MediaWiki  1.29.1
ApiQueryAllDeletedRevisions.php
Go to the documentation of this file.
1 <?php
34 
35  public function __construct( ApiQuery $query, $moduleName ) {
36  parent::__construct( $query, $moduleName, 'adr' );
37  }
38 
43  protected function run( ApiPageSet $resultPageSet = null ) {
44  // Before doing anything at all, let's check permissions
45  $this->checkUserRightsAny( 'deletedhistory' );
46 
47  $user = $this->getUser();
48  $db = $this->getDB();
49  $params = $this->extractRequestParams( false );
50 
51  $result = $this->getResult();
52 
53  // If the user wants no namespaces, they get no pages.
54  if ( $params['namespace'] === [] ) {
55  if ( $resultPageSet === null ) {
56  $result->addValue( 'query', $this->getModuleName(), [] );
57  }
58  return;
59  }
60 
61  // This module operates in two modes:
62  // 'user': List deleted revs by a certain user
63  // 'all': List all deleted revs in NS
64  $mode = 'all';
65  if ( !is_null( $params['user'] ) ) {
66  $mode = 'user';
67  }
68 
69  if ( $mode == 'user' ) {
70  foreach ( [ 'from', 'to', 'prefix', 'excludeuser' ] as $param ) {
71  if ( !is_null( $params[$param] ) ) {
72  $p = $this->getModulePrefix();
73  $this->dieWithError(
74  [ 'apierror-invalidparammix-cannotusewith', $p.$param, "{$p}user" ],
75  'invalidparammix'
76  );
77  }
78  }
79  } else {
80  foreach ( [ 'start', 'end' ] as $param ) {
81  if ( !is_null( $params[$param] ) ) {
82  $p = $this->getModulePrefix();
83  $this->dieWithError(
84  [ 'apierror-invalidparammix-mustusewith', $p.$param, "{$p}user" ],
85  'invalidparammix'
86  );
87  }
88  }
89  }
90 
91  // If we're generating titles only, we can use DISTINCT for a better
92  // query. But we can't do that in 'user' mode (wrong index), and we can
93  // only do it when sorting ASC (because MySQL apparently can't use an
94  // index backwards for grouping even though it can for ORDER BY, WTF?)
95  $dir = $params['dir'];
96  $optimizeGenerateTitles = false;
97  if ( $mode === 'all' && $params['generatetitles'] && $resultPageSet !== null ) {
98  if ( $dir === 'newer' ) {
99  $optimizeGenerateTitles = true;
100  } else {
101  $p = $this->getModulePrefix();
102  $this->addWarning( [ 'apiwarn-alldeletedrevisions-performance', $p ], 'performance' );
103  }
104  }
105 
106  $this->addTables( 'archive' );
107  if ( $resultPageSet === null ) {
108  $this->parseParameters( $params );
110  $this->addFields( [ 'ar_title', 'ar_namespace' ] );
111  } else {
112  $this->limit = $this->getParameter( 'limit' ) ?: 10;
113  $this->addFields( [ 'ar_title', 'ar_namespace' ] );
114  if ( $optimizeGenerateTitles ) {
115  $this->addOption( 'DISTINCT' );
116  } else {
117  $this->addFields( [ 'ar_timestamp', 'ar_rev_id', 'ar_id' ] );
118  }
119  }
120 
121  if ( $this->fld_tags ) {
122  $this->addTables( 'tag_summary' );
123  $this->addJoinConds(
124  [ 'tag_summary' => [ 'LEFT JOIN', [ 'ar_rev_id=ts_rev_id' ] ] ]
125  );
126  $this->addFields( 'ts_tags' );
127  }
128 
129  if ( !is_null( $params['tag'] ) ) {
130  $this->addTables( 'change_tag' );
131  $this->addJoinConds(
132  [ 'change_tag' => [ 'INNER JOIN', [ 'ar_rev_id=ct_rev_id' ] ] ]
133  );
134  $this->addWhereFld( 'ct_tag', $params['tag'] );
135  }
136 
137  if ( $this->fetchContent ) {
138  // Modern MediaWiki has the content for deleted revs in the 'text'
139  // table using fields old_text and old_flags. But revisions deleted
140  // pre-1.5 store the content in the 'archive' table directly using
141  // fields ar_text and ar_flags, and no corresponding 'text' row. So
142  // we have to LEFT JOIN and fetch all four fields.
143  $this->addTables( 'text' );
144  $this->addJoinConds(
145  [ 'text' => [ 'LEFT JOIN', [ 'ar_text_id=old_id' ] ] ]
146  );
147  $this->addFields( [ 'ar_text', 'ar_flags', 'old_text', 'old_flags' ] );
148 
149  // This also means stricter restrictions
150  $this->checkUserRightsAny( [ 'deletedtext', 'undelete' ] );
151  }
152 
153  $miser_ns = null;
154 
155  if ( $mode == 'all' ) {
156  if ( $params['namespace'] !== null ) {
157  $namespaces = $params['namespace'];
158  } else {
160  }
161  $this->addWhereFld( 'ar_namespace', $namespaces );
162 
163  // For from/to/prefix, we have to consider the potential
164  // transformations of the title in all specified namespaces.
165  // Generally there will be only one transformation, but wikis with
166  // some namespaces case-sensitive could have two.
167  if ( $params['from'] !== null || $params['to'] !== null ) {
168  $isDirNewer = ( $dir === 'newer' );
169  $after = ( $isDirNewer ? '>=' : '<=' );
170  $before = ( $isDirNewer ? '<=' : '>=' );
171  $where = [];
172  foreach ( $namespaces as $ns ) {
173  $w = [];
174  if ( $params['from'] !== null ) {
175  $w[] = 'ar_title' . $after .
176  $db->addQuotes( $this->titlePartToKey( $params['from'], $ns ) );
177  }
178  if ( $params['to'] !== null ) {
179  $w[] = 'ar_title' . $before .
180  $db->addQuotes( $this->titlePartToKey( $params['to'], $ns ) );
181  }
182  $w = $db->makeList( $w, LIST_AND );
183  $where[$w][] = $ns;
184  }
185  if ( count( $where ) == 1 ) {
186  $where = key( $where );
187  $this->addWhere( $where );
188  } else {
189  $where2 = [];
190  foreach ( $where as $w => $ns ) {
191  $where2[] = $db->makeList( [ $w, 'ar_namespace' => $ns ], LIST_AND );
192  }
193  $this->addWhere( $db->makeList( $where2, LIST_OR ) );
194  }
195  }
196 
197  if ( isset( $params['prefix'] ) ) {
198  $where = [];
199  foreach ( $namespaces as $ns ) {
200  $w = 'ar_title' . $db->buildLike(
201  $this->titlePartToKey( $params['prefix'], $ns ),
202  $db->anyString() );
203  $where[$w][] = $ns;
204  }
205  if ( count( $where ) == 1 ) {
206  $where = key( $where );
207  $this->addWhere( $where );
208  } else {
209  $where2 = [];
210  foreach ( $where as $w => $ns ) {
211  $where2[] = $db->makeList( [ $w, 'ar_namespace' => $ns ], LIST_AND );
212  }
213  $this->addWhere( $db->makeList( $where2, LIST_OR ) );
214  }
215  }
216  } else {
217  if ( $this->getConfig()->get( 'MiserMode' ) ) {
218  $miser_ns = $params['namespace'];
219  } else {
220  $this->addWhereFld( 'ar_namespace', $params['namespace'] );
221  }
222  $this->addTimestampWhereRange( 'ar_timestamp', $dir, $params['start'], $params['end'] );
223  }
224 
225  if ( !is_null( $params['user'] ) ) {
226  $this->addWhereFld( 'ar_user_text', $params['user'] );
227  } elseif ( !is_null( $params['excludeuser'] ) ) {
228  $this->addWhere( 'ar_user_text != ' .
229  $db->addQuotes( $params['excludeuser'] ) );
230  }
231 
232  if ( !is_null( $params['user'] ) || !is_null( $params['excludeuser'] ) ) {
233  // Paranoia: avoid brute force searches (T19342)
234  // (shouldn't be able to get here without 'deletedhistory', but
235  // check it again just in case)
236  if ( !$user->isAllowed( 'deletedhistory' ) ) {
237  $bitmask = Revision::DELETED_USER;
238  } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
240  } else {
241  $bitmask = 0;
242  }
243  if ( $bitmask ) {
244  $this->addWhere( $db->bitAnd( 'ar_deleted', $bitmask ) . " != $bitmask" );
245  }
246  }
247 
248  if ( !is_null( $params['continue'] ) ) {
249  $cont = explode( '|', $params['continue'] );
250  $op = ( $dir == 'newer' ? '>' : '<' );
251  if ( $optimizeGenerateTitles ) {
252  $this->dieContinueUsageIf( count( $cont ) != 2 );
253  $ns = intval( $cont[0] );
254  $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
255  $title = $db->addQuotes( $cont[1] );
256  $this->addWhere( "ar_namespace $op $ns OR " .
257  "(ar_namespace = $ns AND ar_title $op= $title)" );
258  } elseif ( $mode == 'all' ) {
259  $this->dieContinueUsageIf( count( $cont ) != 4 );
260  $ns = intval( $cont[0] );
261  $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
262  $title = $db->addQuotes( $cont[1] );
263  $ts = $db->addQuotes( $db->timestamp( $cont[2] ) );
264  $ar_id = (int)$cont[3];
265  $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[3] );
266  $this->addWhere( "ar_namespace $op $ns OR " .
267  "(ar_namespace = $ns AND " .
268  "(ar_title $op $title OR " .
269  "(ar_title = $title AND " .
270  "(ar_timestamp $op $ts OR " .
271  "(ar_timestamp = $ts AND " .
272  "ar_id $op= $ar_id)))))" );
273  } else {
274  $this->dieContinueUsageIf( count( $cont ) != 2 );
275  $ts = $db->addQuotes( $db->timestamp( $cont[0] ) );
276  $ar_id = (int)$cont[1];
277  $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[1] );
278  $this->addWhere( "ar_timestamp $op $ts OR " .
279  "(ar_timestamp = $ts AND " .
280  "ar_id $op= $ar_id)" );
281  }
282  }
283 
284  $this->addOption( 'LIMIT', $this->limit + 1 );
285 
286  $sort = ( $dir == 'newer' ? '' : ' DESC' );
287  $orderby = [];
288  if ( $optimizeGenerateTitles ) {
289  // Targeting index name_title_timestamp
290  if ( $params['namespace'] === null || count( array_unique( $params['namespace'] ) ) > 1 ) {
291  $orderby[] = "ar_namespace $sort";
292  }
293  $orderby[] = "ar_title $sort";
294  } elseif ( $mode == 'all' ) {
295  // Targeting index name_title_timestamp
296  if ( $params['namespace'] === null || count( array_unique( $params['namespace'] ) ) > 1 ) {
297  $orderby[] = "ar_namespace $sort";
298  }
299  $orderby[] = "ar_title $sort";
300  $orderby[] = "ar_timestamp $sort";
301  $orderby[] = "ar_id $sort";
302  } else {
303  // Targeting index usertext_timestamp
304  // 'user' is always constant.
305  $orderby[] = "ar_timestamp $sort";
306  $orderby[] = "ar_id $sort";
307  }
308  $this->addOption( 'ORDER BY', $orderby );
309 
310  $res = $this->select( __METHOD__ );
311  $pageMap = []; // Maps ns&title to array index
312  $count = 0;
313  $nextIndex = 0;
314  $generated = [];
315  foreach ( $res as $row ) {
316  if ( ++$count > $this->limit ) {
317  // We've had enough
318  if ( $optimizeGenerateTitles ) {
319  $this->setContinueEnumParameter( 'continue', "$row->ar_namespace|$row->ar_title" );
320  } elseif ( $mode == 'all' ) {
321  $this->setContinueEnumParameter( 'continue',
322  "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
323  );
324  } else {
325  $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
326  }
327  break;
328  }
329 
330  // Miser mode namespace check
331  if ( $miser_ns !== null && !in_array( $row->ar_namespace, $miser_ns ) ) {
332  continue;
333  }
334 
335  if ( $resultPageSet !== null ) {
336  if ( $params['generatetitles'] ) {
337  $key = "{$row->ar_namespace}:{$row->ar_title}";
338  if ( !isset( $generated[$key] ) ) {
339  $generated[$key] = Title::makeTitle( $row->ar_namespace, $row->ar_title );
340  }
341  } else {
342  $generated[] = $row->ar_rev_id;
343  }
344  } else {
345  $revision = Revision::newFromArchiveRow( $row );
346  $rev = $this->extractRevisionInfo( $revision, $row );
347 
348  if ( !isset( $pageMap[$row->ar_namespace][$row->ar_title] ) ) {
349  $index = $nextIndex++;
350  $pageMap[$row->ar_namespace][$row->ar_title] = $index;
351  $title = $revision->getTitle();
352  $a = [
353  'pageid' => $title->getArticleID(),
354  'revisions' => [ $rev ],
355  ];
356  ApiResult::setIndexedTagName( $a['revisions'], 'rev' );
358  $fit = $result->addValue( [ 'query', $this->getModuleName() ], $index, $a );
359  } else {
360  $index = $pageMap[$row->ar_namespace][$row->ar_title];
361  $fit = $result->addValue(
362  [ 'query', $this->getModuleName(), $index, 'revisions' ],
363  null, $rev );
364  }
365  if ( !$fit ) {
366  if ( $mode == 'all' ) {
367  $this->setContinueEnumParameter( 'continue',
368  "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
369  );
370  } else {
371  $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
372  }
373  break;
374  }
375  }
376  }
377 
378  if ( $resultPageSet !== null ) {
379  if ( $params['generatetitles'] ) {
380  $resultPageSet->populateFromTitles( $generated );
381  } else {
382  $resultPageSet->populateFromRevisionIDs( $generated );
383  }
384  } else {
385  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
386  }
387  }
388 
389  public function getAllowedParams() {
390  $ret = parent::getAllowedParams() + [
391  'user' => [
392  ApiBase::PARAM_TYPE => 'user'
393  ],
394  'namespace' => [
395  ApiBase::PARAM_ISMULTI => true,
396  ApiBase::PARAM_TYPE => 'namespace',
397  ],
398  'start' => [
399  ApiBase::PARAM_TYPE => 'timestamp',
400  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'useronly' ] ],
401  ],
402  'end' => [
403  ApiBase::PARAM_TYPE => 'timestamp',
404  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'useronly' ] ],
405  ],
406  'dir' => [
408  'newer',
409  'older'
410  ],
411  ApiBase::PARAM_DFLT => 'older',
412  ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
413  ],
414  'from' => [
415  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
416  ],
417  'to' => [
418  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
419  ],
420  'prefix' => [
421  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
422  ],
423  'excludeuser' => [
424  ApiBase::PARAM_TYPE => 'user',
425  ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
426  ],
427  'tag' => null,
428  'continue' => [
429  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
430  ],
431  'generatetitles' => [
433  ],
434  ];
435 
436  if ( $this->getConfig()->get( 'MiserMode' ) ) {
438  'apihelp-query+alldeletedrevisions-param-miser-user-namespace',
439  ];
440  $ret['namespace'][ApiBase::PARAM_HELP_MSG_APPEND] = [
441  'apihelp-query+alldeletedrevisions-param-miser-user-namespace',
442  ];
443  }
444 
445  return $ret;
446  }
447 
448  protected function getExamplesMessages() {
449  return [
450  'action=query&list=alldeletedrevisions&adruser=Example&adrlimit=50'
451  => 'apihelp-query+alldeletedrevisions-example-user',
452  'action=query&list=alldeletedrevisions&adrdir=newer&adrnamespace=0&adrlimit=50'
453  => 'apihelp-query+alldeletedrevisions-example-ns-main',
454  ];
455  }
456 
457  public function getHelpUrls() {
458  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Alldeletedrevisions';
459  }
460 }
Revision\newFromArchiveRow
static newFromArchiveRow( $row, $overrides=[])
Make a fake revision object from an archive table row.
Definition: Revision.php:189
ApiQueryRevisionsBase\parseParameters
parseParameters( $params)
Parse the parameters into the various instance fields.
Definition: ApiQueryRevisionsBase.php:61
Revision\DELETED_USER
const DELETED_USER
Definition: Revision.php:92
ContextSource\getConfig
getConfig()
Get the Config object.
Definition: ContextSource.php:68
Revision\DELETED_RESTRICTED
const DELETED_RESTRICTED
Definition: Revision.php:93
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:198
ApiQuery
This is the main query class.
Definition: ApiQuery.php:40
ApiBase\addWarning
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition: ApiBase.php:1720
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
MWNamespace\getValidNamespaces
static getValidNamespaces()
Returns an array of the namespaces (by integer id) that exist on the wiki.
Definition: MWNamespace.php:264
captcha-old.count
count
Definition: captcha-old.py:225
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1796
ApiQueryBase\addTimestampWhereRange
addTimestampWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
Definition: ApiQueryBase.php:321
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:128
$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. 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 '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. '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) '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 '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: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! 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:1954
$namespaces
namespace and then decline to actually register it & $namespaces
Definition: hooks.txt:934
ApiBase\PARAM_TYPE
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:91
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:610
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:246
ApiBase\checkUserRightsAny
checkUserRightsAny( $rights, $user=null)
Helper function for permission-denied errors.
Definition: ApiBase.php:1890
$params
$params
Definition: styleTest.css.php:40
$res
$res
Definition: database.txt:21
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:333
ContextSource\getUser
getUser()
Get the User object.
Definition: ContextSource.php:133
ApiBase\PARAM_HELP_MSG_APPEND
const PARAM_HELP_MSG_APPEND
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this ...
Definition: ApiBase.php:135
ApiPageSet
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:44
php
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
LIST_AND
const LIST_AND
Definition: Defines.php:41
key
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain database key
Definition: design.txt:25
ApiQueryRevisionsBase
A base class for functions common to producing a list of revisions.
Definition: ApiQueryRevisionsBase.php:32
ApiQueryAllDeletedRevisions\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQueryAllDeletedRevisions.php:457
ApiQueryGeneratorBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
Definition: ApiQueryGeneratorBase.php:88
$query
null for the 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:1572
LIST_OR
const LIST_OR
Definition: Defines.php:44
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:934
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:111
ApiQueryAllDeletedRevisions\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryAllDeletedRevisions.php:389
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:164
ApiQueryBase\select
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:358
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:514
ApiQueryAllDeletedRevisions\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQueryAllDeletedRevisions.php:448
$dir
$dir
Definition: Autoload.php:8
$sort
$sort
Definition: profileinfo.php:323
ApiQueryBase\$where
$where
Definition: ApiQueryBase.php:39
ApiQueryAllDeletedRevisions\run
run(ApiPageSet $resultPageSet=null)
Definition: ApiQueryAllDeletedRevisions.php:43
ApiBase\getModulePrefix
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:498
ApiQueryRevisionsBase\extractRevisionInfo
extractRevisionInfo(Revision $revision, $row)
Extract information from the Revision.
Definition: ApiQueryRevisionsBase.php:157
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:718
ApiResult\setIndexedTagName
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
Revision\selectArchiveFields
static selectArchiveFields()
Return the list of revision fields that should be selected to create a new revision from an archive r...
Definition: Revision.php:479
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition: ApiBase.php:1950
ApiQueryBase\addJoinConds
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
Definition: ApiQueryBase.php:187
$ret
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:1956
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
Definition: ApiQueryBase.php:266
ApiBase\PARAM_HELP_MSG_INFO
const PARAM_HELP_MSG_INFO
(array) Specify additional information tags for the parameter.
Definition: ApiBase.php:145
ApiQueryAllDeletedRevisions\__construct
__construct(ApiQuery $query, $moduleName)
Definition: ApiQueryAllDeletedRevisions.php:35
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:52
$rev
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:1741
ApiBase\getParameter
getParameter( $paramName, $parseLimit=true)
Get a value for the given parameter.
Definition: ApiBase.php:742
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:490
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:55
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:233
ApiQueryBase\titlePartToKey
titlePartToKey( $titlePart, $namespace=NS_MAIN)
Convert an input title or title prefix into a dbkey.
Definition: ApiQueryBase.php:549
ApiQueryAllDeletedRevisions
Query module to enumerate all deleted revisions.
Definition: ApiQueryAllDeletedRevisions.php:33
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:486