mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-10-31 10:47:00 +00:00
428 lines
14 KiB
PHP
428 lines
14 KiB
PHP
<?php
|
|
/**
|
|
* ImportStorage.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\Import;
|
|
|
|
use Carbon\Carbon;
|
|
use FireflyIII\Exceptions\FireflyException;
|
|
use FireflyIII\Models\ImportJob;
|
|
use FireflyIII\Models\Rule;
|
|
use FireflyIII\Models\Tag;
|
|
use FireflyIII\Models\Transaction;
|
|
use FireflyIII\Models\TransactionJournal;
|
|
use FireflyIII\Models\TransactionJournalMeta;
|
|
use FireflyIII\Models\TransactionType;
|
|
use FireflyIII\Repositories\Tag\TagRepositoryInterface;
|
|
use FireflyIII\Rules\Processor;
|
|
use FireflyIII\User;
|
|
use Illuminate\Support\Collection;
|
|
use Log;
|
|
|
|
/**
|
|
* Class ImportStorage
|
|
*
|
|
* @package FireflyIII\Import
|
|
*/
|
|
class ImportStorage
|
|
{
|
|
|
|
/** @var Collection */
|
|
public $entries;
|
|
/** @var Tag */
|
|
public $importTag;
|
|
/** @var ImportJob */
|
|
public $job;
|
|
/** @var User */
|
|
public $user;
|
|
|
|
/** @var Collection */
|
|
private $rules;
|
|
|
|
/**
|
|
* ImportStorage constructor.
|
|
*
|
|
* @param User $user
|
|
* @param Collection $entries
|
|
*/
|
|
public function __construct(User $user, Collection $entries)
|
|
{
|
|
$this->entries = $entries;
|
|
$this->user = $user;
|
|
$this->rules = $this->getUserRules();
|
|
|
|
}
|
|
|
|
/**
|
|
* @param ImportJob $job
|
|
*/
|
|
public function setJob(ImportJob $job)
|
|
{
|
|
$this->job = $job;
|
|
}
|
|
|
|
/**
|
|
* @param User $user
|
|
*/
|
|
public function setUser(User $user)
|
|
{
|
|
$this->user = $user;
|
|
}
|
|
|
|
/**
|
|
* @return Collection
|
|
*/
|
|
public function store(): Collection
|
|
{
|
|
// create a tag to join the transactions.
|
|
$this->importTag = $this->createImportTag();
|
|
$collection = new Collection;
|
|
Log::notice(sprintf('Started storing %d entry(ies).', $this->entries->count()));
|
|
foreach ($this->entries as $index => $entry) {
|
|
Log::debug(sprintf('--- import store start for row %d ---', $index));
|
|
|
|
// store entry:
|
|
$journal = $this->storeSingle($index, $entry);
|
|
$this->job->addStepsDone(1);
|
|
|
|
// apply rules:
|
|
$this->applyRules($journal);
|
|
$this->job->addStepsDone(1);
|
|
|
|
$collection->put($index, $journal);
|
|
}
|
|
Log::notice(sprintf('Finished storing %d entry(ies).', $collection->count()));
|
|
|
|
return $collection;
|
|
}
|
|
|
|
/**
|
|
* @param string $hash
|
|
*
|
|
* @return TransactionJournal
|
|
*/
|
|
private function alreadyImported(string $hash): TransactionJournal
|
|
{
|
|
|
|
$meta = TransactionJournalMeta::where('name', 'originalImportHash')->where('data', json_encode($hash))->first(['journal_meta.*']);
|
|
if (!is_null($meta)) {
|
|
/** @var TransactionJournal $journal */
|
|
$journal = $meta->transactionjournal;
|
|
if (intval($journal->completed) === 1) {
|
|
return $journal;
|
|
}
|
|
}
|
|
|
|
return new TransactionJournal;
|
|
}
|
|
|
|
/**
|
|
* @param TransactionJournal $journal
|
|
*
|
|
* @return bool
|
|
*/
|
|
private function applyRules(TransactionJournal $journal): bool
|
|
{
|
|
if ($this->rules->count() > 0) {
|
|
|
|
/** @var Rule $rule */
|
|
foreach ($this->rules as $rule) {
|
|
Log::debug(sprintf('Going to apply rule #%d to journal %d.', $rule->id, $journal->id));
|
|
$processor = Processor::make($rule);
|
|
$processor->handleTransactionJournal($journal);
|
|
|
|
if ($rule->stop_processing) {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @return Tag
|
|
*/
|
|
private function createImportTag(): Tag
|
|
{
|
|
/** @var TagRepositoryInterface $repository */
|
|
$repository = app(TagRepositoryInterface::class, [$this->user]);
|
|
$data = [
|
|
'tag' => trans('firefly.import_with_key', ['key' => $this->job->key]),
|
|
'date' => new Carbon,
|
|
'description' => null,
|
|
'latitude' => null,
|
|
'longitude' => null,
|
|
'zoomLevel' => null,
|
|
'tagMode' => 'nothing',
|
|
];
|
|
$tag = $repository->store($data);
|
|
|
|
return $tag;
|
|
}
|
|
|
|
/**
|
|
* @return Collection
|
|
*/
|
|
private function getUserRules(): Collection
|
|
{
|
|
$set = Rule::distinct()
|
|
->where('rules.user_id', $this->user->id)
|
|
->leftJoin('rule_groups', 'rule_groups.id', '=', 'rules.rule_group_id')
|
|
->leftJoin('rule_triggers', 'rules.id', '=', 'rule_triggers.rule_id')
|
|
->where('rule_groups.active', 1)
|
|
->where('rule_triggers.trigger_type', 'user_action')
|
|
->where('rule_triggers.trigger_value', 'store-journal')
|
|
->where('rules.active', 1)
|
|
->orderBy('rule_groups.order', 'ASC')
|
|
->orderBy('rules.order', 'ASC')
|
|
->get(['rules.*']);
|
|
Log::debug(sprintf('Found %d user rules.', $set->count()));
|
|
|
|
return $set;
|
|
|
|
}
|
|
|
|
/**
|
|
* @param float $amount
|
|
*
|
|
* @return string
|
|
*/
|
|
private function makePositive(float $amount): string
|
|
{
|
|
$amount = strval($amount);
|
|
if (bccomp($amount, '0', 4) === -1) { // left is larger than right
|
|
$amount = bcmul($amount, '-1');
|
|
}
|
|
|
|
return $amount;
|
|
}
|
|
|
|
/**
|
|
* @param $entry
|
|
*
|
|
* @return array
|
|
* @throws FireflyException
|
|
*/
|
|
private function storeAccounts($entry): array
|
|
{
|
|
// then create transactions. Single ones, unfortunately.
|
|
switch ($entry->fields['transaction-type']->type) {
|
|
default:
|
|
throw new FireflyException('ImportStorage cannot handle ' . $entry->fields['transaction-type']->type);
|
|
case TransactionType::WITHDRAWAL:
|
|
$source = $entry->fields['asset-account'];
|
|
$destination = $entry->fields['opposing-account'];
|
|
// make amount positive, if it is not.
|
|
break;
|
|
case TransactionType::DEPOSIT:
|
|
$source = $entry->fields['opposing-account'];
|
|
$destination = $entry->fields['asset-account'];
|
|
break;
|
|
case TransactionType::TRANSFER:
|
|
// depends on amount:
|
|
if ($entry->fields['amount'] < 0) {
|
|
$source = $entry->fields['asset-account'];
|
|
$destination = $entry->fields['opposing-account'];
|
|
break;
|
|
}
|
|
$destination = $entry->fields['asset-account'];
|
|
$source = $entry->fields['opposing-account'];
|
|
break;
|
|
}
|
|
|
|
return [
|
|
'source' => $source,
|
|
'destination' => $destination,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @param TransactionJournal $journal
|
|
* @param ImportEntry $entry
|
|
*/
|
|
private function storeBill(TransactionJournal $journal, ImportEntry $entry)
|
|
{
|
|
|
|
if (!is_null($entry->fields['bill']) && !is_null($entry->fields['bill']->id)) {
|
|
$journal->bill()->associate($entry->fields['bill']);
|
|
Log::debug('Attached bill', ['id' => $entry->fields['bill']->id, 'name' => $entry->fields['bill']->name]);
|
|
$journal->save();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param TransactionJournal $journal
|
|
* @param ImportEntry $entry
|
|
*/
|
|
private function storeBudget(TransactionJournal $journal, ImportEntry $entry)
|
|
{
|
|
if (!is_null($entry->fields['budget']) && !is_null($entry->fields['budget']->id)) {
|
|
$journal->budgets()->save($entry->fields['budget']);
|
|
Log::debug('Attached budget', ['id' => $entry->fields['budget']->id, 'name' => $entry->fields['budget']->name]);
|
|
$journal->save();
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* @param TransactionJournal $journal
|
|
* @param ImportEntry $entry
|
|
*/
|
|
private function storeCategory(TransactionJournal $journal, ImportEntry $entry)
|
|
{
|
|
if (!is_null($entry->fields['category']) && !is_null($entry->fields['category']->id)) {
|
|
$journal->categories()->save($entry->fields['category']);
|
|
Log::debug('Attached category', ['id' => $entry->fields['category']->id, 'name' => $entry->fields['category']->name]);
|
|
$journal->save();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param $entry
|
|
*
|
|
* @return TransactionJournal
|
|
*/
|
|
private function storeJournal($entry): TransactionJournal
|
|
{
|
|
|
|
$billId = is_null($entry->fields['bill']) || intval($entry->fields['bill']->id) === 0 ? null : intval($entry->fields['bill']->id);
|
|
$journalData = [
|
|
'user_id' => $entry->user->id,
|
|
'transaction_type_id' => $entry->fields['transaction-type']->id,
|
|
'bill_id' => $billId,
|
|
'transaction_currency_id' => $entry->fields['currency']->id,
|
|
'description' => $entry->fields['description'],
|
|
'date' => $entry->fields['date-transaction'],
|
|
'interest_date' => $entry->fields['date-interest'],
|
|
'book_date' => $entry->fields['date-book'],
|
|
'process_date' => $entry->fields['date-process'],
|
|
'completed' => 0,
|
|
];
|
|
/** @var TransactionJournal $journal */
|
|
$journal = TransactionJournal::create($journalData);
|
|
|
|
foreach ($journal->getErrors()->all() as $err) {
|
|
Log::error('Error when storing journal: ' . $err);
|
|
}
|
|
Log::debug('Created journal', ['id' => $journal->id]);
|
|
|
|
// save hash as meta value:
|
|
$meta = new TransactionJournalMeta;
|
|
$meta->name = 'originalImportHash';
|
|
$meta->data = $entry->hash;
|
|
$meta->transactionJournal()->associate($journal);
|
|
$meta->save();
|
|
|
|
return $journal;
|
|
}
|
|
|
|
/**
|
|
* @param int $index
|
|
* @param ImportEntry $entry
|
|
*
|
|
* @return TransactionJournal
|
|
* @throws FireflyException
|
|
*/
|
|
private function storeSingle(int $index, ImportEntry $entry): TransactionJournal
|
|
{
|
|
if ($entry->valid === false) {
|
|
Log::warning(sprintf('Cannot import row %d, because the entry is not valid.', $index));
|
|
$errors = join(', ', $entry->errors->all());
|
|
$errorText = sprintf('Row #%d: ' . $errors, $index);
|
|
$extendedStatus = $this->job->extended_status;
|
|
$extendedStatus['errors'][] = $errorText;
|
|
$this->job->extended_status = $extendedStatus;
|
|
$this->job->save();
|
|
|
|
return new TransactionJournal;
|
|
}
|
|
$alreadyImported = $this->alreadyImported($entry->hash);
|
|
if (!is_null($alreadyImported->id)) {
|
|
Log::warning(sprintf('Cannot import row %d, because it has already been imported (journal #%d).', $index, $alreadyImported->id));
|
|
$errorText = trans(
|
|
'firefly.import_double',
|
|
['row' => $index, 'link' => route('transactions.show', [$alreadyImported->id]), 'description' => $alreadyImported->description]
|
|
);
|
|
$extendedStatus = $this->job->extended_status;
|
|
$extendedStatus['errors'][] = $errorText;
|
|
$this->job->extended_status = $extendedStatus;
|
|
$this->job->save();
|
|
|
|
return new TransactionJournal;
|
|
}
|
|
|
|
Log::debug(sprintf('Going to store row %d', $index));
|
|
|
|
|
|
$journal = $this->storeJournal($entry);
|
|
$amount = $this->makePositive($entry->fields['amount']);
|
|
$accounts = $this->storeAccounts($entry);
|
|
|
|
// create new transactions. This is something that needs a rewrite for multiple/split transactions.
|
|
$sourceData = [
|
|
'account_id' => $accounts['source']->id,
|
|
'transaction_journal_id' => $journal->id,
|
|
'description' => $journal->description,
|
|
'amount' => bcmul($amount, '-1'),
|
|
];
|
|
|
|
$destinationData = [
|
|
'account_id' => $accounts['destination']->id,
|
|
'transaction_journal_id' => $journal->id,
|
|
'description' => $journal->description,
|
|
'amount' => $amount,
|
|
];
|
|
|
|
$one = Transaction::create($sourceData);
|
|
$two = Transaction::create($destinationData);
|
|
$error = false;
|
|
if (is_null($one->id)) {
|
|
Log::error('Could not create transaction 1.', $one->getErrors()->all());
|
|
$error = true;
|
|
}
|
|
|
|
if (is_null($two->id)) {
|
|
Log::error('Could not create transaction 1.', $two->getErrors()->all());
|
|
$error = true;
|
|
}
|
|
|
|
// respond to error
|
|
if ($error === true) {
|
|
$errorText = sprintf('Cannot import row %d, because an error occured when storing data.', $index);
|
|
Log::error($errorText);
|
|
$extendedStatus = $this->job->extended_status;
|
|
$extendedStatus['errors'][] = $errorText;
|
|
$this->job->extended_status = $extendedStatus;
|
|
$this->job->save();
|
|
|
|
return new TransactionJournal;
|
|
}
|
|
|
|
Log::debug('Created transaction 1', ['id' => $one->id, 'account' => $one->account_id, 'account_name' => $accounts['source']->name]);
|
|
Log::debug('Created transaction 2', ['id' => $two->id, 'account' => $two->account_id, 'account_name' => $accounts['destination']->name]);
|
|
|
|
$journal->completed = 1;
|
|
$journal->save();
|
|
|
|
// attach import tag.
|
|
$journal->tags()->save($this->importTag);
|
|
|
|
// now attach budget and so on.
|
|
$this->storeBudget($journal, $entry);
|
|
$this->storeCategory($journal, $entry);
|
|
$this->storeBill($journal, $entry);
|
|
|
|
return $journal;
|
|
}
|
|
}
|