app/assets/javascripts/leaflet.share.js

   1 L.OSM.share = function (options) {
   2   const control = L.OSM.sidebarPane(options, "share", "javascripts.share.title", "javascripts.share.title"),
   3         marker = L.marker([0, 0], { draggable: true }),
   4         locationFilter = new L.LocationFilter({
   5           enableButton: false,
   6           adjustButton: false
   7         });
   8
   9   control.onAddPane = function (map, button, $ui) {
  10     // Link / Embed
  11     $("#content").addClass("overlay-right-sidebar");
  12
  13     const $linkSection = $("<div>")
  14       .attr("class", "share-link p-3 border-bottom border-secondary-subtle")
  15       .appendTo($ui);
  16
  17     $("<h4>")
  18       .text(OSM.i18n.t("javascripts.share.link"))
  19       .appendTo($linkSection);
  20
  21     let $form = $("<form>")
  22       .appendTo($linkSection);
  23
  24     $("<div>")
  25       .attr("class", "form-check mb-3")
  26       .appendTo($form)
  27       .append($("<label>")
  28         .attr("for", "link_marker")
  29         .attr("class", "form-check-label")
  30         .text(OSM.i18n.t("javascripts.share.include_marker")))
  31       .append($("<input>")
  32         .attr("id", "link_marker")
  33         .attr("type", "checkbox")
  34         .attr("class", "form-check-input")
  35         .bind("change", toggleMarker));
  36
  37     $("<div class='btn-group btn-group-sm mb-2'>")
  38       .appendTo($form)
  39       .append($("<a class='btn btn-primary'>")
  40         .addClass("active")
  41         .attr("for", "long_input")
  42         .attr("id", "long_link")
  43         .text(OSM.i18n.t("javascripts.share.long_link")))
  44       .append($("<a class='btn btn-primary'>")
  45         .attr("for", "short_input")
  46         .attr("id", "short_link")
  47         .text(OSM.i18n.t("javascripts.share.short_link")))
  48       .append($("<a class='btn btn-primary'>")
  49         .attr("for", "embed_html")
  50         .attr("id", "embed_link")
  51         .attr("data-bs-title", OSM.i18n.t("javascripts.site.embed_html_disabled"))
  52         .attr("href", "#")
  53         .text(OSM.i18n.t("javascripts.share.embed")))
  54       .on("click", "a", function (e) {
  55         e.preventDefault();
  56         if (!$(this).hasClass("btn-primary")) return;
  57         const id = "#" + $(this).attr("for");
  58         $(this).siblings("a")
  59           .removeClass("active");
  60         $(this).addClass("active");
  61         $linkSection.find(".share-tab")
  62           .hide();
  63         $linkSection.find(".share-tab:has(" + id + ")")
  64           .show()
  65           .find("input, textarea")
  66           .select();
  67       });
  68
  69     $("<div>")
  70       .attr("class", "share-tab")
  71       .appendTo($form)
  72       .append($("<input>")
  73         .attr("id", "long_input")
  74         .attr("type", "text")
  75         .attr("class", "form-control form-control-sm font-monospace")
  76         .attr("readonly", true)
  77         .on("click", select));
  78
  79     $("<div>")
  80       .attr("class", "share-tab")
  81       .hide()
  82       .appendTo($form)
  83       .append($("<input>")
  84         .attr("id", "short_input")
  85         .attr("type", "text")
  86         .attr("class", "form-control form-control-sm font-monospace")
  87         .attr("readonly", true)
  88         .on("click", select));
  89
  90     $("<div>")
  91       .attr("class", "share-tab")
  92       .hide()
  93       .appendTo($form)
  94       .append(
  95         $("<textarea>")
  96           .attr("id", "embed_html")
  97           .attr("class", "form-control form-control-sm font-monospace")
  98           .attr("readonly", true)
  99           .on("click", select))
 100       .append(
 101         $("<p>")
 102           .attr("class", "text-body-secondary")
 103           .text(OSM.i18n.t("javascripts.share.paste_html")));
 104
 105     // Geo URI
 106
 107     const $geoUriSection = $("<div>")
 108       .attr("class", "share-geo-uri p-3 border-bottom border-secondary-subtle")
 109       .appendTo($ui);
 110
 111     $("<h4>")
 112       .text(OSM.i18n.t("javascripts.share.geo_uri"))
 113       .appendTo($geoUriSection);
 114
 115     $("<div>")
 116       .appendTo($geoUriSection)
 117       .append($("<a>")
 118         .attr("id", "geo_uri"));
 119
 120     // Image
 121
 122     const $imageSection = $("<div>")
 123       .attr("class", "share-image p-3")
 124       .appendTo($ui);
 125
 126     $("<h4>")
 127       .text(OSM.i18n.t("javascripts.share.image"))
 128       .appendTo($imageSection);
 129
 130     $("<div>")
 131       .attr("id", "export-warning")
 132       .attr("class", "text-body-secondary")
 133       .text(OSM.i18n.t("javascripts.share.only_layers_exported_as_image"))
 134       .append(
 135         $("<ul>").append(
 136           map.baseLayers
 137             .filter(layer => layer.options.canDownloadImage)
 138             .map(layer => $("<li>").text(layer.options.name))))
 139       .appendTo($imageSection);
 140
 141     $form = $("<form>")
 142       .attr("id", "export-image")
 143       .attr("action", "/export/finish")
 144       .attr("method", "post")
 145       .appendTo($imageSection);
 146
 147     $("<div>")
 148       .appendTo($form)
 149       .attr("class", "row mb-3")
 150       .append($("<label>")
 151         .attr("for", "mapnik_format")
 152         .attr("class", "col-auto col-form-label")
 153         .text(OSM.i18n.t("javascripts.share.format")))
 154       .append($("<div>")
 155         .attr("class", "col-auto")
 156         .append($("<select>")
 157           .attr("name", "mapnik_format")
 158           .attr("id", "mapnik_format")
 159           .attr("class", "form-select w-auto")
 160           .append($("<option>").val("png").text("PNG").prop("selected", true))
 161           .append($("<option>").val("jpeg").text("JPEG"))
 162           .append($("<option>").val("webp").text("WEBP"))
 163           .append($("<option>").val("svg").text("SVG"))
 164           .append($("<option>").val("pdf").text("PDF"))));
 165
 166     $("<div>")
 167       .appendTo($form)
 168       .attr("class", "row mb-3")
 169       .attr("id", "mapnik_scale_row")
 170       .append($("<label>")
 171         .attr("for", "mapnik_scale")
 172         .attr("class", "col-auto col-form-label")
 173         .text(OSM.i18n.t("javascripts.share.scale")))
 174       .append($("<div>")
 175         .attr("class", "col-auto")
 176         .append($("<div>")
 177           .attr("class", "input-group flex-nowrap")
 178           .append($("<span>")
 179             .attr("class", "input-group-text")
 180             .text("1 : "))
 181           .append($("<input>")
 182             .attr("name", "mapnik_scale")
 183             .attr("id", "mapnik_scale")
 184             .attr("type", "text")
 185             .attr("class", "form-control")
 186             .on("change", update))));
 187
 188     $("<div>")
 189       .attr("class", "row mb-3")
 190       .appendTo($form)
 191       .append($("<div>")
 192         .attr("class", "col-auto")
 193         .append($("<div>")
 194           .attr("class", "form-check")
 195           .append($("<label>")
 196             .attr("for", "image_filter")
 197             .attr("class", "form-check-label")
 198             .text(OSM.i18n.t("javascripts.share.custom_dimensions")))
 199           .append($("<input>")
 200             .attr("id", "image_filter")
 201             .attr("type", "checkbox")
 202             .attr("class", "form-check-input")
 203             .bind("change", toggleFilter))));
 204
 205     const mapnikNames = ["minlon", "minlat", "maxlon", "maxlat", "lat", "lon"];
 206
 207     for (const name of mapnikNames) {
 208       $("<input>")
 209         .attr("id", "mapnik_" + name)
 210         .attr("name", name)
 211         .attr("type", "hidden")
 212         .appendTo($form);
 213     }
 214
 215     const hiddenExportDefaults = {
 216       format: "mapnik",
 217       zoom: map.getZoom(),
 218       width: 0,
 219       height: 0
 220     };
 221
 222     for (const name in hiddenExportDefaults) {
 223       $("<input>")
 224         .attr("id", "map_" + name)
 225         .attr("name", name)
 226         .attr("value", hiddenExportDefaults[name])
 227         .attr("type", "hidden")
 228         .appendTo($form);
 229     }
 230
 231     const csrfAttrs = { type: "hidden" };
 232     [[csrfAttrs.name, csrfAttrs.value]] = Object.entries(OSM.csrf);
 233
 234     $("<input>")
 235       .attr(csrfAttrs)
 236       .appendTo($form);
 237
 238     const args = {
 239       layer: "<span id=\"mapnik_image_layer\"></span>",
 240       width: "<span id=\"mapnik_image_width\"></span>",
 241       height: "<span id=\"mapnik_image_height\"></span>"
 242     };
 243
 244     $("<p>")
 245       .attr("class", "text-body-secondary")
 246       .html(OSM.i18n.t("javascripts.share.image_dimensions", args))
 247       .appendTo($form);
 248
 249     $("<input>")
 250       .attr("type", "submit")
 251       .attr("class", "btn btn-primary")
 252       .attr("value", OSM.i18n.t("javascripts.share.download"))
 253       .appendTo($form);
 254
 255     locationFilter
 256       .on("change", update)
 257       .addTo(map);
 258
 259     marker.on("dragend", movedMarker);
 260     map.on("move", movedMap);
 261     map.on("moveend baselayerchange overlayadd overlayremove", update);
 262
 263     $ui
 264       .on("show", shown)
 265       .on("hide", hidden);
 266
 267     function shown() {
 268       $("#mapnik_scale").val(getScale());
 269       update();
 270     }
 271
 272     function hidden() {
 273       map.removeLayer(marker);
 274       map.options.scrollWheelZoom = map.options.doubleClickZoom = true;
 275       locationFilter.disable();
 276       update();
 277     }
 278
 279     function toggleMarker() {
 280       if ($(this).is(":checked")) {
 281         marker.setLatLng(map.getCenter());
 282         map.addLayer(marker);
 283         map.options.scrollWheelZoom = map.options.doubleClickZoom = "center";
 284       } else {
 285         map.removeLayer(marker);
 286         map.options.scrollWheelZoom = map.options.doubleClickZoom = true;
 287       }
 288       update();
 289     }
 290
 291     function toggleFilter() {
 292       if ($(this).is(":checked")) {
 293         locationFilter.setBounds(map.getBounds().pad(-0.2));
 294         locationFilter.enable();
 295       } else {
 296         locationFilter.disable();
 297       }
 298       update();
 299     }
 300
 301     function movedMap() {
 302       marker.setLatLng(map.getCenter());
 303       update();
 304     }
 305
 306     function movedMarker() {
 307       if (map.hasLayer(marker)) {
 308         map.off("move", movedMap);
 309         map.on("moveend", updateOnce);
 310         map.panTo(marker.getLatLng());
 311       }
 312     }
 313
 314     function updateOnce() {
 315       map.off("moveend", updateOnce);
 316       map.on("move", movedMap);
 317       update();
 318     }
 319
 320     function escapeHTML(string) {
 321       const htmlEscapes = {
 322         "&": "&amp;",
 323         "<": "&lt;",
 324         ">": "&gt;",
 325         "\"": "&quot;",
 326         "'": "&#x27;"
 327       };
 328       return string === null ? "" : String(string).replace(/[&<>"']/g, function (match) {
 329         return htmlEscapes[match];
 330       });
 331     }
 332
 333     function update() {
 334       const layer = map.getMapBaseLayer();
 335       const canEmbed = Boolean(layer && layer.options.canEmbed);
 336       let bounds = map.getBounds();
 337
 338       $("#link_marker")
 339         .prop("checked", map.hasLayer(marker));
 340
 341       $("#image_filter")
 342         .prop("checked", locationFilter.isEnabled());
 343
 344       // Link / Embed
 345
 346       $("#short_input").val(map.getShortUrl(marker));
 347       $("#long_input").val(map.getUrl(marker));
 348       $("#short_link").attr("href", map.getShortUrl(marker));
 349       $("#long_link").attr("href", map.getUrl(marker));
 350
 351       const params = new URLSearchParams({
 352         bbox: bounds.toBBoxString(),
 353         layer: map.getMapBaseLayerId()
 354       });
 355
 356       if (map.hasLayer(marker)) {
 357         const latLng = marker.getLatLng().wrap();
 358         params.set("marker", latLng.lat + "," + latLng.lng);
 359       }
 360
 361       $("#embed_link")
 362         .toggleClass("btn-primary", canEmbed)
 363         .toggleClass("btn-secondary", !canEmbed)
 364         .tooltip(canEmbed ? "disable" : "enable");
 365       if (!canEmbed && $("#embed_link").hasClass("active")) {
 366         $("#long_link").click();
 367       }
 368
 369       $("#embed_html").val(
 370         "<iframe width=\"425\" height=\"350\" src=\"" +
 371           escapeHTML(OSM.SERVER_PROTOCOL + "://" + OSM.SERVER_URL + "/export/embed.html?" + params) +
 372           "\" style=\"border: 1px solid black\"></iframe><br/>" +
 373           "<small><a href=\"" + escapeHTML(map.getUrl(marker)) + "\">" +
 374           escapeHTML(OSM.i18n.t("javascripts.share.view_larger_map")) + "</a></small>");
 375
 376       // Geo URI
 377
 378       $("#geo_uri")
 379         .attr("href", map.getGeoUri(marker))
 380         .html(map.getGeoUri(marker));
 381
 382       // Image
 383
 384       if (locationFilter.isEnabled()) {
 385         bounds = locationFilter.getBounds();
 386       }
 387
 388       let scale = $("#mapnik_scale").val();
 389       const size = L.bounds(L.CRS.EPSG3857.project(bounds.getSouthWest()),
 390                             L.CRS.EPSG3857.project(bounds.getNorthEast())).getSize(),
 391             maxScale = Math.floor(Math.sqrt(size.x * size.y / 0.3136));
 392
 393       $("#mapnik_minlon").val(bounds.getWest());
 394       $("#mapnik_minlat").val(bounds.getSouth());
 395       $("#mapnik_maxlon").val(bounds.getEast());
 396       $("#mapnik_maxlat").val(bounds.getNorth());
 397
 398       if (scale < maxScale) {
 399         scale = roundScale(maxScale);
 400         $("#mapnik_scale").val(scale);
 401       }
 402
 403       const mapWidth = Math.round(size.x / scale / 0.00028);
 404       const mapHeight = Math.round(size.y / scale / 0.00028);
 405       $("#mapnik_image_width").text(mapWidth);
 406       $("#mapnik_image_height").text(mapHeight);
 407
 408       const canDownloadImage = Boolean(layer && layer.options.canDownloadImage);
 409
 410       $("#mapnik_image_layer").text(canDownloadImage ? layer.options.name : "");
 411       $("#map_format").val(canDownloadImage ? layer.options.layerId : "");
 412
 413       $("#map_zoom").val(map.getZoom());
 414       $("#mapnik_lon").val(map.getCenter().lng);
 415       $("#mapnik_lat").val(map.getCenter().lat);
 416       $("#map_width").val(mapWidth);
 417       $("#map_height").val(mapHeight);
 418
 419       $("#export-image").toggle(canDownloadImage);
 420       $("#export-warning").toggle(!canDownloadImage);
 421       $("#mapnik_scale_row").toggle(canDownloadImage && layer.options.layerId === "mapnik");
 422     }
 423
 424     function select() {
 425       $(this).select();
 426     }
 427
 428     function getScale() {
 429       const bounds = map.getBounds(),
 430             centerLat = bounds.getCenter().lat,
 431             halfWorldMeters = 6378137 * Math.PI * Math.cos(centerLat * Math.PI / 180),
 432             meters = halfWorldMeters * (bounds.getEast() - bounds.getWest()) / 180,
 433             pixelsPerMeter = map.getSize().x / meters,
 434             metersPerPixel = 1 / (92 * 39.3701);
 435       return Math.round(1 / (pixelsPerMeter * metersPerPixel));
 436     }
 437
 438     function roundScale(scale) {
 439       const precision = 5 * Math.pow(10, Math.floor(Math.LOG10E * Math.log(scale)) - 2);
 440       return precision * Math.ceil(scale / precision);
 441     }
 442   };
 443
 444   return control;
 445 };