firefly-iii/app/Rules/UniqueAccountNumber.php

167 lines
5.0 KiB
PHP
Raw Normal View History

2021-01-26 12:27:49 -06:00
<?php
/**
* UniqueAccountNumber.php
* Copyright (c) 2021 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 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;
2021-03-21 03:15:40 -05:00
private ?string $expectedType;
2021-01-26 12:27:49 -06:00
/**
* Create a new rule instance.
*
2021-01-26 12:27:49 -06:00
*
2022-12-29 12:42:26 -06:00
* @param Account|null $account
* @param string|null $expectedType
2021-01-26 12:27:49 -06:00
*/
public function __construct(?Account $account, ?string $expectedType)
{
2021-02-03 07:57:37 -06:00
Log::debug('Constructed UniqueAccountNumber');
2021-01-26 12:27:49 -06:00
$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;
}
2021-02-03 07:57:37 -06:00
Log::debug(sprintf('Expected type is "%s"', $this->expectedType));
2021-01-26 12:27:49 -06:00
}
/**
* Get the validation error message.
*
2021-01-26 12:27:49 -06:00
*
* @return string
*/
public function message(): string
{
2022-12-29 12:42:26 -06:00
return (string)trans('validation.unique_account_number_for_user');
2021-01-26 12:27:49 -06:00
}
/**
* Determine if the validation rule passes.
*
2022-12-29 12:42:26 -06:00
* @param string $attribute
* @param mixed $value
2021-01-26 12:27:49 -06:00
*
* @return bool
*
*/
public function passes($attribute, $value): bool
{
if (!auth()->check()) {
return true;
2021-01-26 12:27:49 -06:00
}
if (null === $this->expectedType) {
return true;
2021-01-26 12:27:49 -06:00
}
$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"',
2022-10-30 08:24:37 -05:00
$value,
$count,
$type,
$this->expectedType
2021-01-26 12:27:49 -06:00
)
);
return false;
}
}
2021-02-03 07:57:37 -06:00
Log::debug('Account number is valid.');
2021-01-26 12:27:49 -06:00
2021-03-21 03:15:40 -05:00
return true;
2021-01-26 12:27:49 -06:00
}
/**
* @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;
}
2021-03-21 03:15:40 -05:00
/**
2022-12-29 12:42:26 -06:00
* @param string $type
* @param string $accountNumber
2021-03-21 03:15:40 -05:00
*
* @return int
*/
private function countHits(string $type, string $accountNumber): int
{
2022-10-30 08:24:37 -05:00
$query = AccountMeta::leftJoin('accounts', 'accounts.id', '=', 'account_meta.account_id')
2022-12-29 12:42:26 -06:00
->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));
2021-03-21 03:15:40 -05:00
if (null !== $this->account) {
$query->where('accounts.id', '!=', $this->account->id);
}
return $query->count();
}
2021-01-26 12:27:49 -06:00
}