From: Bruno Prémont <bonbons@linux-vserver.org>
Date: Sun, 1 Mar 2009 21:20:06 +0000 (+0100)
Subject: php-collection/functions.php: Escape/avoid problematic characters in RRD commandline
X-Git-Tag: collectd-4.6.2~5^2~11^2~1
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=d224ff4d51d564910eba4fe88516cd604ea00620;p=collectd.git

php-collection/functions.php: Escape/avoid problematic characters in RRD commandline

php-collection/functions.php: Escape/avoid problematic characters in RRD commandline

rrdtool does not like '!' in variable names so replace them with '_'.
(bind plugin has them in a few type-instances and type-instance is used
as variable name by MetaGraphs)
Also escape rrdtool field seperators that might appear in file names.

Signed-off-by: Florian Forster <octo@huhu.verplant.org>
---

diff --git a/contrib/php-collection/functions.php b/contrib/php-collection/functions.php
index cb916abe..f555751a 100644
--- a/contrib/php-collection/functions.php
+++ b/contrib/php-collection/functions.php
@@ -374,6 +374,10 @@ function rrd_strip_quotes($str) {
 		return $str;
 }
 
+function rrd_escape($str) {
+	return str_replace(array('\\', ':'), array('\\\\', '\\:'), $str);
+}
+
 /**
  * Determine useful information about RRD file
  * @file Name of RRD file to analyse
@@ -495,11 +499,11 @@ function collectd_draw_rrd($host, $plugin, $pinst = null, $type, $tinst = null,
 		if (strlen($k) > $l_max)
 			$l_max = strlen($k);
 		if ($has_min)
-			$graph[] = sprintf('DEF:%s_min=%s:%s:MIN', $k, $rrdinfo['filename'], $k);
+			$graph[] = sprintf('DEF:%s_min=%s:%s:MIN', $k, rrd_escape($rrdinfo['filename']), $k);
 		if ($has_avg)
-			$graph[] = sprintf('DEF:%s_avg=%s:%s:AVERAGE', $k, $rrdinfo['filename'], $k);
+			$graph[] = sprintf('DEF:%s_avg=%s:%s:AVERAGE', $k, rrd_escape($rrdinfo['filename']), $k);
 		if ($has_max)
-			$graph[] = sprintf('DEF:%s_max=%s:%s:MAX', $k, $rrdinfo['filename'], $k);
+			$graph[] = sprintf('DEF:%s_max=%s:%s:MAX', $k, rrd_escape($rrdinfo['filename']), $k);
 	}
 	if ($has_min && $has_max || $has_min && $has_avg || $has_avg && $has_max) {
 		$n = 1;
@@ -571,7 +575,7 @@ function collectd_draw_generic($timespan, $host, $plugin, $pinst = null, $type,
 			continue;
 
 		$file = str_replace(":", "\\:", $file);
-		$rrd_args = str_replace('{file}', $file, $rrd_args);
+		$rrd_args = str_replace('{file}', rrd_escape($file), $rrd_args);
 
 		$rrdgraph = array_merge($rrd_cmd, $rrd_args);
 		$cmd = RRDTOOL;
@@ -612,7 +616,7 @@ function collectd_draw_meta_stack(&$opts, &$sources) {
 	$max_inst_name = 0;
 
 	foreach($sources as &$inst_data) {
-		$inst_name = $inst_data['name'];
+		$inst_name = str_replace('!', '_', $inst_data['name']);
 		$file      = $inst_data['file'];
 		$ds        = isset($inst_data['ds']) ? $inst_data['ds'] : 'value';
 
@@ -622,9 +626,9 @@ function collectd_draw_meta_stack(&$opts, &$sources) {
 		if (!is_file($file))
 			continue;
 
-		$cmd[] = 'DEF:'.$inst_name.'_min='.$file.':'.$ds.':MIN';
-		$cmd[] = 'DEF:'.$inst_name.'_avg='.$file.':'.$ds.':AVERAGE';
-		$cmd[] = 'DEF:'.$inst_name.'_max='.$file.':'.$ds.':MAX';
+		$cmd[] = 'DEF:'.$inst_name.'_min='.rrd_escape($file).':'.$ds.':MIN';
+		$cmd[] = 'DEF:'.$inst_name.'_avg='.rrd_escape($file).':'.$ds.':AVERAGE';
+		$cmd[] = 'DEF:'.$inst_name.'_max='.rrd_escape($file).':'.$ds.':MAX';
 		$cmd[] = 'CDEF:'.$inst_name.'_nnl='.$inst_name.'_avg,UN,0,'.$inst_name.'_avg,IF';
 	}
 	$inst_data = end($sources);
@@ -633,16 +637,16 @@ function collectd_draw_meta_stack(&$opts, &$sources) {
 
 	$inst_data1 = end($sources);
 	while (($inst_data0 = prev($sources)) !== false) {
-		$inst_name0 = $inst_data0['name'];
-		$inst_name1 = $inst_data1['name'];
+		$inst_name0 = str_replace('!', '_', $inst_data0['name']);
+		$inst_name1 = str_replace('!', '_', $inst_data1['name']);
 
 		$cmd[] = 'CDEF:'.$inst_name0.'_stk='.$inst_name0.'_nnl,'.$inst_name1.'_stk,+';
 		$inst_data1 = $inst_data0;
 	}
 
 	foreach($sources as &$inst_data) {
-		$inst_name = $inst_data['name'];
-		$legend = sprintf('%s', $inst_name);
+		$inst_name = str_replace('!', '_', $inst_data['name']);
+		$legend = sprintf('%s', $inst_data['name']);
 		while (strlen($legend) < $max_inst_name)
 			$legend .= ' ';
 		$number_format = isset($opts['number_format']) ? $opts['number_format'] : '%6.1lf';
@@ -699,7 +703,7 @@ function collectd_draw_meta_line(&$opts, &$sources) {
 	$max_inst_name = 0;
 
 	foreach ($sources as &$inst_data) {
-		$inst_name = $inst_data['name'];
+		$inst_name = str_replace('!', '_', $inst_data['name']);
 		$file      = $inst_data['file'];
 		$ds        = isset($inst_data['ds']) ? $inst_data['ds'] : 'value';
 
@@ -709,13 +713,13 @@ function collectd_draw_meta_line(&$opts, &$sources) {
 		if (!is_file($file))
 			continue;
 
-		$cmd[] = 'DEF:'.$inst_name.'_min='.$file.':'.$ds.':MIN';
-		$cmd[] = 'DEF:'.$inst_name.'_avg='.$file.':'.$ds.':AVERAGE';
-		$cmd[] = 'DEF:'.$inst_name.'_max='.$file.':'.$ds.':MAX';
+		$cmd[] = 'DEF:'.$inst_name.'_min='.rrd_escape($file).':'.$ds.':MIN';
+		$cmd[] = 'DEF:'.$inst_name.'_avg='.rrd_escape($file).':'.$ds.':AVERAGE';
+		$cmd[] = 'DEF:'.$inst_name.'_max='.rrd_escape($file).':'.$ds.':MAX';
 	}
 
 	foreach ($sources as &$inst_data) {
-		$inst_name = $inst_data['name'];
+		$inst_name = str_replace('!', '_', $inst_data['name']);
 		$legend = sprintf('%s', $inst_name);
 		while (strlen($legend) < $max_inst_name)
 			$legend .= ' ';