MediaWiki  master
FSFileBackend Class Reference

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

Inheritance diagram for FSFileBackend:
Collaboration diagram for FSFileBackend:

Public Member Functions

 __construct (array $config)
 
 getDirectoryListInternal ( $fullCont, $dirRel, array $params)
 
 getFeatures ()
 Get the a bitfield of extra features supported by the backend medium. More...
 
 getFileListInternal ( $fullCont, $dirRel, array $params)
 
 isPathUsableInternal ( $storagePath)
 Check if a file can be created or changed at a given storage path in the backend. More...
 
- Public Member Functions inherited from FileBackendStore
 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...
 
 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)
 Check if a directory exists at a given storage path. More...
 
 executeOpHandlesInternal (array $fileOpHandles)
 Execute a list of FileBackendStoreOpHandle handles in parallel. More...
 
 fileExists (array $params)
 Check if a file exists at a storage path in the backend. More...
 
 getDirectoryList (array $params)
 Get an iterator to list all directories under a storage directory. More...
 
 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. More...
 
 getFileHttpUrl (array $params)
 
 getFileList (array $params)
 Get an iterator to list all stored files under a storage directory. More...
 
 getFileProps (array $params)
 Get the properties of the content of the file at a storage path in the backend. More...
 
 getFileSha1Base36 (array $params)
 Get a SHA-1 hash of the content 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...
 
 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. More...
 
 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. More...
 
 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)
 Get an array of scoped locks needed for a batch of file operations. 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)
 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...
 
 storeInternal (array $params)
 Store a file into the backend from a file on disk. More...
 
 streamFile (array $params)
 Stream the content of the file at a storage path in the backend. More...
 
- Public Member Functions inherited from FileBackend
 clean (array $params)
 Delete a storage directory if it is empty. 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...
 
 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, array $opts=[])
 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...
 
 getContainerStoragePath ( $container)
 Get the storage path for the given container for this backend. More...
 
 getDomainId ()
 Get the domain identifier used for this backend (possibly empty). More...
 
 getFileContents (array $params)
 Get the contents of 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...
 
 getLocalReference (array $params)
 Returns a file system file, identical in content to the file at a storage path. 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...
 
 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...
 
 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, array $opts=[])
 Performs a single quick copy operation. More...
 
 quickCreate (array $params, array $opts=[])
 Performs a single quick create operation. More...
 
 quickDelete (array $params, array $opts=[])
 Performs a single quick delete operation. More...
 
 quickDescribe (array $params, array $opts=[])
 Performs a single quick describe operation. More...
 
 quickMove (array $params, array $opts=[])
 Performs a single quick move operation. More...
 
 quickStore (array $params, array $opts=[])
 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...
 
 unlockFiles (array $paths, $type)
 Unlock the files at the given storage paths in the backend. More...
 

Protected Member Functions

 chmod ( $fsPath)
 Chmod a file, suppressing the warnings. More...
 
 cleanPathSlashes ( $fsPath)
 Clean up directory separators for the given OS. More...
 
 containerFSRoot ( $shortCont, $fullCont)
 Given the short (unresolved) and full (resolved) name of a container, return the file system path of the container. 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...
 
 doCleanInternal ( $fullCont, $dirRel, array $params)
 
 doClearCache (array $paths=null)
 Clears any additional stat caches for storage paths. More...
 
 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)
 
 doPublishInternal ( $fullCont, $dirRel, array $params)
 
 doSecureInternal ( $fullCont, $dirRel, array $params)
 
 doStoreInternal (array $params)
 
 htaccessPrivate ()
 Return the text of a .htaccess file to make a directory private. More...
 
 indexHtmlPrivate ()
 Return the text of an index.html file to hide directory listings. More...
 
 isLegalRelPath ( $fsPath)
 Sanity check a relative file system path for validity. More...
 
 newTempFileWithContent (array $params)
 
 resolveContainerPath ( $container, $relStoragePath)
 Resolve a relative storage path, checking if it's allowed by the backend. More...
 
 resolveToFSPath ( $storagePath)
 Get the absolute file system path for a storage path. More...
 
 rmdir ( $fsDirectory)
 Remove an empty directory, suppressing the warnings. More...
 
 trapWarnings ( $regexIgnore=null)
 Listen for E_WARNING errors and track whether any that happen. More...
 
 unlink ( $fsPath)
 Unlink a file, suppressing the warnings. More...
 
 untrapWarnings ()
 Stop listening for E_WARNING errors and get whether any happened. More...
 
