MediaWiki  1.28.0
FileBackendStore Class Reference

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)
 
 concatenate (array $params)
 
 copyInternal (array $params)
 Copy a file from one storage path to another in the backend. More...
 
 createInternal (array $params)
 Create a file in the backend with the given contents. More...
 
 deleteInternal (array $params)
 Delete a file at the storage path. More...
 
 describeInternal (array $params)
 Alter metadata for a file at the storage path. More...
 
 directoryExists (array $params)
 
 executeOpHandlesInternal (array $fileOpHandles)
 Execute a list of FileBackendStoreOpHandle handles in parallel. More...
 
 fileExists (array $params)
 
 getDirectoryList (array $params)
 
 getDirectoryListInternal ($container, $dir, array $params)
 Do not call this function from places outside FileBackend. More...
 
 getFileContentsMulti (array $params)
 
 getFileHttpUrl (array $params)
 
 getFileList (array $params)
 
 getFileListInternal ($container, $dir, array $params)
 Do not call this function from places outside FileBackend. More...
 
 getFileProps (array $params)
 
 getFileSha1Base36 (array $params)
 
 getFileSize (array $params)
 
 getFileStat (array $params)
 
 getFileTimestamp (array $params)
 
 getFileXAttributes (array $params)
 
 getLocalCopyMulti (array $params)
 
 getLocalReferenceMulti (array $params)
 
 getOperationsInternal (array $ops)
 Return a list of FileOp objects from a list of operations. More...
 
 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. More...
 
 getScopedLocksForOps (array $ops, StatusValue $status)
 
 isPathUsableInternal ($storagePath)
 Check if a file can be created or changed at a given storage path. More...
 
 isSingleShardPathInternal ($storagePath)
 Check if a storage path maps to a single shard. More...
 
 maxFileSizeInternal ()
 Get the maximum allowable file size given backend medium restrictions and basic performance constraints. More...
 
 moveInternal (array $params)
 Move a file from one storage path to another in the backend. More...
 
 nullInternal (array $params)
 No-op file operation that does nothing. More...
 
 preloadCache (array $paths)
 
 preloadFileStat (array $params)
 
 storeInternal (array $params)
 Store a file into the backend from a file on disk. More...
 
 streamFile (array $params)
 
