]> git.mxchange.org Git - friendica-addons.git/blobdiff - curweather/curweather.php
Merge pull request #457 from tobiasd/20171127-langXMPPandIFTTT
[friendica-addons.git] / curweather / curweather.php
index cfe66b7e03c3f7f0690c5273b1f9ac77612e22d4..6197c96174c746895189aba5ce79c88febb80efc 100644 (file)
  */
 
 require_once('include/network.php');
-include_once('include/text.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='') {
+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) {
@@ -28,7 +42,12 @@ function getWeather( $loc, $units='metric', $lang='en', $appid='') {
        $tunit = '°F';
        $wunit = 'mph';
     }
-    return array(
+    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 = array(
        'city'=> (string) $res->city['name'][0],
        'country' => (string) $res->city->country[0],
        'lat' => (string) $res->city->coord['lat'],
@@ -36,10 +55,14 @@ function getWeather( $loc, $units='metric', $lang='en', $appid='') {
        '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' => (string)$res->weather['value'].', '.(string)$res->clouds['name'],
+       'descripion' => $desc,
        'wind' => (string)$res->wind->speed['name'].' ('.(string)$res->wind->speed['value'].$wunit.')',
-       'update' => (string)$res->lastupdate['value']
+       '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() {
@@ -56,40 +79,41 @@ function curweather_uninstall() {
 
 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 OpenWeatherMap-PHP-APIlib does all the work here
-    // the $rpt value is needed for location
+    // $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 = get_pconfig(local_user(), 'curweather', 'curweather_loc');
+    $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');
-    $cachetime = intval(get_config('curweather','cachetime'));
+    $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);
+
+    $res = getWeather($rpt, $units, $lang, $appid, $cachetime);
     if ($res===false)
        $ok = false;
-    // TODO Caching
 
     if ($ok) {
        $t = get_markup_template("widget.tpl", "addon/curweather/" );
        $curweather = replace_macros ($t, array(
            '$title' => t("Current Weather"),
+           '$icon' => proxy_url('http://openweathermap.org/img/w/'.$res['icon'].'.png'),
            '$city' => $res['city'],
            '$lon' => $res['lon'],
            '$lat' => $res['lat'],
@@ -98,7 +122,7 @@ function curweather_network_mod_init(&$fk_app,&$b) {
            '$relhumidity' => array('caption'=>t('Relative Humidity'), 'val'=>$res['humidity']),
            '$pressure' => array('caption'=>t('Pressure'), 'val'=>$res['pressure']),
            '$wind' => array('caption'=>t('Wind'), 'val'=> $res['wind']),
-           '$lastupdate' => t('Last Updated').': '.$res['update'],
+           '$lastupdate' => t('Last Updated').': '.$res['update'].'UTC',
            '$databy' =>  t('Data by'),
            '$showonmap' => t('Show on map')
        ));
@@ -119,9 +143,9 @@ function curweather_network_mod_init(&$fk_app,&$b) {
 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);
 }
@@ -134,15 +158,15 @@ function curweather_plugin_settings(&$a,&$s) {
 
        /* 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');
+       $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 optain one.');
+               $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
@@ -153,7 +177,7 @@ function curweather_plugin_settings(&$a,&$s) {
                '$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')),
+               '$curweather_units' => array( 'curweather_units', t('Units'), $curweather_units, t('select if the temperature should be displayed in &deg;C or &deg;F'), array('metric'=>'°C', 'imperial'=>'°F')),
                '$enabled' => array( 'curweather_enable', t('Show weather data'), $enable, '')
            ));
        return;
@@ -165,16 +189,16 @@ 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']));
+           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');
-    $cachetime = get_config('curweather','cachetime');
+    $appid = Config::get('curweather','appid');
+    $cachetime = Config::get('curweather','cachetime');
     $t = get_markup_template("admin.tpl", "addon/curweather/" );
     $o = replace_macros ($t, array(
        '$submit' => t('Save Settings'),