32 private $configHelper;
34 private $languageNameUtils;
36 private $loadBalancer;
38 public function __construct(
42 LanguageNameUtils $languageNameUtils,
43 ILoadBalancer $loadBalancer
45 parent::__construct( $query, $moduleName,
'mc' );
46 $this->configHelper = $configHelper;
47 $this->languageNameUtils = $languageNameUtils;
48 $this->loadBalancer = $loadBalancer;
51 public function execute():
void {
62 $this->run( $resultPageSet );
65 private function validateLanguageCode(
string $code ): void {
66 if ( !
Utilities::isSupportedLanguageCode( $code ) ) {
67 $this->dieWithError( [
'apierror-translate-invalidlanguage', $code ] );
71 private function run( ApiPageSet $resultPageSet =
null ): void {
72 $params = $this->extractRequestParams();
74 $group = MessageGroups::getGroup( $params[
'group'] );
76 $this->dieWithError( [
'apierror-badparameter',
'mcgroup' ] );
79 $languageCode = $params[
'language' ];
80 $this->validateLanguageCode( $languageCode );
81 $sourceLanguageCode = $group->getSourceLanguage();
85 if ( $sourceLanguageCode === $languageCode ) {
86 $name = $this->getLanguageName( $languageCode );
87 $this->addWarning( [
'apiwarn-translate-language-disabled-source', wfEscapeWikiText( $name ) ] );
89 $languages = $group->getTranslatableLanguages();
90 if ( $languages ===
null ) {
93 strtok( $group->getId(),
'-' ),
97 $disabledLanguages = $this->configHelper->getDisabledTargetLanguages();
98 foreach ( $checks as $check ) {
99 if ( isset( $disabledLanguages[ $check ][ $languageCode ] ) ) {
100 $name = $this->getLanguageName( $languageCode );
101 $reason = $disabledLanguages[ $check ][ $languageCode ];
102 $this->dieWithError( [
'apierror-translate-language-disabled-reason', $name, $reason ] );
105 } elseif ( !isset( $languages[ $languageCode ] ) ) {
107 $name = $this->getLanguageName( $languageCode );
108 $this->dieWithError( [
'apierror-translate-language-disabled', $name ] );
113 if ( strtok( $sourceLanguageCode,
'-' ) === strtok( $languageCode,
'-' ) ) {
114 $sourceLaguageName = $this->getLanguageName( $sourceLanguageCode );
115 $targetLaguageName = $this->getLanguageName( $languageCode );
117 'apiwarn-translate-language-targetlang-variant-of-source',
118 wfEscapeWikiText( $targetLaguageName ),
119 wfEscapeWikiText( $sourceLaguageName ) ]
124 if ( MessageGroups::isDynamic( $group ) ) {
127 $group->setLanguage( $params[
'language'] );
130 $messages = $group->initCollection( $params[
'language'] );
132 foreach ( $params[
'filter'] as $filter ) {
134 if ( strpos( $filter,
':' ) !==
false ) {
135 list( $filter, $value ) = explode(
':', $filter, 2 );
141 $value = $value ===
null ? $value : (int)$value;
142 if ( $filter[0] ===
'!' ) {
143 $messages->filter( substr( $filter, 1 ),
true, $value );
145 $messages->filter( $filter,
false, $value );
147 }
catch ( MWException $e ) {
149 [
'apierror-translate-invalidfilter', wfEscapeWikiText( $e->getMessage() ) ],
155 $resultSize = count( $messages );
156 $offsets = $messages->slice( $params[
'offset'], $params[
'limit'] );
157 $batchSize = count( $messages );
158 list( , $forwardsOffset, $startOffset ) = $offsets;
160 $result = $this->getResult();
162 [
'query',
'metadata' ],
164 self::getWorkflowState( $group->getId(), $params[
'language'] )
167 $result->addValue( [
'query',
'metadata' ],
'resultsize', $resultSize );
169 [
'query',
'metadata' ],
171 $resultSize - $startOffset - $batchSize
174 $messages->loadTranslations();
178 if ( $forwardsOffset !==
false ) {
179 $this->setContinueEnumParameter(
'offset', $forwardsOffset );
182 $props = array_flip( $params[
'prop'] );
185 foreach ( $messages->keys() as $mkey => $titleValue ) {
186 $title = Title::newFromLinkTarget( $titleValue );
188 if ( $resultPageSet ===
null ) {
189 $data = $this->extractMessageData( $result, $props, $messages[$mkey] );
190 $data[
'title'] = $title->getPrefixedText();
191 $data[
'targetLanguage'] = $messages->getLanguage();
195 if ( $handle->isValid() ) {
196 $data[
'primaryGroup'] = $handle->getGroup()->getId();
199 $result->addValue( [
'query', $this->getModuleName() ],
null, $data );
205 if ( $resultPageSet ===
null ) {
206 $result->addIndexedTagName(
207 [
'query', $this->getModuleName() ],
211 $resultPageSet->populateFromTitles( $pages );
215 private function getLanguageName(
string $languageCode ): string {
218 ->getLanguageName( $languageCode, $this->getLanguage()->getCode() );
221 private function extractMessageData(
226 $data = [
'key' => $message->key() ];
228 if ( isset( $props[
'definition'] ) ) {
231 if ( isset( $props[
'translation'] ) ) {
234 if ( $translation !==
null ) {
235 $translation = str_replace( TRANSLATE_FUZZY,
'', $translation );
237 $data[
'translation'] = $translation;
239 if ( isset( $props[
'tags'] ) ) {
240 $data[
'tags'] = $message->
getTags();
241 $result->setIndexedTagName( $data[
'tags'],
'tag' );
244 if ( isset( $props[
'revision'] ) ) {
245 $data[
'revision'] = $message->getProperty(
'revision' );
247 if ( isset( $props[
'properties'] ) ) {
249 $data[
'properties'][$prop] = $message->getProperty( $prop );
250 ApiResult::setIndexedTagNameRecursive( $data[
'properties'],
'val' );
261 private function getWorkflowState(
string $groupId,
string $language ) {
262 $dbr = $this->loadBalancer->getConnection( DB_REPLICA );
263 return $dbr->newSelectQueryBuilder()
264 ->select(
'tgr_state' )
265 ->from(
'translate_groupreviews' )
267 'tgr_group' => $groupId,
268 'tgr_lang' => $language
270 ->caller( __METHOD__ )
278 ParamValidator::PARAM_TYPE =>
'string',
279 ParamValidator::PARAM_REQUIRED => true,
282 ParamValidator::PARAM_TYPE =>
'string',
283 ParamValidator::PARAM_DEFAULT =>
'en',
286 ParamValidator::PARAM_DEFAULT => 500,
287 ParamValidator::PARAM_TYPE =>
'limit',
288 IntegerDef::PARAM_MIN => 1,
289 IntegerDef::PARAM_MAX => ApiBase::LIMIT_BIG2,
290 IntegerDef::PARAM_MAX2 => ApiBase::LIMIT_BIG2,
293 ParamValidator::PARAM_DEFAULT =>
'',
294 ParamValidator::PARAM_TYPE =>
'string',
295 ApiBase::PARAM_HELP_MSG =>
'api-help-param-continue',
298 ParamValidator::PARAM_TYPE =>
'string',
299 ParamValidator::PARAM_DEFAULT =>
'!optional|!ignored',
300 ParamValidator::PARAM_ISMULTI => true,
303 ParamValidator::PARAM_TYPE => [
310 ParamValidator::PARAM_DEFAULT =>
'definition|translation',
311 ParamValidator::PARAM_ISMULTI => true,
312 ApiBase::PARAM_HELP_MSG =>
313 [
'apihelp-query+messagecollection-param-prop', TRANSLATE_FUZZY ],
321 'action=query&meta=siteinfo&siprop=languages'
322 =>
'apihelp-query+messagecollection-example-1',
323 'action=query&list=messagecollection&mcgroup=page-Example'
324 =>
'apihelp-query+messagecollection-example-2',
325 'action=query&list=messagecollection&mcgroup=page-Example&mclanguage=fi&' .
326 'mcprop=definition|translation|tags&mcfilter=optional'
327 =>
'apihelp-query+messagecollection-example-3',
328 'action=query&generator=messagecollection&gmcgroup=page-Example&gmclanguage=nl&prop=revisions'
329 =>
'apihelp-query+messagecollection-example-4',
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'), $services->get( 'Translate:MessageIndex'));}, '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:MessageGroupStatsTableFactory'=> static function(MediaWikiServices $services):MessageGroupStatsTableFactory { return new MessageGroupStatsTableFactory($services->get( 'Translate:ProgressStatsTableFactory'), $services->getDBLoadBalancer(), $services->getLinkRenderer(), $services->getMainConfig() ->get( 'TranslateWorkflowStates') !==false);}, '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: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'));}, '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: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: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(), $services->get( 'Translate:TranslatableBundleStatusStore'));}, '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