- Public Member Functions inherited from FileBackend
 __construct (array $config)
 Create a new backend instance from configuration. More...
 
 clean (array $params)
 Delete a storage directory if it is empty. More...
 
 clearCache (array $paths=null)
 Invalidate any in-process file stat and property cache. More...
 
 concatenate (array $params)
 Concatenate a list of storage files into a single file system file. More...
 
 copy (array $params, array $opts=[])
 Performs a single copy operation. More...
 
 create (array $params, array $opts=[])
 Performs a single create operation. More...
 
 delete (array $params, array $opts=[])
 Performs a single delete operation. More...
 
 describe (array $params, array $opts=[])
 Performs a single describe operation. More...
 
 directoryExists (array $params)
 Check if a directory exists at a given storage path. More...
 
 doOperation (array $op, array $opts=[])
 Same as doOperations() except it takes a single operation. More...
 
 doOperations (array $ops, array $opts=[])
 This is the main entry point into the backend for write operations. More...
 
 doQuickOperation (array $op)
 Same as doQuickOperations() except it takes a single operation. More...
 
 doQuickOperations (array $ops, array $opts=[])
 Perform a set of independent file operations on some files. More...
 
 fileExists (array $params)
 Check if a file exists at a storage path in the backend. More...
 
 getContainerStoragePath ($container)
 Get the storage path for the given container for this backend. More...
 
 getDirectoryList (array $params)
 Get an iterator to list all directories under a storage directory. More...
 
 getDomainId ()
 Get the domain identifier used for this backend (possibly empty). More...
 
 getFeatures ()
 Get the a bitfield of extra features supported by the backend medium. More...
 
 getFileContents (array $params)
 Get the contents of a file at a storage path in the backend. More...
 
 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). More...
 
 getFileHttpUrl (array $params)
 Return an HTTP URL to a given file that requires no authentication to use. More...
 
 getFileList (array $params)
 Get an iterator to list all stored files under a storage directory. More...
 
 getFileProps (array $params)
 Get the properties of the file at a storage path in the backend. More...
 
 getFileSha1Base36 (array $params)
 Get a SHA-1 hash of the file at a storage path in the backend. More...
 
 getFileSize (array $params)
 Get the size (bytes) of a file at a storage path in the backend. More...
 
 getFileStat (array $params)
 Get quick information about a file at a storage path in the backend. More...
 
 getFileTimestamp (array $params)
 Get the last-modified timestamp of the file at a storage path. More...
 
 getFileXAttributes (array $params)
 Get metadata about a file at a storage path in the backend. More...
 
 getJournal ()
 Get the file journal object for this backend. More...
 
 getLocalCopy (array $params)
 Get a local copy on disk of the file at a storage path in the backend. More...
 
 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). More...
 
 getLocalReference (array $params)
 Returns a file system file, identical to the file at a storage path. More...
 
 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). More...
 
 getName ()
 Get the unique backend name. More...
 
 getReadOnlyReason ()
 Get an explanatory message if this backend is read-only. More...
 
 getRootStoragePath ()
 Get the root storage path of this backend. More...
 
 getScopedFileLocks (array $paths, $type, StatusValue $status, $timeout=0)
 Lock the files at the given storage paths in the backend. More...
 
 getScopedLocksForOps (array $ops, StatusValue $status)
 Get an array of scoped locks needed for a batch of file operations. More...
 
 getTopDirectoryList (array $params)
 Same as FileBackend::getDirectoryList() except only lists directories that are immediately under the given directory. More...
 
 getTopFileList (array $params)
 Same as FileBackend::getFileList() except only lists files that are immediately under the given directory. More...
 
 getWikiId ()
 Alias to getDomainId() More...
 
 hasFeatures ($bitfield)
 Check if the backend medium supports a field of extra features. More...
 
 isReadOnly ()
 Check if this backend is read-only. More...
 
 lockFiles (array $paths, $type, $timeout=0)
 Lock the files at the given storage paths in the backend. More...
 
 move (array $params, array $opts=[])
 Performs a single move operation. More...
 
 preloadCache (array $paths)
 Preload persistent file stat cache and property cache into in-process cache. More...
 
 preloadFileStat (array $params)
 Preload file stat information (concurrently if possible) into in-process cache. More...
 
 prepare (array $params)
 Prepare a storage directory for usage. More...
 
 publish (array $params)
 Remove measures to block web access to a storage directory and the container it belongs to. More...
 
 quickCopy (array $params)
 Performs a single quick copy operation. More...
 
 quickCreate (array $params)
 Performs a single quick create operation. More...
 
 quickDelete (array $params)
 Performs a single quick delete operation. More...
 
 quickDescribe (array $params)
 Performs a single quick describe operation. More...
 
 quickMove (array $params)
 Performs a single quick move operation. More...
 
 quickStore (array $params)
 Performs a single quick store operation. More...
 
 secure (array $params)
 Take measures to block web access to a storage directory and the container it belongs to. More...
 
 setLogger (LoggerInterface $logger)
 
 store (array $params, array $opts=[])
 Performs a single store operation. More...
 
 streamFile (array $params)
 Stream the file at a storage path in the backend. More...
 
 unlockFiles (array $paths, $type)
 Unlock the files at the given storage paths in the backend. More...
 

Public Attributes

const CACHE_CHEAP_SIZE = 500
 
const CACHE_EXPENSIVE_SIZE = 5
 
const CACHE_TTL = 10
 
- Public Attributes inherited from FileBackend
const ATTR_HEADERS = 1
 Bitfield flags for supported features. More...
 
const ATTR_METADATA = 2
 
const ATTR_UNICODE_PATHS = 4
 

