Merge pull request #9944 from firefly-iii/add-validation-command

Add command to validate various settings.
2025-09-18 18:44:16 +00:00 · 2025-03-08 05:50:47 +01:00
parent 775282ae02 7dede49aee
commit 605623a7af
1 changed files with 93 additions and 0 deletions
--- a/app/Console/Commands/Integrity/ValidatesEnvironmentVariables.php
+++ b/app/Console/Commands/Integrity/ValidatesEnvironmentVariables.php
@@ -0,0 +1,93 @@
+<?php
+/*
+ * ValidatesEnvironmentVariables.php
+ * Copyright (c) 2025 james@firefly-iii.org.
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see https://www.gnu.org/licenses/.
+ */
+
+namespace FireflyIII\Console\Commands\Integrity;
+
+use FireflyIII\Console\Commands\ShowsFriendlyMessages;
+use Illuminate\Console\Command;
+
+class ValidatesEnvironmentVariables extends Command
+{
+    use ShowsFriendlyMessages;
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'integrity:validates-environment-variables';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Makes sure you use the correct variables.';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(): int
+    {
+        $this->validateLanguage();
+        $this->validateGuard();
+        $this->validateStaticToken();
+        return Command::SUCCESS;
+    }
+
+    private function validateLanguage(): void
+    {
+        $language = env('DEFAULT_LANGUAGE', 'en_US');
+        $locale = env('DEFAULT_LOCALE', 'equal');
+        $options  = array_keys(config('firefly.languages'));
+        if (!in_array($language, $options)) {
+            $this->friendlyError(sprintf('DEFAULT_LANGUAGE "%s" is not a valid language for Firefly III.', $language));
+            $this->friendlyError('Please check your .env file and make sure you use a valid setting.');
+            $this->friendlyError(sprintf('Valid languages are: %s', implode(', ', $options)));
+            exit(1);
+        }
+        $options[] = 'equal';
+        if (!in_array($locale, $options)) {
+            $this->friendlyError(sprintf('DEFAULT_LOCALE "%s" is not a valid local for Firefly III.', $locale));
+            $this->friendlyError('Please check your .env file and make sure you use a valid setting.');
+            $this->friendlyError(sprintf('Valid locales are: %s', implode(', ', $options)));
+            exit(1);
+        }
+    }
+
+    private function validateGuard(): void {
+        $guard = env('AUTHENTICATION_GUARD','web');
+        if('web' !== $guard && 'remote_user_guard' !== $guard) {
+            $this->friendlyError(sprintf('AUTHENTICATION_GUARD "%s" is not a valid guard for Firefly III.', $guard));
+            $this->friendlyError('Please check your .env file and make sure you use a valid setting.');
+            $this->friendlyError('Valid guards are: web, remote_user_guard');
+            exit(1);
+        }
+    }
+
+    private function validateStaticToken(): void {
+        $token = (string) env('STATIC_CRON_TOKEN','');
+        if(0 !== strlen($token) && 32 !== strlen($token)) {
+            $this->friendlyError('STATIC_CRON_TOKEN must be empty or a 32-character string.');
+            $this->friendlyError('Please check your .env file and make sure you use a valid setting.');
+            exit(1);
+        }
+    }
+}