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
24 use MediaWiki\MediaWikiServices
;
25 use MediaWiki\Revision\RevisionRecord
;
26 use MediaWiki\Revision\SlotRecord
;
27 use MediaWiki\Storage\NameTableAccessException
;
30 * DifferenceEngine is responsible for rendering the difference between two revisions as HTML.
31 * This includes interpreting URL parameters, retrieving revision data, checking access permissions,
32 * selecting and invoking the diff generator class for the individual slots, doing post-processing
33 * on the generated diff, adding the rest of the HTML (such as headers) and writing the whole thing
36 * DifferenceEngine can be subclassed by extensions, by customizing
37 * ContentHandler::createDifferenceEngine; the content handler will be selected based on the
38 * content model of the main slot (of the new revision, when the two are different).
39 * That might change after PageTypeHandler gets introduced.
41 * In the past, the class was also used for slot-level diff generation, and extensions might still
42 * subclass it and add such functionality. When that is the case (sepcifically, when a
43 * ContentHandler returns a standard SlotDiffRenderer but a nonstandard DifferenceEngine)
44 * DifferenceEngineSlotDiffRenderer will be used to convert the old behavior into the new one.
46 * @ingroup DifferenceEngine
48 * @todo This class is huge and poorly defined. It should be split into a controller responsible
49 * for interpreting query parameters, retrieving data and checking permissions; and a HTML renderer.
51 class DifferenceEngine
extends ContextSource
{
53 use DeprecationHelper
;
56 * Constant to indicate diff cache compatibility.
57 * Bump this when changing the diff formatting in a way that
58 * fixes important bugs or such to force cached diff views to
61 const DIFF_VERSION
= '1.12';
64 * Revision ID for the old revision. 0 for the revision previous to $mNewid, false
65 * if the diff does not have an old revision (e.g. 'oldid=<first revision of page>&diff=prev'),
66 * or the revision does not exist, null if the revision is unsaved.
72 * Revision ID for the new revision. 0 for the last revision of the current page
73 * (as defined by the request context), false if the revision does not exist, null
74 * if it is unsaved, or an alias such as 'next'.
75 * @var int|string|false|null
80 * Old revision (left pane).
81 * Allowed to be an unsaved revision, unlikely that's ever needed though.
82 * False when the old revision does not exist; this can happen when using
83 * diff=prev on the first revision. Null when the revision should exist but
84 * doesn't (e.g. load failure); loadRevisionData() will return false in that
85 * case. Also null until lazy-loaded. Ignored completely when isContentOverridden
87 * Since 1.32 public access is deprecated.
88 * @var Revision|null|false
93 * New revision (right pane).
94 * Note that this might be an unsaved revision (e.g. for edit preview).
95 * Null in case of load failure; diff methods will just return an error message in that case,
96 * and loadRevisionData() will return false. Also null until lazy-loaded. Ignored completely
97 * when isContentOverridden is set.
98 * Since 1.32 public access is deprecated.
104 * Title of $mOldRev or null if the old revision does not exist or does not belong to a page.
105 * Since 1.32 public access is deprecated and the property can be null.
111 * Title of $mNewRev or null if the new revision does not exist or does not belong to a page.
112 * Since 1.32 public access is deprecated and the property can be null.
118 * Change tags of $mOldRev or null if it does not exist / is not saved.
124 * Change tags of $mNewRev or null if it does not exist / is not saved.
131 * @deprecated since 1.32, content slots are now handled by the corresponding SlotDiffRenderer.
132 * This property is set to the content of the main slot, but not actually used for the main diff.
134 private $mOldContent;
138 * @deprecated since 1.32, content slots are now handled by the corresponding SlotDiffRenderer.
139 * This property is set to the content of the main slot, but not actually used for the main diff.
141 private $mNewContent;
144 protected $mDiffLang;
146 /** @var bool Have the revisions IDs been loaded */
147 private $mRevisionsIdsLoaded = false;
149 /** @var bool Have the revisions been loaded */
150 protected $mRevisionsLoaded = false;
152 /** @var int How many text blobs have been loaded, 0, 1 or 2? */
153 protected $mTextLoaded = 0;
156 * Was the content overridden via setContent()?
157 * If the content was overridden, most internal state (e.g. mOldid or mOldRev) should be ignored
158 * and only mOldContent and mNewContent is reliable.
159 * (Note that setRevisions() does not set this flag as in that case all properties are
160 * overriden and remain consistent with each other, so no special handling is needed.)
163 protected $isContentOverridden = false;
165 /** @var bool Was the diff fetched from cache? */
166 protected $mCacheHit = false;
169 * Set this to true to add debug info to the HTML output.
170 * Warning: this may cause RSS readers to spuriously mark articles as "new"
173 public $enableDebugComment = false;
175 /** @var bool If true, line X is not displayed when X is 1, for example
176 * to increase readability and conserve space with many small diffs.
178 protected $mReducedLineNumbers = false;
180 /** @var string Link to action=markpatrolled */
181 protected $mMarkPatrolledLink = null;
183 /** @var bool Show rev_deleted content if allowed */
184 protected $unhide = false;
186 /** @var bool Refresh the diff cache */
187 protected $mRefreshCache = false;
189 /** @var SlotDiffRenderer[] DifferenceEngine classes for the slots, keyed by role name. */
190 protected $slotDiffRenderers = null;
193 * Temporary hack for B/C while slot diff related methods of DifferenceEngine are being
194 * deprecated. When true, we are inside a DifferenceEngineSlotDiffRenderer and
195 * $slotDiffRenderers should not be used.
198 protected $isSlotDiffRenderer = false;
203 * @param IContextSource|null $context Context to use, anything else will be ignored
204 * @param int $old Old ID we want to show and diff with.
205 * @param string|int $new Either revision ID or 'prev' or 'next'. Default: 0.
206 * @param int $rcid Deprecated, no longer used!
207 * @param bool $refreshCache If set, refreshes the diff cache
208 * @param bool $unhide If set, allow viewing deleted revs
210 public function __construct( $context = null, $old = 0, $new = 0, $rcid = 0,
211 $refreshCache = false, $unhide = false
213 $this->deprecatePublicProperty( 'mOldid', '1.32', __CLASS__
);
214 $this->deprecatePublicProperty( 'mNewid', '1.32', __CLASS__
);
215 $this->deprecatePublicProperty( 'mOldRev', '1.32', __CLASS__
);
216 $this->deprecatePublicProperty( 'mNewRev', '1.32', __CLASS__
);
217 $this->deprecatePublicProperty( 'mOldPage', '1.32', __CLASS__
);
218 $this->deprecatePublicProperty( 'mNewPage', '1.32', __CLASS__
);
219 $this->deprecatePublicProperty( 'mOldContent', '1.32', __CLASS__
);
220 $this->deprecatePublicProperty( 'mNewContent', '1.32', __CLASS__
);
221 $this->deprecatePublicProperty( 'mRevisionsLoaded', '1.32', __CLASS__
);
222 $this->deprecatePublicProperty( 'mTextLoaded', '1.32', __CLASS__
);
223 $this->deprecatePublicProperty( 'mCacheHit', '1.32', __CLASS__
);
225 if ( $context instanceof IContextSource
) {
226 $this->setContext( $context );
229 wfDebug( "DifferenceEngine old '$old' new '$new' rcid '$rcid'\n" );
231 $this->mOldid
= $old;
232 $this->mNewid
= $new;
233 $this->mRefreshCache
= $refreshCache;
234 $this->unhide
= $unhide;
238 * @return SlotDiffRenderer[] Diff renderers for each slot, keyed by role name.
239 * Includes slots only present in one of the revisions.
241 protected function getSlotDiffRenderers() {
242 if ( $this->isSlotDiffRenderer
) {
243 throw new LogicException( __METHOD__
. ' called in slot diff renderer mode' );
246 if ( $this->slotDiffRenderers
=== null ) {
247 if ( !$this->loadRevisionData() ) {
251 $slotContents = $this->getSlotContents();
252 $this->slotDiffRenderers
= array_map( function ( $contents ) {
253 /** @var $content Content */
254 $content = $contents['new'] ?
: $contents['old'];
255 return $content->getContentHandler()->getSlotDiffRenderer( $this->getContext() );
258 return $this->slotDiffRenderers
;
262 * Mark this DifferenceEngine as a slot renderer (as opposed to a page renderer).
263 * This is used in legacy mode when the DifferenceEngine is wrapped in a
264 * DifferenceEngineSlotDiffRenderer.
265 * @internal For use by DifferenceEngineSlotDiffRenderer only.
267 public function markAsSlotDiffRenderer() {
268 $this->isSlotDiffRenderer
= true;
272 * Get the old and new content objects for all slots.
273 * This method does not do any permission checks.
274 * @return array [ role => [ 'old' => SlotRecord|null, 'new' => SlotRecord|null ], ... ]
276 protected function getSlotContents() {
277 if ( $this->isContentOverridden
) {
279 SlotRecord
::MAIN
=> [
280 'old' => $this->mOldContent
,
281 'new' => $this->mNewContent
,
284 } elseif ( !$this->loadRevisionData() ) {
288 $newSlots = $this->mNewRev
->getRevisionRecord()->getSlots()->getSlots();
289 if ( $this->mOldRev
) {
290 $oldSlots = $this->mOldRev
->getRevisionRecord()->getSlots()->getSlots();
294 // The order here will determine the visual order of the diff. The current logic is
295 // slots of the new revision first in natural order, then deleted ones. This is ad hoc
296 // and should not be relied on - in the future we may want the ordering to depend
298 $roles = array_merge( array_keys( $newSlots ), array_keys( $oldSlots ) );
301 foreach ( $roles as $role ) {
303 'old' => isset( $oldSlots[$role] ) ?
$oldSlots[$role]->getContent() : null,
304 'new' => isset( $newSlots[$role] ) ?
$newSlots[$role]->getContent() : null,
307 // move main slot to front
308 if ( isset( $slots[SlotRecord
::MAIN
] ) ) {
309 $slots = [ SlotRecord
::MAIN
=> $slots[SlotRecord
::MAIN
] ] +
$slots;
314 public function getTitle() {
315 // T202454 avoid errors when there is no title
316 return parent
::getTitle() ?
: Title
::makeTitle( NS_SPECIAL
, 'BadTitle/DifferenceEngine' );
320 * Set reduced line numbers mode.
321 * When set, line X is not displayed when X is 1, for example to increase readability and
322 * conserve space with many small diffs.
325 public function setReducedLineNumbers( $value = true ) {
326 $this->mReducedLineNumbers
= $value;
330 * Get the language of the difference engine, defaults to page content language
334 public function getDiffLang() {
335 if ( $this->mDiffLang
=== null ) {
336 # Default language in which the diff text is written.
337 $this->mDiffLang
= $this->getTitle()->getPageLanguage();
340 return $this->mDiffLang
;
346 public function wasCacheHit() {
347 return $this->mCacheHit
;
351 * Get the ID of old revision (left pane) of the diff. 0 for the revision
352 * previous to getNewid(), false if the old revision does not exist, null
354 * To get a real revision ID instead of 0, call loadRevisionData() first.
355 * @return int|false|null
357 public function getOldid() {
358 $this->loadRevisionIds();
360 return $this->mOldid
;
364 * Get the ID of new revision (right pane) of the diff. 0 for the current revision,
365 * false if the new revision does not exist, null if it's unsaved.
366 * To get a real revision ID instead of 0, call loadRevisionData() first.
367 * @return int|false|null
369 public function getNewid() {
370 $this->loadRevisionIds();
372 return $this->mNewid
;
376 * Get the left side of the diff.
377 * Could be null when the first revision of the page is diffed to 'prev' (or in the case of
379 * @return RevisionRecord|null
381 public function getOldRevision() {
382 return $this->mOldRev ?
$this->mOldRev
->getRevisionRecord() : null;
386 * Get the right side of the diff.
387 * Should not be null but can still happen in the case of load failure.
388 * @return RevisionRecord|null
390 public function getNewRevision() {
391 return $this->mNewRev ?
$this->mNewRev
->getRevisionRecord() : null;
395 * Look up a special:Undelete link to the given deleted revision id,
396 * as a workaround for being unable to load deleted diffs in currently.
398 * @param int $id Revision ID
400 * @return string|bool Link HTML or false
402 public function deletedLink( $id ) {
403 if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
404 $dbr = wfGetDB( DB_REPLICA
);
405 $arQuery = Revision
::getArchiveQueryInfo();
406 $row = $dbr->selectRow(
408 array_merge( $arQuery['fields'], [ 'ar_namespace', 'ar_title' ] ),
409 [ 'ar_rev_id' => $id ],
415 $rev = Revision
::newFromArchiveRow( $row );
416 $title = Title
::makeTitleSafe( $row->ar_namespace
, $row->ar_title
);
418 return SpecialPage
::getTitleFor( 'Undelete' )->getFullURL( [
419 'target' => $title->getPrefixedText(),
420 'timestamp' => $rev->getTimestamp()
429 * Build a wikitext link toward a deleted revision, if viewable.
431 * @param int $id Revision ID
433 * @return string Wikitext fragment
435 public function deletedIdMarker( $id ) {
436 $link = $this->deletedLink( $id );
438 return "[$link $id]";
444 private function showMissingRevision() {
445 $out = $this->getOutput();
448 if ( $this->mOldRev
=== null ||
449 ( $this->mOldRev
&& $this->mOldContent
=== null )
451 $missing[] = $this->deletedIdMarker( $this->mOldid
);
453 if ( $this->mNewRev
=== null ||
454 ( $this->mNewRev
&& $this->mNewContent
=== null )
456 $missing[] = $this->deletedIdMarker( $this->mNewid
);
459 $out->setPageTitle( $this->msg( 'errorpagetitle' ) );
460 $msg = $this->msg( 'difference-missing-revision' )
461 ->params( $this->getLanguage()->listToText( $missing ) )
462 ->numParams( count( $missing ) )
464 $out->addHTML( $msg );
467 public function showDiffPage( $diffOnly = false ) {
468 # Allow frames except in certain special cases
469 $out = $this->getOutput();
470 $out->allowClickjacking();
471 $out->setRobotPolicy( 'noindex,nofollow' );
473 // Allow extensions to add any extra output here
474 Hooks
::run( 'DifferenceEngineShowDiffPage', [ $out ] );
476 if ( !$this->loadRevisionData() ) {
477 if ( Hooks
::run( 'DifferenceEngineShowDiffPageMaybeShowMissingRevision', [ $this ] ) ) {
478 $this->showMissingRevision();
483 $user = $this->getUser();
485 if ( $this->mNewPage
) {
486 $permErrors = $this->mNewPage
->getUserPermissionsErrors( 'read', $user );
488 if ( $this->mOldPage
) {
489 $permErrors = wfMergeErrorArrays( $permErrors,
490 $this->mOldPage
->getUserPermissionsErrors( 'read', $user ) );
492 if ( count( $permErrors ) ) {
493 throw new PermissionsError( 'read', $permErrors );
499 # Carry over 'diffonly' param via navigation links
500 if ( $diffOnly != $user->getBoolOption( 'diffonly' ) ) {
501 $query['diffonly'] = $diffOnly;
503 # Cascade unhide param in links for easy deletion browsing
504 if ( $this->unhide
) {
505 $query['unhide'] = 1;
508 # Check if one of the revisions is deleted/suppressed
509 $deleted = $suppressed = false;
510 $allowed = $this->mNewRev
->userCan( Revision
::DELETED_TEXT
, $user );
514 # mOldRev is false if the difference engine is called with a "vague" query for
515 # a diff between a version V and its previous version V' AND the version V
516 # is the first version of that article. In that case, V' does not exist.
517 if ( $this->mOldRev
=== false ) {
518 if ( $this->mNewPage
) {
519 $out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage
->getPrefixedText() ) );
523 // Allow extensions to change the $oldHeader variable
524 Hooks
::run( 'DifferenceEngineOldHeaderNoOldRev', [ &$oldHeader ] );
526 Hooks
::run( 'DiffViewHeader', [ $this, $this->mOldRev
, $this->mNewRev
] );
528 if ( !$this->mOldPage ||
!$this->mNewPage
) {
529 // XXX say something to the user?
531 } elseif ( $this->mNewPage
->equals( $this->mOldPage
) ) {
532 $out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage
->getPrefixedText() ) );
535 $out->setPageTitle( $this->msg( 'difference-title-multipage',
536 $this->mOldPage
->getPrefixedText(), $this->mNewPage
->getPrefixedText() ) );
537 $out->addSubtitle( $this->msg( 'difference-multipage' ) );
541 if ( $samePage && $this->mNewPage
&& $this->mNewPage
->quickUserCan( 'edit', $user ) ) {
542 if ( $this->mNewRev
->isCurrent() && $this->mNewPage
->userCan( 'rollback', $user ) ) {
543 $rollbackLink = Linker
::generateRollback( $this->mNewRev
, $this->getContext() );
544 if ( $rollbackLink ) {
545 $out->preventClickjacking();
546 $rollback = "\u{00A0}\u{00A0}\u{00A0}" . $rollbackLink;
550 if ( !$this->mOldRev
->isDeleted( Revision
::DELETED_TEXT
) &&
551 !$this->mNewRev
->isDeleted( Revision
::DELETED_TEXT
)
553 $undoLink = Html
::element( 'a', [
554 'href' => $this->mNewPage
->getLocalURL( [
556 'undoafter' => $this->mOldid
,
557 'undo' => $this->mNewid
559 'title' => Linker
::titleAttrib( 'undo' ),
561 $this->msg( 'editundo' )->text()
563 $revisionTools['mw-diff-undo'] = $undoLink;
567 # Make "previous revision link"
568 if ( $samePage && $this->mOldPage
&& $this->mOldRev
->getPrevious() ) {
569 $prevlink = Linker
::linkKnown(
571 $this->msg( 'previousdiff' )->escaped(),
572 [ 'id' => 'differences-prevlink' ],
573 [ 'diff' => 'prev', 'oldid' => $this->mOldid
] +
$query
576 $prevlink = "\u{00A0}";
579 if ( $this->mOldRev
->isMinor() ) {
580 $oldminor = ChangesList
::flag( 'minor' );
585 $ldel = $this->revisionDeleteLink( $this->mOldRev
);
586 $oldRevisionHeader = $this->getRevisionHeader( $this->mOldRev
, 'complete' );
587 $oldChangeTags = ChangeTags
::formatSummaryRow( $this->mOldTags
, 'diff', $this->getContext() );
589 $oldHeader = '<div id="mw-diff-otitle1"><strong>' . $oldRevisionHeader . '</strong></div>' .
590 '<div id="mw-diff-otitle2">' .
591 Linker
::revUserTools( $this->mOldRev
, !$this->unhide
) . '</div>' .
592 '<div id="mw-diff-otitle3">' . $oldminor .
593 Linker
::revComment( $this->mOldRev
, !$diffOnly, !$this->unhide
) . $ldel . '</div>' .
594 '<div id="mw-diff-otitle5">' . $oldChangeTags[0] . '</div>' .
595 '<div id="mw-diff-otitle4">' . $prevlink . '</div>';
597 // Allow extensions to change the $oldHeader variable
598 Hooks
::run( 'DifferenceEngineOldHeader', [ $this, &$oldHeader, $prevlink, $oldminor,
599 $diffOnly, $ldel, $this->unhide
] );
601 if ( $this->mOldRev
->isDeleted( Revision
::DELETED_TEXT
) ) {
602 $deleted = true; // old revisions text is hidden
603 if ( $this->mOldRev
->isDeleted( Revision
::DELETED_RESTRICTED
) ) {
604 $suppressed = true; // also suppressed
608 # Check if this user can see the revisions
609 if ( !$this->mOldRev
->userCan( Revision
::DELETED_TEXT
, $user ) ) {
614 $out->addJsConfigVars( [
615 'wgDiffOldId' => $this->mOldid
,
616 'wgDiffNewId' => $this->mNewid
,
619 # Make "next revision link"
620 # Skip next link on the top revision
621 if ( $samePage && $this->mNewPage
&& !$this->mNewRev
->isCurrent() ) {
622 $nextlink = Linker
::linkKnown(
624 $this->msg( 'nextdiff' )->escaped(),
625 [ 'id' => 'differences-nextlink' ],
626 [ 'diff' => 'next', 'oldid' => $this->mNewid
] +
$query
629 $nextlink = "\u{00A0}";
632 if ( $this->mNewRev
->isMinor() ) {
633 $newminor = ChangesList
::flag( 'minor' );
638 # Handle RevisionDelete links...
639 $rdel = $this->revisionDeleteLink( $this->mNewRev
);
641 # Allow extensions to define their own revision tools
642 Hooks
::run( 'DiffRevisionTools',
643 [ $this->mNewRev
, &$revisionTools, $this->mOldRev
, $user ] );
644 $formattedRevisionTools = [];
645 // Put each one in parentheses (poor man's button)
646 foreach ( $revisionTools as $key => $tool ) {
647 $toolClass = is_string( $key ) ?
$key : 'mw-diff-tool';
648 $element = Html
::rawElement(
650 [ 'class' => $toolClass ],
651 $this->msg( 'parentheses' )->rawParams( $tool )->escaped()
653 $formattedRevisionTools[] = $element;
655 $newRevisionHeader = $this->getRevisionHeader( $this->mNewRev
, 'complete' ) .
656 ' ' . implode( ' ', $formattedRevisionTools );
657 $newChangeTags = ChangeTags
::formatSummaryRow( $this->mNewTags
, 'diff', $this->getContext() );
659 $newHeader = '<div id="mw-diff-ntitle1"><strong>' . $newRevisionHeader . '</strong></div>' .
660 '<div id="mw-diff-ntitle2">' . Linker
::revUserTools( $this->mNewRev
, !$this->unhide
) .
662 '<div id="mw-diff-ntitle3">' . $newminor .
663 Linker
::revComment( $this->mNewRev
, !$diffOnly, !$this->unhide
) . $rdel . '</div>' .
664 '<div id="mw-diff-ntitle5">' . $newChangeTags[0] . '</div>' .
665 '<div id="mw-diff-ntitle4">' . $nextlink . $this->markPatrolledLink() . '</div>';
667 // Allow extensions to change the $newHeader variable
668 Hooks
::run( 'DifferenceEngineNewHeader', [ $this, &$newHeader, $formattedRevisionTools,
669 $nextlink, $rollback, $newminor, $diffOnly, $rdel, $this->unhide
] );
671 if ( $this->mNewRev
->isDeleted( Revision
::DELETED_TEXT
) ) {
672 $deleted = true; // new revisions text is hidden
673 if ( $this->mNewRev
->isDeleted( Revision
::DELETED_RESTRICTED
) ) {
674 $suppressed = true; // also suppressed
678 # If the diff cannot be shown due to a deleted revision, then output
679 # the diff header and links to unhide (if available)...
680 if ( $deleted && ( !$this->unhide ||
!$allowed ) ) {
681 $this->showDiffStyle();
682 $multi = $this->getMultiNotice();
683 $out->addHTML( $this->addHeader( '', $oldHeader, $newHeader, $multi ) );
685 $msg = $suppressed ?
'rev-suppressed-no-diff' : 'rev-deleted-no-diff';
686 # Give explanation for why revision is not visible
687 $out->wrapWikiMsg( "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
690 # Give explanation and add a link to view the diff...
691 $query = $this->getRequest()->appendQueryValue( 'unhide', '1' );
692 $link = $this->getTitle()->getFullURL( $query );
693 $msg = $suppressed ?
'rev-suppressed-unhide-diff' : 'rev-deleted-unhide-diff';
695 "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
699 # Otherwise, output a regular diff...
701 # Add deletion notice if the user is viewing deleted content
704 $msg = $suppressed ?
'rev-suppressed-diff-view' : 'rev-deleted-diff-view';
705 $notice = "<div id='mw-$msg' class='mw-warning plainlinks'>\n" .
706 $this->msg( $msg )->parse() .
709 $this->showDiff( $oldHeader, $newHeader, $notice );
711 $this->renderNewRevision();
717 * Build a link to mark a change as patrolled.
719 * Returns empty string if there's either no revision to patrol or the user is not allowed to.
720 * Side effect: When the patrol link is build, this method will call
721 * OutputPage::preventClickjacking() and load mediawiki.page.patrol.ajax.
723 * @return string HTML or empty string
725 public function markPatrolledLink() {
726 if ( $this->mMarkPatrolledLink
=== null ) {
727 $linkInfo = $this->getMarkPatrolledLinkInfo();
728 // If false, there is no patrol link needed/allowed
729 if ( !$linkInfo ||
!$this->mNewPage
) {
730 $this->mMarkPatrolledLink
= '';
732 $this->mMarkPatrolledLink
= ' <span class="patrollink" data-mw="interface">[' .
735 $this->msg( 'markaspatrolleddiff' )->escaped(),
738 'action' => 'markpatrolled',
739 'rcid' => $linkInfo['rcid'],
742 // Allow extensions to change the markpatrolled link
743 Hooks
::run( 'DifferenceEngineMarkPatrolledLink', [ $this,
744 &$this->mMarkPatrolledLink
, $linkInfo['rcid'] ] );
747 return $this->mMarkPatrolledLink
;
751 * Returns an array of meta data needed to build a "mark as patrolled" link and
752 * adds the mediawiki.page.patrol.ajax to the output.
754 * @return array|false An array of meta data for a patrol link (rcid only)
755 * or false if no link is needed
757 protected function getMarkPatrolledLinkInfo() {
758 $user = $this->getUser();
759 $config = $this->getConfig();
761 // Prepare a change patrol link, if applicable
763 // Is patrolling enabled and the user allowed to?
764 $config->get( 'UseRCPatrol' ) &&
765 $this->mNewPage
&& $this->mNewPage
->quickUserCan( 'patrol', $user ) &&
766 // Only do this if the revision isn't more than 6 hours older
767 // than the Max RC age (6h because the RC might not be cleaned out regularly)
768 RecentChange
::isInRCLifespan( $this->mNewRev
->getTimestamp(), 21600 )
770 // Look for an unpatrolled change corresponding to this diff
771 $db = wfGetDB( DB_REPLICA
);
772 $change = RecentChange
::newFromConds(
774 'rc_timestamp' => $db->timestamp( $this->mNewRev
->getTimestamp() ),
775 'rc_this_oldid' => $this->mNewid
,
776 'rc_patrolled' => RecentChange
::PRC_UNPATROLLED
781 if ( $change && !$change->getPerformer()->equals( $user ) ) {
782 $rcid = $change->getAttribute( 'rc_id' );
784 // None found or the page has been created by the current user.
785 // If the user could patrol this it already would be patrolled
789 // Allow extensions to possibly change the rcid here
790 // For example the rcid might be set to zero due to the user
791 // being the same as the performer of the change but an extension
792 // might still want to show it under certain conditions
793 Hooks
::run( 'DifferenceEngineMarkPatrolledRCID', [ &$rcid, $this, $change, $user ] );
797 $this->getOutput()->preventClickjacking();
798 if ( $user->isAllowed( 'writeapi' ) ) {
799 $this->getOutput()->addModules( 'mediawiki.page.patrol.ajax' );
808 // No mark as patrolled link applicable
813 * @param Revision $rev
817 protected function revisionDeleteLink( $rev ) {
818 $link = Linker
::getRevDeleteLink( $this->getUser(), $rev, $rev->getTitle() );
819 if ( $link !== '' ) {
820 $link = "\u{00A0}\u{00A0}\u{00A0}" . $link . ' ';
827 * Show the new revision of the page.
829 * @note Not supported after calling setContent().
831 public function renderNewRevision() {
832 if ( $this->isContentOverridden
) {
833 // The code below only works with a Revision object. We could construct a fake revision
834 // (here or in setContent), but since this does not seem needed at the moment,
835 // we'll just fail for now.
836 throw new LogicException(
838 . ' is not supported after calling setContent(). Use setRevisions() instead.'
842 $out = $this->getOutput();
843 $revHeader = $this->getRevisionHeader( $this->mNewRev
);
844 # Add "current version as of X" title
845 $out->addHTML( "<hr class='diff-hr' id='mw-oldid' />
846 <h2 class='diff-currentversion-title'>{$revHeader}</h2>\n" );
847 # Page content may be handled by a hooked call instead...
848 if ( Hooks
::run( 'ArticleContentOnDiff', [ $this, $out ] ) ) {
849 $this->loadNewText();
850 if ( !$this->mNewPage
) {
851 // New revision is unsaved; bail out.
852 // TODO in theory rendering the new revision is a meaningful thing to do
853 // even if it's unsaved, but a lot of untangling is required to do it safely.
857 $out->setRevisionId( $this->mNewid
);
858 $out->setRevisionTimestamp( $this->mNewRev
->getTimestamp() );
859 $out->setArticleFlag( true );
861 if ( !Hooks
::run( 'ArticleRevisionViewCustom',
862 [ $this->mNewRev
->getRevisionRecord(), $this->mNewPage
, $out ] )
864 // Handled by extension
865 // NOTE: sync with hooks called in Article::view()
866 } elseif ( !Hooks
::run( 'ArticleContentViewCustom',
867 [ $this->mNewContent
, $this->mNewPage
, $out ], '1.32' )
869 // Handled by extension
870 // NOTE: sync with hooks called in Article::view()
873 if ( $this->getTitle()->equals( $this->mNewPage
) ) {
874 // If the Title stored in the context is the same as the one
875 // of the new revision, we can use its associated WikiPage
877 $wikiPage = $this->getWikiPage();
879 // Otherwise we need to create our own WikiPage object
880 $wikiPage = WikiPage
::factory( $this->mNewPage
);
883 $parserOutput = $this->getParserOutput( $wikiPage, $this->mNewRev
);
885 # WikiPage::getParserOutput() should not return false, but just in case
886 if ( $parserOutput ) {
887 // Allow extensions to change parser output here
888 if ( Hooks
::run( 'DifferenceEngineRenderRevisionAddParserOutput',
889 [ $this, $out, $parserOutput, $wikiPage ] )
891 $out->addParserOutput( $parserOutput, [
892 'enableSectionEditLinks' => $this->mNewRev
->isCurrent()
893 && $this->mNewRev
->getTitle()->quickUserCan( 'edit', $this->getUser() ),
900 // Allow extensions to optionally not show the final patrolled link
901 if ( Hooks
::run( 'DifferenceEngineRenderRevisionShowFinalPatrolLink' ) ) {
902 # Add redundant patrol link on bottom...
903 $out->addHTML( $this->markPatrolledLink() );
908 * @param WikiPage $page
909 * @param Revision $rev
911 * @return ParserOutput|bool False if the revision was not found
913 protected function getParserOutput( WikiPage
$page, Revision
$rev ) {
914 if ( !$rev->getId() ) {
915 // WikiPage::getParserOutput wants a revision ID. Passing 0 will incorrectly show
916 // the current revision, so fail instead. If need be, WikiPage::getParserOutput
917 // could be made to accept a Revision or RevisionRecord instead of the id.
921 $parserOptions = $page->makeParserOptions( $this->getContext() );
922 $parserOutput = $page->getParserOutput( $parserOptions, $rev->getId() );
924 return $parserOutput;
928 * Get the diff text, send it to the OutputPage object
929 * Returns false if the diff could not be generated, otherwise returns true
931 * @param string|bool $otitle Header for old text or false
932 * @param string|bool $ntitle Header for new text or false
933 * @param string $notice HTML between diff header and body
937 public function showDiff( $otitle, $ntitle, $notice = '' ) {
938 // Allow extensions to affect the output here
939 Hooks
::run( 'DifferenceEngineShowDiff', [ $this ] );
941 $diff = $this->getDiff( $otitle, $ntitle, $notice );
942 if ( $diff === false ) {
943 $this->showMissingRevision();
947 $this->showDiffStyle();
948 $this->getOutput()->addHTML( $diff );
955 * Add style sheets for diff display.
957 public function showDiffStyle() {
958 if ( !$this->isSlotDiffRenderer
) {
959 $this->getOutput()->addModuleStyles( [
960 'mediawiki.interface.helpers.styles',
961 'mediawiki.diff.styles'
963 foreach ( $this->getSlotDiffRenderers() as $slotDiffRenderer ) {
964 $slotDiffRenderer->addModules( $this->getOutput() );
970 * Get complete diff table, including header
972 * @param string|bool $otitle Header for old text or false
973 * @param string|bool $ntitle Header for new text or false
974 * @param string $notice HTML between diff header and body
978 public function getDiff( $otitle, $ntitle, $notice = '' ) {
979 $body = $this->getDiffBody();
980 if ( $body === false ) {
984 $multi = $this->getMultiNotice();
985 // Display a message when the diff is empty
986 if ( $body === '' ) {
987 $notice .= '<div class="mw-diff-empty">' .
988 $this->msg( 'diff-empty' )->parse() .
992 return $this->addHeader( $body, $otitle, $ntitle, $multi, $notice );
996 * Get the diff table body, without header
998 * @return mixed (string/false)
1000 public function getDiffBody() {
1001 $this->mCacheHit
= true;
1002 // Check if the diff should be hidden from this user
1003 if ( !$this->isContentOverridden
) {
1004 if ( !$this->loadRevisionData() ) {
1006 } elseif ( $this->mOldRev
&&
1007 !$this->mOldRev
->userCan( Revision
::DELETED_TEXT
, $this->getUser() )
1010 } elseif ( $this->mNewRev
&&
1011 !$this->mNewRev
->userCan( Revision
::DELETED_TEXT
, $this->getUser() )
1016 if ( $this->mOldRev
=== false ||
( $this->mOldRev
&& $this->mNewRev
&&
1017 $this->mOldRev
->getId() && $this->mOldRev
->getId() == $this->mNewRev
->getId() )
1019 if ( Hooks
::run( 'DifferenceEngineShowEmptyOldContent', [ $this ] ) ) {
1027 $cache = ObjectCache
::getMainWANInstance();
1028 if ( $this->mOldid
&& $this->mNewid
) {
1029 // Check if subclass is still using the old way
1030 // for backwards-compatibility
1031 $key = $this->getDiffBodyCacheKey();
1032 if ( $key === null ) {
1033 $key = $cache->makeKey( ...$this->getDiffBodyCacheKeyParams() );
1037 if ( !$this->mRefreshCache
) {
1038 $difftext = $cache->get( $key );
1039 if ( is_string( $difftext ) ) {
1040 wfIncrStats( 'diff_cache.hit' );
1041 $difftext = $this->localiseDiff( $difftext );
1042 $difftext .= "\n<!-- diff cache key $key -->\n";
1046 } // don't try to load but save the result
1048 $this->mCacheHit
= false;
1050 // Loadtext is permission safe, this just clears out the diff
1051 if ( !$this->loadText() ) {
1056 // We've checked for revdelete at the beginning of this method; it's OK to ignore
1057 // read permissions here.
1058 $slotContents = $this->getSlotContents();
1059 foreach ( $this->getSlotDiffRenderers() as $role => $slotDiffRenderer ) {
1060 $slotDiff = $slotDiffRenderer->getDiff( $slotContents[$role]['old'],
1061 $slotContents[$role]['new'] );
1062 if ( $slotDiff && $role !== SlotRecord
::MAIN
) {
1063 // FIXME: ask SlotRoleHandler::getSlotNameMessage
1065 $difftext .= $this->getSlotHeader( $slotTitle );
1067 $difftext .= $slotDiff;
1070 // Avoid PHP 7.1 warning from passing $this by reference
1071 $diffEngine = $this;
1073 // Save to cache for 7 days
1074 if ( !Hooks
::run( 'AbortDiffCache', [ &$diffEngine ] ) ) {
1075 wfIncrStats( 'diff_cache.uncacheable' );
1076 } elseif ( $key !== false && $difftext !== false ) {
1077 wfIncrStats( 'diff_cache.miss' );
1078 $cache->set( $key, $difftext, 7 * 86400 );
1080 wfIncrStats( 'diff_cache.uncacheable' );
1082 // localise line numbers and title attribute text
1083 if ( $difftext !== false ) {
1084 $difftext = $this->localiseDiff( $difftext );
1091 * Get the diff table body for one slot, without header
1093 * @param string $role
1094 * @return string|false
1096 public function getDiffBodyForRole( $role ) {
1097 $diffRenderers = $this->getSlotDiffRenderers();
1098 if ( !isset( $diffRenderers[$role] ) ) {
1102 $slotContents = $this->getSlotContents();
1103 $slotDiff = $diffRenderers[$role]->getDiff( $slotContents[$role]['old'],
1104 $slotContents[$role]['new'] );
1109 if ( $role !== SlotRecord
::MAIN
) {
1110 // TODO use human-readable role name at least
1112 $slotDiff = $this->getSlotHeader( $slotTitle ) . $slotDiff;
1115 return $this->localiseDiff( $slotDiff );
1119 * Get a slot header for inclusion in a diff body (as a table row).
1121 * @param string $headerText The text of the header
1125 protected function getSlotHeader( $headerText ) {
1126 // The old revision is missing on oldid=<first>&diff=prev; only 2 columns in that case.
1127 $columnCount = $this->mOldRev ?
4 : 2;
1128 $userLang = $this->getLanguage()->getHtmlCode();
1129 return Html
::rawElement( 'tr', [ 'class' => 'mw-diff-slot-header', 'lang' => $userLang ],
1130 Html
::element( 'th', [ 'colspan' => $columnCount ], $headerText ) );
1134 * Returns the cache key for diff body text or content.
1136 * @deprecated since 1.31, use getDiffBodyCacheKeyParams() instead
1139 * @throws MWException
1140 * @return string|null
1142 protected function getDiffBodyCacheKey() {
1147 * Get the cache key parameters
1149 * Subclasses can replace the first element in the array to something
1150 * more specific to the type of diff (e.g. "inline-diff"), or append
1151 * if the cache should vary on more things. Overriding entirely should
1157 * @throws MWException
1159 protected function getDiffBodyCacheKeyParams() {
1160 if ( !$this->mOldid ||
!$this->mNewid
) {
1161 throw new MWException( 'mOldid and mNewid must be set to get diff cache key.' );
1164 $engine = $this->getEngine();
1169 "old-{$this->mOldid}",
1170 "rev-{$this->mNewid}"
1173 if ( $engine === 'wikidiff2' ) {
1174 $params[] = phpversion( 'wikidiff2' );
1175 $params[] = $this->getConfig()->get( 'WikiDiff2MovedParagraphDetectionCutoff' );
1178 if ( !$this->isSlotDiffRenderer
) {
1179 foreach ( $this->getSlotDiffRenderers() as $slotDiffRenderer ) {
1180 $params = array_merge( $params, $slotDiffRenderer->getExtraCacheKeys() );
1188 * Implements DifferenceEngineSlotDiffRenderer::getExtraCacheKeys(). Only used when
1189 * DifferenceEngine is wrapped in DifferenceEngineSlotDiffRenderer.
1191 * @internal for use by DifferenceEngineSlotDiffRenderer only
1194 public function getExtraCacheKeys() {
1195 // This method is called when the DifferenceEngine is used for a slot diff. We only care
1196 // about special things, not the revision IDs, which are added to the cache key by the
1197 // page-level DifferenceEngine, and which might not have a valid value for this object.
1198 $this->mOldid
= 123456789;
1199 $this->mNewid
= 987654321;
1201 // This will repeat a bunch of unnecessary key fields for each slot. Not nice but harmless.
1202 $cacheString = $this->getDiffBodyCacheKey();
1203 if ( $cacheString ) {
1204 return [ $cacheString ];
1207 $params = $this->getDiffBodyCacheKeyParams();
1209 // Try to get rid of the standard keys to keep the cache key human-readable:
1210 // call the getDiffBodyCacheKeyParams implementation of the base class, and if
1211 // the child class includes the same keys, drop them.
1212 // Uses an obscure PHP feature where static calls to non-static methods are allowed
1213 // as long as we are already in a non-static method of the same class, and the call context
1214 // ($this) will be inherited.
1215 // phpcs:ignore Squiz.Classes.SelfMemberReference.NotUsed
1216 $standardParams = DifferenceEngine
::getDiffBodyCacheKeyParams();
1217 if ( array_slice( $params, 0, count( $standardParams ) ) === $standardParams ) {
1218 $params = array_slice( $params, count( $standardParams ) );
1225 * Generate a diff, no caching.
1229 * @param Content $old Old content
1230 * @param Content $new New content
1232 * @throws Exception If old or new content is not an instance of TextContent.
1233 * @return bool|string
1235 * @deprecated since 1.32, use a SlotDiffRenderer instead.
1237 public function generateContentDiffBody( Content
$old, Content
$new ) {
1238 $slotDiffRenderer = $new->getContentHandler()->getSlotDiffRenderer( $this->getContext() );
1240 $slotDiffRenderer instanceof DifferenceEngineSlotDiffRenderer
1241 && $this->isSlotDiffRenderer
1243 // Oops, we are just about to enter an infinite loop (the slot-level DifferenceEngine
1244 // called a DifferenceEngineSlotDiffRenderer that wraps the same DifferenceEngine class).
1245 // This will happen when a content model has no custom slot diff renderer, it does have
1246 // a custom difference engine, but that does not override this method.
1247 throw new Exception( get_class( $this ) . ': could not maintain backwards compatibility. '
1248 . 'Please use a SlotDiffRenderer.' );
1250 return $slotDiffRenderer->getDiff( $old, $new ) . $this->getDebugString();
1254 * Generate a diff, no caching
1256 * @param string $otext Old text, must be already segmented
1257 * @param string $ntext New text, must be already segmented
1259 * @throws Exception If content handling for text content is configured in a way
1260 * that makes maintaining B/C hard.
1261 * @return bool|string
1263 * @deprecated since 1.32, use a TextSlotDiffRenderer instead.
1265 public function generateTextDiffBody( $otext, $ntext ) {
1266 $slotDiffRenderer = ContentHandler
::getForModelID( CONTENT_MODEL_TEXT
)
1267 ->getSlotDiffRenderer( $this->getContext() );
1268 if ( !( $slotDiffRenderer instanceof TextSlotDiffRenderer
) ) {
1269 // Someone used the GetSlotDiffRenderer hook to replace the renderer.
1270 // This is too unlikely to happen to bother handling properly.
1271 throw new Exception( 'The slot diff renderer for text content should be a '
1272 . 'TextSlotDiffRenderer subclass' );
1274 return $slotDiffRenderer->getTextDiff( $otext, $ntext ) . $this->getDebugString();
1278 * Process $wgExternalDiffEngine and get a sane, usable engine
1280 * @return bool|string 'wikidiff2', path to an executable, or false
1281 * @internal For use by this class and TextSlotDiffRenderer only.
1283 public static function getEngine() {
1284 global $wgExternalDiffEngine;
1285 // We use the global here instead of Config because we write to the value,
1286 // and Config is not mutable.
1287 if ( $wgExternalDiffEngine == 'wikidiff' ||
$wgExternalDiffEngine == 'wikidiff3' ) {
1288 wfDeprecated( "\$wgExternalDiffEngine = '{$wgExternalDiffEngine}'", '1.27' );
1289 $wgExternalDiffEngine = false;
1290 } elseif ( $wgExternalDiffEngine == 'wikidiff2' ) {
1291 wfDeprecated( "\$wgExternalDiffEngine = '{$wgExternalDiffEngine}'", '1.32' );
1292 $wgExternalDiffEngine = false;
1293 } elseif ( !is_string( $wgExternalDiffEngine ) && $wgExternalDiffEngine !== false ) {
1294 // And prevent people from shooting themselves in the foot...
1295 wfWarn( '$wgExternalDiffEngine is set to a non-string value, forcing it to false' );
1296 $wgExternalDiffEngine = false;
1299 if ( is_string( $wgExternalDiffEngine ) && is_executable( $wgExternalDiffEngine ) ) {
1300 return $wgExternalDiffEngine;
1301 } elseif ( $wgExternalDiffEngine === false && function_exists( 'wikidiff2_do_diff' ) ) {
1310 * Generates diff, to be wrapped internally in a logging/instrumentation
1312 * @param string $otext Old text, must be already segmented
1313 * @param string $ntext New text, must be already segmented
1315 * @throws Exception If content handling for text content is configured in a way
1316 * that makes maintaining B/C hard.
1317 * @return bool|string
1319 * @deprecated since 1.32, use a TextSlotDiffRenderer instead.
1321 protected function textDiff( $otext, $ntext ) {
1322 $slotDiffRenderer = ContentHandler
::getForModelID( CONTENT_MODEL_TEXT
)
1323 ->getSlotDiffRenderer( $this->getContext() );
1324 if ( !( $slotDiffRenderer instanceof TextSlotDiffRenderer
) ) {
1325 // Someone used the GetSlotDiffRenderer hook to replace the renderer.
1326 // This is too unlikely to happen to bother handling properly.
1327 throw new Exception( 'The slot diff renderer for text content should be a '
1328 . 'TextSlotDiffRenderer subclass' );
1330 return $slotDiffRenderer->getTextDiff( $otext, $ntext ) . $this->getDebugString();
1334 * Generate a debug comment indicating diff generating time,
1335 * server node, and generator backend.
1337 * @param string $generator : What diff engine was used
1341 protected function debug( $generator = "internal" ) {
1342 if ( !$this->enableDebugComment
) {
1345 $data = [ $generator ];
1346 if ( $this->getConfig()->get( 'ShowHostnames' ) ) {
1347 $data[] = wfHostname();
1349 $data[] = wfTimestamp( TS_DB
);
1351 return "<!-- diff generator: " .
1352 implode( " ", array_map( "htmlspecialchars", $data ) ) .
1356 private function getDebugString() {
1357 $engine = self
::getEngine();
1358 if ( $engine === 'wikidiff2' ) {
1359 return $this->debug( 'wikidiff2' );
1360 } elseif ( $engine === false ) {
1361 return $this->debug( 'native PHP' );
1363 return $this->debug( "external $engine" );
1368 * Localise diff output
1370 * @param string $text
1373 private function localiseDiff( $text ) {
1374 $text = $this->localiseLineNumbers( $text );
1375 if ( $this->getEngine() === 'wikidiff2' &&
1376 version_compare( phpversion( 'wikidiff2' ), '1.5.1', '>=' )
1378 $text = $this->addLocalisedTitleTooltips( $text );
1384 * Replace line numbers with the text in the user's language
1386 * @param string $text
1390 public function localiseLineNumbers( $text ) {
1391 return preg_replace_callback(
1392 '/<!--LINE (\d+)-->/',
1393 [ $this, 'localiseLineNumbersCb' ],
1398 public function localiseLineNumbersCb( $matches ) {
1399 if ( $matches[1] === '1' && $this->mReducedLineNumbers
) {
1403 return $this->msg( 'lineno' )->numParams( $matches[1] )->escaped();
1407 * Add title attributes for tooltips on moved paragraph indicators
1409 * @param string $text
1412 private function addLocalisedTitleTooltips( $text ) {
1413 return preg_replace_callback(
1414 '/class="mw-diff-movedpara-(left|right)"/',
1415 [ $this, 'addLocalisedTitleTooltipsCb' ],
1421 * @param array $matches
1424 private function addLocalisedTitleTooltipsCb( array $matches ) {
1425 $key = $matches[1] === 'right' ?
1426 'diff-paragraph-moved-toold' :
1427 'diff-paragraph-moved-tonew';
1428 return $matches[0] . ' title="' . $this->msg( $key )->escaped() . '"';
1432 * If there are revisions between the ones being compared, return a note saying so.
1436 public function getMultiNotice() {
1437 // The notice only make sense if we are diffing two saved revisions of the same page.
1439 !$this->mOldRev ||
!$this->mNewRev
1440 ||
!$this->mOldPage ||
!$this->mNewPage
1441 ||
!$this->mOldPage
->equals( $this->mNewPage
)
1446 if ( $this->mOldRev
->getTimestamp() > $this->mNewRev
->getTimestamp() ) {
1447 $oldRev = $this->mNewRev
; // flip
1448 $newRev = $this->mOldRev
; // flip
1449 } else { // normal case
1450 $oldRev = $this->mOldRev
;
1451 $newRev = $this->mNewRev
;
1454 // Sanity: don't show the notice if too many rows must be scanned
1455 // @todo show some special message for that case
1456 $nEdits = $this->mNewPage
->countRevisionsBetween( $oldRev, $newRev, 1000 );
1457 if ( $nEdits > 0 && $nEdits <= 1000 ) {
1458 $limit = 100; // use diff-multi-manyusers if too many users
1459 $users = $this->mNewPage
->getAuthorsBetween( $oldRev, $newRev, $limit );
1460 $numUsers = count( $users );
1462 if ( $numUsers == 1 && $users[0] == $newRev->getUserText( Revision
::RAW
) ) {
1463 $numUsers = 0; // special case to say "by the same user" instead of "by one other user"
1466 return self
::intermediateEditsMsg( $nEdits, $numUsers, $limit );
1473 * Get a notice about how many intermediate edits and users there are
1475 * @param int $numEdits
1476 * @param int $numUsers
1481 public static function intermediateEditsMsg( $numEdits, $numUsers, $limit ) {
1482 if ( $numUsers === 0 ) {
1483 $msg = 'diff-multi-sameuser';
1484 } elseif ( $numUsers > $limit ) {
1485 $msg = 'diff-multi-manyusers';
1488 $msg = 'diff-multi-otherusers';
1491 return wfMessage( $msg )->numParams( $numEdits, $numUsers )->parse();
1495 * Get a header for a specified revision.
1497 * @param Revision $rev
1498 * @param string $complete 'complete' to get the header wrapped depending
1499 * the visibility of the revision and a link to edit the page.
1501 * @return string HTML fragment
1503 public function getRevisionHeader( Revision
$rev, $complete = '' ) {
1504 $lang = $this->getLanguage();
1505 $user = $this->getUser();
1506 $revtimestamp = $rev->getTimestamp();
1507 $timestamp = $lang->userTimeAndDate( $revtimestamp, $user );
1508 $dateofrev = $lang->userDate( $revtimestamp, $user );
1509 $timeofrev = $lang->userTime( $revtimestamp, $user );
1511 $header = $this->msg(
1512 $rev->isCurrent() ?
'currentrev-asof' : 'revisionasof',
1518 if ( $complete !== 'complete' ) {
1522 $title = $rev->getTitle();
1524 $header = Linker
::linkKnown( $title, $header, [],
1525 [ 'oldid' => $rev->getId() ] );
1527 if ( $rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
1528 $editQuery = [ 'action' => 'edit' ];
1529 if ( !$rev->isCurrent() ) {
1530 $editQuery['oldid'] = $rev->getId();
1533 $key = $title->quickUserCan( 'edit', $user ) ?
'editold' : 'viewsourceold';
1534 $msg = $this->msg( $key )->escaped();
1535 $editLink = $this->msg( 'parentheses' )->rawParams(
1536 Linker
::linkKnown( $title, $msg, [], $editQuery ) )->escaped();
1537 $header .= ' ' . Html
::rawElement(
1539 [ 'class' => 'mw-diff-edit' ],
1542 if ( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
1543 $header = Html
::rawElement(
1545 [ 'class' => 'history-deleted' ],
1550 $header = Html
::rawElement( 'span', [ 'class' => 'history-deleted' ], $header );
1557 * Add the header to a diff body
1559 * @param string $diff Diff body
1560 * @param string $otitle Old revision header
1561 * @param string $ntitle New revision header
1562 * @param string $multi Notice telling user that there are intermediate
1563 * revisions between the ones being compared
1564 * @param string $notice Other notices, e.g. that user is viewing deleted content
1568 public function addHeader( $diff, $otitle, $ntitle, $multi = '', $notice = '' ) {
1569 // shared.css sets diff in interface language/dir, but the actual content
1570 // is often in a different language, mostly the page content language/dir
1571 $header = Html
::openElement( 'table', [
1572 'class' => [ 'diff', 'diff-contentalign-' . $this->getDiffLang()->alignStart() ],
1573 'data-mw' => 'interface',
1575 $userLang = htmlspecialchars( $this->getLanguage()->getHtmlCode() );
1577 if ( !$diff && !$otitle ) {
1579 <tr class=\"diff-title\" lang=\"{$userLang}\">
1580 <td class=\"diff-ntitle\">{$ntitle}</td>
1584 if ( $diff ) { // Safari/Chrome show broken output if cols not used
1586 <col class=\"diff-marker\" />
1587 <col class=\"diff-content\" />
1588 <col class=\"diff-marker\" />
1589 <col class=\"diff-content\" />";
1596 if ( $otitle ||
$ntitle ) {
1598 <tr class=\"diff-title\" lang=\"{$userLang}\">
1599 <td colspan=\"$colspan\" class=\"diff-otitle\">{$otitle}</td>
1600 <td colspan=\"$colspan\" class=\"diff-ntitle\">{$ntitle}</td>
1605 if ( $multi != '' ) {
1606 $header .= "<tr><td colspan=\"{$multiColspan}\" " .
1607 "class=\"diff-multi\" lang=\"{$userLang}\">{$multi}</td></tr>";
1609 if ( $notice != '' ) {
1610 $header .= "<tr><td colspan=\"{$multiColspan}\" " .
1611 "class=\"diff-notice\" lang=\"{$userLang}\">{$notice}</td></tr>";
1614 return $header . $diff . "</table>";
1618 * Use specified text instead of loading from the database
1619 * @param Content $oldContent
1620 * @param Content $newContent
1622 * @deprecated since 1.32, use setRevisions or ContentHandler::getSlotDiffRenderer.
1624 public function setContent( Content
$oldContent, Content
$newContent ) {
1625 $this->mOldContent
= $oldContent;
1626 $this->mNewContent
= $newContent;
1628 $this->mTextLoaded
= 2;
1629 $this->mRevisionsLoaded
= true;
1630 $this->isContentOverridden
= true;
1631 $this->slotDiffRenderers
= null;
1635 * Use specified text instead of loading from the database.
1636 * @param RevisionRecord|null $oldRevision
1637 * @param RevisionRecord $newRevision
1639 public function setRevisions(
1640 RevisionRecord
$oldRevision = null, RevisionRecord
$newRevision
1642 if ( $oldRevision ) {
1643 $this->mOldRev
= new Revision( $oldRevision );
1644 $this->mOldid
= $oldRevision->getId();
1645 $this->mOldPage
= Title
::newFromLinkTarget( $oldRevision->getPageAsLinkTarget() );
1646 // This method is meant for edit diffs and such so there is no reason to provide a
1647 // revision that's not readable to the user, but check it just in case.
1648 $this->mOldContent
= $oldRevision->getContent( SlotRecord
::MAIN
,
1649 RevisionRecord
::FOR_THIS_USER
, $this->getUser() );
1651 $this->mOldPage
= null;
1652 $this->mOldRev
= $this->mOldid
= false;
1654 $this->mNewRev
= new Revision( $newRevision );
1655 $this->mNewid
= $newRevision->getId();
1656 $this->mNewPage
= Title
::newFromLinkTarget( $newRevision->getPageAsLinkTarget() );
1657 $this->mNewContent
= $newRevision->getContent( SlotRecord
::MAIN
,
1658 RevisionRecord
::FOR_THIS_USER
, $this->getUser() );
1660 $this->mRevisionsIdsLoaded
= $this->mRevisionsLoaded
= true;
1661 $this->mTextLoaded
= $oldRevision ?
2 : 1;
1662 $this->isContentOverridden
= false;
1663 $this->slotDiffRenderers
= null;
1667 * Set the language in which the diff text is written
1669 * @param Language $lang
1672 public function setTextLanguage( Language
$lang ) {
1673 $this->mDiffLang
= $lang;
1677 * Maps a revision pair definition as accepted by DifferenceEngine constructor
1678 * to a pair of actual integers representing revision ids.
1680 * @param int $old Revision id, e.g. from URL parameter 'oldid'
1681 * @param int|string $new Revision id or strings 'next' or 'prev', e.g. from URL parameter 'diff'
1683 * @return array List of two revision ids, older first, later second.
1684 * Zero signifies invalid argument passed.
1685 * false signifies that there is no previous/next revision ($old is the oldest/newest one).
1687 public function mapDiffPrevNext( $old, $new ) {
1688 if ( $new === 'prev' ) {
1689 // Show diff between revision $old and the previous one. Get previous one from DB.
1690 $newid = intval( $old );
1691 $oldid = $this->getTitle()->getPreviousRevisionID( $newid );
1692 } elseif ( $new === 'next' ) {
1693 // Show diff between revision $old and the next one. Get next one from DB.
1694 $oldid = intval( $old );
1695 $newid = $this->getTitle()->getNextRevisionID( $oldid );
1697 $oldid = intval( $old );
1698 $newid = intval( $new );
1701 return [ $oldid, $newid ];
1707 private function loadRevisionIds() {
1708 if ( $this->mRevisionsIdsLoaded
) {
1712 $this->mRevisionsIdsLoaded
= true;
1714 $old = $this->mOldid
;
1715 $new = $this->mNewid
;
1717 list( $this->mOldid
, $this->mNewid
) = self
::mapDiffPrevNext( $old, $new );
1718 if ( $new === 'next' && $this->mNewid
=== false ) {
1719 # if no result, NewId points to the newest old revision. The only newer
1720 # revision is cur, which is "0".
1725 'NewDifferenceEngine',
1726 [ $this->getTitle(), &$this->mOldid
, &$this->mNewid
, $old, $new ]
1731 * Load revision metadata for the specified revisions. If newid is 0, then compare
1732 * the old revision in oldid to the current revision of the current page (as defined
1733 * by the request context); if oldid is 0, then compare the revision in newid to the
1734 * immediately previous one.
1736 * If oldid is false, leave the corresponding revision object set
1737 * to false. This can happen with 'diff=prev' pointing to a non-existent revision,
1738 * and is also used directly by the API.
1740 * @return bool Whether both revisions were loaded successfully. Setting mOldRev
1741 * to false counts as successful loading.
1743 public function loadRevisionData() {
1744 if ( $this->mRevisionsLoaded
) {
1745 return $this->isContentOverridden ||
$this->mNewRev
&& !is_null( $this->mOldRev
);
1748 // Whether it succeeds or fails, we don't want to try again
1749 $this->mRevisionsLoaded
= true;
1751 $this->loadRevisionIds();
1753 // Load the new revision object
1754 if ( $this->mNewid
) {
1755 $this->mNewRev
= Revision
::newFromId( $this->mNewid
);
1757 $this->mNewRev
= Revision
::newFromTitle(
1760 Revision
::READ_NORMAL
1764 if ( !$this->mNewRev
instanceof Revision
) {
1768 // Update the new revision ID in case it was 0 (makes life easier doing UI stuff)
1769 $this->mNewid
= $this->mNewRev
->getId();
1770 if ( $this->mNewid
) {
1771 $this->mNewPage
= $this->mNewRev
->getTitle();
1773 $this->mNewPage
= null;
1776 // Load the old revision object
1777 $this->mOldRev
= false;
1778 if ( $this->mOldid
) {
1779 $this->mOldRev
= Revision
::newFromId( $this->mOldid
);
1780 } elseif ( $this->mOldid
=== 0 ) {
1781 $rev = $this->mNewRev
->getPrevious();
1783 $this->mOldid
= $rev->getId();
1784 $this->mOldRev
= $rev;
1786 // No previous revision; mark to show as first-version only.
1787 $this->mOldid
= false;
1788 $this->mOldRev
= false;
1790 } /* elseif ( $this->mOldid === false ) leave mOldRev false; */
1792 if ( is_null( $this->mOldRev
) ) {
1796 if ( $this->mOldRev
&& $this->mOldRev
->getId() ) {
1797 $this->mOldPage
= $this->mOldRev
->getTitle();
1799 $this->mOldPage
= null;
1802 // Load tags information for both revisions
1803 $dbr = wfGetDB( DB_REPLICA
);
1804 $changeTagDefStore = MediaWikiServices
::getInstance()->getChangeTagDefStore();
1805 if ( $this->mOldid
!== false ) {
1806 $tagIds = $dbr->selectFieldValues(
1809 [ 'ct_rev_id' => $this->mOldid
],
1813 foreach ( $tagIds as $tagId ) {
1815 $tags[] = $changeTagDefStore->getName( (int)$tagId );
1816 } catch ( NameTableAccessException
$exception ) {
1820 $this->mOldTags
= implode( ',', $tags );
1822 $this->mOldTags
= false;
1825 $tagIds = $dbr->selectFieldValues(
1828 [ 'ct_rev_id' => $this->mNewid
],
1832 foreach ( $tagIds as $tagId ) {
1834 $tags[] = $changeTagDefStore->getName( (int)$tagId );
1835 } catch ( NameTableAccessException
$exception ) {
1839 $this->mNewTags
= implode( ',', $tags );
1845 * Load the text of the revisions, as well as revision data.
1846 * When the old revision is missing (mOldRev is false), loading mOldContent is not attempted.
1848 * @return bool Whether the content of both revisions could be loaded successfully.
1849 * (When mOldRev is false, that still counts as a success.)
1852 public function loadText() {
1853 if ( $this->mTextLoaded
== 2 ) {
1854 return $this->loadRevisionData() && ( $this->mOldRev
=== false ||
$this->mOldContent
)
1855 && $this->mNewContent
;
1858 // Whether it succeeds or fails, we don't want to try again
1859 $this->mTextLoaded
= 2;
1861 if ( !$this->loadRevisionData() ) {
1865 if ( $this->mOldRev
) {
1866 $this->mOldContent
= $this->mOldRev
->getContent( Revision
::FOR_THIS_USER
, $this->getUser() );
1867 if ( $this->mOldContent
=== null ) {
1872 $this->mNewContent
= $this->mNewRev
->getContent( Revision
::FOR_THIS_USER
, $this->getUser() );
1873 Hooks
::run( 'DifferenceEngineLoadTextAfterNewContentIsLoaded', [ $this ] );
1874 if ( $this->mNewContent
=== null ) {
1882 * Load the text of the new revision, not the old one
1884 * @return bool Whether the content of the new revision could be loaded successfully.
1886 public function loadNewText() {
1887 if ( $this->mTextLoaded
>= 1 ) {
1888 return $this->loadRevisionData();
1891 $this->mTextLoaded
= 1;
1893 if ( !$this->loadRevisionData() ) {
1897 $this->mNewContent
= $this->mNewRev
->getContent( Revision
::FOR_THIS_USER
, $this->getUser() );
1899 Hooks
::run( 'DifferenceEngineAfterLoadNewText', [ $this ] );