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

Collaboration diagram for UploadStash:

[legend]

Public Member Functions
	__construct (FileRepo $repo, UserIdentity $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
LocalRepo	$repo
	repository that this uses to store temp files public because we sometimes need to get a LocalFile within the same repo.

const	KEY_FORMAT_REGEX = '/^[\w\-\.]+\.\w*$/'

Protected Member Functions
	fetchFileMetadata ( $key, $readFromDB=DB_REPLICA)
	Helper function: do the actual database query to fetch file metadata.

	initFile ( $key)
	Helper function: Initialize the UploadStashFile for a given file.

Protected Attributes
array	$fileMetadata = []
	cache of the file metadata that's stored in the database

array	$fileProps = []
	fileprops cache

array	$files = []
	array of initialized repo objects

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 57 of file UploadStash.php.

Constructor & Destructor Documentation

◆ __construct()

UploadStash::__construct	(	FileRepo	$repo,
		UserIdentity	$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

FileRepo	$repo
UserIdentity \| null	$user

Definition at line 90 of file UploadStash.php.

References $repo.

Member Function Documentation

◆ clear()

UploadStash::clear ( )

Remove all files from the stash.

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

Exceptions

UploadStashNotLoggedInException

Returns: bool Success

Definition at line 340 of file UploadStash.php.

References wfDebug(), and wfMessage().

◆ fetchFileMetadata()

UploadStash::fetchFileMetadata	(		$key,
			$readFromDB = DB_REPLICA )

protected

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

Parameters

string	$key
int	$readFromDB	Constant (default: DB_REPLICA)

Returns: bool

Definition at line 509 of file UploadStash.php.

References $dbr, and DB_PRIMARY.

Referenced by getFile().

◆ getExtensionForPath()

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

Parameters

string $path

Returns: string

Definition at line 475 of file UploadStash.php.

References $path.

Referenced by stashFile().

◆ getFile()

UploadStash::getFile	(		$key,
			$noAuth = false )

Get a file and its metadata from the stash.

The noAuth param is a bit janky but is required for automated scripts which clean out the stash.

Parameters

string	$key	Key under which file information is stored
bool	$noAuth	(optional) Don't check authentication. Used by maintenance scripts.

Exceptions

UploadStashFileNotFoundException
UploadStashNotLoggedInException
UploadStashWrongOwnerException
UploadStashBadPathException

Returns: UploadStashFile

Definition at line 112 of file UploadStash.php.

References $path, DB_PRIMARY, fetchFileMetadata(), initFile(), wfDebug(), and wfMessage().

◆ getFileProps()

UploadStash::getFileProps ( $key )

Getter for fileProps.

Parameters

string $key Key under which file information is stored

Returns: array

Definition at line 188 of file UploadStash.php.

References getFile().

◆ getMetadata()

UploadStash::getMetadata ( $key )

Getter for file metadata.

Parameters

string $key Key under which file information is stored

Returns: array

Definition at line 176 of file UploadStash.php.

References getFile().

◆ initFile()

UploadStash::initFile ( $key )

protected

Helper function: Initialize the UploadStashFile for a given file.

Parameters

string $key Key under which to store the object

Exceptions

UploadStashZeroLengthFileException

Returns: bool

Definition at line 547 of file UploadStash.php.

References $file, and wfMessage().

Referenced by getFile(), and stashFile().

◆ listFiles()

UploadStash::listFiles ( )

List all files in the stash.

Exceptions

UploadStashNotLoggedInException

Returns: array|false

Definition at line 439 of file UploadStash.php.

References $keys, $res, and wfMessage().

◆ removeFile()

UploadStash::removeFile ( $key )

Remove a particular file from the stash.

Also removes it from the repo.

Parameters

string $key

Exceptions

UploadStashNoSuchKeyException\|UploadStashNotLoggedInException
UploadStashWrongOwnerException

Returns: bool Success

Definition at line 370 of file UploadStash.php.

References removeFileNoAuth(), and wfMessage().

◆ removeFileNoAuth()

UploadStash::removeFileNoAuth ( $key )

Remove a file (see removeFile), but doesn't check ownership first.

Parameters

string $key

Returns: bool Success

Definition at line 408 of file UploadStash.php.

References getFile(), and wfDebug().

Referenced by removeFile().

◆ stashFile()

UploadStash::stashFile	(		$path,
			$sourceType = null )

Stash a file in a temp directory and record that we did this in the database, along with other metadata.

Parameters

string	$path	Path to file you want stashed
string \| null	$sourceType	The type of upload that generated this file (currently, I believe, 'file' or null)

Exceptions

UploadStashBadPathException
UploadStashFileException
UploadStashNotLoggedInException

Returns: UploadStashFile|null File, or null on failure

Definition at line 206 of file UploadStash.php.

References $fileProps, $path, getExtensionForPath(), getFile(), initFile(), wfDebug(), and wfMessage().

Member Data Documentation

◆ $fileMetadata

array UploadStash::$fileMetadata = []

protected

cache of the file metadata that's stored in the database

Definition at line 74 of file UploadStash.php.

◆ $fileProps

array UploadStash::$fileProps = []

protected

fileprops cache

Definition at line 77 of file UploadStash.php.

Referenced by stashFile().

◆ $files

array UploadStash::$files = []

protected

array of initialized repo objects

Definition at line 71 of file UploadStash.php.

◆ $repo

LocalRepo UploadStash::$repo

repository that this uses to store temp files public because we sometimes need to get a LocalFile within the same repo.

Definition at line 68 of file UploadStash.php.

Referenced by __construct().

◆ KEY_FORMAT_REGEX

const UploadStash::KEY_FORMAT_REGEX = '/^[\w\-\.]+\.\w*$/'

Definition at line 59 of file UploadStash.php.

Referenced by UploadFromStash\isValidKey().

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

includes/upload/UploadStash.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clear()

◆ fetchFileMetadata()

◆ getExtensionForPath()

◆ getFile()

◆ getFileProps()

◆ getMetadata()

◆ initFile()

◆ listFiles()

◆ removeFile()

◆ removeFileNoAuth()

◆ stashFile()

Member Data Documentation

◆ $fileMetadata

◆ $fileProps

◆ $files

◆ $repo

◆ KEY_FORMAT_REGEX