general refactor, move more classes under Database namespace

src/Database/Concerns/CreatesDatabaseUsers.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\Concerns;
+
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
+
+trait CreatesDatabaseUsers
+{
+    public function createDatabase(TenantWithDatabase $tenant): bool
+    {
+        parent::createDatabase($tenant);
+
+        return $this->createUser($tenant->database());
+    }
+
+    public function deleteDatabase(TenantWithDatabase $tenant): bool
+    {
+        parent::deleteDatabase($tenant);
+
+        return $this->deleteUser($tenant->database());
+    }
+}

src/Database/Concerns/HasDatabase.php

@@ -4,8 +4,8 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Database\Concerns;
 
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
-use Stancl\Tenancy\DatabaseConfig;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\DatabaseConfig;
 
 trait HasDatabase
 {

src/Database/Concerns/HasDomains.php

@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+// todo not sure if this should be in Database\
 namespace Stancl\Tenancy\Database\Concerns;
 
 use Stancl\Tenancy\Contracts\Domain;

src/Database/Contracts/ManagesDatabaseUsers.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\Contracts;
+
+use Stancl\Tenancy\Database\DatabaseConfig;
+
+interface ManagesDatabaseUsers extends TenantDatabaseManager
+{
+    /** Create a database user. */
+    public function createUser(DatabaseConfig $databaseConfig): bool;
+
+    /** Delete a database user. */
+    public function deleteUser(DatabaseConfig $databaseConfig): bool;
+
+    /** Does a database user exist? */
+    public function userExists(string $username): bool;
+}

src/Database/Contracts/TenantDatabaseManager.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\Contracts;
+
+use Stancl\Tenancy\Database\Exceptions\NoConnectionSetException;
+
+interface TenantDatabaseManager
+{
+    /** Create a database. */
+    public function createDatabase(TenantWithDatabase $tenant): bool;
+
+    /** Delete a database. */
+    public function deleteDatabase(TenantWithDatabase $tenant): bool;
+
+    /** Does a database exist? */
+    public function databaseExists(string $name): bool;
+
+    /** Construct a DB connection config array. */
+    public function makeConnectionConfig(array $baseConfig, string $databaseName): array;
+
+    /**
+     * Set the DB connection that should be used by the tenant database manager.
+     *
+     * @throws NoConnectionSetException
+     */
+    public function setConnection(string $connection): void;
+}

src/Database/Contracts/TenantWithDatabase.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\Contracts;
+
+use Stancl\Tenancy\Contracts\Tenant;
+use Stancl\Tenancy\Database\DatabaseConfig;
+
+interface TenantWithDatabase extends Tenant
+{
+    public function database(): DatabaseConfig;
+}

src/Database/DatabaseConfig.php

@@ -0,0 +1,158 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database;
+
+use Closure;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Facades\Hash;
+use Illuminate\Support\Str;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase as Tenant;
+
+class DatabaseConfig
+{
+    // todo docblocks
+    public Tenant&Model $tenant;
+
+    public static Closure $usernameGenerator;
+
+    public static Closure $passwordGenerator;
+
+    public static Closure $databaseNameGenerator;
+
+    public static function __constructStatic(): void
+    {
+        static::$usernameGenerator = static::$usernameGenerator ?? function (Tenant $tenant) {
+            return Str::random(16);
+        };
+
+        static::$passwordGenerator = static::$passwordGenerator ?? function (Tenant $tenant) {
+            return Hash::make(Str::random(32));
+        };
+
+        static::$databaseNameGenerator = static::$databaseNameGenerator ?? function (Tenant $tenant) {
+            return config('tenancy.database.prefix') . $tenant->getTenantKey() . config('tenancy.database.suffix');
+        };
+    }
+
+    public function __construct(Tenant $tenant)
+    {
+        static::__constructStatic();
+
+        $this->tenant = $tenant;
+    }
+
+    public static function generateDatabaseNamesUsing(Closure $databaseNameGenerator): void
+    {
+        static::$databaseNameGenerator = $databaseNameGenerator;
+    }
+
+    public static function generateUsernamesUsing(Closure $usernameGenerator): void
+    {
+        static::$usernameGenerator = $usernameGenerator;
+    }
+
+    public static function generatePasswordsUsing(Closure $passwordGenerator): void
+    {
+        static::$passwordGenerator = $passwordGenerator;
+    }
+
+    public function getName(): ?string
+    {
+        return $this->tenant->getInternal('db_name') ?? (static::$databaseNameGenerator)($this->tenant);
+    }
+
+    public function getUsername(): ?string
+    {
+        return $this->tenant->getInternal('db_username') ?? null;
+    }
+
+    public function getPassword(): ?string
+    {
+        return $this->tenant->getInternal('db_password') ?? null;
+    }
+
+    /**
+     * Generate DB name, username & password and write them to the tenant model.
+     */
+    public function makeCredentials(): void
+    {
+        $this->tenant->setInternal('db_name', $this->getName() ?? (static::$databaseNameGenerator)($this->tenant));
+
+        if ($this->manager() instanceof Contracts\ManagesDatabaseUsers) {
+            $this->tenant->setInternal('db_username', $this->getUsername() ?? (static::$usernameGenerator)($this->tenant));
+            $this->tenant->setInternal('db_password', $this->getPassword() ?? (static::$passwordGenerator)($this->tenant));
+        }
+
+        if ($this->tenant->exists) {
+            $this->tenant->save();
+        }
+    }
+
+    public function getTemplateConnectionName(): string
+    {
+        return $this->tenant->getInternal('db_connection')
+            ?? config('tenancy.database.template_tenant_connection')
+            ?? config('tenancy.database.central_connection');
+    }
+
+    /**
+     * Tenant's own database connection config.
+     */
+    public function connection(): array
+    {
+        $template = $this->getTemplateConnectionName();
+        $templateConnection = config("database.connections.{$template}");
+
+        return $this->manager()->makeConnectionConfig(
+            array_merge($templateConnection, $this->tenantConfig()),
+            $this->getName()
+        );
+    }
+
+    /**
+     * Additional config for the database connection, specific to this tenant.
+     */
+    public function tenantConfig(): array
+    {
+        $dbConfig = array_filter(array_keys($this->tenant->getAttributes()), function ($key) {
+            return Str::startsWith($key, $this->tenant->internalPrefix() . 'db_');
+        });
+
+        // Remove DB name because we set that separately
+        if (($pos = array_search($this->tenant->internalPrefix() . 'db_name', $dbConfig)) !== false) {
+            unset($dbConfig[$pos]);
+        }
+
+        // Remove DB connection because that's not used inside the array
+        if (($pos = array_search($this->tenant->internalPrefix() . 'db_connection', $dbConfig)) !== false) {
+            unset($dbConfig[$pos]);
+        }
+
+        return array_reduce($dbConfig, function ($config, $key) {
+            return array_merge($config, [
+                Str::substr($key, strlen($this->tenant->internalPrefix() . 'db_')) => $this->tenant->getAttribute($key),
+            ]);
+        }, []);
+    }
+
+    /** Get the TenantDatabaseManager for this tenant's connection. */
+    public function manager(): Contracts\TenantDatabaseManager
+    {
+        $driver = config("database.connections.{$this->getTemplateConnectionName()}.driver");
+
+        $databaseManagers = config('tenancy.database.managers');
+
+        if (! array_key_exists($driver, $databaseManagers)) {
+            throw new Exceptions\DatabaseManagerNotRegisteredException($driver);
+        }
+
+        /** @var Contracts\TenantDatabaseManager $databaseManager */
+        $databaseManager = app($databaseManagers[$driver]);
+
+        $databaseManager->setConnection($this->getTemplateConnectionName());
+
+        return $databaseManager;
+    }
+}

src/Database/DatabaseManager.php

@@ -7,14 +7,8 @@ namespace Stancl\Tenancy\Database;
 use Illuminate\Config\Repository;
 use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Database\DatabaseManager as BaseDatabaseManager;
-use Stancl\Tenancy\Contracts\ManagesDatabaseUsers;
 use Stancl\Tenancy\Contracts\TenantCannotBeCreatedException;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
-use Stancl\Tenancy\Exceptions\DatabaseManagerNotRegisteredException;
-use Stancl\Tenancy\Exceptions\TenantDatabaseAlreadyExistsException;
-use Stancl\Tenancy\Exceptions\TenantDatabaseUserAlreadyExistsException;
-
-// todo move to Database namespace
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 
 /**
  * @internal Class is subject to breaking changes in minor and patch versions.
@@ -97,11 +91,11 @@ class DatabaseManager
         $manager = $tenant->database()->manager();
 
         if ($manager->databaseExists($database = $tenant->database()->getName())) {
-            throw new TenantDatabaseAlreadyExistsException($database);
+            throw new Exceptions\TenantDatabaseAlreadyExistsException($database);
         }
 
-        if ($manager instanceof ManagesDatabaseUsers && $manager->userExists($username = $tenant->database()->getUsername())) {
-            throw new TenantDatabaseUserAlreadyExistsException($username);
+        if ($manager instanceof Contracts\ManagesDatabaseUsers && $manager->userExists($username = $tenant->database()->getUsername())) {
+            throw new Exceptions\TenantDatabaseUserAlreadyExistsException($username);
         }
     }
 }

src/Database/Exceptions/DatabaseManagerNotRegisteredException.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\Exceptions;
+
+use Exception;
+
+class DatabaseManagerNotRegisteredException extends Exception
+{
+    public function __construct(string $driver)
+    {
+        parent::__construct("Database manager for driver $driver is not registered.");
+    }
+}

src/Database/Exceptions/NoConnectionSetException.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\Exceptions;
+
+use Exception;
+
+class NoConnectionSetException extends Exception
+{
+    public function __construct($manager)
+    {
+        parent::__construct("No connection was set on this $manager instance.");
+    }
+}

src/Database/Exceptions/TenantDatabaseAlreadyExistsException.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\Exceptions;
+
+use Stancl\Tenancy\Contracts\TenantCannotBeCreatedException;
+
+class TenantDatabaseAlreadyExistsException extends TenantCannotBeCreatedException
+{
+    public function __construct(
+        protected string $database,
+    ) {
+        parent::__construct();
+    }
+
+    public function reason(): string
+    {
+        return "Database {$this->database} already exists.";
+    }
+}

src/Database/Exceptions/TenantDatabaseDoesNotExistException.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\Exceptions;
+
+use Exception;
+
+class TenantDatabaseDoesNotExistException extends Exception
+{
+    public function __construct(string $database)
+    {
+        parent::__construct("Database $database does not exist.");
+    }
+}

src/Database/Exceptions/TenantDatabaseUserAlreadyExistsException.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\Exceptions;
+
+use Stancl\Tenancy\Contracts\TenantCannotBeCreatedException;
+
+class TenantDatabaseUserAlreadyExistsException extends TenantCannotBeCreatedException
+{
+    public function __construct(
+        protected string $user,
+    ) {
+        parent::__construct();
+    }
+
+    public function reason(): string
+    {
+        return "Database user {$this->user} already exists.";
+    }
+}

src/Database/TenantDatabaseManagers/MicrosoftSQLDatabaseManager.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+// todo likely move all of these classes to Database\
+
+namespace Stancl\Tenancy\Database\TenantDatabaseManagers;
+
+use Illuminate\Database\Connection;
+use Illuminate\Support\Facades\DB;
+use Stancl\Tenancy\Database\Contracts\TenantDatabaseManager;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Exceptions\NoConnectionSetException;
+
+class MicrosoftSQLDatabaseManager implements TenantDatabaseManager
+{
+    protected string $connection; // todo docblock, in all of these classes
+
+    protected function database(): Connection // todo consider abstracting this method & setConnection() into a base class
+    {
+        if ($this->connection === null) {
+            throw new NoConnectionSetException(static::class);
+        }
+
+        return DB::connection($this->connection);
+    }
+
+    public function setConnection(string $connection): void
+    {
+        $this->connection = $connection;
+    }
+
+    public function createDatabase(TenantWithDatabase $tenant): bool
+    {
+        $database = $tenant->database()->getName();
+        $charset = $this->database()->getConfig('charset');
+        $collation = $this->database()->getConfig('collation'); // todo check why these are not used
+
+        return $this->database()->statement("CREATE DATABASE [{$database}]");
+    }
+
+    public function deleteDatabase(TenantWithDatabase $tenant): bool
+    {
+        return $this->database()->statement("DROP DATABASE [{$tenant->database()->getName()}]");
+    }
+
+    public function databaseExists(string $name): bool
+    {
+        return (bool) $this->database()->select("SELECT name FROM master.sys.databases WHERE name = '$name'");
+    }
+
+    public function makeConnectionConfig(array $baseConfig, string $databaseName): array
+    {
+        $baseConfig['database'] = $databaseName;
+
+        return $baseConfig;
+    }
+}

src/Database/TenantDatabaseManagers/MySQLDatabaseManager.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\TenantDatabaseManagers;
+
+use Illuminate\Database\Connection;
+use Illuminate\Support\Facades\DB;
+use Stancl\Tenancy\Database\Contracts\TenantDatabaseManager;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Exceptions\NoConnectionSetException;
+
+class MySQLDatabaseManager implements TenantDatabaseManager
+{
+    /** @var string */
+    protected $connection;
+
+    protected function database(): Connection
+    {
+        if ($this->connection === null) {
+            throw new NoConnectionSetException(static::class);
+        }
+
+        return DB::connection($this->connection);
+    }
+
+    public function setConnection(string $connection): void
+    {
+        $this->connection = $connection;
+    }
+
+    public function createDatabase(TenantWithDatabase $tenant): bool
+    {
+        $database = $tenant->database()->getName();
+        $charset = $this->database()->getConfig('charset');
+        $collation = $this->database()->getConfig('collation');
+
+        return $this->database()->statement("CREATE DATABASE `{$database}` CHARACTER SET `$charset` COLLATE `$collation`");
+    }
+
+    public function deleteDatabase(TenantWithDatabase $tenant): bool
+    {
+        return $this->database()->statement("DROP DATABASE `{$tenant->database()->getName()}`");
+    }
+
+    public function databaseExists(string $name): bool
+    {
+        return (bool) $this->database()->select("SELECT SCHEMA_NAME FROM INFORMATION_SCHEMA.SCHEMATA WHERE SCHEMA_NAME = '$name'");
+    }
+
+    public function makeConnectionConfig(array $baseConfig, string $databaseName): array
+    {
+        $baseConfig['database'] = $databaseName;
+
+        return $baseConfig;
+    }
+}

