53 'login' =>
'ApiLogin',
54 'clientlogin' =>
'ApiClientLogin',
55 'logout' =>
'ApiLogout',
56 'createaccount' =>
'ApiAMCreateAccount',
57 'linkaccount' =>
'ApiLinkAccount',
58 'unlinkaccount' =>
'ApiRemoveAuthenticationData',
59 'changeauthenticationdata' =>
'ApiChangeAuthenticationData',
60 'removeauthenticationdata' =>
'ApiRemoveAuthenticationData',
61 'resetpassword' =>
'ApiResetPassword',
62 'query' =>
'ApiQuery',
63 'expandtemplates' =>
'ApiExpandTemplates',
64 'parse' =>
'ApiParse',
65 'stashedit' =>
'ApiStashEdit',
66 'opensearch' =>
'ApiOpenSearch',
67 'feedcontributions' =>
'ApiFeedContributions',
68 'feedrecentchanges' =>
'ApiFeedRecentChanges',
69 'feedwatchlist' =>
'ApiFeedWatchlist',
71 'paraminfo' =>
'ApiParamInfo',
73 'compare' =>
'ApiComparePages',
74 'tokens' =>
'ApiTokens',
75 'checktoken' =>
'ApiCheckToken',
76 'cspreport' =>
'ApiCSPReport',
79 'purge' =>
'ApiPurge',
80 'setnotificationtimestamp' =>
'ApiSetNotificationTimestamp',
81 'rollback' =>
'ApiRollback',
82 'delete' =>
'ApiDelete',
83 'undelete' =>
'ApiUndelete',
84 'protect' =>
'ApiProtect',
85 'block' =>
'ApiBlock',
86 'unblock' =>
'ApiUnblock',
88 'edit' =>
'ApiEditPage',
89 'upload' =>
'ApiUpload',
90 'filerevert' =>
'ApiFileRevert',
91 'emailuser' =>
'ApiEmailUser',
92 'watch' =>
'ApiWatch',
93 'patrol' =>
'ApiPatrol',
94 'import' =>
'ApiImport',
95 'clearhasmsg' =>
'ApiClearHasMsg',
96 'userrights' =>
'ApiUserrights',
97 'options' =>
'ApiOptions',
98 'imagerotate' =>
'ApiImageRotate',
99 'revisiondelete' =>
'ApiRevisionDelete',
100 'managetags' =>
'ApiManageTags',
102 'mergehistory' =>
'ApiMergeHistory',
109 'json' =>
'ApiFormatJson',
110 'jsonfm' =>
'ApiFormatJson',
111 'php' =>
'ApiFormatPhp',
112 'phpfm' =>
'ApiFormatPhp',
113 'xml' =>
'ApiFormatXml',
114 'xmlfm' =>
'ApiFormatXml',
115 'rawfm' =>
'ApiFormatJson',
116 'none' =>
'ApiFormatNone',
128 'msg' =>
'right-writeapi',
132 'msg' =>
'api-help-right-apihighlimits',
186 parent::__construct( $this, $this->mInternalMode ?
'main_int' :
'main' );
190 if ( !$this->mInternalMode ) {
193 $originHeader =
$request->getHeader(
'Origin' );
194 if ( $originHeader ===
false ) {
197 $originHeader = trim( $originHeader );
198 $origins = preg_split(
'/\s+/', $originHeader );
200 $sessionCookies = array_intersect(
201 array_keys( $_COOKIE ),
202 MediaWiki\Session\SessionManager::singleton()->getVaryCookies()
204 if ( $origins && $sessionCookies && (
205 count( $origins ) !== 1 || !self::matchOrigin(
207 $config->get(
'CrossSiteAJAXdomains' ),
208 $config->get(
'CrossSiteAJAXdomainExceptions' )
211 LoggerFactory::getInstance(
'cors' )->warning(
212 'Non-whitelisted CORS request with session cookies', [
213 'origin' => $originHeader,
214 'cookies' => $sessionCookies,
226 wfDebug(
"API: stripping user credentials when the same-origin policy is not applied\n" );
227 $wgUser =
new User();
233 if ( $uselang ===
'user' ) {
237 if ( $uselang ===
'content' ) {
239 $uselang = $wgContLang->getCode();
243 if ( !$this->mInternalMode ) {
251 $this->mModuleMgr->addModules( self::$Modules,
'action' );
252 $this->mModuleMgr->addModules( $config->get(
'APIModules' ),
'action' );
253 $this->mModuleMgr->addModules( self::$Formats,
'format' );
254 $this->mModuleMgr->addModules( $config->get(
'APIFormatModules' ),
'format' );
256 Hooks::run(
'ApiMain::moduleManager', [ $this->mModuleMgr ] );
260 $this->mResult->setErrorFormatter( $this->mErrorFormatter );
261 $this->mContinuationManager = null;
262 $this->mEnableWrite = $enableWrite;
264 $this->mSquidMaxage = -1;
265 $this->mCommit =
false;
297 if (
$request->getVal(
'callback' ) !== null ) {
303 if (
$request->getVal(
'origin' ) ===
'*' ) {
310 if (
$request->getHeader(
'Treat-as-Untrusted' ) !==
false ) {
341 if ( $manager !== null ) {
344 is_object( $manager ) ? get_class( $manager ) : gettype( $manager )
347 if ( $this->mContinuationManager !== null ) {
349 __METHOD__ .
': tried to set manager from ' . $manager->getSource() .
350 ' when a manager is already set from ' . $this->mContinuationManager->getSource()
354 $this->mContinuationManager = $manager;
382 'max-age' => $maxage,
383 's-maxage' => $maxage
413 if ( !in_array( $mode, [
'private',
'public',
'anon-public-user-private' ] ) ) {
414 wfDebug( __METHOD__ .
": unrecognised cache mode \"$mode\"\n" );
422 if ( $mode !==
'private' ) {
423 wfDebug( __METHOD__ .
": ignoring request for $mode cache mode, private wiki\n" );
429 if ( $mode ===
'public' && $this->
getParameter(
'uselang' ) ===
'user' ) {
434 wfDebug( __METHOD__ .
": downgrading cache mode 'public' to " .
435 "'anon-public-user-private' due to uselang=user\n" );
436 $mode =
'anon-public-user-private';
439 wfDebug( __METHOD__ .
": setting cache mode $mode\n" );
440 $this->mCacheMode = $mode;
465 $printer = $this->mModuleMgr->getModule( $format,
'format' );
466 if ( $printer === null ) {
467 $this->
dieUsage(
"Unrecognized format: {$format}",
'unknown_format' );
477 if ( $this->mInternalMode ) {
497 if ( $this->
getRequest()->getMethod() ===
'OPTIONS' ) {
503 $obLevel = ob_get_level();
506 $t = microtime(
true );
510 $runTime = microtime(
true ) -
$t;
512 if ( $this->mModule->isWriteMode() && $this->
getRequest()->wasPosted() ) {
514 'api.' . $this->mModule->getModuleName() .
'.executeTiming', 1000 * $runTime
532 while ( ob_get_level() > $obLevel ) {
557 Hooks::run(
'ApiMain::onException', [ $this, $e ] );
560 if ( !( $e instanceof UsageException ) ) {
574 $headerStr =
'MediaWiki-API-Error: ' . $errCode;
575 if ( $e->getCode() === 0 ) {
578 $response->header( $headerStr,
true, $e->getCode() );
589 }
catch ( UsageException $ex ) {
593 'Error printer failed (will retry without params): ' . $ex->getMessage()
595 $this->mPrinter = null;
597 $this->mPrinter->forceDefaultParams();
617 $main->handleException( $e );
618 $main->logRequest( 0, $e );
625 $main->sendCacheHeaders(
true );
646 if ( $originParam === null ) {
654 $matchOrigin =
false;
655 $allowTiming =
false;
658 if ( $originParam ===
'*' ) {
662 $allowCredentials =
'false';
668 $originHeader =
$request->getHeader(
'Origin' );
669 if ( $originHeader ===
false ) {
672 $originHeader = trim( $originHeader );
673 $origins = preg_split(
'/\s+/', $originHeader );
676 if ( !in_array( $originParam, $origins ) ) {
680 $response->header(
'Cache-Control: no-cache' );
681 echo
"'origin' parameter does not match Origin header\n";
687 $matchOrigin = count( $origins ) === 1 && self::matchOrigin(
689 $config->get(
'CrossSiteAJAXdomains' ),
690 $config->get(
'CrossSiteAJAXdomainExceptions' )
693 $allowOrigin = $originHeader;
694 $allowCredentials =
'true';
695 $allowTiming = $originHeader;
698 if ( $matchOrigin ) {
699 $requestedMethod =
$request->getHeader(
'Access-Control-Request-Method' );
700 $preflight =
$request->getMethod() ===
'OPTIONS' && $requestedMethod !==
false;
703 if ( $requestedMethod !==
'POST' && $requestedMethod !==
'GET' ) {
708 $requestedHeaders =
$request->getHeader(
'Access-Control-Request-Headers' );
709 if ( $requestedHeaders !==
false ) {
710 if ( !self::matchRequestedHeaders( $requestedHeaders ) ) {
713 $response->header(
'Access-Control-Allow-Headers: ' . $requestedHeaders );
717 $response->header(
'Access-Control-Allow-Methods: POST, GET' );
720 $response->header(
"Access-Control-Allow-Origin: $allowOrigin" );
721 $response->header(
"Access-Control-Allow-Credentials: $allowCredentials" );
723 if ( $allowTiming !==
false ) {
724 $response->header(
"Timing-Allow-Origin: $allowTiming" );
729 'Access-Control-Expose-Headers: MediaWiki-API-Error, Retry-After, X-Database-Lag'
735 $this->
getOutput()->addVaryHeader(
'Origin' );
750 foreach ( $rules
as $rule ) {
751 if ( preg_match( self::wildcardToRegex( $rule ),
$value ) ) {
753 foreach ( $exceptions
as $exc ) {
754 if ( preg_match( self::wildcardToRegex( $exc ),
$value ) ) {
774 if ( trim( $requestedHeaders ) ===
'' ) {
777 $requestedHeaders = explode(
',', $requestedHeaders );
778 $allowedAuthorHeaders = array_flip( [
791 foreach ( $requestedHeaders
as $rHeader ) {
792 $rHeader = strtolower( trim( $rHeader ) );
793 if ( !isset( $allowedAuthorHeaders[$rHeader] ) ) {
794 wfDebugLog(
'api',
'CORS preflight failed on requested header: ' . $rHeader );
810 $wildcard = preg_quote( $wildcard,
'/' );
811 $wildcard = str_replace(
817 return "/^https?:\/\/$wildcard$/";
829 $out->addVaryHeader(
'Treat-as-Untrusted' );
833 if ( $config->get(
'VaryOnXFP' ) ) {
834 $out->addVaryHeader(
'X-Forwarded-Proto' );
837 if ( !$isError && $this->mModule &&
840 $etag = $this->mModule->getConditionalRequestData(
'etag' );
841 if ( $etag !== null ) {
844 $lastMod = $this->mModule->getConditionalRequestData(
'last-modified' );
845 if ( $lastMod !== null ) {
857 if ( isset( $this->mCacheControl[
'max-age'] ) ) {
858 $maxage = $this->mCacheControl[
'max-age'];
859 } elseif ( ( $this->mModule && !$this->mModule->isWriteMode() ) ||
860 $this->mCacheMode !==
'private'
864 $privateCache =
'private, must-revalidate, max-age=' . $maxage;
866 if ( $this->mCacheMode ==
'private' ) {
867 $response->header(
"Cache-Control: $privateCache" );
871 $useKeyHeader = $config->get(
'UseKeyHeader' );
872 if ( $this->mCacheMode ==
'anon-public-user-private' ) {
873 $out->addVaryHeader(
'Cookie' );
875 if ( $useKeyHeader ) {
877 if (
$out->haveCacheVaryCookies() ) {
879 $response->header(
"Cache-Control: $privateCache" );
883 } elseif (
MediaWiki\Session\SessionManager::getGlobalSession()->isPersistent() ) {
886 $response->header(
"Cache-Control: $privateCache" );
894 if ( $useKeyHeader ) {
899 if ( !isset( $this->mCacheControl[
's-maxage'] ) ) {
900 $this->mCacheControl[
's-maxage'] = $this->
getParameter(
'smaxage' );
902 if ( !isset( $this->mCacheControl[
'max-age'] ) ) {
903 $this->mCacheControl[
'max-age'] = $this->
getParameter(
'maxage' );
906 if ( !$this->mCacheControl[
's-maxage'] && !$this->mCacheControl[
'max-age'] ) {
910 $response->header(
"Cache-Control: $privateCache" );
915 $this->mCacheControl[
'public'] =
true;
918 $maxAge = min( $this->mCacheControl[
's-maxage'], $this->mCacheControl[
'max-age'] );
919 $expiryUnixTime = ( $maxAge == 0 ? 1 : time() + $maxAge );
926 if ( is_bool(
$value ) ) {
928 $ccHeader .= $separator .
$name;
932 $ccHeader .= $separator .
"$name=$value";
937 $response->header(
"Cache-Control: $ccHeader" );
944 if ( !isset( $this->mPrinter ) ) {
946 if ( !$this->mModuleMgr->isDefined(
$value,
'format' ) ) {
947 $value = self::API_DEFAULT_FORMAT;
954 if ( !$this->mPrinter->canPrintErrors() ) {
972 $errMessage =
$e->getMessageArray();
976 if ( (
$e instanceof
DBQueryError ) && !$config->get(
'ShowSQLErrors' ) ) {
977 $info =
'Database query error';
979 $info =
"Exception Caught: {$e->getMessage()}";
983 'code' =>
'internal_api_error_' . get_class(
$e ),
1007 if ( $config->get(
'ShowExceptionDetails' ) ) {
1017 $warnings =
$result->getResultData( [
'warnings' ] );
1022 if ( !is_null( $requestid ) ) {
1025 if ( $config->get(
'ShowHostnames' ) ) {
1029 if ( $warnings !== null ) {
1035 return $errMessage[
'code'];
1046 if ( !is_null( $requestid ) ) {
1047 $result->addValue( null,
'requestid', $requestid );
1050 if ( $this->
getConfig()->
get(
'ShowHostnames' ) ) {
1064 $this->mAction =
$params[
'action'];
1066 if ( !is_string( $this->mAction ) ) {
1067 $this->
dieUsage(
'The API requires a valid action parameter',
'unknown_action' );
1081 $module = $this->mModuleMgr->getModule( $this->mAction,
'action' );
1082 if ( $module === null ) {
1083 $this->
dieUsage(
'The API requires a valid action parameter',
'unknown_action' );
1085 $moduleParams = $module->extractRequestParams();
1088 if ( $module->needsToken() ===
true ) {
1090 "Module '{$module->getModuleName()}' must be updated for the new token handling. " .
1091 'See documentation for ApiBase::needsToken for details.'
1094 if ( $module->needsToken() ) {
1095 if ( !$module->mustBePosted() ) {
1097 "Module '{$module->getModuleName()}' must require POST to use tokens."
1101 if ( !isset( $moduleParams[
'token'] ) ) {
1102 $this->
dieUsageMsg( [
'missingparam',
'token' ] );
1105 $module->requirePostedParameters( [
'token' ] );
1107 if ( !$module->validateToken( $moduleParams[
'token'], $moduleParams ) ) {
1122 if ( $module->shouldCheckMaxlag() && isset(
$params[
'maxlag'] ) ) {
1125 if ( $lag > $maxLag ) {
1128 $response->header(
'Retry-After: ' . max( intval( $maxLag ), 5 ) );
1129 $response->header(
'X-Database-Lag: ' . intval( $lag ) );
1131 if ( $this->
getConfig()->
get(
'ShowHostnames' ) ) {
1132 $this->
dieUsage(
"Waiting for $host: $lag seconds lagged",
'maxlag' );
1135 $this->
dieUsage(
"Waiting for a database server: $lag seconds lagged",
'maxlag' );
1164 if ( $this->mInternalMode ) {
1169 if ( $this->
getRequest()->getMethod() !==
'GET' && $this->
getRequest()->getMethod() !==
'HEAD' ) {
1176 $ifNoneMatch = array_diff(
1180 if ( $ifNoneMatch ) {
1181 if ( $ifNoneMatch === [
'*' ] ) {
1185 $etag = $module->getConditionalRequestData(
'etag' );
1188 if ( $ifNoneMatch && $etag !== null ) {
1189 $test = substr( $etag, 0, 2 ) ===
'W/' ? substr( $etag, 2 ) : $etag;
1190 $match = array_map(
function (
$s ) {
1191 return substr(
$s, 0, 2 ) ===
'W/' ? substr(
$s, 2 ) :
$s;
1193 $return304 = in_array( $test, $match,
true );
1200 $i = strpos(
$value,
';' );
1201 if ( $i !==
false ) {
1212 $ts->format(
'l, d-M-y H:i:s' ) .
' GMT' ===
$value ||
1214 $ts->format(
'D M j H:i:s Y' ) ===
$value ||
1215 $ts->format(
'D M j H:i:s Y' ) ===
$value
1217 $lastMod = $module->getConditionalRequestData(
'last-modified' );
1218 if ( $lastMod !== null ) {
1222 'user' => $this->
getUser()->getTouched(),
1223 'epoch' => $this->
getConfig()->get(
'CacheEpoch' ),
1225 if ( $this->
getConfig()->
get(
'UseSquid' ) ) {
1232 $lastMod = max( $modifiedTimes );
1243 $this->
getRequest()->response()->statusHeader( 304 );
1246 MediaWiki\suppressWarnings();
1247 ini_set(
'zlib.output_compression', 0 );
1248 MediaWiki\restoreWarnings();
1264 !
$user->isAllowed(
'read' )
1269 if ( $module->isWriteMode() ) {
1270 if ( !$this->mEnableWrite ) {
1272 } elseif ( !
$user->isAllowed(
'writeapi' ) ) {
1274 } elseif ( $this->
getRequest()->getHeader(
'Promise-Non-Write-API-Action' ) ) {
1276 'Promise-Non-Write-API-Action HTTP header cannot be sent to write API modules',
1277 'promised-nonwrite-api'
1286 if ( !
Hooks::run(
'ApiCheckCanExecute', [ $module,
$user, &$message ] ) ) {
1300 if ( $module->isWriteMode()
1302 &&
wfGetLB()->getServerCount() > 1
1314 $lagLimit = $this->
getConfig()->get(
'APIMaxLagThreshold' );
1315 $laggedServers = [];
1317 foreach ( $loadBalancer->getLagTimes()
as $serverIndex => $lag ) {
1318 if ( $lag > $lagLimit ) {
1320 $laggedServers[] = $loadBalancer->getServerName( $serverIndex ) .
" ({$lag}s)";
1325 $replicaCount =
wfGetLB()->getServerCount() - 1;
1326 if ( $numLagged >= ceil( $replicaCount / 2 ) ) {
1327 $laggedServers = implode(
', ', $laggedServers );
1330 "Api request failed as read only because the following DBs are lagged: $laggedServers"
1333 $parsed = $this->
parseMsg( [
'readonlytext' ] );
1339 [
'readonlyreason' =>
"Waiting for $numLagged lagged database(s)" ]
1349 if ( isset(
$params[
'assert'] ) ) {
1351 switch (
$params[
'assert'] ) {
1353 if (
$user->isAnon() ) {
1354 $this->
dieUsage(
'Assertion that the user is logged in failed',
'assertuserfailed' );
1358 if ( !
$user->isAllowed(
'bot' ) ) {
1359 $this->
dieUsage(
'Assertion that the user has the bot right failed',
'assertbotfailed' );
1364 if ( isset(
$params[
'assertuser'] ) ) {
1366 if ( !$assertUser || !$this->
getUser()->equals( $assertUser ) ) {
1368 'Assertion that the user is "' .
$params[
'assertuser'] .
'" failed',
1369 'assertnameduserfailed'
1382 if ( !
$request->wasPosted() && $module->mustBePosted() ) {
1389 $this->mPrinter = $module->getCustomPrinter();
1390 if ( is_null( $this->mPrinter ) ) {
1395 if (
$request->getProtocol() ===
'http' && (
1396 $request->getSession()->shouldForceHTTPS() ||
1397 ( $this->
getUser()->isLoggedIn() &&
1398 $this->
getUser()->requiresHTTPS() )
1401 $this->
setWarning(
'HTTP used when HTTPS was expected' );
1411 $this->mModule = $module;
1413 if ( !$this->mInternalMode ) {
1427 if ( !$this->mInternalMode ) {
1435 Hooks::run(
'APIAfterExecute', [ &$module ] );
1439 if ( !$this->mInternalMode ) {
1453 $limits = $this->
getConfig()->get(
'TrxProfilerLimits' );
1455 $trxProfiler->setLogger( LoggerFactory::getInstance(
'DBPerformance' ) );
1456 if ( $this->
getRequest()->hasSafeMethod() ) {
1457 $trxProfiler->setExpectations( $limits[
'GET'], __METHOD__ );
1459 $trxProfiler->setExpectations( $limits[
'POST-nonwrite'], __METHOD__ );
1462 $trxProfiler->setExpectations( $limits[
'POST'], __METHOD__ );
1478 'timeSpentBackend' => (int) round(
$time * 1000 ),
1479 'hadError' =>
$e !== null,
1489 $msg =
"API {$request->getMethod()} " .
1491 " {$logCtx['ip']} " .
1492 "T={$logCtx['timeSpentBackend']}ms";
1500 if ( strlen(
$value ) > 256 ) {
1508 $msg .=
" {$name}={$encValue}";
1513 wfDebugLog(
'ApiAction',
'',
'private', $logCtx );
1524 $chars =
';@$!*(),/:';
1525 $numChars = strlen( $chars );
1526 for ( $i = 0; $i < $numChars; $i++ ) {
1527 $table[rawurlencode( $chars[$i] )] = $chars[$i];
1531 return strtr( rawurlencode(
$s ), $table );
1539 return array_keys( $this->mParamsUsed );
1547 $this->mParamsUsed += array_fill_keys( (
array)
$params,
true );
1557 $this->mParamsUsed[
$name] =
true;
1560 if (
$ret === null ) {
1565 "Parameter '$name' uses unsupported PHP array syntax"
1591 $this->mParamsUsed[
$name] =
true;
1602 $allParams = $this->
getRequest()->getValueNames();
1604 if ( !$this->mInternalMode ) {
1606 $printerParams = array_map(
1607 [ $this->mPrinter,
'encodeParamName' ],
1608 array_keys( $this->mPrinter->getFinalParams() ?: [] )
1610 $unusedParams = array_diff( $allParams, $paramsUsed, $printerParams );
1612 $unusedParams = array_diff( $allParams, $paramsUsed );
1615 if ( count( $unusedParams ) ) {
1616 $s = count( $unusedParams ) > 1 ?
's' :
'';
1617 $this->
setWarning(
"Unrecognized parameter$s: '" . implode( $unusedParams,
"', '" ) .
"'" );
1627 if ( $this->
getConfig()->
get(
'DebugAPI' ) !==
false ) {
1628 $this->
setWarning(
'SECURITY WARNING: $wgDebugAPI is enabled' );
1633 $printer->execute();
1634 $printer->closePrinter();
1660 ApiBase::PARAM_TYPE =>
'integer'
1663 ApiBase::PARAM_TYPE =>
'integer',
1667 ApiBase::PARAM_TYPE =>
'integer',
1671 ApiBase::PARAM_TYPE => [
'user',
'bot' ]
1674 ApiBase::PARAM_TYPE =>
'user',
1676 'requestid' => null,
1677 'servedby' =>
false,
1678 'curtimestamp' =>
false,
1690 =>
'apihelp-help-example-main',
1691 'action=help&recursivesubmodules=1'
1692 =>
'apihelp-help-example-recursive',
1701 foreach ( $oldHelp
as $k => $v ) {
1702 if ( $k ===
'submodules' ) {
1703 $help[
'permissions'] =
'';
1707 $help[
'datatypes'] =
'';
1708 $help[
'credits'] =
'';
1712 [
'class' =>
'apihelp-block apihelp-permissions' ] );
1713 $m = $this->
msg(
'api-help-permissions' );
1714 if ( !$m->isDisabled() ) {
1715 $help[
'permissions'] .=
Html::rawElement(
'div', [
'class' =>
'apihelp-block-head' ],
1716 $m->numParams( count( self::$mRights ) )->parse()
1720 foreach ( self::$mRights
as $right => $rightMsg ) {
1721 $help[
'permissions'] .=
Html::element(
'dt', null, $right );
1723 $rightMsg = $this->
msg( $rightMsg[
'msg'], $rightMsg[
'params'] )->parse();
1726 $groups = array_map(
function ( $group ) {
1727 return $group ==
'*' ?
'all' : $group;
1731 $this->
msg(
'api-help-permissions-granted-to' )
1732 ->numParams( count( $groups ) )
1733 ->params( $this->
getLanguage()->commaList( $groups ) )
1741 if ( empty( $options[
'nolead'] ) ) {
1742 $level = $options[
'headerlevel'];
1743 $tocnumber = &$options[
'tocnumber'];
1745 $header = $this->
msg(
'api-help-datatypes-header' )->parse();
1748 if ( !$this->
getConfig()->
get(
'ExperimentalHtmlIds' ) ) {
1753 [
'id' =>
'main/datatypes',
'class' =>
'apihelp-header' ],
1756 $help[
'datatypes'] .= $this->
msg(
'api-help-datatypes' )->parseAsBlock();
1757 if ( !isset( $tocData[
'main/datatypes'] ) ) {
1758 $tocnumber[$level]++;
1759 $tocData[
'main/datatypes'] = [
1760 'toclevel' => count( $tocnumber ),
1762 'anchor' =>
'main/datatypes',
1764 'number' => implode(
'.', $tocnumber ),
1770 if ( !$this->
getConfig()->
get(
'ExperimentalHtmlIds' ) ) {
1774 $header = $this->
msg(
'api-credits-header' )->parse();
1776 [
'id' =>
'main/credits',
'class' =>
'apihelp-header' ],
1779 $help[
'credits'] .= $this->
msg(
'api-credits' )->useDatabase(
false )->parseAsBlock();
1780 if ( !isset( $tocData[
'main/credits'] ) ) {
1781 $tocnumber[$level]++;
1782 $tocData[
'main/credits'] = [
1783 'toclevel' => count( $tocnumber ),
1785 'anchor' =>
'main/credits',
1787 'number' => implode(
'.', $tocnumber ),
1801 if ( !isset( $this->mCanApiHighLimits ) ) {
1802 $this->mCanApiHighLimits = $this->
getUser()->isAllowed(
'apihighlimits' );
1826 $this->
getRequest()->getHeader(
'Api-user-agent' ) .
' ' .
1827 $this->
getRequest()->getHeader(
'User-agent' )
1853 parent::__construct( $message,
$code );
1854 $this->mCodestr = $codestr;
1855 $this->mExtraData = $extradata;
1859 if ( !is_string( $codestr ) || $codestr ===
'' ) {
1861 ( $codestr ===
'' ?
'empty string' : gettype( $codestr ) )
1879 'info' => $this->getMessage()
1881 if ( is_array( $this->mExtraData ) ) {
1892 return "{$this->getCodeString()}: {$this->getMessage()}";
static newFromName($name, $validate= 'valid')
Static factory method for creation from username.
dieUsageMsgOrDebug($error)
Will only set a warning instead of failing if the global $wgDebugAPI is set to true.
setContext(IContextSource $context)
Set the IContextSource object.
getAllowedParams()
See ApiBase for description.
static closeElement($element)
Returns "$element>".
getModuleManager()
Overrides to return this instance's module manager.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
getStats()
Get the Stats object.
getUserAgent()
Fetches the user agent used for this request.
const LIMIT_BIG2
Fast query, apihighlimits limit.
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
getContinuationManager()
Get the continuation manager.
static $Modules
List of available modules: action name => module class.
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
Database error base class.
printResult($isError)
Print results using the current printer.
checkConditionalRequestHeaders($module)
Check selected RFC 7232 precondition headers.
the array() calling protocol came about after MediaWiki 1.4rc1.
getLanguage()
Get the Language object.
static getRequestId()
Get the unique request ID.
wfScript($script= 'index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
executeActionWithErrorHandling()
Execute an action, and in case of an error, erase whatever partial results have been accumulated...
getParameter($paramName, $parseLimit=true)
Get a value for the given parameter.
modifyHelp(array &$help, array $options, array &$tocData)
__construct($context=null, $enableWrite=false)
Constructs an instance of ApiMain that utilizes the module and format specified by $request...
processing should stop and the error should be shown to the user * false
This class holds a list of modules and handles instantiation.
checkReadOnly($module)
Check if the DB is read-only for this user.
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
bool null $lacksSameOriginSecurity
Cached return value from self::lacksSameOriginSecurity()
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
static instance()
Singleton.
static rawElement($element, $attribs=[], $contents= '')
Returns an HTML element in a string.
wfHostname()
Fetch server name for use in error reporting etc.
An IContextSource implementation which will inherit context from another source but allow individual ...
static matchRequestedHeaders($requestedHeaders)
Attempt to validate the value of Access-Control-Request-Headers against a list of headers that we all...
static static static ApiFormatBase $mPrinter
setCacheMaxAge($maxage)
Set how long the response should be cached.
const TS_RFC2822
RFC 2822 format, for E-mail and HTTP headers.
This manages continuation state.
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
isInternalMode()
Return true if the API was started by other PHP code using FauxRequest.
const GETHEADER_LIST
Flag to make WebRequest::getHeader return an array of values.
canApiHighLimits()
Check whether the current user is allowed to use high limits.
wfUrlencode($s)
We want some things to be included as literal characters in our title URLs for prettiness, which urlencode encodes by default.
this hook is for auditing only $response
when a variable name is used in a it is silently declared as a new local masking the global
wfExpandUrl($url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
static handleApiBeforeMainException(Exception $e)
Handle an exception from the ApiBeforeMain hook.
static setContentValue(array &$arr, $name, $value, $flags=0)
Add an output value to the array by name and mark as META_CONTENT.
const API_DEFAULT_FORMAT
When no format parameter is given, this format will be used.
const TS_ISO_8601
ISO 8601 format with no timezone: 1986-02-09T20:00:00Z.
setCacheMode($mode)
Set the type of caching headers which will be sent.
static static static $mRights
List of user roles that are specifically relevant to the API.
setupExternalResponse($module, $params)
Check POST for external response and setup result printer.
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
setCacheControl($directives)
Set directives (key/value pairs) for the Cache-Control header.
errorMessageFromException($e)
Create an error message for the given exception.
static isEveryoneAllowed($right)
Check if all users may be assumed to have the given permission.
static sanitizeLangCode($code)
Accepts a language code and ensures it's sane.
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 $wgLang
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message.Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item.Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page.Return false to stop further processing of the tag $reader:XMLReader object &$pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision.Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag.Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload.Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports.&$fullInterwikiPrefix:Interwiki prefix, may contain colons.&$pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable.Can be used to lazy-load the import sources list.&$importSources:The value of $wgImportSources.Modify as necessary.See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page.$context:IContextSource object &$pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect.&$title:Title object for the current page &$request:WebRequest &$ignoreRedirect:boolean to skip redirect check &$target:Title/string of redirect target &$article:Article object 'InternalParseBeforeLinks':during Parser's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InternalParseBeforeSanitize':during Parser's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings.Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not.Return true without providing an interwiki to continue interwiki search.$prefix:interwiki prefix we are looking for.&$iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user's email has been invalidated successfully.$user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification.Callee may modify $url and $query, URL will be constructed as $url.$query &$url:URL to index.php &$query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) &$article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() &$ip:IP being check &$result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from &$allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn't match your organization.$addr:The e-mail address entered by the user &$result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user &$result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we're looking for a messages file for &$file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces.Do not use this hook to add namespaces.Use CanonicalNamespaces for that.&$namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names.&$names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page's language links.This is called in various places to allow extensions to define the effective language links for a page.$title:The page's Title.&$links:Associative array mapping language codes to prefixed links of the form"language:title".&$linkFlags:Associative array mapping prefixed links to arrays of flags.Currently unused, but planned to provide support for marking individual language links in the UI, e.g.for featured articles. 'LanguageSelector':Hook to change the language selector available on a page.$out:The output page.$cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED!Use HtmlPageLinkRendererBegin instead.Used when generating internal and interwiki links in Linker::link(), before processing starts.Return false to skip default processing and return $ret.See documentation for Linker::link() for details on the expected meanings of parameters.$skin:the Skin object $target:the Title that the link is pointing to &$html:the contents that the< a > tag should have(raw HTML) $result
setupModule()
Set up the module for response.
usually copyright or history_copyright This message must be in HTML not wikitext & $link
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
getRequest()
Get the WebRequest object.
static wildcardToRegex($wildcard)
Helper function to convert wildcard string into a regex '*' => '.
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 true
wfDebugLog($logGroup, $text, $dest= 'all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
msg()
Get a Message object with context set Parameters are the same as wfMessage()
setRequestExpectations(ApiBase $module)
Set database connection, query, and write expectations given this module request. ...
static openElement($element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
wfGetLB($wiki=false)
Get a load balancer object.
wfReadOnly()
Check whether the wiki is in read-only mode.
static getMain()
Static methods.
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 $options
getConfig()
Get the Config object.
const LIMIT_SML2
Slow query, apihighlimits limit.
getContext()
Get the base IContextSource object.
This is the main API class, used for both external and internal processing.
executeAction()
Execute the actual module, without any error handling.
handleCORS()
Check the &origin= query parameter against the Origin: HTTP header and respond appropriately.
setupExecuteAction()
Set up for the execution.
const TS_MW
MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
lacksSameOriginSecurity()
Get the security flag for the current request.
const NO_SIZE_CHECK
For addValue() and similar functions, do not check size while adding a value Don't use this unless yo...
createPrinterByName($format)
Create an instance of an output formatter by its name.
static dieReadOnly()
Helper function for readonly errors.
static matchOrigin($value, $rules, $exceptions)
Attempt to match an Origin header against a set of rules and a set of exceptions. ...
This class represents the result of the API operations.
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
encodeRequestLogValue($s)
Encode a value in a format suitable for a space-separated log line.
checkMaxLag($module, $params)
Check the max lag if necessary.
setWarning($warning)
Set warning section for this module.
static getRedactedTraceAsString($e)
Generate a string representation of an exception's stack trace.
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 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 modifiable & $code
static static $Formats
List of available formats: format name => format class.
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
getParamsUsed()
Get the request parameters used in the course of the preceding execute() request. ...
logRequest($time, $e=null)
Log the preceding request.
getErrorFormatter()
Get the ApiErrorFormatter object associated with current request.
static rollbackMasterChangesAndLog($e)
If there are any open database transactions, roll them back and log the stack trace of the exception ...
static escapeId($id, $options=[])
Given a value, escape it so that it can be used in an id attribute and return it. ...
getUpload($name)
Get a request upload, and register the fact that it was used, for logging.
markParamsUsed($params)
Mark parameters as used.
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
checkBotReadOnly()
Check whether we are readonly for bots.
getModule()
Get the API module object.
error also a ContextSource you ll probably need to make sure the header is varied on $request
static appendDebugInfoToApiResult(IContextSource $context, ApiResult $result)
Append the debug info to given ApiResult.
reportUnusedParams()
Report unused parameters, so the client gets a hint in case it gave us parameters we don't know...
wfClearOutputBuffers()
More legible than passing a 'false' parameter to wfResetOutputBuffers():
dieUsage($description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
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
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
This abstract class implements many basic API functions, and is the base of all API classes...
getPrinter()
Get the result formatter object.
checkAsserts($params)
Check asserts of the user's rights.
parseMsg($error)
Return the error message related to a certain array.
static logException($e)
Log an exception to the exception log (if enabled).
getCheck($name)
Get a boolean request value, and register the fact that the parameter was used, for logging...
logFeatureUsage($feature)
Write logging information for API features to a debug log, for usage analysis.
sendCacheHeaders($isError)
Send caching headers.
getVal($name, $default=null)
Get a request value, and register the fact that it was used, for logging.
__construct($message, $codestr, $code=0, $extradata=null)
static element($element, $attribs=[], $contents= '')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
getUser()
Get the User object.
substituteResultWithError($e)
Replace the result data with the information about an exception.
Library for creating and parsing MW-style timestamps.
dieUsageMsg($error)
Output the error message related to a certain array.
see documentation in includes Linker php for Linker::makeImageLink & $time
static getGroupsWithPermission($role)
Get all the groups who have a given permission.
execute()
Execute api request.
This exception will be thrown when dieUsage is called to stop module execution.
getResult()
Get the ApiResult object associated with current request.
checkExecutePermissions($module)
Check for sufficient permissions to execute.
createErrorPrinter()
Create the printer for error output.
isWriteMode()
Indicates whether this module requires write mode.
ApiContinuationManager null $mContinuationManager
setContinuationManager($manager)
Set the continuation manager.
getOutput()
Get the OutputPage object.
Allows to change the fields on the form that will be generated $name
handleException(Exception $e)
Handle an exception as an API response.