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