Class for a file system (FS) based file backend. More...

Inherits Wikimedia\FileBackend\FileBackendStore.

Collaboration diagram for Wikimedia\FileBackend\FSFileBackend:

[legend]

Public Member Functions
	__construct (array $config)

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

	getDirectoryListInternal ( $fullCont, $dirRel, array $params)

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

	getFileListInternal ( $fullCont, $dirRel, array $params)

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

chmod ( $fsPath)

Chmod a file, suppressing the warnings.

cleanPathSlashes ( $fsPath)

Clean up directory separators for the given OS.

containerFSRoot ( $shortCont, $fullCont)

Given the short (unresolved) and full (resolved) name of a container, return the file system path of the container.

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.

doCleanInternal ( $fullCont, $dirRel, array $params)

doClearCache (?array $paths=null)

Clears any additional stat caches for storage paths.

doCopyInternal (array $params)

doCreateInternal (array $params)

doDeleteInternal (array $params)

doDirectoryExists ( $fullCont, $dirRel, array $params)

doExecuteOpHandlesInternal (array $fileOpHandles)

doGetFileStat (array $params)

doGetLocalCopyMulti (array $params)

doGetLocalReferenceMulti (array $params)

doMoveInternal (array $params)

doPrepareInternal ( $fullCont, $dirRel, array $params)

See also: FileBackendStore::doPrepare()

Stability: stable: to override

Parameters

string	$container
string	$dir
array	$params

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

doPublishInternal ( $fullCont, $dirRel, array $params)

doSecureInternal ( $fullCont, $dirRel, array $params)

doStoreInternal (array $params)

getFileNotFoundRegex ()

Get a regex matching file not found errors.

htaccessPrivate ()

Return the text of a .htaccess file to make a directory private.

indexHtmlPrivate ()

Return the text of an index.html file to hide directory listings.

isFileNotFoundError ( $error)

Determine whether a given error message is a file not found error.

isLegalRelPath ( $fsPath)

Check a relative file system path for validity.

newTempFileWithContent (array $params)

resolveContainerPath ( $container, $relStoragePath)

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

resolveToFSPath ( $storagePath)

Get the absolute file system path for a storage path.

rmdir ( $fsDirectory)

Remove an empty directory, suppressing the warnings.

trapWarnings ( $regexIgnore=null)

Listen for E_WARNING errors and track whether any that happen.

trapWarningsIgnoringNotFound ()

Track E_WARNING errors but ignore any that correspond to ENOENT "No such file or directory".

unlink ( $fsPath)

Unlink a file, suppressing the warnings.

untrapWarnings ()

Stop listening for E_WARNING errors and get whether any happened.

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)

doConcatenate (array $params)

doDescribeInternal (array $params)

doGetFileContentsMulti (array $params)

doGetFileSha1Base36 (array $params)

doGetFileStatMulti (array $params)

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

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

doPrimeContainerCache (array $containerInfo)

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

doPublish (array $params)

doQuickOperationsInternal (array $ops, array $opts)

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

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
string null	$basePath
	Directory holding the container directories.

array< string, string >	$containerPaths
	Map of container names to root paths for custom container paths.

string	$currentUser
	OS username running this script.

int	$dirMode
	Directory permission mode.

int	$fileMode
	File permission mode.

string	$fileOwner
	Required OS username to own files.

string	$os
	Simpler version of PHP_OS_FAMILY.

MapCacheLRU	$usableDirCache
	Cache for known prepared/usable directories.

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

Class for a file system (FS) based file backend.

All "containers" each map to a directory under the backend's base directory. For backwards-compatibility, some container paths can be set to custom paths. The domain ID will not be used in any custom paths, so this should be avoided.

Having directories with thousands of files will diminish performance. Sharding can be accomplished by using FileRepo-style hash paths.

StatusValue messages should avoid mentioning the internal FS paths. PHP warnings are assumed to be logged rather than output.

Since: 1.19

Definition at line 74 of file FSFileBackend.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\FileBackend\FSFileBackend::__construct ( array $config )

See also

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

basePath : File system directory that holds containers.
containerPaths : Map of container names to custom file system directories. This should only be used for backwards-compatibility.
fileMode : Octal UNIX file permissions to use on files stored.
directoryMode : Octal UNIX file permissions to use on directories created.

Parameters

array $config

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 109 of file FSFileBackend.php.

Member Function Documentation

◆ addShellboxInputFile()

