Skip to content
Open
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions app/Checks/AdminUserCheck.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?php

namespace App\Checks;

use App\Models\Role;
use App\Models\User;
use Spatie\Health\Checks\Check;
use Spatie\Health\Checks\Result;
use Throwable;

class AdminUserCheck extends Check
{
public function run(): Result
{
$result = Result::make()->meta([
'remediation' => trans('installer.health.admin.remediation'),
]);

try {
return User::role(Role::ROOT_ADMIN)->exists()
? $result->ok(trans('installer.health.admin.passed'))
: $result->failed(trans('installer.health.admin.failed'));
} catch (Throwable $exception) {
return $result->failed(trans('installer.health.admin.exception', [
'error' => $exception->getMessage(),
]));
}
}
}
32 changes: 32 additions & 0 deletions app/Checks/ApplicationKeyCheck.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<?php

namespace App\Checks;

use Illuminate\Encryption\Encrypter;
use Spatie\Health\Checks\Check;
use Spatie\Health\Checks\Result;

class ApplicationKeyCheck extends Check
{
public function run(): Result
{
$key = config('app.key');
$cipher = config('app.cipher', 'AES-256-CBC');

if (is_string($key) && str_starts_with($key, 'base64:')) {
$key = base64_decode(substr($key, 7), true);
}

$passed = is_string($key)
&& is_string($cipher)
&& Encrypter::supported($key, $cipher);

$result = Result::make()->meta([
'remediation' => trans('installer.health.app_key.remediation'),
]);

return $passed
? $result->ok(trans('installer.health.app_key.passed'))
: $result->failed(trans('installer.health.app_key.failed'));
}
}
49 changes: 49 additions & 0 deletions app/Checks/DatabaseExtensionCheck.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<?php

namespace App\Checks;

use App\Enums\DatabaseDriver;
use Spatie\Health\Checks\Check;
use Spatie\Health\Checks\Result;

class DatabaseExtensionCheck extends Check
{
protected DatabaseDriver|string $driver = DatabaseDriver::SQLite;

public function driver(DatabaseDriver|string $driver): self
{
$this->driver = $driver;

return $this;
}

public function run(): Result
{
$driver = is_string($this->driver) ? DatabaseDriver::tryFrom($this->driver) : $this->driver;

if ($driver === null) {
return Result::make()
->meta([
'driver' => $this->driver,
'remediation' => trans('installer.health.database_extension.unsupported_remediation'),
])
->failed(trans('installer.health.database_extension.unsupported', ['driver' => $this->driver]));
}

$extension = $driver->requiredExtension();
$passed = extension_loaded($extension);

$result = Result::make()->meta([
'driver' => $driver->value,
'extension' => $extension,
'remediation' => trans('installer.health.extensions.remediation'),
]);

return $passed
? $result->ok(trans('installer.health.database_extension.passed', ['extension' => $extension]))
: $result->failed(trans('installer.health.database_extension.failed', [
'driver' => $driver->getLabel(),
'extension' => $extension,
]));
}
}
20 changes: 20 additions & 0 deletions app/Checks/InstallationFlagCheck.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?php

namespace App\Checks;

use Spatie\Health\Checks\Check;
use Spatie\Health\Checks\Result;

class InstallationFlagCheck extends Check
{
public function run(): Result
{
$result = Result::make()->meta([
'remediation' => trans('installer.health.installed.remediation'),
]);

return config('app.installed')
? $result->ok(trans('installer.health.installed.passed'))
: $result->failed(trans('installer.health.installed.failed'));
}
}
37 changes: 37 additions & 0 deletions app/Checks/MigrationsCheck.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<?php

namespace App\Checks;

use Illuminate\Database\Migrations\Migrator;
use Spatie\Health\Checks\Check;
use Spatie\Health\Checks\Result;
use Throwable;

class MigrationsCheck extends Check
{
public function __construct(private readonly Migrator $migrator) {}

public function run(): Result
{
$result = Result::make()->meta([
'remediation' => trans('installer.health.migrations.remediation'),
]);

try {
if (!$this->migrator->repositoryExists()) {
return $result->failed(trans('installer.health.migrations.repository_missing'));
}

$files = $this->migrator->getMigrationFiles(database_path('migrations'));
$pending = array_diff(array_keys($files), $this->migrator->getRepository()->getRan());

return $pending === []
? $result->ok(trans('installer.health.migrations.passed'))
: $result->failed(trans('installer.health.migrations.failed', ['count' => count($pending)]));
} catch (Throwable $exception) {
return $result->failed(trans('installer.health.migrations.exception', [
'error' => $exception->getMessage(),
]));
}
}
}
63 changes: 63 additions & 0 deletions app/Checks/PhpExtensionsCheck.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<?php

namespace App\Checks;

use App\Enums\DatabaseDriver;
use Spatie\Health\Checks\Check;
use Spatie\Health\Checks\Result;

