MediaWiki  REL1_19
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
ApiUpload Class Reference
API
Inheritance diagram for ApiUpload:
Inheritance graph
[legend]
Collaboration diagram for ApiUpload:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 __construct ($main, $action)
 dieRecoverableError ($error, $parameter, $data=array())
 Throw an error that the user can recover from by providing a better value for $parameter.
 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.
 getDescription ()
 Returns the description string for this module.
 getExamples ()
 Returns usage examples for this module.
 getHelpUrls ()
 getParamDescription ()
 Returns an array of parameter descriptions.
 getPossibleErrors ()
 Returns a list of all possible errors returned by the module.
 getTokenSalt ()
 Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the module doesn't need a token.
 getVersion ()
 Returns a string that identifies the version of the extending class.
 isWriteMode ()
 Indicates whether this module requires write mode.
 mustBePosted ()
 Indicates whether this module must be called with a POST request.
 needsToken ()
 Returns whether this module requires a Token to execute.
 performStash ()
 Stash the file and return the file key Also re-raises exceptions with slightly more informative message strings (useful for API)

Protected Member Functions

 checkAsyncDownloadEnabled ()
 Checks if asynchronous copy uploads are enabled and throws an error if they are not.
 checkPermissions ($user)
 Checks that the user has permissions to perform this upload.
 getApiWarnings ()
 Check warnings if ignorewarnings is not set.
 performUpload ()
 Perform the actual upload.
 selectUploadModule ()
 Select an upload module and set it to mUpload.
 transformWarnings ($warnings)
 verifyUpload ()
 Performs file verification, dies on error.

Protected Attributes

 $mParams
 $mUpload = null

Private Member Functions

 getChunkResult ()
 Get the result of a chunk upload.
 getContextResult ()
 Get an uplaod result based on upload context.
 getStashResult ()
 Get Stash Result, throws an expetion if the file could not be stashed.
 getWarningsResult ($warnings)
 Get Warnings Result.

Detailed Description

Definition at line 30 of file ApiUpload.php.

Constructor & Destructor Documentation

ApiUpload::__construct ( $  main,
$  action 
)

Definition at line 39 of file ApiUpload.php.

Member Function Documentation

ApiUpload::checkAsyncDownloadEnabled ( ) [protected]

Checks if asynchronous copy uploads are enabled and throws an error if they are not.

Definition at line 523 of file ApiUpload.php.

References $wgAllowAsyncCopyUploads, and ApiBase\dieUsage().

Referenced by selectUploadModule().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiUpload::checkPermissions ( $  user) [protected]

Checks that the user has permissions to perform this upload.

Dies with usage message on inadequate permissions.

Parameters:
$userUser The user to check.

Definition at line 354 of file ApiUpload.php.

References $user, and ApiBase\dieUsageMsg().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiUpload::dieRecoverableError ( $  error,
$  parameter,
$  data = array() 
)

Throw an error that the user can recover from by providing a better value for $parameter.

Parameters:
$errorarray Error array suitable for passing to dieUsageMsg()
$parameterstring Parameter that needs revising
$dataarray Optional extra data to pass to the user
Exceptions:
UsageException

Definition at line 237 of file ApiUpload.php.

References ApiBase\dieUsage(), ApiBase\parseMsg(), and performStash().

Referenced by execute(), and verifyUpload().

Here is the call graph for this function:

Here is the caller graph for this function:

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 43 of file ApiUpload.php.

References $result, $user, checkPermissions(), dieRecoverableError(), ApiBase\dieUsage(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), getContextResult(), ApiBase\getMain(), ApiBase\getModuleName(), ApiBase\getResult(), ContextSource\getUser(), UploadBase\isEnabled(), selectUploadModule(), and verifyUpload().

Here is the call graph for this function:

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.

Returns:
array or false

Reimplemented from ApiBase.

Definition at line 538 of file ApiUpload.php.

References ApiBase\PARAM_DEPRECATED, ApiBase\PARAM_DFLT, and ApiBase\PARAM_TYPE.

ApiUpload::getApiWarnings ( ) [protected]

Check warnings if ignorewarnings is not set.

Returns a suitable array for inclusion into API results if there were warnings Returns the empty array if there were no warnings

Returns:
array

Definition at line 437 of file ApiUpload.php.

References transformWarnings().

Referenced by getContextResult().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiUpload::getChunkResult ( ) [private]

Get the result of a chunk upload.

Definition at line 170 of file ApiUpload.php.

References $result, ApiBase\dieUsage(), ApiBase\getMain(), and performStash().

Referenced by getContextResult().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiUpload::getContextResult ( ) [private]

Get an uplaod result based on upload context.

Definition at line 117 of file ApiUpload.php.

