X-Git-Url: https://git-public.kairo.at/?p=php-utility-classes.git;a=blobdiff_plain;f=include%2Fclasses%2Frrdstat.php-class;h=3f5e98f920ca49e0dde13dc64a164752774fccff;hp=60b925fedafb5f1f5b4c7ebd09387dfaebff0a51;hb=ea29ba0c875bd7bfb762d831e81e8074c5f6ce32;hpb=506711ee336f82bfe5295dd722ecc6fb1fc00a33;ds=sidebyside diff --git a/include/classes/rrdstat.php-class b/include/classes/rrdstat.php-class index 60b925f..3f5e98f 100644 --- a/include/classes/rrdstat.php-class +++ b/include/classes/rrdstat.php-class @@ -12,7 +12,7 @@ * * The Initial Developer of the Original Code is * KaiRo - Robert Kaiser. - * Portions created by the Initial Developer are Copyright (C) 2005 + * Portions created by the Initial Developer are Copyright (C) 2005-2006 * the Initial Developer. All Rights Reserved. * * Contributor(s): Robert Kaiser @@ -23,138 +23,146 @@ class rrdstat { // rrdstat PHP class // rrdtool statistics functions // - // function rrdstat($rrdconfig, [$conf_id]) + // function __construct($rrdconfig, [$conf_id]) // CONSTRUCTOR // if $conf_id is set, $rrdconfig is a total configuration set // else it's the configuration for this one RRD // currently only a config array is supported, XML config is planned // - // var $rrd_file + // private $rrdtool_bin + // RRDtool binary to use + // + // private $rrd_file // RRD file name // - // var $basename + // private $basename // base name for this RRD (usually file name without .rrd) // - // var $basedir + // private $basedir // base directory for this RRD (with a trailing slash) // note that $rrd_file usually includes that path as well, but graph directory gets based on this value // - // var $config_all + // private $config_all // complete, raw configuration array set // - // var $config_raw + // private $config_raw // configuration array set for current RRD // - // var $config_graph + // private $config_graph // configuration array set for default graph in this RRD // - // var $config_page + // private $config_page // configuration array set for default page in this RRD // - // var $rrd_fields + // private $rrd_fields // definition of this RRD's fields // - // var $rra_base + // private $rra_base // definition of this RRD's base RRAs // - // var $rrd_step + // private $rrd_step // basic stepping of this RRD in seconds (default: 300) // - // var $rra_add_max + // private $rra_add_max // should RRAs for MAX be added for every base RRA? (bool, default: true) // - // var $status + // private $status // status of the RRD (unused/ok/readonly/graphonly) // note that most functions require certain status values // (e.g. update only works if status is ok, graph for ok/readonly/graphonly) // - // var $mod_textdomain + // private $mod_textdomain // GNU gettext domain for this module // - // function set_def($rrdconfig, [$conf_id]) + // private function set_def($rrdconfig, [$conf_id]) // set definitions based on given configuration // [intended for internal use, called by the constructor] // - // function create() + // public function rrd_version() { + // get RRDtool version string + // + // public function create() // create RRD file according to set config // - // function update([$upArray]) + // public function update([$upArray]) // feed new data into RRD (either use given array of values or use auto-update info from config) // - // function fetch([$cf] = 'AVERAGE', $resolution = null, $start = null, $end = null) + // public function fetch([$cf] = 'AVERAGE', $resolution = null, $start = null, $end = null) // fetch data from the defined RRD // using given consolidation function [default is AVERAGE], // resolution (seconds, default is the RRD's stepping), // start and end times (unix epoch, defaults are the RRD's last update time) // - // function last_update() + // public function last_update() // fetch time of last update in this RRD file // - // function graph([$timeframe], [$sub], [$extra]) + // public function graph([$timeframe], [$sub], [$extra]) // create a RRD graph (and return all meta info in a flat string) // for given timeframe (day [default]/week/month/year), // sub-graph ID (if given) and extra config options (if given) // - // function graph_plus([$timeframe], [$sub], [$extra]) + // public function graph_plus([$timeframe], [$sub], [$extra]) // create a RRD graph (see above) and return meta info as a ready-to-use array // - // function page([$sub], [$page_extras], [$graph_extras]) + // public function page([$sub], [$page_extras], [$graph_extras]) // create a (HTML) page and return it in a string // for given sub-page ID (if given, default is a simple HTML page) // and extra page and graph config options (if given) // - // function simple_html([$sub], [$page_extras], [$graph_extras]) + // public function simple_html([$sub], [$page_extras], [$graph_extras]) // create a simple (MRTG-like) HTML page and return it in a string // XXX: this is here temporarily for compat only, it's preferred to use page()! // - // function page_index($pconf) + // private function page_index($pconf) // create a bare, very simple index list HTML page and return it in a string // using given page config options // [intended for internal use, called by page()] // - // function page_overview($pconf, [$graph_extras]) + // private function page_overview($pconf, [$graph_extras]) // create an overview HTML page (including graphs) and return it in a string // using given page config options and extra graph options (if given) // [intended for internal use, called by page()] // - // function page_simple($pconf, [$graph_extras]) + // private function page_simple($pconf, [$graph_extras]) // create a simple (MRTG-like) HTML page and return it in a string // using given page config options and extra graph options (if given) // [intended for internal use, called by page()] // - // function h_page_statsArray($pconf) + // private function h_page_statsArray($pconf) // return array of stats to list on a page, using given page config options // [intended for internal use, called by page_*()] // - // function h_page_footer() + // private function h_page_footer() // return generic page footer // [intended for internal use, called by page_*()] // - // function text_quote($text) + // private function text_quote($text) // return a quoted/escaped text for use in rrdtool commandline text fields - var $rrd_file = null; - var $basename = null; - var $basedir = null; + private $rrdtool_bin = '/usr/bin/rrdtool'; + + private $rrd_file = null; + private $basename = null; + private $basedir = null; - var $config_all = null; - var $config_raw = null; - var $config_graph = null; - var $config_page = null; + private $config_all = null; + private $config_raw = null; + private $config_graph = null; + private $config_page = null; - var $rrd_fields = array(); - var $rra_base = array(); - var $rrd_step = 300; - var $rra_add_max = true; + private $rrd_fields = array(); + private $rra_base = array(); + private $rrd_step = 300; + private $rra_add_max = true; - var $status = 'unused'; + private $status = 'unused'; - var $mod_textdomain; + private $mod_textdomain; - function rrdstat($rrdconfig, $conf_id = null) { + function __construct($rrdconfig, $conf_id = null) { // ***** init RRD stat module ***** $this->mod_textdomain = 'class_rrdstat'; - $mod_charset = 'iso-8859-15'; + $mod_charset = 'utf-8'; bindtextdomain($this->mod_textdomain, class_exists('baseutils')?baseutils::getDir('locale'):'locale/'); bind_textdomain_codeset($this->mod_textdomain, $mod_charset); @@ -178,7 +186,7 @@ class rrdstat { } } - function set_def($rrdconfig, $conf_id = null) { + private function set_def($rrdconfig, $conf_id = null) { if (is_array($rrdconfig)) { // we have an array in the format we like to have $complete_conf =& $rrdconfig; @@ -192,8 +200,12 @@ class rrdstat { $iinfo = isset($complete_conf[$conf_id])?$complete_conf[$conf_id]:array(); if (isset($complete_conf['*'])) { $iinfo = (array)$iinfo + (array)$complete_conf['*']; - if (isset($complete_conf['*']['graph'])) { $iinfo['graph'] = (array)$iinfo['graph'] + (array)$complete_conf['*']['graph']; } - if (isset($complete_conf['*']['page'])) { $iinfo['page'] = (array)$iinfo['page'] + (array)$complete_conf['*']['page']; } + if (isset($complete_conf['*']['graph'])) { + $iinfo['graph'] = (array)$iinfo['graph'] + (array)$complete_conf['*']['graph']; + } + if (isset($complete_conf['*']['page'])) { + $iinfo['page'] = (array)$iinfo['page'] + (array)$complete_conf['*']['page']; + } } } else { @@ -238,7 +250,7 @@ class rrdstat { } - // MRTG-style RRD "database", see http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/tut/rrdtutorial.en.html + // MRTG-style RRD "database", see http://oss.oetiker.ch/rrdtool/tut/rrdtutorial.en.html // // archives (RRAs): // 600 samples of 5 minutes (2 days and 2 hours) @@ -267,11 +279,31 @@ class rrdstat { $this->config_all = $complete_conf; } - function create() { + public function rrd_version() { + // return RRDtool version + static $version; + if (!isset($version)) { + $create_cmd = $this->rrdtool_bin.' --version'; + $return = `$create_cmd 2>&1`; + if (strpos($return, 'ERROR') !== false) { + trigger_error($this->rrd_file.' - rrd version error: '.$return, E_USER_WARNING); + } + + if (preg_match('/^\s*RRDtool ([\d\.]+)\s+/', $return, $regs)) { + $version = $regs[1]; + } + else { + $version = '0.0'; + } + } + return $version; + } + + public function create() { // create RRD file // compose create command - $create_cmd = 'rrdtool create '.$this->rrd_file.' --step '.$this->rrd_step; + $create_cmd = $this->rrdtool_bin.' create '.$this->rrd_file.' --step '.$this->rrd_step; foreach ($this->rrd_fields as $ds) { if (!isset($ds['type'])) { $ds['type'] = 'COUNTER'; } if (!isset($ds['heartbeat'])) { $ds['heartbeat'] = 2*$this->rrd_step; } @@ -305,7 +337,7 @@ class rrdstat { else { $this->status = 'ok'; } } - function update($upArray = null) { + public function update($upArray = null) { // feed new data into RRD if ($this->status != 'ok') { trigger_error('Cannot update non-writeable file', E_USER_WARNING); return false; } $upvals = array(); @@ -378,7 +410,8 @@ class rrdstat { array_walk($upvals, $walkfunc); $return = null; if (count($upvals)) { - $update_cmd = 'rrdtool update '.$this->rrd_file.($key_names?' --template '.implode(':', array_keys($upvals)):'').' N:'.implode(':', $upvals); + $update_cmd = $this->rrdtool_bin.' update '.$this->rrd_file + .($key_names?' --template '.implode(':', array_keys($upvals)):'').' N:'.implode(':', $upvals); $return = `$update_cmd 2>&1`; } @@ -390,9 +423,11 @@ class rrdstat { return $success; } - function fetch($cf = 'AVERAGE', $resolution = null, $start = null, $end = null) { + public function fetch($cf = 'AVERAGE', $resolution = null, $start = null, $end = null) { // fetch data from a RRD - if (!in_array($this->status, array('ok','readonly'))) { trigger_error('Error: rrd status is '.$this->status, E_USER_WARNING); return false; } + if (!in_array($this->status, array('ok','readonly'))) { + trigger_error('Error: rrd status is '.$this->status, E_USER_WARNING); return false; + } if (!in_array($cf, array('AVERAGE','MIN','MAX','LAST'))) { $cf = 'AVERAGE'; } if (!is_numeric($resolution)) { $resolution = $this->rrd_step; } @@ -403,7 +438,8 @@ class rrdstat { elseif ($start < 0) { $start += $end; } $start = intval($start/$resolution)*$resolution; - $fetch_cmd = 'rrdtool fetch '.$this->rrd_file.' '.$cf.' --resolution '.$resolution.' --start '.$start.' --end '.$end; + $fetch_cmd = $this->rrdtool_bin.' fetch '.$this->rrd_file.' '.$cf.' --resolution '.$resolution + .' --start '.$start.' --end '.$end; $return = `$fetch_cmd 2>&1`; if (strpos($return, 'ERROR') !== false) { @@ -432,25 +468,28 @@ class rrdstat { return $fresult; } - function last_update() { + public function last_update() { // fetch time of last update in this RRD file static $last_update; if (!isset($last_update) && in_array($this->status, array('ok','readonly'))) { - $last_cmd = 'rrdtool last '.$this->rrd_file; + $last_cmd = $this->rrdtool_bin.' last '.$this->rrd_file; $return = trim(`$last_cmd 2>&1`); $last_update = is_numeric($return)?$return:null; } return isset($last_update)?$last_update:null; } - function graph($timeframe = 'day', $sub = null, $extra = null) { + public function graph($timeframe = 'day', $sub = null, $extra = null) { // create a RRD graph static $gColors; if (!isset($gColors)) { - $gColors = array('#00CC00','#0000FF','#000000','#FF0000','#00FF00','#FFFF00','#FF00FF','#00FFFF','#808080','#800000','#008000','#000080','#808000','#800080','#008080','#C0C0C0'); + $gColors = array('#00CC00','#0000FF','#000000','#FF0000','#00FF00','#FFFF00','#FF00FF','#00FFFF', + '#808080','#800000','#008000','#000080','#808000','#800080','#008080','#C0C0C0'); } - if (!in_array($this->status, array('ok','readonly','graphonly'))) { trigger_error('Error: rrd status is '.$this->status, E_USER_WARNING); return false; } + if (!in_array($this->status, array('ok','readonly','graphonly'))) { + trigger_error('Error: rrd status is '.$this->status, E_USER_WARNING); return false; + } // assemble configuration $gconf = (array)$extra; @@ -485,31 +524,32 @@ class rrdstat { $graphrows = array(); $specialrows = array(); $gC = 0; $gDefs = ''; $gGraphs = ''; $addSpecial = ''; + // the default size for the graph area has a width of 400px, so use 400 slices by default if ($timeframe == 'day') { - $duration = isset($gconf['duration'])?$gconf['duration']:30*3600; // 30 hours $slice = isset($gconf['slice'])?$gconf['slice']:300; // 5 minutes + $duration = isset($gconf['duration'])?$gconf['duration']:400*$slice; // 33.33 hours // vertical lines at day borders $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d')).'#FF0000'; $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d').' -1 day').'#FF0000'; if (!isset($gconf['grid_x'])) { $gconf['grid_x'] = 'HOUR:1:HOUR:6:HOUR:2:0:%-H'; } } elseif ($timeframe == 'week') { - $duration = isset($gconf['duration'])?$gconf['duration']:8*86400; // 8 days $slice = isset($gconf['slice'])?$gconf['slice']:1800; // 30 minutes + $duration = isset($gconf['duration'])?$gconf['duration']:400*$slice; // 8.33 days // vertical lines at week borders $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d').' '.(-date('w')+1).' day').'#FF0000'; $addSpecial .= ' VRULE:'.strtotime(date('Y-m-d').' '.(-date('w')-6).' day').'#FF0000'; } elseif ($timeframe == 'month') { - $duration = isset($gconf['duration'])?$gconf['duration']:36*86400; // 36 days $slice = isset($gconf['slice'])?$gconf['slice']:7200; // 2 hours + $duration = isset($gconf['duration'])?$gconf['duration']:400*$slice; // 33.33 days // vertical lines at month borders $addSpecial .= ' VRULE:'.strtotime(date('Y-m-01')).'#FF0000'; $addSpecial .= ' VRULE:'.strtotime(date('Y-m-01').' -1 month').'#FF0000'; } elseif ($timeframe == 'year') { - $duration = isset($gconf['duration'])?$gconf['duration']:396*86400; // 365+31 days $slice = isset($gconf['slice'])?$gconf['slice']:86400; // 1 day + $duration = isset($gconf['duration'])?$gconf['duration']:400*$slice; // 400 days // vertical lines at month borders $addSpecial .= ' VRULE:'.strtotime(date('Y-01-01 12:00:00')).'#FF0000'; $addSpecial .= ' VRULE:'.strtotime(date('Y-01-01 12:00:00').' -1 year').'#FF0000'; @@ -519,65 +559,85 @@ class rrdstat { $slice = isset($gconf['slice'])?$gconf['slice']:$this->rrd_step; // whatever our step is } - if (isset($gconf['rows']) && count($gconf['rows'])) { - foreach ($gconf['rows'] as $erow) { - if (isset($erow['name']) && strlen($erow['name'])) { - if (!isset($erow['scale']) && isset($gconf['scale'])) { $erow['scale'] = $gconf['scale']; } - $grow = array(); - $grow['dType'] = isset($erow['dType'])?$erow['dType']:'DEF'; - $grow['name'] = $erow['name'].(isset($erow['scale'])?'_tmp':''); - if ($grow['dType'] == 'DEF') { - $grow['dsname'] = isset($erow['dsname'])?$erow['dsname']:$erow['name']; - if (isset($erow['dsfile'])) { $grow['dsfile'] = $erow['dsfile']; } - $grow['cf'] = isset($erow['cf'])?$erow['cf']:'AVERAGE'; - } - else { - $grow['rpn_expr'] = isset($erow['rpn_expr'])?$erow['rpn_expr']:'0'; - } - if (isset($erow['scale'])) { - $graphrows[] = $grow; - $grow = array(); - $grow['dType'] = 'CDEF'; - $grow['name'] = $erow['name']; - $grow['rpn_expr'] = $erow['name'].'_tmp,'.$erow['scale'].',*'; - } - $grow['gType'] = isset($erow['gType'])?$erow['gType']:'LINE1'; - $grow['color'] = isset($erow['color'])?$erow['color']:$gColors[$gC++]; - $grow['color_bg'] = isset($erow['color_bg'])?$erow['color_bg']:''; - if ($gC >= count($gColors)) { $gC = 0; } - if (isset($erow['legend'])) { - $grow['legend'] = $erow['legend']; - if (!isset($gconf['show_legend'])) { $gconf['show_legend'] = true; } + $use_gcrows = (isset($gconf['rows']) && count($gconf['rows'])); + if ($use_gcrows) { $grow_def =& $gconf['rows']; } + else { $grow_def =& $this->rrd_fields; } + foreach ($grow_def as $key=>$erow) { + if (isset($erow['name']) && strlen($erow['name'])) { + if (!isset($erow['scale']) && isset($gconf['scale'])) { $erow['scale'] = $gconf['scale']; } + if (!isset($erow['scale_time_src']) && isset($gconf['scale_time_src'])) { + $erow['scale_time_src'] = $gconf['scale_time_src']; + } + if (!isset($erow['scale_time_tgt']) && isset($gconf['scale_time_tgt'])) { + $erow['scale_time_tgt'] = $gconf['scale_time_tgt']; + } + foreach (array('scale_time_src','scale_time_tgt') as $st) { + if (!isset($erow[$st]) || !is_numeric($erow[$st])) { + switch (@$erow[$st]) { + case 'dyn': + case 'auto': + $erow[$st] = $slice; + break; + case 'day': + $erow[$st] = 24*3600; + break; + case '2hr': + case '2hours': + $erow[$st] = 7200; + break; + case 'hr': + case 'hour': + $erow[$st] = 3600; + break; + case '30min': + $erow[$st] = 1800; + break; + case '5min': + $erow[$st] = 300; + break; + case 'min': + $erow[$st] = 60; + break; + case 's': + case 'sec': + default: + $erow[$st] = 1; + break; + } } - if (isset($erow['stack'])) { $grow['stack'] = ($erow['stack'] == true); } - if (isset($erow['desc'])) { $grow['desc'] = $erow['desc']; } - if (isset($erow['legend_long'])) { $grow['legend_long'] = $erow['legend_long']; } - $graphrows[] = $grow; } - } - } - else { - foreach ($this->rrd_fields as $key=>$ds) { + $scale_time_factor = $erow['scale_time_tgt']/$erow['scale_time_src']; + if ($scale_time_factor != 1) { $erow['scale'] = (isset($erow['scale'])?$erow['scale']:1)*$scale_time_factor; } $grow = array(); - $grow['dType'] = 'DEF'; - $grow['name'] = $ds['name'].(isset($gconf['scale'])?'_tmp':''); - $grow['dsname'] = $ds['name']; - $grow['cf'] = 'AVERAGE'; - if (isset($gconf['scale'])) { + $grow['dType'] = ($use_gcrows && isset($erow['dType']))?$erow['dType']:'DEF'; + $grow['name'] = $erow['name'].(isset($erow['scale'])?'_tmp':''); + if ($grow['dType'] == 'DEF') { + $grow['dsname'] = ($use_gcrows && isset($erow['dsname']))?$erow['dsname']:$erow['name']; + if ($use_gcrows && isset($erow['dsfile'])) { $grow['dsfile'] = $erow['dsfile']; } + $grow['cf'] = ($use_gcrows && isset($erow['cf']))?$erow['cf']:'AVERAGE'; + } + else { + $grow['rpn_expr'] = isset($erow['rpn_expr'])?$erow['rpn_expr']:'0'; + } + if (isset($erow['scale'])) { $graphrows[] = $grow; $grow = array(); $grow['dType'] = 'CDEF'; - $grow['name'] = $ds['name']; - $grow['rpn_expr'] = $ds['name'].'_tmp,'.$gconf['scale'].',*'; + $grow['name'] = $erow['name']; + $grow['rpn_expr'] = $erow['name'].'_tmp,'.$erow['scale'].',*'; } - $grow['gType'] = ((count($this->rrd_fields)==2) && ($key==0))?'AREA':'LINE1'; - $grow['color'] = $gColors[$gC++]; if ($gC >= count($gColors)) { $gC = 0; } - if (isset($ds['legend'])) { - $grow['legend'] = $ds['legend']; + if ($use_gcrows) { $grow['gType'] = isset($erow['gType'])?$erow['gType']:'LINE1'; } + else { $grow['gType'] = ((count($grow_def)==2) && ($key==0))?'AREA':'LINE1'; } + $grow['color'] = isset($erow['color'])?$erow['color']:$gColors[$gC++]; + $grow['color_bg'] = isset($erow['color_bg'])?$erow['color_bg']:''; + if ($gC >= count($gColors)) { $gC = 0; } + if (isset($erow['legend'])) { + $grow['legend'] = $erow['legend']; if (!isset($gconf['show_legend'])) { $gconf['show_legend'] = true; } } - if (isset($ds['desc'])) { $grow['desc'] = $ds['desc']; } - if (isset($ds['legend_long'])) { $grow['legend_long'] = $ds['legend_long']; } + if (isset($erow['stack'])) { $grow['stack'] = ($erow['stack'] == true); } + if (isset($erow['desc'])) { $grow['desc'] = $erow['desc']; } + if (isset($erow['legend_long'])) { $grow['legend_long'] = $erow['legend_long']; } $graphrows[] = $grow; } } @@ -588,16 +648,23 @@ class rrdstat { $srow['sType'] = isset($crow['sType'])?$crow['sType']:'COMMENT'; if ($grow['sType'] != 'COMMENT') { // XXX: use line below and remove cf var once we have rrdtol 1.2 - // $srow['name'] = $crow['name'].(isset($crow['cf'])?'_'.$crow['cf']:''); - $srow['name'] = $crow['name']; - $srow['cf'] = isset($crow['cf'])?$crow['cf']:'AVERAGE'; + if ($this->rrd_version() >= '1.2') { + $srow['name'] = $crow['name'].(isset($crow['cf'])?'_'.$crow['cf']:''); + } + else { + $srow['name'] = $crow['name']; + $srow['cf'] = isset($crow['cf'])?$crow['cf']:'AVERAGE'; + } if (isset($crow['cf'])) { - // XXX: use line below once we have rrdtol 1.2 - // $graphrows[] = array('dType'=>'VDEF', 'name'=>$srow['name'].'_'.$crow['cf'], 'rpn_expr'=>$srow['name'].','.$crow['cf']); + if ($this->rrd_version() >= '1.2') { + $graphrows[] = array('dType'=>'VDEF', 'name'=>$srow['name'].'_'.$crow['cf'], + 'rpn_expr'=>$srow['name'].','.$crow['cf']); + } } elseif (isset($crow['rpn_expr'])) { - // XXX: does only work with rrdtool 1.2 - $graphrows[] = array('dType'=>'VDEF', 'name'=>$srow['name'], 'rpn_expr'=>$crow['rpn_expr']); + if ($this->rrd_version() >= '1.2') { + $graphrows[] = array('dType'=>'VDEF', 'name'=>$srow['name'], 'rpn_expr'=>$crow['rpn_expr']); + } } } $srow['text'] = isset($crow['text'])?$crow['text']:''; @@ -609,12 +676,25 @@ class rrdstat { foreach ($graphrows as $grow) { if (isset($grow['gType']) && strlen($grow['gType'])) { $textprefix = isset($grow['desc'])?$grow['desc']:(isset($grow['legend'])?$grow['legend']:$grow['name']); - // XXX: use lines below once we have rrdtol 1.2 - // $graphrows[] = array('dType'=>'VDEF', 'name'=>$grow['name'].'_last', 'rpn_expr'=>$grow['name'].',LAST'); - // $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'].'_last', 'text'=>'%3.2lf%s'); - $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'MAX', 'text'=>$textprefix.'|'.dgettext($td, 'Maximum').'|%.2lf%s'); - $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'AVERAGE', 'text'=>$textprefix.'|'.dgettext($td, 'Average').'|%.2lf%s'); - $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'LAST', 'text'=>$textprefix.'|'.dgettext($td, 'Current').'|%.2lf%s'); + if ($this->rrd_version() >= '1.2') { + $graphrows[] = array('dType'=>'VDEF', 'name'=>'_'.$grow['name'].'__max', 'rpn_expr'=>$grow['name'].',MAXIMUM'); + $specialrows[] = array('sType'=>'PRINT', 'name'=>'_'.$grow['name'].'__max', + 'text'=>$textprefix.'|'.dgettext($td, 'Maximum').'|%.2lf%s'); + $graphrows[] = array('dType'=>'VDEF', 'name'=>'_'.$grow['name'].'__avg', 'rpn_expr'=>$grow['name'].',AVERAGE'); + $specialrows[] = array('sType'=>'PRINT', 'name'=>'_'.$grow['name'].'__avg', + 'text'=>$textprefix.'|'.dgettext($td, 'Average').'|%.2lf%s'); + $graphrows[] = array('dType'=>'VDEF', 'name'=>'_'.$grow['name'].'__last', 'rpn_expr'=>$grow['name'].',LAST'); + $specialrows[] = array('sType'=>'PRINT', 'name'=>'_'.$grow['name'].'__last', + 'text'=>$textprefix.'|'.dgettext($td, 'Current').'|%.2lf%s'); + } + else { + $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'MAX', + 'text'=>$textprefix.'|'.dgettext($td, 'Maximum').'|%.2lf%s'); + $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'AVERAGE', + 'text'=>$textprefix.'|'.dgettext($td, 'Average').'|%.2lf%s'); + $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'LAST', + 'text'=>$textprefix.'|'.dgettext($td, 'Current').'|%.2lf%s'); + } } } } @@ -628,14 +708,22 @@ class rrdstat { if (($gconf['height'] <= 32) && isset($gconf['thumb']) && ($gconf['thumb'])) { $gOpts .= ' --only-graph'; } } if (!isset($gconf['show_legend']) || (!$gconf['show_legend'])) { $gOpts .= ' --no-legend'; } + if (isset($gconf['logarithmic']) && $gconf['logarithmic']) { $gOpts .= ' --logarithmic'; } if (isset($gconf['min_y'])) { $gOpts .= ' --lower-limit '.$gconf['min_y']; } if (isset($gconf['max_y'])) { $gOpts .= ' --upper-limit '.$gconf['max_y']; } if (isset($gconf['fix_scale_y']) && $gconf['fix_scale_y']) { $gOpts .= ' --rigid'; } if (isset($gconf['grid_x'])) { $gOpts .= ' --x-grid '.$gconf['grid_x']; } if (isset($gconf['grid_y'])) { $gOpts .= ' --y-grid '.$gconf['grid_y']; } + if (isset($gconf['gridfit']) && (!$gconf['gridfit'])) { $gOpts .= ' --no-gridfit'; } + if (isset($gconf['calc_scale_y']) && $gconf['calc_scale_y']) { $gOpts .= ' --alt-autoscale'; } + if (isset($gconf['calc_max_y']) && $gconf['calc_max_y']) { $gOpts .= ' --alt-autoscale-max'; } if (isset($gconf['units_exponent'])) { $gOpts .= ' --units-exponent '.$gconf['units_exponent']; } if (isset($gconf['units_length'])) { $gOpts .= ' --units-length '.$gconf['units_length']; } - if (!isset($gconf['force_recreate']) || (!$gconf['force_recreate'])) { $gOpts .= ' --lazy'; } + if (($this->rrd_version() < '1.2') || !count($specialrows)) { + // lazy graphics omit all print reporting in RRDtool 1.2! + // --> so don't use them there when we want to print stuff + if (!isset($gconf['force_recreate']) || (!$gconf['force_recreate'])) { $gOpts .= ' --lazy'; } + } if (isset($gconf['force_color']) && is_array($gconf['force_color'])) { foreach ($gconf['force_color'] as $ctag=>$cval) { $gOpts .= ' --color '.$ctag.$cval; } } @@ -655,33 +743,45 @@ class rrdstat { } if (isset($grow['gType']) && strlen($grow['gType'])) { // XXX: change from STACK type to STACK flag once we have rrdtool 1.2 - if (isset($grow['stack']) && $grow['stack']) { $grow['gType'] = 'STACK'; } + if ($this->rrd_version() < '1.2') { + // rrdtool 1.0 only know STACK type + if (isset($grow['stack']) && $grow['stack']) { $grow['gType'] = 'STACK'; } + } $gGraphs .= ' '.$grow['gType'].':'.$grow['name'].$grow['color']; if (isset($grow['legend'])) { $gGraphs .= ':'.$this->text_quote($grow['legend']); } - // XXX: remove above STACK if-command and uncomment the one below once we have rrdtool 1.2 - //if (isset($grow['stack']) && $grow['stack']) { $gGraphs .= ':STACK'; } + if ($this->rrd_version() >= '1.2') { + // rrdtool 1.2 and above have STACK flag + if (isset($grow['stack']) && $grow['stack']) { $gGraphs .= ':STACK'; } + } } } foreach ($specialrows as $srow) { $addSpecial .= ' '.$srow['sType']; - // XXX: eliminate cf once we have rrdtool 1.2 - // $addSpecial .= ($grow['sType']!='COMMENT')?':'.$grow['name']:''); - $addSpecial .= (($srow['sType']!='COMMENT')?':'.$srow['name'].':'.$srow['cf']:''); + if ($this->rrd_version() >= '1.2') { + $addSpecial .= (($srow['sType']!='COMMENT')?':'.$srow['name']:''); + } + else { + $addSpecial .= (($srow['sType']!='COMMENT')?':'.$srow['name'].':'.$srow['cf']:''); + } $addSpecial .= ':'.$this->text_quote($srow['text']); } - $graph_cmd = 'rrdtool graph '.str_replace('*', '\*', $fname.$gOpts.$gDefs.$gGraphs.$addSpecial); + $graph_cmd = $this->rrdtool_bin.' graph '.str_replace('*', '\*', $fname.$gOpts.$gDefs.$gGraphs.$addSpecial); $return = `$graph_cmd 2>&1`; if (strpos($return, 'ERROR') !== false) { trigger_error($this->rrd_file.' - rrd graph error: '.$return, E_USER_WARNING); - $return = $graph_cmd."\n\n".$return; + $return = 'command:'.$graph_cmd."\n\n".$return; + } + if (0) { + // debug output + $return = 'command:'.$graph_cmd."\n\n".$return; } $legendlines = ''; foreach ($graphrows as $grow) { $legendline = isset($grow['desc'])?$grow['desc']:(isset($grow['legend'])?$grow['legend']:$grow['name']); - $legendline .= '|'.$grow['color']; + $legendline .= '|'.@$grow['color']; $legendline .= '|'.(isset($grow['color_bg'])?$grow['color_bg']:''); $legendline .= '|'.(isset($grow['legend_long'])?$grow['legend_long']:''); $legendlines .= 'legend:'.$legendline."\n"; @@ -690,18 +790,23 @@ class rrdstat { return $return; } - function graph_plus($timeframe = 'day', $sub = null, $extra = null) { + public function graph_plus($timeframe = 'day', $sub = null, $extra = null) { // create a RRD graph and return meta info as a ready-to-use array $gmeta = array('filename'=>null,'legends_long'=>false,'default_colorize'=>false); $ret = $this->graph($timeframe, $sub, $extra); - if (strpos($ret, "\n\n") !== false) { $gmeta['graph_cmd'] = substr($ret, 0, strpos($ret, "\n\n")); $ret = substr($ret, strpos($ret, "\n\n")+2); } - else { $gmeta['graph_cmd'] = null; } + if (0) { + // debug output + $gmeta['ret'] = $ret; + } $grout = explode("\n", $ret); foreach ($grout as $gline) { - if (preg_match('/^file:(.+)$/', $gline, $regs)) { + if (preg_match('/^command:(.+)$/', $gline, $regs)) { + $gmeta['graph_cmd'] = $regs[1]; + } + elseif (preg_match('/^file:(.+)$/', $gline, $regs)) { $gmeta['filename'] = $regs[1]; } - elseif (preg_match('/^legend:([^\|]+)\|([^|]+)\|([^\|]*)\|(.*)$/', $gline, $regs)) { + elseif (preg_match('/^legend:([^\|]+)\|([^|]*)\|([^\|]*)\|(.*)$/', $gline, $regs)) { $gmeta['legend'][$regs[1]] = array('color'=>$regs[2], 'color_bg'=>$regs[3], 'desc_long'=>$regs[4]); if (strlen($regs[4])) { $gmeta['legends_long'] = true; } if (strlen($regs[3]) || strlen($regs[4])) { $gmeta['default_colorize'] = true; } @@ -725,7 +830,7 @@ class rrdstat { return $gmeta; } - function page($sub = null, $page_extras = null, $graph_extras = null) { + public function page($sub = null, $page_extras = null, $graph_extras = null) { // create a (HTML) page and return it in a string // assemble configuration @@ -751,9 +856,10 @@ class rrdstat { return $return; } - function simple_html($sub = null, $page_extras = null, $graph_extras = null) { + public function simple_html($sub = null, $page_extras = null, $graph_extras = null) { // create a simple (MRTG-like) HTML page and return it in a string // XXX: this is here temporarily for compat only, it's preferred to use page()! + trigger_error(__CLASS__.'::'.__METHOD__.' is deprecated, use page() instead.', E_USER_NOTICE); // assemble configuration $pconf = (array)$page_extras; @@ -765,31 +871,31 @@ class rrdstat { return $this->page_simple($pconf, $graph_extras); } - function page_index($pconf) { + private function page_index($pconf) { // create a bare, very simple index list HTML page and return it in a string $td = $this->mod_textdomain; $ptitle = isset($pconf['title_page'])?$pconf['title_page']:dgettext($td, 'RRD statistics index'); - $out = ''; - $out .= ''.$ptitle.''; - $out .= ''; - $out .= ''; - $out .= ''; + $out .= ''."\n"; + $out .= ''."\n"; + $out .= ''."\n"; - $out .= '

