c0d752019505048f97c0ebe4e80e3118cac1bd18
[php-utility-classes.git] / 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
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 rrdstat($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   // var $rrd_file
33   // RRD file name
34   //
35   // var $basename
36   // base name for this RRD (usually file name without .rrd)
37   //
38   // var $config_all
39   // complete, raw configuration array set
40   //
41   // var $config_raw
42   // configuration array set for current RRD
43   //
44   // var $config_graph
45   // configuration array set for default graph in this RRD
46   //
47   // var $config_page
48   // configuration array set for default page in this RRD
49   //
50   // var $rrd_fields
51   // definition of this RRD's fields
52   //
53   // var $rra_base
54   // definition of this RRD's base RRAs
55   //
56   // var $rrd_step
57   // basic stepping of this RRD in seconds (default: 300)
58   //
59   // var $rra_add_max
60   // should RRAs for MAX be added for every base RRA? (bool, default: true)
61   //
62   // var $status
63   // status of the RRD (unused/ok/readonly/graphonly)
64   //   note that most functions require certain status values
65   //   (e.g. update only works if status is ok, graph for ok/readonly/graphonly)
66   //
67   // function set_def($rrdconfig, [$conf_id])
68   //   set definitions based on given configuration
69   //   [intended for internal use, called by the constructor]
70   //
71   // function create()
72   //   create RRD file according to set config
73   //
74   // function update([$upArray])
75   //   feed new data into RRD (either use given array of values or use auto-update info from config)
76   //
77   // function fetch([$cf] = 'AVERAGE', $resolution = null, $start = null, $end = null)
78   //   fetch data from the defined RRD
79   //     using given consolidation function [default is AVERAGE],
80   //     resolution (seconds, default is the RRD's stepping),
81   //     start and end times (unix epoch, defaults are the RRD's last update time)
82   //
83   // function last_update()
84   //   fetch time of last update in this RRD file
85   //
86   // function graph([$timeframe], [$sub], [$extra])
87   //   create a RRD graph (and return all meta info in a flat string)
88   //     for given timeframe (day [default]/week/month/year),
89   //     sub-graph ID (if given) and extra config options (if given)
90   //
91   // function graph_plus([$timeframe], [$sub], [$extra])
92   //   create a RRD graph (see above) and return meta info as a ready-to-use array
93   //
94   // function page([$sub], [$page_extras], [$graph_extras])
95   //   create a (HTML) page and return it in a string
96   //     for given sub-page ID (if given, default is a simple HTML page)
97   //     and extra page and graph config options (if given)
98   //
99   // function simple_html([$sub], [$page_extras], [$graph_extras])
100   //   create a simple (MRTG-like) HTML page and return it in a string
101   //   XXX: this is here temporarily for compat only, it's preferred to use page()!
102   //
103   // function page_index($pconf)
104   //   create a bare, very simple index list HTML page and return it in a string
105   //   using given page config options
106   //   [intended for internal use, called by page()]
107   //
108   // function page_overview($pconf, [$graph_extras])
109   //   create an overview HTML page (including graphs) and return it in a string
110   //   using given page config options and extra graph options (if given)
111   //   [intended for internal use, called by page()]
112   //
113   // function page_simple($pconf, [$graph_extras])
114   //   create a simple (MRTG-like) HTML page and return it in a string
115   //   using given page config options and extra graph options (if given)
116   //   [intended for internal use, called by page()]
117   //
118   // function h_page_statsArray($pconf)
119   //   return array of stats to list on a page, using given page config options
120   //   [intended for internal use, called by page_*()]
121   //
122   // function h_page_footer()
123   //   return generic page footer
124   //   [intended for internal use, called by page_*()]
125   //
126   // function text_quote($text)
127   //   return a quoted/escaped text for use in rrdtool commandline text fields
128
129   var $rrd_file = null;
130   var $basename = null;
131
132   var $config_all = null;
133   var $config_raw = null;
134   var $config_graph = null;
135   var $config_page = null;
136
137   var $rrd_fields = array();
138   var $rra_base = array();
139   var $rrd_step = 300;
140   var $rra_add_max = true;
141
142   var $status = 'unused';
143
144   function rrdstat($rrdconfig, $conf_id = null) {
145     // ***** init RRD stat module *****
146     $this->set_def($rrdconfig, $conf_id);
147
148     if (($this->status == 'unused') && !is_null($this->rrd_file)) {
149       if (!is_writeable($this->rrd_file)) {
150         if (!file_exists($this->rrd_file)) {
151           if (@touch($this->rrd_file)) { $this->create(); }
152           else { trigger_error('RRD file can not be created', E_USER_WARNING); }
153         }
154         else {
155           if (is_readable($this->rrd_file)) { $this->status = 'readonly'; }
156           else { trigger_error('RRD file is not readable', E_USER_WARNING); }
157         }
158       }
159       else {
160         $this->status = 'ok';
161       }
162     }
163   }
164
165   function set_def($rrdconfig, $conf_id = null) {
166     if (is_array($rrdconfig)) {
167       // we have an array in the format we like to have
168       $complete_conf =& $rrdconfig;
169     }
170     else {
171       // we have something else (XML data?), try to generate the iinfo aray from it
172       $complete_conf =& $rrdconfig;
173     }
174
175     if (!is_null($conf_id)) {
176       $iinfo = isset($complete_conf[$conf_id])?$complete_conf[$conf_id]:array();
177       if (isset($complete_conf['*'])) {
178         $iinfo = (array)$iinfo + (array)$complete_conf['*'];
179         if (isset($complete_conf['*']['graph'])) { $iinfo['graph'] = (array)$iinfo['graph'] + (array)$complete_conf['*']['graph']; }
180         if (isset($complete_conf['*']['page'])) { $iinfo['page'] = (array)$iinfo['page'] + (array)$complete_conf['*']['page']; }
181       }
182     }
183     else {
184       $iinfo = $complete_conf;
185     }
186
187     if (isset($iinfo['graph-only']) && $iinfo['graph-only'] && !is_null($conf_id)) {
188       $this->basename = $conf_id;
189       $this->status = 'graphonly';
190     }
191     elseif (isset($iinfo['file'])) {
192       $this->rrd_file = $iinfo['file'];
193       $this->basename = (substr($this->rrd_file, -4) == '.rrd')?substr($this->rrd_file, 0, -4):$this->rrd_file;
194     }
195     elseif (!is_null($conf_id) && file_exists($conf_id.'.rrd')) {
196       $this->rrd_file = $conf_id.'.rrd';
197       $this->basename = $conf_id;
198     }
199     else {
200       $this->basename = !is_null($conf_id)?$conf_id:'xxx.unknown';
201     }
202
203     if (!is_null($this->rrd_file)) {
204       // fields (data sources, DS)
205       //  name - DS name
206       //  type - one of COUNTER, GAUGE, DERIVE, ABSOLUTE
207       //  heartbeat - if no sample recieved for that time, store UNKNOWN
208       //  min - U (unconstrained) or minimum value
209       //  max - U (unconstrained) or maximum value
210       //  update - this string will be fed into eval() for updating this field
211       if (isset($iinfo['fields']) && is_array($iinfo['fields'])) {
212         $this->rrd_fields = $iinfo['fields'];
213       }
214       else {
215         $this->rrd_fields[] = array('name' => 'ds0', 'type' => 'COUNTER', 'heartbeat' => 600, 'min' => 'U', 'max' => 'U');
216         $this->rrd_fields[] = array('name' => 'ds1', 'type' => 'COUNTER', 'heartbeat' => 600, 'min' => 'U', 'max' => 'U');
217       }
218
219
220       // MRTG-style RRD "database", see http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/tut/rrdtutorial.en.html
221       //
222       // archives (RRAs):
223       // 600 samples of 5 minutes  (2 days and 2 hours)
224       // 700 samples of 30 minutes (2 days and 2 hours, plus 12.5 days)
225       // 775 samples of 2 hours    (above + 50 days)
226       // 797 samples of 1 day      (above + 732 days, rounded up to 797)
227
228       $this->rrd_step = isset($iinfo['rrd_step'])?$iinfo['rrd_step']:300;
229
230       if (isset($iinfo['rra_base']) && is_array($iinfo['rra_base'])) {
231         $this->rra_base = $iinfo['rra_base'];
232       }
233       else {
234         $this->rra_base[] = array('step' => 1, 'rows' => 600);
235         $this->rra_base[] = array('step' => 6, 'rows' => 700);
236         $this->rra_base[] = array('step' => 24, 'rows' => 775);
237         $this->rra_base[] = array('step' => 288, 'rows' => 797);
238       }
239
240       $this->rra_add_max = isset($iinfo['rra_add_max'])?$iinfo['rra_add_max']:true;
241     }
242
243     if (isset($iinfo['graph'])) { $this->config_graph = $iinfo['graph']; }
244     if (isset($iinfo['page'])) { $this->config_page = $iinfo['page']; }
245     $this->config_raw = $iinfo;
246     $this->config_all = $complete_conf;
247   }
248
249   function create() {
250     // create RRD file
251
252     // compose create command
253     $create_cmd = 'rrdtool create '.$this->rrd_file.' --step '.$this->rrd_step;
254     foreach ($this->rrd_fields as $ds) {
255       if (!isset($ds['type'])) { $ds['type'] = 'COUNTER'; }
256       if (!isset($ds['heartbeat'])) { $ds['heartbeat'] = 2*$this->rrd_step; }
257       if (!isset($ds['min'])) { $ds['min'] = 'U'; }
258       if (!isset($ds['max'])) { $ds['max'] = 'U'; }
259       $create_cmd .= ' DS:'.$ds['name'].':'.$ds['type'].':'.$ds['heartbeat'].':'.$ds['min'].':'.$ds['max'];
260     }
261     foreach ($this->rra_base as $rra) {
262       if (!isset($rra['cf'])) { $rra['cf'] = 'AVERAGE'; }
263       if (!isset($rra['xff'])) { $rra['xff'] = 0.5; }
264       if (!isset($rra['step'])) { $rra['step'] = 1; }
265       if (!isset($rra['rows'])) { $rra['rows'] = 600; }
266       $create_cmd .= ' RRA:'.$rra['cf'].':'.$rra['xff'].':'.$rra['step'].':'.$rra['rows'];
267     }
268     if ($this->rra_add_max) {
269       foreach ($this->rra_base as $rra) {
270         if (!isset($rra['cf'])) {
271           // only rows that have no CF set will be looked at here
272           $rra['cf'] = 'MAX';
273           if (!isset($rra['xff'])) { $rra['xff'] = 0.5; }
274           if (!isset($rra['step'])) { $rra['step'] = 1; }
275           if (!isset($rra['rows'])) { $rra['rows'] = 600; }
276           $create_cmd .= ' RRA:'.$rra['cf'].':'.$rra['xff'].':'.$rra['step'].':'.$rra['rows'];
277         }
278       }
279     }
280     $return = `$create_cmd 2>&1`;
281     if (strpos($return, 'ERROR') !== false) {
282       trigger_error($this->rrd_file.' - rrd create error: '.$return, E_USER_WARNING);
283     }
284     else { $this->status = 'ok'; }
285   }
286
287   function update($upArray = null) {
288     // feed new data into RRD
289     if ($this->status != 'ok') { trigger_error('Cannot update non-writeable file', E_USER_WARNING); return 1; }
290     $upvals = array();
291     if (isset($this->config_raw['update'])) {
292       $evalcode = $this->config_raw['update'];
293       if (!is_null($evalcode)) {
294         ob_start();
295         eval($evalcode);
296         $ret = ob_get_contents();
297         if (strlen($ret)) { $upvals = explode("\n", $ret); }
298         ob_end_clean();
299       }
300       $walkfunc = create_function('&$val,$key', '$val = is_numeric(trim($val))?trim($val):"U";');
301       array_walk($upvals, $walkfunc);
302     }
303     else {
304       foreach ($this->rrd_fields as $ds) {
305         if (is_array($upArray) && isset($upArray[$ds['name']])) { $val = $upArray[$ds['name']]; }
306         elseif (isset($ds['update'])) {
307           $val = null; $evalcode = null;
308           if (substr($ds['update'], 0, 4) == 'val:') {
309             $evalcode = 'print(trim('.substr($ds['update'], 4).'));';
310           }
311           elseif (substr($ds['update'], 0, 8) == 'snmp-if:') {
312             $snmphost = 'localhost'; $snmpcomm = 'public';
313             list($nix, $ifname, $valtype) = explode(':', $ds['update'], 3);
314             $iflist = explode("\n", `snmpwalk -v2c -c $snmpcomm $snmphost interfaces.ifTable.ifEntry.ifDescr`);
315             $ifnr = null;
316             foreach ($iflist as $ifdesc) {
317               if (preg_match('/ifDescr\.(\d+) = STRING: '.$ifname.'/', $ifdesc, $regs)) { $ifnr = $regs[1]; }
318             }
319             $oid = null;
320             if ($valtype == 'in') { $oid = '1.3.6.1.2.1.2.2.1.10.'.$ifnr; }
321             elseif ($valtype == 'out') { $oid = '1.3.6.1.2.1.2.2.1.16.'.$ifnr; }
322             if (!is_null($ifnr) && !is_null($oid)) {
323               $evalcode = 'print(trim(substr(strrchr(`snmpget -v2c -c '.$snmpcomm.' '.$snmphost.' '.$oid.'`,":"),1)));';
324             }
325           }
326           else { $evalcode = $ds['update']; }
327           if (!is_null($evalcode)) {
328             ob_start();
329             eval($evalcode);
330             $val = ob_get_contents();
331             ob_end_clean();
332           }
333         }
334         else { $val = null; }
335         $upvals[] = is_null($val)?'U':$val;
336       }
337     }
338     if (in_array('L', $upvals)) {
339       // for at least one value, we need to set the same as the last recorded value
340       $lastvals = $this->fetch();
341       foreach (array_keys($upvals, 'L') as $akey) {
342         $upvals[$akey] = $lastvals[$akey];
343       }
344     }
345     $return = null;
346     if (count($upvals)) {
347       $update_cmd = 'rrdtool update '.$this->rrd_file.' N:'.implode(':', $upvals);
348       $return = `$update_cmd 2>&1`;
349     }
350
351     if (strpos($return, 'ERROR') !== false) {
352       trigger_error($this->rrd_file.' - rrd update error: '.$return, E_USER_WARNING);
353       $success = false;
354     }
355     else { $success = true; }
356   return ($return_var == 0);
357   }
358
359   function fetch($cf = 'AVERAGE', $resolution = null, $start = null, $end = null) {
360     // fetch data from a RRD
361     if (!in_array($this->status, array('ok','readonly'))) { trigger_error('Error: rrd status is '.$this->status, E_USER_WARNING); return false; }
362
363     if (!in_array($cf, array('AVERAGE','MIN','MAX','LAST'))) { $cf = 'AVERAGE'; }
364     if (!is_numeric($resolution)) { $resolution = $this->rrd_step; }
365     if (!is_numeric($end)) { $end = $this->last_update(); }
366     elseif ($end < 0) { $end += $this->last_update(); }
367     $end = intval($end/$resolution)*$resolution;
368     if (!is_numeric($start)) { $start = $end; }
369     elseif ($start < 0) { $start += $end; }
370     $start = intval($start/$resolution)*$resolution;
371
372     $fetch_cmd = 'rrdtool fetch '.$this->rrd_file.' '.$cf.' --resolution '.$resolution.' --start '.$start.' --end '.$end;
373     $return = `$fetch_cmd 2>&1`;
374
375     if (strpos($return, 'ERROR') !== false) {
376       trigger_error($this->rrd_file.' - rrd fetch error: '.$return, E_USER_WARNING);
377       $fresult = false;
378     }
379     else {
380       $fresult = array();
381       $rows = explode("\n", $return);
382       $fields = preg_split('/\s+/', array_shift($rows));
383       if (array_shift($fields) == 'timestamp') {
384         $fresult[0] = $fields;
385         foreach ($rows as $row) {
386           if (strlen(trim($row))) {
387             $rvals = preg_split('/\s+/', $row);
388             $rtime = array_shift($rvals);
389             $rv_array = array();
390             foreach ($rvals as $key=>$rval) {
391               $rv_array[$fields[$key]] = ($rval=='nan')?null:floatval($rval);
392             }
393             $fresult[$rtime] = $rv_array;
394           }
395         }
396       }
397     }
398   return $fresult;
399   }
400
401   function last_update() {
402     // fetch time of last update in this RRD file
403     static $last_update;
404     if (!isset($last_update) && in_array($this->status, array('ok','readonly'))) {
405       $last_cmd = 'rrdtool last '.$this->rrd_file;
406       $return = trim(`$last_cmd 2>&1`);
407       $last_update = is_numeric($return)?$return:null;
408     }
409   return isset($last_update)?$last_update:null;
410   }
411
412   function graph($timeframe = 'day', $sub = null, $extra = null) {
413     // create a RRD graph
414     static $gColors;
415     if (!isset($gColors)) {
416       $gColors = array('#00CC00','#0000FF','#000000','#FF0000','#00FF00','#FFFF00','#FF00FF','#00FFFF','#808080','#800000','#008000','#000080','#808000','#800080','#008080','#C0C0C0');
417     }
418
419     if (!in_array($this->status, array('ok','readonly','graphonly'))) { trigger_error('Error: rrd status is '.$this->status, E_USER_WARNING); return false; }
420
421     // assemble configuration
422     $gconf = (array)$extra;
423     if (!is_null($sub) && is_array($this->config_raw['graph.'.$sub])) {
424       $gconf = $gconf + $this->config_raw['graph.'.$sub];
425     }
426     $gconf = $gconf + (array)$this->config_graph;
427
428     if (isset($gconf['format']) && ($gconf['format'] == 'SVG')) {
429       $format = $gconf['format']; $fmt_ext = '.svg';
430     }
431     elseif (isset($gconf['format']) && ($gconf['format'] == 'EPS')) {
432       $format = $gconf['format']; $fmt_ext = '.eps';
433     }
434     elseif (isset($gconf['format']) && ($gconf['format'] == 'PDF')) {
435       $format = $gconf['format']; $fmt_ext = '.pdf';
436     }
437     else {
438       $format = 'PNG'; $fmt_ext = '.png';
439     }
440
441     if (isset($gconf['filename'])) { $fname = $gconf['filename']; }
442     else { $fname = $this->basename.(is_null($sub)?'':'-%s').'-%t%f'; }
443     $fname = str_replace('%s', strval($sub), $fname);
444     $fname = str_replace('%t', $timeframe, $fname);
445     $fname = str_replace('%f', $fmt_ext, $fname);
446     if (substr($fname, -strlen($fmt_ext)) != $fmt_ext) { $fname .= $fmt_ext; }
447     if (isset($gconf['path'])) { $fname = $gconf['path'].'/'.$fname; }
448     $fname = str_replace('//', '/', $fname);
449
450     $graphrows = array(); $specialrows = array(); $gC = 0;
451     $gDefs = ''; $gGraphs = ''; $addSpecial = '';
452
453     if ($timeframe == 'day') {
454       $duration = isset($gconf['duration'])?$gconf['duration']:30*3600; // 30 hours
455       $slice = isset($gconf['slice'])?$gconf['slice']:300; // 5 minutes
456       // vertical lines at day borders
457       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d')).'#FF0000';
458       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d').' -1 day').'#FF0000';
459       if (!isset($gconf['grid_x'])) { $gconf['grid_x'] = 'HOUR:1:HOUR:6:HOUR:2:0:%-H'; }
460     }
461     elseif ($timeframe == 'week') {
462       $duration = isset($gconf['duration'])?$gconf['duration']:8*86400; // 8 days
463       $slice = isset($gconf['slice'])?$gconf['slice']:1800; // 30 minutes
464       // vertical lines at week borders
465       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d').' '.(-date('w')+1).' day').'#FF0000';
466       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d').' '.(-date('w')-6).' day').'#FF0000';
467     }
468     elseif ($timeframe == 'month') {
469       $duration = isset($gconf['duration'])?$gconf['duration']:36*86400; // 36 days
470       $slice = isset($gconf['slice'])?$gconf['slice']:7200; // 2 hours
471       // vertical lines at month borders
472       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-01')).'#FF0000';
473       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-01').' -1 month').'#FF0000';
474     }
475     elseif ($timeframe == 'year') {
476       $duration = isset($gconf['duration'])?$gconf['duration']:396*86400; // 365+31 days
477       $slice = isset($gconf['slice'])?$gconf['slice']:86400; // 1 day
478       // vertical lines at month borders
479       $addSpecial .= ' VRULE:'.strtotime(date('Y-01-01 12:00:00')).'#FF0000';
480       $addSpecial .= ' VRULE:'.strtotime(date('Y-01-01 12:00:00').' -1 year').'#FF0000';
481     }
482     else {
483       $duration = isset($gconf['duration'])?$gconf['duration']:$this->rrd_step*500; // 500 steps
484       $slice = isset($gconf['slice'])?$gconf['slice']:$this->rrd_step; // whatever our step is
485     }
486
487     if (isset($gconf['rows']) && count($gconf['rows'])) {
488       foreach ($gconf['rows'] as $erow) {
489         if (isset($erow['name']) && strlen($erow['name'])) {
490           if (!isset($erow['scale']) && isset($gconf['scale'])) { $erow['scale'] = $gconf['scale']; }
491           $grow = array();
492           $grow['dType'] = isset($erow['dType'])?$erow['dType']:'DEF';
493           $grow['name'] = $erow['name'].(isset($erow['scale'])?'_tmp':'');
494           if ($grow['dType'] == 'DEF') {
495             $grow['dsname'] = isset($erow['dsname'])?$erow['dsname']:$erow['name'];
496             if (isset($erow['dsfile'])) { $grow['dsfile'] = $erow['dsfile']; }
497             $grow['cf'] = isset($erow['cf'])?$erow['cf']:'AVERAGE';
498           }
499           else {
500             $grow['rpn_expr'] = isset($erow['rpn_expr'])?$erow['rpn_expr']:'0';
501           }
502           if (isset($erow['scale'])) {
503             $graphrows[] = $grow;
504             $grow = array();
505             $grow['dType'] = 'CDEF';
506             $grow['name'] = $erow['name'];
507             $grow['rpn_expr'] = $erow['name'].'_tmp,'.$erow['scale'].',*';
508           }
509           $grow['gType'] = isset($erow['gType'])?$erow['gType']:'LINE1';
510           $grow['color'] = isset($erow['color'])?$erow['color']:$gColors[$gC++];
511           if ($gC >= count($gColors)) { $gC = 0; }
512           if (isset($erow['legend'])) {
513             $grow['legend'] = $erow['legend'];
514             if (!isset($gconf['show_legend'])) { $gconf['show_legend'] = true; }
515           }
516           if (isset($erow['stack'])) { $grow['stack'] = ($erow['stack'] == true); }
517           if (isset($erow['desc'])) { $grow['desc'] = $erow['desc']; }
518           $graphrows[] = $grow;
519         }
520       }
521     }
522     else {
523       foreach ($this->rrd_fields as $key=>$ds) {
524         $grow = array();
525         $grow['dType'] = 'DEF';
526         $grow['name'] = $ds['name'].(isset($gconf['scale'])?'_tmp':'');
527         $grow['dsname'] = $ds['name'];
528         $grow['cf'] = 'AVERAGE';
529         if (isset($gconf['scale'])) {
530           $graphrows[] = $grow;
531           $grow = array();
532           $grow['dType'] = 'CDEF';
533           $grow['name'] = $ds['name'];
534           $grow['rpn_expr'] = $ds['name'].'_tmp,'.$gconf['scale'].',*';
535         }
536         $grow['gType'] = ((count($this->rrd_fields)==2) && ($key==0))?'AREA':'LINE1';
537         $grow['color'] = $gColors[$gC++]; if ($gC >= count($gColors)) { $gC = 0; }
538         if (isset($ds['legend'])) {
539           $grow['legend'] = $ds['legend'];
540           if (!isset($gconf['show_legend'])) { $gconf['show_legend'] = true; }
541         }
542         $graphrows[] = $grow;
543       }
544     }
545
546     if (isset($gconf['special']) && count($gconf['special'])) {
547       foreach ($gconf['special'] as $crow) {
548         $srow = array();
549         $srow['sType'] = isset($crow['sType'])?$crow['sType']:'COMMENT';
550         if ($grow['sType'] != 'COMMENT') {
551           // XXX: use line below and remove cf var once we have rrdtol 1.2
552           // $srow['name'] = $crow['name'].(isset($crow['cf'])?'_'.$crow['cf']:'');
553           $srow['name'] = $crow['name'];
554           $srow['cf'] = isset($crow['cf'])?$crow['cf']:'AVERAGE';
555           if (isset($crow['cf'])) {
556             // XXX: use line below once we have rrdtol 1.2
557             // $graphrows[] = array('dType'=>'VDEF', 'name'=>$srow['name'].'_'.$crow['cf'], 'rpn_expr'=>$srow['name'].','.$crow['cf']);
558           }
559           elseif (isset($crow['rpn_expr'])) {
560             // XXX: does only work with rrdtool 1.2
561             $graphrows[] = array('dType'=>'VDEF', 'name'=>$srow['name'], 'rpn_expr'=>$crow['rpn_expr']);
562           }
563         }
564         $srow['text'] = isset($crow['text'])?$crow['text']:'';
565         $specialrows[] = $srow;
566       }
567     }
568     else {
569       foreach ($graphrows as $grow) {
570         if (isset($grow['gType']) && strlen($grow['gType'])) {
571           $textprefix = isset($grow['desc'])?$grow['desc']:(isset($grow['legend'])?$grow['legend']:$grow['name']);
572           // XXX: use lines below once we have rrdtol 1.2
573           // $graphrows[] = array('dType'=>'VDEF', 'name'=>$grow['name'].'_last', 'rpn_expr'=>$grow['name'].',LAST');
574           // $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'].'_last', 'text'=>'%3.2lf%s');
575           $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'MAX', 'text'=>$textprefix.'|Maximum|%.2lf%s');
576           $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'AVERAGE', 'text'=>$textprefix.'|Average|%.2lf%s');
577           $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'LAST', 'text'=>$textprefix.'|Current|%.2lf%s');
578         }
579       }
580     }
581
582     $endtime = isset($gconf['time_end'])?$gconf['time_end']:(is_numeric($this->last_update())?$this->last_update():time());
583     $gOpts = ' --start '.($endtime-$duration).' --end '.$endtime.' --step '.$slice;
584     if (isset($gconf['label_top'])) { $gOpts .= ' --title '.$this->text_quote($gconf['label_top']); }
585     if (isset($gconf['label_y'])) { $gOpts .= ' --vertical-label '.$this->text_quote($gconf['label_y']); }
586     if (isset($gconf['width'])) { $gOpts .= ' --width '.$gconf['width']; }
587     if (isset($gconf['height'])) { $gOpts .= ' --height '.$gconf['height'];
588       if (($gconf['height'] <= 32) && isset($gconf['thumb']) && ($gconf['thumb'])) { $gOpts .= ' --only-graph'; }
589     }
590     if (!isset($gconf['show_legend']) || (!$gconf['show_legend'])) { $gOpts .= ' --no-legend'; }
591     if (isset($gconf['min_y'])) { $gOpts .= ' --lower-limit '.$gconf['min_y']; }
592     if (isset($gconf['max_y'])) { $gOpts .= ' --upper-limit '.$gconf['max_y']; }
593     if (isset($gconf['fix_scale_y']) && $gconf['fix_scale_y']) { $gOpts .= ' --rigid'; }
594     if (isset($gconf['grid_x'])) { $gOpts .= ' --x-grid '.$gconf['grid_x']; }
595     if (isset($gconf['grid_y'])) { $gOpts .= ' --y-grid '.$gconf['grid_y']; }
596     if (isset($gconf['units_exponent'])) { $gOpts .= ' --units-exponent '.$gconf['units_exponent']; }
597     if (isset($gconf['units_length'])) { $gOpts .= ' --units-length '.$gconf['units_length']; }
598     if (!isset($gconf['force_recreate']) || (!$gconf['force_recreate'])) { $gOpts .= ' --lazy'; }
599     if (isset($gconf['force_color']) && is_array($gconf['force_color'])) {
600       foreach ($gconf['force_color'] as $ctag=>$cval) { $gOpts .= ' --color '.$ctag.$cval; }
601     }
602     if (isset($gconf['force_font']) && is_array($gconf['force_font'])) {
603       foreach ($gconf['force_font'] as $ctag=>$cval) { $gOpts .= ' --font '.$ctag.$cval; }
604     }
605     if (isset($gconf['units_binary']) && $gconf['units_binary']) { $gOpts .= ' --base 1024'; }
606
607     foreach ($graphrows as $grow) {
608       if (isset($grow['dType']) && strlen($grow['dType'])) {
609         $gDefs .= ' '.$grow['dType'].':'.$grow['name'].'=';
610         if ($grow['dType'] == 'DEF') {
611           $gDefs .= isset($grow['dsfile'])?$grow['dsfile']:$this->rrd_file;
612           $gDefs .= ':'.$grow['dsname'].':'.$grow['cf'];
613         }
614         else { $gDefs .= $grow['rpn_expr']; }
615       }
616       if (isset($grow['gType']) && strlen($grow['gType'])) {
617         // XXX: change from STACK type to STACK flag once we have rrdtool 1.2
618         if (isset($grow['stack']) && $grow['stack']) { $grow['gType'] = 'STACK'; }
619         $gGraphs .= ' '.$grow['gType'].':'.$grow['name'].$grow['color'];
620         if (isset($grow['legend'])) { $gGraphs .= ':'.$this->text_quote($grow['legend']); }
621         // XXX: remove above STACK if-command and uncomment the one below once we have rrdtool 1.2
622         //if (isset($grow['stack']) && $grow['stack']) { $gGraphs .= ':STACK'; }
623       }
624     }
625
626     foreach ($specialrows as $srow) {
627       $addSpecial .= ' '.$srow['sType'];
628       // XXX: eliminate cf once we have rrdtool 1.2
629       // $addSpecial .= ($grow['sType']!='COMMENT')?':'.$grow['name']:'');
630       $addSpecial .= (($srow['sType']!='COMMENT')?':'.$srow['name'].':'.$srow['cf']:'');
631       $addSpecial .= ':'.$this->text_quote($srow['text']);
632     }
633
634     $graph_cmd = 'rrdtool graph '.str_replace('*', '\*', $fname.$gOpts.$gDefs.$gGraphs.$addSpecial);
635     $return = `$graph_cmd 2>&1`;
636
637     if (strpos($return, 'ERROR') !== false) {
638       trigger_error($this->rrd_file.' - rrd graph error: '.$return, E_USER_WARNING);
639       $return = $graph_cmd."\n\n".$return;
640     }
641     $return = 'file:'.$fname."\n".$return;
642   return $return;
643   }
644
645   function graph_plus($timeframe = 'day', $sub = null, $extra = null) {
646     // create a RRD graph and return meta info as a ready-to-use array
647     $gmeta = array('filename'=>null);
648     $ret = $this->graph($timeframe, $sub, $extra);
649     if (strpos($ret, "\n\n") !== false) { $gmeta['graph_cmd'] = substr($ret, 0, strpos($ret, "\n\n")); $ret = substr($ret, strpos($ret, "\n\n")+2); }
650     else { $gmeta['graph_cmd'] = null; }
651     $grout = explode("\n", $ret);
652     foreach ($grout as $gline) {
653       if (preg_match('/^file:(.+)$/', $gline, $regs)) {
654         $gmeta['filename'] = $regs[1];
655       }
656       elseif (preg_match('/^(\d+)x(\d+)$/', $gline, $regs)) {
657         $gmeta['width'] = $regs[1]; $gmeta['height'] = $regs[2];
658       }
659       elseif (preg_match('/^([^\|]+)\|([^|]+)\|([^\|]*)$/', $gline, $regs)) {
660         $gmeta['data'][$regs[1]][$regs[2]] = $regs[3];
661       }
662       elseif (preg_match('/^([^\|]+)\|([^\|]*)$/', $gline, $regs)) {
663         $gmeta['var'][$regs[1]] = $regs[2];
664       }
665       elseif (strlen(trim($gline))) {
666         $gmeta['info'][] = $gline;
667       }
668     }
669     if (is_null($gmeta['filename'])) {
670       $gmeta['filename'] = $this->basename.(!is_null($sub)?'-'.$sub:'').'-'.$timeframe.'.png';
671     }
672   return $gmeta;
673   }
674
675   function page($sub = null, $page_extras = null, $graph_extras = null) {
676     // create a (HTML) page and return it in a string
677
678     // assemble configuration
679     $pconf = (array)$page_extras;
680     if (!is_null($sub) && is_array($this->config_raw['page.'.$sub])) {
681       $pconf = $pconf + $this->config_raw['page.'.$sub];
682     }
683     $pconf = $pconf + (array)$this->config_page;
684
685     $return = null;
686     switch ($pconf['type']) {
687       case 'index':
688         $return = $this->page_index($pconf);
689         break;
690       case 'overview':
691         $return = $this->page_overview($pconf, $graph_extras);
692         break;
693       case 'simple':
694       default:
695         $return = $this->page_simple($pconf, $graph_extras);
696         break;
697     }
698   return $return;
699   }
700
701   function simple_html($sub = null, $page_extras = null, $graph_extras = null) {
702     // create a simple (MRTG-like) HTML page and return it in a string
703     // XXX: this is here temporarily for compat only, it's preferred to use page()!
704
705     // assemble configuration
706     $pconf = (array)$page_extras;
707     if (!is_null($sub) && is_array($this->config_raw['page.'.$sub])) {
708       $pconf = $pconf + $this->config_raw['page.'.$sub];
709     }
710     $pconf = $pconf + (array)$this->config_page;
711
712   return $this->page_simple($pconf, $graph_extras);
713   }
714
715   function page_index($pconf) {
716     // create a bare, very simple index list HTML page and return it in a string
717
718     $ptitle = isset($pconf['title_page'])?$pconf['title_page']:'RRD statistics index';
719
720     $out = '<html><head>';
721     $out .= '<title>'.$ptitle.'</title>';
722     $out .= '<style>';
723     if (isset($pconf['style_base'])) { $out .= $pconf['style_base']; }
724     else {
725       $out .= 'h1 { font-weight: bold; font-size: 1.5em; }';
726       $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }';
727       $out .= 'li.scanfile { font-style: italic; }';
728     }
729     if (isset($pconf['style'])) { $out .= $pconf['style']; }
730     $out .= '</style>';
731     $out .= '</head>';
732     $out .= '<body>';
733
734     $out .= '<h1>'.$ptitle.'</h1>';
735     if (isset($pconf['text_intro']) && strlen($pconf['text_intro'])) {
736       $out .= '<p class="intro">'.$pconf['text_intro'].'</p>';
737     }
738     elseif (!isset($pconf['text_intro'])) {
739       $out .= '<p class="intro">The following RRD stats are available:</p>';
740     }
741
742     $stats = $this->h_page_statsArray($pconf);
743
744     $out .= '<ul class="indexlist">';
745     foreach ($stats as $stat) {
746       $out .= '<li'.(isset($stat['class'])?' class="'.$stat['class'].'"':'').'>';
747       $surl = '?stat='.$stat['name'];
748       $out .= '<a href="'.$surl.'">'.$stat['name'].'</a>';
749       if (isset($stat['sub']) && count($stat['sub'])) {
750         $sprt = array();
751         foreach ($stat['sub'] as $ssub) { $sprt[] = '<a href="'.$surl.'&sub='.$ssub.'">'.$ssub.'</a>'; }
752         $out .= ' <span="subs">('.implode(', ', $sprt).')</span>';
753       }
754       $out .= '</li>';
755     }
756     $out .= '</ul>';
757
758     $out .= $this->h_page_footer();
759     $out .= '</body></html>';
760   return $out;
761   }
762
763   function page_overview($pconf, $graph_extras = null) {
764     // create an overview HTML page (including graphs) and return it in a string
765
766     $ptitle = isset($pconf['title_page'])?$pconf['title_page']:'RRD statistics overview';
767
768     $out = '<html><head>';
769     $out .= '<title>'.$ptitle.'</title>';
770     $out .= '<style>';
771     if (isset($pconf['style_base'])) { $out .= $pconf['style_base']; }
772     else {
773       $out .= 'h1 { font-weight: bold; font-size: 1.5em; }';
774       $out .= 'h2 { font-weight: bold; font-size: 1em; margin: 0.5em 0; }';
775       $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }';
776       $out .= 'img.rrdgraph { border: none; }';
777     }
778     if (isset($pconf['style'])) { $out .= $pconf['style']; }
779     $out .= '</style>';
780     $out .= '</head>';
781     $out .= '<body>';
782
783     $out .= '<h1>'.$ptitle.'</h1>';
784     if (isset($pconf['text_intro'])) { $out .= '<p class="intro">'.$pconf['text_intro'].'</p>'; }
785
786     $stats = $this->h_page_statsArray($pconf);
787
788     $num_rows = is_numeric($pconf['num_rows'])?$pconf['num_rows']:2;
789     $num_cols = ceil(count($stats)/$num_rows);
790
791     $out .= '<table class="overview">';
792     for ($col = 0; $col < $num_cols; $col++) {
793       $out .= '<tr>';
794       for ($row = 0; $row < $num_rows; $row++) {
795         $idx = $col * $num_rows + $row;
796         $out .= '<td>';
797         if ($idx < count($stats)) {
798           list($sname, $s_psub) = explode('|', $stats[$idx]['name'], 2);
799           $s_psname = 'page'.(isset($s_psub)?'.'.$s_psub:'');
800           $g_sub = $this->config_all[$sname][$s_psname]['graph_sub'];
801
802           if (isset($this->config_all[$sname][$s_psname]['title_page'])) {
803             $s_ptitle = $this->config_all[$sname][$s_psname]['title_page'];
804           }
805           elseif (isset($this->config_all[$sname]['page']['title_page'])) {
806             $s_ptitle = $this->config_all[$sname]['page']['title_page'];
807           }
808           else {
809             $s_ptitle = $sname.(isset($s_psub)?' ('.$s_psub.')':'').' statistics';
810           }
811           if (!isset($pconf['hide_titles']) || !$pconf['hide_titles']) {
812             $out .= '<h2>'.$s_ptitle.'</h2>';
813           }
814
815           $s_rrd = new rrdstat($this->config_all, $sname);
816           if (in_array($s_rrd->status, array('ok','readonly','graphonly'))) {
817             $tframe = isset($pconf['graph_timeframe'])?$pconf['graph_timeframe']:'day';
818             $gmeta = $s_rrd->graph_plus($tframe, $g_sub);
819             if (isset($pconf['graph_url'])) {
820               $gURL = $pconf['graph_url'];
821               $fname = str_replace('%f', basename($gmeta['filename']), $gURL);
822               $fname = str_replace('%p', $gmeta['filename'], $gURL);
823               if (substr($gURL, -1) == '/') { $gURL .= $gmeta['filename']; }
824             }
825             else {
826               $gURL = $gmeta['filename'];
827             }
828             $out .= '<a href="?stat='.$sname.(isset($s_psub)?'&sub='.$s_psub:'').'"';
829             $out .= '<img src="'.$gURL.'"';
830             $out .= ' alt="'.$s_rrd->basename.(!is_null($g_sub)?' - '.$g_sub:'').' - '.$tframe.'" class="rrdgraph"';
831             $out .= ' style="width:'.$gmeta['width'].'px;height:'.$gmeta['height'].'px;">';
832             $out .= '</a>';
833           }
834           else {
835             $out .= 'RRD error: status is "'.$s_rrd->status.'"';
836           }
837         }
838         else {
839           $out .= '&nbsp;';
840         }
841         $out .= '</td>';
842       }
843       $out .= '</tr>';
844     }
845     $out .= '</table>';
846
847     $out .= $this->h_page_footer();
848     $out .= '</body></html>';
849   return $out;
850   }
851
852   function page_simple($pconf, $graph_extras = null) {
853     // create a simple (MRTG-like) HTML page and return it in a string
854
855     $ptitle = isset($pconf['title_page'])?$pconf['title_page']:$this->basename.' - RRD statistics';
856     $gtitle = array();
857     $gtitle['day'] = isset($pconf['title_day'])?$pconf['title_day']:'Day overview (scaling 5 minutes)';
858     $gtitle['week'] = isset($pconf['title_week'])?$pconf['title_week']:'Week overview (scaling 30 minutes)';
859     $gtitle['month'] = isset($pconf['title_month'])?$pconf['title_month']:'Month overview (scaling 2 hours)';
860     $gtitle['year'] = isset($pconf['title_year'])?$pconf['title_year']:'Year overview (scaling 1 day)';
861
862     $out = '<html><head>';
863     $out .= '<title>'.$ptitle.'</title>';
864     $out .= '<style>';
865     if (isset($pconf['style_base'])) { $out .= $pconf['style_base']; }
866     else {
867       $out .= 'h1 { font-weight: bold; font-size: 1.5em; }';
868       $out .= 'h2 { font-weight: bold; font-size: 1em; }';
869       $out .= '.gdata, .gvar, .ginfo { font-size: 0.75em; margin: 0.5em 0; }';
870       $out .= 'table.gdata { border: 1px solid gray; border-collapse: collapse; }';
871       $out .= 'table.gdata td, table.gdata th { border: 1px solid gray; padding: 0.1em 0.2em; }';
872       $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }';
873     }
874     if (isset($pconf['style'])) { $out .= $pconf['style']; }
875     $out .= '</style>';
876     $out .= '</head>';
877     $out .= '<body>';
878
879     $out .= '<h1>'.$ptitle.'</h1>';
880     if (!isset($pconf['show_update']) || $pconf['show_update']) {
881       $out .= '<p class="last_up">Last Update: '.(is_null($this->last_update())?'unknown':date('Y-m-d H:i:s', $this->last_update())).'</p>';
882     }
883
884     $g_sub = isset($pconf['graph_sub'])?$pconf['graph_sub']:null;
885     if (in_array($this->status, array('ok','readonly','graphonly'))) {
886       foreach (array('day','week','month','year') as $tframe) {
887         $gmeta = $this->graph_plus($tframe, $g_sub, $graph_extras);
888         if (isset($pconf['graph_url'])) {
889           $gURL = $pconf['graph_url'];
890           $fname = str_replace('%f', basename($gmeta['filename']), $gURL);
891           $fname = str_replace('%p', $gmeta['filename'], $gURL);
892           if (substr($gURL, -1) == '/') { $gURL .= $gmeta['filename']; }
893         }
894         else {
895           $gURL = $gmeta['filename'];
896         }
897         $out .= '<div class="'.$tframe.'">';
898 //         $out .= '<p>'.nl2br($ret).'</p>';
899         $out .= '<h2>'.$gtitle[$tframe].'</h2>';
900         $out .= '<img src="'.$gURL.'"';
901         $out .= ' alt="'.$this->basename.(!is_null($g_sub)?' - '.$g_sub:'').' - '.$tframe.'" class="rrdgraph"';
902         $out .= ' style="width:'.$gmeta['width'].'px;height:'.$gmeta['height'].'px;">';
903         if (isset($gmeta['data']) && count($gmeta['data'])) {
904           $out .= '<table class="gdata">';
905           foreach ($gmeta['data'] as $field=>$gdata) {
906             $out .= '<tr><th>'.$field.'</th>';
907             foreach ($gdata as $gkey=>$gval) {
908               $out .= '<td><span class="gkey">'.$gkey.': </span>'.$gval.'</td>';
909             }
910             $out .= '</tr>';
911           }
912           $out .= '</table>';
913         }
914         if (isset($gmeta['var']) && count($gmeta['var'])) {
915           foreach ($gmeta['var'] as $gkey=>$gval) {
916             $out .= '<p class="gvar"><span class="gkey">'.$gkey.': </span>'.$gval.'</p>';
917           }
918         }
919         if (isset($gmeta['info']) && count($gmeta['info'])) {
920           foreach ($gmeta['info'] as $gval) {
921             $out .= '<p class="ginfo">'.$gval.'</p>';
922           }
923         }
924         $out .= '</div>';
925       }
926     }
927     else {
928       $out .= 'RRD error: status is "'.$this->status.'"';
929     }
930
931     $out .= $this->h_page_footer();
932     $out .= '</body></html>';
933   return $out;
934   }
935
936   function h_page_statsArray($pconf) {
937     // return array of stats to list on a page
938     $stats = array();
939     $snames = array(); $s_exclude = array(); $sfiles = array();
940     if (isset($pconf['index_ids'])) {
941       foreach (explode(',', $pconf['index_ids']) as $iid) {
942         if ($iid{0} == '-') { $s_exclude[] = substr($iid, 1); }
943         else { $snames[] = $iid; }
944       }
945     }
946     if (!isset($pconf['scan_config']) || $pconf['scan_config']) {
947       foreach ($this->config_all as $iname=>$rinfo) {
948         if (($iname != '*') && !(isset($rinfo['hidden']) && $rinfo['hidden']) &&
949             !(in_array($iname, $snames)) && !(in_array($iname, $s_exclude))) {
950           $snames[] = $iname;
951         }
952       }
953     }
954     foreach ($snames as $iname) {
955       $newstat = array('name'=>$iname);
956       $sfiles[] = isset($this->config_all[$iname]['file'])?$this->config_all[$iname]['file']:$iname.'.rrd';
957       if (is_array($this->config_all[$iname])) {
958         foreach ($this->config_all[$iname] as $key=>$val) {
959           if (substr($key, 0, 5) == 'page.') { $newstat['sub'][] = substr($key, 5); }
960         }
961       }
962       $stats[] = $newstat;
963     }
964     if (isset($pconf['scan_files']) && $pconf['scan_files']) {
965       $rrdfiles = glob('*.rrd');
966       foreach ($rrdfiles as $rrdfile) {
967         $iname = (substr($rrdfile, -4) == '.rrd')?substr($rrdfile, 0, -4):$rrdfile;
968         if (!in_array($rrdfile, $sfiles) && !(in_array($iname, $s_exclude))) {
969           $stats[] = array('name'=>$iname, 'class'=>'scanfile');
970         }
971       }
972     }
973   return $stats;
974   }
975
976   function h_page_footer() {
977     // return generic page footer
978     $out = '<p class="footer">';
979     $out .= 'Statistics created by <a href="http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/">RRDtool</a>';
980     $out .= ' using a library created by <a href="http://www.kairo.at/">KaiRo.at</a>.';
981     $out .= '</p>';
982   return $out;
983   }
984
985   function text_quote($text) { return '"'.str_replace('"', '\"', str_replace(':', '\:', $text)).'"'; }
986 }
987 ?>