Changeset 7531 in josm for trunk/src/org

Timestamp:

2014-09-13T00:40:11+02:00 (10 years ago)

Author:

bastiK

Message:

applied #10503 - Note download code (patch by ToeBee)

Location:

trunk/src/org/openstreetmap/josm

Files:

• actions/DownloadAction.java (modified) (2 diffs)
• actions/OpenLocationAction.java (modified) (2 diffs)
• actions/downloadtasks/DownloadNotesTask.java (added)
• io/BoundingBoxDownloader.java (modified) (2 diffs)
• io/OsmServerLocationReader.java (modified) (3 diffs)
• io/OsmServerReader.java (modified) (2 diffs)

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

@@ -11 +11 @@
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.actions.downloadtasks.DownloadGpsTask;
+import org.openstreetmap.josm.actions.downloadtasks.DownloadNotesTask;
 import org.openstreetmap.josm.actions.downloadtasks.DownloadOsmTask;
 import org.openstreetmap.josm.actions.downloadtasks.PostDownloadHandler;
@@ -54 +55 @@
                 Main.worker.submit(new PostDownloadHandler(task, future));
             }
+
+            //TODO: This eventually needs to be a checkbox in the UI
+            //For now I'm adding it as a hidden feature since this is still a work in progress
+            if (Main.pref.getBoolean("osm.notes.enableDownload", false)) {
+                DownloadNotesTask task = new DownloadNotesTask();
+                Future<?> future = task.download(false, area, null);
+                Main.worker.submit(new PostDownloadHandler(task, future));
+            }
         }
     }

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

@@ -23 +23 @@
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.actions.downloadtasks.DownloadGpsTask;
+import org.openstreetmap.josm.actions.downloadtasks.DownloadNotesTask;
 import org.openstreetmap.josm.actions.downloadtasks.DownloadOsmChangeCompressedTask;
 import org.openstreetmap.josm.actions.downloadtasks.DownloadOsmChangeTask;
@@ -59 +60 @@
         addDownloadTaskClass(DownloadOsmTask.class);
         addDownloadTaskClass(DownloadGpsTask.class);
+        addDownloadTaskClass(DownloadNotesTask.class);
         addDownloadTaskClass(DownloadOsmChangeTask.class);
         addDownloadTaskClass(DownloadOsmUrlTask.class);

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

@@ -6 +6 @@
 import java.io.IOException;
 import java.io.InputStream;
-
+import java.util.List;
+
+import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.data.Bounds;
 import org.openstreetmap.josm.data.gpx.GpxData;
+import org.openstreetmap.josm.data.notes.Note;
 import org.openstreetmap.josm.data.osm.DataSet;
 import org.openstreetmap.josm.gui.progress.ProgressMonitor;
@@ -154 +157 @@
         }
     }
+
+    @Override
+    public List<Note> parseNotes(Integer noteLimit, Integer daysClosed, ProgressMonitor progressMonitor) throws OsmTransferException {
+        progressMonitor.beginTask("Downloading notes");
+        noteLimit = checkNoteLimit(noteLimit);
+        daysClosed = checkDaysClosed(daysClosed);
+        String url = new StringBuilder()
+        .append("notes?limit=")
+        .append(noteLimit)
+        .append("&closed=")
+        .append(daysClosed)
+        .append("&bbox=")
+        .append(lon1)
+        .append(",").append(lat1)
+        .append(",").append(lon2)
+        .append(",").append(lat2)
+        .toString();
+        try {
+            InputStream is = getInputStream(url, progressMonitor.createSubTaskMonitor(1, false));
+            NoteReader reader = new NoteReader(is);
+            return reader.parse();
+        } catch (IOException e) {
+            throw new OsmTransferException(e);
+        } catch (SAXException e) {
+            throw new OsmTransferException(e);
+        } finally {
+            progressMonitor.finishTask();
+        }
+    }
+
+    private Integer checkNoteLimit(Integer limit) {
+        if (limit == null) {
+            limit = Main.pref.getInteger("osm.notes.downloadLimit", 1000);
+        }
+        if (limit > 10000) {
+            Main.error("Requested note limit is over API hard limit of 10000. Reducing to 10000.");
+            limit = 10000;
+        }
+        if (limit < 1) {
+            Main.error("Requested note limit is less than 1. Setting to 1.");
+            limit = 1;
+        }
+        Main.debug("returning note limit: " + limit);
+        return limit;
+    }
+
+    private Integer checkDaysClosed(Integer days) {
+        if (days == null) {
+            days = Main.pref.getInteger("osm.notes.daysClosed", 1);
+        }
+        if (days < -1) {
+            Main.error("Requested days closed must be greater than -1");
+            days = -1;
+        }
+        Main.debug("returning days closed: " + days);
+        return days;
+    }
+
 }

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

