<?php
-// ************ RRD status class **************
+/* ***** BEGIN LICENSE BLOCK *****
+ *
+ * The contents of this file are subject to Austrian copyright reegulations
+ * ("Urheberrecht"); you may not use this file except in compliance with
+ * those laws.
+ * This contents and any derived work, if it gets distributed in any way,
+ * is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND,
+ * either express or implied.
+ *
+ * The Original Code is KaiRo's RRD statistics class.
+ *
+ * The Initial Developer of the Original Code is
+ * KaiRo - Robert Kaiser.
+ * Portions created by the Initial Developer are Copyright (C) 2005
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s): Robert Kaiser <kairo@kairo.at>
+ *
+ * ***** END LICENSE BLOCK ***** */
+
class rrdstat {
+ // rrdstat PHP class
+ // rrdtool statistics functions
+ //
+ // function rrdstat($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
+ // RRD file name
+ //
+ // var $basename
+ // base name for this RRD (usually file name without .rrd)
+ //
+ // var $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
+ // complete, raw configuration array set
+ //
+ // var $config_raw
+ // configuration array set for current RRD
+ //
+ // var $config_graph
+ // configuration array set for default graph in this RRD
+ //
+ // var $config_page
+ // configuration array set for default page in this RRD
+ //
+ // var $rrd_fields
+ // definition of this RRD's fields
+ //
+ // var $rra_base
+ // definition of this RRD's base RRAs
+ //
+ // var $rrd_step
+ // basic stepping of this RRD in seconds (default: 300)
+ //
+ // var $rra_add_max
+ // should RRAs for MAX be added for every base RRA? (bool, default: true)
+ //
+ // var $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
+ // GNU gettext domain for this module
+ //
+ // function set_def($rrdconfig, [$conf_id])
+ // set definitions based on given configuration
+ // [intended for internal use, called by the constructor]
+ //
+ // function create()
+ // create RRD file according to set config
+ //
+ // 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)
+ // 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()
+ // fetch time of last update in this RRD file
+ //
+ // 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])
+ // create a RRD graph (see above) and return meta info as a ready-to-use array
+ //
+ // 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])
+ // 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)
+ // 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])
+ // 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])
+ // 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)
+ // 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()
+ // return generic page footer
+ // [intended for internal use, called by page_*()]
+ //
+ // 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;
var $config_all = null;
var $config_raw = null;
var $status = 'unused';
+ var $mod_textdomain;
+
function rrdstat($rrdconfig, $conf_id = null) {
// ***** init RRD stat module *****
+ $this->mod_textdomain = 'class_rrdstat';
+ $mod_charset = 'iso-8859-15';
+
+ bindtextdomain($this->mod_textdomain, class_exists('baseutils')?baseutils::getDir('locale'):'locale/');
+ bind_textdomain_codeset($this->mod_textdomain, $mod_charset);
+
$this->set_def($rrdconfig, $conf_id);
if (($this->status == 'unused') && !is_null($this->rrd_file)) {
$iinfo = $complete_conf;
}
+ if (isset($iinfo['path']) && strlen($iinfo['path'])) {
+ $this->basedir = $iinfo['path'];
+ if (substr($this->basedir, -1) != '/') { $this->basedir .= '/'; }
+ }
+
if (isset($iinfo['graph-only']) && $iinfo['graph-only'] && !is_null($conf_id)) {
$this->basename = $conf_id;
$this->status = 'graphonly';
}
elseif (isset($iinfo['file'])) {
- $this->rrd_file = $iinfo['file'];
- $this->basename = (substr($this->rrd_file, -4) == '.rrd')?substr($this->rrd_file, 0, -4):$this->rrd_file;
+ $this->rrd_file = (($iinfo['file']{0} != '/')?$this->basedir:'').$iinfo['file'];
+ $this->basename = basename((substr($this->rrd_file, -4) == '.rrd')?substr($this->rrd_file, 0, -4):$this->rrd_file);
+ }
+ elseif (!is_null($conf_id) && file_exists($conf_id.'.rrd')) {
+ $this->rrd_file = (($iinfo['file']{0} != '/')?$this->basedir:'').$conf_id.'.rrd';
+ $this->basename = $conf_id;
}
else {
$this->basename = !is_null($conf_id)?$conf_id:'xxx.unknown';
}
- if (isset($iinfo['file'])) {
+ if (!is_null($this->rrd_file)) {
// fields (data sources, DS)
// name - DS name
// type - one of COUNTER, GAUGE, DERIVE, ABSOLUTE
function update($upArray = null) {
// feed new data into RRD
- if ($this->status != 'ok') { trigger_error('Cannot update non-writeable file', E_USER_WARNING); return 1; }
+ if ($this->status != 'ok') { trigger_error('Cannot update non-writeable file', E_USER_WARNING); return false; }
$upvals = array();
if (isset($this->config_raw['update'])) {
- $evalcode = $this->config_raw['update'];
- if (!is_null($evalcode)) {
- ob_start();
- eval($evalcode);
- $ret = ob_get_contents();
- if (strlen($ret)) { $upvals = explode("\n", $ret); }
- ob_end_clean();
+ if (preg_match('/^\s*function\s+{(.*)}\s*$/is', $this->config_raw['update'], $regs)) {
+ $upfunc = create_function('', $regs[1]);
+ $upvals = $upfunc();
+ }
+ else {
+ $evalcode = $this->config_raw['update'];
+ if (!is_null($evalcode)) {
+ ob_start();
+ eval($evalcode);
+ $ret = ob_get_contents();
+ if (strlen($ret)) { $upvals = explode("\n", $ret); }
+ ob_end_clean();
+ }
}
- $walkfunc = create_function('&$val,$key', '$val = is_numeric(trim($val))?trim($val):"U";');
- array_walk($upvals, $walkfunc);
}
else {
foreach ($this->rrd_fields as $ds) {
elseif (isset($ds['update'])) {
$val = null; $evalcode = null;
if (substr($ds['update'], 0, 4) == 'val:') {
- $evalcode = 'print(trim('.substr($ds['update'], 4).'));';
+ $evalcode = 'function { return trim('.substr($ds['update'], 4).')); }';
}
elseif (substr($ds['update'], 0, 8) == 'snmp-if:') {
$snmphost = 'localhost'; $snmpcomm = 'public';
if ($valtype == 'in') { $oid = '1.3.6.1.2.1.2.2.1.10.'.$ifnr; }
elseif ($valtype == 'out') { $oid = '1.3.6.1.2.1.2.2.1.16.'.$ifnr; }
if (!is_null($ifnr) && !is_null($oid)) {
- $evalcode = 'print(trim(substr(strrchr(`snmpget -v2c -c '.$snmpcomm.' '.$snmphost.' '.$oid.'`,":"),1)));';
+ $evalcode = 'function { return trim(substr(strrchr(`snmpget -v2c -c '.$snmpcomm.' '.$snmphost.' '.$oid.'`,":"),1)); }';
}
}
else { $evalcode = $ds['update']; }
- if (!is_null($evalcode)) {
+ if (preg_match('/^\s*function\s+{(.*)}\s*$/is', $evalcode, $regs)) {
+ $upfunc = create_function('', $regs[1]);
+ $val = $upfunc();
+ }
+ elseif (!is_null($evalcode)) {
ob_start();
eval($evalcode);
$val = ob_get_contents();
}
}
else { $val = null; }
- $upvals[] = is_null($val)?'U':$val;
+ $upvals[$ds['name']] = $val;
}
}
+ $key_names = (!is_numeric(array_shift(array_keys($upvals))));
+ if (in_array('L', $upvals, true)) {
+ // for at least one value, we need to set the same as the last recorded value
+ $fvals = $this->fetch();
+ $rowids = array_shift($fvals);
+ $lastvals = array_shift($fvals);
+ foreach (array_keys($upvals, 'L') as $akey) {
+ $upvals[$akey] = $key_names?$lastvals[$akey]:$lastvals[$rowids[$akey]];
+ }
+ }
+ $walkfunc = create_function('&$val,$key', '$val = is_numeric(trim($val))?trim($val):"U";');
+ array_walk($upvals, $walkfunc);
$return = null;
if (count($upvals)) {
- $update_cmd = 'rrdtool update '.$this->rrd_file.' 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`;
}
$success = false;
}
else { $success = true; }
- return ($return_var == 0);
+ return $success;
}
function fetch($cf = 'AVERAGE', $resolution = null, $start = null, $end = null) {
foreach ($rows as $row) {
if (strlen(trim($row))) {
$rvals = preg_split('/\s+/', $row);
- $rtime = array_shift($rvals);
+ $rtime = str_replace(':', '', array_shift($rvals));
$rv_array = array();
foreach ($rvals as $key=>$rval) {
$rv_array[$fields[$key]] = ($rval=='nan')?null:floatval($rval);
$fname = str_replace('%t', $timeframe, $fname);
$fname = str_replace('%f', $fmt_ext, $fname);
if (substr($fname, -strlen($fmt_ext)) != $fmt_ext) { $fname .= $fmt_ext; }
- if (isset($gconf['path'])) { $fname = $gconf['path'].'/'.$fname; }
+ if (isset($gconf['path']) && ($fname{0} != '/')) { $fname = $gconf['path'].'/'.$fname; }
+ if ($fname{0} != '/') { $fname = $this->basedir.$fname; }
$fname = str_replace('//', '/', $fname);
- $graphrows = array(); $gC = 0;
+ $graphrows = array(); $specialrows = array(); $gC = 0;
$gDefs = ''; $gGraphs = ''; $addSpecial = '';
if ($timeframe == 'day') {
$grow['legend'] = $ds['legend'];
if (!isset($gconf['show_legend'])) { $gconf['show_legend'] = true; }
}
+ if (isset($ds['desc'])) { $grow['desc'] = $ds['desc']; }
$graphrows[] = $grow;
}
}
$pconf = $pconf + (array)$this->config_page;
$return = null;
- switch ($pconf['type']) {
+ switch (@$pconf['type']) {
case 'index':
$return = $this->page_index($pconf);
break;
function page_index($pconf) {
// create a bare, very simple index list HTML page and return it in a string
-
- $ptitle = isset($pconf['title_page'])?$pconf['title_page']:'RRD statistics index';
+ $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 .= '<p class="intro">'.$pconf['text_intro'].'</p>';
}
elseif (!isset($pconf['text_intro'])) {
- $out .= '<p class="intro">The following RRD stats are available:</p>';
+ $out .= '<p class="intro">'.dgettext($td, 'The following RRD stats are available:').'</p>';
}
$stats = $this->h_page_statsArray($pconf);
+ if (isset($pconf['stats_url'])) { $sURL_base = $pconf['stats_url']; }
+ else { $sURL_base = '?stat=%i%a'; }
+
+ if (isset($pconf['stats_url_add'])) { $sURL_add = $pconf['stats_url_add']; }
+ else { $sURL_add = '&sub=%s'; }
+
$out .= '<ul class="indexlist">';
foreach ($stats as $stat) {
$out .= '<li'.(isset($stat['class'])?' class="'.$stat['class'].'"':'').'>';
- $surl = '?stat='.$stat['name'];
- $out .= '<a href="'.$surl.'">'.$stat['name'].'</a>';
+ $sURL = str_replace('%i', $stat['name'], $sURL_base);
+ $sURL = str_replace('%a', '', $sURL);
+ $sURL = str_replace('%s', '', $sURL);
+ $out .= '<a href="'.$sURL.'">'.$stat['name'].'</a>';
if (isset($stat['sub']) && count($stat['sub'])) {
$sprt = array();
- foreach ($stat['sub'] as $ssub) { $sprt[] = '<a href="'.$surl.'&sub='.$ssub.'">'.$ssub.'</a>'; }
+ foreach ($stat['sub'] as $ssub) {
+ $sURL = str_replace('%i', $stat['name'], $sURL_base);
+ $sURL = str_replace('%a', $sURL_add, $sURL);
+ $sURL = str_replace('%s', $ssub, $sURL);
+ $sprt[] = '<a href="'.$sURL.'">'.$ssub.'</a>';
+ }
$out .= ' <span="subs">('.implode(', ', $sprt).')</span>';
}
$out .= '</li>';
function page_overview($pconf, $graph_extras = null) {
// create an overview HTML page (including graphs) and return it in a string
-
- $ptitle = isset($pconf['title_page'])?$pconf['title_page']:'RRD statistics overview';
+ $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 .= '</a>';
}
else {
- $out .= 'RRD error: status is "'.$s_rrd->status.'"';
+ $out .= sprintf(dgettext($td, 'RRD error: status is "%s"'), $s_rrd->status);
}
}
else {
function page_simple($pconf, $graph_extras = null) {
// create a simple (MRTG-like) HTML page and return it in a string
+ $td = $this->mod_textdomain;
- $ptitle = isset($pconf['title_page'])?$pconf['title_page']:$this->basename.' - RRD statistics';
+ $ptitle = isset($pconf['title_page'])?$pconf['title_page']:sprintf(dgettext($td, '%s - RRD statistics'),$this->basename);
$gtitle = array();
- $gtitle['day'] = isset($pconf['title_day'])?$pconf['title_day']:'Day overview (scaling 5 minutes)';
- $gtitle['week'] = isset($pconf['title_week'])?$pconf['title_week']:'Week overview (scaling 30 minutes)';
- $gtitle['month'] = isset($pconf['title_month'])?$pconf['title_month']:'Month overview (scaling 2 hours)';
- $gtitle['year'] = isset($pconf['title_year'])?$pconf['title_year']:'Year overview (scaling 1 day)';
+ $gtitle['day'] = isset($pconf['title_day'])?$pconf['title_day']:dgettext($td, 'Day overview (scaling 5 minutes)');
+ $gtitle['week'] = isset($pconf['title_week'])?$pconf['title_week']:dgettext($td, 'Week overview (scaling 30 minutes)');
+ $gtitle['month'] = isset($pconf['title_month'])?$pconf['title_month']:dgettext($td, 'Month overview (scaling 2 hours)');
+ $gtitle['year'] = isset($pconf['title_year'])?$pconf['title_year']:dgettext($td, 'Year overview (scaling 1 day)');
$out = '<html><head>';
$out .= '<title>'.$ptitle.'</title>';
$out .= '<h1>'.$ptitle.'</h1>';
if (!isset($pconf['show_update']) || $pconf['show_update']) {
- $out .= '<p class="last_up">Last Update: '.(is_null($this->last_update())?'unknown':date('Y-m-d H:i:s', $this->last_update())).'</p>';
+ $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>';
}
$g_sub = isset($pconf['graph_sub'])?$pconf['graph_sub']:null;
$gmeta = $this->graph_plus($tframe, $g_sub, $graph_extras);
if (isset($pconf['graph_url'])) {
$gURL = $pconf['graph_url'];
- $fname = str_replace('%f', basename($gmeta['filename']), $gURL);
- $fname = str_replace('%p', $gmeta['filename'], $gURL);
+ $gURL = str_replace('%f', basename($gmeta['filename']), $gURL);
+ $gURL = str_replace('%p', $gmeta['filename'], $gURL);
if (substr($gURL, -1) == '/') { $gURL .= $gmeta['filename']; }
}
else {
$out .= '<h2>'.$gtitle[$tframe].'</h2>';
$out .= '<img src="'.$gURL.'"';
$out .= ' alt="'.$this->basename.(!is_null($g_sub)?' - '.$g_sub:'').' - '.$tframe.'" class="rrdgraph"';
- $out .= ' style="width:'.$gmeta['width'].'px;height:'.$gmeta['height'].'px;">';
+ if (isset($gmeta['width']) && isset($gmeta['height'])) { $out .= ' style="width:'.$gmeta['width'].'px;height:'.$gmeta['height'].'px;"'; }
+ $out .= '>';
if (isset($gmeta['data']) && count($gmeta['data'])) {
$out .= '<table class="gdata">';
foreach ($gmeta['data'] as $field=>$gdata) {
}
}
else {
- $out .= 'RRD error: status is "'.$this->status.'"';
+ $out .= sprintf(dgettext($td, 'RRD error: status is "%s"'), $this->status);
}
$out .= $this->h_page_footer();
function h_page_footer() {
// return generic page footer
$out = '<p class="footer">';
- $out .= 'Statistics created by <a href="http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/">RRDtool</a>';
- $out .= ' using a library created by <a href="http://www.kairo.at/">KaiRo.at</a>.';
+ $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://www.kairo.at/">KaiRo.at</a>');
$out .= '</p>';
return $out;
}
projects / php-utility-classes.git / blobdiff