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 = array();
  73         public $mExtra = array();
  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 = array(
  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 = array();
 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( array( '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 array(
 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 = array();
 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', array( &$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                         if ( Hooks::run( 'AbortEmailNotification', array( $editor, $title, $this ) ) ) {
 328                                 # @todo FIXME: This would be better as an extension hook
 329                                 $enotif = new EmailNotification();
 330                                 $enotif->notifyOnPageChange( $editor, $title,
 331                                         $this->mAttribs['rc_timestamp'],
 332                                         $this->mAttribs['rc_comment'],
 333                                         $this->mAttribs['rc_minor'],
 334                                         $this->mAttribs['rc_last_oldid'],
 335                                         $this->mExtra['pageStatus'] );
 336                         }
 337                 }
 338
 339                 // Update the cached list of active users
 340                 if ( $this->mAttribs['rc_user'] > 0 ) {
 341                         JobQueueGroup::singleton()->lazyPush( RecentChangesUpdateJob::newCacheUpdateJob() );
 342                 }
 343         }
 344
 345         /**
 346          * Notify all the feeds about the change.
 347          * @param array $feeds Optional feeds to send to, defaults to $wgRCFeeds
 348          */
 349         public function notifyRCFeeds( array $feeds = null ) {
 350                 global $wgRCFeeds;
 351                 if ( $feeds === null ) {
 352                         $feeds = $wgRCFeeds;
 353                 }
 354
 355                 $performer = $this->getPerformer();
 356
 357                 foreach ( $feeds as $feed ) {
 358                         $feed += array(
 359                                 'omit_bots' => false,
 360                                 'omit_anon' => false,
 361                                 'omit_user' => false,
 362                                 'omit_minor' => false,
 363                                 'omit_patrolled' => false,
 364                         );
 365
 366                         if (
 367                                 ( $feed['omit_bots'] && $this->mAttribs['rc_bot'] ) ||
 368                                 ( $feed['omit_anon'] && $performer->isAnon() ) ||
 369                                 ( $feed['omit_user'] && !$performer->isAnon() ) ||
 370                                 ( $feed['omit_minor'] && $this->mAttribs['rc_minor'] ) ||
 371                                 ( $feed['omit_patrolled'] && $this->mAttribs['rc_patrolled'] ) ||
 372                                 $this->mAttribs['rc_type'] == RC_EXTERNAL
 373                         ) {
 374                                 continue;
 375                         }
 376
 377                         $engine = self::getEngine( $feed['uri'] );
 378
 379                         if ( isset( $this->mExtra['actionCommentIRC'] ) ) {
 380                                 $actionComment = $this->mExtra['actionCommentIRC'];
 381                         } else {
 382                                 $actionComment = null;
 383                         }
 384
 385                         /** @var $formatter RCFeedFormatter */
 386                         $formatter = is_object( $feed['formatter'] ) ? $feed['formatter'] : new $feed['formatter']();
 387                         $line = $formatter->getLine( $feed, $this, $actionComment );
 388                         if ( !$line ) {
 389                                 // T109544
 390                                 // If a feed formatter returns null, this will otherwise cause an
 391                                 // error in at least RedisPubSubFeedEngine.
 392                                 // Not sure where/how this should best be handled.
 393                                 continue;
 394                         }
 395
 396                         $engine->send( $feed, $line );
 397                 }
 398         }
 399
 400         /**
 401          * Gets the stream engine object for a given URI from $wgRCEngines
 402          *
 403          * @param string $uri URI to get the engine object for
 404          * @throws MWException
 405          * @return RCFeedEngine The engine object
 406          */
 407         public static function getEngine( $uri ) {
 408                 global $wgRCEngines;
 409
 410                 $scheme = parse_url( $uri, PHP_URL_SCHEME );
 411                 if ( !$scheme ) {
 412                         throw new MWException( __FUNCTION__ . ": Invalid stream logger URI: '$uri'" );
 413                 }
 414
 415                 if ( !isset( $wgRCEngines[$scheme] ) ) {
 416                         throw new MWException( __FUNCTION__ . ": Unknown stream logger URI scheme: $scheme" );
 417                 }
 418
 419                 return new $wgRCEngines[$scheme];
 420         }
 421
 422         /**
 423          * Mark a given change as patrolled
 424          *
 425          * @param RecentChange|int $change RecentChange or corresponding rc_id
 426          * @param bool $auto For automatic patrol
 427          * @return array See doMarkPatrolled(), or null if $change is not an existing rc_id
 428          */
 429         public static function markPatrolled( $change, $auto = false ) {
 430                 global $wgUser;
 431
 432                 $change = $change instanceof RecentChange
 433                         ? $change
 434                         : RecentChange::newFromId( $change );
 435
 436                 if ( !$change instanceof RecentChange ) {
 437                         return null;
 438                 }
 439
 440                 return $change->doMarkPatrolled( $wgUser, $auto );
 441         }
 442
 443         /**
 444          * Mark this RecentChange as patrolled
 445          *
 446          * NOTE: Can also return 'rcpatroldisabled', 'hookaborted' and
 447          * 'markedaspatrollederror-noautopatrol' as errors
 448          * @param User $user User object doing the action
 449          * @param bool $auto For automatic patrol
 450          * @return array Array of permissions errors, see Title::getUserPermissionsErrors()
 451          */
 452         public function doMarkPatrolled( User $user, $auto = false ) {
 453                 global $wgUseRCPatrol, $wgUseNPPatrol;
 454                 $errors = array();
 455                 // If recentchanges patrol is disabled, only new pages
 456                 // can be patrolled
 457                 if ( !$wgUseRCPatrol && ( !$wgUseNPPatrol || $this->getAttribute( 'rc_type' ) != RC_NEW ) ) {
 458                         $errors[] = array( 'rcpatroldisabled' );
 459                 }
 460                 // Automatic patrol needs "autopatrol", ordinary patrol needs "patrol"
 461                 $right = $auto ? 'autopatrol' : 'patrol';
 462                 $errors = array_merge( $errors, $this->getTitle()->getUserPermissionsErrors( $right, $user ) );
 463                 if ( !Hooks::run( 'MarkPatrolled', array( $this->getAttribute( 'rc_id' ), &$user, false ) ) ) {
 464                         $errors[] = array( 'hookaborted' );
 465                 }
 466                 // Users without the 'autopatrol' right can't patrol their
 467                 // own revisions
 468                 if ( $user->getName() === $this->getAttribute( 'rc_user_text' )
 469                         && !$user->isAllowed( 'autopatrol' )
 470                 ) {
 471                         $errors[] = array( 'markedaspatrollederror-noautopatrol' );
 472                 }
 473                 if ( $errors ) {
 474                         return $errors;
 475                 }
 476                 // If the change was patrolled already, do nothing
 477                 if ( $this->getAttribute( 'rc_patrolled' ) ) {
 478                         return array();
 479                 }
 480                 // Actually set the 'patrolled' flag in RC
 481                 $this->reallyMarkPatrolled();
 482                 // Log this patrol event
 483                 PatrolLog::record( $this, $auto, $user );
 484                 Hooks::run( 'MarkPatrolledComplete', array( $this->getAttribute( 'rc_id' ), &$user, false ) );
 485
 486                 return array();
 487         }
 488
 489         /**
 490          * Mark this RecentChange patrolled, without error checking
 491          * @return int Number of affected rows
 492          */
 493         public function reallyMarkPatrolled() {
 494                 $dbw = wfGetDB( DB_MASTER );
 495                 $dbw->update(
 496                         'recentchanges',
 497                         array(
 498                                 'rc_patrolled' => 1
 499                         ),
 500                         array(
 501                                 'rc_id' => $this->getAttribute( 'rc_id' )
 502                         ),
 503                         __METHOD__
 504                 );
 505                 // Invalidate the page cache after the page has been patrolled
 506                 // to make sure that the Patrol link isn't visible any longer!
 507                 $this->getTitle()->invalidateCache();
 508
 509                 return $dbw->affectedRows();
 510         }
 511
 512         /**
 513          * Makes an entry in the database corresponding to an edit
 514          *
 515          * @param string $timestamp
 516          * @param Title $title
 517          * @param bool $minor
 518          * @param User $user
 519          * @param string $comment
 520          * @param int $oldId
 521          * @param string $lastTimestamp
 522          * @param bool $bot
 523          * @param string $ip
 524          * @param int $oldSize
 525          * @param int $newSize
 526          * @param int $newId
 527          * @param int $patrol
 528          * @return RecentChange
 529          */
 530         public static function notifyEdit(
 531                 $timestamp, &$title, $minor, &$user, $comment, $oldId, $lastTimestamp,
 532                 $bot, $ip = '', $oldSize = 0, $newSize = 0, $newId = 0, $patrol = 0
 533         ) {
 534                 $rc = new RecentChange;
 535                 $rc->mTitle = $title;
 536                 $rc->mPerformer = $user;
 537                 $rc->mAttribs = array(
 538                         'rc_timestamp' => $timestamp,
 539                         'rc_namespace' => $title->getNamespace(),
 540                         'rc_title' => $title->getDBkey(),
 541                         'rc_type' => RC_EDIT,
 542                         'rc_source' => self::SRC_EDIT,
 543                         'rc_minor' => $minor ? 1 : 0,
 544                         'rc_cur_id' => $title->getArticleID(),
 545                         'rc_user' => $user->getId(),
 546                         'rc_user_text' => $user->getName(),
 547                         'rc_comment' => $comment,
 548                         'rc_this_oldid' => $newId,
 549                         'rc_last_oldid' => $oldId,
 550                         'rc_bot' => $bot ? 1 : 0,
 551                         'rc_ip' => self::checkIPAddress( $ip ),
 552                         'rc_patrolled' => intval( $patrol ),
 553                         'rc_new' => 0, # obsolete
 554                         'rc_old_len' => $oldSize,
 555                         'rc_new_len' => $newSize,
 556                         'rc_deleted' => 0,
 557                         'rc_logid' => 0,
 558                         'rc_log_type' => null,
 559                         'rc_log_action' => '',
 560                         'rc_params' => ''
 561                 );
 562
 563                 $rc->mExtra = array(
 564                         'prefixedDBkey' => $title->getPrefixedDBkey(),
 565                         'lastTimestamp' => $lastTimestamp,
 566                         'oldSize' => $oldSize,
 567                         'newSize' => $newSize,
 568                         'pageStatus' => 'changed'
 569                 );
 570
 571                 DeferredUpdates::addCallableUpdate( function() use ( $rc ) {
 572                         $rc->save();
 573                         if ( $rc->mAttribs['rc_patrolled'] ) {
 574                                 PatrolLog::record( $rc, true, $rc->getPerformer() );
 575                         }
 576                 } );
 577
 578                 return $rc;
 579         }
 580
 581         /**
 582          * Makes an entry in the database corresponding to page creation
 583          * Note: the title object must be loaded with the new id using resetArticleID()
 584          *
 585          * @param string $timestamp
 586          * @param Title $title
 587          * @param bool $minor
 588          * @param User $user
 589          * @param string $comment
 590          * @param bool $bot
 591          * @param string $ip
 592          * @param int $size
 593          * @param int $newId
 594          * @param int $patrol
 595          * @return RecentChange
 596          */
 597         public static function notifyNew(
 598                 $timestamp, &$title, $minor, &$user, $comment, $bot,
 599                 $ip = '', $size = 0, $newId = 0, $patrol = 0
 600         ) {
 601                 $rc = new RecentChange;
 602                 $rc->mTitle = $title;
 603                 $rc->mPerformer = $user;
 604                 $rc->mAttribs = array(
 605                         'rc_timestamp' => $timestamp,
 606                         'rc_namespace' => $title->getNamespace(),
 607                         'rc_title' => $title->getDBkey(),
 608                         'rc_type' => RC_NEW,
 609                         'rc_source' => self::SRC_NEW,
 610                         'rc_minor' => $minor ? 1 : 0,
 611                         'rc_cur_id' => $title->getArticleID(),
 612                         'rc_user' => $user->getId(),
 613                         'rc_user_text' => $user->getName(),
 614                         'rc_comment' => $comment,
 615                         'rc_this_oldid' => $newId,
 616                         'rc_last_oldid' => 0,
 617                         'rc_bot' => $bot ? 1 : 0,
 618                         'rc_ip' => self::checkIPAddress( $ip ),
 619                         'rc_patrolled' => intval( $patrol ),
 620                         'rc_new' => 1, # obsolete
 621                         'rc_old_len' => 0,
 622                         'rc_new_len' => $size,
 623                         'rc_deleted' => 0,
 624                         'rc_logid' => 0,
 625                         'rc_log_type' => null,
 626                         'rc_log_action' => '',
 627                         'rc_params' => ''
 628                 );
 629
 630                 $rc->mExtra = array(
 631                         'prefixedDBkey' => $title->getPrefixedDBkey(),
 632                         'lastTimestamp' => 0,
 633                         'oldSize' => 0,
 634                         'newSize' => $size,
 635                         'pageStatus' => 'created'
 636                 );
 637
 638                 DeferredUpdates::addCallableUpdate( function() use ( $rc ) {
 639                         $rc->save();
 640                         if ( $rc->mAttribs['rc_patrolled'] ) {
 641                                 PatrolLog::record( $rc, true, $rc->getPerformer() );
 642                         }
 643                 } );
 644
 645                 return $rc;
 646         }
 647
 648         /**
 649          * @param string $timestamp
 650          * @param Title $title
 651          * @param User $user
 652          * @param string $actionComment
 653          * @param string $ip
 654          * @param string $type
 655          * @param string $action
 656          * @param Title $target
 657          * @param string $logComment
 658          * @param string $params
 659          * @param int $newId
 660          * @param string $actionCommentIRC
 661          * @return bool
 662          */
 663         public static function notifyLog( $timestamp, &$title, &$user, $actionComment, $ip, $type,
 664                 $action, $target, $logComment, $params, $newId = 0, $actionCommentIRC = ''
 665         ) {
 666                 global $wgLogRestrictions;
 667
 668                 # Don't add private logs to RC!
 669                 if ( isset( $wgLogRestrictions[$type] ) && $wgLogRestrictions[$type] != '*' ) {
 670                         return false;
 671                 }
 672                 $rc = self::newLogEntry( $timestamp, $title, $user, $actionComment, $ip, $type, $action,
 673                         $target, $logComment, $params, $newId, $actionCommentIRC );
 674                 $rc->save();
 675
 676                 return true;
 677         }
 678
 679         /**
 680          * @param string $timestamp
 681          * @param Title $title
 682          * @param User $user
 683          * @param string $actionComment
 684          * @param string $ip
 685          * @param string $type
 686          * @param string $action
 687          * @param Title $target
 688          * @param string $logComment
 689          * @param string $params
 690          * @param int $newId
 691          * @param string $actionCommentIRC
 692          * @return RecentChange
 693          */
 694         public static function newLogEntry( $timestamp, &$title, &$user, $actionComment, $ip,
 695                 $type, $action, $target, $logComment, $params, $newId = 0, $actionCommentIRC = '' ) {
 696                 global $wgRequest;
 697
 698                 # # Get pageStatus for email notification
 699                 switch ( $type . '-' . $action ) {
 700                         case 'delete-delete':
 701                                 $pageStatus = 'deleted';
 702                                 break;
 703                         case 'move-move':
 704                         case 'move-move_redir':
 705                                 $pageStatus = 'moved';
 706                                 break;
 707                         case 'delete-restore':
 708                                 $pageStatus = 'restored';
 709                                 break;
 710                         case 'upload-upload':
 711                                 $pageStatus = 'created';
 712                                 break;
 713                         case 'upload-overwrite':
 714                         default:
 715                                 $pageStatus = 'changed';
 716                                 break;
 717                 }
 718
 719                 $rc = new RecentChange;
 720                 $rc->mTitle = $target;
 721                 $rc->mPerformer = $user;
 722                 $rc->mAttribs = array(
 723                         'rc_timestamp' => $timestamp,
 724                         'rc_namespace' => $target->getNamespace(),
 725                         'rc_title' => $target->getDBkey(),
 726                         'rc_type' => RC_LOG,
 727                         'rc_source' => self::SRC_LOG,
 728                         'rc_minor' => 0,
 729                         'rc_cur_id' => $target->getArticleID(),
 730                         'rc_user' => $user->getId(),
 731                         'rc_user_text' => $user->getName(),
 732                         'rc_comment' => $logComment,
 733                         'rc_this_oldid' => 0,
 734                         'rc_last_oldid' => 0,
 735                         'rc_bot' => $user->isAllowed( 'bot' ) ? $wgRequest->getBool( 'bot', true ) : 0,
 736                         'rc_ip' => self::checkIPAddress( $ip ),
 737                         'rc_patrolled' => 1,
 738                         'rc_new' => 0, # obsolete
 739                         'rc_old_len' => null,
 740                         'rc_new_len' => null,
 741                         'rc_deleted' => 0,
 742                         'rc_logid' => $newId,
 743                         'rc_log_type' => $type,
 744                         'rc_log_action' => $action,
 745                         'rc_params' => $params
 746                 );
 747
 748                 $rc->mExtra = array(
 749                         'prefixedDBkey' => $title->getPrefixedDBkey(),
 750                         'lastTimestamp' => 0,
 751                         'actionComment' => $actionComment, // the comment appended to the action, passed from LogPage
 752                         'pageStatus' => $pageStatus,
 753                         'actionCommentIRC' => $actionCommentIRC
 754                 );
 755
 756                 return $rc;
 757         }
 758
 759         /**
 760          * Constructs a RecentChange object for the given categorization
 761          * This does not call save() on the object and thus does not write to the db
 762          *
 763          * @since 1.26
 764          *
 765          * @param string $timestamp Timestamp of the recent change to occur
 766          * @param Title $categoryTitle Title of the category a page is being added to or removed from
 767          * @param User $user User object of the user that made the change
 768          * @param string $comment Change summary
 769          * @param Title $pageTitle Title of the page that is being added or removed
 770          * @param int $oldRevId Parent revision ID of this change
 771          * @param int $newRevId Revision ID of this change
 772          * @param string $lastTimestamp Parent revision timestamp of this change
 773          * @param bool $bot true, if the change was made by a bot
 774          * @param string $ip IP address of the user, if the change was made anonymously
 775          * @param int $deleted Indicates whether the change has been deleted
 776          *
 777          * @return RecentChange
 778          */
 779         public static function newForCategorization(
 780                 $timestamp,
 781                 Title $categoryTitle,
 782                 User $user = null,
 783                 $comment,
 784                 Title $pageTitle,
 785                 $oldRevId,
 786                 $newRevId,
 787                 $lastTimestamp,
 788                 $bot,
 789                 $ip = '',
 790                 $deleted = 0
 791         ) {
 792
 793                 $rc = new RecentChange;
 794                 $rc->mTitle = $categoryTitle;
 795                 $rc->mPerformer = $user;
 796                 $rc->mAttribs = array(
 797                         'rc_timestamp' => $timestamp,
 798                         'rc_namespace' => $categoryTitle->getNamespace(),
 799                         'rc_title' => $categoryTitle->getDBkey(),
 800                         'rc_type' => RC_CATEGORIZE,
 801                         'rc_source' => self::SRC_CATEGORIZE,
 802                         'rc_minor' => 0,
 803                         'rc_cur_id' => $pageTitle->getArticleID(),
 804                         'rc_user' => $user ? $user->getId() : 0,
 805                         'rc_user_text' => $user ? $user->getName() : '',
 806                         'rc_comment' => $comment,
 807                         'rc_this_oldid' => $newRevId,
 808                         'rc_last_oldid' => $oldRevId,
 809                         'rc_bot' => $bot ? 1 : 0,
 810                         'rc_ip' => self::checkIPAddress( $ip ),
 811                         'rc_patrolled' => 1, // Always patrolled, just like log entries
 812                         'rc_new' => 0, # obsolete
 813                         'rc_old_len' => 0,
 814                         'rc_new_len' => 0,
 815                         'rc_deleted' => $deleted,
 816                         'rc_logid' => 0,
 817                         'rc_log_type' => null,
 818                         'rc_log_action' => '',
 819                         'rc_params' => ''
 820                 );
 821
 822                 $rc->mExtra = array(
 823                         'prefixedDBkey' => $categoryTitle->getPrefixedDBkey(),
 824                         'lastTimestamp' => $lastTimestamp,
 825                         'oldSize' => 0,
 826                         'newSize' => 0,
 827                         'pageStatus' => 'changed'
 828                 );
 829
 830                 return $rc;
 831         }
 832
 833         /**
 834          * Initialises the members of this object from a mysql row object
 835          *
 836          * @param mixed $row
 837          */
 838         public function loadFromRow( $row ) {
 839                 $this->mAttribs = get_object_vars( $row );
 840                 $this->mAttribs['rc_timestamp'] = wfTimestamp( TS_MW, $this->mAttribs['rc_timestamp'] );
 841                 $this->mAttribs['rc_deleted'] = $row->rc_deleted; // MUST be set
 842         }
 843
 844         /**
 845          * Get an attribute value
 846          *
 847          * @param string $name Attribute name
 848          * @return mixed
 849          */
 850         public function getAttribute( $name ) {
 851                 return isset( $this->mAttribs[$name] ) ? $this->mAttribs[$name] : null;
 852         }
 853
 854         /**
 855          * @return array
 856          */
 857         public function getAttributes() {
 858                 return $this->mAttribs;
 859         }
 860
 861         /**
 862          * Gets the end part of the diff URL associated with this object
 863          * Blank if no diff link should be displayed
 864          * @param bool $forceCur
 865          * @return string
 866          */
 867         public function diffLinkTrail( $forceCur ) {
 868                 if ( $this->mAttribs['rc_type'] == RC_EDIT ) {
 869                         $trail = "curid=" . (int)( $this->mAttribs['rc_cur_id'] ) .
 870                                 "&oldid=" . (int)( $this->mAttribs['rc_last_oldid'] );
 871                         if ( $forceCur ) {
 872                                 $trail .= '&diff=0';
 873                         } else {
 874                                 $trail .= '&diff=' . (int)( $this->mAttribs['rc_this_oldid'] );
 875                         }
 876                 } else {
 877                         $trail = '';
 878                 }
 879
 880                 return $trail;
 881         }
 882
 883         /**
 884          * Returns the change size (HTML).
 885          * The lengths can be given optionally.
 886          * @param int $old
 887          * @param int $new
 888          * @return string
 889          */
 890         public function getCharacterDifference( $old = 0, $new = 0 ) {
 891                 if ( $old === 0 ) {
 892                         $old = $this->mAttribs['rc_old_len'];
 893                 }
 894                 if ( $new === 0 ) {
 895                         $new = $this->mAttribs['rc_new_len'];
 896                 }
 897                 if ( $old === null || $new === null ) {
 898                         return '';
 899                 }
 900
 901                 return ChangesList::showCharacterDifference( $old, $new );
 902         }
 903
 904         private static function checkIPAddress( $ip ) {
 905                 global $wgRequest;
 906                 if ( $ip ) {
 907                         if ( !IP::isIPAddress( $ip ) ) {
 908                                 throw new MWException( "Attempt to write \"" . $ip .
 909                                         "\" as an IP address into recent changes" );
 910                         }
 911                 } else {
 912                         $ip = $wgRequest->getIP();
 913                         if ( !$ip ) {
 914                                 $ip = '';
 915                         }
 916                 }
 917
 918                 return $ip;
 919         }
 920
 921         /**
 922          * Check whether the given timestamp is new enough to have a RC row with a given tolerance
 923          * as the recentchanges table might not be cleared out regularly (so older entries might exist)
 924          * or rows which will be deleted soon shouldn't be included.
 925          *
 926          * @param mixed $timestamp MWTimestamp compatible timestamp
 927          * @param int $tolerance Tolerance in seconds
 928          * @return bool
 929          */
 930         public static function isInRCLifespan( $timestamp, $tolerance = 0 ) {
 931                 global $wgRCMaxAge;
 932
 933                 return wfTimestamp( TS_UNIX, $timestamp ) > time() - $tolerance - $wgRCMaxAge;
 934         }
 935
 936         /**
 937          * Parses and returns the rc_params attribute
 938          *
 939          * @since 1.26
 940          *
 941          * @return array|null
 942          */
 943         public function parseParams() {
 944                 $rcParams = $this->getAttribute( 'rc_params' );
 945
 946                 MediaWiki\suppressWarnings();
 947                 $unserializedParams = unserialize( $rcParams );
 948                 MediaWiki\restoreWarnings();
 949
 950                 return $unserializedParams;
 951         }
 952 }