Protected Member Functions

 deleteContainerCache ($container)
 Delete the cached info for a container. More...
 
 deleteFileCache ($path)
 Delete the cached stat info for a file path. More...
 
 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. More...
 
 doClean (array $params)
 
 doCleanInternal ($container, $dir, array $params)
 
 doClearCache (array $paths=null)
 Clears any additional stat caches for storage paths. More...
 
 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. More...
 
 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. More...
 
 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. More...
 
 getContainerHashLevels ($container)
 Get the sharding config for a container. More...
 
 getContainerShard ($container, $relPath)
 Get the container name shard suffix for a given path. More...
 
 getContainerSuffixes ($container)
 Get a list of full container shard suffixes for a container. More...
 
 getContentType ($storagePath, $content, $fsPath)
 Get the content type to use in HEAD/GET requests for a file. More...
 
 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. More...
 
 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. More...
 
 resolveContainerName ($container)
 Resolve a container name, checking if it's allowed by the backend. More...
 
 resolveContainerPath ($container, $relStoragePath)
 Resolve a relative storage path, checking if it's allowed by the backend. More...
 
 resolveStoragePath ($storagePath)
 Splits a storage path into an internal container name, an internal relative file name, and a container shard suffix. More...
 
 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 '/'. More...
 
 sanitizeOpHeaders (array $op)
 Normalize and filter HTTP headers from a file operation. More...
 
 setConcurrencyFlags (array $opts)
 Set the 'concurrency' option from a list of operation options. More...
 
 setContainerCache ($container, array $val)
 Set the cached info for a container. More...
 
 setFileCache ($path, array $val)
 Set the cached stat info for a file path. More...
 
- Protected Member Functions inherited from FileBackend
 doClean (array $params)
 
 doOperationsInternal (array $ops, array $opts)
 
 doPrepare (array $params)
 
 doPublish (array $params)
 
 doQuickOperationsInternal (array $ops)
 
 doSecure (array $params)
 
 getScopedPHPBehaviorForOps ()
 Enter file operation scope. More...
 
 newStatus ()
 Yields the result of the status wrapper callback on either: More...
 
 resetOutputBuffer ()
 
 resolveFSFileObjects (array $ops)
 Convert FSFile 'src' paths to string paths (with an 'srcRef' field set to the FSFile) More...
 
 scopedProfileSection ($section)
 
 wrapStatus (StatusValue $sv)
 

Static Protected Member Functions

static isValidContainerName ($container)
 Check if a full container name is valid. More...
 
static isValidShortContainerName ($container)
 Check if a short container name is valid. More...
 
static normalizeXAttributes (array $xattr)
 Normalize file headers/metadata to the FileBackend::getFileXAttributes() format. More...
 
- Static Protected Member Functions inherited from FileBackend
static normalizeContainerPath ($path)
 Validate and normalize a relative storage path. More...
 

Protected Attributes

ProcessCacheLRU $cheapCache
 Map of paths to small (RAM/disk) cache items. More...
 
ProcessCacheLRU $expensiveCache
 Map of paths to large (RAM/disk) cache items. More...
 
 $maxFileSize = 4294967296
 
WANObjectCache $memCache
 
callable $mimeCallback
 Method to get the MIME type of files. More...
 
array $shardViaHashLevels = []
 Map of container names to sharding config. More...
 
BagOStuff $srvCache
 
- Protected Attributes inherited from FileBackend
int $concurrency
 How many operations can be done in parallel. More...
 
string $domainId
 Unique domain name. More...
 
FileJournal $fileJournal
 
LockManager $lockManager
 
LoggerInterface $logger
 
string $name
 Unique backend name. More...
 
callable $obResetFunc
 
string $parallelize
 When to do operations in parallel. More...
 
object string $profiler
 Class name or object With profileIn/profileOut methods. More...
 
string $readOnly
 Read-only explanation message. More...
 
callable $statusWrapper
 
callable $streamMimeFunc
 
string $tmpDirectory
 Temporary file directory. More...
 

Private Member Functions

 containerCacheKey ($container)
 Get the cache key for a container. More...
 
 fileCacheKey ($path)
 Get the cache key for a file path. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from FileBackend
static extensionFromPath ($path, $case= 'lowercase')
 Get the final extension from a storage or FS path. More...
 
static isPathTraversalFree ($path)
 Check if a relative path has no directory traversals. More...
 
static isStoragePath ($path)
 Check if a given path is a "mwstore://" path. More...
 
static makeContentDisposition ($type, $filename= '')
 Build a Content-Disposition header value per RFC 6266. More...
 
static normalizeStoragePath ($storagePath)
 Normalize a storage path by cleaning up directory separators. More...
 
