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                 foreach ( $res as $row ) {
 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                 /* Format the result */
 277                 $this->getResult()->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'rc' );
 278         }
 279
 280         /**
 281          * Extracts from a single sql row the data needed to describe one recent change.
 282          *
 283          * @param $row The row from which to extract the data.
 284          * @return An array mapping strings (descriptors) to their respective string values.
 285          * @access public
 286          */
 287         public function extractRowInfo( $row ) {
 288                 /* If page was moved somewhere, get the title of the move target. */
 289                 $movedToTitle = false;
 290                 if ( isset( $row->rc_moved_to_title ) && $row->rc_moved_to_title !== '' )
 291                 {
 292                         $movedToTitle = Title::makeTitle( $row->rc_moved_to_ns, $row->rc_moved_to_title );
 293                 }
 294
 295                 /* Determine the title of the page that has been changed. */
 296                 $title = Title::makeTitle( $row->rc_namespace, $row->rc_title );
 297
 298                 /* Our output data. */
 299                 $vals = array();
 300
 301                 $type = intval( $row->rc_type );
 302
 303                 /* Determine what kind of change this was. */
 304                 switch ( $type ) {
 305                         case RC_EDIT:
 306                                 $vals['type'] = 'edit';
 307                                 break;
 308                         case RC_NEW:
 309                                 $vals['type'] = 'new';
 310                                 break;
 311                         case RC_MOVE:
 312                                 $vals['type'] = 'move';
 313                                 break;
 314                         case RC_LOG:
 315                                 $vals['type'] = 'log';
 316                                 break;
 317                         case RC_MOVE_OVER_REDIRECT:
 318                                 $vals['type'] = 'move over redirect';
 319                                 break;
 320                         default:
 321                                 $vals['type'] = $type;
 322                 }
 323
 324                 /* Create a new entry in the result for the title. */
 325                 if ( $this->fld_title ) {
 326                         ApiQueryBase::addTitleInfo( $vals, $title );
 327                         if ( $movedToTitle ) {
 328                                 ApiQueryBase::addTitleInfo( $vals, $movedToTitle, 'new_' );
 329                         }
 330                 }
 331
 332                 /* Add ids, such as rcid, pageid, revid, and oldid to the change's info. */
 333                 if ( $this->fld_ids ) {
 334                         $vals['rcid'] = intval( $row->rc_id );
 335                         $vals['pageid'] = intval( $row->rc_cur_id );
 336                         $vals['revid'] = intval( $row->rc_this_oldid );
 337                         $vals['old_revid'] = intval( $row->rc_last_oldid );
 338                 }
 339
 340                 /* Add user data and 'anon' flag, if use is anonymous. */
 341                 if ( $this->fld_user ) {
 342                         $vals['user'] = $row->rc_user_text;
 343                         if ( !$row->rc_user ) {
 344                                 $vals['anon'] = '';
 345                         }
 346                 }
 347
 348                 /* Add flags, such as new, minor, bot. */
 349                 if ( $this->fld_flags ) {
 350                         if ( $row->rc_bot ) {
 351                                 $vals['bot'] = '';
 352                         }
 353                         if ( $row->rc_new ) {
 354                                 $vals['new'] = '';
 355                         }
 356                         if ( $row->rc_minor ) {
 357                                 $vals['minor'] = '';
 358                         }
 359                 }
 360
 361                 /* Add sizes of each revision. (Only available on 1.10+) */
 362                 if ( $this->fld_sizes ) {
 363                         $vals['oldlen'] = intval( $row->rc_old_len );
 364                         $vals['newlen'] = intval( $row->rc_new_len );
 365                 }
 366
 367                 /* Add the timestamp. */
 368                 if ( $this->fld_timestamp ) {
 369                         $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->rc_timestamp );
 370                 }
 371
 372                 /* Add edit summary / log summary. */
 373                 if ( $this->fld_comment && isset( $row->rc_comment ) ) {
 374                         $vals['comment'] = $row->rc_comment;
 375                 }
 376
 377                 if ( $this->fld_parsedcomment && isset( $row->rc_comment ) ) {
 378                         global $wgUser;
 379                         $vals['parsedcomment'] = $wgUser->getSkin()->formatComment( $row->rc_comment, $title );
 380                 }
 381
 382                 if ( $this->fld_redirect ) {
 383                         if ( $row->page_is_redirect ) {
 384                                 $vals['redirect'] = '';
 385                         }
 386                 }
 387
 388                 /* Add the patrolled flag */
 389                 if ( $this->fld_patrolled && $row->rc_patrolled == 1 ) {
 390                         $vals['patrolled'] = '';
 391                 }
 392
 393                 if ( $this->fld_loginfo && $row->rc_type == RC_LOG ) {
 394                         $vals['logid'] = intval( $row->rc_logid );
 395                         $vals['logtype'] = $row->rc_log_type;
 396                         $vals['logaction'] = $row->rc_log_action;
 397                         ApiQueryLogEvents::addLogParams(
 398                                 $this->getResult(),
 399                                 $vals, $row->rc_params,
 400                                 $row->rc_log_type, $row->rc_timestamp
 401                         );
 402                 }
 403
 404                 if ( $this->fld_tags ) {
 405                         if ( $row->ts_tags ) {
 406                                 $tags = explode( ',', $row->ts_tags );
 407                                 $this->getResult()->setIndexedTagName( $tags, 'tag' );
 408                                 $vals['tags'] = $tags;
 409                         } else {
 410                                 $vals['tags'] = array();
 411                         }
 412                 }
 413
 414                 if ( !is_null( $this->token ) ) {
 415                         $tokenFunctions = $this->getTokenFunctions();
 416                         foreach ( $this->token as $t ) {
 417                                 $val = call_user_func( $tokenFunctions[$t], $row->rc_cur_id,
 418                                         $title, RecentChange::newFromRow( $row ) );
 419                                 if ( $val === false ) {
 420                                         $this->setWarning( "Action '$t' is not allowed for the current user" );
 421                                 } else {
 422                                         $vals[$t . 'token'] = $val;
 423                                 }
 424                         }
 425                 }
 426
 427                 return $vals;
 428         }
 429
 430         private function parseRCType( $type ) {
 431                 if ( is_array( $type ) ) {
 432                         $retval = array();
 433                         foreach ( $type as $t ) {
 434                                 $retval[] = $this->parseRCType( $t );
 435                         }
 436                         return $retval;
 437                 }
 438                 switch( $type ) {
 439                         case 'edit':
 440                                 return RC_EDIT;
 441                         case 'new':
 442                                 return RC_NEW;
 443                         case 'log':
 444                                 return RC_LOG;
 445                 }
 446         }
 447
 448         public function getAllowedParams() {
 449                 return array(
 450                         'start' => array(
 451                                 ApiBase::PARAM_TYPE => 'timestamp'
 452                         ),
 453                         'end' => array(
 454                                 ApiBase::PARAM_TYPE => 'timestamp'
 455                         ),
 456                         'dir' => array(
 457                                 ApiBase::PARAM_DFLT => 'older',
 458                                 ApiBase::PARAM_TYPE => array(
 459                                         'newer',
 460                                         'older'
 461                                 )
 462                         ),
 463                         'namespace' => array(
 464                                 ApiBase::PARAM_ISMULTI => true,
 465                                 ApiBase::PARAM_TYPE => 'namespace'
 466                         ),
 467                         'user' => array(
 468                                 ApiBase::PARAM_TYPE => 'user'
 469                         ),
 470                         'excludeuser' => array(
 471                                 ApiBase::PARAM_TYPE => 'user'
 472                         ),
 473                         'tag' => null,
 474                         'prop' => array(
 475                                 ApiBase::PARAM_ISMULTI => true,
 476                                 ApiBase::PARAM_DFLT => 'title|timestamp|ids',
 477                                 ApiBase::PARAM_TYPE => array(
 478                                         'user',
 479                                         'comment',
 480                                         'parsedcomment',
 481                                         'flags',
 482                                         'timestamp',
 483                                         'title',
 484                                         'ids',
 485                                         'sizes',
 486                                         'redirect',
 487                                         'patrolled',
 488                                         'loginfo',
 489                                         'tags'
 490                                 )
 491                         ),
 492                         'token' => array(
 493                                 ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() ),
 494                                 ApiBase::PARAM_ISMULTI => true
 495                         ),
 496                         'show' => array(
 497                                 ApiBase::PARAM_ISMULTI => true,
 498                                 ApiBase::PARAM_TYPE => array(
 499                                         'minor',
 500                                         '!minor',
 501                                         'bot',
 502                                         '!bot',
 503                                         'anon',
 504                                         '!anon',
 505                                         'redirect',
 506                                         '!redirect',
 507                                         'patrolled',
 508                                         '!patrolled'
 509                                 )
 510                         ),
 511                         'limit' => array(
 512                                 ApiBase::PARAM_DFLT => 10,
 513                                 ApiBase::PARAM_TYPE => 'limit',
 514                                 ApiBase::PARAM_MIN => 1,
 515                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 516                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 517                         ),
 518                         'type' => array(
 519                                 ApiBase::PARAM_ISMULTI => true,
 520                                 ApiBase::PARAM_TYPE => array(
 521                                         'edit',
 522                                         'new',
 523                                         'log'
 524                                 )
 525                         )
 526                 );
 527         }
 528
 529         public function getParamDescription() {
 530                 return array(
 531                         'start' => 'The timestamp to start enumerating from',
 532                         'end' => 'The timestamp to end enumerating',
 533                         'dir' => 'In which direction to enumerate',
 534                         'namespace' => 'Filter log entries to only this namespace(s)',
 535                         'user' => 'Only list changes by this user',
 536                         'excludeuser' => 'Don\'t list changes by this user',
 537                         'prop' => 'Include additional pieces of information',
 538                         'token' => 'Which tokens to obtain for each change',
 539                         'show' => array(
 540                                 'Show only items that meet this criteria.',
 541                                 "For example, to see only minor edits done by logged-in users, set {$this->getModulePrefix()}show=minor|!anon"
 542                         ),
 543                         'type' => 'Which types of changes to show',
 544                         'limit' => 'How many total changes to return',
 545                         'tag' => 'Only list changes tagged with this tag',
 546                 );
 547         }
 548
 549         public function getDescription() {
 550                 return 'Enumerate recent changes';
 551         }
 552
 553         public function getPossibleErrors() {
 554                 return array_merge( parent::getPossibleErrors(), array(
 555                         array( 'show' ),
 556                         array( 'code' => 'permissiondenied', 'info' => 'You need the patrol right to request the patrolled flag' ),
 557                         array( 'code' => 'user-excludeuser', 'info' => 'user and excludeuser cannot be used together' ),
 558                 ) );
 559         }
 560
 561         protected function getExamples() {
 562                 return array(
 563                         'api.php?action=query&list=recentchanges'
 564                 );
 565         }
 566
 567         public function getVersion() {
 568                 return __CLASS__ . ': $Id$';
 569         }
 570 }