firefly-iii/app/Console/Commands/CreateImport.php

<?php
/**
 * CreateImport.php
 * Copyright (C) 2016 thegrumpydictator@gmail.com
 *
 * This software may be modified and distributed under the terms of the
 * Creative Commons Attribution-ShareAlike 4.0 International License.
 *
 * See the LICENSE file for details.
 */

declare(strict_types = 1);

namespace FireflyIII\Console\Commands;

use Artisan;
use FireflyIII\Repositories\ImportJob\ImportJobRepositoryInterface;
use FireflyIII\Repositories\User\UserRepositoryInterface;
use Illuminate\Console\Command;
use Log;

/**
 * Class CreateImport
 *
 * @package FireflyIII\Console\Commands
 */
class CreateImport extends Command
{
    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Use this command to create a new import. Your user ID can be found on the /profile page.';

    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'firefly:create-import {file} {configuration} {--user=1} {--type=csv} {--start}';

    /**
     * Create a new command instance.
     *
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        // find the file
        /** @var UserRepositoryInterface $userRepository */
        $userRepository = app(UserRepositoryInterface::class);
        $file           = $this->argument('file');
        $configuration  = $this->argument('configuration');
        $user           = $userRepository->find(intval($this->option('user')));
        $cwd            = getcwd();
        $type           = strtolower($this->option('type'));

        if (!$this->validArguments()) {
            return;
        }

        // try to parse configuration data:
        $configurationData = json_decode(file_get_contents($configuration));
        if (is_null($configurationData)) {
            $this->error(sprintf('Firefly III cannot read the contents of configuration file "%s" (working directory: "%s").', $configuration, $cwd));

            return;
        }

        $this->info(sprintf('Going to create a job to import file: %s', $file));
        $this->info(sprintf('Using configuration file: %s', $configuration));
        $this->info(sprintf('Import into user: #%d (%s)', $user->id, $user->email));
        $this->info(sprintf('Type of import: %s', $type));

        /** @var ImportJobRepositoryInterface $jobRepository */
        $jobRepository = app(ImportJobRepositoryInterface::class, [$user]);

        $job = $jobRepository->create($type);
        $this->line(sprintf('Created job "%s"...', $job->key));

        // put the file in the proper place:
        Artisan::call('firefly:encrypt', ['file' => $file, 'key' => $job->key]);
        $this->line('Stored import data...');

        // store the configuration in the job:
        $job->configuration = $configurationData;
        $job->status        = 'settings_complete';
        $job->save();
        $this->line('Stored configuration...');

        // if user wants to run it, do!
        if ($this->option('start') === true) {
            $this->line('The import will start in a moment. This process is not visible...');
            Log::debug('Go for import!');
            Artisan::call('firefly:start-import', ['key' => $job->key]);
            $this->line('Done!');
        }

        return;
    }

    /**
     * @return bool
     */
    private function validArguments(): bool
    {
        // find the file
        /** @var UserRepositoryInterface $userRepository */
        $userRepository = app(UserRepositoryInterface::class);
        $file           = $this->argument('file');
        $configuration  = $this->argument('configuration');
        $user           = $userRepository->find(intval($this->option('user')));
        $cwd            = getcwd();
        $validTypes     = array_keys(config('firefly.import_formats'));
        $type           = strtolower($this->option('type'));

        if (is_null($user->id)) {
            $this->error(sprintf('There is no user with ID %d.', $this->option('user')));

            return false;
        }
        if (!in_array($type, $validTypes)) {
            $this->error(sprintf('Cannot import file of type "%s"', $type));

            return false;
        }

        if (!file_exists($file)) {
            $this->error(sprintf('Firefly III cannot find file "%s" (working directory: "%s").', $file, $cwd));

            return false;
        }

        if (!file_exists($configuration)) {
            $this->error(sprintf('Firefly III cannot find configuration file "%s" (working directory: "%s").', $configuration, $cwd));

            return false;
        }

        return true;
    }
}