3 * Created on Aug 21, 2008
4 * API for MediaWiki 1.8+
6 * Copyright © 2008 - 2010 Bryan Tong Minh <Bryan.TongMinh@Gmail.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 * http://www.gnu.org/copyleft/gpl.html
24 if ( !defined( 'MEDIAWIKI' ) ) {
25 // Eclipse helper - will be ignored in production
26 require_once( "ApiBase.php" );
32 class ApiUpload
extends ApiBase
{
33 protected $mUpload = null;
36 public function __construct( $main, $action ) {
37 parent
::__construct( $main, $action );
40 public function execute() {
41 global $wgUser, $wgAllowCopyUploads;
43 // Check whether upload is enabled
44 if ( !UploadBase
::isEnabled() ) {
45 $this->dieUsageMsg( array( 'uploaddisabled' ) );
48 $this->mParams
= $this->extractRequestParams();
49 $request = $this->getMain()->getRequest();
51 // Add the uploaded file to the params array
52 $this->mParams
['file'] = $request->getFileName( 'file' );
54 // One and only one of the following parameters is needed
55 $this->requireOnlyOneParameter( $this->mParams
,
56 'sessionkey', 'file', 'url' );
58 if ( $this->mParams
['sessionkey'] ) {
60 * Upload stashed in a previous request
62 // Check the session key
63 if ( !isset( $_SESSION['wsUploadData'][$this->mParams
['sessionkey']] ) ) {
64 $this->dieUsageMsg( array( 'invalid-session-key' ) );
67 $this->mUpload
= new UploadFromStash();
68 $this->mUpload
->initialize( $this->mParams
['filename'],
69 $this->mParams
['sessionkey'],
70 $_SESSION['wsUploadData'][$this->mParams
['sessionkey']] );
71 } elseif ( isset( $this->mParams
['filename'] ) ) {
73 * Upload from URL, etc.
74 * Parameter filename is required
76 if ( isset( $this->mParams
['file'] ) ) {
77 $this->mUpload
= new UploadFromFile();
78 $this->mUpload
->initialize(
79 $this->mParams
['filename'],
80 $request->getFileTempName( 'file' ),
81 $request->getFileSize( 'file' )
83 } elseif ( isset( $this->mParams
['url'] ) ) {
84 // make sure upload by URL is enabled:
85 if ( !$wgAllowCopyUploads ) {
86 $this->dieUsageMsg( array( 'uploaddisabled' ) );
89 // make sure the current user can upload
90 if ( !$wgUser->isAllowed( 'upload_by_url' ) ) {
91 $this->dieUsageMsg( array( 'badaccess-groups' ) );
94 $this->mUpload
= new UploadFromUrl();
95 $this->mUpload
->initialize( $this->mParams
['filename'],
96 $this->mParams
['url'] );
98 $status = $this->mUpload
->fetchFile();
99 if ( !$status->isOK() ) {
100 $this->dieUsage( $status->getWikiText(), 'fetchfileerror' );
104 $this->dieUsageMsg( array( 'missingparam', 'filename' ) );
107 if ( !isset( $this->mUpload
) ) {
108 $this->dieUsage( 'No upload module set', 'nomodule' );
111 // Check whether the user has the appropriate permissions to upload anyway
112 $permission = $this->mUpload
->isAllowed( $wgUser );
114 if ( $permission !== true ) {
115 if ( !$wgUser->isLoggedIn() ) {
116 $this->dieUsageMsg( array( 'mustbeloggedin', 'upload' ) );
118 $this->dieUsageMsg( array( 'badaccess-groups' ) );
121 // Perform the upload
122 $result = $this->performUpload();
124 // Cleanup any temporary mess
125 $this->mUpload
->cleanupTempFile();
127 $this->getResult()->addValue( null, $this->getModuleName(), $result );
130 protected function performUpload() {
133 $permErrors = $this->mUpload
->verifyPermissions( $wgUser );
134 if ( $permErrors !== true ) {
135 $this->dieUsageMsg( array( 'badaccess-groups' ) );
138 // TODO: Move them to ApiBase's message map
139 $verification = $this->mUpload
->verifyUpload();
140 if ( $verification['status'] !== UploadBase
::OK
) {
141 $result['result'] = 'Failure';
142 switch( $verification['status'] ) {
143 case UploadBase
::EMPTY_FILE
:
144 $this->dieUsage( 'The file you submitted was empty', 'empty-file' );
146 case UploadBase
::FILETYPE_MISSING
:
147 $this->dieUsage( 'The file is missing an extension', 'filetype-missing' );
149 case UploadBase
::FILETYPE_BADTYPE
:
150 global $wgFileExtensions;
151 $this->dieUsage( 'This type of file is banned', 'filetype-banned',
153 'filetype' => $verification['finalExt'],
154 'allowed' => $wgFileExtensions
157 case UploadBase
::MIN_LENGTH_PARTNAME
:
158 $this->dieUsage( 'The filename is too short', 'filename-tooshort' );
160 case UploadBase
::ILLEGAL_FILENAME
:
161 $this->dieUsage( 'The filename is not allowed', 'illegal-filename',
162 0, array( 'filename' => $verification['filtered'] ) );
164 case UploadBase
::OVERWRITE_EXISTING_FILE
:
165 $this->dieUsage( 'Overwriting an existing file is not allowed', 'overwrite' );
167 case UploadBase
::VERIFICATION_ERROR
:
168 $this->getResult()->setIndexedTagName( $verification['details'], 'detail' );
169 $this->dieUsage( 'This file did not pass file verification', 'verification-error',
170 0, array( 'details' => $verification['details'] ) );
172 case UploadBase
::HOOK_ABORTED
:
173 $this->dieUsage( "The modification you tried to make was aborted by an extension hook",
174 'hookaborted', 0, array( 'error' => $verification['error'] ) );
177 $this->dieUsage( 'An unknown error occurred', 'unknown-error',
178 0, array( 'code' => $verification['status'] ) );
183 if ( !$this->mParams
['ignorewarnings'] ) {
184 $warnings = $this->mUpload
->checkWarnings();
187 $this->getResult()->setIndexedTagName( $warnings, 'warning' );
189 if ( isset( $warnings['duplicate'] ) ) {
191 foreach ( $warnings['duplicate'] as $key => $dupe )
192 $dupes[] = $dupe->getName();
193 $this->getResult()->setIndexedTagName( $dupes, 'duplicate' );
194 $warnings['duplicate'] = $dupes;
197 if ( isset( $warnings['exists'] ) ) {
198 $warning = $warnings['exists'];
199 unset( $warnings['exists'] );
200 $warnings[$warning['warning']] = $warning['file']->getName();
203 $result['result'] = 'Warning';
204 $result['warnings'] = $warnings;
206 $sessionKey = $this->mUpload
->stashSession();
207 if ( !$sessionKey ) {
208 $this->dieUsage( 'Stashing temporary file failed', 'stashfailed' );
211 $result['sessionkey'] = $sessionKey;
217 // Use comment as initial page text by default
218 if ( is_null( $this->mParams
['text'] ) ) {
219 $this->mParams
['text'] = $this->mParams
['comment'];
222 // No errors, no warnings: do the upload
223 $status = $this->mUpload
->performUpload( $this->mParams
['comment'],
224 $this->mParams
['text'], $this->mParams
['watch'], $wgUser );
226 if ( !$status->isGood() ) {
227 $error = $status->getErrorsArray();
228 $this->getResult()->setIndexedTagName( $result['details'], 'error' );
230 $this->dieUsage( 'An internal error occurred', 'internal-error', 0, $error );
233 $file = $this->mUpload
->getLocalFile();
234 $result['result'] = 'Success';
235 $result['filename'] = $file->getName();
236 $result['imageinfo'] = $this->mUpload
->getImageInfo( $this->getResult() );
241 public function mustBePosted() {
245 public function isWriteMode() {
249 public function getAllowedParams() {
253 ApiBase
::PARAM_DFLT
=> ''
258 'ignorewarnings' => false,
261 'sessionkey' => null,
266 public function getParamDescription() {
268 'filename' => 'Target filename',
269 'token' => 'Edit token. You can get one of these through prop=info',
270 'comment' => 'Upload comment. Also used as the initial page text for new files if "text" is not specified',
271 'text' => 'Initial page text for new files',
272 'watch' => 'Watch the page',
273 'ignorewarnings' => 'Ignore any warnings',
274 'file' => 'File contents',
275 'url' => 'Url to fetch the file from',
276 'sessionkey' => array(
277 'Session key returned by a previous upload that failed due to warnings',
282 public function getDescription() {
284 'Upload a file, or get the status of pending uploads. Several methods are available:',
285 ' * Upload file contents directly, using the "file" parameter',
286 ' * Have the MediaWiki server fetch a file from a URL, using the "url" parameter',
287 ' * Complete an earlier upload that failed due to warnings, using the "sessionkey" parameter',
288 'Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when',
289 'sending the "file". Note also that queries using session keys must be',
290 'done in the same login session as the query that originally returned the key (i.e. do not',
291 'log out and then log back in). Also you must get and send an edit token before doing any upload stuff.'
295 public function getPossibleErrors() {
296 return array_merge( parent
::getPossibleErrors(), array(
297 array( 'uploaddisabled' ),
298 array( 'invalid-session-key' ),
299 array( 'uploaddisabled' ),
300 array( 'badaccess-groups' ),
301 array( 'missingparam', 'filename' ),
302 array( 'mustbeloggedin', 'upload' ),
303 array( 'badaccess-groups' ),
304 array( 'badaccess-groups' ),
305 array( 'code' => 'fetchfileerror', 'info' => '' ),
306 array( 'code' => 'nomodule', 'info' => 'No upload module set' ),
307 array( 'code' => 'empty-file', 'info' => 'The file you submitted was empty' ),
308 array( 'code' => 'filetype-missing', 'info' => 'The file is missing an extension' ),
309 array( 'code' => 'filename-tooshort', 'info' => 'The filename is too short' ),
310 array( 'code' => 'overwrite', 'info' => 'Overwriting an existing file is not allowed' ),
311 array( 'code' => 'stashfailed', 'info' => 'Stashing temporary file failed' ),
312 array( 'code' => 'internal-error', 'info' => 'An internal error occurred' ),
316 public function getTokenSalt() {
320 protected function getExamples() {
322 'Upload from a URL:',
323 ' api.php?action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png',
324 'Complete an upload that failed due to warnings:',
325 ' api.php?action=upload&filename=Wiki.png&sessionkey=sessionkey&ignorewarnings=1',
329 public function getVersion() {
330 return __CLASS__
. ': $Id: ApiUpload.php 51812 2009-06-12 23:45:20Z dale $';