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