4 * Utility class for creating new RC entries
6 * rc_id id of the row in the recentchanges table
7 * rc_timestamp time the entry was made
8 * rc_cur_time timestamp on the cur row
9 * rc_namespace namespace #
10 * rc_title non-prefixed db key
11 * rc_type is new entry, used to determine whether updating is necessary
13 * rc_cur_id page_id of associated page entry
14 * rc_user user id who made the entry
15 * rc_user_text user name who made the entry
16 * rc_comment edit summary
17 * rc_this_oldid rev_id associated with this entry (or zero)
18 * rc_last_oldid rev_id associated with the entry before this one (or zero)
19 * rc_bot is bot, hidden
20 * rc_ip IP address of the user in dotted quad notation
21 * rc_new obsolete, use rc_type==RC_NEW
22 * rc_patrolled boolean whether or not someone has marked this edit as patrolled
23 * rc_old_len integer byte length of the text before the edit
24 * rc_new_len the same after the edit
25 * rc_deleted partial deletion
26 * rc_logid the log_id value for this log entry (or zero)
27 * rc_log_type the log type (or null)
28 * rc_log_action the log action (or null)
29 * rc_params log params
32 * prefixedDBkey prefixed db key, used by external app via msg queue
33 * lastTimestamp timestamp of previous entry, used in WHERE clause during update
34 * lang the interwiki prefix, automatically set in save()
35 * oldSize text size before the change
36 * newSize text size after the change
38 * temporary: not stored in the database
39 * notificationtimestamp
40 * numberofWatchingusers
42 * @todo document functions and variables
46 var $mAttribs = array(), $mExtra = array();
47 var $mTitle = false, $mMovedToTitle = false;
48 var $numberofWatchingusers = 0 ; # Dummy to prevent error message in SpecialRecentchangeslinked
52 public static function newFromRow( $row ) {
53 $rc = new RecentChange
;
54 $rc->loadFromRow( $row );
58 public static function newFromCurRow( $row ) {
59 $rc = new RecentChange
;
60 $rc->loadFromCurRow( $row );
61 $rc->notificationtimestamp
= false;
62 $rc->numberofWatchingusers
= false;
67 * Obtain the recent change with a given rc_id value
69 * @param $rcid rc_id value to retrieve
70 * @return RecentChange
72 public static function newFromId( $rcid ) {
73 $dbr = wfGetDB( DB_SLAVE
);
74 $res = $dbr->select( 'recentchanges', '*', array( 'rc_id' => $rcid ), __METHOD__
);
75 if( $res && $dbr->numRows( $res ) > 0 ) {
76 $row = $dbr->fetchObject( $res );
77 $dbr->freeResult( $res );
78 return self
::newFromRow( $row );
85 * Find the first recent change matching some specific conditions
87 * @param array $conds Array of conditions
88 * @param mixed $fname Override the method name in profiling/logs
89 * @return RecentChange
91 public static function newFromConds( $conds, $fname = false ) {
92 if( $fname === false )
94 $dbr = wfGetDB( DB_SLAVE
);
101 if( $res instanceof ResultWrapper
&& $res->numRows() > 0 ) {
102 $row = $res->fetchObject();
104 return self
::newFromRow( $row );
111 public function setAttribs( $attribs ) {
112 $this->mAttribs
= $attribs;
115 public function setExtra( $extra ) {
116 $this->mExtra
= $extra;
119 public function &getTitle() {
120 if( $this->mTitle
=== false ) {
121 $this->mTitle
= Title
::makeTitle( $this->mAttribs
['rc_namespace'], $this->mAttribs
['rc_title'] );
123 return $this->mTitle
;
126 public function getMovedToTitle() {
127 if( $this->mMovedToTitle
=== false ) {
128 $this->mMovedToTitle
= Title
::makeTitle( $this->mAttribs
['rc_moved_to_ns'],
129 $this->mAttribs
['rc_moved_to_title'] );
131 return $this->mMovedToTitle
;
134 # Writes the data in this object to the database
135 public function save() {
136 global $wgLocalInterwiki, $wgPutIPinRC, $wgRC2UDPAddress, $wgRC2UDPOmitBots;
137 $fname = 'RecentChange::save';
139 $dbw = wfGetDB( DB_MASTER
);
140 if( !is_array($this->mExtra
) ) {
141 $this->mExtra
= array();
143 $this->mExtra
['lang'] = $wgLocalInterwiki;
145 if( !$wgPutIPinRC ) {
146 $this->mAttribs
['rc_ip'] = '';
149 # If our database is strict about IP addresses, use NULL instead of an empty string
150 if( $dbw->strictIPs() and $this->mAttribs
['rc_ip'] == '' ) {
151 unset( $this->mAttribs
['rc_ip'] );
154 # Fixup database timestamps
155 $this->mAttribs
['rc_timestamp'] = $dbw->timestamp($this->mAttribs
['rc_timestamp']);
156 $this->mAttribs
['rc_cur_time'] = $dbw->timestamp($this->mAttribs
['rc_cur_time']);
157 $this->mAttribs
['rc_id'] = $dbw->nextSequenceValue( 'rc_rc_id_seq' );
159 ## If we are using foreign keys, an entry of 0 for the page_id will fail, so use NULL
160 if( $dbw->cascadingDeletes() and $this->mAttribs
['rc_cur_id']==0 ) {
161 unset ( $this->mAttribs
['rc_cur_id'] );
165 $dbw->insert( 'recentchanges', $this->mAttribs
, $fname );
168 $this->mAttribs
['rc_id'] = $dbw->insertId();
171 wfRunHooks( 'RecentChange_save', array( &$this ) );
173 # Notify external application via UDP
174 if( $wgRC2UDPAddress && ( !$this->mAttribs
['rc_bot'] ||
!$wgRC2UDPOmitBots ) ) {
175 self
::sendToUDP( $this->getIRCLine() );
178 # E-mail notifications
179 global $wgUseEnotif, $wgShowUpdatedMarker, $wgUser;
180 if( $wgUseEnotif ||
$wgShowUpdatedMarker ) {
182 if( $this->mAttribs
['rc_user'] ) {
183 $editor = ($wgUser->getId() == $this->mAttribs
['rc_user']) ?
184 $wgUser : User
::newFromID( $this->mAttribs
['rc_user'] );
187 $editor = ($wgUser->getName() == $this->mAttribs
['rc_user_text']) ?
188 $wgUser : User
::newFromName( $this->mAttribs
['rc_user_text'], false );
190 # FIXME: this would be better as an extension hook
191 $enotif = new EmailNotification();
192 $title = Title
::makeTitle( $this->mAttribs
['rc_namespace'], $this->mAttribs
['rc_title'] );
193 $enotif->notifyOnPageChange( $editor, $title,
194 $this->mAttribs
['rc_timestamp'],
195 $this->mAttribs
['rc_comment'],
196 $this->mAttribs
['rc_minor'],
197 $this->mAttribs
['rc_last_oldid'] );
201 public function notifyRC2UDP() {
202 global $wgRC2UDPAddress, $wgRC2UDPOmitBots;
203 # Notify external application via UDP
204 if( $wgRC2UDPAddress && ( !$this->mAttribs
['rc_bot'] ||
!$wgRC2UDPOmitBots ) ) {
205 self
::sendToUDP( $this->getIRCLine() );
210 * Send some text to UDP
211 * @param string $line
212 * @param string $prefix
213 * @param string $address
214 * @return bool success
216 public static function sendToUDP( $line, $address = '', $prefix = '' ) {
217 global $wgRC2UDPAddress, $wgRC2UDPPrefix, $wgRC2UDPPort;
218 # Assume default for standard RC case
219 $address = $address ?
$address : $wgRC2UDPAddress;
220 $prefix = $prefix ?
$prefix : $wgRC2UDPPrefix;
221 # Notify external application via UDP
223 $conn = socket_create( AF_INET
, SOCK_DGRAM
, SOL_UDP
);
225 $line = $prefix . $line;
226 wfDebug( __METHOD__
. ": sending UDP line: $line\n" );
227 socket_sendto( $conn, $line, strlen($line), 0, $address, $wgRC2UDPPort );
228 socket_close( $conn );
231 wfDebug( __METHOD__
. ": failed to create UDP socket\n" );
238 * Remove newlines, carriage returns and decode html entites
239 * @param string $line
242 public static function cleanupForIRC( $text ) {
243 return Sanitizer
::decodeCharReferences( str_replace( array( "\n", "\r" ), array( "", "" ), $text ) );
247 * Mark a given change as patrolled
249 * @param mixed $change RecentChange or corresponding rc_id
250 * @param bool $auto for automatic patrol
251 * @return See doMarkPatrolled(), or null if $change is not an existing rc_id
253 public static function markPatrolled( $change, $auto = false ) {
254 $change = $change instanceof RecentChange
256 : RecentChange
::newFromId($change);
257 if( !$change instanceof RecentChange
) {
260 return $change->doMarkPatrolled( $auto );
264 * Mark this RecentChange as patrolled
266 * NOTE: Can also return 'rcpatroldisabled', 'hookaborted' and 'markedaspatrollederror-noautopatrol' as errors
267 * @param bool $auto for automatic patrol
268 * @return array of permissions errors, see Title::getUserPermissionsErrors()
270 public function doMarkPatrolled( $auto = false ) {
271 global $wgUser, $wgUseRCPatrol, $wgUseNPPatrol;
273 // If recentchanges patrol is disabled, only new pages
275 if( !$wgUseRCPatrol && ( !$wgUseNPPatrol ||
$this->getAttribute('rc_type') != RC_NEW
) ) {
276 $errors[] = array('rcpatroldisabled');
278 // Automatic patrol needs "autopatrol", ordinary patrol needs "patrol"
279 $right = $auto ?
'autopatrol' : 'patrol';
280 $errors = array_merge( $errors, $this->getTitle()->getUserPermissionsErrors( $right, $wgUser ) );
281 if( !wfRunHooks('MarkPatrolled', array($this->getAttribute('rc_id'), &$wgUser, false)) ) {
282 $errors[] = array('hookaborted');
284 // Users without the 'autopatrol' right can't patrol their
286 if( $wgUser->getName() == $this->getAttribute('rc_user_text') && !$wgUser->isAllowed('autopatrol') ) {
287 $errors[] = array('markedaspatrollederror-noautopatrol');
292 // If the change was patrolled already, do nothing
293 if( $this->getAttribute('rc_patrolled') ) {
296 // Actually set the 'patrolled' flag in RC
297 $this->reallyMarkPatrolled();
298 // Log this patrol event
299 PatrolLog
::record( $this, $auto );
300 wfRunHooks( 'MarkPatrolledComplete', array($this->getAttribute('rc_id'), &$wgUser, false) );
305 * Mark this RecentChange patrolled, without error checking
306 * @return int Number of affected rows
308 public function reallyMarkPatrolled() {
309 $dbw = wfGetDB( DB_MASTER
);
316 'rc_id' => $this->getAttribute('rc_id')
320 return $dbw->affectedRows();
323 # Makes an entry in the database corresponding to an edit
324 public static function notifyEdit( $timestamp, &$title, $minor, &$user, $comment, $oldId,
325 $lastTimestamp, $bot, $ip='', $oldSize=0, $newSize=0, $newId=0, $patrol=0 )
332 $rc = new RecentChange
;
333 $rc->mAttribs
= array(
334 'rc_timestamp' => $timestamp,
335 'rc_cur_time' => $timestamp,
336 'rc_namespace' => $title->getNamespace(),
337 'rc_title' => $title->getDBkey(),
338 'rc_type' => RC_EDIT
,
339 'rc_minor' => $minor ?
1 : 0,
340 'rc_cur_id' => $title->getArticleID(),
341 'rc_user' => $user->getId(),
342 'rc_user_text' => $user->getName(),
343 'rc_comment' => $comment,
344 'rc_this_oldid' => $newId,
345 'rc_last_oldid' => $oldId,
346 'rc_bot' => $bot ?
1 : 0,
347 'rc_moved_to_ns' => 0,
348 'rc_moved_to_title' => '',
350 'rc_patrolled' => intval($patrol),
351 'rc_new' => 0, # obsolete
352 'rc_old_len' => $oldSize,
353 'rc_new_len' => $newSize,
356 'rc_log_type' => null,
357 'rc_log_action' => '',
362 'prefixedDBkey' => $title->getPrefixedDBkey(),
363 'lastTimestamp' => $lastTimestamp,
364 'oldSize' => $oldSize,
365 'newSize' => $newSize,
372 * Makes an entry in the database corresponding to page creation
373 * Note: the title object must be loaded with the new id using resetArticleID()
374 * @todo Document parameters and return
376 public static function notifyNew( $timestamp, &$title, $minor, &$user, $comment, $bot,
377 $ip='', $size=0, $newId=0, $patrol=0 )
384 $rc = new RecentChange
;
385 $rc->mAttribs
= array(
386 'rc_timestamp' => $timestamp,
387 'rc_cur_time' => $timestamp,
388 'rc_namespace' => $title->getNamespace(),
389 'rc_title' => $title->getDBkey(),
391 'rc_minor' => $minor ?
1 : 0,
392 'rc_cur_id' => $title->getArticleID(),
393 'rc_user' => $user->getId(),
394 'rc_user_text' => $user->getName(),
395 'rc_comment' => $comment,
396 'rc_this_oldid' => $newId,
397 'rc_last_oldid' => 0,
398 'rc_bot' => $bot ?
1 : 0,
399 'rc_moved_to_ns' => 0,
400 'rc_moved_to_title' => '',
402 'rc_patrolled' => intval($patrol),
403 'rc_new' => 1, # obsolete
405 'rc_new_len' => $size,
408 'rc_log_type' => null,
409 'rc_log_action' => '',
414 'prefixedDBkey' => $title->getPrefixedDBkey(),
415 'lastTimestamp' => 0,
423 # Makes an entry in the database corresponding to a rename
424 public static function notifyMove( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='', $overRedir = false )
432 $rc = new RecentChange
;
433 $rc->mAttribs
= array(
434 'rc_timestamp' => $timestamp,
435 'rc_cur_time' => $timestamp,
436 'rc_namespace' => $oldTitle->getNamespace(),
437 'rc_title' => $oldTitle->getDBkey(),
438 'rc_type' => $overRedir ? RC_MOVE_OVER_REDIRECT
: RC_MOVE
,
440 'rc_cur_id' => $oldTitle->getArticleID(),
441 'rc_user' => $user->getId(),
442 'rc_user_text' => $user->getName(),
443 'rc_comment' => $comment,
444 'rc_this_oldid' => 0,
445 'rc_last_oldid' => 0,
446 'rc_bot' => $user->isAllowed( 'bot' ) ?
$wgRequest->getBool( 'bot' , true ) : 0,
447 'rc_moved_to_ns' => $newTitle->getNamespace(),
448 'rc_moved_to_title' => $newTitle->getDBkey(),
450 'rc_new' => 0, # obsolete
452 'rc_old_len' => NULL,
453 'rc_new_len' => NULL,
455 'rc_logid' => 0, # notifyMove not used anymore
456 'rc_log_type' => null,
457 'rc_log_action' => '',
462 'prefixedDBkey' => $oldTitle->getPrefixedDBkey(),
463 'lastTimestamp' => 0,
464 'prefixedMoveTo' => $newTitle->getPrefixedDBkey()
469 public static function notifyMoveToNew( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='' ) {
470 RecentChange
::notifyMove( $timestamp, $oldTitle, $newTitle, $user, $comment, $ip, false );
473 public static function notifyMoveOverRedirect( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='' ) {
474 RecentChange
::notifyMove( $timestamp, $oldTitle, $newTitle, $user, $comment, $ip, true );
477 public static function notifyLog( $timestamp, &$title, &$user, $actionComment, $ip='', $type,
478 $action, $target, $logComment, $params, $newId=0 )
480 global $wgLogRestrictions;
481 # Don't add private logs to RC!
482 if( isset($wgLogRestrictions[$type]) && $wgLogRestrictions[$type] != '*' ) {
485 $rc = self
::newLogEntry( $timestamp, $title, $user, $actionComment, $ip, $type, $action,
486 $target, $logComment, $params, $newId );
491 public static function newLogEntry( $timestamp, &$title, &$user, $actionComment, $ip='',
492 $type, $action, $target, $logComment, $params, $newId=0 )
500 $rc = new RecentChange
;
501 $rc->mAttribs
= array(
502 'rc_timestamp' => $timestamp,
503 'rc_cur_time' => $timestamp,
504 'rc_namespace' => $target->getNamespace(),
505 'rc_title' => $target->getDBkey(),
508 'rc_cur_id' => $target->getArticleID(),
509 'rc_user' => $user->getId(),
510 'rc_user_text' => $user->getName(),
511 'rc_comment' => $logComment,
512 'rc_this_oldid' => 0,
513 'rc_last_oldid' => 0,
514 'rc_bot' => $user->isAllowed( 'bot' ) ?
$wgRequest->getBool( 'bot', true ) : 0,
515 'rc_moved_to_ns' => 0,
516 'rc_moved_to_title' => '',
519 'rc_new' => 0, # obsolete
520 'rc_old_len' => NULL,
521 'rc_new_len' => NULL,
523 'rc_logid' => $newId,
524 'rc_log_type' => $type,
525 'rc_log_action' => $action,
526 'rc_params' => $params
529 'prefixedDBkey' => $title->getPrefixedDBkey(),
530 'lastTimestamp' => 0,
531 'actionComment' => $actionComment, // the comment appended to the action, passed from LogPage
536 # Initialises the members of this object from a mysql row object
537 public function loadFromRow( $row ) {
538 $this->mAttribs
= get_object_vars( $row );
539 $this->mAttribs
['rc_timestamp'] = wfTimestamp(TS_MW
, $this->mAttribs
['rc_timestamp']);
540 $this->mAttribs
['rc_deleted'] = $row->rc_deleted
; // MUST be set
543 # Makes a pseudo-RC entry from a cur row
544 public function loadFromCurRow( $row ) {
545 $this->mAttribs
= array(
546 'rc_timestamp' => wfTimestamp(TS_MW
, $row->rev_timestamp
),
547 'rc_cur_time' => $row->rev_timestamp
,
548 'rc_user' => $row->rev_user
,
549 'rc_user_text' => $row->rev_user_text
,
550 'rc_namespace' => $row->page_namespace
,
551 'rc_title' => $row->page_title
,
552 'rc_comment' => $row->rev_comment
,
553 'rc_minor' => $row->rev_minor_edit ?
1 : 0,
554 'rc_type' => $row->page_is_new ? RC_NEW
: RC_EDIT
,
555 'rc_cur_id' => $row->page_id
,
556 'rc_this_oldid' => $row->rev_id
,
557 'rc_last_oldid' => isset($row->rc_last_oldid
) ?
$row->rc_last_oldid
: 0,
559 'rc_moved_to_ns' => 0,
560 'rc_moved_to_title' => '',
562 'rc_id' => $row->rc_id
,
563 'rc_patrolled' => $row->rc_patrolled
,
564 'rc_new' => $row->page_is_new
, # obsolete
565 'rc_old_len' => $row->rc_old_len
,
566 'rc_new_len' => $row->rc_new_len
,
567 'rc_params' => isset($row->rc_params
) ?
$row->rc_params
: '',
568 'rc_log_type' => isset($row->rc_log_type
) ?
$row->rc_log_type
: null,
569 'rc_log_action' => isset($row->rc_log_action
) ?
$row->rc_log_action
: null,
570 'rc_log_id' => isset($row->rc_log_id
) ?
$row->rc_log_id
: 0,
571 'rc_deleted' => $row->rc_deleted
// MUST be set
576 * Get an attribute value
578 * @param $name Attribute name
581 public function getAttribute( $name ) {
582 return isset( $this->mAttribs
[$name] ) ?
$this->mAttribs
[$name] : NULL;
586 * Gets the end part of the diff URL associated with this object
587 * Blank if no diff link should be displayed
589 public function diffLinkTrail( $forceCur ) {
590 if( $this->mAttribs
['rc_type'] == RC_EDIT
) {
591 $trail = "curid=" . (int)($this->mAttribs
['rc_cur_id']) .
592 "&oldid=" . (int)($this->mAttribs
['rc_last_oldid']);
594 $trail .= '&diff=0' ;
596 $trail .= '&diff=' . (int)($this->mAttribs
['rc_this_oldid']);
604 public function getIRCLine() {
605 global $wgUseRCPatrol, $wgUseNPPatrol, $wgRC2UDPInterwikiPrefix, $wgLocalInterwiki;
607 // FIXME: Would be good to replace these 2 extract() calls with something more explicit
608 // e.g. list ($rc_type, $rc_id) = array_values ($this->mAttribs); [or something like that]
609 extract($this->mAttribs
);
610 extract($this->mExtra
);
612 if( $rc_type == RC_LOG
) {
613 $titleObj = Title
::newFromText( "Log/$rc_log_type", NS_SPECIAL
);
615 $titleObj =& $this->getTitle();
617 $title = $titleObj->getPrefixedText();
618 $title = self
::cleanupForIRC( $title );
620 if( $rc_type == RC_LOG
) {
623 if( $rc_type == RC_NEW
) {
624 $url = "oldid=$rc_this_oldid";
626 $url = "diff=$rc_this_oldid&oldid=$rc_last_oldid";
628 if( $wgUseRCPatrol ||
($rc_type == RC_NEW
&& $wgUseNPPatrol) ) {
629 $url .= "&rcid=$rc_id";
631 // XXX: *HACK* this should use getFullURL(), hacked for SSL madness --brion 2005-12-26
632 // XXX: *HACK^2* the preg_replace() undoes much of what getInternalURL() does, but we
633 // XXX: need to call it so that URL paths on the Wikimedia secure server can be fixed
634 // XXX: by a custom GetInternalURL hook --vyznev 2008-12-10
635 $url = preg_replace( '/title=[^&]*&/', '', $titleObj->getInternalURL( $url ) );
638 if( isset( $oldSize ) && isset( $newSize ) ) {
639 $szdiff = $newSize - $oldSize;
641 $szdiff = "\002$szdiff\002";
642 } elseif($szdiff >= 0) {
643 $szdiff = '+' . $szdiff ;
645 $szdiff = '(' . $szdiff . ')' ;
650 $user = self
::cleanupForIRC( $rc_user_text );
652 if( $rc_type == RC_LOG
) {
653 $targetText = $this->getTitle()->getPrefixedText();
654 $comment = self
::cleanupForIRC( str_replace("[[$targetText]]","[[\00302$targetText\00310]]",$actionComment) );
655 $flag = $rc_log_action;
657 $comment = self
::cleanupForIRC( $rc_comment );
659 if( !$rc_patrolled && ($wgUseRCPatrol ||
$rc_new && $wgUseNPPatrol) ) {
662 $flag .= ($rc_new ?
"N" : "") . ($rc_minor ?
"M" : "") . ($rc_bot ?
"B" : "");
665 if ( $wgRC2UDPInterwikiPrefix === true ) {
666 $prefix = $wgLocalInterwiki;
667 } elseif ( $wgRC2UDPInterwikiPrefix ) {
668 $prefix = $wgRC2UDPInterwikiPrefix;
672 if ( $prefix !== false ) {
673 $titleString = "\00314[[\00303$prefix:\00307$title\00314]]";
675 $titleString = "\00314[[\00307$title\00314]]";
678 # see http://www.irssi.org/documentation/formats for some colour codes. prefix is \003,
679 # no colour (\003) switches back to the term default
680 $fullString = "$titleString\0034 $flag\00310 " .
681 "\00302$url\003 \0035*\003 \00303$user\003 \0035*\003 $szdiff \00310$comment\003\n";
687 * Returns the change size (HTML).
688 * The lengths can be given optionally.
690 public function getCharacterDifference( $old = 0, $new = 0 ) {
692 $old = $this->mAttribs
['rc_old_len'];
695 $new = $this->mAttribs
['rc_new_len'];
697 if( $old === NULL ||
$new === NULL ) {
700 return ChangesList
::showCharacterDifference( $old, $new );