SORMAS-Foundation#2087 update geocoding to work with any custom external service

Author: lgal

SERVER_CUSTOMIZATION.md

@@ -31,6 +31,9 @@ The following properties are currently configurable:
 * **Rscript executable** *(rscript.executable)*: The location of the Rscript executable. If you've installed Rscript on your server and specify the path here (the default should work for Linux systems as long as you've used the default install path), network diagrams for transmission chains will be shown in the web app.
 * **Symptom journal interface**: Properties used to connect to an external symptom journal service. *interface.symptomjournal.url* is the URL to the website that SORMAS should connect to; *interface.symptomjournal.authurl* is the URL used to authenticate SORMAS at the external service; *interface.symptomjournal.clientid* and *interface.symptomjournal.secret* are the credentials used for the authentication process.
 * **Custom branding**: Properties used to apply a custom branding to SORMAS that overrides its name and default logo. Using these properties also alters the sidebar and adds another customizable area to it. If you want to use this feature, set *custombranding* to true. *custombranding.name* is the name that you want to use, *custombranding.logo.path* is the path to the logo that should be used.
+* **Geocoding** Properties used to integrate an external geocoding service for obtaining the geo coordinates of addresses.
+*geocodingServiceUrlTemplate* is the url for searching for address details, *${street}*, *${houseNumber}*, *${postalCode}*, and *${city}* placeholders will be replaced with the actual address fields when searching;
+*geocodingLongitudeJsonPath* and *geocodingLatitudeJsonPath* are used to obtain the longitude and latitude of the address in the result of the geocoding service request
 
 ## Importing Infrastructure Data
 When you start a SORMAS server for the first time, some default infrastructure data is generated to ensure that the server is usable and the default users can be created. It is recommended (and, unless you're working on a demo server, necessary) to archive this default data and import the official infrastructure data of the country or part of the country that you intend to use SORMAS in instead.

sormas-api/src/main/java/de/symeda/sormas/api/ConfigFacade.java

@@ -90,7 +90,11 @@ public interface ConfigFacade {
 
 	int getMapZoom();
 
-	String getGeocodingOsgtsEndpoint();
+	String getGeocodingServiceUrlTemplate();
+
+	String getGeocodingLongitudeJsonPath();
+
+	String getGeocodingLatitudeJsonPath();
 
 	SymptomJournalConfig getSymptomJournalConfig();
 

sormas-backend/pom.xml

@@ -166,6 +166,13 @@
 			<artifactId>microprofile-config-api</artifactId>
 		</dependency>
 
+		<!-- JsonPath -->
+		<dependency>
+			<groupId>com.jayway.jsonpath</groupId>
+			<artifactId>json-path</artifactId>
+			<version>2.4.0</version>
+		</dependency>
+
 	</dependencies>
 
 	<build>

sormas-backend/src/main/java/de/symeda/sormas/backend/common/ConfigFacadeEjb.java

@@ -105,7 +105,9 @@ public class ConfigFacadeEjb implements ConfigFacade {
 	public static final String DAYS_AFTER_CASE_GETS_ARCHIVED = "daysAfterCaseGetsArchived";
 	private static final String DAYS_AFTER_EVENT_GETS_ARCHIVED = "daysAfterEventGetsArchived";
 
-	private static final String GEOCODING_OSGTS_ENDPOINT = "geocodingOsgtsEndpoint";
+	private static final String GEOCODING_SERVICE_URL_TEMPLATE = "geocodingServiceUrlTemplate";
+	private static final String GEOCODING_LONGITUDE_JSON_PATH = "geocodingLongitudeJsonPath";
+	private static final String GEOCODING_LATITUDE_JSON_PATH = "geocodingLatitudeJsonPath";
 
 	private static final String SORMAS2SORMAS_FILES_PATH = "sormas2sormas.path";
 	private static final String SORMAS2SORMAS_SERVER_ACCESS_DATA_FILE_NAME = "sormas2sormas.serverAccessDataFileName";
@@ -362,8 +364,18 @@ public int getDaysAfterEventGetsArchived() {
 	}
 
 	@Override
-	public String getGeocodingOsgtsEndpoint() {
-		return getProperty(GEOCODING_OSGTS_ENDPOINT, null);
+	public String getGeocodingServiceUrlTemplate() {
+		return getProperty(GEOCODING_SERVICE_URL_TEMPLATE, null);
+	}
+
+	@Override
+	public String getGeocodingLongitudeJsonPath() {
+		return getProperty(GEOCODING_LONGITUDE_JSON_PATH, null);
+	}
+
+	@Override
+	public String getGeocodingLatitudeJsonPath() {
+		return getProperty(GEOCODING_LATITUDE_JSON_PATH, null);
 	}
 
 	@Override

sormas-backend/src/main/java/de/symeda/sormas/backend/geocoding/GeocodingFacadeEjb.java

@@ -17,11 +17,6 @@
  *******************************************************************************/
 package de.symeda.sormas.backend.geocoding;
 
-import java.util.Arrays;
-import java.util.regex.Pattern;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
-
 import javax.ejb.EJB;
 import javax.ejb.Stateless;
 
@@ -33,36 +28,6 @@
 @Stateless(name = "GeocodingFacade")
 public class GeocodingFacadeEjb implements GeocodingFacade {
 
-	/**
-	 * @see https://www.bkg.bund.de/SharedDocs/Produktinformationen/BKG/DE/P-Download/Doku-Geokodierungsdienst.pdf?__blob=publicationFile&v=3
-	 *      4.3.1.10 Sonderzeichen
-	 */
-	//@formatter:off
-	private static final Pattern TO_BE_ESCAPED = Pattern
-		.compile(
-			Stream
-				.of(
-			"&&",
-			"||",
-			"+",
-			"-",
-			"!",
-			"(",
-			")",
-			"{",
-			"}",
-			"[",
-			"]",
-			"^",
-			"\"",
-			"~",
-			"*",
-			"?",
-			":")
-	.map(Pattern::quote)
-	.collect(Collectors.joining("|")));
-	//@formatter:on
-
 	@EJB
 	private GeocodingService geocodingService;
 
@@ -74,49 +39,10 @@ public boolean isEnabled() {
 	@Override
 	public GeoLatLon getLatLon(String street, String houseNumber, String postalCode, String city) {
 
-		if (StringUtils.isBlank(street)) {
-			return null;
+		if (StringUtils.isNotBlank(street) && (StringUtils.isNotBlank(city) || StringUtils.isNotBlank(postalCode))) {
+			return geocodingService.getLatLon(new LocationQuery(houseNumber, street, postalCode, city));
 		}
 
-		String textValue = join(", ", join(" ", street, houseNumber.replaceAll("\\s", " ")), join(" ", postalCode, city));
-
-		String query = textValue;
-//		Stream.of(
-//			property("text", textValue),
-//			property("ort", city),
-//			property("plz", postalCode),
-//			property("strasse", address)
-//		)
-//		.filter(Objects::nonNull)
-//		.collect(Collectors.joining(" AND "));
-
-		if (StringUtils.isBlank(query)) {
-			return null;
-		}
-
-		return geocodingService.getLatLon(query);
-	}
-
-	private String join(String delimiter, String... values) {
-
-		String result = Arrays.stream(values).filter(StringUtils::isNotBlank).collect(Collectors.joining(delimiter));
-		if (StringUtils.isBlank(result)) {
-			return null;
-		} else {
-			return result;
-		}
-	}
-
-	private static String property(String key, String value) {
-
-		if (StringUtils.isBlank(value)) {
-			return "";
-		}
-
-		return key + ":\"" + escape(value.trim()) + "\" ";
-	}
-
-	static String escape(String raw) {
-		return TO_BE_ESCAPED.matcher(raw.replace("\\", "\\\\")).replaceAll("\\\\$0");
+		return null;
 	}
 }