]> git.openstreetmap.org Git - rails.git/blob - app/assets/javascripts/leaflet.map.js
Map display: handle deleted elements
[rails.git] / app / assets / javascripts / leaflet.map.js
1 //= require download_util
2 L.extend(L.LatLngBounds.prototype, {
3   getSize: function () {
4     return (this._northEast.lat - this._southWest.lat) *
5            (this._northEast.lng - this._southWest.lng);
6   }
7 });
8
9 L.OSM.Map = L.Map.extend({
10   initialize: function (id, options) {
11     L.Map.prototype.initialize.call(this, id, options);
12
13     this.baseLayers = OSM.LAYER_DEFINITIONS.map((
14       { credit, nameId, leafletOsmId, leafletOsmDarkId, ...layerOptions }
15     ) => {
16       if (credit) layerOptions.attribution = makeAttribution(credit);
17       if (nameId) layerOptions.name = OSM.i18n.t(`javascripts.map.base.${nameId}`);
18       const layerConstructor =
19         (OSM.isDarkMap() && L.OSM[leafletOsmDarkId]) ||
20         L.OSM[leafletOsmId] ||
21         L.OSM.TileLayer;
22
23       const layer = new layerConstructor(layerOptions);
24       layer.on("add", () => {
25         this.fire("baselayerchange", { layer: layer });
26       });
27       return layer;
28     });
29
30     this.noteLayer = new L.FeatureGroup();
31     this.noteLayer.options = { code: "N" };
32
33     this.dataLayer = new L.OSM.DataLayer(null);
34     this.dataLayer.options.code = "D";
35
36     this.gpsLayer = new L.OSM.GPS({
37       pane: "overlayPane",
38       code: "G"
39     });
40     this.gpsLayer.on("add", () => {
41       this.fire("overlayadd", { layer: this.gpsLayer });
42     }).on("remove", () => {
43       this.fire("overlayremove", { layer: this.gpsLayer });
44     });
45
46     this.on("baselayerchange", function (event) {
47       if (this.baseLayers.indexOf(event.layer) >= 0) {
48         this.setMaxZoom(event.layer.options.maxZoom);
49       }
50     });
51
52     function makeAttribution(credit) {
53       let attribution = "";
54
55       attribution += OSM.i18n.t("javascripts.map.copyright_text", {
56         copyright_link: $("<a>", {
57           href: "/copyright",
58           text: OSM.i18n.t("javascripts.map.openstreetmap_contributors")
59         }).prop("outerHTML")
60       });
61
62       attribution += credit.donate ? " &hearts; " : ". ";
63       attribution += makeCredit(credit);
64       attribution += ". ";
65
66       attribution += $("<a>", {
67         href: "https://wiki.osmfoundation.org/wiki/Terms_of_Use",
68         text: OSM.i18n.t("javascripts.map.website_and_api_terms")
69       }).prop("outerHTML");
70
71       return attribution;
72     }
73
74     function makeCredit(credit) {
75       const children = {};
76       for (const childId in credit.children) {
77         children[childId] = makeCredit(credit.children[childId]);
78       }
79       const text = OSM.i18n.t(`javascripts.map.${credit.id}`, children);
80       if (credit.href) {
81         const link = $("<a>", {
82           href: credit.href,
83           text: text
84         });
85         if (credit.donate) {
86           link.addClass("donate-attr");
87         } else {
88           link.attr("target", "_blank");
89         }
90         return link.prop("outerHTML");
91       }
92       return text;
93     }
94   },
95
96   updateLayers: function (layerParam) {
97     const oldBaseLayer = this.getMapBaseLayer();
98     let newBaseLayer;
99
100     for (const layer of this.baseLayers) {
101       if (!newBaseLayer || layerParam.includes(layer.options.code)) {
102         newBaseLayer = layer;
103       }
104     }
105
106     if (newBaseLayer !== oldBaseLayer) {
107       if (oldBaseLayer) this.removeLayer(oldBaseLayer);
108       if (newBaseLayer) this.addLayer(newBaseLayer);
109     }
110   },
111
112   getLayersCode: function () {
113     let layerConfig = "";
114     this.eachLayer(function (layer) {
115       if (layer.options && layer.options.code) {
116         layerConfig += layer.options.code;
117       }
118     });
119     return layerConfig;
120   },
121
122   getMapBaseLayerId: function () {
123     const layer = this.getMapBaseLayer();
124     if (layer) return layer.options.layerId;
125   },
126
127   getMapBaseLayer: function () {
128     for (const layer of this.baseLayers) {
129       if (this.hasLayer(layer)) return layer;
130     }
131   },
132
133   getUrl: function (marker) {
134     const params = {};
135
136     if (marker && this.hasLayer(marker)) {
137       [params.mlat, params.mlon] = OSM.cropLocation(marker.getLatLng(), this.getZoom());
138     }
139
140     let url = location.protocol + "//" + OSM.SERVER_URL + "/";
141     const query = new URLSearchParams(params),
142           hash = OSM.formatHash(this);
143
144     if (query) url += "?" + query;
145     if (hash) url += hash;
146
147     return url;
148   },
149
150   getShortUrl: function (marker) {
151     const zoom = this.getZoom(),
152           latLng = marker && this.hasLayer(marker) ? marker.getLatLng().wrap() : this.getCenter().wrap(),
153           char_array = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_~",
154           x = Math.round((latLng.lng + 180.0) * ((1 << 30) / 90.0)),
155           y = Math.round((latLng.lat + 90.0) * ((1 << 30) / 45.0)),
156           // JavaScript only has to keep 32 bits of bitwise operators, so this has to be
157           // done in two parts. each of the parts c1/c2 has 30 bits of the total in it
158           // and drops the last 4 bits of the full 64 bit Morton code.
159           c1 = interlace(x >>> 17, y >>> 17),
160           c2 = interlace((x >>> 2) & 0x7fff, (y >>> 2) & 0x7fff);
161     let str = location.protocol + "//" + location.hostname.replace(/^www\.openstreetmap\.org/i, "osm.org") + "/go/";
162
163     for (let i = 0; i < Math.ceil((zoom + 8) / 3.0) && i < 5; ++i) {
164       const digit = (c1 >> (24 - (6 * i))) & 0x3f;
165       str += char_array.charAt(digit);
166     }
167     for (let i = 5; i < Math.ceil((zoom + 8) / 3.0); ++i) {
168       const digit = (c2 >> (24 - (6 * (i - 5)))) & 0x3f;
169       str += char_array.charAt(digit);
170     }
171     for (let i = 0; i < ((zoom + 8) % 3); ++i) str += "-";
172
173     // Called to interlace the bits in x and y, making a Morton code.
174     function interlace(x, y) {
175       let interlaced_x = x,
176           interlaced_y = y;
177       interlaced_x = (interlaced_x | (interlaced_x << 8)) & 0x00ff00ff;
178       interlaced_x = (interlaced_x | (interlaced_x << 4)) & 0x0f0f0f0f;
179       interlaced_x = (interlaced_x | (interlaced_x << 2)) & 0x33333333;
180       interlaced_x = (interlaced_x | (interlaced_x << 1)) & 0x55555555;
181       interlaced_y = (interlaced_y | (interlaced_y << 8)) & 0x00ff00ff;
182       interlaced_y = (interlaced_y | (interlaced_y << 4)) & 0x0f0f0f0f;
183       interlaced_y = (interlaced_y | (interlaced_y << 2)) & 0x33333333;
184       interlaced_y = (interlaced_y | (interlaced_y << 1)) & 0x55555555;
185       return (interlaced_x << 1) | interlaced_y;
186     }
187
188     const params = new URLSearchParams();
189     const layers = this.getLayersCode().replace("M", "");
190
191     if (layers) {
192       params.set("layers", layers);
193     }
194
195     if (marker && this.hasLayer(marker)) {
196       params.set("m", "");
197     }
198
199     if (this._object) {
200       params.set(this._object.type, this._object.id);
201     }
202
203     const query = params.toString();
204     if (query) {
205       str += "?" + query;
206     }
207
208     return str;
209   },
210
211   getGeoUri: function (marker) {
212     let latLng = this.getCenter();
213     const zoom = this.getZoom();
214
215     if (marker && this.hasLayer(marker)) {
216       latLng = marker.getLatLng();
217     }
218
219     return `geo:${OSM.cropLocation(latLng, zoom).join(",")}?z=${zoom}`;
220   },
221
222   addObject: function (object, callback) {
223     class ElementGoneError extends Error {
224       constructor(message = "Element is gone") {
225         super(message);
226         this.name = "ElementGoneError";
227       }
228     }
229
230     const objectStyle = {
231       color: "#FF6200",
232       weight: 4,
233       opacity: 1,
234       fillOpacity: 0.5
235     };
236
237     const changesetStyle = {
238       weight: 4,
239       color: "#FF9500",
240       opacity: 1,
241       fillOpacity: 0,
242       interactive: false
243     };
244
245     const haloStyle = {
246       weight: 2.5,
247       radius: 20,
248       fillOpacity: 0.5,
249       color: "#FF6200"
250     };
251
252     this.removeObject();
253
254     if (object.type === "note" || object.type === "changeset") {
255       this._objectLoader = { abort: () => {} };
256
257       this._object = object;
258       this._objectLayer = L.featureGroup().addTo(this);
259
260       if (object.type === "note") {
261         L.circleMarker(object.latLng, haloStyle).addTo(this._objectLayer);
262
263         if (object.icon) {
264           L.marker(object.latLng, {
265             icon: object.icon,
266             opacity: 1,
267             interactive: true
268           }).addTo(this._objectLayer);
269         }
270       } else if (object.type === "changeset") {
271         if (object.bbox) {
272           L.rectangle([
273             [object.bbox.minlat, object.bbox.minlon],
274             [object.bbox.maxlat, object.bbox.maxlon]
275           ], changesetStyle).addTo(this._objectLayer);
276         }
277       }
278
279       if (callback) callback(this._objectLayer.getBounds());
280       this.fire("overlayadd", { layer: this._objectLayer });
281     } else { // element handled by L.OSM.DataLayer
282       const map = this;
283       this._objectLoader = new AbortController();
284       fetch(OSM.apiUrl(object), {
285         headers: { accept: "application/json" },
286         signal: this._objectLoader.signal
287       })
288         .then(async response => {
289           if (response.ok) {
290             return response.json();
291           }
292
293           if (response.status === 410) {
294             throw new ElementGoneError();
295           }
296
297           const status = response.statusText || response.status;
298           if (response.status !== 400 && response.status !== 509) {
299             throw new Error(status);
300           }
301
302           const text = await response.text();
303           throw new Error(text || status);
304         })
305         .then(function (data) {
306           const visible_data = {
307             ...data,
308             elements: data.elements?.filter(el => el.visible !== false) ?? []
309           };
310
311           map._object = object;
312
313           map._objectLayer = new L.OSM.DataLayer(null, {
314             styles: {
315               node: objectStyle,
316               way: objectStyle,
317               area: objectStyle,
318               changeset: changesetStyle
319             }
320           });
321
322           map._objectLayer.interestingNode = function (node, wayNodes, relationNodes) {
323             return object.type === "node" ||
324                    (object.type === "relation" && Boolean(relationNodes[node.id]));
325           };
326
327           map._objectLayer.addData(visible_data);
328           map._objectLayer.addTo(map);
329
330           if (callback) callback(map._objectLayer.getBounds());
331           map.fire("overlayadd", { layer: map._objectLayer });
332           $("#browse_status").empty();
333         })
334         .catch(function (error) {
335           if (error.name === "AbortError") return;
336           if (error instanceof ElementGoneError) {
337             $("#browse_status").empty();
338             return;
339           }
340           OSM.displayLoadError(error?.message, () => {
341             $("#browse_status").empty();
342           });
343         });
344     }
345   },
346
347   removeObject: function () {
348     this._object = null;
349     if (this._objectLoader) this._objectLoader.abort();
350     if (this._objectLayer) this.removeLayer(this._objectLayer);
351     this.fire("overlayremove", { layer: this._objectLayer });
352   },
353
354   getState: function () {
355     return {
356       center: this.getCenter().wrap(),
357       zoom: this.getZoom(),
358       layers: this.getLayersCode()
359     };
360   },
361
362   setState: function (state, options) {
363     if (state.center) this.setView(state.center, state.zoom, options);
364     if (state.layers) this.updateLayers(state.layers);
365   },
366
367   setSidebarOverlaid: function (overlaid) {
368     const mediumDeviceWidth = window.getComputedStyle(document.documentElement).getPropertyValue("--bs-breakpoint-md");
369     const isMediumDevice = window.matchMedia(`(max-width: ${mediumDeviceWidth})`).matches;
370     const sidebarWidth = $("#sidebar").width();
371     const sidebarHeight = $("#sidebar").height();
372     if (overlaid && !$("#content").hasClass("overlay-sidebar")) {
373       $("#content").addClass("overlay-sidebar");
374       this.invalidateSize({ pan: false });
375       if (isMediumDevice) {
376         this.panBy([0, -sidebarHeight], { animate: false });
377       } else if ($("html").attr("dir") !== "rtl") {
378         this.panBy([-sidebarWidth, 0], { animate: false });
379       }
380     } else if (!overlaid && $("#content").hasClass("overlay-sidebar")) {
381       if (isMediumDevice) {
382         this.panBy([0, $("#map").height() / 2], { animate: false });
383       } else if ($("html").attr("dir") !== "rtl") {
384         this.panBy([sidebarWidth, 0], { animate: false });
385       }
386       $("#content").removeClass("overlay-sidebar");
387       this.invalidateSize({ pan: false });
388     }
389     return this;
390   }
391 });
392
393 OSM.isDarkMap = function () {
394   const mapTheme = $("body").attr("data-map-theme");
395   if (mapTheme) return mapTheme === "dark";
396   const siteTheme = $("html").attr("data-bs-theme");
397   if (siteTheme) return siteTheme === "dark";
398   return window.matchMedia("(prefers-color-scheme: dark)").matches;
399 };
400
401 OSM.getMarker = function ({ icon = "dot", color = "var(--marker-red)", ...options }) {
402   const html = `<svg viewBox="0 0 25 40" class="pe-none" overflow="visible"><use href="#pin-shadow" /><use href="#pin-${icon}" color="${color}" class="pe-auto" /></svg>`;
403   return L.divIcon({
404     ...options,
405     html,
406     iconSize: [25, 40],
407     iconAnchor: [12.5, 40],
408     popupAnchor: [1, -34]
409   });
410 };
411
412 OSM.noteMarkers = {
413   "closed": OSM.getMarker({ icon: "tick", color: "var(--marker-green)" }),
414   "new": OSM.getMarker({ icon: "plus", color: "var(--marker-blue)" }),
415   "open": OSM.getMarker({ icon: "cross", color: "var(--marker-red)" })
416 };