Wikimedia\FileBackend\FSFileBackend::addShellboxInputFile	(	BoxedCommand	$command,
		string	$boxedName,
		array	$params )

Add a file to a Shellbox command as an input file.

Parameters

BoxedCommand	$command
string	$boxedName
array	$params	Parameters include: src : source storage path latest : use the latest available data

Returns: StatusValue

Since: 1.43

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 775 of file FSFileBackend.php.

References $path, Wikimedia\FileBackend\FileBackend\newStatus(), and Wikimedia\FileBackend\FSFileBackend\resolveToFSPath().

◆ chmod()

Wikimedia\FileBackend\FSFileBackend::chmod ( $fsPath )

protected

Chmod a file, suppressing the warnings.

Parameters

string $fsPath Absolute file system path

Returns: bool Success

Definition at line 914 of file FSFileBackend.php.

References Wikimedia\FileBackend\FSFileBackend\chmod().

Referenced by Wikimedia\FileBackend\FSFileBackend\chmod(), Wikimedia\FileBackend\FSFileBackend\doCopyInternal(), Wikimedia\FileBackend\FSFileBackend\doCreateInternal(), Wikimedia\FileBackend\FSFileBackend\doGetLocalCopyMulti(), and Wikimedia\FileBackend\FSFileBackend\doStoreInternal().

◆ cleanPathSlashes()

Wikimedia\FileBackend\FSFileBackend::cleanPathSlashes ( $fsPath )

protected

Clean up directory separators for the given OS.

Parameters

string $fsPath

Returns: string

Definition at line 999 of file FSFileBackend.php.

◆ containerFSRoot()

Wikimedia\FileBackend\FSFileBackend::containerFSRoot	(		$shortCont,
			$fullCont )

protected

Given the short (unresolved) and full (resolved) name of a container, return the file system path of the container.

Parameters

string	$shortCont
string	$fullCont

Returns: string|null

Definition at line 184 of file FSFileBackend.php.

Referenced by Wikimedia\FileBackend\FSFileBackend\doCleanInternal(), Wikimedia\FileBackend\FSFileBackend\doDirectoryExists(), Wikimedia\FileBackend\FSFileBackend\doPrepareInternal(), Wikimedia\FileBackend\FSFileBackend\doPublishInternal(), Wikimedia\FileBackend\FSFileBackend\doSecureInternal(), Wikimedia\FileBackend\FSFileBackend\getDirectoryListInternal(), Wikimedia\FileBackend\FSFileBackend\getFileListInternal(), and Wikimedia\FileBackend\FSFileBackend\resolveToFSPath().

◆ directoriesAreVirtual()

Wikimedia\FileBackend\FSFileBackend::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 786 of file FSFileBackend.php.

◆ doCleanInternal()

Wikimedia\FileBackend\FSFileBackend::doCleanInternal	(		$container,
			$dir,
		array	$params )

protected

See also: FileBackendStore::doClean()

Stability: stable: to override

Parameters

string	$container
string	$dir
array	$params

Returns: StatusValue

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 584 of file FSFileBackend.php.

References Wikimedia\FileBackend\FSFileBackend\containerFSRoot(), Wikimedia\FileBackend\FileBackend\newStatus(), Wikimedia\FileBackend\FSFileBackend\rmdir(), and Wikimedia\FileBackend\FileBackend\splitStoragePath().

◆ doClearCache()

Wikimedia\FileBackend\FSFileBackend::doClearCache ( ?array $paths = null )

protected

Clears any additional stat caches for storage paths.

Stability: stable: to override

See also: FileBackend::clearCache()

Parameters

string[] | null $paths Storage paths (optional)

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 617 of file FSFileBackend.php.

References $path, and Wikimedia\FileBackend\FSFileBackend\resolveToFSPath().

◆ doCopyInternal()

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

protected

See also: FileBackendStore::copyInternal()

Parameters

array $params

Returns: StatusValue

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 345 of file FSFileBackend.php.

References Wikimedia\FileBackend\FSFileBackend\chmod(), Wikimedia\FileBackend\FileBackend\newStatus(), Wikimedia\FileBackend\FSFileBackend\resolveToFSPath(), Wikimedia\FileBackend\FSFileBackend\trapWarningsIgnoringNotFound(), and Wikimedia\FileBackend\FSFileBackend\untrapWarnings().

◆ doCreateInternal()

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

protected

See also: FileBackendStore::createInternal()

Parameters

array $params

Returns: StatusValue

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 237 of file FSFileBackend.php.

