includes/api/ApiQueryMyStashedFiles.php

   1 <?php
   2 /**
   3  * API for MediaWiki 1.27+
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * action=query&list=mystashedfiles module, gets all stashed files for
  25  * the current user.
  26  *
  27  * @ingroup API
  28  */
  29 class ApiQueryMyStashedFiles extends ApiQueryBase {
  30
  31         public function __construct( ApiQuery $query, $moduleName ) {
  32                 parent::__construct( $query, $moduleName, 'msf' );
  33         }
  34
  35         public function execute() {
  36                 $user = $this->getUser();
  37
  38                 if ( $user->isAnon() ) {
  39                         $this->dieUsage( 'The upload stash is only available to logged-in users.', 'stashnotloggedin' );
  40                 }
  41
  42                 // Note: If user is logged in but cannot upload, they can still see
  43                 // the list of stashed uploads...but it will probably be empty.
  44
  45                 $params = $this->extractRequestParams();
  46
  47                 $this->addTables( 'uploadstash' );
  48
  49                 $this->addFields( [ 'us_id', 'us_key', 'us_status' ] );
  50
  51                 $this->addWhere( [ 'us_user' => $user->getId() ] );
  52
  53                 if ( $params['continue'] !== null ) {
  54                         $cont = explode( '|', $params['continue'] );
  55                         $this->dieContinueUsageIf( count( $cont ) != 1 );
  56                         $cont_from = (int)$cont[0];
  57                         $this->dieContinueUsageIf( strval( $cont_from ) !== $cont[0] );
  58                         $this->addWhere( "us_id >= $cont_from" );
  59                 }
  60
  61                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
  62                 $this->addOption( 'ORDER BY', 'us_id' );
  63
  64                 $prop = array_flip( $params['prop'] );
  65                 $this->addFieldsIf(
  66                         [
  67                                 'us_size',
  68                                 'us_image_width',
  69                                 'us_image_height',
  70                                 'us_image_bits'
  71                         ],
  72
  73                         isset( $prop['size'] )
  74                 );
  75                 $this->addFieldsIf( [ 'us_mime', 'us_media_type' ], isset( $prop['type'] ) );
  76
  77                 $res = $this->select( __METHOD__ );
  78                 $result = $this->getResult();
  79                 $count = 0;
  80
  81                 foreach ( $res as $row ) {
  82                         if ( ++$count > $params['limit'] ) {
  83                                 // We've reached the one extra which shows that there are
  84                                 // additional files to be had. Stop here...
  85                                 $this->setContinueEnumParameter( 'continue', $row->us_id );
  86                                 break;
  87                         }
  88
  89                         $item = [
  90                                 'filekey' => $row->us_key,
  91                                 'status' => $row->us_status,
  92                         ];
  93
  94                         if ( isset( $prop['size'] ) ) {
  95                                 $item['size'] = (int) $row->us_size;
  96                                 $item['width'] = (int) $row->us_image_width;
  97                                 $item['height'] = (int) $row->us_image_height;
  98                                 $item['bits'] = (int) $row->us_image_bits;
  99                         }
 100
 101                         if ( isset( $prop['type'] ) ) {
 102                                 $item['mimetype'] = $row->us_mime;
 103                                 $item['mediatype'] = $row->us_media_type;
 104                         }
 105
 106                         $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $item );
 107
 108                         if ( !$fit ) {
 109                                 $this->setContinueEnumParameter( 'continue', $row->us_id );
 110                                 break;
 111                         }
 112                 }
 113
 114                 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'file' );
 115         }
 116
 117         public function getAllowedParams() {
 118                 return [
 119                         'prop' => [
 120                                 ApiBase::PARAM_ISMULTI => true,
 121                                 ApiBase::PARAM_DFLT => '',
 122                                 ApiBase::PARAM_TYPE => [ 'size', 'type' ],
 123                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
 124                         ],
 125
 126                         'limit' => [
 127                                 ApiBase::PARAM_TYPE => 'limit',
 128                                 ApiBase::PARAM_DFLT => 10,
 129                                 ApiBase::PARAM_MIN => 1,
 130                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 131                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2,
 132                         ],
 133
 134                         'continue' => [
 135                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 136                         ],
 137                 ];
 138         }
 139
 140         protected function getExamplesMessages() {
 141                 return [
 142                         'action=query&list=mystashedfiles&msfprop=size'
 143                                 => 'apihelp-query+mystashedfiles-example-simple',
 144                 ];
 145         }
 146
 147         public function getHelpUrls() {
 148                 return 'https://www.mediawiki.org/wiki/API:mystashedfiles';
 149         }
 150 }