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