src/Database/TenantDatabaseManagers/PermissionControlledMySQLDatabaseManager.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\TenantDatabaseManagers;
+
+use Stancl\Tenancy\Database\Concerns\CreatesDatabaseUsers;
+use Stancl\Tenancy\Database\Contracts\ManagesDatabaseUsers;
+use Stancl\Tenancy\Database\DatabaseConfig;
+
+class PermissionControlledMySQLDatabaseManager extends MySQLDatabaseManager implements ManagesDatabaseUsers
+{
+    use CreatesDatabaseUsers;
+
+    public static $grants = [
+        'ALTER', 'ALTER ROUTINE', 'CREATE', 'CREATE ROUTINE', 'CREATE TEMPORARY TABLES', 'CREATE VIEW',
+        'DELETE', 'DROP', 'EVENT', 'EXECUTE', 'INDEX', 'INSERT', 'LOCK TABLES', 'REFERENCES', 'SELECT',
+        'SHOW VIEW', 'TRIGGER', 'UPDATE',
+    ];
+
+    public function createUser(DatabaseConfig $databaseConfig): bool
+    {
+        $database = $databaseConfig->getName();
+        $username = $databaseConfig->getUsername();
+        $hostname = $databaseConfig->connection()['host'];
+        $password = $databaseConfig->getPassword();
+
+        $this->database()->statement("CREATE USER `{$username}`@`%` IDENTIFIED BY '{$password}'");
+
+        $grants = implode(', ', static::$grants);
+
+        if ($this->isVersion8()) { // MySQL 8+
+            $grantQuery = "GRANT $grants ON `$database`.* TO `$username`@`%`";
+        } else { // MySQL 5.7
+            $grantQuery = "GRANT $grants ON `$database`.* TO `$username`@`%` IDENTIFIED BY '$password'";
+        }
+
+        return $this->database()->statement($grantQuery);
+    }
+
+    protected function isVersion8(): bool
+    {
+        $version = $this->database()->select($this->database()->raw('select version()'))[0]->{'version()'};
+
+        return version_compare($version, '8.0.0') >= 0;
+    }
+
+    public function deleteUser(DatabaseConfig $databaseConfig): bool
+    {
+        return $this->database()->statement("DROP USER IF EXISTS '{$databaseConfig->getUsername()}'");
+    }
+
+    public function userExists(string $username): bool
+    {
+        return (bool) $this->database()->select("SELECT count(*) FROM mysql.user WHERE user = '$username'")[0]->{'count(*)'};
+    }
+
+    public function makeConnectionConfig(array $baseConfig, string $databaseName): array
+    {
+        $baseConfig['database'] = $databaseName;
+
+        return $baseConfig;
+    }
+}

