mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-09-20 11:19:16 +00:00
513 lines
20 KiB
PHP
513 lines
20 KiB
PHP
<?php
|
|
/**
|
|
* CategoryController.php
|
|
* Copyright (c) 2017 thegrumpydictator@gmail.com
|
|
*
|
|
* This file is part of Firefly III.
|
|
*
|
|
* Firefly III is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Firefly III 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Http\Controllers\Chart;
|
|
|
|
use Carbon\Carbon;
|
|
use Exception;
|
|
use FireflyIII\Generator\Chart\Basic\GeneratorInterface;
|
|
use FireflyIII\Http\Controllers\Controller;
|
|
use FireflyIII\Models\AccountType;
|
|
use FireflyIII\Models\Category;
|
|
use FireflyIII\Models\TransactionCurrency;
|
|
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
|
|
use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
|
|
use FireflyIII\Repositories\Category\NoCategoryRepositoryInterface;
|
|
use FireflyIII\Repositories\Category\OperationsRepositoryInterface;
|
|
use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
|
|
use FireflyIII\Support\CacheProperties;
|
|
use FireflyIII\Support\Chart\Category\WholePeriodChartGenerator;
|
|
use FireflyIII\Support\Http\Controllers\AugumentData;
|
|
use FireflyIII\Support\Http\Controllers\ChartGeneration;
|
|
use FireflyIII\Support\Http\Controllers\DateCalculation;
|
|
use Illuminate\Http\JsonResponse;
|
|
use Illuminate\Support\Collection;
|
|
use Log;
|
|
|
|
/**
|
|
* Class CategoryController.
|
|
*/
|
|
class CategoryController extends Controller
|
|
{
|
|
use DateCalculation, AugumentData, ChartGeneration;
|
|
/** @var GeneratorInterface Chart generation methods. */
|
|
protected $generator;
|
|
|
|
/**
|
|
* CategoryController constructor.
|
|
*
|
|
* @codeCoverageIgnore
|
|
*/
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
// create chart generator:
|
|
$this->generator = app(GeneratorInterface::class);
|
|
}
|
|
|
|
|
|
/**
|
|
* Show an overview for a category for all time, per month/week/year.
|
|
*
|
|
* TODO this chart is not multi-currency aware.
|
|
*
|
|
* @param CategoryRepositoryInterface $repository
|
|
* @param Category $category
|
|
*
|
|
* @return JsonResponse
|
|
*/
|
|
public function all(CategoryRepositoryInterface $repository, Category $category): JsonResponse
|
|
{
|
|
// cache results:
|
|
$cache = new CacheProperties;
|
|
$cache->addProperty('chart.category.all');
|
|
$cache->addProperty($category->id);
|
|
if ($cache->has()) {
|
|
return response()->json($cache->get()); // @codeCoverageIgnore
|
|
}
|
|
$start = $repository->firstUseDate($category) ?? $this->getDate();
|
|
$range = app('preferences')->get('viewRange', '1M')->data;
|
|
$start = app('navigation')->startOfPeriod($start, $range);
|
|
$end = $this->getDate();
|
|
|
|
Log::debug(sprintf('Full range is %s to %s', $start->format('Y-m-d'), $end->format('Y-m-d')));
|
|
|
|
/** @var WholePeriodChartGenerator $generator */
|
|
$generator = app(WholePeriodChartGenerator::class);
|
|
$chartData = $generator->generate($category, $start, $end);
|
|
$data = $this->generator->multiSet($chartData);
|
|
$cache->store($data);
|
|
|
|
return response()->json($data);
|
|
}
|
|
|
|
|
|
/**
|
|
* Shows the category chart on the front page.
|
|
*
|
|
* @return JsonResponse
|
|
*/
|
|
public function frontPage(): JsonResponse
|
|
{
|
|
$start = session('start', Carbon::now()->startOfMonth());
|
|
$end = session('end', Carbon::now()->endOfMonth());
|
|
// chart properties for cache:
|
|
$cache = new CacheProperties;
|
|
$cache->addProperty($start);
|
|
$cache->addProperty($end);
|
|
$cache->addProperty('chart.category.frontpage');
|
|
if ($cache->has()) {
|
|
return response()->json($cache->get()); // @codeCoverageIgnore
|
|
}
|
|
|
|
// currency repos:
|
|
/** @var CurrencyRepositoryInterface $currencyRepository */
|
|
$currencyRepository = app(CurrencyRepositoryInterface::class);
|
|
/** @var CategoryRepositoryInterface $repository */
|
|
$repository = app(CategoryRepositoryInterface::class);
|
|
|
|
/** @var AccountRepositoryInterface $accountRepository */
|
|
$accountRepository = app(AccountRepositoryInterface::class);
|
|
|
|
/** @var OperationsRepositoryInterface $opsRepository */
|
|
$opsRepository = app(OperationsRepositoryInterface::class);
|
|
|
|
/** @var NoCategoryRepositoryInterface $noCatRepository */
|
|
$noCatRepository = app(NoCategoryRepositoryInterface::class);
|
|
|
|
$currencies = [];
|
|
|
|
|
|
$chartData = [];
|
|
$tempData = [];
|
|
$categories = $repository->getCategories();
|
|
$accounts = $accountRepository->getAccountsByType([AccountType::ASSET, AccountType::DEFAULT]);
|
|
|
|
/** @var Category $category */
|
|
foreach ($categories as $category) {
|
|
$spentArray = $opsRepository->spentInPeriodPerCurrency(new Collection([$category]), $accounts, $start, $end);
|
|
foreach ($spentArray as $categoryId => $spentInfo) {
|
|
foreach ($spentInfo['spent'] as $currencyId => $row) {
|
|
$spent = $row['spent'];
|
|
if (bccomp($spent, '0') === -1) {
|
|
$currencies[$currencyId] = $currencies[$currencyId] ?? $currencyRepository->findNull((int)$currencyId);
|
|
$tempData[] = [
|
|
'name' => $category->name,
|
|
'spent' => bcmul($spent, '-1'),
|
|
'spent_float' => (float)bcmul($spent, '-1'),
|
|
'currency_id' => $currencyId,
|
|
];
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// no category per currency:
|
|
$noCategory = $noCatRepository->spentInPeriodPcWoCategory(new Collection, $start, $end);
|
|
foreach ($noCategory as $currencyId => $spent) {
|
|
$currencies[$currencyId] = $currencies[$currencyId] ?? $currencyRepository->findNull($currencyId);
|
|
$tempData[] = [
|
|
'name' => trans('firefly.no_category'),
|
|
'spent' => bcmul($spent['spent'], '-1'),
|
|
'spent_float' => (float)bcmul($spent['spent'], '-1'),
|
|
'currency_id' => $currencyId,
|
|
];
|
|
}
|
|
|
|
// sort temp array by amount.
|
|
$amounts = array_column($tempData, 'spent_float');
|
|
array_multisort($amounts, SORT_DESC, $tempData);
|
|
|
|
// loop all found currencies and build the data array for the chart.
|
|
/**
|
|
* @var int $currencyId
|
|
* @var TransactionCurrency $currency
|
|
*/
|
|
foreach ($currencies as $currencyId => $currency) {
|
|
$dataSet = [
|
|
'label' => (string)trans('firefly.spent'),
|
|
'type' => 'bar',
|
|
'currency_symbol' => $currency->symbol,
|
|
'entries' => $this->expandNames($tempData),
|
|
];
|
|
$chartData[$currencyId] = $dataSet;
|
|
}
|
|
// loop temp data and place data in correct array:
|
|
foreach ($tempData as $entry) {
|
|
$currencyId = $entry['currency_id'];
|
|
$name = $entry['name'];
|
|
$chartData[$currencyId]['entries'][$name] = $entry['spent'];
|
|
}
|
|
$data = $this->generator->multiSet($chartData);
|
|
$cache->store($data);
|
|
|
|
return response()->json($data);
|
|
}
|
|
|
|
/**
|
|
* Chart report.
|
|
*
|
|
* TODO this chart is not multi-currency aware.
|
|
*
|
|
* @param Category $category
|
|
* @param Collection $accounts
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
*
|
|
* @return JsonResponse
|
|
*/
|
|
public function reportPeriod(Category $category, Collection $accounts, Carbon $start, Carbon $end): JsonResponse
|
|
{
|
|
$cache = new CacheProperties;
|
|
$cache->addProperty($start);
|
|
$cache->addProperty($end);
|
|
$cache->addProperty('chart.category.period');
|
|
$cache->addProperty($accounts->pluck('id')->toArray());
|
|
$cache->addProperty($category);
|
|
if ($cache->has()) {
|
|
return response()->json($cache->get());// @codeCoverageIgnore
|
|
}
|
|
|
|
/** @var OperationsRepositoryInterface $opsRepository */
|
|
$opsRepository = app(OperationsRepositoryInterface::class);
|
|
|
|
$expenses = $opsRepository->periodExpenses(new Collection([$category]), $accounts, $start, $end);
|
|
$income = $opsRepository->periodIncome(new Collection([$category]), $accounts, $start, $end);
|
|
$periods = app('navigation')->listOfPeriods($start, $end);
|
|
$chartData = [
|
|
[
|
|
'label' => (string)trans('firefly.spent'),
|
|
'entries' => [],
|
|
'type' => 'bar',
|
|
'backgroundColor' => 'rgba(219, 68, 55, 0.5)', // red
|
|
],
|
|
[
|
|
'label' => (string)trans('firefly.earned'),
|
|
'entries' => [],
|
|
'type' => 'bar',
|
|
'backgroundColor' => 'rgba(0, 141, 76, 0.5)', // green
|
|
],
|
|
[
|
|
'label' => (string)trans('firefly.sum'),
|
|
'entries' => [],
|
|
'type' => 'line',
|
|
'fill' => false,
|
|
],
|
|
];
|
|
|
|
foreach (array_keys($periods) as $period) {
|
|
$label = $periods[$period];
|
|
$spent = $expenses[$category->id]['entries'][$period] ?? '0';
|
|
$earned = $income[$category->id]['entries'][$period] ?? '0';
|
|
$sum = bcadd($spent, $earned);
|
|
$chartData[0]['entries'][$label] = round($spent, 12);
|
|
$chartData[1]['entries'][$label] = round($earned, 12);
|
|
$chartData[2]['entries'][$label] = round($sum, 12);
|
|
}
|
|
|
|
$data = $this->generator->multiSet($chartData);
|
|
$cache->store($data);
|
|
|
|
return response()->json($data);
|
|
}
|
|
|
|
|
|
/**
|
|
* Chart for period for transactions without a category.
|
|
*
|
|
* @param Collection $accounts
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
*
|
|
* @return JsonResponse
|
|
*/
|
|
public function reportPeriodNoCategory(Collection $accounts, Carbon $start, Carbon $end): JsonResponse
|
|
{
|
|
$cache = new CacheProperties;
|
|
$cache->addProperty($start);
|
|
$cache->addProperty($end);
|
|
$cache->addProperty('chart.category.period.no-cat');
|
|
$cache->addProperty($accounts->pluck('id')->toArray());
|
|
if ($cache->has()) {
|
|
// return response()->json($cache->get()); // @codeCoverageIgnore
|
|
}
|
|
|
|
/** @var NoCategoryRepositoryInterface $noCatRepository */
|
|
$noCatRepository = app(NoCategoryRepositoryInterface::class);
|
|
|
|
// this gives us all currencies
|
|
$expenses = $noCatRepository->listExpenses($start, $end);
|
|
$income = $noCatRepository->listIncome($start, $end);
|
|
$currencies = array_unique(array_merge(array_keys($income), array_keys($expenses)));
|
|
$periods = app('navigation')->listOfPeriods($start, $end);
|
|
$format = app('navigation')->preferredCarbonLocalizedFormat($start, $end);
|
|
$chartData = [];
|
|
// make empty data array:
|
|
// double foreach (bad) to make empty array:
|
|
foreach ($currencies as $currencyId) {
|
|
$currencyInfo = $expenses[$currencyId] ?? $income[$currencyId];
|
|
$outKey = sprintf('%d-out', $currencyId);
|
|
$inKey = sprintf('%d-in', $currencyId);
|
|
|
|
$chartData[$outKey]
|
|
= [
|
|
'label' => sprintf('%s (%s)', (string)trans('firefly.spent'), $currencyInfo['currency_name']),
|
|
'entries' => [],
|
|
'type' => 'bar',
|
|
'backgroundColor' => 'rgba(219, 68, 55, 0.5)', // red
|
|
];
|
|
|
|
$chartData[$inKey]
|
|
= [
|
|
'label' => sprintf('%s (%s)', (string)trans('firefly.earned'), $currencyInfo['currency_name']),
|
|
'entries' => [],
|
|
'type' => 'bar',
|
|
'backgroundColor' => 'rgba(0, 141, 76, 0.5)', // green
|
|
];
|
|
|
|
// loop empty periods:
|
|
foreach (array_keys($periods) as $period) {
|
|
$label = $periods[$period];
|
|
$chartData[$outKey]['entries'][$label] = '0';
|
|
$chartData[$inKey]['entries'][$label] = '0';
|
|
}
|
|
// loop income and expenses:
|
|
$outSet = $expenses[$currencyId] ?? ['transaction_journals' => []];
|
|
foreach ($outSet['transaction_journals'] as $journal) {
|
|
$date = $journal['date']->formatLocalized($format);
|
|
$chartData[$outKey]['entries'][$date] = bcadd($journal['amount'], $chartData[$outKey]['entries'][$date]);
|
|
}
|
|
|
|
$inSet = $income[$currencyId] ?? ['transaction_journals' => []];
|
|
foreach ($inSet['transaction_journals'] as $journal) {
|
|
$date = $journal['date']->formatLocalized($format);
|
|
$chartData[$inKey]['entries'][$date] = bcadd($journal['amount'], $chartData[$inKey]['entries'][$date]);
|
|
}
|
|
}
|
|
$data = $this->generator->multiSet($chartData);
|
|
$cache->store($data);
|
|
|
|
return response()->json($data);
|
|
var_dump($chartData);
|
|
var_dump(array_values($chartData));
|
|
exit;
|
|
|
|
|
|
$format = app('navigation')->preferredCarbonLocalizedFormat($start, $end);
|
|
$chartData = [];
|
|
|
|
// double foreach (bad) to make empty array:
|
|
foreach ($currencies as $currencyId) {
|
|
$currencyInfo = $expenses[$currencyId] ?? $income[$currencyId];
|
|
|
|
$spentArray
|
|
= [
|
|
'label' => sprintf('%s (%s)', (string)trans('firefly.spent'), $currencyInfo['currency_name']),
|
|
'entries' => [],
|
|
'type' => 'bar',
|
|
'backgroundColor' => 'rgba(219, 68, 55, 0.5)', // red
|
|
];
|
|
$incomeArray
|
|
= [
|
|
'label' => sprintf('%s (%s)', (string)trans('firefly.earned'), $currencyInfo['currency_name']),
|
|
'entries' => [],
|
|
'type' => 'bar',
|
|
'backgroundColor' => 'rgba(0, 141, 76, 0.5)', // green
|
|
];
|
|
|
|
foreach (array_keys($periods) as $period) {
|
|
$label = $periods[$period];
|
|
$spentArray['entries'][$label] = '0';
|
|
$incomeArray['entries'][$label] = '0';
|
|
|
|
// then loop income and then loop expenses, maybe?
|
|
$currencyExpenses = $expenses[$currencyId] ?? ['transaction_journals' => []];
|
|
foreach ($currencyExpenses['transaction_journals'] as $row) {
|
|
|
|
}
|
|
}
|
|
$chartData[] = $spentArray;
|
|
$chartData[] = $incomeArray;
|
|
}
|
|
var_dump($chartData);
|
|
exit;
|
|
|
|
|
|
foreach ($currencies as $currencyId) {
|
|
$currencyInfo = $expenses[$currencyId] ?? $income[$currencyId];
|
|
// loop expenses[$currencyId], if set
|
|
$spentArray
|
|
= [
|
|
'label' => sprintf('%s (%s)', (string)trans('firefly.spent'), $currencyInfo['currency_name']),
|
|
'entries' => [],
|
|
'type' => 'bar',
|
|
'backgroundColor' => 'rgba(219, 68, 55, 0.5)', // red
|
|
];
|
|
|
|
$current = $expenses[$currencyId] ?? ['transaction_journals' => []];
|
|
foreach ($current['transaction_journals'] as $row) {
|
|
$thisPeriod = $row['date']->formatLocalized($format);
|
|
$spentArray['entries'][$thisPeriod] = $spentArray['entries'][$thisPeriod] ?? '0';
|
|
$spentArray['entries'][$thisPeriod] = bcadd($spentArray['entries'][$thisPeriod], $row['amount']);
|
|
}
|
|
$chartData[] = $spentArray;
|
|
|
|
// loop income[$currencyId], if set
|
|
$incomeArray
|
|
= [
|
|
'label' => sprintf('%s (%s)', (string)trans('firefly.earned'), $currencyInfo['currency_name']),
|
|
'entries' => [],
|
|
'type' => 'bar',
|
|
'backgroundColor' => 'rgba(0, 141, 76, 0.5)', // green
|
|
];
|
|
|
|
$current = $income[$currencyId] ?? ['transaction_journals' => []];
|
|
foreach ($current['transaction_journals'] as $row) {
|
|
$thisPeriod = $row['date']->formatLocalized($format);
|
|
$incomeArray['entries'][$thisPeriod] = $incomeArray['entries'][$thisPeriod] ?? '0';
|
|
$incomeArray['entries'][$thisPeriod] = bcadd($incomeArray['entries'][$thisPeriod], $row['amount']);
|
|
}
|
|
$chartData[] = $incomeArray;
|
|
|
|
// $chartData[] = [
|
|
// 'label' => sprintf('%s (%s)', (string)trans('firefly.earned'), $currencyInfo['currency_name']),
|
|
// 'entries' => [],
|
|
// 'type' => 'bar',
|
|
// 'backgroundColor' => 'rgba(0, 141, 76, 0.5)', // green
|
|
// ];
|
|
}
|
|
echo '<pre>';
|
|
print_r($chartData);
|
|
exit;
|
|
|
|
foreach (array_keys($periods) as $period) {
|
|
$label = $periods[$period];
|
|
$spent = $expenses['entries'][$period] ?? '0';
|
|
$earned = $income['entries'][$period] ?? '0';
|
|
$sum = bcadd($spent, $earned);
|
|
$chartData[0]['entries'][$label] = bcmul($spent, '-1');
|
|
$chartData[1]['entries'][$label] = $earned;
|
|
$chartData[2]['entries'][$label] = $sum;
|
|
}
|
|
$data = $this->generator->multiSet($chartData);
|
|
$cache->store($data);
|
|
|
|
return response()->json($data);
|
|
}
|
|
|
|
/**
|
|
* Chart for a specific period.
|
|
*
|
|
* @param Category $category
|
|
* @param $date
|
|
*
|
|
* @return JsonResponse
|
|
*/
|
|
public function specificPeriod(Category $category, Carbon $date): JsonResponse
|
|
{
|
|
$range = app('preferences')->get('viewRange', '1M')->data;
|
|
$start = app('navigation')->startOfPeriod($date, $range);
|
|
$end = session()->get('end');
|
|
if ($end < $start) {
|
|
[$end, $start] = [$start, $end]; // @codeCoverageIgnore
|
|
}
|
|
|
|
$cache = new CacheProperties;
|
|
$cache->addProperty($start);
|
|
$cache->addProperty($end);
|
|
$cache->addProperty($category->id);
|
|
$cache->addProperty('chart.category.period-chart');
|
|
|
|
|
|
if ($cache->has()) {
|
|
return response()->json($cache->get()); // @codeCoverageIgnore
|
|
}
|
|
|
|
/** @var GeneratorInterface $generator */
|
|
$generator = app(GeneratorInterface::class);
|
|
|
|
/** @var WholePeriodChartGenerator $chartGenerator */
|
|
$chartGenerator = app(WholePeriodChartGenerator::class);
|
|
$chartData = $chartGenerator->generate($category, $start, $end);
|
|
$data = $generator->multiSet($chartData);
|
|
|
|
$cache->store($data);
|
|
|
|
return response()->json($data);
|
|
}
|
|
|
|
/**
|
|
* @return Carbon
|
|
*/
|
|
private function getDate(): Carbon
|
|
{
|
|
$carbon = null;
|
|
try {
|
|
$carbon = new Carbon;
|
|
} catch (Exception $e) {
|
|
$e->getMessage();
|
|
}
|
|
|
|
return $carbon;
|
|
}
|
|
}
|