8 * Utility class for creating new RC entries
10 * rc_id id of the row in the recentchanges table
11 * rc_timestamp time the entry was made
12 * rc_cur_time timestamp on the cur row
13 * rc_namespace namespace #
14 * rc_title non-prefixed db key
15 * rc_type is new entry, used to determine whether updating is necessary
17 * rc_cur_id page_id of associated page entry
18 * rc_user user id who made the entry
19 * rc_user_text user name who made the entry
20 * rc_comment edit summary
21 * rc_this_oldid rev_id associated with this entry (or zero)
22 * rc_last_oldid rev_id associated with the entry before this one (or zero)
23 * rc_bot is bot, hidden
24 * rc_ip IP address of the user in dotted quad notation
25 * rc_new obsolete, use rc_type==RC_NEW
26 * rc_patrolled boolean whether or not someone has marked this edit as patrolled
29 * prefixedDBkey prefixed db key, used by external app via msg queue
30 * lastTimestamp timestamp of previous entry, used in WHERE clause during update
31 * lang the interwiki prefix, automatically set in save()
32 * oldSize text size before the change
33 * newSize text size after the change
35 * temporary: not stored in the database
36 * notificationtimestamp
37 * numberofWatchingusers
39 * @todo document functions and variables
44 var $mAttribs = array(), $mExtra = array();
45 var $mTitle = false, $mMovedToTitle = false;
46 var $numberofWatchingusers = 0 ; # Dummy to prevent error message in SpecialRecentchangeslinked
50 /* static */ function newFromRow( $row )
52 $rc = new RecentChange
;
53 $rc->loadFromRow( $row );
57 /* static */ function newFromCurRow( $row, $rc_this_oldid = 0 )
59 $rc = new RecentChange
;
60 $rc->loadFromCurRow( $row, $rc_this_oldid );
61 $rc->notificationtimestamp
= false;
62 $rc->numberofWatchingusers
= false;
68 function setAttribs( $attribs )
70 $this->mAttribs
= $attribs;
73 function setExtra( $extra )
75 $this->mExtra
= $extra;
80 if ( $this->mTitle
=== false ) {
81 $this->mTitle
= Title
::makeTitle( $this->mAttribs
['rc_namespace'], $this->mAttribs
['rc_title'] );
86 function getMovedToTitle()
88 if ( $this->mMovedToTitle
=== false ) {
89 $this->mMovedToTitle
= Title
::makeTitle( $this->mAttribs
['rc_moved_to_ns'],
90 $this->mAttribs
['rc_moved_to_title'] );
92 return $this->mMovedToTitle
;
95 # Writes the data in this object to the database
98 global $wgLocalInterwiki, $wgPutIPinRC, $wgRC2UDPAddress, $wgRC2UDPPort, $wgRC2UDPPrefix, $wgUseRCPatrol;
99 $fname = 'RecentChange::save';
101 $dbw =& wfGetDB( DB_MASTER
);
102 if ( !is_array($this->mExtra
) ) {
103 $this->mExtra
= array();
105 $this->mExtra
['lang'] = $wgLocalInterwiki;
107 if ( !$wgPutIPinRC ) {
108 $this->mAttribs
['rc_ip'] = '';
111 # Fixup database timestamps
112 $this->mAttribs
['rc_timestamp'] = $dbw->timestamp($this->mAttribs
['rc_timestamp']);
113 $this->mAttribs
['rc_cur_time'] = $dbw->timestamp($this->mAttribs
['rc_cur_time']);
114 $this->mAttribs
['rc_id'] = $dbw->nextSequenceValue( 'rc_rc_id_seq' );
117 $dbw->insert( 'recentchanges', $this->mAttribs
, $fname );
120 $this->mAttribs
['rc_id'] = $dbw->insertId();
122 # Update old rows, if necessary
123 if ( $this->mAttribs
['rc_type'] == RC_EDIT
) {
124 $lastTime = $this->mExtra
['lastTimestamp'];
125 #$now = $this->mAttribs['rc_timestamp'];
126 #$curId = $this->mAttribs['rc_cur_id'];
128 # Don't bother looking for entries that have probably
129 # been purged, it just locks up the indexes needlessly.
131 $age = time() - wfTimestamp( TS_UNIX
, $lastTime );
132 if( $age < $wgRCMaxAge ) {
133 # live hack, will commit once tested - kate
134 # Update rc_this_oldid for the entries which were current
136 #$oldid = $this->mAttribs['rc_last_oldid'];
137 #$ns = $this->mAttribs['rc_namespace'];
138 #$title = $this->mAttribs['rc_title'];
140 #$dbw->update( 'recentchanges',
142 # 'rc_this_oldid' => $oldid
143 # ), array( /* WHERE */
144 # 'rc_namespace' => $ns,
145 # 'rc_title' => $title,
146 # 'rc_timestamp' => $dbw->timestamp( $lastTime )
152 #$dbw->update( 'recentchanges', array( 'rc_cur_time' => $now ),
153 # array( 'rc_cur_id' => $curId ), $fname );
156 # Notify external application via UDP
157 if ( $wgRC2UDPAddress ) {
158 $conn = socket_create( AF_INET
, SOCK_DGRAM
, SOL_UDP
);
160 $line = $wgRC2UDPPrefix . $this->getIRCLine();
161 socket_sendto( $conn, $line, strlen($line), 0, $wgRC2UDPAddress, $wgRC2UDPPort );
162 socket_close( $conn );
166 // E-mail notifications
169 # this would be better as an extension hook
170 include_once( "UserMailer.php" );
171 $enotif = new EmailNotification();
172 $title = Title
::makeTitle( $this->mAttribs
['rc_namespace'], $this->mAttribs
['rc_title'] );
173 $enotif->notifyOnPageChange( $title,
174 $this->mAttribs
['rc_timestamp'],
175 $this->mAttribs
['rc_comment'],
176 $this->mAttribs
['rc_minor'],
177 $this->mAttribs
['rc_last_oldid'] );
182 # Marks a certain row as patrolled
183 function markPatrolled( $rcid )
185 $fname = 'RecentChange::markPatrolled';
187 $dbw =& wfGetDB( DB_MASTER
);
189 $dbw->update( 'recentchanges',
192 ), array( /* WHERE */
198 # Makes an entry in the database corresponding to an edit
199 /*static*/ function notifyEdit( $timestamp, &$title, $minor, &$user, $comment,
200 $oldId, $lastTimestamp, $bot = "default", $ip = '', $oldSize = 0, $newSize = 0,
203 if ( $bot == 'default ' ) {
204 $bot = $user->isBot();
208 $ip = ProxyTools
::getIP();
214 $rc = new RecentChange
;
215 $rc->mAttribs
= array(
216 'rc_timestamp' => $timestamp,
217 'rc_cur_time' => $timestamp,
218 'rc_namespace' => $title->getNamespace(),
219 'rc_title' => $title->getDBkey(),
220 'rc_type' => RC_EDIT
,
221 'rc_minor' => $minor ?
1 : 0,
222 'rc_cur_id' => $title->getArticleID(),
223 'rc_user' => $user->getID(),
224 'rc_user_text' => $user->getName(),
225 'rc_comment' => $comment,
226 'rc_this_oldid' => $newId,
227 'rc_last_oldid' => $oldId,
228 'rc_bot' => $bot ?
1 : 0,
229 'rc_moved_to_ns' => 0,
230 'rc_moved_to_title' => '',
233 'rc_new' => 0 # obsolete
237 'prefixedDBkey' => $title->getPrefixedDBkey(),
238 'lastTimestamp' => $lastTimestamp,
239 'oldSize' => $oldSize,
240 'newSize' => $newSize,
243 return( $rc->mAttribs
['rc_id'] );
246 # Makes an entry in the database corresponding to page creation
247 # Note: the title object must be loaded with the new id using resetArticleID()
248 /*static*/ function notifyNew( $timestamp, &$title, $minor, &$user, $comment, $bot = "default",
249 $ip='', $size = 0, $newId = 0 )
252 $ip = ProxyTools
::getIP();
257 if ( $bot == 'default' ) {
258 $bot = $user->isBot();
261 $rc = new RecentChange
;
262 $rc->mAttribs
= array(
263 'rc_timestamp' => $timestamp,
264 'rc_cur_time' => $timestamp,
265 'rc_namespace' => $title->getNamespace(),
266 'rc_title' => $title->getDBkey(),
268 'rc_minor' => $minor ?
1 : 0,
269 'rc_cur_id' => $title->getArticleID(),
270 'rc_user' => $user->getID(),
271 'rc_user_text' => $user->getName(),
272 'rc_comment' => $comment,
273 'rc_this_oldid' => $newId,
274 'rc_last_oldid' => 0,
275 'rc_bot' => $bot ?
1 : 0,
276 'rc_moved_to_ns' => 0,
277 'rc_moved_to_title' => '',
280 'rc_new' => 1 # obsolete
284 'prefixedDBkey' => $title->getPrefixedDBkey(),
285 'lastTimestamp' => 0,
290 return( $rc->mAttribs
['rc_id'] );
293 # Makes an entry in the database corresponding to a rename
294 /*static*/ function notifyMove( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='', $overRedir = false )
297 $ip = ProxyTools
::getIP();
303 $rc = new RecentChange
;
304 $rc->mAttribs
= array(
305 'rc_timestamp' => $timestamp,
306 'rc_cur_time' => $timestamp,
307 'rc_namespace' => $oldTitle->getNamespace(),
308 'rc_title' => $oldTitle->getDBkey(),
309 'rc_type' => $overRedir ? RC_MOVE_OVER_REDIRECT
: RC_MOVE
,
311 'rc_cur_id' => $oldTitle->getArticleID(),
312 'rc_user' => $user->getID(),
313 'rc_user_text' => $user->getName(),
314 'rc_comment' => $comment,
315 'rc_this_oldid' => 0,
316 'rc_last_oldid' => 0,
317 'rc_bot' => $user->isBot() ?
1 : 0,
318 'rc_moved_to_ns' => $newTitle->getNamespace(),
319 'rc_moved_to_title' => $newTitle->getDBkey(),
321 'rc_new' => 0, # obsolete
326 'prefixedDBkey' => $oldTitle->getPrefixedDBkey(),
327 'lastTimestamp' => 0,
328 'prefixedMoveTo' => $newTitle->getPrefixedDBkey()
333 /* static */ function notifyMoveToNew( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='' ) {
334 RecentChange
::notifyMove( $timestamp, $oldTitle, $newTitle, $user, $comment, $ip, false );
337 /* static */ function notifyMoveOverRedirect( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='' ) {
338 RecentChange
::notifyMove( $timestamp, $oldTitle, $newTitle, $user, $comment, $ip, true );
341 # A log entry is different to an edit in that previous revisions are
343 /*static*/ function notifyLog( $timestamp, &$title, &$user, $comment, $ip='',
344 $type, $action, $target, $logComment, $params )
347 $ip = ProxyTools
::getIP();
353 $rc = new RecentChange
;
354 $rc->mAttribs
= array(
355 'rc_timestamp' => $timestamp,
356 'rc_cur_time' => $timestamp,
357 'rc_namespace' => $title->getNamespace(),
358 'rc_title' => $title->getDBkey(),
361 'rc_cur_id' => $title->getArticleID(),
362 'rc_user' => $user->getID(),
363 'rc_user_text' => $user->getName(),
364 'rc_comment' => $comment,
365 'rc_this_oldid' => 0,
366 'rc_last_oldid' => 0,
367 'rc_bot' => $user->isBot() ?
1 : 0,
368 'rc_moved_to_ns' => 0,
369 'rc_moved_to_title' => '',
372 'rc_new' => 0 # obsolete
375 'prefixedDBkey' => $title->getPrefixedDBkey(),
376 'lastTimestamp' => 0,
378 'logAction' => $action,
379 'logComment' => $logComment,
380 'logTarget' => $target,
381 'logParams' => $params
386 # Initialises the members of this object from a mysql row object
387 function loadFromRow( $row )
389 $this->mAttribs
= get_object_vars( $row );
390 $this->mAttribs
["rc_timestamp"] = wfTimestamp(TS_MW
, $this->mAttribs
["rc_timestamp"]);
391 $this->mExtra
= array();
394 # Makes a pseudo-RC entry from a cur row, for watchlists and things
395 function loadFromCurRow( $row )
397 $this->mAttribs
= array(
398 'rc_timestamp' => wfTimestamp(TS_MW
, $row->rev_timestamp
),
399 'rc_cur_time' => $row->rev_timestamp
,
400 'rc_user' => $row->rev_user
,
401 'rc_user_text' => $row->rev_user_text
,
402 'rc_namespace' => $row->page_namespace
,
403 'rc_title' => $row->page_title
,
404 'rc_comment' => $row->rev_comment
,
405 'rc_minor' => $row->rev_minor_edit ?
1 : 0,
406 'rc_type' => $row->page_is_new ? RC_NEW
: RC_EDIT
,
407 'rc_cur_id' => $row->page_id
,
408 'rc_this_oldid' => $row->rev_id
,
409 'rc_last_oldid' => isset($row->rc_last_oldid
) ?
$row->rc_last_oldid
: 0,
411 'rc_moved_to_ns' => 0,
412 'rc_moved_to_title' => '',
414 'rc_id' => $row->rc_id
,
415 'rc_patrolled' => $row->rc_patrolled
,
416 'rc_new' => $row->page_is_new
# obsolete
419 $this->mExtra
= array();
424 * Gets the end part of the diff URL associated with this object
425 * Blank if no diff link should be displayed
427 function diffLinkTrail( $forceCur )
429 if ( $this->mAttribs
['rc_type'] == RC_EDIT
) {
430 $trail = "curid=" . (int)($this->mAttribs
['rc_cur_id']) .
431 "&oldid=" . (int)($this->mAttribs
['rc_last_oldid']);
433 $trail .= '&diff=0' ;
435 $trail .= '&diff=' . (int)($this->mAttribs
['rc_this_oldid']);
443 function cleanupForIRC( $text ) {
444 return str_replace(array("\n", "\r"), array("", ""), $text);
447 function getIRCLine() {
448 global $wgUseRCPatrol;
450 extract($this->mAttribs
);
451 extract($this->mExtra
);
453 $titleObj =& $this->getTitle();
454 if ( $rc_type == RC_LOG
) {
455 $title = Namespace::getCanonicalName( $titleObj->getNamespace() ) . $titleObj->getText();
457 $title = $titleObj->getPrefixedText();
459 $title = $this->cleanupForIRC( $title );
461 $bad = array("\n", "\r");
462 $empty = array("", "");
463 $title = $titleObj->getPrefixedText();
464 $title = str_replace($bad, $empty, $title);
466 // FIXME: *HACK* these should be getFullURL(), hacked for SSL madness --brion 2005-12-26
467 if ( $rc_type == RC_LOG
) {
469 } elseif ( $rc_new && $wgUseRCPatrol ) {
470 $url = $titleObj->getInternalURL("rcid=$rc_id");
471 } else if ( $rc_new ) {
472 $url = $titleObj->getInternalURL();
473 } else if ( $wgUseRCPatrol ) {
474 $url = $titleObj->getInternalURL("diff=$rc_this_oldid&oldid=$rc_last_oldid&rcid=$rc_id");
476 $url = $titleObj->getInternalURL("diff=$rc_this_oldid&oldid=$rc_last_oldid");
479 if ( isset( $oldSize ) && isset( $newSize ) ) {
480 $szdiff = $newSize - $oldSize;
481 if ($szdiff < -500) {
482 $szdiff = "\002$szdiff\002";
483 } elseif ($szdiff >= 0) {
484 $szdiff = '+' . $szdiff ;
486 $szdiff = '(' . $szdiff . ')' ;
491 $user = $this->cleanupForIRC( $rc_user_text );
493 if ( $rc_type == RC_LOG
) {
494 $logTargetText = $logTarget->getPrefixedText();
495 $comment = $this->cleanupForIRC( str_replace( $logTargetText, "\00302$logTargetText\00310", $rc_comment ) );
498 $comment = $this->cleanupForIRC( $rc_comment );
499 $flag = ($rc_minor ?
"M" : "") . ($rc_new ?
"N" : "");
501 # see http://www.irssi.org/documentation/formats for some colour codes. prefix is \003,
502 # no colour (\003) switches back to the term default
503 $fullString = "\00314[[\00307$title\00314]]\0034 $flag\00310 " .
504 "\00302$url\003 \0035*\003 \00303$user\003 \0035*\003 $szdiff \00310$comment\003\n";