<?php
-
-class UploadBase {
- var $mTempPath;
- var $mDesiredDestName, $mDestName, $mRemoveTempFile, $mSourceType;
- var $mTitle = false, $mTitleError = 0;
- var $mFilteredName, $mFinalExtension;
+/**
+ * @file
+ * @ingroup upload
+ *
+ * UploadBase and subclasses are the backend of MediaWiki's file uploads.
+ * The frontends are formed by ApiUpload and SpecialUpload.
+ *
+ * See also includes/docs/upload.txt
+ *
+ * @author Brion Vibber
+ * @author Bryan Tong Minh
+ * @author Michael Dale
+ */
+
+abstract class UploadBase {
+ protected $mTempPath;
+ protected $mDesiredDestName, $mDestName, $mRemoveTempFile, $mSourceType;
+ protected $mTitle = false, $mTitleError = 0;
+ protected $mFilteredName, $mFinalExtension;
+ protected $mLocalFile;
const SUCCESS = 0;
const OK = 0;
- const BEFORE_PROCESSING = 1;
- const LARGE_FILE_SERVER = 2;
const EMPTY_FILE = 3;
const MIN_LENGTH_PARTNAME = 4;
const ILLEGAL_FILENAME = 5;
- const PROTECTED_PAGE = 6;
const OVERWRITE_EXISTING_FILE = 7;
const FILETYPE_MISSING = 8;
const FILETYPE_BADTYPE = 9;
const VERIFICATION_ERROR = 10;
const UPLOAD_VERIFICATION_ERROR = 11;
- const UPLOAD_WARNING = 12;
- const INTERNAL_ERROR = 13;
- const MIN_LENGHT_PARTNAME = 14;
+ const HOOK_ABORTED = 11;
const SESSION_VERSION = 2;
+ const SESSION_KEYNAME = 'wsUploadData';
+
+ static public function getSessionKeyname() {
+ return self::SESSION_KEYNAME;
+ }
/**
* Returns true if uploads are enabled.
* Can be override by subclasses.
*/
- static function isEnabled() {
+ public static function isEnabled() {
global $wgEnableUploads;
- if ( !$wgEnableUploads )
+ if ( !$wgEnableUploads ) {
return false;
+ }
# Check php's file_uploads setting
if( !wfIniGetBool( 'file_uploads' ) ) {
}
return true;
}
+
/**
* Returns true if the user can use this upload module or else a string
* identifying the missing permission.
* Can be overriden by subclasses.
*/
- static function isAllowed( $user ) {
- if( !$user->isAllowed( 'upload' ) )
+ public static function isAllowed( $user ) {
+ if( !$user->isAllowed( 'upload' ) ) {
return 'upload';
+ }
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
*/
- static function createFromRequest( &$request, $type = null ) {
- $type = $type ? $type : $request->getVal( 'wpSourceType' );
+ public static function createFromRequest( &$request, $type = null ) {
+ $type = $type ? $type : $request->getVal( 'wpSourceType', 'File' );
- if( !$type )
+ if( !$type ) {
return null;
+ }
- $type = ucfirst($type);
- $className = 'UploadFrom'.$type;
- wfDebug( __METHOD__.": class name: $className");
- if( !in_array( $type, self::$uploadHandlers ) )
- return null;
+ // Get the upload class
+ $type = ucfirst( $type );
+
+ // 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;
+ }
+ }
- if( !call_user_func( array( $className, 'isEnabled' ) ) )
+ // Check whether this upload class is enabled
+ if( !call_user_func( array( $className, 'isEnabled' ) ) ) {
return null;
+ }
-
- if( !call_user_func( array( $className, 'isValidRequest' ), $request ) )
+ // Check whether the request is valid
+ if( !call_user_func( array( $className, 'isValidRequest' ), $request ) ) {
return null;
+ }
$handler = new $className;
$handler->initializeFromRequest( $request );
return $handler;
}
+
/**
* Check whether a request if valid for this handler
*/
- static function isValidRequest( $request ) {
+ public static function isValidRequest( $request ) {
return false;
}
- function __construct() {}
+ public function __construct() {}
/**
- * 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
*/
- 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.
+ */
+ public abstract function initializeFromRequest( &$request );
+
/**
* Fetch the file. Usually a no-op
*/
- function fetchFile() {
+ public function fetchFile() {
return Status::newGood();
}
- //return the file size
- function isEmptyFile(){
- return empty( $this->mFileSize);
+
+ /**
+ * Return true if the file is empty
+ * @return bool
+ */
+ public function isEmptyFile() {
+ return empty( $this->mFileSize );
}
+
/**
- * Verify whether the upload is sane.
- * Returns self::OK or else an array with error information
+ * Return the file size
+ * @return integer
*/
- function verifyUpload() {
- /**
- * If there was no filename or a zero size given, give up quick.
- */
+ public function getFileSize() {
+ return $this->mFileSize;
+ }
- if( $this->isEmptyFile() )
- return array( 'status' => self::EMPTY_FILE );
+ /**
+ * Append a file to the Repo file
+ *
+ * @param string $srcPath Path to source file
+ * @param string $toAppendPath 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;
+ }
- $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;
+ /**
+ * @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 );
}
- $this->mLocalFile = wfLocalFile( $nt );
- $this->mDestName = $this->mLocalFile->getName();
+ return $srcPath;
+ }
+ /**
+ * Verify whether the upload is sane.
+ * @return mixed self::OK or else an array with error information
+ */
+ public function verifyUpload( ) {
/**
- * In some cases we may forbid overwriting of existing files.
+ * If there was no filename or a zero size given, give up quick.
*/
- $overwrite = $this->checkOverwrite();
- if( $overwrite !== true )
- return array( 'status' => self::OVERWRITE_EXISTING_FILE, 'overwrite' => $overwrite );
+ if( $this->isEmptyFile() ) {
+ return array( 'status' => self::EMPTY_FILE );
+ }
/**
* 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 ) )
+ 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->validateNameAndOverwrite();
+ if( $result !== true ) {
+ return $result;
}
$error = '';
if( !wfRunHooks( 'UploadVerification',
array( $this->mDestName, $this->mTempPath, &$error ) ) ) {
- return array( 'status' => self::UPLOAD_VERIFICATION_ERROR, 'error' => $error );
+ // @fixme This status needs another name...
+ 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
*
- * this function seems to intermixes tmpfile and $this->mTempPath .. no idea why this is
+ * @return mixed true if valid, otherwise and array with 'status'
+ * and other keys
+ **/
+ public function validateNameAndOverwrite() {
+ $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.
+ */
+ $overwrite = $this->checkOverwrite();
+ if( $overwrite !== true ) {
+ return array(
+ 'status' => self::OVERWRITE_EXISTING_FILE,
+ 'overwrite' => $overwrite
+ );
+ }
+ return true;
+ }
+
+ /**
+ * Verifies that it's ok to include the uploaded file
*
- * @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 ) {
+ protected function verifyFile() {
$this->mFileProps = File::getPropsFromPath( $this->mTempPath, $this->mFinalExtension );
- $this->checkMacBinary( );
+ $this->checkMacBinary();
- #magically determine mime type
+ # magically determine mime type
$magic = MimeMagic::singleton();
- $mime = $magic->guessMimeType( $tmpfile, false );
+ $mime = $magic->guessMimeType( $this->mTempPath, false );
- #check mime type, if desired
+ # check mime type, if desired
global $wgVerifyMimeType;
- if( isset($wgMimeTypeBlacklist) && !is_null($wgMimeTypeBlacklist) ) {
- if ( $this->checkFileExtension( $mime, $wgMimeTypeBlacklist ) )
+ if ( $wgVerifyMimeType ) {
+ wfDebug ( "\n\nmime: <$mime> extension: <{$this->mFinalExtension}>\n\n");
+ if ( !$this->verifyExtension( $mime, $this->mFinalExtension ) ) {
+ return array( 'filetype-mime-mismatch' );
+ }
+
+ global $wgMimeTypeBlacklist;
+ if ( $this->checkFileExtension( $mime, $wgMimeTypeBlacklist ) ) {
return array( 'filetype-badmime', $mime );
+ }
# Check IE type
- $fp = fopen( $tmpfile, 'rb' );
+ $fp = fopen( $this->mTempPath, 'rb' );
$chunk = fread( $fp, 256 );
fclose( $fp );
$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 );
}
}
-
- #check for htmlish code and javascript
- if( $this->detectScript ( $tmpfile, $mime, $this->mFinalExtension ) ) {
+ # check for htmlish code and javascript
+ if( self::detectScript( $this->mTempPath, $mime, $this->mFinalExtension ) ) {
return 'uploadscripted';
}
if( $this->mFinalExtension == 'svg' || $mime == 'image/svg+xml' ) {
- if( $this->detectScriptInSvg( $tmpfile ) ) {
+ if( self::detectScriptInSvg( $this->mTempPath ) ) {
return 'uploadscripted';
}
}
/**
* Scan the uploaded file for viruses
*/
- $virus = $this->detectVirus($tmpfile);
+ $virus = $this->detectVirus( $this->mTempPath );
if ( $virus ) {
return array( 'uploadvirus', $virus );
}
- wfDebug( __METHOD__.": all clear; passing.\n" );
+ wfDebug( __METHOD__ . ": all clear; passing.\n" );
return true;
}
/**
- * Check whether the user can edit, upload and create the image
+ * Check whether the user can edit, upload and create the image.
+ *
+ * @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.
*/
- function verifyPermissions( $user ) {
+ public function verifyPermissions( $user ) {
/**
* If the image is protected, non-sysop users won't be able
* 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 ) );
/**
* Check for non fatal problems with the file
+ *
+ * @return Array of warnings
*/
- function checkWarnings() {
- $warning = array();
+ public function checkWarnings() {
+ $warnings = array();
- $filename = $this->mLocalFile->getName();
+ $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;
+ }
- $exists = self::getExistsWarning( $this->mLocalFile );
- if( $exists !== false )
- $warning['exists'] = $exists;
+ if ( $this->mFileSize == 0 ) {
+ $warnings['emptyfile'] = true;
+ }
- // Check whether this may be a thumbnail
- if( $exists !== false && $exists[0] != 'thumb'
- && self::isThumbName( $this->mLocalFile->getName() ) ){
- //make the title:
- $nt = $this->getTitle();
- $warning['file-thumbnail-no'] = substr( $filename , 0,
- strpos( $nt->getText() , '-' ) +1 );
+ $exists = self::getExistsWarning( $localFile );
+ if( $exists !== false ) {
+ $warnings['exists'] = $exists;
}
// Check dupes against existing files
$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( $this->mLocalFile->wasDeleted() && !$this->mLocalFile->exists() )
- $warning['filewasdeleted'] = $this->mLocalFile->getTitle();
-
- return $warning;
+ return $warnings;
}
/**
- * Really perform the upload.
+ * 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.
*/
- function performUpload( $comment, $pageText, $watch, $user ) {
- wfDebug("\n\n\performUpload: sum:" . $comment . ' c: ' . $pageText . ' w:' .$watch);
- $status = $this->mLocalFile->upload( $this->mTempPath, $comment, $pageText,
+ 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 );
- if( $status->isGood() && $watch )
- $user->addWatch( $this->mLocalFile->getTitle() );
+ if( $status->isGood() ) {
+ if ( $watch ) {
+ $user->addWatch( $this->getLocalFile()->getTitle() );
+ }
- if( $status->isGood() )
wfRunHooks( 'UploadComplete', array( &$this ) );
+ }
return $status;
}
/**
- * Returns a title or null
+ * 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
*/
- function getTitle() {
- if ( $this->mTitle !== false )
+ public function getTitle() {
+ 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 ) ) {
# 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 ) {
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;
}
- function getLocalFile() {
+ /**
+ * Return the local file and initializes if necessary.
+ */
+ public function getLocalFile() {
if( is_null( $this->mLocalFile ) ) {
$nt = $this->getTitle();
$this->mLocalFile = is_null( $nt ) ? null : wfLocalFile( $nt );
* 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
*/
- function saveTempUploadedFile( $saveName, $tempName ) {
- $repo = RepoGroup::singleton()->getLocalRepo();
- $status = $repo->storeTemp( $saveName, $tempName );
- return $status;
- }
- /* append to a stashed file */
- function appendToUploadFile($srcPath, $toAppendPath ){
+ protected function saveTempUploadedFile( $saveName, $tempSrc ) {
$repo = RepoGroup::singleton()->getLocalRepo();
- $status = $repo->append($srcPath, $toAppendPath);
+ $status = $repo->storeTemp( $saveName, $tempSrc );
return $status;
}
* Returns a key value which will be passed through a form
* to pick up the path info on a later invocation.
*
- * @return int
- * @access private
+ * @return Integer: session key
*/
- function stashSession() {
+ public function stashSession() {
$status = $this->saveTempUploadedFile( $this->mDestName, $this->mTempPath );
if( !$status->isOK() ) {
# Couldn't save the file.
return false;
}
- $mTempPath = $status->value;
- session_start();//start up the session (might have been previously closed to prevent php session locking)
- $key = $this->getSessionKey ();
- $_SESSION['wsUploadData'][$key] = array(
- 'mTempPath' => $mTempPath,
+
+ $key = $this->getSessionKey();
+ $_SESSION[self::SESSION_KEYNAME][$key] = array(
+ 'mTempPath' => $status->value,
'mFileSize' => $this->mFileSize,
- 'mSrcName' => $this->mSrcName,
'mFileProps' => $this->mFileProps,
'version' => self::SESSION_VERSION,
- );
- session_write_close();
- return $key;
- }
- //pull session Key gen from stash in cases where we want to start an upload without much information
- function getSessionKey(){
- $key = mt_rand( 0, 0x7fffffff );
- $_SESSION['wsUploadData'][$key] = array();
+ );
return $key;
}
/**
- * Remove a temporarily kept file stashed by saveTempUploadedFile().
- * @return success
+ * Generate a random session key from stash in cases where we want to start an upload without much information
*/
- function unsaveUploadedFile() {
- $repo = RepoGroup::singleton()->getLocalRepo();
- $success = $repo->freeTemp( $this->mTempPath );
- return $success;
+ protected function getSessionKey() {
+ $key = mt_rand( 0, 0x7fffffff );
+ $_SESSION[self::SESSION_KEYNAME][$key] = array();
+ return $key;
}
/**
* If we've modified the upload file we need to manually remove it
* on exit to clean up.
- * @access private
*/
- function cleanupTempFile() {
+ public function cleanupTempFile() {
if ( $this->mRemoveTempFile && $this->mTempPath && file_exists( $this->mTempPath ) ) {
- wfDebug( __METHOD__.": Removing temporary file {$this->mTempPath}\n" );
+ wfDebug( __METHOD__ . ": Removing temporary file {$this->mTempPath}\n" );
unlink( $this->mTempPath );
}
}
- function getTempPath() {
+ public function getTempPath() {
return $this->mTempPath;
}
-
- /**
+ /**
* Split a file into a base name and all dot-delimited 'extensions'
* on the end. Some web server configurations will fall back to
* earlier pseudo-'extensions' to determine type and execute
* 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 );
* Perform case-insensitive match against a list of file extensions.
* Returns true if any of the extensions are in the list.
*
- * @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 ) {
return false;
}
-
/**
* 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();
- if ( ! $mime || $mime == 'unknown' || $mime == 'unknown/unknown' )
- if ( ! $magic->isRecognizableExtension( $extension ) ) {
- wfDebug( __METHOD__.": passing file with unknown detected mime type; " .
+ if ( !$mime || $mime == 'unknown' || $mime == 'unknown/unknown' )
+ if ( !$magic->isRecognizableExtension( $extension ) ) {
+ wfDebug( __METHOD__ . ": passing file with unknown detected mime type; " .
"unrecognized extension '$extension', can't verify\n" );
return true;
} else {
- wfDebug( __METHOD__.": rejecting file with unknown detected mime type; ".
+ wfDebug( __METHOD__ . ": rejecting file with unknown detected mime type; ".
"recognized extension '$extension', so probably invalid file\n" );
return false;
}
- $match= $magic->isMatchingExtension($extension,$mime);
+ $match = $magic->isMatchingExtension( $extension, $mime );
- if ($match===NULL) {
- wfDebug( __METHOD__.": no file extension known for mime type $mime, passing file\n" );
+ if ( $match === null ) {
+ wfDebug( __METHOD__ . ": no file extension known for mime type $mime, passing file\n" );
return true;
- } elseif ($match===true) {
- wfDebug( __METHOD__.": mime type $mime matches extension $extension, passing file\n" );
+ } elseif( $match === true ) {
+ wfDebug( __METHOD__ . ": mime type $mime matches extension $extension, passing file\n" );
#TODO: if it's a bitmap, make sure PHP or ImageMagic resp. can handle it!
return true;
} else {
- wfDebug( __METHOD__.": mime type $mime mismatches file extension $extension, rejecting file\n" );
+ wfDebug( __METHOD__ . ": mime type $mime mismatches file extension $extension, rejecting file\n" );
return false;
}
}
/**
* 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
*/
- function detectScript($file, $mime, $extension) {
+ 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) $chunk = file_get_contents( $file );
- else {
+ if( strpos( $mime,'text/' ) === 0 ) {
+ $chunk = file_get_contents( $file );
+ } else {
$fp = fopen( $file, 'rb' );
$chunk = fread( $fp, 1024 );
fclose( $fp );
}
- $chunk= strtolower( $chunk );
-
- if (!$chunk) return false;
+ $chunk = strtolower( $chunk );
- #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( !$chunk ) {
+ return false;
+ }
- if ($enc) $chunk= iconv($enc,"ASCII//IGNORE",$chunk);
+ # 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;
+ }
- $chunk= trim($chunk);
+ if( $enc ) {
+ $chunk = iconv( $enc, "ASCII//IGNORE", $chunk );
+ }
- #FIXME: convert from UTF-16 if necessarry!
+ $chunk = trim( $chunk );
- wfDebug("SpecialUpload::detectScript: checking for embedded scripts and HTML stuff\n");
+ # FIXME: convert from UTF-16 if necessarry!
+ wfDebug( __METHOD__ . ": checking for embedded scripts and HTML stuff\n" );
- #check for HTML doctype
- if (eregi("<!DOCTYPE *X?HTML",$chunk)) return true;
+ # check for HTML doctype
+ if ( preg_match( "/<!DOCTYPE *X?HTML/i", $chunk ) ) {
+ return true;
+ }
/**
- * Internet Explorer for Windows performs some really stupid file type
- * autodetection which can cause it to interpret valid image files as HTML
- * and potentially execute JavaScript, creating a cross-site scripting
- * attack vectors.
- *
- * Apple's Safari browser also performs some unsafe file type autodetection
- * which can cause legitimate files to be interpreted as HTML if the
- * web server is not correctly configured to send the right content-type
- * (or if you're really uploading plain text and octet streams!)
- *
- * Returns true if IE is likely to mistake the given file for HTML.
- * Also returns true if Safari would mistake the given file for HTML
- * when served with a generic content-type.
- */
-
+ * Internet Explorer for Windows performs some really stupid file type
+ * autodetection which can cause it to interpret valid image files as HTML
+ * and potentially execute JavaScript, creating a cross-site scripting
+ * attack vectors.
+ *
+ * Apple's Safari browser also performs some unsafe file type autodetection
+ * which can cause legitimate files to be interpreted as HTML if the
+ * web server is not correctly configured to send the right content-type
+ * (or if you're really uploading plain text and octet streams!)
+ *
+ * Returns true if IE is likely to mistake the given file for HTML.
+ * Also returns true if Safari would mistake the given file for HTML
+ * when served with a generic content-type.
+ */
$tags = array(
- '<a',
+ '<a href',
'<body',
'<head',
'<html', #also in safari
'<pre',
'<script', #also in safari
'<table'
- );
- if( ! $wgAllowTitlesInSVG && $extension !== 'svg' && $mime !== 'image/svg' ) {
+ );
+
+ if( !$wgAllowTitlesInSVG && $extension !== 'svg' && $mime !== 'image/svg' ) {
$tags[] = '<title';
}
}
/*
- * look for javascript
- */
+ * look for JavaScript
+ */
- #resolve entity-refs to look at attributes. may be harsh on big files... cache result?
+ # resolve entity-refs to look at attributes. may be harsh on big files... cache result?
$chunk = Sanitizer::decodeCharReferences( $chunk );
- #look for script-types
- if (preg_match('!type\s*=\s*[\'"]?\s*(?:\w*/)?(?:ecma|java)!sim',$chunk)) return true;
+ # look for script-types
+ if( preg_match( '!type\s*=\s*[\'"]?\s*(?:\w*/)?(?:ecma|java)!sim', $chunk ) ) {
+ return true;
+ }
- #look for html-style script-urls
- if (preg_match('!(?:href|src|data)\s*=\s*[\'"]?\s*(?:ecma|java)script:!sim',$chunk)) return true;
+ # look for html-style script-urls
+ if( preg_match( '!(?:href|src|data)\s*=\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
+ return true;
+ }
- #look for css-style script-urls
- if (preg_match('!url\s*\(\s*[\'"]?\s*(?:ecma|java)script:!sim',$chunk)) return true;
+ # look for css-style script-urls
+ if( preg_match( '!url\s*\(\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
+ return true;
+ }
- wfDebug("SpecialUpload::detectScript: no scripts found\n");
+ wfDebug( __METHOD__ . ": no scripts found\n" );
return false;
}
- function detectScriptInSvg( $filename ) {
+ protected function detectScriptInSvg( $filename ) {
$check = new XmlTypeCheck( $filename, array( $this, 'checkSvgScriptCallback' ) );
return $check->filterMatch;
}
/**
* @todo Replace this with a whitelist filter!
*/
- function checkSvgScriptCallback( $element, $attribs ) {
+ public function checkSvgScriptCallback( $element, $attribs ) {
$stripped = $this->stripXmlNamespace( $element );
if( $stripped == 'script' ) {
return array_pop( $parts );
}
-
-
/**
* Generic wrapper function for a virus scanner program.
* This relies on the $wgAntivirus and $wgAntivirusSetup variables.
* $wgAntivirusRequired may be used to deny upload if the scan fails.
*
- * @param string $file Pathname to the temporary upload file
+ * @param $file String: pathname to the temporary upload file
* @return mixed false if not virus is found, NULL if the scan fails or is disabled,
* or a string containing feedback from the virus scanner if a virus was found.
* If textual feedback is missing but a virus was found, this function returns true.
*/
- function detectVirus($file) {
+ public static function detectVirus( $file ) {
global $wgAntivirus, $wgAntivirusSetup, $wgAntivirusRequired, $wgOut;
if ( !$wgAntivirus ) {
- wfDebug( __METHOD__.": virus scanner disabled\n");
- return NULL;
+ wfDebug( __METHOD__ . ": virus scanner disabled\n" );
+ return null;
}
if ( !$wgAntivirusSetup[$wgAntivirus] ) {
- wfDebug( __METHOD__.": unknown virus scanner: $wgAntivirus\n" );
- $wgOut->wrapWikiMsg( '<div class="error">$1</div>', array( 'virus-badscanner', $wgAntivirus ) );
- return wfMsg('virus-unknownscanner') . " $wgAntivirus";
+ wfDebug( __METHOD__ . ": unknown virus scanner: $wgAntivirus\n" );
+ $wgOut->wrapWikiMsg( "<div class=\"error\">\n$1</div>", 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 {
$command = str_replace( "%f", wfEscapeShellArg( $file ), $command );
}
- wfDebug( __METHOD__.": running virus scan: $command \n" );
+ wfDebug( __METHOD__ . ": running virus scan: $command \n" );
# 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;
if ( $mappedCode === AV_SCAN_FAILED ) {
# scan failed (code was mapped to false by $exitCodeMap)
- wfDebug( __METHOD__.": failed to scan $file (code $exitCode).\n" );
+ wfDebug( __METHOD__ . ": failed to scan $file (code $exitCode).\n" );
if ( $wgAntivirusRequired ) {
- return wfMsg('virus-scanfailed', array( $exitCode ) );
+ 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 ) {
+ wfDebug( __METHOD__ . ": unsupported file type $file (code $exitCode).\n" );
+ return null;
+ } elseif ( $mappedCode === AV_NO_VIRUS ) {
# no virus found
- wfDebug( __METHOD__.": file passed virus scan.\n" );
+ wfDebug( __METHOD__ . ": file passed virus scan.\n" );
return false;
} else {
- $output = join( "\n", $output );
$output = trim( $output );
if ( !$output ) {
}
}
- wfDebug( __METHOD__.": FOUND VIRUS! scanner feedback: $output \n" );
+ wfDebug( __METHOD__ . ": FOUND VIRUS! scanner feedback: $output \n" );
return $output;
}
}
* 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
*/
- function checkMacBinary() {
+ private function checkMacBinary() {
$macbin = new MacBinary( $this->mTempPath );
if( $macbin->isValid() ) {
- $dataFile = tempnam( wfTempDir(), "WikiMacBinary" );
+ $dataFile = tempnam( wfTempDir(), 'WikiMacBinary' );
$dataHandle = fopen( $dataFile, 'wb' );
- wfDebug( "SpecialUpload::checkMacBinary: Extracting MacBinary data fork to $dataFile\n" );
+ wfDebug( __METHOD__ . ": Extracting MacBinary data fork to $dataFile\n" );
$macbin->extractData( $dataHandle );
$this->mTempPath = $dataFile;
* Check if there's an overwrite conflict and, if so, if restrictions
* forbid this user from performing the upload.
*
- * @return mixed true on success, WikiError on failure
- * @access private
+ * @return mixed true on success, error string on failure
*/
- function checkOverwrite() {
+ private function checkOverwrite() {
global $wgUser;
// First check whether the local file can be overwritten
- if( $this->mLocalFile->exists() )
- if( !self::userCanReUpload( $wgUser, $this->mLocalFile ) )
+ $file = $this->getLocalFile();
+ if( $file->exists() ) {
+ if( !self::userCanReUpload( $wgUser, $file ) ) {
return 'fileexists-forbidden';
+ } else {
+ return true;
+ }
+ }
- // Check shared conflicts
- $file = wfFindFile( $this->mLocalFile->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 && !$wgUser->isAllowed( 'reupload-shared' ) ) {
return 'fileexists-shared-forbidden';
+ }
return true;
-
}
+
/**
* 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 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 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;
}
+ /**
+ * Helper function that checks whether the filename looks like a thumbnail
+ */
public static function isThumbName( $filename ) {
$n = strrpos( $filename, '.' );
$partname = $n ? substr( $filename, 0, $n ) : $filename;
substr( $partname , 3, 3 ) == 'px-' ||
substr( $partname , 2, 3 ) == 'px-'
) &&
- ereg( "[0-9]{2}" , substr( $partname , 0, 2) );
+ preg_match( "/[0-9]{2}/" , substr( $partname , 0, 2 ) );
}
/**
- * 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
*/
return $blacklist;
}
+ public function getImageInfo( $result ) {
+ $file = $this->getLocalFile();
+ $imParam = ApiQueryImageInfo::getPropertyNames();
+ return ApiQueryImageInfo::getInfo( $file, array_flip( $imParam ), $result );
+ }
}
dépôts / lhc / web / wiklou.git / blobdiff