static parentStoragePath ($storagePath)
 Get the parent storage directory of a storage path. More...
 
static splitStoragePath ($storagePath)
 Split a storage path into a backend name, a container name, and a relative file path. More...
 

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:
Parameters
array$config

Definition at line 71 of file FileBackendStore.php.

References WANObjectCache\newEmpty().

Member Function Documentation

FileBackendStore::concatenate ( array  $params)
final
FileBackendStore::containerCacheKey (   $container)
private

Get the cache key for a container.

Parameters
string$containerResolved container name
Returns
string

Definition at line 1619 of file FileBackendStore.php.

Referenced by primeContainerCache(), and setContainerCache().

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 : StatusValue will be returned immediately if supported. If the StatusValue 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
StatusValue

Definition at line 205 of file FileBackendStore.php.

References $status, clearCache(), deleteFileCache(), doCopyInternal(), and FileBackend\scopedProfileSection().

Referenced by doMoveInternal().

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 : StatusValue will be returned immediately if supported. If the StatusValue 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
StatusValue

Definition at line 122 of file FileBackendStore.php.

References $status, clearCache(), deleteFileCache(), doCreateInternal(), maxFileSizeInternal(), FileBackend\newStatus(), and FileBackend\scopedProfileSection().

FileBackendStore::deleteContainerCache (   $container)
finalprotected

Delete the cached info for a container.

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

Parameters
string$containerResolved container name

Definition at line 1639 of file FileBackendStore.php.

Referenced by doClean().

FileBackendStore::deleteFileCache (   $path)
finalprotected

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$pathStorage path

Definition at line 1732 of file FileBackendStore.php.

References $path, and FileBackend\normalizeStoragePath().

Referenced by SwiftFileBackend\addMissingMetadata(), copyInternal(), createInternal(), deleteInternal(), describeInternal(), SwiftFileBackend\doStreamFile(), moveInternal(), and storeInternal().

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 : StatusValue will be returned immediately if supported. If the StatusValue is OK, then its value field will be set to a FileBackendStoreOpHandle object.
Parameters
array$params
Returns
StatusValue

Definition at line 237 of file FileBackendStore.php.

References $status, clearCache(), deleteFileCache(), doDeleteInternal(), and FileBackend\scopedProfileSection().

Referenced by doMoveInternal().

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:

Parameters
array$params
Returns
StatusValue

Definition at line 317 of file FileBackendStore.php.

References $status, clearCache(), deleteFileCache(), doDescribeInternal(), FileBackend\newStatus(), and FileBackend\scopedProfileSection().

FileBackendStore::directoriesAreVirtual ( )
abstractprotected

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

Referenced by doClean().

FileBackendStore::directoryExists ( array  $params)
final
FileBackendStore::doCleanInternal (   $container,
  $dir,
array  $params 
)
protected
See also
FileBackendStore::doClean()
Parameters
string$container
string$dir
array$params
Returns
StatusValue

Definition at line 600 of file FileBackendStore.php.

References FileBackend\newStatus().

Referenced by doClean().

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

Clears any additional stat caches for storage paths.

See also
FileBackend::clearCache()
Parameters
array$pathsStorage paths (optional)

Definition at line 1307 of file FileBackendStore.php.

Referenced by clearCache().

FileBackendStore::doConcatenate ( array  $params)
protected
See also
FileBackendStore::concatenate()
Parameters
array$params
Returns
StatusValue

Definition at line 375 of file FileBackendStore.php.

References $path, $status, as, FileBackend\getLocalReference(), getLocalReferenceMulti(), and FileBackend\newStatus().

Referenced by concatenate().

FileBackendStore::doCopyInternal ( array  $params)
abstractprotected
See also
FileBackendStore::copyInternal()
Parameters
array$params
Returns
StatusValue

Referenced by copyInternal().

FileBackendStore::doCreateInternal ( array  $params)
abstractprotected
See also
FileBackendStore::createInternal()
Parameters
array$params
Returns
StatusValue

Referenced by createInternal().

FileBackendStore::doDeleteInternal ( array  $params)
abstractprotected
See also
FileBackendStore::deleteInternal()
Parameters
array$params
Returns
StatusValue

Referenced by deleteInternal().