References Wikimedia\FileBackend\FSFileBackend\chmod(), Wikimedia\FileBackend\FileBackend\newStatus(), Wikimedia\FileBackend\FSFileBackend\newTempFileWithContent(), Wikimedia\FileBackend\FSFileBackend\resolveToFSPath(), Wikimedia\FileBackend\FSFileBackend\trapWarningsIgnoringNotFound(), and Wikimedia\FileBackend\FSFileBackend\untrapWarnings().

◆ doDeleteInternal()

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

protected

See also: FileBackendStore::deleteInternal()

Parameters

array $params

Returns: StatusValue

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 458 of file FSFileBackend.php.

References Wikimedia\FileBackend\FileBackend\newStatus(), Wikimedia\FileBackend\FSFileBackend\resolveToFSPath(), Wikimedia\FileBackend\FSFileBackend\trapWarningsIgnoringNotFound(), Wikimedia\FileBackend\FSFileBackend\unlink(), and Wikimedia\FileBackend\FSFileBackend\untrapWarnings().

◆ doDirectoryExists()

Wikimedia\FileBackend\FSFileBackend::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 632 of file FSFileBackend.php.

References Wikimedia\FileBackend\FSFileBackend\containerFSRoot(), Wikimedia\FileBackend\FileBackend\splitStoragePath(), Wikimedia\FileBackend\FSFileBackend\trapWarnings(), and Wikimedia\FileBackend\FSFileBackend\untrapWarnings().

◆ doExecuteOpHandlesInternal()

Wikimedia\FileBackend\FSFileBackend::doExecuteOpHandlesInternal ( array $fileOpHandles )

protected

Parameters

FSFileOpHandle[] $fileOpHandles

Returns: StatusValue[]

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 795 of file FSFileBackend.php.

References Wikimedia\FileBackend\FileBackend\newStatus().

◆ doGetFileStat()

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

protected

See also: FileBackendStore::getFileStat()

Parameters

array $params

Returns: array|false|null

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 595 of file FSFileBackend.php.

References Wikimedia\FileBackend\FSFileBackend\resolveToFSPath(), Wikimedia\FileBackend\FSFileBackend\trapWarnings(), and Wikimedia\FileBackend\FSFileBackend\untrapWarnings().

◆ doGetLocalCopyMulti()

Wikimedia\FileBackend\FSFileBackend::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 738 of file FSFileBackend.php.

References $source, Wikimedia\FileBackend\FSFileBackend\chmod(), Wikimedia\FileBackend\FileBackend\copy(), Wikimedia\FileBackend\FileBackend\extensionFromPath(), Wikimedia\FileBackend\FSFileBackend\resolveToFSPath(), Wikimedia\FileBackend\FSFileBackend\trapWarnings(), and Wikimedia\FileBackend\FSFileBackend\untrapWarnings().

◆ doGetLocalReferenceMulti()

Wikimedia\FileBackend\FSFileBackend::doGetLocalReferenceMulti ( array $params )

protected

See also: FileBackendStore::getLocalReferenceMulti()

Stability: stable: to override

Parameters

array $params

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

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 712 of file FSFileBackend.php.

References $source, Wikimedia\FileBackend\FSFileBackend\resolveToFSPath(), Wikimedia\FileBackend\FSFileBackend\trapWarnings(), and Wikimedia\FileBackend\FSFileBackend\untrapWarnings().

◆ doMoveInternal()

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

protected

See also: FileBackendStore::moveInternal()

Parameters

array $params

Returns: StatusValue

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 409 of file FSFileBackend.php.

References Wikimedia\FileBackend\FileBackend\newStatus(), Wikimedia\FileBackend\FSFileBackend\resolveToFSPath(), Wikimedia\FileBackend\FSFileBackend\trapWarningsIgnoringNotFound(), and Wikimedia\FileBackend\FSFileBackend\untrapWarnings().

◆ doPrepareInternal()

Wikimedia\FileBackend\FSFileBackend::doPrepareInternal	(		$fullCont,
			$dirRel,
		array	$params )

protected

See also: FileBackendStore::doPrepare()

Stability: stable: to override

Parameters

string	$container
string	$dir
array	$params

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

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 496 of file FSFileBackend.php.

References Wikimedia\FileBackend\FSFileBackend\containerFSRoot(), Wikimedia\FileBackend\FSFileBackend\doSecureInternal(), Wikimedia\FileBackend\FileBackend\newStatus(), and Wikimedia\FileBackend\FileBackend\splitStoragePath().

