X-Git-Url: https://git-public.kairo.at/?p=php-utility-classes.git;a=blobdiff_plain;f=include%2Fclasses%2Frrdstat.php-class;h=590fc3c98de8b302e3f52d5a71307b5b7eb549b1;hp=5c64af169d9836575b43780619418903b24a5fcf;hb=cd6b890ca05d547f326d7e17a66473f76d34f7b6;hpb=eb12543d81760361058d1f92d2002c5c97c2fe5b diff --git a/include/classes/rrdstat.php-class b/include/classes/rrdstat.php-class index 5c64af1..590fc3c 100644 --- a/include/classes/rrdstat.php-class +++ b/include/classes/rrdstat.php-class @@ -35,6 +35,10 @@ class rrdstat { // 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 // @@ -64,6 +68,9 @@ class rrdstat { // 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] @@ -128,6 +135,7 @@ class rrdstat { var $rrd_file = null; var $basename = null; + var $basedir = null; var $config_all = null; var $config_raw = null; @@ -141,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)) { @@ -184,16 +200,21 @@ 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 = $conf_id.'.rrd'; + $this->rrd_file = (($iinfo['file']{0} != '/')?$this->basedir:'').$conf_id.'.rrd'; $this->basename = $conf_id; } else { @@ -286,16 +307,22 @@ 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(); + } } } else { @@ -304,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'; @@ -318,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(); @@ -330,22 +361,24 @@ class rrdstat { } } else { $val = null; } + $upvals[$ds['name']] = $val; } } - if (in_array('L', $upvals)) { + $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] = $lastvals[$rowids[$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`; } @@ -354,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) { @@ -445,37 +478,39 @@ 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(); $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'; @@ -485,61 +520,81 @@ 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++]; - 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']; } - $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($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; } } @@ -567,15 +622,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'); } } } @@ -589,11 +645,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'; } @@ -639,13 +699,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; } @@ -654,6 +722,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]; } @@ -684,7 +757,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; @@ -715,8 +788,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.''; @@ -737,19 +810,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 .= '