Refactor and renam commands.

app/Console/Commands/Correction/ConvertsDatesToUTC.php

@@ -0,0 +1,130 @@
+<?php
+/*
+ * ConvertsDatesToUTC.php
+ * Copyright (c) 2024 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);
+/*
+ * ConvertDatesToUTC.php
+ * Copyright (c) 2024 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\Correction;
+
+use Carbon\Carbon;
+use FireflyIII\Console\Commands\ShowsFriendlyMessages;
+use FireflyIII\Support\Facades\FireflyConfig;
+use Illuminate\Console\Command;
+use Illuminate\Database\QueryException;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Log;
+
+class ConvertDatesToUTC extends Command
+{
+    use ShowsFriendlyMessages;
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Convert stored dates to UTC.';
+
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature   = 'firefly-iii:migrate-to-utc';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(): int
+    {
+        $this->friendlyWarning('Please do not use this command.');
+        return 0;
+        /**
+         * @var string $model
+         * @var array  $fields
+         */
+        foreach (AddTimezonesToDates::$models as $model => $fields) {
+            $this->ConvertModeltoUTC($model, $fields);
+        }
+        // tell the system we are now in UTC mode.
+        FireflyConfig::set('utc', true);
+
+        return Command::SUCCESS;
+    }
+
+    private function ConvertModeltoUTC(string $model, array $fields): void
+    {
+        /** @var string $field */
+        foreach ($fields as $field) {
+            $this->convertFieldtoUTC($model, $field);
+        }
+    }
+
+    private function convertFieldtoUTC(string $model, string $field): void
+    {
+        $this->info(sprintf('Converting %s.%s to UTC', $model, $field));
+        $shortModel    = str_replace('FireflyIII\Models\\', '', $model);
+        $timezoneField = sprintf('%s_tz', $field);
+        $items         = new Collection();
+        $timeZone      = config('app.timezone');
+
+        try {
+            $items = $model::where($timezoneField, $timeZone)->get();
+        } catch (QueryException $e) {
+            $this->friendlyError(sprintf('Cannot find timezone information to field "%s" of model "%s". Field does not exist.', $field, $shortModel));
+            Log::error($e->getMessage());
+        }
+        if (0 === $items->count()) {
+            $this->friendlyPositive(sprintf('All timezone information is UTC in field "%s" of model "%s".', $field, $shortModel));
+
+            return;
+        }
+        $this->friendlyInfo(sprintf('Converting field "%s" of model "%s" to UTC.', $field, $shortModel));
+        $items->each(
+            function ($item) use ($field, $timezoneField): void {
+                /** @var Carbon $date */
+                $date                   = Carbon::parse($item->{$field}, $item->{$timezoneField});
+                $date->setTimezone('UTC');
+                $item->{$field}         = $date->format('Y-m-d H:i:s');
+                $item->{$timezoneField} = 'UTC';
+                $item->save();
+            }
+        );
+    }
+}

app/Console/Commands/Correction/CorrectDatabase.php

