- <?php
+<?php
/**
- * Name: Current Weather
- * Description: Shows current weather conditions for user's location on their network page.<br />Find the location code for the station or airport nearest you <a href="http://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code" target="_blank">here</a>.
- * Version: 1.0
+ * Name: Current Weather
+ * Description: Shows current weather conditions for user's location on their network page.
+ * Version: 1.1
* 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>
*
*/
-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;
+use Friendica\Core\Config;
+use Friendica\Core\Hook;
+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()
+{
+ 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');
-
+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');
}
+// 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));
+ $now = new DateTime();
-function curweather_network_mod_init(&$fk_app,&$b) {
+ if (!is_null($cached)) {
+ $cdate = PConfig::get(local_user(), 'curweather', 'last');
+ $cached = unserialize($cached);
- if(! intval(get_pconfig(local_user(),'curweather','curweather_enable')))
- return;
+ if ($cdate + $cachetime > $now->getTimestamp()) {
+ return $cached;
+ }
+ }
- $fk_app->page['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . $fk_app->get_baseurl() . '/addon/curweather/curweather.css' . '" media="all" />' . "\r\n";
+ 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;
+ }
- // 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 = '<div id="curweather-network" class="widget">
- <div class="title tool">
- <h4>'.t("Current Weather").'</h4></div>';
+ return false;
+ }
- $curweather .= "Weather: $weather<br />
- Temperature: $temp<br />
- Relative Humidity: $rhumid<br />
- Pressure: $pressure<br />
- Wind: $wind";
+ unset($_SESSION['curweather_notice_shown']);
- $curweather .= '</div><div class="clear"></div>';
+ if ((string) $res->temperature['unit'] === 'metric') {
+ $tunit = '°C';
+ $wunit = 'm/s';
+ } else {
+ $tunit = '°F';
+ $wunit = 'mph';
+ }
- $fk_app->page['aside'] = $curweather.$fk_app->page['aside'];
+ 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']));
+ }
- info( t('Current Weather settings updated.') . EOL);
-}
+ $a->page['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . $a->getBaseURL() . '/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 = PConfig::get(local_user(), 'curweather', 'curweather_loc');
+ // Set the language to the browsers language or default and use metric units
+ $lang = defaults($_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'));
-function curweather_plugin_settings(&$a,&$s) {
+ 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')
+ ]);
+ }
+
+ $a->page['aside'] = $curweather . $a->page['aside'];
+}
- if(! local_user())
+function curweather_addon_settings_post(App $a, $post)
+{
+ if (!local_user() || empty($_POST['curweather-settings-submit'])) {
return;
+ }
- /* Add our stylesheet to the curweather so we can make our settings look nice */
+ 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']));
- $a->page['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . $a->get_baseurl() . '/addon/curweather/curweather.css' . '" media="all" />' . "\r\n";
+ info(L10n::t('Current Weather settings updated.') . EOL);
+}
+
+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');
- $enable = intval(get_pconfig(local_user(),'curweather','curweather_enable'));
+ if ($appid == "") {
+ $noappidtext = L10n::t('No APPID found, please contact your admin to obtain one.');
+ } else {
+ $noappidtext = '';
+ }
+
+ $enable = intval(PConfig::get(local_user(), 'curweather', 'curweather_enable'));
$enable_checked = (($enable) ? ' checked="checked" ' : '');
-
- /* Add some HTML to the existing form */
+ // load template and replace the macros
+ $t = Renderer::getMarkupTemplate("settings.tpl", "addon/curweather/" );
- $s .= '<div class="settings-block">';
- $s .= '<h3>' . t('Current Weather Settings') . '</h3>';
- $s .= '<div id="curweather-settings-wrapper">';
- $s .= '<p>Find the location code for the airport/weather station nearest you <a href="http://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code" target="_blank">here</a>.</p>';
- $s .= '<label id="curweather-location-label" for="curweather_loc">' . t('Weather Location: ') . '</label>';
- $s .= '<input id="curweather-location" type="text" name="curweather_loc" value="' . $curweather_loc . '"/>';
- $s .= '<div class="clear"></div>';
- $s .= '<label id="curweather-enable-label" for="curweather_enable">' . t('Enable Current Weather') . '</label>';
- $s .= '<input id="curweather-enable" type="checkbox" name="curweather_enable" value="1" ' . $enable_checked . '/>';
- $s .= '<div class="clear"></div>';
+ $s = Renderer::replaceMacros($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, '']
+ ]);
- $s .= '</div>';
+ return;
+}
- /* provide a submit button */
+// 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;
+ }
- $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="curweather-settings-submit" class="settings-submit" value="' . t('Submit') . '" /></div></div>';
+ 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_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')]
+ ]);
+}
projects / friendica-addons.git / blobdiff