Cloud storage library simplifications

src/Environment/Environment.php

@@ -9,14 +9,12 @@
  * @author Arman Ag. <arman.ag@softberg.org>
  * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
  * @link http://quantum.softberg.org/
- * @since 2.9.5
+ * @since 2.9.6
  */
 
 namespace Quantum\Environment;
 
-use Quantum\Libraries\Storage\Factories\FileSystemFactory;
 use Quantum\Environment\Exceptions\EnvException;
-use Quantum\Libraries\Storage\FileSystem;
 use Quantum\Di\Exceptions\DiException;
 use Quantum\Exceptions\BaseException;
 use Quantum\Loader\Loader;
@@ -34,12 +32,6 @@
 class Environment
 {
 
-    /**
-     * FileSystem instance
-     * @var FileSystem
-     */
-    private $fs;
-
     /**
      * Environment file
      * @var string
@@ -65,14 +57,6 @@ class Environment
      */
     private static $instance = null;
 
-    /**
-     * @throws BaseException
-     */
-    private function __construct()
-    {
-        $this->fs = FileSystemFactory::get();
-    }
-
     /**
      * GetInstance
      * @return Environment
@@ -197,14 +181,11 @@ public function updateRow(string $key, ?string $value)
         $envFilePath = App::getBaseDir() . DS . $this->envFile;
 
         if ($row) {
-            $this->fs->put($envFilePath, preg_replace(
-                    '/^' . $row . '/m',
-                    $key . "=" . $value,
-                    $this->fs->get($envFilePath)
-                )
-            );
+            $envFileContent = file_get_contents($envFilePath);
+            $envFileContent = preg_replace('/^' . preg_quote($row, '/') . '/m', $key . "=" . $value, $envFileContent);
+            file_put_contents($envFilePath, $envFileContent);
         } else {
-            $this->fs->append($envFilePath, PHP_EOL . $key . "=" . $value . PHP_EOL);
+            file_put_contents($envFilePath, PHP_EOL . $key . "=" . $value . PHP_EOL, FILE_APPEND);
         }
 
         $this->envContent = Dotenv::createMutable(App::getBaseDir(), $this->envFile)->load();

src/Libraries/Storage/Exceptions/FileSystemException.php

@@ -9,7 +9,7 @@
  * @author Arman Ag. <arman.ag@softberg.org>
  * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
  * @link http://quantum.softberg.org/
- * @since 2.9.5
+ * @since 2.9.6
  */
 
 namespace Quantum\Libraries\Storage\Exceptions;
@@ -48,4 +48,12 @@ public static function fileAlreadyExists(): FileSystemException
     {
         return new static(t('exception.file_already_exists'), E_WARNING);
     }
+
+    /**
+     * @return FileSystemException
+     */
+    public static function incorrectTokenService(): FileSystemException
+    {
+        return new static(t('exception.incorrect_auth_service'), E_WARNING);
+    }
 }

src/Libraries/Storage/Factories/FileSystemFactory.php

@@ -9,18 +9,28 @@
  * @author Arman Ag. <arman.ag@softberg.org>
  * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
  * @link http://quantum.softberg.org/
- * @since 2.9.5
+ * @since 2.9.6
  */
 
 namespace Quantum\Libraries\Storage\Factories;
 
 use Quantum\Libraries\Storage\Adapters\GoogleDrive\GoogleDriveFileSystemAdapter;
 use Quantum\Libraries\Storage\Adapters\Dropbox\DropboxFileSystemAdapter;
 use Quantum\Libraries\Storage\Adapters\Local\LocalFileSystemAdapter;
+use Quantum\Libraries\Storage\Adapters\GoogleDrive\GoogleDriveApp;
+use Quantum\Libraries\Storage\Contracts\TokenServiceInterface;
 use Quantum\Libraries\Storage\Exceptions\FileSystemException;
+use Quantum\Libraries\Storage\Adapters\Dropbox\DropboxApp;
 use Quantum\Libraries\Storage\Contracts\CloudAppInterface;
+use Quantum\Libraries\Config\Exceptions\ConfigException;
+use Quantum\Libraries\HttpClient\HttpClient;
 use Quantum\Libraries\Storage\FileSystem;
+use Quantum\Exceptions\ServiceException;
+use Quantum\Di\Exceptions\DiException;
 use Quantum\Exceptions\BaseException;
+use Quantum\Factory\ServiceFactory;
+use Quantum\Loader\Setup;
+use ReflectionException;
 
 /**
  * Class FileSystemFactory
@@ -38,40 +48,114 @@ class FileSystemFactory
         FileSystem::GDRIVE => GoogleDriveFileSystemAdapter::class,
     ];
 
+    /**
+     * Supported apps
+     */
+    const APPS = [
+        FileSystem::DROPBOX => DropboxApp::class,
+        FileSystem::GDRIVE => GoogleDriveApp::class,
+    ];
+
     /**
      * @var array
      */
     private static $instances = [];
 
     /**
-     * @param string $type
-     * @param CloudAppInterface|null $cloudApp
+     * @param string|null $adapter
      * @return FileSystem
      * @throws BaseException
+     * @throws DiException
+     * @throws ReflectionException
+     * @throws ConfigException
      */
