Merge "Remove unused alias/layer of test abstraction wfShellMaintenanceCmd()"
[lhc/web/wiklou.git] / includes / diff / DifferenceEngine.php
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 /**
25 * Constant to indicate diff cache compatibility.
26 * Bump this when changing the diff formatting in a way that
27 * fixes important bugs or such to force cached diff views to
28 * clear.
29 */
30 define( 'MW_DIFF_VERSION', '1.11a' );
31
32 /**
33 * @todo document
34 * @ingroup DifferenceEngine
35 */
36 class DifferenceEngine extends ContextSource {
37
38 /** @var int */
39 public $mOldid;
40
41 /** @var int */
42 public $mNewid;
43
44 private $mOldTags;
45 private $mNewTags;
46
47 /** @var Content */
48 public $mOldContent;
49
50 /** @var Content */
51 public $mNewContent;
52
53 /** @var Language */
54 protected $mDiffLang;
55
56 /** @var Title */
57 public $mOldPage;
58
59 /** @var Title */
60 public $mNewPage;
61
62 /** @var Revision */
63 public $mOldRev;
64
65 /** @var Revision */
66 public $mNewRev;
67
68 /** @var bool Have the revisions IDs been loaded */
69 private $mRevisionsIdsLoaded = false;
70
71 /** @var bool Have the revisions been loaded */
72 public $mRevisionsLoaded = false;
73
74 /** @var int How many text blobs have been loaded, 0, 1 or 2? */
75 public $mTextLoaded = 0;
76
77 /** @var bool Was the diff fetched from cache? */
78 public $mCacheHit = false;
79
80 /**
81 * Set this to true to add debug info to the HTML output.
82 * Warning: this may cause RSS readers to spuriously mark articles as "new"
83 * (bug 20601)
84 */
85 public $enableDebugComment = false;
86
87 /** @var bool If true, line X is not displayed when X is 1, for example
88 * to increase readability and conserve space with many small diffs.
89 */
90 protected $mReducedLineNumbers = false;
91
92 /** @var string Link to action=markpatrolled */
93 protected $mMarkPatrolledLink = null;
94
95 /** @var bool Show rev_deleted content if allowed */
96 protected $unhide = false;
97
98 /** @var bool Refresh the diff cache */
99 protected $mRefreshCache = false;
100
101 /**#@-*/
102
103 /**
104 * Constructor
105 * @param IContextSource $context Context to use, anything else will be ignored
106 * @param int $old Old ID we want to show and diff with.
107 * @param string|int $new Either revision ID or 'prev' or 'next'. Default: 0.
108 * @param int $rcid Deprecated, no longer used!
109 * @param bool $refreshCache If set, refreshes the diff cache
110 * @param bool $unhide If set, allow viewing deleted revs
111 */
112 public function __construct( $context = null, $old = 0, $new = 0, $rcid = 0,
113 $refreshCache = false, $unhide = false
114 ) {
115 if ( $context instanceof IContextSource ) {
116 $this->setContext( $context );
117 }
118
119 wfDebug( "DifferenceEngine old '$old' new '$new' rcid '$rcid'\n" );
120
121 $this->mOldid = $old;
122 $this->mNewid = $new;
123 $this->mRefreshCache = $refreshCache;
124 $this->unhide = $unhide;
125 }
126
127 /**
128 * @param bool $value
129 */
130 public function setReducedLineNumbers( $value = true ) {
131 $this->mReducedLineNumbers = $value;
132 }
133
134 /**
135 * @return Language
136 */
137 public function getDiffLang() {
138 if ( $this->mDiffLang === null ) {
139 # Default language in which the diff text is written.
140 $this->mDiffLang = $this->getTitle()->getPageLanguage();
141 }
142
143 return $this->mDiffLang;
144 }
145
146 /**
147 * @return bool
148 */
149 public function wasCacheHit() {
150 return $this->mCacheHit;
151 }
152
153 /**
154 * @return int
155 */
156 public function getOldid() {
157 $this->loadRevisionIds();
158
159 return $this->mOldid;
160 }
161
162 /**
163 * @return bool|int
164 */
165 public function getNewid() {
166 $this->loadRevisionIds();
167
168 return $this->mNewid;
169 }
170
171 /**
172 * Look up a special:Undelete link to the given deleted revision id,
173 * as a workaround for being unable to load deleted diffs in currently.
174 *
175 * @param int $id Revision ID
176 *
177 * @return mixed URL or false
178 */
179 public function deletedLink( $id ) {
180 if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
181 $dbr = wfGetDB( DB_SLAVE );
182 $row = $dbr->selectRow( 'archive', '*',
183 array( 'ar_rev_id' => $id ),
184 __METHOD__ );
185 if ( $row ) {
186 $rev = Revision::newFromArchiveRow( $row );
187 $title = Title::makeTitleSafe( $row->ar_namespace, $row->ar_title );
188
189 return SpecialPage::getTitleFor( 'Undelete' )->getFullURL( array(
190 'target' => $title->getPrefixedText(),
191 'timestamp' => $rev->getTimestamp()
192 ) );
193 }
194 }
195
196 return false;
197 }
198
199 /**
200 * Build a wikitext link toward a deleted revision, if viewable.
201 *
202 * @param int $id Revision ID
203 *
204 * @return string Wikitext fragment
205 */
206 public function deletedIdMarker( $id ) {
207 $link = $this->deletedLink( $id );
208 if ( $link ) {
209 return "[$link $id]";
210 } else {
211 return $id;
212 }
213 }
214
215 private function showMissingRevision() {
216 $out = $this->getOutput();
217
218 $missing = array();
219 if ( $this->mOldRev === null ||
220 ( $this->mOldRev && $this->mOldContent === null )
221 ) {
222 $missing[] = $this->deletedIdMarker( $this->mOldid );
223 }
224 if ( $this->mNewRev === null ||
225 ( $this->mNewRev && $this->mNewContent === null )
226 ) {
227 $missing[] = $this->deletedIdMarker( $this->mNewid );
228 }
229
230 $out->setPageTitle( $this->msg( 'errorpagetitle' ) );
231 $msg = $this->msg( 'difference-missing-revision' )
232 ->params( $this->getLanguage()->listToText( $missing ) )
233 ->numParams( count( $missing ) )
234 ->parseAsBlock();
235 $out->addHtml( $msg );
236 }
237
238 public function showDiffPage( $diffOnly = false ) {
239
240 # Allow frames except in certain special cases
241 $out = $this->getOutput();
242 $out->allowClickjacking();
243 $out->setRobotPolicy( 'noindex,nofollow' );
244
245 if ( !$this->loadRevisionData() ) {
246 $this->showMissingRevision();
247
248 return;
249 }
250
251 $user = $this->getUser();
252 $permErrors = $this->mNewPage->getUserPermissionsErrors( 'read', $user );
253 if ( $this->mOldPage ) { # mOldPage might not be set, see below.
254 $permErrors = wfMergeErrorArrays( $permErrors,
255 $this->mOldPage->getUserPermissionsErrors( 'read', $user ) );
256 }
257 if ( count( $permErrors ) ) {
258 throw new PermissionsError( 'read', $permErrors );
259 }
260
261 $rollback = '';
262
263 $query = array();
264 # Carry over 'diffonly' param via navigation links
265 if ( $diffOnly != $user->getBoolOption( 'diffonly' ) ) {
266 $query['diffonly'] = $diffOnly;
267 }
268 # Cascade unhide param in links for easy deletion browsing
269 if ( $this->unhide ) {
270 $query['unhide'] = 1;
271 }
272
273 # Check if one of the revisions is deleted/suppressed
274 $deleted = $suppressed = false;
275 $allowed = $this->mNewRev->userCan( Revision::DELETED_TEXT, $user );
276
277 $revisionTools = array();
278
279 # mOldRev is false if the difference engine is called with a "vague" query for
280 # a diff between a version V and its previous version V' AND the version V
281 # is the first version of that article. In that case, V' does not exist.
282 if ( $this->mOldRev === false ) {
283 $out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage->getPrefixedText() ) );
284 $samePage = true;
285 $oldHeader = '';
286 } else {
287 Hooks::run( 'DiffViewHeader', array( $this, $this->mOldRev, $this->mNewRev ) );
288
289 if ( $this->mNewPage->equals( $this->mOldPage ) ) {
290 $out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage->getPrefixedText() ) );
291 $samePage = true;
292 } else {
293 $out->setPageTitle( $this->msg( 'difference-title-multipage',
294 $this->mOldPage->getPrefixedText(), $this->mNewPage->getPrefixedText() ) );
295 $out->addSubtitle( $this->msg( 'difference-multipage' ) );
296 $samePage = false;
297 }
298
299 if ( $samePage && $this->mNewPage->quickUserCan( 'edit', $user ) ) {
300 if ( $this->mNewRev->isCurrent() && $this->mNewPage->userCan( 'rollback', $user ) ) {
301 $rollbackLink = Linker::generateRollback( $this->mNewRev, $this->getContext() );
302 if ( $rollbackLink ) {
303 $out->preventClickjacking();
304 $rollback = '&#160;&#160;&#160;' . $rollbackLink;
305 }
306 }
307
308 if ( !$this->mOldRev->isDeleted( Revision::DELETED_TEXT ) &&
309 !$this->mNewRev->isDeleted( Revision::DELETED_TEXT )
310 ) {
311 $undoLink = Html::element( 'a', array(
312 'href' => $this->mNewPage->getLocalURL( array(
313 'action' => 'edit',
314 'undoafter' => $this->mOldid,
315 'undo' => $this->mNewid
316 ) ),
317 'title' => Linker::titleAttrib( 'undo' ),
318 ),
319 $this->msg( 'editundo' )->text()
320 );
321 $revisionTools['mw-diff-undo'] = $undoLink;
322 }
323 }
324
325 # Make "previous revision link"
326 if ( $samePage && $this->mOldRev->getPrevious() ) {
327 $prevlink = Linker::linkKnown(
328 $this->mOldPage,
329 $this->msg( 'previousdiff' )->escaped(),
330 array( 'id' => 'differences-prevlink' ),
331 array( 'diff' => 'prev', 'oldid' => $this->mOldid ) + $query
332 );
333 } else {
334 $prevlink = '&#160;';
335 }
336
337 if ( $this->mOldRev->isMinor() ) {
338 $oldminor = ChangesList::flag( 'minor' );
339 } else {
340 $oldminor = '';
341 }
342
343 $ldel = $this->revisionDeleteLink( $this->mOldRev );
344 $oldRevisionHeader = $this->getRevisionHeader( $this->mOldRev, 'complete' );
345 $oldChangeTags = ChangeTags::formatSummaryRow( $this->mOldTags, 'diff' );
346
347 $oldHeader = '<div id="mw-diff-otitle1"><strong>' . $oldRevisionHeader . '</strong></div>' .
348 '<div id="mw-diff-otitle2">' .
349 Linker::revUserTools( $this->mOldRev, !$this->unhide ) . '</div>' .
350 '<div id="mw-diff-otitle3">' . $oldminor .
351 Linker::revComment( $this->mOldRev, !$diffOnly, !$this->unhide ) . $ldel . '</div>' .
352 '<div id="mw-diff-otitle5">' . $oldChangeTags[0] . '</div>' .
353 '<div id="mw-diff-otitle4">' . $prevlink . '</div>';
354
355 if ( $this->mOldRev->isDeleted( Revision::DELETED_TEXT ) ) {
356 $deleted = true; // old revisions text is hidden
357 if ( $this->mOldRev->isDeleted( Revision::DELETED_RESTRICTED ) ) {
358 $suppressed = true; // also suppressed
359 }
360 }
361
362 # Check if this user can see the revisions
363 if ( !$this->mOldRev->userCan( Revision::DELETED_TEXT, $user ) ) {
364 $allowed = false;
365 }
366 }
367
368 # Make "next revision link"
369 # Skip next link on the top revision
370 if ( $samePage && !$this->mNewRev->isCurrent() ) {
371 $nextlink = Linker::linkKnown(
372 $this->mNewPage,
373 $this->msg( 'nextdiff' )->escaped(),
374 array( 'id' => 'differences-nextlink' ),
375 array( 'diff' => 'next', 'oldid' => $this->mNewid ) + $query
376 );
377 } else {
378 $nextlink = '&#160;';
379 }
380
381 if ( $this->mNewRev->isMinor() ) {
382 $newminor = ChangesList::flag( 'minor' );
383 } else {
384 $newminor = '';
385 }
386
387 # Handle RevisionDelete links...
388 $rdel = $this->revisionDeleteLink( $this->mNewRev );
389
390 # Allow extensions to define their own revision tools
391 Hooks::run( 'DiffRevisionTools', array( $this->mNewRev, &$revisionTools, $this->mOldRev ) );
392 $formattedRevisionTools = array();
393 // Put each one in parentheses (poor man's button)
394 foreach ( $revisionTools as $key => $tool ) {
395 $toolClass = is_string( $key ) ? $key : 'mw-diff-tool';
396 $element = Html::rawElement(
397 'span',
398 array( 'class' => $toolClass ),
399 $this->msg( 'parentheses' )->rawParams( $tool )->escaped()
400 );
401 $formattedRevisionTools[] = $element;
402 }
403 $newRevisionHeader = $this->getRevisionHeader( $this->mNewRev, 'complete' ) .
404 ' ' . implode( ' ', $formattedRevisionTools );
405 $newChangeTags = ChangeTags::formatSummaryRow( $this->mNewTags, 'diff' );
406
407 $newHeader = '<div id="mw-diff-ntitle1"><strong>' . $newRevisionHeader . '</strong></div>' .
408 '<div id="mw-diff-ntitle2">' . Linker::revUserTools( $this->mNewRev, !$this->unhide ) .
409 " $rollback</div>" .
410 '<div id="mw-diff-ntitle3">' . $newminor .
411 Linker::revComment( $this->mNewRev, !$diffOnly, !$this->unhide ) . $rdel . '</div>' .
412 '<div id="mw-diff-ntitle5">' . $newChangeTags[0] . '</div>' .
413 '<div id="mw-diff-ntitle4">' . $nextlink . $this->markPatrolledLink() . '</div>';
414
415 if ( $this->mNewRev->isDeleted( Revision::DELETED_TEXT ) ) {
416 $deleted = true; // new revisions text is hidden
417 if ( $this->mNewRev->isDeleted( Revision::DELETED_RESTRICTED ) ) {
418 $suppressed = true; // also suppressed
419 }
420 }
421
422 # If the diff cannot be shown due to a deleted revision, then output
423 # the diff header and links to unhide (if available)...
424 if ( $deleted && ( !$this->unhide || !$allowed ) ) {
425 $this->showDiffStyle();
426 $multi = $this->getMultiNotice();
427 $out->addHTML( $this->addHeader( '', $oldHeader, $newHeader, $multi ) );
428 if ( !$allowed ) {
429 $msg = $suppressed ? 'rev-suppressed-no-diff' : 'rev-deleted-no-diff';
430 # Give explanation for why revision is not visible
431 $out->wrapWikiMsg( "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
432 array( $msg ) );
433 } else {
434 # Give explanation and add a link to view the diff...
435 $query = $this->getRequest()->appendQueryValue( 'unhide', '1', true );
436 $link = $this->getTitle()->getFullURL( $query );
437 $msg = $suppressed ? 'rev-suppressed-unhide-diff' : 'rev-deleted-unhide-diff';
438 $out->wrapWikiMsg(
439 "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
440 array( $msg, $link )
441 );
442 }
443 # Otherwise, output a regular diff...
444 } else {
445 # Add deletion notice if the user is viewing deleted content
446 $notice = '';
447 if ( $deleted ) {
448 $msg = $suppressed ? 'rev-suppressed-diff-view' : 'rev-deleted-diff-view';
449 $notice = "<div id='mw-$msg' class='mw-warning plainlinks'>\n" .
450 $this->msg( $msg )->parse() .
451 "</div>\n";
452 }
453 $this->showDiff( $oldHeader, $newHeader, $notice );
454 if ( !$diffOnly ) {
455 $this->renderNewRevision();
456 }
457 }
458 }
459
460 /**
461 * Get a link to mark the change as patrolled, or '' if there's either no
462 * revision to patrol or the user is not allowed to to it.
463 * Side effect: When the patrol link is build, this method will call
464 * OutputPage::preventClickjacking() and load mediawiki.page.patrol.ajax.
465 *
466 * @return string
467 */
468 protected function markPatrolledLink() {
469 global $wgUseRCPatrol, $wgEnableAPI, $wgEnableWriteAPI;
470 $user = $this->getUser();
471
472 if ( $this->mMarkPatrolledLink === null ) {
473 // Prepare a change patrol link, if applicable
474 if (
475 // Is patrolling enabled and the user allowed to?
476 $wgUseRCPatrol && $this->mNewPage->quickUserCan( 'patrol', $user ) &&
477 // Only do this if the revision isn't more than 6 hours older
478 // than the Max RC age (6h because the RC might not be cleaned out regularly)
479 RecentChange::isInRCLifespan( $this->mNewRev->getTimestamp(), 21600 )
480 ) {
481 // Look for an unpatrolled change corresponding to this diff
482
483 $db = wfGetDB( DB_SLAVE );
484 $change = RecentChange::newFromConds(
485 array(
486 'rc_timestamp' => $db->timestamp( $this->mNewRev->getTimestamp() ),
487 'rc_this_oldid' => $this->mNewid,
488 'rc_patrolled' => 0
489 ),
490 __METHOD__,
491 array( 'USE INDEX' => 'rc_timestamp' )
492 );
493
494 if ( $change && !$change->getPerformer()->equals( $user ) ) {
495 $rcid = $change->getAttribute( 'rc_id' );
496 } else {
497 // None found or the page has been created by the current user.
498 // If the user could patrol this it already would be patrolled
499 $rcid = 0;
500 }
501 // Build the link
502 if ( $rcid ) {
503 $this->getOutput()->preventClickjacking();
504 if ( $wgEnableAPI && $wgEnableWriteAPI
505 && $user->isAllowed( 'writeapi' )
506 ) {
507 $this->getOutput()->addModules( 'mediawiki.page.patrol.ajax' );
508 }
509
510 $token = $user->getEditToken( $rcid );
511 $this->mMarkPatrolledLink = ' <span class="patrollink">[' . Linker::linkKnown(
512 $this->mNewPage,
513 $this->msg( 'markaspatrolleddiff' )->escaped(),
514 array(),
515 array(
516 'action' => 'markpatrolled',
517 'rcid' => $rcid,
518 'token' => $token,
519 )
520 ) . ']</span>';
521 } else {
522 $this->mMarkPatrolledLink = '';
523 }
524 } else {
525 $this->mMarkPatrolledLink = '';
526 }
527 }
528
529 return $this->mMarkPatrolledLink;
530 }
531
532 /**
533 * @param Revision $rev
534 *
535 * @return string
536 */
537 protected function revisionDeleteLink( $rev ) {
538 $link = Linker::getRevDeleteLink( $this->getUser(), $rev, $rev->getTitle() );
539 if ( $link !== '' ) {
540 $link = '&#160;&#160;&#160;' . $link . ' ';
541 }
542
543 return $link;
544 }
545
546 /**
547 * Show the new revision of the page.
548 */
549 public function renderNewRevision() {
550 $out = $this->getOutput();
551 $revHeader = $this->getRevisionHeader( $this->mNewRev );
552 # Add "current version as of X" title
553 $out->addHTML( "<hr class='diff-hr' />
554 <h2 class='diff-currentversion-title'>{$revHeader}</h2>\n" );
555 # Page content may be handled by a hooked call instead...
556 # @codingStandardsIgnoreStart Ignoring long lines.
557 if ( Hooks::run( 'ArticleContentOnDiff', array( $this, $out ) ) ) {
558 $this->loadNewText();
559 $out->setRevisionId( $this->mNewid );
560 $out->setRevisionTimestamp( $this->mNewRev->getTimestamp() );
561 $out->setArticleFlag( true );
562
563 // NOTE: only needed for B/C: custom rendering of JS/CSS via hook
564 if ( $this->mNewPage->isCssJsSubpage() || $this->mNewPage->isCssOrJsPage() ) {
565 // This needs to be synchronised with Article::showCssOrJsPage(), which sucks
566 // Give hooks a chance to customise the output
567 // @todo standardize this crap into one function
568 if ( ContentHandler::runLegacyHooks( 'ShowRawCssJs', array( $this->mNewContent, $this->mNewPage, $out ) ) ) {
569 // NOTE: deprecated hook, B/C only
570 // use the content object's own rendering
571 $cnt = $this->mNewRev->getContent();
572 $po = $cnt ? $cnt->getParserOutput( $this->mNewRev->getTitle(), $this->mNewRev->getId() ) : null;
573 if ( $po ) {
574 $out->addParserOutputContent( $po );
575 }
576 }
577 } elseif ( !Hooks::run( 'ArticleContentViewCustom', array( $this->mNewContent, $this->mNewPage, $out ) ) ) {
578 // Handled by extension
579 } elseif ( !ContentHandler::runLegacyHooks( 'ArticleViewCustom', array( $this->mNewContent, $this->mNewPage, $out ) ) ) {
580 // NOTE: deprecated hook, B/C only
581 // Handled by extension
582 } else {
583 // Normal page
584 if ( $this->getTitle()->equals( $this->mNewPage ) ) {
585 // If the Title stored in the context is the same as the one
586 // of the new revision, we can use its associated WikiPage
587 // object.
588 $wikiPage = $this->getWikiPage();
589 } else {
590 // Otherwise we need to create our own WikiPage object
591 $wikiPage = WikiPage::factory( $this->mNewPage );
592 }
593
594 $parserOutput = $this->getParserOutput( $wikiPage, $this->mNewRev );
595
596 # WikiPage::getParserOutput() should not return false, but just in case
597 if ( $parserOutput ) {
598 $out->addParserOutput( $parserOutput );
599 }
600 }
601 }
602 # @codingStandardsIgnoreEnd
603
604 # Add redundant patrol link on bottom...
605 $out->addHTML( $this->markPatrolledLink() );
606
607 }
608
609 protected function getParserOutput( WikiPage $page, Revision $rev ) {
610 $parserOptions = $page->makeParserOptions( $this->getContext() );
611
612 if ( !$rev->isCurrent() || !$rev->getTitle()->quickUserCan( 'edit', $this->getUser() ) ) {
613 $parserOptions->setEditSection( false );
614 }
615
616 $parserOutput = $page->getParserOutput( $parserOptions, $rev->getId() );
617
618 return $parserOutput;
619 }
620
621 /**
622 * Get the diff text, send it to the OutputPage object
623 * Returns false if the diff could not be generated, otherwise returns true
624 *
625 * @param string|bool $otitle Header for old text or false
626 * @param string|bool $ntitle Header for new text or false
627 * @param string $notice HTML between diff header and body
628 *
629 * @return bool
630 */
631 public function showDiff( $otitle, $ntitle, $notice = '' ) {
632 $diff = $this->getDiff( $otitle, $ntitle, $notice );
633 if ( $diff === false ) {
634 $this->showMissingRevision();
635
636 return false;
637 } else {
638 $this->showDiffStyle();
639 $this->getOutput()->addHTML( $diff );
640
641 return true;
642 }
643 }
644
645 /**
646 * Add style sheets and supporting JS for diff display.
647 */
648 public function showDiffStyle() {
649 $this->getOutput()->addModuleStyles( 'mediawiki.action.history.diff' );
650 }
651
652 /**
653 * Get complete diff table, including header
654 *
655 * @param string|bool $otitle Header for old text or false
656 * @param string|bool $ntitle Header for new text or false
657 * @param string $notice HTML between diff header and body
658 *
659 * @return mixed
660 */
661 public function getDiff( $otitle, $ntitle, $notice = '' ) {
662 $body = $this->getDiffBody();
663 if ( $body === false ) {
664 return false;
665 }
666
667 $multi = $this->getMultiNotice();
668 // Display a message when the diff is empty
669 if ( $body === '' ) {
670 $notice .= '<div class="mw-diff-empty">' .
671 $this->msg( 'diff-empty' )->parse() .
672 "</div>\n";
673 }
674
675 return $this->addHeader( $body, $otitle, $ntitle, $multi, $notice );
676 }
677
678 /**
679 * Get the diff table body, without header
680 *
681 * @return mixed (string/false)
682 */
683 public function getDiffBody() {
684 global $wgMemc;
685 $this->mCacheHit = true;
686 // Check if the diff should be hidden from this user
687 if ( !$this->loadRevisionData() ) {
688
689 return false;
690 } elseif ( $this->mOldRev &&
691 !$this->mOldRev->userCan( Revision::DELETED_TEXT, $this->getUser() )
692 ) {
693
694 return false;
695 } elseif ( $this->mNewRev &&
696 !$this->mNewRev->userCan( Revision::DELETED_TEXT, $this->getUser() )
697 ) {
698
699 return false;
700 }
701 // Short-circuit
702 if ( $this->mOldRev === false || ( $this->mOldRev && $this->mNewRev
703 && $this->mOldRev->getID() == $this->mNewRev->getID() )
704 ) {
705
706 return '';
707 }
708 // Cacheable?
709 $key = false;
710 if ( $this->mOldid && $this->mNewid ) {
711 $key = $this->getDiffBodyCacheKey();
712
713 // Try cache
714 if ( !$this->mRefreshCache ) {
715 $difftext = $wgMemc->get( $key );
716 if ( $difftext ) {
717 wfIncrStats( 'diff_cache_hit' );
718 $difftext = $this->localiseLineNumbers( $difftext );
719 $difftext .= "\n<!-- diff cache key $key -->\n";
720
721 return $difftext;
722 }
723 } // don't try to load but save the result
724 }
725 $this->mCacheHit = false;
726
727 // Loadtext is permission safe, this just clears out the diff
728 if ( !$this->loadText() ) {
729
730 return false;
731 }
732
733 $difftext = $this->generateContentDiffBody( $this->mOldContent, $this->mNewContent );
734
735 // Save to cache for 7 days
736 if ( !Hooks::run( 'AbortDiffCache', array( &$this ) ) ) {
737 wfIncrStats( 'diff_uncacheable' );
738 } elseif ( $key !== false && $difftext !== false ) {
739 wfIncrStats( 'diff_cache_miss' );
740 $wgMemc->set( $key, $difftext, 7 * 86400 );
741 } else {
742 wfIncrStats( 'diff_uncacheable' );
743 }
744 // Replace line numbers with the text in the user's language
745 if ( $difftext !== false ) {
746 $difftext = $this->localiseLineNumbers( $difftext );
747 }
748
749 return $difftext;
750 }
751
752 /**
753 * Returns the cache key for diff body text or content.
754 *
755 * @since 1.23
756 *
757 * @throws MWException
758 * @return string
759 */
760 protected function getDiffBodyCacheKey() {
761 if ( !$this->mOldid || !$this->mNewid ) {
762 throw new MWException( 'mOldid and mNewid must be set to get diff cache key.' );
763 }
764
765 return wfMemcKey( 'diff', 'version', MW_DIFF_VERSION,
766 'oldid', $this->mOldid, 'newid', $this->mNewid );
767 }
768
769 /**
770 * Generate a diff, no caching.
771 *
772 * This implementation uses generateTextDiffBody() to generate a diff based on the default
773 * serialization of the given Content objects. This will fail if $old or $new are not
774 * instances of TextContent.
775 *
776 * Subclasses may override this to provide a different rendering for the diff,
777 * perhaps taking advantage of the content's native form. This is required for all content
778 * models that are not text based.
779 *
780 * @since 1.21
781 *
782 * @param Content $old Old content
783 * @param Content $new New content
784 *
785 * @throws MWException If old or new content is not an instance of TextContent.
786 * @return bool|string
787 */
788 public function generateContentDiffBody( Content $old, Content $new ) {
789 if ( !( $old instanceof TextContent ) ) {
790 throw new MWException( "Diff not implemented for " . get_class( $old ) . "; " .
791 "override generateContentDiffBody to fix this." );
792 }
793
794 if ( !( $new instanceof TextContent ) ) {
795 throw new MWException( "Diff not implemented for " . get_class( $new ) . "; "
796 . "override generateContentDiffBody to fix this." );
797 }
798
799 $otext = $old->serialize();
800 $ntext = $new->serialize();
801
802 return $this->generateTextDiffBody( $otext, $ntext );
803 }
804
805 /**
806 * Generate a diff, no caching
807 *
808 * @param string $otext Old text, must be already segmented
809 * @param string $ntext New text, must be already segmented
810 *
811 * @return bool|string
812 * @deprecated since 1.21, use generateContentDiffBody() instead!
813 */
814 public function generateDiffBody( $otext, $ntext ) {
815 ContentHandler::deprecated( __METHOD__, "1.21" );
816
817 return $this->generateTextDiffBody( $otext, $ntext );
818 }
819
820 /**
821 * Generate a diff, no caching
822 *
823 * @todo move this to TextDifferenceEngine, make DifferenceEngine abstract. At some point.
824 *
825 * @param string $otext Old text, must be already segmented
826 * @param string $ntext New text, must be already segmented
827 *
828 * @return bool|string
829 */
830 public function generateTextDiffBody( $otext, $ntext ) {
831 global $wgExternalDiffEngine, $wgContLang;
832
833 $otext = str_replace( "\r\n", "\n", $otext );
834 $ntext = str_replace( "\r\n", "\n", $ntext );
835
836 if ( $wgExternalDiffEngine == 'wikidiff' && function_exists( 'wikidiff_do_diff' ) ) {
837 # For historical reasons, external diff engine expects
838 # input text to be HTML-escaped already
839 $otext = htmlspecialchars( $wgContLang->segmentForDiff( $otext ) );
840 $ntext = htmlspecialchars( $wgContLang->segmentForDiff( $ntext ) );
841
842 return $wgContLang->unsegmentForDiff( wikidiff_do_diff( $otext, $ntext, 2 ) ) .
843 $this->debug( 'wikidiff1' );
844 }
845
846 if ( $wgExternalDiffEngine == 'wikidiff2' && function_exists( 'wikidiff2_do_diff' ) ) {
847 # Better external diff engine, the 2 may some day be dropped
848 # This one does the escaping and segmenting itself
849 $text = wikidiff2_do_diff( $otext, $ntext, 2 );
850 $text .= $this->debug( 'wikidiff2' );
851
852 return $text;
853 }
854 if ( $wgExternalDiffEngine != 'wikidiff3' && $wgExternalDiffEngine !== false ) {
855 # Diff via the shell
856 $tmpDir = wfTempDir();
857 $tempName1 = tempnam( $tmpDir, 'diff_' );
858 $tempName2 = tempnam( $tmpDir, 'diff_' );
859
860 $tempFile1 = fopen( $tempName1, "w" );
861 if ( !$tempFile1 ) {
862
863 return false;
864 }
865 $tempFile2 = fopen( $tempName2, "w" );
866 if ( !$tempFile2 ) {
867
868 return false;
869 }
870 fwrite( $tempFile1, $otext );
871 fwrite( $tempFile2, $ntext );
872 fclose( $tempFile1 );
873 fclose( $tempFile2 );
874 $cmd = wfEscapeShellArg( $wgExternalDiffEngine, $tempName1, $tempName2 );
875 $difftext = wfShellExec( $cmd );
876 $difftext .= $this->debug( "external $wgExternalDiffEngine" );
877 unlink( $tempName1 );
878 unlink( $tempName2 );
879
880 return $difftext;
881 }
882
883 # Native PHP diff
884 $ota = explode( "\n", $wgContLang->segmentForDiff( $otext ) );
885 $nta = explode( "\n", $wgContLang->segmentForDiff( $ntext ) );
886 $diffs = new Diff( $ota, $nta );
887 $formatter = new TableDiffFormatter();
888 $difftext = $wgContLang->unsegmentForDiff( $formatter->format( $diffs ) );
889
890 return $difftext;
891 }
892
893 /**
894 * Generate a debug comment indicating diff generating time,
895 * server node, and generator backend.
896 *
897 * @param string $generator : What diff engine was used
898 *
899 * @return string
900 */
901 protected function debug( $generator = "internal" ) {
902 global $wgShowHostnames;
903 if ( !$this->enableDebugComment ) {
904 return '';
905 }
906 $data = array( $generator );
907 if ( $wgShowHostnames ) {
908 $data[] = wfHostname();
909 }
910 $data[] = wfTimestamp( TS_DB );
911
912 return "<!-- diff generator: " .
913 implode( " ", array_map( "htmlspecialchars", $data ) ) .
914 " -->\n";
915 }
916
917 /**
918 * Replace line numbers with the text in the user's language
919 *
920 * @param string $text
921 *
922 * @return mixed
923 */
924 public function localiseLineNumbers( $text ) {
925 return preg_replace_callback(
926 '/<!--LINE (\d+)-->/',
927 array( &$this, 'localiseLineNumbersCb' ),
928 $text
929 );
930 }
931
932 public function localiseLineNumbersCb( $matches ) {
933 if ( $matches[1] === '1' && $this->mReducedLineNumbers ) {
934 return '';
935 }
936
937 return $this->msg( 'lineno' )->numParams( $matches[1] )->escaped();
938 }
939
940 /**
941 * If there are revisions between the ones being compared, return a note saying so.
942 *
943 * @return string
944 */
945 public function getMultiNotice() {
946 if ( !is_object( $this->mOldRev ) || !is_object( $this->mNewRev ) ) {
947 return '';
948 } elseif ( !$this->mOldPage->equals( $this->mNewPage ) ) {
949 // Comparing two different pages? Count would be meaningless.
950 return '';
951 }
952
953 if ( $this->mOldRev->getTimestamp() > $this->mNewRev->getTimestamp() ) {
954 $oldRev = $this->mNewRev; // flip
955 $newRev = $this->mOldRev; // flip
956 } else { // normal case
957 $oldRev = $this->mOldRev;
958 $newRev = $this->mNewRev;
959 }
960
961 // Sanity: don't show the notice if too many rows must be scanned
962 // @todo show some special message for that case
963 $nEdits = $this->mNewPage->countRevisionsBetween( $oldRev, $newRev, 1000 );
964 if ( $nEdits > 0 && $nEdits <= 1000 ) {
965 $limit = 100; // use diff-multi-manyusers if too many users
966 $users = $this->mNewPage->getAuthorsBetween( $oldRev, $newRev, $limit );
967 $numUsers = count( $users );
968
969 if ( $numUsers == 1 && $users[0] == $newRev->getUserText( Revision::RAW ) ) {
970 $numUsers = 0; // special case to say "by the same user" instead of "by one other user"
971 }
972
973 return self::intermediateEditsMsg( $nEdits, $numUsers, $limit );
974 }
975
976 return ''; // nothing
977 }
978
979 /**
980 * Get a notice about how many intermediate edits and users there are
981 *
982 * @param int $numEdits
983 * @param int $numUsers
984 * @param int $limit
985 *
986 * @return string
987 */
988 public static function intermediateEditsMsg( $numEdits, $numUsers, $limit ) {
989 if ( $numUsers === 0 ) {
990 $msg = 'diff-multi-sameuser';
991 } elseif ( $numUsers > $limit ) {
992 $msg = 'diff-multi-manyusers';
993 $numUsers = $limit;
994 } else {
995 $msg = 'diff-multi-otherusers';
996 }
997
998 return wfMessage( $msg )->numParams( $numEdits, $numUsers )->parse();
999 }
1000
1001 /**
1002 * Get a header for a specified revision.
1003 *
1004 * @param Revision $rev
1005 * @param string $complete 'complete' to get the header wrapped depending
1006 * the visibility of the revision and a link to edit the page.
1007 *
1008 * @return string HTML fragment
1009 */
1010 protected function getRevisionHeader( Revision $rev, $complete = '' ) {
1011 $lang = $this->getLanguage();
1012 $user = $this->getUser();
1013 $revtimestamp = $rev->getTimestamp();
1014 $timestamp = $lang->userTimeAndDate( $revtimestamp, $user );
1015 $dateofrev = $lang->userDate( $revtimestamp, $user );
1016 $timeofrev = $lang->userTime( $revtimestamp, $user );
1017
1018 $header = $this->msg(
1019 $rev->isCurrent() ? 'currentrev-asof' : 'revisionasof',
1020 $timestamp,
1021 $dateofrev,
1022 $timeofrev
1023 )->escaped();
1024
1025 if ( $complete !== 'complete' ) {
1026 return $header;
1027 }
1028
1029 $title = $rev->getTitle();
1030
1031 $header = Linker::linkKnown( $title, $header, array(),
1032 array( 'oldid' => $rev->getID() ) );
1033
1034 if ( $rev->userCan( Revision::DELETED_TEXT, $user ) ) {
1035 $editQuery = array( 'action' => 'edit' );
1036 if ( !$rev->isCurrent() ) {
1037 $editQuery['oldid'] = $rev->getID();
1038 }
1039
1040 $key = $title->quickUserCan( 'edit', $user ) ? 'editold' : 'viewsourceold';
1041 $msg = $this->msg( $key )->escaped();
1042 $editLink = $this->msg( 'parentheses' )->rawParams(
1043 Linker::linkKnown( $title, $msg, array( ), $editQuery ) )->escaped();
1044 $header .= ' ' . Html::rawElement(
1045 'span',
1046 array( 'class' => 'mw-diff-edit' ),
1047 $editLink
1048 );
1049 if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
1050 $header = Html::rawElement(
1051 'span',
1052 array( 'class' => 'history-deleted' ),
1053 $header
1054 );
1055 }
1056 } else {
1057 $header = Html::rawElement( 'span', array( 'class' => 'history-deleted' ), $header );
1058 }
1059
1060 return $header;
1061 }
1062
1063 /**
1064 * Add the header to a diff body
1065 *
1066 * @param string $diff Diff body
1067 * @param string $otitle Old revision header
1068 * @param string $ntitle New revision header
1069 * @param string $multi Notice telling user that there are intermediate
1070 * revisions between the ones being compared
1071 * @param string $notice Other notices, e.g. that user is viewing deleted content
1072 *
1073 * @return string
1074 */
1075 public function addHeader( $diff, $otitle, $ntitle, $multi = '', $notice = '' ) {
1076 // shared.css sets diff in interface language/dir, but the actual content
1077 // is often in a different language, mostly the page content language/dir
1078 $tableClass = 'diff diff-contentalign-' . htmlspecialchars( $this->getDiffLang()->alignStart() );
1079 $header = "<table class='$tableClass'>";
1080
1081 if ( !$diff && !$otitle ) {
1082 $header .= "
1083 <tr style='vertical-align: top;'>
1084 <td class='diff-ntitle'>{$ntitle}</td>
1085 </tr>";
1086 $multiColspan = 1;
1087 } else {
1088 if ( $diff ) { // Safari/Chrome show broken output if cols not used
1089 $header .= "
1090 <col class='diff-marker' />
1091 <col class='diff-content' />
1092 <col class='diff-marker' />
1093 <col class='diff-content' />";
1094 $colspan = 2;
1095 $multiColspan = 4;
1096 } else {
1097 $colspan = 1;
1098 $multiColspan = 2;
1099 }
1100 if ( $otitle || $ntitle ) {
1101 $header .= "
1102 <tr style='vertical-align: top;'>
1103 <td colspan='$colspan' class='diff-otitle'>{$otitle}</td>
1104 <td colspan='$colspan' class='diff-ntitle'>{$ntitle}</td>
1105 </tr>";
1106 }
1107 }
1108
1109 if ( $multi != '' ) {
1110 $header .= "<tr><td colspan='{$multiColspan}' style='text-align: center;' " .
1111 "class='diff-multi'>{$multi}</td></tr>";
1112 }
1113 if ( $notice != '' ) {
1114 $header .= "<tr><td colspan='{$multiColspan}' style='text-align: center;'>{$notice}</td></tr>";
1115 }
1116
1117 return $header . $diff . "</table>";
1118 }
1119
1120 /**
1121 * Use specified text instead of loading from the database
1122 * @deprecated since 1.21, use setContent() instead.
1123 */
1124 public function setText( $oldText, $newText ) {
1125 ContentHandler::deprecated( __METHOD__, "1.21" );
1126
1127 $oldContent = ContentHandler::makeContent( $oldText, $this->getTitle() );
1128 $newContent = ContentHandler::makeContent( $newText, $this->getTitle() );
1129
1130 $this->setContent( $oldContent, $newContent );
1131 }
1132
1133 /**
1134 * Use specified text instead of loading from the database
1135 * @param Content $oldContent
1136 * @param Content $newContent
1137 * @since 1.21
1138 */
1139 public function setContent( Content $oldContent, Content $newContent ) {
1140 $this->mOldContent = $oldContent;
1141 $this->mNewContent = $newContent;
1142
1143 $this->mTextLoaded = 2;
1144 $this->mRevisionsLoaded = true;
1145 }
1146
1147 /**
1148 * Set the language in which the diff text is written
1149 * (Defaults to page content language).
1150 * @param Language|string $lang
1151 * @since 1.19
1152 */
1153 public function setTextLanguage( $lang ) {
1154 $this->mDiffLang = wfGetLangObj( $lang );
1155 }
1156
1157 /**
1158 * Maps a revision pair definition as accepted by DifferenceEngine constructor
1159 * to a pair of actual integers representing revision ids.
1160 *
1161 * @param int $old Revision id, e.g. from URL parameter 'oldid'
1162 * @param int|string $new Revision id or strings 'next' or 'prev', e.g. from URL parameter 'diff'
1163 *
1164 * @return int[] List of two revision ids, older first, later second.
1165 * Zero signifies invalid argument passed.
1166 * false signifies that there is no previous/next revision ($old is the oldest/newest one).
1167 */
1168 public function mapDiffPrevNext( $old, $new ) {
1169 if ( $new === 'prev' ) {
1170 // Show diff between revision $old and the previous one. Get previous one from DB.
1171 $newid = intval( $old );
1172 $oldid = $this->getTitle()->getPreviousRevisionID( $newid );
1173 } elseif ( $new === 'next' ) {
1174 // Show diff between revision $old and the next one. Get next one from DB.
1175 $oldid = intval( $old );
1176 $newid = $this->getTitle()->getNextRevisionID( $oldid );
1177 } else {
1178 $oldid = intval( $old );
1179 $newid = intval( $new );
1180 }
1181
1182 return array( $oldid, $newid );
1183 }
1184
1185 /**
1186 * Load revision IDs
1187 */
1188 private function loadRevisionIds() {
1189 if ( $this->mRevisionsIdsLoaded ) {
1190 return;
1191 }
1192
1193 $this->mRevisionsIdsLoaded = true;
1194
1195 $old = $this->mOldid;
1196 $new = $this->mNewid;
1197
1198 list( $this->mOldid, $this->mNewid ) = self::mapDiffPrevNext( $old, $new );
1199 if ( $new === 'next' && $this->mNewid === false ) {
1200 # if no result, NewId points to the newest old revision. The only newer
1201 # revision is cur, which is "0".
1202 $this->mNewid = 0;
1203 }
1204
1205 Hooks::run(
1206 'NewDifferenceEngine',
1207 array( $this->getTitle(), &$this->mOldid, &$this->mNewid, $old, $new )
1208 );
1209 }
1210
1211 /**
1212 * Load revision metadata for the specified articles. If newid is 0, then compare
1213 * the old article in oldid to the current article; if oldid is 0, then
1214 * compare the current article to the immediately previous one (ignoring the
1215 * value of newid).
1216 *
1217 * If oldid is false, leave the corresponding revision object set
1218 * to false. This is impossible via ordinary user input, and is provided for
1219 * API convenience.
1220 *
1221 * @return bool
1222 */
1223 public function loadRevisionData() {
1224 if ( $this->mRevisionsLoaded ) {
1225 return true;
1226 }
1227
1228 // Whether it succeeds or fails, we don't want to try again
1229 $this->mRevisionsLoaded = true;
1230
1231 $this->loadRevisionIds();
1232
1233 // Load the new revision object
1234 if ( $this->mNewid ) {
1235 $this->mNewRev = Revision::newFromId( $this->mNewid );
1236 } else {
1237 $this->mNewRev = Revision::newFromTitle(
1238 $this->getTitle(),
1239 false,
1240 Revision::READ_NORMAL
1241 );
1242 }
1243
1244 if ( !$this->mNewRev instanceof Revision ) {
1245 return false;
1246 }
1247
1248 // Update the new revision ID in case it was 0 (makes life easier doing UI stuff)
1249 $this->mNewid = $this->mNewRev->getId();
1250 $this->mNewPage = $this->mNewRev->getTitle();
1251
1252 // Load the old revision object
1253 $this->mOldRev = false;
1254 if ( $this->mOldid ) {
1255 $this->mOldRev = Revision::newFromId( $this->mOldid );
1256 } elseif ( $this->mOldid === 0 ) {
1257 $rev = $this->mNewRev->getPrevious();
1258 if ( $rev ) {
1259 $this->mOldid = $rev->getId();
1260 $this->mOldRev = $rev;
1261 } else {
1262 // No previous revision; mark to show as first-version only.
1263 $this->mOldid = false;
1264 $this->mOldRev = false;
1265 }
1266 } /* elseif ( $this->mOldid === false ) leave mOldRev false; */
1267
1268 if ( is_null( $this->mOldRev ) ) {
1269 return false;
1270 }
1271
1272 if ( $this->mOldRev ) {
1273 $this->mOldPage = $this->mOldRev->getTitle();
1274 }
1275
1276 // Load tags information for both revisions
1277 $dbr = wfGetDB( DB_SLAVE );
1278 if ( $this->mOldid !== false ) {
1279 $this->mOldTags = $dbr->selectField(
1280 'tag_summary',
1281 'ts_tags',
1282 array( 'ts_rev_id' => $this->mOldid ),
1283 __METHOD__
1284 );
1285 } else {
1286 $this->mOldTags = false;
1287 }
1288 $this->mNewTags = $dbr->selectField(
1289 'tag_summary',
1290 'ts_tags',
1291 array( 'ts_rev_id' => $this->mNewid ),
1292 __METHOD__
1293 );
1294
1295 return true;
1296 }
1297
1298 /**
1299 * Load the text of the revisions, as well as revision data.
1300 *
1301 * @return bool
1302 */
1303 public function loadText() {
1304 if ( $this->mTextLoaded == 2 ) {
1305 return true;
1306 }
1307
1308 // Whether it succeeds or fails, we don't want to try again
1309 $this->mTextLoaded = 2;
1310
1311 if ( !$this->loadRevisionData() ) {
1312 return false;
1313 }
1314
1315 if ( $this->mOldRev ) {
1316 $this->mOldContent = $this->mOldRev->getContent( Revision::FOR_THIS_USER, $this->getUser() );
1317 if ( $this->mOldContent === null ) {
1318 return false;
1319 }
1320 }
1321
1322 if ( $this->mNewRev ) {
1323 $this->mNewContent = $this->mNewRev->getContent( Revision::FOR_THIS_USER, $this->getUser() );
1324 if ( $this->mNewContent === null ) {
1325 return false;
1326 }
1327 }
1328
1329 return true;
1330 }
1331
1332 /**
1333 * Load the text of the new revision, not the old one
1334 *
1335 * @return bool
1336 */
1337 public function loadNewText() {
1338 if ( $this->mTextLoaded >= 1 ) {
1339 return true;
1340 }
1341
1342 $this->mTextLoaded = 1;
1343
1344 if ( !$this->loadRevisionData() ) {
1345 return false;
1346 }
1347
1348 $this->mNewContent = $this->mNewRev->getContent( Revision::FOR_THIS_USER, $this->getUser() );
1349
1350 return true;
1351 }
1352
1353 }