From: nupplaPhil <admin@philipp.info>
Date: Fri, 17 Jan 2020 22:25:11 +0000 (+0100)
Subject: Add legacy backend storage functionality
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=ca8ca05051964dc5ffd881b83d8b1d04a56df776;p=friendica.git

Add legacy backend storage functionality
---

diff --git a/src/Core/StorageManager.php b/src/Core/StorageManager.php
index d1a943a227..8fd0d1a93f 100644
--- a/src/Core/StorageManager.php
+++ b/src/Core/StorageManager.php
@@ -88,6 +88,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
@@ -140,6 +143,25 @@ class StorageManager
 		       (!$onlyUserBackend && $name === Storage\SystemResource::getName());
 	}
 
+	/**
+	 * 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;
+	}
+
 	/**
 	 * @brief Set current storage backend class
 	 *
diff --git a/tests/src/Core/StorageManagerTest.php b/tests/src/Core/StorageManagerTest.php
index 084caa68ab..b7e5b8c3dd 100644
--- a/tests/src/Core/StorageManagerTest.php
+++ b/tests/src/Core/StorageManagerTest.php
@@ -109,10 +109,42 @@ class StorageManagerTest extends DatabaseTest
 		];
 	}
 
+	/**
+	 * Data array for legacy backends
+	 *
+	 * @todo 2020.09 After 2 releases, remove the legacy functionality and these data array with it
+	 *
+	 * @return array
+	 */
+	public function dataLegacyBackends()
+	{
+		return [
+			'legacyDatabase'          => [
+				'name'        => 'Friendica\Model\Storage\Database',
+				'assert'      => Storage\Database::class,
+				'assertName'  => Storage\Database::NAME,
+				'userBackend' => true,
+			],
+			'legacyFilesystem'       => [
+				'name'        => 'Friendica\Model\Storage\Filesystem',
+				'assert'      => Storage\Filesystem::class,
+				'assertName'  => Storage\Filesystem::NAME,
+				'userBackend' => true,
+			],
+			'legacySystemResource'     => [
+				'name'        => 'Friendica\Model\Storage\SystemResource',
+				'assert'      => Storage\SystemResource::class,
+				'assertName'  => Storage\SystemResource::NAME,
+				'userBackend' => false,
+			],
+		];
+	}
+
 	/**
 	 * Test the getByName() method
 	 *
 	 * @dataProvider dataStorages
+	 * @dataProvider dataLegacyBackends
 	 */
 	public function testGetByName($name, $assert, $assertName, $userBackend)
 	{
@@ -123,7 +155,6 @@ class StorageManagerTest extends DatabaseTest
 		if (!empty($assert)) {
 			$this->assertInstanceOf(Storage\IStorage::class, $storage);
 			$this->assertInstanceOf($assert, $storage);
-			$this->assertEquals($name, $storage::getName());
 		} else {
 			$this->assertNull($storage);
 		}
@@ -178,6 +209,7 @@ class StorageManagerTest extends DatabaseTest
 	 * Test the method getBackend() with a pre-configured backend
 	 *
 	 * @dataProvider dataStorages
+	 * @dataProvider dataLegacyBackends
 	 */
 	public function testPresetBackend($name, $assert, $assertName, $userBackend)
 	{