2018-11-29 08:27:04 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace Friendica\Core;
|
|
|
|
|
2020-01-05 00:58:49 +00:00
|
|
|
use Dice\Dice;
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief 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
|
|
|
|
{
|
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 = [];
|
|
|
|
|
|
|
|
/** @var Database */
|
|
|
|
private $dba;
|
|
|
|
/** @var IConfiguration */
|
|
|
|
private $config;
|
|
|
|
/** @var LoggerInterface */
|
|
|
|
private $logger;
|
|
|
|
/** @var Dice */
|
|
|
|
private $dice;
|
|
|
|
|
|
|
|
/** @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-06 16:42:28 +00:00
|
|
|
* @param Dice $dice
|
2020-01-05 00:58:49 +00:00
|
|
|
*/
|
|
|
|
public function __construct(Database $dba, IConfiguration $config, LoggerInterface $logger, Dice $dice)
|
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;
|
|
|
|
$this->dice = $dice;
|
|
|
|
$this->backends = $config->get('storage', 'backends', self::DEFAULT_BACKENDS);
|
|
|
|
|
|
|
|
$currentName = $this->config->get('storage', 'name', '');
|
|
|
|
|
|
|
|
if ($this->isValidBackend($currentName)) {
|
|
|
|
$this->currentBackend = $this->dice->create($this->backends[$currentName]);
|
|
|
|
} else {
|
|
|
|
$this->currentBackend = null;
|
2018-11-29 08:27:04 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-04-10 06:35:44 +00:00
|
|
|
* @brief Return current storage backend class
|
|
|
|
*
|
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
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Return storage backend class by registered name
|
|
|
|
*
|
2020-01-06 16:42:28 +00:00
|
|
|
* @param string|null $name Backend name
|
2020-01-05 00:58:49 +00:00
|
|
|
*
|
|
|
|
* @return Storage\IStorage|null null if no backend registered at $name
|
|
|
|
*/
|
2020-01-06 16:42:28 +00:00
|
|
|
public function getByName(string $name = null)
|
2020-01-05 00:58:49 +00:00
|
|
|
{
|
2020-01-06 16:42:28 +00:00
|
|
|
if (!$this->isValidBackend($name) &&
|
|
|
|
$name !== Storage\SystemResource::getName()) {
|
2020-01-05 00:58:49 +00:00
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
2020-01-06 16:42:28 +00:00
|
|
|
/** @var Storage\IStorage $storage */
|
|
|
|
$storage = null;
|
|
|
|
|
|
|
|
// 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;
|
2020-01-05 00:58:49 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Checks, if the storage is a valid backend
|
|
|
|
*
|
2020-01-06 16:42:28 +00:00
|
|
|
* @param string|null $name The name or class of the backend
|
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-06 16:42:28 +00:00
|
|
|
public function isValidBackend(string $name = null)
|
2018-11-29 08:27:04 +00:00
|
|
|
{
|
2020-01-05 00:58:49 +00:00
|
|
|
return array_key_exists($name, $this->backends);
|
2018-11-29 08:27:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Set current storage backend class
|
|
|
|
*
|
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-05 00:58:49 +00:00
|
|
|
if (!$this->isValidBackend($name)) {
|
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)) {
|
|
|
|
$this->currentBackend = $this->dice->create($this->backends[$name]);
|
|
|
|
return true;
|
|
|
|
} else {
|
|
|
|
return false;
|
|
|
|
}
|
2018-11-29 08:27:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get registered backends
|
|
|
|
*
|
|
|
|
* @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
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Register a storage backend class
|
|
|
|
*
|
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 */
|
|
|
|
|
|
|
|
$backends = $this->backends;
|
|
|
|
$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
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Unregister a storage backend class
|
|
|
|
*
|
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) {
|
|
|
|
$this->config->set('storage', 'name', null);
|
|
|
|
$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
|
|
|
|
|
|
|
/**
|
2019-03-20 04:41:57 +00:00
|
|
|
* @brief 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-05 00:58:49 +00:00
|
|
|
if ($destination === null) {
|
|
|
|
throw new Storage\StorageException('Can\'t move to NULL storage backend');
|
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
|
|
|
}
|