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\Revision\RevisionRecord;
  25 use MediaWiki\Storage\NameTableAccessException;
  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                 $user = $this->getUser();
 147                 /* Get the parameters of the request. */
 148                 $params = $this->extractRequestParams();
 149
 150                 /* Build our basic query. Namely, something along the lines of:
 151                  * SELECT * FROM recentchanges WHERE rc_timestamp > $start
 152                  *   AND rc_timestamp < $end AND rc_namespace = $namespace
 153                  */
 154                 $this->addTables( 'recentchanges' );
 155                 $this->addTimestampWhereRange( 'rc_timestamp', $params['dir'], $params['start'], $params['end'] );
 156
 157                 if ( !is_null( $params['continue'] ) ) {
 158                         $cont = explode( '|', $params['continue'] );
 159                         $this->dieContinueUsageIf( count( $cont ) != 2 );
 160                         $db = $this->getDB();
 161                         $timestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
 162                         $id = intval( $cont[1] );
 163                         $this->dieContinueUsageIf( $id != $cont[1] );
 164                         $op = $params['dir'] === 'older' ? '<' : '>';
 165                         $this->addWhere(
 166                                 "rc_timestamp $op $timestamp OR " .
 167                                 "(rc_timestamp = $timestamp AND " .
 168                                 "rc_id $op= $id)"
 169                         );
 170                 }
 171
 172                 $order = $params['dir'] === 'older' ? 'DESC' : 'ASC';
 173                 $this->addOption( 'ORDER BY', [
 174                         "rc_timestamp $order",
 175                         "rc_id $order",
 176                 ] );
 177
 178                 $this->addWhereFld( 'rc_namespace', $params['namespace'] );
 179
 180                 if ( !is_null( $params['type'] ) ) {
 181                         try {
 182                                 $this->addWhereFld( 'rc_type', RecentChange::parseToRCType( $params['type'] ) );
 183                         } catch ( Exception $e ) {
 184                                 ApiBase::dieDebug( __METHOD__, $e->getMessage() );
 185                         }
 186                 }
 187
 188                 $title = $params['title'];
 189                 if ( !is_null( $title ) ) {
 190                         $titleObj = Title::newFromText( $title );
 191                         if ( is_null( $titleObj ) ) {
 192                                 $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $title ) ] );
 193                         }
 194                         $this->addWhereFld( 'rc_namespace', $titleObj->getNamespace() );
 195                         $this->addWhereFld( 'rc_title', $titleObj->getDBkey() );
 196                 }
 197
 198                 if ( !is_null( $params['show'] ) ) {
 199                         $show = array_flip( $params['show'] );
 200
 201                         /* Check for conflicting parameters. */
 202                         if ( ( isset( $show['minor'] ) && isset( $show['!minor'] ) )
 203                                 || ( isset( $show['bot'] ) && isset( $show['!bot'] ) )
 204                                 || ( isset( $show['anon'] ) && isset( $show['!anon'] ) )
 205                                 || ( isset( $show['redirect'] ) && isset( $show['!redirect'] ) )
 206                                 || ( isset( $show['patrolled'] ) && isset( $show['!patrolled'] ) )
 207                                 || ( isset( $show['patrolled'] ) && isset( $show['unpatrolled'] ) )
 208                                 || ( isset( $show['!patrolled'] ) && isset( $show['unpatrolled'] ) )
 209                                 || ( isset( $show['autopatrolled'] ) && isset( $show['!autopatrolled'] ) )
 210                                 || ( isset( $show['autopatrolled'] ) && isset( $show['unpatrolled'] ) )
 211                                 || ( isset( $show['autopatrolled'] ) && isset( $show['!patrolled'] ) )
 212                         ) {
 213                                 $this->dieWithError( 'apierror-show' );
 214                         }
 215
 216                         // Check permissions
 217                         if ( isset( $show['patrolled'] )
 218                                 || isset( $show['!patrolled'] )
 219                                 || isset( $show['unpatrolled'] )
 220                                 || isset( $show['autopatrolled'] )
 221                                 || isset( $show['!autopatrolled'] )
 222                         ) {
 223                                 if ( !$user->useRCPatrol() && !$user->useNPPatrol() ) {
 224                                         $this->dieWithError( 'apierror-permissiondenied-patrolflag', 'permissiondenied' );
 225                                 }
 226                         }
 227
 228                         /* Add additional conditions to query depending upon parameters. */
 229                         $this->addWhereIf( 'rc_minor = 0', isset( $show['!minor'] ) );
 230                         $this->addWhereIf( 'rc_minor != 0', isset( $show['minor'] ) );
 231                         $this->addWhereIf( 'rc_bot = 0', isset( $show['!bot'] ) );
 232                         $this->addWhereIf( 'rc_bot != 0', isset( $show['bot'] ) );
 233                         if ( isset( $show['anon'] ) || isset( $show['!anon'] ) ) {
 234                                 $actorMigration = ActorMigration::newMigration();
 235                                 $actorQuery = $actorMigration->getJoin( 'rc_user' );
 236                                 $this->addTables( $actorQuery['tables'] );
 237                                 $this->addJoinConds( $actorQuery['joins'] );
 238                                 $this->addWhereIf(
 239                                         $actorMigration->isAnon( $actorQuery['fields']['rc_user'] ), isset( $show['anon'] )
 240                                 );
 241                                 $this->addWhereIf(
 242                                         $actorMigration->isNotAnon( $actorQuery['fields']['rc_user'] ), isset( $show['!anon'] )
 243                                 );
 244                         }
 245                         $this->addWhereIf( 'rc_patrolled = 0', isset( $show['!patrolled'] ) );
 246                         $this->addWhereIf( 'rc_patrolled != 0', isset( $show['patrolled'] ) );
 247                         $this->addWhereIf( 'page_is_redirect = 1', isset( $show['redirect'] ) );
 248
 249                         if ( isset( $show['unpatrolled'] ) ) {
 250                                 // See ChangesList::isUnpatrolled
 251                                 if ( $user->useRCPatrol() ) {
 252                                         $this->addWhere( 'rc_patrolled = ' . RecentChange::PRC_UNPATROLLED );
 253                                 } elseif ( $user->useNPPatrol() ) {
 254                                         $this->addWhere( 'rc_patrolled = ' . RecentChange::PRC_UNPATROLLED );
 255                                         $this->addWhereFld( 'rc_type', RC_NEW );
 256                                 }
 257                         }
 258
 259                         $this->addWhereIf(
 260                                 'rc_patrolled != ' . RecentChange::PRC_AUTOPATROLLED,
 261                                 isset( $show['!autopatrolled'] )
 262                         );
 263                         $this->addWhereIf(
 264                                 'rc_patrolled = ' . RecentChange::PRC_AUTOPATROLLED,
 265                                 isset( $show['autopatrolled'] )
 266                         );
 267
 268                         // Don't throw log entries out the window here
 269                         $this->addWhereIf(
 270                                 'page_is_redirect = 0 OR page_is_redirect IS NULL',
 271                                 isset( $show['!redirect'] )
 272                         );
 273                 }
 274
 275                 $this->requireMaxOneParameter( $params, 'user', 'excludeuser' );
 276
 277                 if ( !is_null( $params['user'] ) ) {
 278                         // Don't query by user ID here, it might be able to use the rc_user_text index.
 279                         $actorQuery = ActorMigration::newMigration()
 280                                 ->getWhere( $this->getDB(), 'rc_user', User::newFromName( $params['user'], false ), false );
 281                         $this->addTables( $actorQuery['tables'] );
 282                         $this->addJoinConds( $actorQuery['joins'] );
 283                         $this->addWhere( $actorQuery['conds'] );
 284                 }
 285
 286                 if ( !is_null( $params['excludeuser'] ) ) {
 287                         // Here there's no chance to use the rc_user_text index, so allow ID to be used.
 288                         $actorQuery = ActorMigration::newMigration()
 289                                 ->getWhere( $this->getDB(), 'rc_user', User::newFromName( $params['excludeuser'], false ) );
 290                         $this->addTables( $actorQuery['tables'] );
 291                         $this->addJoinConds( $actorQuery['joins'] );
 292                         $this->addWhere( 'NOT(' . $actorQuery['conds'] . ')' );
 293                 }
 294
 295                 /* Add the fields we're concerned with to our query. */
 296                 $this->addFields( [
 297                         'rc_id',
 298                         'rc_timestamp',
 299                         'rc_namespace',
 300                         'rc_title',
 301                         'rc_cur_id',
 302                         'rc_type',
 303                         'rc_deleted'
 304                 ] );
 305
 306                 $showRedirects = false;
 307                 /* Determine what properties we need to display. */
 308                 if ( !is_null( $params['prop'] ) ) {
 309                         $prop = array_flip( $params['prop'] );
 310
 311                         /* Set up internal members based upon params. */
 312                         $this->initProperties( $prop );
 313
 314                         if ( $this->fld_patrolled && !$user->useRCPatrol() && !$user->useNPPatrol() ) {
 315                                 $this->dieWithError( 'apierror-permissiondenied-patrolflag', 'permissiondenied' );
 316                         }
 317
 318                         /* Add fields to our query if they are specified as a needed parameter. */
 319                         $this->addFieldsIf( [ 'rc_this_oldid', 'rc_last_oldid' ], $this->fld_ids );
 320                         if ( $this->fld_user || $this->fld_userid ) {
 321                                 $actorQuery = ActorMigration::newMigration()->getJoin( 'rc_user' );
 322                                 $this->addTables( $actorQuery['tables'] );
 323                                 $this->addFields( $actorQuery['fields'] );
 324                                 $this->addJoinConds( $actorQuery['joins'] );
 325                         }
 326                         $this->addFieldsIf( [ 'rc_minor', 'rc_type', 'rc_bot' ], $this->fld_flags );
 327                         $this->addFieldsIf( [ 'rc_old_len', 'rc_new_len' ], $this->fld_sizes );
 328                         $this->addFieldsIf( [ 'rc_patrolled', 'rc_log_type' ], $this->fld_patrolled );
 329                         $this->addFieldsIf(
 330                                 [ 'rc_logid', 'rc_log_type', 'rc_log_action', 'rc_params' ],
 331                                 $this->fld_loginfo
 332                         );
 333                         $showRedirects = $this->fld_redirect || isset( $show['redirect'] )
 334                                 || isset( $show['!redirect'] );
 335                 }
 336                 $this->addFieldsIf( [ 'rc_this_oldid' ],
 337                         $resultPageSet && $params['generaterevisions'] );
 338
 339                 if ( $this->fld_tags ) {
 340                         $this->addFields( [ 'ts_tags' => ChangeTags::makeTagSummarySubquery( 'recentchanges' ) ] );
 341                 }
 342
 343                 if ( $this->fld_sha1 ) {
 344                         $this->addTables( 'revision' );
 345                         $this->addJoinConds( [ 'revision' => [ 'LEFT JOIN',
 346                                 [ 'rc_this_oldid=rev_id' ] ] ] );
 347                         $this->addFields( [ 'rev_sha1', 'rev_deleted' ] );
 348                 }
 349
 350                 if ( $params['toponly'] || $showRedirects ) {
 351                         $this->addTables( 'page' );
 352                         $this->addJoinConds( [ 'page' => [ 'LEFT JOIN',
 353                                 [ 'rc_namespace=page_namespace', 'rc_title=page_title' ] ] ] );
 354                         $this->addFields( 'page_is_redirect' );
 355
 356                         if ( $params['toponly'] ) {
 357                                 $this->addWhere( 'rc_this_oldid = page_latest' );
 358                         }
 359                 }
 360
 361                 if ( !is_null( $params['tag'] ) ) {
 362                         $this->addTables( 'change_tag' );
 363                         $this->addJoinConds( [ 'change_tag' => [ 'INNER JOIN', [ 'rc_id=ct_rc_id' ] ] ] );
 364                         $changeTagDefStore = MediaWikiServices::getInstance()->getChangeTagDefStore();
 365                         try {
 366                                 $this->addWhereFld( 'ct_tag_id', $changeTagDefStore->getId( $params['tag'] ) );
 367                         } catch ( NameTableAccessException $exception ) {
 368                                 // Return nothing.
 369                                 $this->addWhere( '1=0' );
 370                         }
 371                 }
 372
 373                 // Paranoia: avoid brute force searches (T19342)
 374                 if ( !is_null( $params['user'] ) || !is_null( $params['excludeuser'] ) ) {
 375                         if ( !$user->isAllowed( 'deletedhistory' ) ) {
 376                                 $bitmask = RevisionRecord::DELETED_USER;
 377                         } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
 378                                 $bitmask = RevisionRecord::DELETED_USER | RevisionRecord::DELETED_RESTRICTED;
 379                         } else {
 380                                 $bitmask = 0;
 381                         }
 382                         if ( $bitmask ) {
 383                                 $this->addWhere( $this->getDB()->bitAnd( 'rc_deleted', $bitmask ) . " != $bitmask" );
 384                         }
 385                 }
 386                 if ( $this->getRequest()->getCheck( 'namespace' ) ) {
 387                         // LogPage::DELETED_ACTION hides the affected page, too.
 388                         if ( !$user->isAllowed( 'deletedhistory' ) ) {
 389                                 $bitmask = LogPage::DELETED_ACTION;
 390                         } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
 391                                 $bitmask = LogPage::DELETED_ACTION | LogPage::DELETED_RESTRICTED;
 392                         } else {
 393                                 $bitmask = 0;
 394                         }
 395                         if ( $bitmask ) {
 396                                 $this->addWhere( $this->getDB()->makeList( [
 397                                         'rc_type != ' . RC_LOG,
 398                                         $this->getDB()->bitAnd( 'rc_deleted', $bitmask ) . " != $bitmask",
 399                                 ], LIST_OR ) );
 400                         }
 401                 }
 402
 403                 $this->token = $params['token'];
 404
 405                 if ( $this->fld_comment || $this->fld_parsedcomment || $this->token ) {
 406                         $this->commentStore = CommentStore::getStore();
 407                         $commentQuery = $this->commentStore->getJoin( 'rc_comment' );
 408                         $this->addTables( $commentQuery['tables'] );
 409                         $this->addFields( $commentQuery['fields'] );
 410                         $this->addJoinConds( $commentQuery['joins'] );
 411                 }
 412
 413                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
 414
 415                 $hookData = [];
 416                 $count = 0;
 417                 /* Perform the actual query. */
 418                 $res = $this->select( __METHOD__, [], $hookData );
 419
 420                 $revids = [];
 421                 $titles = [];
 422
 423                 $result = $this->getResult();
 424
 425                 /* Iterate through the rows, adding data extracted from them to our query result. */
 426                 foreach ( $res as $row ) {
 427                         if ( $count === 0 && $resultPageSet !== null ) {
 428                                 // Set the non-continue since the list of recentchanges is
 429                                 // prone to having entries added at the start frequently.
 430                                 $this->getContinuationManager()->addGeneratorNonContinueParam(
 431                                         $this, 'continue', "$row->rc_timestamp|$row->rc_id"
 432                                 );
 433                         }
 434                         if ( ++$count > $params['limit'] ) {
 435                                 // We've reached the one extra which shows that there are
 436                                 // additional pages to be had. Stop here...
 437                                 $this->setContinueEnumParameter( 'continue', "$row->rc_timestamp|$row->rc_id" );
 438                                 break;
 439                         }
 440
 441                         if ( is_null( $resultPageSet ) ) {
 442                                 /* Extract the data from a single row. */
 443                                 $vals = $this->extractRowInfo( $row );
 444
 445                                 /* Add that row's data to our final output. */
 446                                 $fit = $this->processRow( $row, $vals, $hookData ) &&
 447                                         $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
 448                                 if ( !$fit ) {
 449                                         $this->setContinueEnumParameter( 'continue', "$row->rc_timestamp|$row->rc_id" );
 450                                         break;
 451                                 }
 452                         } elseif ( $params['generaterevisions'] ) {
 453                                 $revid = (int)$row->rc_this_oldid;
 454                                 if ( $revid > 0 ) {
 455                                         $revids[] = $revid;
 456                                 }
 457                         } else {
 458                                 $titles[] = Title::makeTitle( $row->rc_namespace, $row->rc_title );
 459                         }
 460                 }
 461
 462                 if ( is_null( $resultPageSet ) ) {
 463                         /* Format the result */
 464                         $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'rc' );
 465                 } elseif ( $params['generaterevisions'] ) {
 466                         $resultPageSet->populateFromRevisionIDs( $revids );
 467                 } else {
 468                         $resultPageSet->populateFromTitles( $titles );
 469                 }
 470         }
 471
 472         /**
 473          * Extracts from a single sql row the data needed to describe one recent change.
 474          *
 475          * @param stdClass $row The row from which to extract the data.
 476          * @return array An array mapping strings (descriptors) to their respective string values.
 477          * @access public
 478          */
 479         public function extractRowInfo( $row ) {
 480                 /* Determine the title of the page that has been changed. */
 481                 $title = Title::makeTitle( $row->rc_namespace, $row->rc_title );
 482                 $user = $this->getUser();
 483
 484                 /* Our output data. */
 485                 $vals = [];
 486
 487                 $type = intval( $row->rc_type );
 488                 $vals['type'] = RecentChange::parseFromRCType( $type );
 489
 490                 $anyHidden = false;
 491
 492                 /* Create a new entry in the result for the title. */
 493                 if ( $this->fld_title || $this->fld_ids ) {
 494                         if ( $type === RC_LOG && ( $row->rc_deleted & LogPage::DELETED_ACTION ) ) {
 495                                 $vals['actionhidden'] = true;
 496                                 $anyHidden = true;
 497                         }
 498                         if ( $type !== RC_LOG ||
 499                                 LogEventsList::userCanBitfield( $row->rc_deleted, LogPage::DELETED_ACTION, $user )
 500                         ) {
 501                                 if ( $this->fld_title ) {
 502                                         ApiQueryBase::addTitleInfo( $vals, $title );
 503                                 }
 504                                 if ( $this->fld_ids ) {
 505                                         $vals['pageid'] = intval( $row->rc_cur_id );
 506                                         $vals['revid'] = intval( $row->rc_this_oldid );
 507                                         $vals['old_revid'] = intval( $row->rc_last_oldid );
 508                                 }
 509                         }
 510                 }
 511
 512                 if ( $this->fld_ids ) {
 513                         $vals['rcid'] = intval( $row->rc_id );
 514                 }
 515
 516                 /* Add user data and 'anon' flag, if user is anonymous. */
 517                 if ( $this->fld_user || $this->fld_userid ) {
 518                         if ( $row->rc_deleted & RevisionRecord::DELETED_USER ) {
 519                                 $vals['userhidden'] = true;
 520                                 $anyHidden = true;
 521                         }
 522                         if ( RevisionRecord::userCanBitfield( $row->rc_deleted, RevisionRecord::DELETED_USER, $user ) ) {
 523                                 if ( $this->fld_user ) {
 524                                         $vals['user'] = $row->rc_user_text;
 525                                 }
 526
 527                                 if ( $this->fld_userid ) {
 528                                         $vals['userid'] = (int)$row->rc_user;
 529                                 }
 530
 531                                 if ( !$row->rc_user ) {
 532                                         $vals['anon'] = true;
 533                                 }
 534                         }
 535                 }
 536
 537                 /* Add flags, such as new, minor, bot. */
 538                 if ( $this->fld_flags ) {
 539                         $vals['bot'] = (bool)$row->rc_bot;
 540                         $vals['new'] = $row->rc_type == RC_NEW;
 541                         $vals['minor'] = (bool)$row->rc_minor;
 542                 }
 543
 544                 /* Add sizes of each revision. (Only available on 1.10+) */
 545                 if ( $this->fld_sizes ) {
 546                         $vals['oldlen'] = intval( $row->rc_old_len );
 547                         $vals['newlen'] = intval( $row->rc_new_len );
 548                 }
 549
 550                 /* Add the timestamp. */
 551                 if ( $this->fld_timestamp ) {
 552                         $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->rc_timestamp );
 553                 }
 554
 555                 /* Add edit summary / log summary. */
 556                 if ( $this->fld_comment || $this->fld_parsedcomment ) {
 557                         if ( $row->rc_deleted & RevisionRecord::DELETED_COMMENT ) {
 558                                 $vals['commenthidden'] = true;
 559                                 $anyHidden = true;
 560                         }
 561                         if ( RevisionRecord::userCanBitfield(
 562                                 $row->rc_deleted, RevisionRecord::DELETED_COMMENT, $user
 563                         ) ) {
 564                                 $comment = $this->commentStore->getComment( 'rc_comment', $row )->text;
 565                                 if ( $this->fld_comment ) {
 566                                         $vals['comment'] = $comment;
 567                                 }
 568
 569                                 if ( $this->fld_parsedcomment ) {
 570                                         $vals['parsedcomment'] = Linker::formatComment( $comment, $title );
 571                                 }
 572                         }
 573                 }
 574
 575                 if ( $this->fld_redirect ) {
 576                         $vals['redirect'] = (bool)$row->page_is_redirect;
 577                 }
 578
 579                 /* Add the patrolled flag */
 580                 if ( $this->fld_patrolled ) {
 581                         $vals['patrolled'] = $row->rc_patrolled != RecentChange::PRC_UNPATROLLED;
 582                         $vals['unpatrolled'] = ChangesList::isUnpatrolled( $row, $user );
 583                         $vals['autopatrolled'] = $row->rc_patrolled == RecentChange::PRC_AUTOPATROLLED;
 584                 }
 585
 586                 if ( $this->fld_loginfo && $row->rc_type == RC_LOG ) {
 587                         if ( $row->rc_deleted & LogPage::DELETED_ACTION ) {
 588                                 $vals['actionhidden'] = true;
 589                                 $anyHidden = true;
 590                         }
 591                         if ( LogEventsList::userCanBitfield( $row->rc_deleted, LogPage::DELETED_ACTION, $user ) ) {
 592                                 $vals['logid'] = intval( $row->rc_logid );
 593                                 $vals['logtype'] = $row->rc_log_type;
 594                                 $vals['logaction'] = $row->rc_log_action;
 595                                 $vals['logparams'] = LogFormatter::newFromRow( $row )->formatParametersForApi();
 596                         }
 597                 }
 598
 599                 if ( $this->fld_tags ) {
 600                         if ( $row->ts_tags ) {
 601                                 $tags = explode( ',', $row->ts_tags );
 602                                 ApiResult::setIndexedTagName( $tags, 'tag' );
 603                                 $vals['tags'] = $tags;
 604                         } else {
 605                                 $vals['tags'] = [];
 606                         }
 607                 }
 608
 609                 if ( $this->fld_sha1 && $row->rev_sha1 !== null ) {
 610                         if ( $row->rev_deleted & RevisionRecord::DELETED_TEXT ) {
 611                                 $vals['sha1hidden'] = true;
 612                                 $anyHidden = true;
 613                         }
 614                         if ( RevisionRecord::userCanBitfield(
 615                                 $row->rev_deleted, RevisionRecord::DELETED_TEXT, $user
 616                         ) ) {
 617                                 if ( $row->rev_sha1 !== '' ) {
 618                                         $vals['sha1'] = Wikimedia\base_convert( $row->rev_sha1, 36, 16, 40 );
 619                                 } else {
 620                                         $vals['sha1'] = '';
 621                                 }
 622                         }
 623                 }
 624
 625                 if ( !is_null( $this->token ) ) {
 626                         $tokenFunctions = $this->getTokenFunctions();
 627                         foreach ( $this->token as $t ) {
 628                                 $val = call_user_func( $tokenFunctions[$t], $row->rc_cur_id,
 629                                         $title, RecentChange::newFromRow( $row ) );
 630                                 if ( $val === false ) {
 631                                         $this->addWarning( [ 'apiwarn-tokennotallowed', $t ] );
 632                                 } else {
 633                                         $vals[$t . 'token'] = $val;
 634                                 }
 635                         }
 636                 }
 637
 638                 if ( $anyHidden && ( $row->rc_deleted & RevisionRecord::DELETED_RESTRICTED ) ) {
 639                         $vals['suppressed'] = true;
 640                 }
 641
 642                 return $vals;
 643         }
 644
 645         public function getCacheMode( $params ) {
 646                 if ( isset( $params['show'] ) ) {
 647                         foreach ( $params['show'] as $show ) {
 648                                 if ( $show === 'patrolled' || $show === '!patrolled' ) {
 649                                         return 'private';
 650                                 }
 651                         }
 652                 }
 653                 if ( isset( $params['token'] ) ) {
 654                         return 'private';
 655                 }
 656                 if ( $this->userCanSeeRevDel() ) {
 657                         return 'private';
 658                 }
 659                 if ( !is_null( $params['prop'] ) && in_array( 'parsedcomment', $params['prop'] ) ) {
 660                         // formatComment() calls wfMessage() among other things
 661                         return 'anon-public-user-private';
 662                 }
 663
 664                 return 'public';
 665         }
 666
 667         public function getAllowedParams() {
 668                 return [
 669                         'start' => [
 670                                 ApiBase::PARAM_TYPE => 'timestamp'
 671                         ],
 672                         'end' => [
 673                                 ApiBase::PARAM_TYPE => 'timestamp'
 674                         ],
 675                         'dir' => [
 676                                 ApiBase::PARAM_DFLT => 'older',
 677                                 ApiBase::PARAM_TYPE => [
 678                                         'newer',
 679                                         'older'
 680                                 ],
 681                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
 682                         ],
 683                         'namespace' => [
 684                                 ApiBase::PARAM_ISMULTI => true,
 685                                 ApiBase::PARAM_TYPE => 'namespace',
 686                                 ApiBase::PARAM_EXTRA_NAMESPACES => [ NS_MEDIA, NS_SPECIAL ],
 687                         ],
 688                         'user' => [
 689                                 ApiBase::PARAM_TYPE => 'user'
 690                         ],
 691                         'excludeuser' => [
 692                                 ApiBase::PARAM_TYPE => 'user'
 693                         ],
 694                         'tag' => null,
 695                         'prop' => [
 696                                 ApiBase::PARAM_ISMULTI => true,
 697                                 ApiBase::PARAM_DFLT => 'title|timestamp|ids',
 698                                 ApiBase::PARAM_TYPE => [
 699                                         'user',
 700                                         'userid',
 701                                         'comment',
 702                                         'parsedcomment',
 703                                         'flags',
 704                                         'timestamp',
 705                                         'title',
 706                                         'ids',
 707                                         'sizes',
 708                                         'redirect',
 709                                         'patrolled',
 710                                         'loginfo',
 711                                         'tags',
 712                                         'sha1',
 713                                 ],
 714                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
 715                         ],
 716                         'token' => [
 717                                 ApiBase::PARAM_DEPRECATED => true,
 718                                 ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() ),
 719                                 ApiBase::PARAM_ISMULTI => true
 720                         ],
 721                         'show' => [
 722                                 ApiBase::PARAM_ISMULTI => true,
 723                                 ApiBase::PARAM_TYPE => [
 724                                         'minor',
 725                                         '!minor',
 726                                         'bot',
 727                                         '!bot',
 728                                         'anon',
 729                                         '!anon',
 730                                         'redirect',
 731                                         '!redirect',
 732                                         'patrolled',
 733                                         '!patrolled',
 734                                         'unpatrolled',
 735                                         'autopatrolled',
 736                                         '!autopatrolled',
 737                                 ]
 738                         ],
 739                         'limit' => [
 740                                 ApiBase::PARAM_DFLT => 10,
 741                                 ApiBase::PARAM_TYPE => 'limit',
 742                                 ApiBase::PARAM_MIN => 1,
 743                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 744                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 745                         ],
 746                         'type' => [
 747                                 ApiBase::PARAM_DFLT => 'edit|new|log|categorize',
 748                                 ApiBase::PARAM_ISMULTI => true,
 749                                 ApiBase::PARAM_TYPE => RecentChange::getChangeTypes()
 750                         ],
 751                         'toponly' => false,
 752                         'title' => null,
 753                         'continue' => [
 754                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 755                         ],
 756                         'generaterevisions' => false,
 757                 ];
 758         }
 759
 760         protected function getExamplesMessages() {
 761                 return [
 762                         'action=query&list=recentchanges'
 763                                 => 'apihelp-query+recentchanges-example-simple',
 764                         'action=query&generator=recentchanges&grcshow=!patrolled&prop=info'
 765                                 => 'apihelp-query+recentchanges-example-generator',
 766                 ];
 767         }
 768
 769         public function getHelpUrls() {
 770                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Recentchanges';
 771         }
 772 }