vendor/symfony/validator/Constraints/File.php line 26

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Validator\Constraints;
  14. use Symfony\Component\Validator\Constraint;
  15. use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
  17. /**
  18.  * @Annotation
  19.  * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
  20.  *
  21.  * @property int $maxSize
  22.  *
  23.  * @author Bernhard Schussek <bschussek@gmail.com>
  24.  */
  25. #[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
  26. class File extends Constraint
  27. {
  28.     // Check the Image constraint for clashes if adding new constants here
  30.     public const NOT_FOUND_ERROR = 'd2a3fb6e-7ddc-4210-8fbf-2ab345ce1998';
  31.     public const NOT_READABLE_ERROR = 'c20c92a4-5bfa-4202-9477-28e800e0f6ff';
  32.     public const EMPTY_ERROR = '5d743385-9775-4aa5-8ff5-495fb1e60137';
  33.     public const TOO_LARGE_ERROR = 'df8637af-d466-48c6-a59d-e7126250a654';
  34.     public const INVALID_MIME_TYPE_ERROR = '744f00bc-4389-4c74-92de-9a43cde55534';
  35.     public const INVALID_EXTENSION_ERROR = 'c8c7315c-6186-4719-8b71-5659e16bdcb7';
  37.     protected const ERROR_NAMES = [
  38.         self::NOT_FOUND_ERROR => 'NOT_FOUND_ERROR',
  39.         self::NOT_READABLE_ERROR => 'NOT_READABLE_ERROR',
  40.         self::EMPTY_ERROR => 'EMPTY_ERROR',
  41.         self::TOO_LARGE_ERROR => 'TOO_LARGE_ERROR',
  42.         self::INVALID_MIME_TYPE_ERROR => 'INVALID_MIME_TYPE_ERROR',
  43.     ];
  45.     /**
  46.      * @deprecated since Symfony 6.1, use const ERROR_NAMES instead
  47.      */
  48.     protected static $errorNames = self::ERROR_NAMES;
  50.     public $binaryFormat;
  51.     public $mimeTypes = [];
  52.     public array|string|null $extensions = [];
  53.     public $notFoundMessage = 'The file could not be found.';
  54.     public $notReadableMessage = 'The file is not readable.';
  55.     public $maxSizeMessage = 'The file is too large ({{ size }} {{ suffix }}). Allowed maximum size is {{ limit }} {{ suffix }}.';
  56.     public $mimeTypesMessage = 'The mime type of the file is invalid ({{ type }}). Allowed mime types are {{ types }}.';
  57.     public string $extensionsMessage = 'The extension of the file is invalid ({{ extension }}). Allowed extensions are {{ extensions }}.';
  58.     public $disallowEmptyMessage = 'An empty file is not allowed.';
  60.     public $uploadIniSizeErrorMessage = 'The file is too large. Allowed maximum size is {{ limit }} {{ suffix }}.';
  61.     public $uploadFormSizeErrorMessage = 'The file is too large.';
  62.     public $uploadPartialErrorMessage = 'The file was only partially uploaded.';
  63.     public $uploadNoFileErrorMessage = 'No file was uploaded.';
  64.     public $uploadNoTmpDirErrorMessage = 'No temporary folder was configured in php.ini.';
  65.     public $uploadCantWriteErrorMessage = 'Cannot write temporary file to disk.';
  66.     public $uploadExtensionErrorMessage = 'A PHP extension caused the upload to fail.';
  67.     public $uploadErrorMessage = 'The file could not be uploaded.';
  69.     protected $maxSize;
  71.     /**
  72.      * @param array<string, string|string[]>|string[]|string $extensions
  73.      */
  74.     public function __construct(
  75.         array $options = null,
  76.         int|string $maxSize = null,
  77.         bool $binaryFormat = null,
  78.         array|string $mimeTypes = null,
  79.         string $notFoundMessage = null,
  80.         string $notReadableMessage = null,
  81.         string $maxSizeMessage = null,
  82.         string $mimeTypesMessage = null,
  83.         string $disallowEmptyMessage = null,
  85.         string $uploadIniSizeErrorMessage = null,
  86.         string $uploadFormSizeErrorMessage = null,
  87.         string $uploadPartialErrorMessage = null,
  88.         string $uploadNoFileErrorMessage = null,
  89.         string $uploadNoTmpDirErrorMessage = null,
  90.         string $uploadCantWriteErrorMessage = null,
  91.         string $uploadExtensionErrorMessage = null,
  92.         string $uploadErrorMessage = null,
  93.         array $groups = null,
  94.         mixed $payload = null,
  96.         array|string $extensions = null,
  97.         string $extensionsMessage = null,
  98.     ) {
  99.         parent::__construct($options, $groups, $payload);
  101.         $this->maxSize = $maxSize ?? $this->maxSize;
  102.         $this->binaryFormat = $binaryFormat ?? $this->binaryFormat;
  103.         $this->mimeTypes = $mimeTypes ?? $this->mimeTypes;
  104.         $this->extensions = $extensions ?? $this->extensions;
  105.         $this->notFoundMessage = $notFoundMessage ?? $this->notFoundMessage;
  106.         $this->notReadableMessage = $notReadableMessage ?? $this->notReadableMessage;
  107.         $this->maxSizeMessage = $maxSizeMessage ?? $this->maxSizeMessage;
  108.         $this->mimeTypesMessage = $mimeTypesMessage ?? $this->mimeTypesMessage;
  109.         $this->extensionsMessage = $extensionsMessage ?? $this->extensionsMessage;
  110.         $this->disallowEmptyMessage = $disallowEmptyMessage ?? $this->disallowEmptyMessage;
  111.         $this->uploadIniSizeErrorMessage = $uploadIniSizeErrorMessage ?? $this->uploadIniSizeErrorMessage;
  112.         $this->uploadFormSizeErrorMessage = $uploadFormSizeErrorMessage ?? $this->uploadFormSizeErrorMessage;
  113.         $this->uploadPartialErrorMessage = $uploadPartialErrorMessage ?? $this->uploadPartialErrorMessage;
  114.         $this->uploadNoFileErrorMessage = $uploadNoFileErrorMessage ?? $this->uploadNoFileErrorMessage;
  115.         $this->uploadNoTmpDirErrorMessage = $uploadNoTmpDirErrorMessage ?? $this->uploadNoTmpDirErrorMessage;
  116.         $this->uploadCantWriteErrorMessage = $uploadCantWriteErrorMessage ?? $this->uploadCantWriteErrorMessage;
  117.         $this->uploadExtensionErrorMessage = $uploadExtensionErrorMessage ?? $this->uploadExtensionErrorMessage;
  118.         $this->uploadErrorMessage = $uploadErrorMessage ?? $this->uploadErrorMessage;
  120.         if (null !== $this->maxSize) {
  121.             $this->normalizeBinaryFormat($this->maxSize);
  122.         }
  123.     }
  125.     public function __set(string $option, mixed $value)
  126.     {
  127.         if ('maxSize' === $option) {
  128.             $this->normalizeBinaryFormat($value);
  130.             return;
  131.         }
  133.         parent::__set($option, $value);
  134.     }
  136.     public function __get(string $option): mixed
  137.     {
  138.         if ('maxSize' === $option) {
  139.             return $this->maxSize;
  140.         }
  142.         return parent::__get($option);
  143.     }
  145.     public function __isset(string $option): bool
  146.     {
  147.         if ('maxSize' === $option) {
  148.             return true;
  149.         }
  151.         return parent::__isset($option);
  152.     }
  154.     private function normalizeBinaryFormat(int|string $maxSize)
  155.     {
  156.         $factors = [
  157.             'k' => 1000,
  158.             'ki' => 1 << 10,
  159.             'm' => 1000 * 1000,
  160.             'mi' => 1 << 20,
  161.             'g' => 1000 * 1000 * 1000,
  162.             'gi' => 1 << 30,
  163.         ];
  164.         if (ctype_digit((string) $maxSize)) {
  165.             $this->maxSize = (int) $maxSize;
  166.             $this->binaryFormat ??= false;
  167.         } elseif (preg_match('/^(\d++)('.implode('|', array_keys($factors)).')$/i', $maxSize, $matches)) {
  168.             $this->maxSize = $matches[1] * $factors[$unit = strtolower($matches[2])];
  169.             $this->binaryFormat ??= 2 === \strlen($unit);
  170.         } else {
  171.             throw new ConstraintDefinitionException(sprintf('"%s" is not a valid maximum size.', $maxSize));
  172.         }
  173.     }
  174. }