src/Database/TenantDatabaseManagers/PostgreSQLDatabaseManager.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\TenantDatabaseManagers;
+
+use Illuminate\Database\Connection;
+use Illuminate\Support\Facades\DB;
+use Stancl\Tenancy\Database\Contracts\TenantDatabaseManager;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Exceptions\NoConnectionSetException;
+
+class PostgreSQLDatabaseManager implements TenantDatabaseManager
+{
+    /** @var string */
+    protected $connection;
+
+    protected function database(): Connection
+    {
+        if ($this->connection === null) {
+            throw new NoConnectionSetException(static::class);
+        }
+
+        return DB::connection($this->connection);
+    }
+
+    public function setConnection(string $connection): void
+    {
+        $this->connection = $connection;
+    }
+
+    public function createDatabase(TenantWithDatabase $tenant): bool
+    {
+        return $this->database()->statement("CREATE DATABASE \"{$tenant->database()->getName()}\" WITH TEMPLATE=template0");
+    }
+
+    public function deleteDatabase(TenantWithDatabase $tenant): bool
+    {
+        return $this->database()->statement("DROP DATABASE \"{$tenant->database()->getName()}\"");
+    }
+
+    public function databaseExists(string $name): bool
+    {
+        return (bool) $this->database()->select("SELECT datname FROM pg_database WHERE datname = '$name'");
+    }
+
+    public function makeConnectionConfig(array $baseConfig, string $databaseName): array
+    {
+        $baseConfig['database'] = $databaseName;
+
+        return $baseConfig;
+    }
+}

