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\Storage\RevisionRecord
;
27 * DifferenceEngine is responsible for rendering the difference between two revisions as HTML.
28 * This includes interpreting URL parameters, retrieving revision data, checking access permissions,
29 * selecting and invoking the diff generator class for the individual slots, doing post-processing
30 * on the generated diff, adding the rest of the HTML (such as headers) and writing the whole thing
33 * DifferenceEngine can be subclassed by extensions, by customizing
34 * ContentHandler::createDifferenceEngine; the content handler will be selected based on the
35 * content model of the main slot (of the new revision, when the two are different).
36 * That might change after PageTypeHandler gets introduced.
38 * In the past, the class was also used for slot-level diff generation, and extensions might still
39 * subclass it and add such functionality. When that is the case (sepcifically, when a
40 * ContentHandler returns a standard SlotDiffRenderer but a nonstandard DifferenceEngine)
41 * DifferenceEngineSlotDiffRenderer will be used to convert the old behavior into the new one.
43 * @ingroup DifferenceEngine
45 * @todo This class is huge and poorly defined. It should be split into a controller responsible
46 * for interpreting query parameters, retrieving data and checking permissions; and a HTML renderer.
48 class DifferenceEngine
extends ContextSource
{
50 use DeprecationHelper
;
53 * Constant to indicate diff cache compatibility.
54 * Bump this when changing the diff formatting in a way that
55 * fixes important bugs or such to force cached diff views to
58 const DIFF_VERSION
= '1.12';
61 * Revision ID for the old revision. 0 for the revision previous to $mNewid, false
62 * if the diff does not have an old revision (e.g. 'oldid=<first revision of page>&diff=prev'),
63 * or the revision does not exist, null if the revision is unsaved.
69 * Revision ID for the new revision. 0 for the last revision of the current page
70 * (as defined by the request context), false if the revision does not exist, null
71 * if it is unsaved, or an alias such as 'next'.
72 * @var int|string|false|null
77 * Old revision (left pane).
78 * Allowed to be an unsaved revision, unlikely that's ever needed though.
79 * False when the old revision does not exist; this can happen when using
80 * diff=prev on the first revision. Null when the revision should exist but
81 * doesn't (e.g. load failure); loadRevisionData() will return false in that
82 * case. Also null until lazy-loaded. Ignored completely when isContentOverridden
84 * Since 1.32 public access is deprecated.
85 * @var Revision|null|false
90 * New revision (right pane).
91 * Note that this might be an unsaved revision (e.g. for edit preview).
92 * Null in case of load failure; diff methods will just return an error message in that case,
93 * and loadRevisionData() will return false. Also null until lazy-loaded. Ignored completely
94 * when isContentOverridden is set.
95 * Since 1.32 public access is deprecated.
101 * Title of $mOldRev or null if the old revision does not exist or does not belong to a page.
102 * Since 1.32 public access is deprecated and the property can be null.
108 * Title of $mNewRev or null if the new revision does not exist or does not belong to a page.
109 * Since 1.32 public access is deprecated and the property can be null.
115 * Change tags of $mOldRev or null if it does not exist / is not saved.
121 * Change tags of $mNewRev or null if it does not exist / is not saved.
128 * @deprecated since 1.32, content slots are now handled by the corresponding SlotDiffRenderer.
129 * This property is set to the content of the main slot, but not actually used for the main diff.
131 private $mOldContent;
135 * @deprecated since 1.32, content slots are now handled by the corresponding SlotDiffRenderer.
136 * This property is set to the content of the main slot, but not actually used for the main diff.
138 private $mNewContent;
141 protected $mDiffLang;
143 /** @var bool Have the revisions IDs been loaded */
144 private $mRevisionsIdsLoaded = false;
146 /** @var bool Have the revisions been loaded */
147 protected $mRevisionsLoaded = false;
149 /** @var int How many text blobs have been loaded, 0, 1 or 2? */
150 protected $mTextLoaded = 0;
153 * Was the content overridden via setContent()?
154 * If the content was overridden, most internal state (e.g. mOldid or mOldRev) should be ignored
155 * and only mOldContent and mNewContent is reliable.
156 * (Note that setRevisions() does not set this flag as in that case all properties are
157 * overriden and remain consistent with each other, so no special handling is needed.)
160 protected $isContentOverridden = false;
162 /** @var bool Was the diff fetched from cache? */
163 protected $mCacheHit = false;
166 * Set this to true to add debug info to the HTML output.
167 * Warning: this may cause RSS readers to spuriously mark articles as "new"
170 public $enableDebugComment = false;
172 /** @var bool If true, line X is not displayed when X is 1, for example
173 * to increase readability and conserve space with many small diffs.
175 protected $mReducedLineNumbers = false;
177 /** @var string Link to action=markpatrolled */
178 protected $mMarkPatrolledLink = null;
180 /** @var bool Show rev_deleted content if allowed */
181 protected $unhide = false;
183 /** @var bool Refresh the diff cache */
184 protected $mRefreshCache = false;
186 /** @var SlotDiffRenderer[] DifferenceEngine classes for the slots, keyed by role name. */
187 protected $slotDiffRenderers = null;
190 * Temporary hack for B/C while slot diff related methods of DifferenceEngine are being
191 * deprecated. When true, we are inside a DifferenceEngineSlotDiffRenderer and
192 * $slotDiffRenderers should not be used.
195 protected $isSlotDiffRenderer = false;
200 * @param IContextSource|null $context Context to use, anything else will be ignored
201 * @param int $old Old ID we want to show and diff with.
202 * @param string|int $new Either revision ID or 'prev' or 'next'. Default: 0.
203 * @param int $rcid Deprecated, no longer used!
204 * @param bool $refreshCache If set, refreshes the diff cache
205 * @param bool $unhide If set, allow viewing deleted revs
207 public function __construct( $context = null, $old = 0, $new = 0, $rcid = 0,
208 $refreshCache = false, $unhide = false
210 $this->deprecatePublicProperty( 'mOldid', '1.32', __CLASS__
);
211 $this->deprecatePublicProperty( 'mNewid', '1.32', __CLASS__
);
212 $this->deprecatePublicProperty( 'mOldRev', '1.32', __CLASS__
);
213 $this->deprecatePublicProperty( 'mNewRev', '1.32', __CLASS__
);
214 $this->deprecatePublicProperty( 'mOldPage', '1.32', __CLASS__
);
215 $this->deprecatePublicProperty( 'mNewPage', '1.32', __CLASS__
);
216 $this->deprecatePublicProperty( 'mOldContent', '1.32', __CLASS__
);
217 $this->deprecatePublicProperty( 'mNewContent', '1.32', __CLASS__
);
218 $this->deprecatePublicProperty( 'mRevisionsLoaded', '1.32', __CLASS__
);
219 $this->deprecatePublicProperty( 'mTextLoaded', '1.32', __CLASS__
);
220 $this->deprecatePublicProperty( 'mCacheHit', '1.32', __CLASS__
);
222 if ( $context instanceof IContextSource
) {
223 $this->setContext( $context );
226 wfDebug( "DifferenceEngine old '$old' new '$new' rcid '$rcid'\n" );
228 $this->mOldid
= $old;
229 $this->mNewid
= $new;
230 $this->mRefreshCache
= $refreshCache;
231 $this->unhide
= $unhide;
235 * @return SlotDiffRenderer[] Diff renderers for each slot, keyed by role name.
236 * Includes slots only present in one of the revisions.
238 protected function getSlotDiffRenderers() {
239 if ( $this->isSlotDiffRenderer
) {
240 throw new LogicException( __METHOD__
. ' called in slot diff renderer mode' );
243 if ( $this->slotDiffRenderers
=== null ) {
244 if ( !$this->loadRevisionData() ) {
248 $slotContents = $this->getSlotContents();
249 $this->slotDiffRenderers
= array_map( function ( $contents ) {
250 /** @var $content Content */
251 $content = $contents['new'] ?
: $contents['old'];
252 return $content->getContentHandler()->getSlotDiffRenderer( $this->getContext() );
255 return $this->slotDiffRenderers
;
259 * Mark this DifferenceEngine as a slot renderer (as opposed to a page renderer).
260 * This is used in legacy mode when the DifferenceEngine is wrapped in a
261 * DifferenceEngineSlotDiffRenderer.
262 * @internal For use by DifferenceEngineSlotDiffRenderer only.
264 public function markAsSlotDiffRenderer() {
265 $this->isSlotDiffRenderer
= true;
269 * Get the old and new content objects for all slots.
270 * This method does not do any permission checks.
271 * @return array [ role => [ 'old' => SlotRecord|null, 'new' => SlotRecord|null ], ... ]
273 protected function getSlotContents() {
274 if ( $this->isContentOverridden
) {
277 'old' => $this->mOldContent
,
278 'new' => $this->mNewContent
,
281 } elseif ( !$this->loadRevisionData() ) {
285 $newSlots = $this->mNewRev
->getRevisionRecord()->getSlots()->getSlots();
286 if ( $this->mOldRev
) {
287 $oldSlots = $this->mOldRev
->getRevisionRecord()->getSlots()->getSlots();
291 // The order here will determine the visual order of the diff. The current logic is
292 // slots of the new revision first in natural order, then deleted ones. This is ad hoc
293 // and should not be relied on - in the future we may want the ordering to depend
295 $roles = array_merge( array_keys( $newSlots ), array_keys( $oldSlots ) );
298 foreach ( $roles as $role ) {
300 'old' => isset( $oldSlots[$role] ) ?
$oldSlots[$role]->getContent() : null,
301 'new' => isset( $newSlots[$role] ) ?
$newSlots[$role]->getContent() : null,
304 // move main slot to front
305 if ( isset( $slots['main'] ) ) {
306 $slots = [ 'main' => $slots['main'] ] +
$slots;
311 public function getTitle() {
312 // T202454 avoid errors when there is no title
313 return parent
::getTitle() ?
: Title
::makeTitle( NS_SPECIAL
, 'BadTitle/DifferenceEngine' );
317 * Set reduced line numbers mode.
318 * When set, line X is not displayed when X is 1, for example to increase readability and
319 * conserve space with many small diffs.
322 public function setReducedLineNumbers( $value = true ) {
323 $this->mReducedLineNumbers
= $value;
327 * Get the language of the difference engine, defaults to page content language
331 public function getDiffLang() {
332 if ( $this->mDiffLang
=== null ) {
333 # Default language in which the diff text is written.
334 $this->mDiffLang
= $this->getTitle()->getPageLanguage();
337 return $this->mDiffLang
;
343 public function wasCacheHit() {
344 return $this->mCacheHit
;
348 * Get the ID of old revision (left pane) of the diff. 0 for the revision
349 * previous to getNewid(), false if the old revision does not exist, null
351 * To get a real revision ID instead of 0, call loadRevisionData() first.
352 * @return int|false|null
354 public function getOldid() {
355 $this->loadRevisionIds();
357 return $this->mOldid
;
361 * Get the ID of new revision (right pane) of the diff. 0 for the current revision,
362 * false if the new revision does not exist, null if it's unsaved.
363 * To get a real revision ID instead of 0, call loadRevisionData() first.
364 * @return int|false|null
366 public function getNewid() {
367 $this->loadRevisionIds();
369 return $this->mNewid
;
373 * Get the left side of the diff.
374 * Could be null when the first revision of the page is diffed to 'prev' (or in the case of
376 * @return RevisionRecord|null
378 public function getOldRevision() {
379 return $this->mOldRev ?
$this->mOldRev
->getRevisionRecord() : null;
383 * Get the right side of the diff.
384 * Should not be null but can still happen in the case of load failure.
385 * @return RevisionRecord|null
387 public function getNewRevision() {
388 return $this->mNewRev ?
$this->mNewRev
->getRevisionRecord() : null;
392 * Look up a special:Undelete link to the given deleted revision id,
393 * as a workaround for being unable to load deleted diffs in currently.
395 * @param int $id Revision ID
397 * @return string|bool Link HTML or false
399 public function deletedLink( $id ) {
400 if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
401 $dbr = wfGetDB( DB_REPLICA
);
402 $arQuery = Revision
::getArchiveQueryInfo();
403 $row = $dbr->selectRow(
405 array_merge( $arQuery['fields'], [ 'ar_namespace', 'ar_title' ] ),
406 [ 'ar_rev_id' => $id ],
412 $rev = Revision
::newFromArchiveRow( $row );
413 $title = Title
::makeTitleSafe( $row->ar_namespace
, $row->ar_title
);
415 return SpecialPage
::getTitleFor( 'Undelete' )->getFullURL( [
416 'target' => $title->getPrefixedText(),
417 'timestamp' => $rev->getTimestamp()
426 * Build a wikitext link toward a deleted revision, if viewable.
428 * @param int $id Revision ID
430 * @return string Wikitext fragment
432 public function deletedIdMarker( $id ) {
433 $link = $this->deletedLink( $id );
435 return "[$link $id]";
441 private function showMissingRevision() {
442 $out = $this->getOutput();
445 if ( $this->mOldRev
=== null ||
446 ( $this->mOldRev
&& $this->mOldContent
=== null )
448 $missing[] = $this->deletedIdMarker( $this->mOldid
);
450 if ( $this->mNewRev
=== null ||
451 ( $this->mNewRev
&& $this->mNewContent
=== null )
453 $missing[] = $this->deletedIdMarker( $this->mNewid
);
456 $out->setPageTitle( $this->msg( 'errorpagetitle' ) );
457 $msg = $this->msg( 'difference-missing-revision' )
458 ->params( $this->getLanguage()->listToText( $missing ) )
459 ->numParams( count( $missing ) )
461 $out->addHTML( $msg );
464 public function showDiffPage( $diffOnly = false ) {
465 # Allow frames except in certain special cases
466 $out = $this->getOutput();
467 $out->allowClickjacking();
468 $out->setRobotPolicy( 'noindex,nofollow' );
470 // Allow extensions to add any extra output here
471 Hooks
::run( 'DifferenceEngineShowDiffPage', [ $out ] );
473 if ( !$this->loadRevisionData() ) {
474 if ( Hooks
::run( 'DifferenceEngineShowDiffPageMaybeShowMissingRevision', [ $this ] ) ) {
475 $this->showMissingRevision();
480 $user = $this->getUser();
482 if ( $this->mNewPage
) {
483 $permErrors = $this->mNewPage
->getUserPermissionsErrors( 'read', $user );
485 if ( $this->mOldPage
) {
486 $permErrors = wfMergeErrorArrays( $permErrors,
487 $this->mOldPage
->getUserPermissionsErrors( 'read', $user ) );
489 if ( count( $permErrors ) ) {
490 throw new PermissionsError( 'read', $permErrors );
496 # Carry over 'diffonly' param via navigation links
497 if ( $diffOnly != $user->getBoolOption( 'diffonly' ) ) {
498 $query['diffonly'] = $diffOnly;
500 # Cascade unhide param in links for easy deletion browsing
501 if ( $this->unhide
) {
502 $query['unhide'] = 1;
505 # Check if one of the revisions is deleted/suppressed
506 $deleted = $suppressed = false;
507 $allowed = $this->mNewRev
->userCan( Revision
::DELETED_TEXT
, $user );
511 # mOldRev is false if the difference engine is called with a "vague" query for
512 # a diff between a version V and its previous version V' AND the version V
513 # is the first version of that article. In that case, V' does not exist.
514 if ( $this->mOldRev
=== false ) {
515 if ( $this->mNewPage
) {
516 $out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage
->getPrefixedText() ) );
520 // Allow extensions to change the $oldHeader variable
521 Hooks
::run( 'DifferenceEngineOldHeaderNoOldRev', [ &$oldHeader ] );
523 Hooks
::run( 'DiffViewHeader', [ $this, $this->mOldRev
, $this->mNewRev
] );
525 if ( !$this->mOldPage ||
!$this->mNewPage
) {
526 // XXX say something to the user?
528 } elseif ( $this->mNewPage
->equals( $this->mOldPage
) ) {
529 $out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage
->getPrefixedText() ) );
532 $out->setPageTitle( $this->msg( 'difference-title-multipage',
533 $this->mOldPage
->getPrefixedText(), $this->mNewPage
->getPrefixedText() ) );
534 $out->addSubtitle( $this->msg( 'difference-multipage' ) );
538 if ( $samePage && $this->mNewPage
&& $this->mNewPage
->quickUserCan( 'edit', $user ) ) {
539 if ( $this->mNewRev
->isCurrent() && $this->mNewPage
->userCan( 'rollback', $user ) ) {
540 $rollbackLink = Linker
::generateRollback( $this->mNewRev
, $this->getContext() );
541 if ( $rollbackLink ) {
542 $out->preventClickjacking();
543 $rollback = "\u{00A0}\u{00A0}\u{00A0}" . $rollbackLink;
547 if ( !$this->mOldRev
->isDeleted( Revision
::DELETED_TEXT
) &&
548 !$this->mNewRev
->isDeleted( Revision
::DELETED_TEXT
)
550 $undoLink = Html
::element( 'a', [
551 'href' => $this->mNewPage
->getLocalURL( [
553 'undoafter' => $this->mOldid
,
554 'undo' => $this->mNewid
556 'title' => Linker
::titleAttrib( 'undo' ),
558 $this->msg( 'editundo' )->text()
560 $revisionTools['mw-diff-undo'] = $undoLink;
564 # Make "previous revision link"
565 if ( $samePage && $this->mOldPage
&& $this->mOldRev
->getPrevious() ) {
566 $prevlink = Linker
::linkKnown(
568 $this->msg( 'previousdiff' )->escaped(),
569 [ 'id' => 'differences-prevlink' ],
570 [ 'diff' => 'prev', 'oldid' => $this->mOldid
] +
$query
573 $prevlink = "\u{00A0}";
576 if ( $this->mOldRev
->isMinor() ) {
577 $oldminor = ChangesList
::flag( 'minor' );
582 $ldel = $this->revisionDeleteLink( $this->mOldRev
);
583 $oldRevisionHeader = $this->getRevisionHeader( $this->mOldRev
, 'complete' );
584 $oldChangeTags = ChangeTags
::formatSummaryRow( $this->mOldTags
, 'diff', $this->getContext() );
586 $oldHeader = '<div id="mw-diff-otitle1"><strong>' . $oldRevisionHeader . '</strong></div>' .
587 '<div id="mw-diff-otitle2">' .
588 Linker
::revUserTools( $this->mOldRev
, !$this->unhide
) . '</div>' .
589 '<div id="mw-diff-otitle3">' . $oldminor .
590 Linker
::revComment( $this->mOldRev
, !$diffOnly, !$this->unhide
) . $ldel . '</div>' .
591 '<div id="mw-diff-otitle5">' . $oldChangeTags[0] . '</div>' .
592 '<div id="mw-diff-otitle4">' . $prevlink . '</div>';
594 // Allow extensions to change the $oldHeader variable
595 Hooks
::run( 'DifferenceEngineOldHeader', [ $this, &$oldHeader, $prevlink, $oldminor,
596 $diffOnly, $ldel, $this->unhide
] );
598 if ( $this->mOldRev
->isDeleted( Revision
::DELETED_TEXT
) ) {
599 $deleted = true; // old revisions text is hidden
600 if ( $this->mOldRev
->isDeleted( Revision
::DELETED_RESTRICTED
) ) {
601 $suppressed = true; // also suppressed
605 # Check if this user can see the revisions
606 if ( !$this->mOldRev
->userCan( Revision
::DELETED_TEXT
, $user ) ) {
611 $out->addJsConfigVars( [
612 'wgDiffOldId' => $this->mOldid
,
613 'wgDiffNewId' => $this->mNewid
,
616 # Make "next revision link"
617 # Skip next link on the top revision
618 if ( $samePage && $this->mNewPage
&& !$this->mNewRev
->isCurrent() ) {
619 $nextlink = Linker
::linkKnown(
621 $this->msg( 'nextdiff' )->escaped(),
622 [ 'id' => 'differences-nextlink' ],
623 [ 'diff' => 'next', 'oldid' => $this->mNewid
] +
$query
626 $nextlink = "\u{00A0}";
629 if ( $this->mNewRev
->isMinor() ) {
630 $newminor = ChangesList
::flag( 'minor' );
635 # Handle RevisionDelete links...
636 $rdel = $this->revisionDeleteLink( $this->mNewRev
);
638 # Allow extensions to define their own revision tools
639 Hooks
::run( 'DiffRevisionTools',
640 [ $this->mNewRev
, &$revisionTools, $this->mOldRev
, $user ] );
641 $formattedRevisionTools = [];
642 // Put each one in parentheses (poor man's button)
643 foreach ( $revisionTools as $key => $tool ) {
644 $toolClass = is_string( $key ) ?
$key : 'mw-diff-tool';
645 $element = Html
::rawElement(
647 [ 'class' => $toolClass ],
648 $this->msg( 'parentheses' )->rawParams( $tool )->escaped()
650 $formattedRevisionTools[] = $element;
652 $newRevisionHeader = $this->getRevisionHeader( $this->mNewRev
, 'complete' ) .
653 ' ' . implode( ' ', $formattedRevisionTools );
654 $newChangeTags = ChangeTags
::formatSummaryRow( $this->mNewTags
, 'diff', $this->getContext() );
656 $newHeader = '<div id="mw-diff-ntitle1"><strong>' . $newRevisionHeader . '</strong></div>' .
657 '<div id="mw-diff-ntitle2">' . Linker
::revUserTools( $this->mNewRev
, !$this->unhide
) .
659 '<div id="mw-diff-ntitle3">' . $newminor .
660 Linker
::revComment( $this->mNewRev
, !$diffOnly, !$this->unhide
) . $rdel . '</div>' .
661 '<div id="mw-diff-ntitle5">' . $newChangeTags[0] . '</div>' .
662 '<div id="mw-diff-ntitle4">' . $nextlink . $this->markPatrolledLink() . '</div>';
664 // Allow extensions to change the $newHeader variable
665 Hooks
::run( 'DifferenceEngineNewHeader', [ $this, &$newHeader, $formattedRevisionTools,
666 $nextlink, $rollback, $newminor, $diffOnly, $rdel, $this->unhide
] );
668 if ( $this->mNewRev
->isDeleted( Revision
::DELETED_TEXT
) ) {
669 $deleted = true; // new revisions text is hidden
670 if ( $this->mNewRev
->isDeleted( Revision
::DELETED_RESTRICTED
) ) {
671 $suppressed = true; // also suppressed
675 # If the diff cannot be shown due to a deleted revision, then output
676 # the diff header and links to unhide (if available)...
677 if ( $deleted && ( !$this->unhide ||
!$allowed ) ) {
678 $this->showDiffStyle();
679 $multi = $this->getMultiNotice();
680 $out->addHTML( $this->addHeader( '', $oldHeader, $newHeader, $multi ) );
682 $msg = $suppressed ?
'rev-suppressed-no-diff' : 'rev-deleted-no-diff';
683 # Give explanation for why revision is not visible
684 $out->wrapWikiMsg( "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
687 # Give explanation and add a link to view the diff...
688 $query = $this->getRequest()->appendQueryValue( 'unhide', '1' );
689 $link = $this->getTitle()->getFullURL( $query );
690 $msg = $suppressed ?
'rev-suppressed-unhide-diff' : 'rev-deleted-unhide-diff';
692 "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
696 # Otherwise, output a regular diff...
698 # Add deletion notice if the user is viewing deleted content
701 $msg = $suppressed ?
'rev-suppressed-diff-view' : 'rev-deleted-diff-view';
702 $notice = "<div id='mw-$msg' class='mw-warning plainlinks'>\n" .
703 $this->msg( $msg )->parse() .
706 $this->showDiff( $oldHeader, $newHeader, $notice );
708 $this->renderNewRevision();
714 * Build a link to mark a change as patrolled.
716 * Returns empty string if there's either no revision to patrol or the user is not allowed to.
717 * Side effect: When the patrol link is build, this method will call
718 * OutputPage::preventClickjacking() and load mediawiki.page.patrol.ajax.
720 * @return string HTML or empty string
722 public function markPatrolledLink() {
723 if ( $this->mMarkPatrolledLink
=== null ) {
724 $linkInfo = $this->getMarkPatrolledLinkInfo();
725 // If false, there is no patrol link needed/allowed
726 if ( !$linkInfo ||
!$this->mNewPage
) {
727 $this->mMarkPatrolledLink
= '';
729 $this->mMarkPatrolledLink
= ' <span class="patrollink" data-mw="interface">[' .
732 $this->msg( 'markaspatrolleddiff' )->escaped(),
735 'action' => 'markpatrolled',
736 'rcid' => $linkInfo['rcid'],
739 // Allow extensions to change the markpatrolled link
740 Hooks
::run( 'DifferenceEngineMarkPatrolledLink', [ $this,
741 &$this->mMarkPatrolledLink
, $linkInfo['rcid'] ] );
744 return $this->mMarkPatrolledLink
;
748 * Returns an array of meta data needed to build a "mark as patrolled" link and
749 * adds the mediawiki.page.patrol.ajax to the output.
751 * @return array|false An array of meta data for a patrol link (rcid only)
752 * or false if no link is needed
754 protected function getMarkPatrolledLinkInfo() {
755 global $wgUseRCPatrol;
757 $user = $this->getUser();
759 // Prepare a change patrol link, if applicable
761 // Is patrolling enabled and the user allowed to?
762 $wgUseRCPatrol && $this->mNewPage
&& $this->mNewPage
->quickUserCan( 'patrol', $user ) &&
763 // Only do this if the revision isn't more than 6 hours older
764 // than the Max RC age (6h because the RC might not be cleaned out regularly)
765 RecentChange
::isInRCLifespan( $this->mNewRev
->getTimestamp(), 21600 )
767 // Look for an unpatrolled change corresponding to this diff
768 $db = wfGetDB( DB_REPLICA
);
769 $change = RecentChange
::newFromConds(
771 'rc_timestamp' => $db->timestamp( $this->mNewRev
->getTimestamp() ),
772 'rc_this_oldid' => $this->mNewid
,
773 'rc_patrolled' => RecentChange
::PRC_UNPATROLLED
778 if ( $change && !$change->getPerformer()->equals( $user ) ) {
779 $rcid = $change->getAttribute( 'rc_id' );
781 // None found or the page has been created by the current user.
782 // If the user could patrol this it already would be patrolled
786 // Allow extensions to possibly change the rcid here
787 // For example the rcid might be set to zero due to the user
788 // being the same as the performer of the change but an extension
789 // might still want to show it under certain conditions
790 Hooks
::run( 'DifferenceEngineMarkPatrolledRCID', [ &$rcid, $this, $change, $user ] );
794 $this->getOutput()->preventClickjacking();
795 if ( $user->isAllowed( 'writeapi' ) ) {
796 $this->getOutput()->addModules( 'mediawiki.page.patrol.ajax' );
805 // No mark as patrolled link applicable
810 * @param Revision $rev
814 protected function revisionDeleteLink( $rev ) {
815 $link = Linker
::getRevDeleteLink( $this->getUser(), $rev, $rev->getTitle() );
816 if ( $link !== '' ) {
817 $link = "\u{00A0}\u{00A0}\u{00A0}" . $link . ' ';
824 * Show the new revision of the page.
826 * @note Not supported after calling setContent().
828 public function renderNewRevision() {
829 if ( $this->isContentOverridden
) {
830 // The code below only works with a Revision object. We could construct a fake revision
831 // (here or in setContent), but since this does not seem needed at the moment,
832 // we'll just fail for now.
833 throw new LogicException(
835 . ' is not supported after calling setContent(). Use setRevisions() instead.'
839 $out = $this->getOutput();
840 $revHeader = $this->getRevisionHeader( $this->mNewRev
);
841 # Add "current version as of X" title
842 $out->addHTML( "<hr class='diff-hr' id='mw-oldid' />
843 <h2 class='diff-currentversion-title'>{$revHeader}</h2>\n" );
844 # Page content may be handled by a hooked call instead...
845 if ( Hooks
::run( 'ArticleContentOnDiff', [ $this, $out ] ) ) {
846 $this->loadNewText();
847 if ( !$this->mNewPage
) {
848 // New revision is unsaved; bail out.
849 // TODO in theory rendering the new revision is a meaningful thing to do
850 // even if it's unsaved, but a lot of untangling is required to do it safely.
854 $out->setRevisionId( $this->mNewid
);
855 $out->setRevisionTimestamp( $this->mNewRev
->getTimestamp() );
856 $out->setArticleFlag( true );
858 if ( !Hooks
::run( 'ArticleRevisionViewCustom',
859 [ $this->mNewRev
->getRevisionRecord(), $this->mNewPage
, $out ] )
861 // Handled by extension
862 // NOTE: sync with hooks called in Article::view()
863 } elseif ( !Hooks
::run( 'ArticleContentViewCustom',
864 [ $this->mNewContent
, $this->mNewPage
, $out ], '1.32' )
866 // Handled by extension
867 // NOTE: sync with hooks called in Article::view()
870 if ( $this->getTitle()->equals( $this->mNewPage
) ) {
871 // If the Title stored in the context is the same as the one
872 // of the new revision, we can use its associated WikiPage
874 $wikiPage = $this->getWikiPage();
876 // Otherwise we need to create our own WikiPage object
877 $wikiPage = WikiPage
::factory( $this->mNewPage
);
880 $parserOutput = $this->getParserOutput( $wikiPage, $this->mNewRev
);
882 # WikiPage::getParserOutput() should not return false, but just in case
883 if ( $parserOutput ) {
884 // Allow extensions to change parser output here
885 if ( Hooks
::run( 'DifferenceEngineRenderRevisionAddParserOutput',
886 [ $this, $out, $parserOutput, $wikiPage ] )
888 $out->addParserOutput( $parserOutput, [
889 'enableSectionEditLinks' => $this->mNewRev
->isCurrent()
890 && $this->mNewRev
->getTitle()->quickUserCan( 'edit', $this->getUser() ),
897 // Allow extensions to optionally not show the final patrolled link
898 if ( Hooks
::run( 'DifferenceEngineRenderRevisionShowFinalPatrolLink' ) ) {
899 # Add redundant patrol link on bottom...
900 $out->addHTML( $this->markPatrolledLink() );
905 * @param WikiPage $page
906 * @param Revision $rev
908 * @return ParserOutput|bool False if the revision was not found
910 protected function getParserOutput( WikiPage
$page, Revision
$rev ) {
911 if ( !$rev->getId() ) {
912 // WikiPage::getParserOutput wants a revision ID. Passing 0 will incorrectly show
913 // the current revision, so fail instead. If need be, WikiPage::getParserOutput
914 // could be made to accept a Revision or RevisionRecord instead of the id.
918 $parserOptions = $page->makeParserOptions( $this->getContext() );
919 $parserOutput = $page->getParserOutput( $parserOptions, $rev->getId() );
921 return $parserOutput;
925 * Get the diff text, send it to the OutputPage object
926 * Returns false if the diff could not be generated, otherwise returns true
928 * @param string|bool $otitle Header for old text or false
929 * @param string|bool $ntitle Header for new text or false
930 * @param string $notice HTML between diff header and body
934 public function showDiff( $otitle, $ntitle, $notice = '' ) {
935 // Allow extensions to affect the output here
936 Hooks
::run( 'DifferenceEngineShowDiff', [ $this ] );
938 $diff = $this->getDiff( $otitle, $ntitle, $notice );
939 if ( $diff === false ) {
940 $this->showMissingRevision();
944 $this->showDiffStyle();
945 $this->getOutput()->addHTML( $diff );
952 * Add style sheets for diff display.
954 public function showDiffStyle() {
955 if ( !$this->isSlotDiffRenderer
) {
956 $this->getOutput()->addModuleStyles( 'mediawiki.diff.styles' );
957 foreach ( $this->getSlotDiffRenderers() as $slotDiffRenderer ) {
958 $slotDiffRenderer->addModules( $this->getOutput() );
964 * Get complete diff table, including header
966 * @param string|bool $otitle Header for old text or false
967 * @param string|bool $ntitle Header for new text or false
968 * @param string $notice HTML between diff header and body
972 public function getDiff( $otitle, $ntitle, $notice = '' ) {
973 $body = $this->getDiffBody();
974 if ( $body === false ) {
978 $multi = $this->getMultiNotice();
979 // Display a message when the diff is empty
980 if ( $body === '' ) {
981 $notice .= '<div class="mw-diff-empty">' .
982 $this->msg( 'diff-empty' )->parse() .
986 return $this->addHeader( $body, $otitle, $ntitle, $multi, $notice );
990 * Get the diff table body, without header
992 * @return mixed (string/false)
994 public function getDiffBody() {
995 $this->mCacheHit
= true;
996 // Check if the diff should be hidden from this user
997 if ( !$this->isContentOverridden
) {
998 if ( !$this->loadRevisionData() ) {
1000 } elseif ( $this->mOldRev
&&
1001 !$this->mOldRev
->userCan( Revision
::DELETED_TEXT
, $this->getUser() )
1004 } elseif ( $this->mNewRev
&&
1005 !$this->mNewRev
->userCan( Revision
::DELETED_TEXT
, $this->getUser() )
1010 if ( $this->mOldRev
=== false ||
( $this->mOldRev
&& $this->mNewRev
&&
1011 $this->mOldRev
->getId() && $this->mOldRev
->getId() == $this->mNewRev
->getId() )
1013 if ( Hooks
::run( 'DifferenceEngineShowEmptyOldContent', [ $this ] ) ) {
1021 $cache = ObjectCache
::getMainWANInstance();
1022 if ( $this->mOldid
&& $this->mNewid
) {
1023 // Check if subclass is still using the old way
1024 // for backwards-compatibility
1025 $key = $this->getDiffBodyCacheKey();
1026 if ( $key === null ) {
1027 $key = $cache->makeKey( ...$this->getDiffBodyCacheKeyParams() );
1031 if ( !$this->mRefreshCache
) {
1032 $difftext = $cache->get( $key );
1034 wfIncrStats( 'diff_cache.hit' );
1035 $difftext = $this->localiseDiff( $difftext );
1036 $difftext .= "\n<!-- diff cache key $key -->\n";
1040 } // don't try to load but save the result
1042 $this->mCacheHit
= false;
1044 // Loadtext is permission safe, this just clears out the diff
1045 if ( !$this->loadText() ) {
1050 // We've checked for revdelete at the beginning of this method; it's OK to ignore
1051 // read permissions here.
1052 $slotContents = $this->getSlotContents();
1053 foreach ( $this->getSlotDiffRenderers() as $role => $slotDiffRenderer ) {
1054 $slotDiff = $slotDiffRenderer->getDiff( $slotContents[$role]['old'],
1055 $slotContents[$role]['new'] );
1056 if ( $slotDiff && $role !== 'main' ) {
1057 // TODO use human-readable role name at least
1059 $difftext .= $this->getSlotHeader( $slotTitle );
1061 $difftext .= $slotDiff;
1064 // Avoid PHP 7.1 warning from passing $this by reference
1065 $diffEngine = $this;
1067 // Save to cache for 7 days
1068 if ( !Hooks
::run( 'AbortDiffCache', [ &$diffEngine ] ) ) {
1069 wfIncrStats( 'diff_cache.uncacheable' );
1070 } elseif ( $key !== false && $difftext !== false ) {
1071 wfIncrStats( 'diff_cache.miss' );
1072 $cache->set( $key, $difftext, 7 * 86400 );
1074 wfIncrStats( 'diff_cache.uncacheable' );
1076 // localise line numbers and title attribute text
1077 if ( $difftext !== false ) {
1078 $difftext = $this->localiseDiff( $difftext );
1085 * Get the diff table body for one slot, without header
1087 * @param string $role
1088 * @return string|false
1090 public function getDiffBodyForRole( $role ) {
1091 $diffRenderers = $this->getSlotDiffRenderers();
1092 if ( !isset( $diffRenderers[$role] ) ) {
1096 $slotContents = $this->getSlotContents();
1097 $slotDiff = $diffRenderers[$role]->getDiff( $slotContents[$role]['old'],
1098 $slotContents[$role]['new'] );
1103 if ( $role !== 'main' ) {
1104 // TODO use human-readable role name at least
1106 $slotDiff = $this->getSlotHeader( $slotTitle ) . $slotDiff;
1109 return $this->localiseDiff( $slotDiff );
1113 * Get a slot header for inclusion in a diff body (as a table row).
1115 * @param string $headerText The text of the header
1119 protected function getSlotHeader( $headerText ) {
1120 // The old revision is missing on oldid=<first>&diff=prev; only 2 columns in that case.
1121 $columnCount = $this->mOldRev ?
4 : 2;
1122 $userLang = $this->getLanguage()->getHtmlCode();
1123 return Html
::rawElement( 'tr', [ 'class' => 'mw-diff-slot-header', 'lang' => $userLang ],
1124 Html
::element( 'th', [ 'colspan' => $columnCount ], $headerText ) );
1128 * Returns the cache key for diff body text or content.
1130 * @deprecated since 1.31, use getDiffBodyCacheKeyParams() instead
1133 * @throws MWException
1134 * @return string|null
1136 protected function getDiffBodyCacheKey() {
1141 * Get the cache key parameters
1143 * Subclasses can replace the first element in the array to something
1144 * more specific to the type of diff (e.g. "inline-diff"), or append
1145 * if the cache should vary on more things. Overriding entirely should
1151 * @throws MWException
1153 protected function getDiffBodyCacheKeyParams() {
1154 if ( !$this->mOldid ||
!$this->mNewid
) {
1155 throw new MWException( 'mOldid and mNewid must be set to get diff cache key.' );
1158 $engine = $this->getEngine();
1163 "old-{$this->mOldid}",
1164 "rev-{$this->mNewid}"
1167 if ( $engine === 'wikidiff2' ) {
1168 $params[] = phpversion( 'wikidiff2' );
1169 $params[] = $this->getConfig()->get( 'WikiDiff2MovedParagraphDetectionCutoff' );
1172 if ( !$this->isSlotDiffRenderer
) {
1173 foreach ( $this->getSlotDiffRenderers() as $slotDiffRenderer ) {
1174 $params = array_merge( $params, $slotDiffRenderer->getExtraCacheKeys() );
1182 * Implements DifferenceEngineSlotDiffRenderer::getExtraCacheKeys(). Only used when
1183 * DifferenceEngine is wrapped in DifferenceEngineSlotDiffRenderer.
1185 * @internal for use by DifferenceEngineSlotDiffRenderer only
1188 public function getExtraCacheKeys() {
1189 // This method is called when the DifferenceEngine is used for a slot diff. We only care
1190 // about special things, not the revision IDs, which are added to the cache key by the
1191 // page-level DifferenceEngine, and which might not have a valid value for this object.
1192 $this->mOldid
= 123456789;
1193 $this->mNewid
= 987654321;
1195 // This will repeat a bunch of unnecessary key fields for each slot. Not nice but harmless.
1196 $cacheString = $this->getDiffBodyCacheKey();
1197 if ( $cacheString ) {
1198 return [ $cacheString ];
1201 $params = $this->getDiffBodyCacheKeyParams();
1203 // Try to get rid of the standard keys to keep the cache key human-readable:
1204 // call the getDiffBodyCacheKeyParams implementation of the base class, and if
1205 // the child class includes the same keys, drop them.
1206 // Uses an obscure PHP feature where static calls to non-static methods are allowed
1207 // as long as we are already in a non-static method of the same class, and the call context
1208 // ($this) will be inherited.
1209 // phpcs:ignore Squiz.Classes.SelfMemberReference.NotUsed
1210 $standardParams = DifferenceEngine
::getDiffBodyCacheKeyParams();
1211 if ( array_slice( $params, 0, count( $standardParams ) ) === $standardParams ) {
1212 $params = array_slice( $params, count( $standardParams ) );
1219 * Generate a diff, no caching.
1223 * @param Content $old Old content
1224 * @param Content $new New content
1226 * @throws Exception If old or new content is not an instance of TextContent.
1227 * @return bool|string
1229 * @deprecated since 1.32, use a SlotDiffRenderer instead.
1231 public function generateContentDiffBody( Content
$old, Content
$new ) {
1232 $slotDiffRenderer = $new->getContentHandler()->getSlotDiffRenderer( $this->getContext() );
1234 $slotDiffRenderer instanceof DifferenceEngineSlotDiffRenderer
1235 && $this->isSlotDiffRenderer
1237 // Oops, we are just about to enter an infinite loop (the slot-level DifferenceEngine
1238 // called a DifferenceEngineSlotDiffRenderer that wraps the same DifferenceEngine class).
1239 // This will happen when a content model has no custom slot diff renderer, it does have
1240 // a custom difference engine, but that does not override this method.
1241 throw new Exception( get_class( $this ) . ': could not maintain backwards compatibility. '
1242 . 'Please use a SlotDiffRenderer.' );
1244 return $slotDiffRenderer->getDiff( $old, $new ) . $this->getDebugString();
1248 * Generate a diff, no caching
1250 * @param string $otext Old text, must be already segmented
1251 * @param string $ntext New text, must be already segmented
1253 * @throws Exception If content handling for text content is configured in a way
1254 * that makes maintaining B/C hard.
1255 * @return bool|string
1257 * @deprecated since 1.32, use a TextSlotDiffRenderer instead.
1259 public function generateTextDiffBody( $otext, $ntext ) {
1260 $slotDiffRenderer = ContentHandler
::getForModelID( CONTENT_MODEL_TEXT
)
1261 ->getSlotDiffRenderer( $this->getContext() );
1262 if ( !( $slotDiffRenderer instanceof TextSlotDiffRenderer
) ) {
1263 // Someone used the GetSlotDiffRenderer hook to replace the renderer.
1264 // This is too unlikely to happen to bother handling properly.
1265 throw new Exception( 'The slot diff renderer for text content should be a '
1266 . 'TextSlotDiffRenderer subclass' );
1268 return $slotDiffRenderer->getTextDiff( $otext, $ntext ) . $this->getDebugString();
1272 * Process $wgExternalDiffEngine and get a sane, usable engine
1274 * @return bool|string 'wikidiff2', path to an executable, or false
1275 * @internal For use by this class and TextSlotDiffRenderer only.
1277 public static function getEngine() {
1278 global $wgExternalDiffEngine;
1279 // We use the global here instead of Config because we write to the value,
1280 // and Config is not mutable.
1281 if ( $wgExternalDiffEngine == 'wikidiff' ||
$wgExternalDiffEngine == 'wikidiff3' ) {
1282 wfDeprecated( "\$wgExternalDiffEngine = '{$wgExternalDiffEngine}'", '1.27' );
1283 $wgExternalDiffEngine = false;
1284 } elseif ( $wgExternalDiffEngine == 'wikidiff2' ) {
1285 wfDeprecated( "\$wgExternalDiffEngine = '{$wgExternalDiffEngine}'", '1.32' );
1286 $wgExternalDiffEngine = false;
1287 } elseif ( !is_string( $wgExternalDiffEngine ) && $wgExternalDiffEngine !== false ) {
1288 // And prevent people from shooting themselves in the foot...
1289 wfWarn( '$wgExternalDiffEngine is set to a non-string value, forcing it to false' );
1290 $wgExternalDiffEngine = false;
1293 if ( is_string( $wgExternalDiffEngine ) && is_executable( $wgExternalDiffEngine ) ) {
1294 return $wgExternalDiffEngine;
1295 } elseif ( $wgExternalDiffEngine === false && function_exists( 'wikidiff2_do_diff' ) ) {
1304 * Generates diff, to be wrapped internally in a logging/instrumentation
1306 * @param string $otext Old text, must be already segmented
1307 * @param string $ntext New text, must be already segmented
1309 * @throws Exception If content handling for text content is configured in a way
1310 * that makes maintaining B/C hard.
1311 * @return bool|string
1313 * @deprecated since 1.32, use a TextSlotDiffRenderer instead.
1315 protected function textDiff( $otext, $ntext ) {
1316 $slotDiffRenderer = ContentHandler
::getForModelID( CONTENT_MODEL_TEXT
)
1317 ->getSlotDiffRenderer( $this->getContext() );
1318 if ( !( $slotDiffRenderer instanceof TextSlotDiffRenderer
) ) {
1319 // Someone used the GetSlotDiffRenderer hook to replace the renderer.
1320 // This is too unlikely to happen to bother handling properly.
1321 throw new Exception( 'The slot diff renderer for text content should be a '
1322 . 'TextSlotDiffRenderer subclass' );
1324 return $slotDiffRenderer->getTextDiff( $otext, $ntext ) . $this->getDebugString();
1328 * Generate a debug comment indicating diff generating time,
1329 * server node, and generator backend.
1331 * @param string $generator : What diff engine was used
1335 protected function debug( $generator = "internal" ) {
1336 global $wgShowHostnames;
1337 if ( !$this->enableDebugComment
) {
1340 $data = [ $generator ];
1341 if ( $wgShowHostnames ) {
1342 $data[] = wfHostname();
1344 $data[] = wfTimestamp( TS_DB
);
1346 return "<!-- diff generator: " .
1347 implode( " ", array_map( "htmlspecialchars", $data ) ) .
1351 private function getDebugString() {
1352 $engine = self
::getEngine();
1353 if ( $engine === 'wikidiff2' ) {
1354 return $this->debug( 'wikidiff2' );
1355 } elseif ( $engine === false ) {
1356 return $this->debug( 'native PHP' );
1358 return $this->debug( "external $engine" );
1363 * Localise diff output
1365 * @param string $text
1368 private function localiseDiff( $text ) {
1369 $text = $this->localiseLineNumbers( $text );
1370 if ( $this->getEngine() === 'wikidiff2' &&
1371 version_compare( phpversion( 'wikidiff2' ), '1.5.1', '>=' )
1373 $text = $this->addLocalisedTitleTooltips( $text );
1379 * Replace line numbers with the text in the user's language
1381 * @param string $text
1385 public function localiseLineNumbers( $text ) {
1386 return preg_replace_callback(
1387 '/<!--LINE (\d+)-->/',
1388 [ $this, 'localiseLineNumbersCb' ],
1393 public function localiseLineNumbersCb( $matches ) {
1394 if ( $matches[1] === '1' && $this->mReducedLineNumbers
) {
1398 return $this->msg( 'lineno' )->numParams( $matches[1] )->escaped();
1402 * Add title attributes for tooltips on moved paragraph indicators
1404 * @param string $text
1407 private function addLocalisedTitleTooltips( $text ) {
1408 return preg_replace_callback(
1409 '/class="mw-diff-movedpara-(left|right)"/',
1410 [ $this, 'addLocalisedTitleTooltipsCb' ],
1416 * @param array $matches
1419 private function addLocalisedTitleTooltipsCb( array $matches ) {
1420 $key = $matches[1] === 'right' ?
1421 'diff-paragraph-moved-toold' :
1422 'diff-paragraph-moved-tonew';
1423 return $matches[0] . ' title="' . $this->msg( $key )->escaped() . '"';
1427 * If there are revisions between the ones being compared, return a note saying so.
1431 public function getMultiNotice() {
1432 // The notice only make sense if we are diffing two saved revisions of the same page.
1434 !$this->mOldRev ||
!$this->mNewRev
1435 ||
!$this->mOldPage ||
!$this->mNewPage
1436 ||
!$this->mOldPage
->equals( $this->mNewPage
)
1441 if ( $this->mOldRev
->getTimestamp() > $this->mNewRev
->getTimestamp() ) {
1442 $oldRev = $this->mNewRev
; // flip
1443 $newRev = $this->mOldRev
; // flip
1444 } else { // normal case
1445 $oldRev = $this->mOldRev
;
1446 $newRev = $this->mNewRev
;
1449 // Sanity: don't show the notice if too many rows must be scanned
1450 // @todo show some special message for that case
1451 $nEdits = $this->mNewPage
->countRevisionsBetween( $oldRev, $newRev, 1000 );
1452 if ( $nEdits > 0 && $nEdits <= 1000 ) {
1453 $limit = 100; // use diff-multi-manyusers if too many users
1454 $users = $this->mNewPage
->getAuthorsBetween( $oldRev, $newRev, $limit );
1455 $numUsers = count( $users );
1457 if ( $numUsers == 1 && $users[0] == $newRev->getUserText( Revision
::RAW
) ) {
1458 $numUsers = 0; // special case to say "by the same user" instead of "by one other user"
1461 return self
::intermediateEditsMsg( $nEdits, $numUsers, $limit );
1464 return ''; // nothing
1468 * Get a notice about how many intermediate edits and users there are
1470 * @param int $numEdits
1471 * @param int $numUsers
1476 public static function intermediateEditsMsg( $numEdits, $numUsers, $limit ) {
1477 if ( $numUsers === 0 ) {
1478 $msg = 'diff-multi-sameuser';
1479 } elseif ( $numUsers > $limit ) {
1480 $msg = 'diff-multi-manyusers';
1483 $msg = 'diff-multi-otherusers';
1486 return wfMessage( $msg )->numParams( $numEdits, $numUsers )->parse();
1490 * Get a header for a specified revision.
1492 * @param Revision $rev
1493 * @param string $complete 'complete' to get the header wrapped depending
1494 * the visibility of the revision and a link to edit the page.
1496 * @return string HTML fragment
1498 public function getRevisionHeader( Revision
$rev, $complete = '' ) {
1499 $lang = $this->getLanguage();
1500 $user = $this->getUser();
1501 $revtimestamp = $rev->getTimestamp();
1502 $timestamp = $lang->userTimeAndDate( $revtimestamp, $user );
1503 $dateofrev = $lang->userDate( $revtimestamp, $user );
1504 $timeofrev = $lang->userTime( $revtimestamp, $user );
1506 $header = $this->msg(
1507 $rev->isCurrent() ?
'currentrev-asof' : 'revisionasof',
1513 if ( $complete !== 'complete' ) {
1517 $title = $rev->getTitle();
1519 $header = Linker
::linkKnown( $title, $header, [],
1520 [ 'oldid' => $rev->getId() ] );
1522 if ( $rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
1523 $editQuery = [ 'action' => 'edit' ];
1524 if ( !$rev->isCurrent() ) {
1525 $editQuery['oldid'] = $rev->getId();
1528 $key = $title->quickUserCan( 'edit', $user ) ?
'editold' : 'viewsourceold';
1529 $msg = $this->msg( $key )->escaped();
1530 $editLink = $this->msg( 'parentheses' )->rawParams(
1531 Linker
::linkKnown( $title, $msg, [], $editQuery ) )->escaped();
1532 $header .= ' ' . Html
::rawElement(
1534 [ 'class' => 'mw-diff-edit' ],
1537 if ( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
1538 $header = Html
::rawElement(
1540 [ 'class' => 'history-deleted' ],
1545 $header = Html
::rawElement( 'span', [ 'class' => 'history-deleted' ], $header );
1552 * Add the header to a diff body
1554 * @param string $diff Diff body
1555 * @param string $otitle Old revision header
1556 * @param string $ntitle New revision header
1557 * @param string $multi Notice telling user that there are intermediate
1558 * revisions between the ones being compared
1559 * @param string $notice Other notices, e.g. that user is viewing deleted content
1563 public function addHeader( $diff, $otitle, $ntitle, $multi = '', $notice = '' ) {
1564 // shared.css sets diff in interface language/dir, but the actual content
1565 // is often in a different language, mostly the page content language/dir
1566 $header = Html
::openElement( 'table', [
1567 'class' => [ 'diff', 'diff-contentalign-' . $this->getDiffLang()->alignStart() ],
1568 'data-mw' => 'interface',
1570 $userLang = htmlspecialchars( $this->getLanguage()->getHtmlCode() );
1572 if ( !$diff && !$otitle ) {
1574 <tr class=\"diff-title\" lang=\"{$userLang}\">
1575 <td class=\"diff-ntitle\">{$ntitle}</td>
1579 if ( $diff ) { // Safari/Chrome show broken output if cols not used
1581 <col class=\"diff-marker\" />
1582 <col class=\"diff-content\" />
1583 <col class=\"diff-marker\" />
1584 <col class=\"diff-content\" />";
1591 if ( $otitle ||
$ntitle ) {
1593 <tr class=\"diff-title\" lang=\"{$userLang}\">
1594 <td colspan=\"$colspan\" class=\"diff-otitle\">{$otitle}</td>
1595 <td colspan=\"$colspan\" class=\"diff-ntitle\">{$ntitle}</td>
1600 if ( $multi != '' ) {
1601 $header .= "<tr><td colspan=\"{$multiColspan}\" " .
1602 "class=\"diff-multi\" lang=\"{$userLang}\">{$multi}</td></tr>";
1604 if ( $notice != '' ) {
1605 $header .= "<tr><td colspan=\"{$multiColspan}\" " .
1606 "class=\"diff-notice\" lang=\"{$userLang}\">{$notice}</td></tr>";
1609 return $header . $diff . "</table>";
1613 * Use specified text instead of loading from the database
1614 * @param Content $oldContent
1615 * @param Content $newContent
1617 * @deprecated since 1.32, use setRevisions or ContentHandler::getSlotDiffRenderer.
1619 public function setContent( Content
$oldContent, Content
$newContent ) {
1620 $this->mOldContent
= $oldContent;
1621 $this->mNewContent
= $newContent;
1623 $this->mTextLoaded
= 2;
1624 $this->mRevisionsLoaded
= true;
1625 $this->isContentOverridden
= true;
1626 $this->slotDiffRenderers
= null;
1630 * Use specified text instead of loading from the database.
1631 * @param RevisionRecord|null $oldRevision
1632 * @param RevisionRecord $newRevision
1634 public function setRevisions(
1635 RevisionRecord
$oldRevision = null, RevisionRecord
$newRevision
1637 if ( $oldRevision ) {
1638 $this->mOldRev
= new Revision( $oldRevision );
1639 $this->mOldid
= $oldRevision->getId();
1640 $this->mOldPage
= Title
::newFromLinkTarget( $oldRevision->getPageAsLinkTarget() );
1641 // This method is meant for edit diffs and such so there is no reason to provide a
1642 // revision that's not readable to the user, but check it just in case.
1643 $this->mOldContent
= $oldRevision ?
$oldRevision->getContent( 'main',
1644 RevisionRecord
::FOR_THIS_USER
, $this->getUser() ) : null;
1646 $this->mOldPage
= null;
1647 $this->mOldRev
= $this->mOldid
= false;
1649 $this->mNewRev
= new Revision( $newRevision );
1650 $this->mNewid
= $newRevision->getId();
1651 $this->mNewPage
= Title
::newFromLinkTarget( $newRevision->getPageAsLinkTarget() );
1652 $this->mNewContent
= $newRevision->getContent( 'main',
1653 RevisionRecord
::FOR_THIS_USER
, $this->getUser() );
1655 $this->mRevisionsIdsLoaded
= $this->mRevisionsLoaded
= true;
1656 $this->mTextLoaded
= !!$oldRevision +
1;
1657 $this->isContentOverridden
= false;
1658 $this->slotDiffRenderers
= null;
1662 * Set the language in which the diff text is written
1664 * @param Language $lang
1667 public function setTextLanguage( $lang ) {
1668 if ( !$lang instanceof Language
) {
1669 wfDeprecated( __METHOD__
. ' with other type than Language for $lang', '1.32' );
1671 $this->mDiffLang
= wfGetLangObj( $lang );
1675 * Maps a revision pair definition as accepted by DifferenceEngine constructor
1676 * to a pair of actual integers representing revision ids.
1678 * @param int $old Revision id, e.g. from URL parameter 'oldid'
1679 * @param int|string $new Revision id or strings 'next' or 'prev', e.g. from URL parameter 'diff'
1681 * @return array List of two revision ids, older first, later second.
1682 * Zero signifies invalid argument passed.
1683 * false signifies that there is no previous/next revision ($old is the oldest/newest one).
1685 public function mapDiffPrevNext( $old, $new ) {
1686 if ( $new === 'prev' ) {
1687 // Show diff between revision $old and the previous one. Get previous one from DB.
1688 $newid = intval( $old );
1689 $oldid = $this->getTitle()->getPreviousRevisionID( $newid );
1690 } elseif ( $new === 'next' ) {
1691 // Show diff between revision $old and the next one. Get next one from DB.
1692 $oldid = intval( $old );
1693 $newid = $this->getTitle()->getNextRevisionID( $oldid );
1695 $oldid = intval( $old );
1696 $newid = intval( $new );
1699 return [ $oldid, $newid ];
1705 private function loadRevisionIds() {
1706 if ( $this->mRevisionsIdsLoaded
) {
1710 $this->mRevisionsIdsLoaded
= true;
1712 $old = $this->mOldid
;
1713 $new = $this->mNewid
;
1715 list( $this->mOldid
, $this->mNewid
) = self
::mapDiffPrevNext( $old, $new );
1716 if ( $new === 'next' && $this->mNewid
=== false ) {
1717 # if no result, NewId points to the newest old revision. The only newer
1718 # revision is cur, which is "0".
1723 'NewDifferenceEngine',
1724 [ $this->getTitle(), &$this->mOldid
, &$this->mNewid
, $old, $new ]
1729 * Load revision metadata for the specified revisions. If newid is 0, then compare
1730 * the old revision in oldid to the current revision of the current page (as defined
1731 * by the request context); if oldid is 0, then compare the revision in newid to the
1732 * immediately previous one.
1734 * If oldid is false, leave the corresponding revision object set
1735 * to false. This can happen with 'diff=prev' pointing to a non-existent revision,
1736 * and is also used directly by the API.
1738 * @return bool Whether both revisions were loaded successfully. Setting mOldRev
1739 * to false counts as successful loading.
1741 public function loadRevisionData() {
1742 if ( $this->mRevisionsLoaded
) {
1743 return $this->isContentOverridden ||
$this->mNewRev
&& !is_null( $this->mOldRev
);
1746 // Whether it succeeds or fails, we don't want to try again
1747 $this->mRevisionsLoaded
= true;
1749 $this->loadRevisionIds();
1751 // Load the new revision object
1752 if ( $this->mNewid
) {
1753 $this->mNewRev
= Revision
::newFromId( $this->mNewid
);
1755 $this->mNewRev
= Revision
::newFromTitle(
1758 Revision
::READ_NORMAL
1762 if ( !$this->mNewRev
instanceof Revision
) {
1766 // Update the new revision ID in case it was 0 (makes life easier doing UI stuff)
1767 $this->mNewid
= $this->mNewRev
->getId();
1768 if ( $this->mNewid
) {
1769 $this->mNewPage
= $this->mNewRev
->getTitle();
1771 $this->mNewPage
= null;
1774 // Load the old revision object
1775 $this->mOldRev
= false;
1776 if ( $this->mOldid
) {
1777 $this->mOldRev
= Revision
::newFromId( $this->mOldid
);
1778 } elseif ( $this->mOldid
=== 0 ) {
1779 $rev = $this->mNewRev
->getPrevious();
1781 $this->mOldid
= $rev->getId();
1782 $this->mOldRev
= $rev;
1784 // No previous revision; mark to show as first-version only.
1785 $this->mOldid
= false;
1786 $this->mOldRev
= false;
1788 } /* elseif ( $this->mOldid === false ) leave mOldRev false; */
1790 if ( is_null( $this->mOldRev
) ) {
1794 if ( $this->mOldRev
&& $this->mOldRev
->getId() ) {
1795 $this->mOldPage
= $this->mOldRev
->getTitle();
1797 $this->mOldPage
= null;
1800 // Load tags information for both revisions
1801 $dbr = wfGetDB( DB_REPLICA
);
1802 if ( $this->mOldid
!== false ) {
1803 $this->mOldTags
= $dbr->selectField(
1806 [ 'ts_rev_id' => $this->mOldid
],
1810 $this->mOldTags
= false;
1812 $this->mNewTags
= $dbr->selectField(
1815 [ 'ts_rev_id' => $this->mNewid
],
1823 * Load the text of the revisions, as well as revision data.
1824 * When the old revision is missing (mOldRev is false), loading mOldContent is not attempted.
1826 * @return bool Whether the content of both revisions could be loaded successfully.
1827 * (When mOldRev is false, that still counts as a success.)
1830 public function loadText() {
1831 if ( $this->mTextLoaded
== 2 ) {
1832 return $this->loadRevisionData() && ( $this->mOldRev
=== false ||
$this->mOldContent
)
1833 && $this->mNewContent
;
1836 // Whether it succeeds or fails, we don't want to try again
1837 $this->mTextLoaded
= 2;
1839 if ( !$this->loadRevisionData() ) {
1843 if ( $this->mOldRev
) {
1844 $this->mOldContent
= $this->mOldRev
->getContent( Revision
::FOR_THIS_USER
, $this->getUser() );
1845 if ( $this->mOldContent
=== null ) {
1850 $this->mNewContent
= $this->mNewRev
->getContent( Revision
::FOR_THIS_USER
, $this->getUser() );
1851 Hooks
::run( 'DifferenceEngineLoadTextAfterNewContentIsLoaded', [ $this ] );
1852 if ( $this->mNewContent
=== null ) {
1860 * Load the text of the new revision, not the old one
1862 * @return bool Whether the content of the new revision could be loaded successfully.
1864 public function loadNewText() {
1865 if ( $this->mTextLoaded
>= 1 ) {
1866 return $this->loadRevisionData();
1869 $this->mTextLoaded
= 1;
1871 if ( !$this->loadRevisionData() ) {
1875 $this->mNewContent
= $this->mNewRev
->getContent( Revision
::FOR_THIS_USER
, $this->getUser() );
1877 Hooks
::run( 'DifferenceEngineAfterLoadNewText', [ $this ] );