MediaWiki master
MediaWiki\Upload\UploadFromFile Class Reference

Implements regular file uploads. More...

Inherits MediaWiki\Upload\UploadBase.

Inherited by MediaWiki\Upload\UploadFromChunks.

Collaboration diagram for MediaWiki\Upload\UploadFromFile:

Public Member Functions

 getSourceType ()
 
 initialize ( $name, $webRequestUpload)
 Initialize from a filename and a MediaWiki\Request\WebRequestUpload.
 
 initializeFromRequest (&$request)
 
 skipStashFileAttempt ()
 Check, if stash file attempt should be skipped, for example when the file is already known to stash.
 
 verifyUpload ()
 
- Public Member Functions inherited from MediaWiki\Upload\UploadBase
 __construct ()
 
 authorizeUpload (Authority $performer)
 Check whether the user can upload the image.
 
 canFetchFile ()
 Perform checks to see if the file can be fetched.
 
 checkWarnings (Authority $performer)
 Check for non fatal problems with the file.
 
 cleanupTempFile ()
 If we've modified the upload file, then we need to manually remove it on exit to clean up.
 
 convertVerifyErrorToStatus (array $error)
 
 fetchFile ()
 Fetch the file.
 
 getDesiredDestName ()
 Get the desired destination name.
 
 getFileSize ()
 Return the file size.
 
 getImageInfo ( $result=null)
 Gets image info about the file just uploaded.
 
 getLocalFile ()
 Return the local file and initializes if necessary.
 
 getRealPath ( $srcPath)
 
 getStashFile ()
 
 getTempFileSha1Base36 ()
 Get the base 36 SHA1 of the file.
 
 getTempPath ()
 
 getTitle ()
 Returns the title of the file to be uploaded.
 
 getVerificationErrorCode ( $error)
 
 initializePathInfo ( $name, $tempPath, $fileSize, $removeTempFile=false)
 
 isEmptyFile ()
 Return true if the file is empty.
 
 performUpload ( $comment, $pageText, $watch, $user, $tags=[], ?string $watchlistExpiry=null)
 Really perform the upload.
 
 postProcessUpload ()
 Perform extra steps after a successful upload.
 
 tryStashFile (User $user, $isPartial=false)
 Like stashFile(), but respects extensions' wishes to prevent the stashing.
 
 validateName ()
 Verify that the name is valid and, if necessary, that we can overwrite.
 

Static Public Member Functions

static isValidRequest ( $request)
 
- Static Public Member Functions inherited from MediaWiki\Upload\UploadBase
static checkFileExtension ( $ext, $list)
 Perform case-insensitive match against a list of file extensions.
 
static checkFileExtensionList ( $ext, $list)
 Perform case-insensitive match against a list of file extensions.
 
static createFromRequest (&$request, $type=null)
 Create a form of UploadBase depending on wpSourceType and initializes it.
 
static detectScript ( $file, $mime, $extension)
 Heuristic for detecting files that could contain JavaScript instructions or things that may look like HTML to a browser and are thus potentially harmful.
 
static detectVirus ( $file)
 Generic wrapper function for a virus scanner program.
 
static getExistsWarning ( $file)
 Helper function that does various existence checks for a file.
 
static getFilenamePrefixBlacklist ()
 Get a list of disallowed filename prefixes from [[MediaWiki:Filename-prefix-blacklist]].
 
static getMaxPhpUploadSize ()
 Get the PHP maximum uploaded file size, based on ini settings.
 
static getMaxUploadSize ( $forType=null)
 Get MediaWiki's maximum uploaded file size for a given type of upload, based on $wgMaxUploadSize.
 
static getSessionStatus (UserIdentity $user, $statusKey)
 Get the current status of a chunked upload (used for polling).
 
static isAllowed (Authority $performer)
 Returns true if the user can use this upload module or else a string identifying the missing permission.
 
static isEnabled ()
 Returns true if uploads are enabled.
 
static isThrottled ( $user)
 Returns true if the user has surpassed the upload rate limit, false otherwise.
 
static isThumbName ( $filename)
 Helper function that checks whether the filename looks like a thumbnail.
 
static makeWarningsSerializable ( $warnings)
 Convert the warnings array returned by checkWarnings() to something that can be serialized, and that is suitable for inclusion directly in action API results.
 
static setSessionStatus (UserIdentity $user, $statusKey, $value)
 Set the current status of a chunked upload (used for polling).
 
static splitExtensions ( $filename)
 Split a file into a base name and all dot-delimited 'extensions' on the end.
 
