Skip to content

Firefly III: a personal finances manager

10.8 KB
Raw Blame
<?php

/**
 * ShowController.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\Http\Controllers\Account;

use Carbon\Carbon;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Helpers\Collector\GroupCollectorInterface;
use FireflyIII\Http\Controllers\Controller;
use FireflyIII\Models\Account;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Support\Debug\Timer;
use FireflyIII\Support\Facades\Preferences;
use FireflyIII\Support\Facades\Steam;
use FireflyIII\Support\Http\Controllers\PeriodOverview;
use Illuminate\Contracts\View\Factory;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Routing\Redirector;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Log;
use Illuminate\View\View;
use Psr\Container\ContainerExceptionInterface;
use Psr\Container\NotFoundExceptionInterface;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

/**
 * Class ShowController
 */
final class ShowController extends Controller
{
    use PeriodOverview;

    private AccountRepositoryInterface $repository;

    /**
     * ShowController constructor.
     */
    public function __construct()
    {
        parent::__construct();

        app('view')->share('showCategory', true);

        // translations:
        $this->middleware(function ($request, $next) {
            app('view')->share('mainTitleIcon', 'bi-credit-card');
            app('view')->share('title', (string) trans('firefly.accounts'));

            $this->repository = app(AccountRepositoryInterface::class);

            return $next($request);
        });
    }

    /**
     * Show an account.
     *
     * @return Factory|RedirectResponse|View
     *
     * @throws ContainerExceptionInterface
     * @throws FireflyException
     * @throws NotFoundExceptionInterface
     */
    public function show(
        Request $request,
        Account $account,
        ?Carbon $start = null,
        ?Carbon $end = null
    ): Factory|\Illuminate\Contracts\View\View|Redirector|RedirectResponse {
        if (0 === $account->id) {
            throw new NotFoundHttpException();
        }
        $objectType       = config(sprintf('firefly.shortNamesByFullName.%s', $account->accountType->type));

        if (!$this->isEditableAccount($account)) {
            return $this->redirectAccountToAccount($account);
        }

        $start ??= session('start');
        $end   ??= session('end');

        /** @var Carbon $start */
        /** @var Carbon $end */
        if ($end->lt($start)) {
            [$start, $end] = [$end, $start];
        }

        // make sure dates are end of day and start of day:
        $start->startOfDay();
        $end->endOfDay()->milli(0);

        $location         = $this->repository->getLocation($account);
        $attachments      = $this->repository->getAttachments($account);
        $today            = today(config('app.timezone'));
        $subTitleIcon     = config(sprintf('firefly.subIconsByIdentifier.%s', $account->accountType->type));
        $page             = (int) $request->input('page');
        $pageSize         = (int) Preferences::get('listPageSize', 50)->data;
        $accountCurrency  = $this->repository->getAccountCurrency($account);
        $currency         = $accountCurrency ?? $this->primaryCurrency;
        $fStart           = $start->isoFormat($this->monthAndDayFormat);
        $fEnd             = $end->isoFormat($this->monthAndDayFormat);
        $isLiability      = $this->repository->isLiability($account);
        $subTitle         = (string) trans('firefly.journals_in_period_for_account', ['name' => $account->name, 'start' => $fStart, 'end' => $fEnd]);
        $chartUrl         = route('chart.account.period', [$account->id, $start->format('Y-m-d'), $end->format('Y-m-d')]);
        $firstTransaction = $this->repository->oldestJournalDate($account) ?? $start;

        // go back max 3 years.
        $threeYearsAgo    = clone $start;
        $threeYearsAgo->startOfYear()->subYears(3);
        if ($firstTransaction->lt($threeYearsAgo)) {
            $firstTransaction = clone $threeYearsAgo;
        }

        Log::debug('Start period overview');
        $timer            = Timer::getInstance();
        $timer->start('period-overview');
        $periods          = $this->getAccountPeriodOverview($account, $firstTransaction, $end);

        Log::debug('End period overview');
        $timer->stop('period-overview');

        Log::debug('Collect transactions');
        $timer->start('collection');

        /** @var GroupCollectorInterface $collector */
        $collector        = app(GroupCollectorInterface::class);
        $collector
            ->setAccounts(new Collection()->push($account))
            ->setLimit($pageSize)
            ->setPage($page)
            ->withAttachmentInformation()
            ->withAPIInformation()
            ->setRange($start, $end)
        ;
        // this search will not include transaction groups where this asset account (or liability)
        // is just part of ONE of the journals. To force this:
        $collector->setExpandGroupSearch(true);
        $groups           = $collector->getPaginatedGroups();

        Log::debug('End collect transactions');
        $timer->stop('collection');
        $groups->setPath(route('accounts.show', [$account->id, $start->format('Y-m-d'), $end->format('Y-m-d')]));
        $now              = now();
        if ($now->gt($end) || $now->lt($start)) {
            $now = $end;
        }

        // 2025-10-08 replace finalAccountBalance with accountsBalancesOptimized.
        $balances         = Steam::accountsBalancesOptimized(new Collection()->push($account), $now)[$account->id];
        // $balances         = Steam::filterAccountBalance(Steam::finalAccountBalance($account, $now), $account, $this->convertToPrimary, $accountCurrency);

        return view('accounts.show', [
            'account'      => $account,
            'showAll'      => false,
            'objectType'   => $objectType,
            'currency'     => $currency,
            'today'        => $today,
            'periods'      => $periods,
            'isLiability'  => $isLiability,
            'subTitleIcon' => $subTitleIcon,
            'groups'       => $groups,
            'attachments'  => $attachments,
            'subTitle'     => $subTitle,
            'start'        => $start,
            'end'          => $end,
            'chartUrl'     => $chartUrl,
            'location'     => $location,
            'balances'     => $balances,
        ]);
    }

