IBX-6856: Added mime types limitation for ezimage field type

phpstan-baseline.neon

@@ -10745,11 +10745,6 @@ parameters:
 			count: 1
 			path: src/lib/FieldType/Validator/FloatValueValidator.php
 
-		-
-			message: "#^Method Ibexa\\\\Core\\\\FieldType\\\\Validator\\\\ImageValidator\\:\\:innerValidate\\(\\) has no return type specified\\.$#"
-			count: 1
-			path: src/lib/FieldType/Validator/ImageValidator.php
-
 		-
 			message: "#^Method Ibexa\\\\Core\\\\FieldType\\\\Validator\\\\ImageValidator\\:\\:innerValidate\\(\\) has parameter \\$filePath with no type specified\\.$#"
 			count: 1
@@ -30605,21 +30600,6 @@ parameters:
 			count: 1
 			path: tests/integration/Core/Repository/FieldType/ImageIntegrationTest.php
 
-		-
-			message: "#^Method Ibexa\\\\Tests\\\\Integration\\\\Core\\\\Repository\\\\FieldType\\\\ImageIntegrationTest\\:\\:assertCopiedFieldDataLoadedCorrectly\\(\\) has no return type specified\\.$#"
-			count: 1
-			path: tests/integration/Core/Repository/FieldType/ImageIntegrationTest.php
-
-		-
-			message: "#^Method Ibexa\\\\Tests\\\\Integration\\\\Core\\\\Repository\\\\FieldType\\\\ImageIntegrationTest\\:\\:assertUpdatedFieldDataLoadedCorrect\\(\\) return type has no value type specified in iterable type array\\.$#"
-			count: 1
-			path: tests/integration/Core/Repository/FieldType/ImageIntegrationTest.php
-
-		-
-			message: "#^Method Ibexa\\\\Tests\\\\Integration\\\\Core\\\\Repository\\\\FieldType\\\\ImageIntegrationTest\\:\\:assertUpdatedFieldDataLoadedCorrect\\(\\) should return array but return statement is missing\\.$#"
-			count: 1
-			path: tests/integration/Core/Repository/FieldType/ImageIntegrationTest.php
-
 		-
 			message: "#^Method Ibexa\\\\Tests\\\\Integration\\\\Core\\\\Repository\\\\FieldType\\\\ImageIntegrationTest\\:\\:getAdditionallyIndexedFieldData\\(\\) return type has no value type specified in iterable type array\\.$#"
 			count: 1
@@ -30630,31 +30610,11 @@ parameters:
 			count: 1
 			path: tests/integration/Core/Repository/FieldType/ImageIntegrationTest.php
 
-		-
-			message: "#^Method Ibexa\\\\Tests\\\\Integration\\\\Core\\\\Repository\\\\FieldType\\\\ImageIntegrationTest\\:\\:getSettingsSchema\\(\\) return type has no value type specified in iterable type array\\.$#"
-			count: 1
-			path: tests/integration/Core/Repository/FieldType/ImageIntegrationTest.php
-
 		-
 			message: "#^Method Ibexa\\\\Tests\\\\Integration\\\\Core\\\\Repository\\\\FieldType\\\\ImageIntegrationTest\\:\\:getStoragePrefix\\(\\) has no return type specified\\.$#"
 			count: 1
 			path: tests/integration/Core/Repository/FieldType/ImageIntegrationTest.php
 
-		-
-			message: "#^Method Ibexa\\\\Tests\\\\Integration\\\\Core\\\\Repository\\\\FieldType\\\\ImageIntegrationTest\\:\\:getValidUpdateFieldData\\(\\) return type has no value type specified in iterable type array\\.$#"
-			count: 1
-			path: tests/integration/Core/Repository/FieldType/ImageIntegrationTest.php
-
-		-
-			message: "#^Method Ibexa\\\\Tests\\\\Integration\\\\Core\\\\Repository\\\\FieldType\\\\ImageIntegrationTest\\:\\:getValidUpdateFieldData\\(\\) should return array but returns Ibexa\\\\Core\\\\FieldType\\\\Image\\\\Value\\.$#"
-			count: 1
-			path: tests/integration/Core/Repository/FieldType/ImageIntegrationTest.php
-
-		-
-			message: "#^Method Ibexa\\\\Tests\\\\Integration\\\\Core\\\\Repository\\\\FieldType\\\\ImageIntegrationTest\\:\\:getValidatorSchema\\(\\) return type has no value type specified in iterable type array\\.$#"
-			count: 1
-			path: tests/integration/Core/Repository/FieldType/ImageIntegrationTest.php
-
 		-
 			message: "#^Method Ibexa\\\\Tests\\\\Integration\\\\Core\\\\Repository\\\\FieldType\\\\ImageIntegrationTest\\:\\:provideFromHashData\\(\\) return type has no value type specified in iterable type array\\.$#"
 			count: 1
