source: josm/trunk/src/org/openstreetmap/josm/actions/SaveActionBase.java @ 13115

Last change on this file since 13115 was 13115, checked in by Don-vip, 17 months ago

fix #12086 - fix EDT violation when no file exporter is found + choose note exporter by default when saving a note layer

  • Property svn:eol-style set to native
File size: 8.8 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.actions;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.awt.event.ActionEvent;
7import java.io.File;
8import java.io.IOException;
9import java.util.Collection;
10import java.util.LinkedList;
11import java.util.List;
12
13import javax.swing.JFileChooser;
14import javax.swing.JOptionPane;
15import javax.swing.filechooser.FileFilter;
16
17import org.openstreetmap.josm.Main;
18import org.openstreetmap.josm.data.PreferencesUtils;
19import org.openstreetmap.josm.gui.ExtendedDialog;
20import org.openstreetmap.josm.gui.io.importexport.FileExporter;
21import org.openstreetmap.josm.gui.layer.Layer;
22import org.openstreetmap.josm.gui.layer.OsmDataLayer;
23import org.openstreetmap.josm.gui.util.GuiHelper;
24import org.openstreetmap.josm.gui.widgets.AbstractFileChooser;
25import org.openstreetmap.josm.spi.preferences.Config;
26import org.openstreetmap.josm.tools.Logging;
27import org.openstreetmap.josm.tools.Shortcut;
28
29/**
30 * Abstract superclass of save actions.
31 * @since 290
32 */
33public abstract class SaveActionBase extends DiskAccessAction {
34
35    /**
36     * Constructs a new {@code SaveActionBase}.
37     * @param name The action's text as displayed on the menu (if it is added to a menu)
38     * @param iconName The filename of the icon to use
39     * @param tooltip A longer description of the action that will be displayed in the tooltip
40     * @param shortcut A ready-created shortcut object or {@code null} if you don't want a shortcut
41     */
42    public SaveActionBase(String name, String iconName, String tooltip, Shortcut shortcut) {
43        super(name, iconName, tooltip, shortcut);
44    }
45
46    @Override
47    public void actionPerformed(ActionEvent e) {
48        if (!isEnabled())
49            return;
50        doSave();
51    }
52
53    /**
54     * Saves the active layer.
55     * @return {@code true} if the save operation succeeds
56     */
57    public boolean doSave() {
58        Layer layer = getLayerManager().getActiveLayer();
59        if (layer != null && layer.isSavable()) {
60            return doSave(layer);
61        }
62        return false;
63    }
64
65    /**
66     * Saves the given layer.
67     * @param layer layer to save
68     * @return {@code true} if the save operation succeeds
69     */
70    public boolean doSave(Layer layer) {
71        if (!layer.checkSaveConditions())
72            return false;
73        return doInternalSave(layer, getFile(layer));
74    }
75
76    /**
77     * Saves a layer to a given file.
78     * @param layer The layer to save
79     * @param file The destination file
80     * @param checkSaveConditions if {@code true}, checks preconditions before saving. Set it to {@code false} to skip it
81     * if preconditions have already been checked (as this check can prompt UI dialog in EDT it may be best in some cases
82     * to do it earlier).
83     * @return {@code true} if the layer has been successfully saved, {@code false} otherwise
84     * @since 7204
85     */
86    public static boolean doSave(Layer layer, File file, boolean checkSaveConditions) {
87        if (checkSaveConditions && !layer.checkSaveConditions())
88            return false;
89        return doInternalSave(layer, file);
90    }
91
92    private static boolean doInternalSave(Layer layer, File file) {
93        if (file == null)
94            return false;
95
96        try {
97            boolean exported = false;
98            boolean canceled = false;
99            for (FileExporter exporter : ExtensionFileFilter.getExporters()) {
100                if (exporter.acceptFile(file, layer)) {
101                    exporter.exportData(file, layer);
102                    exported = true;
103                    canceled = exporter.isCanceled();
104                    break;
105                }
106            }
107            if (!exported) {
108                GuiHelper.runInEDTAndWait(() ->
109                    JOptionPane.showMessageDialog(Main.parent, tr("No Exporter found! Nothing saved."), tr("Warning"),
110                        JOptionPane.WARNING_MESSAGE));
111                return false;
112            } else if (canceled) {
113                return false;
114            }
115            if (!layer.isRenamed()) {
116                layer.setName(file.getName());
117            }
118            layer.setAssociatedFile(file);
119            if (layer instanceof OsmDataLayer) {
120                ((OsmDataLayer) layer).onPostSaveToFile();
121            }
122            Main.parent.repaint();
123        } catch (IOException e) {
124            Logging.error(e);
125            return false;
126        }
127        addToFileOpenHistory(file);
128        return true;
129    }
130
131    protected abstract File getFile(Layer layer);
132
133    /**
134     * Refreshes the enabled state
135     *
136     */
137    @Override
138    protected void updateEnabledState() {
139        Layer activeLayer = getLayerManager().getActiveLayer();
140        setEnabled(activeLayer != null && activeLayer.isSavable());
141    }
142
143    /**
144     * Creates a new "Save" dialog for a single {@link ExtensionFileFilter} and makes it visible.<br>
145     * When the user has chosen a file, checks the file extension, and confirms overwrite if needed.
146     *
147     * @param title The dialog title
148     * @param filter The dialog file filter
149     * @return The output {@code File}
150     * @see DiskAccessAction#createAndOpenFileChooser(boolean, boolean, String, FileFilter, int, String)
151     * @since 5456
152     */
153    public static File createAndOpenSaveFileChooser(String title, ExtensionFileFilter filter) {
154        AbstractFileChooser fc = createAndOpenFileChooser(false, false, title, filter, JFileChooser.FILES_ONLY, null);
155        return checkFileAndConfirmOverWrite(fc, filter.getDefaultExtension());
156    }
157
158    /**
159     * Creates a new "Save" dialog for a given file extension and makes it visible.<br>
160     * When the user has chosen a file, checks the file extension, and confirms overwrite if needed.
161     *
162     * @param title The dialog title
163     * @param extension The file extension
164     * @return The output {@code File}
165     * @see DiskAccessAction#createAndOpenFileChooser(boolean, boolean, String, String)
166     */
167    public static File createAndOpenSaveFileChooser(String title, String extension) {
168        AbstractFileChooser fc = createAndOpenFileChooser(false, false, title, extension);
169        return checkFileAndConfirmOverWrite(fc, extension);
170    }
171
172    /**
173     * Checks if selected filename has the given extension. If not, adds the extension and asks for overwrite if filename exists.
174     *
175     * @param fc FileChooser where file was already selected
176     * @param extension file extension
177     * @return the {@code File} or {@code null} if the user cancelled the dialog.
178     */
179    public static File checkFileAndConfirmOverWrite(AbstractFileChooser fc, String extension) {
180        if (fc == null)
181            return null;
182        File file = fc.getSelectedFile();
183
184        FileFilter ff = fc.getFileFilter();
185        if (!ff.accept(file)) {
186            // Extension of another filefilter given ?
187            for (FileFilter cff : fc.getChoosableFileFilters()) {
188                if (cff.accept(file)) {
189                    fc.setFileFilter(cff);
190                    return file;
191                }
192            }
193            // No filefilter accepts current filename, add default extension
194            String fn = file.getPath();
195            if (extension != null && ff.accept(new File(fn + '.' + extension))) {
196                fn += '.' + extension;
197            } else if (ff instanceof ExtensionFileFilter) {
198                fn += '.' + ((ExtensionFileFilter) ff).getDefaultExtension();
199            }
200            file = new File(fn);
201            if (!fc.getSelectedFile().exists() && !confirmOverwrite(file))
202                return null;
203        }
204        return file;
205    }
206
207    /**
208     * Asks user to confirm overwiting a file.
209     * @param file file to overwrite
210     * @return {@code true} if the file can be written
211     */
212    public static boolean confirmOverwrite(File file) {
213        if (file == null || file.exists()) {
214            return new ExtendedDialog(
215                    Main.parent,
216                    tr("Overwrite"),
217                    tr("Overwrite"), tr("Cancel"))
218                .setContent(tr("File exists. Overwrite?"))
219                .setButtonIcons("save_as", "cancel")
220                .showDialog()
221                .getValue() == 1;
222        }
223        return true;
224    }
225
226    static void addToFileOpenHistory(File file) {
227        final String filepath;
228        try {
229            filepath = file.getCanonicalPath();
230        } catch (IOException ign) {
231            Logging.warn(ign);
232            return;
233        }
234
235        int maxsize = Math.max(0, Config.getPref().getInt("file-open.history.max-size", 15));
236        Collection<String> oldHistory = Config.getPref().getList("file-open.history");
237        List<String> history = new LinkedList<>(oldHistory);
238        history.remove(filepath);
239        history.add(0, filepath);
240        PreferencesUtils.putListBounded(Config.getPref(), "file-open.history", maxsize, history);
241    }
242}
Note: See TracBrowser for help on using the repository browser.