symfony · dunglas · Oct 7, 2015 · Oct 7, 2015 · Oct 10, 2015 · Oct 10, 2015
diff --git a/src/Symfony/Component/Serializer/Normalizer/DataUriNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/DataUriNormalizer.php
@@ -0,0 +1,157 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Serializer\Normalizer;
+
+use Symfony\Component\HttpFoundation\File\File;
+use Symfony\Component\HttpFoundation\File\MimeType\MimeTypeGuesser;
+use Symfony\Component\HttpFoundation\File\MimeType\MimeTypeGuesserInterface;
+use Symfony\Component\Serializer\Exception\InvalidArgumentException;
+use Symfony\Component\Serializer\Exception\UnexpectedValueException;
+
+/**
+ * Normalizes an {@see \SplFileInfo} object to a data URI.
+ * Denormalizes a data URI to a {@see \SplFileObject} object.
+ *
+ * @author Kévin Dunglas <dunglas@gmail.com>
+ */
+class DataUriNormalizer implements NormalizerInterface, DenormalizerInterface
+{
+    /**
+     * @var MimeTypeGuesserInterface
+     */
+    private $mimeTypeGuesser;
+
+    public function __construct(MimeTypeGuesserInterface $mimeTypeGuesser = null)
+    {
+        if (null === $mimeTypeGuesser && class_exists('Symfony\Component\HttpFoundation\File\MimeType\MimeTypeGuesser')) {
+            $mimeTypeGuesser = MimeTypeGuesser::getInstance();
+        }
+
+        $this->mimeTypeGuesser = $mimeTypeGuesser;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function normalize($object, $format = null, array $context = array())
+    {
+        if (!$object instanceof \SplFileInfo) {
+            throw new InvalidArgumentException('The object must be an instance of "\SplFileInfo".');
+        }
+
+        $mimeType = $this->getMimeType($object);
+        $splFileObject = $this->extractSplFileObject($object);
+
+        $data = '';
+
+        $splFileObject->rewind();
+        while (!$splFileObject->eof()) {
+            $data .= $splFileObject->fgets();
+        }
+
+        if ('text' === explode('/', $mimeType, 2)[0]) {
+            return sprintf('data:%s,%s', $mimeType, rawurlencode($data));
+        }
+
+        return sprintf('data:%s;base64,%s', $mimeType, base64_encode($data));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supportsNormalization($data, $format = null)
+    {
+        return $data instanceof \SplFileInfo;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * Regex adapted from Brian Grinstead code.
+     *
+     * @see https://gist.github.com/bgrins/6194623
+     *
+     * @throws InvalidArgumentException
+     * @throws UnexpectedValueException
+     */
+    public function denormalize($data, $class, $format = null, array $context = array())
+    {
+        if (!preg_match('/^data:([a-z0-9]+\/[a-z0-9]+(;[a-z0-9\-]+\=[a-z0-9\-]+)?)?(;base64)?,[a-z0-9\!\$\&\\\'\,\(\)\*\+\,\;\=\-\.\_\~\:\@\/\?\%\s]*\s*$/i', $data)) {
+            throw new UnexpectedValueException('The provided "data:" URI is not valid.');
+        }
+
+        try {
+            switch ($class) {
+                case 'Symfony\Component\HttpFoundation\File\File':
+                    return new File($data, false);
+
+                case 'SplFileObject':
+                case 'SplFileInfo':
+                    return new \SplFileObject($data);
+            }
+        } catch (\RuntimeException $exception) {
+            throw new UnexpectedValueException($exception->getMessage(), $exception->getCode(), $exception);
+        }
+
+        throw new InvalidArgumentException(sprintf('The class parameter "%s" is not supported. It must be one of "SplFileInfo", "SplFileObject" or "Symfony\Component\HttpFoundation\File\File".', $class));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supportsDenormalization($data, $type, $format = null)
+    {
+        $supportedTypes = array(
+            \SplFileInfo::class => true,
+            \SplFileObject::class => true,
+            'Symfony\Component\HttpFoundation\File\File' => true,
+        );
+
+        return isset($supportedTypes[$type]);
+    }
+
+    /**
+     * Gets the mime type of the object. Defaults to application/octet-stream.
+     *
+     * @param \SplFileInfo $object
+     *
+     * @return string
+     */
+    private function getMimeType(\SplFileInfo $object)
+    {
+        if ($object instanceof File) {
+            return $object->getMimeType();
+        }
+
+        if ($this->mimeTypeGuesser && $mimeType = $this->mimeTypeGuesser->guess($object->getPathname())) {
+            return $mimeType;
+        }
+
+        return 'application/octet-stream';
+    }
+
+    /**
+     * Returns the \SplFileObject instance associated with the given \SplFileInfo instance.
+     *
+     * @param \SplFileInfo $object
+     *
+     * @return \SplFileObject
+     */
+    private function extractSplFileObject(\SplFileInfo $object)
+    {
+        if ($object instanceof \SplFileObject) {
+            return $object;
+        }
+
+        return $object->openFile();
+    }
+}
diff --git a/src/Symfony/Component/Serializer/Tests/Fixtures/test.gif b/src/Symfony/Component/Serializer/Tests/Fixtures/test.gif
diff --git a/src/Symfony/Component/Serializer/Tests/Fixtures/test.txt b/src/Symfony/Component/Serializer/Tests/Fixtures/test.txt
@@ -0,0 +1 @@
+Kévin Dunglas
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/CustomNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/CustomNormalizerTest.php
@@ -32,6 +32,7 @@ public function testInterface()
     {
         $this->assertInstanceOf('Symfony\Component\Serializer\Normalizer\NormalizerInterface', $this->normalizer);
         $this->assertInstanceOf('Symfony\Component\Serializer\Normalizer\DenormalizerInterface', $this->normalizer);
+        $this->assertInstanceOf('Symfony\Component\Serializer\SerializerAwareInterface', $this->normalizer);
     }
 
     public function testSerialize()

diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/DataUriNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/DataUriNormalizerTest.php
@@ -0,0 +1,176 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Serializer\Tests\Normalizer;
+
+use Symfony\Component\HttpFoundation\File\File;
+use Symfony\Component\Serializer\Normalizer\DataUriNormalizer;
+
+/**
+ * @author Kévin Dunglas <dunglas@gmail.com>
+ */
+class DataUriNormalizerTest extends \PHPUnit_Framework_TestCase
+{
+    const TEST_GIF_DATA = 'data:image/gif;base64,R0lGODdhAQABAIAAAP///////ywAAAAAAQABAAACAkQBADs=';
+    const TEST_TXT_DATA = 'data:text/plain,K%C3%A9vin%20Dunglas%0A';
+    const TEST_TXT_CONTENT = "Kévin Dunglas\n";
+
+    /**
+     * @var DataUriNormalizer
+     */
+    private $normalizer;
+
+    public function setUp()
+    {
+        $this->normalizer = new DataUriNormalizer();
+    }
+
+    public function testInterface()
+    {
+        $this->assertInstanceOf('Symfony\Component\Serializer\Normalizer\NormalizerInterface', $this->normalizer);
+        $this->assertInstanceOf('Symfony\Component\Serializer\Normalizer\DenormalizerInterface', $this->normalizer);
+    }
+
+    public function testSupportNormalization()
+    {
+        $this->assertFalse($this->normalizer->supportsNormalization(new \stdClass()));
+        $this->assertTrue($this->normalizer->supportsNormalization(new \SplFileObject('data:,Hello%2C%20World!')));
+    }
+
+    public function testNormalizeHttpFoundationFile()
+    {
+        $file = new File(__DIR__.'/../Fixtures/test.gif');
+
+        $this->assertSame(self::TEST_GIF_DATA, $this->normalizer->normalize($file));
+    }
+
+    public function testNormalizeSplFileInfo()
+    {
+        $file = new \SplFileInfo(__DIR__.'/../Fixtures/test.gif');
+
+        $this->assertSame(self::TEST_GIF_DATA, $this->normalizer->normalize($file));
+    }
+
+    public function testNormalizeText()
+    {
+        $file = new \SplFileObject(__DIR__.'/../Fixtures/test.txt');
+
+        $data = $this->normalizer->normalize($file);
+
+        $this->assertSame(self::TEST_TXT_DATA, $data);
+        $this->assertSame(self::TEST_TXT_CONTENT, file_get_contents($data));
+    }
+
+    public function testSupportsDenormalization()
+    {
+        $this->assertFalse($this->normalizer->supportsDenormalization('foo', 'Bar'));
+        $this->assertTrue($this->normalizer->supportsDenormalization(self::TEST_GIF_DATA, 'SplFileInfo'));
+        $this->assertTrue($this->normalizer->supportsDenormalization(self::TEST_GIF_DATA, 'SplFileObject'));
+        $this->assertTrue($this->normalizer->supportsDenormalization(self::TEST_TXT_DATA, 'Symfony\Component\HttpFoundation\File\File'));
+    }
+
+    public function testDenormalizeSplFileInfo()
+    {
+        $file = $this->normalizer->denormalize(self::TEST_TXT_DATA, 'SplFileInfo');
+
+        $this->assertInstanceOf('SplFileInfo', $file);
+        $this->assertSame(file_get_contents(self::TEST_TXT_DATA), $this->getContent($file));
+    }
+
+    public function testDenormalizeSplFileObject()
+    {
+        $file = $this->normalizer->denormalize(self::TEST_TXT_DATA, 'SplFileObject');
+
+        $this->assertInstanceOf('SplFileObject', $file);
+        $this->assertEquals(file_get_contents(self::TEST_TXT_DATA), $this->getContent($file));
+    }
+
+    public function testDenormalizeHttpFoundationFile()
+    {
+        $file = $this->normalizer->denormalize(self::TEST_GIF_DATA, 'Symfony\Component\HttpFoundation\File\File');
+
+        $this->assertInstanceOf('Symfony\Component\HttpFoundation\File\File', $file);
+        $this->assertSame(file_get_contents(self::TEST_GIF_DATA), $this->getContent($file->openFile()));
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Serializer\Exception\UnexpectedValueException
+     * @expectedExceptionMessage The provided "data:" URI is not valid.
+     */
+    public function testGiveNotAccessToLocalFiles()
+    {
+        $this->normalizer->denormalize('/etc/shadow', 'SplFileObject');
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Serializer\Exception\UnexpectedValueException
+     * @dataProvider invalidUriProvider
+     */
+    public function testInvalidData($uri)
+    {
+        $this->normalizer->denormalize($uri, 'SplFileObject');
+    }
+
+    public function invalidUriProvider()
+    {
+        return array(
+            array('dataxbase64'),
+            array('data:HelloWorld'),
+            array('data:text/html;charset=,%3Ch1%3EHello!%3C%2Fh1%3E'),
+            array('data:text/html;charset,%3Ch1%3EHello!%3C%2Fh1%3E'),
+            array('data:base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQAQMAAAAlPW0iAAAABlBMVEUAAAD///+l2Z/dAAAAM0lEQVR4nGP4/5/h/1+G/58ZDrAz3D/McH8yw83NDDeNGe4Ug9C9zwz3gVLMDA/A6P9/AFGGFyjOXZtQAAAAAElFTkSuQmCC'),
+            array(''),
+            array('http://wikipedia.org'),
+            array('base64'),
+            array('iVBORw0KGgoAAAANSUhEUgAAABAAAAAQAQMAAAAlPW0iAAAABlBMVEUAAAD///+l2Z/dAAAAM0lEQVR4nGP4/5/h/1+G/58ZDrAz3D/McH8yw83NDDeNGe4Ug9C9zwz3gVLMDA/A6P9/AFGGFyjOXZtQAAAAAElFTkSuQmCC'),
+            array(' data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIBAMAAAA2IaO4AAAAFVBMVEXk5OTn5+ft7e319fX29vb5+fn///++GUmVAAAALUlEQVQIHWNICnYLZnALTgpmMGYIFWYIZTA2ZFAzTTFlSDFVMwVyQhmAwsYMAKDaBy0axX/iAAAAAElFTkSuQmCC'),
+            array('   data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIBAMAAAA2IaO4AAAAFVBMVEXk5OTn5+ft7e319fX29vb5+fn///++GUmVAAAALUlEQVQIHWNICnYLZnALTgpmMGYIFWYIZTA2ZFAzTTFlSDFVMwVyQhmAwsYMAKDaBy0axX/iAAAAAElFTkSuQmCC'),
+        );
+    }
+
+    /**
+     * @dataProvider validUriProvider
+     */
+    public function testValidData($uri)
+    {
+        $this->assertInstanceOf('SplFileObject', $this->normalizer->denormalize($uri, 'SplFileObject'));
+    }
+
+    public function validUriProvider()
+    {
+        $data = array(
+            array('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQAQMAAAAlPW0iAAAABlBMVEUAAAD///+l2Z/dAAAAM0lEQVR4nGP4/5/h/1+G/58ZDrAz3D/McH8yw83NDDeNGe4Ug9C9zwz3gVLMDA/A6P9/AFGGFyjOXZtQAAAAAElFTkSuQmCC'),
+            array('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIBAMAAAA2IaO4AAAAFVBMVEXk5OTn5+ft7e319fX29vb5+fn///++GUmVAAAALUlEQVQIHWNICnYLZnALTgpmMGYIFWYIZTA2ZFAzTTFlSDFVMwVyQhmAwsYMAKDaBy0axX/iAAAAAElFTkSuQmCC'),
+            array('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIBAMAAAA2IaO4AAAAFVBMVEXk5OTn5+ft7e319fX29vb5+fn///++GUmVAAAALUlEQVQIHWNICnYLZnALTgpmMGYIFWYIZTA2ZFAzTTFlSDFVMwVyQhmAwsYMAKDaBy0axX/iAAAAAElFTkSuQmCC   '),
+            array('data:,Hello%2C%20World!'),
+            array('data:text/html,%3Ch1%3EHello%2C%20World!%3C%2Fh1%3E'),
+            array('data:,A%20brief%20note'),
+            array('data:text/html;charset=US-ASCII,%3Ch1%3EHello!%3C%2Fh1%3E'),
+        );
+
+        if (!defined('HHVM_VERSION')) {
+            // See https://github.com/facebook/hhvm/issues/6354
+            $data[] = array('data:text/plain;charset=utf-8;base64,SGVsbG8gV29ybGQh');
+        }
+
+        return $data;
+    }
+
+    private function getContent(\SplFileObject $file)
+    {
+        $buffer = '';
+        while (!$file->eof()) {
+            $buffer .= $file->fgets();
+        }
+
+        return $buffer;
+    }
+}
diff --git a/src/Symfony/Component/Serializer/composer.json b/src/Symfony/Component/Serializer/composer.json
@@ -23,6 +23,7 @@
         "symfony/yaml": "~2.8|~3.0",
         "symfony/config": "~2.8|~3.0",
         "symfony/property-access": "~2.8|~3.0",
+        "symfony/http-foundation": "~2.8|~3.0",
         "doctrine/annotations": "~1.0",
         "doctrine/cache": "~1.0"
     },
@@ -31,7 +32,8 @@
         "doctrine/cache": "For using the default cached annotation reader and metadata cache.",
         "symfony/yaml": "For using the default YAML mapping loader.",
         "symfony/config": "For using the XML mapping loader.",
-        "symfony/property-access": "For using the ObjectNormalizer."
+        "symfony/property-access": "For using the ObjectNormalizer.",
+        "symfony/http-foundation": "To use the DataUriNormalizer."
     },
     "autoload": {
         "psr-4": { "Symfony\\Component\\Serializer\\": "" }