FileBackendStore::doDescribeInternal ( array  $params)
protected
See also
FileBackendStore::describeInternal()
Parameters
array$params
Returns
StatusValue

Definition at line 335 of file FileBackendStore.php.

References FileBackend\newStatus().

Referenced by describeInternal().

FileBackendStore::doDirectoryExists (   $container,
  $dir,
array  $params 
)
abstractprotected
See also
FileBackendStore::directoryExists()
Parameters
string$containerResolved container name
string$dirResolved path relative to container
array$params
Returns
bool|null

Referenced by directoryExists().

FileBackendStore::doExecuteOpHandlesInternal ( array  $fileOpHandles)
protected
See also
FileBackendStore::executeOpHandlesInternal()
Parameters
FileBackendStoreOpHandle[]$fileOpHandles
Exceptions
FileBackendError
Returns
StatusValue[] List of corresponding StatusValue objects

Definition at line 1233 of file FileBackendStore.php.

Referenced by executeOpHandlesInternal().

FileBackendStore::doGetFileContentsMulti ( array  $params)
protected
See also
FileBackendStore::getFileContentsMulti()
Parameters
array$params
Returns
array

Definition at line 696 of file FileBackendStore.php.

References $path, as, and doGetLocalReferenceMulti().

Referenced by getFileContentsMulti().

FileBackendStore::doGetFileSha1Base36 ( array  $params)
protected
See also
FileBackendStore::getFileSha1Base36()
Parameters
array$params
Returns
bool|string

Definition at line 764 of file FileBackendStore.php.

References FileBackend\getLocalReference().

Referenced by getFileSha1Base36().

FileBackendStore::doGetFileStat ( array  $params)
abstractprotected
See also
FileBackendStore::getFileStat()
Parameters
array$params

Referenced by getFileStat().

FileBackendStore::doGetFileStatMulti ( array  $params)
protected

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

See also
FileBackend::getFileStat()
Parameters
array$paramsParameters 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

Definition at line 1368 of file FileBackendStore.php.

Referenced by preloadFileStat().

FileBackendStore::doGetFileXAttributes ( array  $params)
protected
See also
FileBackendStore::getFileXAttributes()
Parameters
array$params
Returns
bool|string

Definition at line 734 of file FileBackendStore.php.

Referenced by getFileXAttributes().

FileBackendStore::doGetLocalCopyMulti ( array  $params)
abstractprotected
See also
FileBackendStore::getLocalCopyMulti()
Parameters
array$params
Returns
array

Referenced by doGetLocalReferenceMulti(), and getLocalCopyMulti().

FileBackendStore::doGetLocalReferenceMulti ( array  $params)
protected
See also
FileBackendStore::getLocalReferenceMulti()
Parameters
array$params
Returns
array

Definition at line 820 of file FileBackendStore.php.

References doGetLocalCopyMulti().

Referenced by doGetFileContentsMulti(), and getLocalReferenceMulti().

FileBackendStore::doMoveInternal ( array  $params)
protected
See also
FileBackendStore::moveInternal()
Parameters
array$params
Returns
StatusValue

Definition at line 288 of file FileBackendStore.php.

References $status, copyInternal(), deleteInternal(), and FileBackend\normalizeStoragePath().

Referenced by moveInternal().

FileBackendStore::doPrepare ( array  $params)
finalprotected
FileBackendStore::doPrepareInternal (   $container,
  $dir,
array  $params 
)
protected
See also
FileBackendStore::doPrepare()
Parameters
string$container
string$dir
array$params
Returns
StatusValue

Definition at line 474 of file FileBackendStore.php.

References FileBackend\newStatus().

Referenced by doPrepare().

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$containerInfoMap of resolved container names to cached info

Definition at line 1691 of file FileBackendStore.php.

Referenced by primeContainerCache().

FileBackendStore::doPublish ( array  $params)
finalprotected
FileBackendStore::doPublishInternal (   $container,
  $dir,
array  $params 
)
protected
See also
FileBackendStore::doPublish()
Parameters
string$container
string$dir
array$params
Returns
StatusValue

Definition at line 544 of file FileBackendStore.php.

References FileBackend\newStatus().

Referenced by doPublish().

