Page MenuHomeWickedGov Phorge
Files F5955154

FileBackendStoreShardListIterator.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

FileBackendStoreShardListIterator.php
View Options

<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup FileBackend
*/
namespace Wikimedia\FileBackend\FileIteration;
use AppendIterator;
use FilterIterator;
use Iterator;
use Wikimedia\FileBackend\FileBackendStore;
/**
* FileBackendStore helper function to handle listings that span container shards.
* Do not use this class from places outside of FileBackendStore.
*
* @ingroup FileBackend
*/
abstract class FileBackendStoreShardListIterator extends FilterIterator {
/** @var FileBackendStore */
protected $backend;
/** @var array */
protected $params;
/** @var string Full container name */
protected $container;
/** @var string Resolved relative path */
protected $directory;
/** @var array */
protected $multiShardPaths = []; // (rel path => 1)
/**
* @param FileBackendStore $backend
* @param string $container Full storage container name
* @param string $dir Storage directory relative to container
* @param array $suffixes List of container shard suffixes
* @param array $params
*/
public function __construct(
FileBackendStore $backend, $container, $dir, array $suffixes, array $params
) {
$this->backend = $backend;
$this->container = $container;
$this->directory = $dir;
$this->params = $params;
$iter = new AppendIterator();
foreach ( $suffixes as $suffix ) {
$iter->append( $this->listFromShard( $this->container . $suffix ) );
}
parent::__construct( $iter );
}
public function accept(): bool {
$inner = $this->getInnerIterator();
'@phan-var AppendIterator $inner';
$rel = $inner->current(); // path relative to given directory
$path = $this->params['dir'] . "/{$rel}"; // full storage path
if ( $this->backend->isSingleShardPathInternal( $path ) ) {
return true; // path is only on one shard; no issue with duplicates
} elseif ( isset( $this->multiShardPaths[$rel] ) ) {
// Don't keep listing paths that are on multiple shards
return false;
} else {
$this->multiShardPaths[$rel] = 1;
return true;
}
}
public function rewind(): void {
parent::rewind();
$this->multiShardPaths = [];
}
/**
* Get the list for a given container shard
*
* @param string $container Resolved container name
* @return Iterator
*/
abstract protected function listFromShard( $container );
}
/** @deprecated class alias since 1.43 */
class_alias( FileBackendStoreShardListIterator::class, 'FileBackendStoreShardListIterator' );

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 03:29 (3 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
c5/df/1749c1517421c008cd34491e6f7b
Default Alt Text
FileBackendStoreShardListIterator.php (3 KB)

Event Timeline