mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-10-31 10:47:00 +00:00
585 lines
19 KiB
PHP
585 lines
19 KiB
PHP
<?php
|
|
/**
|
|
* JournalRepository.php
|
|
* Copyright (c) 2017 thegrumpydictator@gmail.com
|
|
*
|
|
* This file is part of Firefly III.
|
|
*
|
|
* Firefly III is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Firefly III is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Repositories\Journal;
|
|
|
|
use Carbon\Carbon;
|
|
use DB;
|
|
use FireflyIII\Models\Account;
|
|
use FireflyIII\Models\AccountType;
|
|
use FireflyIII\Models\Note;
|
|
use FireflyIII\Models\Tag;
|
|
use FireflyIII\Models\Transaction;
|
|
use FireflyIII\Models\TransactionJournal;
|
|
use FireflyIII\Models\TransactionType;
|
|
use FireflyIII\Repositories\Tag\TagRepositoryInterface;
|
|
use FireflyIII\User;
|
|
use Illuminate\Support\Collection;
|
|
use Illuminate\Support\MessageBag;
|
|
use Log;
|
|
use Preferences;
|
|
|
|
/**
|
|
* Class JournalRepository.
|
|
*/
|
|
class JournalRepository implements JournalRepositoryInterface
|
|
{
|
|
use CreateJournalsTrait, UpdateJournalsTrait, SupportJournalsTrait;
|
|
|
|
/** @var User */
|
|
private $user;
|
|
/** @var array */
|
|
private $validMetaFields = ['interest_date', 'book_date', 'process_date', 'due_date', 'payment_date', 'invoice_date', 'internal_reference'];
|
|
|
|
/**
|
|
* @param TransactionJournal $journal
|
|
* @param TransactionType $type
|
|
* @param Account $source
|
|
* @param Account $destination
|
|
*
|
|
* @return MessageBag
|
|
*/
|
|
public function convert(TransactionJournal $journal, TransactionType $type, Account $source, Account $destination): MessageBag
|
|
{
|
|
// default message bag that shows errors for everything.
|
|
$messages = new MessageBag;
|
|
$messages->add('source_account_revenue', trans('firefly.invalid_convert_selection'));
|
|
$messages->add('destination_account_asset', trans('firefly.invalid_convert_selection'));
|
|
$messages->add('destination_account_expense', trans('firefly.invalid_convert_selection'));
|
|
$messages->add('source_account_asset', trans('firefly.invalid_convert_selection'));
|
|
|
|
if ($source->id === $destination->id || null === $source->id || null === $destination->id) {
|
|
return $messages;
|
|
}
|
|
|
|
$sourceTransaction = $journal->transactions()->where('amount', '<', 0)->first();
|
|
$destinationTransaction = $journal->transactions()->where('amount', '>', 0)->first();
|
|
$sourceTransaction->account_id = $source->id;
|
|
$sourceTransaction->save();
|
|
$destinationTransaction->account_id = $destination->id;
|
|
$destinationTransaction->save();
|
|
$journal->transaction_type_id = $type->id;
|
|
$journal->save();
|
|
|
|
// if journal is a transfer now, remove budget:
|
|
if (TransactionType::TRANSFER === $type->type) {
|
|
$journal->budgets()->detach();
|
|
}
|
|
|
|
Preferences::mark();
|
|
|
|
return new MessageBag;
|
|
}
|
|
|
|
/**
|
|
* @param TransactionJournal $journal
|
|
*
|
|
* @return int
|
|
*/
|
|
public function countTransactions(TransactionJournal $journal): int
|
|
{
|
|
return $journal->transactions()->count();
|
|
}
|
|
|
|
/**
|
|
* @param TransactionJournal $journal
|
|
*
|
|
* @return bool
|
|
*
|
|
* @throws \Exception
|
|
*/
|
|
public function delete(TransactionJournal $journal): bool
|
|
{
|
|
$journal->delete();
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @param int $journalId
|
|
*
|
|
* @return TransactionJournal
|
|
*/
|
|
public function find(int $journalId): TransactionJournal
|
|
{
|
|
$journal = $this->user->transactionJournals()->where('id', $journalId)->first();
|
|
if (null === $journal) {
|
|
return new TransactionJournal;
|
|
}
|
|
|
|
return $journal;
|
|
}
|
|
|
|
/**
|
|
* @param Transaction $transaction
|
|
*
|
|
* @return Transaction|null
|
|
*/
|
|
public function findOpposingTransaction(Transaction $transaction): ?Transaction
|
|
{
|
|
$opposing = Transaction::leftJoin('transaction_journals', 'transaction_journals.id', '=', 'transactions.transaction_journal_id')
|
|
->where('transaction_journals.user_id', $this->user->id)
|
|
->where('transactions.transaction_journal_id', $transaction->transaction_journal_id)
|
|
->where('transactions.identifier', $transaction->identifier)
|
|
->where('amount', bcmul($transaction->amount, '-1'))
|
|
->first(['transactions.*']);
|
|
|
|
return $opposing;
|
|
}
|
|
|
|
/**
|
|
* @param int $transactionid
|
|
*
|
|
* @return Transaction|null
|
|
*/
|
|
public function findTransaction(int $transactionid): ?Transaction
|
|
{
|
|
$transaction = Transaction::leftJoin('transaction_journals', 'transaction_journals.id', '=', 'transactions.transaction_journal_id')
|
|
->where('transaction_journals.user_id', $this->user->id)
|
|
->where('transactions.id', $transactionid)
|
|
->first(['transactions.*']);
|
|
|
|
return $transaction;
|
|
}
|
|
|
|
/**
|
|
* Get users first transaction journal.
|
|
*
|
|
* @return TransactionJournal
|
|
*/
|
|
public function first(): TransactionJournal
|
|
{
|
|
$entry = $this->user->transactionJournals()->orderBy('date', 'ASC')->first(['transaction_journals.*']);
|
|
|
|
if (null === $entry) {
|
|
return new TransactionJournal;
|
|
}
|
|
|
|
return $entry;
|
|
}
|
|
|
|
/**
|
|
* @param TransactionJournal $journal
|
|
*
|
|
* @return Transaction|null
|
|
*/
|
|
public function getAssetTransaction(TransactionJournal $journal): ?Transaction
|
|
{
|
|
/** @var Transaction $transaction */
|
|
foreach ($journal->transactions as $transaction) {
|
|
if (AccountType::ASSET === $transaction->account->accountType->type) {
|
|
return $transaction;
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* @param TransactionJournal $journal
|
|
*
|
|
* @return Note|null
|
|
*/
|
|
public function getNote(TransactionJournal $journal): ?Note
|
|
{
|
|
return $journal->notes()->first();
|
|
}
|
|
|
|
/**
|
|
* @return Collection
|
|
*/
|
|
public function getTransactionTypes(): Collection
|
|
{
|
|
return TransactionType::orderBy('type', 'ASC')->get();
|
|
}
|
|
|
|
/**
|
|
* @param array $transactionIds
|
|
*
|
|
* @return Collection
|
|
*/
|
|
public function getTransactionsById(array $transactionIds): Collection
|
|
{
|
|
$set = Transaction::leftJoin('transaction_journals', 'transaction_journals.id', '=', 'transactions.transaction_journal_id')
|
|
->whereIn('transactions.id', $transactionIds)
|
|
->where('transaction_journals.user_id', $this->user->id)
|
|
->whereNull('transaction_journals.deleted_at')
|
|
->whereNull('transactions.deleted_at')
|
|
->get(['transactions.*']);
|
|
|
|
return $set;
|
|
}
|
|
|
|
/**
|
|
* @param TransactionJournal $journal
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isTransfer(TransactionJournal $journal): bool
|
|
{
|
|
return TransactionType::TRANSFER === $journal->transactionType->type;
|
|
}
|
|
|
|
/**
|
|
* @param Transaction $transaction
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function reconcile(Transaction $transaction): bool
|
|
{
|
|
Log::debug(sprintf('Going to reconcile transaction #%d', $transaction->id));
|
|
$opposing = $this->findOpposingTransaction($transaction);
|
|
|
|
if (null === $opposing) {
|
|
Log::debug('Opposing transaction is NULL. Cannot reconcile.');
|
|
|
|
return false;
|
|
}
|
|
Log::debug(sprintf('Opposing transaction ID is #%d', $opposing->id));
|
|
|
|
$transaction->reconciled = true;
|
|
$opposing->reconciled = true;
|
|
$transaction->save();
|
|
$opposing->save();
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @param TransactionJournal $journal
|
|
* @param int $order
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function setOrder(TransactionJournal $journal, int $order): bool
|
|
{
|
|
$journal->order = $order;
|
|
$journal->save();
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @param User $user
|
|
*/
|
|
public function setUser(User $user)
|
|
{
|
|
$this->user = $user;
|
|
}
|
|
|
|
/**
|
|
* @param array $data
|
|
*
|
|
* @return TransactionJournal
|
|
*
|
|
* @throws \FireflyIII\Exceptions\FireflyException
|
|
* @throws \FireflyIII\Exceptions\FireflyException
|
|
*/
|
|
public function store(array $data): TransactionJournal
|
|
{
|
|
// find transaction type.
|
|
/** @var TransactionType $transactionType */
|
|
$transactionType = TransactionType::where('type', ucfirst($data['what']))->first();
|
|
$accounts = $this->storeAccounts($this->user, $transactionType, $data);
|
|
$data = $this->verifyNativeAmount($data, $accounts);
|
|
$amount = strval($data['amount']);
|
|
$dateString = $data['date'];
|
|
if ($data['date'] instanceof Carbon) {
|
|
$dateString = $data['date']->format('Y-m-d 00:00:00');
|
|
}
|
|
$journal = new TransactionJournal(
|
|
[
|
|
'user_id' => $this->user->id,
|
|
'transaction_type_id' => $transactionType->id,
|
|
'transaction_currency_id' => $data['currency_id'], // no longer used.
|
|
'description' => $data['description'],
|
|
'completed' => 0,
|
|
'date' => $dateString,
|
|
]
|
|
);
|
|
$journal->save();
|
|
|
|
// store stuff:
|
|
$this->storeCategoryWithJournal($journal, strval($data['category']));
|
|
$this->storeBudgetWithJournal($journal, $data['budget_id']);
|
|
|
|
// store two transactions:
|
|
|
|
$one = [
|
|
'journal' => $journal,
|
|
'account' => $accounts['source'],
|
|
'amount' => bcmul($amount, '-1'),
|
|
'transaction_currency_id' => $data['currency_id'],
|
|
'foreign_amount' => null === $data['foreign_amount'] ? null : bcmul(strval($data['foreign_amount']), '-1'),
|
|
'foreign_currency_id' => $data['foreign_currency_id'],
|
|
'description' => null,
|
|
'category' => null,
|
|
'budget' => null,
|
|
'identifier' => 0,
|
|
];
|
|
$this->storeTransaction($one);
|
|
|
|
$two = [
|
|
'journal' => $journal,
|
|
'account' => $accounts['destination'],
|
|
'amount' => $amount,
|
|
'transaction_currency_id' => $data['currency_id'],
|
|
'foreign_amount' => $data['foreign_amount'],
|
|
'foreign_currency_id' => $data['foreign_currency_id'],
|
|
'description' => null,
|
|
'category' => null,
|
|
'budget' => null,
|
|
'identifier' => 0,
|
|
];
|
|
|
|
$this->storeTransaction($two);
|
|
|
|
// store tags
|
|
if (isset($data['tags']) && is_array($data['tags'])) {
|
|
$this->saveTags($journal, $data['tags']);
|
|
}
|
|
|
|
// update note:
|
|
if (isset($data['notes'])) {
|
|
$this->updateNote($journal, $data['notes']);
|
|
}
|
|
|
|
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));
|
|
}
|
|
|
|
$journal->completed = 1;
|
|
$journal->save();
|
|
|
|
return $journal;
|
|
}
|
|
|
|
/**
|
|
* @param TransactionJournal $journal
|
|
* @param array $data
|
|
*
|
|
* @return TransactionJournal
|
|
*
|
|
* @throws \FireflyIII\Exceptions\FireflyException
|
|
* @throws \FireflyIII\Exceptions\FireflyException
|
|
* @throws \FireflyIII\Exceptions\FireflyException
|
|
* @throws \FireflyIII\Exceptions\FireflyException
|
|
*/
|
|
public function update(TransactionJournal $journal, array $data): TransactionJournal
|
|
{
|
|
// update actual journal:
|
|
$journal->description = $data['description'];
|
|
$journal->date = $data['date'];
|
|
$accounts = $this->storeAccounts($this->user, $journal->transactionType, $data);
|
|
$data = $this->verifyNativeAmount($data, $accounts);
|
|
$data['amount'] = strval($data['amount']);
|
|
$data['foreign_amount'] = null === $data['foreign_amount'] ? null : strval($data['foreign_amount']);
|
|
|
|
// unlink all categories, recreate them:
|
|
$journal->categories()->detach();
|
|
$journal->budgets()->detach();
|
|
|
|
$this->storeCategoryWithJournal($journal, strval($data['category']));
|
|
$this->storeBudgetWithJournal($journal, $data['budget_id']);
|
|
|
|
// negative because source loses money.
|
|
$this->updateSourceTransaction($journal, $accounts['source'], $data);
|
|
|
|
// positive because destination gets money.
|
|
$this->updateDestinationTransaction($journal, $accounts['destination'], $data);
|
|
|
|
$journal->save();
|
|
|
|
// update tags:
|
|
if (isset($data['tags']) && is_array($data['tags'])) {
|
|
$this->updateTags($journal, $data['tags']);
|
|
}
|
|
|
|
// update note:
|
|
if (isset($data['notes']) && null !== $data['notes']) {
|
|
$this->updateNote($journal, strval($data['notes']));
|
|
}
|
|
|
|
// 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;
|
|
}
|
|
|
|
return $journal;
|
|
}
|
|
|
|
/**
|
|
* @param TransactionJournal $journal
|
|
* @param int $budgetId
|
|
*
|
|
* @return TransactionJournal
|
|
*/
|
|
public function updateBudget(TransactionJournal $journal, int $budgetId): TransactionJournal
|
|
{
|
|
if ($budgetId === 0) {
|
|
$journal->budgets()->detach();
|
|
$journal->save();
|
|
|
|
return $journal;
|
|
}
|
|
$this->storeBudgetWithJournal($journal, $budgetId);
|
|
|
|
return $journal;
|
|
}
|
|
|
|
/**
|
|
* @param TransactionJournal $journal
|
|
* @param string $category
|
|
*
|
|
* @return TransactionJournal
|
|
*/
|
|
public function updateCategory(TransactionJournal $journal, string $category): TransactionJournal
|
|
{
|
|
Log::debug(sprintf('In updateCategory("%s")', $category));
|
|
$journal->categories()->detach();
|
|
if (strlen($category) === 0) {
|
|
return $journal;
|
|
}
|
|
$this->storeCategoryWithJournal($journal, $category);
|
|
|
|
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->description = $data['journal_description'];
|
|
$journal->date = $data['date'];
|
|
$journal->save();
|
|
Log::debug(sprintf('Updated split journal #%d', $journal->id));
|
|
|
|
// unlink all categories:
|
|
$journal->categories()->detach();
|
|
$journal->budgets()->detach();
|
|
|
|
// update note:
|
|
if (isset($data['notes']) && null !== $data['notes']) {
|
|
$this->updateNote($journal, strval($data['notes']));
|
|
}
|
|
|
|
// 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));
|
|
}
|
|
}
|
|
|
|
// 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;
|
|
Log::debug(sprintf('Count %d transactions in updateSplitJournal()', count($data['transactions'])));
|
|
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* Update tags.
|
|
*
|
|
* @param TransactionJournal $journal
|
|
* @param array $array
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function updateTags(TransactionJournal $journal, array $array): bool
|
|
{
|
|
// create tag repository
|
|
/** @var TagRepositoryInterface $tagRepository */
|
|
$tagRepository = app(TagRepositoryInterface::class);
|
|
|
|
// find or create all tags:
|
|
$tags = [];
|
|
$ids = [];
|
|
foreach ($array as $name) {
|
|
if (strlen(trim($name)) > 0) {
|
|
$tag = Tag::firstOrCreateEncrypted(['tag' => $name, 'user_id' => $journal->user_id]);
|
|
$tags[] = $tag;
|
|
$ids[] = $tag->id;
|
|
}
|
|
}
|
|
|
|
// delete all tags connected to journal not in this array:
|
|
if (count($ids) > 0) {
|
|
DB::table('tag_transaction_journal')->where('transaction_journal_id', $journal->id)->whereNotIn('tag_id', $ids)->delete();
|
|
}
|
|
// if count is zero, delete them all:
|
|
if (0 === count($ids)) {
|
|
DB::table('tag_transaction_journal')->where('transaction_journal_id', $journal->id)->delete();
|
|
}
|
|
|
|
// connect each tag to journal (if not yet connected):
|
|
/** @var Tag $tag */
|
|
foreach ($tags as $tag) {
|
|
Log::debug(sprintf('Will try to connect tag #%d to journal #%d.', $tag->id, $journal->id));
|
|
$tagRepository->connect($journal, $tag);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
}
|