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 ()
 
 getFileListInternal ( $fullCont, $dirRel, array $params)
 
 isPathUsableInternal ( $storagePath)
 
- Public Member Functions inherited from FileBackendStore
 __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 in the backend. 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 an order preserved map of storage paths to their content. 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 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...
 
 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 yields an order preserved-map of storage paths to temporary local file copies. More...
 
 getLocalReference (array $params)
 Returns a file system file, identical in content to the file at a storage path. 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...
 
 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 content of 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...
 

Protected Member Functions

 chmod ( $path)
 Chmod a file, suppressing the warnings. More...
 
 cleanPathSlashes ( $path)
 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 ()
 
 doCleanInternal ( $fullCont, $dirRel, array $params)
 
 doClearCache (array $paths=null)
 
 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 ( $path)
 Sanity check a relative file system path for validity. More...
 
 resolveContainerPath ( $container, $relStoragePath)
 
 resolveToFSPath ( $storagePath)
 Get the absolute file system path for a storage path. More...
 
 stageContentAsTempFile (array $params)
 
 trapWarnings ( $regexIgnore=null)
 Listen for E_WARNING errors and track whether any that happen. More...
 
 unlink ( $path)
 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...
 
 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 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...
 
 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)
 
 newStatus (... $args)
 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)
 

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 $isWindows
 Whether the OS is Windows (otherwise assumed Unix-like) 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
 
- 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 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 FileBackendStore
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
 
- 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 62 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

Definition at line 94 of file FSFileBackend.php.

References $path.

Member Function Documentation

◆ chmod()

FSFileBackend::chmod (   $path)
protected

Chmod a file, suppressing the warnings.

Parameters
string$pathAbsolute file system path
Returns
bool Success

Definition at line 782 of file FSFileBackend.php.

References $path.

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

◆ cleanPathSlashes()

FSFileBackend::cleanPathSlashes (   $path)
protected

Clean up directory separators for the given OS.

Parameters
string$pathFS path
Returns
string

Definition at line 853 of file FSFileBackend.php.

References $path.

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

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

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

◆ directoriesAreVirtual()

FSFileBackend::directoriesAreVirtual ( )
protected

Definition at line 728 of file FSFileBackend.php.

◆ doCleanInternal()

FSFileBackend::doCleanInternal (   $fullCont,
  $dirRel,
array  $params 
)
protected

◆ doClearCache()

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

Definition at line 581 of file FSFileBackend.php.

◆ doCopyInternal()

FSFileBackend::doCopyInternal ( array  $params)
protected

◆ doCreateInternal()

FSFileBackend::doCreateInternal ( array  $params)
protected

◆ doDeleteInternal()

FSFileBackend::doDeleteInternal ( array  $params)
protected

◆ doDirectoryExists()

FSFileBackend::doDirectoryExists (   $fullCont,
  $dirRel,
array  $params 
)
protected

◆ doExecuteOpHandlesInternal()

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

Definition at line 737 of file FSFileBackend.php.

References FileBackend\newStatus().

◆ doGetFileStat()

FSFileBackend::doGetFileStat ( array  $params)
protected

Definition at line 559 of file FSFileBackend.php.

References $source, resolveToFSPath(), trapWarnings(), and untrapWarnings().

◆ doGetLocalCopyMulti()

FSFileBackend::doGetLocalCopyMulti ( array  $params)
protected

◆ doGetLocalReferenceMulti()

FSFileBackend::doGetLocalReferenceMulti ( array  $params)
protected

Definition at line 665 of file FSFileBackend.php.

References $source, resolveToFSPath(), trapWarnings(), and untrapWarnings().

◆ doMoveInternal()

FSFileBackend::doMoveInternal ( array  $params)
protected

◆ doPrepareInternal()

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

Definition at line 468 of file FSFileBackend.php.

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

◆ doPublishInternal()

FSFileBackend::doPublishInternal (   $fullCont,
  $dirRel,
array  $params 
)
protected

◆ doSecureInternal()

FSFileBackend::doSecureInternal (   $fullCont,
  $dirRel,
array  $params 
)
protected

◆ 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

Definition at line 604 of file FSFileBackend.php.

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

◆ getFeatures()

FSFileBackend::getFeatures ( )

Definition at line 119 of file FSFileBackend.php.

◆ getFileListInternal()

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

Definition at line 638 of file FSFileBackend.php.

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

◆ htaccessPrivate()

FSFileBackend::htaccessPrivate ( )
protected

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

Returns
string

Definition at line 843 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 834 of file FSFileBackend.php.

Referenced by doPublishInternal(), and doSecureInternal().

◆ isLegalRelPath()

FSFileBackend::isLegalRelPath (   $path)
protected

Sanity check a relative file system path for validity.

Parameters
string$pathNormalized relative path
Returns
bool

Definition at line 141 of file FSFileBackend.php.

References $path.

Referenced by resolveContainerPath().

◆ isPathUsableInternal()

FSFileBackend::isPathUsableInternal (   $storagePath)

Definition at line 191 of file FSFileBackend.php.

References resolveToFSPath().

◆ resolveContainerPath()

FSFileBackend::resolveContainerPath (   $container,
  $relStoragePath 
)
protected

Definition at line 123 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 177 of file FSFileBackend.php.

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

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

◆ stageContentAsTempFile()

FSFileBackend::stageContentAsTempFile ( array  $params)
protected
Parameters
array$paramsOperation parameters with 'content' and 'headers' fields
Returns
TempFSFile|null

Definition at line 812 of file FSFileBackend.php.

References $content.

Referenced by doCreateInternal().

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

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

◆ unlink()

FSFileBackend::unlink (   $path)
protected

Unlink a file, suppressing the warnings.

Parameters
string$pathAbsolute file system path
Returns
bool Success

Definition at line 800 of file FSFileBackend.php.

References $path.

Referenced by doCopyInternal(), doDeleteInternal(), doPublishInternal(), and doStoreInternal().

◆ untrapWarnings()

FSFileBackend::untrapWarnings ( )
protected

Stop listening for E_WARNING errors and get whether any happened.

Returns
bool Whether any warnings happened

Definition at line 878 of file FSFileBackend.php.

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

Member Data Documentation

◆ $basePath

string FSFileBackend::$basePath
protected

Directory holding the container directories.

Definition at line 64 of file FSFileBackend.php.

◆ $containerPaths

array FSFileBackend::$containerPaths
protected

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

Definition at line 67 of file FSFileBackend.php.

◆ $currentUser

string FSFileBackend::$currentUser
protected

OS username running this script.

Definition at line 79 of file FSFileBackend.php.

◆ $dirMode

int FSFileBackend::$dirMode
protected

Directory permission mode.

Definition at line 70 of file FSFileBackend.php.

◆ $fileMode

int FSFileBackend::$fileMode
protected

File permission mode.

Definition at line 72 of file FSFileBackend.php.

◆ $fileOwner

string FSFileBackend::$fileOwner
protected

Required OS username to own files.

Definition at line 74 of file FSFileBackend.php.

◆ $isWindows

bool FSFileBackend::$isWindows
protected

Whether the OS is Windows (otherwise assumed Unix-like)

Definition at line 77 of file FSFileBackend.php.

◆ $warningTrapStack

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

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

Definition at line 82 of file FSFileBackend.php.


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