IBX-85: Fixed Content cache containing invalid "uri" for file field types

eZ/Publish/Core/FieldType/BinaryBase/BinaryBaseStorage.php

@@ -6,6 +6,7 @@
  */
 namespace eZ\Publish\Core\FieldType\BinaryBase;
 
+use eZ\Publish\SPI\FieldType\BinaryBase\RouteAwarePathGenerator;
 use eZ\Publish\SPI\FieldType\GatewayBasedStorage;
 use eZ\Publish\Core\IO\IOServiceInterface;
 use eZ\Publish\SPI\FieldType\BinaryBase\PathGenerator;
@@ -32,7 +33,7 @@ class BinaryBaseStorage extends GatewayBasedStorage
     /** @var \eZ\Publish\SPI\IO\MimeTypeDetector */
     protected $mimeTypeDetector;
 
-    /** @var PathGenerator */
+    /** @var \eZ\Publish\SPI\FieldType\BinaryBase\PathGenerator */
     protected $downloadUrlGenerator;
 
     /** @var \eZ\Publish\Core\FieldType\BinaryBase\BinaryBaseStorage\Gateway */
@@ -59,7 +60,7 @@ public function __construct(
     }
 
     /**
-     * @param PathGenerator $downloadUrlGenerator
+     * @param \eZ\Publish\SPI\FieldType\BinaryBase\PathGenerator $downloadUrlGenerator
      */
     public function setDownloadUrlGenerator(PathGenerator $downloadUrlGenerator)
     {
@@ -144,9 +145,21 @@ public function getFieldData(VersionInfo $versionInfo, Field $field, array $cont
         if ($field->value->externalData !== null) {
             $binaryFile = $this->ioService->loadBinaryFile($field->value->externalData['id']);
             $field->value->externalData['fileSize'] = $binaryFile->size;
-            $field->value->externalData['uri'] = isset($this->downloadUrlGenerator) ?
-                $this->downloadUrlGenerator->getStoragePathForField($field, $versionInfo) :
-                $binaryFile->uri;
+
+            $uri = $binaryFile->uri;
+            if (isset($this->downloadUrlGenerator)) {
+                $uri = $this->downloadUrlGenerator->getStoragePathForField($field, $versionInfo);
+
+                if ($this->downloadUrlGenerator instanceof RouteAwarePathGenerator) {
+                    $field->value->externalData['route'] = $this->downloadUrlGenerator->getRoute($field, $versionInfo);
+                    $field->value->externalData['route_parameters'] = $this->downloadUrlGenerator->getParameters(
+                        $field,
+                        $versionInfo
+                    );
+                }
+            }
+
+            $field->value->externalData['uri'] = $uri;
         }
     }
 

eZ/Publish/Core/FieldType/BinaryBase/Type.php

@@ -8,8 +8,10 @@
 
 use eZ\Publish\Core\FieldType\FieldType;
 use eZ\Publish\Core\Base\Exceptions\InvalidArgumentValue;
+use eZ\Publish\Core\FieldType\Media\Value;
 use eZ\Publish\Core\FieldType\ValidationError;
 use eZ\Publish\API\Repository\Values\ContentType\FieldDefinition;
+use eZ\Publish\SPI\FieldType\BinaryBase\RouteAwarePathGenerator;
 use eZ\Publish\SPI\FieldType\Value as SPIValue;
 use eZ\Publish\SPI\Persistence\Content\FieldValue as PersistenceValue;
 use eZ\Publish\Core\FieldType\Value as BaseValue;
@@ -20,7 +22,7 @@
 abstract class Type extends FieldType
 {
     /**
-     * @see eZ\Publish\Core\FieldType::$validatorConfigurationSchema
+     * @see \eZ\Publish\Core\FieldType\FieldType::$validatorConfigurationSchema
      */
     protected $validatorConfigurationSchema = [
         'FileSizeValidator' => [
@@ -34,12 +36,16 @@ abstract class Type extends FieldType
     /** @var \eZ\Publish\Core\FieldType\Validator[] */
     private $validators;
 
+    /** @var \eZ\Publish\SPI\FieldType\BinaryBase\RouteAwarePathGenerator|null */
+    protected $routeAwarePathGenerator;
+
     /**
      * @param \eZ\Publish\Core\FieldType\Validator[] $validators
      */
-    public function __construct(array $validators)
+    public function __construct(array $validators, ?RouteAwarePathGenerator $routeAwarePathGenerator = null)
     {
         $this->validators = $validators;
+        $this->routeAwarePathGenerator = $routeAwarePathGenerator;
     }
 
     /**
@@ -51,6 +57,20 @@ public function __construct(array $validators)
      */
     abstract protected function createValue(array $inputValue);
 
+    final protected function regenerateUri(array $inputValue): array
+    {
+        if (isset($this->routeAwarePathGenerator, $inputValue['route'])) {
+            $inputValue['uri'] = $this->routeAwarePathGenerator->generate(
+                $inputValue['route'],
+                $inputValue['route_parameters'] ?? []
+            );
+
+            unset($inputValue['route'], $inputValue['route_parameters']);
+        }
+
+        return $inputValue;
+    }
+
     /**
      * Returns the name of the given field value.
      *
@@ -252,27 +272,23 @@ public function fromPersistenceValue(PersistenceValue $fieldValue)
     {
         // Restored data comes in $data, since it has already been processed
         // there might be more data in the persistence value than needed here
-        $result = $this->fromHash(
-            [
-                'id' => (isset($fieldValue->externalData['id'])
-                    ? $fieldValue->externalData['id']
-                    : null),
-                'fileName' => (isset($fieldValue->externalData['fileName'])
-                    ? $fieldValue->externalData['fileName']
-                    : null),
-                'fileSize' => (isset($fieldValue->externalData['fileSize'])
-                    ? $fieldValue->externalData['fileSize']
-                    : null),
-                'mimeType' => (isset($fieldValue->externalData['mimeType'])
-                    ? $fieldValue->externalData['mimeType']
-                    : null),
-                'uri' => (isset($fieldValue->externalData['uri'])
-                    ? $fieldValue->externalData['uri']
-                    : null),
-            ]
-        );
+        $hash = [
+            'id' => $fieldValue->externalData['id'] ?? null,
+            'fileName' => $fieldValue->externalData['fileName'] ?? null,
+            'fileSize' => $fieldValue->externalData['fileSize'] ?? null,
+            'mimeType' => $fieldValue->externalData['mimeType'] ?? null,
+            'uri' => $fieldValue->externalData['uri'] ?? null,
+        ];
+
+        if (isset($fieldValue->externalData['route'])) {
+            $hash['route'] = $fieldValue->externalData['route'];
+        }
+
+        if (isset($fieldValue->externalData['route_parameters'])) {
+            $hash['route_parameters'] = $fieldValue->externalData['route_parameters'];
+        }
 
-        return $result;
+        return $this->fromHash($hash);
     }
 
     /**

eZ/Publish/Core/FieldType/BinaryFile/Type.php

@@ -44,10 +44,12 @@ public function getEmptyValue()
      *
      * @param array $inputValue
      *
-     * @return Value
+     * @return \eZ\Publish\Core\FieldType\BinaryFile\Value
      */
     protected function createValue(array $inputValue)
     {
+        $inputValue = $this->regenerateUri($inputValue);
+
         return new Value($inputValue);
     }
 

eZ/Publish/Core/FieldType/Media/Type.php

@@ -120,10 +120,12 @@ public function validateFieldSettings($fieldSettings)
      *
      * @param array $inputValue
      *
-     * @return Value
+     * @return \eZ\Publish\Core\FieldType\Media\Value
      */
     protected function createValue(array $inputValue)
     {
+        $inputValue = $this->regenerateUri($inputValue);
+
         return new Value($inputValue);
     }
 

eZ/Publish/Core/FieldType/Tests/BinaryFileTest.php

@@ -9,11 +9,15 @@
 use eZ\Publish\Core\FieldType\BinaryFile\Type as BinaryFileType;
 use eZ\Publish\Core\FieldType\BinaryFile\Value as BinaryFileValue;
 use eZ\Publish\Core\Base\Exceptions\InvalidArgumentValue;
+use eZ\Publish\Core\FieldType\FieldType;
 use eZ\Publish\Core\FieldType\ValidationError;
+use eZ\Publish\SPI\FieldType\BinaryBase\RouteAwarePathGenerator;
 
 /**
  * @group fieldType
  * @group ezbinaryfile
+ *
+ * @covers \eZ\Publish\Core\FieldType\BinaryFile\Type
  */
 class BinaryFileTest extends BinaryBaseTest
 {
@@ -26,11 +30,14 @@ class BinaryFileTest extends BinaryBaseTest
      * NOT take care for test case wide caching of the field type, just return
      * a new instance from this method!
      *
-     * @return FieldType
+     * @return \eZ\Publish\Core\FieldType\FieldType
      */
-    protected function createFieldTypeUnderTest()
+    protected function createFieldTypeUnderTest(): FieldType
     {
-        $fieldType = new BinaryFileType([$this->getBlackListValidatorMock()]);
+        $fieldType = new BinaryFileType(
+            [$this->getBlackListValidatorMock()],
+            $this->getRouteAwarePathGenerator()
+        );
         $fieldType->setTransformationProcessor($this->getTransformationProcessorMock());
 
         return $fieldType;
@@ -445,6 +452,55 @@ public function provideInputForFromHash()
                     ]
                 ),
             ],
+            [
+                [
+                    'id' => __FILE__,
+                    'fileName' => 'sindelfingen.jpg',
+                    'fileSize' => 2342,
+                    'downloadCount' => 0,
+                    'mimeType' => 'image/jpeg',
+                    'uri' => 'some_uri_acquired_from_SPI',
+                    'route' => 'some_route',
+                ],
+                new BinaryFileValue(
+                    [
+                        'id' => null,
+                        'inputUri' => __FILE__,
+                        'path' => __FILE__,
+                        'fileName' => 'sindelfingen.jpg',
+                        'fileSize' => 2342,
+                        'downloadCount' => 0,
+                        'mimeType' => 'image/jpeg',
+                        'uri' => '__GENERATED_URI__',
+                    ]
+                ),
+            ],
+            [
+                [
+                    'id' => __FILE__,
+                    'fileName' => 'sindelfingen.jpg',
+                    'fileSize' => 2342,
+                    'downloadCount' => 0,
+                    'mimeType' => 'image/jpeg',
+                    'uri' => 'some_uri_acquired_from_SPI',
+                    'route' => 'some_route',
+                    'route_parameters' => [
+                        'any_param' => true,
+                    ],
+                ],
+                new BinaryFileValue(
+                    [
+                        'id' => null,
+                        'inputUri' => __FILE__,
+                        'path' => __FILE__,
+                        'fileName' => 'sindelfingen.jpg',
+                        'fileSize' => 2342,
+                        'downloadCount' => 0,
+                        'mimeType' => 'image/jpeg',
+                        'uri' => '__GENERATED_URI_WITH_PARAMS__',
+                    ]
+                ),
+            ],
             // @todo: Provide upload struct (via REST)!
         ];
     }
@@ -582,4 +638,19 @@ public function provideInvalidDataForValidate()
             ],
         ];
     }
