001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.actions;
003
004import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
005import static org.openstreetmap.josm.tools.I18n.tr;
006
007import java.awt.GridBagLayout;
008import java.awt.event.KeyEvent;
009import java.beans.PropertyChangeListener;
010import java.io.File;
011
012import javax.swing.JCheckBox;
013import javax.swing.JLabel;
014import javax.swing.JPanel;
015import javax.swing.SwingConstants;
016
017import org.openstreetmap.josm.data.gpx.GpxConstants;
018import org.openstreetmap.josm.gui.ExtendedDialog;
019import org.openstreetmap.josm.gui.MainApplication;
020import org.openstreetmap.josm.gui.layer.AbstractModifiableLayer;
021import org.openstreetmap.josm.gui.layer.GpxLayer;
022import org.openstreetmap.josm.gui.layer.Layer;
023import org.openstreetmap.josm.gui.layer.LayerManager.LayerAddEvent;
024import org.openstreetmap.josm.gui.layer.LayerManager.LayerRemoveEvent;
025import org.openstreetmap.josm.spi.preferences.Config;
026import org.openstreetmap.josm.tools.GBC;
027import org.openstreetmap.josm.tools.Shortcut;
028
029/**
030 * Export the data as an OSM xml file.
031 *
032 * @author imi
033 */
034public final class SaveAction extends SaveActionBase {
035    private static final SaveAction instance = new SaveAction();
036
037    private final PropertyChangeListener updateOnRequireSaveChange = evt -> {
038        if (AbstractModifiableLayer.REQUIRES_SAVE_TO_DISK_PROP.equals(evt.getPropertyName())) {
039            updateEnabledState();
040        }
041    };
042
043    /**
044     * Construct the action with "Save" as label.
045     */
046    private SaveAction() {
047        super(tr("Save"), "save", tr("Save the current data."),
048                Shortcut.registerShortcut("system:save", tr("File: {0}", tr("Save")), KeyEvent.VK_S, Shortcut.CTRL),
049                true);
050        setHelpId(ht("/Action/Save"));
051    }
052
053    /**
054     * Returns the unique instance.
055     * @return the unique instance
056     */
057    public static SaveAction getInstance() {
058        return instance;
059    }
060
061    @Override
062    protected LayerChangeAdapter buildLayerChangeAdapter() {
063        return new LayerChangeAdapter() {
064            @Override
065            public void layerAdded(LayerAddEvent e) {
066                Layer l = e.getAddedLayer();
067                if (l instanceof AbstractModifiableLayer) {
068                    l.addPropertyChangeListener(updateOnRequireSaveChange);
069                }
070                super.layerAdded(e);
071            }
072
073            @Override
074            public void layerRemoving(LayerRemoveEvent e) {
075                Layer l = e.getRemovedLayer();
076                if (l instanceof AbstractModifiableLayer) {
077                    l.removePropertyChangeListener(updateOnRequireSaveChange);
078                }
079                super.layerRemoving(e);
080            }
081        };
082    }
083
084    @Override
085    protected boolean listenToSelectionChange() {
086        return false;
087    }
088
089    @Override
090    public File getFile(Layer layer) {
091        File f = layer.getAssociatedFile();
092        if (f != null && !f.exists()) {
093            f = null;
094        }
095
096        // Ask for overwrite in case of GpxLayer
097        if (f != null
098                && layer instanceof GpxLayer
099                && (((GpxLayer) layer).data == null
100                || !GpxConstants.JOSM_CREATOR_NAME.equals(((GpxLayer) layer).data.creator))
101                && !Config.getPref().getBoolean("gpx.export.overwrite", false)) {
102
103            JPanel p = new JPanel(new GridBagLayout());
104            JLabel label = new JLabel("<html>"
105                    + tr("The file \"{0}\" will be modified.<br>Would you like to overwrite the existing file?", f.getName())
106                    + "</html>");
107            label.setHorizontalAlignment(SwingConstants.CENTER);
108            JCheckBox remember = new JCheckBox(tr("Always overwrite GPX files without asking"));
109            remember.setHorizontalAlignment(SwingConstants.CENTER);
110            p.add(label, GBC.eol().fill(GBC.HORIZONTAL).insets(5, 5, 5, 10));
111            p.add(remember, GBC.eop().fill(GBC.HORIZONTAL));
112            ExtendedDialog dialog = new ExtendedDialog(
113                    MainApplication.getMainFrame(),
114                    tr("Overwrite"),
115                    tr("Overwrite"), tr("Save As..."), tr("Cancel"))
116                .setButtonIcons("save", "save_as", "cancel")
117                .setContent(p);
118            int val = dialog.showDialog().getValue();
119            if (val == 1) {
120                Config.getPref().putBoolean("gpx.export.overwrite", remember.isSelected());
121            } else if (val == 2) {
122                f = null;
123            } else {
124                return null;
125            }
126        }
127        return f == null ? layer.createAndOpenSaveFileChooser() : f;
128    }
129}