data-importer/app/Http/Controllers/Import/ConversionController.php

<?php
/*
 * ConversionController.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\Controllers\Import;

use App\Exceptions\ImporterErrorException;
use App\Http\Controllers\Controller;
use App\Http\Middleware\ConversionControllerMiddleware;
use App\Services\Camt\Conversion\RoutineManager as CamtRoutineManager;
use App\Services\CSV\Conversion\RoutineManager as CSVRoutineManager;
use App\Services\Nordigen\Conversion\RoutineManager as NordigenRoutineManager;
use App\Services\Session\Constants;
use App\Services\Shared\Conversion\ConversionStatus;
use App\Services\Shared\Conversion\RoutineManagerInterface;
use App\Services\Shared\Conversion\RoutineStatusManager;
use App\Services\Spectre\Conversion\RoutineManager as SpectreRoutineManager;
use App\Support\Http\RestoresConfiguration;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;

/**
 * Class ConversionController
 */
class ConversionController extends Controller
{
    use RestoresConfiguration;

    protected const DISK_NAME = 'jobs'; // TODO stored in several places

    /**
     * StartController constructor.
     */
    public function __construct()
    {
        parent::__construct();
        app('view')->share('pageTitle', 'Importing data...');
        $this->middleware(ConversionControllerMiddleware::class);
    }

    /**
     * @throws ImporterErrorException
     */
    public function index()
    {
        // app('log')->debug(sprintf('Now in %s', __METHOD__));
        $mainTitle     = 'Convert the data';

        // create configuration:
        $configuration = $this->restoreConfiguration();

        app('log')->debug('Will now verify configuration content.');
        $jobBackUrl    = route('back.mapping');
        if (0 === count($configuration->getDoMapping()) && 'file' === $configuration->getFlow()) {
            // no mapping, back to roles
            app('log')->debug('Pressing "back" will send you to roles.');
            $jobBackUrl = route('back.roles');
        }
        if (0 === count($configuration->getMapping())) {
            // back to mapping
            app('log')->debug('Pressing "back" will send you to mapping.');
            $jobBackUrl = route('back.mapping');
        }
        // TODO option is not used atm.

        //        if (true === $configuration->isMapAllData()) {
        //            app('log')->debug('Pressing "back" will send you to mapping.');
        //            $jobBackUrl = route('back.mapping');
        //        }

        // job ID may be in session:
        $identifier    = session()->get(Constants::CONVERSION_JOB_IDENTIFIER);
        $routine       = null;
        $flow          = $configuration->getFlow();
        app('log')->debug('Will redirect to submission after conversion.');
        $nextUrl       = route('008-submit.index');

        // switch based on flow:
        if (!in_array($flow, config('importer.flows'), true)) {
            throw new ImporterErrorException(sprintf('Not a supported flow: "%s"', $flow));
        }
        // @var RoutineManagerInterface $routine
        if ('file' === $flow) {
            $contentType = $configuration->getContentType();
            if ('unknown' === $contentType || 'csv' === $contentType) {
                app('log')->debug('Create CSV routine manager.');
                $routine = new CSVRoutineManager($identifier);
            }
            if ('camt' === $contentType) {
                app('log')->debug('Create CAMT routine manager.');
                $routine = new CamtRoutineManager($identifier);
            }
        }
        if ('nordigen' === $flow) {
            app('log')->debug('Create Nordigen routine manager.');
            $routine = new NordigenRoutineManager($identifier);
        }
        if ('spectre' === $flow) {
            app('log')->debug('Create Spectre routine manager.');
            $routine = new SpectreRoutineManager($identifier);
        }
        if ($configuration->isMapAllData() && in_array($flow, ['spectre', 'nordigen'], true)) {
            app('log')->debug('Will redirect to mapping after conversion.');
            $nextUrl = route('006-mapping.index');
        }
        if (null === $routine) {
            throw new ImporterErrorException(sprintf('Could not create routine manager for flow "%s"', $flow));
        }

        // may be a new identifier! Yay!
        $identifier    = $routine->getIdentifier();

        app('log')->debug(sprintf('Conversion routine manager identifier is "%s"', $identifier));

        // store identifier in session so the status can get it.
        session()->put(Constants::CONVERSION_JOB_IDENTIFIER, $identifier);
        app('log')->debug(sprintf('Stored "%s" under "%s"', $identifier, Constants::CONVERSION_JOB_IDENTIFIER));

        return view('import.007-convert.index', compact('mainTitle', 'identifier', 'jobBackUrl', 'flow', 'nextUrl'));
    }

