Merge branch 'master' of github.com:archtechx/tenancy

src/Bootstrappers/MailTenancyBootstrapper.php

@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Bootstrappers;
+
+use Illuminate\Config\Repository;
+use Illuminate\Foundation\Application;
+use Stancl\Tenancy\Contracts\TenancyBootstrapper;
+use Stancl\Tenancy\Contracts\Tenant;
+
+class MailTenancyBootstrapper implements TenancyBootstrapper
+{
+    /**
+     * Tenant properties to be mapped to config (similarly to the TenantConfig feature).
+     *
+     * For example:
+     * [
+     *     'config.key.name' => 'tenant_property',
+     * ]
+     */
+    public static array $credentialsMap = [];
+
+    public static string|null $mailer = null;
+
+    protected array $originalConfig = [];
+
+    public static array $mapPresets = [
+        'smtp' => [
+            'mail.mailers.smtp.host' => 'smtp_host',
+            'mail.mailers.smtp.port' => 'smtp_port',
+            'mail.mailers.smtp.username' => 'smtp_username',
+            'mail.mailers.smtp.password' => 'smtp_password',
+        ],
+    ];
+
+    public function __construct(
+        protected Repository $config,
+        protected Application $app
+    ) {
+        static::$mailer ??= $config->get('mail.default');
+        static::$credentialsMap = array_merge(static::$credentialsMap, static::$mapPresets[static::$mailer] ?? []);
+    }
+
+    public function bootstrap(Tenant $tenant): void
+    {
+        // Forget the mail manager instance to clear the cached mailers
+        $this->app->forgetInstance('mail.manager');
+
+        $this->setConfig($tenant);
+    }
+
+    public function revert(): void
+    {
+        $this->unsetConfig();
+
+        $this->app->forgetInstance('mail.manager');
+    }
+
+    protected function setConfig(Tenant $tenant): void
+    {
+        foreach (static::$credentialsMap as $configKey => $storageKey) {
+            $override = $tenant->$storageKey;
+
+            if (array_key_exists($storageKey, $tenant->getAttributes())) {
+                $this->originalConfig[$configKey] ??= $this->config->get($configKey);
+
+                $this->config->set($configKey, $override);
+            }
+        }
+    }
+
+    protected function unsetConfig(): void
+    {
+        foreach ($this->originalConfig as $key => $value) {
+            $this->config->set($key, $value);
+        }
+    }
+}

src/Commands/ClearPendingTenants.php

@@ -17,7 +17,7 @@ class ClearPendingTenants extends Command
 
     public function handle(): int
     {
-        $this->info('Removing pending tenants.');
+        $this->components->info('Removing pending tenants.');
 
         $expirationDate = now();
         // We compare the original expiration date to the new one to check if the new one is different later
@@ -27,8 +27,7 @@ class ClearPendingTenants extends Command
         $olderThanHours = (int) $this->option('older-than-hours');
 
         if ($olderThanDays && $olderThanHours) {
-            $this->line("<options=bold,reverse;fg=red> Cannot use '--older-than-days' and '--older-than-hours' together \n"); // todo@cli refactor all of these styled command outputs to use $this->components
-            $this->line('Please, choose only one of these options.');
+            $this->components->error("Cannot use '--older-than-days' and '--older-than-hours' together. Please, choose only one of these options.");
 
             return 1; // Exit code for failure
         }
@@ -51,7 +50,7 @@ class ClearPendingTenants extends Command
             ->delete()
             ->count();
 
-        $this->info($deletedTenantCount . ' pending ' . str('tenant')->plural($deletedTenantCount) . ' deleted.');
+        $this->components->info($deletedTenantCount . ' pending ' . str('tenant')->plural($deletedTenantCount) . ' deleted.');
 
         return 0;
     }

src/Commands/CreatePendingTenants.php

@@ -14,7 +14,7 @@ class CreatePendingTenants extends Command
 
     public function handle(): int
     {
-        $this->info('Creating pending tenants.');
+        $this->components->info('Creating pending tenants.');
 
         $maxPendingTenantCount = (int) ($this->option('count') ?? config('tenancy.pending.count'));
         $pendingTenantCount = $this->getPendingTenantCount();
@@ -30,8 +30,8 @@ class CreatePendingTenants extends Command
             $createdCount++;
         }
 
-        $this->info($createdCount . ' pending ' . str('tenant')->plural($createdCount) . ' created.');
-        $this->info($maxPendingTenantCount . ' pending ' . str('tenant')->plural($maxPendingTenantCount) . ' ready to be used.');
+        $this->components->info($createdCount . ' pending ' . str('tenant')->plural($createdCount) . ' created.');
+        $this->components->info($maxPendingTenantCount . ' pending ' . str('tenant')->plural($maxPendingTenantCount) . ' ready to be used.');
 
         return 0;
     }

src/Commands/Link.php

@@ -34,7 +34,7 @@ class Link extends Command
                 $this->createLinks($tenants);
             }
         } catch (Exception $exception) {
-            $this->error($exception->getMessage());
+            $this->components->error($exception->getMessage());
 
             return 1;
         }

src/Contracts/Domain.php

@@ -11,7 +11,7 @@ use Illuminate\Database\Eloquent\Relations\BelongsTo;
  *
  * @see \Stancl\Tenancy\Database\Models\Domain
  *
- * @method __call(string $method, array $parameters) IDE support. This will be a model.
+ * @method __call(string $method, array $parameters) IDE support. This will be a model. // todo check if we can remove these now
  * @method static __callStatic(string $method, array $parameters) IDE support. This will be a model.
  * @mixin \Illuminate\Database\Eloquent\Model
  */

src/Features/UserImpersonation.php

@@ -48,6 +48,23 @@ class UserImpersonation implements Feature
 
         $token->delete();
 
+        session()->put('tenancy_impersonating', true);
+
         return redirect($token->redirect_url);
     }
+
+    public static function isImpersonating(): bool
+    {
+        return session()->has('tenancy_impersonating');
+    }
+
+    /**
+     * Logout from the current domain and forget impersonation session.
+     */
+    public static function leave(): void // todo possibly rename
+    {
+        auth()->logout();
+
+        session()->forget('tenancy_impersonating');
+    }
 }

src/Resolvers/DomainTenantResolver.php

@@ -5,6 +5,7 @@ declare(strict_types=1);
 namespace Stancl\Tenancy\Resolvers;
 
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
 use Stancl\Tenancy\Contracts\Domain;
 use Stancl\Tenancy\Contracts\Tenant;
 use Stancl\Tenancy\Exceptions\TenantCouldNotBeIdentifiedOnDomainException;
@@ -39,14 +40,16 @@ class DomainTenantResolver extends Contracts\CachedTenantResolver
 
     protected function setCurrentDomain(Tenant $tenant, string $domain): void
     {
+        /** @var Tenant&Model $tenant */
         static::$currentDomain = $tenant->domains->where('domain', $domain)->first();
     }
 
     public function getArgsForTenant(Tenant $tenant): array
     {
+        /** @var Tenant&Model $tenant */
         $tenant->unsetRelation('domains');
 
-        return $tenant->domains->map(function (Domain $domain) {
+        return $tenant->domains->map(function (Domain&Model $domain) {
             return [$domain->domain];
         })->toArray();
     }

src/Tenancy.php

@@ -118,6 +118,7 @@ class Tenancy
      */
     public static function find(int|string $id): Tenant|null
     {
+        // todo update all syntax like this once we're fully on PHP 8.2
         /** @var (Tenant&Model)|null */
         $tenant = static::model()->where(static::model()->getTenantKeyName(), $id)->first();