Simulation of a backend storage in memory. More...

Inherits Wikimedia\FileBackend\FileBackendStore.

Collaboration diagram for Wikimedia\FileBackend\MemoryFileBackend:

[legend]

Public Member Functions
	getDirectoryListInternal ( $container, $dir, array $params)
	Do not call this function from places outside FileBackend.

	getFeatures ()
	Get the a bitfield of extra features supported by the backend medium.

	getFileListInternal ( $container, $dir, array $params)
	Do not call this function from places outside FileBackend.

	isPathUsableInternal ( $storagePath)
	Check if a file can be created or changed at a given storage path in the backend.

Public Member Functions inherited from Wikimedia\FileBackend\FileBackendStore
	__construct (array $config)

	addShellboxInputFile (BoxedCommand $command, string $boxedName, array $params)
	Add a file to a Shellbox command as an input file.

	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.

	getFileContentsMulti (array $params)
	Like getFileContents() except it takes an array of storage paths and returns an order preserved map of storage paths to their content.

	getFileHttpUrl (array $params)

	getFileList (array $params)
	Get an iterator to list all stored files under a storage directory.

	getFileProps (array $params)
	Get the properties of the content of the file at a storage path in the backend.

	getFileSha1Base36 (array $params)
	Get a SHA-1 hash of the content 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 yields an order preserved-map of storage paths to temporary local file copies.

	getLocalReferenceMulti (array $params)
	Like getLocalReference() except it takes an array of storage paths and yields an order-preserved map of storage paths to temporary local file copies.

	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, StatusValue $status)
	Get an array of scoped locks needed for a batch of file operations.

	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 content of the file at a storage path in the backend.

Public Member Functions inherited from Wikimedia\FileBackend\FileBackend
	clean (array $params)
	Delete a storage directory if it is empty.

	copy (array $params, array $opts=[])
	Performs a single copy operation.

	create (array $params, array $opts=[])
	Performs a single create operation.

	delete (array $params, array $opts=[])
	Performs a single delete operation.

	describe (array $params, array $opts=[])
	Performs a single describe operation.

	doOperation (array $op, array $opts=[])
	Same as doOperations() except it takes a single operation.

	doOperations (array $ops, array $opts=[])
	This is the main entry point into the backend for write operations.

	doQuickOperation (array $op, array $opts=[])
	Same as doQuickOperations() except it takes a single operation.

	doQuickOperations (array $ops, array $opts=[])
	Perform a set of independent file operations on some files.

	getContainerStoragePath ( $container)
	Get the storage path for the given container for this backend.

	getDomainId ()
	Get the domain identifier used for this backend (possibly empty).

	getFileContents (array $params)
	Get the contents of a file at a storage path in the backend.

	getLocalCopy (array $params)
	Get a local copy on disk of the file at a storage path in the backend.

	getLocalReference (array $params)
	Returns a file system file, identical in content to the file at a storage path.

	getName ()
	Get the unique backend name.

	getReadOnlyReason ()
	Get an explanatory message if this backend is read-only.

	getRootStoragePath ()
	Get the root storage path of this backend.

	getScopedFileLocks (array $paths, $type, StatusValue $status, $timeout=0)
	Lock the files at the given storage paths in the backend.

	getStreamerOptions ()
	Return options for use with HTTPFileStreamer.

	getTopDirectoryList (array $params)
	Same as FileBackend::getDirectoryList() except only lists directories that are immediately under the given directory.

	getTopFileList (array $params)
	Same as FileBackend::getFileList() except only lists files that are immediately under the given directory.

	getWikiId ()
	Alias to getDomainId()

	hasFeatures ( $bitfield)
	Check if the backend medium supports a field of extra features.

	isReadOnly ()
	Check if this backend is read-only.

	lockFiles (array $paths, $type, $timeout=0)
	Lock the files at the given storage paths in the backend.

	move (array $params, array $opts=[])
	Performs a single move operation.

	prepare (array $params)
	Prepare a storage directory for usage.

	publish (array $params)
	Remove measures to block web access to a storage directory and the container it belongs to.

	quickCopy (array $params, array $opts=[])
	Performs a single quick copy operation.

	quickCreate (array $params, array $opts=[])
	Performs a single quick create operation.

	quickDelete (array $params, array $opts=[])
	Performs a single quick delete operation.

	quickDescribe (array $params, array $opts=[])
	Performs a single quick describe operation.

	quickMove (array $params, array $opts=[])
	Performs a single quick move operation.

	quickStore (array $params, array $opts=[])
	Performs a single quick store operation.

	secure (array $params)
	Take measures to block web access to a storage directory and the container it belongs to.

	setLogger (LoggerInterface $logger)

	store (array $params, array $opts=[])
	Performs a single store operation.

	unlockFiles (array $paths, $type)
	Unlock the files at the given storage paths in the backend.

