* Non-working API to facilitate dev collaboration. Do not enable this yet in localset...
[lhc/web/wiklou.git] / includes / DifferenceEngine.php
index 492aa4a..6dc82d6 100644 (file)
@@ -6,26 +6,22 @@
  */
 
 /** */
-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;
@@ -35,10 +31,10 @@ class DifferenceEngine {
 
        /**
         * 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;
@@ -72,8 +68,7 @@ class DifferenceEngine {
        }
 
        function showDiffPage() {
-               global $wgUser, $wgOut, $wgContLang, $wgOnlySysopsCanPatrol;
-               global $wgUseExternalEditor, $wgUseRCPatrol;
+               global $wgUser, $wgOut, $wgContLang, $wgUseExternalEditor, $wgUseRCPatrol;
                $fname = 'DifferenceEngine::showDiffPage';
                wfProfileIn( $fname );
 
@@ -117,6 +112,9 @@ CONTROL;
                        wfProfileOut( $fname );
                        return;
                }
+               
+               wfRunHooks( 'DiffViewHeader', array( $this, $this->mOldRev, $this->mNewRev ) );
+
                if ( $this->mNewRev->isCurrent() ) {
                        $wgOut->setArticleFlag( true );
                }
@@ -140,7 +138,7 @@ CONTROL;
                        $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();
@@ -153,30 +151,17 @@ CONTROL;
                $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 = '&nbsp;&nbsp;&nbsp;<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 = '';
                }
@@ -184,24 +169,26 @@ CONTROL;
                $prevlink = $sk->makeKnownLinkObj( $this->mTitle, wfMsgHtml( 'previousdiff' ),
                        'diff=prev&oldid='.$this->mOldid, '', '', 'id="differences-prevlink"' );
                if ( $this->mNewRev->isCurrent() ) {
-                       $nextlink = '';
+                       $nextlink = '&nbsp;';
                } 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();
@@ -211,7 +198,7 @@ CONTROL;
                $wgOut->addSecondaryWikiText( $this->mNewtext );
 
                if( !$this->mNewRev->isCurrent() ) {
-                       $wgOut->mParserOptions->setEditSection( $oldEditSectionSetting );
+                       $wgOut->parserOptions()->setEditSection( $oldEditSectionSetting );
                }
 
                wfProfileOut( $fname );
@@ -222,7 +209,7 @@ CONTROL;
         * contrast to normal "old revision" display style.
         */
        function showFirstRevision() {
-               global $wgOut, $wgUser, $wgLang;
+               global $wgOut, $wgUser;
 
                $fname = 'DifferenceEngine::showFirstRevision';
                wfProfileIn( $fname );
@@ -255,19 +242,16 @@ CONTROL;
                #
                $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
@@ -289,7 +273,7 @@ CONTROL;
                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 );
@@ -330,7 +314,7 @@ CONTROL;
                        if ( $difftext ) {
                                wfIncrStats( 'diff_cache_hit' );
                                $difftext = $this->localiseLineNumbers( $difftext );
-                               $difftext .= "\n<!-- diff cache key $key -->\n"; 
+                               $difftext .= "\n<!-- diff cache key $key -->\n";
                                wfProfileOut( $fname );
                                return $difftext;
                        }
@@ -378,16 +362,21 @@ CONTROL;
                                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' ) ) {
-                               return wikidiff2_do_diff( $otext, $ntext, 2 );
+                               wfProfileIn( 'wikidiff2_do_diff' );
+                               $text = wikidiff2_do_diff( $otext, $ntext, 2 );
+                               wfProfileOut( 'wikidiff2_do_diff' );
+                               return $text;
                        }
                }
                if ( $wgExternalDiffEngine !== false ) {
@@ -422,8 +411,8 @@ CONTROL;
                # Native PHP diff
                $ota = explode( "\n", $wgContLang->segmentForDiff( $otext ) );
                $nta = explode( "\n", $wgContLang->segmentForDiff( $ntext ) );
-               $diffs =& new Diff( $ota, $nta );
-               $formatter =& new TableDiffFormatter();
+               $diffs = new Diff( $ota, $nta );
+               $formatter = new TableDiffFormatter();
                return $wgContLang->unsegmentForDiff( $formatter->format( $diffs ) );
        }
                
