firefly-iii/app/Api/V2/Controllers/Chart/AccountController.php

<?php

/*
 * AccountController.php
 * Copyright (c) 2022 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\Api\V2\Controllers\Chart;

use Carbon\Carbon;
use FireflyIII\Api\V2\Controllers\Controller;
use FireflyIII\Api\V2\Request\Chart\DashboardChartRequest;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\Account;
use FireflyIII\Models\AccountType;
use FireflyIII\Models\TransactionCurrency;
use FireflyIII\Repositories\UserGroups\Account\AccountRepositoryInterface;
use FireflyIII\Support\Http\Api\CleansChartData;
use FireflyIII\Support\Http\Api\ValidatesUserGroupTrait;
use Illuminate\Http\JsonResponse;
use Illuminate\Support\Collection;

/**
 * Class AccountController
 */
class AccountController extends Controller
{
    use CleansChartData;
    use ValidatesUserGroupTrait;

    private AccountRepositoryInterface $repository;

    public function __construct()
    {
        parent::__construct();
        $this->middleware(
            function ($request, $next) {
                $this->repository = app(AccountRepositoryInterface::class);
                $userGroup        = $this->validateUserGroup($request);
                if (null !== $userGroup) {
                    $this->repository->setUserGroup($userGroup);
                }

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

    /**
     * This endpoint is documented at
     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v2)#/charts/getChartAccountOverview
     *
     * The native currency is the preferred currency on the page /currencies.
     *
     * If a transaction has foreign currency = native currency, the foreign amount will be used, no conversion
     * will take place.
     *
     * TODO validate and set user_group_id from request
     *
     * @throws FireflyException
     *
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function dashboard(DashboardChartRequest $request): JsonResponse
    {
        /** @var Carbon $start */
        $start = $this->parameters->get('start');

        /** @var Carbon $end */
        $end = $this->parameters->get('end');
        $end->endOfDay();

        /** @var TransactionCurrency $default */
        $default = app('amount')->getDefaultCurrency();
        $params  = $request->getAll();

        /** @var Collection $accounts */
        $accounts  = $params['accounts'];
        $chartData = [];

        // user's preferences
        if (0 === $accounts->count()) {
            $defaultSet = $this->repository->getAccountsByType([AccountType::ASSET, AccountType::DEFAULT])->pluck('id')->toArray();
            $frontPage  = app('preferences')->get('frontPageAccounts', $defaultSet);

            if (!(is_array($frontPage->data) && count($frontPage->data) > 0)) {
                $frontPage->data = $defaultSet;
                $frontPage->save();
            }

            $accounts = $this->repository->getAccountsById($frontPage->data);
        }

        // both options are overruled by "preselected"
        if ('all' === $params['preselected']) {
            $accounts = $this->repository->getAccountsByType([AccountType::ASSET, AccountType::DEFAULT, AccountType::LOAN, AccountType::DEBT, AccountType::MORTGAGE]);
        }
        if ('assets' === $params['preselected']) {
            $accounts = $this->repository->getAccountsByType([AccountType::ASSET, AccountType::DEFAULT]);
        }
        if ('liabilities' === $params['preselected']) {
            $accounts = $this->repository->getAccountsByType([AccountType::LOAN, AccountType::DEBT, AccountType::MORTGAGE]);
        }

        /** @var Account $account */
        foreach ($accounts as $account) {
            $currency = $this->repository->getAccountCurrency($account);
            if (null === $currency) {
                $currency = $default;
            }
            $currentSet     = [
                'label'                   => $account->name,
                // the currency that belongs to the account.
                'currency_id'             => (string)$currency->id,
                'currency_code'           => $currency->code,
                'currency_symbol'         => $currency->symbol,
                'currency_decimal_places' => $currency->decimal_places,

                // the default currency of the user (could be the same!)
                'native_currency_id'               => (string)$default->id,
                'native_currency_code'             => $default->code,
                'native_currency_symbol'           => $default->symbol,
                'native_currency_decimal_places'   => $default->decimal_places,
                'start'                   => $start->toAtomString(),
                'end'                     => $end->toAtomString(),
                'period'                  => '1D',
                'entries'                 => [],
                'native_entries'          => [],
            ];
            $currentStart   = clone $start;
            $range          = app('steam')->balanceInRange($account, $start, clone $end, $currency);
            $rangeConverted = app('steam')->balanceInRangeConverted($account, $start, clone $end, $default);

            $previous          = array_values($range)[0];
            $previousConverted = array_values($rangeConverted)[0];
            while ($currentStart <= $end) {
                $format            = $currentStart->format('Y-m-d');
                $label             = $currentStart->toAtomString();
                $balance           = array_key_exists($format, $range) ? $range[$format] : $previous;
                $balanceConverted  = array_key_exists($format, $rangeConverted) ? $rangeConverted[$format] : $previousConverted;
                $previous          = $balance;
                $previousConverted = $balanceConverted;

                $currentStart->addDay();
                $currentSet['entries'][$label]        = $balance;
                $currentSet['native_entries'][$label] = $balanceConverted;
            }
            $chartData[] = $currentSet;
        }

        return response()->json($this->clean($chartData));
    }
}