*
* 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 <kairo@kairo.at>
// 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 $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 $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';
}
}
- 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;
$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 {
}
- // 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)
$this->config_all = $complete_conf;
}
- function create() {
+ public function rrd_version() {
+ // return RRDtool version
+ static $version;
+ if (!isset($version)) {
+ $create_cmd = 'rrdtool --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
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();
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 = 'rrdtool update '.$this->rrd_file
+ .($key_names?' --template '.implode(':', array_keys($upvals)):'').' N:'.implode(':', $upvals);
$return = `$update_cmd 2>&1`;
}
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; }
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'))) {
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;
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']; }
+ 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]) {
$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']:'';
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');
+ }
}
}
}
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; }
}
}
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']);
}
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) {
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)) {
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
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;
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 = '<html><head>';
- $out .= '<title>'.$ptitle.'</title>';
- $out .= '<style>';
+ $out = '<html><head>'."\n";
+ $out .= '<title>'.$ptitle.'</title>'."\n";
+ $out .= '<style type="text/css">'."\n";
if (isset($pconf['style_base'])) { $out .= $pconf['style_base']; }
else {
- $out .= 'h1 { font-weight: bold; font-size: 1.5em; }';
- $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }';
- $out .= 'li.scanfile { font-style: italic; }';
+ $out .= 'h1 { font-weight: bold; font-size: 1.5em; }'."\n";
+ $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }'."\n";
+ $out .= 'li.scanfile { font-style: italic; }'."\n";
}
if (isset($pconf['style'])) { $out .= $pconf['style']; }
- $out .= '</style>';
- $out .= '</head>';
- $out .= '<body>';
+ $out .= '</style>'."\n";
+ $out .= '</head>'."\n";
+ $out .= '<body>'."\n";
- $out .= '<h1>'.$ptitle.'</h1>';
+ $out .= '<h1>'.$ptitle.'</h1>'."\n";
if (isset($pconf['text_intro']) && strlen($pconf['text_intro'])) {
- $out .= '<p class="intro">'.$pconf['text_intro'].'</p>';
+ $out .= '<p class="intro">'.$pconf['text_intro'].'</p>'."\n";
}
elseif (!isset($pconf['text_intro'])) {
- $out .= '<p class="intro">'.dgettext($td, 'The following RRD stats are available:').'</p>';
+ $out .= '<p class="intro">'.dgettext($td, 'The following RRD stats are available:').'</p>'."\n";
}
$stats = $this->h_page_statsArray($pconf);
if (isset($pconf['stats_url_add'])) { $sURL_add = $pconf['stats_url_add']; }
else { $sURL_add = '&sub=%s'; }
- $out .= '<ul class="indexlist">';
+ $out .= '<ul class="indexlist">'."\n";
foreach ($stats as $stat) {
$out .= '<li'.(isset($stat['class'])?' class="'.$stat['class'].'"':'').'>';
$sURL = str_replace('%i', $stat['name'], $sURL_base);
}
$out .= ' <span="subs">('.implode(', ', $sprt).')</span>';
}
- $out .= '</li>';
+ $out .= '</li>'."\n";
}
- $out .= '</ul>';
+ $out .= '</ul>'."\n";
$out .= $this->h_page_footer();
- $out .= '</body></html>';
+ $out .= '</body></html>'."\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 = '<html><head>';
- $out .= '<title>'.$ptitle.'</title>';
- $out .= '<style>';
+ $out = '<html><head>'."\n";
+ $out .= '<title>'.$ptitle.'</title>'."\n";
+ $out .= '<style type="text/css">'."\n";
if (isset($pconf['style_base'])) { $out .= $pconf['style_base']; }
else {
- $out .= 'h1 { font-weight: bold; font-size: 1.5em; }';
- $out .= 'h2 { font-weight: bold; font-size: 1em; margin: 0.5em 0; }';
- $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }';
- $out .= 'img.rrdgraph { border: none; }';
+ $out .= 'h1 { font-weight: bold; font-size: 1.5em; }'."\n";
+ $out .= 'h2 { font-weight: bold; font-size: 1em; margin: 0.5em 0; }'."\n";
+ $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }'."\n";
+ $out .= 'img.rrdgraph { border: none; }'."\n";
}
if (isset($pconf['style'])) { $out .= $pconf['style']; }
- $out .= '</style>';
- $out .= '</head>';
- $out .= '<body>';
+ $out .= '</style>'."\n";
+ $out .= '</head>'."\n";
+ $out .= '<body>'."\n";
- $out .= '<h1>'.$ptitle.'</h1>';
- if (isset($pconf['text_intro']) && strlen($pconf['text_intro'])) { $out .= '<p class="intro">'.$pconf['text_intro'].'</p>'; }
+ $out .= '<h1>'.$ptitle.'</h1>'."\n";
+ if (isset($pconf['text_intro']) && strlen($pconf['text_intro'])) {
+ $out .= '<p class="intro">'.$pconf['text_intro'].'</p>';
+ }
$stats = $this->h_page_statsArray($pconf);
$num_rows = is_numeric($pconf['num_rows'])?$pconf['num_rows']:2;
$num_cols = ceil(count($stats)/$num_rows);
- $out .= '<table class="overview">';
+ $out .= '<table class="overview">'."\n";
for ($col = 0; $col < $num_cols; $col++) {
- $out .= '<tr>';
+ $out .= '<tr>'."\n";
for ($row = 0; $row < $num_rows; $row++) {
$idx = $col * $num_rows + $row;
- $out .= '<td>';
+ $out .= '<td>'."\n";
if ($idx < count($stats)) {
@list($sname, $s_psub) = explode('|', $stats[$idx]['name'], 2);
$s_psname = 'page'.(isset($s_psub)?'.'.$s_psub:'');
$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 .= '<h2>'.$s_ptitle.'</h2>';
+ $out .= '<h2>'.$s_ptitle.'</h2>'."\n";
}
$s_rrd = new rrdstat($this->config_all, $sname);
$out .= '<a href="'.$sURL.'">';
$out .= '<img src="'.$gURL.'"';
$out .= ' alt="'.$s_rrd->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 .= '></a>';
+ if (isset($gmeta['width']) && isset($gmeta['height'])) {
+ $out .= ' style="width:'.$gmeta['width'].'px;height:'.$gmeta['height'].'px;"';
+ }
+ $out .= '></a>'."\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 .= '</td>';
+ $out .= '</td>'."\n";
}
- $out .= '</tr>';
+ $out .= '</tr>'."\n";
}
- $out .= '</table>';
+ $out .= '</table>'."\n";
$out .= $this->h_page_footer();
- $out .= '</body></html>';
+ $out .= '</body></html>'."\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;
$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 = '<html><head>';
- $out .= '<title>'.$ptitle.'</title>';
- $out .= '<style>';
+ $out = '<html><head>'."\n";
+ $out .= '<title>'.$ptitle.'</title>'."\n";
+ $out .= '<style type="text/css">'."\n";
if (isset($pconf['style_base'])) { $out .= $pconf['style_base']; }
else {
- $out .= 'h1 { font-weight: bold; font-size: 1.5em; }';
- $out .= 'h2 { font-weight: bold; font-size: 1em; }';
- $out .= '.gdata, .gvar, .ginfo { font-size: 0.75em; margin: 0.5em 0; }';
- $out .= 'table.gdata, table.legend { border: 1px solid gray; border-collapse: collapse; }';
- $out .= 'table.gdata td, table.gdata th, ';
- $out .= 'table.legend td, table.legend th { border: 1px solid gray; padding: 0.1em 0.2em; }';
- $out .= 'div.legend { font-size: 0.75em; margin: 0.5em 0; }';
- $out .= 'div.legend p { margin: 0; }';
- $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }';
+ $out .= 'h1 { font-weight: bold; font-size: 1.5em; }'."\n";
+ $out .= 'h2 { font-weight: bold; font-size: 1em; }'."\n";
+ $out .= '.gdata, .gvar, .ginfo { font-size: 0.75em; margin: 0.5em 0; }'."\n";
+ $out .= 'table.gdata, table.legend { border: 1px solid gray; border-collapse: collapse; }'."\n";
+ $out .= 'table.gdata td, table.gdata th, '."\n";
+ $out .= 'table.legend td, table.legend th { border: 1px solid gray; padding: 0.1em 0.2em; }'."\n";
+ $out .= 'div.legend { font-size: 0.75em; margin: 0.5em 0; }'."\n";
+ $out .= 'div.legend p { margin: 0; }'."\n";
+ $out .= '.footer { font-size: 0.75em; margin: 0.5em 0; }'."\n";
}
if (isset($pconf['style'])) { $out .= $pconf['style']; }
- $out .= '</style>';
- $out .= '</head>';
- $out .= '<body>';
+ $out .= '</style>'."\n";
+ $out .= '</head>'."\n";
+ $out .= '<body>'."\n";
- $out .= '<h1>'.$ptitle.'</h1>';
- if (isset($pconf['text_intro']) && strlen($pconf['text_intro'])) { $out .= '<p class="intro">'.$pconf['text_intro'].'</p>'; }
+ $out .= '<h1>'.$ptitle.'</h1>'."\n";
+ if (isset($pconf['text_intro']) && strlen($pconf['text_intro'])) {
+ $out .= '<p class="intro">'.$pconf['text_intro'].'</p>'."\n";
+ }
if (!isset($pconf['show_update']) || $pconf['show_update']) {
$out .= '<p class="last_up">';
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 .= '</p>';
+ $out .= '</p>'."\n";
}
$g_sub = isset($pconf['graph_sub'])?$pconf['graph_sub']:null;
else {
$gURL = $gmeta['filename'];
}
- $out .= '<div class="'.$tframe.'">';
-// $out .= '<p>'.nl2br($ret).'</p>';
- $out .= '<h2>'.$gtitle[$tframe].'</h2>';
+ $out .= '<div class="'.$tframe.'">'."\n";
+ if (0) {
+ // debug output
+ ob_start();
+ print_r($gmeta);
+ $buffer = ob_get_contents();
+ ob_end_clean();
+ $out .= '<p>'.nl2br($buffer).'</p>';
+ }
+ $out .= '<h2>'.$gtitle[$tframe].'</h2>'."\n";
$out .= '<img src="'.$gURL.'"';
$out .= ' alt="'.$this->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 .= '<table class="gdata">';
+ $out .= '<table class="gdata">'."\n";
foreach ($gmeta['data'] as $field=>$gdata) {
$out .= '<tr><th';
if ($colorize_data && isset($gmeta['legend'][$field])) {
foreach ($gdata as $gkey=>$gval) {
$out .= '<td><span class="gkey">'.$gkey.': </span>'.$gval.'</td>';
}
- $out .= '</tr>';
+ $out .= '</tr>'."\n";
}
- $out .= '</table>';
+ $out .= '</table>'."\n";
}
if (isset($gmeta['var']) && count($gmeta['var'])) {
foreach ($gmeta['var'] as $gkey=>$gval) {
- $out .= '<p class="gvar"><span class="gkey">'.$gkey.': </span>'.$gval.'</p>';
+ $out .= '<p class="gvar"><span class="gkey">'.$gkey.': </span>'.$gval.'</p>'."\n";
}
}
if (isset($gmeta['info']) && count($gmeta['info'])) {
foreach ($gmeta['info'] as $gval) {
- $out .= '<p class="ginfo">'.$gval.'</p>';
+ $out .= '<p class="ginfo">'.$gval.'</p>'."\n";
}
}
- $out .= '</div>';
+ $out .= '</div>'."\n";
}
if ($gmeta['legends_long'] && (!isset($pconf['show_legend']) || $pconf['show_legend'])) {
- $out .= '<div class="legend">';
- $out .= '<p>'.$ltitle.'</p>';
- $out .= '<table class="legend">';
+ $out .= '<div class="legend">'."\n";
+ $out .= '<p>'.$ltitle.'</p>'."\n";
+ $out .= '<table class="legend">'."\n";
foreach ($gmeta['legend'] as $field=>$legend) {
if (strlen($legend['desc_long'])) {
$out .= '<tr><th';
}
$out .= '>'.$field.'</th>';
$out .= '<td>'.$legend['desc_long'].'</td>';
- $out .= '</tr>';
+ $out .= '</tr>'."\n";
}
}
- $out .= '</table>';
- $out .= '</div>';
+ $out .= '</table>'."\n";
+ $out .= '</div>'."\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 .= '</body></html>';
+ $out .= '</body></html>'."\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();
return $stats;
}
- function h_page_footer() {
+ private function h_page_footer() {
// return generic page footer
$out = '<p class="footer">';
$out .= sprintf(dgettext($this->mod_textdomain, 'Statistics created with %s using a library created by %s.'),
- '<a href="http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/">RRDtool</a>',
+ '<a href="http://oss.oetiker.ch/rrdtool/">RRDtool</a>',
'<a href="http://www.kairo.at/">KaiRo.at</a>');
- $out .= '</p>';
+ $out .= '</p>'."\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;
+ }
}
?>
projects / php-utility-classes.git / blobdiff