'.$ptitle.'

'; + $out .= '

'.$ptitle.'

'."\n"; if (isset($pconf['text_intro']) && strlen($pconf['text_intro'])) { - $out .= '

'.$pconf['text_intro'].'

'; + $out .= '

'.$pconf['text_intro'].'

'."\n"; } elseif (!isset($pconf['text_intro'])) { - $out .= '

'.dgettext($td, 'The following RRD stats are available:').'

'; + $out .= '

'.dgettext($td, 'The following RRD stats are available:').'

'."\n"; } $stats = $this->h_page_statsArray($pconf); @@ -800,7 +906,7 @@ class rrdstat { if (isset($pconf['stats_url_add'])) { $sURL_add = $pconf['stats_url_add']; } else { $sURL_add = '&sub=%s'; } - $out .= ''."\n"; $out .= $this->h_page_footer(); - $out .= ''; + $out .= ''."\n"; return $out; } - function page_overview($pconf, $graph_extras = null) { + private function page_overview($pconf, $graph_extras = null) { // create an overview HTML page (including graphs) and return it in a string $td = $this->mod_textdomain; $ptitle = isset($pconf['title_page'])?$pconf['title_page']:dgettext($td, 'RRD statistics overview'); - $out = ''; - $out .= ''.$ptitle.''; - $out .= ''; - $out .= ''; - $out .= ''; + $out .= ''."\n"; + $out .= ''."\n"; + $out .= ''."\n"; - $out .= '

