Base class for all backends using particular storage medium. More...

Inheritance diagram for FileBackendStore:

Collaboration diagram for FileBackendStore:

Public Member Functions
	__construct (array $config)
	clearCache (array $paths=null)
	Invalidate any in-process file stat and property cache.
	concatenate (array $params)
	Concatenate a list of storage files into a single file system file.
	copyInternal (array $params)
	Copy a file from one storage path to another in the backend.
	createInternal (array $params)
	Create a file in the backend with the given contents.
	deleteInternal (array $params)
	Delete a file at the storage path.
	describeInternal (array $params)
	Alter metadata for a file at the storage path.
	directoryExists (array $params)
	Check if a directory exists at a given storage path.
	executeOpHandlesInternal (array $fileOpHandles)
	Execute a list of FileBackendStoreOpHandle handles in parallel.
	fileExists (array $params)
	Check if a file exists at a storage path in the backend.
	getDirectoryList (array $params)
	Get an iterator to list all directories under a storage directory.
	getDirectoryListInternal ($container, $dir, array $params)
	Do not call this function from places outside FileBackend.
	getFileContentsMulti (array $params)
	Like getFileContents() except it takes an array of storage paths and returns a map of storage paths to strings (or null on failure).
	getFileHttpUrl (array $params)
	getFileList (array $params)
	Get an iterator to list all stored files under a storage directory.
	getFileListInternal ($container, $dir, array $params)
	Do not call this function from places outside FileBackend.
	getFileProps (array $params)
	Get the properties of the file at a storage path in the backend.
	getFileSha1Base36 (array $params)
	Get a SHA-1 hash of the file at a storage path in the backend.
	getFileSize (array $params)
	Get the size (bytes) of a file at a storage path in the backend.
	getFileStat (array $params)
	Get quick information about a file at a storage path in the backend.
	getFileTimestamp (array $params)
	Get the last-modified timestamp of the file at a storage path.
	getFileXAttributes (array $params)
	Get metadata about a file at a storage path in the backend.
	getLocalCopyMulti (array $params)
	Like getLocalCopy() except it takes an array of storage paths and returns a map of storage paths to TempFSFile objects (or null on failure).
	getLocalReferenceMulti (array $params)
	Like getLocalReference() except it takes an array of storage paths and returns a map of storage paths to FSFile objects (or null on failure).
	getOperationsInternal (array $ops)
	Return a list of FileOp objects from a list of operations.
	getPathsToLockForOpsInternal (array $performOps)
	Get a list of storage paths to lock for a list of operations Returns an array with LockManager::LOCK_UW (shared locks) and LockManager::LOCK_EX (exclusive locks) keys, each corresponding to a list of storage paths to be locked.
	getScopedLocksForOps (array $ops, Status $status)
	Get an array of scoped locks needed for a batch of file operations.
	isPathUsableInternal ($storagePath)
	Check if a file can be created or changed at a given storage path.
	isSingleShardPathInternal ($storagePath)
	Check if a storage path maps to a single shard.
	maxFileSizeInternal ()
	Get the maximum allowable file size given backend medium restrictions and basic performance constraints.
	moveInternal (array $params)
	Move a file from one storage path to another in the backend.
	nullInternal (array $params)
	No-op file operation that does nothing.
	preloadCache (array $paths)
	Preload persistent file stat cache and property cache into in-process cache.
	preloadFileStat (array $params)
	Preload file stat information (concurrently if possible) into in-process cache.
	storeInternal (array $params)
	Store a file into the backend from a file on disk.
	streamFile (array $params)
	Stream the file at a storage path in the backend.
Public Attributes
const	CACHE_CHEAP_SIZE = 500
const	CACHE_EXPENSIVE_SIZE = 5
const	CACHE_TTL = 10
Protected Member Functions
	deleteContainerCache ($container)
	Delete the cached info for a container.
	deleteFileCache ($path)
	Delete the cached stat info for a file path.
	directoriesAreVirtual ()
	Is this a key/value store where directories are just virtual? Virtual directories exists in so much as files exists that are prefixed with the directory path followed by a forward slash.
	doClean (array $params)
	doCleanInternal ($container, $dir, array $params)
	doClearCache (array $paths=null)
	Clears any additional stat caches for storage paths.
	doConcatenate (array $params)
	doCopyInternal (array $params)
	doCreateInternal (array $params)
	doDeleteInternal (array $params)
	doDescribeInternal (array $params)
	doDirectoryExists ($container, $dir, array $params)
	doExecuteOpHandlesInternal (array $fileOpHandles)
	doGetFileContentsMulti (array $params)
	doGetFileSha1Base36 (array $params)
	doGetFileStat (array $params)
	doGetFileStatMulti (array $params)
	Get file stat information (concurrently if possible) for several files.
	doGetFileXAttributes (array $params)
	doGetLocalCopyMulti (array $params)
	doGetLocalReferenceMulti (array $params)
	doMoveInternal (array $params)
	doOperationsInternal (array $ops, array $opts)
	doPrepare (array $params)
	doPrepareInternal ($container, $dir, array $params)
	doPrimeContainerCache (array $containerInfo)
	Fill the backend-specific process cache given an array of resolved container names and their corresponding cached info.
	doPublish (array $params)
	doPublishInternal ($container, $dir, array $params)
	doQuickOperationsInternal (array $ops)
	doSecure (array $params)
	doSecureInternal ($container, $dir, array $params)
	doStoreInternal (array $params)
	doStreamFile (array $params)
	fullContainerName ($container)
	Get the full container name, including the wiki ID prefix.
	getContainerHashLevels ($container)
	Get the sharding config for a container.
	getContainerShard ($container, $relPath)
	Get the container name shard suffix for a given path.
	getContainerSuffixes ($container)
	Get a list of full container shard suffixes for a container.
	getContentType ($storagePath, $content, $fsPath)
	Get the content type to use in HEAD/GET requests for a file.
	primeContainerCache (array $items)
	Do a batch lookup from cache for container stats for all containers used in a list of container names or storage paths objects.
	primeFileCache (array $items)
	Do a batch lookup from cache for file stats for all paths used in a list of storage paths or FileOp objects.
	resolveContainerName ($container)
	Resolve a container name, checking if it's allowed by the backend.
	resolveContainerPath ($container, $relStoragePath)
	Resolve a relative storage path, checking if it's allowed by the backend.
	resolveStoragePath ($storagePath)
	Splits a storage path into an internal container name, an internal relative file name, and a container shard suffix.
	resolveStoragePathReal ($storagePath)
	Like resolveStoragePath() except null values are returned if the container is sharded and the shard could not be determined or if the path ends with '/'.
	setConcurrencyFlags (array $opts)
	Set the 'concurrency' option from a list of operation options.
	setContainerCache ($container, array $val)
	Set the cached info for a container.
	setFileCache ($path, array $val)
	Set the cached stat info for a file path.
	stripInvalidHeadersFromOp (array $op)
	Strip long HTTP headers from a file operation.
