Completed
Branch master (bb5bb2)
by
unknown
34:48
created

DifferenceEngine::generateDiffBody()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 5
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 3
nc 1
nop 2
dl 0
loc 5
rs 9.4285
c 0
b 0
f 0
1
<?php
2
/**
3
 * User interface for the difference engine.
4
 *
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.
9
 *
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.
14
 *
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
19
 *
20
 * @file
21
 * @ingroup DifferenceEngine
22
 */
23
24
// Deprecated, use class constant instead
25
define( 'MW_DIFF_VERSION', '1.11a' );
26
27
/**
28
 * @todo document
29
 * @ingroup DifferenceEngine
30
 */
31
class DifferenceEngine extends ContextSource {
32
	/**
33
	 * Constant to indicate diff cache compatibility.
34
	 * Bump this when changing the diff formatting in a way that
35
	 * fixes important bugs or such to force cached diff views to
36
	 * clear.
37
	 */
38
	const DIFF_VERSION = MW_DIFF_VERSION;
39
40
	/** @var int */
41
	public $mOldid;
42
43
	/** @var int */
44
	public $mNewid;
45
46
	private $mOldTags;
47
	private $mNewTags;
48
49
	/** @var Content */
50
	public $mOldContent;
51
52
	/** @var Content */
53
	public $mNewContent;
54
55
	/** @var Language */
56
	protected $mDiffLang;
57
58
	/** @var Title */
59
	public $mOldPage;
60
61
	/** @var Title */
62
	public $mNewPage;
63
64
	/** @var Revision */
65
	public $mOldRev;
66
67
	/** @var Revision */
68
	public $mNewRev;
69
70
	/** @var bool Have the revisions IDs been loaded */
71
	private $mRevisionsIdsLoaded = false;
72
73
	/** @var bool Have the revisions been loaded */
74
	public $mRevisionsLoaded = false;
75
76
	/** @var int How many text blobs have been loaded, 0, 1 or 2? */
77
	public $mTextLoaded = 0;
78
79
	/** @var bool Was the diff fetched from cache? */
80
	public $mCacheHit = false;
81
82
	/**
83
	 * Set this to true to add debug info to the HTML output.
84
	 * Warning: this may cause RSS readers to spuriously mark articles as "new"
85
	 * (bug 20601)
86
	 */
87
	public $enableDebugComment = false;
88
89
	/** @var bool If true, line X is not displayed when X is 1, for example
90
	 *    to increase readability and conserve space with many small diffs.
91
	 */
92
	protected $mReducedLineNumbers = false;
93
94
	/** @var string Link to action=markpatrolled */
95
	protected $mMarkPatrolledLink = null;
96
97
	/** @var bool Show rev_deleted content if allowed */
98
	protected $unhide = false;
99
100
	/** @var bool Refresh the diff cache */
101
	protected $mRefreshCache = false;
102
103
	/**#@-*/
104
105
	/**
106
	 * Constructor
107
	 * @param IContextSource $context Context to use, anything else will be ignored
108
	 * @param int $old Old ID we want to show and diff with.
109
	 * @param string|int $new Either revision ID or 'prev' or 'next'. Default: 0.
110
	 * @param int $rcid Deprecated, no longer used!
111
	 * @param bool $refreshCache If set, refreshes the diff cache
112
	 * @param bool $unhide If set, allow viewing deleted revs
113
	 */
114
	public function __construct( $context = null, $old = 0, $new = 0, $rcid = 0,
115
		$refreshCache = false, $unhide = false
116
	) {
117
		if ( $context instanceof IContextSource ) {
118
			$this->setContext( $context );
119
		}
120
121
		wfDebug( "DifferenceEngine old '$old' new '$new' rcid '$rcid'\n" );
122
123
		$this->mOldid = $old;
124
		$this->mNewid = $new;
125
		$this->mRefreshCache = $refreshCache;
126
		$this->unhide = $unhide;
127
	}
128
129
	/**
130
	 * @param bool $value
131
	 */
132
	public function setReducedLineNumbers( $value = true ) {
133
		$this->mReducedLineNumbers = $value;
134
	}
135
136
	/**
137
	 * @return Language
138
	 */
139
	public function getDiffLang() {
140
		if ( $this->mDiffLang === null ) {
141
			# Default language in which the diff text is written.
142
			$this->mDiffLang = $this->getTitle()->getPageLanguage();
143
		}
144
145
		return $this->mDiffLang;
146
	}
147
148
	/**
149
	 * @return bool
150
	 */
151
	public function wasCacheHit() {
152
		return $this->mCacheHit;
153
	}
154
155
	/**
156
	 * @return int
157
	 */
158
	public function getOldid() {
159
		$this->loadRevisionIds();
160
161
		return $this->mOldid;
162
	}
163
164
	/**
165
	 * @return bool|int
166
	 */
167
	public function getNewid() {
168
		$this->loadRevisionIds();
169
170
		return $this->mNewid;
171
	}
172
173
	/**
174
	 * Look up a special:Undelete link to the given deleted revision id,
175
	 * as a workaround for being unable to load deleted diffs in currently.
176
	 *
177
	 * @param int $id Revision ID
178
	 *
179
	 * @return mixed URL or false
180
	 */
181
	public function deletedLink( $id ) {
182
		if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
183
			$dbr = wfGetDB( DB_SLAVE );
184
			$row = $dbr->selectRow( 'archive', '*',
185
				[ 'ar_rev_id' => $id ],
186
				__METHOD__ );
187
			if ( $row ) {
188
				$rev = Revision::newFromArchiveRow( $row );
0 ignored issues
show
Bug introduced by
It seems like $row defined by $dbr->selectRow('archive...d' => $id), __METHOD__) on line 184 can also be of type boolean; however, Revision::newFromArchiveRow() does only seem to accept object, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
189
				$title = Title::makeTitleSafe( $row->ar_namespace, $row->ar_title );
190
191
				return SpecialPage::getTitleFor( 'Undelete' )->getFullURL( [
192
					'target' => $title->getPrefixedText(),
193
					'timestamp' => $rev->getTimestamp()
194
				] );
195
			}
196
		}
197
198
		return false;
199
	}
200
201
	/**
202
	 * Build a wikitext link toward a deleted revision, if viewable.
203
	 *
204
	 * @param int $id Revision ID
205
	 *
206
	 * @return string Wikitext fragment
207
	 */
208
	public function deletedIdMarker( $id ) {
209
		$link = $this->deletedLink( $id );
210
		if ( $link ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $link of type string|false is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== false instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
211
			return "[$link $id]";
212
		} else {
213
			return $id;
214
		}
215
	}
216
217
	private function showMissingRevision() {
218
		$out = $this->getOutput();
219
220
		$missing = [];
221
		if ( $this->mOldRev === null ||
222
			( $this->mOldRev && $this->mOldContent === null )
223
		) {
224
			$missing[] = $this->deletedIdMarker( $this->mOldid );
225
		}
226
		if ( $this->mNewRev === null ||
227
			( $this->mNewRev && $this->mNewContent === null )
228
		) {
229
			$missing[] = $this->deletedIdMarker( $this->mNewid );
230
		}
231
232
		$out->setPageTitle( $this->msg( 'errorpagetitle' ) );
233
		$msg = $this->msg( 'difference-missing-revision' )
234
			->params( $this->getLanguage()->listToText( $missing ) )
235
			->numParams( count( $missing ) )
236
			->parseAsBlock();
237
		$out->addHTML( $msg );
238
	}
