Expand chart api

app/Api/V2/Controllers/Chart/AccountController.php

@@ -24,14 +24,14 @@ 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\Api\V2\Request\Chart\ChartRequest;
 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\Chart\ChartData;
 use FireflyIII\Support\Http\Api\CleansChartData;
 use FireflyIII\Support\Http\Api\ValidatesUserGroupTrait;
 use Illuminate\Http\JsonResponse;
@@ -46,6 +46,8 @@ class AccountController extends Controller
     use ValidatesUserGroupTrait;
 
     private AccountRepositoryInterface $repository;
+    private ChartData $chartData;
+    private TransactionCurrency $default;
 
     public function __construct()
     {
@@ -54,6 +56,8 @@ class AccountController extends Controller
             function ($request, $next) {
                 $this->repository = app(AccountRepositoryInterface::class);
                 $this->repository->setUserGroup($this->validateUserGroup($request));
+                $this->chartData = new ChartData();
+                $this->default = app('amount')->getDefaultCurrency();
 
                 return $next($request);
             }
@@ -61,37 +65,49 @@ class AccountController extends Controller
     }
 
     /**
-     * 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
-     *
+     * TODO fix documentation
      * @throws FireflyException
      */
-    public function dashboard(DashboardChartRequest $request): JsonResponse
+    public function dashboard(ChartRequest $request): JsonResponse
     {
-        /** @var Carbon $start */
-        $start     = $this->parameters->get('start');
+        $queryParameters = $request->getParameters();
+        $accounts        = $this->getAccountList($queryParameters);
 
-        /** @var Carbon $end */
-        $end       = $this->parameters->get('end');
-        $end->endOfDay();
+        // move date to end of day
+        $queryParameters['start']->startOfDay();
+        $queryParameters['end']->endOfDay();
 
-        /** @var TransactionCurrency $default */
-        $default   = app('amount')->getDefaultCurrency();
-        $params    = $request->getAll();
+        // loop each account, and collect info:
+        /** @var Account $account */
+        foreach ($accounts as $account) {
+            $this->renderAccountData($queryParameters, $account);
+        }
 
-        /** @var Collection $accounts */
-        $accounts  = $params['accounts'];
-        $chartData = [];
+        return response()->json($this->chartData->render());
+    }
 
