. */ declare(strict_types=1); namespace FireflyIII\Repositories\Journal; use Carbon\Carbon; use DB; use Exception; use FireflyIII\Models\Account; use FireflyIII\Models\AccountType; use FireflyIII\Models\Note; use FireflyIII\Models\PiggyBankEvent; use FireflyIII\Models\Transaction; use FireflyIII\Models\TransactionGroup; use FireflyIII\Models\TransactionJournal; use FireflyIII\Models\TransactionJournalLink; use FireflyIII\Models\TransactionJournalMeta; use FireflyIII\Models\TransactionType; use FireflyIII\Services\Internal\Destroy\JournalDestroyService; use FireflyIII\Services\Internal\Destroy\TransactionGroupDestroyService; use FireflyIII\Services\Internal\Update\JournalUpdateService; use FireflyIII\Support\CacheProperties; use FireflyIII\User; use Illuminate\Support\Collection; use Illuminate\Support\MessageBag; use Log; /** * Class JournalRepository. * * @SuppressWarnings(PHPMD.CouplingBetweenObjects) * @SuppressWarnings(PHPMD.TooManyPublicMethods) * @SuppressWarnings(PHPMD.ExcessiveClassComplexity) */ class JournalRepository implements JournalRepositoryInterface { /** @var User */ private $user; /** * Constructor. */ public function __construct() { if ('testing' === config('app.env')) { Log::warning(sprintf('%s should not be instantiated in the TEST environment!', \get_class($this))); } } /** @noinspection MoreThanThreeArgumentsInspection */ /** * @param TransactionJournal $journal * @param TransactionType $type * @param Account $source * @param Account $destination * * @return MessageBag * @SuppressWarnings(PHPMD.CyclomaticComplexity) * @SuppressWarnings(PHPMD.ExcessiveMethodLength) */ public function convert(TransactionJournal $journal, TransactionType $type, Account $source, Account $destination): MessageBag { if ($source->id === $destination->id || null === $source->id || null === $destination->id) { // default message bag that shows errors for everything. $messages = new MessageBag; $messages->add('source_account_revenue', (string)trans('firefly.invalid_convert_selection')); $messages->add('destination_account_asset', (string)trans('firefly.invalid_convert_selection')); $messages->add('destination_account_expense', (string)trans('firefly.invalid_convert_selection')); $messages->add('source_account_asset', (string)trans('firefly.invalid_convert_selection')); return $messages; } $srcTransaction = $journal->transactions()->where('amount', '<', 0)->first(); $dstTransaction = $journal->transactions()->where('amount', '>', 0)->first(); if (null === $srcTransaction || null === $dstTransaction) { // default message bag that shows errors for everything. $messages = new MessageBag; $messages->add('source_account_revenue', (string)trans('firefly.source_or_dest_invalid')); $messages->add('destination_account_asset', (string)trans('firefly.source_or_dest_invalid')); $messages->add('destination_account_expense', (string)trans('firefly.source_or_dest_invalid')); $messages->add('source_account_asset', (string)trans('firefly.source_or_dest_invalid')); return $messages; } // update transactions, and update journal: $srcTransaction->account_id = $source->id; $dstTransaction->account_id = $destination->id; $journal->transaction_type_id = $type->id; $dstTransaction->save(); $srcTransaction->save(); $journal->save(); // if journal is a transfer now, remove budget: if (TransactionType::TRANSFER === $type->type) { $journal->budgets()->detach(); // also from transactions: foreach ($journal->transactions as $transaction) { $transaction->budgets()->detach(); } } // if journal is not a withdrawal, remove the bill ID. if (TransactionType::WITHDRAWAL !== $type->type) { $journal->bill_id = null; $journal->save(); } app('preferences')->mark(); return new MessageBag; } /** * @param TransactionGroup $transactionGroup * */ public function destroyGroup(TransactionGroup $transactionGroup): void { /** @var TransactionGroupDestroyService $service */ $service = app(TransactionGroupDestroyService::class); $service->destroy($transactionGroup); } /** * @param TransactionJournal $journal * */ public function destroyJournal(TransactionJournal $journal): void { /** @var JournalDestroyService $service */ $service = app(JournalDestroyService::class); $service->destroy($journal); } /** * Find a journal by its hash. * * @param string $hash * * @return TransactionJournalMeta|null */ public function findByHash(string $hash): ?TransactionJournalMeta { $jsonEncode = json_encode($hash); $hashOfHash = hash('sha256', $jsonEncode); Log::debug(sprintf('JSON encoded hash is: %s', $jsonEncode)); Log::debug(sprintf('Hash of hash is: %s', $hashOfHash)); $result = TransactionJournalMeta::withTrashed() ->leftJoin('transaction_journals', 'transaction_journals.id', '=', 'journal_meta.transaction_journal_id') ->where('hash', $hashOfHash) ->where('name', 'import_hash_v2') ->first(['journal_meta.*']); if (null === $result) { Log::debug('Result is null'); } return $result; } /** * Find a specific journal. * * @param int $journalId * * @return TransactionJournal|null */ public function findNull(int $journalId): ?TransactionJournal { return $this->user->transactionJournals()->where('id', $journalId)->first(); } /** * @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 or NULL. * * @return TransactionJournal|null */ public function firstNull(): ?TransactionJournal { /** @var TransactionJournal $entry */ $entry = $this->user->transactionJournals()->orderBy('date', 'ASC')->first(['transaction_journals.*']); $result = null; if (null !== $entry) { $result = $entry; } return $result; } /** * @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; } /** * Return all attachments for journal. * * @param TransactionJournal $journal * * @return Collection */ public function getAttachments(TransactionJournal $journal): Collection { return $journal->attachments; } /** * Get all attachments connected to the transaction group. * * @param TransactionJournal $transactionJournal * * @return Collection */ public function getAttachmentsByJournal(TransactionJournal $transactionJournal): Collection { // TODO: Implement getAttachmentsByJournal() method. throw new NotImplementedException; } /** * Returns the first positive transaction for the journal. Useful when editing journals. * * @param TransactionJournal $journal * * @return Transaction */ public function getFirstPosTransaction(TransactionJournal $journal): Transaction { return $journal->transactions()->where('amount', '>', 0)->first(); } /** * Return the ID of the budget linked to the journal (if any) or the transactions (if any). * * @param TransactionJournal $journal * * @return int */ public function getJournalBudgetId(TransactionJournal $journal): int { $budget = $journal->budgets()->first(); if (null !== $budget) { return $budget->id; } /** @noinspection NullPointerExceptionInspection */ $budget = $journal->transactions()->first()->budgets()->first(); if (null !== $budget) { return $budget->id; } return 0; } /** * Return the ID of the category linked to the journal (if any) or to the transactions (if any). * * @param TransactionJournal $journal * * @return int */ public function getJournalCategoryId(TransactionJournal $journal): int { $category = $journal->categories()->first(); if (null !== $category) { return $category->id; } /** @noinspection NullPointerExceptionInspection */ $category = $journal->transactions()->first()->categories()->first(); if (null !== $category) { return $category->id; } return 0; } /** * Return the name of the category linked to the journal (if any) or to the transactions (if any). * * @param TransactionJournal $journal * * @return string */ public function getJournalCategoryName(TransactionJournal $journal): string { $category = $journal->categories()->first(); if (null !== $category) { return $category->name; } /** @noinspection NullPointerExceptionInspection */ $category = $journal->transactions()->first()->categories()->first(); if (null !== $category) { return $category->name; } return ''; } /** * Return requested date as string. When it's a NULL return the date of journal, * otherwise look for meta field and return that one. * * @param TransactionJournal $journal * @param null|string $field * * @return string * @SuppressWarnings(PHPMD.CyclomaticComplexity) * @SuppressWarnings(PHPMD.ExcessiveMethodLength) */ public function getJournalDate(TransactionJournal $journal, ?string $field): string { if (null === $field) { return $journal->date->format('Y-m-d'); } /** @noinspection NotOptimalIfConditionsInspection */ if (null !== $journal->$field && $journal->$field instanceof Carbon) { // make field NULL $carbon = clone $journal->$field; $journal->$field = null; $journal->save(); // create meta entry $this->setMetaDate($journal, $field, $carbon); // return that one instead. return $carbon->format('Y-m-d'); } $metaField = $this->getMetaDate($journal, $field); if (null !== $metaField) { return $metaField->format('Y-m-d'); } return ''; } /** * Return Carbon value of a meta field (or NULL). * * @param TransactionJournal $journal * @param string $field * * @return null|Carbon */ public function getMetaDate(TransactionJournal $journal, string $field): ?Carbon { $cache = new CacheProperties; $cache->addProperty('journal-meta-updated'); $cache->addProperty($journal->id); $cache->addProperty($field); if ($cache->has()) { return new Carbon($cache->get()); // @codeCoverageIgnore } $entry = $journal->transactionJournalMeta()->where('name', $field)->first(); if (null === $entry) { return null; } $value = new Carbon($entry->data); $cache->store($entry->data); return $value; } /** * Return a list of all destination accounts related to journal. * * @param TransactionJournal $journal * @param bool $useCache * * @return Collection */ public function getJournalDestinationAccounts(TransactionJournal $journal, bool $useCache = true): Collection { $cache = new CacheProperties; $cache->addProperty($journal->id); $cache->addProperty('destination-account-list'); if ($useCache && $cache->has()) { return $cache->get(); // @codeCoverageIgnore } $transactions = $journal->transactions()->where('amount', '>', 0)->orderBy('transactions.account_id')->with('account')->get(); $list = new Collection; /** @var Transaction $t */ foreach ($transactions as $t) { $list->push($t->account); } $list = $list->unique('id'); $cache->store($list); return $list; } /** * Return a list of all source accounts related to journal. * * @param TransactionJournal $journal * @param bool $useCache * * @return Collection */ public function getJournalSourceAccounts(TransactionJournal $journal, bool $useCache = true): Collection { $cache = new CacheProperties; $cache->addProperty($journal->id); $cache->addProperty('source-account-list'); if ($useCache && $cache->has()) { return $cache->get(); // @codeCoverageIgnore } $transactions = $journal->transactions()->where('amount', '<', 0)->orderBy('transactions.account_id')->with('account')->get(); $list = new Collection; /** @var Transaction $t */ foreach ($transactions as $t) { $list->push($t->account); } $list = $list->unique('id'); $cache->store($list); return $list; } /** * Return total amount of journal. Is always positive. * * @param TransactionJournal $journal * * @return string */ public function getJournalTotal(TransactionJournal $journal): string { $cache = new CacheProperties; $cache->addProperty($journal->id); $cache->addProperty('amount-positive'); if ($cache->has()) { return $cache->get(); // @codeCoverageIgnore } // saves on queries: $amount = $journal->transactions()->where('amount', '>', 0)->get()->sum('amount'); $amount = (string)$amount; $cache->store($amount); return $amount; } /** * Return all journals without a group, used in an upgrade routine. * * @return array */ public function getJournalsWithoutGroup(): array { return TransactionJournal::whereNull('transaction_group_id')->get(['id', 'user_id'])->toArray(); } /** * @param TransactionJournalLink $link * * @return string */ public function getLinkNoteText(TransactionJournalLink $link): string { $notes = null; /** @var Note $note */ $note = $link->notes()->first(); if (null !== $note) { return $note->text ?? ''; } return ''; } /** * Return string value of a meta date (or NULL). * * @param TransactionJournal $journal * @param string $field * * @return null|string */ public function getMetaDateString(TransactionJournal $journal, string $field): ?string { $date = $this->getMetaDate($journal, $field); if (null === $date) { return null; } return $date->format('Y-m-d'); } /** * Return value of a meta field (or NULL) as a string. * * @param TransactionJournal $journal * @param string $field * * @return null|string * @SuppressWarnings(PHPMD.CyclomaticComplexity) */ public function getMetaField(TransactionJournal $journal, string $field): ?string { $cache = new CacheProperties; $cache->addProperty('journal-meta-updated'); $cache->addProperty($journal->id); $cache->addProperty($field); if ($cache->has()) { return $cache->get(); // @codeCoverageIgnore } $entry = $journal->transactionJournalMeta()->where('name', $field)->first(); if (null === $entry) { return null; } $value = $entry->data; if (\is_array($value)) { $return = implode(',', $value); $cache->store($return); return $return; } // return when something else: try { $return = (string)$value; $cache->store($return); } catch (Exception $e) { Log::error($e->getMessage()); return ''; } return $return; } /** * Return text of a note attached to journal, or NULL * * @param TransactionJournal $journal * * @return string|null */ public function getNoteText(TransactionJournal $journal): ?string { $note = $journal->notes()->first(); if (null === $note) { return null; } return $note->text; } /** * @param TransactionJournal $journal * * @return Collection */ public function getPiggyBankEvents(TransactionJournal $journal): Collection { /** @var Collection $set */ $events = $journal->piggyBankEvents()->get(); $events->each( function (PiggyBankEvent $event) { $event->piggyBank = $event->piggyBank()->withTrashed()->first(); } ); return $events; } /** * Returns all journals with more than 2 transactions. Should only return empty collections * in Firefly III > v4.8.0. * * @return Collection */ public function getSplitJournals(): Collection { $query = TransactionJournal ::leftJoin('transactions', 'transaction_journals.id', '=', 'transactions.transaction_journal_id') ->groupBy('transaction_journals.id') ->having('tid', '>', 2) ->get(['transaction_journals.id as jid', DB::raw('count(transactions.id) as tid')]); $journalIds = array_unique($query->pluck('jid')->toArray()); return TransactionJournal ::with(['transactions']) ->whereIn('id', $journalIds)->get(); } /** * Return all tags as strings in an array. * * @param TransactionJournal $journal * * @return array */ public function getTags(TransactionJournal $journal): array { return $journal->tags()->get()->pluck('tag')->toArray(); } /** * Return the transaction type of the journal. * * @param TransactionJournal $journal * * @return string */ public function getTransactionType(TransactionJournal $journal): string { return $journal->transactionType->type; } /** * Will tell you if journal is reconciled or not. * * @param TransactionJournal $journal * * @return bool */ public function isJournalReconciled(TransactionJournal $journal): bool { foreach ($journal->transactions as $transaction) { if ($transaction->reconciled) { return true; } } return false; } /** * @param int $transactionId * * @return bool */ public function reconcileById(int $transactionId): bool { /** @var Transaction $transaction */ $transaction = $this->user->transactions()->find($transactionId); if (null !== $transaction) { return $this->reconcile($transaction); } return false; } /** * @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): void { $this->user = $user; } /** * Update budget for a journal. * * @param TransactionJournal $journal * @param int $budgetId * * @return TransactionJournal */ public function updateBudget(TransactionJournal $journal, int $budgetId): TransactionJournal { /** @var JournalUpdateService $service */ $service = app(JournalUpdateService::class); return $service->updateBudget($journal, $budgetId); } /** * Update category for a journal. * * @param TransactionJournal $journal * @param string $category * * @return TransactionJournal */ public function updateCategory(TransactionJournal $journal, string $category): TransactionJournal { /** @var JournalUpdateService $service */ $service = app(JournalUpdateService::class); return $service->updateCategory($journal, $category); } /** * Update tag(s) for a journal. * * @param TransactionJournal $journal * @param array $tags * * @return TransactionJournal */ public function updateTags(TransactionJournal $journal, array $tags): TransactionJournal { /** @var JournalUpdateService $service */ $service = app(JournalUpdateService::class); $service->connectTags($journal, $tags); return $journal; } }