firefly-iii/app/Import/JobConfiguration/FileJobConfiguration.php

<?php

/**
 * FileJobConfiguration.php
 * Copyright (c) 2019 thegrumpydictator@gmail.com
 *
 * 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\Import\JobConfiguration;


use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\ImportJob;
use FireflyIII\Repositories\ImportJob\ImportJobRepositoryInterface;
use FireflyIII\Support\Import\JobConfiguration\File\ConfigureMappingHandler;
use FireflyIII\Support\Import\JobConfiguration\File\ConfigureRolesHandler;
use FireflyIII\Support\Import\JobConfiguration\File\ConfigureUploadHandler;
use FireflyIII\Support\Import\JobConfiguration\File\FileConfigurationInterface;
use FireflyIII\Support\Import\JobConfiguration\File\NewFileJobHandler;
use Illuminate\Support\MessageBag;

/**
 * Class FileJobConfiguration
 */
class FileJobConfiguration implements JobConfigurationInterface
{
    /** @var ImportJob The import job */
    private $importJob;
    /** @var ImportJobRepositoryInterface Import job repository */
    private $repository;

    /**
     * Returns true when the initial configuration for this job is complete.
     *
     * @return bool
     */
    public function configurationComplete(): bool
    {
        return 'ready_to_run' === $this->importJob->stage;
    }

    /**
     * Store any data from the $data array into the job. Anything in the message bag will be flashed
     * as an error to the user, regardless of its content.
     *
     * @param array $data
     *
     * @return MessageBag
     * @throws FireflyException
     */
    public function configureJob(array $data): MessageBag
    {
        $configurator = $this->getConfigurationObject();
        $configurator->setImportJob($this->importJob);

        return $configurator->configureJob($data);
    }

    /**
     * Return the data required for the next step in the job configuration.
     *
     * @throws FireflyException
     * @return array
     */
    public function getNextData(): array
    {
        $configurator = $this->getConfigurationObject();
        $configurator->setImportJob($this->importJob);

        return $configurator->getNextData();
    }

    /**
     * Returns the view of the next step in the job configuration.
     *
     * @return string
     *
     *@throws FireflyException
     */
    public function getNextView(): string
    {
        switch ($this->importJob->stage) {
            case 'new':
                return 'import.file.new';
            case 'configure-upload':
                return 'import.file.configure-upload';
            case 'roles':
                return 'import.file.roles';
            case 'map':
                return 'import.file.map';
            default:
                // @codeCoverageIgnoreStart
                throw new FireflyException(
                    sprintf('FileJobConfiguration::getNextView() cannot handle stage "%s"', $this->importJob->stage)
                );
            // @codeCoverageIgnoreEnd
        }
    }

    /**
     * Set import job.
     *
     * @param ImportJob $importJob
     */
    public function setImportJob(ImportJob $importJob): void
    {
        $this->importJob  = $importJob;
        $this->repository = app(ImportJobRepositoryInterface::class);
        $this->repository->setUser($importJob->user);
    }

    /**
     * Get the configuration handler for this specific stage.
     *
     * @return FileConfigurationInterface
     * @throws FireflyException
     *
     */
    private function getConfigurationObject(): FileConfigurationInterface
    {
        $class = 'DoNotExist';
        switch ($this->importJob->stage) {
            case 'new': // has nothing, no file upload or anything.
                $class = NewFileJobHandler::class;
                break;
            case 'configure-upload':
                $class = ConfigureUploadHandler::class;
                break;
            case 'roles':
                $class = ConfigureRolesHandler::class;
                break;
            case 'map':
                $class = ConfigureMappingHandler::class;
                break;
        }
        if (!class_exists($class)) {
            throw new FireflyException(sprintf('Class %s does not exist in getConfigurationClass().', $class)); // @codeCoverageIgnore
        }

        return app($class);
    }
}