Static Protected Member Functions
static	isValidContainerName ($container)
	Check if a container name is valid.
static	normalizeXAttributes (array $xattr)
	Normalize file headers/metadata to the FileBackend::getFileXAttributes() format.
Protected Attributes
	$cheapCache
	$expensiveCache
	$maxFileSize = 4294967296
BagOStuff	$memCache
	*
callable	$mimeCallback
	Method to get the MIME type of files *.
array	$shardViaHashLevels = array()
	Map of container names to sharding config *.
Private Member Functions
	containerCacheKey ($container)
	Get the cache key for a container.
	fileCacheKey ($path)
	Get the cache key for a file path.

Detailed Description

Base class for all backends using particular storage medium.

This class defines the methods as abstract that subclasses must implement. Outside callers should *not* use functions with "Internal" in the name.

The FileBackend operations are implemented using basic functions such as storeInternal(), copyInternal(), deleteInternal() and the like. This class is also responsible for path resolution and sanitization.

Since:: 1.19

Definition at line 38 of file FileBackendStore.php.

Constructor & Destructor Documentation

FileBackendStore::__construct ( array $ config )

See also:

FileBackend::__construct() Additional $config params include:

mimeCallback : Callback that takes (storage path, content, file system path) and returns the MIME type of the file or 'unknown/unknown'. The file system path parameter should be used if the content one is null.

Parameters:

array $config

Reimplemented from FileBackend.

Reimplemented in SwiftFileBackend, and FSFileBackend.

Definition at line 64 of file FileBackendStore.php.

Member Function Documentation

FileBackendStore::clearCache ( array $ paths = null ) [final]

Invalidate any in-process file stat and property cache.

If $paths is given, then only the cache for those files will be cleared.

See also:: FileBackend::getFileStat()

Parameters:

array $paths Storage paths (optional)

Reimplemented from FileBackend.

Definition at line 1272 of file FileBackendStore.php.

FileBackendStore::concatenate ( array $ params ) [final]

Concatenate a list of storage files into a single file system file.

The target path should refer to a file that is already locked or otherwise safe from modification from other processes. Normally, the file will be a new temp file, which should be adequate.

Parameters:

array

$params

Operation parameters, include:

srcs : ordered source storage paths (e.g. chunk1, chunk2, ...)
dst : file system path to 0-byte temp file
parallelize : try to do operations in parallel when possible

Returns:: Status

Reimplemented from FileBackend.

Definition at line 345 of file FileBackendStore.php.

FileBackendStore::containerCacheKey ( $ container ) [private]

Get the cache key for a container.

Parameters:

string $container Resolved container name

Returns:: string

Definition at line 1589 of file FileBackendStore.php.

FileBackendStore::copyInternal ( array $ params ) [final]

Copy a file from one storage path to another in the backend.

This will overwrite any file that exists at the destination. Do not call this function from places outside FileBackend and FileOp.

$params include:

src : source storage path
dst : destination storage path
ignoreMissingSource : do nothing if the source file does not exist
headers : HTTP header name/value map
async : Status will be returned immediately if supported. If the status is OK, then its value field will be set to a FileBackendStoreOpHandle object.
dstExists : Whether a file exists at the destination (optimization). Callers can use "false" if no existing file is being changed.

Parameters:

array $params

Returns:: Status

Definition at line 200 of file FileBackendStore.php.

FileBackendStore::createInternal ( array $ params ) [final]

Create a file in the backend with the given contents.

This will overwrite any file that exists at the destination. Do not call this function from places outside FileBackend and FileOp.

$params include:

