b5a1584c52
Remove ending dot from option description for consistency
257 lines
10 KiB
PHP
257 lines
10 KiB
PHP
<?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\Component\Console\Style\SymfonyStyle;
|
|
use Symfony\Component\Translation\Catalogue\TargetOperation;
|
|
use Symfony\Component\Translation\Catalogue\MergeOperation;
|
|
use Symfony\Component\Console\Input\InputInterface;
|
|
use Symfony\Component\Console\Output\OutputInterface;
|
|
use Symfony\Component\Console\Input\InputArgument;
|
|
use Symfony\Component\Console\Input\InputOption;
|
|
use Symfony\Component\Translation\MessageCatalogue;
|
|
|
|
/**
|
|
* A command that parses templates to extract translation messages and adds them
|
|
* into the translation files.
|
|
*
|
|
* @author Michel Salib <michelsalib@hotmail.com>
|
|
*/
|
|
class TranslationUpdateCommand extends ContainerAwareCommand
|
|
{
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
protected function configure()
|
|
{
|
|
$this
|
|
->setName('translation:update')
|
|
->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('prefix', null, InputOption::VALUE_OPTIONAL, 'Override the default prefix', '__'),
|
|
new InputOption('no-prefix', null, InputOption::VALUE_NONE, 'If set, no prefix is added to the translations'),
|
|
new InputOption('output-format', null, InputOption::VALUE_OPTIONAL, 'Override the default output format', 'yml'),
|
|
new InputOption('dump-messages', null, InputOption::VALUE_NONE, 'Should the messages be dumped in the console'),
|
|
new InputOption('force', null, InputOption::VALUE_NONE, 'Should the update be done'),
|
|
new InputOption('no-backup', null, InputOption::VALUE_NONE, 'Should backup be disabled'),
|
|
new InputOption('clean', null, InputOption::VALUE_NONE, 'Should clean not found messages'),
|
|
new InputOption('domain', null, InputOption::VALUE_OPTIONAL, 'Specify the domain to update'),
|
|
))
|
|
->setDescription('Updates the translation file')
|
|
->setHelp(<<<'EOF'
|
|
The <info>%command.name%</info> command extracts translation strings from templates
|
|
of a given bundle or the app folder. It can display them or merge the new ones into the translation files.
|
|
|
|
When new translation strings are found it can automatically add a prefix to the translation
|
|
message.
|
|
|
|
Example running against a Bundle (AcmeBundle)
|
|
<info>php %command.full_name% --dump-messages en AcmeBundle</info>
|
|
<info>php %command.full_name% --force --prefix="new_" fr AcmeBundle</info>
|
|
|
|
Example running against app messages (app/Resources folder)
|
|
<info>php %command.full_name% --dump-messages en</info>
|
|
<info>php %command.full_name% --force --prefix="new_" fr</info>
|
|
EOF
|
|
)
|
|
;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function isEnabled()
|
|
{
|
|
if (!class_exists('Symfony\Component\Translation\Translator')) {
|
|
return false;
|
|
}
|
|
|
|
return parent::isEnabled();
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
protected function execute(InputInterface $input, OutputInterface $output)
|
|
{
|
|
$io = new SymfonyStyle($input, $output);
|
|
|
|
// check presence of force or dump-message
|
|
if ($input->getOption('force') !== true && $input->getOption('dump-messages') !== true) {
|
|
$io->error('You must choose one of --force or --dump-messages');
|
|
|
|
return 1;
|
|
}
|
|
|
|
// check format
|
|
$writer = $this->getContainer()->get('translation.writer');
|
|
$supportedFormats = $writer->getFormats();
|
|
if (!in_array($input->getOption('output-format'), $supportedFormats)) {
|
|
$io->error(array('Wrong output format', 'Supported formats are: '.implode(', ', $supportedFormats).'.'));
|
|
|
|
return 1;
|
|
}
|
|
$kernel = $this->getContainer()->get('kernel');
|
|
|
|
// Define Root Path to App folder
|
|
$transPaths = array($kernel->getRootDir().'/Resources/');
|
|
$currentName = 'app folder';
|
|
|
|
// Override with provided Bundle info
|
|
if (null !== $input->getArgument('bundle')) {
|
|
try {
|
|
$foundBundle = $kernel->getBundle($input->getArgument('bundle'));
|
|
$transPaths = array(
|
|
$foundBundle->getPath().'/Resources/',
|
|
sprintf('%s/Resources/%s/', $kernel->getRootDir(), $foundBundle->getName()),
|
|
);
|
|
$currentName = $foundBundle->getName();
|
|
} catch (\InvalidArgumentException $e) {
|
|
// such a bundle does not exist, so treat the argument as path
|
|
$transPaths = array($input->getArgument('bundle').'/Resources/');
|
|
$currentName = $transPaths[0];
|
|
|
|
if (!is_dir($transPaths[0])) {
|
|
throw new \InvalidArgumentException(sprintf('<error>"%s" is neither an enabled bundle nor a directory.</error>', $transPaths[0]));
|
|
}
|
|
}
|
|
}
|
|
|
|
$io->title('Translation Messages Extractor and Dumper');
|
|
$io->comment(sprintf('Generating "<info>%s</info>" translation files for "<info>%s</info>"', $input->getArgument('locale'), $currentName));
|
|
|
|
// load any messages from templates
|
|
$extractedCatalogue = new MessageCatalogue($input->getArgument('locale'));
|
|
$io->comment('Parsing templates...');
|
|
$extractor = $this->getContainer()->get('translation.extractor');
|
|
$extractor->setPrefix($input->getOption('no-prefix') ? '' : $input->getOption('prefix'));
|
|
foreach ($transPaths as $path) {
|
|
$path .= 'views';
|
|
if (is_dir($path)) {
|
|
$extractor->extract($path, $extractedCatalogue);
|
|
}
|
|
}
|
|
|
|
// load any existing messages from the translation files
|
|
$currentCatalogue = new MessageCatalogue($input->getArgument('locale'));
|
|
$io->comment('Loading translation files...');
|
|
$loader = $this->getContainer()->get('translation.loader');
|
|
foreach ($transPaths as $path) {
|
|
$path .= 'translations';
|
|
if (is_dir($path)) {
|
|
$loader->loadMessages($path, $currentCatalogue);
|
|
}
|
|
}
|
|
|
|
if (null !== $domain = $input->getOption('domain')) {
|
|
$currentCatalogue = $this->filterCatalogue($currentCatalogue, $domain);
|
|
$extractedCatalogue = $this->filterCatalogue($extractedCatalogue, $domain);
|
|
}
|
|
|
|
// process catalogues
|
|
$operation = $input->getOption('clean')
|
|
? new TargetOperation($currentCatalogue, $extractedCatalogue)
|
|
: new MergeOperation($currentCatalogue, $extractedCatalogue);
|
|
|
|
// Exit if no messages found.
|
|
if (!count($operation->getDomains())) {
|
|
$io->warning('No translation messages were found.');
|
|
|
|
return;
|
|
}
|
|
|
|
$resultMessage = 'Translation files were successfully updated';
|
|
|
|
// show compiled list of messages
|
|
if (true === $input->getOption('dump-messages')) {
|
|
$extractedMessagesCount = 0;
|
|
$io->newLine();
|
|
foreach ($operation->getDomains() as $domain) {
|
|
$newKeys = array_keys($operation->getNewMessages($domain));
|
|
$allKeys = array_keys($operation->getMessages($domain));
|
|
|
|
$list = array_merge(
|
|
array_diff($allKeys, $newKeys),
|
|
array_map(function ($id) {
|
|
return sprintf('<fg=green>%s</>', $id);
|
|
}, $newKeys),
|
|
array_map(function ($id) {
|
|
return sprintf('<fg=red>%s</>', $id);
|
|
}, array_keys($operation->getObsoleteMessages($domain)))
|
|
);
|
|
|
|
$domainMessagesCount = count($list);
|
|
|
|
$io->section(sprintf('Messages extracted for domain "<info>%s</info>" (%d message%s)', $domain, $domainMessagesCount, $domainMessagesCount > 1 ? 's' : ''));
|
|
$io->listing($list);
|
|
|
|
$extractedMessagesCount += $domainMessagesCount;
|
|
}
|
|
|
|
if ($input->getOption('output-format') == 'xlf') {
|
|
$io->comment('Xliff output version is <info>1.2</info>');
|
|
}
|
|
|
|
$resultMessage = sprintf('%d message%s successfully extracted', $extractedMessagesCount, $extractedMessagesCount > 1 ? 's were' : ' was');
|
|
}
|
|
|
|
if ($input->getOption('no-backup') === true) {
|
|
$writer->disableBackup();
|
|
}
|
|
|
|
// save the files
|
|
if ($input->getOption('force') === true) {
|
|
$io->comment('Writing files...');
|
|
|
|
$bundleTransPath = false;
|
|
foreach ($transPaths as $path) {
|
|
$path .= 'translations';
|
|
if (is_dir($path)) {
|
|
$bundleTransPath = $path;
|
|
}
|
|
}
|
|
|
|
if (!$bundleTransPath) {
|
|
$bundleTransPath = end($transPaths).'translations';
|
|
}
|
|
|
|
$writer->writeTranslations($operation->getResult(), $input->getOption('output-format'), array('path' => $bundleTransPath, 'default_locale' => $this->getContainer()->getParameter('kernel.default_locale')));
|
|
|
|
if (true === $input->getOption('dump-messages')) {
|
|
$resultMessage .= ' and translation files were updated';
|
|
}
|
|
}
|
|
|
|
$io->success($resultMessage.'.');
|
|
}
|
|
|
|
private function filterCatalogue(MessageCatalogue $catalogue, $domain)
|
|
{
|
|
$filteredCatalogue = new MessageCatalogue($catalogue->getLocale());
|
|
|
|
if ($messages = $catalogue->all($domain)) {
|
|
$filteredCatalogue->add($messages, $domain);
|
|
}
|
|
foreach ($catalogue->getResources() as $resource) {
|
|
$filteredCatalogue->addResource($resource);
|
|
}
|
|
if ($metadata = $catalogue->getMetadata('', $domain)) {
|
|
foreach ($metadata as $k => $v) {
|
|
$filteredCatalogue->setMetadata($k, $v, $domain);
|
|
}
|
|
}
|
|
|
|
return $filteredCatalogue;
|
|
}
|
|
}
|