includes/diff/DifferenceEngine.php

   1 <?php
   2 /**
   3  * User interface for the difference engine.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup DifferenceEngine
  22  */
  23
  24 /**
  25  * Constant to indicate diff cache compatibility.
  26  * Bump this when changing the diff formatting in a way that
  27  * fixes important bugs or such to force cached diff views to
  28  * clear.
  29  */
  30 define( 'MW_DIFF_VERSION', '1.11a' );
  31
  32 /**
  33  * @todo document
  34  * @ingroup DifferenceEngine
  35  */
  36 class DifferenceEngine extends ContextSource {
  37         /**#@+
  38          * @private
  39          */
  40         var $mOldid, $mNewid;
  41         var $mOldtext, $mNewtext;
  42         protected $mDiffLang;
  43
  44         /**
  45          * @var Title
  46          */
  47         var $mOldPage, $mNewPage;
  48         var $mRcidMarkPatrolled;
  49
  50         /**
  51          * @var Revision
  52          */
  53         var $mOldRev, $mNewRev;
  54         private $mRevisionsIdsLoaded = false; // Have the revisions IDs been loaded
  55         var $mRevisionsLoaded = false; // Have the revisions been loaded
  56         var $mTextLoaded = 0; // How many text blobs have been loaded, 0, 1 or 2?
  57         var $mCacheHit = false; // Was the diff fetched from cache?
  58
  59         /**
  60          * Set this to true to add debug info to the HTML output.
  61          * Warning: this may cause RSS readers to spuriously mark articles as "new"
  62          * (bug 20601)
  63          */
  64         var $enableDebugComment = false;
  65
  66         // If true, line X is not displayed when X is 1, for example to increase
  67         // readability and conserve space with many small diffs.
  68         protected $mReducedLineNumbers = false;
  69
  70         // Link to action=markpatrolled
  71         protected $mMarkPatrolledLink = null;
  72
  73         protected $unhide = false; # show rev_deleted content if allowed
  74         /**#@-*/
  75
  76         /**
  77          * Constructor
  78          * @param $context IContextSource context to use, anything else will be ignored
  79          * @param $old Integer old ID we want to show and diff with.
  80          * @param $new String either 'prev' or 'next'.
  81          * @param $rcid Integer ??? FIXME (default 0)
  82          * @param $refreshCache boolean If set, refreshes the diff cache
  83          * @param $unhide boolean If set, allow viewing deleted revs
  84          */
  85         function __construct( $context = null, $old = 0, $new = 0, $rcid = 0,
  86                 $refreshCache = false, $unhide = false )
  87         {
  88                 if ( $context instanceof IContextSource ) {
  89                         $this->setContext( $context );
  90                 }
  91
  92                 wfDebug( "DifferenceEngine old '$old' new '$new' rcid '$rcid'\n" );
  93
  94                 $this->mOldid = $old;
  95                 $this->mNewid = $new;
  96                 $this->mRcidMarkPatrolled = intval( $rcid );  # force it to be an integer
  97                 $this->mRefreshCache = $refreshCache;
  98                 $this->unhide = $unhide;
  99         }
 100
 101         /**
 102          * @param $value bool
 103          */
 104         function setReducedLineNumbers( $value = true ) {
 105                 $this->mReducedLineNumbers = $value;
 106         }
 107
 108         /**
 109          * @return Language
 110          */
 111         function getDiffLang() {
 112                 if ( $this->mDiffLang === null ) {
 113                         # Default language in which the diff text is written.
 114                         $this->mDiffLang = $this->getTitle()->getPageLanguage();
 115                 }
 116                 return $this->mDiffLang;
 117         }
 118
 119         /**
 120          * @return bool
 121          */
 122         function wasCacheHit() {
 123                 return $this->mCacheHit;
 124         }
 125
 126         /**
 127          * @return int
 128          */
 129         function getOldid() {
 130                 $this->loadRevisionIds();
 131                 return $this->mOldid;
 132         }
 133
 134         /**
 135          * @return Bool|int
 136          */
 137         function getNewid() {
 138                 $this->loadRevisionIds();
 139                 return $this->mNewid;
 140         }
 141
 142         /**
 143          * Look up a special:Undelete link to the given deleted revision id,
 144          * as a workaround for being unable to load deleted diffs in currently.
 145          *
 146          * @param int $id revision ID
 147          * @return mixed URL or false
 148          */
 149         function deletedLink( $id ) {
 150                 if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
 151                         $dbr = wfGetDB( DB_SLAVE );
 152                         $row = $dbr->selectRow('archive', '*',
 153                                 array( 'ar_rev_id' => $id ),
 154                                 __METHOD__ );
 155                         if ( $row ) {
 156                                 $rev = Revision::newFromArchiveRow( $row );
 157                                 $title = Title::makeTitleSafe( $row->ar_namespace, $row->ar_title );
 158                                 return SpecialPage::getTitleFor( 'Undelete' )->getFullURL( array(
 159                                         'target' => $title->getPrefixedText(),
 160                                         'timestamp' => $rev->getTimestamp()
 161                                 ));
 162                         }
 163                 }
 164                 return false;
 165         }
 166
 167         /**
 168          * Build a wikitext link toward a deleted revision, if viewable.
 169          *
 170          * @param int $id revision ID
 171          * @return string wikitext fragment
 172          */
 173         function deletedIdMarker( $id ) {
 174                 $link = $this->deletedLink( $id );
 175                 if ( $link ) {
 176                         return "[$link $id]";
 177                 } else {
 178                         return $id;
 179                 }
 180         }
 181
 182         private function showMissingRevision() {
 183                 $out = $this->getOutput();
 184
 185                 $missing = array();
 186                 if ( $this->mOldRev === null ) {
 187                         $missing[] = $this->deletedIdMarker( $this->mOldid );
 188                 }
 189                 if ( $this->mNewRev === null ) {
 190                         $missing[] = $this->deletedIdMarker( $this->mNewid );
 191                 }
 192
 193                 $out->setPageTitle( $this->msg( 'errorpagetitle' ) );
 194                 $out->addWikiMsg( 'difference-missing-revision',
 195                         $this->getLanguage()->listToText( $missing ), count( $missing ) );
 196         }
 197
 198         function showDiffPage( $diffOnly = false ) {
 199                 wfProfileIn( __METHOD__ );
 200
 201                 # Allow frames except in certain special cases
 202                 $out = $this->getOutput();
 203                 $out->allowClickjacking();
 204                 $out->setRobotPolicy( 'noindex,nofollow' );
 205
 206                 if ( !$this->loadRevisionData() ) {
 207                         $this->showMissingRevision();
 208                         wfProfileOut( __METHOD__ );
 209                         return;
 210                 }
 211
 212                 $user = $this->getUser();
 213                 $permErrors = $this->mNewPage->getUserPermissionsErrors( 'read', $user );
 214                 if ( $this->mOldPage ) { # mOldPage might not be set, see below.
 215                         $permErrors = wfMergeErrorArrays( $permErrors,
 216                                 $this->mOldPage->getUserPermissionsErrors( 'read', $user ) );
 217                 }
 218                 if ( count( $permErrors ) ) {
 219                         wfProfileOut( __METHOD__ );
 220                         throw new PermissionsError( 'read', $permErrors );
 221                 }
 222
 223                 # If external diffs are enabled both globally and for the user,
 224                 # we'll use the application/x-external-editor interface to call
 225                 # an external diff tool like kompare, kdiff3, etc.
 226                 if ( ExternalEdit::useExternalEngine( $this->getContext(), 'diff' ) ) {
 227                         $urls = array(
 228                                 'File' => array( 'Extension' => 'wiki', 'URL' =>
 229                                         # This should be mOldPage, but it may not be set, see below.
 230                                         $this->mNewPage->getCanonicalURL( array(
 231                                                 'action' => 'raw', 'oldid' => $this->mOldid ) )
 232                                 ),
 233                                 'File2' => array( 'Extension' => 'wiki', 'URL' =>
 234                                         $this->mNewPage->getCanonicalURL( array(
 235                                                 'action' => 'raw', 'oldid' => $this->mNewid ) )
 236                                 ),
 237                         );
 238
 239                         $externalEditor = new ExternalEdit( $this->getContext(), $urls );
 240                         $externalEditor->execute();
 241
 242                         wfProfileOut( __METHOD__ );
 243                         return;
 244                 }
 245
 246                 $rollback = '';
 247                 $undoLink = '';
 248
 249                 $query = array();
 250                 # Carry over 'diffonly' param via navigation links
 251                 if ( $diffOnly != $user->getBoolOption( 'diffonly' ) ) {
 252                         $query['diffonly'] = $diffOnly;
 253                 }
 254                 # Cascade unhide param in links for easy deletion browsing
 255                 if ( $this->unhide ) {
 256                         $query['unhide'] = 1;
 257                 }
 258
 259                 # Check if one of the revisions is deleted/suppressed
 260                 $deleted = $suppressed = false;
 261                 $allowed = $this->mNewRev->userCan( Revision::DELETED_TEXT, $user );
 262
 263                 # mOldRev is false if the difference engine is called with a "vague" query for
 264                 # a diff between a version V and its previous version V' AND the version V
 265                 # is the first version of that article. In that case, V' does not exist.
 266                 if ( $this->mOldRev === false ) {
 267                         $out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage->getPrefixedText() ) );
 268                         $samePage = true;
 269                         $oldHeader = '';
 270                 } else {
 271                         wfRunHooks( 'DiffViewHeader', array( $this, $this->mOldRev, $this->mNewRev ) );
 272
 273                         $sk = $this->getSkin();
 274                         if ( method_exists( $sk, 'suppressQuickbar' ) ) {
 275                                 $sk->suppressQuickbar();
 276                         }
 277
 278                         if ( $this->mNewPage->equals( $this->mOldPage ) ) {
 279                                 $out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage->getPrefixedText() ) );
 280                                 $samePage = true;
 281                         } else {
 282                                 $out->setPageTitle( $this->msg( 'difference-title-multipage', $this->mOldPage->getPrefixedText(),
 283                                         $this->mNewPage->getPrefixedText() ) );
 284                                 $out->addSubtitle( $this->msg( 'difference-multipage' ) );
 285                                 $samePage = false;
 286                         }
 287
 288                         if ( $samePage && $this->mNewPage->quickUserCan( 'edit', $user ) ) {
 289                                 if ( $this->mNewRev->isCurrent() && $this->mNewPage->userCan( 'rollback', $user ) ) {
 290                                         $out->preventClickjacking();
 291                                         $rollback = '&#160;&#160;&#160;' . Linker::generateRollback( $this->mNewRev, $this->getContext() );
 292                                 }
 293                                 if ( !$this->mOldRev->isDeleted( Revision::DELETED_TEXT ) && !$this->mNewRev->isDeleted( Revision::DELETED_TEXT ) ) {
 294                                         $undoLink = ' ' . $this->msg( 'parentheses' )->rawParams(
 295                                                 Html::element( 'a', array(
 296                                                         'href' => $this->mNewPage->getLocalUrl( array(
 297                                                                 'action' => 'edit',
 298                                                                 'undoafter' => $this->mOldid,
 299                                                                 'undo' => $this->mNewid ) ),
 300                                                         'title' => Linker::titleAttrib( 'undo' )
 301                                                 ),
 302                                                 $this->msg( 'editundo' )->text()
 303                                         ) )->escaped();
 304                                 }
 305                         }
 306
 307                         # Make "previous revision link"
 308                         if ( $samePage && $this->mOldRev->getPrevious() ) {
 309                                 $prevlink = Linker::linkKnown(
 310                                         $this->mOldPage,
 311                                         $this->msg( 'previousdiff' )->escaped(),
 312                                         array( 'id' => 'differences-prevlink' ),
 313                                         array( 'diff' => 'prev', 'oldid' => $this->mOldid ) + $query
 314                                 );
 315                         } else {
 316                                 $prevlink = '&#160;';
 317                         }
 318
 319                         if ( $this->mOldRev->isMinor() ) {
 320                                 $oldminor = ChangesList::flag( 'minor' );
 321                         } else {
 322                                 $oldminor = '';
 323                         }
 324
 325                         $ldel = $this->revisionDeleteLink( $this->mOldRev );
 326                         $oldRevisionHeader = $this->getRevisionHeader( $this->mOldRev, 'complete' );
 327
 328                         $oldHeader = '<div id="mw-diff-otitle1"><strong>' . $oldRevisionHeader . '</strong></div>' .
 329                                 '<div id="mw-diff-otitle2">' .
 330                                         Linker::revUserTools( $this->mOldRev, !$this->unhide ) . '</div>' .
 331                                 '<div id="mw-diff-otitle3">' . $oldminor .
 332                                         Linker::revComment( $this->mOldRev, !$diffOnly, !$this->unhide ) . $ldel . '</div>' .
 333                                 '<div id="mw-diff-otitle4">' . $prevlink . '</div>';
 334
 335                         if ( $this->mOldRev->isDeleted( Revision::DELETED_TEXT ) ) {
 336                                 $deleted = true; // old revisions text is hidden
 337                                 if ( $this->mOldRev->isDeleted( Revision::DELETED_RESTRICTED ) ) {
 338                                         $suppressed = true; // also suppressed
 339                                 }
 340                         }
 341
 342                         # Check if this user can see the revisions
 343                         if ( !$this->mOldRev->userCan( Revision::DELETED_TEXT, $user ) ) {
 344                                 $allowed = false;
 345                         }
 346                 }
 347
 348                 # Make "next revision link"
 349                 # Skip next link on the top revision
 350                 if ( $samePage && !$this->mNewRev->isCurrent() ) {
 351                         $nextlink = Linker::linkKnown(
 352                                 $this->mNewPage,
 353                                 $this->msg( 'nextdiff' )->escaped(),
 354                                 array( 'id' => 'differences-nextlink' ),
 355                                 array( 'diff' => 'next', 'oldid' => $this->mNewid ) + $query
 356                         );
 357                 } else {
 358                         $nextlink = '&#160;';
 359                 }
 360
 361                 if ( $this->mNewRev->isMinor() ) {
 362                         $newminor = ChangesList::flag( 'minor' );
 363                 } else {
 364                         $newminor = '';
 365                 }
 366
 367                 # Handle RevisionDelete links...
 368                 $rdel = $this->revisionDeleteLink( $this->mNewRev );
 369                 $newRevisionHeader = $this->getRevisionHeader( $this->mNewRev, 'complete' ) . $undoLink;
 370
 371                 $newHeader = '<div id="mw-diff-ntitle1"><strong>' . $newRevisionHeader . '</strong></div>' .
 372                         '<div id="mw-diff-ntitle2">' . Linker::revUserTools( $this->mNewRev, !$this->unhide ) .
 373                                 " $rollback</div>" .
 374                         '<div id="mw-diff-ntitle3">' . $newminor .
 375                                 Linker::revComment( $this->mNewRev, !$diffOnly, !$this->unhide ) . $rdel . '</div>' .
 376                         '<div id="mw-diff-ntitle4">' . $nextlink . $this->markPatrolledLink() . '</div>';
 377
 378                 if ( $this->mNewRev->isDeleted( Revision::DELETED_TEXT ) ) {
 379                         $deleted = true; // new revisions text is hidden
 380                         if ( $this->mNewRev->isDeleted( Revision::DELETED_RESTRICTED ) )
 381                                 $suppressed = true; // also suppressed
 382                 }
 383
 384                 # If the diff cannot be shown due to a deleted revision, then output
 385                 # the diff header and links to unhide (if available)...
 386                 if ( $deleted && ( !$this->unhide || !$allowed ) ) {
 387                         $this->showDiffStyle();
 388                         $multi = $this->getMultiNotice();
 389                         $out->addHTML( $this->addHeader( '', $oldHeader, $newHeader, $multi ) );
 390                         if ( !$allowed ) {
 391                                 $msg = $suppressed ? 'rev-suppressed-no-diff' : 'rev-deleted-no-diff';
 392                                 # Give explanation for why revision is not visible
 393                                 $out->wrapWikiMsg( "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
 394                                         array( $msg ) );
 395                         } else {
 396                                 # Give explanation and add a link to view the diff...
 397                                 $link = $this->getTitle()->getFullUrl( $this->getRequest()->appendQueryValue( 'unhide', '1', true ) );
 398                                 $msg = $suppressed ? 'rev-suppressed-unhide-diff' : 'rev-deleted-unhide-diff';
 399                                 $out->wrapWikiMsg( "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n", array( $msg, $link ) );
 400                         }
 401                 # Otherwise, output a regular diff...
 402                 } else {
 403                         # Add deletion notice if the user is viewing deleted content
 404                         $notice = '';
 405                         if ( $deleted ) {
 406                                 $msg = $suppressed ? 'rev-suppressed-diff-view' : 'rev-deleted-diff-view';
 407                                 $notice = "<div id='mw-$msg' class='mw-warning plainlinks'>\n" . $this->msg( $msg )->parse() . "</div>\n";
 408                         }
 409                         $this->showDiff( $oldHeader, $newHeader, $notice );
 410                         if ( !$diffOnly ) {
 411                                 $this->renderNewRevision();
 412                         }
 413                 }
 414                 wfProfileOut( __METHOD__ );
 415         }
 416
 417         /**
 418          * Get a link to mark the change as patrolled, or '' if there's either no
 419          * revision to patrol or the user is not allowed to to it.
 420          * Side effect: this method will call OutputPage::preventClickjacking()
 421          * when a link is builded.
 422          *
 423          * @return String
 424          */
 425         protected function markPatrolledLink() {
 426                 global $wgUseRCPatrol;
 427
 428                 if ( $this->mMarkPatrolledLink === null ) {
 429                         // Prepare a change patrol link, if applicable
 430                         if ( $wgUseRCPatrol && $this->mNewPage->quickUserCan( 'patrol', $this->getUser() ) ) {
 431                                 // If we've been given an explicit change identifier, use it; saves time
 432                                 if ( $this->mRcidMarkPatrolled ) {
 433                                         $rcid = $this->mRcidMarkPatrolled;
 434                                         $rc = RecentChange::newFromId( $rcid );
 435                                         // Already patrolled?
 436                                         $rcid = is_object( $rc ) && !$rc->getAttribute( 'rc_patrolled' ) ? $rcid : 0;
 437                                 } else {
 438                                         // Look for an unpatrolled change corresponding to this diff
 439                                         $db = wfGetDB( DB_SLAVE );
 440                                         $change = RecentChange::newFromConds(
 441                                                 array(
 442                                                 // Redundant user,timestamp condition so we can use the existing index
 443                                                         'rc_user_text'  => $this->mNewRev->getRawUserText(),
 444                                                         'rc_timestamp'  => $db->timestamp( $this->mNewRev->getTimestamp() ),
 445                                                         'rc_this_oldid' => $this->mNewid,
 446                                                         'rc_last_oldid' => $this->mOldid,
 447                                                         'rc_patrolled'  => 0
 448                                                 ),
 449                                                 __METHOD__
 450                                         );
 451                                         if ( $change instanceof RecentChange ) {
 452                                                 $rcid = $change->mAttribs['rc_id'];
 453                                                 $this->mRcidMarkPatrolled = $rcid;
 454                                         } else {
 455                                                 // None found
 456                                                 $rcid = 0;
 457                                         }
 458                                 }
 459                                 // Build the link
 460                                 if ( $rcid ) {
 461                                         $this->getOutput()->preventClickjacking();
 462                                         $token = $this->getUser()->getEditToken( $rcid );
 463                                         $this->mMarkPatrolledLink = ' <span class="patrollink">[' . Linker::linkKnown(
 464                                                 $this->mNewPage,
 465                                                 $this->msg( 'markaspatrolleddiff' )->escaped(),
 466                                                 array(),
 467                                                 array(
 468                                                         'action' => 'markpatrolled',
 469                                                         'rcid' => $rcid,
 470                                                         'token' => $token,
 471                                                 )
 472                                         ) . ']</span>';
 473                                 } else {
 474                                         $this->mMarkPatrolledLink = '';
 475                                 }
 476                         } else {
 477                                 $this->mMarkPatrolledLink = '';
 478                         }
 479                 }
 480
 481                 return $this->mMarkPatrolledLink;
 482         }
 483
 484         /**
 485          * @param $rev Revision
 486          * @return String
 487          */
 488         protected function revisionDeleteLink( $rev ) {
 489                 $link = Linker::getRevDeleteLink( $this->getUser(), $rev, $rev->getTitle() );
 490                 if ( $link !== '' ) {
 491                         $link = '&#160;&#160;&#160;' . $link . ' ';
 492                 }
 493                 return $link;
 494         }
 495
 496         /**
 497          * Show the new revision of the page.
 498          */
 499         function renderNewRevision() {
 500                 wfProfileIn( __METHOD__ );
 501                 $out = $this->getOutput();
 502                 $revHeader = $this->getRevisionHeader( $this->mNewRev );
 503                 # Add "current version as of X" title
 504                 $out->addHTML( "<hr class='diff-hr' />
 505                 <h2 class='diff-currentversion-title'>{$revHeader}</h2>\n" );
 506                 # Page content may be handled by a hooked call instead...
 507                 if ( wfRunHooks( 'ArticleContentOnDiff', array( $this, $out ) ) ) {
 508                         $this->loadNewText();
 509                         $out->setRevisionId( $this->mNewid );
 510                         $out->setRevisionTimestamp( $this->mNewRev->getTimestamp() );
 511                         $out->setArticleFlag( true );
 512
 513                         if ( $this->mNewPage->isCssJsSubpage() || $this->mNewPage->isCssOrJsPage() ) {
 514                                 // Stolen from Article::view --AG 2007-10-11
 515                                 // Give hooks a chance to customise the output
 516                                 // @TODO: standardize this crap into one function
 517                                 if ( wfRunHooks( 'ShowRawCssJs', array( $this->mNewtext, $this->mNewPage, $out ) ) ) {
 518                                         // Wrap the whole lot in a <pre> and don't parse
 519                                         $m = array();
 520                                         preg_match( '!\.(css|js)$!u', $this->mNewPage->getText(), $m );
 521                                         $out->addHTML( "<pre class=\"mw-code mw-{$m[1]}\" dir=\"ltr\">\n" );
 522                                         $out->addHTML( htmlspecialchars( $this->mNewtext ) );
 523                                         $out->addHTML( "\n</pre>\n" );
 524                                 }
 525                         } elseif ( !wfRunHooks( 'ArticleViewCustom', array( $this->mNewtext, $this->mNewPage, $out ) ) ) {
 526                                 // Handled by extension
 527                         } else {
 528                                 // Normal page
 529                                 if ( $this->getTitle()->equals( $this->mNewPage ) ) {
 530                                         // If the Title stored in the context is the same as the one
 531                                         // of the new revision, we can use its associated WikiPage
 532                                         // object.
 533                                         $wikiPage = $this->getWikiPage();
 534                                 } else {
 535                                         // Otherwise we need to create our own WikiPage object
 536                                         $wikiPage = WikiPage::factory( $this->mNewPage );
 537                                 }
 538
 539                                 $parserOptions = $wikiPage->makeParserOptions( $this->getContext() );
 540
 541                                 if ( !$this->mNewRev->isCurrent() ) {
 542                                         $parserOptions->setEditSection( false );
 543                                 }
 544
 545                                 $parserOutput = $wikiPage->getParserOutput( $parserOptions, $this->mNewid );
 546
 547                                 # WikiPage::getParserOutput() should not return false, but just in case
 548                                 if( $parserOutput ) {
 549                                         $out->addParserOutput( $parserOutput );
 550                                 }
 551                         }
 552                 }
 553                 # Add redundant patrol link on bottom...
 554                 $out->addHTML( $this->markPatrolledLink() );
 555
 556                 wfProfileOut( __METHOD__ );
 557         }
 558
 559         /**
 560          * Get the diff text, send it to the OutputPage object
 561          * Returns false if the diff could not be generated, otherwise returns true
 562          *
 563          * @return bool
 564          */
 565         function showDiff( $otitle, $ntitle, $notice = '' ) {
 566                 $diff = $this->getDiff( $otitle, $ntitle, $notice );
 567                 if ( $diff === false ) {
 568                         $this->showMissingRevision();
 569                         return false;
 570                 } else {
 571                         $this->showDiffStyle();
 572                         $this->getOutput()->addHTML( $diff );
 573                         return true;
 574                 }
 575         }
 576
 577         /**
 578          * Add style sheets and supporting JS for diff display.
 579          */
 580         function showDiffStyle() {
 581                 $this->getOutput()->addModuleStyles( 'mediawiki.action.history.diff' );
 582         }
 583
 584         /**
 585          * Get complete diff table, including header
 586          *
 587          * @param $otitle Title: old title
 588          * @param $ntitle Title: new title
 589          * @param $notice String: HTML between diff header and body
 590          * @return mixed
 591          */
 592         function getDiff( $otitle, $ntitle, $notice = '' ) {
 593                 $body = $this->getDiffBody();
 594                 if ( $body === false ) {
 595                         return false;
 596                 } else {
 597                         $multi = $this->getMultiNotice();
 598                         return $this->addHeader( $body, $otitle, $ntitle, $multi, $notice );
 599                 }
 600         }
 601
 602         /**
 603          * Get the diff table body, without header
 604          *
 605          * @return mixed (string/false)
 606          */
 607         public function getDiffBody() {
 608                 global $wgMemc;
 609                 wfProfileIn( __METHOD__ );
 610                 $this->mCacheHit = true;
 611                 // Check if the diff should be hidden from this user
 612                 if ( !$this->loadRevisionData() ) {
 613                         wfProfileOut( __METHOD__ );
 614                         return false;
 615                 } elseif ( $this->mOldRev && !$this->mOldRev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) {
 616                         wfProfileOut( __METHOD__ );
 617                         return false;
 618                 } elseif ( $this->mNewRev && !$this->mNewRev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) {
 619                         wfProfileOut( __METHOD__ );
 620                         return false;
 621                 }
 622                 // Short-circuit
 623                 // If mOldRev is false, it means that the
 624                 if ( $this->mOldRev === false || ( $this->mOldRev && $this->mNewRev
 625                         && $this->mOldRev->getID() == $this->mNewRev->getID() ) )
 626                 {
 627                         wfProfileOut( __METHOD__ );
 628                         return '';
 629                 }
 630                 // Cacheable?
 631                 $key = false;
 632                 if ( $this->mOldid && $this->mNewid ) {
 633                         $key = wfMemcKey( 'diff', 'version', MW_DIFF_VERSION,
 634                                 'oldid', $this->mOldid, 'newid', $this->mNewid );
 635                         // Try cache
 636                         if ( !$this->mRefreshCache ) {
 637                                 $difftext = $wgMemc->get( $key );
 638                                 if ( $difftext ) {
 639                                         wfIncrStats( 'diff_cache_hit' );
 640                                         $difftext = $this->localiseLineNumbers( $difftext );
 641                                         $difftext .= "\n<!-- diff cache key $key -->\n";
 642                                         wfProfileOut( __METHOD__ );
 643                                         return $difftext;
 644                                 }
 645                         } // don't try to load but save the result
 646                 }
 647                 $this->mCacheHit = false;
 648
 649                 // Loadtext is permission safe, this just clears out the diff
 650                 if ( !$this->loadText() ) {
 651                         wfProfileOut( __METHOD__ );
 652                         return false;
 653                 }
 654
 655                 $difftext = $this->generateDiffBody( $this->mOldtext, $this->mNewtext );
 656
 657                 // Save to cache for 7 days
 658                 if ( !wfRunHooks( 'AbortDiffCache', array( &$this ) ) ) {
 659                         wfIncrStats( 'diff_uncacheable' );
 660                 } elseif ( $key !== false && $difftext !== false ) {
 661                         wfIncrStats( 'diff_cache_miss' );
 662                         $wgMemc->set( $key, $difftext, 7 * 86400 );
 663                 } else {
 664                         wfIncrStats( 'diff_uncacheable' );
 665                 }
 666                 // Replace line numbers with the text in the user's language
 667                 if ( $difftext !== false ) {
 668                         $difftext = $this->localiseLineNumbers( $difftext );
 669                 }
 670                 wfProfileOut( __METHOD__ );
 671                 return $difftext;
 672         }
 673
 674         /**
 675          * Make sure the proper modules are loaded before we try to
 676          * make the diff
 677          */
 678         private function initDiffEngines() {
 679                 global $wgExternalDiffEngine;
 680                 if ( $wgExternalDiffEngine == 'wikidiff' && !function_exists( 'wikidiff_do_diff' ) ) {
 681                         wfProfileIn( __METHOD__ . '-php_wikidiff.so' );
 682                         wfDl( 'php_wikidiff' );
 683                         wfProfileOut( __METHOD__ . '-php_wikidiff.so' );
 684                 }
 685                 elseif ( $wgExternalDiffEngine == 'wikidiff2' && !function_exists( 'wikidiff2_do_diff' ) ) {
 686                         wfProfileIn( __METHOD__ . '-php_wikidiff2.so' );
 687                         wfDl( 'wikidiff2' );
 688                         wfProfileOut( __METHOD__ . '-php_wikidiff2.so' );
 689                 }
 690         }
 691
 692         /**
 693          * Generate a diff, no caching
 694          *
 695          * @param $otext String: old text, must be already segmented
 696          * @param $ntext String: new text, must be already segmented
 697          * @return bool|string
 698          */
 699         function generateDiffBody( $otext, $ntext ) {
 700                 global $wgExternalDiffEngine, $wgContLang;
 701
 702                 wfProfileIn( __METHOD__ );
 703
 704                 $otext = str_replace( "\r\n", "\n", $otext );
 705                 $ntext = str_replace( "\r\n", "\n", $ntext );
 706
 707                 $this->initDiffEngines();
 708
 709                 if ( $wgExternalDiffEngine == 'wikidiff' && function_exists( 'wikidiff_do_diff' ) ) {
 710                         # For historical reasons, external diff engine expects
 711                         # input text to be HTML-escaped already
 712                         $otext = htmlspecialchars ( $wgContLang->segmentForDiff( $otext ) );
 713                         $ntext = htmlspecialchars ( $wgContLang->segmentForDiff( $ntext ) );
 714                         wfProfileOut( __METHOD__ );
 715                         return $wgContLang->unsegmentForDiff( wikidiff_do_diff( $otext, $ntext, 2 ) ) .
 716                         $this->debug( 'wikidiff1' );
 717                 }
 718
 719                 if ( $wgExternalDiffEngine == 'wikidiff2' && function_exists( 'wikidiff2_do_diff' ) ) {
 720                         # Better external diff engine, the 2 may some day be dropped
 721                         # This one does the escaping and segmenting itself
 722                         wfProfileIn( 'wikidiff2_do_diff' );
 723                         $text = wikidiff2_do_diff( $otext, $ntext, 2 );
 724                         $text .= $this->debug( 'wikidiff2' );
 725                         wfProfileOut( 'wikidiff2_do_diff' );
 726                         wfProfileOut( __METHOD__ );
 727                         return $text;
 728                 }
 729                 if ( $wgExternalDiffEngine != 'wikidiff3' && $wgExternalDiffEngine !== false ) {
 730                         # Diff via the shell
 731                         $tmpDir = wfTempDir();
 732                         $tempName1 = tempnam( $tmpDir, 'diff_' );
 733                         $tempName2 = tempnam( $tmpDir, 'diff_' );
 734
 735                         $tempFile1 = fopen( $tempName1, "w" );
 736                         if ( !$tempFile1 ) {
 737                                 wfProfileOut( __METHOD__ );
 738                                 return false;
 739                         }
 740                         $tempFile2 = fopen( $tempName2, "w" );
 741                         if ( !$tempFile2 ) {
 742                                 wfProfileOut( __METHOD__ );
 743                                 return false;
 744                         }
 745                         fwrite( $tempFile1, $otext );
 746                         fwrite( $tempFile2, $ntext );
 747                         fclose( $tempFile1 );
 748                         fclose( $tempFile2 );
 749                         $cmd = wfEscapeShellArg( $wgExternalDiffEngine, $tempName1, $tempName2 );
 750                         wfProfileIn( __METHOD__ . "-shellexec" );
 751                         $difftext = wfShellExec( $cmd );
 752                         $difftext .= $this->debug( "external $wgExternalDiffEngine" );
 753                         wfProfileOut( __METHOD__ . "-shellexec" );
 754                         unlink( $tempName1 );
 755                         unlink( $tempName2 );
 756                         wfProfileOut( __METHOD__ );
 757                         return $difftext;
 758                 }
 759
 760                 # Native PHP diff
 761                 $ota = explode( "\n", $wgContLang->segmentForDiff( $otext ) );
 762                 $nta = explode( "\n", $wgContLang->segmentForDiff( $ntext ) );
 763                 $diffs = new Diff( $ota, $nta );
 764                 $formatter = new TableDiffFormatter();
 765                 $difftext = $wgContLang->unsegmentForDiff( $formatter->format( $diffs ) ) .
 766                 wfProfileOut( __METHOD__ );
 767                 return $difftext;
 768         }
 769
 770         /**
 771          * Generate a debug comment indicating diff generating time,
 772          * server node, and generator backend.
 773          * @return string
 774          */
 775         protected function debug( $generator = "internal" ) {
 776                 global $wgShowHostnames;
 777                 if ( !$this->enableDebugComment ) {
 778                         return '';
 779                 }
 780                 $data = array( $generator );
 781                 if ( $wgShowHostnames ) {
 782                         $data[] = wfHostname();
 783                 }
 784                 $data[] = wfTimestamp( TS_DB );
 785                 return "<!-- diff generator: " .
 786                 implode( " ",
 787                 array_map(
 788                                         "htmlspecialchars",
 789                 $data ) ) .
 790                         " -->\n";
 791         }
 792
 793         /**
 794          * Replace line numbers with the text in the user's language
 795          * @return mixed
 796          */
 797         function localiseLineNumbers( $text ) {
 798                 return preg_replace_callback( '/<!--LINE (\d+)-->/',
 799                 array( &$this, 'localiseLineNumbersCb' ), $text );
 800         }
 801
 802         function localiseLineNumbersCb( $matches ) {
 803                 if ( $matches[1] === '1' && $this->mReducedLineNumbers ) return '';
 804                 return $this->msg( 'lineno' )->numParams( $matches[1] )->escaped();
 805         }
 806
 807
 808         /**
 809          * If there are revisions between the ones being compared, return a note saying so.
 810          * @return string
 811          */
 812         function getMultiNotice() {
 813                 if ( !is_object( $this->mOldRev ) || !is_object( $this->mNewRev ) ) {
 814                         return '';
 815                 } elseif ( !$this->mOldPage->equals( $this->mNewPage ) ) {
 816                         // Comparing two different pages? Count would be meaningless.
 817                         return '';
 818                 }
 819
 820                 if ( $this->mOldRev->getTimestamp() > $this->mNewRev->getTimestamp() ) {
 821                         $oldRev = $this->mNewRev; // flip
 822                         $newRev = $this->mOldRev; // flip
 823                 } else { // normal case
 824                         $oldRev = $this->mOldRev;
 825                         $newRev = $this->mNewRev;
 826                 }
 827
 828                 $nEdits = $this->mNewPage->countRevisionsBetween( $oldRev, $newRev );
 829                 if ( $nEdits > 0 ) {
 830                         $limit = 100; // use diff-multi-manyusers if too many users
 831                         $numUsers = $this->mNewPage->countAuthorsBetween( $oldRev, $newRev, $limit );
 832                         return self::intermediateEditsMsg( $nEdits, $numUsers, $limit );
 833                 }
 834                 return ''; // nothing
 835         }
 836
 837         /**
 838          * Get a notice about how many intermediate edits and users there are
 839          * @param $numEdits int
 840          * @param $numUsers int
 841          * @param $limit int
 842          * @return string
 843          */
 844         public static function intermediateEditsMsg( $numEdits, $numUsers, $limit ) {
 845                 if ( $numUsers > $limit ) {
 846                         $msg = 'diff-multi-manyusers';
 847                         $numUsers = $limit;
 848                 } else {
 849                         $msg = 'diff-multi';
 850                 }
 851                 return wfMessage( $msg )->numParams( $numEdits, $numUsers )->parse();
 852         }
 853
 854         /**
 855          * Get a header for a specified revision.
 856          *
 857          * @param $rev Revision
 858          * @param $complete String: 'complete' to get the header wrapped depending
 859          *        the visibility of the revision and a link to edit the page.
 860          * @return String HTML fragment
 861          */
 862         private function getRevisionHeader( Revision $rev, $complete = '' ) {
 863                 $lang = $this->getLanguage();
 864                 $user = $this->getUser();
 865                 $revtimestamp = $rev->getTimestamp();
 866                 $timestamp = $lang->userTimeAndDate( $revtimestamp, $user );
 867                 $dateofrev = $lang->userDate( $revtimestamp, $user );
 868                 $timeofrev = $lang->userTime( $revtimestamp, $user );
 869
 870                 $header = $this->msg(
 871                         $rev->isCurrent() ? 'currentrev-asof' : 'revisionasof',
 872                         $timestamp,
 873                         $dateofrev,
 874                         $timeofrev
 875                 )->escaped();
 876
 877                 if ( $complete !== 'complete' ) {
 878                         return $header;
 879                 }
 880
 881                 $title = $rev->getTitle();
 882
 883                 $header = Linker::linkKnown( $title, $header, array(),
 884                         array( 'oldid' => $rev->getID() ) );
 885
 886                 if ( $rev->userCan( Revision::DELETED_TEXT, $user ) ) {
 887                         $editQuery = array( 'action' => 'edit' );
 888                         if ( !$rev->isCurrent() ) {
 889                                 $editQuery['oldid'] = $rev->getID();
 890                         }
 891
 892                         $msg = $this->msg( $title->quickUserCan( 'edit', $user ) ? 'editold' : 'viewsourceold' )->escaped();
 893                         $header .= ' ' . $this->msg( 'parentheses' )->rawParams(
 894                                 Linker::linkKnown( $title, $msg, array(), $editQuery ) )->plain();
 895                         if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
 896                                 $header = Html::rawElement( 'span', array( 'class' => 'history-deleted' ), $header );
 897                         }
 898                 } else {
 899                         $header = Html::rawElement( 'span', array( 'class' => 'history-deleted' ), $header );
 900                 }
 901
 902                 return $header;
 903         }
 904
 905         /**
 906          * Add the header to a diff body
 907          *
 908          * @return string
 909          */
 910         function addHeader( $diff, $otitle, $ntitle, $multi = '', $notice = '' ) {
 911                 // shared.css sets diff in interface language/dir, but the actual content
 912                 // is often in a different language, mostly the page content language/dir
 913                 $tableClass = 'diff diff-contentalign-' . htmlspecialchars( $this->getDiffLang()->alignStart() );
 914                 $header = "<table class='$tableClass'>";
 915
 916                 if ( !$diff && !$otitle ) {
 917                         $header .= "
 918                         <tr style='vertical-align: top;'>
 919                         <td class='diff-ntitle'>{$ntitle}</td>
 920                         </tr>";
 921                         $multiColspan = 1;
 922                 } else {
 923                         if ( $diff ) { // Safari/Chrome show broken output if cols not used
 924                                 $header .= "
 925                                 <col class='diff-marker' />
 926                                 <col class='diff-content' />
 927                                 <col class='diff-marker' />
 928                                 <col class='diff-content' />";
 929                                 $colspan = 2;
 930                                 $multiColspan = 4;
 931                         } else {
 932                                 $colspan = 1;
 933                                 $multiColspan = 2;
 934                         }
 935                         $header .= "
 936                         <tr style='vertical-align: top;'>
 937                         <td colspan='$colspan' class='diff-otitle'>{$otitle}</td>
 938                         <td colspan='$colspan' class='diff-ntitle'>{$ntitle}</td>
 939                         </tr>";
 940                 }
 941
 942                 if ( $multi != '' ) {
 943                         $header .= "<tr><td colspan='{$multiColspan}' style='text-align: center;' class='diff-multi'>{$multi}</td></tr>";
 944                 }
 945                 if ( $notice != '' ) {
 946                         $header .= "<tr><td colspan='{$multiColspan}' style='text-align: center;'>{$notice}</td></tr>";
 947                 }
 948
 949                 return $header . $diff . "</table>";
 950         }
 951
 952         /**
 953          * Use specified text instead of loading from the database
 954          */
 955         function setText( $oldText, $newText ) {
 956                 $this->mOldtext = $oldText;
 957                 $this->mNewtext = $newText;
 958                 $this->mTextLoaded = 2;
 959                 $this->mRevisionsLoaded = true;
 960         }
 961
 962         /**
 963          * Set the language in which the diff text is written
 964          * (Defaults to page content language).
 965          * @since 1.19
 966          */
 967         function setTextLanguage( $lang ) {
 968                 $this->mDiffLang = wfGetLangObj( $lang );
 969         }
 970
 971         /**
 972          * Load revision IDs
 973          */
 974         private function loadRevisionIds() {
 975                 if ( $this->mRevisionsIdsLoaded ) {
 976                         return;
 977                 }
 978
 979                 $this->mRevisionsIdsLoaded = true;
 980
 981                 $old = $this->mOldid;
 982                 $new = $this->mNewid;
 983
 984                 if ( $new === 'prev' ) {
 985                         # Show diff between revision $old and the previous one.
 986                         # Get previous one from DB.
 987                         $this->mNewid = intval( $old );
 988                         $this->mOldid = $this->getTitle()->getPreviousRevisionID( $this->mNewid );
 989                 } elseif ( $new === 'next' ) {
 990                         # Show diff between revision $old and the next one.
 991                         # Get next one from DB.
 992                         $this->mOldid = intval( $old );
 993                         $this->mNewid = $this->getTitle()->getNextRevisionID( $this->mOldid );
 994                         if ( $this->mNewid === false ) {
 995                                 # if no result, NewId points to the newest old revision. The only newer
 996                                 # revision is cur, which is "0".
 997                                 $this->mNewid = 0;
 998                         }
 999                 } else {
1000                         $this->mOldid = intval( $old );
1001                         $this->mNewid = intval( $new );
1002                         wfRunHooks( 'NewDifferenceEngine', array( $this->getTitle(), &$this->mOldid, &$this->mNewid, $old, $new ) );
1003                 }
1004         }
1005
1006         /**
1007          * Load revision metadata for the specified articles. If newid is 0, then compare
1008          * the old article in oldid to the current article; if oldid is 0, then
1009          * compare the current article to the immediately previous one (ignoring the
1010          * value of newid).
1011          *
1012          * If oldid is false, leave the corresponding revision object set
1013          * to false. This is impossible via ordinary user input, and is provided for
1014          * API convenience.
1015          *
1016          * @return bool
1017          */
1018         function loadRevisionData() {
1019                 if ( $this->mRevisionsLoaded ) {
1020                         return true;
1021                 }
1022
1023                 // Whether it succeeds or fails, we don't want to try again
1024                 $this->mRevisionsLoaded = true;
1025
1026                 $this->loadRevisionIds();
1027
1028                 // Load the new revision object
1029                 $this->mNewRev = $this->mNewid
1030                         ? Revision::newFromId( $this->mNewid )
1031                         : Revision::newFromTitle( $this->getTitle(), false, Revision::READ_NORMAL );
1032
1033                 if ( !$this->mNewRev instanceof Revision ) {
1034                         return false;
1035                 }
1036
1037                 // Update the new revision ID in case it was 0 (makes life easier doing UI stuff)
1038                 $this->mNewid = $this->mNewRev->getId();
1039                 $this->mNewPage = $this->mNewRev->getTitle();
1040
1041                 // Load the old revision object
1042                 $this->mOldRev = false;
1043                 if ( $this->mOldid ) {
1044                         $this->mOldRev = Revision::newFromId( $this->mOldid );
1045                 } elseif ( $this->mOldid === 0 ) {
1046                         $rev = $this->mNewRev->getPrevious();
1047                         if ( $rev ) {
1048                                 $this->mOldid = $rev->getId();
1049                                 $this->mOldRev = $rev;
1050                         } else {
1051                                 // No previous revision; mark to show as first-version only.
1052                                 $this->mOldid = false;
1053                                 $this->mOldRev = false;
1054                         }
1055                 } /* elseif ( $this->mOldid === false ) leave mOldRev false; */
1056
1057                 if ( is_null( $this->mOldRev ) ) {
1058                         return false;
1059                 }
1060
1061                 if ( $this->mOldRev ) {
1062                         $this->mOldPage = $this->mOldRev->getTitle();
1063                 }
1064
1065                 return true;
1066         }
1067
1068         /**
1069          * Load the text of the revisions, as well as revision data.
1070          *
1071          * @return bool
1072          */
1073         function loadText() {
1074                 if ( $this->mTextLoaded == 2 ) {
1075                         return true;
1076                 } else {
1077                         // Whether it succeeds or fails, we don't want to try again
1078                         $this->mTextLoaded = 2;
1079                 }
1080
1081                 if ( !$this->loadRevisionData() ) {
1082                         return false;
1083                 }
1084                 if ( $this->mOldRev ) {
1085                         $this->mOldtext = $this->mOldRev->getText( Revision::FOR_THIS_USER );
1086                         if ( $this->mOldtext === false ) {
1087                                 return false;
1088                         }
1089                 }
1090                 if ( $this->mNewRev ) {
1091                         $this->mNewtext = $this->mNewRev->getText( Revision::FOR_THIS_USER );
1092                         if ( $this->mNewtext === false ) {
1093                                 return false;
1094                         }
1095                 }
1096                 return true;
1097         }
1098
1099         /**
1100          * Load the text of the new revision, not the old one
1101          *
1102          * @return bool
1103          */
1104         function loadNewText() {
1105                 if ( $this->mTextLoaded >= 1 ) {
1106                         return true;
1107                 } else {
1108                         $this->mTextLoaded = 1;
1109                 }
1110                 if ( !$this->loadRevisionData() ) {
1111                         return false;
1112                 }
1113                 $this->mNewtext = $this->mNewRev->getText( Revision::FOR_THIS_USER );
1114                 return true;
1115         }
1116 }