- Protected Member Functions inherited from FileBackendStore
 deleteContainerCache ( $container)
 Delete the cached info for a container. More...
 
 deleteFileCache ( $path)
 Delete the cached stat info for a file path. More...
 
 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. More...
 
 doGetFileXAttributes (array $params)
 
 doOperationsInternal (array $ops, array $opts)
 
 doPrepare (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)
 
 doQuickOperationsInternal (array $ops, array $opts)
 
 doSecure (array $params)
 
 doStreamFile (array $params)
 
 fullContainerName ( $container)
 Get the full container name, including the domain 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...
 
 ingestFreshFileStats (array $stats, $latest)
 Ingest file stat entries that just came from querying the backend (not cache) 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...
 
 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
 newStatus (... $args)
 Yields the result of the status wrapper callback on either: More...
 
 resetOutputBuffer ()
 Let's not reset output buffering during tests. More...
 
 resolveFSFileObjects (array $ops)
 Convert FSFile 'src' paths to string paths (with an 'srcRef' field set to the FSFile) More...
 
 scopedProfileSection ( $section)
 
 wrapStatus (StatusValue $sv)
 

Protected Attributes

string $basePath
 Directory holding the container directories. More...
 
array $containerPaths
 Map of container names to root paths for custom container paths. More...
 
string $currentUser
 OS username running this script. More...
 
int $dirMode
 Directory permission mode. More...
 
int $fileMode
 File permission mode. More...
 
string $fileOwner
 Required OS username to own files. More...
 
bool $os
 Simpler version of PHP_OS_FAMILY (PHP 7.2) More...
 
MapCacheLRU $usableDirCache
 Cache for known prepared/usable directorries. More...
 
- Protected Attributes inherited from FileBackendStore
MapCacheLRU $cheapCache
 Map of paths to small (RAM/disk) cache items. More...
 
MapCacheLRU $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
 
const CACHE_CHEAP_SIZE = 500
 
const CACHE_EXPENSIVE_SIZE = 5
 
const CACHE_TTL = 10
 
- 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...
 
callable null $profiler
 
string $readOnly
 Read-only explanation message. More...
 
callable $statusWrapper
 
callable $streamMimeFunc
 
TempFSFileFactory $tmpFileFactory
 

Private Member Functions

 makeCopyCommand ( $fsSrcPath, $fsDstPath, $ignoreMissing)
 
 makeMoveCommand ( $fsSrcPath, $fsDstPath, $ignoreMissing=false)
 
 makeStagingPath ( $fsPath)
 
 makeUnlinkCommand ( $fsPath, $ignoreMissing=false)
 

Private Attributes

bool[] $warningTrapStack = []
 Map of (stack index => whether a warning happened) 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...
 
- Public Attributes inherited from FileBackend
const ATTR_HEADERS = 1
 Bitfield flags for supported features. More...
 
const ATTR_METADATA = 2
 
const ATTR_UNICODE_PATHS = 4
 
- Static Protected Member Functions inherited from FileBackendStore
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...
 
- Static Protected Attributes inherited from FileBackendStore
static string $ABSENT_LATEST = 'FNE-L'
 File does not exist according to a "latest"-mode stat query. More...
 
static string $ABSENT_NORMAL = 'FNE-N'
 File does not exist according to a normal stat query. More...
 
static false $RES_ABSENT = false
 Idiom for "no result due to missing file" (since 1.34) More...
 
static null $RES_ERROR = null
 Idiom for "no result due to I/O errors" (since 1.34) More...
 

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 63 of file FSFileBackend.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 98 of file FSFileBackend.php.

Member Function Documentation

◆ chmod()

FSFileBackend::chmod (   $fsPath)
protected

Chmod a file, suppressing the warnings.

Parameters
string$fsPathAbsolute file system path
Returns
bool Success

Definition at line 893 of file FSFileBackend.php.