@@ -432,13 +421,13 @@ CONTROL;
         * Replace line numbers with the text in the user's language
         */
        function localiseLineNumbers( $text ) {
-               return preg_replace_callback( '/<!--LINE (\d+)-->/', 
+               return preg_replace_callback( '/<!--LINE (\d+)-->/',
                        array( &$this, 'localiseLineNumbersCb' ), $text );
        }
 
        function localiseLineNumbersCb( $matches ) {
                global $wgLang;
-               return wfMsg( 'lineno', $wgLang->formatNum( $matches[1] ) );
+               return wfMsgExt( 'lineno', array('parseinline'), $wgLang->formatNum( $matches[1] ) );
        }
 
        /**
@@ -497,22 +486,25 @@ CONTROL;
                }
 
                // 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 ) {
@@ -538,11 +530,9 @@ CONTROL;
 
                        $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;
@@ -563,6 +553,7 @@ CONTROL;
                        return false;
                }
                if ( $this->mOldRev ) {
+                       // FIXME: permission tests
                        $this->mOldtext = $this->mOldRev->getText();
                        if ( $this->mOldtext === false ) {
                                return false;
@@ -606,7 +597,7 @@ define('USE_ASSERTS', function_exists('assert'));
 
 /**
  * @todo document
- * @access private
+ * @private
  * @package MediaWiki
  * @subpackage DifferenceEngine
  */
@@ -630,7 +621,7 @@ class _DiffOp {
 
 /**
  * @todo document
- * @access private
+ * @private
  * @package MediaWiki
  * @subpackage DifferenceEngine
  */
@@ -651,7 +642,7 @@ class _DiffOp_Copy extends _DiffOp {
 
 /**
  * @todo document
- * @access private
+ * @private
  * @package MediaWiki
  * @subpackage DifferenceEngine
  */
@@ -670,7 +661,7 @@ class _DiffOp_Delete extends _DiffOp {
 
 /**
  * @todo document
- * @access private
+ * @private
  * @package MediaWiki
  * @subpackage DifferenceEngine
  */
@@ -689,7 +680,7 @@ class _DiffOp_Add extends _DiffOp {
 
 /**
  * @todo document
- * @access private
+ * @private
  * @package MediaWiki
  * @subpackage DifferenceEngine
  */
@@ -727,7 +718,7 @@ class _DiffOp_Change extends _DiffOp {
  * 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
  */
@@ -1147,7 +1138,7 @@ class _DiffEngine
 /**
  * Class representing a 'diff' between two sequences of strings.
  * @todo document
- * @access private
+ * @private
  * @package MediaWiki
  * @subpackage DifferenceEngine
  */
@@ -1289,7 +1280,7 @@ class Diff
 /**
  * FIXME: bad name.
  * @todo document
- * @access private
+ * @private
  * @package MediaWiki
  * @subpackage DifferenceEngine
  */
@@ -1353,7 +1344,7 @@ class MappedDiff extends Diff
  * It is intended that this class be customized via inheritance,
  * to obtain fancier outputs.
  * @todo document
- * @access private
+ * @private
  * @package MediaWiki
  * @subpackage DifferenceEngine
  */
@@ -1520,7 +1511,7 @@ define('NBSP', '&#160;');                 // iso-8859-x non-breaking space.
 
 /**
  * @todo document
- * @access private
+ * @private
  * @package MediaWiki
  * @subpackage DifferenceEngine
  */
@@ -1579,7 +1570,7 @@ class _HWLDF_WordAccumulator {
 
 /**
  * @todo document
- * @access private
+ * @private
  * @package MediaWiki
  * @subpackage DifferenceEngine
  */
@@ -1665,7 +1656,7 @@ class WordLevelDiff extends MappedDiff
 /**
  *     Wikipedia Table style diff formatter.
  * @todo document
- * @access private
+ * @private
  * @package MediaWiki
  * @subpackage DifferenceEngine
  */