IntenseFinance/firefly-iii
3
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-02-25 18:45:27 -06:00
Code Issues Packages Projects Releases Wiki Activity

Various cleanup in import.

Browse Source
This commit is contained in:
James Cole 2018-01-10 18:18:49 +01:00
parent 87dae6ea18
commit 91178d2604
No known key found for this signature in database
GPG Key ID: C16961E655E74B5E
10 changed files with 272 additions and 153 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
app/Import/Configuration/FileConfigurator.php
View File

@ -88,11 +88,9 @@ class FileConfigurator implements ConfiguratorInterface
if (is_null($this->job)) { if (is_null($this->job)) {
throw new FireflyException('Cannot call configureJob() without a job.'); throw new FireflyException('Cannot call configureJob() without a job.');
} }
$class = $this->getConfigurationClass();
$job = $this->job;
/** @var ConfigurationInterface $object */ /** @var ConfigurationInterface $object */
$object = app($class); $object = app($this->getConfigurationClass());
$object->setJob($job); $object->setJob($this->job);
$result = $object->storeConfiguration($data); $result = $object->storeConfiguration($data);
$this->warning = $object->getWarningMessage(); $this->warning = $object->getWarningMessage();
@ -111,12 +109,9 @@ class FileConfigurator implements ConfiguratorInterface
if (is_null($this->job)) { if (is_null($this->job)) {
throw new FireflyException('Cannot call getNextData() without a job.'); throw new FireflyException('Cannot call getNextData() without a job.');
} }
$class = $this->getConfigurationClass();
$job = $this->job;
/** @var ConfigurationInterface $object */ /** @var ConfigurationInterface $object */
$object = app($class); $object = app($this->getConfigurationClass());
$object->setJob($job); $object->setJob($this->job);
return $object->getData(); return $object->getData();
} }

96
app/Import/Configuration/SpectreConfigurator.php
View File

