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
{
68 /** @var bool Have the revisions IDs been loaded */
69 private $mRevisionsIdsLoaded = false;
71 /** @var bool Have the revisions been loaded */
72 public $mRevisionsLoaded = false;
74 /** @var int How many text blobs have been loaded, 0, 1 or 2? */
75 public $mTextLoaded = 0;
77 /** @var bool Was the diff fetched from cache? */
78 public $mCacheHit = false;
81 * Set this to true to add debug info to the HTML output.
82 * Warning: this may cause RSS readers to spuriously mark articles as "new"
85 public $enableDebugComment = false;
87 /** @var bool If true, line X is not displayed when X is 1, for example
88 * to increase readability and conserve space with many small diffs.
90 protected $mReducedLineNumbers = false;
92 /** @var string Link to action=markpatrolled */
93 protected $mMarkPatrolledLink = null;
95 /** @var bool Show rev_deleted content if allowed */
96 protected $unhide = false;
98 /** @var bool Refresh the diff cache */
99 protected $mRefreshCache = false;
105 * @param IContextSource $context Context to use, anything else will be ignored
106 * @param int $old Old ID we want to show and diff with.
107 * @param string|int $new Either revision ID or 'prev' or 'next'. Default: 0.
108 * @param int $rcid Deprecated, no longer used!
109 * @param bool $refreshCache If set, refreshes the diff cache
110 * @param bool $unhide If set, allow viewing deleted revs
112 public function __construct( $context = null, $old = 0, $new = 0, $rcid = 0,
113 $refreshCache = false, $unhide = false
115 if ( $context instanceof IContextSource
) {
116 $this->setContext( $context );
119 wfDebug( "DifferenceEngine old '$old' new '$new' rcid '$rcid'\n" );
121 $this->mOldid
= $old;
122 $this->mNewid
= $new;
123 $this->mRefreshCache
= $refreshCache;
124 $this->unhide
= $unhide;
130 public function setReducedLineNumbers( $value = true ) {
131 $this->mReducedLineNumbers
= $value;
137 public function getDiffLang() {
138 if ( $this->mDiffLang
=== null ) {
139 # Default language in which the diff text is written.
140 $this->mDiffLang
= $this->getTitle()->getPageLanguage();
143 return $this->mDiffLang
;
149 public function wasCacheHit() {
150 return $this->mCacheHit
;
156 public function getOldid() {
157 $this->loadRevisionIds();
159 return $this->mOldid
;
165 public function getNewid() {
166 $this->loadRevisionIds();
168 return $this->mNewid
;
172 * Look up a special:Undelete link to the given deleted revision id,
173 * as a workaround for being unable to load deleted diffs in currently.
175 * @param int $id Revision ID
177 * @return mixed URL or false
179 public function deletedLink( $id ) {
180 if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
181 $dbr = wfGetDB( DB_SLAVE
);
182 $row = $dbr->selectRow( 'archive', '*',
183 array( 'ar_rev_id' => $id ),
186 $rev = Revision
::newFromArchiveRow( $row );
187 $title = Title
::makeTitleSafe( $row->ar_namespace
, $row->ar_title
);
189 return SpecialPage
::getTitleFor( 'Undelete' )->getFullURL( array(
190 'target' => $title->getPrefixedText(),
191 'timestamp' => $rev->getTimestamp()
200 * Build a wikitext link toward a deleted revision, if viewable.
202 * @param int $id Revision ID
204 * @return string Wikitext fragment
206 public function deletedIdMarker( $id ) {
207 $link = $this->deletedLink( $id );
209 return "[$link $id]";
215 private function showMissingRevision() {
216 $out = $this->getOutput();
219 if ( $this->mOldRev
=== null ||
220 ( $this->mOldRev
&& $this->mOldContent
=== null )
222 $missing[] = $this->deletedIdMarker( $this->mOldid
);
224 if ( $this->mNewRev
=== null ||
225 ( $this->mNewRev
&& $this->mNewContent
=== null )
227 $missing[] = $this->deletedIdMarker( $this->mNewid
);
230 $out->setPageTitle( $this->msg( 'errorpagetitle' ) );
231 $msg = $this->msg( 'difference-missing-revision' )
232 ->params( $this->getLanguage()->listToText( $missing ) )
233 ->numParams( count( $missing ) )
235 $out->addHtml( $msg );
238 public function showDiffPage( $diffOnly = false ) {
240 # Allow frames except in certain special cases
241 $out = $this->getOutput();
242 $out->allowClickjacking();
243 $out->setRobotPolicy( 'noindex,nofollow' );
245 if ( !$this->loadRevisionData() ) {
246 $this->showMissingRevision();
251 $user = $this->getUser();
252 $permErrors = $this->mNewPage
->getUserPermissionsErrors( 'read', $user );
253 if ( $this->mOldPage
) { # mOldPage might not be set, see below.
254 $permErrors = wfMergeErrorArrays( $permErrors,
255 $this->mOldPage
->getUserPermissionsErrors( 'read', $user ) );
257 if ( count( $permErrors ) ) {
258 throw new PermissionsError( 'read', $permErrors );
264 # Carry over 'diffonly' param via navigation links
265 if ( $diffOnly != $user->getBoolOption( 'diffonly' ) ) {
266 $query['diffonly'] = $diffOnly;
268 # Cascade unhide param in links for easy deletion browsing
269 if ( $this->unhide
) {
270 $query['unhide'] = 1;
273 # Check if one of the revisions is deleted/suppressed
274 $deleted = $suppressed = false;
275 $allowed = $this->mNewRev
->userCan( Revision
::DELETED_TEXT
, $user );
277 $revisionTools = array();
279 # mOldRev is false if the difference engine is called with a "vague" query for
280 # a diff between a version V and its previous version V' AND the version V
281 # is the first version of that article. In that case, V' does not exist.
282 if ( $this->mOldRev
=== false ) {
283 $out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage
->getPrefixedText() ) );
287 Hooks
::run( 'DiffViewHeader', array( $this, $this->mOldRev
, $this->mNewRev
) );
289 if ( $this->mNewPage
->equals( $this->mOldPage
) ) {
290 $out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage
->getPrefixedText() ) );
293 $out->setPageTitle( $this->msg( 'difference-title-multipage',
294 $this->mOldPage
->getPrefixedText(), $this->mNewPage
->getPrefixedText() ) );
295 $out->addSubtitle( $this->msg( 'difference-multipage' ) );
299 if ( $samePage && $this->mNewPage
->quickUserCan( 'edit', $user ) ) {
300 if ( $this->mNewRev
->isCurrent() && $this->mNewPage
->userCan( 'rollback', $user ) ) {
301 $rollbackLink = Linker
::generateRollback( $this->mNewRev
, $this->getContext() );
302 if ( $rollbackLink ) {
303 $out->preventClickjacking();
304 $rollback = '   ' . $rollbackLink;
308 if ( !$this->mOldRev
->isDeleted( Revision
::DELETED_TEXT
) &&
309 !$this->mNewRev
->isDeleted( Revision
::DELETED_TEXT
)
311 $undoLink = Html
::element( 'a', array(
312 'href' => $this->mNewPage
->getLocalURL( array(
314 'undoafter' => $this->mOldid
,
315 'undo' => $this->mNewid
317 'title' => Linker
::titleAttrib( 'undo' ),
319 $this->msg( 'editundo' )->text()
321 $revisionTools['mw-diff-undo'] = $undoLink;
325 # Make "previous revision link"
326 if ( $samePage && $this->mOldRev
->getPrevious() ) {
327 $prevlink = Linker
::linkKnown(
329 $this->msg( 'previousdiff' )->escaped(),
330 array( 'id' => 'differences-prevlink' ),
331 array( 'diff' => 'prev', 'oldid' => $this->mOldid
) +
$query
334 $prevlink = ' ';
337 if ( $this->mOldRev
->isMinor() ) {
338 $oldminor = ChangesList
::flag( 'minor' );
343 $ldel = $this->revisionDeleteLink( $this->mOldRev
);
344 $oldRevisionHeader = $this->getRevisionHeader( $this->mOldRev
, 'complete' );
345 $oldChangeTags = ChangeTags
::formatSummaryRow( $this->mOldTags
, 'diff' );
347 $oldHeader = '<div id="mw-diff-otitle1"><strong>' . $oldRevisionHeader . '</strong></div>' .
348 '<div id="mw-diff-otitle2">' .
349 Linker
::revUserTools( $this->mOldRev
, !$this->unhide
) . '</div>' .
350 '<div id="mw-diff-otitle3">' . $oldminor .
351 Linker
::revComment( $this->mOldRev
, !$diffOnly, !$this->unhide
) . $ldel . '</div>' .
352 '<div id="mw-diff-otitle5">' . $oldChangeTags[0] . '</div>' .
353 '<div id="mw-diff-otitle4">' . $prevlink . '</div>';
355 if ( $this->mOldRev
->isDeleted( Revision
::DELETED_TEXT
) ) {
356 $deleted = true; // old revisions text is hidden
357 if ( $this->mOldRev
->isDeleted( Revision
::DELETED_RESTRICTED
) ) {
358 $suppressed = true; // also suppressed
362 # Check if this user can see the revisions
363 if ( !$this->mOldRev
->userCan( Revision
::DELETED_TEXT
, $user ) ) {
368 # Make "next revision link"
369 # Skip next link on the top revision
370 if ( $samePage && !$this->mNewRev
->isCurrent() ) {
371 $nextlink = Linker
::linkKnown(
373 $this->msg( 'nextdiff' )->escaped(),
374 array( 'id' => 'differences-nextlink' ),
375 array( 'diff' => 'next', 'oldid' => $this->mNewid
) +
$query
378 $nextlink = ' ';
381 if ( $this->mNewRev
->isMinor() ) {
382 $newminor = ChangesList
::flag( 'minor' );
387 # Handle RevisionDelete links...
388 $rdel = $this->revisionDeleteLink( $this->mNewRev
);
390 # Allow extensions to define their own revision tools
391 Hooks
::run( 'DiffRevisionTools', array( $this->mNewRev
, &$revisionTools, $this->mOldRev
) );
392 $formattedRevisionTools = array();
393 // Put each one in parentheses (poor man's button)
394 foreach ( $revisionTools as $key => $tool ) {
395 $toolClass = is_string( $key ) ?
$key : 'mw-diff-tool';
396 $element = Html
::rawElement(
398 array( 'class' => $toolClass ),
399 $this->msg( 'parentheses' )->rawParams( $tool )->escaped()
401 $formattedRevisionTools[] = $element;
403 $newRevisionHeader = $this->getRevisionHeader( $this->mNewRev
, 'complete' ) .
404 ' ' . implode( ' ', $formattedRevisionTools );
405 $newChangeTags = ChangeTags
::formatSummaryRow( $this->mNewTags
, 'diff' );
407 $newHeader = '<div id="mw-diff-ntitle1"><strong>' . $newRevisionHeader . '</strong></div>' .
408 '<div id="mw-diff-ntitle2">' . Linker
::revUserTools( $this->mNewRev
, !$this->unhide
) .
410 '<div id="mw-diff-ntitle3">' . $newminor .
411 Linker
::revComment( $this->mNewRev
, !$diffOnly, !$this->unhide
) . $rdel . '</div>' .
412 '<div id="mw-diff-ntitle5">' . $newChangeTags[0] . '</div>' .
413 '<div id="mw-diff-ntitle4">' . $nextlink . $this->markPatrolledLink() . '</div>';
415 if ( $this->mNewRev
->isDeleted( Revision
::DELETED_TEXT
) ) {
416 $deleted = true; // new revisions text is hidden
417 if ( $this->mNewRev
->isDeleted( Revision
::DELETED_RESTRICTED
) ) {
418 $suppressed = true; // also suppressed
422 # If the diff cannot be shown due to a deleted revision, then output
423 # the diff header and links to unhide (if available)...
424 if ( $deleted && ( !$this->unhide ||
!$allowed ) ) {
425 $this->showDiffStyle();
426 $multi = $this->getMultiNotice();
427 $out->addHTML( $this->addHeader( '', $oldHeader, $newHeader, $multi ) );
429 $msg = $suppressed ?
'rev-suppressed-no-diff' : 'rev-deleted-no-diff';
430 # Give explanation for why revision is not visible
431 $out->wrapWikiMsg( "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
434 # Give explanation and add a link to view the diff...
435 $query = $this->getRequest()->appendQueryValue( 'unhide', '1', true );
436 $link = $this->getTitle()->getFullURL( $query );
437 $msg = $suppressed ?
'rev-suppressed-unhide-diff' : 'rev-deleted-unhide-diff';
439 "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
443 # Otherwise, output a regular diff...
445 # Add deletion notice if the user is viewing deleted content
448 $msg = $suppressed ?
'rev-suppressed-diff-view' : 'rev-deleted-diff-view';
449 $notice = "<div id='mw-$msg' class='mw-warning plainlinks'>\n" .
450 $this->msg( $msg )->parse() .
453 $this->showDiff( $oldHeader, $newHeader, $notice );
455 $this->renderNewRevision();
461 * Get a link to mark the change as patrolled, or '' if there's either no
462 * revision to patrol or the user is not allowed to to it.
463 * Side effect: When the patrol link is build, this method will call
464 * OutputPage::preventClickjacking() and load mediawiki.page.patrol.ajax.
468 protected function markPatrolledLink() {
469 global $wgUseRCPatrol, $wgEnableAPI, $wgEnableWriteAPI;
470 $user = $this->getUser();
472 if ( $this->mMarkPatrolledLink
=== null ) {
473 // Prepare a change patrol link, if applicable
475 // Is patrolling enabled and the user allowed to?
476 $wgUseRCPatrol && $this->mNewPage
->quickUserCan( 'patrol', $user ) &&
477 // Only do this if the revision isn't more than 6 hours older
478 // than the Max RC age (6h because the RC might not be cleaned out regularly)
479 RecentChange
::isInRCLifespan( $this->mNewRev
->getTimestamp(), 21600 )
481 // Look for an unpatrolled change corresponding to this diff
483 $db = wfGetDB( DB_SLAVE
);
484 $change = RecentChange
::newFromConds(
486 'rc_timestamp' => $db->timestamp( $this->mNewRev
->getTimestamp() ),
487 'rc_this_oldid' => $this->mNewid
,
491 array( 'USE INDEX' => 'rc_timestamp' )
494 if ( $change && !$change->getPerformer()->equals( $user ) ) {
495 $rcid = $change->getAttribute( 'rc_id' );
497 // None found or the page has been created by the current user.
498 // If the user could patrol this it already would be patrolled
503 $this->getOutput()->preventClickjacking();
504 if ( $wgEnableAPI && $wgEnableWriteAPI
505 && $user->isAllowed( 'writeapi' )
507 $this->getOutput()->addModules( 'mediawiki.page.patrol.ajax' );
510 $token = $user->getEditToken( $rcid );
511 $this->mMarkPatrolledLink
= ' <span class="patrollink">[' . Linker
::linkKnown(
513 $this->msg( 'markaspatrolleddiff' )->escaped(),
516 'action' => 'markpatrolled',
522 $this->mMarkPatrolledLink
= '';
525 $this->mMarkPatrolledLink
= '';
529 return $this->mMarkPatrolledLink
;
533 * @param Revision $rev
537 protected function revisionDeleteLink( $rev ) {
538 $link = Linker
::getRevDeleteLink( $this->getUser(), $rev, $rev->getTitle() );
539 if ( $link !== '' ) {
540 $link = '   ' . $link . ' ';
547 * Show the new revision of the page.
549 public function renderNewRevision() {
550 $out = $this->getOutput();
551 $revHeader = $this->getRevisionHeader( $this->mNewRev
);
552 # Add "current version as of X" title
553 $out->addHTML( "<hr class='diff-hr' id='mw-oldid' />
554 <h2 class='diff-currentversion-title'>{$revHeader}</h2>\n" );
555 # Page content may be handled by a hooked call instead...
556 # @codingStandardsIgnoreStart Ignoring long lines.
557 if ( Hooks
::run( 'ArticleContentOnDiff', array( $this, $out ) ) ) {
558 $this->loadNewText();
559 $out->setRevisionId( $this->mNewid
);
560 $out->setRevisionTimestamp( $this->mNewRev
->getTimestamp() );
561 $out->setArticleFlag( true );
563 // NOTE: only needed for B/C: custom rendering of JS/CSS via hook
564 if ( $this->mNewPage
->isCssJsSubpage() ||
$this->mNewPage
->isCssOrJsPage() ) {
565 // This needs to be synchronised with Article::showCssOrJsPage(), which sucks
566 // Give hooks a chance to customise the output
567 // @todo standardize this crap into one function
568 if ( ContentHandler
::runLegacyHooks( 'ShowRawCssJs', array( $this->mNewContent
, $this->mNewPage
, $out ) ) ) {
569 // NOTE: deprecated hook, B/C only
570 // use the content object's own rendering
571 $cnt = $this->mNewRev
->getContent();
572 $po = $cnt ?
$cnt->getParserOutput( $this->mNewRev
->getTitle(), $this->mNewRev
->getId() ) : null;
574 $out->addParserOutputContent( $po );
577 } elseif ( !Hooks
::run( 'ArticleContentViewCustom', array( $this->mNewContent
, $this->mNewPage
, $out ) ) ) {
578 // Handled by extension
579 } elseif ( !ContentHandler
::runLegacyHooks( 'ArticleViewCustom', array( $this->mNewContent
, $this->mNewPage
, $out ) ) ) {
580 // NOTE: deprecated hook, B/C only
581 // Handled by extension
584 if ( $this->getTitle()->equals( $this->mNewPage
) ) {
585 // If the Title stored in the context is the same as the one
586 // of the new revision, we can use its associated WikiPage
588 $wikiPage = $this->getWikiPage();
590 // Otherwise we need to create our own WikiPage object
591 $wikiPage = WikiPage
::factory( $this->mNewPage
);
594 $parserOutput = $this->getParserOutput( $wikiPage, $this->mNewRev
);
596 # WikiPage::getParserOutput() should not return false, but just in case
597 if ( $parserOutput ) {
598 $out->addParserOutput( $parserOutput );
602 # @codingStandardsIgnoreEnd
604 # Add redundant patrol link on bottom...
605 $out->addHTML( $this->markPatrolledLink() );
609 protected function getParserOutput( WikiPage
$page, Revision
$rev ) {
610 $parserOptions = $page->makeParserOptions( $this->getContext() );
612 if ( !$rev->isCurrent() ||
!$rev->getTitle()->quickUserCan( 'edit', $this->getUser() ) ) {
613 $parserOptions->setEditSection( false );
616 $parserOutput = $page->getParserOutput( $parserOptions, $rev->getId() );
618 return $parserOutput;
622 * Get the diff text, send it to the OutputPage object
623 * Returns false if the diff could not be generated, otherwise returns true
625 * @param string|bool $otitle Header for old text or false
626 * @param string|bool $ntitle Header for new text or false
627 * @param string $notice HTML between diff header and body
631 public function showDiff( $otitle, $ntitle, $notice = '' ) {
632 $diff = $this->getDiff( $otitle, $ntitle, $notice );
633 if ( $diff === false ) {
634 $this->showMissingRevision();
638 $this->showDiffStyle();
639 $this->getOutput()->addHTML( $diff );
646 * Add style sheets and supporting JS for diff display.
648 public function showDiffStyle() {
649 $this->getOutput()->addModuleStyles( 'mediawiki.action.history.diff' );
653 * Get complete diff table, including header
655 * @param string|bool $otitle Header for old text or false
656 * @param string|bool $ntitle Header for new text or false
657 * @param string $notice HTML between diff header and body
661 public function getDiff( $otitle, $ntitle, $notice = '' ) {
662 $body = $this->getDiffBody();
663 if ( $body === false ) {
667 $multi = $this->getMultiNotice();
668 // Display a message when the diff is empty
669 if ( $body === '' ) {
670 $notice .= '<div class="mw-diff-empty">' .
671 $this->msg( 'diff-empty' )->parse() .
675 return $this->addHeader( $body, $otitle, $ntitle, $multi, $notice );
679 * Get the diff table body, without header
681 * @return mixed (string/false)
683 public function getDiffBody() {
685 $this->mCacheHit
= true;
686 // Check if the diff should be hidden from this user
687 if ( !$this->loadRevisionData() ) {
690 } elseif ( $this->mOldRev
&&
691 !$this->mOldRev
->userCan( Revision
::DELETED_TEXT
, $this->getUser() )
695 } elseif ( $this->mNewRev
&&
696 !$this->mNewRev
->userCan( Revision
::DELETED_TEXT
, $this->getUser() )
702 if ( $this->mOldRev
=== false ||
( $this->mOldRev
&& $this->mNewRev
703 && $this->mOldRev
->getID() == $this->mNewRev
->getID() )
710 if ( $this->mOldid
&& $this->mNewid
) {
711 $key = $this->getDiffBodyCacheKey();
714 if ( !$this->mRefreshCache
) {
715 $difftext = $wgMemc->get( $key );
717 wfIncrStats( 'diff_cache_hit' );
718 $difftext = $this->localiseLineNumbers( $difftext );
719 $difftext .= "\n<!-- diff cache key $key -->\n";
723 } // don't try to load but save the result
725 $this->mCacheHit
= false;
727 // Loadtext is permission safe, this just clears out the diff
728 if ( !$this->loadText() ) {
733 $difftext = $this->generateContentDiffBody( $this->mOldContent
, $this->mNewContent
);
735 // Save to cache for 7 days
736 if ( !Hooks
::run( 'AbortDiffCache', array( &$this ) ) ) {
737 wfIncrStats( 'diff_uncacheable' );
738 } elseif ( $key !== false && $difftext !== false ) {
739 wfIncrStats( 'diff_cache_miss' );
740 $wgMemc->set( $key, $difftext, 7 * 86400 );
742 wfIncrStats( 'diff_uncacheable' );
744 // Replace line numbers with the text in the user's language
745 if ( $difftext !== false ) {
746 $difftext = $this->localiseLineNumbers( $difftext );
753 * Returns the cache key for diff body text or content.
757 * @throws MWException
760 protected function getDiffBodyCacheKey() {
761 if ( !$this->mOldid ||
!$this->mNewid
) {
762 throw new MWException( 'mOldid and mNewid must be set to get diff cache key.' );
765 return wfMemcKey( 'diff', 'version', MW_DIFF_VERSION
,
766 'oldid', $this->mOldid
, 'newid', $this->mNewid
);
770 * Generate a diff, no caching.
772 * This implementation uses generateTextDiffBody() to generate a diff based on the default
773 * serialization of the given Content objects. This will fail if $old or $new are not
774 * instances of TextContent.
776 * Subclasses may override this to provide a different rendering for the diff,
777 * perhaps taking advantage of the content's native form. This is required for all content
778 * models that are not text based.
782 * @param Content $old Old content
783 * @param Content $new New content
785 * @throws MWException If old or new content is not an instance of TextContent.
786 * @return bool|string
788 public function generateContentDiffBody( Content
$old, Content
$new ) {
789 if ( !( $old instanceof TextContent
) ) {
790 throw new MWException( "Diff not implemented for " . get_class( $old ) . "; " .
791 "override generateContentDiffBody to fix this." );
794 if ( !( $new instanceof TextContent
) ) {
795 throw new MWException( "Diff not implemented for " . get_class( $new ) . "; "
796 . "override generateContentDiffBody to fix this." );
799 $otext = $old->serialize();
800 $ntext = $new->serialize();
802 return $this->generateTextDiffBody( $otext, $ntext );
806 * Generate a diff, no caching
808 * @param string $otext Old text, must be already segmented
809 * @param string $ntext New text, must be already segmented
811 * @return bool|string
812 * @deprecated since 1.21, use generateContentDiffBody() instead!
814 public function generateDiffBody( $otext, $ntext ) {
815 ContentHandler
::deprecated( __METHOD__
, "1.21" );
817 return $this->generateTextDiffBody( $otext, $ntext );
821 * Generate a diff, no caching
823 * @todo move this to TextDifferenceEngine, make DifferenceEngine abstract. At some point.
825 * @param string $otext Old text, must be already segmented
826 * @param string $ntext New text, must be already segmented
828 * @return bool|string
830 public function generateTextDiffBody( $otext, $ntext ) {
831 global $wgExternalDiffEngine, $wgContLang;
833 $otext = str_replace( "\r\n", "\n", $otext );
834 $ntext = str_replace( "\r\n", "\n", $ntext );
836 if ( $wgExternalDiffEngine == 'wikidiff' && function_exists( 'wikidiff_do_diff' ) ) {
837 # For historical reasons, external diff engine expects
838 # input text to be HTML-escaped already
839 $otext = htmlspecialchars( $wgContLang->segmentForDiff( $otext ) );
840 $ntext = htmlspecialchars( $wgContLang->segmentForDiff( $ntext ) );
842 return $wgContLang->unsegmentForDiff( wikidiff_do_diff( $otext, $ntext, 2 ) ) .
843 $this->debug( 'wikidiff1' );
846 if ( $wgExternalDiffEngine == 'wikidiff2' && function_exists( 'wikidiff2_do_diff' ) ) {
847 # Better external diff engine, the 2 may some day be dropped
848 # This one does the escaping and segmenting itself
849 $text = wikidiff2_do_diff( $otext, $ntext, 2 );
850 $text .= $this->debug( 'wikidiff2' );
854 if ( $wgExternalDiffEngine != 'wikidiff3' && $wgExternalDiffEngine !== false ) {
856 $tmpDir = wfTempDir();
857 $tempName1 = tempnam( $tmpDir, 'diff_' );
858 $tempName2 = tempnam( $tmpDir, 'diff_' );
860 $tempFile1 = fopen( $tempName1, "w" );
865 $tempFile2 = fopen( $tempName2, "w" );
870 fwrite( $tempFile1, $otext );
871 fwrite( $tempFile2, $ntext );
872 fclose( $tempFile1 );
873 fclose( $tempFile2 );
874 $cmd = wfEscapeShellArg( $wgExternalDiffEngine, $tempName1, $tempName2 );
875 $difftext = wfShellExec( $cmd );
876 $difftext .= $this->debug( "external $wgExternalDiffEngine" );
877 unlink( $tempName1 );
878 unlink( $tempName2 );
884 $ota = explode( "\n", $wgContLang->segmentForDiff( $otext ) );
885 $nta = explode( "\n", $wgContLang->segmentForDiff( $ntext ) );
886 $diffs = new Diff( $ota, $nta );
887 $formatter = new TableDiffFormatter();
888 $difftext = $wgContLang->unsegmentForDiff( $formatter->format( $diffs ) );
894 * Generate a debug comment indicating diff generating time,
895 * server node, and generator backend.
897 * @param string $generator : What diff engine was used
901 protected function debug( $generator = "internal" ) {
902 global $wgShowHostnames;
903 if ( !$this->enableDebugComment
) {
906 $data = array( $generator );
907 if ( $wgShowHostnames ) {
908 $data[] = wfHostname();
910 $data[] = wfTimestamp( TS_DB
);
912 return "<!-- diff generator: " .
913 implode( " ", array_map( "htmlspecialchars", $data ) ) .
918 * Replace line numbers with the text in the user's language
920 * @param string $text
924 public function localiseLineNumbers( $text ) {
925 return preg_replace_callback(
926 '/<!--LINE (\d+)-->/',
927 array( &$this, 'localiseLineNumbersCb' ),
932 public function localiseLineNumbersCb( $matches ) {
933 if ( $matches[1] === '1' && $this->mReducedLineNumbers
) {
937 return $this->msg( 'lineno' )->numParams( $matches[1] )->escaped();
941 * If there are revisions between the ones being compared, return a note saying so.
945 public function getMultiNotice() {
946 if ( !is_object( $this->mOldRev
) ||
!is_object( $this->mNewRev
) ) {
948 } elseif ( !$this->mOldPage
->equals( $this->mNewPage
) ) {
949 // Comparing two different pages? Count would be meaningless.
953 if ( $this->mOldRev
->getTimestamp() > $this->mNewRev
->getTimestamp() ) {
954 $oldRev = $this->mNewRev
; // flip
955 $newRev = $this->mOldRev
; // flip
956 } else { // normal case
957 $oldRev = $this->mOldRev
;
958 $newRev = $this->mNewRev
;
961 // Sanity: don't show the notice if too many rows must be scanned
962 // @todo show some special message for that case
963 $nEdits = $this->mNewPage
->countRevisionsBetween( $oldRev, $newRev, 1000 );
964 if ( $nEdits > 0 && $nEdits <= 1000 ) {
965 $limit = 100; // use diff-multi-manyusers if too many users
966 $users = $this->mNewPage
->getAuthorsBetween( $oldRev, $newRev, $limit );
967 $numUsers = count( $users );
969 if ( $numUsers == 1 && $users[0] == $newRev->getUserText( Revision
::RAW
) ) {
970 $numUsers = 0; // special case to say "by the same user" instead of "by one other user"
973 return self
::intermediateEditsMsg( $nEdits, $numUsers, $limit );
976 return ''; // nothing
980 * Get a notice about how many intermediate edits and users there are
982 * @param int $numEdits
983 * @param int $numUsers
988 public static function intermediateEditsMsg( $numEdits, $numUsers, $limit ) {
989 if ( $numUsers === 0 ) {
990 $msg = 'diff-multi-sameuser';
991 } elseif ( $numUsers > $limit ) {
992 $msg = 'diff-multi-manyusers';
995 $msg = 'diff-multi-otherusers';
998 return wfMessage( $msg )->numParams( $numEdits, $numUsers )->parse();
1002 * Get a header for a specified revision.
1004 * @param Revision $rev
1005 * @param string $complete 'complete' to get the header wrapped depending
1006 * the visibility of the revision and a link to edit the page.
1008 * @return string HTML fragment
1010 protected function getRevisionHeader( Revision
$rev, $complete = '' ) {
1011 $lang = $this->getLanguage();
1012 $user = $this->getUser();
1013 $revtimestamp = $rev->getTimestamp();
1014 $timestamp = $lang->userTimeAndDate( $revtimestamp, $user );
1015 $dateofrev = $lang->userDate( $revtimestamp, $user );
1016 $timeofrev = $lang->userTime( $revtimestamp, $user );
1018 $header = $this->msg(
1019 $rev->isCurrent() ?
'currentrev-asof' : 'revisionasof',
1025 if ( $complete !== 'complete' ) {
1029 $title = $rev->getTitle();
1031 $header = Linker
::linkKnown( $title, $header, array(),
1032 array( 'oldid' => $rev->getID() ) );
1034 if ( $rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
1035 $editQuery = array( 'action' => 'edit' );
1036 if ( !$rev->isCurrent() ) {
1037 $editQuery['oldid'] = $rev->getID();
1040 $key = $title->quickUserCan( 'edit', $user ) ?
'editold' : 'viewsourceold';
1041 $msg = $this->msg( $key )->escaped();
1042 $editLink = $this->msg( 'parentheses' )->rawParams(
1043 Linker
::linkKnown( $title, $msg, array( ), $editQuery ) )->escaped();
1044 $header .= ' ' . Html
::rawElement(
1046 array( 'class' => 'mw-diff-edit' ),
1049 if ( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
1050 $header = Html
::rawElement(
1052 array( 'class' => 'history-deleted' ),
1057 $header = Html
::rawElement( 'span', array( 'class' => 'history-deleted' ), $header );
1064 * Add the header to a diff body
1066 * @param string $diff Diff body
1067 * @param string $otitle Old revision header
1068 * @param string $ntitle New revision header
1069 * @param string $multi Notice telling user that there are intermediate
1070 * revisions between the ones being compared
1071 * @param string $notice Other notices, e.g. that user is viewing deleted content
1075 public function addHeader( $diff, $otitle, $ntitle, $multi = '', $notice = '' ) {
1076 // shared.css sets diff in interface language/dir, but the actual content
1077 // is often in a different language, mostly the page content language/dir
1078 $tableClass = 'diff diff-contentalign-' . htmlspecialchars( $this->getDiffLang()->alignStart() );
1079 $header = "<table class='$tableClass'>";
1081 if ( !$diff && !$otitle ) {
1083 <tr style='vertical-align: top;'>
1084 <td class='diff-ntitle'>{$ntitle}</td>
1088 if ( $diff ) { // Safari/Chrome show broken output if cols not used
1090 <col class='diff-marker' />
1091 <col class='diff-content' />
1092 <col class='diff-marker' />
1093 <col class='diff-content' />";
1100 if ( $otitle ||
$ntitle ) {
1102 <tr style='vertical-align: top;'>
1103 <td colspan='$colspan' class='diff-otitle'>{$otitle}</td>
1104 <td colspan='$colspan' class='diff-ntitle'>{$ntitle}</td>
1109 if ( $multi != '' ) {
1110 $header .= "<tr><td colspan='{$multiColspan}' style='text-align: center;' " .
1111 "class='diff-multi'>{$multi}</td></tr>";
1113 if ( $notice != '' ) {
1114 $header .= "<tr><td colspan='{$multiColspan}' style='text-align: center;'>{$notice}</td></tr>";
1117 return $header . $diff . "</table>";
1121 * Use specified text instead of loading from the database
1122 * @deprecated since 1.21, use setContent() instead.
1124 public function setText( $oldText, $newText ) {
1125 ContentHandler
::deprecated( __METHOD__
, "1.21" );
1127 $oldContent = ContentHandler
::makeContent( $oldText, $this->getTitle() );
1128 $newContent = ContentHandler
::makeContent( $newText, $this->getTitle() );
1130 $this->setContent( $oldContent, $newContent );
1134 * Use specified text instead of loading from the database
1135 * @param Content $oldContent
1136 * @param Content $newContent
1139 public function setContent( Content
$oldContent, Content
$newContent ) {
1140 $this->mOldContent
= $oldContent;
1141 $this->mNewContent
= $newContent;
1143 $this->mTextLoaded
= 2;
1144 $this->mRevisionsLoaded
= true;
1148 * Set the language in which the diff text is written
1149 * (Defaults to page content language).
1150 * @param Language|string $lang
1153 public function setTextLanguage( $lang ) {
1154 $this->mDiffLang
= wfGetLangObj( $lang );
1158 * Maps a revision pair definition as accepted by DifferenceEngine constructor
1159 * to a pair of actual integers representing revision ids.
1161 * @param int $old Revision id, e.g. from URL parameter 'oldid'
1162 * @param int|string $new Revision id or strings 'next' or 'prev', e.g. from URL parameter 'diff'
1164 * @return int[] List of two revision ids, older first, later second.
1165 * Zero signifies invalid argument passed.
1166 * false signifies that there is no previous/next revision ($old is the oldest/newest one).
1168 public function mapDiffPrevNext( $old, $new ) {
1169 if ( $new === 'prev' ) {
1170 // Show diff between revision $old and the previous one. Get previous one from DB.
1171 $newid = intval( $old );
1172 $oldid = $this->getTitle()->getPreviousRevisionID( $newid );
1173 } elseif ( $new === 'next' ) {
1174 // Show diff between revision $old and the next one. Get next one from DB.
1175 $oldid = intval( $old );
1176 $newid = $this->getTitle()->getNextRevisionID( $oldid );
1178 $oldid = intval( $old );
1179 $newid = intval( $new );
1182 return array( $oldid, $newid );
1188 private function loadRevisionIds() {
1189 if ( $this->mRevisionsIdsLoaded
) {
1193 $this->mRevisionsIdsLoaded
= true;
1195 $old = $this->mOldid
;
1196 $new = $this->mNewid
;
1198 list( $this->mOldid
, $this->mNewid
) = self
::mapDiffPrevNext( $old, $new );
1199 if ( $new === 'next' && $this->mNewid
=== false ) {
1200 # if no result, NewId points to the newest old revision. The only newer
1201 # revision is cur, which is "0".
1206 'NewDifferenceEngine',
1207 array( $this->getTitle(), &$this->mOldid
, &$this->mNewid
, $old, $new )
1212 * Load revision metadata for the specified articles. If newid is 0, then compare
1213 * the old article in oldid to the current article; if oldid is 0, then
1214 * compare the current article to the immediately previous one (ignoring the
1217 * If oldid is false, leave the corresponding revision object set
1218 * to false. This is impossible via ordinary user input, and is provided for
1223 public function loadRevisionData() {
1224 if ( $this->mRevisionsLoaded
) {
1228 // Whether it succeeds or fails, we don't want to try again
1229 $this->mRevisionsLoaded
= true;
1231 $this->loadRevisionIds();
1233 // Load the new revision object
1234 if ( $this->mNewid
) {
1235 $this->mNewRev
= Revision
::newFromId( $this->mNewid
);
1237 if ( !$this->mNewRev
&& wfGetLB()->getServerCount() > 1 ) {
1238 // Try harder… This is being hit after a rollback where we show the
1239 // diff immediately after the edit happened. T93866
1240 $this->mNewRev
= Revision
::newFromId( $this->mNewid
, Revision
::READ_LATEST
);
1243 $this->mNewRev
= Revision
::newFromTitle(
1246 Revision
::READ_NORMAL
1250 if ( !$this->mNewRev
instanceof Revision
) {
1254 // Update the new revision ID in case it was 0 (makes life easier doing UI stuff)
1255 $this->mNewid
= $this->mNewRev
->getId();
1256 $this->mNewPage
= $this->mNewRev
->getTitle();
1258 // Load the old revision object
1259 $this->mOldRev
= false;
1260 if ( $this->mOldid
) {
1261 $this->mOldRev
= Revision
::newFromId( $this->mOldid
);
1262 } elseif ( $this->mOldid
=== 0 ) {
1263 $rev = $this->mNewRev
->getPrevious();
1265 $this->mOldid
= $rev->getId();
1266 $this->mOldRev
= $rev;
1268 // No previous revision; mark to show as first-version only.
1269 $this->mOldid
= false;
1270 $this->mOldRev
= false;
1272 } /* elseif ( $this->mOldid === false ) leave mOldRev false; */
1274 if ( is_null( $this->mOldRev
) ) {
1278 if ( $this->mOldRev
) {
1279 $this->mOldPage
= $this->mOldRev
->getTitle();
1282 // Load tags information for both revisions
1283 $dbr = wfGetDB( DB_SLAVE
);
1284 if ( $this->mOldid
!== false ) {
1285 $this->mOldTags
= $dbr->selectField(
1288 array( 'ts_rev_id' => $this->mOldid
),
1292 $this->mOldTags
= false;
1294 $this->mNewTags
= $dbr->selectField(
1297 array( 'ts_rev_id' => $this->mNewid
),
1305 * Load the text of the revisions, as well as revision data.
1309 public function loadText() {
1310 if ( $this->mTextLoaded
== 2 ) {
1314 // Whether it succeeds or fails, we don't want to try again
1315 $this->mTextLoaded
= 2;
1317 if ( !$this->loadRevisionData() ) {
1321 if ( $this->mOldRev
) {
1322 $this->mOldContent
= $this->mOldRev
->getContent( Revision
::FOR_THIS_USER
, $this->getUser() );
1323 if ( $this->mOldContent
=== null ) {
1328 if ( $this->mNewRev
) {
1329 $this->mNewContent
= $this->mNewRev
->getContent( Revision
::FOR_THIS_USER
, $this->getUser() );
1330 if ( $this->mNewContent
=== null ) {
1339 * Load the text of the new revision, not the old one
1343 public function loadNewText() {
1344 if ( $this->mTextLoaded
>= 1 ) {
1348 $this->mTextLoaded
= 1;
1350 if ( !$this->loadRevisionData() ) {
1354 $this->mNewContent
= $this->mNewRev
->getContent( Revision
::FOR_THIS_USER
, $this->getUser() );