firefly-iii/app/Support/Import/JobConfiguration/File/ConfigureUploadHandler.php

<?php
/**
 * ConfigureUploadHandler.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\Support\Import\JobConfiguration\File;

use FireflyIII\Models\ImportJob;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Repositories\ImportJob\ImportJobRepositoryInterface;
use Illuminate\Support\MessageBag;
use Log;


/**
 * Class ConfigureUploadHandler
 */
class ConfigureUploadHandler implements FileConfigurationInterface
{
    /** @var AccountRepositoryInterface */
    private $accountRepos;
    /** @var ImportJob */
    private $importJob;
    /** @var ImportJobRepositoryInterface */
    private $repository;

    /**
     * Store data associated with current stage.
     *
     * @param array $data
     *
     * @return MessageBag
     */
    public function configureJob(array $data): MessageBag
    {
        $config   = $this->importJob->configuration;
        $complete = true;

        // collect values:
        $importId              = isset($data['csv_import_account']) ? (int)$data['csv_import_account'] : 0;
        $delimiter             = (string)$data['csv_delimiter'];
        $config['has-headers'] = 1 === (int)($data['has_headers'] ?? 0.0);
        $config['date-format'] = (string)$data['date_format'];
        $config['delimiter']   = 'tab' === $delimiter ? "\t" : $delimiter;
        $config['apply-rules'] = 1 === (int)($data['apply_rules'] ?? 0.0);
        $config['specifics']   = $this->getSpecifics($data);
        // validate values:
        $account = $this->accountRepos->findNull($importId);

        // respond to invalid account:
        if (null === $account) {
            Log::error('Could not find anything for csv_import_account.', ['id' => $importId]);
            $complete = false;
        }
        if (null !== $account) {
            $config['import-account'] = $account->id;
        }

        $this->repository->setConfiguration($this->importJob, $config);
        if ($complete) {
            $this->repository->setStage($this->importJob, 'roles');
        }
        if (!$complete) {
            $messages = new MessageBag;
            $messages->add('account', (string)trans('import.invalid_import_account'));

            return $messages;
        }

        return new MessageBag;
    }

    /**
     * Get the data necessary to show the configuration screen.
     *
     * @return array
     */
    public function getNextData(): array
    {
        $delimiters            = [
            ','   => (string)trans('form.csv_comma'),
            ';'   => (string)trans('form.csv_semicolon'),
            'tab' => (string)trans('form.csv_tab'),
        ];
        $config                = $this->importJob->configuration;
        $config['date-format'] = $config['date-format'] ?? 'Ymd';
        $specifics             = [];
        $this->repository->setConfiguration($this->importJob, $config);

        // collect specifics.
        foreach (config('csv.import_specifics') as $name => $className) {
            $specifics[$name] = [
                'name'        => trans($className::getName()),
                'description' => trans($className::getDescription()),
            ];
        }

        $data = [
            'accounts'   => [],
            'delimiters' => $delimiters,
            'specifics'  => $specifics,
        ];

        return $data;
    }

    /**
     * @param array $data
     *
     * @return array
     */
    public function getSpecifics(array $data): array
    {
        $return = [];
        // check if specifics given are correct:
        if (isset($data['specifics']) && is_array($data['specifics'])) {

            foreach ($data['specifics'] as $name) {
                // verify their content.
                $className = sprintf('FireflyIII\\Import\\Specifics\\%s', $name);
                if (class_exists($className)) {
                    $return[$name] = 1;
                }
            }
        }

        return $return;
    }

    /**
     * @param ImportJob $importJob
     */
    public function setImportJob(ImportJob $importJob): void
    {
        $this->importJob  = $importJob;
        $this->repository = app(ImportJobRepositoryInterface::class);
        $this->repository->setUser($importJob->user);
        $this->accountRepos = app(AccountRepositoryInterface::class);
        $this->accountRepos->setUser($importJob->user);

    }
}