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