'.$ptitle.'

'; - if (isset($pconf['text_intro'])) { $out .= '

'.$pconf['text_intro'].'

'; } + $out .= '

'.$ptitle.'

'."\n"; + if (isset($pconf['text_intro']) && strlen($pconf['text_intro'])) { + $out .= '

'.$pconf['text_intro'].'

'; + } $stats = $this->h_page_statsArray($pconf); @@ -860,16 +968,16 @@ class rrdstat { $num_rows = is_numeric($pconf['num_rows'])?$pconf['num_rows']:2; $num_cols = ceil(count($stats)/$num_rows); - $out .= ''; + $out .= '
'."\n"; for ($col = 0; $col < $num_cols; $col++) { - $out .= ''; + $out .= ''."\n"; for ($row = 0; $row < $num_rows; $row++) { $idx = $col * $num_rows + $row; - $out .= ''; + $out .= ''."\n"; } - $out .= ''; + $out .= ''."\n"; } - $out .= '
'; + $out .= ''."\n"; if ($idx < count($stats)) { - list($sname, $s_psub) = explode('|', $stats[$idx]['name'], 2); + @list($sname, $s_psub) = explode('|', $stats[$idx]['name'], 2); $s_psname = 'page'.(isset($s_psub)?'.'.$s_psub:''); - $g_sub = $this->config_all[$sname][$s_psname]['graph_sub']; + $g_sub = @$this->config_all[$sname][$s_psname]['graph_sub']; if (isset($this->config_all[$sname][$s_psname]['title_page'])) { $s_ptitle = $this->config_all[$sname][$s_psname]['title_page']; @@ -878,10 +986,12 @@ class rrdstat { $s_ptitle = $this->config_all[$sname]['page']['title_page']; } else { - $s_ptitle = isset($s_psub)?sprintf(dgettext($td, '%s (%s) statistics'), $sname, $s_psub):sprintf(dgettext($td, '%s statistics'), $sname); + $s_ptitle = isset($s_psub) + ?sprintf(dgettext($td, '%s (%s) statistics'), $sname, $s_psub) + :sprintf(dgettext($td, '%s statistics'), $sname); } if (!isset($pconf['hide_titles']) || !$pconf['hide_titles']) { - $out .= '

