Changeset 14219 in josm

Timestamp:

2018-09-02T21:53:46+02:00 (6 years ago)

Author:

Don-vip

Message:

fix #16695 - display remark from Overpass API when a download returns no data

Location:

trunk

Files:

• src/org/openstreetmap/josm/actions/downloadtasks/DownloadOsmTask.java (modified) (1 diff)
• src/org/openstreetmap/josm/data/osm/DataSet.java (modified) (2 diffs)
• src/org/openstreetmap/josm/io/OsmJsonReader.java (modified) (1 diff)
• src/org/openstreetmap/josm/io/OsmReader.java (modified) (3 diffs)
• test/unit/org/openstreetmap/josm/io/OsmJsonReaderTest.java (modified) (3 diffs)
• test/unit/org/openstreetmap/josm/io/OsmReaderTest.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadOsmTask.java

@@ -471 +471 @@
                     rememberErrorMessage(tr("No data found in this area."));
                 }
+                String remark = dataSet.getRemark();
+                if (remark != null && !remark.isEmpty()) {
+                    rememberErrorMessage(remark);
+                }
                 // need to synthesize a download bounds lest the visual indication of downloaded area doesn't work
                 dataSet.addDataSource(new DataSource(currentBounds != null ? currentBounds :

trunk/src/org/openstreetmap/josm/data/osm/DataSet.java

@@ -169 +169 @@
 
     private short mappaintCacheIdx = 1;
+    private String remark;
 
     /**
@@ -1231 +1232 @@
         }
     }
+
+    /**
+     * Returns an optional remark about this data set (used by Overpass API).
+     * @return a remark about this data set, or {@code null}
+     * @since 14219
+     */
+    public String getRemark() {
+        return remark;
+    }
+
+    /**
+     * Sets an optional remark about this data set (used by Overpass API).
+     * @param remark a remark about this data set, or {@code null}
+     * @since 14219
+     */
+    public void setRemark(String remark) {
+        this.remark = remark;
+    }
 }

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

@@ -67 +67 @@
         parseLocked(object.getString("locked", null));
         parseElements(object.getJsonArray("elements"));
+        parseRemark(object.getString("remark", null));
+    }
+
+    private void parseRemark(String remark) {
+        ds.setRemark(remark);
     }
 

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

@@ -103 +103 @@
             uploadChangesetId = getLong("upload-changeset");
         }
-        while (true) {
+        while (parser.hasNext()) {
             int event = parser.next();
 
@@ -127 +127 @@
                 case "changeset":
                     parseChangeset(uploadChangesetId);
+                    break;
+                case "remark": // Used by Overpass API
+                    parseRemark();
                     break;
                 default:
@@ -143 +146 @@
         } else {
             throwException(e);
+        }
+    }
+
+    private void parseRemark() throws XMLStreamException {
+        while (parser.hasNext()) {
+            int event = parser.next();
+            if (event == XMLStreamConstants.CHARACTERS) {
+                ds.setRemark(parser.getText());
+            } else if (event == XMLStreamConstants.END_ELEMENT) {
+                return;
+            }
         }
     }

trunk/test/unit/org/openstreetmap/josm/io/OsmJsonReaderTest.java

@@ -53 +53 @@
      */
     private static DataSet parse(String osm) throws Exception {
+        return parse(osm, "");
+    }
+
+    /**
+     * Parse JSON.
+     * @param osm OSM data in JSON format, without header/footer
+     * @param extraContent extra content added after OSM elements
+     * @return data set
+     * @throws Exception if any error occurs
+     */
+    private static DataSet parse(String osm, String extraContent) throws Exception {
         try (InputStream in = new ByteArrayInputStream((
                 "{\n" +
@@ -65 +76 @@
                 "  },\n" +
                 "  \"elements\": [" + osm + "]\n" +
+                extraContent +
                 "}")
                 .getBytes(StandardCharsets.UTF_8))) {
@@ -225 +237 @@
         assertEquals("route", r.get("type"));
     }
+
+    /**
+     * Test reading remark from Overpass API.
+     * @throws Exception if any error occurs
+     */
+    @Test
+    public void testRemark() throws Exception {
+        DataSet ds = parse("", "," +
+                "  \"remark\": \"runtime error: Query ran out of memory in \\\"query\\\" at line 5.\"\n");
+        assertEquals("runtime error: Query ran out of memory in \"query\" at line 5.", ds.getRemark());
+    }
 }

trunk/test/unit/org/openstreetmap/josm/io/OsmReaderTest.java

@@ -115 +115 @@
      * Test valid data.
      * @param osm OSM data without XML prefix
-     * @throws Exception if any error occurs
-     */
-    private static void testValidData(String osm) throws Exception {
+     * @return parsed data set
+     * @throws Exception if any error occurs
+     */
+    private static DataSet testValidData(String osm) throws Exception {
         try (InputStream in = new ByteArrayInputStream(
                 ("<?xml version='1.0' encoding='UTF-8'?>" + osm).getBytes(StandardCharsets.UTF_8))) {
-            OsmReader.parseDataSet(in, NullProgressMonitor.INSTANCE);
+            return OsmReader.parseDataSet(in, NullProgressMonitor.INSTANCE);
         }
     }
@@ -341 +342 @@
         }
     }
+
+    /**
+     * Test reading remark from Overpass API.
+     * @throws Exception if any error occurs
+     */
+    @Test
+    public void testRemark() throws Exception {
+        DataSet ds = testValidData(
+                "<osm version=\"0.6\" generator=\"Overpass API 0.7.55.4 3079d8ea\">\r\n" +
+                "<note>The data included in this document is from www.openstreetmap.org. The data is made available under ODbL.</note>\r\n" +
+                "<meta osm_base=\"2018-08-30T12:46:02Z\" areas=\"2018-08-30T12:40:02Z\"/>\r\n" +
+                "<remark>runtime error: Query ran out of memory in \"query\" at line 5.</remark>\r\n" +
+                "</osm>");
+        assertEquals("runtime error: Query ran out of memory in \"query\" at line 5.", ds.getRemark());
+    }
 }