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