Merge pull request #9039 from MrPetovan/task/frio-accent-scheme

[friendica.git] / src / Core / StorageManager.php

diff --git a/src/Core/StorageManager.php b/src/Core/StorageManager.php
index d1a943a227646737f29dab82fd36186a1f637988..c8385783e9f4c1bebe3d6e0041a5eebebc4b6926 100644 (file)
--- a/src/Core/StorageManager.php
+++ b/src/Core/StorageManager.php
@@ -1,17 +1,35 @@
 <?php
+/**
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @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 Exception;
-use Friendica\Core\Config\IConfiguration;
-use Friendica\Core\L10n\L10n;
+use Friendica\Core\Config\IConfig;
 use Friendica\Database\Database;
 use Friendica\Model\Storage;
 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.
@@ -36,7 +54,7 @@ class StorageManager
 
        /** @var Database */
        private $dba;
-       /** @var IConfiguration */
+       /** @var IConfig */
        private $config;
        /** @var LoggerInterface */
        private $logger;
@@ -48,11 +66,11 @@ class StorageManager
 
        /**
         * @param Database        $dba
-        * @param IConfiguration  $config
+        * @param IConfig         $config
         * @param LoggerInterface $logger
         * @param L10n            $l10n
         */
-       public function __construct(Database $dba, IConfiguration $config, LoggerInterface $logger, L10n $l10n)
+       public function __construct(Database $dba, IConfig $config, LoggerInterface $logger, L10n $l10n)
        {
                $this->dba      = $dba;
                $this->config   = $config;
@@ -67,7 +85,7 @@ class StorageManager
        }
 
        /**
-        * @brief Return current storage backend class
+        * Return current storage backend class
         *
         * @return Storage\IStorage|null
         */
@@ -77,7 +95,7 @@ class StorageManager
        }
 
        /**
-        * @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)
@@ -88,6 +106,9 @@ class StorageManager
         */
        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
@@ -141,7 +162,26 @@ class StorageManager
        }
 
        /**
-        * @brief Set current storage backend class
+        * 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;
+       }
+
+       /**
+        * Set current storage backend class
         *
         * @param string $name Backend class name
         *
@@ -162,7 +202,7 @@ class StorageManager
        }
 
        /**
-        * @brief Get registered backends
+        * Get registered backends
         *
         * @return array
         */
@@ -200,7 +240,7 @@ class StorageManager
        }
 
        /**
-        * @brief Unregister a storage backend class
+        * Unregister a storage backend class
         *
         * @param string $class Backend class name
         *
@@ -225,7 +265,7 @@ class StorageManager
        }
 
        /**
-        * @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.