X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=curweather%2Fcurweather.php;h=85fd4a6033ebbfcb440e87fba7ec3ccb854b0de0;hb=074493a29eff22bb38275ea5c4c958dfea156056;hp=6db89428f4a0d2342b3bd086005e11ec009b18a8;hpb=02b29b2a6a5e9c8c10999feec9b270967c4050ba;p=friendica-addons.git diff --git a/curweather/curweather.php b/curweather/curweather.php index 6db89428..85fd4a60 100644 --- a/curweather/curweather.php +++ b/curweather/curweather.php @@ -1,6 +1,6 @@ @@ -8,202 +8,252 @@ * Author: Tobias Diekershoff * */ -use Cmfcmf\OpenWeatherMap; -use Cmfcmf\OpenWeatherMap\AbstractCache; -use Cmfcmf\OpenWeatherMap\Exception as OWMException; -// Must point to composer's autoload file. -require('vendor/autoload.php'); +require_once 'include/text.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\Addon; +use Friendica\Core\Cache; +use Friendica\Core\Config; +use Friendica\Core\L10n; +use Friendica\Core\PConfig; +use Friendica\Core\Renderer; +use Friendica\Util\Network; +use Friendica\Util\Proxy as ProxyUtils; +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() { - 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'); - +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'); } -// The caching mechanism is taken from the cache example of the -// OpenWeatherMap-PHP-API library and a bit customized to allow admins to set -// the caching time depending on the plans they got from openweathermap.org -// and the usage of the friendica temppath - -class ExampleCache extends AbstractCache +// get the weather data from OpenWeatherMap +function getWeather($loc, $units = 'metric', $lang = 'en', $appid = '', $cachetime = 0) { - private function urlToPath($url) - { - $tmp = get_config('system','temppath'); - $dir = $tmp . DIRECTORY_SEPARATOR . "OpenWeatherMapPHPAPI"; - if (!is_dir($dir)) { - mkdir($dir); - } - - $path = $dir . DIRECTORY_SEPARATOR . md5($url); - return $path; - } - - /** - * @inheritdoc - */ - public function isCached($url) - { - $path = $this->urlToPath($url); - if (!file_exists($path) || filectime($path) + $this->seconds < time()) { - return false; - } - return true; - } - /** - * @inheritdoc - */ - public function getCached($url) - { - return file_get_contents($this->urlToPath($url)); - } - /** - * @inheritdoc - */ - public function setCached($url, $content) - { - file_put_contents($this->urlToPath($url), $content); - } -} + $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)); + $now = new DateTime(); + + if (!is_null($cached)) { + $cdate = PConfig::get(local_user(), 'curweather', 'last'); + $cached = unserialize($cached); + + if ($cdate + $cachetime > $now->getTimestamp()) { + return $cached; + } + } + + try { + $res = new SimpleXMLElement(Network::fetchUrl($url)); + } catch (Exception $e) { + if (empty($_SESSION['curweather_notice_shown'])) { + info(L10n::t('Error fetching weather data. Error was: '.$e->getMessage())); + $_SESSION['curweather_notice_shown'] = true; + } + + return false; + } + unset($_SESSION['curweather_notice_shown']); -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 OpenWeatherMap-PHP-APIlib does all the work here - // the $rpt value is needed for location - // $lang will be taken from the browser session to honour user settings - // $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 = get_pconfig(local_user(), 'curweather', 'curweather_loc'); - - - // set the language to the browsers language and use metric units - $lang = $_SESSION['language']; - $units = get_pconfig( local_user(), 'curweather', 'curweather_units'); - $appid = get_config('curweather','appid'); - $cachetime = intval(get_config('curweather','cachetime')); - if ($units==="") - $units = 'metric'; - // Get OpenWeatherMap object. Don't use caching (take a look into - // Example_Cache.php to see how it works). - //$owm = new OpenWeatherMap(); - $owm = new OpenWeatherMap(null, new ExampleCache(), $cachetime); - - try { - $weather = $owm->getWeather($rpt, $units, $lang, $appid); - $temp = $weather->temperature->getValue(); - if ( $units === 'metric') { - $temp .= '°C'; + if ((string) $res->temperature['unit'] === 'metric') { + $tunit = '°C'; + $wunit = 'm/s'; } else { - $temp .= '°F'; - }; - $rhumid = $weather->humidity; - $pressure = $weather->pressure; - $wind = $weather->wind->speed->getDescription().', '.$weather->wind->speed . " " . $weather->wind->direction; - $description = $weather->clouds->getDescription(); - } catch(OWMException $e) { - info ( 'OpenWeatherMap exception: ' . $e->getMessage() . ' (Code ' . $e->getCode() . ').'); - } catch(\Exception $e) { - info ('General exception: ' . $e->getMessage() . ' (Code ' . $e->getCode() . ').'); - } - - $curweather = '
-
-

'.t("Current Weather").': '.$weather->city->name.'

