3 * Base class for the backend of file upload.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
25 * @defgroup Upload Upload related
31 * UploadBase and subclasses are the backend of MediaWiki's file uploads.
32 * The frontends are formed by ApiUpload and SpecialUpload.
34 * @author Brion Vibber
35 * @author Bryan Tong Minh
36 * @author Michael Dale
38 abstract class UploadBase
{
40 protected $mDesiredDestName, $mDestName, $mRemoveTempFile, $mSourceType;
41 protected $mTitle = false, $mTitleError = 0;
42 protected $mFilteredName, $mFinalExtension;
43 protected $mLocalFile, $mFileSize, $mFileProps;
44 protected $mBlackListedExtensions;
45 protected $mJavaDetected, $mSVGNSError;
47 protected static $safeXmlEncodings = array(
58 const MIN_LENGTH_PARTNAME
= 4;
59 const ILLEGAL_FILENAME
= 5;
60 const OVERWRITE_EXISTING_FILE
= 7; # Not used anymore; handled by verifyTitlePermissions()
61 const FILETYPE_MISSING
= 8;
62 const FILETYPE_BADTYPE
= 9;
63 const VERIFICATION_ERROR
= 10;
65 # HOOK_ABORTED is the new name of UPLOAD_VERIFICATION_ERROR
66 const UPLOAD_VERIFICATION_ERROR
= 11;
67 const HOOK_ABORTED
= 11;
68 const FILE_TOO_LARGE
= 12;
69 const WINDOWS_NONASCII_FILENAME
= 13;
70 const FILENAME_TOO_LONG
= 14;
76 public function getVerificationErrorCode( $error ) {
77 $code_to_status = array(
78 self
::EMPTY_FILE
=> 'empty-file',
79 self
::FILE_TOO_LARGE
=> 'file-too-large',
80 self
::FILETYPE_MISSING
=> 'filetype-missing',
81 self
::FILETYPE_BADTYPE
=> 'filetype-banned',
82 self
::MIN_LENGTH_PARTNAME
=> 'filename-tooshort',
83 self
::ILLEGAL_FILENAME
=> 'illegal-filename',
84 self
::OVERWRITE_EXISTING_FILE
=> 'overwrite',
85 self
::VERIFICATION_ERROR
=> 'verification-error',
86 self
::HOOK_ABORTED
=> 'hookaborted',
87 self
::WINDOWS_NONASCII_FILENAME
=> 'windows-nonascii-filename',
88 self
::FILENAME_TOO_LONG
=> 'filename-toolong',
90 if ( isset( $code_to_status[$error] ) ) {
91 return $code_to_status[$error];
94 return 'unknown-error';
98 * Returns true if uploads are enabled.
99 * Can be override by subclasses.
102 public static function isEnabled() {
103 global $wgEnableUploads;
105 if ( !$wgEnableUploads ) {
109 # Check php's file_uploads setting
110 return wfIsHHVM() ||
wfIniGetBool( 'file_uploads' );
114 * Returns true if the user can use this upload module or else a string
115 * identifying the missing permission.
116 * Can be overridden by subclasses.
119 * @return bool|string
121 public static function isAllowed( $user ) {
122 foreach ( array( 'upload', 'edit' ) as $permission ) {
123 if ( !$user->isAllowed( $permission ) ) {
131 // Upload handlers. Should probably just be a global.
132 private static $uploadHandlers = array( 'Stash', 'File', 'Url' );
135 * Create a form of UploadBase depending on wpSourceType and initializes it
137 * @param WebRequest $request
138 * @param string|null $type
139 * @return null|UploadBase
141 public static function createFromRequest( &$request, $type = null ) {
142 $type = $type ?
$type : $request->getVal( 'wpSourceType', 'File' );
148 // Get the upload class
149 $type = ucfirst( $type );
151 // Give hooks the chance to handle this request
153 wfRunHooks( 'UploadCreateFromRequest', array( $type, &$className ) );
154 if ( is_null( $className ) ) {
155 $className = 'UploadFrom' . $type;
156 wfDebug( __METHOD__
. ": class name: $className\n" );
157 if ( !in_array( $type, self
::$uploadHandlers ) ) {
162 // Check whether this upload class is enabled
163 if ( !call_user_func( array( $className, 'isEnabled' ) ) ) {
167 // Check whether the request is valid
168 if ( !call_user_func( array( $className, 'isValidRequest' ), $request ) ) {
172 /** @var UploadBase $handler */
173 $handler = new $className;
175 $handler->initializeFromRequest( $request );
181 * Check whether a request if valid for this handler
182 * @param WebRequest $request
185 public static function isValidRequest( $request ) {
189 public function __construct() {
193 * Returns the upload type. Should be overridden by child classes
198 public function getSourceType() {
203 * Initialize the path information
204 * @param string $name The desired destination name
205 * @param string $tempPath The temporary path
206 * @param int $fileSize The file size
207 * @param bool $removeTempFile (false) remove the temporary file?
208 * @throws MWException
210 public function initializePathInfo( $name, $tempPath, $fileSize, $removeTempFile = false ) {
211 $this->mDesiredDestName
= $name;
212 if ( FileBackend
::isStoragePath( $tempPath ) ) {
213 throw new MWException( __METHOD__
. " given storage path `$tempPath`." );
215 $this->mTempPath
= $tempPath;
216 $this->mFileSize
= $fileSize;
217 $this->mRemoveTempFile
= $removeTempFile;
221 * Initialize from a WebRequest. Override this in a subclass.
223 * @param WebRequest $request
225 abstract public function initializeFromRequest( &$request );
228 * Fetch the file. Usually a no-op
231 public function fetchFile() {
232 return Status
::newGood();
236 * Return true if the file is empty
239 public function isEmptyFile() {
240 return empty( $this->mFileSize
);
244 * Return the file size
247 public function getFileSize() {
248 return $this->mFileSize
;
252 * Get the base 36 SHA1 of the file
255 public function getTempFileSha1Base36() {
256 return FSFile
::getSha1Base36FromPath( $this->mTempPath
);
260 * @param string $srcPath The source path
261 * @return string|bool The real path if it was a virtual URL Returns false on failure
263 function getRealPath( $srcPath ) {
264 wfProfileIn( __METHOD__
);
265 $repo = RepoGroup
::singleton()->getLocalRepo();
266 if ( $repo->isVirtualUrl( $srcPath ) ) {
267 /** @todo Just make uploads work with storage paths UploadFromStash
268 * loads files via virtual URLs.
270 $tmpFile = $repo->getLocalCopy( $srcPath );
272 $tmpFile->bind( $this ); // keep alive with $this
274 $path = $tmpFile ?
$tmpFile->getPath() : false;
278 wfProfileOut( __METHOD__
);
284 * Verify whether the upload is sane.
285 * @return mixed Const self::OK or else an array with error information
287 public function verifyUpload() {
288 wfProfileIn( __METHOD__
);
291 * If there was no filename or a zero size given, give up quick.
293 if ( $this->isEmptyFile() ) {
294 wfProfileOut( __METHOD__
);
296 return array( 'status' => self
::EMPTY_FILE
);
300 * Honor $wgMaxUploadSize
302 $maxSize = self
::getMaxUploadSize( $this->getSourceType() );
303 if ( $this->mFileSize
> $maxSize ) {
304 wfProfileOut( __METHOD__
);
307 'status' => self
::FILE_TOO_LARGE
,
313 * Look at the contents of the file; if we can recognize the
314 * type but it's corrupt or data of the wrong type, we should
315 * probably not accept it.
317 $verification = $this->verifyFile();
318 if ( $verification !== true ) {
319 wfProfileOut( __METHOD__
);
322 'status' => self
::VERIFICATION_ERROR
,
323 'details' => $verification
328 * Make sure this file can be created
330 $result = $this->validateName();
331 if ( $result !== true ) {
332 wfProfileOut( __METHOD__
);
338 if ( !wfRunHooks( 'UploadVerification',
339 array( $this->mDestName
, $this->mTempPath
, &$error ) )
341 wfProfileOut( __METHOD__
);
343 return array( 'status' => self
::HOOK_ABORTED
, 'error' => $error );
346 wfProfileOut( __METHOD__
);
348 return array( 'status' => self
::OK
);
352 * Verify that the name is valid and, if necessary, that we can overwrite
354 * @return mixed True if valid, otherwise and array with 'status'
357 public function validateName() {
358 $nt = $this->getTitle();
359 if ( is_null( $nt ) ) {
360 $result = array( 'status' => $this->mTitleError
);
361 if ( $this->mTitleError
== self
::ILLEGAL_FILENAME
) {
362 $result['filtered'] = $this->mFilteredName
;
364 if ( $this->mTitleError
== self
::FILETYPE_BADTYPE
) {
365 $result['finalExt'] = $this->mFinalExtension
;
366 if ( count( $this->mBlackListedExtensions
) ) {
367 $result['blacklistedExt'] = $this->mBlackListedExtensions
;
373 $this->mDestName
= $this->getLocalFile()->getName();
379 * Verify the MIME type.
381 * @note Only checks that it is not an evil MIME. The "does it have
382 * correct extension given its MIME type?" check is in verifyFile.
383 * in `verifyFile()` that MIME type and file extension correlate.
384 * @param string $mime Representing the MIME
385 * @return mixed True if the file is verified, an array otherwise
387 protected function verifyMimeType( $mime ) {
388 global $wgVerifyMimeType;
389 wfProfileIn( __METHOD__
);
390 if ( $wgVerifyMimeType ) {
391 wfDebug( "mime: <$mime> extension: <{$this->mFinalExtension}>\n" );
392 global $wgMimeTypeBlacklist;
393 if ( $this->checkFileExtension( $mime, $wgMimeTypeBlacklist ) ) {
394 wfProfileOut( __METHOD__
);
396 return array( 'filetype-badmime', $mime );
399 # Check what Internet Explorer would detect
400 $fp = fopen( $this->mTempPath
, 'rb' );
401 $chunk = fread( $fp, 256 );
404 $magic = MimeMagic
::singleton();
405 $extMime = $magic->guessTypesForExtension( $this->mFinalExtension
);
406 $ieTypes = $magic->getIEMimeTypes( $this->mTempPath
, $chunk, $extMime );
407 foreach ( $ieTypes as $ieType ) {
408 if ( $this->checkFileExtension( $ieType, $wgMimeTypeBlacklist ) ) {
409 wfProfileOut( __METHOD__
);
411 return array( 'filetype-bad-ie-mime', $ieType );
416 wfProfileOut( __METHOD__
);
422 * Verifies that it's ok to include the uploaded file
424 * @return mixed True of the file is verified, array otherwise.
426 protected function verifyFile() {
427 global $wgVerifyMimeType;
428 wfProfileIn( __METHOD__
);
430 $status = $this->verifyPartialFile();
431 if ( $status !== true ) {
432 wfProfileOut( __METHOD__
);
437 $this->mFileProps
= FSFile
::getPropsFromPath( $this->mTempPath
, $this->mFinalExtension
);
438 $mime = $this->mFileProps
['mime'];
440 if ( $wgVerifyMimeType ) {
441 # XXX: Missing extension will be caught by validateName() via getTitle()
442 if ( $this->mFinalExtension
!= '' && !$this->verifyExtension( $mime, $this->mFinalExtension
) ) {
443 wfProfileOut( __METHOD__
);
445 return array( 'filetype-mime-mismatch', $this->mFinalExtension
, $mime );
449 $handler = MediaHandler
::getHandler( $mime );
451 $handlerStatus = $handler->verifyUpload( $this->mTempPath
);
452 if ( !$handlerStatus->isOK() ) {
453 $errors = $handlerStatus->getErrorsArray();
454 wfProfileOut( __METHOD__
);
456 return reset( $errors );
460 wfRunHooks( 'UploadVerifyFile', array( $this, $mime, &$status ) );
461 if ( $status !== true ) {
462 wfProfileOut( __METHOD__
);
467 wfDebug( __METHOD__
. ": all clear; passing.\n" );
468 wfProfileOut( __METHOD__
);
474 * A verification routine suitable for partial files
476 * Runs the blacklist checks, but not any checks that may
477 * assume the entire file is present.
479 * @return mixed True for valid or array with error message key.
481 protected function verifyPartialFile() {
482 global $wgAllowJavaUploads, $wgDisableUploadScriptChecks;
483 wfProfileIn( __METHOD__
);
485 # getTitle() sets some internal parameters like $this->mFinalExtension
488 $this->mFileProps
= FSFile
::getPropsFromPath( $this->mTempPath
, $this->mFinalExtension
);
490 # check MIME type, if desired
491 $mime = $this->mFileProps
['file-mime'];
492 $status = $this->verifyMimeType( $mime );
493 if ( $status !== true ) {
494 wfProfileOut( __METHOD__
);
499 # check for htmlish code and javascript
500 if ( !$wgDisableUploadScriptChecks ) {
501 if ( self
::detectScript( $this->mTempPath
, $mime, $this->mFinalExtension
) ) {
502 wfProfileOut( __METHOD__
);
504 return array( 'uploadscripted' );
506 if ( $this->mFinalExtension
== 'svg' ||
$mime == 'image/svg+xml' ) {
507 $svgStatus = $this->detectScriptInSvg( $this->mTempPath
);
508 if ( $svgStatus !== false ) {
509 wfProfileOut( __METHOD__
);
516 # Check for Java applets, which if uploaded can bypass cross-site
518 if ( !$wgAllowJavaUploads ) {
519 $this->mJavaDetected
= false;
520 $zipStatus = ZipDirectoryReader
::read( $this->mTempPath
,
521 array( $this, 'zipEntryCallback' ) );
522 if ( !$zipStatus->isOK() ) {
523 $errors = $zipStatus->getErrorsArray();
524 $error = reset( $errors );
525 if ( $error[0] !== 'zip-wrong-format' ) {
526 wfProfileOut( __METHOD__
);
531 if ( $this->mJavaDetected
) {
532 wfProfileOut( __METHOD__
);
534 return array( 'uploadjava' );
538 # Scan the uploaded file for viruses
539 $virus = $this->detectVirus( $this->mTempPath
);
541 wfProfileOut( __METHOD__
);
543 return array( 'uploadvirus', $virus );
546 wfProfileOut( __METHOD__
);
552 * Callback for ZipDirectoryReader to detect Java class files.
554 * @param array $entry
556 function zipEntryCallback( $entry ) {
557 $names = array( $entry['name'] );
559 // If there is a null character, cut off the name at it, because JDK's
560 // ZIP_GetEntry() uses strcmp() if the name hashes match. If a file name
561 // were constructed which had ".class\0" followed by a string chosen to
562 // make the hash collide with the truncated name, that file could be
563 // returned in response to a request for the .class file.
564 $nullPos = strpos( $entry['name'], "\000" );
565 if ( $nullPos !== false ) {
566 $names[] = substr( $entry['name'], 0, $nullPos );
569 // If there is a trailing slash in the file name, we have to strip it,
570 // because that's what ZIP_GetEntry() does.
571 if ( preg_grep( '!\.class/?$!', $names ) ) {
572 $this->mJavaDetected
= true;
577 * Alias for verifyTitlePermissions. The function was originally
578 * 'verifyPermissions', but that suggests it's checking the user, when it's
579 * really checking the title + user combination.
581 * @param User $user User object to verify the permissions against
582 * @return mixed An array as returned by getUserPermissionsErrors or true
583 * in case the user has proper permissions.
585 public function verifyPermissions( $user ) {
586 return $this->verifyTitlePermissions( $user );
590 * Check whether the user can edit, upload and create the image. This
591 * checks only against the current title; if it returns errors, it may
592 * very well be that another title will not give errors. Therefore
593 * isAllowed() should be called as well for generic is-user-blocked or
594 * can-user-upload checking.
596 * @param User $user User object to verify the permissions against
597 * @return mixed An array as returned by getUserPermissionsErrors or true
598 * in case the user has proper permissions.
600 public function verifyTitlePermissions( $user ) {
602 * If the image is protected, non-sysop users won't be able
603 * to modify it by uploading a new revision.
605 $nt = $this->getTitle();
606 if ( is_null( $nt ) ) {
609 $permErrors = $nt->getUserPermissionsErrors( 'edit', $user );
610 $permErrorsUpload = $nt->getUserPermissionsErrors( 'upload', $user );
611 if ( !$nt->exists() ) {
612 $permErrorsCreate = $nt->getUserPermissionsErrors( 'create', $user );
614 $permErrorsCreate = array();
616 if ( $permErrors ||
$permErrorsUpload ||
$permErrorsCreate ) {
617 $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsUpload, $permErrors ) );
618 $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsCreate, $permErrors ) );
623 $overwriteError = $this->checkOverwrite( $user );
624 if ( $overwriteError !== true ) {
625 return array( $overwriteError );
632 * Check for non fatal problems with the file.
634 * This should not assume that mTempPath is set.
636 * @return array Array of warnings
638 public function checkWarnings() {
640 wfProfileIn( __METHOD__
);
644 $localFile = $this->getLocalFile();
645 $filename = $localFile->getName();
648 * Check whether the resulting filename is different from the desired one,
649 * but ignore things like ucfirst() and spaces/underscore things
651 $comparableName = str_replace( ' ', '_', $this->mDesiredDestName
);
652 $comparableName = Title
::capitalize( $comparableName, NS_FILE
);
654 if ( $this->mDesiredDestName
!= $filename && $comparableName != $filename ) {
655 $warnings['badfilename'] = $filename;
656 // Debugging for bug 62241
657 wfDebugLog( 'upload', "Filename: '$filename', mDesiredDestName: "
658 . "'$this->mDesiredDestName', comparableName: '$comparableName'" );
661 // Check whether the file extension is on the unwanted list
662 global $wgCheckFileExtensions, $wgFileExtensions;
663 if ( $wgCheckFileExtensions ) {
664 $extensions = array_unique( $wgFileExtensions );
665 if ( !$this->checkFileExtension( $this->mFinalExtension
, $extensions ) ) {
666 $warnings['filetype-unwanted-type'] = array( $this->mFinalExtension
,
667 $wgLang->commaList( $extensions ), count( $extensions ) );
671 global $wgUploadSizeWarning;
672 if ( $wgUploadSizeWarning && ( $this->mFileSize
> $wgUploadSizeWarning ) ) {
673 $warnings['large-file'] = array( $wgUploadSizeWarning, $this->mFileSize
);
676 if ( $this->mFileSize
== 0 ) {
677 $warnings['emptyfile'] = true;
680 $exists = self
::getExistsWarning( $localFile );
681 if ( $exists !== false ) {
682 $warnings['exists'] = $exists;
685 // Check dupes against existing files
686 $hash = $this->getTempFileSha1Base36();
687 $dupes = RepoGroup
::singleton()->findBySha1( $hash );
688 $title = $this->getTitle();
689 // Remove all matches against self
690 foreach ( $dupes as $key => $dupe ) {
691 if ( $title->equals( $dupe->getTitle() ) ) {
692 unset( $dupes[$key] );
696 $warnings['duplicate'] = $dupes;
699 // Check dupes against archives
700 $archivedImage = new ArchivedFile( null, 0, "{$hash}.{$this->mFinalExtension}" );
701 if ( $archivedImage->getID() > 0 ) {
702 if ( $archivedImage->userCan( File
::DELETED_FILE
) ) {
703 $warnings['duplicate-archive'] = $archivedImage->getName();
705 $warnings['duplicate-archive'] = '';
709 wfProfileOut( __METHOD__
);
715 * Really perform the upload. Stores the file in the local repo, watches
716 * if necessary and runs the UploadComplete hook.
718 * @param string $comment
719 * @param string $pageText
723 * @return Status Indicating the whether the upload succeeded.
725 public function performUpload( $comment, $pageText, $watch, $user ) {
726 wfProfileIn( __METHOD__
);
728 $status = $this->getLocalFile()->upload(
738 if ( $status->isGood() ) {
740 WatchAction
::doWatch(
741 $this->getLocalFile()->getTitle(),
743 WatchedItem
::IGNORE_USER_RIGHTS
746 wfRunHooks( 'UploadComplete', array( &$this ) );
748 $this->postProcessUpload();
751 wfProfileOut( __METHOD__
);
757 * Perform extra steps after a successful upload.
761 public function postProcessUpload() {
762 global $wgUploadThumbnailRenderMap;
766 $sizes = $wgUploadThumbnailRenderMap;
769 foreach ( $sizes as $size ) {
770 $jobs[] = new ThumbnailRenderJob( $this->getLocalFile()->getTitle(), array(
771 'transformParams' => array( 'width' => $size ),
775 JobQueueGroup
::singleton()->push( $jobs );
779 * Returns the title of the file to be uploaded. Sets mTitleError in case
780 * the name was illegal.
782 * @return Title The title of the file or null in case the name was illegal
784 public function getTitle() {
785 if ( $this->mTitle
!== false ) {
786 return $this->mTitle
;
788 /* Assume that if a user specified File:Something.jpg, this is an error
789 * and that the namespace prefix needs to be stripped of.
791 $title = Title
::newFromText( $this->mDesiredDestName
);
792 if ( $title && $title->getNamespace() == NS_FILE
) {
793 $this->mFilteredName
= $title->getDBkey();
795 $this->mFilteredName
= $this->mDesiredDestName
;
798 # oi_archive_name is max 255 bytes, which include a timestamp and an
799 # exclamation mark, so restrict file name to 240 bytes.
800 if ( strlen( $this->mFilteredName
) > 240 ) {
801 $this->mTitleError
= self
::FILENAME_TOO_LONG
;
802 $this->mTitle
= null;
804 return $this->mTitle
;
808 * Chop off any directories in the given filename. Then
809 * filter out illegal characters, and try to make a legible name
810 * out of it. We'll strip some silently that Title would die on.
812 $this->mFilteredName
= wfStripIllegalFilenameChars( $this->mFilteredName
);
813 /* Normalize to title form before we do any further processing */
814 $nt = Title
::makeTitleSafe( NS_FILE
, $this->mFilteredName
);
815 if ( is_null( $nt ) ) {
816 $this->mTitleError
= self
::ILLEGAL_FILENAME
;
817 $this->mTitle
= null;
819 return $this->mTitle
;
821 $this->mFilteredName
= $nt->getDBkey();
824 * We'll want to blacklist against *any* 'extension', and use
825 * only the final one for the whitelist.
827 list( $partname, $ext ) = $this->splitExtensions( $this->mFilteredName
);
829 if ( count( $ext ) ) {
830 $this->mFinalExtension
= trim( $ext[count( $ext ) - 1] );
832 $this->mFinalExtension
= '';
834 # No extension, try guessing one
835 $magic = MimeMagic
::singleton();
836 $mime = $magic->guessMimeType( $this->mTempPath
);
837 if ( $mime !== 'unknown/unknown' ) {
838 # Get a space separated list of extensions
839 $extList = $magic->getExtensionsForType( $mime );
841 # Set the extension to the canonical extension
842 $this->mFinalExtension
= strtok( $extList, ' ' );
844 # Fix up the other variables
845 $this->mFilteredName
.= ".{$this->mFinalExtension}";
846 $nt = Title
::makeTitleSafe( NS_FILE
, $this->mFilteredName
);
847 $ext = array( $this->mFinalExtension
);
852 /* Don't allow users to override the blacklist (check file extension) */
853 global $wgCheckFileExtensions, $wgStrictFileExtensions;
854 global $wgFileExtensions, $wgFileBlacklist;
856 $blackListedExtensions = $this->checkFileExtensionList( $ext, $wgFileBlacklist );
858 if ( $this->mFinalExtension
== '' ) {
859 $this->mTitleError
= self
::FILETYPE_MISSING
;
860 $this->mTitle
= null;
862 return $this->mTitle
;
863 } elseif ( $blackListedExtensions ||
864 ( $wgCheckFileExtensions && $wgStrictFileExtensions &&
865 !$this->checkFileExtension( $this->mFinalExtension
, $wgFileExtensions ) )
867 $this->mBlackListedExtensions
= $blackListedExtensions;
868 $this->mTitleError
= self
::FILETYPE_BADTYPE
;
869 $this->mTitle
= null;
871 return $this->mTitle
;
874 // Windows may be broken with special characters, see bug 1780
875 if ( !preg_match( '/^[\x0-\x7f]*$/', $nt->getText() )
876 && !RepoGroup
::singleton()->getLocalRepo()->backendSupportsUnicodePaths()
878 $this->mTitleError
= self
::WINDOWS_NONASCII_FILENAME
;
879 $this->mTitle
= null;
881 return $this->mTitle
;
884 # If there was more than one "extension", reassemble the base
885 # filename to prevent bogus complaints about length
886 if ( count( $ext ) > 1 ) {
887 $iterations = count( $ext ) - 1;
888 for ( $i = 0; $i < $iterations; $i++
) {
889 $partname .= '.' . $ext[$i];
893 if ( strlen( $partname ) < 1 ) {
894 $this->mTitleError
= self
::MIN_LENGTH_PARTNAME
;
895 $this->mTitle
= null;
897 return $this->mTitle
;
902 return $this->mTitle
;
906 * Return the local file and initializes if necessary.
908 * @return LocalFile|UploadStashFile|null
910 public function getLocalFile() {
911 if ( is_null( $this->mLocalFile
) ) {
912 $nt = $this->getTitle();
913 $this->mLocalFile
= is_null( $nt ) ?
null : wfLocalFile( $nt );
916 return $this->mLocalFile
;
920 * If the user does not supply all necessary information in the first upload
921 * form submission (either by accident or by design) then we may want to
922 * stash the file temporarily, get more information, and publish the file
925 * This method will stash a file in a temporary directory for later
926 * processing, and save the necessary descriptive info into the database.
927 * This method returns the file object, which also has a 'fileKey' property
928 * which can be passed through a form or API request to find this stashed
932 * @return UploadStashFile Stashed file
934 public function stashFile( User
$user = null ) {
935 // was stashSessionFile
936 wfProfileIn( __METHOD__
);
938 $stash = RepoGroup
::singleton()->getLocalRepo()->getUploadStash( $user );
939 $file = $stash->stashFile( $this->mTempPath
, $this->getSourceType() );
940 $this->mLocalFile
= $file;
942 wfProfileOut( __METHOD__
);
948 * Stash a file in a temporary directory, returning a key which can be used
949 * to find the file again. See stashFile().
951 * @return string File key
953 public function stashFileGetKey() {
954 return $this->stashFile()->getFileKey();
958 * alias for stashFileGetKey, for backwards compatibility
960 * @return string File key
962 public function stashSession() {
963 return $this->stashFileGetKey();
967 * If we've modified the upload file we need to manually remove it
968 * on exit to clean up.
970 public function cleanupTempFile() {
971 if ( $this->mRemoveTempFile
&& $this->mTempPath
&& file_exists( $this->mTempPath
) ) {
972 wfDebug( __METHOD__
. ": Removing temporary file {$this->mTempPath}\n" );
973 unlink( $this->mTempPath
);
977 public function getTempPath() {
978 return $this->mTempPath
;
982 * Split a file into a base name and all dot-delimited 'extensions'
983 * on the end. Some web server configurations will fall back to
984 * earlier pseudo-'extensions' to determine type and execute
985 * scripts, so the blacklist needs to check them all.
987 * @param string $filename
990 public static function splitExtensions( $filename ) {
991 $bits = explode( '.', $filename );
992 $basename = array_shift( $bits );
994 return array( $basename, $bits );
998 * Perform case-insensitive match against a list of file extensions.
999 * Returns true if the extension is in the list.
1001 * @param string $ext
1002 * @param array $list
1005 public static function checkFileExtension( $ext, $list ) {
1006 return in_array( strtolower( $ext ), $list );
1010 * Perform case-insensitive match against a list of file extensions.
1011 * Returns an array of matching extensions.
1014 * @param array $list
1017 public static function checkFileExtensionList( $ext, $list ) {
1018 return array_intersect( array_map( 'strtolower', $ext ), $list );
1022 * Checks if the MIME type of the uploaded file matches the file extension.
1024 * @param string $mime The MIME type of the uploaded file
1025 * @param string $extension The filename extension that the file is to be served with
1028 public static function verifyExtension( $mime, $extension ) {
1029 $magic = MimeMagic
::singleton();
1031 if ( !$mime ||
$mime == 'unknown' ||
$mime == 'unknown/unknown' ) {
1032 if ( !$magic->isRecognizableExtension( $extension ) ) {
1033 wfDebug( __METHOD__
. ": passing file with unknown detected mime type; " .
1034 "unrecognized extension '$extension', can't verify\n" );
1038 wfDebug( __METHOD__
. ": rejecting file with unknown detected mime type; " .
1039 "recognized extension '$extension', so probably invalid file\n" );
1045 $match = $magic->isMatchingExtension( $extension, $mime );
1047 if ( $match === null ) {
1048 if ( $magic->getTypesForExtension( $extension ) !== null ) {
1049 wfDebug( __METHOD__
. ": No extension known for $mime, but we know a mime for $extension\n" );
1053 wfDebug( __METHOD__
. ": no file extension known for mime type $mime, passing file\n" );
1057 } elseif ( $match === true ) {
1058 wfDebug( __METHOD__
. ": mime type $mime matches extension $extension, passing file\n" );
1060 /** @todo If it's a bitmap, make sure PHP or ImageMagick resp. can handle it! */
1064 . ": mime type $mime mismatches file extension $extension, rejecting file\n" );
1071 * Heuristic for detecting files that *could* contain JavaScript instructions or
1072 * things that may look like HTML to a browser and are thus
1073 * potentially harmful. The present implementation will produce false
1074 * positives in some situations.
1076 * @param string $file Pathname to the temporary upload file
1077 * @param string $mime The MIME type of the file
1078 * @param string $extension The extension of the file
1079 * @return bool True if the file contains something looking like embedded scripts
1081 public static function detectScript( $file, $mime, $extension ) {
1082 global $wgAllowTitlesInSVG;
1083 wfProfileIn( __METHOD__
);
1085 # ugly hack: for text files, always look at the entire file.
1086 # For binary field, just check the first K.
1088 if ( strpos( $mime, 'text/' ) === 0 ) {
1089 $chunk = file_get_contents( $file );
1091 $fp = fopen( $file, 'rb' );
1092 $chunk = fread( $fp, 1024 );
1096 $chunk = strtolower( $chunk );
1099 wfProfileOut( __METHOD__
);
1104 # decode from UTF-16 if needed (could be used for obfuscation).
1105 if ( substr( $chunk, 0, 2 ) == "\xfe\xff" ) {
1107 } elseif ( substr( $chunk, 0, 2 ) == "\xff\xfe" ) {
1114 $chunk = iconv( $enc, "ASCII//IGNORE", $chunk );
1117 $chunk = trim( $chunk );
1119 /** @todo FIXME: Convert from UTF-16 if necessary! */
1120 wfDebug( __METHOD__
. ": checking for embedded scripts and HTML stuff\n" );
1122 # check for HTML doctype
1123 if ( preg_match( "/<!DOCTYPE *X?HTML/i", $chunk ) ) {
1124 wfProfileOut( __METHOD__
);
1129 // Some browsers will interpret obscure xml encodings as UTF-8, while
1130 // PHP/expat will interpret the given encoding in the xml declaration (bug 47304)
1131 if ( $extension == 'svg' ||
strpos( $mime, 'image/svg' ) === 0 ) {
1132 if ( self
::checkXMLEncodingMissmatch( $file ) ) {
1133 wfProfileOut( __METHOD__
);
1140 * Internet Explorer for Windows performs some really stupid file type
1141 * autodetection which can cause it to interpret valid image files as HTML
1142 * and potentially execute JavaScript, creating a cross-site scripting
1145 * Apple's Safari browser also performs some unsafe file type autodetection
1146 * which can cause legitimate files to be interpreted as HTML if the
1147 * web server is not correctly configured to send the right content-type
1148 * (or if you're really uploading plain text and octet streams!)
1150 * Returns true if IE is likely to mistake the given file for HTML.
1151 * Also returns true if Safari would mistake the given file for HTML
1152 * when served with a generic content-type.
1158 '<html', #also in safari
1161 '<script', #also in safari
1165 if ( !$wgAllowTitlesInSVG && $extension !== 'svg' && $mime !== 'image/svg' ) {
1169 foreach ( $tags as $tag ) {
1170 if ( false !== strpos( $chunk, $tag ) ) {
1171 wfDebug( __METHOD__
. ": found something that may make it be mistaken for html: $tag\n" );
1172 wfProfileOut( __METHOD__
);
1179 * look for JavaScript
1182 # resolve entity-refs to look at attributes. may be harsh on big files... cache result?
1183 $chunk = Sanitizer
::decodeCharReferences( $chunk );
1185 # look for script-types
1186 if ( preg_match( '!type\s*=\s*[\'"]?\s*(?:\w*/)?(?:ecma|java)!sim', $chunk ) ) {
1187 wfDebug( __METHOD__
. ": found script types\n" );
1188 wfProfileOut( __METHOD__
);
1193 # look for html-style script-urls
1194 if ( preg_match( '!(?:href|src|data)\s*=\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1195 wfDebug( __METHOD__
. ": found html-style script urls\n" );
1196 wfProfileOut( __METHOD__
);
1201 # look for css-style script-urls
1202 if ( preg_match( '!url\s*\(\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1203 wfDebug( __METHOD__
. ": found css-style script urls\n" );
1204 wfProfileOut( __METHOD__
);
1209 wfDebug( __METHOD__
. ": no scripts found\n" );
1210 wfProfileOut( __METHOD__
);
1216 * Check a whitelist of xml encodings that are known not to be interpreted differently
1217 * by the server's xml parser (expat) and some common browsers.
1219 * @param string $file Pathname to the temporary upload file
1220 * @return bool True if the file contains an encoding that could be misinterpreted
1222 public static function checkXMLEncodingMissmatch( $file ) {
1223 global $wgSVGMetadataCutoff;
1224 $contents = file_get_contents( $file, false, null, -1, $wgSVGMetadataCutoff );
1225 $encodingRegex = '!encoding[ \t\n\r]*=[ \t\n\r]*[\'"](.*?)[\'"]!si';
1227 if ( preg_match( "!<\?xml\b(.*?)\?>!si", $contents, $matches ) ) {
1228 if ( preg_match( $encodingRegex, $matches[1], $encMatch )
1229 && !in_array( strtoupper( $encMatch[1] ), self
::$safeXmlEncodings )
1231 wfDebug( __METHOD__
. ": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1235 } elseif ( preg_match( "!<\?xml\b!si", $contents ) ) {
1236 // Start of XML declaration without an end in the first $wgSVGMetadataCutoff
1237 // bytes. There shouldn't be a legitimate reason for this to happen.
1238 wfDebug( __METHOD__
. ": Unmatched XML declaration start\n" );
1241 } elseif ( substr( $contents, 0, 4 ) == "\x4C\x6F\xA7\x94" ) {
1242 // EBCDIC encoded XML
1243 wfDebug( __METHOD__
. ": EBCDIC Encoded XML\n" );
1248 // It's possible the file is encoded with multi-byte encoding, so re-encode attempt to
1249 // detect the encoding in case is specifies an encoding not whitelisted in self::$safeXmlEncodings
1250 $attemptEncodings = array( 'UTF-16', 'UTF-16BE', 'UTF-32', 'UTF-32BE' );
1251 foreach ( $attemptEncodings as $encoding ) {
1252 wfSuppressWarnings();
1253 $str = iconv( $encoding, 'UTF-8', $contents );
1254 wfRestoreWarnings();
1255 if ( $str != '' && preg_match( "!<\?xml\b(.*?)\?>!si", $str, $matches ) ) {
1256 if ( preg_match( $encodingRegex, $matches[1], $encMatch )
1257 && !in_array( strtoupper( $encMatch[1] ), self
::$safeXmlEncodings )
1259 wfDebug( __METHOD__
. ": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1263 } elseif ( $str != '' && preg_match( "!<\?xml\b!si", $str ) ) {
1264 // Start of XML declaration without an end in the first $wgSVGMetadataCutoff
1265 // bytes. There shouldn't be a legitimate reason for this to happen.
1266 wfDebug( __METHOD__
. ": Unmatched XML declaration start\n" );
1276 * @param string $filename
1277 * @return mixed False of the file is verified (does not contain scripts), array otherwise.
1279 protected function detectScriptInSvg( $filename ) {
1280 $this->mSVGNSError
= false;
1281 $check = new XmlTypeCheck(
1283 array( $this, 'checkSvgScriptCallback' ),
1285 array( 'processing_instruction_handler' => 'UploadBase::checkSvgPICallback' )
1287 if ( $check->wellFormed
!== true ) {
1288 // Invalid xml (bug 58553)
1289 return array( 'uploadinvalidxml' );
1290 } elseif ( $check->filterMatch
) {
1291 if ( $this->mSVGNSError
) {
1292 return array( 'uploadscriptednamespace', $this->mSVGNSError
);
1295 return array( 'uploadscripted' );
1302 * Callback to filter SVG Processing Instructions.
1303 * @param string $target Processing instruction name
1304 * @param string $data Processing instruction attribute and value
1305 * @return bool (true if the filter identified something bad)
1307 public static function checkSvgPICallback( $target, $data ) {
1308 // Don't allow external stylesheets (bug 57550)
1309 if ( preg_match( '/xml-stylesheet/i', $target ) ) {
1317 * @todo Replace this with a whitelist filter!
1318 * @param string $element
1319 * @param array $attribs
1322 public function checkSvgScriptCallback( $element, $attribs, $data = null ) {
1324 list( $namespace, $strippedElement ) = $this->splitXmlNamespace( $element );
1326 // We specifically don't include:
1327 // http://www.w3.org/1999/xhtml (bug 60771)
1328 static $validNamespaces = array(
1331 'http://creativecommons.org/ns#',
1332 'http://inkscape.sourceforge.net/dtd/sodipodi-0.dtd',
1333 'http://ns.adobe.com/adobeillustrator/10.0/',
1334 'http://ns.adobe.com/adobesvgviewerextensions/3.0/',
1335 'http://ns.adobe.com/extensibility/1.0/',
1336 'http://ns.adobe.com/flows/1.0/',
1337 'http://ns.adobe.com/illustrator/1.0/',
1338 'http://ns.adobe.com/imagereplacement/1.0/',
1339 'http://ns.adobe.com/pdf/1.3/',
1340 'http://ns.adobe.com/photoshop/1.0/',
1341 'http://ns.adobe.com/saveforweb/1.0/',
1342 'http://ns.adobe.com/variables/1.0/',
1343 'http://ns.adobe.com/xap/1.0/',
1344 'http://ns.adobe.com/xap/1.0/g/',
1345 'http://ns.adobe.com/xap/1.0/g/img/',
1346 'http://ns.adobe.com/xap/1.0/mm/',
1347 'http://ns.adobe.com/xap/1.0/rights/',
1348 'http://ns.adobe.com/xap/1.0/stype/dimensions#',
1349 'http://ns.adobe.com/xap/1.0/stype/font#',
1350 'http://ns.adobe.com/xap/1.0/stype/manifestitem#',
1351 'http://ns.adobe.com/xap/1.0/stype/resourceevent#',
1352 'http://ns.adobe.com/xap/1.0/stype/resourceref#',
1353 'http://ns.adobe.com/xap/1.0/t/pg/',
1354 'http://purl.org/dc/elements/1.1/',
1355 'http://purl.org/dc/elements/1.1',
1356 'http://schemas.microsoft.com/visio/2003/svgextensions/',
1357 'http://sodipodi.sourceforge.net/dtd/sodipodi-0.dtd',
1358 'http://taptrix.com/inkpad/svg_extensions',
1359 'http://web.resource.org/cc/',
1360 'http://www.freesoftware.fsf.org/bkchem/cdml',
1361 'http://www.inkscape.org/namespaces/inkscape',
1362 'http://www.opengis.net/gml',
1363 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
1364 'http://www.w3.org/2000/svg',
1365 'http://www.w3.org/tr/rec-rdf-syntax/',
1368 if ( !in_array( $namespace, $validNamespaces ) ) {
1369 wfDebug( __METHOD__
. ": Non-svg namespace '$namespace' in uploaded file.\n" );
1370 /** @todo Return a status object to a closure in XmlTypeCheck, for MW1.21+ */
1371 $this->mSVGNSError
= $namespace;
1377 * check for elements that can contain javascript
1379 if ( $strippedElement == 'script' ) {
1380 wfDebug( __METHOD__
. ": Found script element '$element' in uploaded file.\n" );
1385 # e.g., <svg xmlns="http://www.w3.org/2000/svg">
1386 # <handler xmlns:ev="http://www.w3.org/2001/xml-events" ev:event="load">alert(1)</handler> </svg>
1387 if ( $strippedElement == 'handler' ) {
1388 wfDebug( __METHOD__
. ": Found scriptable element '$element' in uploaded file.\n" );
1393 # SVG reported in Feb '12 that used xml:stylesheet to generate javascript block
1394 if ( $strippedElement == 'stylesheet' ) {
1395 wfDebug( __METHOD__
. ": Found scriptable element '$element' in uploaded file.\n" );
1400 # Block iframes, in case they pass the namespace check
1401 if ( $strippedElement == 'iframe' ) {
1402 wfDebug( __METHOD__
. ": iframe in uploaded file.\n" );
1408 if ( $strippedElement == 'style'
1409 && self
::checkCssFragment( Sanitizer
::normalizeCss( $data ) )
1411 wfDebug( __METHOD__
. ": hostile css in style element.\n" );
1415 foreach ( $attribs as $attrib => $value ) {
1416 $stripped = $this->stripXmlNamespace( $attrib );
1417 $value = strtolower( $value );
1419 if ( substr( $stripped, 0, 2 ) == 'on' ) {
1421 . ": Found event-handler attribute '$attrib'='$value' in uploaded file.\n" );
1426 # href with non-local target (don't allow http://, javascript:, etc)
1427 if ( $stripped == 'href'
1428 && strpos( $value, 'data:' ) !== 0
1429 && strpos( $value, '#' ) !== 0
1431 if ( !( $strippedElement === 'a'
1432 && preg_match( '!^https?://!im', $value ) )
1434 wfDebug( __METHOD__
. ": Found href attribute <$strippedElement "
1435 . "'$attrib'='$value' in uploaded file.\n" );
1441 # href with embedded svg as target
1442 if ( $stripped == 'href' && preg_match( '!data:[^,]*image/svg[^,]*,!sim', $value ) ) {
1443 wfDebug( __METHOD__
. ": Found href to embedded svg "
1444 . "\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1449 # href with embedded (text/xml) svg as target
1450 if ( $stripped == 'href' && preg_match( '!data:[^,]*text/xml[^,]*,!sim', $value ) ) {
1451 wfDebug( __METHOD__
. ": Found href to embedded svg "
1452 . "\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1457 # Change href with animate from (http://html5sec.org/#137). This doesn't seem
1458 # possible without embedding the svg, but filter here in case.
1459 if ( $stripped == 'from'
1460 && $strippedElement === 'animate'
1461 && !preg_match( '!^https?://!im', $value )
1463 wfDebug( __METHOD__
. ": Found animate that might be changing href using from "
1464 . "\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1469 # use set/animate to add event-handler attribute to parent
1470 if ( ( $strippedElement == 'set' ||
$strippedElement == 'animate' )
1471 && $stripped == 'attributename'
1472 && substr( $value, 0, 2 ) == 'on'
1474 wfDebug( __METHOD__
. ": Found svg setting event-handler attribute with "
1475 . "\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1480 # use set to add href attribute to parent element
1481 if ( $strippedElement == 'set'
1482 && $stripped == 'attributename'
1483 && strpos( $value, 'href' ) !== false
1485 wfDebug( __METHOD__
. ": Found svg setting href attribute '$value' in uploaded file.\n" );
1490 # use set to add a remote / data / script target to an element
1491 if ( $strippedElement == 'set'
1492 && $stripped == 'to'
1493 && preg_match( '!(http|https|data|script):!sim', $value )
1495 wfDebug( __METHOD__
. ": Found svg setting attribute to '$value' in uploaded file.\n" );
1500 # use handler attribute with remote / data / script
1501 if ( $stripped == 'handler' && preg_match( '!(http|https|data|script):!sim', $value ) ) {
1502 wfDebug( __METHOD__
. ": Found svg setting handler with remote/data/script "
1503 . "'$attrib'='$value' in uploaded file.\n" );
1508 # use CSS styles to bring in remote code
1509 if ( $stripped == 'style'
1510 && self
::checkCssFragment( Sanitizer
::normalizeCss( $value ) )
1512 wfDebug( __METHOD__
. ": Found svg setting a style with "
1513 . "remote url '$attrib'='$value' in uploaded file.\n" );
1517 # Several attributes can include css, css character escaping isn't allowed
1518 $cssAttrs = array( 'font', 'clip-path', 'fill', 'filter', 'marker',
1519 'marker-end', 'marker-mid', 'marker-start', 'mask', 'stroke' );
1520 if ( in_array( $stripped, $cssAttrs )
1521 && self
::checkCssFragment( $value )
1523 wfDebug( __METHOD__
. ": Found svg setting a style with "
1524 . "remote url '$attrib'='$value' in uploaded file.\n" );
1528 # image filters can pull in url, which could be svg that executes scripts
1529 if ( $strippedElement == 'image'
1530 && $stripped == 'filter'
1531 && preg_match( '!url\s*\(!sim', $value )
1533 wfDebug( __METHOD__
. ": Found image filter with url: "
1534 . "\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1540 return false; //No scripts detected
1544 * Check a block of CSS or CSS fragment for anything that looks like
1545 * it is bringing in remote code.
1546 * @param string $value a string of CSS
1547 * @param bool $propOnly only check css properties (start regex with :)
1548 * @return bool true if the CSS contains an illegal string, false if otherwise
1550 private static function checkCssFragment( $value ) {
1552 # Forbid external stylesheets, for both reliability and to protect viewer's privacy
1553 if ( strpos( $value, '@import' ) !== false ) {
1557 # We allow @font-face to embed fonts with data: urls, so we snip the string
1558 # 'url' out so this case won't match when we check for urls below
1559 $pattern = '!(@font-face\s*{[^}]*src:)url(\("data:;base64,)!im';
1560 $value = preg_replace( $pattern, '$1$2', $value );
1562 # Check for remote and executable CSS. Unlike in Sanitizer::checkCss, the CSS
1563 # properties filter and accelerator don't seem to be useful for xss in SVG files.
1564 # Expression and -o-link don't seem to work either, but filtering them here in case.
1565 # Additionally, we catch remote urls like url("http:..., url('http:..., url(http:...,
1566 # but not local ones such as url("#..., url('#..., url(#....
1567 if ( preg_match( '!expression
1569 | -o-link-source\s*:
1570 | -o-replace\s*:!imx', $value ) ) {
1574 if ( preg_match_all(
1575 "!(\s*(url|image|image-set)\s*\(\s*[\"']?\s*[^#]+.*?\))!sim",
1580 # TODO: redo this in one regex. Until then, url("#whatever") matches the first
1581 foreach ( $matches[1] as $match ) {
1582 if ( !preg_match( "!\s*(url|image|image-set)\s*\(\s*(#|'#|\"#)!im", $match ) ) {
1588 if ( preg_match( '/[\000-\010\013\016-\037\177]/', $value ) ) {
1596 * Divide the element name passed by the xml parser to the callback into URI and prifix.
1597 * @param string $element
1598 * @return array Containing the namespace URI and prefix
1600 private static function splitXmlNamespace( $element ) {
1601 // 'http://www.w3.org/2000/svg:script' -> array( 'http://www.w3.org/2000/svg', 'script' )
1602 $parts = explode( ':', strtolower( $element ) );
1603 $name = array_pop( $parts );
1604 $ns = implode( ':', $parts );
1606 return array( $ns, $name );
1610 * @param string $name
1613 private function stripXmlNamespace( $name ) {
1614 // 'http://www.w3.org/2000/svg:script' -> 'script'
1615 $parts = explode( ':', strtolower( $name ) );
1617 return array_pop( $parts );
1621 * Generic wrapper function for a virus scanner program.
1622 * This relies on the $wgAntivirus and $wgAntivirusSetup variables.
1623 * $wgAntivirusRequired may be used to deny upload if the scan fails.
1625 * @param string $file Pathname to the temporary upload file
1626 * @return mixed False if not virus is found, null if the scan fails or is disabled,
1627 * or a string containing feedback from the virus scanner if a virus was found.
1628 * If textual feedback is missing but a virus was found, this function returns true.
1630 public static function detectVirus( $file ) {
1631 global $wgAntivirus, $wgAntivirusSetup, $wgAntivirusRequired, $wgOut;
1632 wfProfileIn( __METHOD__
);
1634 if ( !$wgAntivirus ) {
1635 wfDebug( __METHOD__
. ": virus scanner disabled\n" );
1636 wfProfileOut( __METHOD__
);
1641 if ( !$wgAntivirusSetup[$wgAntivirus] ) {
1642 wfDebug( __METHOD__
. ": unknown virus scanner: $wgAntivirus\n" );
1643 $wgOut->wrapWikiMsg( "<div class=\"error\">\n$1\n</div>",
1644 array( 'virus-badscanner', $wgAntivirus ) );
1645 wfProfileOut( __METHOD__
);
1647 return wfMessage( 'virus-unknownscanner' )->text() . " $wgAntivirus";
1650 # look up scanner configuration
1651 $command = $wgAntivirusSetup[$wgAntivirus]['command'];
1652 $exitCodeMap = $wgAntivirusSetup[$wgAntivirus]['codemap'];
1653 $msgPattern = isset( $wgAntivirusSetup[$wgAntivirus]['messagepattern'] ) ?
1654 $wgAntivirusSetup[$wgAntivirus]['messagepattern'] : null;
1656 if ( strpos( $command, "%f" ) === false ) {
1657 # simple pattern: append file to scan
1658 $command .= " " . wfEscapeShellArg( $file );
1660 # complex pattern: replace "%f" with file to scan
1661 $command = str_replace( "%f", wfEscapeShellArg( $file ), $command );
1664 wfDebug( __METHOD__
. ": running virus scan: $command \n" );
1666 # execute virus scanner
1669 # NOTE: there's a 50 line workaround to make stderr redirection work on windows, too.
1670 # that does not seem to be worth the pain.
1671 # Ask me (Duesentrieb) about it if it's ever needed.
1672 $output = wfShellExecWithStderr( $command, $exitCode );
1674 # map exit code to AV_xxx constants.
1675 $mappedCode = $exitCode;
1676 if ( $exitCodeMap ) {
1677 if ( isset( $exitCodeMap[$exitCode] ) ) {
1678 $mappedCode = $exitCodeMap[$exitCode];
1679 } elseif ( isset( $exitCodeMap["*"] ) ) {
1680 $mappedCode = $exitCodeMap["*"];
1684 /* NB: AV_NO_VIRUS is 0 but AV_SCAN_FAILED is false,
1685 * so we need the strict equalities === and thus can't use a switch here
1687 if ( $mappedCode === AV_SCAN_FAILED
) {
1688 # scan failed (code was mapped to false by $exitCodeMap)
1689 wfDebug( __METHOD__
. ": failed to scan $file (code $exitCode).\n" );
1691 $output = $wgAntivirusRequired
1692 ?
wfMessage( 'virus-scanfailed', array( $exitCode ) )->text()
1694 } elseif ( $mappedCode === AV_SCAN_ABORTED
) {
1695 # scan failed because filetype is unknown (probably imune)
1696 wfDebug( __METHOD__
. ": unsupported file type $file (code $exitCode).\n" );
1698 } elseif ( $mappedCode === AV_NO_VIRUS
) {
1700 wfDebug( __METHOD__
. ": file passed virus scan.\n" );
1703 $output = trim( $output );
1706 $output = true; #if there's no output, return true
1707 } elseif ( $msgPattern ) {
1709 if ( preg_match( $msgPattern, $output, $groups ) ) {
1711 $output = $groups[1];
1716 wfDebug( __METHOD__
. ": FOUND VIRUS! scanner feedback: $output \n" );
1719 wfProfileOut( __METHOD__
);
1725 * Check if there's an overwrite conflict and, if so, if restrictions
1726 * forbid this user from performing the upload.
1730 * @return mixed True on success, array on failure
1732 private function checkOverwrite( $user ) {
1733 // First check whether the local file can be overwritten
1734 $file = $this->getLocalFile();
1735 if ( $file->exists() ) {
1736 if ( !self
::userCanReUpload( $user, $file ) ) {
1737 return array( 'fileexists-forbidden', $file->getName() );
1743 /* Check shared conflicts: if the local file does not exist, but
1744 * wfFindFile finds a file, it exists in a shared repository.
1746 $file = wfFindFile( $this->getTitle() );
1747 if ( $file && !$user->isAllowed( 'reupload-shared' ) ) {
1748 return array( 'fileexists-shared-forbidden', $file->getName() );
1755 * Check if a user is the last uploader
1758 * @param string $img Image name
1761 public static function userCanReUpload( User
$user, $img ) {
1762 if ( $user->isAllowed( 'reupload' ) ) {
1763 return true; // non-conditional
1765 if ( !$user->isAllowed( 'reupload-own' ) ) {
1768 if ( is_string( $img ) ) {
1769 $img = wfLocalFile( $img );
1771 if ( !( $img instanceof LocalFile
) ) {
1775 return $user->getId() == $img->getUser( 'id' );
1779 * Helper function that does various existence checks for a file.
1780 * The following checks are performed:
1782 * - Article with the same name as the file exists
1783 * - File exists with normalized extension
1784 * - The file looks like a thumbnail and the original exists
1786 * @param File $file The File object to check
1787 * @return mixed False if the file does not exists, else an array
1789 public static function getExistsWarning( $file ) {
1790 if ( $file->exists() ) {
1791 return array( 'warning' => 'exists', 'file' => $file );
1794 if ( $file->getTitle()->getArticleID() ) {
1795 return array( 'warning' => 'page-exists', 'file' => $file );
1798 if ( $file->wasDeleted() && !$file->exists() ) {
1799 return array( 'warning' => 'was-deleted', 'file' => $file );
1802 if ( strpos( $file->getName(), '.' ) == false ) {
1803 $partname = $file->getName();
1806 $n = strrpos( $file->getName(), '.' );
1807 $extension = substr( $file->getName(), $n +
1 );
1808 $partname = substr( $file->getName(), 0, $n );
1810 $normalizedExtension = File
::normalizeExtension( $extension );
1812 if ( $normalizedExtension != $extension ) {
1813 // We're not using the normalized form of the extension.
1814 // Normal form is lowercase, using most common of alternate
1815 // extensions (eg 'jpg' rather than 'JPEG').
1817 // Check for another file using the normalized form...
1818 $nt_lc = Title
::makeTitle( NS_FILE
, "{$partname}.{$normalizedExtension}" );
1819 $file_lc = wfLocalFile( $nt_lc );
1821 if ( $file_lc->exists() ) {
1823 'warning' => 'exists-normalized',
1825 'normalizedFile' => $file_lc
1830 // Check for files with the same name but a different extension
1831 $similarFiles = RepoGroup
::singleton()->getLocalRepo()->findFilesByPrefix(
1832 "{$partname}.", 1 );
1833 if ( count( $similarFiles ) ) {
1835 'warning' => 'exists-normalized',
1837 'normalizedFile' => $similarFiles[0],
1841 if ( self
::isThumbName( $file->getName() ) ) {
1842 # Check for filenames like 50px- or 180px-, these are mostly thumbnails
1843 $nt_thb = Title
::newFromText(
1844 substr( $partname, strpos( $partname, '-' ) +
1 ) . '.' . $extension,
1847 $file_thb = wfLocalFile( $nt_thb );
1848 if ( $file_thb->exists() ) {
1850 'warning' => 'thumb',
1852 'thumbFile' => $file_thb
1855 // File does not exist, but we just don't like the name
1857 'warning' => 'thumb-name',
1859 'thumbFile' => $file_thb
1864 foreach ( self
::getFilenamePrefixBlacklist() as $prefix ) {
1865 if ( substr( $partname, 0, strlen( $prefix ) ) == $prefix ) {
1867 'warning' => 'bad-prefix',
1878 * Helper function that checks whether the filename looks like a thumbnail
1879 * @param string $filename
1882 public static function isThumbName( $filename ) {
1883 $n = strrpos( $filename, '.' );
1884 $partname = $n ?
substr( $filename, 0, $n ) : $filename;
1887 substr( $partname, 3, 3 ) == 'px-' ||
1888 substr( $partname, 2, 3 ) == 'px-'
1890 preg_match( "/[0-9]{2}/", substr( $partname, 0, 2 ) );
1894 * Get a list of blacklisted filename prefixes from [[MediaWiki:Filename-prefix-blacklist]]
1896 * @return array List of prefixes
1898 public static function getFilenamePrefixBlacklist() {
1899 $blacklist = array();
1900 $message = wfMessage( 'filename-prefix-blacklist' )->inContentLanguage();
1901 if ( !$message->isDisabled() ) {
1902 $lines = explode( "\n", $message->plain() );
1903 foreach ( $lines as $line ) {
1904 // Remove comment lines
1905 $comment = substr( trim( $line ), 0, 1 );
1906 if ( $comment == '#' ||
$comment == '' ) {
1909 // Remove additional comments after a prefix
1910 $comment = strpos( $line, '#' );
1911 if ( $comment > 0 ) {
1912 $line = substr( $line, 0, $comment - 1 );
1914 $blacklist[] = trim( $line );
1922 * Gets image info about the file just uploaded.
1924 * Also has the effect of setting metadata to be an 'indexed tag name' in
1925 * returned API result if 'metadata' was requested. Oddly, we have to pass
1926 * the "result" object down just so it can do that with the appropriate
1927 * format, presumably.
1929 * @param ApiResult $result
1930 * @return array Image info
1932 public function getImageInfo( $result ) {
1933 $file = $this->getLocalFile();
1934 /** @todo This cries out for refactoring.
1935 * We really want to say $file->getAllInfo(); here.
1936 * Perhaps "info" methods should be moved into files, and the API should
1937 * just wrap them in queries.
1939 if ( $file instanceof UploadStashFile
) {
1940 $imParam = ApiQueryStashImageInfo
::getPropertyNames();
1941 $info = ApiQueryStashImageInfo
::getInfo( $file, array_flip( $imParam ), $result );
1943 $imParam = ApiQueryImageInfo
::getPropertyNames();
1944 $info = ApiQueryImageInfo
::getInfo( $file, array_flip( $imParam ), $result );
1951 * @param array $error
1954 public function convertVerifyErrorToStatus( $error ) {
1955 $code = $error['status'];
1956 unset( $code['status'] );
1958 return Status
::newFatal( $this->getVerificationErrorCode( $code ), $error );
1962 * @param null|string $forType
1965 public static function getMaxUploadSize( $forType = null ) {
1966 global $wgMaxUploadSize;
1968 if ( is_array( $wgMaxUploadSize ) ) {
1969 if ( !is_null( $forType ) && isset( $wgMaxUploadSize[$forType] ) ) {
1970 return $wgMaxUploadSize[$forType];
1972 return $wgMaxUploadSize['*'];
1975 return intval( $wgMaxUploadSize );
1980 * Get the current status of a chunked upload (used for polling)
1982 * The value will be read from cache.
1985 * @param string $statusKey
1986 * @return Status[]|bool
1988 public static function getSessionStatus( User
$user, $statusKey ) {
1989 $key = wfMemcKey( 'uploadstatus', $user->getId() ?
: md5( $user->getName() ), $statusKey );
1991 return wfGetCache( CACHE_ANYTHING
)->get( $key );
1995 * Set the current status of a chunked upload (used for polling)
1997 * The value will be set in cache for 1 day
2000 * @param string $statusKey
2001 * @param array|bool $value
2004 public static function setSessionStatus( User
$user, $statusKey, $value ) {
2005 $key = wfMemcKey( 'uploadstatus', $user->getId() ?
: md5( $user->getName() ), $statusKey );
2007 $cache = wfGetCache( CACHE_ANYTHING
);
2008 if ( $value === false ) {
2009 $cache->delete( $key );
2011 $cache->set( $key, $value, 86400 );