123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252 |
- <?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\Validator\Constraints;
- use Symfony\Component\HttpFoundation\File\File as FileObject;
- use Symfony\Component\HttpFoundation\File\UploadedFile;
- use Symfony\Component\Mime\MimeTypes;
- use Symfony\Component\Validator\Constraint;
- use Symfony\Component\Validator\ConstraintValidator;
- use Symfony\Component\Validator\Exception\LogicException;
- use Symfony\Component\Validator\Exception\UnexpectedTypeException;
- use Symfony\Component\Validator\Exception\UnexpectedValueException;
- /**
- * @author Bernhard Schussek <bschussek@gmail.com>
- */
- class FileValidator extends ConstraintValidator
- {
- public const KB_BYTES = 1000;
- public const MB_BYTES = 1000000;
- public const KIB_BYTES = 1024;
- public const MIB_BYTES = 1048576;
- private const SUFFICES = [
- 1 => 'bytes',
- self::KB_BYTES => 'kB',
- self::MB_BYTES => 'MB',
- self::KIB_BYTES => 'KiB',
- self::MIB_BYTES => 'MiB',
- ];
- /**
- * {@inheritdoc}
- */
- public function validate($value, Constraint $constraint)
- {
- if (!$constraint instanceof File) {
- throw new UnexpectedTypeException($constraint, File::class);
- }
- if (null === $value || '' === $value) {
- return;
- }
- if ($value instanceof UploadedFile && !$value->isValid()) {
- switch ($value->getError()) {
- case \UPLOAD_ERR_INI_SIZE:
- $iniLimitSize = UploadedFile::getMaxFilesize();
- if ($constraint->maxSize && $constraint->maxSize < $iniLimitSize) {
- $limitInBytes = $constraint->maxSize;
- $binaryFormat = $constraint->binaryFormat;
- } else {
- $limitInBytes = $iniLimitSize;
- $binaryFormat = null === $constraint->binaryFormat ? true : $constraint->binaryFormat;
- }
- [, $limitAsString, $suffix] = $this->factorizeSizes(0, $limitInBytes, $binaryFormat);
- $this->context->buildViolation($constraint->uploadIniSizeErrorMessage)
- ->setParameter('{{ limit }}', $limitAsString)
- ->setParameter('{{ suffix }}', $suffix)
- ->setCode((string) \UPLOAD_ERR_INI_SIZE)
- ->addViolation();
- return;
- case \UPLOAD_ERR_FORM_SIZE:
- $this->context->buildViolation($constraint->uploadFormSizeErrorMessage)
- ->setCode((string) \UPLOAD_ERR_FORM_SIZE)
- ->addViolation();
- return;
- case \UPLOAD_ERR_PARTIAL:
- $this->context->buildViolation($constraint->uploadPartialErrorMessage)
- ->setCode((string) \UPLOAD_ERR_PARTIAL)
- ->addViolation();
- return;
- case \UPLOAD_ERR_NO_FILE:
- $this->context->buildViolation($constraint->uploadNoFileErrorMessage)
- ->setCode((string) \UPLOAD_ERR_NO_FILE)
- ->addViolation();
- return;
- case \UPLOAD_ERR_NO_TMP_DIR:
- $this->context->buildViolation($constraint->uploadNoTmpDirErrorMessage)
- ->setCode((string) \UPLOAD_ERR_NO_TMP_DIR)
- ->addViolation();
- return;
- case \UPLOAD_ERR_CANT_WRITE:
- $this->context->buildViolation($constraint->uploadCantWriteErrorMessage)
- ->setCode((string) \UPLOAD_ERR_CANT_WRITE)
- ->addViolation();
- return;
- case \UPLOAD_ERR_EXTENSION:
- $this->context->buildViolation($constraint->uploadExtensionErrorMessage)
- ->setCode((string) \UPLOAD_ERR_EXTENSION)
- ->addViolation();
- return;
- default:
- $this->context->buildViolation($constraint->uploadErrorMessage)
- ->setCode((string) $value->getError())
- ->addViolation();
- return;
- }
- }
- if (!is_scalar($value) && !$value instanceof FileObject && !(\is_object($value) && method_exists($value, '__toString'))) {
- throw new UnexpectedValueException($value, 'string');
- }
- $path = $value instanceof FileObject ? $value->getPathname() : (string) $value;
- if (!is_file($path)) {
- $this->context->buildViolation($constraint->notFoundMessage)
- ->setParameter('{{ file }}', $this->formatValue($path))
- ->setCode(File::NOT_FOUND_ERROR)
- ->addViolation();
- return;
- }
- if (!is_readable($path)) {
- $this->context->buildViolation($constraint->notReadableMessage)
- ->setParameter('{{ file }}', $this->formatValue($path))
- ->setCode(File::NOT_READABLE_ERROR)
- ->addViolation();
- return;
- }
- $sizeInBytes = filesize($path);
- $basename = $value instanceof UploadedFile ? $value->getClientOriginalName() : basename($path);
- if (0 === $sizeInBytes) {
- $this->context->buildViolation($constraint->disallowEmptyMessage)
- ->setParameter('{{ file }}', $this->formatValue($path))
- ->setParameter('{{ name }}', $this->formatValue($basename))
- ->setCode(File::EMPTY_ERROR)
- ->addViolation();
- return;
- }
- if ($constraint->maxSize) {
- $limitInBytes = $constraint->maxSize;
- if ($sizeInBytes > $limitInBytes) {
- [$sizeAsString, $limitAsString, $suffix] = $this->factorizeSizes($sizeInBytes, $limitInBytes, $constraint->binaryFormat);
- $this->context->buildViolation($constraint->maxSizeMessage)
- ->setParameter('{{ file }}', $this->formatValue($path))
- ->setParameter('{{ size }}', $sizeAsString)
- ->setParameter('{{ limit }}', $limitAsString)
- ->setParameter('{{ suffix }}', $suffix)
- ->setParameter('{{ name }}', $this->formatValue($basename))
- ->setCode(File::TOO_LARGE_ERROR)
- ->addViolation();
- return;
- }
- }
- if ($constraint->mimeTypes) {
- if ($value instanceof FileObject) {
- $mime = $value->getMimeType();
- } elseif (class_exists(MimeTypes::class)) {
- $mime = MimeTypes::getDefault()->guessMimeType($path);
- } elseif (!class_exists(FileObject::class)) {
- throw new LogicException('You cannot validate the mime-type of files as the Mime component is not installed. Try running "composer require symfony/mime".');
- } else {
- $mime = (new FileObject($value))->getMimeType();
- }
- $mimeTypes = (array) $constraint->mimeTypes;
- foreach ($mimeTypes as $mimeType) {
- if ($mimeType === $mime) {
- return;
- }
- if ($discrete = strstr($mimeType, '/*', true)) {
- if (strstr($mime, '/', true) === $discrete) {
- return;
- }
- }
- }
- $this->context->buildViolation($constraint->mimeTypesMessage)
- ->setParameter('{{ file }}', $this->formatValue($path))
- ->setParameter('{{ type }}', $this->formatValue($mime))
- ->setParameter('{{ types }}', $this->formatValues($mimeTypes))
- ->setParameter('{{ name }}', $this->formatValue($basename))
- ->setCode(File::INVALID_MIME_TYPE_ERROR)
- ->addViolation();
- }
- }
- private static function moreDecimalsThan(string $double, int $numberOfDecimals): bool
- {
- return \strlen($double) > \strlen(round($double, $numberOfDecimals));
- }
- /**
- * Convert the limit to the smallest possible number
- * (i.e. try "MB", then "kB", then "bytes").
- *
- * @param int|float $limit
- */
- private function factorizeSizes(int $size, $limit, bool $binaryFormat): array
- {
- if ($binaryFormat) {
- $coef = self::MIB_BYTES;
- $coefFactor = self::KIB_BYTES;
- } else {
- $coef = self::MB_BYTES;
- $coefFactor = self::KB_BYTES;
- }
- $limitAsString = (string) ($limit / $coef);
- // Restrict the limit to 2 decimals (without rounding! we
- // need the precise value)
- while (self::moreDecimalsThan($limitAsString, 2)) {
- $coef /= $coefFactor;
- $limitAsString = (string) ($limit / $coef);
- }
- // Convert size to the same measure, but round to 2 decimals
- $sizeAsString = (string) round($size / $coef, 2);
- // If the size and limit produce the same string output
- // (due to rounding), reduce the coefficient
- while ($sizeAsString === $limitAsString) {
- $coef /= $coefFactor;
- $limitAsString = (string) ($limit / $coef);
- $sizeAsString = (string) round($size / $coef, 2);
- }
- return [$sizeAsString, $limitAsString, self::SUFFICES[$coef]];
- }
- }
|