content : the raw file contents
dst : destination storage path
headers : HTTP header name/value map
async : Status will be returned immediately if supported. If the status is OK, then its value field will be set to a FileBackendStoreOpHandle object.
dstExists : Whether a file exists at the destination (optimization). Callers can use "false" if no existing file is being changed.

Parameters:

array $params

Returns:: Status

Definition at line 117 of file FileBackendStore.php.

FileBackendStore::deleteContainerCache ( $ container ) [final, protected]

Delete the cached info for a container.

The cache key is salted for a while to prevent race conditions.

Parameters:

string $container Resolved container name

Definition at line 1609 of file FileBackendStore.php.

FileBackendStore::deleteFileCache ( $ path ) [final, protected]

Delete the cached stat info for a file path.

The cache key is salted for a while to prevent race conditions. Since negatives (404s) are not cached, this does not need to be called when a file is created at a path were there was none before.

Parameters:

string $path Storage path

Definition at line 1715 of file FileBackendStore.php.

FileBackendStore::deleteInternal ( array $ params ) [final]

Delete a file at the storage path.

Do not call this function from places outside FileBackend and FileOp.

$params include:

src : source storage path
ignoreMissingSource : do nothing if the source file does not exist
async : Status will be returned immediately if supported. If the status is OK, then its value field will be set to a FileBackendStoreOpHandle object.

Parameters:

array $params

Returns:: Status

Definition at line 232 of file FileBackendStore.php.

FileBackendStore::describeInternal ( array $ params ) [final]

Alter metadata for a file at the storage path.

Do not call this function from places outside FileBackend and FileOp.

$params include:

src : source storage path
headers : HTTP header name/value map
async : Status will be returned immediately if supported. If the status is OK, then its value field will be set to a FileBackendStoreOpHandle object.

Parameters:

array $params

Returns:: Status

Definition at line 312 of file FileBackendStore.php.

FileBackendStore::directoriesAreVirtual ( ) [abstract, protected]

Is this a key/value store where directories are just virtual? Virtual directories exists in so much as files exists that are prefixed with the directory path followed by a forward slash.

Returns:: bool

Reimplemented in SwiftFileBackend, FSFileBackend, and MemoryFileBackend.

FileBackendStore::directoryExists ( array $ params ) [final]

Check if a directory exists at a given storage path.

Backends using key/value stores will check if the path is a virtual directory, meaning there are files under the given directory.

Storage backends with eventual consistency might return stale data.

Parameters:

array

$params

Parameters include:

dir : storage directory

Returns:: bool|null Returns null on failure

Since:: 1.20

Reimplemented from FileBackend.

Definition at line 901 of file FileBackendStore.php.

FileBackendStore::doClean ( array $ params ) [final, protected]

See also:: FileBackend::clean()

Reimplemented from FileBackend.

Definition at line 543 of file FileBackendStore.php.

FileBackendStore::doCleanInternal	(	$	container,
		$	dir,
		array $	params
	)		`[protected]`

See also:: FileBackendStore::doClean()

Parameters:

string	$container
string	$dir
array	$params

Returns:: Status

Reimplemented in SwiftFileBackend, and FSFileBackend.

Definition at line 595 of file FileBackendStore.php.

FileBackendStore::doClearCache ( array $ paths = null ) [protected]

Clears any additional stat caches for storage paths.

See also:: FileBackend::clearCache()

Parameters:

array $paths Storage paths (optional)

Reimplemented in FSFileBackend.

Definition at line 1296 of file FileBackendStore.php.

FileBackendStore::doConcatenate ( array $ params ) [protected]

See also:: FileBackendStore::concatenate()

Parameters:

array $params

Returns:: Status

Definition at line 370 of file FileBackendStore.php.

FileBackendStore::doCopyInternal ( array $ params ) [abstract, protected]

See also:: FileBackendStore::copyInternal()

Parameters:

array $params

Returns:: Status

Reimplemented in SwiftFileBackend, FSFileBackend, and MemoryFileBackend.

FileBackendStore::doCreateInternal ( array $ params ) [abstract, protected]

See also:: FileBackendStore::createInternal()

Parameters:

array $params

Returns:: Status

Reimplemented in SwiftFileBackend, FSFileBackend, and MemoryFileBackend.

FileBackendStore::doDeleteInternal ( array $ params ) [abstract, protected]

See also:: FileBackendStore::deleteInternal()

Parameters:

array $params

Returns:: Status

Reimplemented in SwiftFileBackend, FSFileBackend, and MemoryFileBackend.

FileBackendStore::doDescribeInternal ( array $ params ) [protected]

See also:: FileBackendStore::describeInternal()

Parameters:

array $params

Returns:: Status

Reimplemented in SwiftFileBackend.

Definition at line 330 of file FileBackendStore.php.

FileBackendStore::doDirectoryExists	(	$	container,
		$	dir,
		array $	params
	)		`[abstract, protected]`

See also:: FileBackendStore::directoryExists()

Parameters:

string	$container	Resolved container name
string	$dir	Resolved path relative to container
array	$params

Returns:: bool|null

Reimplemented in SwiftFileBackend, FSFileBackend, and MemoryFileBackend.

FileBackendStore::doExecuteOpHandlesInternal ( array $ fileOpHandles ) [protected]

See also:: FileBackendStore::executeOpHandlesInternal()

Parameters:

array $fileOpHandles

