MediaWiki  master
SwiftFileBackend Class Reference

Class for an OpenStack Swift (or Ceph RGW) based file backend. More...

Inheritance diagram for SwiftFileBackend:
Collaboration diagram for SwiftFileBackend:

Public Member Functions

 __construct (array $config)
 
 getDirectoryListInternal ( $fullCont, $dir, array $params)
 
 getDirListPageInternal ( $fullCont, $dir, &$after, $limit, array $params)
 Do not call this function outside of SwiftFileBackendFileList. More...
 
 getFeatures ()
 Get the a bitfield of extra features supported by the backend medium Stable to override. More...
 
 getFileHttpUrl (array $params)
 
 getFileListInternal ( $fullCont, $dir, array $params)
 
 getFileListPageInternal ( $fullCont, $dir, &$after, $limit, array $params)
 Do not call this function outside of SwiftFileBackendFileList. More...
 
 isPathUsableInternal ( $storagePath)
 Check if a file can be created or changed at a given storage path in the backend. More...
 
 loadListingStatInternal ( $path, array $val)
 Do not call this function outside of SwiftFileBackendFileList. More...
 
 onError ( $status, $func, array $params, $err='', $code=0, $desc='')
 Log an unexpected exception for this 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...
 
 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

 addMissingHashMetadata (array $objHdrs, $path)
 Fill in any missing object metadata and save it to Swift. More...
 
 authTokenHeaders (array $creds)
 
 convertSwiftDate ( $ts, $format=TS_MW)
 Convert dates like "Tue, 03 Jan 2012 22:01:04 GMT"/"2013-05-11T07:37:27.678360Z". More...
 
 createContainer ( $container, array $params)
 Create a Swift container. More...
 
 deleteContainer ( $container, array $params)
 Delete a Swift 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, $dir, array $params)
 
 doCopyInternal (array $params)
 
 doCreateInternal (array $params)
 
 doDeleteInternal (array $params)
 
 doDescribeInternal (array $params)
 
 doDirectoryExists ( $fullCont, $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 Stable to override. More...
 
 doGetFileXAttributes (array $params)
 
 doGetLocalCopyMulti (array $params)
 
 doMoveInternal (array $params)
 
 doPrepareInternal ( $fullCont, $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...
 
 doPublishInternal ( $fullCont, $dir, array $params)
 
 doSecureInternal ( $fullCont, $dir, array $params)
 
 doStoreInternal (array $params)
 
 doStreamFile (array $params)
 
 extractMetadataHeaders (array $headers)
 
 extractMutableContentHeaders (array $headers)
 Filter/normalize a header map to only include mutable "content-"/"x-content-" headers. More...
 
 getAuthentication ()
 
 getContainerStat ( $container, $bypassCache=false)
 Get a Swift container stat array, possibly from process cache. More...
 
 getMetadataFromHeaders (array $headers)
 
 getStatFromHeaders (array $rhdrs)
 
 headersFromParams (array $params)
 Get headers to send to Swift when reading a file based on a FileBackend params array, e.g. More...
 
 resolveContainerPath ( $container, $relStoragePath)
 Resolve a relative storage path, checking if it's allowed by the backend. More...
 
 setContainerAccess ( $container, array $readUsers, array $writeUsers)
 Set read/write permissions for a Swift container. More...
 
 storageUrl (array $creds, $container=null, $object=null)
 
- 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)
 
 doClearCache (array $paths=null)
 Clears any additional stat caches for storage paths Stable to override. More...
 
 doConcatenate (array $params)
 
 doGetFileSha1Base36 (array $params)
 
 doGetLocalReferenceMulti (array $params)
 
 doOperationsInternal (array $ops, array $opts)
 
 doPrepare (array $params)
 
 doPublish (array $params)
 
 doQuickOperationsInternal (array $ops, array $opts)
 
 doSecure (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 Stable to override. 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

array $authCreds
 
int $authErrorTimestamp = null
 UNIX timestamp. More...
 
int $authSessionTimestamp = 0
 UNIX timestamp. More...
 
int $authTTL
 TTL in seconds. More...
 
MapCacheLRU $containerStatCache
 Container stat cache. More...
 
MultiHttpClient $http
 
bool $isRGW = false
 Whether the server is an Ceph RGW. More...
 
array $readUsers
 Additional users (account:user) with read permissions on public containers. More...
 
string $rgwS3AccessKey
 S3 access key (RADOS Gateway) More...
 
string $rgwS3SecretKey
 S3 authentication key (RADOS Gateway) More...
 
array $secureReadUsers
 Additional users (account:user) with read permissions on private containers. More...
 
array $secureWriteUsers
 Additional users (account:user) with write permissions on private containers. More...
 
BagOStuff $srvCache
 
string $swiftAuthUrl
 Authentication base URL (without version) More...
 
string $swiftKey
 Secret key for user. More...
 
string $swiftStorageUrl
 Override of storage base URL. More...
 
string $swiftTempUrlKey
 Shared secret value for making temp URLs. More...
 
string $swiftUser
 Swift user (account:user) to authenticate as. More...
 
array $writeUsers
 Additional users (account:user) with write permissions on public containers. 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

 buildFileObjectListing (array $objects)
 Build a list of file objects, filtering out any directories and extracting any stat info if provided in $objects. More...
 
 getCredsCacheKey ( $username)
 Get the cache key for a container. More...
 
 objectListing ( $fullCont, $type, $limit, $after=null, $prefix=null, $delim=null)
 Get a list of objects under a container. 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 an OpenStack Swift (or Ceph RGW) based file backend.

StatusValue messages should avoid mentioning the Swift account name. Likewise, error suppression should be used to avoid path disclosure.

Since
1.19

Definition at line 36 of file SwiftFileBackend.php.

Constructor & Destructor Documentation

◆ __construct()

SwiftFileBackend::__construct ( array  $config)
See also
FileBackendStore::__construct()
Parameters
array$configParams include:
  • swiftAuthUrl : Swift authentication server URL
  • swiftUser : Swift user used by MediaWiki (account:username)
  • swiftKey : Swift authentication key for the above user
  • swiftAuthTTL : Swift authentication TTL (seconds)
  • swiftTempUrlKey : Swift "X-Account-Meta-Temp-URL-Key" value on the account. Do not set this until it has been set in the backend.
  • swiftStorageUrl : Swift storage URL (overrides that of the authentication response). This is useful to set if a TLS proxy is in use.
  • shardViaHashLevels : Map of container names to sharding config with:
    • base : base of hash characters, 16 or 36
    • levels : the number of hash levels (and digits)
    • repeat : hash subdirectories are prefixed with all the parent hash directory names (e.g. "a/ab/abc")
  • cacheAuthInfo : Whether to cache authentication tokens in APC, etc. If those are not available, then the main cache will be used. This is probably insecure in shared hosting environments.
  • rgwS3AccessKey : Rados Gateway S3 "access key" value on the account. Do not set this until it has been set in the backend. This is used for generating expiring pre-authenticated URLs. Only use this when using rgw and to work around http://tracker.newdream.net/issues/3454.
  • rgwS3SecretKey : Rados Gateway S3 "secret key" value on the account. Do not set this until it has been set in the backend. This is used for generating expiring pre-authenticated URLs. Only use this when using rgw and to work around http://tracker.newdream.net/issues/3454.
  • readUsers : Swift users with read access to public containers (account:username)
  • writeUsers : Swift users with write access to public containers (account:username)
  • secureReadUsers : Swift users with read access to private containers (account:username)
  • secureWriteUsers : Swift users with write access to private containers (account:username)
  • connTimeout : The HTTP connect timeout to use when connecting to Swift, in seconds.
  • reqTimeout : The HTTP request timeout to use when communicating with Swift, in seconds.

Reimplemented from FileBackendStore.

Definition at line 118 of file SwiftFileBackend.php.

Member Function Documentation

◆ addMissingHashMetadata()

SwiftFileBackend::addMissingHashMetadata ( array  $objHdrs,
  $path 
)
protected

Fill in any missing object metadata and save it to Swift.

Parameters
array$objHdrsObject response headers
string$pathStorage path to object
Returns
array New headers

Definition at line 761 of file SwiftFileBackend.php.

References $path, authTokenHeaders(), FileBackendStore\deleteFileCache(), extractMetadataHeaders(), extractMutableContentHeaders(), getAuthentication(), FileBackend\getLocalCopy(), FileBackend\getScopedFileLocks(), LockManager\LOCK_UW, FileBackend\newStatus(), FileBackendStore\resolveStoragePathReal(), FileBackend\scopedProfileSection(), and storageUrl().

Referenced by doGetFileStatMulti().

◆ authTokenHeaders()

SwiftFileBackend::authTokenHeaders ( array  $creds)
protected

◆ buildFileObjectListing()

SwiftFileBackend::buildFileObjectListing ( array  $objects)
private

Build a list of file objects, filtering out any directories and extracting any stat info if provided in $objects.

Parameters
stdClass[] | string[]$objectsList of stdClass items or object names
Returns
array List of (names,stat array or null) entries

Definition at line 1052 of file SwiftFileBackend.php.

References convertSwiftDate().

Referenced by getFileListPageInternal().

◆ convertSwiftDate()

SwiftFileBackend::convertSwiftDate (   $ts,
  $format = TS_MW 
)
protected

Convert dates like "Tue, 03 Jan 2012 22:01:04 GMT"/"2013-05-11T07:37:27.678360Z".

Dates might also come in like "2013-05-11T07:37:27.678360" from Swift listings, missing the timezone suffix (though Ceph RGW does not appear to have this bug).

Parameters
string$ts
int$formatOutput format (TS_* constant)
Returns
string
Exceptions
FileBackendError

Definition at line 744 of file SwiftFileBackend.php.

Referenced by buildFileObjectListing(), and getStatFromHeaders().

◆ createContainer()

SwiftFileBackend::createContainer (   $container,
array  $params 
)
protected

Create a Swift container.

Parameters
string$containerContainer name
array$params
Returns
StatusValue

Definition at line 1497 of file SwiftFileBackend.php.

References $readUsers, $writeUsers, authTokenHeaders(), getAuthentication(), FileBackend\newStatus(), onError(), and storageUrl().

Referenced by doPrepareInternal().

◆ deleteContainer()

SwiftFileBackend::deleteContainer (   $container,
array  $params 
)
protected

Delete a Swift container.

Parameters
string$containerContainer name
array$params
Returns
StatusValue

Definition at line 1545 of file SwiftFileBackend.php.

References authTokenHeaders(), getAuthentication(), FileBackend\newStatus(), onError(), and storageUrl().

Referenced by doCleanInternal().

◆ directoriesAreVirtual()

SwiftFileBackend::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 1308 of file SwiftFileBackend.php.

◆ doCleanInternal()

SwiftFileBackend::doCleanInternal (   $container,
  $dir,
array  $params 
)
protected
See also
FileBackendStore::doClean() Stable to override
Parameters
string$container
string$dir
array$params
Returns
StatusValue

Reimplemented from FileBackendStore.

Definition at line 698 of file SwiftFileBackend.php.

References deleteContainer(), getContainerStat(), and FileBackend\newStatus().

◆ doCopyInternal()

SwiftFileBackend::doCopyInternal ( array  $params)
protected

◆ doCreateInternal()

SwiftFileBackend::doCreateInternal ( array  $params)
protected

◆ doDeleteInternal()

SwiftFileBackend::doDeleteInternal ( array  $params)
protected

◆ doDescribeInternal()

SwiftFileBackend::doDescribeInternal ( array  $params)
protected

◆ doDirectoryExists()

SwiftFileBackend::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 873 of file SwiftFileBackend.php.

References FileBackendStore\$RES_ERROR, and objectListing().

◆ doExecuteOpHandlesInternal()

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

Reimplemented from FileBackendStore.

Definition at line 1329 of file SwiftFileBackend.php.

References $s, authTokenHeaders(), getAuthentication(), FileBackend\newStatus(), and storageUrl().

◆ doGetFileContentsMulti()

SwiftFileBackend::doGetFileContentsMulti ( array  $params)
protected
See also
FileBackendStore::getFileContentsMulti() Stable to override
Parameters
array$params
Returns
string[]|bool[]|null[] Map of (path => string, false (missing), or null (error))

Reimplemented from FileBackendStore.

Definition at line 815 of file SwiftFileBackend.php.

References $content, $path, FileBackendStore\$RES_ABSENT, FileBackendStore\$RES_ERROR, authTokenHeaders(), getAuthentication(), headersFromParams(), onError(), FileBackendStore\resolveStoragePathReal(), and storageUrl().

◆ doGetFileSha1base36()

SwiftFileBackend::doGetFileSha1base36 ( array  $params)
protected

◆ doGetFileStat()

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

Reimplemented from FileBackendStore.

Definition at line 726 of file SwiftFileBackend.php.

References doGetFileStatMulti().

Referenced by doDescribeInternal().

◆ doGetFileStatMulti()

SwiftFileBackend::doGetFileStatMulti ( array  $params)
protected

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

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

Reimplemented from FileBackendStore.

Definition at line 1644 of file SwiftFileBackend.php.

References $path, FileBackendStore\$RES_ABSENT, FileBackendStore\$RES_ERROR, addMissingHashMetadata(), authTokenHeaders(), getAuthentication(), getContainerStat(), getStatFromHeaders(), headersFromParams(), onError(), FileBackendStore\resolveStoragePathReal(), and storageUrl().

Referenced by doGetFileStat().

◆ doGetFileXAttributes()

SwiftFileBackend::doGetFileXAttributes ( array  $params)
protected
See also
FileBackendStore::getFileXAttributes() Stable to override
Parameters
array$params
Returns
array[][]|false|null Attributes, false (missing file), or null (error)

Reimplemented from FileBackendStore.

Definition at line 1088 of file SwiftFileBackend.php.

References FileBackendStore\$RES_ABSENT, FileBackendStore\$RES_ERROR, FileBackendStore\clearCache(), and FileBackendStore\getFileStat().

◆ doGetLocalCopyMulti()

SwiftFileBackend::doGetLocalCopyMulti ( array  $params)
protected

◆ doMoveInternal()

SwiftFileBackend::doMoveInternal ( array  $params)
protected

◆ doPrepareInternal()

SwiftFileBackend::doPrepareInternal (   $container,
  $dir,
array  $params 
)
protected
See also
FileBackendStore::doPrepare() Stable to override
Parameters
string$container
string$dir
array$params
Returns
StatusValue

Reimplemented from FileBackendStore.

Definition at line 625 of file SwiftFileBackend.php.

References createContainer(), getContainerStat(), and FileBackend\newStatus().

◆ doPrimeContainerCache()

SwiftFileBackend::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. Stable to override

Parameters
array$containerInfoMap of resolved container names to cached info

Reimplemented from FileBackendStore.

Definition at line 1638 of file SwiftFileBackend.php.

◆ doPublishInternal()

SwiftFileBackend::doPublishInternal (   $container,
  $dir,
array  $params 
)
protected
See also
FileBackendStore::doPublish() Stable to override
Parameters
string$container
string$dir
array$params
Returns
StatusValue

Reimplemented from FileBackendStore.

Definition at line 674 of file SwiftFileBackend.php.

References $readUsers, $writeUsers, getContainerStat(), FileBackend\newStatus(), and setContainerAccess().

◆ doSecureInternal()

SwiftFileBackend::doSecureInternal (   $container,
  $dir,
array  $params 
)
protected
See also
FileBackendStore::doSecure() Stable to override
Parameters
string$container
string$dir
array$params
Returns
StatusValue

Reimplemented from FileBackendStore.

Definition at line 648 of file SwiftFileBackend.php.

References $readUsers, $writeUsers, getContainerStat(), FileBackend\newStatus(), and setContainerAccess().

◆ doStoreInternal()

SwiftFileBackend::doStoreInternal ( array  $params)
protected

◆ doStreamFile()

◆ extractMetadataHeaders()

SwiftFileBackend::extractMetadataHeaders ( array  $headers)
protected
See also
https://docs.openstack.org/api-ref/object-store
Parameters
string[]$headersMap of (header => value) for a swift object
Returns
string[] Map of (metadata header name => metadata value)

Definition at line 230 of file SwiftFileBackend.php.

References FileBackend\$name.

Referenced by addMissingHashMetadata(), and getMetadataFromHeaders().

◆ extractMutableContentHeaders()

SwiftFileBackend::extractMutableContentHeaders ( array  $headers)
protected

Filter/normalize a header map to only include mutable "content-"/"x-content-" headers.

Mutable headers can be changed via HTTP POST even if the file content is the same

See also
https://docs.openstack.org/api-ref/object-store
Parameters
string[]$headersMap of (header => value) for a swift object
Returns
string[] Map of (header => value) for Content-* headers mutable via POST

Definition at line 195 of file SwiftFileBackend.php.

References FileBackend\$name.

Referenced by addMissingHashMetadata(), doCopyInternal(), doCreateInternal(), doDescribeInternal(), doMoveInternal(), doStoreInternal(), and getStatFromHeaders().

◆ getAuthentication()

◆ getContainerStat()

SwiftFileBackend::getContainerStat (   $container,
  $bypassCache = false 
)
protected

Get a Swift container stat array, possibly from process cache.

Use $reCache if the file count or byte count is needed.

Parameters
string$containerContainer name
bool$bypassCacheBypass all caches and load from Swift
Returns
array|bool|null False on 404, null on failure

Definition at line 1445 of file SwiftFileBackend.php.

References FileBackendStore\$RES_ABSENT, FileBackendStore\$RES_ERROR, authTokenHeaders(), getAuthentication(), onError(), FileBackendStore\primeContainerCache(), FileBackend\scopedProfileSection(), FileBackendStore\setContainerCache(), and storageUrl().

Referenced by doCleanInternal(), doGetFileStatMulti(), doPrepareInternal(), doPublishInternal(), doSecureInternal(), doStreamFile(), and isPathUsableInternal().

◆ getCredsCacheKey()

SwiftFileBackend::getCredsCacheKey (   $username)
private

Get the cache key for a container.

Parameters
string$username
Returns
string

Definition at line 1817 of file SwiftFileBackend.php.

Referenced by getAuthentication(), and onError().

◆ getDirectoryListInternal()

SwiftFileBackend::getDirectoryListInternal (   $fullCont,
  $dir,
array  $params 
)
See also
FileBackendStore::getDirectoryListInternal()
Parameters
string$fullCont
string$dir
array$params
Returns
SwiftFileBackendDirList

Reimplemented from FileBackendStore.

Definition at line 890 of file SwiftFileBackend.php.

◆ getDirListPageInternal()

SwiftFileBackend::getDirListPageInternal (   $fullCont,
  $dir,
$after,
  $limit,
array  $params 
)

Do not call this function outside of SwiftFileBackendFileList.

Parameters
string$fullContResolved container name
string$dirResolved storage directory with no trailing slash
string | null&$afterResolved container relative path to list items after
int$limitMax number of items to list
array$paramsParameters for getDirectoryList()
Returns
array List of container relative resolved paths of directories directly under $dir
Exceptions
FileBackendError

Definition at line 916 of file SwiftFileBackend.php.

References $dirs, $path, objectListing(), and FileBackend\scopedProfileSection().

◆ getFeatures()

SwiftFileBackend::getFeatures ( )

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

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

Reimplemented from FileBackend.

Definition at line 159 of file SwiftFileBackend.php.

◆ getFileHttpUrl()

SwiftFileBackend::getFileHttpUrl ( array  $params)
See also
FileBackend::getFileHttpUrl() Stable to override
Parameters
array$params
Returns
string|null

Reimplemented from FileBackendStore.

Definition at line 1254 of file SwiftFileBackend.php.

References getAuthentication(), FileBackendStore\resolveStoragePathReal(), and storageUrl().

◆ getFileListInternal()

SwiftFileBackend::getFileListInternal (   $fullCont,
  $dir,
array  $params 
)
See also
FileBackendStore::getFileListInternal()
Parameters
string$fullCont
string$dir
array$params
Returns
SwiftFileBackendFileList

Reimplemented from FileBackendStore.

Definition at line 901 of file SwiftFileBackend.php.

◆ getFileListPageInternal()

SwiftFileBackend::getFileListPageInternal (   $fullCont,
  $dir,
$after,
  $limit,
array  $params 
)

Do not call this function outside of SwiftFileBackendFileList.

Parameters
string$fullContResolved container name
string$dirResolved storage directory with no trailing slash
string | null&$afterResolved container relative path of file to list items after
int$limitMax number of items to list
array$paramsParameters for getDirectoryList()
Returns
array List of resolved container relative paths of files under $dir
Exceptions
FileBackendError

Definition at line 999 of file SwiftFileBackend.php.

References buildFileObjectListing(), objectListing(), and FileBackend\scopedProfileSection().

◆ getMetadataFromHeaders()

SwiftFileBackend::getMetadataFromHeaders ( array  $headers)
protected
See also
https://docs.openstack.org/api-ref/object-store
Parameters
string[]$headersMap of (header => value) for a swift object
Returns
string[] Map of (metadata key name => metadata value)

Definition at line 247 of file SwiftFileBackend.php.

References FileBackend\$name, and extractMetadataHeaders().

Referenced by getStatFromHeaders().

◆ getStatFromHeaders()

SwiftFileBackend::getStatFromHeaders ( array  $rhdrs)
protected
Parameters
array$rhdrs
Returns
array

Definition at line 1705 of file SwiftFileBackend.php.

References convertSwiftDate(), extractMutableContentHeaders(), and getMetadataFromHeaders().

Referenced by doGetFileStatMulti(), and doGetLocalCopyMulti().

◆ headersFromParams()

SwiftFileBackend::headersFromParams ( array  $params)
protected

Get headers to send to Swift when reading a file based on a FileBackend params array, e.g.

that of getLocalCopy(). $params is currently only checked for a 'latest' flag.

Parameters
array$params
Returns
array

Definition at line 1320 of file SwiftFileBackend.php.

Referenced by doGetFileContentsMulti(), doGetFileStatMulti(), doGetLocalCopyMulti(), and doStreamFile().

◆ isPathUsableInternal()

SwiftFileBackend::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 177 of file SwiftFileBackend.php.

References getContainerStat(), and FileBackendStore\resolveStoragePathReal().

◆ loadListingStatInternal()

SwiftFileBackend::loadListingStatInternal (   $path,
array  $val 
)

Do not call this function outside of SwiftFileBackendFileList.

Parameters
string$pathStorage path
array$valStat value

Definition at line 1084 of file SwiftFileBackend.php.

References $path.

◆ objectListing()

SwiftFileBackend::objectListing (   $fullCont,
  $type,
  $limit,
  $after = null,
  $prefix = null,
  $delim = null 
)
private

Get a list of objects under a container.

Either just the names or a list of stdClass objects with details can be returned.

Parameters
string$fullCont
string$type('info' for a list of object detail maps, 'names' for names only)
int$limit
string | null$after
string | null$prefix
string | null$delim
Returns
StatusValue With the list as value

Definition at line 1587 of file SwiftFileBackend.php.

References $type, authTokenHeaders(), FormatJson\decode(), getAuthentication(), FileBackend\newStatus(), onError(), and storageUrl().

Referenced by doDirectoryExists(), getDirListPageInternal(), and getFileListPageInternal().

◆ onError()

SwiftFileBackend::onError (   $status,
  $func,
array  $params,
  $err = '',
  $code = 0,
  $desc = '' 
)

Log an unexpected exception for this backend.

This also sets the StatusValue object to have a fatal error.

Parameters
StatusValue | null$status
string$func
array$params
string$errError string
int$codeHTTP status
string$descHTTP StatusValue description

Definition at line 1832 of file SwiftFileBackend.php.

References FormatJson\encode(), and getCredsCacheKey().

Referenced by createContainer(), deleteContainer(), doCopyInternal(), doCreateInternal(), doDeleteInternal(), doDescribeInternal(), doGetFileContentsMulti(), doGetFileStatMulti(), doGetLocalCopyMulti(), doMoveInternal(), doStoreInternal(), doStreamFile(), getAuthentication(), getContainerStat(), and objectListing().

◆ resolveContainerPath()

SwiftFileBackend::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). Stable to override

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 167 of file SwiftFileBackend.php.

◆ setContainerAccess()

SwiftFileBackend::setContainerAccess (   $container,
array  $readUsers,
array  $writeUsers 
)
protected

Set read/write permissions for a Swift container.

See also
http://docs.openstack.org/developer/swift/misc.html#acls

In general, we don't allow listings to end-users. It's not useful, isn't well-defined (lists are truncated to 10000 item with no way to page), and is just a performance risk.

Parameters
string$containerResolved Swift container
array$readUsersList of the possible criteria for a request to have access to read a container. Each item is one of the following formats:
  • account:user : Grants access if the request is by the given user
  • ".r:<regex>" : Grants access if the request is from a referrer host that matches the expression and the request is not for a listing. Setting this to '*' effectively makes a container public. -".rlistings:<regex>" : Grants access if the request is from a referrer host that matches the expression and the request is for a listing.
array$writeUsersA list of the possible criteria for a request to have access to write to a container. Each item is of the following format:
  • account:user : Grants access if the request is by the given user
Returns
StatusValue

Definition at line 1409 of file SwiftFileBackend.php.

References $readUsers, $writeUsers, authTokenHeaders(), getAuthentication(), FileBackend\newStatus(), and storageUrl().

Referenced by doPublishInternal(), and doSecureInternal().

◆ storageUrl()

SwiftFileBackend::storageUrl ( array  $creds,
  $container = null,
  $object = null 
)
protected

Member Data Documentation

◆ $authCreds

array SwiftFileBackend::$authCreds
protected

Definition at line 71 of file SwiftFileBackend.php.

Referenced by getAuthentication().

◆ $authErrorTimestamp

int SwiftFileBackend::$authErrorTimestamp = null
protected

UNIX timestamp.

Definition at line 75 of file SwiftFileBackend.php.

◆ $authSessionTimestamp

int SwiftFileBackend::$authSessionTimestamp = 0
protected

UNIX timestamp.

Definition at line 73 of file SwiftFileBackend.php.

Referenced by getAuthentication().

◆ $authTTL

int SwiftFileBackend::$authTTL
protected

TTL in seconds.

Definition at line 40 of file SwiftFileBackend.php.

◆ $containerStatCache

MapCacheLRU SwiftFileBackend::$containerStatCache
protected

Container stat cache.

Definition at line 68 of file SwiftFileBackend.php.

◆ $http

MultiHttpClient SwiftFileBackend::$http
protected

Definition at line 38 of file SwiftFileBackend.php.

◆ $isRGW

bool SwiftFileBackend::$isRGW = false
protected

Whether the server is an Ceph RGW.

Definition at line 78 of file SwiftFileBackend.php.

◆ $readUsers

array SwiftFileBackend::$readUsers
protected

Additional users (account:user) with read permissions on public containers.

Definition at line 56 of file SwiftFileBackend.php.

Referenced by createContainer(), doPublishInternal(), doSecureInternal(), and setContainerAccess().

◆ $rgwS3AccessKey

string SwiftFileBackend::$rgwS3AccessKey
protected

S3 access key (RADOS Gateway)

Definition at line 52 of file SwiftFileBackend.php.

◆ $rgwS3SecretKey

string SwiftFileBackend::$rgwS3SecretKey
protected

S3 authentication key (RADOS Gateway)

Definition at line 54 of file SwiftFileBackend.php.

◆ $secureReadUsers

array SwiftFileBackend::$secureReadUsers
protected

Additional users (account:user) with read permissions on private containers.

Definition at line 60 of file SwiftFileBackend.php.

◆ $secureWriteUsers

array SwiftFileBackend::$secureWriteUsers
protected

Additional users (account:user) with write permissions on private containers.

Definition at line 62 of file SwiftFileBackend.php.

◆ $srvCache

BagOStuff SwiftFileBackend::$srvCache
protected

Definition at line 65 of file SwiftFileBackend.php.

◆ $swiftAuthUrl

string SwiftFileBackend::$swiftAuthUrl
protected

Authentication base URL (without version)

Definition at line 42 of file SwiftFileBackend.php.

◆ $swiftKey

string SwiftFileBackend::$swiftKey
protected

Secret key for user.

Definition at line 48 of file SwiftFileBackend.php.

◆ $swiftStorageUrl

string SwiftFileBackend::$swiftStorageUrl
protected

Override of storage base URL.

Definition at line 44 of file SwiftFileBackend.php.

◆ $swiftTempUrlKey

string SwiftFileBackend::$swiftTempUrlKey
protected

Shared secret value for making temp URLs.

Definition at line 50 of file SwiftFileBackend.php.

◆ $swiftUser

string SwiftFileBackend::$swiftUser
protected

Swift user (account:user) to authenticate as.

Definition at line 46 of file SwiftFileBackend.php.

◆ $writeUsers

array SwiftFileBackend::$writeUsers
protected

Additional users (account:user) with write permissions on public containers.

Definition at line 58 of file SwiftFileBackend.php.

Referenced by createContainer(), doPublishInternal(), doSecureInternal(), and setContainerAccess().


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