DefaultFileControl.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2023 The Gridarta Developers.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
package net.sf.gridarta.gui.misc;
 
import java.awt.Component;
import java.io.File;
import java.io.IOException;
import javax.swing.JFileChooser;
import javax.swing.JOptionPane;
import javax.swing.filechooser.FileFilter;
import net.sf.gridarta.gui.dialog.newmap.NewMapDialogFactory;
import net.sf.gridarta.gui.map.MapPreviewAccessory;
import net.sf.gridarta.gui.map.mapview.MapViewsManager;
import net.sf.gridarta.gui.mapimagecache.MapImageCache;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.io.PathManager;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.model.mapcontrol.MapControl;
import net.sf.gridarta.model.mapmanager.FileControl;
import net.sf.gridarta.model.mapmanager.MapManager;
import net.sf.gridarta.model.mapmodel.MapFile;
import net.sf.gridarta.model.settings.ProjectSettings;
import net.sf.gridarta.model.settings.VolatileSettings;
import net.sf.gridarta.textedit.scripteditor.ScriptEditControl;
import net.sf.gridarta.utils.ActionBuilderUtils;
import net.sf.gridarta.utils.CommonConstants;
import net.sf.gridarta.utils.FileChooserUtils;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class DefaultFileControl<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> implements FileControl<G, A, R> {
 
    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
 
    @NotNull
    private final ProjectSettings projectSettings;
 
    @NotNull
    private final VolatileSettings volatileSettings;
 
    @NotNull
    private final MapImageCache<G, A, R> mapImageCache;
 
    @NotNull
    private final MapManager<G, A, R> mapManager;
 
    @NotNull
    private final MapViewsManager<G, A, R> mapViewsManager;
 
    @NotNull
    private final Component parent;
 
    @NotNull
    private final FileFilter mapFileFilter;
 
    @NotNull
    private final FileFilter scriptFileFilter;
 
    @NotNull
    private final NewMapDialogFactory<G, A, R> newMapDialogFactory;
 
    @NotNull
    private final String scriptExtension;
 
    @NotNull
    private final ScriptEditControl scriptEditControl;
 
    @NotNull
    private final PathManager pathManager;
 
    @Nullable
    private JFileChooser fileChooser;
 
    public DefaultFileControl(@NotNull final ProjectSettings projectSettings, @NotNull final VolatileSettings volatileSettings, @NotNull final MapImageCache<G, A, R> mapImageCache, @NotNull final MapManager<G, A, R> mapManager, @NotNull final MapViewsManager<G, A, R> mapViewsManager, @NotNull final Component parent, @NotNull final FileFilter mapFileFilter, @NotNull final FileFilter scriptFileFilter, @NotNull final NewMapDialogFactory<G, A, R> newMapDialogFactory, @NotNull final String scriptExtension, @NotNull final ScriptEditControl scriptEditControl, @NotNull final PathManager pathManager) {
        this.projectSettings = projectSettings;
        this.volatileSettings = volatileSettings;
        this.mapImageCache = mapImageCache;
        this.mapManager = mapManager;
        this.mapViewsManager = mapViewsManager;
        this.parent = parent;
        this.mapFileFilter = mapFileFilter;
        this.scriptFileFilter = scriptFileFilter;
        this.newMapDialogFactory = newMapDialogFactory;
        this.scriptExtension = scriptExtension;
        this.scriptEditControl = scriptEditControl;
        this.pathManager = pathManager;
    }
 
    @NotNull
    private JFileChooser createFileChooser() {
        final JFileChooser tmpFileChooser = new JFileChooser();
        tmpFileChooser.setDialogTitle(ActionBuilderUtils.getString(ACTION_BUILDER, "fileDialog.title"));
        tmpFileChooser.setFileSelectionMode(JFileChooser.FILES_ONLY);
        tmpFileChooser.setMultiSelectionEnabled(true);
        tmpFileChooser.addChoosableFileFilter(scriptFileFilter);
        tmpFileChooser.addChoosableFileFilter(mapFileFilter);
        if (projectSettings.getMapsDirectory().exists()) {
            FileChooserUtils.setCurrentDirectory(tmpFileChooser, projectSettings.getMapsDirectory());
        }
        tmpFileChooser.setAccessory(new MapPreviewAccessory(mapImageCache, tmpFileChooser));
        return tmpFileChooser;
    }
 
    @Override
    public void openFile(final boolean mapFile) {
        if (fileChooser == null) {
            fileChooser = createFileChooser();
        }
        final JFileChooser tmpFileChooser = fileChooser;
        tmpFileChooser.setFileFilter(mapFile ? mapFileFilter : scriptFileFilter);
        FileChooserUtils.sanitizeCurrentDirectory(tmpFileChooser);
        final int returnVal = tmpFileChooser.showOpenDialog(parent);
        if (returnVal != JFileChooser.APPROVE_OPTION) {
            return;
        }
 
        final File[] files = tmpFileChooser.getSelectedFiles();
        for (final File file : files) {
            final boolean isScriptFile = file.getName().toLowerCase().endsWith(scriptExtension);
            if (file.isFile()) {
                if (isScriptFile) {
                    scriptEditControl.openScriptFile(file);
                } else {
                    try {
                        mapViewsManager.openMapFileWithView(file, null, null);
                    } catch (final IOException ex) {
                        reportLoadError(file, ex.getMessage());
                    }
                }
            } else if (!file.exists()) {
                if (isScriptFile) {
                    scriptEditControl.newScript(); // TODO: pass filename
                } else {
                    newMapDialogFactory.showNewMapDialog(); // XXX: pass file
                }
            } // If neither branch matches, it's a directory - what to do with directories?
        }
    }
 
    @Override
    public boolean save(@NotNull final MapControl<G, A, R> mapControl) {
        final MapFile mapFile = mapControl.getMapModel().getMapFile();
        if (mapFile != null) {
            try {
                mapControl.save();
            } catch (final IOException ex) {
                reportSaveError(mapFile.getFile(), ex.getMessage());
                return false;
            }
            return true;
        }
 
        return saveAs(mapControl);
    }
 
    @Override
    public void saveAllMaps() {
        for (final MapControl<G, A, R> mapControl : mapManager.getOpenedMaps()) {
            if (mapControl.getMapModel().isModified() && !save(mapControl)) {
                return;
            }
        }
    }
 
    @Override
    public boolean closeAllMaps() {
        while (true) {
            final MapControl<G, A, R> mapControl = mapManager.getOpenMap();
            if (mapControl == null) {
                break;
            }
 
            if (!confirmSaveChanges(mapControl)) {
                return false;
            }
 
            mapManager.closeMap(mapControl);
        }
 
        return true;
    }
 
    @Override
    public boolean saveAs(@NotNull final MapControl<G, A, R> mapControl) {
        final File file = saveMapAs(mapControl);
        if (file == null) {
            return false;
        }
 
        try {
            mapControl.saveAs(pathManager.getMapFile(file));
        } catch (final IOException ex) {
            reportSaveError(file, ex.getMessage());
            return false;
        }
 
        return true;
    }
 
    @Nullable
    private File saveMapAs(@NotNull final MapControl<G, A, R> mapControl) {
        final JFileChooser saveFileChooser = new JFileChooser();
        saveFileChooser.setDialogType(JFileChooser.SAVE_DIALOG);
        saveFileChooser.setDialogTitle("Save Map Or Script As");
        saveFileChooser.setFileSelectionMode(JFileChooser.FILES_ONLY);
        saveFileChooser.setMultiSelectionEnabled(false);
        saveFileChooser.resetChoosableFileFilters();
        saveFileChooser.addChoosableFileFilter(scriptFileFilter);
        saveFileChooser.setFileFilter(mapFileFilter);
 
        final MapFile mapFile = mapControl.getMapModel().getMapFile();
        final File defaultDir = mapFile == null ? null : mapFile.getFile().getParentFile();
        if (defaultDir != null && defaultDir.exists()) {
            FileChooserUtils.setCurrentDirectory(saveFileChooser, defaultDir);
            saveFileChooser.setSelectedFile(mapFile.getFile());
        } else {
            final File currentSaveMapDirectory = volatileSettings.getCurrentSaveMapDirectory();
            FileChooserUtils.setCurrentDirectory(saveFileChooser, currentSaveMapDirectory);
            saveFileChooser.setSelectedFile(new File(currentSaveMapDirectory, mapFile == null ? CommonConstants.DEFAULT_MAP_FILENAME : mapFile.getFile().getName()));
        }
 
        final int returnVal = saveFileChooser.showSaveDialog(parent);
        if (returnVal != JFileChooser.APPROVE_OPTION) {
            return null;
        }
 
        volatileSettings.setCurrentSaveMapDirectory(saveFileChooser.getCurrentDirectory());
        final File file = saveFileChooser.getSelectedFile();
        if (file.exists() && ACTION_BUILDER.showConfirmDialog(parent, JOptionPane.WARNING_MESSAGE, JOptionPane.OK_CANCEL_OPTION, "overwriteOtherFile", file.getName()) != JOptionPane.OK_OPTION) {
            return null;
        }
 
        return file;
    }
 
    @Override
    public boolean confirmSaveChanges(@NotNull final MapControl<G, A, R> mapControl) {
        if (mapControl.getMapModel().isModified()) {
            final int result = ACTION_BUILDER.showConfirmDialog(parent, JOptionPane.YES_NO_CANCEL_OPTION, JOptionPane.WARNING_MESSAGE, "confirmSaveChanges", mapControl.getMapModel().getMapArchObject().getMapName());
            if (result == JOptionPane.YES_OPTION) {
                if (!save(mapControl)) {
                    return false;
                }
            } else if (result == JOptionPane.CANCEL_OPTION || result == JOptionPane.CLOSED_OPTION) {
                return false;
            }
        }
 
        return true;
    }
 
    @Override
    public void reportSaveError(@NotNull final MapControl<G, A, R> mapControl, @NotNull final String message) {
        final MapFile mapFile = mapControl.getMapModel().getMapFile();
        assert mapFile != null;
        reportSaveError(mapFile.getFile(), message);
    }
 
    @Override
    public void reportSaveError(@NotNull final File mapFile, @NotNull final String message) {
        ACTION_BUILDER.showMessageDialog(parent, "encodeMapFile", mapFile, message);
    }
 
    @Override
    public void reportLoadError(@Nullable final File file, @NotNull final String message) {
        ACTION_BUILDER.showMessageDialog(parent, "openFileLoadMap", file == null ? "<unknown>" : file, message);
    }
 
    @Override
    public void reportOutOfMapBoundsDeleted(@NotNull final File file, final int outOfMapBoundsDeleted, @NotNull final StringBuilder outOfMapBoundsObjects) {
        ACTION_BUILDER.showMessageDialog(parent, "openFileOutOfMapBoundsDeleted", file, outOfMapBoundsDeleted, outOfMapBoundsObjects);
    }
 
    @Override
    public void reportOutOfMemory(@NotNull final File file) {
        ACTION_BUILDER.showMessageDialog(parent, "mapOutOfMemory", file);
    }
 
    @Override
    public void reportTeleportCharacterError(@NotNull final String mapPath, @NotNull final String message) {
        ACTION_BUILDER.showMessageDialog(parent, "teleportCharacterError", mapPath, message);
    }
 
}