◆ doPublishInternal()

Wikimedia\FileBackend\FSFileBackend::doPublishInternal	(		$container,
			$dir,
		array	$params )

protected

See also: FileBackendStore::doPublish()

Stability: stable: to override

Parameters

string	$container
string	$dir
array	$params

Returns: StatusValue

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 560 of file FSFileBackend.php.

References Wikimedia\FileBackend\FSFileBackend\containerFSRoot(), Wikimedia\FileBackend\FSFileBackend\htaccessPrivate(), Wikimedia\FileBackend\FSFileBackend\indexHtmlPrivate(), Wikimedia\FileBackend\FileBackend\newStatus(), Wikimedia\FileBackend\FileBackend\splitStoragePath(), and Wikimedia\FileBackend\FSFileBackend\unlink().

◆ doSecureInternal()

Wikimedia\FileBackend\FSFileBackend::doSecureInternal	(		$container,
			$dir,
		array	$params )

protected

See also: FileBackendStore::doSecure()

Stability: stable: to override

Parameters

string	$container
string	$dir
array	$params

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

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 532 of file FSFileBackend.php.

References Wikimedia\FileBackend\FSFileBackend\containerFSRoot(), Wikimedia\FileBackend\FSFileBackend\htaccessPrivate(), Wikimedia\FileBackend\FSFileBackend\indexHtmlPrivate(), Wikimedia\FileBackend\FileBackend\newStatus(), Wikimedia\FileBackend\FileBackend\splitStoragePath(), Wikimedia\FileBackend\FSFileBackend\trapWarnings(), and Wikimedia\FileBackend\FSFileBackend\untrapWarnings().

Referenced by Wikimedia\FileBackend\FSFileBackend\doPrepareInternal().

◆ doStoreInternal()

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

protected

See also: FileBackendStore::storeInternal()

Parameters

array $params

Returns: StatusValue

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 289 of file FSFileBackend.php.

References Wikimedia\FileBackend\FSFileBackend\chmod(), Wikimedia\FileBackend\FileBackend\newStatus(), Wikimedia\FileBackend\FSFileBackend\resolveToFSPath(), Wikimedia\FileBackend\FSFileBackend\trapWarningsIgnoringNotFound(), and Wikimedia\FileBackend\FSFileBackend\untrapWarnings().

◆ getDirectoryListInternal()

Wikimedia\FileBackend\FSFileBackend::getDirectoryListInternal	(		$fullCont,
			$dirRel,
		array	$params )

See also: FileBackendStore::getDirectoryListInternal()

Parameters

string	$fullCont
string	$dirRel
array	$params

Returns: array|FSFileBackendDirList|null

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 651 of file FSFileBackend.php.

References Wikimedia\FileBackend\FSFileBackend\containerFSRoot(), Wikimedia\FileBackend\FSFileBackend\isFileNotFoundError(), and Wikimedia\FileBackend\FileBackend\splitStoragePath().

◆ getFeatures()

Wikimedia\FileBackend\FSFileBackend::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 142 of file FSFileBackend.php.

References Wikimedia\FileBackend\FileBackend\ATTR_UNICODE_PATHS.

◆ getFileListInternal()

Wikimedia\FileBackend\FSFileBackend::getFileListInternal	(		$fullCont,
			$dirRel,
		array	$params )

See also: FileBackendStore::getFileListInternal()

Parameters

string	$fullCont
string	$dirRel
array	$params

Returns: array|FSFileBackendFileList|null

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 684 of file FSFileBackend.php.

References Wikimedia\FileBackend\FSFileBackend\containerFSRoot(), Wikimedia\FileBackend\FSFileBackend\isFileNotFoundError(), and Wikimedia\FileBackend\FileBackend\splitStoragePath().

◆ getFileNotFoundRegex()

Wikimedia\FileBackend\FSFileBackend::getFileNotFoundRegex ( )

protected

Get a regex matching file not found errors.

Returns: string

Definition at line 1042 of file FSFileBackend.php.

Referenced by Wikimedia\FileBackend\FSFileBackend\isFileNotFoundError(), and Wikimedia\FileBackend\FSFileBackend\trapWarningsIgnoringNotFound().

◆ htaccessPrivate()

Wikimedia\FileBackend\FSFileBackend::htaccessPrivate ( )

protected

Return the text of a .htaccess file to make a directory private.

Returns: string

Definition at line 989 of file FSFileBackend.php.

Referenced by Wikimedia\FileBackend\FSFileBackend\doPublishInternal(), and Wikimedia\FileBackend\FSFileBackend\doSecureInternal().

