X-Git-Url: https://git-public.kairo.at/?p=php-utility-classes.git;a=blobdiff_plain;f=include%2Fclasses%2Frrdstat.php-class;h=2593e758ff3ca206490df57cb39079d03f2ada44;hp=ff144456b2103bd05cc17c041443600b7510f21c;hb=d6ad10a5002de85419858a9881bc46835946c5c0;hpb=75124b94e74fb301e2d09d25c7e3b8b2564d42e0 diff --git a/include/classes/rrdstat.php-class b/include/classes/rrdstat.php-class index ff14445..2593e75 100644 --- a/include/classes/rrdstat.php-class +++ b/include/classes/rrdstat.php-class @@ -1,9 +1,141 @@ + * + * ***** 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; @@ -17,8 +149,16 @@ class rrdstat { 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)) { @@ -60,19 +200,28 @@ class rrdstat { $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 @@ -158,19 +307,23 @@ class rrdstat { 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) { @@ -178,7 +331,7 @@ class rrdstat { 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'; @@ -192,11 +345,15 @@ class rrdstat { 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(); @@ -204,12 +361,24 @@ class rrdstat { } } 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`; } @@ -218,7 +387,7 @@ class rrdstat { $success = false; } else { $success = true; } - return ($return_var == 0); + return $success; } function fetch($cf = 'AVERAGE', $resolution = null, $start = null, $end = null) { @@ -250,7 +419,7 @@ class rrdstat { 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); @@ -309,10 +478,11 @@ class rrdstat { $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') { @@ -373,6 +543,7 @@ class rrdstat { } $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']; @@ -380,6 +551,7 @@ class rrdstat { } 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; } } @@ -404,6 +576,8 @@ class rrdstat { $grow['legend'] = $ds['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']; } $graphrows[] = $grow; } } @@ -431,15 +605,16 @@ class rrdstat { } } else { + $td = $this->mod_textdomain; 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.'|Maximum|%.2lf%s'); - $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'AVERAGE', 'text'=>$textprefix.'|Average|%.2lf%s'); - $specialrows[] = array('sType'=>'PRINT', 'name'=>$grow['name'], 'cf'=>'LAST', 'text'=>$textprefix.'|Current|%.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'); } } } @@ -453,11 +628,15 @@ 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'; } @@ -503,13 +682,21 @@ class rrdstat { trigger_error($this->rrd_file.' - rrd graph error: '.$return, E_USER_WARNING); $return = $graph_cmd."\n\n".$return; } - $return = 'file:'.$fname."\n".$return; + $legendlines = ''; + foreach ($graphrows as $grow) { + $legendline = isset($grow['desc'])?$grow['desc']:(isset($grow['legend'])?$grow['legend']:$grow['name']); + $legendline .= '|'.$grow['color']; + $legendline .= '|'.(isset($grow['color_bg'])?$grow['color_bg']:''); + $legendline .= '|'.(isset($grow['legend_long'])?$grow['legend_long']:''); + $legendlines .= 'legend:'.$legendline."\n"; + } + $return = 'file:'.$fname."\n".$legendlines.$return; return $return; } 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); + $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; } @@ -518,6 +705,11 @@ class rrdstat { if (preg_match('/^file:(.+)$/', $gline, $regs)) { $gmeta['filename'] = $regs[1]; } + 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; } + } elseif (preg_match('/^(\d+)x(\d+)$/', $gline, $regs)) { $gmeta['width'] = $regs[1]; $gmeta['height'] = $regs[2]; } @@ -548,7 +740,7 @@ class rrdstat { $pconf = $pconf + (array)$this->config_page; $return = null; - switch ($pconf['type']) { + switch (@$pconf['type']) { case 'index': $return = $this->page_index($pconf); break; @@ -579,8 +771,8 @@ class rrdstat { 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 = ''; $out .= ''.$ptitle.''; @@ -601,19 +793,32 @@ class rrdstat { $out .= '

'.$pconf['text_intro'].'

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

The following RRD stats are available:

'; + $out .= '

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

'; } $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 .= '