Exceptions:

FileBackendError

Returns:: array List of corresponding Status objects

Reimplemented in SwiftFileBackend, and FSFileBackend.

Definition at line 1227 of file FileBackendStore.php.

FileBackendStore::doGetFileContentsMulti ( array $ params ) [protected]

See also:: FileBackendStore::getFileContentsMulti()

Parameters:

array $params

Returns:: array

Reimplemented in SwiftFileBackend.

Definition at line 692 of file FileBackendStore.php.

FileBackendStore::doGetFileSha1Base36 ( array $ params ) [protected]

See also:: FileBackendStore::getFileSha1Base36()

Parameters:

array $params

Returns:: bool|string

Definition at line 765 of file FileBackendStore.php.

FileBackendStore::doGetFileStat ( array $ params ) [abstract, protected]

See also:: FileBackendStore::getFileStat()

Reimplemented in SwiftFileBackend, FSFileBackend, and MemoryFileBackend.

FileBackendStore::doGetFileStatMulti ( array $ params ) [protected]

Get file stat information (concurrently if possible) for several files.

See also:: FileBackend::getFileStat()

Parameters:

array

$params

Parameters include:

srcs : list of source storage paths
latest : use the latest available data

Returns:: array|null Map of storage paths to array|bool|null (returns null if not supported)

Since:: 1.23

Reimplemented in SwiftFileBackend.

Definition at line 1357 of file FileBackendStore.php.

FileBackendStore::doGetFileXAttributes ( array $ params ) [protected]

See also:: FileBackendStore::getFileXAttributes()

Returns:: bool|string

Reimplemented in SwiftFileBackend.

Definition at line 733 of file FileBackendStore.php.

FileBackendStore::doGetLocalCopyMulti ( array $ params ) [abstract, protected]

See also:: FileBackendStore::getLocalCopyMulti()

Parameters:

array $params

Returns:: array

Reimplemented in SwiftFileBackend, FSFileBackend, MemoryFileBackend, and MockFileBackend.

FileBackendStore::doGetLocalReferenceMulti ( array $ params ) [protected]

See also:: FileBackendStore::getLocalReferenceMulti()

Parameters:

array $params

Returns:: array

Reimplemented in FSFileBackend.

Definition at line 821 of file FileBackendStore.php.

FileBackendStore::doMoveInternal ( array $ params ) [protected]

See also:: FileBackendStore::moveInternal()

Parameters:

array $params

Returns:: Status

Reimplemented in SwiftFileBackend, and FSFileBackend.

Definition at line 283 of file FileBackendStore.php.

FileBackendStore::doOperationsInternal	(	array $	ops,
		array $	opts
	)		`[final, protected]`

See also:: FileBackend::doOperations()

Reimplemented from FileBackend.

Definition at line 1070 of file FileBackendStore.php.

FileBackendStore::doPrepare ( array $ params ) [final, protected]

See also:: FileBackend::prepare()

Reimplemented from FileBackend.

Definition at line 438 of file FileBackendStore.php.

FileBackendStore::doPrepareInternal	(	$	container,
		$	dir,
		array $	params
	)		`[protected]`

See also:: FileBackendStore::doPrepare()

Parameters:

string	$container
string	$dir
array	$params

Returns:: Status

Reimplemented in SwiftFileBackend, and FSFileBackend.

Definition at line 469 of file FileBackendStore.php.

FileBackendStore::doPrimeContainerCache ( array $ containerInfo ) [protected]

Fill the backend-specific process cache given an array of resolved container names and their corresponding cached info.

Only containers that actually exist should appear in the map.

Parameters:

array $containerInfo Map of resolved container names to cached info

Reimplemented in SwiftFileBackend.

Definition at line 1661 of file FileBackendStore.php.

FileBackendStore::doPublish ( array $ params ) [final, protected]

See also:: FileBackend::publish()

Reimplemented from FileBackend.

Definition at line 508 of file FileBackendStore.php.

FileBackendStore::doPublishInternal	(	$	container,
		$	dir,
		array $	params
	)		`[protected]`

See also:: FileBackendStore::doPublish()

Parameters:

string	$container
string	$dir
array	$params

Returns:: Status

Reimplemented in SwiftFileBackend, and FSFileBackend.

Definition at line 539 of file FileBackendStore.php.

FileBackendStore::doQuickOperationsInternal ( array $ ops ) [final, protected]

See also:: FileBackend::doQuickOperations()

Since:: 1.20

Reimplemented from FileBackend.

Definition at line 1136 of file FileBackendStore.php.

FileBackendStore::doSecure ( array $ params ) [final, protected]

See also:: FileBackend::secure()

Reimplemented from FileBackend.

Definition at line 473 of file FileBackendStore.php.

FileBackendStore::doSecureInternal	(	$	container,
		$	dir,
		array $	params
	)		`[protected]`

See also:: FileBackendStore::doSecure()

Parameters:

string	$container
string	$dir
array	$params

Returns:: Status

Reimplemented in SwiftFileBackend, and FSFileBackend.

Definition at line 504 of file FileBackendStore.php.

FileBackendStore::doStoreInternal ( array $ params ) [abstract, protected]

See also:: FileBackendStore::storeInternal()

Parameters:

array $params

Returns:: Status

Reimplemented in SwiftFileBackend, FSFileBackend, and MemoryFileBackend.