References getApiWarnings(), getChunkResult(), getStashResult(), getWarningsResult(), and performUpload().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiUpload::getDescription ( )

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 610 of file ApiUpload.php.

ApiUpload::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:
false|string|array

Reimplemented from ApiBase.

Definition at line 651 of file ApiUpload.php.

ApiUpload::getHelpUrls ( )
Returns:
false|string|array Returns a false if the module has no help url, else returns a (array of) string

Reimplemented from ApiBase.

Definition at line 660 of file ApiUpload.php.

ApiUpload::getParamDescription ( )

Returns an array of parameter descriptions.

Don't call this functon directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.

Returns:
array or false

Reimplemented from ApiBase.

Definition at line 582 of file ApiUpload.php.

ApiUpload::getPossibleErrors ( )

Returns a list of all possible errors returned by the module.

Returns:
array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )

Reimplemented from ApiBase.

Definition at line 621 of file ApiUpload.php.

References ApiBase\getRequireOnlyOneParameterErrorMessages().

Here is the call graph for this function:

ApiUpload::getStashResult ( ) [private]

Get Stash Result, throws an expetion if the file could not be stashed.

Definition at line 136 of file ApiUpload.php.

References $result, ApiBase\dieUsage(), and performStash().

Referenced by getContextResult().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiUpload::getTokenSalt ( )

Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the module doesn't need a token.

Returns:
bool|string

Reimplemented from ApiBase.

Definition at line 647 of file ApiUpload.php.

ApiUpload::getVersion ( )

Returns a string that identifies the version of the extending class.

Typically includes the class name, the svn revision, timestamp, and last author. Usually done with SVN's Id keyword

Returns:
string

Reimplemented from ApiBase.

Definition at line 664 of file ApiUpload.php.

ApiUpload::getWarningsResult ( $  warnings) [private]

Get Warnings Result.

Parameters:
$warningsArray of Api upload warnings

Definition at line 153 of file ApiUpload.php.

References $result, and performStash().

Referenced by getContextResult().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiUpload::isWriteMode ( )

Indicates whether this module requires write mode.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 534 of file ApiUpload.php.

ApiUpload::mustBePosted ( )

Indicates whether this module must be called with a POST request.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 530 of file ApiUpload.php.

ApiUpload::needsToken ( )

Returns whether this module requires a Token to execute.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 643 of file ApiUpload.php.

ApiUpload::performStash ( )

Stash the file and return the file key Also re-raises exceptions with slightly more informative message strings (useful for API)

Exceptions:
MWException
Returns:
String file key

Definition at line 212 of file ApiUpload.php.

References wfDebug().

Referenced by dieRecoverableError(), getChunkResult(), getStashResult(), and getWarningsResult().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiUpload::performUpload ( ) [protected]

Perform the actual upload.

Returns a suitable result array on success; dies on failure.

Returns:
array

Definition at line 477 of file ApiUpload.php.

References $file, $result, ApiBase\dieUsage(), ApiBase\getResult(), ContextSource\getUser(), and ApiBase\getWatchlistValue().

Referenced by getContextResult().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiUpload::selectUploadModule ( ) [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

Returns:
bool

Definition at line 257 of file ApiUpload.php.

References checkAsyncDownloadEnabled(), ApiBase\dieUsage(), ApiBase\dieUsageMsg(), ApiBase\getMain(), ApiBase\getModuleName(), ApiBase\getResult(), UploadFromUrlJob\getSessionData(), ContextSource\getUser(), UploadFromUrl\initialize(), UploadFromUrl\isEnabled(), UploadFromStash\isValidKey(), ApiBase\requireOnlyOneParameter(), and transformWarnings().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiUpload::transformWarnings ( $  warnings) [protected]

Definition at line 446 of file ApiUpload.php.

References $result, and ApiBase\getResult().

Referenced by getApiWarnings(), and selectUploadModule().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiUpload::verifyUpload ( ) [protected]

Performs file verification, dies on error.

Definition at line 370 of file ApiUpload.php.

References $wgFileExtensions, dieRecoverableError(), ApiBase\dieUsage(), UploadBase\EMPTY_FILE, UploadBase\FILE_TOO_LARGE, UploadBase\FILENAME_TOO_LONG, UploadBase\FILETYPE_BADTYPE, UploadBase\FILETYPE_MISSING, ApiBase\getResult(), UploadBase\HOOK_ABORTED, UploadBase\ILLEGAL_FILENAME, UploadBase\MIN_LENGTH_PARTNAME, UploadBase\OK, UploadBase\VERIFICATION_ERROR, and UploadBase\WINDOWS_NONASCII_FILENAME.

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

ApiUpload::$mParams [protected]

Definition at line 37 of file ApiUpload.php.

ApiUpload::$mUpload = null [protected]

Definition at line 35 of file ApiUpload.php.

The documentation for this class was generated from the following file: