* Skip additional setting of include_path in commandLine.inc (for non-Wikimedia mode)
[lhc/web/wiklou.git] / includes / DifferenceEngine.php
index 741b719..8d96e3d 100644 (file)
@@ -1,19 +1,22 @@
 <?php
 /**
  * See diff.doc
- * @package MediaWiki
- * @subpackage DifferenceEngine
+ * @todo indicate where diff.doc can be found.
+ * @addtogroup DifferenceEngine
  */
 
-/** */
-define( 'MAX_DIFF_LINE', 10000 );
-define( 'MAX_DIFF_XREF_LENGTH', 10000 );
+/**
+ * Constant to indicate diff cache compatibility.
+ * Bump this when changing the diff formatting in a way that
+ * fixes important bugs or such to force cached diff views to
+ * clear.
+ */
+define( 'MW_DIFF_VERSION', '1.11a' );
 
 /**
  * @todo document
  * @public
- * @package MediaWiki
- * @subpackage DifferenceEngine
+ * @addtogroup DifferenceEngine
  */
 class DifferenceEngine {
        /**#@+
@@ -67,8 +70,8 @@ class DifferenceEngine {
                $this->mRcidMarkPatrolled = intval($rcid);  # force it to be an integer
        }
 
-       function showDiffPage() {
-               global $wgUser, $wgOut, $wgContLang, $wgUseExternalEditor, $wgUseRCPatrol;
+       function showDiffPage( $diffOnly = false ) {
+               global $wgUser, $wgOut, $wgUseExternalEditor, $wgUseRCPatrol;
                $fname = 'DifferenceEngine::showDiffPage';
                wfProfileIn( $fname );
 
@@ -101,12 +104,10 @@ CONTROL;
                        return;
                }
 
-               $t = $this->mTitle->getPrefixedText() . " (Diff: {$this->mOldid}, " .
-                 "{$this->mNewid})";
-               $mtext = wfMsg( 'missingarticle', "<nowiki>$t</nowiki>" );
-
                $wgOut->setArticleFlag( false );
                if ( ! $this->loadRevisionData() ) {
+                       $t = $this->mTitle->getPrefixedText() . " (Diff: {$this->mOldid}, {$this->mNewid})";
+                       $mtext = wfMsg( 'missingarticle', "<nowiki>$t</nowiki>" );
                        $wgOut->setPagetitle( wfMsg( 'errorpagetitle' ) );
                        $wgOut->addWikitext( $mtext );
                        wfProfileOut( $fname );
@@ -124,6 +125,7 @@ CONTROL;
                # is the first version of that article. In that case, V' does not exist.
                if ( $this->mOldid === false ) {
                        $this->showFirstRevision();
+                       $this->renderNewRevision();  // should we respect $diffOnly here or not?
                        wfProfileOut( $fname );
                        return;
                }
@@ -148,15 +150,9 @@ CONTROL;
                }
 
                $sk = $wgUser->getSkin();
-               $talk = $wgContLang->getNsText( NS_TALK );
-               $contribs = wfMsg( 'contribslink' );
 
                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( $username ) .
-                               '&token=' . urlencode( $wgUser->editToken( array( $this->mTitle->getPrefixedText(), $username ) ) ) ) .
-                               ']</strong>';
+                       $rollback = '&nbsp;&nbsp;&nbsp;' . $sk->generateRollback( $this->mNewRev );
                } else {
                        $rollback = '';
                }
@@ -175,30 +171,63 @@ CONTROL;
                                'diff=next&oldid='.$this->mNewid, '', '', 'id="differences-nextlink"' );
                }
 
+               $oldminor = '';
+               $newminor = '';
+
+               if ($this->mOldRev->mMinorEdit == 1) {
+                       $oldminor = wfElement( 'span', array( 'class' => 'minor' ),
+                               wfMsg( 'minoreditletter') ) . ' ';
+               }
+
+               if ($this->mNewRev->mMinorEdit == 1) {
+                       $newminor = wfElement( 'span', array( 'class' => 'minor' ),
+                       wfMsg( 'minoreditletter') ) . ' ';
+               }
+
                $oldHeader = "<strong>{$this->mOldtitle}</strong><br />" .
                        $sk->revUserTools( $this->mOldRev ) . "<br />" .
-                       $sk->revComment( $this->mOldRev ) . "<br />" .
+                       $oldminor . $sk->revComment( $this->mOldRev, !$diffOnly ) . "<br />" .
                        $prevlink;
                $newHeader = "<strong>{$this->mNewtitle}</strong><br />" .
                        $sk->revUserTools( $this->mNewRev ) . " $rollback<br />" .
-                       $sk->revComment( $this->mNewRev ) . "<br />" .
+                       $newminor . $sk->revComment( $this->mNewRev, !$diffOnly ) . "<br />" .
                        $nextlink . $patrol;
 
                $this->showDiff( $oldHeader, $newHeader );
+
+               if ( !$diffOnly )
+                       $this->renderNewRevision();
+
+               wfProfileOut( $fname );
+       }
+
+       /**
+        * Show the new revision of the page.
+        */
+       function renderNewRevision() {
+               global $wgOut;
+               $fname = 'DifferenceEngine::renderNewRevision';
+               wfProfileIn( $fname );
+
                $wgOut->addHTML( "<hr /><h2>{$this->mPagetitle}</h2>\n" );
+               #add deleted rev tag if needed
+               if ( !$this->mNewRev->userCan(Revision::DELETED_TEXT) ) {
+                       $wgOut->addWikiText( wfMsg( 'rev-deleted-text-permission' ) );
+               }
 
                if( !$this->mNewRev->isCurrent() ) {
-                       $oldEditSectionSetting = $wgOut->mParserOptions->setEditSection( false );
+                       $oldEditSectionSetting = $wgOut->parserOptions()->setEditSection( false );
                }
 
                $this->loadNewText();
                if( is_object( $this->mNewRev ) ) {
                        $wgOut->setRevisionId( $this->mNewRev->getId() );
                }
-               $wgOut->addSecondaryWikiText( $this->mNewtext );
+
+               $wgOut->addWikiTextTidy( $this->mNewtext );
 
                if( !$this->mNewRev->isCurrent() ) {
-                       $wgOut->mParserOptions->setEditSection( $oldEditSectionSetting );
+                       $wgOut->parserOptions()->setEditSection( $oldEditSectionSetting );
                }
 
                wfProfileOut( $fname );
@@ -253,15 +282,6 @@ CONTROL;
                $wgOut->setSubtitle( wfMsg( 'difference' ) );
                $wgOut->setRobotpolicy( 'noindex,nofollow' );
 
-
-               # Show current revision
-               #
-               $wgOut->addHTML( "<hr /><h2>{$this->mPagetitle}</h2>\n" );
-               if( is_object( $this->mNewRev ) ) {
-                       $wgOut->setRevisionId( $this->mNewRev->getId() );
-               }
-               $wgOut->addSecondaryWikiText( $this->mNewtext );
-
                wfProfileOut( $fname );
        }
 
@@ -276,6 +296,7 @@ CONTROL;
                        $wgOut->addWikitext( wfMsg( 'missingarticle', "<nowiki>(fixme, bug)</nowiki>" ) );
                        return false;
                } else {
+                       $wgOut->addStyle( 'common/diff.css' );
                        $wgOut->addHTML( $diff );
                        return true;
                }