239
240
	public function showDiffPage( $diffOnly = false ) {
241
242
		# Allow frames except in certain special cases
243
		$out = $this->getOutput();
244
		$out->allowClickjacking();
245
		$out->setRobotPolicy( 'noindex,nofollow' );
246
247
		if ( !$this->loadRevisionData() ) {
248
			$this->showMissingRevision();
249
250
			return;
251
		}
252
253
		$user = $this->getUser();
254
		$permErrors = $this->mNewPage->getUserPermissionsErrors( 'read', $user );
255
		if ( $this->mOldPage ) { # mOldPage might not be set, see below.
256
			$permErrors = wfMergeErrorArrays( $permErrors,
257
				$this->mOldPage->getUserPermissionsErrors( 'read', $user ) );
258
		}
259
		if ( count( $permErrors ) ) {
260
			throw new PermissionsError( 'read', $permErrors );
261
		}
262
263
		$rollback = '';
264
265
		$query = [];
266
		# Carry over 'diffonly' param via navigation links
267
		if ( $diffOnly != $user->getBoolOption( 'diffonly' ) ) {
268
			$query['diffonly'] = $diffOnly;
269
		}
270
		# Cascade unhide param in links for easy deletion browsing
271
		if ( $this->unhide ) {
272
			$query['unhide'] = 1;
273
		}
274
275
		# Check if one of the revisions is deleted/suppressed
276
		$deleted = $suppressed = false;
277
		$allowed = $this->mNewRev->userCan( Revision::DELETED_TEXT, $user );
278
279
		$revisionTools = [];
280
281
		# mOldRev is false if the difference engine is called with a "vague" query for
282
		# a diff between a version V and its previous version V' AND the version V
283
		# is the first version of that article. In that case, V' does not exist.
284
		if ( $this->mOldRev === false ) {
285
			$out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage->getPrefixedText() ) );
286
			$samePage = true;
287
			$oldHeader = '';
288
		} else {
289
			Hooks::run( 'DiffViewHeader', [ $this, $this->mOldRev, $this->mNewRev ] );
290
291
			if ( $this->mNewPage->equals( $this->mOldPage ) ) {
292
				$out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage->getPrefixedText() ) );
293
				$samePage = true;
294
			} else {
295
				$out->setPageTitle( $this->msg( 'difference-title-multipage',
296
					$this->mOldPage->getPrefixedText(), $this->mNewPage->getPrefixedText() ) );
297
				$out->addSubtitle( $this->msg( 'difference-multipage' ) );
298
				$samePage = false;
299
			}
300
301
			if ( $samePage && $this->mNewPage->quickUserCan( 'edit', $user ) ) {
302
				if ( $this->mNewRev->isCurrent() && $this->mNewPage->userCan( 'rollback', $user ) ) {
303
					$rollbackLink = Linker::generateRollback( $this->mNewRev, $this->getContext() );
304
					if ( $rollbackLink ) {
305
						$out->preventClickjacking();
306
						$rollback = '&#160;&#160;&#160;' . $rollbackLink;
307
					}
308
				}
309
310
				if ( !$this->mOldRev->isDeleted( Revision::DELETED_TEXT ) &&
311
					!$this->mNewRev->isDeleted( Revision::DELETED_TEXT )
312
				) {
313
					$undoLink = Html::element( 'a', [
314
							'href' => $this->mNewPage->getLocalURL( [
315
								'action' => 'edit',
316
								'undoafter' => $this->mOldid,
317
								'undo' => $this->mNewid
318
							] ),
319
							'title' => Linker::titleAttrib( 'undo' ),
320
						],
321
						$this->msg( 'editundo' )->text()
322
					);
323
					$revisionTools['mw-diff-undo'] = $undoLink;
324
				}
325
			}
326
327
			# Make "previous revision link"
328 View Code Duplication
			if ( $samePage && $this->mOldRev->getPrevious() ) {
329
				$prevlink = Linker::linkKnown(
330
					$this->mOldPage,
331
					$this->msg( 'previousdiff' )->escaped(),
332
					[ 'id' => 'differences-prevlink' ],
333
					[ 'diff' => 'prev', 'oldid' => $this->mOldid ] + $query
334
				);
335
			} else {
336
				$prevlink = '&#160;';
337
			}
338
339
			if ( $this->mOldRev->isMinor() ) {
340
				$oldminor = ChangesList::flag( 'minor' );
341
			} else {
342
				$oldminor = '';
343
			}
344
345
			$ldel = $this->revisionDeleteLink( $this->mOldRev );
346
			$oldRevisionHeader = $this->getRevisionHeader( $this->mOldRev, 'complete' );
347
			$oldChangeTags = ChangeTags::formatSummaryRow( $this->mOldTags, 'diff', $this->getContext() );
348
349
			$oldHeader = '<div id="mw-diff-otitle1"><strong>' . $oldRevisionHeader . '</strong></div>' .
350
				'<div id="mw-diff-otitle2">' .
351
				Linker::revUserTools( $this->mOldRev, !$this->unhide ) . '</div>' .
352
				'<div id="mw-diff-otitle3">' . $oldminor .
353
				Linker::revComment( $this->mOldRev, !$diffOnly, !$this->unhide ) . $ldel . '</div>' .
354
				'<div id="mw-diff-otitle5">' . $oldChangeTags[0] . '</div>' .
355
				'<div id="mw-diff-otitle4">' . $prevlink . '</div>';
356
357 View Code Duplication
			if ( $this->mOldRev->isDeleted( Revision::DELETED_TEXT ) ) {
358
				$deleted = true; // old revisions text is hidden
359
				if ( $this->mOldRev->isDeleted( Revision::DELETED_RESTRICTED ) ) {
360
					$suppressed = true; // also suppressed
361
				}
362
			}
363
364
			# Check if this user can see the revisions
365
			if ( !$this->mOldRev->userCan( Revision::DELETED_TEXT, $user ) ) {
366
				$allowed = false;
367
			}
368
		}
369
370
		# Make "next revision link"
371
		# Skip next link on the top revision
372 View Code Duplication
		if ( $samePage && !$this->mNewRev->isCurrent() ) {
373
			$nextlink = Linker::linkKnown(
374
				$this->mNewPage,
375
				$this->msg( 'nextdiff' )->escaped(),
376
				[ 'id' => 'differences-nextlink' ],
377
				[ 'diff' => 'next', 'oldid' => $this->mNewid ] + $query
378
			);
379
		} else {
380
			$nextlink = '&#160;';
381
		}
382
383
		if ( $this->mNewRev->isMinor() ) {
384
			$newminor = ChangesList::flag( 'minor' );
385
		} else {
386
			$newminor = '';
387
		}
388
389
		# Handle RevisionDelete links...
