23 public function __construct() {
24 parent::__construct();
25 $this->addDescription(
'Backport translations from one branch to another.' );
29 'Comma separated list of message group IDs (supports * wildcard) to backport',
35 'Source path for reading updated translations. Defaults to $wgTranslateGroupRoot.',
41 'Target path for writing backported translations',
47 'Only export a group if its export path matches this prefix (relative to target-path)',
52 'never-export-languages',
53 'Languages to not export',
57 $this->requireExtension(
'Translate' );
62 $config = $this->getConfig();
63 $logger = LoggerFactory::getInstance(
'Translate.GroupSynchronization' );
64 $groupPattern = $this->getOption(
'group' ) ??
'';
66 'Starting backports for groups {groups}',
67 [
'groups' => $groupPattern ]
70 $sourcePath = $this->getOption(
'source-path' ) ?: $config->get(
'TranslateGroupRoot' );
71 if ( !is_readable( $sourcePath ) ) {
72 $this->fatalError(
"Source directory is not readable ($sourcePath)." );
75 $targetPath = $this->getOption(
'target-path' );
76 if ( !is_writable( $targetPath ) ) {
77 $this->fatalError(
"Target directory is not writable ($targetPath)." );
80 $groupIds = MessageGroups::expandWildcards( explode(
',', trim( $groupPattern ) ) );
81 $groups = MessageGroups::getGroupsById( $groupIds );
82 if ( $groups === [] ) {
83 $this->fatalError(
"Pattern $groupPattern did not match any message groups." );
86 $neverExportLanguages = $this->csv2array(
87 $this->getOption(
'never-export-languages' ) ??
''
89 $supportedLanguages = TranslateUtils::getLanguageNames(
'en' );
91 foreach ( $groups as $group ) {
92 $groupId = $group->getId();
94 if ( !$this->hasOption(
'filter-path' ) ) {
95 $this->error(
"Skipping $groupId: Not instance of FileBasedMessageGroup" );
100 if ( !$group->getFFS() instanceof
JsonFFS ) {
101 $this->error(
"Skipping $groupId: Only JSON format is supported" );
105 if ( $this->hasOption(
'filter-path' ) ) {
106 $filter = $this->getOption(
'filter-path' );
107 $exportPath = $group->getTargetFilename(
'*' );
108 if ( !$this->matchPath( $filter, $exportPath ) ) {
114 $sourceLanguage = $group->getSourceLanguage();
116 $sourceDefinitions = $this->loadDefinitions( $group, $sourcePath, $sourceLanguage );
117 $targetDefinitions = $this->loadDefinitions( $group, $targetPath, $sourceLanguage );
118 }
catch ( RuntimeException $e ) {
120 "Skipping $groupId: Error while loading definitions: {$e->getMessage()}\n"
125 $keyCompatibilityMap = $this->getKeyCompatibilityMap(
126 $sourceDefinitions[
'MESSAGES'],
127 $targetDefinitions[
'MESSAGES'],
131 if ( array_filter( $keyCompatibilityMap ) === [] ) {
132 $this->output(
"Skipping $groupId: No compatible keys found\n" );
137 $languages = array_keys( $group->getTranslatableLanguages() ?? $supportedLanguages );
138 $languagesToSkip = $neverExportLanguages;
139 $languagesToSkip[] = $sourceLanguage;
140 $languages = array_diff( $languages, $languagesToSkip );
142 foreach ( $languages as $language ) {
143 $status = $this->backport(
147 $keyCompatibilityMap,
151 $summary[$status][] = $language;
154 $numUpdated = count( $summary[
'updated' ] ?? [] );
155 $numAdded = count( $summary[
'new' ] ?? [] );
156 if ( ( $numUpdated + $numAdded ) > 0 ) {
159 "%s: Compatible keys: %d. Updated %d languages, %d new (%s)\n",
161 count( $keyCompatibilityMap ),
164 implode(
', ', $summary[
'new' ] ?? [] )
171 private function csv2array(
string $input ): array {
173 array_map(
'trim', explode(
',', $input ) ),
174 static function ( $v ) {
180 private function matchPath(
string $prefix,
string $full ): bool {
181 $prefix =
"./$prefix";
182 $length = strlen( $prefix );
183 return substr( $full, 0, $length ) === $prefix;
186 private function loadDefinitions(
191 $file = $path .
'/' . $group->getTargetFilename( $language );
193 if ( !file_exists( $file ) ) {
194 throw new RuntimeException(
"File $file does not exist" );
197 $contents = file_get_contents( $file );
198 return $group->getFFS()->readFromVariable( $contents );
210 private function getKeyCompatibilityMap( array $source, array $target,
SimpleFFS $ffs ): array {
212 foreach ( $target as $key => $value ) {
213 $keys[$key] = isset( $source[ $key ] ) && $ffs->
isContentEqual( $source[ $key ], $value );
218 private function backport(
222 array $keyCompatibilityMap,
226 $sourceTemplate = $this->loadDefinitions( $group, $source, $language );
227 }
catch ( RuntimeException $e ) {
228 return 'no definitions';
232 $targetTemplate = $this->loadDefinitions( $group, $targetPath, $language );
233 }
catch ( RuntimeException $e ) {
243 $ffs = $group->getFFS();
247 if ( !$ffs instanceof
JsonFFS ) {
248 throw new RuntimeException(
249 "Expected FFS type: " . JsonFFS::class .
'; got: ' . get_class( $ffs )
253 $combinedMessages = [];
255 foreach ( $keyCompatibilityMap as $key => $isCompatible ) {
256 $sourceValue = $sourceTemplate[
'MESSAGES'][$key] ??
null;
257 $targetValue = $targetTemplate[
'MESSAGES'][$key] ??
null;
260 if ( $targetValue !==
null ) {
261 $combinedMessages[$key] = $targetValue;
266 if ( !$isCompatible ) {
269 if ( $sourceValue !==
null && !$ffs->
isContentEqual( $sourceValue, $targetValue ) ) {
272 $combinedMessages[$key] = $sourceValue;
276 if ( !$hasUpdates ) {
281 $combinedAuthors = array_merge(
282 $targetTemplate[
'AUTHORS' ] ?? [],
283 $sourceTemplate[
'AUTHORS' ] ?? []
285 $combinedAuthors = array_unique( $combinedAuthors );
286 $combinedAuthors = $ffs->
filterAuthors( $combinedAuthors, $language );
288 $targetTemplate[
'AUTHORS'] = $combinedAuthors;
289 $targetTemplate[
'MESSAGES'] = $combinedMessages;
291 $backportedContent = $ffs->generateFile( $targetTemplate );
293 $targetFilename = $targetPath .
'/' . $group->getTargetFilename( $language );
294 if ( file_exists( $targetFilename ) ) {
295 $currentContent = file_get_contents( $targetFilename );
298 file_put_contents( $targetFilename, $backportedContent );
302 file_put_contents( $targetFilename, $backportedContent );
return[ 'Translate:ConfigHelper'=> static function():ConfigHelper { return new ConfigHelper();}, 'Translate:CsvTranslationImporter'=> static function(MediaWikiServices $services):CsvTranslationImporter { return new CsvTranslationImporter( $services->getWikiPageFactory());}, 'Translate:EntitySearch'=> static function(MediaWikiServices $services):EntitySearch { return new EntitySearch($services->getMainWANObjectCache(), $services->getCollationFactory() ->makeCollation( 'uca-default-u-kn'), MessageGroups::singleton(), $services->getNamespaceInfo(), $services->get( 'Translate:MessageIndex'), $services->getTitleParser(), $services->getTitleFormatter());}, 'Translate:ExternalMessageSourceStateImporter'=> static function(MediaWikiServices $services):ExternalMessageSourceStateImporter { return new ExternalMessageSourceStateImporter($services->getMainConfig(), $services->get( 'Translate:GroupSynchronizationCache'), $services->getJobQueueGroup(), LoggerFactory::getInstance( 'Translate.GroupSynchronization'), MessageIndex::singleton());}, 'Translate:GroupSynchronizationCache'=> static function(MediaWikiServices $services):GroupSynchronizationCache { return new GroupSynchronizationCache( $services->get( 'Translate:PersistentCache'));}, 'Translate:MessageBundleStore'=> static function(MediaWikiServices $services):MessageBundleStore { return new MessageBundleStore(new RevTagStore(), $services->getJobQueueGroup(), $services->getLanguageNameUtils(), $services->get( 'Translate:MessageIndex'));}, 'Translate:MessageGroupReview'=> static function(MediaWikiServices $services):MessageGroupReview { return new MessageGroupReview($services->getDBLoadBalancer(), $services->getHookContainer());}, 'Translate:MessageIndex'=> static function(MediaWikiServices $services):MessageIndex { $params=$services->getMainConfig() ->get( 'TranslateMessageIndex');if(is_string( $params)) { $params=(array) $params;} $class=array_shift( $params);return new $class( $params);}, 'Translate:ParsingPlaceholderFactory'=> static function():ParsingPlaceholderFactory { return new ParsingPlaceholderFactory();}, 'Translate:PersistentCache'=> static function(MediaWikiServices $services):PersistentCache { return new PersistentDatabaseCache($services->getDBLoadBalancer(), $services->getJsonCodec());}, 'Translate:ProgressStatsTableFactory'=> static function(MediaWikiServices $services):ProgressStatsTableFactory { return new ProgressStatsTableFactory($services->getLinkRenderer(), $services->get( 'Translate:ConfigHelper'));}, 'Translate:SubpageListBuilder'=> static function(MediaWikiServices $services):SubpageListBuilder { return new SubpageListBuilder($services->get( 'Translate:TranslatableBundleFactory'), $services->getLinkBatchFactory());}, 'Translate:TranslatableBundleFactory'=> static function(MediaWikiServices $services):TranslatableBundleFactory { return new TranslatableBundleFactory($services->get( 'Translate:TranslatablePageStore'), $services->get( 'Translate:MessageBundleStore'));}, 'Translate:TranslatableBundleMover'=> static function(MediaWikiServices $services):TranslatableBundleMover { return new TranslatableBundleMover($services->getMovePageFactory(), $services->getJobQueueGroup(), $services->getLinkBatchFactory(), $services->get( 'Translate:TranslatableBundleFactory'), $services->get( 'Translate:SubpageListBuilder'), $services->getMainConfig() ->get( 'TranslatePageMoveLimit'));}, 'Translate:TranslatablePageParser'=> static function(MediaWikiServices $services):TranslatablePageParser { return new TranslatablePageParser($services->get( 'Translate:ParsingPlaceholderFactory'));}, 'Translate:TranslatablePageStore'=> static function(MediaWikiServices $services):TranslatablePageStore { return new TranslatablePageStore($services->get( 'Translate:MessageIndex'), $services->getJobQueueGroup(), new RevTagStore(), $services->getDBLoadBalancer());}, 'Translate:TranslationStashReader'=> static function(MediaWikiServices $services):TranslationStashReader { $db=$services->getDBLoadBalancer() ->getConnectionRef(DB_REPLICA);return new TranslationStashStorage( $db);}, 'Translate:TranslationStatsDataProvider'=> static function(MediaWikiServices $services):TranslationStatsDataProvider { return new TranslationStatsDataProvider(new ServiceOptions(TranslationStatsDataProvider::CONSTRUCTOR_OPTIONS, $services->getMainConfig()), $services->getObjectFactory());}, 'Translate:TranslationUnitStoreFactory'=> static function(MediaWikiServices $services):TranslationUnitStoreFactory { return new TranslationUnitStoreFactory( $services->getDBLoadBalancer());}, 'Translate:TranslatorActivity'=> static function(MediaWikiServices $services):TranslatorActivity { $query=new TranslatorActivityQuery($services->getMainConfig(), $services->getDBLoadBalancer());return new TranslatorActivity($services->getMainObjectStash(), $query, $services->getJobQueueGroup());}, 'Translate:TtmServerFactory'=> static function(MediaWikiServices $services):TtmServerFactory { $config=$services->getMainConfig();$default=$config->get( 'TranslateTranslationDefaultService');if( $default===false) { $default=null;} return new TtmServerFactory( $config->get( 'TranslateTranslationServices'), $default);}]
@phpcs-require-sorted-array