5 * @subpackage SpecialPage
12 function wfSpecialUpload() {
14 $form = new UploadForm( $wgRequest );
21 * @subpackage SpecialPage
27 var $mUploadFile, $mUploadDescription, $mLicense ,$mIgnoreWarning, $mUploadError;
28 var $mUploadSaveName, $mUploadTempName, $mUploadSize, $mUploadOldVersion;
29 var $mUploadCopyStatus, $mUploadSource, $mReUpload, $mAction, $mUpload;
30 var $mOname, $mSessionKey, $mStashed, $mDestFile, $mRemoveTempFile, $mSourceType;
31 var $mUploadTempFileSize = 0;
33 # Placeholders for text injection by hooks (must be HTML)
34 # extensions should take care to _append_ to the present value
35 var $uploadFormTextTop;
36 var $uploadFormTextAfterSummary;
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->mDestFile
= $request->getText( 'wpDestFile' );
49 if( !$request->wasPosted() ) {
50 # GET requests just give the main form; no data except wpDestfile.
54 # Placeholders for text injection by hooks (empty per default)
55 $this->uploadFormTextTop
= "";
56 $this->uploadFormTextAfterSummary
= "";
58 $this->mIgnoreWarning
= $request->getCheck( 'wpIgnoreWarning' );
59 $this->mReUpload
= $request->getCheck( 'wpReUpload' );
60 $this->mUpload
= $request->getCheck( 'wpUpload' );
62 $this->mUploadDescription
= $request->getText( 'wpUploadDescription' );
63 $this->mLicense
= $request->getText( 'wpLicense' );
64 $this->mUploadCopyStatus
= $request->getText( 'wpUploadCopyStatus' );
65 $this->mUploadSource
= $request->getText( 'wpUploadSource' );
66 $this->mWatchthis
= $request->getBool( 'wpWatchthis' );
67 $this->mSourceType
= $request->getText( 'wpSourceType' );
68 wfDebug( "UploadForm: watchthis is: '$this->mWatchthis'\n" );
70 $this->mAction
= $request->getVal( 'action' );
72 $this->mSessionKey
= $request->getInt( 'wpSessionKey' );
73 if( !empty( $this->mSessionKey
) &&
74 isset( $_SESSION['wsUploadData'][$this->mSessionKey
] ) ) {
76 * Confirming a temporarily stashed upload.
77 * We don't want path names to be forged, so we keep
78 * them in the session on the server and just give
79 * an opaque key to the user agent.
81 $data = $_SESSION['wsUploadData'][$this->mSessionKey
];
82 $this->mUploadTempName
= $data['mUploadTempName'];
83 $this->mUploadSize
= $data['mUploadSize'];
84 $this->mOname
= $data['mOname'];
85 $this->mUploadError
= 0/*UPLOAD_ERR_OK*/;
86 $this->mStashed
= true;
87 $this->mRemoveTempFile
= false;
90 *Check for a newly uploaded file.
92 if( $wgAllowCopyUploads && $this->mSourceType
== 'web' ) {
93 $this->initializeFromUrl( $request );
95 $this->initializeFromUpload( $request );
101 * Initialize the uploaded file from PHP data
104 function initializeFromUpload( $request ) {
105 $this->mUploadTempName
= $request->getFileTempName( 'wpUploadFile' );
106 $this->mUploadSize
= $request->getFileSize( 'wpUploadFile' );
107 $this->mOname
= $request->getFileName( 'wpUploadFile' );
108 $this->mUploadError
= $request->getUploadError( 'wpUploadFile' );
109 $this->mSessionKey
= false;
110 $this->mStashed
= false;
111 $this->mRemoveTempFile
= false; // PHP will handle this
115 * Copy a web file to a temporary file
118 function initializeFromUrl( $request ) {
119 global $wgTmpDirectory;
120 $url = $request->getText( 'wpUploadFileURL' );
121 $local_file = tempnam( $wgTmpDirectory, 'WEBUPLOAD' );
123 $this->mUploadTempName
= $local_file;
124 $this->mUploadError
= $this->curlCopy( $url, $local_file );
125 $this->mUploadSize
= $this->mUploadTempFileSize
;
126 $this->mOname
= array_pop( explode( '/', $url ) );
127 $this->mSessionKey
= false;
128 $this->mStashed
= false;
130 // PHP won't auto-cleanup the file
131 $this->mRemoveTempFile
= file_exists( $local_file );
136 * Returns true if there was an error, false otherwise
138 private function curlCopy( $url, $dest ) {
139 global $wgUser, $wgOut;
141 if( !$wgUser->isAllowed( 'upload_by_url' ) ) {
142 $wgOut->permissionRequired( 'upload_by_url' );
146 # Maybe remove some pasting blanks :-)
148 if( stripos($url, 'http://') !== 0 && stripos($url, 'ftp://') !== 0 ) {
149 # Only HTTP or FTP URLs
150 $wgOut->errorPage( 'upload-proto-error', 'upload-proto-error-text' );
154 # Open temporary file
155 $this->mUploadTempFile
= @fopen
( $this->mUploadTempName
, "wb" );
156 if( $this->mUploadTempFile
=== false ) {
157 # Could not open temporary file to write in
158 $wgOut->errorPage( 'upload-file-error', 'upload-file-error-text');
163 curl_setopt( $ch, CURLOPT_HTTP_VERSION
, 1.0); # Probably not needed, but apparently can work around some bug
164 curl_setopt( $ch, CURLOPT_TIMEOUT
, 10); # 10 seconds timeout
165 curl_setopt( $ch, CURLOPT_LOW_SPEED_LIMIT
, 512); # 0.5KB per second minimum transfer speed
166 curl_setopt( $ch, CURLOPT_URL
, $url);
167 curl_setopt( $ch, CURLOPT_WRITEFUNCTION
, array( $this, 'uploadCurlCallback' ) );
169 $error = curl_errno( $ch ) ?
true : false;
170 $errornum = curl_errno( $ch );
171 // if ( $error ) print curl_error ( $ch ) ; # Debugging output
174 fclose( $this->mUploadTempFile
);
175 unset( $this->mUploadTempFile
);
178 if( wfEmptyMsg( "upload-curl-error$errornum", wfMsg("upload-curl-error$errornum") ) )
179 $wgOut->errorPage( 'upload-misc-error', 'upload-misc-error-text' );
181 $wgOut->errorPage( "upload-curl-error$errornum", "upload-curl-error$errornum-text" );
188 * Callback function for CURL-based web transfer
189 * Write data to file unless we've passed the length limit;
190 * if so, abort immediately.
193 function uploadCurlCallback( $ch, $data ) {
194 global $wgMaxUploadSize;
195 $length = strlen( $data );
196 $this->mUploadTempFileSize +
= $length;
197 if( $this->mUploadTempFileSize
> $wgMaxUploadSize ) {
200 fwrite( $this->mUploadTempFile
, $data );
209 global $wgUser, $wgOut;
210 global $wgEnableUploads, $wgUploadDirectory;
212 # Check uploading enabled
213 if( !$wgEnableUploads ) {
214 $wgOut->showErrorPage( 'uploaddisabled', 'uploaddisabledtext' );
219 if( !$wgUser->isAllowed( 'upload' ) ) {
220 if( !$wgUser->isLoggedIn() ) {
221 $wgOut->showErrorPage( 'uploadnologin', 'uploadnologintext' );
223 $wgOut->permissionRequired( 'upload' );
229 if( $wgUser->isBlocked() ) {
230 $wgOut->blockedPage();
235 $wgOut->readOnlyPage();
239 /** Check if the image directory is writeable, this is a common mistake */
240 if( !is_writeable( $wgUploadDirectory ) ) {
241 $wgOut->addWikiText( wfMsg( 'upload_directory_read_only', $wgUploadDirectory ) );
245 if( $this->mReUpload
) {
246 if( !$this->unsaveUploadedFile() ) {
249 $this->mainUploadForm();
250 } else if( 'submit' == $this->mAction ||
$this->mUpload
) {
251 $this->processUpload();
253 $this->mainUploadForm();
256 $this->cleanupTempFile();
259 /* -------------------------------------------------------------- */
262 * Really do the upload
263 * Checks are made in SpecialUpload::execute()
266 function processUpload() {
267 global $wgUser, $wgOut;
269 if( !wfRunHooks( 'UploadForm:BeforeProcessing', array( &$this ) ) )
271 wfDebug( "Hook 'UploadForm:BeforeProcessing' broke processing the file." );
275 /* Check for PHP error if any, requires php 4.2 or newer */
276 if( $this->mUploadError
== 1/*UPLOAD_ERR_INI_SIZE*/ ) {
277 $this->mainUploadForm( wfMsgHtml( 'largefileserver' ) );
282 * If there was no filename or a zero size given, give up quick.
284 if( trim( $this->mOname
) == '' ||
empty( $this->mUploadSize
) ) {
285 $this->mainUploadForm( wfMsgHtml( 'emptyfile' ) );
289 # Chop off any directories in the given filename
290 if( $this->mDestFile
) {
291 $basename = wfBaseName( $this->mDestFile
);
293 $basename = wfBaseName( $this->mOname
);
297 * We'll want to blacklist against *any* 'extension', and use
298 * only the final one for the whitelist.
300 list( $partname, $ext ) = $this->splitExtensions( $basename );
302 if( count( $ext ) ) {
303 $finalExt = $ext[count( $ext ) - 1];
307 $fullExt = implode( '.', $ext );
309 # If there was more than one "extension", reassemble the base
310 # filename to prevent bogus complaints about length
311 if( count( $ext ) > 1 ) {
312 for( $i = 0; $i < count( $ext ) - 1; $i++
)
313 $partname .= '.' . $ext[$i];
316 if( strlen( $partname ) < 3 ) {
317 $this->mainUploadForm( wfMsgHtml( 'minlength' ) );
322 * Filter out illegal characters, and try to make a legible name
323 * out of it. We'll strip some silently that Title would die on.
325 $filtered = preg_replace ( "/[^".Title
::legalChars()."]|:/", '-', $basename );
326 $nt = Title
::newFromText( $filtered );
327 if( is_null( $nt ) ) {
328 $this->uploadError( wfMsgWikiHtml( 'illegalfilename', htmlspecialchars( $filtered ) ) );
331 $nt =& Title
::makeTitle( NS_IMAGE
, $nt->getDBkey() );
332 $this->mUploadSaveName
= $nt->getDBkey();
335 * If the image is protected, non-sysop users won't be able
336 * to modify it by uploading a new revision.
338 if( !$nt->userCanEdit() ) {
339 return $this->uploadError( wfMsgWikiHtml( 'protectedpage' ) );
343 * In some cases we may forbid overwriting of existing files.
345 $overwrite = $this->checkOverwrite( $this->mUploadSaveName
);
346 if( WikiError
::isError( $overwrite ) ) {
347 return $this->uploadError( $overwrite->toString() );
350 /* Don't allow users to override the blacklist (check file extension) */
351 global $wgStrictFileExtensions;
352 global $wgFileExtensions, $wgFileBlacklist;
353 if( $this->checkFileExtensionList( $ext, $wgFileBlacklist ) ||
354 ($wgStrictFileExtensions &&
355 !$this->checkFileExtension( $finalExt, $wgFileExtensions ) ) ) {
356 return $this->uploadError( wfMsgHtml( 'badfiletype', htmlspecialchars( $fullExt ) ) );
360 * Look at the contents of the file; if we can recognize the
361 * type but it's corrupt or data of the wrong type, we should
362 * probably not accept it.
364 if( !$this->mStashed
) {
365 $this->checkMacBinary();
366 $veri = $this->verify( $this->mUploadTempName
, $finalExt );
368 if( $veri !== true ) { //it's a wiki error...
369 return $this->uploadError( $veri->toString() );
374 * Provide an opportunity for extensions to add futher checks
377 if( !wfRunHooks( 'UploadVerification',
378 array( $this->mUploadSaveName
, $this->mUploadTempName
, &$error ) ) ) {
379 return $this->uploadError( $error );
383 * Check for non-fatal conditions
385 if ( ! $this->mIgnoreWarning
) {
388 global $wgCapitalLinks;
389 if( $wgCapitalLinks ) {
390 $filtered = ucfirst( $filtered );
392 if( $this->mUploadSaveName
!= $filtered ) {
393 $warning .= '<li>'.wfMsgHtml( 'badfilename', htmlspecialchars( $this->mUploadSaveName
) ).'</li>';
396 global $wgCheckFileExtensions;
397 if ( $wgCheckFileExtensions ) {
398 if ( ! $this->checkFileExtension( $finalExt, $wgFileExtensions ) ) {
399 $warning .= '<li>'.wfMsgHtml( 'badfiletype', htmlspecialchars( $fullExt ) ).'</li>';
403 global $wgUploadSizeWarning;
404 if ( $wgUploadSizeWarning && ( $this->mUploadSize
> $wgUploadSizeWarning ) ) {
405 # TODO: Format $wgUploadSizeWarning to something that looks better than the raw byte
406 # value, perhaps add GB,MB and KB suffixes?
407 $warning .= '<li>'.wfMsgHtml( 'largefile', $wgUploadSizeWarning, $this->mUploadSize
).'</li>';
409 if ( $this->mUploadSize
== 0 ) {
410 $warning .= '<li>'.wfMsgHtml( 'emptyfile' ).'</li>';
413 if( $nt->getArticleID() ) {
415 $sk = $wgUser->getSkin();
416 $dlink = $sk->makeKnownLinkObj( $nt );
417 $warning .= '<li>'.wfMsgHtml( 'fileexists', $dlink ).'</li>';
419 # If the file existed before and was deleted, warn the user of this
420 # Don't bother doing so if the image exists now, however
421 $image = new Image( $nt );
422 if( $image->wasDeleted() ) {
423 $skin = $wgUser->getSkin();
424 $ltitle = SpecialPage
::getTitleFor( 'Log' );
425 $llink = $skin->makeKnownLinkObj( $ltitle, wfMsgHtml( 'deletionlog' ), 'type=delete&page=' . $nt->getPrefixedUrl() );
426 $warning .= wfOpenElement( 'li' ) . wfMsgWikiHtml( 'filewasdeleted', $llink ) . wfCloseElement( 'li' );
430 if( $warning != '' ) {
432 * Stash the file in a temporary location; the user can choose
433 * to let it through and we'll complete the upload then.
435 return $this->uploadWarning( $warning );
440 * Try actually saving the thing...
441 * It will show an error form on failure.
443 $hasBeenMunged = !empty( $this->mSessionKey
) ||
$this->mRemoveTempFile
;
444 if( $this->saveUploadedFile( $this->mUploadSaveName
,
445 $this->mUploadTempName
,
448 * Update the upload log and create the description page
449 * if it's a new file.
451 $img = Image
::newFromName( $this->mUploadSaveName
);
452 $success = $img->recordUpload( $this->mUploadOldVersion
,
453 $this->mUploadDescription
,
455 $this->mUploadCopyStatus
,
456 $this->mUploadSource
,
460 $this->showSuccess();
461 wfRunHooks( 'UploadComplete', array( &$img ) );
463 // Image::recordUpload() fails if the image went missing, which is
464 // unlikely, hence the lack of a specialised message
465 $wgOut->showFileNotFoundError( $this->mUploadSaveName
);
471 * Move the uploaded file from its temporary location to the final
472 * destination. If a previous version of the file exists, move
473 * it into the archive subdirectory.
475 * @todo If the later save fails, we may have disappeared the original file.
477 * @param string $saveName
478 * @param string $tempName full path to the temporary file
479 * @param bool $useRename if true, doesn't check that the source file
480 * is a PHP-managed upload temporary
482 function saveUploadedFile( $saveName, $tempName, $useRename = false ) {
483 global $wgOut, $wgAllowCopyUploads;
485 if ( !$useRename AND $wgAllowCopyUploads AND $this->mSourceType
== 'web' ) $useRename = true;
487 $fname= "SpecialUpload::saveUploadedFile";
489 $dest = wfImageDir( $saveName );
490 $archive = wfImageArchiveDir( $saveName );
491 if ( !is_dir( $dest ) ) wfMkdirParents( $dest );
492 if ( !is_dir( $archive ) ) wfMkdirParents( $archive );
494 $this->mSavedFile
= "{$dest}/{$saveName}";
496 if( is_file( $this->mSavedFile
) ) {
497 $this->mUploadOldVersion
= gmdate( 'YmdHis' ) . "!{$saveName}";
498 wfSuppressWarnings();
499 $success = rename( $this->mSavedFile
, "${archive}/{$this->mUploadOldVersion}" );
503 $wgOut->showFileRenameError( $this->mSavedFile
,
504 "${archive}/{$this->mUploadOldVersion}" );
507 else wfDebug("$fname: moved file ".$this->mSavedFile
." to ${archive}/{$this->mUploadOldVersion}\n");
510 $this->mUploadOldVersion
= '';
513 wfSuppressWarnings();
514 $success = $useRename
515 ?
rename( $tempName, $this->mSavedFile
)
516 : move_uploaded_file( $tempName, $this->mSavedFile
);
520 $wgOut->showFileCopyError( $tempName, $this->mSavedFile
);
523 wfDebug("$fname: wrote tempfile $tempName to ".$this->mSavedFile
."\n");
526 chmod( $this->mSavedFile
, 0644 );
531 * Stash a file in a temporary directory for later processing
532 * after the user has confirmed it.
534 * If the user doesn't explicitly cancel or accept, these files
535 * can accumulate in the temp directory.
537 * @param string $saveName - the destination filename
538 * @param string $tempName - the source temporary file to save
539 * @return string - full path the stashed file, or false on failure
542 function saveTempUploadedFile( $saveName, $tempName ) {
544 $archive = wfImageArchiveDir( $saveName, 'temp' );
545 if ( !is_dir ( $archive ) ) wfMkdirParents( $archive );
546 $stash = $archive . '/' . gmdate( "YmdHis" ) . '!' . $saveName;
548 $success = $this->mRemoveTempFile
549 ?
rename( $tempName, $stash )
550 : move_uploaded_file( $tempName, $stash );
552 $wgOut->showFileCopyError( $tempName, $stash );
560 * Stash a file in a temporary directory for later processing,
561 * and save the necessary descriptive info into the session.
562 * Returns a key value which will be passed through a form
563 * to pick up the path info on a later invocation.
568 function stashSession() {
569 $stash = $this->saveTempUploadedFile(
570 $this->mUploadSaveName
, $this->mUploadTempName
);
573 # Couldn't save the file.
577 $key = mt_rand( 0, 0x7fffffff );
578 $_SESSION['wsUploadData'][$key] = array(
579 'mUploadTempName' => $stash,
580 'mUploadSize' => $this->mUploadSize
,
581 'mOname' => $this->mOname
);
586 * Remove a temporarily kept file stashed by saveTempUploadedFile().
590 function unsaveUploadedFile() {
592 wfSuppressWarnings();
593 $success = unlink( $this->mUploadTempName
);
596 $wgOut->showFileDeleteError( $this->mUploadTempName
);
603 /* -------------------------------------------------------------- */
606 * Show some text and linkage on successful upload.
609 function showSuccess() {
610 global $wgUser, $wgOut, $wgContLang;
612 $sk = $wgUser->getSkin();
613 $ilink = $sk->makeMediaLink( $this->mUploadSaveName
, Image
::imageUrl( $this->mUploadSaveName
) );
614 $dname = $wgContLang->getNsText( NS_IMAGE
) . ':'.$this->mUploadSaveName
;
615 $dlink = $sk->makeKnownLink( $dname, $dname );
617 $wgOut->addHTML( '<h2>' . wfMsgHtml( 'successfulupload' ) . "</h2>\n" );
618 $text = wfMsgWikiHtml( 'fileuploaded', $ilink, $dlink );
619 $wgOut->addHTML( $text );
620 $wgOut->returnToMain( false );
624 * @param string $error as HTML
627 function uploadError( $error ) {
629 $wgOut->addHTML( "<h2>" . wfMsgHtml( 'uploadwarning' ) . "</h2>\n" );
630 $wgOut->addHTML( "<span class='error'>{$error}</span>\n" );
634 * There's something wrong with this file, not enough to reject it
635 * totally but we require manual intervention to save it for real.
636 * Stash it away, then present a form asking to confirm or cancel.
638 * @param string $warning as HTML
641 function uploadWarning( $warning ) {
643 global $wgUseCopyrightUpload;
645 $this->mSessionKey
= $this->stashSession();
646 if( !$this->mSessionKey
) {
647 # Couldn't save file; an error has been displayed so let's go.
651 $wgOut->addHTML( "<h2>" . wfMsgHtml( 'uploadwarning' ) . "</h2>\n" );
652 $wgOut->addHTML( "<ul class='warning'>{$warning}</ul><br />\n" );
654 $save = wfMsgHtml( 'savefile' );
655 $reupload = wfMsgHtml( 'reupload' );
656 $iw = wfMsgWikiHtml( 'ignorewarning' );
657 $reup = wfMsgWikiHtml( 'reuploaddesc' );
658 $titleObj = SpecialPage
::getTitleFor( 'Upload' );
659 $action = $titleObj->escapeLocalURL( 'action=submit' );
661 if ( $wgUseCopyrightUpload )
664 <input type='hidden' name='wpUploadCopyStatus' value=\"" . htmlspecialchars( $this->mUploadCopyStatus
) . "\" />
665 <input type='hidden' name='wpUploadSource' value=\"" . htmlspecialchars( $this->mUploadSource
) . "\" />
672 <form id='uploadwarning' method='post' enctype='multipart/form-data' action='$action'>
673 <input type='hidden' name='wpIgnoreWarning' value='1' />
674 <input type='hidden' name='wpSessionKey' value=\"" . htmlspecialchars( $this->mSessionKey
) . "\" />
675 <input type='hidden' name='wpUploadDescription' value=\"" . htmlspecialchars( $this->mUploadDescription
) . "\" />
676 <input type='hidden' name='wpLicense' value=\"" . htmlspecialchars( $this->mLicense
) . "\" />
677 <input type='hidden' name='wpDestFile' value=\"" . htmlspecialchars( $this->mDestFile
) . "\" />
678 <input type='hidden' name='wpWatchthis' value=\"" . htmlspecialchars( intval( $this->mWatchthis
) ) . "\" />
684 <input tabindex='2' type='submit' name='wpUpload' value=\"$save\" />
686 <td align='left'>$iw</td>
690 <input tabindex='2' type='submit' name='wpReUpload' value=\"{$reupload}\" />
692 <td align='left'>$reup</td>
695 </table></form>\n" );
699 * Displays the main upload form, optionally with a highlighted
700 * error message up at the top.
702 * @param string $msg as HTML
705 function mainUploadForm( $msg='' ) {
706 global $wgOut, $wgUser;
707 global $wgUseCopyrightUpload;
708 global $wgRequest, $wgAllowCopyUploads;
710 if( !wfRunHooks( 'UploadForm:initial', array( &$this ) ) )
712 wfDebug( "Hook 'UploadForm:initial' broke output of the upload form" );
716 $cols = intval($wgUser->getOption( 'cols' ));
717 $ew = $wgUser->getOption( 'editwidth' );
718 if ( $ew ) $ew = " style=\"width:100%\"";
722 $sub = wfMsgHtml( 'uploaderror' );
723 $wgOut->addHTML( "<h2>{$sub}</h2>\n" .
724 "<span class='error'>{$msg}</span>\n" );
726 $wgOut->addHTML( '<div id="uploadtext">' );
727 $wgOut->addWikiText( wfMsg( 'uploadtext' ) );
728 $wgOut->addHTML( '</div>' );
730 $sourcefilename = wfMsgHtml( 'sourcefilename' );
731 $destfilename = wfMsgHtml( 'destfilename' );
732 $summary = wfMsgWikiHtml( 'fileuploadsummary' );
734 $licenses = new Licenses();
735 $license = wfMsgHtml( 'license' );
736 $nolicense = wfMsgHtml( 'nolicense' );
737 $licenseshtml = $licenses->getHtml();
739 $ulb = wfMsgHtml( 'uploadbtn' );
742 $titleObj = SpecialPage
::getTitleFor( 'Upload' );
743 $action = $titleObj->escapeLocalURL();
745 $encDestFile = htmlspecialchars( $this->mDestFile
);
748 ( $wgUser->getOption( 'watchdefault' ) ||
749 ( $wgUser->getOption( 'watchcreations' ) && $this->mDestFile
== '' ) )
750 ?
'checked="checked"'
753 // Prepare form for upload or upload/copy
754 if( $wgAllowCopyUploads && $wgUser->isAllowed( 'upload_by_url' ) ) {
756 "<input type='radio' id='wpSourceTypeFile' name='wpSourceType' value='file' onchange='toggle_element_activation(\"wpUploadFileURL\",\"wpUploadFile\")' checked />" .
757 "<input tabindex='1' type='file' name='wpUploadFile' id='wpUploadFile' onfocus='toggle_element_activation(\"wpUploadFileURL\",\"wpUploadFile\");toggle_element_check(\"wpSourceTypeFile\",\"wpSourceTypeURL\")'" .
758 ($this->mDestFile?
"":"onchange='fillDestFilename(\"wpUploadFile\")' ") . "size='40' />" .
759 wfMsgHTML( 'upload_source_file' ) . "<br/>" .
760 "<input type='radio' id='wpSourceTypeURL' name='wpSourceType' value='web' onchange='toggle_element_activation(\"wpUploadFile\",\"wpUploadFileURL\")' />" .
761 "<input tabindex='1' type='text' name='wpUploadFileURL' id='wpUploadFileURL' onfocus='toggle_element_activation(\"wpUploadFile\",\"wpUploadFileURL\");toggle_element_check(\"wpSourceTypeURL\",\"wpSourceTypeFile\")'" .
762 ($this->mDestFile?
"":"onchange='fillDestFilename(\"wpUploadFileURL\")' ") . "size='40' DISABLED />" .
763 wfMsgHtml( 'upload_source_url' ) ;
766 "<input tabindex='1' type='file' name='wpUploadFile' id='wpUploadFile' " .
767 ($this->mDestFile?
"":"onchange='fillDestFilename(\"wpUploadFile\")' ") .
769 "<input type='hidden' name='wpSourceType' value='file' />" ;
773 <form id='upload' method='post' enctype='multipart/form-data' action=\"$action\">
776 {$this->uploadFormTextTop}
777 <td align='right' valign='top'><label for='wpUploadFile'>{$sourcefilename}:</label></td>
783 <td align='right'><label for='wpDestFile'>{$destfilename}:</label></td>
785 <input tabindex='2' type='text' name='wpDestFile' id='wpDestFile' size='40' value=\"$encDestFile\" />
789 <td align='right'><label for='wpUploadDescription'>{$summary}</label></td>
791 <textarea tabindex='3' name='wpUploadDescription' id='wpUploadDescription' rows='6' cols='{$cols}'{$ew}>" . htmlspecialchars( $this->mUploadDescription
) . "</textarea>
792 {$this->uploadFormTextAfterSummary}
797 if ( $licenseshtml != '' ) {
800 <td align='right'><label for='wpLicense'>$license:</label></td>
802 <script type='text/javascript' src=\"$wgStylePath/common/upload.js\"></script>
803 <select name='wpLicense' id='wpLicense' tabindex='4'
804 onchange='licenseSelectorCheck()'>
805 <option value=''>$nolicense</option>
814 if ( $wgUseCopyrightUpload ) {
815 $filestatus = wfMsgHtml ( 'filestatus' );
816 $copystatus = htmlspecialchars( $this->mUploadCopyStatus
);
817 $filesource = wfMsgHtml ( 'filesource' );
818 $uploadsource = htmlspecialchars( $this->mUploadSource
);
821 <td align='right' nowrap='nowrap'><label for='wpUploadCopyStatus'>$filestatus:</label></td>
822 <td><input tabindex='5' type='text' name='wpUploadCopyStatus' id='wpUploadCopyStatus' value=\"$copystatus\" size='40' /></td>
825 <td align='right'><label for='wpUploadCopyStatus'>$filesource:</label></td>
826 <td><input tabindex='6' type='text' name='wpUploadSource' id='wpUploadCopyStatus' value=\"$uploadsource\" size='40' /></td>
836 <input tabindex='7' type='checkbox' name='wpWatchthis' id='wpWatchthis' $watchChecked value='true' />
837 <label for='wpWatchthis'>" . wfMsgHtml( 'watchthisupload' ) . "</label>
838 <input tabindex='8' type='checkbox' name='wpIgnoreWarning' id='wpIgnoreWarning' value='true' />
839 <label for='wpIgnoreWarning'>" . wfMsgHtml( 'ignorewarnings' ) . "</label>
847 <td align='left'><input tabindex='9' type='submit' name='wpUpload' value=\"{$ulb}\" /></td>
854 $wgOut->addWikiText( wfMsgForContent( 'edittools' ) );
863 /* -------------------------------------------------------------- */
866 * Split a file into a base name and all dot-delimited 'extensions'
867 * on the end. Some web server configurations will fall back to
868 * earlier pseudo-'extensions' to determine type and execute
869 * scripts, so the blacklist needs to check them all.
873 function splitExtensions( $filename ) {
874 $bits = explode( '.', $filename );
875 $basename = array_shift( $bits );
876 return array( $basename, $bits );
880 * Perform case-insensitive match against a list of file extensions.
881 * Returns true if the extension is in the list.
887 function checkFileExtension( $ext, $list ) {
888 return in_array( strtolower( $ext ), $list );
892 * Perform case-insensitive match against a list of file extensions.
893 * Returns true if any of the extensions are in the list.
899 function checkFileExtensionList( $ext, $list ) {
900 foreach( $ext as $e ) {
901 if( in_array( strtolower( $e ), $list ) ) {
909 * Verifies that it's ok to include the uploaded file
911 * @param string $tmpfile the full path of the temporary file to verify
912 * @param string $extension The filename extension that the file is to be served with
913 * @return mixed true of the file is verified, a WikiError object otherwise.
915 function verify( $tmpfile, $extension ) {
916 #magically determine mime type
917 $magic=& MimeMagic
::singleton();
918 $mime= $magic->guessMimeType($tmpfile,false);
920 $fname= "SpecialUpload::verify";
922 #check mime type, if desired
923 global $wgVerifyMimeType;
924 if ($wgVerifyMimeType) {
926 #check mime type against file extension
927 if( !$this->verifyExtension( $mime, $extension ) ) {
928 return new WikiErrorMsg( 'uploadcorrupt' );
931 #check mime type blacklist
932 global $wgMimeTypeBlacklist;
933 if( isset($wgMimeTypeBlacklist) && !is_null($wgMimeTypeBlacklist)
934 && $this->checkFileExtension( $mime, $wgMimeTypeBlacklist ) ) {
935 return new WikiErrorMsg( 'badfiletype', htmlspecialchars( $mime ) );
939 #check for htmlish code and javascript
940 if( $this->detectScript ( $tmpfile, $mime, $extension ) ) {
941 return new WikiErrorMsg( 'uploadscripted' );
945 * Scan the uploaded file for viruses
947 $virus= $this->detectVirus($tmpfile);
949 return new WikiErrorMsg( 'uploadvirus', htmlspecialchars($virus) );
952 wfDebug( "$fname: all clear; passing.\n" );
957 * Checks if the mime type of the uploaded file matches the file extension.
959 * @param string $mime the mime type of the uploaded file
960 * @param string $extension The filename extension that the file is to be served with
963 function verifyExtension( $mime, $extension ) {
964 $fname = 'SpecialUpload::verifyExtension';
966 $magic =& MimeMagic
::singleton();
968 if ( ! $mime ||
$mime == 'unknown' ||
$mime == 'unknown/unknown' )
969 if ( ! $magic->isRecognizableExtension( $extension ) ) {
970 wfDebug( "$fname: passing file with unknown detected mime type; unrecognized extension '$extension', can't verify\n" );
973 wfDebug( "$fname: rejecting file with unknown detected mime type; recognized extension '$extension', so probably invalid file\n" );
977 $match= $magic->isMatchingExtension($extension,$mime);
980 wfDebug( "$fname: no file extension known for mime type $mime, passing file\n" );
982 } elseif ($match===true) {
983 wfDebug( "$fname: mime type $mime matches extension $extension, passing file\n" );
985 #TODO: if it's a bitmap, make sure PHP or ImageMagic resp. can handle it!
989 wfDebug( "$fname: mime type $mime mismatches file extension $extension, rejecting file\n" );
994 /** Heuristig for detecting files that *could* contain JavaScript instructions or
995 * things that may look like HTML to a browser and are thus
996 * potentially harmful. The present implementation will produce false positives in some situations.
998 * @param string $file Pathname to the temporary upload file
999 * @param string $mime The mime type of the file
1000 * @param string $extension The extension of the file
1001 * @return bool true if the file contains something looking like embedded scripts
1003 function detectScript($file, $mime, $extension) {
1004 global $wgAllowTitlesInSVG;
1006 #ugly hack: for text files, always look at the entire file.
1007 #For binarie field, just check the first K.
1009 if (strpos($mime,'text/')===0) $chunk = file_get_contents( $file );
1011 $fp = fopen( $file, 'rb' );
1012 $chunk = fread( $fp, 1024 );
1016 $chunk= strtolower( $chunk );
1018 if (!$chunk) return false;
1020 #decode from UTF-16 if needed (could be used for obfuscation).
1021 if (substr($chunk,0,2)=="\xfe\xff") $enc= "UTF-16BE";
1022 elseif (substr($chunk,0,2)=="\xff\xfe") $enc= "UTF-16LE";
1025 if ($enc) $chunk= iconv($enc,"ASCII//IGNORE",$chunk);
1027 $chunk= trim($chunk);
1029 #FIXME: convert from UTF-16 if necessarry!
1031 wfDebug("SpecialUpload::detectScript: checking for embedded scripts and HTML stuff\n");
1033 #check for HTML doctype
1034 if (eregi("<!DOCTYPE *X?HTML",$chunk)) return true;
1037 * Internet Explorer for Windows performs some really stupid file type
1038 * autodetection which can cause it to interpret valid image files as HTML
1039 * and potentially execute JavaScript, creating a cross-site scripting
1042 * Apple's Safari browser also performs some unsafe file type autodetection
1043 * which can cause legitimate files to be interpreted as HTML if the
1044 * web server is not correctly configured to send the right content-type
1045 * (or if you're really uploading plain text and octet streams!)
1047 * Returns true if IE is likely to mistake the given file for HTML.
1048 * Also returns true if Safari would mistake the given file for HTML
1049 * when served with a generic content-type.
1055 '<html', #also in safari
1058 '<script', #also in safari
1061 if( ! $wgAllowTitlesInSVG && $extension !== 'svg' && $mime !== 'image/svg' ) {
1065 foreach( $tags as $tag ) {
1066 if( false !== strpos( $chunk, $tag ) ) {
1072 * look for javascript
1075 #resolve entity-refs to look at attributes. may be harsh on big files... cache result?
1076 $chunk = Sanitizer
::decodeCharReferences( $chunk );
1078 #look for script-types
1079 if (preg_match('!type\s*=\s*[\'"]?\s*(\w*/)?(ecma|java)!sim',$chunk)) return true;
1081 #look for html-style script-urls
1082 if (preg_match('!(href|src|data)\s*=\s*[\'"]?\s*(ecma|java)script:!sim',$chunk)) return true;
1084 #look for css-style script-urls
1085 if (preg_match('!url\s*\(\s*[\'"]?\s*(ecma|java)script:!sim',$chunk)) return true;
1087 wfDebug("SpecialUpload::detectScript: no scripts found\n");
1091 /** Generic wrapper function for a virus scanner program.
1092 * This relies on the $wgAntivirus and $wgAntivirusSetup variables.
1093 * $wgAntivirusRequired may be used to deny upload if the scan fails.
1095 * @param string $file Pathname to the temporary upload file
1096 * @return mixed false if not virus is found, NULL if the scan fails or is disabled,
1097 * or a string containing feedback from the virus scanner if a virus was found.
1098 * If textual feedback is missing but a virus was found, this function returns true.
1100 function detectVirus($file) {
1101 global $wgAntivirus, $wgAntivirusSetup, $wgAntivirusRequired, $wgOut;
1103 $fname= "SpecialUpload::detectVirus";
1105 if (!$wgAntivirus) { #disabled?
1106 wfDebug("$fname: virus scanner disabled\n");
1111 if (!$wgAntivirusSetup[$wgAntivirus]) {
1112 wfDebug("$fname: unknown virus scanner: $wgAntivirus\n");
1114 $wgOut->addHTML( "<div class='error'>Bad configuration: unknown virus scanner: <i>$wgAntivirus</i></div>\n" ); #LOCALIZE
1116 return "unknown antivirus: $wgAntivirus";
1119 #look up scanner configuration
1120 $virus_scanner= $wgAntivirusSetup[$wgAntivirus]["command"]; #command pattern
1121 $virus_scanner_codes= $wgAntivirusSetup[$wgAntivirus]["codemap"]; #exit-code map
1122 $msg_pattern= $wgAntivirusSetup[$wgAntivirus]["messagepattern"]; #message pattern
1124 $scanner= $virus_scanner; #copy, so we can resolve the pattern
1126 if (strpos($scanner,"%f")===false) $scanner.= " ".wfEscapeShellArg($file); #simple pattern: append file to scan
1127 else $scanner= str_replace("%f",wfEscapeShellArg($file),$scanner); #complex pattern: replace "%f" with file to scan
1129 wfDebug("$fname: running virus scan: $scanner \n");
1131 #execute virus scanner
1134 #NOTE: there's a 50 line workaround to make stderr redirection work on windows, too.
1135 # that does not seem to be worth the pain.
1136 # Ask me (Duesentrieb) about it if it's ever needed.
1138 if (wfIsWindows()) exec("$scanner",$output,$code);
1139 else exec("$scanner 2>&1",$output,$code);
1141 $exit_code= $code; #remember for user feedback
1143 if ($virus_scanner_codes) { #map exit code to AV_xxx constants.
1144 if (isset($virus_scanner_codes[$code])) {
1145 $code= $virus_scanner_codes[$code]; # explicit mapping
1146 } else if (isset($virus_scanner_codes["*"])) {
1147 $code= $virus_scanner_codes["*"]; # fallback mapping
1151 if ($code===AV_SCAN_FAILED
) { #scan failed (code was mapped to false by $virus_scanner_codes)
1152 wfDebug("$fname: failed to scan $file (code $exit_code).\n");
1154 if ($wgAntivirusRequired) { return "scan failed (code $exit_code)"; }
1155 else { return NULL; }
1157 else if ($code===AV_SCAN_ABORTED
) { #scan failed because filetype is unknown (probably imune)
1158 wfDebug("$fname: unsupported file type $file (code $exit_code).\n");
1161 else if ($code===AV_NO_VIRUS
) {
1162 wfDebug("$fname: file passed virus scan.\n");
1163 return false; #no virus found
1166 $output= join("\n",$output);
1167 $output= trim($output);
1169 if (!$output) $output= true; #if there's no output, return true
1170 else if ($msg_pattern) {
1172 if (preg_match($msg_pattern,$output,$groups)) {
1173 if ($groups[1]) $output= $groups[1];
1177 wfDebug("$fname: FOUND VIRUS! scanner feedback: $output");
1183 * Check if the temporary file is MacBinary-encoded, as some uploads
1184 * from Internet Explorer on Mac OS Classic and Mac OS X will be.
1185 * If so, the data fork will be extracted to a second temporary file,
1186 * which will then be checked for validity and either kept or discarded.
1190 function checkMacBinary() {
1191 $macbin = new MacBinary( $this->mUploadTempName
);
1192 if( $macbin->isValid() ) {
1193 $dataFile = tempnam( wfTempDir(), "WikiMacBinary" );
1194 $dataHandle = fopen( $dataFile, 'wb' );
1196 wfDebug( "SpecialUpload::checkMacBinary: Extracting MacBinary data fork to $dataFile\n" );
1197 $macbin->extractData( $dataHandle );
1199 $this->mUploadTempName
= $dataFile;
1200 $this->mUploadSize
= $macbin->dataForkLength();
1202 // We'll have to manually remove the new file if it's not kept.
1203 $this->mRemoveTempFile
= true;
1209 * If we've modified the upload file we need to manually remove it
1210 * on exit to clean up.
1213 function cleanupTempFile() {
1214 if( $this->mRemoveTempFile
&& file_exists( $this->mUploadTempName
) ) {
1215 wfDebug( "SpecialUpload::cleanupTempFile: Removing temporary file $this->mUploadTempName\n" );
1216 unlink( $this->mUploadTempName
);
1221 * Check if there's an overwrite conflict and, if so, if restrictions
1222 * forbid this user from performing the upload.
1224 * @return mixed true on success, WikiError on failure
1227 function checkOverwrite( $name ) {
1228 $img = Image
::newFromName( $name );
1229 if( is_null( $img ) ) {
1230 // Uh... this shouldn't happen ;)
1231 // But if it does, fall through to previous behavior
1236 if( $img->exists() ) {
1237 global $wgUser, $wgOut;
1238 if( $img->isLocal() ) {
1239 if( !$wgUser->isAllowed( 'reupload' ) ) {
1240 $error = 'fileexists-forbidden';
1243 if( !$wgUser->isAllowed( 'reupload' ) ||
1244 !$wgUser->isAllowed( 'reupload-shared' ) ) {
1245 $error = "fileexists-shared-forbidden";
1251 $errorText = wfMsg( $error, wfEscapeWikiText( $img->getName() ) );
1252 return new WikiError( $wgOut->parse( $errorText ) );
1255 // Rockin', go ahead and upload