Changeset 18365 in josm

Timestamp:

2022-01-25T19:05:27+01:00 (20 months ago)

Author:

Don-vip

Message:

see #15182 - make JOSM callable as standalone validator (patch by taylor.smock)

Location:

trunk

Files:

• src/org/openstreetmap/josm/data/validation/ValidatorCLI.java (added)
• src/org/openstreetmap/josm/data/validation/tests/MapCSSTagChecker.java (modified) (2 diffs)
• src/org/openstreetmap/josm/data/validation/tests/MapCSSTagCheckerAsserts.java (modified) (2 diffs)
• src/org/openstreetmap/josm/data/validation/tests/MapCSSTagCheckerRule.java (modified) (4 diffs)
• src/org/openstreetmap/josm/gui/MainApplication.java (modified) (3 diffs)
• src/org/openstreetmap/josm/gui/io/importexport/OsmImporter.java (modified) (1 diff)
• src/org/openstreetmap/josm/gui/preferences/projection/CustomProjectionChoice.java (modified) (3 diffs)
• src/org/openstreetmap/josm/gui/progress/AbstractProgressMonitor.java (modified) (1 diff)
• src/org/openstreetmap/josm/gui/progress/CLIProgressMonitor.java (added)
• src/org/openstreetmap/josm/gui/util/GuiHelper.java (modified) (1 diff)
• src/org/openstreetmap/josm/io/GeoJSONMapRouletteWriter.java (added)
• src/org/openstreetmap/josm/io/GeoJSONWriter.java (modified) (10 diffs)
• test/unit/org/openstreetmap/josm/data/validation/ValidatorCLITest.java (added)

trunk/src/org/openstreetmap/josm/data/validation/tests/MapCSSTagChecker.java

