Class for an OpenStack Swift based file backend. More...

Inheritance diagram for SwiftFileBackend:

Collaboration diagram for SwiftFileBackend:

Public Member Functions
	__construct (array $config)
	doGetFileSha1base36 (array $params)
	getFileContents (array $params)
	getFileListInternal ($fullCont, $dir, array $params)
	getFileListPageInternal ($fullCont, $dir, $after, $limit)
	Do not call this function outside of SwiftFileBackendFileList.
	getLocalCopy (array $params)
	isPathUsableInternal ($storagePath)
Protected Member Functions
	addMissingMetadata (CF_Object $obj, $path)
	Fill in any missing object metadata and save it to Swift.
	createContainer ($container)
	Create a Swift container.
	deleteContainer ($container)
	Delete a Swift container.
	doCleanInternal ($fullCont, $dir, array $params)
	doClearCache (array $paths=null)
	doCopyInternal (array $params)
	doCreateInternal (array $params)
	doDeleteInternal (array $params)
	doGetFileStat (array $params)
	doPrepareInternal ($fullCont, $dir, array $params)
	doSecureInternal ($fullCont, $dir, array $params)
	doStoreInternal (array $params)
	doStreamFile (array $params)
	getConnection ()
	Get a connection to the Swift proxy.
	getContainer ($container, $reCache=false)
	Get a Swift container object, possibly from process cache.
	headersFromParams (array $params)
	Get headers to send to Swift when reading a file based on a FileBackend params array, e.g.
	logException (Exception $e, $func, array $params)
	Log an unexpected exception for this backend.
	resolveContainerPath ($container, $relStoragePath)
	setContainerAccess (CF_Container $contObj, array $readGrps, array $writeGrps)
	Set read/write permissions for a Swift container.
Protected Attributes
	$auth
	$authTTL
	$conn
	$connContainers = array()
	$connStarted = 0
	$maxContCacheSize = 100
	$swiftAnonUser

Detailed Description

Class for an OpenStack Swift based file backend.

This requires the SwiftCloudFiles MediaWiki extension, which includes the php-cloudfiles library (https://github.com/rackspace/php-cloudfiles). php-cloudfiles requires the curl, fileinfo, and mb_string PHP extensions.

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

Since:: 1.19

Definition at line 22 of file SwiftFileBackend.php.

Constructor & Destructor Documentation

SwiftFileBackend::__construct ( array $ config )

See also:: FileBackendStore::__construct() Additional $config params 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) swiftAnonUser : Swift user used for end-user requests (account:username) 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")

Reimplemented from FileBackend.

Definition at line 48 of file SwiftFileBackend.php.

Member Function Documentation

SwiftFileBackend::addMissingMetadata	(	CF_Object $	obj,
		$	path
	)		`[protected]`

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

Parameters:

$obj	CF_Object
$path	string Storage path to object

Returns:: bool Success

Exceptions:

Exception cloudfiles exceptions

Definition at line 479 of file SwiftFileBackend.php.

References $path, getLocalCopy(), FileBackend\getScopedFileLocks(), LockManager\LOCK_UW, and Status\newGood().

Referenced by doGetFileStat().

Here is the call graph for this function:

Here is the caller graph for this function:

SwiftFileBackend::createContainer ( $ container ) [protected]

Create a Swift container.

Parameters:

$container string Container name

Returns:: CF_Container

Definition at line 766 of file SwiftFileBackend.php.

References $conn, and getConnection().

Referenced by doPrepareInternal().

Here is the call graph for this function:

Here is the caller graph for this function:

SwiftFileBackend::deleteContainer ( $ container ) [protected]

Delete a Swift container.

Parameters:

$container string Container name

Returns:: void

Definition at line 779 of file SwiftFileBackend.php.

References $conn, and getConnection().

Referenced by doCleanInternal().

Here is the call graph for this function:

Here is the caller graph for this function:

SwiftFileBackend::doCleanInternal	(	$	fullCont,
		$	dir,
		array $	params
	)		`[protected]`

See also:: FileBackendStore::doCleanInternal()

Reimplemented from FileBackendStore.

Definition at line 398 of file SwiftFileBackend.php.

References $dir, deleteContainer(), getContainer(), logException(), and Status\newGood().

Here is the call graph for this function:

SwiftFileBackend::doClearCache ( array $ paths = null ) [protected]

See also:: FileBackendStore::doClearCache()

Reimplemented from FileBackendStore.

Definition at line 730 of file SwiftFileBackend.php.

SwiftFileBackend::doCopyInternal ( array $ params ) [protected]

See also:: FileBackendStore::doCopyInternal()

Reimplemented from FileBackendStore.

Definition at line 233 of file SwiftFileBackend.php.

References FileBackendStore\fileExists(), getContainer(), logException(), Status\newGood(), and FileBackendStore\resolveStoragePathReal().

Here is the call graph for this function:

SwiftFileBackend::doCreateInternal ( array $ params ) [protected]

