Changeset 2040 in josm for trunk/src/org/openstreetmap/josm/io

Timestamp:

2009-09-03T18:51:04+02:00 (16 years ago)

Author:

Gubaer

Message:

improved upload dialog
new: tags for changesets
new: multiple uploads to the same changeset
fixed #3381: simple imput of a changeset source
fixed #2491: Allow arbitrary key-value pairs in changesets
fixed #2436: Allow multiple uploads to one changeset

Location:

trunk/src/org/openstreetmap/josm/io

Files:

• ChangesetProcessingType.java (added)
• OsmApi.java (modified) (3 diffs)
• OsmServerWriter.java (modified) (7 diffs)

trunk/src/org/openstreetmap/josm/io/OsmApi.java

@@ -145 +145 @@
 
     /**
-     * Returns true if the negotiated version supports changesets.
-     * @return true if the negotiated version supports changesets.
-     */
-    public boolean hasChangesetSupport() {
+     * Returns true if the negotiated version supports diff uploads.
+     * @return true if the negotiated version supports diff uploads
+     */
+    public boolean hasSupportForDiffUploads() {
         return ((version != null) && (version.compareTo("0.6")>=0));
     }
@@ -280 +280 @@
 
     /**
-     * Creates a new changeset on the server to use for subsequent calls.
-     * @param comment the "commit comment" for the new changeset
+     * Creates the changeset to be used for subsequent uploads.
+     * 
+     * If changesetProcessingType is {@see ChangesetProcessingType#USE_NEW} creates a new changeset based
+     * on <code>changeset</code>. Otherwise uses the changeset given by {@see OsmApi#getCurrentChangeset()}.
+     * If this changeset is null or has an id of value 0, a new changeset is created too.
+     * 
+     * @param changeset the changeset to be used for uploading if <code>changesetProcessingType</code> is
+     *   {@see ChangesetProcessingType#USE_NEW}
+     * @param changesetProcessingType  how to handel changesets; set to {@see ChangesetProcessingType#USE_NEW} if null
+     * @param progressMonitor the progress monitor
      * @throws OsmTransferException signifying a non-200 return code, or connection errors
      */
-    public void createChangeset(String comment, ProgressMonitor progressMonitor) throws OsmTransferException {
-        progressMonitor.beginTask((tr("Opening changeset...")));
+    public void createChangeset(Changeset changeset, ChangesetProcessingType changesetProcessingType, ProgressMonitor progressMonitor) throws OsmTransferException {
+        if (changesetProcessingType == null) {
+            changesetProcessingType = ChangesetProcessingType.USE_NEW_AND_CLOSE;
+        }
         try {
-            changeset = new Changeset();
-            Properties sysProp = System.getProperties();
-            Object ua = sysProp.get("http.agent");
-            changeset.put("created_by", (ua == null) ? "JOSM" : ua.toString());
-            changeset.put("comment", comment);
-            createPrimitive(changeset, progressMonitor);
+            progressMonitor.beginTask((tr("Creating changeset...")));
+            if (changesetProcessingType.isUseNew()) {
+                Properties sysProp = System.getProperties();
+                Object ua = sysProp.get("http.agent");
+                changeset.put("created_by", (ua == null) ? "JOSM" : ua.toString());
+                createPrimitive(changeset, progressMonitor);
+                this.changeset = changeset;
+                progressMonitor.setCustomText((tr("Successfully opened changeset {0}",changeset.getId())));
+            } else {
+                if (this.changeset == null || this.changeset.getId() == 0) {
+                    progressMonitor.setCustomText((tr("No currently open changeset. Opening a new changeset...")));
+                    System.out.println(tr("Warning: could not reuse an existing changeset as requested. Opening a new one."));
+                    Properties sysProp = System.getProperties();
+                    Object ua = sysProp.get("http.agent");
+                    changeset.put("created_by", (ua == null) ? "JOSM" : ua.toString());
+                    createPrimitive(changeset, progressMonitor);
+                    this.changeset = changeset;
+                    progressMonitor.setCustomText((tr("Successfully opened changeset {0}",this.changeset.getId())));
+                } else {
+                    progressMonitor.setCustomText((tr("Reusing existing changeset {0}", this.changeset.getId())));
+                }
+            }
         } finally {
             progressMonitor.finishTask();
@@ -301 +327 @@
      * Closes a changeset on the server.
      *
+     * @param changesetProcessingType how changesets are currently handled
+     * @param progressMonitor the progress monitor
+     * 
      * @throws OsmTransferException if something goes wrong.
      */
-    public void stopChangeset(ProgressMonitor progressMonitor) throws OsmTransferException {
-        progressMonitor.beginTask(tr("Closing changeset {0}...", changeset.getId()));
+    public void stopChangeset(ChangesetProcessingType changesetProcessingType, ProgressMonitor progressMonitor) throws OsmTransferException {
+        if (changesetProcessingType == null) {
+            changesetProcessingType = ChangesetProcessingType.USE_NEW_AND_CLOSE;
+        }
         try {
+            progressMonitor.beginTask(tr("Closing changeset..."));
             initialize(progressMonitor);
-            sendRequest("PUT", "changeset" + "/" + changeset.getId() + "/close", null, progressMonitor);
-            changeset = null;
+            if (changesetProcessingType.isCloseAfterUpload()) {
+                progressMonitor.setCustomText(tr("Closing changeset {0}...", changeset.getId()));
+                if (this.changeset != null && this.changeset.getId() > 0) {
+                    sendRequest("PUT", "changeset" + "/" + changeset.getId() + "/close", null, progressMonitor);
+                    changeset = null;
+                }
+            } else {
+                progressMonitor.setCustomText(tr("Leaving changeset {0} open...", changeset.getId()));
+            }
         } finally {
             progressMonitor.finishTask();

trunk/src/org/openstreetmap/josm/io/OsmServerWriter.java

@@ -12 +12 @@
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.actions.UploadAction;
+import org.openstreetmap.josm.data.osm.Changeset;
 import org.openstreetmap.josm.data.osm.OsmPrimitive;
 import org.openstreetmap.josm.data.osm.OsmPrimitiveType;
@@ -81 +82 @@
      * 
      * @param primitives the collection of primitives to upload
+     * @param changeset the changeset to be used if <code>changesetProcessingType</code> indicates that
+     *   a new changeset should be opened
+     * @param changesetProcessingType how we handle changesets
      * @param progressMonitor the progress monitor
      * @throws OsmTransferException thrown if an exception occurs
      */
-    protected void uploadChangesIndividually(Collection<OsmPrimitive> primitives, ProgressMonitor progressMonitor) throws OsmTransferException {
+    protected void uploadChangesIndividually(Collection<OsmPrimitive> primitives, Changeset changeset, ChangesetProcessingType changesetProcessingType, ProgressMonitor progressMonitor) throws OsmTransferException {
         try {
             progressMonitor.setTicksCount(primitives.size());
-            api.createChangeset(getChangesetComment(), progressMonitor.createSubTaskMonitor(0, false));
+            api.createChangeset(changeset, changesetProcessingType,progressMonitor.createSubTaskMonitor(0, false));
             uploadStartTime = System.currentTimeMillis();
             for (OsmPrimitive osm : primitives) {
@@ -121 +125 @@
 
                 if (api.getCurrentChangeset() != null && api.getCurrentChangeset().getId() > 0) {
-                    api.stopChangeset(progressMonitor.createSubTaskMonitor(0, false));
+                    api.stopChangeset(changesetProcessingType, progressMonitor.createSubTaskMonitor(0, false));
                 }
             } catch(Exception e) {
@@ -138 +142 @@
      * @throws OsmTransferException thrown if an exception occurs
      */
-    protected void uploadChangesAsDiffUpload(Collection<OsmPrimitive> primitives, ProgressMonitor progressMonitor) throws OsmTransferException {
+    protected void uploadChangesAsDiffUpload(Collection<OsmPrimitive> primitives, Changeset changeset, ChangesetProcessingType changesetProcessingType, ProgressMonitor progressMonitor) throws OsmTransferException {
         // upload everything in one changeset
         //
         try {
-            api.createChangeset(getChangesetComment(), progressMonitor.createSubTaskMonitor(0, false));
+            api.createChangeset(changeset, changesetProcessingType, progressMonitor.createSubTaskMonitor(0, false));
             processed.addAll(api.uploadDiff(primitives, progressMonitor.createSubTaskMonitor(ProgressMonitor.ALL_TICKS, false)));
         } catch(OsmTransferException e) {
@@ -150 +154 @@
         } finally {
             try {
-                api.stopChangeset(progressMonitor.createSubTaskMonitor(0, false));
+                api.stopChangeset(changesetProcessingType, progressMonitor.createSubTaskMonitor(0, false));
             } catch (Exception ee) {
                 OsmChangesetCloseException closeException = new OsmChangesetCloseException(ee);
@@ -165 +169 @@
      * @param primitives list of objects to send
      */
-    public void uploadOsm(String apiVersion, Collection<OsmPrimitive> primitives, ProgressMonitor progressMonitor) throws OsmTransferException {
+    public void uploadOsm(String apiVersion, Collection<OsmPrimitive> primitives, Changeset changeset, ChangesetProcessingType changesetProcessingType, ProgressMonitor progressMonitor) throws OsmTransferException {
         processed = new LinkedList<OsmPrimitive>();
 
@@ -171 +175 @@
 
         try {
-            // check whether we can use changeset
+            // check whether we can use diff upload
             //
-            boolean canUseChangeset = api.hasChangesetSupport();
-            boolean useChangeset = Main.pref.getBoolean("osm-server.atomic-upload", apiVersion.compareTo("0.6")>=0);
-            if (useChangeset && ! canUseChangeset) {
-                System.out.println(tr("WARNING: preference ''{0}'' or api version ''{1}'' of dataset requires to use changesets, but API is not able to handle them. Ignoring changesets.", "osm-server.atomic-upload", apiVersion));
-                useChangeset = false;
-            }
-
-            if (useChangeset) {
+            boolean casUseDiffUploads = api.hasSupportForDiffUploads();
+            boolean useDiffUpload = Main.pref.getBoolean("osm-server.atomic-upload", apiVersion.compareTo("0.6")>=0);
+            if (useDiffUpload && ! casUseDiffUploads) {
+                System.out.println(tr("WARNING: preference ''{0}'' or api version ''{1}'' of dataset requires to use diff uploads, but API is not able to handle them. Ignoring diff upload.", "osm-server.atomic-upload", apiVersion));
+                useDiffUpload = false;
+            }
+
+            if (useDiffUpload) {
                 progressMonitor.beginTask(tr("Starting to upload in one request ..."));
-                uploadChangesAsDiffUpload(primitives, progressMonitor);
+                uploadChangesAsDiffUpload(primitives,changeset, changesetProcessingType, progressMonitor);
             } else {
                 progressMonitor.beginTask(tr("Starting to upload with one request per primitive ..."));
-                uploadChangesIndividually(primitives, progressMonitor);
+                uploadChangesIndividually(primitives,changeset,changesetProcessingType,  progressMonitor);
             }
         } finally {