c03cb71796
Mostly used find-and-replace: Find: /\*[\*\s]+@var (I?[A-Z](\w+)(?:Interface)?)[\s\*]+/\s*(private|protected|public) (\$[a-z]\w+;\n)((?=\s*/\*[\*\s]+@var (I?[A-Z](\w+)(?:Interface)?))\n|) Replace with: \3 \1 \4 Followed by some manual review to make sure I'm not changing too much, omitting some changes that looked too complicated and anything that caused test failures, and some whitespace fixes. Change-Id: Ie78be1c614985d7c2964156e454cc9266515dc18
289 lines
8.6 KiB
PHP
289 lines
8.6 KiB
PHP
<?php
|
|
/**
|
|
* Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
use MediaWiki\Languages\LanguageFactory;
|
|
use MediaWiki\Languages\LanguageNameUtils;
|
|
use MediaWiki\Title\Title;
|
|
use Wikimedia\ParamValidator\ParamValidator;
|
|
|
|
/**
|
|
* A query action to return messages from site message cache
|
|
*
|
|
* @ingroup API
|
|
*/
|
|
class ApiQueryAllMessages extends ApiQueryBase {
|
|
|
|
private Language $contentLanguage;
|
|
private LanguageFactory $languageFactory;
|
|
private LanguageNameUtils $languageNameUtils;
|
|
private LocalisationCache $localisationCache;
|
|
private MessageCache $messageCache;
|
|
|
|
/**
|
|
* @param ApiQuery $query
|
|
* @param string $moduleName
|
|
* @param Language $contentLanguage
|
|
* @param LanguageFactory $languageFactory
|
|
* @param LanguageNameUtils $languageNameUtils
|
|
* @param LocalisationCache $localisationCache
|
|
* @param MessageCache $messageCache
|
|
*/
|
|
public function __construct(
|
|
ApiQuery $query,
|
|
$moduleName,
|
|
Language $contentLanguage,
|
|
LanguageFactory $languageFactory,
|
|
LanguageNameUtils $languageNameUtils,
|
|
LocalisationCache $localisationCache,
|
|
MessageCache $messageCache
|
|
) {
|
|
parent::__construct( $query, $moduleName, 'am' );
|
|
$this->contentLanguage = $contentLanguage;
|
|
$this->languageFactory = $languageFactory;
|
|
$this->languageNameUtils = $languageNameUtils;
|
|
$this->localisationCache = $localisationCache;
|
|
$this->messageCache = $messageCache;
|
|
}
|
|
|
|
public function execute() {
|
|
$params = $this->extractRequestParams();
|
|
if ( $params['lang'] === null ) {
|
|
$langObj = $this->getLanguage();
|
|
} elseif ( !$this->languageNameUtils->isValidCode( $params['lang'] ) ) {
|
|
$this->dieWithError(
|
|
[ 'apierror-invalidlang', $this->encodeParamName( 'lang' ) ], 'invalidlang'
|
|
);
|
|
} else {
|
|
$langObj = $this->languageFactory->getLanguage( $params['lang'] );
|
|
}
|
|
|
|
if ( $params['enableparser'] ) {
|
|
if ( $params['title'] !== null ) {
|
|
$title = Title::newFromText( $params['title'] );
|
|
if ( !$title || $title->isExternal() ) {
|
|
$this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $params['title'] ) ] );
|
|
}
|
|
} else {
|
|
$title = Title::newFromText( 'API' );
|
|
}
|
|
}
|
|
|
|
$prop = array_fill_keys( (array)$params['prop'], true );
|
|
|
|
// Determine which messages should we print
|
|
if ( in_array( '*', $params['messages'] ) ) {
|
|
$message_names = $this->localisationCache->getSubitemList( $langObj->getCode(), 'messages' ) ?? [];
|
|
if ( $params['includelocal'] ) {
|
|
$message_names = array_unique( array_merge(
|
|
$message_names,
|
|
// Pass in the content language code so we get local messages that have a
|
|
// MediaWiki:msgkey page. We might theoretically miss messages that have no
|
|
// MediaWiki:msgkey page but do have a MediaWiki:msgkey/lang page, but that's
|
|
// just a stupid case.
|
|
$this->messageCache->getAllMessageKeys( $this->contentLanguage->getCode() )
|
|
) );
|
|
}
|
|
sort( $message_names );
|
|
$messages_target = $message_names;
|
|
} else {
|
|
$messages_target = $params['messages'];
|
|
}
|
|
|
|
// Filter messages that have the specified prefix
|
|
// Because we sorted the message array earlier, they will appear in a clump:
|
|
if ( isset( $params['prefix'] ) ) {
|
|
$skip = false;
|
|
$messages_filtered = [];
|
|
foreach ( $messages_target as $message ) {
|
|
if ( str_starts_with( $message, $params['prefix'] ) ) {
|
|
if ( !$skip ) {
|
|
$skip = true;
|
|
}
|
|
$messages_filtered[] = $message;
|
|
} elseif ( $skip ) {
|
|
break;
|
|
}
|
|
}
|
|
$messages_target = $messages_filtered;
|
|
}
|
|
|
|
// Filter messages that contain specified string
|
|
if ( isset( $params['filter'] ) ) {
|
|
$messages_filtered = [];
|
|
foreach ( $messages_target as $message ) {
|
|
if ( str_contains( $message, $params['filter'] ) ) {
|
|
$messages_filtered[] = $message;
|
|
}
|
|
}
|
|
$messages_target = $messages_filtered;
|
|
}
|
|
|
|
// Whether we have any sort of message customisation filtering
|
|
$customiseFilterEnabled = $params['customised'] !== 'all';
|
|
if ( $customiseFilterEnabled ) {
|
|
$customisedMessages = AllMessagesTablePager::getCustomisedStatuses(
|
|
array_map(
|
|
[ $langObj, 'ucfirst' ],
|
|
$messages_target
|
|
),
|
|
$langObj->getCode(),
|
|
!$langObj->equals( $this->contentLanguage ),
|
|
$this->getDB()
|
|
);
|
|
|
|
$customised = $params['customised'] === 'modified';
|
|
}
|
|
|
|
// Get all requested messages and print the result
|
|
$skip = $params['from'] !== null;
|
|
$useto = $params['to'] !== null;
|
|
$result = $this->getResult();
|
|
foreach ( $messages_target as $message ) {
|
|
// Skip all messages up to $params['from']
|
|
if ( $skip && $message === $params['from'] ) {
|
|
$skip = false;
|
|
}
|
|
|
|
if ( $useto && $message > $params['to'] ) {
|
|
break;
|
|
}
|
|
|
|
if ( !$skip ) {
|
|
$a = [
|
|
'name' => $message,
|
|
'normalizedname' => MessageCache::normalizeKey( $message ),
|
|
];
|
|
|
|
$args = [];
|
|
if ( isset( $params['args'] ) && count( $params['args'] ) != 0 ) {
|
|
$args = $params['args'];
|
|
}
|
|
|
|
if ( $customiseFilterEnabled ) {
|
|
$messageIsCustomised = isset( $customisedMessages['pages'][$langObj->ucfirst( $message )] );
|
|
// @phan-suppress-next-line PhanPossiblyUndeclaredVariable customised is set when used
|
|
if ( $customised === $messageIsCustomised ) {
|
|
// @phan-suppress-next-line PhanPossiblyUndeclaredVariable customised is set when used
|
|
if ( $customised ) {
|
|
$a['customised'] = true;
|
|
}
|
|
} else {
|
|
continue;
|
|
}
|
|
}
|
|
|
|
$msg = $this->msg( $message, $args )->inLanguage( $langObj );
|
|
|
|
if ( !$msg->exists() ) {
|
|
$a['missing'] = true;
|
|
} else {
|
|
// Check if the parser is enabled:
|
|
if ( $params['enableparser'] ) {
|
|
// @phan-suppress-next-line PhanPossiblyUndeclaredVariable title is set when used
|
|
$msgString = $msg->page( $title )->text();
|
|
} else {
|
|
$msgString = $msg->plain();
|
|
}
|
|
if ( !$params['nocontent'] ) {
|
|
ApiResult::setContentValue( $a, 'content', $msgString );
|
|
}
|
|
if ( isset( $prop['default'] ) ) {
|
|
$default = $this->msg( $message )->inLanguage( $langObj )->useDatabase( false );
|
|
if ( !$default->exists() ) {
|
|
$a['defaultmissing'] = true;
|
|
} elseif ( $default->plain() != $msgString ) {
|
|
$a['default'] = $default->plain();
|
|
}
|
|
}
|
|
}
|
|
$fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $a );
|
|
if ( !$fit ) {
|
|
$this->setContinueEnumParameter( 'from', $message );
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
$result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'message' );
|
|
}
|
|
|
|
public function getCacheMode( $params ) {
|
|
if ( $params['lang'] === null ) {
|
|
// Language not specified, will be fetched from preferences
|
|
return 'anon-public-user-private';
|
|
} elseif ( $params['enableparser'] ) {
|
|
// User-specific parser options will be used
|
|
return 'anon-public-user-private';
|
|
} else {
|
|
// OK to cache
|
|
return 'public';
|
|
}
|
|
}
|
|
|
|
public function getAllowedParams() {
|
|
return [
|
|
'messages' => [
|
|
ParamValidator::PARAM_DEFAULT => '*',
|
|
ParamValidator::PARAM_ISMULTI => true,
|
|
],
|
|
'prop' => [
|
|
ParamValidator::PARAM_ISMULTI => true,
|
|
ParamValidator::PARAM_TYPE => [
|
|
'default'
|
|
]
|
|
],
|
|
'enableparser' => false,
|
|
'nocontent' => false,
|
|
'includelocal' => false,
|
|
'args' => [
|
|
ParamValidator::PARAM_ISMULTI => true,
|
|
ParamValidator::PARAM_ALLOW_DUPLICATES => true,
|
|
],
|
|
'filter' => [],
|
|
'customised' => [
|
|
ParamValidator::PARAM_DEFAULT => 'all',
|
|
ParamValidator::PARAM_TYPE => [
|
|
'all',
|
|
'modified',
|
|
'unmodified'
|
|
]
|
|
],
|
|
'lang' => null,
|
|
'from' => null,
|
|
'to' => null,
|
|
'title' => null,
|
|
'prefix' => null,
|
|
];
|
|
}
|
|
|
|
protected function getExamplesMessages() {
|
|
return [
|
|
'action=query&meta=allmessages&refix=ipb-'
|
|
=> 'apihelp-query+allmessages-example-ipb',
|
|
'action=query&meta=allmessages&ammessages=august|mainpage&amlang=de'
|
|
=> 'apihelp-query+allmessages-example-de',
|
|
];
|
|
}
|
|
|
|
public function getHelpUrls() {
|
|
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allmessages';
|
|
}
|
|
}
|