X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=curweather%2Fcurweather.php;h=303fbbf942116290586c6d92c8e4e5044893b2c0;hb=c4c2536052614d3bdaf8e3ed88cc99f38e476dae;hp=bd0d6c7507dcdedc33e1b352d69ed9943acb1ca1;hpb=72f23f7b5236bdfc1d8c1b878ca22261ae8e55dd;p=friendica-addons.git diff --git a/curweather/curweather.php b/curweather/curweather.php index bd0d6c75..303fbbf9 100644 --- a/curweather/curweather.php +++ b/curweather/curweather.php @@ -1,108 +1,244 @@ - Find the location code for the station or airport nearest you here. - * Version: 1.0 + * Name: Current Weather + * Description: Shows current weather conditions for user's location on their network page. + * Version: 1.2 * Author: Tony Baldwin * Author: Fabio Comuni + * Author: Tobias Diekershoff * */ -require_once('addon/curweather/getweather.php'); - -function curweather_install() { - register_hook('network_mod_init', 'addon/curweather/curweather.php', 'curweather_network_mod_init'); - register_hook('plugin_settings', 'addon/curweather/curweather.php', 'curweather_plugin_settings'); - register_hook('plugin_settings_post', 'addon/curweather/curweather.php', 'curweather_plugin_settings_post'); +use Friendica\App; +use Friendica\Core\Cache\Duration; +use Friendica\Core\Hook; +use Friendica\Core\Renderer; +use Friendica\Core\Session; +use Friendica\DI; +use Friendica\Util\Proxy as ProxyUtils; + +function curweather_install() +{ + Hook::register('network_mod_init' , 'addon/curweather/curweather.php', 'curweather_network_mod_init'); + Hook::register('addon_settings' , 'addon/curweather/curweather.php', 'curweather_addon_settings'); + Hook::register('addon_settings_post', 'addon/curweather/curweather.php', 'curweather_addon_settings_post'); } -function curweather_uninstall() { - unregister_hook('network_mod_init', 'addon/curweather/curweather.php', 'curweather_network_mod_init'); - unregister_hook('plugin_settings', 'addon/curweather/curweather.php', 'curweather_plugin_settings'); - unregister_hook('plugin_settings_post', 'addon/curweather/curweather.php', 'curweather_plugin_settings_post'); - +// get the weather data from OpenWeatherMap +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"; + $cached = DI::cache()->get('curweather'.md5($url)); + $now = new DateTime(); + + if (!is_null($cached)) { + $cdate = DI::pConfig()->get(local_user(), 'curweather', 'last'); + $cached = unserialize($cached); + + if ($cdate + $cachetime > $now->getTimestamp()) { + return $cached; + } + } + + try { + $res = new SimpleXMLElement(DI::httpClient()->fetch($url)); + } catch (Exception $e) { + if (empty($_SESSION['curweather_notice_shown'])) { + notice(DI::l10n()->t('Error fetching weather data. Error was: ' . $e->getMessage())); + $_SESSION['curweather_notice_shown'] = true; + } + + return false; + } + + unset($_SESSION['curweather_notice_shown']); + + if (in_array((string) $res->temperature['unit'], ['celsius', 'metric'])) { + $tunit = '°C'; + $wunit = 'm/s'; + } else { + $tunit = '°F'; + $wunit = 'mph'; + } + + if (trim((string) $res->weather['value']) == trim((string) $res->clouds['name'])) { + $desc = (string) $res->clouds['name']; + } else { + $desc = (string) $res->weather['value'] . ', ' . (string) $res->clouds['name']; + } + + $r = [ + 'city' => (string) $res->city['name'][0], + 'country' => (string) $res->city->country[0], + 'lat' => (string) $res->city->coord['lat'], + 'lon' => (string) $res->city->coord['lon'], + 'temperature' => (string) $res->temperature['value'][0].$tunit, + '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'], + ]; + + DI::pConfig()->set(local_user(), 'curweather', 'last', $now->getTimestamp()); + DI::cache()->set('curweather'.md5($url), serialize($r), Duration::HOUR); + + return $r; } - -function curweather_network_mod_init(&$fk_app,&$b) { - - if(! intval(get_pconfig(local_user(),'curweather','curweather_enable'))) - return; - - $fk_app->page['htmlhead'] .= '' . "\r\n"; - - // the getweather file does all the work here - // the $rpt value is needed for location - // which getweather uses to fetch the weather data for weather and temp - $rpt = get_pconfig(local_user(), 'curweather', 'curweather_loc'); - $wxdata = GetWeather::get($rpt); - $temp = $wxdata['TEMPERATURE_STRING']; - $weather = $wxdata['WEATHER']; - $rhumid = $wxdata['RELATIVE_HUMIDITY']; - $pressure = $wxdata['PRESSURE_STRING']; - $wind = $wxdata['WIND_STRING']; - $curweather = '
-
-

