mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-11-03 20:55:05 +00:00
323 lines
13 KiB
PHP
323 lines
13 KiB
PHP
<?php
|
|
/**
|
|
* RecurrenceValidation.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\Validation;
|
|
|
|
use Carbon\Carbon;
|
|
use FireflyIII\Models\Recurrence;
|
|
use FireflyIII\Models\RecurrenceTransaction;
|
|
use Illuminate\Validation\Validator;
|
|
use InvalidArgumentException;
|
|
use Log;
|
|
|
|
/**
|
|
* Trait RecurrenceValidation
|
|
*
|
|
* Contains advanced validation rules used in validation of new and existing recurrences.
|
|
*
|
|
*/
|
|
trait RecurrenceValidation
|
|
{
|
|
/**
|
|
* Validate account information input for recurrences which are being updated.
|
|
*
|
|
* See reference nr. 101
|
|
*
|
|
* @param Validator $validator
|
|
*/
|
|
public function valUpdateAccountInfo(Validator $validator): void
|
|
{
|
|
$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 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 RecurrenceTransaction|null $first */
|
|
$first = $recurrence->recurrenceTransactions()->first();
|
|
if (null !== $first) {
|
|
$transactionType = $first->transactionType ? $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 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)
|
|
) {
|
|
continue;
|
|
}
|
|
// 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]);
|
|
|
|
// do something with result:
|
|
if (false === $validSource) {
|
|
$validator->errors()->add(sprintf('transactions.%d.source_id', $index), $accountValidator->sourceError);
|
|
$validator->errors()->add(sprintf('transactions.%d.source_name', $index), $accountValidator->sourceError);
|
|
|
|
return;
|
|
}
|
|
// validate destination account
|
|
$destinationId = array_key_exists('destination_id', $transaction) ? (int)$transaction['destination_id'] : null;
|
|
$destinationName = $transaction['destination_name'] ?? null;
|
|
$validDestination = $accountValidator->validateDestination(['id' => $destinationId, 'name' => $destinationName,]);
|
|
// do something with result:
|
|
if (false === $validDestination) {
|
|
$validator->errors()->add(sprintf('transactions.%d.destination_id', $index), $accountValidator->destError);
|
|
$validator->errors()->add(sprintf('transactions.%d.destination_name', $index), $accountValidator->destError);
|
|
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds an error to the validator when there are no repetitions in the array of data.
|
|
*
|
|
* @param Validator $validator
|
|
*/
|
|
public function validateOneRepetition(Validator $validator): void
|
|
{
|
|
$data = $validator->getData();
|
|
$repetitions = $data['repetitions'] ?? [];
|
|
// need at least one transaction
|
|
if (!is_countable($repetitions) || empty($repetitions)) {
|
|
$validator->errors()->add('repetitions', (string)trans('validation.at_least_one_repetition'));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds an error to the validator when there are no repetitions in the array of data.
|
|
*
|
|
* @param Validator $validator
|
|
*/
|
|
public function validateOneRepetitionUpdate(Validator $validator): void
|
|
{
|
|
$data = $validator->getData();
|
|
$repetitions = $data['repetitions'] ?? null;
|
|
if (null === $repetitions) {
|
|
return;
|
|
}
|
|
// need at least one transaction
|
|
if (empty($repetitions)) {
|
|
$validator->errors()->add('repetitions', (string)trans('validation.at_least_one_repetition'));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Validates that the recurrence has valid repetition information. It either doesn't stop,
|
|
* or stops after X times or at X date. Not both of them.,
|
|
*
|
|
* @param Validator $validator
|
|
*/
|
|
public function validateRecurrenceRepetition(Validator $validator): void
|
|
{
|
|
$data = $validator->getData();
|
|
$repetitions = $data['nr_of_repetitions'] ?? null;
|
|
$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'));
|
|
}
|
|
}
|
|
|
|
public function validateRecurringConfig(Validator $validator)
|
|
{
|
|
$data = $validator->getData();
|
|
$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 && null === $repeatUntil) {
|
|
$validator->errors()->add('nr_of_repetitions', trans('validation.require_repeat_until'));
|
|
$validator->errors()->add('repeat_until', trans('validation.require_repeat_until'));
|
|
|
|
return;
|
|
}
|
|
if ($reps > 0 && null !== $repeatUntil) {
|
|
$validator->errors()->add('nr_of_repetitions', trans('validation.require_repeat_until'));
|
|
$validator->errors()->add('repeat_until', trans('validation.require_repeat_until'));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param Validator $validator
|
|
*/
|
|
public function validateRepetitionMoment(Validator $validator): void
|
|
{
|
|
$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'));
|
|
|
|
return;
|
|
}
|
|
/**
|
|
* @var int $index
|
|
* @var array $repetition
|
|
*/
|
|
foreach ($repetitions as $index => $repetition) {
|
|
if (!array_key_exists('moment', $repetition)) {
|
|
continue;
|
|
}
|
|
if (null === $repetition['moment']) {
|
|
$repetition['moment'] = '';
|
|
}
|
|
$repetition['moment'] = $repetition['moment'] ?? 'invalid';
|
|
switch ($repetition['type'] ?? 'empty') {
|
|
default:
|
|
$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']);
|
|
break;
|
|
case 'monthly':
|
|
$this->validateMonthly($validator, $index, (int)$repetition['moment']);
|
|
break;
|
|
case 'ndom':
|
|
$this->validateNdom($validator, $index, (string)$repetition['moment']);
|
|
break;
|
|
case 'weekly':
|
|
$this->validateWeekly($validator, $index, (int)$repetition['moment']);
|
|
break;
|
|
case 'yearly':
|
|
$this->validateYearly($validator, $index, (string)$repetition['moment']);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* If the repetition type is daily, the moment should be empty.
|
|
*
|
|
* @param Validator $validator
|
|
* @param int $index
|
|
* @param string $moment
|
|
*/
|
|
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'));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* If the repetition type is monthly, the moment should be a day between 1-31 (inclusive).
|
|
*
|
|
* @param Validator $validator
|
|
* @param int $index
|
|
* @param int $dayOfMonth
|
|
*/
|
|
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'));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* If the repetition type is "ndom", the first part must be between 1-5 (inclusive), for the week in the month,
|
|
* and the second one must be between 1-7 (inclusive) for the day of the week.
|
|
*
|
|
* @param Validator $validator
|
|
* @param int $index
|
|
* @param string $moment
|
|
*/
|
|
protected function validateNdom(Validator $validator, int $index, string $moment): void
|
|
{
|
|
$parameters = explode(',', $moment);
|
|
if (2 !== count($parameters)) {
|
|
$validator->errors()->add(sprintf('repetitions.%d.moment', $index), (string)trans('validation.valid_recurrence_rep_moment'));
|
|
|
|
return;
|
|
}
|
|
$nthDay = (int)($parameters[0] ?? 0.0);
|
|
$dayOfWeek = (int)($parameters[1] ?? 0.0);
|
|
if ($nthDay < 1 || $nthDay > 5) {
|
|
$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'));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* If the repetition type is weekly, the moment should be a day between 1-7 (inclusive).
|
|
*
|
|
* @param Validator $validator
|
|
* @param int $index
|
|
* @param int $dayOfWeek
|
|
*/
|
|
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'));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* If the repetition type is yearly, the moment should be a valid date.
|
|
*
|
|
* @param Validator $validator
|
|
* @param int $index
|
|
* @param string $moment
|
|
*/
|
|
protected function validateYearly(Validator $validator, int $index, string $moment): void
|
|
{
|
|
try {
|
|
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'));
|
|
}
|
|
}
|
|
}
|