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
{
39 /** @var string Local file system path to the file to upload (or a local copy) */
41 /** @var TempFSFile|null Wrapper to handle deleting the temp file */
42 protected $tempFileObj;
44 protected $mDesiredDestName, $mDestName, $mRemoveTempFile, $mSourceType;
45 protected $mTitle = false, $mTitleError = 0;
46 protected $mFilteredName, $mFinalExtension;
47 protected $mLocalFile, $mFileSize, $mFileProps;
48 protected $mBlackListedExtensions;
49 protected $mJavaDetected, $mSVGNSError;
51 protected static $safeXmlEncodings = [
71 const MIN_LENGTH_PARTNAME
= 4;
72 const ILLEGAL_FILENAME
= 5;
73 const OVERWRITE_EXISTING_FILE
= 7; # Not used anymore; handled by verifyTitlePermissions()
74 const FILETYPE_MISSING
= 8;
75 const FILETYPE_BADTYPE
= 9;
76 const VERIFICATION_ERROR
= 10;
77 const HOOK_ABORTED
= 11;
78 const FILE_TOO_LARGE
= 12;
79 const WINDOWS_NONASCII_FILENAME
= 13;
80 const FILENAME_TOO_LONG
= 14;
86 public function getVerificationErrorCode( $error ) {
88 self
::EMPTY_FILE
=> 'empty-file',
89 self
::FILE_TOO_LARGE
=> 'file-too-large',
90 self
::FILETYPE_MISSING
=> 'filetype-missing',
91 self
::FILETYPE_BADTYPE
=> 'filetype-banned',
92 self
::MIN_LENGTH_PARTNAME
=> 'filename-tooshort',
93 self
::ILLEGAL_FILENAME
=> 'illegal-filename',
94 self
::OVERWRITE_EXISTING_FILE
=> 'overwrite',
95 self
::VERIFICATION_ERROR
=> 'verification-error',
96 self
::HOOK_ABORTED
=> 'hookaborted',
97 self
::WINDOWS_NONASCII_FILENAME
=> 'windows-nonascii-filename',
98 self
::FILENAME_TOO_LONG
=> 'filename-toolong',
100 if ( isset( $code_to_status[$error] ) ) {
101 return $code_to_status[$error];
104 return 'unknown-error';
108 * Returns true if uploads are enabled.
109 * Can be override by subclasses.
112 public static function isEnabled() {
113 global $wgEnableUploads;
115 if ( !$wgEnableUploads ) {
119 # Check php's file_uploads setting
120 return wfIsHHVM() ||
wfIniGetBool( 'file_uploads' );
124 * Returns true if the user can use this upload module or else a string
125 * identifying the missing permission.
126 * Can be overridden by subclasses.
129 * @return bool|string
131 public static function isAllowed( $user ) {
132 foreach ( [ 'upload', 'edit' ] as $permission ) {
133 if ( !$user->isAllowed( $permission ) ) {
142 * Returns true if the user has surpassed the upload rate limit, false otherwise.
147 public static function isThrottled( $user ) {
148 return $user->pingLimiter( 'upload' );
151 // Upload handlers. Should probably just be a global.
152 private static $uploadHandlers = [ 'Stash', 'File', 'Url' ];
155 * Create a form of UploadBase depending on wpSourceType and initializes it
157 * @param WebRequest $request
158 * @param string|null $type
159 * @return null|UploadBase
161 public static function createFromRequest( &$request, $type = null ) {
162 $type = $type ?
$type : $request->getVal( 'wpSourceType', 'File' );
168 // Get the upload class
169 $type = ucfirst( $type );
171 // Give hooks the chance to handle this request
173 Hooks
::run( 'UploadCreateFromRequest', [ $type, &$className ] );
174 if ( is_null( $className ) ) {
175 $className = 'UploadFrom' . $type;
176 wfDebug( __METHOD__
. ": class name: $className\n" );
177 if ( !in_array( $type, self
::$uploadHandlers ) ) {
182 // Check whether this upload class is enabled
183 if ( !call_user_func( [ $className, 'isEnabled' ] ) ) {
187 // Check whether the request is valid
188 if ( !call_user_func( [ $className, 'isValidRequest' ], $request ) ) {
192 /** @var UploadBase $handler */
193 $handler = new $className;
195 $handler->initializeFromRequest( $request );
201 * Check whether a request if valid for this handler
202 * @param WebRequest $request
205 public static function isValidRequest( $request ) {
209 public function __construct() {
213 * Returns the upload type. Should be overridden by child classes
218 public function getSourceType() {
223 * Initialize the path information
224 * @param string $name The desired destination name
225 * @param string $tempPath The temporary path
226 * @param int $fileSize The file size
227 * @param bool $removeTempFile (false) remove the temporary file?
228 * @throws MWException
230 public function initializePathInfo( $name, $tempPath, $fileSize, $removeTempFile = false ) {
231 $this->mDesiredDestName
= $name;
232 if ( FileBackend
::isStoragePath( $tempPath ) ) {
233 throw new MWException( __METHOD__
. " given storage path `$tempPath`." );
236 $this->setTempFile( $tempPath, $fileSize );
237 $this->mRemoveTempFile
= $removeTempFile;
241 * Initialize from a WebRequest. Override this in a subclass.
243 * @param WebRequest $request
245 abstract public function initializeFromRequest( &$request );
248 * @param string $tempPath File system path to temporary file containing the upload
249 * @param integer $fileSize
251 protected function setTempFile( $tempPath, $fileSize = null ) {
252 $this->mTempPath
= $tempPath;
253 $this->mFileSize
= $fileSize ?
: null;
254 if ( strlen( $this->mTempPath
) && file_exists( $this->mTempPath
) ) {
255 $this->tempFileObj
= new TempFSFile( $this->mTempPath
);
257 $this->mFileSize
= filesize( $this->mTempPath
);
260 $this->tempFileObj
= null;
265 * Fetch the file. Usually a no-op
268 public function fetchFile() {
269 return Status
::newGood();
273 * Return true if the file is empty
276 public function isEmptyFile() {
277 return empty( $this->mFileSize
);
281 * Return the file size
284 public function getFileSize() {
285 return $this->mFileSize
;
289 * Get the base 36 SHA1 of the file
292 public function getTempFileSha1Base36() {
293 return FSFile
::getSha1Base36FromPath( $this->mTempPath
);
297 * @param string $srcPath The source path
298 * @return string|bool The real path if it was a virtual URL Returns false on failure
300 function getRealPath( $srcPath ) {
301 $repo = RepoGroup
::singleton()->getLocalRepo();
302 if ( $repo->isVirtualUrl( $srcPath ) ) {
303 /** @todo Just make uploads work with storage paths UploadFromStash
304 * loads files via virtual URLs.
306 $tmpFile = $repo->getLocalCopy( $srcPath );
308 $tmpFile->bind( $this ); // keep alive with $this
310 $path = $tmpFile ?
$tmpFile->getPath() : false;
319 * Verify whether the upload is sane.
320 * @return mixed Const self::OK or else an array with error information
322 public function verifyUpload() {
325 * If there was no filename or a zero size given, give up quick.
327 if ( $this->isEmptyFile() ) {
328 return [ 'status' => self
::EMPTY_FILE
];
332 * Honor $wgMaxUploadSize
334 $maxSize = self
::getMaxUploadSize( $this->getSourceType() );
335 if ( $this->mFileSize
> $maxSize ) {
337 'status' => self
::FILE_TOO_LARGE
,
343 * Look at the contents of the file; if we can recognize the
344 * type but it's corrupt or data of the wrong type, we should
345 * probably not accept it.
347 $verification = $this->verifyFile();
348 if ( $verification !== true ) {
350 'status' => self
::VERIFICATION_ERROR
,
351 'details' => $verification
356 * Make sure this file can be created
358 $result = $this->validateName();
359 if ( $result !== true ) {
364 if ( !Hooks
::run( 'UploadVerification',
365 [ $this->mDestName
, $this->mTempPath
, &$error ], '1.28' )
367 return [ 'status' => self
::HOOK_ABORTED
, 'error' => $error ];
370 return [ 'status' => self
::OK
];
374 * Verify that the name is valid and, if necessary, that we can overwrite
376 * @return mixed True if valid, otherwise and array with 'status'
379 public function validateName() {
380 $nt = $this->getTitle();
381 if ( is_null( $nt ) ) {
382 $result = [ 'status' => $this->mTitleError
];
383 if ( $this->mTitleError
== self
::ILLEGAL_FILENAME
) {
384 $result['filtered'] = $this->mFilteredName
;
386 if ( $this->mTitleError
== self
::FILETYPE_BADTYPE
) {
387 $result['finalExt'] = $this->mFinalExtension
;
388 if ( count( $this->mBlackListedExtensions
) ) {
389 $result['blacklistedExt'] = $this->mBlackListedExtensions
;
395 $this->mDestName
= $this->getLocalFile()->getName();
401 * Verify the MIME type.
403 * @note Only checks that it is not an evil MIME. The "does it have
404 * correct extension given its MIME type?" check is in verifyFile.
405 * in `verifyFile()` that MIME type and file extension correlate.
406 * @param string $mime Representing the MIME
407 * @return mixed True if the file is verified, an array otherwise
409 protected function verifyMimeType( $mime ) {
410 global $wgVerifyMimeType;
411 if ( $wgVerifyMimeType ) {
412 wfDebug( "mime: <$mime> extension: <{$this->mFinalExtension}>\n" );
413 global $wgMimeTypeBlacklist;
414 if ( $this->checkFileExtension( $mime, $wgMimeTypeBlacklist ) ) {
415 return [ 'filetype-badmime', $mime ];
418 # Check what Internet Explorer would detect
419 $fp = fopen( $this->mTempPath
, 'rb' );
420 $chunk = fread( $fp, 256 );
423 $magic = MimeMagic
::singleton();
424 $extMime = $magic->guessTypesForExtension( $this->mFinalExtension
);
425 $ieTypes = $magic->getIEMimeTypes( $this->mTempPath
, $chunk, $extMime );
426 foreach ( $ieTypes as $ieType ) {
427 if ( $this->checkFileExtension( $ieType, $wgMimeTypeBlacklist ) ) {
428 return [ 'filetype-bad-ie-mime', $ieType ];
437 * Verifies that it's ok to include the uploaded file
439 * @return mixed True of the file is verified, array otherwise.
441 protected function verifyFile() {
442 global $wgVerifyMimeType, $wgDisableUploadScriptChecks;
444 $status = $this->verifyPartialFile();
445 if ( $status !== true ) {
449 $this->mFileProps
= FSFile
::getPropsFromPath( $this->mTempPath
, $this->mFinalExtension
);
450 $mime = $this->mFileProps
['mime'];
452 if ( $wgVerifyMimeType ) {
453 # XXX: Missing extension will be caught by validateName() via getTitle()
454 if ( $this->mFinalExtension
!= '' && !$this->verifyExtension( $mime, $this->mFinalExtension
) ) {
455 return [ 'filetype-mime-mismatch', $this->mFinalExtension
, $mime ];
459 # check for htmlish code and javascript
460 if ( !$wgDisableUploadScriptChecks ) {
461 if ( $this->mFinalExtension
== 'svg' ||
$mime == 'image/svg+xml' ) {
462 $svgStatus = $this->detectScriptInSvg( $this->mTempPath
, false );
463 if ( $svgStatus !== false ) {
469 $handler = MediaHandler
::getHandler( $mime );
471 $handlerStatus = $handler->verifyUpload( $this->mTempPath
);
472 if ( !$handlerStatus->isOK() ) {
473 $errors = $handlerStatus->getErrorsArray();
475 return reset( $errors );
480 Hooks
::run( 'UploadVerifyFile', [ $this, $mime, &$error ] );
481 if ( $error !== true ) {
482 if ( !is_array( $error ) ) {
488 wfDebug( __METHOD__
. ": all clear; passing.\n" );
494 * A verification routine suitable for partial files
496 * Runs the blacklist checks, but not any checks that may
497 * assume the entire file is present.
499 * @return mixed True for valid or array with error message key.
501 protected function verifyPartialFile() {
502 global $wgAllowJavaUploads, $wgDisableUploadScriptChecks;
504 # getTitle() sets some internal parameters like $this->mFinalExtension
507 $this->mFileProps
= FSFile
::getPropsFromPath( $this->mTempPath
, $this->mFinalExtension
);
509 # check MIME type, if desired
510 $mime = $this->mFileProps
['file-mime'];
511 $status = $this->verifyMimeType( $mime );
512 if ( $status !== true ) {
516 # check for htmlish code and javascript
517 if ( !$wgDisableUploadScriptChecks ) {
518 if ( self
::detectScript( $this->mTempPath
, $mime, $this->mFinalExtension
) ) {
519 return [ 'uploadscripted' ];
521 if ( $this->mFinalExtension
== 'svg' ||
$mime == 'image/svg+xml' ) {
522 $svgStatus = $this->detectScriptInSvg( $this->mTempPath
, true );
523 if ( $svgStatus !== false ) {
529 # Check for Java applets, which if uploaded can bypass cross-site
531 if ( !$wgAllowJavaUploads ) {
532 $this->mJavaDetected
= false;
533 $zipStatus = ZipDirectoryReader
::read( $this->mTempPath
,
534 [ $this, 'zipEntryCallback' ] );
535 if ( !$zipStatus->isOK() ) {
536 $errors = $zipStatus->getErrorsArray();
537 $error = reset( $errors );
538 if ( $error[0] !== 'zip-wrong-format' ) {
542 if ( $this->mJavaDetected
) {
543 return [ 'uploadjava' ];
547 # Scan the uploaded file for viruses
548 $virus = $this->detectVirus( $this->mTempPath
);
550 return [ 'uploadvirus', $virus ];
557 * Callback for ZipDirectoryReader to detect Java class files.
559 * @param array $entry
561 function zipEntryCallback( $entry ) {
562 $names = [ $entry['name'] ];
564 // If there is a null character, cut off the name at it, because JDK's
565 // ZIP_GetEntry() uses strcmp() if the name hashes match. If a file name
566 // were constructed which had ".class\0" followed by a string chosen to
567 // make the hash collide with the truncated name, that file could be
568 // returned in response to a request for the .class file.
569 $nullPos = strpos( $entry['name'], "\000" );
570 if ( $nullPos !== false ) {
571 $names[] = substr( $entry['name'], 0, $nullPos );
574 // If there is a trailing slash in the file name, we have to strip it,
575 // because that's what ZIP_GetEntry() does.
576 if ( preg_grep( '!\.class/?$!', $names ) ) {
577 $this->mJavaDetected
= true;
582 * Alias for verifyTitlePermissions. The function was originally
583 * 'verifyPermissions', but that suggests it's checking the user, when it's
584 * really checking the title + user combination.
586 * @param User $user User object to verify the permissions against
587 * @return mixed An array as returned by getUserPermissionsErrors or true
588 * in case the user has proper permissions.
590 public function verifyPermissions( $user ) {
591 return $this->verifyTitlePermissions( $user );
595 * Check whether the user can edit, upload and create the image. This
596 * checks only against the current title; if it returns errors, it may
597 * very well be that another title will not give errors. Therefore
598 * isAllowed() should be called as well for generic is-user-blocked or
599 * can-user-upload checking.
601 * @param User $user User object to verify the permissions against
602 * @return mixed An array as returned by getUserPermissionsErrors or true
603 * in case the user has proper permissions.
605 public function verifyTitlePermissions( $user ) {
607 * If the image is protected, non-sysop users won't be able
608 * to modify it by uploading a new revision.
610 $nt = $this->getTitle();
611 if ( is_null( $nt ) ) {
614 $permErrors = $nt->getUserPermissionsErrors( 'edit', $user );
615 $permErrorsUpload = $nt->getUserPermissionsErrors( 'upload', $user );
616 if ( !$nt->exists() ) {
617 $permErrorsCreate = $nt->getUserPermissionsErrors( 'create', $user );
619 $permErrorsCreate = [];
621 if ( $permErrors ||
$permErrorsUpload ||
$permErrorsCreate ) {
622 $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsUpload, $permErrors ) );
623 $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsCreate, $permErrors ) );
628 $overwriteError = $this->checkOverwrite( $user );
629 if ( $overwriteError !== true ) {
630 return [ $overwriteError ];
637 * Check for non fatal problems with the file.
639 * This should not assume that mTempPath is set.
641 * @return array Array of warnings
643 public function checkWarnings() {
648 $localFile = $this->getLocalFile();
649 $localFile->load( File
::READ_LATEST
);
650 $filename = $localFile->getName();
653 * Check whether the resulting filename is different from the desired one,
654 * but ignore things like ucfirst() and spaces/underscore things
656 $comparableName = str_replace( ' ', '_', $this->mDesiredDestName
);
657 $comparableName = Title
::capitalize( $comparableName, NS_FILE
);
659 if ( $this->mDesiredDestName
!= $filename && $comparableName != $filename ) {
660 $warnings['badfilename'] = $filename;
663 // Check whether the file extension is on the unwanted list
664 global $wgCheckFileExtensions, $wgFileExtensions;
665 if ( $wgCheckFileExtensions ) {
666 $extensions = array_unique( $wgFileExtensions );
667 if ( !$this->checkFileExtension( $this->mFinalExtension
, $extensions ) ) {
668 $warnings['filetype-unwanted-type'] = [ $this->mFinalExtension
,
669 $wgLang->commaList( $extensions ), count( $extensions ) ];
673 global $wgUploadSizeWarning;
674 if ( $wgUploadSizeWarning && ( $this->mFileSize
> $wgUploadSizeWarning ) ) {
675 $warnings['large-file'] = [ $wgUploadSizeWarning, $this->mFileSize
];
678 if ( $this->mFileSize
== 0 ) {
679 $warnings['empty-file'] = true;
682 $exists = self
::getExistsWarning( $localFile );
683 if ( $exists !== false ) {
684 $warnings['exists'] = $exists;
687 if ( $localFile->wasDeleted() && !$localFile->exists() ) {
688 $warnings['was-deleted'] = $filename;
691 // Check dupes against existing files
692 $hash = $this->getTempFileSha1Base36();
693 $dupes = RepoGroup
::singleton()->findBySha1( $hash );
694 $title = $this->getTitle();
695 // Remove all matches against self
696 foreach ( $dupes as $key => $dupe ) {
697 if ( $title->equals( $dupe->getTitle() ) ) {
698 unset( $dupes[$key] );
702 $warnings['duplicate'] = $dupes;
705 // Check dupes against archives
706 $archivedFile = new ArchivedFile( null, 0, '', $hash );
707 if ( $archivedFile->getID() > 0 ) {
708 if ( $archivedFile->userCan( File
::DELETED_FILE
) ) {
709 $warnings['duplicate-archive'] = $archivedFile->getName();
711 $warnings['duplicate-archive'] = '';
719 * Really perform the upload. Stores the file in the local repo, watches
720 * if necessary and runs the UploadComplete hook.
722 * @param string $comment
723 * @param string $pageText
724 * @param bool $watch Whether the file page should be added to user's watchlist.
725 * (This doesn't check $user's permissions.)
727 * @param string[] $tags Change tags to add to the log entry and page revision.
728 * (This doesn't check $user's permissions.)
729 * @return Status Indicating the whether the upload succeeded.
731 public function performUpload( $comment, $pageText, $watch, $user, $tags = [] ) {
732 $this->getLocalFile()->load( File
::READ_LATEST
);
733 $props = $this->mFileProps
;
736 Hooks
::run( 'UploadVerifyUpload', [ $this, $user, $props, $comment, $pageText, &$error ] );
738 if ( !is_array( $error ) ) {
741 return call_user_func_array( 'Status::newFatal', $error );
744 $status = $this->getLocalFile()->upload(
755 if ( $status->isGood() ) {
757 WatchAction
::doWatch(
758 $this->getLocalFile()->getTitle(),
760 User
::IGNORE_USER_RIGHTS
763 Hooks
::run( 'UploadComplete', [ &$this ] );
765 $this->postProcessUpload();
772 * Perform extra steps after a successful upload.
776 public function postProcessUpload() {
780 * Returns the title of the file to be uploaded. Sets mTitleError in case
781 * the name was illegal.
783 * @return Title The title of the file or null in case the name was illegal
785 public function getTitle() {
786 if ( $this->mTitle
!== false ) {
787 return $this->mTitle
;
789 if ( !is_string( $this->mDesiredDestName
) ) {
790 $this->mTitleError
= self
::ILLEGAL_FILENAME
;
791 $this->mTitle
= null;
793 return $this->mTitle
;
795 /* Assume that if a user specified File:Something.jpg, this is an error
796 * and that the namespace prefix needs to be stripped of.
798 $title = Title
::newFromText( $this->mDesiredDestName
);
799 if ( $title && $title->getNamespace() == NS_FILE
) {
800 $this->mFilteredName
= $title->getDBkey();
802 $this->mFilteredName
= $this->mDesiredDestName
;
805 # oi_archive_name is max 255 bytes, which include a timestamp and an
806 # exclamation mark, so restrict file name to 240 bytes.
807 if ( strlen( $this->mFilteredName
) > 240 ) {
808 $this->mTitleError
= self
::FILENAME_TOO_LONG
;
809 $this->mTitle
= null;
811 return $this->mTitle
;
815 * Chop off any directories in the given filename. Then
816 * filter out illegal characters, and try to make a legible name
817 * out of it. We'll strip some silently that Title would die on.
819 $this->mFilteredName
= wfStripIllegalFilenameChars( $this->mFilteredName
);
820 /* Normalize to title form before we do any further processing */
821 $nt = Title
::makeTitleSafe( NS_FILE
, $this->mFilteredName
);
822 if ( is_null( $nt ) ) {
823 $this->mTitleError
= self
::ILLEGAL_FILENAME
;
824 $this->mTitle
= null;
826 return $this->mTitle
;
828 $this->mFilteredName
= $nt->getDBkey();
831 * We'll want to blacklist against *any* 'extension', and use
832 * only the final one for the whitelist.
834 list( $partname, $ext ) = $this->splitExtensions( $this->mFilteredName
);
836 if ( count( $ext ) ) {
837 $this->mFinalExtension
= trim( $ext[count( $ext ) - 1] );
839 $this->mFinalExtension
= '';
841 # No extension, try guessing one
842 $magic = MimeMagic
::singleton();
843 $mime = $magic->guessMimeType( $this->mTempPath
);
844 if ( $mime !== 'unknown/unknown' ) {
845 # Get a space separated list of extensions
846 $extList = $magic->getExtensionsForType( $mime );
848 # Set the extension to the canonical extension
849 $this->mFinalExtension
= strtok( $extList, ' ' );
851 # Fix up the other variables
852 $this->mFilteredName
.= ".{$this->mFinalExtension}";
853 $nt = Title
::makeTitleSafe( NS_FILE
, $this->mFilteredName
);
854 $ext = [ $this->mFinalExtension
];
859 /* Don't allow users to override the blacklist (check file extension) */
860 global $wgCheckFileExtensions, $wgStrictFileExtensions;
861 global $wgFileExtensions, $wgFileBlacklist;
863 $blackListedExtensions = $this->checkFileExtensionList( $ext, $wgFileBlacklist );
865 if ( $this->mFinalExtension
== '' ) {
866 $this->mTitleError
= self
::FILETYPE_MISSING
;
867 $this->mTitle
= null;
869 return $this->mTitle
;
870 } elseif ( $blackListedExtensions ||
871 ( $wgCheckFileExtensions && $wgStrictFileExtensions &&
872 !$this->checkFileExtension( $this->mFinalExtension
, $wgFileExtensions ) )
874 $this->mBlackListedExtensions
= $blackListedExtensions;
875 $this->mTitleError
= self
::FILETYPE_BADTYPE
;
876 $this->mTitle
= null;
878 return $this->mTitle
;
881 // Windows may be broken with special characters, see bug 1780
882 if ( !preg_match( '/^[\x0-\x7f]*$/', $nt->getText() )
883 && !RepoGroup
::singleton()->getLocalRepo()->backendSupportsUnicodePaths()
885 $this->mTitleError
= self
::WINDOWS_NONASCII_FILENAME
;
886 $this->mTitle
= null;
888 return $this->mTitle
;
891 # If there was more than one "extension", reassemble the base
892 # filename to prevent bogus complaints about length
893 if ( count( $ext ) > 1 ) {
894 $iterations = count( $ext ) - 1;
895 for ( $i = 0; $i < $iterations; $i++
) {
896 $partname .= '.' . $ext[$i];
900 if ( strlen( $partname ) < 1 ) {
901 $this->mTitleError
= self
::MIN_LENGTH_PARTNAME
;
902 $this->mTitle
= null;
904 return $this->mTitle
;
909 return $this->mTitle
;
913 * Return the local file and initializes if necessary.
915 * @return LocalFile|UploadStashFile|null
917 public function getLocalFile() {
918 if ( is_null( $this->mLocalFile
) ) {
919 $nt = $this->getTitle();
920 $this->mLocalFile
= is_null( $nt ) ?
null : wfLocalFile( $nt );
923 return $this->mLocalFile
;
927 * Like stashFile(), but respects extensions' wishes to prevent the stashing. verifyUpload() must
928 * be called before calling this method (unless $isPartial is true).
930 * Upload stash exceptions are also caught and converted to an error status.
934 * @param bool $isPartial Pass `true` if this is a part of a chunked upload (not a complete file).
935 * @return Status If successful, value is an UploadStashFile instance
937 public function tryStashFile( User
$user, $isPartial = false ) {
939 $props = $this->mFileProps
;
941 Hooks
::run( 'UploadStashFile', [ $this, $user, $props, &$error ] );
943 if ( !is_array( $error ) ) {
946 return call_user_func_array( 'Status::newFatal', $error );
950 $file = $this->doStashFile( $user );
951 return Status
::newGood( $file );
952 } catch ( UploadStashException
$e ) {
953 return Status
::newFatal( 'uploadstash-exception', get_class( $e ), $e->getMessage() );
958 * If the user does not supply all necessary information in the first upload
959 * form submission (either by accident or by design) then we may want to
960 * stash the file temporarily, get more information, and publish the file
963 * This method will stash a file in a temporary directory for later
964 * processing, and save the necessary descriptive info into the database.
965 * This method returns the file object, which also has a 'fileKey' property
966 * which can be passed through a form or API request to find this stashed
969 * @deprecated since 1.28 Use tryStashFile() instead
971 * @return UploadStashFile Stashed file
972 * @throws UploadStashBadPathException
973 * @throws UploadStashFileException
974 * @throws UploadStashNotLoggedInException
976 public function stashFile( User
$user = null ) {
977 return $this->doStashFile( $user );
981 * Implementation for stashFile() and tryStashFile().
984 * @return UploadStashFile Stashed file
986 protected function doStashFile( User
$user = null ) {
987 $stash = RepoGroup
::singleton()->getLocalRepo()->getUploadStash( $user );
988 $file = $stash->stashFile( $this->mTempPath
, $this->getSourceType() );
989 $this->mLocalFile
= $file;
995 * Stash a file in a temporary directory, returning a key which can be used
996 * to find the file again. See stashFile().
998 * @deprecated since 1.28
999 * @return string File key
1001 public function stashFileGetKey() {
1002 wfDeprecated( __METHOD__
, '1.28' );
1003 return $this->doStashFile()->getFileKey();
1007 * alias for stashFileGetKey, for backwards compatibility
1009 * @deprecated since 1.28
1010 * @return string File key
1012 public function stashSession() {
1013 wfDeprecated( __METHOD__
, '1.28' );
1014 return $this->doStashFile()->getFileKey();
1018 * If we've modified the upload file we need to manually remove it
1019 * on exit to clean up.
1021 public function cleanupTempFile() {
1022 if ( $this->mRemoveTempFile
&& $this->tempFileObj
) {
1023 // Delete when all relevant TempFSFile handles go out of scope
1024 wfDebug( __METHOD__
. ": Marked temporary file '{$this->mTempPath}' for removal\n" );
1025 $this->tempFileObj
->autocollect();
1029 public function getTempPath() {
1030 return $this->mTempPath
;
1034 * Split a file into a base name and all dot-delimited 'extensions'
1035 * on the end. Some web server configurations will fall back to
1036 * earlier pseudo-'extensions' to determine type and execute
1037 * scripts, so the blacklist needs to check them all.
1039 * @param string $filename
1042 public static function splitExtensions( $filename ) {
1043 $bits = explode( '.', $filename );
1044 $basename = array_shift( $bits );
1046 return [ $basename, $bits ];
1050 * Perform case-insensitive match against a list of file extensions.
1051 * Returns true if the extension is in the list.
1053 * @param string $ext
1054 * @param array $list
1057 public static function checkFileExtension( $ext, $list ) {
1058 return in_array( strtolower( $ext ), $list );
1062 * Perform case-insensitive match against a list of file extensions.
1063 * Returns an array of matching extensions.
1066 * @param array $list
1069 public static function checkFileExtensionList( $ext, $list ) {
1070 return array_intersect( array_map( 'strtolower', $ext ), $list );
1074 * Checks if the MIME type of the uploaded file matches the file extension.
1076 * @param string $mime The MIME type of the uploaded file
1077 * @param string $extension The filename extension that the file is to be served with
1080 public static function verifyExtension( $mime, $extension ) {
1081 $magic = MimeMagic
::singleton();
1083 if ( !$mime ||
$mime == 'unknown' ||
$mime == 'unknown/unknown' ) {
1084 if ( !$magic->isRecognizableExtension( $extension ) ) {
1085 wfDebug( __METHOD__
. ": passing file with unknown detected mime type; " .
1086 "unrecognized extension '$extension', can't verify\n" );
1090 wfDebug( __METHOD__
. ": rejecting file with unknown detected mime type; " .
1091 "recognized extension '$extension', so probably invalid file\n" );
1097 $match = $magic->isMatchingExtension( $extension, $mime );
1099 if ( $match === null ) {
1100 if ( $magic->getTypesForExtension( $extension ) !== null ) {
1101 wfDebug( __METHOD__
. ": No extension known for $mime, but we know a mime for $extension\n" );
1105 wfDebug( __METHOD__
. ": no file extension known for mime type $mime, passing file\n" );
1109 } elseif ( $match === true ) {
1110 wfDebug( __METHOD__
. ": mime type $mime matches extension $extension, passing file\n" );
1112 /** @todo If it's a bitmap, make sure PHP or ImageMagick resp. can handle it! */
1116 . ": mime type $mime mismatches file extension $extension, rejecting file\n" );
1123 * Heuristic for detecting files that *could* contain JavaScript instructions or
1124 * things that may look like HTML to a browser and are thus
1125 * potentially harmful. The present implementation will produce false
1126 * positives in some situations.
1128 * @param string $file Pathname to the temporary upload file
1129 * @param string $mime The MIME type of the file
1130 * @param string $extension The extension of the file
1131 * @return bool True if the file contains something looking like embedded scripts
1133 public static function detectScript( $file, $mime, $extension ) {
1134 global $wgAllowTitlesInSVG;
1136 # ugly hack: for text files, always look at the entire file.
1137 # For binary field, just check the first K.
1139 if ( strpos( $mime, 'text/' ) === 0 ) {
1140 $chunk = file_get_contents( $file );
1142 $fp = fopen( $file, 'rb' );
1143 $chunk = fread( $fp, 1024 );
1147 $chunk = strtolower( $chunk );
1153 # decode from UTF-16 if needed (could be used for obfuscation).
1154 if ( substr( $chunk, 0, 2 ) == "\xfe\xff" ) {
1156 } elseif ( substr( $chunk, 0, 2 ) == "\xff\xfe" ) {
1163 $chunk = iconv( $enc, "ASCII//IGNORE", $chunk );
1166 $chunk = trim( $chunk );
1168 /** @todo FIXME: Convert from UTF-16 if necessary! */
1169 wfDebug( __METHOD__
. ": checking for embedded scripts and HTML stuff\n" );
1171 # check for HTML doctype
1172 if ( preg_match( "/<!DOCTYPE *X?HTML/i", $chunk ) ) {
1176 // Some browsers will interpret obscure xml encodings as UTF-8, while
1177 // PHP/expat will interpret the given encoding in the xml declaration (bug 47304)
1178 if ( $extension == 'svg' ||
strpos( $mime, 'image/svg' ) === 0 ) {
1179 if ( self
::checkXMLEncodingMissmatch( $file ) ) {
1185 * Internet Explorer for Windows performs some really stupid file type
1186 * autodetection which can cause it to interpret valid image files as HTML
1187 * and potentially execute JavaScript, creating a cross-site scripting
1190 * Apple's Safari browser also performs some unsafe file type autodetection
1191 * which can cause legitimate files to be interpreted as HTML if the
1192 * web server is not correctly configured to send the right content-type
1193 * (or if you're really uploading plain text and octet streams!)
1195 * Returns true if IE is likely to mistake the given file for HTML.
1196 * Also returns true if Safari would mistake the given file for HTML
1197 * when served with a generic content-type.
1203 '<html', # also in safari
1206 '<script', # also in safari
1210 if ( !$wgAllowTitlesInSVG && $extension !== 'svg' && $mime !== 'image/svg' ) {
1214 foreach ( $tags as $tag ) {
1215 if ( false !== strpos( $chunk, $tag ) ) {
1216 wfDebug( __METHOD__
. ": found something that may make it be mistaken for html: $tag\n" );
1223 * look for JavaScript
1226 # resolve entity-refs to look at attributes. may be harsh on big files... cache result?
1227 $chunk = Sanitizer
::decodeCharReferences( $chunk );
1229 # look for script-types
1230 if ( preg_match( '!type\s*=\s*[\'"]?\s*(?:\w*/)?(?:ecma|java)!sim', $chunk ) ) {
1231 wfDebug( __METHOD__
. ": found script types\n" );
1236 # look for html-style script-urls
1237 if ( preg_match( '!(?:href|src|data)\s*=\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1238 wfDebug( __METHOD__
. ": found html-style script urls\n" );
1243 # look for css-style script-urls
1244 if ( preg_match( '!url\s*\(\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1245 wfDebug( __METHOD__
. ": found css-style script urls\n" );
1250 wfDebug( __METHOD__
. ": no scripts found\n" );
1256 * Check a whitelist of xml encodings that are known not to be interpreted differently
1257 * by the server's xml parser (expat) and some common browsers.
1259 * @param string $file Pathname to the temporary upload file
1260 * @return bool True if the file contains an encoding that could be misinterpreted
1262 public static function checkXMLEncodingMissmatch( $file ) {
1263 global $wgSVGMetadataCutoff;
1264 $contents = file_get_contents( $file, false, null, -1, $wgSVGMetadataCutoff );
1265 $encodingRegex = '!encoding[ \t\n\r]*=[ \t\n\r]*[\'"](.*?)[\'"]!si';
1267 if ( preg_match( "!<\?xml\b(.*?)\?>!si", $contents, $matches ) ) {
1268 if ( preg_match( $encodingRegex, $matches[1], $encMatch )
1269 && !in_array( strtoupper( $encMatch[1] ), self
::$safeXmlEncodings )
1271 wfDebug( __METHOD__
. ": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1275 } elseif ( preg_match( "!<\?xml\b!si", $contents ) ) {
1276 // Start of XML declaration without an end in the first $wgSVGMetadataCutoff
1277 // bytes. There shouldn't be a legitimate reason for this to happen.
1278 wfDebug( __METHOD__
. ": Unmatched XML declaration start\n" );
1281 } elseif ( substr( $contents, 0, 4 ) == "\x4C\x6F\xA7\x94" ) {
1282 // EBCDIC encoded XML
1283 wfDebug( __METHOD__
. ": EBCDIC Encoded XML\n" );
1288 // It's possible the file is encoded with multi-byte encoding, so re-encode attempt to
1289 // detect the encoding in case is specifies an encoding not whitelisted in self::$safeXmlEncodings
1290 $attemptEncodings = [ 'UTF-16', 'UTF-16BE', 'UTF-32', 'UTF-32BE' ];
1291 foreach ( $attemptEncodings as $encoding ) {
1292 MediaWiki\
suppressWarnings();
1293 $str = iconv( $encoding, 'UTF-8', $contents );
1294 MediaWiki\restoreWarnings
();
1295 if ( $str != '' && preg_match( "!<\?xml\b(.*?)\?>!si", $str, $matches ) ) {
1296 if ( preg_match( $encodingRegex, $matches[1], $encMatch )
1297 && !in_array( strtoupper( $encMatch[1] ), self
::$safeXmlEncodings )
1299 wfDebug( __METHOD__
. ": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1303 } elseif ( $str != '' && preg_match( "!<\?xml\b!si", $str ) ) {
1304 // Start of XML declaration without an end in the first $wgSVGMetadataCutoff
1305 // bytes. There shouldn't be a legitimate reason for this to happen.
1306 wfDebug( __METHOD__
. ": Unmatched XML declaration start\n" );
1316 * @param string $filename
1317 * @param bool $partial
1318 * @return mixed False of the file is verified (does not contain scripts), array otherwise.
1320 protected function detectScriptInSvg( $filename, $partial ) {
1321 $this->mSVGNSError
= false;
1322 $check = new XmlTypeCheck(
1324 [ $this, 'checkSvgScriptCallback' ],
1326 [ 'processing_instruction_handler' => 'UploadBase::checkSvgPICallback' ]
1328 if ( $check->wellFormed
!== true ) {
1329 // Invalid xml (bug 58553)
1330 // But only when non-partial (bug 65724)
1331 return $partial ?
false : [ 'uploadinvalidxml' ];
1332 } elseif ( $check->filterMatch
) {
1333 if ( $this->mSVGNSError
) {
1334 return [ 'uploadscriptednamespace', $this->mSVGNSError
];
1337 return $check->filterMatchType
;
1344 * Callback to filter SVG Processing Instructions.
1345 * @param string $target Processing instruction name
1346 * @param string $data Processing instruction attribute and value
1347 * @return bool (true if the filter identified something bad)
1349 public static function checkSvgPICallback( $target, $data ) {
1350 // Don't allow external stylesheets (bug 57550)
1351 if ( preg_match( '/xml-stylesheet/i', $target ) ) {
1352 return [ 'upload-scripted-pi-callback' ];
1359 * @todo Replace this with a whitelist filter!
1360 * @param string $element
1361 * @param array $attribs
1364 public function checkSvgScriptCallback( $element, $attribs, $data = null ) {
1366 list( $namespace, $strippedElement ) = $this->splitXmlNamespace( $element );
1368 // We specifically don't include:
1369 // http://www.w3.org/1999/xhtml (bug 60771)
1370 static $validNamespaces = [
1373 'http://creativecommons.org/ns#',
1374 'http://inkscape.sourceforge.net/dtd/sodipodi-0.dtd',
1375 'http://ns.adobe.com/adobeillustrator/10.0/',
1376 'http://ns.adobe.com/adobesvgviewerextensions/3.0/',
1377 'http://ns.adobe.com/extensibility/1.0/',
1378 'http://ns.adobe.com/flows/1.0/',
1379 'http://ns.adobe.com/illustrator/1.0/',
1380 'http://ns.adobe.com/imagereplacement/1.0/',
1381 'http://ns.adobe.com/pdf/1.3/',
1382 'http://ns.adobe.com/photoshop/1.0/',
1383 'http://ns.adobe.com/saveforweb/1.0/',
1384 'http://ns.adobe.com/variables/1.0/',
1385 'http://ns.adobe.com/xap/1.0/',
1386 'http://ns.adobe.com/xap/1.0/g/',
1387 'http://ns.adobe.com/xap/1.0/g/img/',
1388 'http://ns.adobe.com/xap/1.0/mm/',
1389 'http://ns.adobe.com/xap/1.0/rights/',
1390 'http://ns.adobe.com/xap/1.0/stype/dimensions#',
1391 'http://ns.adobe.com/xap/1.0/stype/font#',
1392 'http://ns.adobe.com/xap/1.0/stype/manifestitem#',
1393 'http://ns.adobe.com/xap/1.0/stype/resourceevent#',
1394 'http://ns.adobe.com/xap/1.0/stype/resourceref#',
1395 'http://ns.adobe.com/xap/1.0/t/pg/',
1396 'http://purl.org/dc/elements/1.1/',
1397 'http://purl.org/dc/elements/1.1',
1398 'http://schemas.microsoft.com/visio/2003/svgextensions/',
1399 'http://sodipodi.sourceforge.net/dtd/sodipodi-0.dtd',
1400 'http://taptrix.com/inkpad/svg_extensions',
1401 'http://web.resource.org/cc/',
1402 'http://www.freesoftware.fsf.org/bkchem/cdml',
1403 'http://www.inkscape.org/namespaces/inkscape',
1404 'http://www.opengis.net/gml',
1405 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
1406 'http://www.w3.org/2000/svg',
1407 'http://www.w3.org/tr/rec-rdf-syntax/',
1410 if ( !in_array( $namespace, $validNamespaces ) ) {
1411 wfDebug( __METHOD__
. ": Non-svg namespace '$namespace' in uploaded file.\n" );
1412 /** @todo Return a status object to a closure in XmlTypeCheck, for MW1.21+ */
1413 $this->mSVGNSError
= $namespace;
1419 * check for elements that can contain javascript
1421 if ( $strippedElement == 'script' ) {
1422 wfDebug( __METHOD__
. ": Found script element '$element' in uploaded file.\n" );
1424 return [ 'uploaded-script-svg', $strippedElement ];
1427 # e.g., <svg xmlns="http://www.w3.org/2000/svg">
1428 # <handler xmlns:ev="http://www.w3.org/2001/xml-events" ev:event="load">alert(1)</handler> </svg>
1429 if ( $strippedElement == 'handler' ) {
1430 wfDebug( __METHOD__
. ": Found scriptable element '$element' in uploaded file.\n" );
1432 return [ 'uploaded-script-svg', $strippedElement ];
1435 # SVG reported in Feb '12 that used xml:stylesheet to generate javascript block
1436 if ( $strippedElement == 'stylesheet' ) {
1437 wfDebug( __METHOD__
. ": Found scriptable element '$element' in uploaded file.\n" );
1439 return [ 'uploaded-script-svg', $strippedElement ];
1442 # Block iframes, in case they pass the namespace check
1443 if ( $strippedElement == 'iframe' ) {
1444 wfDebug( __METHOD__
. ": iframe in uploaded file.\n" );
1446 return [ 'uploaded-script-svg', $strippedElement ];
1450 if ( $strippedElement == 'style'
1451 && self
::checkCssFragment( Sanitizer
::normalizeCss( $data ) )
1453 wfDebug( __METHOD__
. ": hostile css in style element.\n" );
1454 return [ 'uploaded-hostile-svg' ];
1457 foreach ( $attribs as $attrib => $value ) {
1458 $stripped = $this->stripXmlNamespace( $attrib );
1459 $value = strtolower( $value );
1461 if ( substr( $stripped, 0, 2 ) == 'on' ) {
1463 . ": Found event-handler attribute '$attrib'='$value' in uploaded file.\n" );
1465 return [ 'uploaded-event-handler-on-svg', $attrib, $value ];
1468 # Do not allow relative links, or unsafe url schemas.
1469 # For <a> tags, only data:, http: and https: and same-document
1470 # fragment links are allowed. For all other tags, only data:
1471 # and fragment are allowed.
1472 if ( $stripped == 'href'
1473 && strpos( $value, 'data:' ) !== 0
1474 && strpos( $value, '#' ) !== 0
1476 if ( !( $strippedElement === 'a'
1477 && preg_match( '!^https?://!i', $value ) )
1479 wfDebug( __METHOD__
. ": Found href attribute <$strippedElement "
1480 . "'$attrib'='$value' in uploaded file.\n" );
1482 return [ 'uploaded-href-attribute-svg', $strippedElement, $attrib, $value ];
1486 # only allow data: targets that should be safe. This prevents vectors like,
1487 # image/svg, text/xml, application/xml, and text/html, which can contain scripts
1488 if ( $stripped == 'href' && strncasecmp( 'data:', $value, 5 ) === 0 ) {
1489 // rfc2397 parameters. This is only slightly slower than (;[\w;]+)*.
1490 // @codingStandardsIgnoreStart Generic.Files.LineLength
1491 $parameters = '(?>;[a-zA-Z0-9\!#$&\'*+.^_`{|}~-]+=(?>[a-zA-Z0-9\!#$&\'*+.^_`{|}~-]+|"(?>[\0-\x0c\x0e-\x21\x23-\x5b\x5d-\x7f]+|\\\\[\0-\x7f])*"))*(?:;base64)?';
1492 // @codingStandardsIgnoreEnd
1494 if ( !preg_match( "!^data:\s*image/(gif|jpeg|jpg|png)$parameters,!i", $value ) ) {
1495 wfDebug( __METHOD__
. ": Found href to unwhitelisted data: uri "
1496 . "\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1497 return [ 'uploaded-href-unsafe-target-svg', $strippedElement, $attrib, $value ];
1501 # Change href with animate from (http://html5sec.org/#137).
1502 if ( $stripped === 'attributename'
1503 && $strippedElement === 'animate'
1504 && $this->stripXmlNamespace( $value ) == 'href'
1506 wfDebug( __METHOD__
. ": Found animate that might be changing href using from "
1507 . "\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1509 return [ 'uploaded-animate-svg', $strippedElement, $attrib, $value ];
1512 # use set/animate to add event-handler attribute to parent
1513 if ( ( $strippedElement == 'set' ||
$strippedElement == 'animate' )
1514 && $stripped == 'attributename'
1515 && substr( $value, 0, 2 ) == 'on'
1517 wfDebug( __METHOD__
. ": Found svg setting event-handler attribute with "
1518 . "\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1520 return [ 'uploaded-setting-event-handler-svg', $strippedElement, $stripped, $value ];
1523 # use set to add href attribute to parent element
1524 if ( $strippedElement == 'set'
1525 && $stripped == 'attributename'
1526 && strpos( $value, 'href' ) !== false
1528 wfDebug( __METHOD__
. ": Found svg setting href attribute '$value' in uploaded file.\n" );
1530 return [ 'uploaded-setting-href-svg' ];
1533 # use set to add a remote / data / script target to an element
1534 if ( $strippedElement == 'set'
1535 && $stripped == 'to'
1536 && preg_match( '!(http|https|data|script):!sim', $value )
1538 wfDebug( __METHOD__
. ": Found svg setting attribute to '$value' in uploaded file.\n" );
1540 return [ 'uploaded-wrong-setting-svg', $value ];
1543 # use handler attribute with remote / data / script
1544 if ( $stripped == 'handler' && preg_match( '!(http|https|data|script):!sim', $value ) ) {
1545 wfDebug( __METHOD__
. ": Found svg setting handler with remote/data/script "
1546 . "'$attrib'='$value' in uploaded file.\n" );
1548 return [ 'uploaded-setting-handler-svg', $attrib, $value ];
1551 # use CSS styles to bring in remote code
1552 if ( $stripped == 'style'
1553 && self
::checkCssFragment( Sanitizer
::normalizeCss( $value ) )
1555 wfDebug( __METHOD__
. ": Found svg setting a style with "
1556 . "remote url '$attrib'='$value' in uploaded file.\n" );
1557 return [ 'uploaded-remote-url-svg', $attrib, $value ];
1560 # Several attributes can include css, css character escaping isn't allowed
1561 $cssAttrs = [ 'font', 'clip-path', 'fill', 'filter', 'marker',
1562 'marker-end', 'marker-mid', 'marker-start', 'mask', 'stroke' ];
1563 if ( in_array( $stripped, $cssAttrs )
1564 && self
::checkCssFragment( $value )
1566 wfDebug( __METHOD__
. ": Found svg setting a style with "
1567 . "remote url '$attrib'='$value' in uploaded file.\n" );
1568 return [ 'uploaded-remote-url-svg', $attrib, $value ];
1571 # image filters can pull in url, which could be svg that executes scripts
1572 if ( $strippedElement == 'image'
1573 && $stripped == 'filter'
1574 && preg_match( '!url\s*\(!sim', $value )
1576 wfDebug( __METHOD__
. ": Found image filter with url: "
1577 . "\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1579 return [ 'uploaded-image-filter-svg', $strippedElement, $stripped, $value ];
1583 return false; // No scripts detected
1587 * Check a block of CSS or CSS fragment for anything that looks like
1588 * it is bringing in remote code.
1589 * @param string $value a string of CSS
1590 * @param bool $propOnly only check css properties (start regex with :)
1591 * @return bool true if the CSS contains an illegal string, false if otherwise
1593 private static function checkCssFragment( $value ) {
1595 # Forbid external stylesheets, for both reliability and to protect viewer's privacy
1596 if ( stripos( $value, '@import' ) !== false ) {
1600 # We allow @font-face to embed fonts with data: urls, so we snip the string
1601 # 'url' out so this case won't match when we check for urls below
1602 $pattern = '!(@font-face\s*{[^}]*src:)url(\("data:;base64,)!im';
1603 $value = preg_replace( $pattern, '$1$2', $value );
1605 # Check for remote and executable CSS. Unlike in Sanitizer::checkCss, the CSS
1606 # properties filter and accelerator don't seem to be useful for xss in SVG files.
1607 # Expression and -o-link don't seem to work either, but filtering them here in case.
1608 # Additionally, we catch remote urls like url("http:..., url('http:..., url(http:...,
1609 # but not local ones such as url("#..., url('#..., url(#....
1610 if ( preg_match( '!expression
1612 | -o-link-source\s*:
1613 | -o-replace\s*:!imx', $value ) ) {
1617 if ( preg_match_all(
1618 "!(\s*(url|image|image-set)\s*\(\s*[\"']?\s*[^#]+.*?\))!sim",
1623 # TODO: redo this in one regex. Until then, url("#whatever") matches the first
1624 foreach ( $matches[1] as $match ) {
1625 if ( !preg_match( "!\s*(url|image|image-set)\s*\(\s*(#|'#|\"#)!im", $match ) ) {
1631 if ( preg_match( '/[\000-\010\013\016-\037\177]/', $value ) ) {
1639 * Divide the element name passed by the xml parser to the callback into URI and prifix.
1640 * @param string $element
1641 * @return array Containing the namespace URI and prefix
1643 private static function splitXmlNamespace( $element ) {
1644 // 'http://www.w3.org/2000/svg:script' -> array( 'http://www.w3.org/2000/svg', 'script' )
1645 $parts = explode( ':', strtolower( $element ) );
1646 $name = array_pop( $parts );
1647 $ns = implode( ':', $parts );
1649 return [ $ns, $name ];
1653 * @param string $name
1656 private function stripXmlNamespace( $name ) {
1657 // 'http://www.w3.org/2000/svg:script' -> 'script'
1658 $parts = explode( ':', strtolower( $name ) );
1660 return array_pop( $parts );
1664 * Generic wrapper function for a virus scanner program.
1665 * This relies on the $wgAntivirus and $wgAntivirusSetup variables.
1666 * $wgAntivirusRequired may be used to deny upload if the scan fails.
1668 * @param string $file Pathname to the temporary upload file
1669 * @return mixed False if not virus is found, null if the scan fails or is disabled,
1670 * or a string containing feedback from the virus scanner if a virus was found.
1671 * If textual feedback is missing but a virus was found, this function returns true.
1673 public static function detectVirus( $file ) {
1674 global $wgAntivirus, $wgAntivirusSetup, $wgAntivirusRequired, $wgOut;
1676 if ( !$wgAntivirus ) {
1677 wfDebug( __METHOD__
. ": virus scanner disabled\n" );
1682 if ( !$wgAntivirusSetup[$wgAntivirus] ) {
1683 wfDebug( __METHOD__
. ": unknown virus scanner: $wgAntivirus\n" );
1684 $wgOut->wrapWikiMsg( "<div class=\"error\">\n$1\n</div>",
1685 [ 'virus-badscanner', $wgAntivirus ] );
1687 return wfMessage( 'virus-unknownscanner' )->text() . " $wgAntivirus";
1690 # look up scanner configuration
1691 $command = $wgAntivirusSetup[$wgAntivirus]['command'];
1692 $exitCodeMap = $wgAntivirusSetup[$wgAntivirus]['codemap'];
1693 $msgPattern = isset( $wgAntivirusSetup[$wgAntivirus]['messagepattern'] ) ?
1694 $wgAntivirusSetup[$wgAntivirus]['messagepattern'] : null;
1696 if ( strpos( $command, "%f" ) === false ) {
1697 # simple pattern: append file to scan
1698 $command .= " " . wfEscapeShellArg( $file );
1700 # complex pattern: replace "%f" with file to scan
1701 $command = str_replace( "%f", wfEscapeShellArg( $file ), $command );
1704 wfDebug( __METHOD__
. ": running virus scan: $command \n" );
1706 # execute virus scanner
1709 # NOTE: there's a 50 line workaround to make stderr redirection work on windows, too.
1710 # that does not seem to be worth the pain.
1711 # Ask me (Duesentrieb) about it if it's ever needed.
1712 $output = wfShellExecWithStderr( $command, $exitCode );
1714 # map exit code to AV_xxx constants.
1715 $mappedCode = $exitCode;
1716 if ( $exitCodeMap ) {
1717 if ( isset( $exitCodeMap[$exitCode] ) ) {
1718 $mappedCode = $exitCodeMap[$exitCode];
1719 } elseif ( isset( $exitCodeMap["*"] ) ) {
1720 $mappedCode = $exitCodeMap["*"];
1724 /* NB: AV_NO_VIRUS is 0 but AV_SCAN_FAILED is false,
1725 * so we need the strict equalities === and thus can't use a switch here
1727 if ( $mappedCode === AV_SCAN_FAILED
) {
1728 # scan failed (code was mapped to false by $exitCodeMap)
1729 wfDebug( __METHOD__
. ": failed to scan $file (code $exitCode).\n" );
1731 $output = $wgAntivirusRequired
1732 ?
wfMessage( 'virus-scanfailed', [ $exitCode ] )->text()
1734 } elseif ( $mappedCode === AV_SCAN_ABORTED
) {
1735 # scan failed because filetype is unknown (probably imune)
1736 wfDebug( __METHOD__
. ": unsupported file type $file (code $exitCode).\n" );
1738 } elseif ( $mappedCode === AV_NO_VIRUS
) {
1740 wfDebug( __METHOD__
. ": file passed virus scan.\n" );
1743 $output = trim( $output );
1746 $output = true; # if there's no output, return true
1747 } elseif ( $msgPattern ) {
1749 if ( preg_match( $msgPattern, $output, $groups ) ) {
1751 $output = $groups[1];
1756 wfDebug( __METHOD__
. ": FOUND VIRUS! scanner feedback: $output \n" );
1763 * Check if there's an overwrite conflict and, if so, if restrictions
1764 * forbid this user from performing the upload.
1768 * @return mixed True on success, array on failure
1770 private function checkOverwrite( $user ) {
1771 // First check whether the local file can be overwritten
1772 $file = $this->getLocalFile();
1773 $file->load( File
::READ_LATEST
);
1774 if ( $file->exists() ) {
1775 if ( !self
::userCanReUpload( $user, $file ) ) {
1776 return [ 'fileexists-forbidden', $file->getName() ];
1782 /* Check shared conflicts: if the local file does not exist, but
1783 * wfFindFile finds a file, it exists in a shared repository.
1785 $file = wfFindFile( $this->getTitle(), [ 'latest' => true ] );
1786 if ( $file && !$user->isAllowed( 'reupload-shared' ) ) {
1787 return [ 'fileexists-shared-forbidden', $file->getName() ];
1794 * Check if a user is the last uploader
1800 public static function userCanReUpload( User
$user, File
$img ) {
1801 if ( $user->isAllowed( 'reupload' ) ) {
1802 return true; // non-conditional
1803 } elseif ( !$user->isAllowed( 'reupload-own' ) ) {
1807 if ( !( $img instanceof LocalFile
) ) {
1813 return $user->getId() == $img->getUser( 'id' );
1817 * Helper function that does various existence checks for a file.
1818 * The following checks are performed:
1820 * - Article with the same name as the file exists
1821 * - File exists with normalized extension
1822 * - The file looks like a thumbnail and the original exists
1824 * @param File $file The File object to check
1825 * @return mixed False if the file does not exists, else an array
1827 public static function getExistsWarning( $file ) {
1828 if ( $file->exists() ) {
1829 return [ 'warning' => 'exists', 'file' => $file ];
1832 if ( $file->getTitle()->getArticleID() ) {
1833 return [ 'warning' => 'page-exists', 'file' => $file ];
1836 if ( strpos( $file->getName(), '.' ) == false ) {
1837 $partname = $file->getName();
1840 $n = strrpos( $file->getName(), '.' );
1841 $extension = substr( $file->getName(), $n +
1 );
1842 $partname = substr( $file->getName(), 0, $n );
1844 $normalizedExtension = File
::normalizeExtension( $extension );
1846 if ( $normalizedExtension != $extension ) {
1847 // We're not using the normalized form of the extension.
1848 // Normal form is lowercase, using most common of alternate
1849 // extensions (eg 'jpg' rather than 'JPEG').
1851 // Check for another file using the normalized form...
1852 $nt_lc = Title
::makeTitle( NS_FILE
, "{$partname}.{$normalizedExtension}" );
1853 $file_lc = wfLocalFile( $nt_lc );
1855 if ( $file_lc->exists() ) {
1857 'warning' => 'exists-normalized',
1859 'normalizedFile' => $file_lc
1864 // Check for files with the same name but a different extension
1865 $similarFiles = RepoGroup
::singleton()->getLocalRepo()->findFilesByPrefix(
1866 "{$partname}.", 1 );
1867 if ( count( $similarFiles ) ) {
1869 'warning' => 'exists-normalized',
1871 'normalizedFile' => $similarFiles[0],
1875 if ( self
::isThumbName( $file->getName() ) ) {
1876 # Check for filenames like 50px- or 180px-, these are mostly thumbnails
1877 $nt_thb = Title
::newFromText(
1878 substr( $partname, strpos( $partname, '-' ) +
1 ) . '.' . $extension,
1881 $file_thb = wfLocalFile( $nt_thb );
1882 if ( $file_thb->exists() ) {
1884 'warning' => 'thumb',
1886 'thumbFile' => $file_thb
1889 // File does not exist, but we just don't like the name
1891 'warning' => 'thumb-name',
1893 'thumbFile' => $file_thb
1898 foreach ( self
::getFilenamePrefixBlacklist() as $prefix ) {
1899 if ( substr( $partname, 0, strlen( $prefix ) ) == $prefix ) {
1901 'warning' => 'bad-prefix',
1912 * Helper function that checks whether the filename looks like a thumbnail
1913 * @param string $filename
1916 public static function isThumbName( $filename ) {
1917 $n = strrpos( $filename, '.' );
1918 $partname = $n ?
substr( $filename, 0, $n ) : $filename;
1921 substr( $partname, 3, 3 ) == 'px-' ||
1922 substr( $partname, 2, 3 ) == 'px-'
1924 preg_match( "/[0-9]{2}/", substr( $partname, 0, 2 ) );
1928 * Get a list of blacklisted filename prefixes from [[MediaWiki:Filename-prefix-blacklist]]
1930 * @return array List of prefixes
1932 public static function getFilenamePrefixBlacklist() {
1934 $message = wfMessage( 'filename-prefix-blacklist' )->inContentLanguage();
1935 if ( !$message->isDisabled() ) {
1936 $lines = explode( "\n", $message->plain() );
1937 foreach ( $lines as $line ) {
1938 // Remove comment lines
1939 $comment = substr( trim( $line ), 0, 1 );
1940 if ( $comment == '#' ||
$comment == '' ) {
1943 // Remove additional comments after a prefix
1944 $comment = strpos( $line, '#' );
1945 if ( $comment > 0 ) {
1946 $line = substr( $line, 0, $comment - 1 );
1948 $blacklist[] = trim( $line );
1956 * Gets image info about the file just uploaded.
1958 * Also has the effect of setting metadata to be an 'indexed tag name' in
1959 * returned API result if 'metadata' was requested. Oddly, we have to pass
1960 * the "result" object down just so it can do that with the appropriate
1961 * format, presumably.
1963 * @param ApiResult $result
1964 * @return array Image info
1966 public function getImageInfo( $result ) {
1967 $file = $this->getLocalFile();
1968 /** @todo This cries out for refactoring.
1969 * We really want to say $file->getAllInfo(); here.
1970 * Perhaps "info" methods should be moved into files, and the API should
1971 * just wrap them in queries.
1973 if ( $file instanceof UploadStashFile
) {
1974 $imParam = ApiQueryStashImageInfo
::getPropertyNames();
1975 $info = ApiQueryStashImageInfo
::getInfo( $file, array_flip( $imParam ), $result );
1977 $imParam = ApiQueryImageInfo
::getPropertyNames();
1978 $info = ApiQueryImageInfo
::getInfo( $file, array_flip( $imParam ), $result );
1985 * @param array $error
1988 public function convertVerifyErrorToStatus( $error ) {
1989 $code = $error['status'];
1990 unset( $code['status'] );
1992 return Status
::newFatal( $this->getVerificationErrorCode( $code ), $error );
1996 * Get the MediaWiki maximum uploaded file size for given type of upload, based on
1999 * @param null|string $forType
2002 public static function getMaxUploadSize( $forType = null ) {
2003 global $wgMaxUploadSize;
2005 if ( is_array( $wgMaxUploadSize ) ) {
2006 if ( !is_null( $forType ) && isset( $wgMaxUploadSize[$forType] ) ) {
2007 return $wgMaxUploadSize[$forType];
2009 return $wgMaxUploadSize['*'];
2012 return intval( $wgMaxUploadSize );
2017 * Get the PHP maximum uploaded file size, based on ini settings. If there is no limit or the
2018 * limit can't be guessed, returns a very large number (PHP_INT_MAX).
2023 public static function getMaxPhpUploadSize() {
2024 $phpMaxFileSize = wfShorthandToInteger(
2025 ini_get( 'upload_max_filesize' ) ?
: ini_get( 'hhvm.server.upload.upload_max_file_size' ),
2028 $phpMaxPostSize = wfShorthandToInteger(
2029 ini_get( 'post_max_size' ) ?
: ini_get( 'hhvm.server.max_post_size' ),
2032 return min( $phpMaxFileSize, $phpMaxPostSize );
2036 * Get the current status of a chunked upload (used for polling)
2038 * The value will be read from cache.
2041 * @param string $statusKey
2042 * @return Status[]|bool
2044 public static function getSessionStatus( User
$user, $statusKey ) {
2045 $key = wfMemcKey( 'uploadstatus', $user->getId() ?
: md5( $user->getName() ), $statusKey );
2047 return ObjectCache
::getMainStashInstance()->get( $key );
2051 * Set the current status of a chunked upload (used for polling)
2053 * The value will be set in cache for 1 day
2056 * @param string $statusKey
2057 * @param array|bool $value
2060 public static function setSessionStatus( User
$user, $statusKey, $value ) {
2061 $key = wfMemcKey( 'uploadstatus', $user->getId() ?
: md5( $user->getName() ), $statusKey );
2063 $cache = ObjectCache
::getMainStashInstance();
2064 if ( $value === false ) {
2065 $cache->delete( $key );
2067 $cache->set( $key, $value, $cache::TTL_DAY
);