ted with the entry before this one (or zero)
* rc_bot is bot, hidden
* rc_ip IP address of the user in dotted quad notation
* rc_new obsolete, use rc_type==RC_NEW
* rc_patrolled boolean whether or not someone has marked this edit as patrolled
*
* mExtra:
* prefixedDBkey prefixed db key, used by external app via msg queue
* lastTimestamp timestamp of previous entry, used in WHERE clause during update
* lang the interwiki prefix, automatically set in save()
* oldSize text size before the change
* newSize text size after the change
*
* temporary: not stored in the database
* notificationtimestamp
* numberofWatchingusers
*
* @todo document functions and variables
* @package MediaWiki
*/
class RecentChange
{
var $mAttribs = array(), $mExtra = array();
var $mTitle = false, $mMovedToTitle = false;
# Factory methods
/* static */ function newFromRow( $row )
{
$rc = new RecentChange;
$rc->loadFromRow( $row );
return $rc;
}
/* static */ function newFromCurRow( $row, $rc_this_oldid = 0 )
{
$rc = new RecentChange;
$rc->loadFromCurRow( $row, $rc_this_oldid );
$rc->notificationtimestamp = false;
$rc->numberofWatchingusers = false;
return $rc;
}
# Accessors
function setAttribs( $attribs )
{
$this->mAttribs = $attribs;
}
function setExtra( $extra )
{
$this->mExtra = $extra;
}
function &getTitle()
{
if ( $this->mTitle === false ) {
$this->mTitle = Title::makeTitle( $this->mAttribs['rc_namespace'], $this->mAttribs['rc_title'] );
}
return $this->mTitle;
}
function getMovedToTitle()
{
if ( $this->mMovedToTitle === false ) {
$this->mMovedToTitle = Title::makeTitle( $this->mAttribs['rc_moved_to_ns'],
$this->mAttribs['rc_moved_to_title'] );
}
return $this->mMovedToTitle;
}
# Writes the data in this object to the database
function save()
{
global $wgLocalInterwiki, $wgPutIPinRC, $wgRC2UDPAddress, $wgRC2UDPPort, $wgRC2UDPPrefix;
$fname = 'RecentChange::save';
$dbw =& wfGetDB( DB_MASTER );
if ( !is_array($this->mExtra) ) {
$this->mExtra = array();
}
$this->mExtra['lang'] = $wgLocalInterwiki;
if ( !$wgPutIPinRC ) {
$this->mAttribs['rc_ip'] = '';
}
# Fixup database timestamps
$this->mAttribs['rc_timestamp']=$dbw->timestamp($this->mAttribs['rc_timestamp']);
$this->mAttribs['rc_cur_time']=$dbw->timestamp($this->mAttribs['rc_cur_time']);
# Insert new row
$dbw->insert( 'recentchanges', $this->mAttribs, $fname );
# Update old rows, if necessary
if ( $this->mAttribs['rc_type'] == RC_EDIT ) {
$oldid = $this->mAttribs['rc_last_oldid'];
$ns = $this->mAttribs['rc_namespace'];
$title = $this->mAttribs['rc_title'];
$lastTime = $this->mExtra['lastTimestamp'];
$now = $this->mAttribs['rc_timestamp'];
$curId = $this->mAttribs['rc_cur_id'];
# Don't bother looking for entries that have probably
# been purged, it just locks up the indexes needlessly.
global $wgRCMaxAge;
$age = time() - wfTimestamp( TS_UNIX, $lastTime );
if( $age < $wgRCMaxAge ) {
# live hack, will commit once tested - kate
# Update rc_this_oldid for the entries which were current
#$dbw->update( 'recentchanges',
# array( /* SET */
# 'rc_this_oldid' => $oldid
# ), array( /* WHERE */
# 'rc_namespace' => $ns,
# 'rc_title' => $title,
# 'rc_timestamp' => $dbw->timestamp( $lastTime )
# ), $fname
#);
}
# Update rc_cur_time
$dbw->update( 'recentchanges', array( 'rc_cur_time' => $now ),
array( 'rc_cur_id' => $curId ), $fname );
}
# Notify external application via UDP
if ( $wgRC2UDPAddress ) {
$conn = socket_create( AF_INET, SOCK_DGRAM, SOL_UDP );
if ( $conn ) {
$line = $wgRC2UDPPrefix . $this->getIRCLine();
socket_sendto( $conn, $line, strlen($line), 0, $wgRC2UDPAddress, $wgRC2UDPPort );
socket_close( $conn );
}
}
}
# Marks a certain row as patrolled
function markPatrolled( $rcid )
{
$fname = 'RecentChange::markPatrolled';
$dbw =& wfGetDB( DB_MASTER );
$dbw->update( 'recentchanges',
array( /* SET */
'rc_patrolled' => 1
), array( /* WHERE */
'rc_id' => $rcid
), $fname
);
}
# Makes an entry in the database corresponding to an edit
/*static*/ function notifyEdit( $timestamp, &$title, $minor, &$user, $comment,
$oldId, $lastTimestamp, $bot = "default", $ip = '', $oldSize = 0, $newSize = 0,
$newId = 0)
{
if ( $bot == 'default ' ) {
$bot = $user->isBot();
}
if ( !$ip ) {
global $wgIP;
$ip = empty( $wgIP ) ? '' : $wgIP;
}
$rc = new RecentChange;
$rc->mAttribs = array(
'rc_timestamp' => $timestamp,
'rc_cur_time' => $timestamp,
'rc_namespace' => $title->getNamespace(),
'rc_title' => $title->getDBkey(),
'rc_type' => RC_EDIT,
'rc_minor' => $minor ? 1 : 0,
'rc_cur_id' => $title->getArticleID(),
'rc_user' => $user->getID(),
'rc_user_text' => $user->getName(),
'rc_comment' => $comment,
'rc_this_oldid' => $newId,
'rc_last_oldid' => $oldId,
'rc_bot' => $bot ? 1 : 0,
'rc_moved_to_ns' => 0,
'rc_moved_to_title' => '',
'rc_ip' => $ip,
'rc_patrolled' => 0,
'rc_new' => 0 # obsolete
);
$rc->mExtra = array(
'prefixedDBkey' => $title->getPrefixedDBkey(),
'lastTimestamp' => $lastTimestamp,
'oldSize' => $oldSize,
'newSize' => $newSize,
);
$rc->save();
}
# Makes an entry in the database corresponding to page creation
# Note: the title object must be loaded with the new id using resetArticleID()
/*static*/ function notifyNew( $timestamp, &$title, $minor, &$user, $comment, $bot = "default",
$ip='', $size = 0, $newId = 0 )
{
if ( !$ip ) {
global $wgIP;
$ip = empty( $wgIP ) ? '' : $wgIP;
}
if ( $bot == 'default' ) {
$bot = $user->isBot();
}
$rc = new RecentChange;
$rc->mAttribs = array(
'rc_timestamp' => $timestamp,
'rc_cur_time' => $timestamp,
'rc_namespace' => $title->getNamespace(),
'rc_title' => $title->getDBkey(),
'rc_type' => RC_NEW,
'rc_minor' => $minor ? 1 : 0,
'rc_cur_id' => $title->getArticleID(),
'rc_user' => $user->getID(),
'rc_user_text' => $user->getName(),
'rc_comment' => $comment,
'rc_this_oldid' => $newId,
'rc_last_oldid' => 0,
'rc_bot' => $bot ? 1 : 0,
'rc_moved_to_ns' => 0,
'rc_moved_to_title' => '',
'rc_ip' => $ip,
'rc_patrolled' => 0,
'rc_new' => 1 # obsolete
);
$rc->mExtra = array(
'prefixedDBkey' => $title->getPrefixedDBkey(),
'lastTimestamp' => 0,
'oldSize' => 0,
'newSize' => $size
);
$rc->save();
}
# Makes an entry in the database corresponding to a rename
/*static*/ function notifyMove( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='', $overRedir = false )
{
if ( !$ip ) {
global $wgIP;
$ip = empty( $wgIP ) ? '' : $wgIP;
}
$rc = new RecentChange;
$rc->mAttribs = array(
'rc_timestamp' => $timestamp,
'rc_cur_time' => $timestamp,
'rc_namespace' => $oldTitle->getNamespace(),
'rc_title' => $oldTitle->getDBkey(),
'rc_type' => $overRedir ? RC_MOVE_OVER_REDIRECT : RC_MOVE,
'rc_minor' => 0,
'rc_cur_id' => $oldTitle->getArticleID(),
'rc_user' => $user->getID(),
'rc_user_text' => $user->getName(),
'rc_comment' => $comment,
'rc_this_oldid' => 0,
'rc_last_oldid' => 0,
'rc_bot' => $user->isBot() ? 1 : 0,
'rc_moved_to_ns' => $newTitle->getNamespace(),
'rc_moved_to_title' => $newTitle->getDBkey(),
'rc_ip' => $ip,
'rc_new' => 0, # obsolete
'rc_patrolled' => 1
);
$rc->mExtra = array(
'prefixedDBkey' => $oldTitle->getPrefixedDBkey(),
'lastTimestamp' => 0,
'prefixedMoveTo' => $newTitle->getPrefixedDBkey()
);
$rc->save();
}
/* static */ function notifyMoveToNew( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='' ) {
RecentChange::notifyMove( $timestamp, $oldTitle, $newTitle, $user, $comment, $ip, false );
}
/* static */ function notifyMoveOverRedirect( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='' ) {
RecentChange::notifyMove( $timestamp, $oldTitle, $newTitle, $user, $comment, $ip='', true );
}
# A log entry is different to an edit in that previous revisions are
# not kept
/*static*/ function notifyLog( $timestamp, &$title, &$user, $comment, $ip='' )
{
if ( !$ip ) {
global $wgIP;
$ip = empty( $wgIP ) ? '' : $wgIP;
}
$rc = new RecentChange;
$rc->mAttribs = array(
'rc_timestamp' => $timestamp,
'rc_cur_time' => $timestamp,
'rc_namespace' => $title->getNamespace(),
'rc_title' => $title->getDBkey(),
'rc_type' => RC_LOG,
'rc_minor' => 0,
'rc_cur_id' => $title->getArticleID(),
'rc_user' => $user->getID(),
'rc_user_text' => $user->getName(),
'rc_comment' => $comment,
'rc_this_oldid' => 0,
'rc_last_oldid' => 0,
'rc_bot' => 0,
'rc_moved_to_ns' => 0,
'rc_moved_to_title' => '',
'rc_ip' => $ip,
'rc_patrolled' => 1,
'rc_new' => 0 # obsolete
);
$rc->mExtra = array(
'prefixedDBkey' => $title->getPrefixedDBkey(),
'lastTimestamp' => 0
);
$rc->save();
}
# Initialises the members of this object from a mysql row object
function loadFromRow( $row )
{
$this->mAttribs = get_object_vars( $row );
$this->mExtra = array();
}
# Makes a pseudo-RC entry from a cur row, for watchlists and things
function loadFromCurRow( $row )
{
$this->mAttribs = array(
'rc_timestamp' => $row->rev_timestamp,
'rc_cur_time' => $row->rev_timestamp,
'rc_user' => $row->rev_user,
'rc_user_text' => $row->rev_user_text,
'rc_namespace' => $row->page_namespace,
'rc_title' => $row->page_title,
'rc_comment' => $row->rev_comment,
'rc_minor' => $row->rev_minor_edit ? 1 : 0,
'rc_type' => $row->page_is_new ? RC_NEW : RC_EDIT,
'rc_cur_id' => $row->page_id,
'rc_this_oldid' => $row->rev_id,
'rc_last_oldid' => isset($row->rc_last_oldid) ? $row->rc_last_oldid : 0,
'rc_bot' => 0,
'rc_moved_to_ns' => 0,
'rc_moved_to_title' => '',
'rc_ip' => '',
'rc_patrolled' => '1', # we can't support patrolling on the Watchlist
# currently because it uses cur, not recentchanges
'rc_new' => $row->page_is_new # obsolete
);
$this->mExtra = array();
}
/**
* Gets the end part of the diff URL associated with this object
* Blank if no diff link should be displayed
*/
function diffLinkTrail( $forceCur )
{
if ( $this->mAttribs['rc_type'] == RC_EDIT ) {
$trail = "curid=" . (int)($this->mAttribs['rc_cur_id']) .
"&oldid=" . (int)($this->mAttribs['rc_last_oldid']);
if ( $forceCur ) {
$trail .= '&diff=0' ;
} else {
$trail .= '&diff=' . (int)($this->mAttribs['rc_this_oldid']);
}
} else {
$trail = '';
}
return $trail;
}
function getIRCLine() {
extract($this->mAttribs);
extract($this->mExtra);
$titleObj =& $this->getTitle();
$bad = array("\n", "\r");
$empty = array("", "");
$title = $titleObj->getPrefixedText();
$title = str_replace($bad, $empty, $title);
if ( $rc_new ) {
$url = $titleObj->getFullURL();
} else {
$url = $titleObj->getFullURL("diff=0&oldid=$rc_last_oldid");
}
if ( isset( $oldSize ) && isset( $newSize ) ) {
$szdiff = $newSize - $oldSize;
if ($szdiff < -500)
$szdiff = "\002$szdiff\002";
else if ($szdiff >= 0)
$szdiff = "+$szdiff";
$szdiff = "($szdiff)";
} else {
$szdiff = '';
}
$comment = str_replace($bad, $empty, $rc_comment);
$user = str_replace($bad, $empty, $rc_user_text);
$flag = ($rc_minor ? "M" : "") . ($rc_new ? "N" : "");
# see http://www.irssi.org/?page=docs&doc=formats for some colour codes. prefix is \003,
# no colour (\003) switches back to the term default
$comment = preg_replace("/\/\* (.*) \*\/(.*)/", "\00315\$1\003 - \00310\$2\003", $comment);
$fullString = "\00314[[\00307$title\00314]]\0034 $flag\00310 " .
"\00302$url\003 \0035*\003 \00303$user\003 \0035*\003 $szdiff \00310$comment\003\n";
return $fullString;
}
}
?>
$link = htmlspecialchars( $link );
$r = ($class != '') ? " class='$class'" : " class='external'";
$r .= " title=\"{$link}\"";
return $r;
}
/** @todo document */
function getInternalLinkAttributes( $link, $text, $broken = false ) {
$link = urldecode( $link );
$link = str_replace( '_', ' ', $link );
$link = htmlspecialchars( $link );
if( $broken == 'stub' ) {
$r = ' class="stub"';
} else if ( $broken == 'yes' ) {
$r = ' class="new"';
} else {
$r = '';
}
$r .= " title=\"{$link}\"";
return $r;
}
/**
* @param bool $broken
*/
function getInternalLinkAttributesObj( &$nt, $text, $broken = false ) {
if( $broken == 'stub' ) {
$r = ' class="stub"';
} else if ( $broken == 'yes' ) {
$r = ' class="new"';
} else {
$r = '';
}
$r .= ' title="' . $nt->getEscapedText() . '"';
return $r;
}
/**
* Note: This function MUST call getArticleID() on the link,
* otherwise the cache won't get updated properly. See LINKCACHE.DOC.
*/
function makeLink( $title, $text = '', $query = '', $trail = '' ) {
wfProfileIn( 'Linker::makeLink' );
$nt = Title::newFromText( $title );
if ($nt) {
$result = $this->makeLinkObj( Title::newFromText( $title ), $text, $query, $trail );
} else {
wfDebug( 'Invalid title passed to Linker::makeLink(): "'.$title."\"\n" );
$result = $text == "" ? $title : $text;
}
wfProfileOut( 'Linker::makeLink' );
return $result;
}
/** @todo document */
function makeKnownLink( $title, $text = '', $query = '', $trail = '', $prefix = '',$aprops = '') {
$nt = Title::newFromText( $title );
if ($nt) {
return $this->makeKnownLinkObj( Title::newFromText( $title ), $text, $query, $trail, $prefix , $aprops );
} else {
wfDebug( 'Invalid title passed to Linker::makeKnownLink(): "'.$title."\"\n" );
return $text == '' ? $title : $text;
}
}
/** @todo document */
function makeBrokenLink( $title, $text = '', $query = '', $trail = '' ) {
$nt = Title::newFromText( $title );
if ($nt) {
return $this->makeBrokenLinkObj( Title::newFromText( $title ), $text, $query, $trail );
} else {
wfDebug( 'Invalid title passed to Linker::makeBrokenLink(): "'.$title."\"\n" );
return $text == '' ? $title : $text;
}
}
/** @todo document */
function makeStubLink( $title, $text = '', $query = '', $trail = '' ) {
$nt = Title::newFromText( $title );
if ($nt) {
return $this->makeStubLinkObj( Title::newFromText( $title ), $text, $query, $trail );
} else {
wfDebug( 'Invalid title passed to Linker::makeStubLink(): "'.$title."\"\n" );
return $text == '' ? $title : $text;
}
}
/**
* Pass a title object, not a title string
*/
function makeLinkObj( $nt, $text= '', $query = '', $trail = '', $prefix = '' ) {
global $wgUser;
$fname = 'Linker::makeLinkObj';
wfProfileIn( $fname );
# Fail gracefully
if ( ! is_object($nt) ) {
# wfDebugDieBacktrace();
wfProfileOut( $fname );
return "{$prefix}{$text}{$trail}";
}
$ns = $nt->getNamespace();
$dbkey = $nt->getDBkey();
if ( $nt->isExternal() ) {
$u = $nt->getFullURL();
$link = $nt->getPrefixedURL();
if ( '' == $text ) { $text = $nt->getPrefixedText(); }
$style = $this->getExternalLinkAttributes( $link, $text, 'extiw' );
$inside = '';
if ( '' != $trail ) {
if ( preg_match( '/^([a-z]+)(.*)$$/sD', $trail, $m ) ) {
$inside = $m[1];
$trail = $m[2];
}
}
# Check for anchors, normalize the anchor
$parts = explode( '#', $u, 2 );
if ( count( $parts ) == 2 ) {
$anchor = urlencode( Sanitizer::decodeCharReferences( str_replace(' ', '_', $parts[1] ) ) );
$replacearray = array(
'%3A' => ':',
'%' => '.'
);
$u = $parts[0] . '#' .
str_replace( array_keys( $replacearray ),
array_values( $replacearray ),
$anchor );
}
$t = "{$text}{$inside}";
wfProfileOut( $fname );
return $t;
} elseif ( $nt->isAlwaysKnown() ) {
# Image links, special page links and self-links with fragements are always known.
$retVal = $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
} else {
wfProfileIn( $fname.'-immediate' );
# Work out link colour immediately
$aid = $nt->getArticleID() ;
if ( 0 == $aid ) {
$retVal = $this->makeBrokenLinkObj( $nt, $text, $query, $trail, $prefix );
} else {
$threshold = $wgUser->getOption('stubthreshold') ;
if ( $threshold > 0 ) {
$dbr =& wfGetDB( DB_SLAVE );
$s = $dbr->selectRow(
array( 'page' ),
array( 'page_len',
'page_namespace',
'page_is_redirect' ),
array( 'page_id' => $aid ), $fname ) ;
if ( $s !== false ) {
$size = $s->page_len;
if ( $s->page_is_redirect OR $s->page_namespace != NS_MAIN ) {
$size = $threshold*2 ; # Really big
}
} else {
$size = $threshold*2 ; # Really big
}
} else {
$size = 1 ;
}
if ( $size < $threshold ) {
$retVal = $this->makeStubLinkObj( $nt, $text, $query, $trail, $prefix );
} else {
$retVal = $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
}
}
wfProfileOut( $fname.'-immediate' );
}
wfProfileOut( $fname );
return $retVal;
}
/**
* Pass a title object, not a title string
*/
function makeKnownLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' , $aprops = '' ) {
global $wgTitle;
$fname = 'Linker::makeKnownLinkObj';
wfProfileIn( $fname );
if ( !is_object( $nt ) ) {
wfProfileOut( $fname );
return $text;
}
$u = $nt->escapeLocalURL( $query );
if ( '' != $nt->getFragment() ) {
if( $nt->getPrefixedDbkey() == '' ) {
$u = '';
if ( '' == $text ) {
$text = htmlspecialchars( $nt->getFragment() );
}
}
$anchor = urlencode( Sanitizer::decodeCharReferences( str_replace( ' ', '_', $nt->getFragment() ) ) );
$replacearray = array(
'%3A' => ':',
'%' => '.'
);
$u .= '#' . str_replace(array_keys($replacearray),array_values($replacearray),$anchor);
}
if ( '' == $text ) {
$text = htmlspecialchars( $nt->getPrefixedText() );
}
$style = $this->getInternalLinkAttributesObj( $nt, $text );
list( $inside, $trail ) = Linker::splitTrail( $trail );
$r = "{$prefix}{$text}{$inside}{$trail}";
wfProfileOut( $fname );
return $r;
}
/**
* Pass a title object, not a title string
*/
function makeBrokenLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
# Fail gracefully
if ( ! isset($nt) ) {
# wfDebugDieBacktrace();
return "{$prefix}{$text}{$trail}";
}
$fname = 'Linker::makeBrokenLinkObj';
wfProfileIn( $fname );
if ( '' == $query ) {
$q = 'action=edit';
} else {
$q = 'action=edit&'.$query;
}
$u = $nt->escapeLocalURL( $q );
if ( '' == $text ) {
$text = htmlspecialchars( $nt->getPrefixedText() );
}
$style = $this->getInternalLinkAttributesObj( $nt, $text, "yes" );
list( $inside, $trail ) = Linker::splitTrail( $trail );
$s = "{$prefix}{$text}{$inside}{$trail}";
wfProfileOut( $fname );
return $s;
}
/**
* Pass a title object, not a title string
*/
function makeStubLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
$link = $nt->getPrefixedURL();
$u = $nt->escapeLocalURL( $query );
if ( '' == $text ) {
$text = htmlspecialchars( $nt->getPrefixedText() );
}
$style = $this->getInternalLinkAttributesObj( $nt, $text, 'stub' );
list( $inside, $trail ) = Linker::splitTrail( $trail );
$s = "{$prefix}{$text}{$inside}{$trail}";
return $s;
}
/**
* Generate either a normal exists-style link or a stub link, depending
* on the given page size.
*
* @param int $size
* @param Title $nt
* @param string $text
* @param string $query
* @param string $trail
* @param string $prefix
* @return string HTML of link
*/
function makeSizeLinkObj( $size, $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
global $wgUser;
$threshold = IntVal( $wgUser->getOption( 'stubthreshold' ) );
if( $size < $threshold ) {
return $this->makeStubLinkObj( $nt, $text, $query, $trail, $prefix );
} else {
return $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
}
}
/** @todo document */
function makeSelfLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
$u = $nt->escapeLocalURL( $query );
if ( '' == $text ) {
$text = htmlspecialchars( $nt->getPrefixedText() );
}
list( $inside, $trail ) = Linker::splitTrail( $trail );
return "{$prefix}{$text}{$inside}{$trail}";
}
/** @todo document */
function fnamePart( $url ) {
$basename = strrchr( $url, '/' );
if ( false === $basename ) {
$basename = $url;
} else {
$basename = substr( $basename, 1 );
}
return htmlspecialchars( $basename );
}
/** Obsolete alias */
function makeImage( $url, $alt = '' ) {
return $this->makeExternalImage( $url, $alt );
}
/** @todo document */
function makeExternalImage( $url, $alt = '' ) {
if ( '' == $alt ) {
$alt = $this->fnamePart( $url );
}
$s = '';
return $s;
}
/** @todo document */
function makeImageLinkObj( $nt, $label, $alt, $align = '', $width = false, $height = false, $framed = false,
$thumb = false, $manual_thumb = '' )
{
global $wgContLang, $wgUser, $wgThumbLimits;
$img = new Image( $nt );
if ( !$img->allowInlineDisplay() ) {
return $this->makeKnownLinkObj( $nt );
}
$url = $img->getViewURL();
$prefix = $postfix = '';
wfDebug( "makeImageLinkObj: '$width'x'$height'\n" );
if ( 'center' == $align )
{
$prefix = '
"
. "" . wfMsgForContent('toc') . " |