3 * OpenStack Swift based file backend.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup FileBackend
23 * @author Aaron Schulz
27 * @brief Class for an OpenStack Swift based file backend.
29 * This requires the SwiftCloudFiles MediaWiki extension, which includes
30 * the php-cloudfiles library (https://github.com/rackspace/php-cloudfiles).
31 * php-cloudfiles requires the curl, fileinfo, and mb_string PHP extensions.
33 * Status messages should avoid mentioning the Swift account name.
34 * Likewise, error suppression should be used to avoid path disclosure.
36 * @ingroup FileBackend
39 class SwiftFileBackend
extends FileBackendStore
{
40 /** @var CF_Authentication */
41 protected $auth; // Swift authentication handler
42 protected $authTTL; // integer seconds
43 protected $swiftAnonUser; // string; username to handle unauthenticated requests
44 protected $swiftUseCDN; // boolean; whether CloudFiles CDN is enabled
45 protected $swiftCDNExpiry; // integer; how long to cache things in the CDN
46 protected $swiftCDNPurgable; // boolean; whether object CDN purging is enabled
48 /** @var CF_Connection */
49 protected $conn; // Swift connection handle
50 protected $sessionStarted = 0; // integer UNIX timestamp
52 /** @var CloudFilesException */
53 protected $connException;
54 protected $connErrorTime = 0; // UNIX timestamp
59 /** @var ProcessCacheLRU */
60 protected $connContainerCache; // container object cache
63 * @see FileBackendStore::__construct()
64 * Additional $config params include:
65 * - swiftAuthUrl : Swift authentication server URL
66 * - swiftUser : Swift user used by MediaWiki (account:username)
67 * - swiftKey : Swift authentication key for the above user
68 * - swiftAuthTTL : Swift authentication TTL (seconds)
69 * - swiftAnonUser : Swift user used for end-user requests (account:username).
70 * If set, then views of public containers are assumed to go
71 * through this user. If not set, then public containers are
72 * accessible to unauthenticated requests via ".r:*" in the ACL.
73 * - swiftUseCDN : Whether a Cloud Files Content Delivery Network is set up
74 * - swiftCDNExpiry : How long (in seconds) to store content in the CDN.
75 * If files may likely change, this should probably not exceed
76 * a few days. For example, deletions may take this long to apply.
77 * If object purging is enabled, however, this is not an issue.
78 * - swiftCDNPurgable : Whether object purge requests are allowed by the CDN.
79 * - shardViaHashLevels : Map of container names to sharding config with:
80 * - base : base of hash characters, 16 or 36
81 * - levels : the number of hash levels (and digits)
82 * - repeat : hash subdirectories are prefixed with all the
83 * parent hash directory names (e.g. "a/ab/abc")
84 * - cacheAuthInfo : Whether to cache authentication tokens in APC, XCache, ect.
85 * If those are not available, then the main cache will be used.
86 * This is probably insecure in shared hosting environments.
88 public function __construct( array $config ) {
89 parent
::__construct( $config );
90 if ( !MWInit
::classExists( 'CF_Constants' ) ) {
91 throw new MWException( 'SwiftCloudFiles extension not installed.' );
94 $this->auth
= new CF_Authentication(
97 null, // account; unused
98 $config['swiftAuthUrl']
101 $this->authTTL
= isset( $config['swiftAuthTTL'] )
102 ?
$config['swiftAuthTTL']
103 : 5 * 60; // some sane number
104 $this->swiftAnonUser
= isset( $config['swiftAnonUser'] )
105 ?
$config['swiftAnonUser']
107 $this->shardViaHashLevels
= isset( $config['shardViaHashLevels'] )
108 ?
$config['shardViaHashLevels']
110 $this->swiftUseCDN
= isset( $config['swiftUseCDN'] )
111 ?
$config['swiftUseCDN']
113 $this->swiftCDNExpiry
= isset( $config['swiftCDNExpiry'] )
114 ?
$config['swiftCDNExpiry']
115 : 12*3600; // 12 hours is safe (tokens last 24 hours per http://docs.openstack.org)
116 $this->swiftCDNPurgable
= isset( $config['swiftCDNPurgable'] )
117 ?
$config['swiftCDNPurgable']
119 // Cache container information to mask latency
120 $this->memCache
= wfGetMainCache();
121 // Process cache for container info
122 $this->connContainerCache
= new ProcessCacheLRU( 300 );
123 // Cache auth token information to avoid RTTs
124 if ( !empty( $config['cacheAuthInfo'] ) ) {
125 if ( php_sapi_name() === 'cli' ) {
126 $this->srvCache
= wfGetMainCache(); // preferrably memcached
128 try { // look for APC, XCache, WinCache, ect...
129 $this->srvCache
= ObjectCache
::newAccelerator( array() );
130 } catch ( Exception
$e ) {}
133 $this->srvCache
= $this->srvCache ?
$this->srvCache
: new EmptyBagOStuff();
137 * @see FileBackendStore::resolveContainerPath()
140 protected function resolveContainerPath( $container, $relStoragePath ) {
141 if ( !mb_check_encoding( $relStoragePath, 'UTF-8' ) ) { // mb_string required by CF
142 return null; // not UTF-8, makes it hard to use CF and the swift HTTP API
143 } elseif ( strlen( urlencode( $relStoragePath ) ) > 1024 ) {
144 return null; // too long for Swift
146 return $relStoragePath;
150 * @see FileBackendStore::isPathUsableInternal()
153 public function isPathUsableInternal( $storagePath ) {
154 list( $container, $rel ) = $this->resolveStoragePathReal( $storagePath );
155 if ( $rel === null ) {
156 return false; // invalid
160 $this->getContainer( $container );
161 return true; // container exists
162 } catch ( NoSuchContainerException
$e ) {
163 } catch ( CloudFilesException
$e ) { // some other exception?
164 $this->handleException( $e, null, __METHOD__
, array( 'path' => $storagePath ) );
171 * @param $disposition string Content-Disposition header value
172 * @return string Truncated Content-Disposition header value to meet Swift limits
174 protected function truncDisp( $disposition ) {
176 foreach ( explode( ';', $disposition ) as $part ) {
177 $part = trim( $part );
178 $new = ( $res === '' ) ?
$part : "{$res};{$part}";
179 if ( strlen( $new ) <= 255 ) {
182 break; // too long; sigh
189 * @see FileBackendStore::doCreateInternal()
192 protected function doCreateInternal( array $params ) {
193 $status = Status
::newGood();
195 list( $dstCont, $dstRel ) = $this->resolveStoragePathReal( $params['dst'] );
196 if ( $dstRel === null ) {
197 $status->fatal( 'backend-fail-invalidpath', $params['dst'] );
201 // (a) Check the destination container and object
203 $dContObj = $this->getContainer( $dstCont );
204 if ( empty( $params['overwrite'] ) &&
205 $this->fileExists( array( 'src' => $params['dst'], 'latest' => 1 ) ) )
207 $status->fatal( 'backend-fail-alreadyexists', $params['dst'] );
210 } catch ( NoSuchContainerException
$e ) {
211 $status->fatal( 'backend-fail-create', $params['dst'] );
213 } catch ( CloudFilesException
$e ) { // some other exception?
214 $this->handleException( $e, $status, __METHOD__
, $params );
218 // (b) Get a SHA-1 hash of the object
219 $sha1Hash = wfBaseConvert( sha1( $params['content'] ), 16, 36, 31 );
221 // (c) Actually create the object
223 // Create a fresh CF_Object with no fields preloaded.
224 // We don't want to preserve headers, metadata, and such.
225 $obj = new CF_Object( $dContObj, $dstRel, false, false ); // skip HEAD
226 // Note: metadata keys stored as [Upper case char][[Lower case char]...]
227 $obj->metadata
= array( 'Sha1base36' => $sha1Hash );
228 // Manually set the ETag (https://github.com/rackspace/php-cloudfiles/issues/59).
229 // The MD5 here will be checked within Swift against its own MD5.
230 $obj->set_etag( md5( $params['content'] ) );
231 // Use the same content type as StreamFile for security
232 $obj->content_type
= StreamFile
::contentTypeFromPath( $params['dst'] );
233 if ( !strlen( $obj->content_type
) ) { // special case
234 $obj->content_type
= 'unknown/unknown';
236 // Set the Content-Disposition header if requested
237 if ( isset( $params['disposition'] ) ) {
238 $obj->headers
['Content-Disposition'] = $this->truncDisp( $params['disposition'] );
240 if ( !empty( $params['async'] ) ) { // deferred
241 $op = $obj->write_async( $params['content'] );
242 $status->value
= new SwiftFileOpHandle( $this, $params, 'Create', $op );
243 if ( !empty( $params['overwrite'] ) ) { // file possibly mutated
244 $status->value
->affectedObjects
[] = $obj;
246 } else { // actually write the object in Swift
247 $obj->write( $params['content'] );
248 if ( !empty( $params['overwrite'] ) ) { // file possibly mutated
249 $this->purgeCDNCache( array( $obj ) );
252 } catch ( CDNNotEnabledException
$e ) {
253 // CDN not enabled; nothing to see here
254 } catch ( BadContentTypeException
$e ) {
255 $status->fatal( 'backend-fail-contenttype', $params['dst'] );
256 } catch ( CloudFilesException
$e ) { // some other exception?
257 $this->handleException( $e, $status, __METHOD__
, $params );
264 * @see SwiftFileBackend::doExecuteOpHandlesInternal()
266 protected function _getResponseCreate( CF_Async_Op
$cfOp, Status
$status, array $params ) {
268 $cfOp->getLastResponse();
269 } catch ( BadContentTypeException
$e ) {
270 $status->fatal( 'backend-fail-contenttype', $params['dst'] );
275 * @see FileBackendStore::doStoreInternal()
278 protected function doStoreInternal( array $params ) {
279 $status = Status
::newGood();
281 list( $dstCont, $dstRel ) = $this->resolveStoragePathReal( $params['dst'] );
282 if ( $dstRel === null ) {
283 $status->fatal( 'backend-fail-invalidpath', $params['dst'] );
287 // (a) Check the destination container and object
289 $dContObj = $this->getContainer( $dstCont );
290 if ( empty( $params['overwrite'] ) &&
291 $this->fileExists( array( 'src' => $params['dst'], 'latest' => 1 ) ) )
293 $status->fatal( 'backend-fail-alreadyexists', $params['dst'] );
296 } catch ( NoSuchContainerException
$e ) {
297 $status->fatal( 'backend-fail-copy', $params['src'], $params['dst'] );
299 } catch ( CloudFilesException
$e ) { // some other exception?
300 $this->handleException( $e, $status, __METHOD__
, $params );
304 // (b) Get a SHA-1 hash of the object
305 $sha1Hash = sha1_file( $params['src'] );
306 if ( $sha1Hash === false ) { // source doesn't exist?
307 $status->fatal( 'backend-fail-copy', $params['src'], $params['dst'] );
310 $sha1Hash = wfBaseConvert( $sha1Hash, 16, 36, 31 );
312 // (c) Actually store the object
314 // Create a fresh CF_Object with no fields preloaded.
315 // We don't want to preserve headers, metadata, and such.
316 $obj = new CF_Object( $dContObj, $dstRel, false, false ); // skip HEAD
317 // Note: metadata keys stored as [Upper case char][[Lower case char]...]
318 $obj->metadata
= array( 'Sha1base36' => $sha1Hash );
319 // The MD5 here will be checked within Swift against its own MD5.
320 $obj->set_etag( md5_file( $params['src'] ) );
321 // Use the same content type as StreamFile for security
322 $obj->content_type
= StreamFile
::contentTypeFromPath( $params['dst'] );
323 if ( !strlen( $obj->content_type
) ) { // special case
324 $obj->content_type
= 'unknown/unknown';
326 // Set the Content-Disposition header if requested
327 if ( isset( $params['disposition'] ) ) {
328 $obj->headers
['Content-Disposition'] = $this->truncDisp( $params['disposition'] );
330 if ( !empty( $params['async'] ) ) { // deferred
331 wfSuppressWarnings();
332 $fp = fopen( $params['src'], 'rb' );
335 $status->fatal( 'backend-fail-copy', $params['src'], $params['dst'] );
337 $op = $obj->write_async( $fp, filesize( $params['src'] ), true );
338 $status->value
= new SwiftFileOpHandle( $this, $params, 'Store', $op );
339 $status->value
->resourcesToClose
[] = $fp;
340 if ( !empty( $params['overwrite'] ) ) { // file possibly mutated
341 $status->value
->affectedObjects
[] = $obj;
344 } else { // actually write the object in Swift
345 $obj->load_from_filename( $params['src'], true ); // calls $obj->write()
346 if ( !empty( $params['overwrite'] ) ) { // file possibly mutated
347 $this->purgeCDNCache( array( $obj ) );
350 } catch ( CDNNotEnabledException
$e ) {
351 // CDN not enabled; nothing to see here
352 } catch ( BadContentTypeException
$e ) {
353 $status->fatal( 'backend-fail-contenttype', $params['dst'] );
354 } catch ( IOException
$e ) {
355 $status->fatal( 'backend-fail-copy', $params['src'], $params['dst'] );
356 } catch ( CloudFilesException
$e ) { // some other exception?
357 $this->handleException( $e, $status, __METHOD__
, $params );
364 * @see SwiftFileBackend::doExecuteOpHandlesInternal()
366 protected function _getResponseStore( CF_Async_Op
$cfOp, Status
$status, array $params ) {
368 $cfOp->getLastResponse();
369 } catch ( BadContentTypeException
$e ) {
370 $status->fatal( 'backend-fail-contenttype', $params['dst'] );
371 } catch ( IOException
$e ) {
372 $status->fatal( 'backend-fail-copy', $params['src'], $params['dst'] );
377 * @see FileBackendStore::doCopyInternal()
380 protected function doCopyInternal( array $params ) {
381 $status = Status
::newGood();
383 list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $params['src'] );
384 if ( $srcRel === null ) {
385 $status->fatal( 'backend-fail-invalidpath', $params['src'] );
389 list( $dstCont, $dstRel ) = $this->resolveStoragePathReal( $params['dst'] );
390 if ( $dstRel === null ) {
391 $status->fatal( 'backend-fail-invalidpath', $params['dst'] );
395 // (a) Check the source/destination containers and destination object
397 $sContObj = $this->getContainer( $srcCont );
398 $dContObj = $this->getContainer( $dstCont );
399 if ( empty( $params['overwrite'] ) &&
400 $this->fileExists( array( 'src' => $params['dst'], 'latest' => 1 ) ) )
402 $status->fatal( 'backend-fail-alreadyexists', $params['dst'] );
405 } catch ( NoSuchContainerException
$e ) {
406 $status->fatal( 'backend-fail-copy', $params['src'], $params['dst'] );
408 } catch ( CloudFilesException
$e ) { // some other exception?
409 $this->handleException( $e, $status, __METHOD__
, $params );
413 // (b) Actually copy the file to the destination
415 $dstObj = new CF_Object( $dContObj, $dstRel, false, false ); // skip HEAD
416 $hdrs = array(); // source file headers to override with new values
417 if ( isset( $params['disposition'] ) ) {
418 $hdrs['Content-Disposition'] = $this->truncDisp( $params['disposition'] );
420 if ( !empty( $params['async'] ) ) { // deferred
421 $op = $sContObj->copy_object_to_async( $srcRel, $dContObj, $dstRel, null, $hdrs );
422 $status->value
= new SwiftFileOpHandle( $this, $params, 'Copy', $op );
423 if ( !empty( $params['overwrite'] ) ) { // file possibly mutated
424 $status->value
->affectedObjects
[] = $dstObj;
426 } else { // actually write the object in Swift
427 $sContObj->copy_object_to( $srcRel, $dContObj, $dstRel, null, $hdrs );
428 if ( !empty( $params['overwrite'] ) ) { // file possibly mutated
429 $this->purgeCDNCache( array( $dstObj ) );
432 } catch ( CDNNotEnabledException
$e ) {
433 // CDN not enabled; nothing to see here
434 } catch ( NoSuchObjectException
$e ) { // source object does not exist
435 $status->fatal( 'backend-fail-copy', $params['src'], $params['dst'] );
436 } catch ( CloudFilesException
$e ) { // some other exception?
437 $this->handleException( $e, $status, __METHOD__
, $params );
444 * @see SwiftFileBackend::doExecuteOpHandlesInternal()
446 protected function _getResponseCopy( CF_Async_Op
$cfOp, Status
$status, array $params ) {
448 $cfOp->getLastResponse();
449 } catch ( NoSuchObjectException
$e ) { // source object does not exist
450 $status->fatal( 'backend-fail-copy', $params['src'], $params['dst'] );
455 * @see FileBackendStore::doMoveInternal()
458 protected function doMoveInternal( array $params ) {
459 $status = Status
::newGood();
461 list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $params['src'] );
462 if ( $srcRel === null ) {
463 $status->fatal( 'backend-fail-invalidpath', $params['src'] );
467 list( $dstCont, $dstRel ) = $this->resolveStoragePathReal( $params['dst'] );
468 if ( $dstRel === null ) {
469 $status->fatal( 'backend-fail-invalidpath', $params['dst'] );
473 // (a) Check the source/destination containers and destination object
475 $sContObj = $this->getContainer( $srcCont );
476 $dContObj = $this->getContainer( $dstCont );
477 if ( empty( $params['overwrite'] ) &&
478 $this->fileExists( array( 'src' => $params['dst'], 'latest' => 1 ) ) )
480 $status->fatal( 'backend-fail-alreadyexists', $params['dst'] );
483 } catch ( NoSuchContainerException
$e ) {
484 $status->fatal( 'backend-fail-move', $params['src'], $params['dst'] );
486 } catch ( CloudFilesException
$e ) { // some other exception?
487 $this->handleException( $e, $status, __METHOD__
, $params );
491 // (b) Actually move the file to the destination
493 $srcObj = new CF_Object( $sContObj, $srcRel, false, false ); // skip HEAD
494 $dstObj = new CF_Object( $dContObj, $dstRel, false, false ); // skip HEAD
495 $hdrs = array(); // source file headers to override with new values
496 if ( isset( $params['disposition'] ) ) {
497 $hdrs['Content-Disposition'] = $this->truncDisp( $params['disposition'] );
499 if ( !empty( $params['async'] ) ) { // deferred
500 $op = $sContObj->move_object_to_async( $srcRel, $dContObj, $dstRel, null, $hdrs );
501 $status->value
= new SwiftFileOpHandle( $this, $params, 'Move', $op );
502 $status->value
->affectedObjects
[] = $srcObj;
503 if ( !empty( $params['overwrite'] ) ) { // file possibly mutated
504 $status->value
->affectedObjects
[] = $dstObj;
506 } else { // actually write the object in Swift
507 $sContObj->move_object_to( $srcRel, $dContObj, $dstRel, null, $hdrs );
508 $this->purgeCDNCache( array( $srcObj ) );
509 if ( !empty( $params['overwrite'] ) ) { // file possibly mutated
510 $this->purgeCDNCache( array( $dstObj ) );
513 } catch ( CDNNotEnabledException
$e ) {
514 // CDN not enabled; nothing to see here
515 } catch ( NoSuchObjectException
$e ) { // source object does not exist
516 $status->fatal( 'backend-fail-move', $params['src'], $params['dst'] );
517 } catch ( CloudFilesException
$e ) { // some other exception?
518 $this->handleException( $e, $status, __METHOD__
, $params );
525 * @see SwiftFileBackend::doExecuteOpHandlesInternal()
527 protected function _getResponseMove( CF_Async_Op
$cfOp, Status
$status, array $params ) {
529 $cfOp->getLastResponse();
530 } catch ( NoSuchObjectException
$e ) { // source object does not exist
531 $status->fatal( 'backend-fail-move', $params['src'], $params['dst'] );
536 * @see FileBackendStore::doDeleteInternal()
539 protected function doDeleteInternal( array $params ) {
540 $status = Status
::newGood();
542 list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $params['src'] );
543 if ( $srcRel === null ) {
544 $status->fatal( 'backend-fail-invalidpath', $params['src'] );
549 $sContObj = $this->getContainer( $srcCont );
550 $srcObj = new CF_Object( $sContObj, $srcRel, false, false ); // skip HEAD
551 if ( !empty( $params['async'] ) ) { // deferred
552 $op = $sContObj->delete_object_async( $srcRel );
553 $status->value
= new SwiftFileOpHandle( $this, $params, 'Delete', $op );
554 $status->value
->affectedObjects
[] = $srcObj;
555 } else { // actually write the object in Swift
556 $sContObj->delete_object( $srcRel );
557 $this->purgeCDNCache( array( $srcObj ) );
559 } catch ( CDNNotEnabledException
$e ) {
560 // CDN not enabled; nothing to see here
561 } catch ( NoSuchContainerException
$e ) {
562 $status->fatal( 'backend-fail-delete', $params['src'] );
563 } catch ( NoSuchObjectException
$e ) {
564 if ( empty( $params['ignoreMissingSource'] ) ) {
565 $status->fatal( 'backend-fail-delete', $params['src'] );
567 } catch ( CloudFilesException
$e ) { // some other exception?
568 $this->handleException( $e, $status, __METHOD__
, $params );
575 * @see SwiftFileBackend::doExecuteOpHandlesInternal()
577 protected function _getResponseDelete( CF_Async_Op
$cfOp, Status
$status, array $params ) {
579 $cfOp->getLastResponse();
580 } catch ( NoSuchContainerException
$e ) {
581 $status->fatal( 'backend-fail-delete', $params['src'] );
582 } catch ( NoSuchObjectException
$e ) {
583 if ( empty( $params['ignoreMissingSource'] ) ) {
584 $status->fatal( 'backend-fail-delete', $params['src'] );
590 * @see FileBackendStore::doPrepareInternal()
593 protected function doPrepareInternal( $fullCont, $dir, array $params ) {
594 $status = Status
::newGood();
596 // (a) Check if container already exists
598 $contObj = $this->getContainer( $fullCont );
599 // NoSuchContainerException not thrown: container must exist
600 return $status; // already exists
601 } catch ( NoSuchContainerException
$e ) {
602 // NoSuchContainerException thrown: container does not exist
603 } catch ( CloudFilesException
$e ) { // some other exception?
604 $this->handleException( $e, $status, __METHOD__
, $params );
608 // (b) Create container as needed
610 $contObj = $this->createContainer( $fullCont );
611 if ( !empty( $params['noAccess'] ) ) {
612 // Make container private to end-users...
613 $status->merge( $this->doSecureInternal( $fullCont, $dir, $params ) );
615 // Make container public to end-users...
616 $status->merge( $this->doPublishInternal( $fullCont, $dir, $params ) );
618 if ( $this->swiftUseCDN
) { // Rackspace style CDN
619 $contObj->make_public( $this->swiftCDNExpiry
);
621 } catch ( CDNNotEnabledException
$e ) {
622 // CDN not enabled; nothing to see here
623 } catch ( CloudFilesException
$e ) { // some other exception?
624 $this->handleException( $e, $status, __METHOD__
, $params );
632 * @see FileBackendStore::doSecureInternal()
635 protected function doSecureInternal( $fullCont, $dir, array $params ) {
636 $status = Status
::newGood();
637 if ( empty( $params['noAccess'] ) ) {
638 return $status; // nothing to do
641 // Restrict container from end-users...
643 // doPrepareInternal() should have been called,
644 // so the Swift container should already exist...
645 $contObj = $this->getContainer( $fullCont ); // normally a cache hit
646 // NoSuchContainerException not thrown: container must exist
648 // Make container private to end-users...
649 $status->merge( $this->setContainerAccess(
651 array( $this->auth
->username
), // read
652 array( $this->auth
->username
) // write
654 if ( $this->swiftUseCDN
&& $contObj->is_public() ) { // Rackspace style CDN
655 $contObj->make_private();
657 } catch ( CDNNotEnabledException
$e ) {
658 // CDN not enabled; nothing to see here
659 } catch ( CloudFilesException
$e ) { // some other exception?
660 $this->handleException( $e, $status, __METHOD__
, $params );
667 * @see FileBackendStore::doPublishInternal()
670 protected function doPublishInternal( $fullCont, $dir, array $params ) {
671 $status = Status
::newGood();
673 // Unrestrict container from end-users...
675 // doPrepareInternal() should have been called,
676 // so the Swift container should already exist...
677 $contObj = $this->getContainer( $fullCont ); // normally a cache hit
678 // NoSuchContainerException not thrown: container must exist
680 // Make container public to end-users...
681 if ( $this->swiftAnonUser
!= '' ) {
682 $status->merge( $this->setContainerAccess(
684 array( $this->auth
->username
, $this->swiftAnonUser
), // read
685 array( $this->auth
->username
, $this->swiftAnonUser
) // write
688 $status->merge( $this->setContainerAccess(
690 array( $this->auth
->username
, '.r:*' ), // read
691 array( $this->auth
->username
) // write
694 if ( $this->swiftUseCDN
&& !$contObj->is_public() ) { // Rackspace style CDN
695 $contObj->make_public();
697 } catch ( CDNNotEnabledException
$e ) {
698 // CDN not enabled; nothing to see here
699 } catch ( CloudFilesException
$e ) { // some other exception?
700 $this->handleException( $e, $status, __METHOD__
, $params );
707 * @see FileBackendStore::doCleanInternal()
710 protected function doCleanInternal( $fullCont, $dir, array $params ) {
711 $status = Status
::newGood();
713 // Only containers themselves can be removed, all else is virtual
715 return $status; // nothing to do
718 // (a) Check the container
720 $contObj = $this->getContainer( $fullCont, true );
721 } catch ( NoSuchContainerException
$e ) {
722 return $status; // ok, nothing to do
723 } catch ( CloudFilesException
$e ) { // some other exception?
724 $this->handleException( $e, $status, __METHOD__
, $params );
728 // (b) Delete the container if empty
729 if ( $contObj->object_count
== 0 ) {
731 $this->deleteContainer( $fullCont );
732 } catch ( NoSuchContainerException
$e ) {
733 return $status; // race?
734 } catch ( NonEmptyContainerException
$e ) {
735 return $status; // race? consistency delay?
736 } catch ( CloudFilesException
$e ) { // some other exception?
737 $this->handleException( $e, $status, __METHOD__
, $params );
746 * @see FileBackendStore::doFileExists()
747 * @return array|bool|null
749 protected function doGetFileStat( array $params ) {
750 list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $params['src'] );
751 if ( $srcRel === null ) {
752 return false; // invalid storage path
757 $contObj = $this->getContainer( $srcCont );
758 $srcObj = $contObj->get_object( $srcRel, $this->headersFromParams( $params ) );
759 $this->addMissingMetadata( $srcObj, $params['src'] );
761 // Convert dates like "Tue, 03 Jan 2012 22:01:04 GMT" to TS_MW
762 'mtime' => wfTimestamp( TS_MW
, $srcObj->last_modified
),
763 'size' => (int)$srcObj->content_length
,
764 'sha1' => $srcObj->metadata
['Sha1base36']
766 } catch ( NoSuchContainerException
$e ) {
767 } catch ( NoSuchObjectException
$e ) {
768 } catch ( CloudFilesException
$e ) { // some other exception?
770 $this->handleException( $e, null, __METHOD__
, $params );
777 * Fill in any missing object metadata and save it to Swift
779 * @param $obj CF_Object
780 * @param $path string Storage path to object
781 * @return bool Success
782 * @throws Exception cloudfiles exceptions
784 protected function addMissingMetadata( CF_Object
$obj, $path ) {
785 if ( isset( $obj->metadata
['Sha1base36'] ) ) {
786 return true; // nothing to do
788 wfProfileIn( __METHOD__
);
789 $status = Status
::newGood();
790 $scopeLockS = $this->getScopedFileLocks( array( $path ), LockManager
::LOCK_UW
, $status );
791 if ( $status->isOK() ) {
792 $tmpFile = $this->getLocalCopy( array( 'src' => $path, 'latest' => 1 ) );
794 $hash = $tmpFile->getSha1Base36();
795 if ( $hash !== false ) {
796 $obj->metadata
['Sha1base36'] = $hash;
797 $obj->sync_metadata(); // save to Swift
798 wfProfileOut( __METHOD__
);
799 return true; // success
803 $obj->metadata
['Sha1base36'] = false;
804 wfProfileOut( __METHOD__
);
805 return false; // failed
809 * @see FileBackend::getFileContents()
810 * @return bool|string
812 public function getFileContents( array $params ) {
813 list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $params['src'] );
814 if ( $srcRel === null ) {
815 return false; // invalid storage path
820 $sContObj = $this->getContainer( $srcCont );
821 $obj = new CF_Object( $sContObj, $srcRel, false, false ); // skip HEAD
822 $data = $obj->read( $this->headersFromParams( $params ) );
823 } catch ( NoSuchContainerException
$e ) {
824 } catch ( NoSuchObjectException
$e ) {
825 } catch ( CloudFilesException
$e ) { // some other exception?
826 $this->handleException( $e, null, __METHOD__
, $params );
833 * @see FileBackendStore::doDirectoryExists()
836 protected function doDirectoryExists( $fullCont, $dir, array $params ) {
838 $container = $this->getContainer( $fullCont );
839 $prefix = ( $dir == '' ) ?
null : "{$dir}/";
840 return ( count( $container->list_objects( 1, null, $prefix ) ) > 0 );
841 } catch ( NoSuchContainerException
$e ) {
843 } catch ( CloudFilesException
$e ) { // some other exception?
844 $this->handleException( $e, null, __METHOD__
,
845 array( 'cont' => $fullCont, 'dir' => $dir ) );
848 return null; // error
852 * @see FileBackendStore::getDirectoryListInternal()
853 * @return SwiftFileBackendDirList
855 public function getDirectoryListInternal( $fullCont, $dir, array $params ) {
856 return new SwiftFileBackendDirList( $this, $fullCont, $dir, $params );
860 * @see FileBackendStore::getFileListInternal()
861 * @return SwiftFileBackendFileList
863 public function getFileListInternal( $fullCont, $dir, array $params ) {
864 return new SwiftFileBackendFileList( $this, $fullCont, $dir, $params );
868 * Do not call this function outside of SwiftFileBackendFileList
870 * @param $fullCont string Resolved container name
871 * @param $dir string Resolved storage directory with no trailing slash
872 * @param $after string|null Storage path of file to list items after
873 * @param $limit integer Max number of items to list
874 * @param $params Array Includes flag for 'topOnly'
875 * @return Array List of relative paths of dirs directly under $dir
877 public function getDirListPageInternal( $fullCont, $dir, &$after, $limit, array $params ) {
879 if ( $after === INF
) {
880 return $dirs; // nothing more
882 wfProfileIn( __METHOD__
. '-' . $this->name
);
885 $container = $this->getContainer( $fullCont );
886 $prefix = ( $dir == '' ) ?
null : "{$dir}/";
887 // Non-recursive: only list dirs right under $dir
888 if ( !empty( $params['topOnly'] ) ) {
889 $objects = $container->list_objects( $limit, $after, $prefix, null, '/' );
890 foreach ( $objects as $object ) { // files and dirs
891 if ( substr( $object, -1 ) === '/' ) {
892 $dirs[] = $object; // directories end in '/'
895 // Recursive: list all dirs under $dir and its subdirs
897 // Get directory from last item of prior page
898 $lastDir = $this->getParentDir( $after ); // must be first page
899 $objects = $container->list_objects( $limit, $after, $prefix );
900 foreach ( $objects as $object ) { // files
901 $objectDir = $this->getParentDir( $object ); // directory of object
902 if ( $objectDir !== false ) { // file has a parent dir
903 // Swift stores paths in UTF-8, using binary sorting.
904 // See function "create_container_table" in common/db.py.
905 // If a directory is not "greater" than the last one,
906 // then it was already listed by the calling iterator.
907 if ( strcmp( $objectDir, $lastDir ) > 0 ) {
909 do { // add dir and all its parent dirs
910 $dirs[] = "{$pDir}/";
911 $pDir = $this->getParentDir( $pDir );
912 } while ( $pDir !== false // sanity
913 && strcmp( $pDir, $lastDir ) > 0 // not done already
914 && strlen( $pDir ) > strlen( $dir ) // within $dir
917 $lastDir = $objectDir;
921 if ( count( $objects ) < $limit ) {
922 $after = INF
; // avoid a second RTT
924 $after = end( $objects ); // update last item
926 } catch ( NoSuchContainerException
$e ) {
927 } catch ( CloudFilesException
$e ) { // some other exception?
928 $this->handleException( $e, null, __METHOD__
,
929 array( 'cont' => $fullCont, 'dir' => $dir ) );
932 wfProfileOut( __METHOD__
. '-' . $this->name
);
936 protected function getParentDir( $path ) {
937 return ( strpos( $path, '/' ) !== false ) ?
dirname( $path ) : false;
941 * Do not call this function outside of SwiftFileBackendFileList
943 * @param $fullCont string Resolved container name
944 * @param $dir string Resolved storage directory with no trailing slash
945 * @param $after string|null Storage path of file to list items after
946 * @param $limit integer Max number of items to list
947 * @param $params Array Includes flag for 'topOnly'
948 * @return Array List of relative paths of files under $dir
950 public function getFileListPageInternal( $fullCont, $dir, &$after, $limit, array $params ) {
952 if ( $after === INF
) {
953 return $files; // nothing more
955 wfProfileIn( __METHOD__
. '-' . $this->name
);
958 $container = $this->getContainer( $fullCont );
959 $prefix = ( $dir == '' ) ?
null : "{$dir}/";
960 // Non-recursive: only list files right under $dir
961 if ( !empty( $params['topOnly'] ) ) { // files and dirs
962 $objects = $container->list_objects( $limit, $after, $prefix, null, '/' );
963 foreach ( $objects as $object ) {
964 if ( substr( $object, -1 ) !== '/' ) {
965 $files[] = $object; // directories end in '/'
968 // Recursive: list all files under $dir and its subdirs
970 $objects = $container->list_objects( $limit, $after, $prefix );
973 if ( count( $objects ) < $limit ) {
974 $after = INF
; // avoid a second RTT
976 $after = end( $objects ); // update last item
978 } catch ( NoSuchContainerException
$e ) {
979 } catch ( CloudFilesException
$e ) { // some other exception?
980 $this->handleException( $e, null, __METHOD__
,
981 array( 'cont' => $fullCont, 'dir' => $dir ) );
984 wfProfileOut( __METHOD__
. '-' . $this->name
);
989 * @see FileBackendStore::doGetFileSha1base36()
992 protected function doGetFileSha1base36( array $params ) {
993 $stat = $this->getFileStat( $params );
995 return $stat['sha1'];
1002 * @see FileBackendStore::doStreamFile()
1005 protected function doStreamFile( array $params ) {
1006 $status = Status
::newGood();
1008 list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $params['src'] );
1009 if ( $srcRel === null ) {
1010 $status->fatal( 'backend-fail-invalidpath', $params['src'] );
1014 $cont = $this->getContainer( $srcCont );
1015 } catch ( NoSuchContainerException
$e ) {
1016 $status->fatal( 'backend-fail-stream', $params['src'] );
1018 } catch ( CloudFilesException
$e ) { // some other exception?
1019 $this->handleException( $e, $status, __METHOD__
, $params );
1024 $output = fopen( 'php://output', 'wb' );
1025 $obj = new CF_Object( $cont, $srcRel, false, false ); // skip HEAD
1026 $obj->stream( $output, $this->headersFromParams( $params ) );
1027 } catch ( NoSuchObjectException
$e ) {
1028 $status->fatal( 'backend-fail-stream', $params['src'] );
1029 } catch ( CloudFilesException
$e ) { // some other exception?
1030 $this->handleException( $e, $status, __METHOD__
, $params );
1037 * @see FileBackendStore::getLocalCopy()
1038 * @return null|TempFSFile
1040 public function getLocalCopy( array $params ) {
1041 list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $params['src'] );
1042 if ( $srcRel === null ) {
1046 // Blindly create a tmp file and stream to it, catching any exception if the file does
1047 // not exist. Also, doing a stat here will cause infinite loops in addMissingMetadata().
1050 $sContObj = $this->getContainer( $srcCont );
1051 $obj = new CF_Object( $sContObj, $srcRel, false, false ); // skip HEAD
1052 // Get source file extension
1053 $ext = FileBackend
::extensionFromPath( $srcRel );
1054 // Create a new temporary file...
1055 $tmpFile = TempFSFile
::factory( 'localcopy_', $ext );
1057 $handle = fopen( $tmpFile->getPath(), 'wb' );
1059 $obj->stream( $handle, $this->headersFromParams( $params ) );
1062 $tmpFile = null; // couldn't open temp file
1065 } catch ( NoSuchContainerException
$e ) {
1067 } catch ( NoSuchObjectException
$e ) {
1069 } catch ( CloudFilesException
$e ) { // some other exception?
1071 $this->handleException( $e, null, __METHOD__
, $params );
1078 * @see FileBackendStore::directoriesAreVirtual()
1081 protected function directoriesAreVirtual() {
1086 * Get headers to send to Swift when reading a file based
1087 * on a FileBackend params array, e.g. that of getLocalCopy().
1088 * $params is currently only checked for a 'latest' flag.
1090 * @param $params Array
1093 protected function headersFromParams( array $params ) {
1095 if ( !empty( $params['latest'] ) ) {
1096 $hdrs[] = 'X-Newest: true';
1102 * @see FileBackendStore::doExecuteOpHandlesInternal()
1103 * @return Array List of corresponding Status objects
1105 protected function doExecuteOpHandlesInternal( array $fileOpHandles ) {
1106 $statuses = array();
1108 $cfOps = array(); // list of CF_Async_Op objects
1109 foreach ( $fileOpHandles as $index => $fileOpHandle ) {
1110 $cfOps[$index] = $fileOpHandle->cfOp
;
1112 $batch = new CF_Async_Op_Batch( $cfOps );
1114 $cfOps = $batch->execute();
1115 foreach ( $cfOps as $index => $cfOp ) {
1116 $status = Status
::newGood();
1117 try { // catch exceptions; update status
1118 $function = '_getResponse' . $fileOpHandles[$index]->call
;
1119 $this->$function( $cfOp, $status, $fileOpHandles[$index]->params
);
1120 $this->purgeCDNCache( $fileOpHandles[$index]->affectedObjects
);
1121 } catch ( CloudFilesException
$e ) { // some other exception?
1122 $this->handleException( $e, $status,
1123 __CLASS__
. ":$function", $fileOpHandles[$index]->params
);
1125 $statuses[$index] = $status;
1132 * Set read/write permissions for a Swift container.
1134 * $readGrps is a list of the possible criteria for a request to have
1135 * access to read a container. Each item is one of the following formats:
1136 * - account:user : Grants access if the request is by the given user
1137 * - .r:<regex> : Grants access if the request is from a referrer host that
1138 * matches the expression and the request is not for a listing.
1139 * Setting this to '*' effectively makes a container public.
1140 * - .rlistings:<regex> : Grants access if the request is from a referrer host that
1141 * matches the expression and the request for a listing.
1143 * $writeGrps is a list of the possible criteria for a request to have
1144 * access to write to a container. Each item is of the following format:
1145 * - account:user : Grants access if the request is by the given user
1147 * @see http://swift.openstack.org/misc.html#acls
1149 * In general, we don't allow listings to end-users. It's not useful, isn't well-defined
1150 * (lists are truncated to 10000 item with no way to page), and is just a performance risk.
1152 * @param $contObj CF_Container Swift container
1153 * @param $readGrps Array List of read access routes
1154 * @param $writeGrps Array List of write access routes
1157 protected function setContainerAccess(
1158 CF_Container
$contObj, array $readGrps, array $writeGrps
1160 $creds = $contObj->cfs_auth
->export_credentials();
1162 $url = $creds['storage_url'] . '/' . rawurlencode( $contObj->name
);
1164 // Note: 10 second timeout consistent with php-cloudfiles
1165 $req = MWHttpRequest
::factory( $url, array( 'method' => 'POST', 'timeout' => 10 ) );
1166 $req->setHeader( 'X-Auth-Token', $creds['auth_token'] );
1167 $req->setHeader( 'X-Container-Read', implode( ',', $readGrps ) );
1168 $req->setHeader( 'X-Container-Write', implode( ',', $writeGrps ) );
1170 return $req->execute(); // should return 204
1174 * Purge the CDN cache of affected objects if CDN caching is enabled.
1175 * This is for Rackspace/Akamai CDNs.
1177 * @param $objects Array List of CF_Object items
1180 public function purgeCDNCache( array $objects ) {
1181 if ( $this->swiftUseCDN
&& $this->swiftCDNPurgable
) {
1182 foreach ( $objects as $object ) {
1184 $object->purge_from_cdn();
1185 } catch ( CDNNotEnabledException
$e ) {
1186 // CDN not enabled; nothing to see here
1187 } catch ( CloudFilesException
$e ) {
1188 $this->handleException( $e, null, __METHOD__
,
1189 array( 'cont' => $object->container
->name
, 'obj' => $object->name
) );
1196 * Get an authenticated connection handle to the Swift proxy
1198 * @return CF_Connection|bool False on failure
1199 * @throws CloudFilesException
1201 protected function getConnection() {
1202 if ( $this->connException
instanceof CloudFilesException
) {
1203 if ( ( time() - $this->connErrorTime
) < 60 ) {
1204 throw $this->connException
; // failed last attempt; don't bother
1205 } else { // actually retry this time
1206 $this->connException
= null;
1207 $this->connErrorTime
= 0;
1210 // Session keys expire after a while, so we renew them periodically
1211 $reAuth = ( ( time() - $this->sessionStarted
) > $this->authTTL
);
1212 // Authenticate with proxy and get a session key...
1213 if ( !$this->conn ||
$reAuth ) {
1214 $this->sessionStarted
= 0;
1215 $this->connContainerCache
->clear();
1216 $cacheKey = $this->getCredsCacheKey( $this->auth
->username
);
1217 $creds = $this->srvCache
->get( $cacheKey ); // credentials
1218 if ( is_array( $creds ) ) { // cache hit
1219 $this->auth
->load_cached_credentials(
1220 $creds['auth_token'], $creds['storage_url'], $creds['cdnm_url'] );
1221 $this->sessionStarted
= time() - ceil( $this->authTTL
/2 ); // skew for worst case
1222 } else { // cache miss
1224 $this->auth
->authenticate();
1225 $creds = $this->auth
->export_credentials();
1226 $this->srvCache
->add( $cacheKey, $creds, ceil( $this->authTTL
/2 ) ); // cache
1227 $this->sessionStarted
= time();
1228 } catch ( CloudFilesException
$e ) {
1229 $this->connException
= $e; // don't keep re-trying
1230 $this->connErrorTime
= time();
1231 throw $e; // throw it back
1234 if ( $this->conn
) { // re-authorizing?
1235 $this->conn
->close(); // close active cURL handles in CF_Http object
1237 $this->conn
= new CF_Connection( $this->auth
);
1243 * Close the connection to the Swift proxy
1247 protected function closeConnection() {
1248 if ( $this->conn
) {
1249 $this->conn
->close(); // close active cURL handles in CF_Http object
1250 $this->sessionStarted
= 0;
1251 $this->connContainerCache
->clear();
1256 * Get the cache key for a container
1258 * @param $username string
1261 private function getCredsCacheKey( $username ) {
1262 return wfMemcKey( 'backend', $this->getName(), 'usercreds', $username );
1266 * @see FileBackendStore::doClearCache()
1268 protected function doClearCache( array $paths = null ) {
1269 $this->connContainerCache
->clear(); // clear container object cache
1273 * Get a Swift container object, possibly from process cache.
1274 * Use $reCache if the file count or byte count is needed.
1276 * @param $container string Container name
1277 * @param $bypassCache bool Bypass all caches and load from Swift
1278 * @return CF_Container
1279 * @throws CloudFilesException
1281 protected function getContainer( $container, $bypassCache = false ) {
1282 $conn = $this->getConnection(); // Swift proxy connection
1283 if ( $bypassCache ) { // purge cache
1284 $this->connContainerCache
->clear( $container );
1285 } elseif ( !$this->connContainerCache
->has( $container, 'obj' ) ) {
1286 $this->primeContainerCache( array( $container ) ); // check persistent cache
1288 if ( !$this->connContainerCache
->has( $container, 'obj' ) ) {
1289 $contObj = $conn->get_container( $container );
1290 // NoSuchContainerException not thrown: container must exist
1291 $this->connContainerCache
->set( $container, 'obj', $contObj ); // cache it
1292 if ( !$bypassCache ) {
1293 $this->setContainerCache( $container, // update persistent cache
1294 array( 'bytes' => $contObj->bytes_used
, 'count' => $contObj->object_count
)
1298 return $this->connContainerCache
->get( $container, 'obj' );
1302 * Create a Swift container
1304 * @param $container string Container name
1305 * @return CF_Container
1306 * @throws CloudFilesException
1308 protected function createContainer( $container ) {
1309 $conn = $this->getConnection(); // Swift proxy connection
1310 $contObj = $conn->create_container( $container );
1311 $this->connContainerCache
->set( $container, 'obj', $contObj ); // cache
1316 * Delete a Swift container
1318 * @param $container string Container name
1320 * @throws CloudFilesException
1322 protected function deleteContainer( $container ) {
1323 $conn = $this->getConnection(); // Swift proxy connection
1324 $this->connContainerCache
->clear( $container ); // purge
1325 $conn->delete_container( $container );
1329 * @see FileBackendStore::doPrimeContainerCache()
1332 protected function doPrimeContainerCache( array $containerInfo ) {
1334 $conn = $this->getConnection(); // Swift proxy connection
1335 foreach ( $containerInfo as $container => $info ) {
1336 $contObj = new CF_Container( $conn->cfs_auth
, $conn->cfs_http
,
1337 $container, $info['count'], $info['bytes'] );
1338 $this->connContainerCache
->set( $container, 'obj', $contObj );
1340 } catch ( CloudFilesException
$e ) { // some other exception?
1341 $this->handleException( $e, null, __METHOD__
, array() );
1346 * Log an unexpected exception for this backend.
1347 * This also sets the Status object to have a fatal error.
1349 * @param $e Exception
1350 * @param $status Status|null
1351 * @param $func string
1352 * @param $params Array
1355 protected function handleException( Exception
$e, $status, $func, array $params ) {
1356 if ( $status instanceof Status
) {
1357 if ( $e instanceof AuthenticationException
) {
1358 $status->fatal( 'backend-fail-connect', $this->name
);
1360 $status->fatal( 'backend-fail-internal', $this->name
);
1363 if ( $e->getMessage() ) {
1364 trigger_error( "$func: " . $e->getMessage(), E_USER_WARNING
);
1366 if ( $e instanceof InvalidResponseException
) { // possibly a stale token
1367 $this->srvCache
->delete( $this->getCredsCacheKey( $this->auth
->username
) );
1368 $this->closeConnection(); // force a re-connect and re-auth next time
1370 wfDebugLog( 'SwiftBackend',
1371 get_class( $e ) . " in '{$func}' (given '" . FormatJson
::encode( $params ) . "')" .
1372 ( $e->getMessage() ?
": {$e->getMessage()}" : "" )
1378 * @see FileBackendStoreOpHandle
1380 class SwiftFileOpHandle
extends FileBackendStoreOpHandle
{
1381 /** @var CF_Async_Op */
1384 public $affectedObjects = array();
1386 public function __construct( $backend, array $params, $call, CF_Async_Op
$cfOp ) {
1387 $this->backend
= $backend;
1388 $this->params
= $params;
1389 $this->call
= $call;
1390 $this->cfOp
= $cfOp;
1395 * SwiftFileBackend helper class to page through listings.
1396 * Swift also has a listing limit of 10,000 objects for sanity.
1397 * Do not use this class from places outside SwiftFileBackend.
1399 * @ingroup FileBackend
1401 abstract class SwiftFileBackendList
implements Iterator
{
1403 protected $bufferIter = array();
1404 protected $bufferAfter = null; // string; list items *after* this path
1405 protected $pos = 0; // integer
1407 protected $params = array();
1409 /** @var SwiftFileBackend */
1411 protected $container; // string; container name
1412 protected $dir; // string; storage directory
1413 protected $suffixStart; // integer
1415 const PAGE_SIZE
= 9000; // file listing buffer size
1418 * @param $backend SwiftFileBackend
1419 * @param $fullCont string Resolved container name
1420 * @param $dir string Resolved directory relative to container
1421 * @param $params Array
1423 public function __construct( SwiftFileBackend
$backend, $fullCont, $dir, array $params ) {
1424 $this->backend
= $backend;
1425 $this->container
= $fullCont;
1427 if ( substr( $this->dir
, -1 ) === '/' ) {
1428 $this->dir
= substr( $this->dir
, 0, -1 ); // remove trailing slash
1430 if ( $this->dir
== '' ) { // whole container
1431 $this->suffixStart
= 0;
1432 } else { // dir within container
1433 $this->suffixStart
= strlen( $this->dir
) +
1; // size of "path/to/dir/"
1435 $this->params
= $params;
1439 * @see Iterator::key()
1442 public function key() {
1447 * @see Iterator::next()
1450 public function next() {
1451 // Advance to the next file in the page
1452 next( $this->bufferIter
);
1454 // Check if there are no files left in this page and
1455 // advance to the next page if this page was not empty.
1456 if ( !$this->valid() && count( $this->bufferIter
) ) {
1457 $this->bufferIter
= $this->pageFromList(
1458 $this->container
, $this->dir
, $this->bufferAfter
, self
::PAGE_SIZE
, $this->params
1459 ); // updates $this->bufferAfter
1464 * @see Iterator::rewind()
1467 public function rewind() {
1469 $this->bufferAfter
= null;
1470 $this->bufferIter
= $this->pageFromList(
1471 $this->container
, $this->dir
, $this->bufferAfter
, self
::PAGE_SIZE
, $this->params
1472 ); // updates $this->bufferAfter
1476 * @see Iterator::valid()
1479 public function valid() {
1480 if ( $this->bufferIter
=== null ) {
1481 return false; // some failure?
1483 return ( current( $this->bufferIter
) !== false ); // no paths can have this value
1488 * Get the given list portion (page)
1490 * @param $container string Resolved container name
1491 * @param $dir string Resolved path relative to container
1492 * @param $after string|null
1493 * @param $limit integer
1494 * @param $params Array
1495 * @return Traversable|Array|null Returns null on failure
1497 abstract protected function pageFromList( $container, $dir, &$after, $limit, array $params );
1501 * Iterator for listing directories
1503 class SwiftFileBackendDirList
extends SwiftFileBackendList
{
1505 * @see Iterator::current()
1506 * @return string|bool String (relative path) or false
1508 public function current() {
1509 return substr( current( $this->bufferIter
), $this->suffixStart
, -1 );
1513 * @see SwiftFileBackendList::pageFromList()
1514 * @return Array|null
1516 protected function pageFromList( $container, $dir, &$after, $limit, array $params ) {
1517 return $this->backend
->getDirListPageInternal( $container, $dir, $after, $limit, $params );
1522 * Iterator for listing regular files
1524 class SwiftFileBackendFileList
extends SwiftFileBackendList
{
1526 * @see Iterator::current()
1527 * @return string|bool String (relative path) or false
1529 public function current() {
1530 return substr( current( $this->bufferIter
), $this->suffixStart
);
1534 * @see SwiftFileBackendList::pageFromList()
1535 * @return Array|null
1537 protected function pageFromList( $container, $dir, &$after, $limit, array $params ) {
1538 return $this->backend
->getFileListPageInternal( $container, $dir, $after, $limit, $params );