Referenced by doCopyInternal(), doCreateInternal(), doGetLocalCopyMulti(), and doStoreInternal().

◆ cleanPathSlashes()

FSFileBackend::cleanPathSlashes (   $fsPath)
protected

Clean up directory separators for the given OS.

Parameters
string$fsPathFS path
Returns
string

Definition at line 978 of file FSFileBackend.php.

Referenced by makeCopyCommand(), makeMoveCommand(), and makeUnlinkCommand().

◆ containerFSRoot()

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 173 of file FSFileBackend.php.

Referenced by doCleanInternal(), doDirectoryExists(), doPrepareInternal(), doPublishInternal(), doSecureInternal(), getDirectoryListInternal(), getFileListInternal(), and resolveToFSPath().

◆ directoriesAreVirtual()

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

Definition at line 765 of file FSFileBackend.php.

◆ doCleanInternal()

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

Reimplemented from FileBackendStore.

Definition at line 576 of file FSFileBackend.php.

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

◆ doClearCache()

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

Clears any additional stat caches for storage paths.

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

Reimplemented from FileBackendStore.

Definition at line 609 of file FSFileBackend.php.

References $path, and resolveToFSPath().

◆ doCopyInternal()

FSFileBackend::doCopyInternal ( array  $params)
protected

◆ doCreateInternal()

FSFileBackend::doCreateInternal ( array  $params)
protected

◆ doDeleteInternal()

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

Reimplemented from FileBackendStore.

Definition at line 447 of file FSFileBackend.php.

References makeUnlinkCommand(), FileBackend\newStatus(), resolveToFSPath(), trapWarnings(), unlink(), and untrapWarnings().

◆ doDirectoryExists()

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

Reimplemented from FileBackendStore.

Definition at line 624 of file FSFileBackend.php.

References FileBackendStore\$RES_ERROR, containerFSRoot(), FileBackend\splitStoragePath(), trapWarnings(), and untrapWarnings().

◆ doExecuteOpHandlesInternal()

FSFileBackend::doExecuteOpHandlesInternal ( array  $fileOpHandles)
protected
Parameters
FSFileOpHandle[]$fileOpHandles
Returns
StatusValue[]

Reimplemented from FileBackendStore.

Definition at line 774 of file FSFileBackend.php.

References FileBackend\newStatus().

◆ doGetFileStat()

FSFileBackend::doGetFileStat ( array  $params)
protected

◆ doGetLocalCopyMulti()

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

Definition at line 728 of file FSFileBackend.php.

References $ext, FileBackendStore\$RES_ABSENT, FileBackendStore\$RES_ERROR, $source, chmod(), FileBackend\copy(), FileBackend\extensionFromPath(), resolveToFSPath(), trapWarnings(), and untrapWarnings().

◆ doGetLocalReferenceMulti()

FSFileBackend::doGetLocalReferenceMulti ( array  $params)
protected
See also
FileBackendStore::getLocalReferenceMulti()
Parameters
array$params
Returns
string[]|bool[]|null[] Map of (path => FSFile, false (missing), or null (error))

Reimplemented from FileBackendStore.

Definition at line 702 of file FSFileBackend.php.

References FileBackendStore\$RES_ABSENT, FileBackendStore\$RES_ERROR, $source, resolveToFSPath(), trapWarnings(), and untrapWarnings().

◆ doMoveInternal()

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

Reimplemented from FileBackendStore.

Definition at line 398 of file FSFileBackend.php.

References makeMoveCommand(), FileBackend\newStatus(), resolveToFSPath(), trapWarnings(), and untrapWarnings().

◆ doPrepareInternal()

FSFileBackend::doPrepareInternal (   $fullCont,
  $dirRel,
array  $params 
)
protected
Parameters
string$fullCont
string$dirRel
array$params
Returns
StatusValue

Reimplemented from FileBackendStore.

Definition at line 488 of file FSFileBackend.php.

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

◆ doPublishInternal()

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

Reimplemented from FileBackendStore.

Definition at line 552 of file FSFileBackend.php.

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

◆ doSecureInternal()

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

Reimplemented from FileBackendStore.

Definition at line 524 of file FSFileBackend.php.

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