390
		$rdel = $this->revisionDeleteLink( $this->mNewRev );
391
392
		# Allow extensions to define their own revision tools
393
		Hooks::run( 'DiffRevisionTools',
394
			[ $this->mNewRev, &$revisionTools, $this->mOldRev, $user ] );
395
		$formattedRevisionTools = [];
396
		// Put each one in parentheses (poor man's button)
397
		foreach ( $revisionTools as $key => $tool ) {
398
			$toolClass = is_string( $key ) ? $key : 'mw-diff-tool';
399
			$element = Html::rawElement(
400
				'span',
401
				[ 'class' => $toolClass ],
402
				$this->msg( 'parentheses' )->rawParams( $tool )->escaped()
403
			);
404
			$formattedRevisionTools[] = $element;
405
		}
406
		$newRevisionHeader = $this->getRevisionHeader( $this->mNewRev, 'complete' ) .
407
			' ' . implode( ' ', $formattedRevisionTools );
408
		$newChangeTags = ChangeTags::formatSummaryRow( $this->mNewTags, 'diff', $this->getContext() );
409
410
		$newHeader = '<div id="mw-diff-ntitle1"><strong>' . $newRevisionHeader . '</strong></div>' .
411
			'<div id="mw-diff-ntitle2">' . Linker::revUserTools( $this->mNewRev, !$this->unhide ) .
412
			" $rollback</div>" .
413
			'<div id="mw-diff-ntitle3">' . $newminor .
414
			Linker::revComment( $this->mNewRev, !$diffOnly, !$this->unhide ) . $rdel . '</div>' .
415
			'<div id="mw-diff-ntitle5">' . $newChangeTags[0] . '</div>' .
416
			'<div id="mw-diff-ntitle4">' . $nextlink . $this->markPatrolledLink() . '</div>';
417
418 View Code Duplication
		if ( $this->mNewRev->isDeleted( Revision::DELETED_TEXT ) ) {
419
			$deleted = true; // new revisions text is hidden
420
			if ( $this->mNewRev->isDeleted( Revision::DELETED_RESTRICTED ) ) {
421
				$suppressed = true; // also suppressed
422
			}
423
		}
424
425
		# If the diff cannot be shown due to a deleted revision, then output
426
		# the diff header and links to unhide (if available)...
427
		if ( $deleted && ( !$this->unhide || !$allowed ) ) {
428
			$this->showDiffStyle();
429
			$multi = $this->getMultiNotice();
430
			$out->addHTML( $this->addHeader( '', $oldHeader, $newHeader, $multi ) );
431
			if ( !$allowed ) {
432
				$msg = $suppressed ? 'rev-suppressed-no-diff' : 'rev-deleted-no-diff';
433
				# Give explanation for why revision is not visible
434
				$out->wrapWikiMsg( "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
435
					[ $msg ] );
436
			} else {
437
				# Give explanation and add a link to view the diff...
438
				$query = $this->getRequest()->appendQueryValue( 'unhide', '1' );
439
				$link = $this->getTitle()->getFullURL( $query );
440
				$msg = $suppressed ? 'rev-suppressed-unhide-diff' : 'rev-deleted-unhide-diff';
441
				$out->wrapWikiMsg(
442
					"<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
443
					[ $msg, $link ]
444
				);
445
			}
446
		# Otherwise, output a regular diff...
447
		} else {
448
			# Add deletion notice if the user is viewing deleted content
449
			$notice = '';
450
			if ( $deleted ) {
451
				$msg = $suppressed ? 'rev-suppressed-diff-view' : 'rev-deleted-diff-view';
452
				$notice = "<div id='mw-$msg' class='mw-warning plainlinks'>\n" .
453
					$this->msg( $msg )->parse() .
454
					"</div>\n";
455
			}
456
			$this->showDiff( $oldHeader, $newHeader, $notice );
457
			if ( !$diffOnly ) {
458
				$this->renderNewRevision();
459
			}
460
		}
461
	}
462
463
	/**
464
	 * Build a link to mark a change as patrolled.
465
	 *
466
	 * Returns empty string if there's either no revision to patrol or the user is not allowed to.
467
	 * Side effect: When the patrol link is build, this method will call
468
	 * OutputPage::preventClickjacking() and load mediawiki.page.patrol.ajax.
469
	 *
470
	 * @return string HTML or empty string
471
	 */
472
	protected function markPatrolledLink() {
473
		if ( $this->mMarkPatrolledLink === null ) {
474
			$linkInfo = $this->getMarkPatrolledLinkInfo();
475
			// If false, there is no patrol link needed/allowed
476
			if ( !$linkInfo ) {
477
				$this->mMarkPatrolledLink = '';
478
			} else {
479
				$this->mMarkPatrolledLink = ' <span class="patrollink" data-mw="interface">[' .
480
					Linker::linkKnown(
481
						$this->mNewPage,
482
						$this->msg( 'markaspatrolleddiff' )->escaped(),
483
						[],
484
						[
485
							'action' => 'markpatrolled',
486
							'rcid' => $linkInfo['rcid'],
487
							'token' => $linkInfo['token'],
488
						]
489
					) . ']</span>';
490
			}
491
		}
492
		return $this->mMarkPatrolledLink;
493
	}
494
495
	/**
496
	 * Returns an array of meta data needed to build a "mark as patrolled" link and
497
	 * adds the mediawiki.page.patrol.ajax to the output.
498
	 *
499
	 * @return array|false An array of meta data for a patrol link (rcid & token)
500
	 *  or false if no link is needed
501
	 */
502
	protected function getMarkPatrolledLinkInfo() {
503
		global $wgUseRCPatrol, $wgEnableAPI, $wgEnableWriteAPI;
504
505
		$user = $this->getUser();
506
507
		// Prepare a change patrol link, if applicable
508
		if (
509
			// Is patrolling enabled and the user allowed to?
510
			$wgUseRCPatrol && $this->mNewPage->quickUserCan( 'patrol', $user ) &&
511
			// Only do this if the revision isn't more than 6 hours older
512
			// than the Max RC age (6h because the RC might not be cleaned out regularly)
513
			RecentChange::isInRCLifespan( $this->mNewRev->getTimestamp(), 21600 )
514
		) {
515
			// Look for an unpatrolled change corresponding to this diff
516
			$db = wfGetDB( DB_SLAVE );
517
			$change = RecentChange::newFromConds(
518
				[
519
					'rc_timestamp' => $db->timestamp( $this->mNewRev->getTimestamp() ),
520
					'rc_this_oldid' => $this->mNewid,
521
					'rc_patrolled' => 0
522
				],
523
				__METHOD__
524
			);
525
526
			if ( $change && !$change->getPerformer()->equals( $user ) ) {
527
				$rcid = $change->getAttribute( 'rc_id' );
528
			} else {
529
				// None found or the page has been created by the current user.
530
				// If the user could patrol this it already would be patrolled
531
				$rcid = 0;
532
			}
533
			// Build the link
534
			if ( $rcid ) {
535
				$this->getOutput()->preventClickjacking();
536
				if ( $wgEnableAPI && $wgEnableWriteAPI
537
					&& $user->isAllowed( 'writeapi' )
538
				) {
539
					$this->getOutput()->addModules( 'mediawiki.page.patrol.ajax' );
540
				}
541
542
				$token = $user->getEditToken( $rcid );
543
				return [
544
					'rcid' => $rcid,
545
					'token' => $token,
546
				];
547
			}
548
		}
549
550
		// No mark as patrolled link applicable
551
		return false;
552
	}
