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