Referenced by doPrepareInternal().

◆ doStoreInternal()

FSFileBackend::doStoreInternal ( array  $params)
protected

◆ getDirectoryListInternal()

FSFileBackend::getDirectoryListInternal (   $fullCont,
  $dirRel,
array  $params 
)
See also
FileBackendStore::getDirectoryListInternal()
Parameters
string$fullCont
string$dirRel
array$params
Returns
array|FSFileBackendDirList|null

Reimplemented from FileBackendStore.

Definition at line 643 of file FSFileBackend.php.

References FileBackendStore\$RES_ERROR, containerFSRoot(), and FileBackend\splitStoragePath().

◆ getFeatures()

FSFileBackend::getFeatures ( )

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

Returns
int Bitfield of FileBackend::ATTR_* flags
Since
1.23

Reimplemented from FileBackend.

Definition at line 131 of file FSFileBackend.php.

References FileBackend\ATTR_UNICODE_PATHS.

◆ getFileListInternal()

FSFileBackend::getFileListInternal (   $fullCont,
  $dirRel,
array  $params 
)
See also
FileBackendStore::getFileListInternal()
Parameters
string$fullCont
string$dirRel
array$params
Returns
array|FSFileBackendFileList|null

Reimplemented from FileBackendStore.

Definition at line 676 of file FSFileBackend.php.

References FileBackendStore\$RES_ERROR, containerFSRoot(), and FileBackend\splitStoragePath().

◆ htaccessPrivate()

FSFileBackend::htaccessPrivate ( )
protected

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

Returns
string

Definition at line 968 of file FSFileBackend.php.

Referenced by doPublishInternal(), and doSecureInternal().

◆ indexHtmlPrivate()

FSFileBackend::indexHtmlPrivate ( )
protected

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

Returns
string

Definition at line 959 of file FSFileBackend.php.

Referenced by doPublishInternal(), and doSecureInternal().

◆ isLegalRelPath()

FSFileBackend::isLegalRelPath (   $fsPath)
protected

Sanity check a relative file system path for validity.

Parameters
string$fsPathNormalized relative path
Returns
bool

Definition at line 153 of file FSFileBackend.php.

Referenced by resolveContainerPath().

◆ isPathUsableInternal()

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

Definition at line 203 of file FSFileBackend.php.

References resolveToFSPath().

◆ makeCopyCommand()

FSFileBackend::makeCopyCommand (   $fsSrcPath,
  $fsDstPath,
  $ignoreMissing 
)
private
Parameters
string$fsSrcPathAbsolute file system path
string$fsDstPathAbsolute file system path
bool$ignoreMissingWhether to no-op if the source file is non-existant
Returns
string Command

Definition at line 818 of file FSFileBackend.php.

References cleanPathSlashes(), and makeStagingPath().

Referenced by doCopyInternal(), doCreateInternal(), and doStoreInternal().

◆ makeMoveCommand()

FSFileBackend::makeMoveCommand (   $fsSrcPath,
  $fsDstPath,
  $ignoreMissing = false 
)
private
Parameters
string$fsSrcPathAbsolute file system path
string$fsDstPathAbsolute file system path
bool$ignoreMissingWhether to no-op if the source file is non-existant
Returns
string Command

Definition at line 852 of file FSFileBackend.php.

References cleanPathSlashes().

Referenced by doMoveInternal().

◆ makeStagingPath()

FSFileBackend::makeStagingPath (   $fsPath)
private
Parameters
string$fsPathAbsolute file system path
Returns
string Absolute file system path on the same device

Definition at line 804 of file FSFileBackend.php.

Referenced by doCopyInternal(), doCreateInternal(), doStoreInternal(), and makeCopyCommand().

◆ makeUnlinkCommand()

FSFileBackend::makeUnlinkCommand (   $fsPath,
  $ignoreMissing = false 
)
private
Parameters
string$fsPathAbsolute file system path
bool$ignoreMissingWhether to no-op if the file is non-existant
Returns
string Command

Definition at line 873 of file FSFileBackend.php.

References cleanPathSlashes().

Referenced by doDeleteInternal().

◆ newTempFileWithContent()

