Collect map layer credits into a data structure

[rails.git] / app / assets / javascripts / leaflet.map.js

diff --git a/app/assets/javascripts/leaflet.map.js b/app/assets/javascripts/leaflet.map.js
index 75396fd73013fefd67d63f634d7aad34ae8c9b9b..fe4b139d14f41e9ff017ee83f10a0395bb6b1274 100644 (file)
--- a/app/assets/javascripts/leaflet.map.js
+++ b/app/assets/javascripts/leaflet.map.js
@@ -15,25 +15,69 @@ L.OSM.Map = L.Map.extend({
   initialize: function (id, options) {
     L.Map.prototype.initialize.call(this, id, options);
 
   initialize: function (id, options) {
     L.Map.prototype.initialize.call(this, id, options);
 

-    var copyright = I18n.t("javascripts.map.copyright", { copyright_url: "/copyright" });
-    var donate = I18n.t("javascripts.map.donate_link_text", { donate_url: "https://donate.openstreetmap.org" });
-    var terms = I18n.t("javascripts.map.terms", { terms_url: "https://wiki.osmfoundation.org/wiki/Terms_of_Use" });
-    var cyclosm = I18n.t("javascripts.map.cyclosm", { cyclosm_url: "https://www.cyclosm.org", osmfrance_url: "https://openstreetmap.fr/" });
-    var thunderforest = I18n.t("javascripts.map.thunderforest", { thunderforest_url: "https://www.thunderforest.com/" });
-    var memomaps = I18n.t("javascripts.map.opnvkarte", { memomaps_url: "https://memomaps.de/" });
-    var hotosm = I18n.t("javascripts.map.hotosm", { hotosm_url: "https://www.hotosm.org/", osmfrance_url: "https://openstreetmap.fr/" });
+    const layerCredits = {
+      mapnik: {
+        id: "make_a_donation",
+        href: "https://supporting.openstreetmap.org",
+        donate: true
+      },
+      cyclosm: {
+        id: "cyclosm_credit",
+        children: {
+          cyclosm_link: {
+            id: "cyclosm_name",
+            href: "https://www.cyclosm.org"
+          },
+          osm_france_link: {
+            id: "osm_france",
+            href: "https://openstreetmap.fr/"
+          }
+        }
+      },
+      thunderforest: {
+        id: "thunderforest_credit",
+        children: {
+          thunderforest_link: {
+            id: "andy_allan",
+            href: "https://www.thunderforest.com/"
+          }
+        }
+      },
+      tracestrack: {
+        id: "tracestrack_credit",
+        children: {
+          tracestrack_link: {
+            id: "tracestrack",
+            href: "https://www.tracestrack.com/"
+          }
+        }
+      },
+      hotosm: {
+        id: "hotosm_credit",
+        children: {
+          hotosm_link: {
+            id: "hotosm_name",
+            href: "https://www.hotosm.org/"
+          },
+          osm_france_link: {
+            id: "osm_france",
+            href: "https://openstreetmap.fr/"
+          }
+        }
+      }
+    };

 
     this.baseLayers = [];
 
     this.baseLayers.push(new L.OSM.Mapnik({
 
     this.baseLayers = [];
 
     this.baseLayers.push(new L.OSM.Mapnik({

-      attribution: copyright + " ♥ " + donate + ". " + terms,
+      attribution: makeAttribution("mapnik"),

       code: "M",
       keyid: "mapnik",
       name: I18n.t("javascripts.map.base.standard")
     }));
 
     this.baseLayers.push(new L.OSM.CyclOSM({
       code: "M",
       keyid: "mapnik",
       name: I18n.t("javascripts.map.base.standard")
     }));
 
     this.baseLayers.push(new L.OSM.CyclOSM({

-      attribution: copyright + ". " + cyclosm + ". " + terms,
+      attribution: makeAttribution("cyclosm"),

       code: "Y",
       keyid: "cyclosm",
       name: I18n.t("javascripts.map.base.cyclosm")
       code: "Y",
       keyid: "cyclosm",
       name: I18n.t("javascripts.map.base.cyclosm")


@@ -41,7 +85,7 @@ L.OSM.Map = L.Map.extend({
 
     if (OSM.THUNDERFOREST_KEY) {
       this.baseLayers.push(new L.OSM.CycleMap({
 
     if (OSM.THUNDERFOREST_KEY) {
       this.baseLayers.push(new L.OSM.CycleMap({

-        attribution: copyright + ". " + thunderforest + ". " + terms,
+        attribution: makeAttribution("thunderforest"),

         apikey: OSM.THUNDERFOREST_KEY,
         code: "C",
         keyid: "cyclemap",
         apikey: OSM.THUNDERFOREST_KEY,
         code: "C",
         keyid: "cyclemap",


@@ -49,7 +93,7 @@ L.OSM.Map = L.Map.extend({
       }));
 
       this.baseLayers.push(new L.OSM.TransportMap({
       }));
 
       this.baseLayers.push(new L.OSM.TransportMap({

-        attribution: copyright + ". " + thunderforest + ". " + terms,
+        attribution: makeAttribution("thunderforest"),

         apikey: OSM.THUNDERFOREST_KEY,
         code: "T",
         keyid: "transportmap",
         apikey: OSM.THUNDERFOREST_KEY,
         code: "T",
         keyid: "transportmap",


@@ -57,15 +101,18 @@ L.OSM.Map = L.Map.extend({
       }));
     }
 
       }));
     }
 

-    this.baseLayers.push(new L.OSM.OPNVKarte({
-      attribution: copyright + ". " + memomaps + ". " + terms,
-      code: "O",
-      keyid: "opnvkarte",
-      name: I18n.t("javascripts.map.base.opnvkarte")
-    }));
+    if (OSM.TRACESTRACK_KEY) {
+      this.baseLayers.push(new L.OSM.TracestrackTopo({
+        attribution: makeAttribution("tracestrack"),
+        apikey: OSM.TRACESTRACK_KEY,
+        code: "P",
+        keyid: "tracestracktopo",
+        name: I18n.t("javascripts.map.base.tracestracktop_topo")
+      }));
+    }

 
     this.baseLayers.push(new L.OSM.HOT({
 
     this.baseLayers.push(new L.OSM.HOT({

-      attribution: copyright + ". " + hotosm + ". " + terms,
+      attribution: makeAttribution("hotosm"),

       code: "H",
       keyid: "hot",
       name: I18n.t("javascripts.map.base.hot")
       code: "H",
       keyid: "hot",
       name: I18n.t("javascripts.map.base.hot")


@@ -79,8 +126,7 @@ L.OSM.Map = L.Map.extend({
 
     this.gpsLayer = new L.OSM.GPS({
       pane: "overlayPane",
 
     this.gpsLayer = new L.OSM.GPS({
       pane: "overlayPane",

-      code: "G",
-      name: I18n.t("javascripts.map.base.gps")
+      code: "G"

     });
 
     this.on("layeradd", function (event) {
     });
 
     this.on("layeradd", function (event) {


@@ -88,6 +134,51 @@ L.OSM.Map = L.Map.extend({
         this.setMaxZoom(event.layer.options.maxZoom);
       }
     });
         this.setMaxZoom(event.layer.options.maxZoom);
       }
     });

+
+    function makeAttribution(id) {
+      const layerCredit = layerCredits[id];
+      let attribution = "";
+
+      attribution += I18n.t("javascripts.map.copyright_text", {
+        copyright_link: $("<a>", {
+          href: "/copyright",
+          text: I18n.t("javascripts.map.openstreetmap_contributors")
+        }).prop("outerHTML")
+      });
+
+      attribution += layerCredit.donate ? " &hearts; " : ". ";
+      attribution += makeCredit(layerCredit);
+      attribution += ". ";
+
+      attribution += $("<a>", {
+        href: "https://wiki.osmfoundation.org/wiki/Terms_of_Use",
+        text: I18n.t("javascripts.map.website_and_api_terms")
+      }).prop("outerHTML");
+
+      return attribution;
+    }
+
+    function makeCredit(credit) {
+      const children = {};
+      for (const childId in credit.children) {
+        children[childId] = makeCredit(credit.children[childId]);
+      }
+      const text = I18n.t(`javascripts.map.${credit.id}`, children);
+      if (credit.href) {
+        const link = $("<a>", {
+          href: credit.href,
+          text: text
+        });
+        if (credit.donate) {
+          link.addClass("donate-attr");
+        } else {
+          link.attr("target", "_blank");
+        }
+        return link.prop("outerHTML");
+      } else {
+        return text;
+      }
+    }

   },
 
   updateLayers: function (layerParam) {
   },
 
   updateLayers: function (layerParam) {


@@ -258,15 +349,17 @@ L.OSM.Map = L.Map.extend({
 
       this._object = object;
       this._objectLayer = L.featureGroup().addTo(this);
 
       this._object = object;
       this._objectLayer = L.featureGroup().addTo(this);

-      
+

       L.circleMarker(object.latLng, haloStyle).addTo(this._objectLayer);
       L.circleMarker(object.latLng, haloStyle).addTo(this._objectLayer);

-      
-      L.marker(object.latLng, {
-        icon: object.icon,
-        opacity: 1,
-        interactive: true
-      }).addTo(this._objectLayer);
-      
+
+      if (object.icon) {
+        L.marker(object.latLng, {
+          icon: object.icon,
+          opacity: 1,
+          interactive: true
+        }).addTo(this._objectLayer);
+      }
+

       if (callback) callback(this._objectLayer.getBounds());
     } else { // element or changeset handled by L.OSM.DataLayer
       var map = this;
       if (callback) callback(this._objectLayer.getBounds());
     } else { // element or changeset handled by L.OSM.DataLayer
       var map = this;