@@ -6 +6 @@
 import java.io.IOException;
 import java.io.InputStream;
+import java.util.ArrayList;
+import java.util.List;
 
 import org.openstreetmap.josm.actions.downloadtasks.DownloadGpsTask;
 import org.openstreetmap.josm.data.gpx.GpxData;
+import org.openstreetmap.josm.data.notes.Note;
 import org.openstreetmap.josm.data.osm.DataSet;
 import org.openstreetmap.josm.gui.progress.ProgressMonitor;
@@ -106 +109 @@
     }
 
+    @Override
+    public List<Note> parseRawNotes(final ProgressMonitor progressMonitor) throws OsmTransferException {
+        return doParse(new NoteParser(progressMonitor, Compression.NONE), progressMonitor);
+    }
+
+    @Override
+    public List<Note> parseRawNotesBzip2(final ProgressMonitor progressMonitor) throws OsmTransferException {
+        return doParse(new NoteParser(progressMonitor, Compression.BZIP2), progressMonitor);
+    }
+
     protected class OsmParser extends Parser<DataSet> {
         protected OsmParser(ProgressMonitor progressMonitor, Compression compression) {
@@ -154 +167 @@
         }
     }
+
+    protected class NoteParser extends Parser<List<Note>> {
+
+        public NoteParser(ProgressMonitor progressMonitor, Compression compression) {
+            super(progressMonitor, compression);
+        }
+
+        @Override
+        public List<Note> parse() throws OsmTransferException, IllegalDataException, IOException, SAXException {
+            in = getInputStream(url, progressMonitor.createSubTaskMonitor(1, true));
+            if (in == null) {
+                return new ArrayList<Note>();
+            }
+            progressMonitor.subTask(tr("Downloading OSM notes..."));
+            NoteReader reader = new NoteReader(compression.getUncompressedInputStream(in));
+            return reader.parse();
+        }
+    }
 }

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

@@ -20 +20 @@
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.data.gpx.GpxData;
+import org.openstreetmap.josm.data.notes.Note;
 import org.openstreetmap.josm.data.osm.DataSet;
 import org.openstreetmap.josm.gui.progress.ProgressMonitor;
@@ -349 +350 @@
         return gpxParsedProperly;
     }
+
+    /**
+     * Downloads notes from the API, given API limit parameters
+     *
+     * @param noteLimit How many notes to download. Defaults to 1000 if not specified. API has a hard limit of 10000
+     * @param daysClosed Return notes closed this many days in the past. -1 means all notes, ever. 0 means only unresolved notes.
+     * @param progressMonitor Progress monitor for user feedback
+     * @return List of notes returned by the API
+     * @throws OsmTransferException if any errors happen
+     */
+    public List<Note> parseNotes(Integer noteLimit, Integer daysClosed, ProgressMonitor progressMonitor) throws OsmTransferException {
+        return null;
+    }
+
+    /**
+     * Downloads notes from a given raw URL. The URL is assumed to be complete and no API limits are added
+     *
+     * @param progressMonitor
+     * @return A list of notes parsed from the URL
+     * @throws OsmTransferException
+     */
+    public List<Note> parseRawNotes(final ProgressMonitor progressMonitor) throws OsmTransferException {
+        return null;
+    }
+
+    /**
+     * Download notes from a URL that contains a bzip2 compressed notes dump file
+     * @param progressMonitor
+     * @return A list of notes parsed from the URL
+     * @throws OsmTransferException
+     */
+    public List<Note> parseRawNotesBzip2(final ProgressMonitor progressMonitor) throws OsmTransferException {
+        return null;
+    }
 }