4 * @addtogroup SpecialPage
11 function wfSpecialUpload() {
13 $form = new UploadForm( $wgRequest );
18 * implements Special:Upload
19 * @addtogroup SpecialPage
25 var $mComment, $mLicense, $mIgnoreWarning, $mCurlError;
26 var $mDestName, $mTempPath, $mFileSize, $mFileProps;
27 var $mCopyrightStatus, $mCopyrightSource, $mReUpload, $mAction, $mUploadClicked;
28 var $mSrcName, $mSessionKey, $mStashed, $mDesiredDestName, $mRemoveTempFile, $mSourceType;
29 var $mDestWarningAck, $mCurlDestHandle;
32 # Placeholders for text injection by hooks (must be HTML)
33 # extensions should take care to _append_ to the present value
34 var $uploadFormTextTop;
35 var $uploadFormTextAfterSummary;
37 const SESSION_VERSION
= 1;
41 * Constructor : initialise object
42 * Get data POSTed through the form and assign them to the object
43 * @param $request Data posted.
45 function UploadForm( &$request ) {
46 global $wgAllowCopyUploads;
47 $this->mDesiredDestName
= $request->getText( 'wpDestFile' );
48 $this->mIgnoreWarning
= $request->getCheck( 'wpIgnoreWarning' );
49 $this->mComment
= $request->getText( 'wpUploadDescription' );
51 if( !$request->wasPosted() ) {
52 # GET requests just give the main form; no data except destination
53 # filename and description
57 # Placeholders for text injection by hooks (empty per default)
58 $this->uploadFormTextTop
= "";
59 $this->uploadFormTextAfterSummary
= "";
61 $this->mReUpload
= $request->getCheck( 'wpReUpload' );
62 $this->mUploadClicked
= $request->getCheck( 'wpUpload' );
64 $this->mLicense
= $request->getText( 'wpLicense' );
65 $this->mCopyrightStatus
= $request->getText( 'wpUploadCopyStatus' );
66 $this->mCopyrightSource
= $request->getText( 'wpUploadSource' );
67 $this->mWatchthis
= $request->getBool( 'wpWatchthis' );
68 $this->mSourceType
= $request->getText( 'wpSourceType' );
69 $this->mDestWarningAck
= $request->getText( 'wpDestFileWarningAck' );
71 $this->mAction
= $request->getVal( 'action' );
73 $this->mSessionKey
= $request->getInt( 'wpSessionKey' );
74 if( !empty( $this->mSessionKey
) &&
75 isset( $_SESSION['wsUploadData'][$this->mSessionKey
]['version'] ) &&
76 $_SESSION['wsUploadData'][$this->mSessionKey
]['version'] == self
::SESSION_VERSION
) {
78 * Confirming a temporarily stashed upload.
79 * We don't want path names to be forged, so we keep
80 * them in the session on the server and just give
81 * an opaque key to the user agent.
83 $data = $_SESSION['wsUploadData'][$this->mSessionKey
];
84 $this->mTempPath
= $data['mTempPath'];
85 $this->mFileSize
= $data['mFileSize'];
86 $this->mSrcName
= $data['mSrcName'];
87 $this->mFileProps
= $data['mFileProps'];
88 $this->mCurlError
= 0/*UPLOAD_ERR_OK*/;
89 $this->mStashed
= true;
90 $this->mRemoveTempFile
= false;
93 *Check for a newly uploaded file.
95 if( $wgAllowCopyUploads && $this->mSourceType
== 'web' ) {
96 $this->initializeFromUrl( $request );
98 $this->initializeFromUpload( $request );
104 * Initialize the uploaded file from PHP data
107 function initializeFromUpload( $request ) {
108 $this->mTempPath
= $request->getFileTempName( 'wpUploadFile' );
109 $this->mFileSize
= $request->getFileSize( 'wpUploadFile' );
110 $this->mSrcName
= $request->getFileName( 'wpUploadFile' );
111 $this->mCurlError
= $request->getUploadError( 'wpUploadFile' );
112 $this->mSessionKey
= false;
113 $this->mStashed
= false;
114 $this->mRemoveTempFile
= false; // PHP will handle this
118 * Copy a web file to a temporary file
121 function initializeFromUrl( $request ) {
122 global $wgTmpDirectory;
123 $url = $request->getText( 'wpUploadFileURL' );
124 $local_file = tempnam( $wgTmpDirectory, 'WEBUPLOAD' );
126 $this->mTempPath
= $local_file;
127 $this->mFileSize
= 0; # Will be set by curlCopy
128 $this->mCurlError
= $this->curlCopy( $url, $local_file );
129 $this->mSrcName
= array_pop( explode( '/', $url ) );
130 $this->mSessionKey
= false;
131 $this->mStashed
= false;
133 // PHP won't auto-cleanup the file
134 $this->mRemoveTempFile
= file_exists( $local_file );
139 * Returns true if there was an error, false otherwise
141 private function curlCopy( $url, $dest ) {
142 global $wgUser, $wgOut;
144 if( !$wgUser->isAllowed( 'upload_by_url' ) ) {
145 $wgOut->permissionRequired( 'upload_by_url' );
149 # Maybe remove some pasting blanks :-)
151 if( stripos($url, 'http://') !== 0 && stripos($url, 'ftp://') !== 0 ) {
152 # Only HTTP or FTP URLs
153 $wgOut->errorPage( 'upload-proto-error', 'upload-proto-error-text' );
157 # Open temporary file
158 $this->mCurlDestHandle
= @fopen
( $this->mTempPath
, "wb" );
159 if( $this->mCurlDestHandle
=== false ) {
160 # Could not open temporary file to write in
161 $wgOut->errorPage( 'upload-file-error', 'upload-file-error-text');
166 curl_setopt( $ch, CURLOPT_HTTP_VERSION
, 1.0); # Probably not needed, but apparently can work around some bug
167 curl_setopt( $ch, CURLOPT_TIMEOUT
, 10); # 10 seconds timeout
168 curl_setopt( $ch, CURLOPT_LOW_SPEED_LIMIT
, 512); # 0.5KB per second minimum transfer speed
169 curl_setopt( $ch, CURLOPT_URL
, $url);
170 curl_setopt( $ch, CURLOPT_WRITEFUNCTION
, array( $this, 'uploadCurlCallback' ) );
172 $error = curl_errno( $ch ) ?
true : false;
173 $errornum = curl_errno( $ch );
174 // if ( $error ) print curl_error ( $ch ) ; # Debugging output
177 fclose( $this->mCurlDestHandle
);
178 unset( $this->mCurlDestHandle
);
181 if( wfEmptyMsg( "upload-curl-error$errornum", wfMsg("upload-curl-error$errornum") ) )
182 $wgOut->errorPage( 'upload-misc-error', 'upload-misc-error-text' );
184 $wgOut->errorPage( "upload-curl-error$errornum", "upload-curl-error$errornum-text" );
191 * Callback function for CURL-based web transfer
192 * Write data to file unless we've passed the length limit;
193 * if so, abort immediately.
196 function uploadCurlCallback( $ch, $data ) {
197 global $wgMaxUploadSize;
198 $length = strlen( $data );
199 $this->mFileSize +
= $length;
200 if( $this->mFileSize
> $wgMaxUploadSize ) {
203 fwrite( $this->mCurlDestHandle
, $data );
212 global $wgUser, $wgOut;
213 global $wgEnableUploads;
215 # Check uploading enabled
216 if( !$wgEnableUploads ) {
217 $wgOut->showErrorPage( 'uploaddisabled', 'uploaddisabledtext', array( $this->mDesiredDestName
) );
222 if( !$wgUser->isAllowed( 'upload' ) ) {
223 if( !$wgUser->isLoggedIn() ) {
224 $wgOut->showErrorPage( 'uploadnologin', 'uploadnologintext' );
226 $wgOut->permissionRequired( 'upload' );
232 if( $wgUser->isBlocked() ) {
233 $wgOut->blockedPage();
238 $wgOut->readOnlyPage();
242 if( $this->mReUpload
) {
243 if( !$this->unsaveUploadedFile() ) {
246 $this->mainUploadForm();
247 } else if( 'submit' == $this->mAction ||
$this->mUploadClicked
) {
248 $this->processUpload();
250 $this->mainUploadForm();
253 $this->cleanupTempFile();
256 /* -------------------------------------------------------------- */
259 * Really do the upload
260 * Checks are made in SpecialUpload::execute()
263 function processUpload() {
264 global $wgUser, $wgOut;
266 if( !wfRunHooks( 'UploadForm:BeforeProcessing', array( &$this ) ) )
268 wfDebug( "Hook 'UploadForm:BeforeProcessing' broke processing the file." );
272 /* Check for PHP error if any, requires php 4.2 or newer */
273 if( $this->mCurlError
== 1/*UPLOAD_ERR_INI_SIZE*/ ) {
274 $this->mainUploadForm( wfMsgHtml( 'largefileserver' ) );
279 * If there was no filename or a zero size given, give up quick.
281 if( trim( $this->mSrcName
) == '' ||
empty( $this->mFileSize
) ) {
282 $this->mainUploadForm( wfMsgHtml( 'emptyfile' ) );
286 # Chop off any directories in the given filename
287 if( $this->mDesiredDestName
) {
288 $basename = $this->mDesiredDestName
;
290 $basename = $this->mSrcName
;
292 $filtered = wfBaseName( $basename );
295 * We'll want to blacklist against *any* 'extension', and use
296 * only the final one for the whitelist.
298 list( $partname, $ext ) = $this->splitExtensions( $filtered );
300 if( count( $ext ) ) {
301 $finalExt = $ext[count( $ext ) - 1];
306 # If there was more than one "extension", reassemble the base
307 # filename to prevent bogus complaints about length
308 if( count( $ext ) > 1 ) {
309 for( $i = 0; $i < count( $ext ) - 1; $i++
)
310 $partname .= '.' . $ext[$i];
313 if( strlen( $partname ) < 1 ) {
314 $this->mainUploadForm( wfMsgHtml( 'minlength1' ) );
319 * Filter out illegal characters, and try to make a legible name
320 * out of it. We'll strip some silently that Title would die on.
322 $filtered = preg_replace ( "/[^".Title
::legalChars()."]|:/", '-', $filtered );
323 $nt = Title
::makeTitleSafe( NS_IMAGE
, $filtered );
324 if( is_null( $nt ) ) {
325 $this->uploadError( wfMsgWikiHtml( 'illegalfilename', htmlspecialchars( $filtered ) ) );
328 $this->mLocalFile
= wfLocalFile( $nt );
329 $this->mDestName
= $this->mLocalFile
->getName();
332 * If the image is protected, non-sysop users won't be able
333 * to modify it by uploading a new revision.
335 if( !$nt->userCan( 'edit' ) ) {
336 return $this->uploadError( wfMsgWikiHtml( 'protectedpage' ) );
340 * In some cases we may forbid overwriting of existing files.
342 $overwrite = $this->checkOverwrite( $this->mDestName
);
343 if( WikiError
::isError( $overwrite ) ) {
344 return $this->uploadError( $overwrite->toString() );
347 /* Don't allow users to override the blacklist (check file extension) */
348 global $wgStrictFileExtensions;
349 global $wgFileExtensions, $wgFileBlacklist;
350 if ($finalExt == '') {
351 return $this->uploadError( wfMsgExt( 'filetype-missing', array ( 'parseinline' ) ) );
352 } elseif ( $this->checkFileExtensionList( $ext, $wgFileBlacklist ) ||
353 ($wgStrictFileExtensions && !$this->checkFileExtension( $finalExt, $wgFileExtensions ) ) ) {
354 return $this->uploadError( wfMsgExt( 'filetype-badtype', array ( 'parseinline' ),
355 htmlspecialchars( $finalExt ), implode ( ', ', $wgFileExtensions ) ) );
359 * Look at the contents of the file; if we can recognize the
360 * type but it's corrupt or data of the wrong type, we should
361 * probably not accept it.
363 if( !$this->mStashed
) {
364 $this->mFileProps
= File
::getPropsFromPath( $this->mTempPath
, $finalExt );
365 $this->checkMacBinary();
366 $veri = $this->verify( $this->mTempPath
, $finalExt );
368 if( $veri !== true ) { //it's a wiki error...
369 return $this->uploadError( $veri->toString() );
373 * Provide an opportunity for extensions to add further checks
376 if( !wfRunHooks( 'UploadVerification',
377 array( $this->mDestName
, $this->mTempPath
, &$error ) ) ) {
378 return $this->uploadError( $error );
384 * Check for non-fatal conditions
386 if ( ! $this->mIgnoreWarning
) {
389 global $wgCapitalLinks;
390 if( $wgCapitalLinks ) {
391 $filtered = ucfirst( $filtered );
393 if( $basename != $filtered ) {
394 $warning .= '<li>'.wfMsgHtml( 'badfilename', htmlspecialchars( $this->mDestName
) ).'</li>';
397 global $wgCheckFileExtensions;
398 if ( $wgCheckFileExtensions ) {
399 if ( ! $this->checkFileExtension( $finalExt, $wgFileExtensions ) ) {
400 $warning .= '<li>'.wfMsgExt( 'filetype-badtype', array ( 'parseinline' ),
401 htmlspecialchars( $finalExt ), implode ( ', ', $wgFileExtensions ) ).'</li>';
405 global $wgUploadSizeWarning;
406 if ( $wgUploadSizeWarning && ( $this->mFileSize
> $wgUploadSizeWarning ) ) {
407 $skin = $wgUser->getSkin();
408 $wsize = $skin->formatSize( $wgUploadSizeWarning );
409 $asize = $skin->formatSize( $this->mFileSize
);
410 $warning .= '<li>' . wfMsgHtml( 'large-file', $wsize, $asize ) . '</li>';
412 if ( $this->mFileSize
== 0 ) {
413 $warning .= '<li>'.wfMsgHtml( 'emptyfile' ).'</li>';
416 if ( !$this->mDestWarningAck
) {
417 $warning .= self
::getExistsWarning( $this->mLocalFile
);
419 if( $warning != '' ) {
421 * Stash the file in a temporary location; the user can choose
422 * to let it through and we'll complete the upload then.
424 return $this->uploadWarning( $warning );
429 * Try actually saving the thing...
430 * It will show an error form on failure.
432 $pageText = self
::getInitialPageText( $this->mComment
, $this->mLicense
,
433 $this->mCopyrightStatus
, $this->mCopyrightSource
);
435 $status = $this->mLocalFile
->upload( $this->mTempPath
, $this->mComment
, $pageText,
436 File
::DELETE_SOURCE
, $this->mFileProps
);
437 if ( !$status->isGood() ) {
438 $this->showError( $status->getWikiText() );
440 if ( $this->mWatchthis
) {
442 $wgUser->addWatch( $this->mLocalFile
->getTitle() );
444 // Success, redirect to description page
445 $wgOut->redirect( $this->mLocalFile
->getTitle()->getFullURL() );
446 wfRunHooks( 'UploadComplete', array( &$img ) );
451 * Do existence checks on a file and produce a warning
452 * This check is static and can be done pre-upload via AJAX
453 * Returns an HTML fragment consisting of one or more LI elements if there is a warning
454 * Returns an empty string if there is no warning
456 static function getExistsWarning( $file ) {
458 // Check for uppercase extension. We allow these filenames but check if an image
459 // with lowercase extension exists already
461 $ext = $file->getExtension();
462 $sk = $wgUser->getSkin();
464 $partname = substr( $file->getName(), 0, -strlen( $ext ) - 1 );
466 $partname = $file->getName();
469 if ( $ext != strtolower( $ext ) ) {
470 $nt_lc = Title
::newFromText( $partname . '.' . strtolower( $ext ) );
471 $file_lc = wfLocalFile( $nt_lc );
476 if( $file->exists() ) {
477 $dlink = $sk->makeKnownLinkObj( $file->getTitle() );
478 if ( $file->allowInlineDisplay() ) {
479 $dlink2 = $sk->makeImageLinkObj( $file->getTitle(), wfMsgExt( 'fileexists-thumb', 'parseinline', $dlink ),
480 $file->getName(), 'right', array(), false, true );
481 } elseif ( !$file->allowInlineDisplay() && $file->isSafeFile() ) {
482 $icon = $file->iconThumb();
483 $dlink2 = '<div style="float:right" id="mw-media-icon"><a href="' . $file->getURL() . '">' .
484 $icon->toHtml() . '</a><br />' . $dlink . '</div>';
489 $warning .= '<li>' . wfMsgExt( 'fileexists', 'parseline', $dlink ) . '</li>' . $dlink2;
491 } elseif ( $file_lc && $file_lc->exists() ) {
492 # Check if image with lowercase extension exists.
493 # It's not forbidden but in 99% it makes no sense to upload the same filename with uppercase extension
494 $dlink = $sk->makeKnownLinkObj( $nt_lc );
495 if ( $file_lc->allowInlineDisplay() ) {
496 $dlink2 = $sk->makeImageLinkObj( $nt_lc, wfMsgExt( 'fileexists-thumb', 'parseinline', $dlink ),
497 $nt_lc->getText(), 'right', array(), false, true );
498 } elseif ( !$file_lc->allowInlineDisplay() && $file_lc->isSafeFile() ) {
499 $icon = $file_lc->iconThumb();
500 $dlink2 = '<div style="float:right" id="mw-media-icon"><a href="' . $file_lc->getURL() . '">' .
501 $icon->toHtml() . '</a><br />' . $dlink . '</div>';
506 $warning .= '<li>' . wfMsgExt( 'fileexists-extension', 'parsemag' , $partname . '.'
507 . $ext , $dlink ) . '</li>' . $dlink2;
509 } elseif ( ( substr( $partname , 3, 3 ) == 'px-' ||
substr( $partname , 2, 3 ) == 'px-' )
510 && ereg( "[0-9]{2}" , substr( $partname , 0, 2) ) )
512 # Check for filenames like 50px- or 180px-, these are mostly thumbnails
513 $nt_thb = Title
::newFromText( substr( $partname , strpos( $partname , '-' ) +
1 ) . '.' . $ext );
514 $file_thb = wfLocalFile( $nt_thb );
515 if ($file_thb->exists() ) {
516 # Check if an image without leading '180px-' (or similiar) exists
517 $dlink = $sk->makeKnownLinkObj( $nt_thb);
518 if ( $file_thb->allowInlineDisplay() ) {
519 $dlink2 = $sk->makeImageLinkObj( $nt_thb,
520 wfMsgExt( 'fileexists-thumb', 'parseinline', $dlink ),
521 $nt_thb->getText(), 'right', array(), false, true );
522 } elseif ( !$file_thb->allowInlineDisplay() && $file_thb->isSafeFile() ) {
523 $icon = $file_thb->iconThumb();
524 $dlink2 = '<div style="float:right" id="mw-media-icon"><a href="' .
525 $file_thb->getURL() . '">' . $icon->toHtml() . '</a><br />' .
531 $warning .= '<li>' . wfMsgExt( 'fileexists-thumbnail-yes', 'parsemag', $dlink ) .
534 # Image w/o '180px-' does not exists, but we do not like these filenames
535 $warning .= '<li>' . wfMsgExt( 'file-thumbnail-no', 'parseinline' ,
536 substr( $partname , 0, strpos( $partname , '-' ) +
1 ) ) . '</li>';
539 if ( $file->wasDeleted() ) {
540 # If the file existed before and was deleted, warn the user of this
541 # Don't bother doing so if the image exists now, however
542 $ltitle = SpecialPage
::getTitleFor( 'Log' );
543 $llink = $sk->makeKnownLinkObj( $ltitle, wfMsgHtml( 'deletionlog' ),
544 'type=delete&page=' . $file->getTitle()->getPrefixedUrl() );
545 $warning .= '<li>' . wfMsgWikiHtml( 'filewasdeleted', $llink ) . '</li>';
550 static function ajaxGetExistsWarning( $filename ) {
551 $file = wfFindFile( $filename );
554 $warning = self
::getExistsWarning( $file );
555 if ( $warning !== '' ) {
556 $s = "<ul>$warning</ul>";
563 * Render a preview of a given license for the AJAX preview on upload
565 * @param string $license
568 public static function ajaxGetLicensePreview( $license ) {
569 global $wgParser, $wgUser;
570 $text = '{{' . $license . '}}';
571 $title = Title
::makeTitle( NS_IMAGE
, 'Sample.jpg' );
572 $options = ParserOptions
::newFromUser( $wgUser );
574 // Expand subst: first, then live templates...
575 $text = $wgParser->preSaveTransform( $text, $title, $wgUser, $options );
576 $output = $wgParser->parse( $text, $title, $options );
578 return $output->getText();
582 * Stash a file in a temporary directory for later processing
583 * after the user has confirmed it.
585 * If the user doesn't explicitly cancel or accept, these files
586 * can accumulate in the temp directory.
588 * @param string $saveName - the destination filename
589 * @param string $tempName - the source temporary file to save
590 * @return string - full path the stashed file, or false on failure
593 function saveTempUploadedFile( $saveName, $tempName ) {
595 $repo = RepoGroup
::singleton()->getLocalRepo();
596 $status = $repo->storeTemp( $saveName, $tempName );
597 if ( !$status->isGood() ) {
598 $this->showError( $status->getWikiText() );
601 return $status->value
;
606 * Stash a file in a temporary directory for later processing,
607 * and save the necessary descriptive info into the session.
608 * Returns a key value which will be passed through a form
609 * to pick up the path info on a later invocation.
614 function stashSession() {
615 $stash = $this->saveTempUploadedFile( $this->mDestName
, $this->mTempPath
);
618 # Couldn't save the file.
622 $key = mt_rand( 0, 0x7fffffff );
623 $_SESSION['wsUploadData'][$key] = array(
624 'mTempPath' => $stash,
625 'mFileSize' => $this->mFileSize
,
626 'mSrcName' => $this->mSrcName
,
627 'mFileProps' => $this->mFileProps
,
628 'version' => self
::SESSION_VERSION
,
634 * Remove a temporarily kept file stashed by saveTempUploadedFile().
638 function unsaveUploadedFile() {
640 $repo = RepoGroup
::singleton()->getLocalRepo();
641 $success = $repo->freeTemp( $this->mTempPath
);
643 $wgOut->showFileDeleteError( $this->mTempPath
);
650 /* -------------------------------------------------------------- */
653 * @param string $error as HTML
656 function uploadError( $error ) {
658 $wgOut->addHTML( "<h2>" . wfMsgHtml( 'uploadwarning' ) . "</h2>\n" );
659 $wgOut->addHTML( "<span class='error'>{$error}</span>\n" );
663 * There's something wrong with this file, not enough to reject it
664 * totally but we require manual intervention to save it for real.
665 * Stash it away, then present a form asking to confirm or cancel.
667 * @param string $warning as HTML
670 function uploadWarning( $warning ) {
672 global $wgUseCopyrightUpload;
674 $this->mSessionKey
= $this->stashSession();
675 if( !$this->mSessionKey
) {
676 # Couldn't save file; an error has been displayed so let's go.
680 $wgOut->addHTML( "<h2>" . wfMsgHtml( 'uploadwarning' ) . "</h2>\n" );
681 $wgOut->addHTML( "<ul class='warning'>{$warning}</ul><br />\n" );
683 $save = wfMsgHtml( 'savefile' );
684 $reupload = wfMsgHtml( 'reupload' );
685 $iw = wfMsgWikiHtml( 'ignorewarning' );
686 $reup = wfMsgWikiHtml( 'reuploaddesc' );
687 $titleObj = SpecialPage
::getTitleFor( 'Upload' );
688 $action = $titleObj->escapeLocalURL( 'action=submit' );
690 if ( $wgUseCopyrightUpload )
693 <input type='hidden' name='wpUploadCopyStatus' value=\"" . htmlspecialchars( $this->mCopyrightStatus
) . "\" />
694 <input type='hidden' name='wpUploadSource' value=\"" . htmlspecialchars( $this->mCopyrightSource
) . "\" />
701 <form id='uploadwarning' method='post' enctype='multipart/form-data' action='$action'>
702 <input type='hidden' name='wpIgnoreWarning' value='1' />
703 <input type='hidden' name='wpSessionKey' value=\"" . htmlspecialchars( $this->mSessionKey
) . "\" />
704 <input type='hidden' name='wpUploadDescription' value=\"" . htmlspecialchars( $this->mComment
) . "\" />
705 <input type='hidden' name='wpLicense' value=\"" . htmlspecialchars( $this->mLicense
) . "\" />
706 <input type='hidden' name='wpDestFile' value=\"" . htmlspecialchars( $this->mDesiredDestName
) . "\" />
707 <input type='hidden' name='wpWatchthis' value=\"" . htmlspecialchars( intval( $this->mWatchthis
) ) . "\" />
713 <input tabindex='2' type='submit' name='wpUpload' value=\"$save\" />
715 <td align='left'>$iw</td>
719 <input tabindex='2' type='submit' name='wpReUpload' value=\"{$reupload}\" />
721 <td align='left'>$reup</td>
724 </table></form>\n" );
728 * Displays the main upload form, optionally with a highlighted
729 * error message up at the top.
731 * @param string $msg as HTML
734 function mainUploadForm( $msg='' ) {
735 global $wgOut, $wgUser;
736 global $wgUseCopyrightUpload, $wgUseAjax, $wgAjaxUploadDestCheck, $wgAjaxLicensePreview;
737 global $wgRequest, $wgAllowCopyUploads, $wgEnableAPI;
738 global $wgStylePath, $wgStyleVersion;
740 $useAjaxDestCheck = $wgUseAjax && $wgAjaxUploadDestCheck;
741 $useAjaxLicensePreview = $wgUseAjax && $wgAjaxLicensePreview;
743 $adc = wfBoolToStr( $useAjaxDestCheck );
744 $alp = wfBoolToStr( $useAjaxLicensePreview );
746 $wgOut->addScript( "<script type=\"text/javascript\">
747 wgAjaxUploadDestCheck = {$adc};
748 wgAjaxLicensePreview = {$alp};
750 <script type=\"text/javascript\" src=\"{$wgStylePath}/common/upload.js?{$wgStyleVersion}\"></script>
753 if( !wfRunHooks( 'UploadForm:initial', array( &$this ) ) )
755 wfDebug( "Hook 'UploadForm:initial' broke output of the upload form" );
759 $cols = intval($wgUser->getOption( 'cols' ));
760 $ew = $wgUser->getOption( 'editwidth' );
761 if ( $ew ) $ew = " style=\"width:100%\"";
765 $sub = wfMsgHtml( 'uploaderror' );
766 $wgOut->addHTML( "<h2>{$sub}</h2>\n" .
767 "<span class='error'>{$msg}</span>\n" );
769 $wgOut->addHTML( '<div id="uploadtext">' );
770 $wgOut->addWikiText( wfMsgNoTrans( 'uploadtext', $this->mDesiredDestName
) );
771 $wgOut->addHTML( '</div>' );
773 $sourcefilename = wfMsgHtml( 'sourcefilename' );
774 $destfilename = wfMsgHtml( 'destfilename' );
775 $summary = wfMsgWikiHtml( 'fileuploadsummary' );
777 $licenses = new Licenses();
778 $license = wfMsgExt( 'license', array( 'parseinline' ) );
779 $nolicense = wfMsgHtml( 'nolicense' );
780 $licenseshtml = $licenses->getHtml();
782 $ulb = wfMsgHtml( 'uploadbtn' );
785 $titleObj = SpecialPage
::getTitleFor( 'Upload' );
786 $action = $titleObj->escapeLocalURL();
788 $encDestName = htmlspecialchars( $this->mDesiredDestName
);
791 ( $wgUser->getOption( 'watchdefault' ) ||
792 ( $wgUser->getOption( 'watchcreations' ) && $this->mDesiredDestName
== '' ) )
793 ?
'checked="checked"'
795 $warningChecked = $this->mIgnoreWarning ?
'checked' : '';
797 // Prepare form for upload or upload/copy
798 if( $wgAllowCopyUploads && $wgUser->isAllowed( 'upload_by_url' ) ) {
800 "<input type='radio' id='wpSourceTypeFile' name='wpSourceType' value='file' " .
801 "onchange='toggle_element_activation(\"wpUploadFileURL\",\"wpUploadFile\")' checked />" .
802 "<input tabindex='1' type='file' name='wpUploadFile' id='wpUploadFile' " .
804 "toggle_element_activation(\"wpUploadFileURL\",\"wpUploadFile\");" .
805 "toggle_element_check(\"wpSourceTypeFile\",\"wpSourceTypeURL\")'" .
806 ($this->mDesiredDestName?
"":"onchange='fillDestFilename(\"wpUploadFile\")' ") . "size='40' />" .
807 wfMsgHTML( 'upload_source_file' ) . "<br/>" .
808 "<input type='radio' id='wpSourceTypeURL' name='wpSourceType' value='web' " .
809 "onchange='toggle_element_activation(\"wpUploadFile\",\"wpUploadFileURL\")' />" .
810 "<input tabindex='1' type='text' name='wpUploadFileURL' id='wpUploadFileURL' " .
812 "toggle_element_activation(\"wpUploadFile\",\"wpUploadFileURL\");" .
813 "toggle_element_check(\"wpSourceTypeURL\",\"wpSourceTypeFile\")'" .
814 ($this->mDesiredDestName?
"":"onchange='fillDestFilename(\"wpUploadFileURL\")' ") . "size='40' DISABLED />" .
815 wfMsgHtml( 'upload_source_url' ) ;
818 "<input tabindex='1' type='file' name='wpUploadFile' id='wpUploadFile' " .
819 ($this->mDesiredDestName?
"":"onchange='fillDestFilename(\"wpUploadFile\")' ") .
821 "<input type='hidden' name='wpSourceType' value='file' />" ;
823 if ( $useAjaxDestCheck ) {
824 $warningRow = "<tr><td colspan='2' id='wpDestFile-warning'> </td></tr>";
825 $destOnkeyup = 'onkeyup="wgUploadWarningObj.keypress();"';
831 $encComment = htmlspecialchars( $this->mComment
);
833 $wgOut->addHTML( <<<EOT
834 <form id='upload' method='post' enctype='multipart/form-data' action="$action">
837 {$this->uploadFormTextTop}
838 <td align='right' valign='top'><label for='wpUploadFile'>{$sourcefilename}:</label></td>
844 <td align='right'><label for='wpDestFile'>{$destfilename}:</label></td>
846 <input tabindex='2' type='text' name='wpDestFile' id='wpDestFile' size='40'
847 value="$encDestName" $destOnkeyup />
851 <td align='right'><label for='wpUploadDescription'>{$summary}</label></td>
853 <textarea tabindex='3' name='wpUploadDescription' id='wpUploadDescription' rows='6'
854 cols='{$cols}'{$ew}>$encComment</textarea>
855 {$this->uploadFormTextAfterSummary}
862 if ( $licenseshtml != '' ) {
865 <td align='right'><label for='wpLicense'>$license:</label></td>
867 <select name='wpLicense' id='wpLicense' tabindex='4'
868 onchange='licenseSelectorCheck()'>
869 <option value=''>$nolicense</option>
875 if( $useAjaxLicensePreview ) {
878 <td id=\"mw-license-preview\"></td>
884 if ( $wgUseCopyrightUpload ) {
885 $filestatus = wfMsgHtml ( 'filestatus' );
886 $copystatus = htmlspecialchars( $this->mCopyrightStatus
);
887 $filesource = wfMsgHtml ( 'filesource' );
888 $uploadsource = htmlspecialchars( $this->mCopyrightSource
);
891 <td align='right' nowrap='nowrap'><label for='wpUploadCopyStatus'>$filestatus:</label></td>
892 <td><input tabindex='5' type='text' name='wpUploadCopyStatus' id='wpUploadCopyStatus'
893 value=\"$copystatus\" size='40' /></td>
896 <td align='right'><label for='wpUploadCopyStatus'>$filesource:</label></td>
897 <td><input tabindex='6' type='text' name='wpUploadSource' id='wpUploadCopyStatus'
898 value=\"$uploadsource\" size='40' /></td>
907 <input tabindex='7' type='checkbox' name='wpWatchthis' id='wpWatchthis' $watchChecked value='true' />
908 <label for='wpWatchthis'>" . wfMsgHtml( 'watchthisupload' ) . "</label>
909 <input tabindex='8' type='checkbox' name='wpIgnoreWarning' id='wpIgnoreWarning' value='true' $warningChecked/>
910 <label for='wpIgnoreWarning'>" . wfMsgHtml( 'ignorewarnings' ) . "</label>
916 <td align='left'><input tabindex='9' type='submit' name='wpUpload' value=\"{$ulb}\" /></td>
922 $wgOut->addWikiText( wfMsgForContent( 'edittools' ) );
928 <input type='hidden' name='wpDestFileWarningAck' id='wpDestFileWarningAck' value=''/>
932 /* -------------------------------------------------------------- */
935 * Split a file into a base name and all dot-delimited 'extensions'
936 * on the end. Some web server configurations will fall back to
937 * earlier pseudo-'extensions' to determine type and execute
938 * scripts, so the blacklist needs to check them all.
942 function splitExtensions( $filename ) {
943 $bits = explode( '.', $filename );
944 $basename = array_shift( $bits );
945 return array( $basename, $bits );
949 * Perform case-insensitive match against a list of file extensions.
950 * Returns true if the extension is in the list.
956 function checkFileExtension( $ext, $list ) {
957 return in_array( strtolower( $ext ), $list );
961 * Perform case-insensitive match against a list of file extensions.
962 * Returns true if any of the extensions are in the list.
968 function checkFileExtensionList( $ext, $list ) {
969 foreach( $ext as $e ) {
970 if( in_array( strtolower( $e ), $list ) ) {
978 * Verifies that it's ok to include the uploaded file
980 * @param string $tmpfile the full path of the temporary file to verify
981 * @param string $extension The filename extension that the file is to be served with
982 * @return mixed true of the file is verified, a WikiError object otherwise.
984 function verify( $tmpfile, $extension ) {
985 #magically determine mime type
986 $magic=& MimeMagic
::singleton();
987 $mime= $magic->guessMimeType($tmpfile,false);
989 #check mime type, if desired
990 global $wgVerifyMimeType;
991 if ($wgVerifyMimeType) {
993 wfDebug ( "\n\nmime: <$mime> extension: <$extension>\n\n");
994 #check mime type against file extension
995 if( !$this->verifyExtension( $mime, $extension ) ) {
996 return new WikiErrorMsg( 'uploadcorrupt' );
999 #check mime type blacklist
1000 global $wgMimeTypeBlacklist;
1001 if( isset($wgMimeTypeBlacklist) && !is_null($wgMimeTypeBlacklist)
1002 && $this->checkFileExtension( $mime, $wgMimeTypeBlacklist ) ) {
1003 return new WikiErrorMsg( 'filetype-badmime', htmlspecialchars( $mime ) );
1007 #check for htmlish code and javascript
1008 if( $this->detectScript ( $tmpfile, $mime, $extension ) ) {
1009 return new WikiErrorMsg( 'uploadscripted' );
1013 * Scan the uploaded file for viruses
1015 $virus= $this->detectVirus($tmpfile);
1017 return new WikiErrorMsg( 'uploadvirus', htmlspecialchars($virus) );
1020 wfDebug( __METHOD__
.": all clear; passing.\n" );
1025 * Checks if the mime type of the uploaded file matches the file extension.
1027 * @param string $mime the mime type of the uploaded file
1028 * @param string $extension The filename extension that the file is to be served with
1031 function verifyExtension( $mime, $extension ) {
1032 $magic =& MimeMagic
::singleton();
1034 if ( ! $mime ||
$mime == 'unknown' ||
$mime == 'unknown/unknown' )
1035 if ( ! $magic->isRecognizableExtension( $extension ) ) {
1036 wfDebug( __METHOD__
.": passing file with unknown detected mime type; " .
1037 "unrecognized extension '$extension', can't verify\n" );
1040 wfDebug( __METHOD__
.": rejecting file with unknown detected mime type; ".
1041 "recognized extension '$extension', so probably invalid file\n" );
1045 $match= $magic->isMatchingExtension($extension,$mime);
1047 if ($match===NULL) {
1048 wfDebug( __METHOD__
.": no file extension known for mime type $mime, passing file\n" );
1050 } elseif ($match===true) {
1051 wfDebug( __METHOD__
.": mime type $mime matches extension $extension, passing file\n" );
1053 #TODO: if it's a bitmap, make sure PHP or ImageMagic resp. can handle it!
1057 wfDebug( __METHOD__
.": mime type $mime mismatches file extension $extension, rejecting file\n" );
1063 * Heuristic for detecting files that *could* contain JavaScript instructions or
1064 * things that may look like HTML to a browser and are thus
1065 * potentially harmful. The present implementation will produce false positives in some situations.
1067 * @param string $file Pathname to the temporary upload file
1068 * @param string $mime The mime type of the file
1069 * @param string $extension The extension of the file
1070 * @return bool true if the file contains something looking like embedded scripts
1072 function detectScript($file, $mime, $extension) {
1073 global $wgAllowTitlesInSVG;
1075 #ugly hack: for text files, always look at the entire file.
1076 #For binarie field, just check the first K.
1078 if (strpos($mime,'text/')===0) $chunk = file_get_contents( $file );
1080 $fp = fopen( $file, 'rb' );
1081 $chunk = fread( $fp, 1024 );
1085 $chunk= strtolower( $chunk );
1087 if (!$chunk) return false;
1089 #decode from UTF-16 if needed (could be used for obfuscation).
1090 if (substr($chunk,0,2)=="\xfe\xff") $enc= "UTF-16BE";
1091 elseif (substr($chunk,0,2)=="\xff\xfe") $enc= "UTF-16LE";
1094 if ($enc) $chunk= iconv($enc,"ASCII//IGNORE",$chunk);
1096 $chunk= trim($chunk);
1098 #FIXME: convert from UTF-16 if necessarry!
1100 wfDebug("SpecialUpload::detectScript: checking for embedded scripts and HTML stuff\n");
1102 #check for HTML doctype
1103 if (eregi("<!DOCTYPE *X?HTML",$chunk)) return true;
1106 * Internet Explorer for Windows performs some really stupid file type
1107 * autodetection which can cause it to interpret valid image files as HTML
1108 * and potentially execute JavaScript, creating a cross-site scripting
1111 * Apple's Safari browser also performs some unsafe file type autodetection
1112 * which can cause legitimate files to be interpreted as HTML if the
1113 * web server is not correctly configured to send the right content-type
1114 * (or if you're really uploading plain text and octet streams!)
1116 * Returns true if IE is likely to mistake the given file for HTML.
1117 * Also returns true if Safari would mistake the given file for HTML
1118 * when served with a generic content-type.
1124 '<html', #also in safari
1127 '<script', #also in safari
1130 if( ! $wgAllowTitlesInSVG && $extension !== 'svg' && $mime !== 'image/svg' ) {
1134 foreach( $tags as $tag ) {
1135 if( false !== strpos( $chunk, $tag ) ) {
1141 * look for javascript
1144 #resolve entity-refs to look at attributes. may be harsh on big files... cache result?
1145 $chunk = Sanitizer
::decodeCharReferences( $chunk );
1147 #look for script-types
1148 if (preg_match('!type\s*=\s*[\'"]?\s*(?:\w*/)?(?:ecma|java)!sim',$chunk)) return true;
1150 #look for html-style script-urls
1151 if (preg_match('!(?:href|src|data)\s*=\s*[\'"]?\s*(?:ecma|java)script:!sim',$chunk)) return true;
1153 #look for css-style script-urls
1154 if (preg_match('!url\s*\(\s*[\'"]?\s*(?:ecma|java)script:!sim',$chunk)) return true;
1156 wfDebug("SpecialUpload::detectScript: no scripts found\n");
1161 * Generic wrapper function for a virus scanner program.
1162 * This relies on the $wgAntivirus and $wgAntivirusSetup variables.
1163 * $wgAntivirusRequired may be used to deny upload if the scan fails.
1165 * @param string $file Pathname to the temporary upload file
1166 * @return mixed false if not virus is found, NULL if the scan fails or is disabled,
1167 * or a string containing feedback from the virus scanner if a virus was found.
1168 * If textual feedback is missing but a virus was found, this function returns true.
1170 function detectVirus($file) {
1171 global $wgAntivirus, $wgAntivirusSetup, $wgAntivirusRequired, $wgOut;
1173 if ( !$wgAntivirus ) {
1174 wfDebug( __METHOD__
.": virus scanner disabled\n");
1178 if ( !$wgAntivirusSetup[$wgAntivirus] ) {
1179 wfDebug( __METHOD__
.": unknown virus scanner: $wgAntivirus\n" );
1181 $wgOut->addHTML( "<div class='error'>Bad configuration: unknown virus scanner: <i>$wgAntivirus</i></div>\n" );
1182 return "unknown antivirus: $wgAntivirus";
1185 # look up scanner configuration
1186 $command = $wgAntivirusSetup[$wgAntivirus]["command"];
1187 $exitCodeMap = $wgAntivirusSetup[$wgAntivirus]["codemap"];
1188 $msgPattern = isset( $wgAntivirusSetup[$wgAntivirus]["messagepattern"] ) ?
1189 $wgAntivirusSetup[$wgAntivirus]["messagepattern"] : null;
1191 if ( strpos( $command,"%f" ) === false ) {
1192 # simple pattern: append file to scan
1193 $command .= " " . wfEscapeShellArg( $file );
1195 # complex pattern: replace "%f" with file to scan
1196 $command = str_replace( "%f", wfEscapeShellArg( $file ), $command );
1199 wfDebug( __METHOD__
.": running virus scan: $command \n" );
1201 # execute virus scanner
1204 #NOTE: there's a 50 line workaround to make stderr redirection work on windows, too.
1205 # that does not seem to be worth the pain.
1206 # Ask me (Duesentrieb) about it if it's ever needed.
1208 if ( wfIsWindows() ) {
1209 exec( "$command", $output, $exitCode );
1211 exec( "$command 2>&1", $output, $exitCode );
1214 # map exit code to AV_xxx constants.
1215 $mappedCode = $exitCode;
1216 if ( $exitCodeMap ) {
1217 if ( isset( $exitCodeMap[$exitCode] ) ) {
1218 $mappedCode = $exitCodeMap[$exitCode];
1219 } elseif ( isset( $exitCodeMap["*"] ) ) {
1220 $mappedCode = $exitCodeMap["*"];
1224 if ( $mappedCode === AV_SCAN_FAILED
) {
1225 # scan failed (code was mapped to false by $exitCodeMap)
1226 wfDebug( __METHOD__
.": failed to scan $file (code $exitCode).\n" );
1228 if ( $wgAntivirusRequired ) {
1229 return "scan failed (code $exitCode)";
1233 } else if ( $mappedCode === AV_SCAN_ABORTED
) {
1234 # scan failed because filetype is unknown (probably imune)
1235 wfDebug( __METHOD__
.": unsupported file type $file (code $exitCode).\n" );
1237 } else if ( $mappedCode === AV_NO_VIRUS
) {
1239 wfDebug( __METHOD__
.": file passed virus scan.\n" );
1242 $output = join( "\n", $output );
1243 $output = trim( $output );
1246 $output = true; #if there's no output, return true
1247 } elseif ( $msgPattern ) {
1249 if ( preg_match( $msgPattern, $output, $groups ) ) {
1251 $output = $groups[1];
1256 wfDebug( __METHOD__
.": FOUND VIRUS! scanner feedback: $output" );
1262 * Check if the temporary file is MacBinary-encoded, as some uploads
1263 * from Internet Explorer on Mac OS Classic and Mac OS X will be.
1264 * If so, the data fork will be extracted to a second temporary file,
1265 * which will then be checked for validity and either kept or discarded.
1269 function checkMacBinary() {
1270 $macbin = new MacBinary( $this->mTempPath
);
1271 if( $macbin->isValid() ) {
1272 $dataFile = tempnam( wfTempDir(), "WikiMacBinary" );
1273 $dataHandle = fopen( $dataFile, 'wb' );
1275 wfDebug( "SpecialUpload::checkMacBinary: Extracting MacBinary data fork to $dataFile\n" );
1276 $macbin->extractData( $dataHandle );
1278 $this->mTempPath
= $dataFile;
1279 $this->mFileSize
= $macbin->dataForkLength();
1281 // We'll have to manually remove the new file if it's not kept.
1282 $this->mRemoveTempFile
= true;
1288 * If we've modified the upload file we need to manually remove it
1289 * on exit to clean up.
1292 function cleanupTempFile() {
1293 if ( $this->mRemoveTempFile
&& file_exists( $this->mTempPath
) ) {
1294 wfDebug( "SpecialUpload::cleanupTempFile: Removing temporary file {$this->mTempPath}\n" );
1295 unlink( $this->mTempPath
);
1300 * Check if there's an overwrite conflict and, if so, if restrictions
1301 * forbid this user from performing the upload.
1303 * @return mixed true on success, WikiError on failure
1306 function checkOverwrite( $name ) {
1307 $img = wfFindFile( $name );
1311 global $wgUser, $wgOut;
1312 if( $img->isLocal() ) {
1313 if( !self
::userCanReUpload( $wgUser, $img->name
) ) {
1314 $error = 'fileexists-forbidden';
1317 if( !$wgUser->isAllowed( 'reupload' ) ||
1318 !$wgUser->isAllowed( 'reupload-shared' ) ) {
1319 $error = "fileexists-shared-forbidden";
1325 $errorText = wfMsg( $error, wfEscapeWikiText( $img->getName() ) );
1326 return new WikiError( $wgOut->parse( $errorText ) );
1329 // Rockin', go ahead and upload
1334 * Check if a user is the last uploader
1337 * @param string $img, image name
1340 public static function userCanReUpload( User
$user, $img ) {
1341 if( $user->isAllowed( 'reupload' ) )
1342 return true; // non-conditional
1343 if( !$user->isAllowed( 'reupload-own' ) )
1346 $dbr = wfGetDB( DB_SLAVE
);
1347 $row = $dbr->selectRow('image',
1348 /* SELECT */ 'img_user',
1349 /* WHERE */ array( 'img_name' => $img )
1354 return $user->getID() == $row->img_user
;
1358 * Display an error with a wikitext description
1360 function showError( $description ) {
1362 $wgOut->setPageTitle( wfMsg( "internalerror" ) );
1363 $wgOut->setRobotpolicy( "noindex,nofollow" );
1364 $wgOut->setArticleRelated( false );
1365 $wgOut->enableClientCache( false );
1366 $wgOut->addWikiText( $description );
1370 * Get the initial image page text based on a comment and optional file status information
1372 static function getInitialPageText( $comment, $license, $copyStatus, $source ) {
1373 global $wgUseCopyrightUpload;
1374 if ( $wgUseCopyrightUpload ) {
1375 if ( $license != '' ) {
1376 $licensetxt = '== ' . wfMsgForContent( 'license' ) . " ==\n" . '{{' . $license . '}}' . "\n";
1378 $pageText = '== ' . wfMsg ( 'filedesc' ) . " ==\n" . $comment . "\n" .
1379 '== ' . wfMsgForContent ( 'filestatus' ) . " ==\n" . $copyStatus . "\n" .
1381 '== ' . wfMsgForContent ( 'filesource' ) . " ==\n" . $source ;
1383 if ( $license != '' ) {
1384 $filedesc = $comment == '' ?
'' : '== ' . wfMsg ( 'filedesc' ) . " ==\n" . $comment . "\n";
1385 $pageText = $filedesc .
1386 '== ' . wfMsgForContent ( 'license' ) . " ==\n" . '{{' . $license . '}}' . "\n";
1388 $pageText = $comment;