+
+    private function getRouteAwarePathGenerator(): RouteAwarePathGenerator
+    {
+        $mock = $this->createMock(RouteAwarePathGenerator::class);
+        $mock->method('generate')
+            ->willReturnCallback(static function (string $route, array $routeParameters = []): string {
+                if ($routeParameters) {
+                    return '__GENERATED_URI_WITH_PARAMS__';
+                }
+
+                return '__GENERATED_URI__';
+            });
+
+        return $mock;
+    }
 }

eZ/Publish/Core/FieldType/Tests/FieldTypeTest.php

@@ -685,7 +685,7 @@ public function testToHash($inputValue, $expectedResult)
     }
 
     /**
-     * @param mixed $inputValue
+     * @param mixed $inputHash
      * @param array $expectedResult
      *
      * @dataProvider provideInputForFromHash

eZ/Publish/Core/MVC/Symfony/FieldType/BinaryBase/ContentDownloadUrlGenerator.php

@@ -7,29 +7,45 @@
 namespace eZ\Publish\Core\MVC\Symfony\FieldType\BinaryBase;
 
 use eZ\Publish\SPI\FieldType\BinaryBase\PathGenerator;
+use eZ\Publish\SPI\FieldType\BinaryBase\RouteAwarePathGenerator;
 use eZ\Publish\SPI\Persistence\Content\Field;
 use eZ\Publish\SPI\Persistence\Content\VersionInfo;
 use Symfony\Component\Routing\RouterInterface;
 
-class ContentDownloadUrlGenerator extends PathGenerator
+class ContentDownloadUrlGenerator extends PathGenerator implements RouteAwarePathGenerator
 {
     /** @var \Symfony\Component\Routing\RouterInterface */
     private $router;
 
