firefly-iii/app/Support/Chart/Budget/FrontpageChartGenerator.php

<?php

/**
 * FrontpageChartGenerator.php
 * Copyright (c) 2020 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\Chart\Budget;

use Carbon\Carbon;
use FireflyIII\Models\Budget;
use FireflyIII\Models\BudgetLimit;
use FireflyIII\Models\TransactionCurrency;
use FireflyIII\Repositories\Budget\BudgetLimitRepositoryInterface;
use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
use FireflyIII\Repositories\Budget\OperationsRepositoryInterface;
use FireflyIII\User;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Log;

/**
 * Class FrontpageChartGenerator
 */
class FrontpageChartGenerator
{
    public bool                                     $convertToPrimary = false;
    public TransactionCurrency                      $default;
    protected OperationsRepositoryInterface         $opsRepository;
    private readonly BudgetLimitRepositoryInterface $blRepository;
    private readonly BudgetRepositoryInterface      $budgetRepository;
    private Carbon                                  $end;
    private string                                  $monthAndDayFormat;
    private Carbon                                  $start;

    /**
     * FrontpageChartGenerator constructor.
     */
    public function __construct()
    {
        $this->budgetRepository  = app(BudgetRepositoryInterface::class);
        $this->blRepository      = app(BudgetLimitRepositoryInterface::class);
        $this->opsRepository     = app(OperationsRepositoryInterface::class);
        $this->monthAndDayFormat = '';
    }

    /**
     * Generate the data for a budget chart. Collect all budgets and process each budget.
     *
     * @return array[]
     */
    public function generate(): array
    {
        Log::debug('Now in generate for budget chart.');
        $budgets = $this->budgetRepository->getActiveBudgets();
        $data    = [
            ['label' => (string) trans('firefly.spent_in_budget'), 'entries' => [], 'type' => 'bar'],
            ['label' => (string) trans('firefly.left_to_spend'), 'entries' => [], 'type' => 'bar'],
            ['label' => (string) trans('firefly.overspent'), 'entries' => [], 'type' => 'bar'],
        ];

        // loop al budgets:
        /** @var Budget $budget */
        foreach ($budgets as $budget) {
            $data = $this->processBudget($data, $budget);
        }
        Log::debug('DONE with generate budget chart.');

        return $data;
    }

    /**
     * For each budget, gets all budget limits for the current time range.
     * When no limits are present, the time range is used to collect information on money spent.
     * If limits are present, each limit is processed individually.
     */
    private function processBudget(array $data, Budget $budget): array
    {
        Log::debug(sprintf('Now processing budget #%d ("%s")', $budget->id, $budget->name));
        // get all limits:
        $limits = $this->blRepository->getBudgetLimits($budget, $this->start, $this->end);
        Log::debug(sprintf('Found %d limit(s) for budget #%d.', $limits->count(), $budget->id));
        // if no limits
        if (0 === $limits->count()) {
            $result = $this->noBudgetLimits($data, $budget);
            Log::debug(sprintf('Now DONE processing budget #%d ("%s")', $budget->id, $budget->name));

            return $result;
        }
        $result = $this->budgetLimits($data, $budget, $limits);
        Log::debug(sprintf('Now DONE processing budget #%d ("%s")', $budget->id, $budget->name));

        return $result;
    }

    /**
     * When no limits are present, the expenses of the whole period are collected and grouped.
     * This is grouped per currency. Because there is no limit set, "left to spend" and "overspent" are empty.
     */
    private function noBudgetLimits(array $data, Budget $budget): array
    {
        $spent = $this->opsRepository->sumExpenses($this->start, $this->end, null, new Collection([$budget]));

        /** @var array $entry */
        foreach ($spent as $entry) {
            $title                      = sprintf('%s (%s)', $budget->name, $entry['currency_name']);
            $data[0]['entries'][$title] = bcmul((string) $entry['sum'], '-1'); // spent
            $data[1]['entries'][$title] = 0;                                   // left to spend
            $data[2]['entries'][$title] = 0;                                   // overspent
        }

        return $data;
    }

    /**
     * If a budget has budget limit, each limit is processed individually.
     */
    private function budgetLimits(array $data, Budget $budget, Collection $limits): array
    {
        Log::debug('Start processing budget limits.');

        /** @var BudgetLimit $limit */
        foreach ($limits as $limit) {
            $data = $this->processLimit($data, $budget, $limit);
        }
        Log::debug('Done processing budget limits.');

        return $data;
    }

