123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325 |
- <?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\Bundle\FrameworkBundle\Command;
- use Symfony\Bundle\FrameworkBundle\Translation\TranslationLoader;
- use Symfony\Component\Console\Input\InputArgument;
- use Symfony\Component\Console\Input\InputInterface;
- use Symfony\Component\Console\Input\InputOption;
- use Symfony\Component\Console\Output\OutputInterface;
- use Symfony\Component\Console\Style\SymfonyStyle;
- use Symfony\Component\HttpKernel\Kernel;
- use Symfony\Component\Translation\Catalogue\MergeOperation;
- use Symfony\Component\Translation\DataCollectorTranslator;
- use Symfony\Component\Translation\LoggingTranslator;
- use Symfony\Component\Translation\MessageCatalogue;
- use Symfony\Component\Translation\Translator;
- /**
- * Helps finding unused or missing translation messages in a given locale
- * and comparing them with the fallback ones.
- *
- * @author Florian Voutzinos <florian@voutzinos.com>
- */
- class TranslationDebugCommand extends ContainerAwareCommand
- {
- const MESSAGE_MISSING = 0;
- const MESSAGE_UNUSED = 1;
- const MESSAGE_EQUALS_FALLBACK = 2;
- /**
- * {@inheritdoc}
- */
- protected function configure()
- {
- $this
- ->setName('debug:translation')
- ->setAliases(array(
- 'translation:debug',
- ))
- ->setDefinition(array(
- new InputArgument('locale', InputArgument::REQUIRED, 'The locale'),
- new InputArgument('bundle', InputArgument::OPTIONAL, 'The bundle name or directory where to load the messages, defaults to app/Resources folder'),
- new InputOption('domain', null, InputOption::VALUE_OPTIONAL, 'The messages domain'),
- new InputOption('only-missing', null, InputOption::VALUE_NONE, 'Displays only missing messages'),
- new InputOption('only-unused', null, InputOption::VALUE_NONE, 'Displays only unused messages'),
- new InputOption('all', null, InputOption::VALUE_NONE, 'Load messages from all registered bundles'),
- ))
- ->setDescription('Displays translation messages information')
- ->setHelp(<<<'EOF'
- The <info>%command.name%</info> command helps finding unused or missing translation
- messages and comparing them with the fallback ones by inspecting the
- templates and translation files of a given bundle or the app folder.
- You can display information about bundle translations in a specific locale:
- <info>php %command.full_name% en AcmeDemoBundle</info>
- You can also specify a translation domain for the search:
- <info>php %command.full_name% --domain=messages en AcmeDemoBundle</info>
- You can only display missing messages:
- <info>php %command.full_name% --only-missing en AcmeDemoBundle</info>
- You can only display unused messages:
- <info>php %command.full_name% --only-unused en AcmeDemoBundle</info>
- You can display information about app translations in a specific locale:
- <info>php %command.full_name% en</info>
- You can display information about translations in all registered bundles in a specific locale:
- <info>php %command.full_name% --all en</info>
- EOF
- )
- ;
- }
- /**
- * {@inheritdoc}
- */
- protected function execute(InputInterface $input, OutputInterface $output)
- {
- $io = new SymfonyStyle($input, $output);
- if (false !== strpos($input->getFirstArgument(), ':d')) {
- $io->caution('The use of "translation:debug" command is deprecated since version 2.7 and will be removed in 3.0. Use the "debug:translation" instead.');
- }
- $locale = $input->getArgument('locale');
- $domain = $input->getOption('domain');
- /** @var TranslationLoader $loader */
- $loader = $this->getContainer()->get('translation.loader');
- /** @var Kernel $kernel */
- $kernel = $this->getContainer()->get('kernel');
- // Define Root Path to App folder
- $transPaths = array($kernel->getRootDir().'/Resources/');
- // Override with provided Bundle info
- if (null !== $input->getArgument('bundle')) {
- try {
- $bundle = $kernel->getBundle($input->getArgument('bundle'));
- $transPaths = array(
- $bundle->getPath().'/Resources/',
- sprintf('%s/Resources/%s/', $kernel->getRootDir(), $bundle->getName()),
- );
- } catch (\InvalidArgumentException $e) {
- // such a bundle does not exist, so treat the argument as path
- $transPaths = array($input->getArgument('bundle').'/Resources/');
- if (!is_dir($transPaths[0])) {
- throw new \InvalidArgumentException(sprintf('"%s" is neither an enabled bundle nor a directory.', $transPaths[0]));
- }
- }
- } elseif ($input->getOption('all')) {
- foreach ($kernel->getBundles() as $bundle) {
- $transPaths[] = $bundle->getPath().'/Resources/';
- $transPaths[] = sprintf('%s/Resources/%s/', $kernel->getRootDir(), $bundle->getName());
- }
- }
- // Extract used messages
- $extractedCatalogue = $this->extractMessages($locale, $transPaths);
- // Load defined messages
- $currentCatalogue = $this->loadCurrentMessages($locale, $transPaths, $loader);
- // Merge defined and extracted messages to get all message ids
- $mergeOperation = new MergeOperation($extractedCatalogue, $currentCatalogue);
- $allMessages = $mergeOperation->getResult()->all($domain);
- if (null !== $domain) {
- $allMessages = array($domain => $allMessages);
- }
- // No defined or extracted messages
- if (empty($allMessages) || null !== $domain && empty($allMessages[$domain])) {
- $outputMessage = sprintf('No defined or extracted messages for locale "%s"', $locale);
- if (null !== $domain) {
- $outputMessage .= sprintf(' and domain "%s"', $domain);
- }
- $io->warning($outputMessage);
- return;
- }
- // Load the fallback catalogues
- $fallbackCatalogues = $this->loadFallbackCatalogues($locale, $transPaths, $loader);
- // Display header line
- $headers = array('State', 'Domain', 'Id', sprintf('Message Preview (%s)', $locale));
- foreach ($fallbackCatalogues as $fallbackCatalogue) {
- $headers[] = sprintf('Fallback Message Preview (%s)', $fallbackCatalogue->getLocale());
- }
- $rows = array();
- // Iterate all message ids and determine their state
- foreach ($allMessages as $domain => $messages) {
- foreach (array_keys($messages) as $messageId) {
- $value = $currentCatalogue->get($messageId, $domain);
- $states = array();
- if ($extractedCatalogue->defines($messageId, $domain)) {
- if (!$currentCatalogue->defines($messageId, $domain)) {
- $states[] = self::MESSAGE_MISSING;
- }
- } elseif ($currentCatalogue->defines($messageId, $domain)) {
- $states[] = self::MESSAGE_UNUSED;
- }
- if (!\in_array(self::MESSAGE_UNUSED, $states) && true === $input->getOption('only-unused')
- || !\in_array(self::MESSAGE_MISSING, $states) && true === $input->getOption('only-missing')) {
- continue;
- }
- foreach ($fallbackCatalogues as $fallbackCatalogue) {
- if ($fallbackCatalogue->defines($messageId, $domain) && $value === $fallbackCatalogue->get($messageId, $domain)) {
- $states[] = self::MESSAGE_EQUALS_FALLBACK;
- break;
- }
- }
- $row = array($this->formatStates($states), $domain, $this->formatId($messageId), $this->sanitizeString($value));
- foreach ($fallbackCatalogues as $fallbackCatalogue) {
- $row[] = $this->sanitizeString($fallbackCatalogue->get($messageId, $domain));
- }
- $rows[] = $row;
- }
- }
- $io->table($headers, $rows);
- }
- private function formatState($state)
- {
- if (self::MESSAGE_MISSING === $state) {
- return '<error> missing </error>';
- }
- if (self::MESSAGE_UNUSED === $state) {
- return '<comment> unused </comment>';
- }
- if (self::MESSAGE_EQUALS_FALLBACK === $state) {
- return '<info> fallback </info>';
- }
- return $state;
- }
- private function formatStates(array $states)
- {
- $result = array();
- foreach ($states as $state) {
- $result[] = $this->formatState($state);
- }
- return implode(' ', $result);
- }
- private function formatId($id)
- {
- return sprintf('<fg=cyan;options=bold>%s</>', $id);
- }
- private function sanitizeString($string, $length = 40)
- {
- $string = trim(preg_replace('/\s+/', ' ', $string));
- if (false !== $encoding = mb_detect_encoding($string, null, true)) {
- if (mb_strlen($string, $encoding) > $length) {
- return mb_substr($string, 0, $length - 3, $encoding).'...';
- }
- } elseif (\strlen($string) > $length) {
- return substr($string, 0, $length - 3).'...';
- }
- return $string;
- }
- /**
- * @param string $locale
- * @param array $transPaths
- *
- * @return MessageCatalogue
- */
- private function extractMessages($locale, $transPaths)
- {
- $extractedCatalogue = new MessageCatalogue($locale);
- foreach ($transPaths as $path) {
- $path .= 'views';
- if (is_dir($path)) {
- $this->getContainer()->get('translation.extractor')->extract($path, $extractedCatalogue);
- }
- }
- return $extractedCatalogue;
- }
- /**
- * @param string $locale
- * @param array $transPaths
- * @param TranslationLoader $loader
- *
- * @return MessageCatalogue
- */
- private function loadCurrentMessages($locale, $transPaths, TranslationLoader $loader)
- {
- $currentCatalogue = new MessageCatalogue($locale);
- foreach ($transPaths as $path) {
- $path .= 'translations';
- if (is_dir($path)) {
- $loader->loadMessages($path, $currentCatalogue);
- }
- }
- return $currentCatalogue;
- }
- /**
- * @param string $locale
- * @param array $transPaths
- * @param TranslationLoader $loader
- *
- * @return MessageCatalogue[]
- */
- private function loadFallbackCatalogues($locale, $transPaths, TranslationLoader $loader)
- {
- $fallbackCatalogues = array();
- $translator = $this->getContainer()->get('translator');
- if ($translator instanceof Translator || $translator instanceof DataCollectorTranslator || $translator instanceof LoggingTranslator) {
- foreach ($translator->getFallbackLocales() as $fallbackLocale) {
- if ($fallbackLocale === $locale) {
- continue;
- }
- $fallbackCatalogue = new MessageCatalogue($fallbackLocale);
- foreach ($transPaths as $path) {
- $path .= 'translations';
- if (is_dir($path)) {
- $loader->loadMessages($path, $fallbackCatalogue);
- }
- }
- $fallbackCatalogues[] = $fallbackCatalogue;
- }
- }
- return $fallbackCatalogues;
- }
- }
|