package and depencies

vendor/symfony/translation/Extractor/AbstractFileExtractor.php

@@ -20,12 +20,7 @@ use Symfony\Component\Translation\Exception\InvalidArgumentException;
  */
 abstract class AbstractFileExtractor
 {
-    /**
-     * @param string|iterable $resource Files, a file or a directory
-     *
-     * @return iterable
-     */
-    protected function extractFiles($resource)
+    protected function extractFiles(string|iterable $resource): iterable
     {
         if (is_iterable($resource)) {
             $files = [];
@@ -49,11 +44,9 @@ abstract class AbstractFileExtractor
     }
 
     /**
-     * @return bool
-     *
      * @throws InvalidArgumentException
      */
-    protected function isFile(string $file)
+    protected function isFile(string $file): bool
     {
         if (!is_file($file)) {
             throw new InvalidArgumentException(sprintf('The "%s" file does not exist.', $file));
@@ -68,9 +61,7 @@ abstract class AbstractFileExtractor
     abstract protected function canBeExtracted(string $file);
 
     /**
-     * @param string|array $resource Files, a file or a directory
-     *
      * @return iterable
      */
-    abstract protected function extractFromDirectory($resource);
+    abstract protected function extractFromDirectory(string|array $resource);
 }

vendor/symfony/translation/Extractor/ChainExtractor.php

@@ -25,7 +25,7 @@ class ChainExtractor implements ExtractorInterface
      *
      * @var ExtractorInterface[]
      */
-    private $extractors = [];
+    private array $extractors = [];
 
     /**
      * Adds a loader to the translation extractor.
@@ -35,9 +35,6 @@ class ChainExtractor implements ExtractorInterface
         $this->extractors[$format] = $extractor;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function setPrefix(string $prefix)
     {
         foreach ($this->extractors as $extractor) {
@@ -45,10 +42,7 @@ class ChainExtractor implements ExtractorInterface
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function extract($directory, MessageCatalogue $catalogue)
+    public function extract(string|iterable $directory, MessageCatalogue $catalogue)
     {
         foreach ($this->extractors as $extractor) {
             $extractor->extract($directory, $catalogue);

vendor/symfony/translation/Extractor/ExtractorInterface.php

@@ -26,7 +26,7 @@ interface ExtractorInterface
      *
      * @param string|iterable<string> $resource Files, a file or a directory
      */
-    public function extract($resource, MessageCatalogue $catalogue);
+    public function extract(string|iterable $resource, MessageCatalogue $catalogue);
 
     /**
      * Sets the prefix that should be used for new found messages.

vendor/symfony/translation/Extractor/PhpAstExtractor.php

@@ -0,0 +1,78 @@
+<?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\Translation\Extractor;
+
+use PhpParser\NodeTraverser;
+use PhpParser\NodeVisitor;
+use PhpParser\Parser;
+use PhpParser\ParserFactory;
+use Symfony\Component\Finder\Finder;
+use Symfony\Component\Translation\Extractor\Visitor\AbstractVisitor;
+use Symfony\Component\Translation\MessageCatalogue;
+
+/**
+ * PhpAstExtractor extracts translation messages from a PHP AST.
+ *
+ * @author Mathieu Santostefano <msantostefano@protonmail.com>
+ */
+final class PhpAstExtractor extends AbstractFileExtractor implements ExtractorInterface
+{
+    private Parser $parser;
+
+    public function __construct(
+        /**
+         * @param iterable<AbstractVisitor&NodeVisitor> $visitors
+         */
+        private readonly iterable $visitors,
+        private string $prefix = '',
+    ) {
+        if (!class_exists(ParserFactory::class)) {
+            throw new \LogicException(sprintf('You cannot use "%s" as the "nikic/php-parser" package is not installed. Try running "composer require nikic/php-parser".', static::class));
+        }
+
+        $this->parser = (new ParserFactory())->create(ParserFactory::PREFER_PHP7);
+    }
+
+    public function extract(iterable|string $resource, MessageCatalogue $catalogue): void
+    {
+        foreach ($this->extractFiles($resource) as $file) {
+            $traverser = new NodeTraverser();
+            /** @var AbstractVisitor&NodeVisitor $visitor */
+            foreach ($this->visitors as $visitor) {
+                $visitor->initialize($catalogue, $file, $this->prefix);
+                $traverser->addVisitor($visitor);
+            }
+
+            $nodes = $this->parser->parse(file_get_contents($file));
+            $traverser->traverse($nodes);
+        }
+    }
+
+    public function setPrefix(string $prefix): void
+    {
+        $this->prefix = $prefix;
+    }
+
+    protected function canBeExtracted(string $file): bool
+    {
+        return 'php' === pathinfo($file, \PATHINFO_EXTENSION) && $this->isFile($file);
+    }
+
+    protected function extractFromDirectory(array|string $resource): iterable|Finder
+    {
+        if (!class_exists(Finder::class)) {
+            throw new \LogicException(sprintf('You cannot use "%s" as the "symfony/finder" package is not installed. Try running "composer require symfony/finder".', static::class));
+        }
+
+        return (new Finder())->files()->name('*.php')->in($resource);
+    }
+}

vendor/symfony/translation/Extractor/PhpExtractor.php

@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Translation\Extractor;
 
+trigger_deprecation('symfony/translation', '6.2', '"%s" is deprecated, use "%s" instead.', PhpExtractor::class, PhpAstExtractor::class);
+
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\Translation\MessageCatalogue;
 
@@ -18,6 +20,8 @@ use Symfony\Component\Translation\MessageCatalogue;
  * PhpExtractor extracts translation messages from a PHP template.
  *
  * @author Michel Salib <michelsalib@hotmail.com>
+ *
+ * @deprecated since Symfony 6.2, use the PhpAstExtractor instead
  */
 class PhpExtractor extends AbstractFileExtractor implements ExtractorInterface
 {
@@ -28,7 +32,7 @@ class PhpExtractor extends AbstractFileExtractor implements ExtractorInterface
     /**
      * Prefix for new found message.
      */
-    private $prefix = '';
+    private string $prefix = '';
 
     /**
      * The sequence that captures translation messages.
@@ -128,10 +132,7 @@ class PhpExtractor extends AbstractFileExtractor implements ExtractorInterface
         ],
     ];
 
-    /**
-     * {@inheritdoc}
-     */
-    public function extract($resource, MessageCatalogue $catalog)
+    public function extract(string|iterable $resource, MessageCatalogue $catalog)
     {
         $files = $this->extractFiles($resource);
         foreach ($files as $file) {
@@ -141,9 +142,6 @@ class PhpExtractor extends AbstractFileExtractor implements ExtractorInterface
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function setPrefix(string $prefix)
     {
         $this->prefix = $prefix;
@@ -151,12 +149,8 @@ class PhpExtractor extends AbstractFileExtractor implements ExtractorInterface
 
     /**
      * Normalizes a token.
-     *
-     * @param mixed $token
-     *
-     * @return string|null
      */
-    protected function normalizeToken($token)
+    protected function normalizeToken(mixed $token): ?string
     {
         if (isset($token[1]) && 'b"' !== $token) {
             return $token[1];
@@ -311,19 +305,14 @@ class PhpExtractor extends AbstractFileExtractor implements ExtractorInterface
     }
 
     /**
-     * @return bool
-     *
      * @throws \InvalidArgumentException
      */
-    protected function canBeExtracted(string $file)
+    protected function canBeExtracted(string $file): bool
     {
         return $this->isFile($file) && 'php' === pathinfo($file, \PATHINFO_EXTENSION);
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function extractFromDirectory($directory)
+    protected function extractFromDirectory(string|array $directory): iterable
     {
         if (!class_exists(Finder::class)) {
             throw new \LogicException(sprintf('You cannot use "%s" as the "symfony/finder" package is not installed. Try running "composer require symfony/finder".', static::class));

vendor/symfony/translation/Extractor/PhpStringTokenParser.php

@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Translation\Extractor;
 
+trigger_deprecation('symfony/translation', '6.2', '"%s" is deprecated.', PhpStringTokenParser::class);
+
 /*
  * The following is derived from code at http://github.com/nikic/PHP-Parser
  *
@@ -47,6 +49,9 @@ namespace Symfony\Component\Translation\Extractor;
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+/**
+ * @deprecated since Symfony 6.2
+ */
 class PhpStringTokenParser
 {
     protected static $replacements = [
@@ -64,10 +69,8 @@ class PhpStringTokenParser
      * Parses a string token.
      *
      * @param string $str String token content
-     *
-     * @return string
      */
-    public static function parse(string $str)
+    public static function parse(string $str): string
     {
         $bLength = 0;
         if ('b' === $str[0]) {
@@ -90,10 +93,8 @@ class PhpStringTokenParser
      *
      * @param string      $str   String without quotes
      * @param string|null $quote Quote type
-     *
-     * @return string
      */
-    public static function parseEscapeSequences(string $str, string $quote = null)
+    public static function parseEscapeSequences(string $str, string $quote = null): string
     {
         if (null !== $quote) {
             $str = str_replace('\\'.$quote, $quote, $str);
@@ -124,10 +125,8 @@ class PhpStringTokenParser
      *
      * @param string $startToken Doc string start token content (<<<SMTHG)
      * @param string $str        String token content
-     *
-     * @return string
      */
-    public static function parseDocString(string $startToken, string $str)
+    public static function parseDocString(string $startToken, string $str): string
     {
         // strip last newline (thanks tokenizer for sticking it into the string!)
         $str = preg_replace('~(\r\n|\n|\r)$~', '', $str);

vendor/symfony/translation/Extractor/Visitor/AbstractVisitor.php

@@ -0,0 +1,111 @@
+<?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\Translation\Extractor\Visitor;
+
+use PhpParser\Node;
+use Symfony\Component\Translation\MessageCatalogue;
+
+/**
+ * @author Mathieu Santostefano <msantostefano@protonmail.com>
+ */
+abstract class AbstractVisitor
+{
+    private MessageCatalogue $catalogue;
+    private \SplFileInfo $file;
+    private string $messagePrefix;
+
+    public function initialize(MessageCatalogue $catalogue, \SplFileInfo $file, string $messagePrefix): void
+    {
+        $this->catalogue = $catalogue;
+        $this->file = $file;
+        $this->messagePrefix = $messagePrefix;
+    }
+
+    protected function addMessageToCatalogue(string $message, ?string $domain, int $line): void
+    {
+        $domain ??= 'messages';
+        $this->catalogue->set($message, $this->messagePrefix.$message, $domain);
+        $metadata = $this->catalogue->getMetadata($message, $domain) ?? [];
+        $normalizedFilename = preg_replace('{[\\\\/]+}', '/', $this->file);
+        $metadata['sources'][] = $normalizedFilename.':'.$line;
+        $this->catalogue->setMetadata($message, $metadata, $domain);
+    }
+
+    protected function getStringArguments(Node\Expr\CallLike|Node\Attribute|Node\Expr\New_ $node, int|string $index, bool $indexIsRegex = false): array
+    {
+        if (\is_string($index)) {
+            return $this->getStringNamedArguments($node, $index, $indexIsRegex);
+        }
+
+        $args = $node instanceof Node\Expr\CallLike ? $node->getRawArgs() : $node->args;
+
+        if (!($arg = $args[$index] ?? null) instanceof Node\Arg) {
+            return [];
+        }
+
+        return (array) $this->getStringValue($arg->value);
+    }
+
+    protected function hasNodeNamedArguments(Node\Expr\CallLike|Node\Attribute|Node\Expr\New_ $node): bool
+    {
+        $args = $node instanceof Node\Expr\CallLike ? $node->getRawArgs() : $node->args;
+
+        foreach ($args as $arg) {
+            if ($arg instanceof Node\Arg && null !== $arg->name) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    private function getStringNamedArguments(Node\Expr\CallLike|Node\Attribute $node, string $argumentName = null, bool $isArgumentNamePattern = false): array
+    {
+        $args = $node instanceof Node\Expr\CallLike ? $node->getArgs() : $node->args;
+        $argumentValues = [];
+
+        foreach ($args as $arg) {
+            if (!$isArgumentNamePattern && $arg->name?->toString() === $argumentName) {
+                $argumentValues[] = $this->getStringValue($arg->value);
+            } elseif ($isArgumentNamePattern && preg_match($argumentName, $arg->name?->toString() ?? '') > 0) {
+                $argumentValues[] = $this->getStringValue($arg->value);
+            }
+        }
+
+        return array_filter($argumentValues);
+    }
+
+    private function getStringValue(Node $node): ?string
+    {
+        if ($node instanceof Node\Scalar\String_) {
+            return $node->value;
+        }
+
+        if ($node instanceof Node\Expr\BinaryOp\Concat) {
+            if (null === $left = $this->getStringValue($node->left)) {
+                return null;
+            }
+
+            if (null === $right = $this->getStringValue($node->right)) {
+                return null;
+            }
+
+            return $left.$right;
+        }
+
+        if ($node instanceof Node\Expr\Assign && $node->expr instanceof Node\Scalar\String_) {
+            return $node->expr->value;
+        }
+
+        return null;
+    }
+}

vendor/symfony/translation/Extractor/Visitor/ConstraintVisitor.php

@@ -0,0 +1,114 @@
+<?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\Translation\Extractor\Visitor;
+
+use PhpParser\Node;
+use PhpParser\NodeVisitor;
+
+/**
+ * @author Mathieu Santostefano <msantostefano@protonmail.com>
+ *
+ * Code mostly comes from https://github.com/php-translation/extractor/blob/master/src/Visitor/Php/Symfony/Constraint.php
+ */
+final class ConstraintVisitor extends AbstractVisitor implements NodeVisitor
+{
+    private const CONSTRAINT_VALIDATION_MESSAGE_PATTERN = '/[a-zA-Z]*message/i';
+
+    public function __construct(
+        private readonly array $constraintClassNames = []
+    ) {
+    }
+
+    public function beforeTraverse(array $nodes): ?Node
+    {
+        return null;
+    }
+
+    public function enterNode(Node $node): ?Node
+    {
+        if (!$node instanceof Node\Expr\New_ && !$node instanceof Node\Attribute) {
+            return null;
+        }
+
+        $className = $node instanceof Node\Attribute ? $node->name : $node->class;
+        if (!$className instanceof Node\Name) {
+            return null;
+        }
+
+        $parts = $className->parts;
+        $isConstraintClass = false;
+
+        foreach ($parts as $part) {
+            if (\in_array($part, $this->constraintClassNames, true)) {
+                $isConstraintClass = true;
+
+                break;
+            }
+        }
+
+        if (!$isConstraintClass) {
+            return null;
+        }
+
+        $arg = $node->args[0] ?? null;
+        if (!$arg instanceof Node\Arg) {
+            return null;
+        }
+
+        if ($this->hasNodeNamedArguments($node)) {
+            $messages = $this->getStringArguments($node, self::CONSTRAINT_VALIDATION_MESSAGE_PATTERN, true);
+        } else {
+            if (!$arg->value instanceof Node\Expr\Array_) {
+                // There is no way to guess which argument is a message to be translated.
+                return null;
+            }
+
+            $messages = [];
+            $options = $arg->value;
+
+            /** @var Node\Expr\ArrayItem $item */
+            foreach ($options->items as $item) {
+                if (!$item->key instanceof Node\Scalar\String_) {
+                    continue;
+                }
+
+                if (!preg_match(self::CONSTRAINT_VALIDATION_MESSAGE_PATTERN, $item->key->value ?? '')) {
+                    continue;
+                }
+
+                if (!$item->value instanceof Node\Scalar\String_) {
+                    continue;
+                }
+
+                $messages[] = $item->value->value;
+
+                break;
+            }
+        }
+
+        foreach ($messages as $message) {
+            $this->addMessageToCatalogue($message, 'validators', $node->getStartLine());
+        }
+
+        return null;
+    }
+
+    public function leaveNode(Node $node): ?Node
+    {
+        return null;
+    }
+
+    public function afterTraverse(array $nodes): ?Node
+    {
+        return null;
+    }
+}

vendor/symfony/translation/Extractor/Visitor/TransMethodVisitor.php

@@ -0,0 +1,64 @@
+<?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\Translation\Extractor\Visitor;
+
+use PhpParser\Node;
+use PhpParser\NodeVisitor;
+
+/**
+ * @author Mathieu Santostefano <msantostefano@protonmail.com>
+ */
+final class TransMethodVisitor extends AbstractVisitor implements NodeVisitor
+{
+    public function beforeTraverse(array $nodes): ?Node
+    {
+        return null;
+    }
+
+    public function enterNode(Node $node): ?Node
+    {
+        if (!$node instanceof Node\Expr\MethodCall && !$node instanceof Node\Expr\FuncCall) {
+            return null;
+        }
+
+        if (!\is_string($node->name) && !$node->name instanceof Node\Identifier && !$node->name instanceof Node\Name) {
+            return null;
+        }
+
+        $name = (string) $node->name;
+
+        if ('trans' === $name || 't' === $name) {
+            $nodeHasNamedArguments = $this->hasNodeNamedArguments($node);
+            if (!$messages = $this->getStringArguments($node, $nodeHasNamedArguments ? 'message' : 0)) {
+                return null;
+            }
+
+            $domain = $this->getStringArguments($node, $nodeHasNamedArguments ? 'domain' : 2)[0] ?? null;
+
+            foreach ($messages as $message) {
+                $this->addMessageToCatalogue($message, $domain, $node->getStartLine());
+            }
+        }
+
+        return null;
+    }
+
+    public function leaveNode(Node $node): ?Node
+    {
+        return null;
+    }
+
+    public function afterTraverse(array $nodes): ?Node
+    {
+        return null;
+    }
+}

vendor/symfony/translation/Extractor/Visitor/TranslatableMessageVisitor.php

@@ -0,0 +1,65 @@
+<?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\Translation\Extractor\Visitor;
+
+use PhpParser\Node;
+use PhpParser\NodeVisitor;
+
+/**
+ * @author Mathieu Santostefano <msantostefano@protonmail.com>
+ */
+final class TranslatableMessageVisitor extends AbstractVisitor implements NodeVisitor
+{
+    public function beforeTraverse(array $nodes): ?Node
+    {
+        return null;
+    }
+
+    public function enterNode(Node $node): ?Node
+    {
+        if (!$node instanceof Node\Expr\New_) {
+            return null;
+        }
+
+        if (!($className = $node->class) instanceof Node\Name) {
+            return null;
+        }
+
+        if (!\in_array('TranslatableMessage', $className->parts, true)) {
+            return null;
+        }
+
+        $nodeHasNamedArguments = $this->hasNodeNamedArguments($node);
+
+        if (!$messages = $this->getStringArguments($node, $nodeHasNamedArguments ? 'message' : 0)) {
+            return null;
+        }
+
+        $domain = $this->getStringArguments($node, $nodeHasNamedArguments ? 'domain' : 2)[0] ?? null;
+
+        foreach ($messages as $message) {
+            $this->addMessageToCatalogue($message, $domain, $node->getStartLine());
+        }
+
+        return null;
+    }
+
+    public function leaveNode(Node $node): ?Node
+    {
+        return null;
+    }
+
+    public function afterTraverse(array $nodes): ?Node
+    {
+        return null;
+    }
+}