'; - - $curweather .= "$description; $temp
"; - $curweather .= t('Relative Humidity').": $rhumid
"; - $curweather .= t('Pressure').": $pressure
"; - $curweather .= t('Wind').": $wind
"; - $curweather .= ''. t('Data by').': OpenWeatherMap. '.t('Show on map').''; - - $curweather .= '
'; - - $fk_app->page['aside'] = $curweather.$fk_app->page['aside']; + $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'], + ]; + PConfig::set(local_user(), 'curweather', 'last', $now->getTimestamp()); + Cache::set('curweather'.md5($url), serialize($r), Cache::HOUR); + + return $r; +} -function curweather_plugin_settings_post($a,$post) { - if(! local_user() || (! x($_POST,'curweather-settings-submit'))) +function curweather_network_mod_init(App $a, &$b) +{ + if (!intval(PConfig::get(local_user(), 'curweather', 'curweather_enable'))) { return; - set_pconfig(local_user(),'curweather','curweather_loc',trim($_POST['curweather_loc'])); - set_pconfig(local_user(),'curweather','curweather_enable',intval($_POST['curweather_enable'])); - set_pconfig(local_user(),'curweather','curweather_units',trim($_POST['curweather_units'])); + } + + $a->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 = PConfig::get(local_user(), 'curweather', 'curweather_loc'); + + // Set the language to the browsers language or default and use metric units + $lang = (!empty($_SESSION['language']) ? $_SESSION['language'] : Config::get('system', 'language')); + $units = PConfig::get( local_user(), 'curweather', 'curweather_units'); + $appid = Config::get('curweather', 'appid'); + $cachetime = intval(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' => 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') + ]); + } else { + $t = Renderer::getMarkupTemplate('widget-error.tpl', 'addon/curweather/'); + $curweather = Renderer::replaceMacros( $t, [ + '$problem' => L10n::t('There was a problem accessing the weather data. But have a look'), + '$rpt' => $rpt, + '$atOWM' => L10n::t('at OpenWeatherMap') + ]); + } - info( t('Current Weather settings updated.') . EOL); + $a->page['aside'] = $curweather . $a->page['aside']; } +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'])); -function curweather_plugin_settings(&$a,&$s) { + info(L10n::t('Current Weather settings updated.') . EOL); +} - 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'); - $curweather_loc = get_pconfig(local_user(), 'curweather', 'curweather_loc'); - $curweather_units = get_pconfig(local_user(), 'curweather', 'curweather_units'); - $appid = get_config('curweather','appid'); - if ($appid=="") { - $noappidtext = t('No APPID found, please contact your admin to optain one.'); + if ($appid == "") { + $noappidtext = L10n::t('No APPID found, please contact your admin to obtain one.'); } else { - $noappidtext = ''; + $noappidtext = ''; } - $enable = intval(get_pconfig(local_user(),'curweather','curweather_enable')); + + $enable = intval(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, array( - '$submit' => t('Save Settings'), - '$header' => t('Current Weather').' '.t('Settings'), + $t = Renderer::getMarkupTemplate("settings.tpl", "addon/curweather/" ); + + $s = Renderer::replaceMacros($t, [ + '$submit' => L10n::t('Save Settings'), + '$header' => L10n::t('Current Weather').' '.L10n::t('Settings'), '$noappidtext' => $noappidtext, - '$info' => t('Enter either the name of your location or the zip code.'), - '$curweather_loc' => array( 'curweather_loc', t('Your Location'), $curweather_loc, t('Identifier of your location (name or zip code), e.g. Berlin,DE or 14476,DE.') ), - '$curweather_units' => array( 'curweather_units', t('Units'), $curweather_units, t('select if the temperatur should be displayed in °C or °F'), array('metric'=>'°C', 'imperial'=>'°F')), - '$enabled' => array( 'curweather_enable', t('Show weather data'), $enable, '') - )); - return; + '$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, ''] + ]); + 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_plugin_admin_post (&$a) { - if(! is_site_admin()) - return; - if ($_POST['curweather-submit']) { - set_config('curweather','appid',trim($_POST['appid'])); - set_config('curweather','cachetime',trim($_POST['cachetime'])); - info( t('Curweather settings saved.'.EOL)); +function curweather_addon_admin_post(App $a) +{ + if (!is_site_admin()) { + return; + } + + 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)); } } -function curweather_plugin_admin (&$a, &$o) { - if(! is_site_admin()) - return; - $appid = get_config('curweather','appid'); - $cachetime = get_config('curweather','cachetime'); - $t = get_markup_template("admin.tpl", "addon/curweather/" ); - $o = replace_macros ($t, array( - '$submit' => t('Save Settings'), - '$cachetime' => array('cachetime', t('Caching Interval'), $cachetime, t('For how long should the weather data be cached? Choose according your OpenWeatherMap account type.'), array('0'=>t('no cache'), '300'=>'5 '.t('minutes'), '900'=>'15 '.t('minutes'), '1800'=>'30 '.t('minutes'), '3600'=>'60 '.t('minutes'))), - '$appid' => array('appid', t('Your APPID'), $appid, t('Your API key provided by OpenWeatherMap')) - )); + +function curweather_addon_admin(App $a, &$o) +{ + if (!is_site_admin()) { + return; + } + + $appid = Config::get('curweather', 'appid'); + $cachetime = Config::get('curweather', 'cachetime'); + + $t = Renderer::getMarkupTemplate("admin.tpl", "addon/curweather/" ); + + $o = Renderer::replaceMacros($t, [ + '$submit' => 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') + ] + ], + '$appid' => ['appid', L10n::t('Your APPID'), $appid, L10n::t('Your API key provided by OpenWeatherMap')] + ]); }