firefly-iii/app/Console/Commands/Correction/FixIbans.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\Models\Account;
use FireflyIII\Models\AccountType;
use Illuminate\Console\Command;
use Illuminate\Support\Collection;

/**
 * Class FixIbans
 */
class FixIbans extends Command
{
    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Removes spaces from IBANs';
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'firefly-iii:fix-ibans';

    /**
     * Execute the console command.
     *
     * @return int
     */
    public function handle(): int
    {
        $accounts = Account::whereNotNull('iban')->get();
        $this->filterIbans($accounts);
        $this->countAndCorrectIbans($accounts);

        return 0;
    }

    /**
     * @param  Collection  $accounts
     *
     * @return void
     */
    private function countAndCorrectIbans(Collection $accounts): void
    {
        $set = [];
        /** @var Account $account */
        foreach ($accounts as $account) {
            $userId       = (int)$account->user_id;
            $set[$userId] = $set[$userId] ?? [];
            $iban         = (string)$account->iban;
            if ('' === $iban) {
                continue;
            }
            $type = $account->accountType->type;
            if (in_array($type, [AccountType::LOAN, AccountType::DEBT, AccountType::MORTGAGE], true)) {
                $type = 'liabilities';
            }
            if (array_key_exists($iban, $set[$userId])) {
                // iban already in use! two exceptions exist:
                if (
                    !(AccountType::EXPENSE === $set[$userId][$iban] && AccountType::REVENUE === $type)
                    && // allowed combination
                    !(AccountType::REVENUE === $set[$userId][$iban] && AccountType::EXPENSE === $type) // also allowed combination.
                ) {
                    $this->line(
                        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();
                }
            }

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

    /**
     * @param  Collection  $accounts
     *
     * @return void
     */
    private function filterIbans(Collection $accounts): void
    {
        /** @var Account $account */
        foreach ($accounts as $account) {
            $iban = $account->iban;
            if (str_contains($iban, ' ')) {
                $iban = app('steam')->filterSpaces((string)$account->iban);
                if ('' !== $iban) {
                    $account->iban = $iban;
                    $account->save();
                    $this->line(sprintf('Removed spaces from IBAN of account #%d', $account->id));
                }
            }
        }
    }
}