. */ declare(strict_types=1); namespace FireflyIII\Rules; use FireflyIII\Models\Account; use FireflyIII\Models\AccountMeta; use FireflyIII\Models\AccountType; use Illuminate\Contracts\Validation\Rule; use Log; /** * Class UniqueAccountNumber */ class UniqueAccountNumber implements Rule { private ?Account $account; private ?string $expectedType; /** * Create a new rule instance. * * @codeCoverageIgnore * * @param Account|null $account * @param string|null $expectedType */ public function __construct(?Account $account, ?string $expectedType) { Log::debug('Constructed UniqueAccountNumber'); $this->account = $account; $this->expectedType = $expectedType; // a very basic fix to make sure we get the correct account type: if ('expense' === $expectedType) { $this->expectedType = AccountType::EXPENSE; } if ('revenue' === $expectedType) { $this->expectedType = AccountType::REVENUE; } if ('asset' === $expectedType) { $this->expectedType = AccountType::ASSET; } Log::debug(sprintf('Expected type is "%s"', $this->expectedType)); } /** * Get the validation error message. * * @codeCoverageIgnore * * @return string */ public function message(): string { return (string)trans('validation.unique_account_number_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 (null === $this->expectedType) { return true; } $maxCounts = $this->getMaxOccurrences(); foreach ($maxCounts as $type => $max) { $count = $this->countHits($type, $value); Log::debug(sprintf('Count for "%s" and account number "%s" is %d', $type, $value, $count)); if ($count > $max) { Log::debug( sprintf( 'account number "%s" is in use with %d account(s) of type "%s", which is too much for expected type "%s"', $value, $count, $type, $this->expectedType ) ); return false; } } Log::debug('Account number is valid.'); return true; } /** * @return array * */ private function getMaxOccurrences(): array { $maxCounts = [ AccountType::ASSET => 0, AccountType::EXPENSE => 0, AccountType::REVENUE => 0, ]; if ('expense' === $this->expectedType || AccountType::EXPENSE === $this->expectedType) { // IBAN should be unique amongst expense and asset accounts. // may appear once in revenue accounts $maxCounts[AccountType::REVENUE] = 1; } if ('revenue' === $this->expectedType || AccountType::REVENUE === $this->expectedType) { // IBAN should be unique amongst revenue and asset accounts. // may appear once in expense accounts $maxCounts[AccountType::EXPENSE] = 1; } return $maxCounts; } /** * @param string $type * @param string $accountNumber * * @return int */ private function countHits(string $type, string $accountNumber): int { $query = AccountMeta ::leftJoin('accounts', 'accounts.id', '=', 'account_meta.account_id') ->leftJoin('account_types', 'account_types.id', '=', 'accounts.account_type_id') ->where('accounts.user_id', auth()->user()->id) ->where('account_types.type', $type) ->where('account_meta.name', '=', 'account_number') ->where('account_meta.data', json_encode($accountNumber)); if (null !== $this->account) { $query->where('accounts.id', '!=', $this->account->id); } return $query->count(); } }