FileBackendStore::doQuickOperationsInternal ( array  $ops)
finalprotected
FileBackendStore::doSecure ( array  $params)
finalprotected
FileBackendStore::doSecureInternal (   $container,
  $dir,
array  $params 
)
protected
See also
FileBackendStore::doSecure()
Parameters
string$container
string$dir
array$params
Returns
StatusValue

Definition at line 509 of file FileBackendStore.php.

References FileBackend\newStatus().

Referenced by doSecure().

FileBackendStore::doStoreInternal ( array  $params)
abstractprotected
See also
FileBackendStore::storeInternal()
Parameters
array$params
Returns
StatusValue

Referenced by storeInternal().

FileBackendStore::executeOpHandlesInternal ( array  $fileOpHandles)
final

Execute a list of FileBackendStoreOpHandle handles in parallel.

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

Parameters
FileBackendStoreOpHandle[]$fileOpHandles
Exceptions
FileBackendError
Returns
StatusValue[] Map of StatusValue objects

Definition at line 1206 of file FileBackendStore.php.

References $res, as, doExecuteOpHandlesInternal(), FileBackend\getName(), and FileBackend\scopedProfileSection().

Referenced by doQuickOperationsInternal().

FileBackendStore::fileCacheKey (   $path)
private

Get the cache key for a file path.

Parameters
string$pathNormalized storage path
Returns
string

Definition at line 1700 of file FileBackendStore.php.

References $path.

Referenced by primeFileCache(), and setFileCache().

FileBackendStore::fileExists ( array  $params)
final
FileBackendStore::fullContainerName (   $container)
finalprotected

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

Parameters
string$container
Returns
string

Definition at line 1579 of file FileBackendStore.php.

Referenced by resolveStoragePath().

FileBackendStore::getContainerHashLevels (   $container)
finalprotected

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 1539 of file FileBackendStore.php.

References false.

Referenced by getContainerShard(), and getContainerSuffixes().

FileBackendStore::getContainerShard (   $container,
  $relPath 
)
finalprotected

Get the container name shard suffix for a given path.

Any empty suffix means the container is not sharded.

Parameters
string$containerContainer name
string$relPathStorage path relative to the container
Returns
string|null Returns null if shard could not be determined

Definition at line 1487 of file FileBackendStore.php.

References $base, getContainerHashLevels(), and list.

Referenced by resolveStoragePath().

FileBackendStore::getContainerSuffixes (   $container)
finalprotected

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

Parameters
string$container
Returns
array

Definition at line 1560 of file FileBackendStore.php.

References $base, getContainerHashLevels(), and list.

Referenced by directoryExists(), doClean(), doPrepare(), doPublish(), doSecure(), getDirectoryList(), and getFileList().

FileBackendStore::getContentType (   $storagePath,
  $content,
  $fsPath 
)
protected

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

Parameters
string$storagePath
string | null$contentFile data
string | null$fsPathFile system path
Returns
string MIME type

Definition at line 1839 of file FileBackendStore.php.

References $mime.

Referenced by SwiftFileBackend\doCreateInternal(), and SwiftFileBackend\doStoreInternal().

FileBackendStore::getDirectoryList ( array  $params)
final
FileBackendStore::getDirectoryListInternal (   $container,
  $dir,
array  $params 
)
abstract

Do not call this function from places outside FileBackend.

See also
FileBackendStore::getDirectoryList()
Parameters
string$containerResolved container name
string$dirResolved path relative to container
array$params
Returns
Traversable|array|null Returns null on failure

Referenced by getDirectoryList().

FileBackendStore::getFileContentsMulti ( array  $params)
FileBackendStore::getFileHttpUrl ( array  $params)
See also
FileBackend::getFileHttpUrl()
Parameters
array$params
Returns
string|null

Definition at line 845 of file FileBackendStore.php.

FileBackendStore::getFileList ( array  $params)
final
FileBackendStore::getFileListInternal (   $container,
  $dir,
array  $params 
)
abstract

Do not call this function from places outside FileBackend.

See also
FileBackendStore::getFileList()
Parameters
string$containerResolved container name
string$dirResolved path relative to container
array$params
Returns
Traversable|array|null Returns null on failure

Referenced by getFileList().