◆ indexHtmlPrivate()

Wikimedia\FileBackend\FSFileBackend::indexHtmlPrivate ( )

protected

Return the text of an index.html file to hide directory listings.

Returns: string

Definition at line 980 of file FSFileBackend.php.

Referenced by Wikimedia\FileBackend\FSFileBackend\doPublishInternal(), and Wikimedia\FileBackend\FSFileBackend\doSecureInternal().

◆ isFileNotFoundError()

Wikimedia\FileBackend\FSFileBackend::isFileNotFoundError ( $error )

protected

Determine whether a given error message is a file not found error.

Parameters

string $error

Returns: bool

Definition at line 1068 of file FSFileBackend.php.

References Wikimedia\FileBackend\FSFileBackend\getFileNotFoundRegex().

Referenced by Wikimedia\FileBackend\FSFileBackend\getDirectoryListInternal(), and Wikimedia\FileBackend\FSFileBackend\getFileListInternal().

◆ isLegalRelPath()

Wikimedia\FileBackend\FSFileBackend::isLegalRelPath ( $fsPath )

protected

Check a relative file system path for validity.

Parameters

string $fsPath Normalized relative path

Returns: bool

Definition at line 164 of file FSFileBackend.php.

Referenced by Wikimedia\FileBackend\FSFileBackend\resolveContainerPath().

◆ isPathUsableInternal()

Wikimedia\FileBackend\FSFileBackend::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 214 of file FSFileBackend.php.

References Wikimedia\FileBackend\FSFileBackend\resolveToFSPath().

◆ newTempFileWithContent()

Wikimedia\FileBackend\FSFileBackend::newTempFileWithContent ( array $params )

protected

Parameters

array $params Parameters for FileBackend 'create' operation

Returns: TempFSFile|null

Definition at line 960 of file FSFileBackend.php.

Referenced by Wikimedia\FileBackend\FSFileBackend\doCreateInternal().

◆ resolveContainerPath()

Wikimedia\FileBackend\FSFileBackend::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).

Stability: stable: to override

Parameters

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

Returns: string|null Path or null if not valid

Reimplemented from Wikimedia\FileBackend\FileBackendStore.

Definition at line 146 of file FSFileBackend.php.

References Wikimedia\FileBackend\FSFileBackend\isLegalRelPath().

◆ resolveToFSPath()

Wikimedia\FileBackend\FSFileBackend::resolveToFSPath ( $storagePath )

protected

Get the absolute file system path for a storage path.

Parameters

string $storagePath

Returns: string|null

Definition at line 200 of file FSFileBackend.php.

References Wikimedia\FileBackend\FSFileBackend\containerFSRoot(), Wikimedia\FileBackend\FileBackendStore\resolveStoragePathReal(), and Wikimedia\FileBackend\FileBackend\splitStoragePath().

◆ rmdir()

Wikimedia\FileBackend\FSFileBackend::rmdir ( $fsDirectory )

protected

Remove an empty directory, suppressing the warnings.

Parameters

string $fsDirectory Absolute file system path

Returns: bool Success

Definition at line 947 of file FSFileBackend.php.

References Wikimedia\FileBackend\FSFileBackend\rmdir().

Referenced by Wikimedia\FileBackend\FSFileBackend\doCleanInternal(), and Wikimedia\FileBackend\FSFileBackend\rmdir().

◆ trapWarnings()

Wikimedia\FileBackend\FSFileBackend::trapWarnings ( $regexIgnore = null )

protected

Listen for E_WARNING errors and track whether any that happen.

Parameters

string | null $regexIgnore Optional regex of errors to ignore

Definition at line 1008 of file FSFileBackend.php.

Referenced by Wikimedia\FileBackend\FSFileBackend\doDirectoryExists(), Wikimedia\FileBackend\FSFileBackend\doGetFileStat(), Wikimedia\FileBackend\FSFileBackend\doGetLocalCopyMulti(), Wikimedia\FileBackend\FSFileBackend\doGetLocalReferenceMulti(), Wikimedia\FileBackend\FSFileBackend\doSecureInternal(), and Wikimedia\FileBackend\FSFileBackend\trapWarningsIgnoringNotFound().

◆ trapWarningsIgnoringNotFound()

Wikimedia\FileBackend\FSFileBackend::trapWarningsIgnoringNotFound ( )

protected

Track E_WARNING errors but ignore any that correspond to ENOENT "No such file or directory".

