3 * Base class for the backend of file upload.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
25 * @defgroup Upload Upload related
31 * UploadBase and subclasses are the backend of MediaWiki's file uploads.
32 * The frontends are formed by ApiUpload and SpecialUpload.
34 * @author Brion Vibber
35 * @author Bryan Tong Minh
36 * @author Michael Dale
38 abstract class UploadBase
{
40 protected $mDesiredDestName, $mDestName, $mRemoveTempFile, $mSourceType;
41 protected $mTitle = false, $mTitleError = 0;
42 protected $mFilteredName, $mFinalExtension;
43 protected $mLocalFile, $mFileSize, $mFileProps;
44 protected $mBlackListedExtensions;
45 protected $mJavaDetected, $mSVGNSError;
47 protected static $safeXmlEncodings = array(
58 const MIN_LENGTH_PARTNAME
= 4;
59 const ILLEGAL_FILENAME
= 5;
60 const OVERWRITE_EXISTING_FILE
= 7; # Not used anymore; handled by verifyTitlePermissions()
61 const FILETYPE_MISSING
= 8;
62 const FILETYPE_BADTYPE
= 9;
63 const VERIFICATION_ERROR
= 10;
65 # HOOK_ABORTED is the new name of UPLOAD_VERIFICATION_ERROR
66 const UPLOAD_VERIFICATION_ERROR
= 11;
67 const HOOK_ABORTED
= 11;
68 const FILE_TOO_LARGE
= 12;
69 const WINDOWS_NONASCII_FILENAME
= 13;
70 const FILENAME_TOO_LONG
= 14;
72 const SESSION_STATUS_KEY
= 'wsUploadStatusData';
78 public function getVerificationErrorCode( $error ) {
79 $code_to_status = array(
80 self
::EMPTY_FILE
=> 'empty-file',
81 self
::FILE_TOO_LARGE
=> 'file-too-large',
82 self
::FILETYPE_MISSING
=> 'filetype-missing',
83 self
::FILETYPE_BADTYPE
=> 'filetype-banned',
84 self
::MIN_LENGTH_PARTNAME
=> 'filename-tooshort',
85 self
::ILLEGAL_FILENAME
=> 'illegal-filename',
86 self
::OVERWRITE_EXISTING_FILE
=> 'overwrite',
87 self
::VERIFICATION_ERROR
=> 'verification-error',
88 self
::HOOK_ABORTED
=> 'hookaborted',
89 self
::WINDOWS_NONASCII_FILENAME
=> 'windows-nonascii-filename',
90 self
::FILENAME_TOO_LONG
=> 'filename-toolong',
92 if ( isset( $code_to_status[$error] ) ) {
93 return $code_to_status[$error];
96 return 'unknown-error';
100 * Returns true if uploads are enabled.
101 * Can be override by subclasses.
104 public static function isEnabled() {
105 global $wgEnableUploads;
107 if ( !$wgEnableUploads ) {
111 # Check php's file_uploads setting
112 return wfIsHHVM() ||
wfIniGetBool( 'file_uploads' );
116 * Returns true if the user can use this upload module or else a string
117 * identifying the missing permission.
118 * Can be overridden by subclasses.
123 public static function isAllowed( $user ) {
124 foreach ( array( 'upload', 'edit' ) as $permission ) {
125 if ( !$user->isAllowed( $permission ) ) {
133 // Upload handlers. Should probably just be a global.
134 private static $uploadHandlers = array( 'Stash', 'File', 'Url' );
137 * Create a form of UploadBase depending on wpSourceType and initializes it
139 * @param WebRequest $request
140 * @param string|null $type
141 * @return null|UploadBase
143 public static function createFromRequest( &$request, $type = null ) {
144 $type = $type ?
$type : $request->getVal( 'wpSourceType', 'File' );
150 // Get the upload class
151 $type = ucfirst( $type );
153 // Give hooks the chance to handle this request
155 wfRunHooks( 'UploadCreateFromRequest', array( $type, &$className ) );
156 if ( is_null( $className ) ) {
157 $className = 'UploadFrom' . $type;
158 wfDebug( __METHOD__
. ": class name: $className\n" );
159 if ( !in_array( $type, self
::$uploadHandlers ) ) {
164 // Check whether this upload class is enabled
165 if ( !call_user_func( array( $className, 'isEnabled' ) ) ) {
169 // Check whether the request is valid
170 if ( !call_user_func( array( $className, 'isValidRequest' ), $request ) ) {
174 $handler = new $className;
176 $handler->initializeFromRequest( $request );
182 * Check whether a request if valid for this handler
183 * @param WebRequest $request
186 public static function isValidRequest( $request ) {
190 public function __construct() {
194 * Returns the upload type. Should be overridden by child classes
199 public function getSourceType() {
204 * Initialize the path information
205 * @param string $name The desired destination name
206 * @param string $tempPath The temporary path
207 * @param int $fileSize The file size
208 * @param bool $removeTempFile (false) remove the temporary file?
209 * @throws MWException
211 public function initializePathInfo( $name, $tempPath, $fileSize, $removeTempFile = false ) {
212 $this->mDesiredDestName
= $name;
213 if ( FileBackend
::isStoragePath( $tempPath ) ) {
214 throw new MWException( __METHOD__
. " given storage path `$tempPath`." );
216 $this->mTempPath
= $tempPath;
217 $this->mFileSize
= $fileSize;
218 $this->mRemoveTempFile
= $removeTempFile;
222 * Initialize from a WebRequest. Override this in a subclass.
224 * @param WebRequest $request
226 abstract public function initializeFromRequest( &$request );
229 * Fetch the file. Usually a no-op
232 public function fetchFile() {
233 return Status
::newGood();
237 * Return true if the file is empty
240 public function isEmptyFile() {
241 return empty( $this->mFileSize
);
245 * Return the file size
248 public function getFileSize() {
249 return $this->mFileSize
;
253 * Get the base 36 SHA1 of the file
256 public function getTempFileSha1Base36() {
257 return FSFile
::getSha1Base36FromPath( $this->mTempPath
);
261 * @param string $srcPath The source path
262 * @return string|bool The real path if it was a virtual URL Returns false on failure
264 function getRealPath( $srcPath ) {
265 wfProfileIn( __METHOD__
);
266 $repo = RepoGroup
::singleton()->getLocalRepo();
267 if ( $repo->isVirtualUrl( $srcPath ) ) {
268 /** @todo Just make uploads work with storage paths UploadFromStash
269 * loads files via virtual URLs.
271 $tmpFile = $repo->getLocalCopy( $srcPath );
273 $tmpFile->bind( $this ); // keep alive with $this
275 $path = $tmpFile ?
$tmpFile->getPath() : false;
279 wfProfileOut( __METHOD__
);
285 * Verify whether the upload is sane.
286 * @return mixed self::OK or else an array with error information
288 public function verifyUpload() {
289 wfProfileIn( __METHOD__
);
292 * If there was no filename or a zero size given, give up quick.
294 if ( $this->isEmptyFile() ) {
295 wfProfileOut( __METHOD__
);
297 return array( 'status' => self
::EMPTY_FILE
);
301 * Honor $wgMaxUploadSize
303 $maxSize = self
::getMaxUploadSize( $this->getSourceType() );
304 if ( $this->mFileSize
> $maxSize ) {
305 wfProfileOut( __METHOD__
);
308 'status' => self
::FILE_TOO_LARGE
,
314 * Look at the contents of the file; if we can recognize the
315 * type but it's corrupt or data of the wrong type, we should
316 * probably not accept it.
318 $verification = $this->verifyFile();
319 if ( $verification !== true ) {
320 wfProfileOut( __METHOD__
);
323 'status' => self
::VERIFICATION_ERROR
,
324 'details' => $verification
329 * Make sure this file can be created
331 $result = $this->validateName();
332 if ( $result !== true ) {
333 wfProfileOut( __METHOD__
);
339 if ( !wfRunHooks( 'UploadVerification',
340 array( $this->mDestName
, $this->mTempPath
, &$error ) )
342 wfProfileOut( __METHOD__
);
344 return array( 'status' => self
::HOOK_ABORTED
, 'error' => $error );
347 wfProfileOut( __METHOD__
);
349 return array( 'status' => self
::OK
);
353 * Verify that the name is valid and, if necessary, that we can overwrite
355 * @return mixed True if valid, otherwise and array with 'status'
358 public function validateName() {
359 $nt = $this->getTitle();
360 if ( is_null( $nt ) ) {
361 $result = array( 'status' => $this->mTitleError
);
362 if ( $this->mTitleError
== self
::ILLEGAL_FILENAME
) {
363 $result['filtered'] = $this->mFilteredName
;
365 if ( $this->mTitleError
== self
::FILETYPE_BADTYPE
) {
366 $result['finalExt'] = $this->mFinalExtension
;
367 if ( count( $this->mBlackListedExtensions
) ) {
368 $result['blacklistedExt'] = $this->mBlackListedExtensions
;
374 $this->mDestName
= $this->getLocalFile()->getName();
380 * Verify the mime type.
382 * @note Only checks that it is not an evil mime. The does it have
383 * correct extension given its mime type check is in verifyFile.
384 * @param string $mime Representing the mime
385 * @return mixed True if the file is verified, an array otherwise
387 protected function verifyMimeType( $mime ) {
388 global $wgVerifyMimeType;
389 wfProfileIn( __METHOD__
);
390 if ( $wgVerifyMimeType ) {
391 wfDebug( "\n\nmime: <$mime> extension: <{$this->mFinalExtension}>\n\n" );
392 global $wgMimeTypeBlacklist;
393 if ( $this->checkFileExtension( $mime, $wgMimeTypeBlacklist ) ) {
394 wfProfileOut( __METHOD__
);
396 return array( 'filetype-badmime', $mime );
400 $fp = fopen( $this->mTempPath
, 'rb' );
401 $chunk = fread( $fp, 256 );
404 $magic = MimeMagic
::singleton();
405 $extMime = $magic->guessTypesForExtension( $this->mFinalExtension
);
406 $ieTypes = $magic->getIEMimeTypes( $this->mTempPath
, $chunk, $extMime );
407 foreach ( $ieTypes as $ieType ) {
408 if ( $this->checkFileExtension( $ieType, $wgMimeTypeBlacklist ) ) {
409 wfProfileOut( __METHOD__
);
411 return array( 'filetype-bad-ie-mime', $ieType );
416 wfProfileOut( __METHOD__
);
422 * Verifies that it's ok to include the uploaded file
424 * @return mixed True of the file is verified, array otherwise.
426 protected function verifyFile() {
427 global $wgVerifyMimeType;
428 wfProfileIn( __METHOD__
);
430 $status = $this->verifyPartialFile();
431 if ( $status !== true ) {
432 wfProfileOut( __METHOD__
);
437 $this->mFileProps
= FSFile
::getPropsFromPath( $this->mTempPath
, $this->mFinalExtension
);
438 $mime = $this->mFileProps
['file-mime'];
440 if ( $wgVerifyMimeType ) {
441 # XXX: Missing extension will be caught by validateName() via getTitle()
442 if ( $this->mFinalExtension
!= '' && !$this->verifyExtension( $mime, $this->mFinalExtension
) ) {
443 wfProfileOut( __METHOD__
);
445 return array( 'filetype-mime-mismatch', $this->mFinalExtension
, $mime );
449 $handler = MediaHandler
::getHandler( $mime );
451 $handlerStatus = $handler->verifyUpload( $this->mTempPath
);
452 if ( !$handlerStatus->isOK() ) {
453 $errors = $handlerStatus->getErrorsArray();
454 wfProfileOut( __METHOD__
);
456 return reset( $errors );
460 wfRunHooks( 'UploadVerifyFile', array( $this, $mime, &$status ) );
461 if ( $status !== true ) {
462 wfProfileOut( __METHOD__
);
467 wfDebug( __METHOD__
. ": all clear; passing.\n" );
468 wfProfileOut( __METHOD__
);
474 * A verification routine suitable for partial files
476 * Runs the blacklist checks, but not any checks that may
477 * assume the entire file is present.
479 * @return mixed True for valid or array with error message key.
481 protected function verifyPartialFile() {
482 global $wgAllowJavaUploads, $wgDisableUploadScriptChecks;
483 wfProfileIn( __METHOD__
);
485 # getTitle() sets some internal parameters like $this->mFinalExtension
488 $this->mFileProps
= FSFile
::getPropsFromPath( $this->mTempPath
, $this->mFinalExtension
);
490 # check mime type, if desired
491 $mime = $this->mFileProps
['file-mime'];
492 $status = $this->verifyMimeType( $mime );
493 if ( $status !== true ) {
494 wfProfileOut( __METHOD__
);
499 # check for htmlish code and javascript
500 if ( !$wgDisableUploadScriptChecks ) {
501 if ( self
::detectScript( $this->mTempPath
, $mime, $this->mFinalExtension
) ) {
502 wfProfileOut( __METHOD__
);
504 return array( 'uploadscripted' );
506 if ( $this->mFinalExtension
== 'svg' ||
$mime == 'image/svg+xml' ) {
507 $svgStatus = $this->detectScriptInSvg( $this->mTempPath
);
508 if ( $svgStatus !== false ) {
509 wfProfileOut( __METHOD__
);
516 # Check for Java applets, which if uploaded can bypass cross-site
518 if ( !$wgAllowJavaUploads ) {
519 $this->mJavaDetected
= false;
520 $zipStatus = ZipDirectoryReader
::read( $this->mTempPath
,
521 array( $this, 'zipEntryCallback' ) );
522 if ( !$zipStatus->isOK() ) {
523 $errors = $zipStatus->getErrorsArray();
524 $error = reset( $errors );
525 if ( $error[0] !== 'zip-wrong-format' ) {
526 wfProfileOut( __METHOD__
);
531 if ( $this->mJavaDetected
) {
532 wfProfileOut( __METHOD__
);
534 return array( 'uploadjava' );
538 # Scan the uploaded file for viruses
539 $virus = $this->detectVirus( $this->mTempPath
);
541 wfProfileOut( __METHOD__
);
543 return array( 'uploadvirus', $virus );
546 wfProfileOut( __METHOD__
);
552 * Callback for ZipDirectoryReader to detect Java class files.
554 * @param array $entry
556 function zipEntryCallback( $entry ) {
557 $names = array( $entry['name'] );
559 // If there is a null character, cut off the name at it, because JDK's
560 // ZIP_GetEntry() uses strcmp() if the name hashes match. If a file name
561 // were constructed which had ".class\0" followed by a string chosen to
562 // make the hash collide with the truncated name, that file could be
563 // returned in response to a request for the .class file.
564 $nullPos = strpos( $entry['name'], "\000" );
565 if ( $nullPos !== false ) {
566 $names[] = substr( $entry['name'], 0, $nullPos );
569 // If there is a trailing slash in the file name, we have to strip it,
570 // because that's what ZIP_GetEntry() does.
571 if ( preg_grep( '!\.class/?$!', $names ) ) {
572 $this->mJavaDetected
= true;
577 * Alias for verifyTitlePermissions. The function was originally
578 * 'verifyPermissions', but that suggests it's checking the user, when it's
579 * really checking the title + user combination.
581 * @param User $user User object to verify the permissions against
582 * @return mixed An array as returned by getUserPermissionsErrors or true
583 * in case the user has proper permissions.
585 public function verifyPermissions( $user ) {
586 return $this->verifyTitlePermissions( $user );
590 * Check whether the user can edit, upload and create the image. This
591 * checks only against the current title; if it returns errors, it may
592 * very well be that another title will not give errors. Therefore
593 * isAllowed() should be called as well for generic is-user-blocked or
594 * can-user-upload checking.
596 * @param User $user object to verify the permissions against
597 * @return mixed An array as returned by getUserPermissionsErrors or true
598 * in case the user has proper permissions.
600 public function verifyTitlePermissions( $user ) {
602 * If the image is protected, non-sysop users won't be able
603 * to modify it by uploading a new revision.
605 $nt = $this->getTitle();
606 if ( is_null( $nt ) ) {
609 $permErrors = $nt->getUserPermissionsErrors( 'edit', $user );
610 $permErrorsUpload = $nt->getUserPermissionsErrors( 'upload', $user );
611 if ( !$nt->exists() ) {
612 $permErrorsCreate = $nt->getUserPermissionsErrors( 'create', $user );
614 $permErrorsCreate = array();
616 if ( $permErrors ||
$permErrorsUpload ||
$permErrorsCreate ) {
617 $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsUpload, $permErrors ) );
618 $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsCreate, $permErrors ) );
623 $overwriteError = $this->checkOverwrite( $user );
624 if ( $overwriteError !== true ) {
625 return array( $overwriteError );
632 * Check for non fatal problems with the file.
634 * This should not assume that mTempPath is set.
636 * @return array Array of warnings
638 public function checkWarnings() {
640 wfProfileIn( __METHOD__
);
644 $localFile = $this->getLocalFile();
645 $filename = $localFile->getName();
648 * Check whether the resulting filename is different from the desired one,
649 * but ignore things like ucfirst() and spaces/underscore things
651 $comparableName = str_replace( ' ', '_', $this->mDesiredDestName
);
652 $comparableName = Title
::capitalize( $comparableName, NS_FILE
);
654 if ( $this->mDesiredDestName
!= $filename && $comparableName != $filename ) {
655 $warnings['badfilename'] = $filename;
656 // Debugging for bug 62241
657 wfDebugLog( 'upload', "Filename: '$filename', mDesiredDestName: "
658 . "'$this->mDesiredDestName', comparableName: '$comparableName'" );
661 // Check whether the file extension is on the unwanted list
662 global $wgCheckFileExtensions, $wgFileExtensions;
663 if ( $wgCheckFileExtensions ) {
664 $extensions = array_unique( $wgFileExtensions );
665 if ( !$this->checkFileExtension( $this->mFinalExtension
, $extensions ) ) {
666 $warnings['filetype-unwanted-type'] = array( $this->mFinalExtension
,
667 $wgLang->commaList( $extensions ), count( $extensions ) );
671 global $wgUploadSizeWarning;
672 if ( $wgUploadSizeWarning && ( $this->mFileSize
> $wgUploadSizeWarning ) ) {
673 $warnings['large-file'] = array( $wgUploadSizeWarning, $this->mFileSize
);
676 if ( $this->mFileSize
== 0 ) {
677 $warnings['emptyfile'] = true;
680 $exists = self
::getExistsWarning( $localFile );
681 if ( $exists !== false ) {
682 $warnings['exists'] = $exists;
685 // Check dupes against existing files
686 $hash = $this->getTempFileSha1Base36();
687 $dupes = RepoGroup
::singleton()->findBySha1( $hash );
688 $title = $this->getTitle();
689 // Remove all matches against self
690 foreach ( $dupes as $key => $dupe ) {
691 if ( $title->equals( $dupe->getTitle() ) ) {
692 unset( $dupes[$key] );
696 $warnings['duplicate'] = $dupes;
699 // Check dupes against archives
700 $archivedImage = new ArchivedFile( null, 0, "{$hash}.{$this->mFinalExtension}" );
701 if ( $archivedImage->getID() > 0 ) {
702 if ( $archivedImage->userCan( File
::DELETED_FILE
) ) {
703 $warnings['duplicate-archive'] = $archivedImage->getName();
705 $warnings['duplicate-archive'] = '';
709 wfProfileOut( __METHOD__
);
715 * Really perform the upload. Stores the file in the local repo, watches
716 * if necessary and runs the UploadComplete hook.
718 * @param string $comment
719 * @param string $pageText
723 * @return Status Indicating the whether the upload succeeded.
725 public function performUpload( $comment, $pageText, $watch, $user ) {
726 wfProfileIn( __METHOD__
);
728 $status = $this->getLocalFile()->upload(
738 if ( $status->isGood() ) {
740 WatchAction
::doWatch(
741 $this->getLocalFile()->getTitle(),
743 WatchedItem
::IGNORE_USER_RIGHTS
746 wfRunHooks( 'UploadComplete', array( &$this ) );
749 wfProfileOut( __METHOD__
);
755 * Returns the title of the file to be uploaded. Sets mTitleError in case
756 * the name was illegal.
758 * @return Title The title of the file or null in case the name was illegal
760 public function getTitle() {
761 if ( $this->mTitle
!== false ) {
762 return $this->mTitle
;
764 /* Assume that if a user specified File:Something.jpg, this is an error
765 * and that the namespace prefix needs to be stripped of.
767 $title = Title
::newFromText( $this->mDesiredDestName
);
768 if ( $title && $title->getNamespace() == NS_FILE
) {
769 $this->mFilteredName
= $title->getDBkey();
771 $this->mFilteredName
= $this->mDesiredDestName
;
774 # oi_archive_name is max 255 bytes, which include a timestamp and an
775 # exclamation mark, so restrict file name to 240 bytes.
776 if ( strlen( $this->mFilteredName
) > 240 ) {
777 $this->mTitleError
= self
::FILENAME_TOO_LONG
;
778 $this->mTitle
= null;
780 return $this->mTitle
;
784 * Chop off any directories in the given filename. Then
785 * filter out illegal characters, and try to make a legible name
786 * out of it. We'll strip some silently that Title would die on.
788 $this->mFilteredName
= wfStripIllegalFilenameChars( $this->mFilteredName
);
789 /* Normalize to title form before we do any further processing */
790 $nt = Title
::makeTitleSafe( NS_FILE
, $this->mFilteredName
);
791 if ( is_null( $nt ) ) {
792 $this->mTitleError
= self
::ILLEGAL_FILENAME
;
793 $this->mTitle
= null;
795 return $this->mTitle
;
797 $this->mFilteredName
= $nt->getDBkey();
800 * We'll want to blacklist against *any* 'extension', and use
801 * only the final one for the whitelist.
803 list( $partname, $ext ) = $this->splitExtensions( $this->mFilteredName
);
805 if ( count( $ext ) ) {
806 $this->mFinalExtension
= trim( $ext[count( $ext ) - 1] );
808 $this->mFinalExtension
= '';
810 # No extension, try guessing one
811 $magic = MimeMagic
::singleton();
812 $mime = $magic->guessMimeType( $this->mTempPath
);
813 if ( $mime !== 'unknown/unknown' ) {
814 # Get a space separated list of extensions
815 $extList = $magic->getExtensionsForType( $mime );
817 # Set the extension to the canonical extension
818 $this->mFinalExtension
= strtok( $extList, ' ' );
820 # Fix up the other variables
821 $this->mFilteredName
.= ".{$this->mFinalExtension}";
822 $nt = Title
::makeTitleSafe( NS_FILE
, $this->mFilteredName
);
823 $ext = array( $this->mFinalExtension
);
828 /* Don't allow users to override the blacklist (check file extension) */
829 global $wgCheckFileExtensions, $wgStrictFileExtensions;
830 global $wgFileExtensions, $wgFileBlacklist;
832 $blackListedExtensions = $this->checkFileExtensionList( $ext, $wgFileBlacklist );
834 if ( $this->mFinalExtension
== '' ) {
835 $this->mTitleError
= self
::FILETYPE_MISSING
;
836 $this->mTitle
= null;
838 return $this->mTitle
;
839 } elseif ( $blackListedExtensions ||
840 ( $wgCheckFileExtensions && $wgStrictFileExtensions &&
841 !$this->checkFileExtension( $this->mFinalExtension
, $wgFileExtensions ) )
843 $this->mBlackListedExtensions
= $blackListedExtensions;
844 $this->mTitleError
= self
::FILETYPE_BADTYPE
;
845 $this->mTitle
= null;
847 return $this->mTitle
;
850 // Windows may be broken with special characters, see bug 1780
851 if ( !preg_match( '/^[\x0-\x7f]*$/', $nt->getText() )
852 && !RepoGroup
::singleton()->getLocalRepo()->backendSupportsUnicodePaths()
854 $this->mTitleError
= self
::WINDOWS_NONASCII_FILENAME
;
855 $this->mTitle
= null;
857 return $this->mTitle
;
860 # If there was more than one "extension", reassemble the base
861 # filename to prevent bogus complaints about length
862 if ( count( $ext ) > 1 ) {
863 $iterations = count( $ext ) - 1;
864 for ( $i = 0; $i < $iterations; $i++
) {
865 $partname .= '.' . $ext[$i];
869 if ( strlen( $partname ) < 1 ) {
870 $this->mTitleError
= self
::MIN_LENGTH_PARTNAME
;
871 $this->mTitle
= null;
873 return $this->mTitle
;
878 return $this->mTitle
;
882 * Return the local file and initializes if necessary.
884 * @return LocalFile|null
886 public function getLocalFile() {
887 if ( is_null( $this->mLocalFile
) ) {
888 $nt = $this->getTitle();
889 $this->mLocalFile
= is_null( $nt ) ?
null : wfLocalFile( $nt );
892 return $this->mLocalFile
;
896 * If the user does not supply all necessary information in the first upload
897 * form submission (either by accident or by design) then we may want to
898 * stash the file temporarily, get more information, and publish the file
901 * This method will stash a file in a temporary directory for later
902 * processing, and save the necessary descriptive info into the database.
903 * This method returns the file object, which also has a 'fileKey' property
904 * which can be passed through a form or API request to find this stashed
908 * @return UploadStashFile Stashed file
910 public function stashFile( User
$user = null ) {
911 // was stashSessionFile
912 wfProfileIn( __METHOD__
);
914 $stash = RepoGroup
::singleton()->getLocalRepo()->getUploadStash( $user );
915 $file = $stash->stashFile( $this->mTempPath
, $this->getSourceType() );
916 $this->mLocalFile
= $file;
918 wfProfileOut( __METHOD__
);
924 * Stash a file in a temporary directory, returning a key which can be used
925 * to find the file again. See stashFile().
927 * @return string File key
929 public function stashFileGetKey() {
930 return $this->stashFile()->getFileKey();
934 * alias for stashFileGetKey, for backwards compatibility
936 * @return string File key
938 public function stashSession() {
939 return $this->stashFileGetKey();
943 * If we've modified the upload file we need to manually remove it
944 * on exit to clean up.
946 public function cleanupTempFile() {
947 if ( $this->mRemoveTempFile
&& $this->mTempPath
&& file_exists( $this->mTempPath
) ) {
948 wfDebug( __METHOD__
. ": Removing temporary file {$this->mTempPath}\n" );
949 unlink( $this->mTempPath
);
953 public function getTempPath() {
954 return $this->mTempPath
;
958 * Split a file into a base name and all dot-delimited 'extensions'
959 * on the end. Some web server configurations will fall back to
960 * earlier pseudo-'extensions' to determine type and execute
961 * scripts, so the blacklist needs to check them all.
963 * @param string $filename
966 public static function splitExtensions( $filename ) {
967 $bits = explode( '.', $filename );
968 $basename = array_shift( $bits );
970 return array( $basename, $bits );
974 * Perform case-insensitive match against a list of file extensions.
975 * Returns true if the extension is in the list.
981 public static function checkFileExtension( $ext, $list ) {
982 return in_array( strtolower( $ext ), $list );
986 * Perform case-insensitive match against a list of file extensions.
987 * Returns an array of matching extensions.
993 public static function checkFileExtensionList( $ext, $list ) {
994 return array_intersect( array_map( 'strtolower', $ext ), $list );
998 * Checks if the mime type of the uploaded file matches the file extension.
1000 * @param string $mime The mime type of the uploaded file
1001 * @param string $extension The filename extension that the file is to be served with
1004 public static function verifyExtension( $mime, $extension ) {
1005 $magic = MimeMagic
::singleton();
1007 if ( !$mime ||
$mime == 'unknown' ||
$mime == 'unknown/unknown' ) {
1008 if ( !$magic->isRecognizableExtension( $extension ) ) {
1009 wfDebug( __METHOD__
. ": passing file with unknown detected mime type; " .
1010 "unrecognized extension '$extension', can't verify\n" );
1014 wfDebug( __METHOD__
. ": rejecting file with unknown detected mime type; " .
1015 "recognized extension '$extension', so probably invalid file\n" );
1021 $match = $magic->isMatchingExtension( $extension, $mime );
1023 if ( $match === null ) {
1024 if ( $magic->getTypesForExtension( $extension ) !== null ) {
1025 wfDebug( __METHOD__
. ": No extension known for $mime, but we know a mime for $extension\n" );
1029 wfDebug( __METHOD__
. ": no file extension known for mime type $mime, passing file\n" );
1033 } elseif ( $match === true ) {
1034 wfDebug( __METHOD__
. ": mime type $mime matches extension $extension, passing file\n" );
1036 /** @todo If it's a bitmap, make sure PHP or ImageMagick resp. can handle it! */
1040 . ": mime type $mime mismatches file extension $extension, rejecting file\n" );
1047 * Heuristic for detecting files that *could* contain JavaScript instructions or
1048 * things that may look like HTML to a browser and are thus
1049 * potentially harmful. The present implementation will produce false
1050 * positives in some situations.
1052 * @param string $file Pathname to the temporary upload file
1053 * @param string $mime The mime type of the file
1054 * @param string $extension The extension of the file
1055 * @return bool True if the file contains something looking like embedded scripts
1057 public static function detectScript( $file, $mime, $extension ) {
1058 global $wgAllowTitlesInSVG;
1059 wfProfileIn( __METHOD__
);
1061 # ugly hack: for text files, always look at the entire file.
1062 # For binary field, just check the first K.
1064 if ( strpos( $mime, 'text/' ) === 0 ) {
1065 $chunk = file_get_contents( $file );
1067 $fp = fopen( $file, 'rb' );
1068 $chunk = fread( $fp, 1024 );
1072 $chunk = strtolower( $chunk );
1075 wfProfileOut( __METHOD__
);
1080 # decode from UTF-16 if needed (could be used for obfuscation).
1081 if ( substr( $chunk, 0, 2 ) == "\xfe\xff" ) {
1083 } elseif ( substr( $chunk, 0, 2 ) == "\xff\xfe" ) {
1090 $chunk = iconv( $enc, "ASCII//IGNORE", $chunk );
1093 $chunk = trim( $chunk );
1095 /** @todo FIXME: Convert from UTF-16 if necessary! */
1096 wfDebug( __METHOD__
. ": checking for embedded scripts and HTML stuff\n" );
1098 # check for HTML doctype
1099 if ( preg_match( "/<!DOCTYPE *X?HTML/i", $chunk ) ) {
1100 wfProfileOut( __METHOD__
);
1105 // Some browsers will interpret obscure xml encodings as UTF-8, while
1106 // PHP/expat will interpret the given encoding in the xml declaration (bug 47304)
1107 if ( $extension == 'svg' ||
strpos( $mime, 'image/svg' ) === 0 ) {
1108 if ( self
::checkXMLEncodingMissmatch( $file ) ) {
1109 wfProfileOut( __METHOD__
);
1116 * Internet Explorer for Windows performs some really stupid file type
1117 * autodetection which can cause it to interpret valid image files as HTML
1118 * and potentially execute JavaScript, creating a cross-site scripting
1121 * Apple's Safari browser also performs some unsafe file type autodetection
1122 * which can cause legitimate files to be interpreted as HTML if the
1123 * web server is not correctly configured to send the right content-type
1124 * (or if you're really uploading plain text and octet streams!)
1126 * Returns true if IE is likely to mistake the given file for HTML.
1127 * Also returns true if Safari would mistake the given file for HTML
1128 * when served with a generic content-type.
1134 '<html', #also in safari
1137 '<script', #also in safari
1141 if ( !$wgAllowTitlesInSVG && $extension !== 'svg' && $mime !== 'image/svg' ) {
1145 foreach ( $tags as $tag ) {
1146 if ( false !== strpos( $chunk, $tag ) ) {
1147 wfDebug( __METHOD__
. ": found something that may make it be mistaken for html: $tag\n" );
1148 wfProfileOut( __METHOD__
);
1155 * look for JavaScript
1158 # resolve entity-refs to look at attributes. may be harsh on big files... cache result?
1159 $chunk = Sanitizer
::decodeCharReferences( $chunk );
1161 # look for script-types
1162 if ( preg_match( '!type\s*=\s*[\'"]?\s*(?:\w*/)?(?:ecma|java)!sim', $chunk ) ) {
1163 wfDebug( __METHOD__
. ": found script types\n" );
1164 wfProfileOut( __METHOD__
);
1169 # look for html-style script-urls
1170 if ( preg_match( '!(?:href|src|data)\s*=\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1171 wfDebug( __METHOD__
. ": found html-style script urls\n" );
1172 wfProfileOut( __METHOD__
);
1177 # look for css-style script-urls
1178 if ( preg_match( '!url\s*\(\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1179 wfDebug( __METHOD__
. ": found css-style script urls\n" );
1180 wfProfileOut( __METHOD__
);
1185 wfDebug( __METHOD__
. ": no scripts found\n" );
1186 wfProfileOut( __METHOD__
);
1192 * Check a whitelist of xml encodings that are known not to be interpreted differently
1193 * by the server's xml parser (expat) and some common browsers.
1195 * @param string $file Pathname to the temporary upload file
1196 * @return bool True if the file contains an encoding that could be misinterpreted
1198 public static function checkXMLEncodingMissmatch( $file ) {
1199 global $wgSVGMetadataCutoff;
1200 $contents = file_get_contents( $file, false, null, -1, $wgSVGMetadataCutoff );
1201 $encodingRegex = '!encoding[ \t\n\r]*=[ \t\n\r]*[\'"](.*?)[\'"]!si';
1203 if ( preg_match( "!<\?xml\b(.*?)\?>!si", $contents, $matches ) ) {
1204 if ( preg_match( $encodingRegex, $matches[1], $encMatch )
1205 && !in_array( strtoupper( $encMatch[1] ), self
::$safeXmlEncodings )
1207 wfDebug( __METHOD__
. ": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1211 } elseif ( preg_match( "!<\?xml\b!si", $contents ) ) {
1212 // Start of XML declaration without an end in the first $wgSVGMetadataCutoff
1213 // bytes. There shouldn't be a legitimate reason for this to happen.
1214 wfDebug( __METHOD__
. ": Unmatched XML declaration start\n" );
1217 } elseif ( substr( $contents, 0, 4 ) == "\x4C\x6F\xA7\x94" ) {
1218 // EBCDIC encoded XML
1219 wfDebug( __METHOD__
. ": EBCDIC Encoded XML\n" );
1224 // It's possible the file is encoded with multi-byte encoding, so re-encode attempt to
1225 // detect the encoding in case is specifies an encoding not whitelisted in self::$safeXmlEncodings
1226 $attemptEncodings = array( 'UTF-16', 'UTF-16BE', 'UTF-32', 'UTF-32BE' );
1227 foreach ( $attemptEncodings as $encoding ) {
1228 wfSuppressWarnings();
1229 $str = iconv( $encoding, 'UTF-8', $contents );
1230 wfRestoreWarnings();
1231 if ( $str != '' && preg_match( "!<\?xml\b(.*?)\?>!si", $str, $matches ) ) {
1232 if ( preg_match( $encodingRegex, $matches[1], $encMatch )
1233 && !in_array( strtoupper( $encMatch[1] ), self
::$safeXmlEncodings )
1235 wfDebug( __METHOD__
. ": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1239 } elseif ( $str != '' && preg_match( "!<\?xml\b!si", $str ) ) {
1240 // Start of XML declaration without an end in the first $wgSVGMetadataCutoff
1241 // bytes. There shouldn't be a legitimate reason for this to happen.
1242 wfDebug( __METHOD__
. ": Unmatched XML declaration start\n" );
1252 * @param string $filename
1253 * @return mixed False of the file is verified (does not contain scripts), array otherwise.
1255 protected function detectScriptInSvg( $filename ) {
1256 $this->mSVGNSError
= false;
1257 $check = new XmlTypeCheck(
1259 array( $this, 'checkSvgScriptCallback' ),
1261 array( 'processing_instruction_handler' => 'UploadBase::checkSvgPICallback' )
1263 if ( $check->wellFormed
!== true ) {
1264 // Invalid xml (bug 58553)
1265 return array( 'uploadinvalidxml' );
1266 } elseif ( $check->filterMatch
) {
1267 if ( $this->mSVGNSError
) {
1268 return array( 'uploadscriptednamespace', $this->mSVGNSError
);
1271 return array( 'uploadscripted' );
1278 * Callback to filter SVG Processing Instructions.
1279 * @param string $target processing instruction name
1280 * @param string $data processing instruction attribute and value
1281 * @return bool (true if the filter identified something bad)
1283 public static function checkSvgPICallback( $target, $data ) {
1284 // Don't allow external stylesheets (bug 57550)
1285 if ( preg_match( '/xml-stylesheet/i', $target ) ) {
1293 * @todo Replace this with a whitelist filter!
1294 * @param string $element
1295 * @param array $attribs
1298 public function checkSvgScriptCallback( $element, $attribs ) {
1299 list( $namespace, $strippedElement ) = $this->splitXmlNamespace( $element );
1301 // We specifically don't include:
1302 // http://www.w3.org/1999/xhtml (bug 60771)
1303 static $validNamespaces = array(
1306 'http://creativecommons.org/ns#',
1307 'http://inkscape.sourceforge.net/dtd/sodipodi-0.dtd',
1308 'http://ns.adobe.com/adobeillustrator/10.0/',
1309 'http://ns.adobe.com/adobesvgviewerextensions/3.0/',
1310 'http://ns.adobe.com/extensibility/1.0/',
1311 'http://ns.adobe.com/flows/1.0/',
1312 'http://ns.adobe.com/illustrator/1.0/',
1313 'http://ns.adobe.com/imagereplacement/1.0/',
1314 'http://ns.adobe.com/pdf/1.3/',
1315 'http://ns.adobe.com/photoshop/1.0/',
1316 'http://ns.adobe.com/saveforweb/1.0/',
1317 'http://ns.adobe.com/variables/1.0/',
1318 'http://ns.adobe.com/xap/1.0/',
1319 'http://ns.adobe.com/xap/1.0/g/',
1320 'http://ns.adobe.com/xap/1.0/g/img/',
1321 'http://ns.adobe.com/xap/1.0/mm/',
1322 'http://ns.adobe.com/xap/1.0/rights/',
1323 'http://ns.adobe.com/xap/1.0/stype/dimensions#',
1324 'http://ns.adobe.com/xap/1.0/stype/font#',
1325 'http://ns.adobe.com/xap/1.0/stype/manifestitem#',
1326 'http://ns.adobe.com/xap/1.0/stype/resourceevent#',
1327 'http://ns.adobe.com/xap/1.0/stype/resourceref#',
1328 'http://ns.adobe.com/xap/1.0/t/pg/',
1329 'http://purl.org/dc/elements/1.1/',
1330 'http://purl.org/dc/elements/1.1',
1331 'http://schemas.microsoft.com/visio/2003/svgextensions/',
1332 'http://sodipodi.sourceforge.net/dtd/sodipodi-0.dtd',
1333 'http://taptrix.com/inkpad/svg_extensions',
1334 'http://web.resource.org/cc/',
1335 'http://www.freesoftware.fsf.org/bkchem/cdml',
1336 'http://www.inkscape.org/namespaces/inkscape',
1337 'http://www.opengis.net/gml',
1338 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
1339 'http://www.w3.org/2000/svg',
1340 'http://www.w3.org/tr/rec-rdf-syntax/',
1343 if ( !in_array( $namespace, $validNamespaces ) ) {
1344 wfDebug( __METHOD__
. ": Non-svg namespace '$namespace' in uploaded file.\n" );
1345 /** @todo Return a status object to a closure in XmlTypeCheck, for MW1.21+ */
1346 $this->mSVGNSError
= $namespace;
1352 * check for elements that can contain javascript
1354 if ( $strippedElement == 'script' ) {
1355 wfDebug( __METHOD__
. ": Found script element '$element' in uploaded file.\n" );
1360 # e.g., <svg xmlns="http://www.w3.org/2000/svg">
1361 # <handler xmlns:ev="http://www.w3.org/2001/xml-events" ev:event="load">alert(1)</handler> </svg>
1362 if ( $strippedElement == 'handler' ) {
1363 wfDebug( __METHOD__
. ": Found scriptable element '$element' in uploaded file.\n" );
1368 # SVG reported in Feb '12 that used xml:stylesheet to generate javascript block
1369 if ( $strippedElement == 'stylesheet' ) {
1370 wfDebug( __METHOD__
. ": Found scriptable element '$element' in uploaded file.\n" );
1375 # Block iframes, in case they pass the namespace check
1376 if ( $strippedElement == 'iframe' ) {
1377 wfDebug( __METHOD__
. ": iframe in uploaded file.\n" );
1382 foreach ( $attribs as $attrib => $value ) {
1383 $stripped = $this->stripXmlNamespace( $attrib );
1384 $value = strtolower( $value );
1386 if ( substr( $stripped, 0, 2 ) == 'on' ) {
1388 . ": Found event-handler attribute '$attrib'='$value' in uploaded file.\n" );
1393 # href with javascript target
1394 if ( $stripped == 'href' && strpos( strtolower( $value ), 'javascript:' ) !== false ) {
1396 . ": Found script in href attribute '$attrib'='$value' in uploaded file.\n" );
1401 # href with embedded svg as target
1402 if ( $stripped == 'href' && preg_match( '!data:[^,]*image/svg[^,]*,!sim', $value ) ) {
1403 wfDebug( __METHOD__
. ": Found href to embedded svg "
1404 . "\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1409 # href with embedded (text/xml) svg as target
1410 if ( $stripped == 'href' && preg_match( '!data:[^,]*text/xml[^,]*,!sim', $value ) ) {
1411 wfDebug( __METHOD__
. ": Found href to embedded svg "
1412 . "\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1417 # use set/animate to add event-handler attribute to parent
1418 if ( ( $strippedElement == 'set' ||
$strippedElement == 'animate' )
1419 && $stripped == 'attributename'
1420 && substr( $value, 0, 2 ) == 'on'
1422 wfDebug( __METHOD__
. ": Found svg setting event-handler attribute with "
1423 . "\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1428 # use set to add href attribute to parent element
1429 if ( $strippedElement == 'set'
1430 && $stripped == 'attributename'
1431 && strpos( $value, 'href' ) !== false
1433 wfDebug( __METHOD__
. ": Found svg setting href attribute '$value' in uploaded file.\n" );
1438 # use set to add a remote / data / script target to an element
1439 if ( $strippedElement == 'set'
1440 && $stripped == 'to'
1441 && preg_match( '!(http|https|data|script):!sim', $value )
1443 wfDebug( __METHOD__
. ": Found svg setting attribute to '$value' in uploaded file.\n" );
1448 # use handler attribute with remote / data / script
1449 if ( $stripped == 'handler' && preg_match( '!(http|https|data|script):!sim', $value ) ) {
1450 wfDebug( __METHOD__
. ": Found svg setting handler with remote/data/script "
1451 . "'$attrib'='$value' in uploaded file.\n" );
1456 # use CSS styles to bring in remote code
1457 # catch url("http:..., url('http:..., url(http:..., but not url("#..., url('#..., url(#....
1458 $tagsList = "font|clip-path|fill|filter|marker|marker-end|marker-mid|marker-start|mask|stroke";
1459 if ( $stripped == 'style'
1461 '!((?:' . $tagsList . ')\s*:\s*url\s*\(\s*["\']?\s*[^#]+.*?\))!sim',
1466 foreach ( $matches[1] as $match ) {
1467 if ( !preg_match( '!(?:' . $tagsList . ')\s*:\s*url\s*\(\s*(#|\'#|"#)!sim', $match ) ) {
1468 wfDebug( __METHOD__
. ": Found svg setting a style with "
1469 . "remote url '$attrib'='$value' in uploaded file.\n" );
1476 # image filters can pull in url, which could be svg that executes scripts
1477 if ( $strippedElement == 'image'
1478 && $stripped == 'filter'
1479 && preg_match( '!url\s*\(!sim', $value )
1481 wfDebug( __METHOD__
. ": Found image filter with url: "
1482 . "\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1488 return false; //No scripts detected
1492 * Divide the element name passed by the xml parser to the callback into URI and prifix.
1493 * @param string $name
1494 * @return array Containing the namespace URI and prefix
1496 private static function splitXmlNamespace( $element ) {
1497 // 'http://www.w3.org/2000/svg:script' -> array( 'http://www.w3.org/2000/svg', 'script' )
1498 $parts = explode( ':', strtolower( $element ) );
1499 $name = array_pop( $parts );
1500 $ns = implode( ':', $parts );
1502 return array( $ns, $name );
1506 * @param string $name
1509 private function stripXmlNamespace( $name ) {
1510 // 'http://www.w3.org/2000/svg:script' -> 'script'
1511 $parts = explode( ':', strtolower( $name ) );
1513 return array_pop( $parts );
1517 * Generic wrapper function for a virus scanner program.
1518 * This relies on the $wgAntivirus and $wgAntivirusSetup variables.
1519 * $wgAntivirusRequired may be used to deny upload if the scan fails.
1521 * @param string $file Pathname to the temporary upload file
1522 * @return mixed False if not virus is found, null if the scan fails or is disabled,
1523 * or a string containing feedback from the virus scanner if a virus was found.
1524 * If textual feedback is missing but a virus was found, this function returns true.
1526 public static function detectVirus( $file ) {
1527 global $wgAntivirus, $wgAntivirusSetup, $wgAntivirusRequired, $wgOut;
1528 wfProfileIn( __METHOD__
);
1530 if ( !$wgAntivirus ) {
1531 wfDebug( __METHOD__
. ": virus scanner disabled\n" );
1532 wfProfileOut( __METHOD__
);
1537 if ( !$wgAntivirusSetup[$wgAntivirus] ) {
1538 wfDebug( __METHOD__
. ": unknown virus scanner: $wgAntivirus\n" );
1539 $wgOut->wrapWikiMsg( "<div class=\"error\">\n$1\n</div>",
1540 array( 'virus-badscanner', $wgAntivirus ) );
1541 wfProfileOut( __METHOD__
);
1543 return wfMessage( 'virus-unknownscanner' )->text() . " $wgAntivirus";
1546 # look up scanner configuration
1547 $command = $wgAntivirusSetup[$wgAntivirus]['command'];
1548 $exitCodeMap = $wgAntivirusSetup[$wgAntivirus]['codemap'];
1549 $msgPattern = isset( $wgAntivirusSetup[$wgAntivirus]['messagepattern'] ) ?
1550 $wgAntivirusSetup[$wgAntivirus]['messagepattern'] : null;
1552 if ( strpos( $command, "%f" ) === false ) {
1553 # simple pattern: append file to scan
1554 $command .= " " . wfEscapeShellArg( $file );
1556 # complex pattern: replace "%f" with file to scan
1557 $command = str_replace( "%f", wfEscapeShellArg( $file ), $command );
1560 wfDebug( __METHOD__
. ": running virus scan: $command \n" );
1562 # execute virus scanner
1565 # NOTE: there's a 50 line workaround to make stderr redirection work on windows, too.
1566 # that does not seem to be worth the pain.
1567 # Ask me (Duesentrieb) about it if it's ever needed.
1568 $output = wfShellExecWithStderr( $command, $exitCode );
1570 # map exit code to AV_xxx constants.
1571 $mappedCode = $exitCode;
1572 if ( $exitCodeMap ) {
1573 if ( isset( $exitCodeMap[$exitCode] ) ) {
1574 $mappedCode = $exitCodeMap[$exitCode];
1575 } elseif ( isset( $exitCodeMap["*"] ) ) {
1576 $mappedCode = $exitCodeMap["*"];
1580 /* NB: AV_NO_VIRUS is 0 but AV_SCAN_FAILED is false,
1581 * so we need the strict equalities === and thus can't use a switch here
1583 if ( $mappedCode === AV_SCAN_FAILED
) {
1584 # scan failed (code was mapped to false by $exitCodeMap)
1585 wfDebug( __METHOD__
. ": failed to scan $file (code $exitCode).\n" );
1587 $output = $wgAntivirusRequired
1588 ?
wfMessage( 'virus-scanfailed', array( $exitCode ) )->text()
1590 } elseif ( $mappedCode === AV_SCAN_ABORTED
) {
1591 # scan failed because filetype is unknown (probably imune)
1592 wfDebug( __METHOD__
. ": unsupported file type $file (code $exitCode).\n" );
1594 } elseif ( $mappedCode === AV_NO_VIRUS
) {
1596 wfDebug( __METHOD__
. ": file passed virus scan.\n" );
1599 $output = trim( $output );
1602 $output = true; #if there's no output, return true
1603 } elseif ( $msgPattern ) {
1605 if ( preg_match( $msgPattern, $output, $groups ) ) {
1607 $output = $groups[1];
1612 wfDebug( __METHOD__
. ": FOUND VIRUS! scanner feedback: $output \n" );
1615 wfProfileOut( __METHOD__
);
1621 * Check if there's an overwrite conflict and, if so, if restrictions
1622 * forbid this user from performing the upload.
1626 * @return mixed True on success, array on failure
1628 private function checkOverwrite( $user ) {
1629 // First check whether the local file can be overwritten
1630 $file = $this->getLocalFile();
1631 if ( $file->exists() ) {
1632 if ( !self
::userCanReUpload( $user, $file ) ) {
1633 return array( 'fileexists-forbidden', $file->getName() );
1639 /* Check shared conflicts: if the local file does not exist, but
1640 * wfFindFile finds a file, it exists in a shared repository.
1642 $file = wfFindFile( $this->getTitle() );
1643 if ( $file && !$user->isAllowed( 'reupload-shared' ) ) {
1644 return array( 'fileexists-shared-forbidden', $file->getName() );
1651 * Check if a user is the last uploader
1654 * @param string $img Image name
1657 public static function userCanReUpload( User
$user, $img ) {
1658 if ( $user->isAllowed( 'reupload' ) ) {
1659 return true; // non-conditional
1661 if ( !$user->isAllowed( 'reupload-own' ) ) {
1664 if ( is_string( $img ) ) {
1665 $img = wfLocalFile( $img );
1667 if ( !( $img instanceof LocalFile
) ) {
1671 return $user->getId() == $img->getUser( 'id' );
1675 * Helper function that does various existence checks for a file.
1676 * The following checks are performed:
1678 * - Article with the same name as the file exists
1679 * - File exists with normalized extension
1680 * - The file looks like a thumbnail and the original exists
1682 * @param File $file The File object to check
1683 * @return mixed False if the file does not exists, else an array
1685 public static function getExistsWarning( $file ) {
1686 if ( $file->exists() ) {
1687 return array( 'warning' => 'exists', 'file' => $file );
1690 if ( $file->getTitle()->getArticleID() ) {
1691 return array( 'warning' => 'page-exists', 'file' => $file );
1694 if ( $file->wasDeleted() && !$file->exists() ) {
1695 return array( 'warning' => 'was-deleted', 'file' => $file );
1698 if ( strpos( $file->getName(), '.' ) == false ) {
1699 $partname = $file->getName();
1702 $n = strrpos( $file->getName(), '.' );
1703 $extension = substr( $file->getName(), $n +
1 );
1704 $partname = substr( $file->getName(), 0, $n );
1706 $normalizedExtension = File
::normalizeExtension( $extension );
1708 if ( $normalizedExtension != $extension ) {
1709 // We're not using the normalized form of the extension.
1710 // Normal form is lowercase, using most common of alternate
1711 // extensions (eg 'jpg' rather than 'JPEG').
1713 // Check for another file using the normalized form...
1714 $nt_lc = Title
::makeTitle( NS_FILE
, "{$partname}.{$normalizedExtension}" );
1715 $file_lc = wfLocalFile( $nt_lc );
1717 if ( $file_lc->exists() ) {
1719 'warning' => 'exists-normalized',
1721 'normalizedFile' => $file_lc
1726 // Check for files with the same name but a different extension
1727 $similarFiles = RepoGroup
::singleton()->getLocalRepo()->findFilesByPrefix(
1728 "{$partname}.", 1 );
1729 if ( count( $similarFiles ) ) {
1731 'warning' => 'exists-normalized',
1733 'normalizedFile' => $similarFiles[0],
1737 if ( self
::isThumbName( $file->getName() ) ) {
1738 # Check for filenames like 50px- or 180px-, these are mostly thumbnails
1739 $nt_thb = Title
::newFromText(
1740 substr( $partname, strpos( $partname, '-' ) +
1 ) . '.' . $extension,
1743 $file_thb = wfLocalFile( $nt_thb );
1744 if ( $file_thb->exists() ) {
1746 'warning' => 'thumb',
1748 'thumbFile' => $file_thb
1751 // File does not exist, but we just don't like the name
1753 'warning' => 'thumb-name',
1755 'thumbFile' => $file_thb
1760 foreach ( self
::getFilenamePrefixBlacklist() as $prefix ) {
1761 if ( substr( $partname, 0, strlen( $prefix ) ) == $prefix ) {
1763 'warning' => 'bad-prefix',
1774 * Helper function that checks whether the filename looks like a thumbnail
1775 * @param string $filename
1778 public static function isThumbName( $filename ) {
1779 $n = strrpos( $filename, '.' );
1780 $partname = $n ?
substr( $filename, 0, $n ) : $filename;
1783 substr( $partname, 3, 3 ) == 'px-' ||
1784 substr( $partname, 2, 3 ) == 'px-'
1786 preg_match( "/[0-9]{2}/", substr( $partname, 0, 2 ) );
1790 * Get a list of blacklisted filename prefixes from [[MediaWiki:Filename-prefix-blacklist]]
1792 * @return array List of prefixes
1794 public static function getFilenamePrefixBlacklist() {
1795 $blacklist = array();
1796 $message = wfMessage( 'filename-prefix-blacklist' )->inContentLanguage();
1797 if ( !$message->isDisabled() ) {
1798 $lines = explode( "\n", $message->plain() );
1799 foreach ( $lines as $line ) {
1800 // Remove comment lines
1801 $comment = substr( trim( $line ), 0, 1 );
1802 if ( $comment == '#' ||
$comment == '' ) {
1805 // Remove additional comments after a prefix
1806 $comment = strpos( $line, '#' );
1807 if ( $comment > 0 ) {
1808 $line = substr( $line, 0, $comment - 1 );
1810 $blacklist[] = trim( $line );
1818 * Gets image info about the file just uploaded.
1820 * Also has the effect of setting metadata to be an 'indexed tag name' in
1821 * returned API result if 'metadata' was requested. Oddly, we have to pass
1822 * the "result" object down just so it can do that with the appropriate
1823 * format, presumably.
1825 * @param ApiResult $result
1826 * @return array Image info
1828 public function getImageInfo( $result ) {
1829 $file = $this->getLocalFile();
1830 /** @todo This cries out for refactoring.
1831 * We really want to say $file->getAllInfo(); here.
1832 * Perhaps "info" methods should be moved into files, and the API should
1833 * just wrap them in queries.
1835 if ( $file instanceof UploadStashFile
) {
1836 $imParam = ApiQueryStashImageInfo
::getPropertyNames();
1837 $info = ApiQueryStashImageInfo
::getInfo( $file, array_flip( $imParam ), $result );
1839 $imParam = ApiQueryImageInfo
::getPropertyNames();
1840 $info = ApiQueryImageInfo
::getInfo( $file, array_flip( $imParam ), $result );
1847 * @param array $error
1850 public function convertVerifyErrorToStatus( $error ) {
1851 $code = $error['status'];
1852 unset( $code['status'] );
1854 return Status
::newFatal( $this->getVerificationErrorCode( $code ), $error );
1858 * @param null|string $forType
1861 public static function getMaxUploadSize( $forType = null ) {
1862 global $wgMaxUploadSize;
1864 if ( is_array( $wgMaxUploadSize ) ) {
1865 if ( !is_null( $forType ) && isset( $wgMaxUploadSize[$forType] ) ) {
1866 return $wgMaxUploadSize[$forType];
1868 return $wgMaxUploadSize['*'];
1871 return intval( $wgMaxUploadSize );
1876 * Get the current status of a chunked upload (used for polling).
1877 * The status will be read from the *current* user session.
1878 * @param string $statusKey
1879 * @return array|bool
1881 public static function getSessionStatus( $statusKey ) {
1882 return isset( $_SESSION[self
::SESSION_STATUS_KEY
][$statusKey] )
1883 ?
$_SESSION[self
::SESSION_STATUS_KEY
][$statusKey]
1888 * Set the current status of a chunked upload (used for polling).
1889 * The status will be stored in the *current* user session.
1890 * @param string $statusKey
1891 * @param array|bool $value
1894 public static function setSessionStatus( $statusKey, $value ) {
1895 if ( $value === false ) {
1896 unset( $_SESSION[self
::SESSION_STATUS_KEY
][$statusKey] );
1898 $_SESSION[self
::SESSION_STATUS_KEY
][$statusKey] = $value;