Implements uploading from previously stored file. More...

Inheritance diagram for UploadFromStash:

Collaboration diagram for UploadFromStash:

[legend]

Public Member Functions
	__construct (UserIdentity $user=null, $stash=false, $repo=false)

	getSourceType ()

	getTempFileSha1Base36 ()
	Get the base 36 SHA1 of the file.

	initialize ( $key, $name='upload_file', $initTempFile=true)

	initializeFromRequest (&$request)

	postProcessUpload ()
	Remove the database record after a successful upload.

	unsaveUploadedFile ()
	Remove a temporarily kept file stashed by saveTempUploadedFile().

Public Member Functions inherited from UploadBase
	__construct ()

	checkSvgScriptCallback ( $element, $attribs, $data=null)

	checkWarnings ( $user=null)
	Check for non fatal problems with the file.

	cleanupTempFile ()
	If we've modified the upload file we need to manually remove it on exit to clean up.

	convertVerifyErrorToStatus ( $error)

	fetchFile ()
	Fetch the file.

	getFileSize ()
	Return the file size.

	getImageInfo ( $result)
	Gets image info about the file just uploaded.

	getLocalFile ()
	Return the local file and initializes if necessary.

	getRealPath ( $srcPath)

	getStashFile ()

	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.

	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.

	verifyPermissions (Authority $performer)
	Alias for verifyTitlePermissions.

	verifyTitlePermissions (Authority $performer)
	Check whether the user can edit, upload and create the image.

	verifyUpload ()
	Verify whether the upload is sensible.

	zipEntryCallback ( $entry)
	Callback for ZipDirectoryReader to detect Java class files.

Static Public Member Functions
static	isValidKey ( $key)

static	isValidRequest ( $request)

Static Public Member Functions inherited from 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	checkSvgExternalDTD ( $type, $publicId, $systemId)
	Verify that DTD urls referenced are only the standard dtds.

static	checkSvgPICallback ( $target, $data)
	Callback to filter SVG Processing Instructions.

static	checkXMLEncodingMissmatch ( $file)
	Check a whitelist of xml encodings that are known not to be interpreted differently by the server's xml parser (expat) and some common browsers.

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 blacklisted 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 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.

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	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
	$mFileKey

	$mFileProps

	$mSourceType

	$mVirtualTempPath

Protected Attributes inherited from UploadBase
string[]	$mBlackListedExtensions

string null	$mDesiredDestName

string null	$mDestName

array null	$mFileProps

int null	$mFileSize

string null	$mFilteredName

string null	$mFinalExtension

bool null	$mJavaDetected

LocalFile null	$mLocalFile

bool null	$mRemoveTempFile

string null	$mSourceType

UploadStashFile null	$mStashFile

string false	$mSVGNSError

string null	$mTempPath
	Local file system path to the file to upload (or a local copy)

Title bool null	$mTitle = false

int	$mTitleError = 0

TempFSFile null	$tempFileObj
	Wrapper to handle deleting the temp file.

Additional Inherited Members
Public Attributes inherited from UploadBase
const	EMPTY_FILE = 3

const	FILE_TOO_LARGE = 12

const	FILENAME_TOO_LONG = 14

const	FILETYPE_BADTYPE = 9

const	FILETYPE_MISSING = 8

const	HOOK_ABORTED = 11

const	ILLEGAL_FILENAME = 5

const	MIN_LENGTH_PARTNAME = 4

const	OK = 0

const	OVERWRITE_EXISTING_FILE = 7

const	SUCCESS = 0

const	VERIFICATION_ERROR = 10

const	WINDOWS_NONASCII_FILENAME = 13

Protected Member Functions inherited from UploadBase
	detectScriptInSvg ( $filename, $partial)

	doStashFile (User $user=null)
	Implementation for stashFile() and tryStashFile().

	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.

Static Protected Attributes inherited from UploadBase
static	$safeXmlEncodings

Detailed Description

Implements uploading from previously stored file.

Author: Bryan Tong Minh

Definition at line 33 of file UploadFromStash.php.

Constructor & Destructor Documentation

◆ __construct()

UploadFromStash::__construct	(	UserIdentity	$user = null,
			$stash = false,
			$repo = false )

Parameters

UserIdentity \| null	$user	Default: null Sometimes this won't exist, as when running from cron.
UploadStash \| bool	$stash	Default: false
FileRepo \| bool	$repo	Default: false

Definition at line 50 of file UploadFromStash.php.

References wfDebug().

Member Function Documentation

◆ getSourceType()

UploadFromStash::getSourceType ( )

Returns: string

Reimplemented from UploadBase.

Definition at line 134 of file UploadFromStash.php.

References $mSourceType.

◆ getTempFileSha1Base36()

UploadFromStash::getTempFileSha1Base36 ( )

Get the base 36 SHA1 of the file.

Returns: string

Reimplemented from UploadBase.

Definition at line 142 of file UploadFromStash.php.

◆ initialize()

UploadFromStash::initialize	(	$key,
		$name = 'upload_file',
		$initTempFile = true )

Parameters

string	$key
string	$name
bool	$initTempFile

Definition at line 95 of file UploadFromStash.php.

References UploadBase\getRealPath(), and UploadBase\initializePathInfo().

Referenced by initializeFromRequest().

◆ initializeFromRequest()

UploadFromStash::initializeFromRequest ( & $request )

Parameters

WebRequest &$request

Reimplemented from UploadBase.

Definition at line 118 of file UploadFromStash.php.

References initialize().

◆ isValidKey()

static UploadFromStash::isValidKey ( $key )

static

Parameters

string $key

Returns: bool

Definition at line 74 of file UploadFromStash.php.

References UploadStash\KEY_FORMAT_REGEX.

Referenced by isValidRequest(), and ApiUpload\selectUploadModule().

◆ isValidRequest()

static UploadFromStash::isValidRequest ( $request )

static

Parameters

WebRequest $request

Returns: bool

Reimplemented from UploadBase.

Definition at line 83 of file UploadFromStash.php.

References isValidKey().

◆ postProcessUpload()

UploadFromStash::postProcessUpload ( )

Remove the database record after a successful upload.

Reimplemented from UploadBase.

Definition at line 157 of file UploadFromStash.php.

References unsaveUploadedFile().

◆ unsaveUploadedFile()

UploadFromStash::unsaveUploadedFile ( )

Remove a temporarily kept file stashed by saveTempUploadedFile().

Returns: bool Success

Definition at line 150 of file UploadFromStash.php.

Referenced by postProcessUpload().

Member Data Documentation

◆ $mFileKey

UploadFromStash::$mFileKey

protected

Definition at line 34 of file UploadFromStash.php.

◆ $mFileProps

UploadFromStash::$mFileProps

protected

Definition at line 36 of file UploadFromStash.php.

◆ $mSourceType

UploadFromStash::$mSourceType

protected

Definition at line 37 of file UploadFromStash.php.

Referenced by getSourceType().

◆ $mVirtualTempPath

UploadFromStash::$mVirtualTempPath

protected

Definition at line 35 of file UploadFromStash.php.

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

includes/upload/UploadFromStash.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getSourceType()

◆ getTempFileSha1Base36()

◆ initialize()

◆ initializeFromRequest()

◆ isValidKey()

◆ isValidRequest()

◆ postProcessUpload()

◆ unsaveUploadedFile()

Member Data Documentation

◆ $mFileKey

◆ $mFileProps

◆ $mSourceType

◆ $mVirtualTempPath