some minor corrections; make this first rrd test really work
[php-utility-classes.git] / include / classes / rrdstat.php-class
index 680516c136f8eb3594d9939534d79d5eeefb5db9..0cc03ef556fc62aada4882a69cef84bc2c8d6fdf 100644 (file)
@@ -1,6 +1,130 @@
 <?php
-// ************ RRD status class **************
+/* ***** BEGIN LICENSE BLOCK *****
+ *
+ * The contents of this file are subject to Austrian copyright reegulations
+ * ("Urheberrecht"); you may not use this file except in compliance with
+ * those laws.
+ * This contents and any derived work, if it gets distributed in any way,
+ * is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND,
+ * either express or implied.
+ *
+ * The Original Code is KaiRo's RRD statistics class.
+ *
+ * The Initial Developer of the Original Code is
+ * KaiRo - Robert Kaiser.
+ * Portions created by the Initial Developer are Copyright (C) 2005
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s): Robert Kaiser <kairo@kairo.at>
+ *
+ * ***** END LICENSE BLOCK ***** */
+
 class rrdstat {
+  // rrdstat PHP class
+  // rrdtool statistics functions
+  //
+  // function rrdstat($rrdconfig, [$conf_id])
+  //   CONSTRUCTOR
+  //     if $conf_id is set, $rrdconfig is a total configuration set
+  //     else it's the configuration for this one RRD
+  //     currently only a config array is supported, XML config is planned
+  //
+  // var $rrd_file
+  // RRD file name
+  //
+  // var $basename
+  // base name for this RRD (usually file name without .rrd)
+  //
+  // var $config_all
+  // complete, raw configuration array set
+  //
+  // var $config_raw
+  // configuration array set for current RRD
+  //
+  // var $config_graph
+  // configuration array set for default graph in this RRD
+  //
+  // var $config_page
+  // configuration array set for default page in this RRD
+  //
+  // var $rrd_fields
+  // definition of this RRD's fields
+  //
+  // var $rra_base
+  // definition of this RRD's base RRAs
+  //
+  // var $rrd_step
+  // basic stepping of this RRD in seconds (default: 300)
+  //
+  // var $rra_add_max
+  // should RRAs for MAX be added for every base RRA? (bool, default: true)
+  //
+  // var $status
+  // status of the RRD (unused/ok/readonly/graphonly)
+  //   note that most functions require certain status values
+  //   (e.g. update only works if status is ok, graph for ok/readonly/graphonly)
+  //
+  // function set_def($rrdconfig, [$conf_id])
+  //   set definitions based on given configuration
+  //   [intended for internal use, called by the constructor]
+  //
+  // function create()
+  //   create RRD file according to set config
+  //
+  // function update([$upArray])
+  //   feed new data into RRD (either use given array of values or use auto-update info from config)
+  //
+  // function fetch([$cf] = 'AVERAGE', $resolution = null, $start = null, $end = null)
+  //   fetch data from the defined RRD
+  //     using given consolidation function [default is AVERAGE],
+  //     resolution (seconds, default is the RRD's stepping),
+  //     start and end times (unix epoch, defaults are the RRD's last update time)
+  //
+  // function last_update()
+  //   fetch time of last update in this RRD file
+  //
+  // function graph([$timeframe], [$sub], [$extra])
+  //   create a RRD graph (and return all meta info in a flat string)
+  //     for given timeframe (day [default]/week/month/year),
+  //     sub-graph ID (if given) and extra config options (if given)
+  //
+  // function graph_plus([$timeframe], [$sub], [$extra])
+  //   create a RRD graph (see above) and return meta info as a ready-to-use array
+  //
+  // function page([$sub], [$page_extras], [$graph_extras])
+  //   create a (HTML) page and return it in a string
+  //     for given sub-page ID (if given, default is a simple HTML page)
+  //     and extra page and graph config options (if given)
+  //
+  // function simple_html([$sub], [$page_extras], [$graph_extras])
+  //   create a simple (MRTG-like) HTML page and return it in a string
+  //   XXX: this is here temporarily for compat only, it's preferred to use page()!
+  //
+  // function page_index($pconf)
+  //   create a bare, very simple index list HTML page and return it in a string
+  //   using given page config options
+  //   [intended for internal use, called by page()]
+  //
+  // function page_overview($pconf, [$graph_extras])
+  //   create an overview HTML page (including graphs) and return it in a string
+  //   using given page config options and extra graph options (if given)
+  //   [intended for internal use, called by page()]
+  //
+  // function page_simple($pconf, [$graph_extras])
+  //   create a simple (MRTG-like) HTML page and return it in a string
+  //   using given page config options and extra graph options (if given)
+  //   [intended for internal use, called by page()]
+  //
+  // function h_page_statsArray($pconf)
+  //   return array of stats to list on a page, using given page config options
+  //   [intended for internal use, called by page_*()]
+  //
+  // function h_page_footer()
+  //   return generic page footer
+  //   [intended for internal use, called by page_*()]
+  //
+  // function text_quote($text)
+  //   return a quoted/escaped text for use in rrdtool commandline text fields
 
   var $rrd_file = null;
   var $basename = null;
@@ -162,19 +286,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) {
@@ -182,7 +310,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';
@@ -196,11 +324,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();
@@ -208,12 +340,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)) {
+      // 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`;
     }
 
@@ -222,7 +366,7 @@ class rrdstat {
       $success = false;
     }
     else { $success = true; }
-  return ($return_var == 0);
+  return $success;
   }
 
   function fetch($cf = 'AVERAGE', $resolution = null, $start = null, $end = null) {
@@ -254,7 +398,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);