-    public static function get(string $type = FileSystem::LOCAL, ?CloudAppInterface $cloudApp = null): FileSystem
+    public static function get(?string $adapter = null): FileSystem
     {
-        if (!isset(self::$instances[$type])) {
-            self::$instances[$type] = self::createInstance($type, $cloudApp);
+        if (!config()->has('fs')) {
+            config()->import(new Setup('Config', 'fs'));
+        }
+
+        $adapter = $adapter ?? config()->get('fs.default');
+
+        $adapterClass = self::getAdapterClass($adapter);
+
+        if (!isset(self::$instances[$adapter])) {
+            self::$instances[$adapter] = self::createInstance($adapterClass, $adapter);
         }
 
-        return self::$instances[$type];
+        return self::$instances[$adapter];
     }
 
     /**
-     * @param string $type
-     * @param CloudAppInterface|null $cloudApp
+     * @param string $adapterClass
+     * @param string $adapter
      * @return FileSystem
+     * @throws DiException
+     * @throws FileSystemException
+     * @throws ReflectionException
+     * @throws ServiceException
+     */
+    private static function createInstance(string $adapterClass, string $adapter): FileSystem
+    {
+        return new FileSystem(new $adapterClass(
+            self::createCloudApp($adapter)
+        ));
+    }
+
+    /**
+     * @param string $adapter
+     * @return string
      * @throws BaseException
      */
-    private static function createInstance(string $type, ?CloudAppInterface $cloudApp = null): FileSystem
+    private static function getAdapterClass(string $adapter): string
+    {
+        if (!array_key_exists($adapter, self::ADAPTERS)) {
+            throw FileSystemException::adapterNotSupported($adapter);
+        }
+
+        return self::ADAPTERS[$adapter];
+    }
+
+    /**
+     * @param string $adapter
+     * @return CloudAppInterface|null
+     * @throws DiException
+     * @throws FileSystemException
+     * @throws ReflectionException
+     * @throws ServiceException
+     */
+    private static function createCloudApp(string $adapter): ?CloudAppInterface
     {
-        if (!isset(self::ADAPTERS[$type])) {
-            throw FileSystemException::adapterNotSupported($type);
+        if ($adapter === FileSystem::LOCAL || !isset(self::APPS[$adapter])) {
+            return null;
         }
 
-        $adapterClass = self::ADAPTERS[$type];
+        $cloudAppClass = self::APPS[$adapter];
+
+        return new $cloudAppClass(
+            config()->get('fs.' . $adapter . '.params.app_key'),
+            config()->get('fs.' . $adapter . '.params.app_secret'),
+            self::createTokenService($adapter),
+            new HttpClient()
+        );
+    }
+
+    /**
+     * @param string $adapter
+     * @return TokenServiceInterface
+     * @throws FileSystemException
+     * @throws DiException
+     * @throws ServiceException
+     * @throws ReflectionException
+     */
+    private static function createTokenService(string $adapter): TokenServiceInterface
+    {
+        $tokenService = ServiceFactory::create(config()->get('fs.' . $adapter . '.service'));
+
+        if (!$tokenService instanceof TokenServiceInterface) {
+            throw FileSystemException::incorrectTokenService();
+        }
 
-        return new FileSystem(new $adapterClass($cloudApp));
+        return $tokenService;
     }
 }

src/Libraries/Storage/Helpers/fs.php

@@ -0,0 +1,37 @@
+<?php
+
+/**
+ * Quantum PHP Framework
+ *
+ * An open source software development framework for PHP
+ *
+ * @package Quantum
+ * @author Arman Ag. <arman.ag@softberg.org>
+ * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
+ * @link http://quantum.softberg.org/
+ * @since 2.9.6
+ */
+
+use Quantum\Libraries\Storage\Factories\FileSystemFactory;
+use Quantum\Libraries\Config\Exceptions\ConfigException;
+use Quantum\Libraries\Auth\Exceptions\AuthException;
+use Quantum\Libraries\Storage\FileSystem;
+use Quantum\Exceptions\ServiceException;
+use Quantum\Di\Exceptions\DiException;
+use Quantum\Exceptions\BaseException;
+
+/**
+ * Gets the FileSystem handler
+ * @param string|null $adapter
+ * @return FileSystem
+ * @throws AuthException
+ * @throws BaseException
+ * @throws ConfigException
+ * @throws DiException
+ * @throws ReflectionException
+ * @throws ServiceException
+ */
+function fs(?string $adapter = null): FileSystem
+{
+    return FileSystemFactory::get($adapter);
+}

src/Loader/Loader.php

@@ -9,12 +9,11 @@
  * @author Arman Ag. <arman.ag@softberg.org>
  * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
  * @link http://quantum.softberg.org/
- * @since 2.9.5
+ * @since 2.9.6
  */
 
 namespace Quantum\Loader;
 
-use Quantum\Libraries\Storage\Factories\FileSystemFactory;
 use Quantum\Loader\Exceptions\LoaderException;
 use Quantum\Exceptions\BaseException;
 use ReflectionException;
@@ -157,9 +156,7 @@ public function loadClassFromFile(
         callable $notDefinedException,
         array $constructorArgs = []
     ) {
-        $fs = FileSystemFactory::get();
-
-        if (!$fs->exists($filePath)) {
+        if (!file_exists($filePath)) {
             throw $notFoundException();
         }
 

tests/Unit/AppTestCase.php

@@ -18,8 +18,6 @@ abstract class AppTestCase extends TestCase
 
     public function setUp(): void
     {
-        $this->fs = FileSystemFactory::get();
-
         AppFactory::create(App::WEB, PROJECT_ROOT);
 
         Config::getInstance()->flush();
@@ -30,6 +28,8 @@ public function setUp(): void
 
         Config::getInstance()
             ->load(new Setup('config', 'config'));
+
+        $this->fs = FileSystemFactory::get();
     }
 
     protected function setPrivateProperty($object, $property, $value): void