'.$s_ptitle.'

'; + $out .= '

'.$s_ptitle.'

'."\n"; } $s_rrd = new rrdstat($this->config_all, $sname); @@ -903,28 +1013,30 @@ class rrdstat { $out .= ''; $out .= 'basename.(!is_null($g_sub)?' - '.$g_sub:'').' - '.$tframe.'" class="rrdgraph"'; - if (isset($gmeta['width']) && isset($gmeta['height'])) { $out .= ' style="width:'.$gmeta['width'].'px;height:'.$gmeta['height'].'px;"'; } - $out .= '>'; + if (isset($gmeta['width']) && isset($gmeta['height'])) { + $out .= ' style="width:'.$gmeta['width'].'px;height:'.$gmeta['height'].'px;"'; + } + $out .= '>'."\n"; } else { - $out .= sprintf(dgettext($td, 'RRD error: status is "%s"'), $s_rrd->status); + $out .= sprintf(dgettext($td, 'RRD error: status is "%s"'), $s_rrd->status)."\n"; } } else { $out .= ' '; } - $out .= '
'; + $out .= ''."\n"; $out .= $this->h_page_footer(); - $out .= ''; + $out .= ''."\n"; return $out; } - function page_simple($pconf, $graph_extras = null) { + private function page_simple($pconf, $graph_extras = null) { // create a simple (MRTG-like) HTML page and return it in a string $td = $this->mod_textdomain; @@ -936,34 +1048,37 @@ class rrdstat { $gtitle['year'] = isset($pconf['title_year'])?$pconf['title_year']:dgettext($td, 'Year overview (scaling 1 day)'); $ltitle = isset($pconf['title_legend'])?$pconf['title_legend']:dgettext($td, 'Legend:'); - $out = ''; - $out .= ''.$ptitle.''; - $out .= ''; - $out .= ''; - $out .= ''; + $out .= ''."\n"; + $out .= ''."\n"; + $out .= ''."\n"; - $out .= '

