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
  15
  16 function openstreetmap_install()
  17 {
  18         Addon::registerHook('render_location', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_location');
  19         Addon::registerHook('generate_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_map');
  20         Addon::registerHook('generate_named_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_named_map');
  21         Addon::registerHook('page_header', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_alterheader');
  22
  23         logger("installed openstreetmap");
  24 }
  25
  26 function openstreetmap_uninstall()
  27 {
  28         Addon::unregisterHook('render_location', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_location');
  29         Addon::unregisterHook('generate_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_map');
  30         Addon::unregisterHook('generate_named_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_named_map');
  31         Addon::unregisterHook('page_header', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_alterheader');
  32
  33         logger("removed openstreetmap");
  34 }
  35
  36 function openstreetmap_alterheader($a, &$navHtml)
  37 {
  38         $addScriptTag = '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/openstreetmap/openstreetmap.js"></script>' . "\r\n";
  39         $a->page['htmlhead'] .= $addScriptTag;
  40 }
  41
  42 /**
  43  * @brief Add link to a map for an item's set location/coordinates.
  44  *
  45  * If an item has coordinates add link to a tile map server, e.g. openstreetmap.org.
  46  * If an item has a location open it with the help of OSM's Nominatim reverse geocode search.
  47  *
  48  * @param mixed $a
  49  * @param array& $item
  50  */
  51 function openstreetmap_location($a, &$item) {
  52
  53         if(! (strlen($item['location']) || strlen($item['coord']))) {
  54                 return;
  55         }
  56
  57         /*
  58          * Get the configuration variables from the config.
  59          * @todo Separate the tile map server from the text-string to map tile server
  60          * since they apparently use different URL conventions.
  61          * We use OSM's current convention of "#map=zoom/lat/lon" and optional
  62          * ?mlat=lat&mlon=lon for markers.
  63          */
  64
  65         $tmsserver = Config::get('openstreetmap', 'tmsserver');
  66         if(! $tmsserver) {
  67                 $tmsserver = 'http://www.openstreetmap.org';
  68         }
  69
  70         $nomserver = Config::get('openstreetmap', 'nomserver');
  71         if(! $nomserver) {
  72                 $nomserver = 'http://nominatim.openstreetmap.org/search.php';
  73         }
  74
  75         $zoom = Config::get('openstreetmap', 'zoom');
  76         if(! $zoom) {
  77                 $zoom = 16;
  78         }
  79
  80         $marker = Config::get('openstreetmap', 'marker');
  81         if(! $marker) {
  82                 $marker = 0;
  83         }
  84
  85         if ($item['coord'] != "") {
  86                 $coords = explode(' ', $item['coord']);
  87                 if(count($coords) > 1) {
  88                         $lat = urlencode(round($coords[0], 5));
  89                         $lon = urlencode(round($coords[1], 5));
  90                         $target = $tmsserver;
  91                         if($marker > 0)
  92                                 $target .= '?mlat='.$lat.'&mlon='.$lon;
  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
 111 function openstreetmap_generate_named_map(&$a, &$b)
 112 {
 113         $nomserver = Config::get('openstreetmap', 'nomserver');
 114         if(! $nomserver)
 115                 $nomserver = 'http://nominatim.openstreetmap.org/search.php';
 116         $args = '?q=' . urlencode($b['location']) . '&format=json';
 117
 118         $x = z_fetch_url($nomserver . $args);
 119         if($x['success']) {
 120                 $j = json_decode($x['body'],true);
 121
 122                 if($j && is_array($j) && $j[0]['lat'] && $j[0]['lon']) {
 123                         $arr = ['lat' => $j[0]['lat'],'lon' => $j[0]['lon'],'location' => $b['location'], 'html' => ''];
 124                         openstreetmap_generate_map($a,$arr);
 125                         $b['html'] = $arr['html'];
 126                 }
 127         }
 128 }
 129
 130 function openstreetmap_generate_map(&$a, &$b)
 131 {
 132         $tmsserver = Config::get('openstreetmap', 'tmsserver');
 133         if(! $tmsserver) {
 134                 $tmsserver = 'http://www.openstreetmap.org';
 135         }
 136         if(strpos(z_root(),'https:') !== false) {
 137                 $tmsserver = str_replace('http:','https:',$tmsserver);
 138         }
 139
 140
 141         $zoom = Config::get('openstreetmap', 'zoom');
 142         if(! $zoom) {
 143                 $zoom = 16;
 144         }
 145
 146         $marker = Config::get('openstreetmap', 'marker');
 147         if(! $marker) {
 148                 $marker = 0;
 149         }
 150
 151         $lat = $b['lat']; // round($b['lat'], 5);
 152         $lon = $b['lon']; // round($b['lon'], 5);
 153
 154         logger('lat: ' . $lat, LOGGER_DATA);
 155         logger('lon: ' . $lon, LOGGER_DATA);
 156
 157
 158         $b['html'] = '<iframe style="width:100%; height:300px; border:1px solid #ccc" src="' . $tmsserver . '/export/embed.html?bbox=' . ($lon - 0.01) . '%2C' . ($lat - 0.01) . '%2C' . ($lon + 0.01) . '%2C' . ($lat + 0.01) ;
 159
 160         $b['html'] .=  '&amp;layer=mapnik&amp;marker=' . $lat . '%2C' . $lon . '" style="border: 1px solid black"></iframe><br/><small><a href="' . $tmsserver . '/?mlat=' . $lat . '&mlon=' . $lon . '#map=16/' . $lat . '/' . $lon . '">' . (($b['location']) ? escape_tags($b['location']) : t('View Larger')) . '</a></small>';
 161
 162         logger('generate_map: ' . $b['html'], LOGGER_DATA);
 163
 164 }
 165
 166 function openstreetmap_plugin_admin(&$a, &$o)
 167 {
 168         $t = get_markup_template("admin.tpl", "addon/openstreetmap/");
 169         $tmsserver = Config::get('openstreetmap', 'tmsserver');
 170         if(! $tmsserver) {
 171                 $tmsserver = 'http://www.openstreetmap.org';
 172         }
 173         $nomserver = Config::get('openstreetmap', 'nomserver');
 174         if(! $nomserver) {
 175                 $nomserver = 'http://nominatim.openstreetmap.org/search.php';
 176         }
 177         $zoom = Config::get('openstreetmap', 'zoom');
 178         if(! $zoom) {
 179                 $zoom = 16;
 180         }
 181         $marker = Config::get('openstreetmap', 'marker');
 182         if(! $marker) {
 183                 $marker = 0;
 184         }
 185
 186         $o = replace_macros($t, [
 187                         '$submit' => t('Submit'),
 188                         '$tmsserver' => ['tmsserver', t('Tile Server URL'), $tmsserver, t('A list of <a href="http://wiki.openstreetmap.org/wiki/TMS" target="_blank">public tile servers</a>')],
 189                         '$nomserver' => ['nomserver', t('Nominatim (reverse geocoding) Server URL'), $nomserver, t('A list of <a href="http://wiki.openstreetmap.org/wiki/Nominatim" target="_blank">Nominatim servers</a>')],
 190                         '$zoom' => ['zoom', t('Default zoom'), $zoom, t('The default zoom level. (1:world, 18:highest, also depends on tile server)')],
 191                         '$marker' => ['marker', t('Include marker on map'), $marker, t('Include a marker on the map.')],
 192         ]);
 193 }
 194
 195 function openstreetmap_plugin_admin_post(&$a)
 196 {
 197         $urltms = ((x($_POST, 'tmsserver')) ? notags(trim($_POST['tmsserver'])) : '');
 198         $urlnom = ((x($_POST, 'nomserver')) ? notags(trim($_POST['nomserver'])) : '');
 199         $zoom = ((x($_POST, 'zoom')) ? intval(trim($_POST['zoom'])) : '16');
 200         $marker = ((x($_POST, 'marker')) ? intval(trim($_POST['marker'])) : '0');
 201         Config::set('openstreetmap', 'tmsserver', $urltms);
 202         Config::set('openstreetmap', 'nomserver', $urlnom);
 203         Config::set('openstreetmap', 'zoom', $zoom);
 204         Config::set('openstreetmap', 'marker', $marker);
 205         info( t('Settings updated.') . EOL);
 206 }