c435212260
This is mostly about adding return types to methods that implement PHP interfaces, and not passing null to core functions that want a string. After this patch, and an update to return types in RemexHtml, tests/phpunit/integration/ has no more errors than in PHP 8.0. Bug: T289879 Bug: T289926 Change-Id: Ia424f5cc897070f4188ae126b5bf6a1f552db0e1
139 lines
3.9 KiB
PHP
139 lines
3.9 KiB
PHP
<?php
|
|
/**
|
|
* OpenStack Swift based file backend.
|
|
*
|
|
* 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
|
|
* @author Russ Nelson
|
|
*/
|
|
|
|
/**
|
|
* SwiftFileBackend helper class to page through listings.
|
|
* Swift also has a listing limit of 10,000 objects for performance.
|
|
* Do not use this class from places outside SwiftFileBackend.
|
|
*
|
|
* @ingroup FileBackend
|
|
*/
|
|
abstract class SwiftFileBackendList implements Iterator {
|
|
/** @var array List of path or (path,stat array) entries */
|
|
protected $bufferIter = [];
|
|
|
|
/** @var string|null List items *after* this path */
|
|
protected $bufferAfter = null;
|
|
|
|
/** @var int */
|
|
protected $pos = 0;
|
|
|
|
/** @var array */
|
|
protected $params = [];
|
|
|
|
/** @var SwiftFileBackend */
|
|
protected $backend;
|
|
|
|
/** @var string Container name */
|
|
protected $container;
|
|
|
|
/** @var string Storage directory */
|
|
protected $dir;
|
|
|
|
/** @var int */
|
|
protected $suffixStart;
|
|
|
|
private const PAGE_SIZE = 9000; // file listing buffer size
|
|
|
|
/**
|
|
* @param SwiftFileBackend $backend
|
|
* @param string $fullCont Resolved container name
|
|
* @param string $dir Resolved directory relative to container
|
|
* @param array $params
|
|
*/
|
|
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
|
|
}
|
|
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 int
|
|
*/
|
|
public function key(): int {
|
|
return $this->pos;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function next(): void {
|
|
// Advance to the next file in the page
|
|
next( $this->bufferIter );
|
|
++$this->pos;
|
|
// 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->bufferIter = $this->pageFromList(
|
|
$this->container, $this->dir, $this->bufferAfter, self::PAGE_SIZE, $this->params
|
|
); // updates $this->bufferAfter
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function rewind(): void {
|
|
$this->pos = 0;
|
|
$this->bufferAfter = null;
|
|
$this->bufferIter = $this->pageFromList(
|
|
// @phan-suppress-next-line PhanTypeMismatchArgumentPropertyReferenceReal
|
|
$this->container, $this->dir, $this->bufferAfter, self::PAGE_SIZE, $this->params
|
|
); // updates $this->bufferAfter
|
|
}
|
|
|
|
/**
|
|
* @see Iterator::valid()
|
|
* @return bool
|
|
*/
|
|
public function valid(): bool {
|
|
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 string $container Resolved container name
|
|
* @param string $dir Resolved path relative to container
|
|
* @param string &$after @phan-output-reference
|
|
* @param int $limit
|
|
* @param array $params
|
|
* @return Traversable|array
|
|
*/
|
|
abstract protected function pageFromList( $container, $dir, &$after, $limit, array $params );
|
|
}
|