some small styling and L10n improvements
[php-utility-classes.git] / include / classes / rrdstat.php-class
index 5e8cc6659c92b68f849e72bd2800c0a39b554ebf..4eae8b60edad176fa541ddbf4cda5318696b1d32 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)) {
@@ -200,7 +211,7 @@ class rrdstat {
     }
     elseif (isset($iinfo['file'])) {
       $this->rrd_file = (($iinfo['file']{0} != '/')?$this->basedir:'').$iinfo['file'];
-      $this->basename = (substr($this->rrd_file, -4) == '.rrd')?substr($this->rrd_file, 0, -4):$this->rrd_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';
@@ -354,7 +365,7 @@ class rrdstat {
       }
     }
     $key_names = (!is_numeric(array_shift(array_keys($upvals))));
-    if (in_array('L', $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);
@@ -563,6 +574,7 @@ class rrdstat {
           $grow['legend'] = $ds['legend'];
           if (!isset($gconf['show_legend'])) { $gconf['show_legend'] = true; }
         }
+        if (isset($ds['desc'])) { $grow['desc'] = $ds['desc']; }
         $graphrows[] = $grow;
       }
     }
@@ -590,15 +602,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');
         }
       }
     }
@@ -707,7 +720,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;
@@ -738,8 +751,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>';
@@ -760,19 +773,32 @@ 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);
 
+    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>';
@@ -786,8 +812,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>';
@@ -809,6 +835,12 @@ class rrdstat {
 
     $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);
 
@@ -830,7 +862,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>';
@@ -842,21 +874,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_pub:'', $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 {
@@ -875,13 +910,14 @@ 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)');
 
     $out = '<html><head>';
     $out .= '<title>'.$ptitle.'</title>';
@@ -902,7 +938,12 @@ class rrdstat {
 
     $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;
@@ -911,8 +952,8 @@ class rrdstat {
         $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 {
@@ -923,7 +964,8 @@ class rrdstat {
         $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) {
@@ -949,7 +991,7 @@ class rrdstat {
       }
     }
     else {
-      $out .= 'RRD error: status is "'.$this->status.'"';
+      $out .= sprintf(dgettext($td, 'RRD error: status is "%s"'), $this->status);
     }
 
     $out .= $this->h_page_footer();
@@ -1000,8 +1042,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;
   }