MediaWiki REL1_37
|
Public Member Functions | |
__construct (ApiMain $mainModule, $moduleName, JobQueueGroup $jobQueueGroup, WatchlistManager $watchlistManager, UserOptionsLookup $userOptionsLookup) | |
dieStatusWithCode ( $status, $overrideCode, $moreExtraData=null) | |
Like dieStatus(), but always uses $overrideCode for the error code, unless the code comes from IApiMessage. | |
execute () | |
Evaluates the parameters, performs the requested query, and sets up the result. | |
getAllowedParams () | |
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed. | |
getHelpUrls () | |
Return links to more detailed help pages about the module. | |
isWriteMode () | |
Indicates whether this module requires write mode. | |
mustBePosted () | |
Indicates whether this module must be called with a POST request. | |
needsToken () | |
Returns the token type this module requires in order to execute. | |
![]() | |
__construct (ApiMain $mainModule, $moduleName, $modulePrefix='') | |
getModuleManager () | |
Get the module manager, or null if this module has no sub-modules. | |
getCustomPrinter () | |
If the module may only be used with a certain format module, it should override this method to return an instance of that formatter. | |
shouldCheckMaxlag () | |
Indicates if this module needs maxlag to be checked. | |
isReadMode () | |
Indicates whether this module requires read rights. | |
isDeprecated () | |
Indicates whether this module is deprecated. | |
isInternal () | |
Indicates whether this module is "internal" Internal API modules are not (yet) intended for 3rd party use and may be unstable. | |
getConditionalRequestData ( $condition) | |
Returns data for HTTP conditional request mechanisms. | |
getModuleName () | |
Get the name of the module being executed by this instance. | |
getModulePrefix () | |
Get parameter prefix (usually two letters or an empty string). | |
getMain () | |
Get the main module. | |
isMain () | |
Returns true if this module is the main module ($this === $this->mMainModule), false otherwise. | |
getParent () | |
Get the parent of this module. | |
lacksSameOriginSecurity () | |
Returns true if the current request breaks the same-origin policy. | |
getModulePath () | |
Get the path to this module. | |
getModuleFromPath ( $path) | |
Get a module from its module path. | |
getResult () | |
Get the result object. | |
getErrorFormatter () | |
getContinuationManager () | |
setContinuationManager (ApiContinuationManager $manager=null) | |
dynamicParameterDocumentation () | |
Indicate if the module supports dynamically-determined parameters that cannot be included in self::getAllowedParams(). | |
encodeParamName ( $paramName) | |
This method mangles parameter name based on the prefix supplied to the constructor. | |
extractRequestParams ( $options=[]) | |
Using getAllowedParams(), this function makes an array of the values provided by the user, with key being the name of the variable, and value - validated value from user or default. | |
requireOnlyOneParameter ( $params,... $required) | |
Die if none or more than one of a certain set of parameters is set and not false. | |
requireMaxOneParameter ( $params,... $required) | |
Die if more than one of a certain set of parameters is set and not false. | |
requireAtLeastOneParameter ( $params,... $required) | |
Die if none of a certain set of parameters is set and not false. | |
requirePostedParameters ( $params, $prefix='prefix') | |
Die if any of the specified parameters were found in the query part of the URL rather than the post body. | |
getTitleOrPageId ( $params, $load=false) | |
Get a WikiPage object from a title or pageid param, if possible. | |
getTitleFromTitleOrPageId ( $params) | |
Get a Title object from a title or pageid param, if possible. | |
handleParamNormalization ( $paramName, $value, $rawValue) | |
Handle when a parameter was Unicode-normalized. | |
validateToken ( $token, array $params) | |
Validate the supplied token. | |
getWatchlistUser ( $params) | |
Gets the user for whom to get the watchlist. | |
errorArrayToStatus (array $errors, User $user=null) | |
Turn an array of message keys or key+param arrays into a Status. | |
addBlockInfoToStatus (StatusValue $status, Authority $user=null) | |
Add block info to block messages in a Status. | |
addWarning ( $msg, $code=null, $data=null) | |
Add a warning for this module. | |
addDeprecation ( $msg, $feature, $data=[]) | |
Add a deprecation warning for this module. | |
addError ( $msg, $code=null, $data=null) | |
Add an error for this module without aborting. | |
addMessagesFromStatus (StatusValue $status, $types=[ 'warning', 'error'], array $filter=[]) | |
Add warnings and/or errors from a Status. | |
dieWithError ( $msg, $code=null, $data=null, $httpCode=0) | |
Abort execution with an error. | |
dieWithException (Throwable $exception, array $options=[]) | |
Abort execution with an error derived from a throwable. | |
dieBlocked (Block $block) | |
Throw an ApiUsageException, which will (if uncaught) call the main module's error handler and die with an error message including block info. | |
dieStatus (StatusValue $status) | |
Throw an ApiUsageException based on the Status object. | |
dieReadOnly () | |
Helper function for readonly errors. | |
checkUserRightsAny ( $rights, $user=null) | |
Helper function for permission-denied errors. | |
checkTitleUserPermissions ( $pageIdentity, $actions, array $options=[]) | |
Helper function for permission-denied errors. | |
dieWithErrorOrDebug ( $msg, $code=null, $data=null, $httpCode=null) | |
Will only set a warning instead of failing if the global $wgDebugAPI is set to true. | |
logFeatureUsage ( $feature) | |
Write logging information for API features to a debug log, for usage analysis. | |
getFinalSummary () | |
Get final module summary. | |
getFinalDescription () | |
Get final module description, after hooks have had a chance to tweak it as needed. | |
getFinalParams ( $flags=0) | |
Get final list of parameters, after hooks have had a chance to tweak it as needed. | |
getFinalParamDescription () | |
Get final parameter descriptions, after hooks have had a chance to tweak it as needed. | |
modifyHelp (array &$help, array $options, array &$tocData) | |
Called from ApiHelp before the pieces are joined together and returned. | |
![]() | |
canUseWikiPage () | |
Check whether a WikiPage object can be get with getWikiPage(). | |
exportSession () | |
Export the resolved user IP, HTTP headers, user ID, and session ID. | |
getAuthority () | |
getConfig () | |
getContext () | |
Get the base IContextSource object. | |
getCsrfTokenSet () | |
Get a repository to obtain and match CSRF tokens. | |
getLanguage () | |
getOutput () | |
getRequest () | |
getSkin () | |
getStats () | |
getTiming () | |
getTitle () | |
getUser () | |
getWikiPage () | |
Get the WikiPage object. | |
msg ( $key,... $params) | |
Get a Message object with context set Parameters are the same as wfMessage() | |
setContext (IContextSource $context) | |
Static Public Member Functions | |
static | getMinUploadChunkSize (Config $config) |
![]() | |
static | makeMessage ( $msg, IContextSource $context, array $params=null) |
Create a Message from a string or array. | |
Protected Member Functions | |
checkPermissions ( $user) | |
Checks that the user has permissions to perform this upload. | |
checkVerification (array $verification) | |
Performs file verification, dies on error. | |
getApiWarnings () | |
Check warnings. | |
getExamplesMessages () | |
Returns usage examples for this module. | |
handleStashException ( $e) | |
Handles a stash exception, giving a useful error to the user. | |
performUpload ( $warnings) | |
Perform the actual upload. | |
selectUploadModule () | |
Select an upload module and set it to mUpload. | |
transformWarnings ( $warnings) | |
verifyUpload () | |
Performs file verification, dies on error. | |
![]() | |
getWebUITokenSalt (array $params) | |
Fetch the salt used in the Web UI corresponding to this module. | |
getDB () | |
Gets a default replica DB connection object. | |
getPermissionManager () | |
Obtain a PermissionManager instance that subclasses may use in their authorization checks. | |
getHookContainer () | |
Get a HookContainer, for running extension hooks or for hook metadata. | |
getHookRunner () | |
Get an ApiHookRunner for running core API hooks. | |
getParameter ( $paramName, $parseLimit=true) | |
Get a value for the given parameter. | |
getParameterFromSettings ( $name, $settings, $parseLimit) | |
Using the settings determine the value for the given parameter. | |
useTransactionalTimeLimit () | |
Call wfTransactionalTimeLimit() if this request was POSTed. | |
filterIDs ( $fields, array $ids) | |
Filter out-of-range values from a list of positive integer IDs. | |
dieContinueUsageIf ( $condition) | |
Die with the 'badcontinue' error. | |
getSummaryMessage () | |
Return the summary message. | |
getExtendedDescription () | |
Return the extended help text message. | |
getHelpFlags () | |
Generates the list of flags for the help screen and for action=paraminfo. | |
getModuleSourceInfo () | |
Returns information about the source of this module, if known. | |
Protected Attributes | |
$mParams | |
UploadBase UploadFromChunks | $mUpload = null |
Private Member Functions | |
dieRecoverableError ( $errors, $parameter=null) | |
Throw an error that the user can recover from by providing a better value for $parameter. | |
getChunkResult ( $warnings) | |
Get the result of a chunk upload. | |
getContextResult () | |
Get an upload result based on upload context. | |
getStashResult ( $warnings) | |
Get Stash Result, throws an exception if the file could not be stashed. | |
getWarningsResult ( $warnings) | |
Get Warnings Result. | |
performStash ( $failureMode, &$data=null) | |
Stash the file and add the file key, or error information if it fails, to the data. | |
Private Attributes | |
JobQueueGroup | $jobQueueGroup |
Additional Inherited Members | |
![]() | |
const | PARAM_RANGE_ENFORCE = 'api-param-range-enforce' |
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE | |
const | PARAM_DFLT = ParamValidator::PARAM_DEFAULT |
const | PARAM_ISMULTI = ParamValidator::PARAM_ISMULTI |
const | PARAM_TYPE = ParamValidator::PARAM_TYPE |
const | PARAM_MAX = IntegerDef::PARAM_MAX |
const | PARAM_MAX2 = IntegerDef::PARAM_MAX2 |
const | PARAM_MIN = IntegerDef::PARAM_MIN |
const | PARAM_ALLOW_DUPLICATES = ParamValidator::PARAM_ALLOW_DUPLICATES |
const | PARAM_DEPRECATED = ParamValidator::PARAM_DEPRECATED |
const | PARAM_REQUIRED = ParamValidator::PARAM_REQUIRED |
const | PARAM_SUBMODULE_MAP = SubmoduleDef::PARAM_SUBMODULE_MAP |
const | PARAM_SUBMODULE_PARAM_PREFIX = SubmoduleDef::PARAM_SUBMODULE_PARAM_PREFIX |
const | PARAM_ALL = ParamValidator::PARAM_ALL |
const | PARAM_EXTRA_NAMESPACES = NamespaceDef::PARAM_EXTRA_NAMESPACES |
const | PARAM_SENSITIVE = ParamValidator::PARAM_SENSITIVE |
const | PARAM_DEPRECATED_VALUES = EnumDef::PARAM_DEPRECATED_VALUES |
const | PARAM_ISMULTI_LIMIT1 = ParamValidator::PARAM_ISMULTI_LIMIT1 |
const | PARAM_ISMULTI_LIMIT2 = ParamValidator::PARAM_ISMULTI_LIMIT2 |
const | PARAM_MAX_BYTES = StringDef::PARAM_MAX_BYTES |
const | PARAM_MAX_CHARS = StringDef::PARAM_MAX_CHARS |
const | PARAM_HELP_MSG = 'api-param-help-msg' |
(string|array|Message) Specify an alternative i18n documentation message for this parameter. | |
const | PARAM_HELP_MSG_APPEND = 'api-param-help-msg-append' |
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this parameter. | |
const | PARAM_HELP_MSG_INFO = 'api-param-help-msg-info' |
(array) Specify additional information tags for the parameter. | |
const | PARAM_VALUE_LINKS = 'api-param-value-links' |
Deprecated and unused. | |
const | PARAM_HELP_MSG_PER_VALUE = 'api-param-help-msg-per-value' |
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg for ApiBase::makeMessage(). | |
const | PARAM_TEMPLATE_VARS = 'param-template-vars' |
(array) Indicate that this is a templated parameter, and specify replacements. | |
const | ALL_DEFAULT_STRING = '*' |
(string|array|Message) Specify an alternative i18n documentation message for this parameter. | |
const | LIMIT_BIG1 = 500 |
Fast query, standard limit. | |
const | LIMIT_BIG2 = 5000 |
Fast query, apihighlimits limit. | |
const | LIMIT_SML1 = 50 |
Slow query, standard limit. | |
const | LIMIT_SML2 = 500 |
Slow query, apihighlimits limit. | |
const | GET_VALUES_FOR_HELP = 1 |
getAllowedParams() flag: When set, the result could take longer to generate, but should be more thorough. | |
![]() | |
static | dieDebug ( $method, $message) |
Internal code errors should be reported with this method. | |
Definition at line 29 of file ApiUpload.php.
ApiUpload::__construct | ( | ApiMain | $mainModule, |
$moduleName, | |||
JobQueueGroup | $jobQueueGroup, | ||
WatchlistManager | $watchlistManager, | ||
UserOptionsLookup | $userOptionsLookup | ||
) |
ApiMain | $mainModule | |
string | $moduleName | |
JobQueueGroup | $jobQueueGroup | |
WatchlistManager | $watchlistManager | |
UserOptionsLookup | $userOptionsLookup |
Definition at line 48 of file ApiUpload.php.
References $jobQueueGroup, $userOptionsLookup, $watchlistManager, JobQueueGroup\get(), and ContextSource\getConfig().
|
protected |
Checks that the user has permissions to perform this upload.
Dies with usage message on inadequate permissions.
User | $user | The user to check. |
Definition at line 581 of file ApiUpload.php.
References ApiBase\dieBlocked(), ApiBase\dieStatus(), ApiBase\dieWithError(), ContextSource\msg(), and User\newFatalPermissionDeniedStatus().
Referenced by execute().
|
protected |
Performs file verification, dies on error.
array | $verification |
Definition at line 646 of file ApiUpload.php.
References dieRecoverableError(), ApiBase\dieWithError(), ContextSource\getConfig(), and Message\listParam().
Referenced by selectUploadModule(), and verifyUpload().
|
private |
Throw an error that the user can recover from by providing a better value for $parameter.
array | $errors | Array of Message objects, message keys, key+param arrays, or StatusValue::getErrors()-style arrays |
string | null | $parameter | Parameter that needs revising |
ApiUsageException |
Definition at line 411 of file ApiUpload.php.
References ApiBase\dieStatus(), and performStash().
Referenced by checkVerification(), execute(), and performUpload().
ApiUpload::dieStatusWithCode | ( | $status, | |
$overrideCode, | |||
$moreExtraData = null |
|||
) |
Like dieStatus(), but always uses $overrideCode for the error code, unless the code comes from IApiMessage.
Status | $status | |
string | $overrideCode | Error code to use if there isn't one from IApiMessage |
array | null | $moreExtraData |
ApiUsageException |
Definition at line 436 of file ApiUpload.php.
References ApiBase\dieStatus().
Referenced by getChunkResult(), and selectUploadModule().
ApiUpload::execute | ( | ) |
Evaluates the parameters, performs the requested query, and sets up the result.
Concrete implementations of ApiBase must override this method to provide whatever functionality their module offers. Implementations must not produce any output on their own and are not expected to handle any errors.
The execute() method will be invoked directly by ApiMain immediately before the result of the module is output. Aside from the constructor, implementations should assume that no other methods will be called externally on the module before the result is processed.
The result data should be stored in the ApiResult object available through getResult().
Reimplemented from ApiBase.
Definition at line 65 of file ApiUpload.php.
References checkPermissions(), ApiBase\dieDebug(), dieRecoverableError(), ApiBase\dieStatus(), ApiBase\dieWithError(), ApiBase\extractRequestParams(), ContextSource\getConfig(), getContextResult(), ApiBase\getMain(), ApiBase\getModuleName(), ApiBase\getResult(), ContextSource\getUser(), handleStashException(), selectUploadModule(), and verifyUpload().
ApiUpload::getAllowedParams | ( | ) |
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.
Some derived classes may choose to handle an integer $flags parameter in the overriding methods. Callers of this method can pass zero or more OR-ed flags like GET_VALUES_FOR_HELP.
Reimplemented from ApiBase.
Definition at line 932 of file ApiUpload.php.
References getWatchlistParams(), ApiBase\PARAM_DEPRECATED, ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, ApiBase\PARAM_MAX, ApiBase\PARAM_MIN, and ApiBase\PARAM_TYPE.
|
protected |
Check warnings.
Returns a suitable array for inclusion into API results if there were warnings Returns the empty array if there were no warnings
Definition at line 734 of file ApiUpload.php.
References transformWarnings().
Referenced by getChunkResult(), and getContextResult().
|
private |
Get the result of a chunk upload.
array | $warnings | Array of Api upload warnings |
Definition at line 236 of file ApiUpload.php.
References dieStatusWithCode(), ApiBase\dieWithError(), ContextSource\exportSession(), getApiWarnings(), ContextSource\getConfig(), ContextSource\getContext(), ApiBase\getMain(), getMinUploadChunkSize(), ContextSource\getUser(), NS_FILE, Message\numParam(), and performStash().
Referenced by getContextResult().
|
private |
Get an upload result based on upload context.
Definition at line 146 of file ApiUpload.php.
References ApiBase\dieWithError(), getApiWarnings(), getChunkResult(), getStashResult(), ContextSource\getUser(), getWarningsResult(), and performUpload().
Referenced by execute().
|
protected |
Returns usage examples for this module.
Return value has query strings as keys, with values being either strings (message key), arrays (message key + parameter), or Message objects.
Do not call this base class implementation when overriding this method.
Reimplemented from ApiBase.
Definition at line 997 of file ApiUpload.php.
ApiUpload::getHelpUrls | ( | ) |
Return links to more detailed help pages about the module.
Reimplemented from ApiBase.
Definition at line 1007 of file ApiUpload.php.
|
static |
Definition at line 210 of file ApiUpload.php.
References Config\get(), and wfShorthandToInteger().
Referenced by ApiQuerySiteinfo\appendGeneralInfo(), and getChunkResult().
|
private |
Get Stash Result, throws an exception if the file could not be stashed.
array | $warnings | Array of Api upload warnings |
Definition at line 175 of file ApiUpload.php.
References performStash().
Referenced by getContextResult().
|
private |
Get Warnings Result.
array | $warnings | Array of Api upload warnings |
Definition at line 193 of file ApiUpload.php.
References performStash().
Referenced by getContextResult().
|
protected |
Handles a stash exception, giving a useful error to the user.
Exception | $e |
Definition at line 792 of file ApiUpload.php.
References ApiBase\getErrorFormatter(), and ContextSource\msg().
Referenced by execute().
ApiUpload::isWriteMode | ( | ) |
Indicates whether this module requires write mode.
This should return true for modules that may require synchronous database writes. Modules that do not need such writes should also not rely on primary database access, since only read queries are needed and each primary DB is a single point of failure. Additionally, requests that only need replica DBs can be efficiently routed to any datacenter via the Promise-Non-Write-API-Action header.
Reimplemented from ApiBase.
Definition at line 928 of file ApiUpload.php.
ApiUpload::mustBePosted | ( | ) |
Indicates whether this module must be called with a POST request.
Reimplemented from ApiBase.
Definition at line 924 of file ApiUpload.php.
ApiUpload::needsToken | ( | ) |
Returns the token type this module requires in order to execute.
Modules are strongly encouraged to use the core 'csrf' type unless they have specialized security needs. If the token type is not one of the core types, you must use the ApiQueryTokensRegisterTypes hook to register it.
Returning a non-falsey value here will force the addition of an appropriate 'token' parameter in self::getFinalParams(). Also, self::mustBePosted() must return true when tokens are used.
In previous versions of MediaWiki, true was a valid return value. Returning true will generate errors indicating that the API module needs updating.
Reimplemented from ApiBase.
Definition at line 993 of file ApiUpload.php.
|
private |
Stash the file and add the file key, or error information if it fails, to the data.
string | $failureMode | What to do on failure to stash:
|
array | null | &$data | API result to which to add the information |
Definition at line 360 of file ApiUpload.php.
References ApiBase\dieStatus(), ApiBase\getErrorFormatter(), ContextSource\getUser(), and wfDebug().
Referenced by dieRecoverableError(), getChunkResult(), getStashResult(), and getWarningsResult().
|
protected |
Perform the actual upload.
Returns a suitable result array on success; dies on failure.
array | $warnings | Array of Api upload warnings |
Definition at line 832 of file ApiUpload.php.
References $file, $title, ChangeTags\canAddTagsAccompanyingChange(), dieRecoverableError(), ApiBase\dieStatus(), ApiBase\dieWithError(), ContextSource\exportSession(), ContextSource\getAuthority(), ContextSource\getContext(), getExpiryFromParams(), ContextSource\getUser(), getWatchlistValue(), and NS_FILE.
Referenced by getContextResult().
|
protected |
Select an upload module and set it to mUpload.
Dies on failure. If the request was a status request and not a true upload, returns false; otherwise true
Definition at line 456 of file ApiUpload.php.
References checkVerification(), dieStatusWithCode(), ApiBase\dieWithError(), ApiBase\getMain(), ApiBase\getModuleName(), ApiBase\getResult(), ContextSource\getUser(), UploadFromUrl\initialize(), UploadFromUrl\isAllowedHost(), UploadFromUrl\isAllowedUrl(), UploadFromUrl\isEnabled(), UploadFromStash\isValidKey(), ApiBase\requireOnlyOneParameter(), and transformWarnings().
Referenced by execute().
|
protected |
Definition at line 742 of file ApiUpload.php.
References $file, and wfTimestamp().
Referenced by getApiWarnings(), and selectUploadModule().
|
protected |
Performs file verification, dies on error.
Definition at line 607 of file ApiUpload.php.
References checkVerification(), ApiBase\dieWithError(), and wfDebug().
Referenced by execute().
|
private |
Definition at line 39 of file ApiUpload.php.
Referenced by __construct().
|
protected |
Definition at line 36 of file ApiUpload.php.
|
protected |
Definition at line 34 of file ApiUpload.php.