4 * Created on Oct 19, 2006
6 * API for MediaWiki 1.8+
8 * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if ( !defined( 'MEDIAWIKI' ) ) {
27 // Eclipse helper - will be ignored in production
28 require_once( 'ApiQueryBase.php' );
32 * A query action to enumerate the recent changes that were done to the wiki.
33 * Various filters are supported.
37 class ApiQueryRecentChanges
extends ApiQueryBase
{
39 public function __construct( $query, $moduleName ) {
40 parent
::__construct( $query, $moduleName, 'rc' );
43 private $fld_comment = false, $fld_parsedcomment = false, $fld_user = false, $fld_flags = false,
44 $fld_timestamp = false, $fld_title = false, $fld_ids = false,
47 * Get an array mapping token names to their handler functions.
48 * The prototype for a token function is func($pageid, $title, $rc)
49 * it should return a token or false (permission denied)
50 * @return array(tokenname => function)
52 protected function getTokenFunctions() {
53 // Don't call the hooks twice
54 if ( isset( $this->tokenFunctions
) ) {
55 return $this->tokenFunctions
;
58 // If we're in JSON callback mode, no tokens can be obtained
59 if ( !is_null( $this->getMain()->getRequest()->getVal( 'callback' ) ) ) {
63 $this->tokenFunctions
= array(
64 'patrol' => array( 'ApiQueryRecentChanges', 'getPatrolToken' )
66 wfRunHooks( 'APIQueryRecentChangesTokens', array( &$this->tokenFunctions
) );
67 return $this->tokenFunctions
;
70 public static function getPatrolToken( $pageid, $title, $rc ) {
72 if ( !$wgUser->useRCPatrol() && ( !$wgUser->useNPPatrol() ||
73 $rc->getAttribute( 'rc_type' ) != RC_NEW
) )
78 // The patrol token is always the same, let's exploit that
79 static $cachedPatrolToken = null;
80 if ( !is_null( $cachedPatrolToken ) ) {
81 return $cachedPatrolToken;
84 $cachedPatrolToken = $wgUser->editToken();
85 return $cachedPatrolToken;
89 * Sets internal state to include the desired properties in the output.
90 * @param $prop associative array of properties, only keys are used here
92 public function initProperties( $prop ) {
93 $this->fld_comment
= isset( $prop['comment'] );
94 $this->fld_parsedcomment
= isset( $prop['parsedcomment'] );
95 $this->fld_user
= isset( $prop['user'] );
96 $this->fld_flags
= isset( $prop['flags'] );
97 $this->fld_timestamp
= isset( $prop['timestamp'] );
98 $this->fld_title
= isset( $prop['title'] );
99 $this->fld_ids
= isset( $prop['ids'] );
100 $this->fld_sizes
= isset( $prop['sizes'] );
101 $this->fld_redirect
= isset( $prop['redirect'] );
102 $this->fld_patrolled
= isset( $prop['patrolled'] );
103 $this->fld_loginfo
= isset( $prop['loginfo'] );
104 $this->fld_tags
= isset( $prop['tags'] );
108 * Generates and outputs the result of this query based upon the provided parameters.
110 public function execute() {
112 /* Get the parameters of the request. */
113 $params = $this->extractRequestParams();
115 /* Build our basic query. Namely, something along the lines of:
116 * SELECT * FROM recentchanges WHERE rc_timestamp > $start
117 * AND rc_timestamp < $end AND rc_namespace = $namespace
118 * AND rc_deleted = '0'
120 $this->addTables( 'recentchanges' );
121 $index = array( 'recentchanges' => 'rc_timestamp' ); // May change
122 $this->addWhereRange( 'rc_timestamp', $params['dir'], $params['start'], $params['end'] );
123 $this->addWhereFld( 'rc_namespace', $params['namespace'] );
124 $this->addWhereFld( 'rc_deleted', 0 );
126 if ( !is_null( $params['type'] ) ) {
127 $this->addWhereFld( 'rc_type', $this->parseRCType( $params['type'] ) );
130 if ( !is_null( $params['show'] ) ) {
131 $show = array_flip( $params['show'] );
133 /* Check for conflicting parameters. */
134 if ( ( isset( $show['minor'] ) && isset( $show['!minor'] ) )
135 ||
( isset( $show['bot'] ) && isset( $show['!bot'] ) )
136 ||
( isset( $show['anon'] ) && isset( $show['!anon'] ) )
137 ||
( isset( $show['redirect'] ) && isset( $show['!redirect'] ) )
138 ||
( isset( $show['patrolled'] ) && isset( $show['!patrolled'] ) )
141 $this->dieUsageMsg( array( 'show' ) );
145 if ( isset( $show['patrolled'] ) ||
isset( $show['!patrolled'] ) ) {
146 if ( !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol() ) {
147 $this->dieUsage( 'You need the patrol right to request the patrolled flag', 'permissiondenied' );
151 /* Add additional conditions to query depending upon parameters. */
152 $this->addWhereIf( 'rc_minor = 0', isset( $show['!minor'] ) );
153 $this->addWhereIf( 'rc_minor != 0', isset( $show['minor'] ) );
154 $this->addWhereIf( 'rc_bot = 0', isset( $show['!bot'] ) );
155 $this->addWhereIf( 'rc_bot != 0', isset( $show['bot'] ) );
156 $this->addWhereIf( 'rc_user = 0', isset( $show['anon'] ) );
157 $this->addWhereIf( 'rc_user != 0', isset( $show['!anon'] ) );
158 $this->addWhereIf( 'rc_patrolled = 0', isset( $show['!patrolled'] ) );
159 $this->addWhereIf( 'rc_patrolled != 0', isset( $show['patrolled'] ) );
160 $this->addWhereIf( 'page_is_redirect = 1', isset( $show['redirect'] ) );
162 // Don't throw log entries out the window here
163 $this->addWhereIf( 'page_is_redirect = 0 OR page_is_redirect IS NULL', isset( $show['!redirect'] ) );
166 if ( !is_null( $params['user'] ) && !is_null( $param['excludeuser'] ) ) {
167 $this->dieUsage( 'user and excludeuser cannot be used together', 'user-excludeuser' );
170 if ( !is_null( $params['user'] ) ) {
171 $this->addWhereFld( 'rc_user_text', $params['user'] );
172 $index['recentchanges'] = 'rc_user_text';
175 if ( !is_null( $params['excludeuser'] ) ) {
176 // We don't use the rc_user_text index here because
177 // * it would require us to sort by rc_user_text before rc_timestamp
178 // * the != condition doesn't throw out too many rows anyway
179 $this->addWhere( 'rc_user_text != ' . $this->getDB()->addQuotes( $params['excludeuser'] ) );
182 /* Add the fields we're concerned with to our query. */
183 $this->addFields( array(
193 /* Determine what properties we need to display. */
194 if ( !is_null( $params['prop'] ) ) {
195 $prop = array_flip( $params['prop'] );
197 /* Set up internal members based upon params. */
198 $this->initProperties( $prop );
200 if ( $this->fld_patrolled
&& !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol() )
202 $this->dieUsage( 'You need the patrol right to request the patrolled flag', 'permissiondenied' );
205 /* Add fields to our query if they are specified as a needed parameter. */
206 $this->addFieldsIf( 'rc_id', $this->fld_ids
);
207 $this->addFieldsIf( 'rc_this_oldid', $this->fld_ids
);
208 $this->addFieldsIf( 'rc_last_oldid', $this->fld_ids
);
209 $this->addFieldsIf( 'rc_comment', $this->fld_comment ||
$this->fld_parsedcomment
);
210 $this->addFieldsIf( 'rc_user', $this->fld_user
);
211 $this->addFieldsIf( 'rc_user_text', $this->fld_user
);
212 $this->addFieldsIf( 'rc_minor', $this->fld_flags
);
213 $this->addFieldsIf( 'rc_bot', $this->fld_flags
);
214 $this->addFieldsIf( 'rc_new', $this->fld_flags
);
215 $this->addFieldsIf( 'rc_old_len', $this->fld_sizes
);
216 $this->addFieldsIf( 'rc_new_len', $this->fld_sizes
);
217 $this->addFieldsIf( 'rc_patrolled', $this->fld_patrolled
);
218 $this->addFieldsIf( 'rc_logid', $this->fld_loginfo
);
219 $this->addFieldsIf( 'rc_log_type', $this->fld_loginfo
);
220 $this->addFieldsIf( 'rc_log_action', $this->fld_loginfo
);
221 $this->addFieldsIf( 'rc_params', $this->fld_loginfo
);
222 if ( $this->fld_redirect ||
isset( $show['redirect'] ) ||
isset( $show['!redirect'] ) )
224 $this->addTables( 'page' );
225 $this->addJoinConds( array( 'page' => array( 'LEFT JOIN', array( 'rc_namespace=page_namespace', 'rc_title=page_title' ) ) ) );
226 $this->addFields( 'page_is_redirect' );
230 if ( $this->fld_tags
) {
231 $this->addTables( 'tag_summary' );
232 $this->addJoinConds( array( 'tag_summary' => array( 'LEFT JOIN', array( 'rc_id=ts_rc_id' ) ) ) );
233 $this->addFields( 'ts_tags' );
236 if ( !is_null( $params['tag'] ) ) {
237 $this->addTables( 'change_tag' );
238 $this->addJoinConds( array( 'change_tag' => array( 'INNER JOIN', array( 'rc_id=ct_rc_id' ) ) ) );
239 $this->addWhereFld( 'ct_tag' , $params['tag'] );
240 global $wgOldChangeTagsIndex;
241 $index['change_tag'] = $wgOldChangeTagsIndex ?
'ct_tag' : 'change_tag_tag_id';
244 $this->token
= $params['token'];
245 $this->addOption( 'LIMIT', $params['limit'] +
1 );
246 $this->addOption( 'USE INDEX', $index );
249 /* Perform the actual query. */
250 $res = $this->select( __METHOD__
);
252 /* Iterate through the rows, adding data extracted from them to our query result. */
253 foreach ( $res as $row ) {
254 if ( ++
$count > $params['limit'] ) {
255 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
256 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->rc_timestamp
) );
260 /* Extract the data from a single row. */
261 $vals = $this->extractRowInfo( $row );
263 /* Add that row's data to our final output. */
267 $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ), null, $vals );
269 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->rc_timestamp
) );
274 /* Format the result */
275 $this->getResult()->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'rc' );
279 * Extracts from a single sql row the data needed to describe one recent change.
281 * @param $row The row from which to extract the data.
282 * @return An array mapping strings (descriptors) to their respective string values.
285 public function extractRowInfo( $row ) {
286 /* If page was moved somewhere, get the title of the move target. */
287 $movedToTitle = false;
288 if ( isset( $row->rc_moved_to_title
) && $row->rc_moved_to_title
!== '' )
290 $movedToTitle = Title
::makeTitle( $row->rc_moved_to_ns
, $row->rc_moved_to_title
);
293 /* Determine the title of the page that has been changed. */
294 $title = Title
::makeTitle( $row->rc_namespace
, $row->rc_title
);
296 /* Our output data. */
299 $type = intval( $row->rc_type
);
301 /* Determine what kind of change this was. */
304 $vals['type'] = 'edit';
307 $vals['type'] = 'new';
310 $vals['type'] = 'move';
313 $vals['type'] = 'log';
315 case RC_MOVE_OVER_REDIRECT
:
316 $vals['type'] = 'move over redirect';
319 $vals['type'] = $type;
322 /* Create a new entry in the result for the title. */
323 if ( $this->fld_title
) {
324 ApiQueryBase
::addTitleInfo( $vals, $title );
325 if ( $movedToTitle ) {
326 ApiQueryBase
::addTitleInfo( $vals, $movedToTitle, 'new_' );
330 /* Add ids, such as rcid, pageid, revid, and oldid to the change's info. */
331 if ( $this->fld_ids
) {
332 $vals['rcid'] = intval( $row->rc_id
);
333 $vals['pageid'] = intval( $row->rc_cur_id
);
334 $vals['revid'] = intval( $row->rc_this_oldid
);
335 $vals['old_revid'] = intval( $row->rc_last_oldid
);
338 /* Add user data and 'anon' flag, if use is anonymous. */
339 if ( $this->fld_user
) {
340 $vals['user'] = $row->rc_user_text
;
341 if ( !$row->rc_user
) {
346 /* Add flags, such as new, minor, bot. */
347 if ( $this->fld_flags
) {
348 if ( $row->rc_bot
) {
351 if ( $row->rc_new
) {
354 if ( $row->rc_minor
) {
359 /* Add sizes of each revision. (Only available on 1.10+) */
360 if ( $this->fld_sizes
) {
361 $vals['oldlen'] = intval( $row->rc_old_len
);
362 $vals['newlen'] = intval( $row->rc_new_len
);
365 /* Add the timestamp. */
366 if ( $this->fld_timestamp
) {
367 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->rc_timestamp
);
370 /* Add edit summary / log summary. */
371 if ( $this->fld_comment
&& isset( $row->rc_comment
) ) {
372 $vals['comment'] = $row->rc_comment
;
375 if ( $this->fld_parsedcomment
&& isset( $row->rc_comment
) ) {
377 $vals['parsedcomment'] = $wgUser->getSkin()->formatComment( $row->rc_comment
, $title );
380 if ( $this->fld_redirect
) {
381 if ( $row->page_is_redirect
) {
382 $vals['redirect'] = '';
386 /* Add the patrolled flag */
387 if ( $this->fld_patrolled
&& $row->rc_patrolled
== 1 ) {
388 $vals['patrolled'] = '';
391 if ( $this->fld_loginfo
&& $row->rc_type
== RC_LOG
) {
392 $vals['logid'] = intval( $row->rc_logid
);
393 $vals['logtype'] = $row->rc_log_type
;
394 $vals['logaction'] = $row->rc_log_action
;
395 ApiQueryLogEvents
::addLogParams(
397 $vals, $row->rc_params
,
398 $row->rc_log_type
, $row->rc_timestamp
402 if ( $this->fld_tags
) {
403 if ( $row->ts_tags
) {
404 $tags = explode( ',', $row->ts_tags
);
405 $this->getResult()->setIndexedTagName( $tags, 'tag' );
406 $vals['tags'] = $tags;
408 $vals['tags'] = array();
412 if ( !is_null( $this->token
) ) {
413 $tokenFunctions = $this->getTokenFunctions();
414 foreach ( $this->token
as $t ) {
415 $val = call_user_func( $tokenFunctions[$t], $row->rc_cur_id
,
416 $title, RecentChange
::newFromRow( $row ) );
417 if ( $val === false ) {
418 $this->setWarning( "Action '$t' is not allowed for the current user" );
420 $vals[$t . 'token'] = $val;
428 private function parseRCType( $type ) {
429 if ( is_array( $type ) ) {
431 foreach ( $type as $t ) {
432 $retval[] = $this->parseRCType( $t );
446 public function getCacheMode( $params ) {
447 if ( isset( $params['show'] ) ) {
448 foreach ( $params['show'] as $show ) {
449 if ( $show === 'patrolled' ||
$show === '!patrolled' ) {
454 if ( isset( $params['token'] ) ) {
457 if ( !is_null( $params['prop'] ) && in_array( 'parsedcomment', $params['prop'] ) ) {
458 // formatComment() calls wfMsg() among other things
459 return 'anon-public-user-private';
464 public function getAllowedParams() {
467 ApiBase
::PARAM_TYPE
=> 'timestamp'
470 ApiBase
::PARAM_TYPE
=> 'timestamp'
473 ApiBase
::PARAM_DFLT
=> 'older',
474 ApiBase
::PARAM_TYPE
=> array(
479 'namespace' => array(
480 ApiBase
::PARAM_ISMULTI
=> true,
481 ApiBase
::PARAM_TYPE
=> 'namespace'
484 ApiBase
::PARAM_TYPE
=> 'user'
486 'excludeuser' => array(
487 ApiBase
::PARAM_TYPE
=> 'user'
491 ApiBase
::PARAM_ISMULTI
=> true,
492 ApiBase
::PARAM_DFLT
=> 'title|timestamp|ids',
493 ApiBase
::PARAM_TYPE
=> array(
509 ApiBase
::PARAM_TYPE
=> array_keys( $this->getTokenFunctions() ),
510 ApiBase
::PARAM_ISMULTI
=> true
513 ApiBase
::PARAM_ISMULTI
=> true,
514 ApiBase
::PARAM_TYPE
=> array(
528 ApiBase
::PARAM_DFLT
=> 10,
529 ApiBase
::PARAM_TYPE
=> 'limit',
530 ApiBase
::PARAM_MIN
=> 1,
531 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
532 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
535 ApiBase
::PARAM_ISMULTI
=> true,
536 ApiBase
::PARAM_TYPE
=> array(
545 public function getParamDescription() {
547 'start' => 'The timestamp to start enumerating from',
548 'end' => 'The timestamp to end enumerating',
549 'dir' => 'In which direction to enumerate',
550 'namespace' => 'Filter log entries to only this namespace(s)',
551 'user' => 'Only list changes by this user',
552 'excludeuser' => 'Don\'t list changes by this user',
554 'Include additional pieces of information',
555 ' user - Adds the user responsible for the edit and tags if they are an IP',
556 ' comment - Adds the comment for the edit',
557 ' parsedcomment - Adds the parsed comment for the edit',
558 ' flags - Adds flags for the edit',
559 ' timestamp - Adds timestamp of the edit',
560 ' title - Adds the page title of the edit',
561 ' ids - Adds the page id, recent changes id and the new and old revision id',
562 ' sizes - Adds the new and old page length in bytes',
563 ' redirect - Tags edit if page is a redirect',
564 ' patrolled - Tags edits have have been patrolled',
565 ' loginfo - Adds log information (logid, logtype, etc) to log entries',
566 ' tags - Lists tags for the entry',
568 'token' => 'Which tokens to obtain for each change',
570 'Show only items that meet this criteria.',
571 "For example, to see only minor edits done by logged-in users, set {$this->getModulePrefix()}show=minor|!anon"
573 'type' => 'Which types of changes to show',
574 'limit' => 'How many total changes to return',
575 'tag' => 'Only list changes tagged with this tag',
579 public function getDescription() {
580 return 'Enumerate recent changes';
583 public function getPossibleErrors() {
584 return array_merge( parent
::getPossibleErrors(), array(
586 array( 'code' => 'permissiondenied', 'info' => 'You need the patrol right to request the patrolled flag' ),
587 array( 'code' => 'user-excludeuser', 'info' => 'user and excludeuser cannot be used together' ),
591 protected function getExamples() {
593 'api.php?action=query&list=recentchanges'
597 public function getVersion() {
598 return __CLASS__
. ': $Id$';