firefly-iii/app/Http/Controllers/Import/PrerequisitesController.php

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

use FireflyIII\Http\Controllers\Controller;
use FireflyIII\Import\Prerequisites\PrerequisitesInterface;
use FireflyIII\Models\ImportJob;
use FireflyIII\Repositories\ImportJob\ImportJobRepositoryInterface;
use FireflyIII\User;
use Illuminate\Contracts\View\Factory;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Routing\Redirector;
use Illuminate\View\View;
use Log;

/**
 * Class PrerequisitesController
 *
 * @deprecated
 * @codeCoverageIgnore
 */
class PrerequisitesController extends Controller
{

    /** @var ImportJobRepositoryInterface The import job repository */
    private $repository;

    /**
     * PrerequisitesController constructor.
     */
    public function __construct()
    {
        parent::__construct();

        $this->middleware(
            function ($request, $next) {
                app('view')->share('mainTitleIcon', 'fa-archive');
                app('view')->share('title', (string) trans('firefly.import_index_title'));
                app('view')->share('subTitleIcon', 'fa-check');

                $this->repository = app(ImportJobRepositoryInterface::class);

                return $next($request);
            }
        );
    }

    /**
     * This method will process and store import provider global prerequisites
     * such as API keys.
     *
     * @param string    $importProvider
     * @param ImportJob $importJob
     *
     * @return Factory|RedirectResponse|Redirector|View
     */
    public function index(string $importProvider, ImportJob $importJob = null)
    {
        // catch impossible status:
        $allowed = ['new'];
        if (null !== $importJob && !in_array($importJob->status, $allowed, true)) {
            Log::error(sprintf('Job has state "%s" but this Prerequisites::index() only accepts %s', $importJob->status, json_encode($allowed)));
            session()->flash('error', (string) trans('import.bad_job_status', ['status' => e($importJob->status)]));

            return redirect(route('import.index'));
        }

        app('view')->share('subTitle', (string) trans('import.prerequisites_breadcrumb_' . $importProvider));
        $class = (string) config(sprintf('import.prerequisites.%s', $importProvider));
        /** @var User $user */
        $user = auth()->user();
        /** @var PrerequisitesInterface $object */
        $object = app($class);
        $object->setUser($user);

        if (null !== $importJob && $object->isComplete()) {
            // update job:
            $this->repository->setStatus($importJob, 'has_prereq');

            // redirect to job config:
            return redirect(route('import.job.configuration.index', [$importJob->key]));
        }


        $view       = $object->getView();
        $parameters = ['title' => (string) trans('firefly.import_index_title'), 'mainTitleIcon' => 'fa-archive', 'importJob' => $importJob];
        $parameters = array_merge($object->getViewParameters(), $parameters);

        return view($view, $parameters);
    }

    /**
     * This method processes the prerequisites the user has entered in the previous step.
     *
     * Whatever storePrerequisites does, it should make sure that the system is ready to continue immediately. So
     * no extra calls or stuff, except maybe to open a session
     *
     * @param Request   $request
     * @param string    $importProvider
     * @param ImportJob $importJob
     *
     * @return RedirectResponse|Redirector
     * @see PrerequisitesInterface::storePrerequisites
     *
     */
    public function post(Request $request, string $importProvider, ImportJob $importJob = null)
    {
        Log::debug(sprintf('Now in postPrerequisites for %s', $importProvider));

        // catch impossible status:
        $allowed = ['new'];
        if (null !== $importJob && !in_array($importJob->status, $allowed, true)) {
            Log::error(sprintf('Job has state "%s" but this Prerequisites::post() only accepts %s', $importJob->status, json_encode($allowed)));
            session()->flash('error', (string) trans('import.bad_job_status', ['status' => e($importJob->status)]));

            return redirect(route('import.index'));
        }


        $class = (string) config(sprintf('import.prerequisites.%s', $importProvider));
        /** @var User $user */
        $user = auth()->user();
        /** @var PrerequisitesInterface $object */
        $object = app($class);
        $object->setUser($user);
        Log::debug('Going to store entered prerequisites.');
        // store post data
        $data   = $request->all();
        $result = $object->storePrerequisites($data);
        Log::debug(sprintf('Result of storePrerequisites has message count: %d', $result->count()));

        if ($result->count() > 0) {
            $request->session()->flash('error', e($result->first()));

            // redirect back to job, if has job:
            return redirect(route('import.prerequisites.index', [$importProvider, $importJob->key ?? '']))->withInput();
        }

        // session flash!
        $request->session()->flash('success', (string) trans('import.prerequisites_saved_for_' . $importProvider));

        // if has job, redirect to global config for provider
        // if no job, back to index!
        if (null === $importJob) {
            return redirect(route('import.index'));
        }

        // update job:
        $this->repository->setStatus($importJob, 'has_prereq');

        // redirect to job config:
        return redirect(route('import.job.configuration.index', [$importJob->key]));


    }
}