3 * User interface for the difference engine.
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.
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.
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
21 * @ingroup DifferenceEngine
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
30 define( 'MW_DIFF_VERSION', '1.11a' );
34 * @ingroup DifferenceEngine
36 class DifferenceEngine
extends ContextSource
{
44 var $mOldContent, $mNewContent;
50 var $mOldPage, $mNewPage;
55 var $mOldRev, $mNewRev;
56 private $mRevisionsIdsLoaded = false; // Have the revisions IDs been loaded
57 var $mRevisionsLoaded = false; // Have the revisions been loaded
58 var $mTextLoaded = 0; // How many text blobs have been loaded, 0, 1 or 2?
59 var $mCacheHit = false; // Was the diff fetched from cache?
62 * Set this to true to add debug info to the HTML output.
63 * Warning: this may cause RSS readers to spuriously mark articles as "new"
66 var $enableDebugComment = false;
68 // If true, line X is not displayed when X is 1, for example to increase
69 // readability and conserve space with many small diffs.
70 protected $mReducedLineNumbers = false;
72 // Link to action=markpatrolled
73 protected $mMarkPatrolledLink = null;
75 protected $unhide = false; # show rev_deleted content if allowed
80 * @param $context IContextSource context to use, anything else will be ignored
81 * @param $old Integer old ID we want to show and diff with.
82 * @param $new String either 'prev' or 'next'.
83 * @param $rcid Integer Deprecated, no longer used!
84 * @param $refreshCache boolean If set, refreshes the diff cache
85 * @param $unhide boolean If set, allow viewing deleted revs
87 function __construct( $context = null, $old = 0, $new = 0, $rcid = 0,
88 $refreshCache = false, $unhide = false )
90 if ( $context instanceof IContextSource
) {
91 $this->setContext( $context );
94 wfDebug( "DifferenceEngine old '$old' new '$new' rcid '$rcid'\n" );
98 $this->mRefreshCache
= $refreshCache;
99 $this->unhide
= $unhide;
105 function setReducedLineNumbers( $value = true ) {
106 $this->mReducedLineNumbers
= $value;
112 function getDiffLang() {
113 if ( $this->mDiffLang
=== null ) {
114 # Default language in which the diff text is written.
115 $this->mDiffLang
= $this->getTitle()->getPageLanguage();
117 return $this->mDiffLang
;
123 function wasCacheHit() {
124 return $this->mCacheHit
;
130 function getOldid() {
131 $this->loadRevisionIds();
132 return $this->mOldid
;
138 function getNewid() {
139 $this->loadRevisionIds();
140 return $this->mNewid
;
144 * Look up a special:Undelete link to the given deleted revision id,
145 * as a workaround for being unable to load deleted diffs in currently.
147 * @param int $id revision ID
148 * @return mixed URL or false
150 function deletedLink( $id ) {
151 if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
152 $dbr = wfGetDB( DB_SLAVE
);
153 $row = $dbr->selectRow( 'archive', '*',
154 array( 'ar_rev_id' => $id ),
157 $rev = Revision
::newFromArchiveRow( $row );
158 $title = Title
::makeTitleSafe( $row->ar_namespace
, $row->ar_title
);
159 return SpecialPage
::getTitleFor( 'Undelete' )->getFullURL( array(
160 'target' => $title->getPrefixedText(),
161 'timestamp' => $rev->getTimestamp()
169 * Build a wikitext link toward a deleted revision, if viewable.
171 * @param int $id revision ID
172 * @return string wikitext fragment
174 function deletedIdMarker( $id ) {
175 $link = $this->deletedLink( $id );
177 return "[$link $id]";
183 private function showMissingRevision() {
184 $out = $this->getOutput();
187 if ( $this->mOldRev
=== null ) {
188 $missing[] = $this->deletedIdMarker( $this->mOldid
);
190 if ( $this->mNewRev
=== null ) {
191 $missing[] = $this->deletedIdMarker( $this->mNewid
);
194 $out->setPageTitle( $this->msg( 'errorpagetitle' ) );
195 $out->addWikiMsg( 'difference-missing-revision',
196 $this->getLanguage()->listToText( $missing ), count( $missing ) );
199 function showDiffPage( $diffOnly = false ) {
200 wfProfileIn( __METHOD__
);
202 # Allow frames except in certain special cases
203 $out = $this->getOutput();
204 $out->allowClickjacking();
205 $out->setRobotPolicy( 'noindex,nofollow' );
207 if ( !$this->loadRevisionData() ) {
208 $this->showMissingRevision();
209 wfProfileOut( __METHOD__
);
213 $user = $this->getUser();
214 $permErrors = $this->mNewPage
->getUserPermissionsErrors( 'read', $user );
215 if ( $this->mOldPage
) { # mOldPage might not be set, see below.
216 $permErrors = wfMergeErrorArrays( $permErrors,
217 $this->mOldPage
->getUserPermissionsErrors( 'read', $user ) );
219 if ( count( $permErrors ) ) {
220 wfProfileOut( __METHOD__
);
221 throw new PermissionsError( 'read', $permErrors );
228 # Carry over 'diffonly' param via navigation links
229 if ( $diffOnly != $user->getBoolOption( 'diffonly' ) ) {
230 $query['diffonly'] = $diffOnly;
232 # Cascade unhide param in links for easy deletion browsing
233 if ( $this->unhide
) {
234 $query['unhide'] = 1;
237 # Check if one of the revisions is deleted/suppressed
238 $deleted = $suppressed = false;
239 $allowed = $this->mNewRev
->userCan( Revision
::DELETED_TEXT
, $user );
241 $revisionTools = array();
243 # mOldRev is false if the difference engine is called with a "vague" query for
244 # a diff between a version V and its previous version V' AND the version V
245 # is the first version of that article. In that case, V' does not exist.
246 if ( $this->mOldRev
=== false ) {
247 $out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage
->getPrefixedText() ) );
251 wfRunHooks( 'DiffViewHeader', array( $this, $this->mOldRev
, $this->mNewRev
) );
253 if ( $this->mNewPage
->equals( $this->mOldPage
) ) {
254 $out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage
->getPrefixedText() ) );
257 $out->setPageTitle( $this->msg( 'difference-title-multipage', $this->mOldPage
->getPrefixedText(),
258 $this->mNewPage
->getPrefixedText() ) );
259 $out->addSubtitle( $this->msg( 'difference-multipage' ) );
263 if ( $samePage && $this->mNewPage
->quickUserCan( 'edit', $user ) ) {
264 if ( $this->mNewRev
->isCurrent() && $this->mNewPage
->userCan( 'rollback', $user ) ) {
265 $rollbackLink = Linker
::generateRollback( $this->mNewRev
, $this->getContext() );
266 if ( $rollbackLink ) {
267 $out->preventClickjacking();
268 $rollback = '   ' . $rollbackLink;
271 if ( !$this->mOldRev
->isDeleted( Revision
::DELETED_TEXT
) && !$this->mNewRev
->isDeleted( Revision
::DELETED_TEXT
) ) {
272 $undoLink = Html
::element( 'a', array(
273 'href' => $this->mNewPage
->getLocalURL( array(
275 'undoafter' => $this->mOldid
,
276 'undo' => $this->mNewid
) ),
277 'title' => Linker
::titleAttrib( 'undo' )
279 $this->msg( 'editundo' )->text()
281 $revisionTools[] = $undoLink;
285 # Make "previous revision link"
286 if ( $samePage && $this->mOldRev
->getPrevious() ) {
287 $prevlink = Linker
::linkKnown(
289 $this->msg( 'previousdiff' )->escaped(),
290 array( 'id' => 'differences-prevlink' ),
291 array( 'diff' => 'prev', 'oldid' => $this->mOldid
) +
$query
294 $prevlink = ' ';
297 if ( $this->mOldRev
->isMinor() ) {
298 $oldminor = ChangesList
::flag( 'minor' );
303 $ldel = $this->revisionDeleteLink( $this->mOldRev
);
304 $oldRevisionHeader = $this->getRevisionHeader( $this->mOldRev
, 'complete' );
306 $oldHeader = '<div id="mw-diff-otitle1"><strong>' . $oldRevisionHeader . '</strong></div>' .
307 '<div id="mw-diff-otitle2">' .
308 Linker
::revUserTools( $this->mOldRev
, !$this->unhide
) . '</div>' .
309 '<div id="mw-diff-otitle3">' . $oldminor .
310 Linker
::revComment( $this->mOldRev
, !$diffOnly, !$this->unhide
) . $ldel . '</div>' .
311 '<div id="mw-diff-otitle4">' . $prevlink . '</div>';
313 if ( $this->mOldRev
->isDeleted( Revision
::DELETED_TEXT
) ) {
314 $deleted = true; // old revisions text is hidden
315 if ( $this->mOldRev
->isDeleted( Revision
::DELETED_RESTRICTED
) ) {
316 $suppressed = true; // also suppressed
320 # Check if this user can see the revisions
321 if ( !$this->mOldRev
->userCan( Revision
::DELETED_TEXT
, $user ) ) {
326 # Make "next revision link"
327 # Skip next link on the top revision
328 if ( $samePage && !$this->mNewRev
->isCurrent() ) {
329 $nextlink = Linker
::linkKnown(
331 $this->msg( 'nextdiff' )->escaped(),
332 array( 'id' => 'differences-nextlink' ),
333 array( 'diff' => 'next', 'oldid' => $this->mNewid
) +
$query
336 $nextlink = ' ';
339 if ( $this->mNewRev
->isMinor() ) {
340 $newminor = ChangesList
::flag( 'minor' );
345 # Handle RevisionDelete links...
346 $rdel = $this->revisionDeleteLink( $this->mNewRev
);
348 # Allow extensions to define their own revision tools
349 wfRunHooks( 'DiffRevisionTools', array( $this->mNewRev
, &$revisionTools ) );
350 $formattedRevisionTools = array();
351 // Put each one in parentheses (poor man's button)
352 foreach ( $revisionTools as $tool ) {
353 $formattedRevisionTools[] = $this->msg( 'parentheses' )->rawParams( $tool )->escaped();
355 $newRevisionHeader = $this->getRevisionHeader( $this->mNewRev
, 'complete' ) . ' ' . implode( ' ', $formattedRevisionTools );
357 $newHeader = '<div id="mw-diff-ntitle1"><strong>' . $newRevisionHeader . '</strong></div>' .
358 '<div id="mw-diff-ntitle2">' . Linker
::revUserTools( $this->mNewRev
, !$this->unhide
) .
360 '<div id="mw-diff-ntitle3">' . $newminor .
361 Linker
::revComment( $this->mNewRev
, !$diffOnly, !$this->unhide
) . $rdel . '</div>' .
362 '<div id="mw-diff-ntitle4">' . $nextlink . $this->markPatrolledLink() . '</div>';
364 if ( $this->mNewRev
->isDeleted( Revision
::DELETED_TEXT
) ) {
365 $deleted = true; // new revisions text is hidden
366 if ( $this->mNewRev
->isDeleted( Revision
::DELETED_RESTRICTED
) ) {
367 $suppressed = true; // also suppressed
371 # If the diff cannot be shown due to a deleted revision, then output
372 # the diff header and links to unhide (if available)...
373 if ( $deleted && ( !$this->unhide ||
!$allowed ) ) {
374 $this->showDiffStyle();
375 $multi = $this->getMultiNotice();
376 $out->addHTML( $this->addHeader( '', $oldHeader, $newHeader, $multi ) );
378 $msg = $suppressed ?
'rev-suppressed-no-diff' : 'rev-deleted-no-diff';
379 # Give explanation for why revision is not visible
380 $out->wrapWikiMsg( "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
383 # Give explanation and add a link to view the diff...
384 $link = $this->getTitle()->getFullURL( $this->getRequest()->appendQueryValue( 'unhide', '1', true ) );
385 $msg = $suppressed ?
'rev-suppressed-unhide-diff' : 'rev-deleted-unhide-diff';
386 $out->wrapWikiMsg( "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n", array( $msg, $link ) );
388 # Otherwise, output a regular diff...
390 # Add deletion notice if the user is viewing deleted content
393 $msg = $suppressed ?
'rev-suppressed-diff-view' : 'rev-deleted-diff-view';
394 $notice = "<div id='mw-$msg' class='mw-warning plainlinks'>\n" . $this->msg( $msg )->parse() . "</div>\n";
396 $this->showDiff( $oldHeader, $newHeader, $notice );
398 $this->renderNewRevision();
401 wfProfileOut( __METHOD__
);
405 * Get a link to mark the change as patrolled, or '' if there's either no
406 * revision to patrol or the user is not allowed to to it.
407 * Side effect: When the patrol link is build, this method will call
408 * OutputPage::preventClickjacking() and load mediawiki.page.patrol.ajax.
412 protected function markPatrolledLink() {
413 global $wgUseRCPatrol, $wgRCMaxAge, $wgEnableAPI, $wgEnableWriteAPI;
414 $cache = wfGetMainCache();
416 if ( $this->mMarkPatrolledLink
=== null ) {
417 // Prepare a change patrol link, if applicable
419 // Is patrolling enabled and the user allowed to?
420 $wgUseRCPatrol && $this->mNewPage
->quickUserCan( 'patrol', $this->getUser() ) &&
421 // Only do this if the revision isn't more than 6 hours older
422 // than the Max RC age (6h because the RC might not be cleaned out regularly)
423 RecentChange
::isInRCLifespan( $this->mNewRev
->getTimestamp(), 21600 ) &&
424 // Maybe the result is cached
425 !$cache->get( wfMemcKey( 'NotPatrollableRevId', $this->mNewid
) )
427 // Look for an unpatrolled change corresponding to this diff
429 $db = wfGetDB( DB_SLAVE
);
430 $change = RecentChange
::newFromConds(
432 'rc_timestamp' => $db->timestamp( $this->mNewRev
->getTimestamp() ),
433 'rc_this_oldid' => $this->mNewid
,
434 'rc_last_oldid' => $this->mOldid
,
438 array( 'USE INDEX' => 'rc_timestamp' )
442 $rcid = $change->getAttribute( 'rc_id' );
449 $this->getOutput()->preventClickjacking();
450 if ( $wgEnableAPI && $wgEnableWriteAPI
451 && $this->getUser()->isAllowed( 'writeapi' )
453 $this->getOutput()->addModules( 'mediawiki.page.patrol.ajax' );
456 $token = $this->getUser()->getEditToken( $rcid );
457 $this->mMarkPatrolledLink
= ' <span class="patrollink">[' . Linker
::linkKnown(
459 $this->msg( 'markaspatrolleddiff' )->escaped(),
462 'action' => 'markpatrolled',
468 $cache->set( wfMemcKey( 'NotPatrollableRevId', $this->mNewid
), '1', $wgRCMaxAge );
469 $this->mMarkPatrolledLink
= '';
472 $this->mMarkPatrolledLink
= '';
476 return $this->mMarkPatrolledLink
;
480 * @param $rev Revision
483 protected function revisionDeleteLink( $rev ) {
484 $link = Linker
::getRevDeleteLink( $this->getUser(), $rev, $rev->getTitle() );
485 if ( $link !== '' ) {
486 $link = '   ' . $link . ' ';
492 * Show the new revision of the page.
494 function renderNewRevision() {
495 wfProfileIn( __METHOD__
);
496 $out = $this->getOutput();
497 $revHeader = $this->getRevisionHeader( $this->mNewRev
);
498 # Add "current version as of X" title
499 $out->addHTML( "<hr class='diff-hr' />
500 <h2 class='diff-currentversion-title'>{$revHeader}</h2>\n" );
501 # Page content may be handled by a hooked call instead...
502 if ( wfRunHooks( 'ArticleContentOnDiff', array( $this, $out ) ) ) {
503 $this->loadNewText();
504 $out->setRevisionId( $this->mNewid
);
505 $out->setRevisionTimestamp( $this->mNewRev
->getTimestamp() );
506 $out->setArticleFlag( true );
508 // NOTE: only needed for B/C: custom rendering of JS/CSS via hook
509 if ( $this->mNewPage
->isCssJsSubpage() ||
$this->mNewPage
->isCssOrJsPage() ) {
510 // Stolen from Article::view --AG 2007-10-11
511 // Give hooks a chance to customise the output
512 // @todo standardize this crap into one function
513 if ( ContentHandler
::runLegacyHooks( 'ShowRawCssJs', array( $this->mNewContent
, $this->mNewPage
, $out ) ) ) {
514 // NOTE: deprecated hook, B/C only
515 // use the content object's own rendering
516 $cnt = $this->mNewRev
->getContent();
517 $po = $cnt ?
$cnt->getParserOutput( $this->mNewRev
->getTitle(), $this->mNewRev
->getId() ) : null;
518 $txt = $po ?
$po->getText() : '';
519 $out->addHTML( $txt );
521 } elseif ( !wfRunHooks( 'ArticleContentViewCustom', array( $this->mNewContent
, $this->mNewPage
, $out ) ) ) {
522 // Handled by extension
523 } elseif ( !ContentHandler
::runLegacyHooks( 'ArticleViewCustom', array( $this->mNewContent
, $this->mNewPage
, $out ) ) ) {
524 // NOTE: deprecated hook, B/C only
525 // Handled by extension
528 if ( $this->getTitle()->equals( $this->mNewPage
) ) {
529 // If the Title stored in the context is the same as the one
530 // of the new revision, we can use its associated WikiPage
532 $wikiPage = $this->getWikiPage();
534 // Otherwise we need to create our own WikiPage object
535 $wikiPage = WikiPage
::factory( $this->mNewPage
);
538 $parserOutput = $this->getParserOutput( $wikiPage, $this->mNewRev
);
540 # Also try to load it as a redirect
541 $rt = $this->mNewContent ?
$this->mNewContent
->getRedirectTarget() : null;
544 $article = Article
::newFromTitle( $this->mNewPage
, $this->getContext() );
545 $out->addHTML( $article->viewRedirect( $rt ) );
547 # WikiPage::getParserOutput() should not return false, but just in case
548 if ( $parserOutput ) {
549 # Show categories etc.
550 $out->addParserOutputNoText( $parserOutput );
552 } elseif ( $parserOutput ) {
553 $out->addParserOutput( $parserOutput );
557 # Add redundant patrol link on bottom...
558 $out->addHTML( $this->markPatrolledLink() );
560 wfProfileOut( __METHOD__
);
563 protected function getParserOutput( WikiPage
$page, Revision
$rev ) {
564 $parserOptions = $page->makeParserOptions( $this->getContext() );
566 if ( !$rev->isCurrent() ||
!$rev->getTitle()->quickUserCan( "edit" ) ) {
567 $parserOptions->setEditSection( false );
570 $parserOutput = $page->getParserOutput( $parserOptions, $rev->getId() );
571 return $parserOutput;
575 * Get the diff text, send it to the OutputPage object
576 * Returns false if the diff could not be generated, otherwise returns true
580 function showDiff( $otitle, $ntitle, $notice = '' ) {
581 $diff = $this->getDiff( $otitle, $ntitle, $notice );
582 if ( $diff === false ) {
583 $this->showMissingRevision();
586 $this->showDiffStyle();
587 $this->getOutput()->addHTML( $diff );
593 * Add style sheets and supporting JS for diff display.
595 function showDiffStyle() {
596 $this->getOutput()->addModuleStyles( 'mediawiki.action.history.diff' );
600 * Get complete diff table, including header
602 * @param string|bool $otitle Header for old text or false
603 * @param string|bool $ntitle Header for new text or false
604 * @param string $notice HTML between diff header and body
607 function getDiff( $otitle, $ntitle, $notice = '' ) {
608 $body = $this->getDiffBody();
609 if ( $body === false ) {
612 $multi = $this->getMultiNotice();
613 return $this->addHeader( $body, $otitle, $ntitle, $multi, $notice );
618 * Get the diff table body, without header
620 * @return mixed (string/false)
622 public function getDiffBody() {
624 wfProfileIn( __METHOD__
);
625 $this->mCacheHit
= true;
626 // Check if the diff should be hidden from this user
627 if ( !$this->loadRevisionData() ) {
628 wfProfileOut( __METHOD__
);
630 } elseif ( $this->mOldRev
&& !$this->mOldRev
->userCan( Revision
::DELETED_TEXT
, $this->getUser() ) ) {
631 wfProfileOut( __METHOD__
);
633 } elseif ( $this->mNewRev
&& !$this->mNewRev
->userCan( Revision
::DELETED_TEXT
, $this->getUser() ) ) {
634 wfProfileOut( __METHOD__
);
638 // If mOldRev is false, it means that the
639 if ( $this->mOldRev
=== false ||
( $this->mOldRev
&& $this->mNewRev
640 && $this->mOldRev
->getID() == $this->mNewRev
->getID() ) )
642 wfProfileOut( __METHOD__
);
647 if ( $this->mOldid
&& $this->mNewid
) {
648 $key = wfMemcKey( 'diff', 'version', MW_DIFF_VERSION
,
649 'oldid', $this->mOldid
, 'newid', $this->mNewid
);
651 if ( !$this->mRefreshCache
) {
652 $difftext = $wgMemc->get( $key );
654 wfIncrStats( 'diff_cache_hit' );
655 $difftext = $this->localiseLineNumbers( $difftext );
656 $difftext .= "\n<!-- diff cache key $key -->\n";
657 wfProfileOut( __METHOD__
);
660 } // don't try to load but save the result
662 $this->mCacheHit
= false;
664 // Loadtext is permission safe, this just clears out the diff
665 if ( !$this->loadText() ) {
666 wfProfileOut( __METHOD__
);
670 $difftext = $this->generateContentDiffBody( $this->mOldContent
, $this->mNewContent
);
672 // Save to cache for 7 days
673 if ( !wfRunHooks( 'AbortDiffCache', array( &$this ) ) ) {
674 wfIncrStats( 'diff_uncacheable' );
675 } elseif ( $key !== false && $difftext !== false ) {
676 wfIncrStats( 'diff_cache_miss' );
677 $wgMemc->set( $key, $difftext, 7 * 86400 );
679 wfIncrStats( 'diff_uncacheable' );
681 // Replace line numbers with the text in the user's language
682 if ( $difftext !== false ) {
683 $difftext = $this->localiseLineNumbers( $difftext );
685 wfProfileOut( __METHOD__
);
690 * Make sure the proper modules are loaded before we try to
693 private function initDiffEngines() {
694 global $wgExternalDiffEngine;
695 if ( $wgExternalDiffEngine == 'wikidiff' && !function_exists( 'wikidiff_do_diff' ) ) {
696 wfProfileIn( __METHOD__
. '-php_wikidiff.so' );
697 wfDl( 'php_wikidiff' );
698 wfProfileOut( __METHOD__
. '-php_wikidiff.so' );
700 elseif ( $wgExternalDiffEngine == 'wikidiff2' && !function_exists( 'wikidiff2_do_diff' ) ) {
701 wfProfileIn( __METHOD__
. '-php_wikidiff2.so' );
703 wfProfileOut( __METHOD__
. '-php_wikidiff2.so' );
708 * Generate a diff, no caching.
710 * This implementation uses generateTextDiffBody() to generate a diff based on the default
711 * serialization of the given Content objects. This will fail if $old or $new are not
712 * instances of TextContent.
714 * Subclasses may override this to provide a different rendering for the diff,
715 * perhaps taking advantage of the content's native form. This is required for all content
716 * models that are not text based.
718 * @param $old Content: old content
719 * @param $new Content: new content
721 * @return bool|string
723 * @throws MWException if $old or $new are not instances of TextContent.
725 function generateContentDiffBody( Content
$old, Content
$new ) {
726 if ( !( $old instanceof TextContent
) ) {
727 throw new MWException( "Diff not implemented for " . get_class( $old ) . "; "
728 . "override generateContentDiffBody to fix this." );
731 if ( !( $new instanceof TextContent
) ) {
732 throw new MWException( "Diff not implemented for " . get_class( $new ) . "; "
733 . "override generateContentDiffBody to fix this." );
736 $otext = $old->serialize();
737 $ntext = $new->serialize();
739 return $this->generateTextDiffBody( $otext, $ntext );
743 * Generate a diff, no caching
745 * @param string $otext old text, must be already segmented
746 * @param string $ntext new text, must be already segmented
747 * @return bool|string
748 * @deprecated since 1.21, use generateContentDiffBody() instead!
750 function generateDiffBody( $otext, $ntext ) {
751 ContentHandler
::deprecated( __METHOD__
, "1.21" );
753 return $this->generateTextDiffBody( $otext, $ntext );
757 * Generate a diff, no caching
759 * @todo move this to TextDifferenceEngine, make DifferenceEngine abstract. At some point.
761 * @param string $otext old text, must be already segmented
762 * @param string $ntext new text, must be already segmented
763 * @return bool|string
765 function generateTextDiffBody( $otext, $ntext ) {
766 global $wgExternalDiffEngine, $wgContLang;
768 wfProfileIn( __METHOD__
);
770 $otext = str_replace( "\r\n", "\n", $otext );
771 $ntext = str_replace( "\r\n", "\n", $ntext );
773 $this->initDiffEngines();
775 if ( $wgExternalDiffEngine == 'wikidiff' && function_exists( 'wikidiff_do_diff' ) ) {
776 # For historical reasons, external diff engine expects
777 # input text to be HTML-escaped already
778 $otext = htmlspecialchars ( $wgContLang->segmentForDiff( $otext ) );
779 $ntext = htmlspecialchars ( $wgContLang->segmentForDiff( $ntext ) );
780 wfProfileOut( __METHOD__
);
781 return $wgContLang->unsegmentForDiff( wikidiff_do_diff( $otext, $ntext, 2 ) ) .
782 $this->debug( 'wikidiff1' );
785 if ( $wgExternalDiffEngine == 'wikidiff2' && function_exists( 'wikidiff2_do_diff' ) ) {
786 # Better external diff engine, the 2 may some day be dropped
787 # This one does the escaping and segmenting itself
788 wfProfileIn( 'wikidiff2_do_diff' );
789 $text = wikidiff2_do_diff( $otext, $ntext, 2 );
790 $text .= $this->debug( 'wikidiff2' );
791 wfProfileOut( 'wikidiff2_do_diff' );
792 wfProfileOut( __METHOD__
);
795 if ( $wgExternalDiffEngine != 'wikidiff3' && $wgExternalDiffEngine !== false ) {
797 $tmpDir = wfTempDir();
798 $tempName1 = tempnam( $tmpDir, 'diff_' );
799 $tempName2 = tempnam( $tmpDir, 'diff_' );
801 $tempFile1 = fopen( $tempName1, "w" );
803 wfProfileOut( __METHOD__
);
806 $tempFile2 = fopen( $tempName2, "w" );
808 wfProfileOut( __METHOD__
);
811 fwrite( $tempFile1, $otext );
812 fwrite( $tempFile2, $ntext );
813 fclose( $tempFile1 );
814 fclose( $tempFile2 );
815 $cmd = wfEscapeShellArg( $wgExternalDiffEngine, $tempName1, $tempName2 );
816 wfProfileIn( __METHOD__
. "-shellexec" );
817 $difftext = wfShellExec( $cmd );
818 $difftext .= $this->debug( "external $wgExternalDiffEngine" );
819 wfProfileOut( __METHOD__
. "-shellexec" );
820 unlink( $tempName1 );
821 unlink( $tempName2 );
822 wfProfileOut( __METHOD__
);
827 $ota = explode( "\n", $wgContLang->segmentForDiff( $otext ) );
828 $nta = explode( "\n", $wgContLang->segmentForDiff( $ntext ) );
829 $diffs = new Diff( $ota, $nta );
830 $formatter = new TableDiffFormatter();
831 $difftext = $wgContLang->unsegmentForDiff( $formatter->format( $diffs ) ) .
832 wfProfileOut( __METHOD__
);
837 * Generate a debug comment indicating diff generating time,
838 * server node, and generator backend.
841 protected function debug( $generator = "internal" ) {
842 global $wgShowHostnames;
843 if ( !$this->enableDebugComment
) {
846 $data = array( $generator );
847 if ( $wgShowHostnames ) {
848 $data[] = wfHostname();
850 $data[] = wfTimestamp( TS_DB
);
851 return "<!-- diff generator: " .
860 * Replace line numbers with the text in the user's language
863 function localiseLineNumbers( $text ) {
864 return preg_replace_callback( '/<!--LINE (\d+)-->/',
865 array( &$this, 'localiseLineNumbersCb' ), $text );
868 function localiseLineNumbersCb( $matches ) {
869 if ( $matches[1] === '1' && $this->mReducedLineNumbers
) {
872 return $this->msg( 'lineno' )->numParams( $matches[1] )->escaped();
876 * If there are revisions between the ones being compared, return a note saying so.
879 function getMultiNotice() {
880 if ( !is_object( $this->mOldRev
) ||
!is_object( $this->mNewRev
) ) {
882 } elseif ( !$this->mOldPage
->equals( $this->mNewPage
) ) {
883 // Comparing two different pages? Count would be meaningless.
887 if ( $this->mOldRev
->getTimestamp() > $this->mNewRev
->getTimestamp() ) {
888 $oldRev = $this->mNewRev
; // flip
889 $newRev = $this->mOldRev
; // flip
890 } else { // normal case
891 $oldRev = $this->mOldRev
;
892 $newRev = $this->mNewRev
;
895 $nEdits = $this->mNewPage
->countRevisionsBetween( $oldRev, $newRev );
897 $limit = 100; // use diff-multi-manyusers if too many users
898 $numUsers = $this->mNewPage
->countAuthorsBetween( $oldRev, $newRev, $limit );
899 return self
::intermediateEditsMsg( $nEdits, $numUsers, $limit );
901 return ''; // nothing
905 * Get a notice about how many intermediate edits and users there are
906 * @param $numEdits int
907 * @param $numUsers int
911 public static function intermediateEditsMsg( $numEdits, $numUsers, $limit ) {
912 if ( $numUsers > $limit ) {
913 $msg = 'diff-multi-manyusers';
918 return wfMessage( $msg )->numParams( $numEdits, $numUsers )->parse();
922 * Get a header for a specified revision.
924 * @param $rev Revision
925 * @param string $complete 'complete' to get the header wrapped depending
926 * the visibility of the revision and a link to edit the page.
927 * @return String HTML fragment
929 protected function getRevisionHeader( Revision
$rev, $complete = '' ) {
930 $lang = $this->getLanguage();
931 $user = $this->getUser();
932 $revtimestamp = $rev->getTimestamp();
933 $timestamp = $lang->userTimeAndDate( $revtimestamp, $user );
934 $dateofrev = $lang->userDate( $revtimestamp, $user );
935 $timeofrev = $lang->userTime( $revtimestamp, $user );
937 $header = $this->msg(
938 $rev->isCurrent() ?
'currentrev-asof' : 'revisionasof',
944 if ( $complete !== 'complete' ) {
948 $title = $rev->getTitle();
950 $header = Linker
::linkKnown( $title, $header, array(),
951 array( 'oldid' => $rev->getID() ) );
953 if ( $rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
954 $editQuery = array( 'action' => 'edit' );
955 if ( !$rev->isCurrent() ) {
956 $editQuery['oldid'] = $rev->getID();
959 $msg = $this->msg( $title->quickUserCan( 'edit', $user ) ?
'editold' : 'viewsourceold' )->escaped();
960 $header .= ' ' . $this->msg( 'parentheses' )->rawParams(
961 Linker
::linkKnown( $title, $msg, array(), $editQuery ) )->plain();
962 if ( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
963 $header = Html
::rawElement( 'span', array( 'class' => 'history-deleted' ), $header );
966 $header = Html
::rawElement( 'span', array( 'class' => 'history-deleted' ), $header );
973 * Add the header to a diff body
977 function addHeader( $diff, $otitle, $ntitle, $multi = '', $notice = '' ) {
978 // shared.css sets diff in interface language/dir, but the actual content
979 // is often in a different language, mostly the page content language/dir
980 $tableClass = 'diff diff-contentalign-' . htmlspecialchars( $this->getDiffLang()->alignStart() );
981 $header = "<table class='$tableClass'>";
983 if ( !$diff && !$otitle ) {
985 <tr style='vertical-align: top;'>
986 <td class='diff-ntitle'>{$ntitle}</td>
990 if ( $diff ) { // Safari/Chrome show broken output if cols not used
992 <col class='diff-marker' />
993 <col class='diff-content' />
994 <col class='diff-marker' />
995 <col class='diff-content' />";
1003 <tr style='vertical-align: top;'>
1004 <td colspan='$colspan' class='diff-otitle'>{$otitle}</td>
1005 <td colspan='$colspan' class='diff-ntitle'>{$ntitle}</td>
1009 if ( $multi != '' ) {
1010 $header .= "<tr><td colspan='{$multiColspan}' style='text-align: center;' class='diff-multi'>{$multi}</td></tr>";
1012 if ( $notice != '' ) {
1013 $header .= "<tr><td colspan='{$multiColspan}' style='text-align: center;'>{$notice}</td></tr>";
1016 return $header . $diff . "</table>";
1020 * Use specified text instead of loading from the database
1021 * @deprecated since 1.21, use setContent() instead.
1023 function setText( $oldText, $newText ) {
1024 ContentHandler
::deprecated( __METHOD__
, "1.21" );
1026 $oldContent = ContentHandler
::makeContent( $oldText, $this->getTitle() );
1027 $newContent = ContentHandler
::makeContent( $newText, $this->getTitle() );
1029 $this->setContent( $oldContent, $newContent );
1033 * Use specified text instead of loading from the database
1036 function setContent( Content
$oldContent, Content
$newContent ) {
1037 $this->mOldContent
= $oldContent;
1038 $this->mNewContent
= $newContent;
1040 $this->mTextLoaded
= 2;
1041 $this->mRevisionsLoaded
= true;
1045 * Set the language in which the diff text is written
1046 * (Defaults to page content language).
1049 function setTextLanguage( $lang ) {
1050 $this->mDiffLang
= wfGetLangObj( $lang );
1056 private function loadRevisionIds() {
1057 if ( $this->mRevisionsIdsLoaded
) {
1061 $this->mRevisionsIdsLoaded
= true;
1063 $old = $this->mOldid
;
1064 $new = $this->mNewid
;
1066 if ( $new === 'prev' ) {
1067 # Show diff between revision $old and the previous one.
1068 # Get previous one from DB.
1069 $this->mNewid
= intval( $old );
1070 $this->mOldid
= $this->getTitle()->getPreviousRevisionID( $this->mNewid
);
1071 } elseif ( $new === 'next' ) {
1072 # Show diff between revision $old and the next one.
1073 # Get next one from DB.
1074 $this->mOldid
= intval( $old );
1075 $this->mNewid
= $this->getTitle()->getNextRevisionID( $this->mOldid
);
1076 if ( $this->mNewid
=== false ) {
1077 # if no result, NewId points to the newest old revision. The only newer
1078 # revision is cur, which is "0".
1082 $this->mOldid
= intval( $old );
1083 $this->mNewid
= intval( $new );
1084 wfRunHooks( 'NewDifferenceEngine', array( $this->getTitle(), &$this->mOldid
, &$this->mNewid
, $old, $new ) );
1089 * Load revision metadata for the specified articles. If newid is 0, then compare
1090 * the old article in oldid to the current article; if oldid is 0, then
1091 * compare the current article to the immediately previous one (ignoring the
1094 * If oldid is false, leave the corresponding revision object set
1095 * to false. This is impossible via ordinary user input, and is provided for
1100 function loadRevisionData() {
1101 if ( $this->mRevisionsLoaded
) {
1105 // Whether it succeeds or fails, we don't want to try again
1106 $this->mRevisionsLoaded
= true;
1108 $this->loadRevisionIds();
1110 // Load the new revision object
1111 $this->mNewRev
= $this->mNewid
1112 ? Revision
::newFromId( $this->mNewid
)
1113 : Revision
::newFromTitle( $this->getTitle(), false, Revision
::READ_NORMAL
);
1115 if ( !$this->mNewRev
instanceof Revision
) {
1119 // Update the new revision ID in case it was 0 (makes life easier doing UI stuff)
1120 $this->mNewid
= $this->mNewRev
->getId();
1121 $this->mNewPage
= $this->mNewRev
->getTitle();
1123 // Load the old revision object
1124 $this->mOldRev
= false;
1125 if ( $this->mOldid
) {
1126 $this->mOldRev
= Revision
::newFromId( $this->mOldid
);
1127 } elseif ( $this->mOldid
=== 0 ) {
1128 $rev = $this->mNewRev
->getPrevious();
1130 $this->mOldid
= $rev->getId();
1131 $this->mOldRev
= $rev;
1133 // No previous revision; mark to show as first-version only.
1134 $this->mOldid
= false;
1135 $this->mOldRev
= false;
1137 } /* elseif ( $this->mOldid === false ) leave mOldRev false; */
1139 if ( is_null( $this->mOldRev
) ) {
1143 if ( $this->mOldRev
) {
1144 $this->mOldPage
= $this->mOldRev
->getTitle();
1151 * Load the text of the revisions, as well as revision data.
1155 function loadText() {
1156 if ( $this->mTextLoaded
== 2 ) {
1159 // Whether it succeeds or fails, we don't want to try again
1160 $this->mTextLoaded
= 2;
1163 if ( !$this->loadRevisionData() ) {
1166 if ( $this->mOldRev
) {
1167 $this->mOldContent
= $this->mOldRev
->getContent( Revision
::FOR_THIS_USER
, $this->getUser() );
1168 if ( $this->mOldContent
=== null ) {
1172 if ( $this->mNewRev
) {
1173 $this->mNewContent
= $this->mNewRev
->getContent( Revision
::FOR_THIS_USER
, $this->getUser() );
1174 if ( $this->mNewContent
=== null ) {
1182 * Load the text of the new revision, not the old one
1186 function loadNewText() {
1187 if ( $this->mTextLoaded
>= 1 ) {
1190 $this->mTextLoaded
= 1;
1192 if ( !$this->loadRevisionData() ) {
1195 $this->mNewContent
= $this->mNewRev
->getContent( Revision
::FOR_THIS_USER
, $this->getUser() );