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             if (substr_count($ds['update'], ':') >= 4) {
 370               list($nix, $snmphost, $snmpcomm, $ifname, $valtype) = explode(':', $ds['update'], 5);
 371             }
 372             else {
 373               $snmphost = 'localhost'; $snmpcomm = 'public';
 374               list($nix, $ifname, $valtype) = explode(':', $ds['update'], 3);
 375             }
 376             $iflist = explode("\n", `snmpwalk -v2c -c $snmpcomm $snmphost interfaces.ifTable.ifEntry.ifDescr`);
 377             $ifnr = null;
 378             foreach ($iflist as $ifdesc) {
 379               if (preg_match('/ifDescr\.(\d+) = STRING: '.$ifname.'/', $ifdesc, $regs)) { $ifnr = $regs[1]; }
 380             }
 381             $oid = null;
 382             if ($valtype == 'in') { $oid = '1.3.6.1.2.1.2.2.1.10.'.$ifnr; }
 383             elseif ($valtype == 'out') { $oid = '1.3.6.1.2.1.2.2.1.16.'.$ifnr; }
 384             if (!is_null($ifnr) && !is_null($oid)) {
 385               $evalcode = 'function { return trim(substr(strrchr(`snmpget -v2c -c '.$snmpcomm.' '.$snmphost.' '.$oid.'`,":"),1)); }';
 386             }
 387           }
 388           else { $evalcode = $ds['update']; }
 389           if (preg_match('/^\s*function\s+{(.*)}\s*$/is', $evalcode, $regs)) {
 390             $upfunc = create_function('', $regs[1]);
 391             $val = $upfunc();
 392           }
 393           elseif (!is_null($evalcode)) {
 394             ob_start();
 395             eval($evalcode);
 396             $val = ob_get_contents();
 397             ob_end_clean();
 398           }
 399         }
 400         else { $val = null; }
 401         $upvals[$ds['name']] = $val;
 402       }
 403     }
 404     $upval_keys = array_keys($upvals);
 405     $keys_have_names = !is_numeric(array_shift($upval_keys));
 406     if (in_array('L', $upvals, true)) {
 407       // for at least one value, we need to set the same as the last recorded value
 408       $fvals = $this->fetch();
 409       $rowids = array_shift($fvals);
 410       $lastvals = array_shift($fvals);
 411       foreach (array_keys($upvals, 'L') as $akey) {
 412         $upvals[$akey] = $keys_have_names?$lastvals[$akey]:$lastvals[$rowids[$akey]];
 413       }
 414     }
 415     $walkfunc = create_function('&$val,$key', '$val = is_numeric(trim($val))?trim($val):"U";');
 416     array_walk($upvals, $walkfunc);
 417     $return = null;
 418     if (count($upvals)) {
 419       $update_cmd = $this->rrdtool_bin.' update '.$this->rrd_file
 420                     .($keys_have_names?' --template '.implode(':', array_keys($upvals)):'').' N:'.implode(':', $upvals);
 421       $return = `$update_cmd 2>&1`;
 422     }
 423
 424     if (strpos($return, 'ERROR') !== false) {
 425       trigger_error($this->rrd_file.' - rrd update error: '.$return, E_USER_WARNING);
 426       $success = false;
 427     }
 428     else { $success = true; }
 429   return $success;
 430   }
 431
 432   public function fetch($cf = 'AVERAGE', $resolution = null, $start = null, $end = null) {
 433     // fetch data from a RRD
 434     if (!in_array($this->status, array('ok','readonly'))) {
 435       trigger_error('Error: rrd status is '.$this->status, E_USER_WARNING); return false;
 436     }
 437
 438     if (!in_array($cf, array('AVERAGE','MIN','MAX','LAST'))) { $cf = 'AVERAGE'; }
 439     if (!is_numeric($resolution)) { $resolution = $this->rrd_step; }
 440     if (!is_numeric($end)) { $end = $this->last_update(); }
 441     elseif ($end < 0) { $end += $this->last_update(); }
 442     $end = intval($end/$resolution)*$resolution;
 443     if (!is_numeric($start)) { $start = $end; }
 444     elseif ($start < 0) { $start += $end; }
 445     $start = intval($start/$resolution)*$resolution;
 446
 447     $fetch_cmd = $this->rrdtool_bin.' fetch '.$this->rrd_file.' '.$cf.' --resolution '.$resolution
 448                  .' --start '.$start.' --end '.$end;
 449     $return = `$fetch_cmd 2>&1`;
 450
 451     if (strpos($return, 'ERROR') !== false) {
 452       trigger_error($this->rrd_file.' - rrd fetch error: '.$return, E_USER_WARNING);
 453       $fresult = false;
 454     }
 455     else {
 456       $fresult = array();
 457       $rows = explode("\n", $return);
 458       $fields = preg_split('/\s+/', array_shift($rows));
 459       if (array_shift($fields) == 'timestamp') {
 460         $fresult[0] = $fields;
 461         foreach ($rows as $row) {
 462           if (strlen(trim($row))) {
 463             $rvals = preg_split('/\s+/', $row);
 464             $rtime = str_replace(':', '', array_shift($rvals));
 465             $rv_array = array();
 466             foreach ($rvals as $key=>$rval) {
 467               $rv_array[$fields[$key]] = ($rval=='nan')?null:floatval($rval);
 468             }
 469             $fresult[$rtime] = $rv_array;
 470           }
 471         }
 472       }
 473     }
 474   return $fresult;
 475   }
 476
 477   public function last_update() {
 478     // fetch time of last update in this RRD file
 479     static $last_update;
 480     if (!isset($last_update) && in_array($this->status, array('ok','readonly'))) {
 481       $last_cmd = $this->rrdtool_bin.' last '.$this->rrd_file;
 482       $return = trim(`$last_cmd 2>&1`);
 483       $last_update = is_numeric($return)?$return:null;
 484     }
 485   return isset($last_update)?$last_update:null;
 486   }
 487
 488   public function graph($timeframe = 'day', $sub = null, $extra = null) {
 489     // create a RRD graph
 490     static $gColors;
 491     if (!isset($gColors)) {
 492       $gColors = array('#00CC00','#0000FF','#000000','#FF0000','#00FF00','#FFFF00','#FF00FF','#00FFFF',
 493                        '#808080','#800000','#008000','#000080','#808000','#800080','#008080','#C0C0C0');
 494     }
 495
 496     if (!in_array($this->status, array('ok','readonly','graphonly'))) {
 497       trigger_error('Error: rrd status is '.$this->status, E_USER_WARNING); return false;
 498     }
 499
 500     // assemble configuration
 501     $gconf = (array)$extra;
 502     if (!is_null($sub) && is_array($this->config_raw['graph.'.$sub])) {
 503       $gconf = $gconf + $this->config_raw['graph.'.$sub];
 504     }
 505     $gconf = $gconf + (array)$this->config_graph;
 506
 507     if (isset($gconf['format']) && ($gconf['format'] == 'SVG')) {
 508       $format = $gconf['format']; $fmt_ext = '.svg';
 509     }
 510     elseif (isset($gconf['format']) && ($gconf['format'] == 'EPS')) {
 511       $format = $gconf['format']; $fmt_ext = '.eps';
 512     }
 513     elseif (isset($gconf['format']) && ($gconf['format'] == 'PDF')) {
 514       $format = $gconf['format']; $fmt_ext = '.pdf';
 515     }
 516     else {
 517       $format = 'PNG'; $fmt_ext = '.png';
 518     }
 519
 520     if (isset($gconf['filename'])) { $fname = $gconf['filename']; }
 521     else { $fname = $this->basename.(is_null($sub)?'':'-%s').'-%t%f'; }
 522     $fname = str_replace('%s', strval($sub), $fname);
 523     $fname = str_replace('%t', $timeframe, $fname);
 524     $fname = str_replace('%f', $fmt_ext, $fname);
 525     if (substr($fname, -strlen($fmt_ext)) != $fmt_ext) { $fname .= $fmt_ext; }
 526     if (isset($gconf['path']) && ($fname{0} != '/')) { $fname = $gconf['path'].'/'.$fname; }
 527     if ($fname{0} != '/') { $fname = $this->basedir.$fname; }
 528     $fname = str_replace('//', '/', $fname);
 529
 530     $graphrows = array(); $specialrows = array(); $gC = 0;
 531     $gDefs = ''; $gGraphs = ''; $addSpecial = '';
 532
 533     // the default size for the graph area has a width of 400px, so use 400 slices by default
 534     if ($timeframe == 'day') {
 535       $slice = isset($gconf['slice'])?$gconf['slice']:300; // 5 minutes
 536       $duration = isset($gconf['duration'])?$gconf['duration']:400*$slice; // 33.33 hours
 537       // vertical lines at day borders
 538       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d')).'#FF0000';
 539       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d').' -1 day').'#FF0000';
 540       if (!isset($gconf['grid_x'])) { $gconf['grid_x'] = 'HOUR:1:HOUR:6:HOUR:2:0:%-H'; }
 541     }
 542     elseif ($timeframe == 'week') {
 543       $slice = isset($gconf['slice'])?$gconf['slice']:1800; // 30 minutes
 544       $duration = isset($gconf['duration'])?$gconf['duration']:400*$slice; // 8.33 days
 545       // vertical lines at week borders
 546       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d').' '.(-date('w')+1).' day').'#FF0000';
 547       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d').' '.(-date('w')-6).' day').'#FF0000';
 548     }
 549     elseif ($timeframe == 'month') {
 550       $slice = isset($gconf['slice'])?$gconf['slice']:7200; // 2 hours
 551       $duration = isset($gconf['duration'])?$gconf['duration']:400*$slice; // 33.33 days
 552       // vertical lines at month borders
 553       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-01')).'#FF0000';
 554       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-01').' -1 month').'#FF0000';
 555     }
 556     elseif ($timeframe == 'year') {
 557       $slice = isset($gconf['slice'])?$gconf['slice']:86400; // 1 day
 558       $duration = isset($gconf['duration'])?$gconf['duration']:400*$slice; // 400 days
 559       // vertical lines at month borders
 560       $addSpecial .= ' VRULE:'.strtotime(date('Y-01-01 12:00:00')).'#FF0000';
 561       $addSpecial .= ' VRULE:'.strtotime(date('Y-01-01 12:00:00').' -1 year').'#FF0000';
 562     }
 563     else {
 564       $duration = isset($gconf['duration'])?$gconf['duration']:$this->rrd_step*500; // 500 steps
 565       $slice = isset($gconf['slice'])?$gconf['slice']:$this->rrd_step; // whatever our step is
 566     }
 567
 568     $use_gcrows = (isset($gconf['rows']) && count($gconf['rows']));
 569     if ($use_gcrows) { $grow_def =& $gconf['rows']; }
 570     else { $grow_def =& $this->rrd_fields; }
 571     foreach ($grow_def as $key=>$erow) {
 572       if (isset($erow['name']) && strlen($erow['name'])) {
 573         if (!isset($erow['scale']) && isset($gconf['scale'])) { $erow['scale'] = $gconf['scale']; }
 574         if (!isset($erow['scale_time_src']) && isset($gconf['scale_time_src'])) {
 575           $erow['scale_time_src'] = $gconf['scale_time_src'];
 576         }
 577         if (!isset($erow['scale_time_tgt']) && isset($gconf['scale_time_tgt'])) {
 578           $erow['scale_time_tgt'] = $gconf['scale_time_tgt'];
 579         }
 580         foreach (array('scale_time_src','scale_time_tgt') as $st) {
 581           if (!isset($erow[$st]) || !is_numeric($erow[$st])) {
 582             switch (@$erow[$st]) {
 583               case 'dyn':
 584               case 'auto':
 585                 $erow[$st] = $slice;
 586                 break;
 587               case 'day':
 588                 $erow[$st] = 24*3600;
 589                 break;
 590               case '2hr':
 591               case '2hours':
 592                 $erow[$st] = 7200;
 593                 break;
 594               case 'hr':
 595               case 'hour':
 596                 $erow[$st] = 3600;
 597                 break;
 598               case '30min':
 599                 $erow[$st] = 1800;
 600                 break;
 601               case '5min':
 602                 $erow[$st] = 300;
 603                 break;
 604               case 'min':
 605                 $erow[$st] = 60;
 606                 break;
 607               case 's':
 608               case 'sec':
 609               default:
 610                 $erow[$st] = 1;
 611                 break;
 612             }
 613           }
 614         }
 615         $scale_time_factor = $erow['scale_time_tgt']/$erow['scale_time_src'];
 616         if ($scale_time_factor != 1) { $erow['scale'] = (isset($erow['scale'])?$erow['scale']:1)*$scale_time_factor; }
 617         $grow = array();
 618         $grow['dType'] = ($use_gcrows && isset($erow['dType']))?$erow['dType']:'DEF';
 619         $grow['name'] = $erow['name'].(isset($erow['scale'])?'_tmp':'');
 620         if ($grow['dType'] == 'DEF') {
 621           $grow['dsname'] = ($use_gcrows && isset($erow['dsname']))?$erow['dsname']:$erow['name'];
 622           if ($use_gcrows && isset($erow['dsfile'])) { $grow['dsfile'] = $erow['dsfile']; }
 623           $grow['cf'] = ($use_gcrows && isset($erow['cf']))?$erow['cf']:'AVERAGE';
 624         }
 625         else {
 626           $grow['rpn_expr'] = isset($erow['rpn_expr'])?$erow['rpn_expr']:'0';
 627         }
 628         if (isset($erow['scale'])) {
 629           $graphrows[] = $grow;
 630           $grow = array();
 631           $grow['dType'] = 'CDEF';
 632           $grow['name'] = $erow['name'];
 633           $grow['rpn_expr'] = $erow['name'].'_tmp,'.$erow['scale'].',*';
 634         }
 635         if ($use_gcrows) { $grow['gType'] = isset($erow['gType'])?$erow['gType']:'LINE1'; }
 636         else { $grow['gType'] = ((count($grow_def)==2) && ($key==0))?'AREA':'LINE1'; }
 637         $grow['color'] = isset($erow['color'])?$erow['color']:$gColors[$gC++];
 638         $grow['color_bg'] = isset($erow['color_bg'])?$erow['color_bg']:'';
 639         if ($gC >= count($gColors)) { $gC = 0; }
 640         if (isset($erow['legend'])) {
 641           $grow['legend'] = $erow['legend'];
 642           if (!isset($gconf['show_legend'])) { $gconf['show_legend'] = true; }
 643         }
 644         if (isset($erow['stack'])) { $grow['stack'] = ($erow['stack'] == true); }
 645         if (isset($erow['desc'])) { $grow['desc'] = $erow['desc']; }
 646         if (isset($erow['legend_long'])) { $grow['legend_long'] = $erow['legend_long']; }
 647         $graphrows[] = $grow;
 648       }
 649     }
 650
 651     if (isset($gconf['special']) && count($gconf['special'])) {
 652       foreach ($gconf['special'] as $crow) {
 653         $srow = array();
 654         $srow['sType'] = isset($crow['sType'])?$crow['sType']:'COMMENT';
 655         if ($grow['sType'] != 'COMMENT') {
 656           // XXX: use line below and remove cf var once we have rrdtol 1.2
 657           if ($this->rrd_version() >= '1.2') {
 658             $srow['name'] = $crow['name'].(isset($crow['cf'])?'_'.$crow['cf']:'');
 659           }
 660           else {
 661             $srow['name'] = $crow['name'];
 662             $srow['cf'] = isset($crow['cf'])?$crow['cf']:'AVERAGE';
 663           }
 664           if (isset($crow['cf'])) {
 665             if ($this->rrd_version() >= '1.2') {
 666               $graphrows[] = array('dType'=>'VDEF', 'name'=>$srow['name'].'_'.$crow['cf'],
 667                                    'rpn_expr'=>$srow['name'].','.$crow['cf']);
 668             }
 669           }
 670           elseif (isset($crow['rpn_expr'])) {
 671             if ($this->rrd_version() >= '1.2') {
 672               $graphrows[] = array('dType'=>'VDEF', 'name'=>$srow['name'], 'rpn_expr'=>$crow['rpn_expr']);
 673             }
 674           }
 675         }
 676         $srow['text'] = isset($crow['text'])?$crow['text']:'';
 677         $specialrows[] = $srow;
 678       }
 679     }
 680     else {
 681       $td = $this->mod_textdomain;
 682       foreach ($graphrows as $grow) {
 683         if (isset($grow['gType']) && strlen($grow['gType'])) {
 684           $textprefix = isset($grow['desc'])?$grow['desc']:(isset($grow['legend'])?$grow['legend']:$grow['name']);
 685           if ($this->rrd_version() >= '1.2') {
 686             $graphrows[] = array('dType'=>'VDEF', 'name'=>'_'.$grow['name'].'__max', 'rpn_expr'=>$grow['name'].',MAXIMUM');
 687             $specialrows[] = array('sType'=>'PRINT', 'name'=>'_'.$grow['name'].'__max',
 688                                    'text'=>$textprefix.'|'.dgettext($td, 'Maximum').'|%.2lf%s');
 689             $graphrows[] = array('dType'=>'VDEF', 'name'=>'_'.$grow['name'].'__avg', 'rpn_expr'=>$grow['name'].',AVERAGE');
 690             $specialrows[] = array('sType'=>'PRINT', 'name'=>'_'.$grow['name'].'__avg',
 691                                    'text'=>$textprefix.'|'.dgettext($td, 'Average').'|%.2lf%s');
 692             $graphrows[] = array('dType'=>'VDEF', 'name'=>'_'.$grow['name'].'__last', 'rpn_expr'=>$grow['name'].',LAST');
 693             $specialrows[] = array('sType'=>'PRINT', 'name'=>'_'.$grow['name'].'__last',
 694                                    'text'=>$textprefix.'|'.dgettext($td, 'Current').'|%.2lf%s');
 695           }
 696           else {
 697             $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'MAX',
 698                                    'text'=>$textprefix.'|'.dgettext($td, 'Maximum').'|%.2lf%s');
 699             $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'AVERAGE',
 700                                    'text'=>$textprefix.'|'.dgettext($td, 'Average').'|%.2lf%s');
 701             $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'LAST',
 702                                    'text'=>$textprefix.'|'.dgettext($td, 'Current').'|%.2lf%s');
 703           }
 704         }
 705       }
 706     }
 707
 708     $endtime = isset($gconf['time_end'])?$gconf['time_end']:(is_numeric($this->last_update())?$this->last_update():time());
 709     $gOpts = ' --start '.($endtime-$duration).' --end '.$endtime.' --step '.$slice;
 710     if (isset($gconf['label_top'])) { $gOpts .= ' --title '.$this->text_quote($gconf['label_top']); }
 711     if (isset($gconf['label_y'])) { $gOpts .= ' --vertical-label '.$this->text_quote($gconf['label_y']); }
 712     if (isset($gconf['width'])) { $gOpts .= ' --width '.$gconf['width']; }
 713     if (isset($gconf['height'])) { $gOpts .= ' --height '.$gconf['height'];
 714       if (($gconf['height'] <= 32) && isset($gconf['thumb']) && ($gconf['thumb'])) { $gOpts .= ' --only-graph'; }
 715     }
 716     if (!isset($gconf['show_legend']) || (!$gconf['show_legend'])) { $gOpts .= ' --no-legend'; }
 717     if (isset($gconf['logarithmic']) && $gconf['logarithmic']) { $gOpts .= ' --logarithmic'; }
 718     if (isset($gconf['min_y'])) { $gOpts .= ' --lower-limit '.$gconf['min_y']; }
 719     if (isset($gconf['max_y'])) { $gOpts .= ' --upper-limit '.$gconf['max_y']; }
 720     if (isset($gconf['fix_scale_y']) && $gconf['fix_scale_y']) { $gOpts .= ' --rigid'; }
 721     if (isset($gconf['grid_x'])) { $gOpts .= ' --x-grid '.$gconf['grid_x']; }
 722     if (isset($gconf['grid_y'])) { $gOpts .= ' --y-grid '.$gconf['grid_y']; }
 723     if (isset($gconf['gridfit']) && (!$gconf['gridfit'])) { $gOpts .= ' --no-gridfit'; }
 724     if (isset($gconf['calc_scale_y']) && $gconf['calc_scale_y']) { $gOpts .= ' --alt-autoscale'; }
 725     if (isset($gconf['calc_max_y']) && $gconf['calc_max_y']) { $gOpts .= ' --alt-autoscale-max'; }
 726     if (isset($gconf['units_exponent'])) { $gOpts .= ' --units-exponent '.$gconf['units_exponent']; }
 727     if (isset($gconf['units_length'])) { $gOpts .= ' --units-length '.$gconf['units_length']; }
 728     if (($this->rrd_version() < '1.2') || !count($specialrows)) {
 729       // lazy graphics omit all print reporting in RRDtool 1.2!
 730       // --> so don't use them there when we want to print stuff
 731       if (!isset($gconf['force_recreate']) || (!$gconf['force_recreate'])) { $gOpts .= ' --lazy'; }
 732     }
 733     if (isset($gconf['force_color']) && is_array($gconf['force_color'])) {
 734       foreach ($gconf['force_color'] as $ctag=>$cval) { $gOpts .= ' --color '.$ctag.$cval; }
 735     }
 736     if (isset($gconf['force_font']) && is_array($gconf['force_font'])) {
 737       foreach ($gconf['force_font'] as $ctag=>$cval) { $gOpts .= ' --font '.$ctag.$cval; }
 738     }
 739     if (isset($gconf['units_binary']) && $gconf['units_binary']) { $gOpts .= ' --base 1024'; }
 740
 741     foreach ($graphrows as $grow) {
 742       if (isset($grow['dType']) && strlen($grow['dType'])) {
 743         $gDefs .= ' '.$grow['dType'].':'.$grow['name'].'=';
 744         if ($grow['dType'] == 'DEF') {
 745           $gDefs .= isset($grow['dsfile'])?$grow['dsfile']:$this->rrd_file;
 746           $gDefs .= ':'.$grow['dsname'].':'.$grow['cf'];
 747         }
 748         else { $gDefs .= $grow['rpn_expr']; }
 749       }
 750       if (isset($grow['gType']) && strlen($grow['gType'])) {
 751         // XXX: change from STACK type to STACK flag once we have rrdtool 1.2
 752         if ($this->rrd_version() < '1.2') {
 753           // rrdtool 1.0 only know STACK type
 754           if (isset($grow['stack']) && $grow['stack']) { $grow['gType'] = 'STACK'; }
 755         }
 756         $gGraphs .= ' '.$grow['gType'].':'.$grow['name'].$grow['color'];
 757         if (isset($grow['legend'])) { $gGraphs .= ':'.$this->text_quote($grow['legend']); }
 758         if ($this->rrd_version() >= '1.2') {
 759           // rrdtool 1.2 and above have STACK flag
 760           if (isset($grow['stack']) && $grow['stack']) { $gGraphs .= ':STACK'; }
 761         }
 762       }
 763     }
 764
 765     foreach ($specialrows as $srow) {
 766       $addSpecial .= ' '.$srow['sType'];
 767       if ($this->rrd_version() >= '1.2') {
 768         $addSpecial .= (($srow['sType']!='COMMENT')?':'.$srow['name']:'');
 769       }
 770       else {
 771         $addSpecial .= (($srow['sType']!='COMMENT')?':'.$srow['name'].':'.$srow['cf']:'');
 772       }
 773       $addSpecial .= ':'.$this->text_quote($srow['text']);
 774     }
 775
 776     $graph_cmd = $this->rrdtool_bin.' graph '.str_replace('*', '\*', $fname.$gOpts.$gDefs.$gGraphs.$addSpecial);
 777     $return = `$graph_cmd 2>&1`;
 778
 779     if (strpos($return, 'ERROR') !== false) {
 780       trigger_error($this->rrd_file.' - rrd graph error: '.$return, E_USER_WARNING);
 781       $return = 'command:'.$graph_cmd."\n\n".$return;
 782     }
 783     if (0) {
 784       // debug output
 785       $return = 'command:'.$graph_cmd."\n\n".$return;
 786     }
 787     $legendlines = '';
 788     foreach ($graphrows as $grow) {
 789       $legendline = isset($grow['desc'])?$grow['desc']:(isset($grow['legend'])?$grow['legend']:$grow['name']);
 790       $legendline .= '|'.@$grow['color'];
 791       $legendline .= '|'.(isset($grow['color_bg'])?$grow['color_bg']:'');
 792       $legendline .= '|'.(isset($grow['legend_long'])?$grow['legend_long']:'');
 793       $legendlines .= 'legend:'.$legendline."\n";
 794     }
 795     $return = 'file:'.$fname."\n".$legendlines.$return;
 796   return $return;
 797   }
 798
 799   public function graph_plus($timeframe = 'day', $sub = null, $extra = null) {
 800     // create a RRD graph and return meta info as a ready-to-use array
 801     $gmeta = array('filename'=>null,'legends_long'=>false,'default_colorize'=>false);
 802     $ret = $this->graph($timeframe, $sub, $extra);
 803     if (0) {
 804       // debug output
 805       $gmeta['ret'] = $ret;
 806     }
 807     $grout = explode("\n", $ret);
 808     foreach ($grout as $gline) {
 809       if (preg_match('/^command:(.+)$/', $gline, $regs)) {
 810         $gmeta['graph_cmd'] = $regs[1];
 811       }
 812       elseif (preg_match('/^file:(.+)$/', $gline, $regs)) {
 813         $gmeta['filename'] = $regs[1];
 814       }
 815       elseif (preg_match('/^legend:([^\|]+)\|([^|]*)\|([^\|]*)\|(.*)$/', $gline, $regs)) {
 816         $gmeta['legend'][$regs[1]] = array('color'=>$regs[2], 'color_bg'=>$regs[3], 'desc_long'=>$regs[4]);
 817         if (strlen($regs[4])) { $gmeta['legends_long'] = true; }
 818         if (strlen($regs[3]) || strlen($regs[4])) { $gmeta['default_colorize'] = true; }
 819       }
 820       elseif (preg_match('/^(\d+)x(\d+)$/', $gline, $regs)) {
 821         $gmeta['width'] = $regs[1]; $gmeta['height'] = $regs[2];
 822       }
 823       elseif (preg_match('/^([^\|]+)\|([^|]+)\|([^\|]*)$/', $gline, $regs)) {
 824         $gmeta['data'][$regs[1]][$regs[2]] = $regs[3];
 825       }
 826       elseif (preg_match('/^([^\|]+)\|([^\|]*)$/', $gline, $regs)) {
 827         $gmeta['var'][$regs[1]] = $regs[2];
 828       }
 829       elseif (strlen(trim($gline))) {
 830         $gmeta['info'][] = $gline;
 831       }
 832     }
 833     if (is_null($gmeta['filename'])) {
 834       $gmeta['filename'] = $this->basename.(!is_null($sub)?'-'.$sub:'').'-'.$timeframe.'.png';
 835     }
 836   return $gmeta;
 837   }
 838
 839   public function page($sub = null, $page_extras = null, $graph_extras = null) {
 840     // create a (HTML) page and return it in a string
 841
 842     // assemble configuration
 843     $pconf = (array)$page_extras;
 844     if (!is_null($sub) && is_array($this->config_raw['page.'.$sub])) {
 845       $pconf = $pconf + $this->config_raw['page.'.$sub];
 846     }
 847     $pconf = $pconf + (array)$this->config_page;
 848
 849     $return = null;
 850     switch (@$pconf['type']) {
 851       case 'index':
 852         $return = $this->page_index($pconf);
 853         break;
 854       case 'overview':
 855         $return = $this->page_overview($pconf, $graph_extras);
 856         break;
 857       case 'simple':
 858       default:
 859         $return = $this->page_simple($pconf, $graph_extras);
 860         break;
 861     }
 862   return $return;
 863   }
 864
 865   public function simple_html($sub = null, $page_extras = null, $graph_extras = null) {
 866     // create a simple (MRTG-like) HTML page and return it in a string
 867     // XXX: this is here temporarily for compat only, it's preferred to use page()!
 868     trigger_error(__CLASS__.'::'.__METHOD__.' is deprecated, use page() instead.', E_USER_NOTICE);
 869
 870     // assemble configuration
 871     $pconf = (array)$page_extras;
 872     if (!is_null($sub) && is_array($this->config_raw['page.'.$sub])) {
 873       $pconf = $pconf + $this->config_raw['page.'.$sub];
 874     }
 875     $pconf = $pconf + (array)$this->config_page;
 876
 877   return $this->page_simple($pconf, $graph_extras);
 878   }
 879
 880   private function page_index($pconf) {
 881     // create a bare, very simple index list HTML page and return it in a string
 882     $td = $this->mod_textdomain;
 883     $ptitle = isset($pconf['title_page'])?$pconf['title_page']:dgettext($td, 'RRD statistics index');
 884
 885     $out = '<html><head>'."\n";
 886     $out .= '<title>'.$ptitle.'</title>'."\n";
 887     $out .= '<style type="text/css">'."\n";
 888     if (isset($pconf['style_base'])) { $out .= $pconf['style_base']; }
 889     else {
 890       $out .= 'h1 { font-weight: bold; font-size: 1.5em; }'."\n";
 891       $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }'."\n";
 892       $out .= 'li.scanfile { font-style: italic; }'."\n";
 893     }
 894     if (isset($pconf['style'])) { $out .= $pconf['style']; }
 895     $out .= '</style>'."\n";
 896     $out .= '</head>'."\n";
 897     $out .= '<body>'."\n";
 898
 899     $out .= '<h1>'.$ptitle.'</h1>'."\n";
 900     if (isset($pconf['text_intro']) && strlen($pconf['text_intro'])) {
 901       $out .= '<p class="intro">'.$pconf['text_intro'].'</p>'."\n";
 902     }
 903     elseif (!isset($pconf['text_intro'])) {
 904       $out .= '<p class="intro">'.dgettext($td, 'The following RRD stats are available:').'</p>'."\n";
 905     }
 906
 907     $stats = $this->h_page_statsArray($pconf);
 908
 909     if (isset($pconf['stats_url'])) { $sURL_base = $pconf['stats_url']; }
 910     else { $sURL_base = '?stat=%i%a'; }
 911
 912     if (isset($pconf['stats_url_add'])) { $sURL_add = $pconf['stats_url_add']; }
 913     else { $sURL_add = '&sub=%s'; }
 914
 915     $out .= '<ul class="indexlist">'."\n";
 916     foreach ($stats as $stat) {
 917       $out .= '<li'.(isset($stat['class'])?' class="'.$stat['class'].'"':'').'>';
 918       $sURL = str_replace('%i', $stat['name'], $sURL_base);
 919       $sURL = str_replace('%a', '', $sURL);
 920       $sURL = str_replace('%s', '', $sURL);
 921       $out .= '<a href="'.$sURL.'">'.$stat['name'].'</a>';
 922       if (isset($stat['sub']) && count($stat['sub'])) {
 923         $sprt = array();
 924         foreach ($stat['sub'] as $ssub) {
 925           $sURL = str_replace('%i', $stat['name'], $sURL_base);
 926           $sURL = str_replace('%a', $sURL_add, $sURL);
 927           $sURL = str_replace('%s', $ssub, $sURL);
 928           $sprt[] = '<a href="'.$sURL.'">'.$ssub.'</a>';
 929         }
 930         $out .= ' <span="subs">('.implode(', ', $sprt).')</span>';
 931       }
 932       $out .= '</li>'."\n";
 933     }
 934     $out .= '</ul>'."\n";
 935
 936     $out .= $this->h_page_footer();
 937     $out .= '</body></html>'."\n";
 938   return $out;
 939   }
 940
 941   private function page_overview($pconf, $graph_extras = null) {
 942     // create an overview HTML page (including graphs) and return it in a string
 943     $td = $this->mod_textdomain;
 944     $ptitle = isset($pconf['title_page'])?$pconf['title_page']:dgettext($td, 'RRD statistics overview');
 945
 946     $out = '<html><head>'."\n";
 947     $out .= '<title>'.$ptitle.'</title>'."\n";
 948     $out .= '<style type="text/css">'."\n";
 949     if (isset($pconf['style_base'])) { $out .= $pconf['style_base']; }
 950     else {
 951       $out .= 'h1 { font-weight: bold; font-size: 1.5em; }'."\n";
 952       $out .= 'h2 { font-weight: bold; font-size: 1em; margin: 0.5em 0; }'."\n";
 953       $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }'."\n";
 954       $out .= 'img.rrdgraph { border: none; }'."\n";
 955     }
 956     if (isset($pconf['style'])) { $out .= $pconf['style']; }
 957     $out .= '</style>'."\n";
 958     $out .= '</head>'."\n";
 959     $out .= '<body>'."\n";
 960
 961     $out .= '<h1>'.$ptitle.'</h1>'."\n";
 962     if (isset($pconf['text_intro']) && strlen($pconf['text_intro'])) {
 963       $out .= '<p class="intro">'.$pconf['text_intro'].'</p>';
 964     }
 965
 966     $stats = $this->h_page_statsArray($pconf);
 967
 968     if (isset($pconf['stats_url'])) { $sURL_base = $pconf['stats_url']; }
 969     else { $sURL_base = '?stat=%i%a'; }
 970
 971     if (isset($pconf['stats_url_add'])) { $sURL_add = $pconf['stats_url_add']; }
 972     else { $sURL_add = '&sub=%s'; }
 973
 974     $default_num_cols = $GLOBALS['ua']->isMobile()?1:2;
 975     $num_cols = is_numeric($pconf['num_rows'])?$pconf['num_rows']:$default_num_cols;
 976     $num_rows = ceil(count($stats)/$num_cols);
 977
 978     $out .= '<table class="overview">'."\n";
 979     for ($row = 0; $row < $num_rows; $row++) {
 980       $out .= '<tr>'."\n";
 981       for ($col = 0; $col < $num_cols; $col++) {
 982         $idx = $row * $num_cols + $col;
 983         $out .= '<td>'."\n";
 984         if ($idx < count($stats)) {
 985           @list($sname, $s_psub) = explode('|', $stats[$idx]['name'], 2);
 986           $s_psname = 'page'.(isset($s_psub)?'.'.$s_psub:'');
 987           $g_sub = @$this->config_all[$sname][$s_psname]['graph_sub'];
 988
 989           if (isset($this->config_all[$sname][$s_psname]['title_page'])) {
 990             $s_ptitle = $this->config_all[$sname][$s_psname]['title_page'];
 991           }
 992           elseif (isset($this->config_all[$sname]['page']['title_page'])) {
 993             $s_ptitle = $this->config_all[$sname]['page']['title_page'];
 994           }
 995           else {
 996             $s_ptitle = isset($s_psub)
 997                         ?sprintf(dgettext($td, '%s (%s) statistics'), $sname, $s_psub)
 998                         :sprintf(dgettext($td, '%s statistics'), $sname);
 999           }
1000           if (!isset($pconf['hide_titles']) || !$pconf['hide_titles']) {
1001             $out .= '<h2>'.$s_ptitle.'</h2>'."\n";
1002           }
1003
1004           $s_rrd = new rrdstat($this->config_all, $sname);
1005           if (in_array($s_rrd->status, array('ok','readonly','graphonly'))) {
1006             $tframe = isset($pconf['graph_timeframe'])?$pconf['graph_timeframe']:'day';
1007             $gmeta = $s_rrd->graph_plus($tframe, $g_sub);
1008             if (isset($pconf['graph_url'])) {
1009               $gURL = $pconf['graph_url'];
1010               $gURL = str_replace('%f', basename($gmeta['filename']), $gURL);
1011               $gURL = str_replace('%p', $gmeta['filename'], $gURL);
1012               if (substr($gURL, -1) == '/') { $gURL .= $gmeta['filename']; }
1013             }
1014             else {
1015               $gURL = $gmeta['filename'];
1016             }
1017             $sURL = str_replace('%i', $sname, $sURL_base);
1018             $sURL = str_replace('%a', isset($s_psub)?$sURL_add:'', $sURL);
1019             $sURL = str_replace('%s', isset($s_psub)?$s_psub:'', $sURL);
1020             $out .= '<a href="'.$sURL.'">';
1021             $out .= '<img src="'.$gURL.'"';
1022             $out .= ' alt="'.$s_rrd->basename.(!is_null($g_sub)?' - '.$g_sub:'').' - '.$tframe.'" class="rrdgraph"';
1023             if (isset($gmeta['width']) && isset($gmeta['height'])) {
1024               $out .= ' style="width:'.$gmeta['width'].'px;height:'.$gmeta['height'].'px;"';
1025             }
1026             $out .= '></a>'."\n";
1027           }
1028           else {
1029             $out .= sprintf(dgettext($td, 'RRD error: status is "%s"'), $s_rrd->status)."\n";
1030           }
1031         }
1032         else {
1033           $out .= '&nbsp;';
1034         }
1035         $out .= '</td>'."\n";
1036       }
1037       $out .= '</tr>'."\n";
1038     }
1039     $out .= '</table>'."\n";
1040
1041     $out .= $this->h_page_footer();
1042     $out .= '</body></html>'."\n";
1043   return $out;
1044   }
1045
1046   private function page_simple($pconf, $graph_extras = null) {
1047     // create a simple (MRTG-like) HTML page and return it in a string
1048     $td = $this->mod_textdomain;
1049
1050     $ptitle = isset($pconf['title_page'])?$pconf['title_page']:sprintf(dgettext($td, '%s - RRD statistics'),$this->basename);
1051     $gtitle = array();
1052     $gtitle['day'] = isset($pconf['title_day'])?$pconf['title_day']:dgettext($td, 'Day overview (scaling 5 minutes)');
1053     $gtitle['week'] = isset($pconf['title_week'])?$pconf['title_week']:dgettext($td, 'Week overview (scaling 30 minutes)');
1054     $gtitle['month'] = isset($pconf['title_month'])?$pconf['title_month']:dgettext($td, 'Month overview (scaling 2 hours)');
1055     $gtitle['year'] = isset($pconf['title_year'])?$pconf['title_year']:dgettext($td, 'Year overview (scaling 1 day)');
1056     $ltitle = isset($pconf['title_legend'])?$pconf['title_legend']:dgettext($td, 'Legend:');
1057
1058     $out = '<html><head>'."\n";
1059     $out .= '<title>'.$ptitle.'</title>'."\n";
1060     $out .= '<style type="text/css">'."\n";
1061     if (isset($pconf['style_base'])) { $out .= $pconf['style_base']; }
1062     else {
1063       $out .= 'h1 { font-weight: bold; font-size: 1.5em; }'."\n";
1064       $out .= 'h2 { font-weight: bold; font-size: 1em; }'."\n";
1065       $out .= '.gdata, .gvar, .ginfo { font-size: 0.75em; margin: 0.5em 0; }'."\n";
1066       $out .= 'table.gdata, table.legend  { border: 1px solid gray; border-collapse: collapse; }'."\n";
1067       $out .= 'table.gdata td, table.gdata th, '."\n";
1068       $out .= 'table.legend td, table.legend th { border: 1px solid gray; padding: 0.1em 0.2em; }'."\n";
1069       $out .= 'div.legend { font-size: 0.75em; margin: 0.5em 0; }'."\n";
1070       $out .= 'div.legend p { margin: 0; }'."\n";
1071       $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }'."\n";
1072     }
1073     if (isset($pconf['style'])) { $out .= $pconf['style']; }
1074     $out .= '</style>'."\n";
1075     $out .= '</head>'."\n";
1076     $out .= '<body>'."\n";
1077
1078     $out .= '<h1>'.$ptitle.'</h1>'."\n";
1079     if (isset($pconf['text_intro']) && strlen($pconf['text_intro'])) {
1080       $out .= '<p class="intro">'.$pconf['text_intro'].'</p>'."\n";
1081     }
1082     if (!isset($pconf['show_update']) || $pconf['show_update']) {
1083       $out .= '<p class="last_up">';
1084       if (is_null($this->last_update())) { $up_time = dgettext($td, 'unknown'); }
1085       elseif (class_exists('baseutils')) { $up_time = baseutils::dateFormat($this->last_update(), 'short'); }
1086       else { $up_time = date('Y-m-d H:i:s', $this->last_update()); }
1087       $out .= sprintf(dgettext($td, 'Last Update: %s'), $up_time);
1088       $out .= '</p>'."\n";
1089     }
1090
1091     $g_sub = isset($pconf['graph_sub'])?$pconf['graph_sub']:null;
1092     if (in_array($this->status, array('ok','readonly','graphonly'))) {
1093       foreach (array('day','week','month','year') as $tframe) {
1094         $gmeta = $this->graph_plus($tframe, $g_sub, $graph_extras);
1095         if (isset($pconf['graph_url'])) {
1096           $gURL = $pconf['graph_url'];
1097           $gURL = str_replace('%f', basename($gmeta['filename']), $gURL);
1098           $gURL = str_replace('%p', $gmeta['filename'], $gURL);
1099           if (substr($gURL, -1) == '/') { $gURL .= $gmeta['filename']; }
1100         }
1101         else {
1102           $gURL = $gmeta['filename'];
1103         }
1104         $out .= '<div class="'.$tframe.'">'."\n";
1105         if (0) {
1106           // debug output
1107           ob_start();
1108           print_r($gmeta);
1109           $buffer = ob_get_contents();
1110           ob_end_clean();
1111           $out .= '<p>'.nl2br($buffer).'</p>';
1112         }
1113         $out .= '<h2>'.$gtitle[$tframe].'</h2>'."\n";
1114         $out .= '<img src="'.$gURL.'"';
1115         $out .= ' alt="'.$this->basename.(!is_null($g_sub)?' - '.$g_sub:'').' - '.$tframe.'" class="rrdgraph"';
1116         if (isset($gmeta['width']) && isset($gmeta['height'])) {
1117           $out .= ' style="width:'.$gmeta['width'].'px;height:'.$gmeta['height'].'px;"';
1118         }
1119         $out .= '>'."\n";
1120         $colorize_data = (isset($pconf['data_colorize']) && $pconf['data_colorize']) ||
1121                          (!isset($pconf['data_colorize']) && $gmeta['default_colorize']);
1122         if (isset($gmeta['data']) && count($gmeta['data'])) {
1123           $out .= '<table class="gdata">'."\n";
1124           foreach ($gmeta['data'] as $field=>$gdata) {
1125             $out .= '<tr><th';
1126             if ($colorize_data && isset($gmeta['legend'][$field])) {
1127               $out .= ' style="color:'.$gmeta['legend'][$field]['color'].';';
1128               if (strlen($gmeta['legend'][$field]['color_bg'])) {
1129                 $out .= 'background-color:'.$gmeta['legend'][$field]['color_bg'].';';
1130               }
1131               $out .= '"';
1132             }
1133             $out .= '>'.$field.'</th>';
1134             foreach ($gdata as $gkey=>$gval) {
1135               $out .= '<td><span class="gkey">'.$gkey.': </span>'.$gval.'</td>';
1136             }
1137             $out .= '</tr>'."\n";
1138           }
1139           $out .= '</table>'."\n";
1140         }
1141         if (isset($gmeta['var']) && count($gmeta['var'])) {
1142           foreach ($gmeta['var'] as $gkey=>$gval) {
1143             $out .= '<p class="gvar"><span class="gkey">'.$gkey.': </span>'.$gval.'</p>'."\n";
1144           }
1145         }
1146         if (isset($gmeta['info']) && count($gmeta['info'])) {
1147           foreach ($gmeta['info'] as $gval) {
1148             $out .= '<p class="ginfo">'.$gval.'</p>'."\n";
1149           }
1150         }
1151         $out .= '</div>'."\n";
1152       }
1153       if ($gmeta['legends_long'] && (!isset($pconf['show_legend']) || $pconf['show_legend'])) {
1154         $out .= '<div class="legend">'."\n";
1155         $out .= '<p>'.$ltitle.'</p>'."\n";
1156         $out .= '<table class="legend">'."\n";
1157         foreach ($gmeta['legend'] as $field=>$legend) {
1158           if (strlen($legend['desc_long'])) {
1159             $out .= '<tr><th';
1160             if ($colorize_data && isset($gmeta['legend'][$field])) {
1161               $out .= ' style="color:'.$gmeta['legend'][$field]['color'].';';
1162               if (strlen($gmeta['legend'][$field]['color_bg'])) {
1163                 $out .= 'background-color:'.$gmeta['legend'][$field]['color_bg'].';';
1164               }
1165               $out .= '"';
1166             }
1167             $out .= '>'.$field.'</th>';
1168             $out .= '<td>'.$legend['desc_long'].'</td>';
1169             $out .= '</tr>'."\n";
1170           }
1171         }
1172         $out .= '</table>'."\n";
1173         $out .= '</div>'."\n";
1174       }
1175     }
1176     else {
1177       $out .= sprintf(dgettext($td, 'RRD error: status is "%s"'), $this->status)."\n";
1178     }
1179
1180     $out .= $this->h_page_footer();
1181     $out .= '</body></html>'."\n";
1182   return $out;
1183   }
1184
1185   private function h_page_statsArray($pconf) {
1186     // return array of stats to list on a page
1187     $stats = array();
1188     $snames = array(); $s_exclude = array(); $sfiles = array();
1189     if (isset($pconf['index_ids'])) {
1190       foreach (explode(',', $pconf['index_ids']) as $iid) {
1191         if ($iid{0} == '-') { $s_exclude[] = substr($iid, 1); }
1192         else { $snames[] = $iid; }
1193       }
1194     }
1195     if (!isset($pconf['scan_config']) || $pconf['scan_config']) {
1196       foreach ($this->config_all as $iname=>$rinfo) {
1197         if (($iname != '*') && !(isset($rinfo['hidden']) && $rinfo['hidden']) &&
1198             !(in_array($iname, $snames)) && !(in_array($iname, $s_exclude))) {
1199           $snames[] = $iname;
1200         }
1201       }
1202     }
1203     foreach ($snames as $iname) {
1204       $newstat = array('name'=>$iname);
1205       $sfiles[] = isset($this->config_all[$iname]['file'])?$this->config_all[$iname]['file']:$iname.'.rrd';
1206       if (is_array($this->config_all[$iname])) {
1207         foreach ($this->config_all[$iname] as $key=>$val) {
1208           if (substr($key, 0, 5) == 'page.') { $newstat['sub'][] = substr($key, 5); }
1209         }
1210       }
1211       $stats[] = $newstat;
1212     }
1213     if (isset($pconf['scan_files']) && $pconf['scan_files']) {
1214       $rrdfiles = glob('*.rrd');
1215       foreach ($rrdfiles as $rrdfile) {
1216         $iname = (substr($rrdfile, -4) == '.rrd')?substr($rrdfile, 0, -4):$rrdfile;
1217         if (!in_array($rrdfile, $sfiles) && !(in_array($iname, $s_exclude))) {
1218           $stats[] = array('name'=>$iname, 'class'=>'scanfile');
1219         }
1220       }
1221     }
1222   return $stats;
1223   }
1224
1225   private function h_page_footer() {
1226     // return generic page footer
1227     $out = '<p class="footer">';
1228     $out .= sprintf(dgettext($this->mod_textdomain, 'Statistics created with %s using a library created by %s.'),
1229                     '<a href="http://oss.oetiker.ch/rrdtool/">RRDtool</a>',
1230                     '<a href="http://www.kairo.at/">KaiRo.at</a>');
1231     $out .= '</p>'."\n";
1232   return $out;
1233   }
1234
1235   private function text_quote($text) {
1236     $trans = array('"' => '\"', ':' => '\:');
1237     $qtext = '"'.strtr($text, $trans).'"';
1238   return $qtext;
1239   }
1240 }
1241 ?>