Index: applications/editors/josm/plugins/SaudiNationalAddress/build.xml
===================================================================
--- applications/editors/josm/plugins/SaudiNationalAddress/build.xml (revision 36293)
+++ applications/editors/josm/plugins/SaudiNationalAddress/build.xml (revision 36294)
@@ -4,5 +4,5 @@
-
+
src
- 10580
+ 19044
Mouath Ibrahim
org.openstreetmap.josm.plugins.saudinationaladdress.SaudiNationalAddressPlugin
Index: applications/editors/josm/plugins/SaudiNationalAddress/src/org/openstreetmap/josm/plugins/saudinationaladdress/SaudiNationalAddressAction.java
===================================================================
--- applications/editors/josm/plugins/SaudiNationalAddress/src/org/openstreetmap/josm/plugins/saudinationaladdress/SaudiNationalAddressAction.java (revision 36293)
+++ applications/editors/josm/plugins/SaudiNationalAddress/src/org/openstreetmap/josm/plugins/saudinationaladdress/SaudiNationalAddressAction.java (revision 36294)
@@ -1,4 +1,9 @@
+// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.plugins.saudinationaladdress;
+import jakarta.json.Json;
+import jakarta.json.JsonArray;
+import jakarta.json.JsonObject;
+import jakarta.json.JsonReader;
import org.openstreetmap.josm.actions.JosmAction;
import org.openstreetmap.josm.command.ChangeCommand;
@@ -6,4 +11,5 @@
import org.openstreetmap.josm.command.SequenceCommand;
import org.openstreetmap.josm.data.UndoRedoHandler;
+import org.openstreetmap.josm.data.coor.ILatLon;
import org.openstreetmap.josm.data.coor.LatLon;
import org.openstreetmap.josm.data.coor.conversion.DecimalDegreesCoordinateFormat;
@@ -17,77 +23,64 @@
import org.openstreetmap.josm.tools.HttpClient;
import org.openstreetmap.josm.tools.ImageProvider;
+import org.openstreetmap.josm.tools.Logging;
import org.openstreetmap.josm.tools.Shortcut;
-import javax.json.Json;
-import javax.json.JsonArray;
-import javax.json.JsonObject;
-import javax.json.JsonReader;
-import javax.swing.*;
import java.awt.event.ActionEvent;
import java.awt.event.KeyEvent;
import java.io.BufferedReader;
import java.io.IOException;
-import java.io.UnsupportedEncodingException;
import java.net.MalformedURLException;
+import java.net.URI;
+import java.net.URISyntaxException;
import java.net.URL;
import java.net.URLEncoder;
+import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
+import static org.openstreetmap.josm.tools.I18n.marktr;
import static org.openstreetmap.josm.tools.I18n.tr;
import static org.openstreetmap.josm.tools.I18n.trn;
+import javax.swing.JOptionPane;
+
/**
- * Created by tom on 02/08/15. (originaly for AustriaAddressHelper plugin)
- * Mouath Ibrahim 05/03/20
+ * Created by tom on 02/08/15. (originally for AustriaAddressHelper plugin)
+ * @author Mouath Ibrahim 05/03/20
*/
public class SaudiNationalAddressAction extends JosmAction {
static final String baseUrl = "https://apina.address.gov.sa/NationalAddress/v3.1/Address/address-geocode";
-
+ private static final String GET_ADDRESS = marktr("Get Address");
+
+ /**
+ * Create a new action for getting Saudi addresses
+ */
public SaudiNationalAddressAction() {
- super(tr("Get Address"), new ImageProvider("icon.png"), tr("Get Address"),
- Shortcut.registerShortcut("Get Address", tr("Get Address"),
+ super(tr(GET_ADDRESS), new ImageProvider("icon.png"), tr(GET_ADDRESS),
+ Shortcut.registerShortcut("Get Address", tr(GET_ADDRESS),
KeyEvent.VK_G, Shortcut.CTRL), true, "getAddress",
true);
}
+ /**
+ * Load an address for an object
+ * @param selectedObject The object to get the address for
+ * @return The address if available, {@code null} otherwise
+ */
public static OsmPrimitive loadAddress(OsmPrimitive selectedObject) {
- final String API_KEY = Config.getPref().get(SaudiNationalAddressPreference.API_KEY);
-
- if (!API_KEY.isEmpty()) {
+ final String apiKey = Config.getPref().get(SaudiNationalAddressPreference.API_KEY);
+
+ if (!apiKey.isEmpty()) {
LatLon center = selectedObject.getBBox().getCenter();
// https://apina.address.gov.sa/NationalAddress/v3.1/Address/address-geocode?lat=25.36919&long=49.55076&language=E&format=json&encode=utf8
- URL url = null;
- try {
- url = new URL(baseUrl
- + "?lat=" + URLEncoder.encode(DecimalDegreesCoordinateFormat.INSTANCE.latToString(center), "UTF-8")
- + "&long=" + URLEncoder.encode(DecimalDegreesCoordinateFormat.INSTANCE.lonToString(center), "UTF-8")
- + "&language=A" // A for Arabic, E for English
- + "&format=json"
- + "&encode=utf8"
- );
- } catch (MalformedURLException | UnsupportedEncodingException e) {
- notification(e.getMessage(), JOptionPane.ERROR_MESSAGE);
- }
-
- JsonObject json = null;
- try (BufferedReader in = HttpClient.create(url)
- .setReasonForRequest("JOSM Plugin Saudi National Address")
- .setHeader("api_key", API_KEY)
- .connect()
- .getContentReader();
- JsonReader reader = Json.createReader(in)) {
- json = reader.readObject();
- } catch (IOException e) {
- notification(e.getMessage(), JOptionPane.ERROR_MESSAGE);
-
- }
-
+ URL url = generateUrl(center);
+
+ JsonObject json = getJson(apiKey, url);
// The api is not consistent in what it returns for error messages, hence this smart AI.
try {
if (json != null) {
if (json.containsKey("statusCode")) {
- if (!(json.getInt("statusCode") == 200)) {
+ if (json.getInt("statusCode") != 200) {
notification(json.getString("message"), JOptionPane.ERROR_MESSAGE); // message: auth, rate limit errors
}
@@ -95,67 +88,108 @@
notification(tr("No address was found for this object."), JOptionPane.WARNING_MESSAGE);
} else {
- final JsonArray addressItems = json.getJsonArray("Addresses");
- final JsonObject firstAddress = addressItems.getJsonObject(0);
-
- String country = "SA";
- // String province = firstAddress.getString("RegionName");
- String district = firstAddress.getString("District");
- String postcode = firstAddress.getString("PostCode") + "-" + firstAddress.getString("AdditionalNumber");
- String city = firstAddress.getString("City");
- String buildingNumber = firstAddress.getString("BuildingNumber");
- String street = firstAddress.getString("Street");
-
- final OsmPrimitive newObject = selectedObject instanceof Node
- ? new Node(((Node) selectedObject))
- : selectedObject instanceof Way
- ? new Way((Way) selectedObject)
- : selectedObject instanceof Relation
- ? new Relation((Relation) selectedObject)
- : null;
-
-
- // seperate arabic and english
- String[] districtArray = district.split(",");
- String[] cityArray = city.split(",");
-
- // newObject.put("addr:country", country); // can be determined from boundary relations
- // newObject.put("addr:province", province); // can be determined from boundary relations
- newObject.put("addr:postcode", postcode);
- newObject.put("addr:city", cityArray[1]);
- newObject.put("addr:city:en", cityArray[0]);
- newObject.put("addr:district", districtArray[1]); // Arabic and common version
- newObject.put("addr:district:en", districtArray[0]);
- newObject.put("addr:housenumber", buildingNumber);
- if (!street.isEmpty()) {
- newObject.put("addr:street", street);
- } // the api is still missing street names in some areas
-
- String msg = tr("Successfully added address to selected object:") + "
"
- + encodeHTML(street) + " "
- + encodeHTML(buildingNumber) + ", "
- + encodeHTML(postcode) + " "
- + encodeHTML(district) + " ("
- + encodeHTML(country) + ")
";
- notification(msg, JOptionPane.INFORMATION_MESSAGE);
-
- return newObject;
+ return createAddress(selectedObject, json);
}
}
} catch (NullPointerException e) {
+ Logging.error(e);
notification(tr("Unknown Error: ") + e.getMessage(), JOptionPane.ERROR_MESSAGE);
}
} else {
notification(tr("Please set your API key in the preference window!"), JOptionPane.ERROR_MESSAGE);
- return null;
}
return null;
}
+ private static URL generateUrl(ILatLon center) {
+ try {
+ return new URI(baseUrl
+ + "?lat=" + URLEncoder.encode(DecimalDegreesCoordinateFormat.INSTANCE.latToString(center), StandardCharsets.UTF_8)
+ + "&long=" + URLEncoder.encode(DecimalDegreesCoordinateFormat.INSTANCE.lonToString(center), StandardCharsets.UTF_8)
+ + "&language=A" // A for Arabic, E for English
+ + "&format=json"
+ + "&encode=utf8"
+ ).toURL();
+ } catch (URISyntaxException | MalformedURLException e) {
+ Logging.trace(e);
+ notification(e.getMessage(), JOptionPane.ERROR_MESSAGE);
+ }
+ return null;
+ }
+
+ private static OsmPrimitive createAddress(OsmPrimitive selectedObject, JsonObject json) {
+ final JsonArray addressItems = json.getJsonArray("Addresses");
+ final JsonObject firstAddress = addressItems.getJsonObject(0);
+
+ String country = "SA";
+ // String province = firstAddress.getString("RegionName");
+ String district = firstAddress.getString("District");
+ String postcode = firstAddress.getString("PostCode") + "-" + firstAddress.getString("AdditionalNumber");
+ String city = firstAddress.getString("City");
+ String buildingNumber = firstAddress.getString("BuildingNumber");
+ String street = firstAddress.getString("Street");
+
+ final OsmPrimitive newObject = createPrimitive(selectedObject);
+
+ // separate arabic and english
+ String[] districtArray = district.split(",");
+ String[] cityArray = city.split(",");
+
+ // newObject.put("addr:country", country); // can be determined from boundary relations
+ // newObject.put("addr:province", province); // can be determined from boundary relations
+ newObject.put("addr:postcode", postcode);
+ newObject.put("addr:city", cityArray[1]);
+ newObject.put("addr:city:en", cityArray[0]);
+ newObject.put("addr:district", districtArray[1]); // Arabic and common version
+ newObject.put("addr:district:en", districtArray[0]);
+ newObject.put("addr:housenumber", buildingNumber);
+ if (!street.isEmpty()) {
+ newObject.put("addr:street", street);
+ } // the api is still missing street names in some areas
+
+ String msg = tr("Successfully added address to selected object:") + "
"
+ + encodeHTML(street) + " "
+ + encodeHTML(buildingNumber) + ", "
+ + encodeHTML(postcode) + " "
+ + encodeHTML(district) + " ("
+ + encodeHTML(country) + ")
";
+ notification(msg, JOptionPane.INFORMATION_MESSAGE);
+
+ return newObject;
+ }
+
+ private static JsonObject getJson(String apiKey, URL url) {
+ try (BufferedReader in = HttpClient.create(url)
+ .setReasonForRequest("JOSM Plugin Saudi National Address")
+ .setHeader("api_key", apiKey)
+ .connect()
+ .getContentReader();
+ JsonReader reader = Json.createReader(in)) {
+ return reader.readObject();
+ } catch (IOException e) {
+ Logging.trace(e);
+ notification(e.getMessage(), JOptionPane.ERROR_MESSAGE);
+ }
+ return null;
+ }
+
+ private static OsmPrimitive createPrimitive(OsmPrimitive selectedObject) {
+ if (selectedObject instanceof Node) {
+ return new Node((Node) selectedObject);
+ }
+ if (selectedObject instanceof Way) {
+ return new Way((Way) selectedObject);
+ }
+ if (selectedObject instanceof Relation) {
+ return new Relation((Relation) selectedObject);
+ }
+ throw new IllegalStateException("Unknown object type: " + selectedObject.getClass().getName());
+ }
+
private static String encodeHTML(String s) {
- StringBuffer out = new StringBuffer();
+ StringBuilder out = new StringBuilder(s.length());
for (int i = 0; i < s.length(); i++) {
char c = s.charAt(i);
if (c > 127 || c == '"' || c == '<' || c == '>') {
- out.append("&#" + (int) c + ";");
+ out.append("&#").append((int) c).append(';');
} else {
out.append(c);