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