new web API to change the graph permanently e.g. via GeoJSON and pre-request blocking areas, graphhopper#789

Author: boldtrn

.gitignore

@@ -41,4 +41,5 @@ local.properties
 .DS_Store
 /core/nbproject/
 /reader-overlay-data/nbproject/
-!malta-latest.osm.pbf 
+!malta-latest.osm.pbf
+/reader-json/nbproject/

config-example.properties

@@ -57,6 +57,8 @@ prepare.min_one_way_network_size=200
 # the given distance in meter. Default is set to 1000km.
 routing.non_ch.max_waypoint_distance = 1000000
 
+# You can permanently block certain areas from routing
+# e.g. you can block certain areas with block_area=lat1,lon1,lat2,lon2
 
 ##### Web #####
 

core/src/main/java/com/graphhopper/GHRequest.java

@@ -100,7 +100,7 @@ public GHRequest(GHPoint startPlace, GHPoint endPlace) {
     /**
      * Set routing request
      * <p>
-     *  @param points          List of stopover points in order: start, 1st stop, 2nd stop, ..., end
+     * @param points          List of stopover points in order: start, 1st stop, 2nd stop, ..., end
      * @param favoredHeadings List of favored headings for starting (start point) and arrival (via
      *                        and end points) Headings are north based azimuth (clockwise) in (0, 360) or NaN for equal
      */
@@ -236,19 +236,6 @@ public GHRequest setVehicle(String vehicle) {
         return this;
     }
 
-    @Override
-    public String toString() {
-        String res = "";
-        for (GHPoint point : points) {
-            if (res.isEmpty()) {
-                res = point.toString();
-            } else {
-                res += "; " + point.toString();
-            }
-        }
-        return res + "(" + algo + ")";
-    }
-
     public HintsMap getHints() {
         return hints;
     }
@@ -262,11 +249,20 @@ public List<String> getPointHints() {
         return pointHints;
     }
 
-    public String getPointHint(int index) {
-        return pointHints.get(index);
+    public boolean hasPointHints() {
+        return pointHints.size() == points.size();
     }
 
-    public boolean hasPointHints(){
-        return pointHints.size() == points.size();
+    @Override
+    public String toString() {
+        String res = "";
+        for (GHPoint point : points) {
+            if (res.isEmpty()) {
+                res = point.toString();
+            } else {
+                res += "; " + point.toString();
+            }
+        }
+        return res + "(" + algo + ")";
     }
 }

core/src/main/java/com/graphhopper/GraphHopper.java

@@ -17,12 +17,15 @@
  */
 package com.graphhopper;
 
+import com.graphhopper.json.geo.JsonFeature;
 import com.graphhopper.reader.DataReader;
 import com.graphhopper.reader.dem.BridgeElevationInterpolator;
 import com.graphhopper.reader.dem.CGIARProvider;
 import com.graphhopper.reader.dem.ElevationProvider;
 import com.graphhopper.reader.dem.SRTMProvider;
 import com.graphhopper.reader.dem.TunnelElevationInterpolator;
+import com.graphhopper.storage.change.ChangeGraphHelper;
+import com.graphhopper.storage.change.ChangeGraphResponse;
 import com.graphhopper.routing.*;
 import com.graphhopper.routing.ch.CHAlgoFactoryDecorator;
 import com.graphhopper.routing.ch.PrepareContractionHierarchies;
@@ -54,6 +57,10 @@
 
 import static com.graphhopper.util.Parameters.Algorithms.*;
 
+import java.util.concurrent.locks.Lock;
+import java.util.concurrent.locks.ReadWriteLock;
+import java.util.concurrent.locks.ReentrantReadWriteLock;
+
 /**
  * Easy to use access point to configure import and (offline) routing.
  *
@@ -87,6 +94,7 @@ public class GraphHopper implements GraphHopperAPI {
     private boolean simplifyResponse = true;
     private TraversalMode traversalMode = TraversalMode.NODE_BASED;
     private int maxVisitedNodes = Integer.MAX_VALUE;
+    private String blockedRectangularAreas = "";
 
     private int nonChMaxWaypointDistance = Integer.MAX_VALUE;
     // for index
@@ -103,6 +111,7 @@ public class GraphHopper implements GraphHopperAPI {
     private boolean calcPoints = true;
     private ElevationProvider eleProvider = ElevationProvider.NOOP;
     private FlagEncoderFactory flagEncoderFactory = FlagEncoderFactory.DEFAULT;
+    private final ReadWriteLock readWriteLock = new ReentrantReadWriteLock();
 
     public GraphHopper() {
         chFactoryDecorator.setEnabled(true);
@@ -642,6 +651,7 @@ public GraphHopper init(CmdArgs args) {
         maxVisitedNodes = args.getInt(Routing.INIT_MAX_VISITED_NODES, Integer.MAX_VALUE);
         maxRoundTripRetries = args.getInt(RoundTrip.INIT_MAX_RETRIES, maxRoundTripRetries);
         nonChMaxWaypointDistance = args.getInt(Parameters.NON_CH.MAX_NON_CH_POINT_DISTANCE, Integer.MAX_VALUE);
+        blockedRectangularAreas = args.get(Routing.BLOCK_AREA, "");
 
         return this;
     }
@@ -672,7 +682,7 @@ public GraphHopper importOrLoad() {
      */
     private GraphHopper process(String graphHopperLocation) {
         setGraphHopperLocation(graphHopperLocation);
-        Lock lock = null;
+        GHLock lock = null;
         try {
             if (ghStorage.getDirectory().getDefaultType().isStoring()) {
                 lockFactory.setLockDir(new File(graphHopperLocation));
@@ -788,7 +798,7 @@ public boolean load(String graphHopperFolder) {
         if (!new File(graphHopperFolder).exists())
             return false;
 
-        Lock lock = null;
+        GHLock lock = null;
         try {
             // create locks only if writes are allowed, if they are not allowed a lock cannot be created 
             // (e.g. on a read only filesystem locks would fail)
@@ -836,7 +846,7 @@ private void initCHAlgoFactoryDecorator() {
         if (!chFactoryDecorator.hasWeightings())
             for (FlagEncoder encoder : encodingManager.fetchEdgeEncoders()) {
                 for (String chWeightingStr : chFactoryDecorator.getWeightingsAsStrings()) {
-                    Weighting weighting = createWeighting(new HintsMap(chWeightingStr), encoder);
+                    Weighting weighting = createWeighting(new HintsMap(chWeightingStr), encoder, null);
                     chFactoryDecorator.addWeighting(weighting);
                 }
             }
@@ -911,15 +921,30 @@ private boolean isPrepared() {
      * @param hintsMap all parameters influencing the weighting. E.g. parameters coming via
      *                 GHRequest.getHints or directly via "&api.xy=" from the URL of the web UI
      * @param encoder  the required vehicle
+     * @param graph    The Graph enables the Weighting for NodeAccess and more
      * @return the weighting to be used for route calculation
      * @see HintsMap
      */
-    public Weighting createWeighting(HintsMap hintsMap, FlagEncoder encoder) {
+    public Weighting createWeighting(HintsMap hintsMap, FlagEncoder encoder, Graph graph) {
         String weighting = hintsMap.getWeighting().toLowerCase();
 
         if (encoder.supports(GenericWeighting.class)) {
             DataFlagEncoder dataEncoder = (DataFlagEncoder) encoder;
-            return new GenericWeighting(dataEncoder, dataEncoder.readStringMap(hintsMap));
+            ConfigMap cMap = dataEncoder.readStringMap(hintsMap);
+
+            // add default blocked rectangular areas from config properties
+            if (!this.blockedRectangularAreas.isEmpty()) {
+                String val = this.blockedRectangularAreas;
+                String blockedAreasFromRequest = hintsMap.get(Parameters.Routing.BLOCK_AREA, "");
+                if (!blockedAreasFromRequest.isEmpty())
+                    val += ";" + blockedAreasFromRequest;
+                hintsMap.put(Parameters.Routing.BLOCK_AREA, val);
+            }
+
+            cMap = new GraphEdgeIdFinder(graph, locationIndex).parseStringHints(cMap, hintsMap, new DefaultEdgeFilter(encoder));
+            GenericWeighting genericWeighting = new GenericWeighting(dataEncoder, cMap);
+            genericWeighting.setGraph(graph);
+            return genericWeighting;
         } else if ("shortest".equalsIgnoreCase(weighting)) {
             return new ShortestWeighting(encoder);
         } else if ("fastest".equalsIgnoreCase(weighting) || weighting.isEmpty()) {
@@ -969,6 +994,8 @@ public List<Path> calcPaths(GHRequest request, GHResponse ghRsp) {
             request.setVehicle(vehicle);
         }
 
+        Lock readLock = readWriteLock.readLock();
+        readLock.lock();
         try {
             if (!encodingManager.supports(vehicle))
                 throw new IllegalArgumentException("Vehicle " + vehicle + " unsupported. "
@@ -1010,7 +1037,7 @@ else if (ALT_ROUTE.equalsIgnoreCase(algoStr))
 
                 RoutingAlgorithmFactory tmpAlgoFactory = getAlgorithmFactory(hints);
                 Weighting weighting = null;
-                Graph routingGraph = ghStorage;
+                QueryGraph queryGraph;
 
                 boolean forceFlexibleMode = hints.getBool(CH.DISABLE, false);
                 if (!chFactoryDecorator.isDisablingAllowed() && forceFlexibleMode)
@@ -1025,20 +1052,20 @@ else if (!(tmpAlgoFactory instanceof PrepareContractionHierarchies))
 
                     tMode = getCHFactoryDecorator().getNodeBase();
                     weighting = ((PrepareContractionHierarchies) tmpAlgoFactory).getWeighting();
-                    routingGraph = ghStorage.getGraph(CHGraph.class, weighting);
-
+                    queryGraph = new QueryGraph(ghStorage.getGraph(CHGraph.class, weighting));
+                    queryGraph.lookup(qResults);
                 } else {
                     checkNonChMaxWaypointDistance(points);
-                    weighting = createWeighting(hints, encoder);
+                    queryGraph = new QueryGraph(ghStorage);
+                    queryGraph.lookup(qResults);
+                    weighting = createWeighting(hints, encoder, queryGraph);
                     ghRsp.addDebugInfo("tmode:" + tMode.toString());
                 }
 
                 int maxVisitedNodesForRequest = hints.getInt(Routing.MAX_VISITED_NODES, maxVisitedNodes);
                 if (maxVisitedNodesForRequest > maxVisitedNodes)
                     throw new IllegalArgumentException("The max_visited_nodes parameter has to be below or equal to:" + maxVisitedNodes);
 
-                QueryGraph queryGraph = new QueryGraph(routingGraph);
-                queryGraph.lookup(qResults);
                 weighting = createTurnWeighting(queryGraph, weighting, tMode);
 
                 AlgorithmOptions algoOpts = AlgorithmOptions.start().
@@ -1068,6 +1095,29 @@ else if (!(tmpAlgoFactory instanceof PrepareContractionHierarchies))
         } catch (IllegalArgumentException ex) {
             ghRsp.addError(ex);
             return Collections.emptyList();
+        } finally {
+            readLock.unlock();
+        }
+    }
+
+    /**
+     * This method applies the changes to the graph specified as feature collection. It does so by locking the routing
+     * to avoid concurrent changes which could result in incorrect routing (like when done while a Dijkstra search) or
+     * also while just reading one edge row (inconsistent edge properties).
+     */
+    public ChangeGraphResponse changeGraph(Collection<JsonFeature> collection) {
+        // TODO allow calling this method if called before CH preparation
+        if (getCHFactoryDecorator().isEnabled())
+            throw new IllegalArgumentException("To use the changeGraph API you need to turn off CH");
+
+        Lock writeLock = readWriteLock.writeLock();
+        writeLock.lock();
+        try {
+            ChangeGraphHelper overlay = new ChangeGraphHelper(ghStorage, locationIndex);
+            long updateCount = overlay.applyChanges(encodingManager, collection);
+            return new ChangeGraphResponse(updateCount);
+        } finally {
+            writeLock.unlock();
         }
     }
 

core/src/main/java/com/graphhopper/coll/GHBitSetImpl.java

@@ -24,6 +24,7 @@
  */
 public class GHBitSetImpl extends BitSet implements GHBitSet {
     public GHBitSetImpl() {
+        super();
     }
 
     public GHBitSetImpl(int nbits) {

reader-overlay-data/src/main/java/com/graphhopper/json/GHson.java renamed to core/src/main/java/com/graphhopper/json/GHJson.java

@@ -25,7 +25,7 @@
  *
  * @author Peter Karich
  */
-public interface GHson {
+public interface GHJson {
     /**
      * This method reads JSON data from the provided source and creates an instance of the provided
      * class.

reader-overlay-data/src/main/java/com/graphhopper/json/geo/Geometry.java renamed to core/src/main/java/com/graphhopper/json/geo/Geometry.java

@@ -21,6 +21,8 @@
 import com.graphhopper.util.shapes.GHPoint;
 
 /**
+ * This interface is used to define an area or location being used to block or change areas in the graph.
+ *
  * @author Peter Karich
  */
 public interface Geometry {

reader-overlay-data/src/main/java/com/graphhopper/json/geo/JsonFeature.java renamed to core/src/main/java/com/graphhopper/json/geo/JsonFeature.java

@@ -22,14 +22,24 @@
 import java.util.Map;
 
 /**
+ * This class defines a properties where a geometry is associated. Typically read from GeoJSON but also from in-memory is possible.
+ *
  * @author Peter Karich
  */
 public class JsonFeature {
-    String id;
-    String type;
-    BBox bbox;
-    Geometry geometry;
-    Map<String, Object> properties;
+    final String id;
+    final String type;
+    final BBox bbox;
+    final Geometry geometry;
+    final Map<String, Object> properties;
+
+    public JsonFeature(String id, String type, BBox bbox, Geometry geometry, Map<String, Object> properties) {
+        this.id = id;
+        this.type = type;
+        this.bbox = bbox;
+        this.geometry = geometry;
+        this.properties = properties;
+    }
 
     public String getId() {
         return id;

reader-overlay-data/src/main/java/com/graphhopper/json/geo/JsonFeatureCollection.java renamed to core/src/main/java/com/graphhopper/json/geo/JsonFeatureCollection.java

@@ -28,6 +28,7 @@
 import com.graphhopper.util.DistancePlaneProjection;
 import com.graphhopper.util.EdgeExplorer;
 import com.graphhopper.util.EdgeIterator;
+import com.graphhopper.util.Helper;
 import com.graphhopper.util.Parameters;
 
 import java.util.PriorityQueue;
@@ -54,7 +55,7 @@ public AStar(Graph graph, Weighting weighting, TraversalMode tMode) {
         int size = Math.min(Math.max(200, graph.getNodes() / 10), 2000);
         initCollections(size);
         BeelineWeightApproximator defaultApprox = new BeelineWeightApproximator(nodeAccess, weighting);
-        defaultApprox.setDistanceCalc(new DistancePlaneProjection());
+        defaultApprox.setDistanceCalc(Helper.DIST_PLANE);
         setApproximation(defaultApprox);
     }
 

reader-overlay-data/src/main/java/com/graphhopper/json/geo/LineString.java renamed to core/src/main/java/com/graphhopper/json/geo/LineString.java

@@ -73,7 +73,7 @@ public AStarBidirection(Graph graph, Weighting weighting, TraversalMode tMode) {
         int size = Math.min(Math.max(200, graph.getNodes() / 10), 150_000);
         initCollections(size);
         BeelineWeightApproximator defaultApprox = new BeelineWeightApproximator(nodeAccess, weighting);
-        defaultApprox.setDistanceCalc(new DistancePlaneProjection());
+        defaultApprox.setDistanceCalc(Helper.DIST_PLANE);
         setApproximation(defaultApprox);
     }
 

reader-overlay-data/src/main/java/com/graphhopper/json/geo/Point.java renamed to core/src/main/java/com/graphhopper/json/geo/Point.java

@@ -22,6 +22,7 @@
 import com.graphhopper.routing.util.HintsMap;
 import com.graphhopper.routing.util.TraversalMode;
 import com.graphhopper.routing.weighting.AbstractWeighting;
+import com.graphhopper.routing.weighting.GenericWeighting;
 import com.graphhopper.routing.weighting.Weighting;
 import com.graphhopper.storage.*;
 import com.graphhopper.util.CmdArgs;
@@ -322,6 +323,9 @@ public void createPreparations(GraphHopperStorage ghStorage, TraversalMode trave
         traversalMode = getNodeBase();
 
         for (Weighting weighting : getWeightings()) {
+            if(weighting instanceof GenericWeighting){
+                ((GenericWeighting) weighting).setGraph(ghStorage);
+            }
             PrepareContractionHierarchies tmpPrepareCH = new PrepareContractionHierarchies(
                     new GHDirectory("", DAType.RAM_INT), ghStorage, ghStorage.getGraph(CHGraph.class, weighting),
                     weighting, traversalMode);

core/src/main/java/com/graphhopper/routing/AStar.java

@@ -64,12 +64,12 @@ public List<QueryResult> lookup(List<GHPoint> points, FlagEncoder encoder) {
         for (int placeIndex = 0; placeIndex < points.size(); placeIndex++) {
             GHPoint point = points.get(placeIndex);
             QueryResult res;
-            if(ghRequest.hasPointHints()){
-                res = locationIndex.findClosest(point.lat, point.lon, new NameSimilarityEdgeFilter(edgeFilter, ghRequest.getPointHint(placeIndex)));
-                if(!res.isValid()){
+            if (ghRequest.hasPointHints()) {
+                res = locationIndex.findClosest(point.lat, point.lon, new NameSimilarityEdgeFilter(edgeFilter, ghRequest.getPointHints().get(placeIndex)));
+                if (!res.isValid()) {
                     res = locationIndex.findClosest(point.lat, point.lon, edgeFilter);
                 }
-            }else{
+            } else {
                 res = locationIndex.findClosest(point.lat, point.lon, edgeFilter);
             }
             if (!res.isValid())