kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-10-12 15:35:15 +00:00
Code Issues Projects Releases Wiki Activity

Large update to fix split journals.

Browse Source
This commit is contained in:
James Cole
2016-10-21 21:41:31 +02:00
parent a74cef439b
commit 6a553f77f3
12 changed files with 510 additions and 632 deletions
Download Patch File Download Diff File Expand all files Collapse all files

181
app/Repositories/Journal/JournalRepository.php
View File

@@ -14,6 +14,7 @@ declare(strict_types = 1);
namespace FireflyIII\Repositories\Journal;
use DB;
use FireflyIII\Events\TransactionStored;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\Account;
use FireflyIII\Models\AccountType;
@@ -25,6 +26,7 @@ use FireflyIII\Models\TransactionJournal;
use FireflyIII\Models\TransactionType;
use FireflyIII\Repositories\Tag\TagRepositoryInterface;
use FireflyIII\User;
use Illuminate\Support\Collection;
use Log;
/**
@@ -251,6 +253,92 @@ class JournalRepository implements JournalRepositoryInterface
return $journal;
}
/**
* Same as above but for transaction journal with multiple transactions.
*
* @param TransactionJournal $journal
* @param array $data
*
* @return TransactionJournal
*/
public function updateSplitJournal(TransactionJournal $journal, array $data): TransactionJournal
{
// update actual journal:
$journal->transaction_currency_id = $data['transaction_currency_id'];
$journal->description = $data['journal_description'];
$journal->date = $data['date'];
// unlink all categories:
$journal->categories()->detach();
$journal->budgets()->detach();
// update meta fields:
$result = $journal->save();
if ($result) {
foreach ($data as $key => $value) {
if (in_array($key, $this->validMetaFields)) {
$journal->setMeta($key, $value);
continue;
}
Log::debug(sprintf('Could not store meta field "%s" with value "%s" for journal #%d', json_encode($key), json_encode($value), $journal->id));
}
return $journal;
}
// update tags:
if (isset($data['tags']) && is_array($data['tags'])) {
$this->updateTags($journal, $data['tags']);
}
// delete original transactions, and recreate them.
$journal->transactions()->delete();
// store each transaction.
$identifier = 0;
foreach ($data['transactions'] as $transaction) {
Log::debug(sprintf('Split journal update split transaction %d', $identifier));
$transaction = $this->appendTransactionData($transaction, $data);
$this->storeSplitTransaction($journal, $transaction, $identifier);
$identifier++;
}
$journal->save();
return $journal;
}
/**
* When the user edits a split journal, each line is missing crucial data:
*
* - Withdrawal lines are missing the source account ID
* - Deposit lines are missing the destination account ID
* - Transfers are missing both.
*
* We need to append the array.
*
* @param array $transaction
* @param array $data
*
* @return array
*/
private function appendTransactionData(array $transaction, array $data): array
{
switch ($data['what']) {
case strtolower(TransactionType::TRANSFER):
case strtolower(TransactionType::WITHDRAWAL):
$transaction['source_account_id'] = intval($data['journal_source_account_id']);
break;
case strtolower(TransactionType::TRANSFER):
case strtolower(TransactionType::DEPOSIT):
$transaction['destination_account_id'] = intval($data['journal_destination_account_id']);
break;
}
return $transaction;
}
/**
*
* * Remember: a balancingAct takes at most one expense and one transfer.
@@ -291,6 +379,7 @@ class JournalRepository implements JournalRepositoryInterface
'source' => null,
'destination' => null,
];
Log::debug(sprintf('Going to store accounts for type %s', $type->type));
switch ($type->type) {
case TransactionType::WITHDRAWAL:
$accounts = $this->storeWithdrawalAccounts($data);
@@ -310,13 +399,13 @@ class JournalRepository implements JournalRepositoryInterface
}
if (is_null($accounts['source'])) {
Log::error('"destination"-account is null, so we cannot continue!', ['data' => $data]);
throw new FireflyException('"destination"-account is null, so we cannot continue!');
Log::error('"source"-account is null, so we cannot continue!', ['data' => $data]);
throw new FireflyException('"source"-account is null, so we cannot continue!');
}
if (is_null($accounts['destination'])) {
Log::error('"source"-account is null, so we cannot continue!', ['data' => $data]);
throw new FireflyException('"source"-account is null, so we cannot continue!');
Log::error('"destination"-account is null, so we cannot continue!', ['data' => $data]);
throw new FireflyException('"destination"-account is null, so we cannot continue!');
}
@@ -337,6 +426,19 @@ class JournalRepository implements JournalRepositoryInterface
}
}
/**
* @param Transaction $transaction
* @param int $budgetId
*/
private function storeBudgetWithTransaction(Transaction $transaction, int $budgetId)
{
if (intval($budgetId) > 0 && $transaction->transactionJournal->transactionType->type !== TransactionType::TRANSFER) {
/** @var \FireflyIII\Models\Budget $budget */
$budget = Budget::find($budgetId);
$transaction->budgets()->save($budget);
}
}
/**
* @param TransactionJournal $journal
* @param string $category
@@ -349,6 +451,18 @@ class JournalRepository implements JournalRepositoryInterface
}
}
/**
* @param Transaction $transaction
* @param string $category
*/
private function storeCategoryWithTransaction(Transaction $transaction, string $category)
{
if (strlen($category) > 0) {
$category = Category::firstOrCreateEncrypted(['name' => $category, 'user_id' => $transaction->transactionJournal->user_id]);
$transaction->categories()->save($category);
}
}
/**
* @param array $data
*
@@ -380,7 +494,61 @@ class JournalRepository implements JournalRepositoryInterface
];
}
/**
* @param TransactionJournal $journal
* @param array $transaction
* @param int $identifier
*
* @return Collection
*/
private function storeSplitTransaction(TransactionJournal $journal, array $transaction, int $identifier): Collection
{
// store source and destination accounts (depends on type)
$accounts = $this->storeAccounts($journal->transactionType, $transaction);
// store transaction one way:
$one = $this->storeTransaction(
[
'journal' => $journal,
'account' => $accounts['source'],
'amount' => bcmul(strval($transaction['amount']), '-1'),
'description' => $transaction['description'],
'category' => null,
'budget' => null,
'identifier' => $identifier,
]
);
$this->storeCategoryWithTransaction($one, $transaction['category']);
$this->storeBudgetWithTransaction($one, $transaction['budget_id']);
// and the other way:
$two = $this->storeTransaction(
[
'journal' => $journal,
'account' => $accounts['destination'],
'amount' => strval($transaction['amount']),
'description' => $transaction['description'],
'category' => null,
'budget' => null,
'identifier' => $identifier,
]
);
$this->storeCategoryWithTransaction($two, $transaction['category']);
$this->storeBudgetWithTransaction($two, $transaction['budget_id']);
if ($transaction['piggy_bank_id'] > 0) {
$transaction['date'] = $journal->date->format('Y-m-d');
event(new TransactionStored($transaction));
}
return new Collection([$one, $two]);
}
/**
* @param array $data
*
* @return Transaction
*/
private function storeTransaction(array $data): Transaction
{
/** @var Transaction $transaction */
@@ -393,6 +561,9 @@ class JournalRepository implements JournalRepositoryInterface
'identifier' => $data['identifier'],
]
);
Log::debug(sprintf('Transaction stored with ID: %s', $transaction->id));
if (!is_null($data['category'])) {
$transaction->categories()->save($data['category']);
}
@@ -415,7 +586,7 @@ class JournalRepository implements JournalRepositoryInterface
$sourceAccount = Account::where('user_id', $this->user->id)->where('id', $data['source_account_id'])->first(['accounts.*']);
if (strlen($data['destination_account_name']) > 0) {
$destinationType = AccountType::where('type', 'Expense account')->first();
$destinationType = AccountType::where('type', AccountType::EXPENSE)->first();
$destinationAccount = Account::firstOrCreateEncrypted(
[
'user_id' => $data['user'],

8
app/Repositories/Journal/JournalRepositoryInterface.php
View File

@@ -73,4 +73,12 @@ interface JournalRepositoryInterface
*/
public function update(TransactionJournal $journal, array $data): TransactionJournal;
/**
* @param TransactionJournal $journal
* @param array $data
*
* @return TransactionJournal
*/
public function updateSplitJournal(TransactionJournal $journal, array $data): TransactionJournal;
}

44
app/Repositories/Journal/JournalTasker.php
View File

@@ -175,12 +175,15 @@ class JournalTasker implements JournalTaskerInterface
$join
->on('transactions.transaction_journal_id', '=', 'destination.transaction_journal_id')
->where('transactions.amount', '=', DB::raw('destination.amount * -1'))
->where('transactions.identifier', '=', DB::raw('destination.identifier'));
->where('transactions.identifier', '=', DB::raw('destination.identifier'))
->whereNull('destination.deleted_at');
}
)
->with(['budgets', 'categories'])
->leftJoin('accounts as source_accounts', 'transactions.account_id', '=', 'source_accounts.id')
->leftJoin('accounts as destination_accounts', 'destination.account_id', '=', 'destination_accounts.id')
->where('transactions.amount', '<', 0)
->whereNull('transactions.deleted_at')
->get(
[
'transactions.id',
@@ -202,6 +205,8 @@ class JournalTasker implements JournalTaskerInterface
foreach ($set as $entry) {
$sourceBalance = $this->getBalance($entry->id);
$destinationBalance = $this->getBalance($entry->destination_id);
$budget = $entry->budgets->first();
$category = $entry->categories->first();
$transaction = [
'source_id' => $entry->id,
'source_amount' => $entry->amount,
@@ -218,8 +223,11 @@ class JournalTasker implements JournalTaskerInterface
intval($entry->destination_account_encrypted) === 1 ? Crypt::decrypt($entry->destination_account_name) : $entry->destination_account_name,
'destination_account_before' => $destinationBalance,
'destination_account_after' => bcadd($destinationBalance, bcmul($entry->amount, '-1')),
'budget_id' => is_null($budget) ? 0 : $budget->id,
'category' => is_null($category) ? '' : $category->name,
];
$transactions[] = $transaction;
}
@@ -237,40 +245,6 @@ class JournalTasker implements JournalTaskerInterface
*/
private function getBalance(int $transactionId): string
{
/*
select
-- transactions.*, transaction_journals.date, transaction_journals.order, transaction_journals.id, transactions.identifier
sum(transactions.amount)
from transactions
and (
-- first things first: remove all transaction journals that are newer by selecting only those that are earlier:
or
-- date is 03 but sorted lower: (fucntion 1)
(
transaction_journals.date = "2016-09-20"
and transaction_journals.order > 2)
or
-- date is 03 and sort is the same but id is higher (func 2)
(transaction_journals.date = "2016-09-20"
and transaction_journals.order = 2
and transaction_journals.id < 6966
)
-- date is 03 and sort is the same, and id is the same but identifier is 1 and not 0.(func 3)
or
(transaction_journals.date = "2016-09-20"
and transaction_journals.order = 2
and transaction_journals.id = 6966
and transactions.identifier > 1
)
) -- 14048
and transactions.id != 14048 -- just in case
order by transaction_journals.date DESC, transaction_journals.order ASC, transaction_journals.id DESC, transactions.identifier ASC
*/
// find the transaction first:
$transaction = Transaction::find($transactionId);
$date = $transaction->transactionJournal->date->format('Y-m-d');