MediaWiki  master
ApiQueryAllMessages.php
Go to the documentation of this file.
1 <?php
24 
31 
32  public function __construct( ApiQuery $query, $moduleName ) {
33  parent::__construct( $query, $moduleName, 'am' );
34  }
35 
36  public function execute() {
37  $params = $this->extractRequestParams();
38 
39  if ( is_null( $params['lang'] ) ) {
40  $langObj = $this->getLanguage();
41  } elseif ( !Language::isValidCode( $params['lang'] ) ) {
42  $this->dieWithError(
43  [ 'apierror-invalidlang', $this->encodeParamName( 'lang' ) ], 'invalidlang'
44  );
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->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $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  $message_names = array_unique( array_merge(
67  $message_names,
68  // Pass in the content language code so we get local messages that have a
69  // MediaWiki:msgkey page. We might theoretically miss messages that have no
70  // MediaWiki:msgkey page but do have a MediaWiki:msgkey/lang page, but that's
71  // just a stupid case.
72  MessageCache::singleton()->getAllMessageKeys( $this->getConfig()->get( 'LanguageCode' ) )
73  ) );
74  }
75  sort( $message_names );
76  $messages_target = $message_names;
77  } else {
78  $messages_target = $params['messages'];
79  }
80 
81  // Filter messages that have the specified prefix
82  // Because we sorted the message array earlier, they will appear in a clump:
83  if ( isset( $params['prefix'] ) ) {
84  $skip = false;
85  $messages_filtered = [];
86  foreach ( $messages_target as $message ) {
87  // === 0: must be at beginning of string (position 0)
88  if ( strpos( $message, $params['prefix'] ) === 0 ) {
89  if ( !$skip ) {
90  $skip = true;
91  }
92  $messages_filtered[] = $message;
93  } elseif ( $skip ) {
94  break;
95  }
96  }
97  $messages_target = $messages_filtered;
98  }
99 
100  // Filter messages that contain specified string
101  if ( isset( $params['filter'] ) ) {
102  $messages_filtered = [];
103  foreach ( $messages_target as $message ) {
104  // !== is used because filter can be at the beginning of the string
105  if ( strpos( $message, $params['filter'] ) !== false ) {
106  $messages_filtered[] = $message;
107  }
108  }
109  $messages_target = $messages_filtered;
110  }
111 
112  // Whether we have any sort of message customisation filtering
113  $customiseFilterEnabled = $params['customised'] !== 'all';
114  if ( $customiseFilterEnabled ) {
115  $customisedMessages = AllMessagesTablePager::getCustomisedStatuses(
116  array_map(
117  [ $langObj, 'ucfirst' ],
118  $messages_target
119  ),
120  $langObj->getCode(),
121  !$langObj->equals( MediaWikiServices::getInstance()->getContentLanguage() )
122  );
123 
124  $customised = $params['customised'] === 'modified';
125  }
126 
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'] ) {
134  $skip = false;
135  }
136 
137  if ( $useto && $message > $params['to'] ) {
138  break;
139  }
140 
141  if ( !$skip ) {
142  $a = [
143  'name' => $message,
144  'normalizedname' => MessageCache::normalizeKey( $message ),
145  ];
146 
147  $args = [];
148  if ( isset( $params['args'] ) && count( $params['args'] ) != 0 ) {
149  $args = $params['args'];
150  }
151 
152  if ( $customiseFilterEnabled ) {
153  $messageIsCustomised = isset( $customisedMessages['pages'][$langObj->ucfirst( $message )] );
154  if ( $customised === $messageIsCustomised ) {
155  if ( $customised ) {
156  $a['customised'] = true;
157  }
158  } else {
159  continue;
160  }
161  }
162 
163  $msg = wfMessage( $message, $args )->inLanguage( $langObj );
164 
165  if ( !$msg->exists() ) {
166  $a['missing'] = true;
167  } else {
168  // Check if the parser is enabled:
169  if ( $params['enableparser'] ) {
170  $msgString = $msg->title( $title )->text();
171  } else {
172  $msgString = $msg->plain();
173  }
174  if ( !$params['nocontent'] ) {
175  ApiResult::setContentValue( $a, 'content', $msgString );
176  }
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();
183  }
184  }
185  }
186  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $a );
187  if ( !$fit ) {
188  $this->setContinueEnumParameter( 'from', $message );
189  break;
190  }
191  }
192  }
193  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'message' );
194  }
195 
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';
203  } else {
204  // OK to cache
205  return 'public';
206  }
207  }
208 
209  public function getAllowedParams() {
210  return [
211  'messages' => [
212  ApiBase::PARAM_DFLT => '*',
213  ApiBase::PARAM_ISMULTI => true,
214  ],
215  'prop' => [
216  ApiBase::PARAM_ISMULTI => true,
218  'default'
219  ]
220  ],
221  'enableparser' => false,
222  'nocontent' => false,
223  'includelocal' => false,
224  'args' => [
225  ApiBase::PARAM_ISMULTI => true,
227  ],
228  'filter' => [],
229  'customised' => [
230  ApiBase::PARAM_DFLT => 'all',
232  'all',
233  'modified',
234  'unmodified'
235  ]
236  ],
237  'lang' => null,
238  'from' => null,
239  'to' => null,
240  'title' => null,
241  'prefix' => null,
242  ];
243  }
244 
245  protected function getExamplesMessages() {
246  return [
247  'action=query&meta=allmessages&amprefix=ipb-'
248  => 'apihelp-query+allmessages-example-ipb',
249  'action=query&meta=allmessages&ammessages=august|mainpage&amlang=de'
250  => 'apihelp-query+allmessages-example-de',
251  ];
252  }
253 
254  public function getHelpUrls() {
255  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allmessages';
256  }
257 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:94
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1585
getResult()
Get the result object.
Definition: ApiBase.php:639
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:55
This is a base class for all Query modules.
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:2008
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:760
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
__construct(ApiQuery $query, $moduleName)
static setContentValue(array &$arr, $name, $value, $flags=0)
Add an output value to the array by name and mark as META_CONTENT.
Definition: ApiResult.php:478
static getCustomisedStatuses( $messageNames, $langcode='en', $foreign=false)
Determine which of the MediaWiki and MediaWiki_talk namespace pages exist.
static normalizeKey( $key)
Normalize message key input.
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. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. '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 '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 '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 '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. '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 IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() '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 Sanitizer::validateEmail(), 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 '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:Array with elements of the form "language:title" in the order that they will be output. & $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. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. 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:1980
if( $line===false) $args
Definition: cdb.php:64
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead 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
static getMessageKeysFor( $code)
Get all message keys for a given language.
Definition: Language.php:4597
A query action to return messages from site message cache.
$params
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:519
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:216
This is the main query class.
Definition: ApiQuery.php:36
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
encodeParamName( $paramName)
This method mangles parameter name based on the prefix supplied to the constructor.
Definition: ApiBase.php:738
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:58
static isValidCode( $code)
Returns true if a language code string is of a valid form, whether or not it exists.
Definition: Language.php:388
const PARAM_ALLOW_DUPLICATES
(boolean) Allow the same value to be set more than once when PARAM_ISMULTI is true?
Definition: ApiBase.php:109
static singleton()
Get the signleton instance of this class.
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:319
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.