@@ -291,7 +312,8 @@ CONTROL;
                if ( $body === false ) {
                        return false;
                } else {
-                       return $this->addHeader( $body, $otitle, $ntitle );
+                       $multi = $this->getMultiNotice();
+                       return $this->addHeader( $body, $otitle, $ntitle, $multi );
                }
        }
 
@@ -301,7 +323,7 @@ CONTROL;
         * Returns false on error
         */
        function getDiffBody() {
-               global $wgMemc, $wgDBname;
+               global $wgMemc;
                $fname = 'DifferenceEngine::getDiffBody';
                wfProfileIn( $fname );
                
@@ -309,7 +331,7 @@ CONTROL;
                $key = false;
                if ( $this->mOldid && $this->mNewid ) {
                        // Try cache
-                       $key = "$wgDBname:diff:oldid:{$this->mOldid}:newid:{$this->mNewid}";
+                       $key = wfMemcKey( 'diff', 'version', MW_DIFF_VERSION, 'oldid', $this->mOldid, 'newid', $this->mNewid );
                        $difftext = $wgMemc->get( $key );
                        if ( $difftext ) {
                                wfIncrStats( 'diff_cache_hit' );
@@ -320,9 +342,14 @@ CONTROL;
                        }
                }
 
+               #loadtext is permission safe, this just clears out the diff
                if ( !$this->loadText() ) {
                        wfProfileOut( $fname );
                        return false;
+               } else if ( $this->mOldRev && !$this->mOldRev->userCan(Revision::DELETED_TEXT) ) {
+                 return '';
+               } else if ( $this->mNewRev && !$this->mNewRev->userCan(Revision::DELETED_TEXT) ) {
+                 return '';
                }
 
                $difftext = $this->generateDiffBody( $this->mOldtext, $this->mNewtext );
@@ -411,8 +438,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 ) );
        }
                