FileBackendStore::doStreamFile ( array $ params ) [protected]

See also:: FileBackendStore::streamFile()

Parameters:

array $params

Returns:: Status

Reimplemented in SwiftFileBackend, and MemoryFileBackend.

Definition at line 888 of file FileBackendStore.php.

FileBackendStore::executeOpHandlesInternal ( array $ fileOpHandles ) [final]

Execute a list of FileBackendStoreOpHandle handles in parallel.

The resulting Status object fields will correspond to the order in which the handles where given.

Parameters:

array $fileOpHandles

Exceptions:

FileBackendError

Definition at line 1203 of file FileBackendStore.php.

FileBackendStore::fileCacheKey ( $ path ) [private]

Get the cache key for a file path.

Parameters:

string $path Normalized storage path

Returns:: string

Definition at line 1670 of file FileBackendStore.php.

FileBackendStore::fileExists ( array $ params ) [final]

Check if a file exists at a storage path in the backend.

This returns false if only a directory exists at the path.

Parameters:

array

$params

Parameters include:

src : source storage path
latest : use the latest available data

Returns:: bool|null Returns null on failure

Reimplemented from FileBackend.

Definition at line 599 of file FileBackendStore.php.

FileBackendStore::fullContainerName ( $ container ) [final, protected]

Get the full container name, including the wiki ID prefix.

Parameters:

string $container

Returns:: string

Definition at line 1549 of file FileBackendStore.php.

FileBackendStore::getContainerHashLevels ( $ container ) [final, protected]

Get the sharding config for a container.

If greater than 0, then all file storage paths within the container are required to be hashed accordingly.

Parameters:

string $container

Returns:: array (integer levels, integer base, repeat flag) or (0, 0, false)

Definition at line 1509 of file FileBackendStore.php.

FileBackendStore::getContainerShard	(	$	container,
		$	relPath
	)		`[final, protected]`

Get the container name shard suffix for a given path.

Any empty suffix means the container is not sharded.

Parameters:

string	$container	Container name
string	$relPath	Storage path relative to the container

Returns:: string|null Returns null if shard could not be determined

Definition at line 1457 of file FileBackendStore.php.

FileBackendStore::getContainerSuffixes ( $ container ) [final, protected]

Get a list of full container shard suffixes for a container.

Parameters:

string $container

Returns:: array

Definition at line 1530 of file FileBackendStore.php.

FileBackendStore::getContentType	(	$	storagePath,
		$	content,
		$	fsPath
	)		`[protected]`

Get the content type to use in HEAD/GET requests for a file.

Parameters:

string	$storagePath
string \| null	$content	File data
string \| null	$fsPath	File system path

Returns:: string MIME type

Definition at line 1821 of file FileBackendStore.php.

FileBackendStore::getDirectoryList ( array $ params ) [final]

Get an iterator to list *all* directories under a storage directory.

If the directory is of the form "mwstore://backend/container", then all directories in the container will be listed. If the directory is of form "mwstore://backend/container/dir", then all directories directly under that directory will be listed. Results will be storage directories relative to the given directory.

Storage backends with eventual consistency might return stale data.

Failures during iteration can result in FileBackendError exceptions (since 1.22).

Parameters:

array

$params

Parameters include:

dir : storage directory
topOnly : only return direct child dirs of the directory

Returns:: Traversable|array|null Returns null on failure

Since:: 1.20

Reimplemented from FileBackend.

Definition at line 936 of file FileBackendStore.php.

FileBackendStore::getDirectoryListInternal	(	$	container,
		$	dir,
		array $	params
	)		`[abstract]`

Do not call this function from places outside FileBackend.

See also:: FileBackendStore::getDirectoryList()

Parameters:

string	$container	Resolved container name
string	$dir	Resolved path relative to container
array	$params

Returns:: Traversable|array|null Returns null on failure

Reimplemented in SwiftFileBackend, FSFileBackend, and MemoryFileBackend.

FileBackendStore::getFileContentsMulti ( array $ params )

Like getFileContents() except it takes an array of storage paths and returns a map of storage paths to strings (or null on failure).

The map keys (paths) are in the same order as the provided list of paths.

See also:: FileBackend::getFileContents()

Parameters:

array

$params

Parameters include:

srcs : list of source storage paths
latest : use the latest available data
parallelize : try to do operations in parallel when possible

Returns:: array Map of (path name => string or false on failure)

Since:: 1.20

Reimplemented from FileBackend.

Definition at line 678 of file FileBackendStore.php.

FileBackendStore::getFileHttpUrl ( array $ params )

See also:: FileBackend::getFileHttpUrl()

Parameters:

array $params

Returns:: string|null

Reimplemented from FileBackend.

Reimplemented in SwiftFileBackend.

Definition at line 846 of file FileBackendStore.php.

FileBackendStore::getFileList ( array $ params ) [final]

Get an iterator to list *all* stored files under a storage directory.

If the directory is of the form "mwstore://backend/container", then all files in the container will be listed. If the directory is of form "mwstore://backend/container/dir", then all files under that directory will be listed. Results will be storage paths relative to the given directory.

Storage backends with eventual consistency might return stale data.

Failures during iteration can result in FileBackendError exceptions (since 1.22).

Parameters:

array

$params

Parameters include:

