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
23 use MediaWiki\MediaWikiServices
;
25 /** @deprecated use class constant instead */
26 define( 'MW_DIFF_VERSION', '1.11a' );
30 * @ingroup DifferenceEngine
32 class DifferenceEngine
extends ContextSource
{
34 * Constant to indicate diff cache compatibility.
35 * Bump this when changing the diff formatting in a way that
36 * fixes important bugs or such to force cached diff views to
39 const DIFF_VERSION
= MW_DIFF_VERSION
;
71 /** @var bool Have the revisions IDs been loaded */
72 private $mRevisionsIdsLoaded = false;
74 /** @var bool Have the revisions been loaded */
75 public $mRevisionsLoaded = false;
77 /** @var int How many text blobs have been loaded, 0, 1 or 2? */
78 public $mTextLoaded = 0;
80 /** @var bool Was the diff fetched from cache? */
81 public $mCacheHit = false;
84 * Set this to true to add debug info to the HTML output.
85 * Warning: this may cause RSS readers to spuriously mark articles as "new"
88 public $enableDebugComment = false;
90 /** @var bool If true, line X is not displayed when X is 1, for example
91 * to increase readability and conserve space with many small diffs.
93 protected $mReducedLineNumbers = false;
95 /** @var string Link to action=markpatrolled */
96 protected $mMarkPatrolledLink = null;
98 /** @var bool Show rev_deleted content if allowed */
99 protected $unhide = false;
101 /** @var bool Refresh the diff cache */
102 protected $mRefreshCache = false;
108 * @param IContextSource $context Context to use, anything else will be ignored
109 * @param int $old Old ID we want to show and diff with.
110 * @param string|int $new Either revision ID or 'prev' or 'next'. Default: 0.
111 * @param int $rcid Deprecated, no longer used!
112 * @param bool $refreshCache If set, refreshes the diff cache
113 * @param bool $unhide If set, allow viewing deleted revs
115 public function __construct( $context = null, $old = 0, $new = 0, $rcid = 0,
116 $refreshCache = false, $unhide = false
118 if ( $context instanceof IContextSource
) {
119 $this->setContext( $context );
122 wfDebug( "DifferenceEngine old '$old' new '$new' rcid '$rcid'\n" );
124 $this->mOldid
= $old;
125 $this->mNewid
= $new;
126 $this->mRefreshCache
= $refreshCache;
127 $this->unhide
= $unhide;
133 public function setReducedLineNumbers( $value = true ) {
134 $this->mReducedLineNumbers
= $value;
140 public function getDiffLang() {
141 if ( $this->mDiffLang
=== null ) {
142 # Default language in which the diff text is written.
143 $this->mDiffLang
= $this->getTitle()->getPageLanguage();
146 return $this->mDiffLang
;
152 public function wasCacheHit() {
153 return $this->mCacheHit
;
159 public function getOldid() {
160 $this->loadRevisionIds();
162 return $this->mOldid
;
168 public function getNewid() {
169 $this->loadRevisionIds();
171 return $this->mNewid
;
175 * Look up a special:Undelete link to the given deleted revision id,
176 * as a workaround for being unable to load deleted diffs in currently.
178 * @param int $id Revision ID
180 * @return string|bool Link HTML or false
182 public function deletedLink( $id ) {
183 if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
184 $dbr = wfGetDB( DB_REPLICA
);
185 $row = $dbr->selectRow( 'archive', '*',
186 [ 'ar_rev_id' => $id ],
189 $rev = Revision
::newFromArchiveRow( $row );
190 $title = Title
::makeTitleSafe( $row->ar_namespace
, $row->ar_title
);
192 return SpecialPage
::getTitleFor( 'Undelete' )->getFullURL( [
193 'target' => $title->getPrefixedText(),
194 'timestamp' => $rev->getTimestamp()
203 * Build a wikitext link toward a deleted revision, if viewable.
205 * @param int $id Revision ID
207 * @return string Wikitext fragment
209 public function deletedIdMarker( $id ) {
210 $link = $this->deletedLink( $id );
212 return "[$link $id]";
218 private function showMissingRevision() {
219 $out = $this->getOutput();
222 if ( $this->mOldRev
=== null ||
223 ( $this->mOldRev
&& $this->mOldContent
=== null )
225 $missing[] = $this->deletedIdMarker( $this->mOldid
);
227 if ( $this->mNewRev
=== null ||
228 ( $this->mNewRev
&& $this->mNewContent
=== null )
230 $missing[] = $this->deletedIdMarker( $this->mNewid
);
233 $out->setPageTitle( $this->msg( 'errorpagetitle' ) );
234 $msg = $this->msg( 'difference-missing-revision' )
235 ->params( $this->getLanguage()->listToText( $missing ) )
236 ->numParams( count( $missing ) )
238 $out->addHTML( $msg );
241 public function showDiffPage( $diffOnly = false ) {
242 # Allow frames except in certain special cases
243 $out = $this->getOutput();
244 $out->allowClickjacking();
245 $out->setRobotPolicy( 'noindex,nofollow' );
247 // Allow extensions to add any extra output here
248 Hooks
::run( 'DifferenceEngineShowDiffPage', [ $out ] );
250 if ( !$this->loadRevisionData() ) {
251 if ( Hooks
::run( 'DifferenceEngineShowDiffPageMaybeShowMissingRevision', [ $this ] ) ) {
252 $this->showMissingRevision();
257 $user = $this->getUser();
258 $permErrors = $this->mNewPage
->getUserPermissionsErrors( 'read', $user );
259 if ( $this->mOldPage
) { # mOldPage might not be set, see below.
260 $permErrors = wfMergeErrorArrays( $permErrors,
261 $this->mOldPage
->getUserPermissionsErrors( 'read', $user ) );
263 if ( count( $permErrors ) ) {
264 throw new PermissionsError( 'read', $permErrors );
270 # Carry over 'diffonly' param via navigation links
271 if ( $diffOnly != $user->getBoolOption( 'diffonly' ) ) {
272 $query['diffonly'] = $diffOnly;
274 # Cascade unhide param in links for easy deletion browsing
275 if ( $this->unhide
) {
276 $query['unhide'] = 1;
279 # Check if one of the revisions is deleted/suppressed
280 $deleted = $suppressed = false;
281 $allowed = $this->mNewRev
->userCan( Revision
::DELETED_TEXT
, $user );
285 # mOldRev is false if the difference engine is called with a "vague" query for
286 # a diff between a version V and its previous version V' AND the version V
287 # is the first version of that article. In that case, V' does not exist.
288 if ( $this->mOldRev
=== false ) {
289 $out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage
->getPrefixedText() ) );
292 // Allow extensions to change the $oldHeader variable
293 Hooks
::run( 'DifferenceEngineOldHeaderNoOldRev', [ &$oldHeader ] );
295 Hooks
::run( 'DiffViewHeader', [ $this, $this->mOldRev
, $this->mNewRev
] );
297 if ( $this->mNewPage
->equals( $this->mOldPage
) ) {
298 $out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage
->getPrefixedText() ) );
301 $out->setPageTitle( $this->msg( 'difference-title-multipage',
302 $this->mOldPage
->getPrefixedText(), $this->mNewPage
->getPrefixedText() ) );
303 $out->addSubtitle( $this->msg( 'difference-multipage' ) );
307 if ( $samePage && $this->mNewPage
->quickUserCan( 'edit', $user ) ) {
308 if ( $this->mNewRev
->isCurrent() && $this->mNewPage
->userCan( 'rollback', $user ) ) {
309 $rollbackLink = Linker
::generateRollback( $this->mNewRev
, $this->getContext() );
310 if ( $rollbackLink ) {
311 $out->preventClickjacking();
312 $rollback = '   ' . $rollbackLink;
316 if ( !$this->mOldRev
->isDeleted( Revision
::DELETED_TEXT
) &&
317 !$this->mNewRev
->isDeleted( Revision
::DELETED_TEXT
)
319 $undoLink = Html
::element( 'a', [
320 'href' => $this->mNewPage
->getLocalURL( [
322 'undoafter' => $this->mOldid
,
323 'undo' => $this->mNewid
325 'title' => Linker
::titleAttrib( 'undo' ),
327 $this->msg( 'editundo' )->text()
329 $revisionTools['mw-diff-undo'] = $undoLink;
333 # Make "previous revision link"
334 if ( $samePage && $this->mOldRev
->getPrevious() ) {
335 $prevlink = Linker
::linkKnown(
337 $this->msg( 'previousdiff' )->escaped(),
338 [ 'id' => 'differences-prevlink' ],
339 [ 'diff' => 'prev', 'oldid' => $this->mOldid
] +
$query
342 $prevlink = ' ';
345 if ( $this->mOldRev
->isMinor() ) {
346 $oldminor = ChangesList
::flag( 'minor' );
351 $ldel = $this->revisionDeleteLink( $this->mOldRev
);
352 $oldRevisionHeader = $this->getRevisionHeader( $this->mOldRev
, 'complete' );
353 $oldChangeTags = ChangeTags
::formatSummaryRow( $this->mOldTags
, 'diff', $this->getContext() );
355 $oldHeader = '<div id="mw-diff-otitle1"><strong>' . $oldRevisionHeader . '</strong></div>' .
356 '<div id="mw-diff-otitle2">' .
357 Linker
::revUserTools( $this->mOldRev
, !$this->unhide
) . '</div>' .
358 '<div id="mw-diff-otitle3">' . $oldminor .
359 Linker
::revComment( $this->mOldRev
, !$diffOnly, !$this->unhide
) . $ldel . '</div>' .
360 '<div id="mw-diff-otitle5">' . $oldChangeTags[0] . '</div>' .
361 '<div id="mw-diff-otitle4">' . $prevlink . '</div>';
363 // Allow extensions to change the $oldHeader variable
364 Hooks
::run( 'DifferenceEngineOldHeader', [ $this, &$oldHeader, $prevlink, $oldminor,
365 $diffOnly, $ldel, $this->unhide
] );
367 if ( $this->mOldRev
->isDeleted( Revision
::DELETED_TEXT
) ) {
368 $deleted = true; // old revisions text is hidden
369 if ( $this->mOldRev
->isDeleted( Revision
::DELETED_RESTRICTED
) ) {
370 $suppressed = true; // also suppressed
374 # Check if this user can see the revisions
375 if ( !$this->mOldRev
->userCan( Revision
::DELETED_TEXT
, $user ) ) {
380 # Make "next revision link"
381 # Skip next link on the top revision
382 if ( $samePage && !$this->mNewRev
->isCurrent() ) {
383 $nextlink = Linker
::linkKnown(
385 $this->msg( 'nextdiff' )->escaped(),
386 [ 'id' => 'differences-nextlink' ],
387 [ 'diff' => 'next', 'oldid' => $this->mNewid
] +
$query
390 $nextlink = ' ';
393 if ( $this->mNewRev
->isMinor() ) {
394 $newminor = ChangesList
::flag( 'minor' );
399 # Handle RevisionDelete links...
400 $rdel = $this->revisionDeleteLink( $this->mNewRev
);
402 # Allow extensions to define their own revision tools
403 Hooks
::run( 'DiffRevisionTools',
404 [ $this->mNewRev
, &$revisionTools, $this->mOldRev
, $user ] );
405 $formattedRevisionTools = [];
406 // Put each one in parentheses (poor man's button)
407 foreach ( $revisionTools as $key => $tool ) {
408 $toolClass = is_string( $key ) ?
$key : 'mw-diff-tool';
409 $element = Html
::rawElement(
411 [ 'class' => $toolClass ],
412 $this->msg( 'parentheses' )->rawParams( $tool )->escaped()
414 $formattedRevisionTools[] = $element;
416 $newRevisionHeader = $this->getRevisionHeader( $this->mNewRev
, 'complete' ) .
417 ' ' . implode( ' ', $formattedRevisionTools );
418 $newChangeTags = ChangeTags
::formatSummaryRow( $this->mNewTags
, 'diff', $this->getContext() );
420 $newHeader = '<div id="mw-diff-ntitle1"><strong>' . $newRevisionHeader . '</strong></div>' .
421 '<div id="mw-diff-ntitle2">' . Linker
::revUserTools( $this->mNewRev
, !$this->unhide
) .
423 '<div id="mw-diff-ntitle3">' . $newminor .
424 Linker
::revComment( $this->mNewRev
, !$diffOnly, !$this->unhide
) . $rdel . '</div>' .
425 '<div id="mw-diff-ntitle5">' . $newChangeTags[0] . '</div>' .
426 '<div id="mw-diff-ntitle4">' . $nextlink . $this->markPatrolledLink() . '</div>';
428 // Allow extensions to change the $newHeader variable
429 Hooks
::run( 'DifferenceEngineNewHeader', [ $this, &$newHeader, $formattedRevisionTools,
430 $nextlink, $rollback, $newminor, $diffOnly, $rdel, $this->unhide
] );
432 if ( $this->mNewRev
->isDeleted( Revision
::DELETED_TEXT
) ) {
433 $deleted = true; // new revisions text is hidden
434 if ( $this->mNewRev
->isDeleted( Revision
::DELETED_RESTRICTED
) ) {
435 $suppressed = true; // also suppressed
439 # If the diff cannot be shown due to a deleted revision, then output
440 # the diff header and links to unhide (if available)...
441 if ( $deleted && ( !$this->unhide ||
!$allowed ) ) {
442 $this->showDiffStyle();
443 $multi = $this->getMultiNotice();
444 $out->addHTML( $this->addHeader( '', $oldHeader, $newHeader, $multi ) );
446 $msg = $suppressed ?
'rev-suppressed-no-diff' : 'rev-deleted-no-diff';
447 # Give explanation for why revision is not visible
448 $out->wrapWikiMsg( "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
451 # Give explanation and add a link to view the diff...
452 $query = $this->getRequest()->appendQueryValue( 'unhide', '1' );
453 $link = $this->getTitle()->getFullURL( $query );
454 $msg = $suppressed ?
'rev-suppressed-unhide-diff' : 'rev-deleted-unhide-diff';
456 "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
460 # Otherwise, output a regular diff...
462 # Add deletion notice if the user is viewing deleted content
465 $msg = $suppressed ?
'rev-suppressed-diff-view' : 'rev-deleted-diff-view';
466 $notice = "<div id='mw-$msg' class='mw-warning plainlinks'>\n" .
467 $this->msg( $msg )->parse() .
470 $this->showDiff( $oldHeader, $newHeader, $notice );
472 $this->renderNewRevision();
478 * Build a link to mark a change as patrolled.
480 * Returns empty string if there's either no revision to patrol or the user is not allowed to.
481 * Side effect: When the patrol link is build, this method will call
482 * OutputPage::preventClickjacking() and load mediawiki.page.patrol.ajax.
484 * @return string HTML or empty string
486 public function markPatrolledLink() {
487 if ( $this->mMarkPatrolledLink
=== null ) {
488 $linkInfo = $this->getMarkPatrolledLinkInfo();
489 // If false, there is no patrol link needed/allowed
491 $this->mMarkPatrolledLink
= '';
493 $this->mMarkPatrolledLink
= ' <span class="patrollink" data-mw="interface">[' .
496 $this->msg( 'markaspatrolleddiff' )->escaped(),
499 'action' => 'markpatrolled',
500 'rcid' => $linkInfo['rcid'],
503 // Allow extensions to change the markpatrolled link
504 Hooks
::run( 'DifferenceEngineMarkPatrolledLink', [ $this,
505 &$this->mMarkPatrolledLink
, $linkInfo['rcid'] ] );
508 return $this->mMarkPatrolledLink
;
512 * Returns an array of meta data needed to build a "mark as patrolled" link and
513 * adds the mediawiki.page.patrol.ajax to the output.
515 * @return array|false An array of meta data for a patrol link (rcid only)
516 * or false if no link is needed
518 protected function getMarkPatrolledLinkInfo() {
519 global $wgUseRCPatrol, $wgEnableAPI, $wgEnableWriteAPI;
521 $user = $this->getUser();
523 // Prepare a change patrol link, if applicable
525 // Is patrolling enabled and the user allowed to?
526 $wgUseRCPatrol && $this->mNewPage
->quickUserCan( 'patrol', $user ) &&
527 // Only do this if the revision isn't more than 6 hours older
528 // than the Max RC age (6h because the RC might not be cleaned out regularly)
529 RecentChange
::isInRCLifespan( $this->mNewRev
->getTimestamp(), 21600 )
531 // Look for an unpatrolled change corresponding to this diff
532 $db = wfGetDB( DB_REPLICA
);
533 $change = RecentChange
::newFromConds(
535 'rc_timestamp' => $db->timestamp( $this->mNewRev
->getTimestamp() ),
536 'rc_this_oldid' => $this->mNewid
,
542 if ( $change && !$change->getPerformer()->equals( $user ) ) {
543 $rcid = $change->getAttribute( 'rc_id' );
545 // None found or the page has been created by the current user.
546 // If the user could patrol this it already would be patrolled
550 // Allow extensions to possibly change the rcid here
551 // For example the rcid might be set to zero due to the user
552 // being the same as the performer of the change but an extension
553 // might still want to show it under certain conditions
554 Hooks
::run( 'DifferenceEngineMarkPatrolledRCID', [ &$rcid, $this, $change, $user ] );
558 $this->getOutput()->preventClickjacking();
559 if ( $wgEnableAPI && $wgEnableWriteAPI
560 && $user->isAllowed( 'writeapi' )
562 $this->getOutput()->addModules( 'mediawiki.page.patrol.ajax' );
571 // No mark as patrolled link applicable
576 * @param Revision $rev
580 protected function revisionDeleteLink( $rev ) {
581 $link = Linker
::getRevDeleteLink( $this->getUser(), $rev, $rev->getTitle() );
582 if ( $link !== '' ) {
583 $link = '   ' . $link . ' ';
590 * Show the new revision of the page.
592 public function renderNewRevision() {
593 $out = $this->getOutput();
594 $revHeader = $this->getRevisionHeader( $this->mNewRev
);
595 # Add "current version as of X" title
596 $out->addHTML( "<hr class='diff-hr' id='mw-oldid' />
597 <h2 class='diff-currentversion-title'>{$revHeader}</h2>\n" );
598 # Page content may be handled by a hooked call instead...
599 # @codingStandardsIgnoreStart Ignoring long lines.
600 if ( Hooks
::run( 'ArticleContentOnDiff', [ $this, $out ] ) ) {
601 $this->loadNewText();
602 $out->setRevisionId( $this->mNewid
);
603 $out->setRevisionTimestamp( $this->mNewRev
->getTimestamp() );
604 $out->setArticleFlag( true );
606 if ( !Hooks
::run( 'ArticleContentViewCustom', [ $this->mNewContent
, $this->mNewPage
, $out ] ) ) {
607 // Handled by extension
610 if ( $this->getTitle()->equals( $this->mNewPage
) ) {
611 // If the Title stored in the context is the same as the one
612 // of the new revision, we can use its associated WikiPage
614 $wikiPage = $this->getWikiPage();
616 // Otherwise we need to create our own WikiPage object
617 $wikiPage = WikiPage
::factory( $this->mNewPage
);
620 $parserOutput = $this->getParserOutput( $wikiPage, $this->mNewRev
);
622 # WikiPage::getParserOutput() should not return false, but just in case
623 if ( $parserOutput ) {
624 // Allow extensions to change parser output here
625 if ( Hooks
::run( 'DifferenceEngineRenderRevisionAddParserOutput', [ $this, $out, $parserOutput, $wikiPage ] ) ) {
626 $out->addParserOutput( $parserOutput );
631 # @codingStandardsIgnoreEnd
633 // Allow extensions to optionally not show the final patrolled link
634 if ( Hooks
::run( 'DifferenceEngineRenderRevisionShowFinalPatrolLink' ) ) {
635 # Add redundant patrol link on bottom...
636 $out->addHTML( $this->markPatrolledLink() );
640 protected function getParserOutput( WikiPage
$page, Revision
$rev ) {
641 $parserOptions = $page->makeParserOptions( $this->getContext() );
643 if ( !$rev->isCurrent() ||
!$rev->getTitle()->quickUserCan( 'edit', $this->getUser() ) ) {
644 $parserOptions->setEditSection( false );
647 $parserOutput = $page->getParserOutput( $parserOptions, $rev->getId() );
649 return $parserOutput;
653 * Get the diff text, send it to the OutputPage object
654 * Returns false if the diff could not be generated, otherwise returns true
656 * @param string|bool $otitle Header for old text or false
657 * @param string|bool $ntitle Header for new text or false
658 * @param string $notice HTML between diff header and body
662 public function showDiff( $otitle, $ntitle, $notice = '' ) {
663 // Allow extensions to affect the output here
664 Hooks
::run( 'DifferenceEngineShowDiff', [ $this ] );
666 $diff = $this->getDiff( $otitle, $ntitle, $notice );
667 if ( $diff === false ) {
668 $this->showMissingRevision();
672 $this->showDiffStyle();
673 $this->getOutput()->addHTML( $diff );
680 * Add style sheets for diff display.
682 public function showDiffStyle() {
683 $this->getOutput()->addModuleStyles( 'mediawiki.diff.styles' );
687 * Get complete diff table, including header
689 * @param string|bool $otitle Header for old text or false
690 * @param string|bool $ntitle Header for new text or false
691 * @param string $notice HTML between diff header and body
695 public function getDiff( $otitle, $ntitle, $notice = '' ) {
696 $body = $this->getDiffBody();
697 if ( $body === false ) {
701 $multi = $this->getMultiNotice();
702 // Display a message when the diff is empty
703 if ( $body === '' ) {
704 $notice .= '<div class="mw-diff-empty">' .
705 $this->msg( 'diff-empty' )->parse() .
709 return $this->addHeader( $body, $otitle, $ntitle, $multi, $notice );
713 * Get the diff table body, without header
715 * @return mixed (string/false)
717 public function getDiffBody() {
718 $this->mCacheHit
= true;
719 // Check if the diff should be hidden from this user
720 if ( !$this->loadRevisionData() ) {
722 } elseif ( $this->mOldRev
&&
723 !$this->mOldRev
->userCan( Revision
::DELETED_TEXT
, $this->getUser() )
726 } elseif ( $this->mNewRev
&&
727 !$this->mNewRev
->userCan( Revision
::DELETED_TEXT
, $this->getUser() )
732 if ( $this->mOldRev
=== false ||
( $this->mOldRev
&& $this->mNewRev
733 && $this->mOldRev
->getId() == $this->mNewRev
->getId() )
735 if ( Hooks
::run( 'DifferenceEngineShowEmptyOldContent', [ $this ] ) ) {
741 $cache = ObjectCache
::getMainWANInstance();
742 if ( $this->mOldid
&& $this->mNewid
) {
743 $key = $this->getDiffBodyCacheKey();
746 if ( !$this->mRefreshCache
) {
747 $difftext = $cache->get( $key );
749 wfIncrStats( 'diff_cache.hit' );
750 $difftext = $this->localiseLineNumbers( $difftext );
751 $difftext .= "\n<!-- diff cache key $key -->\n";
755 } // don't try to load but save the result
757 $this->mCacheHit
= false;
759 // Loadtext is permission safe, this just clears out the diff
760 if ( !$this->loadText() ) {
764 $difftext = $this->generateContentDiffBody( $this->mOldContent
, $this->mNewContent
);
766 // Avoid PHP 7.1 warning from passing $this by reference
769 // Save to cache for 7 days
770 if ( !Hooks
::run( 'AbortDiffCache', [ &$diffEngine ] ) ) {
771 wfIncrStats( 'diff_cache.uncacheable' );
772 } elseif ( $key !== false && $difftext !== false ) {
773 wfIncrStats( 'diff_cache.miss' );
774 $cache->set( $key, $difftext, 7 * 86400 );
776 wfIncrStats( 'diff_cache.uncacheable' );
778 // Replace line numbers with the text in the user's language
779 if ( $difftext !== false ) {
780 $difftext = $this->localiseLineNumbers( $difftext );
787 * Returns the cache key for diff body text or content.
791 * @throws MWException
794 protected function getDiffBodyCacheKey() {
795 if ( !$this->mOldid ||
!$this->mNewid
) {
796 throw new MWException( 'mOldid and mNewid must be set to get diff cache key.' );
799 return wfMemcKey( 'diff', 'version', self
::DIFF_VERSION
,
800 'oldid', $this->mOldid
, 'newid', $this->mNewid
);
804 * Generate a diff, no caching.
806 * This implementation uses generateTextDiffBody() to generate a diff based on the default
807 * serialization of the given Content objects. This will fail if $old or $new are not
808 * instances of TextContent.
810 * Subclasses may override this to provide a different rendering for the diff,
811 * perhaps taking advantage of the content's native form. This is required for all content
812 * models that are not text based.
816 * @param Content $old Old content
817 * @param Content $new New content
819 * @throws MWException If old or new content is not an instance of TextContent.
820 * @return bool|string
822 public function generateContentDiffBody( Content
$old, Content
$new ) {
823 if ( !( $old instanceof TextContent
) ) {
824 throw new MWException( "Diff not implemented for " . get_class( $old ) . "; " .
825 "override generateContentDiffBody to fix this." );
828 if ( !( $new instanceof TextContent
) ) {
829 throw new MWException( "Diff not implemented for " . get_class( $new ) . "; "
830 . "override generateContentDiffBody to fix this." );
833 $otext = $old->serialize();
834 $ntext = $new->serialize();
836 return $this->generateTextDiffBody( $otext, $ntext );
840 * Generate a diff, no caching
842 * @todo move this to TextDifferenceEngine, make DifferenceEngine abstract. At some point.
844 * @param string $otext Old text, must be already segmented
845 * @param string $ntext New text, must be already segmented
847 * @return bool|string
849 public function generateTextDiffBody( $otext, $ntext ) {
850 $diff = function() use ( $otext, $ntext ) {
851 $time = microtime( true );
853 $result = $this->textDiff( $otext, $ntext );
855 $time = intval( ( microtime( true ) - $time ) * 1000 );
856 MediaWikiServices
::getInstance()->getStatsdDataFactory()->timing( 'diff_time', $time );
857 // Log requests slower than 99th percentile
858 if ( $time > 100 && $this->mOldPage
&& $this->mNewPage
) {
860 "$time ms diff: {$this->mOldid} -> {$this->mNewid} {$this->mNewPage}" );
867 * @param Status $status
870 $error = function( $status ) {
871 throw new FatalError( $status->getWikiText() );
874 // Use PoolCounter if the diff looks like it can be expensive
875 if ( strlen( $otext ) +
strlen( $ntext ) > 20000 ) {
876 $work = new PoolCounterWorkViaCallback( 'diff',
877 md5( $otext ) . md5( $ntext ),
878 [ 'doWork' => $diff, 'error' => $error ]
880 return $work->execute();
887 * Generates diff, to be wrapped internally in a logging/instrumentation
889 * @param string $otext Old text, must be already segmented
890 * @param string $ntext New text, must be already segmented
891 * @return bool|string
893 protected function textDiff( $otext, $ntext ) {
894 global $wgExternalDiffEngine, $wgContLang;
896 $otext = str_replace( "\r\n", "\n", $otext );
897 $ntext = str_replace( "\r\n", "\n", $ntext );
899 if ( $wgExternalDiffEngine == 'wikidiff' ||
$wgExternalDiffEngine == 'wikidiff3' ) {
900 wfDeprecated( "\$wgExternalDiffEngine = '{$wgExternalDiffEngine}'", '1.27' );
901 $wgExternalDiffEngine = false;
902 } elseif ( $wgExternalDiffEngine == 'wikidiff2' ) {
903 // Same as above, but with no deprecation warnings
904 $wgExternalDiffEngine = false;
905 } elseif ( !is_string( $wgExternalDiffEngine ) && $wgExternalDiffEngine !== false ) {
906 // And prevent people from shooting themselves in the foot...
907 wfWarn( '$wgExternalDiffEngine is set to a non-string value, forcing it to false' );
908 $wgExternalDiffEngine = false;
911 if ( function_exists( 'wikidiff2_do_diff' ) && $wgExternalDiffEngine === false ) {
912 # Better external diff engine, the 2 may some day be dropped
913 # This one does the escaping and segmenting itself
914 $text = wikidiff2_do_diff( $otext, $ntext, 2 );
915 $text .= $this->debug( 'wikidiff2' );
918 } elseif ( $wgExternalDiffEngine !== false && is_executable( $wgExternalDiffEngine ) ) {
920 $tmpDir = wfTempDir();
921 $tempName1 = tempnam( $tmpDir, 'diff_' );
922 $tempName2 = tempnam( $tmpDir, 'diff_' );
924 $tempFile1 = fopen( $tempName1, "w" );
928 $tempFile2 = fopen( $tempName2, "w" );
932 fwrite( $tempFile1, $otext );
933 fwrite( $tempFile2, $ntext );
934 fclose( $tempFile1 );
935 fclose( $tempFile2 );
936 $cmd = wfEscapeShellArg( $wgExternalDiffEngine, $tempName1, $tempName2 );
937 $difftext = wfShellExec( $cmd );
938 $difftext .= $this->debug( "external $wgExternalDiffEngine" );
939 unlink( $tempName1 );
940 unlink( $tempName2 );
946 $ota = explode( "\n", $wgContLang->segmentForDiff( $otext ) );
947 $nta = explode( "\n", $wgContLang->segmentForDiff( $ntext ) );
948 $diffs = new Diff( $ota, $nta );
949 $formatter = new TableDiffFormatter();
950 $difftext = $wgContLang->unsegmentForDiff( $formatter->format( $diffs ) );
956 * Generate a debug comment indicating diff generating time,
957 * server node, and generator backend.
959 * @param string $generator : What diff engine was used
963 protected function debug( $generator = "internal" ) {
964 global $wgShowHostnames;
965 if ( !$this->enableDebugComment
) {
968 $data = [ $generator ];
969 if ( $wgShowHostnames ) {
970 $data[] = wfHostname();
972 $data[] = wfTimestamp( TS_DB
);
974 return "<!-- diff generator: " .
975 implode( " ", array_map( "htmlspecialchars", $data ) ) .
980 * Replace line numbers with the text in the user's language
982 * @param string $text
986 public function localiseLineNumbers( $text ) {
987 return preg_replace_callback(
988 '/<!--LINE (\d+)-->/',
989 [ $this, 'localiseLineNumbersCb' ],
994 public function localiseLineNumbersCb( $matches ) {
995 if ( $matches[1] === '1' && $this->mReducedLineNumbers
) {
999 return $this->msg( 'lineno' )->numParams( $matches[1] )->escaped();
1003 * If there are revisions between the ones being compared, return a note saying so.
1007 public function getMultiNotice() {
1008 if ( !is_object( $this->mOldRev
) ||
!is_object( $this->mNewRev
) ) {
1010 } elseif ( !$this->mOldPage
->equals( $this->mNewPage
) ) {
1011 // Comparing two different pages? Count would be meaningless.
1015 if ( $this->mOldRev
->getTimestamp() > $this->mNewRev
->getTimestamp() ) {
1016 $oldRev = $this->mNewRev
; // flip
1017 $newRev = $this->mOldRev
; // flip
1018 } else { // normal case
1019 $oldRev = $this->mOldRev
;
1020 $newRev = $this->mNewRev
;
1023 // Sanity: don't show the notice if too many rows must be scanned
1024 // @todo show some special message for that case
1025 $nEdits = $this->mNewPage
->countRevisionsBetween( $oldRev, $newRev, 1000 );
1026 if ( $nEdits > 0 && $nEdits <= 1000 ) {
1027 $limit = 100; // use diff-multi-manyusers if too many users
1028 $users = $this->mNewPage
->getAuthorsBetween( $oldRev, $newRev, $limit );
1029 $numUsers = count( $users );
1031 if ( $numUsers == 1 && $users[0] == $newRev->getUserText( Revision
::RAW
) ) {
1032 $numUsers = 0; // special case to say "by the same user" instead of "by one other user"
1035 return self
::intermediateEditsMsg( $nEdits, $numUsers, $limit );
1038 return ''; // nothing
1042 * Get a notice about how many intermediate edits and users there are
1044 * @param int $numEdits
1045 * @param int $numUsers
1050 public static function intermediateEditsMsg( $numEdits, $numUsers, $limit ) {
1051 if ( $numUsers === 0 ) {
1052 $msg = 'diff-multi-sameuser';
1053 } elseif ( $numUsers > $limit ) {
1054 $msg = 'diff-multi-manyusers';
1057 $msg = 'diff-multi-otherusers';
1060 return wfMessage( $msg )->numParams( $numEdits, $numUsers )->parse();
1064 * Get a header for a specified revision.
1066 * @param Revision $rev
1067 * @param string $complete 'complete' to get the header wrapped depending
1068 * the visibility of the revision and a link to edit the page.
1070 * @return string HTML fragment
1072 public function getRevisionHeader( Revision
$rev, $complete = '' ) {
1073 $lang = $this->getLanguage();
1074 $user = $this->getUser();
1075 $revtimestamp = $rev->getTimestamp();
1076 $timestamp = $lang->userTimeAndDate( $revtimestamp, $user );
1077 $dateofrev = $lang->userDate( $revtimestamp, $user );
1078 $timeofrev = $lang->userTime( $revtimestamp, $user );
1080 $header = $this->msg(
1081 $rev->isCurrent() ?
'currentrev-asof' : 'revisionasof',
1087 if ( $complete !== 'complete' ) {
1091 $title = $rev->getTitle();
1093 $header = Linker
::linkKnown( $title, $header, [],
1094 [ 'oldid' => $rev->getId() ] );
1096 if ( $rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
1097 $editQuery = [ 'action' => 'edit' ];
1098 if ( !$rev->isCurrent() ) {
1099 $editQuery['oldid'] = $rev->getId();
1102 $key = $title->quickUserCan( 'edit', $user ) ?
'editold' : 'viewsourceold';
1103 $msg = $this->msg( $key )->escaped();
1104 $editLink = $this->msg( 'parentheses' )->rawParams(
1105 Linker
::linkKnown( $title, $msg, [], $editQuery ) )->escaped();
1106 $header .= ' ' . Html
::rawElement(
1108 [ 'class' => 'mw-diff-edit' ],
1111 if ( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
1112 $header = Html
::rawElement(
1114 [ 'class' => 'history-deleted' ],
1119 $header = Html
::rawElement( 'span', [ 'class' => 'history-deleted' ], $header );
1126 * Add the header to a diff body
1128 * @param string $diff Diff body
1129 * @param string $otitle Old revision header
1130 * @param string $ntitle New revision header
1131 * @param string $multi Notice telling user that there are intermediate
1132 * revisions between the ones being compared
1133 * @param string $notice Other notices, e.g. that user is viewing deleted content
1137 public function addHeader( $diff, $otitle, $ntitle, $multi = '', $notice = '' ) {
1138 // shared.css sets diff in interface language/dir, but the actual content
1139 // is often in a different language, mostly the page content language/dir
1140 $header = Html
::openElement( 'table', [
1141 'class' => [ 'diff', 'diff-contentalign-' . $this->getDiffLang()->alignStart() ],
1142 'data-mw' => 'interface',
1144 $userLang = htmlspecialchars( $this->getLanguage()->getHtmlCode() );
1146 if ( !$diff && !$otitle ) {
1148 <tr style='vertical-align: top;' lang='{$userLang}'>
1149 <td class='diff-ntitle'>{$ntitle}</td>
1153 if ( $diff ) { // Safari/Chrome show broken output if cols not used
1155 <col class='diff-marker' />
1156 <col class='diff-content' />
1157 <col class='diff-marker' />
1158 <col class='diff-content' />";
1165 if ( $otitle ||
$ntitle ) {
1167 <tr style='vertical-align: top;' lang='{$userLang}'>
1168 <td colspan='$colspan' class='diff-otitle'>{$otitle}</td>
1169 <td colspan='$colspan' class='diff-ntitle'>{$ntitle}</td>
1174 if ( $multi != '' ) {
1175 $header .= "<tr><td colspan='{$multiColspan}' style='text-align: center;' " .
1176 "class='diff-multi' lang='{$userLang}'>{$multi}</td></tr>";
1178 if ( $notice != '' ) {
1179 $header .= "<tr><td colspan='{$multiColspan}' style='text-align: center;' " .
1180 "lang='{$userLang}'>{$notice}</td></tr>";
1183 return $header . $diff . "</table>";
1187 * Use specified text instead of loading from the database
1188 * @param Content $oldContent
1189 * @param Content $newContent
1192 public function setContent( Content
$oldContent, Content
$newContent ) {
1193 $this->mOldContent
= $oldContent;
1194 $this->mNewContent
= $newContent;
1196 $this->mTextLoaded
= 2;
1197 $this->mRevisionsLoaded
= true;
1201 * Set the language in which the diff text is written
1202 * (Defaults to page content language).
1203 * @param Language|string $lang
1206 public function setTextLanguage( $lang ) {
1207 $this->mDiffLang
= wfGetLangObj( $lang );
1211 * Maps a revision pair definition as accepted by DifferenceEngine constructor
1212 * to a pair of actual integers representing revision ids.
1214 * @param int $old Revision id, e.g. from URL parameter 'oldid'
1215 * @param int|string $new Revision id or strings 'next' or 'prev', e.g. from URL parameter 'diff'
1217 * @return int[] List of two revision ids, older first, later second.
1218 * Zero signifies invalid argument passed.
1219 * false signifies that there is no previous/next revision ($old is the oldest/newest one).
1221 public function mapDiffPrevNext( $old, $new ) {
1222 if ( $new === 'prev' ) {
1223 // Show diff between revision $old and the previous one. Get previous one from DB.
1224 $newid = intval( $old );
1225 $oldid = $this->getTitle()->getPreviousRevisionID( $newid );
1226 } elseif ( $new === 'next' ) {
1227 // Show diff between revision $old and the next one. Get next one from DB.
1228 $oldid = intval( $old );
1229 $newid = $this->getTitle()->getNextRevisionID( $oldid );
1231 $oldid = intval( $old );
1232 $newid = intval( $new );
1235 return [ $oldid, $newid ];
1241 private function loadRevisionIds() {
1242 if ( $this->mRevisionsIdsLoaded
) {
1246 $this->mRevisionsIdsLoaded
= true;
1248 $old = $this->mOldid
;
1249 $new = $this->mNewid
;
1251 list( $this->mOldid
, $this->mNewid
) = self
::mapDiffPrevNext( $old, $new );
1252 if ( $new === 'next' && $this->mNewid
=== false ) {
1253 # if no result, NewId points to the newest old revision. The only newer
1254 # revision is cur, which is "0".
1259 'NewDifferenceEngine',
1260 [ $this->getTitle(), &$this->mOldid
, &$this->mNewid
, $old, $new ]
1265 * Load revision metadata for the specified articles. If newid is 0, then compare
1266 * the old article in oldid to the current article; if oldid is 0, then
1267 * compare the current article to the immediately previous one (ignoring the
1270 * If oldid is false, leave the corresponding revision object set
1271 * to false. This is impossible via ordinary user input, and is provided for
1276 public function loadRevisionData() {
1277 if ( $this->mRevisionsLoaded
) {
1281 // Whether it succeeds or fails, we don't want to try again
1282 $this->mRevisionsLoaded
= true;
1284 $this->loadRevisionIds();
1286 // Load the new revision object
1287 if ( $this->mNewid
) {
1288 $this->mNewRev
= Revision
::newFromId( $this->mNewid
);
1290 $this->mNewRev
= Revision
::newFromTitle(
1293 Revision
::READ_NORMAL
1297 if ( !$this->mNewRev
instanceof Revision
) {
1301 // Update the new revision ID in case it was 0 (makes life easier doing UI stuff)
1302 $this->mNewid
= $this->mNewRev
->getId();
1303 $this->mNewPage
= $this->mNewRev
->getTitle();
1305 // Load the old revision object
1306 $this->mOldRev
= false;
1307 if ( $this->mOldid
) {
1308 $this->mOldRev
= Revision
::newFromId( $this->mOldid
);
1309 } elseif ( $this->mOldid
=== 0 ) {
1310 $rev = $this->mNewRev
->getPrevious();
1312 $this->mOldid
= $rev->getId();
1313 $this->mOldRev
= $rev;
1315 // No previous revision; mark to show as first-version only.
1316 $this->mOldid
= false;
1317 $this->mOldRev
= false;
1319 } /* elseif ( $this->mOldid === false ) leave mOldRev false; */
1321 if ( is_null( $this->mOldRev
) ) {
1325 if ( $this->mOldRev
) {
1326 $this->mOldPage
= $this->mOldRev
->getTitle();
1329 // Load tags information for both revisions
1330 $dbr = wfGetDB( DB_REPLICA
);
1331 if ( $this->mOldid
!== false ) {
1332 $this->mOldTags
= $dbr->selectField(
1335 [ 'ts_rev_id' => $this->mOldid
],
1339 $this->mOldTags
= false;
1341 $this->mNewTags
= $dbr->selectField(
1344 [ 'ts_rev_id' => $this->mNewid
],
1352 * Load the text of the revisions, as well as revision data.
1356 public function loadText() {
1357 if ( $this->mTextLoaded
== 2 ) {
1361 // Whether it succeeds or fails, we don't want to try again
1362 $this->mTextLoaded
= 2;
1364 if ( !$this->loadRevisionData() ) {
1368 if ( $this->mOldRev
) {
1369 $this->mOldContent
= $this->mOldRev
->getContent( Revision
::FOR_THIS_USER
, $this->getUser() );
1370 if ( $this->mOldContent
=== null ) {
1375 if ( $this->mNewRev
) {
1376 $this->mNewContent
= $this->mNewRev
->getContent( Revision
::FOR_THIS_USER
, $this->getUser() );
1377 Hooks
::run( 'DifferenceEngineLoadTextAfterNewContentIsLoaded', [ $this ] );
1378 if ( $this->mNewContent
=== null ) {
1387 * Load the text of the new revision, not the old one
1391 public function loadNewText() {
1392 if ( $this->mTextLoaded
>= 1 ) {
1396 $this->mTextLoaded
= 1;
1398 if ( !$this->loadRevisionData() ) {
1402 $this->mNewContent
= $this->mNewRev
->getContent( Revision
::FOR_THIS_USER
, $this->getUser() );
1404 Hooks
::run( 'DifferenceEngineAfterLoadNewText', [ $this ] );