MediaWiki REL1_33
|
Class for an OpenStack Swift (or Ceph RGW) based file backend. More...
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. | |
getFeatures () | |
Get the a bitfield of extra features supported by the backend medium. | |
getFileHttpUrl (array $params) | |
getFileListInternal ( $fullCont, $dir, array $params) | |
getFileListPageInternal ( $fullCont, $dir, &$after, $limit, array $params) | |
Do not call this function outside of SwiftFileBackendFileList. | |
isPathUsableInternal ( $storagePath) | |
Check if a file can be created or changed at a given storage path. | |
loadListingStatInternal ( $path, array $val) | |
Do not call this function outside of SwiftFileBackendFileList. | |
onError ( $status, $func, array $params, $err='', $code=0, $desc='') | |
Log an unexpected exception for this backend. | |
Public Member Functions inherited from FileBackendStore | |
clearCache (array $paths=null) | |
Invalidate any in-process file stat and property cache. | |
concatenate (array $params) | |
Concatenate a list of storage files into a single file system file. | |
copyInternal (array $params) | |
Copy a file from one storage path to another in the backend. | |
createInternal (array $params) | |
Create a file in the backend with the given contents. | |
deleteInternal (array $params) | |
Delete a file at the storage path. | |
describeInternal (array $params) | |
Alter metadata for a file at the storage path. | |
directoryExists (array $params) | |
Check if a directory exists at a given storage path. | |
executeOpHandlesInternal (array $fileOpHandles) | |
Execute a list of FileBackendStoreOpHandle handles in parallel. | |
fileExists (array $params) | |
Check if a file exists at a storage path in the backend. | |
getDirectoryList (array $params) | |
Get an iterator to list all directories under a storage directory. | |
getFileContentsMulti (array $params) | |
Like getFileContents() except it takes an array of storage paths and returns a map of storage paths to strings (or null on failure). | |
getFileList (array $params) | |
Get an iterator to list all stored files under a storage directory. | |
getFileProps (array $params) | |
Get the properties of the file at a storage path in the backend. | |
getFileSha1Base36 (array $params) | |
Get a SHA-1 hash of the file at a storage path in the backend. | |
getFileSize (array $params) | |
Get the size (bytes) of a file at a storage path in the backend. | |
getFileStat (array $params) | |
Get quick information about a file at a storage path in the backend. | |
getFileTimestamp (array $params) | |
Get the last-modified timestamp of the file at a storage path. | |
getFileXAttributes (array $params) | |
Get metadata about a file at a storage path in the backend. | |
getLocalCopyMulti (array $params) | |
Like getLocalCopy() except it takes an array of storage paths and returns a map of storage paths to TempFSFile objects (or null on failure). | |
getLocalReferenceMulti (array $params) | |
Like getLocalReference() except it takes an array of storage paths and returns a map of storage paths to FSFile objects (or null on failure). | |
getOperationsInternal (array $ops) | |
Return a list of FileOp objects from a list of operations. | |
getPathsToLockForOpsInternal (array $performOps) | |
Get a list of storage paths to lock for a list of operations Returns an array with LockManager::LOCK_UW (shared locks) and LockManager::LOCK_EX (exclusive locks) keys, each corresponding to a list of storage paths to be locked. | |
getScopedLocksForOps (array $ops, StatusValue $status) | |
Get an array of scoped locks needed for a batch of file operations. | |
isSingleShardPathInternal ( $storagePath) | |
Check if a storage path maps to a single shard. | |
maxFileSizeInternal () | |
Get the maximum allowable file size given backend medium restrictions and basic performance constraints. | |
moveInternal (array $params) | |
Move a file from one storage path to another in the backend. | |
nullInternal (array $params) | |
No-op file operation that does nothing. | |
preloadCache (array $paths) | |
Preload persistent file stat cache and property cache into in-process cache. | |
preloadFileStat (array $params) | |
Preload file stat information (concurrently if possible) into in-process cache. | |
storeInternal (array $params) | |
Store a file into the backend from a file on disk. | |
streamFile (array $params) | |
Stream the file at a storage path in the backend. | |
Public Member Functions inherited from FileBackend | |
clean (array $params) | |
Delete a storage directory if it is empty. | |
copy (array $params, array $opts=[]) | |
Performs a single copy operation. | |
create (array $params, array $opts=[]) | |
Performs a single create operation. | |
delete (array $params, array $opts=[]) | |
Performs a single delete operation. | |
describe (array $params, array $opts=[]) | |
Performs a single describe operation. | |
doOperation (array $op, array $opts=[]) | |
Same as doOperations() except it takes a single operation. | |
doOperations (array $ops, array $opts=[]) | |
This is the main entry point into the backend for write operations. | |
doQuickOperation (array $op) | |
Same as doQuickOperations() except it takes a single operation. | |
doQuickOperations (array $ops, array $opts=[]) | |
Perform a set of independent file operations on some files. | |
getContainerStoragePath ( $container) | |
Get the storage path for the given container for this backend. | |
getDomainId () | |
Get the domain identifier used for this backend (possibly empty). | |
getFileContents (array $params) | |
Get the contents of a file at a storage path in the backend. | |
getJournal () | |
Get the file journal object for this backend. | |
getLocalCopy (array $params) | |
Get a local copy on disk of the file at a storage path in the backend. | |
getLocalReference (array $params) | |
Returns a file system file, identical to the file at a storage path. | |
getName () | |
Get the unique backend name. | |
getReadOnlyReason () | |
Get an explanatory message if this backend is read-only. | |
getRootStoragePath () | |
Get the root storage path of this backend. | |
getScopedFileLocks (array $paths, $type, StatusValue $status, $timeout=0) | |
Lock the files at the given storage paths in the backend. | |
getTopDirectoryList (array $params) | |
Same as FileBackend::getDirectoryList() except only lists directories that are immediately under the given directory. | |
getTopFileList (array $params) | |
Same as FileBackend::getFileList() except only lists files that are immediately under the given directory. | |
getWikiId () | |
Alias to getDomainId() | |
hasFeatures ( $bitfield) | |
Check if the backend medium supports a field of extra features. | |
isReadOnly () | |
Check if this backend is read-only. | |
lockFiles (array $paths, $type, $timeout=0) | |
Lock the files at the given storage paths in the backend. | |
move (array $params, array $opts=[]) | |
Performs a single move operation. | |
prepare (array $params) | |
Prepare a storage directory for usage. | |
publish (array $params) | |
Remove measures to block web access to a storage directory and the container it belongs to. | |
quickCopy (array $params) | |
Performs a single quick copy operation. | |
quickCreate (array $params) | |
Performs a single quick create operation. | |
quickDelete (array $params) | |
Performs a single quick delete operation. | |
quickDescribe (array $params) | |
Performs a single quick describe operation. | |
quickMove (array $params) | |
Performs a single quick move operation. | |
quickStore (array $params) | |
Performs a single quick store operation. | |
secure (array $params) | |
Take measures to block web access to a storage directory and the container it belongs to. | |
setLogger (LoggerInterface $logger) | |
store (array $params, array $opts=[]) | |
Performs a single store operation. | |
unlockFiles (array $paths, $type) | |
Unlock the files at the given storage paths in the backend. | |
Protected Member Functions | |
addMissingHashMetadata (array $objHdrs, $path) | |
Fill in any missing object metadata and save it to Swift. | |
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". | |
createContainer ( $container, array $params) | |
Create a Swift container. | |
deleteContainer ( $container, array $params) | |
Delete a Swift container. | |
directoriesAreVirtual () | |
Is this a key/value store where directories are just virtual? Virtual directories exists in so much as files exists that are prefixed with the directory path followed by a forward slash. | |
doCleanInternal ( $fullCont, $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. | |
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. | |
doPublishInternal ( $fullCont, $dir, array $params) | |
doSecureInternal ( $fullCont, $dir, array $params) | |
doStoreInternal (array $params) | |
doStreamFile (array $params) | |
getAuthentication () | |
getContainerStat ( $container, $bypassCache=false) | |
Get a Swift container stat array, possibly from process cache. | |
getCustomHeaders (array $rawHeaders) | |
getMetadata (array $rawHeaders) | |
getMetadataHeaders (array $rawHeaders) | |
getStatFromHeaders (array $rhdrs) | |
headersFromParams (array $params) | |
Get headers to send to Swift when reading a file based on a FileBackend params array, e.g. | |
resolveContainerPath ( $container, $relStoragePath) | |
Resolve a relative storage path, checking if it's allowed by the backend. | |
sanitizeHdrs (array $params) | |
Sanitize and filter the custom headers from a $params array. | |
sanitizeHdrsStrict (array $params) | |
Sanitize and filter the custom headers from a $params array. | |
setContainerAccess ( $container, array $readUsers, array $writeUsers) | |
Set read/write permissions for a Swift container. | |
storageUrl (array $creds, $container=null, $object=null) | |
Protected Member Functions inherited from FileBackendStore | |
deleteContainerCache ( $container) | |
Delete the cached info for a container. | |
deleteFileCache ( $path) | |
Delete the cached stat info for a file path. | |
doClean (array $params) | |
doClearCache (array $paths=null) | |
Clears any additional stat caches for storage paths. | |
doConcatenate (array $params) | |
doGetFileSha1Base36 (array $params) | |
doGetLocalReferenceMulti (array $params) | |
doOperationsInternal (array $ops, array $opts) | |
doPrepare (array $params) | |
doPublish (array $params) | |
doQuickOperationsInternal (array $ops) | |
doSecure (array $params) | |
fullContainerName ( $container) | |
Get the full container name, including the wiki ID prefix. | |
getContainerHashLevels ( $container) | |
Get the sharding config for a container. | |
getContainerShard ( $container, $relPath) | |
Get the container name shard suffix for a given path. | |
getContainerSuffixes ( $container) | |
Get a list of full container shard suffixes for a container. | |
getContentType ( $storagePath, $content, $fsPath) | |
Get the content type to use in HEAD/GET requests for a file. | |
primeContainerCache (array $items) | |
Do a batch lookup from cache for container stats for all containers used in a list of container names or storage paths objects. | |
primeFileCache (array $items) | |
Do a batch lookup from cache for file stats for all paths used in a list of storage paths or FileOp objects. | |
resolveContainerName ( $container) | |
Resolve a container name, checking if it's allowed by the backend. | |
resolveStoragePath ( $storagePath) | |
Splits a storage path into an internal container name, an internal relative file name, and a container shard suffix. | |
resolveStoragePathReal ( $storagePath) | |
Like resolveStoragePath() except null values are returned if the container is sharded and the shard could not be determined or if the path ends with '/'. | |
sanitizeOpHeaders (array $op) | |
Normalize and filter HTTP headers from a file operation. | |
setConcurrencyFlags (array $opts) | |
Set the 'concurrency' option from a list of operation options. | |
setContainerCache ( $container, array $val) | |
Set the cached info for a container. | |
setFileCache ( $path, array $val) | |
Set the cached stat info for a file path. | |
Protected Member Functions inherited from FileBackend | |
newStatus () | |
Yields the result of the status wrapper callback on either: | |
resetOutputBuffer () | |
resolveFSFileObjects (array $ops) | |
Convert FSFile 'src' paths to string paths (with an 'srcRef' field set to the FSFile) | |
scopedProfileSection ( $section) | |
wrapStatus (StatusValue $sv) | |
Protected Attributes | |
array | $authCreds |
int | $authErrorTimestamp = null |
UNIX timestamp. | |
int | $authSessionTimestamp = 0 |
UNIX timestamp. | |
int | $authTTL |
TTL in seconds. | |
ProcessCacheLRU | $containerStatCache |
Container stat cache. | |
MultiHttpClient | $http |
bool | $isRGW = false |
Whether the server is an Ceph RGW. | |
array | $readUsers |
Additional users (account:user) with read permissions on public containers. | |
string | $rgwS3AccessKey |
S3 access key (RADOS Gateway) | |
string | $rgwS3SecretKey |
S3 authentication key (RADOS Gateway) | |
array | $secureReadUsers |
Additional users (account:user) with read permissions on private containers. | |
array | $secureWriteUsers |
Additional users (account:user) with write permissions on private containers. | |
BagOStuff | $srvCache |
string | $swiftAuthUrl |
Authentication base URL (without version) | |
string | $swiftKey |
Secret key for user. | |
string | $swiftStorageUrl |
Override of storage base URL. | |
string | $swiftTempUrlKey |
Shared secret value for making temp URLs. | |
string | $swiftUser |
Swift user (account:user) to authenticate as. | |
array | $writeUsers |
Additional users (account:user) with write permissions on public containers. | |
Protected Attributes inherited from FileBackendStore | |
MapCacheLRU | $cheapCache |
Map of paths to small (RAM/disk) cache items. | |
MapCacheLRU | $expensiveCache |
Map of paths to large (RAM/disk) cache items. | |
$maxFileSize = 4294967296 | |
WANObjectCache | $memCache |
callable | $mimeCallback |
Method to get the MIME type of files. | |
array | $shardViaHashLevels = [] |
Map of container names to sharding config. | |
BagOStuff | $srvCache |
Protected Attributes inherited from FileBackend | |
int | $concurrency |
How many operations can be done in parallel. | |
string | $domainId |
Unique domain name. | |
FileJournal | $fileJournal |
LockManager | $lockManager |
LoggerInterface | $logger |
string | $name |
Unique backend name. | |
callable | $obResetFunc |
string | $parallelize |
When to do operations in parallel. | |
callable null | $profiler |
string | $readOnly |
Read-only explanation message. | |
callable | $statusWrapper |
callable | $streamMimeFunc |
string | $tmpDirectory |
Temporary file directory. | |
Private Member Functions | |
buildFileObjectListing (array $params, $dir, array $objects) | |
Build a list of file objects, filtering out any directories and extracting any stat info if provided in $objects (for CF_Objects) | |
getCredsCacheKey ( $username) | |
Get the cache key for a container. | |
objectListing ( $fullCont, $type, $limit, $after=null, $prefix=null, $delim=null) | |
Get a list of objects under a container. | |
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. | |
static | isPathTraversalFree ( $path) |
Check if a relative path has no directory traversals. | |
static | isStoragePath ( $path) |
Check if a given path is a "mwstore://" path. | |
static | makeContentDisposition ( $type, $filename='') |
Build a Content-Disposition header value per RFC 6266. | |
static | normalizeStoragePath ( $storagePath) |
Normalize a storage path by cleaning up directory separators. | |
static | parentStoragePath ( $storagePath) |
Get the parent storage directory of a storage path. | |
static | splitStoragePath ( $storagePath) |
Split a storage path into a backend name, a container name, and a relative file path. | |
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. | |
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. | |
static | isValidShortContainerName ( $container) |
Check if a short container name is valid. | |
static | normalizeXAttributes (array $xattr) |
Normalize file headers/metadata to the FileBackend::getFileXAttributes() format. | |
Static Protected Member Functions inherited from FileBackend | |
static | normalizeContainerPath ( $path) |
Validate and normalize a relative storage path. | |
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.
Definition at line 34 of file SwiftFileBackend.php.
SwiftFileBackend::__construct | ( | array | $config | ) |
array | $config | Params include:
|
Reimplemented from FileBackendStore.
Definition at line 112 of file SwiftFileBackend.php.
|
protected |
Fill in any missing object metadata and save it to Swift.
array | $objHdrs | Object response headers |
string | $path | Storage path to object |
Definition at line 723 of file SwiftFileBackend.php.
References and(), authTokenHeaders(), FileBackendStore\deleteFileCache(), getAuthentication(), getCustomHeaders(), FileBackend\getLocalCopy(), getMetadataHeaders(), FileBackend\getScopedFileLocks(), http, list, FileBackend\newStatus(), FileBackendStore\resolveStoragePathReal(), FileBackend\scopedProfileSection(), and storageUrl().
Referenced by doGetFileStatMulti().
|
protected |
array | $creds | From getAuthentication() |
Definition at line 1760 of file SwiftFileBackend.php.
Referenced by addMissingHashMetadata(), createContainer(), deleteContainer(), doExecuteOpHandlesInternal(), doGetFileContentsMulti(), doGetFileStatMulti(), doGetLocalCopyMulti(), doStreamFile(), getContainerStat(), objectListing(), and setContainerAccess().
Build a list of file objects, filtering out any directories and extracting any stat info if provided in $objects (for CF_Objects)
array | $params | Parameters for getDirectoryList() |
string | $dir | Resolved container directory path |
array | $objects | List of CF_Object items or object names |
Definition at line 1003 of file SwiftFileBackend.php.
References and(), convertSwiftDate(), and null.
Referenced by getFileListPageInternal().
|
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).
string | $ts | |
int | $format | Output format (TS_* constant) |
FileBackendError |
Definition at line 706 of file SwiftFileBackend.php.
References $e.
Referenced by buildFileObjectListing(), and getStatFromHeaders().
|
protected |
Create a Swift container.
string | $container | Container name |
array | $params |
Definition at line 1442 of file SwiftFileBackend.php.
References $params, $readUsers, $writeUsers, and(), authTokenHeaders(), getAuthentication(), http, list, FileBackend\newStatus(), onError(), and storageUrl().
Referenced by doPrepareInternal().
|
protected |
Delete a Swift container.
string | $container | Container name |
array | $params |
Definition at line 1490 of file SwiftFileBackend.php.
References $params, and(), authTokenHeaders(), getAuthentication(), http, list, FileBackend\newStatus(), onError(), and storageUrl().
Referenced by doCleanInternal().
|
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.
Reimplemented from FileBackendStore.
Definition at line 1256 of file SwiftFileBackend.php.
|
protected |
string | $container | |
string | $dir | |
array | $params |
Reimplemented from FileBackendStore.
Definition at line 660 of file SwiftFileBackend.php.
References $params, and(), deleteContainer(), getContainerStat(), and FileBackend\newStatus().
|
protected |
array | $params |
Reimplemented from FileBackendStore.
Definition at line 384 of file SwiftFileBackend.php.
References $handler, $params, $request, and(), array(), FileBackendStore\executeOpHandlesInternal(), list, FileBackend\newStatus(), onError(), FileBackendStore\resolveStoragePathReal(), and sanitizeHdrsStrict().
|
protected |
array | $params |
Reimplemented from FileBackendStore.
Definition at line 271 of file SwiftFileBackend.php.
References $handler, $params, $request, and(), array(), FileBackendStore\executeOpHandlesInternal(), FileBackendStore\getContentType(), list, FileBackend\newStatus(), onError(), FileBackendStore\resolveStoragePathReal(), and sanitizeHdrsStrict().
|
protected |
array | $params |
Reimplemented from FileBackendStore.
Definition at line 491 of file SwiftFileBackend.php.
References $handler, $params, $request, and(), array(), FileBackendStore\executeOpHandlesInternal(), list, FileBackend\newStatus(), onError(), and FileBackendStore\resolveStoragePathReal().
|
protected |
array | $params |
Reimplemented from FileBackendStore.
Definition at line 531 of file SwiftFileBackend.php.
References $handler, $params, $request, $value, and(), array(), doGetFileStat(), FileBackendStore\executeOpHandlesInternal(), FileBackendStore\getFileStat(), list, FileBackend\newStatus(), onError(), FileBackendStore\resolveStoragePathReal(), and sanitizeHdrs().
|
protected |
string | $container | Resolved container name |
string | $dir | Resolved path relative to container |
array | $params |
Reimplemented from FileBackendStore.
Definition at line 826 of file SwiftFileBackend.php.
References objectListing().
|
protected |
FileBackendStoreOpHandle[] | $fileOpHandles |
Reimplemented from FileBackendStore.
Definition at line 1282 of file SwiftFileBackend.php.
References $req, $s, and(), authTokenHeaders(), getAuthentication(), http, list, FileBackend\newStatus(), and storageUrl().
|
protected |
array | $params |
Reimplemented from FileBackendStore.
Definition at line 777 of file SwiftFileBackend.php.
References $params, $path, and(), authTokenHeaders(), getAuthentication(), headersFromParams(), http, list, onError(), FileBackendStore\resolveStoragePathReal(), and storageUrl().
|
protected |
Definition at line 1054 of file SwiftFileBackend.php.
References $params, and FileBackendStore\getFileStat().
|
protected |
array | $params |
Reimplemented from FileBackendStore.
Definition at line 688 of file SwiftFileBackend.php.
References $params, and(), and doGetFileStatMulti().
Referenced by doDescribeInternal().
|
protected |
Get file stat information (concurrently if possible) for several files.
array | $params | Parameters include:
|
Reimplemented from FileBackendStore.
Definition at line 1588 of file SwiftFileBackend.php.
References $params, $path, addMissingHashMetadata(), and(), authTokenHeaders(), getAuthentication(), getContainerStat(), getStatFromHeaders(), headersFromParams(), http, list, onError(), FileBackendStore\resolveStoragePathReal(), and storageUrl().
Referenced by doGetFileStat().
|
protected |
array | $params |
Reimplemented from FileBackendStore.
Definition at line 1039 of file SwiftFileBackend.php.
References and(), FileBackendStore\clearCache(), and FileBackendStore\getFileStat().
|
protected |
array | $params |
Reimplemented from FileBackendStore.
Definition at line 1133 of file SwiftFileBackend.php.
References $ext, $params, $path, and(), authTokenHeaders(), FileBackend\extensionFromPath(), TempFSFile\factory(), getAuthentication(), getStatFromHeaders(), headersFromParams(), http, list, onError(), FileBackendStore\resolveStoragePathReal(), and storageUrl().
|
protected |
array | $params |
Reimplemented from FileBackendStore.
Definition at line 432 of file SwiftFileBackend.php.
References $handler, $params, $request, and(), array(), FileBackendStore\executeOpHandlesInternal(), list, FileBackend\newStatus(), onError(), FileBackendStore\resolveStoragePathReal(), and sanitizeHdrsStrict().
|
protected |
string | $container | |
string | $dir | |
array | $params |
Reimplemented from FileBackendStore.
Definition at line 587 of file SwiftFileBackend.php.
References $params, and(), createContainer(), getContainerStat(), and FileBackend\newStatus().
|
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.
array | $containerInfo | Map of resolved container names to cached info |
Reimplemented from FileBackendStore.
Definition at line 1582 of file SwiftFileBackend.php.
|
protected |
string | $container | |
string | $dir | |
array | $params |
Reimplemented from FileBackendStore.
Definition at line 636 of file SwiftFileBackend.php.
References $params, $readUsers, $writeUsers, and(), getContainerStat(), FileBackend\newStatus(), and setContainerAccess().
|
protected |
string | $container | |
string | $dir | |
array | $params |
Reimplemented from FileBackendStore.
Definition at line 610 of file SwiftFileBackend.php.
References $params, $readUsers, $writeUsers, and(), getContainerStat(), FileBackend\newStatus(), and setContainerAccess().
|
protected |
array | $params |
Reimplemented from FileBackendStore.
Definition at line 319 of file SwiftFileBackend.php.
References $handler, $params, $request, and(), array(), FileBackendStore\executeOpHandlesInternal(), FileBackendStore\getContentType(), list, FileBackend\newStatus(), onError(), FileBackendStore\resolveStoragePathReal(), and sanitizeHdrsStrict().
|
protected |
array | $params |
Reimplemented from FileBackendStore.
Definition at line 1067 of file SwiftFileBackend.php.
References $header, FileBackend\$obResetFunc, $params, and(), authTokenHeaders(), FileBackendStore\clearCache(), FileBackendStore\deleteFileCache(), FileBackendStore\fileExists(), getAuthentication(), getContainerStat(), headersFromParams(), http, list, FileBackend\newStatus(), onError(), FileBackendStore\resolveStoragePathReal(), StreamFile\send404Message(), storageUrl(), and StreamFile\STREAM_HEADLESS.
|
protected |
Definition at line 1677 of file SwiftFileBackend.php.
References $authCreds, $authSessionTimestamp, and(), getCredsCacheKey(), http, list, null, and onError().
Referenced by addMissingHashMetadata(), createContainer(), deleteContainer(), doExecuteOpHandlesInternal(), doGetFileContentsMulti(), doGetFileStatMulti(), doGetLocalCopyMulti(), doStreamFile(), getContainerStat(), getFileHttpUrl(), objectListing(), and setContainerAccess().
|
protected |
Get a Swift container stat array, possibly from process cache.
Use $reCache if the file count or byte count is needed.
string | $container | Container name |
bool | $bypassCache | Bypass all caches and load from Swift |
Definition at line 1391 of file SwiftFileBackend.php.
References and(), authTokenHeaders(), getAuthentication(), http, list, onError(), FileBackendStore\primeContainerCache(), FileBackend\scopedProfileSection(), FileBackendStore\setContainerCache(), and storageUrl().
Referenced by doCleanInternal(), doGetFileStatMulti(), doPrepareInternal(), doPublishInternal(), doSecureInternal(), doStreamFile(), and isPathUsableInternal().
|
private |
Get the cache key for a container.
string | $username |
Definition at line 1770 of file SwiftFileBackend.php.
References $username, and and().
Referenced by getAuthentication(), and onError().
|
protected |
array | $rawHeaders |
Definition at line 209 of file SwiftFileBackend.php.
References FileBackend\$name, $value, and and().
Referenced by addMissingHashMetadata(), sanitizeHdrs(), and sanitizeHdrsStrict().
SwiftFileBackend::getDirectoryListInternal | ( | $fullCont, | |
$dir, | |||
array | $params ) |
string | $fullCont | |
string | $dir | |
array | $params |
Reimplemented from FileBackendStore.
Definition at line 843 of file SwiftFileBackend.php.
References $params.
SwiftFileBackend::getDirListPageInternal | ( | $fullCont, | |
$dir, | |||
& | $after, | ||
$limit, | |||
array | $params ) |
Do not call this function outside of SwiftFileBackendFileList.
string | $fullCont | Resolved container name |
string | $dir | Resolved storage directory with no trailing slash |
string | null | &$after | Resolved container relative path to list items after |
int | $limit | Max number of items to list |
array | $params | Parameters for getDirectoryList() |
FileBackendError |
Definition at line 869 of file SwiftFileBackend.php.
References $params, $path, and(), false, objectListing(), and FileBackend\scopedProfileSection().
SwiftFileBackend::getFeatures | ( | ) |
Get the a bitfield of extra features supported by the backend medium.
Reimplemented from FileBackend.
Definition at line 145 of file SwiftFileBackend.php.
References FileBackend\ATTR_HEADERS, FileBackend\ATTR_METADATA, and FileBackend\ATTR_UNICODE_PATHS.
SwiftFileBackend::getFileHttpUrl | ( | array | $params | ) |
array | $params |
Reimplemented from FileBackendStore.
Definition at line 1202 of file SwiftFileBackend.php.
References $params, and(), getAuthentication(), list, FileBackendStore\resolveStoragePathReal(), and storageUrl().
SwiftFileBackend::getFileListInternal | ( | $fullCont, | |
$dir, | |||
array | $params ) |
string | $fullCont | |
string | $dir | |
array | $params |
Reimplemented from FileBackendStore.
Definition at line 854 of file SwiftFileBackend.php.
References $params.
SwiftFileBackend::getFileListPageInternal | ( | $fullCont, | |
$dir, | |||
& | $after, | ||
$limit, | |||
array | $params ) |
Do not call this function outside of SwiftFileBackendFileList.
string | $fullCont | Resolved container name |
string | $dir | Resolved storage directory with no trailing slash |
string | null | &$after | Resolved container relative path of file to list items after |
int | $limit | Max number of items to list |
array | $params | Parameters for getDirectoryList() |
FileBackendError |
Definition at line 949 of file SwiftFileBackend.php.
References $params, and(), buildFileObjectListing(), objectListing(), and FileBackend\scopedProfileSection().
|
protected |
array | $rawHeaders |
Definition at line 262 of file SwiftFileBackend.php.
References $value, and(), and getMetadataHeaders().
Referenced by getStatFromHeaders().
|
protected |
array | $rawHeaders |
Definition at line 246 of file SwiftFileBackend.php.
References FileBackend\$name, $value, and and().
Referenced by addMissingHashMetadata(), and getMetadata().
|
protected |
array | $rhdrs |
Definition at line 1656 of file SwiftFileBackend.php.
References and(), convertSwiftDate(), getMetadata(), and sanitizeHdrs().
Referenced by doGetFileStatMulti(), and doGetLocalCopyMulti().
|
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.
array | $params |
Definition at line 1268 of file SwiftFileBackend.php.
References $params, and and().
Referenced by doGetFileContentsMulti(), doGetFileStatMulti(), doGetLocalCopyMulti(), and doStreamFile().
SwiftFileBackend::isPathUsableInternal | ( | $storagePath | ) |
Check if a file can be created or changed at a given storage path.
FS backends should check if the parent directory exists, files can be written under it, and that any file already there is writable. Backends using key/value stores should check if the container exists.
string | $storagePath |
Reimplemented from FileBackendStore.
Definition at line 160 of file SwiftFileBackend.php.
References and(), getContainerStat(), list, and FileBackendStore\resolveStoragePathReal().
SwiftFileBackend::loadListingStatInternal | ( | $path, | |
array | $val ) |
Do not call this function outside of SwiftFileBackendFileList.
string | $path | Storage path |
array | $val | Stat value |
Definition at line 1035 of file SwiftFileBackend.php.
|
private |
Get a list of objects under a container.
Either just the names or a list of stdClass objects with details can be returned.
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 |
Definition at line 1531 of file SwiftFileBackend.php.
References $params, $query, $type, and(), authTokenHeaders(), getAuthentication(), http, list, FileBackend\newStatus(), onError(), and storageUrl().
Referenced by doDirectoryExists(), getDirListPageInternal(), and getFileListPageInternal().
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.
StatusValue | null | $status | |
string | $func | |
array | $params | |
string | $err | Error string |
int | $code | HTTP status |
string | $desc | HTTP StatusValue description |
Definition at line 1785 of file SwiftFileBackend.php.
References $code, $params, and(), and getCredsCacheKey().
Referenced by createContainer(), deleteContainer(), doCopyInternal(), doCreateInternal(), doDeleteInternal(), doDescribeInternal(), doGetFileContentsMulti(), doGetFileStatMulti(), doGetLocalCopyMulti(), doMoveInternal(), doStoreInternal(), doStreamFile(), getAuthentication(), getContainerStat(), and objectListing().
|
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).
string | $container | Container name |
string | $relStoragePath | Storage path relative to the container |
Reimplemented from FileBackendStore.
Definition at line 150 of file SwiftFileBackend.php.
References and().
|
protected |
Sanitize and filter the custom headers from a $params array.
Only allows certain "standard" Content- and X-Content- headers.
When POSTing data, libcurl adds Content-Type: application/x-www-form-urlencoded if Content-Type is not set, which overwrites the stored Content-Type header in Swift - therefore for POSTing data do not strip the Content-Type header (the previously-stored header that has been already read back from swift is sent)
array | $params |
Definition at line 199 of file SwiftFileBackend.php.
References $params, and(), and getCustomHeaders().
Referenced by doDescribeInternal(), and getStatFromHeaders().
|
protected |
Sanitize and filter the custom headers from a $params array.
Only allows certain "standard" Content- and X-Content- headers.
array | $params |
Definition at line 176 of file SwiftFileBackend.php.
References $params, and(), and getCustomHeaders().
Referenced by doCopyInternal(), doCreateInternal(), doMoveInternal(), and doStoreInternal().
Set read/write permissions for a Swift container.
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.
string | $container | Resolved Swift container |
array | $readUsers | List of the possible criteria for a request to have access to read a container. Each item is one of the following formats:
|
array | $writeUsers | A list of the possible criteria for a request to have access to write to a container. Each item is of the following format:
|
Definition at line 1355 of file SwiftFileBackend.php.
References $readUsers, $writeUsers, authTokenHeaders(), getAuthentication(), http, list, FileBackend\newStatus(), and storageUrl().
Referenced by doPublishInternal(), and doSecureInternal().
array | $creds | From getAuthentication() |
string | null | $container | |
string | null | $object |
Definition at line 1744 of file SwiftFileBackend.php.
References and().
Referenced by addMissingHashMetadata(), createContainer(), deleteContainer(), doExecuteOpHandlesInternal(), doGetFileContentsMulti(), doGetFileStatMulti(), doGetLocalCopyMulti(), doStreamFile(), getContainerStat(), getFileHttpUrl(), objectListing(), and setContainerAccess().
|
protected |
Definition at line 69 of file SwiftFileBackend.php.
Referenced by getAuthentication().
|
protected |
UNIX timestamp.
Definition at line 73 of file SwiftFileBackend.php.
|
protected |
UNIX timestamp.
Definition at line 71 of file SwiftFileBackend.php.
Referenced by getAuthentication().
|
protected |
TTL in seconds.
Definition at line 38 of file SwiftFileBackend.php.
|
protected |
Container stat cache.
Definition at line 66 of file SwiftFileBackend.php.
|
protected |
Definition at line 36 of file SwiftFileBackend.php.
|
protected |
Whether the server is an Ceph RGW.
Definition at line 76 of file SwiftFileBackend.php.
|
protected |
Additional users (account:user) with read permissions on public containers.
Definition at line 54 of file SwiftFileBackend.php.
Referenced by createContainer(), doPublishInternal(), doSecureInternal(), and setContainerAccess().
|
protected |
S3 access key (RADOS Gateway)
Definition at line 50 of file SwiftFileBackend.php.
|
protected |
S3 authentication key (RADOS Gateway)
Definition at line 52 of file SwiftFileBackend.php.
|
protected |
Additional users (account:user) with read permissions on private containers.
Definition at line 58 of file SwiftFileBackend.php.
|
protected |
Additional users (account:user) with write permissions on private containers.
Definition at line 60 of file SwiftFileBackend.php.
|
protected |
Definition at line 63 of file SwiftFileBackend.php.
|
protected |
Authentication base URL (without version)
Definition at line 40 of file SwiftFileBackend.php.
|
protected |
Secret key for user.
Definition at line 46 of file SwiftFileBackend.php.
|
protected |
Override of storage base URL.
Definition at line 42 of file SwiftFileBackend.php.
|
protected |
Shared secret value for making temp URLs.
Definition at line 48 of file SwiftFileBackend.php.
|
protected |
Swift user (account:user) to authenticate as.
Definition at line 44 of file SwiftFileBackend.php.
|
protected |
Additional users (account:user) with write permissions on public containers.
Definition at line 56 of file SwiftFileBackend.php.
Referenced by createContainer(), doPublishInternal(), doSecureInternal(), and setContainerAccess().