includes/changes/RecentChange.php

   1 <?php
   2 /**
   3  * Utility class for creating and accessing recent change entries.
   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 use MediaWiki\ChangeTags\Taggable;
  23 use MediaWiki\MediaWikiServices;
  24
  25 /**
  26  * Utility class for creating new RC entries
  27  *
  28  * mAttribs:
  29  *  rc_id           id of the row in the recentchanges table
  30  *  rc_timestamp    time the entry was made
  31  *  rc_namespace    namespace #
  32  *  rc_title        non-prefixed db key
  33  *  rc_type         is new entry, used to determine whether updating is necessary
  34  *  rc_source       string representation of change source
  35  *  rc_minor        is minor
  36  *  rc_cur_id       page_id of associated page entry
  37  *  rc_user         user id who made the entry
  38  *  rc_user_text    user name who made the entry
  39  *  rc_actor        actor id who made the entry
  40  *  rc_comment      edit summary
  41  *  rc_this_oldid   rev_id associated with this entry (or zero)
  42  *  rc_last_oldid   rev_id associated with the entry before this one (or zero)
  43  *  rc_bot          is bot, hidden
  44  *  rc_ip           IP address of the user in dotted quad notation
  45  *  rc_new          obsolete, use rc_type==RC_NEW
  46  *  rc_patrolled    boolean whether or not someone has marked this edit as patrolled
  47  *  rc_old_len      integer byte length of the text before the edit
  48  *  rc_new_len      the same after the edit
  49  *  rc_deleted      partial deletion
  50  *  rc_logid        the log_id value for this log entry (or zero)
  51  *  rc_log_type     the log type (or null)
  52  *  rc_log_action   the log action (or null)
  53  *  rc_params       log params
  54  *
  55  * mExtra:
  56  *  prefixedDBkey   prefixed db key, used by external app via msg queue
  57  *  lastTimestamp   timestamp of previous entry, used in WHERE clause during update
  58  *  oldSize         text size before the change
  59  *  newSize         text size after the change
  60  *  pageStatus      status of the page: created, deleted, moved, restored, changed
  61  *
  62  * temporary:       not stored in the database
  63  *      notificationtimestamp
  64  *      numberofWatchingusers
  65  *
  66  * @todo Deprecate access to mAttribs (direct or via getAttributes). Right now
  67  *  we're having to include both rc_comment and rc_comment_text/rc_comment_data
  68  *  so random crap works right.
  69  */
  70 class RecentChange implements Taggable {
  71         // Constants for the rc_source field.  Extensions may also have
  72         // their own source constants.
  73         const SRC_EDIT = 'mw.edit';
  74         const SRC_NEW = 'mw.new';
  75         const SRC_LOG = 'mw.log';
  76         const SRC_EXTERNAL = 'mw.external'; // obsolete
  77         const SRC_CATEGORIZE = 'mw.categorize';
  78
  79         const PRC_UNPATROLLED = 0;
  80         const PRC_PATROLLED = 1;
  81         const PRC_AUTOPATROLLED = 2;
  82
  83         /**
  84          * @var bool For save() - save to the database only, without any events.
  85          */
  86         const SEND_NONE = true;
  87
  88         /**
  89          * @var bool For save() - do emit the change to RCFeeds (usually public).
  90          */
  91         const SEND_FEED = false;
  92
  93         public $mAttribs = [];
  94         public $mExtra = [];
  95
  96         /**
  97          * @var Title|false
  98          */
  99         public $mTitle = false;
 100
 101         /**
 102          * @var User|false
 103          */
 104         private $mPerformer = false;
 105
 106         public $numberofWatchingusers = 0; # Dummy to prevent error message in SpecialRecentChangesLinked
 107         public $notificationtimestamp;
 108
 109         /**
 110          * @var int Line number of recent change. Default -1.
 111          */
 112         public $counter = -1;
 113
 114         /**
 115          * @var array List of tags to apply
 116          */
 117         private $tags = [];
 118
 119         /**
 120          * @var array Array of change types
 121          */
 122         private static $changeTypes = [
 123                 'edit' => RC_EDIT,
 124                 'new' => RC_NEW,
 125                 'log' => RC_LOG,
 126                 'external' => RC_EXTERNAL,
 127                 'categorize' => RC_CATEGORIZE,
 128         ];
 129
 130         # Factory methods
 131
 132         /**
 133          * @param mixed $row
 134          * @return RecentChange
 135          */
 136         public static function newFromRow( $row ) {
 137                 $rc = new RecentChange;
 138                 $rc->loadFromRow( $row );
 139
 140                 return $rc;
 141         }
 142
 143         /**
 144          * Parsing text to RC_* constants
 145          * @since 1.24
 146          * @param string|array $type
 147          * @throws MWException
 148          * @return int|array RC_TYPE
 149          */
 150         public static function parseToRCType( $type ) {
 151                 if ( is_array( $type ) ) {
 152                         $retval = [];
 153                         foreach ( $type as $t ) {
 154                                 $retval[] = self::parseToRCType( $t );
 155                         }
 156
 157                         return $retval;
 158                 }
 159
 160                 if ( !array_key_exists( $type, self::$changeTypes ) ) {
 161                         throw new MWException( "Unknown type '$type'" );
 162                 }
 163                 return self::$changeTypes[$type];
 164         }
 165
 166         /**
 167          * Parsing RC_* constants to human-readable test
 168          * @since 1.24
 169          * @param int $rcType
 170          * @return string $type
 171          */
 172         public static function parseFromRCType( $rcType ) {
 173                 return array_search( $rcType, self::$changeTypes, true ) ?: "$rcType";
 174         }
 175
 176         /**
 177          * Get an array of all change types
 178          *
 179          * @since 1.26
 180          *
 181          * @return array
 182          */
 183         public static function getChangeTypes() {
 184                 return array_keys( self::$changeTypes );
 185         }
 186
 187         /**
 188          * Obtain the recent change with a given rc_id value
 189          *
 190          * @param int $rcid The rc_id value to retrieve
 191          * @return RecentChange|null
 192          */
 193         public static function newFromId( $rcid ) {
 194                 return self::newFromConds( [ 'rc_id' => $rcid ], __METHOD__ );
 195         }
 196
 197         /**
 198          * Find the first recent change matching some specific conditions
 199          *
 200          * @param array $conds Array of conditions
 201          * @param mixed $fname Override the method name in profiling/logs
 202          * @param int $dbType DB_* constant
 203          *
 204          * @return RecentChange|null
 205          */
 206         public static function newFromConds(
 207                 $conds,
 208                 $fname = __METHOD__,
 209                 $dbType = DB_REPLICA
 210         ) {
 211                 $db = wfGetDB( $dbType );
 212                 $rcQuery = self::getQueryInfo();
 213                 $row = $db->selectRow(
 214                         $rcQuery['tables'], $rcQuery['fields'], $conds, $fname, [], $rcQuery['joins']
 215                 );
 216                 if ( $row !== false ) {
 217                         return self::newFromRow( $row );
 218                 } else {
 219                         return null;
 220                 }
 221         }
 222
 223         /**
 224          * Return the list of recentchanges fields that should be selected to create
 225          * a new recentchanges object.
 226          * @deprecated since 1.31, use self::getQueryInfo() instead.
 227          * @return array
 228          */
 229         public static function selectFields() {
 230                 global $wgActorTableSchemaMigrationStage;
 231
 232                 wfDeprecated( __METHOD__, '1.31' );
 233                 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW ) {
 234                         // If code is using this instead of self::getQueryInfo(), there's a
 235                         // decent chance it's going to try to directly access
 236                         // $row->rc_user or $row->rc_user_text and we can't give it
 237                         // useful values here once those aren't being used anymore.
 238                         throw new BadMethodCallException(
 239                                 'Cannot use ' . __METHOD__
 240                                         . ' when $wgActorTableSchemaMigrationStage has SCHEMA_COMPAT_READ_NEW'
 241                         );
 242                 }
 243
 244                 return [
 245                         'rc_id',
 246                         'rc_timestamp',
 247                         'rc_user',
 248                         'rc_user_text',
 249                         'rc_actor' => 'NULL',
 250                         'rc_namespace',
 251                         'rc_title',
 252                         'rc_minor',
 253                         'rc_bot',
 254                         'rc_new',
 255                         'rc_cur_id',
 256                         'rc_this_oldid',
 257                         'rc_last_oldid',
 258                         'rc_type',
 259                         'rc_source',
 260                         'rc_patrolled',
 261                         'rc_ip',
 262                         'rc_old_len',
 263                         'rc_new_len',
 264                         'rc_deleted',
 265                         'rc_logid',
 266                         'rc_log_type',
 267                         'rc_log_action',
 268                         'rc_params',
 269                 ] + CommentStore::getStore()->getFields( 'rc_comment' );
 270         }
 271
 272         /**
 273          * Return the tables, fields, and join conditions to be selected to create
 274          * a new recentchanges object.
 275          * @since 1.31
 276          * @return array With three keys:
 277          *   - tables: (string[]) to include in the `$table` to `IDatabase->select()`
 278          *   - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
 279          *   - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
 280          */
 281         public static function getQueryInfo() {
 282                 $commentQuery = CommentStore::getStore()->getJoin( 'rc_comment' );
 283                 $actorQuery = ActorMigration::newMigration()->getJoin( 'rc_user' );
 284                 return [
 285                         'tables' => [ 'recentchanges' ] + $commentQuery['tables'] + $actorQuery['tables'],
 286                         'fields' => [
 287                                 'rc_id',
 288                                 'rc_timestamp',
 289                                 'rc_namespace',
 290                                 'rc_title',
 291                                 'rc_minor',
 292                                 'rc_bot',
 293                                 'rc_new',
 294                                 'rc_cur_id',
 295                                 'rc_this_oldid',
 296                                 'rc_last_oldid',
 297                                 'rc_type',
 298                                 'rc_source',
 299                                 'rc_patrolled',
 300                                 'rc_ip',
 301                                 'rc_old_len',
 302                                 'rc_new_len',
 303                                 'rc_deleted',
 304                                 'rc_logid',
 305                                 'rc_log_type',
 306                                 'rc_log_action',
 307                                 'rc_params',
 308                         ] + $commentQuery['fields'] + $actorQuery['fields'],
 309                         'joins' => $commentQuery['joins'] + $actorQuery['joins'],
 310                 ];
 311         }
 312
 313         # Accessors
 314
 315         /**
 316          * @param array $attribs
 317          */
 318         public function setAttribs( $attribs ) {
 319                 $this->mAttribs = $attribs;
 320         }
 321
 322         /**
 323          * @param array $extra
 324          */
 325         public function setExtra( $extra ) {
 326                 $this->mExtra = $extra;
 327         }
 328
 329         /**
 330          * @return Title
 331          */
 332         public function &getTitle() {
 333                 if ( $this->mTitle === false ) {
 334                         $this->mTitle = Title::makeTitle( $this->mAttribs['rc_namespace'], $this->mAttribs['rc_title'] );
 335                 }
 336
 337                 return $this->mTitle;
 338         }
 339
 340         /**
 341          * Get the User object of the person who performed this change.
 342          *
 343          * @return User
 344          */
 345         public function getPerformer() {
 346                 if ( $this->mPerformer === false ) {
 347                         if ( !empty( $this->mAttribs['rc_actor'] ) ) {
 348                                 $this->mPerformer = User::newFromActorId( $this->mAttribs['rc_actor'] );
 349                         } elseif ( !empty( $this->mAttribs['rc_user'] ) ) {
 350                                 $this->mPerformer = User::newFromId( $this->mAttribs['rc_user'] );
 351                         } elseif ( !empty( $this->mAttribs['rc_user_text'] ) ) {
 352                                 $this->mPerformer = User::newFromName( $this->mAttribs['rc_user_text'], false );
 353                         } else {
 354                                 throw new MWException( 'RecentChange object lacks rc_actor, rc_user, and rc_user_text' );
 355                         }
 356                 }
 357
 358                 return $this->mPerformer;
 359         }
 360
 361         /**
 362          * Writes the data in this object to the database
 363          *
 364          * For compatibility reasons, the SEND_ constants internally reference a value
 365          * that may seem negated from their purpose (none=true, feed=false). This is
 366          * because the parameter used to be called "$noudp", defaulting to false.
 367          *
 368          * @param bool $send self::SEND_FEED or self::SEND_NONE
 369          */
 370         public function save( $send = self::SEND_FEED ) {
 371                 global $wgPutIPinRC, $wgUseEnotif, $wgShowUpdatedMarker;
 372
 373                 $dbw = wfGetDB( DB_MASTER );
 374                 if ( !is_array( $this->mExtra ) ) {
 375                         $this->mExtra = [];
 376                 }
 377
 378                 if ( !$wgPutIPinRC ) {
 379                         $this->mAttribs['rc_ip'] = '';
 380                 }
 381
 382                 # Strict mode fixups (not-NULL fields)
 383                 foreach ( [ 'minor', 'bot', 'new', 'patrolled', 'deleted' ] as $field ) {
 384                         $this->mAttribs["rc_$field"] = (int)$this->mAttribs["rc_$field"];
 385                 }
 386                 # ...more fixups (NULL fields)
 387                 foreach ( [ 'old_len', 'new_len' ] as $field ) {
 388                         $this->mAttribs["rc_$field"] = isset( $this->mAttribs["rc_$field"] )
 389                                 ? (int)$this->mAttribs["rc_$field"]
 390                                 : null;
 391                 }
 392
 393                 # If our database is strict about IP addresses, use NULL instead of an empty string
 394                 $strictIPs = $dbw->getType() === 'postgres'; // legacy
 395                 if ( $strictIPs && $this->mAttribs['rc_ip'] == '' ) {
 396                         unset( $this->mAttribs['rc_ip'] );
 397                 }
 398
 399                 # Trim spaces on user supplied text
 400                 $this->mAttribs['rc_comment'] = trim( $this->mAttribs['rc_comment'] );
 401
 402                 # Fixup database timestamps
 403                 $this->mAttribs['rc_timestamp'] = $dbw->timestamp( $this->mAttribs['rc_timestamp'] );
 404
 405                 # # If we are using foreign keys, an entry of 0 for the page_id will fail, so use NULL
 406                 if ( $this->mAttribs['rc_cur_id'] == 0 ) {
 407                         unset( $this->mAttribs['rc_cur_id'] );
 408                 }
 409
 410                 $row = $this->mAttribs;
 411
 412                 # Convert mAttribs['rc_comment'] for CommentStore
 413                 $comment = $row['rc_comment'];
 414                 unset( $row['rc_comment'], $row['rc_comment_text'], $row['rc_comment_data'] );
 415                 $row += CommentStore::getStore()->insert( $dbw, 'rc_comment', $comment );
 416
 417                 # Convert mAttribs['rc_user'] etc for ActorMigration
 418                 $user = User::newFromAnyId(
 419                         $row['rc_user'] ?? null,
 420                         $row['rc_user_text'] ?? null,
 421                         $row['rc_actor'] ?? null
 422                 );
 423                 unset( $row['rc_user'], $row['rc_user_text'], $row['rc_actor'] );
 424                 $row += ActorMigration::newMigration()->getInsertValues( $dbw, 'rc_user', $user );
 425
 426                 # Don't reuse an existing rc_id for the new row, if one happens to be
 427                 # set for some reason.
 428                 unset( $row['rc_id'] );
 429
 430                 # Insert new row
 431                 $dbw->insert( 'recentchanges', $row, __METHOD__ );
 432
 433                 # Set the ID
 434                 $this->mAttribs['rc_id'] = $dbw->insertId();
 435
 436                 # Notify extensions
 437                 // Avoid PHP 7.1 warning from passing $this by reference
 438                 $rc = $this;
 439                 Hooks::run( 'RecentChange_save', [ &$rc ] );
 440
 441                 if ( count( $this->tags ) ) {
 442                         ChangeTags::addTags( $this->tags, $this->mAttribs['rc_id'],
 443                                 $this->mAttribs['rc_this_oldid'], $this->mAttribs['rc_logid'], null, $this );
 444                 }
 445
 446                 if ( $send === self::SEND_FEED ) {
 447                         // Emit the change to external applications via RCFeeds.
 448                         $this->notifyRCFeeds();
 449                 }
 450
 451                 # E-mail notifications
 452                 if ( $wgUseEnotif || $wgShowUpdatedMarker ) {
 453                         $editor = $this->getPerformer();
 454                         $title = $this->getTitle();
 455
 456                         // Never send an RC notification email about categorization changes
 457                         if (
 458                                 Hooks::run( 'AbortEmailNotification', [ $editor, $title, $this ] ) &&
 459                                 $this->mAttribs['rc_type'] != RC_CATEGORIZE
 460                         ) {
 461                                 // @FIXME: This would be better as an extension hook
 462                                 // Send emails or email jobs once this row is safely committed
 463                                 $dbw->onTransactionCommitOrIdle(
 464                                         function () use ( $editor, $title ) {
 465                                                 $enotif = new EmailNotification();
 466                                                 $enotif->notifyOnPageChange(
 467                                                         $editor,
 468                                                         $title,
 469                                                         $this->mAttribs['rc_timestamp'],
 470                                                         $this->mAttribs['rc_comment'],
 471                                                         $this->mAttribs['rc_minor'],
 472                                                         $this->mAttribs['rc_last_oldid'],
 473                                                         $this->mExtra['pageStatus']
 474                                                 );
 475                                         },
 476                                         __METHOD__
 477                                 );
 478                         }
 479                 }
 480
 481                 // Update the cached list of active users
 482                 if ( $this->mAttribs['rc_user'] > 0 ) {
 483                         JobQueueGroup::singleton()->lazyPush( RecentChangesUpdateJob::newCacheUpdateJob() );
 484                 }
 485         }
 486
 487         /**
 488          * Notify all the feeds about the change.
 489          * @param array|null $feeds Optional feeds to send to, defaults to $wgRCFeeds
 490          */
 491         public function notifyRCFeeds( array $feeds = null ) {
 492                 global $wgRCFeeds;
 493                 if ( $feeds === null ) {
 494                         $feeds = $wgRCFeeds;
 495                 }
 496
 497                 $performer = $this->getPerformer();
 498
 499                 foreach ( $feeds as $params ) {
 500                         $params += [
 501                                 'omit_bots' => false,
 502                                 'omit_anon' => false,
 503                                 'omit_user' => false,
 504                                 'omit_minor' => false,
 505                                 'omit_patrolled' => false,
 506                         ];
 507
 508                         if (
 509                                 ( $params['omit_bots'] && $this->mAttribs['rc_bot'] ) ||
 510                                 ( $params['omit_anon'] && $performer->isAnon() ) ||
 511                                 ( $params['omit_user'] && !$performer->isAnon() ) ||
 512                                 ( $params['omit_minor'] && $this->mAttribs['rc_minor'] ) ||
 513                                 ( $params['omit_patrolled'] && $this->mAttribs['rc_patrolled'] ) ||
 514                                 $this->mAttribs['rc_type'] == RC_EXTERNAL
 515                         ) {
 516                                 continue;
 517                         }
 518
 519                         $actionComment = $this->mExtra['actionCommentIRC'] ?? null;
 520
 521                         $feed = RCFeed::factory( $params );
 522                         $feed->notify( $this, $actionComment );
 523                 }
 524         }
 525
 526         /**
 527          * @since 1.22
 528          * @deprecated since 1.29 Use RCFeed::factory() instead
 529          * @param string $uri URI to get the engine object for
 530          * @param array $params
 531          * @return RCFeedEngine The engine object
 532          * @throws MWException
 533          */
 534         public static function getEngine( $uri, $params = [] ) {
 535                 // TODO: Merge into RCFeed::factory().
 536                 global $wgRCEngines;
 537                 $scheme = parse_url( $uri, PHP_URL_SCHEME );
 538                 if ( !$scheme ) {
 539                         throw new MWException( "Invalid RCFeed uri: '$uri'" );
 540                 }
 541                 if ( !isset( $wgRCEngines[$scheme] ) ) {
 542                         throw new MWException( "Unknown RCFeedEngine scheme: '$scheme'" );
 543                 }
 544                 if ( defined( 'MW_PHPUNIT_TEST' ) && is_object( $wgRCEngines[$scheme] ) ) {
 545                         return $wgRCEngines[$scheme];
 546                 }
 547                 return new $wgRCEngines[$scheme]( $params );
 548         }
 549
 550         /**
 551          * Mark a given change as patrolled
 552          *
 553          * @param RecentChange|int $change RecentChange or corresponding rc_id
 554          * @param bool $auto For automatic patrol
 555          * @param string|string[]|null $tags Change tags to add to the patrol log entry
 556          *   ($user should be able to add the specified tags before this is called)
 557          * @return array See doMarkPatrolled(), or null if $change is not an existing rc_id
 558          */
 559         public static function markPatrolled( $change, $auto = false, $tags = null ) {
 560                 global $wgUser;
 561
 562                 $change = $change instanceof RecentChange
 563                         ? $change
 564                         : self::newFromId( $change );
 565
 566                 if ( !$change instanceof RecentChange ) {
 567                         return null;
 568                 }
 569
 570                 return $change->doMarkPatrolled( $wgUser, $auto, $tags );
 571         }
 572
 573         /**
 574          * Mark this RecentChange as patrolled
 575          *
 576          * NOTE: Can also return 'rcpatroldisabled', 'hookaborted' and
 577          * 'markedaspatrollederror-noautopatrol' as errors
 578          * @param User $user User object doing the action
 579          * @param bool $auto For automatic patrol
 580          * @param string|string[]|null $tags Change tags to add to the patrol log entry
 581          *   ($user should be able to add the specified tags before this is called)
 582          * @return array Array of permissions errors, see Title::getUserPermissionsErrors()
 583          */
 584         public function doMarkPatrolled( User $user, $auto = false, $tags = null ) {
 585                 global $wgUseRCPatrol, $wgUseNPPatrol, $wgUseFilePatrol;
 586
 587                 // Fix up $tags so that the MarkPatrolled hook below always gets an array
 588                 if ( $tags === null ) {
 589                         $tags = [];
 590                 } elseif ( is_string( $tags ) ) {
 591                         $tags = [ $tags ];
 592                 }
 593
 594                 $errors = [];
 595                 // If recentchanges patrol is disabled, only new pages or new file versions
 596                 // can be patrolled, provided the appropriate config variable is set
 597                 if ( !$wgUseRCPatrol && ( !$wgUseNPPatrol || $this->getAttribute( 'rc_type' ) != RC_NEW ) &&
 598                         ( !$wgUseFilePatrol || !( $this->getAttribute( 'rc_type' ) == RC_LOG &&
 599                         $this->getAttribute( 'rc_log_type' ) == 'upload' ) ) ) {
 600                         $errors[] = [ 'rcpatroldisabled' ];
 601                 }
 602                 // Automatic patrol needs "autopatrol", ordinary patrol needs "patrol"
 603                 $right = $auto ? 'autopatrol' : 'patrol';
 604                 $errors = array_merge( $errors, $this->getTitle()->getUserPermissionsErrors( $right, $user ) );
 605                 if ( !Hooks::run( 'MarkPatrolled',
 606                                         [ $this->getAttribute( 'rc_id' ), &$user, false, $auto, &$tags ] )
 607                 ) {
 608                         $errors[] = [ 'hookaborted' ];
 609                 }
 610                 // Users without the 'autopatrol' right can't patrol their
 611                 // own revisions
 612                 if ( $user->getName() === $this->getAttribute( 'rc_user_text' ) &&
 613                                 !MediaWikiServices::getInstance()->getPermissionManager()
 614                                         ->userHasRight( $user, 'autopatrol' )
 615                 ) {
 616                         $errors[] = [ 'markedaspatrollederror-noautopatrol' ];
 617                 }
 618                 if ( $errors ) {
 619                         return $errors;
 620                 }
 621                 // If the change was patrolled already, do nothing
 622                 if ( $this->getAttribute( 'rc_patrolled' ) ) {
 623                         return [];
 624                 }
 625                 // Actually set the 'patrolled' flag in RC
 626                 $this->reallyMarkPatrolled();
 627                 // Log this patrol event
 628                 PatrolLog::record( $this, $auto, $user, $tags );
 629
 630                 Hooks::run(
 631                         'MarkPatrolledComplete',
 632                         [ $this->getAttribute( 'rc_id' ), &$user, false, $auto ]
 633                 );
 634
 635                 return [];
 636         }
 637
 638         /**
 639          * Mark this RecentChange patrolled, without error checking
 640          * @return int Number of affected rows
 641          */
 642         public function reallyMarkPatrolled() {
 643                 $dbw = wfGetDB( DB_MASTER );
 644                 $dbw->update(
 645                         'recentchanges',
 646                         [
 647                                 'rc_patrolled' => self::PRC_PATROLLED
 648                         ],
 649                         [
 650                                 'rc_id' => $this->getAttribute( 'rc_id' )
 651                         ],
 652                         __METHOD__
 653                 );
 654                 // Invalidate the page cache after the page has been patrolled
 655                 // to make sure that the Patrol link isn't visible any longer!
 656                 $this->getTitle()->invalidateCache();
 657
 658                 return $dbw->affectedRows();
 659         }
 660
 661         /**
 662          * Makes an entry in the database corresponding to an edit
 663          *
 664          * @param string $timestamp
 665          * @param Title $title
 666          * @param bool $minor
 667          * @param User $user
 668          * @param string $comment
 669          * @param int $oldId
 670          * @param string $lastTimestamp
 671          * @param bool $bot
 672          * @param string $ip
 673          * @param int $oldSize
 674          * @param int $newSize
 675          * @param int $newId
 676          * @param int $patrol
 677          * @param array $tags
 678          * @return RecentChange
 679          */
 680         public static function notifyEdit(
 681                 $timestamp, $title, $minor, $user, $comment, $oldId, $lastTimestamp,
 682                 $bot, $ip = '', $oldSize = 0, $newSize = 0, $newId = 0, $patrol = 0,
 683                 $tags = []
 684         ) {
 685                 $rc = new RecentChange;
 686                 $rc->mTitle = $title;
 687                 $rc->mPerformer = $user;
 688                 $rc->mAttribs = [
 689                         'rc_timestamp' => $timestamp,
 690                         'rc_namespace' => $title->getNamespace(),
 691                         'rc_title' => $title->getDBkey(),
 692                         'rc_type' => RC_EDIT,
 693                         'rc_source' => self::SRC_EDIT,
 694                         'rc_minor' => $minor ? 1 : 0,
 695                         'rc_cur_id' => $title->getArticleID(),
 696                         'rc_user' => $user->getId(),
 697                         'rc_user_text' => $user->getName(),
 698                         'rc_actor' => $user->getActorId(),
 699                         'rc_comment' => &$comment,
 700                         'rc_comment_text' => &$comment,
 701                         'rc_comment_data' => null,
 702                         'rc_this_oldid' => $newId,
 703                         'rc_last_oldid' => $oldId,
 704                         'rc_bot' => $bot ? 1 : 0,
 705                         'rc_ip' => self::checkIPAddress( $ip ),
 706                         'rc_patrolled' => intval( $patrol ),
 707                         'rc_new' => 0, # obsolete
 708                         'rc_old_len' => $oldSize,
 709                         'rc_new_len' => $newSize,
 710                         'rc_deleted' => 0,
 711                         'rc_logid' => 0,
 712                         'rc_log_type' => null,
 713                         'rc_log_action' => '',
 714                         'rc_params' => ''
 715                 ];
 716
 717                 $rc->mExtra = [
 718                         'prefixedDBkey' => $title->getPrefixedDBkey(),
 719                         'lastTimestamp' => $lastTimestamp,
 720                         'oldSize' => $oldSize,
 721                         'newSize' => $newSize,
 722                         'pageStatus' => 'changed'
 723                 ];
 724
 725                 DeferredUpdates::addCallableUpdate(
 726                         function () use ( $rc, $tags ) {
 727                                 $rc->addTags( $tags );
 728                                 $rc->save();
 729                         },
 730                         DeferredUpdates::POSTSEND,
 731                         wfGetDB( DB_MASTER )
 732                 );
 733
 734                 return $rc;
 735         }
 736
 737         /**
 738          * Makes an entry in the database corresponding to page creation
 739          * Note: the title object must be loaded with the new id using resetArticleID()
 740          *
 741          * @param string $timestamp
 742          * @param Title $title
 743          * @param bool $minor
 744          * @param User $user
 745          * @param string $comment
 746          * @param bool $bot
 747          * @param string $ip
 748          * @param int $size
 749          * @param int $newId
 750          * @param int $patrol
 751          * @param array $tags
 752          * @return RecentChange
 753          */
 754         public static function notifyNew(
 755                 $timestamp, $title, $minor, $user, $comment, $bot,
 756                 $ip = '', $size = 0, $newId = 0, $patrol = 0, $tags = []
 757         ) {
 758                 $rc = new RecentChange;
 759                 $rc->mTitle = $title;
 760                 $rc->mPerformer = $user;
 761                 $rc->mAttribs = [
 762                         'rc_timestamp' => $timestamp,
 763                         'rc_namespace' => $title->getNamespace(),
 764                         'rc_title' => $title->getDBkey(),
 765                         'rc_type' => RC_NEW,
 766                         'rc_source' => self::SRC_NEW,
 767                         'rc_minor' => $minor ? 1 : 0,
 768                         'rc_cur_id' => $title->getArticleID(),
 769                         'rc_user' => $user->getId(),
 770                         'rc_user_text' => $user->getName(),
 771                         'rc_actor' => $user->getActorId(),
 772                         'rc_comment' => &$comment,
 773                         'rc_comment_text' => &$comment,
 774                         'rc_comment_data' => null,
 775                         'rc_this_oldid' => $newId,
 776                         'rc_last_oldid' => 0,
 777                         'rc_bot' => $bot ? 1 : 0,
 778                         'rc_ip' => self::checkIPAddress( $ip ),
 779                         'rc_patrolled' => intval( $patrol ),
 780                         'rc_new' => 1, # obsolete
 781                         'rc_old_len' => 0,
 782                         'rc_new_len' => $size,
 783                         'rc_deleted' => 0,
 784                         'rc_logid' => 0,
 785                         'rc_log_type' => null,
 786                         'rc_log_action' => '',
 787                         'rc_params' => ''
 788                 ];
 789
 790                 $rc->mExtra = [
 791                         'prefixedDBkey' => $title->getPrefixedDBkey(),
 792                         'lastTimestamp' => 0,
 793                         'oldSize' => 0,
 794                         'newSize' => $size,
 795                         'pageStatus' => 'created'
 796                 ];
 797
 798                 DeferredUpdates::addCallableUpdate(
 799                         function () use ( $rc, $tags ) {
 800                                 $rc->addTags( $tags );
 801                                 $rc->save();
 802                         },
 803                         DeferredUpdates::POSTSEND,
 804                         wfGetDB( DB_MASTER )
 805                 );
 806
 807                 return $rc;
 808         }
 809
 810         /**
 811          * @param string $timestamp
 812          * @param Title $title
 813          * @param User $user
 814          * @param string $actionComment
 815          * @param string $ip
 816          * @param string $type
 817          * @param string $action
 818          * @param Title $target
 819          * @param string $logComment
 820          * @param string $params
 821          * @param int $newId
 822          * @param string $actionCommentIRC
 823          * @return bool
 824          */
 825         public static function notifyLog( $timestamp, $title, $user, $actionComment, $ip, $type,
 826                 $action, $target, $logComment, $params, $newId = 0, $actionCommentIRC = ''
 827         ) {
 828                 global $wgLogRestrictions;
 829
 830                 # Don't add private logs to RC!
 831                 if ( isset( $wgLogRestrictions[$type] ) && $wgLogRestrictions[$type] != '*' ) {
 832                         return false;
 833                 }
 834                 $rc = self::newLogEntry( $timestamp, $title, $user, $actionComment, $ip, $type, $action,
 835                         $target, $logComment, $params, $newId, $actionCommentIRC );
 836                 $rc->save();
 837
 838                 return true;
 839         }
 840
 841         /**
 842          * @param string $timestamp
 843          * @param Title $title
 844          * @param User $user
 845          * @param string $actionComment
 846          * @param string $ip
 847          * @param string $type
 848          * @param string $action
 849          * @param Title $target
 850          * @param string $logComment
 851          * @param string $params
 852          * @param int $newId
 853          * @param string $actionCommentIRC
 854          * @param int $revId Id of associated revision, if any
 855          * @param bool $isPatrollable Whether this log entry is patrollable
 856          * @return RecentChange
 857          */
 858         public static function newLogEntry( $timestamp, $title, $user, $actionComment, $ip,
 859                 $type, $action, $target, $logComment, $params, $newId = 0, $actionCommentIRC = '',
 860                 $revId = 0, $isPatrollable = false ) {
 861                 global $wgRequest;
 862                 $permissionManager = MediaWikiServices::getInstance()->getPermissionManager();
 863
 864                 # # Get pageStatus for email notification
 865                 switch ( $type . '-' . $action ) {
 866                         case 'delete-delete':
 867                         case 'delete-delete_redir':
 868                                 $pageStatus = 'deleted';
 869                                 break;
 870                         case 'move-move':
 871                         case 'move-move_redir':
 872                                 $pageStatus = 'moved';
 873                                 break;
 874                         case 'delete-restore':
 875                                 $pageStatus = 'restored';
 876                                 break;
 877                         case 'upload-upload':
 878                                 $pageStatus = 'created';
 879                                 break;
 880                         case 'upload-overwrite':
 881                         default:
 882                                 $pageStatus = 'changed';
 883                                 break;
 884                 }
 885
 886                 // Allow unpatrolled status for patrollable log entries
 887                 $canAutopatrol = $permissionManager->userHasRight( $user, 'autopatrol' );
 888                 $markPatrolled = $isPatrollable ? $canAutopatrol : true;
 889
 890                 $rc = new RecentChange;
 891                 $rc->mTitle = $target;
 892                 $rc->mPerformer = $user;
 893                 $rc->mAttribs = [
 894                         'rc_timestamp' => $timestamp,
 895                         'rc_namespace' => $target->getNamespace(),
 896                         'rc_title' => $target->getDBkey(),
 897                         'rc_type' => RC_LOG,
 898                         'rc_source' => self::SRC_LOG,
 899                         'rc_minor' => 0,
 900                         'rc_cur_id' => $target->getArticleID(),
 901                         'rc_user' => $user->getId(),
 902                         'rc_user_text' => $user->getName(),
 903                         'rc_actor' => $user->getActorId(),
 904                         'rc_comment' => &$logComment,
 905                         'rc_comment_text' => &$logComment,
 906                         'rc_comment_data' => null,
 907                         'rc_this_oldid' => $revId,
 908                         'rc_last_oldid' => 0,
 909                         'rc_bot' => $permissionManager->userHasRight( $user, 'bot' ) ?
 910                                 (int)$wgRequest->getBool( 'bot', true ) : 0,
 911                         'rc_ip' => self::checkIPAddress( $ip ),
 912                         'rc_patrolled' => $markPatrolled ? self::PRC_AUTOPATROLLED : self::PRC_UNPATROLLED,
 913                         'rc_new' => 0, # obsolete
 914                         'rc_old_len' => null,
 915                         'rc_new_len' => null,
 916                         'rc_deleted' => 0,
 917                         'rc_logid' => $newId,
 918                         'rc_log_type' => $type,
 919                         'rc_log_action' => $action,
 920                         'rc_params' => $params
 921                 ];
 922
 923                 $rc->mExtra = [
 924                         'prefixedDBkey' => $title->getPrefixedDBkey(),
 925                         'lastTimestamp' => 0,
 926                         'actionComment' => $actionComment, // the comment appended to the action, passed from LogPage
 927                         'pageStatus' => $pageStatus,
 928                         'actionCommentIRC' => $actionCommentIRC
 929                 ];
 930
 931                 return $rc;
 932         }
 933
 934         /**
 935          * Constructs a RecentChange object for the given categorization
 936          * This does not call save() on the object and thus does not write to the db
 937          *
 938          * @since 1.27
 939          *
 940          * @param string $timestamp Timestamp of the recent change to occur
 941          * @param Title $categoryTitle Title of the category a page is being added to or removed from
 942          * @param User|null $user User object of the user that made the change
 943          * @param string $comment Change summary
 944          * @param Title $pageTitle Title of the page that is being added or removed
 945          * @param int $oldRevId Parent revision ID of this change
 946          * @param int $newRevId Revision ID of this change
 947          * @param string $lastTimestamp Parent revision timestamp of this change
 948          * @param bool $bot true, if the change was made by a bot
 949          * @param string $ip IP address of the user, if the change was made anonymously
 950          * @param int $deleted Indicates whether the change has been deleted
 951          * @param bool|null $added true, if the category was added, false for removed
 952          *
 953          * @return RecentChange
 954          */
 955         public static function newForCategorization(
 956                 $timestamp,
 957                 Title $categoryTitle,
 958                 User $user = null,
 959                 $comment,
 960                 Title $pageTitle,
 961                 $oldRevId,
 962                 $newRevId,
 963                 $lastTimestamp,
 964                 $bot,
 965                 $ip = '',
 966                 $deleted = 0,
 967                 $added = null
 968         ) {
 969                 // Done in a backwards compatible way.
 970                 $params = [
 971                         'hidden-cat' => WikiCategoryPage::factory( $categoryTitle )->isHidden()
 972                 ];
 973                 if ( $added !== null ) {
 974                         $params['added'] = $added;
 975                 }
 976
 977                 $rc = new RecentChange;
 978                 $rc->mTitle = $categoryTitle;
 979                 $rc->mPerformer = $user;
 980                 $rc->mAttribs = [
 981                         'rc_timestamp' => $timestamp,
 982                         'rc_namespace' => $categoryTitle->getNamespace(),
 983                         'rc_title' => $categoryTitle->getDBkey(),
 984                         'rc_type' => RC_CATEGORIZE,
 985                         'rc_source' => self::SRC_CATEGORIZE,
 986                         'rc_minor' => 0,
 987                         'rc_cur_id' => $pageTitle->getArticleID(),
 988                         'rc_user' => $user ? $user->getId() : 0,
 989                         'rc_user_text' => $user ? $user->getName() : '',
 990                         'rc_actor' => $user ? $user->getActorId() : null,
 991                         'rc_comment' => &$comment,
 992                         'rc_comment_text' => &$comment,
 993                         'rc_comment_data' => null,
 994                         'rc_this_oldid' => $newRevId,
 995                         'rc_last_oldid' => $oldRevId,
 996                         'rc_bot' => $bot ? 1 : 0,
 997                         'rc_ip' => self::checkIPAddress( $ip ),
 998                         'rc_patrolled' => self::PRC_AUTOPATROLLED, // Always patrolled, just like log entries
 999                         'rc_new' => 0, # obsolete
1000                         'rc_old_len' => null,
1001                         'rc_new_len' => null,
1002                         'rc_deleted' => $deleted,
1003                         'rc_logid' => 0,
1004                         'rc_log_type' => null,
1005                         'rc_log_action' => '',
1006                         'rc_params' => serialize( $params )
1007                 ];
1008
1009                 $rc->mExtra = [
1010                         'prefixedDBkey' => $categoryTitle->getPrefixedDBkey(),
1011                         'lastTimestamp' => $lastTimestamp,
1012                         'oldSize' => 0,
1013                         'newSize' => 0,
1014                         'pageStatus' => 'changed'
1015                 ];
1016
1017                 return $rc;
1018         }
1019
1020         /**
1021          * Get a parameter value
1022          *
1023          * @since 1.27
1024          *
1025          * @param string $name parameter name
1026          * @return mixed
1027          */
1028         public function getParam( $name ) {
1029                 $params = $this->parseParams();
1030                 return $params[$name] ?? null;
1031         }
1032
1033         /**
1034          * Initialises the members of this object from a mysql row object
1035          *
1036          * @param mixed $row
1037          */
1038         public function loadFromRow( $row ) {
1039                 $this->mAttribs = get_object_vars( $row );
1040                 $this->mAttribs['rc_timestamp'] = wfTimestamp( TS_MW, $this->mAttribs['rc_timestamp'] );
1041                 // rc_deleted MUST be set
1042                 $this->mAttribs['rc_deleted'] = $row->rc_deleted;
1043
1044                 if ( isset( $this->mAttribs['rc_ip'] ) ) {
1045                         // Clean up CIDRs for Postgres per T164898. ("127.0.0.1" casts to "127.0.0.1/32")
1046                         $n = strpos( $this->mAttribs['rc_ip'], '/' );
1047                         if ( $n !== false ) {
1048                                 $this->mAttribs['rc_ip'] = substr( $this->mAttribs['rc_ip'], 0, $n );
1049                         }
1050                 }
1051
1052                 $comment = CommentStore::getStore()
1053                         // Legacy because $row may have come from self::selectFields()
1054                         ->getCommentLegacy( wfGetDB( DB_REPLICA ), 'rc_comment', $row, true )
1055                         ->text;
1056                 $this->mAttribs['rc_comment'] = &$comment;
1057                 $this->mAttribs['rc_comment_text'] = &$comment;
1058                 $this->mAttribs['rc_comment_data'] = null;
1059
1060                 $user = User::newFromAnyId(
1061                         $this->mAttribs['rc_user'] ?? null,
1062                         $this->mAttribs['rc_user_text'] ?? null,
1063                         $this->mAttribs['rc_actor'] ?? null
1064                 );
1065                 $this->mAttribs['rc_user'] = $user->getId();
1066                 $this->mAttribs['rc_user_text'] = $user->getName();
1067                 $this->mAttribs['rc_actor'] = $user->getActorId();
1068         }
1069
1070         /**
1071          * Get an attribute value
1072          *
1073          * @param string $name Attribute name
1074          * @return mixed
1075          */
1076         public function getAttribute( $name ) {
1077                 if ( $name === 'rc_comment' ) {
1078                         return CommentStore::getStore()
1079                                 ->getComment( 'rc_comment', $this->mAttribs, true )->text;
1080                 }
1081
1082                 if ( $name === 'rc_user' || $name === 'rc_user_text' || $name === 'rc_actor' ) {
1083                         $user = User::newFromAnyId(
1084                                 $this->mAttribs['rc_user'] ?? null,
1085                                 $this->mAttribs['rc_user_text'] ?? null,
1086                                 $this->mAttribs['rc_actor'] ?? null
1087                         );
1088                         if ( $name === 'rc_user' ) {
1089                                 return $user->getId();
1090                         }
1091                         if ( $name === 'rc_user_text' ) {
1092                                 return $user->getName();
1093                         }
1094                         if ( $name === 'rc_actor' ) {
1095                                 return $user->getActorId();
1096                         }
1097                 }
1098
1099                 return $this->mAttribs[$name] ?? null;
1100         }
1101
1102         /**
1103          * @return array
1104          */
1105         public function getAttributes() {
1106                 return $this->mAttribs;
1107         }
1108
1109         /**
1110          * Gets the end part of the diff URL associated with this object
1111          * Blank if no diff link should be displayed
1112          * @param bool $forceCur
1113          * @return string
1114          */
1115         public function diffLinkTrail( $forceCur ) {
1116                 if ( $this->mAttribs['rc_type'] == RC_EDIT ) {
1117                         $trail = "curid=" . (int)( $this->mAttribs['rc_cur_id'] ) .
1118                                 "&oldid=" . (int)( $this->mAttribs['rc_last_oldid'] );
1119                         if ( $forceCur ) {
1120                                 $trail .= '&diff=0';
1121                         } else {
1122                                 $trail .= '&diff=' . (int)( $this->mAttribs['rc_this_oldid'] );
1123                         }
1124                 } else {
1125                         $trail = '';
1126                 }
1127
1128                 return $trail;
1129         }
1130
1131         /**
1132          * Returns the change size (HTML).
1133          * The lengths can be given optionally.
1134          * @param int $old
1135          * @param int $new
1136          * @return string
1137          */
1138         public function getCharacterDifference( $old = 0, $new = 0 ) {
1139                 if ( $old === 0 ) {
1140                         $old = $this->mAttribs['rc_old_len'];
1141                 }
1142                 if ( $new === 0 ) {
1143                         $new = $this->mAttribs['rc_new_len'];
1144                 }
1145                 if ( $old === null || $new === null ) {
1146                         return '';
1147                 }
1148
1149                 return ChangesList::showCharacterDifference( $old, $new );
1150         }
1151
1152         private static function checkIPAddress( $ip ) {
1153                 global $wgRequest;
1154                 if ( $ip ) {
1155                         if ( !IP::isIPAddress( $ip ) ) {
1156                                 throw new MWException( "Attempt to write \"" . $ip .
1157                                         "\" as an IP address into recent changes" );
1158                         }
1159                 } else {
1160                         $ip = $wgRequest->getIP();
1161                         if ( !$ip ) {
1162                                 $ip = '';
1163                         }
1164                 }
1165
1166                 return $ip;
1167         }
1168
1169         /**
1170          * Check whether the given timestamp is new enough to have a RC row with a given tolerance
1171          * as the recentchanges table might not be cleared out regularly (so older entries might exist)
1172          * or rows which will be deleted soon shouldn't be included.
1173          *
1174          * @param mixed $timestamp MWTimestamp compatible timestamp
1175          * @param int $tolerance Tolerance in seconds
1176          * @return bool
1177          */
1178         public static function isInRCLifespan( $timestamp, $tolerance = 0 ) {
1179                 global $wgRCMaxAge;
1180
1181                 return wfTimestamp( TS_UNIX, $timestamp ) > time() - $tolerance - $wgRCMaxAge;
1182         }
1183
1184         /**
1185          * Parses and returns the rc_params attribute
1186          *
1187          * @since 1.26
1188          *
1189          * @return mixed|bool false on failed unserialization
1190          */
1191         public function parseParams() {
1192                 $rcParams = $this->getAttribute( 'rc_params' );
1193
1194                 Wikimedia\suppressWarnings();
1195                 $unserializedParams = unserialize( $rcParams );
1196                 Wikimedia\restoreWarnings();
1197
1198                 return $unserializedParams;
1199         }
1200
1201         /**
1202          * Tags to append to the recent change,
1203          * and associated revision/log
1204          *
1205          * @since 1.28
1206          *
1207          * @param string|string[] $tags
1208          */
1209         public function addTags( $tags ) {
1210                 if ( is_string( $tags ) ) {
1211                         $this->tags[] = $tags;
1212                 } else {
1213                         $this->tags = array_merge( $tags, $this->tags );
1214                 }
1215         }
1216 }