'.$ptitle.'

'; + $out .= '

'.$ptitle.'

'."\n"; + if (isset($pconf['text_intro']) && strlen($pconf['text_intro'])) { + $out .= '

'.$pconf['text_intro'].'

'."\n"; + } if (!isset($pconf['show_update']) || $pconf['show_update']) { $out .= '

'; if (is_null($this->last_update())) { $up_time = dgettext($td, 'unknown'); } elseif (class_exists('baseutils')) { $up_time = baseutils::dateFormat($this->last_update(), 'short'); } else { $up_time = date('Y-m-d H:i:s', $this->last_update()); } $out .= sprintf(dgettext($td, 'Last Update: %s'), $up_time); - $out .= '

'; + $out .= '

'."\n"; } $g_sub = isset($pconf['graph_sub'])?$pconf['graph_sub']:null; @@ -979,16 +1094,26 @@ class rrdstat { else { $gURL = $gmeta['filename']; } - $out .= '
'; -// $out .= '

'.nl2br($ret).'

'; - $out .= '

'.$gtitle[$tframe].'

'; + $out .= '
'."\n"; + if (0) { + // debug output + ob_start(); + print_r($gmeta); + $buffer = ob_get_contents(); + ob_end_clean(); + $out .= '

'.nl2br($buffer).'

