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
23 use MediaWiki\MediaWikiServices
;
24 use MediaWiki\Revision\RevisionRecord
;
27 * Query module to enumerate all revisions.
32 class ApiQueryAllRevisions
extends ApiQueryRevisionsBase
{
34 public function __construct( ApiQuery
$query, $moduleName ) {
35 parent
::__construct( $query, $moduleName, 'arv' );
39 * @param ApiPageSet|null $resultPageSet
42 protected function run( ApiPageSet
$resultPageSet = null ) {
43 global $wgActorTableSchemaMigrationStage;
46 $params = $this->extractRequestParams( false );
47 $revisionStore = MediaWikiServices
::getInstance()->getRevisionStore();
49 $result = $this->getResult();
51 $this->requireMaxOneParameter( $params, 'user', 'excludeuser' );
53 $tsField = 'rev_timestamp';
55 $pageField = 'rev_page';
56 if ( $params['user'] !== null &&
57 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
)
59 // The query is probably best done using the actor_timestamp index on
60 // revision_actor_temp. Use the denormalized fields from that table.
61 $tsField = 'revactor_timestamp';
62 $idField = 'revactor_rev';
63 $pageField = 'revactor_page';
66 // Namespace check is likely to be desired, but can't be done
67 // efficiently in SQL.
69 $needPageTable = false;
70 if ( $params['namespace'] !== null ) {
71 $params['namespace'] = array_unique( $params['namespace'] );
72 sort( $params['namespace'] );
73 if ( $params['namespace'] != MWNamespace
::getValidNamespaces() ) {
74 $needPageTable = true;
75 if ( $this->getConfig()->get( 'MiserMode' ) ) {
76 $miser_ns = $params['namespace'];
78 $this->addWhere( [ 'page_namespace' => $params['namespace'] ] );
83 if ( $resultPageSet === null ) {
84 $this->parseParameters( $params );
85 $revQuery = $revisionStore->getQueryInfo(
86 $this->fetchContent ?
[ 'page', 'text' ] : [ 'page' ]
89 $this->limit
= $this->getParameter( 'limit' ) ?
: 10;
91 'tables' => [ 'revision' ],
92 'fields' => [ 'rev_timestamp', 'rev_id' ],
96 if ( $params['generatetitles'] ) {
97 $revQuery['fields'][] = 'rev_page';
100 if ( $params['user'] !== null ||
$params['excludeuser'] !== null ) {
101 $actorQuery = ActorMigration
::newMigration()->getJoin( 'rev_user' );
102 $revQuery['tables'] +
= $actorQuery['tables'];
103 $revQuery['joins'] +
= $actorQuery['joins'];
106 if ( $needPageTable ) {
107 $revQuery['tables'][] = 'page';
108 $revQuery['joins']['page'] = [ 'INNER JOIN', [ "$pageField = page_id" ] ];
109 if ( (bool)$miser_ns ) {
110 $revQuery['fields'][] = 'page_namespace';
115 // If we're going to be using actor_timestamp, we need to swap the order of `revision`
116 // and `revision_actor_temp` in the query (for the straight join) and adjust some field aliases.
117 if ( $idField !== 'rev_id' && isset( $revQuery['tables']['temp_rev_user'] ) ) {
118 $aliasFields = [ 'rev_id' => $idField, 'rev_timestamp' => $tsField, 'rev_page' => $pageField ];
119 $revQuery['fields'] = array_merge(
121 array_diff( $revQuery['fields'], array_keys( $aliasFields ) )
123 unset( $revQuery['tables']['temp_rev_user'] );
124 $revQuery['tables'] = array_merge(
125 [ 'temp_rev_user' => 'revision_actor_temp' ],
128 $revQuery['joins']['revision'] = $revQuery['joins']['temp_rev_user'];
129 unset( $revQuery['joins']['temp_rev_user'] );
132 $this->addTables( $revQuery['tables'] );
133 $this->addFields( $revQuery['fields'] );
134 $this->addJoinConds( $revQuery['joins'] );
136 // Seems to be needed to avoid a planner bug (T113901)
137 $this->addOption( 'STRAIGHT_JOIN' );
139 $dir = $params['dir'];
140 $this->addTimestampWhereRange( $tsField, $dir, $params['start'], $params['end'] );
142 if ( $this->fld_tags
) {
143 $this->addTables( 'tag_summary' );
145 [ 'tag_summary' => [ 'LEFT JOIN', [ 'rev_id=ts_rev_id' ] ] ]
147 $this->addFields( 'ts_tags' );
150 if ( $params['user'] !== null ) {
151 $actorQuery = ActorMigration
::newMigration()
152 ->getWhere( $db, 'rev_user', User
::newFromName( $params['user'], false ) );
153 $this->addWhere( $actorQuery['conds'] );
154 } elseif ( $params['excludeuser'] !== null ) {
155 $actorQuery = ActorMigration
::newMigration()
156 ->getWhere( $db, 'rev_user', User
::newFromName( $params['excludeuser'], false ) );
157 $this->addWhere( 'NOT(' . $actorQuery['conds'] . ')' );
160 if ( $params['user'] !== null ||
$params['excludeuser'] !== null ) {
161 // Paranoia: avoid brute force searches (T19342)
162 if ( !$this->getUser()->isAllowed( 'deletedhistory' ) ) {
163 $bitmask = RevisionRecord
::DELETED_USER
;
164 } elseif ( !$this->getUser()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
165 $bitmask = RevisionRecord
::DELETED_USER | RevisionRecord
::DELETED_RESTRICTED
;
170 $this->addWhere( $db->bitAnd( 'rev_deleted', $bitmask ) . " != $bitmask" );
174 if ( $params['continue'] !== null ) {
175 $op = ( $dir == 'newer' ?
'>' : '<' );
176 $cont = explode( '|', $params['continue'] );
177 $this->dieContinueUsageIf( count( $cont ) != 2 );
178 $ts = $db->addQuotes( $db->timestamp( $cont[0] ) );
179 $rev_id = (int)$cont[1];
180 $this->dieContinueUsageIf( strval( $rev_id ) !== $cont[1] );
181 $this->addWhere( "$tsField $op $ts OR " .
182 "($tsField = $ts AND " .
183 "$idField $op= $rev_id)" );
186 $this->addOption( 'LIMIT', $this->limit +
1 );
188 $sort = ( $dir == 'newer' ?
'' : ' DESC' );
190 // Targeting index rev_timestamp, user_timestamp, usertext_timestamp, or actor_timestamp.
191 // But 'user' is always constant for the latter three, so it doesn't matter here.
192 $orderby[] = "rev_timestamp $sort";
193 $orderby[] = "rev_id $sort";
194 $this->addOption( 'ORDER BY', $orderby );
197 $res = $this->select( __METHOD__
, [], $hookData );
198 $pageMap = []; // Maps rev_page to array index
202 foreach ( $res as $row ) {
203 if ( $count === 0 && $resultPageSet !== null ) {
204 // Set the non-continue since the list of all revisions is
205 // prone to having entries added at the start frequently.
206 $this->getContinuationManager()->addGeneratorNonContinueParam(
207 $this, 'continue', "$row->rev_timestamp|$row->rev_id"
210 if ( ++
$count > $this->limit
) {
212 $this->setContinueEnumParameter( 'continue', "$row->rev_timestamp|$row->rev_id" );
216 // Miser mode namespace check
217 if ( $miser_ns !== null && !in_array( $row->page_namespace
, $miser_ns ) ) {
221 if ( $resultPageSet !== null ) {
222 if ( $params['generatetitles'] ) {
223 $generated[$row->rev_page
] = $row->rev_page
;
225 $generated[] = $row->rev_id
;
228 $revision = $revisionStore->newRevisionFromRow( $row );
229 $rev = $this->extractRevisionInfo( $revision, $row );
231 if ( !isset( $pageMap[$row->rev_page
] ) ) {
232 $index = $nextIndex++
;
233 $pageMap[$row->rev_page
] = $index;
234 $title = Title
::newFromLinkTarget( $revision->getPageAsLinkTarget() );
236 'pageid' => $title->getArticleID(),
237 'revisions' => [ $rev ],
239 ApiResult
::setIndexedTagName( $a['revisions'], 'rev' );
240 ApiQueryBase
::addTitleInfo( $a, $title );
241 $fit = $this->processRow( $row, $a['revisions'][0], $hookData ) &&
242 $result->addValue( [ 'query', $this->getModuleName() ], $index, $a );
244 $index = $pageMap[$row->rev_page
];
245 $fit = $this->processRow( $row, $rev, $hookData ) &&
246 $result->addValue( [ 'query', $this->getModuleName(), $index, 'revisions' ], null, $rev );
249 $this->setContinueEnumParameter( 'continue', "$row->rev_timestamp|$row->rev_id" );
255 if ( $resultPageSet !== null ) {
256 if ( $params['generatetitles'] ) {
257 $resultPageSet->populateFromPageIDs( $generated );
259 $resultPageSet->populateFromRevisionIDs( $generated );
262 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
266 public function getAllowedParams() {
267 $ret = parent
::getAllowedParams() +
[
269 ApiBase
::PARAM_TYPE
=> 'user',
272 ApiBase
::PARAM_ISMULTI
=> true,
273 ApiBase
::PARAM_TYPE
=> 'namespace',
274 ApiBase
::PARAM_DFLT
=> null,
277 ApiBase
::PARAM_TYPE
=> 'timestamp',
280 ApiBase
::PARAM_TYPE
=> 'timestamp',
283 ApiBase
::PARAM_TYPE
=> [
287 ApiBase
::PARAM_DFLT
=> 'older',
288 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-direction',
291 ApiBase
::PARAM_TYPE
=> 'user',
294 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
296 'generatetitles' => [
297 ApiBase
::PARAM_DFLT
=> false,
301 if ( $this->getConfig()->get( 'MiserMode' ) ) {
302 $ret['namespace'][ApiBase
::PARAM_HELP_MSG_APPEND
] = [
303 'api-help-param-limited-in-miser-mode',
310 protected function getExamplesMessages() {
312 'action=query&list=allrevisions&arvuser=Example&arvlimit=50'
313 => 'apihelp-query+allrevisions-example-user',
314 'action=query&list=allrevisions&arvdir=newer&arvlimit=50'
315 => 'apihelp-query+allrevisions-example-ns-main',
319 public function getHelpUrls() {
320 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allrevisions';