@@ -30675,36 +30635,11 @@ parameters:
 			count: 1
 			path: tests/integration/Core/Repository/FieldType/ImageIntegrationTest.php
 
-		-
-			message: "#^Method Ibexa\\\\Tests\\\\Integration\\\\Core\\\\Repository\\\\FieldType\\\\ImageIntegrationTest\\:\\:providerForTestIsEmptyValue\\(\\) has no return type specified\\.$#"
-			count: 1
-			path: tests/integration/Core/Repository/FieldType/ImageIntegrationTest.php
-
-		-
-			message: "#^Method Ibexa\\\\Tests\\\\Integration\\\\Core\\\\Repository\\\\FieldType\\\\ImageIntegrationTest\\:\\:providerForTestIsNotEmptyValue\\(\\) has no return type specified\\.$#"
-			count: 1
-			path: tests/integration/Core/Repository/FieldType/ImageIntegrationTest.php
-
 		-
 			message: "#^Method Ibexa\\\\Tests\\\\Integration\\\\Core\\\\Repository\\\\FieldType\\\\ImageIntegrationTest\\:\\:publishNewImage\\(\\) has parameter \\$parentLocationIDs with no value type specified in iterable type array\\.$#"
 			count: 1
 			path: tests/integration/Core/Repository/FieldType/ImageIntegrationTest.php
 
-		-
-			message: "#^Method Ibexa\\\\Tests\\\\Integration\\\\Core\\\\Repository\\\\FieldType\\\\ImageIntegrationTest\\:\\:testInherentCopyForNewLanguage\\(\\) has no return type specified\\.$#"
-			count: 1
-			path: tests/integration/Core/Repository/FieldType/ImageIntegrationTest.php
-
-		-
-			message: "#^Method Ibexa\\\\Tests\\\\Integration\\\\Core\\\\Repository\\\\FieldType\\\\ImageIntegrationTest\\:\\:testUpdatingImageMetadataOnlyWorks\\(\\) has no return type specified\\.$#"
-			count: 1
-			path: tests/integration/Core/Repository/FieldType/ImageIntegrationTest.php
-
-		-
-			message: "#^Parameter \\#2 \\$newImageValue of method Ibexa\\\\Tests\\\\Integration\\\\Core\\\\Repository\\\\FieldType\\\\ImageIntegrationTest\\:\\:updateImage\\(\\) expects Ibexa\\\\Core\\\\FieldType\\\\Image\\\\Value, array given\\.$#"
-			count: 2
-			path: tests/integration/Core/Repository/FieldType/ImageIntegrationTest.php
-
 		-
 			message: "#^Property Ibexa\\\\Tests\\\\Integration\\\\Core\\\\Repository\\\\FieldType\\\\ImageIntegrationTest\\:\\:\\$loadedImagePath has no type specified\\.$#"
 			count: 1

src/lib/FieldType/Image/Type.php

@@ -36,15 +36,37 @@ class Type extends FieldType implements TranslationContainerInterface
         ],
     ];
 
+    /**
+     * @var array{
+     *     mimeTypes: array{
+     *         type: string,
+     *         default: array{},
+     *     }
+     * }
+     */
+    protected $settingsSchema = [
+        'mimeTypes' => [
+            'type' => 'choice',
+            'default' => [],
+        ],
+    ];
+
     /** @var \Ibexa\Core\FieldType\Validator[] */
     private $validators;
 
+    /** @var array<string> */
+    private array $mimeTypes;
+
     /**
-     * @param \Ibexa\Core\FieldType\Validator[] $validators
+     * @param array<\Ibexa\Core\FieldType\Validator> $validators
+     * @param array<string> $mimeTypes
      */
