MediaWiki  1.28.0
ApiQueryAllRevisions.php
Go to the documentation of this file.
1 <?php
32 
33  public function __construct( ApiQuery $query, $moduleName ) {
34  parent::__construct( $query, $moduleName, 'arv' );
35  }
36 
41  protected function run( ApiPageSet $resultPageSet = null ) {
42  $db = $this->getDB();
43  $params = $this->extractRequestParams( false );
44 
45  $result = $this->getResult();
46 
47  $this->requireMaxOneParameter( $params, 'user', 'excludeuser' );
48 
49  // Namespace check is likely to be desired, but can't be done
50  // efficiently in SQL.
51  $miser_ns = null;
52  $needPageTable = false;
53  if ( $params['namespace'] !== null ) {
54  $params['namespace'] = array_unique( $params['namespace'] );
55  sort( $params['namespace'] );
56  if ( $params['namespace'] != MWNamespace::getValidNamespaces() ) {
57  $needPageTable = true;
58  if ( $this->getConfig()->get( 'MiserMode' ) ) {
59  $miser_ns = $params['namespace'];
60  } else {
61  $this->addWhere( [ 'page_namespace' => $params['namespace'] ] );
62  }
63  }
64  }
65 
66  $this->addTables( 'revision' );
67  if ( $resultPageSet === null ) {
68  $this->parseParameters( $params );
69  $this->addTables( 'page' );
70  $this->addJoinConds(
71  [ 'page' => [ 'INNER JOIN', [ 'rev_page = page_id' ] ] ]
72  );
75 
76  // Review this depeneding on the outcome of T113901
77  $this->addOption( 'STRAIGHT_JOIN' );
78  } else {
79  $this->limit = $this->getParameter( 'limit' ) ?: 10;
80  $this->addFields( [ 'rev_timestamp', 'rev_id' ] );
81  if ( $params['generatetitles'] ) {
82  $this->addFields( [ 'rev_page' ] );
83  }
84 
85  if ( $needPageTable ) {
86  $this->addTables( 'page' );
87  $this->addJoinConds(
88  [ 'page' => [ 'INNER JOIN', [ 'rev_page = page_id' ] ] ]
89  );
90  $this->addFieldsIf( [ 'page_namespace' ], (bool)$miser_ns );
91 
92  // Review this depeneding on the outcome of T113901
93  $this->addOption( 'STRAIGHT_JOIN' );
94  }
95  }
96 
97  $dir = $params['dir'];
98  $this->addTimestampWhereRange( 'rev_timestamp', $dir, $params['start'], $params['end'] );
99 
100  if ( $this->fld_tags ) {
101  $this->addTables( 'tag_summary' );
102  $this->addJoinConds(
103  [ 'tag_summary' => [ 'LEFT JOIN', [ 'rev_id=ts_rev_id' ] ] ]
104  );
105  $this->addFields( 'ts_tags' );
106  }
107 
108  if ( $this->fetchContent ) {
109  $this->addTables( 'text' );
110  $this->addJoinConds(
111  [ 'text' => [ 'INNER JOIN', [ 'rev_text_id=old_id' ] ] ]
112  );
113  $this->addFields( 'old_id' );
115  }
116 
117  if ( $params['user'] !== null ) {
118  $id = User::idFromName( $params['user'] );
119  if ( $id ) {
120  $this->addWhereFld( 'rev_user', $id );
121  } else {
122  $this->addWhereFld( 'rev_user_text', $params['user'] );
123  }
124  } elseif ( $params['excludeuser'] !== null ) {
125  $id = User::idFromName( $params['excludeuser'] );
126  if ( $id ) {
127  $this->addWhere( 'rev_user != ' . $id );
128  } else {
129  $this->addWhere( 'rev_user_text != ' . $db->addQuotes( $params['excludeuser'] ) );
130  }
131  }
132 
133  if ( $params['user'] !== null || $params['excludeuser'] !== null ) {
134  // Paranoia: avoid brute force searches (bug 17342)
135  if ( !$this->getUser()->isAllowed( 'deletedhistory' ) ) {
136  $bitmask = Revision::DELETED_USER;
137  } elseif ( !$this->getUser()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
139  } else {
140  $bitmask = 0;
141  }
142  if ( $bitmask ) {
143  $this->addWhere( $db->bitAnd( 'rev_deleted', $bitmask ) . " != $bitmask" );
144  }
145  }
146 
147  if ( $params['continue'] !== null ) {
148  $op = ( $dir == 'newer' ? '>' : '<' );
149  $cont = explode( '|', $params['continue'] );
150  $this->dieContinueUsageIf( count( $cont ) != 2 );
151  $ts = $db->addQuotes( $db->timestamp( $cont[0] ) );
152  $rev_id = (int)$cont[1];
153  $this->dieContinueUsageIf( strval( $rev_id ) !== $cont[1] );
154  $this->addWhere( "rev_timestamp $op $ts OR " .
155  "(rev_timestamp = $ts AND " .
156  "rev_id $op= $rev_id)" );
157  }
158 
159  $this->addOption( 'LIMIT', $this->limit + 1 );
160 
161  $sort = ( $dir == 'newer' ? '' : ' DESC' );
162  $orderby = [];
163  // Targeting index rev_timestamp, user_timestamp, or usertext_timestamp
164  // But 'user' is always constant for the latter two, so it doesn't matter here.
165  $orderby[] = "rev_timestamp $sort";
166  $orderby[] = "rev_id $sort";
167  $this->addOption( 'ORDER BY', $orderby );
168 
169  $hookData = [];
170  $res = $this->select( __METHOD__, [], $hookData );
171  $pageMap = []; // Maps rev_page to array index
172  $count = 0;
173  $nextIndex = 0;
174  $generated = [];
175  foreach ( $res as $row ) {
176  if ( $count === 0 && $resultPageSet !== null ) {
177  // Set the non-continue since the list of all revisions is
178  // prone to having entries added at the start frequently.
179  $this->getContinuationManager()->addGeneratorNonContinueParam(
180  $this, 'continue', "$row->rev_timestamp|$row->rev_id"
181  );
182  }
183  if ( ++$count > $this->limit ) {
184  // We've had enough
185  $this->setContinueEnumParameter( 'continue', "$row->rev_timestamp|$row->rev_id" );
186  break;
187  }
188 
189  // Miser mode namespace check
190  if ( $miser_ns !== null && !in_array( $row->page_namespace, $miser_ns ) ) {
191  continue;
192  }
193 
194  if ( $resultPageSet !== null ) {
195  if ( $params['generatetitles'] ) {
196  $generated[$row->rev_page] = $row->rev_page;
197  } else {
198  $generated[] = $row->rev_id;
199  }
200  } else {
201  $revision = Revision::newFromRow( $row );
202  $rev = $this->extractRevisionInfo( $revision, $row );
203 
204  if ( !isset( $pageMap[$row->rev_page] ) ) {
205  $index = $nextIndex++;
206  $pageMap[$row->rev_page] = $index;
207  $title = $revision->getTitle();
208  $a = [
209  'pageid' => $title->getArticleID(),
210  'revisions' => [ $rev ],
211  ];
212  ApiResult::setIndexedTagName( $a['revisions'], 'rev' );
214  $fit = $this->processRow( $row, $a['revisions'][0], $hookData ) &&
215  $result->addValue( [ 'query', $this->getModuleName() ], $index, $a );
216  } else {
217  $index = $pageMap[$row->rev_page];
218  $fit = $this->processRow( $row, $rev, $hookData ) &&
219  $result->addValue( [ 'query', $this->getModuleName(), $index, 'revisions' ], null, $rev );
220  }
221  if ( !$fit ) {
222  $this->setContinueEnumParameter( 'continue', "$row->rev_timestamp|$row->rev_id" );
223  break;
224  }
225  }
226  }
227 
228  if ( $resultPageSet !== null ) {
229  if ( $params['generatetitles'] ) {
230  $resultPageSet->populateFromPageIDs( $generated );
231  } else {
232  $resultPageSet->populateFromRevisionIDs( $generated );
233  }
234  } else {
235  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
236  }
237  }
238 
239  public function getAllowedParams() {
240  $ret = parent::getAllowedParams() + [
241  'user' => [
242  ApiBase::PARAM_TYPE => 'user',
243  ],
244  'namespace' => [
245  ApiBase::PARAM_ISMULTI => true,
246  ApiBase::PARAM_TYPE => 'namespace',
247  ApiBase::PARAM_DFLT => null,
248  ],
249  'start' => [
250  ApiBase::PARAM_TYPE => 'timestamp',
251  ],
252  'end' => [
253  ApiBase::PARAM_TYPE => 'timestamp',
254  ],
255  'dir' => [
257  'newer',
258  'older'
259  ],
260  ApiBase::PARAM_DFLT => 'older',
261  ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
262  ],
263  'excludeuser' => [
264  ApiBase::PARAM_TYPE => 'user',
265  ],
266  'continue' => [
267  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
268  ],
269  'generatetitles' => [
270  ApiBase::PARAM_DFLT => false,
271  ],
272  ];
273 
274  if ( $this->getConfig()->get( 'MiserMode' ) ) {
275  $ret['namespace'][ApiBase::PARAM_HELP_MSG_APPEND] = [
276  'api-help-param-limited-in-miser-mode',
277  ];
278  }
279 
280  return $ret;
281  }
282 
283  protected function getExamplesMessages() {
284  return [
285  'action=query&list=allrevisions&arvuser=Example&arvlimit=50'
286  => 'apihelp-query+allrevisions-example-user',
287  'action=query&list=allrevisions&arvdir=newer&arvlimit=50'
288  => 'apihelp-query+allrevisions-example-ns-main',
289  ];
290  }
291 
292  public function getHelpUrls() {
293  return 'https://www.mediawiki.org/wiki/API:Allrevisions';
294  }
295 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
Query module to enumerate all revisions.
getDB()
Get the Query database connection (read-only)
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:1555
getResult()
Get the result object.
Definition: ApiBase.php:577
if(count($args)==0) $dir
getParameter($paramName, $parseLimit=true)
Get a value for the given parameter.
Definition: ApiBase.php:702
addWhereFld($field, $value)
Equivalent to addWhere(array($field => $value))
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:41
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:1936
requireMaxOneParameter($params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:740
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:50
$sort
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:678
A base class for functions common to producing a list of revisions.
select($method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
addTimestampWhereRange($field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
setContinueEnumParameter($paramName, $paramValue)
Overridden to set the generator param if in generator mode.
addWhere($value)
Add a set of WHERE clauses to the internal array.
extractRevisionInfo(Revision $revision, $row)
Extract information from the Revision.
addJoinConds($join_conds)
Add a set of JOIN conditions to the internal array.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:618
parseParameters($params)
Parse the parameters into the various instance fields.
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: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. '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:1934
const PARAM_HELP_MSG_APPEND
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this ...
Definition: ApiBase.php:132
$res
Definition: database.txt:21
getContinuationManager()
Get the continuation manager.
Definition: ApiBase.php:617
getConfig()
Get the Config object.
processRow($row, array &$data, array &$hookData)
Call the ApiQueryBaseProcessRow hook.
addOption($name, $value=null)
Add an option such as LIMIT or USE INDEX.
$params
static selectFields()
Return the list of revision fields that should be selected to create a new revision.
Definition: Revision.php:442
static selectTextFields()
Return the list of text fields that should be selected to read the revision text. ...
Definition: Revision.php:504
const DELETED_RESTRICTED
Definition: Revision.php:88
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:457
This is the main query class.
Definition: ApiQuery.php:38
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:1721
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
dieContinueUsageIf($condition)
Die with the $prefix.
Definition: ApiBase.php:2229
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
addFieldsIf($value, $condition)
Same as addFields(), but add the fields only if a condition is met.
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 DELETED_USER
Definition: Revision.php:87
addFields($value)
Add a set of fields to select to the internal array.
__construct(ApiQuery $query, $moduleName)
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:53
static newFromRow($row)
Definition: Revision.php:230
static idFromName($name, $flags=self::READ_NORMAL)
Get database id given a user name.
Definition: User.php:728
$count
static selectPageFields()
Return the list of page fields that should be selected from page table.
Definition: Revision.php:515
static getValidNamespaces()
Returns an array of the namespaces (by integer id) that exist on the wiki.
static addTitleInfo(&$arr, $title, $prefix= '')
Add information (title and namespace) about a Title object to a result array.
getUser()
Get the User object.
addTables($tables, $alias=null)
Add a set of tables to the internal array.
run(ApiPageSet $resultPageSet=null)