    /**
     * Show an account.
     *
     * @return Factory|RedirectResponse|View
     *
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
    public function showAll(Request $request, Account $account): Factory|\Illuminate\Contracts\View\View|Redirector|RedirectResponse
    {
        if (!$this->isEditableAccount($account)) {
            return $this->redirectAccountToAccount($account);
        }
        $location     = $this->repository->getLocation($account);
        $isLiability  = $this->repository->isLiability($account);
        $attachments  = $this->repository->getAttachments($account);
        $objectType   = config(sprintf('firefly.shortNamesByFullName.%s', $account->accountType->type));
        $end          = today(config('app.timezone'));
        $today        = today(config('app.timezone'));
        $this->repository->getAccountCurrency($account);
        $start        = $this->repository->oldestJournalDate($account) ?? today(config('app.timezone'))->startOfMonth();
        $subTitleIcon = config('firefly.subIconsByIdentifier.'.$account->accountType->type);
        $page         = (int) $request->input('page');
        $page         = clamp($page, 1, 2 ** 16);
        $pageSize     = (int) Preferences::get('listPageSize', 50)->data;
        $currency     = $this->repository->getAccountCurrency($account) ?? $this->primaryCurrency;
        $subTitle     = (string) trans('firefly.all_journals_for_account', ['name' => $account->name]);
        $periods      = new Collection();

        $end->endOfDay();

        /** @var GroupCollectorInterface $collector */
        $collector    = app(GroupCollectorInterface::class);
        $collector->setAccounts(new Collection()->push($account))->withAPIInformation()->setLimit($pageSize)->setPage($page)->withAccountInformation();

        // this search will not include transaction groups where this asset account (or liability)
        // is just part of ONE of the journals. To force this:
        $collector->setExpandGroupSearch(true);

        $groups       = $collector->getPaginatedGroups();
        $groups->setPath(route('accounts.show.all', [$account->id]));
        $chartUrl     = route('chart.account.period', [$account->id, $start->format('Y-m-d'), $end->format('Y-m-d')]);
        $showAll      = true;
        // correct
        Log::debug(sprintf('showAll: Call accountsBalancesOptimized with date/time "%s"', $end->toIso8601String()));

        $now          = now();
        if ($now->gt($end) || $now->lt($start)) {
            $now = $end;
        }

        // 2025-10-08 replace finalAccountBalance with accountsBalancesOptimized.
        // $balances = Steam::finalAccountBalance($account, $end);
        // $balances        = Steam::filterAccountBalance($balances, $account, $this->convertToPrimary, $accountCurrency);
        $balances     = Steam::accountsBalancesOptimized(new Collection()->push($account), $now)[$account->id];

        return view('accounts.show', [
            'account'      => $account,
            'showAll'      => $showAll,
            'location'     => $location,
            'objectType'   => $objectType,
            'isLiability'  => $isLiability,
            'attachments'  => $attachments,
            'currency'     => $currency,
            'today'        => $today,
            'chartUrl'     => $chartUrl,
            'periods'      => $periods,
            'subTitleIcon' => $subTitleIcon,
            'groups'       => $groups,
            'subTitle'     => $subTitle,
            'start'        => $start,
            'end'          => $end,
            'balances'     => $balances,
        ]);
    }
}