    /**
     * For each limit, the expenses from the time range of the limit are collected. Each row from the result is
     * processed individually.
     */
    private function processLimit(array $data, Budget $budget, BudgetLimit $limit): array
    {
        $usePrimary = $this->convertToPrimary && $this->default->id !== $limit->transaction_currency_id;
        $currency   = $limit->transactionCurrency;
        if ($usePrimary) {
            Log::debug(sprintf('Processing limit #%d with (primary currency) %s %s', $limit->id, $this->default->code, $limit->native_amount));
        }
        if (!$usePrimary) {
            Log::debug(sprintf('Processing limit #%d with %s %s', $limit->id, $limit->transactionCurrency->code, $limit->amount));
        }

        $spent      = $this->opsRepository->sumExpenses($limit->start_date, $limit->end_date, null, new Collection([$budget]), $currency);
        Log::debug(sprintf('Spent array has %d entries.', count($spent)));

        /** @var array $entry */
        foreach ($spent as $entry) {
            // only spent the entry where the entry's currency matches the budget limit's currency
            // or when usePrimary is true.
            if ($entry['currency_id'] === $limit->transaction_currency_id || $usePrimary) {
                Log::debug(sprintf('Process spent row (%s)', $entry['currency_code']));
                $data = $this->processRow($data, $budget, $limit, $entry);
            }
            if (!($entry['currency_id'] === $limit->transaction_currency_id || $usePrimary)) {
                Log::debug(sprintf('Skipping spent row (%s).', $entry['currency_code']));
            }
        }

        return $data;
    }

    /**
     * Each row of expenses from a budget limit is in another currency (note $entry['currency_name']).
     *
     * Each one is added to the $data array. If the limit's date range is different from the global $start and $end
     * dates, for example when a limit only partially falls into this month, the title is expanded to clarify.
     */
    private function processRow(array $data, Budget $budget, BudgetLimit $limit, array $entry): array
    {
        $title                      = sprintf('%s (%s)', $budget->name, $entry['currency_name']);
        Log::debug(sprintf('Title is "%s"', $title));
        if ($limit->start_date->startOfDay()->ne($this->start->startOfDay()) || $limit->end_date->startOfDay()->ne($this->end->startOfDay())) {
            $title = sprintf(
                '%s (%s) (%s - %s)',
                $budget->name,
                $entry['currency_name'],
                $limit->start_date->isoFormat($this->monthAndDayFormat),
                $limit->end_date->isoFormat($this->monthAndDayFormat)
            );
        }
        $usePrimary                 = $this->convertToPrimary && $this->default->id !== $limit->transaction_currency_id;
        $amount                     = $limit->amount;
        Log::debug(sprintf('Amount is "%s".', $amount));
        if ($usePrimary && $limit->transaction_currency_id !== $this->default->id) {
            $amount = $limit->native_amount;
            Log::debug(sprintf('Amount is now "%s".', $amount));
        }
        $amount                     ??= '0';
        $sumSpent                   = bcmul((string) $entry['sum'], '-1'); // spent
        $data[0]['entries'][$title] ??= '0';
        $data[1]['entries'][$title] ??= '0';
        $data[2]['entries'][$title] ??= '0';

        $data[0]['entries'][$title] = bcadd((string) $data[0]['entries'][$title], 1 === bccomp($sumSpent, $amount) ? $amount : $sumSpent);                                       // spent
        $data[1]['entries'][$title] = bcadd((string) $data[1]['entries'][$title], 1 === bccomp($amount, $sumSpent) ? bcadd((string) $entry['sum'], $amount) : '0');              // left to spent
        $data[2]['entries'][$title] = bcadd((string) $data[2]['entries'][$title], 1 === bccomp($amount, $sumSpent) ? '0' : bcmul(bcadd((string) $entry['sum'], $amount), '-1')); // overspent

        Log::debug(sprintf('Amount [spent]     is now %s.', $data[0]['entries'][$title]));
        Log::debug(sprintf('Amount [left]      is now %s.', $data[1]['entries'][$title]));
        Log::debug(sprintf('Amount [overspent] is now %s.', $data[2]['entries'][$title]));

        return $data;
    }

    public function setEnd(Carbon $end): void
    {
        $this->end = $end;
    }

    public function setStart(Carbon $start): void
    {
        $this->start = $start;
    }

    /**
     * A basic setter for the user. Also updates the repositories with the right user.
     */
    public function setUser(User $user): void
    {
        $this->budgetRepository->setUser($user);
        $this->blRepository->setUser($user);
        $this->opsRepository->setUser($user);

        $locale                  = app('steam')->getLocale();
        $this->monthAndDayFormat = (string) trans('config.month_and_day_js', [], $locale);
    }
}