<?php
/**
- * Name: Current Weather
+ * 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: Tobias Diekershoff <https://f.diekershoff.de/u/tobias>
*
*/
-use Cmfcmf\OpenWeatherMap;
-use Cmfcmf\OpenWeatherMap\Exception as OWMException;
-// Must point to composer's autoload file.
-require('vendor/autoload.php');
+require_once('include/network.php');
+require_once("mod/proxy.php");
+require_once('include/text.php');
+
+use Friendica\Core\Cache;
+use Friendica\Core\Config;
+use Friendica\Core\PConfig;
+
+// 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();
+ 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(fetch_url($url));
+ } catch (Exception $e) {
+ info(t('Error fetching weather data.\nError was: '.$e->getMessage()));
+ return false;
+ }
+ if ((string)$res->temperature['unit']==='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']
+ ];
+ PConfig::set(local_user(), 'curweather', 'last', $now->getTimestamp());
+ Cache::set('curweather'.md5($url), serialize($r), CACHE_HOUR);
+ return $r;
+}
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_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_network_mod_init(&$fk_app,&$b) {
- if(! intval(get_pconfig(local_user(),'curweather','curweather_enable')))
+ if(! intval(PConfig::get(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 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');
+ // $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 and use metric units
$lang = $_SESSION['language'];
- $units = get_pconfig( local_user(), 'curweather', 'curweather_units');
- $appid = get_config('curweather','appid');
+ $units = PConfig::get( local_user(), 'curweather', 'curweather_units');
+ $appid = Config::get('curweather','appid');
+ $cachetime = intval(Config::get('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();
-
- try {
- $weather = $owm->getWeather($rpt, $units, $lang, $appid);
- $temp = $weather->temperature->getValue();
- if ( $units === 'metric') {
- $temp .= '°C';
- } else {
- $temp .= '°F';
- };
- $rhumid = $weather->humidity;
- $pressure = $weather->pressure;
- $wind = $weather->wind->speed . " " . $weather->wind->direction;
- $description = $weather->clouds->getDescription();
- } catch(OWMException $e) {
- alert ( 'OpenWeatherMap exception: ' . $e->getMessage() . ' (Code ' . $e->getCode() . ').');
- } catch(\Exception $e) {
- alert ('General exception: ' . $e->getMessage() . ' (Code ' . $e->getCode() . ').');
+ $ok = true;
+
+ $res = getWeather($rpt, $units, $lang, $appid, $cachetime);
+ if ($res===false)
+ $ok = false;
+
+ if ($ok) {
+ $t = get_markup_template("widget.tpl", "addon/curweather/" );
+ $curweather = replace_macros ($t, [
+ '$title' => t("Current Weather"),
+ '$icon' => proxy_url('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'=>t('Relative Humidity'), 'val'=>$res['humidity']],
+ '$pressure' => ['caption'=>t('Pressure'), 'val'=>$res['pressure']],
+ '$wind' => ['caption'=>t('Wind'), 'val'=> $res['wind']],
+ '$lastupdate' => t('Last Updated').': '.$res['update'].'UTC',
+ '$databy' => t('Data by'),
+ '$showonmap' => t('Show on map')
+ ]);
+ } else {
+ $t = get_markup_template('widget-error.tpl', 'addon/curweather/');
+ $curweather = replace_macros( $t, [
+ '$problem' => t('There was a problem accessing the weather data. But have a look'),
+ '$rpt' => $rpt,
+ '$atOWM' => t('at OpenWeatherMap')
+ ]);
}
- $curweather = '<div id="curweather-network" class="widget">
- <div class="title tool">
- <h4>'.t("Current Weather").': '.$weather->city->name.'</h4></div>';
-
- $curweather .= "$description; $temp<br />";
- $curweather .= t('Relative Humidity').": $rhumid<br />";
- $curweather .= t('Pressure').": $pressure<br />";
- $curweather .= t('Wind').": $wind<br />";
- $curweather .= '<span style="font-size:0.8em;">'. t('Data by').': <a href="http://openweathermap.org">OpenWeatherMap</a>. <a href="http://openweathermap.org/Maps?zoom=7&lat='.$weather->city->lat.'&lon='.$weather->city->lon.'&layers=B0FTTFF">'.t('Show on map').'</a></span>';
-
- $curweather .= '</div><div class="clear"></div>';
-
$fk_app->page['aside'] = $curweather.$fk_app->page['aside'];
}
function curweather_plugin_settings_post($a,$post) {
if(! local_user() || (! x($_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']));
- set_pconfig(local_user(),'curweather','curweather_units',trim($_POST['curweather_units']));
+ 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( t('Current Weather settings updated.') . EOL);
}
/* Get the current state of our config variable */
- $curweather_loc = get_pconfig(local_user(), 'curweather', 'curweather_loc');
- $curweather_units = get_pconfig(local_user(), 'curweather', 'curweather_units');
- $appid = get_config('curweather','appid');
- if (x($appid)) {
- $noappidtext = t('No APPID found, please contact your admin to optain one.');
+ $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 = t('No APPID found, please contact your admin to obtain one.');
} else {
$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('curweather Settings'),
- '$noappidtext' => t('No APPID found, please contact your admin to optain one.'),
+ $s = replace_macros ($t, [
+ '$submit' => t('Save Settings'),
+ '$header' => t('Current Weather').' '.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, '')
- ));
+ '$curweather_loc' => [ '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' => [ 'curweather_units', t('Units'), $curweather_units, t('select if the temperature should be displayed in °C or °F'), ['metric'=>'°C', 'imperial'=>'°F']],
+ '$enabled' => [ 'curweather_enable', t('Show weather data'), $enable, '']
+ ]);
return;
}
if(! is_site_admin())
return;
if ($_POST['curweather-submit']) {
- set_config('curweather','appid',trim($_POST['appid']));
+ Config::set('curweather','appid',trim($_POST['appid']));
+ Config::set('curweather','cachetime',trim($_POST['cachetime']));
info( t('Curweather settings saved.'.EOL));
}
}
function curweather_plugin_admin (&$a, &$o) {
if(! is_site_admin())
return;
- $appid = get_config('curweather','appid');
+ $appid = Config::get('curweather','appid');
+ $cachetime = Config::get('curweather','cachetime');
$t = get_markup_template("admin.tpl", "addon/curweather/" );
- $o = replace_macros ($t, array(
+ $o = replace_macros ($t, [
'$submit' => t('Save Settings'),
- '$appid' => array('appid', t('Your APPID'), $appid, t('Your API key provided by OpenWeatherMap'))
- ));
+ '$cachetime' => ['cachetime', t('Caching Interval'), $cachetime, t('For how long should the weather data be cached? Choose according your OpenWeatherMap account type.'), ['0'=>t('no cache'), '300'=>'5 '.t('minutes'), '900'=>'15 '.t('minutes'), '1800'=>'30 '.t('minutes'), '3600'=>'60 '.t('minutes')]],
+ '$appid' => ['appid', t('Your APPID'), $appid, t('Your API key provided by OpenWeatherMap')]
+ ]);
}
projects / friendica-addons.git / blobdiff