Changeset 7358 in josm

Timestamp:

2014-08-01T23:03:40+02:00 (11 years ago)

Author:

Don-vip

Message:

see #9899 - refactor save/upload layer stuff to allow different layers (i.e: notes layer) to benefit from the mechanism

Location:

trunk/src/org/openstreetmap/josm

Files:

• Main.java (modified) (4 diffs)
• actions/UploadAction.java (modified) (5 diffs)
• gui/io/AbstractIOTask.java (modified) (1 diff)
• gui/io/AbstractUploadDialog.java (added)
• gui/io/SaveLayerInfo.java (modified) (4 diffs)
• gui/io/SaveLayerTask.java (modified) (2 diffs)
• gui/io/SaveLayersDialog.java (modified) (3 diffs)
• gui/io/SaveLayersModel.java (modified) (8 diffs)
• gui/io/UploadDialog.java (modified) (5 diffs)
• gui/io/UploadLayerTask.java (modified) (1 diff)
• gui/layer/Layer.java (modified) (1 diff)
• gui/layer/ModifiableLayer.java (added)
• gui/layer/OsmDataLayer.java (modified) (9 diffs)

trunk/src/org/openstreetmap/josm/Main.java ¶

@@ -77 +77 @@
 import org.openstreetmap.josm.gui.io.SaveLayersDialog;
 import org.openstreetmap.josm.gui.layer.Layer;
+import org.openstreetmap.josm.gui.layer.ModifiableLayer;
 import org.openstreetmap.josm.gui.layer.OsmDataLayer;
 import org.openstreetmap.josm.gui.layer.OsmDataLayer.CommandQueueListener;
@@ -890 +891 @@
 
     /**
-     * Asks user to perform "save layer" operations (save .osm on disk and/or upload osm data to server) for all {@link OsmDataLayer} before JOSM exits.
+     * Asks user to perform "save layer" operations (save on disk and/or upload data to server) for all {@link ModifiableLayer} before JOSM exits.
      * @return {@code true} if there was nothing to save, or if the user wants to proceed to save operations. {@code false} if the user cancels.
      * @since 2025
@@ -896 +897 @@
     public static boolean saveUnsavedModifications() {
         if (!isDisplayingMapView()) return true;
-        return saveUnsavedModifications(map.mapView.getLayersOfType(OsmDataLayer.class), true);
-    }
-
-    /**
-     * Asks user to perform "save layer" operations (save .osm on disk and/or upload osm data to server) before osm layers deletion.
-     *
-     * @param selectedLayers The layers to check. Only instances of {@link OsmDataLayer} are considered.
+        return saveUnsavedModifications(map.mapView.getLayersOfType(ModifiableLayer.class), true);
+    }
+
+    /**
+     * Asks user to perform "save layer" operations (save on disk and/or upload data to server) before data layers deletion.
+     *
+     * @param selectedLayers The layers to check. Only instances of {@link ModifiableLayer} are considered.
      * @param exit {@code true} if JOSM is exiting, {@code false} otherwise.
      * @return {@code true} if there was nothing to save, or if the user wants to proceed to save operations. {@code false} if the user cancels.
@@ -909 +910 @@
     public static boolean saveUnsavedModifications(Iterable<? extends Layer> selectedLayers, boolean exit) {
         SaveLayersDialog dialog = new SaveLayersDialog(parent);
-        List<OsmDataLayer> layersWithUnmodifiedChanges = new ArrayList<>();
+        List<ModifiableLayer> layersWithUnmodifiedChanges = new ArrayList<>();
         for (Layer l: selectedLayers) {
-            if (!(l instanceof OsmDataLayer)) {
+            if (!(l instanceof ModifiableLayer)) {
                 continue;
             }
-            OsmDataLayer odl = (OsmDataLayer)l;
-            if ((odl.requiresSaveToFile() || (odl.requiresUploadToServer() && !odl.isUploadDiscouraged())) && odl.data.isModified()) {
+            ModifiableLayer odl = (ModifiableLayer)l;
+            if ((odl.requiresSaveToFile() || (odl.requiresUploadToServer() && !odl.isUploadDiscouraged())) && odl.isModified()) {
                 layersWithUnmodifiedChanges.add(odl);
             }

trunk/src/org/openstreetmap/josm/actions/UploadAction.java ¶

@@ -27 +27 @@
 import org.openstreetmap.josm.gui.io.UploadDialog;
 import org.openstreetmap.josm.gui.io.UploadPrimitivesTask;
+import org.openstreetmap.josm.gui.layer.ModifiableLayer;
 import org.openstreetmap.josm.gui.layer.OsmDataLayer;
 import org.openstreetmap.josm.gui.util.GuiHelper;
@@ -142 +143 @@
     }
 
-    public boolean checkPreUploadConditions(OsmDataLayer layer) {
-        return checkPreUploadConditions(layer, new APIDataSet(layer.data));
+    public static boolean checkPreUploadConditions(ModifiableLayer layer) {
+        return checkPreUploadConditions(layer,
+                layer instanceof OsmDataLayer ? new APIDataSet(((OsmDataLayer)layer).data) : null);
     }
 
@@ -162 +164 @@
      * want to continue
      */
