make some additional scaling options available (logarithmic, claculated ranges);...
[php-utility-classes.git] / include / classes / rrdstat.php-class
index ea32b5276821c585c79a613eb691aff1ed2dbb7c..2593e758ff3ca206490df57cb39079d03f2ada44 100644 (file)
@@ -68,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]
@@ -146,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)) {
@@ -532,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'];
@@ -539,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;
         }
       }
@@ -564,6 +577,7 @@ class rrdstat {
           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;
       }
     }
@@ -591,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');
         }
       }
     }
@@ -613,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'; }
@@ -663,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; }
@@ -678,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];
       }
@@ -739,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 = '<html><head>';
     $out .= '<title>'.$ptitle.'</title>';
@@ -761,7 +793,7 @@ class rrdstat {
       $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);
@@ -800,8 +832,8 @@ class rrdstat {
 
   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>';
@@ -819,10 +851,16 @@ class rrdstat {
     $out .= '<body>';
 
     $out .= '<h1>'.$ptitle.'</h1>';
-    if (isset($pconf['text_intro'])) { $out .= '<p class="intro">'.$pconf['text_intro'].'</p>'; }
+    if (isset($pconf['text_intro']) && strlen($pconf['text_intro'])) { $out .= '<p class="intro">'.$pconf['text_intro'].'</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'; }
+
     $num_rows = is_numeric($pconf['num_rows'])?$pconf['num_rows']:2;
     $num_cols = ceil(count($stats)/$num_rows);
 
@@ -844,7 +882,7 @@ class rrdstat {
             $s_ptitle = $this->config_all[$sname]['page']['title_page'];
           }
           else {
-            $s_ptitle = $sname.(isset($s_psub)?' ('.$s_psub.')':'').' statistics';
+            $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>';
@@ -856,21 +894,24 @@ class rrdstat {
             $gmeta = $s_rrd->graph_plus($tframe, $g_sub);
             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 {
               $gURL = $gmeta['filename'];
             }
-            $out .= '<a href="?stat='.$sname.(isset($s_psub)?'&sub='.$s_psub:'').'"';
+            $sURL = str_replace('%i', $sname, $sURL_base);
+            $sURL = str_replace('%a', isset($s_psub)?$sURL_add:'', $sURL);
+            $sURL = str_replace('%s', isset($s_psub)?$s_psub:'', $sURL);
+            $out .= '<a href="'.$sURL.'">';
             $out .= '<img src="'.$gURL.'"';
             $out .= ' alt="'.$s_rrd->basename.(!is_null($g_sub)?' - '.$g_sub:'').' - '.$tframe.'" class="rrdgraph"';
-            $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>';
           }
           else {
-            $out .= 'RRD error: status is "'.$s_rrd->status.'"';
+            $out .= sprintf(dgettext($td, 'RRD error: status is "%s"'), $s_rrd->status);
           }
         }
         else {
@@ -889,13 +930,15 @@ class rrdstat {
 
   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)');
+    $ltitle = isset($pconf['title_legend'])?$pconf['title_legend']:dgettext($td, 'Legend:');
 
     $out = '<html><head>';
     $out .= '<title>'.$ptitle.'</title>';
@@ -905,8 +948,11 @@ class rrdstat {
       $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 { border: 1px solid gray; border-collapse: collapse; }';
-      $out .= 'table.gdata td, table.gdata th { border: 1px solid gray; padding: 0.1em 0.2em; }';
+      $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; }';
     }
     if (isset($pconf['style'])) { $out .= $pconf['style']; }
@@ -915,8 +961,14 @@ class rrdstat {
     $out .= '<body>';
 
     $out .= '<h1>'.$ptitle.'</h1>';
+    if (isset($pconf['text_intro']) && strlen($pconf['text_intro'])) { $out .= '<p class="intro">'.$pconf['text_intro'].'</p>'; }
     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;
@@ -939,10 +991,19 @@ class rrdstat {
         $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['data']) && count($gmeta['data'])) {
           $out .= '<table class="gdata">';
           foreach ($gmeta['data'] as $field=>$gdata) {
-            $out .= '<tr><th>'.$field.'</th>';
+            $out .= '<tr><th';
+            if ($colorize_data && isset($gmeta['legend'][$field])) {
+              $out .= ' style="color:'.$gmeta['legend'][$field]['color'].';';
+              if (strlen($gmeta['legend'][$field]['color_bg'])) {
+                $out .= 'background-color:'.$gmeta['legend'][$field]['color_bg'].';';
+              }
+              $out .= '"';
+            }
+            $out .= '>'.$field.'</th>';
             foreach ($gdata as $gkey=>$gval) {
               $out .= '<td><span class="gkey">'.$gkey.': </span>'.$gval.'</td>';
             }
@@ -962,9 +1023,31 @@ class rrdstat {
         }
         $out .= '</div>';
       }
+      if ($gmeta['legends_long'] && (!isset($pconf['show_legend']) || $pconf['show_legend'])) {
+        $out .= '<div class="legend">';
+        $out .= '<p>'.$ltitle.'</p>';
+        $out .= '<table class="legend">';
+        foreach ($gmeta['legend'] as $field=>$legend) {
+          if (strlen($legend['desc_long'])) {
+            $out .= '<tr><th';
+            if ($colorize_data && isset($gmeta['legend'][$field])) {
+              $out .= ' style="color:'.$gmeta['legend'][$field]['color'].';';
+              if (strlen($gmeta['legend'][$field]['color_bg'])) {
+                $out .= 'background-color:'.$gmeta['legend'][$field]['color_bg'].';';
+              }
+              $out .= '"';
+            }
+            $out .= '>'.$field.'</th>';
+            $out .= '<td>'.$legend['desc_long'].'</td>';
+            $out .= '</tr>';
+          }
+        }
+        $out .= '</table>';
+        $out .= '</div>';
+      }
     }
     else {
-      $out .= 'RRD error: status is "'.$this->status.'"';
+      $out .= sprintf(dgettext($td, 'RRD error: status is "%s"'), $this->status);
     }
 
     $out .= $this->h_page_footer();
@@ -1015,8 +1098,9 @@ class rrdstat {
   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;
   }