MediaWiki  1.23.2
ApiQueryAllMessages.php
Go to the documentation of this file.
1 <?php
33 
34  public function __construct( $query, $moduleName ) {
35  parent::__construct( $query, $moduleName, 'am' );
36  }
37 
38  public function execute() {
39  $params = $this->extractRequestParams();
40 
41  if ( is_null( $params['lang'] ) ) {
42  $langObj = $this->getLanguage();
43  } elseif ( !Language::isValidCode( $params['lang'] ) ) {
44  $this->dieUsage( 'Invalid language code for parameter lang', 'invalidlang' );
45  } else {
46  $langObj = Language::factory( $params['lang'] );
47  }
48 
49  if ( $params['enableparser'] ) {
50  if ( !is_null( $params['title'] ) ) {
51  $title = Title::newFromText( $params['title'] );
52  if ( !$title || $title->isExternal() ) {
53  $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
54  }
55  } else {
56  $title = Title::newFromText( 'API' );
57  }
58  }
59 
60  $prop = array_flip( (array)$params['prop'] );
61 
62  // Determine which messages should we print
63  if ( in_array( '*', $params['messages'] ) ) {
64  $message_names = Language::getMessageKeysFor( $langObj->getCode() );
65  if ( $params['includelocal'] ) {
66  global $wgLanguageCode;
67  $message_names = array_unique( array_merge(
68  $message_names,
69  // Pass in the content language code so we get local messages that have a
70  // MediaWiki:msgkey page. We might theoretically miss messages that have no
71  // MediaWiki:msgkey page but do have a MediaWiki:msgkey/lang page, but that's
72  // just a stupid case.
73  MessageCache::singleton()->getAllMessageKeys( $wgLanguageCode )
74  ) );
75  }
76  sort( $message_names );
77  $messages_target = $message_names;
78  } else {
79  $messages_target = $params['messages'];
80  }
81 
82  // Filter messages that have the specified prefix
83  // Because we sorted the message array earlier, they will appear in a clump:
84  if ( isset( $params['prefix'] ) ) {
85  $skip = false;
86  $messages_filtered = array();
87  foreach ( $messages_target as $message ) {
88  // === 0: must be at beginning of string (position 0)
89  if ( strpos( $message, $params['prefix'] ) === 0 ) {
90  if ( !$skip ) {
91  $skip = true;
92  }
93  $messages_filtered[] = $message;
94  } elseif ( $skip ) {
95  break;
96  }
97  }
98  $messages_target = $messages_filtered;
99  }
100 
101  // Filter messages that contain specified string
102  if ( isset( $params['filter'] ) ) {
103  $messages_filtered = array();
104  foreach ( $messages_target as $message ) {
105  // !== is used because filter can be at the beginning of the string
106  if ( strpos( $message, $params['filter'] ) !== false ) {
107  $messages_filtered[] = $message;
108  }
109  }
110  $messages_target = $messages_filtered;
111  }
112 
113  // Whether we have any sort of message customisation filtering
114  $customiseFilterEnabled = $params['customised'] !== 'all';
115  if ( $customiseFilterEnabled ) {
117  $lang = $langObj->getCode();
118 
119  $customisedMessages = AllmessagesTablePager::getCustomisedStatuses(
120  array_map( array( $langObj, 'ucfirst' ), $messages_target ), $lang, $lang != $wgContLang->getCode() );
121 
122  $customised = $params['customised'] === 'modified';
123  }
124 
125  // Get all requested messages and print the result
126  $skip = !is_null( $params['from'] );
127  $useto = !is_null( $params['to'] );
128  $result = $this->getResult();
129  foreach ( $messages_target as $message ) {
130  // Skip all messages up to $params['from']
131  if ( $skip && $message === $params['from'] ) {
132  $skip = false;
133  }
134 
135  if ( $useto && $message > $params['to'] ) {
136  break;
137  }
138 
139  if ( !$skip ) {
140  $a = array( 'name' => $message );
141  $args = array();
142  if ( isset( $params['args'] ) && count( $params['args'] ) != 0 ) {
143  $args = $params['args'];
144  }
145 
146  if ( $customiseFilterEnabled ) {
147  $messageIsCustomised = isset( $customisedMessages['pages'][$langObj->ucfirst( $message )] );
148  if ( $customised === $messageIsCustomised ) {
149  if ( $customised ) {
150  $a['customised'] = '';
151  }
152  } else {
153  continue;
154  }
155  }
156 
157  $msg = wfMessage( $message, $args )->inLanguage( $langObj );
158 
159  if ( !$msg->exists() ) {
160  $a['missing'] = '';
161  } else {
162  // Check if the parser is enabled:
163  if ( $params['enableparser'] ) {
164  $msgString = $msg->title( $title )->text();
165  } else {
166  $msgString = $msg->plain();
167  }
168  if ( !$params['nocontent'] ) {
169  ApiResult::setContent( $a, $msgString );
170  }
171  if ( isset( $prop['default'] ) ) {
172  $default = wfMessage( $message )->inLanguage( $langObj )->useDatabase( false );
173  if ( !$default->exists() ) {
174  $a['defaultmissing'] = '';
175  } elseif ( $default->plain() != $msgString ) {
176  $a['default'] = $default->plain();
177  }
178  }
179  }
180  $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $a );
181  if ( !$fit ) {
182  $this->setContinueEnumParameter( 'from', $message );
183  break;
184  }
185  }
186  }
187  $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'message' );
188  }
189 
190  public function getCacheMode( $params ) {
191  if ( is_null( $params['lang'] ) ) {
192  // Language not specified, will be fetched from preferences
193  return 'anon-public-user-private';
194  } elseif ( $params['enableparser'] ) {
195  // User-specific parser options will be used
196  return 'anon-public-user-private';
197  } else {
198  // OK to cache
199  return 'public';
200  }
201  }
202 
203  public function getAllowedParams() {
204  return array(
205  'messages' => array(
206  ApiBase::PARAM_DFLT => '*',
207  ApiBase::PARAM_ISMULTI => true,
208  ),
209  'prop' => array(
210  ApiBase::PARAM_ISMULTI => true,
212  'default'
213  )
214  ),
215  'enableparser' => false,
216  'nocontent' => false,
217  'includelocal' => false,
218  'args' => array(
219  ApiBase::PARAM_ISMULTI => true,
221  ),
222  'filter' => array(),
223  'customised' => array(
224  ApiBase::PARAM_DFLT => 'all',
226  'all',
227  'modified',
228  'unmodified'
229  )
230  ),
231  'lang' => null,
232  'from' => null,
233  'to' => null,
234  'title' => null,
235  'prefix' => null,
236  );
237  }
238 
239  public function getParamDescription() {
240  return array(
241  'messages' => 'Which messages to output. "*" (default) means all messages',
242  'prop' => 'Which properties to get',
243  'enableparser' => array( 'Set to enable parser, will preprocess the wikitext of message',
244  'Will substitute magic words, handle templates etc.' ),
245  'nocontent' => 'If set, do not include the content of the messages in the output.',
246  'includelocal' => array( "Also include local messages, i.e. messages that don't exist in the software but do exist as a MediaWiki: page.",
247  "This lists all MediaWiki: pages, so it will also list those that aren't 'really' messages such as Common.js",
248  ),
249  'title' => 'Page name to use as context when parsing message (for enableparser option)',
250  'args' => 'Arguments to be substituted into message',
251  'prefix' => 'Return messages with this prefix',
252  'filter' => 'Return only messages with names that contain this string',
253  'customised' => 'Return only messages in this customisation state',
254  'lang' => 'Return messages in this language',
255  'from' => 'Return messages starting at this message',
256  'to' => 'Return messages ending at this message',
257  );
258  }
259 
260  public function getPossibleErrors() {
261  return array_merge( parent::getPossibleErrors(), array(
262  array( 'code' => 'invalidlang', 'info' => 'Invalid language code for parameter lang' ),
263  ) );
264  }
265 
266  public function getResultProperties() {
267  return array(
268  '' => array(
269  'name' => 'string',
270  'customised' => 'boolean',
271  'missing' => 'boolean',
272  '*' => array(
273  ApiBase::PROP_TYPE => 'string',
274  ApiBase::PROP_NULLABLE => true
275  )
276  ),
277  'default' => array(
278  'defaultmissing' => 'boolean',
279  'default' => array(
280  ApiBase::PROP_TYPE => 'string',
281  ApiBase::PROP_NULLABLE => true
282  )
283  )
284  );
285  }
286 
287  public function getDescription() {
288  return 'Return messages from this site.';
289  }
290 
291  public function getExamples() {
292  return array(
293  'api.php?action=query&meta=allmessages&amprefix=ipb-',
294  'api.php?action=query&meta=allmessages&ammessages=august|mainpage&amlang=de',
295  );
296  }
297 
298  public function getHelpUrls() {
299  return 'https://www.mediawiki.org/wiki/API:Meta#allmessages_.2F_am';
300  }
301 }
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. $title:Title object for the current page $request:WebRequest $ignoreRedirect:boolean to skip redirect check $target:Title/string of redirect target $article:Article object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) $article:article(object) being checked 'IsTrustedProxy':Override the result of wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of User::isValidEmailAddr(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetMagic':DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetSpecialPageAliases':DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LinkBegin':Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1528
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:189
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
ApiQueryAllMessages\getHelpUrls
getHelpUrls()
Definition: ApiQueryAllMessages.php:298
ApiQueryAllMessages\getParamDescription
getParamDescription()
Returns an array of parameter descriptions.
Definition: ApiQueryAllMessages.php:239
ApiResult\setContent
static setContent(&$arr, $value, $subElemName=null)
Adds a content element to an array.
Definition: ApiResult.php:201
ApiBase\dieUsageMsg
dieUsageMsg( $error)
Output the error message related to a certain array.
Definition: ApiBase.php:1929
ApiBase\PARAM_TYPE
const PARAM_TYPE
Definition: ApiBase.php:50
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:205
$params
$params
Definition: styleTest.css.php:40
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:56
ApiBase\PARAM_ALLOW_DUPLICATES
const PARAM_ALLOW_DUPLICATES
Definition: ApiBase.php:58
ContextSource\getLanguage
getLanguage()
Get the Language object.
Definition: ContextSource.php:154
ApiQueryAllMessages\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryAllMessages.php:38
ApiQueryBase
This is a base class for all Query modules.
Definition: ApiQueryBase.php:34
ApiQueryAllMessages\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryAllMessages.php:190
wfMessage
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and has completed for all link tables default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
ApiQueryAllMessages\getDescription
getDescription()
Returns the description string for this module.
Definition: ApiQueryAllMessages.php:287
ApiBase\PROP_TYPE
const PROP_TYPE
Definition: ApiBase.php:74
MessageCache\singleton
static singleton()
Get the signleton instance of this class.
Definition: MessageCache.php:101
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
$title
presenting them properly to the user as errors is done by the caller $title
Definition: hooks.txt:1324
ApiQueryAllMessages
A query action to return messages from site message cache.
Definition: ApiQueryAllMessages.php:32
ApiBase\dieUsage
dieUsage( $description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
Definition: ApiBase.php:1363
ApiBase\PROP_NULLABLE
const PROP_NULLABLE
Definition: ApiBase.php:76
ApiQueryAllMessages\getResultProperties
getResultProperties()
Returns possible properties in the result, grouped by the value of the prop parameter that shows them...
Definition: ApiQueryAllMessages.php:266
Language\isValidCode
static isValidCode( $code)
Returns true if a language code string is of a valid form, whether or not it exists.
Definition: Language.php:337
$args
if( $line===false) $args
Definition: cdb.php:62
ApiQueryAllMessages\__construct
__construct( $query, $moduleName)
Definition: ApiQueryAllMessages.php:34
ApiQueryAllMessages\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryAllMessages.php:203
ApiQueryAllMessages\getPossibleErrors
getPossibleErrors()
Definition: ApiQueryAllMessages.php:260
AllmessagesTablePager\getCustomisedStatuses
static getCustomisedStatuses( $messageNames, $langcode='en', $foreign=false)
Determine which of the MediaWiki and MediaWiki_talk namespace pages exist.
Definition: SpecialAllmessages.php:243
ApiBase\PARAM_DFLT
const PARAM_DFLT
Definition: ApiBase.php:46
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:148
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
Definition: ApiBase.php:48
Language\getMessageKeysFor
static getMessageKeysFor( $code)
Get all message keys for a given language.
Definition: Language.php:4216
Language\factory
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:184
ApiQueryBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
Definition: ApiQueryBase.php:404
$query
return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1105
ApiQueryAllMessages\getExamples
getExamples()
Returns usage examples for this module.
Definition: ApiQueryAllMessages.php:291