Merge pull request #5347 from jinzo/photon-geocoder

Photon Geocoder

4 files changed, 100 insertions, 31 deletions

diff --git a/src/main/java/org/traccar/MainModule.java b/src/main/java/org/traccar/MainModule.java
index 66238ab44..806e6da18 100644
--- a/src/main/java/org/traccar/MainModule.java
+++ b/src/main/java/org/traccar/MainModule.java
@@ -68,6 +68,7 @@ import org.traccar.geocoder.OpenCageGeocoder;
 import org.traccar.geocoder.PositionStackGeocoder;
 import org.traccar.geocoder.PlusCodesGeocoder;
 import org.traccar.geocoder.TomTomGeocoder;
+import org.traccar.geocoder.GeocodeJsonGeocoder;
 import org.traccar.geolocation.GeolocationProvider;
 import org.traccar.geolocation.GoogleGeolocationProvider;
 import org.traccar.geolocation.OpenCellIdGeolocationProvider;
@@ -261,6 +262,9 @@ public class MainModule extends AbstractModule {
                 case "geoapify":
                     geocoder = new GeoapifyGeocoder(client, key, language, cacheSize, addressFormat);
                     break;
+                case "geocodejson":
+                    geocoder = new GeocodeJsonGeocoder(client, url, key, language, cacheSize, addressFormat);
+                    break;
                 default:
                     geocoder = new GoogleGeocoder(client, key, language, cacheSize, addressFormat);
                     break;
diff --git a/src/main/java/org/traccar/geocoder/BanGeocoder.java b/src/main/java/org/traccar/geocoder/BanGeocoder.java
index e2ff72311..128ef4b84 100644
--- a/src/main/java/org/traccar/geocoder/BanGeocoder.java
+++ b/src/main/java/org/traccar/geocoder/BanGeocoder.java
@@ -20,45 +20,22 @@ package org.traccar.geocoder;
  * API documentation: https://adresse.data.gouv.fr/api
  */
 
-import jakarta.json.JsonArray;
 import jakarta.json.JsonObject;
 import jakarta.ws.rs.client.Client;
 
-public class BanGeocoder extends JsonGeocoder {
+public class BanGeocoder extends GeocodeJsonGeocoder {
 
     public BanGeocoder(Client client, int cacheSize, AddressFormat addressFormat) {
-        super(client, "https://api-adresse.data.gouv.fr/reverse/?lat=%f&lon=%f", cacheSize, addressFormat);
+        super(client, "https://api-adresse.data.gouv.fr/reverse/", null, null, cacheSize, addressFormat);
     }
 
     @Override
     public Address parseAddress(JsonObject json) {
-        JsonArray result = json.getJsonArray("features");
+        Address geodecoded = super.parseAddress(json);
+        if (geodecoded != null) {
+            geodecoded.setCountry("FR");
 
-        if (result != null && !result.isEmpty()) {
-            JsonObject location = result.getJsonObject(0).getJsonObject("properties");
-            Address address = new Address();
-
-            address.setCountry("FR");
-            if (location.containsKey("postcode")) {
-                address.setPostcode(location.getString("postcode"));
-            }
-            if (location.containsKey("context")) {
-                address.setDistrict(location.getString("context"));
-            }
-            if (location.containsKey("name")) {
-                address.setStreet(location.getString("name"));
-            }
-            if (location.containsKey("city")) {
-                address.setSettlement(location.getString("city"));
-            }
-            if (location.containsKey("housenumber")) {
-                address.setHouse(location.getString("housenumber"));
-            }
-            if (location.containsKey("label")) {
-                address.setFormattedAddress(location.getString("label"));
-            }
-
-            return address;
+            return geodecoded;
         }
 
         return null;
diff --git a/src/main/java/org/traccar/geocoder/GeocodeJsonGeocoder.java b/src/main/java/org/traccar/geocoder/GeocodeJsonGeocoder.java
new file mode 100644
index 000000000..da4688423
--- /dev/null
+++ b/src/main/java/org/traccar/geocoder/GeocodeJsonGeocoder.java
@@ -0,0 +1,81 @@
+/*
+ * Copyright 2014 - 2024 Anton Tananaev (anton@traccar.org)
+ * Copyright 2024 - 2024 Matjaž Črnko (m.crnko@txt.i)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.traccar.geocoder;
+
+import jakarta.json.JsonArray;
+import jakarta.json.JsonObject;
+import jakarta.ws.rs.client.Client;
+
+public class GeocodeJsonGeocoder extends JsonGeocoder {
+
+    private static String formatUrl(String url, String key, String language) {
+        if (url == null) {
+            url = "https://photon.komoot.io/reverse";
+        }
+        url += "?lat=%f&lon=%f";
+        if (key != null) {
+            url += "&key=" + key;
+        }
+        if (language != null) {
+            url += "&lang=" + language;
+        }
+        return url;
+    }
+
+    public GeocodeJsonGeocoder(
+            Client client, String url, String key, String language, int cacheSize, AddressFormat addressFormat) {
+        super(client, formatUrl(url, key, language), cacheSize, addressFormat);
+    }
+
+    @Override
+    public Address parseAddress(JsonObject json) {
+        JsonArray features = json.getJsonArray("features");
+        if (!features.isEmpty()) {
+            Address address = new Address();
+            JsonObject properties = features.getJsonObject(0).getJsonObject("properties");
+
+            if (properties.containsKey("label")) {
+                address.setFormattedAddress(properties.getString("label"));
+            }
+            if (properties.containsKey("housenumber")) {
+                address.setHouse(properties.getString("housenumber"));
+            }
+            if (properties.containsKey("street")) {
+                address.setStreet(properties.getString("street"));
+            }
+            if (properties.containsKey("city")) {
+                address.setSettlement(properties.getString("city"));
+            }
+            if (properties.containsKey("district")) {
+                address.setDistrict(properties.getString("district"));
+            }
+            if (properties.containsKey("state")) {
+                address.setState(properties.getString("state"));
+            }
+            if (properties.containsKey("countrycode")) {
+                address.setCountry(properties.getString("countrycode").toUpperCase());
+            }
+            if (properties.containsKey("postcode")) {
+                address.setPostcode(properties.getString("postcode"));
+            }
+
+            return address;
+        }
+        return null;
+    }
+
+}
diff --git a/src/test/java/org/traccar/geocoder/GeocoderTest.java b/src/test/java/org/traccar/geocoder/GeocoderTest.java
index ef2dd062d..3e65d20c7 100644
--- a/src/test/java/org/traccar/geocoder/GeocoderTest.java
+++ b/src/test/java/org/traccar/geocoder/GeocoderTest.java
@@ -69,9 +69,9 @@ public class GeocoderTest {
     @Disabled
     @Test
     public void testBan() {
-        Geocoder geocoder = new BanGeocoder(client, 0, new AddressFormat("%f [%d], %c"));
+        Geocoder geocoder = new BanGeocoder(client, 0, new AddressFormat());
         String address = geocoder.getAddress(48.8575, 2.2944, null);
-        assertEquals("8 Avenue Gustave Eiffel 75007 Paris [75, Paris, Île-de-France], FR", address);
+        assertEquals("8 Avenue Gustave Eiffel, Paris, FR", address);
     }
 
     @Disabled
@@ -122,4 +122,11 @@ public class GeocoderTest {
         assertEquals("114 East 13th Street, New York, New York, US", address);
     }
 
+    @Disabled
+    @Test
+    public void testGeocodeJSON() {
+        Geocoder geocoder = new GeocodeJsonGeocoder(client, null, null, null, 0, new AddressFormat());
+        String address = geocoder.getAddress(40.7337807, -73.9974401, null);
+        assertEquals("35 West 9th Street, New York, New York, US", address);
+    }
 }