553
554
	/**
555
	 * @param Revision $rev
556
	 *
557
	 * @return string
558
	 */
559
	protected function revisionDeleteLink( $rev ) {
560
		$link = Linker::getRevDeleteLink( $this->getUser(), $rev, $rev->getTitle() );
0 ignored issues
show
Bug introduced by
It seems like $rev->getTitle() can be null; however, getRevDeleteLink() does not accept null, maybe add an additional type check?

Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code:

/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
Loading history...
561
		if ( $link !== '' ) {
562
			$link = '&#160;&#160;&#160;' . $link . ' ';
563
		}
564
565
		return $link;
566
	}
567
568
	/**
569
	 * Show the new revision of the page.
570
	 */
571
	public function renderNewRevision() {
572
		$out = $this->getOutput();
573
		$revHeader = $this->getRevisionHeader( $this->mNewRev );
574
		# Add "current version as of X" title
575
		$out->addHTML( "<hr class='diff-hr' id='mw-oldid' />
576
		<h2 class='diff-currentversion-title'>{$revHeader}</h2>\n" );
577
		# Page content may be handled by a hooked call instead...
578
		# @codingStandardsIgnoreStart Ignoring long lines.
579
		if ( Hooks::run( 'ArticleContentOnDiff', [ $this, $out ] ) ) {
580
			$this->loadNewText();
581
			$out->setRevisionId( $this->mNewid );
582
			$out->setRevisionTimestamp( $this->mNewRev->getTimestamp() );
0 ignored issues
show
Security Bug introduced by
It seems like $this->mNewRev->getTimestamp() targeting Revision::getTimestamp() can also be of type false; however, OutputPage::setRevisionTimestamp() does only seem to accept string|null, did you maybe forget to handle an error condition?
Loading history...
583
			$out->setArticleFlag( true );
584
585
			// NOTE: only needed for B/C: custom rendering of JS/CSS via hook
586
			if ( $this->mNewPage->isCssJsSubpage() || $this->mNewPage->isCssOrJsPage() ) {
587
				// This needs to be synchronised with Article::showCssOrJsPage(), which sucks
588
				// Give hooks a chance to customise the output
589
				// @todo standardize this crap into one function
590
				if ( ContentHandler::runLegacyHooks( 'ShowRawCssJs', [ $this->mNewContent, $this->mNewPage, $out ] ) ) {
591
					// NOTE: deprecated hook, B/C only
592
					// use the content object's own rendering
593
					$cnt = $this->mNewRev->getContent();
594
					$po = $cnt ? $cnt->getParserOutput( $this->mNewRev->getTitle(), $this->mNewRev->getId() ) : null;
0 ignored issues
show
Bug introduced by
It seems like $this->mNewRev->getTitle() can be null; however, getParserOutput() does not accept null, maybe add an additional type check?

Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code:

/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
Loading history...
595
					if ( $po ) {
596
						$out->addParserOutputContent( $po );
597
					}
598
				}
599
			} elseif ( !Hooks::run( 'ArticleContentViewCustom', [ $this->mNewContent, $this->mNewPage, $out ] ) ) {
600
				// Handled by extension
601
			} elseif ( !ContentHandler::runLegacyHooks( 'ArticleViewCustom', [ $this->mNewContent, $this->mNewPage, $out ] ) ) {
602
				// NOTE: deprecated hook, B/C only
603
				// Handled by extension
604
			} else {
605
				// Normal page
606
				if ( $this->getTitle()->equals( $this->mNewPage ) ) {
607
					// If the Title stored in the context is the same as the one
608
					// of the new revision, we can use its associated WikiPage
609
					// object.
610
					$wikiPage = $this->getWikiPage();
611
				} else {
612
					// Otherwise we need to create our own WikiPage object
613
					$wikiPage = WikiPage::factory( $this->mNewPage );
614
				}
615
616
				$parserOutput = $this->getParserOutput( $wikiPage, $this->mNewRev );
617
618
				# WikiPage::getParserOutput() should not return false, but just in case
619
				if ( $parserOutput ) {
620
					$out->addParserOutput( $parserOutput );
0 ignored issues
show
Bug introduced by
It seems like $parserOutput defined by $this->getParserOutput($wikiPage, $this->mNewRev) on line 616 can also be of type boolean; however, OutputPage::addParserOutput() does only seem to accept object<ParserOutput>, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
621
				}
622
			}
623
		}
624
		# @codingStandardsIgnoreEnd
625
626
		# Add redundant patrol link on bottom...
627
		$out->addHTML( $this->markPatrolledLink() );
628
629
	}
630
631
	protected function getParserOutput( WikiPage $page, Revision $rev ) {
632
		$parserOptions = $page->makeParserOptions( $this->getContext() );
633
634
		if ( !$rev->isCurrent() || !$rev->getTitle()->quickUserCan( 'edit', $this->getUser() ) ) {
635
			$parserOptions->setEditSection( false );
636
		}
637
638
		$parserOutput = $page->getParserOutput( $parserOptions, $rev->getId() );
639
640
		return $parserOutput;
641
	}
642
643
	/**
644
	 * Get the diff text, send it to the OutputPage object
645
	 * Returns false if the diff could not be generated, otherwise returns true
646
	 *
647
	 * @param string|bool $otitle Header for old text or false
648
	 * @param string|bool $ntitle Header for new text or false
649
	 * @param string $notice HTML between diff header and body
650
	 *
651
	 * @return bool
652
	 */
653
	public function showDiff( $otitle, $ntitle, $notice = '' ) {
654
		$diff = $this->getDiff( $otitle, $ntitle, $notice );
655
		if ( $diff === false ) {
656
			$this->showMissingRevision();
657
658
			return false;
659
		} else {
660
			$this->showDiffStyle();
661
			$this->getOutput()->addHTML( $diff );
662
663
			return true;
664
		}
665
	}
666
667
	/**
668
	 * Add style sheets and supporting JS for diff display.
669
	 */
670
	public function showDiffStyle() {
671
		$this->getOutput()->addModuleStyles( 'mediawiki.action.history.diff' );
672
	}
673
674
	/**
675
	 * Get complete diff table, including header
676
	 *
677
	 * @param string|bool $otitle Header for old text or false
678
	 * @param string|bool $ntitle Header for new text or false
679
	 * @param string $notice HTML between diff header and body
680
	 *
681
	 * @return mixed
682
	 */
683
	public function getDiff( $otitle, $ntitle, $notice = '' ) {
684
		$body = $this->getDiffBody();
685
		if ( $body === false ) {
686
			return false;
687
		}
688
689
		$multi = $this->getMultiNotice();
690
		// Display a message when the diff is empty
691
		if ( $body === '' ) {
692
			$notice .= '<div class="mw-diff-empty">' .
693
				$this->msg( 'diff-empty' )->parse() .
694
				"</div>\n";
695
		}
696
697
		return $this->addHeader( $body, $otitle, $ntitle, $multi, $notice );
0 ignored issues
show
Bug introduced by
It seems like $otitle defined by parameter $otitle on line 683 can also be of type boolean; however, DifferenceEngine::addHeader() does only seem to accept string, maybe add an additional type check?

This check looks at variables that have been passed in as parameters and are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
Bug introduced by
It seems like $ntitle defined by parameter $ntitle on line 683 can also be of type boolean; however, DifferenceEngine::addHeader() does only seem to accept string, maybe add an additional type check?

This check looks at variables that have been passed in as parameters and are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
698
	}
699
700
	/**
701
	 * Get the diff table body, without header
702
	 *
703
	 * @return mixed (string/false)
704
	 */
705
	public function getDiffBody() {
706
		$this->mCacheHit = true;
707
		// Check if the diff should be hidden from this user
708
		if ( !$this->loadRevisionData() ) {
709
			return false;
710
		} elseif ( $this->mOldRev &&
711
			!$this->mOldRev->userCan( Revision::DELETED_TEXT, $this->getUser() )
712
		) {
713
			return false;
714
		} elseif ( $this->mNewRev &&
715
			!$this->mNewRev->userCan( Revision::DELETED_TEXT, $this->getUser() )
716
		) {
717
			return false;
718
		}
719
		// Short-circuit
720
		if ( $this->mOldRev === false || ( $this->mOldRev && $this->mNewRev
721
			&& $this->mOldRev->getId() == $this->mNewRev->getId() )
722
		) {
723
			return '';
724
		}
725
		// Cacheable?
726
		$key = false;
727
		$cache = ObjectCache::getMainWANInstance();
728
		if ( $this->mOldid && $this->mNewid ) {
729
			$key = $this->getDiffBodyCacheKey();
730
731
			// Try cache
732
			if ( !$this->mRefreshCache ) {
733
				$difftext = $cache->get( $key );
734
				if ( $difftext ) {
735
					wfIncrStats( 'diff_cache.hit' );
736
					$difftext = $this->localiseLineNumbers( $difftext );
737
					$difftext .= "\n<!-- diff cache key $key -->\n";
738
739
					return $difftext;
740
				}
741
			} // don't try to load but save the result
742
		}
743
		$this->mCacheHit = false;
744
745
		// Loadtext is permission safe, this just clears out the diff
746
		if ( !$this->loadText() ) {
747
			return false;
748
		}
749
750
		$difftext = $this->generateContentDiffBody( $this->mOldContent, $this->mNewContent );
751
752
		// Save to cache for 7 days
753
		if ( !Hooks::run( 'AbortDiffCache', [ &$this ] ) ) {
754
			wfIncrStats( 'diff_cache.uncacheable' );
755
		} elseif ( $key !== false && $difftext !== false ) {
756
			wfIncrStats( 'diff_cache.miss' );
757
			$cache->set( $key, $difftext, 7 * 86400 );
758
		} else {
759
			wfIncrStats( 'diff_cache.uncacheable' );
760
		}
761
		// Replace line numbers with the text in the user's language
762
		if ( $difftext !== false ) {
763
			$difftext = $this->localiseLineNumbers( $difftext );
0 ignored issues
show
Bug introduced by
It seems like $difftext can also be of type boolean; however, DifferenceEngine::localiseLineNumbers() does only seem to accept string, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
764
		}
765
766
		return $difftext;
767
	}
768
769
	/**
770
	 * Returns the cache key for diff body text or content.
771
	 *
772
	 * @since 1.23
773
	 *
774
	 * @throws MWException
775
	 * @return string
776
	 */
777
	protected function getDiffBodyCacheKey() {
778
		if ( !$this->mOldid || !$this->mNewid ) {
779
			throw new MWException( 'mOldid and mNewid must be set to get diff cache key.' );
780
		}
781
782
		return wfMemcKey( 'diff', 'version', self::DIFF_VERSION,
783
			'oldid', $this->mOldid, 'newid', $this->mNewid );
784
	}
785
786
	/**
787
	 * Generate a diff, no caching.
788
	 *
789
	 * This implementation uses generateTextDiffBody() to generate a diff based on the default
790
	 * serialization of the given Content objects. This will fail if $old or $new are not
791
	 * instances of TextContent.
792
	 *
793
	 * Subclasses may override this to provide a different rendering for the diff,
794
	 * perhaps taking advantage of the content's native form. This is required for all content
795
	 * models that are not text based.
796
	 *
797
	 * @since 1.21
798
	 *
799
	 * @param Content $old Old content
800
	 * @param Content $new New content
801
	 *
802
	 * @throws MWException If old or new content is not an instance of TextContent.
803
	 * @return bool|string
804
	 */
805
	public function generateContentDiffBody( Content $old, Content $new ) {
806 View Code Duplication
		if ( !( $old instanceof TextContent ) ) {
807
			throw new MWException( "Diff not implemented for " . get_class( $old ) . "; " .
808
				"override generateContentDiffBody to fix this." );
809
		}
810
811 View Code Duplication
		if ( !( $new instanceof TextContent ) ) {
812
			throw new MWException( "Diff not implemented for " . get_class( $new ) . "; "
813
				. "override generateContentDiffBody to fix this." );
814
		}
815
816
		$otext = $old->serialize();
817
		$ntext = $new->serialize();
818
819
		return $this->generateTextDiffBody( $otext, $ntext );
820
	}
821
822
	/**
823
	 * Generate a diff, no caching
824
	 *
825
	 * @todo move this to TextDifferenceEngine, make DifferenceEngine abstract. At some point.
826
	 *
827
	 * @param string $otext Old text, must be already segmented
828
	 * @param string $ntext New text, must be already segmented
829
	 *
830
	 * @return bool|string
831
	 */
832
	public function generateTextDiffBody( $otext, $ntext ) {
833
		$diff = function() use ( $otext, $ntext ) {
834
			$time = microtime( true );
835
836
			$result = $this->textDiff( $otext, $ntext );
837
838
			$time = intval( ( microtime( true ) - $time ) * 1000 );
839
			$this->getStats()->timing( 'diff_time', $time );
840
			// Log requests slower than 99th percentile
841
			if ( $time > 100 && $this->mOldPage && $this->mNewPage ) {
842
				wfDebugLog( 'diff',
843
					"$time ms diff: {$this->mOldid} -> {$this->mNewid} {$this->mNewPage}" );
844
			}
845
846
			return $result;
847
		};
848
849
		$error = function( $status ) {
850
			throw new FatalError( $status->getWikiText() );
851
		};
852
853
		// Use PoolCounter if the diff looks like it can be expensive
854
		if ( strlen( $otext ) + strlen( $ntext ) > 20000 ) {
855
			$work = new PoolCounterWorkViaCallback( 'diff',
856
				md5( $otext ) . md5( $ntext ),
857
				[ 'doWork' => $diff, 'error' => $error ]
858
			);
859
			return $work->execute();
860
		}
861
862
		return $diff();
863
	}
864
865
	/**
866
	 * Generates diff, to be wrapped internally in a logging/instrumentation
867
	 *
868
	 * @param string $otext Old text, must be already segmented
869
	 * @param string $ntext New text, must be already segmented
870
	 * @return bool|string
871
	 */
872
	protected function textDiff( $otext, $ntext ) {
873
		global $wgExternalDiffEngine, $wgContLang;
874
875
		$otext = str_replace( "\r\n", "\n", $otext );
876
		$ntext = str_replace( "\r\n", "\n", $ntext );
877
878
		if ( $wgExternalDiffEngine == 'wikidiff' || $wgExternalDiffEngine == 'wikidiff3' ) {
879
			wfDeprecated( "\$wgExternalDiffEngine = '{$wgExternalDiffEngine}'", '1.27' );
880
			$wgExternalDiffEngine = false;
881
		} elseif ( $wgExternalDiffEngine == 'wikidiff2' ) {
882
			// Same as above, but with no deprecation warnings
883
			$wgExternalDiffEngine = false;
884
		} elseif ( !is_string( $wgExternalDiffEngine ) && $wgExternalDiffEngine !== false ) {
885
			// And prevent people from shooting themselves in the foot...
886
			wfWarn( '$wgExternalDiffEngine is set to a non-string value, forcing it to false' );
887
			$wgExternalDiffEngine = false;
888
		}
889
890
		if ( function_exists( 'wikidiff2_do_diff' ) && $wgExternalDiffEngine === false ) {
891
			# Better external diff engine, the 2 may some day be dropped
892
			# This one does the escaping and segmenting itself
893
			$text = wikidiff2_do_diff( $otext, $ntext, 2 );
894
			$text .= $this->debug( 'wikidiff2' );
895
896
			return $text;
897
		} elseif ( $wgExternalDiffEngine !== false && is_executable( $wgExternalDiffEngine ) ) {
898
			# Diff via the shell
899
			$tmpDir = wfTempDir();
900
			$tempName1 = tempnam( $tmpDir, 'diff_' );
901
			$tempName2 = tempnam( $tmpDir, 'diff_' );
902
903
			$tempFile1 = fopen( $tempName1, "w" );
904
			if ( !$tempFile1 ) {
905
				return false;
906
			}
907
			$tempFile2 = fopen( $tempName2, "w" );
908
			if ( !$tempFile2 ) {
909
				return false;
910
			}
911
			fwrite( $tempFile1, $otext );
912
			fwrite( $tempFile2, $ntext );
913
			fclose( $tempFile1 );
914
			fclose( $tempFile2 );
915
			$cmd = wfEscapeShellArg( $wgExternalDiffEngine, $tempName1, $tempName2 );
916
			$difftext = wfShellExec( $cmd );
917
			$difftext .= $this->debug( "external $wgExternalDiffEngine" );
918
			unlink( $tempName1 );
919
			unlink( $tempName2 );
920
921
			return $difftext;
922
		}
923
924
		# Native PHP diff
925
		$ota = explode( "\n", $wgContLang->segmentForDiff( $otext ) );
926
		$nta = explode( "\n", $wgContLang->segmentForDiff( $ntext ) );
927
		$diffs = new Diff( $ota, $nta );
928
		$formatter = new TableDiffFormatter();
929
		$difftext = $wgContLang->unsegmentForDiff( $formatter->format( $diffs ) );
930
931
		return $difftext;
932
	}
933
934
	/**
935
	 * Generate a debug comment indicating diff generating time,
936
	 * server node, and generator backend.
937
	 *
938
	 * @param string $generator : What diff engine was used
939
	 *
940
	 * @return string
941
	 */
942
	protected function debug( $generator = "internal" ) {
943
		global $wgShowHostnames;
944
		if ( !$this->enableDebugComment ) {
945
			return '';
946
		}
947
		$data = [ $generator ];
948
		if ( $wgShowHostnames ) {
949
			$data[] = wfHostname();
950
		}
951
		$data[] = wfTimestamp( TS_DB );
952
953
		return "<!-- diff generator: " .
954
			implode( " ", array_map( "htmlspecialchars", $data ) ) .
955
			" -->\n";
956
	}
957
958
	/**
959
	 * Replace line numbers with the text in the user's language
960
	 *
961
	 * @param string $text
962
	 *
963
	 * @return mixed
964
	 */
965
	public function localiseLineNumbers( $text ) {
966
		return preg_replace_callback(
967
			'/<!--LINE (\d+)-->/',
968
			[ &$this, 'localiseLineNumbersCb' ],
969
			$text
970
		);
971
	}
972
973
	public function localiseLineNumbersCb( $matches ) {
974
		if ( $matches[1] === '1' && $this->mReducedLineNumbers ) {
975
			return '';
976
		}
977
978
		return $this->msg( 'lineno' )->numParams( $matches[1] )->escaped();
979
	}
980
981
	/**
982
	 * If there are revisions between the ones being compared, return a note saying so.
983
	 *
984
	 * @return string
985
	 */
986
	public function getMultiNotice() {
987
		if ( !is_object( $this->mOldRev ) || !is_object( $this->mNewRev ) ) {
988
			return '';
989
		} elseif ( !$this->mOldPage->equals( $this->mNewPage ) ) {
990
			// Comparing two different pages? Count would be meaningless.
991
			return '';
992
		}
993
994
		if ( $this->mOldRev->getTimestamp() > $this->mNewRev->getTimestamp() ) {
995
			$oldRev = $this->mNewRev; // flip
996
			$newRev = $this->mOldRev; // flip
997
		} else { // normal case
998
			$oldRev = $this->mOldRev;
999
			$newRev = $this->mNewRev;
1000
		}
1001
1002
		// Sanity: don't show the notice if too many rows must be scanned
1003
		// @todo show some special message for that case
1004
		$nEdits = $this->mNewPage->countRevisionsBetween( $oldRev, $newRev, 1000 );
1005
		if ( $nEdits > 0 && $nEdits <= 1000 ) {
1006
			$limit = 100; // use diff-multi-manyusers if too many users
1007
			$users = $this->mNewPage->getAuthorsBetween( $oldRev, $newRev, $limit );
1008
			$numUsers = count( $users );
1009
1010
			if ( $numUsers == 1 && $users[0] == $newRev->getUserText( Revision::RAW ) ) {
1011
				$numUsers = 0; // special case to say "by the same user" instead of "by one other user"
1012
			}
1013
1014
			return self::intermediateEditsMsg( $nEdits, $numUsers, $limit );
1015
		}
1016
1017
		return ''; // nothing
1018
	}
1019
1020
	/**
1021
	 * Get a notice about how many intermediate edits and users there are
1022
	 *
1023
	 * @param int $numEdits
1024
	 * @param int $numUsers
1025
	 * @param int $limit
1026
	 *
1027
	 * @return string
1028
	 */
1029
	public static function intermediateEditsMsg( $numEdits, $numUsers, $limit ) {
1030
		if ( $numUsers === 0 ) {
1031
			$msg = 'diff-multi-sameuser';
1032
		} elseif ( $numUsers > $limit ) {
1033
			$msg = 'diff-multi-manyusers';
1034
			$numUsers = $limit;
1035
		} else {
1036
			$msg = 'diff-multi-otherusers';
1037
		}
1038
1039
		return wfMessage( $msg )->numParams( $numEdits, $numUsers )->parse();
1040
	}
1041
1042
	/**
1043
	 * Get a header for a specified revision.
1044
	 *
1045
	 * @param Revision $rev
1046
	 * @param string $complete 'complete' to get the header wrapped depending
1047
	 *        the visibility of the revision and a link to edit the page.
1048
	 *
1049
	 * @return string HTML fragment
1050
	 */
1051
	protected function getRevisionHeader( Revision $rev, $complete = '' ) {
1052
		$lang = $this->getLanguage();
1053
		$user = $this->getUser();
1054
		$revtimestamp = $rev->getTimestamp();
1055
		$timestamp = $lang->userTimeAndDate( $revtimestamp, $user );
1056
		$dateofrev = $lang->userDate( $revtimestamp, $user );
1057
		$timeofrev = $lang->userTime( $revtimestamp, $user );
1058
1059
		$header = $this->msg(
1060
			$rev->isCurrent() ? 'currentrev-asof' : 'revisionasof',
1061
			$timestamp,
1062
			$dateofrev,
1063
			$timeofrev
1064
		)->escaped();
1065
1066
		if ( $complete !== 'complete' ) {
1067
			return $header;
1068
		}
1069
1070
		$title = $rev->getTitle();
1071
1072
		$header = Linker::linkKnown( $title, $header, [],
1073
			[ 'oldid' => $rev->getId() ] );
1074
1075
		if ( $rev->userCan( Revision::DELETED_TEXT, $user ) ) {
1076
			$editQuery = [ 'action' => 'edit' ];
1077
			if ( !$rev->isCurrent() ) {
1078
				$editQuery['oldid'] = $rev->getId();
1079
			}
1080
1081
			$key = $title->quickUserCan( 'edit', $user ) ? 'editold' : 'viewsourceold';
1082
			$msg = $this->msg( $key )->escaped();
1083
			$editLink = $this->msg( 'parentheses' )->rawParams(
1084
				Linker::linkKnown( $title, $msg, [], $editQuery ) )->escaped();
1085
			$header .= ' ' . Html::rawElement(
1086
				'span',
1087
				[ 'class' => 'mw-diff-edit' ],
1088
				$editLink
1089
			);
1090
			if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
1091
				$header = Html::rawElement(
1092
					'span',
1093
					[ 'class' => 'history-deleted' ],
1094
					$header
1095
				);
1096
			}
1097
		} else {
1098
			$header = Html::rawElement( 'span', [ 'class' => 'history-deleted' ], $header );
1099
		}
1100
1101
		return $header;
1102
	}