'.t("Current Weather").'

'; - - $curweather .= "Weather: $weather
- Temperature: $temp
- Relative Humidity: $rhumid
- Pressure: $pressure
- Wind: $wind"; - - $curweather .= '
'; - - $fk_app->page['aside'] = $curweather.$fk_app->page['aside']; - +function curweather_network_mod_init(App $a, &$b) +{ + if (!intval(DI::pConfig()->get(local_user(), 'curweather', 'curweather_enable'))) { + return; + } + + DI::page()['htmlhead'] .= '' . "\r\n"; + + // $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 = DI::pConfig()->get(local_user(), 'curweather', 'curweather_loc'); + + // Set the language to the browsers language or default and use metric units + $lang = Session::get('language', DI::config()->get('system', 'language')); + $units = DI::pConfig()->get( local_user(), 'curweather', 'curweather_units'); + $appid = DI::config()->get('curweather', 'appid'); + $cachetime = intval(DI::config()->get('curweather', 'cachetime')); + + if ($units === "") { + $units = 'metric'; + } + + $ok = true; + + $res = getWeather($rpt, $units, $lang, $appid, $cachetime); + + if ($res === false) { + $ok = false; + } + + if ($ok) { + $t = Renderer::getMarkupTemplate("widget.tpl", "addon/curweather/" ); + $curweather = Renderer::replaceMacros($t, [ + '$title' => DI::l10n()->t("Current Weather"), + '$icon' => ProxyUtils::proxifyUrl('http://openweathermap.org/img/w/'.$res['icon'].'.png'), + '$city' => $res['city'], + '$lon' => $res['lon'], + '$lat' => $res['lat'], + '$description' => $res['descripion'], + '$temp' => $res['temperature'], + '$relhumidity' => ['caption'=>DI::l10n()->t('Relative Humidity'), 'val'=>$res['humidity']], + '$pressure' => ['caption'=>DI::l10n()->t('Pressure'), 'val'=>$res['pressure']], + '$wind' => ['caption'=>DI::l10n()->t('Wind'), 'val'=> $res['wind']], + '$lastupdate' => DI::l10n()->t('Last Updated').': '.$res['update'].'UTC', + '$databy' => DI::l10n()->t('Data by'), + '$showonmap' => DI::l10n()->t('Show on map') + ]); + } else { + $t = Renderer::getMarkupTemplate('widget-error.tpl', 'addon/curweather/'); + $curweather = Renderer::replaceMacros( $t, [ + '$problem' => DI::l10n()->t('There was a problem accessing the weather data. But have a look'), + '$rpt' => $rpt, + '$atOWM' => DI::l10n()->t('at OpenWeatherMap') + ]); + } + + DI::page()['aside'] = $curweather . DI::page()['aside']; } - -function curweather_plugin_settings_post($a,$post) { - if(! local_user() || (! x($_POST,'curweather-settings-submit'))) +function curweather_addon_settings_post(App $a, $post) +{ + if (!local_user() || empty($_POST['curweather-settings-submit'])) { return; - set_pconfig(local_user(),'curweather','curweather_loc',trim($_POST['curweather_loc'])); - set_pconfig(local_user(),'curweather','curweather_enable',intval($_POST['curweather_enable'])); + } - info( t('Current Weather settings updated.') . EOL); + DI::pConfig()->set(local_user(), 'curweather', 'curweather_loc' , trim($_POST['curweather_loc'])); + DI::pConfig()->set(local_user(), 'curweather', 'curweather_enable', intval($_POST['curweather_enable'])); + DI::pConfig()->set(local_user(), 'curweather', 'curweather_units' , trim($_POST['curweather_units'])); } - -function curweather_plugin_settings(&$a,&$s) { - - if(! local_user()) +function curweather_addon_settings(App $a, &$s) +{ + if (!local_user()) { return; - - /* Add our stylesheet to the curweather so we can make our settings look nice */ - - $a->page['htmlhead'] .= '' . "\r\n"; + } /* Get the current state of our config variable */ + $curweather_loc = DI::pConfig()->get(local_user(), 'curweather', 'curweather_loc'); + $curweather_units = DI::pConfig()->get(local_user(), 'curweather', 'curweather_units'); + $appid = DI::config()->get('curweather', 'appid'); + + if ($appid == "") { + $noappidtext = DI::l10n()->t('No APPID found, please contact your admin to obtain one.'); + } else { + $noappidtext = ''; + } - $curweather_loc = get_pconfig(local_user(), 'curweather', 'curweather_loc'); - $enable = intval(get_pconfig(local_user(),'curweather','curweather_enable')); + $enable = intval(DI::pConfig()->get(local_user(), 'curweather', 'curweather_enable')); $enable_checked = (($enable) ? ' checked="checked" ' : ''); - - /* Add some HTML to the existing form */ - - $s .= '
'; - $s .= '

