3 * Created on Sep 27, 2015
5 * Copyright © 2015 Brad Jorsch "bjorsch@wikimedia.org"
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 * http://www.gnu.org/copyleft/gpl.html
26 * Query module to enumerate all revisions.
31 class ApiQueryAllRevisions
extends ApiQueryRevisionsBase
{
33 public function __construct( ApiQuery
$query, $moduleName ) {
34 parent
::__construct( $query, $moduleName, 'arv' );
38 * @param ApiPageSet $resultPageSet
41 protected function run( ApiPageSet
$resultPageSet = null ) {
43 $params = $this->extractRequestParams( false );
45 $result = $this->getResult();
47 $this->requireMaxOneParameter( $params, 'user', 'excludeuser' );
49 // Namespace check is likely to be desired, but can't be done
50 // efficiently in SQL.
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'];
61 $this->addWhere( array( 'page_namespace' => $params['namespace'] ) );
66 $this->addTables( 'revision' );
67 if ( $resultPageSet === null ) {
68 $this->parseParameters( $params );
69 $this->addTables( 'page' );
71 array( 'page' => array( 'INNER JOIN', array( 'rev_page = page_id' ) ) )
73 $this->addFields( Revision
::selectFields() );
74 $this->addFields( Revision
::selectPageFields() );
76 // Review this depeneding on the outcome of T113901
77 $this->addOption( 'STRAIGHT_JOIN' );
79 $this->limit
= $this->getParameter( 'limit' ) ?
: 10;
80 $this->addFields( array( 'rev_timestamp', 'rev_id' ) );
81 if ( $params['generatetitles'] ) {
82 $this->addFields( array( 'rev_page' ) );
85 if ( $needPageTable ) {
86 $this->addTables( 'page' );
88 array( 'page' => array( 'INNER JOIN', array( 'rev_page = page_id' ) ) )
90 $this->addFieldsIf( array( 'page_namespace' ), (bool)$miser_ns );
92 // Review this depeneding on the outcome of T113901
93 $this->addOption( 'STRAIGHT_JOIN' );
97 if ( $this->fld_tags
) {
98 $this->addTables( 'tag_summary' );
100 array( 'tag_summary' => array( 'LEFT JOIN', array( 'rev_id=ts_rev_id' ) ) )
102 $this->addFields( 'ts_tags' );
105 if ( $this->fetchContent
) {
106 $this->addTables( 'text' );
108 array( 'text' => array( 'INNER JOIN', array( 'rev_text_id=old_id' ) ) )
110 $this->addFields( 'old_id' );
111 $this->addFields( Revision
::selectTextFields() );
114 if ( $params['user'] !== null ) {
115 $id = User
::idFromName( $params['user'] );
117 $this->addWhereFld( 'rev_user', $id );
119 $this->addWhereFld( 'rev_user_text', $params['user'] );
121 } elseif ( $params['excludeuser'] !== null ) {
122 $id = User
::idFromName( $params['excludeuser'] );
124 $this->addWhere( 'rev_user != ' . $id );
126 $this->addWhere( 'rev_user_text != ' . $db->addQuotes( $params['excludeuser'] ) );
130 if ( $params['user'] !== null ||
$params['excludeuser'] !== null ) {
131 // Paranoia: avoid brute force searches (bug 17342)
132 if ( !$this->getUser()->isAllowed( 'deletedhistory' ) ) {
133 $bitmask = Revision
::DELETED_USER
;
134 } elseif ( !$this->getUser()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
135 $bitmask = Revision
::DELETED_USER | Revision
::DELETED_RESTRICTED
;
140 $this->addWhere( $db->bitAnd( 'rev_deleted', $bitmask ) . " != $bitmask" );
144 $dir = $params['dir'];
146 if ( $params['continue'] !== null ) {
147 $op = ( $dir == 'newer' ?
'>' : '<' );
148 $cont = explode( '|', $params['continue'] );
149 $this->dieContinueUsageIf( count( $cont ) != 2 );
150 $ts = $db->addQuotes( $db->timestamp( $cont[0] ) );
151 $rev_id = (int)$cont[1];
152 $this->dieContinueUsageIf( strval( $rev_id ) !== $cont[1] );
153 $this->addWhere( "rev_timestamp $op $ts OR " .
154 "(rev_timestamp = $ts AND " .
155 "rev_id $op= $rev_id)" );
158 $this->addOption( 'LIMIT', $this->limit +
1 );
160 $sort = ( $dir == 'newer' ?
'' : ' DESC' );
162 // Targeting index rev_timestamp, user_timestamp, or usertext_timestamp
163 // But 'user' is always constant for the latter two, so it doesn't matter here.
164 $orderby[] = "rev_timestamp $sort";
165 $orderby[] = "rev_id $sort";
166 $this->addOption( 'ORDER BY', $orderby );
168 $res = $this->select( __METHOD__
);
169 $pageMap = array(); // Maps rev_page to array index
172 $generated = array();
173 foreach ( $res as $row ) {
174 if ( ++
$count > $this->limit
) {
176 $this->setContinueEnumParameter( 'continue', "$row->rev_timestamp|$row->rev_id" );
180 // Miser mode namespace check
181 if ( $miser_ns !== null && !in_array( $row->page_namespace
, $miser_ns ) ) {
185 if ( $resultPageSet !== null ) {
186 if ( $params['generatetitles'] ) {
187 $generated[$row->rev_page
] = $row->rev_page
;
189 $generated[] = $row->rev_id
;
192 $revision = Revision
::newFromRow( $row );
193 $rev = $this->extractRevisionInfo( $revision, $row );
195 if ( !isset( $pageMap[$row->rev_page
] ) ) {
196 $index = $nextIndex++
;
197 $pageMap[$row->rev_page
] = $index;
198 $title = $revision->getTitle();
200 'pageid' => $title->getArticleID(),
201 'revisions' => array( $rev ),
203 ApiResult
::setIndexedTagName( $a['revisions'], 'rev' );
204 ApiQueryBase
::addTitleInfo( $a, $title );
205 $fit = $result->addValue( array( 'query', $this->getModuleName() ), $index, $a );
207 $index = $pageMap[$row->rev_page
];
208 $fit = $result->addValue(
209 array( 'query', $this->getModuleName(), $index, 'revisions' ),
213 $this->setContinueEnumParameter( 'continue', "$row->rev_timestamp|$row->rev_id" );
219 if ( $resultPageSet !== null ) {
220 if ( $params['generatetitles'] ) {
221 $resultPageSet->populateFromPageIDs( $generated );
223 $resultPageSet->populateFromRevisionIDs( $generated );
226 $result->addIndexedTagName( array( 'query', $this->getModuleName() ), 'page' );
230 public function getAllowedParams() {
231 $ret = parent
::getAllowedParams() +
array(
233 ApiBase
::PARAM_TYPE
=> 'user',
235 'namespace' => array(
236 ApiBase
::PARAM_ISMULTI
=> true,
237 ApiBase
::PARAM_TYPE
=> 'namespace',
238 ApiBase
::PARAM_DFLT
=> null,
241 ApiBase
::PARAM_TYPE
=> 'timestamp',
244 ApiBase
::PARAM_TYPE
=> 'timestamp',
247 ApiBase
::PARAM_TYPE
=> array(
251 ApiBase
::PARAM_DFLT
=> 'older',
252 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-direction',
254 'excludeuser' => array(
255 ApiBase
::PARAM_TYPE
=> 'user',
258 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
260 'generatetitles' => array(
261 ApiBase
::PARAM_DFLT
=> false,
265 if ( $this->getConfig()->get( 'MiserMode' ) ) {
266 $ret['namespace'][ApiBase
::PARAM_HELP_MSG_APPEND
] = array(
267 'api-help-param-limited-in-miser-mode',
274 protected function getExamplesMessages() {
276 'action=query&list=allrevisions&arvuser=Example&arvlimit=50'
277 => 'apihelp-query+allrevisions-example-user',
278 'action=query&list=allrevisions&arvdir=newer&arvlimit=50'
279 => 'apihelp-query+allrevisions-example-ns-main',
283 public function getHelpUrls() {
284 return 'https://www.mediawiki.org/wiki/API:Allrevisions';