@ -24,6 +24,7 @@ namespace FireflyIII\Import\Configuration;
use FireflyIII\Exceptions\FireflyException; use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\ImportJob; use FireflyIII\Models\ImportJob;
use FireflyIII\Repositories\ImportJob\ImportJobRepositoryInterface;
use FireflyIII\Support\Import\Configuration\Spectre\HaveAccounts; use FireflyIII\Support\Import\Configuration\Spectre\HaveAccounts;
use Log; use Log;
@ -35,6 +36,9 @@ class SpectreConfigurator implements ConfiguratorInterface
/** @var ImportJob */ /** @var ImportJob */
private $job; private $job;
/** @var ImportJobRepositoryInterface */
private $repository;
/** @var string */ /** @var string */
private $warning = ''; private $warning = '';
@ -51,12 +55,14 @@ class SpectreConfigurator implements ConfiguratorInterface
* @param array $data * @param array $data
* *
* @return bool * @return bool
* @throws FireflyException
*/ */
public function configureJob(array $data): bool public function configureJob(array $data): bool
{ {
$config = $this->job->configuration; if (is_null($this->job)) {
$stage = $config['stage']; throw new FireflyException('Cannot call configureJob() without a job.');
$status = $this->job->status; }
$stage = $this->getConfig()['stage'] ?? 'initial';
Log::debug(sprintf('in getNextData(), for stage "%s".', $stage)); Log::debug(sprintf('in getNextData(), for stage "%s".', $stage));
switch ($stage) { switch ($stage) {
case 'have-accounts': case 'have-accounts':
@ -66,11 +72,10 @@ class SpectreConfigurator implements ConfiguratorInterface
$class->storeConfiguration($data); $class->storeConfiguration($data);
// update job for next step and set to "configured". // update job for next step and set to "configured".
$config = $this->job->configuration; $config = $this->getConfig();
$config['stage'] = 'have-account-mapping'; $config['stage'] = 'have-account-mapping';
$this->job->configuration = $config; $this->repository->setConfiguration($this->job, $config);
$this->job->status = 'configured';
$this->job->save();
return true; return true;
break; break;
default: default:
@ -83,12 +88,14 @@ class SpectreConfigurator implements ConfiguratorInterface
* Return the data required for the next step in the job configuration. * Return the data required for the next step in the job configuration.
* *
* @return array * @return array
* @throws FireflyException
*/ */
public function getNextData(): array public function getNextData(): array
{ {
$config = $this->job->configuration; if (is_null($this->job)) {
$stage = $config['stage']; throw new FireflyException('Cannot call configureJob() without a job.');
$status = $this->job->status; }
$stage = $this->getConfig()['stage'] ?? 'initial';
Log::debug(sprintf('in getNextData(), for stage "%s".', $stage)); Log::debug(sprintf('in getNextData(), for stage "%s".', $stage));
switch ($stage) { switch ($stage) {
case 'has-token': case 'has-token':
@ -96,6 +103,12 @@ class SpectreConfigurator implements ConfiguratorInterface
$config['is-redirected'] = true; $config['is-redirected'] = true;
$config['stage'] = 'user-logged-in'; $config['stage'] = 'user-logged-in';
$status = 'configured'; $status = 'configured';
// update config and status:
$this->repository->setConfiguration($this->job, $config);
$this->repository->setStatus($this->job, $status);
return $this->repository->getConfiguration($this->job);
break; break;
case 'have-accounts': case 'have-accounts':
// use special class: // use special class:
@ -108,29 +121,25 @@ class SpectreConfigurator implements ConfiguratorInterface
default: default:
return []; return [];
break; break;
} }
// update config and status:
$this->job->configuration = $config;
$this->job->status = $status;
$this->job->save();
return $this->job->configuration;
} }
/** /**
* @return string * @return string
* @throws FireflyException
*/ */
public function getNextView(): string public function getNextView(): string
{ {
$config = $this->job->configuration; if (is_null($this->job)) {
$stage = $config['stage']; throw new FireflyException('Cannot call configureJob() without a job.');
}
$stage = $this->getConfig()['stage'] ?? 'initial';
Log::debug(sprintf('in getNextView(), for stage "%s".', $stage)); Log::debug(sprintf('in getNextView(), for stage "%s".', $stage));
switch ($stage) { switch ($stage) {
case 'has-token': case 'has-token':
// redirect to Spectre. // redirect to Spectre.
Log::info('User is being redirected to Spectre.'); Log::info('User is being redirected to Spectre.');
return 'import.spectre.redirect'; return 'import.spectre.redirect';
break; break;
case 'have-accounts': case 'have-accounts':
@ -155,11 +164,14 @@ class SpectreConfigurator implements ConfiguratorInterface
/** /**
* @return bool * @return bool
* @throws FireflyException
*/ */
public function isJobConfigured(): bool public function isJobConfigured(): bool
{ {
$config = $this->job->configuration; if (is_null($this->job)) {
$stage = $config['stage']; throw new FireflyException('Cannot call configureJob() without a job.');
}
$stage = $this->getConfig()['stage'] ?? 'initial';
Log::debug(sprintf('in isJobConfigured(), for stage "%s".', $stage)); Log::debug(sprintf('in isJobConfigured(), for stage "%s".', $stage));
switch ($stage) { switch ($stage) {
case 'has-token': case 'has-token':
@ -177,9 +189,14 @@ class SpectreConfigurator implements ConfiguratorInterface
/** /**
* @param ImportJob $job * @param ImportJob $job
*/ */
public function setJob(ImportJob $job) public function setJob(ImportJob $job): void
{ {
$defaultConfig = [ // make repository
$this->repository = app(ImportJobRepositoryInterface::class);
$this->repository->setUser($job->user);
// set default config:
$defaultConfig = [
'has-token' => false, 'has-token' => false,
'token' => '', 'token' => '',
'token-expires' => 0, 'token-expires' => 0,
@ -191,16 +208,31 @@ class SpectreConfigurator implements ConfiguratorInterface
'accounts' => '', 'accounts' => '',
'accounts-mapped' => '', 'accounts-mapped' => '',
'auto-start' => true, 'auto-start' => true,
'apply-rules' => true,
'match-bills' => false,
]; ];
$extendedStatus = $job->extended_status; $currentConfig = $this->repository->getConfiguration($job);
$finalConfig = array_merge($defaultConfig, $currentConfig);
// set default extended status:
$extendedStatus = $this->repository->getExtendedStatus($job);
$extendedStatus['steps'] = 100; $extendedStatus['steps'] = 100;
// save to job:
$config = $job->configuration; $job = $this->repository->setConfiguration($job, $finalConfig);
$finalConfig = array_merge($defaultConfig, $config); $job = $this->repository->setExtendedStatus($job, $extendedStatus);
$job->configuration = $finalConfig;
$job->extended_status = $extendedStatus;
$job->save();
$this->job = $job; $this->job = $job;
return;
}
/**
* Shorthand method.
*
* @return array
*/
private function getConfig(): array
{
return $this->repository->getConfiguration($this->job);
} }
} }

21
app/Import/FileProcessor/CsvProcessor.php
View File

@ -98,7 +98,7 @@ class CsvProcessor implements FileProcessorInterface
if ($this->rowAlreadyImported($row)) { if ($this->rowAlreadyImported($row)) {
$message = sprintf('Row #%d has already been imported.', $index); $message = sprintf('Row #%d has already been imported.', $index);
$this->repository->addStepsDone($this->job, 5); $this->repository->addStepsDone($this->job, 5);
$this->addError($index, $message); $this->repository->addError($this->job, $index, $message);
Log::info($message); Log::info($message);
return null; return null;
@ -154,23 +154,6 @@ class CsvProcessor implements FileProcessorInterface
return $this; return $this;
} }
/**
* Shorthand method.
*
* @codeCoverageIgnore
*
* @param int $index
* @param string $message
*/
private function addError(int $index, string $message): void
{
$extended = $this->getExtendedStatus();
$extended['errors'][$index][] = $message;
$this->setExtendedStatus($extended);
return;
}
/** /**
* Add meta data to the individual value and verify that it can be handled in a later stage. * Add meta data to the individual value and verify that it can be handled in a later stage.
* *
@ -375,7 +358,7 @@ class CsvProcessor implements FileProcessorInterface
*/ */
private function specifics(array $row): array private function specifics(array $row): array
{ {
$config = $this->job->configuration; $config = $this->getConfig();
$names = array_keys($config['specifics'] ?? []); $names = array_keys($config['specifics'] ?? []);
foreach ($names as $name) { foreach ($names as $name) {
if (!in_array($name, $this->validSpecifics)) { if (!in_array($name, $this->validSpecifics)) {

85
app/Import/Routine/FileRoutine.php
View File

@ -28,6 +28,7 @@ use FireflyIII\Import\FileProcessor\FileProcessorInterface;
use FireflyIII\Import\Storage\ImportStorage; use FireflyIII\Import\Storage\ImportStorage;
use FireflyIII\Models\ImportJob; use FireflyIII\Models\ImportJob;
use FireflyIII\Models\Tag; use FireflyIII\Models\Tag;
use FireflyIII\Repositories\ImportJob\ImportJobRepositoryInterface;
use FireflyIII\Repositories\Tag\TagRepositoryInterface; use FireflyIII\Repositories\Tag\TagRepositoryInterface;
use Illuminate\Support\Collection; use Illuminate\Support\Collection;
use Log; use Log;
@ -46,6 +47,9 @@ class FileRoutine implements RoutineInterface
/** @var ImportJob */ /** @var ImportJob */
private $job; private $job;
/** @var ImportJobRepositoryInterface */
private $repository;
/** /**
* ImportRoutine constructor. * ImportRoutine constructor.
*/ */
@ -84,8 +88,8 @@ class FileRoutine implements RoutineInterface
*/ */
public function run(): bool public function run(): bool
{ {
if ('configured' !== $this->job->status) { if ('configured' !== $this->getStatus()) {
Log::error(sprintf('Job %s is in state "%s" so it cannot be started.', $this->job->key, $this->job->status)); Log::error(sprintf('Job %s is in state "%s" so it cannot be started.', $this->job->key, $this->getStatus()));
return false; return false;
} }
@ -102,8 +106,7 @@ class FileRoutine implements RoutineInterface
Log::debug('Back in run()'); Log::debug('Back in run()');
// update job: // update job:
$this->job->status = 'finished'; $this->setStatus('finished');
$this->job->save();
Log::debug('Updated job...'); Log::debug('Updated job...');
Log::debug(sprintf('%d journals in $storage->journals', $storage->journals->count())); Log::debug(sprintf('%d journals in $storage->journals', $storage->journals->count()));
@ -125,7 +128,9 @@ class FileRoutine implements RoutineInterface
*/ */
public function setJob(ImportJob $job) public function setJob(ImportJob $job)
{ {
$this->job = $job; $this->job = $job;
$this->repository = app(ImportJobRepositoryInterface::class);
$this->repository->setUser($job->user);
} }
/** /**
@ -134,18 +139,16 @@ class FileRoutine implements RoutineInterface
protected function getImportObjects(): Collection protected function getImportObjects(): Collection
{ {
$objects = new Collection; $objects = new Collection;
$config = $this->job->configuration; $fileType = $this->getConfig()['file-type'] ?? 'csv';
$fileType = $config['file-type'] ?? 'csv';
// will only respond to "file" // will only respond to "file"
$class = config(sprintf('import.options.file.processors.%s', $fileType)); $class = config(sprintf('import.options.file.processors.%s', $fileType));
/** @var FileProcessorInterface $processor */ /** @var FileProcessorInterface $processor */
$processor = app($class); $processor = app($class);
$processor->setJob($this->job); $processor->setJob($this->job);
if ('configured' === $this->job->status) { if ('configured' === $this->getStatus()) {
// set job as "running"... // set job as "running"...
$this->job->status = 'running'; $this->setStatus('running');
$this->job->save();
Log::debug('Job is configured, start with run()'); Log::debug('Job is configured, start with run()');
$processor->run(); $processor->run();
@ -171,7 +174,7 @@ class FileRoutine implements RoutineInterface
/** @var TagRepositoryInterface $repository */ /** @var TagRepositoryInterface $repository */
$repository = app(TagRepositoryInterface::class); $repository = app(TagRepositoryInterface::class);
$repository->setUser($this->job->user); $repository->setUser($this->job->user);
$data = [ $data = [
'tag' => trans('import.import_with_key', ['key' => $this->job->key]), 'tag' => trans('import.import_with_key', ['key' => $this->job->key]),
'date' => new Carbon, 'date' => new Carbon,
'description' => null, 'description' => null,
@ -180,11 +183,10 @@ class FileRoutine implements RoutineInterface
'zoomLevel' => null, 'zoomLevel' => null,
'tagMode' => 'nothing', 'tagMode' => 'nothing',
]; ];
$tag = $repository->store($data); $tag = $repository->store($data);
$extended = $this->job->extended_status; $extended = $this->getExtendedStatus();
$extended['tag'] = $tag->id; $extended['tag'] = $tag->id;
$this->job->extended_status = $extended; $this->setExtendedStatus($extended);
$this->job->save();
Log::debug(sprintf('Created tag #%d ("%s")', $tag->id, $tag->tag)); Log::debug(sprintf('Created tag #%d ("%s")', $tag->id, $tag->tag));
Log::debug('Looping journals...'); Log::debug('Looping journals...');
@ -199,6 +201,54 @@ class FileRoutine implements RoutineInterface
return $tag; return $tag;
} }
/**
* Shorthand method
*
* @return array
*/
private function getConfig(): array
{
return $this->repository->getConfiguration($this->job);
}
/**
* @return array
*/
private function getExtendedStatus(): array
{
return $this->repository->getExtendedStatus($this->job);
}
/**
* Shorthand method.
*
* @return string
*/
private function getStatus(): string
{
return $this->repository->getStatus($this->job);
}
/**
* @param array $extended
*/
private function setExtendedStatus(array $extended): void
{
$this->repository->setExtendedStatus($this->job, $extended);
return;
}
/**
* Shorthand
*
* @param string $status
*/
private function setStatus(string $status): void
{
$this->repository->setStatus($this->job, $status);
}
/** /**
* @param Collection $objects * @param Collection $objects
* *
@ -206,9 +256,10 @@ class FileRoutine implements RoutineInterface
*/ */
private function storeObjects(Collection $objects): ImportStorage private function storeObjects(Collection $objects): ImportStorage
{ {
$config = $this->getConfig();
$storage = new ImportStorage; $storage = new ImportStorage;
$storage->setJob($this->job); $storage->setJob($this->job);
$storage->setDateFormat($this->job->configuration['date-format']); $storage->setDateFormat($config['date-format']);
$storage->setObjects($objects); $storage->setObjects($objects);
$storage->store(); $storage->store();
Log::info('Back in storeObjects()'); Log::info('Back in storeObjects()');

123
app/Import/Routine/SpectreRoutine.php
View File

@ -122,15 +122,14 @@ class SpectreRoutine implements RoutineInterface
*/ */
public function run(): bool public function run(): bool
{ {
if ('configured' === $this->job->status) { if ('configured' === $this->getStatus()) {
$this->repository->updateStatus($this->job, 'running'); $this->repository->updateStatus($this->job, 'running');
} }
Log::info(sprintf('Start with import job %s using Spectre.', $this->job->key)); Log::info(sprintf('Start with import job %s using Spectre.', $this->job->key));
set_time_limit(0); set_time_limit(0);
// check if job has token first! // check if job has token first!
$config = $this->job->configuration; $stage = $this->getConfig()['stage'] ?? 'unknown';
$stage = $config['stage'];
switch ($stage) { switch ($stage) {
case 'initial': case 'initial':
@ -205,21 +204,20 @@ class SpectreRoutine implements RoutineInterface
*/ */
protected function getCustomer(): Customer protected function getCustomer(): Customer
{ {
$config = $this->job->configuration; $config = $this->getConfig();
if (!is_null($config['customer'])) { if (!is_null($config['customer'])) {
$customer = new Customer($config['customer']); $customer = new Customer($config['customer']);
return $customer; return $customer;
} }
$customer = $this->createCustomer(); $customer = $this->createCustomer();
$config['customer'] = [ $config['customer'] = [
'id' => $customer->getId(), 'id' => $customer->getId(),
'identifier' => $customer->getIdentifier(), 'identifier' => $customer->getIdentifier(),
'secret' => $customer->getSecret(), 'secret' => $customer->getSecret(),
]; ];
$this->job->configuration = $config; $this->setConfig($config);
$this->job->save();
return $customer; return $customer;
} }
@ -268,19 +266,18 @@ class SpectreRoutine implements RoutineInterface
$this->repository->addStepsDone($this->job, 2); $this->repository->addStepsDone($this->job, 2);
// update job, give it the token: // update job, give it the token:
$config = $this->job->configuration; $config = $this->getConfig();
$config['has-token'] = true; $config['has-token'] = true;
$config['token'] = $token->getToken(); $config['token'] = $token->getToken();
$config['token-expires'] = $token->getExpiresAt()->format('U'); $config['token-expires'] = $token->getExpiresAt()->format('U');
$config['token-url'] = $token->getConnectUrl(); $config['token-url'] = $token->getConnectUrl();
$config['stage'] = 'has-token'; $config['stage'] = 'has-token';
$this->job->configuration = $config; $this->setConfig($config);
Log::debug('Job config is now', $config); Log::debug('Job config is now', $config);
// update job, set status to "configuring". // update job, set status to "configuring".
$this->job->status = 'configuring'; $this->setStatus('configuring');
$this->job->save();
Log::debug(sprintf('Job status is now %s', $this->job->status)); Log::debug(sprintf('Job status is now %s', $this->job->status));
} }
@ -319,7 +316,8 @@ class SpectreRoutine implements RoutineInterface
$this->repository->addError($this->job, 0, 'Spectre connection failed. Did you use invalid credentials, press Cancel or failed the 2FA challenge?'); $this->repository->addError($this->job, 0, 'Spectre connection failed. Did you use invalid credentials, press Cancel or failed the 2FA challenge?');
$this->repository->setTotalSteps($this->job, 1); $this->repository->setTotalSteps($this->job, 1);
$this->repository->setStepsDone($this->job, 1); $this->repository->setStepsDone($this->job, 1);
$this->repository->setStatus($this->job,'error'); $this->repository->setStatus($this->job, 'error');
return; return;
} }
@ -343,13 +341,13 @@ class SpectreRoutine implements RoutineInterface
} }
// update job: // update job:
$config = $this->job->configuration; $config = $this->getConfig();
$config['accounts'] = $all; $config['accounts'] = $all;
$config['login'] = $login->toArray(); $config['login'] = $login->toArray();
$config['stage'] = 'have-accounts'; $config['stage'] = 'have-accounts';
$this->job->configuration = $config;
$this->job->status = 'configuring'; $this->setConfig($config);
$this->job->save(); $this->setStatus('configuring');
// add some steps done // add some steps done
$this->repository->addStepsDone($this->job, 2); $this->repository->addStepsDone($this->job, 2);
@ -357,6 +355,32 @@ class SpectreRoutine implements RoutineInterface
return; return;
} }
/**
* @return array
*/
private function getConfig(): array
{
return $this->repository->getConfiguration($this->job);
}
/**
* @return array
*/
private function getExtendedStatus(): array
{
return $this->repository->getExtendedStatus($this->job);
}
/**
* Shorthand method.
*
* @return string
*/
private function getStatus(): string
{
return $this->repository->getStatus($this->job);
}
/** /**
* @param array $all * @param array $all
* *
@ -433,7 +457,7 @@ class SpectreRoutine implements RoutineInterface
/** @var TagRepositoryInterface $repository */ /** @var TagRepositoryInterface $repository */
$repository = app(TagRepositoryInterface::class); $repository = app(TagRepositoryInterface::class);
$repository->setUser($this->job->user); $repository->setUser($this->job->user);
$data = [ $data = [
'tag' => trans('import.import_with_key', ['key' => $this->job->key]), 'tag' => trans('import.import_with_key', ['key' => $this->job->key]),
'date' => new Carbon, 'date' => new Carbon,
'description' => null, 'description' => null,
@ -442,11 +466,10 @@ class SpectreRoutine implements RoutineInterface
'zoomLevel' => null, 'zoomLevel' => null,
'tagMode' => 'nothing', 'tagMode' => 'nothing',
]; ];
$tag = $repository->store($data); $tag = $repository->store($data);
$extended = $this->job->extended_status; $extended = $this->getExtendedStatus();
$extended['tag'] = $tag->id; $extended['tag'] = $tag->id;
$this->job->extended_status = $extended; $this->setExtendedStatus($extended);
$this->job->save();
Log::debug(sprintf('Created tag #%d ("%s")', $tag->id, $tag->tag)); Log::debug(sprintf('Created tag #%d ("%s")', $tag->id, $tag->tag));
Log::debug('Looping journals...'); Log::debug('Looping journals...');
@ -460,8 +483,7 @@ class SpectreRoutine implements RoutineInterface
// set status to "finished"? // set status to "finished"?
// update job: // update job:
$this->job->status = 'finished'; $this->setStatus('finished');
$this->job->save();
return; return;
} }
@ -472,8 +494,7 @@ class SpectreRoutine implements RoutineInterface
*/ */
private function runStageHaveMapping() private function runStageHaveMapping()
{ {
$config = $this->job->configuration; $accounts = $this->getConfig()['accounts'] ?? [];
$accounts = $config['accounts'] ?? [];
$all = []; $all = [];
$count = 0; $count = 0;
/** @var array $accountArray */ /** @var array $accountArray */
@ -508,4 +529,36 @@ class SpectreRoutine implements RoutineInterface
$this->importTransactions($all); $this->importTransactions($all);
} }
/**
* Shorthand.
*
* @param array $config
*/
private function setConfig(array $config): void
{
$this->repository->setConfiguration($this->job, $config);
return;
}
/**
* @param array $extended
*/
private function setExtendedStatus(array $extended): void
{
$this->repository->setExtendedStatus($this->job, $extended);
return;
}
/**
* Shorthand.
*
* @param string $status
*/
private function setStatus(string $status): void
{
$this->repository->setStatus($this->job, $status);
}
} }

30
app/Import/Storage/ImportStorage.php
View File

@ -30,6 +30,7 @@ use FireflyIII\Models\ImportJob;
use FireflyIII\Models\Note; use FireflyIII\Models\Note;
use FireflyIII\Models\TransactionType; use FireflyIII\Models\TransactionType;
use FireflyIII\Repositories\Bill\BillRepositoryInterface; use FireflyIII\Repositories\Bill\BillRepositoryInterface;
use FireflyIII\Repositories\ImportJob\ImportJobRepositoryInterface;
use Illuminate\Support\Collection; use Illuminate\Support\Collection;
use Log; use Log;
@ -53,6 +54,8 @@ class ImportStorage
protected $defaultCurrencyId = 1; protected $defaultCurrencyId = 1;
/** @var ImportJob */ /** @var ImportJob */
protected $job; protected $job;
/** @var ImportJobRepositoryInterface */
protected $repository;
/** @var Collection */ /** @var Collection */
protected $rules; protected $rules;
/** @var bool */ /** @var bool */
@ -63,7 +66,8 @@ class ImportStorage
private $matchBills = false; private $matchBills = false;
/** @var Collection */ /** @var Collection */
private $objects; private $objects;
private $total = 0; /** @var int */
private $total = 0;
/** @var array */ /** @var array */
private $transfers = []; private $transfers = [];
@ -90,13 +94,17 @@ class ImportStorage
*/ */
public function setJob(ImportJob $job) public function setJob(ImportJob $job)
{ {
$this->job = $job; $this->repository = app(ImportJobRepositoryInterface::class);
$this->repository->setUser($job->user);
$config = $this->repository->getConfiguration($job);
$currency = app('amount')->getDefaultCurrencyByUser($this->job->user); $currency = app('amount')->getDefaultCurrencyByUser($this->job->user);
$this->defaultCurrencyId = $currency->id; $this->defaultCurrencyId = $currency->id;
$this->transfers = $this->getTransfers(); $this->transfers = $this->getTransfers();
$config = $job->configuration;
$this->applyRules = $config['apply-rules'] ?? false; $this->applyRules = $config['apply-rules'] ?? false;
$this->matchBills = $config['match-bills'] ?? false; $this->matchBills = $config['match-bills'] ?? false;
if (true === $this->applyRules) { if (true === $this->applyRules) {
Log::debug('applyRules seems to be true, get the rules.'); Log::debug('applyRules seems to be true, get the rules.');
$this->rules = $this->getRules(); $this->rules = $this->getRules();
@ -109,6 +117,10 @@ class ImportStorage
} }
Log::debug(sprintf('Value of apply rules is %s', var_export($this->applyRules, true))); Log::debug(sprintf('Value of apply rules is %s', var_export($this->applyRules, true)));
Log::debug(sprintf('Value of match bills is %s', var_export($this->matchBills, true))); Log::debug(sprintf('Value of match bills is %s', var_export($this->matchBills, true)));
$this->job = $job;
} }
/** /**
@ -152,7 +164,7 @@ class ImportStorage
*/ */
protected function storeImportJournal(int $index, ImportJournal $importJournal): bool protected function storeImportJournal(int $index, ImportJournal $importJournal): bool
{ {
Log::debug(sprintf('Going to store object #%d/%d with description "%s"', ($index+1), $this->total, $importJournal->getDescription())); Log::debug(sprintf('Going to store object #%d/%d with description "%s"', ($index + 1), $this->total, $importJournal->getDescription()));
$assetAccount = $importJournal->asset->getAccount(); $assetAccount = $importJournal->asset->getAccount();
$amount = $importJournal->getAmount(); $amount = $importJournal->getAmount();
$currencyId = $this->getCurrencyId($importJournal); $currencyId = $this->getCurrencyId($importJournal);
@ -163,7 +175,7 @@ class ImportStorage
$description = $importJournal->getDescription(); $description = $importJournal->getDescription();
// First step done! // First step done!
$this->job->addStepsDone(1); $this->repository->addStepsDone($this->job, 1);
/** /**
* Check for double transfer. * Check for double transfer.
@ -177,7 +189,7 @@ class ImportStorage
'opposing' => $opposingAccount->name, 'opposing' => $opposingAccount->name,
]; ];
if ($this->isDoubleTransfer($parameters) || $this->hashAlreadyImported($importJournal->hash)) { if ($this->isDoubleTransfer($parameters) || $this->hashAlreadyImported($importJournal->hash)) {
$this->job->addStepsDone(3); $this->repository->addStepsDone($this->job, 3);
// throw error // throw error
$message = sprintf('Detected a possible duplicate, skip this one (hash: %s).', $importJournal->hash); $message = sprintf('Detected a possible duplicate, skip this one (hash: %s).', $importJournal->hash);
Log::error($message, $parameters); Log::error($message, $parameters);
@ -201,7 +213,7 @@ class ImportStorage
unset($parameters); unset($parameters);
// Another step done! // Another step done!
$this->job->addStepsDone(1); $this->repository->addStepsDone($this->job, 1);
// store meta object things: // store meta object things:
$this->storeCategory($journal, $importJournal->category->getCategory()); $this->storeCategory($journal, $importJournal->category->getCategory());
@ -225,7 +237,7 @@ class ImportStorage
$journal->save(); $journal->save();
// Another step done! // Another step done!
$this->job->addStepsDone(1); $this->repository->addStepsDone($this->job, 1);
// run rules if config calls for it: // run rules if config calls for it:
if (true === $this->applyRules) { if (true === $this->applyRules) {
@ -247,7 +259,7 @@ class ImportStorage
} }
// Another step done! // Another step done!
$this->job->addStepsDone(1); $this->repository->addStepsDone($this->job, 1);
$this->journals->push($journal); $this->journals->push($journal);
Log::info(sprintf('Imported new journal #%d: "%s", amount %s %s.', $journal->id, $journal->description, $journal->transactionCurrency->code, $amount)); Log::info(sprintf('Imported new journal #%d: "%s", amount %s %s.', $journal->id, $journal->description, $journal->transactionCurrency->code, $amount));

2
app/Import/Storage/ImportSupport.php
View File

@ -436,7 +436,7 @@ trait ImportSupport
if (!$journal->save()) { if (!$journal->save()) {
$errorText = join(', ', $journal->getErrors()->all()); $errorText = join(', ', $journal->getErrors()->all());
// add three steps: // add three steps:
$this->job->addStepsDone(3); $this->repository->addStepsDone($this->job, 3);
// throw error // throw error
throw new FireflyException($errorText); throw new FireflyException($errorText);
} }

27
app/Models/ImportJob.php
View File

@ -82,33 +82,6 @@ class ImportJob extends Model
throw new NotFoundHttpException; throw new NotFoundHttpException;
} }
/**
* @param int $index
* @param string $message
*
* @return bool
*/
public function addError(int $index, string $message): bool
{
$extended = $this->extended_status;
$extended['errors'][$index][] = $message;
$this->extended_status = $extended;
return true;
}
/**
* @param int $count
*/
public function addStepsDone(int $count)
{
$status = $this->extended_status;
$status['done'] += $count;
$this->extended_status = $status;
$this->save();
Log::debug(sprintf('Add %d to steps done for job "%s" making steps done %d', $count, $this->key, $status['done']));
}
/** /**
* @param int $count * @param int $count
*/ */

21
app/Repositories/ImportJob/ImportJobRepository.php
View File

@ -51,9 +51,10 @@ class ImportJobRepository implements ImportJobRepositoryInterface
*/ */
public function addError(ImportJob $job, int $index, string $error): ImportJob public function addError(ImportJob $job, int $index, string $error): ImportJob
{ {
$job->addError($index, $error); $extended = $this->getExtendedStatus($job);
$extended['errors'][$index][] = $error;
return $job; return $this->setExtendedStatus($job, $extended);
} }
/** /**
@ -64,9 +65,11 @@ class ImportJobRepository implements ImportJobRepositoryInterface
*/ */
public function addStepsDone(ImportJob $job, int $steps = 1): ImportJob public function addStepsDone(ImportJob $job, int $steps = 1): ImportJob
{ {
$job->addStepsDone($steps); $status = $this->getExtendedStatus($job);
$status['done'] += $steps;
Log::debug(sprintf('Add %d to steps done for job "%s" making steps done %d', $steps, $job->key, $status['done']));
return $job; return $this->setExtendedStatus($status);
} }
/** /**
@ -175,6 +178,16 @@ class ImportJobRepository implements ImportJobRepositoryInterface
return []; return [];
} }
/**
* @param ImportJob $job
*
* @return string
*/
public function getStatus(ImportJob $job): string
{
return $job->status;
}
/** /**
* @param ImportJob $job * @param ImportJob $job
* @param UploadedFile $file * @param UploadedFile $file

7
app/Repositories/ImportJob/ImportJobRepositoryInterface.php
View File

@ -90,6 +90,13 @@ interface ImportJobRepositoryInterface
*/ */
public function getExtendedStatus(ImportJob $job): array; public function getExtendedStatus(ImportJob $job): array;
/**
* @param ImportJob $job
*
* @return string
*/
public function getStatus(ImportJob $job);
/** /**
* @param ImportJob $job * @param ImportJob $job
* @param UploadedFile $file * @param UploadedFile $file