' . t('Current Weather Settings') . '

'; - $s .= '
'; - $s .= '

Find the location code for the airport/weather station nearest you here.

'; - $s .= ''; - $s .= ''; - $s .= '
'; - $s .= ''; - $s .= ''; - $s .= '
'; - - $s .= '
'; - - /* provide a submit button */ + // load template and replace the macros + $t = Renderer::getMarkupTemplate("settings.tpl", "addon/curweather/" ); + + $s = Renderer::replaceMacros($t, [ + '$submit' => DI::l10n()->t('Save Settings'), + '$header' => DI::l10n()->t('Current Weather').' '.DI::l10n()->t('Settings'), + '$noappidtext' => $noappidtext, + '$info' => DI::l10n()->t('Enter either the name of your location or the zip code.'), + '$curweather_loc' => [ 'curweather_loc', DI::l10n()->t('Your Location'), $curweather_loc, DI::l10n()->t('Identifier of your location (name or zip code), e.g. Berlin,DE or 14476,DE.') ], + '$curweather_units' => [ 'curweather_units', DI::l10n()->t('Units'), $curweather_units, DI::l10n()->t('select if the temperature should be displayed in °C or °F'), ['metric'=>'°C', 'imperial'=>'°F']], + '$enabled' => [ 'curweather_enable', DI::l10n()->t('Show weather data'), $enable, ''] + ]); + + return; +} - $s .= '
'; +// Config stuff for the admin panel to let the admin of the node set a APPID +// for accessing the API of openweathermap +function curweather_addon_admin_post(App $a) +{ + if (!is_site_admin()) { + return; + } + if (!empty($_POST['curweather-submit'])) { + DI::config()->set('curweather', 'appid', trim($_POST['appid'])); + DI::config()->set('curweather', 'cachetime', trim($_POST['cachetime'])); + } } - +function curweather_addon_admin(App $a, &$o) +{ + if (!is_site_admin()) { + return; + } + + $appid = DI::config()->get('curweather', 'appid'); + $cachetime = DI::config()->get('curweather', 'cachetime'); + + $t = Renderer::getMarkupTemplate("admin.tpl", "addon/curweather/" ); + + $o = Renderer::replaceMacros($t, [ + '$submit' => DI::l10n()->t('Save Settings'), + '$cachetime' => [ + 'cachetime', + DI::l10n()->t('Caching Interval'), + $cachetime, + DI::l10n()->t('For how long should the weather data be cached? Choose according your OpenWeatherMap account type.'), [ + '0' => DI::l10n()->t('no cache'), + '300' => '5 ' . DI::l10n()->t('minutes'), + '900' => '15 ' . DI::l10n()->t('minutes'), + '1800' => '30 ' . DI::l10n()->t('minutes'), + '3600' => '60 ' . DI::l10n()->t('minutes') + ] + ], + '$appid' => ['appid', DI::l10n()->t('Your APPID'), $appid, DI::l10n()->t('Your API key provided by OpenWeatherMap')] + ]); +}