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

Open in your IDE?
  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';
  36. public const FILENAME_TOO_LONG = 'e5706483-91a8-49d8-9a59-5e81a3c634a8';
  38. protected const ERROR_NAMES = [
  39. self::NOT_FOUND_ERROR => 'NOT_FOUND_ERROR',
  40. self::NOT_READABLE_ERROR => 'NOT_READABLE_ERROR',
  41. self::EMPTY_ERROR => 'EMPTY_ERROR',
  42. self::TOO_LARGE_ERROR => 'TOO_LARGE_ERROR',
  43. self::INVALID_MIME_TYPE_ERROR => 'INVALID_MIME_TYPE_ERROR',
  44. self::INVALID_EXTENSION_ERROR => 'INVALID_EXTENSION_ERROR',
  45. self::FILENAME_TOO_LONG => 'FILENAME_TOO_LONG',
  46. ];
  48. /**
  49. * @deprecated since Symfony 6.1, use const ERROR_NAMES instead
  50. */
  51. protected static $errorNames = self::ERROR_NAMES;
  53. public $binaryFormat;
  54. public $mimeTypes = [];
  55. public ?int $filenameMaxLength = null;
  56. public array|string|null $extensions = [];
  57. public $notFoundMessage = 'The file could not be found.';
  58. public $notReadableMessage = 'The file is not readable.';
  59. public $maxSizeMessage = 'The file is too large ({{ size }} {{ suffix }}). Allowed maximum size is {{ limit }} {{ suffix }}.';
  60. public $mimeTypesMessage = 'The mime type of the file is invalid ({{ type }}). Allowed mime types are {{ types }}.';
  61. public string $extensionsMessage = 'The extension of the file is invalid ({{ extension }}). Allowed extensions are {{ extensions }}.';
  62. public $disallowEmptyMessage = 'An empty file is not allowed.';
  63. public $filenameTooLongMessage = 'The filename is too long. It should have {{ filename_max_length }} character or less.|The filename is too long. It should have {{ filename_max_length }} characters or less.';
  65. public $uploadIniSizeErrorMessage = 'The file is too large. Allowed maximum size is {{ limit }} {{ suffix }}.';
  66. public $uploadFormSizeErrorMessage = 'The file is too large.';
  67. public $uploadPartialErrorMessage = 'The file was only partially uploaded.';
  68. public $uploadNoFileErrorMessage = 'No file was uploaded.';
  69. public $uploadNoTmpDirErrorMessage = 'No temporary folder was configured in php.ini.';
  70. public $uploadCantWriteErrorMessage = 'Cannot write temporary file to disk.';
  71. public $uploadExtensionErrorMessage = 'A PHP extension caused the upload to fail.';
  72. public $uploadErrorMessage = 'The file could not be uploaded.';
  74. protected $maxSize;
  76. /**
  77. * @param array<string|string[]>|string $extensions
  78. */
  79. public function __construct(
  80. ?array $options = null,
  81. int|string|null $maxSize = null,
  82. ?bool $binaryFormat = null,
  83. array|string|null $mimeTypes = null,
  84. ?int $filenameMaxLength = null,
  85. ?string $notFoundMessage = null,
  86. ?string $notReadableMessage = null,
  87. ?string $maxSizeMessage = null,
  88. ?string $mimeTypesMessage = null,
  89. ?string $disallowEmptyMessage = null,
  90. ?string $filenameTooLongMessage = null,
  92. ?string $uploadIniSizeErrorMessage = null,
  93. ?string $uploadFormSizeErrorMessage = null,
  94. ?string $uploadPartialErrorMessage = null,
  95. ?string $uploadNoFileErrorMessage = null,
  96. ?string $uploadNoTmpDirErrorMessage = null,
  97. ?string $uploadCantWriteErrorMessage = null,
  98. ?string $uploadExtensionErrorMessage = null,
  99. ?string $uploadErrorMessage = null,
  100. ?array $groups = null,
  101. mixed $payload = null,
  103. array|string|null $extensions = null,
  104. ?string $extensionsMessage = null,
  105. ) {
  106. parent::__construct($options, $groups, $payload);
  108. $this->maxSize = $maxSize ?? $this->maxSize;
  109. $this->binaryFormat = $binaryFormat ?? $this->binaryFormat;
  110. $this->mimeTypes = $mimeTypes ?? $this->mimeTypes;
  111. $this->filenameMaxLength = $filenameMaxLength ?? $this->filenameMaxLength;
  112. $this->extensions = $extensions ?? $this->extensions;
  113. $this->notFoundMessage = $notFoundMessage ?? $this->notFoundMessage;
  114. $this->notReadableMessage = $notReadableMessage ?? $this->notReadableMessage;
  115. $this->maxSizeMessage = $maxSizeMessage ?? $this->maxSizeMessage;
  116. $this->mimeTypesMessage = $mimeTypesMessage ?? $this->mimeTypesMessage;
  117. $this->extensionsMessage = $extensionsMessage ?? $this->extensionsMessage;
  118. $this->disallowEmptyMessage = $disallowEmptyMessage ?? $this->disallowEmptyMessage;
  119. $this->filenameTooLongMessage = $filenameTooLongMessage ?? $this->filenameTooLongMessage;
  120. $this->uploadIniSizeErrorMessage = $uploadIniSizeErrorMessage ?? $this->uploadIniSizeErrorMessage;
  121. $this->uploadFormSizeErrorMessage = $uploadFormSizeErrorMessage ?? $this->uploadFormSizeErrorMessage;
  122. $this->uploadPartialErrorMessage = $uploadPartialErrorMessage ?? $this->uploadPartialErrorMessage;
  123. $this->uploadNoFileErrorMessage = $uploadNoFileErrorMessage ?? $this->uploadNoFileErrorMessage;
  124. $this->uploadNoTmpDirErrorMessage = $uploadNoTmpDirErrorMessage ?? $this->uploadNoTmpDirErrorMessage;
  125. $this->uploadCantWriteErrorMessage = $uploadCantWriteErrorMessage ?? $this->uploadCantWriteErrorMessage;
  126. $this->uploadExtensionErrorMessage = $uploadExtensionErrorMessage ?? $this->uploadExtensionErrorMessage;
  127. $this->uploadErrorMessage = $uploadErrorMessage ?? $this->uploadErrorMessage;
  129. if (null !== $this->maxSize) {
  130. $this->normalizeBinaryFormat($this->maxSize);
  131. }
  132. }
  134. /**
  135. * @return void
  136. */
  137. public function __set(string $option, mixed $value)
  138. {
  139. if ('maxSize' === $option) {
  140. $this->normalizeBinaryFormat($value);
  142. return;
  143. }
  145. parent::__set($option, $value);
  146. }
  148. public function __get(string $option): mixed
  149. {
  150. if ('maxSize' === $option) {
  151. return $this->maxSize;
  152. }
  154. return parent::__get($option);
  155. }
  157. public function __isset(string $option): bool
  158. {
  159. if ('maxSize' === $option) {
  160. return true;
  161. }
  163. return parent::__isset($option);
  164. }
  166. private function normalizeBinaryFormat(int|string $maxSize): void
  167. {
  168. $factors = [
  169. 'k' => 1000,
  170. 'ki' => 1 << 10,
  171. 'm' => 1000 * 1000,
  172. 'mi' => 1 << 20,
  173. 'g' => 1000 * 1000 * 1000,
  174. 'gi' => 1 << 30,
  175. ];
  176. if (ctype_digit((string) $maxSize)) {
  177. $this->maxSize = (int) $maxSize;
  178. $this->binaryFormat ??= false;
  179. } elseif (preg_match('/^(\d++)('.implode('|', array_keys($factors)).')$/i', $maxSize, $matches)) {
  180. $this->maxSize = $matches[1] * $factors[$unit = strtolower($matches[2])];
  181. $this->binaryFormat ??= 2 === \strlen($unit);
  182. } else {
  183. throw new ConstraintDefinitionException(\sprintf('"%s" is not a valid maximum size.', $maxSize));
  184. }
  185. }
  186. }