1103
1104
	/**
1105
	 * Add the header to a diff body
1106
	 *
1107
	 * @param string $diff Diff body
1108
	 * @param string $otitle Old revision header
1109
	 * @param string $ntitle New revision header
1110
	 * @param string $multi Notice telling user that there are intermediate
1111
	 *   revisions between the ones being compared
1112
	 * @param string $notice Other notices, e.g. that user is viewing deleted content
1113
	 *
1114
	 * @return string
1115
	 */
1116
	public function addHeader( $diff, $otitle, $ntitle, $multi = '', $notice = '' ) {
1117
		// shared.css sets diff in interface language/dir, but the actual content
1118
		// is often in a different language, mostly the page content language/dir
1119
		$header = Html::openElement( 'table', [
1120
			'class' => [ 'diff', 'diff-contentalign-' . $this->getDiffLang()->alignStart() ],
1121
			'data-mw' => 'interface',
1122
		] );
1123
		$userLang = htmlspecialchars( $this->getLanguage()->getHtmlCode() );
1124
1125
		if ( !$diff && !$otitle ) {
1126
			$header .= "
1127
			<tr style='vertical-align: top;' lang='{$userLang}'>
1128
			<td class='diff-ntitle'>{$ntitle}</td>
1129
			</tr>";
1130
			$multiColspan = 1;
1131
		} else {
1132
			if ( $diff ) { // Safari/Chrome show broken output if cols not used
1133
				$header .= "
1134
				<col class='diff-marker' />
1135
				<col class='diff-content' />
1136
				<col class='diff-marker' />
1137
				<col class='diff-content' />";
1138
				$colspan = 2;
1139
				$multiColspan = 4;
1140
			} else {
1141
				$colspan = 1;
1142
				$multiColspan = 2;
1143
			}
1144
			if ( $otitle || $ntitle ) {
1145
				$header .= "
1146
				<tr style='vertical-align: top;' lang='{$userLang}'>
1147
				<td colspan='$colspan' class='diff-otitle'>{$otitle}</td>
1148
				<td colspan='$colspan' class='diff-ntitle'>{$ntitle}</td>
1149
				</tr>";
1150
			}
1151
		}
1152
1153
		if ( $multi != '' ) {
1154
			$header .= "<tr><td colspan='{$multiColspan}' style='text-align: center;' " .
1155
				"class='diff-multi' lang='{$userLang}'>{$multi}</td></tr>";
1156
		}
1157
		if ( $notice != '' ) {
1158
			$header .= "<tr><td colspan='{$multiColspan}' style='text-align: center;' " .
1159
				"lang='{$userLang}'>{$notice}</td></tr>";
1160
		}
1161
1162
		return $header . $diff . "</table>";
1163
	}