@@ -34,7 +34,7 @@ class CorrectDatabase extends Command
 {
     use ShowsFriendlyMessages;
 
-    protected $description = 'Will correct the integrity of your database, if necessary.';
+    protected $description = 'Will validate and correct the integrity of your database, if necessary.';
     protected $signature   = 'firefly-iii:correct-database';
 
     /**
@@ -49,6 +49,14 @@ class CorrectDatabase extends Command
             return 1;
         }
         $commands = [
+
+            // also just in case, some integrity commands:
+            //            'upgrade:restore-oauth-keys',
+            //            'upgrade:add-timezones-to-dates',
+            //            'upgrade:create-group-memberships',
+            //            'upgrade:upgrade-group-information',
+            //            'upgrade:610-currency-preferences',
+            //            'upgrade:620-piggy-banks',
             'firefly-iii:fix-piggies',
             'firefly-iii:create-link-types',
             'firefly-iii:create-access-tokens',

app/Console/Commands/Correction/CorrectsGroupInformation.php

@@ -0,0 +1,121 @@
+<?php
+
+/*
+ * CorrectsGroupInformation.php
+ * Copyright (c) 2024 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\Correction;
+
+use FireflyIII\Console\Commands\ShowsFriendlyMessages;
+use FireflyIII\Models\Account;
+use FireflyIII\Models\Attachment;
+use FireflyIII\Models\AvailableBudget;
+use FireflyIII\Models\Bill;
+use FireflyIII\Models\Budget;
+use FireflyIII\Models\Category;
+use FireflyIII\Models\CurrencyExchangeRate;
+use FireflyIII\Models\ObjectGroup;
+use FireflyIII\Models\Recurrence;
+use FireflyIII\Models\Rule;
+use FireflyIII\Models\RuleGroup;
+use FireflyIII\Models\Tag;
+use FireflyIII\Models\TransactionGroup;
+use FireflyIII\Models\TransactionJournal;
+use FireflyIII\Models\UserGroup;
+use FireflyIII\Models\Webhook;
+use FireflyIII\User;
+use Illuminate\Console\Command;
+use Illuminate\Database\QueryException;
+
+/**
+ * Class UpdateGroupInformation
+ */
+class UpdateGroupInformation extends Command
+{
+    use ShowsFriendlyMessages;
+
+    protected $description = 'Makes sure that every object is linked to a group';
+    protected $signature   = 'firefly-iii:upgrade-group-information';
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle()
+    {
+        // objects: accounts, attachments, available budgets, bills, budgets, categories, currency_exchange_rates
+        // recurrences, rule groups, rules, tags, transaction groups, transaction journals, webhooks
+
+        $users = User::get();
+
+        /** @var User $user */
+        foreach ($users as $user) {
+            $this->updateGroupInfo($user);
+        }
+
+        return 0;
+    }
+
+    private function updateGroupInfo(User $user): void
+    {
+        $group = $user->userGroup;
+        if (null === $group) {
+            $this->friendlyWarning(sprintf('User "%s" has no group. Please run "php artisan firefly-iii:create-group-memberships"', $user->email));
+
+            return;
+        }
+        $set   = [
+            Account::class,
+            Attachment::class,
+            AvailableBudget::class,
+            Bill::class,
+            Budget::class,
+            Category::class,
+            ObjectGroup::class,
+            CurrencyExchangeRate::class,
+            Recurrence::class,
+            RuleGroup::class,
+            Rule::class,
+            Tag::class,
+            TransactionGroup::class,
+            TransactionJournal::class,
+            Webhook::class,
+        ];
+        foreach ($set as $className) {
+            $this->updateGroupInfoForObject($user, $group, $className);
+        }
+    }
+
+    private function updateGroupInfoForObject(User $user, UserGroup $group, string $className): void
+    {
+        try {
+            $result = $className::where('user_id', $user->id)->where('user_group_id', null)->update(['user_group_id' => $group->id]);
+        } catch (QueryException $e) {
+            $this->friendlyError(sprintf('Could not update group information for "%s" because of error "%s"', $className, $e->getMessage()));
+
+            return;
+        }
+        if (0 !== $result) {
+            $this->friendlyPositive(sprintf('User #%d: Moved %d %s objects to the correct group.', $user->id, $result, str_replace('FireflyIII\Models\\', '', $className)));
+        }
+    }
+}

app/Console/Commands/Correction/CorrectsTimezoneInformation.php

@@ -0,0 +1,137 @@
+<?php
+/*
+ * CorrectsTimezoneInformation.php
+ * Copyright (c) 2024 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);
+/*
+ * AddTimezonesToDates.php
+ * Copyright (c) 2024 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\Correction;
+
+use FireflyIII\Console\Commands\ShowsFriendlyMessages;
+use FireflyIII\Models\AccountBalance;
+use FireflyIII\Models\AvailableBudget;
+use FireflyIII\Models\Bill;
+use FireflyIII\Models\BudgetLimit;
+use FireflyIII\Models\CurrencyExchangeRate;
+use FireflyIII\Models\InvitedUser;
+use FireflyIII\Models\PiggyBank;
+use FireflyIII\Models\PiggyBankEvent;
+use FireflyIII\Models\PiggyBankRepetition;
+use FireflyIII\Models\Recurrence;
+use FireflyIII\Models\Tag;
+use FireflyIII\Models\TransactionJournal;
+use FireflyIII\Support\Facades\FireflyConfig;
+use Illuminate\Console\Command;
+use Illuminate\Database\QueryException;
+use Illuminate\Support\Facades\Log;
+
+class AddTimezonesToDates extends Command
+{
+    use ShowsFriendlyMessages;
+
+    public static array $models
+                           = [
+            AccountBalance::class       => ['date'], // done
+            AvailableBudget::class      => ['start_date', 'end_date'], // done
+            Bill::class                 => ['date', 'end_date', 'extension_date'], // done
+            BudgetLimit::class          => ['start_date', 'end_date'], // done
+            CurrencyExchangeRate::class => ['date'], // done
+            InvitedUser::class          => ['expires'],
+            PiggyBankEvent::class       => ['date'],
+            PiggyBankRepetition::class  => ['start_date', 'target_date'],
+            PiggyBank::class            => ['start_date', 'target_date'], // done
+            Recurrence::class           => ['first_date', 'repeat_until', 'latest_date'],
+            Tag::class                  => ['date'],
+            TransactionJournal::class   => ['date'],
+        ];
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Make sure all dates have a timezone.';
+
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature   = 'firefly-iii:add-timezones-to-dates';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(): void
+    {
+        foreach (self::$models as $model => $fields) {
+            $this->addTimezoneToModel($model, $fields);
+        }
+        // not yet in UTC mode
+        FireflyConfig::set('utc', false);
+    }
+
+    private function addTimezoneToModel(string $model, array $fields): void
+    {
+        foreach ($fields as $field) {
+            $this->addTimezoneToModelField($model, $field);
+        }
+    }
+
+    private function addTimezoneToModelField(string $model, string $field): void
+    {
+        $shortModel    = str_replace('FireflyIII\Models\\', '', $model);
+        $timezoneField = sprintf('%s_tz', $field);
+        $count         = 0;
+
+        try {
+            $count = $model::whereNull($timezoneField)->count();
+        } catch (QueryException $e) {
+            $this->friendlyError(sprintf('Cannot add timezone information to field "%s" of model "%s". Field does not exist.', $field, $shortModel));
+            Log::error($e->getMessage());
+        }
+        if (0 === $count) {
+            $this->friendlyPositive(sprintf('Timezone information is present in field "%s" of model "%s".', $field, $shortModel));
+
+            return;
+        }
+        $this->friendlyInfo(sprintf('Adding timezone information to field "%s" of model "%s".', $field, $shortModel));
+
+        $model::whereNull($timezoneField)->update([$timezoneField => config('app.timezone')]);
+    }
+}

app/Console/Commands/Correction/CreatesGroupMemberships.php

@@ -0,0 +1,109 @@
+<?php
+
+/*
+ * CreatesGroupMemberships.php
+ * Copyright (c) 2024 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\Correction;
+
+use FireflyIII\Console\Commands\ShowsFriendlyMessages;
+use FireflyIII\Enums\UserRoleEnum;
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Models\GroupMembership;
+use FireflyIII\Models\UserGroup;
+use FireflyIII\Models\UserRole;
+use FireflyIII\User;
+use Illuminate\Console\Command;
+
+/**
+ * Class CreateGroupMemberships
+ */
+class CreateGroupMemberships extends Command
+{
+    use ShowsFriendlyMessages;
+
+    public const string CONFIG_NAME = '560_create_group_memberships';
+    protected $description          = 'Update group memberships';
+    protected $signature            = 'firefly-iii:create-group-memberships';
+
+    /**
+     * Execute the console command.
+     *
+     * @throws FireflyException
+     */
+    public function handle(): int
+    {
+        $this->createGroupMemberships();
+        $this->friendlyPositive('Validated group memberships');
+
+        return 0;
+    }
+
+    /**
+     * @throws FireflyException
+     */
+    private function createGroupMemberships(): void
+    {
+        $users = User::get();
+
+        /** @var User $user */
+        foreach ($users as $user) {
+            self::createGroupMembership($user);
+        }
+    }
+
+    /**
+     * TODO move to helper.
+     *
+     * @throws FireflyException
+     */
+    public static function createGroupMembership(User $user): void
+    {
+        // check if membership exists
+        $userGroup  = UserGroup::where('title', $user->email)->first();
+        if (null === $userGroup) {
+            $userGroup = UserGroup::create(['title' => $user->email]);
+        }
+
+        $userRole   = UserRole::where('title', UserRoleEnum::OWNER->value)->first();
+
+        if (null === $userRole) {
+            throw new FireflyException('Firefly III could not find a user role. Please make sure all migrations have run.');
+        }
+        $membership = GroupMembership::where('user_id', $user->id)
+            ->where('user_group_id', $userGroup->id)
+            ->where('user_role_id', $userRole->id)->first()
+        ;
+        if (null === $membership) {
+            GroupMembership::create(
+                [
+                    'user_id'       => $user->id,
+                    'user_role_id'  => $userRole->id,
+                    'user_group_id' => $userGroup->id,
+                ]
+            );
+        }
+        if (null === $user->user_group_id) {
+            $user->user_group_id = $userGroup->id;
+            $user->save();
+        }
+    }
+}

app/Console/Commands/Correction/RestoresOAuthKeys.php

@@ -0,0 +1,106 @@
+<?php
+
+/*
+ * RestoresOAuthKeys.php
+ * Copyright (c) 2024 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\Correction;
+
+use FireflyIII\Console\Commands\ShowsFriendlyMessages;
+use FireflyIII\Support\System\OAuthKeys;
+use Illuminate\Console\Command;
+
+/**
+ * Class RestoreOAuthKeys
+ */
+class RestoreOAuthKeys extends Command
+{
+    use ShowsFriendlyMessages;
+
+    protected $description = 'Will restore the OAuth keys generated for the system.';
+    protected $signature   = 'firefly-iii:restore-oauth-keys';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(): int
+    {
+        $this->restoreOAuthKeys();
+
+        return 0;
+    }
+
+    private function restoreOAuthKeys(): void
+    {
+        if (!$this->keysInDatabase() && !$this->keysOnDrive()) {
+            $this->generateKeys();
+            $this->storeKeysInDB();
+            $this->friendlyInfo('Generated and stored new keys.');
+
+            return;
+        }
+        if ($this->keysInDatabase() && !$this->keysOnDrive()) {
+            $result = $this->restoreKeysFromDB();
+            if (true === $result) {
+                $this->friendlyInfo('Restored OAuth keys from database.');
+
+                return;
+            }
+            $this->generateKeys();
+            $this->storeKeysInDB();
+            $this->friendlyInfo('Generated and stored new keys.');
+
+            return;
+        }
+        if (!$this->keysInDatabase() && $this->keysOnDrive()) {
+            $this->storeKeysInDB();
+            $this->friendlyInfo('Stored OAuth keys in database.');
+
+            return;
+        }
+        $this->friendlyPositive('OAuth keys are OK');
+    }
+
+    private function keysInDatabase(): bool
+    {
+        return OAuthKeys::keysInDatabase();
+    }
+
+    private function keysOnDrive(): bool
+    {
+        return OAuthKeys::hasKeyFiles();
+    }
+
+    private function generateKeys(): void
+    {
+        OAuthKeys::generateKeys();
+    }
+
+    private function storeKeysInDB(): void
+    {
+        OAuthKeys::storeKeysInDB();
+    }
+
+    private function restoreKeysFromDB(): bool
+    {
+        return OAuthKeys::restoreKeysFromDB();
+    }
+}