Go to the documentation of this file.
24 use Psr\Log\LoggerInterface;
29 use Liuggio\StatsdClient\Sender\SocketSender;
69 $request = $this->context->getRequest();
70 $curid =
$request->getInt(
'curid' );
74 if (
$request->getCheck(
'search' ) ) {
93 $contLang->hasVariants() && !is_null(
$ret ) &&
$ret->getArticleID() == 0
103 if (
$ret ===
null || !
$ret->isSpecialPage() ) {
105 $oldid =
$request->getInt(
'oldid' );
106 $oldid = $oldid ?:
$request->getInt(
'diff' );
116 && strval(
$title ) ===
''
123 if (
$ret ===
null || (
$ret->getDBkey() ==
'' && !
$ret->isExternal() ) ) {
138 if ( !$this->context->hasTitle() ) {
140 $this->context->setTitle( $this->
parseTitle() );
145 return $this->context->getTitle();
154 if ( $this->
action ===
null ) {
176 $request = $this->context->getRequest();
177 $requestTitle =
$title = $this->context->getTitle();
178 $output = $this->context->getOutput();
179 $user = $this->context->getUser();
181 if (
$request->getVal(
'printable' ) ===
'yes' ) {
190 ||
$title->isSpecial(
'Badtitle' )
204 $permErrors =
$title->isSpecial(
'RunJobs' )
206 :
$title->getUserPermissionsErrors(
'read',
$user );
207 if (
count( $permErrors ) ) {
218 $this->context->setTitle( $badTitle );
225 if (
$title->isExternal() ) {
226 $rdfrom =
$request->getVal(
'rdfrom' );
228 $url =
$title->getFullURL( [
'rdfrom' => $rdfrom ] );
235 if ( !preg_match(
'/^' . preg_quote( $this->config->get(
'Server' ),
'/' ) .
'/', $url )
239 $output->redirect( $url, 301 );
254 if (
$title->isSpecialPage() ) {
255 $specialPage = $spFactory->getPage(
$title->getDBkey() );
257 $specialPage->setContext( $this->context );
258 if ( $this->config->get(
'HideIdentifiableRedirects' )
259 && $specialPage->personallyIdentifiableTarget()
261 list( , $subpage ) = $spFactory->resolveAlias(
$title->getDBkey() );
262 $target = $specialPage->getRedirect( $subpage );
264 if ( $target instanceof
Title ) {
265 $query = $specialPage->getRedirectQuery() ?: [];
267 $request->setRequestURL( $this->context->getRequest()->getRequestURL() );
268 $this->context->setRequest(
$request );
270 $this->context->getOutput()->lowerCdnMaxage( 0 );
271 $this->context->setTitle( $target );
277 'wgInternalRedirectTargetUrl' => $target->getFullURL(
$query ),
279 $output->addModules(
'mediawiki.action.view.redirect' );
286 if (
$title->isSpecialPage() ) {
288 $spFactory->executePath(
$title, $this->context );
295 } elseif ( is_string(
$article ) ) {
298 throw new MWException(
"Shouldn't happen: MediaWiki::initializeArticle()"
299 .
" returned neither an object nor a URL" );
328 $request = $this->context->getRequest();
329 $output = $this->context->getOutput();
331 if (
$request->getVal(
'action',
'view' ) !=
'view'
341 if (
$title->isSpecialPage() ) {
343 resolveAlias(
$title->getDBkey() );
350 if ( $targetUrl ==
$request->getFullRequestURL() ) {
351 $message =
"Redirect loop detected!\n\n" .
352 "This means the wiki got confused about what page was " .
353 "requested; this sometimes happens when moving a wiki " .
354 "to a new server or changing the server configuration.\n\n";
356 if ( $this->config->get(
'UsePathInfo' ) ) {
357 $message .=
"The wiki is trying to interpret the page " .
358 "title from the URL path portion (PATH_INFO), which " .
359 "sometimes fails depending on the web server. Try " .
360 "setting \"\$wgUsePathInfo = false;\" in your " .
361 "LocalSettings.php, or check that \$wgArticlePath " .
364 $message .=
"Your web server was detected as possibly not " .
365 "supporting URL path components (PATH_INFO) correctly; " .
366 "check your LocalSettings.php for a customized " .
367 "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
373 $output->redirect( $targetUrl,
'301' );
384 $title = $this->context->getTitle();
385 if ( $this->context->canUseWikiPage() ) {
389 $page = $this->context->getWikiPage();
394 $this->context->setWikiPage( $page );
395 wfWarn(
"RequestContext::canUseWikiPage() returned false" );
406 $request = $this->context->getRequest();
415 &&
$request->getVal(
'redirect' ) !=
'no'
417 && !( is_object(
$file ) &&
$file->exists() && !
$file->getRedirected() )
420 $ignoreRedirect = $target =
false;
428 if ( !$ignoreRedirect && ( $target || $page->isRedirect() ) ) {
430 $target = $target ?: $page->followRedirect();
431 if ( is_string( $target ) && !$this->config->get(
'DisableHardRedirects' ) ) {
435 if ( is_object( $target ) ) {
438 $rpage->loadPageData();
439 if ( $rpage->exists() || ( is_object(
$file ) && !
$file->isLocal() ) ) {
441 $rarticle->setRedirectedFrom(
$title );
444 $this->context->setTitle( $target );
445 $this->context->setWikiPage(
$article->getPage() );
451 $this->context->setWikiPage(
$article->getPage() );
465 $request = $this->context->getRequest();
466 $output = $this->context->getOutput();
467 $title = $this->context->getTitle();
468 $user = $this->context->getUser();
481 $trxLimits = $this->config->get(
'TrxProfilerLimits' );
484 $trxProfiler->setExpectations( $trxLimits[
'POST-nonwrite'], __METHOD__ );
488 # Let CDN cache things if we can purge them.
489 if ( $this->config->get(
'UseSquid' ) &&
496 $output->setCdnMaxage( $this->config->get(
'SquidMaxage' ) );
505 $output->showErrorPage(
'nosuchaction',
'nosuchactiontext' );
523 }
catch ( Exception
$e ) {
530 in_array(
$action, [
'view',
'history' ],
true ) &&
535 if (
$cache->isCached() ) {
543 }
catch ( Error
$e ) {
554 $name = $this->context->getUser()->getName();
555 $services->getDBLoadBalancerFactory()->setAgentName(
584 ignore_user_abort(
true );
592 $lbFactory->commitMasterChanges(
595 [
'maxWriteDuration' =>
$config->
get(
'MaxUserDBWriteDuration' ) ]
597 wfDebug( __METHOD__ .
': primary transaction round committed' );
601 wfDebug( __METHOD__ .
': pre-send deferred updates completed' );
610 $flags = $lbFactory::SHUTDOWN_CHRONPROT_SYNC;
611 $strategy =
'cookie+sync';
613 $allowHeaders = !(
$output->isDisabled() || headers_sent() );
614 if (
$output->getRedirect() && $lbFactory->hasOrMadeRecentMasterChanges( INF ) ) {
619 if ( $domainDistance ===
'local' && $allowHeaders ) {
620 $flags = $lbFactory::SHUTDOWN_CHRONPROT_ASYNC;
621 $strategy =
'cookie';
622 } elseif ( $domainDistance ===
'remote' ) {
623 $flags = $lbFactory::SHUTDOWN_CHRONPROT_ASYNC;
624 $strategy =
'cookie+url';
631 $lbFactory->shutdown( $flags, $postCommitWork, $cpIndex, $cpClientId );
632 wfDebug( __METHOD__ .
': LBFactory shutdown completed' );
634 if ( $cpIndex > 0 ) {
635 if ( $allowHeaders ) {
637 $expires = $now + ChronologyProtector::POSITION_COOKIE_TTL;
643 if ( $strategy ===
'cookie+url' ) {
644 if (
$output->getRedirect() ) {
645 $safeUrl = $lbFactory->appendShutdownCPIndexAsQuery(
651 $e =
new LogicException(
"No redirect; cannot append cpPosIndex parameter." );
660 if (
$request->wasPosted() && $lbFactory->hasOrMadeRecentMasterChanges() ) {
661 $expires = time() +
$config->
get(
'DataCenterUpdateStickTTL' );
664 $request->response()->setCookie(
'UseCDNCache',
'false', $expires,
$options );
669 if ( $lbFactory->laggedReplicaUsed() ) {
671 $output->lowerCdnMaxage( $maxAge );
672 $request->response()->header(
"X-Database-Lagged: true" );
673 wfDebugLog(
'replication',
"Lagged DB used; CDN cache TTL limited to $maxAge seconds" );
678 $maxAge =
$config->
get(
'CdnMaxageSubstitute' );
679 $output->lowerCdnMaxage( $maxAge );
680 $request->response()->header(
"X-Response-Substitute: true" );
693 if ( $clusterWiki !==
false ) {
712 $timing = $this->context->getTiming();
713 $timing->mark(
'requestShutdown' );
719 }
catch ( Exception
$e ) {
727 $blocksHttpClient =
true;
729 $callback =
function ()
use ( $mode, &$blocksHttpClient ) {
732 }
catch ( Exception
$e ) {
738 if ( function_exists(
'register_postsend_function' ) ) {
740 register_postsend_function( $callback );
742 $blocksHttpClient =
false;
744 if ( function_exists(
'fastcgi_finish_request' ) ) {
745 fastcgi_finish_request();
747 $blocksHttpClient =
false;
751 ignore_user_abort(
true );
761 $output = $this->context->getOutput();
762 $request = $this->context->getRequest();
765 if (
$request->getVal(
'action' ) ===
'ajax' ) {
770 $this->context->setTitle(
$title );
774 $dispatcher->performAction( $this->context->getUser() );
786 $trxLimits = $this->config->get(
'TrxProfilerLimits' );
788 $trxProfiler->setLogger( LoggerFactory::getInstance(
'DBPerformance' ) );
790 $trxProfiler->setExpectations( $trxLimits[
'GET'], __METHOD__ );
792 $trxProfiler->setExpectations( $trxLimits[
'POST'], __METHOD__ );
801 $request->getProtocol() ==
'http' &&
805 $request->getSession()->shouldForceHTTPS() ||
807 $request->getCookie(
'forceHTTPS',
'' ) ||
809 $request->getCookie(
'forceHTTPS' ) ||
812 $this->context->getUser()->isLoggedIn()
813 && $this->context->getUser()->requiresHTTPS()
817 $oldUrl =
$request->getFullRequestURL();
818 $redirUrl = preg_replace(
'#^http://#',
'https://', $oldUrl );
821 if (
Hooks::run(
'BeforeHttpsRedirect', [ $this->context, &$redirUrl ] ) ) {
831 wfDebugLog(
'RedirectedPosts',
"Redirected from HTTP to HTTPS: $oldUrl" );
835 $this->context->setTitle(
$title );
837 $output->addVaryHeader(
'X-Forwarded-Proto' );
838 $output->redirect( $redirUrl );
848 if (
$cache->isCacheGood( ) ) {
850 $timestamp =
$cache->cacheTimestamp();
851 if ( !
$output->checkLastModified( $timestamp ) ) {
852 $cache->loadFromFileCache( $this->context );
856 $this->context->getWikiPage()->doViewUpdates( $this->context->getUser() );
892 public function restInPeace( $mode =
'fast', $blocksHttpClient =
true ) {
895 $lbFactory->commitMasterChanges( __METHOD__ );
899 $trxProfiler->redefineExpectations(
900 $this->context->getRequest()->hasSafeMethod()
901 ? $this->config->get(
'TrxProfilerLimits' )[
'PostSend-GET']
902 : $this->config->get(
'TrxProfilerLimits' )[
'PostSend-POST'],
911 if ( $mode ===
'normal' ) {
919 $lbFactory->commitMasterChanges( __METHOD__ );
922 wfDebug(
"Request ended normally\n" );
938 $statsdServer = explode(
':',
$config->
get(
'StatsdServer' ), 2 );
939 $statsdHost = $statsdServer[0];
940 $statsdPort = $statsdServer[1] ?? 8125;
941 $statsdSender =
new SocketSender( $statsdHost, $statsdPort );
943 $statsdClient->setSamplingRates(
$config->
get(
'StatsdSamplingRates' ) );
944 $statsdClient->send( $stats->
getData() );
947 }
catch ( Exception $ex ) {
959 $jobRunRate = $this->config->get(
'JobRunRate' );
960 if ( $this->
getTitle()->isSpecial(
'RunJobs' ) ) {
962 } elseif ( $jobRunRate <= 0 ||
wfReadOnly() ) {
966 if ( $jobRunRate < 1 ) {
967 $max = mt_getrandmax();
968 if ( mt_rand( 0, $max ) > $max * $jobRunRate ) {
973 $n = intval( $jobRunRate );
976 $logger = LoggerFactory::getInstance(
'runJobs' );
979 if ( $this->config->get(
'RunJobsAsync' ) ) {
982 if ( !$invokedWithSuccess ) {
984 $logger->warning(
"Jobs switched to blocking; Special:RunJobs disabled" );
1002 $old = $trxProfiler->setSilenced(
true );
1004 $runner =
new JobRunner( $runJobsLogger );
1005 $runner->run( [
'maxJobs' => $n ] );
1007 $trxProfiler->setSilenced( $old );
1023 $query = [
'title' =>
'Special:RunJobs',
1024 'tasks' =>
'jobs',
'maxjobs' => $n,
'sigexpiry' => time() + 5 ];
1026 $query, $this->config->get(
'SecretKey' ) );
1028 $errno = $errstr =
null;
1029 $info =
wfParseUrl( $this->config->get(
'CanonicalServer' ) );
1030 $host = $info ? $info[
'host'] :
null;
1032 if ( isset( $info[
'scheme'] ) && $info[
'scheme'] ==
'https' ) {
1033 $host =
"tls://" . $host;
1036 if ( isset( $info[
'port'] ) ) {
1037 $port = $info[
'port'];
1040 Wikimedia\suppressWarnings();
1041 $sock = $host ? fsockopen(
1049 Wikimedia\restoreWarnings();
1051 $invokedWithSuccess =
true;
1054 getPage(
'RunJobs' );
1055 $url = $special->getPageTitle()->getCanonicalURL(
$query );
1057 "POST $url HTTP/1.1\r\n" .
1058 "Host: {$info['host']}\r\n" .
1059 "Connection: Close\r\n" .
1060 "Content-Length: 0\r\n\r\n"
1063 $runJobsLogger->info(
"Running $n job(s) via '$url'" );
1066 stream_set_timeout( $sock, 2 );
1067 $bytes = fwrite( $sock,
$req );
1068 if ( $bytes !== strlen(
$req ) ) {
1069 $invokedWithSuccess =
false;
1070 $runJobsLogger->error(
"Failed to start cron API (socket write error)" );
1074 $start = microtime(
true );
1076 $sec = microtime(
true ) - $start;
1077 if ( !preg_match(
'#^HTTP/\d\.\d 202 #',
$status ) ) {
1078 $invokedWithSuccess =
false;
1079 $runJobsLogger->error(
"Failed to start cron API: received '$status' ($sec)" );
1084 $invokedWithSuccess =
false;
1085 $runJobsLogger->error(
"Failed to start cron API (socket error $errno): $errstr" );
1088 return $invokedWithSuccess;
static getActionName(IContextSource $context)
Get the action that will be executed, not necessarily the one passed passed through the "action" requ...
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. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header '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
Similar to FauxRequest, but only fakes URL parameters and method (POST or GET) and use the base reque...
clearData()
Clear all buffered data from the factory.
static useFileCache(IContextSource $context, $mode=self::MODE_NORMAL)
Check if pages can be cached for this request/user.
return true to allow those checks to and false if checking is done & $user
Interface for type hinting (accepts WikiPage, Article, ImagePage, CategoryPage)
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used the name of the old file & $article
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
static instance()
Singleton.
static isCurrentWikiId( $wikiId)
Page view caching in the file system.
static newMainPage()
Create a new Title for the Main Page.
static getWikiFromUrl( $url)
this hook is for auditing only $req
static getQuerySignature(array $query, $secretKey)
wfReadOnly()
Check whether the wiki is in read-only mode.
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,...
static getForTitle(Title $title)
Returns the appropriate ContentHandler singleton for the given title.
if(! $wgRequest->checkUrlExtension()) if(isset( $_SERVER['PATH_INFO']) && $_SERVER['PATH_INFO'] !='') $wgTitle
Show an error when a user tries to do something they do not have the necessary permissions for.
Shortcut to construct a special page alias.
hasData()
Check whether this data factory has any buffered data.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
Show an error that looks like an HTTP server error.
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
Actions are things which can be done to pages (edit, delete, rollback, etc).
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
Interface for configuration instances.
getCdnUrls()
Get a list of URLs to purge from the CDN cache when this page changes.
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
static newFromWikiPage(WikiPage $page, IContextSource $context)
Create an Article object of the appropriate class for the given page.
getData()
Return the buffered data from the factory.
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.
get( $name)
Get a configuration variable such as "Sitename" or "UploadMaintenance.".
static handleException( $e)
Exception handler which simulates the appropriate catch() handling:
static rollbackMasterChangesAndLog( $e)
Roll back any open database transactions and log the stack trace of the exception.
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
A statsd client that applies the sampling rate to the data items before sending them.
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
report()
Output a report about the exception and takes care of formatting.
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
static singleton()
Get the signleton instance of this class.
static newFromTextThrow( $text, $defaultNamespace=NS_MAIN)
Like Title::newFromText(), but throws MalformedTitleException when the title is invalid,...
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Allows to change the fields on the form that will be generated $name
static disableForPostSend()
Disable setters for post-send processing.
Object-Oriented Ajax functions.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
static newFromURL( $url)
THIS IS NOT THE FUNCTION YOU WANT.
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 & $ret
static getMain()
Get the RequestContext object associated with the main request.
Interface for objects which can provide a MediaWiki context on request.
static doUpdates( $mode='run', $stage=self::ALL)
Do any deferred updates and clear the list.
MediaWiki adaptation of StatsdDataFactory that provides buffering functionality.
Represents a title within MediaWiki.
static singleton( $domain=false)
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 & $options
getConfig()
Get the site configuration.
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
static getHTML( $e)
If $wgShowExceptionDetails is true, return a HTML message with a backtrace to the error,...
MediaWiki Logger LoggerFactory implements a PSR[0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Special handling for file pages.
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
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
Job queue runner utility methods.
An error page which can definitely be safely rendered using the OutputPage.
static newFromID( $id, $flags=0)
Create a new Title from an article ID.
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
static factory( $action, Page $page, IContextSource $context=null)
Get an appropriate Action subclass for the given action.
Show an error page on a badtitle.
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
static logException( $e, $catcher=self::CAUGHT_BY_OTHER)
Log an exception to the exception log (if enabled).