4 * Description: Use OpenStreetMap for displaying locations. After activation the post location just beneath your avatar in your posts will link to OpenStreetMap.
6 * Author: Fabio <http://kirgroup.com/~fabrixxm>
7 * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
8 * Author: Klaus Weidenbach
11 use Friendica\Core\Addon;
12 use Friendica\Core\Cache;
13 use Friendica\Core\Config;
14 use Friendica\Core\L10n;
15 use Friendica\Core\System;
16 use Friendica\Util\Network;
18 const OSM_TMS = 'http://www.openstreetmap.org';
19 const OSM_NOM = 'http://nominatim.openstreetmap.org/search.php';
23 function openstreetmap_install()
25 Addon::registerHook('render_location', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_location');
26 Addon::registerHook('generate_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_map');
27 Addon::registerHook('generate_named_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_named_map');
28 Addon::registerHook('Map::getCoordinates', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_get_coordinates');
29 Addon::registerHook('page_header', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_alterheader');
31 logger("installed openstreetmap");
34 function openstreetmap_uninstall()
36 Addon::unregisterHook('render_location', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_location');
37 Addon::unregisterHook('generate_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_map');
38 Addon::unregisterHook('generate_named_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_named_map');
39 Addon::unregisterHook('Map::getCoordinates', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_get_coordinates');
40 Addon::unregisterHook('page_header', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_alterheader');
42 logger("removed openstreetmap");
45 function openstreetmap_alterheader($a, &$navHtml) {
46 $addScriptTag = '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/openstreetmap/openstreetmap.js"></script>' . "\r\n";
47 $a->page['htmlhead'] .= $addScriptTag;
51 * @brief Add link to a map for an item's set location/coordinates.
53 * If an item has coordinates add link to a tile map server, e.g. openstreetmap.org.
54 * If an item has a location open it with the help of OSM's Nominatim reverse geocode search.
59 function openstreetmap_location($a, &$item)
61 if (!(strlen($item['location']) || strlen($item['coord']))) {
65 * Get the configuration variables from the config.
66 * @todo Separate the tile map server from the text-string to map tile server
67 * since they apparently use different URL conventions.
68 * We use OSM's current convention of "#map=zoom/lat/lon" and optional
69 * ?mlat=lat&mlon=lon for markers.
72 $tmsserver = Config::get('openstreetmap', 'tmsserver', OSM_TMS);
73 $nomserver = Config::get('openstreetmap', 'nomserver', OSM_NOM);
74 $zoom = Config::get('openstreetmap', 'zoom', OSM_ZOOM);
75 $marker = Config::get('openstreetmap', 'marker', OSM_MARKER);
77 // This is needed since we stored an empty string in the config in previous versions
78 if (empty($nomserver)) {
82 if ($item['coord'] != "") {
83 $coords = explode(' ', $item['coord']);
84 if (count($coords) > 1) {
85 $lat = urlencode(round($coords[0], 5));
86 $lon = urlencode(round($coords[1], 5));
89 $target .= '?mlat=' . $lat . '&mlon=' . $lon;
91 $target .= '#map='.intval($zoom).'/'.$lat.'/'.$lon;
96 $target = $nomserver.'?q='.urlencode($item['location']);
98 if ($item['location'] != "")
99 $title = $item['location'];
101 $title = $item['coord'];
103 $item['html'] = '<a target="map" title="'.$title.'" href= "'.$target.'">'.$title.'</a>';
106 function openstreetmap_get_coordinates($a, &$b)
108 $nomserver = Config::get('openstreetmap', 'nomserver', OSM_NOM);
110 // This is needed since we stored an empty string in the config in previous versions
111 if (empty($nomserver)) {
112 $nomserver = OSM_NOM;
115 $args = '?q=' . urlencode($b['location']) . '&format=json';
117 $cachekey = "openstreetmap:" . $b['location'];
118 $j = Cache::get($cachekey);
121 $x = Network::curl($nomserver . $args);
123 $j = json_decode($x['body'], true);
124 Cache::set($cachekey, $j, CACHE_MONTH);
128 if (!empty($j[0]['lat']) && !empty($j[0]['lon'])) {
129 $b['lat'] = $j[0]['lat'];
130 $b['lon'] = $j[0]['lon'];
134 function openstreetmap_generate_named_map(&$a, &$b)
136 openstreetmap_get_coordinates($a, $b);
138 if (!empty($b['lat']) && !empty($b['lon'])) {
139 openstreetmap_generate_map($a, $b);
143 function openstreetmap_generate_map(&$a, &$b)
145 $tmsserver = Config::get('openstreetmap', 'tmsserver', OSM_TMS);
147 if (strpos(z_root(), 'https:') !== false) {
148 $tmsserver = str_replace('http:','https:',$tmsserver);
151 $zoom = Config::get('openstreetmap', 'zoom', OSM_ZOOM);
152 $marker = Config::get('openstreetmap', 'marker', OSM_MARKER);
154 $lat = $b['lat']; // round($b['lat'], 5);
155 $lon = $b['lon']; // round($b['lon'], 5);
157 logger('lat: ' . $lat, LOGGER_DATA);
158 logger('lon: ' . $lon, LOGGER_DATA);
160 $cardlink = '<a href="' . $tmsserver;
163 $cardlink .= '?mlat=' . $lat . '&mlon=' . $lon;
166 $cardlink .= '#map=' . $zoom . '/' . $lat . '/' . $lon . '">' . ($b['location'] ? escape_tags($b['location']) : L10n::t('View Larger')) . '</a>';
167 if (empty($b['mode'])) {
168 $b['html'] = '<iframe style="width:100%; height:300px; border:1px solid #ccc" src="' . $tmsserver .
169 '/export/embed.html?bbox=' . ($lon - 0.01) . '%2C' . ($lat - 0.01) . '%2C' . ($lon + 0.01) . '%2C' . ($lat + 0.01) .
170 '&layer=mapnik&marker=' . $lat . '%2C' . $lon . '" style="border: 1px solid black"></iframe>' .
171 '<br/><small>' . $cardlink . '</small>';
173 $b['html'] .= '<br/>' . $cardlink;
176 logger('generate_map: ' . $b['html'], LOGGER_DATA);
179 function openstreetmap_addon_admin(&$a, &$o)
181 $t = get_markup_template("admin.tpl", "addon/openstreetmap/");
182 $tmsserver = Config::get('openstreetmap', 'tmsserver', OSM_TMS);
183 $nomserver = Config::get('openstreetmap', 'nomserver', OSM_NOM);
184 $zoom = Config::get('openstreetmap', 'zoom', OSM_ZOOM);
185 $marker = Config::get('openstreetmap', 'marker', OSM_MARKER);
187 // This is needed since we stored an empty string in the config in previous versions
188 if (empty($nomserver)) {
189 $nomserver = OSM_NOM;
192 $o = replace_macros($t, [
193 '$submit' => L10n::t('Submit'),
194 '$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>')],
195 '$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>')],
196 '$zoom' => ['zoom', L10n::t('Default zoom'), $zoom, L10n::t('The default zoom level. (1:world, 18:highest, also depends on tile server)')],
197 '$marker' => ['marker', L10n::t('Include marker on map'), $marker, L10n::t('Include a marker on the map.')],
201 function openstreetmap_addon_admin_post(&$a)
203 $urltms = defaults($_POST, 'tmsserver', OSM_TMS);
204 $urlnom = defaults($_POST, 'nomserver', OSM_NOM);
205 $zoom = defaults($_POST, 'zoom', OSM_ZOOM);
206 $marker = defaults($_POST, 'marker', OSM_MARKER);
208 Config::set('openstreetmap', 'tmsserver', $urltms);
209 Config::set('openstreetmap', 'nomserver', $urlnom);
210 Config::set('openstreetmap', 'zoom', $zoom);
211 Config::set('openstreetmap', 'marker', $marker);
213 info(L10n::t('Settings updated.') . EOL);