-    public function __construct(array $validators)
-    {
+    public function __construct(
+        array $validators,
+        array $mimeTypes = []
+    ) {
         $this->validators = $validators;
+        $this->mimeTypes = $mimeTypes;
     }
 
     /**
@@ -166,7 +188,7 @@ public function validate(FieldDefinition $fieldDefinition, SPIValue $fieldValue)
         }
 
         foreach ($this->validators as $externalValidator) {
-            if (!$externalValidator->validate($fieldValue)) {
+            if (!$externalValidator->validate($fieldValue, $fieldDefinition)) {
                 $errors = array_merge($errors, $externalValidator->getMessage());
             }
         }
@@ -207,6 +229,41 @@ public function validate(FieldDefinition $fieldDefinition, SPIValue $fieldValue)
         return $errors;
     }
 
+    public function validateFieldSettings($fieldSettings): array
+    {
+        $validationErrors = [];
+
+        foreach ($fieldSettings as $name => $value) {
+            if (!isset($this->settingsSchema[$name])) {
+                $validationErrors[] = new ValidationError(
+                    "Setting '%setting%' is unknown",
+                    null,
+                    [
+                        '%setting%' => $name,
+                    ],
+                    "[$name]"
+                );
+            }
+
+            if (
+                $name === 'mimeTypes'
+                && !empty($this->mimeTypes)
+                && !empty(array_diff($value, $this->mimeTypes))
+            ) {
+                $validationErrors[] = new ValidationError(
+                    "Setting '%setting%' contains unsupported mime types",
+                    null,
+                    [
+                        '%setting%' => $name,
+                    ],
+                    "[$name]"
+                );
+            }
+        }
+
+        return $validationErrors;
+    }
+
     /**
      * Validates the validatorConfiguration of a FieldDefinitionCreateStruct or FieldDefinitionUpdateStruct.
      *

src/lib/FieldType/Validator.php

@@ -7,6 +7,7 @@
 namespace Ibexa\Core\FieldType;
 
 use Ibexa\Contracts\Core\Repository\Exceptions\PropertyNotFoundException as PropertyNotFound;
+use Ibexa\Contracts\Core\Repository\Values\ContentType\FieldDefinition;
 
 /**
  * Base field type validator validator.
@@ -98,7 +99,7 @@ abstract public function validateConstraints($constraints);
      *
      * @return bool
      */
-    abstract public function validate(Value $value);
+    abstract public function validate(Value $value, ?FieldDefinition $fieldDefinition = null);
 
     /**
      * Returns array of messages on performed validations.

src/lib/FieldType/Validator/EmailAddressValidator.php

@@ -6,6 +6,7 @@
  */
 namespace Ibexa\Core\FieldType\Validator;
 
+use Ibexa\Contracts\Core\Repository\Values\ContentType\FieldDefinition;
 use Ibexa\Core\FieldType\ValidationError;
 use Ibexa\Core\FieldType\Validator;
 use Ibexa\Core\FieldType\Value as BaseValue;
@@ -84,7 +85,7 @@ public function validateConstraints($constraints)
      *
      * @return bool
      */
-    public function validate(BaseValue $value)
+    public function validate(BaseValue $value, ?FieldDefinition $fieldDefinition = null)
     {
         $pattern = '/^((\"[^\"\f\n\r\t\v\b]+\")|([A-Za-z0-9_\!\#\$\%\&\'\*\+\-\~\/\^\`\|\{\}]+(\.[A-Za-z0-9_\!\#\$\%\&\'\*\+\-\~\/\^\`\|\{\}]+)*))@((\[(((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9]))\.((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9]))\.((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9]))\.((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9])))\])|(((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9]))\.((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9]))\.((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9]))\.((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9])))|((([A-Za-z0-9\-])+\.)+[A-Za-z\-]{2,}))$/';
 

src/lib/FieldType/Validator/FileExtensionBlackListValidator.php

@@ -6,6 +6,7 @@
  */
 namespace Ibexa\Core\FieldType\Validator;
 
+use Ibexa\Contracts\Core\Repository\Values\ContentType\FieldDefinition;
 use Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface;
 use Ibexa\Core\FieldType\ValidationError;
 use Ibexa\Core\FieldType\Validator;
@@ -45,7 +46,7 @@ public function validateConstraints($constraints)
     /**
      * {@inheritdoc}
      */
-    public function validate(BaseValue $value)
+    public function validate(BaseValue $value, ?FieldDefinition $fieldDefinition = null)
     {
         if (
             pathinfo($value->fileName, PATHINFO_BASENAME) !== $value->fileName ||

src/lib/FieldType/Validator/FileSizeValidator.php

@@ -6,6 +6,7 @@
  */
 namespace Ibexa\Core\FieldType\Validator;
 
+use Ibexa\Contracts\Core\Repository\Values\ContentType\FieldDefinition;
 use Ibexa\Core\FieldType\ValidationError;
 use Ibexa\Core\FieldType\Validator;
 use Ibexa\Core\FieldType\Value as BaseValue;
@@ -66,7 +67,7 @@ public function validateConstraints($constraints)
      *
      * @return bool
      */
-    public function validate(BaseValue $value)
+    public function validate(BaseValue $value, ?FieldDefinition $fieldDefinition = null)
     {
         $isValid = true;
 

src/lib/FieldType/Validator/FloatValueValidator.php

@@ -6,6 +6,7 @@
  */
 namespace Ibexa\Core\FieldType\Validator;
 
+use Ibexa\Contracts\Core\Repository\Values\ContentType\FieldDefinition;
 use Ibexa\Core\FieldType\ValidationError;
 use Ibexa\Core\FieldType\Validator;
 use Ibexa\Core\FieldType\Value as BaseValue;
@@ -82,7 +83,7 @@ public function validateConstraints($constraints)
      *
      * @return bool
      */
-    public function validate(BaseValue $value)
+    public function validate(BaseValue $value, ?FieldDefinition $fieldDefinition = null)
     {
         $isValid = true;
 

src/lib/FieldType/Validator/ImageValidator.php

@@ -6,6 +6,7 @@
  */
 namespace Ibexa\Core\FieldType\Validator;
 
+use Ibexa\Contracts\Core\Repository\Values\ContentType\FieldDefinition;
 use Ibexa\Core\FieldType\ValidationError;
 use Ibexa\Core\FieldType\Validator;
 use Ibexa\Core\FieldType\Value;
@@ -15,34 +16,43 @@ class ImageValidator extends Validator
     /**
      * {@inheritdoc}
      */
-    public function validateConstraints($constraints)
+    public function validateConstraints($constraints, ?FieldDefinition $fieldDefinition = null)
     {
         return [];
     }
 
     /**
      * {@inheritdoc}
      */
-    public function validate(Value $value)
+    public function validate(Value $value, ?FieldDefinition $fieldDefinition = null)
     {
+        $mimeTypes = [];
+        if (null !== $fieldDefinition) {
+            $mimeTypes = $fieldDefinition->getFieldSettings()['mimeTypes'] ?? [];
+        }
+
         $isValid = true;
-        if (isset($value->inputUri) && !$this->innerValidate($value->inputUri)) {
+        if (isset($value->inputUri) && !$this->innerValidate($value->inputUri, $mimeTypes)) {
             $isValid = false;
         }
 
         // BC: Check if file is a valid image if the value of 'id' matches a local file
-        if (isset($value->id) && file_exists($value->id) && !$this->innerValidate($value->id)) {
+        if (isset($value->id) && file_exists($value->id) && !$this->innerValidate($value->id, $mimeTypes)) {
             $isValid = false;
         }
 
         return $isValid;
     }
 
-    private function innerValidate($filePath)
+    /**
+     * @param array<string> $mimeTypes
+     */
+    private function innerValidate($filePath, array $mimeTypes): bool
     {
         // silence `getimagesize` error as extension-wise valid image files might produce it anyway
         // note that file extension checking is done using other validation which should be called before this one
-        if (!@getimagesize($filePath)) {
+        $imageData = @getimagesize($filePath);
+        if (false === $imageData) {
             $this->errors[] = new ValidationError(
                 'A valid image file is required.',
                 null,
@@ -53,6 +63,26 @@ private function innerValidate($filePath)
             return false;
         }
 
+        // If array with mime types is empty, it means that all mime types are allowed
+        if (empty($mimeTypes)) {
+            return true;
+        }
+
+        $mimeType = $imageData['mime'];
+        if (!in_array($mimeType, $mimeTypes, true)) {
+            $this->errors[] = new ValidationError(
+                'The mime type of the file is invalid (%mimeType%). Allowed mime types are %mimeTypes%.',
+                null,
+                [
+                    '%mimeType%' => $mimeType,
+                    '%mimeTypes%' => implode(', ', $mimeTypes),
+                ],
+                'id'
+            );
+
+            return false;
+        }
+
         return true;
     }
 }

src/lib/FieldType/Validator/IntegerValueValidator.php

@@ -6,6 +6,7 @@
  */
 namespace Ibexa\Core\FieldType\Validator;
 
+use Ibexa\Contracts\Core\Repository\Values\ContentType\FieldDefinition;
 use Ibexa\Core\FieldType\ValidationError;
 use Ibexa\Core\FieldType\Validator;
 use Ibexa\Core\FieldType\Value as BaseValue;
@@ -85,7 +86,7 @@ public function validateConstraints($constraints)
      *
      * @return bool
      */
-    public function validate(BaseValue $value)
+    public function validate(BaseValue $value, ?FieldDefinition $fieldDefinition = null)
     {
         $isValid = true;
 

src/lib/FieldType/Validator/StringLengthValidator.php

@@ -6,6 +6,7 @@
  */
 namespace Ibexa\Core\FieldType\Validator;
 
+use Ibexa\Contracts\Core\Repository\Values\ContentType\FieldDefinition;
 use Ibexa\Core\FieldType\ValidationError;
 use Ibexa\Core\FieldType\Validator;
 use Ibexa\Core\FieldType\Value as BaseValue;
@@ -104,7 +105,7 @@ protected function validateConstraintsOrder($constraints)
      *
      * @return bool
      */
-    public function validate(BaseValue $value)
+    public function validate(BaseValue $value, ?FieldDefinition $fieldDefinition = null)
     {
         $isValid = true;