vendor/symfony/validator/Constraints/IsbnValidator.php line 169

  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\ConstraintValidator;
  16. use Symfony\Component\Validator\Exception\UnexpectedTypeException;
  17. use Symfony\Component\Validator\Exception\UnexpectedValueException;
  19. /**
  20.  * Validates whether the value is a valid ISBN-10 or ISBN-13.
  21.  *
  22.  * @author The Whole Life To Learn <thewholelifetolearn@gmail.com>
  23.  * @author Manuel Reinhard <manu@sprain.ch>
  24.  * @author Bernhard Schussek <bschussek@gmail.com>
  25.  *
  26.  * @see https://en.wikipedia.org/wiki/Isbn
  27.  */
  28. class IsbnValidator extends ConstraintValidator
  29. {
  30.     public function validate(mixed $value, Constraint $constraint)
  31.     {
  32.         if (!$constraint instanceof Isbn) {
  33.             throw new UnexpectedTypeException($constraint, Isbn::class);
  34.         }
  36.         if (null === $value || '' === $value) {
  37.             return;
  38.         }
  40.         if (!\is_scalar($value) && !$value instanceof \Stringable) {
  41.             throw new UnexpectedValueException($value, 'string');
  42.         }
  44.         $value = (string) $value;
  45.         $canonical = str_replace('-', '', $value);
  47.         // Explicitly validate against ISBN-10
  48.         if (Isbn::ISBN_10 === $constraint->type) {
  49.             if (true !== ($code = $this->validateIsbn10($canonical))) {
  50.                 $this->context->buildViolation($this->getMessage($constraint, $constraint->type))
  51.                     ->setParameter('{{ value }}', $this->formatValue($value))
  52.                     ->setCode($code)
  53.                     ->addViolation();
  54.             }
  56.             return;
  57.         }
  59.         // Explicitly validate against ISBN-13
  60.         if (Isbn::ISBN_13 === $constraint->type) {
  61.             if (true !== ($code = $this->validateIsbn13($canonical))) {
  62.                 $this->context->buildViolation($this->getMessage($constraint, $constraint->type))
  63.                     ->setParameter('{{ value }}', $this->formatValue($value))
  64.                     ->setCode($code)
  65.                     ->addViolation();
  66.             }
  68.             return;
  69.         }
  71.         // Try both ISBNs
  73.         // First, try ISBN-10
  74.         $code = $this->validateIsbn10($canonical);
  76.         // The ISBN can only be an ISBN-13 if the value was too long for ISBN-10
  77.         if (Isbn::TOO_LONG_ERROR === $code) {
  78.             // Try ISBN-13 now
  79.             $code = $this->validateIsbn13($canonical);
  81.             // If too short, this means we have 11 or 12 digits
  82.             if (Isbn::TOO_SHORT_ERROR === $code) {
  83.                 $code = Isbn::TYPE_NOT_RECOGNIZED_ERROR;
  84.             }
  85.         }
  87.         if (true !== $code) {
  88.             $this->context->buildViolation($this->getMessage($constraint))
  89.                 ->setParameter('{{ value }}', $this->formatValue($value))
  90.                 ->setCode($code)
  91.                 ->addViolation();
  92.         }
  93.     }
  95.     protected function validateIsbn10(string $isbn)
  96.     {
  97.         // Choose an algorithm so that ERROR_INVALID_CHARACTERS is preferred
  98.         // over ERROR_TOO_SHORT/ERROR_TOO_LONG
  99.         // Otherwise "0-45122-5244" passes, but "0-45122_5244" reports
  100.         // "too long"
  102.         // Error priority:
  103.         // 1. ERROR_INVALID_CHARACTERS
  104.         // 2. ERROR_TOO_SHORT/ERROR_TOO_LONG
  105.         // 3. ERROR_CHECKSUM_FAILED
  107.         $checkSum = 0;
  109.         for ($i = 0; $i < 10; ++$i) {
  110.             // If we test the length before the loop, we get an ERROR_TOO_SHORT
  111.             // when actually an ERROR_INVALID_CHARACTERS is wanted, e.g. for
  112.             // "0-45122_5244" (typo)
  113.             if (!isset($isbn[$i])) {
  114.                 return Isbn::TOO_SHORT_ERROR;
  115.             }
  117.             if ('X' === $isbn[$i]) {
  118.                 $digit = 10;
  119.             } elseif (ctype_digit($isbn[$i])) {
  120.                 $digit = $isbn[$i];
  121.             } else {
  122.                 return Isbn::INVALID_CHARACTERS_ERROR;
  123.             }
  125.             $checkSum += $digit * (10 - $i);
  126.         }
  128.         if (isset($isbn[$i])) {
  129.             return Isbn::TOO_LONG_ERROR;
  130.         }
  132.         return 0 === $checkSum % 11 ? true : Isbn::CHECKSUM_FAILED_ERROR;
  133.     }
  135.     protected function validateIsbn13(string $isbn)
  136.     {
  137.         // Error priority:
  138.         // 1. ERROR_INVALID_CHARACTERS
  139.         // 2. ERROR_TOO_SHORT/ERROR_TOO_LONG
  140.         // 3. ERROR_CHECKSUM_FAILED
  142.         if (!ctype_digit($isbn)) {
  143.             return Isbn::INVALID_CHARACTERS_ERROR;
  144.         }
  146.         $length = \strlen($isbn);
  148.         if ($length < 13) {
  149.             return Isbn::TOO_SHORT_ERROR;
  150.         }
  152.         if ($length > 13) {
  153.             return Isbn::TOO_LONG_ERROR;
  154.         }
  156.         $checkSum = 0;
  158.         for ($i = 0; $i < 13; $i += 2) {
  159.             $checkSum += $isbn[$i];
  160.         }
  162.         for ($i = 1; $i < 12; $i += 2) {
  163.             $checkSum += $isbn[$i] * 3;
  164.         }
  166.         return 0 === $checkSum % 10 ? true : Isbn::CHECKSUM_FAILED_ERROR;
  167.     }
  169.     protected function getMessage(Isbn $constraint, string $type = null)
  170.     {
  171.         if (null !== $constraint->message) {
  172.             return $constraint->message;
  173.         } elseif (Isbn::ISBN_10 === $type) {
  174.             return $constraint->isbn10Message;
  175.         } elseif (Isbn::ISBN_13 === $type) {
  176.             return $constraint->isbn13Message;
  177.         }
  179.         return $constraint->bothIsbnMessage;
  180.     }
  181. }