Preference can be turned on and off (is always off now)

This commit is contained in:
James Cole 2022-06-07 19:24:08 +02:00
parent 46e97f95f9
commit c3bd46d7c0
No known key found for this signature in database
GPG Key ID: B49A324B7EAD6D80
8 changed files with 473 additions and 4 deletions

View File

@ -0,0 +1,121 @@
<?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/>.
*/
namespace FireflyIII\Api\V2\Controllers\Chart;
use Carbon\Carbon;
use FireflyIII\Api\V2\Controllers\Controller;
use FireflyIII\Api\V2\Request\Generic\DateRequest;
use FireflyIII\Models\Account;
use FireflyIII\Models\AccountType;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Support\Http\Api\ConvertsExchangeRates;
use Illuminate\Http\JsonResponse;
/**
* Class AccountController
*/
class AccountController extends Controller
{
use ConvertsExchangeRates;
private AccountRepositoryInterface $repository;
/**
*
*/
public function __construct()
{
$this->middleware(
function ($request, $next) {
$this->repository = app(AccountRepositoryInterface::class);
return $next($request);
}
);
}
/**
* @param DateRequest $request
* @return JsonResponse
*/
public function dashboard(DateRequest $request): JsonResponse
{
// parameters for chart:
$dates = $request->getAll();
/** @var Carbon $start */
$start = $dates['start'];
/** @var Carbon $end */
$end = $dates['end'];
// user's preferences
$defaultSet = $this->repository->getAccountsByType([AccountType::ASSET, AccountType::DEFAULT])->pluck('id')->toArray();
$frontPage = app('preferences')->get('frontPageAccounts', $defaultSet);
$default = app('amount')->getDefaultCurrency();
$accounts = $this->repository->getAccountsById($frontPage->data);
$chartData = [];
if (empty($frontPage->data)) {
$frontPage->data = $defaultSet;
$frontPage->save();
}
/** @var Account $account */
foreach ($accounts as $account) {
$currency = $this->repository->getAccountCurrency($account);
if (null === $currency) {
$currency = $default;
}
$currentSet = [
'label' => $account->name,
'currency_id' => (string) $currency->id,
'currency_code' => $currency->code,
'currency_symbol' => $currency->symbol,
'currency_decimal_places' => $currency->decimal_places,
'native_id' => null,
'native_code' => null,
'native_symbol' => null,
'native_decimal_places' => null,
'start_date' => $start->toAtomString(),
'end_date' => $end->toAtomString(),
'type' => 'line', // line, area or bar
'yAxisID' => 0, // 0, 1, 2
'entries' => [],
];
$currentStart = clone $start;
$range = app('steam')->balanceInRange($account, $start, clone $end);
$previous = round((float) array_values($range)[0], 12);
while ($currentStart <= $end) {
$format = $currentStart->format('Y-m-d');
$label = $currentStart->toAtomString();
$balance = array_key_exists($format, $range) ? round((float) $range[$format], 12) : $previous;
$previous = $balance;
$currentStart->addDay();
$currentSet['entries'][$label] = $balance;
}
$currentSet = $this->cerChartSet($currentSet);
$chartData[] = $currentSet;
}
return response()->json($chartData);
return response()->json(['x']);
}
}

View File

@ -0,0 +1,62 @@
<?php
/*
* DateRequest.php
* Copyright (c) 2021 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\Request\Generic;
use Carbon\Carbon;
use FireflyIII\Support\Request\ChecksLogin;
use FireflyIII\Support\Request\ConvertsDataTypes;
use Illuminate\Foundation\Http\FormRequest;
/**
* Request class for end points that require a date parameter.
*
* Class SingleDateRequest
*/
class SingleDateRequest extends FormRequest
{
use ConvertsDataTypes, ChecksLogin;
/**
* Get all data from the request.
*
* @return Carbon
*/
public function getDate(): Carbon
{
return $this->getCarbonDate('date');
}
/**
* The rules that the incoming request must be matched against.
*
* @return array
*/
public function rules(): array
{
return [
'date' => 'required|date',
];
}
}

View File

