mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-02-25 18:45:27 -06:00
447 lines
14 KiB
PHP
447 lines
14 KiB
PHP
<?php
|
|
/**
|
|
* ReportController.php
|
|
* Copyright (c) 2019 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/>.
|
|
*/
|
|
/** @noinspection CallableParameterUseCaseInTypeContextInspection */
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Http\Controllers;
|
|
|
|
use Carbon\Carbon;
|
|
use FireflyIII\Exceptions\FireflyException;
|
|
use FireflyIII\Generator\Report\ReportGeneratorFactory;
|
|
use FireflyIII\Helpers\Report\ReportHelperInterface;
|
|
use FireflyIII\Http\Requests\ReportFormRequest;
|
|
use FireflyIII\Models\Account;
|
|
use FireflyIII\Models\AccountType;
|
|
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
|
|
use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
|
|
use FireflyIII\Support\Http\Controllers\RenderPartialViews;
|
|
use Illuminate\Contracts\View\Factory;
|
|
use Illuminate\Http\RedirectResponse;
|
|
use Illuminate\Routing\Redirector;
|
|
use Illuminate\Support\Collection;
|
|
use Illuminate\View\View;
|
|
use Log;
|
|
|
|
/**
|
|
* Class ReportController.
|
|
*
|
|
*/
|
|
class ReportController extends Controller
|
|
{
|
|
use RenderPartialViews;
|
|
|
|
/** @var ReportHelperInterface Helper interface. */
|
|
protected $helper;
|
|
|
|
/** @var BudgetRepositoryInterface The budget repository */
|
|
private $repository;
|
|
|
|
/**
|
|
* ReportController constructor.
|
|
*/
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
|
|
$this->middleware(
|
|
function ($request, $next) {
|
|
app('view')->share('title', (string) trans('firefly.reports'));
|
|
app('view')->share('mainTitleIcon', 'fa-bar-chart');
|
|
app('view')->share('subTitleIcon', 'fa-calendar');
|
|
$this->helper = app(ReportHelperInterface::class);
|
|
$this->repository = app(BudgetRepositoryInterface::class);
|
|
|
|
return $next($request);
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Show audit report.
|
|
*
|
|
* @param Collection $accounts
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
*
|
|
* @throws FireflyException
|
|
* @return Factory|View|string
|
|
*
|
|
*/
|
|
public function auditReport(Collection $accounts, Carbon $start, Carbon $end)
|
|
{
|
|
if ($end < $start) {
|
|
return view('error')->with('message', (string) trans('firefly.end_after_start_date')); // @codeCoverageIgnore
|
|
}
|
|
$this->repository->cleanupBudgets();
|
|
|
|
app('view')->share(
|
|
'subTitle',
|
|
trans(
|
|
'firefly.report_audit',
|
|
[
|
|
'start' => $start->formatLocalized($this->monthAndDayFormat),
|
|
'end' => $end->formatLocalized($this->monthAndDayFormat),
|
|
]
|
|
)
|
|
);
|
|
|
|
$generator = ReportGeneratorFactory::reportGenerator('Audit', $start, $end);
|
|
$generator->setAccounts($accounts);
|
|
|
|
return $generator->generate();
|
|
}
|
|
|
|
/**
|
|
* Show budget report.
|
|
*
|
|
* @param Collection $accounts
|
|
* @param Collection $budgets
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
*
|
|
* @throws FireflyException
|
|
* @return Factory|View|string
|
|
*
|
|
*/
|
|
public function budgetReport(Collection $accounts, Collection $budgets, Carbon $start, Carbon $end)
|
|
{
|
|
if ($end < $start) {
|
|
return view('error')->with('message', (string) trans('firefly.end_after_start_date')); // @codeCoverageIgnore
|
|
}
|
|
$this->repository->cleanupBudgets();
|
|
|
|
app('view')->share(
|
|
'subTitle',
|
|
trans(
|
|
'firefly.report_budget',
|
|
[
|
|
'start' => $start->formatLocalized($this->monthAndDayFormat),
|
|
'end' => $end->formatLocalized($this->monthAndDayFormat),
|
|
]
|
|
)
|
|
);
|
|
|
|
$generator = ReportGeneratorFactory::reportGenerator('Budget', $start, $end);
|
|
$generator->setAccounts($accounts);
|
|
$generator->setBudgets($budgets);
|
|
|
|
return $generator->generate();
|
|
}
|
|
|
|
/**
|
|
* Show category report.
|
|
*
|
|
* @param Collection $accounts
|
|
* @param Collection $categories
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
*
|
|
* @throws FireflyException
|
|
* @return Factory|View|string
|
|
*
|
|
*/
|
|
public function categoryReport(Collection $accounts, Collection $categories, Carbon $start, Carbon $end)
|
|
{
|
|
if ($end < $start) {
|
|
return view('error')->with('message', (string) trans('firefly.end_after_start_date')); // @codeCoverageIgnore
|
|
}
|
|
$this->repository->cleanupBudgets();
|
|
|
|
app('view')->share(
|
|
'subTitle',
|
|
trans(
|
|
'firefly.report_category',
|
|
[
|
|
'start' => $start->formatLocalized($this->monthAndDayFormat),
|
|
'end' => $end->formatLocalized($this->monthAndDayFormat),
|
|
]
|
|
)
|
|
);
|
|
|
|
$generator = ReportGeneratorFactory::reportGenerator('Category', $start, $end);
|
|
$generator->setAccounts($accounts);
|
|
$generator->setCategories($categories);
|
|
|
|
return $generator->generate();
|
|
}
|
|
|
|
/**
|
|
* Show default report.
|
|
*
|
|
* @param Collection $accounts
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
*
|
|
* @throws FireflyException
|
|
* @return Factory|View|string
|
|
*
|
|
*/
|
|
public function defaultReport(Collection $accounts, Carbon $start, Carbon $end)
|
|
{
|
|
if ($end < $start) {
|
|
return view('error')->with('message', (string) trans('firefly.end_after_start_date'));
|
|
}
|
|
|
|
$this->repository->cleanupBudgets();
|
|
|
|
app('view')->share(
|
|
'subTitle',
|
|
trans(
|
|
'firefly.report_default',
|
|
[
|
|
'start' => $start->formatLocalized($this->monthAndDayFormat),
|
|
'end' => $end->formatLocalized($this->monthAndDayFormat),
|
|
]
|
|
)
|
|
);
|
|
|
|
$generator = ReportGeneratorFactory::reportGenerator('Standard', $start, $end);
|
|
$generator->setAccounts($accounts);
|
|
|
|
return $generator->generate();
|
|
}
|
|
|
|
/**
|
|
* Show account report.
|
|
*
|
|
* @param Collection $accounts
|
|
* @param Collection $expense
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
*
|
|
* @throws FireflyException
|
|
* @return Factory|View|string
|
|
*/
|
|
public function doubleReport(Collection $accounts, Collection $expense, Carbon $start, Carbon $end)
|
|
{
|
|
if ($end < $start) {
|
|
[$start, $end] = [$end, $start];
|
|
}
|
|
|
|
$this->repository->cleanupBudgets();
|
|
|
|
app('view')->share(
|
|
'subTitle',
|
|
trans(
|
|
'firefly.report_double',
|
|
['start' => $start->formatLocalized($this->monthAndDayFormat), 'end' => $end->formatLocalized($this->monthAndDayFormat)]
|
|
)
|
|
);
|
|
|
|
$generator = ReportGeneratorFactory::reportGenerator('Account', $start, $end);
|
|
$generator->setAccounts($accounts);
|
|
$generator->setExpense($expense);
|
|
|
|
return $generator->generate();
|
|
}
|
|
|
|
/**
|
|
* Show index.
|
|
*
|
|
* @param AccountRepositoryInterface $repository
|
|
*
|
|
* @return Factory|View
|
|
*/
|
|
public function index(AccountRepositoryInterface $repository)
|
|
{
|
|
/** @var Carbon $start */
|
|
$start = clone session('first');
|
|
$months = $this->helper->listOfMonths($start);
|
|
$customFiscalYear = app('preferences')->get('customFiscalYear', 0)->data;
|
|
$accounts = $repository->getAccountsByType(
|
|
[AccountType::DEFAULT, AccountType::ASSET, AccountType::DEBT, AccountType::LOAN, AccountType::MORTGAGE]
|
|
);
|
|
|
|
// group accounts by role:
|
|
$groupedAccounts = [];
|
|
/** @var Account $account */
|
|
foreach ($accounts as $account) {
|
|
$type = $account->accountType->type;
|
|
$role = sprintf('opt_group_%s', $repository->getMetaValue($account, 'account_role'));
|
|
|
|
if (in_array($type, [AccountType::MORTGAGE, AccountType::DEBT, AccountType::LOAN], true)) {
|
|
$role = sprintf('opt_group_l_%s', $type);
|
|
}
|
|
|
|
if ('' === $role || 'opt_group_' === $role) {
|
|
$role = 'opt_group_defaultAsset';
|
|
}
|
|
$groupedAccounts[trans(sprintf('firefly.%s', $role))][$account->id] = $account;
|
|
}
|
|
ksort($groupedAccounts);
|
|
|
|
$accountList = implode(',', $accounts->pluck('id')->toArray());
|
|
$this->repository->cleanupBudgets();
|
|
|
|
return view('reports.index', compact('months', 'accounts', 'start', 'accountList', 'groupedAccounts', 'customFiscalYear'));
|
|
}
|
|
|
|
/**
|
|
* Show options for reports.
|
|
*
|
|
* @param string $reportType
|
|
*
|
|
* @return mixed
|
|
*
|
|
*/
|
|
public function options(string $reportType)
|
|
{
|
|
switch ($reportType) {
|
|
default:
|
|
$result = $this->noReportOptions();
|
|
break;
|
|
case 'category':
|
|
$result = $this->categoryReportOptions();
|
|
break;
|
|
case 'budget':
|
|
$result = $this->budgetReportOptions();
|
|
break;
|
|
case 'tag':
|
|
$result = $this->tagReportOptions();
|
|
break;
|
|
case 'double':
|
|
$result = $this->doubleReportOptions();
|
|
break;
|
|
}
|
|
|
|
return response()->json(['html' => $result]);
|
|
}
|
|
|
|
/**
|
|
* Process the submit of report.
|
|
*
|
|
* @param ReportFormRequest $request
|
|
*
|
|
* @throws FireflyException
|
|
*
|
|
* @return RedirectResponse|Redirector
|
|
*
|
|
*/
|
|
public function postIndex(ReportFormRequest $request)
|
|
{
|
|
// report type:
|
|
$reportType = $request->get('report_type');
|
|
$start = $request->getStartDate()->format('Ymd');
|
|
$end = $request->getEndDate()->format('Ymd');
|
|
$accounts = implode(',', $request->getAccountList()->pluck('id')->toArray());
|
|
$categories = implode(',', $request->getCategoryList()->pluck('id')->toArray());
|
|
$budgets = implode(',', $request->getBudgetList()->pluck('id')->toArray());
|
|
$tags = implode(',', $request->getTagList()->pluck('id')->toArray());
|
|
$double = implode(',', $request->getDoubleList()->pluck('id')->toArray());
|
|
$uri = route('reports.index');
|
|
|
|
if (0 === $request->getAccountList()->count()) {
|
|
Log::debug('Account count is zero');
|
|
session()->flash('error', (string) trans('firefly.select_at_least_one_account'));
|
|
|
|
return redirect(route('reports.index'));
|
|
}
|
|
|
|
if ('category' === $reportType && 0 === $request->getCategoryList()->count()) {
|
|
session()->flash('error', (string) trans('firefly.select_at_least_one_category'));
|
|
|
|
return redirect(route('reports.index'));
|
|
}
|
|
|
|
if ('budget' === $reportType && 0 === $request->getBudgetList()->count()) {
|
|
session()->flash('error', (string) trans('firefly.select_at_least_one_budget'));
|
|
|
|
return redirect(route('reports.index'));
|
|
}
|
|
|
|
if ('tag' === $reportType && 0 === $request->getTagList()->count()) {
|
|
session()->flash('error', (string) trans('firefly.select_at_least_one_tag'));
|
|
|
|
return redirect(route('reports.index'));
|
|
}
|
|
|
|
if ('double' === $reportType && 0 === $request->getDoubleList()->count()) {
|
|
session()->flash('error', (string) trans('firefly.select_at_least_one_expense'));
|
|
|
|
return redirect(route('reports.index'));
|
|
}
|
|
|
|
if ($request->getEndDate() < $request->getStartDate()) {
|
|
return view('error')->with('message', (string) trans('firefly.end_after_start_date'));
|
|
}
|
|
|
|
switch ($reportType) {
|
|
case 'category':
|
|
$uri = route('reports.report.category', [$accounts, $categories, $start, $end]);
|
|
break;
|
|
case 'default':
|
|
$uri = route('reports.report.default', [$accounts, $start, $end]);
|
|
break;
|
|
case 'audit':
|
|
$uri = route('reports.report.audit', [$accounts, $start, $end]);
|
|
break;
|
|
case 'budget':
|
|
$uri = route('reports.report.budget', [$accounts, $budgets, $start, $end]);
|
|
break;
|
|
case 'tag':
|
|
$uri = route('reports.report.tag', [$accounts, $tags, $start, $end]);
|
|
break;
|
|
case 'double':
|
|
$uri = route('reports.report.double', [$accounts, $double, $start, $end]);
|
|
break;
|
|
}
|
|
|
|
return redirect($uri);
|
|
}
|
|
|
|
|
|
/**
|
|
* Get a tag report.
|
|
*
|
|
* @param Collection $accounts
|
|
* @param Collection $tags
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
*
|
|
* @throws FireflyException
|
|
* @return Factory|View|string
|
|
*/
|
|
public function tagReport(Collection $accounts, Collection $tags, Carbon $start, Carbon $end)
|
|
{
|
|
if ($end < $start) {
|
|
return view('error')->with('message', (string) trans('firefly.end_after_start_date')); // @codeCoverageIgnore
|
|
}
|
|
$this->repository->cleanupBudgets();
|
|
|
|
app('view')->share(
|
|
'subTitle',
|
|
trans(
|
|
'firefly.report_tag',
|
|
[
|
|
'start' => $start->formatLocalized($this->monthAndDayFormat),
|
|
'end' => $end->formatLocalized($this->monthAndDayFormat),
|
|
]
|
|
)
|
|
);
|
|
|
|
$generator = ReportGeneratorFactory::reportGenerator('Tag', $start, $end);
|
|
$generator->setAccounts($accounts);
|
|
$generator->setTags($tags);
|
|
|
|
return $generator->generate();
|
|
}
|
|
}
|