    public function start(Request $request): JsonResponse
    {
        app('log')->debug(sprintf('Now at %s', __METHOD__));
        $identifier      = $request->get('identifier');
        $configuration   = $this->restoreConfiguration();
        $routine         = null;

        // now create the right class:
        $flow            = $configuration->getFlow();
        if (!in_array($flow, config('importer.flows'), true)) {
            throw new ImporterErrorException(sprintf('Not a supported flow: "%s"', $flow));
        }
        // @var RoutineManagerInterface $routine
        if ('file' === $flow) {
            $contentType = $configuration->getContentType();
            if ('unknown' === $contentType || 'csv' === $contentType) {
                $routine = new CSVRoutineManager($identifier);
            }
            if ('camt' === $contentType) {
                $routine = new CamtRoutineManager($identifier); // why do we need this one?
            }
        }
        if ('nordigen' === $flow) {
            $routine = new NordigenRoutineManager($identifier);
        }
        if ('spectre' === $flow) {
            $routine = new SpectreRoutineManager($identifier);
        }

        if (null === $routine) {
            throw new ImporterErrorException(sprintf('Could not create routine manager for flow "%s"', $flow));
        }

        $importJobStatus = RoutineStatusManager::startOrFindConversion($identifier);

        RoutineStatusManager::setConversionStatus(ConversionStatus::CONVERSION_RUNNING);

        // then push stuff into the routine:
        $routine->setConfiguration($configuration);

        try {
            $transactions = $routine->start();
        } catch (ImporterErrorException $e) {
            app('log')->error($e->getMessage());
            app('log')->error($e->getTraceAsString());
            RoutineStatusManager::setConversionStatus(ConversionStatus::CONVERSION_ERRORED);

            return response()->json($importJobStatus->toArray());
        }
        app('log')->debug(sprintf('Conversion routine "%s" was started successfully.', $flow));
        if (0 === count($transactions)) {
            app('log')->error('[b] Zero transactions!');
            RoutineStatusManager::setConversionStatus(ConversionStatus::CONVERSION_ERRORED);

            return response()->json($importJobStatus->toArray());
        }
        app('log')->debug(sprintf('Conversion routine "%s" yielded %d transaction(s).', $flow, count($transactions)));
        // save transactions in 'jobs' directory under the same key as the conversion thing.
        $disk            = \Storage::disk(self::DISK_NAME);

        try {
            $disk->put(sprintf('%s.json', $identifier), json_encode($transactions, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR));
        } catch (\JsonException $e) {
            app('log')->error(sprintf('JSON exception: %s', $e->getMessage()));
            app('log')->error($e->getTraceAsString());
            RoutineStatusManager::setConversionStatus(ConversionStatus::CONVERSION_ERRORED);

            return response()->json($importJobStatus->toArray());
        }
        app('log')->debug(sprintf('Transactions are stored on disk "%s" in file "%s.json"', self::DISK_NAME, $identifier));

        // set done:
        RoutineStatusManager::setConversionStatus(ConversionStatus::CONVERSION_DONE);

        // set config as complete.
        session()->put(Constants::CONVERSION_COMPLETE_INDICATOR, true);
        app('log')->debug('Set conversion as complete.');

        return response()->json($importJobStatus->toArray());
    }

    public function status(Request $request): JsonResponse
    {
        //        app('log')->debug(sprintf('Now at %s', __METHOD__));
        $identifier      = $request->get('identifier');
        app('log')->debug(sprintf('Now at %s(%s)', __METHOD__, $identifier));
        if (null === $identifier) {
            app('log')->warning('Identifier is NULL.');
            // no status is known yet because no identifier is in the session.
            // As a fallback, return empty status
            $fakeStatus = new ConversionStatus();

            return response()->json($fakeStatus->toArray());
        }
        $importJobStatus = RoutineStatusManager::startOrFindConversion($identifier);

        return response()->json($importJobStatus->toArray());
    }
}