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