MediaWiki master
ApiQueryMyStashedFiles.php
Go to the documentation of this file.
1<?php
25
33
34 public function __construct( ApiQuery $query, $moduleName ) {
35 parent::__construct( $query, $moduleName, 'msf' );
36 }
37
38 public function execute() {
39 $user = $this->getUser();
40
41 if ( !$user->isRegistered() ) {
42 $this->dieWithError( 'apierror-mustbeloggedin-uploadstash', 'stashnotloggedin' );
43 }
44
45 // Note: If user is logged in but cannot upload, they can still see
46 // the list of stashed uploads...but it will probably be empty.
47
49
50 $this->addTables( 'uploadstash' );
51
52 $this->addFields( [ 'us_id', 'us_key', 'us_status' ] );
53
54 $this->addWhere( [ 'us_user' => $user->getId() ] );
55
56 if ( $params['continue'] !== null ) {
57 $cont = $this->parseContinueParamOrDie( $params['continue'], [ 'int' ] );
58 $this->addWhere( $this->getDB()->buildComparison( '>=', [
59 'us_id' => (int)$cont[0],
60 ] ) );
61 }
62
63 $this->addOption( 'LIMIT', $params['limit'] + 1 );
64 $this->addOption( 'ORDER BY', 'us_id' );
65
66 $prop = array_fill_keys( $params['prop'], true );
67 $this->addFieldsIf(
68 [
69 'us_size',
70 'us_image_width',
71 'us_image_height',
72 'us_image_bits'
73 ],
74
75 isset( $prop['size'] )
76 );
77 $this->addFieldsIf( [ 'us_mime', 'us_media_type' ], isset( $prop['type'] ) );
78
79 $res = $this->select( __METHOD__ );
80 $result = $this->getResult();
81 $count = 0;
82
83 foreach ( $res as $row ) {
84 if ( ++$count > $params['limit'] ) {
85 // We've reached the one extra which shows that there are
86 // additional files to be had. Stop here...
87 $this->setContinueEnumParameter( 'continue', $row->us_id );
88 break;
89 }
90
91 $item = [
92 'filekey' => $row->us_key,
93 'status' => $row->us_status,
94 ];
95
96 if ( isset( $prop['size'] ) ) {
97 $item['size'] = (int)$row->us_size;
98 $item['width'] = (int)$row->us_image_width;
99 $item['height'] = (int)$row->us_image_height;
100 $item['bits'] = (int)$row->us_image_bits;
101 }
102
103 if ( isset( $prop['type'] ) ) {
104 $item['mimetype'] = $row->us_mime;
105 $item['mediatype'] = $row->us_media_type;
106 }
107
108 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $item );
109
110 if ( !$fit ) {
111 $this->setContinueEnumParameter( 'continue', $row->us_id );
112 break;
113 }
114 }
115
116 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'file' );
117 }
118
119 public function getAllowedParams() {
120 return [
121 'prop' => [
122 ParamValidator::PARAM_ISMULTI => true,
123 ParamValidator::PARAM_DEFAULT => '',
124 ParamValidator::PARAM_TYPE => [ 'size', 'type' ],
126 ],
127
128 'limit' => [
129 ParamValidator::PARAM_TYPE => 'limit',
130 ParamValidator::PARAM_DEFAULT => 10,
131 IntegerDef::PARAM_MIN => 1,
132 IntegerDef::PARAM_MAX => ApiBase::LIMIT_BIG1,
133 IntegerDef::PARAM_MAX2 => ApiBase::LIMIT_BIG2,
134 ],
135
136 'continue' => [
137 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
138 ],
139 ];
140 }
141
142 protected function getExamplesMessages() {
143 return [
144 'action=query&list=mystashedfiles&msfprop=size'
145 => 'apihelp-query+mystashedfiles-example-simple',
146 ];
147 }
148
149 public function getHelpUrls() {
150 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:mystashedfiles';
151 }
152}
array $params
The job parameters.
dieWithError( $msg, $code=null, $data=null, $httpCode=0)
Abort execution with an error.
Definition ApiBase.php:1540
parseContinueParamOrDie(string $continue, array $types)
Parse the 'continue' parameter in the usual format and validate the types of each part,...
Definition ApiBase.php:1731
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, or 'string' with PARAM_ISMULTI,...
Definition ApiBase.php:212
const LIMIT_BIG1
Fast query, standard limit.
Definition ApiBase.php:237
getResult()
Get the result object.
Definition ApiBase.php:681
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:821
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:172
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition ApiBase.php:239
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:542
This is a base class for all Query modules.
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
addFields( $value)
Add a set of fields to select to the internal array.
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
getDB()
Get the Query database connection (read-only)
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
addWhere( $value)
Add a set of WHERE clauses to the internal array.
action=query&list=mystashedfiles module, gets all stashed files for the current user.
getExamplesMessages()
Returns usage examples for this module.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
getHelpUrls()
Return links to more detailed help pages about the module.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
__construct(ApiQuery $query, $moduleName)
This is the main query class.
Definition ApiQuery.php:43
Service for formatting and validating API parameters.
Type definition for integer types.