<?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 Friendica\Database\DBA;
-use Friendica\Core\Config;
-
+use Exception;
+use Friendica\Core\Config\IConfig;
+use Friendica\Database\Database;
+use Friendica\Model\Storage;
+use Friendica\Network\IHTTPRequest;
+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.
*/
class StorageManager
{
- private static $default_backends = [
- 'Filesystem' => Friendica\Model\Storage\Filesystem::class,
- 'Database' => Friendica\Model\Storage\Database::class,
+ // Default tables to look for data
+ const TABLES = ['photo', 'attach'];
+
+ // Default storage backends
+ const DEFAULT_BACKENDS = [
+ Storage\Filesystem::NAME => Storage\Filesystem::class,
+ Storage\Database::NAME => Storage\Database::class,
];
- private static $backends = [];
+ private $backends = [];
- private static function setup()
+ /**
+ * @var Storage\IStorage[] A local cache for storage instances
+ */
+ private $backendInstances = [];
+
+ /** @var Database */
+ private $dba;
+ /** @var IConfig */
+ private $config;
+ /** @var LoggerInterface */
+ private $logger;
+ /** @var L10n */
+ private $l10n;
+ /** @var IHTTPRequest */
+ private $httpRequest;
+
+ /** @var Storage\IStorage */
+ private $currentBackend;
+
+ /**
+ * @param Database $dba
+ * @param IConfig $config
+ * @param LoggerInterface $logger
+ * @param L10n $l10n
+ */
+ public function __construct(Database $dba, IConfig $config, LoggerInterface $logger, L10n $l10n, IHTTPRequest $httpRequest)
{
- if (count(self::$backends)==0) {
- self::$backends = Config::get('storage', 'backends', self::$default_backends);
- }
+ $this->dba = $dba;
+ $this->config = $config;
+ $this->logger = $logger;
+ $this->l10n = $l10n;
+ $this->httpRequest = $httpRequest;
+ $this->backends = $config->get('storage', 'backends', self::DEFAULT_BACKENDS);
+
+ $currentName = $this->config->get('storage', 'name', '');
+
+ // you can only use user backends as a "default" backend, so the second parameter is true
+ $this->currentBackend = $this->getByName($currentName, true);
}
/**
- * @brief Return current storage backend class
- * @return string
+ * Return current storage backend class
+ *
+ * @return Storage\IStorage|null
*/
- public static function getBackend()
+ public function getBackend()
{
- return Config::get('storage', 'class', '');
+ return $this->currentBackend;
}
/**
- * @brief Return storage backend class by registered name
+ * Return storage backend class by registered name
+ *
+ * @param string|null $name Backend name
+ * @param boolean $onlyUserBackend True, if just user specific instances should be returrned (e.g. not SystemResource)
*
- * @param string $name Backend name
- * @return string Empty if no backend registered at $name exists
+ * @return Storage\IStorage|null null if no backend registered at $name
+ *
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function getByName($name)
+ public function getByName(string $name = null, $onlyUserBackend = false)
{
- self::setup();
- return defaults(self::$backends, $name, '');
+ // @todo 2020.09 Remove this call after 2 releases
+ $name = $this->checkLegacyBackend($name);
+
+ // 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, $onlyUserBackend)) {
+ switch ($name) {
+ // Try the filesystem backend
+ case Storage\Filesystem::getName():
+ $this->backendInstances[$name] = new Storage\Filesystem($this->config, $this->logger, $this->l10n);
+ break;
+ // try the database backend
+ case Storage\Database::getName():
+ $this->backendInstances[$name] = new Storage\Database($this->dba, $this->logger, $this->l10n);
+ 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($this->httpRequest);
+ break;
+ default:
+ $data = [
+ 'name' => $name,
+ 'storage' => null,
+ ];
+ Hook::callAll('storage_instance', $data);
+ if (($data['storage'] ?? null) instanceof Storage\IStorage) {
+ $this->backendInstances[$data['name'] ?? $name] = $data['storage'];
+ } else {
+ return null;
+ }
+ break;
+ }
+ } else {
+ return null;
+ }
+ }
+
+ return $this->backendInstances[$name];
}
/**
- * @brief Set current storage backend class
+ * Checks, if the storage is a valid backend
+ *
+ * @param string|null $name The name or class of the backend
+ * @param boolean $onlyUserBackend True, if just user backend should get returned (e.g. not SystemResource)
*
- * @param string $class Backend class name
+ * @return boolean True, if the backend is a valid backend
*/
- public static function setBackend($class)
+ public function isValidBackend(string $name = null, bool $onlyUserBackend = false)
{
- /// @todo Check that $class implements IStorage
- Config::set('storage', 'class', $class);
+ return array_key_exists($name, $this->backends) ||
+ (!$onlyUserBackend && in_array($name, [Storage\SystemResource::getName(), Storage\ExternalResource::getName()]));
}
/**
- * @brief Get registered backends
+ * Check for legacy backend storage class names (= full model class name)
*
- * @return array
+ * @todo 2020.09 Remove this function after 2 releases, because there shouldn't be any legacy backend classes left
+ *
+ * @param string|null $name a potential, legacy storage name ("Friendica\Model\Storage\...")
+ *
+ * @return string|null The current storage name
*/
- public static function listBackends()
+ private function checkLegacyBackend(string $name = null)
{
- self::setup();
- return self::$backends;
+ if (stristr($name, 'Friendica\Model\Storage\\')) {
+ $this->logger->notice('Using deprecated storage class value', ['name' => $name]);
+ return substr($name, 24);
+ }
+
+ return $name;
}
+ /**
+ * Set current storage backend class
+ *
+ * @param string $name Backend class name
+ *
+ * @return boolean True, if the set was successful
+ */
+ public function setBackend(string $name = null)
+ {
+ if (!$this->isValidBackend($name, false)) {
+ return false;
+ }
+ if ($this->config->set('storage', 'name', $name)) {
+ $this->currentBackend = $this->getByName($name, false);
+ return true;
+ } else {
+ return false;
+ }
+ }
/**
- * @brief Register a storage backend class
+ * Get registered backends
*
- * @param string $name User readable backend name
- * @param string $class Backend class name
+ * @return array
*/
- public static function register($name, $class)
+ public function listBackends()
{
- /// @todo Check that $class implements IStorage
- self::setup();
- self::$backends[$name] = $class;
- Config::set('storage', 'backends', self::$backends);
+ return $this->backends;
}
-
/**
- * @brief Unregister a storage backend class
+ * Register a storage backend class
*
- * @param string $name User readable backend name
+ * 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 static function unregister($class)
+ public function register(string $class)
{
- self::setup();
- unset(self::$backends[$name]);
- Config::set('storage', 'backends', self::$backends);
+ if (is_subclass_of($class, Storage\IStorage::class)) {
+ /** @var Storage\IStorage $class */
+
+ $backends = $this->backends;
+ $backends[$class::getName()] = $class;
+
+ if ($this->config->set('storage', 'backends', $backends)) {
+ $this->backends = $backends;
+ return true;
+ } else {
+ return false;
+ }
+ } else {
+ return false;
+ }
}
+ /**
+ * Unregister a storage backend class
+ *
+ * @param string $class Backend class name
+ *
+ * @return boolean True, if unregistering was successful
+ */
+ public function unregister(string $class)
+ {
+ 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;
+ }
+
+ return $this->config->set('storage', 'backends', $this->backends);
+ } else {
+ return false;
+ }
+ }
/**
- * @brief Move resources to storage $dest
+ * Move up to 5000 resources to storage $dest
*
- * @param string $dest Destination storage class name
- * @param array $tables Tables to look in for resources. Optional, defaults to ['photo']
+ * Copy existing data to destination storage and delete from source.
+ * This method cannot move to legacy in-table `data` field.
*
- * @retur int Number of moved resources
+ * @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
+ *
+ * @return int Number of moved resources
+ * @throws Storage\StorageException
+ * @throws Exception
*/
- public static function move($dest, $tables = null)
+ public function move(Storage\IStorage $destination, array $tables = self::TABLES, int $limit = 5000)
{
- if (is_null($tables)) {
- $tables = ['photo'];
+ if (!$this->isValidBackend($destination, true)) {
+ throw new Storage\StorageException(sprintf("Can't move to storage backend '%s'", $destination::getName()));
}
$moved = 0;
foreach ($tables as $table) {
- $rr = DBA::select($table, ['id', 'data', 'backend-class', 'backend-ref'], ['`backend-class` != ?', $dest]);
- if (DBA::isResult($rr)) {
- while($r = $rr->fetch()) {
- $id = $r['id'];
- $data = $r['data'];
- $backendClass = $r['backend-class'];
- $backendRef = $r['backend-ref'];
- if ($backendClass !== '') {
- $data = $backendClass::get($backendRef);
- }
- $ref = $dest::put($data);
-
- if ($ref !== "") {
- $ru = DBA::update($table, ["backend-class" => $dest, "backend-ref" => $ref, "data" => ""], ["id" => $id]);
- if ($ru) {
- if ($backendClass !== "") {
- $backendClass::delete($backendRef);
- }
- $moved++;
+ // Get the rows where backend class is not the destination backend class
+ $resources = $this->dba->select(
+ $table,
+ ['id', 'data', 'backend-class', 'backend-ref'],
+ ['`backend-class` IS NULL or `backend-class` != ?', $destination::getName()],
+ ['limit' => $limit]
+ );
+
+ while ($resource = $this->dba->fetch($resources)) {
+ $id = $resource['id'];
+ $data = $resource['data'];
+ $source = $this->getByName($resource['backend-class']);
+ $sourceRef = $resource['backend-ref'];
+
+ if (!empty($source)) {
+ $this->logger->info('Get data from old backend.', ['oldBackend' => $source, 'oldReference' => $sourceRef]);
+ $data = $source->get($sourceRef);
+ }
+
+ $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::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);
}
+ $moved++;
}
}
}
+
+ $this->dba->close($resources);
}
return $moved;
}
-}
\ No newline at end of file
+}
projects / friendica.git / blobdiff