Protected Member Functions

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.

doCopyInternal (array $params)

doCreateInternal (array $params)

doDeleteInternal (array $params)

doDirectoryExists ( $container, $dir, array $params)

doGetFileStat (array $params)

doGetLocalCopyMulti (array $params)

doMoveInternal (array $params)

doStoreInternal (array $params)

resolveHashKey ( $storagePath)

Get the absolute file system path for a storage path.

Protected Member Functions inherited from Wikimedia\FileBackend\FileBackendStore

deleteContainerCache ( $container)

Delete the cached info for a container.

deleteFileCache ( $path)

Delete the cached stat info for a file path.

doClean (array $params)

doCleanInternal ( $container, $dir, array $params)

doClearCache (?array $paths=null)

Clears any additional stat caches for storage paths.

doConcatenate (array $params)

doDescribeInternal (array $params)

doExecuteOpHandlesInternal (array $fileOpHandles)

doGetFileContentsMulti (array $params)

doGetFileSha1Base36 (array $params)

doGetFileStatMulti (array $params)

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

doGetFileXAttributes (array $params)

doGetLocalReferenceMulti (array $params)

doOperationsInternal (array $ops, array $opts)

doPrepare (array $params)

See also: FileBackend::prepare()

Parameters

array $params

Returns: StatusValue Good status without value for success, fatal otherwise.

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, array $opts)

doSecure (array $params)

doSecureInternal ( $container, $dir, array $params)

doStreamFile (array $params)

fullContainerName ( $container)

Get the full container name, including the domain 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.

ingestFreshFileStats (array $stats, $latest)

Ingest file stat entries that just came from querying the backend (not cache)

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

sanitizeOpHeaders (array $op)

Normalize and filter HTTP headers from a file operation.

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.

Protected Member Functions inherited from Wikimedia\FileBackend\FileBackend

callNowOrLater (callable $update)

header ( $header)

newStatus ( $message=null,... $params)

Yields the result of the status wrapper callback on either:

resetOutputBuffer ()

resolveFSFileObjects (array $ops)

Convert FSFile 'src' paths to string paths (with an 'srcRef' field set to the FSFile)

scopedProfileSection ( $section)

wrapStatus (StatusValue $sv)

