. */ declare(strict_types=1); namespace FireflyIII\Http\Controllers\Report; use Carbon\Carbon; use FireflyIII\Exceptions\FireflyException; use FireflyIII\Http\Controllers\Controller; use FireflyIII\Models\Account; use FireflyIII\Models\Category; use FireflyIII\Repositories\Category\NoCategoryRepositoryInterface; use FireflyIII\Repositories\Category\OperationsRepositoryInterface; use FireflyIII\Support\CacheProperties; use FireflyIII\Support\Http\Controllers\BasicDataSupport; use FireflyIII\Support\Report\Category\CategoryReportGenerator; use Illuminate\Contracts\View\Factory; use Illuminate\Support\Collection; use Illuminate\View\View; /** * Class CategoryController. */ class CategoryController extends Controller { use BasicDataSupport; private NoCategoryRepositoryInterface $noCatRepository; private OperationsRepositoryInterface $opsRepository; /** * ExpenseReportController constructor. */ public function __construct() { parent::__construct(); $this->middleware( function ($request, $next) { $this->opsRepository = app(OperationsRepositoryInterface::class); $this->noCatRepository = app(NoCategoryRepositoryInterface::class); return $next($request); } ); } /** * @return Factory|View */ public function accountPerCategory(Collection $accounts, Collection $categories, Carbon $start, Carbon $end) { $spent = $this->opsRepository->listExpenses($start, $end, $accounts, $categories); $earned = $this->opsRepository->listIncome($start, $end, $accounts, $categories); $report = []; /** @var Account $account */ foreach ($accounts as $account) { $accountId = $account->id; $report[$accountId] ??= [ 'name' => $account->name, 'id' => $account->id, 'iban' => $account->iban, 'currencies' => [], ]; } // loop expenses. foreach ($spent as $currency) { $currencyId = $currency['currency_id']; /** @var array $category */ foreach ($currency['categories'] as $category) { foreach ($category['transaction_journals'] as $journal) { $sourceAccountId = $journal['source_account_id']; $report[$sourceAccountId]['currencies'][$currencyId] ??= [ 'currency_id' => $currency['currency_id'], 'currency_symbol' => $currency['currency_symbol'], 'currency_name' => $currency['currency_name'], 'currency_decimal_places' => $currency['currency_decimal_places'], 'categories' => [], ]; $report[$sourceAccountId]['currencies'][$currencyId]['categories'][$category['id']] ??= [ 'spent' => '0', 'earned' => '0', 'sum' => '0', ]; $report[$sourceAccountId]['currencies'][$currencyId]['categories'][$category['id']]['spent'] = bcadd( $report[$sourceAccountId]['currencies'][$currencyId]['categories'][$category['id']]['spent'], (string) $journal['amount'] ); $report[$sourceAccountId]['currencies'][$currencyId]['categories'][$category['id']]['sum'] = bcadd( $report[$sourceAccountId]['currencies'][$currencyId]['categories'][$category['id']]['sum'], (string) $journal['amount'] ); } } } // loop income. foreach ($earned as $currency) { $currencyId = $currency['currency_id']; /** @var array $category */ foreach ($currency['categories'] as $category) { foreach ($category['transaction_journals'] as $journal) { $destinationId = $journal['destination_account_id']; $report[$destinationId]['currencies'][$currencyId] ??= [ 'currency_id' => $currency['currency_id'], 'currency_symbol' => $currency['currency_symbol'], 'currency_name' => $currency['currency_name'], 'currency_decimal_places' => $currency['currency_decimal_places'], 'categories' => [], ]; $report[$destinationId]['currencies'][$currencyId]['categories'][$category['id']] ??= [ 'spent' => '0', 'earned' => '0', 'sum' => '0', ]; $report[$destinationId]['currencies'][$currencyId]['categories'][$category['id']]['earned'] = bcadd( $report[$destinationId]['currencies'][$currencyId]['categories'][$category['id']]['earned'], (string) $journal['amount'] ); $report[$destinationId]['currencies'][$currencyId]['categories'][$category['id']]['sum'] = bcadd( $report[$destinationId]['currencies'][$currencyId]['categories'][$category['id']]['sum'], (string) $journal['amount'] ); } } } return view('reports.category.partials.account-per-category', compact('report', 'categories')); } /** * @return Factory|View * * @SuppressWarnings("PHPMD.ExcessiveMethodLength") */ public function accounts(Collection $accounts, Collection $categories, Carbon $start, Carbon $end) { $spent = $this->opsRepository->listExpenses($start, $end, $accounts, $categories); $earned = $this->opsRepository->listIncome($start, $end, $accounts, $categories); $report = []; $sums = []; /** @var Account $account */ foreach ($accounts as $account) { $accountId = $account->id; $report[$accountId] ??= [ 'name' => $account->name, 'id' => $account->id, 'iban' => $account->iban, 'currencies' => [], ]; } // loop expenses. foreach ($spent as $currency) { $currencyId = $currency['currency_id']; $sums[$currencyId] ??= [ 'currency_id' => $currency['currency_id'], 'currency_symbol' => $currency['currency_symbol'], 'currency_name' => $currency['currency_name'], 'currency_decimal_places' => $currency['currency_decimal_places'], 'spent_sum' => '0', 'earned_sum' => '0', 'total_sum' => '0', ]; foreach ($currency['categories'] as $category) { foreach ($category['transaction_journals'] as $journal) { $sourceAccountId = $journal['source_account_id']; $report[$sourceAccountId]['currencies'][$currencyId] ??= [ 'currency_id' => $currency['currency_id'], 'currency_symbol' => $currency['currency_symbol'], 'currency_name' => $currency['currency_name'], 'currency_decimal_places' => $currency['currency_decimal_places'], 'spent' => '0', 'earned' => '0', 'sum' => '0', ]; $report[$sourceAccountId]['currencies'][$currencyId]['spent'] = bcadd( $report[$sourceAccountId]['currencies'][$currencyId]['spent'], (string) $journal['amount'] ); $report[$sourceAccountId]['currencies'][$currencyId]['sum'] = bcadd( $report[$sourceAccountId]['currencies'][$currencyId]['sum'], (string) $journal['amount'] ); $sums[$currencyId]['spent_sum'] = bcadd($sums[$currencyId]['spent_sum'], (string) $journal['amount']); $sums[$currencyId]['total_sum'] = bcadd($sums[$currencyId]['total_sum'], (string) $journal['amount']); } } } // loop income. foreach ($earned as $currency) { $currencyId = $currency['currency_id']; $sums[$currencyId] ??= [ 'currency_id' => $currency['currency_id'], 'currency_symbol' => $currency['currency_symbol'], 'currency_name' => $currency['currency_name'], 'currency_decimal_places' => $currency['currency_decimal_places'], 'spent_sum' => '0', 'earned_sum' => '0', 'total_sum' => '0', ]; foreach ($currency['categories'] as $category) { foreach ($category['transaction_journals'] as $journal) { $destinationAccountId = $journal['destination_account_id']; $report[$destinationAccountId]['currencies'][$currencyId] ??= [ 'currency_id' => $currency['currency_id'], 'currency_symbol' => $currency['currency_symbol'], 'currency_name' => $currency['currency_name'], 'currency_decimal_places' => $currency['currency_decimal_places'], 'spent' => '0', 'earned' => '0', 'sum' => '0', ]; $report[$destinationAccountId]['currencies'][$currencyId]['earned'] = bcadd( $report[$destinationAccountId]['currencies'][$currencyId]['earned'], (string) $journal['amount'] ); $report[$destinationAccountId]['currencies'][$currencyId]['sum'] = bcadd( $report[$destinationAccountId]['currencies'][$currencyId]['sum'], (string) $journal['amount'] ); $sums[$currencyId]['earned_sum'] = bcadd($sums[$currencyId]['earned_sum'], (string) $journal['amount']); $sums[$currencyId]['total_sum'] = bcadd($sums[$currencyId]['total_sum'], (string) $journal['amount']); } } } return view('reports.category.partials.accounts', compact('sums', 'report')); } /** * @return string * * @throws FireflyException */ public function avgExpenses(Collection $accounts, Collection $categories, Carbon $start, Carbon $end) { $spent = $this->opsRepository->listExpenses($start, $end, $accounts, $categories); $result = []; foreach ($spent as $currency) { foreach ($currency['categories'] as $category) { foreach ($category['transaction_journals'] as $journal) { $destinationId = $journal['destination_account_id']; $key = sprintf('%d-%d', $destinationId, $currency['currency_id']); $result[$key] ??= [ 'transactions' => 0, 'sum' => '0', 'avg' => '0', 'avg_float' => 0, 'destination_account_name' => $journal['destination_account_name'], 'destination_account_id' => $journal['destination_account_id'], 'currency_id' => $currency['currency_id'], 'currency_name' => $currency['currency_name'], 'currency_symbol' => $currency['currency_symbol'], 'currency_decimal_places' => $currency['currency_decimal_places'], ]; ++$result[$key]['transactions']; $result[$key]['sum'] = bcadd((string) $journal['amount'], $result[$key]['sum']); $result[$key]['avg'] = bcdiv($result[$key]['sum'], (string) $result[$key]['transactions']); $result[$key]['avg_float'] = (float) $result[$key]['avg']; // intentional float } } } // sort by amount_float // sort temp array by amount. $amounts = array_column($result, 'avg_float'); array_multisort($amounts, SORT_ASC, $result); try { $result = view('reports.category.partials.avg-expenses', compact('result'))->render(); } catch (\Throwable $e) { app('log')->error(sprintf('Could not render reports.partials.budget-period: %s', $e->getMessage())); $result = sprintf('Could not render view: %s', $e->getMessage()); throw new FireflyException($result, 0, $e); } return $result; } /** * @return string * * @throws FireflyException */ public function avgIncome(Collection $accounts, Collection $categories, Carbon $start, Carbon $end) { $spent = $this->opsRepository->listIncome($start, $end, $accounts, $categories); $result = []; foreach ($spent as $currency) { foreach ($currency['categories'] as $category) { foreach ($category['transaction_journals'] as $journal) { $sourceId = $journal['source_account_id']; $key = sprintf('%d-%d', $sourceId, $currency['currency_id']); $result[$key] ??= [ 'transactions' => 0, 'sum' => '0', 'avg' => '0', 'avg_float' => 0, 'source_account_name' => $journal['source_account_name'], 'source_account_id' => $journal['source_account_id'], 'currency_id' => $currency['currency_id'], 'currency_name' => $currency['currency_name'], 'currency_symbol' => $currency['currency_symbol'], 'currency_decimal_places' => $currency['currency_decimal_places'], ]; ++$result[$key]['transactions']; $result[$key]['sum'] = bcadd((string) $journal['amount'], $result[$key]['sum']); $result[$key]['avg'] = bcdiv($result[$key]['sum'], (string) $result[$key]['transactions']); $result[$key]['avg_float'] = (float) $result[$key]['avg']; } } } // sort by amount_float // sort temp array by amount. $amounts = array_column($result, 'avg_float'); array_multisort($amounts, SORT_DESC, $result); try { $result = view('reports.category.partials.avg-income', compact('result'))->render(); } catch (\Throwable $e) { app('log')->error(sprintf('Could not render reports.partials.budget-period: %s', $e->getMessage())); $result = sprintf('Could not render view: %s', $e->getMessage()); throw new FireflyException($result, 0, $e); } return $result; } /** * @return Factory|View * * @SuppressWarnings("PHPMD.ExcessiveMethodLength") */ public function categories(Collection $accounts, Collection $categories, Carbon $start, Carbon $end) { $spent = $this->opsRepository->listExpenses($start, $end, $accounts, $categories); $earned = $this->opsRepository->listIncome($start, $end, $accounts, $categories); $sums = []; $report = []; /** @var Category $category */ foreach ($categories as $category) { $categoryId = $category->id; $report[$categoryId] ??= [ 'name' => $category->name, 'id' => $category->id, 'currencies' => [], ]; } foreach ($spent as $currency) { $currencyId = $currency['currency_id']; $sums[$currencyId] ??= [ 'currency_id' => $currency['currency_id'], 'currency_symbol' => $currency['currency_symbol'], 'currency_name' => $currency['currency_name'], 'currency_decimal_places' => $currency['currency_decimal_places'], 'earned_sum' => '0', 'spent_sum' => '0', 'total_sum' => '0', ]; /** @var array $category */ foreach ($currency['categories'] as $category) { $categoryId = $category['id']; foreach ($category['transaction_journals'] as $journal) { // add currency info to report array: $report[$categoryId]['currencies'][$currencyId] ??= [ 'spent' => '0', 'earned' => '0', 'sum' => '0', 'currency_id' => $currency['currency_id'], 'currency_symbol' => $currency['currency_symbol'], 'currency_name' => $currency['currency_name'], 'currency_decimal_places' => $currency['currency_decimal_places'], ]; $report[$categoryId]['currencies'][$currencyId]['spent'] = bcadd( $report[$categoryId]['currencies'][$currencyId]['spent'], (string) $journal['amount'] ); $report[$categoryId]['currencies'][$currencyId]['sum'] = bcadd( $report[$categoryId]['currencies'][$currencyId]['sum'], (string) $journal['amount'] ); $sums[$currencyId]['spent_sum'] = bcadd($sums[$currencyId]['spent_sum'], (string) $journal['amount']); $sums[$currencyId]['total_sum'] = bcadd($sums[$currencyId]['total_sum'], (string) $journal['amount']); } } } foreach ($earned as $currency) { $currencyId = $currency['currency_id']; $sums[$currencyId] ??= [ 'currency_id' => $currency['currency_id'], 'currency_symbol' => $currency['currency_symbol'], 'currency_name' => $currency['currency_name'], 'currency_decimal_places' => $currency['currency_decimal_places'], 'earned_sum' => '0', 'spent_sum' => '0', 'total_sum' => '0', ]; /** @var array $category */ foreach ($currency['categories'] as $category) { $categoryId = $category['id']; foreach ($category['transaction_journals'] as $journal) { // add currency info to report array: $report[$categoryId]['currencies'][$currencyId] ??= [ 'spent' => '0', 'earned' => '0', 'sum' => '0', 'currency_id' => $currency['currency_id'], 'currency_symbol' => $currency['currency_symbol'], 'currency_name' => $currency['currency_name'], 'currency_decimal_places' => $currency['currency_decimal_places'], ]; $report[$categoryId]['currencies'][$currencyId]['earned'] = bcadd( $report[$categoryId]['currencies'][$currencyId]['earned'], (string) $journal['amount'] ); $report[$categoryId]['currencies'][$currencyId]['sum'] = bcadd( $report[$categoryId]['currencies'][$currencyId]['sum'], (string) $journal['amount'] ); $sums[$currencyId]['earned_sum'] = bcadd($sums[$currencyId]['earned_sum'], (string) $journal['amount']); $sums[$currencyId]['total_sum'] = bcadd($sums[$currencyId]['total_sum'], (string) $journal['amount']); } } } return view('reports.category.partials.categories', compact('sums', 'report')); } /** * Show overview of expenses in category. * * @return mixed|string * * @throws FireflyException */ public function expenses(Collection $accounts, Carbon $start, Carbon $end) { $cache = new CacheProperties(); $cache->addProperty($start); $cache->addProperty($end); $cache->addProperty('category-period-expenses-report'); $cache->addProperty($accounts->pluck('id')->toArray()); if ($cache->has()) { return $cache->get(); } // depending on the carbon format (a reliable way to determine the general date difference) // change the "listOfPeriods" call so the entire period gets included correctly. $format = app('navigation')->preferredCarbonFormat($start, $end); if ('Y' === $format) { $start->startOfYear(); } if ('Y-m' === $format) { $start->startOfMonth(); } $periods = app('navigation')->listOfPeriods($start, $end); $data = []; $with = $this->opsRepository->listExpenses($start, $end, $accounts); $without = $this->noCatRepository->listExpenses($start, $end, $accounts); foreach ([$with, $without] as $set) { foreach ($set as $currencyId => $currencyRow) { foreach ($currencyRow['categories'] as $categoryId => $categoryRow) { $key = sprintf('%d-%d', $currencyId, $categoryId); $data[$key] ??= [ 'id' => $categoryRow['id'], 'title' => sprintf('%s (%s)', $categoryRow['name'], $currencyRow['currency_name']), 'currency_id' => $currencyRow['currency_id'], 'currency_symbol' => $currencyRow['currency_symbol'], 'currency_name' => $currencyRow['currency_name'], 'currency_code' => $currencyRow['currency_code'], 'currency_decimal_places' => $currencyRow['currency_decimal_places'], 'sum' => '0', 'entries' => [], ]; foreach ($categoryRow['transaction_journals'] as $journal) { $date = $journal['date']->format($format); $data[$key]['entries'][$date] ??= '0'; $data[$key]['entries'][$date] = bcadd($data[$key]['entries'][$date], (string) $journal['amount']); $data[$key]['sum'] = bcadd($data[$key]['sum'], (string) $journal['amount']); } } } } $cache->store($data); $report = $data; try { $result = view('reports.partials.category-period', compact('report', 'periods'))->render(); } catch (\Throwable $e) { app('log')->error(sprintf('Could not render category::expenses: %s', $e->getMessage())); $result = sprintf('An error prevented Firefly III from rendering: %s. Apologies.', $e->getMessage()); throw new FireflyException($result, 0, $e); } $cache->store($result); return $result; } /** * Show overview of income in category. * * @throws FireflyException */ public function income(Collection $accounts, Carbon $start, Carbon $end): string { $cache = new CacheProperties(); $cache->addProperty($start); $cache->addProperty($end); $cache->addProperty('category-period-income-report'); $cache->addProperty($accounts->pluck('id')->toArray()); if ($cache->has()) { return $cache->get(); } // depending on the carbon format (a reliable way to determine the general date difference) // change the "listOfPeriods" call so the entire period gets included correctly. $format = app('navigation')->preferredCarbonFormat($start, $end); if ('Y' === $format) { $start->startOfYear(); } if ('Y-m' === $format) { $start->startOfMonth(); } $periods = app('navigation')->listOfPeriods($start, $end); $data = []; $with = $this->opsRepository->listIncome($start, $end, $accounts); $without = $this->noCatRepository->listIncome($start, $end, $accounts); foreach ([$with, $without] as $set) { foreach ($set as $currencyId => $currencyRow) { foreach ($currencyRow['categories'] as $categoryId => $categoryRow) { $key = sprintf('%d-%d', $currencyId, $categoryId); $data[$key] ??= [ 'id' => $categoryRow['id'], 'title' => sprintf('%s (%s)', $categoryRow['name'], $currencyRow['currency_name']), 'currency_id' => $currencyRow['currency_id'], 'currency_symbol' => $currencyRow['currency_symbol'], 'currency_name' => $currencyRow['currency_name'], 'currency_code' => $currencyRow['currency_code'], 'currency_decimal_places' => $currencyRow['currency_decimal_places'], 'sum' => '0', 'entries' => [], ]; foreach ($categoryRow['transaction_journals'] as $journal) { $date = $journal['date']->format($format); $data[$key]['entries'][$date] ??= '0'; $data[$key]['entries'][$date] = bcadd($data[$key]['entries'][$date], (string) $journal['amount']); $data[$key]['sum'] = bcadd($data[$key]['sum'], (string) $journal['amount']); } } } } $report = $data; try { $result = view('reports.partials.category-period', compact('report', 'periods'))->render(); } catch (\Throwable $e) { app('log')->error(sprintf('Could not render category::expenses: %s', $e->getMessage())); $result = sprintf('An error prevented Firefly III from rendering: %s. Apologies.', $e->getMessage()); throw new FireflyException($result, 0, $e); } $cache->store($result); return $result; } /** * Show overview of category transactions on the default report. * * @throws FireflyException */ public function operations(Collection $accounts, Carbon $start, Carbon $end): string { // chart properties for cache: $cache = new CacheProperties(); $cache->addProperty($start); $cache->addProperty($end); $cache->addProperty('category-report'); $cache->addProperty($accounts->pluck('id')->toArray()); if ($cache->has()) { return $cache->get(); } /** @var CategoryReportGenerator $generator */ $generator = app(CategoryReportGenerator::class); $generator->setAccounts($accounts); $generator->setStart($start); $generator->setEnd($end); $generator->operations(); $report = $generator->getReport(); try { $result = view('reports.partials.categories', compact('report'))->render(); $cache->store($result); } catch (\Throwable $e) { app('log')->error(sprintf('Could not render category::expenses: %s', $e->getMessage())); $result = sprintf('An error prevented Firefly III from rendering: %s. Apologies.', $e->getMessage()); throw new FireflyException($result, 0, $e); } return $result; } /** * @return string * * @throws FireflyException */ public function topExpenses(Collection $accounts, Collection $categories, Carbon $start, Carbon $end) { $spent = $this->opsRepository->listExpenses($start, $end, $accounts, $categories); $result = []; foreach ($spent as $currency) { foreach ($currency['categories'] as $category) { foreach ($category['transaction_journals'] as $journal) { $result[] = [ 'description' => $journal['description'], 'transaction_group_id' => $journal['transaction_group_id'], 'amount_float' => (float) $journal['amount'], 'amount' => $journal['amount'], 'date' => $journal['date']->isoFormat($this->monthAndDayFormat), 'date_sort' => $journal['date']->format('Y-m-d'), 'destination_account_name' => $journal['destination_account_name'], 'destination_account_id' => $journal['destination_account_id'], 'currency_id' => $currency['currency_id'], 'currency_name' => $currency['currency_name'], 'currency_symbol' => $currency['currency_symbol'], 'currency_decimal_places' => $currency['currency_decimal_places'], 'category_id' => $category['id'], 'category_name' => $category['name'], ]; } } } // sort by amount_float // sort temp array by amount. $amounts = array_column($result, 'amount_float'); array_multisort($amounts, SORT_ASC, $result); try { $result = view('reports.category.partials.top-expenses', compact('result'))->render(); } catch (\Throwable $e) { app('log')->debug(sprintf('Could not render reports.partials.budget-period: %s', $e->getMessage())); $result = sprintf('Could not render view: %s', $e->getMessage()); throw new FireflyException($e->getMessage(), 0, $e); } return $result; } /** * @return string * * @throws FireflyException */ public function topIncome(Collection $accounts, Collection $categories, Carbon $start, Carbon $end) { $spent = $this->opsRepository->listIncome($start, $end, $accounts, $categories); $result = []; foreach ($spent as $currency) { foreach ($currency['categories'] as $category) { foreach ($category['transaction_journals'] as $journal) { $result[] = [ 'description' => $journal['description'], 'transaction_group_id' => $journal['transaction_group_id'], 'amount_float' => (float) $journal['amount'], 'amount' => $journal['amount'], 'date' => $journal['date']->isoFormat($this->monthAndDayFormat), 'date_sort' => $journal['date']->format('Y-m-d'), 'source_account_name' => $journal['source_account_name'], 'source_account_id' => $journal['source_account_id'], 'currency_id' => $currency['currency_id'], 'currency_name' => $currency['currency_name'], 'currency_symbol' => $currency['currency_symbol'], 'currency_decimal_places' => $currency['currency_decimal_places'], 'category_id' => $category['id'], 'category_name' => $category['name'], ]; } } } // sort by amount_float // sort temp array by amount. $amounts = array_column($result, 'amount_float'); array_multisort($amounts, SORT_DESC, $result); try { $result = view('reports.category.partials.top-income', compact('result'))->render(); } catch (\Throwable $e) { app('log')->debug(sprintf('Could not render reports.partials.budget-period: %s', $e->getMessage())); $result = sprintf('Could not render view: %s', $e->getMessage()); throw new FireflyException($e->getMessage(), 0, $e); } return $result; } }