[php-utility-classes.git] / include / classes / rrdstat.php-class

<?php
/* ***** 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 $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
  //
  // 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;
  var $basedir = null;

  var $config_all = null;
  var $config_raw = null;
  var $config_graph = null;
  var $config_page = null;

  var $rrd_fields = array();
  var $rra_base = array();
  var $rrd_step = 300;
  var $rra_add_max = true;

  var $status = 'unused';

  function rrdstat($rrdconfig, $conf_id = null) {
    // ***** init RRD stat module *****
    $this->set_def($rrdconfig, $conf_id);

    if (($this->status == 'unused') && !is_null($this->rrd_file)) {
      if (!is_writeable($this->rrd_file)) {
        if (!file_exists($this->rrd_file)) {
          if (@touch($this->rrd_file)) { $this->create(); }
          else { trigger_error('RRD file can not be created', E_USER_WARNING); }
        }
        else {
          if (is_readable($this->rrd_file)) { $this->status = 'readonly'; }
          else { trigger_error('RRD file is not readable', E_USER_WARNING); }
        }
      }
      else {
        $this->status = 'ok';
      }
    }
  }

  function set_def($rrdconfig, $conf_id = null) {
    if (is_array($rrdconfig)) {
      // we have an array in the format we like to have
      $complete_conf =& $rrdconfig;
    }
    else {
      // we have something else (XML data?), try to generate the iinfo aray from it
      $complete_conf =& $rrdconfig;
    }

    if (!is_null($conf_id)) {
      $iinfo = isset($complete_conf[$conf_id])?$complete_conf[$conf_id]:array();
      if (isset($complete_conf['*'])) {
        $iinfo = (array)$iinfo + (array)$complete_conf['*'];
        if (isset($complete_conf['*']['graph'])) { $iinfo['graph'] = (array)$iinfo['graph'] + (array)$complete_conf['*']['graph']; }
        if (isset($complete_conf['*']['page'])) { $iinfo['page'] = (array)$iinfo['page'] + (array)$complete_conf['*']['page']; }
      }
    }
    else {
      $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']{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 = (($iinfo['file']{0} != '/')?$this->basedir:'').$conf_id.'.rrd';
      $this->basename = $conf_id;
    }
    else {
      $this->basename = !is_null($conf_id)?$conf_id:'xxx.unknown';
    }

    if (!is_null($this->rrd_file)) {
      // fields (data sources, DS)
      //  name - DS name
      //  type - one of COUNTER, GAUGE, DERIVE, ABSOLUTE
      //  heartbeat - if no sample recieved for that time, store UNKNOWN
      //  min - U (unconstrained) or minimum value
      //  max - U (unconstrained) or maximum value
      //  update - this string will be fed into eval() for updating this field
      if (isset($iinfo['fields']) && is_array($iinfo['fields'])) {
        $this->rrd_fields = $iinfo['fields'];
      }
      else {
        $this->rrd_fields[] = array('name' => 'ds0', 'type' => 'COUNTER', 'heartbeat' => 600, 'min' => 'U', 'max' => 'U');
        $this->rrd_fields[] = array('name' => 'ds1', 'type' => 'COUNTER', 'heartbeat' => 600, 'min' => 'U', 'max' => 'U');
      }


      // MRTG-style RRD "database", see http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/tut/rrdtutorial.en.html
      //
      // archives (RRAs):
      // 600 samples of 5 minutes  (2 days and 2 hours)
      // 700 samples of 30 minutes (2 days and 2 hours, plus 12.5 days)
      // 775 samples of 2 hours    (above + 50 days)
      // 797 samples of 1 day      (above + 732 days, rounded up to 797)

      $this->rrd_step = isset($iinfo['rrd_step'])?$iinfo['rrd_step']:300;

      if (isset($iinfo['rra_base']) && is_array($iinfo['rra_base'])) {
        $this->rra_base = $iinfo['rra_base'];
      }
      else {
        $this->rra_base[] = array('step' => 1, 'rows' => 600);
        $this->rra_base[] = array('step' => 6, 'rows' => 700);
        $this->rra_base[] = array('step' => 24, 'rows' => 775);
        $this->rra_base[] = array('step' => 288, 'rows' => 797);
      }

      $this->rra_add_max = isset($iinfo['rra_add_max'])?$iinfo['rra_add_max']:true;
    }

    if (isset($iinfo['graph'])) { $this->config_graph = $iinfo['graph']; }
    if (isset($iinfo['page'])) { $this->config_page = $iinfo['page']; }
    $this->config_raw = $iinfo;
    $this->config_all = $complete_conf;
  }

  function create() {
    // create RRD file

    // compose create command
    $create_cmd = 'rrdtool create '.$this->rrd_file.' --step '.$this->rrd_step;
    foreach ($this->rrd_fields as $ds) {
      if (!isset($ds['type'])) { $ds['type'] = 'COUNTER'; }
      if (!isset($ds['heartbeat'])) { $ds['heartbeat'] = 2*$this->rrd_step; }
      if (!isset($ds['min'])) { $ds['min'] = 'U'; }
      if (!isset($ds['max'])) { $ds['max'] = 'U'; }
      $create_cmd .= ' DS:'.$ds['name'].':'.$ds['type'].':'.$ds['heartbeat'].':'.$ds['min'].':'.$ds['max'];
    }
    foreach ($this->rra_base as $rra) {
      if (!isset($rra['cf'])) { $rra['cf'] = 'AVERAGE'; }
      if (!isset($rra['xff'])) { $rra['xff'] = 0.5; }
      if (!isset($rra['step'])) { $rra['step'] = 1; }
      if (!isset($rra['rows'])) { $rra['rows'] = 600; }
      $create_cmd .= ' RRA:'.$rra['cf'].':'.$rra['xff'].':'.$rra['step'].':'.$rra['rows'];
    }
    if ($this->rra_add_max) {
      foreach ($this->rra_base as $rra) {
        if (!isset($rra['cf'])) {
          // only rows that have no CF set will be looked at here
          $rra['cf'] = 'MAX';
          if (!isset($rra['xff'])) { $rra['xff'] = 0.5; }
          if (!isset($rra['step'])) { $rra['step'] = 1; }
          if (!isset($rra['rows'])) { $rra['rows'] = 600; }
          $create_cmd .= ' RRA:'.$rra['cf'].':'.$rra['xff'].':'.$rra['step'].':'.$rra['rows'];
        }
      }
    }
    $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'; }
  }

  function update($upArray = null) {
    // feed new data into RRD
    if ($this->status != 'ok') { trigger_error('Cannot update non-writeable file', E_USER_WARNING); return false; }
    $upvals = array();
    if (isset($this->config_raw['update'])) {
      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();
        }
      }
    }
    else {
      foreach ($this->rrd_fields as $ds) {
        if (is_array($upArray) && isset($upArray[$ds['name']])) { $val = $upArray[$ds['name']]; }
        elseif (isset($ds['update'])) {
          $val = null; $evalcode = null;
          if (substr($ds['update'], 0, 4) == 'val:') {
            $evalcode = 'function { return trim('.substr($ds['update'], 4).')); }';
          }
          elseif (substr($ds['update'], 0, 8) == 'snmp-if:') {
            $snmphost = 'localhost'; $snmpcomm = 'public';
            list($nix, $ifname, $valtype) = explode(':', $ds['update'], 3);
            $iflist = explode("\n", `snmpwalk -v2c -c $snmpcomm $snmphost interfaces.ifTable.ifEntry.ifDescr`);
            $ifnr = null;
            foreach ($iflist as $ifdesc) {
              if (preg_match('/ifDescr\.(\d+) = STRING: '.$ifname.'/', $ifdesc, $regs)) { $ifnr = $regs[1]; }
            }
            $oid = null;
            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 = 'function { return trim(substr(strrchr(`snmpget -v2c -c '.$snmpcomm.' '.$snmphost.' '.$oid.'`,":"),1)); }';
            }
          }
          else { $evalcode = $ds['update']; }
          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();
            ob_end_clean();
          }
        }
        else { $val = null; }
        $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.($key_names?' --template '.implode(':', array_keys($upvals)):'').' 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 $success;
  }

  function fetch($cf = 'AVERAGE', $resolution = null, $start = null, $end = null) {
    // fetch data from a RRD
    if (!in_array($this->status, array('ok','readonly'))) { trigger_error('Error: rrd status is '.$this->status, E_USER_WARNING); return false; }

    if (!in_array($cf, array('AVERAGE','MIN','MAX','LAST'))) { $cf = 'AVERAGE'; }
    if (!is_numeric($resolution)) { $resolution = $this->rrd_step; }
    if (!is_numeric($end)) { $end = $this->last_update(); }
    elseif ($end < 0) { $end += $this->last_update(); }
    $end = intval($end/$resolution)*$resolution;
    if (!is_numeric($start)) { $start = $end; }
    elseif ($start < 0) { $start += $end; }
    $start = intval($start/$resolution)*$resolution;

    $fetch_cmd = 'rrdtool fetch '.$this->rrd_file.' '.$cf.' --resolution '.$resolution.' --start '.$start.' --end '.$end;
    $return = `$fetch_cmd 2>&1`;

    if (strpos($return, 'ERROR') !== false) {
      trigger_error($this->rrd_file.' - rrd fetch error: '.$return, E_USER_WARNING);
      $fresult = false;
    }
    else {
      $fresult = array();
      $rows = explode("\n", $return);
      $fields = preg_split('/\s+/', array_shift($rows));
      if (array_shift($fields) == 'timestamp') {
        $fresult[0] = $fields;
        foreach ($rows as $row) {
          if (strlen(trim($row))) {
            $rvals = preg_split('/\s+/', $row);
            $rtime = str_replace(':', '', array_shift($rvals));
            $rv_array = array();
            foreach ($rvals as $key=>$rval) {
              $rv_array[$fields[$key]] = ($rval=='nan')?null:floatval($rval);
            }
            $fresult[$rtime] = $rv_array;
          }
        }
      }
    }
  return $fresult;
  }

  function last_update() {
    // fetch time of last update in this RRD file
    static $last_update;
    if (!isset($last_update) && in_array($this->status, array('ok','readonly'))) {
      $last_cmd = 'rrdtool last '.$this->rrd_file;
      $return = trim(`$last_cmd 2>&1`);
      $last_update = is_numeric($return)?$return:null;
    }
  return isset($last_update)?$last_update:null;
  }

  function graph($timeframe = 'day', $sub = null, $extra = null) {
    // create a RRD graph
    static $gColors;
    if (!isset($gColors)) {
      $gColors = array('#00CC00','#0000FF','#000000','#FF0000','#00FF00','#FFFF00','#FF00FF','#00FFFF','#808080','#800000','#008000','#000080','#808000','#800080','#008080','#C0C0C0');
    }

    if (!in_array($this->status, array('ok','readonly','graphonly'))) { trigger_error('Error: rrd status is '.$this->status, E_USER_WARNING); return false; }

    // assemble configuration
    $gconf = (array)$extra;
    if (!is_null($sub) && is_array($this->config_raw['graph.'.$sub])) {
      $gconf = $gconf + $this->config_raw['graph.'.$sub];
    }
    $gconf = $gconf + (array)$this->config_graph;

    if (isset($gconf['format']) && ($gconf['format'] == 'SVG')) {
      $format = $gconf['format']; $fmt_ext = '.svg';
    }
    elseif (isset($gconf['format']) && ($gconf['format'] == 'EPS')) {
      $format = $gconf['format']; $fmt_ext = '.eps';
    }
    elseif (isset($gconf['format']) && ($gconf['format'] == 'PDF')) {
      $format = $gconf['format']; $fmt_ext = '.pdf';
    }
    else {
      $format = 'PNG'; $fmt_ext = '.png';
    }

    if (isset($gconf['filename'])) { $fname = $gconf['filename']; }
    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);
    if (substr($fname, -strlen($fmt_ext)) != $fmt_ext) { $fname .= $fmt_ext; }
    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;
    $gDefs = ''; $gGraphs = ''; $addSpecial = '';

    if ($timeframe == 'day') {
      $duration = isset($gconf['duration'])?$gconf['duration']:30*3600; // 30 hours
      $slice = isset($gconf['slice'])?$gconf['slice']:300; // 5 minutes
      // vertical lines at day borders
      $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d')).'#FF0000';
      $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d').' -1 day').'#FF0000';
      if (!isset($gconf['grid_x'])) { $gconf['grid_x'] = 'HOUR:1:HOUR:6:HOUR:2:0:%-H'; }
    }
    elseif ($timeframe == 'week') {
      $duration = isset($gconf['duration'])?$gconf['duration']:8*86400; // 8 days
      $slice = isset($gconf['slice'])?$gconf['slice']:1800; // 30 minutes
      // vertical lines at week borders
      $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d').' '.(-date('w')+1).' day').'#FF0000';
      $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d').' '.(-date('w')-6).' day').'#FF0000';
    }
    elseif ($timeframe == 'month') {
      $duration = isset($gconf['duration'])?$gconf['duration']:36*86400; // 36 days
      $slice = isset($gconf['slice'])?$gconf['slice']:7200; // 2 hours
      // vertical lines at month borders
      $addSpecial .= ' VRULE:'.strtotime(date('Y-m-01')).'#FF0000';
      $addSpecial .= ' VRULE:'.strtotime(date('Y-m-01').' -1 month').'#FF0000';
    }
    elseif ($timeframe == 'year') {
      $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 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
      $slice = isset($gconf['slice'])?$gconf['slice']:$this->rrd_step; // whatever our step is
    }

    if (isset($gconf['rows']) && count($gconf['rows'])) {
      foreach ($gconf['rows'] as $erow) {
        if (isset($erow['name']) && strlen($erow['name'])) {
          if (!isset($erow['scale']) && isset($gconf['scale'])) { $erow['scale'] = $gconf['scale']; }
          $grow = array();
          $grow['dType'] = isset($erow['dType'])?$erow['dType']:'DEF';
          $grow['name'] = $erow['name'].(isset($erow['scale'])?'_tmp':'');
          if ($grow['dType'] == 'DEF') {
            $grow['dsname'] = isset($erow['dsname'])?$erow['dsname']:$erow['name'];
            if (isset($erow['dsfile'])) { $grow['dsfile'] = $erow['dsfile']; }
            $grow['cf'] = isset($erow['cf'])?$erow['cf']:'AVERAGE';
          }
          else {
            $grow['rpn_expr'] = isset($erow['rpn_expr'])?$erow['rpn_expr']:'0';
          }
          if (isset($erow['scale'])) {
            $graphrows[] = $grow;
            $grow = array();
            $grow['dType'] = 'CDEF';
            $grow['name'] = $erow['name'];
            $grow['rpn_expr'] = $erow['name'].'_tmp,'.$erow['scale'].',*';
          }
          $grow['gType'] = isset($erow['gType'])?$erow['gType']:'LINE1';
          $grow['color'] = isset($erow['color'])?$erow['color']:$gColors[$gC++];
          if ($gC >= count($gColors)) { $gC = 0; }
          if (isset($erow['legend'])) {
            $grow['legend'] = $erow['legend'];
            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;
        }
      }
    }
    else {
      foreach ($this->rrd_fields as $key=>$ds) {
        $grow = array();
        $grow['dType'] = 'DEF';
        $grow['name'] = $ds['name'].(isset($gconf['scale'])?'_tmp':'');
        $grow['dsname'] = $ds['name'];
        $grow['cf'] = 'AVERAGE';
        if (isset($gconf['scale'])) {
          $graphrows[] = $grow;
          $grow = array();
          $grow['dType'] = 'CDEF';
          $grow['name'] = $ds['name'];
          $grow['rpn_expr'] = $ds['name'].'_tmp,'.$gconf['scale'].',*';
        }
        $grow['gType'] = ((count($this->rrd_fields)==2) && ($key==0))?'AREA':'LINE1';
        $grow['color'] = $gColors[$gC++]; if ($gC >= count($gColors)) { $gC = 0; }
        if (isset($ds['legend'])) {
          $grow['legend'] = $ds['legend'];
          if (!isset($gconf['show_legend'])) { $gconf['show_legend'] = true; }
        }
        if (isset($ds['desc'])) { $grow['desc'] = $ds['desc']; }
        $graphrows[] = $grow;
      }
    }

    if (isset($gconf['special']) && count($gconf['special'])) {
      foreach ($gconf['special'] as $crow) {
        $srow = array();
        $srow['sType'] = isset($crow['sType'])?$crow['sType']:'COMMENT';
        if ($grow['sType'] != 'COMMENT') {
          // XXX: use line below and remove cf var once we have rrdtol 1.2
          // $srow['name'] = $crow['name'].(isset($crow['cf'])?'_'.$crow['cf']:'');
          $srow['name'] = $crow['name'];
          $srow['cf'] = isset($crow['cf'])?$crow['cf']:'AVERAGE';
          if (isset($crow['cf'])) {
            // XXX: use line below once we have rrdtol 1.2
            // $graphrows[] = array('dType'=>'VDEF', 'name'=>$srow['name'].'_'.$crow['cf'], 'rpn_expr'=>$srow['name'].','.$crow['cf']);
          }
          elseif (isset($crow['rpn_expr'])) {
            // XXX: does only work with rrdtool 1.2
            $graphrows[] = array('dType'=>'VDEF', 'name'=>$srow['name'], 'rpn_expr'=>$crow['rpn_expr']);
          }
        }
        $srow['text'] = isset($crow['text'])?$crow['text']:'';
        $specialrows[] = $srow;
      }
    }
    else {
      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');
        }
      }
    }

    $endtime = isset($gconf['time_end'])?$gconf['time_end']:(is_numeric($this->last_update())?$this->last_update():time());
    $gOpts = ' --start '.($endtime-$duration).' --end '.$endtime.' --step '.$slice;
    if (isset($gconf['label_top'])) { $gOpts .= ' --title '.$this->text_quote($gconf['label_top']); }
    if (isset($gconf['label_y'])) { $gOpts .= ' --vertical-label '.$this->text_quote($gconf['label_y']); }
    if (isset($gconf['width'])) { $gOpts .= ' --width '.$gconf['width']; }
    if (isset($gconf['height'])) { $gOpts .= ' --height '.$gconf['height'];
      if (($gconf['height'] <= 32) && isset($gconf['thumb']) && ($gconf['thumb'])) { $gOpts .= ' --only-graph'; }
    }
    if (!isset($gconf['show_legend']) || (!$gconf['show_legend'])) { $gOpts .= ' --no-legend'; }
    if (isset($gconf['min_y'])) { $gOpts .= ' --lower-limit '.$gconf['min_y']; }
    if (isset($gconf['max_y'])) { $gOpts .= ' --upper-limit '.$gconf['max_y']; }
    if (isset($gconf['fix_scale_y']) && $gconf['fix_scale_y']) { $gOpts .= ' --rigid'; }
    if (isset($gconf['grid_x'])) { $gOpts .= ' --x-grid '.$gconf['grid_x']; }
    if (isset($gconf['grid_y'])) { $gOpts .= ' --y-grid '.$gconf['grid_y']; }
    if (isset($gconf['units_exponent'])) { $gOpts .= ' --units-exponent '.$gconf['units_exponent']; }
    if (isset($gconf['units_length'])) { $gOpts .= ' --units-length '.$gconf['units_length']; }
    if (!isset($gconf['force_recreate']) || (!$gconf['force_recreate'])) { $gOpts .= ' --lazy'; }
    if (isset($gconf['force_color']) && is_array($gconf['force_color'])) {
      foreach ($gconf['force_color'] as $ctag=>$cval) { $gOpts .= ' --color '.$ctag.$cval; }
    }
    if (isset($gconf['force_font']) && is_array($gconf['force_font'])) {
      foreach ($gconf['force_font'] as $ctag=>$cval) { $gOpts .= ' --font '.$ctag.$cval; }
    }
    if (isset($gconf['units_binary']) && $gconf['units_binary']) { $gOpts .= ' --base 1024'; }

    foreach ($graphrows as $grow) {
      if (isset($grow['dType']) && strlen($grow['dType'])) {
        $gDefs .= ' '.$grow['dType'].':'.$grow['name'].'=';
        if ($grow['dType'] == 'DEF') {
          $gDefs .= isset($grow['dsfile'])?$grow['dsfile']:$this->rrd_file;
          $gDefs .= ':'.$grow['dsname'].':'.$grow['cf'];
        }
        else { $gDefs .= $grow['rpn_expr']; }
      }
      if (isset($grow['gType']) && strlen($grow['gType'])) {
        // XXX: change from STACK type to STACK flag once we have rrdtool 1.2
        if (isset($grow['stack']) && $grow['stack']) { $grow['gType'] = 'STACK'; }
        $gGraphs .= ' '.$grow['gType'].':'.$grow['name'].$grow['color'];
        if (isset($grow['legend'])) { $gGraphs .= ':'.$this->text_quote($grow['legend']); }
        // XXX: remove above STACK if-command and uncomment the one below once we have rrdtool 1.2
        //if (isset($grow['stack']) && $grow['stack']) { $gGraphs .= ':STACK'; }
      }
    }

    foreach ($specialrows as $srow) {
      $addSpecial .= ' '.$srow['sType'];
      // XXX: eliminate cf once we have rrdtool 1.2
      // $addSpecial .= ($grow['sType']!='COMMENT')?':'.$grow['name']:'');
      $addSpecial .= (($srow['sType']!='COMMENT')?':'.$srow['name'].':'.$srow['cf']:'');
      $addSpecial .= ':'.$this->text_quote($srow['text']);
    }

    $graph_cmd = 'rrdtool graph '.str_replace('*', '\*', $fname.$gOpts.$gDefs.$gGraphs.$addSpecial);
    $return = `$graph_cmd 2>&1`;

    if (strpos($return, 'ERROR') !== false) {
      trigger_error($this->rrd_file.' - rrd graph error: '.$return, E_USER_WARNING);
      $return = $graph_cmd."\n\n".$return;
    }
    $return = 'file:'.$fname."\n".$return;
  return $return;
  }

  function graph_plus($timeframe = 'day', $sub = null, $extra = null) {
    // create a RRD graph and return meta info as a ready-to-use array
    $gmeta = array('filename'=>null);
    $ret = $this->graph($timeframe, $sub, $extra);
    if (strpos($ret, "\n\n") !== false) { $gmeta['graph_cmd'] = substr($ret, 0, strpos($ret, "\n\n")); $ret = substr($ret, strpos($ret, "\n\n")+2); }
    else { $gmeta['graph_cmd'] = null; }
    $grout = explode("\n", $ret);
    foreach ($grout as $gline) {
      if (preg_match('/^file:(.+)$/', $gline, $regs)) {
        $gmeta['filename'] = $regs[1];
      }
      elseif (preg_match('/^(\d+)x(\d+)$/', $gline, $regs)) {
        $gmeta['width'] = $regs[1]; $gmeta['height'] = $regs[2];
      }
      elseif (preg_match('/^([^\|]+)\|([^|]+)\|([^\|]*)$/', $gline, $regs)) {
        $gmeta['data'][$regs[1]][$regs[2]] = $regs[3];
      }
      elseif (preg_match('/^([^\|]+)\|([^\|]*)$/', $gline, $regs)) {
        $gmeta['var'][$regs[1]] = $regs[2];
      }
      elseif (strlen(trim($gline))) {
        $gmeta['info'][] = $gline;
      }
    }
    if (is_null($gmeta['filename'])) {
      $gmeta['filename'] = $this->basename.(!is_null($sub)?'-'.$sub:'').'-'.$timeframe.'.png';
    }
  return $gmeta;
  }

  function page($sub = null, $page_extras = null, $graph_extras = null) {
    // create a (HTML) page and return it in a string

    // assemble configuration
    $pconf = (array)$page_extras;
    if (!is_null($sub) && is_array($this->config_raw['page.'.$sub])) {
      $pconf = $pconf + $this->config_raw['page.'.$sub];
    }
    $pconf = $pconf + (array)$this->config_page;

    $return = null;
    switch (@$pconf['type']) {
      case 'index':
        $return = $this->page_index($pconf);
        break;
      case 'overview':
        $return = $this->page_overview($pconf, $graph_extras);
        break;
      case 'simple':
      default:
        $return = $this->page_simple($pconf, $graph_extras);
        break;
    }
  return $return;
  }

  function simple_html($sub = null, $page_extras = null, $graph_extras = null) {
    // 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()!

    // assemble configuration
    $pconf = (array)$page_extras;
    if (!is_null($sub) && is_array($this->config_raw['page.'.$sub])) {
      $pconf = $pconf + $this->config_raw['page.'.$sub];
    }
    $pconf = $pconf + (array)$this->config_page;

  return $this->page_simple($pconf, $graph_extras);
  }

  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';

    $out = '<html><head>';
    $out .= '<title>'.$ptitle.'</title>';
    $out .= '<style>';
    if (isset($pconf['style_base'])) { $out .= $pconf['style_base']; }
    else {
      $out .= 'h1 { font-weight: bold; font-size: 1.5em; }';
      $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }';
      $out .= 'li.scanfile { font-style: italic; }';
    }
    if (isset($pconf['style'])) { $out .= $pconf['style']; }
    $out .= '</style>';
    $out .= '</head>';
    $out .= '<body>';

    $out .= '<h1>'.$ptitle.'</h1>';
    if (isset($pconf['text_intro']) && strlen($pconf['text_intro'])) {
      $out .= '<p class="intro">'.$pconf['text_intro'].'</p>';
    }
    elseif (!isset($pconf['text_intro'])) {
      $out .= '<p class="intro">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 = 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) {
          $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>';
    }
    $out .= '</ul>';

    $out .= $this->h_page_footer();
    $out .= '</body></html>';
  return $out;
  }

  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';

    $out = '<html><head>';
    $out .= '<title>'.$ptitle.'</title>';
    $out .= '<style>';
    if (isset($pconf['style_base'])) { $out .= $pconf['style_base']; }
    else {
      $out .= 'h1 { font-weight: bold; font-size: 1.5em; }';
      $out .= 'h2 { font-weight: bold; font-size: 1em; margin: 0.5em 0; }';
      $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }';
      $out .= 'img.rrdgraph { border: none; }';
    }
    if (isset($pconf['style'])) { $out .= $pconf['style']; }
    $out .= '</style>';
    $out .= '</head>';
    $out .= '<body>';

    $out .= '<h1>'.$ptitle.'</h1>';
    if (isset($pconf['text_intro'])) { $out .= '<p class="intro">'.$pconf['text_intro'].'</p>'; }

    $stats = $this->h_page_statsArray($pconf);

    $num_rows = is_numeric($pconf['num_rows'])?$pconf['num_rows']:2;
    $num_cols = ceil(count($stats)/$num_rows);

    $out .= '<table class="overview">';
    for ($col = 0; $col < $num_cols; $col++) {
      $out .= '<tr>';
      for ($row = 0; $row < $num_rows; $row++) {
        $idx = $col * $num_rows + $row;
        $out .= '<td>';
        if ($idx < count($stats)) {
          list($sname, $s_psub) = explode('|', $stats[$idx]['name'], 2);
          $s_psname = 'page'.(isset($s_psub)?'.'.$s_psub:'');
          $g_sub = $this->config_all[$sname][$s_psname]['graph_sub'];

          if (isset($this->config_all[$sname][$s_psname]['title_page'])) {
            $s_ptitle = $this->config_all[$sname][$s_psname]['title_page'];
          }
          elseif (isset($this->config_all[$sname]['page']['title_page'])) {
            $s_ptitle = $this->config_all[$sname]['page']['title_page'];
          }
          else {
            $s_ptitle = $sname.(isset($s_psub)?' ('.$s_psub.')':'').' statistics';
          }
          if (!isset($pconf['hide_titles']) || !$pconf['hide_titles']) {
            $out .= '<h2>'.$s_ptitle.'</h2>';
          }

          $s_rrd = new rrdstat($this->config_all, $sname);
          if (in_array($s_rrd->status, array('ok','readonly','graphonly'))) {
            $tframe = isset($pconf['graph_timeframe'])?$pconf['graph_timeframe']:'day';
            $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);
              if (substr($gURL, -1) == '/') { $gURL .= $gmeta['filename']; }
            }
            else {
              $gURL = $gmeta['filename'];
            }
            $out .= '<a href="?stat='.$sname.(isset($s_psub)?'&sub='.$s_psub:'').'"';
            $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>';
          }
          else {
            $out .= 'RRD error: status is "'.$s_rrd->status.'"';
          }
        }
        else {
          $out .= '&nbsp;';
        }
        $out .= '</td>';
      }
      $out .= '</tr>';
    }
    $out .= '</table>';

    $out .= $this->h_page_footer();
    $out .= '</body></html>';
  return $out;
  }

  function page_simple($pconf, $graph_extras = null) {
    // create a simple (MRTG-like) HTML page and return it in a string

    $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)';
    $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)';

    $out = '<html><head>';
    $out .= '<title>'.$ptitle.'</title>';
    $out .= '<style>';
    if (isset($pconf['style_base'])) { $out .= $pconf['style_base']; }
    else {
      $out .= 'h1 { font-weight: bold; font-size: 1.5em; }';
      $out .= 'h2 { font-weight: bold; font-size: 1em; }';
      $out .= '.gdata, .gvar, .ginfo { font-size: 0.75em; margin: 0.5em 0; }';
      $out .= 'table.gdata { border: 1px solid gray; border-collapse: collapse; }';
      $out .= 'table.gdata td, table.gdata th { border: 1px solid gray; padding: 0.1em 0.2em; }';
      $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }';
    }
    if (isset($pconf['style'])) { $out .= $pconf['style']; }
    $out .= '</style>';
    $out .= '</head>';
    $out .= '<body>';

    $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>';
    }

    $g_sub = isset($pconf['graph_sub'])?$pconf['graph_sub']:null;
    if (in_array($this->status, array('ok','readonly','graphonly'))) {
      foreach (array('day','week','month','year') as $tframe) {
        $gmeta = $this->graph_plus($tframe, $g_sub, $graph_extras);
        if (isset($pconf['graph_url'])) {
          $gURL = $pconf['graph_url'];
          $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 .= '<div class="'.$tframe.'">';
//         $out .= '<p>'.nl2br($ret).'</p>';
        $out .= '<h2>'.$gtitle[$tframe].'</h2>';
        $out .= '<img src="'.$gURL.'"';
        $out .= ' alt="'.$this->basename.(!is_null($g_sub)?' - '.$g_sub:'').' - '.$tframe.'" class="rrdgraph"';
        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) {
            $out .= '<tr><th>'.$field.'</th>';
            foreach ($gdata as $gkey=>$gval) {
              $out .= '<td><span class="gkey">'.$gkey.': </span>'.$gval.'</td>';
            }
            $out .= '</tr>';
          }
          $out .= '</table>';
        }
        if (isset($gmeta['var']) && count($gmeta['var'])) {
          foreach ($gmeta['var'] as $gkey=>$gval) {
            $out .= '<p class="gvar"><span class="gkey">'.$gkey.': </span>'.$gval.'</p>';
          }
        }
        if (isset($gmeta['info']) && count($gmeta['info'])) {
          foreach ($gmeta['info'] as $gval) {
            $out .= '<p class="ginfo">'.$gval.'</p>';
          }
        }
        $out .= '</div>';
      }
    }
    else {
      $out .= 'RRD error: status is "'.$this->status.'"';
    }

    $out .= $this->h_page_footer();
    $out .= '</body></html>';
  return $out;
  }

  function h_page_statsArray($pconf) {
    // return array of stats to list on a page
    $stats = array();
    $snames = array(); $s_exclude = array(); $sfiles = array();
    if (isset($pconf['index_ids'])) {
      foreach (explode(',', $pconf['index_ids']) as $iid) {
        if ($iid{0} == '-') { $s_exclude[] = substr($iid, 1); }
        else { $snames[] = $iid; }
      }
    }
    if (!isset($pconf['scan_config']) || $pconf['scan_config']) {
      foreach ($this->config_all as $iname=>$rinfo) {
        if (($iname != '*') && !(isset($rinfo['hidden']) && $rinfo['hidden']) &&
            !(in_array($iname, $snames)) && !(in_array($iname, $s_exclude))) {
          $snames[] = $iname;
        }
      }
    }
    foreach ($snames as $iname) {
      $newstat = array('name'=>$iname);
      $sfiles[] = isset($this->config_all[$iname]['file'])?$this->config_all[$iname]['file']:$iname.'.rrd';
      if (is_array($this->config_all[$iname])) {
        foreach ($this->config_all[$iname] as $key=>$val) {
          if (substr($key, 0, 5) == 'page.') { $newstat['sub'][] = substr($key, 5); }
        }
      }
      $stats[] = $newstat;
    }
    if (isset($pconf['scan_files']) && $pconf['scan_files']) {
      $rrdfiles = glob('*.rrd');
      foreach ($rrdfiles as $rrdfile) {
        $iname = (substr($rrdfile, -4) == '.rrd')?substr($rrdfile, 0, -4):$rrdfile;
        if (!in_array($rrdfile, $sfiles) && !(in_array($iname, $s_exclude))) {
          $stats[] = array('name'=>$iname, 'class'=>'scanfile');
        }
      }
    }
  return $stats;
  }

  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 .= '</p>';
  return $out;
  }

  function text_quote($text) { return '"'.str_replace('"', '\"', str_replace(':', '\:', $text)).'"'; }
}
?>