some small styling and L10n improvements
[php-utility-classes.git] / include / classes / rrdstat.php-class
index 7810b78a369ed6582b6e3f15f118acccacde9804..4eae8b60edad176fa541ddbf4cda5318696b1d32 100644 (file)
@@ -35,6 +35,10 @@ class rrdstat {
   // var $basename
   // base name for this RRD (usually file name without .rrd)
   //
+  // var $basedir
+  // base directory for this RRD (with a trailing slash)
+  //   note that $rrd_file usually includes that path as well, but graph directory gets based on this value
+  //
   // var $config_all
   // complete, raw configuration array set
   //
@@ -64,6 +68,9 @@ class rrdstat {
   //   note that most functions require certain status values
   //   (e.g. update only works if status is ok, graph for ok/readonly/graphonly)
   //
+  // var $mod_textdomain
+  //   GNU gettext domain for this module
+  //
   // function set_def($rrdconfig, [$conf_id])
   //   set definitions based on given configuration
   //   [intended for internal use, called by the constructor]
@@ -128,6 +135,7 @@ class rrdstat {
 
   var $rrd_file = null;
   var $basename = null;
+  var $basedir = null;
 
   var $config_all = null;
   var $config_raw = null;
@@ -141,8 +149,16 @@ class rrdstat {
 
   var $status = 'unused';
 
+  var $mod_textdomain;
+
   function rrdstat($rrdconfig, $conf_id = null) {
     // ***** init RRD stat module *****
+    $this->mod_textdomain = 'class_rrdstat';
+    $mod_charset = 'iso-8859-15';
+
+    bindtextdomain($this->mod_textdomain, class_exists('baseutils')?baseutils::getDir('locale'):'locale/');
+    bind_textdomain_codeset($this->mod_textdomain, $mod_charset);
+
     $this->set_def($rrdconfig, $conf_id);
 
     if (($this->status == 'unused') && !is_null($this->rrd_file)) {
@@ -184,16 +200,21 @@ class rrdstat {
       $iinfo = $complete_conf;
     }
 
+    if (isset($iinfo['path']) && strlen($iinfo['path'])) {
+      $this->basedir = $iinfo['path'];
+      if (substr($this->basedir, -1) != '/') { $this->basedir .= '/'; }
+    }
+
     if (isset($iinfo['graph-only']) && $iinfo['graph-only'] && !is_null($conf_id)) {
       $this->basename = $conf_id;
       $this->status = 'graphonly';
     }
     elseif (isset($iinfo['file'])) {
-      $this->rrd_file = $iinfo['file'];
-      $this->basename = (substr($this->rrd_file, -4) == '.rrd')?substr($this->rrd_file, 0, -4):$this->rrd_file;
+      $this->rrd_file = (($iinfo['file']{0} != '/')?$this->basedir:'').$iinfo['file'];
+      $this->basename = basename((substr($this->rrd_file, -4) == '.rrd')?substr($this->rrd_file, 0, -4):$this->rrd_file);
     }
     elseif (!is_null($conf_id) && file_exists($conf_id.'.rrd')) {
-      $this->rrd_file = $conf_id.'.rrd';
+      $this->rrd_file = (($iinfo['file']{0} != '/')?$this->basedir:'').$conf_id.'.rrd';
       $this->basename = $conf_id;
     }
     else {
@@ -286,19 +307,23 @@ class rrdstat {
 
   function update($upArray = null) {
     // feed new data into RRD
-    if ($this->status != 'ok') { trigger_error('Cannot update non-writeable file', E_USER_WARNING); return 1; }
+    if ($this->status != 'ok') { trigger_error('Cannot update non-writeable file', E_USER_WARNING); return false; }
     $upvals = array();
     if (isset($this->config_raw['update'])) {
-      $evalcode = $this->config_raw['update'];
-      if (!is_null($evalcode)) {
-        ob_start();
-        eval($evalcode);
-        $ret = ob_get_contents();
-        if (strlen($ret)) { $upvals = explode("\n", $ret); }
-        ob_end_clean();
+      if (preg_match('/^\s*function\s+{(.*)}\s*$/is', $this->config_raw['update'], $regs)) {
+        $upfunc = create_function('', $regs[1]);
+        $upvals = $upfunc();
+      }
+      else {
+        $evalcode = $this->config_raw['update'];
+        if (!is_null($evalcode)) {
+          ob_start();
+          eval($evalcode);
+          $ret = ob_get_contents();
+          if (strlen($ret)) { $upvals = explode("\n", $ret); }
+          ob_end_clean();
+        }
       }
-      $walkfunc = create_function('&$val,$key', '$val = is_numeric(trim($val))?trim($val):"U";');
-      array_walk($upvals, $walkfunc);
     }
     else {
       foreach ($this->rrd_fields as $ds) {
@@ -306,7 +331,7 @@ class rrdstat {
         elseif (isset($ds['update'])) {
           $val = null; $evalcode = null;
           if (substr($ds['update'], 0, 4) == 'val:') {
-            $evalcode = 'print(trim('.substr($ds['update'], 4).'));';
+            $evalcode = 'function { return trim('.substr($ds['update'], 4).')); }';
           }
           elseif (substr($ds['update'], 0, 8) == 'snmp-if:') {
             $snmphost = 'localhost'; $snmpcomm = 'public';
@@ -320,11 +345,15 @@ class rrdstat {
             if ($valtype == 'in') { $oid = '1.3.6.1.2.1.2.2.1.10.'.$ifnr; }
             elseif ($valtype == 'out') { $oid = '1.3.6.1.2.1.2.2.1.16.'.$ifnr; }
             if (!is_null($ifnr) && !is_null($oid)) {
-              $evalcode = 'print(trim(substr(strrchr(`snmpget -v2c -c '.$snmpcomm.' '.$snmphost.' '.$oid.'`,":"),1)));';
+              $evalcode = 'function { return trim(substr(strrchr(`snmpget -v2c -c '.$snmpcomm.' '.$snmphost.' '.$oid.'`,":"),1)); }';
             }
           }
           else { $evalcode = $ds['update']; }
-          if (!is_null($evalcode)) {
+          if (preg_match('/^\s*function\s+{(.*)}\s*$/is', $evalcode, $regs)) {
+            $upfunc = create_function('', $regs[1]);
+            $val = $upfunc();
+          }
+          elseif (!is_null($evalcode)) {
             ob_start();
             eval($evalcode);
             $val = ob_get_contents();
@@ -332,12 +361,24 @@ class rrdstat {
           }
         }
         else { $val = null; }
-        $upvals[] = is_null($val)?'U':$val;
+        $upvals[$ds['name']] = $val;
+      }
+    }
+    $key_names = (!is_numeric(array_shift(array_keys($upvals))));
+    if (in_array('L', $upvals, true)) {
+      // for at least one value, we need to set the same as the last recorded value
+      $fvals = $this->fetch();
+      $rowids = array_shift($fvals);
+      $lastvals = array_shift($fvals);
+      foreach (array_keys($upvals, 'L') as $akey) {
+        $upvals[$akey] = $key_names?$lastvals[$akey]:$lastvals[$rowids[$akey]];
       }
     }
+    $walkfunc = create_function('&$val,$key', '$val = is_numeric(trim($val))?trim($val):"U";');
+    array_walk($upvals, $walkfunc);
     $return = null;
     if (count($upvals)) {
-      $update_cmd = 'rrdtool update '.$this->rrd_file.' N:'.implode(':', $upvals);
+      $update_cmd = 'rrdtool update '.$this->rrd_file.($key_names?' --template '.implode(':', array_keys($upvals)):'').' N:'.implode(':', $upvals);
       $return = `$update_cmd 2>&1`;
     }
 
@@ -346,7 +387,7 @@ class rrdstat {
       $success = false;
     }
     else { $success = true; }
-  return ($return_var == 0);
+  return $success;
   }
 
   function fetch($cf = 'AVERAGE', $resolution = null, $start = null, $end = null) {
@@ -378,7 +419,7 @@ class rrdstat {
         foreach ($rows as $row) {
           if (strlen(trim($row))) {
             $rvals = preg_split('/\s+/', $row);
-            $rtime = array_shift($rvals);
+            $rtime = str_replace(':', '', array_shift($rvals));
             $rv_array = array();
             foreach ($rvals as $key=>$rval) {
               $rv_array[$fields[$key]] = ($rval=='nan')?null:floatval($rval);
@@ -437,7 +478,8 @@ class rrdstat {
     $fname = str_replace('%t', $timeframe, $fname);
     $fname = str_replace('%f', $fmt_ext, $fname);
     if (substr($fname, -strlen($fmt_ext)) != $fmt_ext) { $fname .= $fmt_ext; }
-    if (isset($gconf['path'])) { $fname = $gconf['path'].'/'.$fname; }
+    if (isset($gconf['path']) && ($fname{0} != '/')) { $fname = $gconf['path'].'/'.$fname; }
+    if ($fname{0} != '/') { $fname = $this->basedir.$fname; }
     $fname = str_replace('//', '/', $fname);
 
     $graphrows = array(); $specialrows = array(); $gC = 0;
@@ -532,6 +574,7 @@ class rrdstat {
           $grow['legend'] = $ds['legend'];
           if (!isset($gconf['show_legend'])) { $gconf['show_legend'] = true; }
         }
+        if (isset($ds['desc'])) { $grow['desc'] = $ds['desc']; }
         $graphrows[] = $grow;
       }
     }
@@ -559,15 +602,16 @@ class rrdstat {
       }
     }
     else {
+      $td = $this->mod_textdomain;
       foreach ($graphrows as $grow) {
         if (isset($grow['gType']) && strlen($grow['gType'])) {
           $textprefix = isset($grow['desc'])?$grow['desc']:(isset($grow['legend'])?$grow['legend']:$grow['name']);
           // XXX: use lines below once we have rrdtol 1.2
           // $graphrows[] = array('dType'=>'VDEF', 'name'=>$grow['name'].'_last', 'rpn_expr'=>$grow['name'].',LAST');
           // $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'].'_last', 'text'=>'%3.2lf%s');
-          $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'MAX', 'text'=>$textprefix.'|Maximum|%.2lf%s');
-          $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'AVERAGE', 'text'=>$textprefix.'|Average|%.2lf%s');
-          $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'LAST', 'text'=>$textprefix.'|Current|%.2lf%s');
+          $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'MAX', 'text'=>$textprefix.'|'.dgettext($td, 'Maximum').'|%.2lf%s');
+          $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'AVERAGE', 'text'=>$textprefix.'|'.dgettext($td, 'Average').'|%.2lf%s');
+          $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'LAST', 'text'=>$textprefix.'|'.dgettext($td, 'Current').'|%.2lf%s');
         }
       }
     }
@@ -676,7 +720,7 @@ class rrdstat {
     $pconf = $pconf + (array)$this->config_page;
 
     $return = null;
-    switch ($pconf['type']) {
+    switch (@$pconf['type']) {
       case 'index':
         $return = $this->page_index($pconf);
         break;
@@ -707,8 +751,8 @@ class rrdstat {
 
   function page_index($pconf) {
     // create a bare, very simple index list HTML page and return it in a string
-
-    $ptitle = isset($pconf['title_page'])?$pconf['title_page']:'RRD statistics index';
+    $td = $this->mod_textdomain;
+    $ptitle = isset($pconf['title_page'])?$pconf['title_page']:dgettext($td, 'RRD statistics index');
 
     $out = '<html><head>';
     $out .= '<title>'.$ptitle.'</title>';
@@ -729,19 +773,32 @@ class rrdstat {
       $out .= '<p class="intro">'.$pconf['text_intro'].'</p>';
     }
     elseif (!isset($pconf['text_intro'])) {
-      $out .= '<p class="intro">The following RRD stats are available:</p>';
+      $out .= '<p class="intro">'.dgettext($td, 'The following RRD stats are available:').'</p>';
     }
 
     $stats = $this->h_page_statsArray($pconf);
 
+    if (isset($pconf['stats_url'])) { $sURL_base = $pconf['stats_url']; }
+    else { $sURL_base = '?stat=%i%a'; }
+
+    if (isset($pconf['stats_url_add'])) { $sURL_add = $pconf['stats_url_add']; }
+    else { $sURL_add = '&sub=%s'; }
+
     $out .= '<ul class="indexlist">';
     foreach ($stats as $stat) {
       $out .= '<li'.(isset($stat['class'])?' class="'.$stat['class'].'"':'').'>';
-      $surl = '?stat='.$stat['name'];
-      $out .= '<a href="'.$surl.'">'.$stat['name'].'</a>';
+      $sURL = str_replace('%i', $stat['name'], $sURL_base);
+      $sURL = str_replace('%a', '', $sURL);
+      $sURL = str_replace('%s', '', $sURL);
+      $out .= '<a href="'.$sURL.'">'.$stat['name'].'</a>';
       if (isset($stat['sub']) && count($stat['sub'])) {
         $sprt = array();
-        foreach ($stat['sub'] as $ssub) { $sprt[] = '<a href="'.$surl.'&sub='.$ssub.'">'.$ssub.'</a>'; }
+        foreach ($stat['sub'] as $ssub) {
+          $sURL = str_replace('%i', $stat['name'], $sURL_base);
+          $sURL = str_replace('%a', $sURL_add, $sURL);
+          $sURL = str_replace('%s', $ssub, $sURL);
+          $sprt[] = '<a href="'.$sURL.'">'.$ssub.'</a>';
+        }
         $out .= ' <span="subs">('.implode(', ', $sprt).')</span>';
       }
       $out .= '</li>';
@@ -755,8 +812,8 @@ class rrdstat {
 
   function page_overview($pconf, $graph_extras = null) {
     // create an overview HTML page (including graphs) and return it in a string
-
-    $ptitle = isset($pconf['title_page'])?$pconf['title_page']:'RRD statistics overview';
+    $td = $this->mod_textdomain;
+    $ptitle = isset($pconf['title_page'])?$pconf['title_page']:dgettext($td, 'RRD statistics overview');
 
     $out = '<html><head>';
     $out .= '<title>'.$ptitle.'</title>';
@@ -778,6 +835,12 @@ class rrdstat {
 
     $stats = $this->h_page_statsArray($pconf);
 
+    if (isset($pconf['stats_url'])) { $sURL_base = $pconf['stats_url']; }
+    else { $sURL_base = '?stat=%i%a'; }
+
+    if (isset($pconf['stats_url_add'])) { $sURL_add = $pconf['stats_url_add']; }
+    else { $sURL_add = '&sub=%s'; }
+
     $num_rows = is_numeric($pconf['num_rows'])?$pconf['num_rows']:2;
     $num_cols = ceil(count($stats)/$num_rows);
 
@@ -799,7 +862,7 @@ class rrdstat {
             $s_ptitle = $this->config_all[$sname]['page']['title_page'];
           }
           else {
-            $s_ptitle = $sname.(isset($s_psub)?' ('.$s_psub.')':'').' statistics';
+            $s_ptitle = isset($s_psub)?sprintf(dgettext($td, '%s (%s) statistics'), $sname, $s_psub):sprintf(dgettext($td, '%s statistics'), $sname);
           }
           if (!isset($pconf['hide_titles']) || !$pconf['hide_titles']) {
             $out .= '<h2>'.$s_ptitle.'</h2>';
@@ -811,21 +874,24 @@ class rrdstat {
             $gmeta = $s_rrd->graph_plus($tframe, $g_sub);
             if (isset($pconf['graph_url'])) {
               $gURL = $pconf['graph_url'];
-              $fname = str_replace('%f', basename($gmeta['filename']), $gURL);
-              $fname = str_replace('%p', $gmeta['filename'], $gURL);
+              $gURL = str_replace('%f', basename($gmeta['filename']), $gURL);
+              $gURL = str_replace('%p', $gmeta['filename'], $gURL);
               if (substr($gURL, -1) == '/') { $gURL .= $gmeta['filename']; }
             }
             else {
               $gURL = $gmeta['filename'];
             }
-            $out .= '<a href="?stat='.$sname.(isset($s_psub)?'&sub='.$s_psub:'').'"';
+            $sURL = str_replace('%i', $sname, $sURL_base);
+            $sURL = str_replace('%a', isset($s_psub)?$sURL_add:'', $sURL);
+            $sURL = str_replace('%s', isset($s_psub)?$s_pub:'', $sURL);
+            $out .= '<a href="'.$sURL.'">';
             $out .= '<img src="'.$gURL.'"';
             $out .= ' alt="'.$s_rrd->basename.(!is_null($g_sub)?' - '.$g_sub:'').' - '.$tframe.'" class="rrdgraph"';
-            $out .= ' style="width:'.$gmeta['width'].'px;height:'.$gmeta['height'].'px;">';
-            $out .= '</a>';
+            if (isset($gmeta['width']) && isset($gmeta['height'])) { $out .= ' style="width:'.$gmeta['width'].'px;height:'.$gmeta['height'].'px;"'; }
+            $out .= '></a>';
           }
           else {
-            $out .= 'RRD error: status is "'.$s_rrd->status.'"';
+            $out .= sprintf(dgettext($td, 'RRD error: status is "%s"'), $s_rrd->status);
           }
         }
         else {
@@ -844,13 +910,14 @@ class rrdstat {
 
   function page_simple($pconf, $graph_extras = null) {
     // create a simple (MRTG-like) HTML page and return it in a string
+    $td = $this->mod_textdomain;
 
-    $ptitle = isset($pconf['title_page'])?$pconf['title_page']:$this->basename.' - RRD statistics';
+    $ptitle = isset($pconf['title_page'])?$pconf['title_page']:sprintf(dgettext($td, '%s - RRD statistics'),$this->basename);
     $gtitle = array();
-    $gtitle['day'] = isset($pconf['title_day'])?$pconf['title_day']:'Day overview (scaling 5 minutes)';
-    $gtitle['week'] = isset($pconf['title_week'])?$pconf['title_week']:'Week overview (scaling 30 minutes)';
-    $gtitle['month'] = isset($pconf['title_month'])?$pconf['title_month']:'Month overview (scaling 2 hours)';
-    $gtitle['year'] = isset($pconf['title_year'])?$pconf['title_year']:'Year overview (scaling 1 day)';
+    $gtitle['day'] = isset($pconf['title_day'])?$pconf['title_day']:dgettext($td, 'Day overview (scaling 5 minutes)');
+    $gtitle['week'] = isset($pconf['title_week'])?$pconf['title_week']:dgettext($td, 'Week overview (scaling 30 minutes)');
+    $gtitle['month'] = isset($pconf['title_month'])?$pconf['title_month']:dgettext($td, 'Month overview (scaling 2 hours)');
+    $gtitle['year'] = isset($pconf['title_year'])?$pconf['title_year']:dgettext($td, 'Year overview (scaling 1 day)');
 
     $out = '<html><head>';
     $out .= '<title>'.$ptitle.'</title>';
@@ -871,7 +938,12 @@ class rrdstat {
 
     $out .= '<h1>'.$ptitle.'</h1>';
     if (!isset($pconf['show_update']) || $pconf['show_update']) {
-      $out .= '<p class="last_up">Last Update: '.(is_null($this->last_update())?'unknown':date('Y-m-d H:i:s', $this->last_update())).'</p>';
+      $out .= '<p class="last_up">';
+      if (is_null($this->last_update())) { $up_time = dgettext($td, 'unknown'); }
+      elseif (class_exists('baseutils')) { $up_time = baseutils::dateFormat($this->last_update(), 'short'); }
+      else { $up_time = date('Y-m-d H:i:s', $this->last_update()); }
+      $out .= sprintf(dgettext($td, 'Last Update: %s'), $up_time);
+      $out .= '</p>';
     }
 
     $g_sub = isset($pconf['graph_sub'])?$pconf['graph_sub']:null;
@@ -880,8 +952,8 @@ class rrdstat {
         $gmeta = $this->graph_plus($tframe, $g_sub, $graph_extras);
         if (isset($pconf['graph_url'])) {
           $gURL = $pconf['graph_url'];
-          $fname = str_replace('%f', basename($gmeta['filename']), $gURL);
-          $fname = str_replace('%p', $gmeta['filename'], $gURL);
+          $gURL = str_replace('%f', basename($gmeta['filename']), $gURL);
+          $gURL = str_replace('%p', $gmeta['filename'], $gURL);
           if (substr($gURL, -1) == '/') { $gURL .= $gmeta['filename']; }
         }
         else {
@@ -892,7 +964,8 @@ class rrdstat {
         $out .= '<h2>'.$gtitle[$tframe].'</h2>';
         $out .= '<img src="'.$gURL.'"';
         $out .= ' alt="'.$this->basename.(!is_null($g_sub)?' - '.$g_sub:'').' - '.$tframe.'" class="rrdgraph"';
-        $out .= ' style="width:'.$gmeta['width'].'px;height:'.$gmeta['height'].'px;">';
+        if (isset($gmeta['width']) && isset($gmeta['height'])) { $out .= ' style="width:'.$gmeta['width'].'px;height:'.$gmeta['height'].'px;"'; }
+        $out .= '>';
         if (isset($gmeta['data']) && count($gmeta['data'])) {
           $out .= '<table class="gdata">';
           foreach ($gmeta['data'] as $field=>$gdata) {
@@ -918,7 +991,7 @@ class rrdstat {
       }
     }
     else {
-      $out .= 'RRD error: status is "'.$this->status.'"';
+      $out .= sprintf(dgettext($td, 'RRD error: status is "%s"'), $this->status);
     }
 
     $out .= $this->h_page_footer();
@@ -969,8 +1042,9 @@ class rrdstat {
   function h_page_footer() {
     // return generic page footer
     $out = '<p class="footer">';
-    $out .= 'Statistics created by <a href="http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/">RRDtool</a>';
-    $out .= ' using a library created by <a href="http://www.kairo.at/">KaiRo.at</a>.';
+    $out .= sprintf(dgettext($this->mod_textdomain, 'Statistics created with %s using a library created by %s.'),
+                    '<a href="http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/">RRDtool</a>',
+                    '<a href="http://www.kairo.at/">KaiRo.at</a>');
     $out .= '</p>';
   return $out;
   }