include/classes/rrdstat.php-class

   1 <?php
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  *
   4  * The contents of this file are subject to Austrian copyright reegulations
   5  * ("Urheberrecht"); you may not use this file except in compliance with
   6  * those laws.
   7  * This contents and any derived work, if it gets distributed in any way,
   8  * is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND,
   9  * either express or implied.
  10  *
  11  * The Original Code is KaiRo's RRD statistics class.
  12  *
  13  * The Initial Developer of the Original Code is
  14  * KaiRo - Robert Kaiser.
  15  * Portions created by the Initial Developer are Copyright (C) 2005-2006
  16  * the Initial Developer. All Rights Reserved.
  17  *
  18  * Contributor(s): Robert Kaiser <kairo@kairo.at>
  19  *
  20  * ***** END LICENSE BLOCK ***** */
  21
  22 class rrdstat {
  23   // rrdstat PHP class
  24   // rrdtool statistics functions
  25   //
  26   // function __construct($rrdconfig, [$conf_id])
  27   //   CONSTRUCTOR
  28   //     if $conf_id is set, $rrdconfig is a total configuration set
  29   //     else it's the configuration for this one RRD
  30   //     currently only a config array is supported, XML config is planned
  31   //
  32   // private $rrdtool_bin
  33   // RRDtool binary to use
  34   //
  35   // private $rrd_file
  36   // RRD file name
  37   //
  38   // private $basename
  39   // base name for this RRD (usually file name without .rrd)
  40   //
  41   // private $basedir
  42   // base directory for this RRD (with a trailing slash)
  43   //   note that $rrd_file usually includes that path as well, but graph directory gets based on this value
  44   //
  45   // private $config_all
  46   // complete, raw configuration array set
  47   //
  48   // private $config_raw
  49   // configuration array set for current RRD
  50   //
  51   // private $config_graph
  52   // configuration array set for default graph in this RRD
  53   //
  54   // private $config_page
  55   // configuration array set for default page in this RRD
  56   //
  57   // private $rrd_fields
  58   // definition of this RRD's fields
  59   //
  60   // private $rra_base
  61   // definition of this RRD's base RRAs
  62   //
  63   // private $rrd_step
  64   // basic stepping of this RRD in seconds (default: 300)
  65   //
  66   // private $rra_add_max
  67   // should RRAs for MAX be added for every base RRA? (bool, default: true)
  68   //
  69   // private $status
  70   // status of the RRD (unused/ok/readonly/graphonly)
  71   //   note that most functions require certain status values
  72   //   (e.g. update only works if status is ok, graph for ok/readonly/graphonly)
  73   //
  74   // private $mod_textdomain
  75   //   GNU gettext domain for this module
  76   //
  77   // private function set_def($rrdconfig, [$conf_id])
  78   //   set definitions based on given configuration
  79   //   [intended for internal use, called by the constructor]
  80   //
  81   // public function rrd_version() {
  82   //   get RRDtool version string
  83   //
  84   // public function create()
  85   //   create RRD file according to set config
  86   //
  87   // public function update([$upArray])
  88   //   feed new data into RRD (either use given array of values or use auto-update info from config)
  89   //
  90   // public function fetch([$cf] = 'AVERAGE', $resolution = null, $start = null, $end = null)
  91   //   fetch data from the defined RRD
  92   //     using given consolidation function [default is AVERAGE],
  93   //     resolution (seconds, default is the RRD's stepping),
  94   //     start and end times (unix epoch, defaults are the RRD's last update time)
  95   //
  96   // public function last_update()
  97   //   fetch time of last update in this RRD file
  98   //
  99   // public function graph([$timeframe], [$sub], [$extra])
 100   //   create a RRD graph (and return all meta info in a flat string)
 101   //     for given timeframe (day [default]/week/month/year),
 102   //     sub-graph ID (if given) and extra config options (if given)
 103   //
 104   // public function graph_plus([$timeframe], [$sub], [$extra])
 105   //   create a RRD graph (see above) and return meta info as a ready-to-use array
 106   //
 107   // public function page([$sub], [$page_extras], [$graph_extras])
 108   //   create a (HTML) page and return it in a string
 109   //     for given sub-page ID (if given, default is a simple HTML page)
 110   //     and extra page and graph config options (if given)
 111   //
 112   // public function simple_html([$sub], [$page_extras], [$graph_extras])
 113   //   create a simple (MRTG-like) HTML page and return it in a string
 114   //   XXX: this is here temporarily for compat only, it's preferred to use page()!
 115   //
 116   // private function page_index($pconf)
 117   //   create a bare, very simple index list HTML page and return it in a string
 118   //   using given page config options
 119   //   [intended for internal use, called by page()]
 120   //
 121   // private function page_overview($pconf, [$graph_extras])
 122   //   create an overview HTML page (including graphs) and return it in a string
 123   //   using given page config options and extra graph options (if given)
 124   //   [intended for internal use, called by page()]
 125   //
 126   // private function page_simple($pconf, [$graph_extras])
 127   //   create a simple (MRTG-like) HTML page and return it in a string
 128   //   using given page config options and extra graph options (if given)
 129   //   [intended for internal use, called by page()]
 130   //
 131   // private function h_page_statsArray($pconf)
 132   //   return array of stats to list on a page, using given page config options
 133   //   [intended for internal use, called by page_*()]
 134   //
 135   // private function h_page_footer()
 136   //   return generic page footer
 137   //   [intended for internal use, called by page_*()]
 138   //
 139   // private function text_quote($text)
 140   //   return a quoted/escaped text for use in rrdtool commandline text fields
 141
 142   private $rrdtool_bin = '/usr/bin/rrdtool';
 143
 144   private $rrd_file = null;
 145   private $basename = null;
 146   private $basedir = null;
 147
 148   private $config_all = null;
 149   private $config_raw = null;
 150   private $config_graph = null;
 151   private $config_page = null;
 152
 153   private $rrd_fields = array();
 154   private $rra_base = array();
 155   private $rrd_step = 300;
 156   private $rra_add_max = true;
 157
 158   private $status = 'unused';
 159
 160   private $mod_textdomain;
 161
 162   function __construct($rrdconfig, $conf_id = null) {
 163     // ***** init RRD stat module *****
 164     $this->mod_textdomain = 'class_rrdstat';
 165     $mod_charset = 'utf-8';
 166
 167     bindtextdomain($this->mod_textdomain, class_exists('baseutils')?baseutils::getDir('locale'):'locale/');
 168     bind_textdomain_codeset($this->mod_textdomain, $mod_charset);
 169
 170     $this->set_def($rrdconfig, $conf_id);
 171
 172     if (($this->status == 'unused') && !is_null($this->rrd_file)) {
 173       if (!is_writeable($this->rrd_file)) {
 174         if (!file_exists($this->rrd_file)) {
 175           if (@touch($this->rrd_file)) { $this->create(); }
 176           else { trigger_error('RRD file can not be created', E_USER_WARNING); }
 177         }
 178         else {
 179           if (is_readable($this->rrd_file)) { $this->status = 'readonly'; }
 180           else { trigger_error('RRD file is not readable', E_USER_WARNING); }
 181         }
 182       }
 183       else {
 184         $this->status = 'ok';
 185       }
 186     }
 187   }
 188
 189   private function set_def($rrdconfig, $conf_id = null) {
 190     if (is_array($rrdconfig)) {
 191       // we have an array in the format we like to have
 192       $complete_conf =& $rrdconfig;
 193     }
 194     else {
 195       // we have something else (XML data?), try to generate the iinfo aray from it
 196       $complete_conf =& $rrdconfig;
 197     }
 198
 199     if (!is_null($conf_id)) {
 200       $iinfo = isset($complete_conf[$conf_id])?$complete_conf[$conf_id]:array();
 201       if (isset($complete_conf['*'])) {
 202         $iinfo = (array)$iinfo + (array)$complete_conf['*'];
 203         if (isset($complete_conf['*']['graph'])) {
 204           $iinfo['graph'] = (array)$iinfo['graph'] + (array)$complete_conf['*']['graph'];
 205         }
 206         if (isset($complete_conf['*']['page'])) {
 207           $iinfo['page'] = (array)$iinfo['page'] + (array)$complete_conf['*']['page'];
 208         }
 209       }
 210     }
 211     else {
 212       $iinfo = $complete_conf;
 213     }
 214
 215     if (isset($iinfo['path']) && strlen($iinfo['path'])) {
 216       $this->basedir = $iinfo['path'];
 217       if (substr($this->basedir, -1) != '/') { $this->basedir .= '/'; }
 218     }
 219
 220     if (isset($iinfo['graph-only']) && $iinfo['graph-only'] && !is_null($conf_id)) {
 221       $this->basename = $conf_id;
 222       $this->status = 'graphonly';
 223     }
 224     elseif (isset($iinfo['file'])) {
 225       $this->rrd_file = (($iinfo['file']{0} != '/')?$this->basedir:'').$iinfo['file'];
 226       $this->basename = basename((substr($this->rrd_file, -4) == '.rrd')?substr($this->rrd_file, 0, -4):$this->rrd_file);
 227     }
 228     elseif (!is_null($conf_id) && file_exists($conf_id.'.rrd')) {
 229       $this->rrd_file = (($iinfo['file']{0} != '/')?$this->basedir:'').$conf_id.'.rrd';
 230       $this->basename = $conf_id;
 231     }
 232     else {
 233       $this->basename = !is_null($conf_id)?$conf_id:'xxx.unknown';
 234     }
 235
 236     if (!is_null($this->rrd_file)) {
 237       // fields (data sources, DS)
 238       //  name - DS name
 239       //  type - one of COUNTER, GAUGE, DERIVE, ABSOLUTE
 240       //  heartbeat - if no sample recieved for that time, store UNKNOWN
 241       //  min - U (unconstrained) or minimum value
 242       //  max - U (unconstrained) or maximum value
 243       //  update - this string will be fed into eval() for updating this field
 244       if (isset($iinfo['fields']) && is_array($iinfo['fields'])) {
 245         $this->rrd_fields = $iinfo['fields'];
 246       }
 247       else {
 248         $this->rrd_fields[] = array('name' => 'ds0', 'type' => 'COUNTER', 'heartbeat' => 600, 'min' => 'U', 'max' => 'U');
 249         $this->rrd_fields[] = array('name' => 'ds1', 'type' => 'COUNTER', 'heartbeat' => 600, 'min' => 'U', 'max' => 'U');
 250       }
 251
 252
 253       // MRTG-style RRD "database", see http://oss.oetiker.ch/rrdtool/tut/rrdtutorial.en.html
 254       //
 255       // archives (RRAs):
 256       // 600 samples of 5 minutes  (2 days and 2 hours)
 257       // 700 samples of 30 minutes (2 days and 2 hours, plus 12.5 days)
 258       // 775 samples of 2 hours    (above + 50 days)
 259       // 797 samples of 1 day      (above + 732 days, rounded up to 797)
 260
 261       $this->rrd_step = isset($iinfo['rrd_step'])?$iinfo['rrd_step']:300;
 262
 263       if (isset($iinfo['rra_base']) && is_array($iinfo['rra_base'])) {
 264         $this->rra_base = $iinfo['rra_base'];
 265       }
 266       else {
 267         $this->rra_base[] = array('step' => 1, 'rows' => 600);
 268         $this->rra_base[] = array('step' => 6, 'rows' => 700);
 269         $this->rra_base[] = array('step' => 24, 'rows' => 775);
 270         $this->rra_base[] = array('step' => 288, 'rows' => 797);
 271       }
 272
 273       $this->rra_add_max = isset($iinfo['rra_add_max'])?$iinfo['rra_add_max']:true;
 274     }
 275
 276     if (isset($iinfo['graph'])) { $this->config_graph = $iinfo['graph']; }
 277     if (isset($iinfo['page'])) { $this->config_page = $iinfo['page']; }
 278     $this->config_raw = $iinfo;
 279     $this->config_all = $complete_conf;
 280   }
 281
 282   public function rrd_version() {
 283     // return RRDtool version
 284     static $version;
 285     if (!isset($version)) {
 286       $create_cmd = $this->rrdtool_bin.' --version';
 287       $return = `$create_cmd 2>&1`;
 288       if (strpos($return, 'ERROR') !== false) {
 289         trigger_error($this->rrd_file.' - rrd version error: '.$return, E_USER_WARNING);
 290       }
 291
 292       if (preg_match('/^\s*RRDtool ([\d\.]+)\s+/', $return, $regs)) {
 293         $version = $regs[1];
 294       }
 295       else {
 296         $version = '0.0';
 297       }
 298     }
 299   return $version;
 300   }
 301
 302   public function create() {
 303     // create RRD file
 304
 305     // compose create command
 306     $create_cmd = $this->rrdtool_bin.' create '.$this->rrd_file.' --step '.$this->rrd_step;
 307     foreach ($this->rrd_fields as $ds) {
 308       if (!isset($ds['type'])) { $ds['type'] = 'COUNTER'; }
 309       if (!isset($ds['heartbeat'])) { $ds['heartbeat'] = 2*$this->rrd_step; }
 310       if (!isset($ds['min'])) { $ds['min'] = 'U'; }
 311       if (!isset($ds['max'])) { $ds['max'] = 'U'; }
 312       $create_cmd .= ' DS:'.$ds['name'].':'.$ds['type'].':'.$ds['heartbeat'].':'.$ds['min'].':'.$ds['max'];
 313     }
 314     foreach ($this->rra_base as $rra) {
 315       if (!isset($rra['cf'])) { $rra['cf'] = 'AVERAGE'; }
 316       if (!isset($rra['xff'])) { $rra['xff'] = 0.5; }
 317       if (!isset($rra['step'])) { $rra['step'] = 1; }
 318       if (!isset($rra['rows'])) { $rra['rows'] = 600; }
 319       $create_cmd .= ' RRA:'.$rra['cf'].':'.$rra['xff'].':'.$rra['step'].':'.$rra['rows'];
 320     }
 321     if ($this->rra_add_max) {
 322       foreach ($this->rra_base as $rra) {
 323         if (!isset($rra['cf'])) {
 324           // only rows that have no CF set will be looked at here
 325           $rra['cf'] = 'MAX';
 326           if (!isset($rra['xff'])) { $rra['xff'] = 0.5; }
 327           if (!isset($rra['step'])) { $rra['step'] = 1; }
 328           if (!isset($rra['rows'])) { $rra['rows'] = 600; }
 329           $create_cmd .= ' RRA:'.$rra['cf'].':'.$rra['xff'].':'.$rra['step'].':'.$rra['rows'];
 330         }
 331       }
 332     }
 333     $return = `$create_cmd 2>&1`;
 334     if (strpos($return, 'ERROR') !== false) {
 335       trigger_error($this->rrd_file.' - rrd create error: '.$return, E_USER_WARNING);
 336     }
 337     else { $this->status = 'ok'; }
 338   }
 339
 340   public function update($upArray = null) {
 341     // feed new data into RRD
 342     if ($this->status != 'ok') { trigger_error('Cannot update non-writeable file', E_USER_WARNING); return false; }
 343     $upvals = array();
 344     if (isset($this->config_raw['update'])) {
 345       if (preg_match('/^\s*function\s+{(.*)}\s*$/is', $this->config_raw['update'], $regs)) {
 346         $upfunc = create_function('', $regs[1]);
 347         $upvals = $upfunc();
 348       }
 349       else {
 350         $evalcode = $this->config_raw['update'];
 351         if (!is_null($evalcode)) {
 352           ob_start();
 353           eval($evalcode);
 354           $ret = ob_get_contents();
 355           if (strlen($ret)) { $upvals = explode("\n", $ret); }
 356           ob_end_clean();
 357         }
 358       }
 359     }
 360     else {
 361       foreach ($this->rrd_fields as $ds) {
 362         if (is_array($upArray) && isset($upArray[$ds['name']])) { $val = $upArray[$ds['name']]; }
 363         elseif (isset($ds['update'])) {
 364           $val = null; $evalcode = null;
 365           if (substr($ds['update'], 0, 4) == 'val:') {
 366             $evalcode = 'function { return trim('.substr($ds['update'], 4).')); }';
 367           }
 368           elseif (substr($ds['update'], 0, 8) == 'snmp-if:') {
 369             $snmphost = 'localhost'; $snmpcomm = 'public';
 370             list($nix, $ifname, $valtype) = explode(':', $ds['update'], 3);
 371             $iflist = explode("\n", `snmpwalk -v2c -c $snmpcomm $snmphost interfaces.ifTable.ifEntry.ifDescr`);
 372             $ifnr = null;
 373             foreach ($iflist as $ifdesc) {
 374               if (preg_match('/ifDescr\.(\d+) = STRING: '.$ifname.'/', $ifdesc, $regs)) { $ifnr = $regs[1]; }
 375             }
 376             $oid = null;
 377             if ($valtype == 'in') { $oid = '1.3.6.1.2.1.2.2.1.10.'.$ifnr; }
 378             elseif ($valtype == 'out') { $oid = '1.3.6.1.2.1.2.2.1.16.'.$ifnr; }
 379             if (!is_null($ifnr) && !is_null($oid)) {
 380               $evalcode = 'function { return trim(substr(strrchr(`snmpget -v2c -c '.$snmpcomm.' '.$snmphost.' '.$oid.'`,":"),1)); }';
 381             }
 382           }
 383           else { $evalcode = $ds['update']; }
 384           if (preg_match('/^\s*function\s+{(.*)}\s*$/is', $evalcode, $regs)) {
 385             $upfunc = create_function('', $regs[1]);
 386             $val = $upfunc();
 387           }
 388           elseif (!is_null($evalcode)) {
 389             ob_start();
 390             eval($evalcode);
 391             $val = ob_get_contents();
 392             ob_end_clean();
 393           }
 394         }
 395         else { $val = null; }
 396         $upvals[$ds['name']] = $val;
 397       }
 398     }
 399     $upval_keys = array_keys($upvals);
 400     $keys_have_names = !is_numeric(array_shift($upval_keys));
 401     if (in_array('L', $upvals, true)) {
 402       // for at least one value, we need to set the same as the last recorded value
 403       $fvals = $this->fetch();
 404       $rowids = array_shift($fvals);
 405       $lastvals = array_shift($fvals);
 406       foreach (array_keys($upvals, 'L') as $akey) {
 407         $upvals[$akey] = $keys_have_names?$lastvals[$akey]:$lastvals[$rowids[$akey]];
 408       }
 409     }
 410     $walkfunc = create_function('&$val,$key', '$val = is_numeric(trim($val))?trim($val):"U";');
 411     array_walk($upvals, $walkfunc);
 412     $return = null;
 413     if (count($upvals)) {
 414       $update_cmd = $this->rrdtool_bin.' update '.$this->rrd_file
 415                     .($keys_have_names?' --template '.implode(':', array_keys($upvals)):'').' N:'.implode(':', $upvals);
 416       $return = `$update_cmd 2>&1`;
 417     }
 418
 419     if (strpos($return, 'ERROR') !== false) {
 420       trigger_error($this->rrd_file.' - rrd update error: '.$return, E_USER_WARNING);
 421       $success = false;
 422     }
 423     else { $success = true; }
 424   return $success;
 425   }
 426
 427   public function fetch($cf = 'AVERAGE', $resolution = null, $start = null, $end = null) {
 428     // fetch data from a RRD
 429     if (!in_array($this->status, array('ok','readonly'))) {
 430       trigger_error('Error: rrd status is '.$this->status, E_USER_WARNING); return false;
 431     }
 432
 433     if (!in_array($cf, array('AVERAGE','MIN','MAX','LAST'))) { $cf = 'AVERAGE'; }
 434     if (!is_numeric($resolution)) { $resolution = $this->rrd_step; }
 435     if (!is_numeric($end)) { $end = $this->last_update(); }
 436     elseif ($end < 0) { $end += $this->last_update(); }
 437     $end = intval($end/$resolution)*$resolution;
 438     if (!is_numeric($start)) { $start = $end; }
 439     elseif ($start < 0) { $start += $end; }
 440     $start = intval($start/$resolution)*$resolution;
 441
 442     $fetch_cmd = $this->rrdtool_bin.' fetch '.$this->rrd_file.' '.$cf.' --resolution '.$resolution
 443                  .' --start '.$start.' --end '.$end;
 444     $return = `$fetch_cmd 2>&1`;
 445
 446     if (strpos($return, 'ERROR') !== false) {
 447       trigger_error($this->rrd_file.' - rrd fetch error: '.$return, E_USER_WARNING);
 448       $fresult = false;
 449     }
 450     else {
 451       $fresult = array();
 452       $rows = explode("\n", $return);
 453       $fields = preg_split('/\s+/', array_shift($rows));
 454       if (array_shift($fields) == 'timestamp') {
 455         $fresult[0] = $fields;
 456         foreach ($rows as $row) {
 457           if (strlen(trim($row))) {
 458             $rvals = preg_split('/\s+/', $row);
 459             $rtime = str_replace(':', '', array_shift($rvals));
 460             $rv_array = array();
 461             foreach ($rvals as $key=>$rval) {
 462               $rv_array[$fields[$key]] = ($rval=='nan')?null:floatval($rval);
 463             }
 464             $fresult[$rtime] = $rv_array;
 465           }
 466         }
 467       }
 468     }
 469   return $fresult;
 470   }
 471
 472   public function last_update() {
 473     // fetch time of last update in this RRD file
 474     static $last_update;
 475     if (!isset($last_update) && in_array($this->status, array('ok','readonly'))) {
 476       $last_cmd = $this->rrdtool_bin.' last '.$this->rrd_file;
 477       $return = trim(`$last_cmd 2>&1`);
 478       $last_update = is_numeric($return)?$return:null;
 479     }
 480   return isset($last_update)?$last_update:null;
 481   }
 482
 483   public function graph($timeframe = 'day', $sub = null, $extra = null) {
 484     // create a RRD graph
 485     static $gColors;
 486     if (!isset($gColors)) {
 487       $gColors = array('#00CC00','#0000FF','#000000','#FF0000','#00FF00','#FFFF00','#FF00FF','#00FFFF',
 488                        '#808080','#800000','#008000','#000080','#808000','#800080','#008080','#C0C0C0');
 489     }
 490
 491     if (!in_array($this->status, array('ok','readonly','graphonly'))) {
 492       trigger_error('Error: rrd status is '.$this->status, E_USER_WARNING); return false;
 493     }
 494
 495     // assemble configuration
 496     $gconf = (array)$extra;
 497     if (!is_null($sub) && is_array($this->config_raw['graph.'.$sub])) {
 498       $gconf = $gconf + $this->config_raw['graph.'.$sub];
 499     }
 500     $gconf = $gconf + (array)$this->config_graph;
 501
 502     if (isset($gconf['format']) && ($gconf['format'] == 'SVG')) {
 503       $format = $gconf['format']; $fmt_ext = '.svg';
 504     }
 505     elseif (isset($gconf['format']) && ($gconf['format'] == 'EPS')) {
 506       $format = $gconf['format']; $fmt_ext = '.eps';
 507     }
 508     elseif (isset($gconf['format']) && ($gconf['format'] == 'PDF')) {
 509       $format = $gconf['format']; $fmt_ext = '.pdf';
 510     }
 511     else {
 512       $format = 'PNG'; $fmt_ext = '.png';
 513     }
 514
 515     if (isset($gconf['filename'])) { $fname = $gconf['filename']; }
 516     else { $fname = $this->basename.(is_null($sub)?'':'-%s').'-%t%f'; }
 517     $fname = str_replace('%s', strval($sub), $fname);
 518     $fname = str_replace('%t', $timeframe, $fname);
 519     $fname = str_replace('%f', $fmt_ext, $fname);
 520     if (substr($fname, -strlen($fmt_ext)) != $fmt_ext) { $fname .= $fmt_ext; }
 521     if (isset($gconf['path']) && ($fname{0} != '/')) { $fname = $gconf['path'].'/'.$fname; }
 522     if ($fname{0} != '/') { $fname = $this->basedir.$fname; }
 523     $fname = str_replace('//', '/', $fname);
 524
 525     $graphrows = array(); $specialrows = array(); $gC = 0;
 526     $gDefs = ''; $gGraphs = ''; $addSpecial = '';
 527
 528     // the default size for the graph area has a width of 400px, so use 400 slices by default
 529     if ($timeframe == 'day') {
 530       $slice = isset($gconf['slice'])?$gconf['slice']:300; // 5 minutes
 531       $duration = isset($gconf['duration'])?$gconf['duration']:400*$slice; // 33.33 hours
 532       // vertical lines at day borders
 533       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d')).'#FF0000';
 534       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d').' -1 day').'#FF0000';
 535       if (!isset($gconf['grid_x'])) { $gconf['grid_x'] = 'HOUR:1:HOUR:6:HOUR:2:0:%-H'; }
 536     }
 537     elseif ($timeframe == 'week') {
 538       $slice = isset($gconf['slice'])?$gconf['slice']:1800; // 30 minutes
 539       $duration = isset($gconf['duration'])?$gconf['duration']:400*$slice; // 8.33 days
 540       // vertical lines at week borders
 541       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d').' '.(-date('w')+1).' day').'#FF0000';
 542       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d').' '.(-date('w')-6).' day').'#FF0000';
 543     }
 544     elseif ($timeframe == 'month') {
 545       $slice = isset($gconf['slice'])?$gconf['slice']:7200; // 2 hours
 546       $duration = isset($gconf['duration'])?$gconf['duration']:400*$slice; // 33.33 days
 547       // vertical lines at month borders
 548       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-01')).'#FF0000';
 549       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-01').' -1 month').'#FF0000';
 550     }
 551     elseif ($timeframe == 'year') {
 552       $slice = isset($gconf['slice'])?$gconf['slice']:86400; // 1 day
 553       $duration = isset($gconf['duration'])?$gconf['duration']:400*$slice; // 400 days
 554       // vertical lines at month borders
 555       $addSpecial .= ' VRULE:'.strtotime(date('Y-01-01 12:00:00')).'#FF0000';
 556       $addSpecial .= ' VRULE:'.strtotime(date('Y-01-01 12:00:00').' -1 year').'#FF0000';
 557     }
 558     else {
 559       $duration = isset($gconf['duration'])?$gconf['duration']:$this->rrd_step*500; // 500 steps
 560       $slice = isset($gconf['slice'])?$gconf['slice']:$this->rrd_step; // whatever our step is
 561     }
 562
 563     $use_gcrows = (isset($gconf['rows']) && count($gconf['rows']));
 564     if ($use_gcrows) { $grow_def =& $gconf['rows']; }
 565     else { $grow_def =& $this->rrd_fields; }
 566     foreach ($grow_def as $key=>$erow) {
 567       if (isset($erow['name']) && strlen($erow['name'])) {
 568         if (!isset($erow['scale']) && isset($gconf['scale'])) { $erow['scale'] = $gconf['scale']; }
 569         if (!isset($erow['scale_time_src']) && isset($gconf['scale_time_src'])) {
 570           $erow['scale_time_src'] = $gconf['scale_time_src'];
 571         }
 572         if (!isset($erow['scale_time_tgt']) && isset($gconf['scale_time_tgt'])) {
 573           $erow['scale_time_tgt'] = $gconf['scale_time_tgt'];
 574         }
 575         foreach (array('scale_time_src','scale_time_tgt') as $st) {
 576           if (!isset($erow[$st]) || !is_numeric($erow[$st])) {
 577             switch (@$erow[$st]) {
 578               case 'dyn':
 579               case 'auto':
 580                 $erow[$st] = $slice;
 581                 break;
 582               case 'day':
 583                 $erow[$st] = 24*3600;
 584                 break;
 585               case '2hr':
 586               case '2hours':
 587                 $erow[$st] = 7200;
 588                 break;
 589               case 'hr':
 590               case 'hour':
 591                 $erow[$st] = 3600;
 592                 break;
 593               case '30min':
 594                 $erow[$st] = 1800;
 595                 break;
 596               case '5min':
 597                 $erow[$st] = 300;
 598                 break;
 599               case 'min':
 600                 $erow[$st] = 60;
 601                 break;
 602               case 's':
 603               case 'sec':
 604               default:
 605                 $erow[$st] = 1;
 606                 break;
 607             }
 608           }
 609         }
 610         $scale_time_factor = $erow['scale_time_tgt']/$erow['scale_time_src'];
 611         if ($scale_time_factor != 1) { $erow['scale'] = (isset($erow['scale'])?$erow['scale']:1)*$scale_time_factor; }
 612         $grow = array();
 613         $grow['dType'] = ($use_gcrows && isset($erow['dType']))?$erow['dType']:'DEF';
 614         $grow['name'] = $erow['name'].(isset($erow['scale'])?'_tmp':'');
 615         if ($grow['dType'] == 'DEF') {
 616           $grow['dsname'] = ($use_gcrows && isset($erow['dsname']))?$erow['dsname']:$erow['name'];
 617           if ($use_gcrows && isset($erow['dsfile'])) { $grow['dsfile'] = $erow['dsfile']; }
 618           $grow['cf'] = ($use_gcrows && isset($erow['cf']))?$erow['cf']:'AVERAGE';
 619         }
 620         else {
 621           $grow['rpn_expr'] = isset($erow['rpn_expr'])?$erow['rpn_expr']:'0';
 622         }
 623         if (isset($erow['scale'])) {
 624           $graphrows[] = $grow;
 625           $grow = array();
 626           $grow['dType'] = 'CDEF';
 627           $grow['name'] = $erow['name'];
 628           $grow['rpn_expr'] = $erow['name'].'_tmp,'.$erow['scale'].',*';
 629         }
 630         if ($use_gcrows) { $grow['gType'] = isset($erow['gType'])?$erow['gType']:'LINE1'; }
 631         else { $grow['gType'] = ((count($grow_def)==2) && ($key==0))?'AREA':'LINE1'; }
 632         $grow['color'] = isset($erow['color'])?$erow['color']:$gColors[$gC++];
 633         $grow['color_bg'] = isset($erow['color_bg'])?$erow['color_bg']:'';
 634         if ($gC >= count($gColors)) { $gC = 0; }
 635         if (isset($erow['legend'])) {
 636           $grow['legend'] = $erow['legend'];
 637           if (!isset($gconf['show_legend'])) { $gconf['show_legend'] = true; }
 638         }
 639         if (isset($erow['stack'])) { $grow['stack'] = ($erow['stack'] == true); }
 640         if (isset($erow['desc'])) { $grow['desc'] = $erow['desc']; }
 641         if (isset($erow['legend_long'])) { $grow['legend_long'] = $erow['legend_long']; }
 642         $graphrows[] = $grow;
 643       }
 644     }
 645
 646     if (isset($gconf['special']) && count($gconf['special'])) {
 647       foreach ($gconf['special'] as $crow) {
 648         $srow = array();
 649         $srow['sType'] = isset($crow['sType'])?$crow['sType']:'COMMENT';
 650         if ($grow['sType'] != 'COMMENT') {
 651           // XXX: use line below and remove cf var once we have rrdtol 1.2
 652           if ($this->rrd_version() >= '1.2') {
 653             $srow['name'] = $crow['name'].(isset($crow['cf'])?'_'.$crow['cf']:'');
 654           }
 655           else {
 656             $srow['name'] = $crow['name'];
 657             $srow['cf'] = isset($crow['cf'])?$crow['cf']:'AVERAGE';
 658           }
 659           if (isset($crow['cf'])) {
 660             if ($this->rrd_version() >= '1.2') {
 661               $graphrows[] = array('dType'=>'VDEF', 'name'=>$srow['name'].'_'.$crow['cf'],
 662                                    'rpn_expr'=>$srow['name'].','.$crow['cf']);
 663             }
 664           }
 665           elseif (isset($crow['rpn_expr'])) {
 666             if ($this->rrd_version() >= '1.2') {
 667               $graphrows[] = array('dType'=>'VDEF', 'name'=>$srow['name'], 'rpn_expr'=>$crow['rpn_expr']);
 668             }
 669           }
 670         }
 671         $srow['text'] = isset($crow['text'])?$crow['text']:'';
 672         $specialrows[] = $srow;
 673       }
 674     }
 675     else {
 676       $td = $this->mod_textdomain;
 677       foreach ($graphrows as $grow) {
 678         if (isset($grow['gType']) && strlen($grow['gType'])) {
 679           $textprefix = isset($grow['desc'])?$grow['desc']:(isset($grow['legend'])?$grow['legend']:$grow['name']);
 680           if ($this->rrd_version() >= '1.2') {
 681             $graphrows[] = array('dType'=>'VDEF', 'name'=>'_'.$grow['name'].'__max', 'rpn_expr'=>$grow['name'].',MAXIMUM');
 682             $specialrows[] = array('sType'=>'PRINT', 'name'=>'_'.$grow['name'].'__max',
 683                                    'text'=>$textprefix.'|'.dgettext($td, 'Maximum').'|%.2lf%s');
 684             $graphrows[] = array('dType'=>'VDEF', 'name'=>'_'.$grow['name'].'__avg', 'rpn_expr'=>$grow['name'].',AVERAGE');
 685             $specialrows[] = array('sType'=>'PRINT', 'name'=>'_'.$grow['name'].'__avg',
 686                                    'text'=>$textprefix.'|'.dgettext($td, 'Average').'|%.2lf%s');
 687             $graphrows[] = array('dType'=>'VDEF', 'name'=>'_'.$grow['name'].'__last', 'rpn_expr'=>$grow['name'].',LAST');
 688             $specialrows[] = array('sType'=>'PRINT', 'name'=>'_'.$grow['name'].'__last',
 689                                    'text'=>$textprefix.'|'.dgettext($td, 'Current').'|%.2lf%s');
 690           }
 691           else {
 692             $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'MAX',
 693                                    'text'=>$textprefix.'|'.dgettext($td, 'Maximum').'|%.2lf%s');
 694             $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'AVERAGE',
 695                                    'text'=>$textprefix.'|'.dgettext($td, 'Average').'|%.2lf%s');
 696             $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'LAST',
 697                                    'text'=>$textprefix.'|'.dgettext($td, 'Current').'|%.2lf%s');
 698           }
 699         }
 700       }
 701     }
 702
 703     $endtime = isset($gconf['time_end'])?$gconf['time_end']:(is_numeric($this->last_update())?$this->last_update():time());
 704     $gOpts = ' --start '.($endtime-$duration).' --end '.$endtime.' --step '.$slice;
 705     if (isset($gconf['label_top'])) { $gOpts .= ' --title '.$this->text_quote($gconf['label_top']); }
 706     if (isset($gconf['label_y'])) { $gOpts .= ' --vertical-label '.$this->text_quote($gconf['label_y']); }
 707     if (isset($gconf['width'])) { $gOpts .= ' --width '.$gconf['width']; }
 708     if (isset($gconf['height'])) { $gOpts .= ' --height '.$gconf['height'];
 709       if (($gconf['height'] <= 32) && isset($gconf['thumb']) && ($gconf['thumb'])) { $gOpts .= ' --only-graph'; }
 710     }
 711     if (!isset($gconf['show_legend']) || (!$gconf['show_legend'])) { $gOpts .= ' --no-legend'; }
 712     if (isset($gconf['logarithmic']) && $gconf['logarithmic']) { $gOpts .= ' --logarithmic'; }
 713     if (isset($gconf['min_y'])) { $gOpts .= ' --lower-limit '.$gconf['min_y']; }
 714     if (isset($gconf['max_y'])) { $gOpts .= ' --upper-limit '.$gconf['max_y']; }
 715     if (isset($gconf['fix_scale_y']) && $gconf['fix_scale_y']) { $gOpts .= ' --rigid'; }
 716     if (isset($gconf['grid_x'])) { $gOpts .= ' --x-grid '.$gconf['grid_x']; }
 717     if (isset($gconf['grid_y'])) { $gOpts .= ' --y-grid '.$gconf['grid_y']; }
 718     if (isset($gconf['gridfit']) && (!$gconf['gridfit'])) { $gOpts .= ' --no-gridfit'; }
 719     if (isset($gconf['calc_scale_y']) && $gconf['calc_scale_y']) { $gOpts .= ' --alt-autoscale'; }
 720     if (isset($gconf['calc_max_y']) && $gconf['calc_max_y']) { $gOpts .= ' --alt-autoscale-max'; }
 721     if (isset($gconf['units_exponent'])) { $gOpts .= ' --units-exponent '.$gconf['units_exponent']; }
 722     if (isset($gconf['units_length'])) { $gOpts .= ' --units-length '.$gconf['units_length']; }
 723     if (($this->rrd_version() < '1.2') || !count($specialrows)) {
 724       // lazy graphics omit all print reporting in RRDtool 1.2!
 725       // --> so don't use them there when we want to print stuff
 726       if (!isset($gconf['force_recreate']) || (!$gconf['force_recreate'])) { $gOpts .= ' --lazy'; }
 727     }
 728     if (isset($gconf['force_color']) && is_array($gconf['force_color'])) {
 729       foreach ($gconf['force_color'] as $ctag=>$cval) { $gOpts .= ' --color '.$ctag.$cval; }
 730     }
 731     if (isset($gconf['force_font']) && is_array($gconf['force_font'])) {
 732       foreach ($gconf['force_font'] as $ctag=>$cval) { $gOpts .= ' --font '.$ctag.$cval; }
 733     }
 734     if (isset($gconf['units_binary']) && $gconf['units_binary']) { $gOpts .= ' --base 1024'; }
 735
 736     foreach ($graphrows as $grow) {
 737       if (isset($grow['dType']) && strlen($grow['dType'])) {
 738         $gDefs .= ' '.$grow['dType'].':'.$grow['name'].'=';
 739         if ($grow['dType'] == 'DEF') {
 740           $gDefs .= isset($grow['dsfile'])?$grow['dsfile']:$this->rrd_file;
 741           $gDefs .= ':'.$grow['dsname'].':'.$grow['cf'];
 742         }
 743         else { $gDefs .= $grow['rpn_expr']; }
 744       }
 745       if (isset($grow['gType']) && strlen($grow['gType'])) {
 746         // XXX: change from STACK type to STACK flag once we have rrdtool 1.2
 747         if ($this->rrd_version() < '1.2') {
 748           // rrdtool 1.0 only know STACK type
 749           if (isset($grow['stack']) && $grow['stack']) { $grow['gType'] = 'STACK'; }
 750         }
 751         $gGraphs .= ' '.$grow['gType'].':'.$grow['name'].$grow['color'];
 752         if (isset($grow['legend'])) { $gGraphs .= ':'.$this->text_quote($grow['legend']); }
 753         if ($this->rrd_version() >= '1.2') {
 754           // rrdtool 1.2 and above have STACK flag
 755           if (isset($grow['stack']) && $grow['stack']) { $gGraphs .= ':STACK'; }
 756         }
 757       }
 758     }
 759
 760     foreach ($specialrows as $srow) {
 761       $addSpecial .= ' '.$srow['sType'];
 762       if ($this->rrd_version() >= '1.2') {
 763         $addSpecial .= (($srow['sType']!='COMMENT')?':'.$srow['name']:'');
 764       }
 765       else {
 766         $addSpecial .= (($srow['sType']!='COMMENT')?':'.$srow['name'].':'.$srow['cf']:'');
 767       }
 768       $addSpecial .= ':'.$this->text_quote($srow['text']);
 769     }
 770
 771     $graph_cmd = $this->rrdtool_bin.' graph '.str_replace('*', '\*', $fname.$gOpts.$gDefs.$gGraphs.$addSpecial);
 772     $return = `$graph_cmd 2>&1`;
 773
 774     if (strpos($return, 'ERROR') !== false) {
 775       trigger_error($this->rrd_file.' - rrd graph error: '.$return, E_USER_WARNING);
 776       $return = 'command:'.$graph_cmd."\n\n".$return;
 777     }
 778     if (0) {
 779       // debug output
 780       $return = 'command:'.$graph_cmd."\n\n".$return;
 781     }
 782     $legendlines = '';
 783     foreach ($graphrows as $grow) {
 784       $legendline = isset($grow['desc'])?$grow['desc']:(isset($grow['legend'])?$grow['legend']:$grow['name']);
 785       $legendline .= '|'.@$grow['color'];
 786       $legendline .= '|'.(isset($grow['color_bg'])?$grow['color_bg']:'');
 787       $legendline .= '|'.(isset($grow['legend_long'])?$grow['legend_long']:'');
 788       $legendlines .= 'legend:'.$legendline."\n";
 789     }
 790     $return = 'file:'.$fname."\n".$legendlines.$return;
 791   return $return;
 792   }
 793
 794   public function graph_plus($timeframe = 'day', $sub = null, $extra = null) {
 795     // create a RRD graph and return meta info as a ready-to-use array
 796     $gmeta = array('filename'=>null,'legends_long'=>false,'default_colorize'=>false);
 797     $ret = $this->graph($timeframe, $sub, $extra);
 798     if (0) {
 799       // debug output
 800       $gmeta['ret'] = $ret;
 801     }
 802     $grout = explode("\n", $ret);
 803     foreach ($grout as $gline) {
 804       if (preg_match('/^command:(.+)$/', $gline, $regs)) {
 805         $gmeta['graph_cmd'] = $regs[1];
 806       }
 807       elseif (preg_match('/^file:(.+)$/', $gline, $regs)) {
 808         $gmeta['filename'] = $regs[1];
 809       }
 810       elseif (preg_match('/^legend:([^\|]+)\|([^|]*)\|([^\|]*)\|(.*)$/', $gline, $regs)) {
 811         $gmeta['legend'][$regs[1]] = array('color'=>$regs[2], 'color_bg'=>$regs[3], 'desc_long'=>$regs[4]);
 812         if (strlen($regs[4])) { $gmeta['legends_long'] = true; }
 813         if (strlen($regs[3]) || strlen($regs[4])) { $gmeta['default_colorize'] = true; }
 814       }
 815       elseif (preg_match('/^(\d+)x(\d+)$/', $gline, $regs)) {
 816         $gmeta['width'] = $regs[1]; $gmeta['height'] = $regs[2];
 817       }
 818       elseif (preg_match('/^([^\|]+)\|([^|]+)\|([^\|]*)$/', $gline, $regs)) {
 819         $gmeta['data'][$regs[1]][$regs[2]] = $regs[3];
 820       }
 821       elseif (preg_match('/^([^\|]+)\|([^\|]*)$/', $gline, $regs)) {
 822         $gmeta['var'][$regs[1]] = $regs[2];
 823       }
 824       elseif (strlen(trim($gline))) {
 825         $gmeta['info'][] = $gline;
 826       }
 827     }
 828     if (is_null($gmeta['filename'])) {
 829       $gmeta['filename'] = $this->basename.(!is_null($sub)?'-'.$sub:'').'-'.$timeframe.'.png';
 830     }
 831   return $gmeta;
 832   }
 833
 834   public function page($sub = null, $page_extras = null, $graph_extras = null) {
 835     // create a (HTML) page and return it in a string
 836
 837     // assemble configuration
 838     $pconf = (array)$page_extras;
 839     if (!is_null($sub) && is_array($this->config_raw['page.'.$sub])) {
 840       $pconf = $pconf + $this->config_raw['page.'.$sub];
 841     }
 842     $pconf = $pconf + (array)$this->config_page;
 843
 844     $return = null;
 845     switch (@$pconf['type']) {
 846       case 'index':
 847         $return = $this->page_index($pconf);
 848         break;
 849       case 'overview':
 850         $return = $this->page_overview($pconf, $graph_extras);
 851         break;
 852       case 'simple':
 853       default:
 854         $return = $this->page_simple($pconf, $graph_extras);
 855         break;
 856     }
 857   return $return;
 858   }
 859
 860   public function simple_html($sub = null, $page_extras = null, $graph_extras = null) {
 861     // create a simple (MRTG-like) HTML page and return it in a string
 862     // XXX: this is here temporarily for compat only, it's preferred to use page()!
 863     trigger_error(__CLASS__.'::'.__METHOD__.' is deprecated, use page() instead.', E_USER_NOTICE);
 864
 865     // assemble configuration
 866     $pconf = (array)$page_extras;
 867     if (!is_null($sub) && is_array($this->config_raw['page.'.$sub])) {
 868       $pconf = $pconf + $this->config_raw['page.'.$sub];
 869     }
 870     $pconf = $pconf + (array)$this->config_page;
 871
 872   return $this->page_simple($pconf, $graph_extras);
 873   }
 874
 875   private function page_index($pconf) {
 876     // create a bare, very simple index list HTML page and return it in a string
 877     $td = $this->mod_textdomain;
 878     $ptitle = isset($pconf['title_page'])?$pconf['title_page']:dgettext($td, 'RRD statistics index');
 879
 880     $out = '<html><head>'."\n";
 881     $out .= '<title>'.$ptitle.'</title>'."\n";
 882     $out .= '<style type="text/css">'."\n";
 883     if (isset($pconf['style_base'])) { $out .= $pconf['style_base']; }
 884     else {
 885       $out .= 'h1 { font-weight: bold; font-size: 1.5em; }'."\n";
 886       $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }'."\n";
 887       $out .= 'li.scanfile { font-style: italic; }'."\n";
 888     }
 889     if (isset($pconf['style'])) { $out .= $pconf['style']; }
 890     $out .= '</style>'."\n";
 891     $out .= '</head>'."\n";
 892     $out .= '<body>'."\n";
 893
 894     $out .= '<h1>'.$ptitle.'</h1>'."\n";
 895     if (isset($pconf['text_intro']) && strlen($pconf['text_intro'])) {
 896       $out .= '<p class="intro">'.$pconf['text_intro'].'</p>'."\n";
 897     }
 898     elseif (!isset($pconf['text_intro'])) {
 899       $out .= '<p class="intro">'.dgettext($td, 'The following RRD stats are available:').'</p>'."\n";
 900     }
 901
 902     $stats = $this->h_page_statsArray($pconf);
 903
 904     if (isset($pconf['stats_url'])) { $sURL_base = $pconf['stats_url']; }
 905     else { $sURL_base = '?stat=%i%a'; }
 906
 907     if (isset($pconf['stats_url_add'])) { $sURL_add = $pconf['stats_url_add']; }
 908     else { $sURL_add = '&sub=%s'; }
 909
 910     $out .= '<ul class="indexlist">'."\n";
 911     foreach ($stats as $stat) {
 912       $out .= '<li'.(isset($stat['class'])?' class="'.$stat['class'].'"':'').'>';
 913       $sURL = str_replace('%i', $stat['name'], $sURL_base);
 914       $sURL = str_replace('%a', '', $sURL);
 915       $sURL = str_replace('%s', '', $sURL);
 916       $out .= '<a href="'.$sURL.'">'.$stat['name'].'</a>';
 917       if (isset($stat['sub']) && count($stat['sub'])) {
 918         $sprt = array();
 919         foreach ($stat['sub'] as $ssub) {
 920           $sURL = str_replace('%i', $stat['name'], $sURL_base);
 921           $sURL = str_replace('%a', $sURL_add, $sURL);
 922           $sURL = str_replace('%s', $ssub, $sURL);
 923           $sprt[] = '<a href="'.$sURL.'">'.$ssub.'</a>';
 924         }
 925         $out .= ' <span="subs">('.implode(', ', $sprt).')</span>';
 926       }
 927       $out .= '</li>'."\n";
 928     }
 929     $out .= '</ul>'."\n";
 930
 931     $out .= $this->h_page_footer();
 932     $out .= '</body></html>'."\n";
 933   return $out;
 934   }
 935
 936   private function page_overview($pconf, $graph_extras = null) {
 937     // create an overview HTML page (including graphs) and return it in a string
 938     $td = $this->mod_textdomain;
 939     $ptitle = isset($pconf['title_page'])?$pconf['title_page']:dgettext($td, 'RRD statistics overview');
 940
 941     $out = '<html><head>'."\n";
 942     $out .= '<title>'.$ptitle.'</title>'."\n";
 943     $out .= '<style type="text/css">'."\n";
 944     if (isset($pconf['style_base'])) { $out .= $pconf['style_base']; }
 945     else {
 946       $out .= 'h1 { font-weight: bold; font-size: 1.5em; }'."\n";
 947       $out .= 'h2 { font-weight: bold; font-size: 1em; margin: 0.5em 0; }'."\n";
 948       $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }'."\n";
 949       $out .= 'img.rrdgraph { border: none; }'."\n";
 950     }
 951     if (isset($pconf['style'])) { $out .= $pconf['style']; }
 952     $out .= '</style>'."\n";
 953     $out .= '</head>'."\n";
 954     $out .= '<body>'."\n";
 955
 956     $out .= '<h1>'.$ptitle.'</h1>'."\n";
 957     if (isset($pconf['text_intro']) && strlen($pconf['text_intro'])) {
 958       $out .= '<p class="intro">'.$pconf['text_intro'].'</p>';
 959     }
 960
 961     $stats = $this->h_page_statsArray($pconf);
 962
 963     if (isset($pconf['stats_url'])) { $sURL_base = $pconf['stats_url']; }
 964     else { $sURL_base = '?stat=%i%a'; }
 965
 966     if (isset($pconf['stats_url_add'])) { $sURL_add = $pconf['stats_url_add']; }
 967     else { $sURL_add = '&sub=%s'; }
 968
 969     $default_num_rows = $GLOBALS['ua']->isMobile()?1:2;
 970     $num_rows = is_numeric($pconf['num_rows'])?$pconf['num_rows']:$default_num_rows;
 971     $num_cols = ceil(count($stats)/$num_rows);
 972
 973     $out .= '<table class="overview">'."\n";
 974     for ($col = 0; $col < $num_cols; $col++) {
 975       $out .= '<tr>'."\n";
 976       for ($row = 0; $row < $num_rows; $row++) {
 977         $idx = $col * $num_rows + $row;
 978         $out .= '<td>'."\n";
 979         if ($idx < count($stats)) {
 980           @list($sname, $s_psub) = explode('|', $stats[$idx]['name'], 2);
 981           $s_psname = 'page'.(isset($s_psub)?'.'.$s_psub:'');
 982           $g_sub = @$this->config_all[$sname][$s_psname]['graph_sub'];
 983
 984           if (isset($this->config_all[$sname][$s_psname]['title_page'])) {
 985             $s_ptitle = $this->config_all[$sname][$s_psname]['title_page'];
 986           }
 987           elseif (isset($this->config_all[$sname]['page']['title_page'])) {
 988             $s_ptitle = $this->config_all[$sname]['page']['title_page'];
 989           }
 990           else {
 991             $s_ptitle = isset($s_psub)
 992                         ?sprintf(dgettext($td, '%s (%s) statistics'), $sname, $s_psub)
 993                         :sprintf(dgettext($td, '%s statistics'), $sname);
 994           }
 995           if (!isset($pconf['hide_titles']) || !$pconf['hide_titles']) {
 996             $out .= '<h2>'.$s_ptitle.'</h2>'."\n";
 997           }
 998
 999           $s_rrd = new rrdstat($this->config_all, $sname);
1000           if (in_array($s_rrd->status, array('ok','readonly','graphonly'))) {
1001             $tframe = isset($pconf['graph_timeframe'])?$pconf['graph_timeframe']:'day';
1002             $gmeta = $s_rrd->graph_plus($tframe, $g_sub);
1003             if (isset($pconf['graph_url'])) {
1004               $gURL = $pconf['graph_url'];
1005               $gURL = str_replace('%f', basename($gmeta['filename']), $gURL);
1006               $gURL = str_replace('%p', $gmeta['filename'], $gURL);
1007               if (substr($gURL, -1) == '/') { $gURL .= $gmeta['filename']; }
1008             }
1009             else {
1010               $gURL = $gmeta['filename'];
1011             }
1012             $sURL = str_replace('%i', $sname, $sURL_base);
1013             $sURL = str_replace('%a', isset($s_psub)?$sURL_add:'', $sURL);
1014             $sURL = str_replace('%s', isset($s_psub)?$s_psub:'', $sURL);
1015             $out .= '<a href="'.$sURL.'">';
1016             $out .= '<img src="'.$gURL.'"';
1017             $out .= ' alt="'.$s_rrd->basename.(!is_null($g_sub)?' - '.$g_sub:'').' - '.$tframe.'" class="rrdgraph"';
1018             if (isset($gmeta['width']) && isset($gmeta['height'])) {
1019               $out .= ' style="width:'.$gmeta['width'].'px;height:'.$gmeta['height'].'px;"';
1020             }
1021             $out .= '></a>'."\n";
1022           }
1023           else {
1024             $out .= sprintf(dgettext($td, 'RRD error: status is "%s"'), $s_rrd->status)."\n";
1025           }
1026         }
1027         else {
1028           $out .= '&nbsp;';
1029         }
1030         $out .= '</td>'."\n";
1031       }
1032       $out .= '</tr>'."\n";
1033     }
1034     $out .= '</table>'."\n";
1035
1036     $out .= $this->h_page_footer();
1037     $out .= '</body></html>'."\n";
1038   return $out;
1039   }
1040
1041   private function page_simple($pconf, $graph_extras = null) {
1042     // create a simple (MRTG-like) HTML page and return it in a string
1043     $td = $this->mod_textdomain;
1044
1045     $ptitle = isset($pconf['title_page'])?$pconf['title_page']:sprintf(dgettext($td, '%s - RRD statistics'),$this->basename);
1046     $gtitle = array();
1047     $gtitle['day'] = isset($pconf['title_day'])?$pconf['title_day']:dgettext($td, 'Day overview (scaling 5 minutes)');
1048     $gtitle['week'] = isset($pconf['title_week'])?$pconf['title_week']:dgettext($td, 'Week overview (scaling 30 minutes)');
1049     $gtitle['month'] = isset($pconf['title_month'])?$pconf['title_month']:dgettext($td, 'Month overview (scaling 2 hours)');
1050     $gtitle['year'] = isset($pconf['title_year'])?$pconf['title_year']:dgettext($td, 'Year overview (scaling 1 day)');
1051     $ltitle = isset($pconf['title_legend'])?$pconf['title_legend']:dgettext($td, 'Legend:');
1052
1053     $out = '<html><head>'."\n";
1054     $out .= '<title>'.$ptitle.'</title>'."\n";
1055     $out .= '<style type="text/css">'."\n";
1056     if (isset($pconf['style_base'])) { $out .= $pconf['style_base']; }
1057     else {
1058       $out .= 'h1 { font-weight: bold; font-size: 1.5em; }'."\n";
1059       $out .= 'h2 { font-weight: bold; font-size: 1em; }'."\n";
1060       $out .= '.gdata, .gvar, .ginfo { font-size: 0.75em; margin: 0.5em 0; }'."\n";
1061       $out .= 'table.gdata, table.legend  { border: 1px solid gray; border-collapse: collapse; }'."\n";
1062       $out .= 'table.gdata td, table.gdata th, '."\n";
1063       $out .= 'table.legend td, table.legend th { border: 1px solid gray; padding: 0.1em 0.2em; }'."\n";
1064       $out .= 'div.legend { font-size: 0.75em; margin: 0.5em 0; }'."\n";
1065       $out .= 'div.legend p { margin: 0; }'."\n";
1066       $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }'."\n";
1067     }
1068     if (isset($pconf['style'])) { $out .= $pconf['style']; }
1069     $out .= '</style>'."\n";
1070     $out .= '</head>'."\n";
1071     $out .= '<body>'."\n";
1072
1073     $out .= '<h1>'.$ptitle.'</h1>'."\n";
1074     if (isset($pconf['text_intro']) && strlen($pconf['text_intro'])) {
1075       $out .= '<p class="intro">'.$pconf['text_intro'].'</p>'."\n";
1076     }
1077     if (!isset($pconf['show_update']) || $pconf['show_update']) {
1078       $out .= '<p class="last_up">';
1079       if (is_null($this->last_update())) { $up_time = dgettext($td, 'unknown'); }
1080       elseif (class_exists('baseutils')) { $up_time = baseutils::dateFormat($this->last_update(), 'short'); }
1081       else { $up_time = date('Y-m-d H:i:s', $this->last_update()); }
1082       $out .= sprintf(dgettext($td, 'Last Update: %s'), $up_time);
1083       $out .= '</p>'."\n";
1084     }
1085
1086     $g_sub = isset($pconf['graph_sub'])?$pconf['graph_sub']:null;
1087     if (in_array($this->status, array('ok','readonly','graphonly'))) {
1088       foreach (array('day','week','month','year') as $tframe) {
1089         $gmeta = $this->graph_plus($tframe, $g_sub, $graph_extras);
1090         if (isset($pconf['graph_url'])) {
1091           $gURL = $pconf['graph_url'];
1092           $gURL = str_replace('%f', basename($gmeta['filename']), $gURL);
1093           $gURL = str_replace('%p', $gmeta['filename'], $gURL);
1094           if (substr($gURL, -1) == '/') { $gURL .= $gmeta['filename']; }
1095         }
1096         else {
1097           $gURL = $gmeta['filename'];
1098         }
1099         $out .= '<div class="'.$tframe.'">'."\n";
1100         if (0) {
1101           // debug output
1102           ob_start();
1103           print_r($gmeta);
1104           $buffer = ob_get_contents();
1105           ob_end_clean();
1106           $out .= '<p>'.nl2br($buffer).'</p>';
1107         }
1108         $out .= '<h2>'.$gtitle[$tframe].'</h2>'."\n";
1109         $out .= '<img src="'.$gURL.'"';
1110         $out .= ' alt="'.$this->basename.(!is_null($g_sub)?' - '.$g_sub:'').' - '.$tframe.'" class="rrdgraph"';
1111         if (isset($gmeta['width']) && isset($gmeta['height'])) {
1112           $out .= ' style="width:'.$gmeta['width'].'px;height:'.$gmeta['height'].'px;"';
1113         }
1114         $out .= '>'."\n";
1115         $colorize_data = (isset($pconf['data_colorize']) && $pconf['data_colorize']) ||
1116                          (!isset($pconf['data_colorize']) && $gmeta['default_colorize']);
1117         if (isset($gmeta['data']) && count($gmeta['data'])) {
1118           $out .= '<table class="gdata">'."\n";
1119           foreach ($gmeta['data'] as $field=>$gdata) {
1120             $out .= '<tr><th';
1121             if ($colorize_data && isset($gmeta['legend'][$field])) {
1122               $out .= ' style="color:'.$gmeta['legend'][$field]['color'].';';
1123               if (strlen($gmeta['legend'][$field]['color_bg'])) {
1124                 $out .= 'background-color:'.$gmeta['legend'][$field]['color_bg'].';';
1125               }
1126               $out .= '"';
1127             }
1128             $out .= '>'.$field.'</th>';
1129             foreach ($gdata as $gkey=>$gval) {
1130               $out .= '<td><span class="gkey">'.$gkey.': </span>'.$gval.'</td>';
1131             }
1132             $out .= '</tr>'."\n";
1133           }
1134           $out .= '</table>'."\n";
1135         }
1136         if (isset($gmeta['var']) && count($gmeta['var'])) {
1137           foreach ($gmeta['var'] as $gkey=>$gval) {
1138             $out .= '<p class="gvar"><span class="gkey">'.$gkey.': </span>'.$gval.'</p>'."\n";
1139           }
1140         }
1141         if (isset($gmeta['info']) && count($gmeta['info'])) {
1142           foreach ($gmeta['info'] as $gval) {
1143             $out .= '<p class="ginfo">'.$gval.'</p>'."\n";
1144           }
1145         }
1146         $out .= '</div>'."\n";
1147       }
1148       if ($gmeta['legends_long'] && (!isset($pconf['show_legend']) || $pconf['show_legend'])) {
1149         $out .= '<div class="legend">'."\n";
1150         $out .= '<p>'.$ltitle.'</p>'."\n";
1151         $out .= '<table class="legend">'."\n";
1152         foreach ($gmeta['legend'] as $field=>$legend) {
1153           if (strlen($legend['desc_long'])) {
1154             $out .= '<tr><th';
1155             if ($colorize_data && isset($gmeta['legend'][$field])) {
1156               $out .= ' style="color:'.$gmeta['legend'][$field]['color'].';';
1157               if (strlen($gmeta['legend'][$field]['color_bg'])) {
1158                 $out .= 'background-color:'.$gmeta['legend'][$field]['color_bg'].';';
1159               }
1160               $out .= '"';
1161             }
1162             $out .= '>'.$field.'</th>';
1163             $out .= '<td>'.$legend['desc_long'].'</td>';
1164             $out .= '</tr>'."\n";
1165           }
1166         }
1167         $out .= '</table>'."\n";
1168         $out .= '</div>'."\n";
1169       }
1170     }
1171     else {
1172       $out .= sprintf(dgettext($td, 'RRD error: status is "%s"'), $this->status)."\n";
1173     }
1174
1175     $out .= $this->h_page_footer();
1176     $out .= '</body></html>'."\n";
1177   return $out;
1178   }
1179
1180   private function h_page_statsArray($pconf) {
1181     // return array of stats to list on a page
1182     $stats = array();
1183     $snames = array(); $s_exclude = array(); $sfiles = array();
1184     if (isset($pconf['index_ids'])) {
1185       foreach (explode(',', $pconf['index_ids']) as $iid) {
1186         if ($iid{0} == '-') { $s_exclude[] = substr($iid, 1); }
1187         else { $snames[] = $iid; }
1188       }
1189     }
1190     if (!isset($pconf['scan_config']) || $pconf['scan_config']) {
1191       foreach ($this->config_all as $iname=>$rinfo) {
1192         if (($iname != '*') && !(isset($rinfo['hidden']) && $rinfo['hidden']) &&
1193             !(in_array($iname, $snames)) && !(in_array($iname, $s_exclude))) {
1194           $snames[] = $iname;
1195         }
1196       }
1197     }
1198     foreach ($snames as $iname) {
1199       $newstat = array('name'=>$iname);
1200       $sfiles[] = isset($this->config_all[$iname]['file'])?$this->config_all[$iname]['file']:$iname.'.rrd';
1201       if (is_array($this->config_all[$iname])) {
1202         foreach ($this->config_all[$iname] as $key=>$val) {
1203           if (substr($key, 0, 5) == 'page.') { $newstat['sub'][] = substr($key, 5); }
1204         }
1205       }
1206       $stats[] = $newstat;
1207     }
1208     if (isset($pconf['scan_files']) && $pconf['scan_files']) {
1209       $rrdfiles = glob('*.rrd');
1210       foreach ($rrdfiles as $rrdfile) {
1211         $iname = (substr($rrdfile, -4) == '.rrd')?substr($rrdfile, 0, -4):$rrdfile;
1212         if (!in_array($rrdfile, $sfiles) && !(in_array($iname, $s_exclude))) {
1213           $stats[] = array('name'=>$iname, 'class'=>'scanfile');
1214         }
1215       }
1216     }
1217   return $stats;
1218   }
1219
1220   private function h_page_footer() {
1221     // return generic page footer
1222     $out = '<p class="footer">';
1223     $out .= sprintf(dgettext($this->mod_textdomain, 'Statistics created with %s using a library created by %s.'),
1224                     '<a href="http://oss.oetiker.ch/rrdtool/">RRDtool</a>',
1225                     '<a href="http://www.kairo.at/">KaiRo.at</a>');
1226     $out .= '</p>'."\n";
1227   return $out;
1228   }
1229
1230   private function text_quote($text) {
1231     $trans = array('"' => '\"', ':' => '\:');
1232     $qtext = '"'.strtr($text, $trans).'"';
1233   return $qtext;
1234   }
1235 }
1236 ?>