<?php
+/**
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
namespace Friendica\Core;
-use Dice\Dice;
use Exception;
-use Friendica\Core\Config\IConfiguration;
+use Friendica\Core\Config\IConfig;
use Friendica\Database\Database;
use Friendica\Model\Storage;
+use Friendica\Network\HTTPException\InternalServerErrorException;
use Psr\Log\LoggerInterface;
-
/**
- * @brief Manage storage backends
+ * Manage storage backends
*
* Core code uses this class to get and set current storage backend class.
* Addons use this class to register and unregister additional backends.
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
+ */
+ private $backendInstances = [];
/** @var Database */
private $dba;
- /** @var IConfiguration */
+ /** @var IConfig */
private $config;
/** @var LoggerInterface */
private $logger;
- /** @var Dice */
- private $dice;
+ /** @var L10n */
+ private $l10n;
- /** @var Storage\IStorage */
+ /** @var Storage\IWritableStorage */
private $currentBackend;
/**
* @param Database $dba
- * @param IConfiguration $config
+ * @param IConfig $config
* @param LoggerInterface $logger
- * @param Dice $dice
+ * @param L10n $l10n
+ *
+ * @throws Storage\InvalidClassStorageException in case the active backend class is invalid
+ * @throws Storage\StorageException in case of unexpected errors during the active backend class loading
*/
- public function __construct(Database $dba, IConfiguration $config, LoggerInterface $logger, Dice $dice)
+ public function __construct(Database $dba, IConfig $config, LoggerInterface $logger, L10n $l10n)
{
- $this->dba = $dba;
- $this->config = $config;
- $this->logger = $logger;
- $this->dice = $dice;
- $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', '');
+ $currentName = $this->config->get('storage', 'name');
- if ($this->isValidBackend($currentName)) {
- $this->currentBackend = $this->dice->create($this->backends[$currentName]);
- } else {
- $this->currentBackend = null;
- }
+ // you can only use user backends as a "default" backend, so the second parameter is true
+ $this->currentBackend = $this->getWritableStorageByName($currentName);
}
/**
- * @brief Return current storage backend class
+ * Return current storage backend class
*
- * @return Storage\IStorage|null
+ * @return Storage\IWritableStorage
*/
public function getBackend()
{
}
/**
- * @brief Return storage backend class by registered name
+ * Returns a writable storage backend class by registered name
+ *
+ * @param string $name Backend name
*
- * @param string|null $name Backend name
+ * @return Storage\IWritableStorage
*
- * @return Storage\IStorage|null null if no backend registered at $name
+ * @throws Storage\InvalidClassStorageException in case there's no backend class for the name
+ * @throws Storage\StorageException in case of an unexpected failure during the hook call
*/
- public function getByName(string $name = null)
+ public function getWritableStorageByName(string $name): Storage\IWritableStorage
{
- if (!$this->isValidBackend($name) &&
- $name !== Storage\SystemResource::getName()) {
- return null;
+ $storage = $this->getByName($name, $this->validBackends);
+ if (!$storage instanceof Storage\IWritableStorage) {
+ throw new Storage\InvalidClassStorageException(sprintf('Backend %s is not writable', $name));
}
- /** @var Storage\IStorage $storage */
- $storage = null;
+ return $storage;
+ }
- // If the storage of the file is a system resource,
- // create it directly since it isn't listed in the registered backends
- if ($name === Storage\SystemResource::getName()) {
- $storage = $this->dice->create(Storage\SystemResource::class);
- } else {
- $storage = $this->dice->create($this->backends[$name]);
+ /**
+ * Return storage backend class by registered name
+ *
+ * @param string $name Backend name
+ * @param string[]|null $validBackends possible, manual override of the valid backends
+ *
+ * @return Storage\IStorage
+ *
+ * @throws Storage\InvalidClassStorageException in case there's no backend class for the name
+ * @throws Storage\StorageException in case of an unexpected failure during the hook call
+ */
+ public function getByName(string $name, array $validBackends = null): 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)) {
+ 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 $storage;
+ return $this->backendInstances[$name];
}
/**
* Checks, if the storage is a valid backend
*
- * @param string|null $name The name or class of the backend
+ * @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)
+ public function isValidBackend(string $name = null, array $validBackends = null): bool
{
- return array_key_exists($name, $this->backends);
+ $validBackends = $validBackends ?? array_merge($this->validBackends,
+ [
+ Storage\SystemResource::getName(),
+ Storage\ExternalResource::getName(),
+ ]);
+ return in_array($name, $validBackends);
}
/**
- * @brief Set current storage backend class
+ * Set current storage backend class
*
- * @param string $name Backend class name
+ * @param Storage\IWritableStorage $storage The storage class
*
* @return boolean True, if the set was successful
*/
- public function setBackend(string $name = null)
+ public function setBackend(Storage\IWritableStorage $storage): bool
{
- if (!$this->isValidBackend($name)) {
- return false;
- }
-
- if ($this->config->set('storage', 'name', $name)) {
- $this->currentBackend = $this->dice->create($this->backends[$name]);
+ if ($this->config->set('storage', 'name', $storage::getName())) {
+ $this->currentBackend = $storage;
return true;
} else {
return false;
}
/**
- * @brief Get registered backends
+ * Get registered backends
*
- * @return array
+ * @return string[]
*/
- public function listBackends()
+ public function listBackends(): array
{
- return $this->backends;
+ return $this->validBackends;
}
/**
- * @brief Register a storage backend class
+ * Register a storage backend class
+ *
+ * You have to register the hook "storage_instance" as well to make this class work!
*
* @param string $class Backend class name
*
* @return boolean True, if the registration was successful
*/
- public function register(string $class)
+ public function register(string $class): bool
{
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;
}
/**
- * @brief Unregister a storage backend class
+ * Unregister a storage backend class
*
* @param string $class Backend class name
*
* @return boolean True, if unregistering was successful
+ *
+ * @throws Storage\StorageException
*/
- public function unregister(string $class)
+ 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;
}
}
/**
- * @brief Move up to 5000 resources to storage $dest
+ * Move up to 5000 resources to storage $dest
*
* Copy existing data to destination storage and delete from source.
* This method cannot move to legacy in-table `data` field.
*
- * @param Storage\IStorage $destination Destination storage class name
- * @param array $tables Tables to look in for resources. Optional, defaults to ['photo', 'attach']
- * @param int $limit Limit of the process batch size, defaults to 5000
+ * @param Storage\IWritableStorage $destination Destination storage class name
+ * @param array $tables Tables to look in for resources. Optional, defaults to ['photo', 'attach']
+ * @param int $limit Limit of the process batch size, defaults to 5000
*
* @return int Number of moved resources
* @throws Storage\StorageException
* @throws Exception
*/
- public function move(Storage\IStorage $destination, array $tables = self::TABLES, int $limit = 5000)
+ public function move(Storage\IWritableStorage $destination, array $tables = self::TABLES, int $limit = 5000): int
{
- if ($destination === null) {
- throw new Storage\StorageException('Can\'t move to NULL storage backend');
+ if (!$this->isValidBackend($destination, $this->validBackends)) {
+ throw new Storage\StorageException(sprintf("Can't move to storage backend '%s'", $destination::getName()));
}
$moved = 0;
while ($resource = $this->dba->fetch($resources)) {
$id = $resource['id'];
- $data = $resource['data'];
- $source = $this->getByName($resource['backend-class']);
$sourceRef = $resource['backend-ref'];
+ $source = null;
- if (!empty($source)) {
+ try {
+ $source = $this->getWritableStorageByName($resource['backend-class'] ?? '');
$this->logger->info('Get data from old backend.', ['oldBackend' => $source, 'oldReference' => $sourceRef]);
$data = $source->get($sourceRef);
+ } catch (Storage\InvalidClassStorageException $exception) {
+ $this->logger->info('Get data from DB resource field.', ['oldReference' => $sourceRef]);
+ $data = $resource['data'];
+ } catch (Storage\ReferenceStorageException $exception) {
+ $this->logger->info('Invalid source reference.', ['oldBackend' => $source, 'oldReference' => $sourceRef]);
+ continue;
}
- $this->logger->info('Save data to new backend.', ['newBackend' => $destination]);
+ $this->logger->info('Save data to new backend.', ['newBackend' => $destination::getName()]);
$destinationRef = $destination->put($data);
$this->logger->info('Saved data.', ['newReference' => $destinationRef]);
if ($destinationRef !== '') {
$this->logger->info('update row');
- if ($this->dba->update($table, ['backend-class' => $destination, 'backend-ref' => $destinationRef, 'data' => ''], ['id' => $id])) {
+ if ($this->dba->update($table, ['backend-class' => $destination::getName(), 'backend-ref' => $destinationRef, 'data' => ''], ['id' => $id])) {
if (!empty($source)) {
$this->logger->info('Delete data from old backend.', ['oldBackend' => $source, 'oldReference' => $sourceRef]);
$source->delete($sourceRef);
projects / friendica.git / blobdiff