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