[Yaml] deprecate dumping non UTF-8 strings

xabbuh · xabbuh · commit 333485678cdd · 2016-03-24T14:32:48.000+01:00
diff --git a/src/Symfony/Component/Yaml/Inline.php b/src/Symfony/Component/Yaml/Inline.php
@@ -203,6 +203,13 @@ public static function dump($value, $flags = 0)
                 return "''";
             case Yaml::DUMP_BASE64_BINARY_DATA & $flags && self::isBinaryString($value):
                 return '!!binary '.base64_encode($value);
+        }
+
+        if (self::isBinaryString($value)) {
+            @trigger_error('Dumping non UTF-8 data without passing the DUMP_BASE64_BINARY_DATA flag is deprecated since Symfony 3.1 and will be removed in 4.0.', E_USER_DEPRECATED);
+        }
+
+        switch (true) {
             case Escaper::requiresDoubleQuoting($value):
                 return Escaper::escapeWithDoubleQuotes($value);
             case Escaper::requiresSingleQuoting($value):
@@ -627,7 +634,7 @@ public static function evaluateBinaryScalar($scalar)
 
     private static function isBinaryString($value)
     {
-        return preg_match('/[^\x09-\x0d\x20-\xff]/', $value);
+        return !preg_match('//u', $value);
     }
 
     /**
diff --git a/src/Symfony/Component/Yaml/Tests/DumperTest.php b/src/Symfony/Component/Yaml/Tests/DumperTest.php
@@ -279,10 +279,26 @@ public function getEscapeSequences()
 
     public function testBinaryDataIsDumpedAsIsWithoutFlag()
     {
+        $deprecations = array();
+        set_error_handler(function ($type, $msg) use (&$deprecations) {
+            if (E_USER_DEPRECATED !== $type) {
+                restore_error_handler();
+
+                throw new \LogicException(sprintf('Unexpected error: "%s".', $msg));
+            }
+
+            $deprecations[] = $msg;
+        });
+
         $binaryData = file_get_contents(__DIR__.'/Fixtures/arrow.gif');
         $expected = "{ data: '".str_replace("'", "''", $binaryData)."' }";
+        $yaml = $this->dumper->dump(array('data' => $binaryData));
 
-        $this->assertSame($expected, $this->dumper->dump(array('data' => $binaryData)));
+        restore_error_handler();
+
+        $this->assertCount(1, $deprecations);
+        $this->assertSame('Dumping non UTF-8 data without passing the DUMP_BASE64_BINARY_DATA flag is deprecated since Symfony 3.1 and will be removed in 4.0.', $deprecations[0]);
+        $this->assertSame($expected, $yaml);
     }
 
     public function testBinaryDataIsDumpedBase64EncodedWithFlag()
@@ -293,6 +309,28 @@ public function testBinaryDataIsDumpedBase64EncodedWithFlag()
         $this->assertSame($expected, $this->dumper->dump(array('data' => $binaryData), 0, 0, Yaml::DUMP_BASE64_BINARY_DATA));
     }
 
+    public function testDumpingNonUtf8DataTriggersException()
+    {
+        $deprecations = array();
+        set_error_handler(function ($type, $msg) use (&$deprecations) {
+            if (E_USER_DEPRECATED !== $type) {
+                restore_error_handler();
+
+                throw new \LogicException(sprintf('Unexpected error: "%s".', $msg));
+            }
+
+            $deprecations[] = $msg;
+        });
+
+        // "für" (ISO-8859-1 encoded)
+        $this->dumper->dump("f\xc3\x3fr");
+
+        restore_error_handler();
+
+        $this->assertCount(1, $deprecations);
+        $this->assertSame('Dumping non UTF-8 data without passing the DUMP_BASE64_BINARY_DATA flag is deprecated since Symfony 3.1 and will be removed in 4.0.', $deprecations[0]);
+    }
+
     /**
      * @dataProvider objectAsMapProvider
      */
