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 WebRequest $request Data posted.
37 public function __construct( $request = null ) {
38 parent
::__construct( 'Upload', 'upload' );
41 /** Misc variables **/
43 /** @var WebRequest|FauxRequest The request this form is supposed to handle */
47 /** @var UploadBase */
52 public $mUploadClicked;
54 /** User input variables from the "description" section **/
56 /** @var string The requested target file name */
57 public $mDesiredDestName;
61 /** User input variables from the root section **/
63 public $mIgnoreWarning;
65 public $mCopyrightStatus;
66 public $mCopyrightSource;
68 /** Hidden variables **/
70 public $mDestWarningAck;
72 /** @var bool The user followed an "overwrite this file" link */
75 /** @var bool The user clicked "Cancel and return to upload form" button */
76 public $mCancelUpload;
79 /** @var bool Subclasses can use this to determine whether a file was uploaded */
80 public $mUploadSuccessful = false;
82 /** Text injection points for hooks not using HTMLForm **/
83 public $uploadFormTextTop;
84 public $uploadFormTextAfterSummary;
87 * Initialize instance variables from request and create an Upload handler
89 protected function loadRequest() {
90 $this->mRequest
= $request = $this->getRequest();
91 $this->mSourceType
= $request->getVal( 'wpSourceType', 'file' );
92 $this->mUpload
= UploadBase
::createFromRequest( $request );
93 $this->mUploadClicked
= $request->wasPosted()
94 && ( $request->getCheck( 'wpUpload' )
95 ||
$request->getCheck( 'wpUploadIgnoreWarning' ) );
97 // Guess the desired name from the filename if not provided
98 $this->mDesiredDestName
= $request->getText( 'wpDestFile' );
99 if ( !$this->mDesiredDestName
&& $request->getFileName( 'wpUploadFile' ) !== null ) {
100 $this->mDesiredDestName
= $request->getFileName( 'wpUploadFile' );
102 $this->mLicense
= $request->getText( 'wpLicense' );
104 $this->mDestWarningAck
= $request->getText( 'wpDestFileWarningAck' );
105 $this->mIgnoreWarning
= $request->getCheck( 'wpIgnoreWarning' )
106 ||
$request->getCheck( 'wpUploadIgnoreWarning' );
107 $this->mWatchthis
= $request->getBool( 'wpWatchthis' ) && $this->getUser()->isLoggedIn();
108 $this->mCopyrightStatus
= $request->getText( 'wpUploadCopyStatus' );
109 $this->mCopyrightSource
= $request->getText( 'wpUploadSource' );
111 $this->mForReUpload
= $request->getBool( 'wpForReUpload' ); // updating a file
113 $commentDefault = '';
114 $commentMsg = wfMessage( 'upload-default-description' )->inContentLanguage();
115 if ( !$this->mForReUpload
&& !$commentMsg->isDisabled() ) {
116 $commentDefault = $commentMsg->plain();
118 $this->mComment
= $request->getText( 'wpUploadDescription', $commentDefault );
120 $this->mCancelUpload
= $request->getCheck( 'wpCancelUpload' )
121 ||
$request->getCheck( 'wpReUpload' ); // b/w compat
123 // If it was posted check for the token (no remote POST'ing with user credentials)
124 $token = $request->getVal( 'wpEditToken' );
125 $this->mTokenOk
= $this->getUser()->matchEditToken( $token );
127 $this->uploadFormTextTop
= '';
128 $this->uploadFormTextAfterSummary
= '';
132 * This page can be shown if uploading is enabled.
133 * Handle permission checking elsewhere in order to be able to show
134 * custom error messages.
139 public function userCanExecute( User
$user ) {
140 return UploadBase
::isEnabled() && parent
::userCanExecute( $user );
144 * Special page entry point
147 public function execute( $par ) {
149 $this->outputHeader();
151 # Check uploading enabled
152 if ( !UploadBase
::isEnabled() ) {
153 throw new ErrorPageError( 'uploaddisabled', 'uploaddisabledtext' );
157 $user = $this->getUser();
158 $permissionRequired = UploadBase
::isAllowed( $user );
159 if ( $permissionRequired !== true ) {
160 throw new PermissionsError( $permissionRequired );
164 if ( $user->isBlocked() ) {
165 throw new UserBlockedError( $user->getBlock() );
168 # Check whether we actually want to allow changing stuff
169 $this->checkReadOnly();
171 $this->loadRequest();
173 # Unsave the temporary file in case this was a cancelled upload
174 if ( $this->mCancelUpload
) {
175 if ( !$this->unsaveUploadedFile() ) {
176 # Something went wrong, so unsaveUploadedFile showed a warning
181 # Process upload or show a form
183 $this->mTokenOk
&& !$this->mCancelUpload
&&
184 ( $this->mUpload
&& $this->mUploadClicked
)
186 $this->processUpload();
188 # Backwards compatibility hook
189 if ( !wfRunHooks( 'UploadForm:initial', array( &$this ) ) ) {
190 wfDebug( "Hook 'UploadForm:initial' broke output of the upload form\n" );
194 $this->showUploadForm( $this->getUploadForm() );
198 if ( $this->mUpload
) {
199 $this->mUpload
->cleanupTempFile();
204 * Show the main upload form
206 * @param HTMLForm|string $form An HTMLForm instance or HTML string to show
208 protected function showUploadForm( $form ) {
209 # Add links if file was previously deleted
210 if ( $this->mDesiredDestName
) {
211 $this->showViewDeletedLinks();
214 if ( $form instanceof HTMLForm
) {
217 $this->getOutput()->addHTML( $form );
222 * Get an UploadForm instance with title and text properly set.
224 * @param string $message HTML string to add to the form
225 * @param string $sessionKey Session key in case this is a stashed upload
226 * @param bool $hideIgnoreWarning Whether to hide "ignore warning" check box
229 protected function getUploadForm( $message = '', $sessionKey = '', $hideIgnoreWarning = false ) {
231 $context = new DerivativeContext( $this->getContext() );
232 $context->setTitle( $this->getPageTitle() ); // Remove subpage
233 $form = new UploadForm( array(
234 'watch' => $this->getWatchCheck(),
235 'forreupload' => $this->mForReUpload
,
236 'sessionkey' => $sessionKey,
237 'hideignorewarning' => $hideIgnoreWarning,
238 'destwarningack' => (bool)$this->mDestWarningAck
,
240 'description' => $this->mComment
,
241 'texttop' => $this->uploadFormTextTop
,
242 'textaftersummary' => $this->uploadFormTextAfterSummary
,
243 'destfile' => $this->mDesiredDestName
,
246 # Check the token, but only if necessary
248 !$this->mTokenOk
&& !$this->mCancelUpload
&&
249 ( $this->mUpload
&& $this->mUploadClicked
)
251 $form->addPreText( $this->msg( 'session_fail_preview' )->parse() );
254 # Give a notice if the user is uploading a file that has been deleted or moved
255 # Note that this is independent from the message 'filewasdeleted' that requires JS
256 $desiredTitleObj = Title
::makeTitleSafe( NS_FILE
, $this->mDesiredDestName
);
257 $delNotice = ''; // empty by default
258 if ( $desiredTitleObj instanceof Title
&& !$desiredTitleObj->exists() ) {
259 LogEventsList
::showLogExtract( $delNotice, array( 'delete', 'move' ),
261 '', array( 'lim' => 10,
262 'conds' => array( "log_action != 'revision'" ),
263 'showIfEmpty' => false,
264 'msgKey' => array( 'upload-recreate-warning' ) )
267 $form->addPreText( $delNotice );
270 $form->addPreText( '<div id="uploadtext">' .
271 $this->msg( 'uploadtext', array( $this->mDesiredDestName
) )->parseAsBlock() .
273 # Add upload error message
274 $form->addPreText( $message );
277 $uploadFooter = $this->msg( 'uploadfooter' );
278 if ( !$uploadFooter->isDisabled() ) {
279 $form->addPostText( '<div id="mw-upload-footer-message">'
280 . $uploadFooter->parseAsBlock() . "</div>\n" );
287 * Shows the "view X deleted revivions link""
289 protected function showViewDeletedLinks() {
290 $title = Title
::makeTitleSafe( NS_FILE
, $this->mDesiredDestName
);
291 $user = $this->getUser();
292 // Show a subtitle link to deleted revisions (to sysops et al only)
293 if ( $title instanceof Title
) {
294 $count = $title->isDeleted();
295 if ( $count > 0 && $user->isAllowed( 'deletedhistory' ) ) {
296 $restorelink = Linker
::linkKnown(
297 SpecialPage
::getTitleFor( 'Undelete', $title->getPrefixedText() ),
298 $this->msg( 'restorelink' )->numParams( $count )->escaped()
300 $link = $this->msg( $user->isAllowed( 'delete' ) ?
'thisisdeleted' : 'viewdeleted' )
301 ->rawParams( $restorelink )->parseAsBlock();
302 $this->getOutput()->addHTML( "<div id=\"contentSub2\">{$link}</div>" );
308 * Stashes the upload and shows the main upload form.
310 * Note: only errors that can be handled by changing the name or
311 * description should be redirected here. It should be assumed that the
312 * file itself is sane and has passed UploadBase::verifyFile. This
313 * essentially means that UploadBase::VERIFICATION_ERROR and
314 * UploadBase::EMPTY_FILE should not be passed here.
316 * @param string $message HTML message to be passed to mainUploadForm
318 protected function showRecoverableUploadError( $message ) {
319 $sessionKey = $this->mUpload
->stashSession();
320 $message = '<h2>' . $this->msg( 'uploaderror' )->escaped() . "</h2>\n" .
321 '<div class="error">' . $message . "</div>\n";
323 $form = $this->getUploadForm( $message, $sessionKey );
324 $form->setSubmitText( $this->msg( 'upload-tryagain' )->escaped() );
325 $this->showUploadForm( $form );
329 * Stashes the upload, shows the main form, but adds a "continue anyway button".
330 * Also checks whether there are actually warnings to display.
332 * @param array $warnings
333 * @return bool True if warnings were displayed, false if there are no
334 * warnings and it should continue processing
336 protected function showUploadWarning( $warnings ) {
337 # If there are no warnings, or warnings we can ignore, return early.
338 # mDestWarningAck is set when some javascript has shown the warning
339 # to the user. mForReUpload is set when the user clicks the "upload a
341 if ( !$warnings ||
( count( $warnings ) == 1
342 && isset( $warnings['exists'] )
343 && ( $this->mDestWarningAck ||
$this->mForReUpload
) )
348 $sessionKey = $this->mUpload
->stashSession();
350 $warningHtml = '<h2>' . $this->msg( 'uploadwarning' )->escaped() . "</h2>\n"
351 . '<ul class="warning">';
352 foreach ( $warnings as $warning => $args ) {
353 if ( $warning == 'badfilename' ) {
354 $this->mDesiredDestName
= Title
::makeTitle( NS_FILE
, $args )->getText();
356 if ( $warning == 'exists' ) {
357 $msg = "\t<li>" . self
::getExistsWarning( $args ) . "</li>\n";
358 } elseif ( $warning == 'duplicate' ) {
359 $msg = $this->getDupeWarning( $args );
360 } elseif ( $warning == 'duplicate-archive' ) {
361 if ( $args === '' ) {
362 $msg = "\t<li>" . $this->msg( 'file-deleted-duplicate-notitle' )->parse()
365 $msg = "\t<li>" . $this->msg( 'file-deleted-duplicate',
366 Title
::makeTitle( NS_FILE
, $args )->getPrefixedText() )->parse()
370 if ( $args === true ) {
372 } elseif ( !is_array( $args ) ) {
373 $args = array( $args );
375 $msg = "\t<li>" . $this->msg( $warning, $args )->parse() . "</li>\n";
377 $warningHtml .= $msg;
379 $warningHtml .= "</ul>\n";
380 $warningHtml .= $this->msg( 'uploadwarning-text' )->parseAsBlock();
382 $form = $this->getUploadForm( $warningHtml, $sessionKey, /* $hideIgnoreWarning */ true );
383 $form->setSubmitText( $this->msg( 'upload-tryagain' )->text() );
384 $form->addButton( 'wpUploadIgnoreWarning', $this->msg( 'ignorewarning' )->text() );
385 $form->addButton( 'wpCancelUpload', $this->msg( 'reuploaddesc' )->text() );
387 $this->showUploadForm( $form );
389 # Indicate that we showed a form
394 * Show the upload form with error message, but do not stash the file.
396 * @param string $message HTML string
398 protected function showUploadError( $message ) {
399 $message = '<h2>' . $this->msg( 'uploadwarning' )->escaped() . "</h2>\n" .
400 '<div class="error">' . $message . "</div>\n";
401 $this->showUploadForm( $this->getUploadForm( $message ) );
406 * Checks are made in SpecialUpload::execute()
408 protected function processUpload() {
409 // Fetch the file if required
410 $status = $this->mUpload
->fetchFile();
411 if ( !$status->isOK() ) {
412 $this->showUploadError( $this->getOutput()->parse( $status->getWikiText() ) );
417 if ( !wfRunHooks( 'UploadForm:BeforeProcessing', array( &$this ) ) ) {
418 wfDebug( "Hook 'UploadForm:BeforeProcessing' broke processing the file.\n" );
419 // This code path is deprecated. If you want to break upload processing
420 // do so by hooking into the appropriate hooks in UploadBase::verifyUpload
421 // and UploadBase::verifyFile.
422 // If you use this hook to break uploading, the user will be returned
423 // an empty form with no error message whatsoever.
427 // Upload verification
428 $details = $this->mUpload
->verifyUpload();
429 if ( $details['status'] != UploadBase
::OK
) {
430 $this->processVerificationError( $details );
435 // Verify permissions for this title
436 $permErrors = $this->mUpload
->verifyTitlePermissions( $this->getUser() );
437 if ( $permErrors !== true ) {
438 $code = array_shift( $permErrors[0] );
439 $this->showRecoverableUploadError( $this->msg( $code, $permErrors[0] )->parse() );
444 $this->mLocalFile
= $this->mUpload
->getLocalFile();
446 // Check warnings if necessary
447 if ( !$this->mIgnoreWarning
) {
448 $warnings = $this->mUpload
->checkWarnings();
449 if ( $this->showUploadWarning( $warnings ) ) {
454 // Get the page text if this is not a reupload
455 if ( !$this->mForReUpload
) {
456 $pageText = self
::getInitialPageText( $this->mComment
, $this->mLicense
,
457 $this->mCopyrightStatus
, $this->mCopyrightSource
);
462 $status = $this->mUpload
->performUpload(
469 if ( !$status->isGood() ) {
470 $this->showUploadError( $this->getOutput()->parse( $status->getWikiText() ) );
475 // Success, redirect to description page
476 $this->mUploadSuccessful
= true;
477 wfRunHooks( 'SpecialUploadComplete', array( &$this ) );
478 $this->getOutput()->redirect( $this->mLocalFile
->getTitle()->getFullURL() );
482 * Get the initial image page text based on a comment and optional file status information
483 * @param string $comment
484 * @param string $license
485 * @param string $copyStatus
486 * @param string $source
488 * @todo Use Config obj instead of globals
490 public static function getInitialPageText( $comment = '', $license = '',
491 $copyStatus = '', $source = ''
493 global $wgUseCopyrightUpload, $wgForceUIMsgAsContentMsg;
496 /* These messages are transcluded into the actual text of the description page.
497 * Thus, forcing them as content messages makes the upload to produce an int: template
498 * instead of hardcoding it there in the uploader language.
500 foreach ( array( 'license-header', 'filedesc', 'filestatus', 'filesource' ) as $msgName ) {
501 if ( in_array( $msgName, (array)$wgForceUIMsgAsContentMsg ) ) {
502 $msg[$msgName] = "{{int:$msgName}}";
504 $msg[$msgName] = wfMessage( $msgName )->inContentLanguage()->text();
508 if ( $wgUseCopyrightUpload ) {
510 if ( $license != '' ) {
511 $licensetxt = '== ' . $msg['license-header'] . " ==\n" . '{{' . $license . '}}' . "\n";
513 $pageText = '== ' . $msg['filedesc'] . " ==\n" . $comment . "\n" .
514 '== ' . $msg['filestatus'] . " ==\n" . $copyStatus . "\n" .
516 '== ' . $msg['filesource'] . " ==\n" . $source;
518 if ( $license != '' ) {
519 $filedesc = $comment == '' ?
'' : '== ' . $msg['filedesc'] . " ==\n" . $comment . "\n";
520 $pageText = $filedesc .
521 '== ' . $msg['license-header'] . " ==\n" . '{{' . $license . '}}' . "\n";
523 $pageText = $comment;
531 * See if we should check the 'watch this page' checkbox on the form
532 * based on the user's preferences and whether we're being asked
533 * to create a new file or update an existing one.
535 * In the case where 'watch edits' is off but 'watch creations' is on,
536 * we'll leave the box unchecked.
538 * Note that the page target can be changed *on the form*, so our check
539 * state can get out of sync.
540 * @return bool|string
542 protected function getWatchCheck() {
543 if ( $this->getUser()->getOption( 'watchdefault' ) ) {
548 $desiredTitleObj = Title
::makeTitleSafe( NS_FILE
, $this->mDesiredDestName
);
549 if ( $desiredTitleObj instanceof Title
&& $this->getUser()->isWatched( $desiredTitleObj ) ) {
550 // Already watched, don't change that
554 $local = wfLocalFile( $this->mDesiredDestName
);
555 if ( $local && $local->exists() ) {
556 // We're uploading a new version of an existing file.
557 // No creation, so don't watch it if we're not already.
560 // New page should get watched if that's our option.
561 return $this->getUser()->getOption( 'watchcreations' );
566 * Provides output to the user for a result of UploadBase::verifyUpload
568 * @param array $details Result of UploadBase::verifyUpload
569 * @throws MWException
571 protected function processVerificationError( $details ) {
572 switch ( $details['status'] ) {
574 /** Statuses that only require name changing **/
575 case UploadBase
::MIN_LENGTH_PARTNAME
:
576 $this->showRecoverableUploadError( $this->msg( 'minlength1' )->escaped() );
578 case UploadBase
::ILLEGAL_FILENAME
:
579 $this->showRecoverableUploadError( $this->msg( 'illegalfilename',
580 $details['filtered'] )->parse() );
582 case UploadBase
::FILENAME_TOO_LONG
:
583 $this->showRecoverableUploadError( $this->msg( 'filename-toolong' )->escaped() );
585 case UploadBase
::FILETYPE_MISSING
:
586 $this->showRecoverableUploadError( $this->msg( 'filetype-missing' )->parse() );
588 case UploadBase
::WINDOWS_NONASCII_FILENAME
:
589 $this->showRecoverableUploadError( $this->msg( 'windows-nonascii-filename' )->parse() );
592 /** Statuses that require reuploading **/
593 case UploadBase
::EMPTY_FILE
:
594 $this->showUploadError( $this->msg( 'emptyfile' )->escaped() );
596 case UploadBase
::FILE_TOO_LARGE
:
597 $this->showUploadError( $this->msg( 'largefileserver' )->escaped() );
599 case UploadBase
::FILETYPE_BADTYPE
:
600 $msg = $this->msg( 'filetype-banned-type' );
601 if ( isset( $details['blacklistedExt'] ) ) {
602 $msg->params( $this->getLanguage()->commaList( $details['blacklistedExt'] ) );
604 $msg->params( $details['finalExt'] );
606 $extensions = array_unique( $this->getConfig()->get( 'FileExtensions' ) );
607 $msg->params( $this->getLanguage()->commaList( $extensions ),
608 count( $extensions ) );
610 // Add PLURAL support for the first parameter. This results
611 // in a bit unlogical parameter sequence, but does not break
613 if ( isset( $details['blacklistedExt'] ) ) {
614 $msg->params( count( $details['blacklistedExt'] ) );
619 $this->showUploadError( $msg->parse() );
621 case UploadBase
::VERIFICATION_ERROR
:
622 unset( $details['status'] );
623 $code = array_shift( $details['details'] );
624 $this->showUploadError( $this->msg( $code, $details['details'] )->parse() );
626 case UploadBase
::HOOK_ABORTED
:
627 if ( is_array( $details['error'] ) ) { # allow hooks to return error details in an array
628 $args = $details['error'];
629 $error = array_shift( $args );
631 $error = $details['error'];
635 $this->showUploadError( $this->msg( $error, $args )->parse() );
638 throw new MWException( __METHOD__
. ": Unknown value `{$details['status']}`" );
643 * Remove a temporarily kept file stashed by saveTempUploadedFile().
645 * @return bool Success
647 protected function unsaveUploadedFile() {
648 if ( !( $this->mUpload
instanceof UploadFromStash
) ) {
651 $success = $this->mUpload
->unsaveUploadedFile();
653 $this->getOutput()->showFileDeleteError( $this->mUpload
->getTempPath() );
661 /*** Functions for formatting warnings ***/
664 * Formats a result of UploadBase::getExistsWarning as HTML
665 * This check is static and can be done pre-upload via AJAX
667 * @param array $exists The result of UploadBase::getExistsWarning
668 * @return string Empty string if there is no warning or an HTML fragment
670 public static function getExistsWarning( $exists ) {
675 $file = $exists['file'];
676 $filename = $file->getTitle()->getPrefixedText();
679 if ( $exists['warning'] == 'exists' ) {
681 $warning = wfMessage( 'fileexists', $filename )->parse();
682 } elseif ( $exists['warning'] == 'page-exists' ) {
683 // Page exists but file does not
684 $warning = wfMessage( 'filepageexists', $filename )->parse();
685 } elseif ( $exists['warning'] == 'exists-normalized' ) {
686 $warning = wfMessage( 'fileexists-extension', $filename,
687 $exists['normalizedFile']->getTitle()->getPrefixedText() )->parse();
688 } elseif ( $exists['warning'] == 'thumb' ) {
689 // Swapped argument order compared with other messages for backwards compatibility
690 $warning = wfMessage( 'fileexists-thumbnail-yes',
691 $exists['thumbFile']->getTitle()->getPrefixedText(), $filename )->parse();
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 = wfMessage( 'file-thumbnail-no', $badPart )->parse();
697 } elseif ( $exists['warning'] == 'bad-prefix' ) {
698 $warning = wfMessage( 'filename-bad-prefix', $exists['prefix'] )->parse();
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 = Linker
::linkKnown(
704 wfMessage( 'deletionlog' )->escaped(),
711 $warning = wfMessage( 'filewasdeleted' )->rawParams( $llink )->parseAsBlock();
718 * Construct a warning and a gallery from an array of duplicate files.
719 * @param array $dupes
722 public function getDupeWarning( $dupes ) {
727 $gallery = ImageGalleryBase
::factory( false, $this->getContext() );
728 $gallery->setShowBytes( false );
729 foreach ( $dupes as $file ) {
730 $gallery->add( $file->getTitle() );
734 wfMessage( 'file-exists-duplicate' )->numParams( count( $dupes ) )->parse() .
735 $gallery->toHtml() . "</li>\n";
738 protected function getGroupName() {
744 * Sub class of HTMLForm that provides the form section of SpecialUpload
746 class UploadForm
extends HTMLForm
{
748 protected $mForReUpload;
749 protected $mSessionKey;
750 protected $mHideIgnoreWarning;
751 protected $mDestWarningAck;
752 protected $mDestFile;
756 protected $mTextAfterSummary;
758 protected $mSourceIds;
760 protected $mMaxFileSize = array();
762 protected $mMaxUploadSize = array();
764 public function __construct( array $options = array(), IContextSource
$context = null ) {
765 $this->mWatch
= !empty( $options['watch'] );
766 $this->mForReUpload
= !empty( $options['forreupload'] );
767 $this->mSessionKey
= isset( $options['sessionkey'] ) ?
$options['sessionkey'] : '';
768 $this->mHideIgnoreWarning
= !empty( $options['hideignorewarning'] );
769 $this->mDestWarningAck
= !empty( $options['destwarningack'] );
770 $this->mDestFile
= isset( $options['destfile'] ) ?
$options['destfile'] : '';
772 $this->mComment
= isset( $options['description'] ) ?
773 $options['description'] : '';
775 $this->mTextTop
= isset( $options['texttop'] )
776 ?
$options['texttop'] : '';
778 $this->mTextAfterSummary
= isset( $options['textaftersummary'] )
779 ?
$options['textaftersummary'] : '';
781 $sourceDescriptor = $this->getSourceSection();
782 $descriptor = $sourceDescriptor
783 +
$this->getDescriptionSection()
784 +
$this->getOptionsSection();
786 wfRunHooks( 'UploadFormInitDescriptor', array( &$descriptor ) );
787 parent
::__construct( $descriptor, $context, 'upload' );
789 # Add a link to edit MediaWik:Licenses
790 if ( $this->getUser()->isAllowed( 'editinterface' ) ) {
791 $licensesLink = Linker
::link(
792 Title
::makeTitle( NS_MEDIAWIKI
, 'Licenses' ),
793 $this->msg( 'licenses-edit' )->escaped(),
795 array( 'action' => 'edit' )
797 $editLicenses = '<p class="mw-upload-editlicenses">' . $licensesLink . '</p>';
798 $this->addFooterText( $editLicenses, 'description' );
801 # Set some form properties
802 $this->setSubmitText( $this->msg( 'uploadbtn' )->text() );
803 $this->setSubmitName( 'wpUpload' );
804 # Used message keys: 'accesskey-upload', 'tooltip-upload'
805 $this->setSubmitTooltip( 'upload' );
806 $this->setId( 'mw-upload-form' );
808 # Build a list of IDs for javascript insertion
809 $this->mSourceIds
= array();
810 foreach ( $sourceDescriptor as $field ) {
811 if ( !empty( $field['id'] ) ) {
812 $this->mSourceIds
[] = $field['id'];
818 * Get the descriptor of the fieldset that contains the file source
819 * selection. The section is 'source'
821 * @return array Descriptor array
823 protected function getSourceSection() {
824 if ( $this->mSessionKey
) {
826 'SessionKey' => array(
828 'default' => $this->mSessionKey
,
830 'SourceType' => array(
832 'default' => 'Stash',
837 $canUploadByUrl = UploadFromUrl
::isEnabled()
838 && ( UploadFromUrl
::isAllowed( $this->getUser() ) === true )
839 && $this->getConfig()->get( 'CopyUploadsFromSpecialUpload' );
840 $radio = $canUploadByUrl;
841 $selectedSourceType = strtolower( $this->getRequest()->getText( 'wpSourceType', 'File' ) );
843 $descriptor = array();
844 if ( $this->mTextTop
) {
845 $descriptor['UploadFormTextTop'] = array(
847 'section' => 'source',
848 'default' => $this->mTextTop
,
853 $this->mMaxUploadSize
['file'] = UploadBase
::getMaxUploadSize( 'file' );
854 # Limit to upload_max_filesize unless we are running under HipHop and
855 # that setting doesn't exist
857 $this->mMaxUploadSize
['file'] = min( $this->mMaxUploadSize
['file'],
858 wfShorthandToInteger( ini_get( 'upload_max_filesize' ) ),
859 wfShorthandToInteger( ini_get( 'post_max_size' ) )
863 $descriptor['UploadFile'] = array(
864 'class' => 'UploadSourceField',
865 'section' => 'source',
867 'id' => 'wpUploadFile',
868 'radio-id' => 'wpSourceTypeFile',
869 'label-message' => 'sourcefilename',
870 'upload-type' => 'File',
872 'help' => $this->msg( 'upload-maxfilesize',
873 $this->getContext()->getLanguage()->formatSize( $this->mMaxUploadSize
['file'] )
875 $this->msg( 'word-separator' )->escaped() .
876 $this->msg( 'upload_source_file' )->escaped(),
877 'checked' => $selectedSourceType == 'file',
880 if ( $canUploadByUrl ) {
881 $this->mMaxUploadSize
['url'] = UploadBase
::getMaxUploadSize( 'url' );
882 $descriptor['UploadFileURL'] = array(
883 'class' => 'UploadSourceField',
884 'section' => 'source',
885 'id' => 'wpUploadFileURL',
886 'radio-id' => 'wpSourceTypeurl',
887 'label-message' => 'sourceurl',
888 'upload-type' => 'url',
890 'help' => $this->msg( 'upload-maxfilesize',
891 $this->getContext()->getLanguage()->formatSize( $this->mMaxUploadSize
['url'] )
893 $this->msg( 'word-separator' )->escaped() .
894 $this->msg( 'upload_source_url' )->escaped(),
895 'checked' => $selectedSourceType == 'url',
898 wfRunHooks( 'UploadFormSourceDescriptors', array( &$descriptor, &$radio, $selectedSourceType ) );
900 $descriptor['Extensions'] = array(
902 'section' => 'source',
903 'default' => $this->getExtensionsMessage(),
911 * Get the messages indicating which extensions are preferred and prohibitted.
913 * @return string HTML string containing the message
915 protected function getExtensionsMessage() {
916 # Print a list of allowed file extensions, if so configured. We ignore
917 # MIME type here, it's incomprehensible to most people and too long.
918 $config = $this->getConfig();
920 if ( $config->get( 'CheckFileExtensions' ) ) {
921 if ( $config->get( 'StrictFileExtensions' ) ) {
922 # Everything not permitted is banned
924 '<div id="mw-upload-permitted">' .
927 $this->getContext()->getLanguage()->commaList(
928 array_unique( $config->get( 'FileExtensions' ) )
933 # We have to list both preferred and prohibited
935 '<div id="mw-upload-preferred">' .
938 $this->getContext()->getLanguage()->commaList(
939 array_unique( $config->get( 'FileExtensions' ) )
943 '<div id="mw-upload-prohibited">' .
946 $this->getContext()->getLanguage()->commaList(
947 array_unique( $config->get( 'FileBlacklist' ) )
953 # Everything is permitted.
954 $extensionsList = '';
957 return $extensionsList;
961 * Get the descriptor of the fieldset that contains the file description
962 * input. The section is 'description'
964 * @return array Descriptor array
966 protected function getDescriptionSection() {
967 $config = $this->getConfig();
968 if ( $this->mSessionKey
) {
969 $stash = RepoGroup
::singleton()->getLocalRepo()->getUploadStash();
971 $file = $stash->getFile( $this->mSessionKey
);
972 } catch ( MWException
$e ) {
978 $mto = $file->transform( array( 'width' => 120 ) );
979 $this->addHeaderText(
980 '<div class="thumb t' . $wgContLang->alignEnd() . '">' .
981 Html
::element( 'img', array(
982 'src' => $mto->getUrl(),
983 'class' => 'thumbimage',
984 ) ) . '</div>', 'description' );
991 'section' => 'description',
992 'id' => 'wpDestFile',
993 'label-message' => 'destfilename',
995 'default' => $this->mDestFile
,
996 # @todo FIXME: Hack to work around poor handling of the 'default' option in HTMLForm
997 'nodata' => strval( $this->mDestFile
) !== '',
999 'UploadDescription' => array(
1000 'type' => 'textarea',
1001 'section' => 'description',
1002 'id' => 'wpUploadDescription',
1003 'label-message' => $this->mForReUpload
1004 ?
'filereuploadsummary'
1005 : 'fileuploadsummary',
1006 'default' => $this->mComment
,
1007 'cols' => $this->getUser()->getIntOption( 'cols' ),
1011 if ( $this->mTextAfterSummary
) {
1012 $descriptor['UploadFormTextAfterSummary'] = array(
1014 'section' => 'description',
1015 'default' => $this->mTextAfterSummary
,
1020 $descriptor +
= array(
1021 'EditTools' => array(
1022 'type' => 'edittools',
1023 'section' => 'description',
1024 'message' => 'edittools-upload',
1028 if ( $this->mForReUpload
) {
1029 $descriptor['DestFile']['readonly'] = true;
1031 $descriptor['License'] = array(
1033 'class' => 'Licenses',
1034 'section' => 'description',
1035 'id' => 'wpLicense',
1036 'label-message' => 'license',
1040 if ( $config->get( 'UseCopyrightUpload' ) ) {
1041 $descriptor['UploadCopyStatus'] = array(
1043 'section' => 'description',
1044 'id' => 'wpUploadCopyStatus',
1045 'label-message' => 'filestatus',
1047 $descriptor['UploadSource'] = array(
1049 'section' => 'description',
1050 'id' => 'wpUploadSource',
1051 'label-message' => 'filesource',
1059 * Get the descriptor of the fieldset that contains the upload options,
1060 * such as "watch this file". The section is 'options'
1062 * @return array Descriptor array
1064 protected function getOptionsSection() {
1065 $user = $this->getUser();
1066 if ( $user->isLoggedIn() ) {
1067 $descriptor = array(
1068 'Watchthis' => array(
1070 'id' => 'wpWatchthis',
1071 'label-message' => 'watchthisupload',
1072 'section' => 'options',
1073 'default' => $this->mWatch
,
1077 if ( !$this->mHideIgnoreWarning
) {
1078 $descriptor['IgnoreWarning'] = array(
1080 'id' => 'wpIgnoreWarning',
1081 'label-message' => 'ignorewarnings',
1082 'section' => 'options',
1086 $descriptor['DestFileWarningAck'] = array(
1088 'id' => 'wpDestFileWarningAck',
1089 'default' => $this->mDestWarningAck ?
'1' : '',
1092 if ( $this->mForReUpload
) {
1093 $descriptor['ForReUpload'] = array(
1095 'id' => 'wpForReUpload',
1104 * Add the upload JS and show the form.
1106 public function show() {
1107 $this->addUploadJS();
1112 * Add upload JS to the OutputPage
1114 protected function addUploadJS() {
1115 $config = $this->getConfig();
1117 $useAjaxDestCheck = $config->get( 'UseAjax' ) && $config->get( 'AjaxUploadDestCheck' );
1118 $useAjaxLicensePreview = $config->get( 'UseAjax' ) &&
1119 $config->get( 'AjaxLicensePreview' ) && $config->get( 'EnableAPI' );
1120 $this->mMaxUploadSize
['*'] = UploadBase
::getMaxUploadSize();
1122 $scriptVars = array(
1123 'wgAjaxUploadDestCheck' => $useAjaxDestCheck,
1124 'wgAjaxLicensePreview' => $useAjaxLicensePreview,
1125 'wgUploadAutoFill' => !$this->mForReUpload
&&
1126 // If we received mDestFile from the request, don't autofill
1127 // the wpDestFile textbox
1128 $this->mDestFile
=== '',
1129 'wgUploadSourceIds' => $this->mSourceIds
,
1130 'wgStrictFileExtensions' => $config->get( 'StrictFileExtensions' ),
1131 'wgCapitalizeUploads' => MWNamespace
::isCapitalized( NS_FILE
),
1132 'wgMaxUploadSize' => $this->mMaxUploadSize
,
1135 $out = $this->getOutput();
1136 $out->addJsConfigVars( $scriptVars );
1138 $out->addModules( array(
1139 'mediawiki.action.edit', // For <charinsert> support
1140 'mediawiki.special.upload', // Extras for thumbnail and license preview.
1145 * Empty function; submission is handled elsewhere.
1147 * @return bool False
1149 function trySubmit() {
1155 * A form field that contains a radio box in the label
1157 class UploadSourceField
extends HTMLTextField
{
1160 * @param array $cellAttributes
1163 function getLabelHtml( $cellAttributes = array() ) {
1164 $id = $this->mParams
['id'];
1165 $label = Html
::rawElement( 'label', array( 'for' => $id ), $this->mLabel
);
1167 if ( !empty( $this->mParams
['radio'] ) ) {
1168 if ( isset( $this->mParams
['radio-id'] ) ) {
1169 $radioId = $this->mParams
['radio-id'];
1171 // Old way. For the benefit of extensions that do not define
1172 // the 'radio-id' key.
1173 $radioId = 'wpSourceType' . $this->mParams
['upload-type'];
1177 'name' => 'wpSourceType',
1180 'value' => $this->mParams
['upload-type'],
1183 if ( !empty( $this->mParams
['checked'] ) ) {
1184 $attribs['checked'] = 'checked';
1187 $label .= Html
::element( 'input', $attribs );
1190 return Html
::rawElement( 'td', array( 'class' => 'mw-label' ) +
$cellAttributes, $label );
1196 function getSize() {
1197 return isset( $this->mParams
['size'] )
1198 ?
$this->mParams
['size']