FileBackendStore::getFileProps ( array  $params)
final
FileBackendStore::getFileSha1Base36 ( array  $params)
final
FileBackendStore::getFileSize ( array  $params)
final

Definition at line 618 of file FileBackendStore.php.

References getFileStat(), and FileBackend\scopedProfileSection().

FileBackendStore::getFileTimestamp ( array  $params)
final

Definition at line 611 of file FileBackendStore.php.

References getFileStat(), and FileBackend\scopedProfileSection().

FileBackendStore::getFileXAttributes ( array  $params)
final
FileBackendStore::getLocalCopyMulti ( array  $params)
final
FileBackendStore::getLocalReferenceMulti ( array  $params)
final
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$opsSame format as doOperations()
Returns
FileOp[] List of FileOp objects
Exceptions
FileBackendError

Definition at line 1009 of file FileBackendStore.php.

References $params, and as.

Referenced by doOperationsInternal(), and getScopedLocksForOps().

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$performOpsList of FileOp objects
Returns
array (LockManager::LOCK_UW => path list, LockManager::LOCK_EX => path list)

Definition at line 1048 of file FileBackendStore.php.

References as, LockManager\LOCK_EX, and LockManager\LOCK_UW.

Referenced by doOperationsInternal(), and getScopedLocksForOps().

FileBackendStore::getScopedLocksForOps ( array  $ops,
StatusValue  $status 
)
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
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$storagePathStorage path
Returns
bool

Definition at line 1525 of file FileBackendStore.php.

References list, and resolveStoragePath().

static FileBackendStore::isValidContainerName (   $container)
staticfinalprotected

Check if a full container name is valid.

This checks for length and illegal characters. Limiting the characters makes migrations to other stores easier.

Parameters
string$container
Returns
bool

Definition at line 1408 of file FileBackendStore.php.

static FileBackendStore::isValidShortContainerName (   $container)
staticfinalprotected

Check if a short container name is valid.

This checks for length and illegal characters. This may disallow certain characters that can appear in the prefix used to make the full container name.

Parameters
string$container
Returns
bool

Definition at line 1391 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 89 of file FileBackendStore.php.

References $maxFileSize.

Referenced by createInternal(), and storeInternal().

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 : StatusValue will be returned immediately if supported. If the StatusValue 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
StatusValue

Definition at line 271 of file FileBackendStore.php.

References $status, clearCache(), deleteFileCache(), doMoveInternal(), and FileBackend\scopedProfileSection().

static FileBackendStore::normalizeXAttributes ( array  $xattr)
staticfinalprotected

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

Parameters
array$xattr
Returns
array
Since
1.22

Definition at line 1796 of file FileBackendStore.php.

References FileBackend\$name, $value, and as.

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
StatusValue

Definition at line 346 of file FileBackendStore.php.

References FileBackend\newStatus().

FileBackendStore::preloadCache ( array  $paths)
final
FileBackendStore::preloadFileStat ( array  $params)
final
FileBackendStore::primeContainerCache ( array  $items)
finalprotected

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 1652 of file FileBackendStore.php.

References $path, as, containerCacheKey(), doPrimeContainerCache(), list, resolveStoragePath(), and FileBackend\scopedProfileSection().

Referenced by doOperationsInternal(), SwiftFileBackend\getContainerStat(), and preloadCache().

FileBackendStore::primeFileCache ( array  $items)
finalprotected

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$itemsList of storage paths

Definition at line 1749 of file FileBackendStore.php.

References $path, as, fileCacheKey(), list, FileBackend\normalizeStoragePath(), resolveStoragePath(), and FileBackend\scopedProfileSection().

Referenced by getFileStat(), and preloadCache().

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 1595 of file FileBackendStore.php.

Referenced by resolveStoragePath().

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$containerContainer name
string$relStoragePathStorage path relative to the container
Returns
string|null Path or null if not valid

Definition at line 1609 of file FileBackendStore.php.

Referenced by resolveStoragePath().

FileBackendStore::resolveStoragePath (   $storagePath)
finalprotected

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 1429 of file FileBackendStore.php.

References fullContainerName(), getContainerShard(), list, name, resolveContainerName(), and resolveContainerPath().