dir : storage directory
topOnly : only return direct child files of the directory (since 1.20)
adviseStat : set to true if stat requests will be made on the files (since 1.22)

Returns:: Traversable|array|null Returns null on failure

Reimplemented from FileBackend.

Definition at line 966 of file FileBackendStore.php.

FileBackendStore::getFileListInternal	(	$	container,
		$	dir,
		array $	params
	)		`[abstract]`

Do not call this function from places outside FileBackend.

See also:: FileBackendStore::getFileList()

Parameters:

string	$container	Resolved container name
string	$dir	Resolved path relative to container
array	$params

Returns:: Traversable|array|null Returns null on failure

Reimplemented in SwiftFileBackend, FSFileBackend, and MemoryFileBackend.

FileBackendStore::getFileProps ( array $ params ) [final]

Get the properties of the file at a storage path in the backend.

This gives the result of FSFile::getProps() on a local copy of the file.

Parameters:

array

$params

Parameters include:

src : source storage path
latest : use the latest available data

Returns:: array Returns FSFile::placeholderProps() on failure

Reimplemented from FileBackend.

Definition at line 774 of file FileBackendStore.php.

FileBackendStore::getFileSha1Base36 ( array $ params ) [final]

Get a SHA-1 hash of the file at a storage path in the backend.

Parameters:

array

$params

Parameters include:

src : source storage path
latest : use the latest available data

Returns:: string|bool Hash string or false on failure

Reimplemented from FileBackend.

Definition at line 737 of file FileBackendStore.php.

FileBackendStore::getFileSize ( array $ params ) [final]

Get the size (bytes) of a file at a storage path in the backend.

Parameters:

array

$params

Parameters include:

src : source storage path
latest : use the latest available data

Returns:: int|bool Returns false on failure

Reimplemented from FileBackend.

Definition at line 613 of file FileBackendStore.php.

FileBackendStore::getFileStat ( array $ params ) [final]

Get quick information about a file at a storage path in the backend.

If the file does not exist, then this returns false. Otherwise, the result is an associative array that includes:

mtime : the last-modified timestamp (TS_MW)
size : the file size (bytes) Additional values may be included for internal use only.

Parameters:

array

$params

Parameters include:

src : source storage path
latest : use the latest available data

Returns:: array|bool|null Returns null on failure

Reimplemented from FileBackend.

Definition at line 620 of file FileBackendStore.php.

FileBackendStore::getFileTimestamp ( array $ params ) [final]

Get the last-modified timestamp of the file at a storage path.

Parameters:

array

$params

Parameters include:

src : source storage path
latest : use the latest available data

Returns:: string|bool TS_MW timestamp or false on failure

Reimplemented from FileBackend.

Definition at line 606 of file FileBackendStore.php.

FileBackendStore::getFileXAttributes ( array $ params ) [final]

Get metadata about a file at a storage path in the backend.

If the file does not exist, then this returns false. Otherwise, the result is an associative array that includes:

headers : map of HTTP headers used for GET/HEAD requests (name => value)
metadata : map of file metadata (name => value) Metadata keys and headers names will be returned in all lower-case. Additional values may be included for internal use only.

Use FileBackend::hasFeatures() to check how well this is supported.

Parameters:

array

$params

$params include:

src : source storage path
latest : use the latest available data

Returns:: array|bool Returns false on failure

Since:: 1.23

Reimplemented from FileBackend.

Definition at line 703 of file FileBackendStore.php.

FileBackendStore::getLocalCopyMulti ( array $ params ) [final]

Like getLocalCopy() except it takes an array of storage paths and returns a map of storage paths to TempFSFile objects (or null on failure).

The map keys (paths) are in the same order as the provided list of paths.

See also:: FileBackend::getLocalCopy()

Parameters:

array

$params

Parameters include:

srcs : list of source storage paths
latest : use the latest available data
parallelize : try to do operations in parallel when possible

Returns:: array Map of (path name => TempFSFile or null on failure)

Since:: 1.20

Reimplemented from FileBackend.

Definition at line 825 of file FileBackendStore.php.

FileBackendStore::getLocalReferenceMulti ( array $ params ) [final]

Like getLocalReference() except it takes an array of storage paths and returns a map of storage paths to FSFile objects (or null on failure).

The map keys (paths) are in the same order as the provided list of paths.

See also:: FileBackend::getLocalReference()

Parameters:

array

$params

Parameters include:

srcs : list of source storage paths
latest : use the latest available data
parallelize : try to do operations in parallel when possible

Returns:: array Map of (path name => FSFile or null on failure)

Since:: 1.20

Reimplemented from FileBackend.

Definition at line 782 of file FileBackendStore.php.

FileBackendStore::getOperationsInternal ( array $ ops ) [final]

Return a list of FileOp objects from a list of operations.

Do not call this function from places outside FileBackend.

The result must have the same number of items as the input. An exception is thrown if an unsupported operation is requested.

Parameters:

array $ops Same format as doOperations()

Returns:: array List of FileOp objects

Exceptions:

FileBackendError

Definition at line 1007 of file FileBackendStore.php.

FileBackendStore::getPathsToLockForOpsInternal ( array $ performOps ) [final]

Get a list of storage paths to lock for a list of operations Returns an array with LockManager::LOCK_UW (shared locks) and LockManager::LOCK_EX (exclusive locks) keys, each corresponding to a list of storage paths to be locked.