1164
1165
	/**
1166
	 * Use specified text instead of loading from the database
1167
	 * @param Content $oldContent
1168
	 * @param Content $newContent
1169
	 * @since 1.21
1170
	 */
1171
	public function setContent( Content $oldContent, Content $newContent ) {
1172
		$this->mOldContent = $oldContent;
1173
		$this->mNewContent = $newContent;
1174
1175
		$this->mTextLoaded = 2;
1176
		$this->mRevisionsLoaded = true;
1177
	}
1178
1179
	/**
1180
	 * Set the language in which the diff text is written
1181
	 * (Defaults to page content language).
1182
	 * @param Language|string $lang
1183
	 * @since 1.19
1184
	 */
1185
	public function setTextLanguage( $lang ) {
1186
		$this->mDiffLang = wfGetLangObj( $lang );
1187
	}
1188
1189
	/**
1190
	 * Maps a revision pair definition as accepted by DifferenceEngine constructor
1191
	 * to a pair of actual integers representing revision ids.
1192
	 *
1193
	 * @param int $old Revision id, e.g. from URL parameter 'oldid'
1194
	 * @param int|string $new Revision id or strings 'next' or 'prev', e.g. from URL parameter 'diff'
1195
	 *
1196
	 * @return int[] List of two revision ids, older first, later second.
1197
	 *     Zero signifies invalid argument passed.
1198
	 *     false signifies that there is no previous/next revision ($old is the oldest/newest one).
1199
	 */
