API: fix copyright symbol, coding style cleanup, more braces
[lhc/web/wiklou.git] / includes / api / ApiQueryRecentChanges.php
1 <?php
2
3 /**
4 * Created on Oct 19, 2006
5 *
6 * API for MediaWiki 1.8+
7 *
8 * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
9 *
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.
14 *
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.
19 *
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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
24 */
25
26 if ( !defined( 'MEDIAWIKI' ) ) {
27 // Eclipse helper - will be ignored in production
28 require_once( 'ApiQueryBase.php' );
29 }
30
31 /**
32 * A query action to enumerate the recent changes that were done to the wiki.
33 * Various filters are supported.
34 *
35 * @ingroup API
36 */
37 class ApiQueryRecentChanges extends ApiQueryBase {
38
39 public function __construct( $query, $moduleName ) {
40 parent::__construct( $query, $moduleName, 'rc' );
41 }
42
43 private $fld_comment = false, $fld_parsedcomment = false, $fld_user = false, $fld_flags = false,
44 $fld_timestamp = false, $fld_title = false, $fld_ids = false,
45 $fld_sizes = false;
46 /**
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)
51 */
52 protected function getTokenFunctions() {
53 // Don't call the hooks twice
54 if ( isset( $this->tokenFunctions ) ) {
55 return $this->tokenFunctions;
56 }
57
58 // If we're in JSON callback mode, no tokens can be obtained
59 if ( !is_null( $this->getMain()->getRequest()->getVal( 'callback' ) ) ) {
60 return array();
61 }
62
63 $this->tokenFunctions = array(
64 'patrol' => array( 'ApiQueryRecentChanges', 'getPatrolToken' )
65 );
66 wfRunHooks( 'APIQueryRecentChangesTokens', array( &$this->tokenFunctions ) );
67 return $this->tokenFunctions;
68 }
69
70 public static function getPatrolToken( $pageid, $title, $rc ) {
71 global $wgUser;
72 if ( !$wgUser->useRCPatrol() && ( !$wgUser->useNPPatrol() ||
73 $rc->getAttribute( 'rc_type' ) != RC_NEW ) )
74 {
75 return false;
76 }
77
78 // The patrol token is always the same, let's exploit that
79 static $cachedPatrolToken = null;
80 if ( !is_null( $cachedPatrolToken ) ) {
81 return $cachedPatrolToken;
82 }
83
84 $cachedPatrolToken = $wgUser->editToken();
85 return $cachedPatrolToken;
86 }
87
88 /**
89 * Sets internal state to include the desired properties in the output.
90 * @param $prop associative array of properties, only keys are used here
91 */
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'] );
105 }
106
107 /**
108 * Generates and outputs the result of this query based upon the provided parameters.
109 */
110 public function execute() {
111 /* Get the parameters of the request. */
112 $params = $this->extractRequestParams();
113
114 /* Build our basic query. Namely, something along the lines of:
115 * SELECT * FROM recentchanges WHERE rc_timestamp > $start
116 * AND rc_timestamp < $end AND rc_namespace = $namespace
117 * AND rc_deleted = '0'
118 */
119 $db = $this->getDB();
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 );
125
126 if ( !is_null( $params['type'] ) ) {
127 $this->addWhereFld( 'rc_type', $this->parseRCType( $params['type'] ) );
128 }
129
130 if ( !is_null( $params['show'] ) ) {
131 $show = array_flip( $params['show'] );
132
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'] ) )
139 )
140 {
141 $this->dieUsageMsg( array( 'show' ) );
142 }
143
144 // Check permissions
145 global $wgUser;
146 if ( ( isset( $show['patrolled'] ) || isset( $show['!patrolled'] ) ) && !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol() )
147 {
148 $this->dieUsage( 'You need the patrol right to request the patrolled flag', 'permissiondenied' );
149 }
150
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'] ) );
161
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'] ) );
164 }
165
166 if ( !is_null( $params['user'] ) && !is_null( $param['excludeuser'] ) ) {
167 $this->dieUsage( 'user and excludeuser cannot be used together', 'user-excludeuser' );
168 }
169
170 if ( !is_null( $params['user'] ) ) {
171 $this->addWhereFld( 'rc_user_text', $params['user'] );
172 $index['recentchanges'] = 'rc_user_text';
173 }
174
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'] ) );
180 }
181
182 /* Add the fields we're concerned with to our query. */
183 $this->addFields( array(
184 'rc_timestamp',
185 'rc_namespace',
186 'rc_title',
187 'rc_cur_id',
188 'rc_type',
189 'rc_moved_to_ns',
190 'rc_moved_to_title'
191 ) );
192
193 /* Determine what properties we need to display. */
194 if ( !is_null( $params['prop'] ) ) {
195 $prop = array_flip( $params['prop'] );
196
197 /* Set up internal members based upon params. */
198 $this->initProperties( $prop );
199
200 global $wgUser;
201 if ( $this->fld_patrolled && !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol() )
202 {
203 $this->dieUsage( 'You need the patrol right to request the patrolled flag', 'permissiondenied' );
204 }
205
206 /* Add fields to our query if they are specified as a needed parameter. */
207 $this->addFieldsIf( 'rc_id', $this->fld_ids );
208 $this->addFieldsIf( 'rc_this_oldid', $this->fld_ids );
209 $this->addFieldsIf( 'rc_last_oldid', $this->fld_ids );
210 $this->addFieldsIf( 'rc_comment', $this->fld_comment || $this->fld_parsedcomment );
211 $this->addFieldsIf( 'rc_user', $this->fld_user );
212 $this->addFieldsIf( 'rc_user_text', $this->fld_user );
213 $this->addFieldsIf( 'rc_minor', $this->fld_flags );
214 $this->addFieldsIf( 'rc_bot', $this->fld_flags );
215 $this->addFieldsIf( 'rc_new', $this->fld_flags );
216 $this->addFieldsIf( 'rc_old_len', $this->fld_sizes );
217 $this->addFieldsIf( 'rc_new_len', $this->fld_sizes );
218 $this->addFieldsIf( 'rc_patrolled', $this->fld_patrolled );
219 $this->addFieldsIf( 'rc_logid', $this->fld_loginfo );
220 $this->addFieldsIf( 'rc_log_type', $this->fld_loginfo );
221 $this->addFieldsIf( 'rc_log_action', $this->fld_loginfo );
222 $this->addFieldsIf( 'rc_params', $this->fld_loginfo );
223 if ( $this->fld_redirect || isset( $show['redirect'] ) || isset( $show['!redirect'] ) )
224 {
225 $this->addTables( 'page' );
226 $this->addJoinConds( array( 'page' => array( 'LEFT JOIN', array( 'rc_namespace=page_namespace', 'rc_title=page_title' ) ) ) );
227 $this->addFields( 'page_is_redirect' );
228 }
229 }
230
231 if ( $this->fld_tags ) {
232 $this->addTables( 'tag_summary' );
233 $this->addJoinConds( array( 'tag_summary' => array( 'LEFT JOIN', array( 'rc_id=ts_rc_id' ) ) ) );
234 $this->addFields( 'ts_tags' );
235 }
236
237 if ( !is_null( $params['tag'] ) ) {
238 $this->addTables( 'change_tag' );
239 $this->addJoinConds( array( 'change_tag' => array( 'INNER JOIN', array( 'rc_id=ct_rc_id' ) ) ) );
240 $this->addWhereFld( 'ct_tag' , $params['tag'] );
241 global $wgOldChangeTagsIndex;
242 $index['change_tag'] = $wgOldChangeTagsIndex ? 'ct_tag' : 'change_tag_tag_id';
243 }
244
245 $this->token = $params['token'];
246 $this->addOption( 'LIMIT', $params['limit'] + 1 );
247 $this->addOption( 'USE INDEX', $index );
248
249 $count = 0;
250 /* Perform the actual query. */
251 $db = $this->getDB();
252 $res = $this->select( __METHOD__ );
253
254 /* Iterate through the rows, adding data extracted from them to our query result. */
255 while ( $row = $db->fetchObject( $res ) ) {
256 if ( ++ $count > $params['limit'] ) {
257 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
258 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->rc_timestamp ) );
259 break;
260 }
261
262 /* Extract the data from a single row. */
263 $vals = $this->extractRowInfo( $row );
264
265 /* Add that row's data to our final output. */
266 if ( !$vals ) {
267 continue;
268 }
269 $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ), null, $vals );
270 if ( !$fit ) {
271 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->rc_timestamp ) );
272 break;
273 }
274 }
275
276 $db->freeResult( $res );
277
278 /* Format the result */
279 $this->getResult()->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'rc' );
280 }
281
282 /**
283 * Extracts from a single sql row the data needed to describe one recent change.
284 *
285 * @param $row The row from which to extract the data.
286 * @return An array mapping strings (descriptors) to their respective string values.
287 * @access public
288 */
289 public function extractRowInfo( $row ) {
290 /* If page was moved somewhere, get the title of the move target. */
291 $movedToTitle = false;
292 if ( isset( $row->rc_moved_to_title ) && $row->rc_moved_to_title !== '' )
293 {
294 $movedToTitle = Title::makeTitle( $row->rc_moved_to_ns, $row->rc_moved_to_title );
295 }
296
297 /* Determine the title of the page that has been changed. */
298 $title = Title::makeTitle( $row->rc_namespace, $row->rc_title );
299
300 /* Our output data. */
301 $vals = array();
302
303 $type = intval( $row->rc_type );
304
305 /* Determine what kind of change this was. */
306 switch ( $type ) {
307 case RC_EDIT:
308 $vals['type'] = 'edit';
309 break;
310 case RC_NEW:
311 $vals['type'] = 'new';
312 break;
313 case RC_MOVE:
314 $vals['type'] = 'move';
315 break;
316 case RC_LOG:
317 $vals['type'] = 'log';
318 break;
319 case RC_MOVE_OVER_REDIRECT:
320 $vals['type'] = 'move over redirect';
321 break;
322 default:
323 $vals['type'] = $type;
324 }
325
326 /* Create a new entry in the result for the title. */
327 if ( $this->fld_title ) {
328 ApiQueryBase::addTitleInfo( $vals, $title );
329 if ( $movedToTitle ) {
330 ApiQueryBase::addTitleInfo( $vals, $movedToTitle, 'new_' );
331 }
332 }
333
334 /* Add ids, such as rcid, pageid, revid, and oldid to the change's info. */
335 if ( $this->fld_ids ) {
336 $vals['rcid'] = intval( $row->rc_id );
337 $vals['pageid'] = intval( $row->rc_cur_id );
338 $vals['revid'] = intval( $row->rc_this_oldid );
339 $vals['old_revid'] = intval( $row->rc_last_oldid );
340 }
341
342 /* Add user data and 'anon' flag, if use is anonymous. */
343 if ( $this->fld_user ) {
344 $vals['user'] = $row->rc_user_text;
345 if ( !$row->rc_user ) {
346 $vals['anon'] = '';
347 }
348 }
349
350 /* Add flags, such as new, minor, bot. */
351 if ( $this->fld_flags ) {
352 if ( $row->rc_bot ) {
353 $vals['bot'] = '';
354 }
355 if ( $row->rc_new ) {
356 $vals['new'] = '';
357 }
358 if ( $row->rc_minor ) {
359 $vals['minor'] = '';
360 }
361 }
362
363 /* Add sizes of each revision. (Only available on 1.10+) */
364 if ( $this->fld_sizes ) {
365 $vals['oldlen'] = intval( $row->rc_old_len );
366 $vals['newlen'] = intval( $row->rc_new_len );
367 }
368
369 /* Add the timestamp. */
370 if ( $this->fld_timestamp ) {
371 $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->rc_timestamp );
372 }
373
374 /* Add edit summary / log summary. */
375 if ( $this->fld_comment && isset( $row->rc_comment ) ) {
376 $vals['comment'] = $row->rc_comment;
377 }
378
379 if ( $this->fld_parsedcomment && isset( $row->rc_comment ) ) {
380 global $wgUser;
381 $vals['parsedcomment'] = $wgUser->getSkin()->formatComment( $row->rc_comment, $title );
382 }
383
384 if ( $this->fld_redirect ) {
385 if ( $row->page_is_redirect ) {
386 $vals['redirect'] = '';
387 }
388 }
389
390 /* Add the patrolled flag */
391 if ( $this->fld_patrolled && $row->rc_patrolled == 1 ) {
392 $vals['patrolled'] = '';
393 }
394
395 if ( $this->fld_loginfo && $row->rc_type == RC_LOG ) {
396 $vals['logid'] = intval( $row->rc_logid );
397 $vals['logtype'] = $row->rc_log_type;
398 $vals['logaction'] = $row->rc_log_action;
399 ApiQueryLogEvents::addLogParams(
400 $this->getResult(),
401 $vals, $row->rc_params,
402 $row->rc_log_type, $row->rc_timestamp
403 );
404 }
405
406 if ( $this->fld_tags ) {
407 if ( $row->ts_tags ) {
408 $tags = explode( ',', $row->ts_tags );
409 $this->getResult()->setIndexedTagName( $tags, 'tag' );
410 $vals['tags'] = $tags;
411 } else {
412 $vals['tags'] = array();
413 }
414 }
415
416 if ( !is_null( $this->token ) ) {
417 $tokenFunctions = $this->getTokenFunctions();
418 foreach ( $this->token as $t ) {
419 $val = call_user_func( $tokenFunctions[$t], $row->rc_cur_id,
420 $title, RecentChange::newFromRow( $row ) );
421 if ( $val === false ) {
422 $this->setWarning( "Action '$t' is not allowed for the current user" );
423 } else {
424 $vals[$t . 'token'] = $val;
425 }
426 }
427 }
428
429 return $vals;
430 }
431
432 private function parseRCType( $type ) {
433 if ( is_array( $type ) ) {
434 $retval = array();
435 foreach ( $type as $t ) {
436 $retval[] = $this->parseRCType( $t );
437 }
438 return $retval;
439 }
440 switch( $type ) {
441 case 'edit':
442 return RC_EDIT;
443 case 'new':
444 return RC_NEW;
445 case 'log':
446 return RC_LOG;
447 }
448 }
449
450 public function getAllowedParams() {
451 return array(
452 'start' => array(
453 ApiBase::PARAM_TYPE => 'timestamp'
454 ),
455 'end' => array(
456 ApiBase::PARAM_TYPE => 'timestamp'
457 ),
458 'dir' => array(
459 ApiBase::PARAM_DFLT => 'older',
460 ApiBase::PARAM_TYPE => array(
461 'newer',
462 'older'
463 )
464 ),
465 'namespace' => array(
466 ApiBase::PARAM_ISMULTI => true,
467 ApiBase::PARAM_TYPE => 'namespace'
468 ),
469 'user' => array(
470 ApiBase::PARAM_TYPE => 'user'
471 ),
472 'excludeuser' => array(
473 ApiBase::PARAM_TYPE => 'user'
474 ),
475 'tag' => null,
476 'prop' => array(
477 ApiBase::PARAM_ISMULTI => true,
478 ApiBase::PARAM_DFLT => 'title|timestamp|ids',
479 ApiBase::PARAM_TYPE => array(
480 'user',
481 'comment',
482 'parsedcomment',
483 'flags',
484 'timestamp',
485 'title',
486 'ids',
487 'sizes',
488 'redirect',
489 'patrolled',
490 'loginfo',
491 'tags'
492 )
493 ),
494 'token' => array(
495 ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() ),
496 ApiBase::PARAM_ISMULTI => true
497 ),
498 'show' => array(
499 ApiBase::PARAM_ISMULTI => true,
500 ApiBase::PARAM_TYPE => array(
501 'minor',
502 '!minor',
503 'bot',
504 '!bot',
505 'anon',
506 '!anon',
507 'redirect',
508 '!redirect',
509 'patrolled',
510 '!patrolled'
511 )
512 ),
513 'limit' => array(
514 ApiBase::PARAM_DFLT => 10,
515 ApiBase::PARAM_TYPE => 'limit',
516 ApiBase::PARAM_MIN => 1,
517 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
518 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
519 ),
520 'type' => array(
521 ApiBase::PARAM_ISMULTI => true,
522 ApiBase::PARAM_TYPE => array(
523 'edit',
524 'new',
525 'log'
526 )
527 )
528 );
529 }
530
531 public function getParamDescription() {
532 return array(
533 'start' => 'The timestamp to start enumerating from.',
534 'end' => 'The timestamp to end enumerating.',
535 'dir' => 'In which direction to enumerate.',
536 'namespace' => 'Filter log entries to only this namespace(s)',
537 'user' => 'Only list changes by this user',
538 'excludeuser' => 'Don\'t list changes by this user',
539 'prop' => 'Include additional pieces of information',
540 'token' => 'Which tokens to obtain for each change',
541 'show' => array(
542 'Show only items that meet this criteria.',
543 'For example, to see only minor edits done by logged-in users, set show=minor|!anon'
544 ),
545 'type' => 'Which types of changes to show.',
546 'limit' => 'How many total changes to return.',
547 'tag' => 'Only list changes tagged with this tag.',
548 );
549 }
550
551 public function getDescription() {
552 return 'Enumerate recent changes';
553 }
554
555 public function getPossibleErrors() {
556 return array_merge( parent::getPossibleErrors(), array(
557 array( 'show' ),
558 array( 'code' => 'permissiondenied', 'info' => 'You need the patrol right to request the patrolled flag' ),
559 array( 'code' => 'user-excludeuser', 'info' => 'user and excludeuser cannot be used together' ),
560 ) );
561 }
562
563 protected function getExamples() {
564 return array(
565 'api.php?action=query&list=recentchanges'
566 );
567 }
568
569 public function getVersion() {
570 return __CLASS__ . ': $Id$';
571 }
572 }