friendica/src/Core/StorageManager.php

330 lines
9.5 KiB
PHP
Raw Normal View History

2018-11-29 08:27:04 +00:00
<?php
2020-02-09 14:45:36 +00:00
/**
2021-03-29 06:40:20 +00:00
* @copyright Copyright (C) 2010-2021, the Friendica project
2020-02-09 14:45:36 +00:00
*
* @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/>.
*
*/
2018-11-29 08:27:04 +00:00
namespace Friendica\Core;
use Exception;
use Friendica\Core\Config\IConfig;
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
{
// 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
];
private $backends = [];
/**
* @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 Storage\IStorage */
private $currentBackend;
2018-11-29 08:27:04 +00:00
/**
* @param Database $dba
* @param IConfig $config
* @param LoggerInterface $logger
* @param L10n $l10n
*/
public function __construct(Database $dba, IConfig $config, LoggerInterface $logger, L10n $l10n)
2018-11-29 08:27:04 +00:00
{
$this->dba = $dba;
$this->config = $config;
$this->logger = $logger;
$this->l10n = $l10n;
$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
*
* @return Storage\IStorage|null
2018-11-29 08:27:04 +00:00
*/
public function getBackend()
2018-11-29 08:27:04 +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)
*
* @return Storage\IStorage|null null if no backend registered at $name
*
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
2020-01-17 19:23:30 +00:00
public function getByName(string $name = null, $onlyUserBackend = false)
{
// @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
2020-01-17 19:23:30 +00:00
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():
2020-01-17 19:23:30 +00:00
$this->backendInstances[$name] = new Storage\SystemResource();
break;
default:
$data = [
2020-01-17 19:23:30 +00:00
'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];
}
/**
* 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)
*
* @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
{
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
}
/**
* 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
*
* @param string $name Backend class name
*
* @return boolean True, if the set was successful
2018-11-29 08:27:04 +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)) {
return false;
}
if ($this->config->set('storage', 'name', $name)) {
2020-01-17 18:31:34 +00:00
$this->currentBackend = $this->getByName($name, false);
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
*/
public function listBackends()
2018-11-29 08:27:04 +00:00
{
return $this->backends;
2018-11-29 08:27:04 +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
*
* @return boolean True, if the registration was successful
2018-11-29 08:27:04 +00:00
*/
public function register(string $class)
2018-11-29 08:27:04 +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;
$backends[$class::getName()] = $class;
if ($this->config->set('storage', 'backends', $backends)) {
$this->backends = $backends;
return true;
} else {
return false;
}
} 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
*
* @param string $class Backend class name
*
* @return boolean True, if unregistering was successful
2018-11-29 08:27:04 +00:00
*/
public function unregister(string $class)
2018-11-29 08:27:04 +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);
$this->currentBackend = null;
}
return $this->config->set('storage', 'backends', $this->backends);
} else {
return false;
}
2018-11-29 08:27:04 +00:00
}
/**
2020-01-19 06:05:23 +00:00
* Move up to 5000 resources to storage $dest
*
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.
*
* @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
* @throws Storage\StorageException
* @throws Exception
*/
public function move(Storage\IStorage $destination, array $tables = self::TABLES, int $limit = 5000)
{
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) {
2018-12-12 16:50:34 +00:00
// Get the rows where backend class is not the destination backend class
$resources = $this->dba->select(
$table,
2018-12-12 16:50:34 +00:00
['id', 'data', 'backend-class', 'backend-ref'],
['`backend-class` IS NULL or `backend-class` != ?', $destination::getName()],
['limit' => $limit]
2018-12-12 16:50:34 +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);
}
$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;
}
2018-12-12 16:50:34 +00:00
}