Changeset 1663 in josm for trunk/src/org/openstreetmap/josm/io/OsmApi.java

Timestamp:

2009-06-10T23:15:32+02:00 (17 years ago)

Author:

Gubaer

Message:

#2437: cleaned up code for uploading and improved user feedback in case of 409 conflicts

File:

• trunk/src/org/openstreetmap/josm/io/OsmApi.java (modified) (10 diffs)

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

@@ -23 +23 @@
 import java.util.Properties;
 import java.util.StringTokenizer;
-import java.util.concurrent.FutureTask;
 
 import javax.xml.parsers.SAXParserFactory;
@@ -34 +33 @@
 import org.openstreetmap.josm.data.osm.Way;
 import org.openstreetmap.josm.data.osm.visitor.CreateOsmChangeVisitor;
-import org.openstreetmap.josm.gui.PleaseWaitRunnable;
 import org.xml.sax.Attributes;
 import org.xml.sax.InputSource;
@@ -50 +48 @@
  */
 public class OsmApi extends OsmConnection {
+    /** max number of retries to send a request in case of HTTP 500 errors or timeouts */
+    static public final int DEFAULT_MAX_NUM_RETRIES = 5;
 
     /**
@@ -93 +93 @@
                 minVersion = atts.getValue("minimum");
                 maxVersion = atts.getValue("maximum");
-            } else if (qName.equals("area"))
+            } else if (qName.equals("area")) {
                 maxArea = atts.getValue("maximum");
+            }
         }
     }
@@ -132 +133 @@
      * @exception UnknownHostException thrown, if the API host is unknown
      * @exception SocketTimeoutException thrown, if the connection to the API host  times out
-     * @exception ConnectException throw, if the connection to the API host fails 
-     * @exception Exception any other exception 
+     * @exception ConnectException throw, if the connection to the API host fails
+     * @exception Exception any other exception
      */
     public void initialize() throws UnknownHostException,SocketTimeoutException, ConnectException,Exception {
@@ -149 +150 @@
                 System.err.println(tr("This version of JOSM is incompatible with the configured server."));
                 System.err.println(tr("It supports protocol versions 0.5 and 0.6, while the server says it supports {0} to {1}.",
-                    minVersion, maxVersion));
+                        minVersion, maxVersion));
                 initialized = false;
             }
             System.out.println(tr("Communications with {0} established using protocol version {1}",
-                Main.pref.get("osm-server.url"),
-                version));
+                    Main.pref.get("osm-server.url"),
+                    version));
             osmWriter.setVersion(version);
         } catch (Exception ex) {
@@ -302 +303 @@
     public Collection<OsmPrimitive> uploadDiff(final Collection<OsmPrimitive> list) throws OsmTransferException {
 
-        if (changeset == null) {
+        if (changeset == null)
             throw new OsmTransferException(tr("No changeset present for diff upload"));
-        }
-
 
         final ArrayList<OsmPrimitive> processed = new ArrayList<OsmPrimitive>();
 
-        // this is the asynchronous update task
-        //
-        class UploadDiffTask extends  PleaseWaitRunnable {
-
-            private boolean uploadCancelled = false;
-            private boolean uploadFailed = false;
-            private Throwable lastThrowable = null;
-
-            public UploadDiffTask(String title) {
-                super(title,false /* don't ignore exceptions */);
-            }
-
-            @Override protected void realRun() throws SAXException, IOException {
-                CreateOsmChangeVisitor duv = new CreateOsmChangeVisitor(changeset, OsmApi.this);
-
-                for (OsmPrimitive osm : list) {
-                    int progress = Main.pleaseWaitDlg.progress.getValue();
-                    Main.pleaseWaitDlg.currentAction.setText(tr("Preparing..."));
-                    osm.visit(duv);
-                    Main.pleaseWaitDlg.progress.setValue(progress+1);
-                }
-
-                Main.pleaseWaitDlg.currentAction.setText(tr("Uploading..."));
-
-                String diff = duv.getDocument();
-                try {
-                    String diffresult = sendRequest("POST", "changeset/" + changeset.id + "/upload", diff);
-                    DiffResultReader.parseDiffResult(diffresult, list, processed, duv.getNewIdMap(), Main.pleaseWaitDlg);
-                } catch (Exception sxe) {
-                    if (isUploadCancelled()) {
-                        // ignore exceptions thrown because the connection is aborted,
-                        // i.e. IOExceptions or SocketExceptions
-                        //
-                        System.out.println("Ignoring exception caught because upload is cancelled. Exception is: " + sxe.toString());
-                        return;
-                    }
-                    uploadFailed = true;
-                    // remember last exception and don't throw it. If it was thrown again it would
-                    // have to be encapsulated in a RuntimeException which would be nested in yet
-                    // another RuntimeException by parent classes.
-                    // Rather check isUploadFailed() and retrieve getLastThrowable() after the task
-                    // is completed
-                    //
-                    lastThrowable = sxe;
-                }
-            }
-
-            @Override protected void finish() {
-                // do nothing
-            }
-
-            @Override protected void cancel() {
-                activeConnection.disconnect();
-                uploadCancelled = true;
-            }
-
-            public boolean isUploadCancelled() {
-                return uploadCancelled;
-            }
-
-            public boolean isUploadFailed() {
-                return uploadFailed;
-            }
-
-            public Throwable getLastThrowable() {
-                return lastThrowable;
-            }
-        }
-
-        UploadDiffTask uploadTask = new UploadDiffTask(tr("Uploading data"));
-
-        // run  data upload as asynchronous task
-        //
+
+        CreateOsmChangeVisitor duv = new CreateOsmChangeVisitor(changeset, OsmApi.this);
+
+        for (OsmPrimitive osm : list) {
+            int progress = Main.pleaseWaitDlg.progress.getValue();
+            Main.pleaseWaitDlg.currentAction.setText(tr("Preparing..."));
+            osm.visit(duv);
+            Main.pleaseWaitDlg.progress.setValue(progress+1);
+        }
+
+        Main.pleaseWaitDlg.currentAction.setText(tr("Uploading..."));
+
+        String diff = duv.getDocument();
+        String diffresult = sendRequest("POST", "changeset/" + changeset.id + "/upload", diff);
         try {
-            Void result = null;
-            FutureTask<Void> task = new FutureTask<Void>(uploadTask, result);
-            task.run();
-            task.get(); // wait for the task to complete, no return value expected, though
-        }  catch(Throwable e) {
-            if (uploadTask.isUploadCancelled()) {
-                throw new OsmTransferCancelledException();
-            }
+            DiffResultReader.parseDiffResult(diffresult, list, processed, duv.getNewIdMap(), Main.pleaseWaitDlg);
+        } catch(Exception e) {
             throw new OsmTransferException(e);
-        }
-
-        // handle failed upload
-        //
-        if (uploadTask.isUploadFailed()) {
-            if (uploadTask.getLastThrowable() != null && uploadTask.getLastThrowable() instanceof OsmTransferException) {
-                OsmTransferException e = (OsmTransferException)uploadTask.getLastThrowable();
-                throw e;
-            }
-            // shouldn't happen, but just in case
-            //
-            throw new OsmTransferException(tr("Data upload failed for unknown reason"));
-        }
-
-        // handle cancelled upload
-        //
-        if (uploadTask.isUploadCancelled()) {
-            throw new OsmTransferCancelledException();
         }
 
@@ -420 +336 @@
         // System.out.print("backing off for 10 seconds...");
         for(int i=0; i < 10; i++) {
-            if (cancel || isAuthCancelled()) {
+            if (cancel || isAuthCancelled())
                 throw new OsmTransferCancelledException();
-            }
             try {
                 Thread.sleep(1000);
@@ -450 +365 @@
 
         StringBuffer responseBody = new StringBuffer();
-        StringBuffer statusMessage = new StringBuffer();
-
-        int retries = 5; // configurable?
+
+        int retries = Main.pref.getInteger("osm-server.max-num-retries", DEFAULT_MAX_NUM_RETRIES);
+        retries = Math.max(0,retries);
+
 
         while(true) { // the retry loop
@@ -511 +427 @@
                     responseBody.append("\n");
                 }
-
-                statusMessage.setLength(0);
+                String errorHeader = null;
                 // Look for a detailed error message from the server
                 if (activeConnection.getHeaderField("Error") != null) {
-                    String er = activeConnection.getHeaderField("Error");
-                    System.err.println("Error header: " + er);
-                    statusMessage.append(tr(er));
+                    errorHeader = activeConnection.getHeaderField("Error");
+                    System.err.println("Error header: " + errorHeader);
                 } else if (retCode != 200 && responseBody.length()>0) {
                     System.err.println("Error body: " + responseBody);
-                    statusMessage.append(tr(responseBody.toString()));
-                } else {
-                    statusMessage.append(activeConnection.getResponseMessage());
                 }
                 activeConnection.disconnect();
 
-                if (retCode != 200) {
-                    throw new OsmTransferException(statusMessage.toString());
-                }
+                if (retCode != 200)
+                    throw new OsmApiException(retCode,errorHeader,responseBody.toString());
+
                 return responseBody.toString();
             } catch (UnknownHostException e) {
-                throw new OsmTransferException(tr("Unknown host")+": "+e.getMessage(), e);
+                throw new OsmTransferException(e);
             } catch (SocketTimeoutException e) {
-                if (retries-- > 0)
+                if (retries-- > 0) {
                     continue;
-                throw new OsmTransferException(e.getMessage()+ " " + e.getClass().getCanonicalName(), e);
+                }
+                throw new OsmTransferException(e);
             } catch (ConnectException e) {
-                if (retries-- > 0)
+                if (retries-- > 0) {
                     continue;
-                throw new OsmTransferException(e.getMessage()+ " " + e.getClass().getCanonicalName(), e);
+                }
+                throw new OsmTransferException(e);
             } catch (Exception e) {
                 if (e instanceof OsmTransferException) throw (OsmTransferException) e;