class PhpExtensionsCheck extends Check
{
public const REQUIRED_EXTENSIONS = [
'bcmath',
'curl',
'gd',
'intl',
'json',
'mbstring',
'pdo',
'xml',
'zip',
];

/** @var string[] */
protected array $requiredExtensions = self::REQUIRED_EXTENSIONS;

/** @param string[] $extensions */
public function requireExtensions(array $extensions): self
{
$this->requiredExtensions = $extensions;

return $this;
}

public function run(): Result
{
$missing = array_values(array_filter(
$this->requiredExtensions,
fn (string $extension) => !extension_loaded($extension),
));

$databaseExtensions = array_unique(array_map(
fn (DatabaseDriver $driver) => $driver->requiredExtension(),
DatabaseDriver::cases(),
));

$hasDatabaseExtension = array_filter($databaseExtensions, extension_loaded(...)) !== [];

if (!$hasDatabaseExtension) {
$missing[] = implode(', ', $databaseExtensions);
}

$result = Result::make()->meta([
'missing' => implode(', ', $missing),
'remediation' => trans('installer.health.extensions.remediation'),
]);

return $missing === []
? $result->ok(trans('installer.health.extensions.passed'))
: $result->failed(trans('installer.health.extensions.failed', [
'extensions' => implode(', ', $missing),
]));
}
}
52 changes: 52 additions & 0 deletions app/Checks/PhpVersionCheck.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?php

namespace App\Checks;

use Spatie\Health\Checks\Check;
use Spatie\Health\Checks\Result;

class PhpVersionCheck extends Check
{
public const MINIMUM_VERSION = '8.3.0';

protected string $minimumVersion = self::MINIMUM_VERSION;

protected string $currentVersion = PHP_VERSION;

public function minimumVersion(string $version): self
{
$this->minimumVersion = $version;

return $this;
}

public function currentVersion(string $version): self
{
$this->currentVersion = $version;

return $this;
}

public function run(): Result
{
$passed = version_compare($this->currentVersion, $this->minimumVersion, '>=');

$result = Result::make()
->meta([
'current' => $this->currentVersion,
'minimum' => $this->minimumVersion,
'remediation' => trans('installer.health.php.remediation', ['minimum' => $this->minimumVersion]),
])
->shortSummary($this->currentVersion);

return $passed
? $result->ok(trans('installer.health.php.passed', [
'current' => $this->currentVersion,
'minimum' => $this->minimumVersion,
]))
: $result->failed(trans('installer.health.php.failed', [
'current' => $this->currentVersion,
'minimum' => $this->minimumVersion,
]));
}
}
46 changes: 46 additions & 0 deletions app/Checks/WritablePathsCheck.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<?php

namespace App\Checks;

use Spatie\Health\Checks\Check;
use Spatie\Health\Checks\Result;

class WritablePathsCheck extends Check
{
/** @var string[]|null */
protected ?array $paths = null;

/** @param string[] $paths */
public function paths(array $paths): self
{
$this->paths = $paths;

return $this;
}

public function run(): Result
{
$paths = $this->paths ?? [
storage_path(),
base_path('bootstrap/cache'),
file_exists(base_path('.env')) ? base_path('.env') : base_path(),
];

$notWritable = array_values(array_filter(
$paths,
fn (string $path) => !is_writable($path),
));

$result = Result::make()->meta([
'paths' => implode(', ', $paths),
'not_writable' => implode(', ', $notWritable),
'remediation' => trans('installer.health.paths.remediation'),
]);

return $notWritable === []
? $result->ok(trans('installer.health.paths.passed'))
: $result->failed(trans('installer.health.paths.failed', [
'paths' => implode(', ', $notWritable),
]));
}
}
22 changes: 20 additions & 2 deletions app/Console/Commands/Environment/AppSettingsCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,32 @@

namespace App\Console\Commands\Environment;

use App\Services\Environment\InstallationHealthService;
use App\Traits\Commands\DisplaysHealthResults;
use Illuminate\Console\Command;

class AppSettingsCommand extends Command
{
use DisplaysHealthResults;

protected $description = 'Configure basic environment settings for the Panel.';

protected $signature = 'p:environment:setup';
protected $signature = 'p:environment:setup
{--skip-preflight : Skip server requirement checks before setup.}';

public function handle(): void
public function handle(InstallationHealthService $health): int
{
if (!$this->option('skip-preflight')) {
$results = $health->systemRequirements();
$this->displayHealthResults($results);

if ($health->hasFailures($results)) {
$this->error(trans('commands.environment_check.preflight_failed'));

return self::FAILURE;
}
}

$path = base_path('.env');
if (!file_exists($path)) {
$this->comment('Copying example .env file');
Expand All @@ -28,5 +44,7 @@ public function handle(): void

$this->comment('Caching components & icons');
$this->call('filament:optimize');

return self::SUCCESS;
}
}
Loading
Loading