Skip to content

Firefly III: a personal finances manager

9.3 KB
Raw Blame
<?php

/**
 * ModelInformation.php
 * Copyright (c) 2019 [email protected]
 *
 * This file is part of Firefly III (https://github.com/firefly-iii).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace FireflyIII\Support\Http\Controllers;

use FireflyIII\Enums\AccountTypeEnum;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\AccountType;
use FireflyIII\Models\Bill;
use FireflyIII\Models\Tag;
use FireflyIII\Models\Transaction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use Illuminate\Support\Facades\Log;
use Throwable;

/**
 * Trait ModelInformation
 */
trait ModelInformation
{
    /**
     * Get actions based on a bill.
     *
     * @throws FireflyException
     */
    protected function getActionsForBill(Bill $bill): array // get info and argument
    {
        try {
            $result = view('rules.partials.action', [
                'oldAction'  => 'link_to_bill',
                'oldValue'   => $bill->name,
                'oldChecked' => false,
                'count'      => 1,
            ])->render();
        } catch (Throwable $e) {
            Log::error(sprintf('Throwable was thrown in getActionsForBill(): %s', $e->getMessage()));
            Log::error($e->getTraceAsString());
            $result = 'Could not render view. See log files.';

            throw new FireflyException($result, 0, $e);
        }

        return [$result];
    }

    /**
     * @return string[]
     *
     * @psalm-return array<int|null, string>
     */
    protected function getLiabilityTypes(): array
    {
        /** @var AccountRepositoryInterface $repository */
        $repository     = app(AccountRepositoryInterface::class);

        // types of liability:
        /** @var AccountType $debt */
        $debt           = $repository->getAccountTypeByType(AccountTypeEnum::DEBT->value);

        /** @var AccountType $loan */
        $loan           = $repository->getAccountTypeByType(AccountTypeEnum::LOAN->value);

        /** @var AccountType $mortgage */
        $mortgage       = $repository->getAccountTypeByType(AccountTypeEnum::MORTGAGE->value);
        $liabilityTypes = [
            $debt->id     => (string) trans(sprintf('firefly.account_type_%s', AccountTypeEnum::DEBT->value)),
            $loan->id     => (string) trans(sprintf('firefly.account_type_%s', AccountTypeEnum::LOAN->value)),
            $mortgage->id => (string) trans(sprintf('firefly.account_type_%s', AccountTypeEnum::MORTGAGE->value)),
        ];
        asort($liabilityTypes);

        return $liabilityTypes;
    }

    protected function getRoles(): array
    {
        $roles = [];
        foreach (config('firefly.accountRoles') as $role) {
            $roles[$role] = (string) trans(sprintf('firefly.account_role_%s', $role));
        }

        return $roles;
    }

    /**
     * Create fake triggers to match the bill's properties
     *
     * @throws FireflyException
     */
    protected function getTriggersForBill(Bill $bill): array // get info and argument
    {
        // TODO duplicate code
        $operators    = config('search.operators');
        $triggers     = [];
        foreach ($operators as $key => $operator) {
            if ('user_action' !== $key && false === $operator['alias']) {
                $triggers[$key] = (string) trans(sprintf('firefly.rule_trigger_%s_choice', $key));
            }
        }
        asort($triggers);

        $result       = [];
        $billTriggers = ['currency_is', 'amount_more', 'amount_less', 'description_contains'];
        $values       = [$bill->transactionCurrency()->first()?->name, $bill->amount_min, $bill->amount_max, $bill->name];
        foreach ($billTriggers as $index => $trigger) {
            try {
                $string = view('rules.partials.trigger', [
                    'oldTrigger'    => $trigger,
                    'oldValue'      => $values[$index],
                    'oldProhibited' => null,
                    'oldChecked'    => false,
                    'count'         => $index + 1,
                    'triggers'      => $triggers,
                ])->render();
            } catch (Throwable $e) {
                Log::debug(sprintf('Throwable was thrown in getTriggersForBill(): %s', $e->getMessage()));
                Log::debug($e->getTraceAsString());

                throw new FireflyException(sprintf('Could not render trigger: %s', $e->getMessage()), 0, $e);
            }
            if ('' !== $string) {
                $result[] = $string;
            }
        }

        return $result;
    }

