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