You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
188 lines
7.5 KiB
188 lines
7.5 KiB
<?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\Command; |
|
|
|
use Symfony\Component\Console\Command\Command; |
|
use Symfony\Component\Console\Completion\CompletionInput; |
|
use Symfony\Component\Console\Completion\CompletionSuggestions; |
|
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\Translation\Catalogue\TargetOperation; |
|
use Symfony\Component\Translation\MessageCatalogue; |
|
use Symfony\Component\Translation\Provider\TranslationProviderCollection; |
|
use Symfony\Component\Translation\Reader\TranslationReaderInterface; |
|
use Symfony\Component\Translation\Writer\TranslationWriterInterface; |
|
|
|
/** |
|
* @author Mathieu Santostefano <msantostefano@protonmail.com> |
|
*/ |
|
final class TranslationPullCommand extends Command |
|
{ |
|
use TranslationTrait; |
|
|
|
protected static $defaultName = 'translation:pull'; |
|
protected static $defaultDescription = 'Pull translations from a given provider.'; |
|
|
|
private $providerCollection; |
|
private $writer; |
|
private $reader; |
|
private $defaultLocale; |
|
private $transPaths; |
|
private $enabledLocales; |
|
|
|
public function __construct(TranslationProviderCollection $providerCollection, TranslationWriterInterface $writer, TranslationReaderInterface $reader, string $defaultLocale, array $transPaths = [], array $enabledLocales = []) |
|
{ |
|
$this->providerCollection = $providerCollection; |
|
$this->writer = $writer; |
|
$this->reader = $reader; |
|
$this->defaultLocale = $defaultLocale; |
|
$this->transPaths = $transPaths; |
|
$this->enabledLocales = $enabledLocales; |
|
|
|
parent::__construct(); |
|
} |
|
|
|
public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void |
|
{ |
|
if ($input->mustSuggestArgumentValuesFor('provider')) { |
|
$suggestions->suggestValues($this->providerCollection->keys()); |
|
|
|
return; |
|
} |
|
|
|
if ($input->mustSuggestOptionValuesFor('domains')) { |
|
$provider = $this->providerCollection->get($input->getArgument('provider')); |
|
|
|
if ($provider && method_exists($provider, 'getDomains')) { |
|
$domains = $provider->getDomains(); |
|
$suggestions->suggestValues($domains); |
|
} |
|
|
|
return; |
|
} |
|
|
|
if ($input->mustSuggestOptionValuesFor('locales')) { |
|
$suggestions->suggestValues($this->enabledLocales); |
|
|
|
return; |
|
} |
|
|
|
if ($input->mustSuggestOptionValuesFor('format')) { |
|
$suggestions->suggestValues(['php', 'xlf', 'xlf12', 'xlf20', 'po', 'mo', 'yml', 'yaml', 'ts', 'csv', 'json', 'ini', 'res']); |
|
} |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
protected function configure() |
|
{ |
|
$keys = $this->providerCollection->keys(); |
|
$defaultProvider = 1 === \count($keys) ? $keys[0] : null; |
|
|
|
$this |
|
->setDefinition([ |
|
new InputArgument('provider', null !== $defaultProvider ? InputArgument::OPTIONAL : InputArgument::REQUIRED, 'The provider to pull translations from.', $defaultProvider), |
|
new InputOption('force', null, InputOption::VALUE_NONE, 'Override existing translations with provider ones (it will delete not synchronized messages).'), |
|
new InputOption('intl-icu', null, InputOption::VALUE_NONE, 'Associated to --force option, it will write messages in "%domain%+intl-icu.%locale%.xlf" files.'), |
|
new InputOption('domains', null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'Specify the domains to pull.'), |
|
new InputOption('locales', null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'Specify the locales to pull.'), |
|
new InputOption('format', null, InputOption::VALUE_OPTIONAL, 'Override the default output format.', 'xlf12'), |
|
]) |
|
->setHelp(<<<'EOF' |
|
The <info>%command.name%</> command pulls translations from the given provider. Only |
|
new translations are pulled, existing ones are not overwritten. |
|
|
|
You can overwrite existing translations (and remove the missing ones on local side) by using the <comment>--force</> flag: |
|
|
|
<info>php %command.full_name% --force provider</> |
|
|
|
Full example: |
|
|
|
<info>php %command.full_name% provider --force --domains=messages --domains=validators --locales=en</> |
|
|
|
This command pulls all translations associated with the <comment>messages</> and <comment>validators</> domains for the <comment>en</> locale. |
|
Local translations for the specified domains and locale are deleted if they're not present on the provider and overwritten if it's the case. |
|
Local translations for others domains and locales are ignored. |
|
EOF |
|
) |
|
; |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
protected function execute(InputInterface $input, OutputInterface $output): int |
|
{ |
|
$io = new SymfonyStyle($input, $output); |
|
|
|
$provider = $this->providerCollection->get($input->getArgument('provider')); |
|
$force = $input->getOption('force'); |
|
$intlIcu = $input->getOption('intl-icu'); |
|
$locales = $input->getOption('locales') ?: $this->enabledLocales; |
|
$domains = $input->getOption('domains'); |
|
$format = $input->getOption('format'); |
|
$xliffVersion = '1.2'; |
|
|
|
if ($intlIcu && !$force) { |
|
$io->note('--intl-icu option only has an effect when used with --force. Here, it will be ignored.'); |
|
} |
|
|
|
switch ($format) { |
|
case 'xlf20': $xliffVersion = '2.0'; |
|
// no break |
|
case 'xlf12': $format = 'xlf'; |
|
} |
|
|
|
$writeOptions = [ |
|
'path' => end($this->transPaths), |
|
'xliff_version' => $xliffVersion, |
|
'default_locale' => $this->defaultLocale, |
|
]; |
|
|
|
if (!$domains) { |
|
$domains = $provider->getDomains(); |
|
} |
|
|
|
$providerTranslations = $provider->read($domains, $locales); |
|
|
|
if ($force) { |
|
foreach ($providerTranslations->getCatalogues() as $catalogue) { |
|
$operation = new TargetOperation(new MessageCatalogue($catalogue->getLocale()), $catalogue); |
|
if ($intlIcu) { |
|
$operation->moveMessagesToIntlDomainsIfPossible(); |
|
} |
|
$this->writer->write($operation->getResult(), $format, $writeOptions); |
|
} |
|
|
|
$io->success(sprintf('Local translations has been updated from "%s" (for "%s" locale(s), and "%s" domain(s)).', parse_url($provider, \PHP_URL_SCHEME), implode(', ', $locales), implode(', ', $domains))); |
|
|
|
return 0; |
|
} |
|
|
|
$localTranslations = $this->readLocalTranslations($locales, $domains, $this->transPaths); |
|
|
|
// Append pulled translations to local ones. |
|
$localTranslations->addBag($providerTranslations->diff($localTranslations)); |
|
|
|
foreach ($localTranslations->getCatalogues() as $catalogue) { |
|
$this->writer->write($catalogue, $format, $writeOptions); |
|
} |
|
|
|
$io->success(sprintf('New translations from "%s" has been written locally (for "%s" locale(s), and "%s" domain(s)).', parse_url($provider, \PHP_URL_SCHEME), implode(', ', $locales), implode(', ', $domains))); |
|
|
|
return 0; |
|
} |
|
}
|
|
|