@@ -255 +255 @@
 
     /**
-     * A handler for assertion error messages (for not fulfilled "assertMatch", "assertNoMatch").
-     */
-    @FunctionalInterface
-    interface AssertionConsumer extends Consumer<String> {
-    }
-
-    /**
      * Adds a new MapCSS config file from the given URL.
      * @param url The unique URL of the MapCSS config file
@@ -275 +268 @@
     }
 
-    synchronized ParseResult addMapCSS(String url, AssertionConsumer assertionConsumer) throws ParseException, IOException {
+    /**
+     * Adds a new MapCSS config file from the given URL. <br />
+     * NOTE: You should prefer {@link #addMapCSS(String)} unless you <i>need</i> to know what the assertions return.
+     *
+     * @param url The unique URL of the MapCSS config file
+     * @param assertionConsumer A string consumer for error messages.
+     * @return List of tag checks and parsing errors, or null
+     * @throws ParseException if the config file does not match MapCSS syntax
+     * @throws IOException if any I/O error occurs
+     * @since 18365 (public, primarily for ValidatorCLI)
+     */
+    public synchronized ParseResult addMapCSS(String url, Consumer<String> assertionConsumer) throws ParseException, IOException {
         CheckParameterUtil.ensureParameterNotNull(url, "url");
         ParseResult result;

trunk/src/org/openstreetmap/josm/data/validation/tests/MapCSSTagCheckerAsserts.java

@@ -11 +11 @@
 import java.util.Optional;
 import java.util.Set;
+import java.util.function.Consumer;
 import java.util.stream.Collectors;
 
@@ -47 +48 @@
      */
     static void checkAsserts(final MapCSSTagCheckerRule check, final Map<String, Boolean> assertions,
-                             final MapCSSTagChecker.AssertionConsumer assertionConsumer) {
+                             final Consumer<String> assertionConsumer) {
         final DataSet ds = new DataSet();
         Logging.debug("Check: {0}", check);

trunk/src/org/openstreetmap/josm/data/validation/tests/MapCSSTagCheckerRule.java

@@ -16 +16 @@
 import java.util.Optional;
 import java.util.Set;
+import java.util.function.Consumer;
 import java.util.function.Predicate;
 import java.util.regex.Matcher;
@@ -32 +33 @@
 import org.openstreetmap.josm.data.validation.Test;
 import org.openstreetmap.josm.data.validation.TestError;
-import org.openstreetmap.josm.data.validation.tests.MapCSSTagChecker.AssertionConsumer;
 import org.openstreetmap.josm.gui.mappaint.Environment;
 import org.openstreetmap.josm.gui.mappaint.Keyword;
@@ -107 +107 @@
     private static final String POSSIBLE_THROWS = "throwError/throwWarning/throwOther";
 
-    static MapCSSTagCheckerRule ofMapCSSRule(final MapCSSRule rule, AssertionConsumer assertionConsumer) throws IllegalDataException {
+    static MapCSSTagCheckerRule ofMapCSSRule(final MapCSSRule rule, Consumer<String> assertionConsumer) throws IllegalDataException {
         final MapCSSTagCheckerRule check = new MapCSSTagCheckerRule(rule);
         final Map<String, Boolean> assertions = new HashMap<>();
@@ -186 +186 @@
     }
 
-    static MapCSSTagChecker.ParseResult readMapCSS(Reader css, AssertionConsumer assertionConsumer) throws ParseException {
+    static MapCSSTagChecker.ParseResult readMapCSS(Reader css, Consumer<String> assertionConsumer) throws ParseException {
         CheckParameterUtil.ensureParameterNotNull(css, "css");
 

trunk/src/org/openstreetmap/josm/gui/MainApplication.java

@@ -99 +99 @@
 import org.openstreetmap.josm.data.projection.datum.NTV2GridShiftFileWrapper;
 import org.openstreetmap.josm.data.projection.datum.NTV2Proj4DirGridShiftFileSource;
+import org.openstreetmap.josm.data.validation.ValidatorCLI;
 import org.openstreetmap.josm.data.validation.tests.MapCSSTagChecker;
 import org.openstreetmap.josm.gui.ProgramArguments.Option;
@@ -312 +313 @@
         registerCLIModule(ProjectionCLI.INSTANCE);
         registerCLIModule(RenderingCLI.INSTANCE);
+        registerCLIModule(ValidatorCLI.INSTANCE);
     }
 
@@ -661 +663 @@
                 "\trunjosm     "+tr("launch JOSM (default, performed when no command is specified)")+'\n'+
                 "\trender      "+tr("render data and save the result to an image file")+'\n'+
-                "\tproject     "+tr("convert coordinates from one coordinate reference system to another")+"\n\n"+
+                "\tproject     " + tr("convert coordinates from one coordinate reference system to another")+ '\n' +
+                "\tvalidate    " + tr("validate data") + "\n\n" +
                 tr("For details on the {0} and {1} commands, run them with the {2} option.", "render", "project", "--help")+'\n'+
                 tr("The remainder of this help page documents the {0} command.", "runjosm")+"\n\n"+

trunk/src/org/openstreetmap/josm/gui/io/importexport/OsmImporter.java

@@ -98 +98 @@
                 associatedFile == null ? OsmDataLayer.createNewName() : associatedFile.getName(), pm);
 
+        final OsmDataLayer layer = data.getLayer();
+        // Note: addLayer calls GuiHelper.runInEDTAndWaitWithException
+        MainApplication.getLayerManager().addLayer(layer);
         // FIXME: remove UI stuff from IO subsystem
         GuiHelper.runInEDT(() -> {
-            OsmDataLayer layer = data.getLayer();
-            MainApplication.getLayerManager().addLayer(layer);
             data.getPostLayerTask().run();
             data.getLayer().onPostLoadFromFile();

trunk/src/org/openstreetmap/josm/gui/preferences/projection/CustomProjectionChoice.java

@@ -24 +24 @@
 import org.openstreetmap.josm.data.projection.Projections;
 import org.openstreetmap.josm.gui.ExtendedDialog;
+import org.openstreetmap.josm.gui.tagging.ac.AutoCompTextField;
 import org.openstreetmap.josm.gui.widgets.AbstractTextComponentValidator;
 import org.openstreetmap.josm.gui.widgets.HistoryComboBox;
@@ -53 +54 @@
     private static class PreferencePanel extends JPanel {
 
-        public JosmTextField input;
+        public AutoCompTextField<String> input;
         private HistoryComboBox cbInput;
 
@@ -61 +62 @@
 
         private void build(String initialText, final ActionListener listener) {
-            input = new JosmTextField(30);
+            input = new AutoCompTextField<>(30);
             cbInput = new HistoryComboBox();
             cbInput.setEditor(new BasicComboBoxEditor() {

trunk/src/org/openstreetmap/josm/gui/progress/AbstractProgressMonitor.java

@@ -234 +234 @@
     ==================*/
 
+    /**
+     * Update progress message
+     * @param value The percentage of completion (this and child progress)
+     */
     protected abstract void updateProgress(double value);
 

trunk/src/org/openstreetmap/josm/gui/util/GuiHelper.java

@@ -289 +289 @@
      */
     public static void assertCallFromEdt() {
-        if (!SwingUtilities.isEventDispatchThread()) {
+        if (!SwingUtilities.isEventDispatchThread() && !GraphicsEnvironment.isHeadless()) {
             throw new IllegalStateException(
                     "Needs to be called from the EDT thread, not from " + Thread.currentThread().getName());

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

@@ -7 +7 @@
 import java.math.BigDecimal;
 import java.math.RoundingMode;
+import java.time.Instant;
+import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
+import java.util.EnumSet;
 import java.util.HashSet;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
-import java.util.Map.Entry;
 import java.util.Set;
+import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
@@ -31 +35 @@
 import org.openstreetmap.josm.data.coor.LatLon;
 import org.openstreetmap.josm.data.osm.DataSet;
+import org.openstreetmap.josm.data.osm.INode;
+import org.openstreetmap.josm.data.osm.IWay;
 import org.openstreetmap.josm.data.osm.MultipolygonBuilder;
-import org.openstreetmap.josm.data.osm.MultipolygonBuilder.JoinedPolygon;
 import org.openstreetmap.josm.data.osm.Node;
 import org.openstreetmap.josm.data.osm.OsmPrimitive;
 import org.openstreetmap.josm.data.osm.Relation;
+import org.openstreetmap.josm.data.osm.RelationMember;
 import org.openstreetmap.josm.data.osm.Way;
 import org.openstreetmap.josm.data.osm.visitor.OsmPrimitiveVisitor;
@@ -42 +48 @@
 import org.openstreetmap.josm.data.projection.Projections;
 import org.openstreetmap.josm.gui.mappaint.ElemStyles;
+import org.openstreetmap.josm.tools.Geometry;
 import org.openstreetmap.josm.tools.Logging;
 import org.openstreetmap.josm.tools.Pair;
+import org.openstreetmap.josm.tools.Utils;
 
 /**
@@ -52 +60 @@
 public class GeoJSONWriter {
 
+    enum Options {
+        /** If using the right hand rule, we have to ensure that the "right" side is the interior of the object. */
+        RIGHT_HAND_RULE,
+        /** Write OSM information to the feature properties field. This tries to follow the Overpass turbo format. */
+        WRITE_OSM_INFORMATION,
+        /** Skip empty nodes */
+        SKIP_EMPTY_NODES
+    }
+
     private final DataSet data;
-    private final Projection projection;
+    private static final Projection projection = Projections.getProjectionByCode("EPSG:4326"); // WGS 84
     private static final BooleanProperty SKIP_EMPTY_NODES = new BooleanProperty("geojson.export.skip-empty-nodes", true);
     private static final BooleanProperty UNTAGGED_CLOSED_IS_POLYGON = new BooleanProperty("geojson.export.untagged-closed-is-polygon", false);
     private static final Set<Way> processedMultipolygonWays = new HashSet<>();
+    private EnumSet<Options> options = EnumSet.noneOf(Options.class);
 
     /**
@@ -78 +96 @@
     public GeoJSONWriter(DataSet ds) {
         this.data = ds;
-        this.projection = Projections.getProjectionByCode("EPSG:4326"); // WGS 84
+        if (Boolean.TRUE.equals(SKIP_EMPTY_NODES.get())) {
+            this.options.add(Options.SKIP_EMPTY_NODES);
+        }
+    }
+
+    /**
+     * Set the options for this writer. See {@link Options}.
+     * @param options The options to set.
+     */
+    void setOptions(final Options... options) {
+        this.options.clear();
+        this.options.addAll(Arrays.asList(options));
     }
 
@@ -118 +147 @@
     }
 
+    /**
+     * Convert a primitive to a json object
+     */
     private class GeometryPrimitiveVisitor implements OsmPrimitiveVisitor {
 
@@ -142 +174 @@
                     return;
                 }
-                final JsonArrayBuilder array = getCoorsArray(w.getNodes());
                 boolean writeAsPolygon = w.isClosed() && ((!w.isTagged() && UNTAGGED_CLOSED_IS_POLYGON.get())
                         || ElemStyles.hasAreaElemStyle(w, false));
+                final List<Node> nodes = w.getNodes();
+                if (writeAsPolygon && options.contains(Options.RIGHT_HAND_RULE) && Geometry.isClockwise(nodes)) {
+                    Collections.reverse(nodes);
+                }
+                final JsonArrayBuilder array = getCoorsArray(nodes);
                 if (writeAsPolygon) {
                     geomObj.add("type", "Polygon");
@@ -160 +196 @@
                 return;
             }
-            try {
-                final Pair<List<JoinedPolygon>, List<JoinedPolygon>> mp = MultipolygonBuilder.joinWays(r);
+            if (r.isMultipolygon()) {
+                try {
+                    this.visitMultipolygon(r);
+                    return;
+                } catch (MultipolygonBuilder.JoinedPolygonCreationException ex) {
+                    Logging.warn("GeoJSON: Failed to export multipolygon {0}, falling back to other multi geometry types", r.getUniqueId());
+                    Logging.warn(ex);
+                }
+            }
+            // These are run if (a) r is not a multipolygon or (b) r is not a well-formed multipolygon.
+            if (r.getMemberPrimitives().stream().allMatch(IWay.class::isInstance)) {
+                this.visitMultiLineString(r);
+            } else if (r.getMemberPrimitives().stream().allMatch(INode.class::isInstance)) {
+                this.visitMultiPoints(r);
+            } else {
+                this.visitMultiGeometry(r);
+            }
+        }
+
+        /**
+         * Visit a multi-part geometry.
+         * Note: Does not currently recurse down relations. RFC 7946 indicates that we
+         * should avoid nested geometry collections. This behavior may change any time in the future!
+         * @param r The relation to visit.
+         */
+        private void visitMultiGeometry(final Relation r) {
+            final JsonArrayBuilder jsonArrayBuilder = Json.createArrayBuilder();
+            r.getMemberPrimitives().stream().filter(p -> !(p instanceof Relation))
+                    .map(p -> {
+                        final JsonObjectBuilder tempGeomObj = Json.createObjectBuilder();
+                        p.accept(new GeometryPrimitiveVisitor(tempGeomObj));
+                        return tempGeomObj.build();
+                    }).forEach(jsonArrayBuilder::add);
+            geomObj.add("type", "GeometryCollection");
+            geomObj.add("geometries", jsonArrayBuilder);
+        }
+
+        /**
+         * Visit a relation that only contains points
+         * @param r The relation to visit
+         */
+        private void visitMultiPoints(final Relation r) {
+            final JsonArrayBuilder multiPoint = Json.createArrayBuilder();
+            r.getMembers().stream().map(RelationMember::getMember).filter(Node.class::isInstance).map(Node.class::cast)
+                    .map(Node::getCoor).map(latLon -> getCoorArray(null, latLon))
+                    .forEach(multiPoint::add);
+            geomObj.add("type", "MultiPoint");
+            geomObj.add("coordinates", multiPoint);
+        }
+
+        /**
+         * Visit a relation that is a multi line string
+         * @param r The relation to convert
+         */
+        private void visitMultiLineString(final Relation r) {
+            final JsonArrayBuilder multiLine = Json.createArrayBuilder();
+            r.getMembers().stream().map(RelationMember::getMember).filter(Way.class::isInstance).map(Way.class::cast)
+                    .map(Way::getNodes).map(p -> {
+                JsonArrayBuilder array = getCoorsArray(p);
+                LatLon ll = p.get(0).getCoor();
+                // since first node is not duplicated as last node
+                return ll != null ? array.add(getCoorArray(null, ll)) : array;
+            }).forEach(multiLine::add);
+            geomObj.add("type", "MultiLineString");
+            geomObj.add("coordinates", multiLine);
+            processedMultipolygonWays.addAll(r.getMemberPrimitives(Way.class));
+        }
+
+        /**
+         * Convert a multipolygon to geojson
+         * @param r The relation to convert
+         * @throws MultipolygonBuilder.JoinedPolygonCreationException See {@link MultipolygonBuilder#joinWays(Relation)}.
+         * Note that if the exception is thrown, {@link #geomObj} will not have been modified.
+         */
+        private void visitMultipolygon(final Relation r) throws MultipolygonBuilder.JoinedPolygonCreationException {
+                final Pair<List<MultipolygonBuilder.JoinedPolygon>, List<MultipolygonBuilder.JoinedPolygon>> mp =
+                        MultipolygonBuilder.joinWays(r);
                 final JsonArrayBuilder polygon = Json.createArrayBuilder();
-                Stream.concat(mp.a.stream(), mp.b.stream())
+                // Peek would theoretically be better for these two streams, but SonarLint doesn't like it.
+                // java:S3864: "Stream.peek" should be used with caution
+                final Stream<List<Node>> outer = mp.a.stream().map(MultipolygonBuilder.JoinedPolygon::getNodes).map(nodes -> {
+                    final ArrayList<Node> tempNodes = new ArrayList<>(nodes);
+                    tempNodes.add(tempNodes.get(0));
+                    if (options.contains(Options.RIGHT_HAND_RULE) && Geometry.isClockwise(tempNodes)) {
+                        Collections.reverse(nodes);
+                    }
+                    return nodes;
+                });
+                final Stream<List<Node>> inner = mp.b.stream().map(MultipolygonBuilder.JoinedPolygon::getNodes).map(nodes -> {
+                    final ArrayList<Node> tempNodes = new ArrayList<>(nodes);
+                    tempNodes.add(tempNodes.get(0));
+                    // Note that we are checking !Geometry.isClockwise, which is different from the outer
+                    // ring check.
+                    if (options.contains(Options.RIGHT_HAND_RULE) && !Geometry.isClockwise(tempNodes)) {
+                        Collections.reverse(nodes);
+                    }
+                    return nodes;
+                });
+                Stream.concat(outer, inner)
                         .map(p -> {
-                            JsonArrayBuilder array = getCoorsArray(p.getNodes());
-                            LatLon ll = p.getNodes().get(0).getCoor();
+                            JsonArrayBuilder array = getCoorsArray(p);
+                            LatLon ll = p.get(0).getCoor();
                             // since first node is not duplicated as last node
                             return ll != null ? array.add(getCoorArray(null, ll)) : array;
-                            })
+                        })
                         .forEach(polygon::add);
+                final JsonArrayBuilder multiPolygon = Json.createArrayBuilder().add(polygon);
                 geomObj.add("type", "MultiPolygon");
-                final JsonArrayBuilder multiPolygon = Json.createArrayBuilder().add(polygon);
                 geomObj.add("coordinates", multiPolygon);
                 processedMultipolygonWays.addAll(r.getMemberPrimitives(Way.class));
-            } catch (MultipolygonBuilder.JoinedPolygonCreationException ex) {
-                Logging.warn("GeoJSON: Failed to export multipolygon {0}", r.getUniqueId());
-                Logging.warn(ex);
-            }
         }
 
@@ -205 +332 @@
     protected void appendPrimitive(OsmPrimitive p, JsonArrayBuilder array) {
         if (p.isIncomplete() ||
-            (SKIP_EMPTY_NODES.get() && p instanceof Node && p.getKeys().isEmpty())) {
+            (this.options.contains(Options.SKIP_EMPTY_NODES) && p instanceof Node && p.getKeys().isEmpty())) {
             return;
         }
@@ -211 +338 @@
         // Properties
         final JsonObjectBuilder propObj = Json.createObjectBuilder();
-        for (Entry<String, String> t : p.getKeys().entrySet()) {
-            propObj.add(t.getKey(), convertValueToJson(t.getValue()));
+        for (Map.Entry<String, String> t : p.getKeys().entrySet()) {
+            // If writing OSM information, follow Overpass syntax (escape `@` with another `@`)
+            final String key = options.contains(Options.WRITE_OSM_INFORMATION) && t.getKey().startsWith("@")
+                    ? '@' + t.getKey() : t.getKey();
+            propObj.add(key, convertValueToJson(t.getValue()));
+        }
+        if (options.contains(Options.WRITE_OSM_INFORMATION)) {
+            // Use the same format as Overpass
+            propObj.add("@id", p.getPrimitiveId().getType().getAPIName() + '/' + p.getUniqueId()); // type/id
+            if (!p.isNew()) {
+                propObj.add("@timestamp", Instant.ofEpochSecond(p.getRawTimestamp()).toString());
+                propObj.add("@version", Integer.toString(p.getVersion()));
+                propObj.add("@changeset", Long.toString(p.getChangesetId()));
+            }
+            if (p.getUser() != null) {
+                propObj.add("@user", p.getUser().getName());
+                propObj.add("@uid", p.getUser().getId());
+            }
+            if (options.contains(Options.WRITE_OSM_INFORMATION) && p.getReferrers(true).stream().anyMatch(Relation.class::isInstance)) {
+                final JsonArrayBuilder jsonArrayBuilder = Json.createArrayBuilder();
+                for (Relation relation : Utils.filteredCollection(p.getReferrers(), Relation.class)) {
+                    final JsonObjectBuilder relationObject = Json.createObjectBuilder();
+                    relationObject.add("rel", relation.getId());
+                    Collection<RelationMember> members = relation.getMembersFor(Collections.singleton(p));
+                    // Each role is a separate object in overpass-turbo geojson export. For now, just concat them.
+                    relationObject.add("role",
+                            members.stream().map(RelationMember::getRole).collect(Collectors.joining(";")));
+                    final JsonObjectBuilder relationKeys = Json.createObjectBuilder();
+                    // Uncertain if the @relation reltags need to be @ escaped. I don't think so, as example output
+                    // didn't have any metadata in it.
+                    for (Map.Entry<String, String> tag : relation.getKeys().entrySet()) {
+                        relationKeys.add(tag.getKey(), convertValueToJson(tag.getValue()));
+                    }
+                    relationObject.add("reltags", relationKeys);
+                }
+                propObj.add("@relations", jsonArrayBuilder);
+            }
         }
         final JsonObject prop = propObj.build();