@@ -430,20 +457,61 @@ CONTROL;
                return wfMsgExt( 'lineno', array('parseinline'), $wgLang->formatNum( $matches[1] ) );
        }
 
+       
+       /**
+        * If there are revisions between the ones being compared, return a note saying so.
+        */
+       function getMultiNotice() {
+               if ( !is_object($this->mOldRev) || !is_object($this->mNewRev) )
+                       return '';
+               
+               if( !$this->mOldPage->equals( $this->mNewPage ) ) {
+                       // Comparing two different pages? Count would be meaningless.
+                       return '';
+               }
+               
+               $oldid = $this->mOldRev->getId();
+               $newid = $this->mNewRev->getId();
+               if ( $oldid > $newid ) {
+                       $tmp = $oldid; $oldid = $newid; $newid = $tmp;
+               }
+
+               $n = $this->mTitle->countRevisionsBetween( $oldid, $newid );
+               if ( !$n )
+                       return '';
+
+               return wfMsgExt( 'diff-multi', array( 'parseinline' ), $n );
+       }
+
+
        /**
         * Add the header to a diff body
         */
-       function addHeader( $diff, $otitle, $ntitle ) {
-               $out = "
-                       <table border='0' width='98%' cellpadding='0' cellspacing='4' class='diff'>
+       function addHeader( $diff, $otitle, $ntitle, $multi = '' ) {
+               global $wgOut;
+       
+               if ( $this->mOldRev && $this->mOldRev->isDeleted(Revision::DELETED_TEXT) ) {
+                  $otitle = '<span class="history-deleted">'.$otitle.'</span>';
+               }
+               if ( $this->mNewRev && $this->mNewRev->isDeleted(Revision::DELETED_TEXT) ) {
+                  $ntitle = '<span class="history-deleted">'.$ntitle.'</span>';
+               }
+               $header = "
+                       <table class='diff'>
+                       <col class='diff-marker' />
+                       <col class='diff-content' />
+                       <col class='diff-marker' />
+                       <col class='diff-content' />
                        <tr>
-                               <td colspan='2' width='50%' align='center' class='diff-otitle'>{$otitle}</td>
-                               <td colspan='2' width='50%' align='center' class='diff-ntitle'>{$ntitle}</td>
+                               <td colspan='2' class='diff-otitle'>{$otitle}</td>
+                               <td colspan='2' class='diff-ntitle'>{$ntitle}</td>
                        </tr>
-                       $diff
-                       </table>
                ";
-               return $out;
+
+               if ( $multi != '' )
+                       $header .= "<tr><td colspan='4' align='center' class='diff-multi'>{$multi}</td></tr>";
+
+               return $header . $diff . "</table>";
        }
 
        /**
@@ -492,16 +560,16 @@ CONTROL;
                        $newLink = $this->mNewPage->escapeLocalUrl();
                        $this->mPagetitle = htmlspecialchars( wfMsg( 'currentrev' ) );
                        $newEdit = $this->mNewPage->escapeLocalUrl( 'action=edit' );
-                       
-                       $this->mNewtitle = "<strong><a href='$newLink'>{$this->mPagetitle}</a> ($timestamp)</strong>"
+
+                       $this->mNewtitle = "<a href='$newLink'>{$this->mPagetitle}</a> ($timestamp)"
                                . " (<a href='$newEdit'>" . htmlspecialchars( wfMsg( 'editold' ) ) . "</a>)";
 
                } else {
                        $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>"
+
+                       $this->mNewtitle = "<a href='$newLink'>{$this->mPagetitle}</a>"
                                . " (<a href='$newEdit'>" . htmlspecialchars( wfMsg( 'editold' ) ) . "</a>)";
                }
 
@@ -531,8 +599,11 @@ CONTROL;
                        $t = $wgLang->timeanddate( $this->mOldRev->getTimestamp(), true );
                        $oldLink = $this->mOldPage->escapeLocalUrl( 'oldid=' . $this->mOldid );
                        $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>)";
+                       $this->mOldtitle = "<a href='$oldLink'>" . htmlspecialchars( wfMsg( 'revisionasof', $t ) )
+                               . "</a> (<a href='$oldEdit'>" . htmlspecialchars( wfMsg( 'editold' ) ) . "</a>)";
+                       //now that we considered old rev, we can make undo link (bug 8133, multi-edit undo)
+                       $newUndo = $this->mNewPage->escapeLocalUrl( 'action=edit&undoafter=' . $this->mOldid . '&undo=' . $this->mNewid);
+                       $this->mNewtitle .= " (<a href='$newUndo'>" . htmlspecialchars( wfMsg( 'editundo' ) ) . "</a>)";
                }
 
                return true;
@@ -554,13 +625,13 @@ CONTROL;
                }
                if ( $this->mOldRev ) {
                        // FIXME: permission tests
-                       $this->mOldtext = $this->mOldRev->getText();
+                       $this->mOldtext = $this->mOldRev->revText();
                        if ( $this->mOldtext === false ) {
                                return false;
                        }
                }
                if ( $this->mNewRev ) {
-                       $this->mNewtext = $this->mNewRev->getText();
+                       $this->mNewtext = $this->mNewRev->revText();
                        if ( $this->mNewtext === false ) {
                                return false;
                        }
@@ -598,8 +669,7 @@ define('USE_ASSERTS', function_exists('assert'));
 /**
  * @todo document
  * @private
- * @package MediaWiki
- * @subpackage DifferenceEngine
+ * @addtogroup DifferenceEngine
  */
 class _DiffOp {
        var $type;
@@ -622,8 +692,7 @@ class _DiffOp {
 /**
  * @todo document
  * @private
- * @package MediaWiki
- * @subpackage DifferenceEngine
+ * @addtogroup DifferenceEngine
  */
 class _DiffOp_Copy extends _DiffOp {
        var $type = 'copy';
@@ -643,8 +712,7 @@ class _DiffOp_Copy extends _DiffOp {
 /**
  * @todo document
  * @private
- * @package MediaWiki
- * @subpackage DifferenceEngine
+ * @addtogroup DifferenceEngine
  */
 class _DiffOp_Delete extends _DiffOp {
        var $type = 'delete';
@@ -662,8 +730,7 @@ class _DiffOp_Delete extends _DiffOp {
 /**
  * @todo document
  * @private
- * @package MediaWiki
- * @subpackage DifferenceEngine
+ * @addtogroup DifferenceEngine
  */
 class _DiffOp_Add extends _DiffOp {
        var $type = 'add';
@@ -681,8 +748,7 @@ class _DiffOp_Add extends _DiffOp {
 /**
  * @todo document
  * @private
- * @package MediaWiki
- * @subpackage DifferenceEngine
+ * @addtogroup DifferenceEngine
  */
 class _DiffOp_Change extends _DiffOp {
        var $type = 'change';
@@ -719,11 +785,12 @@ class _DiffOp_Change extends _DiffOp {
  *
  * @author Geoffrey T. Dairiki, Tim Starling
  * @private
- * @package MediaWiki
- * @subpackage DifferenceEngine
+ * @addtogroup DifferenceEngine
  */
 class _DiffEngine
 {
+       const MAX_XREF_LENGTH =  10000;
+
        function diff ($from_lines, $to_lines) {
                $fname = '_DiffEngine::diff';
                wfProfileIn( $fname );
@@ -821,7 +888,7 @@ class _DiffEngine
         * 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;
@@ -892,7 +959,7 @@ class _DiffEngine
                                                $ymids[$k] = $ymids[$k-1];
                                                break;
                                        }
-                               while (list ($junk, $y) = each($matches)) {
+                               while (list ( /* $junk */, $y) = each($matches)) {
                                        if ($y > $this->seq[$k-1]) {
                                                USE_ASSERTS && assert($y < $this->seq[$k]);
                                                // Optimization: this is a common case:
@@ -1139,8 +1206,7 @@ class _DiffEngine
  * Class representing a 'diff' between two sequences of strings.
  * @todo document
  * @private
- * @package MediaWiki
- * @subpackage DifferenceEngine
+ * @addtogroup DifferenceEngine
  */
 class Diff
 {
@@ -1278,11 +1344,9 @@ class Diff
 }
 
 /**
- * FIXME: bad name.
- * @todo document
+ * @todo document, bad name.
  * @private
- * @package MediaWiki
- * @subpackage DifferenceEngine
+ * @addtogroup DifferenceEngine
  */
 class MappedDiff extends Diff
 {
@@ -1345,8 +1409,7 @@ class MappedDiff extends Diff
  * to obtain fancier outputs.
  * @todo document
  * @private
- * @package MediaWiki
- * @subpackage DifferenceEngine
+ * @addtogroup DifferenceEngine
  */
 class DiffFormatter
 {
@@ -1512,8 +1575,7 @@ define('NBSP', '&#160;');                 // iso-8859-x non-breaking space.
 /**
  * @todo document
  * @private
- * @package MediaWiki
- * @subpackage DifferenceEngine
+ * @addtogroup DifferenceEngine
  */
 class _HWLDF_WordAccumulator {
        function _HWLDF_WordAccumulator () {
@@ -1525,9 +1587,12 @@ class _HWLDF_WordAccumulator {
 
        function _flushGroup ($new_tag) {
                if ($this->_group !== '') {
-                       if ($this->_tag == 'mark')
-                               $this->_line .= '<span class="diffchange">' .
-                                       htmlspecialchars ( $this->_group ) . '</span>';
+                       if ($this->_tag == 'ins')
+                               $this->_line .= '<ins class="diffchange">' .
+                                       htmlspecialchars ( $this->_group ) . '</ins>';
+                       elseif ($this->_tag == 'del')
+                               $this->_line .= '<del class="diffchange">' .
+                                       htmlspecialchars ( $this->_group ) . '</del>';
                        else
                                $this->_line .= htmlspecialchars ( $this->_group );
                }
@@ -1571,11 +1636,12 @@ class _HWLDF_WordAccumulator {
 /**
  * @todo document
  * @private
- * @package MediaWiki
- * @subpackage DifferenceEngine
+ * @addtogroup DifferenceEngine
  */
 class WordLevelDiff extends MappedDiff
 {
+       const MAX_LINE_LENGTH = 10000;
+
        function WordLevelDiff ($orig_lines, $closing_lines) {
                $fname = 'WordLevelDiff::WordLevelDiff';
                wfProfileIn( $fname );
@@ -1604,10 +1670,11 @@ class WordLevelDiff extends MappedDiff
                                $words[] = "\n";
                                $stripped[] = "\n";
                        }
-                       if ( strlen( $line ) > MAX_DIFF_LINE ) {
+                       if ( strlen( $line ) > self::MAX_LINE_LENGTH ) {
                                $words[] = $line;
                                $stripped[] = $line;
                        } else {
+                               $m = array();
                                if (preg_match_all('/ ( [^\S\n]+ | [0-9_A-Za-z\x80-\xff]+ | . ) (?: (?!< \n) [^\S\n])? /xs',
                                        $line, $m))
                                {
@@ -1629,7 +1696,7 @@ class WordLevelDiff extends MappedDiff
                        if ($edit->type == 'copy')
                                $orig->addWords($edit->orig);
                        elseif ($edit->orig)
-                               $orig->addWords($edit->orig, 'mark');
+                               $orig->addWords($edit->orig, 'del');
                }
                $lines = $orig->getLines();
                wfProfileOut( $fname );
@@ -1645,7 +1712,7 @@ class WordLevelDiff extends MappedDiff
                        if ($edit->type == 'copy')
                                $closing->addWords($edit->closing);
                        elseif ($edit->closing)
-                               $closing->addWords($edit->closing, 'mark');
+                               $closing->addWords($edit->closing, 'ins');
                }
                $lines = $closing->getLines();
                wfProfileOut( $fname );
@@ -1657,8 +1724,7 @@ class WordLevelDiff extends MappedDiff
  *     Wikipedia Table style diff formatter.
  * @todo document
  * @private
- * @package MediaWiki
- * @subpackage DifferenceEngine
+ * @addtogroup DifferenceEngine
  */
 class TableDiffFormatter extends DiffFormatter
 {
@@ -1668,8 +1734,8 @@ class TableDiffFormatter extends DiffFormatter
        }
 
        function _block_header( $xbeg, $xlen, $ybeg, $ylen ) {
-               $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";
+               $r = '<tr><td colspan="2" class="diff-lineno"><!--LINE '.$xbeg."--></td>\n" .
+                 '<td colspan="2" class="diff-lineno"><!--LINE '.$ybeg."--></td></tr>\n";
                return $r;
        }
 
@@ -1685,17 +1751,25 @@ class TableDiffFormatter extends DiffFormatter
 
        # HTML-escape parameter before calling this
        function addedLine( $line ) {
-               return "<td>+</td><td class='diff-addedline'>{$line}</td>";
+               return $this->wrapLine( '+', 'diff-addedline', $line );
        }
 
        # HTML-escape parameter before calling this
        function deletedLine( $line ) {
-               return "<td>-</td><td class='diff-deletedline'>{$line}</td>";
+               return $this->wrapLine( '-', 'diff-deletedline', $line );
        }
 
        # HTML-escape parameter before calling this
        function contextLine( $line ) {
-               return "<td> </td><td class='diff-context'>{$line}</td>";
+               return $this->wrapLine( ' ', 'diff-context', $line );
+       }
+       
+       private function wrapLine( $marker, $class, $line ) {
+               if( $line !== '' ) {
+                       // The <div> wrapper is needed for 'overflow: auto' style to scroll properly
+                       $line = "<div>$line</div>";
+               }
+               return "<td class='diff-marker'>$marker</td><td class='$class'>$line</td>";
        }
 
        function emptyLine() {