'; + } + $out .= '

'.$gtitle[$tframe].'

'."\n"; $out .= 'basename.(!is_null($g_sub)?' - '.$g_sub:'').' - '.$tframe.'" class="rrdgraph"'; - if (isset($gmeta['width']) && isset($gmeta['height'])) { $out .= ' style="width:'.$gmeta['width'].'px;height:'.$gmeta['height'].'px;"'; } - $out .= '>'; - $colorize_data = (isset($pconf['data_colorize']) && $pconf['data_colorize']) || (!isset($pconf['data_colorize']) && $gmeta['default_colorize']); + if (isset($gmeta['width']) && isset($gmeta['height'])) { + $out .= ' style="width:'.$gmeta['width'].'px;height:'.$gmeta['height'].'px;"'; + } + $out .= '>'."\n"; + $colorize_data = (isset($pconf['data_colorize']) && $pconf['data_colorize']) || + (!isset($pconf['data_colorize']) && $gmeta['default_colorize']); if (isset($gmeta['data']) && count($gmeta['data'])) { - $out .= ''; + $out .= '
'."\n"; foreach ($gmeta['data'] as $field=>$gdata) { $out .= '$gval) { $out .= ''; } - $out .= ''; + $out .= ''."\n"; } - $out .= '
'.$gkey.': '.$gval.'
'; + $out .= ''."\n"; } if (isset($gmeta['var']) && count($gmeta['var'])) { foreach ($gmeta['var'] as $gkey=>$gval) { - $out .= '

