MediaWiki  master
ApiQueryAllRevisions.php
Go to the documentation of this file.
1 <?php
25 
33 
34  public function __construct( ApiQuery $query, $moduleName ) {
35  parent::__construct( $query, $moduleName, 'arv' );
36  }
37 
42  protected function run( ApiPageSet $resultPageSet = null ) {
44 
45  $db = $this->getDB();
46  $params = $this->extractRequestParams( false );
47  $services = MediaWikiServices::getInstance();
48  $revisionStore = $services->getRevisionStore();
49 
50  $result = $this->getResult();
51 
52  $this->requireMaxOneParameter( $params, 'user', 'excludeuser' );
53 
54  $tsField = 'rev_timestamp';
55  $idField = 'rev_id';
56  $pageField = 'rev_page';
57  if ( $params['user'] !== null &&
58  ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW )
59  ) {
60  // The query is probably best done using the actor_timestamp index on
61  // revision_actor_temp. Use the denormalized fields from that table.
62  $tsField = 'revactor_timestamp';
63  $idField = 'revactor_rev';
64  $pageField = 'revactor_page';
65  }
66 
67  // Namespace check is likely to be desired, but can't be done
68  // efficiently in SQL.
69  $miser_ns = null;
70  $needPageTable = false;
71  if ( $params['namespace'] !== null ) {
72  $params['namespace'] = array_unique( $params['namespace'] );
73  sort( $params['namespace'] );
74  if ( $params['namespace'] != $services->getNamespaceInfo()->getValidNamespaces() ) {
75  $needPageTable = true;
76  if ( $this->getConfig()->get( 'MiserMode' ) ) {
77  $miser_ns = $params['namespace'];
78  } else {
79  $this->addWhere( [ 'page_namespace' => $params['namespace'] ] );
80  }
81  }
82  }
83 
84  if ( $resultPageSet === null ) {
85  $this->parseParameters( $params );
86  $revQuery = $revisionStore->getQueryInfo( [ 'page' ] );
87  } else {
88  $this->limit = $this->getParameter( 'limit' ) ?: 10;
89  $revQuery = [
90  'tables' => [ 'revision' ],
91  'fields' => [ 'rev_timestamp', 'rev_id' ],
92  'joins' => [],
93  ];
94 
95  if ( $params['generatetitles'] ) {
96  $revQuery['fields'][] = 'rev_page';
97  }
98 
99  if ( $params['user'] !== null || $params['excludeuser'] !== null ) {
100  $actorQuery = ActorMigration::newMigration()->getJoin( 'rev_user' );
101  $revQuery['tables'] += $actorQuery['tables'];
102  $revQuery['joins'] += $actorQuery['joins'];
103  }
104 
105  if ( $needPageTable ) {
106  $revQuery['tables'][] = 'page';
107  $revQuery['joins']['page'] = [ 'JOIN', [ "$pageField = page_id" ] ];
108  if ( (bool)$miser_ns ) {
109  $revQuery['fields'][] = 'page_namespace';
110  }
111  }
112  }
113 
114  // If we're going to be using actor_timestamp, we need to swap the order of `revision`
115  // and `revision_actor_temp` in the query (for the straight join) and adjust some field aliases.
116  if ( $idField !== 'rev_id' && isset( $revQuery['tables']['temp_rev_user'] ) ) {
117  $aliasFields = [ 'rev_id' => $idField, 'rev_timestamp' => $tsField, 'rev_page' => $pageField ];
118  $revQuery['fields'] = array_merge(
119  $aliasFields,
120  array_diff( $revQuery['fields'], array_keys( $aliasFields ) )
121  );
122  unset( $revQuery['tables']['temp_rev_user'] );
123  $revQuery['tables'] = array_merge(
124  [ 'temp_rev_user' => 'revision_actor_temp' ],
125  $revQuery['tables']
126  );
127  $revQuery['joins']['revision'] = $revQuery['joins']['temp_rev_user'];
128  unset( $revQuery['joins']['temp_rev_user'] );
129  }
130 
131  $this->addTables( $revQuery['tables'] );
132  $this->addFields( $revQuery['fields'] );
133  $this->addJoinConds( $revQuery['joins'] );
134 
135  // Seems to be needed to avoid a planner bug (T113901)
136  $this->addOption( 'STRAIGHT_JOIN' );
137 
138  $dir = $params['dir'];
139  $this->addTimestampWhereRange( $tsField, $dir, $params['start'], $params['end'] );
140 
141  if ( $this->fld_tags ) {
142  $this->addFields( [ 'ts_tags' => ChangeTags::makeTagSummarySubquery( 'revision' ) ] );
143  }
144 
145  if ( $params['user'] !== null ) {
146  $actorQuery = ActorMigration::newMigration()
147  ->getWhere( $db, 'rev_user', User::newFromName( $params['user'], false ) );
148  $this->addWhere( $actorQuery['conds'] );
149  } elseif ( $params['excludeuser'] !== null ) {
150  $actorQuery = ActorMigration::newMigration()
151  ->getWhere( $db, 'rev_user', User::newFromName( $params['excludeuser'], false ) );
152  $this->addWhere( 'NOT(' . $actorQuery['conds'] . ')' );
153  }
154 
155  if ( $params['user'] !== null || $params['excludeuser'] !== null ) {
156  // Paranoia: avoid brute force searches (T19342)
157  if ( !$this->getPermissionManager()->userHasRight( $this->getUser(), 'deletedhistory' ) ) {
158  $bitmask = RevisionRecord::DELETED_USER;
159  } elseif ( !$this->getUser()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
160  $bitmask = RevisionRecord::DELETED_USER | RevisionRecord::DELETED_RESTRICTED;
161  } else {
162  $bitmask = 0;
163  }
164  if ( $bitmask ) {
165  $this->addWhere( $db->bitAnd( 'rev_deleted', $bitmask ) . " != $bitmask" );
166  }
167  }
168 
169  if ( $params['continue'] !== null ) {
170  $op = ( $dir == 'newer' ? '>' : '<' );
171  $cont = explode( '|', $params['continue'] );
172  $this->dieContinueUsageIf( count( $cont ) != 2 );
173  $ts = $db->addQuotes( $db->timestamp( $cont[0] ) );
174  $rev_id = (int)$cont[1];
175  $this->dieContinueUsageIf( strval( $rev_id ) !== $cont[1] );
176  $this->addWhere( "$tsField $op $ts OR " .
177  "($tsField = $ts AND " .
178  "$idField $op= $rev_id)" );
179  }
180 
181  $this->addOption( 'LIMIT', $this->limit + 1 );
182 
183  $sort = ( $dir == 'newer' ? '' : ' DESC' );
184  $orderby = [];
185  // Targeting index rev_timestamp, user_timestamp, usertext_timestamp, or actor_timestamp.
186  // But 'user' is always constant for the latter three, so it doesn't matter here.
187  $orderby[] = "rev_timestamp $sort";
188  $orderby[] = "rev_id $sort";
189  $this->addOption( 'ORDER BY', $orderby );
190 
191  $hookData = [];
192  $res = $this->select( __METHOD__, [], $hookData );
193  $pageMap = []; // Maps rev_page to array index
194  $count = 0;
195  $nextIndex = 0;
196  $generated = [];
197  foreach ( $res as $row ) {
198  if ( $count === 0 && $resultPageSet !== null ) {
199  // Set the non-continue since the list of all revisions is
200  // prone to having entries added at the start frequently.
201  $this->getContinuationManager()->addGeneratorNonContinueParam(
202  $this, 'continue', "$row->rev_timestamp|$row->rev_id"
203  );
204  }
205  if ( ++$count > $this->limit ) {
206  // We've had enough
207  $this->setContinueEnumParameter( 'continue', "$row->rev_timestamp|$row->rev_id" );
208  break;
209  }
210 
211  // Miser mode namespace check
212  if ( $miser_ns !== null && !in_array( $row->page_namespace, $miser_ns ) ) {
213  continue;
214  }
215 
216  if ( $resultPageSet !== null ) {
217  if ( $params['generatetitles'] ) {
218  $generated[$row->rev_page] = $row->rev_page;
219  } else {
220  $generated[] = $row->rev_id;
221  }
222  } else {
223  $revision = $revisionStore->newRevisionFromRow( $row );
224  $rev = $this->extractRevisionInfo( $revision, $row );
225 
226  if ( !isset( $pageMap[$row->rev_page] ) ) {
227  $index = $nextIndex++;
228  $pageMap[$row->rev_page] = $index;
229  $title = Title::newFromLinkTarget( $revision->getPageAsLinkTarget() );
230  $a = [
231  'pageid' => $title->getArticleID(),
232  'revisions' => [ $rev ],
233  ];
234  ApiResult::setIndexedTagName( $a['revisions'], 'rev' );
236  $fit = $this->processRow( $row, $a['revisions'][0], $hookData ) &&
237  $result->addValue( [ 'query', $this->getModuleName() ], $index, $a );
238  } else {
239  $index = $pageMap[$row->rev_page];
240  $fit = $this->processRow( $row, $rev, $hookData ) &&
241  $result->addValue( [ 'query', $this->getModuleName(), $index, 'revisions' ], null, $rev );
242  }
243  if ( !$fit ) {
244  $this->setContinueEnumParameter( 'continue', "$row->rev_timestamp|$row->rev_id" );
245  break;
246  }
247  }
248  }
249 
250  if ( $resultPageSet !== null ) {
251  if ( $params['generatetitles'] ) {
252  $resultPageSet->populateFromPageIDs( $generated );
253  } else {
254  $resultPageSet->populateFromRevisionIDs( $generated );
255  }
256  } else {
257  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
258  }
259  }
260 
261  public function getAllowedParams() {
262  $ret = parent::getAllowedParams() + [
263  'user' => [
264  ApiBase::PARAM_TYPE => 'user',
265  ],
266  'namespace' => [
267  ApiBase::PARAM_ISMULTI => true,
268  ApiBase::PARAM_TYPE => 'namespace',
270  ],
271  'start' => [
272  ApiBase::PARAM_TYPE => 'timestamp',
273  ],
274  'end' => [
275  ApiBase::PARAM_TYPE => 'timestamp',
276  ],
277  'dir' => [
279  'newer',
280  'older'
281  ],
282  ApiBase::PARAM_DFLT => 'older',
283  ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
284  ],
285  'excludeuser' => [
286  ApiBase::PARAM_TYPE => 'user',
287  ],
288  'continue' => [
289  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
290  ],
291  'generatetitles' => [
292  ApiBase::PARAM_DFLT => false,
293  ],
294  ];
295 
296  if ( $this->getConfig()->get( 'MiserMode' ) ) {
297  $ret['namespace'][ApiBase::PARAM_HELP_MSG_APPEND] = [
298  'api-help-param-limited-in-miser-mode',
299  ];
300  }
301 
302  return $ret;
303  }
304 
305  protected function getExamplesMessages() {
306  return [
307  'action=query&list=allrevisions&arvuser=Example&arvlimit=50'
308  => 'apihelp-query+allrevisions-example-user',
309  'action=query&list=allrevisions&arvdir=newer&arvlimit=50'
310  => 'apihelp-query+allrevisions-example-ns-main',
311  ];
312  }
313 
314  public function getHelpUrls() {
315  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allrevisions';
316  }
317 }
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
Query module to enumerate all revisions.
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:1535
getResult()
Get the result object.
Definition: ApiBase.php:640
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:40
processRow( $row, array &$data, array &$hookData)
Call the ApiQueryBaseProcessRow hook.
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:1978
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
int $wgActorTableSchemaMigrationStage
Actor table schema migration stage.
$sort
A base class for functions common to producing a list of revisions.
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:761
const SCHEMA_COMPAT_READ_NEW
Definition: Defines.php:267
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
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:1976
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.
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:2211
$res
Definition: database.txt:21
dieContinueUsageIf( $condition)
Die with the &#39;badcontinue&#39; error.
Definition: ApiBase.php:2200
getContinuationManager()
Get the continuation manager.
Definition: ApiBase.php:680
$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:773
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:918
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:1754
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
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:931
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:131
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...
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
addWhere( $value)
Add a set of WHERE clauses to the internal array.
$revQuery
__construct(ApiQuery $query, $moduleName)
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:58
getPermissionManager()
Obtain a PermissionManager instance that subclasses may use in their authorization checks...
Definition: ApiBase.php:710
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:841
run(ApiPageSet $resultPageSet=null)