3 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * A query action to return messages from site message cache
28 class ApiQueryAllMessages
extends ApiQueryBase
{
30 public function __construct( ApiQuery
$query, $moduleName ) {
31 parent
::__construct( $query, $moduleName, 'am' );
34 public function execute() {
35 $params = $this->extractRequestParams();
37 if ( is_null( $params['lang'] ) ) {
38 $langObj = $this->getLanguage();
39 } elseif ( !Language
::isValidCode( $params['lang'] ) ) {
41 [ 'apierror-invalidlang', $this->encodeParamName( 'lang' ) ], 'invalidlang'
44 $langObj = Language
::factory( $params['lang'] );
47 if ( $params['enableparser'] ) {
48 if ( !is_null( $params['title'] ) ) {
49 $title = Title
::newFromText( $params['title'] );
50 if ( !$title ||
$title->isExternal() ) {
51 $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $params['title'] ) ] );
54 $title = Title
::newFromText( 'API' );
58 $prop = array_flip( (array)$params['prop'] );
60 // Determine which messages should we print
61 if ( in_array( '*', $params['messages'] ) ) {
62 $message_names = Language
::getMessageKeysFor( $langObj->getCode() );
63 if ( $params['includelocal'] ) {
64 $message_names = array_unique( array_merge(
66 // Pass in the content language code so we get local messages that have a
67 // MediaWiki:msgkey page. We might theoretically miss messages that have no
68 // MediaWiki:msgkey page but do have a MediaWiki:msgkey/lang page, but that's
69 // just a stupid case.
70 MessageCache
::singleton()->getAllMessageKeys( $this->getConfig()->get( 'LanguageCode' ) )
73 sort( $message_names );
74 $messages_target = $message_names;
76 $messages_target = $params['messages'];
79 // Filter messages that have the specified prefix
80 // Because we sorted the message array earlier, they will appear in a clump:
81 if ( isset( $params['prefix'] ) ) {
83 $messages_filtered = [];
84 foreach ( $messages_target as $message ) {
85 // === 0: must be at beginning of string (position 0)
86 if ( strpos( $message, $params['prefix'] ) === 0 ) {
90 $messages_filtered[] = $message;
95 $messages_target = $messages_filtered;
98 // Filter messages that contain specified string
99 if ( isset( $params['filter'] ) ) {
100 $messages_filtered = [];
101 foreach ( $messages_target as $message ) {
102 // !== is used because filter can be at the beginning of the string
103 if ( strpos( $message, $params['filter'] ) !== false ) {
104 $messages_filtered[] = $message;
107 $messages_target = $messages_filtered;
110 // Whether we have any sort of message customisation filtering
111 $customiseFilterEnabled = $params['customised'] !== 'all';
112 if ( $customiseFilterEnabled ) {
115 $customisedMessages = AllMessagesTablePager
::getCustomisedStatuses(
117 [ $langObj, 'ucfirst' ],
121 !$langObj->equals( $wgContLang )
124 $customised = $params['customised'] === 'modified';
127 // Get all requested messages and print the result
128 $skip = !is_null( $params['from'] );
129 $useto = !is_null( $params['to'] );
130 $result = $this->getResult();
131 foreach ( $messages_target as $message ) {
132 // Skip all messages up to $params['from']
133 if ( $skip && $message === $params['from'] ) {
137 if ( $useto && $message > $params['to'] ) {
144 'normalizedname' => MessageCache
::normalizeKey( $message ),
148 if ( isset( $params['args'] ) && count( $params['args'] ) != 0 ) {
149 $args = $params['args'];
152 if ( $customiseFilterEnabled ) {
153 $messageIsCustomised = isset( $customisedMessages['pages'][$langObj->ucfirst( $message )] );
154 if ( $customised === $messageIsCustomised ) {
156 $a['customised'] = true;
163 $msg = wfMessage( $message, $args )->inLanguage( $langObj );
165 if ( !$msg->exists() ) {
166 $a['missing'] = true;
168 // Check if the parser is enabled:
169 if ( $params['enableparser'] ) {
170 $msgString = $msg->title( $title )->text();
172 $msgString = $msg->plain();
174 if ( !$params['nocontent'] ) {
175 ApiResult
::setContentValue( $a, 'content', $msgString );
177 if ( isset( $prop['default'] ) ) {
178 $default = wfMessage( $message )->inLanguage( $langObj )->useDatabase( false );
179 if ( !$default->exists() ) {
180 $a['defaultmissing'] = true;
181 } elseif ( $default->plain() != $msgString ) {
182 $a['default'] = $default->plain();
186 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $a );
188 $this->setContinueEnumParameter( 'from', $message );
193 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'message' );
196 public function getCacheMode( $params ) {
197 if ( is_null( $params['lang'] ) ) {
198 // Language not specified, will be fetched from preferences
199 return 'anon-public-user-private';
200 } elseif ( $params['enableparser'] ) {
201 // User-specific parser options will be used
202 return 'anon-public-user-private';
209 public function getAllowedParams() {
212 ApiBase
::PARAM_DFLT
=> '*',
213 ApiBase
::PARAM_ISMULTI
=> true,
216 ApiBase
::PARAM_ISMULTI
=> true,
217 ApiBase
::PARAM_TYPE
=> [
221 'enableparser' => false,
222 'nocontent' => false,
223 'includelocal' => false,
225 ApiBase
::PARAM_ISMULTI
=> true,
226 ApiBase
::PARAM_ALLOW_DUPLICATES
=> true,
230 ApiBase
::PARAM_DFLT
=> 'all',
231 ApiBase
::PARAM_TYPE
=> [
245 protected function getExamplesMessages() {
247 'action=query&meta=allmessages&refix=ipb-'
248 => 'apihelp-query+allmessages-example-ipb',
249 'action=query&meta=allmessages&ammessages=august|mainpage&amlang=de'
250 => 'apihelp-query+allmessages-example-de',
254 public function getHelpUrls() {
255 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allmessages';