2012-02-10 03:10:12 +01:00
< ? php
/**
2012-02-19 14:28:43 +01:00
* Name : OpenStreetMap
2015-05-15 20:27:32 +02:00
* Description : Use OpenStreetMap for displaying locations . After activation the post location just beneath your avatar in your posts will link to OpenStreetMap .
* Version : 1.3 . 1
* Author : Fabio < http :// kirgroup . com /~ fabrixxm >
2012-02-10 03:10:12 +01:00
* Author : Mike Macgirvin < http :// macgirvin . com / profile / mike >
2012-02-19 14:28:43 +01:00
* Author : Klaus Weidenbach
2012-02-10 03:10:12 +01:00
*
*/
2019-02-03 22:22:03 +01:00
2021-10-23 10:49:26 +02:00
use Friendica\Core\Cache\Enum\Duration ;
2018-12-26 08:28:16 +01:00
use Friendica\Core\Hook ;
2018-10-30 00:40:18 +01:00
use Friendica\Core\Logger ;
2018-10-31 15:55:15 +01:00
use Friendica\Core\Renderer ;
2020-03-04 22:07:04 +01:00
use Friendica\DI ;
2023-01-01 20:21:56 +01:00
use Friendica\Core\Config\Util\ConfigFileManager ;
2018-11-08 17:45:19 +01:00
use Friendica\Util\Strings ;
2012-02-10 03:10:12 +01:00
2018-06-28 05:18:19 +02:00
const OSM_TMS = 'https://www.openstreetmap.org' ;
const OSM_NOM = 'https://nominatim.openstreetmap.org/search.php' ;
2018-03-20 07:43:03 +01:00
const OSM_ZOOM = 16 ;
const OSM_MARKER = 0 ;
2017-11-09 17:08:32 +01:00
function openstreetmap_install ()
{
2018-12-26 08:28:16 +01:00
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' );
2012-02-10 03:10:12 +01:00
2021-10-21 08:04:27 +02:00
Logger :: notice ( " installed openstreetmap " );
2012-02-10 03:10:12 +01:00
}
2023-01-14 03:16:09 +01:00
function openstreetmap_load_config ( ConfigFileManager $loader )
2018-06-28 05:18:19 +02:00
{
2024-12-11 22:47:10 +01:00
DI :: appHelper () -> getConfigCache () -> load ( $loader -> loadAddonConfig ( 'openstreetmap' ), \Friendica\Core\Config\ValueObject\Cache :: SOURCE_STATIC );
2018-06-28 05:18:19 +02:00
}
2023-01-14 03:16:09 +01:00
function openstreetmap_alterheader ( & $navHtml )
2017-11-09 17:08:32 +01:00
{
2023-02-18 20:57:09 +01:00
$addScriptTag = '<script type="text/javascript" src="' . DI :: baseUrl () . '/addon/openstreetmap/openstreetmap.js"></script>' . " \r \n " ;
2019-12-30 21:53:43 +01:00
DI :: page ()[ 'htmlhead' ] .= $addScriptTag ;
2013-01-09 00:41:27 +01:00
}
2012-02-10 03:10:12 +01:00
2015-05-15 20:27:32 +02:00
/**
* @ brief Add link to a map for an item ' s set location / coordinates .
*
* 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 .
2018-01-15 14:15:33 +01:00
*
2015-05-15 20:27:32 +02:00
* @ param array & $item
*/
2023-01-14 03:16:09 +01:00
function openstreetmap_location ( array & $item )
2018-03-20 07:43:03 +01:00
{
if ( ! ( strlen ( $item [ 'location' ]) || strlen ( $item [ 'coord' ]))) {
2013-01-09 00:41:27 +01:00
return ;
2017-11-09 17:08:32 +01:00
}
2012-02-10 04:53:56 +01:00
2012-02-19 14:28:43 +01:00
/*
2015-05-15 20:27:32 +02:00
* Get the configuration variables from the config .
2015-06-30 07:31:27 +02:00
* @ todo Separate the tile map server from the text - string to map tile server
2015-05-15 20:27:32 +02:00
* 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 .
*/
2020-01-19 21:21:12 +01:00
$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 );
2012-02-19 14:28:43 +01:00
2018-03-20 07:43:03 +01:00
// This is needed since we stored an empty string in the config in previous versions
if ( empty ( $nomserver )) {
$nomserver = OSM_NOM ;
2017-11-09 17:08:32 +01:00
}
2014-05-29 12:42:25 +02:00
2022-06-30 13:32:13 +02:00
if ( $item [ 'coord' ] != '' ) {
2012-02-10 03:10:12 +01:00
$coords = explode ( ' ' , $item [ 'coord' ]);
2022-09-08 06:16:17 +02:00
if (( count ( $coords ) > 1 ) && is_numeric ( $coords [ 0 ]) && is_numeric ( $coords [ 1 ])) {
2015-05-15 20:27:32 +02:00
$lat = urlencode ( round ( $coords [ 0 ], 5 ));
$lon = urlencode ( round ( $coords [ 1 ], 5 ));
2015-06-30 07:31:27 +02:00
$target = $tmsserver ;
2018-03-20 07:43:03 +01:00
if ( $marker > 0 ) {
$target .= '?mlat=' . $lat . '&mlon=' . $lon ;
}
2015-06-30 07:31:27 +02:00
$target .= '#map=' . intval ( $zoom ) . '/' . $lat . '/' . $lon ;
2012-02-10 03:10:12 +01:00
}
}
2015-06-30 07:31:27 +02:00
2018-07-10 14:30:23 +02:00
if ( empty ( $target )) {
2015-06-30 07:31:27 +02:00
$target = $nomserver . '?q=' . urlencode ( $item [ 'location' ]);
2017-11-09 17:08:32 +01:00
}
2015-06-30 07:31:27 +02:00
2022-06-30 13:32:13 +02:00
if ( $item [ 'location' ] != '' ) {
2015-06-30 07:31:27 +02:00
$title = $item [ 'location' ];
2017-11-09 17:08:32 +01:00
} else {
2015-06-30 07:31:27 +02:00
$title = $item [ 'coord' ];
2017-11-09 17:08:32 +01:00
}
2015-06-30 07:31:27 +02:00
2022-06-30 13:32:13 +02:00
$item [ 'html' ] = '<a target="map" title="' . $title . '" href= "' . $target . '">' . $title . '</a>' ;
2012-02-10 03:10:12 +01:00
}
2023-01-14 03:16:09 +01:00
function openstreetmap_get_coordinates ( array & $b )
2017-11-09 17:08:32 +01:00
{
2020-01-19 21:21:12 +01:00
$nomserver = DI :: config () -> get ( 'openstreetmap' , 'nomserver' , OSM_NOM );
2018-03-20 07:43:03 +01:00
// This is needed since we stored an empty string in the config in previous versions
if ( empty ( $nomserver )) {
$nomserver = OSM_NOM ;
}
2015-05-15 20:27:32 +02:00
$args = '?q=' . urlencode ( $b [ 'location' ]) . '&format=json' ;
2022-06-30 13:32:13 +02:00
$cachekey = 'openstreetmap:' . $b [ 'location' ];
2020-01-12 15:36:43 +01:00
$j = DI :: cache () -> get ( $cachekey );
2015-06-30 07:31:27 +02:00
2018-03-20 07:43:03 +01:00
if ( is_null ( $j )) {
2021-08-25 21:54:54 +02:00
$curlResult = DI :: httpClient () -> get ( $nomserver . $args );
2018-10-11 07:40:57 +02:00
if ( $curlResult -> isSuccess ()) {
2024-01-12 07:16:01 +01:00
$j = json_decode ( $curlResult -> getBodyString (), true );
2020-01-18 15:41:18 +01:00
DI :: cache () -> set ( $cachekey , $j , Duration :: MONTH );
2015-05-15 20:27:32 +02:00
}
}
2018-03-20 07:43:03 +01:00
if ( ! empty ( $j [ 0 ][ 'lat' ]) && ! empty ( $j [ 0 ][ 'lon' ])) {
$b [ 'lat' ] = $j [ 0 ][ 'lat' ];
$b [ 'lon' ] = $j [ 0 ][ 'lon' ];
}
2015-05-15 20:27:32 +02:00
}
2023-01-14 03:16:09 +01:00
function openstreetmap_generate_named_map ( array & $b )
2017-11-09 17:08:32 +01:00
{
2023-01-14 03:16:09 +01:00
openstreetmap_get_coordinates ( $b );
2018-03-20 07:43:03 +01:00
if ( ! empty ( $b [ 'lat' ]) && ! empty ( $b [ 'lon' ])) {
2023-01-14 03:16:09 +01:00
openstreetmap_generate_map ( $b );
2017-11-09 17:08:32 +01:00
}
2018-03-20 07:43:03 +01:00
}
2015-05-15 20:27:32 +02:00
2023-01-14 03:16:09 +01:00
function openstreetmap_generate_map ( array & $b )
2018-03-20 07:43:03 +01:00
{
2020-01-19 21:21:12 +01:00
$tmsserver = DI :: config () -> get ( 'openstreetmap' , 'tmsserver' , OSM_TMS );
2015-05-15 20:27:32 +02:00
2023-02-18 20:57:09 +01:00
if ( strpos ( DI :: baseUrl (), 'https:' ) !== false ) {
2018-03-20 07:43:03 +01:00
$tmsserver = str_replace ( 'http:' , 'https:' , $tmsserver );
2017-11-09 17:08:32 +01:00
}
2015-05-15 20:27:32 +02:00
2020-01-19 21:21:12 +01:00
$zoom = DI :: config () -> get ( 'openstreetmap' , 'zoom' , OSM_ZOOM );
$marker = DI :: config () -> get ( 'openstreetmap' , 'marker' , OSM_MARKER );
2015-05-15 20:27:32 +02:00
$lat = $b [ 'lat' ]; // round($b['lat'], 5);
$lon = $b [ 'lon' ]; // round($b['lon'], 5);
2021-10-21 08:04:27 +02:00
Logger :: debug ( 'lat: ' . $lat );
Logger :: debug ( 'lon: ' . $lon );
2015-05-15 20:27:32 +02:00
2018-03-20 07:43:03 +01:00
$cardlink = '<a href="' . $tmsserver ;
2015-05-15 20:27:32 +02:00
2018-03-20 07:43:03 +01:00
if ( $marker > 0 ) {
$cardlink .= '?mlat=' . $lat . '&mlon=' . $lon ;
}
2012-02-19 23:26:41 +01:00
2021-05-31 07:44:17 +02:00
$cardlink .= '#map=' . $zoom . '/' . $lat . '/' . $lon . '">' . ( $b [ 'location' ] ? ? 0 ? Strings :: escapeHtml ( $b [ 'location' ]) : DI :: l10n () -> t ( 'View Larger' )) . '</a>' ;
2018-03-20 07:43:03 +01:00
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 ;
}
2015-05-15 20:27:32 +02:00
2021-10-21 08:04:27 +02:00
Logger :: debug ( 'generate_map: ' . $b [ 'html' ]);
2015-05-15 20:27:32 +02:00
}
2023-01-14 03:16:09 +01:00
function openstreetmap_addon_admin ( string & $o )
2017-11-09 17:08:32 +01:00
{
2022-06-30 13:32:13 +02:00
$t = Renderer :: getMarkupTemplate ( 'admin.tpl' , 'addon/openstreetmap/' );
2020-01-19 21:21:12 +01:00
$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 );
2018-03-20 07:43:03 +01:00
// This is needed since we stored an empty string in the config in previous versions
if ( empty ( $nomserver )) {
$nomserver = OSM_NOM ;
2017-11-09 17:08:32 +01:00
}
2015-05-15 20:27:32 +02:00
2018-10-31 15:55:15 +01:00
$o = Renderer :: replaceMacros ( $t , [
2020-01-18 20:52:33 +01:00
'$submit' => DI :: l10n () -> t ( 'Submit' ),
2020-02-25 02:08:43 +01:00
'$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>' )],
2020-01-18 20:52:33 +01:00
'$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.' )],
2018-01-15 14:15:33 +01:00
]);
2012-02-19 14:28:43 +01:00
}
2017-11-09 17:08:32 +01:00
2023-01-14 03:16:09 +01:00
function openstreetmap_addon_admin_post ()
2017-11-09 17:08:32 +01:00
{
2022-06-30 13:32:13 +02:00
DI :: config () -> set ( 'openstreetmap' , 'tmsserver' , ( $_POST [ 'tmsserver' ] ? ? '' ) ? : OSM_TMS );
DI :: config () -> set ( 'openstreetmap' , 'nomserver' , ( $_POST [ 'nomserver' ] ? ? '' ) ? : OSM_NOM );
DI :: config () -> set ( 'openstreetmap' , 'zoom' , ( $_POST [ 'zoom' ] ? ? '' ) ? : OSM_ZOOM );
DI :: config () -> set ( 'openstreetmap' , 'marker' , ( $_POST [ 'marker' ] ? ? '' ) ? : OSM_MARKER );
2012-02-19 14:28:43 +01:00
}