<?php
/**
- * Name: Current Weather
+ * 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 <http://friendica.tonybaldwin.info/u/t0ny>
* Author: Fabio Comuni <http://kirkgroup.com/u/fabrixxm>
* Author: Tobias Diekershoff <https://f.diekershoff.de/u/tobias>
*
*/
-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('addon/curweather/openweathermap-php-api/Cmfcmf/OpenWeatherMap.php');
-//require('addon/curweather/vendor/cmfcmf/openweathermap-php-api/Cmfcmf/OpenWeatherMap.php');
+use Friendica\App;
+use Friendica\Core\Cache\Duration;
+use Friendica\Core\Config;
+use Friendica\Core\Hook;
+use Friendica\Core\Renderer;
+use Friendica\Core\Session;
+use Friendica\DI;
+use Friendica\Util\Network;
+use Friendica\Util\Proxy as ProxyUtils;
-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');
+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()
+{
+ Hook::unregister('network_mod_init' , 'addon/curweather/curweather.php', 'curweather_network_mod_init');
+ Hook::unregister('addon_settings' , 'addon/curweather/curweather.php', 'curweather_addon_settings');
+ Hook::unregister('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);
-// 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
+ if ($cdate + $cachetime > $now->getTimestamp()) {
+ return $cached;
+ }
+ }
-class CWCache extends AbstractCache
-{
- private function urlToPath($url)
- {
- // take friendicas tmp directory as base for the cache
- $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);
- }
-}
+ try {
+ $res = new SimpleXMLElement(Network::fetchUrl($url));
+ } catch (Exception $e) {
+ if (empty($_SESSION['curweather_notice_shown'])) {
+ info(DI::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'] .= '<link rel="stylesheet" type="text/css" href="' . $fk_app->get_baseurl() . '/addon/curweather/curweather.css' . '" media="all" />' . "\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 CWCache(), $cachetime);
- $ok = true;
-
- try {
- $weather = $owm->getWeather($rpt, $units, $lang, $appid);
- $temp = $weather->temperature->getValue();
- if ( $units === 'metric') {
- $temp .= '°C';
+ if (in_array((string) $res->temperature['unit'], ['celsius', '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();
- $city = array(
- 'name'=>$weather->city->name,
- 'lon' =>$weather->city->lon,
- 'lat' =>$weather->city->lat
- );
- } catch(OWMException $e) {
- info ( 'OpenWeatherMap exception: ' . $e->getMessage() . ' (Code ' . $e->getCode() . ').');
- $ok = false;
- } catch(\Exception $e) {
- info ('General exception: ' . $e->getMessage() . ' (Code ' . $e->getCode() . ').');
- $ok = false;
- }
-
- if ($ok) {
- $t = get_markup_template("widget.tpl", "addon/curweather/" );
- $curweather = replace_macros ($t, array(
- '$title' => t("Current Weather"),
- '$city' => $city,
- '$description' => $description,
- '$temp' => $temp,
- '$relhumidity' => array('caption'=>t('Relative Humidity'), 'val'=>$rhumid),
- '$pressure' => array('caption'=>t('Pressure'), 'val'=>$pressure),
- '$wind' => array('caption'=>t('Wind'), 'val'=> $wind),
- '$databy' => t('Data by'),
- '$showonmap' => t('Show on map')
- ));
- } else {
- $t = get_markup_template('widget-error.tpl', 'addon/curweather/');
- $curweather = replace_macros( $t, array(
- '$problem' => t('There was a problem accessing the weather data. But have a look'),
- '$rpt' => $rpt,
- '$atOWM' => t('at OpenWeatherMap')
- ));
- }
-
- $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'],
+ ];
-function curweather_plugin_settings_post($a,$post) {
- if(! local_user() || (! x($_POST,'curweather-settings-submit')))
+ 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(App $a, &$b)
+{
+ if (!intval(DI::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']));
+ }
+
+ DI::page()['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . DI::baseUrl()->get() . '/addon/curweather/curweather.css' . '" media="all" />' . "\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;
+ }
- info( t('Current Weather settings updated.') . EOL);
+ 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_addon_settings_post(App $a, $post)
+{
+ if (!local_user() || empty($_POST['curweather-settings-submit'])) {
+ return;
+ }
+
+ 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) {
+ info(DI::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 = DI::pConfig()->get(local_user(), 'curweather', 'curweather_loc');
+ $curweather_units = DI::pConfig()->get(local_user(), 'curweather', 'curweather_units');
+ $appid = DI::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 = DI::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(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, array(
- '$submit' => t('Save Settings'),
- '$header' => t('Current Weather').' '.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' => 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. <em>Berlin,DE</em> or <em>14476,DE</em>.') ),
- '$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' => 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. <em>Berlin,DE</em> or <em>14476,DE</em>.') ],
+ '$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_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(DI::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 = 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')]
+ ]);
}