2018-11-29 08:27:04 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace Friendica\Core;
|
|
|
|
|
2020-01-05 00:58:49 +00:00
|
|
|
use Exception;
|
|
|
|
use Friendica\Core\Config\IConfiguration;
|
|
|
|
use Friendica\Database\Database;
|
|
|
|
use Friendica\Model\Storage;
|
|
|
|
use Psr\Log\LoggerInterface;
|
2018-11-29 08:27:04 +00:00
|
|
|
|
|
|
|
|
|
|
|
/**
|
2020-01-19 06:05:23 +00:00
|
|
|
* Manage storage backends
|
2018-11-29 08:27:04 +00:00
|
|
|
*
|
|
|
|
* 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
|
|
|
|
{
|
2020-01-05 00:58:49 +00:00
|
|
|
// 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,
|
2018-11-29 08:27:04 +00:00
|
|
|
];
|
|
|
|
|
2020-01-05 00:58:49 +00:00
|
|
|
private $backends = [];
|
|
|
|
|
2020-01-08 21:51:37 +00:00
|
|
|
/**
|
|
|
|
* @var Storage\IStorage[] A local cache for storage instances
|
|
|
|
*/
|
|
|
|
private $backendInstances = [];
|
|
|
|
|
2020-01-05 00:58:49 +00:00
|
|
|
/** @var Database */
|
|
|
|
private $dba;
|
|
|
|
/** @var IConfiguration */
|
|
|
|
private $config;
|
|
|
|
/** @var LoggerInterface */
|
|
|
|
private $logger;
|
2020-01-08 21:51:37 +00:00
|
|
|
/** @var L10n */
|
|
|
|
private $l10n;
|
2020-01-05 00:58:49 +00:00
|
|
|
|
|
|
|
/** @var Storage\IStorage */
|
|
|
|
private $currentBackend;
|
2018-11-29 08:27:04 +00:00
|
|
|
|
2020-01-05 00:58:49 +00:00
|
|
|
/**
|
|
|
|
* @param Database $dba
|
|
|
|
* @param IConfiguration $config
|
|
|
|
* @param LoggerInterface $logger
|
2020-01-08 21:51:37 +00:00
|
|
|
* @param L10n $l10n
|
2020-01-05 00:58:49 +00:00
|
|
|
*/
|
2020-01-08 21:51:37 +00:00
|
|
|
public function __construct(Database $dba, IConfiguration $config, LoggerInterface $logger, L10n $l10n)
|
2018-11-29 08:27:04 +00:00
|
|
|
{
|
2020-01-05 00:58:49 +00:00
|
|
|
$this->dba = $dba;
|
|
|
|
$this->config = $config;
|
|
|
|
$this->logger = $logger;
|
2020-01-08 21:51:37 +00:00
|
|
|
$this->l10n = $l10n;
|
2020-01-05 00:58:49 +00:00
|
|
|
$this->backends = $config->get('storage', 'backends', self::DEFAULT_BACKENDS);
|
|
|
|
|
|
|
|
$currentName = $this->config->get('storage', 'name', '');
|
|
|
|
|
2020-01-17 18:31:34 +00:00
|
|
|
// you can only use user backends as a "default" backend, so the second parameter is true
|
|
|
|
$this->currentBackend = $this->getByName($currentName, true);
|
2018-11-29 08:27:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-01-19 06:05:23 +00:00
|
|
|
* Return current storage backend class
|
2019-04-10 06:35:44 +00:00
|
|
|
*
|
2020-01-05 00:58:49 +00:00
|
|
|
* @return Storage\IStorage|null
|
2018-11-29 08:27:04 +00:00
|
|
|
*/
|
2020-01-05 00:58:49 +00:00
|
|
|
public function getBackend()
|
2018-11-29 08:27:04 +00:00
|
|
|
{
|
2020-01-05 00:58:49 +00:00
|
|
|
return $this->currentBackend;
|
2018-11-29 08:27:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-01-19 06:05:23 +00:00
|
|
|
* Return storage backend class by registered name
|
2018-11-29 08:27:04 +00:00
|
|
|
*
|
2020-01-17 19:23:30 +00:00
|
|
|
* @param string|null $name Backend name
|
|
|
|
* @param boolean $onlyUserBackend True, if just user specific instances should be returrned (e.g. not SystemResource)
|
2020-01-05 00:58:49 +00:00
|
|
|
*
|
|
|
|
* @return Storage\IStorage|null null if no backend registered at $name
|
2020-01-08 21:51:37 +00:00
|
|
|
*
|
|
|
|
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
2020-01-05 00:58:49 +00:00
|
|
|
*/
|
2020-01-17 19:23:30 +00:00
|
|
|
public function getByName(string $name = null, $onlyUserBackend = false)
|
2020-01-05 00:58:49 +00:00
|
|
|
{
|
2020-01-17 22:25:11 +00:00
|
|
|
// @todo 2020.09 Remove this call after 2 releases
|
|
|
|
$name = $this->checkLegacyBackend($name);
|
|
|
|
|
2020-01-08 21:51:37 +00:00
|
|
|
// 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
|
2020-01-17 19:23:30 +00:00
|
|
|
if ($this->isValidBackend($name, $onlyUserBackend)) {
|
2020-01-08 21:51:37 +00:00
|
|
|
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():
|
2020-01-17 19:23:30 +00:00
|
|
|
$this->backendInstances[$name] = new Storage\SystemResource();
|
2020-01-08 21:51:37 +00:00
|
|
|
break;
|
|
|
|
default:
|
|
|
|
$data = [
|
2020-01-17 19:23:30 +00:00
|
|
|
'name' => $name,
|
2020-01-08 21:51:37 +00:00
|
|
|
'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;
|
|
|
|
}
|
2020-01-05 00:58:49 +00:00
|
|
|
}
|
|
|
|
|
2020-01-08 21:51:37 +00:00
|
|
|
return $this->backendInstances[$name];
|
2020-01-05 00:58:49 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Checks, if the storage is a valid backend
|
|
|
|
*
|
2020-01-17 19:23:30 +00:00
|
|
|
* @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)
|
2020-01-05 00:58:49 +00:00
|
|
|
*
|
|
|
|
* @return boolean True, if the backend is a valid backend
|
2018-11-29 08:27:04 +00:00
|
|
|
*/
|
2020-01-17 19:23:30 +00:00
|
|
|
public function isValidBackend(string $name = null, bool $onlyUserBackend = false)
|
2018-11-29 08:27:04 +00:00
|
|
|
{
|
2020-01-08 21:51:37 +00:00
|
|
|
return array_key_exists($name, $this->backends) ||
|
2020-01-17 19:23:30 +00:00
|
|
|
(!$onlyUserBackend && $name === Storage\SystemResource::getName());
|
2018-11-29 08:27:04 +00:00
|
|
|
}
|
|
|
|
|
2020-01-17 22:25:11 +00:00
|
|
|
/**
|
|
|
|
* Check for legacy backend storage class names (= full model class name)
|
|
|
|
*
|
|
|
|
* @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
|
|
|
|
*/
|
|
|
|
private function checkLegacyBackend(string $name = null)
|
|
|
|
{
|
|
|
|
if (stristr($name, 'Friendica\Model\Storage\\')) {
|
|
|
|
$this->logger->notice('Using deprecated storage class value', ['name' => $name]);
|
|
|
|
return substr($name, 24);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $name;
|
|
|
|
}
|
|
|
|
|
2018-11-29 08:27:04 +00:00
|
|
|
/**
|
2020-01-19 06:05:23 +00:00
|
|
|
* Set current storage backend class
|
2018-11-29 08:27:04 +00:00
|
|
|
*
|
2020-01-05 00:58:49 +00:00
|
|
|
* @param string $name Backend class name
|
|
|
|
*
|
|
|
|
* @return boolean True, if the set was successful
|
2018-11-29 08:27:04 +00:00
|
|
|
*/
|
2020-01-06 16:42:28 +00:00
|
|
|
public function setBackend(string $name = null)
|
2018-11-29 08:27:04 +00:00
|
|
|
{
|
2020-01-17 18:31:34 +00:00
|
|
|
if (!$this->isValidBackend($name, false)) {
|
2019-03-17 23:12:20 +00:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2020-01-05 00:58:49 +00:00
|
|
|
if ($this->config->set('storage', 'name', $name)) {
|
2020-01-17 18:31:34 +00:00
|
|
|
$this->currentBackend = $this->getByName($name, false);
|
2020-01-05 00:58:49 +00:00
|
|
|
return true;
|
|
|
|
} else {
|
|
|
|
return false;
|
|
|
|
}
|
2018-11-29 08:27:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-01-19 06:05:23 +00:00
|
|
|
* Get registered backends
|
2018-11-29 08:27:04 +00:00
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
2020-01-05 00:58:49 +00:00
|
|
|
public function listBackends()
|
2018-11-29 08:27:04 +00:00
|
|
|
{
|
2020-01-05 00:58:49 +00:00
|
|
|
return $this->backends;
|
2018-11-29 08:27:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-01-08 21:51:37 +00:00
|
|
|
* Register a storage backend class
|
|
|
|
*
|
|
|
|
* You have to register the hook "storage_instance" as well to make this class work!
|
2018-11-29 08:27:04 +00:00
|
|
|
*
|
2019-01-06 21:06:53 +00:00
|
|
|
* @param string $class Backend class name
|
2020-01-05 00:58:49 +00:00
|
|
|
*
|
|
|
|
* @return boolean True, if the registration was successful
|
2018-11-29 08:27:04 +00:00
|
|
|
*/
|
2020-01-06 16:42:28 +00:00
|
|
|
public function register(string $class)
|
2018-11-29 08:27:04 +00:00
|
|
|
{
|
2020-01-06 16:42:28 +00:00
|
|
|
if (is_subclass_of($class, Storage\IStorage::class)) {
|
|
|
|
/** @var Storage\IStorage $class */
|
|
|
|
|
2020-01-17 19:23:30 +00:00
|
|
|
$backends = $this->backends;
|
2020-01-06 16:42:28 +00:00
|
|
|
$backends[$class::getName()] = $class;
|
|
|
|
|
|
|
|
if ($this->config->set('storage', 'backends', $backends)) {
|
|
|
|
$this->backends = $backends;
|
|
|
|
return true;
|
|
|
|
} else {
|
|
|
|
return false;
|
|
|
|
}
|
2020-01-05 00:58:49 +00:00
|
|
|
} else {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
2018-11-29 08:27:04 +00:00
|
|
|
|
|
|
|
/**
|
2020-01-19 06:05:23 +00:00
|
|
|
* Unregister a storage backend class
|
2018-11-29 08:27:04 +00:00
|
|
|
*
|
2020-01-06 16:42:28 +00:00
|
|
|
* @param string $class Backend class name
|
2020-01-05 00:58:49 +00:00
|
|
|
*
|
|
|
|
* @return boolean True, if unregistering was successful
|
2018-11-29 08:27:04 +00:00
|
|
|
*/
|
2020-01-06 16:42:28 +00:00
|
|
|
public function unregister(string $class)
|
2018-11-29 08:27:04 +00:00
|
|
|
{
|
2020-01-06 16:42:28 +00:00
|
|
|
if (is_subclass_of($class, Storage\IStorage::class)) {
|
|
|
|
/** @var Storage\IStorage $class */
|
|
|
|
|
|
|
|
unset($this->backends[$class::getName()]);
|
|
|
|
|
|
|
|
if ($this->currentBackend instanceof $class) {
|
2020-01-17 19:23:30 +00:00
|
|
|
$this->config->set('storage', 'name', null);
|
2020-01-06 16:42:28 +00:00
|
|
|
$this->currentBackend = null;
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this->config->set('storage', 'backends', $this->backends);
|
|
|
|
} else {
|
|
|
|
return false;
|
|
|
|
}
|
2018-11-29 08:27:04 +00:00
|
|
|
}
|
2018-12-01 16:44:54 +00:00
|
|
|
|
|
|
|
/**
|
2020-01-19 06:05:23 +00:00
|
|
|
* Move up to 5000 resources to storage $dest
|
2018-12-01 16:44:54 +00:00
|
|
|
*
|
2018-12-12 16:50:34 +00:00
|
|
|
* Copy existing data to destination storage and delete from source.
|
|
|
|
* This method cannot move to legacy in-table `data` field.
|
|
|
|
*
|
2020-01-05 00:58:49 +00:00
|
|
|
* @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
|
|
|
|
*
|
2019-01-06 21:06:53 +00:00
|
|
|
* @return int Number of moved resources
|
2020-01-05 00:58:49 +00:00
|
|
|
* @throws Storage\StorageException
|
|
|
|
* @throws Exception
|
2018-12-01 16:44:54 +00:00
|
|
|
*/
|
2020-01-05 00:58:49 +00:00
|
|
|
public function move(Storage\IStorage $destination, array $tables = self::TABLES, int $limit = 5000)
|
2018-12-01 16:44:54 +00:00
|
|
|
{
|
2020-01-17 20:01:37 +00:00
|
|
|
if (!$this->isValidBackend($destination, true)) {
|
|
|
|
throw new Storage\StorageException(sprintf("Can't move to storage backend '%s'", $destination::getName()));
|
2018-12-01 16:44:54 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
$moved = 0;
|
|
|
|
foreach ($tables as $table) {
|
2018-12-12 16:50:34 +00:00
|
|
|
// Get the rows where backend class is not the destination backend class
|
2020-01-05 00:58:49 +00:00
|
|
|
$resources = $this->dba->select(
|
|
|
|
$table,
|
2018-12-12 16:50:34 +00:00
|
|
|
['id', 'data', 'backend-class', 'backend-ref'],
|
2020-01-06 16:42:28 +00:00
|
|
|
['`backend-class` IS NULL or `backend-class` != ?', $destination::getName()],
|
2019-03-20 04:41:57 +00:00
|
|
|
['limit' => $limit]
|
2018-12-12 16:50:34 +00:00
|
|
|
);
|
|
|
|
|
2020-01-05 00:58:49 +00:00
|
|
|
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);
|
2019-03-20 04:41:57 +00:00
|
|
|
}
|
|
|
|
|
2020-01-05 00:58:49 +00:00
|
|
|
$this->logger->info('Save data to new backend.', ['newBackend' => $destination]);
|
|
|
|
$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 (!empty($source)) {
|
|
|
|
$this->logger->info('Delete data from old backend.', ['oldBackend' => $source, 'oldReference' => $sourceRef]);
|
|
|
|
$source->delete($sourceRef);
|
2018-12-01 16:44:54 +00:00
|
|
|
}
|
2019-03-20 04:41:57 +00:00
|
|
|
$moved++;
|
2018-12-01 16:44:54 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2019-03-20 04:41:57 +00:00
|
|
|
|
2020-01-05 00:58:49 +00:00
|
|
|
$this->dba->close($resources);
|
2018-12-01 16:44:54 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return $moved;
|
|
|
|
}
|
2018-12-12 16:50:34 +00:00
|
|
|
}
|