5 * Created on Oct 19, 2006
7 * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
27 if ( !defined( 'MEDIAWIKI' ) ) {
28 // Eclipse helper - will be ignored in production
29 require_once( 'ApiQueryBase.php' );
33 * A query action to enumerate the recent changes that were done to the wiki.
34 * Various filters are supported.
38 class ApiQueryRecentChanges
extends ApiQueryGeneratorBase
{
40 public function __construct( $query, $moduleName ) {
41 parent
::__construct( $query, $moduleName, 'rc' );
44 private $fld_comment = false, $fld_parsedcomment = false, $fld_user = false, $fld_userid = false,
45 $fld_flags = false, $fld_timestamp = false, $fld_title = false, $fld_ids = false,
46 $fld_sizes = false, $fld_redirect = false, $fld_patrolled = false, $fld_loginfo = false,
47 $fld_tags = false, $token = array();
49 private $tokenFunctions;
52 * Get an array mapping token names to their handler functions.
53 * The prototype for a token function is func($pageid, $title, $rc)
54 * it should return a token or false (permission denied)
55 * @return array(tokenname => function)
57 protected function getTokenFunctions() {
58 // Don't call the hooks twice
59 if ( isset( $this->tokenFunctions
) ) {
60 return $this->tokenFunctions
;
63 // If we're in JSON callback mode, no tokens can be obtained
64 if ( !is_null( $this->getMain()->getRequest()->getVal( 'callback' ) ) ) {
68 $this->tokenFunctions
= array(
69 'patrol' => array( 'ApiQueryRecentChanges', 'getPatrolToken' )
71 wfRunHooks( 'APIQueryRecentChangesTokens', array( &$this->tokenFunctions
) );
72 return $this->tokenFunctions
;
78 * @param $rc RecentChange
81 public static function getPatrolToken( $pageid, $title, $rc ) {
83 if ( !$wgUser->useRCPatrol() && ( !$wgUser->useNPPatrol() ||
84 $rc->getAttribute( 'rc_type' ) != RC_NEW
) )
89 // The patrol token is always the same, let's exploit that
90 static $cachedPatrolToken = null;
91 if ( is_null( $cachedPatrolToken ) ) {
92 $cachedPatrolToken = $wgUser->editToken( 'patrol' );
95 return $cachedPatrolToken;
99 * Sets internal state to include the desired properties in the output.
100 * @param $prop Array associative array of properties, only keys are used here
102 public function initProperties( $prop ) {
103 $this->fld_comment
= isset( $prop['comment'] );
104 $this->fld_parsedcomment
= isset( $prop['parsedcomment'] );
105 $this->fld_user
= isset( $prop['user'] );
106 $this->fld_userid
= isset( $prop['userid'] );
107 $this->fld_flags
= isset( $prop['flags'] );
108 $this->fld_timestamp
= isset( $prop['timestamp'] );
109 $this->fld_title
= isset( $prop['title'] );
110 $this->fld_ids
= isset( $prop['ids'] );
111 $this->fld_sizes
= isset( $prop['sizes'] );
112 $this->fld_redirect
= isset( $prop['redirect'] );
113 $this->fld_patrolled
= isset( $prop['patrolled'] );
114 $this->fld_loginfo
= isset( $prop['loginfo'] );
115 $this->fld_tags
= isset( $prop['tags'] );
118 public function execute() {
122 public function executeGenerator( $resultPageSet ) {
123 $this->run( $resultPageSet );
127 * Generates and outputs the result of this query based upon the provided parameters.
129 * @param $resultPageSet ApiPageSet
131 public function run( $resultPageSet = null ) {
133 /* Get the parameters of the request. */
134 $params = $this->extractRequestParams();
136 /* Build our basic query. Namely, something along the lines of:
137 * SELECT * FROM recentchanges WHERE rc_timestamp > $start
138 * AND rc_timestamp < $end AND rc_namespace = $namespace
139 * AND rc_deleted = '0'
141 $this->addTables( 'recentchanges' );
142 $index = array( 'recentchanges' => 'rc_timestamp' ); // May change
143 $this->addWhereRange( 'rc_timestamp', $params['dir'], $params['start'], $params['end'] );
144 $this->addWhereFld( 'rc_namespace', $params['namespace'] );
145 $this->addWhereFld( 'rc_deleted', 0 );
147 if ( !is_null( $params['type'] ) ) {
148 $this->addWhereFld( 'rc_type', $this->parseRCType( $params['type'] ) );
151 if ( !is_null( $params['show'] ) ) {
152 $show = array_flip( $params['show'] );
154 /* Check for conflicting parameters. */
155 if ( ( isset( $show['minor'] ) && isset( $show['!minor'] ) )
156 ||
( isset( $show['bot'] ) && isset( $show['!bot'] ) )
157 ||
( isset( $show['anon'] ) && isset( $show['!anon'] ) )
158 ||
( isset( $show['redirect'] ) && isset( $show['!redirect'] ) )
159 ||
( isset( $show['patrolled'] ) && isset( $show['!patrolled'] ) )
161 $this->dieUsageMsg( array( 'show' ) );
165 if ( isset( $show['patrolled'] ) ||
isset( $show['!patrolled'] ) ) {
166 if ( !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol() ) {
167 $this->dieUsage( 'You need the patrol right to request the patrolled flag', 'permissiondenied' );
171 /* Add additional conditions to query depending upon parameters. */
172 $this->addWhereIf( 'rc_minor = 0', isset( $show['!minor'] ) );
173 $this->addWhereIf( 'rc_minor != 0', isset( $show['minor'] ) );
174 $this->addWhereIf( 'rc_bot = 0', isset( $show['!bot'] ) );
175 $this->addWhereIf( 'rc_bot != 0', isset( $show['bot'] ) );
176 $this->addWhereIf( 'rc_user = 0', isset( $show['anon'] ) );
177 $this->addWhereIf( 'rc_user != 0', isset( $show['!anon'] ) );
178 $this->addWhereIf( 'rc_patrolled = 0', isset( $show['!patrolled'] ) );
179 $this->addWhereIf( 'rc_patrolled != 0', isset( $show['patrolled'] ) );
180 $this->addWhereIf( 'page_is_redirect = 1', isset( $show['redirect'] ) );
182 // Don't throw log entries out the window here
183 $this->addWhereIf( 'page_is_redirect = 0 OR page_is_redirect IS NULL', isset( $show['!redirect'] ) );
186 if ( !is_null( $params['user'] ) && !is_null( $params['excludeuser'] ) ) {
187 $this->dieUsage( 'user and excludeuser cannot be used together', 'user-excludeuser' );
190 if ( !is_null( $params['user'] ) ) {
191 $this->addWhereFld( 'rc_user_text', $params['user'] );
192 $index['recentchanges'] = 'rc_user_text';
195 if ( !is_null( $params['excludeuser'] ) ) {
196 // We don't use the rc_user_text index here because
197 // * it would require us to sort by rc_user_text before rc_timestamp
198 // * the != condition doesn't throw out too many rows anyway
199 $this->addWhere( 'rc_user_text != ' . $this->getDB()->addQuotes( $params['excludeuser'] ) );
202 /* Add the fields we're concerned with to our query. */
203 $this->addFields( array(
214 $showRedirects = false;
215 /* Determine what properties we need to display. */
216 if ( !is_null( $params['prop'] ) ) {
217 $prop = array_flip( $params['prop'] );
219 /* Set up internal members based upon params. */
220 $this->initProperties( $prop );
222 if ( $this->fld_patrolled
&& !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol() ) {
223 $this->dieUsage( 'You need the patrol right to request the patrolled flag', 'permissiondenied' );
226 /* Add fields to our query if they are specified as a needed parameter. */
227 $this->addFieldsIf( 'rc_id', $this->fld_ids
);
228 $this->addFieldsIf( 'rc_this_oldid', $this->fld_ids
);
229 $this->addFieldsIf( 'rc_last_oldid', $this->fld_ids
);
230 $this->addFieldsIf( 'rc_comment', $this->fld_comment ||
$this->fld_parsedcomment
);
231 $this->addFieldsIf( 'rc_user', $this->fld_user
);
232 $this->addFieldsIf( 'rc_user_text', $this->fld_user ||
$this->fld_userid
);
233 $this->addFieldsIf( 'rc_minor', $this->fld_flags
);
234 $this->addFieldsIf( 'rc_bot', $this->fld_flags
);
235 $this->addFieldsIf( 'rc_new', $this->fld_flags
);
236 $this->addFieldsIf( 'rc_old_len', $this->fld_sizes
);
237 $this->addFieldsIf( 'rc_new_len', $this->fld_sizes
);
238 $this->addFieldsIf( 'rc_patrolled', $this->fld_patrolled
);
239 $this->addFieldsIf( 'rc_logid', $this->fld_loginfo
);
240 $this->addFieldsIf( 'rc_log_type', $this->fld_loginfo
);
241 $this->addFieldsIf( 'rc_log_action', $this->fld_loginfo
);
242 $this->addFieldsIf( 'rc_params', $this->fld_loginfo
);
243 $showRedirects = $this->fld_redirect ||
isset( $show['redirect'] ) ||
isset( $show['!redirect'] );
246 if ( $this->fld_tags
) {
247 $this->addTables( 'tag_summary' );
248 $this->addJoinConds( array( 'tag_summary' => array( 'LEFT JOIN', array( 'rc_id=ts_rc_id' ) ) ) );
249 $this->addFields( 'ts_tags' );
252 if ( $params['toponly'] ||
$showRedirects ) {
253 $this->addTables( 'page' );
254 $this->addJoinConds( array( 'page' => array( 'LEFT JOIN', array( 'rc_namespace=page_namespace', 'rc_title=page_title' ) ) ) );
256 if ( $params['toponly'] ) {
257 $this->addWhere( 'rc_this_oldid = page_latest' );
261 if ( !is_null( $params['tag'] ) ) {
262 $this->addTables( 'change_tag' );
263 $this->addJoinConds( array( 'change_tag' => array( 'INNER JOIN', array( 'rc_id=ct_rc_id' ) ) ) );
264 $this->addWhereFld( 'ct_tag' , $params['tag'] );
265 global $wgOldChangeTagsIndex;
266 $index['change_tag'] = $wgOldChangeTagsIndex ?
'ct_tag' : 'change_tag_tag_id';
269 $this->token
= $params['token'];
270 $this->addOption( 'LIMIT', $params['limit'] +
1 );
271 $this->addOption( 'USE INDEX', $index );
274 /* Perform the actual query. */
275 $res = $this->select( __METHOD__
);
279 /* Iterate through the rows, adding data extracted from them to our query result. */
280 foreach ( $res as $row ) {
281 if ( ++
$count > $params['limit'] ) {
282 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
283 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->rc_timestamp
) );
287 if ( is_null( $resultPageSet ) ) {
288 /* Extract the data from a single row. */
289 $vals = $this->extractRowInfo( $row );
291 /* Add that row's data to our final output. */
295 $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ), null, $vals );
297 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->rc_timestamp
) );
301 $titles[] = Title
::makeTitle( $row->rc_namespace
, $row->rc_title
);
305 if ( is_null( $resultPageSet ) ) {
306 /* Format the result */
307 $this->getResult()->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'rc' );
309 $resultPageSet->populateFromTitles( $titles );
314 * Extracts from a single sql row the data needed to describe one recent change.
316 * @param $row The row from which to extract the data.
317 * @return An array mapping strings (descriptors) to their respective string values.
320 public function extractRowInfo( $row ) {
321 /* If page was moved somewhere, get the title of the move target. */
322 $movedToTitle = false;
323 if ( isset( $row->rc_moved_to_title
) && $row->rc_moved_to_title
!== '' ) {
324 $movedToTitle = Title
::makeTitle( $row->rc_moved_to_ns
, $row->rc_moved_to_title
);
327 /* Determine the title of the page that has been changed. */
328 $title = Title
::makeTitle( $row->rc_namespace
, $row->rc_title
);
330 /* Our output data. */
333 $type = intval( $row->rc_type
);
335 /* Determine what kind of change this was. */
338 $vals['type'] = 'edit';
341 $vals['type'] = 'new';
344 $vals['type'] = 'move';
347 $vals['type'] = 'log';
349 case RC_MOVE_OVER_REDIRECT
:
350 $vals['type'] = 'move over redirect';
353 $vals['type'] = $type;
356 /* Create a new entry in the result for the title. */
357 if ( $this->fld_title
) {
358 ApiQueryBase
::addTitleInfo( $vals, $title );
359 if ( $movedToTitle ) {
360 ApiQueryBase
::addTitleInfo( $vals, $movedToTitle, 'new_' );
364 /* Add ids, such as rcid, pageid, revid, and oldid to the change's info. */
365 if ( $this->fld_ids
) {
366 $vals['rcid'] = intval( $row->rc_id
);
367 $vals['pageid'] = intval( $row->rc_cur_id
);
368 $vals['revid'] = intval( $row->rc_this_oldid
);
369 $vals['old_revid'] = intval( $row->rc_last_oldid
);
372 /* Add user data and 'anon' flag, if use is anonymous. */
373 if ( $this->fld_user ||
$this->fld_userid
) {
375 if ( $this->fld_user
) {
376 $vals['user'] = $row->rc_user_text
;
379 if ( $this->fld_userid
) {
380 $vals['userid'] = $row->rc_user
;
383 if ( !$row->rc_user
) {
388 /* Add flags, such as new, minor, bot. */
389 if ( $this->fld_flags
) {
390 if ( $row->rc_bot
) {
393 if ( $row->rc_new
) {
396 if ( $row->rc_minor
) {
401 /* Add sizes of each revision. (Only available on 1.10+) */
402 if ( $this->fld_sizes
) {
403 $vals['oldlen'] = intval( $row->rc_old_len
);
404 $vals['newlen'] = intval( $row->rc_new_len
);
407 /* Add the timestamp. */
408 if ( $this->fld_timestamp
) {
409 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->rc_timestamp
);
412 /* Add edit summary / log summary. */
413 if ( $this->fld_comment
&& isset( $row->rc_comment
) ) {
414 $vals['comment'] = $row->rc_comment
;
417 if ( $this->fld_parsedcomment
&& isset( $row->rc_comment
) ) {
419 $vals['parsedcomment'] = $wgUser->getSkin()->formatComment( $row->rc_comment
, $title );
422 if ( $this->fld_redirect
) {
423 if ( $row->page_is_redirect
) {
424 $vals['redirect'] = '';
428 /* Add the patrolled flag */
429 if ( $this->fld_patrolled
&& $row->rc_patrolled
== 1 ) {
430 $vals['patrolled'] = '';
433 if ( $this->fld_loginfo
&& $row->rc_type
== RC_LOG
) {
434 $vals['logid'] = intval( $row->rc_logid
);
435 $vals['logtype'] = $row->rc_log_type
;
436 $vals['logaction'] = $row->rc_log_action
;
437 ApiQueryLogEvents
::addLogParams(
439 $vals, $row->rc_params
,
440 $row->rc_log_type
, $row->rc_timestamp
444 if ( $this->fld_tags
) {
445 if ( $row->ts_tags
) {
446 $tags = explode( ',', $row->ts_tags
);
447 $this->getResult()->setIndexedTagName( $tags, 'tag' );
448 $vals['tags'] = $tags;
450 $vals['tags'] = array();
454 if ( !is_null( $this->token
) ) {
455 $tokenFunctions = $this->getTokenFunctions();
456 foreach ( $this->token
as $t ) {
457 $val = call_user_func( $tokenFunctions[$t], $row->rc_cur_id
,
458 $title, RecentChange
::newFromRow( $row ) );
459 if ( $val === false ) {
460 $this->setWarning( "Action '$t' is not allowed for the current user" );
462 $vals[$t . 'token'] = $val;
470 private function parseRCType( $type ) {
471 if ( is_array( $type ) ) {
473 foreach ( $type as $t ) {
474 $retval[] = $this->parseRCType( $t );
488 public function getCacheMode( $params ) {
489 if ( isset( $params['show'] ) ) {
490 foreach ( $params['show'] as $show ) {
491 if ( $show === 'patrolled' ||
$show === '!patrolled' ) {
496 if ( isset( $params['token'] ) ) {
499 if ( !is_null( $params['prop'] ) && in_array( 'parsedcomment', $params['prop'] ) ) {
500 // formatComment() calls wfMsg() among other things
501 return 'anon-public-user-private';
506 public function getAllowedParams() {
509 ApiBase
::PARAM_TYPE
=> 'timestamp'
512 ApiBase
::PARAM_TYPE
=> 'timestamp'
515 ApiBase
::PARAM_DFLT
=> 'older',
516 ApiBase
::PARAM_TYPE
=> array(
521 'namespace' => array(
522 ApiBase
::PARAM_ISMULTI
=> true,
523 ApiBase
::PARAM_TYPE
=> 'namespace'
526 ApiBase
::PARAM_TYPE
=> 'user'
528 'excludeuser' => array(
529 ApiBase
::PARAM_TYPE
=> 'user'
533 ApiBase
::PARAM_ISMULTI
=> true,
534 ApiBase
::PARAM_DFLT
=> 'title|timestamp|ids',
535 ApiBase
::PARAM_TYPE
=> array(
552 ApiBase
::PARAM_TYPE
=> array_keys( $this->getTokenFunctions() ),
553 ApiBase
::PARAM_ISMULTI
=> true
556 ApiBase
::PARAM_ISMULTI
=> true,
557 ApiBase
::PARAM_TYPE
=> array(
571 ApiBase
::PARAM_DFLT
=> 10,
572 ApiBase
::PARAM_TYPE
=> 'limit',
573 ApiBase
::PARAM_MIN
=> 1,
574 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
575 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
578 ApiBase
::PARAM_ISMULTI
=> true,
579 ApiBase
::PARAM_TYPE
=> array(
589 public function getParamDescription() {
590 $p = $this->getModulePrefix();
592 'start' => 'The timestamp to start enumerating from',
593 'end' => 'The timestamp to end enumerating',
594 'dir' => $this->getDirectionDescription( $p ),
595 'namespace' => 'Filter log entries to only this namespace(s)',
596 'user' => 'Only list changes by this user',
597 'excludeuser' => 'Don\'t list changes by this user',
599 'Include additional pieces of information',
600 ' user - Adds the user responsible for the edit and tags if they are an IP',
601 ' userid - Adds the user id responsible for the edit',
602 ' comment - Adds the comment for the edit',
603 ' parsedcomment - Adds the parsed comment for the edit',
604 ' flags - Adds flags for the edit',
605 ' timestamp - Adds timestamp of the edit',
606 ' title - Adds the page title of the edit',
607 ' ids - Adds the page ID, recent changes ID and the new and old revision ID',
608 ' sizes - Adds the new and old page length in bytes',
609 ' redirect - Tags edit if page is a redirect',
610 ' patrolled - Tags edits that have been patrolled',
611 ' loginfo - Adds log information (logid, logtype, etc) to log entries',
612 ' tags - Lists tags for the entry',
614 'token' => 'Which tokens to obtain for each change',
616 'Show only items that meet this criteria.',
617 "For example, to see only minor edits done by logged-in users, set {$p}show=minor|!anon"
619 'type' => 'Which types of changes to show',
620 'limit' => 'How many total changes to return',
621 'tag' => 'Only list changes tagged with this tag',
622 'toponly' => 'Only list changes which are the latest revision',
626 public function getDescription() {
627 return 'Enumerate recent changes';
630 public function getPossibleErrors() {
631 return array_merge( parent
::getPossibleErrors(), array(
633 array( 'code' => 'permissiondenied', 'info' => 'You need the patrol right to request the patrolled flag' ),
634 array( 'code' => 'user-excludeuser', 'info' => 'user and excludeuser cannot be used together' ),
638 protected function getExamples() {
640 'api.php?action=query&list=recentchanges'
644 public function getVersion() {
645 return __CLASS__
. ': $Id$';