UploadStash is intended to accomplish a few things: More...

Public Member Functions
	__construct (FileRepo $repo, $user=null)
	Represents a temporary filestore, with metadata in the database.
	clear ()
	Remove all files from the stash.
	getFile ($key, $noAuth=false)
	Get a file and its metadata from the stash.
	getFileProps ($key)
	Getter for fileProps.
	getMetadata ($key)
	Getter for file metadata.
	listFiles ()
	List all files in the stash.
	removeFile ($key)
	Remove a particular file from the stash.
	removeFileNoAuth ($key)
	Remove a file (see removeFile), but doesn't check ownership first.
	stashFile ($path, $sourceType=null)
	Stash a file in a temp directory and record that we did this in the database, along with other metadata.
Static Public Member Functions
static	getExtensionForPath ($path)
	Find or guess extension -- ensuring that our extension matches our mime type.
Public Attributes
	$isLoggedIn
	$repo
	$userId
const	KEY_FORMAT_REGEX = '/^[\w-\.]+\.\w*$/'
Protected Member Functions
	fetchFileMetadata ($key, $readFromDB=DB_SLAVE)
	Helper function: do the actual database query to fetch file metadata.
	initFile ($key)
	Helper function: Initialize the UploadStashFile for a given file.
Protected Attributes
	$fileMetadata = array()
	$fileProps = array()
	$files = array()
	$user

Detailed Description

UploadStash is intended to accomplish a few things:

enable applications to temporarily stash files without publishing them to the wiki.
- Several parts of MediaWiki do this in similar ways: UploadBase, UploadWizard, and FirefoggChunkedExtension And there are several that reimplement stashing from scratch, in idiosyncratic ways. The idea is to unify them all here. Mostly all of them are the same except for storing some custom fields, which we subsume into the data array.
enable applications to find said files later, as long as the db table or temp files haven't been purged.
enable the uploading user (and *ONLY* the uploading user) to access said files, and thumbnails of said files, via a URL. We accomplish this using a database table, with ownership checking as you might expect. See SpecialUploadStash, which implements a web interface to some files stored this way.

UploadStash right now is *mostly* intended to show you one user's slice of the entire stash. The user parameter is only optional because there are few cases where we clean out the stash from an automated script. In the future we might refactor this.

UploadStash represents the entire stash of temporary files. UploadStashFile is a filestore for the actual physical disk files. UploadFromStash extends UploadBase, and represents a single stashed file as it is moved from the stash to the regular file repository

Definition at line 22 of file UploadStash.php.

Constructor & Destructor Documentation

UploadStash::__construct	(	FileRepo $	repo,
		$	user = `null`
	)

Represents a temporary filestore, with metadata in the database.

Designed to be compatible with the session stashing code in UploadBase (should replace it eventually)

Parameters:

$repo FileRepo

Definition at line 53 of file UploadStash.php.

References $repo, $user, and $wgUser.

Member Function Documentation

UploadStash::clear ( )

Remove all files from the stash.

Does not clean up files in the repo, just the record of them.

Exceptions:

UploadStashNotLoggedInException

Returns:: boolean: success

Definition at line 271 of file UploadStash.php.

References wfDebug().

Here is the call graph for this function:

UploadStash::fetchFileMetadata	(	$	key,
		$	readFromDB = `DB_SLAVE`
	)		`[protected]`

Helper function: do the actual database query to fetch file metadata.

Parameters:

$key	String: key

Returns:: boolean

Definition at line 433 of file UploadStash.php.

References $dbr.

Referenced by getFile().

Here is the caller graph for this function:

static UploadStash::getExtensionForPath ( $ path ) [static]

Find or guess extension -- ensuring that our extension matches our mime type.

Since these files are constructed from php tempnames they may not start off with an extension. XXX this is somewhat redundant with the checks that ApiUpload.php does with incoming uploads versus the desired filename. Maybe we can get that passed to us...

Definition at line 395 of file UploadStash.php.

References $extensions, $n, $path, $wgFileBlacklist, File\normalizeExtension(), and MimeMagic\singleton().

Referenced by stashFile().

Here is the call graph for this function: