X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=curweather%2Fcurweather.php;h=2b8682d157168316df0a46ccb7641e6082867fd1;hb=02e6e56e85bbad3617f59762f7d5d627e1476f46;hp=71dada34c4be1f83c0637d5e4db86310369df747;hpb=429b9c9f4a2b97d77e824dceabd13b3063c80d47;p=friendica-addons.git diff --git a/curweather/curweather.php b/curweather/curweather.php index 71dada34..2b8682d1 100644 --- a/curweather/curweather.php +++ b/curweather/curweather.php @@ -2,94 +2,98 @@ /** * Name: Current Weather * Description: Shows current weather conditions for user's location on their network page. - * Version: 1.1 + * Version: 1.2 * Author: Tony Baldwin * Author: Fabio Comuni * Author: Tobias Diekershoff * */ -require_once 'mod/proxy.php'; -require_once 'include/text.php'; +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; -use Friendica\Core\Addon; -use Friendica\Core\Cache; -use Friendica\Core\Config; -use Friendica\Core\L10n; -use Friendica\Core\PConfig; -use Friendica\Util\Network; +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'); +} // 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 = Cache::get('curweather'.md5($url)); +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 = PConfig::get(local_user(), 'curweather', 'last'); + $cdate = DI::pConfig()->get(local_user(), 'curweather', 'last'); $cached = unserialize($cached); + if ($cdate + $cachetime > $now->getTimestamp()) { return $cached; } } + try { - $res = new SimpleXMLElement(Network::fetchUrl($url)); + $res = new SimpleXMLElement(DI::httpRequest()->fetch($url)); } catch (Exception $e) { - if (!$_SESSION['curweather_notice_shown']) { - info(L10n::t('Error fetching weather data. Error was: '.$e->getMessage())); + 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 ((string)$res->temperature['unit']==='metric') { + + 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']; + + 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']; + $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'], + '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'] + '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'], ]; - PConfig::set(local_user(), 'curweather', 'last', $now->getTimestamp()); - Cache::set('curweather'.md5($url), serialize($r), CACHE_HOUR); - return $r; -} -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'); -} + DI::pConfig()->set(local_user(), 'curweather', 'last', $now->getTimestamp()); + DI::cache()->set('curweather'.md5($url), serialize($r), Duration::HOUR); -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'); + return $r; } -function curweather_network_mod_init(&$fk_app,&$b) { - - if(! intval(PConfig::get(local_user(),'curweather','curweather_enable'))) +function curweather_network_mod_init(App $a, &$b) +{ + if (!intval(DI::pConfig()->get(local_user(), 'curweather', 'curweather_enable'))) { return; + } - $fk_app->page['htmlhead'] .= '' . "\r\n"; + DI::page()['htmlhead'] .= '' . "\r\n"; // $rpt value is needed for location // $lang will be taken from the browser session to honour user settings @@ -100,124 +104,141 @@ function curweather_network_mod_init(&$fk_app,&$b) { // 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'); - - // set the language to the browsers language and use metric units - $lang = $_SESSION['language']; - $units = PConfig::get( local_user(), 'curweather', 'curweather_units'); - $appid = Config::get('curweather','appid'); - $cachetime = intval(Config::get('curweather','cachetime')); - if ($units==="") + $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) + + if ($res === false) { $ok = false; + } if ($ok) { - $t = get_markup_template("widget.tpl", "addon/curweather/" ); - $curweather = replace_macros ($t, [ - '$title' => L10n::t("Current Weather"), - '$icon' => proxy_url('http://openweathermap.org/img/w/'.$res['icon'].'.png'), + $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'=>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') + '$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 = 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'), + $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' => L10n::t('at OpenWeatherMap') + '$atOWM' => DI::l10n()->t('at OpenWeatherMap') ]); } - $fk_app->page['aside'] = $curweather.$fk_app->page['aside']; + DI::page()['aside'] = $curweather . DI::page()['aside']; } -function curweather_addon_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; - 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'])); - - info(L10n::t('Current Weather settings updated.') . EOL); -} + } -function curweather_addon_settings(&$a,&$s) { + 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'])); +} - if(! local_user()) +function curweather_addon_settings(App $a, &$s) +{ + if (!local_user()) { return; - + } + /* 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'); - $appid = Config::get('curweather','appid'); - if ($appid=="") { - $noappidtext = L10n::t('No APPID found, please contact your admin to obtain one.'); + $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 = ''; } - $enable = intval(PConfig::get(local_user(),'curweather','curweather_enable')); + + $enable = intval(DI::pConfig()->get(local_user(), 'curweather', 'curweather_enable')); $enable_checked = (($enable) ? ' checked="checked" ' : ''); // load template and replace the macros - $t = get_markup_template("settings.tpl", "addon/curweather/" ); - $s = replace_macros ($t, [ - '$submit' => L10n::t('Save Settings'), - '$header' => L10n::t('Current Weather').' '.L10n::t('Settings'), + $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' => 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. Berlin,DE or 14476,DE.') ], - '$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, ''] + '$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; } // 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 (&$a) { - if(! is_site_admin()) +function curweather_addon_admin_post(App $a) +{ + if (!is_site_admin()) { return; - if ($_POST['curweather-submit']) { - Config::set('curweather','appid',trim($_POST['appid'])); - Config::set('curweather','cachetime',trim($_POST['cachetime'])); - info(L10n::t('Curweather settings saved.'.EOL)); + } + + 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 (&$a, &$o) { - if(! is_site_admin()) +function curweather_addon_admin(App $a, &$o) +{ + if (!is_site_admin()) { return; - $appid = Config::get('curweather','appid'); - $cachetime = Config::get('curweather','cachetime'); - $t = get_markup_template("admin.tpl", "addon/curweather/" ); - $o = replace_macros ($t, [ - '$submit' => L10n::t('Save Settings'), + } + + $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', - L10n::t('Caching Interval'), - $cachetime, - L10n::t('For how long should the weather data be cached? Choose according your OpenWeatherMap account type.'), [ - '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') + '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', L10n::t('Your APPID'), $appid, L10n::t('Your API key provided by OpenWeatherMap')] + '$appid' => ['appid', DI::l10n()->t('Your APPID'), $appid, DI::l10n()->t('Your API key provided by OpenWeatherMap')] ]); }