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