use 400 slices for all stats by default. fixes month view showing too big slices...
[php-utility-classes.git] / include / classes / rrdstat.php-class
index eff225551f27124b3ccaeeeff5c31084d0e00552..590fc3c98de8b302e3f52d5a71307b5b7eb549b1 100644 (file)
@@ -485,31 +485,32 @@ class rrdstat {
     $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';
@@ -519,62 +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($ds['desc'])) { $grow['desc'] = $ds['desc']; }
+        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;
       }
     }
@@ -625,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'; }
@@ -675,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; }
@@ -690,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];
       }
@@ -831,7 +868,7 @@ 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);
 
@@ -851,9 +888,9 @@ class rrdstat {
         $idx = $col * $num_rows + $row;
         $out .= '<td>';
         if ($idx < count($stats)) {
-          list($sname, $s_psub) = explode('|', $stats[$idx]['name'], 2);
+          @list($sname, $s_psub) = explode('|', $stats[$idx]['name'], 2);
           $s_psname = 'page'.(isset($s_psub)?'.'.$s_psub:'');
-          $g_sub = $this->config_all[$sname][$s_psname]['graph_sub'];
+          $g_sub = @$this->config_all[$sname][$s_psname]['graph_sub'];
 
           if (isset($this->config_all[$sname][$s_psname]['title_page'])) {
             $s_ptitle = $this->config_all[$sname][$s_psname]['title_page'];
@@ -862,7 +899,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>';
@@ -883,7 +920,7 @@ class rrdstat {
             }
             $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_pub:'', $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"';
@@ -918,6 +955,7 @@ class rrdstat {
     $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>';
@@ -927,8 +965,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']; }
@@ -937,6 +978,7 @@ 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">';
       if (is_null($this->last_update())) { $up_time = dgettext($td, 'unknown'); }
@@ -966,10 +1008,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>';
             }
@@ -989,6 +1040,28 @@ 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 .= sprintf(dgettext($td, 'RRD error: status is "%s"'), $this->status);