includes/diff/DifferenceEngine.php

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