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
25 use MediaWiki\Linker\LinkRenderer
;
26 use MediaWiki\MediaWikiServices
;
29 * Form for handling uploads and special page.
31 * @ingroup SpecialPage
34 class SpecialUpload
extends SpecialPage
{
36 * Get data POSTed through the form and assign them to the object
37 * @param WebRequest $request Data posted.
39 public function __construct( $request = null ) {
40 parent
::__construct( 'Upload', 'upload' );
43 public function doesWrites() {
47 /** Misc variables **/
49 /** @var WebRequest|FauxRequest The request this form is supposed to handle */
53 /** @var UploadBase */
58 public $mUploadClicked;
60 /** User input variables from the "description" section **/
62 /** @var string The requested target file name */
63 public $mDesiredDestName;
67 /** User input variables from the root section **/
69 public $mIgnoreWarning;
71 public $mCopyrightStatus;
72 public $mCopyrightSource;
74 /** Hidden variables **/
76 public $mDestWarningAck;
78 /** @var bool The user followed an "overwrite this file" link */
81 /** @var bool The user clicked "Cancel and return to upload form" button */
82 public $mCancelUpload;
85 /** @var bool Subclasses can use this to determine whether a file was uploaded */
86 public $mUploadSuccessful = false;
88 /** Text injection points for hooks not using HTMLForm **/
89 public $uploadFormTextTop;
90 public $uploadFormTextAfterSummary;
93 * Initialize instance variables from request and create an Upload handler
95 protected function loadRequest() {
96 $this->mRequest
= $request = $this->getRequest();
97 $this->mSourceType
= $request->getVal( 'wpSourceType', 'file' );
98 $this->mUpload
= UploadBase
::createFromRequest( $request );
99 $this->mUploadClicked
= $request->wasPosted()
100 && ( $request->getCheck( 'wpUpload' )
101 ||
$request->getCheck( 'wpUploadIgnoreWarning' ) );
103 // Guess the desired name from the filename if not provided
104 $this->mDesiredDestName
= $request->getText( 'wpDestFile' );
105 if ( !$this->mDesiredDestName
&& $request->getFileName( 'wpUploadFile' ) !== null ) {
106 $this->mDesiredDestName
= $request->getFileName( 'wpUploadFile' );
108 $this->mLicense
= $request->getText( 'wpLicense' );
110 $this->mDestWarningAck
= $request->getText( 'wpDestFileWarningAck' );
111 $this->mIgnoreWarning
= $request->getCheck( 'wpIgnoreWarning' )
112 ||
$request->getCheck( 'wpUploadIgnoreWarning' );
113 $this->mWatchthis
= $request->getBool( 'wpWatchthis' ) && $this->getUser()->isLoggedIn();
114 $this->mCopyrightStatus
= $request->getText( 'wpUploadCopyStatus' );
115 $this->mCopyrightSource
= $request->getText( 'wpUploadSource' );
117 $this->mForReUpload
= $request->getBool( 'wpForReUpload' ); // updating a file
119 $commentDefault = '';
120 $commentMsg = wfMessage( 'upload-default-description' )->inContentLanguage();
121 if ( !$this->mForReUpload
&& !$commentMsg->isDisabled() ) {
122 $commentDefault = $commentMsg->plain();
124 $this->mComment
= $request->getText( 'wpUploadDescription', $commentDefault );
126 $this->mCancelUpload
= $request->getCheck( 'wpCancelUpload' )
127 ||
$request->getCheck( 'wpReUpload' ); // b/w compat
129 // If it was posted check for the token (no remote POST'ing with user credentials)
130 $token = $request->getVal( 'wpEditToken' );
131 $this->mTokenOk
= $this->getUser()->matchEditToken( $token );
133 $this->uploadFormTextTop
= '';
134 $this->uploadFormTextAfterSummary
= '';
138 * This page can be shown if uploading is enabled.
139 * Handle permission checking elsewhere in order to be able to show
140 * custom error messages.
145 public function userCanExecute( User
$user ) {
146 return UploadBase
::isEnabled() && parent
::userCanExecute( $user );
150 * Special page entry point
152 * @throws ErrorPageError
155 * @throws MWException
156 * @throws PermissionsError
157 * @throws ReadOnlyError
158 * @throws UserBlockedError
160 public function execute( $par ) {
161 $this->useTransactionalTimeLimit();
164 $this->outputHeader();
166 # Check uploading enabled
167 if ( !UploadBase
::isEnabled() ) {
168 throw new ErrorPageError( 'uploaddisabled', 'uploaddisabledtext' );
171 $this->addHelpLink( 'Help:Managing files' );
174 $user = $this->getUser();
175 $permissionRequired = UploadBase
::isAllowed( $user );
176 if ( $permissionRequired !== true ) {
177 throw new PermissionsError( $permissionRequired );
181 if ( $user->isBlocked() ) {
182 throw new UserBlockedError( $user->getBlock() );
186 if ( $user->isBlockedGlobally() ) {
187 throw new UserBlockedError( $user->getGlobalBlock() );
190 # Check whether we actually want to allow changing stuff
191 $this->checkReadOnly();
193 $this->loadRequest();
195 # Unsave the temporary file in case this was a cancelled upload
196 if ( $this->mCancelUpload
) {
197 if ( !$this->unsaveUploadedFile() ) {
198 # Something went wrong, so unsaveUploadedFile showed a warning
203 # Process upload or show a form
205 $this->mTokenOk
&& !$this->mCancelUpload
&&
206 ( $this->mUpload
&& $this->mUploadClicked
)
208 $this->processUpload();
210 # Backwards compatibility hook
211 // Avoid PHP 7.1 warning of passing $this by reference
213 if ( !Hooks
::run( 'UploadForm:initial', [ &$upload ] ) ) {
214 wfDebug( "Hook 'UploadForm:initial' broke output of the upload form\n" );
218 $this->showUploadForm( $this->getUploadForm() );
222 if ( $this->mUpload
) {
223 $this->mUpload
->cleanupTempFile();
228 * Show the main upload form
230 * @param HTMLForm|string $form An HTMLForm instance or HTML string to show
232 protected function showUploadForm( $form ) {
233 # Add links if file was previously deleted
234 if ( $this->mDesiredDestName
) {
235 $this->showViewDeletedLinks();
238 if ( $form instanceof HTMLForm
) {
241 $this->getOutput()->addHTML( $form );
246 * Get an UploadForm instance with title and text properly set.
248 * @param string $message HTML string to add to the form
249 * @param string $sessionKey Session key in case this is a stashed upload
250 * @param bool $hideIgnoreWarning Whether to hide "ignore warning" check box
253 protected function getUploadForm( $message = '', $sessionKey = '', $hideIgnoreWarning = false ) {
255 $context = new DerivativeContext( $this->getContext() );
256 $context->setTitle( $this->getPageTitle() ); // Remove subpage
257 $form = new UploadForm( [
258 'watch' => $this->getWatchCheck(),
259 'forreupload' => $this->mForReUpload
,
260 'sessionkey' => $sessionKey,
261 'hideignorewarning' => $hideIgnoreWarning,
262 'destwarningack' => (bool)$this->mDestWarningAck
,
264 'description' => $this->mComment
,
265 'texttop' => $this->uploadFormTextTop
,
266 'textaftersummary' => $this->uploadFormTextAfterSummary
,
267 'destfile' => $this->mDesiredDestName
,
268 ], $context, $this->getLinkRenderer() );
270 # Check the token, but only if necessary
272 !$this->mTokenOk
&& !$this->mCancelUpload
&&
273 ( $this->mUpload
&& $this->mUploadClicked
)
275 $form->addPreText( $this->msg( 'session_fail_preview' )->parse() );
278 # Give a notice if the user is uploading a file that has been deleted or moved
279 # Note that this is independent from the message 'filewasdeleted'
280 $desiredTitleObj = Title
::makeTitleSafe( NS_FILE
, $this->mDesiredDestName
);
281 $delNotice = ''; // empty by default
282 if ( $desiredTitleObj instanceof Title
&& !$desiredTitleObj->exists() ) {
283 $dbr = wfGetDB( DB_REPLICA
);
285 LogEventsList
::showLogExtract( $delNotice, [ 'delete', 'move' ],
288 'conds' => [ 'log_action != ' . $dbr->addQuotes( 'revision' ) ],
289 'showIfEmpty' => false,
290 'msgKey' => [ 'upload-recreate-warning' ] ]
293 $form->addPreText( $delNotice );
296 $form->addPreText( '<div id="uploadtext">' .
297 $this->msg( 'uploadtext', [ $this->mDesiredDestName
] )->parseAsBlock() .
299 # Add upload error message
300 $form->addPreText( $message );
303 $uploadFooter = $this->msg( 'uploadfooter' );
304 if ( !$uploadFooter->isDisabled() ) {
305 $form->addPostText( '<div id="mw-upload-footer-message">'
306 . $uploadFooter->parseAsBlock() . "</div>\n" );
313 * Shows the "view X deleted revivions link""
315 protected function showViewDeletedLinks() {
316 $title = Title
::makeTitleSafe( NS_FILE
, $this->mDesiredDestName
);
317 $user = $this->getUser();
318 // Show a subtitle link to deleted revisions (to sysops et al only)
319 if ( $title instanceof Title
) {
320 $count = $title->isDeleted();
321 if ( $count > 0 && $user->isAllowed( 'deletedhistory' ) ) {
322 $restorelink = $this->getLinkRenderer()->makeKnownLink(
323 SpecialPage
::getTitleFor( 'Undelete', $title->getPrefixedText() ),
324 $this->msg( 'restorelink' )->numParams( $count )->text()
326 $link = $this->msg( $user->isAllowed( 'delete' ) ?
'thisisdeleted' : 'viewdeleted' )
327 ->rawParams( $restorelink )->parseAsBlock();
328 $this->getOutput()->addHTML( "<div id=\"contentSub2\">{$link}</div>" );
334 * Stashes the upload and shows the main upload form.
336 * Note: only errors that can be handled by changing the name or
337 * description should be redirected here. It should be assumed that the
338 * file itself is sane and has passed UploadBase::verifyFile. This
339 * essentially means that UploadBase::VERIFICATION_ERROR and
340 * UploadBase::EMPTY_FILE should not be passed here.
342 * @param string $message HTML message to be passed to mainUploadForm
344 protected function showRecoverableUploadError( $message ) {
345 $stashStatus = $this->mUpload
->tryStashFile( $this->getUser() );
346 if ( $stashStatus->isGood() ) {
347 $sessionKey = $stashStatus->getValue()->getFileKey();
350 // TODO Add a warning message about the failure to stash here?
352 $message = '<h2>' . $this->msg( 'uploaderror' )->escaped() . "</h2>\n" .
353 '<div class="error">' . $message . "</div>\n";
355 $form = $this->getUploadForm( $message, $sessionKey );
356 $form->setSubmitText( $this->msg( 'upload-tryagain' )->escaped() );
357 $this->showUploadForm( $form );
361 * Stashes the upload, shows the main form, but adds a "continue anyway button".
362 * Also checks whether there are actually warnings to display.
364 * @param array $warnings
365 * @return bool True if warnings were displayed, false if there are no
366 * warnings and it should continue processing
368 protected function showUploadWarning( $warnings ) {
369 # If there are no warnings, or warnings we can ignore, return early.
370 # mDestWarningAck is set when some javascript has shown the warning
371 # to the user. mForReUpload is set when the user clicks the "upload a
373 if ( !$warnings ||
( count( $warnings ) == 1
374 && isset( $warnings['exists'] )
375 && ( $this->mDestWarningAck ||
$this->mForReUpload
) )
380 $stashStatus = $this->mUpload
->tryStashFile( $this->getUser() );
381 if ( $stashStatus->isGood() ) {
382 $sessionKey = $stashStatus->getValue()->getFileKey();
385 // TODO Add a warning message about the failure to stash here?
388 // Add styles for the warning, reused from the live preview
389 $this->getOutput()->addModuleStyles( 'mediawiki.special.upload.styles' );
391 $linkRenderer = $this->getLinkRenderer();
392 $warningHtml = '<h2>' . $this->msg( 'uploadwarning' )->escaped() . "</h2>\n"
393 . '<div class="mw-destfile-warning"><ul>';
394 foreach ( $warnings as $warning => $args ) {
395 if ( $warning == 'badfilename' ) {
396 $this->mDesiredDestName
= Title
::makeTitle( NS_FILE
, $args )->getText();
398 if ( $warning == 'exists' ) {
399 $msg = "\t<li>" . self
::getExistsWarning( $args ) . "</li>\n";
400 } elseif ( $warning == 'no-change' ) {
402 $filename = $file->getTitle()->getPrefixedText();
403 $msg = "\t<li>" . wfMessage( 'fileexists-no-change', $filename )->parse() . "</li>\n";
404 } elseif ( $warning == 'duplicate-version' ) {
406 $count = count( $args );
407 $filename = $file->getTitle()->getPrefixedText();
408 $message = wfMessage( 'fileexists-duplicate-version' )
409 ->params( $filename )
410 ->numParams( $count );
411 $msg = "\t<li>" . $message->parse() . "</li>\n";
412 } elseif ( $warning == 'was-deleted' ) {
413 # If the file existed before and was deleted, warn the user of this
414 $ltitle = SpecialPage
::getTitleFor( 'Log' );
415 $llink = $linkRenderer->makeKnownLink(
417 wfMessage( 'deletionlog' )->text(),
421 'page' => Title
::makeTitle( NS_FILE
, $args )->getPrefixedText(),
424 $msg = "\t<li>" . wfMessage( 'filewasdeleted' )->rawParams( $llink )->parse() . "</li>\n";
425 } elseif ( $warning == 'duplicate' ) {
426 $msg = $this->getDupeWarning( $args );
427 } elseif ( $warning == 'duplicate-archive' ) {
428 if ( $args === '' ) {
429 $msg = "\t<li>" . $this->msg( 'file-deleted-duplicate-notitle' )->parse()
432 $msg = "\t<li>" . $this->msg( 'file-deleted-duplicate',
433 Title
::makeTitle( NS_FILE
, $args )->getPrefixedText() )->parse()
437 if ( $args === true ) {
439 } elseif ( !is_array( $args ) ) {
442 $msg = "\t<li>" . $this->msg( $warning, $args )->parse() . "</li>\n";
444 $warningHtml .= $msg;
446 $warningHtml .= "</ul></div>\n";
447 $warningHtml .= $this->msg( 'uploadwarning-text' )->parseAsBlock();
449 $form = $this->getUploadForm( $warningHtml, $sessionKey, /* $hideIgnoreWarning */ true );
450 $form->setSubmitText( $this->msg( 'upload-tryagain' )->text() );
452 'name' => 'wpUploadIgnoreWarning',
453 'value' => $this->msg( 'ignorewarning' )->text()
456 'name' => 'wpCancelUpload',
457 'value' => $this->msg( 'reuploaddesc' )->text()
460 $this->showUploadForm( $form );
462 # Indicate that we showed a form
467 * Show the upload form with error message, but do not stash the file.
469 * @param string $message HTML string
471 protected function showUploadError( $message ) {
472 $message = '<h2>' . $this->msg( 'uploadwarning' )->escaped() . "</h2>\n" .
473 '<div class="error">' . $message . "</div>\n";
474 $this->showUploadForm( $this->getUploadForm( $message ) );
479 * Checks are made in SpecialUpload::execute()
481 protected function processUpload() {
482 // Fetch the file if required
483 $status = $this->mUpload
->fetchFile();
484 if ( !$status->isOK() ) {
485 $this->showUploadError( $this->getOutput()->parse( $status->getWikiText() ) );
489 // Avoid PHP 7.1 warning of passing $this by reference
491 if ( !Hooks
::run( 'UploadForm:BeforeProcessing', [ &$upload ] ) ) {
492 wfDebug( "Hook 'UploadForm:BeforeProcessing' broke processing the file.\n" );
493 // This code path is deprecated. If you want to break upload processing
494 // do so by hooking into the appropriate hooks in UploadBase::verifyUpload
495 // and UploadBase::verifyFile.
496 // If you use this hook to break uploading, the user will be returned
497 // an empty form with no error message whatsoever.
501 // Upload verification
502 $details = $this->mUpload
->verifyUpload();
503 if ( $details['status'] != UploadBase
::OK
) {
504 $this->processVerificationError( $details );
509 // Verify permissions for this title
510 $permErrors = $this->mUpload
->verifyTitlePermissions( $this->getUser() );
511 if ( $permErrors !== true ) {
512 $code = array_shift( $permErrors[0] );
513 $this->showRecoverableUploadError( $this->msg( $code, $permErrors[0] )->parse() );
518 $this->mLocalFile
= $this->mUpload
->getLocalFile();
520 // Check warnings if necessary
521 if ( !$this->mIgnoreWarning
) {
522 $warnings = $this->mUpload
->checkWarnings();
523 if ( $this->showUploadWarning( $warnings ) ) {
528 // This is as late as we can throttle, after expected issues have been handled
529 if ( UploadBase
::isThrottled( $this->getUser() ) ) {
530 $this->showRecoverableUploadError(
531 $this->msg( 'actionthrottledtext' )->escaped()
536 // Get the page text if this is not a reupload
537 if ( !$this->mForReUpload
) {
538 $pageText = self
::getInitialPageText( $this->mComment
, $this->mLicense
,
539 $this->mCopyrightStatus
, $this->mCopyrightSource
, $this->getConfig() );
544 $changeTags = $this->getRequest()->getVal( 'wpChangeTags' );
545 if ( is_null( $changeTags ) ||
$changeTags === '' ) {
548 $changeTags = array_filter( array_map( 'trim', explode( ',', $changeTags ) ) );
552 $changeTagsStatus = ChangeTags
::canAddTagsAccompanyingChange(
553 $changeTags, $this->getUser() );
554 if ( !$changeTagsStatus->isOK() ) {
555 $this->showUploadError( $this->getOutput()->parse( $changeTagsStatus->getWikiText() ) );
561 $status = $this->mUpload
->performUpload(
569 if ( !$status->isGood() ) {
570 $this->showRecoverableUploadError( $this->getOutput()->parse( $status->getWikiText() ) );
575 // Success, redirect to description page
576 $this->mUploadSuccessful
= true;
577 // Avoid PHP 7.1 warning of passing $this by reference
579 Hooks
::run( 'SpecialUploadComplete', [ &$upload ] );
580 $this->getOutput()->redirect( $this->mLocalFile
->getTitle()->getFullURL() );
584 * Get the initial image page text based on a comment and optional file status information
585 * @param string $comment
586 * @param string $license
587 * @param string $copyStatus
588 * @param string $source
589 * @param Config $config Configuration object to load data from
592 public static function getInitialPageText( $comment = '', $license = '',
593 $copyStatus = '', $source = '', Config
$config = null
595 if ( $config === null ) {
596 wfDebug( __METHOD__
. ' called without a Config instance passed to it' );
597 $config = MediaWikiServices
::getInstance()->getMainConfig();
601 $forceUIMsgAsContentMsg = (array)$config->get( 'ForceUIMsgAsContentMsg' );
602 /* These messages are transcluded into the actual text of the description page.
603 * Thus, forcing them as content messages makes the upload to produce an int: template
604 * instead of hardcoding it there in the uploader language.
606 foreach ( [ 'license-header', 'filedesc', 'filestatus', 'filesource' ] as $msgName ) {
607 if ( in_array( $msgName, $forceUIMsgAsContentMsg ) ) {
608 $msg[$msgName] = "{{int:$msgName}}";
610 $msg[$msgName] = wfMessage( $msgName )->inContentLanguage()->text();
614 if ( $config->get( 'UseCopyrightUpload' ) ) {
616 if ( $license != '' ) {
617 $licensetxt = '== ' . $msg['license-header'] . " ==\n" . '{{' . $license . '}}' . "\n";
619 $pageText = '== ' . $msg['filedesc'] . " ==\n" . $comment . "\n" .
620 '== ' . $msg['filestatus'] . " ==\n" . $copyStatus . "\n" .
622 '== ' . $msg['filesource'] . " ==\n" . $source;
624 if ( $license != '' ) {
625 $filedesc = $comment == '' ?
'' : '== ' . $msg['filedesc'] . " ==\n" . $comment . "\n";
626 $pageText = $filedesc .
627 '== ' . $msg['license-header'] . " ==\n" . '{{' . $license . '}}' . "\n";
629 $pageText = $comment;
637 * See if we should check the 'watch this page' checkbox on the form
638 * based on the user's preferences and whether we're being asked
639 * to create a new file or update an existing one.
641 * In the case where 'watch edits' is off but 'watch creations' is on,
642 * we'll leave the box unchecked.
644 * Note that the page target can be changed *on the form*, so our check
645 * state can get out of sync.
646 * @return bool|string
648 protected function getWatchCheck() {
649 if ( $this->getUser()->getOption( 'watchdefault' ) ) {
654 $desiredTitleObj = Title
::makeTitleSafe( NS_FILE
, $this->mDesiredDestName
);
655 if ( $desiredTitleObj instanceof Title
&& $this->getUser()->isWatched( $desiredTitleObj ) ) {
656 // Already watched, don't change that
660 $local = wfLocalFile( $this->mDesiredDestName
);
661 if ( $local && $local->exists() ) {
662 // We're uploading a new version of an existing file.
663 // No creation, so don't watch it if we're not already.
666 // New page should get watched if that's our option.
667 return $this->getUser()->getOption( 'watchcreations' ) ||
668 $this->getUser()->getOption( 'watchuploads' );
673 * Provides output to the user for a result of UploadBase::verifyUpload
675 * @param array $details Result of UploadBase::verifyUpload
676 * @throws MWException
678 protected function processVerificationError( $details ) {
679 switch ( $details['status'] ) {
680 /** Statuses that only require name changing **/
681 case UploadBase
::MIN_LENGTH_PARTNAME
:
682 $this->showRecoverableUploadError( $this->msg( 'minlength1' )->escaped() );
684 case UploadBase
::ILLEGAL_FILENAME
:
685 $this->showRecoverableUploadError( $this->msg( 'illegalfilename',
686 $details['filtered'] )->parse() );
688 case UploadBase
::FILENAME_TOO_LONG
:
689 $this->showRecoverableUploadError( $this->msg( 'filename-toolong' )->escaped() );
691 case UploadBase
::FILETYPE_MISSING
:
692 $this->showRecoverableUploadError( $this->msg( 'filetype-missing' )->parse() );
694 case UploadBase
::WINDOWS_NONASCII_FILENAME
:
695 $this->showRecoverableUploadError( $this->msg( 'windows-nonascii-filename' )->parse() );
698 /** Statuses that require reuploading **/
699 case UploadBase
::EMPTY_FILE
:
700 $this->showUploadError( $this->msg( 'emptyfile' )->escaped() );
702 case UploadBase
::FILE_TOO_LARGE
:
703 $this->showUploadError( $this->msg( 'largefileserver' )->escaped() );
705 case UploadBase
::FILETYPE_BADTYPE
:
706 $msg = $this->msg( 'filetype-banned-type' );
707 if ( isset( $details['blacklistedExt'] ) ) {
708 $msg->params( $this->getLanguage()->commaList( $details['blacklistedExt'] ) );
710 $msg->params( $details['finalExt'] );
712 $extensions = array_unique( $this->getConfig()->get( 'FileExtensions' ) );
713 $msg->params( $this->getLanguage()->commaList( $extensions ),
714 count( $extensions ) );
716 // Add PLURAL support for the first parameter. This results
717 // in a bit unlogical parameter sequence, but does not break
719 if ( isset( $details['blacklistedExt'] ) ) {
720 $msg->params( count( $details['blacklistedExt'] ) );
725 $this->showUploadError( $msg->parse() );
727 case UploadBase
::VERIFICATION_ERROR
:
728 unset( $details['status'] );
729 $code = array_shift( $details['details'] );
730 $this->showUploadError( $this->msg( $code, $details['details'] )->parse() );
732 case UploadBase
::HOOK_ABORTED
:
733 if ( is_array( $details['error'] ) ) { # allow hooks to return error details in an array
734 $args = $details['error'];
735 $error = array_shift( $args );
737 $error = $details['error'];
741 $this->showUploadError( $this->msg( $error, $args )->parse() );
744 throw new MWException( __METHOD__
. ": Unknown value `{$details['status']}`" );
749 * Remove a temporarily kept file stashed by saveTempUploadedFile().
751 * @return bool Success
753 protected function unsaveUploadedFile() {
754 if ( !( $this->mUpload
instanceof UploadFromStash
) ) {
757 $success = $this->mUpload
->unsaveUploadedFile();
759 $this->getOutput()->showFileDeleteError( $this->mUpload
->getTempPath() );
767 /*** Functions for formatting warnings ***/
770 * Formats a result of UploadBase::getExistsWarning as HTML
771 * This check is static and can be done pre-upload via AJAX
773 * @param array $exists The result of UploadBase::getExistsWarning
774 * @return string Empty string if there is no warning or an HTML fragment
776 public static function getExistsWarning( $exists ) {
781 $file = $exists['file'];
782 $filename = $file->getTitle()->getPrefixedText();
785 if ( $exists['warning'] == 'exists' ) {
787 $warnMsg = wfMessage( 'fileexists', $filename );
788 } elseif ( $exists['warning'] == 'page-exists' ) {
789 // Page exists but file does not
790 $warnMsg = wfMessage( 'filepageexists', $filename );
791 } elseif ( $exists['warning'] == 'exists-normalized' ) {
792 $warnMsg = wfMessage( 'fileexists-extension', $filename,
793 $exists['normalizedFile']->getTitle()->getPrefixedText() );
794 } elseif ( $exists['warning'] == 'thumb' ) {
795 // Swapped argument order compared with other messages for backwards compatibility
796 $warnMsg = wfMessage( 'fileexists-thumbnail-yes',
797 $exists['thumbFile']->getTitle()->getPrefixedText(), $filename );
798 } elseif ( $exists['warning'] == 'thumb-name' ) {
799 // Image w/o '180px-' does not exists, but we do not like these filenames
800 $name = $file->getName();
801 $badPart = substr( $name, 0, strpos( $name, '-' ) +
1 );
802 $warnMsg = wfMessage( 'file-thumbnail-no', $badPart );
803 } elseif ( $exists['warning'] == 'bad-prefix' ) {
804 $warnMsg = wfMessage( 'filename-bad-prefix', $exists['prefix'] );
807 return $warnMsg ?
$warnMsg->title( $file->getTitle() )->parse() : '';
811 * Construct a warning and a gallery from an array of duplicate files.
812 * @param array $dupes
815 public function getDupeWarning( $dupes ) {
820 $gallery = ImageGalleryBase
::factory( false, $this->getContext() );
821 $gallery->setShowBytes( false );
822 $gallery->setShowDimensions( false );
823 foreach ( $dupes as $file ) {
824 $gallery->add( $file->getTitle() );
828 $this->msg( 'file-exists-duplicate' )->numParams( count( $dupes ) )->parse() .
829 $gallery->toHTML() . "</li>\n";
832 protected function getGroupName() {
837 * Should we rotate images in the preview on Special:Upload.
839 * This controls js: mw.config.get( 'wgFileCanRotate' )
841 * @todo What about non-BitmapHandler handled files?
844 public static function rotationEnabled() {
845 $bitmapHandler = new BitmapHandler();
846 return $bitmapHandler->autoRotateEnabled();
851 * Sub class of HTMLForm that provides the form section of SpecialUpload
853 class UploadForm
extends HTMLForm
{
855 protected $mForReUpload;
856 protected $mSessionKey;
857 protected $mHideIgnoreWarning;
858 protected $mDestWarningAck;
859 protected $mDestFile;
863 protected $mTextAfterSummary;
865 protected $mSourceIds;
867 protected $mMaxFileSize = [];
869 protected $mMaxUploadSize = [];
871 public function __construct( array $options = [], IContextSource
$context = null,
872 LinkRenderer
$linkRenderer = null
874 if ( $context instanceof IContextSource
) {
875 $this->setContext( $context );
878 if ( !$linkRenderer ) {
879 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
882 $this->mWatch
= !empty( $options['watch'] );
883 $this->mForReUpload
= !empty( $options['forreupload'] );
884 $this->mSessionKey
= isset( $options['sessionkey'] ) ?
$options['sessionkey'] : '';
885 $this->mHideIgnoreWarning
= !empty( $options['hideignorewarning'] );
886 $this->mDestWarningAck
= !empty( $options['destwarningack'] );
887 $this->mDestFile
= isset( $options['destfile'] ) ?
$options['destfile'] : '';
889 $this->mComment
= isset( $options['description'] ) ?
890 $options['description'] : '';
892 $this->mTextTop
= isset( $options['texttop'] )
893 ?
$options['texttop'] : '';
895 $this->mTextAfterSummary
= isset( $options['textaftersummary'] )
896 ?
$options['textaftersummary'] : '';
898 $sourceDescriptor = $this->getSourceSection();
899 $descriptor = $sourceDescriptor
900 +
$this->getDescriptionSection()
901 +
$this->getOptionsSection();
903 Hooks
::run( 'UploadFormInitDescriptor', [ &$descriptor ] );
904 parent
::__construct( $descriptor, $context, 'upload' );
906 # Add a link to edit MediaWiki:Licenses
907 if ( $this->getUser()->isAllowed( 'editinterface' ) ) {
908 $this->getOutput()->addModuleStyles( 'mediawiki.special.upload.styles' );
909 $licensesLink = $linkRenderer->makeKnownLink(
910 $this->msg( 'licenses' )->inContentLanguage()->getTitle(),
911 $this->msg( 'licenses-edit' )->text(),
913 [ 'action' => 'edit' ]
915 $editLicenses = '<p class="mw-upload-editlicenses">' . $licensesLink . '</p>';
916 $this->addFooterText( $editLicenses, 'description' );
919 # Set some form properties
920 $this->setSubmitText( $this->msg( 'uploadbtn' )->text() );
921 $this->setSubmitName( 'wpUpload' );
922 # Used message keys: 'accesskey-upload', 'tooltip-upload'
923 $this->setSubmitTooltip( 'upload' );
924 $this->setId( 'mw-upload-form' );
926 # Build a list of IDs for javascript insertion
927 $this->mSourceIds
= [];
928 foreach ( $sourceDescriptor as $field ) {
929 if ( !empty( $field['id'] ) ) {
930 $this->mSourceIds
[] = $field['id'];
936 * Get the descriptor of the fieldset that contains the file source
937 * selection. The section is 'source'
939 * @return array Descriptor array
941 protected function getSourceSection() {
942 if ( $this->mSessionKey
) {
946 'default' => $this->mSessionKey
,
950 'default' => 'Stash',
955 $canUploadByUrl = UploadFromUrl
::isEnabled()
956 && ( UploadFromUrl
::isAllowed( $this->getUser() ) === true )
957 && $this->getConfig()->get( 'CopyUploadsFromSpecialUpload' );
958 $radio = $canUploadByUrl;
959 $selectedSourceType = strtolower( $this->getRequest()->getText( 'wpSourceType', 'File' ) );
962 if ( $this->mTextTop
) {
963 $descriptor['UploadFormTextTop'] = [
965 'section' => 'source',
966 'default' => $this->mTextTop
,
971 $this->mMaxUploadSize
['file'] = min(
972 UploadBase
::getMaxUploadSize( 'file' ),
973 UploadBase
::getMaxPhpUploadSize()
976 $help = $this->msg( 'upload-maxfilesize',
977 $this->getContext()->getLanguage()->formatSize( $this->mMaxUploadSize
['file'] )
980 // If the user can also upload by URL, there are 2 different file size limits.
981 // This extra message helps stress which limit corresponds to what.
982 if ( $canUploadByUrl ) {
983 $help .= $this->msg( 'word-separator' )->escaped();
984 $help .= $this->msg( 'upload_source_file' )->parse();
987 $descriptor['UploadFile'] = [
988 'class' => 'UploadSourceField',
989 'section' => 'source',
991 'id' => 'wpUploadFile',
992 'radio-id' => 'wpSourceTypeFile',
993 'label-message' => 'sourcefilename',
994 'upload-type' => 'File',
997 'checked' => $selectedSourceType == 'file',
1000 if ( $canUploadByUrl ) {
1001 $this->mMaxUploadSize
['url'] = UploadBase
::getMaxUploadSize( 'url' );
1002 $descriptor['UploadFileURL'] = [
1003 'class' => 'UploadSourceField',
1004 'section' => 'source',
1005 'id' => 'wpUploadFileURL',
1006 'radio-id' => 'wpSourceTypeurl',
1007 'label-message' => 'sourceurl',
1008 'upload-type' => 'url',
1010 'help' => $this->msg( 'upload-maxfilesize',
1011 $this->getContext()->getLanguage()->formatSize( $this->mMaxUploadSize
['url'] )
1013 $this->msg( 'word-separator' )->escaped() .
1014 $this->msg( 'upload_source_url' )->parse(),
1015 'checked' => $selectedSourceType == 'url',
1018 Hooks
::run( 'UploadFormSourceDescriptors', [ &$descriptor, &$radio, $selectedSourceType ] );
1020 $descriptor['Extensions'] = [
1022 'section' => 'source',
1023 'default' => $this->getExtensionsMessage(),
1031 * Get the messages indicating which extensions are preferred and prohibitted.
1033 * @return string HTML string containing the message
1035 protected function getExtensionsMessage() {
1036 # Print a list of allowed file extensions, if so configured. We ignore
1037 # MIME type here, it's incomprehensible to most people and too long.
1038 $config = $this->getConfig();
1040 if ( $config->get( 'CheckFileExtensions' ) ) {
1041 $fileExtensions = array_unique( $config->get( 'FileExtensions' ) );
1042 if ( $config->get( 'StrictFileExtensions' ) ) {
1043 # Everything not permitted is banned
1045 '<div id="mw-upload-permitted">' .
1046 $this->msg( 'upload-permitted' )
1047 ->params( $this->getLanguage()->commaList( $fileExtensions ) )
1048 ->numParams( count( $fileExtensions ) )
1052 # We have to list both preferred and prohibited
1053 $fileBlacklist = array_unique( $config->get( 'FileBlacklist' ) );
1055 '<div id="mw-upload-preferred">' .
1056 $this->msg( 'upload-preferred' )
1057 ->params( $this->getLanguage()->commaList( $fileExtensions ) )
1058 ->numParams( count( $fileExtensions ) )
1061 '<div id="mw-upload-prohibited">' .
1062 $this->msg( 'upload-prohibited' )
1063 ->params( $this->getLanguage()->commaList( $fileBlacklist ) )
1064 ->numParams( count( $fileBlacklist ) )
1069 # Everything is permitted.
1070 $extensionsList = '';
1073 return $extensionsList;
1077 * Get the descriptor of the fieldset that contains the file description
1078 * input. The section is 'description'
1080 * @return array Descriptor array
1082 protected function getDescriptionSection() {
1083 $config = $this->getConfig();
1084 if ( $this->mSessionKey
) {
1085 $stash = RepoGroup
::singleton()->getLocalRepo()->getUploadStash( $this->getUser() );
1087 $file = $stash->getFile( $this->mSessionKey
);
1088 } catch ( Exception
$e ) {
1094 $mto = $file->transform( [ 'width' => 120 ] );
1096 $this->addHeaderText(
1097 '<div class="thumb t' . $wgContLang->alignEnd() . '">' .
1098 Html
::element( 'img', [
1099 'src' => $mto->getUrl(),
1100 'class' => 'thumbimage',
1101 ] ) . '</div>', 'description' );
1109 'section' => 'description',
1110 'id' => 'wpDestFile',
1111 'label-message' => 'destfilename',
1113 'default' => $this->mDestFile
,
1114 # @todo FIXME: Hack to work around poor handling of the 'default' option in HTMLForm
1115 'nodata' => strval( $this->mDestFile
) !== '',
1117 'UploadDescription' => [
1118 'type' => 'textarea',
1119 'section' => 'description',
1120 'id' => 'wpUploadDescription',
1121 'label-message' => $this->mForReUpload
1122 ?
'filereuploadsummary'
1123 : 'fileuploadsummary',
1124 'default' => $this->mComment
,
1129 if ( $this->mTextAfterSummary
) {
1130 $descriptor['UploadFormTextAfterSummary'] = [
1132 'section' => 'description',
1133 'default' => $this->mTextAfterSummary
,
1140 'type' => 'edittools',
1141 'section' => 'description',
1142 'message' => 'edittools-upload',
1146 if ( $this->mForReUpload
) {
1147 $descriptor['DestFile']['readonly'] = true;
1149 $descriptor['License'] = [
1151 'class' => 'Licenses',
1152 'section' => 'description',
1153 'id' => 'wpLicense',
1154 'label-message' => 'license',
1158 if ( $config->get( 'UseCopyrightUpload' ) ) {
1159 $descriptor['UploadCopyStatus'] = [
1161 'section' => 'description',
1162 'id' => 'wpUploadCopyStatus',
1163 'label-message' => 'filestatus',
1165 $descriptor['UploadSource'] = [
1167 'section' => 'description',
1168 'id' => 'wpUploadSource',
1169 'label-message' => 'filesource',
1177 * Get the descriptor of the fieldset that contains the upload options,
1178 * such as "watch this file". The section is 'options'
1180 * @return array Descriptor array
1182 protected function getOptionsSection() {
1183 $user = $this->getUser();
1184 if ( $user->isLoggedIn() ) {
1188 'id' => 'wpWatchthis',
1189 'label-message' => 'watchthisupload',
1190 'section' => 'options',
1191 'default' => $this->mWatch
,
1195 if ( !$this->mHideIgnoreWarning
) {
1196 $descriptor['IgnoreWarning'] = [
1198 'id' => 'wpIgnoreWarning',
1199 'label-message' => 'ignorewarnings',
1200 'section' => 'options',
1204 $descriptor['DestFileWarningAck'] = [
1206 'id' => 'wpDestFileWarningAck',
1207 'default' => $this->mDestWarningAck ?
'1' : '',
1210 if ( $this->mForReUpload
) {
1211 $descriptor['ForReUpload'] = [
1213 'id' => 'wpForReUpload',
1222 * Add the upload JS and show the form.
1224 public function show() {
1225 $this->addUploadJS();
1230 * Add upload JS to the OutputPage
1232 protected function addUploadJS() {
1233 $config = $this->getConfig();
1235 $useAjaxDestCheck = $config->get( 'UseAjax' ) && $config->get( 'AjaxUploadDestCheck' );
1236 $useAjaxLicensePreview = $config->get( 'UseAjax' ) &&
1237 $config->get( 'AjaxLicensePreview' ) && $config->get( 'EnableAPI' );
1238 $this->mMaxUploadSize
['*'] = UploadBase
::getMaxUploadSize();
1241 'wgAjaxUploadDestCheck' => $useAjaxDestCheck,
1242 'wgAjaxLicensePreview' => $useAjaxLicensePreview,
1243 'wgUploadAutoFill' => !$this->mForReUpload
&&
1244 // If we received mDestFile from the request, don't autofill
1245 // the wpDestFile textbox
1246 $this->mDestFile
=== '',
1247 'wgUploadSourceIds' => $this->mSourceIds
,
1248 'wgCheckFileExtensions' => $config->get( 'CheckFileExtensions' ),
1249 'wgStrictFileExtensions' => $config->get( 'StrictFileExtensions' ),
1250 'wgFileExtensions' => array_values( array_unique( $config->get( 'FileExtensions' ) ) ),
1251 'wgCapitalizeUploads' => MWNamespace
::isCapitalized( NS_FILE
),
1252 'wgMaxUploadSize' => $this->mMaxUploadSize
,
1253 'wgFileCanRotate' => SpecialUpload
::rotationEnabled(),
1256 $out = $this->getOutput();
1257 $out->addJsConfigVars( $scriptVars );
1260 'mediawiki.special.upload', // Extras for thumbnail and license preview.
1265 * Empty function; submission is handled elsewhere.
1267 * @return bool False
1269 function trySubmit() {
1275 * A form field that contains a radio box in the label
1277 class UploadSourceField
extends HTMLTextField
{
1280 * @param array $cellAttributes
1283 function getLabelHtml( $cellAttributes = [] ) {
1284 $id = $this->mParams
['id'];
1285 $label = Html
::rawElement( 'label', [ 'for' => $id ], $this->mLabel
);
1287 if ( !empty( $this->mParams
['radio'] ) ) {
1288 if ( isset( $this->mParams
['radio-id'] ) ) {
1289 $radioId = $this->mParams
['radio-id'];
1291 // Old way. For the benefit of extensions that do not define
1292 // the 'radio-id' key.
1293 $radioId = 'wpSourceType' . $this->mParams
['upload-type'];
1297 'name' => 'wpSourceType',
1300 'value' => $this->mParams
['upload-type'],
1303 if ( !empty( $this->mParams
['checked'] ) ) {
1304 $attribs['checked'] = 'checked';
1307 $label .= Html
::element( 'input', $attribs );
1310 return Html
::rawElement( 'td', [ 'class' => 'mw-label' ] +
$cellAttributes, $label );
1316 function getSize() {
1317 return isset( $this->mParams
['size'] )
1318 ?
$this->mParams
['size']