Refactor journal repositories.

app/Repositories/Journal/JournalCLIRepository.php

@@ -0,0 +1,275 @@
+<?php
+/**
+ * JournalCLIRepository.php
+ * Copyright (c) 2019 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/>.
+ */
+
+namespace FireflyIII\Repositories\Journal;
+
+
+use Carbon\Carbon;
+use DB;
+use Exception;
+use FireflyIII\Models\TransactionJournal;
+use FireflyIII\Support\CacheProperties;
+use FireflyIII\User;
+use Illuminate\Support\Collection;
+use Log;
+use stdClass;
+
+/**
+ * Class JournalCLIRepository
+ */
+class JournalCLIRepository implements JournalCLIRepositoryInterface
+{
+    /** @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)));
+        }
+    }
+
+    /**
+     * Get all transaction journals with a specific type, regardless of user.
+     *
+     * @param array $types
+     *
+     * @return Collection
+     */
+    public function getAllJournals(array $types): Collection
+    {
+        return TransactionJournal
+            ::leftJoin('transaction_types', 'transaction_types.id', '=', 'transaction_journals.transaction_type_id')
+            ->whereIn('transaction_types.type', $types)
+            ->with(['user', 'transactionType', 'transactionCurrency', 'transactions', 'transactions.account'])
+            ->get(['transaction_journals.*']);
+    }
+
+    /**
+     * 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 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();
+    }
+
+    /**
+     * 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()) {
+            $result = null;
+            try {
+                $result = new Carbon($cache->get()); // @codeCoverageIgnore
+            } catch (Exception $e) {
+                $e->getMessage();
+            }
+
+            return $result;
+        }
+
+        $entry = $journal->transactionJournalMeta()->where('name', $field)->first();
+        if (null === $entry) {
+            return null;
+        }
+        $value = null;
+        try {
+            $value = new Carbon($entry->data);
+        } catch (Exception $e) {
+            $e->getMessage();
+
+            return null;
+        }
+
+        $cache->store($entry->data);
+
+        return $value;
+    }
+
+    /**
+     * Return value of a meta field (or NULL) as a string.
+     *
+     * @param TransactionJournal $journal
+     * @param string             $field
+     *
+     * @return null|string
+     */
+    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;
+    }
+
+    /**
+     * 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');
+        $result     = $query->get(['transaction_journals.id as id', DB::raw('count(transactions.id) as transaction_count')]);
+        $journalIds = [];
+        /** @var stdClass $row */
+        foreach ($result as $row) {
+            if ((int)$row->transaction_count > 2) {
+                $journalIds[] = (int)$row->id;
+            }
+        }
+        $journalIds = array_unique($journalIds);
+
+        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();
+    }
+
+    /**
+     * @param User $user
+     */
+    public function setUser(User $user): void
+    {
+        $this->user = $user;
+    }
+}