Web access for files temporarily stored by UploadStash. More...

Inheritance diagram for SpecialUploadStash:

Collaboration diagram for SpecialUploadStash:

Public Member Functions
	__construct ()
	execute ($subPage)
	Execute page -- can output a file directly or show a listing of them.
	showUpload ($key)
	If file available in stash, cats it out to the client as a simple HTTP response.
Static Public Member Functions
static	tryClearStashedUploads ($formData)
	Static callback for the HTMLForm in showUploads, to process Note the stash has to be recreated since this is being called in a static context.
Public Attributes
const	MAX_SERVE_BYTES = 1048576
Private Member Functions
	outputContents ($content, $contentType)
	Output HTTP response of raw content Side effect: writes HTTP response to STDOUT.
	outputLocalFile (File $file)
	Output HTTP response for file Side effect: writes HTTP response to STDOUT.
	outputLocallyScaledThumb ($file, $params, $flags)
	Scale a file (probably with a locally installed imagemagick, or similar) and output it to STDOUT.
	outputRemoteScaledThumb ($file, $params, $flags)
	Scale a file with a remote "scaler", as exists on the Wikimedia Foundation cluster, and output it to STDOUT.
	outputThumbFromStash ($file, $params)
	Get a thumbnail for file, either generated locally or remotely, and stream it out.
	parseKey ($key)
	Parse the key passed to the SpecialPage.
	showUploads ()
	Default action when we don't have a subpage -- just show links to the uploads we have, Also show a button to clear stashed files.
Static Private Member Functions
static	outputFileHeaders ($contentType, $size)
	Output headers for streaming.
Private Attributes
	$stash

Detailed Description

Web access for files temporarily stored by UploadStash.

For example -- files that were uploaded with the UploadWizard extension are stored temporarily before committing them to the db. But we want to see their thumbnails and get other information about them.

Since this is based on the user's session, in effect this creates a private temporary file area. However, the URLs for the files cannot be shared.

Definition at line 35 of file SpecialUploadStash.php.

Constructor & Destructor Documentation

SpecialUploadStash::__construct ( )

Definition at line 49 of file SpecialUploadStash.php.

References $e, and RepoGroup\singleton().

Member Function Documentation

SpecialUploadStash::execute ( $ subPage )

Execute page -- can output a file directly or show a listing of them.

Parameters:

string $subPage Subpage, e.g. in http://example.com/wiki/Special:UploadStash/foo.jpg, the "foo.jpg" part

Returns:: bool Success

Reimplemented from SpecialPage.

Definition at line 64 of file SpecialUploadStash.php.

References SpecialPage\checkPermissions(), showUpload(), and showUploads().

SpecialUploadStash::outputContents	(	$	content,
		$	contentType
	)		`[private]`

Output HTTP response of raw content Side effect: writes HTTP response to STDOUT.

Parameters:

string	$content	Content
string	$contentType	MIME type

Exceptions:

SpecialUploadStashTooLargeException

Returns:: bool

Definition at line 299 of file SpecialUploadStash.php.

References $content, $size, outputFileHeaders(), and print.

Referenced by outputRemoteScaledThumb().

static SpecialUploadStash::outputFileHeaders	(	$	contentType,
		$	size
	)		`[static, private]`

Output headers for streaming.

Todo:: Unsure about encoding as binary; if we received from HTTP perhaps we should use that encoding, concatenated with semicolon to `$contentType` as it usually is.

Side effect: preps PHP to write headers to STDOUT.

Parameters:

string	$contentType	String suitable for content-type header
string	$size	Length in bytes

Definition at line 319 of file SpecialUploadStash.php.

Referenced by outputContents().

SpecialUploadStash::outputLocalFile ( File $ file ) [private]

Output HTTP response for file Side effect: writes HTTP response to STDOUT.

Parameters:

File $file File object with a local path (e.g. UnregisteredLocalFile, LocalFile. Oddly these don't share an ancestor!)

Exceptions:

SpecialUploadStashTooLargeException

Returns:: bool

Definition at line 280 of file SpecialUploadStash.php.

References array(), File\getPath(), File\getRepo(), File\getSize(), and MAX_SERVE_BYTES.

Referenced by outputLocallyScaledThumb(), and showUpload().

SpecialUploadStash::outputLocallyScaledThumb	(	$	file,
		$	params,
		$	flags
	)		`[private]`

Scale a file (probably with a locally installed imagemagick, or similar) and output it to STDOUT.

Parameters:

File	$file
array	$params	Scaling parameters ( e.g. array( width => '50' ) );
int	$flags	Scaling flags ( see File:: constants )

Exceptions:

MWException|UploadStashFileNotFoundException

Returns:: bool Success

Definition at line 184 of file SpecialUploadStash.php.

References $file, $flags, $params, false, outputLocalFile(), and File\RENDER_NOW.

Referenced by outputThumbFromStash().

SpecialUploadStash::outputRemoteScaledThumb	(	$	file,
		$	params,
		$	flags
	)		`[private]`

Scale a file with a remote "scaler", as exists on the Wikimedia Foundation cluster, and output it to STDOUT.

Note: Unlike the usual thumbnail process, the web client never sees the cluster URL; we do the whole HTTP transaction to the scaler ourselves and cat the results out. Note: We rely on NFS to have propagated the file contents to the scaler. However, we do not rely on the thumbnail being created in NFS and then propagated back to our filesystem. Instead we take the results of the HTTP request instead. Note: No caching is being done here, although we are instructing the client to cache it forever.

Parameters: