MediaWiki  master
ApiQueryAllDeletedRevisions.php
Go to the documentation of this file.
1 <?php
29 
36 
37  public function __construct( ApiQuery $query, $moduleName ) {
38  parent::__construct( $query, $moduleName, 'adr' );
39  }
40 
45  protected function run( ApiPageSet $resultPageSet = null ) {
46  // Before doing anything at all, let's check permissions
47  $this->checkUserRightsAny( 'deletedhistory' );
48 
49  $user = $this->getUser();
50  $db = $this->getDB();
51  $params = $this->extractRequestParams( false );
52  $services = MediaWikiServices::getInstance();
53  $revisionStore = $services->getRevisionStore();
54 
55  $result = $this->getResult();
56 
57  // If the user wants no namespaces, they get no pages.
58  if ( $params['namespace'] === [] ) {
59  if ( $resultPageSet === null ) {
60  $result->addValue( 'query', $this->getModuleName(), [] );
61  }
62  return;
63  }
64 
65  // This module operates in two modes:
66  // 'user': List deleted revs by a certain user
67  // 'all': List all deleted revs in NS
68  $mode = 'all';
69  if ( !is_null( $params['user'] ) ) {
70  $mode = 'user';
71  }
72 
73  if ( $mode == 'user' ) {
74  foreach ( [ 'from', 'to', 'prefix', 'excludeuser' ] as $param ) {
75  if ( !is_null( $params[$param] ) ) {
76  $p = $this->getModulePrefix();
77  $this->dieWithError(
78  [ 'apierror-invalidparammix-cannotusewith', $p . $param, "{$p}user" ],
79  'invalidparammix'
80  );
81  }
82  }
83  } else {
84  foreach ( [ 'start', 'end' ] as $param ) {
85  if ( !is_null( $params[$param] ) ) {
86  $p = $this->getModulePrefix();
87  $this->dieWithError(
88  [ 'apierror-invalidparammix-mustusewith', $p . $param, "{$p}user" ],
89  'invalidparammix'
90  );
91  }
92  }
93  }
94 
95  // If we're generating titles only, we can use DISTINCT for a better
96  // query. But we can't do that in 'user' mode (wrong index), and we can
97  // only do it when sorting ASC (because MySQL apparently can't use an
98  // index backwards for grouping even though it can for ORDER BY, WTF?)
99  $dir = $params['dir'];
100  $optimizeGenerateTitles = false;
101  if ( $mode === 'all' && $params['generatetitles'] && $resultPageSet !== null ) {
102  if ( $dir === 'newer' ) {
103  $optimizeGenerateTitles = true;
104  } else {
105  $p = $this->getModulePrefix();
106  $this->addWarning( [ 'apiwarn-alldeletedrevisions-performance', $p ], 'performance' );
107  }
108  }
109 
110  if ( $resultPageSet === null ) {
111  $this->parseParameters( $params );
112  $arQuery = $revisionStore->getArchiveQueryInfo();
113  $this->addTables( $arQuery['tables'] );
114  $this->addJoinConds( $arQuery['joins'] );
115  $this->addFields( $arQuery['fields'] );
116  $this->addFields( [ 'ar_title', 'ar_namespace' ] );
117  } else {
118  $this->limit = $this->getParameter( 'limit' ) ?: 10;
119  $this->addTables( 'archive' );
120  $this->addFields( [ 'ar_title', 'ar_namespace' ] );
121  if ( $optimizeGenerateTitles ) {
122  $this->addOption( 'DISTINCT' );
123  } else {
124  $this->addFields( [ 'ar_timestamp', 'ar_rev_id', 'ar_id' ] );
125  }
126  }
127 
128  if ( $this->fld_tags ) {
129  $this->addFields( [ 'ts_tags' => ChangeTags::makeTagSummarySubquery( 'archive' ) ] );
130  }
131 
132  if ( !is_null( $params['tag'] ) ) {
133  $this->addTables( 'change_tag' );
134  $this->addJoinConds(
135  [ 'change_tag' => [ 'JOIN', [ 'ar_rev_id=ct_rev_id' ] ] ]
136  );
137  $changeTagDefStore = MediaWikiServices::getInstance()->getChangeTagDefStore();
138  try {
139  $this->addWhereFld( 'ct_tag_id', $changeTagDefStore->getId( $params['tag'] ) );
140  } catch ( NameTableAccessException $exception ) {
141  // Return nothing.
142  $this->addWhere( '1=0' );
143  }
144  }
145 
146  // This means stricter restrictions
147  if ( $this->fetchContent ) {
148  $this->checkUserRightsAny( [ 'deletedtext', 'undelete' ] );
149  }
150 
151  $miser_ns = null;
152 
153  if ( $mode == 'all' ) {
154  $namespaces = $params['namespace'] ??
155  $services->getNamespaceInfo()->getValidNamespaces();
156  $this->addWhereFld( 'ar_namespace', $namespaces );
157 
158  // For from/to/prefix, we have to consider the potential
159  // transformations of the title in all specified namespaces.
160  // Generally there will be only one transformation, but wikis with
161  // some namespaces case-sensitive could have two.
162  if ( $params['from'] !== null || $params['to'] !== null ) {
163  $isDirNewer = ( $dir === 'newer' );
164  $after = ( $isDirNewer ? '>=' : '<=' );
165  $before = ( $isDirNewer ? '<=' : '>=' );
166  $where = [];
167  foreach ( $namespaces as $ns ) {
168  $w = [];
169  if ( $params['from'] !== null ) {
170  $w[] = 'ar_title' . $after .
171  $db->addQuotes( $this->titlePartToKey( $params['from'], $ns ) );
172  }
173  if ( $params['to'] !== null ) {
174  $w[] = 'ar_title' . $before .
175  $db->addQuotes( $this->titlePartToKey( $params['to'], $ns ) );
176  }
177  $w = $db->makeList( $w, LIST_AND );
178  $where[$w][] = $ns;
179  }
180  if ( count( $where ) == 1 ) {
181  $where = key( $where );
182  $this->addWhere( $where );
183  } else {
184  $where2 = [];
185  foreach ( $where as $w => $ns ) {
186  $where2[] = $db->makeList( [ $w, 'ar_namespace' => $ns ], LIST_AND );
187  }
188  $this->addWhere( $db->makeList( $where2, LIST_OR ) );
189  }
190  }
191 
192  if ( isset( $params['prefix'] ) ) {
193  $where = [];
194  foreach ( $namespaces as $ns ) {
195  $w = 'ar_title' . $db->buildLike(
196  $this->titlePartToKey( $params['prefix'], $ns ),
197  $db->anyString() );
198  $where[$w][] = $ns;
199  }
200  if ( count( $where ) == 1 ) {
201  $where = key( $where );
202  $this->addWhere( $where );
203  } else {
204  $where2 = [];
205  foreach ( $where as $w => $ns ) {
206  $where2[] = $db->makeList( [ $w, 'ar_namespace' => $ns ], LIST_AND );
207  }
208  $this->addWhere( $db->makeList( $where2, LIST_OR ) );
209  }
210  }
211  } else {
212  if ( $this->getConfig()->get( 'MiserMode' ) ) {
213  $miser_ns = $params['namespace'];
214  } else {
215  $this->addWhereFld( 'ar_namespace', $params['namespace'] );
216  }
217  $this->addTimestampWhereRange( 'ar_timestamp', $dir, $params['start'], $params['end'] );
218  }
219 
220  if ( !is_null( $params['user'] ) ) {
221  // Don't query by user ID here, it might be able to use the ar_usertext_timestamp index.
222  $actorQuery = ActorMigration::newMigration()
223  ->getWhere( $db, 'ar_user', User::newFromName( $params['user'], false ), false );
224  $this->addTables( $actorQuery['tables'] );
225  $this->addJoinConds( $actorQuery['joins'] );
226  $this->addWhere( $actorQuery['conds'] );
227  } elseif ( !is_null( $params['excludeuser'] ) ) {
228  // Here there's no chance of using ar_usertext_timestamp.
229  $actorQuery = ActorMigration::newMigration()
230  ->getWhere( $db, 'ar_user', User::newFromName( $params['excludeuser'], false ) );
231  $this->addTables( $actorQuery['tables'] );
232  $this->addJoinConds( $actorQuery['joins'] );
233  $this->addWhere( 'NOT(' . $actorQuery['conds'] . ')' );
234  }
235 
236  if ( !is_null( $params['user'] ) || !is_null( $params['excludeuser'] ) ) {
237  // Paranoia: avoid brute force searches (T19342)
238  // (shouldn't be able to get here without 'deletedhistory', but
239  // check it again just in case)
240  if ( !$user->isAllowed( 'deletedhistory' ) ) {
241  $bitmask = RevisionRecord::DELETED_USER;
242  } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
243  $bitmask = RevisionRecord::DELETED_USER | RevisionRecord::DELETED_RESTRICTED;
244  } else {
245  $bitmask = 0;
246  }
247  if ( $bitmask ) {
248  $this->addWhere( $db->bitAnd( 'ar_deleted', $bitmask ) . " != $bitmask" );
249  }
250  }
251 
252  if ( !is_null( $params['continue'] ) ) {
253  $cont = explode( '|', $params['continue'] );
254  $op = ( $dir == 'newer' ? '>' : '<' );
255  if ( $optimizeGenerateTitles ) {
256  $this->dieContinueUsageIf( count( $cont ) != 2 );
257  $ns = (int)$cont[0];
258  $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
259  $title = $db->addQuotes( $cont[1] );
260  $this->addWhere( "ar_namespace $op $ns OR " .
261  "(ar_namespace = $ns AND ar_title $op= $title)" );
262  } elseif ( $mode == 'all' ) {
263  $this->dieContinueUsageIf( count( $cont ) != 4 );
264  $ns = (int)$cont[0];
265  $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
266  $title = $db->addQuotes( $cont[1] );
267  $ts = $db->addQuotes( $db->timestamp( $cont[2] ) );
268  $ar_id = (int)$cont[3];
269  $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[3] );
270  $this->addWhere( "ar_namespace $op $ns OR " .
271  "(ar_namespace = $ns AND " .
272  "(ar_title $op $title OR " .
273  "(ar_title = $title AND " .
274  "(ar_timestamp $op $ts OR " .
275  "(ar_timestamp = $ts AND " .
276  "ar_id $op= $ar_id)))))" );
277  } else {
278  $this->dieContinueUsageIf( count( $cont ) != 2 );
279  $ts = $db->addQuotes( $db->timestamp( $cont[0] ) );
280  $ar_id = (int)$cont[1];
281  $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[1] );
282  $this->addWhere( "ar_timestamp $op $ts OR " .
283  "(ar_timestamp = $ts AND " .
284  "ar_id $op= $ar_id)" );
285  }
286  }
287 
288  $this->addOption( 'LIMIT', $this->limit + 1 );
289 
290  $sort = ( $dir == 'newer' ? '' : ' DESC' );
291  $orderby = [];
292  if ( $optimizeGenerateTitles ) {
293  // Targeting index name_title_timestamp
294  if ( $params['namespace'] === null || count( array_unique( $params['namespace'] ) ) > 1 ) {
295  $orderby[] = "ar_namespace $sort";
296  }
297  $orderby[] = "ar_title $sort";
298  } elseif ( $mode == 'all' ) {
299  // Targeting index name_title_timestamp
300  if ( $params['namespace'] === null || count( array_unique( $params['namespace'] ) ) > 1 ) {
301  $orderby[] = "ar_namespace $sort";
302  }
303  $orderby[] = "ar_title $sort";
304  $orderby[] = "ar_timestamp $sort";
305  $orderby[] = "ar_id $sort";
306  } else {
307  // Targeting index usertext_timestamp
308  // 'user' is always constant.
309  $orderby[] = "ar_timestamp $sort";
310  $orderby[] = "ar_id $sort";
311  }
312  $this->addOption( 'ORDER BY', $orderby );
313 
314  $res = $this->select( __METHOD__ );
315  $pageMap = []; // Maps ns&title to array index
316  $count = 0;
317  $nextIndex = 0;
318  $generated = [];
319  foreach ( $res as $row ) {
320  if ( ++$count > $this->limit ) {
321  // We've had enough
322  if ( $optimizeGenerateTitles ) {
323  $this->setContinueEnumParameter( 'continue', "$row->ar_namespace|$row->ar_title" );
324  } elseif ( $mode == 'all' ) {
325  $this->setContinueEnumParameter( 'continue',
326  "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
327  );
328  } else {
329  $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
330  }
331  break;
332  }
333 
334  // Miser mode namespace check
335  if ( $miser_ns !== null && !in_array( $row->ar_namespace, $miser_ns ) ) {
336  continue;
337  }
338 
339  if ( $resultPageSet !== null ) {
340  if ( $params['generatetitles'] ) {
341  $key = "{$row->ar_namespace}:{$row->ar_title}";
342  if ( !isset( $generated[$key] ) ) {
343  $generated[$key] = Title::makeTitle( $row->ar_namespace, $row->ar_title );
344  }
345  } else {
346  $generated[] = $row->ar_rev_id;
347  }
348  } else {
349  $revision = $revisionStore->newRevisionFromArchiveRow( $row );
350  $rev = $this->extractRevisionInfo( $revision, $row );
351 
352  if ( !isset( $pageMap[$row->ar_namespace][$row->ar_title] ) ) {
353  $index = $nextIndex++;
354  $pageMap[$row->ar_namespace][$row->ar_title] = $index;
355  $title = Title::newFromLinkTarget( $revision->getPageAsLinkTarget() );
356  $a = [
357  'pageid' => $title->getArticleID(),
358  'revisions' => [ $rev ],
359  ];
360  ApiResult::setIndexedTagName( $a['revisions'], 'rev' );
362  $fit = $result->addValue( [ 'query', $this->getModuleName() ], $index, $a );
363  } else {
364  $index = $pageMap[$row->ar_namespace][$row->ar_title];
365  $fit = $result->addValue(
366  [ 'query', $this->getModuleName(), $index, 'revisions' ],
367  null, $rev );
368  }
369  if ( !$fit ) {
370  if ( $mode == 'all' ) {
371  $this->setContinueEnumParameter( 'continue',
372  "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
373  );
374  } else {
375  $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
376  }
377  break;
378  }
379  }
380  }
381 
382  if ( $resultPageSet !== null ) {
383  if ( $params['generatetitles'] ) {
384  $resultPageSet->populateFromTitles( $generated );
385  } else {
386  $resultPageSet->populateFromRevisionIDs( $generated );
387  }
388  } else {
389  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
390  }
391  }
392 
393  public function getAllowedParams() {
394  $ret = parent::getAllowedParams() + [
395  'user' => [
396  ApiBase::PARAM_TYPE => 'user'
397  ],
398  'namespace' => [
399  ApiBase::PARAM_ISMULTI => true,
400  ApiBase::PARAM_TYPE => 'namespace',
401  ],
402  'start' => [
403  ApiBase::PARAM_TYPE => 'timestamp',
404  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'useronly' ] ],
405  ],
406  'end' => [
407  ApiBase::PARAM_TYPE => 'timestamp',
408  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'useronly' ] ],
409  ],
410  'dir' => [
412  'newer',
413  'older'
414  ],
415  ApiBase::PARAM_DFLT => 'older',
416  ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
417  ],
418  'from' => [
419  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
420  ],
421  'to' => [
422  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
423  ],
424  'prefix' => [
425  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
426  ],
427  'excludeuser' => [
428  ApiBase::PARAM_TYPE => 'user',
429  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
430  ],
431  'tag' => null,
432  'continue' => [
433  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
434  ],
435  'generatetitles' => [
437  ],
438  ];
439 
440  if ( $this->getConfig()->get( 'MiserMode' ) ) {
442  'apihelp-query+alldeletedrevisions-param-miser-user-namespace',
443  ];
444  $ret['namespace'][ApiBase::PARAM_HELP_MSG_APPEND] = [
445  'apihelp-query+alldeletedrevisions-param-miser-user-namespace',
446  ];
447  }
448 
449  return $ret;
450  }
451 
452  protected function getExamplesMessages() {
453  return [
454  'action=query&list=alldeletedrevisions&adruser=Example&adrlimit=50'
455  => 'apihelp-query+alldeletedrevisions-example-user',
456  'action=query&list=alldeletedrevisions&adrdir=newer&adrnamespace=0&adrlimit=50'
457  => 'apihelp-query+alldeletedrevisions-example-ns-main',
458  ];
459  }
460 
461  public function getHelpUrls() {
462  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Alldeletedrevisions';
463  }
464 }
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:94
getDB()
Get the Query database connection (read-only)
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used $groups Array of ChangesListFilterGroup objects(added in 1.34) 'FileDeleteComplete' 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:1529
getResult()
Get the result object.
Definition: ApiBase.php:640
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:40
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 & $ret
Definition: hooks.txt:1972
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
Exception representing a failure to look up a row from a name table.
$sort
const PARAM_HELP_MSG_INFO
(array) Specify additional information tags for the parameter.
Definition: ApiBase.php:148
A base class for functions common to producing a list of revisions.
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:2009
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:761
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 key
Definition: hooks.txt:2139
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
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
getParameter( $paramName, $parseLimit=true)
Get a value for the given parameter.
Definition: ApiBase.php:876
__construct(ApiQuery $query, $moduleName)
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\*-\*)") will be honored when streaming the file. '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:1970
const PARAM_HELP_MSG_APPEND
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this ...
Definition: ApiBase.php:138
static newMigration()
Static constructor.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
const LIST_AND
Definition: Defines.php:39
titlePartToKey( $titlePart, $namespace=NS_MAIN)
Convert an input title or title prefix into a dbkey.
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Definition: hooks.txt:2205
$res
Definition: database.txt:21
dieContinueUsageIf( $condition)
Die with the &#39;badcontinue&#39; error.
Definition: ApiBase.php:2200
$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:767
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:520
addFields( $value)
Add a set of fields to select to the internal array.
This is the main query class.
Definition: ApiQuery.php:36
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1748
namespace and then decline to actually register it & $namespaces
Definition: hooks.txt:912
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
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:131
const LIST_OR
Definition: Defines.php:42
static newFromLinkTarget(LinkTarget $linkTarget, $forceClone='')
Returns a Title given a LinkTarget.
Definition: Title.php:274
addTimestampWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:592
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
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:528
addWhere( $value)
Add a set of WHERE clauses to the internal array.
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition: ApiBase.php:1928
Query module to enumerate all deleted revisions.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:58
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
extractRevisionInfo(RevisionRecord $revision, $row)
Extract information from the RevisionRecord.
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
parseParameters( $params)
Parse the parameters into the various instance fields.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:535
static makeTagSummarySubquery( $tables)
Make the tag summary subquery based on the given tables and return it.
Definition: ChangeTags.php:837
run(ApiPageSet $resultPageSet=null)
checkUserRightsAny( $rights, $user=null)
Helper function for permission-denied errors.
Definition: ApiBase.php:2124
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1454