Bug Fix League\Csv

- bug fix stream filter thephpleague#72
- improve public API by deprecating (get|set)EncodingFrom

Author: nyamsprod

CHANGELOG.md

@@ -2,6 +2,26 @@
 
 All Notable changes to `Csv` will be documented in this file
 
+## Next - 2016-xx-xx
+
+### Added
+
+- `Ouput::getInputEncoding`
+- `Ouput::setInputEncoding`
+
+### Deprecated
+
+- `Ouput::getEncodingFrom` replaced by `Ouput::getInputEncoding`
+- `Ouput::setEncodingFrom` replaced by `Ouput::setInputEncoding`
+
+### Fixed
+
+- Stream Filters are now url encoded before usage [issue #72](https://github.com/thephpleague/csv/issues/72)
+
+### Removed
+
+- None
+
 ## 8.0.0 - 2015-12-11
 
 ### Added

src/AbstractCsv.php

@@ -190,7 +190,7 @@ protected function newInstance($class, $open_mode)
         $csv->delimiter = $this->delimiter;
         $csv->enclosure = $this->enclosure;
         $csv->escape = $this->escape;
-        $csv->encodingFrom = $this->encodingFrom;
+        $csv->input_encoding = $this->input_encoding;
         $csv->input_bom = $this->input_bom;
         $csv->output_bom = $this->output_bom;
         $csv->newline = $this->newline;

src/Config/Output.php

@@ -33,7 +33,7 @@ trait Output
      *
      * @var string
      */
-    protected $encodingFrom = 'UTF-8';
+    protected $input_encoding = 'UTF-8';
 
     /**
      * The Input file BOM character
@@ -54,26 +54,56 @@ trait Output
      *
      * @return static
      */
-    public function setEncodingFrom($str)
+    public function setInputEncoding($str)
     {
         $str = str_replace('_', '-', $str);
         $str = filter_var($str, FILTER_SANITIZE_STRING, ['flags' => FILTER_FLAG_STRIP_LOW | FILTER_FLAG_STRIP_HIGH]);
         if (empty($str)) {
             throw new InvalidArgumentException('you should use a valid charset');
         }
-        $this->encodingFrom = strtoupper($str);
+        $this->input_encoding = strtoupper($str);
 
         return $this;
     }
 
+    /**
+     * Sets the CSV encoding charset
+     *
+     * DEPRECATION WARNING! This method will be removed in the next major point release
+     *
+     * @deprecated deprecated since version 4.1
+     *
+     * @param string $str
+     *
+     * @return static
+     */
+    public function setEncodingFrom($str)
+    {
+        return $this->setInputEncoding($str);
+    }
+
+    /**
+     * Gets the source CSV encoding charset
+     *
+     * @return string
+     */
+    public function getInputEncoding()
+    {
+        return $this->input_encoding;
+    }
+
     /**
      * Gets the source CSV encoding charset
      *
+     * DEPRECATION WARNING! This method will be removed in the next major point release
+     *
+     * @deprecated deprecated since version 4.1
+     *
      * @return string
      */
     public function getEncodingFrom()
     {
-        return $this->encodingFrom;
+        return $this->input_encoding;
     }
 
     /**
@@ -219,12 +249,12 @@ abstract protected function getQueryIterator();
      */
     protected function convertToUtf8(Iterator $iterator)
     {
-        if (stripos($this->encodingFrom, 'UTF-8') !== false) {
+        if (stripos($this->input_encoding, 'UTF-8') !== false) {
             return $iterator;
         }
 
         $convertCell = function ($value) {
-            return mb_convert_encoding($value, 'UTF-8', $this->encodingFrom);
+            return mb_convert_encoding($value, 'UTF-8', $this->input_encoding);
         };
 
         $convertRow = function (array $row) use ($convertCell) {

src/Modifier/StreamFilter.php

@@ -83,7 +83,7 @@ protected function initStreamFilter($path)
             return;
         }
         $this->stream_uri = $matches['resource'];
-        $this->stream_filters = explode('|', $matches['filters']);
+        $this->stream_filters = array_map('urldecode', explode('|', $matches['filters']));
         $this->stream_filter_mode = $this->fetchStreamModeAsInt($matches['mode']);
     }
 
@@ -209,7 +209,7 @@ protected function sanitizeStreamFilter($filter_name)
     {
         $this->assertStreamable();
 
-        return $this->validateString($filter_name);
+        return urldecode($this->validateString($filter_name));
     }
 
     /**
@@ -228,7 +228,7 @@ public function hasStreamFilter($filter_name)
     {
         $this->assertStreamable();
 
-        return false !== array_search($filter_name, $this->stream_filters, true);
+        return false !== array_search(urldecode($filter_name), $this->stream_filters, true);
     }
 
     /**
@@ -241,7 +241,7 @@ public function hasStreamFilter($filter_name)
     public function removeStreamFilter($filter_name)
     {
         $this->assertStreamable();
-        $res = array_search($filter_name, $this->stream_filters, true);
+        $res = array_search(urldecode($filter_name), $this->stream_filters, true);
         if (false !== $res) {
             unset($this->stream_filters[$res]);
         }
@@ -276,7 +276,7 @@ protected function getStreamFilterPath()
 
         return 'php://filter/'
             .$this->getStreamFilterPrefix()
-            .implode('|', $this->stream_filters)
+            .implode('|', array_map('urlencode', $this->stream_filters))
             .'/resource='.$this->stream_uri;
     }
 

test/StreamFilterTest.php

@@ -142,4 +142,11 @@ public function testSetStreamFilterWriterNewLine()
         $this->assertTrue($csv->hasStreamFilter(FilterReplace::FILTER_NAME."\r\n:\n"));
         $csv->insertOne([1, 'two', 3, "new\r\nline"]);
     }
+
+    public function testUrlEncodeFilterParameters()
+    {
+        $csv = Reader::createFromPath(__DIR__.'/data/foo.csv');
+        $csv->appendStreamFilter('convert.iconv.UTF-8/ASCII//TRANSLIT');
+        $this->assertCount(1, $csv->fetchAll());
+    }
 }