+    /** @var string */
+    private $route = 'ez_content_download_field_id';
+
     public function __construct(RouterInterface $router)
     {
         $this->router = $router;
     }
 
     public function getStoragePathForField(Field $field, VersionInfo $versionInfo)
     {
-        return $this->router->generate(
-            'ez_content_download_field_id',
-            [
-                'contentId' => $versionInfo->contentInfo->id,
-                'fieldId' => $field->id,
-                'version' => $versionInfo->versionNo,
-            ]
-        );
+        return $this->generate($this->route, $this->getParameters($field, $versionInfo));
+    }
+
+    public function generate(string $route, ?array $parameters = []): string
+    {
+        return $this->router->generate($route, $parameters ?? []);
+    }
+
+    public function getRoute(Field $field, VersionInfo $versionInfo): string
+    {
+        return $this->route;
+    }
+
+    public function getParameters(Field $field, VersionInfo $versionInfo): array
+    {
+        return [
+            'contentId' => $versionInfo->contentInfo->id,
+            'fieldId' => $field->id,
+            'version' => $versionInfo->versionNo,
+        ];
     }
 }

eZ/Publish/Core/settings/fieldtypes.yml

@@ -292,6 +292,7 @@ services:
         class: "%ezpublish.fieldType.ezbinaryfile.class%"
         arguments:
             - ['@ezpublish.fieldType.validator.black_list']
+            - "@?ezpublish.fieldType.ezbinarybase.download_url_generator"
         parent: ezpublish.fieldType
         tags:
             - {name: ezpublish.fieldType, alias: ezbinaryfile}

eZ/Publish/SPI/FieldType/BinaryBase/PathGenerator.php

@@ -9,7 +9,10 @@
 use eZ\Publish\SPI\Persistence\Content\VersionInfo;
 use eZ\Publish\SPI\Persistence\Content\Field;
 
-abstract class PathGenerator
+/**
+ * @deprecated use \eZ\Publish\SPI\FieldType\BinaryBase\PathGeneratorInterface instead.
+ */
+abstract class PathGenerator implements PathGeneratorInterface
 {
     abstract public function getStoragePathForField(Field $field, VersionInfo $versionInfo);
 }

eZ/Publish/SPI/FieldType/BinaryBase/PathGeneratorInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace eZ\Publish\SPI\FieldType\BinaryBase;
+
+use eZ\Publish\SPI\Persistence\Content\Field;
+use eZ\Publish\SPI\Persistence\Content\VersionInfo;
+
+interface PathGeneratorInterface
+{
+    public function getStoragePathForField(Field $field, VersionInfo $versionInfo);
+}