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