From 29f51f524dc87cb6d5dd29d948b77a305757ef28 Mon Sep 17 00:00:00 2001
From: Johannes Hoermann <j.hoermann@adito.de>
Date: Mon, 1 Jul 2019 13:48:06 +0200
Subject: [PATCH] Webservice
---
.../AddressValidation_entity.aod | 20 +-
.../children/type_param/valueProcess.js | 3 +-
.../currentvalue_param/valueProcess.js | 2 +-
.../_____LANGUAGE_EXTRA.aod | 3 +
.../_____PREFERENCES_PROJECT.aod | 4 +-
process/DataCaching_lib/process.js | 4 +-
process/WsValidation_lib/process.js | 181 +++++++++++++++---
7 files changed, 167 insertions(+), 50 deletions(-)
diff --git a/entity/AddressValidation_entity/AddressValidation_entity.aod b/entity/AddressValidation_entity/AddressValidation_entity.aod
index 2f0920361f..7544eed7e3 100644
--- a/entity/AddressValidation_entity/AddressValidation_entity.aod
+++ b/entity/AddressValidation_entity/AddressValidation_entity.aod
@@ -115,14 +115,6 @@
<name>STREET</name>
<title>Street</title>
</entityField>
- <entityField>
- <name>FROM_BN</name>
- <title>From buildingnumber</title>
- </entityField>
- <entityField>
- <name>TO_BN</name>
- <title>To buildingnumber</title>
- </entityField>
<entityField>
<name>LON</name>
</entityField>
@@ -132,10 +124,14 @@
<entityField>
<name>CITYEXT</name>
</entityField>
+ <entityField>
+ <name>BUILDINGNO</name>
+ </entityField>
</entityFields>
<recordContainers>
<jDitoRecordContainer>
<name>jdito</name>
+ <jDitoRecordAlias></jDitoRecordAlias>
<isFilterable v="true" />
<isRequireContainerFiltering v="true" />
<contentProcess>%aditoprj%/entity/AddressValidation_entity/recordcontainers/jdito/contentProcess.js</contentProcess>
@@ -171,10 +167,7 @@
<name>STREET.value</name>
</jDitoRecordFieldMapping>
<jDitoRecordFieldMapping>
- <name>FROM_BN.value</name>
- </jDitoRecordFieldMapping>
- <jDitoRecordFieldMapping>
- <name>TO_BN.value</name>
+ <name>BUILDINGNO.value</name>
</jDitoRecordFieldMapping>
<jDitoRecordFieldMapping>
<name>LON.value</name>
@@ -182,9 +175,6 @@
<jDitoRecordFieldMapping>
<name>LAT.value</name>
</jDitoRecordFieldMapping>
- <jDitoRecordFieldMapping>
- <name>VALUE.value</name>
- </jDitoRecordFieldMapping>
</recordFieldMappings>
</jDitoRecordContainer>
</recordContainers>
diff --git a/entity/AddressValidation_entity/entityfields/fulladdressvalidation/children/type_param/valueProcess.js b/entity/AddressValidation_entity/entityfields/fulladdressvalidation/children/type_param/valueProcess.js
index a6cfed5664..daa9b19ded 100644
--- a/entity/AddressValidation_entity/entityfields/fulladdressvalidation/children/type_param/valueProcess.js
+++ b/entity/AddressValidation_entity/entityfields/fulladdressvalidation/children/type_param/valueProcess.js
@@ -1,4 +1,5 @@
import("WsValidation_lib");
import("system.result");
-result.string(WsValidationType.get().TYPE_ADDRESS.key);
\ No newline at end of file
+// result.string(WsValidationType.get().TYPE_ADDRESS.key);
+result.string(WsValidationType.get().TYPE_ADDRESS_NOMINATIM.key);
\ No newline at end of file
diff --git a/entity/Address_entity/entityfields/fulladdressvalidation/children/currentvalue_param/valueProcess.js b/entity/Address_entity/entityfields/fulladdressvalidation/children/currentvalue_param/valueProcess.js
index b51e1bdca2..3312d2f2f0 100644
--- a/entity/Address_entity/entityfields/fulladdressvalidation/children/currentvalue_param/valueProcess.js
+++ b/entity/Address_entity/entityfields/fulladdressvalidation/children/currentvalue_param/valueProcess.js
@@ -1,4 +1,4 @@
import("system.result");
import("system.vars");
- result.string(vars.get("$field.AddressSearch"));
\ No newline at end of file
+result.string(vars.get("$field.AddressSearch"));
\ No newline at end of file
diff --git a/language/_____LANGUAGE_EXTRA/_____LANGUAGE_EXTRA.aod b/language/_____LANGUAGE_EXTRA/_____LANGUAGE_EXTRA.aod
index 3ee7d10b55..c409a2a6cf 100644
--- a/language/_____LANGUAGE_EXTRA/_____LANGUAGE_EXTRA.aod
+++ b/language/_____LANGUAGE_EXTRA/_____LANGUAGE_EXTRA.aod
@@ -4461,6 +4461,9 @@
<entry>
<key>Descriptions</key>
</entry>
+ <entry>
+ <key>User Administration</key>
+ </entry>
</keyValueMap>
<font name="Dialog" style="0" size="11" />
<sqlModels>
diff --git a/preferences/_____PREFERENCES_PROJECT/_____PREFERENCES_PROJECT.aod b/preferences/_____PREFERENCES_PROJECT/_____PREFERENCES_PROJECT.aod
index ee8627ef22..b48b6a4811 100644
--- a/preferences/_____PREFERENCES_PROJECT/_____PREFERENCES_PROJECT.aod
+++ b/preferences/_____PREFERENCES_PROJECT/_____PREFERENCES_PROJECT.aod
@@ -102,11 +102,11 @@
<property>Country</property>
</customStringProperty>
<customBooleanProperty>
- <name>osm.enable</name>
+ <name>nominatim.enable</name>
<property v="true" />
</customBooleanProperty>
<customStringProperty>
- <name>osm.url</name>
+ <name>nominatim.url</name>
<property>https://nominatim.openstreetmap.org/search</property>
</customStringProperty>
</customProperties>
diff --git a/process/DataCaching_lib/process.js b/process/DataCaching_lib/process.js
index 5eee5316c7..03cb0d54a4 100644
--- a/process/DataCaching_lib/process.js
+++ b/process/DataCaching_lib/process.js
@@ -11,7 +11,7 @@ import("system.project");
* @class
*
* @param {String} pIdentifiyingName name to identify the DataCache. This MUST be unique for one data representation (e.g. key-value pair for all Languages with key ISO2-code and value the ISO3-Code). this will affect the storage-name (=name of the global variable on the client for example)
- * @param {bool} [pKeepPerLanguage=false] if true the data is kept per locale (different storing for each requested language), false when not (every language is sharin the same stoarge because only untranslated data is kept)
+ * @param {bool} [pKeepPerLanguage=false] if true the data is kept per locale (different storing for each requested language), false when not (every language is sharing the same stoarge because only untranslated data is kept)
* @param {String} [pLocaleOverride=current language] sometimes a special locale is required, use this parameter to specify it
*
*/
@@ -37,7 +37,7 @@ function CachedData(pIdentifiyingName, pKeepPerLanguage, pLocaleOverride)
* @param {String} [pLocaleOverride=current language] sometimes a special locale is required, use this parameter to specify it
* @param {Function} pDataCallbackFunction function that is called to load the data. this functions gets 2 params: 1. if the data has to be translated 2. the locale to translate
*
- * @return {Object} returns the data you wanted (of the pDataCallbackFunction)
+ * @return {CachedData} returns the data you wanted (of the pDataCallbackFunction)
*
* @static
*/
diff --git a/process/WsValidation_lib/process.js b/process/WsValidation_lib/process.js
index e59e0829e2..e8778ed46b 100644
--- a/process/WsValidation_lib/process.js
+++ b/process/WsValidation_lib/process.js
@@ -5,6 +5,8 @@ import("system.vars");
import("system.neon");
import("system.net");
import("system.util");
+import("system.auth");
+import("DataCaching_lib");
/**
* Class used for the webservice validation types.
@@ -12,18 +14,18 @@ import("system.util");
* Do not create new instances anywhere else than inside of the get-function!
*
* @param {String} pKey the key-name
- * @param {String} pParamName name used by the webservice
* @param {String} pWebserviceName name of the webservice. Used to find the correct webservice configuraation
* @param {Function} pProcessResultCallback function for processing Webservice-result to the return value
* @param {Function} pProcessRequestCallback function for processing Webservice-request
+ * @param {Object} pAdditionalInfo additional Info. Can be an object or something else. (callback specific)
*/
-function WsValidationType(pKey, pParamName, pWebserviceName, pProcessResultCallback, pProcessRequestCallback)
+function WsValidationType(pKey, pWebserviceName, pProcessResultCallback, pProcessRequestCallback, pAdditionalInfo)
{
this.key = pKey;
- this.paramName = pParamName;
this.processResultCallback = pProcessResultCallback;
this.processRequestCallback = pProcessRequestCallback;
this.webserviceName = pWebserviceName;
+ this.additionalInfo = pAdditionalInfo;
}
/**
@@ -37,12 +39,13 @@ WsValidationType.get = function(pKey)
if (!this._cache)
this._cache = {
// Address lookups
- TYPE_ADDRESS: new WsValidationType("TYPE_ADDRESS", "search", "addressValidation", _processAllAddressLookup, _customRequest),
- TYPE_ZIP: new WsValidationType("TYPE_ZIP", "zip", "zipCityValidation", _processAddressLookup, _customRequest),
- TYPE_CITY: new WsValidationType("TYPE_CITY", "city", "zipCityValidation", _processAddressLookup, _customRequest),
+ TYPE_ADDRESS_NOMINATIM: new WsValidationType("TYPE_ADDRESS_NOMINATIM", "nominatim", _processNominatimAddressLookup, _nominatimRequest, "q"),
+ TYPE_ADDRESS: new WsValidationType("TYPE_ADDRESS", "addressValidation", _processAllAddressLookup, _customRequest, "search"),
+ TYPE_ZIP: new WsValidationType("TYPE_ZIP", "zipCityValidation", _processAddressLookup, _customRequest, "zip"),
+ TYPE_CITY: new WsValidationType("TYPE_CITY", "zipCityValidation", _processAddressLookup, _customRequest, "city"),
// Communication validation
- TYPE_PHONE: new WsValidationType("TYPE_PHONE", "Number", "phoneValidation", _processCommunicationValidation, _customRequest)
+ TYPE_PHONE: new WsValidationType("TYPE_PHONE", "phoneValidation", _processCommunicationValidation, _customRequest, "Number")
}
if (pKey)
@@ -61,8 +64,7 @@ WsValidationType.get = function(pKey)
* region,
* state,
* street,
- * from_bn, // building number
- * to_bn, // building number
+ * data.from_bn + (data.to_bn ? " - " + data.to_bn : ""),
* lon,
* lat,
* value // pValue
@@ -71,7 +73,7 @@ WsValidationType.get = function(pKey)
{
var resultAddresses = [];
- // if error, only add the default value else parse the body
+ // if error, return [] else parse the body
if (!WsValidationUtils._isError(pWsResult))
{
resultAddresses = JSON.parse(pWsResult.body);
@@ -94,8 +96,7 @@ WsValidationType.get = function(pKey)
data.region,
data.state,
data.streat,
- data.from_bn,
- data.to_bn,
+ data.from_bn + (data.to_bn ? " - " + data.to_bn : ""),
data.lon,
data.lat,
pValue]
@@ -113,8 +114,7 @@ WsValidationType.get = function(pKey)
* region,
* state,
* street,
- * from_bn, // building number
- * to_bn, // building number
+ * data.from_bn + (data.to_bn ? " - " + data.to_bn : ""),
* lon,
* lat,
* value // (the result. e.g. if pType was ZIP, the value is the found zip)
@@ -123,7 +123,7 @@ WsValidationType.get = function(pKey)
{
var resultAddresses = [];
- // if error, only add the default value else parse the body
+ // if error, return [] else parse the body
if (!WsValidationUtils._isError(pWsResult))
{
resultAddresses = JSON.parse(pWsResult.body);
@@ -144,8 +144,7 @@ WsValidationType.get = function(pKey)
data.region,
data.state,
data.streat,
- data.from_bn,
- data.to_bn,
+ data.from_bn + (data.to_bn ? " - " + data.to_bn : ""),
data.lon,
data.lat,
data[this.paramName]]
@@ -164,17 +163,64 @@ WsValidationType.get = function(pKey)
}
}
+ function _processNominatimAddressLookup(pWsResult, pValue)
+ {
+ var resultAddresses = [];
+
+ if (pWsResult != null)
+ {
+ logging.log(JSON.stringify(pWsResult, null, "\t"))
+ pWsResult.forEach(function(pPlaceData) {
+ if (pPlaceData.address == undefined)
+ pPlaceData.address = {};
+
+ var city = pPlaceData.address.town;
+ if (!city)
+ city = pPlaceData.address.city;
+ if (!city)
+ city = pPlaceData.address.village;
+ if (!city)
+ city = pPlaceData.address.hamlet;
+
+ var cityext = pPlaceData.address.suburb;
+ if (!cityext)
+ cityext = pPlaceData.address.city_district;
+
+ var addrData = [
+ pPlaceData.display_name,
+ pPlaceData.address.postcode,
+ city,
+ cityext,
+ pPlaceData.address.country,
+ pPlaceData.address.district,
+ pPlaceData.address.state_district,
+ pPlaceData.address.state,
+ pPlaceData.address.road,
+ pPlaceData.address.house_number,
+ pPlaceData.lon,
+ pPlaceData.lat
+ ];
+
+ resultAddresses.push([JSON.stringify(addrData.concat([pValue, pPlaceData.place_id]))].concat(addrData));
+ })
+ }
+
+ return resultAddresses;
+ }
+
/**
* request using a custom webservice
*/
- function _customRequest(pValue, pCountry) {
+ function _customRequest(pValue, pCountry)
+ {
if (WsValidationUtils.isWsEnabled(this))
{
var userName = project.getPreferenceValue("custom." + this.webserviceName + ".user");
var pw = project.getPreferenceValue("custom." + this.webserviceName + ".pw");
var url = project.getPreferenceValue("custom." + this.webserviceName + ".url");
var countryParamName = project.getPreferenceValue("custom." + this.webserviceName + ".countryParamName");
-
+ var parameterName = this.additionalInfo;
+
if (!userName || !pw || !url || !countryParamName)
{
throw new Error("if the webservice " + this.key + " is enabled, you have to provide also userName, pw, url and countryParamName")
@@ -190,7 +236,7 @@ WsValidationType.get = function(pKey)
{
parameters[countryParamName] = pCountry;
}
- parameters[this.paramName] = pValue;
+ parameters[parameterName] = pValue;
// call webservice
var ret = JSON.parse(net.callRestWebserviceBasicAuth(url, actionType, parameters, null, null, "text/plain", "text/plain", util.DATA_TEXT, util.DATA_TEXT, userName, pw, true));
@@ -208,6 +254,83 @@ WsValidationType.get = function(pKey)
}
return this.processResultCallback.call(this, null, pValue);
}
+
+ function _nominatimRequest(pValue, pCountry)
+ {
+ if (WsValidationUtils.isWsEnabled(this))
+ {
+ var parameterName = this.additionalInfo;
+ var nominatimCache;
+
+ if (!vars.exists("$context.nominatim"))
+ {
+ nominatimCache = {
+ last: ""
+ }
+ }
+ else
+ {
+ nominatimCache = JSON.parse(vars.getString("$context.nominatim"));
+ }
+
+ if (nominatimCache.last == parameterName + pValue + (pCountry ? pCountry : ""))
+ {
+ return nominatimCache.data;
+ }
+ else
+ {
+ nominatimCache.last = parameterName + pValue + (pCountry ? pCountry : "")
+
+ var url = project.getPreferenceValue("custom." + this.webserviceName + ".url");
+
+
+ if (!url)
+ {
+ throw new Error("if the webservice " + this.key + " is enabled, you have to provide also the url")
+ }
+
+ if (pValue)
+ {
+ var restConf = net.createConfigForRestWebserviceCall()
+ .url(url)
+ .actionType("GET")
+ .dataTypeAccept("application/json")
+ .dataTypeJDitoAccept(util.DATA_TEXT)
+ .dataTypeJDitoSend(util.DATA_TEXT)
+ .addQueryParameter("format", "json")
+ .addQueryParameter("addressdetails", "1");
+
+ // add user input params
+ if (pCountry)
+ {
+ restConf.addQueryParameter("countrycodes", pCountry)
+ }
+
+ restConf.addQueryParameter(parameterName, pValue)
+
+
+ // call webservice
+ var ret = JSON.parse(net.callRestWebservice(restConf, auth.createConfigForNoAuth()));
+
+ // if error, log the error. But also process the result and let the callback generate the correct default value
+ if (ret == null)
+ {
+ logging.log("error")
+ logging.log(translate.withArguments("${WEBSERVICE_ERROR} url:%0 status:%1", [url, (ret.hasHttpSuccessStatusCode ? " StatusCode: " + ret.httpStatusCode : "")]));
+ }
+
+ // different handling of the result per type
+ nominatimCache.data = this.processResultCallback.call(this, ret, pValue);
+ vars.set("$context.nominatim", JSON.stringify(nominatimCache))
+ return nominatimCache.data;
+ }
+ }
+ }
+
+ nominatimCache.data = this.processResultCallback.call(this, null, pValue);
+ vars.set("$context.nominatim", JSON.stringify(nominatimCache))
+ return nominatimCache.data;
+ }
}
/**
@@ -242,7 +365,7 @@ WsValidationUtils.validate = function(pValue, pType, pCountry)
*/
WsValidationUtils.setAddressFields = function(pFieldToSetToValue)
{
- try
+ try
{
var data = JSON.parse(vars.getString("$this.value"));
} catch (exception) {
@@ -251,17 +374,17 @@ WsValidationUtils.setAddressFields = function(pFieldToSetToValue)
return
}
- _setField("$field.ZIP", data.zip);
- _setField("$field.COUNTRY", data.country);
- _setField("$field.CITY", data.city);
- //_setField("$field.DISTRICT", data.district); not needed currently
- _setField("$field.REGION", data.region);
- _setField("$field.STATE", data.state);
- _setField("$field.ADDRESS", data.streat);
+ _setField("$field.ZIP", data[1]);
+ _setField("$field.CITY", data[2]);
+ _setField("$field.COUNTRY", data[4]);
+ //_setField("$field.DISTRICT", data[5]); not needed currently
+ _setField("$field.REGION", data[6]);
+ _setField("$field.STATE", data[7]);
+ _setField("$field.ADDRESS", data[8]);
if (pFieldToSetToValue)
{
- _setField(pFieldToSetToValue, data.value)
+ _setField(pFieldToSetToValue, data[12])
}
function _setField(pField, pValue)
--
GitLab