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
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
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 * lang the interwiki prefix, automatically set in save()
56 * oldSize text size before the change
57 * newSize text size after the change
59 * temporary: not stored in the database
60 * notificationtimestamp
61 * numberofWatchingusers
63 * @todo document functions and variables
66 var $mAttribs = array(), $mExtra = array();
76 private $mPerformer = false;
81 var $mMovedToTitle = false;
82 var $numberofWatchingusers = 0 ; # Dummy to prevent error message in SpecialRecentchangeslinked
83 var $notificationtimestamp;
89 * @return RecentChange
91 public static function newFromRow( $row ) {
92 $rc = new RecentChange
;
93 $rc->loadFromRow( $row );
99 * @return RecentChange
101 public static function newFromCurRow( $row ) {
102 $rc = new RecentChange
;
103 $rc->loadFromCurRow( $row );
104 $rc->notificationtimestamp
= false;
105 $rc->numberofWatchingusers
= false;
110 * Obtain the recent change with a given rc_id value
112 * @param $rcid Int rc_id value to retrieve
113 * @return RecentChange
115 public static function newFromId( $rcid ) {
116 return self
::newFromConds( array( 'rc_id' => $rcid ), __METHOD__
);
120 * Find the first recent change matching some specific conditions
122 * @param $conds Array of conditions
123 * @param $fname Mixed: override the method name in profiling/logs
124 * @return RecentChange
126 public static function newFromConds( $conds, $fname = __METHOD__
) {
127 $dbr = wfGetDB( DB_SLAVE
);
128 $row = $dbr->selectRow( 'recentchanges', '*', $conds, $fname );
129 if ( $row !== false ) {
130 return self
::newFromRow( $row );
139 * @param $attribs array
141 public function setAttribs( $attribs ) {
142 $this->mAttribs
= $attribs;
146 * @param $extra array
148 public function setExtra( $extra ) {
149 $this->mExtra
= $extra;
156 public function &getTitle() {
157 if ( $this->mTitle
=== false ) {
158 $this->mTitle
= Title
::makeTitle( $this->mAttribs
['rc_namespace'], $this->mAttribs
['rc_title'] );
159 # Make sure the correct page ID is process cached
160 $this->mTitle
->resetArticleID( $this->mAttribs
['rc_cur_id'] );
162 return $this->mTitle
;
166 * Get the User object of the person who performed this change.
170 public function getPerformer() {
171 if ( $this->mPerformer
=== false ) {
172 if ( $this->mAttribs
['rc_user'] ) {
173 $this->mPerformer
= User
::newFromID( $this->mAttribs
['rc_user'] );
175 $this->mPerformer
= User
::newFromName( $this->mAttribs
['rc_user_text'], false );
178 return $this->mPerformer
;
182 * Writes the data in this object to the database
185 public function save( $noudp = false ) {
186 global $wgLocalInterwiki, $wgPutIPinRC, $wgUseEnotif, $wgShowUpdatedMarker, $wgContLang;
188 $dbw = wfGetDB( DB_MASTER
);
189 if ( !is_array( $this->mExtra
) ) {
190 $this->mExtra
= array();
192 $this->mExtra
['lang'] = $wgLocalInterwiki;
194 if ( !$wgPutIPinRC ) {
195 $this->mAttribs
['rc_ip'] = '';
198 # If our database is strict about IP addresses, use NULL instead of an empty string
199 if ( $dbw->strictIPs() and $this->mAttribs
['rc_ip'] == '' ) {
200 unset( $this->mAttribs
['rc_ip'] );
203 # Make sure summary is truncated (whole multibyte characters)
204 $this->mAttribs
['rc_comment'] = $wgContLang->truncate( $this->mAttribs
['rc_comment'], 255 );
206 # Fixup database timestamps
207 $this->mAttribs
['rc_timestamp'] = $dbw->timestamp( $this->mAttribs
['rc_timestamp'] );
208 $this->mAttribs
['rc_cur_time'] = $dbw->timestamp( $this->mAttribs
['rc_cur_time'] );
209 $this->mAttribs
['rc_id'] = $dbw->nextSequenceValue( 'recentchanges_rc_id_seq' );
211 ## If we are using foreign keys, an entry of 0 for the page_id will fail, so use NULL
212 if ( $dbw->cascadingDeletes() and $this->mAttribs
['rc_cur_id'] == 0 ) {
213 unset( $this->mAttribs
['rc_cur_id'] );
217 $dbw->insert( 'recentchanges', $this->mAttribs
, __METHOD__
);
220 $this->mAttribs
['rc_id'] = $dbw->insertId();
223 wfRunHooks( 'RecentChange_save', array( &$this ) );
225 # Notify external application via UDP
227 $this->notifyRC2UDP();
230 # E-mail notifications
231 if ( $wgUseEnotif ||
$wgShowUpdatedMarker ) {
232 $editor = $this->getPerformer();
233 $title = $this->getTitle();
235 if ( wfRunHooks( 'AbortEmailNotification', array( $editor, $title ) ) ) {
236 # @todo FIXME: This would be better as an extension hook
237 $enotif = new EmailNotification();
238 $enotif->notifyOnPageChange( $editor, $title,
239 $this->mAttribs
['rc_timestamp'],
240 $this->mAttribs
['rc_comment'],
241 $this->mAttribs
['rc_minor'],
242 $this->mAttribs
['rc_last_oldid'] );
247 public function notifyRC2UDP() {
248 global $wgRC2UDPAddress, $wgRC2UDPOmitBots;
249 # Notify external application via UDP
250 if ( $wgRC2UDPAddress && ( !$this->mAttribs
['rc_bot'] ||
!$wgRC2UDPOmitBots ) ) {
251 self
::sendToUDP( $this->getIRCLine() );
256 * Send some text to UDP.
257 * @see RecentChange::cleanupForIRC
258 * @param $line String: text to send
259 * @param $address String: defaults to $wgRC2UDPAddress.
260 * @param $prefix String: defaults to $wgRC2UDPPrefix.
261 * @param $port Int: defaults to $wgRC2UDPPort. (Since 1.17)
262 * @return Boolean: success
264 public static function sendToUDP( $line, $address = '', $prefix = '', $port = '' ) {
265 global $wgRC2UDPAddress, $wgRC2UDPPrefix, $wgRC2UDPPort;
266 # Assume default for standard RC case
267 $address = $address ?
$address : $wgRC2UDPAddress;
268 $prefix = $prefix ?
$prefix : $wgRC2UDPPrefix;
269 $port = $port ?
$port : $wgRC2UDPPort;
270 # Notify external application via UDP
272 $conn = socket_create( AF_INET
, SOCK_DGRAM
, SOL_UDP
);
274 $line = $prefix . $line;
275 wfDebug( __METHOD__
. ": sending UDP line: $line\n" );
276 socket_sendto( $conn, $line, strlen( $line ), 0, $address, $port );
277 socket_close( $conn );
280 wfDebug( __METHOD__
. ": failed to create UDP socket\n" );
287 * Remove newlines, carriage returns and decode html entites
288 * @param $text String
291 public static function cleanupForIRC( $text ) {
292 return Sanitizer
::decodeCharReferences( str_replace( array( "\n", "\r" ), array( "", "" ), $text ) );
296 * Mark a given change as patrolled
298 * @param $change Mixed: RecentChange or corresponding rc_id
299 * @param $auto Boolean: for automatic patrol
300 * @return Array See doMarkPatrolled(), or null if $change is not an existing rc_id
302 public static function markPatrolled( $change, $auto = false ) {
305 $change = $change instanceof RecentChange
307 : RecentChange
::newFromId( $change );
309 if ( !$change instanceof RecentChange
) {
312 return $change->doMarkPatrolled( $wgUser, $auto );
316 * Mark this RecentChange as patrolled
318 * NOTE: Can also return 'rcpatroldisabled', 'hookaborted' and 'markedaspatrollederror-noautopatrol' as errors
319 * @param $user User object doing the action
320 * @param $auto Boolean: for automatic patrol
321 * @return array of permissions errors, see Title::getUserPermissionsErrors()
323 public function doMarkPatrolled( User
$user, $auto = false ) {
324 global $wgUseRCPatrol, $wgUseNPPatrol;
326 // If recentchanges patrol is disabled, only new pages
328 if ( !$wgUseRCPatrol && ( !$wgUseNPPatrol ||
$this->getAttribute( 'rc_type' ) != RC_NEW
) ) {
329 $errors[] = array( 'rcpatroldisabled' );
331 // Automatic patrol needs "autopatrol", ordinary patrol needs "patrol"
332 $right = $auto ?
'autopatrol' : 'patrol';
333 $errors = array_merge( $errors, $this->getTitle()->getUserPermissionsErrors( $right, $user ) );
334 if ( !wfRunHooks( 'MarkPatrolled', array( $this->getAttribute( 'rc_id' ), &$user, false ) ) ) {
335 $errors[] = array( 'hookaborted' );
337 // Users without the 'autopatrol' right can't patrol their
339 if ( $user->getName() == $this->getAttribute( 'rc_user_text' ) && !$user->isAllowed( 'autopatrol' ) ) {
340 $errors[] = array( 'markedaspatrollederror-noautopatrol' );
345 // If the change was patrolled already, do nothing
346 if ( $this->getAttribute( 'rc_patrolled' ) ) {
349 // Actually set the 'patrolled' flag in RC
350 $this->reallyMarkPatrolled();
351 // Log this patrol event
352 PatrolLog
::record( $this, $auto, $user );
353 wfRunHooks( 'MarkPatrolledComplete', array( $this->getAttribute( 'rc_id' ), &$user, false ) );
358 * Mark this RecentChange patrolled, without error checking
359 * @return Integer: number of affected rows
361 public function reallyMarkPatrolled() {
362 $dbw = wfGetDB( DB_MASTER
);
369 'rc_id' => $this->getAttribute( 'rc_id' )
373 return $dbw->affectedRows();
377 * Makes an entry in the database corresponding to an edit
380 * @param $title Title
385 * @param $lastTimestamp
388 * @param $oldSize int
389 * @param $newSize int
392 * @return RecentChange
394 public static function notifyEdit( $timestamp, &$title, $minor, &$user, $comment, $oldId,
395 $lastTimestamp, $bot, $ip = '', $oldSize = 0, $newSize = 0, $newId = 0, $patrol = 0 ) {
396 $rc = new RecentChange
;
397 $rc->mTitle
= $title;
398 $rc->mPerformer
= $user;
399 $rc->mAttribs
= array(
400 'rc_timestamp' => $timestamp,
401 'rc_cur_time' => $timestamp,
402 'rc_namespace' => $title->getNamespace(),
403 'rc_title' => $title->getDBkey(),
404 'rc_type' => RC_EDIT
,
405 'rc_minor' => $minor ?
1 : 0,
406 'rc_cur_id' => $title->getArticleID(),
407 'rc_user' => $user->getId(),
408 'rc_user_text' => $user->getName(),
409 'rc_comment' => $comment,
410 'rc_this_oldid' => $newId,
411 'rc_last_oldid' => $oldId,
412 'rc_bot' => $bot ?
1 : 0,
413 'rc_ip' => self
::checkIPAddress( $ip ),
414 'rc_patrolled' => intval( $patrol ),
415 'rc_new' => 0, # obsolete
416 'rc_old_len' => $oldSize,
417 'rc_new_len' => $newSize,
420 'rc_log_type' => null,
421 'rc_log_action' => '',
426 'prefixedDBkey' => $title->getPrefixedDBkey(),
427 'lastTimestamp' => $lastTimestamp,
428 'oldSize' => $oldSize,
429 'newSize' => $newSize,
436 * Makes an entry in the database corresponding to page creation
437 * Note: the title object must be loaded with the new id using resetArticleID()
438 * @todo Document parameters and return
441 * @param $title Title
450 * @return RecentChange
452 public static function notifyNew( $timestamp, &$title, $minor, &$user, $comment, $bot,
453 $ip = '', $size = 0, $newId = 0, $patrol = 0 ) {
454 $rc = new RecentChange
;
455 $rc->mTitle
= $title;
456 $rc->mPerformer
= $user;
457 $rc->mAttribs
= array(
458 'rc_timestamp' => $timestamp,
459 'rc_cur_time' => $timestamp,
460 'rc_namespace' => $title->getNamespace(),
461 'rc_title' => $title->getDBkey(),
463 'rc_minor' => $minor ?
1 : 0,
464 'rc_cur_id' => $title->getArticleID(),
465 'rc_user' => $user->getId(),
466 'rc_user_text' => $user->getName(),
467 'rc_comment' => $comment,
468 'rc_this_oldid' => $newId,
469 'rc_last_oldid' => 0,
470 'rc_bot' => $bot ?
1 : 0,
471 'rc_ip' => self
::checkIPAddress( $ip ),
472 'rc_patrolled' => intval( $patrol ),
473 'rc_new' => 1, # obsolete
475 'rc_new_len' => $size,
478 'rc_log_type' => null,
479 'rc_log_action' => '',
484 'prefixedDBkey' => $title->getPrefixedDBkey(),
485 'lastTimestamp' => 0,
497 * @param $actionComment
505 * @param $actionCommentIRC string
508 public static function notifyLog( $timestamp, &$title, &$user, $actionComment, $ip, $type,
509 $action, $target, $logComment, $params, $newId = 0, $actionCommentIRC = '' )
511 global $wgLogRestrictions;
512 # Don't add private logs to RC!
513 if ( isset( $wgLogRestrictions[$type] ) && $wgLogRestrictions[$type] != '*' ) {
516 $rc = self
::newLogEntry( $timestamp, $title, $user, $actionComment, $ip, $type, $action,
517 $target, $logComment, $params, $newId, $actionCommentIRC );
524 * @param $title Title
526 * @param $actionComment
530 * @param $target Title
534 * @param $actionCommentIRC string
535 * @return RecentChange
537 public static function newLogEntry( $timestamp, &$title, &$user, $actionComment, $ip,
538 $type, $action, $target, $logComment, $params, $newId = 0, $actionCommentIRC = '' ) {
541 $rc = new RecentChange
;
542 $rc->mTitle
= $target;
543 $rc->mPerformer
= $user;
544 $rc->mAttribs
= array(
545 'rc_timestamp' => $timestamp,
546 'rc_cur_time' => $timestamp,
547 'rc_namespace' => $target->getNamespace(),
548 'rc_title' => $target->getDBkey(),
551 'rc_cur_id' => $target->getArticleID(),
552 'rc_user' => $user->getId(),
553 'rc_user_text' => $user->getName(),
554 'rc_comment' => $logComment,
555 'rc_this_oldid' => 0,
556 'rc_last_oldid' => 0,
557 'rc_bot' => $user->isAllowed( 'bot' ) ?
$wgRequest->getBool( 'bot', true ) : 0,
558 'rc_ip' => self
::checkIPAddress( $ip ),
560 'rc_new' => 0, # obsolete
561 'rc_old_len' => null,
562 'rc_new_len' => null,
564 'rc_logid' => $newId,
565 'rc_log_type' => $type,
566 'rc_log_action' => $action,
567 'rc_params' => $params
571 'prefixedDBkey' => $title->getPrefixedDBkey(),
572 'lastTimestamp' => 0,
573 'actionComment' => $actionComment, // the comment appended to the action, passed from LogPage
574 'actionCommentIRC' => $actionCommentIRC
580 * Initialises the members of this object from a mysql row object
584 public function loadFromRow( $row ) {
585 $this->mAttribs
= get_object_vars( $row );
586 $this->mAttribs
['rc_timestamp'] = wfTimestamp( TS_MW
, $this->mAttribs
['rc_timestamp'] );
587 $this->mAttribs
['rc_deleted'] = $row->rc_deleted
; // MUST be set
591 * Makes a pseudo-RC entry from a cur row
595 public function loadFromCurRow( $row ) {
596 $this->mAttribs
= array(
597 'rc_timestamp' => wfTimestamp( TS_MW
, $row->rev_timestamp
),
598 'rc_cur_time' => $row->rev_timestamp
,
599 'rc_user' => $row->rev_user
,
600 'rc_user_text' => $row->rev_user_text
,
601 'rc_namespace' => $row->page_namespace
,
602 'rc_title' => $row->page_title
,
603 'rc_comment' => $row->rev_comment
,
604 'rc_minor' => $row->rev_minor_edit ?
1 : 0,
605 'rc_type' => $row->page_is_new ? RC_NEW
: RC_EDIT
,
606 'rc_cur_id' => $row->page_id
,
607 'rc_this_oldid' => $row->rev_id
,
608 'rc_last_oldid' => isset( $row->rc_last_oldid
) ?
$row->rc_last_oldid
: 0,
611 'rc_id' => $row->rc_id
,
612 'rc_patrolled' => $row->rc_patrolled
,
613 'rc_new' => $row->page_is_new
, # obsolete
614 'rc_old_len' => $row->rc_old_len
,
615 'rc_new_len' => $row->rc_new_len
,
616 'rc_params' => isset( $row->rc_params
) ?
$row->rc_params
: '',
617 'rc_log_type' => isset( $row->rc_log_type
) ?
$row->rc_log_type
: null,
618 'rc_log_action' => isset( $row->rc_log_action
) ?
$row->rc_log_action
: null,
619 'rc_logid' => isset( $row->rc_logid
) ?
$row->rc_logid
: 0,
620 'rc_deleted' => $row->rc_deleted
// MUST be set
625 * Get an attribute value
627 * @param $name String Attribute name
630 public function getAttribute( $name ) {
631 return isset( $this->mAttribs
[$name] ) ?
$this->mAttribs
[$name] : null;
637 public function getAttributes() {
638 return $this->mAttribs
;
642 * Gets the end part of the diff URL associated with this object
643 * Blank if no diff link should be displayed
647 public function diffLinkTrail( $forceCur ) {
648 if ( $this->mAttribs
['rc_type'] == RC_EDIT
) {
649 $trail = "curid=" . (int)( $this->mAttribs
['rc_cur_id'] ) .
650 "&oldid=" . (int)( $this->mAttribs
['rc_last_oldid'] );
652 $trail .= '&diff=0' ;
654 $trail .= '&diff=' . (int)( $this->mAttribs
['rc_this_oldid'] );
665 public function getIRCLine() {
666 global $wgUseRCPatrol, $wgUseNPPatrol, $wgRC2UDPInterwikiPrefix, $wgLocalInterwiki,
667 $wgCanonicalServer, $wgScript;
669 if ( $this->mAttribs
['rc_type'] == RC_LOG
) {
670 // Don't use SpecialPage::getTitleFor, backwards compatibility with
671 // IRC API which expects "Log".
672 $titleObj = Title
::newFromText( 'Log/' . $this->mAttribs
['rc_log_type'], NS_SPECIAL
);
674 $titleObj =& $this->getTitle();
676 $title = $titleObj->getPrefixedText();
677 $title = self
::cleanupForIRC( $title );
679 if ( $this->mAttribs
['rc_type'] == RC_LOG
) {
682 $url = $wgCanonicalServer . $wgScript;
683 if ( $this->mAttribs
['rc_type'] == RC_NEW
) {
684 $query = '?oldid=' . $this->mAttribs
['rc_this_oldid'];
686 $query = '?diff=' . $this->mAttribs
['rc_this_oldid'] . '&oldid=' . $this->mAttribs
['rc_last_oldid'];
688 if ( $wgUseRCPatrol ||
( $this->mAttribs
['rc_type'] == RC_NEW
&& $wgUseNPPatrol ) ) {
689 $query .= '&rcid=' . $this->mAttribs
['rc_id'];
691 // HACK: We need this hook for WMF's secure server setup
692 wfRunHooks( 'IRCLineURL', array( &$url, &$query ) );
696 if ( $this->mAttribs
['rc_old_len'] !== null && $this->mAttribs
['rc_new_len'] !== null ) {
697 $szdiff = $this->mAttribs
['rc_new_len'] - $this->mAttribs
['rc_old_len'];
698 if ( $szdiff < -500 ) {
699 $szdiff = "\002$szdiff\002";
700 } elseif ( $szdiff >= 0 ) {
701 $szdiff = '+' . $szdiff ;
703 // @todo i18n with parentheses in content language?
704 $szdiff = '(' . $szdiff . ')' ;
709 $user = self
::cleanupForIRC( $this->mAttribs
['rc_user_text'] );
711 if ( $this->mAttribs
['rc_type'] == RC_LOG
) {
712 $targetText = $this->getTitle()->getPrefixedText();
713 $comment = self
::cleanupForIRC( str_replace( "[[$targetText]]", "[[\00302$targetText\00310]]", $this->mExtra
['actionCommentIRC'] ) );
714 $flag = $this->mAttribs
['rc_log_action'];
716 $comment = self
::cleanupForIRC( $this->mAttribs
['rc_comment'] );
718 if ( !$this->mAttribs
['rc_patrolled'] && ( $wgUseRCPatrol ||
$this->mAttribs
['rc_type'] == RC_NEW
&& $wgUseNPPatrol ) ) {
721 $flag .= ( $this->mAttribs
['rc_type'] == RC_NEW ?
"N" : "" ) . ( $this->mAttribs
['rc_minor'] ?
"M" : "" ) . ( $this->mAttribs
['rc_bot'] ?
"B" : "" );
724 if ( $wgRC2UDPInterwikiPrefix === true && $wgLocalInterwiki !== false ) {
725 $prefix = $wgLocalInterwiki;
726 } elseif ( $wgRC2UDPInterwikiPrefix ) {
727 $prefix = $wgRC2UDPInterwikiPrefix;
731 if ( $prefix !== false ) {
732 $titleString = "\00314[[\00303$prefix:\00307$title\00314]]";
734 $titleString = "\00314[[\00307$title\00314]]";
737 # see http://www.irssi.org/documentation/formats for some colour codes. prefix is \003,
738 # no colour (\003) switches back to the term default
739 $fullString = "$titleString\0034 $flag\00310 " .
740 "\00302$url\003 \0035*\003 \00303$user\003 \0035*\003 $szdiff \00310$comment\003\n";
746 * Returns the change size (HTML).
747 * The lengths can be given optionally.
752 public function getCharacterDifference( $old = 0, $new = 0 ) {
754 $old = $this->mAttribs
['rc_old_len'];
757 $new = $this->mAttribs
['rc_new_len'];
759 if ( $old === null ||
$new === null ) {
762 return ChangesList
::showCharacterDifference( $old, $new );
765 private static function checkIPAddress( $ip ) {
768 if ( !IP
::isIPAddress( $ip ) ) {
769 throw new MWException( "Attempt to write \"" . $ip . "\" as an IP address into recent changes" );
772 $ip = $wgRequest->getIP();