Plugin.php

<?php

declare(strict_types=1);

namespace Vdlp\Horizon;

use Backend\Classes\AuthManager;
use Backend\Helpers\Backend;
use Backend\Models\User;
use Illuminate\Notifications\NotificationServiceProvider;
use Laravel\Horizon\Horizon;
use System\Classes\PluginBase;
use Vdlp\Horizon\Console\ClearQueuesCommand;
use Vdlp\Horizon\Console\InstallCommand;
use Vdlp\Horizon\Console\PushExampleJobsCommand;
use Vdlp\Horizon\ServiceProviders\HorizonServiceProvider;

final class Plugin extends PluginBase
{
    public function pluginDetails(): array
    {
        return [
            'name' => 'Horizon',
            'description' => 'Laravel Horizon integration for October CMS',
            'author' => 'Van der Let & Partners',
            'icon' => 'icon-area-chart',
            'homepage' => 'https://octobercms.com/plugin/vdlp-horizon',
        ];
    }

    public function boot(): void
    {
        config()->set('app.env', $this->app->environment());

        Horizon::auth(static function (): bool {
            /** @var ?User $user */
            $user = AuthManager::instance()->getUser();

            if ($user === null) {
                return false;
            }

            return $user->hasPermission('vdlp.horizon.access_dashboard')
                || $user->isSuperUser();
        });

        $this->bootNotificationSettings();

        if (config('app.debug') === true) {
            $this->registerConsoleCommand(PushExampleJobsCommand::class, PushExampleJobsCommand::class);
        }

        $this->registerConsoleCommand(ClearQueuesCommand::class, ClearQueuesCommand::class);
        $this->registerConsoleCommand(InstallCommand::class, InstallCommand::class);
    }

    public function register(): void
    {
        $this->app->register(HorizonServiceProvider::class);
        $this->app->register(NotificationServiceProvider::class);
    }

    public function registerSchedule($schedule): void
    {
        $schedule->command('horizon:snapshot')->everyFiveMinutes();
    }

    public function registerPermissions(): array
    {
        return [
            'vdlp.horizon.access_dashboard' => [
                'tab' => 'Horizon',
                'label' => 'Access to the Horizon dashboard',
                'roles' => ['developer'],
            ],
        ];
    }

    public function registerNavigation(): array
    {
        /** @var Backend $backend */
        $backend = $this->app->make(Backend::class);

        return [
            'dashboard' => [
                'label' => 'Horizon',
                'url' => $backend->url('vdlp/horizon/dashboard'),
                'iconSvg' => '/plugins/vdlp/horizon/assets/icons/horizon.svg',
                'permissions' => ['vdlp.horizon.access_dashboard'],
                'order' => 500,
            ],
        ];
    }

    public function registerMailTemplates(): array
    {
        return [
            'vdlp.horizon::mail.long-wait-detected',
        ];
    }

    private function bootNotificationSettings(): void
    {
        if (config('vdlp.horizon::mail_notifications_enabled', false) === true) {
            Horizon::routeMailNotificationsTo(
                config('vdlp.horizon::mail_notifications_to')
            );
        }

        if (config('vdlp.horizon::slack_notifications_enabled', false) === true) {
            Horizon::routeSlackNotificationsTo(
                config('vdlp.horizon::slack_notifications_webhook_url'),
                config('vdlp.horizon::slack_notifications_channel')
            );
        }

        if (config('vdlp.horizon::sms_notifications_enabled', false) === true) {
            Horizon::routeSmsNotificationsTo(
                config('vdlp.horizon::sms_notifications_to')
            );
        }
    }
}