vendor/symfony/framework-bundle/Command/TranslationDebugCommand.php line 62

  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\Bundle\FrameworkBundle\Command;
  14. use Symfony\Component\Console\Attribute\AsCommand;
  15. use Symfony\Component\Console\Command\Command;
  16. use Symfony\Component\Console\Completion\CompletionInput;
  17. use Symfony\Component\Console\Completion\CompletionSuggestions;
  18. use Symfony\Component\Console\Exception\InvalidArgumentException;
  19. use Symfony\Component\Console\Input\InputArgument;
  20. use Symfony\Component\Console\Input\InputInterface;
  21. use Symfony\Component\Console\Input\InputOption;
  22. use Symfony\Component\Console\Output\OutputInterface;
  23. use Symfony\Component\Console\Style\SymfonyStyle;
  24. use Symfony\Component\HttpKernel\KernelInterface;
  25. use Symfony\Component\Translation\Catalogue\MergeOperation;
  26. use Symfony\Component\Translation\DataCollectorTranslator;
  27. use Symfony\Component\Translation\Extractor\ExtractorInterface;
  28. use Symfony\Component\Translation\LoggingTranslator;
  29. use Symfony\Component\Translation\MessageCatalogue;
  30. use Symfony\Component\Translation\Reader\TranslationReaderInterface;
  31. use Symfony\Component\Translation\Translator;
  32. use Symfony\Contracts\Translation\TranslatorInterface;
  34. /**
  35.  * Helps finding unused or missing translation messages in a given locale
  36.  * and comparing them with the fallback ones.
  37.  *
  38.  * @author Florian Voutzinos <florian@voutzinos.com>
  39.  *
  40.  * @final
  41.  */
  42. #[AsCommand(name: 'debug:translation', description: 'Display translation messages information')]
  43. class TranslationDebugCommand extends Command
  44. {
  45.     public const EXIT_CODE_GENERAL_ERROR = 64;
  46.     public const EXIT_CODE_MISSING = 65;
  47.     public const EXIT_CODE_UNUSED = 66;
  48.     public const EXIT_CODE_FALLBACK = 68;
  49.     public const MESSAGE_MISSING = 0;
  50.     public const MESSAGE_UNUSED = 1;
  51.     public const MESSAGE_EQUALS_FALLBACK = 2;
  53.     private TranslatorInterface $translator;
  54.     private TranslationReaderInterface $reader;
  55.     private ExtractorInterface $extractor;
  56.     private ?string $defaultTransPath;
  57.     private ?string $defaultViewsPath;
  58.     private array $transPaths;
  59.     private array $codePaths;
  60.     private array $enabledLocales;
  62.     public function __construct(TranslatorInterface $translator, TranslationReaderInterface $reader, ExtractorInterface $extractor, string $defaultTransPath = null, string $defaultViewsPath = null, array $transPaths = [], array $codePaths = [], array $enabledLocales = [])
  63.     {
  64.         parent::__construct();
  66.         $this->translator = $translator;
  67.         $this->reader = $reader;
  68.         $this->extractor = $extractor;
  69.         $this->defaultTransPath = $defaultTransPath;
  70.         $this->defaultViewsPath = $defaultViewsPath;
  71.         $this->transPaths = $transPaths;
  72.         $this->codePaths = $codePaths;
  73.         $this->enabledLocales = $enabledLocales;
  74.     }
  76.     protected function configure()
  77.     {
  78.         $this
  79.             ->setDefinition([
  80.                 new InputArgument('locale', InputArgument::REQUIRED, 'The locale'),
  81.                 new InputArgument('bundle', InputArgument::OPTIONAL, 'The bundle name or directory where to load the messages'),
  82.                 new InputOption('domain', null, InputOption::VALUE_OPTIONAL, 'The messages domain'),
  83.                 new InputOption('only-missing', null, InputOption::VALUE_NONE, 'Display only missing messages'),
  84.                 new InputOption('only-unused', null, InputOption::VALUE_NONE, 'Display only unused messages'),
  85.                 new InputOption('all', null, InputOption::VALUE_NONE, 'Load messages from all registered bundles'),
  86.             ])
  87.             ->setHelp(<<<'EOF'
  88. The <info>%command.name%</info> command helps finding unused or missing translation
  89. messages and comparing them with the fallback ones by inspecting the
  90. templates and translation files of a given bundle or the default translations directory.
  92. You can display information about bundle translations in a specific locale:
  94.   <info>php %command.full_name% en AcmeDemoBundle</info>
  96. You can also specify a translation domain for the search:
  98.   <info>php %command.full_name% --domain=messages en AcmeDemoBundle</info>
  100. You can only display missing messages:
  102.   <info>php %command.full_name% --only-missing en AcmeDemoBundle</info>
  104. You can only display unused messages:
  106.   <info>php %command.full_name% --only-unused en AcmeDemoBundle</info>
  108. You can display information about application translations in a specific locale:
  110.   <info>php %command.full_name% en</info>
  112. You can display information about translations in all registered bundles in a specific locale:
  114.   <info>php %command.full_name% --all en</info>
  116. EOF
  117.             )
  118.         ;
  119.     }
  121.     protected function execute(InputInterface $input, OutputInterface $output): int
  122.     {
  123.         $io = new SymfonyStyle($input, $output);
  125.         $locale = $input->getArgument('locale');
  126.         $domain = $input->getOption('domain');
  128.         $exitCode = self::SUCCESS;
  130.         /** @var KernelInterface $kernel */
  131.         $kernel = $this->getApplication()->getKernel();
  133.         // Define Root Paths
  134.         $transPaths = $this->getRootTransPaths();
  135.         $codePaths = $this->getRootCodePaths($kernel);
  137.         // Override with provided Bundle info
  138.         if (null !== $input->getArgument('bundle')) {
  139.             try {
  140.                 $bundle = $kernel->getBundle($input->getArgument('bundle'));
  141.                 $bundleDir = $bundle->getPath();
  142.                 $transPaths = [is_dir($bundleDir.'/Resources/translations') ? $bundleDir.'/Resources/translations' : $bundleDir.'/translations'];
  143.                 $codePaths = [is_dir($bundleDir.'/Resources/views') ? $bundleDir.'/Resources/views' : $bundleDir.'/templates'];
  144.                 if ($this->defaultTransPath) {
  145.                     $transPaths[] = $this->defaultTransPath;
  146.                 }
  147.                 if ($this->defaultViewsPath) {
  148.                     $codePaths[] = $this->defaultViewsPath;
  149.                 }
  150.             } catch (\InvalidArgumentException) {
  151.                 // such a bundle does not exist, so treat the argument as path
  152.                 $path = $input->getArgument('bundle');
  154.                 $transPaths = [$path.'/translations'];
  155.                 $codePaths = [$path.'/templates'];
  157.                 if (!is_dir($transPaths[0])) {
  158.                     throw new InvalidArgumentException(sprintf('"%s" is neither an enabled bundle nor a directory.', $transPaths[0]));
  159.                 }
  160.             }
  161.         } elseif ($input->getOption('all')) {
  162.             foreach ($kernel->getBundles() as $bundle) {
  163.                 $bundleDir = $bundle->getPath();
  164.                 $transPaths[] = is_dir($bundleDir.'/Resources/translations') ? $bundleDir.'/Resources/translations' : $bundle->getPath().'/translations';
  165.                 $codePaths[] = is_dir($bundleDir.'/Resources/views') ? $bundleDir.'/Resources/views' : $bundle->getPath().'/templates';
  166.             }
  167.         }
  169.         // Extract used messages
  170.         $extractedCatalogue = $this->extractMessages($locale, $codePaths);
  172.         // Load defined messages
  173.         $currentCatalogue = $this->loadCurrentMessages($locale, $transPaths);
  175.         // Merge defined and extracted messages to get all message ids
  176.         $mergeOperation = new MergeOperation($extractedCatalogue, $currentCatalogue);
  177.         $allMessages = $mergeOperation->getResult()->all($domain);
  178.         if (null !== $domain) {
  179.             $allMessages = [$domain => $allMessages];
  180.         }
  182.         // No defined or extracted messages
  183.         if (!$allMessages || null !== $domain && empty($allMessages[$domain])) {
  184.             $outputMessage = sprintf('No defined or extracted messages for locale "%s"', $locale);
  186.             if (null !== $domain) {
  187.                 $outputMessage .= sprintf(' and domain "%s"', $domain);
  188.             }
  190.             $io->getErrorStyle()->warning($outputMessage);
  192.             return self::EXIT_CODE_GENERAL_ERROR;
  193.         }
  195.         // Load the fallback catalogues
  196.         $fallbackCatalogues = $this->loadFallbackCatalogues($locale, $transPaths);
  198.         // Display header line
  199.         $headers = ['State', 'Domain', 'Id', sprintf('Message Preview (%s)', $locale)];
  200.         foreach ($fallbackCatalogues as $fallbackCatalogue) {
  201.             $headers[] = sprintf('Fallback Message Preview (%s)', $fallbackCatalogue->getLocale());
  202.         }
  203.         $rows = [];
  204.         // Iterate all message ids and determine their state
  205.         foreach ($allMessages as $domain => $messages) {
  206.             foreach (array_keys($messages) as $messageId) {
  207.                 $value = $currentCatalogue->get($messageId, $domain);
  208.                 $states = [];
  210.                 if ($extractedCatalogue->defines($messageId, $domain)) {
  211.                     if (!$currentCatalogue->defines($messageId, $domain)) {
  212.                         $states[] = self::MESSAGE_MISSING;
  214.                         if (!$input->getOption('only-unused')) {
  215.                             $exitCode = $exitCode | self::EXIT_CODE_MISSING;
  216.                         }
  217.                     }
  218.                 } elseif ($currentCatalogue->defines($messageId, $domain)) {
  219.                     $states[] = self::MESSAGE_UNUSED;
  221.                     if (!$input->getOption('only-missing')) {
  222.                         $exitCode = $exitCode | self::EXIT_CODE_UNUSED;
  223.                     }
  224.                 }
  226.                 if (!\in_array(self::MESSAGE_UNUSED, $states) && $input->getOption('only-unused')
  227.                     || !\in_array(self::MESSAGE_MISSING, $states) && $input->getOption('only-missing')
  228.                 ) {
  229.                     continue;
  230.                 }
  232.                 foreach ($fallbackCatalogues as $fallbackCatalogue) {
  233.                     if ($fallbackCatalogue->defines($messageId, $domain) && $value === $fallbackCatalogue->get($messageId, $domain)) {
  234.                         $states[] = self::MESSAGE_EQUALS_FALLBACK;
  236.                         $exitCode = $exitCode | self::EXIT_CODE_FALLBACK;
  238.                         break;
  239.                     }
  240.                 }
  242.                 $row = [$this->formatStates($states), $domain, $this->formatId($messageId), $this->sanitizeString($value)];
  243.                 foreach ($fallbackCatalogues as $fallbackCatalogue) {
  244.                     $row[] = $this->sanitizeString($fallbackCatalogue->get($messageId, $domain));
  245.                 }
  247.                 $rows[] = $row;
  248.             }
  249.         }
  251.         $io->table($headers, $rows);
  253.         return $exitCode;
  254.     }
  256.     public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
  257.     {
  258.         if ($input->mustSuggestArgumentValuesFor('locale')) {
  259.             $suggestions->suggestValues($this->enabledLocales);
  261.             return;
  262.         }
  264.         /** @var KernelInterface $kernel */
  265.         $kernel = $this->getApplication()->getKernel();
  267.         if ($input->mustSuggestArgumentValuesFor('bundle')) {
  268.             $availableBundles = [];
  269.             foreach ($kernel->getBundles() as $bundle) {
  270.                 $availableBundles[] = $bundle->getName();
  272.                 if ($extension = $bundle->getContainerExtension()) {
  273.                     $availableBundles[] = $extension->getAlias();
  274.                 }
  275.             }
  277.             $suggestions->suggestValues($availableBundles);
  279.             return;
  280.         }
  282.         if ($input->mustSuggestOptionValuesFor('domain')) {
  283.             $locale = $input->getArgument('locale');
  285.             $mergeOperation = new MergeOperation(
  286.                 $this->extractMessages($locale, $this->getRootCodePaths($kernel)),
  287.                 $this->loadCurrentMessages($locale, $this->getRootTransPaths())
  288.             );
  290.             $suggestions->suggestValues($mergeOperation->getDomains());
  291.         }
  292.     }
  294.     private function formatState(int $state): string
  295.     {
  296.         if (self::MESSAGE_MISSING === $state) {
  297.             return '<error> missing </error>';
  298.         }
  300.         if (self::MESSAGE_UNUSED === $state) {
  301.             return '<comment> unused </comment>';
  302.         }
  304.         if (self::MESSAGE_EQUALS_FALLBACK === $state) {
  305.             return '<info> fallback </info>';
  306.         }
  308.         return $state;
  309.     }
  311.     private function formatStates(array $states): string
  312.     {
  313.         $result = [];
  314.         foreach ($states as $state) {
  315.             $result[] = $this->formatState($state);
  316.         }
  318.         return implode(' ', $result);
  319.     }
  321.     private function formatId(string $id): string
  322.     {
  323.         return sprintf('<fg=cyan;options=bold>%s</>', $id);
  324.     }
  326.     private function sanitizeString(string $string, int $length = 40): string
  327.     {
  328.         $string = trim(preg_replace('/\s+/', ' ', $string));
  330.         if (false !== $encoding = mb_detect_encoding($string, null, true)) {
  331.             if (mb_strlen($string, $encoding) > $length) {
  332.                 return mb_substr($string, 0, $length - 3, $encoding).'...';
  333.             }
  334.         } elseif (\strlen($string) > $length) {
  335.             return substr($string, 0, $length - 3).'...';
  336.         }
  338.         return $string;
  339.     }
  341.     private function extractMessages(string $locale, array $transPaths): MessageCatalogue
  342.     {
  343.         $extractedCatalogue = new MessageCatalogue($locale);
  344.         foreach ($transPaths as $path) {
  345.             if (is_dir($path) || is_file($path)) {
  346.                 $this->extractor->extract($path, $extractedCatalogue);
  347.             }
  348.         }
  350.         return $extractedCatalogue;
  351.     }
  353.     private function loadCurrentMessages(string $locale, array $transPaths): MessageCatalogue
  354.     {
  355.         $currentCatalogue = new MessageCatalogue($locale);
  356.         foreach ($transPaths as $path) {
  357.             if (is_dir($path)) {
  358.                 $this->reader->read($path, $currentCatalogue);
  359.             }
  360.         }
  362.         return $currentCatalogue;
  363.     }
  365.     /**
  366.      * @return MessageCatalogue[]
  367.      */
  368.     private function loadFallbackCatalogues(string $locale, array $transPaths): array
  369.     {
  370.         $fallbackCatalogues = [];
  371.         if ($this->translator instanceof Translator || $this->translator instanceof DataCollectorTranslator || $this->translator instanceof LoggingTranslator) {
  372.             foreach ($this->translator->getFallbackLocales() as $fallbackLocale) {
  373.                 if ($fallbackLocale === $locale) {
  374.                     continue;
  375.                 }
  377.                 $fallbackCatalogue = new MessageCatalogue($fallbackLocale);
  378.                 foreach ($transPaths as $path) {
  379.                     if (is_dir($path)) {
  380.                         $this->reader->read($path, $fallbackCatalogue);
  381.                     }
  382.                 }
  383.                 $fallbackCatalogues[] = $fallbackCatalogue;
  384.             }
  385.         }
  387.         return $fallbackCatalogues;
  388.     }
  390.     private function getRootTransPaths(): array
  391.     {
  392.         $transPaths = $this->transPaths;
  393.         if ($this->defaultTransPath) {
  394.             $transPaths[] = $this->defaultTransPath;
  395.         }
  397.         return $transPaths;
  398.     }
  400.     private function getRootCodePaths(KernelInterface $kernel): array
  401.     {
  402.         $codePaths = $this->codePaths;
  403.         $codePaths[] = $kernel->getProjectDir().'/src';
  404.         if ($this->defaultViewsPath) {
  405.             $codePaths[] = $this->defaultViewsPath;
  406.         }
  408.         return $codePaths;
  409.     }
  410. }