Protected Attributes
array	$files = []
	Map of (file path => (data,mtime)

Protected Attributes inherited from Wikimedia\FileBackend\FileBackendStore
MapCacheLRU	$cheapCache
	Map of paths to small (RAM/disk) cache items.

MapCacheLRU	$expensiveCache
	Map of paths to large (RAM/disk) cache items.

int	$maxFileSize = 32 * 1024 * 1024 * 1024
	Size in bytes, defaults to 32 GiB.

WANObjectCache	$memCache

callable null	$mimeCallback
	Method to get the MIME type of files.

array< string, array >	$shardViaHashLevels = []
	Map of container names to sharding config.

BagOStuff	$srvCache

const	CACHE_CHEAP_SIZE = 500

const	CACHE_EXPENSIVE_SIZE = 5

const	CACHE_TTL = 10

Protected Attributes inherited from Wikimedia\FileBackend\FileBackend
int	$concurrency
	How many operations can be done in parallel.

string	$domainId
	Unique domain name.

LockManager	$lockManager

LoggerInterface	$logger

string	$name
	Unique backend name.

string	$parallelize
	When to do operations in parallel.

callable null	$profiler

string	$readOnly
	Read-only explanation message.

callable null	$statusWrapper

array	$streamerOptions
	Option map for use with HTTPFileStreamer.

TempFSFileFactory	$tmpFileFactory

Additional Inherited Members
Static Public Member Functions inherited from Wikimedia\FileBackend\FileBackend
static	extensionFromPath ( $path, $case='lowercase')
	Get the final extension from a storage or FS path.

static	isPathTraversalFree ( $path)
	Check if a relative path has no directory traversals.

static	isStoragePath ( $path)
	Check if a given path is a "mwstore://" path.

static	makeContentDisposition ( $type, $filename='')
	Build a Content-Disposition header value per RFC 6266.

static	normalizeStoragePath ( $storagePath)
	Normalize a storage path by cleaning up directory separators.

static	parentStoragePath ( $storagePath)
	Get the parent storage directory of a storage path.

static	resetOutputBufferTheDefaultWay ()
	Default behavior of resetOutputBuffer().

static	splitStoragePath ( $storagePath)
	Split a storage path into a backend name, a container name, and a relative file path.

Public Attributes inherited from Wikimedia\FileBackend\FileBackend
const	ATTR_HEADERS = 1
	Bitfield flags for supported features.

const	ATTR_METADATA = 2

const	ATTR_UNICODE_PATHS = 4

Static Protected Member Functions inherited from Wikimedia\FileBackend\FileBackendStore
static	isValidContainerName ( $container)
	Check if a full container name is valid.

static	isValidShortContainerName ( $container)
	Check if a short container name is valid.

static	normalizeXAttributes (array $xattr)
	Normalize file headers/metadata to the FileBackend::getFileXAttributes() format.

Static Protected Member Functions inherited from Wikimedia\FileBackend\FileBackend
static	normalizeContainerPath ( $path)
	Validate and normalize a relative storage path.

Detailed Description

Simulation of a backend storage in memory.

All data in the backend is automatically deleted at the end of PHP execution. Since the data stored here is volatile, this is only useful for staging or testing.

Since: 1.23

Definition at line 38 of file MemoryFileBackend.php.

Member Function Documentation

◆ directoriesAreVirtual()

Wikimedia\FileBackend\MemoryFileBackend::directoriesAreVirtual ( )

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 from Wikimedia\FileBackend\FileBackendStore.

Definition at line 283 of file MemoryFileBackend.php.

◆ doCopyInternal()

Wikimedia\FileBackend\MemoryFileBackend::doCopyInternal ( array $params )

protected

See also: FileBackendStore::copyInternal()

Parameters

array $params

Returns: StatusValue

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 95 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\FileBackend\newStatus(), and Wikimedia\FileBackend\MemoryFileBackend\resolveHashKey().

◆ doCreateInternal()

Wikimedia\FileBackend\MemoryFileBackend::doCreateInternal ( array $params )

protected

See also: FileBackendStore::createInternal()

Parameters

array $params

Returns: StatusValue

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 50 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\FileBackend\newStatus(), and Wikimedia\FileBackend\MemoryFileBackend\resolveHashKey().

◆ doDeleteInternal()

Wikimedia\FileBackend\MemoryFileBackend::doDeleteInternal ( array $params )

protected

See also: FileBackendStore::deleteInternal()

Parameters

array $params

Returns: StatusValue

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 160 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\FileBackend\newStatus(), and Wikimedia\FileBackend\MemoryFileBackend\resolveHashKey().

◆ doDirectoryExists()

Wikimedia\FileBackend\MemoryFileBackend::doDirectoryExists	(		$container,
			$dir,
		array	$params )

protected

See also: FileBackendStore::directoryExists()

Parameters

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

Returns: bool|null

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 224 of file MemoryFileBackend.php.

References $path.

◆ doGetFileStat()

Wikimedia\FileBackend\MemoryFileBackend::doGetFileStat ( array $params )

protected

See also: FileBackendStore::getFileStat()

Parameters

array $params

Returns: array|false|null

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 183 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\MemoryFileBackend\resolveHashKey().

◆ doGetLocalCopyMulti()

Wikimedia\FileBackend\MemoryFileBackend::doGetLocalCopyMulti ( array $params )

protected

See also: FileBackendStore::getLocalCopyMulti()

Parameters

array $params

Returns: string[]|bool[]|null[] Map of (path => TempFSFile, false (missing), or null (error))

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 199 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\FileBackend\extensionFromPath(), and Wikimedia\FileBackend\MemoryFileBackend\resolveHashKey().

◆ doMoveInternal()

Wikimedia\FileBackend\MemoryFileBackend::doMoveInternal ( array $params )

protected

See also: FileBackendStore::moveInternal()

Parameters

array $params

Returns: StatusValue

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 128 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\FileBackend\newStatus(), and Wikimedia\FileBackend\MemoryFileBackend\resolveHashKey().

◆ doStoreInternal()

Wikimedia\FileBackend\MemoryFileBackend::doStoreInternal ( array $params )

protected

See also: FileBackendStore::storeInternal()

Parameters

array $params

Returns: StatusValue

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 68 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\FileBackend\newStatus(), and Wikimedia\FileBackend\MemoryFileBackend\resolveHashKey().

◆ getDirectoryListInternal()

Wikimedia\FileBackend\MemoryFileBackend::getDirectoryListInternal	(		$container,
			$dir,
		array	$params )

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 Iterable list or null (error)

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 235 of file MemoryFileBackend.php.

References $path.

◆ getFeatures()

Wikimedia\FileBackend\MemoryFileBackend::getFeatures ( )

Get the a bitfield of extra features supported by the backend medium.

Stability: stable: to override

Returns: int Bitfield of FileBackend::ATTR_* flags

Since: 1.23

Reimplemented from Wikimedia\FileBackend\FileBackend.

Definition at line 42 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\FileBackend\ATTR_UNICODE_PATHS.

◆ getFileListInternal()

Wikimedia\FileBackend\MemoryFileBackend::getFileListInternal	(		$container,
			$dir,
		array	$params )

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|string[]|null Iterable list or null (error)

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 264 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\MemoryFileBackend\$files, and $path.

◆ isPathUsableInternal()

Wikimedia\FileBackend\MemoryFileBackend::isPathUsableInternal ( $storagePath )

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

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

Parameters

string $storagePath

Returns: bool

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 46 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\MemoryFileBackend\resolveHashKey().

◆ resolveHashKey()

Wikimedia\FileBackend\MemoryFileBackend::resolveHashKey ( $storagePath )

protected

Get the absolute file system path for a storage path.

Parameters

string $storagePath

Returns: string|null

Definition at line 293 of file MemoryFileBackend.php.

References Wikimedia\FileBackend\FileBackendStore\resolveStoragePathReal().

Referenced by Wikimedia\FileBackend\MemoryFileBackend\doCopyInternal(), Wikimedia\FileBackend\MemoryFileBackend\doCreateInternal(), Wikimedia\FileBackend\MemoryFileBackend\doDeleteInternal(), Wikimedia\FileBackend\MemoryFileBackend\doGetFileStat(), Wikimedia\FileBackend\MemoryFileBackend\doGetLocalCopyMulti(), Wikimedia\FileBackend\MemoryFileBackend\doMoveInternal(), Wikimedia\FileBackend\MemoryFileBackend\doStoreInternal(), and Wikimedia\FileBackend\MemoryFileBackend\isPathUsableInternal().

Member Data Documentation

◆ $files

array Wikimedia\FileBackend\MemoryFileBackend::$files = []

protected

Map of (file path => (data,mtime)

Definition at line 40 of file MemoryFileBackend.php.

Referenced by Wikimedia\FileBackend\MemoryFileBackend\getFileListInternal().

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

includes/libs/filebackend/MemoryFileBackend.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ directoriesAreVirtual()

◆ doCopyInternal()

◆ doCreateInternal()

◆ doDeleteInternal()

◆ doDirectoryExists()

◆ doGetFileStat()

◆ doGetLocalCopyMulti()

◆ doMoveInternal()

◆ doStoreInternal()

◆ getDirectoryListInternal()

◆ getFeatures()

◆ getFileListInternal()

◆ isPathUsableInternal()

◆ resolveHashKey()

Member Data Documentation

◆ $files