3 * Utility class for creating and accessing recent change entries.
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.
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.
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
24 * Utility class for creating new RC entries
27 * rc_id id of the row in the recentchanges table
28 * rc_timestamp time the entry was made
29 * rc_cur_time timestamp on the cur row
30 * rc_namespace namespace #
31 * rc_title non-prefixed db key
32 * rc_type is new entry, used to determine whether updating is necessary
33 * rc_source string representation of change source
35 * rc_cur_id page_id of associated page entry
36 * rc_user user id who made the entry
37 * rc_user_text user name who made the entry
38 * rc_comment edit summary
39 * rc_this_oldid rev_id associated with this entry (or zero)
40 * rc_last_oldid rev_id associated with the entry before this one (or zero)
41 * rc_bot is bot, hidden
42 * rc_ip IP address of the user in dotted quad notation
43 * rc_new obsolete, use rc_type==RC_NEW
44 * rc_patrolled boolean whether or not someone has marked this edit as patrolled
45 * rc_old_len integer byte length of the text before the edit
46 * rc_new_len the same after the edit
47 * rc_deleted partial deletion
48 * rc_logid the log_id value for this log entry (or zero)
49 * rc_log_type the log type (or null)
50 * rc_log_action the log action (or null)
51 * rc_params log params
54 * prefixedDBkey prefixed db key, used by external app via msg queue
55 * lastTimestamp timestamp of previous entry, used in WHERE clause during update
56 * lang the interwiki prefix, automatically set in save()
57 * oldSize text size before the change
58 * newSize text size after the change
59 * pageStatus status of the page: created, deleted, moved, restored, changed
61 * temporary: not stored in the database
62 * notificationtimestamp
63 * numberofWatchingusers
65 * @todo document functions and variables
69 // Constants for the rc_source field. Extensions may also have
70 // their own source constants.
71 const SRC_EDIT
= 'mw.edit';
72 const SRC_NEW
= 'mw.new';
73 const SRC_LOG
= 'mw.log';
74 const SRC_EXTERNAL
= 'mw.external'; // obsolete
76 var $mAttribs = array(), $mExtra = array();
86 private $mPerformer = false;
91 var $mMovedToTitle = false;
92 var $numberofWatchingusers = 0; # Dummy to prevent error message in SpecialRecentchangeslinked
93 var $notificationtimestamp;
99 * @return RecentChange
101 public static function newFromRow( $row ) {
102 $rc = new RecentChange
;
103 $rc->loadFromRow( $row );
108 * @deprecated in 1.22
110 * @return RecentChange
112 public static function newFromCurRow( $row ) {
113 wfDeprecated( __METHOD__
, '1.22' );
114 $rc = new RecentChange
;
115 $rc->loadFromCurRow( $row );
116 $rc->notificationtimestamp
= false;
117 $rc->numberofWatchingusers
= false;
122 * Obtain the recent change with a given rc_id value
124 * @param int $rcid rc_id value to retrieve
125 * @return RecentChange
127 public static function newFromId( $rcid ) {
128 return self
::newFromConds( array( 'rc_id' => $rcid ), __METHOD__
);
132 * Find the first recent change matching some specific conditions
134 * @param array $conds of conditions
135 * @param $fname Mixed: override the method name in profiling/logs
136 * @param $options Array Query options
137 * @return RecentChange
139 public static function newFromConds( $conds, $fname = __METHOD__
, $options = array() ) {
140 $dbr = wfGetDB( DB_SLAVE
);
141 $row = $dbr->selectRow( 'recentchanges', self
::selectFields(), $conds, $fname, $options );
142 if ( $row !== false ) {
143 return self
::newFromRow( $row );
150 * Return the list of recentchanges fields that should be selected to create
151 * a new recentchanges object.
154 public static function selectFields() {
187 * @param $attribs array
189 public function setAttribs( $attribs ) {
190 $this->mAttribs
= $attribs;
194 * @param $extra array
196 public function setExtra( $extra ) {
197 $this->mExtra
= $extra;
204 public function &getTitle() {
205 if ( $this->mTitle
=== false ) {
206 $this->mTitle
= Title
::makeTitle( $this->mAttribs
['rc_namespace'], $this->mAttribs
['rc_title'] );
208 return $this->mTitle
;
212 * Get the User object of the person who performed this change.
216 public function getPerformer() {
217 if ( $this->mPerformer
=== false ) {
218 if ( $this->mAttribs
['rc_user'] ) {
219 $this->mPerformer
= User
::newFromID( $this->mAttribs
['rc_user'] );
221 $this->mPerformer
= User
::newFromName( $this->mAttribs
['rc_user_text'], false );
224 return $this->mPerformer
;
228 * Writes the data in this object to the database
231 public function save( $noudp = false ) {
232 global $wgLocalInterwiki, $wgPutIPinRC, $wgUseEnotif, $wgShowUpdatedMarker, $wgContLang;
234 $dbw = wfGetDB( DB_MASTER
);
235 if ( !is_array( $this->mExtra
) ) {
236 $this->mExtra
= array();
238 $this->mExtra
['lang'] = $wgLocalInterwiki;
240 if ( !$wgPutIPinRC ) {
241 $this->mAttribs
['rc_ip'] = '';
244 # If our database is strict about IP addresses, use NULL instead of an empty string
245 if ( $dbw->strictIPs() and $this->mAttribs
['rc_ip'] == '' ) {
246 unset( $this->mAttribs
['rc_ip'] );
249 # Trim spaces on user supplied text
250 $this->mAttribs
['rc_comment'] = trim( $this->mAttribs
['rc_comment'] );
252 # Make sure summary is truncated (whole multibyte characters)
253 $this->mAttribs
['rc_comment'] = $wgContLang->truncate( $this->mAttribs
['rc_comment'], 255 );
255 # Fixup database timestamps
256 $this->mAttribs
['rc_timestamp'] = $dbw->timestamp( $this->mAttribs
['rc_timestamp'] );
257 $this->mAttribs
['rc_cur_time'] = $dbw->timestamp( $this->mAttribs
['rc_cur_time'] );
258 $this->mAttribs
['rc_id'] = $dbw->nextSequenceValue( 'recentchanges_rc_id_seq' );
260 ## If we are using foreign keys, an entry of 0 for the page_id will fail, so use NULL
261 if ( $dbw->cascadingDeletes() and $this->mAttribs
['rc_cur_id'] == 0 ) {
262 unset( $this->mAttribs
['rc_cur_id'] );
266 $dbw->insert( 'recentchanges', $this->mAttribs
, __METHOD__
);
269 $this->mAttribs
['rc_id'] = $dbw->insertId();
272 wfRunHooks( 'RecentChange_save', array( &$this ) );
274 # Notify external application via UDP
276 $this->notifyRCFeeds();
279 # E-mail notifications
280 if ( $wgUseEnotif ||
$wgShowUpdatedMarker ) {
281 $editor = $this->getPerformer();
282 $title = $this->getTitle();
284 if ( wfRunHooks( 'AbortEmailNotification', array( $editor, $title ) ) ) {
285 # @todo FIXME: This would be better as an extension hook
286 $enotif = new EmailNotification();
287 $enotif->notifyOnPageChange( $editor, $title,
288 $this->mAttribs
['rc_timestamp'],
289 $this->mAttribs
['rc_comment'],
290 $this->mAttribs
['rc_minor'],
291 $this->mAttribs
['rc_last_oldid'],
292 $this->mExtra
['pageStatus'] );
298 * @deprecated since 1.22, use notifyRCFeeds instead.
300 public function notifyRC2UDP() {
301 wfDeprecated( __METHOD__
, '1.22' );
302 $this->notifyRCFeeds();
306 * Send some text to UDP.
307 * @deprecated since 1.22
309 public static function sendToUDP( $line, $address = '', $prefix = '', $port = '' ) {
310 global $wgRC2UDPAddress, $wgRC2UDPInterwikiPrefix, $wgRC2UDPPort, $wgRC2UDPPrefix;
312 wfDeprecated( __METHOD__
, '1.22' );
314 # Assume default for standard RC case
315 $address = $address ?
$address : $wgRC2UDPAddress;
316 $prefix = $prefix ?
$prefix : $wgRC2UDPPrefix;
317 $port = $port ?
$port : $wgRC2UDPPort;
319 $engine = new UDPRCFeedEngine();
321 'uri' => "udp://$address:$port/$prefix",
322 'formatter' => 'IRCColourfulRCFeedFormatter',
323 'add_interwiki_prefix' => $wgRC2UDPInterwikiPrefix,
326 return $engine->send( $feed, $line );
330 * Notify all the feeds about the change.
332 public function notifyRCFeeds() {
335 foreach ( $wgRCFeeds as $feed ) {
336 $engine = self
::getEngine( $feed['uri'] );
338 if ( isset( $this->mExtra
['actionCommentIRC'] ) ) {
339 $actionComment = $this->mExtra
['actionCommentIRC'];
341 $actionComment = null;
344 $omitBots = isset( $feed['omit_bots'] ) ?
$feed['omit_bots'] : false;
347 ( $omitBots && $this->mAttribs
['rc_bot'] ) ||
348 $this->mAttribs
['rc_type'] == RC_EXTERNAL
353 $formatter = new $feed['formatter']();
354 $line = $formatter->getLine( $feed, $this, $actionComment );
356 $engine->send( $feed, $line );
361 * Gets the stream engine object for a given URI from $wgRCEngines
363 * @param $uri string URI to get the engine object for
364 * @return object The engine object
366 private static function getEngine( $uri ) {
369 $scheme = parse_url( $uri, PHP_URL_SCHEME
);
371 throw new MWException( __FUNCTION__
. ": Invalid stream logger URI: '$uri'" );
374 if ( !isset( $wgRCEngines[$scheme] ) ) {
375 throw new MWException( __FUNCTION__
. ": Unknown stream logger URI scheme: $scheme" );
378 return new $wgRCEngines[$scheme];
382 * @deprecated since 1.22, moved to IRCColourfulRCFeedFormatter
384 public static function cleanupForIRC( $text ) {
385 wfDeprecated( __METHOD__
, '1.22' );
386 return IRCColourfulRCFeedFormatter
::cleanupForIRC( $text );
390 * Mark a given change as patrolled
392 * @param $change Mixed: RecentChange or corresponding rc_id
393 * @param $auto Boolean: for automatic patrol
394 * @return Array See doMarkPatrolled(), or null if $change is not an existing rc_id
396 public static function markPatrolled( $change, $auto = false ) {
399 $change = $change instanceof RecentChange
401 : RecentChange
::newFromId( $change );
403 if ( !$change instanceof RecentChange
) {
406 return $change->doMarkPatrolled( $wgUser, $auto );
410 * Mark this RecentChange as patrolled
412 * NOTE: Can also return 'rcpatroldisabled', 'hookaborted' and 'markedaspatrollederror-noautopatrol' as errors
413 * @param $user User object doing the action
414 * @param $auto Boolean: for automatic patrol
415 * @return array of permissions errors, see Title::getUserPermissionsErrors()
417 public function doMarkPatrolled( User
$user, $auto = false ) {
418 global $wgUseRCPatrol, $wgUseNPPatrol;
420 // If recentchanges patrol is disabled, only new pages
422 if ( !$wgUseRCPatrol && ( !$wgUseNPPatrol ||
$this->getAttribute( 'rc_type' ) != RC_NEW
) ) {
423 $errors[] = array( 'rcpatroldisabled' );
425 // Automatic patrol needs "autopatrol", ordinary patrol needs "patrol"
426 $right = $auto ?
'autopatrol' : 'patrol';
427 $errors = array_merge( $errors, $this->getTitle()->getUserPermissionsErrors( $right, $user ) );
428 if ( !wfRunHooks( 'MarkPatrolled', array( $this->getAttribute( 'rc_id' ), &$user, false ) ) ) {
429 $errors[] = array( 'hookaborted' );
431 // Users without the 'autopatrol' right can't patrol their
433 if ( $user->getName() == $this->getAttribute( 'rc_user_text' ) && !$user->isAllowed( 'autopatrol' ) ) {
434 $errors[] = array( 'markedaspatrollederror-noautopatrol' );
439 // If the change was patrolled already, do nothing
440 if ( $this->getAttribute( 'rc_patrolled' ) ) {
443 // Actually set the 'patrolled' flag in RC
444 $this->reallyMarkPatrolled();
445 // Log this patrol event
446 PatrolLog
::record( $this, $auto, $user );
447 wfRunHooks( 'MarkPatrolledComplete', array( $this->getAttribute( 'rc_id' ), &$user, false ) );
452 * Mark this RecentChange patrolled, without error checking
453 * @return Integer: number of affected rows
455 public function reallyMarkPatrolled() {
456 $dbw = wfGetDB( DB_MASTER
);
463 'rc_id' => $this->getAttribute( 'rc_id' )
467 // Invalidate the page cache after the page has been patrolled
468 // to make sure that the Patrol link isn't visible any longer!
469 $this->getTitle()->invalidateCache();
470 return $dbw->affectedRows();
474 * Makes an entry in the database corresponding to an edit
477 * @param $title Title
482 * @param $lastTimestamp
485 * @param $oldSize int
486 * @param $newSize int
489 * @return RecentChange
491 public static function notifyEdit( $timestamp, &$title, $minor, &$user, $comment, $oldId,
492 $lastTimestamp, $bot, $ip = '', $oldSize = 0, $newSize = 0, $newId = 0, $patrol = 0 ) {
493 $rc = new RecentChange
;
494 $rc->mTitle
= $title;
495 $rc->mPerformer
= $user;
496 $rc->mAttribs
= array(
497 'rc_timestamp' => $timestamp,
498 'rc_cur_time' => $timestamp,
499 'rc_namespace' => $title->getNamespace(),
500 'rc_title' => $title->getDBkey(),
501 'rc_type' => RC_EDIT
,
502 'rc_source' => self
::SRC_EDIT
,
503 'rc_minor' => $minor ?
1 : 0,
504 'rc_cur_id' => $title->getArticleID(),
505 'rc_user' => $user->getId(),
506 'rc_user_text' => $user->getName(),
507 'rc_comment' => $comment,
508 'rc_this_oldid' => $newId,
509 'rc_last_oldid' => $oldId,
510 'rc_bot' => $bot ?
1 : 0,
511 'rc_ip' => self
::checkIPAddress( $ip ),
512 'rc_patrolled' => intval( $patrol ),
513 'rc_new' => 0, # obsolete
514 'rc_old_len' => $oldSize,
515 'rc_new_len' => $newSize,
518 'rc_log_type' => null,
519 'rc_log_action' => '',
524 'prefixedDBkey' => $title->getPrefixedDBkey(),
525 'lastTimestamp' => $lastTimestamp,
526 'oldSize' => $oldSize,
527 'newSize' => $newSize,
528 'pageStatus' => 'changed'
535 * Makes an entry in the database corresponding to page creation
536 * Note: the title object must be loaded with the new id using resetArticleID()
537 * @todo Document parameters and return
540 * @param $title Title
549 * @return RecentChange
551 public static function notifyNew( $timestamp, &$title, $minor, &$user, $comment, $bot,
552 $ip = '', $size = 0, $newId = 0, $patrol = 0 ) {
553 $rc = new RecentChange
;
554 $rc->mTitle
= $title;
555 $rc->mPerformer
= $user;
556 $rc->mAttribs
= array(
557 'rc_timestamp' => $timestamp,
558 'rc_cur_time' => $timestamp,
559 'rc_namespace' => $title->getNamespace(),
560 'rc_title' => $title->getDBkey(),
562 'rc_source' => self
::SRC_NEW
,
563 'rc_minor' => $minor ?
1 : 0,
564 'rc_cur_id' => $title->getArticleID(),
565 'rc_user' => $user->getId(),
566 'rc_user_text' => $user->getName(),
567 'rc_comment' => $comment,
568 'rc_this_oldid' => $newId,
569 'rc_last_oldid' => 0,
570 'rc_bot' => $bot ?
1 : 0,
571 'rc_ip' => self
::checkIPAddress( $ip ),
572 'rc_patrolled' => intval( $patrol ),
573 'rc_new' => 1, # obsolete
575 'rc_new_len' => $size,
578 'rc_log_type' => null,
579 'rc_log_action' => '',
584 'prefixedDBkey' => $title->getPrefixedDBkey(),
585 'lastTimestamp' => 0,
588 'pageStatus' => 'created'
598 * @param $actionComment
606 * @param $actionCommentIRC string
609 public static function notifyLog( $timestamp, &$title, &$user, $actionComment, $ip, $type,
610 $action, $target, $logComment, $params, $newId = 0, $actionCommentIRC = '' )
612 global $wgLogRestrictions;
613 # Don't add private logs to RC!
614 if ( isset( $wgLogRestrictions[$type] ) && $wgLogRestrictions[$type] != '*' ) {
617 $rc = self
::newLogEntry( $timestamp, $title, $user, $actionComment, $ip, $type, $action,
618 $target, $logComment, $params, $newId, $actionCommentIRC );
625 * @param $title Title
627 * @param $actionComment
631 * @param $target Title
635 * @param $actionCommentIRC string
636 * @return RecentChange
638 public static function newLogEntry( $timestamp, &$title, &$user, $actionComment, $ip,
639 $type, $action, $target, $logComment, $params, $newId = 0, $actionCommentIRC = '' ) {
642 ## Get pageStatus for email notification
643 switch ( $type . '-' . $action ) {
644 case 'delete-delete':
645 $pageStatus = 'deleted';
648 case 'move-move_redir':
649 $pageStatus = 'moved';
651 case 'delete-restore':
652 $pageStatus = 'restored';
654 case 'upload-upload':
655 $pageStatus = 'created';
657 case 'upload-overwrite':
659 $pageStatus = 'changed';
663 $rc = new RecentChange
;
664 $rc->mTitle
= $target;
665 $rc->mPerformer
= $user;
666 $rc->mAttribs
= array(
667 'rc_timestamp' => $timestamp,
668 'rc_cur_time' => $timestamp,
669 'rc_namespace' => $target->getNamespace(),
670 'rc_title' => $target->getDBkey(),
672 'rc_source' => self
::SRC_LOG
,
674 'rc_cur_id' => $target->getArticleID(),
675 'rc_user' => $user->getId(),
676 'rc_user_text' => $user->getName(),
677 'rc_comment' => $logComment,
678 'rc_this_oldid' => 0,
679 'rc_last_oldid' => 0,
680 'rc_bot' => $user->isAllowed( 'bot' ) ?
$wgRequest->getBool( 'bot', true ) : 0,
681 'rc_ip' => self
::checkIPAddress( $ip ),
683 'rc_new' => 0, # obsolete
684 'rc_old_len' => null,
685 'rc_new_len' => null,
687 'rc_logid' => $newId,
688 'rc_log_type' => $type,
689 'rc_log_action' => $action,
690 'rc_params' => $params
694 'prefixedDBkey' => $title->getPrefixedDBkey(),
695 'lastTimestamp' => 0,
696 'actionComment' => $actionComment, // the comment appended to the action, passed from LogPage
697 'pageStatus' => $pageStatus,
698 'actionCommentIRC' => $actionCommentIRC
704 * Initialises the members of this object from a mysql row object
708 public function loadFromRow( $row ) {
709 $this->mAttribs
= get_object_vars( $row );
710 $this->mAttribs
['rc_timestamp'] = wfTimestamp( TS_MW
, $this->mAttribs
['rc_timestamp'] );
711 $this->mAttribs
['rc_deleted'] = $row->rc_deleted
; // MUST be set
715 * Makes a pseudo-RC entry from a cur row
717 * @deprecated in 1.22
720 public function loadFromCurRow( $row ) {
721 wfDeprecated( __METHOD__
, '1.22' );
722 $this->mAttribs
= array(
723 'rc_timestamp' => wfTimestamp( TS_MW
, $row->rev_timestamp
),
724 'rc_cur_time' => $row->rev_timestamp
,
725 'rc_user' => $row->rev_user
,
726 'rc_user_text' => $row->rev_user_text
,
727 'rc_namespace' => $row->page_namespace
,
728 'rc_title' => $row->page_title
,
729 'rc_comment' => $row->rev_comment
,
730 'rc_minor' => $row->rev_minor_edit ?
1 : 0,
731 'rc_type' => $row->page_is_new ? RC_NEW
: RC_EDIT
,
732 'rc_source' => $row->page_is_new ? self
::SRC_NEW
: self
::SRC_EDIT
,
733 'rc_cur_id' => $row->page_id
,
734 'rc_this_oldid' => $row->rev_id
,
735 'rc_last_oldid' => isset( $row->rc_last_oldid
) ?
$row->rc_last_oldid
: 0,
738 'rc_id' => $row->rc_id
,
739 'rc_patrolled' => $row->rc_patrolled
,
740 'rc_new' => $row->page_is_new
, # obsolete
741 'rc_old_len' => $row->rc_old_len
,
742 'rc_new_len' => $row->rc_new_len
,
743 'rc_params' => isset( $row->rc_params
) ?
$row->rc_params
: '',
744 'rc_log_type' => isset( $row->rc_log_type
) ?
$row->rc_log_type
: null,
745 'rc_log_action' => isset( $row->rc_log_action
) ?
$row->rc_log_action
: null,
746 'rc_logid' => isset( $row->rc_logid
) ?
$row->rc_logid
: 0,
747 'rc_deleted' => $row->rc_deleted
// MUST be set
752 * Get an attribute value
754 * @param string $name Attribute name
757 public function getAttribute( $name ) {
758 return isset( $this->mAttribs
[$name] ) ?
$this->mAttribs
[$name] : null;
764 public function getAttributes() {
765 return $this->mAttribs
;
769 * Gets the end part of the diff URL associated with this object
770 * Blank if no diff link should be displayed
774 public function diffLinkTrail( $forceCur ) {
775 if ( $this->mAttribs
['rc_type'] == RC_EDIT
) {
776 $trail = "curid=" . (int)( $this->mAttribs
['rc_cur_id'] ) .
777 "&oldid=" . (int)( $this->mAttribs
['rc_last_oldid'] );
781 $trail .= '&diff=' . (int)( $this->mAttribs
['rc_this_oldid'] );
790 * Returns the change size (HTML).
791 * The lengths can be given optionally.
796 public function getCharacterDifference( $old = 0, $new = 0 ) {
798 $old = $this->mAttribs
['rc_old_len'];
801 $new = $this->mAttribs
['rc_new_len'];
803 if ( $old === null ||
$new === null ) {
806 return ChangesList
::showCharacterDifference( $old, $new );
810 * Purge expired changes from the recentchanges table
813 public static function purgeExpiredChanges() {
814 if ( wfReadOnly() ) {
818 $method = __METHOD__
;
819 $dbw = wfGetDB( DB_MASTER
);
820 $dbw->onTransactionIdle( function() use ( $dbw, $method ) {
823 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
826 array( 'rc_timestamp < ' . $dbw->addQuotes( $cutoff ) ),
832 private static function checkIPAddress( $ip ) {
835 if ( !IP
::isIPAddress( $ip ) ) {
836 throw new MWException( "Attempt to write \"" . $ip . "\" as an IP address into recent changes" );
839 $ip = $wgRequest->getIP();
848 * Check whether the given timestamp is new enough to have a RC row with a given tolerance
849 * as the recentchanges table might not be cleared out regularly (so older entries might exist)
850 * or rows which will be deleted soon shouldn't be included.
852 * @param $timestamp mixed MWTimestamp compatible timestamp
853 * @param $tolerance integer Tolerance in seconds
856 public static function isInRCLifespan( $timestamp, $tolerance = 0 ) {
858 return wfTimestamp( TS_UNIX
, $timestamp ) > time() - $tolerance - $wgRCMaxAge;