X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fupload%2FUploadBase.php;h=9549504db8a0ffde2bcd1287d55aedc8d95bcdc8;hb=fa6402516114f900194ab0203ff8878f9094bcab;hp=52bb2487dd65fa80bb59351ec64afa5081a00be9;hpb=c2033042ee59ac9cbcc62fda1cd8aa0123ed65ae;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/upload/UploadBase.php b/includes/upload/UploadBase.php index 52bb2487dd..9549504db8 100644 --- a/includes/upload/UploadBase.php +++ b/includes/upload/UploadBase.php @@ -1,42 +1,64 @@ 'empty-file', + self::FILE_TOO_LARGE => 'file-too-large', + self::FILETYPE_MISSING => 'filetype-missing', + self::FILETYPE_BADTYPE => 'filetype-banned', + self::MIN_LENGTH_PARTNAME => 'filename-tooshort', + self::ILLEGAL_FILENAME => 'illegal-filename', + self::OVERWRITE_EXISTING_FILE => 'overwrite', + self::VERIFICATION_ERROR => 'verification-error', + self::HOOK_ABORTED => 'hookaborted', + ); + if( isset( $code_to_status[$error] ) ) { + return $code_to_status[$error]; + } + + return 'unknown-error'; + } /** * Returns true if uploads are enabled. @@ -44,8 +66,9 @@ abstract class UploadBase { */ public static function isEnabled() { global $wgEnableUploads; - if ( !$wgEnableUploads ) + if ( !$wgEnableUploads ) { return false; + } # Check php's file_uploads setting if( !wfIniGetBool( 'file_uploads' ) ) { @@ -60,37 +83,50 @@ abstract class UploadBase { * Can be overriden by subclasses. */ public static function isAllowed( $user ) { - if( !$user->isAllowed( 'upload' ) ) - return 'upload'; + foreach ( array( 'upload', 'edit' ) as $permission ) { + if ( !$user->isAllowed( $permission ) ) { + return $permission; + } + } return true; } - // Upload handlers. Should probably just be a global + // Upload handlers. Should probably just be a global. static $uploadHandlers = array( 'Stash', 'File', 'Url' ); /** * Create a form of UploadBase depending on wpSourceType and initializes it */ public static function createFromRequest( &$request, $type = null ) { - $type = $type ? $type : $request->getVal( 'wpSourceType' ); + $type = $type ? $type : $request->getVal( 'wpSourceType', 'File' ); - if( !$type ) + if( !$type ) { return null; + } // Get the upload class $type = ucfirst( $type ); - $className = 'UploadFrom' . $type; - wfDebug( __METHOD__ . ": class name: $className\n" ); - if( !in_array( $type, self::$uploadHandlers ) ) - return null; + + // Give hooks the chance to handle this request + $className = null; + wfRunHooks( 'UploadCreateFromRequest', array( $type, &$className ) ); + if ( is_null( $className ) ) { + $className = 'UploadFrom' . $type; + wfDebug( __METHOD__ . ": class name: $className\n" ); + if( !in_array( $type, self::$uploadHandlers ) ) { + return null; + } + } // Check whether this upload class is enabled - if( !call_user_func( array( $className, 'isEnabled' ) ) ) + if( !call_user_func( array( $className, 'isEnabled' ) ) ) { return null; + } // Check whether the request is valid - if( !call_user_func( array( $className, 'isValidRequest' ), $request ) ) + if( !call_user_func( array( $className, 'isValidRequest' ), $request ) ) { return null; + } $handler = new $className; @@ -106,17 +142,30 @@ abstract class UploadBase { } public function __construct() {} + + /** + * Returns the upload type. Should be overridden by child classes + * + * @since 1.18 + * @return string + */ + public function getSourceType() { return null; } /** - * Do the real variable initialization + * Initialize the path information + * @param $name string the desired destination name + * @param $tempPath string the temporary path + * @param $fileSize int the file size + * @param $removeTempFile bool (false) remove the temporary file? + * @return null */ - public function initialize( $name, $tempPath, $fileSize, $removeTempFile = false ) { + public function initializePathInfo( $name, $tempPath, $fileSize, $removeTempFile = false ) { $this->mDesiredDestName = $name; $this->mTempPath = $tempPath; $this->mFileSize = $fileSize; $this->mRemoveTempFile = $removeTempFile; } - + /** * Initialize from a WebRequest. Override this in a subclass. */ @@ -130,93 +179,153 @@ abstract class UploadBase { } /** - * Return the file size + * Return true if the file is empty + * @return bool */ - public function isEmptyFile(){ + public function isEmptyFile() { return empty( $this->mFileSize ); } + /** + * Return the file size + * @return integer + */ + public function getFileSize() { + return $this->mFileSize; + } + + /** + * Append a file to the Repo file + * + * @param $srcPath String: path to source file + * @param $toAppendPath String: path to the Repo file that will be appended to. + * @return Status Status + */ + protected function appendToUploadFile( $srcPath, $toAppendPath ) { + $repo = RepoGroup::singleton()->getLocalRepo(); + $status = $repo->append( $srcPath, $toAppendPath ); + return $status; + } + + /** + * @param $srcPath String: the source path + * @return the real path if it was a virtual URL + */ + function getRealPath( $srcPath ) { + $repo = RepoGroup::singleton()->getLocalRepo(); + if ( $repo->isVirtualUrl( $srcPath ) ) { + return $repo->resolveVirtualUrl( $srcPath ); + } + return $srcPath; + } + /** * Verify whether the upload is sane. - * Returns self::OK or else an array with error information + * @return mixed self::OK or else an array with error information */ public function verifyUpload() { /** * If there was no filename or a zero size given, give up quick. */ - if( $this->isEmptyFile() ) + if( $this->isEmptyFile() ) { return array( 'status' => self::EMPTY_FILE ); - - $nt = $this->getTitle(); - if( is_null( $nt ) ) { - $result = array( 'status' => $this->mTitleError ); - if( $this->mTitleError == self::ILLEGAL_FILENAME ) - $result['filtered'] = $this->mFilteredName; - if ( $this->mTitleError == self::FILETYPE_BADTYPE ) - $result['finalExt'] = $this->mFinalExtension; - return $result; } - $this->mDestName = $this->getLocalFile()->getName(); /** - * In some cases we may forbid overwriting of existing files. + * Honor $wgMaxUploadSize */ - $overwrite = $this->checkOverwrite(); - if( $overwrite !== true ) - return array( 'status' => self::OVERWRITE_EXISTING_FILE, 'overwrite' => $overwrite ); + $maxSize = self::getMaxUploadSize( $this->getSourceType() ); + if( $this->mFileSize > $maxSize ) { + return array( + 'status' => self::FILE_TOO_LARGE, + 'max' => $maxSize, + ); + } /** * Look at the contents of the file; if we can recognize the * type but it's corrupt or data of the wrong type, we should * probably not accept it. */ - $verification = $this->verifyFile( $this->mTempPath ); - + $verification = $this->verifyFile(); if( $verification !== true ) { - if( !is_array( $verification ) ) - $verification = array( $verification ); - $verification['status'] = self::VERIFICATION_ERROR; - return $verification; + return array( + 'status' => self::VERIFICATION_ERROR, + 'details' => $verification + ); + } + + /** + * Make sure this file can be created + */ + $result = $this->validateName(); + if( $result !== true ) { + return $result; } $error = ''; if( !wfRunHooks( 'UploadVerification', array( $this->mDestName, $this->mTempPath, &$error ) ) ) { - return array( 'status' => self::UPLOAD_VERIFICATION_ERROR, 'error' => $error ); + return array( 'status' => self::HOOK_ABORTED, 'error' => $error ); } - return self::OK; + return array( 'status' => self::OK ); } /** - * Verifies that it's ok to include the uploaded file + * Verify that the name is valid and, if necessary, that we can overwrite * - * FIXME: this function seems to intermixes tmpfile and $this->mTempPath .. no idea why this is - * - * @param string $tmpfile the full path of the temporary file to verify - * @return mixed true of the file is verified, a string or array otherwise. - */ - protected function verifyFile( $tmpfile ) { - $this->mFileProps = File::getPropsFromPath( $this->mTempPath, $this->mFinalExtension ); - $this->checkMacBinary(); + * @return mixed true if valid, otherwise and array with 'status' + * and other keys + **/ + protected function validateName() { + $nt = $this->getTitle(); + if( is_null( $nt ) ) { + $result = array( 'status' => $this->mTitleError ); + if( $this->mTitleError == self::ILLEGAL_FILENAME ) { + $result['filtered'] = $this->mFilteredName; + } + if ( $this->mTitleError == self::FILETYPE_BADTYPE ) { + $result['finalExt'] = $this->mFinalExtension; + if ( count( $this->mBlackListedExtensions ) ) { + $result['blacklistedExt'] = $this->mBlackListedExtensions; + } + } + return $result; + } + $this->mDestName = $this->getLocalFile()->getName(); - #magically determine mime type - $magic = MimeMagic::singleton(); - $mime = $magic->guessMimeType( $tmpfile, false ); + return true; + } - #check mime type, if desired + /** + * Verify the mime type + * + * @param $mime string representing the mime + * @return mixed true if the file is verified, an array otherwise + */ + protected function verifyMimeType( $mime ) { global $wgVerifyMimeType; - if ( $wgVerifyMimeType ) { + if ( $wgVerifyMimeType ) { + wfDebug ( "\n\nmime: <$mime> extension: <{$this->mFinalExtension}>\n\n"); global $wgMimeTypeBlacklist; - if ( $this->checkFileExtension( $mime, $wgMimeTypeBlacklist ) ) + if ( $this->checkFileExtension( $mime, $wgMimeTypeBlacklist ) ) { return array( 'filetype-badmime', $mime ); + } + + # XXX: Missing extension will be caught by validateName() via getTitle() + if ( $this->mFinalExtension != '' && !$this->verifyExtension( $mime, $this->mFinalExtension ) ) { + return array( 'filetype-mime-mismatch', $this->mFinalExtension, $mime ); + } # Check IE type - $fp = fopen( $tmpfile, 'rb' ); + $fp = fopen( $this->mTempPath, 'rb' ); $chunk = fread( $fp, 256 ); fclose( $fp ); + + $magic = MimeMagic::singleton(); $extMime = $magic->guessTypesForExtension( $this->mFinalExtension ); - $ieTypes = $magic->getIEMimeTypes( $tmpfile, $chunk, $extMime ); + $ieTypes = $magic->getIEMimeTypes( $this->mTempPath, $chunk, $extMime ); foreach ( $ieTypes as $ieType ) { if ( $this->checkFileExtension( $ieType, $wgMimeTypeBlacklist ) ) { return array( 'filetype-bad-ie-mime', $ieType ); @@ -224,31 +333,73 @@ abstract class UploadBase { } } - #check for htmlish code and javascript - if( self::detectScript( $tmpfile, $mime, $this->mFinalExtension ) ) { - return 'uploadscripted'; + return true; + } + + /** + * Verifies that it's ok to include the uploaded file + * + * @return mixed true of the file is verified, array otherwise. + */ + protected function verifyFile() { + # get the title, even though we are doing nothing with it, because + # we need to populate mFinalExtension + $this->getTitle(); + + $this->mFileProps = File::getPropsFromPath( $this->mTempPath, $this->mFinalExtension ); + $this->checkMacBinary(); + + # check mime type, if desired + $mime = $this->mFileProps[ 'file-mime' ]; + $status = $this->verifyMimeType( $mime ); + if ( $status !== true ) { + return $status; + } + + # check for htmlish code and javascript + if( self::detectScript( $this->mTempPath, $mime, $this->mFinalExtension ) ) { + return array( 'uploadscripted' ); } if( $this->mFinalExtension == 'svg' || $mime == 'image/svg+xml' ) { - if( self::detectScriptInSvg( $tmpfile ) ) { - return 'uploadscripted'; + if( $this->detectScriptInSvg( $this->mTempPath ) ) { + return array( 'uploadscripted' ); } } /** * Scan the uploaded file for viruses */ - $virus = $this->detectVirus( $tmpfile ); + $virus = $this->detectVirus( $this->mTempPath ); if ( $virus ) { return array( 'uploadvirus', $virus ); } + + $handler = MediaHandler::getHandler( $mime ); + if ( $handler ) { + $handlerStatus = $handler->verifyUpload( $this->mTempPath ); + if ( !$handlerStatus->isOK() ) { + $errors = $handlerStatus->getErrorsArray(); + return reset( $errors ); + } + } + + wfRunHooks( 'UploadVerifyFile', array( $this, $mime, &$status ) ); + if ( $status !== true ) { + return $status; + } + wfDebug( __METHOD__ . ": all clear; passing.\n" ); return true; } /** - * Check whether the user can edit, upload and create the image. - * - * @param User $user the user to verify the permissions against + * Check whether the user can edit, upload and create the image. This + * checks only against the current title; if it returns errors, it may + * very well be that another title will not give errors. Therefore + * isAllowed() should be called as well for generic is-user-blocked or + * can-user-upload checking. + * + * @param $user the User object to verify the permissions against * @return mixed An array as returned by getUserPermissionsErrors or true * in case the user has proper permissions. */ @@ -258,70 +409,72 @@ abstract class UploadBase { * to modify it by uploading a new revision. */ $nt = $this->getTitle(); - if( is_null( $nt ) ) + if( is_null( $nt ) ) { return true; + } $permErrors = $nt->getUserPermissionsErrors( 'edit', $user ); $permErrorsUpload = $nt->getUserPermissionsErrors( 'upload', $user ); - $permErrorsCreate = ( $nt->exists() ? array() : $nt->getUserPermissionsErrors( 'create', $user ) ); + if ( $nt->exists() ) { + $permErrorsCreate = $nt->getUserPermissionsErrors( 'createpage', $user ); + } else { + $permErrorsCreate = array(); + } if( $permErrors || $permErrorsUpload || $permErrorsCreate ) { $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsUpload, $permErrors ) ); $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsCreate, $permErrors ) ); return $permErrors; } + + $overwriteError = $this->checkOverwrite( $user ); + if ( $overwriteError !== true ) { + return array( array( $overwriteError ) ); + } + return true; } /** * Check for non fatal problems with the file - * - * @return array Array of warnings + * + * @return Array of warnings */ public function checkWarnings() { - $warning = array(); + $warnings = array(); $localFile = $this->getLocalFile(); $filename = $localFile->getName(); - $n = strrpos( $filename, '.' ); - $partname = $n ? substr( $filename, 0, $n ) : $filename; - /* + /** * Check whether the resulting filename is different from the desired one, * but ignore things like ucfirst() and spaces/underscore things */ $comparableName = str_replace( ' ', '_', $this->mDesiredDestName ); - global $wgCapitalLinks, $wgContLang; - if ( $wgCapitalLinks ) { - $comparableName = $wgContLang->ucfirst( $comparableName ); + $comparableName = Title::capitalize( $comparableName, NS_FILE ); + + if( $this->mDesiredDestName != $filename && $comparableName != $filename ) { + $warnings['badfilename'] = $filename; } - if( $this->mDesiredDestName != $filename && $comparableName != $filename ) - $warning['badfilename'] = $filename; // Check whether the file extension is on the unwanted list global $wgCheckFileExtensions, $wgFileExtensions; if ( $wgCheckFileExtensions ) { - if ( !$this->checkFileExtension( $this->mFinalExtension, $wgFileExtensions ) ) - $warning['filetype-unwanted-type'] = $this->mFinalExtension; + if ( !$this->checkFileExtension( $this->mFinalExtension, $wgFileExtensions ) ) { + $warnings['filetype-unwanted-type'] = $this->mFinalExtension; + } } global $wgUploadSizeWarning; - if ( $wgUploadSizeWarning && ( $this->mFileSize > $wgUploadSizeWarning ) ) - $warning['large-file'] = $wgUploadSizeWarning; - - if ( $this->mFileSize == 0 ) - $warning['emptyfile'] = true; + if ( $wgUploadSizeWarning && ( $this->mFileSize > $wgUploadSizeWarning ) ) { + $warnings['large-file'] = $wgUploadSizeWarning; + } + if ( $this->mFileSize == 0 ) { + $warnings['emptyfile'] = true; + } $exists = self::getExistsWarning( $localFile ); - if( $exists !== false ) - $warning['exists'] = $exists; - - // Check whether this may be a thumbnail - if( $exists !== false && $exists[0] != 'thumb' - && self::isThumbName( $filename ) ){ - // Make the title - $nt = $this->getTitle(); - $warning['file-thumbnail-no'] = substr( $filename, 0, - strpos( $nt->getText() , '-' ) +1 ); + if( $exists !== false ) { + $warnings['exists'] = $exists; } // Check dupes against existing files @@ -330,49 +483,47 @@ abstract class UploadBase { $title = $this->getTitle(); // Remove all matches against self foreach ( $dupes as $key => $dupe ) { - if( $title->equals( $dupe->getTitle() ) ) + if( $title->equals( $dupe->getTitle() ) ) { unset( $dupes[$key] ); + } + } + if( $dupes ) { + $warnings['duplicate'] = $dupes; } - if( $dupes ) - $warning['duplicate'] = $dupes; // Check dupes against archives $archivedImage = new ArchivedFile( null, 0, "{$hash}.{$this->mFinalExtension}" ); - if ( $archivedImage->getID() > 0 ) - $warning['duplicate-archive'] = $archivedImage->getName(); - - $filenamePrefixBlacklist = self::getFilenamePrefixBlacklist(); - foreach( $filenamePrefixBlacklist as $prefix ) { - if ( substr( $partname, 0, strlen( $prefix ) ) == $prefix ) { - $warning['filename-bad-prefix'] = $prefix; - break; - } + if ( $archivedImage->getID() > 0 ) { + $warnings['duplicate-archive'] = $archivedImage->getName(); } - # If the file existed before and was deleted, warn the user of this - # Don't bother doing so if the file exists now, however - if( $localFile->wasDeleted() && !$localFile->exists() ) - $warning['filewasdeleted'] = $localFile->getTitle(); - - return $warning; + return $warnings; } /** - * Really perform the upload. Stores the file in the local repo, watches + * Really perform the upload. Stores the file in the local repo, watches * if necessary and runs the UploadComplete hook. - * - * @return mixed Status indicating the whether the upload succeeded. + * + * @return Status indicating the whether the upload succeeded. */ public function performUpload( $comment, $pageText, $watch, $user ) { - wfDebug( "\n\n\performUpload: sum:" . $comment . ' c: ' . $pageText . ' w:' . $watch ); - $status = $this->getLocalFile()->upload( $this->mTempPath, $comment, $pageText, - File::DELETE_SOURCE, $this->mFileProps, false, $user ); + $status = $this->getLocalFile()->upload( + $this->mTempPath, + $comment, + $pageText, + File::DELETE_SOURCE, + $this->mFileProps, + false, + $user + ); - if( $status->isGood() && $watch ) - $user->addWatch( $this->getLocalFile()->getTitle() ); + if( $status->isGood() ) { + if ( $watch ) { + $user->addWatch( $this->getLocalFile()->getTitle() ); + } - if( $status->isGood() ) wfRunHooks( 'UploadComplete', array( &$this ) ); + } return $status; } @@ -380,21 +531,20 @@ abstract class UploadBase { /** * Returns the title of the file to be uploaded. Sets mTitleError in case * the name was illegal. - * + * * @return Title The title of the file or null in case the name was illegal */ public function getTitle() { - if ( $this->mTitle !== false ) + if ( $this->mTitle !== false ) { return $this->mTitle; + } /** * Chop off any directories in the given filename. Then * filter out illegal characters, and try to make a legible name * out of it. We'll strip some silently that Title would die on. */ - $basename = $this->mDesiredDestName; - - $this->mFilteredName = wfStripIllegalFilenameChars( $basename ); + $this->mFilteredName = wfStripIllegalFilenameChars( $this->mDesiredDestName ); /* Normalize to title form before we do any further processing */ $nt = Title::makeTitleSafe( NS_FILE, $this->mFilteredName ); if( is_null( $nt ) ) { @@ -413,17 +563,39 @@ abstract class UploadBase { $this->mFinalExtension = trim( $ext[count( $ext ) - 1] ); } else { $this->mFinalExtension = ''; + + # No extension, try guessing one + $magic = MimeMagic::singleton(); + $mime = $magic->guessMimeType( $this->mTempPath ); + if ( $mime !== 'unknown/unknown' ) { + # Get a space separated list of extensions + $extList = $magic->getExtensionsForType( $mime ); + if ( $extList ) { + # Set the extension to the canonical extension + $this->mFinalExtension = strtok( $extList, ' ' ); + + # Fix up the other variables + $this->mFilteredName .= ".{$this->mFinalExtension}"; + $nt = Title::makeTitleSafe( NS_FILE, $this->mFilteredName ); + $ext = array( $this->mFinalExtension ); + } + } + } /* Don't allow users to override the blacklist (check file extension) */ global $wgCheckFileExtensions, $wgStrictFileExtensions; global $wgFileExtensions, $wgFileBlacklist; + + $blackListedExtensions = $this->checkFileExtensionList( $ext, $wgFileBlacklist ); + if ( $this->mFinalExtension == '' ) { $this->mTitleError = self::FILETYPE_MISSING; return $this->mTitle = null; - } elseif ( $this->checkFileExtensionList( $ext, $wgFileBlacklist ) || + } elseif ( $blackListedExtensions || ( $wgCheckFileExtensions && $wgStrictFileExtensions && !$this->checkFileExtension( $this->mFinalExtension, $wgFileExtensions ) ) ) { + $this->mBlackListedExtensions = $blackListedExtensions; $this->mTitleError = self::FILETYPE_BADTYPE; return $this->mTitle = null; } @@ -431,8 +603,9 @@ abstract class UploadBase { # If there was more than one "extension", reassemble the base # filename to prevent bogus complaints about length if( count( $ext ) > 1 ) { - for( $i = 0; $i < count( $ext ) - 1; $i++ ) + for( $i = 0; $i < count( $ext ) - 1; $i++ ) { $partname .= '.' . $ext[$i]; + } } if( strlen( $partname ) < 1 ) { @@ -440,16 +613,11 @@ abstract class UploadBase { return $this->mTitle = null; } - $nt = Title::makeTitleSafe( NS_FILE, $this->mFilteredName ); - if( is_null( $nt ) ) { - $this->mTitleError = self::ILLEGAL_FILENAME; - return $this->mTitle = null; - } return $this->mTitle = $nt; } /** - * Return the local file and initializes if necessary. + * Return the local file and initializes if necessary. */ public function getLocalFile() { if( is_null( $this->mLocalFile ) ) { @@ -460,85 +628,61 @@ abstract class UploadBase { } /** + * NOTE: Probably should be deprecated in favor of UploadStash, but this is sometimes + * called outside that context. + * * Stash a file in a temporary directory for later processing * after the user has confirmed it. * * If the user doesn't explicitly cancel or accept, these files * can accumulate in the temp directory. * - * @param string $saveName - the destination filename - * @param string $tempName - the source temporary file to save - * @return string - full path the stashed file, or false on failure - * @access private + * @param $saveName String: the destination filename + * @param $tempSrc String: the source temporary file to save + * @return String: full path the stashed file, or false on failure */ - protected function saveTempUploadedFile( $saveName, $tempName ) { + protected function saveTempUploadedFile( $saveName, $tempSrc ) { $repo = RepoGroup::singleton()->getLocalRepo(); - $status = $repo->storeTemp( $saveName, $tempName ); - return $status; - } - - /** - * Append a file to a stashed file. - * - * @param string $srcPath Path to file to append from - * @param string $toAppendPath Path to file to append to - * @return Status Status - */ - public function appendToUploadFile( $srcPath, $toAppendPath ){ - $repo = RepoGroup::singleton()->getLocalRepo(); - $status = $repo->append( $srcPath, $toAppendPath ); + $status = $repo->storeTemp( $saveName, $tempSrc ); return $status; } /** - * Stash a file in a temporary directory for later processing, - * and save the necessary descriptive info into the session. - * Returns a key value which will be passed through a form - * to pick up the path info on a later invocation. + * If the user does not supply all necessary information in the first upload form submission (either by accident or + * by design) then we may want to stash the file temporarily, get more information, and publish the file later. * - * @return int Session key - */ - public function stashSession() { - $status = $this->saveTempUploadedFile( $this->mDestName, $this->mTempPath ); - if( !$status->isOK() ) { - # Couldn't save the file. - return false; - } - if(!isset($_SESSION)) - session_start(); // start up the session (might have been previously closed to prevent php session locking) - $key = $this->getSessionKey(); - $_SESSION['wsUploadData'][$key] = array( - 'mTempPath' => $status->value, - 'mFileSize' => $this->mFileSize, - 'mFileProps' => $this->mFileProps, - 'version' => self::SESSION_VERSION, - ); - return $key; - } - - /** - * Generate a random session key from stash in cases where we want to start an upload without much information + * This method will stash a file in a temporary directory for later processing, and save the necessary descriptive info + * into the user's session. + * This method returns the file object, which also has a 'sessionKey' property which can be passed through a form or + * API request to find this stashed file again. + * + * @param $key String: (optional) the session key used to find the file info again. If not supplied, a key will be autogenerated. + * @return File stashed file */ - protected function getSessionKey(){ - $key = mt_rand( 0, 0x7fffffff ); - $_SESSION['wsUploadData'][$key] = array(); - return $key; + public function stashSessionFile( $key = null ) { + $stash = RepoGroup::singleton()->getLocalRepo()->getUploadStash(); + $data = array( + 'mFileProps' => $this->mFileProps, + 'mSourceType' => $this->getSourceType(), + ); + $file = $stash->stashFile( $this->mTempPath, $data, $key ); + $this->mLocalFile = $file; + return $file; } /** - * Remove a temporarily kept file stashed by saveTempUploadedFile(). - * @return success + * Stash a file in a temporary directory, returning a key which can be used to find the file again. See stashSessionFile(). + * + * @param $key String: (optional) the session key used to find the file info again. If not supplied, a key will be autogenerated. + * @return String: session key */ - public function unsaveUploadedFile() { - $repo = RepoGroup::singleton()->getLocalRepo(); - $success = $repo->freeTemp( $this->mTempPath ); - return $success; + public function stashSession( $key = null ) { + return $this->stashSessionFile( $key )->getSessionKey(); } /** * If we've modified the upload file we need to manually remove it * on exit to clean up. - * @access private */ public function cleanupTempFile() { if ( $this->mRemoveTempFile && $this->mTempPath && file_exists( $this->mTempPath ) ) { @@ -569,9 +713,9 @@ abstract class UploadBase { * Perform case-insensitive match against a list of file extensions. * Returns true if the extension is in the list. * - * @param string $ext - * @param array $list - * @return bool + * @param $ext String + * @param $list Array + * @return Boolean */ public static function checkFileExtension( $ext, $list ) { return in_array( strtolower( $ext ), $list ); @@ -579,27 +723,22 @@ abstract class UploadBase { /** * Perform case-insensitive match against a list of file extensions. - * Returns true if any of the extensions are in the list. + * Returns an array of matching extensions. * - * @param array $ext - * @param array $list - * @return bool + * @param $ext Array + * @param $list Array + * @return Boolean */ public static function checkFileExtensionList( $ext, $list ) { - foreach( $ext as $e ) { - if( in_array( strtolower( $e ), $list ) ) { - return true; - } - } - return false; + return array_intersect( array_map( 'strtolower', $ext ), $list ); } /** * Checks if the mime type of the uploaded file matches the file extension. * - * @param string $mime the mime type of the uploaded file - * @param string $extension The filename extension that the file is to be served with - * @return bool + * @param $mime String: the mime type of the uploaded file + * @param $extension String: the filename extension that the file is to be served with + * @return Boolean */ public static function verifyExtension( $mime, $extension ) { $magic = MimeMagic::singleton(); @@ -617,7 +756,7 @@ abstract class UploadBase { $match = $magic->isMatchingExtension( $extension, $mime ); - if ( $match === NULL ) { + if ( $match === null ) { wfDebug( __METHOD__ . ": no file extension known for mime type $mime, passing file\n" ); return true; } elseif( $match === true ) { @@ -635,22 +774,23 @@ abstract class UploadBase { /** * Heuristic for detecting files that *could* contain JavaScript instructions or * things that may look like HTML to a browser and are thus - * potentially harmful. The present implementation will produce false positives in some situations. + * potentially harmful. The present implementation will produce false + * positives in some situations. * - * @param string $file Pathname to the temporary upload file - * @param string $mime The mime type of the file - * @param string $extension The extension of the file - * @return bool true if the file contains something looking like embedded scripts + * @param $file String: pathname to the temporary upload file + * @param $mime String: the mime type of the file + * @param $extension String: the extension of the file + * @return Boolean: true if the file contains something looking like embedded scripts */ public static function detectScript( $file, $mime, $extension ) { global $wgAllowTitlesInSVG; - #ugly hack: for text files, always look at the entire file. - #For binary field, just check the first K. + # ugly hack: for text files, always look at the entire file. + # For binary field, just check the first K. - if( strpos( $mime,'text/' ) === 0 ) + if( strpos( $mime,'text/' ) === 0 ) { $chunk = file_get_contents( $file ); - else { + } else { $fp = fopen( $file, 'rb' ); $chunk = fread( $fp, 1024 ); fclose( $fp ); @@ -658,46 +798,50 @@ abstract class UploadBase { $chunk = strtolower( $chunk ); - if( !$chunk ) + if( !$chunk ) { return false; + } - #decode from UTF-16 if needed (could be used for obfuscation). - if( substr( $chunk, 0, 2 ) == "\xfe\xff" ) - $enc = "UTF-16BE"; - elseif( substr( $chunk, 0, 2 ) == "\xff\xfe" ) - $enc = "UTF-16LE"; - else - $enc = NULL; + # decode from UTF-16 if needed (could be used for obfuscation). + if( substr( $chunk, 0, 2 ) == "\xfe\xff" ) { + $enc = 'UTF-16BE'; + } elseif( substr( $chunk, 0, 2 ) == "\xff\xfe" ) { + $enc = 'UTF-16LE'; + } else { + $enc = null; + } - if( $enc ) + if( $enc ) { $chunk = iconv( $enc, "ASCII//IGNORE", $chunk ); + } $chunk = trim( $chunk ); - #FIXME: convert from UTF-16 if necessarry! + # FIXME: convert from UTF-16 if necessarry! wfDebug( __METHOD__ . ": checking for embedded scripts and HTML stuff\n" ); - #check for HTML doctype - if ( preg_match( "/wrapWikiMsg( '
$1
', array( 'virus-badscanner', $wgAntivirus ) ); + $wgOut->wrapWikiMsg( "
\n$1\n
", + array( 'virus-badscanner', $wgAntivirus ) ); return wfMsg( 'virus-unknownscanner' ) . " $wgAntivirus"; } # look up scanner configuration - $command = $wgAntivirusSetup[$wgAntivirus]["command"]; - $exitCodeMap = $wgAntivirusSetup[$wgAntivirus]["codemap"]; - $msgPattern = isset( $wgAntivirusSetup[$wgAntivirus]["messagepattern"] ) ? - $wgAntivirusSetup[$wgAntivirus]["messagepattern"] : null; + $command = $wgAntivirusSetup[$wgAntivirus]['command']; + $exitCodeMap = $wgAntivirusSetup[$wgAntivirus]['codemap']; + $msgPattern = isset( $wgAntivirusSetup[$wgAntivirus]['messagepattern'] ) ? + $wgAntivirusSetup[$wgAntivirus]['messagepattern'] : null; - if ( strpos( $command,"%f" ) === false ) { + if ( strpos( $command, "%f" ) === false ) { # simple pattern: append file to scan $command .= " " . wfEscapeShellArg( $file ); } else { @@ -818,15 +966,10 @@ abstract class UploadBase { # execute virus scanner $exitCode = false; - #NOTE: there's a 50 line workaround to make stderr redirection work on windows, too. + # NOTE: there's a 50 line workaround to make stderr redirection work on windows, too. # that does not seem to be worth the pain. # Ask me (Duesentrieb) about it if it's ever needed. - $output = array(); - if ( wfIsWindows() ) { - exec( "$command", $output, $exitCode ); - } else { - exec( "$command 2>&1", $output, $exitCode ); - } + $output = wfShellExec( "$command 2>&1", $exitCode ); # map exit code to AV_xxx constants. $mappedCode = $exitCode; @@ -845,18 +988,17 @@ abstract class UploadBase { if ( $wgAntivirusRequired ) { return wfMsg( 'virus-scanfailed', array( $exitCode ) ); } else { - return NULL; + return null; } - } else if ( $mappedCode === AV_SCAN_ABORTED ) { + } elseif ( $mappedCode === AV_SCAN_ABORTED ) { # scan failed because filetype is unknown (probably imune) wfDebug( __METHOD__ . ": unsupported file type $file (code $exitCode).\n" ); - return NULL; - } else if ( $mappedCode === AV_NO_VIRUS ) { + return null; + } elseif ( $mappedCode === AV_NO_VIRUS ) { # no virus found wfDebug( __METHOD__ . ": file passed virus scan.\n" ); return false; } else { - $output = join( "\n", $output ); $output = trim( $output ); if ( !$output ) { @@ -880,8 +1022,6 @@ abstract class UploadBase { * from Internet Explorer on Mac OS Classic and Mac OS X will be. * If so, the data fork will be extracted to a second temporary file, * which will then be checked for validity and either kept or discarded. - * - * @access private */ private function checkMacBinary() { $macbin = new MacBinary( $this->mTempPath ); @@ -906,21 +1046,25 @@ abstract class UploadBase { * forbid this user from performing the upload. * * @return mixed true on success, error string on failure - * @access private */ - private function checkOverwrite() { - global $wgUser; + private function checkOverwrite( $user ) { // First check whether the local file can be overwritten $file = $this->getLocalFile(); - if( $file->exists() ) - if( !self::userCanReUpload( $wgUser, $file ) ) + if( $file->exists() ) { + if( !self::userCanReUpload( $user, $file ) ) { return 'fileexists-forbidden'; + } else { + return true; + } + } - // Check shared conflicts - $file = wfFindFile( $file->getName() ); - if ( $file && ( !$wgUser->isAllowed( 'reupload' ) || - !$wgUser->isAllowed( 'reupload-shared' ) ) ) + /* Check shared conflicts: if the local file does not exist, but + * wfFindFile finds a file, it exists in a shared repository. + */ + $file = wfFindFile( $this->getTitle() ); + if ( $file && !$user->isAllowed( 'reupload-shared' ) ) { return 'fileexists-shared-forbidden'; + } return true; } @@ -928,69 +1072,108 @@ abstract class UploadBase { /** * Check if a user is the last uploader * - * @param User $user - * @param string $img, image name - * @return bool + * @param $user User object + * @param $img String: image name + * @return Boolean */ public static function userCanReUpload( User $user, $img ) { - if( $user->isAllowed( 'reupload' ) ) + if( $user->isAllowed( 'reupload' ) ) { return true; // non-conditional - if( !$user->isAllowed( 'reupload-own' ) ) + } + if( !$user->isAllowed( 'reupload-own' ) ) { return false; - if( is_string( $img ) ) + } + if( is_string( $img ) ) { $img = wfLocalFile( $img ); - if ( !( $img instanceof LocalFile ) ) + } + if ( !( $img instanceof LocalFile ) ) { return false; + } return $user->getId() == $img->getUser( 'id' ); } /** * Helper function that does various existence checks for a file. - * The following checks are performed: + * The following checks are performed: * - The file exists * - Article with the same name as the file exists * - File exists with normalized extension * - The file looks like a thumbnail and the original exists - * - * @param File $file The file to check + * + * @param $file File The File object to check * @return mixed False if the file does not exists, else an array */ public static function getExistsWarning( $file ) { - if( $file->exists() ) - return array( 'exists', $file ); + if( $file->exists() ) { + return array( 'warning' => 'exists', 'file' => $file ); + } + + if( $file->getTitle()->getArticleID() ) { + return array( 'warning' => 'page-exists', 'file' => $file ); + } - if( $file->getTitle()->getArticleID() ) - return array( 'page-exists', $file ); + if ( $file->wasDeleted() && !$file->exists() ) { + return array( 'warning' => 'was-deleted', 'file' => $file ); + } if( strpos( $file->getName(), '.' ) == false ) { $partname = $file->getName(); - $rawExtension = ''; + $extension = ''; } else { $n = strrpos( $file->getName(), '.' ); - $rawExtension = substr( $file->getName(), $n + 1 ); + $extension = substr( $file->getName(), $n + 1 ); $partname = substr( $file->getName(), 0, $n ); } + $normalizedExtension = File::normalizeExtension( $extension ); - if ( $rawExtension != $file->getExtension() ) { + if ( $normalizedExtension != $extension ) { // We're not using the normalized form of the extension. // Normal form is lowercase, using most common of alternate // extensions (eg 'jpg' rather than 'JPEG'). // // Check for another file using the normalized form... - $nt_lc = Title::makeTitle( NS_FILE, $partname . '.' . $file->getExtension() ); + $nt_lc = Title::makeTitle( NS_FILE, "{$partname}.{$normalizedExtension}" ); $file_lc = wfLocalFile( $nt_lc ); - if( $file_lc->exists() ) - return array( 'exists-normalized', $file_lc ); + if( $file_lc->exists() ) { + return array( + 'warning' => 'exists-normalized', + 'file' => $file, + 'normalizedFile' => $file_lc + ); + } } if ( self::isThumbName( $file->getName() ) ) { # Check for filenames like 50px- or 180px-, these are mostly thumbnails - $nt_thb = Title::newFromText( substr( $partname , strpos( $partname , '-' ) +1 ) . '.' . $rawExtension ); + $nt_thb = Title::newFromText( substr( $partname , strpos( $partname , '-' ) +1 ) . '.' . $extension, NS_FILE ); $file_thb = wfLocalFile( $nt_thb ); - if( $file_thb->exists() ) - return array( 'thumb', $file_thb ); + if( $file_thb->exists() ) { + return array( + 'warning' => 'thumb', + 'file' => $file, + 'thumbFile' => $file_thb + ); + } else { + // File does not exist, but we just don't like the name + return array( + 'warning' => 'thumb-name', + 'file' => $file, + 'thumbFile' => $file_thb + ); + } + } + + + foreach( self::getFilenamePrefixBlacklist() as $prefix ) { + if ( substr( $partname, 0, strlen( $prefix ) ) == $prefix ) { + return array( + 'warning' => 'bad-prefix', + 'file' => $file, + 'prefix' => $prefix + ); + } } return false; @@ -1010,15 +1193,15 @@ abstract class UploadBase { } /** - * Get a list of blacklisted filename prefixes from [[MediaWiki:filename-prefix-blacklist]] + * Get a list of blacklisted filename prefixes from [[MediaWiki:Filename-prefix-blacklist]] * * @return array list of prefixes */ public static function getFilenamePrefixBlacklist() { $blacklist = array(); - $message = wfMsgForContent( 'filename-prefix-blacklist' ); - if( $message && !( wfEmptyMsg( 'filename-prefix-blacklist', $message ) || $message == '-' ) ) { - $lines = explode( "\n", $message ); + $message = wfMessage( 'filename-prefix-blacklist' )->inContentLanguage(); + if( !$message->isDisabled() ) { + $lines = explode( "\n", $message->plain() ); foreach( $lines as $line ) { // Remove comment lines $comment = substr( trim( $line ), 0, 1 ); @@ -1036,4 +1219,49 @@ abstract class UploadBase { return $blacklist; } + /** + * Gets image info about the file just uploaded. + * + * Also has the effect of setting metadata to be an 'indexed tag name' in returned API result if + * 'metadata' was requested. Oddly, we have to pass the "result" object down just so it can do that + * with the appropriate format, presumably. + * + * @param $result ApiResult: + * @return Array: image info + */ + public function getImageInfo( $result ) { + $file = $this->getLocalFile(); + // TODO This cries out for refactoring. We really want to say $file->getAllInfo(); here. + // Perhaps "info" methods should be moved into files, and the API should just wrap them in queries. + if ( $file instanceof UploadStashFile ) { + $imParam = ApiQueryStashImageInfo::getPropertyNames(); + $info = ApiQueryStashImageInfo::getInfo( $file, array_flip( $imParam ), $result ); + } else { + $imParam = ApiQueryImageInfo::getPropertyNames(); + $info = ApiQueryImageInfo::getInfo( $file, array_flip( $imParam ), $result ); + } + return $info; + } + + + public function convertVerifyErrorToStatus( $error ) { + $code = $error['status']; + unset( $code['status'] ); + return Status::newFatal( $this->getVerificationErrorCode( $code ), $error ); + } + + public static function getMaxUploadSize( $forType = null ) { + global $wgMaxUploadSize; + + if ( is_array( $wgMaxUploadSize ) ) { + if ( !is_null( $forType) && isset( $wgMaxUploadSize[$forType] ) ) { + return $wgMaxUploadSize[$forType]; + } else { + return $wgMaxUploadSize['*']; + } + } else { + return intval( $wgMaxUploadSize ); + } + + } }