projectsend/app/Modules/Platform/Settings/MailConfigApplier.php

<?php

declare(strict_types=1);

namespace App\Modules\Platform\Settings;

use App\Modules\Platform\Capabilities\Capability;
use App\Modules\Platform\Capabilities\CapabilityRegistry;
use App\Modules\Platform\Mail\MailOAuthConnection;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Config;
use Illuminate\Support\Facades\Schema;

/**
 * Overrides Laravel's mail config with the admin-configured
 * MailProviderSettings row, when one exists — otherwise leaves
 * config/mail.php + .env completely untouched (fresh installs, or any
 * install that hasn't visited the Email settings page yet, behave
 * exactly as before this feature existed).
 *
 * Transport (host/port/username/password/encryption) and sender identity
 * (from address/name) are gated independently: transport only applies
 * under Capability::EmailTransportConfigure (community edition — cloud
 * operates its own relay and must never honor a stored host, even a
 * stray one), while sender identity always applies in both editions —
 * hosted customers still set their own From/reply-to.
 *
 * Called on every process boot (PlatformServiceProvider::boot(), so both
 * web requests and a freshly (re)started queue worker pick it up) and
 * once more immediately after a save, so the same request already
 * reflects the new values (e.g. before clicking "Send test email").
 */
class MailConfigApplier
{
    // Bumped (was 'platform.mail_provider_settings') when the resolved
    // array's shape changed (transport/identity split) — a stale
    // rememberForever value under the old key would otherwise crash every
    // boot with "Undefined array key" (PlatformServiceProvider::boot()
    // calls apply() unconditionally). Bump again on any future shape change.
    // v3: OAuth provider fields added. Note what is deliberately NOT in
    // the cached shape: tokens. Transports read those fresh from the
    // connection row at send time — only readiness and the connected
    // address are cheap enough to be worth caching, and neither is a
    // credential.
    // v4: the SMTP password left for the same reason the tokens never
    // arrived. The cache store encrypts nothing and rememberForever never
    // expires, so on the documented CACHE_STORE=database it wrote the
    // password in clear into the same database whose dump the `encrypted`
    // cast exists to survive. It is now read straight from the row, and
    // only on the boot that actually configures an SMTP transport.
    private const CACHE_KEY = 'platform.mail_provider_settings.v4';

    public function __construct(
        private readonly CapabilityRegistry $capabilities,
    ) {}

    public function apply(): void
    {
        $resolved = $this->resolve();

        if ($resolved['oauth_mailer'] !== null && $resolved['oauth_ready'] && $this->capabilities->has(Capability::EmailTransportConfigure)) {
            Config::set('mail.default', $resolved['oauth_mailer']);

            // Delegated Graph/Gmail can only send as the mailbox that
            // consented, so the From address is pinned to it — a stored
            // from_address from an earlier SMTP setup must not survive
            // into a mode where the vendor would reject it (SendAsDenied).
            if ($resolved['oauth_account'] !== null) {
                Config::set('mail.from.address', $resolved['oauth_account']);
            }
        } elseif ($resolved['transport_configured'] && $this->capabilities->has(Capability::EmailTransportConfigure)) {
            Config::set('mail.default', 'smtp');
            Config::set('mail.mailers.smtp.host', $resolved['host']);
            Config::set('mail.mailers.smtp.port', $resolved['port']);
            Config::set('mail.mailers.smtp.username', $resolved['username']);
            Config::set('mail.mailers.smtp.password', $this->password());
            Config::set('mail.mailers.smtp.encryption', $resolved['encryption']);
        }

        if ($resolved['from_address'] !== null && ($resolved['oauth_mailer'] === null || ! $resolved['oauth_ready'])) {
            Config::set('mail.from.address', $resolved['from_address']);
        }

        if ($resolved['from_name'] !== null) {
            Config::set('mail.from.name', $resolved['from_name']);
        }
    }

    public function flush(): void
    {
        Cache::forget(self::CACHE_KEY);
    }

    /**
     * The SMTP password, read from the row rather than from the cache.
     *
     * The same rule MailOAuthConnection states for tokens — "must never
     * travel through the boot-config cache" — applied to the credential
     * this class configures itself. Reached only from the SMTP branch of
     * apply(), so an installation using OAuth, or one that has never
     * opened the Email screen, still boots without touching the table.
     *
     * Guarded like the cached read beside it: resolve() can hand back a
     * warm "transport_configured" from a database that has since stopped
     * answering, and booting must survive that.
     */
    private function password(): ?string
    {
        return BootSettingsCache::read(
            fn (): ?string => MailProviderSettings::current()->password,
        );
    }

    /**
     * @return array{transport_configured: bool, host: string|null, port: int|null, username: string|null, encryption: string|null, from_address: string|null, from_name: string|null, oauth_mailer: string|null, oauth_ready: bool, oauth_account: string|null}
     */
    private function resolve(): array
    {
        $blank = [
            'transport_configured' => false,
            'host' => null, 'port' => null, 'username' => null, 'encryption' => null,
            'from_address' => null, 'from_name' => null,
            'oauth_mailer' => null, 'oauth_ready' => false, 'oauth_account' => null,
        ];

        // Through BootSettingsCache, not Cache directly: this runs on every
        // process boot, including the artisan commands that install the
        // application, and must survive a database that has no tables yet
        // (or none at all). See that class for the full story.
        return BootSettingsCache::rememberForever(self::CACHE_KEY, function () use ($blank): array {
            if (! Schema::hasTable('mail_provider_settings')) {
                return $blank;
            }

            $settings = MailProviderSettings::current();
            $hasHost = $settings->host !== null && $settings->host !== '';

            $oauthMailer = null;
            $oauthReady = false;
            $oauthAccount = null;

            // The table guard covers an install mid-upgrade, where this
            // migration has not run yet but the settings row already
            // names an OAuth provider (it can't, but a guard beats a
            // boot-killing query on the ordering assumption).
            if ($settings->provider->isOAuth() && Schema::hasTable('mail_oauth_connections')) {
                $connection = MailOAuthConnection::for($settings->provider);

                $oauthMailer = $settings->provider->oauthMailer();
                $oauthReady = $connection->usable();
                $oauthAccount = $connection->account_email;
            }

            return [
                'transport_configured' => $hasHost && ! $settings->provider->isOAuth(),
                'host' => $settings->host,
                'port' => $settings->port,
                'username' => $settings->username,
                'encryption' => $settings->encryption === 'none' ? null : $settings->encryption,
                'from_address' => $settings->from_address,
                'from_name' => $settings->from_name,
                'oauth_mailer' => $oauthMailer,
                'oauth_ready' => $oauthReady,
                'oauth_account' => $oauthAccount,
            ];
        }, $blank);
    }
}