30define(
'MW_DIFF_VERSION',
'1.11a' );
119 wfDebug(
"DifferenceEngine old '$old' new '$new' rcid '$rcid'\n" );
121 $this->mOldid = $old;
122 $this->mNewid = $new;
131 $this->mReducedLineNumbers =
$value;
138 if ( $this->mDiffLang ===
null ) {
139 # Default language in which the diff text is written.
140 $this->mDiffLang = $this->
getTitle()->getPageLanguage();
180 if ( $this->
getUser()->isAllowed(
'deletedhistory' ) ) {
182 $row =
$dbr->selectRow(
'archive',
'*',
183 [
'ar_rev_id' => $id ],
190 'target' =>
$title->getPrefixedText(),
191 'timestamp' =>
$rev->getTimestamp()
209 return "[$link $id]";
219 if ( $this->mOldRev ===
null ||
220 ( $this->mOldRev && $this->mOldContent ===
null )
224 if ( $this->mNewRev ===
null ||
225 ( $this->mNewRev && $this->mNewContent ===
null )
230 $out->setPageTitle( $this->
msg(
'errorpagetitle' ) );
231 $msg = $this->
msg(
'difference-missing-revision' )
232 ->params( $this->
getLanguage()->listToText( $missing ) )
233 ->numParams( count( $missing ) )
235 $out->addHTML( $msg );
240 # Allow frames except in certain special cases
242 $out->allowClickjacking();
243 $out->setRobotPolicy(
'noindex,nofollow' );
252 $permErrors = $this->mNewPage->getUserPermissionsErrors(
'read',
$user );
253 if ( $this->mOldPage ) { # mOldPage might not be
set,
see below.
255 $this->mOldPage->getUserPermissionsErrors(
'read',
$user ) );
257 if ( count( $permErrors ) ) {
264 # Carry over 'diffonly' param via navigation links
265 if ( $diffOnly !=
$user->getBoolOption(
'diffonly' ) ) {
266 $query[
'diffonly'] = $diffOnly;
268 # Cascade unhide param in links for easy deletion browsing
269 if ( $this->unhide ) {
273 # Check if one of the revisions is deleted/suppressed
279 # mOldRev is false if the difference engine is called with a "vague" query for
280 # a diff between a version V and its previous version V' AND the version V
281 # is the first version of that article. In that case, V' does not exist.
282 if ( $this->mOldRev ===
false ) {
283 $out->setPageTitle( $this->
msg(
'difference-title', $this->mNewPage->getPrefixedText() ) );
287 Hooks::run(
'DiffViewHeader', [ $this, $this->mOldRev, $this->mNewRev ] );
289 if ( $this->mNewPage->equals( $this->mOldPage ) ) {
290 $out->setPageTitle( $this->
msg(
'difference-title', $this->mNewPage->getPrefixedText() ) );
293 $out->setPageTitle( $this->
msg(
'difference-title-multipage',
294 $this->mOldPage->getPrefixedText(), $this->mNewPage->getPrefixedText() ) );
295 $out->addSubtitle( $this->
msg(
'difference-multipage' ) );
299 if ( $samePage && $this->mNewPage->quickUserCan(
'edit',
$user ) ) {
300 if ( $this->mNewRev->isCurrent() && $this->mNewPage->userCan(
'rollback',
$user ) ) {
302 if ( $rollbackLink ) {
303 $out->preventClickjacking();
304 $rollback =
'   ' . $rollbackLink;
312 'href' => $this->mNewPage->getLocalURL( [
314 'undoafter' => $this->mOldid,
315 'undo' => $this->mNewid
319 $this->msg(
'editundo' )->text()
321 $revisionTools[
'mw-diff-undo'] = $undoLink;
325 # Make "previous revision link"
326 if ( $samePage && $this->mOldRev->getPrevious() ) {
329 $this->
msg(
'previousdiff' )->escaped(),
330 [
'id' =>
'differences-prevlink' ],
331 [
'diff' =>
'prev',
'oldid' => $this->mOldid ] +
$query
334 $prevlink =
' ';
337 if ( $this->mOldRev->isMinor() ) {
347 $oldHeader =
'<div id="mw-diff-otitle1"><strong>' . $oldRevisionHeader .
'</strong></div>' .
348 '<div id="mw-diff-otitle2">' .
350 '<div id="mw-diff-otitle3">' . $oldminor .
352 '<div id="mw-diff-otitle5">' . $oldChangeTags[0] .
'</div>' .
353 '<div id="mw-diff-otitle4">' . $prevlink .
'</div>';
362 # Check if this user can see the revisions
368 # Make "next revision link"
369 # Skip next link on the top revision
370 if ( $samePage && !$this->mNewRev->isCurrent() ) {
373 $this->
msg(
'nextdiff' )->escaped(),
374 [
'id' =>
'differences-nextlink' ],
375 [
'diff' =>
'next',
'oldid' => $this->mNewid ] +
$query
378 $nextlink =
' ';
381 if ( $this->mNewRev->isMinor() ) {
387 # Handle RevisionDelete links...
390 # Allow extensions to define their own revision tools
391 Hooks::run(
'DiffRevisionTools',
392 [ $this->mNewRev, &$revisionTools, $this->mOldRev,
$user ] );
393 $formattedRevisionTools = [];
395 foreach ( $revisionTools
as $key => $tool ) {
396 $toolClass = is_string( $key ) ? $key :
'mw-diff-tool';
399 [
'class' => $toolClass ],
400 $this->
msg(
'parentheses' )->rawParams( $tool )->escaped()
402 $formattedRevisionTools[] = $element;
405 ' ' . implode(
' ', $formattedRevisionTools );
408 $newHeader =
'<div id="mw-diff-ntitle1"><strong>' . $newRevisionHeader .
'</strong></div>' .
411 '<div id="mw-diff-ntitle3">' . $newminor .
413 '<div id="mw-diff-ntitle5">' . $newChangeTags[0] .
'</div>' .
414 '<div id="mw-diff-ntitle4">' . $nextlink . $this->
markPatrolledLink() .
'</div>';
423 # If the diff cannot be shown due to a deleted revision, then output
424 # the diff header and links to unhide (if available)...
425 if ( $deleted && ( !$this->unhide || !$allowed ) ) {
428 $out->addHTML( $this->
addHeader(
'', $oldHeader, $newHeader, $multi ) );
430 $msg =
$suppressed ?
'rev-suppressed-no-diff' :
'rev-deleted-no-diff';
431 # Give explanation for why revision is not visible
432 $out->wrapWikiMsg(
"<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
435 # Give explanation and add a link to view the diff...
438 $msg =
$suppressed ?
'rev-suppressed-unhide-diff' :
'rev-deleted-unhide-diff';
440 "<div id='mw-$msg' class='mw-warning plainlinks'>\n$1\n</div>\n",
444 # Otherwise, output a regular diff...
446 # Add deletion notice if the user is viewing deleted content
449 $msg =
$suppressed ?
'rev-suppressed-diff-view' :
'rev-deleted-diff-view';
450 $notice =
"<div id='mw-$msg' class='mw-warning plainlinks'>\n" .
451 $this->
msg( $msg )->parse() .
454 $this->
showDiff( $oldHeader, $newHeader, $notice );
471 if ( $this->mMarkPatrolledLink ===
null ) {
475 $this->mMarkPatrolledLink =
'';
477 $this->mMarkPatrolledLink =
' <span class="patrollink" data-mw="interface">[' .
480 $this->
msg(
'markaspatrolleddiff' )->escaped(),
483 'action' =>
'markpatrolled',
484 'rcid' => $linkInfo[
'rcid'],
485 'token' => $linkInfo[
'token'],
508 $wgUseRCPatrol && $this->mNewPage->quickUserCan(
'patrol',
$user ) &&
517 'rc_timestamp' => $db->timestamp( $this->mNewRev->getTimestamp() ),
518 'rc_this_oldid' => $this->mNewid,
524 if ( $change && !$change->getPerformer()->equals(
$user ) ) {
525 $rcid = $change->getAttribute(
'rc_id' );
533 $this->
getOutput()->preventClickjacking();
535 &&
$user->isAllowed(
'writeapi' )
537 $this->
getOutput()->addModules(
'mediawiki.page.patrol.ajax' );
540 $token =
$user->getEditToken( $rcid );
559 if (
$link !==
'' ) {
572 # Add "current version as of X" title
573 $out->addHTML(
"<hr class='diff-hr' id='mw-oldid' />
574 <h2 class='diff-currentversion-title'>{$revHeader}</h2>\n" );
575 # Page content may be handled by a hooked call instead...
576 # @codingStandardsIgnoreStart Ignoring long lines.
577 if ( Hooks::run(
'ArticleContentOnDiff', [ $this,
$out ] ) ) {
579 $out->setRevisionId( $this->mNewid );
580 $out->setRevisionTimestamp( $this->mNewRev->getTimestamp() );
581 $out->setArticleFlag(
true );
584 if ( $this->mNewPage->isCssJsSubpage() || $this->mNewPage->isCssOrJsPage() ) {
591 $cnt = $this->mNewRev->getContent();
592 $po = $cnt ? $cnt->getParserOutput( $this->mNewRev->getTitle(), $this->mNewRev->getId() ) :
null;
594 $out->addParserOutputContent( $po );
597 } elseif ( !Hooks::run(
'ArticleContentViewCustom', [ $this->mNewContent, $this->mNewPage,
$out ] ) ) {
604 if ( $this->
getTitle()->equals( $this->mNewPage ) ) {
616 # WikiPage::getParserOutput() should not return false, but just in case
622 # @codingStandardsIgnoreEnd
624 # Add redundant patrol link on bottom...
632 if ( !$rev->
isCurrent() || !
$rev->getTitle()->quickUserCan(
'edit', $this->getUser() ) ) {
633 $parserOptions->setEditSection(
false );
651 public function showDiff( $otitle, $ntitle, $notice =
'' ) {
652 $diff = $this->
getDiff( $otitle, $ntitle, $notice );
653 if ( $diff ===
false ) {
669 $this->
getOutput()->addModuleStyles(
'mediawiki.action.history.diff' );
681 public function getDiff( $otitle, $ntitle, $notice =
'' ) {
683 if ( $body ===
false ) {
689 if ( $body ===
'' ) {
690 $notice .=
'<div class="mw-diff-empty">' .
691 $this->
msg(
'diff-empty' )->parse() .
695 return $this->
addHeader( $body, $otitle, $ntitle, $multi, $notice );
704 $this->mCacheHit =
true;
708 } elseif ( $this->mOldRev &&
712 } elseif ( $this->mNewRev &&
718 if ( $this->mOldRev ===
false || ( $this->mOldRev && $this->mNewRev
719 && $this->mOldRev->getId() == $this->mNewRev->getId() )
726 if ( $this->mOldid && $this->mNewid ) {
730 if ( !$this->mRefreshCache ) {
731 $difftext =
$cache->get( $key );
735 $difftext .=
"\n<!-- diff cache key $key -->\n";
741 $this->mCacheHit =
false;
754 if ( !Hooks::run(
'AbortDiffCache', [ &$diffEngine ] ) ) {
756 } elseif ( $key !==
false && $difftext !==
false ) {
758 $cache->set( $key, $difftext, 7 * 86400 );
763 if ( $difftext !==
false ) {
779 if ( !$this->mOldid || !$this->mNewid ) {
780 throw new MWException(
'mOldid and mNewid must be set to get diff cache key.' );
784 'oldid', $this->mOldid,
'newid', $this->mNewid );
808 throw new MWException(
"Diff not implemented for " . get_class( $old ) .
"; " .
809 "override generateContentDiffBody to fix this." );
813 throw new MWException(
"Diff not implemented for " . get_class( $new ) .
"; "
814 .
"override generateContentDiffBody to fix this." );
849 $diff =
function()
use ( $otext, $ntext ) {
850 $time = microtime(
true );
854 $time = intval( ( microtime(
true ) -
$time ) * 1000 );
857 if (
$time > 100 && $this->mOldPage && $this->mNewPage ) {
859 "$time ms diff: {$this->mOldid} -> {$this->mNewid} {$this->mNewPage}" );
870 if ( strlen( $otext ) + strlen( $ntext ) > 20000 ) {
872 md5( $otext ) . md5( $ntext ),
873 [
'doWork' => $diff,
'error' => $error ]
875 return $work->execute();
891 $otext = str_replace(
"\r\n",
"\n", $otext );
892 $ntext = str_replace(
"\r\n",
"\n", $ntext );
895 wfDeprecated(
"\$wgExternalDiffEngine = '{$wgExternalDiffEngine}'",
'1.27' );
902 wfWarn(
'$wgExternalDiffEngine is set to a non-string value, forcing it to false' );
907 # Better external diff engine, the 2 may some day be dropped
908 # This one does the escaping and segmenting itself
909 $text = wikidiff2_do_diff( $otext, $ntext, 2 );
910 $text .= $this->
debug(
'wikidiff2' );
916 $tempName1 = tempnam( $tmpDir,
'diff_' );
917 $tempName2 = tempnam( $tmpDir,
'diff_' );
919 $tempFile1 = fopen( $tempName1,
"w" );
923 $tempFile2 = fopen( $tempName2,
"w" );
927 fwrite( $tempFile1, $otext );
928 fwrite( $tempFile2, $ntext );
929 fclose( $tempFile1 );
930 fclose( $tempFile2 );
933 $difftext .= $this->
debug(
"external $wgExternalDiffEngine" );
934 unlink( $tempName1 );
935 unlink( $tempName2 );
941 $ota = explode(
"\n",
$wgContLang->segmentForDiff( $otext ) );
942 $nta = explode(
"\n",
$wgContLang->segmentForDiff( $ntext ) );
943 $diffs =
new Diff( $ota, $nta );
945 $difftext =
$wgContLang->unsegmentForDiff( $formatter->format( $diffs ) );
960 if ( !$this->enableDebugComment ) {
969 return "<!-- diff generator: " .
970 implode(
" ", array_map(
"htmlspecialchars", $data ) ) .
982 return preg_replace_callback(
983 '/<!--LINE (\d+)-->/',
984 [ $this,
'localiseLineNumbersCb' ],
990 if (
$matches[1] ===
'1' && $this->mReducedLineNumbers ) {
994 return $this->
msg(
'lineno' )->numParams(
$matches[1] )->escaped();
1003 if ( !is_object( $this->mOldRev ) || !is_object( $this->mNewRev ) ) {
1005 } elseif ( !$this->mOldPage->equals( $this->mNewPage ) ) {
1010 if ( $this->mOldRev->getTimestamp() > $this->mNewRev->getTimestamp() ) {
1020 $nEdits = $this->mNewPage->countRevisionsBetween( $oldRev, $newRev, 1000 );
1021 if ( $nEdits > 0 && $nEdits <= 1000 ) {
1023 $users = $this->mNewPage->getAuthorsBetween( $oldRev, $newRev,
$limit );
1024 $numUsers = count( $users );
1026 if ( $numUsers == 1 && $users[0] == $newRev->getUserText(
Revision::RAW ) ) {
1046 if ( $numUsers === 0 ) {
1047 $msg =
'diff-multi-sameuser';
1048 } elseif ( $numUsers >
$limit ) {
1049 $msg =
'diff-multi-manyusers';
1052 $msg =
'diff-multi-otherusers';
1055 return wfMessage( $msg )->numParams( $numEdits, $numUsers )->parse();
1070 $revtimestamp =
$rev->getTimestamp();
1072 $dateofrev =
$lang->userDate( $revtimestamp,
$user );
1073 $timeofrev =
$lang->userTime( $revtimestamp,
$user );
1075 $header = $this->
msg(
1076 $rev->
isCurrent() ?
'currentrev-asof' :
'revisionasof',
1082 if ( $complete !==
'complete' ) {
1089 [
'oldid' =>
$rev->getId() ] );
1092 $editQuery = [
'action' =>
'edit' ];
1093 if ( !
$rev->isCurrent() ) {
1094 $editQuery[
'oldid'] =
$rev->getId();
1097 $key =
$title->quickUserCan(
'edit',
$user ) ?
'editold' :
'viewsourceold';
1098 $msg = $this->
msg( $key )->escaped();
1099 $editLink = $this->
msg(
'parentheses' )->rawParams(
1103 [
'class' =>
'mw-diff-edit' ],
1109 [
'class' =>
'history-deleted' ],
1114 $header =
Html::rawElement(
'span', [
'class' =>
'history-deleted' ], $header );
1132 public function addHeader( $diff, $otitle, $ntitle, $multi =
'', $notice =
'' ) {
1136 'class' => [
'diff',
'diff-contentalign-' . $this->
getDiffLang()->alignStart() ],
1137 'data-mw' =>
'interface',
1139 $userLang = htmlspecialchars( $this->
getLanguage()->getHtmlCode() );
1141 if ( !$diff && !$otitle ) {
1143 <tr style='vertical-align: top;' lang='{$userLang}'>
1144 <td class='diff-ntitle'>{$ntitle}</td>
1150 <col class='diff-marker' />
1151 <col class='diff-content' />
1152 <col class='diff-marker' />
1153 <col class='diff-content' />";
1160 if ( $otitle || $ntitle ) {
1162 <tr style='vertical-align: top;' lang='{$userLang}'>
1163 <td colspan='$colspan' class='diff-otitle'>{$otitle}</td>
1164 <td colspan='$colspan' class='diff-ntitle'>{$ntitle}</td>
1169 if ( $multi !=
'' ) {
1170 $header .=
"<tr><td colspan='{$multiColspan}' style='text-align: center;' " .
1171 "class='diff-multi' lang='{$userLang}'>{$multi}</td></tr>";
1173 if ( $notice !=
'' ) {
1174 $header .=
"<tr><td colspan='{$multiColspan}' style='text-align: center;' " .
1175 "lang='{$userLang}'>{$notice}</td></tr>";
1178 return $header . $diff .
"</table>";
1188 $this->mOldContent = $oldContent;
1189 $this->mNewContent = $newContent;
1191 $this->mTextLoaded = 2;
1192 $this->mRevisionsLoaded =
true;
1217 if ( $new ===
'prev' ) {
1219 $newid = intval( $old );
1220 $oldid = $this->
getTitle()->getPreviousRevisionID( $newid );
1221 } elseif ( $new ===
'next' ) {
1223 $oldid = intval( $old );
1224 $newid = $this->
getTitle()->getNextRevisionID( $oldid );
1226 $oldid = intval( $old );
1227 $newid = intval( $new );
1230 return [ $oldid, $newid ];
1237 if ( $this->mRevisionsIdsLoaded ) {
1241 $this->mRevisionsIdsLoaded =
true;
1247 if ( $new ===
'next' && $this->mNewid ===
false ) {
1248 # if no result, NewId points to the newest old revision. The only newer
1249 # revision is cur, which is "0".
1254 'NewDifferenceEngine',
1255 [ $this->
getTitle(), &$this->mOldid, &$this->mNewid, $old, $new ]
1272 if ( $this->mRevisionsLoaded ) {
1277 $this->mRevisionsLoaded =
true;
1282 if ( $this->mNewid ) {
1292 if ( !$this->mNewRev instanceof
Revision ) {
1297 $this->mNewid = $this->mNewRev->getId();
1298 $this->mNewPage = $this->mNewRev->getTitle();
1301 $this->mOldRev =
false;
1302 if ( $this->mOldid ) {
1304 } elseif ( $this->mOldid === 0 ) {
1305 $rev = $this->mNewRev->getPrevious();
1307 $this->mOldid =
$rev->getId();
1308 $this->mOldRev =
$rev;
1311 $this->mOldid =
false;
1312 $this->mOldRev =
false;
1316 if ( is_null( $this->mOldRev ) ) {
1320 if ( $this->mOldRev ) {
1321 $this->mOldPage = $this->mOldRev->getTitle();
1326 if ( $this->mOldid !==
false ) {
1327 $this->mOldTags =
$dbr->selectField(
1330 [
'ts_rev_id' => $this->mOldid ],
1334 $this->mOldTags =
false;
1336 $this->mNewTags =
$dbr->selectField(
1339 [
'ts_rev_id' => $this->mNewid ],
1352 if ( $this->mTextLoaded == 2 ) {
1357 $this->mTextLoaded = 2;
1363 if ( $this->mOldRev ) {
1365 if ( $this->mOldContent ===
null ) {
1370 if ( $this->mNewRev ) {
1372 if ( $this->mNewContent ===
null ) {
1386 if ( $this->mTextLoaded >= 1 ) {
1390 $this->mTextLoaded = 1;
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
$wgShowHostnames
Expose backend server host names through the API and various HTML comments.
$wgUseRCPatrol
Use RC Patrolling to check for vandalism (from recent changes and watchlists) New pages and new files...
$wgEnableWriteAPI
Allow the API to be used to perform write operations (page edits, rollback, etc.) when an authorised ...
$wgEnableAPI
Enable the MediaWiki API for convenient access to machine-readable data via api.php.
$wgExternalDiffEngine
Name of the external diff engine to use.
const MW_DIFF_VERSION
Constant to indicate diff cache compatibility.
wfGetLangObj( $langcode=false)
Return a Language object from $langcode.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfTempDir()
Tries to get the system directory for temporary files.
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
wfIncrStats( $key, $count=1)
Increment a statistics counter.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfMergeErrorArrays()
Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.
wfShellExec( $cmd, &$retval=null, $environ=[], $limits=[], $options=[])
Execute a shell command, with time and memory limits mirrored from the PHP configuration if supported...
wfHostname()
Fetch server name for use in error reporting etc.
wfMemcKey()
Make a cache key for the local wiki.
wfEscapeShellArg()
Windows-compatible version of escapeshellarg() Windows doesn't recognise single-quotes in the shell,...
const TS_DB
MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
static flag( $flag, IContextSource $context=null)
Make an "<abbr>" element for a given change flag.
static runLegacyHooks( $event, $args=[], $warn=null)
Call a legacy hook that uses text instead of Content objects.
static deprecated( $func, $version, $component=false)
Logs a deprecation warning, visible if $wgDevelopmentWarnings, but only if self::$enableDeprecationWa...
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and ...
getStats()
Get the Stats object.
getUser()
Get the User object.
getRequest()
Get the WebRequest object.
msg()
Get a Message object with context set Parameters are the same as wfMessage()
getTitle()
Get the Title object.
getOutput()
Get the OutputPage object.
getWikiPage()
Get the WikiPage object.
getLanguage()
Get the Language object.
getContext()
Get the base IContextSource object.
setContext(IContextSource $context)
Set the IContextSource object.
Class representing a 'diff' between two sequences of strings.
getDiffBodyCacheKey()
Returns the cache key for diff body text or content.
bool $unhide
Show rev_deleted content if allowed.
bool $mRevisionsIdsLoaded
Have the revisions IDs been loaded.
revisionDeleteLink( $rev)
int $mTextLoaded
How many text blobs have been loaded, 0, 1 or 2?
deletedIdMarker( $id)
Build a wikitext link toward a deleted revision, if viewable.
generateTextDiffBody( $otext, $ntext)
Generate a diff, no caching.
loadNewText()
Load the text of the new revision, not the old one.
showDiffPage( $diffOnly=false)
loadText()
Load the text of the revisions, as well as revision data.
mapDiffPrevNext( $old, $new)
Maps a revision pair definition as accepted by DifferenceEngine constructor to a pair of actual integ...
getParserOutput(WikiPage $page, Revision $rev)
getDiffBody()
Get the diff table body, without header.
loadRevisionData()
Load revision metadata for the specified articles.
loadRevisionIds()
Load revision IDs.
bool $mRevisionsLoaded
Have the revisions been loaded.
generateDiffBody( $otext, $ntext)
Generate a diff, no caching.
showDiff( $otitle, $ntitle, $notice='')
Get the diff text, send it to the OutputPage object Returns false if the diff could not be generated,...
localiseLineNumbers( $text)
Replace line numbers with the text in the user's language.
string $mMarkPatrolledLink
Link to action=markpatrolled.
localiseLineNumbersCb( $matches)
deletedLink( $id)
Look up a special:Undelete link to the given deleted revision id, as a workaround for being unable to...
bool $mReducedLineNumbers
If true, line X is not displayed when X is 1, for example to increase readability and conserve space ...
getRevisionHeader(Revision $rev, $complete='')
Get a header for a specified revision.
__construct( $context=null, $old=0, $new=0, $rcid=0, $refreshCache=false, $unhide=false)
#-
bool $mCacheHit
Was the diff fetched from cache?
getMultiNotice()
If there are revisions between the ones being compared, return a note saying so.
debug( $generator="internal")
Generate a debug comment indicating diff generating time, server node, and generator backend.
addHeader( $diff, $otitle, $ntitle, $multi='', $notice='')
Add the header to a diff body.
bool $mRefreshCache
Refresh the diff cache.
getDiff( $otitle, $ntitle, $notice='')
Get complete diff table, including header.
renderNewRevision()
Show the new revision of the page.
setContent(Content $oldContent, Content $newContent)
Use specified text instead of loading from the database.
generateContentDiffBody(Content $old, Content $new)
Generate a diff, no caching.
getMarkPatrolledLinkInfo()
Returns an array of meta data needed to build a "mark as patrolled" link and adds the mediawiki....
setReducedLineNumbers( $value=true)
textDiff( $otext, $ntext)
Generates diff, to be wrapped internally in a logging/instrumentation.
static intermediateEditsMsg( $numEdits, $numUsers, $limit)
Get a notice about how many intermediate edits and users there are.
setTextLanguage( $lang)
Set the language in which the diff text is written (Defaults to page content language).
showDiffStyle()
Add style sheets and supporting JS for diff display.
markPatrolledLink()
Build a link to mark a change as patrolled.
$enableDebugComment
Set this to true to add debug info to the HTML output.
Exception class which takes an HTML error message, and does not produce a backtrace.
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
static openElement( $element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
Internationalisation code.
static generateRollback( $rev, IContextSource $context=null, $options=[ 'verify'])
Generate a rollback link for a given revision.
static titleAttrib( $name, $options=null, array $msgParams=[])
Given the id of an interface element, constructs the appropriate title attribute from the system mess...
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.
static revUserTools( $rev, $isPublic=false)
Generate a user tool link cluster if the current user is allowed to view it.
static linkKnown( $target, $html=null, $customAttribs=[], $query=[], $options=[ 'known', 'noclasses'])
Identical to link(), except $options defaults to 'known'.
static getRevDeleteLink(User $user, Revision $rev, Title $title)
Get a revision-deletion link, or disabled link, or nothing, depending on user permissions & the setti...
static getMainWANInstance()
Get the main WAN cache 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.
static isInRCLifespan( $timestamp, $tolerance=0)
Check whether the given timestamp is new enough to have a RC row with a given tolerance as the recent...
static newFromConds( $conds, $fname=__METHOD__, $dbType=DB_SLAVE)
Find the first recent change matching some specific conditions.
static newFromArchiveRow( $row, $overrides=[])
Make a fake revision object from an archive table row.
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that's attached to a given link target.
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name.
Content object implementation for representing flat text.
Represents a title within MediaWiki.
getFullURL( $query='', $query2=false, $proto=PROTO_RELATIVE)
Get a real URL referring to this title, with interwiki link and fragment.
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Class representing a MediaWiki article and history.
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
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
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
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
when a variable name is used in a it is silently declared as a new local masking the global
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
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context $parserOutput
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
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':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
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing 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 "<div ...>$1</div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify prev or next $refreshCache
returning false will NOT prevent logging a wrapping ErrorException $suppressed
namespace and then decline to actually register it file or subcat img or subcat $title
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive $limit
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
see documentation in includes Linker php for Linker::makeImageLink & $time
the value to return A Title object or null for latest to be modified or replaced by the hook handler or if authentication is not possible after cache objects are set for highlighting & $link
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
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
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
Base interface for content objects.
serialize( $format=null)
Convenience method for serializing this Content object.
Interface for objects which can provide a MediaWiki context on request.
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
if(!isset( $args[0])) $lang