firefly-iii/app/Support/Http/Controllers/UserNavigation.php

<?php
/**
 * UserNavigation.php
 * Copyright (c) 2019 james@firefly-iii.org
 *
 * 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\Models\Account;
use FireflyIII\Models\AccountType;
use FireflyIII\Models\Transaction;
use FireflyIII\Models\TransactionGroup;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Models\TransactionType;
use Illuminate\Http\RedirectResponse;
use Illuminate\Routing\Redirector;
use Illuminate\Support\Str;
use Illuminate\Support\ViewErrorBag;
use Log;

/**
 * Trait UserNavigation
 *
 */
trait UserNavigation
{

    /**
     * Functionality:.
     *
     * - If the $identifier contains the word "delete" then a remembered uri with the text "/show/" in it will not be returned but instead the index (/)
     *   will be returned.
     * - If the remembered uri contains "jscript/" the remembered uri will not be returned but instead the index (/) will be returned.
     *
     * @param string $identifier
     *
     * @return string
     */
    final protected function getPreviousUri(string $identifier): string
    {
        Log::debug(sprintf('Trying to retrieve URL stored under "%s"', $identifier));
        $uri = (string)session($identifier);
        Log::debug(sprintf('The URI is %s', $uri));

        if (false !== strpos($uri, 'jscript')) {
            $uri = $this->redirectUri; 
            Log::debug(sprintf('URI is now %s (uri contains jscript)', $uri));
        }

        Log::debug(sprintf('Return direct link %s', $uri));

        return $uri;
    }

    /**
     * Will return false if you cant edit this account type.
     *
     * @param Account $account
     *
     * @return bool
     */
    final protected function isEditableAccount(Account $account): bool
    {
        $editable = [AccountType::EXPENSE, AccountType::REVENUE, AccountType::ASSET, AccountType::LOAN, AccountType::DEBT, AccountType::MORTGAGE];
        $type     = $account->accountType->type;

        return in_array($type, $editable, true);
    }

    /**
     * @param TransactionGroup $group
     *
     * @return bool
     */
    final protected function isEditableGroup(TransactionGroup $group): bool
    {
        /** @var TransactionJournal|null $journal */
        $journal = $group->transactionJournals()->first();
        if (null === $journal) {
            return false;
        }
        $type     = $journal->transactionType->type;
        $editable = [TransactionType::WITHDRAWAL, TransactionType::TRANSFER, TransactionType::DEPOSIT, TransactionType::RECONCILIATION];

        return in_array($type, $editable, true);
    }

    /**
     * @param Account $account
     *
     * @return RedirectResponse|Redirector
     */
    final protected function redirectAccountToAccount(Account $account)
    {
        $type = $account->accountType->type;
        if (AccountType::RECONCILIATION === $type || AccountType::INITIAL_BALANCE === $type) {
            // reconciliation must be stored somewhere in this account's transactions.

            /** @var Transaction|null $transaction */
            $transaction = $account->transactions()->first();
            if (null === $transaction) {
                Log::error(sprintf('Account #%d has no transactions. Dont know where it belongs.', $account->id));
                session()->flash('error', trans('firefly.cant_find_redirect_account'));

                return redirect(route('index'));
            }
            $journal = $transaction->transactionJournal;
            /** @var Transaction|null $other */
            $other = $journal->transactions()->where('id', '!=', $transaction->id)->first();
            if (null === $other) {
                Log::error(sprintf('Account #%d has no valid journals. Dont know where it belongs.', $account->id));
                session()->flash('error', trans('firefly.cant_find_redirect_account'));

                return redirect(route('index'));
            }

            return redirect(route('accounts.show', [$other->account_id]));
        }

        return redirect(route('index'));
    }

    /**
     * @param TransactionGroup $group
     *
     * @return RedirectResponse|Redirector
     */
    final protected function redirectGroupToAccount(TransactionGroup $group)
    {
        /** @var TransactionJournal|null $journal */
        $journal = $group->transactionJournals()->first();
        if (null === $journal) {
            Log::error(sprintf('No journals in group #%d', $group->id));

            return redirect(route('index'));
        }
        // prefer redirect to everything but expense and revenue:
        $transactions = $journal->transactions;
        $ignore       = [AccountType::REVENUE, AccountType::EXPENSE, AccountType::RECONCILIATION, AccountType::INITIAL_BALANCE];
        /** @var Transaction $transaction */
        foreach ($transactions as $transaction) {
            $type = $transaction->account->accountType->type;
            if (!in_array($type, $ignore, true)) {
                return redirect(route('accounts.edit', [$transaction->account_id]));
            }
        }

        return redirect(route('index'));
    }

    /**
     * @param string $identifier
     *
     * @return string|null
     */
    final protected function rememberPreviousUri(string $identifier): ?string
    {
        $return = app('url')->previous();
        /** @var ViewErrorBag|null $errors */
        $errors    = session()->get('errors');
        $forbidden = ['json', 'debug'];
        if ((null === $errors || (0 === $errors->count())) && !Str::contains($return, $forbidden)) {
            Log::debug(sprintf('Saving URL %s under key %s', $return, $identifier));
            session()->put($identifier, $return);
        }

        return $return;
    }
}