control requesting polygons from API without hidden HTML field

[nominatim-ui.git] / src / handlebar_helpers.js

diff --git a/src/handlebar_helpers.js b/src/handlebar_helpers.js
index f7997818c516c0ae7d407628b4735e76ff97b323..4d1889f324530b13371c7c3bca0930a8cf363c0e 100644 (file)
--- a/src/handlebar_helpers.js
+++ b/src/handlebar_helpers.js
@@ -1,141 +1,307 @@
-function formatOSMType(sType, bExcludeExternal)
-{
-    if (sType == 'N') return 'node';
-    if (sType == 'W') return 'way';
-    if (sType == 'R') return 'relation';
+'use strict';

 
 

-    if (!bExcludeExternal) return '';
+function formatOSMType(sType, bExcludeExternal) {
+  if (sType === 'N') return 'node';
+  if (sType === 'W') return 'way';
+  if (sType === 'R') return 'relation';

 
 

-    if (sType == 'T') return 'way';
-    if (sType == 'I') return 'way';
+  if (!bExcludeExternal) return '';

 
 

-    return '';
+  if (sType === 'T') return 'way';
+  if (sType === 'I') return 'way';
+
+  return '';

 }
 
 }
 

+function getIcon(aPlace) {
+  // equivalent to PHP Nominatim::ClassTypes::getIcon
+  // covers 83 of 214 available icon filenames, e.g. transport_roundabout_anticlockwise
+  // transport_rental_bicycle or place_of_worship_christian would need more data from
+  // the place.
+  var aIcons = {
+    'boundary:administrative': 'poi_boundary_administrative',
+    'place:city': 'poi_place_city',
+    'place:town': 'poi_place_town',
+    'place:village': 'poi_place_village',
+    'place:hamlet': 'poi_place_village',
+    'place:suburb': 'poi_place_village',
+    'place:locality': 'poi_place_village',
+    'place:airport': 'transport_airport2',
+    'aeroway:aerodrome': 'transport_airport2',
+    'railway:station': 'transport_train_station2',
+    'amenity:place_of_worship': 'place_of_worship_unknown3',
+    'amenity:pub': 'food_pub',
+    'amenity:bar': 'food_bar',
+    'amenity:university': 'education_university',
+    'tourism:museum': 'tourist_museum',
+    'amenity:arts_centre': 'tourist_art_gallery2',
+    'tourism:zoo': 'tourist_zoo',
+    'tourism:theme_park': 'poi_point_of_interest',
+    'tourism:attraction': 'poi_point_of_interest',
+    'leisure:golf_course': 'sport_golf',
+    'historic:castle': 'tourist_castle',
+    'amenity:hospital': 'health_hospital',
+    'amenity:school': 'education_school',
+    'amenity:theatre': 'tourist_theatre',
+    'amenity:library': 'amenity_library',
+    'amenity:fire_station': 'amenity_firestation3',
+    'amenity:police': 'amenity_police2',
+    'amenity:bank': 'money_bank2',
+    'amenity:post_office': 'amenity_post_office',
+    'tourism:hotel': 'accommodation_hotel2',
+    'amenity:cinema': 'tourist_cinema',
+    'tourism:artwork': 'tourist_art_gallery2',
+    'historic:archaeological_site': 'tourist_archaeological2',
+    'amenity:doctors': 'health_doctors',
+    'leisure:sports_centre': 'sport_leisure_centre',
+    'leisure:swimming_pool': 'sport_swimming_outdoor',
+    'shop:supermarket': 'shopping_supermarket',
+    'shop:convenience': 'shopping_convenience',
+    'amenity:restaurant': 'food_restaurant',
+    'amenity:fast_food': 'food_fastfood',
+    'amenity:cafe': 'food_cafe',
+    'tourism:guest_house': 'accommodation_bed_and_breakfast',
+    'amenity:pharmacy': 'health_pharmacy_dispensing',
+    'amenity:fuel': 'transport_fuel',
+    'natural:peak': 'poi_peak',
+    'natural:wood': 'landuse_coniferous_and_deciduous',
+    'shop:bicycle': 'shopping_bicycle',
+    'shop:clothes': 'shopping_clothes',
+    'shop:hairdresser': 'shopping_hairdresser',
+    'shop:doityourself': 'shopping_diy',
+    'shop:estate_agent': 'shopping_estateagent2',
+    'shop:car': 'shopping_car',
+    'shop:garden_centre': 'shopping_garden_centre',
+    'shop:car_repair': 'shopping_car_repair',
+    'shop:bakery': 'shopping_bakery',
+    'shop:butcher': 'shopping_butcher',
+    'shop:apparel': 'shopping_clothes',
+    'shop:laundry': 'shopping_laundrette',
+    'shop:beverages': 'shopping_alcohol',
+    'shop:alcohol': 'shopping_alcohol',
+    'shop:optician': 'health_opticians',
+    'shop:chemist': 'health_pharmacy',
+    'shop:gallery': 'tourist_art_gallery2',
+    'shop:jewelry': 'shopping_jewelry',
+    'tourism:information': 'amenity_information',
+    'historic:ruins': 'tourist_ruin',
+    'amenity:college': 'education_school',
+    'historic:monument': 'tourist_monument',
+    'historic:memorial': 'tourist_monument',
+    'historic:mine': 'poi_mine',
+    'tourism:caravan_site': 'accommodation_caravan_park',
+    'amenity:bus_station': 'transport_bus_station',
+    'amenity:atm': 'money_atm2',
+    'tourism:viewpoint': 'tourist_view_point',
+    'tourism:guesthouse': 'accommodation_bed_and_breakfast',
+    'railway:tram': 'transport_tram_stop',
+    'amenity:courthouse': 'amenity_court',
+    'amenity:recycling': 'amenity_recycling',
+    'amenity:dentist': 'health_dentist',
+    'natural:beach': 'tourist_beach',
+    'railway:tram_stop': 'transport_tram_stop',
+    'amenity:prison': 'amenity_prison',
+    'highway:bus_stop': 'transport_bus_stop2'
+  };
+
+  var sCategoryPlace = aPlace.category + ':' + aPlace.type;
+
+  return aIcons[sCategoryPlace];
+}
+
+

 Handlebars.registerHelper({
 Handlebars.registerHelper({

-    isaddresses_unused: function(aAddressLine) {
-        return ((aAddressLine.isaddress && aAddressLine.isaddress == 'f') ? 'notused' : '');
-    },
-    // { osm_type: 'R', osm_id: 12345 }
-    // <a href="//www.openstreetmap.org/relation/12345">relation 12345</a
-    osmLink: function(aPlace) {
-        if (!aPlace.osm_type) return '';
-        var sOSMType = formatOSMType(aPlace.osm_type, false);
-        if (!sOSMType) return '';
-
-        return new Handlebars.SafeString(
-            '<a href="//www.openstreetmap.org/' + sOSMType + '/' + aPlace.osm_id + '">' + sOSMType + ' ' + aPlace.osm_id + '</a>'
-        );
-    },
-    /* en:London_Borough_of_Redbridge => https://en.wikipedia.org/wiki/London_Borough_of_Redbridge */
-    wikipediaLink: function(aPlace) {
-        if (! aPlace.wikipedia) return '';
-
-        var parts = aPlace.wikipedia.split(':', 2);
-
-        var sTitle = Handlebars.escapeExpression(aPlace.wikipedia),
-            sLanguage = Handlebars.escapeExpression(parts[0]),
-            sArticle = Handlebars.escapeExpression(parts[1]);
-
-        return new Handlebars.SafeString(
-            '<a href="https://' + sLanguage + '.wikipedia.org/wiki/' + sArticle + '" target="_blank">' + sTitle + '</a>'
-        );
-    },
-    // { osm_type: 'R', osm_id: 12345 }
-    // <a href="//www.openstreetmap.org/relation/12345">relation 12345</a
-    detailsLink: function(aFeature, sTitle) {
-        if (!aFeature) return '';
-        if (!aFeature.place_id) return '';
-
-        sTitle = 'details >';
-        var sTitle = Handlebars.escapeExpression(sTitle);
-
-        return new Handlebars.SafeString(
-            '<a href="details.html?place_id=' + aFeature.place_id + '">' + (sTitle ? sTitle : aFeature.place_id ) + '</a>'
-        );
-    },
-    coverageType: function(aPlace) {
-        return (aPlace.isarea === 't' ? 'Polygon' : 'Point');
-    },
-    // fDistance is in meters
-    formatDistance: function(fDistanceMeters) {
-        if (fDistanceMeters < 1) return '0';
-
-        var formatted = (fDistanceMeters >= 1000) ?
-            Math.round(fDistanceMeters/1000, 1) + ' km' :
-            Math.round(fDistanceMeters, 0) + ' m';
-
-        return new Handlebars.SafeString(
-            '<abbr class="distance" title="' + fDistanceMeters + '">~' + formatted + '</abbr>'
-        );
-    },
-    // mark partial tokens (those starting with a space) with a star for readability
-    formatKeywordToken: function(sToken) {
-        return (sToken[0] == ' ' ? '*' : '') + Handlebars.escapeExpression(sToken);
-    },
-    // Any over 15 are invalid data in OSM anyway
-    formatAdminLevel: function(iLevel) {
-        return (iLevel < 15 ? iLevel : '');
-    },
-    formatMapIcon: function(sIcon) {
-        if (!sIcon) return;
-        
-        var url = sIcon.match(/png$/) ? Nominatim_Config.Images_Base_Url + '/' + sIcon : Nominatim_Config.Images_Base_Url + 'nominatim/images/mapicons/' + sIcon + '.n.32.png';
-
-        return new Handlebars.SafeString(
-            '<img class="mapicon" src="' + url + '" alt="' + sIcon + '"/>'
-        );
-    },
-    formatLabel: function(aPlace) {
-        if (aPlace.label) return aPlace.label;
-
-        function capitalize(s)
-        {
-            return s && s[0].toUpperCase() + s.slice(1);
-        }
-
-        if (aPlace.type && aPlace.type === 'yes') {
-            return capitalize(aPlace.class.replace(/_/g, ' '));
-        } else {
-            return capitalize(aPlace.type.replace(/_/g, ' '));
-        }
-    },
-    zoomLevels: function(iSelectedZoom) {
-        var aZoomLevels = [
-            /*  0 */ 'Continent / Sea',
-            /*  1 */ '',
-            /*  2 */ '',
-            /*  3 */ 'Country',
-            /*  4 */ '',
-            /*  5 */ 'State',
-            /*  6 */ 'Region',
-            /*  7 */ '',
-            /*  8 */ 'County',
-            /*  9 */ '',
-            /* 10 */ 'City',
-            /* 11 */ '',
-            /* 12 */ 'Town / Village',
-            /* 13 */ '',
-            /* 14 */ 'Suburb',
-            /* 15 */ '',
-            /* 16 */ 'Street',
-            /* 17 */ '',
-            /* 18 */ 'Building',
-            /* 19 */ '',
-            /* 20 */ '',
-            /* 21 */ ''
-        ];
-
-        var select = $('<select>');
-        var option = jQuery('<option>', { value: '', text: '--'});
-        if (typeof(iSelectedZoom) === 'undefined') option.attr('selected', 'selected');
-        option.appendTo(select);
-
-        jQuery.each(aZoomLevels, function(i, title) {
-            var option = jQuery('<option>', { value: i, text: i + ' ' + title });
-            if (i == iSelectedZoom) option.attr('selected', 'selected');
-            option.appendTo(select);
-        });
-        return new Handlebars.SafeString(select.html());
+  formatOSMType: function (sType, bExcludeExternal) {
+    return formatOSMType(sType, bExcludeExternal);
+  },
+  shortOSMType: function (sType) {
+    if (sType === 'node') return 'N';
+    if (sType === 'way') return 'W';
+    if (sType === 'relation') return 'R';
+    return '';
+  },
+  // { osm_type: 'R', osm_id: 12345 }
+  // <a href="https://www.openstreetmap.org/relation/12345">relation 12345</a
+  osmLink: function (aPlace) {
+    if (!aPlace.osm_type) return '';
+    var sOSMType = formatOSMType(aPlace.osm_type, false);
+    if (!sOSMType) return '';
+
+    return new Handlebars.SafeString(
+      '<a href="https://www.openstreetmap.org/' + sOSMType + '/' + aPlace.osm_id + '">' + sOSMType + ' ' + aPlace.osm_id + '</a>'
+    );
+  },
+  /* en:London_Borough_of_Redbridge => https://en.wikipedia.org/wiki/London_Borough_of_Redbridge */
+  wikipediaLink: function (aPlace) {
+    if (!aPlace.calculated_wikipedia) return '';
+
+    var parts = aPlace.calculated_wikipedia.split(':', 2);
+
+    var sTitle = Handlebars.escapeExpression(aPlace.calculated_wikipedia);
+    var sLanguage = Handlebars.escapeExpression(parts[0]);
+    var sArticle = Handlebars.escapeExpression(parts[1]);
+
+    return new Handlebars.SafeString(
+      '<a href="https://' + sLanguage + '.wikipedia.org/wiki/' + sArticle + '" target="_blank">' + sTitle + '</a>'
+    );
+  },
+  // { osm_type: 'R', osm_id: 12345 }
+  // <a href="details.html?place_id=12345">details</a>
+  detailsLink: function (aFeature, sTitle) {
+    if (!aFeature) return '';
+    if (!aFeature.place_id) return '';
+
+    var sTitleEscaped = Handlebars.escapeExpression(sTitle || 'details >');
+
+    return new Handlebars.SafeString(
+      '<a href="details.html?place_id=' + aFeature.place_id + '">' + sTitleEscaped + '</a>'
+    );
+  },
+  detailsPermaLink: function (aFeature, sTitle) {
+    if (!aFeature) return '';
+
+    var sOSMType = formatOSMType(aFeature.osm_type, false);
+    if (!sOSMType) return '';
+
+    var sTitleEscaped = Handlebars.escapeExpression(sTitle || sOSMType + ' ' + aFeature.osm_id);
+
+    var sURL = 'details.html?osmtype=' + aFeature.osm_type + '&osmid=' + aFeature.osm_id;
+    if (aFeature.category) {
+      sURL = sURL + '&class=' + aFeature.category;
+    }
+
+    return new Handlebars.SafeString(
+      '<a href="' + sURL + '">' + sTitleEscaped + '</a>'
+    );
+  },
+  formatPlaceType: function (aPlace) {
+    var sOut = aPlace.class + ':' + aPlace.type;
+    if (aPlace.type && aPlace.type === 'administrative' && aPlace.place_type) {
+      sOut = sOut + ' (' + aPlace.place_type + ')';
+    }
+    return new Handlebars.SafeString(sOut);
+  },
+  coverageType: function (aPlace) {
+    return (aPlace.isarea ? 'Polygon' : 'Point');
+  },
+  // fDistance is in meters
+  formatDistance: function (fDistanceMeters) {
+    if (fDistanceMeters < 1) return '0';
+
+    var formatted = (fDistanceMeters >= 1000)
+      ? Math.round(fDistanceMeters / 1000, 1) + ' km'
+      : Math.round(fDistanceMeters, 0) + ' m';
+
+    return new Handlebars.SafeString(
+      '<abbr class="distance" title="' + fDistanceMeters + '">~' + formatted + '</abbr>'
+    );
+  },
+  // mark partial tokens (those starting with a space) with a star for readability
+  formatKeywordToken: function (sToken) {
+    return (sToken[0] === ' ' ? '*' : '') + Handlebars.escapeExpression(sToken);
+  },
+  // Any over 15 are invalid data in OSM anyway
+  formatAdminLevel: function (iLevel) {
+    return (iLevel < 15 ? iLevel : '');
+  },
+  formatMapIcon: function (aPlace) {
+    var sIcon = getIcon(aPlace);
+
+    if (!sIcon) return '';
+
+    var title = 'icon for ' + aPlace.category + ' ' + aPlace.type;
+    var url = get_config_value('Images_Base_Url') + sIcon + '.p.20.png';
+
+    return new Handlebars.SafeString(
+      '<img class="mapicon" src="' + url + '" alt="' + title + '"/>'
+    );
+  },
+  formatLabel: function (aPlace) {
+    if (aPlace.label) return aPlace.label;
+
+    function capitalize(s) {
+      return s && s[0].toUpperCase() + s.slice(1);
+    }
+
+    if (aPlace.type && aPlace.type === 'yes' && aPlace.class) {
+      return capitalize(aPlace.class.replace(/_/g, ' '));
+    }
+    if (aPlace.type) {
+      return capitalize(aPlace.type.replace(/_/g, ' '));

     }
     }

+    return '';
+  },
+  formatSearchRank: function (iRank) {
+    // same as
+    // https://github.com/osm-search/Nominatim/blob/master/sql/functions.sql
+    // get_searchrank_label()
+
+    if (iRank < 2) return 'continent';
+    if (iRank < 4) return 'sea';
+    if (iRank < 8) return 'country';
+    if (iRank < 12) return 'state';
+    if (iRank < 16) return 'county';
+    if (iRank === 16) return 'city';
+    if (iRank === 17) return 'town / island';
+    if (iRank === 18) return 'village / hamlet';
+    if (iRank === 20) return 'suburb';
+    if (iRank === 21) return 'postcode area';
+    if (iRank === 22) return 'croft / farm / locality / islet';
+    if (iRank === 23) return 'postcode area';
+    if (iRank === 25) return 'postcode point';
+    if (iRank === 26) return 'street / major landmark';
+    if (iRank === 27) return 'minory street / path';
+    if (iRank === 28) return 'house / building';
+    return 'other: ' + iRank;
+  },
+  tooManyHierarchyLinesWarning: function (aPlace) {
+    if (!aPlace.hierarchy) return '';
+
+    var c = Object.keys(aPlace.hierarchy);
+    if (c < 500) return '';
+
+    return new Handlebars.SafeString(
+      '<p>There are more child objects which are not shown.</p>'
+    );
+  },
+  zoomLevels: function (iSelectedZoom) {
+    var aZoomLevels = [
+      /*  0 */ 'Continent / Sea',
+      /*  1 */ '',
+      /*  2 */ '',
+      /*  3 */ 'Country',
+      /*  4 */ '',
+      /*  5 */ 'State',
+      /*  6 */ 'Region',
+      /*  7 */ '',
+      /*  8 */ 'County',
+      /*  9 */ '',
+      /* 10 */ 'City',
+      /* 11 */ '',
+      /* 12 */ 'Town / Village',
+      /* 13 */ '',
+      /* 14 */ 'Suburb',
+      /* 15 */ '',
+      /* 16 */ 'Street',
+      /* 17 */ '',
+      /* 18 */ 'Building',
+      /* 19 */ '',
+      /* 20 */ '',
+      /* 21 */ ''
+    ];
+
+    var select = $('<select>');
+    var option = jQuery('<option>', { value: '', text: '--' });
+    if (typeof (iSelectedZoom) === 'undefined') {
+      option.attr('selected', 'selected');
+    }
+    option.appendTo(select);
+
+    jQuery.each(aZoomLevels, function (i, title) {
+      option = jQuery('<option>', { value: i, text: i + ' ' + title });
+      if (i === iSelectedZoom) option.attr('selected', 'selected');
+      option.appendTo(select);
+    });
+    return new Handlebars.SafeString(select.html());
+  }

 });
 });