Changeset 9185 in josm for trunk/src

Timestamp:

2015-12-28T01:42:36+01:00 (9 years ago)

Author:

simon04

Message:

see #12231 - HttpClient now reports status to ProgressMonitor

Location:

trunk/src/org/openstreetmap/josm

Files:

• io/OsmServerReader.java (modified) (2 diffs)
• io/ProgressInputStream.java (modified) (4 diffs)
• io/ProgressOutputStream.java (added)
• io/ProgressStream.java (added)
• tools/HttpClient.java (modified) (8 diffs)

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

@@ -131 +131 @@
 
             try {
-                activeConnection = client.connect();
+                activeConnection = client.connect(progressMonitor);
             } catch (Exception e) {
                 Main.error(e);
@@ -158 +158 @@
 
                 activeConnection.uncompressAccordingToContentDisposition(uncompressAccordingToContentDisposition);
-                InputStream in = new ProgressInputStream(activeConnection, progressMonitor);
-                return in;
+                return activeConnection.getContent();
             } catch (OsmTransferException e) {
                 throw e;

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

@@ -10 +10 @@
 import org.openstreetmap.josm.gui.progress.NullProgressMonitor;
 import org.openstreetmap.josm.gui.progress.ProgressMonitor;
-import org.openstreetmap.josm.tools.HttpClient;
 
 /**
@@ -18 +17 @@
 public class ProgressInputStream extends InputStream {
 
+    private final StreamProgressUpdater updater;
     private final InputStream in;
-    private final long size;
-    private int readSoFar;
-    private int lastDialogUpdate;
-    private final ProgressMonitor progressMonitor;
 
+    /**
+     * Constructs a new {@code ProgressInputStream}.
+     *
+     * @param in the stream to monitor
+     * @param size the total size which will be sent
+     * @param progressMonitor the monitor to report to
+     * @since 9172
+     */
     public ProgressInputStream(InputStream in, long size, ProgressMonitor progressMonitor) {
         if (progressMonitor == null) {
             progressMonitor = NullProgressMonitor.INSTANCE;
         }
+        this.updater = new StreamProgressUpdater(size, progressMonitor, tr("Downloading data..."));
         this.in = in;
-        this.size = size;
-        this.progressMonitor = progressMonitor;
-        progressMonitor.beginTask(tr("Contacting OSM Server..."), 1);
-        progressMonitor.indeterminateSubTask(null);
-        initProgressMonitor();
     }
 
-    public ProgressInputStream(HttpClient.Response response, ProgressMonitor progressMonitor) throws IOException {
-        this(response.getContent(), response.getContentLength(), progressMonitor);
-    }
-
+    /**
+     * Constructs a new {@code ProgressInputStream}.
+     *
+     * Will call {@link URLConnection#getInputStream()} to obtain the stream to monitor.
+     *
+     * @param con the connection to monitor
+     * @param progressMonitor the monitor to report to
+     */
     public ProgressInputStream(URLConnection con, ProgressMonitor progressMonitor) throws OsmTransferException {
         if (progressMonitor == null) {
             progressMonitor = NullProgressMonitor.INSTANCE;
         }
-        this.progressMonitor = progressMonitor;
         progressMonitor.beginTask(tr("Contacting OSM Server..."), 1);
         progressMonitor.indeterminateSubTask(null);
@@ -50 +53 @@
         try {
             this.in = con.getInputStream();
-            this.size = con.getContentLength();
+            this.updater = new StreamProgressUpdater(con.getContentLength(), progressMonitor, tr("Downloading data..."));
         } catch (IOException e) {
             progressMonitor.finishTask();
@@ -57 +60 @@
             throw new OsmTransferException(e);
         }
-        initProgressMonitor();
     }
 
-    protected void initProgressMonitor() {
-        if (size > 0) {
-            progressMonitor.subTask(tr("Downloading OSM data..."));
-            progressMonitor.setTicksCount((int) size);
-        } else {
-            progressMonitor.indeterminateSubTask(tr("Downloading OSM data..."));
+    @Override
+    public void close() throws IOException {
+        try {
+            in.close();
+        } finally {
+            updater.finishTask();
         }
     }
 
-    @Override public void close() throws IOException {
-        try {
-            in.close();
-        } finally {
-            progressMonitor.finishTask();
-        }
-    }
-
-    @Override public int read(byte[] b, int off, int len) throws IOException {
+    @Override
+    public int read(byte[] b, int off, int len) throws IOException {
         int read = in.read(b, off, len);
         if (read != -1) {
-            advanceTicker(read);
+            updater.advanceTicker(read);
         } else {
-            progressMonitor.finishTask();
+            updater.finishTask();
         }
         return read;
     }
 
-    @Override public int read() throws IOException {
+    @Override
+    public int read() throws IOException {
         int read = in.read();
         if (read != -1) {
-            advanceTicker(1);
+            updater.advanceTicker(1);
         } else {
-            progressMonitor.finishTask();
+            updater.finishTask();
         }
         return read;
     }
-
-    /**
-     * Increase ticker (progress counter and displayed text) by the given amount.
-     * @param amount number of ticks
-     */
-    private void advanceTicker(int amount) {
-        readSoFar += amount;
-
-        if (readSoFar / 1024 != lastDialogUpdate) {
-            lastDialogUpdate++;
-            if (size > 0) {
-                progressMonitor.setTicks(readSoFar);
-            }
-            progressMonitor.setExtraText(readSoFar/1024 + " KB");
-        }
-    }
 }

trunk/src/org/openstreetmap/josm/tools/HttpClient.java

@@ -22 +22 @@
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.data.Version;
+import org.openstreetmap.josm.gui.progress.NullProgressMonitor;
 import org.openstreetmap.josm.gui.progress.ProgressMonitor;
 import org.openstreetmap.josm.io.Compression;
+import org.openstreetmap.josm.io.ProgressInputStream;
+import org.openstreetmap.josm.io.ProgressOutputStream;
 import org.openstreetmap.josm.io.UTFInputStreamReader;
 
@@ -61 +64 @@
     /**
      * Opens the HTTP connection.
-     * @param monitor progress monitor
+     * @param progressMonitor progress monitor
      * @return HTTP response
      * @throws IOException if any I/O error occurs
      * @since 9179
      */
-    public Response connect(ProgressMonitor monitor) throws IOException {
+    public Response connect(ProgressMonitor progressMonitor) throws IOException {
+        if (progressMonitor == null) {
+            progressMonitor = NullProgressMonitor.INSTANCE;
+        }
         final HttpURLConnection connection = (HttpURLConnection) url.openConnection();
         connection.setRequestMethod(requestMethod);
@@ -89 +95 @@
         }
 
-        // FIXME: use ProgressMonitor
+        progressMonitor.beginTask(tr("Contacting Server..."), 1);
+        progressMonitor.indeterminateSubTask(null);
 
         if ("PUT".equals(requestMethod) || "POST".equals(requestMethod) || "DELETE".equals(requestMethod)) {
@@ -95 +102 @@
             headers.put("Content-Length", String.valueOf(requestBody.length));
             connection.setDoOutput(true);
-            try (OutputStream out = new BufferedOutputStream(connection.getOutputStream())) {
+            try (OutputStream out = new BufferedOutputStream(
+                    new ProgressOutputStream(connection.getOutputStream(), requestBody.length, progressMonitor))) {
                 out.write(requestBody);
             }
@@ -137 +145 @@
                 }
             }
-            Response response = new Response(connection);
+            Response response = new Response(connection, progressMonitor);
             successfulConnection = true;
             return response;
@@ -152 +160 @@
     public static final class Response {
         private final HttpURLConnection connection;
+        private final ProgressMonitor monitor;
         private final int responseCode;
         private final String responseMessage;
@@ -157 +166 @@
         private boolean uncompressAccordingToContentDisposition;
 
-        private Response(HttpURLConnection connection) throws IOException {
+        private Response(HttpURLConnection connection, ProgressMonitor monitor) throws IOException {
             CheckParameterUtil.ensureParameterNotNull(connection, "connection");
+            CheckParameterUtil.ensureParameterNotNull(monitor, "monitor");
             this.connection = connection;
+            this.monitor = monitor;
             this.responseCode = connection.getResponseCode();
             this.responseMessage = connection.getResponseMessage();
@@ -227 +238 @@
                 in = connection.getErrorStream();
             }
+            in = new ProgressInputStream(in, getContentLength(), monitor);
             in = "gzip".equalsIgnoreCase(getContentEncoding()) ? new GZIPInputStream(in) : in;
             Compression compression = Compression.NONE;