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