All returned paths are normalized.

Parameters:

array $performOps List of FileOp objects

Returns:: array (LockManager::LOCK_UW => path list, LockManager::LOCK_EX => path list)

Definition at line 1046 of file FileBackendStore.php.

FileBackendStore::getScopedLocksForOps	(	array $	ops,
		Status $	status
	)

Get an array of scoped locks needed for a batch of file operations.

Normally, FileBackend::doOperations() handles locking, unless the 'nonLocking' param is passed in. This function is useful if you want the files to be locked for a broader scope than just when the files are changing. For example, if you need to update DB metadata, you may want to keep the files locked until finished.

See also:: FileBackend::doOperations()

Parameters:

array	$ops	List of file operations to FileBackend::doOperations()
Status	$status	Status to update on lock/unlock

Returns:: array List of ScopedFileLocks or null values

Since:: 1.20

Reimplemented from FileBackend.

Definition at line 1064 of file FileBackendStore.php.

FileBackendStore::isPathUsableInternal ( $ storagePath ) [abstract]

Check if a file can be created or changed at a given storage path.

FS backends should check if the parent directory exists, files can be written under it, and that any file already there is writable. Backends using key/value stores should check if the container exists.

Parameters:

string $storagePath

Returns:: bool

Reimplemented in FSFileBackend, SwiftFileBackend, and MemoryFileBackend.

FileBackendStore::isSingleShardPathInternal ( $ storagePath ) [final]

Check if a storage path maps to a single shard.

Container dirs like "a", where the container shards on "x/xy", can reside on several shards. Such paths are tricky to handle.

Parameters:

string $storagePath Storage path

Returns:: bool

Definition at line 1495 of file FileBackendStore.php.

static FileBackendStore::isValidContainerName ( $ container ) [static, final, protected]

Check if a container name is valid.

This checks for for length and illegal characters.

Parameters:

string $container

Returns:: bool

Definition at line 1377 of file FileBackendStore.php.

FileBackendStore::maxFileSizeInternal ( ) [final]

Get the maximum allowable file size given backend medium restrictions and basic performance constraints.

Do not call this function from places outside FileBackend and FileOp.

Returns:: int Bytes

Definition at line 84 of file FileBackendStore.php.

FileBackendStore::moveInternal ( array $ params ) [final]

Move a file from one storage path to another in the backend.

This will overwrite any file that exists at the destination. Do not call this function from places outside FileBackend and FileOp.

$params include:

src : source storage path
dst : destination storage path
ignoreMissingSource : do nothing if the source file does not exist
headers : HTTP header name/value map
async : Status will be returned immediately if supported. If the status is OK, then its value field will be set to a FileBackendStoreOpHandle object.
dstExists : Whether a file exists at the destination (optimization). Callers can use "false" if no existing file is being changed.

Parameters:

array $params

Returns:: Status

Definition at line 266 of file FileBackendStore.php.

static FileBackendStore::normalizeXAttributes ( array $ xattr ) [static, final, protected]

Normalize file headers/metadata to the FileBackend::getFileXAttributes() format.

Parameters:

array $xattr

Returns:: array

Since:: 1.22

Definition at line 1778 of file FileBackendStore.php.

FileBackendStore::nullInternal ( array $ params ) [final]

No-op file operation that does nothing.

Do not call this function from places outside FileBackend and FileOp.

Parameters:

array $params

Returns:: Status

Definition at line 341 of file FileBackendStore.php.

FileBackendStore::preloadCache ( array $ paths ) [final]

Preload persistent file stat cache and property cache into in-process cache.

This should be used when stat calls will be made on a known list of a many files.

See also:: FileBackend::getFileStat()

Parameters:

array $paths Storage paths

Reimplemented from FileBackend.

Definition at line 1261 of file FileBackendStore.php.

FileBackendStore::preloadFileStat ( array $ params ) [final]

Preload file stat information (concurrently if possible) into in-process cache.

This should be used when stat calls will be made on a known list of a many files.

See also:: FileBackend::getFileStat()

Parameters:

array

$params

Parameters include:

srcs : list of source storage paths
latest : use the latest available data

Returns:: bool All requests proceeded without I/O errors (since 1.24)

Since:: 1.23

Reimplemented from FileBackend.

Definition at line 1299 of file FileBackendStore.php.

FileBackendStore::primeContainerCache ( array $ items ) [final, protected]

Do a batch lookup from cache for container stats for all containers used in a list of container names or storage paths objects.

This loads the persistent cache values into the process cache.

Parameters:

array $items

Definition at line 1622 of file FileBackendStore.php.

FileBackendStore::primeFileCache ( array $ items ) [final, protected]

Do a batch lookup from cache for file stats for all paths used in a list of storage paths or FileOp objects.

This loads the persistent cache values into the process cache.

Parameters:

array $items List of storage paths

Definition at line 1732 of file FileBackendStore.php.

FileBackendStore::resolveContainerName ( $ container ) [protected]

Resolve a container name, checking if it's allowed by the backend.

This is intended for internal use, such as encoding illegal chars. Subclasses can override this to be more restrictive.

Parameters:

string $container

Returns:: string|null

Definition at line 1565 of file FileBackendStore.php.

