const TABLES = ['photo', 'attach'];
// Default storage backends
+ /** @var string[] */
const DEFAULT_BACKENDS = [
- Storage\Filesystem::NAME => Storage\Filesystem::class,
- Storage\Database::NAME => Storage\Database::class,
+ Storage\Filesystem::NAME,
+ Storage\Database::NAME,
];
- private $backends;
+ /** @var string[] List of valid backend classes */
+ private $validBackends;
/**
* @var Storage\IStorage[] A local cache for storage instances
*/
public function __construct(Database $dba, IConfig $config, LoggerInterface $logger, L10n $l10n)
{
- $this->dba = $dba;
- $this->config = $config;
- $this->logger = $logger;
- $this->l10n = $l10n;
- $this->backends = $config->get('storage', 'backends', self::DEFAULT_BACKENDS);
+ $this->dba = $dba;
+ $this->config = $config;
+ $this->logger = $logger;
+ $this->l10n = $l10n;
+ $this->validBackends = $config->get('storage', 'backends', self::DEFAULT_BACKENDS);
$currentName = $this->config->get('storage', 'name');
*/
public function getWritableStorageByName(string $name): Storage\IWritableStorage
{
- $storage = $this->getByName($name, $this->backends);
- if ($storage instanceof Storage\IWritableStorage) {
- return $storage;
- } else {
+ $storage = $this->getByName($name, $this->validBackends);
+ if (!$storage instanceof Storage\IWritableStorage) {
throw new Storage\InvalidClassStorageException(sprintf('Backend %s is not writable', $name));
}
+
+ return $storage;
}
/**
* Return storage backend class by registered name
*
* @param string $name Backend name
- * @param array|null $validBackends possible, manual override of the valid backends
+ * @param string[]|null $validBackends possible, manual override of the valid backends
*
* @return Storage\IStorage
*
// If there's no cached instance create a new instance
if (!isset($this->backendInstances[$name])) {
// If the current name isn't a valid backend (or the SystemResource instance) create it
- if ($this->isValidBackend($name, $validBackends)) {
- switch ($name) {
- // Try the filesystem backend
- case Storage\Filesystem::getName():
- $this->backendInstances[$name] = new Storage\Filesystem($this->config, $this->l10n);
- break;
- // try the database backend
- case Storage\Database::getName():
- $this->backendInstances[$name] = new Storage\Database($this->dba);
- break;
- // at least, try if there's an addon for the backend
- case Storage\SystemResource::getName():
- $this->backendInstances[$name] = new Storage\SystemResource();
- break;
- case Storage\ExternalResource::getName():
- $this->backendInstances[$name] = new Storage\ExternalResource();
- break;
- default:
- $data = [
- 'name' => $name,
- 'storage' => null,
- ];
- try {
- Hook::callAll('storage_instance', $data);
- if (($data['storage'] ?? null) instanceof Storage\IStorage) {
- $this->backendInstances[$data['name'] ?? $name] = $data['storage'];
- } else {
- throw new Storage\InvalidClassStorageException(sprintf('Backend %s was not found', $name));
- }
- } catch (InternalServerErrorException $exception) {
- throw new Storage\StorageException(sprintf('Failed calling hook::storage_instance for backend %s', $name), $exception);
- }
- break;
- }
- } else {
+ if (!$this->isValidBackend($name, $validBackends)) {
throw new Storage\InvalidClassStorageException(sprintf('Backend %s is not valid', $name));
}
+
+ switch ($name) {
+ // Try the filesystem backend
+ case Storage\Filesystem::getName():
+ $this->backendInstances[$name] = new Storage\Filesystem($this->config, $this->l10n);
+ break;
+ // try the database backend
+ case Storage\Database::getName():
+ $this->backendInstances[$name] = new Storage\Database($this->dba);
+ break;
+ // at least, try if there's an addon for the backend
+ case Storage\SystemResource::getName():
+ $this->backendInstances[$name] = new Storage\SystemResource();
+ break;
+ case Storage\ExternalResource::getName():
+ $this->backendInstances[$name] = new Storage\ExternalResource();
+ break;
+ default:
+ $data = [
+ 'name' => $name,
+ 'storage' => null,
+ ];
+ try {
+ Hook::callAll('storage_instance', $data);
+ if (!($data['storage'] ?? null) instanceof Storage\IStorage) {
+ throw new Storage\InvalidClassStorageException(sprintf('Backend %s was not found', $name));
+ }
+
+ $this->backendInstances[$data['name'] ?? $name] = $data['storage'];
+ } catch (InternalServerErrorException $exception) {
+ throw new Storage\StorageException(sprintf('Failed calling hook::storage_instance for backend %s', $name), $exception);
+ }
+ break;
+ }
}
return $this->backendInstances[$name];
/**
* Checks, if the storage is a valid backend
*
- * @param string|null $name The name or class of the backend
- * @param array|null $validBackends Possible, valid backends to check
+ * @param string|null $name The name or class of the backend
+ * @param string[]|null $validBackends Possible, valid backends to check
*
* @return boolean True, if the backend is a valid backend
*/
public function isValidBackend(string $name = null, array $validBackends = null): bool
{
- $validBackends = $validBackends ?? array_merge($this->backends,
+ $validBackends = $validBackends ?? array_merge($this->validBackends,
[
- Storage\SystemResource::getName() => '',
- Storage\ExternalResource::getName() => ''
+ Storage\SystemResource::getName(),
+ Storage\ExternalResource::getName(),
]);
- return array_key_exists($name, $validBackends);
+ return in_array($name, $validBackends);
}
/**
/**
* Get registered backends
*
- * @return array
+ * @return string[]
*/
public function listBackends(): array
{
- return $this->backends;
+ return $this->validBackends;
}
/**
if (is_subclass_of($class, Storage\IStorage::class)) {
/** @var Storage\IStorage $class */
- $backends = $this->backends;
- $backends[$class::getName()] = $class;
+ if ($this->isValidBackend($class::getName(), $this->validBackends)) {
+ return true;
+ }
+
+ $backends = $this->validBackends;
+ $backends[] = $class::getName();
if ($this->config->set('storage', 'backends', $backends)) {
- $this->backends = $backends;
+ $this->validBackends = $backends;
return true;
} else {
return false;
* @param string $class Backend class name
*
* @return boolean True, if unregistering was successful
+ *
+ * @throws Storage\StorageException
*/
public function unregister(string $class): bool
{
if (is_subclass_of($class, Storage\IStorage::class)) {
/** @var Storage\IStorage $class */
- unset($this->backends[$class::getName()]);
-
- if ($this->currentBackend instanceof $class) {
- $this->config->set('storage', 'name', null);
- $this->currentBackend = null;
+ if ($this->currentBackend::getName() == $class::getName()) {
+ throw new Storage\StorageException(sprintf('Cannot unregister %s, because it\'s currently active.', $class::getName()));
}
- return $this->config->set('storage', 'backends', $this->backends);
+ $key = array_search($class::getName(), $this->validBackends);
+
+ if ($key !== false) {
+ $backends = $this->validBackends;
+ unset($backends[$key]);
+ $backends = array_values($backends);
+ if ($this->config->set('storage', 'backends', $backends)) {
+ $this->validBackends = $backends;
+ return true;
+ } else {
+ return false;
+ }
+ } else {
+ return true;
+ }
} else {
return false;
}
*/
public function move(Storage\IWritableStorage $destination, array $tables = self::TABLES, int $limit = 5000): int
{
- if (!$this->isValidBackend($destination, $this->backends)) {
+ if (!$this->isValidBackend($destination, $this->validBackends)) {
throw new Storage\StorageException(sprintf("Can't move to storage backend '%s'", $destination::getName()));
}
projects / friendica.git / blobdiff