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