Go to the documentation of this file.
26 use Wikimedia\Timestamp\TimestampException;
134 'msg' =>
'right-writeapi',
138 'msg' =>
'api-help-right-apihighlimits',
192 parent::__construct( $this, $this->mInternalMode ?
'main_int' :
'main' );
196 if ( !$this->mInternalMode ) {
199 $originHeader =
$request->getHeader(
'Origin' );
200 if ( $originHeader ===
false ) {
203 $originHeader = trim( $originHeader );
204 $origins = preg_split(
'/\s+/', $originHeader );
206 $sessionCookies = array_intersect(
207 array_keys( $_COOKIE ),
208 MediaWiki\Session\SessionManager::singleton()->getVaryCookies()
210 if ( $origins && $sessionCookies && (
211 count( $origins ) !== 1 || !self::matchOrigin(
213 $config->get(
'CrossSiteAJAXdomains' ),
214 $config->get(
'CrossSiteAJAXdomainExceptions' )
217 LoggerFactory::getInstance(
'cors' )->warning(
218 'Non-whitelisted CORS request with session cookies', [
219 'origin' => $originHeader,
220 'cookies' => $sessionCookies,
232 wfDebug(
"API: stripping user credentials when the same-origin policy is not applied\n" );
233 $wgUser =
new User();
235 $request->response()->header(
'MediaWiki-Login-Suppressed: true' );
243 $uselang =
$request->getVal(
'uselang', self::API_DEFAULT_USELANG );
244 if ( $uselang ===
'user' ) {
248 if ( $uselang ===
'content' ) {
254 if ( !$this->mInternalMode ) {
263 $errorFormat =
$request->getVal(
'errorformat',
'bc' );
264 $errorLangCode =
$request->getVal(
'errorlang',
'uselang' );
265 $errorsUseDB =
$request->getCheck(
'errorsuselocal' );
266 if ( in_array( $errorFormat, [
'plaintext',
'wikitext',
'html',
'raw',
'none' ],
true ) ) {
267 if ( $errorLangCode ===
'uselang' ) {
269 } elseif ( $errorLangCode ===
'content' ) {
277 $this->mResult, $errorLang, $errorFormat, $errorsUseDB
285 $this->mModuleMgr->addModules( self::$Modules,
'action' );
286 $this->mModuleMgr->addModules( $config->get(
'APIModules' ),
'action' );
287 $this->mModuleMgr->addModules( self::$Formats,
'format' );
288 $this->mModuleMgr->addModules( $config->get(
'APIFormatModules' ),
'format' );
290 Hooks::run(
'ApiMain::moduleManager', [ $this->mModuleMgr ] );
292 $this->mContinuationManager =
null;
293 $this->mEnableWrite = $enableWrite;
295 $this->mSquidMaxage = -1;
296 $this->mCommit =
false;
328 if (
$request->getVal(
'callback' ) !== null ) {
334 if (
$request->getVal(
'origin' ) ===
'*' ) {
341 if (
$request->getHeader(
'Treat-as-Untrusted' ) !==
false ) {
372 if ( $manager !==
null && $this->mContinuationManager !==
null ) {
373 throw new UnexpectedValueException(
374 __METHOD__ .
': tried to set manager from ' . $manager->getSource() .
375 ' when a manager is already set from ' . $this->mContinuationManager->getSource()
378 $this->mContinuationManager = $manager;
406 'max-age' => $maxage,
407 's-maxage' => $maxage
437 if ( !in_array( $mode, [
'private',
'public',
'anon-public-user-private' ] ) ) {
438 wfDebug( __METHOD__ .
": unrecognised cache mode \"$mode\"\n" );
446 if ( $mode !==
'private' ) {
447 wfDebug( __METHOD__ .
": ignoring request for $mode cache mode, private wiki\n" );
453 if ( $mode ===
'public' && $this->
getParameter(
'uselang' ) ===
'user' ) {
458 wfDebug( __METHOD__ .
": downgrading cache mode 'public' to " .
459 "'anon-public-user-private' due to uselang=user\n" );
460 $mode =
'anon-public-user-private';
463 wfDebug( __METHOD__ .
": setting cache mode $mode\n" );
464 $this->mCacheMode = $mode;
489 $printer = $this->mModuleMgr->getModule( $format,
'format' );
490 if ( $printer ===
null ) {
503 if ( $this->mInternalMode ) {
523 if ( $this->
getRequest()->getMethod() ===
'OPTIONS' ) {
529 $obLevel = ob_get_level();
532 $t = microtime(
true );
536 $runTime = microtime(
true ) -
$t;
538 if ( $this->mModule->isWriteMode() && $this->
getRequest()->wasPosted() ) {
539 MediaWikiServices::getInstance()->getStatsdDataFactory()->timing(
540 'api.' . $this->mModule->getModuleName() .
'.executeTiming', 1000 * $runTime
543 }
catch ( Exception
$e ) {
558 while ( ob_get_level() > $obLevel ) {
589 $headerStr =
'MediaWiki-API-Error: ' . implode(
', ', $errCodes );
605 $this->
addWarning(
'apiwarn-errorprinterfailed' );
608 $this->mPrinter->addWarning( $error );
609 }
catch ( Exception $ex2 ) {
619 [
'apiwarn-errorprinterfailed-ex', $ex->getMessage() ],
'errorprinterfailed'
623 $this->mPrinter =
null;
625 $this->mPrinter->forceDefaultParams();
626 if (
$e->getCode() ) {
648 $main->handleException(
$e );
649 $main->logRequest( 0,
$e );
650 }
catch ( Exception $e2 ) {
656 $main->sendCacheHeaders(
true );
677 if ( $originParam ===
null ) {
685 $matchedOrigin =
false;
686 $allowTiming =
false;
689 if ( $originParam ===
'*' ) {
695 $matchedOrigin =
true;
697 $allowCredentials =
'false';
703 $originHeader =
$request->getHeader(
'Origin' );
704 if ( $originHeader ===
false ) {
707 $originHeader = trim( $originHeader );
708 $origins = preg_split(
'/\s+/', $originHeader );
711 if ( !in_array( $originParam, $origins ) ) {
715 $response->header(
'Cache-Control: no-cache' );
716 echo
"'origin' parameter does not match Origin header\n";
724 $config->get(
'CrossSiteAJAXdomains' ),
725 $config->get(
'CrossSiteAJAXdomainExceptions' )
728 $allowOrigin = $originHeader;
729 $allowCredentials =
'true';
730 $allowTiming = $originHeader;
733 if ( $matchedOrigin ) {
734 $requestedMethod =
$request->getHeader(
'Access-Control-Request-Method' );
735 $preflight =
$request->getMethod() ===
'OPTIONS' && $requestedMethod !==
false;
738 if ( $requestedMethod !==
'POST' && $requestedMethod !==
'GET' ) {
740 $response->header(
'MediaWiki-CORS-Rejection: Unsupported method requested in preflight' );
744 $requestedHeaders =
$request->getHeader(
'Access-Control-Request-Headers' );
745 if ( $requestedHeaders !==
false ) {
746 if ( !self::matchRequestedHeaders( $requestedHeaders ) ) {
747 $response->header(
'MediaWiki-CORS-Rejection: Unsupported header requested in preflight' );
750 $response->header(
'Access-Control-Allow-Headers: ' . $requestedHeaders );
754 $response->header(
'Access-Control-Allow-Methods: POST, GET' );
755 } elseif (
$request->getMethod() !==
'POST' &&
$request->getMethod() !==
'GET' ) {
758 'MediaWiki-CORS-Rejection: Unsupported method for simple request or actual request'
763 $response->header(
"Access-Control-Allow-Origin: $allowOrigin" );
764 $response->header(
"Access-Control-Allow-Credentials: $allowCredentials" );
766 if ( $allowTiming !==
false ) {
767 $response->header(
"Timing-Allow-Origin: $allowTiming" );
772 'Access-Control-Expose-Headers: MediaWiki-API-Error, Retry-After, X-Database-Lag, '
773 .
'MediaWiki-Login-Suppressed'
777 $response->header(
'MediaWiki-CORS-Rejection: Origin mismatch' );
781 $this->
getOutput()->addVaryHeader(
'Origin' );
796 foreach ( $rules
as $rule ) {
797 if ( preg_match( self::wildcardToRegex( $rule ),
$value ) ) {
799 foreach ( $exceptions
as $exc ) {
800 if ( preg_match( self::wildcardToRegex( $exc ),
$value ) ) {
820 if ( trim( $requestedHeaders ) ===
'' ) {
823 $requestedHeaders = explode(
',', $requestedHeaders );
824 $allowedAuthorHeaders = array_flip( [
837 foreach ( $requestedHeaders
as $rHeader ) {
838 $rHeader = strtolower( trim( $rHeader ) );
839 if ( !isset( $allowedAuthorHeaders[$rHeader] ) ) {
840 wfDebugLog(
'api',
'CORS preflight failed on requested header: ' . $rHeader );
856 $wildcard = preg_quote( $wildcard,
'/' );
857 $wildcard = str_replace(
863 return "/^https?:\/\/$wildcard$/";
875 $out->addVaryHeader(
'Treat-as-Untrusted' );
879 if ( $config->get(
'VaryOnXFP' ) ) {
880 $out->addVaryHeader(
'X-Forwarded-Proto' );
883 if ( !$isError && $this->mModule &&
886 $etag = $this->mModule->getConditionalRequestData(
'etag' );
887 if ( $etag !==
null ) {
890 $lastMod = $this->mModule->getConditionalRequestData(
'last-modified' );
891 if ( $lastMod !==
null ) {
903 if ( isset( $this->mCacheControl[
'max-age'] ) ) {
904 $maxage = $this->mCacheControl[
'max-age'];
905 } elseif ( ( $this->mModule && !$this->mModule->isWriteMode() ) ||
906 $this->mCacheMode !==
'private'
910 $privateCache =
'private, must-revalidate, max-age=' . $maxage;
912 if ( $this->mCacheMode ==
'private' ) {
913 $response->header(
"Cache-Control: $privateCache" );
917 $useKeyHeader = $config->get(
'UseKeyHeader' );
918 if ( $this->mCacheMode ==
'anon-public-user-private' ) {
919 $out->addVaryHeader(
'Cookie' );
921 if ( $useKeyHeader ) {
923 if (
$out->haveCacheVaryCookies() ) {
925 $response->header(
"Cache-Control: $privateCache" );
929 } elseif (
MediaWiki\Session\SessionManager::getGlobalSession()->isPersistent() ) {
932 $response->header(
"Cache-Control: $privateCache" );
940 if ( $useKeyHeader ) {
945 if ( !isset( $this->mCacheControl[
's-maxage'] ) ) {
946 $this->mCacheControl[
's-maxage'] = $this->
getParameter(
'smaxage' );
948 if ( !isset( $this->mCacheControl[
'max-age'] ) ) {
949 $this->mCacheControl[
'max-age'] = $this->
getParameter(
'maxage' );
952 if ( !$this->mCacheControl[
's-maxage'] && !$this->mCacheControl[
'max-age'] ) {
956 $response->header(
"Cache-Control: $privateCache" );
961 $this->mCacheControl[
'public'] =
true;
964 $maxAge = min( $this->mCacheControl[
's-maxage'], $this->mCacheControl[
'max-age'] );
965 $expiryUnixTime = ( $maxAge == 0 ? 1 : time() + $maxAge );
972 if ( is_bool(
$value ) ) {
974 $ccHeader .= $separator .
$name;
978 $ccHeader .= $separator .
"$name=$value";
983 $response->header(
"Cache-Control: $ccHeader" );
990 if ( !isset( $this->mPrinter ) ) {
992 if ( !$this->mModuleMgr->isDefined(
$value,
'format' ) ) {
1000 if ( !$this->mPrinter->canPrintErrors() ) {
1026 foreach (
$e->getStatusValue()->getErrorsByType(
$type )
as $error ) {
1029 } elseif (
$type !==
'error' ) {
1033 $data = Wikimedia\quietCall( [
$e,
'getMessageArray' ] );
1034 $code = $data[
'code'];
1035 $info = $data[
'info'];
1036 unset( $data[
'code'], $data[
'info'] );
1041 $class = preg_replace(
'#^Wikimedia\\\Rdbms\\\#',
'', get_class(
$e ) );
1042 $code =
'internal_api_error_' . $class;
1043 if ( (
$e instanceof
DBQueryError ) && !$config->get(
'ShowSQLErrors' ) ) {
1047 $msg =
$e->getMessageObject();
1049 $msg = Message::newFromSpecifier(
$e );
1072 $errors =
$result->getResultData( [
'errors' ] );
1073 $warnings =
$result->getResultData( [
'warnings' ] );
1075 if ( $warnings !==
null ) {
1078 if ( $errors !==
null ) {
1082 foreach ( $errors
as $error ) {
1083 if ( isset( $error[
'code'] ) ) {
1084 $errorCodes[$error[
'code']] =
true;
1092 $errorCodes[$msg->getApiCode()] =
true;
1093 $formatter->addError( $modulePath, $msg );
1096 $formatter->addWarning( $modulePath, $msg );
1102 $path = [
'error' ];
1112 $this->
msg(
'api-usage-docref',
$link )->inLanguage( $formatter->getLanguage() )->
text()
1114 . $this->
msg(
'api-usage-mailinglist-ref' )->inLanguage( $formatter->getLanguage() )->
text()
1118 if ( $config->get(
'ShowExceptionDetails' ) &&
1119 ( !
$e instanceof
DBError || $config->get(
'ShowDBErrorBacktrace' ) )
1124 $this->
msg(
'api-exception-trace',
1129 )->inLanguage( $formatter->getLanguage() )->
text()
1137 return array_keys( $errorCodes );
1149 if ( $requestid !==
null ) {
1153 if ( $this->
getConfig()->
get(
'ShowHostnames' ) && (
1154 in_array(
'servedby', $force,
true ) || $this->
getParameter(
'servedby' )
1180 $this->mAction =
$params[
'action'];
1193 $module = $this->mModuleMgr->getModule( $this->mAction,
'action' );
1194 if ( $module ===
null ) {
1198 [
'apierror-unknownaction',
wfEscapeWikiText( $this->mAction ) ],
'unknown_action'
1202 $moduleParams = $module->extractRequestParams();
1205 if ( $module->needsToken() ===
true ) {
1207 "Module '{$module->getModuleName()}' must be updated for the new token handling. " .
1208 'See documentation for ApiBase::needsToken for details.'
1211 if ( $module->needsToken() ) {
1212 if ( !$module->mustBePosted() ) {
1214 "Module '{$module->getModuleName()}' must require POST to use tokens."
1218 if ( !isset( $moduleParams[
'token'] ) ) {
1221 $module->dieWithError( [
'apierror-missingparam',
'token' ] );
1225 $module->requirePostedParameters( [
'token' ] );
1227 if ( !$module->validateToken( $moduleParams[
'token'], $moduleParams ) ) {
1228 $module->dieWithError(
'apierror-badtoken' );
1239 $dbLag = MediaWikiServices::getInstance()->getDBLoadBalancer()->getMaxLag();
1241 'host' => $dbLag[0],
1246 $jobQueueLagFactor = $this->
getConfig()->get(
'JobQueueIncludeInMaxLagFactor' );
1247 if ( $jobQueueLagFactor ) {
1250 $jobQueueLag = $totalJobs / (float)$jobQueueLagFactor;
1251 if ( $jobQueueLag > $lagInfo[
'lag'] ) {
1254 'lag' => $jobQueueLag,
1255 'type' =>
'jobqueue',
1256 'jobs' => $totalJobs,
1271 if ( $module->shouldCheckMaxlag() && isset(
$params[
'maxlag'] ) ) {
1274 if ( $lagInfo[
'lag'] > $maxLag ) {
1277 $response->header(
'Retry-After: ' . max( intval( $maxLag ), 5 ) );
1278 $response->header(
'X-Database-Lag: ' . intval( $lagInfo[
'lag'] ) );
1280 if ( $this->
getConfig()->
get(
'ShowHostnames' ) ) {
1282 [
'apierror-maxlag', $lagInfo[
'lag'], $lagInfo[
'host'] ],
1288 $this->
dieWithError( [
'apierror-maxlag-generic', $lagInfo[
'lag'] ],
'maxlag', $lagInfo );
1317 if ( $this->mInternalMode ) {
1322 if ( $this->
getRequest()->getMethod() !==
'GET' && $this->
getRequest()->getMethod() !==
'HEAD' ) {
1329 $ifNoneMatch = array_diff(
1333 if ( $ifNoneMatch ) {
1334 if ( $ifNoneMatch === [
'*' ] ) {
1338 $etag = $module->getConditionalRequestData(
'etag' );
1341 if ( $ifNoneMatch && $etag !==
null ) {
1342 $test = substr( $etag, 0, 2 ) ===
'W/' ? substr( $etag, 2 ) : $etag;
1343 $match = array_map(
function (
$s ) {
1344 return substr(
$s, 0, 2 ) ===
'W/' ? substr(
$s, 2 ) :
$s;
1346 $return304 = in_array( $test, $match,
true );
1353 $i = strpos(
$value,
';' );
1354 if ( $i !==
false ) {
1363 $ts->getTimestamp( TS_RFC2822 ) ===
$value ||
1365 $ts->format(
'l, d-M-y H:i:s' ) .
' GMT' ===
$value ||
1367 $ts->format(
'D M j H:i:s Y' ) ===
$value ||
1368 $ts->format(
'D M j H:i:s Y' ) ===
$value
1370 $lastMod = $module->getConditionalRequestData(
'last-modified' );
1371 if ( $lastMod !==
null ) {
1375 'user' => $this->
getUser()->getTouched(),
1376 'epoch' => $this->
getConfig()->get(
'CacheEpoch' ),
1378 if ( $this->
getConfig()->
get(
'UseSquid' ) ) {
1381 TS_MW, time() - $this->
getConfig()->
get(
'SquidMaxage' )
1385 $lastMod = max( $modifiedTimes );
1386 $return304 =
wfTimestamp( TS_MW, $lastMod ) <= $ts->getTimestamp( TS_MW );
1389 }
catch ( TimestampException
$e ) {
1396 $this->
getRequest()->response()->statusHeader( 304 );
1399 Wikimedia\suppressWarnings();
1400 ini_set(
'zlib.output_compression', 0 );
1401 Wikimedia\restoreWarnings();
1417 !
$user->isAllowed(
'read' )
1422 if ( $module->isWriteMode() ) {
1423 if ( !$this->mEnableWrite ) {
1425 } elseif ( !
$user->isAllowed(
'writeapi' ) ) {
1427 } elseif ( $this->
getRequest()->getHeader(
'Promise-Non-Write-API-Action' ) ) {
1428 $this->
dieWithError(
'apierror-promised-nonwrite-api' );
1435 $message =
'hookaborted';
1436 if ( !
Hooks::run(
'ApiCheckCanExecute', [ $module,
$user, &$message ] ) ) {
1450 if ( $module->isWriteMode()
1452 && MediaWikiServices::getInstance()->getDBLoadBalancer()->getServerCount() > 1
1464 $lagLimit = $this->
getConfig()->get(
'APIMaxLagThreshold' );
1465 $laggedServers = [];
1466 $loadBalancer = MediaWikiServices::getInstance()->getDBLoadBalancer();
1467 foreach ( $loadBalancer->getLagTimes()
as $serverIndex => $lag ) {
1468 if ( $lag > $lagLimit ) {
1470 $laggedServers[] = $loadBalancer->getServerName( $serverIndex ) .
" ({$lag}s)";
1475 $replicaCount = $loadBalancer->getServerCount() - 1;
1476 if ( $numLagged >= ceil( $replicaCount / 2 ) ) {
1477 $laggedServers = implode(
', ', $laggedServers );
1480 "Api request failed as read only because the following DBs are lagged: $laggedServers"
1486 [
'readonlyreason' =>
"Waiting for $numLagged lagged database(s)" ]
1496 if ( isset(
$params[
'assert'] ) ) {
1498 switch (
$params[
'assert'] ) {
1500 if (
$user->isAnon() ) {
1505 if ( !
$user->isAllowed(
'bot' ) ) {
1511 if ( isset(
$params[
'assertuser'] ) ) {
1513 if ( !$assertUser || !$this->
getUser()->equals( $assertUser ) ) {
1528 if ( !
$request->wasPosted() && $module->mustBePosted() ) {
1535 $this->mPrinter = $module->getCustomPrinter();
1536 if ( is_null( $this->mPrinter ) ) {
1541 if (
$request->getProtocol() ===
'http' && (
1542 $request->getSession()->shouldForceHTTPS() ||
1543 ( $this->
getUser()->isLoggedIn() &&
1544 $this->
getUser()->requiresHTTPS() )
1546 $this->
addDeprecation(
'apiwarn-deprecation-httpsexpected',
'https-expected' );
1556 $this->mModule = $module;
1558 if ( !$this->mInternalMode ) {
1572 if ( !$this->mInternalMode ) {
1580 Hooks::run(
'APIAfterExecute', [ &$module ] );
1584 if ( !$this->mInternalMode ) {
1598 $limits = $this->
getConfig()->get(
'TrxProfilerLimits' );
1600 $trxProfiler->setLogger( LoggerFactory::getInstance(
'DBPerformance' ) );
1601 if ( $this->
getRequest()->hasSafeMethod() ) {
1602 $trxProfiler->setExpectations( $limits[
'GET'], __METHOD__ );
1604 $trxProfiler->setExpectations( $limits[
'POST-nonwrite'], __METHOD__ );
1607 $trxProfiler->setExpectations( $limits[
'POST'], __METHOD__ );
1623 'timeSpentBackend' => (int)round(
$time * 1000 ),
1624 'hadError' =>
$e !==
null,
1631 $logCtx[
'errorCodes'][] = $msg->getApiCode();
1636 $msg =
"API {$request->getMethod()} " .
1638 " {$logCtx['ip']} " .
1639 "T={$logCtx['timeSpentBackend']}ms";
1648 if ( isset( $sensitive[
$name] ) ) {
1650 $encValue =
'[redacted]';
1651 } elseif ( strlen(
$value ) > 256 ) {
1659 $msg .=
" {$name}={$encValue}";
1664 wfDebugLog(
'ApiAction',
'',
'private', $logCtx );
1675 $chars =
';@$!*(),/:';
1676 $numChars = strlen( $chars );
1677 for ( $i = 0; $i < $numChars; $i++ ) {
1678 $table[rawurlencode( $chars[$i] )] = $chars[$i];
1682 return strtr( rawurlencode(
$s ), $table );
1690 return array_keys( $this->mParamsUsed );
1698 $this->mParamsUsed += array_fill_keys( (
array)
$params,
true );
1707 return array_keys( $this->mParamsSensitive );
1716 $this->mParamsSensitive += array_fill_keys( (
array)
$params,
true );
1726 $this->mParamsUsed[
$name] =
true;
1729 if (
$ret ===
null ) {
1758 $this->mParamsUsed[
$name] =
true;
1769 $allParams = $this->
getRequest()->getValueNames();
1771 if ( !$this->mInternalMode ) {
1773 $printerParams = $this->mPrinter->encodeParamName(
1774 array_keys( $this->mPrinter->getFinalParams() ?: [] )
1776 $unusedParams = array_diff( $allParams, $paramsUsed, $printerParams );
1778 $unusedParams = array_diff( $allParams, $paramsUsed );
1781 if (
count( $unusedParams ) ) {
1783 'apierror-unrecognizedparams',
1784 Message::listParam( array_map(
'wfEscapeWikiText', $unusedParams ),
'comma' ),
1785 count( $unusedParams )
1796 if ( $this->
getConfig()->
get(
'DebugAPI' ) !==
false ) {
1803 $printer->setHttpStatus( $httpCode );
1805 $printer->execute();
1806 $printer->closePrinter();
1848 'requestid' =>
null,
1849 'servedby' =>
false,
1850 'curtimestamp' =>
false,
1851 'responselanginfo' =>
false,
1863 'errorsuselocal' => [
1873 =>
'apihelp-help-example-main',
1874 'action=help&recursivesubmodules=1'
1875 =>
'apihelp-help-example-recursive',
1884 foreach ( $oldHelp
as $k => $v ) {
1885 if ( $k ===
'submodules' ) {
1886 $help[
'permissions'] =
'';
1890 $help[
'datatypes'] =
'';
1891 $help[
'credits'] =
'';
1895 [
'class' =>
'apihelp-block apihelp-permissions' ] );
1896 $m = $this->
msg(
'api-help-permissions' );
1897 if ( !$m->isDisabled() ) {
1899 $m->numParams(
count( self::$mRights ) )->parse()
1903 foreach ( self::$mRights
as $right => $rightMsg ) {
1906 $rightMsg = $this->
msg( $rightMsg[
'msg'], $rightMsg[
'params'] )->parse();
1909 $groups = array_map(
function ( $group ) {
1910 return $group ==
'*' ?
'all' : $group;
1914 $this->
msg(
'api-help-permissions-granted-to' )
1915 ->numParams(
count( $groups ) )
1916 ->params( Message::listParam( $groups ) )
1924 if ( empty(
$options[
'nolead'] ) ) {
1926 $tocnumber = &
$options[
'tocnumber'];
1928 $header = $this->
msg(
'api-help-datatypes-header' )->parse();
1930 $id = Sanitizer::escapeIdForAttribute(
'main/datatypes', Sanitizer::ID_PRIMARY );
1931 $idFallback = Sanitizer::escapeIdForAttribute(
'main/datatypes', Sanitizer::ID_FALLBACK );
1933 ' class="apihelp-header">',
1940 if ( $id !==
'main/datatypes' && $idFallback !==
'main/datatypes' ) {
1941 $headline =
'<div id="main/datatypes"></div>' . $headline;
1943 $help[
'datatypes'] .= $headline;
1944 $help[
'datatypes'] .= $this->
msg(
'api-help-datatypes' )->parseAsBlock();
1945 if ( !isset( $tocData[
'main/datatypes'] ) ) {
1946 $tocnumber[$level]++;
1947 $tocData[
'main/datatypes'] = [
1948 'toclevel' =>
count( $tocnumber ),
1950 'anchor' =>
'main/datatypes',
1952 'number' => implode(
'.', $tocnumber ),
1957 $header = $this->
msg(
'api-credits-header' )->parse();
1958 $id = Sanitizer::escapeIdForAttribute(
'main/credits', Sanitizer::ID_PRIMARY );
1959 $idFallback = Sanitizer::escapeIdForAttribute(
'main/credits', Sanitizer::ID_FALLBACK );
1961 ' class="apihelp-header">',
1968 if ( $id !==
'main/credits' && $idFallback !==
'main/credits' ) {
1969 $headline =
'<div id="main/credits"></div>' . $headline;
1971 $help[
'credits'] .= $headline;
1972 $help[
'credits'] .= $this->
msg(
'api-credits' )->useDatabase(
false )->parseAsBlock();
1973 if ( !isset( $tocData[
'main/credits'] ) ) {
1974 $tocnumber[$level]++;
1975 $tocData[
'main/credits'] = [
1976 'toclevel' =>
count( $tocnumber ),
1978 'anchor' =>
'main/credits',
1980 'number' => implode(
'.', $tocnumber ),
1994 if ( !isset( $this->mCanApiHighLimits ) ) {
1995 $this->mCanApiHighLimits = $this->
getUser()->isAllowed(
'apihighlimits' );
2019 $this->
getRequest()->getHeader(
'Api-user-agent' ) .
' ' .
2020 $this->
getRequest()->getHeader(
'User-agent' )
getStatusValue()
Fetch the error status.
executeActionWithErrorHandling()
Execute an action, and in case of an error, erase whatever partial results have been accumulated,...
Library for creating and parsing MW-style timestamps.
This is the main API class, used for both external and internal processing.
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
WebRequest clone which takes values from a provided array.
Exception used to abort API execution with an error.
getContext()
Get the base IContextSource object.
checkReadOnly( $module)
Check if the DB is read-only for this user.
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
static sanitizeLangCode( $code)
Accepts a language code and ensures it's sane.
processing should stop and the error should be shown to the user * false
getParamsUsed()
Get the request parameters used in the course of the preceding execute() request.
static instance()
Singleton.
createErrorPrinter()
Create the printer for error output.
getErrorFormatter()
Get the ApiErrorFormatter object associated with current request.
getVal( $name, $default=null)
Get a request value, and register the fact that it was used, for logging.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
This manages continuation state.
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
sendCacheHeaders( $isError)
Send caching headers.
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 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
static $Modules
List of available modules: action name => module class.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
logRequest( $time, $e=null)
Log the preceding request.
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
wfUrlencode( $s)
We want some things to be included as literal characters in our title URLs for prettiness,...
handleCORS()
Check the &origin= query parameter against the Origin: HTTP header and respond appropriately.
static handleApiBeforeMainException(Exception $e)
Handle an exception from the ApiBeforeMain hook.
checkConditionalRequestHeaders( $module)
Check selected RFC 7232 precondition headers.
dieWithErrorOrDebug( $msg, $code=null, $data=null, $httpCode=null)
Will only set a warning instead of failing if the global $wgDebugAPI is set to true.
lacksSameOriginSecurity()
Get the security flag for the current request.
wfHostname()
Fetch server name for use in error reporting etc.
wfReadOnly()
Check whether the wiki is in read-only mode.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
const NO_SIZE_CHECK
For addValue() and similar functions, do not check size while adding a value Don't use this unless yo...
Allows to change the fields on the form that will be generated $name
encodeRequestLogValue( $s)
Encode a value in a format suitable for a space-separated log line.
ApiContinuationManager null $mContinuationManager
static matchOrigin( $value, $rules, $exceptions)
Attempt to match an Origin header against a set of rules and a set of exceptions.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
static $mRights
List of user roles that are specifically relevant to the API.
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
This abstract class implements many basic API functions, and is the base of all API classes.
Extension of RawMessage implementing IApiMessage.
static closeElement( $element)
Returns "</$element>".
getModule()
Get the API module object.
An IContextSource implementation which will inherit context from another source but allow individual ...
markParamsUsed( $params)
Mark parameters as used.
setupExecuteAction()
Set up for the execution.
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
This class represents the result of the API operations.
This exception will be thrown when dieUsage is called to stop module execution.
bool null $lacksSameOriginSecurity
Cached return value from self::lacksSameOriginSecurity()
static rollbackMasterChangesAndLog( $e)
Roll back any open database transactions and log the stack trace of the exception.
static makeHeadline( $level, $attribs, $anchor, $html, $link, $fallbackAnchor=false)
Create a headline for content.
getResult()
Get the ApiResult object associated with current request.
getSensitiveParams()
Get the request parameters that should be considered sensitive.
checkMaxLag( $module, $params)
Check the max lag if necessary.
const API_DEFAULT_USELANG
When no uselang parameter is given, this language will be used.
getExamplesMessages()
@inheritDoc
setCacheControl( $directives)
Set directives (key/value pairs) for the Cache-Control header.
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
getAllowedParams()
See ApiBase for description.
setupExternalResponse( $module, $params)
Check POST for external response and setup result printer.
see documentation in includes Linker php for Linker::makeImageLink & $time
createPrinterByName( $format)
Create an instance of an output formatter by its name.
getModuleManager()
Overrides to return this instance's module manager.
when a variable name is used in a it is silently declared as a new masking the global
static create( $msg, $code=null, array $data=null)
Create an IApiMessage for the message.
static matchRequestedHeaders( $requestedHeaders)
Attempt to validate the value of Access-Control-Request-Headers against a list of headers that we all...
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
addRequestedFields( $force=[])
Add requested fields to the result.
setContext(IContextSource $context)
Interface for MediaWiki-localized exceptions.
canApiHighLimits()
Check whether the current user is allowed to use high limits.
checkBotReadOnly()
Check whether we are readonly for bots.
getContinuationManager()
Get the continuation manager.
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
This class holds a list of modules and handles instantiation.
checkAsserts( $params)
Check asserts of the user's rights.
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
static appendDebugInfoToApiResult(IContextSource $context, ApiResult $result)
Append the debug info to given ApiResult.
wfClearOutputBuffers()
More legible than passing a 'false' parameter to wfResetOutputBuffers():
setContinuationManager(ApiContinuationManager $manager=null)
Set the continuation manager.
static wildcardToRegex( $wildcard)
Helper function to convert wildcard string into a regex '*' => '.
checkExecutePermissions( $module)
Check for sufficient permissions to execute.
addDeprecation( $msg, $feature, $data=[])
Add a deprecation warning for this module.
const LIMIT_SML2
Slow query, apihighlimits limit.
dieReadOnly()
Helper function for readonly errors.
__construct( $context=null, $enableWrite=false)
Constructs an instance of ApiMain that utilizes the module and format specified by $request.
reportUnusedParams()
Report unused parameters, so the client gets a hint in case it gave us parameters we don't know,...
execute()
Execute api request.
isWriteMode()
Indicates whether this module requires write mode.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
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 $Formats
List of available formats: format name => format class.
markParamsSensitive( $params)
Mark parameters as sensitive.
setRequestExpectations(ApiBase $module)
Set database connection, query, and write expectations given this module request.
substituteResultWithError( $e)
Replace the result data with the information about an exception.
static getMain()
Get the RequestContext object associated with the main request.
getCheck( $name)
Get a boolean request value, and register the fact that the parameter was used, for logging.
printResult( $httpCode=0)
Print results using the current printer.
this hook is for auditing only $response
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
static isEveryoneAllowed( $right)
Check if all users may be assumed to have the given permission.
const LIMIT_BIG2
Fast query, apihighlimits limit.
const API_DEFAULT_FORMAT
When no format parameter is given, this format will be used.
const GETHEADER_LIST
Flag to make WebRequest::getHeader return an array of values.
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
getUpload( $name)
Get a request upload, and register the fact that it was used, for logging.
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
modifyHelp(array &$help, array $options, array &$tocData)
Called from ApiHelp before the pieces are joined together and returned.
static getRequestId()
Get the unique request ID.
static singleton( $wiki=false)
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
getParameter( $paramName, $parseLimit=true)
Get a value for the given parameter.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
static openElement( $element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
executeAction()
Execute the actual module, without any error handling.
usually copyright or history_copyright This message must be in HTML not wikitext & $link
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
setupModule()
Set up the module for response.
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
static factory( $code)
Get a cached or new language object for a given language code.
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
handleException(Exception $e)
Handle an exception as an API response.
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
isInternalMode()
Return true if the API was started by other PHP code using FauxRequest.
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
getUserAgent()
Fetches the user agent used for this request.
setCacheMaxAge( $maxage)
Set how long the response should be cached.
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
errorMessagesFromException( $e, $type='error')
Create an error message for the given exception.
static getRedactedTraceAsString( $e)
Generate a string representation of an exception's stack trace.
setCacheMode( $mode)
Set the type of caching headers which will be sent.
getPrinter()
Get the result formatter object.
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
the array() calling protocol came about after MediaWiki 1.4rc1.
static getGroupsWithPermission( $role)
Get all the groups who have a given permission.
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
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