* Author: Klaus Weidenbach
*
*/
-
-use Friendica\Core\Cache;
-use Friendica\Core\Config;
+use Friendica\Core\Cache\Duration;
+use Friendica\Core\Hook;
+use Friendica\Core\Logger;
+use Friendica\Core\Renderer;
+use Friendica\DI;
+use Friendica\Util\ConfigFileLoader;
+use Friendica\Util\Strings;
+
+const OSM_TMS = 'https://www.openstreetmap.org';
+const OSM_NOM = 'https://nominatim.openstreetmap.org/search.php';
+const OSM_ZOOM = 16;
+const OSM_MARKER = 0;
function openstreetmap_install()
{
- register_hook('render_location', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_location');
- register_hook('generate_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_map');
- register_hook('generate_named_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_named_map');
- register_hook('page_header', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_alterheader');
-
- logger("installed openstreetmap");
+ Hook::register('load_config', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_load_config');
+ Hook::register('render_location', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_location');
+ Hook::register('generate_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_map');
+ Hook::register('generate_named_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_named_map');
+ Hook::register('Map::getCoordinates', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_get_coordinates');
+ Hook::register('page_header', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_alterheader');
+
+ Logger::log("installed openstreetmap");
}
-function openstreetmap_uninstall()
+function openstreetmap_load_config(\Friendica\App $a, ConfigFileLoader $loader)
{
- unregister_hook('render_location', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_location');
- unregister_hook('generate_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_map');
- unregister_hook('generate_named_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_named_map');
- unregister_hook('page_header', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_alterheader');
-
- logger("removed openstreetmap");
+ $a->getConfigCache()->load($loader->loadAddonConfig('openstreetmap'));
}
function openstreetmap_alterheader($a, &$navHtml)
{
- $addScriptTag = '<script type="text/javascript" src="' . $a->get_baseurl() . '/addon/openstreetmap/openstreetmap.js"></script>' . "\r\n";
- $a->page['htmlhead'] .= $addScriptTag;
+ $addScriptTag = '<script type="text/javascript" src="' . DI::baseUrl()->get() . '/addon/openstreetmap/openstreetmap.js"></script>' . "\r\n";
+ DI::page()['htmlhead'] .= $addScriptTag;
}
/**
*
* If an item has coordinates add link to a tile map server, e.g. openstreetmap.org.
* If an item has a location open it with the help of OSM's Nominatim reverse geocode search.
- *
+ *
* @param mixed $a
* @param array& $item
*/
-function openstreetmap_location($a, &$item) {
-
- if(! (strlen($item['location']) || strlen($item['coord']))) {
+function openstreetmap_location($a, &$item)
+{
+ if (!(strlen($item['location']) || strlen($item['coord']))) {
return;
}
* ?mlat=lat&mlon=lon for markers.
*/
- $tmsserver = Config::get('openstreetmap', 'tmsserver');
- if(! $tmsserver) {
- $tmsserver = 'http://www.openstreetmap.org';
- }
+ $tmsserver = DI::config()->get('openstreetmap', 'tmsserver', OSM_TMS);
+ $nomserver = DI::config()->get('openstreetmap', 'nomserver', OSM_NOM);
+ $zoom = DI::config()->get('openstreetmap', 'zoom', OSM_ZOOM);
+ $marker = DI::config()->get('openstreetmap', 'marker', OSM_MARKER);
- $nomserver = Config::get('openstreetmap', 'nomserver');
- if(! $nomserver) {
- $nomserver = 'http://nominatim.openstreetmap.org/search.php';
- }
-
- $zoom = Config::get('openstreetmap', 'zoom');
- if(! $zoom) {
- $zoom = 16;
- }
-
- $marker = Config::get('openstreetmap', 'marker');
- if(! $marker) {
- $marker = 0;
+ // This is needed since we stored an empty string in the config in previous versions
+ if (empty($nomserver)) {
+ $nomserver = OSM_NOM;
}
if ($item['coord'] != "") {
$coords = explode(' ', $item['coord']);
- if(count($coords) > 1) {
+ if (count($coords) > 1) {
$lat = urlencode(round($coords[0], 5));
$lon = urlencode(round($coords[1], 5));
$target = $tmsserver;
- if($marker > 0)
- $target .= '?mlat='.$lat.'&mlon='.$lon;
+ if ($marker > 0) {
+ $target .= '?mlat=' . $lat . '&mlon=' . $lon;
+ }
$target .= '#map='.intval($zoom).'/'.$lat.'/'.$lon;
}
}
- if ($target == "") {
+ if (empty($target)) {
$target = $nomserver.'?q='.urlencode($item['location']);
}
$item['html'] = '<a target="map" title="'.$title.'" href= "'.$target.'">'.$title.'</a>';
}
-
-function openstreetmap_generate_named_map(&$a, &$b)
+function openstreetmap_get_coordinates($a, &$b)
{
- $nomserver = Config::get('openstreetmap', 'nomserver');
- if(! $nomserver)
- $nomserver = 'http://nominatim.openstreetmap.org/search.php';
+ $nomserver = DI::config()->get('openstreetmap', 'nomserver', OSM_NOM);
+
+ // This is needed since we stored an empty string in the config in previous versions
+ if (empty($nomserver)) {
+ $nomserver = OSM_NOM;
+ }
+
$args = '?q=' . urlencode($b['location']) . '&format=json';
- $x = z_fetch_url($nomserver . $args);
- if($x['success']) {
- $j = json_decode($x['body'],true);
+ $cachekey = "openstreetmap:" . $b['location'];
+ $j = DI::cache()->get($cachekey);
- if($j && is_array($j) && $j[0]['lat'] && $j[0]['lon']) {
- $arr = array('lat' => $j[0]['lat'],'lon' => $j[0]['lon'],'location' => $b['location'], 'html' => '');
- openstreetmap_generate_map($a,$arr);
- $b['html'] = $arr['html'];
+ if (is_null($j)) {
+ $curlResult = DI::httpRequest()->get($nomserver . $args);
+ if ($curlResult->isSuccess()) {
+ $j = json_decode($curlResult->getBody(), true);
+ DI::cache()->set($cachekey, $j, Duration::MONTH);
}
}
+
+ if (!empty($j[0]['lat']) && !empty($j[0]['lon'])) {
+ $b['lat'] = $j[0]['lat'];
+ $b['lon'] = $j[0]['lon'];
+ }
}
-function openstreetmap_generate_map(&$a, &$b)
+function openstreetmap_generate_named_map(&$a, &$b)
{
- $tmsserver = Config::get('openstreetmap', 'tmsserver');
- if(! $tmsserver) {
- $tmsserver = 'http://www.openstreetmap.org';
- }
- if(strpos(z_root(),'https:') !== false) {
- $tmsserver = str_replace('http:','https:',$tmsserver);
+ openstreetmap_get_coordinates($a, $b);
+
+ if (!empty($b['lat']) && !empty($b['lon'])) {
+ openstreetmap_generate_map($a, $b);
}
+}
+function openstreetmap_generate_map(&$a, &$b)
+{
+ $tmsserver = DI::config()->get('openstreetmap', 'tmsserver', OSM_TMS);
- $zoom = Config::get('openstreetmap', 'zoom');
- if(! $zoom) {
- $zoom = 16;
+ if (strpos(DI::baseUrl()->get(true), 'https:') !== false) {
+ $tmsserver = str_replace('http:','https:',$tmsserver);
}
- $marker = Config::get('openstreetmap', 'marker');
- if(! $marker) {
- $marker = 0;
- }
+ $zoom = DI::config()->get('openstreetmap', 'zoom', OSM_ZOOM);
+ $marker = DI::config()->get('openstreetmap', 'marker', OSM_MARKER);
$lat = $b['lat']; // round($b['lat'], 5);
$lon = $b['lon']; // round($b['lon'], 5);
- logger('lat: ' . $lat, LOGGER_DATA);
- logger('lon: ' . $lon, LOGGER_DATA);
+ Logger::log('lat: ' . $lat, Logger::DATA);
+ Logger::log('lon: ' . $lon, Logger::DATA);
+ $cardlink = '<a href="' . $tmsserver;
- $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) ;
-
- $b['html'] .= '&layer=mapnik&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>';
+ if ($marker > 0) {
+ $cardlink .= '?mlat=' . $lat . '&mlon=' . $lon;
+ }
- logger('generate_map: ' . $b['html'], LOGGER_DATA);
+ $cardlink .= '#map=' . $zoom . '/' . $lat . '/' . $lon . '">' . ($b['location'] ? Strings::escapeHtml($b['location']) : DI::l10n()->t('View Larger')) . '</a>';
+ if (empty($b['mode'])) {
+ $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) .
+ '&layer=mapnik&marker=' . $lat . '%2C' . $lon . '" style="border: 1px solid black"></iframe>' .
+ '<br/><small>' . $cardlink . '</small>';
+ } else {
+ $b['html'] .= '<br/>' . $cardlink;
+ }
+ Logger::log('generate_map: ' . $b['html'], Logger::DATA);
}
-function openstreetmap_plugin_admin(&$a, &$o)
+function openstreetmap_addon_admin(&$a, &$o)
{
- $t = get_markup_template("admin.tpl", "addon/openstreetmap/");
- $tmsserver = Config::get('openstreetmap', 'tmsserver');
- if(! $tmsserver) {
- $tmsserver = 'http://www.openstreetmap.org';
- }
- $nomserver = Config::get('openstreetmap', 'nomserver');
- if(! $nomserver) {
- $nomserver = 'http://nominatim.openstreetmap.org/search.php';
- }
- $zoom = Config::get('openstreetmap', 'zoom');
- if(! $zoom) {
- $zoom = 16;
- }
- $marker = Config::get('openstreetmap', 'marker');
- if(! $marker) {
- $marker = 0;
- }
-
- $o = replace_macros($t, array(
- '$submit' => t('Submit'),
- '$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>')),
- '$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>')),
- '$zoom' => array('zoom', t('Default zoom'), $zoom, t('The default zoom level. (1:world, 18:highest, also depends on tile server)')),
- '$marker' => array('marker', t('Include marker on map'), $marker, t('Include a marker on the map.')),
- ));
+ $t = Renderer::getMarkupTemplate("admin.tpl", "addon/openstreetmap/");
+ $tmsserver = DI::config()->get('openstreetmap', 'tmsserver', OSM_TMS);
+ $nomserver = DI::config()->get('openstreetmap', 'nomserver', OSM_NOM);
+ $zoom = DI::config()->get('openstreetmap', 'zoom', OSM_ZOOM);
+ $marker = DI::config()->get('openstreetmap', 'marker', OSM_MARKER);
+
+ // This is needed since we stored an empty string in the config in previous versions
+ if (empty($nomserver)) {
+ $nomserver = OSM_NOM;
+ }
+
+ $o = Renderer::replaceMacros($t, [
+ '$submit' => DI::l10n()->t('Submit'),
+ '$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>')],
+ '$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>')],
+ '$zoom' => ['zoom', DI::l10n()->t('Default zoom'), $zoom, DI::l10n()->t('The default zoom level. (1:world, 18:highest, also depends on tile server)')],
+ '$marker' => ['marker', DI::l10n()->t('Include marker on map'), $marker, DI::l10n()->t('Include a marker on the map.')],
+ ]);
}
-function openstreetmap_plugin_admin_post(&$a)
+function openstreetmap_addon_admin_post(&$a)
{
- $urltms = ((x($_POST, 'tmsserver')) ? notags(trim($_POST['tmsserver'])) : '');
- $urlnom = ((x($_POST, 'nomserver')) ? notags(trim($_POST['nomserver'])) : '');
- $zoom = ((x($_POST, 'zoom')) ? intval(trim($_POST['zoom'])) : '16');
- $marker = ((x($_POST, 'marker')) ? intval(trim($_POST['marker'])) : '0');
- Config::set('openstreetmap', 'tmsserver', $urltms);
- Config::set('openstreetmap', 'nomserver', $urlnom);
- Config::set('openstreetmap', 'zoom', $zoom);
- Config::set('openstreetmap', 'marker', $marker);
- info( t('Settings updated.') . EOL);
+ $urltms = ($_POST['tmsserver'] ?? '') ?: OSM_TMS;
+ $urlnom = ($_POST['nomserver'] ?? '') ?: OSM_NOM;
+ $zoom = ($_POST['zoom'] ?? '') ?: OSM_ZOOM;
+ $marker = ($_POST['marker'] ?? '') ?: OSM_MARKER;
+
+ DI::config()->set('openstreetmap', 'tmsserver', $urltms);
+ DI::config()->set('openstreetmap', 'nomserver', $urlnom);
+ DI::config()->set('openstreetmap', 'zoom', $zoom);
+ DI::config()->set('openstreetmap', 'marker', $marker);
}