3 * Implements Special:Upload
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.
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.
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
21 * @ingroup SpecialPage
26 * Form for handling uploads and special page.
28 * @ingroup SpecialPage
31 class SpecialUpload
extends SpecialPage
{
33 * Constructor : initialise object
34 * Get data POSTed through the form and assign them to the object
35 * @param $request WebRequest : data posted.
37 public function __construct( $request = null ) {
40 parent
::__construct( 'Upload', 'upload' );
42 $this->loadRequest( is_null( $request ) ?
$wgRequest : $request );
45 /** Misc variables **/
46 public $mRequest; // The WebRequest or FauxRequest this form is supposed to handle
58 public $mUploadClicked;
60 /** User input variables from the "description" section **/
61 public $mDesiredDestName; // The requested target file name
65 /** User input variables from the root section **/
66 public $mIgnoreWarning;
68 public $mCopyrightStatus;
69 public $mCopyrightSource;
71 /** Hidden variables **/
72 public $mDestWarningAck;
73 public $mForReUpload; // The user followed an "overwrite this file" link
74 public $mCancelUpload; // The user clicked "Cancel and return to upload form" button
76 public $mUploadSuccessful = false; // Subclasses can use this to determine whether a file was uploaded
78 /** Text injection points for hooks not using HTMLForm **/
79 public $uploadFormTextTop;
80 public $uploadFormTextAfterSummary;
85 * Initialize instance variables from request and create an Upload handler
87 * @param $request WebRequest: the request to extract variables from
89 protected function loadRequest( $request ) {
92 $this->mRequest
= $request;
93 $this->mSourceType
= $request->getVal( 'wpSourceType', 'file' );
94 $this->mUpload
= UploadBase
::createFromRequest( $request );
95 $this->mUploadClicked
= $request->wasPosted()
96 && ( $request->getCheck( 'wpUpload' )
97 ||
$request->getCheck( 'wpUploadIgnoreWarning' ) );
99 // Guess the desired name from the filename if not provided
100 $this->mDesiredDestName
= $request->getText( 'wpDestFile' );
101 if( !$this->mDesiredDestName
&& $request->getFileName( 'wpUploadFile' ) !== null ) {
102 $this->mDesiredDestName
= $request->getFileName( 'wpUploadFile' );
104 $this->mComment
= $request->getText( 'wpUploadDescription' );
105 $this->mLicense
= $request->getText( 'wpLicense' );
108 $this->mDestWarningAck
= $request->getText( 'wpDestFileWarningAck' );
109 $this->mIgnoreWarning
= $request->getCheck( 'wpIgnoreWarning' )
110 ||
$request->getCheck( 'wpUploadIgnoreWarning' );
111 $this->mWatchthis
= $request->getBool( 'wpWatchthis' ) && $wgUser->isLoggedIn();
112 $this->mCopyrightStatus
= $request->getText( 'wpUploadCopyStatus' );
113 $this->mCopyrightSource
= $request->getText( 'wpUploadSource' );
116 $this->mForReUpload
= $request->getBool( 'wpForReUpload' ); // updating a file
117 $this->mCancelUpload
= $request->getCheck( 'wpCancelUpload' )
118 ||
$request->getCheck( 'wpReUpload' ); // b/w compat
120 // If it was posted check for the token (no remote POST'ing with user credentials)
121 $token = $request->getVal( 'wpEditToken' );
122 if( $this->mSourceType
== 'file' && $token == null ) {
123 // Skip token check for file uploads as that can't be faked via JS...
124 // Some client-side tools don't expect to need to send wpEditToken
125 // with their submissions, as that's new in 1.16.
126 $this->mTokenOk
= true;
128 $this->mTokenOk
= $wgUser->matchEditToken( $token );
131 $this->uploadFormTextTop
= '';
132 $this->uploadFormTextAfterSummary
= '';
136 * This page can be shown if uploading is enabled.
137 * Handle permission checking elsewhere in order to be able to show
138 * custom error messages.
140 * @param $user User object
143 public function userCanExecute( User
$user ) {
144 return UploadBase
::isEnabled() && parent
::userCanExecute( $user );
148 * Special page entry point
150 public function execute( $par ) {
151 global $wgUser, $wgOut;
154 $this->outputHeader();
156 # Check uploading enabled
157 if( !UploadBase
::isEnabled() ) {
158 $wgOut->showErrorPage( 'uploaddisabled', 'uploaddisabledtext' );
163 global $wgGroupPermissions;
164 $permissionRequired = UploadBase
::isAllowed( $wgUser );
165 if( $permissionRequired !== true ) {
166 if( !$wgUser->isLoggedIn() && ( $wgGroupPermissions['user']['upload']
167 ||
$wgGroupPermissions['autoconfirmed']['upload'] ) ) {
168 // Custom message if logged-in users without any special rights can upload
169 $wgOut->showErrorPage( 'uploadnologin', 'uploadnologintext' );
171 $wgOut->permissionRequired( $permissionRequired );
177 if( $wgUser->isBlocked() ) {
178 $wgOut->blockedPage();
182 # Check whether we actually want to allow changing stuff
184 $wgOut->readOnlyPage();
188 # Unsave the temporary file in case this was a cancelled upload
189 if ( $this->mCancelUpload
) {
190 if ( !$this->unsaveUploadedFile() ) {
191 # Something went wrong, so unsaveUploadedFile showed a warning
196 # Process upload or show a form
198 $this->mTokenOk
&& !$this->mCancelUpload
&&
199 ( $this->mUpload
&& $this->mUploadClicked
)
202 $this->processUpload();
204 # Backwards compatibility hook
205 if( !wfRunHooks( 'UploadForm:initial', array( &$this ) ) ) {
206 wfDebug( "Hook 'UploadForm:initial' broke output of the upload form" );
211 $this->showUploadForm( $this->getUploadForm() );
215 if ( $this->mUpload
) {
216 $this->mUpload
->cleanupTempFile();
221 * Show the main upload form
223 * @param $form Mixed: an HTMLForm instance or HTML string to show
225 protected function showUploadForm( $form ) {
226 # Add links if file was previously deleted
227 if ( $this->mDesiredDestName
) {
228 $this->showViewDeletedLinks();
231 if ( $form instanceof HTMLForm
) {
235 $wgOut->addHTML( $form );
241 * Get an UploadForm instance with title and text properly set.
243 * @param $message String: HTML string to add to the form
244 * @param $sessionKey String: session key in case this is a stashed upload
245 * @param $hideIgnoreWarning Boolean: whether to hide "ignore warning" check box
248 protected function getUploadForm( $message = '', $sessionKey = '', $hideIgnoreWarning = false ) {
252 $form = new UploadForm( array(
253 'watch' => $this->getWatchCheck(),
254 'forreupload' => $this->mForReUpload
,
255 'sessionkey' => $sessionKey,
256 'hideignorewarning' => $hideIgnoreWarning,
257 'destwarningack' => (bool)$this->mDestWarningAck
,
259 'description' => $this->mComment
,
260 'texttop' => $this->uploadFormTextTop
,
261 'textaftersummary' => $this->uploadFormTextAfterSummary
,
262 'destfile' => $this->mDesiredDestName
,
264 $form->setTitle( $this->getTitle() );
266 # Check the token, but only if necessary
268 !$this->mTokenOk
&& !$this->mCancelUpload
&&
269 ( $this->mUpload
&& $this->mUploadClicked
)
272 $form->addPreText( wfMsgExt( 'session_fail_preview', 'parseinline' ) );
275 # Give a notice if the user is uploading a file that has been deleted or moved
276 # Note that this is independent from the message 'filewasdeleted' that requires JS
277 $desiredTitleObj = Title
::makeTitleSafe( NS_FILE
, $this->mDesiredDestName
);
278 $delNotice = ''; // empty by default
279 if ( $desiredTitleObj instanceof Title
&& !$desiredTitleObj->exists() ) {
280 LogEventsList
::showLogExtract( $delNotice, array( 'delete', 'move' ),
281 $desiredTitleObj->getPrefixedText(),
282 '', array( 'lim' => 10,
283 'conds' => array( "log_action != 'revision'" ),
284 'showIfEmpty' => false,
285 'msgKey' => array( 'upload-recreate-warning' ) )
288 $form->addPreText( $delNotice );
291 $form->addPreText( '<div id="uploadtext">' .
292 wfMsgExt( 'uploadtext', 'parse', array( $this->mDesiredDestName
) ) .
294 # Add upload error message
295 $form->addPreText( $message );
298 $uploadFooter = wfMessage( 'uploadfooter' );
299 if ( !$uploadFooter->isDisabled() ) {
300 $form->addPostText( '<div id="mw-upload-footer-message">'
301 . $wgOut->parse( $uploadFooter->plain() ) . "</div>\n" );
309 * Shows the "view X deleted revivions link""
311 protected function showViewDeletedLinks() {
312 global $wgOut, $wgUser;
314 $title = Title
::makeTitleSafe( NS_FILE
, $this->mDesiredDestName
);
315 // Show a subtitle link to deleted revisions (to sysops et al only)
316 if( $title instanceof Title
) {
317 if ( $wgUser->isAllowed( 'deletedhistory' ) ) {
318 $canViewSuppress = $wgUser->isAllowed( 'suppressrevision' );
319 $count = $title->isDeleted( $canViewSuppress );
322 $wgUser->isAllowed( 'delete' ) ?
'thisisdeleted' : 'viewdeleted',
323 array( 'parse', 'replaceafter' ),
324 $this->getSkin()->linkKnown(
325 SpecialPage
::getTitleFor( 'Undelete', $title->getPrefixedText() ),
326 wfMsgExt( 'restorelink', array( 'parsemag', 'escape' ), $count )
329 $wgOut->addHTML( "<div id=\"contentSub2\">{$link}</div>" );
336 * Stashes the upload and shows the main upload form.
338 * Note: only errors that can be handled by changing the name or
339 * description should be redirected here. It should be assumed that the
340 * file itself is sane and has passed UploadBase::verifyFile. This
341 * essentially means that UploadBase::VERIFICATION_ERROR and
342 * UploadBase::EMPTY_FILE should not be passed here.
344 * @param $message String: HTML message to be passed to mainUploadForm
346 protected function showRecoverableUploadError( $message ) {
347 $sessionKey = $this->mUpload
->stashSession();
348 $message = '<h2>' . wfMsgHtml( 'uploadwarning' ) . "</h2>\n" .
349 '<div class="error">' . $message . "</div>\n";
351 $form = $this->getUploadForm( $message, $sessionKey );
352 $form->setSubmitText( wfMsg( 'upload-tryagain' ) );
353 $this->showUploadForm( $form );
356 * Stashes the upload, shows the main form, but adds an "continue anyway button".
357 * Also checks whether there are actually warnings to display.
359 * @param $warnings Array
360 * @return boolean true if warnings were displayed, false if there are no
361 * warnings and the should continue processing like there was no warning
363 protected function showUploadWarning( $warnings ) {
364 # If there are no warnings, or warnings we can ignore, return early.
365 # mDestWarningAck is set when some javascript has shown the warning
366 # to the user. mForReUpload is set when the user clicks the "upload a
368 if ( !$warnings ||
( count( $warnings ) == 1 &&
369 isset( $warnings['exists'] ) &&
370 ( $this->mDestWarningAck ||
$this->mForReUpload
) ) )
375 $sessionKey = $this->mUpload
->stashSession();
377 $warningHtml = '<h2>' . wfMsgHtml( 'uploadwarning' ) . "</h2>\n"
378 . '<ul class="warning">';
379 foreach( $warnings as $warning => $args ) {
380 if( $warning == 'exists' ) {
381 $msg = "\t<li>" . self
::getExistsWarning( $args ) . "</li>\n";
382 } elseif( $warning == 'duplicate' ) {
383 $msg = self
::getDupeWarning( $args );
384 } elseif( $warning == 'duplicate-archive' ) {
385 $msg = "\t<li>" . wfMsgExt( 'file-deleted-duplicate', 'parseinline',
386 array( Title
::makeTitle( NS_FILE
, $args )->getPrefixedText() ) )
389 if ( $args === true ) {
391 } elseif ( !is_array( $args ) ) {
392 $args = array( $args );
394 $msg = "\t<li>" . wfMsgExt( $warning, 'parseinline', $args ) . "</li>\n";
396 $warningHtml .= $msg;
398 $warningHtml .= "</ul>\n";
399 $warningHtml .= wfMsgExt( 'uploadwarning-text', 'parse' );
401 $form = $this->getUploadForm( $warningHtml, $sessionKey, /* $hideIgnoreWarning */ true );
402 $form->setSubmitText( wfMsg( 'upload-tryagain' ) );
403 $form->addButton( 'wpUploadIgnoreWarning', wfMsg( 'ignorewarning' ) );
404 $form->addButton( 'wpCancelUpload', wfMsg( 'reuploaddesc' ) );
406 $this->showUploadForm( $form );
408 # Indicate that we showed a form
413 * Show the upload form with error message, but do not stash the file.
415 * @param $message HTML string
417 protected function showUploadError( $message ) {
418 $message = '<h2>' . wfMsgHtml( 'uploadwarning' ) . "</h2>\n" .
419 '<div class="error">' . $message . "</div>\n";
420 $this->showUploadForm( $this->getUploadForm( $message ) );
425 * Checks are made in SpecialUpload::execute()
427 protected function processUpload() {
428 global $wgUser, $wgOut;
430 // Fetch the file if required
431 $status = $this->mUpload
->fetchFile();
432 if( !$status->isOK() ) {
433 $this->showUploadError( $wgOut->parse( $status->getWikiText() ) );
437 if( !wfRunHooks( 'UploadForm:BeforeProcessing', array( &$this ) ) ) {
438 wfDebug( "Hook 'UploadForm:BeforeProcessing' broke processing the file.\n" );
439 // This code path is deprecated. If you want to break upload processing
440 // do so by hooking into the appropriate hooks in UploadBase::verifyUpload
441 // and UploadBase::verifyFile.
442 // If you use this hook to break uploading, the user will be returned
443 // an empty form with no error message whatsoever.
447 // Upload verification
448 $details = $this->mUpload
->verifyUpload();
449 if ( $details['status'] != UploadBase
::OK
) {
450 $this->processVerificationError( $details );
454 // Verify permissions for this title
455 $permErrors = $this->mUpload
->verifyTitlePermissions( $wgUser );
456 if( $permErrors !== true ) {
457 $code = array_shift( $permErrors[0] );
458 $this->showRecoverableUploadError( wfMsgExt( $code,
459 'parseinline', $permErrors[0] ) );
463 $this->mLocalFile
= $this->mUpload
->getLocalFile();
465 // Check warnings if necessary
466 if( !$this->mIgnoreWarning
) {
467 $warnings = $this->mUpload
->checkWarnings();
468 if( $this->showUploadWarning( $warnings ) ) {
473 // Get the page text if this is not a reupload
474 if( !$this->mForReUpload
) {
475 $pageText = self
::getInitialPageText( $this->mComment
, $this->mLicense
,
476 $this->mCopyrightStatus
, $this->mCopyrightSource
);
480 $status = $this->mUpload
->performUpload( $this->mComment
, $pageText, $this->mWatchthis
, $wgUser );
481 if ( !$status->isGood() ) {
482 $this->showUploadError( $wgOut->parse( $status->getWikiText() ) );
486 // Success, redirect to description page
487 $this->mUploadSuccessful
= true;
488 wfRunHooks( 'SpecialUploadComplete', array( &$this ) );
489 $wgOut->redirect( $this->mLocalFile
->getTitle()->getFullURL() );
493 * Get the initial image page text based on a comment and optional file status information
495 public static function getInitialPageText( $comment = '', $license = '', $copyStatus = '', $source = '' ) {
496 global $wgUseCopyrightUpload, $wgForceUIMsgAsContentMsg;
497 $wgForceUIMsgAsContentMsg = (array) $wgForceUIMsgAsContentMsg;
499 /* These messages are transcluded into the actual text of the description page.
500 * Thus, forcing them as content messages makes the upload to produce an int: template
501 * instead of hardcoding it there in the uploader language.
503 foreach( array( 'license-header', 'filedesc', 'filestatus', 'filesource' ) as $msgName ) {
504 if ( in_array( $msgName, $wgForceUIMsgAsContentMsg ) ) {
505 $msg[$msgName] = "{{int:$msgName}}";
507 $msg[$msgName] = wfMsgForContent( $msgName );
511 if ( $wgUseCopyrightUpload ) {
513 if ( $license != '' ) {
514 $licensetxt = '== ' . $msg[ 'license-header' ] . " ==\n" . '{{' . $license . '}}' . "\n";
516 $pageText = '== ' . $msg[ 'filedesc' ] . " ==\n" . $comment . "\n" .
517 '== ' . $msg[ 'filestatus' ] . " ==\n" . $copyStatus . "\n" .
519 '== ' . $msg[ 'filesource' ] . " ==\n" . $source;
521 if ( $license != '' ) {
522 $filedesc = $comment == '' ?
'' : '== ' . $msg[ 'filedesc' ] . " ==\n" . $comment . "\n";
523 $pageText = $filedesc .
524 '== ' . $msg[ 'license-header' ] . " ==\n" . '{{' . $license . '}}' . "\n";
526 $pageText = $comment;
533 * See if we should check the 'watch this page' checkbox on the form
534 * based on the user's preferences and whether we're being asked
535 * to create a new file or update an existing one.
537 * In the case where 'watch edits' is off but 'watch creations' is on,
538 * we'll leave the box unchecked.
540 * Note that the page target can be changed *on the form*, so our check
541 * state can get out of sync.
543 protected function getWatchCheck() {
545 if( $wgUser->getOption( 'watchdefault' ) ) {
550 $local = wfLocalFile( $this->mDesiredDestName
);
551 if( $local && $local->exists() ) {
552 // We're uploading a new version of an existing file.
553 // No creation, so don't watch it if we're not already.
554 return $local->getTitle()->userIsWatching();
556 // New page should get watched if that's our option.
557 return $wgUser->getOption( 'watchcreations' );
563 * Provides output to the user for a result of UploadBase::verifyUpload
565 * @param $details Array: result of UploadBase::verifyUpload
567 protected function processVerificationError( $details ) {
568 global $wgFileExtensions, $wgLang;
570 switch( $details['status'] ) {
572 /** Statuses that only require name changing **/
573 case UploadBase
::MIN_LENGTH_PARTNAME
:
574 $this->showRecoverableUploadError( wfMsgHtml( 'minlength1' ) );
576 case UploadBase
::ILLEGAL_FILENAME
:
577 $this->showRecoverableUploadError( wfMsgExt( 'illegalfilename',
578 'parseinline', $details['filtered'] ) );
580 case UploadBase
::FILETYPE_MISSING
:
581 $this->showRecoverableUploadError( wfMsgExt( 'filetype-missing',
584 case UploadBase
::WINDOWS_NONASCII_FILENAME
:
585 $this->showRecoverableUploadError( wfMsgExt( 'windows-nonascii-filename',
589 /** Statuses that require reuploading **/
590 case UploadBase
::EMPTY_FILE
:
591 $this->showUploadError( wfMsgHtml( 'emptyfile' ) );
593 case UploadBase
::FILE_TOO_LARGE
:
594 $this->showUploadError( wfMsgHtml( 'largefileserver' ) );
596 case UploadBase
::FILETYPE_BADTYPE
:
597 $msg = wfMessage( 'filetype-banned-type' );
598 if ( isset( $details['blacklistedExt'] ) ) {
599 $msg->params( $wgLang->commaList( $details['blacklistedExt'] ) );
601 $msg->params( $details['finalExt'] );
603 $msg->params( $wgLang->commaList( $wgFileExtensions ),
604 count( $wgFileExtensions ) );
606 // Add PLURAL support for the first parameter. This results
607 // in a bit unlogical parameter sequence, but does not break
609 if ( isset( $details['blacklistedExt'] ) ) {
610 $msg->params( count( $details['blacklistedExt'] ) );
615 $this->showUploadError( $msg->parse() );
617 case UploadBase
::VERIFICATION_ERROR
:
618 unset( $details['status'] );
619 $code = array_shift( $details['details'] );
620 $this->showUploadError( wfMsgExt( $code, 'parseinline', $details['details'] ) );
622 case UploadBase
::HOOK_ABORTED
:
623 if ( is_array( $details['error'] ) ) { # allow hooks to return error details in an array
624 $args = $details['error'];
625 $error = array_shift( $args );
627 $error = $details['error'];
631 $this->showUploadError( wfMsgExt( $error, 'parseinline', $args ) );
634 throw new MWException( __METHOD__
. ": Unknown value `{$details['status']}`" );
639 * Remove a temporarily kept file stashed by saveTempUploadedFile().
641 * @return Boolean: success
643 protected function unsaveUploadedFile() {
645 if ( !( $this->mUpload
instanceof UploadFromStash
) ) {
648 $success = $this->mUpload
->unsaveUploadedFile();
650 $wgOut->showFileDeleteError( $this->mUpload
->getTempPath() );
657 /*** Functions for formatting warnings ***/
660 * Formats a result of UploadBase::getExistsWarning as HTML
661 * This check is static and can be done pre-upload via AJAX
663 * @param $exists Array: the result of UploadBase::getExistsWarning
664 * @return String: empty string if there is no warning or an HTML fragment
666 public static function getExistsWarning( $exists ) {
673 $file = $exists['file'];
674 $filename = $file->getTitle()->getPrefixedText();
677 $sk = $wgUser->getSkin();
679 if( $exists['warning'] == 'exists' ) {
681 $warning = wfMsgExt( 'fileexists', 'parseinline', $filename );
682 } elseif( $exists['warning'] == 'page-exists' ) {
683 // Page exists but file does not
684 $warning = wfMsgExt( 'filepageexists', 'parseinline', $filename );
685 } elseif ( $exists['warning'] == 'exists-normalized' ) {
686 $warning = wfMsgExt( 'fileexists-extension', 'parseinline', $filename,
687 $exists['normalizedFile']->getTitle()->getPrefixedText() );
688 } elseif ( $exists['warning'] == 'thumb' ) {
689 // Swapped argument order compared with other messages for backwards compatibility
690 $warning = wfMsgExt( 'fileexists-thumbnail-yes', 'parseinline',
691 $exists['thumbFile']->getTitle()->getPrefixedText(), $filename );
692 } elseif ( $exists['warning'] == 'thumb-name' ) {
693 // Image w/o '180px-' does not exists, but we do not like these filenames
694 $name = $file->getName();
695 $badPart = substr( $name, 0, strpos( $name, '-' ) +
1 );
696 $warning = wfMsgExt( 'file-thumbnail-no', 'parseinline', $badPart );
697 } elseif ( $exists['warning'] == 'bad-prefix' ) {
698 $warning = wfMsgExt( 'filename-bad-prefix', 'parseinline', $exists['prefix'] );
699 } elseif ( $exists['warning'] == 'was-deleted' ) {
700 # If the file existed before and was deleted, warn the user of this
701 $ltitle = SpecialPage
::getTitleFor( 'Log' );
702 $llink = $sk->linkKnown(
704 wfMsgHtml( 'deletionlog' ),
711 $warning = wfMsgExt( 'filewasdeleted', array( 'parse', 'replaceafter' ), $llink );
718 * Get a list of warnings
720 * @param $filename String: local filename, e.g. 'file exists', 'non-descriptive filename'
721 * @return Array: list of warning messages
723 public static function ajaxGetExistsWarning( $filename ) {
724 $file = wfFindFile( $filename );
726 // Force local file so we have an object to do further checks against
727 // if there isn't an exact match...
728 $file = wfLocalFile( $filename );
732 $exists = UploadBase
::getExistsWarning( $file );
733 $warning = self
::getExistsWarning( $exists );
734 if ( $warning !== '' ) {
735 $s = "<div>$warning</div>";
742 * Construct a warning and a gallery from an array of duplicate files.
744 public static function getDupeWarning( $dupes ) {
748 foreach( $dupes as $file ) {
749 $title = $file->getTitle();
750 $msg .= $title->getPrefixedText() .
751 '|' . $title->getText() . "\n";
753 $msg .= '</gallery>';
755 wfMsgExt( 'file-exists-duplicate', array( 'parse' ), count( $dupes ) ) .
756 $wgOut->parse( $msg ) .
766 * Sub class of HTMLForm that provides the form section of SpecialUpload
768 class UploadForm
extends HTMLForm
{
770 protected $mForReUpload;
771 protected $mSessionKey;
772 protected $mHideIgnoreWarning;
773 protected $mDestWarningAck;
774 protected $mDestFile;
778 protected $mTextAfterSummary;
780 protected $mSourceIds;
782 protected $mMaxFileSize = array();
784 public function __construct( $options = array() ) {
785 $this->mWatch
= !empty( $options['watch'] );
786 $this->mForReUpload
= !empty( $options['forreupload'] );
787 $this->mSessionKey
= isset( $options['sessionkey'] )
788 ?
$options['sessionkey'] : '';
789 $this->mHideIgnoreWarning
= !empty( $options['hideignorewarning'] );
790 $this->mDestWarningAck
= !empty( $options['destwarningack'] );
791 $this->mDestFile
= isset( $options['destfile'] ) ?
$options['destfile'] : '';
793 $this->mComment
= isset( $options['description'] ) ?
794 $options['description'] : '';
796 $this->mTextTop
= isset( $options['texttop'] )
797 ?
$options['texttop'] : '';
799 $this->mTextAfterSummary
= isset( $options['textaftersummary'] )
800 ?
$options['textaftersummary'] : '';
802 $sourceDescriptor = $this->getSourceSection();
803 $descriptor = $sourceDescriptor
804 +
$this->getDescriptionSection()
805 +
$this->getOptionsSection();
807 wfRunHooks( 'UploadFormInitDescriptor', array( &$descriptor ) );
808 parent
::__construct( $descriptor, 'upload' );
810 # Set some form properties
811 $this->setSubmitText( wfMsg( 'uploadbtn' ) );
812 $this->setSubmitName( 'wpUpload' );
813 # Used message keys: 'accesskey-upload', 'tooltip-upload'
814 $this->setSubmitTooltip( 'upload' );
815 $this->setId( 'mw-upload-form' );
817 # Build a list of IDs for javascript insertion
818 $this->mSourceIds
= array();
819 foreach ( $sourceDescriptor as $field ) {
820 if ( !empty( $field['id'] ) ) {
821 $this->mSourceIds
[] = $field['id'];
828 * Get the descriptor of the fieldset that contains the file source
829 * selection. The section is 'source'
831 * @return Array: descriptor array
833 protected function getSourceSection() {
834 global $wgLang, $wgUser, $wgRequest;
836 if ( $this->mSessionKey
) {
838 'SessionKey' => array(
840 'default' => $this->mSessionKey
,
842 'SourceType' => array(
844 'default' => 'Stash',
849 $canUploadByUrl = UploadFromUrl
::isEnabled() && $wgUser->isAllowed( 'upload_by_url' );
850 $radio = $canUploadByUrl;
851 $selectedSourceType = strtolower( $wgRequest->getText( 'wpSourceType', 'File' ) );
853 $descriptor = array();
854 if ( $this->mTextTop
) {
855 $descriptor['UploadFormTextTop'] = array(
857 'section' => 'source',
858 'default' => $this->mTextTop
,
863 $this->mMaxUploadSize
['file'] = UploadBase
::getMaxUploadSize( 'file' );
864 # Limit to upload_max_filesize unless we are running under HipHop and
865 # that setting doesn't exist
866 if ( !wfIsHipHop() ) {
867 $this->mMaxUploadSize
['file'] = min( $this->mMaxUploadSize
['file'],
868 wfShorthandToInteger( ini_get( 'upload_max_filesize' ) ) );
871 $descriptor['UploadFile'] = array(
872 'class' => 'UploadSourceField',
873 'section' => 'source',
875 'id' => 'wpUploadFile',
876 'label-message' => 'sourcefilename',
877 'upload-type' => 'File',
879 'help' => wfMsgExt( 'upload-maxfilesize',
880 array( 'parseinline', 'escapenoentities' ),
881 $wgLang->formatSize( $this->mMaxUploadSize
['file'] )
882 ) . ' ' . wfMsgHtml( 'upload_source_file' ),
883 'checked' => $selectedSourceType == 'file',
885 if ( $canUploadByUrl ) {
886 $this->mMaxUploadSize
['url'] = UploadBase
::getMaxUploadSize( 'url' );
887 $descriptor['UploadFileURL'] = array(
888 'class' => 'UploadSourceField',
889 'section' => 'source',
890 'id' => 'wpUploadFileURL',
891 'label-message' => 'sourceurl',
892 'upload-type' => 'url',
894 'help' => wfMsgExt( 'upload-maxfilesize',
895 array( 'parseinline', 'escapenoentities' ),
896 $wgLang->formatSize( $this->mMaxUploadSize
['url'] )
897 ) . ' ' . wfMsgHtml( 'upload_source_url' ),
898 'checked' => $selectedSourceType == 'url',
901 wfRunHooks( 'UploadFormSourceDescriptors', array( &$descriptor, &$radio, $selectedSourceType ) );
903 $descriptor['Extensions'] = array(
905 'section' => 'source',
906 'default' => $this->getExtensionsMessage(),
913 * Get the messages indicating which extensions are preferred and prohibitted.
915 * @return String: HTML string containing the message
917 protected function getExtensionsMessage() {
918 # Print a list of allowed file extensions, if so configured. We ignore
919 # MIME type here, it's incomprehensible to most people and too long.
920 global $wgLang, $wgCheckFileExtensions, $wgStrictFileExtensions,
921 $wgFileExtensions, $wgFileBlacklist;
923 if( $wgCheckFileExtensions ) {
924 if( $wgStrictFileExtensions ) {
925 # Everything not permitted is banned
927 '<div id="mw-upload-permitted">' .
928 wfMsgExt( 'upload-permitted', 'parse', $wgLang->commaList( $wgFileExtensions ) ) .
931 # We have to list both preferred and prohibited
933 '<div id="mw-upload-preferred">' .
934 wfMsgExt( 'upload-preferred', 'parse', $wgLang->commaList( $wgFileExtensions ) ) .
936 '<div id="mw-upload-prohibited">' .
937 wfMsgExt( 'upload-prohibited', 'parse', $wgLang->commaList( $wgFileBlacklist ) ) .
941 # Everything is permitted.
942 $extensionsList = '';
944 return $extensionsList;
948 * Get the descriptor of the fieldset that contains the file description
949 * input. The section is 'description'
951 * @return Array: descriptor array
953 protected function getDescriptionSection() {
956 if ( $this->mSessionKey
) {
957 $stash = RepoGroup
::singleton()->getLocalRepo()->getUploadStash();
959 $file = $stash->getFile( $this->mSessionKey
);
960 } catch ( MWException
$e ) {
966 $mto = $file->transform( array( 'width' => 120 ) );
967 $this->addHeaderText(
968 '<div class="thumb t' . $wgContLang->alignEnd() . '">' .
969 Html
::element( 'img', array(
970 'src' => $mto->getUrl(),
971 'class' => 'thumbimage',
972 ) ) . '</div>', 'description' );
979 'section' => 'description',
980 'id' => 'wpDestFile',
981 'label-message' => 'destfilename',
983 'default' => $this->mDestFile
,
984 # @todo FIXME: Hack to work around poor handling of the 'default' option in HTMLForm
985 'nodata' => strval( $this->mDestFile
) !== '',
987 'UploadDescription' => array(
988 'type' => 'textarea',
989 'section' => 'description',
990 'id' => 'wpUploadDescription',
991 'label-message' => $this->mForReUpload
992 ?
'filereuploadsummary'
993 : 'fileuploadsummary',
994 'default' => $this->mComment
,
995 'cols' => intval( $wgUser->getOption( 'cols' ) ),
999 if ( $this->mTextAfterSummary
) {
1000 $descriptor['UploadFormTextAfterSummary'] = array(
1002 'section' => 'description',
1003 'default' => $this->mTextAfterSummary
,
1008 $descriptor +
= array(
1009 'EditTools' => array(
1010 'type' => 'edittools',
1011 'section' => 'description',
1012 'message' => 'edittools-upload',
1016 if ( $this->mForReUpload
) {
1017 $descriptor['DestFile']['readonly'] = true;
1019 $descriptor['License'] = array(
1021 'class' => 'Licenses',
1022 'section' => 'description',
1023 'id' => 'wpLicense',
1024 'label-message' => 'license',
1028 global $wgUseCopyrightUpload;
1029 if ( $wgUseCopyrightUpload ) {
1030 $descriptor['UploadCopyStatus'] = array(
1032 'section' => 'description',
1033 'id' => 'wpUploadCopyStatus',
1034 'label-message' => 'filestatus',
1036 $descriptor['UploadSource'] = array(
1038 'section' => 'description',
1039 'id' => 'wpUploadSource',
1040 'label-message' => 'filesource',
1048 * Get the descriptor of the fieldset that contains the upload options,
1049 * such as "watch this file". The section is 'options'
1051 * @return Array: descriptor array
1053 protected function getOptionsSection() {
1056 if ( $wgUser->isLoggedIn() ) {
1057 $descriptor = array(
1058 'Watchthis' => array(
1060 'id' => 'wpWatchthis',
1061 'label-message' => 'watchthisupload',
1062 'section' => 'options',
1063 'default' => $wgUser->getOption( 'watchcreations' ),
1067 if ( !$this->mHideIgnoreWarning
) {
1068 $descriptor['IgnoreWarning'] = array(
1070 'id' => 'wpIgnoreWarning',
1071 'label-message' => 'ignorewarnings',
1072 'section' => 'options',
1076 $descriptor['DestFileWarningAck'] = array(
1078 'id' => 'wpDestFileWarningAck',
1079 'default' => $this->mDestWarningAck ?
'1' : '',
1082 if ( $this->mForReUpload
) {
1083 $descriptor['ForReUpload'] = array(
1085 'id' => 'wpForReUpload',
1094 * Add the upload JS and show the form.
1096 public function show() {
1097 $this->addUploadJS();
1102 * Add upload JS to $wgOut
1104 protected function addUploadJS() {
1105 global $wgUseAjax, $wgAjaxUploadDestCheck, $wgAjaxLicensePreview, $wgEnableAPI, $wgStrictFileExtensions;
1108 $useAjaxDestCheck = $wgUseAjax && $wgAjaxUploadDestCheck;
1109 $useAjaxLicensePreview = $wgUseAjax && $wgAjaxLicensePreview && $wgEnableAPI;
1110 $this->mMaxUploadSize
['*'] = UploadBase
::getMaxUploadSize();
1112 $scriptVars = array(
1113 'wgAjaxUploadDestCheck' => $useAjaxDestCheck,
1114 'wgAjaxLicensePreview' => $useAjaxLicensePreview,
1115 'wgUploadAutoFill' => !$this->mForReUpload
&&
1116 // If we received mDestFile from the request, don't autofill
1117 // the wpDestFile textbox
1118 $this->mDestFile
=== '',
1119 'wgUploadSourceIds' => $this->mSourceIds
,
1120 'wgStrictFileExtensions' => $wgStrictFileExtensions,
1121 'wgCapitalizeUploads' => MWNamespace
::isCapitalized( NS_FILE
),
1122 'wgMaxUploadSize' => $this->mMaxUploadSize
,
1125 $wgOut->addScript( Skin
::makeVariablesScript( $scriptVars ) );
1128 $wgOut->addModules( array(
1129 'mediawiki.legacy.edit', // For <charinsert> support
1130 'mediawiki.legacy.upload', // Old form stuff...
1131 'mediawiki.special.upload', // Newer extras for thumbnail preview.
1136 * Empty function; submission is handled elsewhere.
1138 * @return bool false
1140 function trySubmit() {
1147 * A form field that contains a radio box in the label
1149 class UploadSourceField
extends HTMLTextField
{
1150 function getLabelHtml( $cellAttributes = array() ) {
1151 $id = "wpSourceType{$this->mParams['upload-type']}";
1152 $label = Html
::rawElement( 'label', array( 'for' => $id ), $this->mLabel
);
1154 if ( !empty( $this->mParams
['radio'] ) ) {
1156 'name' => 'wpSourceType',
1159 'value' => $this->mParams
['upload-type'],
1161 if ( !empty( $this->mParams
['checked'] ) ) {
1162 $attribs['checked'] = 'checked';
1164 $label .= Html
::element( 'input', $attribs );
1167 return Html
::rawElement( 'td', array( 'class' => 'mw-label' ) +
$cellAttributes, $label );
1170 function getSize() {
1171 return isset( $this->mParams
['size'] )
1172 ?
$this->mParams
['size']