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

Timestamp:

2017-10-21T14:07:26+02:00 (6 years ago)

Author:

Don-vip

Message:

fix #15464 - Allow plugins to modify the changeset tags before upload (patch by rorym)

Location:

trunk/src/org/openstreetmap/josm/actions

Files:

• UploadAction.java (modified) (4 diffs)
• upload/UploadHook.java (modified) (1 diff)

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

@@ -9 +9 @@
 import java.util.LinkedList;
 import java.util.List;
+import java.util.Map;
 
 import javax.swing.JOptionPane;
@@ -21 +22 @@
 import org.openstreetmap.josm.data.APIDataSet;
 import org.openstreetmap.josm.data.conflict.ConflictCollection;
+import org.openstreetmap.josm.data.osm.Changeset;
 import org.openstreetmap.josm.gui.HelpAwareOptionPane;
 import org.openstreetmap.josm.gui.MainApplication;
@@ -246 +248 @@
         }
 
+        // Any hooks want to change the changeset tags?
+        Changeset cs = UploadDialog.getUploadDialog().getChangeset();
+        Map<String, String> changesetTags = cs.getKeys();
+        for (UploadHook hook : UPLOAD_HOOKS) {
+            hook.modifyChangesetTags(changesetTags);
+        }
+        for (UploadHook hook : LATE_UPLOAD_HOOKS) {
+            hook.modifyChangesetTags(changesetTags);
+        }
+
         MainApplication.worker.execute(
                 new UploadPrimitivesTask(
@@ -251 +263 @@
                         layer,
                         apiData,
-                        UploadDialog.getUploadDialog().getChangeset()
+                        cs
                 )
         );

trunk/src/org/openstreetmap/josm/actions/upload/UploadHook.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.actions.upload;
+
+import java.util.Map;
 
 import org.openstreetmap.josm.data.APIDataSet;
 
 /**
- * A check right before the upload. The UploadHook may modify the uploaded data
- * silently, it may display a warning message to the user or prevent the upload
- * altogether.
+ * Change, or block, the upload.
+ *
+ * The UploadHook may modify the uploaded data silently, it may display a
+ * warning message to the user or prevent the upload altogether.
+ *
+ * The tags of the changeset can also be changed with modifyChangesetTags method.
  */
-@FunctionalInterface
 public interface UploadHook {
 
     /**
-     * Checks the upload.
-     * @param apiDataSet the data to upload
-     * @return {@code true} if upload is possible
+     * Check, and/or change, the data to be uploaded.
+     * Default implementation is to approve the upload.
+     * @param apiDataSet the data to upload, modify this to change the data.
+     * @return {@code true} if upload is possible, {@code false} to block the upload.
      */
-    boolean checkUpload(APIDataSet apiDataSet);
+    default boolean checkUpload(APIDataSet apiDataSet) {
+        return true;
+    }
+
+    /**
+     * Modify the changeset tags (in place) before upload.
+     * Default implementation is to do no changes.
+     * @param tags The current tags to change
+     * @since 13028
+     */
+    default void modifyChangesetTags(Map<String, String> tags) {
+    }
 }