3 * Copyright © 2015 Wikimedia Foundation and contributors
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * Query module to enumerate all revisions.
29 class ApiQueryAllRevisions
extends ApiQueryRevisionsBase
{
31 public function __construct( ApiQuery
$query, $moduleName ) {
32 parent
::__construct( $query, $moduleName, 'arv' );
36 * @param ApiPageSet $resultPageSet
39 protected function run( ApiPageSet
$resultPageSet = null ) {
41 $params = $this->extractRequestParams( false );
43 $result = $this->getResult();
45 $this->requireMaxOneParameter( $params, 'user', 'excludeuser' );
47 // Namespace check is likely to be desired, but can't be done
48 // efficiently in SQL.
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'];
59 $this->addWhere( [ 'page_namespace' => $params['namespace'] ] );
64 if ( $resultPageSet === null ) {
65 $this->parseParameters( $params );
66 $revQuery = Revision
::getQueryInfo(
67 $this->fetchContent ?
[ 'page', 'text' ] : [ 'page' ]
69 $this->addTables( $revQuery['tables'] );
70 $this->addFields( $revQuery['fields'] );
71 $this->addJoinConds( $revQuery['joins'] );
73 // Review this depeneding on the outcome of T113901
74 $this->addOption( 'STRAIGHT_JOIN' );
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' ] );
83 if ( $needPageTable ) {
84 $this->addTables( 'page' );
86 [ 'page' => [ 'INNER JOIN', [ 'rev_page = page_id' ] ] ]
88 $this->addFieldsIf( [ 'page_namespace' ], (bool)$miser_ns );
90 // Review this depeneding on the outcome of T113901
91 $this->addOption( 'STRAIGHT_JOIN' );
95 $dir = $params['dir'];
96 $this->addTimestampWhereRange( 'rev_timestamp', $dir, $params['start'], $params['end'] );
98 if ( $this->fld_tags
) {
99 $this->addTables( 'tag_summary' );
101 [ 'tag_summary' => [ 'LEFT JOIN', [ 'rev_id=ts_rev_id' ] ] ]
103 $this->addFields( 'ts_tags' );
106 if ( $params['user'] !== null ) {
107 $id = User
::idFromName( $params['user'] );
109 $this->addWhereFld( 'rev_user', $id );
111 $this->addWhereFld( 'rev_user_text', $params['user'] );
113 } elseif ( $params['excludeuser'] !== null ) {
114 $id = User
::idFromName( $params['excludeuser'] );
116 $this->addWhere( 'rev_user != ' . $id );
118 $this->addWhere( 'rev_user_text != ' . $db->addQuotes( $params['excludeuser'] ) );
122 if ( $params['user'] !== null ||
$params['excludeuser'] !== null ) {
123 // Paranoia: avoid brute force searches (T19342)
124 if ( !$this->getUser()->isAllowed( 'deletedhistory' ) ) {
125 $bitmask = Revision
::DELETED_USER
;
126 } elseif ( !$this->getUser()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
127 $bitmask = Revision
::DELETED_USER | Revision
::DELETED_RESTRICTED
;
132 $this->addWhere( $db->bitAnd( 'rev_deleted', $bitmask ) . " != $bitmask" );
136 if ( $params['continue'] !== null ) {
137 $op = ( $dir == 'newer' ?
'>' : '<' );
138 $cont = explode( '|', $params['continue'] );
139 $this->dieContinueUsageIf( count( $cont ) != 2 );
140 $ts = $db->addQuotes( $db->timestamp( $cont[0] ) );
141 $rev_id = (int)$cont[1];
142 $this->dieContinueUsageIf( strval( $rev_id ) !== $cont[1] );
143 $this->addWhere( "rev_timestamp $op $ts OR " .
144 "(rev_timestamp = $ts AND " .
145 "rev_id $op= $rev_id)" );
148 $this->addOption( 'LIMIT', $this->limit +
1 );
150 $sort = ( $dir == 'newer' ?
'' : ' DESC' );
152 // Targeting index rev_timestamp, user_timestamp, or usertext_timestamp
153 // But 'user' is always constant for the latter two, so it doesn't matter here.
154 $orderby[] = "rev_timestamp $sort";
155 $orderby[] = "rev_id $sort";
156 $this->addOption( 'ORDER BY', $orderby );
159 $res = $this->select( __METHOD__
, [], $hookData );
160 $pageMap = []; // Maps rev_page to array index
164 foreach ( $res as $row ) {
165 if ( $count === 0 && $resultPageSet !== null ) {
166 // Set the non-continue since the list of all revisions is
167 // prone to having entries added at the start frequently.
168 $this->getContinuationManager()->addGeneratorNonContinueParam(
169 $this, 'continue', "$row->rev_timestamp|$row->rev_id"
172 if ( ++
$count > $this->limit
) {
174 $this->setContinueEnumParameter( 'continue', "$row->rev_timestamp|$row->rev_id" );
178 // Miser mode namespace check
179 if ( $miser_ns !== null && !in_array( $row->page_namespace
, $miser_ns ) ) {
183 if ( $resultPageSet !== null ) {
184 if ( $params['generatetitles'] ) {
185 $generated[$row->rev_page
] = $row->rev_page
;
187 $generated[] = $row->rev_id
;
190 $revision = Revision
::newFromRow( $row );
191 $rev = $this->extractRevisionInfo( $revision, $row );
193 if ( !isset( $pageMap[$row->rev_page
] ) ) {
194 $index = $nextIndex++
;
195 $pageMap[$row->rev_page
] = $index;
196 $title = $revision->getTitle();
198 'pageid' => $title->getArticleID(),
199 'revisions' => [ $rev ],
201 ApiResult
::setIndexedTagName( $a['revisions'], 'rev' );
202 ApiQueryBase
::addTitleInfo( $a, $title );
203 $fit = $this->processRow( $row, $a['revisions'][0], $hookData ) &&
204 $result->addValue( [ 'query', $this->getModuleName() ], $index, $a );
206 $index = $pageMap[$row->rev_page
];
207 $fit = $this->processRow( $row, $rev, $hookData ) &&
208 $result->addValue( [ 'query', $this->getModuleName(), $index, 'revisions' ], null, $rev );
211 $this->setContinueEnumParameter( 'continue', "$row->rev_timestamp|$row->rev_id" );
217 if ( $resultPageSet !== null ) {
218 if ( $params['generatetitles'] ) {
219 $resultPageSet->populateFromPageIDs( $generated );
221 $resultPageSet->populateFromRevisionIDs( $generated );
224 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
228 public function getAllowedParams() {
229 $ret = parent
::getAllowedParams() +
[
231 ApiBase
::PARAM_TYPE
=> 'user',
234 ApiBase
::PARAM_ISMULTI
=> true,
235 ApiBase
::PARAM_TYPE
=> 'namespace',
236 ApiBase
::PARAM_DFLT
=> null,
239 ApiBase
::PARAM_TYPE
=> 'timestamp',
242 ApiBase
::PARAM_TYPE
=> 'timestamp',
245 ApiBase
::PARAM_TYPE
=> [
249 ApiBase
::PARAM_DFLT
=> 'older',
250 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-direction',
253 ApiBase
::PARAM_TYPE
=> 'user',
256 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
258 'generatetitles' => [
259 ApiBase
::PARAM_DFLT
=> false,
263 if ( $this->getConfig()->get( 'MiserMode' ) ) {
264 $ret['namespace'][ApiBase
::PARAM_HELP_MSG_APPEND
] = [
265 'api-help-param-limited-in-miser-mode',
272 protected function getExamplesMessages() {
274 'action=query&list=allrevisions&arvuser=Example&arvlimit=50'
275 => 'apihelp-query+allrevisions-example-user',
276 'action=query&list=allrevisions&arvdir=newer&arvlimit=50'
277 => 'apihelp-query+allrevisions-example-ns-main',
281 public function getHelpUrls() {
282 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allrevisions';