'.$gkey.': '.$gval.'

'; + $out .= '

'.$gkey.': '.$gval.'

'."\n"; } } if (isset($gmeta['info']) && count($gmeta['info'])) { foreach ($gmeta['info'] as $gval) { - $out .= '

'.$gval.'

'; + $out .= '

'.$gval.'

'."\n"; } } - $out .= '
'; + $out .= '
'."\n"; } if ($gmeta['legends_long'] && (!isset($pconf['show_legend']) || $pconf['show_legend'])) { - $out .= '
'; - $out .= '

'.$ltitle.'

'; - $out .= ''; + $out .= '
'."\n"; + $out .= '

'.$ltitle.'

'."\n"; + $out .= '
'."\n"; foreach ($gmeta['legend'] as $field=>$legend) { - $out .= ''; + $out .= ''; + $out .= ''."\n"; } - $out .= '>'.$field.''; - $out .= ''; - $out .= ''; } - $out .= '
'.$legend['desc_long'].'
'.$legend['desc_long'].'
'; - $out .= '
'; + $out .= ''."\n"; + $out .= ''."\n"; } } else { - $out .= sprintf(dgettext($td, 'RRD error: status is "%s"'), $this->status); + $out .= sprintf(dgettext($td, 'RRD error: status is "%s"'), $this->status)."\n"; } $out .= $this->h_page_footer(); - $out .= ''; + $out .= ''."\n"; return $out; } - function h_page_statsArray($pconf) { + private function h_page_statsArray($pconf) { // return array of stats to list on a page $stats = array(); $snames = array(); $s_exclude = array(); $sfiles = array(); @@ -1088,16 +1215,20 @@ class rrdstat { return $stats; } - function h_page_footer() { + private function h_page_footer() { // return generic page footer $out = ''; + $out .= '

'."\n"; return $out; } - function text_quote($text) { return '"'.str_replace('"', '\"', str_replace(':', '\:', $text)).'"'; } + private function text_quote($text) { + $trans = array('"' => '\"', ':' => '\:'); + $qtext = '"'.strtr($text, $trans).'"'; + return $qtext; + } } ?>