FileBackendStore::resolveContainerPath	(	$	container,
		$	relStoragePath
	)		`[protected]`

Resolve a relative storage path, checking if it's allowed by the backend.

This is intended for internal use, such as encoding illegal chars or perhaps getting absolute paths (e.g. FS based backends). Note that the relative path may be the empty string (e.g. the path is simply to the container).

Parameters:

string	$container	Container name
string	$relStoragePath	Storage path relative to the container

Returns:: string|null Path or null if not valid

Reimplemented in SwiftFileBackend, and FSFileBackend.

Definition at line 1579 of file FileBackendStore.php.

FileBackendStore::resolveStoragePath ( $ storagePath ) [final, protected]

Splits a storage path into an internal container name, an internal relative file name, and a container shard suffix.

Any shard suffix is already appended to the internal container name. This also checks that the storage path is valid and within this backend.

If the container is sharded but a suffix could not be determined, this means that the path can only refer to a directory and can only be scanned by looking in all the container shards.

Parameters:

string $storagePath

Returns:: array (container, path, container suffix) or (null, null, null) if invalid

Definition at line 1399 of file FileBackendStore.php.

FileBackendStore::resolveStoragePathReal ( $ storagePath ) [final, protected]

Like resolveStoragePath() except null values are returned if the container is sharded and the shard could not be determined or if the path ends with '/'.

The later case is illegal for FS backends and can confuse listings for object store backends.

This function is used when resolving paths that must be valid locations for files. Directory and listing functions should generally just use resolveStoragePath() instead.

See also:: FileBackendStore::resolveStoragePath()

Parameters:

string $storagePath

Returns:: array (container, path) or (null, null) if invalid

Definition at line 1440 of file FileBackendStore.php.

FileBackendStore::setConcurrencyFlags ( array $ opts ) [final, protected]

Set the 'concurrency' option from a list of operation options.

Parameters:

array $opts Map of operation options

Returns:: array

Definition at line 1798 of file FileBackendStore.php.

FileBackendStore::setContainerCache	(	$	container,
		array $	val
	)		`[final, protected]`

Set the cached info for a container.

Parameters:

string	$container	Resolved container name
array	$val	Information to cache

Definition at line 1599 of file FileBackendStore.php.

FileBackendStore::setFileCache	(	$	path,
		array $	val
	)		`[final, protected]`

Set the cached stat info for a file path.

Negatives (404s) are not cached. By not caching negatives, we can skip cache salting for the case when a file is created at a path were there was none before.

Parameters:

string	$path	Storage path
array	$val	Stat information to cache

Definition at line 1682 of file FileBackendStore.php.

FileBackendStore::storeInternal ( array $ params ) [final]

Store a file into the backend from a file on disk.

This will overwrite any file that exists at the destination. Do not call this function from places outside FileBackend and FileOp.

$params include:

src : source path on disk
dst : destination storage path
headers : HTTP header name/value map
async : Status will be returned immediately if supported. If the status is OK, then its value field will be set to a FileBackendStoreOpHandle object.
dstExists : Whether a file exists at the destination (optimization). Callers can use "false" if no existing file is being changed.

Parameters:

array $params

Returns:: Status

Definition at line 158 of file FileBackendStore.php.

FileBackendStore::streamFile ( array $ params ) [final]

Stream the file at a storage path in the backend.

If the file does not exists, an HTTP 404 error will be given. Appropriate HTTP headers (Status, Content-Type, Content-Length) will be sent if streaming began, while none will be sent otherwise. Implementations should flush the output buffer before sending data.

Parameters:

array

$params

Parameters include:

src : source storage path
headers : list of additional HTTP headers to send on success
latest : use the latest available data

Returns:: Status

Reimplemented from FileBackend.

Definition at line 850 of file FileBackendStore.php.

FileBackendStore::stripInvalidHeadersFromOp ( array $ op ) [protected]

Strip long HTTP headers from a file operation.

Most headers are just numbers, but some are allowed to be long. This function is useful for cleaning up headers and avoiding backend specific errors, especially in the middle of batch file operations.

Parameters:

array $op Same format as doOperation()

Returns:: array

Definition at line 1244 of file FileBackendStore.php.

Member Data Documentation

FileBackendStore::$cheapCache [protected]

Definition at line 41 of file FileBackendStore.php.

FileBackendStore::$expensiveCache [protected]

Definition at line 43 of file FileBackendStore.php.

FileBackendStore::$maxFileSize = 4294967296 [protected]

Definition at line 49 of file FileBackendStore.php.

BagOStuff FileBackendStore::$memCache [protected]

*

Definition at line 39 of file FileBackendStore.php.

callable FileBackendStore::$mimeCallback [protected]

Method to get the MIME type of files *.

Definition at line 47 of file FileBackendStore.php.

array FileBackendStore::$shardViaHashLevels = array() [protected]

Map of container names to sharding config *.

Definition at line 45 of file FileBackendStore.php.

const FileBackendStore::CACHE_CHEAP_SIZE = 500

Definition at line 52 of file FileBackendStore.php.

const FileBackendStore::CACHE_EXPENSIVE_SIZE = 5

Definition at line 53 of file FileBackendStore.php.

const FileBackendStore::CACHE_TTL = 10

Definition at line 51 of file FileBackendStore.php.

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

includes/filebackend/FileBackendStore.php

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation