add the usual doc block at the beginning of the file
[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     $return = null;
339     if (count($upvals)) {
340       $update_cmd = 'rrdtool update '.$this->rrd_file.' N:'.implode(':', $upvals);
341       $return = `$update_cmd 2>&1`;
342     }
343
344     if (strpos($return, 'ERROR') !== false) {
345       trigger_error($this->rrd_file.' - rrd update error: '.$return, E_USER_WARNING);
346       $success = false;
347     }
348     else { $success = true; }
349   return ($return_var == 0);
350   }
351
352   function fetch($cf = 'AVERAGE', $resolution = null, $start = null, $end = null) {
353     // fetch data from a RRD
354     if (!in_array($this->status, array('ok','readonly'))) { trigger_error('Error: rrd status is '.$this->status, E_USER_WARNING); return false; }
355
356     if (!in_array($cf, array('AVERAGE','MIN','MAX','LAST'))) { $cf = 'AVERAGE'; }
357     if (!is_numeric($resolution)) { $resolution = $this->rrd_step; }
358     if (!is_numeric($end)) { $end = $this->last_update(); }
359     elseif ($end < 0) { $end += $this->last_update(); }
360     $end = intval($end/$resolution)*$resolution;
361     if (!is_numeric($start)) { $start = $end; }
362     elseif ($start < 0) { $start += $end; }
363     $start = intval($start/$resolution)*$resolution;
364
365     $fetch_cmd = 'rrdtool fetch '.$this->rrd_file.' '.$cf.' --resolution '.$resolution.' --start '.$start.' --end '.$end;
366     $return = `$fetch_cmd 2>&1`;
367
368     if (strpos($return, 'ERROR') !== false) {
369       trigger_error($this->rrd_file.' - rrd fetch error: '.$return, E_USER_WARNING);
370       $fresult = false;
371     }
372     else {
373       $fresult = array();
374       $rows = explode("\n", $return);
375       $fields = preg_split('/\s+/', array_shift($rows));
376       if (array_shift($fields) == 'timestamp') {
377         $fresult[0] = $fields;
378         foreach ($rows as $row) {
379           if (strlen(trim($row))) {
380             $rvals = preg_split('/\s+/', $row);
381             $rtime = array_shift($rvals);
382             $rv_array = array();
383             foreach ($rvals as $key=>$rval) {
384               $rv_array[$fields[$key]] = ($rval=='nan')?null:floatval($rval);
385             }
386             $fresult[$rtime] = $rv_array;
387           }
388         }
389       }
390     }
391   return $fresult;
392   }
393
394   function last_update() {
395     // fetch time of last update in this RRD file
396     static $last_update;
397     if (!isset($last_update) && in_array($this->status, array('ok','readonly'))) {
398       $last_cmd = 'rrdtool last '.$this->rrd_file;
399       $return = trim(`$last_cmd 2>&1`);
400       $last_update = is_numeric($return)?$return:null;
401     }
402   return isset($last_update)?$last_update:null;
403   }
404
405   function graph($timeframe = 'day', $sub = null, $extra = null) {
406     // create a RRD graph
407     static $gColors;
408     if (!isset($gColors)) {
409       $gColors = array('#00CC00','#0000FF','#000000','#FF0000','#00FF00','#FFFF00','#FF00FF','#00FFFF','#808080','#800000','#008000','#000080','#808000','#800080','#008080','#C0C0C0');
410     }
411
412     if (!in_array($this->status, array('ok','readonly','graphonly'))) { trigger_error('Error: rrd status is '.$this->status, E_USER_WARNING); return false; }
413
414     // assemble configuration
415     $gconf = (array)$extra;
416     if (!is_null($sub) && is_array($this->config_raw['graph.'.$sub])) {
417       $gconf = $gconf + $this->config_raw['graph.'.$sub];
418     }
419     $gconf = $gconf + (array)$this->config_graph;
420
421     if (isset($gconf['format']) && ($gconf['format'] == 'SVG')) {
422       $format = $gconf['format']; $fmt_ext = '.svg';
423     }
424     elseif (isset($gconf['format']) && ($gconf['format'] == 'EPS')) {
425       $format = $gconf['format']; $fmt_ext = '.eps';
426     }
427     elseif (isset($gconf['format']) && ($gconf['format'] == 'PDF')) {
428       $format = $gconf['format']; $fmt_ext = '.pdf';
429     }
430     else {
431       $format = 'PNG'; $fmt_ext = '.png';
432     }
433
434     if (isset($gconf['filename'])) { $fname = $gconf['filename']; }
435     else { $fname = $this->basename.(is_null($sub)?'':'-%s').'-%t%f'; }
436     $fname = str_replace('%s', strval($sub), $fname);
437     $fname = str_replace('%t', $timeframe, $fname);
438     $fname = str_replace('%f', $fmt_ext, $fname);
439     if (substr($fname, -strlen($fmt_ext)) != $fmt_ext) { $fname .= $fmt_ext; }
440     if (isset($gconf['path'])) { $fname = $gconf['path'].'/'.$fname; }
441     $fname = str_replace('//', '/', $fname);
442
443     $graphrows = array(); $specialrows = array(); $gC = 0;
444     $gDefs = ''; $gGraphs = ''; $addSpecial = '';
445
446     if ($timeframe == 'day') {
447       $duration = isset($gconf['duration'])?$gconf['duration']:30*3600; // 30 hours
448       $slice = isset($gconf['slice'])?$gconf['slice']:300; // 5 minutes
449       // vertical lines at day borders
450       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d')).'#FF0000';
451       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d').' -1 day').'#FF0000';
452       if (!isset($gconf['grid_x'])) { $gconf['grid_x'] = 'HOUR:1:HOUR:6:HOUR:2:0:%-H'; }
453     }
454     elseif ($timeframe == 'week') {
455       $duration = isset($gconf['duration'])?$gconf['duration']:8*86400; // 8 days
456       $slice = isset($gconf['slice'])?$gconf['slice']:1800; // 30 minutes
457       // vertical lines at week borders
458       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d').' '.(-date('w')+1).' day').'#FF0000';
459       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d').' '.(-date('w')-6).' day').'#FF0000';
460     }
461     elseif ($timeframe == 'month') {
462       $duration = isset($gconf['duration'])?$gconf['duration']:36*86400; // 36 days
463       $slice = isset($gconf['slice'])?$gconf['slice']:7200; // 2 hours
464       // vertical lines at month borders
465       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-01')).'#FF0000';
466       $addSpecial .= ' VRULE:'.strtotime(date('Y-m-01').' -1 month').'#FF0000';
467     }
468     elseif ($timeframe == 'year') {
469       $duration = isset($gconf['duration'])?$gconf['duration']:396*86400; // 365+31 days
470       $slice = isset($gconf['slice'])?$gconf['slice']:86400; // 1 day
471       // vertical lines at month borders
472       $addSpecial .= ' VRULE:'.strtotime(date('Y-01-01 12:00:00')).'#FF0000';
473       $addSpecial .= ' VRULE:'.strtotime(date('Y-01-01 12:00:00').' -1 year').'#FF0000';
474     }
475     else {
476       $duration = isset($gconf['duration'])?$gconf['duration']:$this->rrd_step*500; // 500 steps
477       $slice = isset($gconf['slice'])?$gconf['slice']:$this->rrd_step; // whatever our step is
478     }
479
480     if (isset($gconf['rows']) && count($gconf['rows'])) {
481       foreach ($gconf['rows'] as $erow) {
482         if (isset($erow['name']) && strlen($erow['name'])) {
483           if (!isset($erow['scale']) && isset($gconf['scale'])) { $erow['scale'] = $gconf['scale']; }
484           $grow = array();
485           $grow['dType'] = isset($erow['dType'])?$erow['dType']:'DEF';
486           $grow['name'] = $erow['name'].(isset($erow['scale'])?'_tmp':'');
487           if ($grow['dType'] == 'DEF') {
488             $grow['dsname'] = isset($erow['dsname'])?$erow['dsname']:$erow['name'];
489             if (isset($erow['dsfile'])) { $grow['dsfile'] = $erow['dsfile']; }
490             $grow['cf'] = isset($erow['cf'])?$erow['cf']:'AVERAGE';
491           }
492           else {
493             $grow['rpn_expr'] = isset($erow['rpn_expr'])?$erow['rpn_expr']:'0';
494           }
495           if (isset($erow['scale'])) {
496             $graphrows[] = $grow;
497             $grow = array();
498             $grow['dType'] = 'CDEF';
499             $grow['name'] = $erow['name'];
500             $grow['rpn_expr'] = $erow['name'].'_tmp,'.$erow['scale'].',*';
501           }
502           $grow['gType'] = isset($erow['gType'])?$erow['gType']:'LINE1';
503           $grow['color'] = isset($erow['color'])?$erow['color']:$gColors[$gC++];
504           if ($gC >= count($gColors)) { $gC = 0; }
505           if (isset($erow['legend'])) {
506             $grow['legend'] = $erow['legend'];
507             if (!isset($gconf['show_legend'])) { $gconf['show_legend'] = true; }
508           }
509           if (isset($erow['stack'])) { $grow['stack'] = ($erow['stack'] == true); }
510           if (isset($erow['desc'])) { $grow['desc'] = $erow['desc']; }
511           $graphrows[] = $grow;
512         }
513       }
514     }
515     else {
516       foreach ($this->rrd_fields as $key=>$ds) {
517         $grow = array();
518         $grow['dType'] = 'DEF';
519         $grow['name'] = $ds['name'].(isset($gconf['scale'])?'_tmp':'');
520         $grow['dsname'] = $ds['name'];
521         $grow['cf'] = 'AVERAGE';
522         if (isset($gconf['scale'])) {
523           $graphrows[] = $grow;
524           $grow = array();
525           $grow['dType'] = 'CDEF';
526           $grow['name'] = $ds['name'];
527           $grow['rpn_expr'] = $ds['name'].'_tmp,'.$gconf['scale'].',*';
528         }
529         $grow['gType'] = ((count($this->rrd_fields)==2) && ($key==0))?'AREA':'LINE1';
530         $grow['color'] = $gColors[$gC++]; if ($gC >= count($gColors)) { $gC = 0; }
531         if (isset($ds['legend'])) {
532           $grow['legend'] = $ds['legend'];
533           if (!isset($gconf['show_legend'])) { $gconf['show_legend'] = true; }
534         }
535         $graphrows[] = $grow;
536       }
537     }
538
539     if (isset($gconf['special']) && count($gconf['special'])) {
540       foreach ($gconf['special'] as $crow) {
541         $srow = array();
542         $srow['sType'] = isset($crow['sType'])?$crow['sType']:'COMMENT';
543         if ($grow['sType'] != 'COMMENT') {
544           // XXX: use line below and remove cf var once we have rrdtol 1.2
545           // $srow['name'] = $crow['name'].(isset($crow['cf'])?'_'.$crow['cf']:'');
546           $srow['name'] = $crow['name'];
547           $srow['cf'] = isset($crow['cf'])?$crow['cf']:'AVERAGE';
548           if (isset($crow['cf'])) {
549             // XXX: use line below once we have rrdtol 1.2
550             // $graphrows[] = array('dType'=>'VDEF', 'name'=>$srow['name'].'_'.$crow['cf'], 'rpn_expr'=>$srow['name'].','.$crow['cf']);
551           }
552           elseif (isset($crow['rpn_expr'])) {
553             // XXX: does only work with rrdtool 1.2
554             $graphrows[] = array('dType'=>'VDEF', 'name'=>$srow['name'], 'rpn_expr'=>$crow['rpn_expr']);
555           }
556         }
557         $srow['text'] = isset($crow['text'])?$crow['text']:'';
558         $specialrows[] = $srow;
559       }
560     }
561     else {
562       foreach ($graphrows as $grow) {
563         if (isset($grow['gType']) && strlen($grow['gType'])) {
564           $textprefix = isset($grow['desc'])?$grow['desc']:(isset($grow['legend'])?$grow['legend']:$grow['name']);
565           // XXX: use lines below once we have rrdtol 1.2
566           // $graphrows[] = array('dType'=>'VDEF', 'name'=>$grow['name'].'_last', 'rpn_expr'=>$grow['name'].',LAST');
567           // $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'].'_last', 'text'=>'%3.2lf%s');
568           $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'MAX', 'text'=>$textprefix.'|Maximum|%.2lf%s');
569           $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'AVERAGE', 'text'=>$textprefix.'|Average|%.2lf%s');
570           $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'LAST', 'text'=>$textprefix.'|Current|%.2lf%s');
571         }
572       }
573     }
574
575     $endtime = isset($gconf['time_end'])?$gconf['time_end']:(is_numeric($this->last_update())?$this->last_update():time());
576     $gOpts = ' --start '.($endtime-$duration).' --end '.$endtime.' --step '.$slice;
577     if (isset($gconf['label_top'])) { $gOpts .= ' --title '.$this->text_quote($gconf['label_top']); }
578     if (isset($gconf['label_y'])) { $gOpts .= ' --vertical-label '.$this->text_quote($gconf['label_y']); }
579     if (isset($gconf['width'])) { $gOpts .= ' --width '.$gconf['width']; }
580     if (isset($gconf['height'])) { $gOpts .= ' --height '.$gconf['height'];
581       if (($gconf['height'] <= 32) && isset($gconf['thumb']) && ($gconf['thumb'])) { $gOpts .= ' --only-graph'; }
582     }
583     if (!isset($gconf['show_legend']) || (!$gconf['show_legend'])) { $gOpts .= ' --no-legend'; }
584     if (isset($gconf['min_y'])) { $gOpts .= ' --lower-limit '.$gconf['min_y']; }
585     if (isset($gconf['max_y'])) { $gOpts .= ' --upper-limit '.$gconf['max_y']; }
586     if (isset($gconf['fix_scale_y']) && $gconf['fix_scale_y']) { $gOpts .= ' --rigid'; }
587     if (isset($gconf['grid_x'])) { $gOpts .= ' --x-grid '.$gconf['grid_x']; }
588     if (isset($gconf['grid_y'])) { $gOpts .= ' --y-grid '.$gconf['grid_y']; }
589     if (isset($gconf['units_exponent'])) { $gOpts .= ' --units-exponent '.$gconf['units_exponent']; }
590     if (isset($gconf['units_length'])) { $gOpts .= ' --units-length '.$gconf['units_length']; }
591     if (!isset($gconf['force_recreate']) || (!$gconf['force_recreate'])) { $gOpts .= ' --lazy'; }
592     if (isset($gconf['force_color']) && is_array($gconf['force_color'])) {
593       foreach ($gconf['force_color'] as $ctag=>$cval) { $gOpts .= ' --color '.$ctag.$cval; }
594     }
595     if (isset($gconf['force_font']) && is_array($gconf['force_font'])) {
596       foreach ($gconf['force_font'] as $ctag=>$cval) { $gOpts .= ' --font '.$ctag.$cval; }
597     }
598     if (isset($gconf['units_binary']) && $gconf['units_binary']) { $gOpts .= ' --base 1024'; }
599
600     foreach ($graphrows as $grow) {
601       if (isset($grow['dType']) && strlen($grow['dType'])) {
602         $gDefs .= ' '.$grow['dType'].':'.$grow['name'].'=';
603         if ($grow['dType'] == 'DEF') {
604           $gDefs .= isset($grow['dsfile'])?$grow['dsfile']:$this->rrd_file;
605           $gDefs .= ':'.$grow['dsname'].':'.$grow['cf'];
606         }
607         else { $gDefs .= $grow['rpn_expr']; }
608       }
609       if (isset($grow['gType']) && strlen($grow['gType'])) {
610         // XXX: change from STACK type to STACK flag once we have rrdtool 1.2
611         if (isset($grow['stack']) && $grow['stack']) { $grow['gType'] = 'STACK'; }
612         $gGraphs .= ' '.$grow['gType'].':'.$grow['name'].$grow['color'];
613         if (isset($grow['legend'])) { $gGraphs .= ':'.$this->text_quote($grow['legend']); }
614         // XXX: remove above STACK if-command and uncomment the one below once we have rrdtool 1.2
615         //if (isset($grow['stack']) && $grow['stack']) { $gGraphs .= ':STACK'; }
616       }
617     }
618
619     foreach ($specialrows as $srow) {
620       $addSpecial .= ' '.$srow['sType'];
621       // XXX: eliminate cf once we have rrdtool 1.2
622       // $addSpecial .= ($grow['sType']!='COMMENT')?':'.$grow['name']:'');
623       $addSpecial .= (($srow['sType']!='COMMENT')?':'.$srow['name'].':'.$srow['cf']:'');
624       $addSpecial .= ':'.$this->text_quote($srow['text']);
625     }
626
627     $graph_cmd = 'rrdtool graph '.str_replace('*', '\*', $fname.$gOpts.$gDefs.$gGraphs.$addSpecial);
628     $return = `$graph_cmd 2>&1`;
629
630     if (strpos($return, 'ERROR') !== false) {
631       trigger_error($this->rrd_file.' - rrd graph error: '.$return, E_USER_WARNING);
632       $return = $graph_cmd."\n\n".$return;
633     }
634     $return = 'file:'.$fname."\n".$return;
635   return $return;
636   }
637
638   function graph_plus($timeframe = 'day', $sub = null, $extra = null) {
639     // create a RRD graph and return meta info as a ready-to-use array
640     $gmeta = array('filename'=>null);
641     $ret = $this->graph($timeframe, $sub, $extra);
642     if (strpos($ret, "\n\n") !== false) { $gmeta['graph_cmd'] = substr($ret, 0, strpos($ret, "\n\n")); $ret = substr($ret, strpos($ret, "\n\n")+2); }
643     else { $gmeta['graph_cmd'] = null; }
644     $grout = explode("\n", $ret);
645     foreach ($grout as $gline) {
646       if (preg_match('/^file:(.+)$/', $gline, $regs)) {
647         $gmeta['filename'] = $regs[1];
648       }
649       elseif (preg_match('/^(\d+)x(\d+)$/', $gline, $regs)) {
650         $gmeta['width'] = $regs[1]; $gmeta['height'] = $regs[2];
651       }
652       elseif (preg_match('/^([^\|]+)\|([^|]+)\|([^\|]*)$/', $gline, $regs)) {
653         $gmeta['data'][$regs[1]][$regs[2]] = $regs[3];
654       }
655       elseif (preg_match('/^([^\|]+)\|([^\|]*)$/', $gline, $regs)) {
656         $gmeta['var'][$regs[1]] = $regs[2];
657       }
658       elseif (strlen(trim($gline))) {
659         $gmeta['info'][] = $gline;
660       }
661     }
662     if (is_null($gmeta['filename'])) {
663       $gmeta['filename'] = $this->basename.(!is_null($sub)?'-'.$sub:'').'-'.$timeframe.'.png';
664     }
665   return $gmeta;
666   }
667
668   function page($sub = null, $page_extras = null, $graph_extras = null) {
669     // create a (HTML) page and return it in a string
670
671     // assemble configuration
672     $pconf = (array)$page_extras;
673     if (!is_null($sub) && is_array($this->config_raw['page.'.$sub])) {
674       $pconf = $pconf + $this->config_raw['page.'.$sub];
675     }
676     $pconf = $pconf + (array)$this->config_page;
677
678     $return = null;
679     switch ($pconf['type']) {
680       case 'index':
681         $return = $this->page_index($pconf);
682         break;
683       case 'overview':
684         $return = $this->page_overview($pconf, $graph_extras);
685         break;
686       case 'simple':
687       default:
688         $return = $this->page_simple($pconf, $graph_extras);
689         break;
690     }
691   return $return;
692   }
693
694   function simple_html($sub = null, $page_extras = null, $graph_extras = null) {
695     // create a simple (MRTG-like) HTML page and return it in a string
696     // XXX: this is here temporarily for compat only, it's preferred to use page()!
697
698     // assemble configuration
699     $pconf = (array)$page_extras;
700     if (!is_null($sub) && is_array($this->config_raw['page.'.$sub])) {
701       $pconf = $pconf + $this->config_raw['page.'.$sub];
702     }
703     $pconf = $pconf + (array)$this->config_page;
704
705   return $this->page_simple($pconf, $graph_extras);
706   }
707
708   function page_index($pconf) {
709     // create a bare, very simple index list HTML page and return it in a string
710
711     $ptitle = isset($pconf['title_page'])?$pconf['title_page']:'RRD statistics index';
712
713     $out = '<html><head>';
714     $out .= '<title>'.$ptitle.'</title>';
715     $out .= '<style>';
716     if (isset($pconf['style_base'])) { $out .= $pconf['style_base']; }
717     else {
718       $out .= 'h1 { font-weight: bold; font-size: 1.5em; }';
719       $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }';
720       $out .= 'li.scanfile { font-style: italic; }';
721     }
722     if (isset($pconf['style'])) { $out .= $pconf['style']; }
723     $out .= '</style>';
724     $out .= '</head>';
725     $out .= '<body>';
726
727     $out .= '<h1>'.$ptitle.'</h1>';
728     if (isset($pconf['text_intro']) && strlen($pconf['text_intro'])) {
729       $out .= '<p class="intro">'.$pconf['text_intro'].'</p>';
730     }
731     elseif (!isset($pconf['text_intro'])) {
732       $out .= '<p class="intro">The following RRD stats are available:</p>';
733     }
734
735     $stats = $this->h_page_statsArray($pconf);
736
737     $out .= '<ul class="indexlist">';
738     foreach ($stats as $stat) {
739       $out .= '<li'.(isset($stat['class'])?' class="'.$stat['class'].'"':'').'>';
740       $surl = '?stat='.$stat['name'];
741       $out .= '<a href="'.$surl.'">'.$stat['name'].'</a>';
742       if (isset($stat['sub']) && count($stat['sub'])) {
743         $sprt = array();
744         foreach ($stat['sub'] as $ssub) { $sprt[] = '<a href="'.$surl.'&sub='.$ssub.'">'.$ssub.'</a>'; }
745         $out .= ' <span="subs">('.implode(', ', $sprt).')</span>';
746       }
747       $out .= '</li>';
748     }
749     $out .= '</ul>';
750
751     $out .= $this->h_page_footer();
752     $out .= '</body></html>';
753   return $out;
754   }
755
756   function page_overview($pconf, $graph_extras = null) {
757     // create an overview HTML page (including graphs) and return it in a string
758
759     $ptitle = isset($pconf['title_page'])?$pconf['title_page']:'RRD statistics overview';
760
761     $out = '<html><head>';
762     $out .= '<title>'.$ptitle.'</title>';
763     $out .= '<style>';
764     if (isset($pconf['style_base'])) { $out .= $pconf['style_base']; }
765     else {
766       $out .= 'h1 { font-weight: bold; font-size: 1.5em; }';
767       $out .= 'h2 { font-weight: bold; font-size: 1em; margin: 0.5em 0; }';
768       $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }';
769       $out .= 'img.rrdgraph { border: none; }';
770     }
771     if (isset($pconf['style'])) { $out .= $pconf['style']; }
772     $out .= '</style>';
773     $out .= '</head>';
774     $out .= '<body>';
775
776     $out .= '<h1>'.$ptitle.'</h1>';
777     if (isset($pconf['text_intro'])) { $out .= '<p class="intro">'.$pconf['text_intro'].'</p>'; }
778
779     $stats = $this->h_page_statsArray($pconf);
780
781     $num_rows = is_numeric($pconf['num_rows'])?$pconf['num_rows']:2;
782     $num_cols = ceil(count($stats)/$num_rows);
783
784     $out .= '<table class="overview">';
785     for ($col = 0; $col < $num_cols; $col++) {
786       $out .= '<tr>';
787       for ($row = 0; $row < $num_rows; $row++) {
788         $idx = $col * $num_rows + $row;
789         $out .= '<td>';
790         if ($idx < count($stats)) {
791           list($sname, $s_psub) = explode('|', $stats[$idx]['name'], 2);
792           $s_psname = 'page'.(isset($s_psub)?'.'.$s_psub:'');
793           $g_sub = $this->config_all[$sname][$s_psname]['graph_sub'];
794
795           if (isset($this->config_all[$sname][$s_psname]['title_page'])) {
796             $s_ptitle = $this->config_all[$sname][$s_psname]['title_page'];
797           }
798           elseif (isset($this->config_all[$sname]['page']['title_page'])) {
799             $s_ptitle = $this->config_all[$sname]['page']['title_page'];
800           }
801           else {
802             $s_ptitle = $sname.(isset($s_psub)?' ('.$s_psub.')':'').' statistics';
803           }
804           if (!isset($pconf['hide_titles']) || !$pconf['hide_titles']) {
805             $out .= '<h2>'.$s_ptitle.'</h2>';
806           }
807
808           $s_rrd = new rrdstat($this->config_all, $sname);
809           if (in_array($s_rrd->status, array('ok','readonly','graphonly'))) {
810             $tframe = isset($pconf['graph_timeframe'])?$pconf['graph_timeframe']:'day';
811             $gmeta = $s_rrd->graph_plus($tframe, $g_sub);
812             if (isset($pconf['graph_url'])) {
813               $gURL = $pconf['graph_url'];
814               $fname = str_replace('%f', basename($gmeta['filename']), $gURL);
815               $fname = str_replace('%p', $gmeta['filename'], $gURL);
816               if (substr($gURL, -1) == '/') { $gURL .= $gmeta['filename']; }
817             }
818             else {
819               $gURL = $gmeta['filename'];
820             }
821             $out .= '<a href="?stat='.$sname.(isset($s_psub)?'&sub='.$s_psub:'').'"';
822             $out .= '<img src="'.$gURL.'"';
823             $out .= ' alt="'.$s_rrd->basename.(!is_null($g_sub)?' - '.$g_sub:'').' - '.$tframe.'" class="rrdgraph"';
824             $out .= ' style="width:'.$gmeta['width'].'px;height:'.$gmeta['height'].'px;">';
825             $out .= '</a>';
826           }
827           else {
828             $out .= 'RRD error: status is "'.$s_rrd->status.'"';
829           }
830         }
831         else {
832           $out .= '&nbsp;';
833         }
834         $out .= '</td>';
835       }
836       $out .= '</tr>';
837     }
838     $out .= '</table>';
839
840     $out .= $this->h_page_footer();
841     $out .= '</body></html>';
842   return $out;
843   }
844
845   function page_simple($pconf, $graph_extras = null) {
846     // create a simple (MRTG-like) HTML page and return it in a string
847
848     $ptitle = isset($pconf['title_page'])?$pconf['title_page']:$this->basename.' - RRD statistics';
849     $gtitle = array();
850     $gtitle['day'] = isset($pconf['title_day'])?$pconf['title_day']:'Day overview (scaling 5 minutes)';
851     $gtitle['week'] = isset($pconf['title_week'])?$pconf['title_week']:'Week overview (scaling 30 minutes)';
852     $gtitle['month'] = isset($pconf['title_month'])?$pconf['title_month']:'Month overview (scaling 2 hours)';
853     $gtitle['year'] = isset($pconf['title_year'])?$pconf['title_year']:'Year overview (scaling 1 day)';
854
855     $out = '<html><head>';
856     $out .= '<title>'.$ptitle.'</title>';
857     $out .= '<style>';
858     if (isset($pconf['style_base'])) { $out .= $pconf['style_base']; }
859     else {
860       $out .= 'h1 { font-weight: bold; font-size: 1.5em; }';
861       $out .= 'h2 { font-weight: bold; font-size: 1em; }';
862       $out .= '.gdata, .gvar, .ginfo { font-size: 0.75em; margin: 0.5em 0; }';
863       $out .= 'table.gdata { border: 1px solid gray; border-collapse: collapse; }';
864       $out .= 'table.gdata td, table.gdata th { border: 1px solid gray; padding: 0.1em 0.2em; }';
865       $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }';
866     }
867     if (isset($pconf['style'])) { $out .= $pconf['style']; }
868     $out .= '</style>';
869     $out .= '</head>';
870     $out .= '<body>';
871
872     $out .= '<h1>'.$ptitle.'</h1>';
873     if (!isset($pconf['show_update']) || $pconf['show_update']) {
874       $out .= '<p class="last_up">Last Update: '.(is_null($this->last_update())?'unknown':date('Y-m-d H:i:s', $this->last_update())).'</p>';
875     }
876
877     $g_sub = isset($pconf['graph_sub'])?$pconf['graph_sub']:null;
878     if (in_array($this->status, array('ok','readonly','graphonly'))) {
879       foreach (array('day','week','month','year') as $tframe) {
880         $gmeta = $this->graph_plus($tframe, $g_sub, $graph_extras);
881         if (isset($pconf['graph_url'])) {
882           $gURL = $pconf['graph_url'];
883           $fname = str_replace('%f', basename($gmeta['filename']), $gURL);
884           $fname = str_replace('%p', $gmeta['filename'], $gURL);
885           if (substr($gURL, -1) == '/') { $gURL .= $gmeta['filename']; }
886         }
887         else {
888           $gURL = $gmeta['filename'];
889         }
890         $out .= '<div class="'.$tframe.'">';
891 //         $out .= '<p>'.nl2br($ret).'</p>';
892         $out .= '<h2>'.$gtitle[$tframe].'</h2>';
893         $out .= '<img src="'.$gURL.'"';
894         $out .= ' alt="'.$this->basename.(!is_null($g_sub)?' - '.$g_sub:'').' - '.$tframe.'" class="rrdgraph"';
895         $out .= ' style="width:'.$gmeta['width'].'px;height:'.$gmeta['height'].'px;">';
896         if (isset($gmeta['data']) && count($gmeta['data'])) {
897           $out .= '<table class="gdata">';
898           foreach ($gmeta['data'] as $field=>$gdata) {
899             $out .= '<tr><th>'.$field.'</th>';
900             foreach ($gdata as $gkey=>$gval) {
901               $out .= '<td><span class="gkey">'.$gkey.': </span>'.$gval.'</td>';
902             }
903             $out .= '</tr>';
904           }
905           $out .= '</table>';
906         }
907         if (isset($gmeta['var']) && count($gmeta['var'])) {
908           foreach ($gmeta['var'] as $gkey=>$gval) {
909             $out .= '<p class="gvar"><span class="gkey">'.$gkey.': </span>'.$gval.'</p>';
910           }
911         }
912         if (isset($gmeta['info']) && count($gmeta['info'])) {
913           foreach ($gmeta['info'] as $gval) {
914             $out .= '<p class="ginfo">'.$gval.'</p>';
915           }
916         }
917         $out .= '</div>';
918       }
919     }
920     else {
921       $out .= 'RRD error: status is "'.$this->status.'"';
922     }
923
924     $out .= $this->h_page_footer();
925     $out .= '</body></html>';
926   return $out;
927   }
928
929   function h_page_statsArray($pconf) {
930     // return array of stats to list on a page
931     $stats = array();
932     $snames = array(); $s_exclude = array(); $sfiles = array();
933     if (isset($pconf['index_ids'])) {
934       foreach (explode(',', $pconf['index_ids']) as $iid) {
935         if ($iid{0} == '-') { $s_exclude[] = substr($iid, 1); }
936         else { $snames[] = $iid; }
937       }
938     }
939     if (!isset($pconf['scan_config']) || $pconf['scan_config']) {
940       foreach ($this->config_all as $iname=>$rinfo) {
941         if (($iname != '*') && !(isset($rinfo['hidden']) && $rinfo['hidden']) &&
942             !(in_array($iname, $snames)) && !(in_array($iname, $s_exclude))) {
943           $snames[] = $iname;
944         }
945       }
946     }
947     foreach ($snames as $iname) {
948       $newstat = array('name'=>$iname);
949       $sfiles[] = isset($this->config_all[$iname]['file'])?$this->config_all[$iname]['file']:$iname.'.rrd';
950       if (is_array($this->config_all[$iname])) {
951         foreach ($this->config_all[$iname] as $key=>$val) {
952           if (substr($key, 0, 5) == 'page.') { $newstat['sub'][] = substr($key, 5); }
953         }
954       }
955       $stats[] = $newstat;
956     }
957     if (isset($pconf['scan_files']) && $pconf['scan_files']) {
958       $rrdfiles = glob('*.rrd');
959       foreach ($rrdfiles as $rrdfile) {
960         $iname = (substr($rrdfile, -4) == '.rrd')?substr($rrdfile, 0, -4):$rrdfile;
961         if (!in_array($rrdfile, $sfiles) && !(in_array($iname, $s_exclude))) {
962           $stats[] = array('name'=>$iname, 'class'=>'scanfile');
963         }
964       }
965     }
966   return $stats;
967   }
968
969   function h_page_footer() {
970     // return generic page footer
971     $out = '<p class="footer">';
972     $out .= 'Statistics created by <a href="http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/">RRDtool</a>';
973     $out .= ' using a library created by <a href="http://www.kairo.at/">KaiRo.at</a>.';
974     $out .= '</p>';
975   return $out;
976   }
977
978   function text_quote($text) { return '"'.str_replace('"', '\"', str_replace(':', '\:', $text)).'"'; }
979 }
980 ?>