Skip to content

Firefly III: a personal finances manager

12.7 KB
Raw Blame
<?php

/**
 * ReconcileController.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\Json;

use Carbon\Carbon;
use FireflyIII\Enums\TransactionTypeEnum;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Helpers\Collector\GroupCollectorInterface;
use FireflyIII\Http\Controllers\Controller;
use FireflyIII\Models\Account;
use FireflyIII\Models\TransactionCurrency;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Rules\System\IsValidOriginUrl;
use FireflyIII\Support\Facades\Steam;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\View as ViewFacade;
use Throwable;

/**
 * Class ReconcileController
 */
final class ReconcileController extends Controller
{
    private AccountRepositoryInterface $accountRepos;

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

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

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

    /**
     * Overview of reconciliation.
     *
     * @throws FireflyException
     */
    public function overview(Request $request, ?Account $account = null, ?Carbon $start = null, ?Carbon $end = null): JsonResponse
    {
        $startBalance    = $request->input('startBalance');
        $endBalance      = $request->input('endBalance');
        $accountCurrency = $this->accountRepos->getAccountCurrency($account) ?? $this->primaryCurrency;
        $amount          = '0';
        $clearedAmount   = '0';

        if (!$start instanceof Carbon && !$end instanceof Carbon) {
            throw new FireflyException('Invalid dates submitted.');
        }
        if (!is_numeric($startBalance)) {
            $startBalance = '0';
        }
        if (!is_numeric($endBalance)) {
            $endBalance = '0';
        }
        if ($end->lt($start)) {
            [$start, $end] = [$end, $start];
        }
        $end->endOfDay();
        $start->startOfDay();

        $route           = route('accounts.reconcile.submit', [$account->id, $start->format('Ymd'), $end->format('Ymd')]);
        $selectedIds     = $request->input('journals') ?? [];
        $clearedJournals = [];
        $clearedIds      = $request->input('cleared') ?? [];
        $journals        = [];
        // Collect all submitted journals
        if (count($selectedIds) > 0) {
            /** @var GroupCollectorInterface $collector */
            $collector = app(GroupCollectorInterface::class);
            $collector->setJournalIds($selectedIds);
            $journals  = $collector->getExtractedJournals();
        }

        // Collect all journals already reconciled
        if (count($clearedIds) > 0) {
            /** @var GroupCollectorInterface $collector */
            $collector       = app(GroupCollectorInterface::class);
            $collector->setJournalIds($clearedIds);
            $clearedJournals = $collector->getExtractedJournals();
        }

        /** @var array $journal */
        foreach ($journals as $journal) {
            $amount = $this->processJournal($account, $accountCurrency, $journal, $amount);
        }
        Log::debug(sprintf('Final amount is %s', $amount));

        /** @var array $journal */
        foreach ($clearedJournals as $journal) {
            if ($journal['date'] <= $end) {
                $clearedAmount = $this->processJournal($account, $accountCurrency, $journal, $clearedAmount);
            }
        }
        Log::debug(sprintf('Start balance: "%s"', $startBalance));
        Log::debug(sprintf('End balance: "%s"', $endBalance));
        Log::debug(sprintf('Cleared amount: "%s"', $clearedAmount));
        Log::debug(sprintf('Amount: "%s"', $amount));
        $difference      = bcadd(bcadd(bcsub($startBalance, $endBalance), $clearedAmount), $amount);
        $diffCompare     = bccomp($difference, '0');
        $countCleared    = count($clearedJournals);
        $reconSum        = bcadd(bcadd($startBalance, $amount), $clearedAmount);

        try {
            $view = view('accounts.reconcile.overview', [
                'account'       => $account,
                'start'         => $start,
                'diffCompare'   => $diffCompare,
                'difference'    => $difference,
                'end'           => $end,
                'clearedAmount' => $clearedAmount,
                'startBalance'  => $startBalance,
                'endBalance'    => $endBalance,
                'amount'        => $amount,
                'route'         => $route,
                'countCleared'  => $countCleared,
                'reconSum'      => $reconSum,
                'selectedIds'   => $selectedIds,
            ])->render();
        } catch (Throwable $e) {
            Log::debug(sprintf('View error: %s', $e->getMessage()));
            Log::error($e->getTraceAsString());
            $view = sprintf('Could not render accounts.reconcile.overview: %s', $e->getMessage());

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

        $return          = ['post_url' => $route, 'html' => $view];

        return response()->json($return);
    }

    /**
     * Returns a list of transactions in a modal.
     *
     * @return JsonResponse
     *
     * @throws FireflyException
     */
    public function transactions(Request $request, Account $account, ?Carbon $start = null, ?Carbon $end = null)
    {
        if (!$start instanceof Carbon || !$end instanceof Carbon) {
            throw new FireflyException('Invalid dates submitted.');
        }
        if ($end->lt($start)) {
            [$end, $start] = [$start, $end];
        }
        $start->endOfDay();
        $end->endOfDay();
        $startDate      = clone $start;
        $startDate->subDay();

        // validate from or exit
        $from           = $request->input('_from');
        $validator      = validator(['_from' => $from], ['nullable', 'max:255', new IsValidOriginUrl()]);
        if ($validator->fails()) {
            throw new FireflyException(trans('validation.bad_url_parts'));
        }
        ViewFacade::share('FF3_FROM', $from);

        $currency       = $this->accountRepos->getAccountCurrency($account) ?? $this->primaryCurrency;
        // correct
        Log::debug(sprintf('transactions: Call accountsBalancesOptimized with date/time "%s"', $startDate->toIso8601String()));
        Log::debug(sprintf('transactions2: Call accountsBalancesOptimized with date/time "%s"', $end->toIso8601String()));

        // 2025-10-08 replace finalAccountBalance with accountsBalancesOptimized
        //        $startBalance   = Steam::bcround(Steam::finalAccountBalance($account, $startDate)['balance'], $currency->decimal_places);
        //        $endBalance     = Steam::bcround(Steam::finalAccountBalance($account, $end)['balance'], $currency->decimal_places);

        $startBalance   = Steam::accountsBalancesOptimized(new Collection()->push($account), $startDate)[$account->id];
        $endBalance     = Steam::accountsBalancesOptimized(new Collection()->push($account), $end)[$account->id];
        // round balances.
        foreach ($startBalance as $key => $value) {
            $startBalance[$key] = Steam::bcround($value, $currency->decimal_places);
        }
        foreach ($endBalance as $key => $value) {
            $endBalance[$key] = Steam::bcround($value, $currency->decimal_places);
        }

        // get the transactions
        $selectionStart = clone $start;
        $selectionStart->startOfDay();
        $selectionStart->subDays(3);
        $selectionEnd   = clone $end;
        $selectionEnd->endOfDay();
        $selectionEnd->addDays(3);

        // to make sure the bar is in the right place:
        $start->startOfDay();

        // grab transactions:
        /** @var GroupCollectorInterface $collector */
        $collector      = app(GroupCollectorInterface::class);

        $collector
            ->setAccounts(new Collection()->push($account))
            ->setRange($selectionStart, $selectionEnd)
            ->withBudgetInformation()
            ->withCategoryInformation()
            ->withAccountInformation()
        ;
        $array          = $collector->getExtractedJournals();
        $journals       = $this->processTransactions($account, $array);

        try {
            $html = view('accounts.reconcile.transactions', [
                'account'        => $account,
                'journals'       => $journals,
                'currency'       => $currency,
                'start'          => $start,
                'end'            => $end,
                'selectionStart' => $selectionStart,
                'selectionEnd'   => $selectionEnd,
            ])->render();
        } catch (Throwable $e) {
            Log::debug(sprintf('Could not render: %s', $e->getMessage()));
            Log::error($e->getTraceAsString());
            $html = sprintf('Could not render accounts.reconcile.transactions: %s', $e->getMessage());

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

        return response()->json(['html' => $html, 'startBalance' => $startBalance, 'endBalance' => $endBalance]);
    }

    private function processJournal(Account $account, TransactionCurrency $currency, array $journal, string $amount): string
    {
        $toAdd  = '0';
        Log::debug(sprintf('User submitted %s #%d: "%s"', $journal['transaction_type_type'], $journal['transaction_journal_id'], $journal['description']));

        // not much magic below we need to cover using tests.

        if ($account->id === $journal['source_account_id']) {
            if ($currency->id === $journal['currency_id']) {
                $toAdd = $journal['amount'];
            }
            if (null !== $journal['foreign_currency_id'] && $journal['foreign_currency_id'] === $currency->id) {
                $toAdd = $journal['foreign_amount'];
            }
        }
        if ($account->id === $journal['destination_account_id']) {
            if ($currency->id === $journal['currency_id']) {
                $toAdd = bcmul((string) $journal['amount'], '-1');
            }
            if (null !== $journal['foreign_currency_id'] && $journal['foreign_currency_id'] === $currency->id) {
                $toAdd = bcmul((string) $journal['foreign_amount'], '-1');
            }
        }

        Log::debug(sprintf('Going to add %s to %s', $toAdd, $amount));
        $amount = bcadd($amount, (string) $toAdd);
        Log::debug(sprintf('Result is %s', $amount));

        return $amount;
    }

    /**
     * "fix" amounts to make it easier on the reconciliation overview:
     */
    private function processTransactions(Account $account, array $array): array
    {
        $journals = [];

        /** @var array $journal */
        foreach ($array as $journal) {
            $inverse    = false;

            if (TransactionTypeEnum::DEPOSIT->value === $journal['transaction_type_type']) {
                $inverse = true;
            }
            // transfer to this account? then positive amount:
            if (TransactionTypeEnum::TRANSFER->value === $journal['transaction_type_type'] && $account->id === $journal['destination_account_id']) {
                $inverse = true;
            }

            // opening balance into account? then positive amount:
            if (TransactionTypeEnum::OPENING_BALANCE->value === $journal['transaction_type_type'] && $account->id === $journal['destination_account_id']) {
                $inverse = true;
            }

            if ($inverse) {
                $journal['amount'] = Steam::positive($journal['amount']);
                if (null !== $journal['foreign_amount']) {
                    $journal['foreign_amount'] = Steam::positive($journal['foreign_amount']);
                }
            }

            $journals[] = $journal;
        }

        return $journals;
    }
}