firefly-iii/app/Console/Commands/Correction/CorrectsIbans.php

<?php

/*
 * FixIbans.php
 * Copyright (c) 2022 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\AccountTypeEnum;
use FireflyIII\Models\Account;
use FireflyIII\Support\Facades\Steam;
use Illuminate\Console\Command;
use Illuminate\Support\Collection;

class CorrectsIbans extends Command
{
    use ShowsFriendlyMessages;

    protected $description = 'Removes spaces from IBANs';
    protected $signature   = 'correction:ibans';
    private int $count     = 0;

    /**
     * Execute the console command.
     */
    public function handle(): int
    {
        $accounts = Account::query()->with('accountMeta')->get();
        $this->filterIbans($accounts);
        $this->countAndCorrectIbans($accounts);

        return 0;
    }

    private function countAndCorrectIbans(Collection $accounts): void
    {
        $set = [];

        /** @var Account $account */
        foreach ($accounts as $account) {
            $userId                = $account->user_id;
            $set[$userId] ??= [];
            $iban                  = (string) $account->iban;
            if ('' === $iban) {
                continue;
            }
            $type                  = $account->accountType->type;
            if (in_array($type, [AccountTypeEnum::LOAN->value, AccountTypeEnum::DEBT->value, AccountTypeEnum::MORTGAGE->value], true)) {
                $type = 'liabilities';
            }
            $showWarningAndCorrect = false;
            if (array_key_exists($iban, $set[$userId])) {
                // the type is a revenue account, and the existing IBAN is NOT an expense account.
                if (AccountTypeEnum::REVENUE->value === $type && AccountTypeEnum::EXPENSE->value !== $set[$userId][$iban]) {
                    $showWarningAndCorrect = true;
                }
                // the type is an expense account, and the existing IBAN is NOT a revenue account
                if (AccountTypeEnum::EXPENSE->value === $type && AccountTypeEnum::REVENUE->value !== $set[$userId][$iban]) {
                    $showWarningAndCorrect = true;
                }
            }
            if ($showWarningAndCorrect) {
                $this->friendlyWarning(sprintf(
                    'IBAN "%s" is used more than once and will be removed from %s #%d ("%s")',
                    $iban,
                    $account->accountType->type,
                    $account->id,
                    $account->name
                ));
                $account->iban = null;
                $account->save();
                ++$this->count;
            }

            if (!array_key_exists($iban, $set[$userId])) {
                $set[$userId][$iban] = $type;
            }
        }
    }

    private function filterIbans(Collection $accounts): void
    {
        /** @var Account $account */
        foreach ($accounts as $account) {
            $iban          = (string) $account->iban;
            $newIban       = Steam::filterSpaces($iban);
            if ('' !== $iban && $iban !== $newIban) {
                $account->iban = $newIban;
                $account->save();
                $this->friendlyInfo(sprintf('Removed spaces from IBAN of account #%d', $account->id));
                ++$this->count;
            }
            // same for account number:
            $accountNumber = $account->accountMeta->where('name', 'account_number')->first();
            if (null !== $accountNumber) {
                $number    = (string) $accountNumber->value;
                $newNumber = Steam::filterSpaces($number);
                if ('' !== $number && $number !== $newNumber) {
                    $accountNumber->value = $newNumber;
                    $accountNumber->save();
                    $this->friendlyInfo(sprintf('Removed spaces from account number of account #%d', $account->id));
                    ++$this->count;
                }
            }
        }
    }
}