static unserializeWarnings ( $warnings)
 Convert the serialized warnings array created by makeWarningsSerializable() back to the output of checkWarnings().
 
static userCanReUpload (Authority $performer, File $img)
 Check if a user is the last uploader.
 
static verifyExtension ( $mime, $extension)
 Checks if the MIME type of the uploaded file matches the file extension.
 

Protected Attributes

WebRequestUpload $mUpload = null
 
- Protected Attributes inherited from MediaWiki\Upload\UploadBase
string[] $mBlackListedExtensions
 
string null $mDesiredDestName
 
string null $mDestName
 
array null $mFileProps
 
int null $mFileSize
 
string null $mFilteredName
 
string null $mFinalExtension
 
LocalFile null $mLocalFile
 
bool null $mRemoveTempFile
 
string null $mSourceType
 
UploadStashFile null $mStashFile
 
string null $mTempPath
 Local file system path to the file to upload (or a local copy)
 
Title false null $mTitle = false
 
int $mTitleError = 0
 
TempFSFile null $tempFileObj
 Wrapper to handle deleting the temp file.
 

Additional Inherited Members

- Public Attributes inherited from MediaWiki\Upload\UploadBase
const EMPTY_FILE = 3
 
const FILE_TOO_LARGE = 12
 
const FILENAME_TOO_LONG = 14
 
const FILETYPE_BADTYPE = 9
 
const FILETYPE_MISSING = 8
 
const ILLEGAL_FILENAME = 5
 
const MIN_LENGTH_PARTNAME = 4
 
const OK = 0
 
const SUCCESS = 0
 
const VERIFICATION_ERROR = 10
 
const WINDOWS_NONASCII_FILENAME = 13
 
- Protected Member Functions inherited from MediaWiki\Upload\UploadBase
 doStashFile (?User $user=null)
 Implementation for stashFile() and tryStashFile().
 
 getFileProps ()
 File props is very expensive on large files (due to sha1 calc) so it is important we save the result to reuse.
 
 runUploadStashFileHook (User $user)
 
 setTempFile ( $tempPath, $fileSize=null)
 
 verifyFile ()
 Verifies that it's ok to include the uploaded file.
 
 verifyMimeType ( $mime)
 Verify the MIME type.
 
 verifyPartialFile ()
 A verification routine suitable for partial files.
 

Detailed Description

Implements regular file uploads.

Author
Bryan Tong Minh

Definition at line 21 of file UploadFromFile.php.

Member Function Documentation

◆ getSourceType()

MediaWiki\Upload\UploadFromFile::getSourceType ( )
Returns
string

Reimplemented from MediaWiki\Upload\UploadBase.

Definition at line 65 of file UploadFromFile.php.

◆ initialize()

MediaWiki\Upload\UploadFromFile::initialize ( $name,
$webRequestUpload )

Initialize from a filename and a MediaWiki\Request\WebRequestUpload.

Parameters
string$name
WebRequestUpload$webRequestUpload

Definition at line 46 of file UploadFromFile.php.

References MediaWiki\Upload\UploadBase\initializePathInfo().

Referenced by MediaWiki\Upload\UploadFromFile\initializeFromRequest().

◆ initializeFromRequest()

MediaWiki\Upload\UploadFromFile::initializeFromRequest ( & $request)
Parameters
WebRequest&$request

Reimplemented from MediaWiki\Upload\UploadBase.

Definition at line 30 of file UploadFromFile.php.

References $request, and MediaWiki\Upload\UploadFromFile\initialize().

◆ isValidRequest()

static MediaWiki\Upload\UploadFromFile::isValidRequest ( $request)
static
Parameters
WebRequest$request
Returns
bool

Reimplemented from MediaWiki\Upload\UploadBase.

Definition at line 56 of file UploadFromFile.php.

◆ skipStashFileAttempt()

MediaWiki\Upload\UploadFromFile::skipStashFileAttempt ( )

Check, if stash file attempt should be skipped, for example when the file is already known to stash.

Since
1.46
Stability: stable
to override

Reimplemented from MediaWiki\Upload\UploadBase.

Definition at line 69 of file UploadFromFile.php.

◆ verifyUpload()

MediaWiki\Upload\UploadFromFile::verifyUpload ( )

Member Data Documentation

◆ $mUpload

WebRequestUpload MediaWiki\Upload\UploadFromFile::$mUpload = null
protected

Definition at line 25 of file UploadFromFile.php.


The documentation for this class was generated from the following file: