Skip to content

Firefly III: a personal finances manager

Fix https://github.com/firefly-iii/firefly-iii/issues/12692 and #12545 with suggested code by @Toshik1978

James Cole211ab24627e4
diff --git a/app/Api/V1/Requests/Models/Recurrence/StoreRequest.php b/app/Api/V1/Requests/Models/Recurrence/StoreRequest.php
index ebc871979f..f7f08db70e 100644
--- a/app/Api/V1/Requests/Models/Recurrence/StoreRequest.php
+++ b/app/Api/V1/Requests/Models/Recurrence/StoreRequest.php
@@ -88,7 +88,7 @@ class StoreRequest extends FormRequest
'nr_of_repetitions' => ['nullable', 'numeric', 'min:1', 'max:255'],
'repetitions.*.type' => ['required', 'in:daily,weekly,ndom,monthly,yearly'],
- 'repetitions.*.moment' => ['string', 'min:0', 'max:10'],
+ 'repetitions.*.moment' => ['nullable', 'string', 'min:0', 'max:10'],
'repetitions.*.skip' => ['nullable', 'numeric', 'min:0', 'max:31'],
'repetitions.*.weekend' => ['numeric', 'min:1', 'max:4'],
diff --git a/app/Api/V1/Requests/Models/Recurrence/UpdateRequest.php b/app/Api/V1/Requests/Models/Recurrence/UpdateRequest.php
index 1a9a01bb4f..0a4b719f4b 100644
--- a/app/Api/V1/Requests/Models/Recurrence/UpdateRequest.php
+++ b/app/Api/V1/Requests/Models/Recurrence/UpdateRequest.php
@@ -97,7 +97,7 @@ class UpdateRequest extends FormRequest
'nr_of_repetitions' => ['nullable', 'numeric', 'min:1', 'max:255'],
'repetitions.*.type' => 'in:daily,weekly,ndom,monthly,yearly',
- 'repetitions.*.moment' => ['string', 'min:0', 'max:10'],
+ 'repetitions.*.moment' => ['nullable', 'string', 'min:0', 'max:10'],
'repetitions.*.skip' => ['nullable', 'numeric', 'min:0', 'max:31'],
'repetitions.*.weekend' => ['nullable', 'numeric', 'min:1', 'max:4'],
diff --git a/app/Validation/RecurrenceValidation.php b/app/Validation/RecurrenceValidation.php
index a3926273ff..4bfe19fecc 100644
--- a/app/Validation/RecurrenceValidation.php
+++ b/app/Validation/RecurrenceValidation.php
@@ -47,7 +47,7 @@ trait RecurrenceValidation
$repetitions = $data['repetitions'] ?? [];
// need at least one transaction
if (!is_countable($repetitions) || 0 === count($repetitions)) {
- $validator->errors()->add('repetitions', (string) trans('validation.at_least_one_repetition'));
+ $validator->errors()->add('repetitions', (string)trans('validation.at_least_one_repetition'));
}
}
@@ -63,7 +63,7 @@ trait RecurrenceValidation
}
// need at least one transaction
if (0 === count($repetitions)) {
- $validator->errors()->add('repetitions', (string) trans('validation.at_least_one_repetition'));
+ $validator->errors()->add('repetitions', (string)trans('validation.at_least_one_repetition'));
}
}
@@ -78,15 +78,15 @@ trait RecurrenceValidation
$repeatUntil = $data['repeat_until'] ?? null;
if (null !== $repetitions && null !== $repeatUntil) {
// expect a date OR count:
- $validator->errors()->add('repeat_until', (string) trans('validation.require_repeat_until'));
- $validator->errors()->add('nr_of_repetitions', (string) trans('validation.require_repeat_until'));
+ $validator->errors()->add('repeat_until', (string)trans('validation.require_repeat_until'));
+ $validator->errors()->add('nr_of_repetitions', (string)trans('validation.require_repeat_until'));
}
}
public function validateRecurringConfig(Validator $validator): void
{
$data = $validator->getData();
- $reps = array_key_exists('nr_of_repetitions', $data) ? (int) $data['nr_of_repetitions'] : null;
+ $reps = array_key_exists('nr_of_repetitions', $data) ? (int)$data['nr_of_repetitions'] : null;
$repeatUntil = array_key_exists('repeat_until', $data) ? new Carbon($data['repeat_until']) : null;
if (null === $reps && !$repeatUntil instanceof Carbon) {
@@ -106,7 +106,7 @@ trait RecurrenceValidation
$data = $validator->getData();
$repetitions = $data['repetitions'] ?? [];
if (!is_array($repetitions)) {
- $validator->errors()->add(sprintf('repetitions.%d.type', 0), (string) trans('validation.valid_recurrence_rep_type'));
+ $validator->errors()->add(sprintf('repetitions.%d.type', 0), (string)trans('validation.valid_recurrence_rep_type'));
return;
}
@@ -125,32 +125,32 @@ trait RecurrenceValidation
switch ($repetition['type'] ?? 'empty') {
default:
- $validator->errors()->add(sprintf('repetitions.%d.type', $index), (string) trans('validation.valid_recurrence_rep_type'));
+ $validator->errors()->add(sprintf('repetitions.%d.type', $index), (string)trans('validation.valid_recurrence_rep_type'));
return;
case 'daily':
- $this->validateDaily($validator, $index, (string) $repetition['moment']);
+ $this->validateDaily($validator, $index, (string)$repetition['moment']);
break;
case 'monthly':
- $this->validateMonthly($validator, $index, (int) $repetition['moment']);
+ $this->validateMonthly($validator, $index, (int)$repetition['moment']);
break;
case 'ndom':
- $this->validateNdom($validator, $index, (string) $repetition['moment']);
+ $this->validateNdom($validator, $index, (string)$repetition['moment']);
break;
case 'weekly':
- $this->validateWeekly($validator, $index, (int) $repetition['moment']);
+ $this->validateWeekly($validator, $index, (int)$repetition['moment']);
break;
case 'yearly':
- $this->validateYearly($validator, $index, (string) $repetition['moment']);
+ $this->validateYearly($validator, $index, (string)$repetition['moment']);
break;
}
@@ -164,55 +164,33 @@ trait RecurrenceValidation
*/
public function valUpdateAccountInfo(Validator $validator): void
{
- $data = $validator->getData();
+ $data = $validator->getData();
- $transactionType = $data['type'] ?? 'invalid';
-
- // grab model from parameter and try to set the transaction type from it
- if ('invalid' === $transactionType) {
- Log::debug('Type is invalid but we will search for it.');
-
- /** @var null|Recurrence $recurrence */
- $recurrence = $this->route()?->parameter('recurrence');
- if (null !== $recurrence) {
- Log::debug('There is a recurrence in the route.');
-
- // ok so we have a recurrence should be able to extract type somehow.
- /** @var null|RecurrenceTransaction $first */
- $first = $recurrence->recurrenceTransactions()->first();
- if (null !== $first) {
- $transactionType = null !== $first->transactionType()->first() ? $first->transactionType->type : 'withdrawal';
- Log::debug(sprintf('Determined type to be %s.', $transactionType));
- }
- if (null === $first) {
- Log::warning('Just going to assume type is a withdrawal.');
- $transactionType = 'withdrawal';
- }
- }
- }
-
- $transactions = $data['transactions'] ?? [];
+ /** @var null|Recurrence $recurrence */
+ $recurrence = $this->route()?->parameter('recurrence');
+ $transactionType = $this->getRecurrenceType($data, $recurrence);
+ $transactions = $data['transactions'] ?? [];
/** @var AccountValidator $accountValidator */
$accountValidator = app(AccountValidator::class);
Log::debug(sprintf('Going to loop %d transaction(s)', count($transactions)));
foreach ($transactions as $index => $transaction) {
- $transactionType = $transaction['type'] ?? $transactionType;
- $accountValidator->setTransactionType($transactionType);
-
- if (
- !array_key_exists('source_id', $transaction)
- && !array_key_exists('destination_id', $transaction)
- && !array_key_exists('source_name', $transaction)
- && !array_key_exists('destination_name', $transaction)
- ) {
+ $currentType = $transaction['type'] ?? $transactionType;
+ $accountValidator->setTransactionType($currentType);
+
+ $hasSource = array_key_exists('source_id', $transaction) || array_key_exists('source_name', $transaction);
+ $hasDestination = array_key_exists('destination_id', $transaction) || array_key_exists('destination_name', $transaction);
+ if (!$hasSource && !$hasDestination) {
continue;
}
+
+ $original = $this->getOriginalRecurrenceTransaction($recurrence, $transaction);
+
// validate source account.
- $sourceId = array_key_exists('source_id', $transaction) ? (int) $transaction['source_id'] : null;
- $sourceName = $transaction['source_name'] ?? null;
- $validSource = $accountValidator->validateSource(['id' => $sourceId, 'name' => $sourceName]);
+ $sourceId = $hasSource ? (int)($transaction['source_id'] ?? 0) : $original?->source_id;
+ $sourceName = $hasSource ? $transaction['source_name'] ?? null : null;
+ $validSource = $accountValidator->validateSource(['id' => $sourceId, 'name' => $sourceName]);
// do something with result:
if (false === $validSource) {
@@ -222,8 +200,8 @@ trait RecurrenceValidation
return;
}
// validate destination account
- $destinationId = array_key_exists('destination_id', $transaction) ? (int) $transaction['destination_id'] : null;
- $destinationName = $transaction['destination_name'] ?? null;
+ $destinationId = $hasDestination ? (int)($transaction['destination_id'] ?? 0) : $original?->destination_id;
+ $destinationName = $hasDestination ? $transaction['destination_name'] ?? null : null;
$validDestination = $accountValidator->validateDestination(['id' => $destinationId, 'name' => $destinationName]);
// do something with result:
if (false === $validDestination) {
@@ -235,13 +213,29 @@ trait RecurrenceValidation
}
}
+ private function getOriginalRecurrenceTransaction(?Recurrence $recurrence, array $transaction): ?RecurrenceTransaction
+ {
+ if (!$recurrence instanceof Recurrence) {
+ return null;
+ }
+ $collection = $recurrence->recurrenceTransactions;
+ $id = (int)($transaction['id'] ?? 0);
+ // without an ID it is only unambiguous when the recurrence has exactly one transaction.
+ if (0 === $id && 1 !== $collection->count()) {
+ return null;
+ }
+ $result = 0 === $id ? $collection->first() : $collection->firstWhere('id', $id);
+
+ return $result instanceof RecurrenceTransaction ? $result : null;
+ }
+
/**
* If the repetition type is daily, the moment should be empty.
*/
protected function validateDaily(Validator $validator, int $index, string $moment): void
{
if ('' !== $moment) {
- $validator->errors()->add(sprintf('repetitions.%d.moment', $index), (string) trans('validation.valid_recurrence_rep_moment'));
+ $validator->errors()->add(sprintf('repetitions.%d.moment', $index), (string)trans('validation.valid_recurrence_rep_moment'));
}
}
@@ -251,7 +245,7 @@ trait RecurrenceValidation
protected function validateMonthly(Validator $validator, int $index, int $dayOfMonth): void
{
if ($dayOfMonth < 1 || $dayOfMonth > 31) {
- $validator->errors()->add(sprintf('repetitions.%d.moment', $index), (string) trans('validation.valid_recurrence_rep_moment'));
+ $validator->errors()->add(sprintf('repetitions.%d.moment', $index), (string)trans('validation.valid_recurrence_rep_moment'));
}
}
@@ -263,19 +257,19 @@ trait RecurrenceValidation
{
$parameters = explode(',', $moment);
if (2 !== count($parameters)) {
- $validator->errors()->add(sprintf('repetitions.%d.moment', $index), (string) trans('validation.valid_recurrence_rep_moment'));
+ $validator->errors()->add(sprintf('repetitions.%d.moment', $index), (string)trans('validation.valid_recurrence_rep_moment'));
return;
}
- $nthDay = (int) $parameters[0];
- $dayOfWeek = (int) $parameters[1];
+ $nthDay = (int)$parameters[0];
+ $dayOfWeek = (int)$parameters[1];
if ($nthDay < 1 || $nthDay > 5) {
- $validator->errors()->add(sprintf('repetitions.%d.moment', $index), (string) trans('validation.valid_recurrence_rep_moment'));
+ $validator->errors()->add(sprintf('repetitions.%d.moment', $index), (string)trans('validation.valid_recurrence_rep_moment'));
return;
}
if ($dayOfWeek < 1 || $dayOfWeek > 7) {
- $validator->errors()->add(sprintf('repetitions.%d.moment', $index), (string) trans('validation.valid_recurrence_rep_moment'));
+ $validator->errors()->add(sprintf('repetitions.%d.moment', $index), (string)trans('validation.valid_recurrence_rep_moment'));
}
}
@@ -290,29 +284,29 @@ trait RecurrenceValidation
if (0 === $submittedTrCount) {
Log::warning('[b] User submitted no transactions.');
- $validator->errors()->add('transactions', (string) trans('validation.at_least_one_transaction'));
+ $validator->errors()->add('transactions', (string)trans('validation.at_least_one_transaction'));
return;
}
- $originalTrCount = $recurrence->recurrenceTransactions()->count();
+ $originalTrCount = $recurrence->recurrenceTransactions()->count();
if (1 === $submittedTrCount && 1 === $originalTrCount) {
- $first = $transactions[0]; // can safely assume index 0.
+ $first = $transactions[0]; // can safely assume index 0.
if (!array_key_exists('id', $first)) {
Log::debug('Single count and no ID, done.');
return; // home safe!
}
- $id = $first['id'];
- if ('' === (string) $id) {
+ $id = $first['id'];
+ if ('' === (string)$id) {
Log::debug('Single count and empty ID, done.');
return; // home safe!
}
- $integer = (int) $id;
+ $integer = (int)$id;
$secondCount = $recurrence->recurrenceTransactions()->where('recurrences_transactions.id', $integer)->count();
Log::debug(sprintf('Result of ID count: %d', $secondCount));
if (0 === $secondCount) {
- $validator->errors()->add('transactions.0.id', (string) trans('validation.id_does_not_match', ['id' => $integer]));
+ $validator->errors()->add('transactions.0.id', (string)trans('validation.id_does_not_match', ['id' => $integer]));
}
Log::debug('Single ID validation done.');
@@ -320,7 +314,7 @@ trait RecurrenceValidation
}
Log::debug('Multi ID validation.');
- $idsMandatory = false;
+ $idsMandatory = false;
if ($submittedTrCount < $originalTrCount) {
Log::debug(sprintf('User submits %d transaction, recurrence has %d transactions. All entries must have ID.', $submittedTrCount, $originalTrCount));
$idsMandatory = true;
@@ -337,19 +331,19 @@ trait RecurrenceValidation
* 2. If the user submits more transactions than already present, count the number of existing transactions. At least those must be matched. After that, submit as many as you like.
* 3. If the user submits the same number of transactions as already present, all but one must have an ID.
*/
- $unmatchedIds = 0;
+ $unmatchedIds = 0;
foreach ($transactions as $index => $transaction) {
Log::debug(sprintf('Now at %d/%d', $index + 1, $submittedTrCount));
if (!is_array($transaction)) {
Log::warning('Not an array. Give error.');
- $validator->errors()->add(sprintf('transactions.%d.id', $index), (string) trans('validation.at_least_one_transaction'));
+ $validator->errors()->add(sprintf('transactions.%d.id', $index), (string)trans('validation.at_least_one_transaction'));
return;
}
if (!array_key_exists('id', $transaction) && $idsMandatory) {
Log::warning('ID is mandatory but array has no ID.');
- $validator->errors()->add(sprintf('transactions.%d.id', $index), (string) trans('validation.need_id_to_match'));
+ $validator->errors()->add(sprintf('transactions.%d.id', $index), (string)trans('validation.need_id_to_match'));
return;
}
@@ -357,9 +351,8 @@ trait RecurrenceValidation
Log::debug('Array has ID.');
$idCount = $recurrence
->recurrenceTransactions()
- ->where('recurrences_transactions.id', (int) $transaction['id'])
- ->count()
- ;
+ ->where('recurrences_transactions.id', (int)$transaction['id'])
+ ->count();
if (0 === $idCount) {
Log::debug('ID does not exist or no match. Count another unmatched ID.');
++$unmatchedIds;
@@ -371,11 +364,11 @@ trait RecurrenceValidation
}
}
// if too many don't match, but you haven't submitted more than already present:
- $maxUnmatched = max(1, $submittedTrCount - $originalTrCount);
+ $maxUnmatched = max(1, $submittedTrCount - $originalTrCount);
Log::debug(sprintf('Submitted: %d. Original: %d. User can submit %d unmatched transactions.', $submittedTrCount, $originalTrCount, $maxUnmatched));
if ($unmatchedIds > $maxUnmatched) {
Log::warning(sprintf('Too many unmatched transactions (%d).', $unmatchedIds));
- $validator->errors()->add('transactions.0.id', (string) trans('validation.too_many_unmatched'));
+ $validator->errors()->add('transactions.0.id', (string)trans('validation.too_many_unmatched'));
return;
}
@@ -388,7 +381,7 @@ trait RecurrenceValidation
protected function validateWeekly(Validator $validator, int $index, int $dayOfWeek): void
{
if ($dayOfWeek < 1 || $dayOfWeek > 7) {
- $validator->errors()->add(sprintf('repetitions.%d.moment', $index), (string) trans('validation.valid_recurrence_rep_moment'));
+ $validator->errors()->add(sprintf('repetitions.%d.moment', $index), (string)trans('validation.valid_recurrence_rep_moment'));
}
}
@@ -401,7 +394,40 @@ trait RecurrenceValidation
Carbon::createFromFormat('Y-m-d', $moment);
} catch (InvalidArgumentException $e) {
Log::debug(sprintf('Invalid argument for Carbon: %s', $e->getMessage()));
- $validator->errors()->add(sprintf('repetitions.%d.moment', $index), (string) trans('validation.valid_recurrence_rep_moment'));
+ $validator->errors()->add(sprintf('repetitions.%d.moment', $index), (string)trans('validation.valid_recurrence_rep_moment'));
+ }
+ }
+
+ /**
+ * Determine the transaction type to validate the submitted accounts against: the submitted type wins, then the
+ * type of the recurrence itself.
+ */
+ private function getRecurrenceType(array $data, ?Recurrence $recurrence): string
+ {
+ $transactionType = $data['type'] ?? 'invalid';
+ if ('invalid' !== $transactionType && in_array(ucfirst($transactionType), array_keys(config('firefly.transactionTypesToShort')), true)) {
+ return (string)$transactionType;
}
+
+ if (!$recurrence instanceof Recurrence) {
+ Log::warning('No recurrence in the route, assume withdrawal.');
+
+ return 'withdrawal';
+ }
+ $transactionType = (string)$recurrence->transactionType?->type;
+
+ /** @var null|RecurrenceTransaction $first */
+ $first = $recurrence->recurrenceTransactions()->first();
+ if (null !== $first?->transactionType) {
+ $transactionType = (string)$first->transactionType->type;
+ }
+
+ if ('' === $transactionType) {
+ Log::warning('Just going to assume type is a withdrawal.');
+ $transactionType = 'withdrawal';
+ }
+ Log::debug(sprintf('Determined type to be %s.', $transactionType));
+
+ return $transactionType;
}
}