src/handlebar_helpers.js

   1 'use strict';
   2
   3 function formatOSMType(sType, bExcludeExternal) {
   4   if (sType === 'N') return 'node';
   5   if (sType === 'W') return 'way';
   6   if (sType === 'R') return 'relation';
   7
   8   if (!bExcludeExternal) return '';
   9
  10   if (sType === 'T') return 'way';
  11   if (sType === 'I') return 'way';
  12
  13   return '';
  14 }
  15
  16 Handlebars.registerHelper({
  17   formatOSMType: function (sType, bExcludeExternal) {
  18     return formatOSMType(sType, bExcludeExternal);
  19   },
  20   shortOSMType: function (sType) {
  21     if (sType === 'node') return 'N';
  22     if (sType === 'way') return 'W';
  23     if (sType === 'relation') return 'R';
  24     return '';
  25   },
  26   // { osm_type: 'R', osm_id: 12345 }
  27   // <a href="https://www.openstreetmap.org/relation/12345">relation 12345</a
  28   osmLink: function (aPlace) {
  29     if (!aPlace.osm_type) return '';
  30     var sOSMType = formatOSMType(aPlace.osm_type, false);
  31     if (!sOSMType) return '';
  32
  33     return new Handlebars.SafeString(
  34       '<a href="https://www.openstreetmap.org/' + sOSMType + '/' + aPlace.osm_id + '">' + sOSMType + ' ' + aPlace.osm_id + '</a>'
  35     );
  36   },
  37   /* en:London_Borough_of_Redbridge => https://en.wikipedia.org/wiki/London_Borough_of_Redbridge */
  38   wikipediaLink: function (aPlace) {
  39     if (!aPlace.calculated_wikipedia) return '';
  40
  41     var parts = aPlace.calculated_wikipedia.split(':', 2);
  42
  43     var sTitle = Handlebars.escapeExpression(aPlace.calculated_wikipedia);
  44     var sLanguage = Handlebars.escapeExpression(parts[0]);
  45     var sArticle = Handlebars.escapeExpression(parts[1]);
  46
  47     return new Handlebars.SafeString(
  48       '<a href="https://' + sLanguage + '.wikipedia.org/wiki/' + sArticle + '" target="_blank">' + sTitle + '</a>'
  49     );
  50   },
  51   // { osm_type: 'R', osm_id: 12345 }
  52   // <a href="details.html?place_id=12345">details</a>
  53   detailsLink: function (aFeature, sTitle) {
  54     if (!aFeature) return '';
  55     if (!aFeature.place_id) return '';
  56
  57     var sTitleEscaped = Handlebars.escapeExpression(sTitle || 'details >');
  58
  59     return new Handlebars.SafeString(
  60       '<a href="details.html?place_id=' + aFeature.place_id + '">' + sTitleEscaped + '</a>'
  61     );
  62   },
  63   detailsPermaLink: function (aFeature, sTitle) {
  64     if (!aFeature) return '';
  65
  66     var sOSMType = formatOSMType(aFeature.osm_type, false);
  67     if (!sOSMType) return '';
  68
  69     var sTitleEscaped = Handlebars.escapeExpression(sTitle || sOSMType + ' ' + aFeature.osm_id);
  70
  71     var sURL = 'details.html?osmtype=' + aFeature.osm_type + '&osmid=' + aFeature.osm_id;
  72     if (aFeature.category) {
  73       sURL = sURL + '&class=' + aFeature.category;
  74     }
  75
  76     return new Handlebars.SafeString(
  77       '<a href="' + sURL + '">' + sTitleEscaped + '</a>'
  78     );
  79   },
  80   formatPlaceType: function (aPlace) {
  81     var sOut = aPlace.class + ':' + aPlace.type;
  82     if (aPlace.type && aPlace.type === 'administrative' && aPlace.place_type) {
  83       sOut = sOut + ' (' + aPlace.place_type + ')';
  84     }
  85     return new Handlebars.SafeString(sOut);
  86   },
  87   coverageType: function (aPlace) {
  88     return (aPlace.isarea ? 'Polygon' : 'Point');
  89   },
  90   // fDistance is in meters
  91   formatDistance: function (fDistanceMeters) {
  92     if (fDistanceMeters < 1) return '0';
  93
  94     var formatted = (fDistanceMeters >= 1000)
  95       ? Math.round(fDistanceMeters / 1000, 1) + ' km'
  96       : Math.round(fDistanceMeters, 0) + ' m';
  97
  98     return new Handlebars.SafeString(
  99       '<abbr class="distance" title="' + fDistanceMeters + '">~' + formatted + '</abbr>'
 100     );
 101   },
 102   // mark partial tokens (those starting with a space) with a star for readability
 103   formatKeywordToken: function (sToken) {
 104     return (sToken[0] === ' ' ? '*' : '') + Handlebars.escapeExpression(sToken);
 105   },
 106   // Any over 15 are invalid data in OSM anyway
 107   formatAdminLevel: function (iLevel) {
 108     return (iLevel < 15 ? iLevel : '');
 109   },
 110   formatMapIcon: function (sIcon) {
 111     if (!sIcon) return '';
 112
 113     // https://nominatim.openstreetmap.org/images/mapicons/poi_boundary_administrative.p.20.png
 114     // => poi boundary administrative
 115     var title = sIcon.replace(/.+\//, '').replace(/\..+/, '').replace(/_/g, ' ');
 116     // => http://localhost/mapicons/poi_boundary_administrative.p.20.png
 117     var url = get_config_value('Images_Base_Url') + sIcon.replace(/.+\//, '');
 118
 119     return new Handlebars.SafeString(
 120       '<img class="mapicon" src="' + url + '" alt="' + title + '"/>'
 121     );
 122   },
 123   formatLabel: function (aPlace) {
 124     if (aPlace.label) return aPlace.label;
 125
 126     function capitalize(s) {
 127       return s && s[0].toUpperCase() + s.slice(1);
 128     }
 129
 130     if (aPlace.type && aPlace.type === 'yes' && aPlace.class) {
 131       return capitalize(aPlace.class.replace(/_/g, ' '));
 132     }
 133     if (aPlace.type) {
 134       return capitalize(aPlace.type.replace(/_/g, ' '));
 135     }
 136     return '';
 137   },
 138   formatSearchRank: function (iRank) {
 139     // same as
 140     // https://github.com/osm-search/Nominatim/blob/master/sql/functions.sql
 141     // get_searchrank_label()
 142
 143     if (iRank < 2) return 'continent';
 144     if (iRank < 4) return 'sea';
 145     if (iRank < 8) return 'country';
 146     if (iRank < 12) return 'state';
 147     if (iRank < 16) return 'county';
 148     if (iRank === 16) return 'city';
 149     if (iRank === 17) return 'town / island';
 150     if (iRank === 18) return 'village / hamlet';
 151     if (iRank === 20) return 'suburb';
 152     if (iRank === 21) return 'postcode area';
 153     if (iRank === 22) return 'croft / farm / locality / islet';
 154     if (iRank === 23) return 'postcode area';
 155     if (iRank === 25) return 'postcode point';
 156     if (iRank === 26) return 'street / major landmark';
 157     if (iRank === 27) return 'minory street / path';
 158     if (iRank === 28) return 'house / building';
 159     return 'other: ' + iRank;
 160   },
 161   tooManyHierarchyLinesWarning: function (aPlace) {
 162     if (!aPlace.hierarchy) return '';
 163
 164     var c = Object.keys(aPlace.hierarchy);
 165     if (c < 500) return '';
 166
 167     return new Handlebars.SafeString(
 168       '<p>There are more child objects which are not shown.</p>'
 169     );
 170   },
 171   zoomLevels: function (iSelectedZoom) {
 172     var aZoomLevels = [
 173       /*  0 */ 'Continent / Sea',
 174       /*  1 */ '',
 175       /*  2 */ '',
 176       /*  3 */ 'Country',
 177       /*  4 */ '',
 178       /*  5 */ 'State',
 179       /*  6 */ 'Region',
 180       /*  7 */ '',
 181       /*  8 */ 'County',
 182       /*  9 */ '',
 183       /* 10 */ 'City',
 184       /* 11 */ '',
 185       /* 12 */ 'Town / Village',
 186       /* 13 */ '',
 187       /* 14 */ 'Suburb',
 188       /* 15 */ '',
 189       /* 16 */ 'Street',
 190       /* 17 */ '',
 191       /* 18 */ 'Building',
 192       /* 19 */ '',
 193       /* 20 */ '',
 194       /* 21 */ ''
 195     ];
 196
 197     var select = $('<select>');
 198     var option = jQuery('<option>', { value: '', text: '--' });
 199     if (typeof (iSelectedZoom) === 'undefined') {
 200       option.attr('selected', 'selected');
 201     }
 202     option.appendTo(select);
 203
 204     jQuery.each(aZoomLevels, function (i, title) {
 205       option = jQuery('<option>', { value: i, text: i + ' ' + title });
 206       if (i === iSelectedZoom) option.attr('selected', 'selected');
 207       option.appendTo(select);
 208     });
 209     return new Handlebars.SafeString(select.html());
 210   }
 211 });