You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
478 lines
20 KiB
478 lines
20 KiB
<?php
|
|
|
|
/*
|
|
* IsReadyForStep.php
|
|
* Copyright (c) 2021 james@firefly-iii.org
|
|
*
|
|
* This file is part of the Firefly III Data Importer
|
|
* (https://github.com/firefly-iii/data-importer).
|
|
*
|
|
* 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 App\Http\Middleware;
|
|
|
|
use App\Exceptions\ImporterErrorException;
|
|
use App\Services\Session\Constants;
|
|
use Closure;
|
|
use Illuminate\Http\RedirectResponse;
|
|
use Illuminate\Http\Request;
|
|
use Log;
|
|
|
|
|
|
/**
|
|
* Trait IsReadyForStep
|
|
*/
|
|
trait IsReadyForStep
|
|
{
|
|
/**
|
|
* @param Request $request
|
|
* @param Closure $next
|
|
*
|
|
* @return mixed
|
|
* @throws ImporterErrorException
|
|
*/
|
|
public function handle(Request $request, Closure $next): mixed
|
|
{
|
|
$result = $this->isReadyForStep($request);
|
|
if (true === $result) {
|
|
return $next($request);
|
|
}
|
|
|
|
$redirect = $this->redirectToCorrectStep($request);
|
|
if (null !== $redirect) {
|
|
return $redirect;
|
|
}
|
|
throw new ImporterErrorException(sprintf('Cannot handle middleware: %s', self::STEP));
|
|
}
|
|
|
|
/**
|
|
* @param Request $request
|
|
* @return bool
|
|
* @throws ImporterErrorException
|
|
*/
|
|
protected function isReadyForStep(Request $request): bool
|
|
{
|
|
$flow = $request->cookie(Constants::FLOW_COOKIE);
|
|
if (null === $flow) {
|
|
Log::debug('isReadyForStep returns true because $flow is null');
|
|
return true;
|
|
}
|
|
if ('csv' === $flow) {
|
|
return $this->isReadyForCSVStep();
|
|
}
|
|
if ('nordigen' === $flow) {
|
|
return $this->isReadyForNordigenStep();
|
|
}
|
|
if ('spectre' === $flow) {
|
|
return $this->isReadyForSpectreStep();
|
|
}
|
|
return $this->isReadyForBasicStep();
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
* @throws ImporterErrorException
|
|
*/
|
|
private function isReadyForCSVStep(): bool
|
|
{
|
|
Log::debug(sprintf('isReadyForCSVStep("%s")', self::STEP));
|
|
switch (self::STEP) {
|
|
default:
|
|
throw new ImporterErrorException(sprintf('isReadyForCSVStep: Cannot handle CSV step "%s"', self::STEP));
|
|
case 'service-validation':
|
|
return true;
|
|
case 'upload-files':
|
|
if (session()->has(Constants::HAS_UPLOAD) && true === session()->get(Constants::HAS_UPLOAD)) {
|
|
return false;
|
|
}
|
|
return true;
|
|
case 'authenticate':
|
|
// for CSV this is always false.
|
|
return false;
|
|
case 'define-roles':
|
|
if (session()->has(Constants::ROLES_COMPLETE_INDICATOR) && true === session()->get(Constants::ROLES_COMPLETE_INDICATOR)) {
|
|
return false;
|
|
}
|
|
return true;
|
|
case 'configuration':
|
|
if (session()->has(Constants::CONFIG_COMPLETE_INDICATOR) && true === session()->get(Constants::CONFIG_COMPLETE_INDICATOR)) {
|
|
return false;
|
|
}
|
|
return true;
|
|
case 'map':
|
|
if (session()->has(Constants::MAPPING_COMPLETE_INDICATOR) && true === session()->get(Constants::MAPPING_COMPLETE_INDICATOR)) {
|
|
return false;
|
|
}
|
|
return true;
|
|
case 'conversion':
|
|
// if/else is in reverse!
|
|
if (session()->has(Constants::READY_FOR_CONVERSION) && true === session()->get(Constants::READY_FOR_CONVERSION)) {
|
|
return true;
|
|
}
|
|
// will probably never return false, but OK.
|
|
return false;
|
|
case 'submit':
|
|
// if/else is in reverse!
|
|
if (session()->has(Constants::CONVERSION_COMPLETE_INDICATOR) && true === session()->get(Constants::CONVERSION_COMPLETE_INDICATOR)) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
* @throws ImporterErrorException
|
|
*/
|
|
private function isReadyForNordigenStep(): bool
|
|
{
|
|
Log::debug(sprintf('isReadyForNordigenStep("%s")', self::STEP));
|
|
switch (self::STEP) {
|
|
default:
|
|
throw new ImporterErrorException(sprintf('isReadyForNordigenStep: Cannot handle Nordigen step "%s"', self::STEP));
|
|
case 'authenticate':
|
|
case 'service-validation':
|
|
return true;
|
|
case 'define-roles':
|
|
return false;
|
|
case 'upload-files':
|
|
if (session()->has(Constants::HAS_UPLOAD) && true === session()->get(Constants::HAS_UPLOAD)) {
|
|
return false;
|
|
}
|
|
return true;
|
|
case 'nordigen-selection':
|
|
// must have upload, thats it
|
|
if (session()->has(Constants::HAS_UPLOAD) && true === session()->get(Constants::HAS_UPLOAD)) {
|
|
return true;
|
|
}
|
|
return false;
|
|
case 'map':
|
|
// mapping must be complete, or not ready for this step.
|
|
if (session()->has(Constants::MAPPING_COMPLETE_INDICATOR) && true === session()->get(Constants::MAPPING_COMPLETE_INDICATOR)) {
|
|
Log::debug('Return false, not ready for step [1].');
|
|
return false;
|
|
}
|
|
|
|
// conversion complete?
|
|
if (session()->has(Constants::CONVERSION_COMPLETE_INDICATOR) && true === session()->get(Constants::CONVERSION_COMPLETE_INDICATOR)) {
|
|
Log::debug('Return true, ready for step [4].');
|
|
return true;
|
|
}
|
|
|
|
// must already have the conversion, or not ready for this step:
|
|
if (session()->has(Constants::READY_FOR_CONVERSION) && true === session()->get(Constants::READY_FOR_CONVERSION)) {
|
|
Log::debug('Return false, not yet ready for step [2].');
|
|
return false;
|
|
}
|
|
// otherwise return false.
|
|
Log::debug('Return true, ready for step [3].');
|
|
return true;
|
|
case 'nordigen-link':
|
|
// must have upload, thats it
|
|
if (session()->has(Constants::SELECTED_BANK_COUNTRY) && true === session()->get(Constants::SELECTED_BANK_COUNTRY)) {
|
|
return true;
|
|
}
|
|
return false;
|
|
case 'conversion':
|
|
if (session()->has(Constants::READY_FOR_SUBMISSION) && true === session()->get(Constants::READY_FOR_SUBMISSION)) {
|
|
Log::debug('Return false, ready for submission.');
|
|
return false;
|
|
}
|
|
// if/else is in reverse!
|
|
if (session()->has(Constants::READY_FOR_CONVERSION) && true === session()->get(Constants::READY_FOR_CONVERSION)) {
|
|
return true;
|
|
}
|
|
|
|
// will probably never return false, but OK.
|
|
return false;
|
|
case 'configuration':
|
|
if (session()->has(Constants::SELECTED_BANK_COUNTRY) && true === session()->get(Constants::SELECTED_BANK_COUNTRY)) {
|
|
return true;
|
|
}
|
|
return false;
|
|
case 'submit':
|
|
// if/else is in reverse!
|
|
if (session()->has(Constants::CONVERSION_COMPLETE_INDICATOR) && true === session()->get(Constants::CONVERSION_COMPLETE_INDICATOR)) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
* @throws ImporterErrorException
|
|
*/
|
|
private function isReadyForSpectreStep(): bool
|
|
{
|
|
Log::debug(sprintf('isReadyForSpectreStep("%s")', self::STEP));
|
|
switch (self::STEP) {
|
|
default:
|
|
throw new ImporterErrorException(sprintf('isReadyForSpectreStep: Cannot handle Spectre step "%s"', self::STEP));
|
|
case 'service-validation':
|
|
case 'authenticate':
|
|
return true;
|
|
case 'conversion':
|
|
if (session()->has(Constants::READY_FOR_SUBMISSION) && true === session()->get(Constants::READY_FOR_SUBMISSION)) {
|
|
Log::debug('Spectre: Return false, ready for submission.');
|
|
return false;
|
|
}
|
|
// if/else is in reverse!
|
|
if (session()->has(Constants::READY_FOR_CONVERSION) && true === session()->get(Constants::READY_FOR_CONVERSION)) {
|
|
return true;
|
|
}
|
|
|
|
// will probably never return false, but OK.
|
|
return false;
|
|
case 'upload-files':
|
|
if (session()->has(Constants::HAS_UPLOAD) && true === session()->get(Constants::HAS_UPLOAD)) {
|
|
return false;
|
|
}
|
|
return true;
|
|
case 'select-connection':
|
|
if (session()->has(Constants::HAS_UPLOAD) && true === session()->get(Constants::HAS_UPLOAD)) {
|
|
return true;
|
|
}
|
|
return false;
|
|
case 'configuration':
|
|
if (session()->has(Constants::CONNECTION_SELECTED_INDICATOR) && true === session()->get(Constants::CONNECTION_SELECTED_INDICATOR)) {
|
|
return true;
|
|
}
|
|
return false;
|
|
case 'define-roles':
|
|
return false;
|
|
case 'map':
|
|
// mapping must be complete, or not ready for this step.
|
|
if (session()->has(Constants::MAPPING_COMPLETE_INDICATOR) && true === session()->get(Constants::MAPPING_COMPLETE_INDICATOR)) {
|
|
Log::debug('Spectre: Return false, not ready for step [1].');
|
|
return false;
|
|
}
|
|
|
|
// conversion complete?
|
|
if (session()->has(Constants::CONVERSION_COMPLETE_INDICATOR) && true === session()->get(Constants::CONVERSION_COMPLETE_INDICATOR)) {
|
|
Log::debug('Spectre: Return true, ready for step [4].');
|
|
return true;
|
|
}
|
|
|
|
// must already have the conversion, or not ready for this step:
|
|
if (session()->has(Constants::READY_FOR_CONVERSION) && true === session()->get(Constants::READY_FOR_CONVERSION)) {
|
|
Log::debug('Spectre: Return false, not yet ready for step [2].');
|
|
return false;
|
|
}
|
|
// otherwise return false.
|
|
Log::debug('Spectre: Return true, ready for step [3].');
|
|
return true;
|
|
case 'submit':
|
|
// if/else is in reverse!
|
|
if (session()->has(Constants::CONVERSION_COMPLETE_INDICATOR) && true === session()->get(Constants::CONVERSION_COMPLETE_INDICATOR)) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
* @throws ImporterErrorException
|
|
*/
|
|
private function isReadyForBasicStep(): bool
|
|
{
|
|
Log::debug(sprintf('isReadyForBasicStep("%s")', self::STEP));
|
|
switch (self::STEP) {
|
|
default:
|
|
throw new ImporterErrorException(sprintf('isReadyForBasicStep: Cannot handle basic step "%s"', self::STEP));
|
|
case 'service-validation':
|
|
return true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param Request $request
|
|
* @return RedirectResponse|null
|
|
* @throws ImporterErrorException
|
|
*/
|
|
protected function redirectToCorrectStep(Request $request): ?RedirectResponse
|
|
{
|
|
$flow = $request->cookie(Constants::FLOW_COOKIE);
|
|
if (null === $flow) {
|
|
Log::debug('redirectToCorrectStep returns true because $flow is null');
|
|
return null;
|
|
}
|
|
if ('csv' === $flow) {
|
|
return $this->redirectToCorrectCSVStep();
|
|
}
|
|
if ('nordigen' === $flow) {
|
|
return $this->redirectToCorrectNordigenStep();
|
|
}
|
|
if ('spectre' === $flow) {
|
|
return $this->redirectToCorrectSpectreStep();
|
|
}
|
|
return $this->redirectToBasicStep();
|
|
}
|
|
|
|
/**
|
|
* @return RedirectResponse
|
|
* @throws ImporterErrorException
|
|
*/
|
|
private function redirectToCorrectCSVStep(): RedirectResponse
|
|
{
|
|
Log::debug(sprintf('redirectToCorrectCSVStep("%s")', self::STEP));
|
|
switch (self::STEP) {
|
|
default:
|
|
throw new ImporterErrorException(sprintf('redirectToCorrectCSVStep: Cannot handle CSV step "%s"', self::STEP));
|
|
case 'upload-files':
|
|
$route = route('004-configure.index');
|
|
Log::debug(sprintf('Return redirect to "%s"', $route));
|
|
return redirect($route);
|
|
case 'define-roles':
|
|
$route = route('006-mapping.index');
|
|
Log::debug(sprintf('Return redirect to "%s"', $route));
|
|
return redirect($route);
|
|
case 'configuration':
|
|
$route = route('005-roles.index');
|
|
Log::debug(sprintf('Return redirect to "%s"', $route));
|
|
return redirect($route);
|
|
case 'map':
|
|
$route = route('007-convert.index');
|
|
Log::debug(sprintf('Return redirect to "%s"', $route));
|
|
return redirect($route);
|
|
case 'conversion':
|
|
// redirect to mapping
|
|
$route = route('006-mapping.index');
|
|
Log::debug(sprintf('Return redirect to "%s"', $route));
|
|
return redirect($route);
|
|
case 'authenticate':
|
|
$route = route('003-upload.index');
|
|
Log::debug(sprintf('Return redirect to "%s"', $route));
|
|
return redirect($route);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return RedirectResponse
|
|
* @throws ImporterErrorException
|
|
*/
|
|
private function redirectToCorrectNordigenStep(): RedirectResponse
|
|
{
|
|
Log::debug(sprintf('redirectToCorrectNordigenStep("%s")', self::STEP));
|
|
switch (self::STEP) {
|
|
default:
|
|
throw new ImporterErrorException(sprintf('redirectToCorrectNordigenStep: Cannot handle Nordigen step "%s"', self::STEP));
|
|
case 'nordigen-selection':
|
|
// back to upload
|
|
$route = route('003-upload.index');
|
|
Log::debug(sprintf('Return redirect to "%s"', $route));
|
|
return redirect($route);
|
|
case 'upload-files':
|
|
case 'nordigen-link':
|
|
// assume files are uploaded, go to step 11 (connection selection)
|
|
// back to selection
|
|
$route = route('009-selection.index');
|
|
Log::debug(sprintf('Return redirect to "%s"', $route));
|
|
return redirect($route);
|
|
case 'define-roles':
|
|
// will always push to mapping, and mapping will send them to
|
|
// the right step.
|
|
$route = route('006-mapping.index');
|
|
Log::debug(sprintf('Return redirect to "%s"', $route));
|
|
return redirect($route);
|
|
case 'map':
|
|
// if no conversion yet, go there first
|
|
// must already have the conversion, or not ready for this step:
|
|
if (session()->has(Constants::READY_FOR_CONVERSION) && true === session()->get(Constants::READY_FOR_CONVERSION)) {
|
|
Log::debug('Is ready for conversion, so send to conversion.');
|
|
$route = route('007-convert.index');
|
|
Log::debug(sprintf('Return redirect to "%s"', $route));
|
|
return redirect($route);
|
|
}
|
|
Log::debug('Is ready for submit.');
|
|
// otherwise go to import right away
|
|
$route = route('008-submit.index');
|
|
Log::debug(sprintf('Return redirect to "%s"', $route));
|
|
return redirect($route);
|
|
case 'conversion':
|
|
if (session()->has(Constants::READY_FOR_SUBMISSION) && true === session()->get(Constants::READY_FOR_SUBMISSION)) {
|
|
$route = route('008-submit.index');
|
|
Log::debug(sprintf('Return redirect to "%s"', $route));
|
|
return redirect($route);
|
|
}
|
|
throw new ImporterErrorException(sprintf('redirectToCorrectNordigenStep: Cannot handle Nordigen step "%s" [1]', self::STEP));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return RedirectResponse
|
|
* @throws ImporterErrorException
|
|
*/
|
|
private function redirectToCorrectSpectreStep(): RedirectResponse
|
|
{
|
|
Log::debug(sprintf('redirectToCorrectSpectreStep("%s")', self::STEP));
|
|
switch (self::STEP) {
|
|
default:
|
|
throw new ImporterErrorException(sprintf('redirectToCorrectSpectreStep: Cannot handle basic step "%s"', self::STEP));
|
|
case 'upload-files':
|
|
// assume files are uploaded, go to step 11 (connection selection)
|
|
// back to selection
|
|
$route = route('011-connections.index');
|
|
Log::debug(sprintf('Return redirect to "%s"', $route));
|
|
return redirect($route);
|
|
case 'define-roles':
|
|
// will always push to mapping, and mapping will send them to
|
|
// the right step.
|
|
$route = route('006-mapping.index');
|
|
Log::debug(sprintf('Return redirect to "%s"', $route));
|
|
return redirect($route);
|
|
case 'map':
|
|
// if no conversion yet, go there first
|
|
// must already have the conversion, or not ready for this step:
|
|
if (session()->has(Constants::READY_FOR_CONVERSION) && true === session()->get(Constants::READY_FOR_CONVERSION)) {
|
|
Log::debug('Spectre: Is ready for conversion, so send to conversion.');
|
|
$route = route('007-convert.index');
|
|
Log::debug(sprintf('Spectre: Return redirect to "%s"', $route));
|
|
return redirect($route);
|
|
}
|
|
Log::debug('Spectre: Is ready for submit.');
|
|
// otherwise go to import right away
|
|
$route = route('008-submit.index');
|
|
Log::debug(sprintf('Spectre: Return redirect to "%s"', $route));
|
|
return redirect($route);
|
|
case 'conversion':
|
|
if (session()->has(Constants::READY_FOR_SUBMISSION) && true === session()->get(Constants::READY_FOR_SUBMISSION)) {
|
|
$route = route('008-submit.index');
|
|
Log::debug(sprintf('Return redirect to "%s"', $route));
|
|
return redirect($route);
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* @return RedirectResponse
|
|
* @throws ImporterErrorException
|
|
*/
|
|
private function redirectToBasicStep(): RedirectResponse
|
|
{
|
|
Log::debug(sprintf('redirectToBasicStep("%s")', self::STEP));
|
|
switch (self::STEP) {
|
|
default:
|
|
throw new ImporterErrorException(sprintf('redirectToBasicStep: Cannot handle basic step "%s"', self::STEP));
|
|
}
|
|
|
|
}
|
|
|
|
}
|