Implements uploading from chunks. More...

Inheritance diagram for UploadFromChunks:

Collaboration diagram for UploadFromChunks:

[legend]

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

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

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

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

	getVirtualChunkLocation ( $index)
	Returns the virtual chunk location: More...

	performUpload ( $comment, $pageText, $watch, $user)
	Perform the upload, then remove the temp copy afterward. More...

	stashFile (User $user=null)
	Calls the parent stashFile and updates the uploadsession table to handle "chunks". More...

Public Member Functions inherited from UploadFromFile
	getSourceType ()

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

	initializeFromRequest (&$request)

	verifyUpload ()

Public Member Functions inherited from UploadBase
	__construct ()

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

	checkWarnings ()
	Check for non fatal problems with the file. More...

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

	convertVerifyErrorToStatus ( $error)

	fetchFile ()
	Fetch the file. More...

	getFileSize ()
	Return the file size. More...

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

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

	getRealPath ( $srcPath)

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

	getTempPath ()

	getTitle ()
	Returns the title of the file to be uploaded. More...

	getVerificationErrorCode ( $error)

	initializePathInfo ( $name, $tempPath, $fileSize, $removeTempFile=false)
	Initialize the path information. More...

	isEmptyFile ()
	Return true if the file is empty. More...

	stashFileGetKey ()
	Stash a file in a temporary directory, returning a key which can be used to find the file again. More...

	stashSession ()
	alias for stashFileGetKey, for backwards compatibility More...

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

	verifyPermissions ( $user)
	Alias for verifyTitlePermissions. More...

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

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

Protected Attributes
	$mChunkIndex

	$mFileKey

	$mOffset

	$mVirtualTempPath

Protected Attributes inherited from UploadFromFile
WebRequestUpload	$mUpload = null

Protected Attributes inherited from UploadBase
	$mBlackListedExtensions

	$mDesiredDestName

	$mFilteredName

	$mJavaDetected

	$mLocalFile

	$mTempPath

	$mTitle = false

Private Member Functions
	getChunkFileKey ( $index=null)

	getChunkIndex ()
	Get the current Chunk index. More...

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

	getOffset ()
	Gets the current offset in fromt the stashedupload table. More...

	outputChunk ( $chunkPath)
	Output the chunk to disk. More...

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

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

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

static	checkFileExtensionList ( $ext, $list)
	Perform case-insensitive match against a list of file extensions. More...

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

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

static	createFromRequest (&$request, $type=null)
	Create a form of UploadBase depending on wpSourceType and initializes it. More...

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

static	detectVirus ( $file)
	Generic wrapper function for a virus scanner program. More...

static	getExistsWarning ( $file)
	Helper function that does various existence checks for a file. More...

static	getFilenamePrefixBlacklist ()
	Get a list of blacklisted filename prefixes from [[MediaWiki:Filename-prefix-blacklist]]. More...

static	getMaxUploadSize ( $forType=null)

static	getSessionStatus ( $statusKey)
	Get the current status of a chunked upload (used for polling). More...

static	isAllowed ( $user)
	Returns true if the user can use this upload module or else a string identifying the missing permission. More...

static	isEnabled ()
	Returns true if uploads are enabled. More...

static	isThumbName ( $filename)
	Helper function that checks whether the filename looks like a thumbnail. More...

static	setSessionStatus ( $statusKey, $value)
	Set the current status of a chunked upload (used for polling). More...

static	splitExtensions ( $filename)
	Split a file into a base name and all dot-delimited 'extensions' on the end. More...

static	userCanReUpload (User $user, $img)
	Check if a user is the last uploader. More...

static	verifyExtension ( $mime, $extension)
	Checks if the mime type of the uploaded file matches the file extension. More...

Public Attributes inherited from UploadBase
	$mDestName

	$mFileProps

	$mFileSize

	$mFinalExtension

	$mRemoveTempFile

	$mSourceType

	$mSVGNSError

	$mTitleError = 0

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	SESSION_STATUS_KEY = 'wsUploadStatusData'

const	SUCCESS = 0

const	UPLOAD_VERIFICATION_ERROR = 11

const	VERIFICATION_ERROR = 10

const	WINDOWS_NONASCII_FILENAME = 13

Static Public Attributes inherited from UploadBase
static	$uploadHandlers = array( 'Stash', 'File', 'Url' )

Protected Member Functions inherited from UploadBase
	detectScriptInSvg ( $filename)

	verifyFile ()
	Verifies that it's ok to include the uploaded file. More...

	verifyMimeType ( $mime)
	Verify the mime type. More...

	verifyPartialFile ()
	A verification routine suitable for partial files. More...

Static Protected Attributes inherited from UploadBase
static	$safeXmlEncodings = array( 'UTF-8', 'ISO-8859-1', 'ISO-8859-2', 'UTF-16', 'UTF-32' )

Detailed Description

Implements uploading from chunks.

Author: Michael Dale

Definition at line 30 of file UploadFromChunks.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

Parameters

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

Definition at line 43 of file UploadFromChunks.php.

References $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 )