1200
	public function mapDiffPrevNext( $old, $new ) {
1201
		if ( $new === 'prev' ) {
1202
			// Show diff between revision $old and the previous one. Get previous one from DB.
1203
			$newid = intval( $old );
1204
			$oldid = $this->getTitle()->getPreviousRevisionID( $newid );
1205
		} elseif ( $new === 'next' ) {
1206
			// Show diff between revision $old and the next one. Get next one from DB.
1207
			$oldid = intval( $old );
1208
			$newid = $this->getTitle()->getNextRevisionID( $oldid );
1209
		} else {
1210
			$oldid = intval( $old );
1211
			$newid = intval( $new );
1212
		}
1213
1214
		return [ $oldid, $newid ];
1215
	}
1216
1217
	/**
1218
	 * Load revision IDs
1219
	 */
1220
	private function loadRevisionIds() {
1221
		if ( $this->mRevisionsIdsLoaded ) {
1222
			return;
1223
		}
1224
1225
		$this->mRevisionsIdsLoaded = true;
1226
1227
		$old = $this->mOldid;
1228
		$new = $this->mNewid;
1229
1230
		list( $this->mOldid, $this->mNewid ) = self::mapDiffPrevNext( $old, $new );
1231
		if ( $new === 'next' && $this->mNewid === false ) {
1232
			# if no result, NewId points to the newest old revision. The only newer
1233
			# revision is cur, which is "0".
1234
			$this->mNewid = 0;
1235
		}
1236
1237
		Hooks::run(
1238
			'NewDifferenceEngine',
1239
			[ $this->getTitle(), &$this->mOldid, &$this->mNewid, $old, $new ]
1240
		);
1241
	}
