add desc option for graph rows to display a different description in text table than...
[php-utility-classes.git] / include / classes / rrdstat.php-class
index 9adb461d1e5232ddb9da72c315c9638e6d1e7cd1..015d5750f8423aef34d42ab04cd9b6ed5bb69a97 100644 (file)
@@ -3,6 +3,7 @@
 class rrdstat {
 
   var $rrd_file = null;
+  var $basename = null;
 
   var $config_raw = null;
   var $config_graph = null;
@@ -22,7 +23,7 @@ class rrdstat {
     if (!is_null($this->rrd_file)) {
       if (!is_writeable($this->rrd_file)) {
         if (!file_exists($this->rrd_file)) {
-          if (touch($this->rrd_file)) { $this->create(); }
+          if (@touch($this->rrd_file)) { $this->create(); }
           else { trigger_error('RRD file can not be created', E_USER_WARNING); }
         }
         else {
@@ -61,6 +62,7 @@ class rrdstat {
     if (!isset($iinfo['file'])) { return false; }
 
     $this->rrd_file = $iinfo['file'];
+    $this->basename = (substr($this->rrd_file, -4) == '.rrd')?substr($this->rrd_file, 0, -4):$this->rrd_file;
 
     // fields (data sources, DS)
     //  name - DS name
@@ -136,9 +138,10 @@ class rrdstat {
         }
       }
     }
-    $output = array(); $return_var = null;
-    exec($create_cmd, $output, $return_var);
-    if ($return_var) { trigger_error('rrd create returned with value '.$return_var, E_USER_WARNING); }
+    $return = `$create_cmd 2>&1`;
+    if (strpos($return, 'ERROR') !== false) {
+      trigger_error($this->rrd_file.' - rrd create error: '.$return, E_USER_WARNING);
+    }
     else { $this->status = 'ok'; }
   }
 
@@ -151,9 +154,12 @@ class rrdstat {
       if (!is_null($evalcode)) {
         ob_start();
         eval($evalcode);
-        $upvals = explode("\n", ob_get_contents());
+        $ret = ob_get_contents();
+        if (strlen($ret)) { $upvals = explode("\n", $ret); }
         ob_end_clean();
       }
+      $walkfunc = create_function('&$val,$key', '$val = is_numeric($val)?$val:"U";');
+      array_walk($upvals, $walkfunc);
     }
     else {
       foreach ($this->rrd_fields as $ds) {
@@ -190,10 +196,17 @@ class rrdstat {
         $upvals[] = is_null($val)?'U':$val;
       }
     }
-    $update_cmd = 'rrdtool update '.$this->rrd_file.' N:'.implode(':', $upvals);
-    $output = array(); $return_var = null;
-    exec($update_cmd, $output, $return_var);
-    if ($return_var) { trigger_error('rrd update returned with value '.$return_var, E_USER_WARNING); }
+    $return = null;
+    if (count($upvals)) {
+      $update_cmd = 'rrdtool update '.$this->rrd_file.' N:'.implode(':', $upvals);
+      $return = `$update_cmd 2>&1`;
+    }
+
+    if (strpos($return, 'ERROR') !== false) {
+      trigger_error($this->rrd_file.' - rrd update error: '.$return, E_USER_WARNING);
+      $success = false;
+    }
+    else { $success = true; }
   return ($return_var == 0);
   }
 
@@ -214,7 +227,7 @@ class rrdstat {
     $return = `$fetch_cmd 2>&1`;
 
     if (strpos($return, 'ERROR') !== false) {
-      trigger_error('rrd fetch error: '.$return, E_USER_WARNING);
+      trigger_error($this->rrd_file.' - rrd fetch error: '.$return, E_USER_WARNING);
       $fresult = false;
     }
     else {
@@ -269,7 +282,7 @@ class rrdstat {
     }
 
     if (isset($gconf['filename'])) { $fname = $gconf['filename']; }
-    else { $fname = str_replace('.rrd', (is_null($sub)?'':'-%s').'-%t%f', $this->rrd_file); }
+    else { $fname = $this->basename.(is_null($sub)?'':'-%s').'-%t%f'; }
     $fname = str_replace('%s', strval($sub), $fname);
     $fname = str_replace('%t', $timeframe, $fname);
     $fname = str_replace('%f', $fmt_ext, $fname);
@@ -306,8 +319,8 @@ class rrdstat {
       $duration = isset($gconf['duration'])?$gconf['duration']:396*86400; // 365+31 days
       $slice = isset($gconf['slice'])?$gconf['slice']:86400; // 1 day
       // vertical lines at month borders
-      $addSpecial .= ' VRULE:'.strtotime(date('Y-01-01')).'#FF0000';
-      $addSpecial .= ' VRULE:'.strtotime(date('Y-01-01').' -1 year').'#FF0000';
+      $addSpecial .= ' VRULE:'.strtotime(date('Y-01-01 12:00:00')).'#FF0000';
+      $addSpecial .= ' VRULE:'.strtotime(date('Y-01-01 12:00:00').' -1 year').'#FF0000';
     }
     else {
       $duration = isset($gconf['duration'])?$gconf['duration']:$this->rrd_step*500; // 500 steps
@@ -343,6 +356,7 @@ class rrdstat {
             if (!isset($gconf['show_legend'])) { $gconf['show_legend'] = true; }
           }
           if (isset($erow['stack'])) { $grow['stack'] = ($erow['stack'] == true); }
+          if (isset($erow['desc'])) { $grow['desc'] = $erow['desc']; }
           $graphrows[] = $grow;
         }
       }
@@ -392,7 +406,7 @@ class rrdstat {
     else {
       foreach ($graphrows as $grow) {
         if (isset($grow['gType']) && strlen($grow['gType'])) {
-          $textprefix = isset($grow['legend'])?$grow['legend']:$grow['name'];
+          $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');
@@ -455,7 +469,7 @@ class rrdstat {
     $return = `$graph_cmd 2>&1`;
 
     if (strpos($return, 'ERROR') !== false) {
-      trigger_error('rrd graph error: '.$return, E_USER_WARNING);
+      trigger_error($this->rrd_file.' - rrd graph error: '.$return, E_USER_WARNING);
       $return = $graph_cmd."\n\n".$return;
     }
     $return = 'file:'.$fname."\n".$return;
@@ -464,7 +478,6 @@ class rrdstat {
 
   function simple_html($sub = null, $page_extras = null, $graph_extras = null) {
     // create a simple (MRTG-like) HTML page and return it in a string
-    $basename = str_replace('.rrd', '', $this->rrd_file);
 
     // assemble configuration
     $pconf = (array)$page_extras;
@@ -473,7 +486,7 @@ class rrdstat {
     }
     $pconf = $pconf + (array)$this->config_page;
 
-    $ptitle = isset($pconf['title_page'])?$pconf['title_page']:$basename.' - RRD statistics';
+    $ptitle = isset($pconf['title_page'])?$pconf['title_page']:$this->basename.' - RRD statistics';
     $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)';
@@ -499,7 +512,7 @@ class rrdstat {
 
     $out .= '<h1>'.$ptitle.'</h1>';
     if (!isset($pconf['show_update']) || $pconf['show_update']) {
-      $out .= '<p class="last_up">Last Update: '.date('Y-m-d H:i:s', $this->last_update()).'</p>';
+      $out .= '<p class="last_up">Last Update: '.(is_null($this->last_update())?'unknown':date('Y-m-d H:i:s', $this->last_update())).'</p>';
     }
 
     if (in_array($this->status, array('ok','readonly'))) {
@@ -528,7 +541,7 @@ class rrdstat {
             $gmeta['info'][] = $gline;
           }
         }
-        if (is_null($gfilename)) { $gfilename = $basename.(!is_null($g_sub)?'-'.$g_sub:'').'-'.$tframe.'.png'; }
+        if (is_null($gfilename)) { $gfilename = $this->basename.(!is_null($g_sub)?'-'.$g_sub:'').'-'.$tframe.'.png'; }
         if (isset($pconf['graph_url'])) {
           $gURL = $pconf['graph_url'];
           $fname = str_replace('%f', basename($gfilename), $gURL);
@@ -542,7 +555,7 @@ class rrdstat {
 //         $out .= '<p>'.nl2br($ret).'</p>';
         $out .= '<h2>'.$gtitle[$tframe].'</h2>';
         $out .= '<img src="'.$gURL.'"';
-        $out .= ' alt="'.$basename.(!is_null($g_sub)?' - '.$g_sub:'').' - '.$tframe.'" class="rrdgraph"';
+        $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['data']) && count($gmeta['data'])) {
           $out .= '<table class="gdata">';