FileBackendStoreShardListIterator.php

Go to the documentation of this file.

<?php
namespace Wikimedia\FileBackend\FileIteration;
 
use AppendIterator;
use FilterIterator;
use Iterator;
use Wikimedia\FileBackend\FileBackendStore;
 
abstract class FileBackendStoreShardListIterator extends FilterIterator {
    protected $backend;
 
    protected $params;
 
    protected $container;
 
    protected $directory;
 
    protected $multiShardPaths = []; // (rel path => 1)
 
    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 = [];
    }
 
    abstract protected function listFromShard( $container );
}
 
class_alias( FileBackendStoreShardListIterator::class, 'FileBackendStoreShardListIterator' );