6 * UploadBase and subclasses are the backend of MediaWiki's file uploads.
7 * The frontends are formed by ApiUpload and SpecialUpload.
9 * See also includes/docs/upload.txt
11 * @author Brion Vibber
12 * @author Bryan Tong Minh
13 * @author Michael Dale
16 abstract class UploadBase
{
18 protected $mDesiredDestName, $mDestName, $mRemoveTempFile, $mSourceType;
19 protected $mTitle = false, $mTitleError = 0;
20 protected $mFilteredName, $mFinalExtension;
21 protected $mLocalFile, $mFileSize, $mFileProps;
22 protected $mBlackListedExtensions;
23 protected $mJavaDetected;
28 const MIN_LENGTH_PARTNAME
= 4;
29 const ILLEGAL_FILENAME
= 5;
30 const OVERWRITE_EXISTING_FILE
= 7; # Not used anymore; handled by verifyTitlePermissions()
31 const FILETYPE_MISSING
= 8;
32 const FILETYPE_BADTYPE
= 9;
33 const VERIFICATION_ERROR
= 10;
35 # HOOK_ABORTED is the new name of UPLOAD_VERIFICATION_ERROR
36 const UPLOAD_VERIFICATION_ERROR
= 11;
37 const HOOK_ABORTED
= 11;
38 const FILE_TOO_LARGE
= 12;
39 const WINDOWS_NONASCII_FILENAME
= 13;
41 const SESSION_VERSION
= 2;
42 const SESSION_KEYNAME
= 'wsUploadData';
44 static public function getSessionKeyname() {
45 return self
::SESSION_KEYNAME
;
48 public function getVerificationErrorCode( $error ) {
49 $code_to_status = array(self
::EMPTY_FILE
=> 'empty-file',
50 self
::FILE_TOO_LARGE
=> 'file-too-large',
51 self
::FILETYPE_MISSING
=> 'filetype-missing',
52 self
::FILETYPE_BADTYPE
=> 'filetype-banned',
53 self
::MIN_LENGTH_PARTNAME
=> 'filename-tooshort',
54 self
::ILLEGAL_FILENAME
=> 'illegal-filename',
55 self
::OVERWRITE_EXISTING_FILE
=> 'overwrite',
56 self
::VERIFICATION_ERROR
=> 'verification-error',
57 self
::HOOK_ABORTED
=> 'hookaborted',
58 self
::WINDOWS_NONASCII_FILENAME
=> 'windows-nonascii-filename',
60 if( isset( $code_to_status[$error] ) ) {
61 return $code_to_status[$error];
64 return 'unknown-error';
68 * Returns true if uploads are enabled.
69 * Can be override by subclasses.
71 public static function isEnabled() {
72 global $wgEnableUploads;
74 if ( !$wgEnableUploads ) {
78 # Check php's file_uploads setting
79 return wfIsHipHop() ||
wfIniGetBool( 'file_uploads' );
83 * Returns true if the user can use this upload module or else a string
84 * identifying the missing permission.
85 * Can be overriden by subclasses.
89 public static function isAllowed( $user ) {
90 foreach ( array( 'upload', 'edit' ) as $permission ) {
91 if ( !$user->isAllowed( $permission ) ) {
98 // Upload handlers. Should probably just be a global.
99 static $uploadHandlers = array( 'Stash', 'File', 'Url' );
102 * Create a form of UploadBase depending on wpSourceType and initializes it
104 * @param $request WebRequest
107 public static function createFromRequest( &$request, $type = null ) {
108 $type = $type ?
$type : $request->getVal( 'wpSourceType', 'File' );
114 // Get the upload class
115 $type = ucfirst( $type );
117 // Give hooks the chance to handle this request
119 wfRunHooks( 'UploadCreateFromRequest', array( $type, &$className ) );
120 if ( is_null( $className ) ) {
121 $className = 'UploadFrom' . $type;
122 wfDebug( __METHOD__
. ": class name: $className\n" );
123 if( !in_array( $type, self
::$uploadHandlers ) ) {
128 // Check whether this upload class is enabled
129 if( !call_user_func( array( $className, 'isEnabled' ) ) ) {
133 // Check whether the request is valid
134 if( !call_user_func( array( $className, 'isValidRequest' ), $request ) ) {
138 $handler = new $className;
140 $handler->initializeFromRequest( $request );
145 * Check whether a request if valid for this handler
147 public static function isValidRequest( $request ) {
151 public function __construct() {}
154 * Returns the upload type. Should be overridden by child classes
159 public function getSourceType() { return null; }
162 * Initialize the path information
163 * @param $name string the desired destination name
164 * @param $tempPath string the temporary path
165 * @param $fileSize int the file size
166 * @param $removeTempFile bool (false) remove the temporary file?
169 public function initializePathInfo( $name, $tempPath, $fileSize, $removeTempFile = false ) {
170 $this->mDesiredDestName
= $name;
171 $this->mTempPath
= $tempPath;
172 $this->mFileSize
= $fileSize;
173 $this->mRemoveTempFile
= $removeTempFile;
177 * Initialize from a WebRequest. Override this in a subclass.
179 public abstract function initializeFromRequest( &$request );
182 * Fetch the file. Usually a no-op
184 public function fetchFile() {
185 return Status
::newGood();
189 * Return true if the file is empty
192 public function isEmptyFile() {
193 return empty( $this->mFileSize
);
197 * Return the file size
200 public function getFileSize() {
201 return $this->mFileSize
;
205 * Append a file to the Repo file
207 * @param $srcPath String: path to source file
208 * @param $toAppendPath String: path to the Repo file that will be appended to.
209 * @return Status Status
211 protected function appendToUploadFile( $srcPath, $toAppendPath ) {
212 $repo = RepoGroup
::singleton()->getLocalRepo();
213 $status = $repo->append( $srcPath, $toAppendPath );
218 * Finish appending to the Repo file
220 * @param $toAppendPath String: path to the Repo file that will be appended to.
221 * @return Status Status
223 protected function appendFinish( $toAppendPath ) {
224 $repo = RepoGroup
::singleton()->getLocalRepo();
225 $status = $repo->appendFinish( $toAppendPath );
231 * @param $srcPath String: the source path
232 * @return the real path if it was a virtual URL
234 function getRealPath( $srcPath ) {
235 $repo = RepoGroup
::singleton()->getLocalRepo();
236 if ( $repo->isVirtualUrl( $srcPath ) ) {
237 return $repo->resolveVirtualUrl( $srcPath );
243 * Verify whether the upload is sane.
244 * @return mixed self::OK or else an array with error information
246 public function verifyUpload() {
248 * If there was no filename or a zero size given, give up quick.
250 if( $this->isEmptyFile() ) {
251 return array( 'status' => self
::EMPTY_FILE
);
255 * Honor $wgMaxUploadSize
257 $maxSize = self
::getMaxUploadSize( $this->getSourceType() );
258 if( $this->mFileSize
> $maxSize ) {
260 'status' => self
::FILE_TOO_LARGE
,
266 * Look at the contents of the file; if we can recognize the
267 * type but it's corrupt or data of the wrong type, we should
268 * probably not accept it.
270 $verification = $this->verifyFile();
271 if( $verification !== true ) {
273 'status' => self
::VERIFICATION_ERROR
,
274 'details' => $verification
279 * Make sure this file can be created
281 $result = $this->validateName();
282 if( $result !== true ) {
287 if( !wfRunHooks( 'UploadVerification',
288 array( $this->mDestName
, $this->mTempPath
, &$error ) ) ) {
289 return array( 'status' => self
::HOOK_ABORTED
, 'error' => $error );
292 return array( 'status' => self
::OK
);
296 * Verify that the name is valid and, if necessary, that we can overwrite
298 * @return mixed true if valid, otherwise and array with 'status'
301 protected function validateName() {
302 $nt = $this->getTitle();
303 if( is_null( $nt ) ) {
304 $result = array( 'status' => $this->mTitleError
);
305 if( $this->mTitleError
== self
::ILLEGAL_FILENAME
) {
306 $result['filtered'] = $this->mFilteredName
;
308 if ( $this->mTitleError
== self
::FILETYPE_BADTYPE
) {
309 $result['finalExt'] = $this->mFinalExtension
;
310 if ( count( $this->mBlackListedExtensions
) ) {
311 $result['blacklistedExt'] = $this->mBlackListedExtensions
;
316 $this->mDestName
= $this->getLocalFile()->getName();
322 * Verify the mime type
324 * @param $mime string representing the mime
325 * @return mixed true if the file is verified, an array otherwise
327 protected function verifyMimeType( $mime ) {
328 global $wgVerifyMimeType;
329 if ( $wgVerifyMimeType ) {
330 wfDebug ( "\n\nmime: <$mime> extension: <{$this->mFinalExtension}>\n\n");
331 global $wgMimeTypeBlacklist;
332 if ( $this->checkFileExtension( $mime, $wgMimeTypeBlacklist ) ) {
333 return array( 'filetype-badmime', $mime );
336 # XXX: Missing extension will be caught by validateName() via getTitle()
337 if ( $this->mFinalExtension
!= '' && !$this->verifyExtension( $mime, $this->mFinalExtension
) ) {
338 return array( 'filetype-mime-mismatch', $this->mFinalExtension
, $mime );
342 $fp = fopen( $this->mTempPath
, 'rb' );
343 $chunk = fread( $fp, 256 );
346 $magic = MimeMagic
::singleton();
347 $extMime = $magic->guessTypesForExtension( $this->mFinalExtension
);
348 $ieTypes = $magic->getIEMimeTypes( $this->mTempPath
, $chunk, $extMime );
349 foreach ( $ieTypes as $ieType ) {
350 if ( $this->checkFileExtension( $ieType, $wgMimeTypeBlacklist ) ) {
351 return array( 'filetype-bad-ie-mime', $ieType );
360 * Verifies that it's ok to include the uploaded file
362 * @return mixed true of the file is verified, array otherwise.
364 protected function verifyFile() {
365 global $wgAllowJavaUploads;
366 # get the title, even though we are doing nothing with it, because
367 # we need to populate mFinalExtension
370 $this->mFileProps
= File
::getPropsFromPath( $this->mTempPath
, $this->mFinalExtension
);
372 # check mime type, if desired
373 $mime = $this->mFileProps
[ 'file-mime' ];
374 $status = $this->verifyMimeType( $mime );
375 if ( $status !== true ) {
379 # check for htmlish code and javascript
380 if( self
::detectScript( $this->mTempPath
, $mime, $this->mFinalExtension
) ) {
381 return array( 'uploadscripted' );
383 if( $this->mFinalExtension
== 'svg' ||
$mime == 'image/svg+xml' ) {
384 if( $this->detectScriptInSvg( $this->mTempPath
) ) {
385 return array( 'uploadscripted' );
389 # Check for Java applets, which if uploaded can bypass cross-site
391 if ( !$wgAllowJavaUploads ) {
392 $this->mJavaDetected
= false;
393 $zipStatus = ZipDirectoryReader
::read( $this->mTempPath
,
394 array( $this, 'zipEntryCallback' ) );
395 if ( !$zipStatus->isOK() ) {
396 $errors = $zipStatus->getErrorsArray();
397 $error = reset( $errors );
398 if ( $error[0] !== 'zip-wrong-format' ) {
402 if ( $this->mJavaDetected
) {
403 return array( 'uploadjava' );
407 # Scan the uploaded file for viruses
408 $virus = $this->detectVirus( $this->mTempPath
);
410 return array( 'uploadvirus', $virus );
413 $handler = MediaHandler
::getHandler( $mime );
415 $handlerStatus = $handler->verifyUpload( $this->mTempPath
);
416 if ( !$handlerStatus->isOK() ) {
417 $errors = $handlerStatus->getErrorsArray();
418 return reset( $errors );
422 wfRunHooks( 'UploadVerifyFile', array( $this, $mime, &$status ) );
423 if ( $status !== true ) {
427 wfDebug( __METHOD__
. ": all clear; passing.\n" );
432 * Callback for ZipDirectoryReader to detect Java class files.
434 function zipEntryCallback( $entry ) {
435 $names = array( $entry['name'] );
437 // If there is a null character, cut off the name at it, because JDK's
438 // ZIP_GetEntry() uses strcmp() if the name hashes match. If a file name
439 // were constructed which had ".class\0" followed by a string chosen to
440 // make the hash collide with the truncated name, that file could be
441 // returned in response to a request for the .class file.
442 $nullPos = strpos( $entry['name'], "\000" );
443 if ( $nullPos !== false ) {
444 $names[] = substr( $entry['name'], 0, $nullPos );
447 // If there is a trailing slash in the file name, we have to strip it,
448 // because that's what ZIP_GetEntry() does.
449 if ( preg_grep( '!\.class/?$!', $names ) ) {
450 $this->mJavaDetected
= true;
455 * Alias for verifyTitlePermissions. The function was originally 'verifyPermissions'
456 * but that suggests it's checking the user, when it's really checking the title + user combination.
457 * @param $user User object to verify the permissions against
458 * @return mixed An array as returned by getUserPermissionsErrors or true
459 * in case the user has proper permissions.
461 public function verifyPermissions( $user ) {
462 return $this->verifyTitlePermissions( $user );
466 * Check whether the user can edit, upload and create the image. This
467 * checks only against the current title; if it returns errors, it may
468 * very well be that another title will not give errors. Therefore
469 * isAllowed() should be called as well for generic is-user-blocked or
470 * can-user-upload checking.
472 * @param $user User object to verify the permissions against
473 * @return mixed An array as returned by getUserPermissionsErrors or true
474 * in case the user has proper permissions.
476 public function verifyTitlePermissions( $user ) {
478 * If the image is protected, non-sysop users won't be able
479 * to modify it by uploading a new revision.
481 $nt = $this->getTitle();
482 if( is_null( $nt ) ) {
485 $permErrors = $nt->getUserPermissionsErrors( 'edit', $user );
486 $permErrorsUpload = $nt->getUserPermissionsErrors( 'upload', $user );
487 if ( !$nt->exists() ) {
488 $permErrorsCreate = $nt->getUserPermissionsErrors( 'createpage', $user );
490 $permErrorsCreate = array();
492 if( $permErrors ||
$permErrorsUpload ||
$permErrorsCreate ) {
493 $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsUpload, $permErrors ) );
494 $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsCreate, $permErrors ) );
498 $overwriteError = $this->checkOverwrite( $user );
499 if ( $overwriteError !== true ) {
500 return array( $overwriteError );
507 * Check for non fatal problems with the file
509 * @return Array of warnings
511 public function checkWarnings() {
516 $localFile = $this->getLocalFile();
517 $filename = $localFile->getName();
520 * Check whether the resulting filename is different from the desired one,
521 * but ignore things like ucfirst() and spaces/underscore things
523 $comparableName = str_replace( ' ', '_', $this->mDesiredDestName
);
524 $comparableName = Title
::capitalize( $comparableName, NS_FILE
);
526 if( $this->mDesiredDestName
!= $filename && $comparableName != $filename ) {
527 $warnings['badfilename'] = $filename;
530 // Check whether the file extension is on the unwanted list
531 global $wgCheckFileExtensions, $wgFileExtensions;
532 if ( $wgCheckFileExtensions ) {
533 if ( !$this->checkFileExtension( $this->mFinalExtension
, $wgFileExtensions ) ) {
534 $warnings['filetype-unwanted-type'] = array( $this->mFinalExtension
,
535 $wgLang->commaList( $wgFileExtensions ) );
539 global $wgUploadSizeWarning;
540 if ( $wgUploadSizeWarning && ( $this->mFileSize
> $wgUploadSizeWarning ) ) {
541 $warnings['large-file'] = $wgUploadSizeWarning;
544 if ( $this->mFileSize
== 0 ) {
545 $warnings['emptyfile'] = true;
548 $exists = self
::getExistsWarning( $localFile );
549 if( $exists !== false ) {
550 $warnings['exists'] = $exists;
553 // Check dupes against existing files
554 $hash = File
::sha1Base36( $this->mTempPath
);
555 $dupes = RepoGroup
::singleton()->findBySha1( $hash );
556 $title = $this->getTitle();
557 // Remove all matches against self
558 foreach ( $dupes as $key => $dupe ) {
559 if( $title->equals( $dupe->getTitle() ) ) {
560 unset( $dupes[$key] );
564 $warnings['duplicate'] = $dupes;
567 // Check dupes against archives
568 $archivedImage = new ArchivedFile( null, 0, "{$hash}.{$this->mFinalExtension}" );
569 if ( $archivedImage->getID() > 0 ) {
570 $warnings['duplicate-archive'] = $archivedImage->getName();
577 * Really perform the upload. Stores the file in the local repo, watches
578 * if necessary and runs the UploadComplete hook.
582 * @return Status indicating the whether the upload succeeded.
584 public function performUpload( $comment, $pageText, $watch, $user ) {
585 $status = $this->getLocalFile()->upload(
595 if( $status->isGood() ) {
597 $user->addWatch( $this->getLocalFile()->getTitle() );
600 wfRunHooks( 'UploadComplete', array( &$this ) );
607 * Returns the title of the file to be uploaded. Sets mTitleError in case
608 * the name was illegal.
610 * @return Title The title of the file or null in case the name was illegal
612 public function getTitle() {
613 if ( $this->mTitle
!== false ) {
614 return $this->mTitle
;
617 /* Assume that if a user specified File:Something.jpg, this is an error
618 * and that the namespace prefix needs to be stripped of.
620 $title = Title
::newFromText( $this->mDesiredDestName
);
621 if ( $title->getNamespace() == NS_FILE
) {
622 $this->mFilteredName
= $title->getDBkey();
624 $this->mFilteredName
= $this->mDesiredDestName
;
628 * Chop off any directories in the given filename. Then
629 * filter out illegal characters, and try to make a legible name
630 * out of it. We'll strip some silently that Title would die on.
632 $this->mFilteredName
= wfStripIllegalFilenameChars( $this->mFilteredName
);
633 /* Normalize to title form before we do any further processing */
634 $nt = Title
::makeTitleSafe( NS_FILE
, $this->mFilteredName
);
635 if( is_null( $nt ) ) {
636 $this->mTitleError
= self
::ILLEGAL_FILENAME
;
637 return $this->mTitle
= null;
639 $this->mFilteredName
= $nt->getDBkey();
642 * We'll want to blacklist against *any* 'extension', and use
643 * only the final one for the whitelist.
645 list( $partname, $ext ) = $this->splitExtensions( $this->mFilteredName
);
647 if( count( $ext ) ) {
648 $this->mFinalExtension
= trim( $ext[count( $ext ) - 1] );
650 $this->mFinalExtension
= '';
652 # No extension, try guessing one
653 $magic = MimeMagic
::singleton();
654 $mime = $magic->guessMimeType( $this->mTempPath
);
655 if ( $mime !== 'unknown/unknown' ) {
656 # Get a space separated list of extensions
657 $extList = $magic->getExtensionsForType( $mime );
659 # Set the extension to the canonical extension
660 $this->mFinalExtension
= strtok( $extList, ' ' );
662 # Fix up the other variables
663 $this->mFilteredName
.= ".{$this->mFinalExtension}";
664 $nt = Title
::makeTitleSafe( NS_FILE
, $this->mFilteredName
);
665 $ext = array( $this->mFinalExtension
);
671 /* Don't allow users to override the blacklist (check file extension) */
672 global $wgCheckFileExtensions, $wgStrictFileExtensions;
673 global $wgFileExtensions, $wgFileBlacklist;
675 $blackListedExtensions = $this->checkFileExtensionList( $ext, $wgFileBlacklist );
677 if ( $this->mFinalExtension
== '' ) {
678 $this->mTitleError
= self
::FILETYPE_MISSING
;
679 return $this->mTitle
= null;
680 } elseif ( $blackListedExtensions ||
681 ( $wgCheckFileExtensions && $wgStrictFileExtensions &&
682 !$this->checkFileExtension( $this->mFinalExtension
, $wgFileExtensions ) ) ) {
683 $this->mBlackListedExtensions
= $blackListedExtensions;
684 $this->mTitleError
= self
::FILETYPE_BADTYPE
;
685 return $this->mTitle
= null;
688 // Windows may be broken with special characters, see bug XXX
689 if ( wfIsWindows() && !preg_match( '/^[\x0-\x7f]*$/', $nt->getText() ) ) {
690 $this->mTitleError
= self
::WINDOWS_NONASCII_FILENAME
;
691 return $this->mTitle
= null;
694 # If there was more than one "extension", reassemble the base
695 # filename to prevent bogus complaints about length
696 if( count( $ext ) > 1 ) {
697 for( $i = 0; $i < count( $ext ) - 1; $i++
) {
698 $partname .= '.' . $ext[$i];
702 if( strlen( $partname ) < 1 ) {
703 $this->mTitleError
= self
::MIN_LENGTH_PARTNAME
;
704 return $this->mTitle
= null;
707 return $this->mTitle
= $nt;
711 * Return the local file and initializes if necessary.
715 public function getLocalFile() {
716 if( is_null( $this->mLocalFile
) ) {
717 $nt = $this->getTitle();
718 $this->mLocalFile
= is_null( $nt ) ?
null : wfLocalFile( $nt );
720 return $this->mLocalFile
;
724 * NOTE: Probably should be deprecated in favor of UploadStash, but this is sometimes
725 * called outside that context.
727 * Stash a file in a temporary directory for later processing
728 * after the user has confirmed it.
730 * If the user doesn't explicitly cancel or accept, these files
731 * can accumulate in the temp directory.
733 * @param $saveName String: the destination filename
734 * @param $tempSrc String: the source temporary file to save
735 * @return String: full path the stashed file, or false on failure
737 protected function saveTempUploadedFile( $saveName, $tempSrc ) {
738 $repo = RepoGroup
::singleton()->getLocalRepo();
739 $status = $repo->storeTemp( $saveName, $tempSrc );
744 * If the user does not supply all necessary information in the first upload form submission (either by accident or
745 * by design) then we may want to stash the file temporarily, get more information, and publish the file later.
747 * This method will stash a file in a temporary directory for later processing, and save the necessary descriptive info
748 * into the user's session.
749 * This method returns the file object, which also has a 'sessionKey' property which can be passed through a form or
750 * API request to find this stashed file again.
752 * @param $key String: (optional) the session key used to find the file info again. If not supplied, a key will be autogenerated.
753 * @return UploadStashFile stashed file
755 public function stashSessionFile( $key = null ) {
756 $stash = RepoGroup
::singleton()->getLocalRepo()->getUploadStash();
758 'mFileProps' => $this->mFileProps
,
759 'mSourceType' => $this->getSourceType(),
761 $file = $stash->stashFile( $this->mTempPath
, $data, $key );
762 $this->mLocalFile
= $file;
767 * Stash a file in a temporary directory, returning a key which can be used to find the file again. See stashSessionFile().
769 * @param $key String: (optional) the session key used to find the file info again. If not supplied, a key will be autogenerated.
770 * @return String: session key
772 public function stashSession( $key = null ) {
773 return $this->stashSessionFile( $key )->getSessionKey();
777 * If we've modified the upload file we need to manually remove it
778 * on exit to clean up.
780 public function cleanupTempFile() {
781 if ( $this->mRemoveTempFile
&& $this->mTempPath
&& file_exists( $this->mTempPath
) ) {
782 wfDebug( __METHOD__
. ": Removing temporary file {$this->mTempPath}\n" );
783 unlink( $this->mTempPath
);
787 public function getTempPath() {
788 return $this->mTempPath
;
792 * Split a file into a base name and all dot-delimited 'extensions'
793 * on the end. Some web server configurations will fall back to
794 * earlier pseudo-'extensions' to determine type and execute
795 * scripts, so the blacklist needs to check them all.
799 public static function splitExtensions( $filename ) {
800 $bits = explode( '.', $filename );
801 $basename = array_shift( $bits );
802 return array( $basename, $bits );
806 * Perform case-insensitive match against a list of file extensions.
807 * Returns true if the extension is in the list.
813 public static function checkFileExtension( $ext, $list ) {
814 return in_array( strtolower( $ext ), $list );
818 * Perform case-insensitive match against a list of file extensions.
819 * Returns an array of matching extensions.
825 public static function checkFileExtensionList( $ext, $list ) {
826 return array_intersect( array_map( 'strtolower', $ext ), $list );
830 * Checks if the mime type of the uploaded file matches the file extension.
832 * @param $mime String: the mime type of the uploaded file
833 * @param $extension String: the filename extension that the file is to be served with
836 public static function verifyExtension( $mime, $extension ) {
837 $magic = MimeMagic
::singleton();
839 if ( !$mime ||
$mime == 'unknown' ||
$mime == 'unknown/unknown' )
840 if ( !$magic->isRecognizableExtension( $extension ) ) {
841 wfDebug( __METHOD__
. ": passing file with unknown detected mime type; " .
842 "unrecognized extension '$extension', can't verify\n" );
845 wfDebug( __METHOD__
. ": rejecting file with unknown detected mime type; ".
846 "recognized extension '$extension', so probably invalid file\n" );
850 $match = $magic->isMatchingExtension( $extension, $mime );
852 if ( $match === null ) {
853 wfDebug( __METHOD__
. ": no file extension known for mime type $mime, passing file\n" );
855 } elseif( $match === true ) {
856 wfDebug( __METHOD__
. ": mime type $mime matches extension $extension, passing file\n" );
858 #TODO: if it's a bitmap, make sure PHP or ImageMagic resp. can handle it!
862 wfDebug( __METHOD__
. ": mime type $mime mismatches file extension $extension, rejecting file\n" );
868 * Heuristic for detecting files that *could* contain JavaScript instructions or
869 * things that may look like HTML to a browser and are thus
870 * potentially harmful. The present implementation will produce false
871 * positives in some situations.
873 * @param $file String: pathname to the temporary upload file
874 * @param $mime String: the mime type of the file
875 * @param $extension String: the extension of the file
876 * @return Boolean: true if the file contains something looking like embedded scripts
878 public static function detectScript( $file, $mime, $extension ) {
879 global $wgAllowTitlesInSVG;
881 # ugly hack: for text files, always look at the entire file.
882 # For binary field, just check the first K.
884 if( strpos( $mime,'text/' ) === 0 ) {
885 $chunk = file_get_contents( $file );
887 $fp = fopen( $file, 'rb' );
888 $chunk = fread( $fp, 1024 );
892 $chunk = strtolower( $chunk );
898 # decode from UTF-16 if needed (could be used for obfuscation).
899 if( substr( $chunk, 0, 2 ) == "\xfe\xff" ) {
901 } elseif( substr( $chunk, 0, 2 ) == "\xff\xfe" ) {
908 $chunk = iconv( $enc, "ASCII//IGNORE", $chunk );
911 $chunk = trim( $chunk );
913 # @todo FIXME: Convert from UTF-16 if necessarry!
914 wfDebug( __METHOD__
. ": checking for embedded scripts and HTML stuff\n" );
916 # check for HTML doctype
917 if ( preg_match( "/<!DOCTYPE *X?HTML/i", $chunk ) ) {
922 * Internet Explorer for Windows performs some really stupid file type
923 * autodetection which can cause it to interpret valid image files as HTML
924 * and potentially execute JavaScript, creating a cross-site scripting
927 * Apple's Safari browser also performs some unsafe file type autodetection
928 * which can cause legitimate files to be interpreted as HTML if the
929 * web server is not correctly configured to send the right content-type
930 * (or if you're really uploading plain text and octet streams!)
932 * Returns true if IE is likely to mistake the given file for HTML.
933 * Also returns true if Safari would mistake the given file for HTML
934 * when served with a generic content-type.
940 '<html', #also in safari
943 '<script', #also in safari
947 if( !$wgAllowTitlesInSVG && $extension !== 'svg' && $mime !== 'image/svg' ) {
951 foreach( $tags as $tag ) {
952 if( false !== strpos( $chunk, $tag ) ) {
953 wfDebug( __METHOD__
. ": found something that may make it be mistaken for html: $tag\n" );
959 * look for JavaScript
962 # resolve entity-refs to look at attributes. may be harsh on big files... cache result?
963 $chunk = Sanitizer
::decodeCharReferences( $chunk );
965 # look for script-types
966 if( preg_match( '!type\s*=\s*[\'"]?\s*(?:\w*/)?(?:ecma|java)!sim', $chunk ) ) {
967 wfDebug( __METHOD__
. ": found script types\n" );
971 # look for html-style script-urls
972 if( preg_match( '!(?:href|src|data)\s*=\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
973 wfDebug( __METHOD__
. ": found html-style script urls\n" );
977 # look for css-style script-urls
978 if( preg_match( '!url\s*\(\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
979 wfDebug( __METHOD__
. ": found css-style script urls\n" );
983 wfDebug( __METHOD__
. ": no scripts found\n" );
987 protected function detectScriptInSvg( $filename ) {
988 $check = new XmlTypeCheck( $filename, array( $this, 'checkSvgScriptCallback' ) );
989 return $check->filterMatch
;
993 * @todo Replace this with a whitelist filter!
995 public function checkSvgScriptCallback( $element, $attribs ) {
996 $stripped = $this->stripXmlNamespace( $element );
998 if( $stripped == 'script' ) {
999 wfDebug( __METHOD__
. ": Found script element '$element' in uploaded file.\n" );
1003 foreach( $attribs as $attrib => $value ) {
1004 $stripped = $this->stripXmlNamespace( $attrib );
1005 if( substr( $stripped, 0, 2 ) == 'on' ) {
1006 wfDebug( __METHOD__
. ": Found script attribute '$attrib'='value' in uploaded file.\n" );
1009 if( $stripped == 'href' && strpos( strtolower( $value ), 'javascript:' ) !== false ) {
1010 wfDebug( __METHOD__
. ": Found script href attribute '$attrib'='$value' in uploaded file.\n" );
1016 private function stripXmlNamespace( $name ) {
1017 // 'http://www.w3.org/2000/svg:script' -> 'script'
1018 $parts = explode( ':', strtolower( $name ) );
1019 return array_pop( $parts );
1023 * Generic wrapper function for a virus scanner program.
1024 * This relies on the $wgAntivirus and $wgAntivirusSetup variables.
1025 * $wgAntivirusRequired may be used to deny upload if the scan fails.
1027 * @param $file String: pathname to the temporary upload file
1028 * @return mixed false if not virus is found, NULL if the scan fails or is disabled,
1029 * or a string containing feedback from the virus scanner if a virus was found.
1030 * If textual feedback is missing but a virus was found, this function returns true.
1032 public static function detectVirus( $file ) {
1033 global $wgAntivirus, $wgAntivirusSetup, $wgAntivirusRequired, $wgOut;
1035 if ( !$wgAntivirus ) {
1036 wfDebug( __METHOD__
. ": virus scanner disabled\n" );
1040 if ( !$wgAntivirusSetup[$wgAntivirus] ) {
1041 wfDebug( __METHOD__
. ": unknown virus scanner: $wgAntivirus\n" );
1042 $wgOut->wrapWikiMsg( "<div class=\"error\">\n$1\n</div>",
1043 array( 'virus-badscanner', $wgAntivirus ) );
1044 return wfMsg( 'virus-unknownscanner' ) . " $wgAntivirus";
1047 # look up scanner configuration
1048 $command = $wgAntivirusSetup[$wgAntivirus]['command'];
1049 $exitCodeMap = $wgAntivirusSetup[$wgAntivirus]['codemap'];
1050 $msgPattern = isset( $wgAntivirusSetup[$wgAntivirus]['messagepattern'] ) ?
1051 $wgAntivirusSetup[$wgAntivirus]['messagepattern'] : null;
1053 if ( strpos( $command, "%f" ) === false ) {
1054 # simple pattern: append file to scan
1055 $command .= " " . wfEscapeShellArg( $file );
1057 # complex pattern: replace "%f" with file to scan
1058 $command = str_replace( "%f", wfEscapeShellArg( $file ), $command );
1061 wfDebug( __METHOD__
. ": running virus scan: $command \n" );
1063 # execute virus scanner
1066 # NOTE: there's a 50 line workaround to make stderr redirection work on windows, too.
1067 # that does not seem to be worth the pain.
1068 # Ask me (Duesentrieb) about it if it's ever needed.
1069 $output = wfShellExec( "$command 2>&1", $exitCode );
1071 # map exit code to AV_xxx constants.
1072 $mappedCode = $exitCode;
1073 if ( $exitCodeMap ) {
1074 if ( isset( $exitCodeMap[$exitCode] ) ) {
1075 $mappedCode = $exitCodeMap[$exitCode];
1076 } elseif ( isset( $exitCodeMap["*"] ) ) {
1077 $mappedCode = $exitCodeMap["*"];
1081 if ( $mappedCode === AV_SCAN_FAILED
) {
1082 # scan failed (code was mapped to false by $exitCodeMap)
1083 wfDebug( __METHOD__
. ": failed to scan $file (code $exitCode).\n" );
1085 if ( $wgAntivirusRequired ) {
1086 return wfMsg( 'virus-scanfailed', array( $exitCode ) );
1090 } elseif ( $mappedCode === AV_SCAN_ABORTED
) {
1091 # scan failed because filetype is unknown (probably imune)
1092 wfDebug( __METHOD__
. ": unsupported file type $file (code $exitCode).\n" );
1094 } elseif ( $mappedCode === AV_NO_VIRUS
) {
1096 wfDebug( __METHOD__
. ": file passed virus scan.\n" );
1099 $output = trim( $output );
1102 $output = true; #if there's no output, return true
1103 } elseif ( $msgPattern ) {
1105 if ( preg_match( $msgPattern, $output, $groups ) ) {
1107 $output = $groups[1];
1112 wfDebug( __METHOD__
. ": FOUND VIRUS! scanner feedback: $output \n" );
1118 * Check if there's an overwrite conflict and, if so, if restrictions
1119 * forbid this user from performing the upload.
1123 * @return mixed true on success, array on failure
1125 private function checkOverwrite( $user ) {
1126 // First check whether the local file can be overwritten
1127 $file = $this->getLocalFile();
1128 if( $file->exists() ) {
1129 if( !self
::userCanReUpload( $user, $file ) ) {
1130 return array( 'fileexists-forbidden', $file->getName() );
1136 /* Check shared conflicts: if the local file does not exist, but
1137 * wfFindFile finds a file, it exists in a shared repository.
1139 $file = wfFindFile( $this->getTitle() );
1140 if ( $file && !$user->isAllowed( 'reupload-shared' ) ) {
1141 return array( 'fileexists-shared-forbidden', $file->getName() );
1148 * Check if a user is the last uploader
1150 * @param $user User object
1151 * @param $img String: image name
1154 public static function userCanReUpload( User
$user, $img ) {
1155 if( $user->isAllowed( 'reupload' ) ) {
1156 return true; // non-conditional
1158 if( !$user->isAllowed( 'reupload-own' ) ) {
1161 if( is_string( $img ) ) {
1162 $img = wfLocalFile( $img );
1164 if ( !( $img instanceof LocalFile
) ) {
1168 return $user->getId() == $img->getUser( 'id' );
1172 * Helper function that does various existence checks for a file.
1173 * The following checks are performed:
1175 * - Article with the same name as the file exists
1176 * - File exists with normalized extension
1177 * - The file looks like a thumbnail and the original exists
1179 * @param $file File The File object to check
1180 * @return mixed False if the file does not exists, else an array
1182 public static function getExistsWarning( $file ) {
1183 if( $file->exists() ) {
1184 return array( 'warning' => 'exists', 'file' => $file );
1187 if( $file->getTitle()->getArticleID() ) {
1188 return array( 'warning' => 'page-exists', 'file' => $file );
1191 if ( $file->wasDeleted() && !$file->exists() ) {
1192 return array( 'warning' => 'was-deleted', 'file' => $file );
1195 if( strpos( $file->getName(), '.' ) == false ) {
1196 $partname = $file->getName();
1199 $n = strrpos( $file->getName(), '.' );
1200 $extension = substr( $file->getName(), $n +
1 );
1201 $partname = substr( $file->getName(), 0, $n );
1203 $normalizedExtension = File
::normalizeExtension( $extension );
1205 if ( $normalizedExtension != $extension ) {
1206 // We're not using the normalized form of the extension.
1207 // Normal form is lowercase, using most common of alternate
1208 // extensions (eg 'jpg' rather than 'JPEG').
1210 // Check for another file using the normalized form...
1211 $nt_lc = Title
::makeTitle( NS_FILE
, "{$partname}.{$normalizedExtension}" );
1212 $file_lc = wfLocalFile( $nt_lc );
1214 if( $file_lc->exists() ) {
1216 'warning' => 'exists-normalized',
1218 'normalizedFile' => $file_lc
1223 if ( self
::isThumbName( $file->getName() ) ) {
1224 # Check for filenames like 50px- or 180px-, these are mostly thumbnails
1225 $nt_thb = Title
::newFromText( substr( $partname , strpos( $partname , '-' ) +
1 ) . '.' . $extension, NS_FILE
);
1226 $file_thb = wfLocalFile( $nt_thb );
1227 if( $file_thb->exists() ) {
1229 'warning' => 'thumb',
1231 'thumbFile' => $file_thb
1234 // File does not exist, but we just don't like the name
1236 'warning' => 'thumb-name',
1238 'thumbFile' => $file_thb
1244 foreach( self
::getFilenamePrefixBlacklist() as $prefix ) {
1245 if ( substr( $partname, 0, strlen( $prefix ) ) == $prefix ) {
1247 'warning' => 'bad-prefix',
1258 * Helper function that checks whether the filename looks like a thumbnail
1260 public static function isThumbName( $filename ) {
1261 $n = strrpos( $filename, '.' );
1262 $partname = $n ?
substr( $filename, 0, $n ) : $filename;
1264 substr( $partname , 3, 3 ) == 'px-' ||
1265 substr( $partname , 2, 3 ) == 'px-'
1267 preg_match( "/[0-9]{2}/" , substr( $partname , 0, 2 ) );
1271 * Get a list of blacklisted filename prefixes from [[MediaWiki:Filename-prefix-blacklist]]
1273 * @return array list of prefixes
1275 public static function getFilenamePrefixBlacklist() {
1276 $blacklist = array();
1277 $message = wfMessage( 'filename-prefix-blacklist' )->inContentLanguage();
1278 if( !$message->isDisabled() ) {
1279 $lines = explode( "\n", $message->plain() );
1280 foreach( $lines as $line ) {
1281 // Remove comment lines
1282 $comment = substr( trim( $line ), 0, 1 );
1283 if ( $comment == '#' ||
$comment == '' ) {
1286 // Remove additional comments after a prefix
1287 $comment = strpos( $line, '#' );
1288 if ( $comment > 0 ) {
1289 $line = substr( $line, 0, $comment-1 );
1291 $blacklist[] = trim( $line );
1298 * Gets image info about the file just uploaded.
1300 * Also has the effect of setting metadata to be an 'indexed tag name' in returned API result if
1301 * 'metadata' was requested. Oddly, we have to pass the "result" object down just so it can do that
1302 * with the appropriate format, presumably.
1304 * @param $result ApiResult:
1305 * @return Array: image info
1307 public function getImageInfo( $result ) {
1308 $file = $this->getLocalFile();
1309 // TODO This cries out for refactoring. We really want to say $file->getAllInfo(); here.
1310 // Perhaps "info" methods should be moved into files, and the API should just wrap them in queries.
1311 if ( $file instanceof UploadStashFile
) {
1312 $imParam = ApiQueryStashImageInfo
::getPropertyNames();
1313 $info = ApiQueryStashImageInfo
::getInfo( $file, array_flip( $imParam ), $result );
1315 $imParam = ApiQueryImageInfo
::getPropertyNames();
1316 $info = ApiQueryImageInfo
::getInfo( $file, array_flip( $imParam ), $result );
1322 public function convertVerifyErrorToStatus( $error ) {
1323 $code = $error['status'];
1324 unset( $code['status'] );
1325 return Status
::newFatal( $this->getVerificationErrorCode( $code ), $error );
1328 public static function getMaxUploadSize( $forType = null ) {
1329 global $wgMaxUploadSize;
1331 if ( is_array( $wgMaxUploadSize ) ) {
1332 if ( !is_null( $forType ) && isset( $wgMaxUploadSize[$forType] ) ) {
1333 return $wgMaxUploadSize[$forType];
1335 return $wgMaxUploadSize['*'];
1338 return intval( $wgMaxUploadSize );