*/
/**
- * Class for a Swift based file backend.
- * Status messages should avoid mentioning the Swift account name
- * Likewise, error suppression should be used to avoid path disclosure.
+ * @brief 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.
*
- * This requires that the php-cloudfiles library is present,
- * which is available at https://github.com/rackspace/php-cloudfiles.
- * All of the library classes must be registed in $wgAutoloadClasses.
+ * Status messages should avoid mentioning the Swift account name.
+ * Likewise, error suppression should be used to avoid path disclosure.
*
* @ingroup FileBackend
* @since 1.19
*/
-class SwiftFileBackend extends FileBackend {
+class SwiftFileBackend extends FileBackendStore {
/** @var CF_Authentication */
- protected $auth; // swift authentication handler
+ protected $auth; // Swift authentication handler
+ protected $authTTL; // integer seconds
+ protected $swiftAnonUser; // string; username to handle unauthenticated requests
+ protected $maxContCacheSize = 300; // integer; max containers with entries
+
/** @var CF_Connection */
- protected $conn; // swift connection handle
+ protected $conn; // Swift connection handle
protected $connStarted = 0; // integer UNIX timestamp
-
- protected $swiftProxyUser; // string
- protected $connTTL = 60; // integer seconds
+ protected $connContainers = array(); // container object cache
/**
- * @see FileBackend::__construct()
+ * @see FileBackendStore::__construct()
* Additional $config params include:
* swiftAuthUrl : Swift authentication server URL
- * swiftUser : Swift user used by MediaWiki
+ * swiftUser : Swift user used by MediaWiki (account:username)
* swiftKey : Swift authentication key for the above user
- * swiftProxyUser : Swift user used for end-user hits to proxy server
- * shardViaHashLevels : Map of container names to the number of hash levels
+ * 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")
*/
public function __construct( array $config ) {
parent::__construct( $config );
// Required settings
$this->auth = new CF_Authentication(
- $config['swiftUser'], $config['swiftKey'], null, $config['swiftAuthUrl'] );
+ $config['swiftUser'],
+ $config['swiftKey'],
+ null, // account; unused
+ $config['swiftAuthUrl']
+ );
// Optional settings
- $this->connTTL = isset( $config['connTTL'] )
- ? $config['connTTL']
- : 60; // some sane number
- $this->swiftProxyUser = isset( $config['swiftProxyUser'] )
- ? $config['swiftProxyUser']
+ $this->authTTL = isset( $config['swiftAuthTTL'] )
+ ? $config['swiftAuthTTL']
+ : 5 * 60; // some sane number
+ $this->swiftAnonUser = isset( $config['swiftAnonUser'] )
+ ? $config['swiftAnonUser']
: '';
$this->shardViaHashLevels = isset( $config['shardViaHashLevels'] )
? $config['shardViaHashLevels']
: '';
+ // Cache container info to mask latency
+ $this->memCache = wfGetMainCache();
}
/**
- * @see FileBackend::resolveContainerPath()
+ * @see FileBackendStore::resolveContainerPath()
+ * @return null
*/
protected function resolveContainerPath( $container, $relStoragePath ) {
if ( strlen( urlencode( $relStoragePath ) ) > 1024 ) {
- return null; // too long for swift
+ return null; // too long for Swift
}
return $relStoragePath;
}
/**
- * @see FileBackend::doCopyInternal()
+ * @see FileBackendStore::isPathUsableInternal()
+ * @return bool
*/
- protected function doCreateInternal( array $params ) {
- $status = Status::newGood();
-
- list( $dstCont, $destRel ) = $this->resolveStoragePathReal( $params['dst'] );
- if ( $destRel === null ) {
- $status->fatal( 'backend-fail-invalidpath', $params['dst'] );
- return $status;
- }
-
- // (a) Get a swift proxy connection
- $conn = $this->getConnection();
- if ( !$conn ) {
- $status->fatal( 'backend-fail-connect', $this->name );
- return $status;
+ public function isPathUsableInternal( $storagePath ) {
+ list( $container, $rel ) = $this->resolveStoragePathReal( $storagePath );
+ if ( $rel === null ) {
+ return false; // invalid
}
- // (b) Check the destination container
try {
- $dContObj = $conn->get_container( $dstCont );
+ $this->getContainer( $container );
+ return true; // container exists
} catch ( NoSuchContainerException $e ) {
- $status->fatal( 'backend-fail-create', $params['dst'] );
- return $status;
} catch ( InvalidResponseException $e ) {
- $status->fatal( 'backend-fail-connect', $this->name );
- return $status;
} catch ( Exception $e ) { // some other exception?
- $status->fatal( 'backend-fail-internal', $this->name );
- $this->logException( $e, __METHOD__, $params );
+ $this->logException( $e, __METHOD__, array( 'path' => $storagePath ) );
+ }
+
+ return false;
+ }
+
+ /**
+ * @see FileBackendStore::doCreateInternal()
+ * @return Status
+ */
+ protected function doCreateInternal( array $params ) {
+ $status = Status::newGood();
+
+ list( $dstCont, $dstRel ) = $this->resolveStoragePathReal( $params['dst'] );
+ if ( $dstRel === null ) {
+ $status->fatal( 'backend-fail-invalidpath', $params['dst'] );
return $status;
}
- // (c) Check if the destination object already exists
+ // (a) Check the destination container and object
try {
- $dContObj->get_object( $destRel ); // throws NoSuchObjectException
- // NoSuchObjectException not thrown: file must exist
- if ( empty( $params['overwriteDest'] ) ) {
+ $dContObj = $this->getContainer( $dstCont );
+ if ( empty( $params['overwrite'] ) &&
+ $this->fileExists( array( 'src' => $params['dst'], 'latest' => 1 ) ) )
+ {
$status->fatal( 'backend-fail-alreadyexists', $params['dst'] );
return $status;
}
- } catch ( NoSuchObjectException $e ) {
- // NoSuchObjectException thrown: file does not exist
+ } catch ( NoSuchContainerException $e ) {
+ $status->fatal( 'backend-fail-create', $params['dst'] );
+ return $status;
} catch ( InvalidResponseException $e ) {
$status->fatal( 'backend-fail-connect', $this->name );
return $status;
return $status;
}
- // (d) Get a SHA-1 hash of the object
+ // (b) Get a SHA-1 hash of the object
$sha1Hash = wfBaseConvert( sha1( $params['content'] ), 16, 36, 31 );
- // (e) Actually create the object
+ // (c) Actually create the object
try {
- $obj = $dContObj->create_object( $destRel );
+ // Create a fresh CF_Object with no fields preloaded.
+ // We don't want to preserve headers, metadata, and such.
+ $obj = new CF_Object( $dContObj, $dstRel, false, false ); // skip HEAD
// Note: metadata keys stored as [Upper case char][[Lower case char]...]
$obj->metadata = array( 'Sha1base36' => $sha1Hash );
+ // Manually set the ETag (https://github.com/rackspace/php-cloudfiles/issues/59).
+ // The MD5 here will be checked within Swift against its own MD5.
+ $obj->set_etag( md5( $params['content'] ) );
+ // Use the same content type as StreamFile for security
+ $obj->content_type = StreamFile::contentTypeFromPath( $params['dst'] );
+ // Actually write the object in Swift
$obj->write( $params['content'] );
} catch ( BadContentTypeException $e ) {
$status->fatal( 'backend-fail-contenttype', $params['dst'] );
}
/**
- * @see FileBackend::doStoreInternal()
+ * @see FileBackendStore::doStoreInternal()
+ * @return Status
*/
protected function doStoreInternal( array $params ) {
$status = Status::newGood();
- list( $dstCont, $destRel ) = $this->resolveStoragePathReal( $params['dst'] );
- if ( $destRel === null ) {
+ list( $dstCont, $dstRel ) = $this->resolveStoragePathReal( $params['dst'] );
+ if ( $dstRel === null ) {
$status->fatal( 'backend-fail-invalidpath', $params['dst'] );
return $status;
}
- // (a) Get a swift proxy connection
- $conn = $this->getConnection();
- if ( !$conn ) {
- $status->fatal( 'backend-fail-connect', $this->name );
- return $status;
- }
-
- // (b) Check the destination container
- try {
- $dContObj = $conn->get_container( $dstCont );
- } catch ( NoSuchContainerException $e ) {
- $status->fatal( 'backend-fail-copy', $params['src'], $params['dst'] );
- return $status;
- } catch ( InvalidResponseException $e ) {
- $status->fatal( 'backend-fail-connect', $this->name );
- return $status;
- } catch ( Exception $e ) { // some other exception?
- $status->fatal( 'backend-fail-internal', $this->name );
- $this->logException( $e, __METHOD__, $params );
- return $status;
- }
-
- // (c) Check if the destination object already exists
+ // (a) Check the destination container and object
try {
- $dContObj->get_object( $destRel ); // throws NoSuchObjectException
- // NoSuchObjectException not thrown: file must exist
- if ( empty( $params['overwriteDest'] ) ) {
+ $dContObj = $this->getContainer( $dstCont );
+ if ( empty( $params['overwrite'] ) &&
+ $this->fileExists( array( 'src' => $params['dst'], 'latest' => 1 ) ) )
+ {
$status->fatal( 'backend-fail-alreadyexists', $params['dst'] );
return $status;
}
- } catch ( NoSuchObjectException $e ) {
- // NoSuchObjectException thrown: file does not exist
+ } catch ( NoSuchContainerException $e ) {
+ $status->fatal( 'backend-fail-copy', $params['src'], $params['dst'] );
+ return $status;
} catch ( InvalidResponseException $e ) {
$status->fatal( 'backend-fail-connect', $this->name );
return $status;
return $status;
}
- // (d) Get a SHA-1 hash of the object
+ // (b) Get a SHA-1 hash of the object
$sha1Hash = sha1_file( $params['src'] );
if ( $sha1Hash === false ) { // source doesn't exist?
$status->fatal( 'backend-fail-copy', $params['src'], $params['dst'] );
}
$sha1Hash = wfBaseConvert( $sha1Hash, 16, 36, 31 );
- // (e) Actually store the object
+ // (c) Actually store the object
try {
- $obj = $dContObj->create_object( $destRel );
+ // Create a fresh CF_Object with no fields preloaded.
+ // We don't want to preserve headers, metadata, and such.
+ $obj = new CF_Object( $dContObj, $dstRel, false, false ); // skip HEAD
// Note: metadata keys stored as [Upper case char][[Lower case char]...]
$obj->metadata = array( 'Sha1base36' => $sha1Hash );
+ // The MD5 here will be checked within Swift against its own MD5.
+ $obj->set_etag( md5_file( $params['src'] ) );
+ // Use the same content type as StreamFile for security
+ $obj->content_type = StreamFile::contentTypeFromPath( $params['dst'] );
+ // Actually write the object in Swift
$obj->load_from_filename( $params['src'], True ); // calls $obj->write()
} catch ( BadContentTypeException $e ) {
$status->fatal( 'backend-fail-contenttype', $params['dst'] );
}
/**
- * @see FileBackend::doCopyInternal()
+ * @see FileBackendStore::doCopyInternal()
+ * @return Status
*/
protected function doCopyInternal( array $params ) {
$status = Status::newGood();
return $status;
}
- list( $dstCont, $destRel ) = $this->resolveStoragePathReal( $params['dst'] );
- if ( $destRel === null ) {
+ list( $dstCont, $dstRel ) = $this->resolveStoragePathReal( $params['dst'] );
+ if ( $dstRel === null ) {
$status->fatal( 'backend-fail-invalidpath', $params['dst'] );
return $status;
}
- // (a) Get a swift proxy connection
- $conn = $this->getConnection();
- if ( !$conn ) {
- $status->fatal( 'backend-fail-connect', $this->name );
- return $status;
- }
-
- // (b) Check the source and destination containers
+ // (a) Check the source/destination containers and destination object
try {
- $sContObj = $conn->get_container( $srcCont );
- $dContObj = $conn->get_container( $dstCont );
- } catch ( NoSuchContainerException $e ) {
- $status->fatal( 'backend-fail-copy', $params['src'], $params['dst'] );
- return $status;
- } catch ( InvalidResponseException $e ) {
- $status->fatal( 'backend-fail-connect', $this->name );
- return $status;
- } catch ( Exception $e ) { // some other exception?
- $status->fatal( 'backend-fail-internal', $this->name );
- $this->logException( $e, __METHOD__, $params );
- return $status;
- }
-
- // (c) Check if the destination object already exists
- try {
- $dContObj->get_object( $destRel ); // throws NoSuchObjectException
- // NoSuchObjectException not thrown: file must exist
- if ( empty( $params['overwriteDest'] ) ) {
+ $sContObj = $this->getContainer( $srcCont );
+ $dContObj = $this->getContainer( $dstCont );
+ if ( empty( $params['overwrite'] ) &&
+ $this->fileExists( array( 'src' => $params['dst'], 'latest' => 1 ) ) )
+ {
$status->fatal( 'backend-fail-alreadyexists', $params['dst'] );
return $status;
}
- } catch ( NoSuchObjectException $e ) {
- // NoSuchObjectException thrown: file does not exist
+ } catch ( NoSuchContainerException $e ) {
+ $status->fatal( 'backend-fail-copy', $params['src'], $params['dst'] );
+ return $status;
} catch ( InvalidResponseException $e ) {
$status->fatal( 'backend-fail-connect', $this->name );
return $status;
return $status;
}
- // (d) Actually copy the file to the destination
+ // (b) Actually copy the file to the destination
try {
- $sContObj->copy_object_to( $srcRel, $dContObj, $destRel );
+ $sContObj->copy_object_to( $srcRel, $dContObj, $dstRel );
} catch ( NoSuchObjectException $e ) { // source object does not exist
$status->fatal( 'backend-fail-copy', $params['src'], $params['dst'] );
} catch ( InvalidResponseException $e ) {
}
/**
- * @see FileBackend::doDeleteInternal()
+ * @see FileBackendStore::doDeleteInternal()
+ * @return Status
*/
protected function doDeleteInternal( array $params ) {
$status = Status::newGood();
return $status;
}
- // (a) Get a swift proxy connection
- $conn = $this->getConnection();
- if ( !$conn ) {
- $status->fatal( 'backend-fail-connect', $this->name );
- return $status;
- }
-
- // (b) Check the source container
try {
- $sContObj = $conn->get_container( $srcCont );
+ $sContObj = $this->getContainer( $srcCont );
+ $sContObj->delete_object( $srcRel );
} catch ( NoSuchContainerException $e ) {
$status->fatal( 'backend-fail-delete', $params['src'] );
- return $status;
- } catch ( InvalidResponseException $e ) {
- $status->fatal( 'backend-fail-connect', $this->name );
- return $status;
- } catch ( Exception $e ) { // some other exception?
- $status->fatal( 'backend-fail-internal', $this->name );
- $this->logException( $e, __METHOD__, $params );
- return $status;
- }
-
- // (c) Actually delete the object
- try {
- $sContObj->delete_object( $srcRel );
} catch ( NoSuchObjectException $e ) {
if ( empty( $params['ignoreMissingSource'] ) ) {
$status->fatal( 'backend-fail-delete', $params['src'] );
}
/**
- * @see FileBackend::doPrepareInternal()
+ * @see FileBackendStore::doPrepareInternal()
+ * @return Status
*/
protected function doPrepareInternal( $fullCont, $dir, array $params ) {
$status = Status::newGood();
- // (a) Get a swift proxy connection
- $conn = $this->getConnection();
- if ( !$conn ) {
+ // (a) Check if container already exists
+ try {
+ $contObj = $this->getContainer( $fullCont );
+ // NoSuchContainerException not thrown: container must exist
+ return $status; // already exists
+ } catch ( NoSuchContainerException $e ) {
+ // NoSuchContainerException thrown: container does not exist
+ } catch ( InvalidResponseException $e ) {
$status->fatal( 'backend-fail-connect', $this->name );
return $status;
+ } catch ( Exception $e ) { // some other exception?
+ $status->fatal( 'backend-fail-internal', $this->name );
+ $this->logException( $e, __METHOD__, $params );
+ return $status;
}
- // (b) Create the destination container
+ // (b) Create container as needed
try {
- $conn->create_container( $fullCont );
+ $contObj = $this->createContainer( $fullCont );
+ if ( $this->swiftAnonUser != '' ) {
+ // Make container public to end-users...
+ $status->merge( $this->setContainerAccess(
+ $contObj,
+ array( $this->auth->username, $this->swiftAnonUser ), // read
+ array( $this->auth->username ) // write
+ ) );
+ }
} catch ( InvalidResponseException $e ) {
$status->fatal( 'backend-fail-connect', $this->name );
+ return $status;
} catch ( Exception $e ) { // some other exception?
$status->fatal( 'backend-fail-internal', $this->name );
$this->logException( $e, __METHOD__, $params );
+ return $status;
}
return $status;
}
/**
- * @see FileBackend::doSecureInternal()
+ * @see FileBackendStore::doSecureInternal()
+ * @return Status
*/
protected function doSecureInternal( $fullCont, $dir, array $params ) {
$status = Status::newGood();
- // @TODO: restrict container from $this->swiftProxyUser
+
+ if ( $this->swiftAnonUser != '' ) {
+ // Restrict container from end-users...
+ try {
+ // doPrepareInternal() should have been called,
+ // so the Swift container should already exist...
+ $contObj = $this->getContainer( $fullCont ); // normally a cache hit
+ // NoSuchContainerException not thrown: container must exist
+ if ( !isset( $contObj->mw_wasSecured ) ) {
+ $status->merge( $this->setContainerAccess(
+ $contObj,
+ array( $this->auth->username ), // read
+ array( $this->auth->username ) // write
+ ) );
+ // @TODO: when php-cloudfiles supports container
+ // metadata, we can make use of that to avoid RTTs
+ $contObj->mw_wasSecured = true; // avoid useless RTTs
+ }
+ } catch ( InvalidResponseException $e ) {
+ $status->fatal( 'backend-fail-connect', $this->name );
+ } catch ( Exception $e ) { // some other exception?
+ $status->fatal( 'backend-fail-internal', $this->name );
+ $this->logException( $e, __METHOD__, $params );
+ }
+ }
+
return $status;
}
/**
- * @see FileBackend::doFileExists()
+ * @see FileBackendStore::doCleanInternal()
+ * @return Status
+ */
+ protected function doCleanInternal( $fullCont, $dir, array $params ) {
+ $status = Status::newGood();
+
+ // Only containers themselves can be removed, all else is virtual
+ if ( $dir != '' ) {
+ return $status; // nothing to do
+ }
+
+ // (a) Check the container
+ try {
+ $contObj = $this->getContainer( $fullCont, true );
+ } catch ( NoSuchContainerException $e ) {
+ return $status; // ok, nothing to do
+ } catch ( InvalidResponseException $e ) {
+ $status->fatal( 'backend-fail-connect', $this->name );
+ return $status;
+ } catch ( Exception $e ) { // some other exception?
+ $status->fatal( 'backend-fail-internal', $this->name );
+ $this->logException( $e, __METHOD__, $params );
+ return $status;
+ }
+
+ // (b) Delete the container if empty
+ if ( $contObj->object_count == 0 ) {
+ try {
+ $this->deleteContainer( $fullCont );
+ } catch ( NoSuchContainerException $e ) {
+ return $status; // race?
+ } catch ( InvalidResponseException $e ) {
+ $status->fatal( 'backend-fail-connect', $this->name );
+ return $status;
+ } catch ( Exception $e ) { // some other exception?
+ $status->fatal( 'backend-fail-internal', $this->name );
+ $this->logException( $e, __METHOD__, $params );
+ return $status;
+ }
+ }
+
+ return $status;
+ }
+
+ /**
+ * @see FileBackendStore::doFileExists()
+ * @return array|bool|null
*/
protected function doGetFileStat( array $params ) {
list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $params['src'] );
return false; // invalid storage path
}
- $conn = $this->getConnection();
- if ( !$conn ) {
- return null;
- }
-
$stat = false;
try {
- $container = $conn->get_container( $srcCont );
- // @TODO: handle 'latest' param as "X-Newest: true"
- $obj = $container->get_object( $srcRel );
- // Convert "Tue, 03 Jan 2012 22:01:04 GMT" to TS_MW
- $date = DateTime::createFromFormat( 'D, d F Y G:i:s e', $obj->last_modified );
- if ( $date ) {
- $stat = array(
- 'mtime' => $date->format( 'YmdHis' ),
- 'size' => $obj->content_length,
- 'sha1' => $obj->metadata['Sha1base36']
- );
- } else { // exception will be caught below
- throw new Exception( "Could not parse date for object {$srcRel}" );
- }
+ $contObj = $this->getContainer( $srcCont );
+ $srcObj = $contObj->get_object( $srcRel, $this->headersFromParams( $params ) );
+ $this->addMissingMetadata( $srcObj, $params['src'] );
+ $stat = array(
+ // Convert dates like "Tue, 03 Jan 2012 22:01:04 GMT" to TS_MW
+ 'mtime' => wfTimestamp( TS_MW, $srcObj->last_modified ),
+ 'size' => $srcObj->content_length,
+ 'sha1' => $srcObj->metadata['Sha1base36']
+ );
} catch ( NoSuchContainerException $e ) {
} catch ( NoSuchObjectException $e ) {
} catch ( InvalidResponseException $e ) {
}
/**
- * @see FileBackendBase::getFileContents()
+ * Fill in any missing object metadata and save it to Swift
+ *
+ * @param $obj CF_Object
+ * @param $path string Storage path to object
+ * @return bool Success
+ * @throws Exception cloudfiles exceptions
+ */
+ protected function addMissingMetadata( CF_Object $obj, $path ) {
+ if ( isset( $obj->metadata['Sha1base36'] ) ) {
+ return true; // nothing to do
+ }
+ $status = Status::newGood();
+ $scopeLockS = $this->getScopedFileLocks( array( $path ), LockManager::LOCK_UW, $status );
+ if ( $status->isOK() ) {
+ $tmpFile = $this->getLocalCopy( array( 'src' => $path, 'latest' => 1 ) );
+ if ( $tmpFile ) {
+ $hash = $tmpFile->getSha1Base36();
+ if ( $hash !== false ) {
+ $obj->metadata['Sha1base36'] = $hash;
+ $obj->sync_metadata(); // save to Swift
+ return true; // success
+ }
+ }
+ }
+ $obj->metadata['Sha1base36'] = false;
+ return false; // failed
+ }
+
+ /**
+ * @see FileBackend::getFileContents()
+ * @return bool|null|string
*/
public function getFileContents( array $params ) {
list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $params['src'] );
return false; // invalid storage path
}
- $conn = $this->getConnection();
- if ( !$conn ) {
- return false;
+ if ( !$this->fileExists( $params ) ) {
+ return null;
}
$data = false;
try {
- $container = $conn->get_container( $srcCont );
- $obj = $container->get_object( $srcRel );
+ $sContObj = $this->getContainer( $srcCont );
+ $obj = new CF_Object( $sContObj, $srcRel, false, false ); // skip HEAD request
$data = $obj->read( $this->headersFromParams( $params ) );
} catch ( NoSuchContainerException $e ) {
- } catch ( NoSuchObjectException $e ) {
} catch ( InvalidResponseException $e ) {
} catch ( Exception $e ) { // some other exception?
$this->logException( $e, __METHOD__, $params );
}
/**
- * @see FileBackend::getFileListInternal()
+ * @see FileBackendStore::doDirectoryExists()
+ * @return bool|null
+ */
+ protected function doDirectoryExists( $fullCont, $dir, array $params ) {
+ try {
+ $container = $this->getContainer( $fullCont );
+ $prefix = ( $dir == '' ) ? null : "{$dir}/";
+ return ( count( $container->list_objects( 1, null, $prefix ) ) > 0 );
+ } catch ( NoSuchContainerException $e ) {
+ return false;
+ } catch ( InvalidResponseException $e ) {
+ } catch ( Exception $e ) { // some other exception?
+ $this->logException( $e, __METHOD__, array( 'cont' => $fullCont, 'dir' => $dir ) );
+ }
+
+ return null; // error
+ }
+
+ /**
+ * @see FileBackendStore::getDirectoryListInternal()
+ * @return SwiftFileBackendDirList
+ */
+ public function getDirectoryListInternal( $fullCont, $dir, array $params ) {
+ return new SwiftFileBackendDirList( $this, $fullCont, $dir, $params );
+ }
+
+ /**
+ * @see FileBackendStore::getFileListInternal()
+ * @return SwiftFileBackendFileList
*/
public function getFileListInternal( $fullCont, $dir, array $params ) {
- return new SwiftFileBackendFileList( $this, $fullCont, $dir );
+ return new SwiftFileBackendFileList( $this, $fullCont, $dir, $params );
}
/**
* Do not call this function outside of SwiftFileBackendFileList
- *
+ *
* @param $fullCont string Resolved container name
* @param $dir string Resolved storage directory with no trailing slash
- * @param $after string Storage path of file to list items after
+ * @param $after string|null Storage path of file to list items after
* @param $limit integer Max number of items to list
- * @return Array
+ * @param $params Array Includes flag for 'topOnly'
+ * @return Array List of relative paths of dirs directly under $dir
*/
- public function getFileListPageInternal( $fullCont, $dir, $after, $limit ) {
- $conn = $this->getConnection();
- if ( !$conn ) {
- return null;
+ public function getDirListPageInternal( $fullCont, $dir, &$after, $limit, array $params ) {
+ $dirs = array();
+
+ try {
+ $container = $this->getContainer( $fullCont );
+ $prefix = ( $dir == '' ) ? null : "{$dir}/";
+ // Non-recursive: only list dirs right under $dir
+ if ( !empty( $params['topOnly'] ) ) {
+ $objects = $container->list_objects( $limit, $after, $prefix, null, '/' );
+ foreach ( $objects as $object ) { // files and dirs
+ if ( substr( $object, -1 ) === '/' ) {
+ $dirs[] = $object; // directories end in '/'
+ }
+ $after = $object; // update last item
+ }
+ // Recursive: list all dirs under $dir and its subdirs
+ } else {
+ // Get directory from last item of prior page
+ $lastDir = $this->getParentDir( $after ); // must be first page
+ $objects = $container->list_objects( $limit, $after, $prefix );
+ foreach ( $objects as $object ) { // files
+ $objectDir = $this->getParentDir( $object ); // directory of object
+ if ( $objectDir !== false ) { // file has a parent dir
+ // Swift stores paths in UTF-8, using binary sorting.
+ // See function "create_container_table" in common/db.py.
+ // If a directory is not "greater" than the last one,
+ // then it was already listed by the calling iterator.
+ if ( $objectDir > $lastDir ) {
+ $pDir = $objectDir;
+ do { // add dir and all its parent dirs
+ $dirs[] = "{$pDir}/";
+ $pDir = $this->getParentDir( $pDir );
+ } while ( $pDir !== false // sanity
+ && $pDir > $lastDir // not done already
+ && strlen( $pDir ) > strlen( $dir ) // within $dir
+ );
+ }
+ $lastDir = $objectDir;
+ }
+ $after = $object; // update last item
+ }
+ }
+ } catch ( NoSuchContainerException $e ) {
+ } catch ( InvalidResponseException $e ) {
+ } catch ( Exception $e ) { // some other exception?
+ $this->logException( $e, __METHOD__, array( 'cont' => $fullCont, 'dir' => $dir ) );
}
+ return $dirs;
+ }
+
+ protected function getParentDir( $path ) {
+ return ( strpos( $path, '/' ) !== false ) ? dirname( $path ) : false;
+ }
+
+ /**
+ * Do not call this function outside of SwiftFileBackendFileList
+ *
+ * @param $fullCont string Resolved container name
+ * @param $dir string Resolved storage directory with no trailing slash
+ * @param $after string|null Storage path of file to list items after
+ * @param $limit integer Max number of items to list
+ * @param $params Array Includes flag for 'topOnly'
+ * @return Array List of relative paths of files under $dir
+ */
+ public function getFileListPageInternal( $fullCont, $dir, &$after, $limit, array $params ) {
$files = array();
+
try {
- $container = $conn->get_container( $fullCont );
- $files = $container->list_objects( $limit, $after, "{$dir}/" );
+ $container = $this->getContainer( $fullCont );
+ $prefix = ( $dir == '' ) ? null : "{$dir}/";
+ // Non-recursive: only list files right under $dir
+ if ( !empty( $params['topOnly'] ) ) { // files and dirs
+ $objects = $container->list_objects( $limit, $after, $prefix, null, '/' );
+ foreach ( $objects as $object ) {
+ if ( substr( $object, -1 ) !== '/' ) {
+ $files[] = $object; // directories end in '/'
+ }
+ }
+ // Recursive: list all files under $dir and its subdirs
+ } else { // files
+ $files = $container->list_objects( $limit, $after, $prefix );
+ }
+ $after = end( $files ); // update last item
+ reset( $files ); // reset pointer
} catch ( NoSuchContainerException $e ) {
- } catch ( NoSuchObjectException $e ) {
} catch ( InvalidResponseException $e ) {
} catch ( Exception $e ) { // some other exception?
- $this->logException( $e, __METHOD__, $params );
+ $this->logException( $e, __METHOD__, array( 'cont' => $fullCont, 'dir' => $dir ) );
}
return $files;
}
/**
- * @see FileBackend::doGetFileSha1base36()
+ * @see FileBackendStore::doGetFileSha1base36()
+ * @return bool
*/
- public function doGetFileSha1base36( array $params ) {
+ protected function doGetFileSha1base36( array $params ) {
$stat = $this->getFileStat( $params );
if ( $stat ) {
return $stat['sha1'];
}
/**
- * @see FileBackend::doStreamFile()
+ * @see FileBackendStore::doStreamFile()
+ * @return Status
*/
protected function doStreamFile( array $params ) {
$status = Status::newGood();
$status->fatal( 'backend-fail-invalidpath', $params['src'] );
}
- $conn = $this->getConnection();
- if ( !$conn ) {
- $status->fatal( 'backend-fail-connect', $this->name );
- }
-
try {
- $cont = $conn->get_container( $srcCont );
- $obj = $cont->get_object( $srcRel );
+ $cont = $this->getContainer( $srcCont );
} catch ( NoSuchContainerException $e ) {
$status->fatal( 'backend-fail-stream', $params['src'] );
return $status;
- } catch ( NoSuchObjectException $e ) {
- $status->fatal( 'backend-fail-stream', $params['src'] );
- return $status;
- } catch ( IOException $e ) {
- $status->fatal( 'backend-fail-stream', $params['src'] );
+ } catch ( InvalidResponseException $e ) {
+ $status->fatal( 'backend-fail-connect', $this->name );
return $status;
} catch ( Exception $e ) { // some other exception?
$status->fatal( 'backend-fail-stream', $params['src'] );
}
try {
- $output = fopen( "php://output", "w" );
+ $output = fopen( 'php://output', 'wb' );
+ $obj = new CF_Object( $cont, $srcRel, false, false ); // skip HEAD request
$obj->stream( $output, $this->headersFromParams( $params ) );
- } catch ( InvalidResponseException $e ) {
- $status->fatal( 'backend-fail-connect', $this->name );
+ } catch ( InvalidResponseException $e ) { // 404? connection problem?
+ $status->fatal( 'backend-fail-stream', $params['src'] );
} catch ( Exception $e ) { // some other exception?
$status->fatal( 'backend-fail-stream', $params['src'] );
$this->logException( $e, __METHOD__, $params );
}
/**
- * @see FileBackend::getLocalCopy()
+ * @see FileBackendStore::getLocalCopy()
+ * @return null|TempFSFile
*/
public function getLocalCopy( array $params ) {
list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $params['src'] );
return null;
}
- $conn = $this->getConnection();
- if ( !$conn ) {
- return null;
- }
-
- // Get source file extension
- $ext = FileBackend::extensionFromPath( $srcRel );
- // Create a new temporary file...
- $tmpFile = TempFSFile::factory( wfBaseName( $srcRel ) . '_', $ext );
- if ( !$tmpFile ) {
+ if ( !$this->fileExists( $params ) ) {
return null;
}
+ $tmpFile = null;
try {
- $cont = $conn->get_container( $srcCont );
- $obj = $cont->get_object( $srcRel );
- $handle = fopen( $tmpFile->getPath(), 'w' );
- if ( $handle ) {
- $obj->stream( $handle, $this->headersFromParams( $params ) );
- fclose( $handle );
- } else {
- $tmpFile = null; // couldn't open temp file
+ $sContObj = $this->getContainer( $srcCont );
+ $obj = new CF_Object( $sContObj, $srcRel, false, false ); // skip HEAD
+ // Get source file extension
+ $ext = FileBackend::extensionFromPath( $srcRel );
+ // Create a new temporary file...
+ $tmpFile = TempFSFile::factory( wfBaseName( $srcRel ) . '_', $ext );
+ if ( $tmpFile ) {
+ $handle = fopen( $tmpFile->getPath(), 'wb' );
+ if ( $handle ) {
+ $obj->stream( $handle, $this->headersFromParams( $params ) );
+ fclose( $handle );
+ } else {
+ $tmpFile = null; // couldn't open temp file
+ }
}
} catch ( NoSuchContainerException $e ) {
$tmpFile = null;
- } catch ( NoSuchObjectException $e ) {
- $tmpFile = null;
} catch ( InvalidResponseException $e ) {
$tmpFile = null;
} catch ( Exception $e ) { // some other exception?
return $tmpFile;
}
+ /**
+ * @see FileBackendStore::directoriesAreVirtual()
+ * @return bool
+ */
+ protected function directoriesAreVirtual() {
+ return true;
+ }
+
/**
* Get headers to send to Swift when reading a file based
- * on a FileBackend params array, e.g. that of getLocalCopy().
+ * on a FileBackend params array, e.g. that of getLocalCopy().
* $params is currently only checked for a 'latest' flag.
- *
+ *
* @param $params Array
- * @return Array
+ * @return Array
*/
protected function headersFromParams( array $params ) {
$hdrs = array();
}
/**
- * Get a connection to the swift proxy
+ * Set read/write permissions for a Swift container
+ *
+ * @param $contObj CF_Container Swift container
+ * @param $readGrps Array Swift users who can read (account:user)
+ * @param $writeGrps Array Swift users who can write (account:user)
+ * @return Status
+ */
+ protected function setContainerAccess(
+ CF_Container $contObj, array $readGrps, array $writeGrps
+ ) {
+ $creds = $contObj->cfs_auth->export_credentials();
+
+ $url = $creds['storage_url'] . '/' . rawurlencode( $contObj->name );
+
+ // Note: 10 second timeout consistent with php-cloudfiles
+ $req = new CurlHttpRequest( $url, array( 'method' => 'POST', 'timeout' => 10 ) );
+ $req->setHeader( 'X-Auth-Token', $creds['auth_token'] );
+ $req->setHeader( 'X-Container-Read', implode( ',', $readGrps ) );
+ $req->setHeader( 'X-Container-Write', implode( ',', $writeGrps ) );
+
+ return $req->execute(); // should return 204
+ }
+
+ /**
+ * Get a connection to the Swift proxy
*
- * @return CF_Connection|false
+ * @return CF_Connection|bool False on failure
+ * @throws InvalidResponseException
*/
protected function getConnection() {
if ( $this->conn === false ) {
- return false; // failed last attempt
+ throw new InvalidResponseException; // failed last attempt
+ }
+ // Session keys expire after a while, so we renew them periodically
+ if ( $this->conn && ( time() - $this->connStarted ) > $this->authTTL ) {
+ $this->conn->close(); // close active cURL connections
+ $this->conn = null;
}
- // Authenticate with proxy and get a session key.
- // Session keys expire after a while, so we renew them periodically.
- if ( $this->conn === null || ( time() - $this->connStarted ) > $this->connTTL ) {
+ // Authenticate with proxy and get a session key...
+ if ( $this->conn === null ) {
+ $this->connContainers = array();
try {
$this->auth->authenticate();
$this->conn = new CF_Connection( $this->auth );
$this->conn = false; // don't keep re-trying
}
}
+ if ( !$this->conn ) {
+ throw new InvalidResponseException; // auth/connection problem
+ }
return $this->conn;
}
+ /**
+ * @see FileBackendStore::doClearCache()
+ */
+ protected function doClearCache( array $paths = null ) {
+ $this->connContainers = array(); // clear container object cache
+ }
+
+ /**
+ * Get a Swift container object, possibly from process cache.
+ * Use $reCache if the file count or byte count is needed.
+ *
+ * @param $container string Container name
+ * @param $bypassCache bool Bypass all caches and load from Swift
+ * @return CF_Container
+ * @throws InvalidResponseException
+ */
+ protected function getContainer( $container, $bypassCache = false ) {
+ $conn = $this->getConnection(); // Swift proxy connection
+ if ( $bypassCache ) { // purge cache
+ unset( $this->connContainers[$container] );
+ } elseif ( !isset( $this->connContainers[$container] ) ) {
+ $this->primeContainerCache( array( $container ) ); // check persistent cache
+ }
+ if ( !isset( $this->connContainers[$container] ) ) {
+ $contObj = $conn->get_container( $container );
+ // NoSuchContainerException not thrown: container must exist
+ if ( count( $this->connContainers ) >= $this->maxContCacheSize ) { // trim cache?
+ reset( $this->connContainers );
+ unset( $this->connContainers[key( $this->connContainers )] );
+ }
+ $this->connContainers[$container] = $contObj; // cache it
+ if ( !$bypassCache ) {
+ $this->setContainerCache( $container, // update persistent cache
+ array( 'bytes' => $contObj->bytes_used, 'count' => $contObj->object_count )
+ );
+ }
+ }
+ return $this->connContainers[$container];
+ }
+
+ /**
+ * Create a Swift container
+ *
+ * @param $container string Container name
+ * @return CF_Container
+ * @throws InvalidResponseException
+ */
+ protected function createContainer( $container ) {
+ $conn = $this->getConnection(); // Swift proxy connection
+ $contObj = $conn->create_container( $container );
+ $this->connContainers[$container] = $contObj; // cache it
+ return $contObj;
+ }
+
+ /**
+ * Delete a Swift container
+ *
+ * @param $container string Container name
+ * @return void
+ * @throws InvalidResponseException
+ */
+ protected function deleteContainer( $container ) {
+ $conn = $this->getConnection(); // Swift proxy connection
+ $conn->delete_container( $container );
+ unset( $this->connContainers[$container] ); // purge cache
+ }
+
+ /**
+ * @see FileBackendStore::doPrimeContainerCache()
+ * @return void
+ */
+ protected function doPrimeContainerCache( array $containerInfo ) {
+ try {
+ $conn = $this->getConnection(); // Swift proxy connection
+ foreach ( $containerInfo as $container => $info ) {
+ $this->connContainers[$container] = new CF_Container(
+ $conn->cfs_auth,
+ $conn->cfs_http,
+ $container,
+ $info['count'],
+ $info['bytes']
+ );
+ }
+ } catch ( InvalidResponseException $e ) {
+ } catch ( Exception $e ) { // some other exception?
+ $this->logException( $e, __METHOD__, array() );
+ }
+ }
+
/**
* Log an unexpected exception for this backend
- *
+ *
* @param $e Exception
* @param $func string
* @param $params Array
*/
protected function logException( Exception $e, $func, array $params ) {
wfDebugLog( 'SwiftBackend',
- get_class( $e ) . " in '{$this->name}': '{$func}' with " . serialize( $params )
+ get_class( $e ) . " in '{$func}' (given '" . FormatJson::encode( $params ) . "')" .
+ ( $e instanceof InvalidResponseException
+ ? ": {$e->getMessage()}"
+ : ""
+ )
);
}
}
/**
- * SwiftFileBackend helper class to page through object listings.
+ * SwiftFileBackend helper class to page through listings.
* Swift also has a listing limit of 10,000 objects for sanity.
* Do not use this class from places outside SwiftFileBackend.
*
* @ingroup FileBackend
*/
-class SwiftFileBackendFileList implements Iterator {
+abstract class SwiftFileBackendList implements Iterator {
/** @var Array */
protected $bufferIter = array();
protected $bufferAfter = null; // string; list items *after* this path
protected $pos = 0; // integer
+ /** @var Array */
+ protected $params = array();
/** @var SwiftFileBackend */
- protected $backend;
- protected $container; //
- protected $dir; // string storage directory
+ protected $backend;
+ protected $container; // string; container name
+ protected $dir; // string; storage directory
protected $suffixStart; // integer
const PAGE_SIZE = 5000; // file listing buffer size
* @param $backend SwiftFileBackend
* @param $fullCont string Resolved container name
* @param $dir string Resolved directory relative to container
+ * @param $params Array
*/
- public function __construct( SwiftFileBackend $backend, $fullCont, $dir ) {
+ public function __construct( SwiftFileBackend $backend, $fullCont, $dir, array $params ) {
$this->backend = $backend;
$this->container = $fullCont;
$this->dir = $dir;
if ( substr( $this->dir, -1 ) === '/' ) {
$this->dir = substr( $this->dir, 0, -1 ); // remove trailing slash
}
- $this->suffixStart = strlen( $dir ) + 1; // size of "path/to/dir/"
- }
-
- public function current() {
- return substr( current( $this->bufferIter ), $this->suffixStart );
+ if ( $this->dir == '' ) { // whole container
+ $this->suffixStart = 0;
+ } else { // dir within container
+ $this->suffixStart = strlen( $this->dir ) + 1; // size of "path/to/dir/"
+ }
+ $this->params = $params;
}
+ /**
+ * @see Iterator::key()
+ * @return integer
+ */
public function key() {
return $this->pos;
}
+ /**
+ * @see Iterator::next()
+ * @return void
+ */
public function next() {
// Advance to the next file in the page
next( $this->bufferIter );
// Check if there are no files left in this page and
// advance to the next page if this page was not empty.
if ( !$this->valid() && count( $this->bufferIter ) ) {
- $this->bufferAfter = end( $this->bufferIter );
- $this->bufferIter = $this->backend->getFileListPageInternal(
- $this->container, $this->dir, $this->bufferAfter, self::PAGE_SIZE
- );
+ $this->bufferIter = $this->pageFromList(
+ $this->container, $this->dir, $this->bufferAfter, self::PAGE_SIZE, $this->params
+ ); // updates $this->bufferAfter
}
}
+ /**
+ * @see Iterator::rewind()
+ * @return void
+ */
public function rewind() {
$this->pos = 0;
$this->bufferAfter = null;
- $this->bufferIter = $this->backend->getFileListPageInternal(
- $this->container, $this->dir, $this->bufferAfter, self::PAGE_SIZE
- );
+ $this->bufferIter = $this->pageFromList(
+ $this->container, $this->dir, $this->bufferAfter, self::PAGE_SIZE, $this->params
+ ); // updates $this->bufferAfter
}
+ /**
+ * @see Iterator::valid()
+ * @return bool
+ */
public function valid() {
- return ( current( $this->bufferIter ) !== false ); // no paths can have this value
+ if ( $this->bufferIter === null ) {
+ return false; // some failure?
+ } else {
+ return ( current( $this->bufferIter ) !== false ); // no paths can have this value
+ }
+ }
+
+ /**
+ * Get the given list portion (page)
+ *
+ * @param $container string Resolved container name
+ * @param $dir string Resolved path relative to container
+ * @param $after string|null
+ * @param $limit integer
+ * @param $params Array
+ * @return Traversable|Array|null Returns null on failure
+ */
+ abstract protected function pageFromList( $container, $dir, &$after, $limit, array $params );
+}
+
+/**
+ * Iterator for listing directories
+ */
+class SwiftFileBackendDirList extends SwiftFileBackendList {
+ /**
+ * @see Iterator::current()
+ * @return string|bool String (relative path) or false
+ */
+ public function current() {
+ return substr( current( $this->bufferIter ), $this->suffixStart, -1 );
+ }
+
+ /**
+ * @see SwiftFileBackendList::pageFromList()
+ * @return Array|null
+ */
+ protected function pageFromList( $container, $dir, &$after, $limit, array $params ) {
+ return $this->backend->getDirListPageInternal( $container, $dir, $after, $limit, $params );
+ }
+}
+
+/**
+ * Iterator for listing regular files
+ */
+class SwiftFileBackendFileList extends SwiftFileBackendList {
+ /**
+ * @see Iterator::current()
+ * @return string|bool String (relative path) or false
+ */
+ public function current() {
+ return substr( current( $this->bufferIter ), $this->suffixStart );
+ }
+
+ /**
+ * @see SwiftFileBackendList::pageFromList()
+ * @return Array|null
+ */
+ protected function pageFromList( $container, $dir, &$after, $limit, array $params ) {
+ return $this->backend->getFileListPageInternal( $container, $dir, $after, $limit, $params );
}
}
dépôts / lhc / web / wiklou.git / blobdiff