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