Escape field values as per line protocol

Author: Joe Axon

src/InfluxDB/Point.php

@@ -82,10 +82,10 @@ public function __toString()
         $string = $this->measurement;
 
         if (count($this->tags) > 0) {
-            $string .=  ',' . $this->arrayToString($this->escapeCharacters($this->tags));
+            $string .=  ',' . $this->arrayToString($this->escapeTags($this->tags));
         }
 
-        $string .= ' ' . $this->arrayToString($this->escapeCharacters($this->fields));
+        $string .= ' ' . $this->arrayToString($this->escapeFields($this->fields));
 
         if ($this->timestamp) {
             $string .= ' '.$this->timestamp;
@@ -143,7 +143,7 @@ public function setFields($fields)
             if (is_integer($field)) {
                 $field = sprintf('%di', $field);
             } elseif (is_string($field)) {
-                $field = sprintf("\"%s\"", $field);
+                $field = $this->escapeFieldValue($field);
             } elseif (is_bool($field)) {
                 $field = ($field ? "true" : "false");
             }
@@ -174,7 +174,7 @@ public function setTimestamp($timestamp)
      * @param array $arr
      * @return array
      */
-    private function escapeCharacters(array $arr)
+    private function escapeTags(array $arr)
     {
         $returnArr = [];
 
@@ -185,6 +185,35 @@ private function escapeCharacters(array $arr)
         return $returnArr;
     }
 
+    /**
+     * Escapes invalid characters in field keys and values
+     *
+     * @param array $arr
+     * @return array
+     */
+    private function escapeFields(array $arr)
+    {
+        $returnArr = [];
+
+        foreach($arr as $key => $value) {
+            $returnArr[$this->addSlashes($key)] = $value;
+        }
+
+        return $returnArr;
+    }
+
+    /*
+     * Returns string double-quoted and double-quotes escaped per Influx write protocol syntax
+     *
+     * @param string $value
+     * @return string
+     */
+    private function escapeFieldValue($value)
+    {
+        $escapedValue = str_replace('"', '\"', $value);
+        return sprintf('"%s"', $escapedValue);
+    }
+
     /**
      * Returns strings with space, comma, or equals sign characters backslashed per Influx write protocol syntax
      *
@@ -244,7 +273,5 @@ private function isValidTimeStamp($timestamp)
         }
 
         return true;
-
-
     }
 }

tests/unit/PointTest.php

@@ -74,6 +74,15 @@ public function testGettersAndSetters()
 
     }
 
+    public function testFieldValueStringEscaping()
+    {
+        $expected = 'instance,host=server01,region=us-west spaces="string with spaces",doublequote="the \" is escaped"';
+        $point = $this->getPoint(null);
+
+        $point->setFields(['spaces' => 'string with spaces', 'doublequote' => 'the " is escaped']);
+
+        $this->assertEquals($expected, (string) $point);
+    }
 
     /**
      * Provide wrong timestamp value for testing.