firefly-iii/app/Rules/UniqueIban.php

<?php
/**
 * UniqueIban.php
 * Copyright (c) 2019 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\Rules;

use Closure;
use FireflyIII\Models\Account;
use FireflyIII\Models\AccountType;
use Illuminate\Contracts\Validation\ValidationRule;
use Illuminate\Support\Facades\Log;

/**
 * Class UniqueIban
 */
class UniqueIban implements ValidationRule
{
    private ?Account $account;
    private array    $expectedTypes;

    /**
     * Create a new rule instance.
     *
     *
     * @param  Account|null  $account
     * @param  string|null  $expectedType
     */
    public function __construct(?Account $account, ?string $expectedType)
    {
        $this->account       = $account;
        $this->expectedTypes = [];
        if (null === $expectedType) {
            return;
        }
        $this->expectedTypes = [$expectedType];
        // a very basic fix to make sure we get the correct account type:
        if ('expense' === $expectedType) {
            $this->expectedTypes = [AccountType::EXPENSE];
        }
        if ('revenue' === $expectedType) {
            $this->expectedTypes = [AccountType::REVENUE];
        }
        if ('asset' === $expectedType) {
            $this->expectedTypes = [AccountType::ASSET];
        }
        if ('liabilities' === $expectedType) {
            $this->expectedTypes = [AccountType::LOAN, AccountType::DEBT, AccountType::MORTGAGE];
        }
    }

    /**
     * Get the validation error message.
     *
     *
     * @return string
     */
    public function message(): string
    {
        return (string)trans('validation.unique_iban_for_user');
    }

    /**
     * Determine if the validation rule passes.
     *
     * @param  string  $attribute
     * @param  mixed  $value
     *
     * @return bool
     *
     */
    public function passes($attribute, $value): bool
    {
        if (!auth()->check()) {
            return true;
        }
        if (0 === count($this->expectedTypes)) {
            return true;
        }
        $maxCounts = $this->getMaxOccurrences();

        foreach ($maxCounts as $type => $max) {
            $count = $this->countHits($type, $value);
            Log::debug(sprintf('Count for "%s" and IBAN "%s" is %d', $type, $value, $count));
            if ($count > $max) {
                Log::debug(
                    sprintf(
                        'IBAN "%s" is in use with %d account(s) of type "%s", which is too much for expected types "%s"',
                        $value,
                        $count,
                        $type,
                        join(', ', $this->expectedTypes)
                    )
                );

                return false;
            }
        }

        return true;
    }

    /**
     * @inheritDoc
     */
    public function validate(string $attribute, mixed $value, Closure $fail): void
    {
        if (!$this->passes($attribute, $value)) {
            $fail((string)trans('validation.unique_iban_for_user'));
        }
    }

    /**
     * @param  string  $type
     * @param  string  $iban
     *
     * @return int
     */
    private function countHits(string $type, string $iban): int
    {
        $typesArray = [$type];
        if ('liabilities' === $type) {
            $typesArray = [AccountType::LOAN, AccountType::DEBT, AccountType::MORTGAGE];
        }
        $query
            = auth()->user()
                    ->accounts()
                    ->leftJoin('account_types', 'account_types.id', '=', 'accounts.account_type_id')
                    ->where('accounts.iban', $iban)
                    ->whereIn('account_types.type', $typesArray);

        if (null !== $this->account) {
            $query->where('accounts.id', '!=', $this->account->id);
        }

        return $query->count();
    }

    /**
     * @return array
     *
     */
    private function getMaxOccurrences(): array
    {
        $maxCounts = [
            AccountType::ASSET   => 0,
            AccountType::EXPENSE => 0,
            AccountType::REVENUE => 0,
            'liabilities'        => 0,
        ];

        if (in_array('expense', $this->expectedTypes, true) || in_array(AccountType::EXPENSE, $this->expectedTypes, true)) {
            // IBAN should be unique amongst expense and asset accounts.
            // may appear once in revenue accounts
            $maxCounts[AccountType::REVENUE] = 1;
        }
        if (in_array('revenue', $this->expectedTypes, true) || in_array(AccountType::REVENUE, $this->expectedTypes, true)) {
            // IBAN should be unique amongst revenue and asset accounts.
            // may appear once in expense accounts
            $maxCounts[AccountType::EXPENSE] = 1;
        }

        return $maxCounts;
    }
}