firefly-iii/app/Http/Controllers/Popup/ReportController.php

<?php
/**
 * ReportController.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\Popup;

use Carbon\Carbon;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Helpers\Collection\BalanceLine;
use FireflyIII\Helpers\Report\PopupReportInterface;
use FireflyIII\Http\Controllers\Controller;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
use FireflyIII\Support\Binder\AccountList;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use Illuminate\Routing\Route;
use InvalidArgumentException;

/**
 * Class ReportController.
 */
class ReportController extends Controller
{
    /** @var AccountRepositoryInterface */
    private $accountRepository;
    /** @var BudgetRepositoryInterface */
    private $budgetRepository;
    /** @var CategoryRepositoryInterface */
    private $categoryRepository;
    /** @var PopupReportInterface */
    private $popupHelper;

    /**
     *
     */
    public function __construct()
    {
        parent::__construct();
        $this->middleware(
            function ($request, $next) {
                /** @var AccountRepositoryInterface accountRepository */
                $this->accountRepository = app(AccountRepositoryInterface::class);

                /** @var BudgetRepositoryInterface budgetRepository */
                $this->budgetRepository = app(BudgetRepositoryInterface::class);

                /** @var CategoryRepositoryInterface categoryRepository */
                $this->categoryRepository = app(CategoryRepositoryInterface::class);

                /** @var PopupReportInterface popupHelper */
                $this->popupHelper = app(PopupReportInterface::class);

                return $next($request);
            }
        );
    }

    /**
     * @param Request $request
     *
     * @return JsonResponse
     *
     * @throws FireflyException
     * @throws \Throwable
     */
    public function general(Request $request): JsonResponse
    {
        $attributes = $request->get('attributes') ?? [];
        $attributes = $this->parseAttributes($attributes);

        app('view')->share('start', $attributes['startDate']);
        app('view')->share('end', $attributes['endDate']);

        switch ($attributes['location']) {
            default:
                throw new FireflyException('Firefly cannot handle "' . e($attributes['location']) . '" ');
            case 'budget-spent-amount':
                $html = $this->budgetSpentAmount($attributes);
                break;
            case 'expense-entry':
                $html = $this->expenseEntry($attributes);
                break;
            case 'income-entry':
                $html = $this->incomeEntry($attributes);
                break;
            case 'category-entry':
                $html = $this->categoryEntry($attributes);
                break;
            case 'balance-amount':
                $html = $this->balanceAmount($attributes);
                break;
        }

        return response()->json(['html' => $html]);
    }

    /**
     * @param array $attributes
     *
     * @return string
     *
     * @throws FireflyException
     * @throws \Throwable
     */
    private function balanceAmount(array $attributes): string
    {
        $role    = (int)$attributes['role'];
        $budget  = $this->budgetRepository->findNull((int)$attributes['budgetId']);
        $account = $this->accountRepository->findNull((int)$attributes['accountId']);


        switch (true) {
            case BalanceLine::ROLE_DEFAULTROLE === $role && null !== $budget && null !== $account:
                // normal row with a budget:
                $journals = $this->popupHelper->balanceForBudget($budget, $account, $attributes);
                break;
            case BalanceLine::ROLE_DEFAULTROLE === $role && null === $budget && null !== $account:
                // normal row without a budget:
                $journals     = $this->popupHelper->balanceForNoBudget($account, $attributes);
                $budget->name = (string)trans('firefly.no_budget');
                break;
            case BalanceLine::ROLE_TAGROLE === $role:
                // row with tag info.
                throw new FireflyException('Firefly cannot handle this type of info-button (BalanceLine::TagRole)');
        }
        $view = view('popup.report.balance-amount', compact('journals', 'budget', 'account'))->render();

        return $view;
    }

    /**
     * Returns all expenses inside the given budget for the given accounts.
     *
     * @param array $attributes
     *
     * @return string
     * @throws \Throwable
     */
    private function budgetSpentAmount(array $attributes): string
    {
        $budget = $this->budgetRepository->findNull((int)$attributes['budgetId']);
        if (null === $budget) {
            throw new FireflyException('This is an unknown budget. Apologies.');
        }
        $journals = $this->popupHelper->byBudget($budget, $attributes);
        $view     = view('popup.report.budget-spent-amount', compact('journals', 'budget'))->render();

        return $view;
    }

    /**
     * Returns all expenses in category in range.
     *
     * @param array $attributes
     *
     * @return string
     * @throws \Throwable
     */
    private function categoryEntry(array $attributes): string
    {
        $category = $this->categoryRepository->findNull((int)$attributes['categoryId']);

        if (null === $category) {
            throw new FireflyException('This is an unknown category. Apologies.');
        }

        $journals = $this->popupHelper->byCategory($category, $attributes);
        $view     = view('popup.report.category-entry', compact('journals', 'category'))->render();

        return $view;
    }

    /**
     * Returns all the expenses that went to the given expense account.
     *
     * @param array $attributes
     *
     * @return string
     * @throws \Throwable
     */
    private function expenseEntry(array $attributes): string
    {
        $account = $this->accountRepository->findNull((int)$attributes['accountId']);

        if (null === $account) {
            throw new FireflyException('This is an unknown account. Apologies.');
        }

        $journals = $this->popupHelper->byExpenses($account, $attributes);
        $view     = view('popup.report.expense-entry', compact('journals', 'account'))->render();

        return $view;
    }

    /**
     * Returns all the incomes that went to the given asset account.
     *
     * @param array $attributes
     *
     * @return string
     * @throws \Throwable
     */
    private function incomeEntry(array $attributes): string
    {
        $account = $this->accountRepository->findNull((int)$attributes['accountId']);

        if (null === $account) {
            throw new FireflyException('This is an unknown category. Apologies.');
        }

        $journals = $this->popupHelper->byIncome($account, $attributes);
        $view     = view('popup.report.income-entry', compact('journals', 'account'))->render();

        return $view;
    }

    /**
     * @param array $attributes
     *
     * @return array
     *
     * @throws FireflyException
     */
    private function parseAttributes(array $attributes): array
    {
        $attributes['location'] = $attributes['location'] ?? '';
        $attributes['accounts'] = AccountList::routeBinder($attributes['accounts'] ?? '', new Route('get', '', []));
        try {
            $attributes['startDate'] = Carbon::createFromFormat('Ymd', $attributes['startDate']);
        } catch (InvalidArgumentException $e) {
            throw new FireflyException(sprintf('Could not parse start date "%s": %s', $attributes['startDate'], $e->getMessage()));
        }

        try {
            $attributes['endDate'] = Carbon::createFromFormat('Ymd', $attributes['endDate']);
        } catch (InvalidArgumentException $e) {
            throw new FireflyException(sprintf('Could not parse end date "%s": %s', $attributes['endDate'], $e->getMessage()));
        }

        return $attributes;
    }
}