FSFileBackend::newTempFileWithContent ( array  $params)
protected
Parameters
array$paramsParameters for FileBackend 'create' operation
Returns
TempFSFile|null

Definition at line 939 of file FSFileBackend.php.

Referenced by doCreateInternal().

◆ resolveContainerPath()

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

Parameters
string$containerContainer name
string$relStoragePathStorage path relative to the container
Returns
string|null Path or null if not valid

Reimplemented from FileBackendStore.

Definition at line 135 of file FSFileBackend.php.

References isLegalRelPath().

◆ resolveToFSPath()

FSFileBackend::resolveToFSPath (   $storagePath)
protected

Get the absolute file system path for a storage path.

Parameters
string$storagePathStorage path
Returns
string|null

Definition at line 189 of file FSFileBackend.php.

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

Referenced by doClearCache(), doCopyInternal(), doCreateInternal(), doDeleteInternal(), doGetFileStat(), doGetLocalCopyMulti(), doGetLocalReferenceMulti(), doMoveInternal(), doStoreInternal(), and isPathUsableInternal().

◆ rmdir()

FSFileBackend::rmdir (   $fsDirectory)
protected

Remove an empty directory, suppressing the warnings.

Parameters
string$fsDirectoryAbsolute file system path
Returns
bool Success

Definition at line 926 of file FSFileBackend.php.

Referenced by doCleanInternal().

◆ trapWarnings()

FSFileBackend::trapWarnings (   $regexIgnore = null)
protected

Listen for E_WARNING errors and track whether any that happen.

Parameters
string | null$regexIgnoreOptional regex of errors to ignore

Definition at line 987 of file FSFileBackend.php.

Referenced by doCopyInternal(), doCreateInternal(), doDeleteInternal(), doDirectoryExists(), doGetFileStat(), doGetLocalCopyMulti(), doGetLocalReferenceMulti(), doMoveInternal(), doSecureInternal(), and doStoreInternal().

◆ unlink()

FSFileBackend::unlink (   $fsPath)
protected

Unlink a file, suppressing the warnings.

Parameters
string$fsPathAbsolute file system path
Returns
bool Success

Definition at line 911 of file FSFileBackend.php.

Referenced by doDeleteInternal(), and doPublishInternal().

◆ untrapWarnings()

FSFileBackend::untrapWarnings ( )
protected

Stop listening for E_WARNING errors and get whether any happened.

Returns
bool Whether any warnings happened

Definition at line 1003 of file FSFileBackend.php.

Referenced by doCopyInternal(), doCreateInternal(), doDeleteInternal(), doDirectoryExists(), doGetFileStat(), doGetLocalCopyMulti(), doGetLocalReferenceMulti(), doMoveInternal(), doSecureInternal(), and doStoreInternal().

Member Data Documentation

◆ $basePath

string FSFileBackend::$basePath
protected

Directory holding the container directories.

Definition at line 68 of file FSFileBackend.php.

◆ $containerPaths

array FSFileBackend::$containerPaths
protected

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

Definition at line 71 of file FSFileBackend.php.

◆ $currentUser

string FSFileBackend::$currentUser
protected

OS username running this script.

Definition at line 83 of file FSFileBackend.php.

◆ $dirMode

int FSFileBackend::$dirMode
protected

Directory permission mode.

Definition at line 74 of file FSFileBackend.php.

◆ $fileMode

int FSFileBackend::$fileMode
protected

File permission mode.

Definition at line 76 of file FSFileBackend.php.

◆ $fileOwner

string FSFileBackend::$fileOwner
protected

Required OS username to own files.

Definition at line 78 of file FSFileBackend.php.

◆ $os

bool FSFileBackend::$os
protected

Simpler version of PHP_OS_FAMILY (PHP 7.2)

Definition at line 81 of file FSFileBackend.php.

◆ $usableDirCache

MapCacheLRU FSFileBackend::$usableDirCache
protected

Cache for known prepared/usable directorries.

Definition at line 65 of file FSFileBackend.php.

◆ $warningTrapStack

bool [] FSFileBackend::$warningTrapStack = []
private

Map of (stack index => whether a warning happened)

Definition at line 86 of file FSFileBackend.php.


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