src/Database/TenantDatabaseManagers/PostgreSQLSchemaManager.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\TenantDatabaseManagers;
+
+use Illuminate\Database\Connection;
+use Illuminate\Support\Facades\DB;
+use Stancl\Tenancy\Database\Contracts\TenantDatabaseManager;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Exceptions\NoConnectionSetException;
+
+class PostgreSQLSchemaManager implements TenantDatabaseManager
+{
+    /** @var string */
+    protected $connection;
+
+    protected function database(): Connection
+    {
+        if ($this->connection === null) {
+            throw new NoConnectionSetException(static::class);
+        }
+
+        return DB::connection($this->connection);
+    }
+
+    public function setConnection(string $connection): void
+    {
+        $this->connection = $connection;
+    }
+
+    public function createDatabase(TenantWithDatabase $tenant): bool
+    {
+        return $this->database()->statement("CREATE SCHEMA \"{$tenant->database()->getName()}\"");
+    }
+
+    public function deleteDatabase(TenantWithDatabase $tenant): bool
+    {
+        return $this->database()->statement("DROP SCHEMA \"{$tenant->database()->getName()}\" CASCADE");
+    }
+
+    public function databaseExists(string $name): bool
+    {
+        return (bool) $this->database()->select("SELECT schema_name FROM information_schema.schemata WHERE schema_name = '$name'");
+    }
+
+    public function makeConnectionConfig(array $baseConfig, string $databaseName): array
+    {
+        if (version_compare(app()->version(), '9.0', '>=')) {
+            $baseConfig['search_path'] = $databaseName;
+        } else {
+            $baseConfig['schema'] = $databaseName;
+        }
+
+        return $baseConfig;
+    }
+}

src/Database/TenantDatabaseManagers/SQLiteDatabaseManager.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\TenantDatabaseManagers;
+
+use Stancl\Tenancy\Database\Contracts\TenantDatabaseManager;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
+
+class SQLiteDatabaseManager implements TenantDatabaseManager
+{
+    public function createDatabase(TenantWithDatabase $tenant): bool
+    {
+        try {
+            return file_put_contents(database_path($tenant->database()->getName()), '');
+        } catch (\Throwable) {
+            return false;
+        }
+    }
+
+    public function deleteDatabase(TenantWithDatabase $tenant): bool
+    {
+        try {
+            return unlink(database_path($tenant->database()->getName()));
+        } catch (\Throwable) {
+            return false;
+        }
+    }
+
+    public function databaseExists(string $name): bool
+    {
+        return file_exists(database_path($name));
+    }
+
+    public function makeConnectionConfig(array $baseConfig, string $databaseName): array
+    {
+        $baseConfig['database'] = database_path($databaseName);
+
+        return $baseConfig;
+    }
+
+    public function setConnection(string $connection): void
+    {
+        //
+    }
+}