42 abstract class UploadBase {
46 protected $tempFileObj;
48 protected $mDesiredDestName;
52 protected $mRemoveTempFile;
54 protected $mSourceType;
58 protected $mTitleError = 0;
60 protected $mFilteredName;
62 protected $mFinalExtension;
64 protected $mLocalFile;
66 protected $mStashFile;
70 protected $mFileProps;
72 protected $mBlackListedExtensions;
74 protected $mJavaDetected;
76 protected $mSVGNSError;
78 protected static $safeXmlEncodings = [
98 const MIN_LENGTH_PARTNAME = 4;
99 const ILLEGAL_FILENAME = 5;
100 const OVERWRITE_EXISTING_FILE = 7; # Not used anymore; handled by verifyTitlePermissions()
101 const FILETYPE_MISSING = 8;
102 const FILETYPE_BADTYPE = 9;
103 const VERIFICATION_ERROR = 10;
104 const HOOK_ABORTED = 11;
105 const FILE_TOO_LARGE = 12;
106 const WINDOWS_NONASCII_FILENAME = 13;
107 const FILENAME_TOO_LONG = 14;
113 public function getVerificationErrorCode( $error ) {
115 self::EMPTY_FILE =>
'empty-file',
116 self::FILE_TOO_LARGE =>
'file-too-large',
117 self::FILETYPE_MISSING =>
'filetype-missing',
118 self::FILETYPE_BADTYPE =>
'filetype-banned',
119 self::MIN_LENGTH_PARTNAME =>
'filename-tooshort',
120 self::ILLEGAL_FILENAME =>
'illegal-filename',
121 self::OVERWRITE_EXISTING_FILE =>
'overwrite',
122 self::VERIFICATION_ERROR =>
'verification-error',
123 self::HOOK_ABORTED =>
'hookaborted',
124 self::WINDOWS_NONASCII_FILENAME =>
'windows-nonascii-filename',
125 self::FILENAME_TOO_LONG =>
'filename-toolong',
127 return $code_to_status[$error] ??
'unknown-error';
135 public static function isEnabled() {
142 # Check php's file_uploads setting
154 public static function isAllowed(
UserIdentity $user ) {
155 $permissionManager = MediaWikiServices::getInstance()->getPermissionManager();
156 foreach ( [
'upload',
'edit' ] as $permission ) {
157 if ( !$permissionManager->userHasRight( $user, $permission ) ) {
171 public static function isThrottled( $user ) {
172 return $user->pingLimiter(
'upload' );
176 private static $uploadHandlers = [
'Stash',
'File',
'Url' ];
185 public static function createFromRequest( &$request,
$type =
null ) {
186 $type =
$type ?: $request->getVal(
'wpSourceType',
'File' );
198 if ( is_null( $className ) ) {
199 $className =
'UploadFrom' .
$type;
200 wfDebug( __METHOD__ .
": class name: $className\n" );
201 if ( !in_array(
$type, self::$uploadHandlers ) ) {
207 if ( !call_user_func( [ $className,
'isEnabled' ] ) ) {
212 if ( !call_user_func( [ $className,
'isValidRequest' ], $request ) ) {
217 $handler =
new $className;
219 $handler->initializeFromRequest( $request );
229 public static function isValidRequest( $request ) {
233 public function __construct() {
242 public function getSourceType() {
254 public function initializePathInfo( $name, $tempPath, $fileSize, $removeTempFile =
false ) {
255 $this->mDesiredDestName = $name;
257 throw new MWException( __METHOD__ .
" given storage path `$tempPath`." );
260 $this->setTempFile( $tempPath, $fileSize );
261 $this->mRemoveTempFile = $removeTempFile;
269 abstract public function initializeFromRequest( &$request );
275 protected function setTempFile( $tempPath, $fileSize =
null ) {
276 $this->mTempPath = $tempPath;
277 $this->mFileSize = $fileSize ?:
null;
278 if ( strlen( $this->mTempPath ) && file_exists( $this->mTempPath ) ) {
279 $this->tempFileObj =
new TempFSFile( $this->mTempPath );
281 $this->mFileSize = filesize( $this->mTempPath );
284 $this->tempFileObj =
null;
292 public function fetchFile() {
300 public function isEmptyFile() {
301 return empty( $this->mFileSize );
308 public function getFileSize() {
309 return $this->mFileSize;
316 public function getTempFileSha1Base36() {
324 public function getRealPath( $srcPath ) {
330 $tmpFile = $repo->getLocalCopy( $srcPath );
332 $tmpFile->bind( $this );
334 $path = $tmpFile ? $tmpFile->getPath() :
false;
346 public function verifyUpload() {
350 if ( $this->isEmptyFile() ) {
351 return [
'status' => self::EMPTY_FILE ];
357 $maxSize = self::getMaxUploadSize( $this->getSourceType() );
358 if ( $this->mFileSize > $maxSize ) {
360 'status' => self::FILE_TOO_LARGE,
370 $verification = $this->verifyFile();
371 if ( $verification !==
true ) {
373 'status' => self::VERIFICATION_ERROR,
374 'details' => $verification
381 $result = $this->validateName();
382 if ( $result !==
true ) {
386 return [
'status' => self::OK ];
395 public function validateName() {
397 if ( is_null( $nt ) ) {
398 $result = [
'status' => $this->mTitleError ];
399 if ( $this->mTitleError == self::ILLEGAL_FILENAME ) {
400 $result[
'filtered'] = $this->mFilteredName;
402 if ( $this->mTitleError == self::FILETYPE_BADTYPE ) {
403 $result[
'finalExt'] = $this->mFinalExtension;
404 if ( count( $this->mBlackListedExtensions ) ) {
405 $result[
'blacklistedExt'] = $this->mBlackListedExtensions;
411 $this->mDestName = $this->getLocalFile()->getName();
425 protected function verifyMimeType( $mime ) {
428 wfDebug(
"mime: <$mime> extension: <{$this->mFinalExtension}>\n" );
431 return [
'filetype-badmime', $mime ];
435 # Check what Internet Explorer would detect
436 $fp = fopen( $this->mTempPath,
'rb' );
437 $chunk = fread( $fp, 256 );
441 $extMime = $magic->guessTypesForExtension( $this->mFinalExtension );
442 $ieTypes = $magic->getIEMimeTypes( $this->mTempPath, $chunk, $extMime );
443 foreach ( $ieTypes as $ieType ) {
445 return [
'filetype-bad-ie-mime', $ieType ];
459 protected function verifyFile() {
462 $status = $this->verifyPartialFile();
468 $this->mFileProps = $mwProps->getPropsFromPath( $this->mTempPath, $this->mFinalExtension );
469 $mime = $this->mFileProps[
'mime'];
472 # XXX: Missing extension will be caught by validateName() via getTitle()
473 if ( $this->mFinalExtension !=
'' && !$this->verifyExtension( $mime, $this->mFinalExtension ) ) {
474 return [
'filetype-mime-mismatch', $this->mFinalExtension, $mime ];
478 # check for htmlish code and javascript
480 if ( $this->mFinalExtension ==
'svg' || $mime ==
'image/svg+xml' ) {
481 $svgStatus = $this->detectScriptInSvg( $this->mTempPath,
false );
482 if ( $svgStatus !==
false ) {
490 $handlerStatus = $handler->verifyUpload( $this->mTempPath );
491 if ( !$handlerStatus->isOK() ) {
492 $errors = $handlerStatus->getErrorsArray();
494 return reset( $errors );
499 Hooks::run(
'UploadVerifyFile', [ $this, $mime, &$error ] );
500 if ( $error !==
true ) {
501 if ( !is_array( $error ) ) {
507 wfDebug( __METHOD__ .
": all clear; passing.\n" );
520 protected function verifyPartialFile() {
523 # getTitle() sets some internal parameters like $this->mFinalExtension
527 $this->mFileProps = $mwProps->getPropsFromPath( $this->mTempPath, $this->mFinalExtension );
529 # check MIME type, if desired
530 $mime = $this->mFileProps[
'file-mime'];
531 $status = $this->verifyMimeType( $mime );
536 # check for htmlish code and javascript
538 if ( self::detectScript( $this->mTempPath, $mime, $this->mFinalExtension ) ) {
539 return [
'uploadscripted' ];
541 if ( $this->mFinalExtension ==
'svg' || $mime ==
'image/svg+xml' ) {
542 $svgStatus = $this->detectScriptInSvg( $this->mTempPath,
true );
543 if ( $svgStatus !==
false ) {
549 # Check for Java applets, which if uploaded can bypass cross-site
552 $this->mJavaDetected =
false;
554 [ $this,
'zipEntryCallback' ] );
555 if ( !$zipStatus->isOK() ) {
556 $errors = $zipStatus->getErrorsArray();
557 $error = reset( $errors );
558 if ( $error[0] !==
'zip-wrong-format' ) {
562 if ( $this->mJavaDetected ) {
563 return [
'uploadjava' ];
567 # Scan the uploaded file for viruses
568 $virus = $this->detectVirus( $this->mTempPath );
570 return [
'uploadvirus', $virus ];
581 public function zipEntryCallback( $entry ) {
582 $names = [ $entry[
'name'] ];
589 $nullPos = strpos( $entry[
'name'],
"\000" );
590 if ( $nullPos !==
false ) {
591 $names[] = substr( $entry[
'name'], 0, $nullPos );
596 if ( preg_grep(
'!\.class/?$!', $names ) ) {
597 $this->mJavaDetected =
true;
610 public function verifyPermissions( $user ) {
611 return $this->verifyTitlePermissions( $user );
625 public function verifyTitlePermissions( $user ) {
631 if ( is_null( $nt ) ) {
634 $permErrors = $nt->getUserPermissionsErrors(
'edit', $user );
635 $permErrorsUpload = $nt->getUserPermissionsErrors(
'upload', $user );
636 if ( !$nt->exists() ) {
637 $permErrorsCreate = $nt->getUserPermissionsErrors(
'create', $user );
639 $permErrorsCreate = [];
641 if ( $permErrors || $permErrorsUpload || $permErrorsCreate ) {
642 $permErrors = array_merge( $permErrors,
wfArrayDiff2( $permErrorsUpload, $permErrors ) );
643 $permErrors = array_merge( $permErrors,
wfArrayDiff2( $permErrorsCreate, $permErrors ) );
648 $overwriteError = $this->checkOverwrite( $user );
649 if ( $overwriteError !==
true ) {
650 return [ $overwriteError ];
663 public function checkWarnings() {
666 $localFile = $this->getLocalFile();
667 $localFile->
load( File::READ_LATEST );
668 $filename = $localFile->
getName();
669 $hash = $this->getTempFileSha1Base36();
671 $badFileName = $this->checkBadFileName( $filename, $this->mDesiredDestName );
672 if ( $badFileName !==
null ) {
673 $warnings[
'badfilename'] = $badFileName;
676 $unwantedFileExtensionDetails = $this->checkUnwantedFileExtensions( $this->mFinalExtension );
677 if ( $unwantedFileExtensionDetails !==
null ) {
678 $warnings[
'filetype-unwanted-type'] = $unwantedFileExtensionDetails;
681 $fileSizeWarnings = $this->checkFileSize( $this->mFileSize );
682 if ( $fileSizeWarnings ) {
683 $warnings = array_merge( $warnings, $fileSizeWarnings );
686 $localFileExistsWarnings = $this->checkLocalFileExists( $localFile, $hash );
687 if ( $localFileExistsWarnings ) {
688 $warnings = array_merge( $warnings, $localFileExistsWarnings );
691 if ( $this->checkLocalFileWasDeleted( $localFile ) ) {
692 $warnings[
'was-deleted'] = $filename;
697 $ignoreLocalDupes = isset( $warnings[
'exists '] );
698 $dupes = $this->checkAgainstExistingDupes( $hash, $ignoreLocalDupes );
700 $warnings[
'duplicate'] = $dupes;
703 $archivedDupes = $this->checkAgainstArchiveDupes( $hash );
704 if ( $archivedDupes !==
null ) {
705 $warnings[
'duplicate-archive'] = $archivedDupes;
722 public static function makeWarningsSerializable( $warnings ) {
723 array_walk_recursive( $warnings,
function ( &$param, $key ) {
724 if ( $param instanceof
File ) {
726 'fileName' => $param->getName(),
727 'timestamp' => $param->getTimestamp()
729 } elseif ( is_object( $param ) ) {
730 throw new InvalidArgumentException(
731 'UploadBase::makeWarningsSerializable: ' .
732 'Unexpected object of class ' . get_class( $param ) );
747 private function checkBadFileName( $filename, $desiredFileName ) {
748 $comparableName = str_replace(
' ',
'_', $desiredFileName );
751 if ( $desiredFileName != $filename && $comparableName != $filename ) {
766 private function checkUnwantedFileExtensions( $fileExtension ) {
771 if ( !$this->checkFileExtension( $fileExtension, $extensions ) ) {
774 $wgLang->commaList( $extensions ),
788 private function checkFileSize( $fileSize ) {
797 if ( $fileSize == 0 ) {
798 $warnings[
'empty-file'] =
true;
810 private function checkLocalFileExists(
LocalFile $localFile, $hash ) {
813 $exists = self::getExistsWarning( $localFile );
814 if ( $exists !==
false ) {
815 $warnings[
'exists'] = $exists;
818 if ( $hash === $localFile->
getSha1() ) {
819 $warnings[
'no-change'] = $localFile;
824 foreach ( $history as $oldFile ) {
825 if ( $hash === $oldFile->getSha1() ) {
826 $warnings[
'duplicate-version'][] = $oldFile;
834 private function checkLocalFileWasDeleted(
LocalFile $localFile ) {
844 private function checkAgainstExistingDupes( $hash, $ignoreLocalDupes ) {
847 foreach ( $dupes as $key => $dupe ) {
851 $title->equals( $dupe->getTitle() )
853 unset( $dupes[$key] );
866 private function checkAgainstArchiveDupes( $hash ) {
868 if ( $archivedFile->getID() > 0 ) {
870 return $archivedFile->getName();
892 public function performUpload( $comment, $pageText, $watch, $user, $tags = [] ) {
893 $this->getLocalFile()->load( File::READ_LATEST );
894 $props = $this->mFileProps;
897 Hooks::run(
'UploadVerifyUpload', [ $this, $user, $props, $comment, $pageText, &$error ] );
899 if ( !is_array( $error ) ) {
905 $status = $this->getLocalFile()->upload(
926 Hooks::run(
'UploadComplete', [ &$uploadBase ] );
928 $this->postProcessUpload();
939 public function postProcessUpload() {
949 if ( $this->mTitle !==
false ) {
952 if ( !is_string( $this->mDesiredDestName ) ) {
953 $this->mTitleError = self::ILLEGAL_FILENAME;
954 $this->mTitle =
null;
963 $this->mFilteredName =
$title->getDBkey();
965 $this->mFilteredName = $this->mDesiredDestName;
968 # oi_archive_name is max 255 bytes, which include a timestamp and an
969 # exclamation mark, so restrict file name to 240 bytes.
970 if ( strlen( $this->mFilteredName ) > 240 ) {
971 $this->mTitleError = self::FILENAME_TOO_LONG;
972 $this->mTitle =
null;
985 if ( is_null( $nt ) ) {
986 $this->mTitleError = self::ILLEGAL_FILENAME;
987 $this->mTitle =
null;
991 $this->mFilteredName = $nt->
getDBkey();
997 list( $partname,
$ext ) = $this->splitExtensions( $this->mFilteredName );
1000 $this->mFinalExtension = trim( end(
$ext ) );
1002 $this->mFinalExtension =
'';
1004 # No extension, try guessing one
1006 $mime = $magic->guessMimeType( $this->mTempPath );
1007 if ( $mime !==
'unknown/unknown' ) {
1008 # Get a space separated list of extensions
1009 $extList = $magic->getExtensionsForType( $mime );
1011 # Set the extension to the canonical extension
1012 $this->mFinalExtension = strtok( $extList,
' ' );
1014 # Fix up the other variables
1015 $this->mFilteredName .=
".{$this->mFinalExtension}";
1017 $ext = [ $this->mFinalExtension ];
1028 if ( $this->mFinalExtension ==
'' ) {
1029 $this->mTitleError = self::FILETYPE_MISSING;
1030 $this->mTitle =
null;
1033 } elseif ( $blackListedExtensions ||
1037 $this->mBlackListedExtensions = $blackListedExtensions;
1038 $this->mTitleError = self::FILETYPE_BADTYPE;
1039 $this->mTitle =
null;
1045 if ( !preg_match(
'/^[\x0-\x7f]*$/', $nt->getText() )
1048 $this->mTitleError = self::WINDOWS_NONASCII_FILENAME;
1049 $this->mTitle =
null;
1054 # If there was more than one "extension", reassemble the base
1055 # filename to prevent bogus complaints about length
1056 if ( count(
$ext ) > 1 ) {
1057 $iterations = count(
$ext ) - 1;
1058 for ( $i = 0; $i < $iterations; $i++ ) {
1059 $partname .=
'.' .
$ext[$i];
1063 if ( strlen( $partname ) < 1 ) {
1064 $this->mTitleError = self::MIN_LENGTH_PARTNAME;
1065 $this->mTitle =
null;
1070 $this->mTitle = $nt;
1080 public function getLocalFile() {
1081 if ( is_null( $this->mLocalFile ) ) {
1083 $this->mLocalFile = is_null( $nt ) ? null :
wfLocalFile( $nt );
1086 return $this->mLocalFile;
1092 public function getStashFile() {
1093 return $this->mStashFile;
1107 public function tryStashFile(
User $user, $isPartial =
false ) {
1108 if ( !$isPartial ) {
1109 $error = $this->runUploadStashFileHook( $user );
1115 $file = $this->doStashFile( $user );
1118 return Status::newFatal(
'uploadstash-exception', get_class( $e ), $e->getMessage() );
1126 protected function runUploadStashFileHook(
User $user ) {
1127 $props = $this->mFileProps;
1129 Hooks::run(
'UploadStashFile', [ $this, $user, $props, &$error ] );
1130 if ( $error && !is_array( $error ) ) {
1131 $error = [ $error ];
1155 public function stashFile(
User $user =
null ) {
1158 return $this->doStashFile( $user );
1167 protected function doStashFile(
User $user =
null ) {
1169 $file = $stash->stashFile( $this->mTempPath, $this->getSourceType() );
1170 $this->mStashFile =
$file;
1179 public function cleanupTempFile() {
1180 if ( $this->mRemoveTempFile && $this->tempFileObj ) {
1182 wfDebug( __METHOD__ .
": Marked temporary file '{$this->mTempPath}' for removal\n" );
1183 $this->tempFileObj->autocollect();
1187 public function getTempPath() {
1188 return $this->mTempPath;
1200 public static function splitExtensions( $filename ) {
1201 $bits = explode(
'.', $filename );
1202 $basename = array_shift( $bits );
1204 return [ $basename, $bits ];
1215 public static function checkFileExtension(
$ext, $list ) {
1216 return in_array( strtolower(
$ext ), $list );
1227 public static function checkFileExtensionList(
$ext, $list ) {
1228 return array_intersect( array_map(
'strtolower',
$ext ), $list );
1238 public static function verifyExtension( $mime, $extension ) {
1241 if ( !$mime || $mime ==
'unknown' || $mime ==
'unknown/unknown' ) {
1242 if ( !$magic->isRecognizableExtension( $extension ) ) {
1243 wfDebug( __METHOD__ .
": passing file with unknown detected mime type; " .
1244 "unrecognized extension '$extension', can't verify\n" );
1248 wfDebug( __METHOD__ .
": rejecting file with unknown detected mime type; " .
1249 "recognized extension '$extension', so probably invalid file\n" );
1255 $match = $magic->isMatchingExtension( $extension, $mime );
1257 if ( $match ===
null ) {
1258 if ( $magic->getTypesForExtension( $extension ) !== null ) {
1259 wfDebug( __METHOD__ .
": No extension known for $mime, but we know a mime for $extension\n" );
1263 wfDebug( __METHOD__ .
": no file extension known for mime type $mime, passing file\n" );
1267 } elseif ( $match ===
true ) {
1268 wfDebug( __METHOD__ .
": mime type $mime matches extension $extension, passing file\n" );
1274 .
": mime type $mime mismatches file extension $extension, rejecting file\n" );
1291 public static function detectScript(
$file, $mime, $extension ) {
1292 # ugly hack: for text files, always look at the entire file.
1293 # For binary field, just check the first K.
1295 $isText = strpos( $mime,
'text/' ) === 0;
1297 $chunk = file_get_contents(
$file );
1299 $fp = fopen(
$file,
'rb' );
1300 $chunk = fread( $fp, 1024 );
1304 $chunk = strtolower( $chunk );
1310 # decode from UTF-16 if needed (could be used for obfuscation).
1311 if ( substr( $chunk, 0, 2 ) ==
"\xfe\xff" ) {
1313 } elseif ( substr( $chunk, 0, 2 ) ==
"\xff\xfe" ) {
1319 if ( $enc !==
null ) {
1320 $chunk = iconv( $enc,
"ASCII//IGNORE", $chunk );
1323 $chunk = trim( $chunk );
1326 wfDebug( __METHOD__ .
": checking for embedded scripts and HTML stuff\n" );
1328 # check for HTML doctype
1329 if ( preg_match(
"/<!DOCTYPE *X?HTML/i", $chunk ) ) {
1335 if ( $extension ==
'svg' || strpos( $mime,
'image/svg' ) === 0 ) {
1336 if ( self::checkXMLEncodingMissmatch(
$file ) ) {
1350 '<html', # also in safari
1351 '<script', # also in safari
1354 foreach ( $tags as $tag ) {
1355 if ( strpos( $chunk, $tag ) !==
false ) {
1356 wfDebug( __METHOD__ .
": found something that may make it be mistaken for html: $tag\n" );
1366 # resolve entity-refs to look at attributes. may be harsh on big files... cache result?
1367 $chunk = Sanitizer::decodeCharReferences( $chunk );
1369 # look for script-types
1370 if ( preg_match(
'!type\s*=\s*[\'"]?\s*(?:\w*/)?(?:ecma|java)!sim', $chunk ) ) {
1371 wfDebug( __METHOD__ .
": found script types\n" );
1376 # look for html-style script-urls
1377 if ( preg_match(
'!(?:href|src|data)\s*=\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1378 wfDebug( __METHOD__ .
": found html-style script urls\n" );
1383 # look for css-style script-urls
1384 if ( preg_match(
'!url\s*\(\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1385 wfDebug( __METHOD__ .
": found css-style script urls\n" );
1390 wfDebug( __METHOD__ .
": no scripts found\n" );
1402 public static function checkXMLEncodingMissmatch(
$file ) {
1405 $encodingRegex =
'!encoding[ \t\n\r]*=[ \t\n\r]*[\'"](.*?)[\'"]!si';
1407 if ( preg_match(
"!<\?xml\b(.*?)\?>!si", $contents,
$matches ) ) {
1408 if ( preg_match( $encodingRegex,
$matches[1], $encMatch )
1409 && !in_array( strtoupper( $encMatch[1] ), self::$safeXmlEncodings )
1411 wfDebug( __METHOD__ .
": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1415 } elseif ( preg_match(
"!<\?xml\b!si", $contents ) ) {
1418 wfDebug( __METHOD__ .
": Unmatched XML declaration start\n" );
1421 } elseif ( substr( $contents, 0, 4 ) ==
"\x4C\x6F\xA7\x94" ) {
1423 wfDebug( __METHOD__ .
": EBCDIC Encoded XML\n" );
1430 $attemptEncodings = [
'UTF-16',
'UTF-16BE',
'UTF-32',
'UTF-32BE' ];
1431 foreach ( $attemptEncodings as $encoding ) {
1432 Wikimedia\suppressWarnings();
1433 $str = iconv( $encoding,
'UTF-8', $contents );
1434 Wikimedia\restoreWarnings();
1435 if ( $str !=
'' && preg_match(
"!<\?xml\b(.*?)\?>!si", $str,
$matches ) ) {
1436 if ( preg_match( $encodingRegex,
$matches[1], $encMatch )
1437 && !in_array( strtoupper( $encMatch[1] ), self::$safeXmlEncodings )
1439 wfDebug( __METHOD__ .
": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1443 } elseif ( $str !=
'' && preg_match(
"!<\?xml\b!si", $str ) ) {
1446 wfDebug( __METHOD__ .
": Unmatched XML declaration start\n" );
1460 protected function detectScriptInSvg( $filename, $partial ) {
1461 $this->mSVGNSError =
false;
1464 [ $this,
'checkSvgScriptCallback' ],
1467 'processing_instruction_handler' =>
'UploadBase::checkSvgPICallback',
1468 'external_dtd_handler' =>
'UploadBase::checkSvgExternalDTD',
1471 if ( $check->wellFormed !==
true ) {
1474 return $partial ? false : [
'uploadinvalidxml' ];
1475 } elseif ( $check->filterMatch ) {
1476 if ( $this->mSVGNSError ) {
1477 return [
'uploadscriptednamespace', $this->mSVGNSError ];
1480 return $check->filterMatchType;
1492 public static function checkSvgPICallback( $target, $data ) {
1494 if ( preg_match(
'/xml-stylesheet/i', $target ) ) {
1495 return [
'upload-scripted-pi-callback' ];
1512 public static function checkSvgExternalDTD(
$type, $publicId, $systemId ) {
1516 'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd',
1517 'http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd',
1518 'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-basic.dtd',
1519 'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-tiny.dtd',
1521 'http://www.w3.org/TR/2001/PR-SVG-20010719/DTD/svg10.dtd',
1523 if (
$type !==
'PUBLIC'
1524 || !in_array( $systemId, $allowedDTDs )
1525 || strpos( $publicId,
"-//W3C//" ) !== 0
1527 return [
'upload-scripted-dtd' ];
1539 public function checkSvgScriptCallback( $element, $attribs, $data =
null ) {
1540 list( $namespace, $strippedElement ) = $this->splitXmlNamespace( $element );
1544 static $validNamespaces = [
1547 'http://creativecommons.org/ns#',
1548 'http://inkscape.sourceforge.net/dtd/sodipodi-0.dtd',
1549 'http://ns.adobe.com/adobeillustrator/10.0/',
1550 'http://ns.adobe.com/adobesvgviewerextensions/3.0/',
1551 'http://ns.adobe.com/extensibility/1.0/',
1552 'http://ns.adobe.com/flows/1.0/',
1553 'http://ns.adobe.com/illustrator/1.0/',
1554 'http://ns.adobe.com/imagereplacement/1.0/',
1555 'http://ns.adobe.com/pdf/1.3/',
1556 'http://ns.adobe.com/photoshop/1.0/',
1557 'http://ns.adobe.com/saveforweb/1.0/',
1558 'http://ns.adobe.com/variables/1.0/',
1559 'http://ns.adobe.com/xap/1.0/',
1560 'http://ns.adobe.com/xap/1.0/g/',
1561 'http://ns.adobe.com/xap/1.0/g/img/',
1562 'http://ns.adobe.com/xap/1.0/mm/',
1563 'http://ns.adobe.com/xap/1.0/rights/',
1564 'http://ns.adobe.com/xap/1.0/stype/dimensions#',
1565 'http://ns.adobe.com/xap/1.0/stype/font#',
1566 'http://ns.adobe.com/xap/1.0/stype/manifestitem#',
1567 'http://ns.adobe.com/xap/1.0/stype/resourceevent#',
1568 'http://ns.adobe.com/xap/1.0/stype/resourceref#',
1569 'http://ns.adobe.com/xap/1.0/t/pg/',
1570 'http://purl.org/dc/elements/1.1/',
1571 'http://purl.org/dc/elements/1.1',
1572 'http://schemas.microsoft.com/visio/2003/svgextensions/',
1573 'http://sodipodi.sourceforge.net/dtd/sodipodi-0.dtd',
1574 'http://taptrix.com/inkpad/svg_extensions',
1575 'http://web.resource.org/cc/',
1576 'http://www.freesoftware.fsf.org/bkchem/cdml',
1577 'http://www.inkscape.org/namespaces/inkscape',
1578 'http://www.opengis.net/gml',
1579 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
1580 'http://www.w3.org/2000/svg',
1581 'http://www.w3.org/tr/rec-rdf-syntax/',
1582 'http://www.w3.org/2000/01/rdf-schema#',
1587 $isBuggyInkscape = preg_match(
'/^&(#38;)*ns_[a-z_]+;$/', $namespace );
1589 if ( !( $isBuggyInkscape || in_array( $namespace, $validNamespaces ) ) ) {
1590 wfDebug( __METHOD__ .
": Non-svg namespace '$namespace' in uploaded file.\n" );
1592 $this->mSVGNSError = $namespace;
1600 if ( $strippedElement ==
'script' ) {
1601 wfDebug( __METHOD__ .
": Found script element '$element' in uploaded file.\n" );
1603 return [
'uploaded-script-svg', $strippedElement ];
1606 # e.g., <svg xmlns="http://www.w3.org/2000/svg">
1607 # <handler xmlns:ev="http://www.w3.org/2001/xml-events" ev:event="load">alert(1)</handler> </svg>
1608 if ( $strippedElement ==
'handler' ) {
1609 wfDebug( __METHOD__ .
": Found scriptable element '$element' in uploaded file.\n" );
1611 return [
'uploaded-script-svg', $strippedElement ];
1614 # SVG reported in Feb '12 that used xml:stylesheet to generate javascript block
1615 if ( $strippedElement ==
'stylesheet' ) {
1616 wfDebug( __METHOD__ .
": Found scriptable element '$element' in uploaded file.\n" );
1618 return [
'uploaded-script-svg', $strippedElement ];
1621 # Block iframes, in case they pass the namespace check
1622 if ( $strippedElement ==
'iframe' ) {
1623 wfDebug( __METHOD__ .
": iframe in uploaded file.\n" );
1625 return [
'uploaded-script-svg', $strippedElement ];
1629 if ( $strippedElement ==
'style'
1630 && self::checkCssFragment( Sanitizer::normalizeCss( $data ) )
1632 wfDebug( __METHOD__ .
": hostile css in style element.\n" );
1633 return [
'uploaded-hostile-svg' ];
1636 foreach ( $attribs as $attrib => $value ) {
1637 $stripped = $this->stripXmlNamespace( $attrib );
1638 $value = strtolower( $value );
1640 if ( substr( $stripped, 0, 2 ) ==
'on' ) {
1642 .
": Found event-handler attribute '$attrib'='$value' in uploaded file.\n" );
1644 return [
'uploaded-event-handler-on-svg', $attrib, $value ];
1647 # Do not allow relative links, or unsafe url schemas.
1648 # For <a> tags, only data:, http: and https: and same-document
1649 # fragment links are allowed. For all other tags, only data:
1650 # and fragment are allowed.
1651 if ( $stripped ==
'href'
1653 && strpos( $value,
'data:' ) !== 0
1654 && strpos( $value,
'#' ) !== 0
1656 if ( !( $strippedElement ===
'a'
1657 && preg_match(
'!^https?://!i', $value ) )
1659 wfDebug( __METHOD__ .
": Found href attribute <$strippedElement "
1660 .
"'$attrib'='$value' in uploaded file.\n" );
1662 return [
'uploaded-href-attribute-svg', $strippedElement, $attrib, $value ];
1666 # only allow data: targets that should be safe. This prevents vectors like,
1667 # image/svg, text/xml, application/xml, and text/html, which can contain scripts
1668 if ( $stripped ==
'href' && strncasecmp(
'data:', $value, 5 ) === 0 ) {
1671 $parameters =
'(?>;[a-zA-Z0-9\!#$&\'*+.^_`{|}~-]+=(?>[a-zA-Z0-9\!#$&\'*+.^_`{|}~-]+|"(?>[\0-\x0c\x0e-\x21\x23-\x5b\x5d-\x7f]+|\\\\[\0-\x7f])*"))*(?:;base64)?';
1673 if ( !preg_match(
"!^data:\s*image/(gif|jpeg|jpg|png)$parameters,!i", $value ) ) {
1674 wfDebug( __METHOD__ .
": Found href to unwhitelisted data: uri "
1675 .
"\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1676 return [
'uploaded-href-unsafe-target-svg', $strippedElement, $attrib, $value ];
1680 # Change href with animate from (http://html5sec.org/#137).
1681 if ( $stripped ===
'attributename'
1682 && $strippedElement ===
'animate'
1683 && $this->stripXmlNamespace( $value ) ==
'href'
1685 wfDebug( __METHOD__ .
": Found animate that might be changing href using from "
1686 .
"\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1688 return [
'uploaded-animate-svg', $strippedElement, $attrib, $value ];
1691 # use set/animate to add event-handler attribute to parent
1692 if ( ( $strippedElement ==
'set' || $strippedElement ==
'animate' )
1693 && $stripped ==
'attributename'
1694 && substr( $value, 0, 2 ) ==
'on'
1696 wfDebug( __METHOD__ .
": Found svg setting event-handler attribute with "
1697 .
"\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1699 return [
'uploaded-setting-event-handler-svg', $strippedElement, $stripped, $value ];
1702 # use set to add href attribute to parent element
1703 if ( $strippedElement ==
'set'
1704 && $stripped ==
'attributename'
1705 && strpos( $value,
'href' ) !==
false
1707 wfDebug( __METHOD__ .
": Found svg setting href attribute '$value' in uploaded file.\n" );
1709 return [
'uploaded-setting-href-svg' ];
1712 # use set to add a remote / data / script target to an element
1713 if ( $strippedElement ==
'set'
1714 && $stripped ==
'to'
1715 && preg_match(
'!(http|https|data|script):!sim', $value )
1717 wfDebug( __METHOD__ .
": Found svg setting attribute to '$value' in uploaded file.\n" );
1719 return [
'uploaded-wrong-setting-svg', $value ];
1722 # use handler attribute with remote / data / script
1723 if ( $stripped ==
'handler' && preg_match(
'!(http|https|data|script):!sim', $value ) ) {
1724 wfDebug( __METHOD__ .
": Found svg setting handler with remote/data/script "
1725 .
"'$attrib'='$value' in uploaded file.\n" );
1727 return [
'uploaded-setting-handler-svg', $attrib, $value ];
1730 # use CSS styles to bring in remote code
1731 if ( $stripped ==
'style'
1732 && self::checkCssFragment( Sanitizer::normalizeCss( $value ) )
1734 wfDebug( __METHOD__ .
": Found svg setting a style with "
1735 .
"remote url '$attrib'='$value' in uploaded file.\n" );
1736 return [
'uploaded-remote-url-svg', $attrib, $value ];
1739 # Several attributes can include css, css character escaping isn't allowed
1740 $cssAttrs = [
'font',
'clip-path',
'fill',
'filter',
'marker',
1741 'marker-end',
'marker-mid',
'marker-start',
'mask',
'stroke' ];
1742 if ( in_array( $stripped, $cssAttrs )
1743 && self::checkCssFragment( $value )
1745 wfDebug( __METHOD__ .
": Found svg setting a style with "
1746 .
"remote url '$attrib'='$value' in uploaded file.\n" );
1747 return [
'uploaded-remote-url-svg', $attrib, $value ];
1750 # image filters can pull in url, which could be svg that executes scripts
1751 # Only allow url( "#foo" ). Do not allow url( http://example.com )
1752 if ( $strippedElement ==
'image'
1753 && $stripped ==
'filter'
1754 && preg_match(
'!url\s*\(\s*["\']?[^#]!sim', $value )
1756 wfDebug( __METHOD__ .
": Found image filter with url: "
1757 .
"\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1759 return [
'uploaded-image-filter-svg', $strippedElement, $stripped, $value ];
1772 private static function checkCssFragment( $value ) {
1773 # Forbid external stylesheets, for both reliability and to protect viewer's privacy
1774 if ( stripos( $value,
'@import' ) !==
false ) {
1778 # We allow @font-face to embed fonts with data: urls, so we snip the string
1779 # 'url' out so this case won't match when we check for urls below
1780 $pattern =
'!(@font-face\s*{[^}]*src:)url(\("data:;base64,)!im';
1781 $value = preg_replace( $pattern,
'$1$2', $value );
1783 # Check for remote and executable CSS. Unlike in Sanitizer::checkCss, the CSS
1784 # properties filter and accelerator don't seem to be useful for xss in SVG files.
1785 # Expression and -o-link don't seem to work either, but filtering them here in case.
1786 # Additionally, we catch remote urls like url("http:..., url('http:..., url(http:...,
1787 # but not local ones such as url("#..., url('#..., url(#....
1788 if ( preg_match(
'!expression
1790 | -o-link-source\s*:
1791 | -o-replace\s*:!imx', $value ) ) {
1795 if ( preg_match_all(
1796 "!(\s*(url|image|image-set)\s*\(\s*[\"']?\s*[^#]+.*?\))!sim",
1801 # TODO: redo this in one regex. Until then, url("#whatever") matches the first
1802 foreach (
$matches[1] as $match ) {
1803 if ( !preg_match(
"!\s*(url|image|image-set)\s*\(\s*(#|'#|\"#)!im", $match ) ) {
1809 if ( preg_match(
'/[\000-\010\013\016-\037\177]/', $value ) ) {
1821 private static function splitXmlNamespace( $element ) {
1823 $parts = explode(
':', strtolower( $element ) );
1824 $name = array_pop( $parts );
1825 $ns = implode(
':', $parts );
1827 return [ $ns, $name ];
1834 private function stripXmlNamespace( $name ) {
1836 $parts = explode(
':', strtolower( $name ) );
1838 return array_pop( $parts );
1851 public static function detectVirus(
$file ) {
1855 wfDebug( __METHOD__ .
": virus scanner disabled\n" );
1861 wfDebug( __METHOD__ .
": unknown virus scanner: $wgAntivirus\n" );
1862 $wgOut->wrapWikiMsg(
"<div class=\"error\">\n$1\n</div>",
1865 return wfMessage(
'virus-unknownscanner' )->text() .
" $wgAntivirus";
1868 # look up scanner configuration
1873 if ( strpos(
$command,
"%f" ) ===
false ) {
1874 # simple pattern: append file to scan
1877 # complex pattern: replace "%f" with file to scan
1881 wfDebug( __METHOD__ .
": running virus scan: $command \n" );
1883 # execute virus scanner
1886 # NOTE: there's a 50 line workaround to make stderr redirection work on windows, too.
1887 # that does not seem to be worth the pain.
1888 # Ask me (Duesentrieb) about it if it's ever needed.
1891 # map exit code to AV_xxx constants.
1892 $mappedCode = $exitCode;
1893 if ( $exitCodeMap ) {
1894 if ( isset( $exitCodeMap[$exitCode] ) ) {
1895 $mappedCode = $exitCodeMap[$exitCode];
1896 } elseif ( isset( $exitCodeMap[
"*"] ) ) {
1897 $mappedCode = $exitCodeMap[
"*"];
1905 # scan failed (code was mapped to false by $exitCodeMap)
1906 wfDebug( __METHOD__ .
": failed to scan $file (code $exitCode).\n" );
1909 ?
wfMessage(
'virus-scanfailed', [ $exitCode ] )->text()
1912 # scan failed because filetype is unknown (probably imune)
1913 wfDebug( __METHOD__ .
": unsupported file type $file (code $exitCode).\n" );
1917 wfDebug( __METHOD__ .
": file passed virus scan.\n" );
1923 $output =
true; #
if there
's no output, return true
1924 } elseif ( $msgPattern ) {
1926 if ( preg_match( $msgPattern, $output, $groups ) && $groups[1] ) {
1927 $output = $groups[1];
1931 wfDebug( __METHOD__ . ": FOUND VIRUS! scanner feedback: $output \n" );
1945 private function checkOverwrite( $user ) {
1946 // First check whether the local file can be overwritten
1947 $file = $this->getLocalFile();
1948 $file->load( File::READ_LATEST );
1949 if ( $file->exists() ) {
1950 if ( !self::userCanReUpload( $user, $file ) ) {
1951 return [ 'fileexists-forbidden
', $file->getName() ];
1957 /* Check shared conflicts: if the local file does not exist, but
1958 * wfFindFile finds a file, it exists in a shared repository.
1960 $file = wfFindFile( $this->getTitle(), [ 'latest
' => true ] );
1961 if ( $file && !MediaWikiServices::getInstance()
1962 ->getPermissionManager()
1963 ->userHasRight( $user, 'reupload-shared
' )
1965 return [ 'fileexists-shared-forbidden
', $file->getName() ];
1978 public static function userCanReUpload( User $user, File $img ) {
1979 $permissionManager = MediaWikiServices::getInstance()->getPermissionManager();
1980 if ( $permissionManager->userHasRight( $user, 'reupload
' ) ) {
1981 return true; // non-conditional
1982 } elseif ( !$permissionManager->userHasRight( $user, 'reupload-own
' ) ) {
1986 if ( !( $img instanceof LocalFile ) ) {
1992 return $user->getId() == $img->getUser( 'id' );
2006 public static function getExistsWarning( $file ) {
2007 if ( $file->exists() ) {
2008 return [ 'warning
' => 'exists
', 'file
' => $file ];
2011 if ( $file->getTitle()->getArticleID() ) {
2012 return [ 'warning
' => 'page-exists
', 'file
' => $file ];
2015 if ( strpos( $file->getName(), '.
' ) == false ) {
2016 $partname = $file->getName();
2019 $n = strrpos( $file->getName(), '.
' );
2020 $extension = substr( $file->getName(), $n + 1 );
2021 $partname = substr( $file->getName(), 0, $n );
2023 $normalizedExtension = File::normalizeExtension( $extension );
2025 if ( $normalizedExtension != $extension ) {
2026 // We're not
using the normalized form of the extension.
2034 if ( $file_lc->exists() ) {
2036 'warning' =>
'exists-normalized',
2038 'normalizedFile' => $file_lc
2045 "{$partname}.", 1 );
2046 if ( count( $similarFiles ) ) {
2048 'warning' =>
'exists-normalized',
2050 'normalizedFile' => $similarFiles[0],
2054 if ( self::isThumbName(
$file->getName() ) ) {
2055 # Check for filenames like 50px- or 180px-, these are mostly thumbnails
2057 substr( $partname, strpos( $partname,
'-' ) + 1 ) .
'.' . $extension,
2061 if ( $file_thb->exists() ) {
2063 'warning' =>
'thumb',
2065 'thumbFile' => $file_thb
2070 'warning' =>
'thumb-name',
2072 'thumbFile' => $file_thb
2077 foreach ( self::getFilenamePrefixBlacklist() as $prefix ) {
2078 if ( substr( $partname, 0, strlen( $prefix ) ) == $prefix ) {
2080 'warning' =>
'bad-prefix',
2095 public static function isThumbName( $filename ) {
2096 $n = strrpos( $filename,
'.' );
2097 $partname = $n ? substr( $filename, 0, $n ) : $filename;
2100 substr( $partname, 3, 3 ) ==
'px-' ||
2101 substr( $partname, 2, 3 ) ==
'px-'
2103 preg_match(
"/[0-9]{2}/", substr( $partname, 0, 2 ) );
2111 public static function getFilenamePrefixBlacklist() {
2113 $message =
wfMessage(
'filename-prefix-blacklist' )->inContentLanguage();
2114 if ( !$message->isDisabled() ) {
2115 $lines = explode(
"\n", $message->plain() );
2118 $comment = substr( trim(
$line ), 0, 1 );
2119 if ( $comment ==
'#' || $comment ==
'' ) {
2123 $comment = strpos(
$line,
'#' );
2124 if ( $comment > 0 ) {
2127 $blacklist[] = trim(
$line );
2145 public function getImageInfo( $result ) {
2146 $localFile = $this->getLocalFile();
2147 $stashFile = $this->getStashFile();
2165 public function convertVerifyErrorToStatus( $error ) {
2166 $code = $error[
'status'];
2167 unset( $code[
'status'] );
2169 return Status::newFatal( $this->getVerificationErrorCode( $code ), $error );
2179 public static function getMaxUploadSize( $forType =
null ) {
2200 public static function getMaxPhpUploadSize() {
2202 ini_get(
'upload_max_filesize' ) ?: ini_get(
'hhvm.server.upload.upload_max_file_size' ),
2206 ini_get(
'post_max_size' ) ?: ini_get(
'hhvm.server.max_post_size' ),
2209 return min( $phpMaxFileSize, $phpMaxPostSize );
2221 public static function getSessionStatus(
User $user, $statusKey ) {
2222 $store = self::getUploadSessionStore();
2223 $key = self::getUploadSessionKey( $store, $user, $statusKey );
2225 return $store->
get( $key );
2240 public static function setSessionStatus(
User $user, $statusKey, $value ) {
2241 $store = self::getUploadSessionStore();
2242 $key = self::getUploadSessionKey( $store, $user, $statusKey );
2244 if ( $value ===
false ) {
2247 $store->
set( $key, $value, $store::TTL_DAY );
2257 private static function getUploadSessionKey(
BagOStuff $store,
User $user, $statusKey ) {
2268 private static function getUploadSessionStore() {