kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-09-23 04:46:44 +00:00
Code Issues Projects Releases Wiki Activity
Files
f684a2900b0405e31afab5ebe3e1032cc0729619
firefly-iii/app/Import/Storage/ImportStorage.php

586 lines
24 KiB
PHP
Raw Normal View History

Refactor and rename some import things.
2017-06-17 22:49:44 +02:00
<?php
/**
* ImportStorage.php
* Copyright (c) 2017 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\Storage;
Improving import storage.
2017-06-24 07:21:10 +02:00
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Import\Object\ImportAccount;
Refactor and rename some import things.
2017-06-17 22:49:44 +02:00
use FireflyIII\Import\Object\ImportJournal;
Expand import routine.
2017-06-20 21:04:25 +02:00
use FireflyIII\Models\Account;
use FireflyIII\Models\AccountType;
use FireflyIII\Models\ImportJob;
Routine to make sure imported entries have the correct opposing account and the correct amount.
2017-07-08 06:53:06 +02:00
use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
Also store links when importing data.
2017-07-28 14:52:01 +02:00
use FireflyIII\Repositories\Tag\TagRepositoryInterface;
Refactor and rename some import things.
2017-06-17 22:49:44 +02:00
use Illuminate\Support\Collection;
use Log;
/**
* Is capable of storing individual ImportJournal objects.
* Class ImportStorage
*
* @package FireflyIII\Import\Storage
*/
class ImportStorage
{
Further improve import routine
2017-06-21 20:04:35 +02:00
/** @var Collection */
public $errors;
Simplify import storage routine.
2017-07-16 07:45:20 +02:00
/** @var Collection */
Further improve import routine
2017-06-21 20:04:35 +02:00
public $journals;
Routine to make sure imported entries have the correct opposing account and the correct amount.
2017-07-08 06:53:06 +02:00
/** @var CurrencyRepositoryInterface */
private $currencyRepository;
Refactor and rename some import things.
2017-06-17 22:49:44 +02:00
/** @var string */
private $dateFormat = 'Ymd';
Include default currency.
2017-08-12 16:42:29 +02:00
/** @var int */
private $defaultCurrencyId = 0;
Expand import routine.
2017-06-20 21:04:25 +02:00
/** @var ImportJob */
private $job;
Refactor and rename some import things.
2017-06-17 22:49:44 +02:00
/** @var Collection */
private $objects;
More code for import routine.
2017-06-22 21:50:10 +02:00
/** @var Collection */
private $rules;
Also store links when importing data.
2017-07-28 14:52:01 +02:00
/** @var TagRepositoryInterface */
private $tagRepository;
Refactor and rename some import things.
2017-06-17 22:49:44 +02:00
/**
* ImportStorage constructor.
*/
public function __construct()
{
Further improve import routine
2017-06-21 20:04:35 +02:00
$this->objects = new Collection;
$this->journals = new Collection;
$this->errors = new Collection;
Refactor and rename some import things.
2017-06-17 22:49:44 +02:00
}
/**
* @param string $dateFormat
*/
public function setDateFormat(string $dateFormat)
{
$this->dateFormat = $dateFormat;
}
Expand import routine.
2017-06-20 21:04:25 +02:00
/**
* @param ImportJob $job
*/
public function setJob(ImportJob $job)
{
Include default currency.
2017-08-12 16:42:29 +02:00
$this->job = $job;
$currency = app('amount')->getDefaultCurrencyByUser($this->job->user);
$this->defaultCurrencyId = $currency->id;
Back to basics.
2017-08-12 16:40:51 +02:00
// $repository = app(CurrencyRepositoryInterface::class);
// $repository->setUser($job->user);
// $this->currencyRepository = $repository;
// $repository = app(TagRepositoryInterface::class);
// $repository->setUser($job->user);
// $this->tagRepository = $repository;
// $this->rules = $this->getUserRules();
Include default currency.
2017-08-12 16:42:29 +02:00
//
Expand import routine.
2017-06-20 21:04:25 +02:00
}
Refactor and rename some import things.
2017-06-17 22:49:44 +02:00
/**
* @param Collection $objects
*/
public function setObjects(Collection $objects)
{
$this->objects = $objects;
}
/**
Back to basics.
2017-08-12 16:40:51 +02:00
* Do storage of import objects. Is the main function.
More code for import routine.
2017-06-22 21:50:10 +02:00
*
* @return bool
*/
Back to basics.
2017-08-12 16:40:51 +02:00
public function store(): bool
More code for import routine.
2017-06-22 21:50:10 +02:00
{
Back to basics.
2017-08-12 16:40:51 +02:00
$this->objects->each(
function (ImportJournal $importJournal, int $index) {
try {
$this->storeImportJournal($index, $importJournal);
} catch (FireflyException $e) {
$this->errors->push($e->getMessage());
Log::error(sprintf('Cannot import row #%d because: %s', $index, $e->getMessage()));
More code for import routine.
2017-06-22 21:50:10 +02:00
}
}
Simplify import storage routine.
2017-07-16 07:45:20 +02:00
);
Back to basics.
2017-08-12 16:40:51 +02:00
Log::info('ImportStorage has finished.');
Various code cleanup
2017-08-12 07:47:42 +02:00
Back to basics.
2017-08-12 16:40:51 +02:00
return true;
Improving import storage.
2017-06-24 07:21:10 +02:00
}
Include default currency.
2017-08-12 16:42:29 +02:00
//
// /**
// * @param TransactionJournal $journal
// *
// * @return bool
// */
// protected 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;
// }
Back to basics.
2017-08-12 16:40:51 +02:00
Include default currency.
2017-08-12 16:42:29 +02:00
// /**
// * @param array $parameters
// *
// * @return bool
// * @throws FireflyException
// */
// private function createTransaction(array $parameters): bool
// {
// $transaction = new Transaction;
// $transaction->account_id = $parameters['account'];
// $transaction->transaction_journal_id = $parameters['id'];
// $transaction->transaction_currency_id = $parameters['currency'];
// $transaction->amount = $parameters['amount'];
// $transaction->foreign_currency_id = $parameters['foreign_currency'];
// $transaction->foreign_amount = $parameters['foreign_amount'];
// $transaction->save();
// if (is_null($transaction->id)) {
// $errorText = join(', ', $transaction->getErrors()->all());
// throw new FireflyException($errorText);
// }
// Log::debug(sprintf('Created transaction with ID #%d, account #%d, amount %s', $transaction->id, $parameters['account'], $parameters['amount']));
//
// return true;
// }
Back to basics.
2017-08-12 16:40:51 +02:00
Include default currency.
2017-08-12 16:42:29 +02:00
// /**
// * @param Collection $set
// * @param ImportJournal $importJournal
// *
// * @return bool
// */
// private function filterTransferSet(Collection $set, ImportJournal $importJournal): bool
// {
// $amount = Steam::positive($importJournal->getAmount());
// $asset = $importJournal->asset->getAccount();
// $opposing = $this->getOpposingAccount($importJournal->opposing, $asset->id, $amount);
// $description = $importJournal->getDescription();
//
// $filtered = $set->filter(
// function (TransactionJournal $journal) use ($asset, $opposing, $description) {
// $match = true;
// $original = [app('steam')->tryDecrypt($journal->source_name), app('steam')->tryDecrypt($journal->destination_name)];
// $compare = [$asset->name, $opposing->name];
// sort($original);
// sort($compare);
//
// // description does not match? Then cannot be duplicate.
// if ($journal->description !== $description) {
// $match = false;
// }
// // not both accounts in journal? Then cannot be duplicate.
// if ($original !== $compare) {
// $match = false;
// }
//
// if ($match) {
// return $journal;
// }
//
// return null;
// }
// );
// if (count($filtered) > 0) {
// return true;
// }
//
// return false;
// }
Back to basics.
2017-08-12 16:40:51 +02:00
Include default currency.
2017-08-12 16:42:29 +02:00
// /**
// * @param ImportJournal $importJournal
// *
// * @param Account $account
// *
// * @return TransactionCurrency
// */
// private function getCurrency(ImportJournal $importJournal, Account $account): TransactionCurrency
// {
// // start with currency pref of account, if any:
// $currency = $this->currencyRepository->find(intval($account->getMeta('currency_id')));
// if (!is_null($currency->id)) {
// return $currency;
// }
//
// // use given currency
// $currency = $importJournal->getCurrency()->getTransactionCurrency();
// if (!is_null($currency->id)) {
// return $currency;
// }
//
// // backup to default
// $currency = $this->defaultCurrency;
//
// return $currency;
//
// }
Back to basics.
2017-08-12 16:40:51 +02:00
Include default currency.
2017-08-12 16:42:29 +02:00
// /**
// * @param ImportJournal $importJournal
// * @param TransactionCurrency $localCurrency
// *
// * @return int|null
// */
// private function getForeignCurrencyId(ImportJournal $importJournal, TransactionCurrency $localCurrency): ?int
// {
// // get journal currency, if any:
// $currency = $importJournal->getCurrency()->getTransactionCurrency();
// if (is_null($currency->id)) {
// Log::debug('getForeignCurrencyId: Journal has no currency, so can\'t be foreign either way.');
//
// // journal has no currency, so can't be foreign either way:
// return null;
// }
//
// if ($currency->id !== $localCurrency->id) {
// Log::debug(
// sprintf('getForeignCurrencyId: journal is %s, but account is %s. Return id of journal currency.', $currency->code, $localCurrency->code)
// );
//
// // journal has different currency than account does, return its ID:
// return $currency->id;
// }
//
// Log::debug('getForeignCurrencyId: journal has no foreign currency.');
//
// // return null in other cases.
// return null;
// }
Improving import storage.
2017-06-24 07:21:10 +02:00
/**
* @param ImportAccount $account
* @param $amount
*
* @return Account
*/
Prevent asset account from being found by opposing account. #719
2017-08-12 13:49:40 +02:00
private function getOpposingAccount(ImportAccount $account, int $forbiddenAccount, string $amount): Account
Improving import storage.
2017-06-24 07:21:10 +02:00
{
Prevent asset account from being found by opposing account. #719
2017-08-12 13:49:40 +02:00
$account->setForbiddenAccountId($forbiddenAccount);
Improving import storage.
2017-06-24 07:21:10 +02:00
if (bccomp($amount, '0') === -1) {
Log::debug(sprintf('%s is negative, create opposing expense account.', $amount));
$account->setExpectedType(AccountType::EXPENSE);
return $account->getAccount();
}
Log::debug(sprintf('%s is positive, create opposing revenue account.', $amount));
// amount is positive, it's a deposit, opposing is an revenue:
$account->setExpectedType(AccountType::REVENUE);
Routine to make sure imported entries have the correct opposing account and the correct amount.
2017-07-08 06:53:06 +02:00
$databaseAccount = $account->getAccount();
return $databaseAccount;
Improving import storage.
2017-06-24 07:21:10 +02:00
}
Include default currency.
2017-08-12 16:42:29 +02:00
//
// /**
// * @param string $amount
// *
// * @return TransactionType
// */
// private function getTransactionType(string $amount): TransactionType
// {
// $transactionType = new TransactionType();
// // amount is negative, it's a withdrawal, opposing is an expense:
// if (bccomp($amount, '0') === -1) {
// $transactionType = TransactionType::whereType(TransactionType::WITHDRAWAL)->first();
// }
// if (bccomp($amount, '0') === 1) {
// $transactionType = TransactionType::whereType(TransactionType::DEPOSIT)->first();
// }
//
// return $transactionType;
// }
Back to basics.
2017-08-12 16:40:51 +02:00
Include default currency.
2017-08-12 16:42:29 +02:00
// /**
// * @return Collection
// */
// private function getUserRules(): Collection
// {
// $set = Rule::distinct()
// ->where('rules.user_id', $this->job->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.*', 'rule_groups.order']);
// Log::debug(sprintf('Found %d user rules.', $set->count()));
//
// return $set;
//
// }
//
// /**
// * @param TransactionJournal $journal
// * @param Bill $bill
// */
// private function storeBill(TransactionJournal $journal, Bill $bill)
// {
// if (!is_null($bill->id)) {
// Log::debug(sprintf('Linked bill #%d to journal #%d', $bill->id, $journal->id));
// $journal->bill()->associate($bill);
// $journal->save();
// }
// }
Back to basics.
2017-08-12 16:40:51 +02:00
Include default currency.
2017-08-12 16:42:29 +02:00
// /**
// * @param TransactionJournal $journal
// * @param Budget $budget
// */
// private function storeBudget(TransactionJournal $journal, Budget $budget)
// {
// if (!is_null($budget->id)) {
// Log::debug(sprintf('Linked budget #%d to journal #%d', $budget->id, $journal->id));
// $journal->budgets()->save($budget);
// }
// }
//
// /**
// * @param TransactionJournal $journal
// * @param Category $category
// */
// private function storeCategory(TransactionJournal $journal, Category $category)
// {
//
// if (!is_null($category->id)) {
// Log::debug(sprintf('Linked category #%d to journal #%d', $category->id, $journal->id));
// $journal->categories()->save($category);
// }
//
// }
Improving import storage.
2017-06-24 07:21:10 +02:00
/**
Back to basics.
2017-08-12 16:40:51 +02:00
* @param int $index
* @param ImportJournal $importJournal
Improving import storage.
2017-06-24 07:21:10 +02:00
*
Back to basics.
2017-08-12 16:40:51 +02:00
* @return bool
* @throws FireflyException
Further improve import storage.
2017-06-24 07:30:05 +02:00
*/
Improving import storage.
2017-06-24 07:21:10 +02:00
private function storeImportJournal(int $index, ImportJournal $importJournal): bool
{
Improve results when presented with invalid data. #701
2017-07-14 17:57:20 +02:00
Log::debug(sprintf('Going to store object #%d with description "%s"', $index, $importJournal->getDescription()));
Include default currency.
2017-08-12 16:42:29 +02:00
$asset = $importJournal->asset->getAccount();
$amount = $importJournal->getAmount();
This should fix #693.
2017-07-07 08:04:21 +02:00
Include default currency.
2017-08-12 16:42:29 +02:00
// $currency = $this->getCurrency($importJournal, $asset);
// $foreignCurrencyId = $this->getForeignCurrencyId($importJournal, $currency);
// $date = $importJournal->getDate($this->dateFormat);
// $transactionType = $this->getTransactionType($amount);
// $opposing = $this->getOpposingAccount($importJournal->opposing, $asset->id, $amount);
//
// // if opposing is an asset account, it's a transfer:
// if ($opposing->accountType->type === AccountType::ASSET) {
// Log::debug(sprintf('Opposing account #%d %s is an asset account, make transfer.', $opposing->id, $opposing->name));
// $transactionType = TransactionType::whereType(TransactionType::TRANSFER)->first();
// }
//
// // verify that opposing account is of the correct type:
// if ($opposing->accountType->type === AccountType::EXPENSE && $transactionType->type !== TransactionType::WITHDRAWAL) {
// $message = sprintf('Row #%d is imported as a %s but opposing is an expense account. This cannot be!', $index, $transactionType->type);
// Log::error($message);
// throw new FireflyException($message);
//
// }
//
// /*** First step done! */
// $this->job->addStepsDone(1);
//
// // could be that transfer is double: verify this.
// if ($this->verifyDoubleTransfer($transactionType, $importJournal)) {
// // add three steps:
// $this->job->addStepsDone(3);
// // throw error
// throw new FireflyException('Detected a possible duplicate, skip this one.');
//
// }
//
// // create a journal:
// $journal = new TransactionJournal;
// $journal->user_id = $this->job->user_id;
// $journal->transaction_type_id = $transactionType->id;
// $journal->transaction_currency_id = $currency->id;// always currency of account
// $journal->description = $importJournal->getDescription();
// $journal->date = $date->format('Y-m-d');
// $journal->order = 0;
// $journal->tag_count = 0;
// $journal->completed = false;
//
// if (!$journal->save()) {
// $errorText = join(', ', $journal->getErrors()->all());
// // add three steps:
// $this->job->addStepsDone(3);
// // throw error
// throw new FireflyException($errorText);
// }
//
// // save meta data:
// $journal->setMeta('importHash', $importJournal->hash);
// Log::debug(sprintf('Created journal with ID #%d', $journal->id));
//
// // create transactions:
// $one = [
// 'id' => $journal->id,
// 'account' => $asset->id,
// 'currency' => $currency->id,
// 'amount' => $amount,
// 'foreign_currency' => $foreignCurrencyId,
// 'foreign_amount' => is_null($foreignCurrencyId) ? null : $amount,
// ];
// $two = [
// 'id' => $journal->id,
// 'account' => $opposing->id,
// 'currency' => $currency->id,
// 'amount' => Steam::opposite($amount),
// 'foreign_currency' => $foreignCurrencyId,
// 'foreign_amount' => is_null($foreignCurrencyId) ? null : Steam::opposite($amount),
// ];
// $this->createTransaction($one);
// $this->createTransaction($two);
//
// /*** Another step done! */
// $this->job->addStepsDone(1);
//
// // store meta object things:
// $this->storeCategory($journal, $importJournal->category->getCategory());
// $this->storeBudget($journal, $importJournal->budget->getBudget());
// $this->storeBill($journal, $importJournal->bill->getBill());
// $this->storeMeta($journal, $importJournal->metaDates);
//
// // sepa thing as note:
// if (strlen($importJournal->notes) > 0) {
// $journal->setMeta('notes', $importJournal->notes);
// }
//
// // store tags
// $this->storeTags($importJournal->tags, $journal);
//
// // set journal completed:
// $journal->completed = true;
// $journal->save();
//
// $this->job->addStepsDone(1);
//
// // run rules:
// $this->applyRules($journal);
// $this->job->addStepsDone(1);
// $this->journals->push($journal);
//
// Log::info(
// sprintf(
// 'Imported new journal #%d with description "%s" and amount %s %s.', $journal->id, $journal->description, $journal->transactionCurrency->code,
// $amount
// )
// );
Improving import storage.
2017-06-24 07:21:10 +02:00
return true;
}
Include default currency.
2017-08-12 16:42:29 +02:00
// /**
// * @param TransactionJournal $journal
// * @param array $dates
// */
// private function storeMeta(TransactionJournal $journal, array $dates)
// {
// // all other date fields as meta thing:
// foreach ($dates as $name => $value) {
// try {
// $date = new Carbon($value);
// $journal->setMeta($name, $date);
// } catch (\Exception $e) {
// // don't care, ignore:
// Log::warning(sprintf('Could not parse "%s" into a valid Date object for field %s', $value, $name));
// }
// }
// }
Back to basics.
2017-08-12 16:40:51 +02:00
Include default currency.
2017-08-12 16:42:29 +02:00
// /**
// * @param array $tags
// * @param TransactionJournal $journal
// */
// private function storeTags(array $tags, TransactionJournal $journal): void
// {
// foreach ($tags as $tag) {
// $dbTag = $this->tagRepository->findByTag($tag);
// if (is_null($dbTag->id)) {
// $dbTag = $this->tagRepository->store(
// ['tag' => $tag, 'date' => null, 'description' => null, 'latitude' => null, 'longitude' => null,
// 'zoomLevel' => null, 'tagMode' => 'nothing']
// );
// }
// $journal->tags()->save($dbTag);
// Log::debug(sprintf('Linked tag %d ("%s") to journal #%d', $dbTag->id, $dbTag->tag, $journal->id));
// }
//
// return;
// }
Back to basics.
2017-08-12 16:40:51 +02:00
Include default currency.
2017-08-12 16:42:29 +02:00
// /**
// * This method checks if the given transaction is a transfer and if so, if it might be a duplicate of an already imported transfer.
// * This is important for import files that cover multiple accounts (and include both A<>B and B<>A transactions).
// *
// * @param TransactionType $transactionType
// * @param ImportJournal $importJournal
// *
// * @return bool
// */
// private function verifyDoubleTransfer(TransactionType $transactionType, ImportJournal $importJournal): bool
// {
// if ($transactionType->type === TransactionType::TRANSFER) {
// $amount = Steam::positive($importJournal->getAmount());
// $date = $importJournal->getDate($this->dateFormat);
// $set = TransactionJournal::leftJoin('transaction_types', 'transaction_types.id', '=', 'transaction_journals.transaction_type_id')
// ->leftJoin(
// 'transactions AS source', function (JoinClause $join) {
// $join->on('transaction_journals.id', '=', 'source.transaction_journal_id')->where('source.amount', '<', 0);
// }
// )
// ->leftJoin(
// 'transactions AS destination', function (JoinClause $join) {
// $join->on('transaction_journals.id', '=', 'destination.transaction_journal_id')->where(
// 'destination.amount', '>', 0
// );
// }
// )
// ->leftJoin('accounts as source_accounts', 'source.account_id', '=', 'source_accounts.id')
// ->leftJoin('accounts as destination_accounts', 'destination.account_id', '=', 'destination_accounts.id')
// ->where('transaction_journals.user_id', $this->job->user_id)
// ->where('transaction_types.type', TransactionType::TRANSFER)
// ->where('transaction_journals.date', $date->format('Y-m-d'))
// ->where('destination.amount', $amount)
// ->get(
// ['transaction_journals.id', 'transaction_journals.encrypted', 'transaction_journals.description',
// 'source_accounts.name as source_name', 'destination_accounts.name as destination_name']
// );
//
// return $this->filterTransferSet($set, $importJournal);
// }
//
//
// return false;
// }
Fixed some issues in import, should improve results for #701
2017-07-14 06:41:47 +02:00
Add newlines [skip ci]
2017-07-07 08:09:42 +02:00
}
Reference in New Issue Copy Permalink