Changeset 18287 in josm for trunk/src/org/openstreetmap/josm/actions

Timestamp:

2021-10-19T01:26:15+02:00 (3 years ago)

Author:

Don-vip

Message:

fix #20913 - fix handling of GPX files in sessions (patch by Bjoeni)

• revert r17659 (except for unit tests) - see #20233
  • don't save GPX track and marker colors in session file anymore, but in the GPX files as extensions (like before)
  • don't ask to save unmodified GPX file
  • don't override global color settings when individual track doesn't have a color
• ask user to save changes to GPX file when any drawing settings or marker colors have changed (currently only happens for track colors)
• save marker color values to session even when corresponding GPX layer has already been deleted
• save alpha values for GPX marker colors
• added explanation to the "overwrite GPX file" dialog
• inform user if not all files referenced by the session file are saved yet
• allow user to save all files that are not included in the *.jos/*.joz but are only referenced in the session file
• display * next to GPX layers that need to be saved (move isDirty() logic from OsmDataLayer to AbstractModifiableLayer)

Location:

trunk/src/org/openstreetmap/josm/actions

Files:

• SaveAction.java (modified) (6 diffs)
• SessionSaveAsAction.java (modified) (7 diffs)

trunk/src/org/openstreetmap/josm/actions/SaveAction.java

@@ -15 +15 @@
 import javax.swing.SwingConstants;
 
-import org.openstreetmap.josm.data.gpx.GpxData.GpxDataChangeListener;
+import org.openstreetmap.josm.data.gpx.GpxConstants;
 import org.openstreetmap.josm.gui.ExtendedDialog;
 import org.openstreetmap.josm.gui.MainApplication;
+import org.openstreetmap.josm.gui.layer.AbstractModifiableLayer;
 import org.openstreetmap.josm.gui.layer.GpxLayer;
 import org.openstreetmap.josm.gui.layer.Layer;
 import org.openstreetmap.josm.gui.layer.LayerManager.LayerAddEvent;
 import org.openstreetmap.josm.gui.layer.LayerManager.LayerRemoveEvent;
-import org.openstreetmap.josm.gui.layer.OsmDataLayer;
 import org.openstreetmap.josm.gui.layer.SaveToFile;
 import org.openstreetmap.josm.gui.util.GuiHelper;
@@ -38 +38 @@
 
     private final PropertyChangeListener updateOnRequireSaveChange = evt -> {
-        if (OsmDataLayer.REQUIRES_SAVE_TO_DISK_PROP.equals(evt.getPropertyName())) {
+        if (AbstractModifiableLayer.REQUIRES_SAVE_TO_DISK_PROP.equals(evt.getPropertyName())) {
             updateEnabledState();
         }
     };
-
-    private final GpxDataChangeListener updateOnRequireSaveChangeGpx = evt -> updateEnabledState();
 
     /**
@@ -69 +67 @@
             public void layerAdded(LayerAddEvent e) {
                 Layer l = e.getAddedLayer();
-                if (l instanceof OsmDataLayer) {
+                if (l instanceof AbstractModifiableLayer) {
                     l.addPropertyChangeListener(updateOnRequireSaveChange);
-                }
-                if (l instanceof GpxLayer) {
-                    ((GpxLayer) l).data.addWeakChangeListener(updateOnRequireSaveChangeGpx);
                 }
                 super.layerAdded(e);
@@ -81 +76 @@
             public void layerRemoving(LayerRemoveEvent e) {
                 Layer l = e.getRemovedLayer();
-                if (l instanceof OsmDataLayer) {
+                if (l instanceof AbstractModifiableLayer) {
                     l.removePropertyChangeListener(updateOnRequireSaveChange);
-                }
-                if (l instanceof GpxLayer) {
-                    ((GpxLayer) l).data.removeChangeListener(updateOnRequireSaveChangeGpx);
                 }
                 super.layerRemoving(e);
@@ -114 +106 @@
 
         // Ask for overwrite in case of GpxLayer
-        if (f != null && layer instanceof GpxLayer && !Config.getPref().getBoolean("gpx.export.overwrite", false)) {
+        if (f != null
+                && layer instanceof GpxLayer
+                && (((GpxLayer) layer).data == null
+                || !GpxConstants.JOSM_CREATOR_NAME.equals(((GpxLayer) layer).data.creator))
+                && !Config.getPref().getBoolean("gpx.export.overwrite", false)) {
+
             JPanel p = new JPanel(new GridBagLayout());
-            JLabel label = new JLabel(tr("File {0} exists. Overwrite?", f.getName()));
+            JLabel label = new JLabel("<html>"
+                    + tr("The file \"{0}\" will be modified.<br>Would you like to overwrite the existing file?", f.getName())
+                    + "</html>");
             label.setHorizontalAlignment(SwingConstants.CENTER);
-            JCheckBox remember = new JCheckBox(tr("Remember choice"));
+            JCheckBox remember = new JCheckBox(tr("Always overwrite GPX files without asking"));
             remember.setHorizontalAlignment(SwingConstants.CENTER);
             p.add(label, GBC.eol().fill(GBC.HORIZONTAL).insets(5, 5, 5, 10));
@@ -125 +124 @@
                     MainApplication.getMainFrame(),
                     tr("Overwrite"),
-                    tr("Overwrite"), tr("Cancel"))
-                .setButtonIcons("save_as", "cancel")
+                    tr("Overwrite"), tr("Save As..."), tr("Cancel"))
+                .setButtonIcons("save", "save_as", "cancel")
                 .setContent(p);
-            if (dialog.showDialog().getValue() != 1) {
+            int val = dialog.showDialog().getValue();
+            if (val == 1) {
+                Config.getPref().putBoolean("gpx.export.overwrite", remember.isSelected());
+            } else if (val == 2) {
                 f = null;
-            } else if (remember.isSelected()) {
-                Config.getPref().putBoolean("gpx.export.overwrite", true);
+            } else {
+                return null;
             }
         }

trunk/src/org/openstreetmap/josm/actions/SessionSaveAsAction.java

@@ -20 +20 @@
 import java.util.Set;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 import javax.swing.BorderFactory;
@@ -33 +34 @@
 import javax.swing.filechooser.FileFilter;
 
+import org.openstreetmap.josm.data.preferences.BooleanProperty;
 import org.openstreetmap.josm.gui.ExtendedDialog;
 import org.openstreetmap.josm.gui.HelpAwareOptionPane;
@@ -39 +41 @@
 import org.openstreetmap.josm.gui.MapFrameListener;
 import org.openstreetmap.josm.gui.Notification;
+import org.openstreetmap.josm.gui.layer.AbstractModifiableLayer;
 import org.openstreetmap.josm.gui.layer.Layer;
 import org.openstreetmap.josm.gui.util.WindowGeometry;
@@ -61 +64 @@
     private transient MultiMap<Layer, Layer> dependencies;
 
+    private static final BooleanProperty SAVE_LOCAL_FILES_PROPERTY = new BooleanProperty("session.savelocal", true);
+
     /**
      * Constructs a new {@code SessionSaveAsAction}.
@@ -158 +163 @@
                 .filter(layer -> exporters.get(layer) != null && exporters.get(layer).shallExport())
                 .collect(Collectors.toList());
+
+        Stream<Layer> layersToSaveStream = layersOut.stream()
+                .filter(layer -> layer.isSavable()
+                        && layer instanceof AbstractModifiableLayer
+                        && ((AbstractModifiableLayer) layer).requiresSaveToFile()
+                        && exporters.get(layer) != null
+                        && !exporters.get(layer).requiresZip());
+
+        if (SAVE_LOCAL_FILES_PROPERTY.get()) {
+            // individual files must be saved before the session file as the location may change
+            if (layersToSaveStream
+                .map(layer -> SaveAction.getInstance().doSave(layer, true))
+                .collect(Collectors.toList()) // force evaluation of all elements
+                .contains(false)) {
+
+                new Notification(tr("Not all local files referenced by the session file could be saved."
+                        + "<br>Make sure you save them before closing JOSM."))
+                    .setIcon(JOptionPane.WARNING_MESSAGE)
+                    .setDuration(Notification.TIME_LONG)
+                    .show();
+            }
+        } else if (layersToSaveStream.anyMatch(l -> true)) {
+            new Notification(tr("Not all local files referenced by the session file are saved yet."
+                    + "<br>Make sure you save them before closing JOSM."))
+                .setIcon(JOptionPane.INFORMATION_MESSAGE)
+                .setDuration(Notification.TIME_LONG)
+                .show();
+        }
 
         int active = -1;
@@ -251 +284 @@
 
         protected final Component build() {
+            JPanel op = new JPanel(new GridBagLayout());
             JPanel ip = new JPanel(new GridBagLayout());
             for (Layer layer : layers) {
@@ -273 +307 @@
             final JTabbedPane tabs = new JTabbedPane();
             tabs.addTab(tr("Layers"), p);
-            return tabs;
+            op.add(tabs, GBC.eol().fill());
+            JCheckBox chkSaveLocal = new JCheckBox(tr("Save all local files to disk"), SAVE_LOCAL_FILES_PROPERTY.get());
+            chkSaveLocal.addChangeListener(l -> {
+                SAVE_LOCAL_FILES_PROPERTY.put(chkSaveLocal.isSelected());
+            });
+            op.add(chkSaveLocal);
+            return op;
         }