]> git.openstreetmap.org Git - rails.git/blob - app/assets/javascripts/index/query.js
Simplify overpass query building
[rails.git] / app / assets / javascripts / index / query.js
1 OSM.Query = function (map) {
2   const control = $(".control-query"),
3         queryButton = control.find(".control-button"),
4         uninterestingTags = ["source", "source_ref", "source:ref", "history", "attribution", "created_by", "tiger:county", "tiger:tlid", "tiger:upload_uuid", "KSJ2:curve_id", "KSJ2:lat", "KSJ2:lon", "KSJ2:coordinate", "KSJ2:filename", "note:ja"];
5   let marker;
6
7   const featureStyle = {
8     color: "#FF6200",
9     weight: 4,
10     opacity: 1,
11     fillOpacity: 0.5,
12     interactive: false
13   };
14
15   queryButton.on("click", function (e) {
16     e.preventDefault();
17     e.stopPropagation();
18
19     if (control.hasClass("active")) {
20       disableQueryMode();
21     } else if (!queryButton.hasClass("disabled")) {
22       enableQueryMode();
23     }
24   }).on("disabled", function () {
25     if (control.hasClass("active")) {
26       map.off("click", clickHandler);
27       $(map.getContainer()).removeClass("query-active").addClass("query-disabled");
28       $(this).tooltip("show");
29     }
30   }).on("enabled", function () {
31     if (control.hasClass("active")) {
32       map.on("click", clickHandler);
33       $(map.getContainer()).removeClass("query-disabled").addClass("query-active");
34       $(this).tooltip("hide");
35     }
36   });
37
38   function showResultGeometry() {
39     const geometry = $(this).data("geometry");
40     if (geometry) map.addLayer(geometry);
41     $(this).addClass("selected");
42   }
43
44   function hideResultGeometry() {
45     const geometry = $(this).data("geometry");
46     if (geometry) map.removeLayer(geometry);
47     $(this).removeClass("selected");
48   }
49
50   $("#sidebar_content")
51     .on("mouseover", ".query-results a", showResultGeometry)
52     .on("mouseout", ".query-results a", hideResultGeometry);
53
54   function interestingFeature(feature) {
55     if (feature.tags) {
56       for (const key in feature.tags) {
57         if (uninterestingTags.indexOf(key) < 0) {
58           return true;
59         }
60       }
61     }
62
63     return false;
64   }
65
66   function featurePrefix(feature) {
67     const tags = feature.tags;
68     let prefix = "";
69
70     if (tags.boundary === "administrative" && (tags.border_type || tags.admin_level)) {
71       prefix = OSM.i18n.t("geocoder.search_osm_nominatim.border_types." + tags.border_type, {
72         defaultValue: OSM.i18n.t("geocoder.search_osm_nominatim.admin_levels.level" + tags.admin_level, {
73           defaultValue: OSM.i18n.t("geocoder.search_osm_nominatim.prefix.boundary.administrative")
74         })
75       });
76     } else {
77       const prefixes = OSM.i18n.t("geocoder.search_osm_nominatim.prefix");
78
79       for (const key in tags) {
80         const value = tags[key];
81
82         if (prefixes[key]) {
83           if (prefixes[key][value]) {
84             return prefixes[key][value];
85           }
86         }
87       }
88
89       for (const key in tags) {
90         const value = tags[key];
91
92         if (prefixes[key]) {
93           const first = value.slice(0, 1).toUpperCase(),
94                 rest = value.slice(1).replace(/_/g, " ");
95
96           return first + rest;
97         }
98       }
99     }
100
101     if (!prefix) {
102       prefix = OSM.i18n.t("javascripts.query." + feature.type);
103     }
104
105     return prefix;
106   }
107
108   function featureName(feature) {
109     const tags = feature.tags,
110           localeKeys = OSM.preferred_languages.map(locale => `name:${locale}`);
111
112     for (const key of [...localeKeys, "name", "ref", "addr:housename"]) {
113       if (tags[key]) return tags[key];
114     }
115     // TODO: Localize format to country of address
116     if (tags["addr:housenumber"] && tags["addr:street"]) return `${tags["addr:housenumber"]} ${tags["addr:street"]}`;
117
118     return "#" + feature.id;
119   }
120
121   function featureGeometry(feature) {
122     switch (feature.type) {
123       case "node":
124         if (!feature.lat || !feature.lon) return;
125         return L.circleMarker([feature.lat, feature.lon], featureStyle);
126       case "way":
127         if (!feature.geometry?.length) return;
128         return L.polyline(feature.geometry.filter(p => p).map(p => [p.lat, p.lon]), featureStyle);
129       case "relation":
130         if (!feature.members?.length) return;
131         return L.featureGroup(feature.members.map(featureGeometry).filter(g => g));
132     }
133   }
134
135   function runQuery(query, $section, merge, compare) {
136     const $ul = $section.find("ul");
137
138     $ul.empty();
139     $section.show();
140
141     if ($section.data("ajax")) {
142       $section.data("ajax").abort();
143     }
144
145     $section.data("ajax", new AbortController());
146     fetch(OSM.OVERPASS_URL, {
147       method: "POST",
148       body: new URLSearchParams({
149         data: "[timeout:10][out:json];" + query
150       }),
151       credentials: OSM.OVERPASS_CREDENTIALS ? "include" : "same-origin",
152       signal: $section.data("ajax").signal
153     })
154       .then(response => response.json())
155       .then(function (results) {
156         let elements = results.elements;
157
158         $section.find(".loader").hide();
159
160         if (merge) {
161           elements = Object.values(elements.reduce(function (hash, element) {
162             const key = element.type + element.id;
163             if ("geometry" in element) delete element.bounds;
164             hash[key] = { ...hash[key], ...element };
165             return hash;
166           }, {}));
167         }
168
169         if (compare) {
170           elements = elements.sort(compare);
171         }
172
173         for (const element of elements) {
174           if (!interestingFeature(element)) continue;
175
176           const $li = $("<li>")
177             .addClass("list-group-item list-group-item-action")
178             .text(featurePrefix(element) + " ")
179             .appendTo($ul);
180
181           $("<a>")
182             .addClass("stretched-link")
183             .attr("href", "/" + element.type + "/" + element.id)
184             .data("geometry", featureGeometry(element))
185             .text(featureName(element))
186             .appendTo($li);
187         }
188
189         if (results.remark) renderError($ul, results.remark);
190
191         if ($ul.find("li").length === 0) {
192           $("<li>")
193             .addClass("list-group-item")
194             .text(OSM.i18n.t("javascripts.query.nothing_found"))
195             .appendTo($ul);
196         }
197       })
198       .catch(function (error) {
199         if (error.name === "AbortError") return;
200
201         $section.find(".loader").hide();
202
203         renderError($ul, error.message);
204       });
205   }
206
207   function renderError($ul, errorMessage) {
208     $("<li>")
209       .addClass("list-group-item")
210       .text(OSM.i18n.t("javascripts.query.error", { server: OSM.OVERPASS_URL, error: errorMessage }))
211       .appendTo($ul);
212   }
213
214   function featureArea({ bounds }) {
215     const height = bounds.maxlat - bounds.minlat;
216     let width = bounds.maxlon - bounds.minlon;
217
218     if (width < 0) width += 360;
219     return width * height;
220   }
221
222   /*
223    * To find nearby objects we ask overpass for the union of the
224    * following sets:
225    *
226    *   node(around:<radius>,<lat>,<lng>)
227    *   way(around:<radius>,<lat>,<lng>)
228    *   relation(around:<radius>,<lat>,<lng>)
229    *
230    * to find enclosing objects we first find all the enclosing areas:
231    *
232    *   is_in(<lat>,<lng>)->.a
233    *
234    * and then return the union of the following sets:
235    *
236    *   relation(pivot.a)
237    *   way(pivot.a)
238    *
239    * In both cases we then ask to retrieve tags and the geometry
240    * for each object.
241    */
242   function queryOverpass(lat, lng) {
243     const bounds = map.getBounds(),
244           zoom = map.getZoom(),
245           bbox = [bounds.getSouthWest(), bounds.getNorthEast()]
246             .map(c => OSM.cropLocation(c, zoom))
247             .join(),
248           geom = `geom(${bbox})`,
249           radius = 10 * Math.pow(1.5, 19 - zoom),
250           here = `(around:${radius},${lat},${lng})`,
251           enclosed = "(pivot.a);out tags bb",
252           nearby = `(node${here};way${here};);out tags ${geom};relation${here};out ${geom};`,
253           isin = `is_in(${lat},${lng})->.a;way${enclosed};out ids ${geom};relation${enclosed};`;
254
255     $("#sidebar_content .query-intro")
256       .hide();
257
258     if (marker) map.removeLayer(marker);
259     marker = L.circle(L.latLng(lat, lng).wrap(), {
260       radius: radius,
261       className: "query-marker",
262       ...featureStyle
263     }).addTo(map);
264
265     runQuery(nearby, $("#query-nearby"), false);
266     runQuery(isin, $("#query-isin"), true, (feature1, feature2) => featureArea(feature1) - featureArea(feature2));
267   }
268
269   function clickHandler(e) {
270     const [lat, lon] = OSM.cropLocation(e.latlng, map.getZoom());
271
272     OSM.router.route("/query?" + new URLSearchParams({ lat, lon }));
273   }
274
275   function enableQueryMode() {
276     control.addClass("active");
277     map.on("click", clickHandler);
278     $(map.getContainer()).addClass("query-active");
279   }
280
281   function disableQueryMode() {
282     if (marker) map.removeLayer(marker);
283     $(map.getContainer()).removeClass("query-active").removeClass("query-disabled");
284     map.off("click", clickHandler);
285     control.removeClass("active");
286   }
287
288   const page = {};
289
290   page.pushstate = page.popstate = function (path) {
291     OSM.loadSidebarContent(path, function () {
292       page.load(path, true);
293     });
294   };
295
296   page.load = function (path, noCentre) {
297     const params = new URLSearchParams(path.substring(path.indexOf("?"))),
298           latlng = L.latLng(params.get("lat"), params.get("lon"));
299
300     if (!location.hash && !noCentre && !map.getBounds().contains(latlng)) {
301       OSM.router.withoutMoveListener(function () {
302         map.setView(latlng, 15);
303       });
304     }
305
306     queryOverpass(params.get("lat"), params.get("lon"));
307   };
308
309   page.unload = function (sameController) {
310     if (!sameController) {
311       disableQueryMode();
312       $("#sidebar_content .query-results a.selected").each(hideResultGeometry);
313     }
314   };
315
316   return page;
317 };