See also:: FileBackendStore::doCreateInternal()

Reimplemented from FileBackendStore.

Definition at line 103 of file SwiftFileBackend.php.

References StreamFile\contentTypeFromPath(), FileBackendStore\fileExists(), getContainer(), logException(), Status\newGood(), FileBackendStore\resolveStoragePathReal(), and wfBaseConvert().

Here is the call graph for this function:

SwiftFileBackend::doDeleteInternal ( array $ params ) [protected]

See also:: FileBackendStore::doDeleteInternal()

Reimplemented from FileBackendStore.

Definition at line 288 of file SwiftFileBackend.php.

References getContainer(), logException(), Status\newGood(), and FileBackendStore\resolveStoragePathReal().

Here is the call graph for this function:

SwiftFileBackend::doGetFileSha1base36 ( array $ params )

See also:: FileBackendStore::doGetFileSha1base36()

Definition at line 563 of file SwiftFileBackend.php.

References FileBackendStore\getFileStat().

Here is the call graph for this function:

SwiftFileBackend::doGetFileStat ( array $ params ) [protected]

See also:: FileBackendStore::doFileExists()

Reimplemented from FileBackendStore.

Definition at line 442 of file SwiftFileBackend.php.

References addMissingMetadata(), getContainer(), headersFromParams(), logException(), FileBackendStore\resolveStoragePathReal(), and wfTimestamp().

Here is the call graph for this function:

SwiftFileBackend::doPrepareInternal	(	$	fullCont,
		$	dir,
		array $	params
	)		`[protected]`

See also:: FileBackendStore::doPrepareInternal()

Reimplemented from FileBackendStore.

Definition at line 319 of file SwiftFileBackend.php.

References createContainer(), getContainer(), logException(), Status\newGood(), and setContainerAccess().

Here is the call graph for this function:

SwiftFileBackend::doSecureInternal	(	$	fullCont,
		$	dir,
		array $	params
	)		`[protected]`

See also:: FileBackendStore::doSecureInternal()

Reimplemented from FileBackendStore.

Definition at line 364 of file SwiftFileBackend.php.

References getContainer(), logException(), Status\newGood(), and setContainerAccess().

Here is the call graph for this function:

SwiftFileBackend::doStoreInternal ( array $ params ) [protected]

See also:: FileBackendStore::doStoreInternal()

Reimplemented from FileBackendStore.

Definition at line 165 of file SwiftFileBackend.php.

References StreamFile\contentTypeFromPath(), FileBackendStore\fileExists(), getContainer(), logException(), Status\newGood(), FileBackendStore\resolveStoragePathReal(), and wfBaseConvert().

Here is the call graph for this function:

SwiftFileBackend::doStreamFile ( array $ params ) [protected]

See also:: FileBackendStore::doStreamFile()

Reimplemented from FileBackendStore.

Definition at line 575 of file SwiftFileBackend.php.

References $output, getContainer(), headersFromParams(), logException(), Status\newGood(), and FileBackendStore\resolveStoragePathReal().

Here is the call graph for this function:

SwiftFileBackend::getConnection ( ) [protected]

Get a connection to the Swift proxy.

Returns:: CF_Connection|false

Exceptions:

InvalidResponseException

Definition at line 699 of file SwiftFileBackend.php.

Referenced by createContainer(), deleteContainer(), and getContainer().

Here is the caller graph for this function:

SwiftFileBackend::getContainer	(	$	container,
		$	reCache = `false`
	)		`[protected]`

Get a Swift container object, possibly from process cache.

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

Parameters:

$container	string Container name
$reCache	bool Refresh the process cache

Returns:: CF_Container

Definition at line 742 of file SwiftFileBackend.php.

References $conn, and getConnection().

Referenced by doCleanInternal(), doCopyInternal(), doCreateInternal(), doDeleteInternal(), doGetFileStat(), doPrepareInternal(), doSecureInternal(), doStoreInternal(), doStreamFile(), getFileContents(), getFileListPageInternal(), getLocalCopy(), and isPathUsableInternal().

Here is the call graph for this function:

Here is the caller graph for this function:

SwiftFileBackend::getFileContents ( array $ params )

See also:: FileBackend::getFileContents()

Reimplemented from FileBackendStore.

Definition at line 503 of file SwiftFileBackend.php.

References FileBackendStore\fileExists(), getContainer(), headersFromParams(), logException(), and FileBackendStore\resolveStoragePathReal().

Here is the call graph for this function:

SwiftFileBackend::getFileListInternal	(	$	fullCont,
		$	dir,
		array $	params
	)

See also:: FileBackendStore::getFileListInternal()

Reimplemented from FileBackendStore.

Definition at line 530 of file SwiftFileBackend.php.

References $dir.

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

Do not call this function outside of SwiftFileBackendFileList.

Parameters:

$fullCont	string Resolved container name
$dir	string Resolved storage directory with no trailing slash
$after	string Storage path of file to list items after
$limit	integer Max number of items to list