27 private const RIGHT =
'translate-manage';
29 public function execute():
void {
30 $this->checkUserRightsAny( self::RIGHT );
31 $params = $this->extractRequestParams();
33 $groupId = $params[
'groupId'];
34 $op = $params[
'operation'];
35 $msgKey = $params[
'messageKey'];
36 $name = $params[
'changesetName'] ?? MessageChangeStorage::DEFAULT_NAME;
37 $changesetModifiedTime = $params[
'changesetModified'];
40 if ( !MessageChangeStorage::isValidCdbName( $name ) ) {
42 [
'apierror-translate-invalid-changeset-name', wfEscapeWikiText( $name ) ],
46 $cdbPath = MessageChangeStorage::getCdbPath( $name );
48 if ( !MessageChangeStorage::isModifiedSince( $cdbPath, $changesetModifiedTime ) ) {
50 $this->dieWithError( [
'apierror-translate-changeset-modified' ] );
53 if ( $op ===
'rename' ) {
54 if ( !isset( $params[
'renameMessageKey'] ) ) {
55 $this->dieWithError( [
'apierror-missingparam',
'renameMessageKey' ] );
57 $keyToRename = $params[
'renameMessageKey'];
60 $sourceChanges = MessageChangeStorage::getGroupChanges( $cdbPath, $groupId );
61 if ( $sourceChanges->getAllModifications() === [] ) {
62 $this->dieWithError( [
'apierror-translate-smg-nochanges' ] );
66 if ( $group ===
null ) {
67 $this->dieWithError(
'apierror-translate-invalidgroup',
'invalidgroup' );
71 if ( $op ===
'rename' ) {
73 $group, $sourceChanges, $msgKey, $keyToRename, $group->getSourceLanguage()
75 } elseif ( $op ===
'new' ) {
76 $this->
handleNew( $sourceChanges, $msgKey, $group->getSourceLanguage() );
79 [
'apierror-translate-invalid-operation', wfEscapeWikiText( $op ),
80 wfEscapeWikiText( implode(
'/', [
'new',
'rename' ] ) ) ],
84 }
catch ( Exception $ex ) {
88 'newMsgKey' => $msgKey,
89 'msgKey' => $keyToRename,
90 'groupId' => $group->getId(),
91 'group' => $group->getLabel(),
92 'groupSourceLang' => $group->getSourceLanguage(),
97 "Error while running: ManageMessageGroupsActionApi::execute. Inputs: \n" .
98 FormatJson::encode( $data,
true )
105 MessageChangeStorage::writeGroupChanges( $sourceChanges, $groupId, $cdbPath );
107 $this->getResult()->addValue(
null, $this->getModuleName(), [
118 string $sourceLanguage
120 $languages = $sourceChanges->getLanguages();
122 foreach ( $languages as $code ) {
123 $msgState = $renameMsgState =
null;
125 $isSourceLang = $sourceLanguage === $code;
126 if ( $isSourceLang ) {
127 $this->handleSourceRename( $sourceChanges, $code, $msgKey, $keyToRename );
134 $msg = $sourceChanges->
findMessage( $code, $msgKey, [
135 MessageSourceChange::ADDITION,
136 MessageSourceChange::RENAME
145 $msg ??= $sourceChanges->
findMessage( $code, $keyToRename, [
146 MessageSourceChange::DELETION,
147 MessageSourceChange::CHANGE,
148 MessageSourceChange::RENAME
151 if ( $msg ===
null ) {
159 [ MessageSourceChange::RENAME, MessageSourceChange::DELETION ],
166 if ( $renameMsg ===
null || !isset( $renameMsg[
'content'] ) ) {
167 $title = Title::newFromText(
168 Utilities::title( $keyToRename, $code, $group->
getNamespace() ),
172 $renameContent = Utilities::getContentForTitle( $title,
true ) ??
'';
175 'key' => $keyToRename,
176 'content' => $renameContent
181 if ( $renameMsgState ===
null ) {
182 $renameMsgState = MessageSourceChange::NONE;
187 if ( $msgState === MessageSourceChange::RENAME ) {
188 $msgState = $sourceChanges->
breakRename( $code, $msg[
'key'] );
193 if ( $renameMsgState === MessageSourceChange::RENAME ) {
194 $renameMsgState = $sourceChanges->
breakRename( $code, $renameMsg[
'key'] );
195 } elseif ( $renameMsgState !== MessageSourceChange::NONE ) {
200 $msg[
'key'] = $msgKey;
204 $similarity = $stringComparator->getSimilarity(
206 $renameMsg[
'content']
208 $sourceChanges->
addRename( $code, $msg, $renameMsg, $similarity );
209 $sourceChanges->setRenameState( $code, $msgKey, $msgState );
210 $sourceChanges->setRenameState( $code, $keyToRename, $renameMsgState );
214 protected function handleSourceRename(
215 MessageSourceChange $sourceChanges,
220 $msgState = $renameMsgState = null;
222 $msg = $sourceChanges->findMessage(
223 $code, $msgKey, [ MessageSourceChange::ADDITION, MessageSourceChange::RENAME ], $msgState
226 $renameMsg = $sourceChanges->findMessage(
229 [ MessageSourceChange::DELETION, MessageSourceChange::RENAME ],
233 if ( $msg ===
null || $renameMsg ===
null ) {
234 $this->dieWithError(
'apierror-translate-rename-key-invalid' );
237 if ( $msgState === MessageSourceChange::RENAME ) {
239 $msgState = $sourceChanges->breakRename( $code, $msg[
'key'] );
242 if ( $renameMsgState === MessageSourceChange::RENAME ) {
244 $renameMsgState = $sourceChanges->breakRename( $code, $renameMsg[
'key'] );
248 if ( $msgState !== MessageSourceChange::ADDITION ||
249 $renameMsgState !== MessageSourceChange::DELETION ) {
250 $this->dieWithError( [
251 'apierror-translate-rename-state-invalid',
252 wfEscapeWikiText( $msgState ), wfEscapeWikiText( $renameMsgState )
257 $sourceChanges->removeAdditions( $code, [ $msgKey ] );
258 $sourceChanges->removeDeletions( $code, [ $keyToRename ] );
261 $stringComparator =
new SimpleStringComparator();
262 $similarity = $stringComparator->getSimilarity(
266 $renameMsg[
'content']
268 $sourceChanges->addRename( $code, $msg, $renameMsg, $similarity );
280 foreach ( $languages as $code ) {
282 $code, $msgKey, [ MessageSourceChange::RENAME ], $msgState
285 if ( $code === $sourceLang && $msg ===
null ) {
286 $this->dieWithError(
'apierror-translate-addition-key-invalid' );
289 if ( $code === $sourceLang && $msgState !== MessageSourceChange::RENAME ) {
290 $this->dieWithError(
'apierror-translate-rename-msg-new' );
294 if ( $msg ===
null ) {
303 protected function getAllowedParams(): array {
306 ParamValidator::PARAM_TYPE =>
'string',
307 ParamValidator::PARAM_REQUIRED => true,
309 'renameMessageKey' => [
310 ParamValidator::PARAM_TYPE =>
'string',
311 ParamValidator::PARAM_REQUIRED => false,
314 ParamValidator::PARAM_TYPE =>
'string',
315 ParamValidator::PARAM_REQUIRED => true,
318 ParamValidator::PARAM_TYPE => [
'rename',
'new' ],
319 ParamValidator::PARAM_ISMULTI => false,
320 ParamValidator::PARAM_REQUIRED => true,
323 ParamValidator::PARAM_TYPE =>
'string',
324 ParamValidator::PARAM_DEFAULT => MessageChangeStorage::DEFAULT_NAME
326 'changesetModified' => [
327 ParamValidator::PARAM_TYPE =>
'integer',
328 ParamValidator::PARAM_REQUIRED => true,
333 public function isInternal(): bool {
337 public function needsToken(): string {
return[ 'Translate:AggregateGroupManager'=> static function(MediaWikiServices $services):AggregateGroupManager { return new AggregateGroupManager( $services->getTitleFactory());}, 'Translate:AggregateGroupMessageGroupFactory'=> static function(MediaWikiServices $services):AggregateGroupMessageGroupFactory { return new AggregateGroupMessageGroupFactory($services->get( 'Translate:MessageGroupMetadata'));}, '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:ExternalMessageSourceStateComparator'=> static function(MediaWikiServices $services):ExternalMessageSourceStateComparator { return new ExternalMessageSourceStateComparator(new SimpleStringComparator(), $services->getRevisionLookup(), $services->getPageStore());}, 'Translate:ExternalMessageSourceStateImporter'=> static function(MediaWikiServices $services):ExternalMessageSourceStateImporter { return new ExternalMessageSourceStateImporter($services->get( 'Translate:GroupSynchronizationCache'), $services->getJobQueueGroup(), LoggerFactory::getInstance( 'Translate.GroupSynchronization'), $services->get( 'Translate:MessageIndex'), $services->getTitleFactory(), new ServiceOptions(ExternalMessageSourceStateImporter::CONSTRUCTOR_OPTIONS, $services->getMainConfig()));}, 'Translate:FileBasedMessageGroupFactory'=> static function(MediaWikiServices $services):FileBasedMessageGroupFactory { return new FileBasedMessageGroupFactory(new MessageGroupConfigurationParser(), new ServiceOptions(FileBasedMessageGroupFactory::SERVICE_OPTIONS, $services->getMainConfig()),);}, 'Translate:FileFormatFactory'=> static function(MediaWikiServices $services):FileFormatFactory { return new FileFormatFactory( $services->getObjectFactory());}, 'Translate:GroupSynchronizationCache'=> static function(MediaWikiServices $services):GroupSynchronizationCache { return new GroupSynchronizationCache( $services->get( 'Translate:PersistentCache'));}, 'Translate:HookDefinedMessageGroupFactory'=> static function(MediaWikiServices $services):HookDefinedMessageGroupFactory { return new HookDefinedMessageGroupFactory( $services->get( 'Translate:HookRunner'));}, 'Translate:HookRunner'=> static function(MediaWikiServices $services):HookRunner { return new HookRunner( $services->getHookContainer());}, 'Translate:MessageBundleMessageGroupFactory'=> static function(MediaWikiServices $services):MessageBundleMessageGroupFactory { return new MessageBundleMessageGroupFactory($services->get( 'Translate:MessageGroupMetadata'), new ServiceOptions(MessageBundleMessageGroupFactory::SERVICE_OPTIONS, $services->getMainConfig()),);}, 'Translate:MessageBundleStore'=> static function(MediaWikiServices $services):MessageBundleStore { return new MessageBundleStore($services->get( 'Translate:RevTagStore'), $services->getJobQueueGroup(), $services->getLanguageNameUtils(), $services->get( 'Translate:MessageIndex'), $services->get( 'Translate:MessageGroupMetadata'));}, 'Translate:MessageBundleTranslationLoader'=> static function(MediaWikiServices $services):MessageBundleTranslationLoader { return new MessageBundleTranslationLoader( $services->getLanguageFallback());}, 'Translate:MessageGroupMetadata'=> static function(MediaWikiServices $services):MessageGroupMetadata { return new MessageGroupMetadata( $services->getDBLoadBalancer());}, 'Translate:MessageGroupReviewStore'=> static function(MediaWikiServices $services):MessageGroupReviewStore { return new MessageGroupReviewStore($services->getDBLoadBalancer(), $services->get( 'Translate:HookRunner'));}, 'Translate:MessageGroupStatsTableFactory'=> static function(MediaWikiServices $services):MessageGroupStatsTableFactory { return new MessageGroupStatsTableFactory($services->get( 'Translate:ProgressStatsTableFactory'), $services->getDBLoadBalancer(), $services->getLinkRenderer(), $services->get( 'Translate:MessageGroupReviewStore'), $services->get( 'Translate:MessageGroupMetadata'), $services->getMainConfig() ->get( 'TranslateWorkflowStates') !==false);}, 'Translate:MessageGroupSubscription'=> static function(MediaWikiServices $services):MessageGroupSubscription { return new MessageGroupSubscription($services->get( 'Translate:MessageGroupSubscriptionStore'), $services->getJobQueueGroup(), $services->getUserIdentityLookup(), LoggerFactory::getInstance( 'Translate.MessageGroupSubscription'), new ServiceOptions(MessageGroupSubscription::CONSTRUCTOR_OPTIONS, $services->getMainConfig()));}, 'Translate:MessageGroupSubscriptionHookHandler'=> static function(MediaWikiServices $services):MessageGroupSubscriptionHookHandler { return new MessageGroupSubscriptionHookHandler($services->get( 'Translate:MessageGroupSubscription'), $services->getUserFactory());}, 'Translate:MessageGroupSubscriptionStore'=> static function(MediaWikiServices $services):MessageGroupSubscriptionStore { return new MessageGroupSubscriptionStore( $services->getDBLoadBalancerFactory());}, 'Translate:MessageIndex'=> static function(MediaWikiServices $services):MessageIndex { $params=(array) $services->getMainConfig() ->get( 'TranslateMessageIndex');$class=array_shift( $params);$implementationMap=['HashMessageIndex'=> HashMessageIndex::class, 'CDBMessageIndex'=> CDBMessageIndex::class, 'DatabaseMessageIndex'=> DatabaseMessageIndex::class, 'hash'=> HashMessageIndex::class, 'cdb'=> CDBMessageIndex::class, 'database'=> DatabaseMessageIndex::class,];$messageIndexStoreClass=$implementationMap[$class] ?? $implementationMap['database'];return new MessageIndex(new $messageIndexStoreClass, $services->getMainWANObjectCache(), $services->getJobQueueGroup(), $services->get( 'Translate:HookRunner'), LoggerFactory::getInstance( 'Translate'), $services->getMainObjectStash(), $services->getDBLoadBalancerFactory(), $services->get( 'Translate:MessageGroupSubscription'), new ServiceOptions(MessageIndex::SERVICE_OPTIONS, $services->getMainConfig()),);}, 'Translate:MessagePrefixStats'=> static function(MediaWikiServices $services):MessagePrefixStats { return new MessagePrefixStats( $services->getTitleParser());}, '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'), $services->get( 'Translate:MessageGroupMetadata'));}, 'Translate:RevTagStore'=> static function(MediaWikiServices $services):RevTagStore { return new RevTagStore( $services->getDBLoadBalancer());}, 'Translate:SubpageListBuilder'=> static function(MediaWikiServices $services):SubpageListBuilder { return new SubpageListBuilder($services->get( 'Translate:TranslatableBundleFactory'), $services->getLinkBatchFactory());}, 'Translate:TranslatableBundleDeleter'=> static function(MediaWikiServices $services):TranslatableBundleDeleter { return new TranslatableBundleDeleter($services->getMainObjectStash(), $services->getJobQueueGroup(), $services->get( 'Translate:SubpageListBuilder'), $services->get( 'Translate:TranslatableBundleFactory'));}, 'Translate:TranslatableBundleExporter'=> static function(MediaWikiServices $services):TranslatableBundleExporter { return new TranslatableBundleExporter($services->get( 'Translate:SubpageListBuilder'), $services->getWikiExporterFactory(), $services->getDBLoadBalancer());}, 'Translate:TranslatableBundleFactory'=> static function(MediaWikiServices $services):TranslatableBundleFactory { return new TranslatableBundleFactory($services->get( 'Translate:TranslatablePageStore'), $services->get( 'Translate:MessageBundleStore'));}, 'Translate:TranslatableBundleImporter'=> static function(MediaWikiServices $services):TranslatableBundleImporter { return new TranslatableBundleImporter($services->getWikiImporterFactory(), $services->get( 'Translate:TranslatablePageParser'), $services->getRevisionLookup(), $services->getNamespaceInfo(), $services->getTitleFactory());}, '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->getDBLoadBalancerFactory(), $services->getMainConfig() ->get( 'TranslatePageMoveLimit'));}, 'Translate:TranslatableBundleStatusStore'=> static function(MediaWikiServices $services):TranslatableBundleStatusStore { return new TranslatableBundleStatusStore($services->getDBLoadBalancer() ->getConnection(DB_PRIMARY), $services->getCollationFactory() ->makeCollation( 'uca-default-u-kn'), $services->getDBLoadBalancer() ->getMaintenanceConnectionRef(DB_PRIMARY));}, 'Translate:TranslatablePageMarker'=> static function(MediaWikiServices $services):TranslatablePageMarker { return new TranslatablePageMarker($services->getDBLoadBalancer(), $services->getJobQueueGroup(), $services->getLinkRenderer(), MessageGroups::singleton(), $services->get( 'Translate:MessageIndex'), $services->getTitleFormatter(), $services->getTitleParser(), $services->get( 'Translate:TranslatablePageParser'), $services->get( 'Translate:TranslatablePageStore'), $services->get( 'Translate:TranslatablePageStateStore'), $services->get( 'Translate:TranslationUnitStoreFactory'), $services->get( 'Translate:MessageGroupMetadata'), $services->getWikiPageFactory(), $services->get( 'Translate:TranslatablePageView'));}, 'Translate:TranslatablePageMessageGroupFactory'=> static function(MediaWikiServices $services):TranslatablePageMessageGroupFactory { return new TranslatablePageMessageGroupFactory(new ServiceOptions(TranslatablePageMessageGroupFactory::SERVICE_OPTIONS, $services->getMainConfig()),);}, 'Translate:TranslatablePageParser'=> static function(MediaWikiServices $services):TranslatablePageParser { return new TranslatablePageParser($services->get( 'Translate:ParsingPlaceholderFactory'));}, 'Translate:TranslatablePageStateStore'=> static function(MediaWikiServices $services):TranslatablePageStateStore { return new TranslatablePageStateStore($services->get( 'Translate:PersistentCache'), $services->getPageStore());}, 'Translate:TranslatablePageStore'=> static function(MediaWikiServices $services):TranslatablePageStore { return new TranslatablePageStore($services->get( 'Translate:MessageIndex'), $services->getJobQueueGroup(), $services->get( 'Translate:RevTagStore'), $services->getDBLoadBalancer(), $services->get( 'Translate:TranslatableBundleStatusStore'), $services->get( 'Translate:TranslatablePageParser'), $services->get( 'Translate:MessageGroupMetadata'));}, 'Translate:TranslatablePageView'=> static function(MediaWikiServices $services):TranslatablePageView { return new TranslatablePageView($services->getDBLoadBalancerFactory(), $services->get( 'Translate:TranslatablePageStateStore'), new ServiceOptions(TranslatablePageView::SERVICE_OPTIONS, $services->getMainConfig()));}, 'Translate:TranslateSandbox'=> static function(MediaWikiServices $services):TranslateSandbox { return new TranslateSandbox($services->getUserFactory(), $services->getDBLoadBalancer(), $services->getPermissionManager(), $services->getAuthManager(), $services->getUserGroupManager(), $services->getActorStore(), $services->getUserOptionsManager(), $services->getJobQueueGroup(), $services->get( 'Translate:HookRunner'), new ServiceOptions(TranslateSandbox::CONSTRUCTOR_OPTIONS, $services->getMainConfig()));}, 'Translate:TranslationStashReader'=> static function(MediaWikiServices $services):TranslationStashReader { $db=$services->getDBLoadBalancer() ->getConnection(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(), $services->getDBLoadBalancer());}, '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