Definition at line 1022 of file FSFileBackend.php.

References Wikimedia\FileBackend\FSFileBackend\getFileNotFoundRegex(), and Wikimedia\FileBackend\FSFileBackend\trapWarnings().

Referenced by Wikimedia\FileBackend\FSFileBackend\doCopyInternal(), Wikimedia\FileBackend\FSFileBackend\doCreateInternal(), Wikimedia\FileBackend\FSFileBackend\doDeleteInternal(), Wikimedia\FileBackend\FSFileBackend\doMoveInternal(), and Wikimedia\FileBackend\FSFileBackend\doStoreInternal().

◆ unlink()

Wikimedia\FileBackend\FSFileBackend::unlink ( $fsPath )

protected

Unlink a file, suppressing the warnings.

Parameters

string $fsPath Absolute file system path

Returns: bool Success

Definition at line 932 of file FSFileBackend.php.

References Wikimedia\FileBackend\FSFileBackend\unlink().

Referenced by Wikimedia\FileBackend\FSFileBackend\doDeleteInternal(), Wikimedia\FileBackend\FSFileBackend\doPublishInternal(), and Wikimedia\FileBackend\FSFileBackend\unlink().

◆ untrapWarnings()

Wikimedia\FileBackend\FSFileBackend::untrapWarnings ( )

protected

Stop listening for E_WARNING errors and get whether any happened.

Returns: bool Whether any warnings happened

Definition at line 1031 of file FSFileBackend.php.

Member Data Documentation

◆ $basePath

string null Wikimedia\FileBackend\FSFileBackend::$basePath

protected

Directory holding the container directories.

Definition at line 79 of file FSFileBackend.php.

◆ $containerPaths

array<string,string> Wikimedia\FileBackend\FSFileBackend::$containerPaths

protected

Map of container names to root paths for custom container paths.

Definition at line 82 of file FSFileBackend.php.

◆ $currentUser

string Wikimedia\FileBackend\FSFileBackend::$currentUser

protected

OS username running this script.

Definition at line 94 of file FSFileBackend.php.

◆ $dirMode

int Wikimedia\FileBackend\FSFileBackend::$dirMode

protected

Directory permission mode.

Definition at line 85 of file FSFileBackend.php.

◆ $fileMode

int Wikimedia\FileBackend\FSFileBackend::$fileMode

protected

File permission mode.

Definition at line 87 of file FSFileBackend.php.

◆ $fileOwner

string Wikimedia\FileBackend\FSFileBackend::$fileOwner

protected

Required OS username to own files.

Definition at line 89 of file FSFileBackend.php.

◆ $os

string Wikimedia\FileBackend\FSFileBackend::$os

protected

Simpler version of PHP_OS_FAMILY.

Definition at line 92 of file FSFileBackend.php.

◆ $usableDirCache

MapCacheLRU Wikimedia\FileBackend\FSFileBackend::$usableDirCache

protected

Cache for known prepared/usable directories.

Definition at line 76 of file FSFileBackend.php.

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

includes/libs/filebackend/FSFileBackend.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addShellboxInputFile()

◆ chmod()

◆ cleanPathSlashes()

◆ containerFSRoot()

◆ directoriesAreVirtual()

◆ doCleanInternal()

◆ doClearCache()

◆ doCopyInternal()

◆ doCreateInternal()

◆ doDeleteInternal()

◆ doDirectoryExists()

◆ doExecuteOpHandlesInternal()

◆ doGetFileStat()

◆ doGetLocalCopyMulti()

◆ doGetLocalReferenceMulti()

◆ doMoveInternal()

◆ doPrepareInternal()

◆ doPublishInternal()

◆ doSecureInternal()

◆ doStoreInternal()

◆ getDirectoryListInternal()

◆ getFeatures()

◆ getFileListInternal()

◆ getFileNotFoundRegex()

◆ htaccessPrivate()

◆ indexHtmlPrivate()

◆ isFileNotFoundError()

◆ isLegalRelPath()

◆ isPathUsableInternal()

◆ newTempFileWithContent()

◆ resolveContainerPath()

◆ resolveToFSPath()

◆ rmdir()

◆ trapWarnings()

◆ trapWarningsIgnoringNotFound()

◆ unlink()

◆ untrapWarnings()

Member Data Documentation

◆ $basePath

◆ $containerPaths

◆ $currentUser

◆ $dirMode

◆ $fileMode

◆ $fileOwner

◆ $os

◆ $usableDirCache