1242
1243
	/**
1244
	 * Load revision metadata for the specified articles. If newid is 0, then compare
1245
	 * the old article in oldid to the current article; if oldid is 0, then
1246
	 * compare the current article to the immediately previous one (ignoring the
1247
	 * value of newid).
1248
	 *
1249
	 * If oldid is false, leave the corresponding revision object set
1250
	 * to false. This is impossible via ordinary user input, and is provided for
1251
	 * API convenience.
1252
	 *
1253
	 * @return bool
1254
	 */
1255
	public function loadRevisionData() {
1256
		if ( $this->mRevisionsLoaded ) {
1257
			return true;
1258
		}
1259
1260
		// Whether it succeeds or fails, we don't want to try again
1261
		$this->mRevisionsLoaded = true;
1262
1263
		$this->loadRevisionIds();
1264
1265
		// Load the new revision object
1266
		if ( $this->mNewid ) {
1267
			$this->mNewRev = Revision::newFromId( $this->mNewid );
1268
		} else {
1269
			$this->mNewRev = Revision::newFromTitle(
1270
				$this->getTitle(),
0 ignored issues
show
Bug introduced by
It seems like $this->getTitle() can be null; however, newFromTitle() does not accept null, maybe add an additional type check?

Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code:

/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
Loading history...
1271
				false,
1272
				Revision::READ_NORMAL
1273
			);
1274
		}
1275
1276
		if ( !$this->mNewRev instanceof Revision ) {
1277
			return false;
1278
		}
1279
1280
		// Update the new revision ID in case it was 0 (makes life easier doing UI stuff)
1281
		$this->mNewid = $this->mNewRev->getId();
1282
		$this->mNewPage = $this->mNewRev->getTitle();
1283
1284
		// Load the old revision object
1285
		$this->mOldRev = false;
0 ignored issues
show
Documentation Bug introduced by
It seems like false of type false is incompatible with the declared type object<Revision> of property $mOldRev.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
1286
		if ( $this->mOldid ) {
1287
			$this->mOldRev = Revision::newFromId( $this->mOldid );
1288
		} elseif ( $this->mOldid === 0 ) {
1289
			$rev = $this->mNewRev->getPrevious();
1290
			if ( $rev ) {
1291
				$this->mOldid = $rev->getId();
1292
				$this->mOldRev = $rev;
1293
			} else {
1294
				// No previous revision; mark to show as first-version only.
1295
				$this->mOldid = false;
0 ignored issues
show
Documentation Bug introduced by
The property $mOldid was declared of type integer, but false is of type false. Maybe add a type cast?

This check looks for assignments to scalar types that may be of the wrong type.

To ensure the code behaves as expected, it may be a good idea to add an explicit type cast.

$answer = 42;

$correct = false;

$correct = (bool) $answer;
Loading history...
1296
				$this->mOldRev = false;
1297
			}
1298
		} /* elseif ( $this->mOldid === false ) leave mOldRev false; */
1299
1300
		if ( is_null( $this->mOldRev ) ) {
1301
			return false;
1302
		}
1303
1304
		if ( $this->mOldRev ) {
1305
			$this->mOldPage = $this->mOldRev->getTitle();
1306
		}
1307
1308
		// Load tags information for both revisions
1309
		$dbr = wfGetDB( DB_SLAVE );
1310
		if ( $this->mOldid !== false ) {
1311
			$this->mOldTags = $dbr->selectField(
1312
				'tag_summary',
1313
				'ts_tags',
1314
				[ 'ts_rev_id' => $this->mOldid ],
1315
				__METHOD__
1316
			);
1317
		} else {
1318
			$this->mOldTags = false;
1319
		}
1320
		$this->mNewTags = $dbr->selectField(
1321
			'tag_summary',
1322
			'ts_tags',
1323
			[ 'ts_rev_id' => $this->mNewid ],
1324
			__METHOD__
1325
		);
1326
1327
		return true;
1328
	}
1329
1330
	/**
1331
	 * Load the text of the revisions, as well as revision data.
1332
	 *
1333
	 * @return bool
1334
	 */
1335
	public function loadText() {
1336
		if ( $this->mTextLoaded == 2 ) {
1337
			return true;
1338
		}
1339
1340
		// Whether it succeeds or fails, we don't want to try again
1341
		$this->mTextLoaded = 2;
1342
1343
		if ( !$this->loadRevisionData() ) {
1344
			return false;
1345
		}
1346
1347 View Code Duplication
		if ( $this->mOldRev ) {
1348
			$this->mOldContent = $this->mOldRev->getContent( Revision::FOR_THIS_USER, $this->getUser() );
1349
			if ( $this->mOldContent === null ) {
1350
				return false;
1351
			}
1352
		}
1353
1354 View Code Duplication
		if ( $this->mNewRev ) {
1355
			$this->mNewContent = $this->mNewRev->getContent( Revision::FOR_THIS_USER, $this->getUser() );
1356
			if ( $this->mNewContent === null ) {
1357
				return false;
1358
			}
1359
		}
1360
1361
		return true;
1362
	}
1363
1364
	/**
1365
	 * Load the text of the new revision, not the old one
1366
	 *
1367
	 * @return bool
1368
	 */
1369
	public function loadNewText() {
1370
		if ( $this->mTextLoaded >= 1 ) {
1371
			return true;
1372
		}
1373
1374
		$this->mTextLoaded = 1;
1375
1376
		if ( !$this->loadRevisionData() ) {
1377
			return false;
1378
		}
1379
1380
		$this->mNewContent = $this->mNewRev->getContent( Revision::FOR_THIS_USER, $this->getUser() );
1381
1382
		return true;
1383
	}
1384
1385
}
1386