-    public static boolean warnUploadDiscouraged(OsmDataLayer layer) {
+    public static boolean warnUploadDiscouraged(ModifiableLayer layer) {
         return GuiHelper.warnUser(tr("Upload discouraged"),
                 "<html>" +
@@ -182 +184 @@
      * @return true, if the preconditions are met; false, otherwise
      */
-    public boolean checkPreUploadConditions(OsmDataLayer layer, APIDataSet apiData) {
+    public static boolean checkPreUploadConditions(ModifiableLayer layer, APIDataSet apiData) {
         if (layer.isUploadDiscouraged()) {
             if (warnUploadDiscouraged(layer)) {
@@ -188 +190 @@
             }
         }
-        ConflictCollection conflicts = layer.getConflicts();
-        if (apiData.participatesInConflict(conflicts)) {
-            alertUnresolvedConflicts(layer);
-            return false;
+        if (layer instanceof OsmDataLayer) {
+            OsmDataLayer osmLayer = (OsmDataLayer) layer;
+            ConflictCollection conflicts = osmLayer.getConflicts();
+            if (apiData.participatesInConflict(conflicts)) {
+                alertUnresolvedConflicts(osmLayer);
+                return false;
+            }
         }
         // Call all upload hooks in sequence.
         // FIXME: this should become an asynchronous task
         //
-        for (UploadHook hook : uploadHooks) {
-            if (!hook.checkUpload(apiData))
-                return false;
+        if (apiData != null) {
+            for (UploadHook hook : uploadHooks) {
+                if (!hook.checkUpload(apiData))
+                    return false;
+            }
         }
 

trunk/src/org/openstreetmap/josm/gui/io/AbstractIOTask.java ¶

@@ -15 +15 @@
     private Exception lastException;
 
+    /**
+     * Contructs a new {@code AbstractIOTask}.
+     */
     public AbstractIOTask() {
         canceled = false;

trunk/src/org/openstreetmap/josm/gui/io/SaveLayerInfo.java ¶

@@ -4 +4 @@
 import java.io.File;
 
-import org.openstreetmap.josm.gui.layer.OsmDataLayer;
+import org.openstreetmap.josm.gui.layer.ModifiableLayer;
 import org.openstreetmap.josm.tools.CheckParameterUtil;
 
@@ -10 +10 @@
  * SaveLayerInfo represents the information, user preferences and save/upload states of
  * a layer which might be uploaded/saved.
- *
+ * @since 2025
  */
 class SaveLayerInfo implements Comparable<SaveLayerInfo> {
 
-    /** the osm data layer */
-    private OsmDataLayer layer;
+    /** the modifiable layer */
+    private ModifiableLayer layer;
     private boolean doCheckSaveConditions;
     private boolean doSaveToFile;
@@ -28 +28 @@
      * @throws IllegalArgumentException thrown if layer is null
      */
-    public SaveLayerInfo(OsmDataLayer layer) {
+    public SaveLayerInfo(ModifiableLayer layer) {
         CheckParameterUtil.ensureParameterNotNull(layer, "layer");
         this.layer = layer;
@@ -42 +42 @@
      * @return the layer this info objects holds information for
      */
-    public OsmDataLayer getLayer() {
+    public ModifiableLayer getLayer() {
         return layer;
     }

trunk/src/org/openstreetmap/josm/gui/io/SaveLayerTask.java ¶

@@ -11 +11 @@
 
 /**
- * SaveLayerTask saves the data managed by an {@link org.openstreetmap.josm.gui.layer.OsmDataLayer} to the
- * {@link org.openstreetmap.josm.gui.layer.OsmDataLayer#getAssociatedFile()}.
+ * SaveLayerTask saves the data managed by an {@link org.openstreetmap.josm.gui.layer.ModifiableLayer} to the
+ * {@link org.openstreetmap.josm.gui.layer.Layer#getAssociatedFile()}.
  *
  * <pre>
@@ -26 +26 @@
  * </pre>
  */
-class SaveLayerTask extends AbstractIOTask {
+public class SaveLayerTask extends AbstractIOTask {
     private SaveLayerInfo layerInfo;
     private ProgressMonitor parentMonitor;

trunk/src/org/openstreetmap/josm/gui/io/SaveLayersDialog.java ¶

@@ -44 +44 @@
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.actions.UploadAction;
-import org.openstreetmap.josm.data.APIDataSet;
 import org.openstreetmap.josm.gui.ExceptionDialogUtil;
 import org.openstreetmap.josm.gui.io.SaveLayersModel.Mode;
+import org.openstreetmap.josm.gui.layer.ModifiableLayer;
 import org.openstreetmap.josm.gui.progress.ProgressMonitor;
 import org.openstreetmap.josm.gui.progress.SwingRenderingProgressMonitor;
@@ -449 +449 @@
         protected void uploadLayers(List<SaveLayerInfo> toUpload) {
             for (final SaveLayerInfo layerInfo: toUpload) {
+                ModifiableLayer layer = layerInfo.getLayer();
                 if (canceled) {
-                    model.setUploadState(layerInfo.getLayer(), UploadOrSaveState.CANCELED);
+                    model.setUploadState(layer, UploadOrSaveState.CANCELED);
                     continue;
                 }
                 monitor.subTask(tr("Preparing layer ''{0}'' for upload ...", layerInfo.getName()));
 
-                if (!new UploadAction().checkPreUploadConditions(layerInfo.getLayer())) {
-                    model.setUploadState(layerInfo.getLayer(), UploadOrSaveState.FAILED);
+                if (!UploadAction.checkPreUploadConditions(layer)) {
+                    model.setUploadState(layer, UploadOrSaveState.FAILED);
                     continue;
                 }
-                final UploadDialog dialog = UploadDialog.getUploadDialog();
-                dialog.setUploadedPrimitives(new APIDataSet(layerInfo.getLayer().data));
-                dialog.setVisible(true);
-                if (dialog.isCanceled()) {
-                    model.setUploadState(layerInfo.getLayer(), UploadOrSaveState.CANCELED);
+
+                AbstractUploadDialog dialog = layer.getUploadDialog();
+                if (dialog != null) {
+                    dialog.setVisible(true);
+                    if (dialog.isCanceled()) {
+                        model.setUploadState(layer, UploadOrSaveState.CANCELED);
+                        continue;
+                    }
+                    dialog.rememberUserInput();
+                }
+
+                currentTask = layer.createUploadTask(monitor);
+                if (currentTask == null) {
+                    model.setUploadState(layer, UploadOrSaveState.FAILED);
                     continue;
                 }
-                dialog.rememberUserInput();
-
-                currentTask = new UploadLayerTask(
-                        UploadDialog.getUploadDialog().getUploadStrategySpecification(),
-                        layerInfo.getLayer(),
-                        monitor,
-                        UploadDialog.getUploadDialog().getChangeset()
-                );
                 currentFuture = worker.submit(currentTask);
                 try {
@@ -480 +482 @@
                     currentFuture.get();
                 } catch(CancellationException e) {
-                    model.setUploadState(layerInfo.getLayer(), UploadOrSaveState.CANCELED);
+                    model.setUploadState(layer, UploadOrSaveState.CANCELED);
                 } catch(Exception e) {
                     Main.error(e);
-                    model.setUploadState(layerInfo.getLayer(), UploadOrSaveState.FAILED);
+                    model.setUploadState(layer, UploadOrSaveState.FAILED);
                     ExceptionDialogUtil.explainException(e);
                 }
                 if (currentTask.isCanceled()) {
-                    model.setUploadState(layerInfo.getLayer(), UploadOrSaveState.CANCELED);
+                    model.setUploadState(layer, UploadOrSaveState.CANCELED);
                 } else if (currentTask.isFailed()) {
                     Main.error(currentTask.getLastException());
                     ExceptionDialogUtil.explainException(currentTask.getLastException());
-                    model.setUploadState(layerInfo.getLayer(), UploadOrSaveState.FAILED);
+                    model.setUploadState(layer, UploadOrSaveState.FAILED);
                 } else {
-                    model.setUploadState(layerInfo.getLayer(), UploadOrSaveState.OK);
+                    model.setUploadState(layer, UploadOrSaveState.OK);
                 }
                 currentTask = null;

trunk/src/org/openstreetmap/josm/gui/io/SaveLayersModel.java ¶

@@ -12 +12 @@
 import javax.swing.table.DefaultTableModel;
 
+import org.openstreetmap.josm.gui.layer.ModifiableLayer;
 import org.openstreetmap.josm.gui.layer.OsmDataLayer;
 
@@ -59 +60 @@
     }
 
-    public void populate(List<OsmDataLayer> layers) {
+    /**
+     * Populates the model with given modifiable layers.
+     * @param layers The layers to use to populate this model
+     * @since 7358
+     */
+    public void populate(List<? extends ModifiableLayer> layers) {
         layerInfo = new ArrayList<>();
         if (layers == null) return;
-        for (OsmDataLayer layer: layers) {
+        for (ModifiableLayer layer: layers) {
             layerInfo.add(new SaveLayerInfo(layer));
         }
@@ -135 +141 @@
 
     public List<SaveLayerInfo> getLayersWithConflictsAndUploadRequest() {
-        List<SaveLayerInfo> ret =new ArrayList<>();
-        for (SaveLayerInfo info: layerInfo) {
-            if (info.isDoUploadToServer() && !info.getLayer().getConflicts().isEmpty()) {
+        List<SaveLayerInfo> ret = new ArrayList<>();
+        for (SaveLayerInfo info: layerInfo) {
+            ModifiableLayer l = info.getLayer();
+            if (info.isDoUploadToServer() && l instanceof OsmDataLayer && !((OsmDataLayer)l).getConflicts().isEmpty()) {
                 ret.add(info);
             }
@@ -145 +152 @@
 
     public List<SaveLayerInfo> getLayersToUpload() {
-        List<SaveLayerInfo> ret =new ArrayList<>();
+        List<SaveLayerInfo> ret = new ArrayList<>();
         for (SaveLayerInfo info: layerInfo) {
             if (info.isDoUploadToServer()) {
@@ -155 +162 @@
 
     public List<SaveLayerInfo> getLayersToSave() {
-        List<SaveLayerInfo> ret =new ArrayList<>();
+        List<SaveLayerInfo> ret = new ArrayList<>();
         for (SaveLayerInfo info: layerInfo) {
             if (info.isDoSaveToFile()) {
@@ -164 +171 @@
     }
 
-    public void setUploadState(OsmDataLayer layer, UploadOrSaveState state) {
+    public void setUploadState(ModifiableLayer layer, UploadOrSaveState state) {
         SaveLayerInfo info = getSaveLayerInfo(layer);
         if (info != null) {
@@ -172 +179 @@
     }
 
-    public void setSaveState(OsmDataLayer layer, UploadOrSaveState state) {
+    public void setSaveState(ModifiableLayer layer, UploadOrSaveState state) {
         SaveLayerInfo info = getSaveLayerInfo(layer);
         if (info != null) {
@@ -180 +187 @@
     }
 
-    public SaveLayerInfo getSaveLayerInfo(OsmDataLayer layer) {
+    public SaveLayerInfo getSaveLayerInfo(ModifiableLayer layer) {
         for (SaveLayerInfo info: this.layerInfo) {
             if (info.getLayer() == layer)

trunk/src/org/openstreetmap/josm/gui/io/UploadDialog.java ¶

@@ -31 +31 @@
 import javax.swing.JButton;
 import javax.swing.JComponent;
-import javax.swing.JDialog;
 import javax.swing.JOptionPane;
 import javax.swing.JPanel;
@@ -59 +58 @@
  * This is a dialog for entering upload options like the parameters for
  * the upload changeset and the strategy for opening/closing a changeset.
- *
+ * @since 2025
  */
-public class UploadDialog extends JDialog implements PropertyChangeListener, PreferenceChangedListener{
+public class UploadDialog extends AbstractUploadDialog implements PropertyChangeListener, PreferenceChangedListener {
     /**  the unique instance of the upload dialog */
     private static UploadDialog uploadDialog;
@@ -97 +96 @@
     /** the upload button */
     private JButton btnUpload;
-    private boolean canceled = false;
 
     /** the changeset comment model keeping the state of the changeset comment */
@@ -267 +265 @@
     }
 
-    /**
-     * Remembers the user input in the preference settings
-     */
+    @Override
     public void rememberUserInput() {
         pnlBasicUploadSettings.rememberUserInput();
@@ -345 +341 @@
     protected String getUploadSource() {
         return changesetSourceModel.getComment();
-    }
-
-    /**
-     * Returns true if the dialog was canceled
-     *
-     * @return true if the dialog was canceled
-     */
-    public boolean isCanceled() {
-        return canceled;
-    }
-
-    /**
-     * Sets whether the dialog was canceled
-     *
-     * @param canceled true if the dialog is canceled
-     */
-    protected void setCanceled(boolean canceled) {
-        this.canceled = canceled;
     }
 

trunk/src/org/openstreetmap/josm/gui/io/UploadLayerTask.java ¶

@@ -40 +40 @@
  * </pre>
  */
-class UploadLayerTask extends AbstractIOTask implements Runnable {
+public class UploadLayerTask extends AbstractIOTask implements Runnable {
     private OsmServerWriter writer;
     private OsmDataLayer layer;

trunk/src/org/openstreetmap/josm/gui/layer/Layer.java ¶

@@ -119 +119 @@
     /**
      * Create the layer and fill in the necessary components.
+     * @param name Layer name
      */
     public Layer(String name) {

trunk/src/org/openstreetmap/josm/gui/layer/OsmDataLayer.java ¶

@@ -44 +44 @@
 import org.openstreetmap.josm.actions.SaveActionBase;
 import org.openstreetmap.josm.actions.ToggleUploadDiscouragedLayerAction;
+import org.openstreetmap.josm.data.APIDataSet;
 import org.openstreetmap.josm.data.Bounds;
 import org.openstreetmap.josm.data.SelectionChangedListener;
@@ -76 +77 @@
 import org.openstreetmap.josm.gui.dialogs.LayerListDialog;
 import org.openstreetmap.josm.gui.dialogs.LayerListPopup;
+import org.openstreetmap.josm.gui.io.AbstractIOTask;
+import org.openstreetmap.josm.gui.io.AbstractUploadDialog;
+import org.openstreetmap.josm.gui.io.UploadDialog;
+import org.openstreetmap.josm.gui.io.UploadLayerTask;
 import org.openstreetmap.josm.gui.progress.PleaseWaitProgressMonitor;
 import org.openstreetmap.josm.gui.progress.ProgressMonitor;
@@ -91 +96 @@
  * @author imi
  */
-public class OsmDataLayer extends Layer implements Listener, SelectionChangedListener {
+public class OsmDataLayer extends ModifiableLayer implements Listener, SelectionChangedListener {
     public static final String REQUIRES_SAVE_TO_DISK_PROP = OsmDataLayer.class.getName() + ".requiresSaveToDisk";
     public static final String REQUIRES_UPLOAD_TO_SERVER_PROP = OsmDataLayer.class.getName() + ".requiresUploadToServer";
@@ -622 +627 @@
     }
 
-    /**
-     * Replies true if the data managed by this layer needs to be uploaded to
-     * the server because it contains at least one modified primitive.
-     *
-     * @return true if the data managed by this layer needs to be uploaded to
-     * the server because it contains at least one modified primitive; false,
-     * otherwise
-     */
+    @Override
     public boolean requiresUploadToServer() {
         return requiresUploadToServer;
     }
 
-    /**
-     * Replies true if the data managed by this layer needs to be saved to
-     * a file. Only replies true if a file is assigned to this layer and
-     * if the data managed by this layer has been modified since the last
-     * save operation to the file.
-     *
-     * @return true if the data managed by this layer needs to be saved to
-     * a file
-     */
+    @Override
     public boolean requiresSaveToFile() {
         return getAssociatedFile() != null && requiresSaveToFile;
@@ -650 +640 @@
     public void onPostLoadFromFile() {
         setRequiresSaveToFile(false);
-        setRequiresUploadToServer(data.isModified());
+        setRequiresUploadToServer(isModified());
     }
 
     public void onPostDownloadFromServer() {
         setRequiresSaveToFile(true);
-        setRequiresUploadToServer(data.isModified());
+        setRequiresUploadToServer(isModified());
     }
 
@@ -663 +653 @@
     }
 
-    /**
-     * Initializes the layer after a successful save of OSM data to a file
-     *
-     */
+    @Override
     public void onPostSaveToFile() {
         setRequiresSaveToFile(false);
-        setRequiresUploadToServer(data.isModified());
-    }
-
-    /**
-     * Initializes the layer after a successful upload to the server
-     *
-     */
+        setRequiresUploadToServer(isModified());
+    }
+
+    @Override
     public void onPostUploadToServer() {
-        setRequiresUploadToServer(data.isModified());
+        setRequiresUploadToServer(isModified());
         // keep requiresSaveToDisk unchanged
     }
@@ -730 +714 @@
     }
 
+    @Override
     public final boolean isUploadDiscouraged() {
         return data.isUploadDiscouraged();
@@ -741 +726 @@
             }
         }
+    }
+
+    @Override
+    public final boolean isModified() {
+        return data.isModified();
     }
 
@@ -810 +800 @@
         return SaveActionBase.createAndOpenSaveFileChooser(tr("Save OSM file"), "osm");
     }
+
+    @Override
+    public AbstractIOTask createUploadTask(final ProgressMonitor monitor) {
+        UploadDialog dialog = UploadDialog.getUploadDialog();
+        return new UploadLayerTask(
+                dialog.getUploadStrategySpecification(),
+                this,
+                monitor,
+                dialog.getChangeset());
+    }
+
+    @Override
+    public AbstractUploadDialog getUploadDialog() {
+        UploadDialog dialog = UploadDialog.getUploadDialog();
+        dialog.setUploadedPrimitives(new APIDataSet(data));
+        return dialog;
+    }
 }