2015-07-11 14:59:00 -04:00
< ? php
2013-02-11 12:49:19 -05:00
/**
2018-01-15 08:15:33 -05:00
* Name : Current Weather
2015-07-11 14:59:00 -04:00
* Description : Shows current weather conditions for user ' s location on their network page .
* Version : 1.1
2013-02-11 12:49:19 -05:00
* Author : Tony Baldwin < http :// friendica . tonybaldwin . info / u / t0ny >
* Author : Fabio Comuni < http :// kirkgroup . com / u / fabrixxm >
2015-07-11 14:59:00 -04:00
* Author : Tobias Diekershoff < https :// f . diekershoff . de / u / tobias >
2013-02-11 12:49:19 -05:00
*
*/
2015-07-11 14:59:00 -04:00
2018-01-22 14:03:11 -05:00
require_once 'include/text.php' ;
2015-07-13 10:21:43 -04:00
2018-07-24 20:18:59 -04:00
use Friendica\App ;
2018-01-16 19:51:12 -05:00
use Friendica\Core\Addon ;
2017-11-09 11:08:32 -05:00
use Friendica\Core\Cache ;
2017-11-06 18:55:24 -05:00
use Friendica\Core\Config ;
2018-01-22 14:03:11 -05:00
use Friendica\Core\L10n ;
2017-11-06 18:55:24 -05:00
use Friendica\Core\PConfig ;
2018-01-27 08:52:02 -05:00
use Friendica\Util\Network ;
2018-07-28 14:24:16 -04:00
use Friendica\Util\ProxyUtils ;
2017-11-06 18:55:24 -05:00
2018-07-24 20:18:59 -04:00
function curweather_install ()
{
Addon :: registerHook ( 'network_mod_init' , 'addon/curweather/curweather.php' , 'curweather_network_mod_init' );
Addon :: registerHook ( 'addon_settings' , 'addon/curweather/curweather.php' , 'curweather_addon_settings' );
Addon :: registerHook ( 'addon_settings_post' , 'addon/curweather/curweather.php' , 'curweather_addon_settings_post' );
}
function curweather_uninstall ()
{
Addon :: unregisterHook ( 'network_mod_init' , 'addon/curweather/curweather.php' , 'curweather_network_mod_init' );
Addon :: unregisterHook ( 'addon_settings' , 'addon/curweather/curweather.php' , 'curweather_addon_settings' );
Addon :: unregisterHook ( 'addon_settings_post' , 'addon/curweather/curweather.php' , 'curweather_addon_settings_post' );
}
2015-07-13 10:21:43 -04:00
// get the weather data from OpenWeatherMap
2018-07-24 20:18:59 -04:00
function getWeather ( $loc , $units = 'metric' , $lang = 'en' , $appid = '' , $cachetime = 0 )
{
$url = " http://api.openweathermap.org/data/2.5/weather?q= " . $loc . " &appid= " . $appid . " &lang= " . $lang . " &units= " . $units . " &mode=xml " ;
2018-07-23 17:06:09 -04:00
$cached = Cache :: get ( 'curweather' . md5 ( $url ));
$now = new DateTime ();
2018-07-24 20:18:59 -04:00
2018-07-23 17:06:09 -04:00
if ( ! is_null ( $cached )) {
$cdate = PConfig :: get ( local_user (), 'curweather' , 'last' );
$cached = unserialize ( $cached );
2018-07-24 20:18:59 -04:00
2018-07-23 17:06:09 -04:00
if ( $cdate + $cachetime > $now -> getTimestamp ()) {
return $cached ;
}
}
2018-07-24 20:18:59 -04:00
2018-07-23 17:06:09 -04:00
try {
$res = new SimpleXMLElement ( Network :: fetchUrl ( $url ));
} catch ( Exception $e ) {
2018-07-24 20:18:59 -04:00
if ( empty ( $_SESSION [ 'curweather_notice_shown' ])) {
2018-07-23 17:06:09 -04:00
info ( L10n :: t ( 'Error fetching weather data. Error was: ' . $e -> getMessage ()));
$_SESSION [ 'curweather_notice_shown' ] = true ;
}
2018-07-24 20:18:59 -04:00
2018-07-23 17:06:09 -04:00
return false ;
}
2018-07-24 20:18:59 -04:00
2018-07-23 17:06:09 -04:00
unset ( $_SESSION [ 'curweather_notice_shown' ]);
2018-07-24 20:18:59 -04:00
if (( string ) $res -> temperature [ 'unit' ] === 'metric' ) {
2018-07-23 17:06:09 -04:00
$tunit = '°C' ;
$wunit = 'm/s' ;
} else {
$tunit = '°F' ;
$wunit = 'mph' ;
}
2018-07-24 20:18:59 -04:00
if ( trim (( string ) $res -> weather [ 'value' ]) == trim (( string ) $res -> clouds [ 'name' ])) {
$desc = ( string ) $res -> clouds [ 'name' ];
2018-07-23 17:06:09 -04:00
} else {
2018-07-24 20:18:59 -04:00
$desc = ( string ) $res -> weather [ 'value' ] . ', ' . ( string ) $res -> clouds [ 'name' ];
2018-07-23 17:06:09 -04:00
}
2018-07-24 20:18:59 -04:00
2018-07-23 17:06:09 -04:00
$r = [
2018-07-24 20:18:59 -04:00
'city' => ( string ) $res -> city [ 'name' ][ 0 ],
'country' => ( string ) $res -> city -> country [ 0 ],
'lat' => ( string ) $res -> city -> coord [ 'lat' ],
'lon' => ( string ) $res -> city -> coord [ 'lon' ],
2018-07-23 17:06:09 -04:00
'temperature' => ( string ) $res -> temperature [ 'value' ][ 0 ] . $tunit ,
2018-07-24 20:18:59 -04:00
'pressure' => ( string ) $res -> pressure [ 'value' ] . ( string ) $res -> pressure [ 'unit' ],
'humidity' => ( string ) $res -> humidity [ 'value' ] . ( string ) $res -> humidity [ 'unit' ],
'descripion' => $desc ,
'wind' => ( string ) $res -> wind -> speed [ 'name' ] . ' (' . ( string ) $res -> wind -> speed [ 'value' ] . $wunit . ')' ,
'update' => ( string ) $res -> lastupdate [ 'value' ],
'icon' => ( string ) $res -> weather [ 'icon' ],
2018-07-23 17:06:09 -04:00
];
2018-07-24 20:18:59 -04:00
2018-07-23 17:06:09 -04:00
PConfig :: set ( local_user (), 'curweather' , 'last' , $now -> getTimestamp ());
Cache :: set ( 'curweather' . md5 ( $url ), serialize ( $r ), CACHE_HOUR );
2018-07-24 20:18:59 -04:00
2018-07-23 17:06:09 -04:00
return $r ;
2015-07-13 10:21:43 -04:00
}
2013-02-11 12:49:19 -05:00
2018-07-24 20:18:59 -04:00
function curweather_network_mod_init ( App $a , & $b )
2018-01-20 08:57:41 -05:00
{
2018-07-24 20:18:59 -04:00
if ( ! intval ( PConfig :: get ( local_user (), 'curweather' , 'curweather_enable' ))) {
2018-07-23 17:06:09 -04:00
return ;
2018-07-24 20:18:59 -04:00
}
2018-07-23 17:06:09 -04:00
2018-07-24 20:18:59 -04:00
$a -> page [ 'htmlhead' ] .= '<link rel="stylesheet" type="text/css" href="' . $a -> get_baseurl () . '/addon/curweather/curweather.css' . '" media="all" />' . " \r \n " ;
2018-07-23 17:06:09 -04:00
// $rpt value is needed for location
// $lang will be taken from the browser session to honour user settings
// TODO $lang does not work if the default settings are used
// and not all response strings are translated
// $units can be set in the settings by the user
// $appid is configured by the admin in the admin panel
// those parameters will be used to get: cloud status, temperature, preassure
// and relative humidity for display, also the relevent area of the map is
// linked from lat/log of the reply of OWMp
$rpt = PConfig :: get ( local_user (), 'curweather' , 'curweather_loc' );
2018-07-24 20:18:59 -04:00
// Set the language to the browsers language or default and use metric units
$lang = ( ! empty ( $_SESSION [ 'language' ]) ? $_SESSION [ 'language' ] : Config :: get ( 'system' , 'language' ));
2018-07-23 17:06:09 -04:00
$units = PConfig :: get ( local_user (), 'curweather' , 'curweather_units' );
2018-07-24 20:18:59 -04:00
$appid = Config :: get ( 'curweather' , 'appid' );
$cachetime = intval ( Config :: get ( 'curweather' , 'cachetime' ));
if ( $units === " " ) {
2018-07-23 17:06:09 -04:00
$units = 'metric' ;
2018-07-24 20:18:59 -04:00
}
2018-07-23 17:06:09 -04:00
$ok = true ;
$res = getWeather ( $rpt , $units , $lang , $appid , $cachetime );
2018-07-24 20:18:59 -04:00
if ( $res === false ) {
2018-07-23 17:06:09 -04:00
$ok = false ;
2018-07-24 20:18:59 -04:00
}
2018-07-23 17:06:09 -04:00
if ( $ok ) {
$t = get_markup_template ( " widget.tpl " , " addon/curweather/ " );
$curweather = replace_macros ( $t , [
'$title' => L10n :: t ( " Current Weather " ),
2018-07-28 14:24:16 -04:00
'$icon' => ProxyUtils :: proxifyUrl ( 'http://openweathermap.org/img/w/' . $res [ 'icon' ] . '.png' ),
2018-07-23 17:06:09 -04:00
'$city' => $res [ 'city' ],
'$lon' => $res [ 'lon' ],
'$lat' => $res [ 'lat' ],
'$description' => $res [ 'descripion' ],
'$temp' => $res [ 'temperature' ],
'$relhumidity' => [ 'caption' => L10n :: t ( 'Relative Humidity' ), 'val' => $res [ 'humidity' ]],
'$pressure' => [ 'caption' => L10n :: t ( 'Pressure' ), 'val' => $res [ 'pressure' ]],
'$wind' => [ 'caption' => L10n :: t ( 'Wind' ), 'val' => $res [ 'wind' ]],
'$lastupdate' => L10n :: t ( 'Last Updated' ) . ': ' . $res [ 'update' ] . 'UTC' ,
'$databy' => L10n :: t ( 'Data by' ),
'$showonmap' => L10n :: t ( 'Show on map' )
]);
} else {
$t = get_markup_template ( 'widget-error.tpl' , 'addon/curweather/' );
$curweather = replace_macros ( $t , [
'$problem' => L10n :: t ( 'There was a problem accessing the weather data. But have a look' ),
'$rpt' => $rpt ,
'$atOWM' => L10n :: t ( 'at OpenWeatherMap' )
]);
}
2018-07-24 20:18:59 -04:00
$a -> page [ 'aside' ] = $curweather . $a -> page [ 'aside' ];
2013-02-11 12:49:19 -05:00
}
2018-07-24 20:18:59 -04:00
function curweather_addon_settings_post ( App $a , $post )
{
if ( ! local_user () || empty ( $_POST [ 'curweather-settings-submit' ])) {
2018-07-23 17:06:09 -04:00
return ;
2018-07-24 20:18:59 -04:00
}
PConfig :: set ( local_user (), 'curweather' , 'curweather_loc' , trim ( $_POST [ 'curweather_loc' ]));
PConfig :: set ( local_user (), 'curweather' , 'curweather_enable' , intval ( $_POST [ 'curweather_enable' ]));
PConfig :: set ( local_user (), 'curweather' , 'curweather_units' , trim ( $_POST [ 'curweather_units' ]));
2018-07-23 17:06:09 -04:00
info ( L10n :: t ( 'Current Weather settings updated.' ) . EOL );
2013-02-11 12:49:19 -05:00
}
2018-07-24 20:18:59 -04:00
function curweather_addon_settings ( App $a , & $s )
{
if ( ! local_user ()) {
2018-07-23 17:06:09 -04:00
return ;
2018-07-24 20:18:59 -04:00
}
2018-07-23 17:06:09 -04:00
/* Get the current state of our config variable */
$curweather_loc = PConfig :: get ( local_user (), 'curweather' , 'curweather_loc' );
$curweather_units = PConfig :: get ( local_user (), 'curweather' , 'curweather_units' );
2018-07-24 20:18:59 -04:00
$appid = Config :: get ( 'curweather' , 'appid' );
if ( $appid == " " ) {
2018-07-23 17:06:09 -04:00
$noappidtext = L10n :: t ( 'No APPID found, please contact your admin to obtain one.' );
} else {
$noappidtext = '' ;
}
2018-07-24 20:18:59 -04:00
$enable = intval ( PConfig :: get ( local_user (), 'curweather' , 'curweather_enable' ));
2018-07-23 17:06:09 -04:00
$enable_checked = (( $enable ) ? ' checked="checked" ' : '' );
// load template and replace the macros
$t = get_markup_template ( " settings.tpl " , " addon/curweather/ " );
2018-07-24 20:18:59 -04:00
2018-07-23 17:06:09 -04:00
$s = replace_macros ( $t , [
'$submit' => L10n :: t ( 'Save Settings' ),
'$header' => L10n :: t ( 'Current Weather' ) . ' ' . L10n :: t ( 'Settings' ),
'$noappidtext' => $noappidtext ,
'$info' => L10n :: t ( 'Enter either the name of your location or the zip code.' ),
'$curweather_loc' => [ 'curweather_loc' , L10n :: t ( 'Your Location' ), $curweather_loc , L10n :: t ( 'Identifier of your location (name or zip code), e.g. <em>Berlin,DE</em> or <em>14476,DE</em>.' ) ],
'$curweather_units' => [ 'curweather_units' , L10n :: t ( 'Units' ), $curweather_units , L10n :: t ( 'select if the temperature should be displayed in °C or °F' ), [ 'metric' => '°C' , 'imperial' => '°F' ]],
'$enabled' => [ 'curweather_enable' , L10n :: t ( 'Show weather data' ), $enable , '' ]
]);
2018-07-24 20:18:59 -04:00
2018-07-23 17:06:09 -04:00
return ;
2013-02-11 12:49:19 -05:00
}
2018-07-20 15:58:53 -04:00
2015-07-11 14:59:00 -04:00
// Config stuff for the admin panel to let the admin of the node set a APPID
// for accessing the API of openweathermap
2018-07-24 20:18:59 -04:00
function curweather_addon_admin_post ( App $a )
{
if ( ! is_site_admin ()) {
2018-07-23 17:06:09 -04:00
return ;
2018-07-24 20:18:59 -04:00
}
if ( ! empty ( $_POST [ 'curweather-submit' ])) {
Config :: set ( 'curweather' , 'appid' , trim ( $_POST [ 'appid' ]));
Config :: set ( 'curweather' , 'cachetime' , trim ( $_POST [ 'cachetime' ]));
info ( L10n :: t ( 'Curweather settings saved.' . PHP_EOL ));
2018-07-23 17:06:09 -04:00
}
2015-07-11 14:59:00 -04:00
}
2018-07-20 15:58:53 -04:00
2018-07-24 20:18:59 -04:00
function curweather_addon_admin ( App $a , & $o )
{
if ( ! is_site_admin ()) {
2018-07-23 17:06:09 -04:00
return ;
2018-07-24 20:18:59 -04:00
}
$appid = Config :: get ( 'curweather' , 'appid' );
$cachetime = Config :: get ( 'curweather' , 'cachetime' );
2018-07-23 17:06:09 -04:00
$t = get_markup_template ( " admin.tpl " , " addon/curweather/ " );
2018-07-24 20:18:59 -04:00
$o = replace_macros ( $t , [
2018-07-23 17:06:09 -04:00
'$submit' => L10n :: t ( 'Save Settings' ),
'$cachetime' => [
2018-07-24 20:18:59 -04:00
'cachetime' ,
L10n :: t ( 'Caching Interval' ),
$cachetime ,
2018-07-23 17:06:09 -04:00
L10n :: t ( 'For how long should the weather data be cached? Choose according your OpenWeatherMap account type.' ), [
2018-07-24 20:18:59 -04:00
'0' => L10n :: t ( 'no cache' ),
'300' => '5 ' . L10n :: t ( 'minutes' ),
'900' => '15 ' . L10n :: t ( 'minutes' ),
'1800' => '30 ' . L10n :: t ( 'minutes' ),
'3600' => '60 ' . L10n :: t ( 'minutes' )
2018-07-23 17:06:09 -04:00
]
],
'$appid' => [ 'appid' , L10n :: t ( 'Your APPID' ), $appid , L10n :: t ( 'Your API key provided by OpenWeatherMap' )]
]);
2015-07-11 14:59:00 -04:00
}