Implements uploading from chunks. More...

Inheritance diagram for UploadFromChunks:

[legend]

Collaboration diagram for UploadFromChunks:

[legend]

Public Member Functions
	__construct (User $user, $stash=false, $repo=false)
	Setup local pointers to stash, repo and user (similar to UploadFromStash)

	addChunk ( $chunkPath, $chunkSize, $offset)
	Add a chunk to the temporary directory.

	concatenateChunks ()
	Append the final chunk and ready file for parent::performUpload()

	continueChunks ( $name, $key, $webRequestUpload)
	Continue chunk uploading.

	getOffset ()
	Get the offset at which the next uploaded chunk will be appended to.

	getVirtualChunkLocation ( $index)
	Returns the virtual chunk location:

	stashFile (User $user=null)
	@inheritDoc

	stashFileGetKey ()
	@inheritDoc

	stashSession ()
	@inheritDoc

	tryStashFile (User $user, $isPartial=false)
	@inheritDoc

Public Member Functions inherited from UploadFromFile
	getSourceType ()

	initialize ( $name, $webRequestUpload)
	Initialize from a filename and a WebRequestUpload.

	initializeFromRequest (&$request)

	verifyUpload ()

Public Member Functions inherited from UploadBase
	__construct ()

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

	checkWarnings ()
	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 ()

	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)
	Initialize the path information.

	isEmptyFile ()
	Return true if the file is empty.

	performUpload ( $comment, $pageText, $watch, $user, $tags=[])
	Really perform the upload.

	postProcessUpload ()
	Perform extra steps after a successful upload.

	validateName ()
	Verify that the name is valid and, if necessary, that we can overwrite.

	verifyPermissions ( $user)
	Alias for verifyTitlePermissions.

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

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

Protected Member Functions
	doStashFile (User $user=null)
	Calls the parent doStashFile and updates the uploadsession table to handle "chunks".

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

	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.

Protected Attributes
	$mChunkIndex

	$mFileKey

	$mOffset

	$mVirtualTempPath

Protected Attributes inherited from UploadFromFile
WebRequestUpload	$mUpload = null

Protected Attributes inherited from UploadBase
	$mBlackListedExtensions

	$mDesiredDestName

	$mDestName

	$mFileProps

	$mFileSize

	$mFilteredName

	$mFinalExtension

	$mJavaDetected

	$mLocalFile

	$mRemoveTempFile

	$mSourceType

	$mStashFile

	$mSVGNSError

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

	$mTitle = false

	$mTitleError = 0

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

Private Member Functions
	getChunkFileKey ( $index=null)

	getChunkIndex ()
	Get the current Chunk index.

	getChunkStatus ()
	Get the chunk db state and populate update relevant local values.

	outputChunk ( $chunkPath)
	Output the chunk to disk.

	updateChunkStatus ()
	Update the chunk db table with the current status:

	verifyChunk ()
	Verify that the chunk isn't really an evil html file.

Private Attributes
LocalRepo	$repo

Additional Inherited Members
Static Public Member Functions inherited from UploadFromFile
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 the MediaWiki maximum uploaded file size for given type of upload, based on $wgMaxUploadSize.

static	getSessionStatus (User $user, $statusKey)
	Get the current status of a chunked upload (used for polling)

static	isAllowed ( $user)
	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	setSessionStatus (User $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 (User $user, 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.

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

Static Protected Attributes inherited from UploadBase
static	$safeXmlEncodings

Detailed Description

Implements uploading from chunks.

Author: Michael Dale

Definition at line 30 of file UploadFromChunks.php.

Constructor & Destructor Documentation

◆ __construct()

UploadFromChunks::__construct	(	User	$user,
			$stash = `false`,
			$repo = `false`
	)

Setup local pointers to stash, repo and user (similar to UploadFromStash)

Parameters

User	$user
UploadStash \| bool	$stash	Default: false
FileRepo \| bool	$repo	Default: false

Definition at line 45 of file UploadFromChunks.php.

References $repo, $user, RepoGroup\singleton(), user, and wfDebug().

Member Function Documentation

◆ addChunk()

UploadFromChunks::addChunk	(	$chunkPath,
		$chunkSize,
		$offset
	)

Add a chunk to the temporary directory.

Parameters

string	$chunkPath	Path to temporary chunk file
int	$chunkSize	Size of the current chunk
int	$offset	Offset of current chunk ( mutch match database chunk offset )