MediaWiki  REL1_31
DifferenceEngine.php
Go to the documentation of this file.
1 <?php
25 
37  const DIFF_VERSION = '1.12';
38 
40  public $mOldid;
41 
43  public $mNewid;
44 
45  private $mOldTags;
46  private $mNewTags;
47 
49  public $mOldContent;
50 
52  public $mNewContent;
53 
55  protected $mDiffLang;
56 
58  public $mOldPage;
59 
61  public $mNewPage;
62 
64  public $mOldRev;
65 
67  public $mNewRev;
68 
70  private $mRevisionsIdsLoaded = false;
71 
73  public $mRevisionsLoaded = false;
74 
76  public $mTextLoaded = 0;
77 
79  public $mCacheHit = false;
80 
86  public $enableDebugComment = false;
87 
91  protected $mReducedLineNumbers = false;
92 
94  protected $mMarkPatrolledLink = null;
95 
97  protected $unhide = false;
98 
100  protected $mRefreshCache = false;
101 
112  public function __construct( $context = null, $old = 0, $new = 0, $rcid = 0,
113  $refreshCache = false, $unhide = false
114  ) {
115  if ( $context instanceof IContextSource ) {
116  $this->setContext( $context );
117  }
118 
119  wfDebug( "DifferenceEngine old '$old' new '$new' rcid '$rcid'\n" );
120 
121  $this->mOldid = $old;
122  $this->mNewid = $new;
123  $this->mRefreshCache = $refreshCache;
124  $this->unhide = $unhide;
125  }
126 
130  public function setReducedLineNumbers( $value = true ) {
131  $this->mReducedLineNumbers = $value;
132  }
133 
137  public function getDiffLang() {
138  if ( $this->mDiffLang === null ) {
139  # Default language in which the diff text is written.
140  $this->mDiffLang = $this->getTitle()->getPageLanguage();
141  }
142 
143  return $this->mDiffLang;
144  }
145 
149  public function wasCacheHit() {
150  return $this->mCacheHit;
151  }
152 
156  public function getOldid() {
157  $this->loadRevisionIds();
158 
159  return $this->mOldid;
160  }
161 
165  public function getNewid() {
166  $this->loadRevisionIds();
167 
168  return $this->mNewid;
169  }
170 
179  public function deletedLink( $id ) {
180  if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
181  $dbr = wfGetDB( DB_REPLICA );
182  $arQuery = Revision::getArchiveQueryInfo();
183  $row = $dbr->selectRow(
184  $arQuery['tables'],
185  array_merge( $arQuery['fields'], [ 'ar_namespace', 'ar_title' ] ),
186  [ 'ar_rev_id' => $id ],
187  __METHOD__,
188  [],
189  $arQuery['joins']
190  );
191  if ( $row ) {
193  $title = Title::makeTitleSafe( $row->ar_namespace, $row->ar_title );
194 
195  return SpecialPage::getTitleFor( 'Undelete' )->getFullURL( [
196  'target' => $title->getPrefixedText(),
197  'timestamp' => $rev->getTimestamp()
198  ] );
199  }
200  }
201 
202  return false;
203  }
204 
212  public function deletedIdMarker( $id ) {
213  $link = $this->deletedLink( $id );
214  if ( $link ) {
215  return "[$link $id]";
216  } else {
217  return (string)$id;
218  }
219  }
220 
221  private function showMissingRevision() {
222  $out = $this->getOutput();
223 
224  $missing = [];
225  if ( $this->mOldRev === null ||
226  ( $this->mOldRev && $this->mOldContent === null )
227  ) {
228  $missing[] = $this->deletedIdMarker( $this->mOldid );
229  }
230  if ( $this->mNewRev === null ||
231  ( $this->mNewRev && $this->mNewContent === null )
232  ) {
233  $missing[] = $this->deletedIdMarker( $this->mNewid );
234  }
235 
236  $out->setPageTitle( $this->msg( 'errorpagetitle' ) );
237  $msg = $this->msg( 'difference-missing-revision' )
238  ->params( $this->getLanguage()->listToText( $missing ) )
239  ->numParams( count( $missing ) )
240  ->parseAsBlock();
241  $out->addHTML( $msg );
242  }
243 
244  public function showDiffPage( $diffOnly = false ) {
245  # Allow frames except in certain special cases
246  $out = $this->getOutput();
247  $out->allowClickjacking();
248  $out->setRobotPolicy( 'noindex,nofollow' );
249 
250  // Allow extensions to add any extra output here
251  Hooks::run( 'DifferenceEngineShowDiffPage', [ $out ] );
252 
253  if ( !$this->loadRevisionData() ) {
254  if ( Hooks::run( 'DifferenceEngineShowDiffPageMaybeShowMissingRevision', [ $this ] ) ) {
255  $this->showMissingRevision();
256  }
257  return;
258  }
259 
260  $user = $this->getUser();
261  $permErrors = $this->mNewPage->getUserPermissionsErrors( 'read', $user );
262  if ( $this->mOldPage ) { # mOldPage might not be set, see below.
263  $permErrors = wfMergeErrorArrays( $permErrors,
264  $this->mOldPage->getUserPermissionsErrors( 'read', $user ) );
265  }
266  if ( count( $permErrors ) ) {
267  throw new PermissionsError( 'read', $permErrors );
268  }
269 
270  $rollback = '';
271 
272  $query = [];
273  # Carry over 'diffonly' param via navigation links
274  if ( $diffOnly != $user->getBoolOption( 'diffonly' ) ) {
275  $query['diffonly'] = $diffOnly;
276  }
277  # Cascade unhide param in links for easy deletion browsing
278  if ( $this->unhide ) {
279  $query['unhide'] = 1;
280  }
281 
282  # Check if one of the revisions is deleted/suppressed
283  $deleted = $suppressed = false;
284  $allowed = $this->mNewRev->userCan( Revision::DELETED_TEXT, $user );
285 
286  $revisionTools = [];
287 
288  # mOldRev is false if the difference engine is called with a "vague" query for
289  # a diff between a version V and its previous version V' AND the version V
290  # is the first version of that article. In that case, V' does not exist.
291  if ( $this->mOldRev === false ) {
292  $out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage->getPrefixedText() ) );
293  $samePage = true;
294  $oldHeader = '';
295  // Allow extensions to change the $oldHeader variable
296  Hooks::run( 'DifferenceEngineOldHeaderNoOldRev', [ &$oldHeader ] );
297  } else {
298  Hooks::run( 'DiffViewHeader', [ $this, $this->mOldRev, $this->mNewRev ] );
299 
300  if ( $this->mNewPage->equals( $this->mOldPage ) ) {
301  $out->setPageTitle( $this->msg( 'difference-title', $this->mNewPage->getPrefixedText() ) );
302  $samePage = true;
303  } else {
304  $out->setPageTitle( $this->msg( 'difference-title-multipage',
305  $this->mOldPage->getPrefixedText(), $this->mNewPage->getPrefixedText() ) );
306  $out->addSubtitle( $this->msg( 'difference-multipage' ) );
307  $samePage = false;
308  }
309 
310  if ( $samePage && $this->mNewPage->quickUserCan( 'edit', $user ) ) {
311  if ( $this->mNewRev->isCurrent() && $this->mNewPage->userCan( 'rollback', $user ) ) {
312  $rollbackLink = Linker::generateRollback( $this->mNewRev, $this->getContext() );
313  if ( $rollbackLink ) {
314  $out->preventClickjacking();
315  $rollback = '&#160;&#160;&#160;' . $rollbackLink;
316  }
317  }
318 
319  if ( !$this->mOldRev->isDeleted( Revision::DELETED_TEXT ) &&
320  !$this->mNewRev->isDeleted( Revision::DELETED_TEXT )
321  ) {
322  $undoLink = Html::element( 'a', [
323  'href' => $this->mNewPage->getLocalURL( [
324  'action' => 'edit',
325  'undoafter' => $this->mOldid,
326  'undo' => $this->mNewid
327  ] ),
328  'title' => Linker::titleAttrib( 'undo' ),
329  ],
330  $this->msg( 'editundo' )->text()
331  );
332  $revisionTools['mw-diff-undo'] = $undoLink;
333  }
334  }
335 
336  # Make "previous revision link"
337  if ( $samePage && $this->mOldRev->getPrevious() ) {
338  $prevlink = Linker::linkKnown(
339  $this->mOldPage,
340  $this->msg( 'previousdiff' )->escaped(),
341  [ 'id' => 'differences-prevlink' ],
342  [ 'diff' => 'prev', 'oldid' => $this->mOldid ] + $query
343  );
344  } else {
345  $prevlink = '&#160;';
346  }
347 
348  if ( $this->mOldRev->isMinor() ) {
349  $oldminor = ChangesList::flag( 'minor' );
350  } else {
351  $oldminor = '';
352  }
353 
354  $ldel = $this->revisionDeleteLink( $this->mOldRev );
355  $oldRevisionHeader = $this->getRevisionHeader( $this->mOldRev, 'complete' );
356  $oldChangeTags = ChangeTags::formatSummaryRow( $this->mOldTags, 'diff', $this->getContext() );
357 
358  $oldHeader = '<div id="mw-diff-otitle1"><strong>' . $oldRevisionHeader . '</strong></div>' .
359  '<div id="mw-diff-otitle2">' .
360  Linker::revUserTools( $this->mOldRev, !$this->unhide ) . '</div>' .
361  '<div id="mw-diff-otitle3">' . $oldminor .
362  Linker::revComment( $this->mOldRev, !$diffOnly, !$this->unhide ) . $ldel . '</div>' .
363  '<div id="mw-diff-otitle5">' . $oldChangeTags[0] . '</div>' .
364  '<div id="mw-diff-otitle4">' . $prevlink . '</div>';
365 
366  // Allow extensions to change the $oldHeader variable
367  Hooks::run( 'DifferenceEngineOldHeader', [ $this, &$oldHeader, $prevlink, $oldminor,
368  $diffOnly, $ldel, $this->unhide ] );
369 
370  if ( $this->mOldRev->isDeleted( Revision::DELETED_TEXT ) ) {
371  $deleted = true; // old revisions text is hidden
372  if ( $this->mOldRev->isDeleted( Revision::DELETED_RESTRICTED ) ) {
373  $suppressed = true; // also suppressed
374  }
375  }
376 
377  # Check if this user can see the revisions
378  if ( !$this->mOldRev->userCan( Revision::DELETED_TEXT, $user ) ) {
379  $allowed = false;
380  }
381  }
382 
383  $out->addJsConfigVars( [
384  'wgDiffOldId' => $this->mOldid,
385  'wgDiffNewId' => $this->mNewid,
386  ] );
387 
388  # Make "next revision link"
389  # Skip next link on the top revision
390  if ( $samePage && !$this->mNewRev->isCurrent() ) {
391  $nextlink = Linker::linkKnown(
392  $this->mNewPage,
393  $this->msg( 'nextdiff' )->escaped(),
394  [ 'id' => 'differences-nextlink' ],
395  [ 'diff' => 'next', 'oldid' => $this->mNewid ] + $query
396  );
397  } else {
398  $nextlink = '&#160;';
399  }
400 
401  if ( $this->mNewRev->isMinor() ) {
402  $newminor = ChangesList::flag( 'minor' );
403  } else {
404  $newminor = '';
405  }
406 
407  # Handle RevisionDelete links...
408  $rdel = $this->revisionDeleteLink( $this->mNewRev );
409 
410  # Allow extensions to define their own revision tools
411  Hooks::run( 'DiffRevisionTools',
412  [ $this->mNewRev, &$revisionTools, $this->mOldRev, $user ] );
413  $formattedRevisionTools = [];
414  // Put each one in parentheses (poor man's button)
415  foreach ( $revisionTools as $key => $tool ) {
416  $toolClass = is_string( $key ) ? $key : 'mw-diff-tool';
417  $element = Html::rawElement(
418  'span',
419  [ 'class' => $toolClass ],
420  $this->msg( 'parentheses' )->rawParams( $tool )->escaped()
421  );
422  $formattedRevisionTools[] = $element;
423  }
424  $newRevisionHeader = $this->getRevisionHeader( $this->mNewRev, 'complete' ) .
425  ' ' . implode( ' ', $formattedRevisionTools );
426  $newChangeTags = ChangeTags::formatSummaryRow( $this->mNewTags, 'diff', $this->getContext() );
427 
428  $newHeader = '<div id="mw-diff-ntitle1"><strong>' . $newRevisionHeader . '</strong></div>' .
429  '<div id="mw-diff-ntitle2">' . Linker::revUserTools( $this->mNewRev, !$this->unhide ) .
430  " $rollback</div>" .
431  '<div id="mw-diff-ntitle3">' . $newminor .
432  Linker::revComment( $this->mNewRev, !$diffOnly, !$this->unhide ) . $rdel . '</div>' .
433  '<div id="mw-diff-ntitle5">' . $newChangeTags[0] . '</div>' .
434  '<div id="mw-diff-ntitle4">' . $nextlink . $this->markPatrolledLink() . '</div>';
435 
436  // Allow extensions to change the $newHeader variable
437  Hooks::run( 'DifferenceEngineNewHeader', [ $this, &$newHeader, $formattedRevisionTools,
438  $nextlink, $rollback, $newminor, $diffOnly, $rdel, $this->unhide ] );
439 
440  if ( $this->mNewRev->isDeleted( Revision::DELETED_TEXT ) ) {
441  $deleted = true; // new revisions text is hidden
442  if ( $this->mNewRev->isDeleted( Revision::DELETED_RESTRICTED ) ) {
443  $suppressed = true; // also suppressed
444  }
445  }
446 
447  # If the diff cannot be shown due to a deleted revision, then output
448  # the diff header and links to unhide (if available)...
449  if ( $deleted && ( !$this->unhide || !$allowed ) ) {
450  $this->showDiffStyle();
451  $multi = $this->getMultiNotice();
452  $out->addHTML( $this->addHeader( '', $oldHeader, $newHeader, $multi ) );
453  if ( !$allowed ) {
454  $msg = $suppressed ? 'rev-suppressed-no-diff' : 'rev-deleted-no-diff';
455  # Give explanation for why revision is not visible
456  $out->wrapWikiMsg( "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
457  [ $msg ] );
458  } else {
459  # Give explanation and add a link to view the diff...
460  $query = $this->getRequest()->appendQueryValue( 'unhide', '1' );
461  $link = $this->getTitle()->getFullURL( $query );
462  $msg = $suppressed ? 'rev-suppressed-unhide-diff' : 'rev-deleted-unhide-diff';
463  $out->wrapWikiMsg(
464  "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
465  [ $msg, $link ]
466  );
467  }
468  # Otherwise, output a regular diff...
469  } else {
470  # Add deletion notice if the user is viewing deleted content
471  $notice = '';
472  if ( $deleted ) {
473  $msg = $suppressed ? 'rev-suppressed-diff-view' : 'rev-deleted-diff-view';
474  $notice = "<div id='mw-$msg' class='mw-warning plainlinks'>\n" .
475  $this->msg( $msg )->parse() .
476  "</div>\n";
477  }
478  $this->showDiff( $oldHeader, $newHeader, $notice );
479  if ( !$diffOnly ) {
480  $this->renderNewRevision();
481  }
482  }
483  }
484 
494  public function markPatrolledLink() {
495  if ( $this->mMarkPatrolledLink === null ) {
496  $linkInfo = $this->getMarkPatrolledLinkInfo();
497  // If false, there is no patrol link needed/allowed
498  if ( !$linkInfo ) {
499  $this->mMarkPatrolledLink = '';
500  } else {
501  $this->mMarkPatrolledLink = ' <span class="patrollink" data-mw="interface">[' .
503  $this->mNewPage,
504  $this->msg( 'markaspatrolleddiff' )->escaped(),
505  [],
506  [
507  'action' => 'markpatrolled',
508  'rcid' => $linkInfo['rcid'],
509  ]
510  ) . ']</span>';
511  // Allow extensions to change the markpatrolled link
512  Hooks::run( 'DifferenceEngineMarkPatrolledLink', [ $this,
513  &$this->mMarkPatrolledLink, $linkInfo['rcid'] ] );
514  }
515  }
517  }
518 
526  protected function getMarkPatrolledLinkInfo() {
528 
529  $user = $this->getUser();
530 
531  // Prepare a change patrol link, if applicable
532  if (
533  // Is patrolling enabled and the user allowed to?
534  $wgUseRCPatrol && $this->mNewPage->quickUserCan( 'patrol', $user ) &&
535  // Only do this if the revision isn't more than 6 hours older
536  // than the Max RC age (6h because the RC might not be cleaned out regularly)
537  RecentChange::isInRCLifespan( $this->mNewRev->getTimestamp(), 21600 )
538  ) {
539  // Look for an unpatrolled change corresponding to this diff
540  $db = wfGetDB( DB_REPLICA );
541  $change = RecentChange::newFromConds(
542  [
543  'rc_timestamp' => $db->timestamp( $this->mNewRev->getTimestamp() ),
544  'rc_this_oldid' => $this->mNewid,
545  'rc_patrolled' => RecentChange::PRC_UNPATROLLED
546  ],
547  __METHOD__
548  );
549 
550  if ( $change && !$change->getPerformer()->equals( $user ) ) {
551  $rcid = $change->getAttribute( 'rc_id' );
552  } else {
553  // None found or the page has been created by the current user.
554  // If the user could patrol this it already would be patrolled
555  $rcid = 0;
556  }
557 
558  // Allow extensions to possibly change the rcid here
559  // For example the rcid might be set to zero due to the user
560  // being the same as the performer of the change but an extension
561  // might still want to show it under certain conditions
562  Hooks::run( 'DifferenceEngineMarkPatrolledRCID', [ &$rcid, $this, $change, $user ] );
563 
564  // Build the link
565  if ( $rcid ) {
566  $this->getOutput()->preventClickjacking();
567  if ( $wgEnableAPI && $wgEnableWriteAPI
568  && $user->isAllowed( 'writeapi' )
569  ) {
570  $this->getOutput()->addModules( 'mediawiki.page.patrol.ajax' );
571  }
572 
573  return [
574  'rcid' => $rcid,
575  ];
576  }
577  }
578 
579  // No mark as patrolled link applicable
580  return false;
581  }
582 
588  protected function revisionDeleteLink( $rev ) {
589  $link = Linker::getRevDeleteLink( $this->getUser(), $rev, $rev->getTitle() );
590  if ( $link !== '' ) {
591  $link = '&#160;&#160;&#160;' . $link . ' ';
592  }
593 
594  return $link;
595  }
596 
600  public function renderNewRevision() {
601  $out = $this->getOutput();
602  $revHeader = $this->getRevisionHeader( $this->mNewRev );
603  # Add "current version as of X" title
604  $out->addHTML( "<hr class='diff-hr' id='mw-oldid' />
605  <h2 class='diff-currentversion-title'>{$revHeader}</h2>\n" );
606  # Page content may be handled by a hooked call instead...
607  if ( Hooks::run( 'ArticleContentOnDiff', [ $this, $out ] ) ) {
608  $this->loadNewText();
609  $out->setRevisionId( $this->mNewid );
610  $out->setRevisionTimestamp( $this->mNewRev->getTimestamp() );
611  $out->setArticleFlag( true );
612 
613  if ( !Hooks::run( 'ArticleContentViewCustom',
614  [ $this->mNewContent, $this->mNewPage, $out ] )
615  ) {
616  // Handled by extension
617  } else {
618  // Normal page
619  if ( $this->getTitle()->equals( $this->mNewPage ) ) {
620  // If the Title stored in the context is the same as the one
621  // of the new revision, we can use its associated WikiPage
622  // object.
623  $wikiPage = $this->getWikiPage();
624  } else {
625  // Otherwise we need to create our own WikiPage object
626  $wikiPage = WikiPage::factory( $this->mNewPage );
627  }
628 
629  $parserOutput = $this->getParserOutput( $wikiPage, $this->mNewRev );
630 
631  # WikiPage::getParserOutput() should not return false, but just in case
632  if ( $parserOutput ) {
633  // Allow extensions to change parser output here
634  if ( Hooks::run( 'DifferenceEngineRenderRevisionAddParserOutput',
635  [ $this, $out, $parserOutput, $wikiPage ] )
636  ) {
637  $out->addParserOutput( $parserOutput, [
638  'enableSectionEditLinks' => $this->mNewRev->isCurrent()
639  && $this->mNewRev->getTitle()->quickUserCan( 'edit', $this->getUser() ),
640  ] );
641  }
642  }
643  }
644  }
645 
646  // Allow extensions to optionally not show the final patrolled link
647  if ( Hooks::run( 'DifferenceEngineRenderRevisionShowFinalPatrolLink' ) ) {
648  # Add redundant patrol link on bottom...
649  $out->addHTML( $this->markPatrolledLink() );
650  }
651  }
652 
659  protected function getParserOutput( WikiPage $page, Revision $rev ) {
660  $parserOptions = $page->makeParserOptions( $this->getContext() );
661  $parserOutput = $page->getParserOutput( $parserOptions, $rev->getId() );
662 
663  return $parserOutput;
664  }
665 
676  public function showDiff( $otitle, $ntitle, $notice = '' ) {
677  // Allow extensions to affect the output here
678  Hooks::run( 'DifferenceEngineShowDiff', [ $this ] );
679 
680  $diff = $this->getDiff( $otitle, $ntitle, $notice );
681  if ( $diff === false ) {
682  $this->showMissingRevision();
683 
684  return false;
685  } else {
686  $this->showDiffStyle();
687  $this->getOutput()->addHTML( $diff );
688 
689  return true;
690  }
691  }
692 
696  public function showDiffStyle() {
697  $this->getOutput()->addModuleStyles( 'mediawiki.diff.styles' );
698  }
699 
709  public function getDiff( $otitle, $ntitle, $notice = '' ) {
710  $body = $this->getDiffBody();
711  if ( $body === false ) {
712  return false;
713  }
714 
715  $multi = $this->getMultiNotice();
716  // Display a message when the diff is empty
717  if ( $body === '' ) {
718  $notice .= '<div class="mw-diff-empty">' .
719  $this->msg( 'diff-empty' )->parse() .
720  "</div>\n";
721  }
722 
723  return $this->addHeader( $body, $otitle, $ntitle, $multi, $notice );
724  }
725 
731  public function getDiffBody() {
732  $this->mCacheHit = true;
733  // Check if the diff should be hidden from this user
734  if ( !$this->loadRevisionData() ) {
735  return false;
736  } elseif ( $this->mOldRev &&
737  !$this->mOldRev->userCan( Revision::DELETED_TEXT, $this->getUser() )
738  ) {
739  return false;
740  } elseif ( $this->mNewRev &&
741  !$this->mNewRev->userCan( Revision::DELETED_TEXT, $this->getUser() )
742  ) {
743  return false;
744  }
745  // Short-circuit
746  if ( $this->mOldRev === false || ( $this->mOldRev && $this->mNewRev
747  && $this->mOldRev->getId() == $this->mNewRev->getId() )
748  ) {
749  if ( Hooks::run( 'DifferenceEngineShowEmptyOldContent', [ $this ] ) ) {
750  return '';
751  }
752  }
753  // Cacheable?
754  $key = false;
756  if ( $this->mOldid && $this->mNewid ) {
757  // Check if subclass is still using the old way
758  // for backwards-compatibility
759  $key = $this->getDiffBodyCacheKey();
760  if ( $key === null ) {
761  $key = call_user_func_array(
762  [ $cache, 'makeKey' ],
764  );
765  }
766 
767  // Try cache
768  if ( !$this->mRefreshCache ) {
769  $difftext = $cache->get( $key );
770  if ( $difftext ) {
771  wfIncrStats( 'diff_cache.hit' );
772  $difftext = $this->localiseDiff( $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  // Avoid PHP 7.1 warning from passing $this by reference
789  $diffEngine = $this;
790 
791  // Save to cache for 7 days
792  if ( !Hooks::run( 'AbortDiffCache', [ &$diffEngine ] ) ) {
793  wfIncrStats( 'diff_cache.uncacheable' );
794  } elseif ( $key !== false && $difftext !== false ) {
795  wfIncrStats( 'diff_cache.miss' );
796  $cache->set( $key, $difftext, 7 * 86400 );
797  } else {
798  wfIncrStats( 'diff_cache.uncacheable' );
799  }
800  // localise line numbers and title attribute text
801  if ( $difftext !== false ) {
802  $difftext = $this->localiseDiff( $difftext );
803  }
804 
805  return $difftext;
806  }
807 
817  protected function getDiffBodyCacheKey() {
818  return null;
819  }
820 
834  protected function getDiffBodyCacheKeyParams() {
835  if ( !$this->mOldid || !$this->mNewid ) {
836  throw new MWException( 'mOldid and mNewid must be set to get diff cache key.' );
837  }
838 
839  $engine = $this->getEngine();
840  $params = [
841  'diff',
842  $engine,
844  "old-{$this->mOldid}",
845  "rev-{$this->mNewid}"
846  ];
847 
848  if ( $engine === 'wikidiff2' ) {
849  $params[] = phpversion( 'wikidiff2' );
850  $params[] = $this->getConfig()->get( 'WikiDiff2MovedParagraphDetectionCutoff' );
851  }
852 
853  return $params;
854  }
855 
875  public function generateContentDiffBody( Content $old, Content $new ) {
876  if ( !( $old instanceof TextContent ) ) {
877  throw new MWException( "Diff not implemented for " . get_class( $old ) . "; " .
878  "override generateContentDiffBody to fix this." );
879  }
880 
881  if ( !( $new instanceof TextContent ) ) {
882  throw new MWException( "Diff not implemented for " . get_class( $new ) . "; "
883  . "override generateContentDiffBody to fix this." );
884  }
885 
886  $otext = $old->serialize();
887  $ntext = $new->serialize();
888 
889  return $this->generateTextDiffBody( $otext, $ntext );
890  }
891 
902  public function generateTextDiffBody( $otext, $ntext ) {
903  $diff = function () use ( $otext, $ntext ) {
904  $time = microtime( true );
905 
906  $result = $this->textDiff( $otext, $ntext );
907 
908  $time = intval( ( microtime( true ) - $time ) * 1000 );
909  MediaWikiServices::getInstance()->getStatsdDataFactory()->timing( 'diff_time', $time );
910  // Log requests slower than 99th percentile
911  if ( $time > 100 && $this->mOldPage && $this->mNewPage ) {
912  wfDebugLog( 'diff',
913  "$time ms diff: {$this->mOldid} -> {$this->mNewid} {$this->mNewPage}" );
914  }
915 
916  return $result;
917  };
918 
923  $error = function ( $status ) {
924  throw new FatalError( $status->getWikiText() );
925  };
926 
927  // Use PoolCounter if the diff looks like it can be expensive
928  if ( strlen( $otext ) + strlen( $ntext ) > 20000 ) {
929  $work = new PoolCounterWorkViaCallback( 'diff',
930  md5( $otext ) . md5( $ntext ),
931  [ 'doWork' => $diff, 'error' => $error ]
932  );
933  return $work->execute();
934  }
935 
936  return $diff();
937  }
938 
944  private function getEngine() {
946  // We use the global here instead of Config because we write to the value,
947  // and Config is not mutable.
948  if ( $wgExternalDiffEngine == 'wikidiff' || $wgExternalDiffEngine == 'wikidiff3' ) {
949  wfDeprecated( "\$wgExternalDiffEngine = '{$wgExternalDiffEngine}'", '1.27' );
950  $wgExternalDiffEngine = false;
951  } elseif ( $wgExternalDiffEngine == 'wikidiff2' ) {
952  // Same as above, but with no deprecation warnings
953  $wgExternalDiffEngine = false;
954  } elseif ( !is_string( $wgExternalDiffEngine ) && $wgExternalDiffEngine !== false ) {
955  // And prevent people from shooting themselves in the foot...
956  wfWarn( '$wgExternalDiffEngine is set to a non-string value, forcing it to false' );
957  $wgExternalDiffEngine = false;
958  }
959 
960  if ( is_string( $wgExternalDiffEngine ) && is_executable( $wgExternalDiffEngine ) ) {
961  return $wgExternalDiffEngine;
962  } elseif ( $wgExternalDiffEngine === false && function_exists( 'wikidiff2_do_diff' ) ) {
963  return 'wikidiff2';
964  } else {
965  // Native PHP
966  return false;
967  }
968  }
969 
977  protected function textDiff( $otext, $ntext ) {
979 
980  $otext = str_replace( "\r\n", "\n", $otext );
981  $ntext = str_replace( "\r\n", "\n", $ntext );
982 
983  $engine = $this->getEngine();
984 
985  // Better external diff engine, the 2 may some day be dropped
986  // This one does the escaping and segmenting itself
987  if ( $engine === 'wikidiff2' ) {
988  $wikidiff2Version = phpversion( 'wikidiff2' );
989  if (
990  $wikidiff2Version !== false &&
991  version_compare( $wikidiff2Version, '1.5.0', '>=' )
992  ) {
993  $text = wikidiff2_do_diff(
994  $otext,
995  $ntext,
996  2,
997  $this->getConfig()->get( 'WikiDiff2MovedParagraphDetectionCutoff' )
998  );
999  } else {
1000  // Don't pass the 4th parameter for compatibility with older versions of wikidiff2
1001  $text = wikidiff2_do_diff(
1002  $otext,
1003  $ntext,
1004  2
1005  );
1006 
1007  // Log a warning in case the configuration value is set to not silently ignore it
1008  if ( $this->getConfig()->get( 'WikiDiff2MovedParagraphDetectionCutoff' ) > 0 ) {
1009  wfLogWarning( '$wgWikiDiff2MovedParagraphDetectionCutoff is set but has no
1010  effect since the used version of WikiDiff2 does not support it.' );
1011  }
1012  }
1013 
1014  $text .= $this->debug( 'wikidiff2' );
1015 
1016  return $text;
1017  } elseif ( $engine !== false ) {
1018  # Diff via the shell
1019  $tmpDir = wfTempDir();
1020  $tempName1 = tempnam( $tmpDir, 'diff_' );
1021  $tempName2 = tempnam( $tmpDir, 'diff_' );
1022 
1023  $tempFile1 = fopen( $tempName1, "w" );
1024  if ( !$tempFile1 ) {
1025  return false;
1026  }
1027  $tempFile2 = fopen( $tempName2, "w" );
1028  if ( !$tempFile2 ) {
1029  return false;
1030  }
1031  fwrite( $tempFile1, $otext );
1032  fwrite( $tempFile2, $ntext );
1033  fclose( $tempFile1 );
1034  fclose( $tempFile2 );
1035  $cmd = [ $engine, $tempName1, $tempName2 ];
1036  $result = Shell::command( $cmd )
1037  ->execute();
1038  $exitCode = $result->getExitCode();
1039  if ( $exitCode !== 0 ) {
1040  throw new Exception( "External diff command returned code {$exitCode}. Stderr: "
1041  . wfEscapeWikiText( $result->getStderr() )
1042  );
1043  }
1044  $difftext = $result->getStdout();
1045  $difftext .= $this->debug( "external $engine" );
1046  unlink( $tempName1 );
1047  unlink( $tempName2 );
1048 
1049  return $difftext;
1050  }
1051 
1052  # Native PHP diff
1053  $ota = explode( "\n", $wgContLang->segmentForDiff( $otext ) );
1054  $nta = explode( "\n", $wgContLang->segmentForDiff( $ntext ) );
1055  $diffs = new Diff( $ota, $nta );
1056  $formatter = new TableDiffFormatter();
1057  $difftext = $wgContLang->unsegmentForDiff( $formatter->format( $diffs ) );
1058  $difftext .= $this->debug( 'native PHP' );
1059 
1060  return $difftext;
1061  }
1062 
1071  protected function debug( $generator = "internal" ) {
1073  if ( !$this->enableDebugComment ) {
1074  return '';
1075  }
1076  $data = [ $generator ];
1077  if ( $wgShowHostnames ) {
1078  $data[] = wfHostname();
1079  }
1080  $data[] = wfTimestamp( TS_DB );
1081 
1082  return "<!-- diff generator: " .
1083  implode( " ", array_map( "htmlspecialchars", $data ) ) .
1084  " -->\n";
1085  }
1086 
1093  private function localiseDiff( $text ) {
1094  $text = $this->localiseLineNumbers( $text );
1095  if ( $this->getEngine() === 'wikidiff2' &&
1096  version_compare( phpversion( 'wikidiff2' ), '1.5.1', '>=' )
1097  ) {
1098  $text = $this->addLocalisedTitleTooltips( $text );
1099  }
1100  return $text;
1101  }
1102 
1110  public function localiseLineNumbers( $text ) {
1111  return preg_replace_callback(
1112  '/<!--LINE (\d+)-->/',
1113  [ $this, 'localiseLineNumbersCb' ],
1114  $text
1115  );
1116  }
1117 
1118  public function localiseLineNumbersCb( $matches ) {
1119  if ( $matches[1] === '1' && $this->mReducedLineNumbers ) {
1120  return '';
1121  }
1122 
1123  return $this->msg( 'lineno' )->numParams( $matches[1] )->escaped();
1124  }
1125 
1132  private function addLocalisedTitleTooltips( $text ) {
1133  return preg_replace_callback(
1134  '/class="mw-diff-movedpara-(left|right)"/',
1135  [ $this, 'addLocalisedTitleTooltipsCb' ],
1136  $text
1137  );
1138  }
1139 
1145  $key = $matches[1] === 'right' ?
1146  'diff-paragraph-moved-toold' :
1147  'diff-paragraph-moved-tonew';
1148  return $matches[0] . ' title="' . $this->msg( $key )->escaped() . '"';
1149  }
1150 
1156  public function getMultiNotice() {
1157  if ( !is_object( $this->mOldRev ) || !is_object( $this->mNewRev ) ) {
1158  return '';
1159  } elseif ( !$this->mOldPage->equals( $this->mNewPage ) ) {
1160  // Comparing two different pages? Count would be meaningless.
1161  return '';
1162  }
1163 
1164  if ( $this->mOldRev->getTimestamp() > $this->mNewRev->getTimestamp() ) {
1165  $oldRev = $this->mNewRev; // flip
1166  $newRev = $this->mOldRev; // flip
1167  } else { // normal case
1168  $oldRev = $this->mOldRev;
1169  $newRev = $this->mNewRev;
1170  }
1171 
1172  // Sanity: don't show the notice if too many rows must be scanned
1173  // @todo show some special message for that case
1174  $nEdits = $this->mNewPage->countRevisionsBetween( $oldRev, $newRev, 1000 );
1175  if ( $nEdits > 0 && $nEdits <= 1000 ) {
1176  $limit = 100; // use diff-multi-manyusers if too many users
1177  $users = $this->mNewPage->getAuthorsBetween( $oldRev, $newRev, $limit );
1178  $numUsers = count( $users );
1179 
1180  if ( $numUsers == 1 && $users[0] == $newRev->getUserText( Revision::RAW ) ) {
1181  $numUsers = 0; // special case to say "by the same user" instead of "by one other user"
1182  }
1183 
1184  return self::intermediateEditsMsg( $nEdits, $numUsers, $limit );
1185  }
1186 
1187  return ''; // nothing
1188  }
1189 
1199  public static function intermediateEditsMsg( $numEdits, $numUsers, $limit ) {
1200  if ( $numUsers === 0 ) {
1201  $msg = 'diff-multi-sameuser';
1202  } elseif ( $numUsers > $limit ) {
1203  $msg = 'diff-multi-manyusers';
1204  $numUsers = $limit;
1205  } else {
1206  $msg = 'diff-multi-otherusers';
1207  }
1208 
1209  return wfMessage( $msg )->numParams( $numEdits, $numUsers )->parse();
1210  }
1211 
1221  public function getRevisionHeader( Revision $rev, $complete = '' ) {
1222  $lang = $this->getLanguage();
1223  $user = $this->getUser();
1224  $revtimestamp = $rev->getTimestamp();
1225  $timestamp = $lang->userTimeAndDate( $revtimestamp, $user );
1226  $dateofrev = $lang->userDate( $revtimestamp, $user );
1227  $timeofrev = $lang->userTime( $revtimestamp, $user );
1228 
1229  $header = $this->msg(
1230  $rev->isCurrent() ? 'currentrev-asof' : 'revisionasof',
1231  $timestamp,
1232  $dateofrev,
1233  $timeofrev
1234  )->escaped();
1235 
1236  if ( $complete !== 'complete' ) {
1237  return $header;
1238  }
1239 
1240  $title = $rev->getTitle();
1241 
1243  [ 'oldid' => $rev->getId() ] );
1244 
1245  if ( $rev->userCan( Revision::DELETED_TEXT, $user ) ) {
1246  $editQuery = [ 'action' => 'edit' ];
1247  if ( !$rev->isCurrent() ) {
1248  $editQuery['oldid'] = $rev->getId();
1249  }
1250 
1251  $key = $title->quickUserCan( 'edit', $user ) ? 'editold' : 'viewsourceold';
1252  $msg = $this->msg( $key )->escaped();
1253  $editLink = $this->msg( 'parentheses' )->rawParams(
1254  Linker::linkKnown( $title, $msg, [], $editQuery ) )->escaped();
1255  $header .= ' ' . Html::rawElement(
1256  'span',
1257  [ 'class' => 'mw-diff-edit' ],
1258  $editLink
1259  );
1260  if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
1262  'span',
1263  [ 'class' => 'history-deleted' ],
1264  $header
1265  );
1266  }
1267  } else {
1268  $header = Html::rawElement( 'span', [ 'class' => 'history-deleted' ], $header );
1269  }
1270 
1271  return $header;
1272  }
1273 
1286  public function addHeader( $diff, $otitle, $ntitle, $multi = '', $notice = '' ) {
1287  // shared.css sets diff in interface language/dir, but the actual content
1288  // is often in a different language, mostly the page content language/dir
1289  $header = Html::openElement( 'table', [
1290  'class' => [ 'diff', 'diff-contentalign-' . $this->getDiffLang()->alignStart() ],
1291  'data-mw' => 'interface',
1292  ] );
1293  $userLang = htmlspecialchars( $this->getLanguage()->getHtmlCode() );
1294 
1295  if ( !$diff && !$otitle ) {
1296  $header .= "
1297  <tr class=\"diff-title\" lang=\"{$userLang}\">
1298  <td class=\"diff-ntitle\">{$ntitle}</td>
1299  </tr>";
1300  $multiColspan = 1;
1301  } else {
1302  if ( $diff ) { // Safari/Chrome show broken output if cols not used
1303  $header .= "
1304  <col class=\"diff-marker\" />
1305  <col class=\"diff-content\" />
1306  <col class=\"diff-marker\" />
1307  <col class=\"diff-content\" />";
1308  $colspan = 2;
1309  $multiColspan = 4;
1310  } else {
1311  $colspan = 1;
1312  $multiColspan = 2;
1313  }
1314  if ( $otitle || $ntitle ) {
1315  $header .= "
1316  <tr class=\"diff-title\" lang=\"{$userLang}\">
1317  <td colspan=\"$colspan\" class=\"diff-otitle\">{$otitle}</td>
1318  <td colspan=\"$colspan\" class=\"diff-ntitle\">{$ntitle}</td>
1319  </tr>";
1320  }
1321  }
1322 
1323  if ( $multi != '' ) {
1324  $header .= "<tr><td colspan=\"{$multiColspan}\" " .
1325  "class=\"diff-multi\" lang=\"{$userLang}\">{$multi}</td></tr>";
1326  }
1327  if ( $notice != '' ) {
1328  $header .= "<tr><td colspan=\"{$multiColspan}\" " .
1329  "class=\"diff-notice\" lang=\"{$userLang}\">{$notice}</td></tr>";
1330  }
1331 
1332  return $header . $diff . "</table>";
1333  }
1334 
1341  public function setContent( Content $oldContent, Content $newContent ) {
1342  $this->mOldContent = $oldContent;
1343  $this->mNewContent = $newContent;
1344 
1345  $this->mTextLoaded = 2;
1346  $this->mRevisionsLoaded = true;
1347  }
1348 
1355  public function setTextLanguage( $lang ) {
1356  $this->mDiffLang = wfGetLangObj( $lang );
1357  }
1358 
1370  public function mapDiffPrevNext( $old, $new ) {
1371  if ( $new === 'prev' ) {
1372  // Show diff between revision $old and the previous one. Get previous one from DB.
1373  $newid = intval( $old );
1374  $oldid = $this->getTitle()->getPreviousRevisionID( $newid );
1375  } elseif ( $new === 'next' ) {
1376  // Show diff between revision $old and the next one. Get next one from DB.
1377  $oldid = intval( $old );
1378  $newid = $this->getTitle()->getNextRevisionID( $oldid );
1379  } else {
1380  $oldid = intval( $old );
1381  $newid = intval( $new );
1382  }
1383 
1384  return [ $oldid, $newid ];
1385  }
1386 
1390  private function loadRevisionIds() {
1391  if ( $this->mRevisionsIdsLoaded ) {
1392  return;
1393  }
1394 
1395  $this->mRevisionsIdsLoaded = true;
1396 
1397  $old = $this->mOldid;
1398  $new = $this->mNewid;
1399 
1400  list( $this->mOldid, $this->mNewid ) = self::mapDiffPrevNext( $old, $new );
1401  if ( $new === 'next' && $this->mNewid === false ) {
1402  # if no result, NewId points to the newest old revision. The only newer
1403  # revision is cur, which is "0".
1404  $this->mNewid = 0;
1405  }
1406 
1407  Hooks::run(
1408  'NewDifferenceEngine',
1409  [ $this->getTitle(), &$this->mOldid, &$this->mNewid, $old, $new ]
1410  );
1411  }
1412 
1425  public function loadRevisionData() {
1426  if ( $this->mRevisionsLoaded ) {
1427  return true;
1428  }
1429 
1430  // Whether it succeeds or fails, we don't want to try again
1431  $this->mRevisionsLoaded = true;
1432 
1433  $this->loadRevisionIds();
1434 
1435  // Load the new revision object
1436  if ( $this->mNewid ) {
1437  $this->mNewRev = Revision::newFromId( $this->mNewid );
1438  } else {
1439  $this->mNewRev = Revision::newFromTitle(
1440  $this->getTitle(),
1441  false,
1442  Revision::READ_NORMAL
1443  );
1444  }
1445 
1446  if ( !$this->mNewRev instanceof Revision ) {
1447  return false;
1448  }
1449 
1450  // Update the new revision ID in case it was 0 (makes life easier doing UI stuff)
1451  $this->mNewid = $this->mNewRev->getId();
1452  $this->mNewPage = $this->mNewRev->getTitle();
1453 
1454  // Load the old revision object
1455  $this->mOldRev = false;
1456  if ( $this->mOldid ) {
1457  $this->mOldRev = Revision::newFromId( $this->mOldid );
1458  } elseif ( $this->mOldid === 0 ) {
1459  $rev = $this->mNewRev->getPrevious();
1460  if ( $rev ) {
1461  $this->mOldid = $rev->getId();
1462  $this->mOldRev = $rev;
1463  } else {
1464  // No previous revision; mark to show as first-version only.
1465  $this->mOldid = false;
1466  $this->mOldRev = false;
1467  }
1468  } /* elseif ( $this->mOldid === false ) leave mOldRev false; */
1469 
1470  if ( is_null( $this->mOldRev ) ) {
1471  return false;
1472  }
1473 
1474  if ( $this->mOldRev ) {
1475  $this->mOldPage = $this->mOldRev->getTitle();
1476  }
1477 
1478  // Load tags information for both revisions
1479  $dbr = wfGetDB( DB_REPLICA );
1480  if ( $this->mOldid !== false ) {
1481  $this->mOldTags = $dbr->selectField(
1482  'tag_summary',
1483  'ts_tags',
1484  [ 'ts_rev_id' => $this->mOldid ],
1485  __METHOD__
1486  );
1487  } else {
1488  $this->mOldTags = false;
1489  }
1490  $this->mNewTags = $dbr->selectField(
1491  'tag_summary',
1492  'ts_tags',
1493  [ 'ts_rev_id' => $this->mNewid ],
1494  __METHOD__
1495  );
1496 
1497  return true;
1498  }
1499 
1505  public function loadText() {
1506  if ( $this->mTextLoaded == 2 ) {
1507  return true;
1508  }
1509 
1510  // Whether it succeeds or fails, we don't want to try again
1511  $this->mTextLoaded = 2;
1512 
1513  if ( !$this->loadRevisionData() ) {
1514  return false;
1515  }
1516 
1517  if ( $this->mOldRev ) {
1518  $this->mOldContent = $this->mOldRev->getContent( Revision::FOR_THIS_USER, $this->getUser() );
1519  if ( $this->mOldContent === null ) {
1520  return false;
1521  }
1522  }
1523 
1524  if ( $this->mNewRev ) {
1525  $this->mNewContent = $this->mNewRev->getContent( Revision::FOR_THIS_USER, $this->getUser() );
1526  Hooks::run( 'DifferenceEngineLoadTextAfterNewContentIsLoaded', [ $this ] );
1527  if ( $this->mNewContent === null ) {
1528  return false;
1529  }
1530  }
1531 
1532  return true;
1533  }
1534 
1540  public function loadNewText() {
1541  if ( $this->mTextLoaded >= 1 ) {
1542  return true;
1543  }
1544 
1545  $this->mTextLoaded = 1;
1546 
1547  if ( !$this->loadRevisionData() ) {
1548  return false;
1549  }
1550 
1551  $this->mNewContent = $this->mNewRev->getContent( Revision::FOR_THIS_USER, $this->getUser() );
1552 
1553  Hooks::run( 'DifferenceEngineAfterLoadNewText', [ $this ] );
1554 
1555  return true;
1556  }
1557 
1558 }
$time
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1795
Revision\newFromArchiveRow
static newFromArchiveRow( $row, $overrides=[])
Make a fake revision object from an archive table row.
Definition: Revision.php:167
DifferenceEngine\$mRevisionsIdsLoaded
bool $mRevisionsIdsLoaded
Have the revisions IDs been loaded.
Definition: DifferenceEngine.php:70
$user
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 account $user
Definition: hooks.txt:247
DifferenceEngine\revisionDeleteLink
revisionDeleteLink( $rev)
Definition: DifferenceEngine.php:588
ContextSource\$context
IContextSource $context
Definition: ContextSource.php:33
ContextSource\getConfig
getConfig()
Definition: ContextSource.php:63
MediaWiki\Shell\Shell
Executes shell commands.
Definition: Shell.php:44
Revision\DELETED_RESTRICTED
const DELETED_RESTRICTED
Definition: Revision.php:50
DifferenceEngine\markPatrolledLink
markPatrolledLink()
Build a link to mark a change as patrolled.
Definition: DifferenceEngine.php:494
ContextSource\getContext
getContext()
Get the base IContextSource object.
Definition: ContextSource.php:40
DifferenceEngine\$mTextLoaded
int $mTextLoaded
How many text blobs have been loaded, 0, 1 or 2?
Definition: DifferenceEngine.php:76
Content\serialize
serialize( $format=null)
Convenience method for serializing this Content object.
wfMergeErrorArrays
wfMergeErrorArrays()
Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.
Definition: GlobalFunctions.php:211
DifferenceEngine\addLocalisedTitleTooltipsCb
addLocalisedTitleTooltipsCb(array $matches)
Definition: DifferenceEngine.php:1144
DifferenceEngine\getDiffBodyCacheKeyParams
getDiffBodyCacheKeyParams()
Get the cache key parameters.
Definition: DifferenceEngine.php:834
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
Revision\newFromId
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Definition: Revision.php:114
DifferenceEngine\$mNewContent
Content $mNewContent
Definition: DifferenceEngine.php:52
DifferenceEngine\$mNewRev
Revision $mNewRev
Definition: DifferenceEngine.php:67
DifferenceEngine\$mOldPage
Title $mOldPage
Definition: DifferenceEngine.php:58
wfMessage
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 unset offset - wrap String Wrap the message in html(usually something like "&lt
DifferenceEngine\$unhide
bool $unhide
Show rev_deleted content if allowed.
Definition: DifferenceEngine.php:97
DifferenceEngine\$mOldTags
$mOldTags
Definition: DifferenceEngine.php:45
array
the array() calling protocol came about after MediaWiki 1.4rc1.
DifferenceEngine\setTextLanguage
setTextLanguage( $lang)
Set the language in which the diff text is written (Defaults to page content language).
Definition: DifferenceEngine.php:1355
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
RecentChange\newFromConds
static newFromConds( $conds, $fname=__METHOD__, $dbType=DB_REPLICA)
Find the first recent change matching some specific conditions.
Definition: RecentChange.php:194
DifferenceEngine\setReducedLineNumbers
setReducedLineNumbers( $value=true)
Definition: DifferenceEngine.php:130
ContextSource\msg
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
Definition: ContextSource.php:168
DifferenceEngine\setContent
setContent(Content $oldContent, Content $newContent)
Use specified text instead of loading from the database.
Definition: DifferenceEngine.php:1341
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1980
DifferenceEngine\getNewid
getNewid()
Definition: DifferenceEngine.php:165
DifferenceEngine\getOldid
getOldid()
Definition: DifferenceEngine.php:156
$wgShowHostnames
$wgShowHostnames
Expose backend server host names through the API and various HTML comments.
Definition: DefaultSettings.php:6330
DifferenceEngine\$mNewTags
$mNewTags
Definition: DifferenceEngine.php:46
$out
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:864
WikiPage
Class representing a MediaWiki article and history.
Definition: WikiPage.php:37
DifferenceEngine\$mRevisionsLoaded
bool $mRevisionsLoaded
Have the revisions been loaded.
Definition: DifferenceEngine.php:73
DifferenceEngine\deletedIdMarker
deletedIdMarker( $id)
Build a wikitext link toward a deleted revision, if viewable.
Definition: DifferenceEngine.php:212
$params
$params
Definition: styleTest.css.php:40
WikiPage\makeParserOptions
makeParserOptions( $context)
Get parser options suitable for rendering the primary article wikitext.
Definition: WikiPage.php:2000
wfHostname
wfHostname()
Fetch server name for use in error reporting etc.
Definition: GlobalFunctions.php:1420
Linker\linkKnown
static linkKnown( $target, $html=null, $customAttribs=[], $query=[], $options=[ 'known'])
Identical to link(), except $options defaults to 'known'.
Definition: Linker.php:164
DifferenceEngine\getEngine
getEngine()
Process $wgExternalDiffEngine and get a sane, usable engine.
Definition: DifferenceEngine.php:944
Revision\getArchiveQueryInfo
static getArchiveQueryInfo()
Return the tables, fields, and join conditions to be selected to create a new archived revision objec...
Definition: Revision.php:506
SpecialPage\getTitleFor
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
DifferenceEngine\addLocalisedTitleTooltips
addLocalisedTitleTooltips( $text)
Add title attributes for tooltips on moved paragraph indicators.
Definition: DifferenceEngine.php:1132
DifferenceEngine\$mNewPage
Title $mNewPage
Definition: DifferenceEngine.php:61
wfLogWarning
wfLogWarning( $msg, $callerOffset=1, $level=E_USER_WARNING)
Send a warning as a PHP error and the debug log.
Definition: GlobalFunctions.php:1150
Revision\isCurrent
isCurrent()
Definition: Revision.php:1015
TableDiffFormatter
MediaWiki default table style diff formatter.
Definition: TableDiffFormatter.php:33
ContextSource\getRequest
getRequest()
Definition: ContextSource.php:71
PermissionsError
Show an error when a user tries to do something they do not have the necessary permissions for.
Definition: PermissionsError.php:28
PoolCounterWorkViaCallback
Convenience class for dealing with PoolCounters using callbacks.
Definition: PoolCounterWorkViaCallback.php:28
DifferenceEngine\showDiffStyle
showDiffStyle()
Add style sheets for diff display.
Definition: DifferenceEngine.php:696
DifferenceEngine\loadNewText
loadNewText()
Load the text of the new revision, not the old one.
Definition: DifferenceEngine.php:1540
$result
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name '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:Array with elements of the form "language:title" in the order that they will be output. & $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:1993
ContextSource\getUser
getUser()
Definition: ContextSource.php:120
ContextSource\getTitle
getTitle()
Definition: ContextSource.php:79
$wgUseRCPatrol
$wgUseRCPatrol
Use RC Patrolling to check for vandalism (from recent changes and watchlists) New pages and new files...
Definition: DefaultSettings.php:6860
DifferenceEngine\showDiff
showDiff( $otitle, $ntitle, $notice='')
Get the diff text, send it to the OutputPage object Returns false if the diff could not be generated,...
Definition: DifferenceEngine.php:676
DifferenceEngine\getDiffBodyCacheKey
getDiffBodyCacheKey()
Returns the cache key for diff body text or content.
Definition: DifferenceEngine.php:817
DifferenceEngine\localiseDiff
localiseDiff( $text)
Localise diff output.
Definition: DifferenceEngine.php:1093
wfDebugLog
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
Definition: GlobalFunctions.php:1087
$newminor
also included in $newHeader if any $newminor
Definition: hooks.txt:1258
DifferenceEngine\$mOldid
int $mOldid
Definition: DifferenceEngine.php:40
php
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:37
DifferenceEngine\$mNewid
int $mNewid
Definition: DifferenceEngine.php:43
DifferenceEngine\generateTextDiffBody
generateTextDiffBody( $otext, $ntext)
Generate a diff, no caching.
Definition: DifferenceEngine.php:902
$dbr
$dbr
Definition: testCompression.php:50
ContextSource\getLanguage
getLanguage()
Definition: ContextSource.php:128
below
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
Revision\FOR_THIS_USER
const FOR_THIS_USER
Definition: Revision.php:56
Revision
Definition: Revision.php:41
DifferenceEngine\$mReducedLineNumbers
bool $mReducedLineNumbers
If true, line X is not displayed when X is 1, for example to increase readability and conserve space ...
Definition: DifferenceEngine.php:91
Revision\newFromTitle
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:133
DifferenceEngine\loadRevisionData
loadRevisionData()
Load revision metadata for the specified articles.
Definition: DifferenceEngine.php:1425
DifferenceEngine\localiseLineNumbersCb
localiseLineNumbersCb( $matches)
Definition: DifferenceEngine.php:1118
MWException
MediaWiki exception.
Definition: MWException.php:26
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:115
wfDeprecated
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Definition: GlobalFunctions.php:1123
Linker\generateRollback
static generateRollback( $rev, IContextSource $context=null, $options=[ 'verify'])
Generate a rollback link for a given revision.
Definition: Linker.php:1706
DifferenceEngine\wasCacheHit
wasCacheHit()
Definition: DifferenceEngine.php:149
wfIncrStats
wfIncrStats( $key, $count=1)
Increment a statistics counter.
Definition: GlobalFunctions.php:1252
DifferenceEngine\getDiffLang
getDiffLang()
Definition: DifferenceEngine.php:137
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
Linker\revUserTools
static revUserTools( $rev, $isPublic=false)
Generate a user tool link cluster if the current user is allowed to view it.
Definition: Linker.php:1070
WikiPage\getParserOutput
getParserOutput(ParserOptions $parserOptions, $oldid=null, $forceParse=false)
Get a ParserOutput for the given ParserOptions and revision ID.
Definition: WikiPage.php:1103
ContextSource\getOutput
getOutput()
Definition: ContextSource.php:112
$matches
$matches
Definition: NoLocalSettings.php:24
ContextSource
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and ...
Definition: ContextSource.php:29
ContextSource\getWikiPage
getWikiPage()
Get the WikiPage object.
Definition: ContextSource.php:104
DifferenceEngine\$mOldContent
Content $mOldContent
Definition: DifferenceEngine.php:49
DifferenceEngine\deletedLink
deletedLink( $id)
Look up a special:Undelete link to the given deleted revision id, as a workaround for being unable to...
Definition: DifferenceEngine.php:179
wfGetLangObj
wfGetLangObj( $langcode=false)
Return a Language object from $langcode.
Definition: GlobalFunctions.php:1306
ChangesList\flag
static flag( $flag, IContextSource $context=null)
Make an "<abbr>" element for a given change flag.
Definition: ChangesList.php:228
DifferenceEngine\getDiffBody
getDiffBody()
Get the diff table body, without header.
Definition: DifferenceEngine.php:731
DifferenceEngine\getRevisionHeader
getRevisionHeader(Revision $rev, $complete='')
Get a header for a specified revision.
Definition: DifferenceEngine.php:1221
$link
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3021
$generator
$generator
Definition: generateLocalAutoload.php:13
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
DifferenceEngine\loadText
loadText()
Load the text of the revisions, as well as revision data.
Definition: DifferenceEngine.php:1505
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:994
ContextSource\setContext
setContext(IContextSource $context)
Definition: ContextSource.php:55
list
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
DifferenceEngine\$mCacheHit
bool $mCacheHit
Was the diff fetched from cache?
Definition: DifferenceEngine.php:79
$wgExternalDiffEngine
$wgExternalDiffEngine
Name of the external diff engine to use.
Definition: DefaultSettings.php:8452
DifferenceEngine\$enableDebugComment
$enableDebugComment
Set this to true to add debug info to the HTML output.
Definition: DifferenceEngine.php:86
DifferenceEngine\__construct
__construct( $context=null, $old=0, $new=0, $rcid=0, $refreshCache=false, $unhide=false)
#-
Definition: DifferenceEngine.php:112
$oldminor
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:1260
Title\makeTitleSafe
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:562
Linker\revComment
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:1480
see
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:18
$value
$value
Definition: styleTest.css.php:45
$header
$header
Definition: updateCredits.php:35
Linker\getRevDeleteLink
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:2053
wikidiff2_do_diff
wikidiff2_do_diff( $text1, $text2, $numContextLines, $movedParagraphDetectionCutoff=0)
This program is free software; you can redistribute it and/or modify it under the terms of the GNU Ge...
Definition: wikidiff.php:28
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1643
$engine
the value to return A Title object or null for latest all implement SearchIndexField $engine
Definition: hooks.txt:2881
Revision\RAW
const RAW
Definition: Revision.php:57
$status
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, 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. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1255
DifferenceEngine\showDiffPage
showDiffPage( $diffOnly=false)
Definition: DifferenceEngine.php:244
$refreshCache
null for the 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 as strings Extensions should add to this list prev or next $refreshCache
Definition: hooks.txt:1632
$suppressed
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:2188
TextContent
Content object implementation for representing flat text.
Definition: TextContent.php:35
Linker\titleAttrib
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:1969
DifferenceEngine\DIFF_VERSION
const DIFF_VERSION
Constant to indicate diff cache compatibility.
Definition: DifferenceEngine.php:37
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:53
DifferenceEngine\intermediateEditsMsg
static intermediateEditsMsg( $numEdits, $numUsers, $limit)
Get a notice about how many intermediate edits and users there are.
Definition: DifferenceEngine.php:1199
DifferenceEngine\showMissingRevision
showMissingRevision()
Definition: DifferenceEngine.php:221
Content
Base interface for content objects.
Definition: Content.php:34
DifferenceEngine\$mOldRev
Revision $mOldRev
Definition: DifferenceEngine.php:64
DifferenceEngine\loadRevisionIds
loadRevisionIds()
Load revision IDs.
Definition: DifferenceEngine.php:1390
DifferenceEngine\getParserOutput
getParserOutput(WikiPage $page, Revision $rev)
Definition: DifferenceEngine.php:659
$rev
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:1777
Title
Represents a title within MediaWiki.
Definition: Title.php:39
wfTempDir
wfTempDir()
Tries to get the system directory for temporary files.
Definition: GlobalFunctions.php:2057
$cache
$cache
Definition: mcc.php:33
DifferenceEngine\$mDiffLang
Language $mDiffLang
Definition: DifferenceEngine.php:55
ObjectCache\getMainWANInstance
static getMainWANInstance()
Get the main WAN cache object.
Definition: ObjectCache.php:380
DifferenceEngine\getMarkPatrolledLinkInfo
getMarkPatrolledLinkInfo()
Returns an array of meta data needed to build a "mark as patrolled" link and adds the mediawiki....
Definition: DifferenceEngine.php:526
$wgEnableWriteAPI
$wgEnableWriteAPI
Allow the API to be used to perform write operations (page edits, rollback, etc.) when an authorised ...
Definition: DefaultSettings.php:8047
FatalError
Exception class which takes an HTML error message, and does not produce a backtrace.
Definition: FatalError.php:28
RecentChange\PRC_UNPATROLLED
const PRC_UNPATROLLED
Definition: RecentChange.php:77
as
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:22
Html\openElement
static openElement( $element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
Definition: Html.php:251
Html\rawElement
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
DifferenceEngine
Definition: DifferenceEngine.php:30
RecentChange\isInRCLifespan
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...
Definition: RecentChange.php:1153
DifferenceEngine\$mMarkPatrolledLink
string $mMarkPatrolledLink
Link to action=markpatrolled.
Definition: DifferenceEngine.php:94
DifferenceEngine\localiseLineNumbers
localiseLineNumbers( $text)
Replace line numbers with the text in the user's language.
Definition: DifferenceEngine.php:1110
wfWarn
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
Definition: GlobalFunctions.php:1137
DifferenceEngine\debug
debug( $generator="internal")
Generate a debug comment indicating diff generating time, server node, and generator backend.
Definition: DifferenceEngine.php:1071
DifferenceEngine\renderNewRevision
renderNewRevision()
Show the new revision of the page.
Definition: DifferenceEngine.php:600
Html\element
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
MediaWikiServices
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 MediaWikiServices
Definition: injection.txt:25
$wgEnableAPI
$wgEnableAPI
Enable the MediaWiki API for convenient access to machine-readable data via api.php.
Definition: DefaultSettings.php:8038
DifferenceEngine\getDiff
getDiff( $otitle, $ntitle, $notice='')
Get complete diff table, including header.
Definition: DifferenceEngine.php:709
$query
null for the 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:1620
DifferenceEngine\generateContentDiffBody
generateContentDiffBody(Content $old, Content $new)
Generate a diff, no caching.
Definition: DifferenceEngine.php:875
DifferenceEngine\mapDiffPrevNext
mapDiffPrevNext( $old, $new)
Maps a revision pair definition as accepted by DifferenceEngine constructor to a pair of actual integ...
Definition: DifferenceEngine.php:1370
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
DifferenceEngine\addHeader
addHeader( $diff, $otitle, $ntitle, $multi='', $notice='')
Add the header to a diff body.
Definition: DifferenceEngine.php:1286
ChangeTags\formatSummaryRow
static formatSummaryRow( $tags, $page, IContextSource $context=null)
Creates HTML for the given tags.
Definition: ChangeTags.php:88
Revision\DELETED_TEXT
const DELETED_TEXT
Definition: Revision.php:47
Language
Internationalisation code.
Definition: Language.php:35
DifferenceEngine\textDiff
textDiff( $otext, $ntext)
Generates diff, to be wrapped internally in a logging/instrumentation.
Definition: DifferenceEngine.php:977
$rollback
also included in $newHeader $rollback
Definition: hooks.txt:1256
$wgContLang
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 content language as $wgContLang
Definition: design.txt:57
Diff
Class representing a 'diff' between two sequences of strings.
Definition: DairikiDiff.php:200
DifferenceEngine\$mRefreshCache
bool $mRefreshCache
Refresh the diff cache.
Definition: DifferenceEngine.php:100
DifferenceEngine\getMultiNotice
getMultiNotice()
If there are revisions between the ones being compared, return a note saying so.
Definition: DifferenceEngine.php:1156