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' );
50 if( !$request->wasPosted() ) {
51 # GET requests just give the main form; no data except wpDestfile.
55 # Placeholders for text injection by hooks (empty per default)
56 $this->uploadFormTextTop
= "";
57 $this->uploadFormTextAfterSummary
= "";
59 $this->mReUpload
= $request->getCheck( 'wpReUpload' );
60 $this->mUploadClicked
= $request->getCheck( 'wpUpload' );
62 $this->mComment
= $request->getText( 'wpUploadDescription' );
63 $this->mLicense
= $request->getText( 'wpLicense' );
64 $this->mCopyrightStatus
= $request->getText( 'wpUploadCopyStatus' );
65 $this->mCopyrightSource
= $request->getText( 'wpUploadSource' );
66 $this->mWatchthis
= $request->getBool( 'wpWatchthis' );
67 $this->mSourceType
= $request->getText( 'wpSourceType' );
68 $this->mDestWarningAck
= $request->getText( 'wpDestFileWarningAck' );
70 $this->mAction
= $request->getVal( 'action' );
72 $this->mSessionKey
= $request->getInt( 'wpSessionKey' );
73 if( !empty( $this->mSessionKey
) &&
74 isset( $_SESSION['wsUploadData'][$this->mSessionKey
]['version'] ) &&
75 $_SESSION['wsUploadData'][$this->mSessionKey
]['version'] == self
::SESSION_VERSION
) {
77 * Confirming a temporarily stashed upload.
78 * We don't want path names to be forged, so we keep
79 * them in the session on the server and just give
80 * an opaque key to the user agent.
82 $data = $_SESSION['wsUploadData'][$this->mSessionKey
];
83 $this->mTempPath
= $data['mTempPath'];
84 $this->mFileSize
= $data['mFileSize'];
85 $this->mSrcName
= $data['mSrcName'];
86 $this->mFileProps
= $data['mFileProps'];
87 $this->mCurlError
= 0/*UPLOAD_ERR_OK*/;
88 $this->mStashed
= true;
89 $this->mRemoveTempFile
= false;
92 *Check for a newly uploaded file.
94 if( $wgAllowCopyUploads && $this->mSourceType
== 'web' ) {
95 $this->initializeFromUrl( $request );
97 $this->initializeFromUpload( $request );
103 * Initialize the uploaded file from PHP data
106 function initializeFromUpload( $request ) {
107 $this->mTempPath
= $request->getFileTempName( 'wpUploadFile' );
108 $this->mFileSize
= $request->getFileSize( 'wpUploadFile' );
109 $this->mSrcName
= $request->getFileName( 'wpUploadFile' );
110 $this->mCurlError
= $request->getUploadError( 'wpUploadFile' );
111 $this->mSessionKey
= false;
112 $this->mStashed
= false;
113 $this->mRemoveTempFile
= false; // PHP will handle this
117 * Copy a web file to a temporary file
120 function initializeFromUrl( $request ) {
121 global $wgTmpDirectory;
122 $url = $request->getText( 'wpUploadFileURL' );
123 $local_file = tempnam( $wgTmpDirectory, 'WEBUPLOAD' );
125 $this->mTempPath
= $local_file;
126 $this->mFileSize
= 0; # Will be set by curlCopy
127 $this->mCurlError
= $this->curlCopy( $url, $local_file );
128 $this->mSrcName
= array_pop( explode( '/', $url ) );
129 $this->mSessionKey
= false;
130 $this->mStashed
= false;
132 // PHP won't auto-cleanup the file
133 $this->mRemoveTempFile
= file_exists( $local_file );
138 * Returns true if there was an error, false otherwise
140 private function curlCopy( $url, $dest ) {
141 global $wgUser, $wgOut;
143 if( !$wgUser->isAllowed( 'upload_by_url' ) ) {
144 $wgOut->permissionRequired( 'upload_by_url' );
148 # Maybe remove some pasting blanks :-)
150 if( stripos($url, 'http://') !== 0 && stripos($url, 'ftp://') !== 0 ) {
151 # Only HTTP or FTP URLs
152 $wgOut->errorPage( 'upload-proto-error', 'upload-proto-error-text' );
156 # Open temporary file
157 $this->mCurlDestHandle
= @fopen
( $this->mTempPath
, "wb" );
158 if( $this->mCurlDestHandle
=== false ) {
159 # Could not open temporary file to write in
160 $wgOut->errorPage( 'upload-file-error', 'upload-file-error-text');
165 curl_setopt( $ch, CURLOPT_HTTP_VERSION
, 1.0); # Probably not needed, but apparently can work around some bug
166 curl_setopt( $ch, CURLOPT_TIMEOUT
, 10); # 10 seconds timeout
167 curl_setopt( $ch, CURLOPT_LOW_SPEED_LIMIT
, 512); # 0.5KB per second minimum transfer speed
168 curl_setopt( $ch, CURLOPT_URL
, $url);
169 curl_setopt( $ch, CURLOPT_WRITEFUNCTION
, array( $this, 'uploadCurlCallback' ) );
171 $error = curl_errno( $ch ) ?
true : false;
172 $errornum = curl_errno( $ch );
173 // if ( $error ) print curl_error ( $ch ) ; # Debugging output
176 fclose( $this->mCurlDestHandle
);
177 unset( $this->mCurlDestHandle
);
180 if( wfEmptyMsg( "upload-curl-error$errornum", wfMsg("upload-curl-error$errornum") ) )
181 $wgOut->errorPage( 'upload-misc-error', 'upload-misc-error-text' );
183 $wgOut->errorPage( "upload-curl-error$errornum", "upload-curl-error$errornum-text" );
190 * Callback function for CURL-based web transfer
191 * Write data to file unless we've passed the length limit;
192 * if so, abort immediately.
195 function uploadCurlCallback( $ch, $data ) {
196 global $wgMaxUploadSize;
197 $length = strlen( $data );
198 $this->mFileSize +
= $length;
199 if( $this->mFileSize
> $wgMaxUploadSize ) {
202 fwrite( $this->mCurlDestHandle
, $data );
211 global $wgUser, $wgOut;
212 global $wgEnableUploads;
214 # Check uploading enabled
215 if( !$wgEnableUploads ) {
216 $wgOut->showErrorPage( 'uploaddisabled', 'uploaddisabledtext', array( $this->mDesiredDestName
) );
221 if( !$wgUser->isAllowed( 'upload' ) ) {
222 if( !$wgUser->isLoggedIn() ) {
223 $wgOut->showErrorPage( 'uploadnologin', 'uploadnologintext' );
225 $wgOut->permissionRequired( 'upload' );
231 if( $wgUser->isBlocked() ) {
232 $wgOut->blockedPage();
237 $wgOut->readOnlyPage();
241 if( $this->mReUpload
) {
242 if( !$this->unsaveUploadedFile() ) {
245 $this->mainUploadForm();
246 } else if( 'submit' == $this->mAction ||
$this->mUploadClicked
) {
247 $this->processUpload();
249 $this->mainUploadForm();
252 $this->cleanupTempFile();
255 /* -------------------------------------------------------------- */
258 * Really do the upload
259 * Checks are made in SpecialUpload::execute()
262 function processUpload() {
263 global $wgUser, $wgOut;
265 if( !wfRunHooks( 'UploadForm:BeforeProcessing', array( &$this ) ) )
267 wfDebug( "Hook 'UploadForm:BeforeProcessing' broke processing the file." );
271 /* Check for PHP error if any, requires php 4.2 or newer */
272 if( $this->mCurlError
== 1/*UPLOAD_ERR_INI_SIZE*/ ) {
273 $this->mainUploadForm( wfMsgHtml( 'largefileserver' ) );
278 * If there was no filename or a zero size given, give up quick.
280 if( trim( $this->mSrcName
) == '' ||
empty( $this->mFileSize
) ) {
281 $this->mainUploadForm( wfMsgHtml( 'emptyfile' ) );
285 # Chop off any directories in the given filename
286 if( $this->mDesiredDestName
) {
287 $basename = $this->mDesiredDestName
;
289 $basename = $this->mSrcName
;
291 $filtered = wfBaseName( $basename );
294 * We'll want to blacklist against *any* 'extension', and use
295 * only the final one for the whitelist.
297 list( $partname, $ext ) = $this->splitExtensions( $filtered );
299 if( count( $ext ) ) {
300 $finalExt = $ext[count( $ext ) - 1];
305 # If there was more than one "extension", reassemble the base
306 # filename to prevent bogus complaints about length
307 if( count( $ext ) > 1 ) {
308 for( $i = 0; $i < count( $ext ) - 1; $i++
)
309 $partname .= '.' . $ext[$i];
312 if( strlen( $partname ) < 1 ) {
313 $this->mainUploadForm( wfMsgHtml( 'minlength1' ) );
318 * Filter out illegal characters, and try to make a legible name
319 * out of it. We'll strip some silently that Title would die on.
321 $filtered = preg_replace ( "/[^".Title
::legalChars()."]|:/", '-', $filtered );
322 $nt = Title
::makeTitleSafe( NS_IMAGE
, $filtered );
323 if( is_null( $nt ) ) {
324 $this->uploadError( wfMsgWikiHtml( 'illegalfilename', htmlspecialchars( $filtered ) ) );
327 $this->mLocalFile
= wfLocalFile( $nt );
328 $this->mDestName
= $this->mLocalFile
->getName();
331 * If the image is protected, non-sysop users won't be able
332 * to modify it by uploading a new revision.
334 if( !$nt->userCan( 'edit' ) ) {
335 return $this->uploadError( wfMsgWikiHtml( 'protectedpage' ) );
339 * In some cases we may forbid overwriting of existing files.
341 $overwrite = $this->checkOverwrite( $this->mDestName
);
342 if( WikiError
::isError( $overwrite ) ) {
343 return $this->uploadError( $overwrite->toString() );
346 /* Don't allow users to override the blacklist (check file extension) */
347 global $wgStrictFileExtensions;
348 global $wgFileExtensions, $wgFileBlacklist;
349 if ($finalExt == '') {
350 return $this->uploadError( wfMsgExt( 'filetype-missing', array ( 'parseinline' ) ) );
351 } elseif ( $this->checkFileExtensionList( $ext, $wgFileBlacklist ) ||
352 ($wgStrictFileExtensions && !$this->checkFileExtension( $finalExt, $wgFileExtensions ) ) ) {
353 return $this->uploadError( wfMsgExt( 'filetype-badtype', array ( 'parseinline' ),
354 htmlspecialchars( $finalExt ), implode ( ', ', $wgFileExtensions ) ) );
358 * Look at the contents of the file; if we can recognize the
359 * type but it's corrupt or data of the wrong type, we should
360 * probably not accept it.
362 if( !$this->mStashed
) {
363 $this->mFileProps
= File
::getPropsFromPath( $this->mTempPath
, $finalExt );
364 $this->checkMacBinary();
365 $veri = $this->verify( $this->mTempPath
, $finalExt );
367 if( $veri !== true ) { //it's a wiki error...
368 return $this->uploadError( $veri->toString() );
372 * Provide an opportunity for extensions to add further checks
375 if( !wfRunHooks( 'UploadVerification',
376 array( $this->mDestName
, $this->mTempPath
, &$error ) ) ) {
377 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( $basename != $filtered ) {
393 $warning .= '<li>'.wfMsgHtml( 'badfilename', htmlspecialchars( $this->mDestName
) ).'</li>';
396 global $wgCheckFileExtensions;
397 if ( $wgCheckFileExtensions ) {
398 if ( ! $this->checkFileExtension( $finalExt, $wgFileExtensions ) ) {
399 $warning .= '<li>'.wfMsgExt( 'filetype-badtype', array ( 'parseinline' ),
400 htmlspecialchars( $finalExt ), implode ( ', ', $wgFileExtensions ) ).'</li>';
404 global $wgUploadSizeWarning;
405 if ( $wgUploadSizeWarning && ( $this->mFileSize
> $wgUploadSizeWarning ) ) {
406 $skin = $wgUser->getSkin();
407 $wsize = $skin->formatSize( $wgUploadSizeWarning );
408 $asize = $skin->formatSize( $this->mFileSize
);
409 $warning .= '<li>' . wfMsgHtml( 'large-file', $wsize, $asize ) . '</li>';
411 if ( $this->mFileSize
== 0 ) {
412 $warning .= '<li>'.wfMsgHtml( 'emptyfile' ).'</li>';
415 if ( !$this->mDestWarningAck
) {
416 $warning .= self
::getExistsWarning( $this->mLocalFile
);
418 if( $warning != '' ) {
420 * Stash the file in a temporary location; the user can choose
421 * to let it through and we'll complete the upload then.
423 return $this->uploadWarning( $warning );
428 * Try actually saving the thing...
429 * It will show an error form on failure.
431 $pageText = self
::getInitialPageText( $this->mComment
, $this->mLicense
,
432 $this->mCopyrightStatus
, $this->mCopyrightSource
);
434 $status = $this->mLocalFile
->upload( $this->mTempPath
, $this->mComment
, $pageText,
435 File
::DELETE_SOURCE
, $this->mFileProps
);
436 if ( !$status->isGood() ) {
437 $this->showError( $status->getWikiText() );
439 if ( $this->mWatchthis
) {
441 $wgUser->addWatch( $this->mLocalFile
->getTitle() );
443 // Success, redirect to description page
444 $wgOut->redirect( $this->mLocalFile
->getTitle()->getFullURL() );
445 wfRunHooks( 'UploadComplete', array( &$img ) );
450 * Do existence checks on a file and produce a warning
451 * This check is static and can be done pre-upload via AJAX
452 * Returns an HTML fragment consisting of one or more LI elements if there is a warning
453 * Returns an empty string if there is no warning
455 static function getExistsWarning( $file ) {
457 // Check for uppercase extension. We allow these filenames but check if an image
458 // with lowercase extension exists already
460 $ext = $file->getExtension();
461 $sk = $wgUser->getSkin();
463 $partname = substr( $file->getName(), 0, -strlen( $ext ) - 1 );
465 $partname = $file->getName();
468 if ( $ext != strtolower( $ext ) ) {
469 $nt_lc = Title
::newFromText( $partname . '.' . strtolower( $ext ) );
470 $file_lc = wfLocalFile( $nt_lc );
475 if( $file->exists() ) {
476 $dlink = $sk->makeKnownLinkObj( $file->getTitle() );
477 if ( $file->allowInlineDisplay() ) {
478 $dlink2 = $sk->makeImageLinkObj( $file->getTitle(), wfMsgExt( 'fileexists-thumb', 'parseinline', $dlink ),
479 $file->getName(), 'right', array(), false, true );
480 } elseif ( !$file->allowInlineDisplay() && $file->isSafeFile() ) {
481 $icon = $file->iconThumb();
482 $dlink2 = '<div style="float:right" id="mw-media-icon"><a href="' . $file->getURL() . '">' .
483 $icon->toHtml() . '</a><br />' . $dlink . '</div>';
488 $warning .= '<li>' . wfMsgExt( 'fileexists', 'parseline', $dlink ) . '</li>' . $dlink2;
490 } elseif ( $file_lc && $file_lc->exists() ) {
491 # Check if image with lowercase extension exists.
492 # It's not forbidden but in 99% it makes no sense to upload the same filename with uppercase extension
493 $dlink = $sk->makeKnownLinkObj( $nt_lc );
494 if ( $file_lc->allowInlineDisplay() ) {
495 $dlink2 = $sk->makeImageLinkObj( $nt_lc, wfMsgExt( 'fileexists-thumb', 'parseinline', $dlink ),
496 $nt_lc->getText(), 'right', array(), false, true );
497 } elseif ( !$file_lc->allowInlineDisplay() && $file_lc->isSafeFile() ) {
498 $icon = $file_lc->iconThumb();
499 $dlink2 = '<div style="float:right" id="mw-media-icon"><a href="' . $file_lc->getURL() . '">' .
500 $icon->toHtml() . '</a><br />' . $dlink . '</div>';
505 $warning .= '<li>' . wfMsgExt( 'fileexists-extension', 'parsemag' , $partname . '.'
506 . $ext , $dlink ) . '</li>' . $dlink2;
508 } elseif ( ( substr( $partname , 3, 3 ) == 'px-' ||
substr( $partname , 2, 3 ) == 'px-' )
509 && ereg( "[0-9]{2}" , substr( $partname , 0, 2) ) )
511 # Check for filenames like 50px- or 180px-, these are mostly thumbnails
512 $nt_thb = Title
::newFromText( substr( $partname , strpos( $partname , '-' ) +
1 ) . '.' . $ext );
513 $file_thb = wfLocalFile( $nt_thb );
514 if ($file_thb->exists() ) {
515 # Check if an image without leading '180px-' (or similiar) exists
516 $dlink = $sk->makeKnownLinkObj( $nt_thb);
517 if ( $file_thb->allowInlineDisplay() ) {
518 $dlink2 = $sk->makeImageLinkObj( $nt_thb,
519 wfMsgExt( 'fileexists-thumb', 'parseinline', $dlink ),
520 $nt_thb->getText(), 'right', array(), false, true );
521 } elseif ( !$file_thb->allowInlineDisplay() && $file_thb->isSafeFile() ) {
522 $icon = $file_thb->iconThumb();
523 $dlink2 = '<div style="float:right" id="mw-media-icon"><a href="' .
524 $file_thb->getURL() . '">' . $icon->toHtml() . '</a><br />' .
530 $warning .= '<li>' . wfMsgExt( 'fileexists-thumbnail-yes', 'parsemag', $dlink ) .
533 # Image w/o '180px-' does not exists, but we do not like these filenames
534 $warning .= '<li>' . wfMsgExt( 'file-thumbnail-no', 'parseinline' ,
535 substr( $partname , 0, strpos( $partname , '-' ) +
1 ) ) . '</li>';
538 if ( $file->wasDeleted() ) {
539 # If the file existed before and was deleted, warn the user of this
540 # Don't bother doing so if the image exists now, however
541 $ltitle = SpecialPage
::getTitleFor( 'Log' );
542 $llink = $sk->makeKnownLinkObj( $ltitle, wfMsgHtml( 'deletionlog' ),
543 'type=delete&page=' . $file->getTitle()->getPrefixedUrl() );
544 $warning .= '<li>' . wfMsgWikiHtml( 'filewasdeleted', $llink ) . '</li>';
549 static function ajaxGetExistsWarning( $filename ) {
550 $file = wfFindFile( $filename );
553 $warning = self
::getExistsWarning( $file );
554 if ( $warning !== '' ) {
555 $s = "<ul>$warning</ul>";
562 * Render a preview of a given license for the AJAX preview on upload
564 * @param string $license
567 public static function ajaxGetLicensePreview( $license ) {
568 global $wgParser, $wgUser;
569 $text = '{{' . $license . '}}';
570 $title = Title
::makeTitle( NS_IMAGE
, 'Sample.jpg' );
571 $options = ParserOptions
::newFromUser( $wgUser );
573 // Expand subst: first, then live templates...
574 $text = $wgParser->preSaveTransform( $text, $title, $wgUser, $options );
575 $output = $wgParser->parse( $text, $title, $options );
577 return $output->getText();
581 * Stash a file in a temporary directory for later processing
582 * after the user has confirmed it.
584 * If the user doesn't explicitly cancel or accept, these files
585 * can accumulate in the temp directory.
587 * @param string $saveName - the destination filename
588 * @param string $tempName - the source temporary file to save
589 * @return string - full path the stashed file, or false on failure
592 function saveTempUploadedFile( $saveName, $tempName ) {
594 $repo = RepoGroup
::singleton()->getLocalRepo();
595 $status = $repo->storeTemp( $saveName, $tempName );
596 if ( !$status->isGood() ) {
597 $this->showError( $status->getWikiText() );
600 return $status->value
;
605 * Stash a file in a temporary directory for later processing,
606 * and save the necessary descriptive info into the session.
607 * Returns a key value which will be passed through a form
608 * to pick up the path info on a later invocation.
613 function stashSession() {
614 $stash = $this->saveTempUploadedFile( $this->mDestName
, $this->mTempPath
);
617 # Couldn't save the file.
621 $key = mt_rand( 0, 0x7fffffff );
622 $_SESSION['wsUploadData'][$key] = array(
623 'mTempPath' => $stash,
624 'mFileSize' => $this->mFileSize
,
625 'mSrcName' => $this->mSrcName
,
626 'mFileProps' => $this->mFileProps
,
627 'version' => self
::SESSION_VERSION
,
633 * Remove a temporarily kept file stashed by saveTempUploadedFile().
637 function unsaveUploadedFile() {
639 $repo = RepoGroup
::singleton()->getLocalRepo();
640 $success = $repo->freeTemp( $this->mTempPath
);
642 $wgOut->showFileDeleteError( $this->mTempPath
);
649 /* -------------------------------------------------------------- */
652 * @param string $error as HTML
655 function uploadError( $error ) {
657 $wgOut->addHTML( "<h2>" . wfMsgHtml( 'uploadwarning' ) . "</h2>\n" );
658 $wgOut->addHTML( "<span class='error'>{$error}</span>\n" );
662 * There's something wrong with this file, not enough to reject it
663 * totally but we require manual intervention to save it for real.
664 * Stash it away, then present a form asking to confirm or cancel.
666 * @param string $warning as HTML
669 function uploadWarning( $warning ) {
671 global $wgUseCopyrightUpload;
673 $this->mSessionKey
= $this->stashSession();
674 if( !$this->mSessionKey
) {
675 # Couldn't save file; an error has been displayed so let's go.
679 $wgOut->addHTML( "<h2>" . wfMsgHtml( 'uploadwarning' ) . "</h2>\n" );
680 $wgOut->addHTML( "<ul class='warning'>{$warning}</ul><br />\n" );
682 $save = wfMsgHtml( 'savefile' );
683 $reupload = wfMsgHtml( 'reupload' );
684 $iw = wfMsgWikiHtml( 'ignorewarning' );
685 $reup = wfMsgWikiHtml( 'reuploaddesc' );
686 $titleObj = SpecialPage
::getTitleFor( 'Upload' );
687 $action = $titleObj->escapeLocalURL( 'action=submit' );
689 if ( $wgUseCopyrightUpload )
692 <input type='hidden' name='wpUploadCopyStatus' value=\"" . htmlspecialchars( $this->mCopyrightStatus
) . "\" />
693 <input type='hidden' name='wpUploadSource' value=\"" . htmlspecialchars( $this->mCopyrightSource
) . "\" />
700 <form id='uploadwarning' method='post' enctype='multipart/form-data' action='$action'>
701 <input type='hidden' name='wpIgnoreWarning' value='1' />
702 <input type='hidden' name='wpSessionKey' value=\"" . htmlspecialchars( $this->mSessionKey
) . "\" />
703 <input type='hidden' name='wpUploadDescription' value=\"" . htmlspecialchars( $this->mComment
) . "\" />
704 <input type='hidden' name='wpLicense' value=\"" . htmlspecialchars( $this->mLicense
) . "\" />
705 <input type='hidden' name='wpDestFile' value=\"" . htmlspecialchars( $this->mDesiredDestName
) . "\" />
706 <input type='hidden' name='wpWatchthis' value=\"" . htmlspecialchars( intval( $this->mWatchthis
) ) . "\" />
712 <input tabindex='2' type='submit' name='wpUpload' value=\"$save\" />
714 <td align='left'>$iw</td>
718 <input tabindex='2' type='submit' name='wpReUpload' value=\"{$reupload}\" />
720 <td align='left'>$reup</td>
723 </table></form>\n" );
727 * Displays the main upload form, optionally with a highlighted
728 * error message up at the top.
730 * @param string $msg as HTML
733 function mainUploadForm( $msg='' ) {
734 global $wgOut, $wgUser;
735 global $wgUseCopyrightUpload, $wgUseAjax, $wgAjaxUploadDestCheck, $wgAjaxLicensePreview;
736 global $wgRequest, $wgAllowCopyUploads, $wgEnableAPI;
737 global $wgStylePath, $wgStyleVersion;
739 $useAjaxDestCheck = $wgUseAjax && $wgAjaxUploadDestCheck;
740 $useAjaxLicensePreview = $wgUseAjax && $wgAjaxLicensePreview;
742 $adc = wfBoolToStr( $useAjaxDestCheck );
743 $alp = wfBoolToStr( $useAjaxLicensePreview );
745 $wgOut->addScript( "<script type=\"text/javascript\">
746 wgAjaxUploadDestCheck = {$adc};
747 wgAjaxLicensePreview = {$alp};
749 <script type=\"text/javascript\" src=\"{$wgStylePath}/common/upload.js?{$wgStyleVersion}\"></script>
752 if( !wfRunHooks( 'UploadForm:initial', array( &$this ) ) )
754 wfDebug( "Hook 'UploadForm:initial' broke output of the upload form" );
758 $cols = intval($wgUser->getOption( 'cols' ));
759 $ew = $wgUser->getOption( 'editwidth' );
760 if ( $ew ) $ew = " style=\"width:100%\"";
764 $sub = wfMsgHtml( 'uploaderror' );
765 $wgOut->addHTML( "<h2>{$sub}</h2>\n" .
766 "<span class='error'>{$msg}</span>\n" );
768 $wgOut->addHTML( '<div id="uploadtext">' );
769 $wgOut->addWikiText( wfMsgNoTrans( 'uploadtext', $this->mDesiredDestName
) );
770 $wgOut->addHTML( '</div>' );
772 $sourcefilename = wfMsgHtml( 'sourcefilename' );
773 $destfilename = wfMsgHtml( 'destfilename' );
774 $summary = wfMsgWikiHtml( 'fileuploadsummary' );
776 $licenses = new Licenses();
777 $license = wfMsgExt( 'license', array( 'parseinline' ) );
778 $nolicense = wfMsgHtml( 'nolicense' );
779 $licenseshtml = $licenses->getHtml();
781 $ulb = wfMsgHtml( 'uploadbtn' );
784 $titleObj = SpecialPage
::getTitleFor( 'Upload' );
785 $action = $titleObj->escapeLocalURL();
787 $encDestName = htmlspecialchars( $this->mDesiredDestName
);
790 ( $wgUser->getOption( 'watchdefault' ) ||
791 ( $wgUser->getOption( 'watchcreations' ) && $this->mDesiredDestName
== '' ) )
792 ?
'checked="checked"'
794 $warningChecked = $this->mIgnoreWarning ?
'checked' : '';
796 // Prepare form for upload or upload/copy
797 if( $wgAllowCopyUploads && $wgUser->isAllowed( 'upload_by_url' ) ) {
799 "<input type='radio' id='wpSourceTypeFile' name='wpSourceType' value='file' " .
800 "onchange='toggle_element_activation(\"wpUploadFileURL\",\"wpUploadFile\")' checked />" .
801 "<input tabindex='1' type='file' name='wpUploadFile' id='wpUploadFile' " .
803 "toggle_element_activation(\"wpUploadFileURL\",\"wpUploadFile\");" .
804 "toggle_element_check(\"wpSourceTypeFile\",\"wpSourceTypeURL\")'" .
805 ($this->mDesiredDestName?
"":"onchange='fillDestFilename(\"wpUploadFile\")' ") . "size='40' />" .
806 wfMsgHTML( 'upload_source_file' ) . "<br/>" .
807 "<input type='radio' id='wpSourceTypeURL' name='wpSourceType' value='web' " .
808 "onchange='toggle_element_activation(\"wpUploadFile\",\"wpUploadFileURL\")' />" .
809 "<input tabindex='1' type='text' name='wpUploadFileURL' id='wpUploadFileURL' " .
811 "toggle_element_activation(\"wpUploadFile\",\"wpUploadFileURL\");" .
812 "toggle_element_check(\"wpSourceTypeURL\",\"wpSourceTypeFile\")'" .
813 ($this->mDesiredDestName?
"":"onchange='fillDestFilename(\"wpUploadFileURL\")' ") . "size='40' DISABLED />" .
814 wfMsgHtml( 'upload_source_url' ) ;
817 "<input tabindex='1' type='file' name='wpUploadFile' id='wpUploadFile' " .
818 ($this->mDesiredDestName?
"":"onchange='fillDestFilename(\"wpUploadFile\")' ") .
820 "<input type='hidden' name='wpSourceType' value='file' />" ;
822 if ( $useAjaxDestCheck ) {
823 $warningRow = "<tr><td colspan='2' id='wpDestFile-warning'> </td></tr>";
824 $destOnkeyup = 'onkeyup="wgUploadWarningObj.keypress();"';
830 $encComment = htmlspecialchars( $this->mComment
);
832 $wgOut->addHTML( <<<EOT
833 <form id='upload' method='post' enctype='multipart/form-data' action="$action">
836 {$this->uploadFormTextTop}
837 <td align='right' valign='top'><label for='wpUploadFile'>{$sourcefilename}:</label></td>
843 <td align='right'><label for='wpDestFile'>{$destfilename}:</label></td>
845 <input tabindex='2' type='text' name='wpDestFile' id='wpDestFile' size='40'
846 value="$encDestName" $destOnkeyup />
850 <td align='right'><label for='wpUploadDescription'>{$summary}</label></td>
852 <textarea tabindex='3' name='wpUploadDescription' id='wpUploadDescription' rows='6'
853 cols='{$cols}'{$ew}>$encComment</textarea>
854 {$this->uploadFormTextAfterSummary}
861 if ( $licenseshtml != '' ) {
864 <td align='right'><label for='wpLicense'>$license:</label></td>
866 <select name='wpLicense' id='wpLicense' tabindex='4'
867 onchange='licenseSelectorCheck()'>
868 <option value=''>$nolicense</option>
874 if( $useAjaxLicensePreview ) {
877 <td id=\"mw-license-preview\"></td>
883 if ( $wgUseCopyrightUpload ) {
884 $filestatus = wfMsgHtml ( 'filestatus' );
885 $copystatus = htmlspecialchars( $this->mCopyrightStatus
);
886 $filesource = wfMsgHtml ( 'filesource' );
887 $uploadsource = htmlspecialchars( $this->mCopyrightSource
);
890 <td align='right' nowrap='nowrap'><label for='wpUploadCopyStatus'>$filestatus:</label></td>
891 <td><input tabindex='5' type='text' name='wpUploadCopyStatus' id='wpUploadCopyStatus'
892 value=\"$copystatus\" size='40' /></td>
895 <td align='right'><label for='wpUploadCopyStatus'>$filesource:</label></td>
896 <td><input tabindex='6' type='text' name='wpUploadSource' id='wpUploadCopyStatus'
897 value=\"$uploadsource\" size='40' /></td>
906 <input tabindex='7' type='checkbox' name='wpWatchthis' id='wpWatchthis' $watchChecked value='true' />
907 <label for='wpWatchthis'>" . wfMsgHtml( 'watchthisupload' ) . "</label>
908 <input tabindex='8' type='checkbox' name='wpIgnoreWarning' id='wpIgnoreWarning' value='true' $warningChecked/>
909 <label for='wpIgnoreWarning'>" . wfMsgHtml( 'ignorewarnings' ) . "</label>
915 <td align='left'><input tabindex='9' type='submit' name='wpUpload' value=\"{$ulb}\" /></td>
921 $wgOut->addWikiText( wfMsgForContent( 'edittools' ) );
927 <input type='hidden' name='wpDestFileWarningAck' id='wpDestFileWarningAck' value=''/>
931 /* -------------------------------------------------------------- */
934 * Split a file into a base name and all dot-delimited 'extensions'
935 * on the end. Some web server configurations will fall back to
936 * earlier pseudo-'extensions' to determine type and execute
937 * scripts, so the blacklist needs to check them all.
941 function splitExtensions( $filename ) {
942 $bits = explode( '.', $filename );
943 $basename = array_shift( $bits );
944 return array( $basename, $bits );
948 * Perform case-insensitive match against a list of file extensions.
949 * Returns true if the extension is in the list.
955 function checkFileExtension( $ext, $list ) {
956 return in_array( strtolower( $ext ), $list );
960 * Perform case-insensitive match against a list of file extensions.
961 * Returns true if any of the extensions are in the list.
967 function checkFileExtensionList( $ext, $list ) {
968 foreach( $ext as $e ) {
969 if( in_array( strtolower( $e ), $list ) ) {
977 * Verifies that it's ok to include the uploaded file
979 * @param string $tmpfile the full path of the temporary file to verify
980 * @param string $extension The filename extension that the file is to be served with
981 * @return mixed true of the file is verified, a WikiError object otherwise.
983 function verify( $tmpfile, $extension ) {
984 #magically determine mime type
985 $magic=& MimeMagic
::singleton();
986 $mime= $magic->guessMimeType($tmpfile,false);
988 #check mime type, if desired
989 global $wgVerifyMimeType;
990 if ($wgVerifyMimeType) {
992 wfDebug ( "\n\nmime: <$mime> extension: <$extension>\n\n");
993 #check mime type against file extension
994 if( !$this->verifyExtension( $mime, $extension ) ) {
995 return new WikiErrorMsg( 'uploadcorrupt' );
998 #check mime type blacklist
999 global $wgMimeTypeBlacklist;
1000 if( isset($wgMimeTypeBlacklist) && !is_null($wgMimeTypeBlacklist)
1001 && $this->checkFileExtension( $mime, $wgMimeTypeBlacklist ) ) {
1002 return new WikiErrorMsg( 'filetype-badmime', htmlspecialchars( $mime ) );
1006 #check for htmlish code and javascript
1007 if( $this->detectScript ( $tmpfile, $mime, $extension ) ) {
1008 return new WikiErrorMsg( 'uploadscripted' );
1012 * Scan the uploaded file for viruses
1014 $virus= $this->detectVirus($tmpfile);
1016 return new WikiErrorMsg( 'uploadvirus', htmlspecialchars($virus) );
1019 wfDebug( __METHOD__
.": all clear; passing.\n" );
1024 * Checks if the mime type of the uploaded file matches the file extension.
1026 * @param string $mime the mime type of the uploaded file
1027 * @param string $extension The filename extension that the file is to be served with
1030 function verifyExtension( $mime, $extension ) {
1031 $magic =& MimeMagic
::singleton();
1033 if ( ! $mime ||
$mime == 'unknown' ||
$mime == 'unknown/unknown' )
1034 if ( ! $magic->isRecognizableExtension( $extension ) ) {
1035 wfDebug( __METHOD__
.": passing file with unknown detected mime type; " .
1036 "unrecognized extension '$extension', can't verify\n" );
1039 wfDebug( __METHOD__
.": rejecting file with unknown detected mime type; ".
1040 "recognized extension '$extension', so probably invalid file\n" );
1044 $match= $magic->isMatchingExtension($extension,$mime);
1046 if ($match===NULL) {
1047 wfDebug( __METHOD__
.": no file extension known for mime type $mime, passing file\n" );
1049 } elseif ($match===true) {
1050 wfDebug( __METHOD__
.": mime type $mime matches extension $extension, passing file\n" );
1052 #TODO: if it's a bitmap, make sure PHP or ImageMagic resp. can handle it!
1056 wfDebug( __METHOD__
.": mime type $mime mismatches file extension $extension, rejecting file\n" );
1062 * Heuristic for detecting files that *could* contain JavaScript instructions or
1063 * things that may look like HTML to a browser and are thus
1064 * potentially harmful. The present implementation will produce false positives in some situations.
1066 * @param string $file Pathname to the temporary upload file
1067 * @param string $mime The mime type of the file
1068 * @param string $extension The extension of the file
1069 * @return bool true if the file contains something looking like embedded scripts
1071 function detectScript($file, $mime, $extension) {
1072 global $wgAllowTitlesInSVG;
1074 #ugly hack: for text files, always look at the entire file.
1075 #For binarie field, just check the first K.
1077 if (strpos($mime,'text/')===0) $chunk = file_get_contents( $file );
1079 $fp = fopen( $file, 'rb' );
1080 $chunk = fread( $fp, 1024 );
1084 $chunk= strtolower( $chunk );
1086 if (!$chunk) return false;
1088 #decode from UTF-16 if needed (could be used for obfuscation).
1089 if (substr($chunk,0,2)=="\xfe\xff") $enc= "UTF-16BE";
1090 elseif (substr($chunk,0,2)=="\xff\xfe") $enc= "UTF-16LE";
1093 if ($enc) $chunk= iconv($enc,"ASCII//IGNORE",$chunk);
1095 $chunk= trim($chunk);
1097 #FIXME: convert from UTF-16 if necessarry!
1099 wfDebug("SpecialUpload::detectScript: checking for embedded scripts and HTML stuff\n");
1101 #check for HTML doctype
1102 if (eregi("<!DOCTYPE *X?HTML",$chunk)) return true;
1105 * Internet Explorer for Windows performs some really stupid file type
1106 * autodetection which can cause it to interpret valid image files as HTML
1107 * and potentially execute JavaScript, creating a cross-site scripting
1110 * Apple's Safari browser also performs some unsafe file type autodetection
1111 * which can cause legitimate files to be interpreted as HTML if the
1112 * web server is not correctly configured to send the right content-type
1113 * (or if you're really uploading plain text and octet streams!)
1115 * Returns true if IE is likely to mistake the given file for HTML.
1116 * Also returns true if Safari would mistake the given file for HTML
1117 * when served with a generic content-type.
1123 '<html', #also in safari
1126 '<script', #also in safari
1129 if( ! $wgAllowTitlesInSVG && $extension !== 'svg' && $mime !== 'image/svg' ) {
1133 foreach( $tags as $tag ) {
1134 if( false !== strpos( $chunk, $tag ) ) {
1140 * look for javascript
1143 #resolve entity-refs to look at attributes. may be harsh on big files... cache result?
1144 $chunk = Sanitizer
::decodeCharReferences( $chunk );
1146 #look for script-types
1147 if (preg_match('!type\s*=\s*[\'"]?\s*(?:\w*/)?(?:ecma|java)!sim',$chunk)) return true;
1149 #look for html-style script-urls
1150 if (preg_match('!(?:href|src|data)\s*=\s*[\'"]?\s*(?:ecma|java)script:!sim',$chunk)) return true;
1152 #look for css-style script-urls
1153 if (preg_match('!url\s*\(\s*[\'"]?\s*(?:ecma|java)script:!sim',$chunk)) return true;
1155 wfDebug("SpecialUpload::detectScript: no scripts found\n");
1160 * Generic wrapper function for a virus scanner program.
1161 * This relies on the $wgAntivirus and $wgAntivirusSetup variables.
1162 * $wgAntivirusRequired may be used to deny upload if the scan fails.
1164 * @param string $file Pathname to the temporary upload file
1165 * @return mixed false if not virus is found, NULL if the scan fails or is disabled,
1166 * or a string containing feedback from the virus scanner if a virus was found.
1167 * If textual feedback is missing but a virus was found, this function returns true.
1169 function detectVirus($file) {
1170 global $wgAntivirus, $wgAntivirusSetup, $wgAntivirusRequired, $wgOut;
1172 if ( !$wgAntivirus ) {
1173 wfDebug( __METHOD__
.": virus scanner disabled\n");
1177 if ( !$wgAntivirusSetup[$wgAntivirus] ) {
1178 wfDebug( __METHOD__
.": unknown virus scanner: $wgAntivirus\n" );
1180 $wgOut->addHTML( "<div class='error'>Bad configuration: unknown virus scanner: <i>$wgAntivirus</i></div>\n" );
1181 return "unknown antivirus: $wgAntivirus";
1184 # look up scanner configuration
1185 $command = $wgAntivirusSetup[$wgAntivirus]["command"];
1186 $exitCodeMap = $wgAntivirusSetup[$wgAntivirus]["codemap"];
1187 $msgPattern = isset( $wgAntivirusSetup[$wgAntivirus]["messagepattern"] ) ?
1188 $wgAntivirusSetup[$wgAntivirus]["messagepattern"] : null;
1190 if ( strpos( $command,"%f" ) === false ) {
1191 # simple pattern: append file to scan
1192 $command .= " " . wfEscapeShellArg( $file );
1194 # complex pattern: replace "%f" with file to scan
1195 $command = str_replace( "%f", wfEscapeShellArg( $file ), $command );
1198 wfDebug( __METHOD__
.": running virus scan: $command \n" );
1200 # execute virus scanner
1203 #NOTE: there's a 50 line workaround to make stderr redirection work on windows, too.
1204 # that does not seem to be worth the pain.
1205 # Ask me (Duesentrieb) about it if it's ever needed.
1207 if ( wfIsWindows() ) {
1208 exec( "$command", $output, $exitCode );
1210 exec( "$command 2>&1", $output, $exitCode );
1213 # map exit code to AV_xxx constants.
1214 $mappedCode = $exitCode;
1215 if ( $exitCodeMap ) {
1216 if ( isset( $exitCodeMap[$exitCode] ) ) {
1217 $mappedCode = $exitCodeMap[$exitCode];
1218 } elseif ( isset( $exitCodeMap["*"] ) ) {
1219 $mappedCode = $exitCodeMap["*"];
1223 if ( $mappedCode === AV_SCAN_FAILED
) {
1224 # scan failed (code was mapped to false by $exitCodeMap)
1225 wfDebug( __METHOD__
.": failed to scan $file (code $exitCode).\n" );
1227 if ( $wgAntivirusRequired ) {
1228 return "scan failed (code $exitCode)";
1232 } else if ( $mappedCode === AV_SCAN_ABORTED
) {
1233 # scan failed because filetype is unknown (probably imune)
1234 wfDebug( __METHOD__
.": unsupported file type $file (code $exitCode).\n" );
1236 } else if ( $mappedCode === AV_NO_VIRUS
) {
1238 wfDebug( __METHOD__
.": file passed virus scan.\n" );
1241 $output = join( "\n", $output );
1242 $output = trim( $output );
1245 $output = true; #if there's no output, return true
1246 } elseif ( $msgPattern ) {
1248 if ( preg_match( $msgPattern, $output, $groups ) ) {
1250 $output = $groups[1];
1255 wfDebug( __METHOD__
.": FOUND VIRUS! scanner feedback: $output" );
1261 * Check if the temporary file is MacBinary-encoded, as some uploads
1262 * from Internet Explorer on Mac OS Classic and Mac OS X will be.
1263 * If so, the data fork will be extracted to a second temporary file,
1264 * which will then be checked for validity and either kept or discarded.
1268 function checkMacBinary() {
1269 $macbin = new MacBinary( $this->mTempPath
);
1270 if( $macbin->isValid() ) {
1271 $dataFile = tempnam( wfTempDir(), "WikiMacBinary" );
1272 $dataHandle = fopen( $dataFile, 'wb' );
1274 wfDebug( "SpecialUpload::checkMacBinary: Extracting MacBinary data fork to $dataFile\n" );
1275 $macbin->extractData( $dataHandle );
1277 $this->mTempPath
= $dataFile;
1278 $this->mFileSize
= $macbin->dataForkLength();
1280 // We'll have to manually remove the new file if it's not kept.
1281 $this->mRemoveTempFile
= true;
1287 * If we've modified the upload file we need to manually remove it
1288 * on exit to clean up.
1291 function cleanupTempFile() {
1292 if ( $this->mRemoveTempFile
&& file_exists( $this->mTempPath
) ) {
1293 wfDebug( "SpecialUpload::cleanupTempFile: Removing temporary file {$this->mTempPath}\n" );
1294 unlink( $this->mTempPath
);
1299 * Check if there's an overwrite conflict and, if so, if restrictions
1300 * forbid this user from performing the upload.
1302 * @return mixed true on success, WikiError on failure
1305 function checkOverwrite( $name ) {
1306 $img = wfFindFile( $name );
1310 global $wgUser, $wgOut;
1311 if( $img->isLocal() ) {
1312 if( !self
::userCanReUpload( $wgUser, $img->name
) ) {
1313 $error = 'fileexists-forbidden';
1316 if( !$wgUser->isAllowed( 'reupload' ) ||
1317 !$wgUser->isAllowed( 'reupload-shared' ) ) {
1318 $error = "fileexists-shared-forbidden";
1324 $errorText = wfMsg( $error, wfEscapeWikiText( $img->getName() ) );
1325 return new WikiError( $wgOut->parse( $errorText ) );
1328 // Rockin', go ahead and upload
1333 * Check if a user is the last uploader
1336 * @param string $img, image name
1339 public static function userCanReUpload( User
$user, $img ) {
1340 if( $user->isAllowed( 'reupload' ) )
1341 return true; // non-conditional
1342 if( !$user->isAllowed( 'reupload-own' ) )
1345 $dbr = wfGetDB( DB_SLAVE
);
1346 $row = $dbr->selectRow('image',
1347 /* SELECT */ 'img_user',
1348 /* WHERE */ array( 'img_name' => $img )
1353 return $user->getID() == $row->img_user
;
1357 * Display an error with a wikitext description
1359 function showError( $description ) {
1361 $wgOut->setPageTitle( wfMsg( "internalerror" ) );
1362 $wgOut->setRobotpolicy( "noindex,nofollow" );
1363 $wgOut->setArticleRelated( false );
1364 $wgOut->enableClientCache( false );
1365 $wgOut->addWikiText( $description );
1369 * Get the initial image page text based on a comment and optional file status information
1371 static function getInitialPageText( $comment, $license, $copyStatus, $source ) {
1372 global $wgUseCopyrightUpload;
1373 if ( $wgUseCopyrightUpload ) {
1374 if ( $license != '' ) {
1375 $licensetxt = '== ' . wfMsgForContent( 'license' ) . " ==\n" . '{{' . $license . '}}' . "\n";
1377 $pageText = '== ' . wfMsg ( 'filedesc' ) . " ==\n" . $comment . "\n" .
1378 '== ' . wfMsgForContent ( 'filestatus' ) . " ==\n" . $copyStatus . "\n" .
1380 '== ' . wfMsgForContent ( 'filesource' ) . " ==\n" . $source ;
1382 if ( $license != '' ) {
1383 $filedesc = $comment == '' ?
'' : '== ' . wfMsg ( 'filedesc' ) . " ==\n" . $comment . "\n";
1384 $pageText = $filedesc .
1385 '== ' . wfMsgForContent ( 'license' ) . " ==\n" . '{{' . $license . '}}' . "\n";
1387 $pageText = $comment;