    /**
     * @throws FireflyException
     *
     * @SuppressWarnings("PHPMD.ExcessiveMethodLength")
     */
    private function getTriggersForJournal(TransactionJournal $journal): array
    {
        // TODO duplicated code.
        $operators               = config('search.operators');
        $triggers                = [];
        foreach ($operators as $key => $operator) {
            if ('user_action' !== $key && false === $operator['alias']) {
                $triggers[$key] = (string) trans(sprintf('firefly.rule_trigger_%s_choice', $key));
            }
        }
        asort($triggers);

        $result                  = [];
        $journalTriggers         = [];
        $values                  = [];
        $index                   = 0;

        // amount, description, category, budget, tags, source, destination, notes, currency type
        // ,type
        /** @var null|Transaction $source */
        $source                  = $journal->transactions()->where('amount', '<', 0)->first();

        /** @var null|Transaction $destination */
        $destination             = $journal->transactions()->where('amount', '>', 0)->first();
        if (null === $destination || null === $source) {
            return $result;
        }
        // type
        $journalTriggers[$index] = 'transaction_type';
        $values[$index]          = $journal->transactionType->type;
        ++$index;

        // currency
        $journalTriggers[$index] = 'currency_is';
        $values[$index]          = sprintf('%s (%s)', $journal->transactionCurrency?->name, $journal->transactionCurrency?->code);
        ++$index;

        // amount_exactly:
        $journalTriggers[$index] = 'amount_is';
        $values[$index]          = $destination->amount;
        ++$index;

        // description_is:
        $journalTriggers[$index] = 'description_is';
        $values[$index]          = $journal->description;
        ++$index;

        // from_account_is
        $journalTriggers[$index] = 'source_account_is';
        $values[$index]          = $source->account->name;
        ++$index;

        // to_account_is
        $journalTriggers[$index] = 'destination_account_is';
        $values[$index]          = $destination->account->name;
        ++$index;

        // category (if)
        $category                = $journal->categories()->first();
        if (null !== $category) {
            $journalTriggers[$index] = 'category_is';
            $values[$index]          = $category->name;
            ++$index;
        }
        // budget (if)
        $budget                  = $journal->budgets()->first();
        if (null !== $budget) {
            $journalTriggers[$index] = 'budget_is';
            $values[$index]          = $budget->name;
            ++$index;
        }
        // tags (if)
        $tags                    = $journal->tags()->get();

        /** @var Tag $tag */
        foreach ($tags as $tag) {
            $journalTriggers[$index] = 'tag_is';
            $values[$index]          = $tag->tag;
            ++$index;
        }
        // notes (if)
        $notes                   = $journal->notes()->first();
        if (null !== $notes) {
            $journalTriggers[$index] = 'notes_is';
            $values[$index]          = $notes->text;
        }

        foreach ($journalTriggers as $ii => $trigger) {
            try {
                $renderInfo = [
                    'oldTrigger'    => $trigger,
                    'oldValue'      => $values[$ii],
                    'oldProhibited' => null,
                    'oldChecked'    => false,
                    'count'         => $ii + 1,
                    'triggers'      => $triggers,
                ];
                $string     = view('rules.partials.trigger', $renderInfo)->render();
            } catch (Throwable $e) {
                Log::debug(sprintf('Throwable was thrown in getTriggersForJournal(): %s', $e->getMessage()));
                Log::debug($e->getTraceAsString());

                throw new FireflyException(sprintf('Could not render trigger: %s', $e->getMessage()), 0, $e);
            }
            if ('' !== $string) {
                $result[] = $string;
            }
        }

        return $result;
    }
}