MediaWiki  REL1_19
Public Member Functions | Public Attributes | Protected Attributes | Private Member Functions
UploadFromChunks Class Reference
Upload

Implements uploading from chunks. More...

Inheritance diagram for UploadFromChunks:
Inheritance graph
[legend]
Collaboration diagram for UploadFromChunks:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 __construct ($user=false, $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.
 getVirtualChunkLocation ($index)
 Returns the virtual chunk location:
 performUpload ($comment, $pageText, $watch, $user)
 Perform the upload, then remove the temp copy afterward.
 stashFile ()
 Calls the parent stashFile and updates the uploadsession table to handle "chunks".

Public Attributes

 $mChunkIndex
 $mFileKey
 $mVirtualTempPath

Protected Attributes

 $mOffset

Private Member Functions

 getChunkFileKey ($index=null)
 getChunkIndex ()
 Get the current Chunk index.
 getChunkStatus ()
 Get the chunk db state and populate update relevant local values.
 getOffset ()
 Gets the current offset in fromt the stashedupload table.
 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.

Detailed Description

Implements uploading from chunks.

Author:
Michael Dale

Definition at line 8 of file UploadFromChunks.php.

Constructor & Destructor Documentation

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

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

Parameters:
$userUser
$stashUploadStash
$repoFileRepo

Definition at line 18 of file UploadFromChunks.php.

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

Here is the call graph for this function:

Member Function Documentation

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

Add a chunk to the temporary directory.

Parameters:
$chunkPathpath to temporary chunk file
$chunkSizesize of the current chunk
$offsetoffset of current chunk ( mutch match database chunk offset )
Returns:
Status

Definition at line 160 of file UploadFromChunks.php.

References UploadBase\getMaxUploadSize(), getOffset(), Status\newFatal(), outputChunk(), updateChunkStatus(), and verifyChunk().

Here is the call graph for this function:

UploadFromChunks::concatenateChunks ( )

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

Returns:
FileRepoStatus

Definition at line 87 of file UploadFromChunks.php.

References $ext, FileRepo\DELETE_SOURCE, FileBackend\extensionFromPath(), TempFSFile\factory(), getChunkIndex(), getOffset(), UploadBase\getVerificationErrorCode(), getVirtualChunkLocation(), UploadBase\OK, stashFile(), UploadFromFile\verifyUpload(), wfDebug(), and wfDebugLog().

Here is the call graph for this function:

UploadFromChunks::continueChunks ( $  name,
$  key,
$  webRequestUpload 
)

Continue chunk uploading.

Definition at line 69 of file UploadFromChunks.php.

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

Here is the call graph for this function:

UploadFromChunks::getChunkFileKey ( $  index = null) [private]

Definition at line 287 of file UploadFromChunks.php.

References getChunkIndex().

Referenced by getVirtualChunkLocation(), and outputChunk().

Here is the call graph for this function:

Here is the caller graph for this function:

UploadFromChunks::getChunkIndex ( ) [private]

Get the current Chunk index.

Returns:
Integer index of the current chunk

Definition at line 241 of file UploadFromChunks.php.

Referenced by concatenateChunks(), getChunkFileKey(), and updateChunkStatus().

Here is the caller graph for this function:

UploadFromChunks::getChunkStatus ( ) [private]

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

Definition at line 216 of file UploadFromChunks.php.

Referenced by continueChunks().

Here is the caller graph for this function:

UploadFromChunks::getOffset ( ) [private]

Gets the current offset in fromt the stashedupload table.

Returns:
Integer current byte offset of the chunk file set

Definition at line 252 of file UploadFromChunks.php.

Referenced by addChunk(), concatenateChunks(), and updateChunkStatus().

Here is the caller graph for this function:

UploadFromChunks::getVirtualChunkLocation ( $  index)

Returns the virtual chunk location:

Parameters:
unknown_type$index

Definition at line 144 of file UploadFromChunks.php.

References getChunkFileKey().

Referenced by concatenateChunks().

Here is the call graph for this function:

Here is the caller graph for this function:

UploadFromChunks::outputChunk ( $  chunkPath) [private]

Output the chunk to disk.

Parameters:
$chunkPathstring

Definition at line 264 of file UploadFromChunks.php.

References getChunkFileKey().

Referenced by addChunk(), and stashFile().

Here is the call graph for this function:

Here is the caller graph for this function:

UploadFromChunks::performUpload ( $  comment,
$  pageText,
$  watch,
$  user 
)

Perform the upload, then remove the temp copy afterward.

Parameters:
$commentstring
$pageTextstring
$watchbool
$userUser
Returns:
Status

Reimplemented from UploadBase.

Definition at line 135 of file UploadFromChunks.php.

References $comment, and $user.

UploadFromChunks::stashFile ( )

Calls the parent stashFile and updates the uploadsession table to handle "chunks".

Returns:
UploadStashFile stashed file

Reimplemented from UploadBase.

Definition at line 46 of file UploadFromChunks.php.

References outputChunk(), updateChunkStatus(), and verifyChunk().

Referenced by concatenateChunks().

Here is the call graph for this function:

Here is the caller graph for this function:

UploadFromChunks::updateChunkStatus ( ) [private]

Update the chunk db table with the current status:

Definition at line 197 of file UploadFromChunks.php.

References getChunkIndex(), getOffset(), and wfDebug().

Referenced by addChunk(), and stashFile().

Here is the call graph for this function:

Here is the caller graph for this function:

UploadFromChunks::verifyChunk ( ) [private]

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

Exceptions:
UploadChunkVerificationException

Definition at line 299 of file UploadFromChunks.php.

References $res, and UploadBase\verifyPartialFile().

Referenced by addChunk(), and stashFile().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

UploadFromChunks::$mChunkIndex

Definition at line 9 of file UploadFromChunks.php.

UploadFromChunks::$mFileKey

Definition at line 9 of file UploadFromChunks.php.

UploadFromChunks::$mOffset [protected]

Definition at line 9 of file UploadFromChunks.php.

UploadFromChunks::$mVirtualTempPath

Definition at line 9 of file UploadFromChunks.php.

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