MediaWiki  1.28.0
DifferenceEngine.php
Go to the documentation of this file.
1 <?php
25 define( 'MW_DIFF_VERSION', '1.11a' );
26 
39 
41  public $mOldid;
42 
44  public $mNewid;
45 
46  private $mOldTags;
47  private $mNewTags;
48 
50  public $mOldContent;
51 
53  public $mNewContent;
54 
56  protected $mDiffLang;
57 
59  public $mOldPage;
60 
62  public $mNewPage;
63 
65  public $mOldRev;
66 
68  public $mNewRev;
69 
71  private $mRevisionsIdsLoaded = false;
72 
74  public $mRevisionsLoaded = false;
75 
77  public $mTextLoaded = 0;
78 
80  public $mCacheHit = false;
81 
87  public $enableDebugComment = false;
88 
92  protected $mReducedLineNumbers = false;
93 
95  protected $mMarkPatrolledLink = null;
96 
98  protected $unhide = false;
99 
101  protected $mRefreshCache = false;
102 
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 
132  public function setReducedLineNumbers( $value = true ) {
133  $this->mReducedLineNumbers = $value;
134  }
135 
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 
151  public function wasCacheHit() {
152  return $this->mCacheHit;
153  }
154 
158  public function getOldid() {
159  $this->loadRevisionIds();
160 
161  return $this->mOldid;
162  }
163 
167  public function getNewid() {
168  $this->loadRevisionIds();
169 
170  return $this->mNewid;
171  }
172 
181  public function deletedLink( $id ) {
182  if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
183  $dbr = wfGetDB( DB_REPLICA );
184  $row = $dbr->selectRow( 'archive', '*',
185  [ 'ar_rev_id' => $id ],
186  __METHOD__ );
187  if ( $row ) {
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 
208  public function deletedIdMarker( $id ) {
209  $link = $this->deletedLink( $id );
210  if ( $link ) {
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  # Allow frames except in certain special cases
242  $out = $this->getOutput();
243  $out->allowClickjacking();
244  $out->setRobotPolicy( 'noindex,nofollow' );
245 
246  // Allow extensions to add any extra output here
247  Hooks::run( 'DifferenceEngineShowDiffPage', [ $out ] );
248 
249  if ( !$this->loadRevisionData() ) {
250  $this->showMissingRevision();
251 
252  return;
253  }
254 
255  $user = $this->getUser();
256  $permErrors = $this->mNewPage->getUserPermissionsErrors( 'read', $user );
257  if ( $this->mOldPage ) { # mOldPage might not be set, see below.
258  $permErrors = wfMergeErrorArrays( $permErrors,
259  $this->mOldPage->getUserPermissionsErrors( 'read', $user ) );
260  }
261  if ( count( $permErrors ) ) {
262  throw new PermissionsError( 'read', $permErrors );
263  }
264 
265  $rollback = '';
266 
267  $query = [];
268  # Carry over 'diffonly' param via navigation links
269  if ( $diffOnly != $user->getBoolOption( 'diffonly' ) ) {
270  $query['diffonly'] = $diffOnly;
271  }
272  # Cascade unhide param in links for easy deletion browsing
273  if ( $this->unhide ) {
274  $query['unhide'] = 1;
275  }
276 
277  # Check if one of the revisions is deleted/suppressed
278  $deleted = $suppressed = false;
279  $allowed = $this->mNewRev->userCan( Revision::DELETED_TEXT, $user );
280 
281  $revisionTools = [];
282 
283  # mOldRev is false if the difference engine is called with a "vague" query for
284  # a diff between a version V and its previous version V' AND the version V
285  # is the first version of that article. In that case, V' does not exist.
286  if ( $this->mOldRev === false ) {
287  $out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage->getPrefixedText() ) );
288  $samePage = true;
289  $oldHeader = '';
290  // Allow extensions to change the $oldHeader variable
291  Hooks::run( 'DifferenceEngineOldHeaderNoOldRev', [ &$oldHeader ] );
292  } else {
293  Hooks::run( 'DiffViewHeader', [ $this, $this->mOldRev, $this->mNewRev ] );
294 
295  if ( $this->mNewPage->equals( $this->mOldPage ) ) {
296  $out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage->getPrefixedText() ) );
297  $samePage = true;
298  } else {
299  $out->setPageTitle( $this->msg( 'difference-title-multipage',
300  $this->mOldPage->getPrefixedText(), $this->mNewPage->getPrefixedText() ) );
301  $out->addSubtitle( $this->msg( 'difference-multipage' ) );
302  $samePage = false;
303  }
304 
305  if ( $samePage && $this->mNewPage->quickUserCan( 'edit', $user ) ) {
306  if ( $this->mNewRev->isCurrent() && $this->mNewPage->userCan( 'rollback', $user ) ) {
307  $rollbackLink = Linker::generateRollback( $this->mNewRev, $this->getContext() );
308  if ( $rollbackLink ) {
309  $out->preventClickjacking();
310  $rollback = '&#160;&#160;&#160;' . $rollbackLink;
311  }
312  }
313 
314  if ( !$this->mOldRev->isDeleted( Revision::DELETED_TEXT ) &&
315  !$this->mNewRev->isDeleted( Revision::DELETED_TEXT )
316  ) {
317  $undoLink = Html::element( 'a', [
318  'href' => $this->mNewPage->getLocalURL( [
319  'action' => 'edit',
320  'undoafter' => $this->mOldid,
321  'undo' => $this->mNewid
322  ] ),
323  'title' => Linker::titleAttrib( 'undo' ),
324  ],
325  $this->msg( 'editundo' )->text()
326  );
327  $revisionTools['mw-diff-undo'] = $undoLink;
328  }
329  }
330 
331  # Make "previous revision link"
332  if ( $samePage && $this->mOldRev->getPrevious() ) {
333  $prevlink = Linker::linkKnown(
334  $this->mOldPage,
335  $this->msg( 'previousdiff' )->escaped(),
336  [ 'id' => 'differences-prevlink' ],
337  [ 'diff' => 'prev', 'oldid' => $this->mOldid ] + $query
338  );
339  } else {
340  $prevlink = '&#160;';
341  }
342 
343  if ( $this->mOldRev->isMinor() ) {
344  $oldminor = ChangesList::flag( 'minor' );
345  } else {
346  $oldminor = '';
347  }
348 
349  $ldel = $this->revisionDeleteLink( $this->mOldRev );
350  $oldRevisionHeader = $this->getRevisionHeader( $this->mOldRev, 'complete' );
351  $oldChangeTags = ChangeTags::formatSummaryRow( $this->mOldTags, 'diff', $this->getContext() );
352 
353  $oldHeader = '<div id="mw-diff-otitle1"><strong>' . $oldRevisionHeader . '</strong></div>' .
354  '<div id="mw-diff-otitle2">' .
355  Linker::revUserTools( $this->mOldRev, !$this->unhide ) . '</div>' .
356  '<div id="mw-diff-otitle3">' . $oldminor .
357  Linker::revComment( $this->mOldRev, !$diffOnly, !$this->unhide ) . $ldel . '</div>' .
358  '<div id="mw-diff-otitle5">' . $oldChangeTags[0] . '</div>' .
359  '<div id="mw-diff-otitle4">' . $prevlink . '</div>';
360 
361  // Allow extensions to change the $oldHeader variable
362  Hooks::run( 'DifferenceEngineOldHeader', [ $this, &$oldHeader, $prevlink, $oldminor,
363  $diffOnly, $ldel, $this->unhide ] );
364 
365  if ( $this->mOldRev->isDeleted( Revision::DELETED_TEXT ) ) {
366  $deleted = true; // old revisions text is hidden
367  if ( $this->mOldRev->isDeleted( Revision::DELETED_RESTRICTED ) ) {
368  $suppressed = true; // also suppressed
369  }
370  }
371 
372  # Check if this user can see the revisions
373  if ( !$this->mOldRev->userCan( Revision::DELETED_TEXT, $user ) ) {
374  $allowed = false;
375  }
376  }
377 
378  # Make "next revision link"
379  # Skip next link on the top revision
380  if ( $samePage && !$this->mNewRev->isCurrent() ) {
382  $this->mNewPage,
383  $this->msg( 'nextdiff' )->escaped(),
384  [ 'id' => 'differences-nextlink' ],
385  [ 'diff' => 'next', 'oldid' => $this->mNewid ] + $query
386  );
387  } else {
388  $nextlink = '&#160;';
389  }
390 
391  if ( $this->mNewRev->isMinor() ) {
392  $newminor = ChangesList::flag( 'minor' );
393  } else {
394  $newminor = '';
395  }
396 
397  # Handle RevisionDelete links...
398  $rdel = $this->revisionDeleteLink( $this->mNewRev );
399 
400  # Allow extensions to define their own revision tools
401  Hooks::run( 'DiffRevisionTools',
402  [ $this->mNewRev, &$revisionTools, $this->mOldRev, $user ] );
404  // Put each one in parentheses (poor man's button)
405  foreach ( $revisionTools as $key => $tool ) {
406  $toolClass = is_string( $key ) ? $key : 'mw-diff-tool';
407  $element = Html::rawElement(
408  'span',
409  [ 'class' => $toolClass ],
410  $this->msg( 'parentheses' )->rawParams( $tool )->escaped()
411  );
412  $formattedRevisionTools[] = $element;
413  }
414  $newRevisionHeader = $this->getRevisionHeader( $this->mNewRev, 'complete' ) .
415  ' ' . implode( ' ', $formattedRevisionTools );
416  $newChangeTags = ChangeTags::formatSummaryRow( $this->mNewTags, 'diff', $this->getContext() );
417 
418  $newHeader = '<div id="mw-diff-ntitle1"><strong>' . $newRevisionHeader . '</strong></div>' .
419  '<div id="mw-diff-ntitle2">' . Linker::revUserTools( $this->mNewRev, !$this->unhide ) .
420  " $rollback</div>" .
421  '<div id="mw-diff-ntitle3">' . $newminor .
422  Linker::revComment( $this->mNewRev, !$diffOnly, !$this->unhide ) . $rdel . '</div>' .
423  '<div id="mw-diff-ntitle5">' . $newChangeTags[0] . '</div>' .
424  '<div id="mw-diff-ntitle4">' . $nextlink . $this->markPatrolledLink() . '</div>';
425 
426  // Allow extensions to change the $newHeader variable
427  Hooks::run( 'DifferenceEngineNewHeader', [ $this, &$newHeader, $formattedRevisionTools,
428  $nextlink, $rollback, $newminor, $diffOnly, $rdel, $this->unhide ] );
429 
430  if ( $this->mNewRev->isDeleted( Revision::DELETED_TEXT ) ) {
431  $deleted = true; // new revisions text is hidden
432  if ( $this->mNewRev->isDeleted( Revision::DELETED_RESTRICTED ) ) {
433  $suppressed = true; // also suppressed
434  }
435  }
436 
437  # If the diff cannot be shown due to a deleted revision, then output
438  # the diff header and links to unhide (if available)...
439  if ( $deleted && ( !$this->unhide || !$allowed ) ) {
440  $this->showDiffStyle();
441  $multi = $this->getMultiNotice();
442  $out->addHTML( $this->addHeader( '', $oldHeader, $newHeader, $multi ) );
443  if ( !$allowed ) {
444  $msg = $suppressed ? 'rev-suppressed-no-diff' : 'rev-deleted-no-diff';
445  # Give explanation for why revision is not visible
446  $out->wrapWikiMsg( "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
447  [ $msg ] );
448  } else {
449  # Give explanation and add a link to view the diff...
450  $query = $this->getRequest()->appendQueryValue( 'unhide', '1' );
451  $link = $this->getTitle()->getFullURL( $query );
452  $msg = $suppressed ? 'rev-suppressed-unhide-diff' : 'rev-deleted-unhide-diff';
453  $out->wrapWikiMsg(
454  "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
455  [ $msg, $link ]
456  );
457  }
458  # Otherwise, output a regular diff...
459  } else {
460  # Add deletion notice if the user is viewing deleted content
461  $notice = '';
462  if ( $deleted ) {
463  $msg = $suppressed ? 'rev-suppressed-diff-view' : 'rev-deleted-diff-view';
464  $notice = "<div id='mw-$msg' class='mw-warning plainlinks'>\n" .
465  $this->msg( $msg )->parse() .
466  "</div>\n";
467  }
468  $this->showDiff( $oldHeader, $newHeader, $notice );
469  if ( !$diffOnly ) {
470  $this->renderNewRevision();
471  }
472  }
473  }
474 
484  protected function markPatrolledLink() {
485  if ( $this->mMarkPatrolledLink === null ) {
486  $linkInfo = $this->getMarkPatrolledLinkInfo();
487  // If false, there is no patrol link needed/allowed
488  if ( !$linkInfo ) {
489  $this->mMarkPatrolledLink = '';
490  } else {
491  $this->mMarkPatrolledLink = ' <span class="patrollink" data-mw="interface">[' .
493  $this->mNewPage,
494  $this->msg( 'markaspatrolleddiff' )->escaped(),
495  [],
496  [
497  'action' => 'markpatrolled',
498  'rcid' => $linkInfo['rcid'],
499  'token' => $linkInfo['token'],
500  ]
501  ) . ']</span>';
502  // Allow extensions to change the markpatrolled link
503  Hooks::run( 'DifferenceEngineMarkPatrolledLink', [ $this,
504  &$this->mMarkPatrolledLink, $linkInfo['rcid'], $linkInfo['token'] ] );
505  }
506  }
508  }
509 
517  protected function getMarkPatrolledLinkInfo() {
518  global $wgUseRCPatrol, $wgEnableAPI, $wgEnableWriteAPI;
519 
520  $user = $this->getUser();
521 
522  // Prepare a change patrol link, if applicable
523  if (
524  // Is patrolling enabled and the user allowed to?
525  $wgUseRCPatrol && $this->mNewPage->quickUserCan( 'patrol', $user ) &&
526  // Only do this if the revision isn't more than 6 hours older
527  // than the Max RC age (6h because the RC might not be cleaned out regularly)
528  RecentChange::isInRCLifespan( $this->mNewRev->getTimestamp(), 21600 )
529  ) {
530  // Look for an unpatrolled change corresponding to this diff
531  $db = wfGetDB( DB_REPLICA );
532  $change = RecentChange::newFromConds(
533  [
534  'rc_timestamp' => $db->timestamp( $this->mNewRev->getTimestamp() ),
535  'rc_this_oldid' => $this->mNewid,
536  'rc_patrolled' => 0
537  ],
538  __METHOD__
539  );
540 
541  if ( $change && !$change->getPerformer()->equals( $user ) ) {
542  $rcid = $change->getAttribute( 'rc_id' );
543  } else {
544  // None found or the page has been created by the current user.
545  // If the user could patrol this it already would be patrolled
546  $rcid = 0;
547  }
548 
549  // Allow extensions to possibly change the rcid here
550  // For example the rcid might be set to zero due to the user
551  // being the same as the performer of the change but an extension
552  // might still want to show it under certain conditions
553  Hooks::run( 'DifferenceEngineMarkPatrolledRCID', [ &$rcid, $this, $change, $user ] );
554 
555  // Build the link
556  if ( $rcid ) {
557  $this->getOutput()->preventClickjacking();
558  if ( $wgEnableAPI && $wgEnableWriteAPI
559  && $user->isAllowed( 'writeapi' )
560  ) {
561  $this->getOutput()->addModules( 'mediawiki.page.patrol.ajax' );
562  }
563 
564  $token = $user->getEditToken( $rcid );
565  return [
566  'rcid' => $rcid,
567  'token' => $token,
568  ];
569  }
570  }
571 
572  // No mark as patrolled link applicable
573  return false;
574  }
575 
581  protected function revisionDeleteLink( $rev ) {
582  $link = Linker::getRevDeleteLink( $this->getUser(), $rev, $rev->getTitle() );
583  if ( $link !== '' ) {
584  $link = '&#160;&#160;&#160;' . $link . ' ';
585  }
586 
587  return $link;
588  }
589 
593  public function renderNewRevision() {
594  $out = $this->getOutput();
595  $revHeader = $this->getRevisionHeader( $this->mNewRev );
596  # Add "current version as of X" title
597  $out->addHTML( "<hr class='diff-hr' id='mw-oldid' />
598  <h2 class='diff-currentversion-title'>{$revHeader}</h2>\n" );
599  # Page content may be handled by a hooked call instead...
600  # @codingStandardsIgnoreStart Ignoring long lines.
601  if ( Hooks::run( 'ArticleContentOnDiff', [ $this, $out ] ) ) {
602  $this->loadNewText();
603  $out->setRevisionId( $this->mNewid );
604  $out->setRevisionTimestamp( $this->mNewRev->getTimestamp() );
605  $out->setArticleFlag( true );
606 
607  // NOTE: only needed for B/C: custom rendering of JS/CSS via hook
608  if ( $this->mNewPage->isCssJsSubpage() || $this->mNewPage->isCssOrJsPage() ) {
609  // This needs to be synchronised with Article::showCssOrJsPage(), which sucks
610  // Give hooks a chance to customise the output
611  // @todo standardize this crap into one function
612  if ( ContentHandler::runLegacyHooks( 'ShowRawCssJs', [ $this->mNewContent, $this->mNewPage, $out ], '1.24' ) ) {
613  // NOTE: deprecated hook, B/C only
614  // use the content object's own rendering
615  $cnt = $this->mNewRev->getContent();
616  $po = $cnt ? $cnt->getParserOutput( $this->mNewRev->getTitle(), $this->mNewRev->getId() ) : null;
617  if ( $po ) {
618  $out->addParserOutputContent( $po );
619  }
620  }
621  } elseif ( !Hooks::run( 'ArticleContentViewCustom', [ $this->mNewContent, $this->mNewPage, $out ] ) ) {
622  // Handled by extension
623  } elseif ( !ContentHandler::runLegacyHooks(
624  'ArticleViewCustom',
625  [ $this->mNewContent, $this->mNewPage, $out ],
626  '1.21'
627  ) ) {
628  // NOTE: deprecated hook, B/C only
629  // Handled by extension
630  } else {
631  // Normal page
632  if ( $this->getTitle()->equals( $this->mNewPage ) ) {
633  // If the Title stored in the context is the same as the one
634  // of the new revision, we can use its associated WikiPage
635  // object.
636  $wikiPage = $this->getWikiPage();
637  } else {
638  // Otherwise we need to create our own WikiPage object
639  $wikiPage = WikiPage::factory( $this->mNewPage );
640  }
641 
642  $parserOutput = $this->getParserOutput( $wikiPage, $this->mNewRev );
643 
644  # WikiPage::getParserOutput() should not return false, but just in case
645  if ( $parserOutput ) {
646  // Allow extensions to change parser output here
647  if ( Hooks::run( 'DifferenceEngineRenderRevisionAddParserOutput', [ $this, $out, $parserOutput, $wikiPage ] ) ) {
648  $out->addParserOutput( $parserOutput );
649  }
650  }
651  }
652  }
653  # @codingStandardsIgnoreEnd
654 
655  // Allow extensions to optionally not show the final patrolled link
656  if ( Hooks::run( 'DifferenceEngineRenderRevisionShowFinalPatrolLink' ) ) {
657  # Add redundant patrol link on bottom...
658  $out->addHTML( $this->markPatrolledLink() );
659  }
660  }
661 
662  protected function getParserOutput( WikiPage $page, Revision $rev ) {
663  $parserOptions = $page->makeParserOptions( $this->getContext() );
664 
665  if ( !$rev->isCurrent() || !$rev->getTitle()->quickUserCan( 'edit', $this->getUser() ) ) {
666  $parserOptions->setEditSection( false );
667  }
668 
669  $parserOutput = $page->getParserOutput( $parserOptions, $rev->getId() );
670 
671  return $parserOutput;
672  }
673 
684  public function showDiff( $otitle, $ntitle, $notice = '' ) {
685  // Allow extensions to affect the output here
686  Hooks::run( 'DifferenceEngineShowDiff', [ $this ] );
687 
688  $diff = $this->getDiff( $otitle, $ntitle, $notice );
689  if ( $diff === false ) {
690  $this->showMissingRevision();
691 
692  return false;
693  } else {
694  $this->showDiffStyle();
695  $this->getOutput()->addHTML( $diff );
696 
697  return true;
698  }
699  }
700 
704  public function showDiffStyle() {
705  $this->getOutput()->addModuleStyles( 'mediawiki.diff.styles' );
706  }
707 
717  public function getDiff( $otitle, $ntitle, $notice = '' ) {
718  $body = $this->getDiffBody();
719  if ( $body === false ) {
720  return false;
721  }
722 
723  $multi = $this->getMultiNotice();
724  // Display a message when the diff is empty
725  if ( $body === '' ) {
726  $notice .= '<div class="mw-diff-empty">' .
727  $this->msg( 'diff-empty' )->parse() .
728  "</div>\n";
729  }
730 
731  return $this->addHeader( $body, $otitle, $ntitle, $multi, $notice );
732  }
733 
739  public function getDiffBody() {
740  $this->mCacheHit = true;
741  // Check if the diff should be hidden from this user
742  if ( !$this->loadRevisionData() ) {
743  return false;
744  } elseif ( $this->mOldRev &&
745  !$this->mOldRev->userCan( Revision::DELETED_TEXT, $this->getUser() )
746  ) {
747  return false;
748  } elseif ( $this->mNewRev &&
749  !$this->mNewRev->userCan( Revision::DELETED_TEXT, $this->getUser() )
750  ) {
751  return false;
752  }
753  // Short-circuit
754  if ( $this->mOldRev === false || ( $this->mOldRev && $this->mNewRev
755  && $this->mOldRev->getId() == $this->mNewRev->getId() )
756  ) {
757  if ( Hooks::run( 'DifferenceEngineShowEmptyOldContent', [ $this ] ) ) {
758  return '';
759  }
760  }
761  // Cacheable?
762  $key = false;
764  if ( $this->mOldid && $this->mNewid ) {
765  $key = $this->getDiffBodyCacheKey();
766 
767  // Try cache
768  if ( !$this->mRefreshCache ) {
769  $difftext = $cache->get( $key );
770  if ( $difftext ) {
771  wfIncrStats( 'diff_cache.hit' );
772  $difftext = $this->localiseLineNumbers( $difftext );
773  $difftext .= "\n<!-- diff cache key $key -->\n";
774 
775  return $difftext;
776  }
777  } // don't try to load but save the result
778  }
779  $this->mCacheHit = false;
780 
781  // Loadtext is permission safe, this just clears out the diff
782  if ( !$this->loadText() ) {
783  return false;
784  }
785 
786  $difftext = $this->generateContentDiffBody( $this->mOldContent, $this->mNewContent );
787 
788  // Save to cache for 7 days
789  if ( !Hooks::run( 'AbortDiffCache', [ &$this ] ) ) {
790  wfIncrStats( 'diff_cache.uncacheable' );
791  } elseif ( $key !== false && $difftext !== false ) {
792  wfIncrStats( 'diff_cache.miss' );
793  $cache->set( $key, $difftext, 7 * 86400 );
794  } else {
795  wfIncrStats( 'diff_cache.uncacheable' );
796  }
797  // Replace line numbers with the text in the user's language
798  if ( $difftext !== false ) {
799  $difftext = $this->localiseLineNumbers( $difftext );
800  }
801 
802  return $difftext;
803  }
804 
813  protected function getDiffBodyCacheKey() {
814  if ( !$this->mOldid || !$this->mNewid ) {
815  throw new MWException( 'mOldid and mNewid must be set to get diff cache key.' );
816  }
817 
818  return wfMemcKey( 'diff', 'version', self::DIFF_VERSION,
819  'oldid', $this->mOldid, 'newid', $this->mNewid );
820  }
821 
841  public function generateContentDiffBody( Content $old, Content $new ) {
842  if ( !( $old instanceof TextContent ) ) {
843  throw new MWException( "Diff not implemented for " . get_class( $old ) . "; " .
844  "override generateContentDiffBody to fix this." );
845  }
846 
847  if ( !( $new instanceof TextContent ) ) {
848  throw new MWException( "Diff not implemented for " . get_class( $new ) . "; "
849  . "override generateContentDiffBody to fix this." );
850  }
851 
852  $otext = $old->serialize();
853  $ntext = $new->serialize();
854 
855  return $this->generateTextDiffBody( $otext, $ntext );
856  }
857 
868  public function generateTextDiffBody( $otext, $ntext ) {
869  $diff = function() use ( $otext, $ntext ) {
870  $time = microtime( true );
871 
872  $result = $this->textDiff( $otext, $ntext );
873 
874  $time = intval( ( microtime( true ) - $time ) * 1000 );
875  $this->getStats()->timing( 'diff_time', $time );
876  // Log requests slower than 99th percentile
877  if ( $time > 100 && $this->mOldPage && $this->mNewPage ) {
878  wfDebugLog( 'diff',
879  "$time ms diff: {$this->mOldid} -> {$this->mNewid} {$this->mNewPage}" );
880  }
881 
882  return $result;
883  };
884 
885  $error = function( $status ) {
886  throw new FatalError( $status->getWikiText() );
887  };
888 
889  // Use PoolCounter if the diff looks like it can be expensive
890  if ( strlen( $otext ) + strlen( $ntext ) > 20000 ) {
891  $work = new PoolCounterWorkViaCallback( 'diff',
892  md5( $otext ) . md5( $ntext ),
893  [ 'doWork' => $diff, 'error' => $error ]
894  );
895  return $work->execute();
896  }
897 
898  return $diff();
899  }
900 
908  protected function textDiff( $otext, $ntext ) {
909  global $wgExternalDiffEngine, $wgContLang;
910 
911  $otext = str_replace( "\r\n", "\n", $otext );
912  $ntext = str_replace( "\r\n", "\n", $ntext );
913 
914  if ( $wgExternalDiffEngine == 'wikidiff' || $wgExternalDiffEngine == 'wikidiff3' ) {
915  wfDeprecated( "\$wgExternalDiffEngine = '{$wgExternalDiffEngine}'", '1.27' );
916  $wgExternalDiffEngine = false;
917  } elseif ( $wgExternalDiffEngine == 'wikidiff2' ) {
918  // Same as above, but with no deprecation warnings
919  $wgExternalDiffEngine = false;
920  } elseif ( !is_string( $wgExternalDiffEngine ) && $wgExternalDiffEngine !== false ) {
921  // And prevent people from shooting themselves in the foot...
922  wfWarn( '$wgExternalDiffEngine is set to a non-string value, forcing it to false' );
923  $wgExternalDiffEngine = false;
924  }
925 
926  if ( function_exists( 'wikidiff2_do_diff' ) && $wgExternalDiffEngine === false ) {
927  # Better external diff engine, the 2 may some day be dropped
928  # This one does the escaping and segmenting itself
929  $text = wikidiff2_do_diff( $otext, $ntext, 2 );
930  $text .= $this->debug( 'wikidiff2' );
931 
932  return $text;
933  } elseif ( $wgExternalDiffEngine !== false && is_executable( $wgExternalDiffEngine ) ) {
934  # Diff via the shell
935  $tmpDir = wfTempDir();
936  $tempName1 = tempnam( $tmpDir, 'diff_' );
937  $tempName2 = tempnam( $tmpDir, 'diff_' );
938 
939  $tempFile1 = fopen( $tempName1, "w" );
940  if ( !$tempFile1 ) {
941  return false;
942  }
943  $tempFile2 = fopen( $tempName2, "w" );
944  if ( !$tempFile2 ) {
945  return false;
946  }
947  fwrite( $tempFile1, $otext );
948  fwrite( $tempFile2, $ntext );
949  fclose( $tempFile1 );
950  fclose( $tempFile2 );
951  $cmd = wfEscapeShellArg( $wgExternalDiffEngine, $tempName1, $tempName2 );
952  $difftext = wfShellExec( $cmd );
953  $difftext .= $this->debug( "external $wgExternalDiffEngine" );
954  unlink( $tempName1 );
955  unlink( $tempName2 );
956 
957  return $difftext;
958  }
959 
960  # Native PHP diff
961  $ota = explode( "\n", $wgContLang->segmentForDiff( $otext ) );
962  $nta = explode( "\n", $wgContLang->segmentForDiff( $ntext ) );
963  $diffs = new Diff( $ota, $nta );
964  $formatter = new TableDiffFormatter();
965  $difftext = $wgContLang->unsegmentForDiff( $formatter->format( $diffs ) );
966 
967  return $difftext;
968  }
969 
978  protected function debug( $generator = "internal" ) {
979  global $wgShowHostnames;
980  if ( !$this->enableDebugComment ) {
981  return '';
982  }
983  $data = [ $generator ];
984  if ( $wgShowHostnames ) {
985  $data[] = wfHostname();
986  }
987  $data[] = wfTimestamp( TS_DB );
988 
989  return "<!-- diff generator: " .
990  implode( " ", array_map( "htmlspecialchars", $data ) ) .
991  " -->\n";
992  }
993 
1001  public function localiseLineNumbers( $text ) {
1002  return preg_replace_callback(
1003  '/<!--LINE (\d+)-->/',
1004  [ &$this, 'localiseLineNumbersCb' ],
1005  $text
1006  );
1007  }
1008 
1009  public function localiseLineNumbersCb( $matches ) {
1010  if ( $matches[1] === '1' && $this->mReducedLineNumbers ) {
1011  return '';
1012  }
1013 
1014  return $this->msg( 'lineno' )->numParams( $matches[1] )->escaped();
1015  }
1016 
1022  public function getMultiNotice() {
1023  if ( !is_object( $this->mOldRev ) || !is_object( $this->mNewRev ) ) {
1024  return '';
1025  } elseif ( !$this->mOldPage->equals( $this->mNewPage ) ) {
1026  // Comparing two different pages? Count would be meaningless.
1027  return '';
1028  }
1029 
1030  if ( $this->mOldRev->getTimestamp() > $this->mNewRev->getTimestamp() ) {
1031  $oldRev = $this->mNewRev; // flip
1032  $newRev = $this->mOldRev; // flip
1033  } else { // normal case
1034  $oldRev = $this->mOldRev;
1035  $newRev = $this->mNewRev;
1036  }
1037 
1038  // Sanity: don't show the notice if too many rows must be scanned
1039  // @todo show some special message for that case
1040  $nEdits = $this->mNewPage->countRevisionsBetween( $oldRev, $newRev, 1000 );
1041  if ( $nEdits > 0 && $nEdits <= 1000 ) {
1042  $limit = 100; // use diff-multi-manyusers if too many users
1043  $users = $this->mNewPage->getAuthorsBetween( $oldRev, $newRev, $limit );
1044  $numUsers = count( $users );
1045 
1046  if ( $numUsers == 1 && $users[0] == $newRev->getUserText( Revision::RAW ) ) {
1047  $numUsers = 0; // special case to say "by the same user" instead of "by one other user"
1048  }
1049 
1050  return self::intermediateEditsMsg( $nEdits, $numUsers, $limit );
1051  }
1052 
1053  return ''; // nothing
1054  }
1055 
1065  public static function intermediateEditsMsg( $numEdits, $numUsers, $limit ) {
1066  if ( $numUsers === 0 ) {
1067  $msg = 'diff-multi-sameuser';
1068  } elseif ( $numUsers > $limit ) {
1069  $msg = 'diff-multi-manyusers';
1070  $numUsers = $limit;
1071  } else {
1072  $msg = 'diff-multi-otherusers';
1073  }
1074 
1075  return wfMessage( $msg )->numParams( $numEdits, $numUsers )->parse();
1076  }
1077 
1087  protected function getRevisionHeader( Revision $rev, $complete = '' ) {
1088  $lang = $this->getLanguage();
1089  $user = $this->getUser();
1090  $revtimestamp = $rev->getTimestamp();
1091  $timestamp = $lang->userTimeAndDate( $revtimestamp, $user );
1092  $dateofrev = $lang->userDate( $revtimestamp, $user );
1093  $timeofrev = $lang->userTime( $revtimestamp, $user );
1094 
1095  $header = $this->msg(
1096  $rev->isCurrent() ? 'currentrev-asof' : 'revisionasof',
1097  $timestamp,
1098  $dateofrev,
1099  $timeofrev
1100  )->escaped();
1101 
1102  if ( $complete !== 'complete' ) {
1103  return $header;
1104  }
1105 
1106  $title = $rev->getTitle();
1107 
1109  [ 'oldid' => $rev->getId() ] );
1110 
1111  if ( $rev->userCan( Revision::DELETED_TEXT, $user ) ) {
1112  $editQuery = [ 'action' => 'edit' ];
1113  if ( !$rev->isCurrent() ) {
1114  $editQuery['oldid'] = $rev->getId();
1115  }
1116 
1117  $key = $title->quickUserCan( 'edit', $user ) ? 'editold' : 'viewsourceold';
1118  $msg = $this->msg( $key )->escaped();
1119  $editLink = $this->msg( 'parentheses' )->rawParams(
1120  Linker::linkKnown( $title, $msg, [], $editQuery ) )->escaped();
1121  $header .= ' ' . Html::rawElement(
1122  'span',
1123  [ 'class' => 'mw-diff-edit' ],
1124  $editLink
1125  );
1126  if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
1128  'span',
1129  [ 'class' => 'history-deleted' ],
1130  $header
1131  );
1132  }
1133  } else {
1134  $header = Html::rawElement( 'span', [ 'class' => 'history-deleted' ], $header );
1135  }
1136 
1137  return $header;
1138  }
1139 
1152  public function addHeader( $diff, $otitle, $ntitle, $multi = '', $notice = '' ) {
1153  // shared.css sets diff in interface language/dir, but the actual content
1154  // is often in a different language, mostly the page content language/dir
1155  $header = Html::openElement( 'table', [
1156  'class' => [ 'diff', 'diff-contentalign-' . $this->getDiffLang()->alignStart() ],
1157  'data-mw' => 'interface',
1158  ] );
1159  $userLang = htmlspecialchars( $this->getLanguage()->getHtmlCode() );
1160 
1161  if ( !$diff && !$otitle ) {
1162  $header .= "
1163  <tr style='vertical-align: top;' lang='{$userLang}'>
1164  <td class='diff-ntitle'>{$ntitle}</td>
1165  </tr>";
1166  $multiColspan = 1;
1167  } else {
1168  if ( $diff ) { // Safari/Chrome show broken output if cols not used
1169  $header .= "
1170  <col class='diff-marker' />
1171  <col class='diff-content' />
1172  <col class='diff-marker' />
1173  <col class='diff-content' />";
1174  $colspan = 2;
1175  $multiColspan = 4;
1176  } else {
1177  $colspan = 1;
1178  $multiColspan = 2;
1179  }
1180  if ( $otitle || $ntitle ) {
1181  $header .= "
1182  <tr style='vertical-align: top;' lang='{$userLang}'>
1183  <td colspan='$colspan' class='diff-otitle'>{$otitle}</td>
1184  <td colspan='$colspan' class='diff-ntitle'>{$ntitle}</td>
1185  </tr>";
1186  }
1187  }
1188 
1189  if ( $multi != '' ) {
1190  $header .= "<tr><td colspan='{$multiColspan}' style='text-align: center;' " .
1191  "class='diff-multi' lang='{$userLang}'>{$multi}</td></tr>";
1192  }
1193  if ( $notice != '' ) {
1194  $header .= "<tr><td colspan='{$multiColspan}' style='text-align: center;' " .
1195  "lang='{$userLang}'>{$notice}</td></tr>";
1196  }
1197 
1198  return $header . $diff . "</table>";
1199  }
1200 
1207  public function setContent( Content $oldContent, Content $newContent ) {
1208  $this->mOldContent = $oldContent;
1209  $this->mNewContent = $newContent;
1210 
1211  $this->mTextLoaded = 2;
1212  $this->mRevisionsLoaded = true;
1213  }
1214 
1221  public function setTextLanguage( $lang ) {
1222  $this->mDiffLang = wfGetLangObj( $lang );
1223  }
1224 
1236  public function mapDiffPrevNext( $old, $new ) {
1237  if ( $new === 'prev' ) {
1238  // Show diff between revision $old and the previous one. Get previous one from DB.
1239  $newid = intval( $old );
1240  $oldid = $this->getTitle()->getPreviousRevisionID( $newid );
1241  } elseif ( $new === 'next' ) {
1242  // Show diff between revision $old and the next one. Get next one from DB.
1243  $oldid = intval( $old );
1244  $newid = $this->getTitle()->getNextRevisionID( $oldid );
1245  } else {
1246  $oldid = intval( $old );
1247  $newid = intval( $new );
1248  }
1249 
1250  return [ $oldid, $newid ];
1251  }
1252 
1256  private function loadRevisionIds() {
1257  if ( $this->mRevisionsIdsLoaded ) {
1258  return;
1259  }
1260 
1261  $this->mRevisionsIdsLoaded = true;
1262 
1263  $old = $this->mOldid;
1264  $new = $this->mNewid;
1265 
1266  list( $this->mOldid, $this->mNewid ) = self::mapDiffPrevNext( $old, $new );
1267  if ( $new === 'next' && $this->mNewid === false ) {
1268  # if no result, NewId points to the newest old revision. The only newer
1269  # revision is cur, which is "0".
1270  $this->mNewid = 0;
1271  }
1272 
1273  Hooks::run(
1274  'NewDifferenceEngine',
1275  [ $this->getTitle(), &$this->mOldid, &$this->mNewid, $old, $new ]
1276  );
1277  }
1278 
1291  public function loadRevisionData() {
1292  if ( $this->mRevisionsLoaded ) {
1293  return true;
1294  }
1295 
1296  // Whether it succeeds or fails, we don't want to try again
1297  $this->mRevisionsLoaded = true;
1298 
1299  $this->loadRevisionIds();
1300 
1301  // Load the new revision object
1302  if ( $this->mNewid ) {
1303  $this->mNewRev = Revision::newFromId( $this->mNewid );
1304  } else {
1305  $this->mNewRev = Revision::newFromTitle(
1306  $this->getTitle(),
1307  false,
1308  Revision::READ_NORMAL
1309  );
1310  }
1311 
1312  if ( !$this->mNewRev instanceof Revision ) {
1313  return false;
1314  }
1315 
1316  // Update the new revision ID in case it was 0 (makes life easier doing UI stuff)
1317  $this->mNewid = $this->mNewRev->getId();
1318  $this->mNewPage = $this->mNewRev->getTitle();
1319 
1320  // Load the old revision object
1321  $this->mOldRev = false;
1322  if ( $this->mOldid ) {
1323  $this->mOldRev = Revision::newFromId( $this->mOldid );
1324  } elseif ( $this->mOldid === 0 ) {
1325  $rev = $this->mNewRev->getPrevious();
1326  if ( $rev ) {
1327  $this->mOldid = $rev->getId();
1328  $this->mOldRev = $rev;
1329  } else {
1330  // No previous revision; mark to show as first-version only.
1331  $this->mOldid = false;
1332  $this->mOldRev = false;
1333  }
1334  } /* elseif ( $this->mOldid === false ) leave mOldRev false; */
1335 
1336  if ( is_null( $this->mOldRev ) ) {
1337  return false;
1338  }
1339 
1340  if ( $this->mOldRev ) {
1341  $this->mOldPage = $this->mOldRev->getTitle();
1342  }
1343 
1344  // Load tags information for both revisions
1345  $dbr = wfGetDB( DB_REPLICA );
1346  if ( $this->mOldid !== false ) {
1347  $this->mOldTags = $dbr->selectField(
1348  'tag_summary',
1349  'ts_tags',
1350  [ 'ts_rev_id' => $this->mOldid ],
1351  __METHOD__
1352  );
1353  } else {
1354  $this->mOldTags = false;
1355  }
1356  $this->mNewTags = $dbr->selectField(
1357  'tag_summary',
1358  'ts_tags',
1359  [ 'ts_rev_id' => $this->mNewid ],
1360  __METHOD__
1361  );
1362 
1363  return true;
1364  }
1365 
1371  public function loadText() {
1372  if ( $this->mTextLoaded == 2 ) {
1373  return true;
1374  }
1375 
1376  // Whether it succeeds or fails, we don't want to try again
1377  $this->mTextLoaded = 2;
1378 
1379  if ( !$this->loadRevisionData() ) {
1380  return false;
1381  }
1382 
1383  if ( $this->mOldRev ) {
1384  $this->mOldContent = $this->mOldRev->getContent( Revision::FOR_THIS_USER, $this->getUser() );
1385  if ( $this->mOldContent === null ) {
1386  return false;
1387  }
1388  }
1389 
1390  if ( $this->mNewRev ) {
1391  $this->mNewContent = $this->mNewRev->getContent( Revision::FOR_THIS_USER, $this->getUser() );
1392  if ( $this->mNewContent === null ) {
1393  return false;
1394  }
1395  }
1396 
1397  return true;
1398  }
1399 
1405  public function loadNewText() {
1406  if ( $this->mTextLoaded >= 1 ) {
1407  return true;
1408  }
1409 
1410  $this->mTextLoaded = 1;
1411 
1412  if ( !$this->loadRevisionData() ) {
1413  return false;
1414  }
1415 
1416  $this->mNewContent = $this->mNewRev->getContent( Revision::FOR_THIS_USER, $this->getUser() );
1417 
1418  return true;
1419  }
1420 
1421 }
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:115
setContext(IContextSource $context)
Set the IContextSource object.
bool $mCacheHit
Was the diff fetched from cache?
getDiff($otitle, $ntitle, $notice= '')
Get complete diff table, including header.
const FOR_THIS_USER
Definition: Revision.php:93
makeParserOptions($context)
Get parser options suitable for rendering the primary article wikitext.
Definition: WikiPage.php:2060
getStats()
Get the Stats object.
$enableDebugComment
Set this to true to add debug info to the HTML output.
static getMainWANInstance()
Get the main WAN cache object.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
Interface for objects which can provide a MediaWiki context on request.
static isInRCLifespan($timestamp, $tolerance=0)
Check whether the given timestamp is new enough to have a RC row with a given tolerance as the recent...
static revComment(Revision $rev, $local=false, $isPublic=false)
Wrap and format the given revision's comment block, if the current user is allowed to view it...
Definition: Linker.php:1550
wfGetDB($db, $groups=[], $wiki=false)
Get a Database object.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:802
getDiffBody()
Get the diff table body, without header.
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1555
getLanguage()
Get the Language object.
serialize($format=null)
Convenience method for serializing this Content object.
static getRevDeleteLink(User $user, Revision $rev, Title $title)
Get a revision-deletion link, or disabled link, or nothing, depending on user permissions & the setti...
Definition: Linker.php:2101
__construct($context=null, $old=0, $new=0, $rcid=0, $refreshCache=false, $unhide=false)
#@-
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static getTitleFor($name, $subpage=false, $fragment= '')
Get a localised Title object for a specified special page name If you don't need a full Title object...
Definition: SpecialPage.php:82
getTimestamp()
Definition: Revision.php:1194
localiseLineNumbers($text)
Replace line numbers with the text in the user's language.
static intermediateEditsMsg($numEdits, $numUsers, $limit)
Get a notice about how many intermediate edits and users there are.
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and ...
static rawElement($element, $attribs=[], $contents= '')
Returns an HTML element in a string.
Definition: Html.php:209
wfHostname()
Fetch server name for use in error reporting etc.
if(!isset($args[0])) $lang
static newFromConds($conds, $fname=__METHOD__, $dbType=DB_REPLICA)
Find the first recent change matching some specific conditions.
getParserOutput(WikiPage $page, Revision $rev)
const MW_DIFF_VERSION
$value
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive false for true for descending in case the handler function wants to provide a converted Content object Note that $result getContentModel() must return $toModel. 'CustomEditor'$rcid is used in generating this variable which contains information about the new such as the revision s whether the revision was marked as a minor edit or etc which include things like revision author revision RevisionDelete link and more $formattedRevisionTools
Definition: hooks.txt:1156
getMarkPatrolledLinkInfo()
Returns an array of meta data needed to build a "mark as patrolled" link and adds the mediawiki...
wfShellExec($cmd, &$retval=null, $environ=[], $limits=[], $options=[])
Execute a shell command, with time and memory limits mirrored from the PHP configuration if supported...
also included in $newHeader if any $newminor
Definition: hooks.txt:1211
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
const DIFF_VERSION
Constant to indicate diff cache compatibility.
mapDiffPrevNext($old, $new)
Maps a revision pair definition as accepted by DifferenceEngine constructor to a pair of actual integ...
loadRevisionIds()
Load revision IDs.
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that's attached to a given link target...
Definition: Revision.php:128
IContextSource $context
getTitle()
Get the Title object.
showDiff($otitle, $ntitle, $notice= '')
Get the diff text, send it to the OutputPage object Returns false if the diff could not be generated...
showDiffPage($diffOnly=false)
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message.Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item.Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page.Return false to stop further processing of the tag $reader:XMLReader object &$pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision.Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag.Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload.Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports.&$fullInterwikiPrefix:Interwiki prefix, may contain colons.&$pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable.Can be used to lazy-load the import sources list.&$importSources:The value of $wgImportSources.Modify as necessary.See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page.$context:IContextSource object &$pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect.&$title:Title object for the current page &$request:WebRequest &$ignoreRedirect:boolean to skip redirect check &$target:Title/string of redirect target &$article:Article object 'InternalParseBeforeLinks':during Parser's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InternalParseBeforeSanitize':during Parser's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings.Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not.Return true without providing an interwiki to continue interwiki search.$prefix:interwiki prefix we are looking for.&$iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user's email has been invalidated successfully.$user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification.Callee may modify $url and $query, URL will be constructed as $url.$query &$url:URL to index.php &$query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) &$article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() &$ip:IP being check &$result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from &$allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn't match your organization.$addr:The e-mail address entered by the user &$result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user &$result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we're looking for a messages file for &$file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces.Do not use this hook to add namespaces.Use CanonicalNamespaces for that.&$namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names.&$names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page's language links.This is called in various places to allow extensions to define the effective language links for a page.$title:The page's Title.&$links:Associative array mapping language codes to prefixed links of the form"language:title".&$linkFlags:Associative array mapping prefixed links to arrays of flags.Currently unused, but planned to provide support for marking individual language links in the UI, e.g.for featured articles. 'LanguageSelector':Hook to change the language selector available on a page.$out:The output page.$cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED!Use HtmlPageLinkRendererBegin instead.Used when generating internal and interwiki links in Linker::link(), before processing starts.Return false to skip default processing and return $ret.See documentation for Linker::link() for details on the expected meanings of parameters.$skin:the Skin object $target:the Title that the link is pointing to &$html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1934
localiseLineNumbersCb($matches)
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:2889
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
getRequest()
Get the WebRequest object.
generateContentDiffBody(Content $old, Content $new)
Generate a diff, no caching.
MediaWiki default table style diff formatter.
wfDebugLog($logGroup, $text, $dest= 'all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
msg()
Get a Message object with context set Parameters are the same as wfMessage()
Convenience class for dealing with PoolCounters using callbacks.
isDeleted($field)
Definition: Revision.php:1015
static openElement($element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
Definition: Html.php:247
string $mMarkPatrolledLink
Link to action=markpatrolled.
Content object implementation for representing flat text.
Definition: TextContent.php:35
getTitle()
Returns the title of the page associated with this entry or null.
Definition: Revision.php:803
wfTempDir()
Tries to get the system directory for temporary files.
debug($generator="internal")
Generate a debug comment indicating diff generating time, server node, and generator backend...
wfMergeErrorArrays()
Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.
renderNewRevision()
Show the new revision of the page.
static formatSummaryRow($tags, $page, IContextSource $context=null)
Creates HTML for the given tags.
Definition: ChangeTags.php:50
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify prev or next $refreshCache
Definition: hooks.txt:1555
static titleAttrib($name, $options=null, array $msgParams=[])
Given the id of an interface element, constructs the appropriate title attribute from the system mess...
Definition: Linker.php:2022
bool $mRefreshCache
Refresh the diff cache.
wfWarn($msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock()-offset Set to overwrite offset parameter in $wgRequest set to ''to unsetoffset-wrap String Wrap the message in html(usually something like"&lt
if($limit) $timestamp
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context $parserOutput
Definition: hooks.txt:1046
getId()
Get revision ID.
Definition: Revision.php:729
bool $mRevisionsIdsLoaded
Have the revisions IDs been loaded.
deletedLink($id)
Look up a special:Undelete link to the given deleted revision id, as a workaround for being unable to...
it s the revision text itself In either if gzip is set
Definition: hooks.txt:2703
markPatrolledLink()
Build a link to mark a change as patrolled.
Base interface for content objects.
Definition: Content.php:34
Class representing a 'diff' between two sequences of strings.
getContext()
Get the base IContextSource object.
$cache
Definition: mcc.php:33
wfDeprecated($function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
getMultiNotice()
If there are revisions between the ones being compared, return a note saying so.
userCan($field, User $user=null)
Determine if the current user is allowed to view a particular field of this revision, if it's marked as deleted.
Definition: Revision.php:1746
static makeTitleSafe($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:535
passed in as a query string parameter to the various URLs constructed here(i.e.$nextlink) $rdel also included in $oldHeader $oldminor
Definition: hooks.txt:1215
wfIncrStats($key, $count=1)
Increment a statistics counter.
Some information about database access in MediaWiki By Tim January Database layout For information about the MediaWiki database such as a description of the tables and their please see
Definition: database.txt:2
const DELETED_RESTRICTED
Definition: Revision.php:88
bool $unhide
Show rev_deleted content if allowed.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
static linkKnown($target, $html=null, $customAttribs=[], $query=[], $options=[ 'known'])
Identical to link(), except $options defaults to 'known'.
Definition: Linker.php:255
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
addHeader($diff, $otitle, $ntitle, $multi= '', $notice= '')
Add the header to a diff body.
$header
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive false for true for descending in case the handler function wants to provide a converted Content object Note that $result getContentModel() must return $toModel. 'CustomEditor'$rcid is used in generating this variable which contains information about the new such as the revision s whether the revision was marked as a minor edit or etc which include things like revision author revision RevisionDelete link and more some of which may have been injected with the DiffRevisionTools hook $nextlink
Definition: hooks.txt:1156
textDiff($otext, $ntext)
Generates diff, to be wrapped internally in a logging/instrumentation.
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1721
setContent(Content $oldContent, Content $newContent)
Use specified text instead of loading from the database.
const RAW
Definition: Revision.php:94
int $mTextLoaded
How many text blobs have been loaded, 0, 1 or 2?
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
getRevisionHeader(Revision $rev, $complete= '')
Get a header for a specified revision.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive false for true for descending in case the handler function wants to provide a converted Content object Note that $result getContentModel() must return $toModel. 'CustomEditor'$rcid is used in generating this variable which contains information about the new such as the revision s whether the revision was marked as a minor edit or not
Definition: hooks.txt:1156
Exception class which takes an HTML error message, and does not produce a backtrace.
Definition: FatalError.php:28
const DELETED_TEXT
Definition: Revision.php:85
Class representing a MediaWiki article and history.
Definition: WikiPage.php:32
static newFromId($id, $flags=0)
Load a page revision from a given revision ID number.
Definition: Revision.php:110
setReducedLineNumbers($value=true)
deletedIdMarker($id)
Build a wikitext link toward a deleted revision, if viewable.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
controlled by $wgMainCacheType controlled by $wgParserCacheType controlled by $wgMessageCacheType If you set CACHE_NONE to one of the three control default value for MediaWiki still create a but requests to it are no ops and we always fall through to the database If the cache daemon can t be it should also disable itself fairly smoothly By $wgMemc is used but when it is $parserMemc or $messageMemc this is mentioned below
Definition: memcached.txt:96
static generateRollback($rev, IContextSource $context=null, $options=[ 'verify'])
Generate a rollback link for a given revision.
Definition: Linker.php:1761
generateTextDiffBody($otext, $ntext)
Generate a diff, no caching.
bool $mRevisionsLoaded
Have the revisions been loaded.
Show an error when a user tries to do something they do not have the necessary permissions for...
setTextLanguage($lang)
Set the language in which the diff text is written (Defaults to page content language).
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive $limit
Definition: hooks.txt:1046
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
showDiffStyle()
Add style sheets for diff display.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1046
static flag($flag, IContextSource $context=null)
Make an "" element for a given change flag.
bool $mReducedLineNumbers
If true, line X is not displayed when X is 1, for example to increase readability and conserve space ...
wfEscapeShellArg()
Version of escapeshellarg() that works better on Windows.
loadNewText()
Load the text of the new revision, not the old one.
also included in $newHeader $rollback
Definition: hooks.txt:1211
getParserOutput(ParserOptions $parserOptions, $oldid=null, $forceParse=false)
Get a ParserOutput for the given ParserOptions and revision ID.
Definition: WikiPage.php:1085
getDiffBodyCacheKey()
Returns the cache key for diff body text or content.
wfMemcKey()
Make a cache key for the local wiki.
const DB_REPLICA
Definition: defines.php:22
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging a wrapping ErrorException $suppressed
Definition: hooks.txt:2102
static newFromArchiveRow($row, $overrides=[])
Make a fake revision object from an archive table row.
Definition: Revision.php:183
static revUserTools($rev, $isPublic=false)
Generate a user tool link cluster if the current user is allowed to view it.
Definition: Linker.php:1141
getWikiPage()
Get the WikiPage object.
static element($element, $attribs=[], $contents= '')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:229
loadRevisionData()
Load revision metadata for the specified articles.
getUser()
Get the User object.
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1749
const TS_DB
MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
Definition: defines.php:16
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
Definition: hooks.txt:2491
static runLegacyHooks($event, $args=[], $deprecatedVersion=null)
Call a legacy hook that uses text instead of Content objects.
wfGetLangObj($langcode=false)
Return a Language object from $langcode.
loadText()
Load the text of the revisions, as well as revision data.
$matches
getOutput()
Get the OutputPage object.