Go to the documentation of this file.
26 define(
'MW_DIFF_VERSION',
'1.11a' );
122 wfDebug(
"DifferenceEngine old '$old' new '$new' rcid '$rcid'\n" );
124 $this->mOldid = $old;
125 $this->mNewid = $new;
134 $this->mReducedLineNumbers =
$value;
141 if ( $this->mDiffLang ===
null ) {
142 # Default language in which the diff text is written.
143 $this->mDiffLang = $this->
getTitle()->getPageLanguage();
183 if ( $this->
getUser()->isAllowed(
'deletedhistory' ) ) {
185 $row =
$dbr->selectRow(
'archive',
'*',
186 [
'ar_rev_id' => $id ],
193 'target' =>
$title->getPrefixedText(),
194 'timestamp' =>
$rev->getTimestamp()
212 return "[$link $id]";
222 if ( $this->mOldRev ===
null ||
223 ( $this->mOldRev && $this->mOldContent ===
null )
227 if ( $this->mNewRev ===
null ||
228 ( $this->mNewRev && $this->mNewContent ===
null )
233 $out->setPageTitle( $this->
msg(
'errorpagetitle' ) );
234 $msg = $this->
msg(
'difference-missing-revision' )
235 ->params( $this->
getLanguage()->listToText( $missing ) )
236 ->numParams(
count( $missing ) )
238 $out->addHTML( $msg );
242 # Allow frames except in certain special cases
244 $out->allowClickjacking();
245 $out->setRobotPolicy(
'noindex,nofollow' );
251 if (
Hooks::run(
'DifferenceEngineShowDiffPageMaybeShowMissingRevision', [ $this ] ) ) {
258 $permErrors = $this->mNewPage->getUserPermissionsErrors(
'read',
$user );
259 if ( $this->mOldPage ) { # mOldPage might
not be
set,
see below.
261 $this->mOldPage->getUserPermissionsErrors(
'read',
$user ) );
263 if (
count( $permErrors ) ) {
270 # Carry over 'diffonly' param via navigation links
271 if ( $diffOnly !=
$user->getBoolOption(
'diffonly' ) ) {
272 $query[
'diffonly'] = $diffOnly;
274 # Cascade unhide param in links for easy deletion browsing
275 if ( $this->unhide ) {
279 # Check if one of the revisions is deleted/suppressed
285 # mOldRev is false if the difference engine is called with a "vague" query for
286 # a diff between a version V and its previous version V' AND the version V
287 # is the first version of that article. In that case, V' does not exist.
288 if ( $this->mOldRev ===
false ) {
289 $out->setPageTitle( $this->
msg(
'difference-title', $this->mNewPage->getPrefixedText() ) );
293 Hooks::run(
'DifferenceEngineOldHeaderNoOldRev', [ &$oldHeader ] );
295 Hooks::run(
'DiffViewHeader', [ $this, $this->mOldRev, $this->mNewRev ] );
297 if ( $this->mNewPage->equals( $this->mOldPage ) ) {
298 $out->setPageTitle( $this->
msg(
'difference-title', $this->mNewPage->getPrefixedText() ) );
301 $out->setPageTitle( $this->
msg(
'difference-title-multipage',
302 $this->mOldPage->getPrefixedText(), $this->mNewPage->getPrefixedText() ) );
303 $out->addSubtitle( $this->
msg(
'difference-multipage' ) );
307 if ( $samePage && $this->mNewPage->quickUserCan(
'edit',
$user ) ) {
308 if ( $this->mNewRev->isCurrent() && $this->mNewPage->userCan(
'rollback',
$user ) ) {
310 if ( $rollbackLink ) {
311 $out->preventClickjacking();
312 $rollback =
'   ' . $rollbackLink;
320 'href' => $this->mNewPage->getLocalURL( [
322 'undoafter' => $this->mOldid,
323 'undo' => $this->mNewid
327 $this->
msg(
'editundo' )->text()
329 $revisionTools[
'mw-diff-undo'] = $undoLink;
333 # Make "previous revision link"
334 if ( $samePage && $this->mOldRev->getPrevious() ) {
337 $this->
msg(
'previousdiff' )->escaped(),
338 [
'id' =>
'differences-prevlink' ],
339 [
'diff' =>
'prev',
'oldid' => $this->mOldid ] +
$query
342 $prevlink =
' ';
345 if ( $this->mOldRev->isMinor() ) {
355 $oldHeader =
'<div id="mw-diff-otitle1"><strong>' . $oldRevisionHeader .
'</strong></div>' .
356 '<div id="mw-diff-otitle2">' .
358 '<div id="mw-diff-otitle3">' .
$oldminor .
360 '<div id="mw-diff-otitle5">' . $oldChangeTags[0] .
'</div>' .
361 '<div id="mw-diff-otitle4">' . $prevlink .
'</div>';
365 $diffOnly, $ldel, $this->unhide ] );
374 # Check if this user can see the revisions
380 # Make "next revision link"
381 # Skip next link on the top revision
382 if ( $samePage && !$this->mNewRev->isCurrent() ) {
385 $this->
msg(
'nextdiff' )->escaped(),
386 [
'id' =>
'differences-nextlink' ],
387 [
'diff' =>
'next',
'oldid' => $this->mNewid ] +
$query
390 $nextlink =
' ';
393 if ( $this->mNewRev->isMinor() ) {
399 # Handle RevisionDelete links...
402 # Allow extensions to define their own revision tools
404 [ $this->mNewRev, &$revisionTools, $this->mOldRev,
$user ] );
405 $formattedRevisionTools = [];
407 foreach ( $revisionTools
as $key => $tool ) {
408 $toolClass = is_string( $key ) ? $key :
'mw-diff-tool';
411 [
'class' => $toolClass ],
412 $this->
msg(
'parentheses' )->rawParams( $tool )->escaped()
414 $formattedRevisionTools[] = $element;
417 ' ' . implode(
' ', $formattedRevisionTools );
420 $newHeader =
'<div id="mw-diff-ntitle1"><strong>' . $newRevisionHeader .
'</strong></div>' .
423 '<div id="mw-diff-ntitle3">' .
$newminor .
425 '<div id="mw-diff-ntitle5">' . $newChangeTags[0] .
'</div>' .
426 '<div id="mw-diff-ntitle4">' . $nextlink . $this->
markPatrolledLink() .
'</div>';
429 Hooks::run(
'DifferenceEngineNewHeader', [ $this, &$newHeader, $formattedRevisionTools,
439 # If the diff cannot be shown due to a deleted revision, then output
440 # the diff header and links to unhide (if available)...
441 if ( $deleted && ( !$this->unhide || !$allowed ) ) {
444 $out->addHTML( $this->
addHeader(
'', $oldHeader, $newHeader, $multi ) );
446 $msg =
$suppressed ?
'rev-suppressed-no-diff' :
'rev-deleted-no-diff';
447 # Give explanation for why revision is not visible
448 $out->wrapWikiMsg(
"<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
451 # Give explanation and add a link to view the diff...
454 $msg =
$suppressed ?
'rev-suppressed-unhide-diff' :
'rev-deleted-unhide-diff';
456 "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
460 # Otherwise, output a regular diff...
462 # Add deletion notice if the user is viewing deleted content
465 $msg =
$suppressed ?
'rev-suppressed-diff-view' :
'rev-deleted-diff-view';
466 $notice =
"<div id='mw-$msg' class='mw-warning plainlinks'>\n" .
467 $this->
msg( $msg )->parse() .
470 $this->
showDiff( $oldHeader, $newHeader, $notice );
487 if ( $this->mMarkPatrolledLink ===
null ) {
491 $this->mMarkPatrolledLink =
'';
493 $this->mMarkPatrolledLink =
' <span class="patrollink" data-mw="interface">[' .
496 $this->
msg(
'markaspatrolleddiff' )->escaped(),
499 'action' =>
'markpatrolled',
500 'rcid' => $linkInfo[
'rcid'],
504 Hooks::run(
'DifferenceEngineMarkPatrolledLink', [ $this,
505 &$this->mMarkPatrolledLink, $linkInfo[
'rcid'] ] );
519 global $wgUseRCPatrol, $wgEnableAPI, $wgEnableWriteAPI;
526 $wgUseRCPatrol && $this->mNewPage->quickUserCan(
'patrol',
$user ) &&
535 'rc_timestamp' => $db->timestamp( $this->mNewRev->getTimestamp() ),
536 'rc_this_oldid' => $this->mNewid,
542 if ( $change && !$change->getPerformer()->equals(
$user ) ) {
543 $rcid = $change->getAttribute(
'rc_id' );
554 Hooks::run(
'DifferenceEngineMarkPatrolledRCID', [ &$rcid, $this, $change,
$user ] );
558 $this->
getOutput()->preventClickjacking();
559 if ( $wgEnableAPI && $wgEnableWriteAPI
560 &&
$user->isAllowed(
'writeapi' )
562 $this->
getOutput()->addModules(
'mediawiki.page.patrol.ajax' );
582 if (
$link !==
'' ) {
595 # Add "current version as of X" title
596 $out->addHTML(
"<hr class='diff-hr' id='mw-oldid' />
597 <h2 class='diff-currentversion-title'>{$revHeader}</h2>\n" );
598 # Page content may be handled by a hooked call instead...
599 # @codingStandardsIgnoreStart Ignoring long lines.
602 $out->setRevisionId( $this->mNewid );
603 $out->setRevisionTimestamp( $this->mNewRev->getTimestamp() );
604 $out->setArticleFlag(
true );
606 if ( !
Hooks::run(
'ArticleContentViewCustom', [ $this->mNewContent, $this->mNewPage,
$out ] ) ) {
610 if ( $this->
getTitle()->equals( $this->mNewPage ) ) {
622 # WikiPage::getParserOutput() should not return false, but just in case
631 # @codingStandardsIgnoreEnd
634 if (
Hooks::run(
'DifferenceEngineRenderRevisionShowFinalPatrolLink' ) ) {
635 # Add redundant patrol link on bottom...
644 $parserOptions->setEditSection(
false );
662 public function showDiff( $otitle, $ntitle, $notice =
'' ) {
664 Hooks::run(
'DifferenceEngineShowDiff', [ $this ] );
666 $diff = $this->
getDiff( $otitle, $ntitle, $notice );
667 if ( $diff ===
false ) {
683 $this->
getOutput()->addModuleStyles(
'mediawiki.diff.styles' );
695 public function getDiff( $otitle, $ntitle, $notice =
'' ) {
697 if ( $body ===
false ) {
703 if ( $body ===
'' ) {
704 $notice .=
'<div class="mw-diff-empty">' .
705 $this->
msg(
'diff-empty' )->parse() .
709 return $this->
addHeader( $body, $otitle, $ntitle, $multi, $notice );
718 $this->mCacheHit =
true;
722 } elseif ( $this->mOldRev &&
726 } elseif ( $this->mNewRev &&
732 if ( $this->mOldRev ===
false || ( $this->mOldRev && $this->mNewRev
733 && $this->mOldRev->getId() == $this->mNewRev->getId() )
735 if (
Hooks::run(
'DifferenceEngineShowEmptyOldContent', [ $this ] ) ) {
742 if ( $this->mOldid && $this->mNewid ) {
746 if ( !$this->mRefreshCache ) {
747 $difftext =
$cache->get( $key );
751 $difftext .=
"\n<!-- diff cache key $key -->\n";
757 $this->mCacheHit =
false;
770 if ( !
Hooks::run(
'AbortDiffCache', [ &$diffEngine ] ) ) {
772 } elseif ( $key !==
false && $difftext !==
false ) {
774 $cache->set( $key, $difftext, 7 * 86400 );
779 if ( $difftext !==
false ) {
795 if ( !$this->mOldid || !$this->mNewid ) {
796 throw new MWException(
'mOldid and mNewid must be set to get diff cache key.' );
799 return wfMemcKey(
'diff',
'version', self::DIFF_VERSION,
800 'oldid', $this->mOldid,
'newid', $this->mNewid );
824 throw new MWException(
"Diff not implemented for " . get_class( $old ) .
"; " .
825 "override generateContentDiffBody to fix this." );
829 throw new MWException(
"Diff not implemented for " . get_class( $new ) .
"; "
830 .
"override generateContentDiffBody to fix this." );
850 $diff =
function()
use ( $otext, $ntext ) {
851 $time = microtime(
true );
855 $time = intval( ( microtime(
true ) -
$time ) * 1000 );
856 MediaWikiServices::getInstance()->getStatsdDataFactory()->timing(
'diff_time',
$time );
858 if (
$time > 100 && $this->mOldPage && $this->mNewPage ) {
860 "$time ms diff: {$this->mOldid} -> {$this->mNewid} {$this->mNewPage}" );
875 if ( strlen( $otext ) + strlen( $ntext ) > 20000 ) {
877 md5( $otext ) . md5( $ntext ),
878 [
'doWork' => $diff,
'error' => $error ]
880 return $work->execute();
896 $otext = str_replace(
"\r\n",
"\n", $otext );
897 $ntext = str_replace(
"\r\n",
"\n", $ntext );
899 if ( $wgExternalDiffEngine ==
'wikidiff' || $wgExternalDiffEngine ==
'wikidiff3' ) {
900 wfDeprecated(
"\$wgExternalDiffEngine = '{$wgExternalDiffEngine}'",
'1.27' );
901 $wgExternalDiffEngine =
false;
902 } elseif ( $wgExternalDiffEngine ==
'wikidiff2' ) {
904 $wgExternalDiffEngine =
false;
905 } elseif ( !is_string( $wgExternalDiffEngine ) && $wgExternalDiffEngine !==
false ) {
907 wfWarn(
'$wgExternalDiffEngine is set to a non-string value, forcing it to false' );
908 $wgExternalDiffEngine =
false;
911 if ( function_exists(
'wikidiff2_do_diff' ) && $wgExternalDiffEngine ===
false ) {
912 # Better external diff engine, the 2 may some day be dropped
913 # This one does the escaping and segmenting itself
915 $text .= $this->
debug(
'wikidiff2' );
918 } elseif ( $wgExternalDiffEngine !==
false && is_executable( $wgExternalDiffEngine ) ) {
921 $tempName1 = tempnam( $tmpDir,
'diff_' );
922 $tempName2 = tempnam( $tmpDir,
'diff_' );
924 $tempFile1 = fopen( $tempName1,
"w" );
928 $tempFile2 = fopen( $tempName2,
"w" );
932 fwrite( $tempFile1, $otext );
933 fwrite( $tempFile2, $ntext );
934 fclose( $tempFile1 );
935 fclose( $tempFile2 );
938 $difftext .= $this->
debug(
"external $wgExternalDiffEngine" );
939 unlink( $tempName1 );
940 unlink( $tempName2 );
946 $ota = explode(
"\n",
$wgContLang->segmentForDiff( $otext ) );
947 $nta = explode(
"\n",
$wgContLang->segmentForDiff( $ntext ) );
948 $diffs =
new Diff( $ota, $nta );
950 $difftext =
$wgContLang->unsegmentForDiff( $formatter->format( $diffs ) );
965 if ( !$this->enableDebugComment ) {
969 if ( $wgShowHostnames ) {
974 return "<!-- diff generator: " .
975 implode(
" ", array_map(
"htmlspecialchars", $data ) ) .
987 return preg_replace_callback(
988 '/<!--LINE (\d+)-->/',
989 [ $this,
'localiseLineNumbersCb' ],
995 if (
$matches[1] ===
'1' && $this->mReducedLineNumbers ) {
999 return $this->
msg(
'lineno' )->numParams(
$matches[1] )->escaped();
1008 if ( !is_object( $this->mOldRev ) || !is_object( $this->mNewRev ) ) {
1010 } elseif ( !$this->mOldPage->equals( $this->mNewPage ) ) {
1015 if ( $this->mOldRev->getTimestamp() > $this->mNewRev->getTimestamp() ) {
1025 $nEdits = $this->mNewPage->countRevisionsBetween( $oldRev, $newRev, 1000 );
1026 if ( $nEdits > 0 && $nEdits <= 1000 ) {
1028 $users = $this->mNewPage->getAuthorsBetween( $oldRev, $newRev,
$limit );
1029 $numUsers =
count( $users );
1031 if ( $numUsers == 1 && $users[0] == $newRev->getUserText(
Revision::RAW ) ) {
1051 if ( $numUsers === 0 ) {
1052 $msg =
'diff-multi-sameuser';
1053 } elseif ( $numUsers >
$limit ) {
1054 $msg =
'diff-multi-manyusers';
1057 $msg =
'diff-multi-otherusers';
1060 return wfMessage( $msg )->numParams( $numEdits, $numUsers )->parse();
1075 $revtimestamp =
$rev->getTimestamp();
1076 $timestamp =
$lang->userTimeAndDate( $revtimestamp,
$user );
1077 $dateofrev =
$lang->userDate( $revtimestamp,
$user );
1078 $timeofrev =
$lang->userTime( $revtimestamp,
$user );
1081 $rev->
isCurrent() ?
'currentrev-asof' :
'revisionasof',
1087 if ( $complete !==
'complete' ) {
1094 [
'oldid' =>
$rev->getId() ] );
1097 $editQuery = [
'action' =>
'edit' ];
1098 if ( !
$rev->isCurrent() ) {
1099 $editQuery[
'oldid'] =
$rev->getId();
1102 $key =
$title->quickUserCan(
'edit',
$user ) ?
'editold' :
'viewsourceold';
1103 $msg = $this->
msg( $key )->escaped();
1104 $editLink = $this->
msg(
'parentheses' )->rawParams(
1108 [
'class' =>
'mw-diff-edit' ],
1114 [
'class' =>
'history-deleted' ],
1137 public function addHeader( $diff, $otitle, $ntitle, $multi =
'', $notice =
'' ) {
1141 'class' => [
'diff',
'diff-contentalign-' . $this->
getDiffLang()->alignStart() ],
1142 'data-mw' =>
'interface',
1144 $userLang = htmlspecialchars( $this->
getLanguage()->getHtmlCode() );
1146 if ( !$diff && !$otitle ) {
1148 <tr style='vertical-align: top;' lang='{$userLang}'>
1149 <td class='diff-ntitle'>{$ntitle}</td>
1155 <col class='diff-marker' />
1156 <col class='diff-content' />
1157 <col class='diff-marker' />
1158 <col class='diff-content' />";
1165 if ( $otitle || $ntitle ) {
1167 <tr style='vertical-align: top;' lang='{$userLang}'>
1168 <td colspan='$colspan' class='diff-otitle'>{$otitle}</td>
1169 <td colspan='$colspan' class='diff-ntitle'>{$ntitle}</td>
1174 if ( $multi !=
'' ) {
1175 $header .=
"<tr><td colspan='{$multiColspan}' style='text-align: center;' " .
1176 "class='diff-multi' lang='{$userLang}'>{$multi}</td></tr>";
1178 if ( $notice !=
'' ) {
1179 $header .=
"<tr><td colspan='{$multiColspan}' style='text-align: center;' " .
1180 "lang='{$userLang}'>{$notice}</td></tr>";
1183 return $header . $diff .
"</table>";
1193 $this->mOldContent = $oldContent;
1194 $this->mNewContent = $newContent;
1196 $this->mTextLoaded = 2;
1197 $this->mRevisionsLoaded =
true;
1222 if ( $new ===
'prev' ) {
1224 $newid = intval( $old );
1225 $oldid = $this->
getTitle()->getPreviousRevisionID( $newid );
1226 } elseif ( $new ===
'next' ) {
1228 $oldid = intval( $old );
1229 $newid = $this->
getTitle()->getNextRevisionID( $oldid );
1231 $oldid = intval( $old );
1232 $newid = intval( $new );
1235 return [ $oldid, $newid ];
1242 if ( $this->mRevisionsIdsLoaded ) {
1246 $this->mRevisionsIdsLoaded =
true;
1252 if ( $new ===
'next' && $this->mNewid ===
false ) {
1253 # if no result, NewId points to the newest old revision. The only newer
1254 # revision is cur, which is "0".
1259 'NewDifferenceEngine',
1260 [ $this->
getTitle(), &$this->mOldid, &$this->mNewid, $old, $new ]
1277 if ( $this->mRevisionsLoaded ) {
1282 $this->mRevisionsLoaded =
true;
1287 if ( $this->mNewid ) {
1293 Revision::READ_NORMAL
1297 if ( !$this->mNewRev instanceof
Revision ) {
1302 $this->mNewid = $this->mNewRev->getId();
1303 $this->mNewPage = $this->mNewRev->getTitle();
1306 $this->mOldRev =
false;
1307 if ( $this->mOldid ) {
1309 } elseif ( $this->mOldid === 0 ) {
1310 $rev = $this->mNewRev->getPrevious();
1312 $this->mOldid =
$rev->getId();
1313 $this->mOldRev =
$rev;
1316 $this->mOldid =
false;
1317 $this->mOldRev =
false;
1321 if ( is_null( $this->mOldRev ) ) {
1325 if ( $this->mOldRev ) {
1326 $this->mOldPage = $this->mOldRev->getTitle();
1331 if ( $this->mOldid !==
false ) {
1332 $this->mOldTags =
$dbr->selectField(
1335 [
'ts_rev_id' => $this->mOldid ],
1339 $this->mOldTags =
false;
1341 $this->mNewTags =
$dbr->selectField(
1344 [
'ts_rev_id' => $this->mNewid ],
1357 if ( $this->mTextLoaded == 2 ) {
1362 $this->mTextLoaded = 2;
1368 if ( $this->mOldRev ) {
1370 if ( $this->mOldContent ===
null ) {
1375 if ( $this->mNewRev ) {
1377 Hooks::run(
'DifferenceEngineLoadTextAfterNewContentIsLoaded', [ $this ] );
1378 if ( $this->mNewContent ===
null ) {
1392 if ( $this->mTextLoaded >= 1 ) {
1396 $this->mTextLoaded = 1;
1404 Hooks::run(
'DifferenceEngineAfterLoadNewText', [ $this ] );
static newFromArchiveRow( $row, $overrides=[])
Make a fake revision object from an archive table row.
bool $mRevisionsIdsLoaded
Have the revisions IDs been loaded.
revisionDeleteLink( $rev)
markPatrolledLink()
Build a link to mark a change as patrolled.
getContext()
Get the base IContextSource object.
int $mTextLoaded
How many text blobs have been loaded, 0, 1 or 2?
serialize( $format=null)
Convenience method for serializing this Content object.
wfMergeErrorArrays()
Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
msg()
Get a Message object with context set Parameters are the same as wfMessage()
bool $unhide
Show rev_deleted content if allowed.
setTextLanguage( $lang)
Set the language in which the diff text is written (Defaults to page content language).
if(!isset( $args[0])) $lang
static newFromConds( $conds, $fname=__METHOD__, $dbType=DB_REPLICA)
Find the first recent change matching some specific conditions.
setReducedLineNumbers( $value=true)
setContent(Content $oldContent, Content $newContent)
Use specified text instead of loading from the database.
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: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
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
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
Class representing a MediaWiki article and history.
bool $mRevisionsLoaded
Have the revisions been loaded.
deletedIdMarker( $id)
Build a wikitext link toward a deleted revision, if viewable.
wfHostname()
Fetch server name for use in error reporting etc.
static linkKnown( $target, $html=null, $customAttribs=[], $query=[], $options=[ 'known'])
Identical to link(), except $options defaults to 'known'.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 please use GetContentModels hook to make them known to core 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' also included in $newHeader $rollback
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,...
getRequest()
Get the WebRequest object.
Show an error when a user tries to do something they do not have the necessary permissions for.
Convenience class for dealing with PoolCounters using callbacks.
showDiffStyle()
Add style sheets for diff display.
loadNewText()
Load the text of the new revision, not the old one.
getUser()
Get the User object.
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,...
getDiffBodyCacheKey()
Returns the cache key for diff body text or content.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
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
generateTextDiffBody( $otext, $ntext)
Generate a diff, no caching.
getLanguage()
Get the Language object.
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
bool $mReducedLineNumbers
If true, line X is not displayed when X is 1, for example to increase readability and conserve space ...
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that's attached to a given link target.
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
loadRevisionData()
Load revision metadata for the specified articles.
localiseLineNumbersCb( $matches)
wfMemcKey()
Make a cache key for the local wiki.
namespace and then decline to actually register it file or subcat img or subcat $title
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
static generateRollback( $rev, IContextSource $context=null, $options=[ 'verify'])
Generate a rollback link for a given revision.
wfIncrStats( $key, $count=1)
Increment a statistics counter.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
static revUserTools( $rev, $isPublic=false)
Generate a user tool link cluster if the current user is allowed to view it.
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
getOutput()
Get the OutputPage object.
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and ...
getWikiPage()
Get the WikiPage object.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 please use GetContentModels hook to make them known to core 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
deletedLink( $id)
Look up a special:Undelete link to the given deleted revision id, as a workaround for being unable to...
wfGetLangObj( $langcode=false)
Return a Language object from $langcode.
static flag( $flag, IContextSource $context=null)
Make an "<abbr>" element for a given change flag.
getDiffBody()
Get the diff table body, without header.
getRevisionHeader(Revision $rev, $complete='')
Get a header for a specified revision.
see documentation in includes Linker php for Linker::makeImageLink & $time
when a variable name is used in a it is silently declared as a new masking the global
loadText()
Load the text of the revisions, as well as revision data.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
setContext(IContextSource $context)
Set the IContextSource 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
bool $mCacheHit
Was the diff fetched from cache?
$enableDebugComment
Set this to true to add debug info to the HTML output.
__construct( $context=null, $old=0, $new=0, $rcid=0, $refreshCache=false, $unhide=false)
#-
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
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.
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
static getRevDeleteLink(User $user, Revision $rev, Title $title)
Get a revision-deletion link, or disabled link, or nothing, depending on user permissions & the setti...
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging a wrapping ErrorException $suppressed
wfEscapeShellArg()
Version of escapeshellarg() that works better on Windows.
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
showDiffPage( $diffOnly=false)
Content object implementation for representing flat text.
static titleAttrib( $name, $options=null, array $msgParams=[])
Given the id of an interface element, constructs the appropriate title attribute from the system mess...
const DIFF_VERSION
Constant to indicate diff cache compatibility.
Interface for objects which can provide a MediaWiki context on request.
static intermediateEditsMsg( $numEdits, $numUsers, $limit)
Get a notice about how many intermediate edits and users there are.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 please use GetContentModels hook to make them known to core 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' also included in $newHeader if any $newminor
Base interface for content objects.
loadRevisionIds()
Load revision IDs.
getParserOutput(WikiPage $page, Revision $rev)
Represents a title within MediaWiki.
wfTempDir()
Tries to get the system directory for temporary files.
static getMainWANInstance()
Get the main WAN cache object.
getMarkPatrolledLinkInfo()
Returns an array of meta data needed to build a "mark as patrolled" link and adds the mediawiki....
Exception class which takes an HTML error message, and does not produce a backtrace.
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
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
static openElement( $element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
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...
usually copyright or history_copyright This message must be in HTML not wikitext & $link
wikidiff2_do_diff( $text1, $text2, $numContextLines)
This program is free software; you can redistribute it and/or modify it under the terms of the GNU Ge...
passed in as a query string parameter to the various URLs constructed here(i.e. $nextlink) $rdel also included in $oldHeader $oldminor
string $mMarkPatrolledLink
Link to action=markpatrolled.
localiseLineNumbers( $text)
Replace line numbers with the text in the user's language.
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 "<
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
debug( $generator="internal")
Generate a debug comment indicating diff generating time, server node, and generator backend.
renderNewRevision()
Show the new revision of the page.
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
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
getDiff( $otitle, $ntitle, $notice='')
Get complete diff table, including header.
generateContentDiffBody(Content $old, Content $new)
Generate a diff, no caching.
mapDiffPrevNext( $old, $new)
Maps a revision pair definition as accepted by DifferenceEngine constructor to a pair of actual integ...
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
addHeader( $diff, $otitle, $ntitle, $multi='', $notice='')
Add the header to a diff body.
Internationalisation code.
textDiff( $otext, $ntext)
Generates diff, to be wrapped internally in a logging/instrumentation.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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
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
Class representing a 'diff' between two sequences of strings.
wfShellExec( $cmd, &$retval=null, $environ=[], $limits=[], $options=[])
Execute a shell command, with time and memory limits mirrored from the PHP configuration if supported...
bool $mRefreshCache
Refresh the diff cache.
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
getMultiNotice()
If there are revisions between the ones being compared, return a note saying so.