* @subpackage DifferenceEngine
*/
-/** */
-require_once( 'Revision.php' );
-
-define( 'MAX_DIFF_LINE', 10000 );
-define( 'MAX_DIFF_XREF_LENGTH', 10000 );
-
/**
* @todo document
- * @access public
+ * @public
* @package MediaWiki
* @subpackage DifferenceEngine
*/
class DifferenceEngine {
/**#@+
- * @access private
+ * @private
*/
var $mOldid, $mNewid, $mTitle;
var $mOldtitle, $mNewtitle, $mPagetitle;
var $mOldtext, $mNewtext;
- var $mOldUser, $mNewUser;
- var $mOldComment, $mNewComment;
var $mOldPage, $mNewPage;
var $mRcidMarkPatrolled;
var $mOldRev, $mNewRev;
/**
* Constructor
- * @param Title $titleObj Title object that the diff is associated with
- * @param integer $old Old ID we want to show and diff with.
- * @param string $new Either 'prev' or 'next'.
- * @param integer $rcid ??? (default 0)
+ * @param $titleObj Title object that the diff is associated with
+ * @param $old Integer: old ID we want to show and diff with.
+ * @param $new String: either 'prev' or 'next'.
+ * @param $rcid Integer: ??? FIXME (default 0)
*/
function DifferenceEngine( $titleObj = null, $old = 0, $new = 0, $rcid = 0 ) {
$this->mTitle = $titleObj;
wfDebug("DifferenceEngine old '$old' new '$new' rcid '$rcid'\n");
- if ( 'prev' == $new ) {
+ if ( 'prev' === $new ) {
# Show diff between revision $old and the previous one.
# Get previous one from DB.
#
$this->mOldid = $this->mTitle->getPreviousRevisionID( $this->mNewid );
- } elseif ( 'next' == $new ) {
+ } elseif ( 'next' === $new ) {
# Show diff between revision $old and the previous one.
# Get previous one from DB.
#
}
function showDiffPage() {
- global $wgUser, $wgOut, $wgContLang, $wgOnlySysopsCanPatrol,
- $wgUseExternalEditor, $wgUseRCPatrol;
+ global $wgUser, $wgOut, $wgContLang, $wgUseExternalEditor, $wgUseRCPatrol;
$fname = 'DifferenceEngine::showDiffPage';
wfProfileIn( $fname );
wfProfileOut( $fname );
return;
}
+
+ wfRunHooks( 'DiffViewHeader', array( $this, $this->mOldRev, $this->mNewRev ) );
+
if ( $this->mNewRev->isCurrent() ) {
$wgOut->setArticleFlag( true );
}
$wgOut->setPageTitle( $oldTitle . ', ' . $newTitle );
}
$wgOut->setSubtitle( wfMsg( 'difference' ) );
- $wgOut->setRobotpolicy( 'noindex,follow' );
+ $wgOut->setRobotpolicy( 'noindex,nofollow' );
if ( !( $this->mOldPage->userCanRead() && $this->mNewPage->userCanRead() ) ) {
$wgOut->loginToUse();
$talk = $wgContLang->getNsText( NS_TALK );
$contribs = wfMsg( 'contribslink' );
- $this->mOldComment = $sk->formatComment($this->mOldComment);
- $this->mNewComment = $sk->formatComment($this->mNewComment);
-
- $oldUserLink = $sk->makeLinkObj( Title::makeTitleSafe( NS_USER, $this->mOldUser ), $this->mOldUser );
- $newUserLink = $sk->makeLinkObj( Title::makeTitleSafe( NS_USER, $this->mNewUser ), $this->mNewUser );
- $oldUTLink = $sk->makeLinkObj( Title::makeTitleSafe( NS_USER_TALK, $this->mOldUser ), $talk );
- $newUTLink = $sk->makeLinkObj( Title::makeTitleSafe( NS_USER_TALK, $this->mNewUser ), $talk );
- $oldContribs = $sk->makeKnownLinkObj( Title::makeTitle( NS_SPECIAL, 'Contributions' ), $contribs,
- 'target=' . urlencode($this->mOldUser) );
- $newContribs = $sk->makeKnownLinkObj( Title::makeTitle( NS_SPECIAL, 'Contributions' ), $contribs,
- 'target=' . urlencode($this->mNewUser) );
if ( $this->mNewRev->isCurrent() && $wgUser->isAllowed('rollback') ) {
+ $username = $this->mNewRev->getUserText();
$rollback = ' <strong>[' . $sk->makeKnownLinkObj( $this->mTitle, wfMsg( 'rollbacklink' ),
- 'action=rollback&from=' . urlencode($this->mNewUser) .
- '&token=' . urlencode( $wgUser->editToken( array( $this->mTitle->getPrefixedText(), $this->mNewUser ) ) ) ) .
+ 'action=rollback&from=' . urlencode( $username ) .
+ '&token=' . urlencode( $wgUser->editToken( array( $this->mTitle->getPrefixedText(), $username ) ) ) ) .
']</strong>';
} else {
$rollback = '';
}
- if ( $wgUseRCPatrol && $this->mRcidMarkPatrolled != 0 && $wgUser->isLoggedIn() &&
- ( $wgUser->isAllowed('rollback') || !$wgOnlySysopsCanPatrol ) )
- {
- $patrol = ' [' . $sk->makeKnownLinkObj( $this->mTitle, wfMsg( 'markaspatrolleddiff' ),
- "action=markpatrolled&rcid={$this->mRcidMarkPatrolled}" ) . ']';
+ if( $wgUseRCPatrol && $this->mRcidMarkPatrolled != 0 && $wgUser->isAllowed( 'patrol' ) ) {
+ $patrol = ' [' . $sk->makeKnownLinkObj( $this->mTitle, wfMsg( 'markaspatrolleddiff' ), "action=markpatrolled&rcid={$this->mRcidMarkPatrolled}" ) . ']';
} else {
$patrol = '';
}
$prevlink = $sk->makeKnownLinkObj( $this->mTitle, wfMsgHtml( 'previousdiff' ),
'diff=prev&oldid='.$this->mOldid, '', '', 'id="differences-prevlink"' );
if ( $this->mNewRev->isCurrent() ) {
- $nextlink = '';
+ $nextlink = ' ';
} else {
$nextlink = $sk->makeKnownLinkObj( $this->mTitle, wfMsgHtml( 'nextdiff' ),
'diff=next&oldid='.$this->mNewid, '', '', 'id="differences-nextlink"' );
}
- $oldHeader = "<strong>{$this->mOldtitle}</strong><br />$oldUserLink " .
- "($oldUTLink | $oldContribs)<br />" . $this->mOldComment .
- '<br />' . $prevlink;
- $newHeader = "<strong>{$this->mNewtitle}</strong><br />$newUserLink " .
- "($newUTLink | $newContribs) $rollback<br />" . $this->mNewComment .
- '<br />' . $nextlink . $patrol;
+ $oldHeader = "<strong>{$this->mOldtitle}</strong><br />" .
+ $sk->revUserTools( $this->mOldRev ) . "<br />" .
+ $sk->revComment( $this->mOldRev ) . "<br />" .
+ $prevlink;
+ $newHeader = "<strong>{$this->mNewtitle}</strong><br />" .
+ $sk->revUserTools( $this->mNewRev ) . " $rollback<br />" .
+ $sk->revComment( $this->mNewRev ) . "<br />" .
+ $nextlink . $patrol;
$this->showDiff( $oldHeader, $newHeader );
$wgOut->addHTML( "<hr /><h2>{$this->mPagetitle}</h2>\n" );
if( !$this->mNewRev->isCurrent() ) {
- $oldEditSectionSetting = $wgOut->mParserOptions->setEditSection( false );
+ $oldEditSectionSetting = $wgOut->parserOptions()->setEditSection( false );
}
$this->loadNewText();
$wgOut->addSecondaryWikiText( $this->mNewtext );
if( !$this->mNewRev->isCurrent() ) {
- $wgOut->mParserOptions->setEditSection( $oldEditSectionSetting );
+ $wgOut->parserOptions()->setEditSection( $oldEditSectionSetting );
}
wfProfileOut( $fname );
* contrast to normal "old revision" display style.
*/
function showFirstRevision() {
- global $wgOut, $wgUser, $wgLang;
+ global $wgOut, $wgUser;
$fname = 'DifferenceEngine::showFirstRevision';
wfProfileIn( $fname );
#
$sk = $wgUser->getSkin();
- $uTLink = $sk->makeLinkObj( Title::makeTitleSafe( NS_USER_TALK, $this->mOldUser ), $wgLang->getNsText( NS_TALK ) );
- $userLink = $sk->makeLinkObj( Title::makeTitleSafe( NS_USER, $this->mOldUser ), $this->mOldUser );
- $contribs = $sk->makeKnownLinkObj( Title::makeTitle( NS_SPECIAL, 'Contributions' ), wfMsg( 'contribslink' ),
- 'target=' . urlencode($this->mOldUser) );
$nextlink = $sk->makeKnownLinkObj( $this->mTitle, wfMsgHtml( 'nextdiff' ), 'diff=next&oldid='.$this->mNewid, '', '', 'id="differences-nextlink"' );
- $header = "<div class=\"firstrevisionheader\" style=\"text-align: center\"><strong>{$this->mOldtitle}</strong><br />$userLink " .
- "($uTLink | $contribs)<br />" . $this->mOldComment .
- '<br />' . $nextlink. "</div>\n";
+ $header = "<div class=\"firstrevisionheader\" style=\"text-align: center\"><strong>{$this->mOldtitle}</strong><br />" .
+ $sk->revUserTools( $this->mNewRev ) . "<br />" .
+ $sk->revComment( $this->mNewRev ) . "<br />" .
+ $nextlink . "</div>\n";
$wgOut->addHTML( $header );
$wgOut->setSubtitle( wfMsg( 'difference' ) );
- $wgOut->setRobotpolicy( 'noindex,follow' );
+ $wgOut->setRobotpolicy( 'noindex,nofollow' );
# Show current revision
global $wgOut;
$diff = $this->getDiff( $otitle, $ntitle );
if ( $diff === false ) {
- $wgOut->addWikitext( wfMsg( 'missingarticle', "<nowiki>$t</nowiki>" ) );
+ $wgOut->addWikitext( wfMsg( 'missingarticle', "<nowiki>(fixme, bug)</nowiki>" ) );
return false;
} else {
$wgOut->addHTML( $diff );
/**
* Get the diff table body, without header
+ * Results are cached
* Returns false on error
*/
function getDiffBody() {
- global $wgUseExternalDiffEngine, $wgContLang, $wgMemc, $wgDBname;
-
+ global $wgMemc;
+ $fname = 'DifferenceEngine::getDiffBody';
+ wfProfileIn( $fname );
+
// Cacheable?
$key = false;
if ( $this->mOldid && $this->mNewid ) {
// Try cache
- $key = "$wgDBname:diff:oldid:{$this->mOldid}:newid:{$this->mNewid}";
+ $key = wfMemcKey( 'diff', 'oldid', $this->mOldid, 'newid', $this->mNewid );
$difftext = $wgMemc->get( $key );
if ( $difftext ) {
wfIncrStats( 'diff_cache_hit' );
- $difftext .= "\n<!-- diff cache key $key -->\n";
+ $difftext = $this->localiseLineNumbers( $difftext );
+ $difftext .= "\n<!-- diff cache key $key -->\n";
+ wfProfileOut( $fname );
return $difftext;
}
}
if ( !$this->loadText() ) {
+ wfProfileOut( $fname );
return false;
}
- $otext = $wgContLang->segmentForDiff($this->mOldtext);
- $ntext = $wgContLang->segmentForDiff($this->mNewtext);
- if ( $wgUseExternalDiffEngine ) {
- # For historical reasons, external diff engine expects
- # input text to be HTML-escaped already
- $otext = str_replace( "\r\n", "\n", htmlspecialchars ( $otext ) );
- $ntext = str_replace( "\r\n", "\n", htmlspecialchars ( $ntext ) );
- if( !function_exists( 'wikidiff_do_diff' ) ) {
- dl('php_wikidiff.so');
- }
- $difftext = wikidiff_do_diff( $otext, $ntext, 2 );
- } else {
- $ota = explode( "\n", str_replace( "\r\n", "\n", $otext ) );
- $nta = explode( "\n", str_replace( "\r\n", "\n", $ntext ) );
- $diffs =& new Diff( $ota, $nta );
- $formatter =& new TableDiffFormatter();
- $difftext = $formatter->format( $diffs );
- }
- $difftext = $wgContLang->unsegmentForDiff($difftext);
-
+ $difftext = $this->generateDiffBody( $this->mOldtext, $this->mNewtext );
+
// Save to cache for 7 days
- if ( $key !== false ) {
+ if ( $key !== false && $difftext !== false ) {
wfIncrStats( 'diff_cache_miss' );
$wgMemc->set( $key, $difftext, 7*86400 );
} else {
wfIncrStats( 'diff_uncacheable' );
}
+ // Replace line numbers with the text in the user's language
+ if ( $difftext !== false ) {
+ $difftext = $this->localiseLineNumbers( $difftext );
+ }
+ wfProfileOut( $fname );
return $difftext;
}
+ /**
+ * Generate a diff, no caching
+ * $otext and $ntext must be already segmented
+ */
+ function generateDiffBody( $otext, $ntext ) {
+ global $wgExternalDiffEngine, $wgContLang;
+ $fname = 'DifferenceEngine::generateDiffBody';
+
+ $otext = str_replace( "\r\n", "\n", $otext );
+ $ntext = str_replace( "\r\n", "\n", $ntext );
+
+ if ( $wgExternalDiffEngine == 'wikidiff' ) {
+ # For historical reasons, external diff engine expects
+ # input text to be HTML-escaped already
+ $otext = htmlspecialchars ( $wgContLang->segmentForDiff( $otext ) );
+ $ntext = htmlspecialchars ( $wgContLang->segmentForDiff( $ntext ) );
+ if( !function_exists( 'wikidiff_do_diff' ) ) {
+ dl('php_wikidiff.so');
+ }
+ return $wgContLang->unsegementForDiff( wikidiff_do_diff( $otext, $ntext, 2 ) );
+ }
+
+ if ( $wgExternalDiffEngine == 'wikidiff2' ) {
+ # Better external diff engine, the 2 may some day be dropped
+ # This one does the escaping and segmenting itself
+ if ( !function_exists( 'wikidiff2_do_diff' ) ) {
+ wfProfileIn( "$fname-dl" );
+ @dl('php_wikidiff2.so');
+ wfProfileOut( "$fname-dl" );
+ }
+ if ( function_exists( 'wikidiff2_do_diff' ) ) {
+ wfProfileIn( 'wikidiff2_do_diff' );
+ $text = wikidiff2_do_diff( $otext, $ntext, 2 );
+ wfProfileOut( 'wikidiff2_do_diff' );
+ return $text;
+ }
+ }
+ if ( $wgExternalDiffEngine !== false ) {
+ # Diff via the shell
+ global $wgTmpDirectory;
+ $tempName1 = tempnam( $wgTmpDirectory, 'diff_' );
+ $tempName2 = tempnam( $wgTmpDirectory, 'diff_' );
+
+ $tempFile1 = fopen( $tempName1, "w" );
+ if ( !$tempFile1 ) {
+ wfProfileOut( $fname );
+ return false;
+ }
+ $tempFile2 = fopen( $tempName2, "w" );
+ if ( !$tempFile2 ) {
+ wfProfileOut( $fname );
+ return false;
+ }
+ fwrite( $tempFile1, $otext );
+ fwrite( $tempFile2, $ntext );
+ fclose( $tempFile1 );
+ fclose( $tempFile2 );
+ $cmd = wfEscapeShellArg( $wgExternalDiffEngine, $tempName1, $tempName2 );
+ wfProfileIn( "$fname-shellexec" );
+ $difftext = wfShellExec( $cmd );
+ wfProfileOut( "$fname-shellexec" );
+ unlink( $tempName1 );
+ unlink( $tempName2 );
+ return $difftext;
+ }
+
+ # Native PHP diff
+ $ota = explode( "\n", $wgContLang->segmentForDiff( $otext ) );
+ $nta = explode( "\n", $wgContLang->segmentForDiff( $ntext ) );
+ $diffs = new Diff( $ota, $nta );
+ $formatter = new TableDiffFormatter();
+ return $wgContLang->unsegmentForDiff( $formatter->format( $diffs ) );
+ }
+
+
+ /**
+ * Replace line numbers with the text in the user's language
+ */
+ function localiseLineNumbers( $text ) {
+ return preg_replace_callback( '/<!--LINE (\d+)-->/',
+ array( &$this, 'localiseLineNumbersCb' ), $text );
+ }
+
+ function localiseLineNumbersCb( $matches ) {
+ global $wgLang;
+ return wfMsgExt( 'lineno', array('parseinline'), $wgLang->formatNum( $matches[1] ) );
+ }
+
/**
* Add the header to a diff body
*/
}
// Set assorted variables
+ $timestamp = $wgLang->timeanddate( $this->mNewRev->getTimestamp(), true );
+ $this->mNewPage = $this->mNewRev->getTitle();
if( $this->mNewRev->isCurrent() ) {
- $this->mPagetitle = htmlspecialchars( wfMsg( 'currentrev' ) );
- $this->mNewPage = $this->mTitle;
$newLink = $this->mNewPage->escapeLocalUrl();
- $this->mNewtitle = "<a href='$newLink'>{$this->mPagetitle}</a>";
+ $this->mPagetitle = htmlspecialchars( wfMsg( 'currentrev' ) );
+ $newEdit = $this->mNewPage->escapeLocalUrl( 'action=edit' );
+
+ $this->mNewtitle = "<strong><a href='$newLink'>{$this->mPagetitle}</a> ($timestamp)</strong>"
+ . " (<a href='$newEdit'>" . htmlspecialchars( wfMsg( 'editold' ) ) . "</a>)";
+
} else {
- $this->mNewPage = $this->mNewRev->getTitle();
- $newLink = $this->mNewPage->escapeLocalUrl ('oldid=' . $this->mNewid );
- $t = $wgLang->timeanddate( $this->mNewRev->getTimestamp(), true );
- $this->mPagetitle = htmlspecialchars( wfMsg( 'revisionasof', $t ) );
- $this->mNewtitle = "<a href='$newLink'>{$this->mPagetitle}</a>";
+ $newLink = $this->mNewPage->escapeLocalUrl( 'oldid=' . $this->mNewid );
+ $newEdit = $this->mNewPage->escapeLocalUrl( 'action=edit&oldid=' . $this->mNewid );
+ $this->mPagetitle = htmlspecialchars( wfMsg( 'revisionasof', $timestamp ) );
+
+ $this->mNewtitle = "<strong><a href='$newLink'>{$this->mPagetitle}</a></strong>"
+ . " (<a href='$newEdit'>" . htmlspecialchars( wfMsg( 'editold' ) ) . "</a>)";
}
- $this->mNewUser = $this->mNewRev->getUserText();
- $this->mNewComment = $this->mNewRev->getComment();
-
// Load the old revision object
$this->mOldRev = false;
if( $this->mOldid ) {
$t = $wgLang->timeanddate( $this->mOldRev->getTimestamp(), true );
$oldLink = $this->mOldPage->escapeLocalUrl( 'oldid=' . $this->mOldid );
- $this->mOldtitle = "<a href='$oldLink'>" . htmlspecialchars( wfMsg( 'revisionasof', $t ) ) . '</a>';
-
-
- $this->mOldUser = $this->mOldRev->getUserText();
- $this->mOldComment = $this->mOldRev->getComment();
+ $oldEdit = $this->mOldPage->escapeLocalUrl( 'action=edit&oldid=' . $this->mOldid );
+ $this->mOldtitle = "<strong><a href='$oldLink'>" . htmlspecialchars( wfMsg( 'revisionasof', $t ) )
+ . "</a></strong> (<a href='$oldEdit'>" . htmlspecialchars( wfMsg( 'editold' ) ) . "</a>)";
}
return true;
return false;
}
if ( $this->mOldRev ) {
+ // FIXME: permission tests
$this->mOldtext = $this->mOldRev->getText();
if ( $this->mOldtext === false ) {
return false;
/**
* @todo document
- * @access private
+ * @private
* @package MediaWiki
* @subpackage DifferenceEngine
*/
/**
* @todo document
- * @access private
+ * @private
* @package MediaWiki
* @subpackage DifferenceEngine
*/
/**
* @todo document
- * @access private
+ * @private
* @package MediaWiki
* @subpackage DifferenceEngine
*/
/**
* @todo document
- * @access private
+ * @private
* @package MediaWiki
* @subpackage DifferenceEngine
*/
/**
* @todo document
- * @access private
+ * @private
* @package MediaWiki
* @subpackage DifferenceEngine
*/
* Line length limits for robustness added by Tim Starling, 2005-08-31
*
* @author Geoffrey T. Dairiki, Tim Starling
- * @access private
+ * @private
* @package MediaWiki
* @subpackage DifferenceEngine
*/
class _DiffEngine
{
+ const MAX_XREF_LENGTH = 10000;
+
function diff ($from_lines, $to_lines) {
$fname = '_DiffEngine::diff';
wfProfileIn( $fname );
* Returns the whole line if it's small enough, or the MD5 hash otherwise
*/
function _line_hash( $line ) {
- if ( strlen( $line ) > MAX_DIFF_XREF_LENGTH ) {
+ if ( strlen( $line ) > self::MAX_XREF_LENGTH ) {
return md5( $line );
} else {
return $line;
/**
* Class representing a 'diff' between two sequences of strings.
* @todo document
- * @access private
+ * @private
* @package MediaWiki
* @subpackage DifferenceEngine
*/
/**
* FIXME: bad name.
* @todo document
- * @access private
+ * @private
* @package MediaWiki
* @subpackage DifferenceEngine
*/
* It is intended that this class be customized via inheritance,
* to obtain fancier outputs.
* @todo document
- * @access private
+ * @private
* @package MediaWiki
* @subpackage DifferenceEngine
*/
/**
* @todo document
- * @access private
+ * @private
* @package MediaWiki
* @subpackage DifferenceEngine
*/
/**
* @todo document
- * @access private
+ * @private
* @package MediaWiki
* @subpackage DifferenceEngine
*/
class WordLevelDiff extends MappedDiff
{
+ const MAX_LINE_LENGTH = 10000;
+
function WordLevelDiff ($orig_lines, $closing_lines) {
$fname = 'WordLevelDiff::WordLevelDiff';
wfProfileIn( $fname );
$words[] = "\n";
$stripped[] = "\n";
}
- if ( strlen( $line ) > MAX_DIFF_LINE ) {
+ if ( strlen( $line ) > self::MAX_LINE_LENGTH ) {
$words[] = $line;
$stripped[] = $line;
} else {
/**
* Wikipedia Table style diff formatter.
* @todo document
- * @access private
+ * @private
* @package MediaWiki
* @subpackage DifferenceEngine
*/
}
function _block_header( $xbeg, $xlen, $ybeg, $ylen ) {
- $l1 = wfMsg( 'lineno', $xbeg );
- $l2 = wfMsg( 'lineno', $ybeg );
-
- $r = '<tr><td colspan="2" align="left"><strong>'.$l1."</strong></td>\n" .
- '<td colspan="2" align="left"><strong>'.$l2."</strong></td></tr>\n";
+ $r = '<tr><td colspan="2" align="left"><strong><!--LINE '.$xbeg."--></strong></td>\n" .
+ '<td colspan="2" align="left"><strong><!--LINE '.$ybeg."--></strong></td></tr>\n";
return $r;
}
function _start_block( $header ) {
- global $wgOut;
echo $header;
}