X-Git-Url: https://git.mxchange.org/?p=friendica-addons.git;a=blobdiff_plain;f=openstreetmap%2Fopenstreetmap.php;h=974be0a0a0c651488cb486526d324157f3d2f9a3;hp=e805632a51a1e6dbda32e2a3539b1a1965b4c142;hb=987b53c6e610b0ffbe4ec568f2c0e70122a2f8f1;hpb=1489253a95a49ec14a05cd1d5073edcc62cdd9d1 diff --git a/openstreetmap/openstreetmap.php b/openstreetmap/openstreetmap.php index e805632a..974be0a0 100644 --- a/openstreetmap/openstreetmap.php +++ b/openstreetmap/openstreetmap.php @@ -8,29 +8,42 @@ * Author: Klaus Weidenbach * */ - -require_once('include/cache.php'); - - -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'); +use Friendica\Core\Addon; +use Friendica\Core\Cache; +use Friendica\Core\Config; +use Friendica\Core\L10n; +use Friendica\Core\System; +use Friendica\Util\Network; + +const OSM_TMS = 'http://www.openstreetmap.org'; +const OSM_NOM = 'http://nominatim.openstreetmap.org/search.php'; +const OSM_ZOOM = 16; +const OSM_MARKER = 0; + +function openstreetmap_install() +{ + Addon::registerHook('render_location', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_location'); + Addon::registerHook('generate_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_map'); + Addon::registerHook('generate_named_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_named_map'); + Addon::registerHook('Map::getCoordinates', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_get_coordinates'); + Addon::registerHook('page_header', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_alterheader'); logger("installed openstreetmap"); } -function openstreetmap_uninstall() { - 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'); +function openstreetmap_uninstall() +{ + Addon::unregisterHook('render_location', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_location'); + Addon::unregisterHook('generate_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_map'); + Addon::unregisterHook('generate_named_map', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_generate_named_map'); + Addon::unregisterHook('Map::getCoordinates', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_get_coordinates'); + Addon::unregisterHook('page_header', 'addon/openstreetmap/openstreetmap.php', 'openstreetmap_alterheader'); logger("removed openstreetmap"); } -function openstreetmap_alterheader($a, &$navHtml) { +function openstreetmap_alterheader($a, &$navHtml) +{ $addScriptTag = '' . "\r\n"; $a->page['htmlhead'] .= $addScriptTag; } @@ -40,105 +53,107 @@ function openstreetmap_alterheader($a, &$navHtml) { * * 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; + } /* * Get the configuration variables from the config. - * @todo Separate the tile map server from the text-string to map tile server + * @todo Separate the tile map server from the text-string to map tile server * since they apparently use different URL conventions. * We use OSM's current convention of "#map=zoom/lat/lon" and optional * ?mlat=lat&mlon=lon for markers. */ - $tmsserver = get_config('openstreetmap', 'tmsserver'); - if(! $tmsserver) - $tmsserver = 'http://www.openstreetmap.org'; - - $nomserver = get_config('openstreetmap', 'nomserver'); - if(! $nomserver) - $nomserver = 'http://nominatim.openstreetmap.org/search.php'; - - $zoom = get_config('openstreetmap', 'zoom'); - if(! $zoom) - $zoom = 16; - - $marker = get_config('openstreetmap', 'marker'); - if(! $marker) - $marker = 0; - - $location = ''; - $coord = ''; + $tmsserver = Config::get('openstreetmap', 'tmsserver', OSM_TMS); + $nomserver = Config::get('openstreetmap', 'nomserver', OSM_NOM); + $zoom = Config::get('openstreetmap', 'zoom', OSM_ZOOM); + $marker = Config::get('openstreetmap', 'marker', OSM_MARKER); - $location = $item['location']; - - $location = (($location && (! $item['coord'])) ? '' . $item['location'] . '' : $location); + // This is needed since we stored an empty string in the config in previous versions + if (empty($nomserver)) { + $nomserver = OSM_NOM; + } - if($item['coord']) { + 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)); - $coord = 'Map'; + $target = $tmsserver; + if ($marker > 0) { + $target .= '?mlat=' . $lat . '&mlon=' . $lon; + } + $target .= '#map='.intval($zoom).'/'.$lat.'/'.$lon; } } - if(strlen($coord)) { - if($location) - $location .= ' (' . $coord . ')'; - else - $location = '' . $coord . ''; + + if ($target == "") { + $target = $nomserver.'?q='.urlencode($item['location']); } - $item['html'] = $location; -} + if ($item['location'] != "") { + $title = $item['location']; + } else { + $title = $item['coord']; + } + + $item['html'] = ''.$title.''; +} -function openstreetmap_generate_named_map(&$a,&$b) { +function openstreetmap_get_coordinates($a, &$b) +{ + $nomserver = 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; + } - $nomserver = get_config('openstreetmap', 'nomserver'); - if(! $nomserver) - $nomserver = 'http://nominatim.openstreetmap.org/search.php'; $args = '?q=' . urlencode($b['location']) . '&format=json'; - $x = z_fetch_url($nomserver . $args); - if($x['success']) { - $j = json_decode($x['body'],true); - - 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']; + $cachekey = "openstreetmap:" . $b['location']; + $j = Cache::get($cachekey); + + if (is_null($j)) { + $x = Network::curl($nomserver . $args); + if ($x['success']) { + $j = json_decode($x['body'], true); + Cache::set($cachekey, $j, CACHE_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) +{ + openstreetmap_get_coordinates($a, $b); - $tmsserver = get_config('openstreetmap', 'tmsserver'); - if(! $tmsserver) - $tmsserver = 'http://www.openstreetmap.org'; - if(strpos(z_root(),'https:') !== false) - $tmsserver = str_replace('http:','https:',$tmsserver); + if (!empty($b['lat']) && !empty($b['lon'])) { + openstreetmap_generate_map($a, $b); + } +} +function openstreetmap_generate_map(&$a, &$b) +{ + $tmsserver = Config::get('openstreetmap', 'tmsserver', OSM_TMS); - $zoom = get_config('openstreetmap', 'zoom'); - if(! $zoom) - $zoom = 16; + if (strpos(z_root(), 'https:') !== false) { + $tmsserver = str_replace('http:','https:',$tmsserver); + } - $marker = get_config('openstreetmap', 'marker'); - if(! $marker) - $marker = 0; + $zoom = Config::get('openstreetmap', 'zoom', OSM_ZOOM); + $marker = Config::get('openstreetmap', 'marker', OSM_MARKER); $lat = $b['lat']; // round($b['lat'], 5); $lon = $b['lon']; // round($b['lon'], 5); @@ -146,48 +161,58 @@ function openstreetmap_generate_map(&$a,&$b) { logger('lat: ' . $lat, LOGGER_DATA); logger('lon: ' . $lon, LOGGER_DATA); + $cardlink = '
' . (($b['location']) ? escape_tags($b['location']) : t('View Larger')) . ''; + $cardlink .= '#map=' . $zoom . '/' . $lat . '/' . $lon . '">' . ($b['location'] ? escape_tags($b['location']) : L10n::t('View Larger')) . ''; + if (empty($b['mode'])) { + $b['html'] = '' . + '
' . $cardlink . ''; + } else { + $b['html'] .= '
' . $cardlink; + } logger('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 = get_config('openstreetmap', 'tmsserver'); - if(! $tmsserver) - $tmsserver = 'http://www.openstreetmap.org'; - $nomserver = get_config('openstreetmap', 'nomserver'); - if(! $nomserver) - $nomserver = 'http://nominatim.openstreetmap.org/search.php'; - $zoom = get_config('openstreetmap', 'zoom'); - if(! $zoom) - $zoom = 16; - $marker = get_config('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 public tile servers')), - '$nomserver' => array('nomserver', t('Nominatim (reverse geocoding) Server URL'), $nomserver, t('A list of Nominatim servers')), - '$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.')), - )); -} -function openstreetmap_plugin_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'); - set_config('openstreetmap', 'tmsserver', $urltms); - set_config('openstreetmap', 'nomserver', $urlnom); - set_config('openstreetmap', 'zoom', $zoom); - set_config('openstreetmap', 'marker', $marker); - info( t('Settings updated.') . EOL); + $tmsserver = Config::get('openstreetmap', 'tmsserver', OSM_TMS); + $nomserver = Config::get('openstreetmap', 'nomserver', OSM_NOM); + $zoom = Config::get('openstreetmap', 'zoom', OSM_ZOOM); + $marker = 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 = replace_macros($t, [ + '$submit' => L10n::t('Submit'), + '$tmsserver' => ['tmsserver', L10n::t('Tile Server URL'), $tmsserver, L10n::t('A list of public tile servers')], + '$nomserver' => ['nomserver', L10n::t('Nominatim (reverse geocoding) Server URL'), $nomserver, L10n::t('A list of Nominatim servers')], + '$zoom' => ['zoom', L10n::t('Default zoom'), $zoom, L10n::t('The default zoom level. (1:world, 18:highest, also depends on tile server)')], + '$marker' => ['marker', L10n::t('Include marker on map'), $marker, L10n::t('Include a marker on the map.')], + ]); } +function openstreetmap_addon_admin_post(&$a) +{ + $urltms = defaults($_POST, 'tmsserver', OSM_TMS); + $urlnom = defaults($_POST, 'nomserver', OSM_NOM); + $zoom = defaults($_POST, 'zoom', OSM_ZOOM); + $marker = defaults($_POST, 'marker', OSM_MARKER); + Config::set('openstreetmap', 'tmsserver', $urltms); + Config::set('openstreetmap', 'nomserver', $urlnom); + Config::set('openstreetmap', 'zoom', $zoom); + Config::set('openstreetmap', 'marker', $marker); + + info(L10n::t('Settings updated.') . EOL); +}