openstreetmap/openstreetmap.php

   1 <?php
   2 /**
   3  * Name: OpenStreetMap
   4  * Description: Use OpenStreetMap for displaying locations. After activation the post location just beneath your avatar in your posts will link to OpenStreetMap.
   5  * Version: 1.3.1
   6  * Author: Fabio <http://kirgroup.com/~fabrixxm>
   7  * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
   8  * Author: Klaus Weidenbach
   9  *
  10  */
  11 use Friendica\Core\Addon;
  12 use Friendica\Core\Cache;
  13 use Friendica\Core\Config;
  14 use Friendica\Core\L10n;
  15 use Friendica\Core\System;
  16 use Friendica\Util\Network;
  17
  18 const OSM_TMS = 'http://www.openstreetmap.org';
  19 const OSM_NOM = 'http://nominatim.openstreetmap.org/search.php';
  20 const OSM_ZOOM = 16;
  21 const OSM_MARKER = 0;
  22
  23 function openstreetmap_install()
  24 {
  25         Addon::registerHook('render_location', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_location');
  26         Addon::registerHook('generate_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_map');
  27         Addon::registerHook('generate_named_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_named_map');
  28         Addon::registerHook('Map::getCoordinates', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_get_coordinates');
  29         Addon::registerHook('page_header', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_alterheader');
  30
  31         logger("installed openstreetmap");
  32 }
  33
  34 function openstreetmap_uninstall()
  35 {
  36         Addon::unregisterHook('render_location', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_location');
  37         Addon::unregisterHook('generate_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_map');
  38         Addon::unregisterHook('generate_named_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_named_map');
  39         Addon::unregisterHook('Map::getCoordinates', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_get_coordinates');
  40         Addon::unregisterHook('page_header', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_alterheader');
  41
  42         logger("removed openstreetmap");
  43 }
  44
  45 function openstreetmap_alterheader($a, &$navHtml)
  46 {
  47         $addScriptTag = '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/openstreetmap/openstreetmap.js"></script>' . "\r\n";
  48         $a->page['htmlhead'] .= $addScriptTag;
  49 }
  50
  51 /**
  52  * @brief Add link to a map for an item's set location/coordinates.
  53  *
  54  * If an item has coordinates add link to a tile map server, e.g. openstreetmap.org.
  55  * If an item has a location open it with the help of OSM's Nominatim reverse geocode search.
  56  *
  57  * @param mixed $a
  58  * @param array& $item
  59  */
  60 function openstreetmap_location($a, &$item)
  61 {
  62         if (!(strlen($item['location']) || strlen($item['coord']))) {
  63                 return;
  64         }
  65
  66         /*
  67          * Get the configuration variables from the config.
  68          * @todo Separate the tile map server from the text-string to map tile server
  69          * since they apparently use different URL conventions.
  70          * We use OSM's current convention of "#map=zoom/lat/lon" and optional
  71          * ?mlat=lat&mlon=lon for markers.
  72          */
  73
  74         $tmsserver = Config::get('openstreetmap', 'tmsserver', OSM_TMS);
  75         $nomserver = Config::get('openstreetmap', 'nomserver', OSM_NOM);
  76         $zoom = Config::get('openstreetmap', 'zoom', OSM_ZOOM);
  77         $marker = Config::get('openstreetmap', 'marker', OSM_MARKER);
  78
  79         // This is needed since we stored an empty string in the config in previous versions
  80         if (empty($nomserver)) {
  81                 $nomserver = OSM_NOM;
  82         }
  83
  84         if ($item['coord'] != "") {
  85                 $coords = explode(' ', $item['coord']);
  86                 if (count($coords) > 1) {
  87                         $lat = urlencode(round($coords[0], 5));
  88                         $lon = urlencode(round($coords[1], 5));
  89                         $target = $tmsserver;
  90                         if ($marker > 0) {
  91                                 $target .= '?mlat=' . $lat . '&mlon=' . $lon;
  92                         }
  93                         $target .= '#map='.intval($zoom).'/'.$lat.'/'.$lon;
  94                 }
  95         }
  96
  97         if ($target == "") {
  98                 $target = $nomserver.'?q='.urlencode($item['location']);
  99         }
 100
 101         if ($item['location'] != "") {
 102                 $title = $item['location'];
 103         } else {
 104                 $title = $item['coord'];
 105         }
 106
 107         $item['html'] = '<a target="map" title="'.$title.'" href= "'.$target.'">'.$title.'</a>';
 108 }
 109
 110 function openstreetmap_get_coordinates($a, &$b)
 111 {
 112         $nomserver = Config::get('openstreetmap', 'nomserver', OSM_NOM);
 113
 114         // This is needed since we stored an empty string in the config in previous versions
 115         if (empty($nomserver)) {
 116                 $nomserver = OSM_NOM;
 117         }
 118
 119         $args = '?q=' . urlencode($b['location']) . '&format=json';
 120
 121         $cachekey = "openstreetmap:" . $b['location'];
 122         $j = Cache::get($cachekey);
 123
 124         if (is_null($j)) {
 125                 $x = Network::curl($nomserver . $args);
 126                 if ($x['success']) {
 127                         $j = json_decode($x['body'], true);
 128                         Cache::set($cachekey, $j, CACHE_MONTH);
 129                 }
 130         }
 131
 132         if (!empty($j[0]['lat']) && !empty($j[0]['lon'])) {
 133                 $b['lat'] = $j[0]['lat'];
 134                 $b['lon'] = $j[0]['lon'];
 135         }
 136 }
 137
 138 function openstreetmap_generate_named_map(&$a, &$b)
 139 {
 140         openstreetmap_get_coordinates($a, $b);
 141
 142         if (!empty($b['lat']) && !empty($b['lon'])) {
 143                 openstreetmap_generate_map($a, $b);
 144         }
 145 }
 146
 147 function openstreetmap_generate_map(&$a, &$b)
 148 {
 149         $tmsserver = Config::get('openstreetmap', 'tmsserver', OSM_TMS);
 150
 151         if (strpos(z_root(), 'https:') !== false) {
 152                 $tmsserver = str_replace('http:','https:',$tmsserver);
 153         }
 154
 155         $zoom = Config::get('openstreetmap', 'zoom', OSM_ZOOM);
 156         $marker = Config::get('openstreetmap', 'marker', OSM_MARKER);
 157
 158         $lat = $b['lat']; // round($b['lat'], 5);
 159         $lon = $b['lon']; // round($b['lon'], 5);
 160
 161         logger('lat: ' . $lat, LOGGER_DATA);
 162         logger('lon: ' . $lon, LOGGER_DATA);
 163
 164         $cardlink = '<a href="' . $tmsserver;
 165
 166         if ($marker > 0) {
 167                 $cardlink .= '?mlat=' . $lat . '&mlon=' . $lon;
 168         }
 169
 170         $cardlink .= '#map=' . $zoom . '/' . $lat . '/' . $lon . '">' . ($b['location'] ? escape_tags($b['location']) : L10n::t('View Larger')) . '</a>';
 171         if (empty($b['mode'])) {
 172                 $b['html'] = '<iframe style="width:100%; height:300px; border:1px solid #ccc" src="' . $tmsserver .
 173                                 '/export/embed.html?bbox=' . ($lon - 0.01) . '%2C' . ($lat - 0.01) . '%2C' . ($lon + 0.01) . '%2C' . ($lat + 0.01) .
 174                                 '&amp;layer=mapnik&amp;marker=' . $lat . '%2C' . $lon . '" style="border: 1px solid black"></iframe>' .
 175                                 '<br/><small>' . $cardlink . '</small>';
 176         } else {
 177                 $b['html'] .= '<br/>' . $cardlink;
 178         }
 179
 180         logger('generate_map: ' . $b['html'], LOGGER_DATA);
 181 }
 182
 183 function openstreetmap_addon_admin(&$a, &$o)
 184 {
 185         $t = get_markup_template("admin.tpl", "addon/openstreetmap/");
 186         $tmsserver = Config::get('openstreetmap', 'tmsserver', OSM_TMS);
 187         $nomserver = Config::get('openstreetmap', 'nomserver', OSM_NOM);
 188         $zoom = Config::get('openstreetmap', 'zoom', OSM_ZOOM);
 189         $marker = Config::get('openstreetmap', 'marker', OSM_MARKER);
 190
 191         // This is needed since we stored an empty string in the config in previous versions
 192         if (empty($nomserver)) {
 193                 $nomserver = OSM_NOM;
 194         }
 195
 196         $o = replace_macros($t, [
 197                         '$submit' => L10n::t('Submit'),
 198                         '$tmsserver' => ['tmsserver', L10n::t('Tile Server URL'), $tmsserver, L10n::t('A list of <a href="http://wiki.openstreetmap.org/wiki/TMS" target="_blank">public tile servers</a>')],
 199                         '$nomserver' => ['nomserver', L10n::t('Nominatim (reverse geocoding) Server URL'), $nomserver, L10n::t('A list of <a href="http://wiki.openstreetmap.org/wiki/Nominatim" target="_blank">Nominatim servers</a>')],
 200                         '$zoom' => ['zoom', L10n::t('Default zoom'), $zoom, L10n::t('The default zoom level. (1:world, 18:highest, also depends on tile server)')],
 201                         '$marker' => ['marker', L10n::t('Include marker on map'), $marker, L10n::t('Include a marker on the map.')],
 202         ]);
 203 }
 204
 205 function openstreetmap_addon_admin_post(&$a)
 206 {
 207         $urltms = defaults($_POST, 'tmsserver', OSM_TMS);
 208         $urlnom = defaults($_POST, 'nomserver', OSM_NOM);
 209         $zoom = defaults($_POST, 'zoom', OSM_ZOOM);
 210         $marker = defaults($_POST, 'marker', OSM_MARKER);
 211
 212         Config::set('openstreetmap', 'tmsserver', $urltms);
 213         Config::set('openstreetmap', 'nomserver', $urlnom);
 214         Config::set('openstreetmap', 'zoom', $zoom);
 215         Config::set('openstreetmap', 'marker', $marker);
 216
 217         info(L10n::t('Settings updated.') . EOL);
 218 }