-        // user's preferences
-        if (0 === $accounts->count()) {
+    /**
+     * TODO Duplicate function but I think it belongs here or in a separate trait
+     *
+     */
+    private function getAccountList(array $queryParameters): Collection
+    {
+        $collection = new Collection();
+
+        // always collect from the query parameter, even when it's empty.
+        foreach ($queryParameters['accounts'] as $accountId) {
+            $account = $this->repository->find((int) $accountId);
+            if (null !== $account) {
+                $collection->push($account);
+            }
+        }
+
+        // if no "preselected", and found accounts
+        if ('empty' === $queryParameters['preselected'] && $collection->count() > 0) {
+            return $collection;
+        }
+        // if no preselected, but no accounts:
+        if ('empty' === $queryParameters['preselected'] && 0 === $collection->count()) {
             $defaultSet = $this->repository->getAccountsByType([AccountType::ASSET, AccountType::DEFAULT])->pluck('id')->toArray();
             $frontpage  = app('preferences')->get('frontpageAccounts', $defaultSet);
 
@@ -100,66 +116,69 @@ class AccountController extends Controller
                 $frontpage->save();
             }
 
-            $accounts   = $this->repository->getAccountsById($frontpage->data);
+            return $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 ('all' === $queryParameters['preselected']) {
+            return $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 ('assets' === $queryParameters['preselected']) {
+            return $this->repository->getAccountsByType([AccountType::ASSET, AccountType::DEFAULT]);
         }
-        if ('liabilities' === $params['preselected']) {
-            $accounts = $this->repository->getAccountsByType([AccountType::LOAN, AccountType::DEBT, AccountType::MORTGAGE]);
+        if ('liabilities' === $queryParameters['preselected']) {
+            return $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,
+        return $collection;
+    }
 
-                // 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;
+    /**
+     * @throws FireflyException
+     */
+    private function renderAccountData(array $params, Account $account): void {
+        $currency = $this->repository->getAccountCurrency($account);
+        if (null === $currency) {
+            $currency = $this->default;
         }
+        $currentSet     = [
+            'label'                          => $account->name,
 
-        return response()->json($this->clean($chartData));
+            // 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) $this->default->id,
+            'native_currency_code'           => $this->default->code,
+            'native_currency_symbol'         => $this->default->symbol,
+            'native_currency_decimal_places' => $this->default->decimal_places,
+            'start'                          => $params['start']->toAtomString(),
+            'end'                            => $params['end']->toAtomString(),
+            'period'                         => '1D',
+            'entries'                        => [],
+            'native_entries'                 => [],
+        ];
+        $currentStart   = clone $params['start'];
+        $range          = app('steam')->balanceInRange($account, $params['start'], clone $params['end'], $currency);
+        $rangeConverted = app('steam')->balanceInRangeConverted($account, $params['start'], clone $params['end'], $this->default);
+
+        $previous          = array_values($range)[0];
+        $previousConverted = array_values($rangeConverted)[0];
+        while ($currentStart <= $params['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;
+        }
+        $this->chartData->add($currentSet);
     }
 }

app/Api/V2/Request/Chart/ChartRequest.php

@@ -25,6 +25,7 @@ namespace FireflyIII\Api\V2\Request\Chart;
 
 use FireflyIII\Enums\UserRoleEnum;
 use FireflyIII\JsonApi\Rules\IsValidFilter;
+use FireflyIII\Rules\IsFilterValueIn;
 use FireflyIII\Support\Http\Api\ParsesQueryFilters;
 use FireflyIII\Support\Http\Api\ValidatesUserGroupTrait;
 use FireflyIII\Support\Request\ChecksLogin;
@@ -50,17 +51,19 @@ class ChartRequest extends FormRequest
     public function getParameters(): array
     {
         $queryParameters = QueryParameters::cast($this->all());
-
         return [
-            'start'          => $this->dateOrToday($queryParameters, 'start'),
-            'end'            => $this->dateOrToday($queryParameters, 'end'),
-
-            // preselected heeft maar een paar toegestane waardes.
-
+            'start'       => $this->dateOrToday($queryParameters, 'start'),
+            'end'         => $this->dateOrToday($queryParameters, 'end'),
+            'preselected' => $this->stringFromQueryParams($queryParameters, 'preselected', 'empty'),
+            'accounts'    => $this->arrayOfStrings($queryParameters, 'accounts'),
+            // preselected heeft maar een paar toegestane waardes, dat moet ook goed gaan.
             //            'query'         => $this->arrayOfStrings($queryParameters, 'query'),
             //            'size'          => $this->integerFromQueryParams($queryParameters,'size', 50),
             //            'account_types' => $this->getAccountTypeParameter($this->arrayOfStrings($queryParameters, 'account_types')),
         ];
+        // collect accounts based on this list?
+
+
     }
 
     //        return [
@@ -76,7 +79,12 @@ class ChartRequest extends FormRequest
     {
         return [
             'fields'  => JsonApiRule::notSupported(),
-            'filter'  => ['nullable', 'array', new IsValidFilter(['start', 'end', 'preselected', 'accounts'])],
+            'filter'  => ['nullable', 'array',
+                          new IsValidFilter(['start', 'end', 'preselected', 'accounts']),
+                          new IsFilterValueIn('preselected', config('firefly.preselected_accounts')),
+
+
+            ],
             'include' => JsonApiRule::notSupported(),
             'page'    => JsonApiRule::notSupported(),
             'sort'    => JsonApiRule::notSupported(),

app/Rules/IsFilterValueIn.php

@@ -0,0 +1,58 @@
+<?php
+/*
+ * IsFilterValueIn.php
+ * Copyright (c) 2024 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\Rules;
+
+use Illuminate\Contracts\Validation\ValidationRule;
+
+class IsFilterValueIn implements ValidationRule
+{
+    private string $key;
+    private array $values;
+    public function __construct(string $key, array $values) {
+        $this->key = $key;
+        $this->values = $values;
+    }
+    /**
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function validate(string $attribute, mixed $value, \Closure $fail): void
+    {
+        if(!is_array($value)) {
+            return;
+        }
+        if(!array_key_exists($this->key, $value)) {
+            return;
+        }
+        $value = $value[$this->key] ?? null;
+
+        if(!is_string($value) && !is_null($value)) {
+            $fail('validation.filter_not_string')->translate(['filter' => $this->key]);
+        }
+        if(!in_array($value, $this->values)) {
+            $fail('validation.filter_must_be_in')->translate(['filter' => $this->key,'values' => join(', ',$this->values)]);
+        }
+        //$fail('validation.filter_not_string')->translate(['filter' => $this->key]);
+    }
+
+}

app/Support/Chart/ChartData.php

@@ -0,0 +1,73 @@
+<?php
+/*
+ * ChartData.php
+ * Copyright (c) 2024 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;
+
+use FireflyIII\Exceptions\FireflyException;
+
+class ChartData
+{
+    private array $series;
+
+    public function __construct()
+    {
+        $this->series = [];
+    }
+
+    public function render(): array
+    {
+        if (0 === count($this->series)) {
+            throw new FireflyException('No series added to chart');
+        }
+
+        return $this->series;
+    }
+
+    /**
+     * @param array $data
+     *
+     * @return void
+     * @throws FireflyException
+     */
+    public function add(array $data): void
+    {
+        if (array_key_exists('currency_id', $data)) {
+            $data['currency_id'] = (string) $data['currency_id'];
+        }
+        if (array_key_exists('native_currency_id', $data)) {
+            $data['native_currency_id'] = (string) $data['native_currency_id'];
+        }
+        if (!array_key_exists('start', $data)) {
+            throw new FireflyException('Data-set is missing the "start"-variable.');
+        }
+        if (!array_key_exists('end', $data)) {
+            throw new FireflyException('Data-set is missing the "end"-variable.');
+        }
+        if (!array_key_exists('period', $data)) {
+            throw new FireflyException('Data-set is missing the "period"-variable.');
+        }
+
+        $this->series[] = $data;
+    }
+
+}

app/Support/Http/Api/ParsesQueryFilters.php

@@ -54,4 +54,8 @@ trait ParsesQueryFilters
     {
         return (int) ($parameters->page()[$field] ?? $default);
     }
+    private function stringFromQueryParams(QueryParameters $parameters, string $field, string $default): string
+    {
+        return (string) ($parameters->page()[$field] ?? $default);
+    }
 }