Fix start and upgrade commands

2026-01-06 22:21:42 +00:00 · 2023-04-16 07:33:12 +02:00
parent 05e307136c
commit e6a84ab387
19 changed files with 391 additions and 274 deletions
--- a/app/Console/Commands/System/UpgradeFireflyInstructions.php
+++ b/app/Console/Commands/System/UpgradeFireflyInstructions.php
@@ -0,0 +1,172 @@
+<?php
+/*
+ * UpgradeFireflyInstructions.php
+ * Copyright (c) 2023 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/>.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\Console\Commands\System;
+
+use FireflyIII\Support\System\GeneratesInstallationId;
+use Illuminate\Console\Command;
+
+use function FireflyIII\Console\Commands\str_starts_with;
+
+/**
+ * Class UpgradeFireflyInstructions.
+ *
+
+ */
+class UpgradeFireflyInstructions extends Command
+{
+    use GeneratesInstallationId;
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Instructions in case of upgrade trouble.';
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'firefly:instructions {task}';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(): int
+    {
+        $this->generateInstallationId();
+        if ('update' === (string)$this->argument('task')) {
+            $this->updateInstructions();
+        }
+        if ('install' === (string)$this->argument('task')) {
+            $this->installInstructions();
+        }
+
+        return 0;
+    }
+
+    /**
+     * Render upgrade instructions.
+     */
+    private function updateInstructions(): void
+    {
+        /** @var string $version */
+        $version = config('firefly.version');
+        $config  = config('upgrade.text.upgrade');
+        $text    = '';
+        foreach (array_keys($config) as $compare) {
+            // if string starts with:
+            if (str_starts_with($version, $compare)) {
+                $text = $config[$compare];
+            }
+        }
+
+        $this->showLine();
+        $this->boxed('');
+        if (null === $text) {
+            $this->boxed(sprintf('Thank you for updating to Firefly III, v%s', $version));
+            $this->boxedInfo('There are no extra upgrade instructions.');
+            $this->boxed('Firefly III should be ready for use.');
+            $this->boxed('');
+            $this->showLine();
+
+            return;
+        }
+
+        $this->boxed(sprintf('Thank you for updating to Firefly III, v%s!', $version));
+        $this->boxedInfo($text);
+        $this->boxed('');
+        $this->showLine();
+    }
+
+    /**
+     * Show a line.
+     */
+    private function showLine(): void
+    {
+        $line = '+';
+        $line .= str_repeat('-', 78);
+        $line .= '+';
+        $this->line($line);
+    }
+
+    /**
+     * Show a nice box.
+     *
+     * @param  string  $text
+     */
+    private function boxed(string $text): void
+    {
+        $parts = explode("\n", wordwrap($text));
+        foreach ($parts as $string) {
+            $this->line('| '.sprintf('%-77s', $string).'|');
+        }
+    }
+
+    /**
+     * Show a nice info box.
+     *
+     * @param  string  $text
+     */
+    private function boxedInfo(string $text): void
+    {
+        $parts = explode("\n", wordwrap($text));
+        foreach ($parts as $string) {
+            $this->info('| '.sprintf('%-77s', $string).'|');
+        }
+    }
+
+    /**
+     * Render instructions.
+     */
+    private function installInstructions(): void
+    {
+        /** @var string $version */
+        $version = config('firefly.version');
+        $config  = config('upgrade.text.install');
+        $text    = '';
+        foreach (array_keys($config) as $compare) {
+            // if string starts with:
+            if (str_starts_with($version, $compare)) {
+                $text = $config[$compare];
+            }
+        }
+        $this->showLine();
+        $this->boxed('');
+        if (null === $text) {
+            $this->boxed(sprintf('Thank you for installing Firefly III, v%s!', $version));
+            $this->boxedInfo('There are no extra installation instructions.');
+            $this->boxed('Firefly III should be ready for use.');
+            $this->boxed('');
+            $this->showLine();
+
+            return;
+        }
+
+        $this->boxed(sprintf('Thank you for installing Firefly III, v%s!', $version));
+        $this->boxedInfo($text);
+        $this->boxed('');
+        $this->showLine();
+    }
+}