includes/api/ApiQueryRecentChanges.php

   1 <?php
   2 /**
   3  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 use MediaWiki\MediaWikiServices;
  24 use MediaWiki\Storage\NameTableAccessException;
  25 use MediaWiki\Storage\RevisionRecord;
  26
  27 /**
  28  * A query action to enumerate the recent changes that were done to the wiki.
  29  * Various filters are supported.
  30  *
  31  * @ingroup API
  32  */
  33 class ApiQueryRecentChanges extends ApiQueryGeneratorBase {
  34
  35         public function __construct( ApiQuery $query, $moduleName ) {
  36                 parent::__construct( $query, $moduleName, 'rc' );
  37         }
  38
  39         private $commentStore;
  40
  41         private $fld_comment = false, $fld_parsedcomment = false, $fld_user = false, $fld_userid = false,
  42                 $fld_flags = false, $fld_timestamp = false, $fld_title = false, $fld_ids = false,
  43                 $fld_sizes = false, $fld_redirect = false, $fld_patrolled = false, $fld_loginfo = false,
  44                 $fld_tags = false, $fld_sha1 = false, $token = [];
  45
  46         private $tokenFunctions;
  47
  48         /**
  49          * Get an array mapping token names to their handler functions.
  50          * The prototype for a token function is func($pageid, $title, $rc)
  51          * it should return a token or false (permission denied)
  52          * @deprecated since 1.24
  53          * @return array [ tokenname => function ]
  54          */
  55         protected function getTokenFunctions() {
  56                 // Don't call the hooks twice
  57                 if ( isset( $this->tokenFunctions ) ) {
  58                         return $this->tokenFunctions;
  59                 }
  60
  61                 // If we're in a mode that breaks the same-origin policy, no tokens can
  62                 // be obtained
  63                 if ( $this->lacksSameOriginSecurity() ) {
  64                         return [];
  65                 }
  66
  67                 $this->tokenFunctions = [
  68                         'patrol' => [ self::class, 'getPatrolToken' ]
  69                 ];
  70                 Hooks::run( 'APIQueryRecentChangesTokens', [ &$this->tokenFunctions ] );
  71
  72                 return $this->tokenFunctions;
  73         }
  74
  75         /**
  76          * @deprecated since 1.24
  77          * @param int $pageid
  78          * @param Title $title
  79          * @param RecentChange|null $rc
  80          * @return bool|string
  81          */
  82         public static function getPatrolToken( $pageid, $title, $rc = null ) {
  83                 global $wgUser;
  84
  85                 $validTokenUser = false;
  86
  87                 if ( $rc ) {
  88                         if ( ( $wgUser->useRCPatrol() && $rc->getAttribute( 'rc_type' ) == RC_EDIT ) ||
  89                                 ( $wgUser->useNPPatrol() && $rc->getAttribute( 'rc_type' ) == RC_NEW )
  90                         ) {
  91                                 $validTokenUser = true;
  92                         }
  93                 } elseif ( $wgUser->useRCPatrol() || $wgUser->useNPPatrol() ) {
  94                         $validTokenUser = true;
  95                 }
  96
  97                 if ( $validTokenUser ) {
  98                         // The patrol token is always the same, let's exploit that
  99                         static $cachedPatrolToken = null;
 100
 101                         if ( is_null( $cachedPatrolToken ) ) {
 102                                 $cachedPatrolToken = $wgUser->getEditToken( 'patrol' );
 103                         }
 104
 105                         return $cachedPatrolToken;
 106                 }
 107
 108                 return false;
 109         }
 110
 111         /**
 112          * Sets internal state to include the desired properties in the output.
 113          * @param array $prop Associative array of properties, only keys are used here
 114          */
 115         public function initProperties( $prop ) {
 116                 $this->fld_comment = isset( $prop['comment'] );
 117                 $this->fld_parsedcomment = isset( $prop['parsedcomment'] );
 118                 $this->fld_user = isset( $prop['user'] );
 119                 $this->fld_userid = isset( $prop['userid'] );
 120                 $this->fld_flags = isset( $prop['flags'] );
 121                 $this->fld_timestamp = isset( $prop['timestamp'] );
 122                 $this->fld_title = isset( $prop['title'] );
 123                 $this->fld_ids = isset( $prop['ids'] );
 124                 $this->fld_sizes = isset( $prop['sizes'] );
 125                 $this->fld_redirect = isset( $prop['redirect'] );
 126                 $this->fld_patrolled = isset( $prop['patrolled'] );
 127                 $this->fld_loginfo = isset( $prop['loginfo'] );
 128                 $this->fld_tags = isset( $prop['tags'] );
 129                 $this->fld_sha1 = isset( $prop['sha1'] );
 130         }
 131
 132         public function execute() {
 133                 $this->run();
 134         }
 135
 136         public function executeGenerator( $resultPageSet ) {
 137                 $this->run( $resultPageSet );
 138         }
 139
 140         /**
 141          * Generates and outputs the result of this query based upon the provided parameters.
 142          *
 143          * @param ApiPageSet|null $resultPageSet
 144          */
 145         public function run( $resultPageSet = null ) {
 146                 global $wgChangeTagsSchemaMigrationStage;
 147
 148                 $user = $this->getUser();
 149                 /* Get the parameters of the request. */
 150                 $params = $this->extractRequestParams();
 151
 152                 /* Build our basic query. Namely, something along the lines of:
 153                  * SELECT * FROM recentchanges WHERE rc_timestamp > $start
 154                  *   AND rc_timestamp < $end AND rc_namespace = $namespace
 155                  */
 156                 $this->addTables( 'recentchanges' );
 157                 $this->addTimestampWhereRange( 'rc_timestamp', $params['dir'], $params['start'], $params['end'] );
 158
 159                 if ( !is_null( $params['continue'] ) ) {
 160                         $cont = explode( '|', $params['continue'] );
 161                         $this->dieContinueUsageIf( count( $cont ) != 2 );
 162                         $db = $this->getDB();
 163                         $timestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
 164                         $id = intval( $cont[1] );
 165                         $this->dieContinueUsageIf( $id != $cont[1] );
 166                         $op = $params['dir'] === 'older' ? '<' : '>';
 167                         $this->addWhere(
 168                                 "rc_timestamp $op $timestamp OR " .
 169                                 "(rc_timestamp = $timestamp AND " .
 170                                 "rc_id $op= $id)"
 171                         );
 172                 }
 173
 174                 $order = $params['dir'] === 'older' ? 'DESC' : 'ASC';
 175                 $this->addOption( 'ORDER BY', [
 176                         "rc_timestamp $order",
 177                         "rc_id $order",
 178                 ] );
 179
 180                 $this->addWhereFld( 'rc_namespace', $params['namespace'] );
 181
 182                 if ( !is_null( $params['type'] ) ) {
 183                         try {
 184                                 $this->addWhereFld( 'rc_type', RecentChange::parseToRCType( $params['type'] ) );
 185                         } catch ( Exception $e ) {
 186                                 ApiBase::dieDebug( __METHOD__, $e->getMessage() );
 187                         }
 188                 }
 189
 190                 $title = $params['title'];
 191                 if ( !is_null( $title ) ) {
 192                         $titleObj = Title::newFromText( $title );
 193                         if ( is_null( $titleObj ) ) {
 194                                 $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $title ) ] );
 195                         }
 196                         $this->addWhereFld( 'rc_namespace', $titleObj->getNamespace() );
 197                         $this->addWhereFld( 'rc_title', $titleObj->getDBkey() );
 198                 }
 199
 200                 if ( !is_null( $params['show'] ) ) {
 201                         $show = array_flip( $params['show'] );
 202
 203                         /* Check for conflicting parameters. */
 204                         if ( ( isset( $show['minor'] ) && isset( $show['!minor'] ) )
 205                                 || ( isset( $show['bot'] ) && isset( $show['!bot'] ) )
 206                                 || ( isset( $show['anon'] ) && isset( $show['!anon'] ) )
 207                                 || ( isset( $show['redirect'] ) && isset( $show['!redirect'] ) )
 208                                 || ( isset( $show['patrolled'] ) && isset( $show['!patrolled'] ) )
 209                                 || ( isset( $show['patrolled'] ) && isset( $show['unpatrolled'] ) )
 210                                 || ( isset( $show['!patrolled'] ) && isset( $show['unpatrolled'] ) )
 211                                 || ( isset( $show['autopatrolled'] ) && isset( $show['!autopatrolled'] ) )
 212                                 || ( isset( $show['autopatrolled'] ) && isset( $show['unpatrolled'] ) )
 213                                 || ( isset( $show['autopatrolled'] ) && isset( $show['!patrolled'] ) )
 214                         ) {
 215                                 $this->dieWithError( 'apierror-show' );
 216                         }
 217
 218                         // Check permissions
 219                         if ( isset( $show['patrolled'] )
 220                                 || isset( $show['!patrolled'] )
 221                                 || isset( $show['unpatrolled'] )
 222                                 || isset( $show['autopatrolled'] )
 223                                 || isset( $show['!autopatrolled'] )
 224                         ) {
 225                                 if ( !$user->useRCPatrol() && !$user->useNPPatrol() ) {
 226                                         $this->dieWithError( 'apierror-permissiondenied-patrolflag', 'permissiondenied' );
 227                                 }
 228                         }
 229
 230                         /* Add additional conditions to query depending upon parameters. */
 231                         $this->addWhereIf( 'rc_minor = 0', isset( $show['!minor'] ) );
 232                         $this->addWhereIf( 'rc_minor != 0', isset( $show['minor'] ) );
 233                         $this->addWhereIf( 'rc_bot = 0', isset( $show['!bot'] ) );
 234                         $this->addWhereIf( 'rc_bot != 0', isset( $show['bot'] ) );
 235                         if ( isset( $show['anon'] ) || isset( $show['!anon'] ) ) {
 236                                 $actorMigration = ActorMigration::newMigration();
 237                                 $actorQuery = $actorMigration->getJoin( 'rc_user' );
 238                                 $this->addTables( $actorQuery['tables'] );
 239                                 $this->addJoinConds( $actorQuery['joins'] );
 240                                 $this->addWhereIf(
 241                                         $actorMigration->isAnon( $actorQuery['fields']['rc_user'] ), isset( $show['anon'] )
 242                                 );
 243                                 $this->addWhereIf(
 244                                         $actorMigration->isNotAnon( $actorQuery['fields']['rc_user'] ), isset( $show['!anon'] )
 245                                 );
 246                         }
 247                         $this->addWhereIf( 'rc_patrolled = 0', isset( $show['!patrolled'] ) );
 248                         $this->addWhereIf( 'rc_patrolled != 0', isset( $show['patrolled'] ) );
 249                         $this->addWhereIf( 'page_is_redirect = 1', isset( $show['redirect'] ) );
 250
 251                         if ( isset( $show['unpatrolled'] ) ) {
 252                                 // See ChangesList::isUnpatrolled
 253                                 if ( $user->useRCPatrol() ) {
 254                                         $this->addWhere( 'rc_patrolled = ' . RecentChange::PRC_UNPATROLLED );
 255                                 } elseif ( $user->useNPPatrol() ) {
 256                                         $this->addWhere( 'rc_patrolled = ' . RecentChange::PRC_UNPATROLLED );
 257                                         $this->addWhereFld( 'rc_type', RC_NEW );
 258                                 }
 259                         }
 260
 261                         $this->addWhereIf(
 262                                 'rc_patrolled != ' . RecentChange::PRC_AUTOPATROLLED,
 263                                 isset( $show['!autopatrolled'] )
 264                         );
 265                         $this->addWhereIf(
 266                                 'rc_patrolled = ' . RecentChange::PRC_AUTOPATROLLED,
 267                                 isset( $show['autopatrolled'] )
 268                         );
 269
 270                         // Don't throw log entries out the window here
 271                         $this->addWhereIf(
 272                                 'page_is_redirect = 0 OR page_is_redirect IS NULL',
 273                                 isset( $show['!redirect'] )
 274                         );
 275                 }
 276
 277                 $this->requireMaxOneParameter( $params, 'user', 'excludeuser' );
 278
 279                 if ( !is_null( $params['user'] ) ) {
 280                         // Don't query by user ID here, it might be able to use the rc_user_text index.
 281                         $actorQuery = ActorMigration::newMigration()
 282                                 ->getWhere( $this->getDB(), 'rc_user', User::newFromName( $params['user'], false ), false );
 283                         $this->addTables( $actorQuery['tables'] );
 284                         $this->addJoinConds( $actorQuery['joins'] );
 285                         $this->addWhere( $actorQuery['conds'] );
 286                 }
 287
 288                 if ( !is_null( $params['excludeuser'] ) ) {
 289                         // Here there's no chance to use the rc_user_text index, so allow ID to be used.
 290                         $actorQuery = ActorMigration::newMigration()
 291                                 ->getWhere( $this->getDB(), 'rc_user', User::newFromName( $params['excludeuser'], false ) );
 292                         $this->addTables( $actorQuery['tables'] );
 293                         $this->addJoinConds( $actorQuery['joins'] );
 294                         $this->addWhere( 'NOT(' . $actorQuery['conds'] . ')' );
 295                 }
 296
 297                 /* Add the fields we're concerned with to our query. */
 298                 $this->addFields( [
 299                         'rc_id',
 300                         'rc_timestamp',
 301                         'rc_namespace',
 302                         'rc_title',
 303                         'rc_cur_id',
 304                         'rc_type',
 305                         'rc_deleted'
 306                 ] );
 307
 308                 $showRedirects = false;
 309                 /* Determine what properties we need to display. */
 310                 if ( !is_null( $params['prop'] ) ) {
 311                         $prop = array_flip( $params['prop'] );
 312
 313                         /* Set up internal members based upon params. */
 314                         $this->initProperties( $prop );
 315
 316                         if ( $this->fld_patrolled && !$user->useRCPatrol() && !$user->useNPPatrol() ) {
 317                                 $this->dieWithError( 'apierror-permissiondenied-patrolflag', 'permissiondenied' );
 318                         }
 319
 320                         /* Add fields to our query if they are specified as a needed parameter. */
 321                         $this->addFieldsIf( [ 'rc_this_oldid', 'rc_last_oldid' ], $this->fld_ids );
 322                         if ( $this->fld_user || $this->fld_userid ) {
 323                                 $actorQuery = ActorMigration::newMigration()->getJoin( 'rc_user' );
 324                                 $this->addTables( $actorQuery['tables'] );
 325                                 $this->addFields( $actorQuery['fields'] );
 326                                 $this->addJoinConds( $actorQuery['joins'] );
 327                         }
 328                         $this->addFieldsIf( [ 'rc_minor', 'rc_type', 'rc_bot' ], $this->fld_flags );
 329                         $this->addFieldsIf( [ 'rc_old_len', 'rc_new_len' ], $this->fld_sizes );
 330                         $this->addFieldsIf( [ 'rc_patrolled', 'rc_log_type' ], $this->fld_patrolled );
 331                         $this->addFieldsIf(
 332                                 [ 'rc_logid', 'rc_log_type', 'rc_log_action', 'rc_params' ],
 333                                 $this->fld_loginfo
 334                         );
 335                         $showRedirects = $this->fld_redirect || isset( $show['redirect'] )
 336                                 || isset( $show['!redirect'] );
 337                 }
 338                 $this->addFieldsIf( [ 'rc_this_oldid' ],
 339                         $resultPageSet && $params['generaterevisions'] );
 340
 341                 if ( $this->fld_tags ) {
 342                         $this->addTables( 'tag_summary' );
 343                         $this->addJoinConds( [ 'tag_summary' => [ 'LEFT JOIN', [ 'rc_id=ts_rc_id' ] ] ] );
 344                         $this->addFields( 'ts_tags' );
 345                 }
 346
 347                 if ( $this->fld_sha1 ) {
 348                         $this->addTables( 'revision' );
 349                         $this->addJoinConds( [ 'revision' => [ 'LEFT JOIN',
 350                                 [ 'rc_this_oldid=rev_id' ] ] ] );
 351                         $this->addFields( [ 'rev_sha1', 'rev_deleted' ] );
 352                 }
 353
 354                 if ( $params['toponly'] || $showRedirects ) {
 355                         $this->addTables( 'page' );
 356                         $this->addJoinConds( [ 'page' => [ 'LEFT JOIN',
 357                                 [ 'rc_namespace=page_namespace', 'rc_title=page_title' ] ] ] );
 358                         $this->addFields( 'page_is_redirect' );
 359
 360                         if ( $params['toponly'] ) {
 361                                 $this->addWhere( 'rc_this_oldid = page_latest' );
 362                         }
 363                 }
 364
 365                 if ( !is_null( $params['tag'] ) ) {
 366                         $this->addTables( 'change_tag' );
 367                         $this->addJoinConds( [ 'change_tag' => [ 'INNER JOIN', [ 'rc_id=ct_rc_id' ] ] ] );
 368                         if ( $wgChangeTagsSchemaMigrationStage > MIGRATION_WRITE_BOTH ) {
 369                                 $changeTagDefStore = MediaWikiServices::getInstance()->getChangeTagDefStore();
 370                                 try {
 371                                         $this->addWhereFld( 'ct_tag_id', $changeTagDefStore->getId( $params['tag'] ) );
 372                                 } catch ( NameTableAccessException $exception ) {
 373                                         // Return nothing.
 374                                         $this->addWhere( '1=0' );
 375                                 }
 376                         } else {
 377                                 $this->addWhereFld( 'ct_tag', $params['tag'] );
 378                         }
 379                 }
 380
 381                 // Paranoia: avoid brute force searches (T19342)
 382                 if ( !is_null( $params['user'] ) || !is_null( $params['excludeuser'] ) ) {
 383                         if ( !$user->isAllowed( 'deletedhistory' ) ) {
 384                                 $bitmask = RevisionRecord::DELETED_USER;
 385                         } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
 386                                 $bitmask = RevisionRecord::DELETED_USER | RevisionRecord::DELETED_RESTRICTED;
 387                         } else {
 388                                 $bitmask = 0;
 389                         }
 390                         if ( $bitmask ) {
 391                                 $this->addWhere( $this->getDB()->bitAnd( 'rc_deleted', $bitmask ) . " != $bitmask" );
 392                         }
 393                 }
 394                 if ( $this->getRequest()->getCheck( 'namespace' ) ) {
 395                         // LogPage::DELETED_ACTION hides the affected page, too.
 396                         if ( !$user->isAllowed( 'deletedhistory' ) ) {
 397                                 $bitmask = LogPage::DELETED_ACTION;
 398                         } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
 399                                 $bitmask = LogPage::DELETED_ACTION | LogPage::DELETED_RESTRICTED;
 400                         } else {
 401                                 $bitmask = 0;
 402                         }
 403                         if ( $bitmask ) {
 404                                 $this->addWhere( $this->getDB()->makeList( [
 405                                         'rc_type != ' . RC_LOG,
 406                                         $this->getDB()->bitAnd( 'rc_deleted', $bitmask ) . " != $bitmask",
 407                                 ], LIST_OR ) );
 408                         }
 409                 }
 410
 411                 $this->token = $params['token'];
 412
 413                 if ( $this->fld_comment || $this->fld_parsedcomment || $this->token ) {
 414                         $this->commentStore = CommentStore::getStore();
 415                         $commentQuery = $this->commentStore->getJoin( 'rc_comment' );
 416                         $this->addTables( $commentQuery['tables'] );
 417                         $this->addFields( $commentQuery['fields'] );
 418                         $this->addJoinConds( $commentQuery['joins'] );
 419                 }
 420
 421                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
 422
 423                 $hookData = [];
 424                 $count = 0;
 425                 /* Perform the actual query. */
 426                 $res = $this->select( __METHOD__, [], $hookData );
 427
 428                 $revids = [];
 429                 $titles = [];
 430
 431                 $result = $this->getResult();
 432
 433                 /* Iterate through the rows, adding data extracted from them to our query result. */
 434                 foreach ( $res as $row ) {
 435                         if ( $count === 0 && $resultPageSet !== null ) {
 436                                 // Set the non-continue since the list of recentchanges is
 437                                 // prone to having entries added at the start frequently.
 438                                 $this->getContinuationManager()->addGeneratorNonContinueParam(
 439                                         $this, 'continue', "$row->rc_timestamp|$row->rc_id"
 440                                 );
 441                         }
 442                         if ( ++$count > $params['limit'] ) {
 443                                 // We've reached the one extra which shows that there are
 444                                 // additional pages to be had. Stop here...
 445                                 $this->setContinueEnumParameter( 'continue', "$row->rc_timestamp|$row->rc_id" );
 446                                 break;
 447                         }
 448
 449                         if ( is_null( $resultPageSet ) ) {
 450                                 /* Extract the data from a single row. */
 451                                 $vals = $this->extractRowInfo( $row );
 452
 453                                 /* Add that row's data to our final output. */
 454                                 $fit = $this->processRow( $row, $vals, $hookData ) &&
 455                                         $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
 456                                 if ( !$fit ) {
 457                                         $this->setContinueEnumParameter( 'continue', "$row->rc_timestamp|$row->rc_id" );
 458                                         break;
 459                                 }
 460                         } elseif ( $params['generaterevisions'] ) {
 461                                 $revid = (int)$row->rc_this_oldid;
 462                                 if ( $revid > 0 ) {
 463                                         $revids[] = $revid;
 464                                 }
 465                         } else {
 466                                 $titles[] = Title::makeTitle( $row->rc_namespace, $row->rc_title );
 467                         }
 468                 }
 469
 470                 if ( is_null( $resultPageSet ) ) {
 471                         /* Format the result */
 472                         $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'rc' );
 473                 } elseif ( $params['generaterevisions'] ) {
 474                         $resultPageSet->populateFromRevisionIDs( $revids );
 475                 } else {
 476                         $resultPageSet->populateFromTitles( $titles );
 477                 }
 478         }
 479
 480         /**
 481          * Extracts from a single sql row the data needed to describe one recent change.
 482          *
 483          * @param stdClass $row The row from which to extract the data.
 484          * @return array An array mapping strings (descriptors) to their respective string values.
 485          * @access public
 486          */
 487         public function extractRowInfo( $row ) {
 488                 /* Determine the title of the page that has been changed. */
 489                 $title = Title::makeTitle( $row->rc_namespace, $row->rc_title );
 490                 $user = $this->getUser();
 491
 492                 /* Our output data. */
 493                 $vals = [];
 494
 495                 $type = intval( $row->rc_type );
 496                 $vals['type'] = RecentChange::parseFromRCType( $type );
 497
 498                 $anyHidden = false;
 499
 500                 /* Create a new entry in the result for the title. */
 501                 if ( $this->fld_title || $this->fld_ids ) {
 502                         if ( $type === RC_LOG && ( $row->rc_deleted & LogPage::DELETED_ACTION ) ) {
 503                                 $vals['actionhidden'] = true;
 504                                 $anyHidden = true;
 505                         }
 506                         if ( $type !== RC_LOG ||
 507                                 LogEventsList::userCanBitfield( $row->rc_deleted, LogPage::DELETED_ACTION, $user )
 508                         ) {
 509                                 if ( $this->fld_title ) {
 510                                         ApiQueryBase::addTitleInfo( $vals, $title );
 511                                 }
 512                                 if ( $this->fld_ids ) {
 513                                         $vals['pageid'] = intval( $row->rc_cur_id );
 514                                         $vals['revid'] = intval( $row->rc_this_oldid );
 515                                         $vals['old_revid'] = intval( $row->rc_last_oldid );
 516                                 }
 517                         }
 518                 }
 519
 520                 if ( $this->fld_ids ) {
 521                         $vals['rcid'] = intval( $row->rc_id );
 522                 }
 523
 524                 /* Add user data and 'anon' flag, if user is anonymous. */
 525                 if ( $this->fld_user || $this->fld_userid ) {
 526                         if ( $row->rc_deleted & RevisionRecord::DELETED_USER ) {
 527                                 $vals['userhidden'] = true;
 528                                 $anyHidden = true;
 529                         }
 530                         if ( RevisionRecord::userCanBitfield( $row->rc_deleted, RevisionRecord::DELETED_USER, $user ) ) {
 531                                 if ( $this->fld_user ) {
 532                                         $vals['user'] = $row->rc_user_text;
 533                                 }
 534
 535                                 if ( $this->fld_userid ) {
 536                                         $vals['userid'] = (int)$row->rc_user;
 537                                 }
 538
 539                                 if ( !$row->rc_user ) {
 540                                         $vals['anon'] = true;
 541                                 }
 542                         }
 543                 }
 544
 545                 /* Add flags, such as new, minor, bot. */
 546                 if ( $this->fld_flags ) {
 547                         $vals['bot'] = (bool)$row->rc_bot;
 548                         $vals['new'] = $row->rc_type == RC_NEW;
 549                         $vals['minor'] = (bool)$row->rc_minor;
 550                 }
 551
 552                 /* Add sizes of each revision. (Only available on 1.10+) */
 553                 if ( $this->fld_sizes ) {
 554                         $vals['oldlen'] = intval( $row->rc_old_len );
 555                         $vals['newlen'] = intval( $row->rc_new_len );
 556                 }
 557
 558                 /* Add the timestamp. */
 559                 if ( $this->fld_timestamp ) {
 560                         $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->rc_timestamp );
 561                 }
 562
 563                 /* Add edit summary / log summary. */
 564                 if ( $this->fld_comment || $this->fld_parsedcomment ) {
 565                         if ( $row->rc_deleted & RevisionRecord::DELETED_COMMENT ) {
 566                                 $vals['commenthidden'] = true;
 567                                 $anyHidden = true;
 568                         }
 569                         if ( RevisionRecord::userCanBitfield(
 570                                 $row->rc_deleted, RevisionRecord::DELETED_COMMENT, $user
 571                         ) ) {
 572                                 $comment = $this->commentStore->getComment( 'rc_comment', $row )->text;
 573                                 if ( $this->fld_comment ) {
 574                                         $vals['comment'] = $comment;
 575                                 }
 576
 577                                 if ( $this->fld_parsedcomment ) {
 578                                         $vals['parsedcomment'] = Linker::formatComment( $comment, $title );
 579                                 }
 580                         }
 581                 }
 582
 583                 if ( $this->fld_redirect ) {
 584                         $vals['redirect'] = (bool)$row->page_is_redirect;
 585                 }
 586
 587                 /* Add the patrolled flag */
 588                 if ( $this->fld_patrolled ) {
 589                         $vals['patrolled'] = $row->rc_patrolled != RecentChange::PRC_UNPATROLLED;
 590                         $vals['unpatrolled'] = ChangesList::isUnpatrolled( $row, $user );
 591                         $vals['autopatrolled'] = $row->rc_patrolled == RecentChange::PRC_AUTOPATROLLED;
 592                 }
 593
 594                 if ( $this->fld_loginfo && $row->rc_type == RC_LOG ) {
 595                         if ( $row->rc_deleted & LogPage::DELETED_ACTION ) {
 596                                 $vals['actionhidden'] = true;
 597                                 $anyHidden = true;
 598                         }
 599                         if ( LogEventsList::userCanBitfield( $row->rc_deleted, LogPage::DELETED_ACTION, $user ) ) {
 600                                 $vals['logid'] = intval( $row->rc_logid );
 601                                 $vals['logtype'] = $row->rc_log_type;
 602                                 $vals['logaction'] = $row->rc_log_action;
 603                                 $vals['logparams'] = LogFormatter::newFromRow( $row )->formatParametersForApi();
 604                         }
 605                 }
 606
 607                 if ( $this->fld_tags ) {
 608                         if ( $row->ts_tags ) {
 609                                 $tags = explode( ',', $row->ts_tags );
 610                                 ApiResult::setIndexedTagName( $tags, 'tag' );
 611                                 $vals['tags'] = $tags;
 612                         } else {
 613                                 $vals['tags'] = [];
 614                         }
 615                 }
 616
 617                 if ( $this->fld_sha1 && $row->rev_sha1 !== null ) {
 618                         if ( $row->rev_deleted & RevisionRecord::DELETED_TEXT ) {
 619                                 $vals['sha1hidden'] = true;
 620                                 $anyHidden = true;
 621                         }
 622                         if ( RevisionRecord::userCanBitfield(
 623                                 $row->rev_deleted, RevisionRecord::DELETED_TEXT, $user
 624                         ) ) {
 625                                 if ( $row->rev_sha1 !== '' ) {
 626                                         $vals['sha1'] = Wikimedia\base_convert( $row->rev_sha1, 36, 16, 40 );
 627                                 } else {
 628                                         $vals['sha1'] = '';
 629                                 }
 630                         }
 631                 }
 632
 633                 if ( !is_null( $this->token ) ) {
 634                         $tokenFunctions = $this->getTokenFunctions();
 635                         foreach ( $this->token as $t ) {
 636                                 $val = call_user_func( $tokenFunctions[$t], $row->rc_cur_id,
 637                                         $title, RecentChange::newFromRow( $row ) );
 638                                 if ( $val === false ) {
 639                                         $this->addWarning( [ 'apiwarn-tokennotallowed', $t ] );
 640                                 } else {
 641                                         $vals[$t . 'token'] = $val;
 642                                 }
 643                         }
 644                 }
 645
 646                 if ( $anyHidden && ( $row->rc_deleted & RevisionRecord::DELETED_RESTRICTED ) ) {
 647                         $vals['suppressed'] = true;
 648                 }
 649
 650                 return $vals;
 651         }
 652
 653         public function getCacheMode( $params ) {
 654                 if ( isset( $params['show'] ) ) {
 655                         foreach ( $params['show'] as $show ) {
 656                                 if ( $show === 'patrolled' || $show === '!patrolled' ) {
 657                                         return 'private';
 658                                 }
 659                         }
 660                 }
 661                 if ( isset( $params['token'] ) ) {
 662                         return 'private';
 663                 }
 664                 if ( $this->userCanSeeRevDel() ) {
 665                         return 'private';
 666                 }
 667                 if ( !is_null( $params['prop'] ) && in_array( 'parsedcomment', $params['prop'] ) ) {
 668                         // formatComment() calls wfMessage() among other things
 669                         return 'anon-public-user-private';
 670                 }
 671
 672                 return 'public';
 673         }
 674
 675         public function getAllowedParams() {
 676                 return [
 677                         'start' => [
 678                                 ApiBase::PARAM_TYPE => 'timestamp'
 679                         ],
 680                         'end' => [
 681                                 ApiBase::PARAM_TYPE => 'timestamp'
 682                         ],
 683                         'dir' => [
 684                                 ApiBase::PARAM_DFLT => 'older',
 685                                 ApiBase::PARAM_TYPE => [
 686                                         'newer',
 687                                         'older'
 688                                 ],
 689                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
 690                         ],
 691                         'namespace' => [
 692                                 ApiBase::PARAM_ISMULTI => true,
 693                                 ApiBase::PARAM_TYPE => 'namespace',
 694                                 ApiBase::PARAM_EXTRA_NAMESPACES => [ NS_MEDIA, NS_SPECIAL ],
 695                         ],
 696                         'user' => [
 697                                 ApiBase::PARAM_TYPE => 'user'
 698                         ],
 699                         'excludeuser' => [
 700                                 ApiBase::PARAM_TYPE => 'user'
 701                         ],
 702                         'tag' => null,
 703                         'prop' => [
 704                                 ApiBase::PARAM_ISMULTI => true,
 705                                 ApiBase::PARAM_DFLT => 'title|timestamp|ids',
 706                                 ApiBase::PARAM_TYPE => [
 707                                         'user',
 708                                         'userid',
 709                                         'comment',
 710                                         'parsedcomment',
 711                                         'flags',
 712                                         'timestamp',
 713                                         'title',
 714                                         'ids',
 715                                         'sizes',
 716                                         'redirect',
 717                                         'patrolled',
 718                                         'loginfo',
 719                                         'tags',
 720                                         'sha1',
 721                                 ],
 722                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
 723                         ],
 724                         'token' => [
 725                                 ApiBase::PARAM_DEPRECATED => true,
 726                                 ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() ),
 727                                 ApiBase::PARAM_ISMULTI => true
 728                         ],
 729                         'show' => [
 730                                 ApiBase::PARAM_ISMULTI => true,
 731                                 ApiBase::PARAM_TYPE => [
 732                                         'minor',
 733                                         '!minor',
 734                                         'bot',
 735                                         '!bot',
 736                                         'anon',
 737                                         '!anon',
 738                                         'redirect',
 739                                         '!redirect',
 740                                         'patrolled',
 741                                         '!patrolled',
 742                                         'unpatrolled',
 743                                         'autopatrolled',
 744                                         '!autopatrolled',
 745                                 ]
 746                         ],
 747                         'limit' => [
 748                                 ApiBase::PARAM_DFLT => 10,
 749                                 ApiBase::PARAM_TYPE => 'limit',
 750                                 ApiBase::PARAM_MIN => 1,
 751                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 752                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 753                         ],
 754                         'type' => [
 755                                 ApiBase::PARAM_DFLT => 'edit|new|log|categorize',
 756                                 ApiBase::PARAM_ISMULTI => true,
 757                                 ApiBase::PARAM_TYPE => RecentChange::getChangeTypes()
 758                         ],
 759                         'toponly' => false,
 760                         'title' => null,
 761                         'continue' => [
 762                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 763                         ],
 764                         'generaterevisions' => false,
 765                 ];
 766         }
 767
 768         protected function getExamplesMessages() {
 769                 return [
 770                         'action=query&list=recentchanges'
 771                                 => 'apihelp-query+recentchanges-example-simple',
 772                         'action=query&generator=recentchanges&grcshow=!patrolled&prop=info'
 773                                 => 'apihelp-query+recentchanges-example-generator',
 774                 ];
 775         }
 776
 777         public function getHelpUrls() {
 778                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Recentchanges';
 779         }
 780 }