@ -22,6 +22,7 @@
namespace FireflyIII\Support\Http\Api;
use Carbon\Carbon;
use DateTimeInterface;
use FireflyIII\Models\CurrencyExchangeRate;
use FireflyIII\Models\TransactionCurrency;
use Log;
@ -31,6 +32,8 @@ use Log;
*/
trait ConvertsExchangeRates
{
private ?bool $enabled = null;
/**
* For a sum of entries, get the exchange rate to the native currency of
* the user.
@ -39,12 +42,29 @@ trait ConvertsExchangeRates
*/
public function cerSum(array $entries): array
{
if (null === $this->enabled) {
$this->getPreference();
}
// if false, return the same array without conversion info
if (false === $this->enabled) {
$return = [];
/** @var array $entry */
foreach ($entries as $entry) {
$entry['converted'] = false;
$return[] = $entry;
}
return $return;
}
/** @var TransactionCurrency $native */
$native = app('amount')->getDefaultCurrency();
$return = [];
/** @var array $entry */
foreach ($entries as $entry) {
$currency = $this->getCurrency((int) $entry['id']);
$currency = $this->getCurrency((int) $entry['id']);
$entry['converted'] = true;
if ($currency->id !== $native->id) {
$amount = $this->convertAmount($entry['sum'], $currency, $native);
$entry['native_sum'] = $amount;
@ -68,6 +88,42 @@ trait ConvertsExchangeRates
return $return;
}
/**
* @param array $set
* @return array
*/
public function cerChartSet(array $set): array
{
if (null === $this->enabled) {
$this->getPreference();
}
// if not enabled, return the same array but without conversion:
if (false === $this->enabled) {
$set['converted'] = false;
return $set;
}
$set['converted'] = true;
/** @var TransactionCurrency $native */
$native = app('amount')->getDefaultCurrency();
$currency = $this->getCurrency((int) $set['currency_id']);
if ($native->id === $currency->id) {
$set['native_id'] = (string) $currency->id;
$set['native_code'] = $currency->code;
$set['native_symbol'] = $currency->symbol;
$set['native_decimal_places'] = $currency->decimal_places;
return $set;
}
foreach ($set['entries'] as $date => $entry) {
$carbon = Carbon::createFromFormat(DateTimeInterface::ATOM, $date);
$rate = $this->getRate($currency, $native, $carbon);
$rate = '0' === $rate ? '1' : $rate;
$set['entries'][$date] = (float) bcmul((string) $entry, $rate);
}
return $set;
}
/**
* @param int $currencyId
* @return TransactionCurrency
@ -199,4 +255,12 @@ trait ConvertsExchangeRates
return '0';
}
/**
* @return void
*/
private function getPreference(): void
{
$this->enabled = false;
}
}

View File

@ -0,0 +1,30 @@
/*
* overview.js
* 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/>.
*/
import {api} from "boot/axios";
import {format} from "date-fns";
export default class Dashboard {
overview(range, cacheKey) {
let startStr = format(range.start, 'y-MM-dd');
let endStr = format(range.end, 'y-MM-dd');
return api.get('/api/v2/chart/account/dashboard', {params: {start: startStr, end: endStr, cache: cacheKey}});
}
}

View File

@ -0,0 +1,175 @@
<!--
- AccountChart.vue
- 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/>.
-->
<template>
<!-- -->
<div class="q-mt-sm q-mr-sm">
<q-card bordered>
<q-item>
<q-item-section>
<q-item-label><strong>Bla bla accounts</strong></q-item-label>
</q-item-section>
</q-item>
<q-separator/>
<ApexChart ref="chart" height="350" type="line" :options="options" :series="series"></ApexChart>
</q-card>
</div>
<div>
</div>
</template>
<script>
import {defineAsyncComponent} from "vue";
import Dashboard from '../../api/v2/chart/account/dashboard';
import format from "date-fns/format";
import {useQuasar} from "quasar";
import {useFireflyIIIStore} from "../../stores/fireflyiii";
export default {
name: "AccountChart",
data() {
return {
loading: false,
currencies: [],
options: {
theme: {
mode: 'dark'
},
dataLabels: {
enabled: false
},
noData: {
text: 'Loading...'
},
chart: {
id: 'account-chart',
toolbar: {
show: true,
tools: {
download: false,
selection: false,
pan: false
}
}
},
yaxis: {
labels: {
formatter: this.numberFormatter
}
},
labels: [],
xaxis: {
categories: [],
},
},
series: [],
locale: 'en-US',
dateFormat: 'MMMM d, y',
store: null,
}
},
created() {
this.dateFormat = this.$t('config.month_and_day_fns');
},
mounted() {
this.store = useFireflyIIIStore();
const $q = useQuasar();
this.options.theme.mode = $q.dark.isActive ? 'dark' : 'light';
this.store.$onAction(
({name, store, args, after, onError,}) => {
after((result) => {
if (name === 'setRange') {
this.locale = this.store.getLocale;
this.buildChart();
}
})
}
)
if (null !== this.store.getRange.start && null !== this.store.getRange.end) {
this.buildChart();
}
},
methods: {
numberFormatter: function (value, index) {
let currencyCode = this.currencies[index] ?? 'EUR';
return Intl.NumberFormat(this.locale, {style: 'currency', currency: currencyCode}).format(value);
},
buildChart: function () {
console.log('buildChart');
if (null !== this.store.getRange.start && null !== this.store.getRange.end && false === this.loading) {
console.log('buildChart go!');
let start = this.store.getRange.start;
let end = this.store.getRange.end;
if (false === this.loading) {
this.loading = true;
// generate labels:
this.generateStaticLabels({start: start, end: end});
(new Dashboard).overview({start: start, end: end}, this.getCacheKey).then(data => {
this.generateSeries(data.data)
});
}
}
},
generateSeries: function (data) {
this.series = [];
let series;
for (let i in data) {
if (data.hasOwnProperty(i)) {
series = {};
series.name = data[i].label;
series.data = [];
this.currencies.push(data[i].currency_code);
for (let ii in data[i].entries) {
series.data.push(data[i].entries[ii]);
}
this.series.push(series);
}
}
this.loading = false;
},
generateStaticLabels: function (range) {
let loop = new Date(range.start);
let newDate;
let labels = [];
while (loop <= range.end) {
labels.push(format(loop, this.dateFormat));
newDate = loop.setDate(loop.getDate() + 1);
loop = new Date(newDate);
}
this.options = {
...this.options,
...{
labels: labels
},
};
}
},
components: {
ApexChart: defineAsyncComponent(() => import('vue3-apexcharts')),
}
}
</script>
<style scoped>
</style>

View File

@ -96,10 +96,16 @@ export default {
for (let i in data) {
if (data.hasOwnProperty(i)) {
const current = data[i];
if(parseFloat(current.sum) <= 0) {
continue;
}
const hasNative = current.native_id !== current.id && current.native_sum !== '0';
if (hasNative || current.native_id === current.id) {
this.primary = this.primary + parseFloat(current.native_sum);
}
this.netWorth.push(
{
sum: current.sum,

View File

@ -35,7 +35,7 @@
</div>
<div class="row q-mb-sm">
<div class="col">
Account chart box
<AccountChart />
</div>
</div>
<div class="row q-mb-sm">
@ -89,12 +89,12 @@
<script>
import {defineAsyncComponent} from "vue";
import NetWorthInsightBox from "../../components/dashboard/NetWorthInsightBox";
export default {
name: "Dashboard",
components: {
NetWorthInsightBox,
AccountChart: defineAsyncComponent(() => import('../../components/dashboard/AccountChart.vue')),
NetWorthInsightBox: defineAsyncComponent(() => import('../../components/dashboard/BillInsightBox.vue')),
BillInsightBox: defineAsyncComponent(() => import('../../components/dashboard/BillInsightBox.vue')),
SpendInsightBox: defineAsyncComponent(() => import('../../components/dashboard/SpendInsightBox.vue')),
}

View File

@ -44,6 +44,17 @@ Route::group(
}
);
/**
* V2 API routes for charts
*/
Route::group(
['namespace' => 'FireflyIII\Api\V2\Controllers\Chart', 'prefix' => 'v2/chart',
'as' => 'api.v1.chart.',],
static function () {
Route::get('account/dashboard', ['uses' => 'AccountController@dashboard', 'as' => 'dashboard']);
}
);
/**
* V2 API route for bills.
*/