Referenced by directoryExists(), doClean(), doPrepare(), doPublish(), doSecure(), getDirectoryList(), getFileList(), isSingleShardPathInternal(), preloadCache(), primeContainerCache(), primeFileCache(), and resolveStoragePathReal().

FileBackendStore::resolveStoragePathReal (   $storagePath)
finalprotected

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 latter 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 1470 of file FileBackendStore.php.

References list, and resolveStoragePath().

Referenced by SwiftFileBackend\addMissingMetadata(), SwiftFileBackend\doCopyInternal(), SwiftFileBackend\doCreateInternal(), SwiftFileBackend\doDeleteInternal(), SwiftFileBackend\doDescribeInternal(), SwiftFileBackend\doGetFileContentsMulti(), SwiftFileBackend\doGetFileStatMulti(), SwiftFileBackend\doGetLocalCopyMulti(), SwiftFileBackend\doMoveInternal(), SwiftFileBackend\doStoreInternal(), SwiftFileBackend\doStreamFile(), SwiftFileBackend\getFileHttpUrl(), SwiftFileBackend\isPathUsableInternal(), MemoryFileBackend\resolveHashKey(), and FSFileBackend\resolveToFSPath().

FileBackendStore::sanitizeOpHeaders ( array  $op)
protected

Normalize and filter HTTP headers from a file operation.

This normalizes and strips 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$opSame format as doOperation()
Returns
array

Definition at line 1252 of file FileBackendStore.php.

References FileBackend\$name, $value, and as.

FileBackendStore::setConcurrencyFlags ( array  $opts)
finalprotected

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

Parameters
array$optsMap of operation options
Returns
array

Definition at line 1816 of file FileBackendStore.php.

References FileBackend\$concurrency.

Referenced by doOperationsInternal(), getFileContentsMulti(), getLocalCopyMulti(), and getLocalReferenceMulti().

FileBackendStore::setContainerCache (   $container,
array  $val 
)
finalprotected

Set the cached info for a container.

Parameters
string$containerResolved container name
array$valInformation to cache

Definition at line 1629 of file FileBackendStore.php.

References containerCacheKey().

Referenced by SwiftFileBackend\getContainerStat().

FileBackendStore::setFileCache (   $path,
array  $val 
)
finalprotected

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$pathStorage path
array$valStat information to cache

Definition at line 1712 of file FileBackendStore.php.

References $path, ConvertibleTimestamp\convert(), fileCacheKey(), FileBackend\normalizeStoragePath(), and TS_UNIX.

Referenced by getFileStat(), and preloadFileStat().

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 : StatusValue will be returned immediately if supported. If the StatusValue 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
StatusValue

Definition at line 163 of file FileBackendStore.php.

References $status, clearCache(), deleteFileCache(), doStoreInternal(), maxFileSizeInternal(), FileBackend\newStatus(), and FileBackend\scopedProfileSection().

FileBackendStore::streamFile ( array  $params)
final

Member Data Documentation

ProcessCacheLRU FileBackendStore::$cheapCache
protected

Map of paths to small (RAM/disk) cache items.

Definition at line 44 of file FileBackendStore.php.

ProcessCacheLRU FileBackendStore::$expensiveCache
protected

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

Definition at line 46 of file FileBackendStore.php.

FileBackendStore::$maxFileSize = 4294967296
protected

Definition at line 54 of file FileBackendStore.php.

Referenced by maxFileSizeInternal().

WANObjectCache FileBackendStore::$memCache
protected

Definition at line 40 of file FileBackendStore.php.

callable FileBackendStore::$mimeCallback
protected

Method to get the MIME type of files.

Definition at line 52 of file FileBackendStore.php.

array FileBackendStore::$shardViaHashLevels = []
protected

Map of container names to sharding config.

Definition at line 49 of file FileBackendStore.php.

BagOStuff FileBackendStore::$srvCache
protected

Definition at line 42 of file FileBackendStore.php.

const FileBackendStore::CACHE_CHEAP_SIZE = 500

Definition at line 57 of file FileBackendStore.php.

const FileBackendStore::CACHE_EXPENSIVE_SIZE = 5

Definition at line 58 of file FileBackendStore.php.

const FileBackendStore::CACHE_TTL = 10

Definition at line 56 of file FileBackendStore.php.


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