firefly-iii/app/Http/Controllers/Report/CategoryController.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\Report;

use Carbon\Carbon;
use FireflyIII\Http\Controllers\Controller;
use FireflyIII\Models\Category;
use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
use FireflyIII\Repositories\Category\NoCategoryRepositoryInterface;
use FireflyIII\Repositories\Category\OperationsRepositoryInterface;
use FireflyIII\Support\CacheProperties;
use FireflyIII\Support\Http\Controllers\BasicDataSupport;
use Illuminate\Support\Collection;
use Log;
use Throwable;

/**
 * Class CategoryController.
 */
class CategoryController extends Controller
{
    use BasicDataSupport;

    /**
     * Show overview of expenses in category.
     *
     * @param Collection $accounts
     * @param Carbon     $start
     * @param Carbon     $end
     *
     * @return mixed|string
     */
    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(); // @codeCoverageIgnore
        }
        /** @var CategoryRepositoryInterface $repository */
        $repository = app(CategoryRepositoryInterface::class);

        /** @var OperationsRepositoryInterface $opsRepository */
        $opsRepository = app(OperationsRepositoryInterface::class);

        /** @var NoCategoryRepositoryInterface $noCatRepos */
        $noCatRepos = app(NoCategoryRepositoryInterface::class);

        // 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    = $opsRepository->listExpenses($start, $end, $accounts);
        $without = $noCatRepos->listExpenses($start, $end, $accounts);

        foreach ($with as $currencyId => $currencyRow) {
            foreach ($currencyRow['categories'] as $categoryId => $categoryRow) {
                $key        = sprintf('%d-%d', $currencyId, $categoryId);
                $data[$key] = $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 $journalId => $journal) {
                    $date                         = $journal['date']->format($format);
                    $data[$key]['entries'][$date] = $data[$key]['entries'][$date] ?? '0';
                    $data[$key]['entries'][$date] = bcadd($data[$key]['entries'][$date], $journal['amount']);
                    $data[$key]['sum']            = bcadd($data[$key]['sum'], $journal['amount']);
                }
            }
        }
        foreach ($without as $currencyId => $currencyRow) {
            $key        = sprintf('0-%d', $currencyId);
            $data[$key] = $data[$key] ?? [
                    'id'                      => 0,
                    'title'                   => sprintf('%s (%s)', trans('firefly.noCategory'), $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 ($currencyRow['transaction_journals'] as $journalId => $journal) {
                $date                         = $journal['date']->format($format);
                $data[$key]['entries'][$date] = $data[$key]['entries'][$date] ?? '0';
                $data[$key]['entries'][$date] = bcadd($data[$key]['entries'][$date], $journal['amount']);
                $data[$key]['sum']            = bcadd($data[$key]['sum'], $journal['amount']);
            }
        }
        $cache->store($data);

        $report = $data;

        try {
            $result = view('reports.partials.category-period', compact('report', 'periods'))->render();
            // @codeCoverageIgnoreStart
        } catch (Throwable $e) {
            Log::error(sprintf('Could not render category::expenses: %s', $e->getMessage()));
            $result = sprintf('An error prevented Firefly III from rendering: %s. Apologies.', $e->getMessage());
        }
        // @codeCoverageIgnoreEnd

        $cache->store($result);

        return $result;
    }


    /**
     * Show overview of income in category.
     *
     * @param Collection $accounts
     *
     * @param Carbon     $start
     * @param Carbon     $end
     *
     * @return string
     */
    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(); // @codeCoverageIgnore
        }

        /** @var OperationsRepositoryInterface $opsRepository */
        $opsRepository = app(OperationsRepositoryInterface::class);

        /** @var NoCategoryRepositoryInterface $noCatRepos */
        $noCatRepos = app(NoCategoryRepositoryInterface::class);

        // 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    = $opsRepository->listIncome($start, $end, $accounts);
        $without = $noCatRepos->listIncome($start, $end, $accounts);

        foreach ($with as $currencyId => $currencyRow) {
            foreach ($currencyRow['categories'] as $categoryId => $categoryRow) {
                $key        = sprintf('%d-%d', $currencyId, $categoryId);
                $data[$key] = $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 $journalId => $journal) {
                    $date                         = $journal['date']->format($format);
                    $data[$key]['entries'][$date] = $data[$key]['entries'][$date] ?? '0';
                    $data[$key]['entries'][$date] = bcadd($data[$key]['entries'][$date], $journal['amount']);
                    $data[$key]['sum']            = bcadd($data[$key]['sum'], $journal['amount']);
                }
            }
        }
        foreach ($without as $currencyId => $currencyRow) {
            $key        = sprintf('0-%d', $currencyId);
            $data[$key] = $data[$key] ?? [
                    'id'                      => 0,
                    'title'                   => sprintf('%s (%s)', trans('firefly.noCategory'), $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 ($currencyRow['transaction_journals'] as $journalId => $journal) {
                $date                         = $journal['date']->format($format);
                $data[$key]['entries'][$date] = $data[$key]['entries'][$date] ?? '0';
                $data[$key]['entries'][$date] = bcadd($data[$key]['entries'][$date], $journal['amount']);
                $data[$key]['sum']            = bcadd($data[$key]['sum'], $journal['amount']);
            }
        }
        $cache->store($data);

        $report = $data;

        try {
            $result = view('reports.partials.category-period', compact('report', 'periods'))->render();
            // @codeCoverageIgnoreStart
        } catch (Throwable $e) {
            Log::error(sprintf('Could not render category::expenses: %s', $e->getMessage()));
            $result = sprintf('An error prevented Firefly III from rendering: %s. Apologies.', $e->getMessage());
        }
        // @codeCoverageIgnoreEnd

        $cache->store($result);

        return $result;
    }


    /**
     * Show overview of operations.
     *
     * @param Collection $accounts
     * @param Carbon     $start
     * @param Carbon     $end
     *
     * @return mixed|string
     *
     */
    public function operations(Collection $accounts, Carbon $start, Carbon $end)
    {
        // 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(); // @codeCoverageIgnore
        }

        /** @var CategoryRepositoryInterface $repository */
        $repository = app(CategoryRepositoryInterface::class);

        /** @var OperationsRepositoryInterface $opsRepository */
        $opsRepository = app(OperationsRepositoryInterface::class);

        /** @var NoCategoryRepositoryInterface $noCatRepository */
        $noCatRepository = app(NoCategoryRepositoryInterface::class);

        $categories    = $repository->getCategories();
        $earnedWith    = $opsRepository->listIncome($start, $end, $accounts);
        $spentWith     = $opsRepository->listExpenses($start, $end, $accounts);
        $earnedWithout = $noCatRepository->listIncome($start, $end, $accounts);
        $spentWithout  = $noCatRepository->listExpenses($start, $end, $accounts);

        $report = [
            'categories' => [],
            'sums'       => [],
        ];

        // needs four for-each loops.
        // TODO improve this.
        foreach ([$earnedWith, $spentWith] as $data) {
            foreach ($data as $currencyId => $currencyRow) {
                $report['sums'][$currencyId] = $report['sums'][$currencyId] ?? [
                        'spent'                     => '0',
                        'earned'                     => '0',
                        'sum'                     => '0',
                        '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'],
                    ];


                foreach ($currencyRow['categories'] as $categoryId => $categoryRow) {
                    $key                        = sprintf('%s-%s', $currencyId, $categoryId);
                    $report['categories'][$key] = $report['categories'][$key] ?? [
                            'id'                      => $categoryId,
                            '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'],
                            'spent'                   => '0',
                            'earned'                  => '0',
                            'sum'                     => '0',
                        ];
                    // loop journals:
                    foreach ($categoryRow['transaction_journals'] as $journal) {
                        // sum of sums
                        $report['sums'][$currencyId]['sum']   = bcadd($report['sums'][$currencyId]['sum'], $journal['amount']);
                        // sum of spent:
                        $report['sums'][$currencyId]['spent']   = -1 === bccomp($journal['amount'], '0') ? bcadd($report['sums'][$currencyId]['spent'], $journal['amount']): $report['sums'][$currencyId]['spent'];
                        // sum of earned
                        $report['sums'][$currencyId]['earned']   = 1 === bccomp($journal['amount'], '0') ? bcadd($report['sums'][$currencyId]['earned'], $journal['amount']): $report['sums'][$currencyId]['earned'];

                        // sum of category
                        $report['categories'][$key]['sum']    = bcadd($report['categories'][$key]['sum'], $journal['amount']);
                        // total spent in category
                        $report['categories'][$key]['spent']  = -1 === bccomp($journal['amount'], '0') ? bcadd(
                            $report['categories'][$key]['spent'], $journal['amount']
                        ) : $report['categories'][$key]['spent'];
                        // total earned in category
                        $report['categories'][$key]['earned'] = 1 === bccomp($journal['amount'], '0') ? bcadd(
                            $report['categories'][$key]['earned'], $journal['amount']
                        ) : $report['categories'][$key]['earned'];
                    }
                }
            }
        }
        foreach ([$earnedWithout, $spentWithout] as $data) {
            foreach ($data as $currencyId => $currencyRow) {
                $report['sums'][$currencyId] = $report['sums'][$currencyId] ?? [
                        'spent'                   => '0',
                        'earned'                  => '0',
                        'sum'                     => '0',
                        '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'],
                    ];
                $key                         = sprintf('%s-0', $currencyId);
                $report['categories'][$key]  = $report['categories'][$key] ?? [
                        'id'                      => 0,
                        'title'                   => sprintf('%s (%s)', trans('firefly.noCategory'), $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'],
                        'spent'                   => '0',
                        'earned'                  => '0',
                        'sum'                     => '0',
                    ];
                // loop journals:
                foreach ($currencyRow['transaction_journals'] as $journal) {
                    // sum of all
                    $report['sums'][$currencyId]['sum']   = bcadd($report['sums'][$currencyId]['sum'], $journal['amount']);

                    // sum of spent:
                    $report['sums'][$currencyId]['spent']   = -1 === bccomp($journal['amount'], '0') ? bcadd($report['sums'][$currencyId]['spent'], $journal['amount']): $report['sums'][$currencyId]['spent'];
                    // sum of earned
                    $report['sums'][$currencyId]['earned']   = 1 === bccomp($journal['amount'], '0') ? bcadd($report['sums'][$currencyId]['earned'], $journal['amount']): $report['sums'][$currencyId]['earned'];

                    // sum of category
                    $report['categories'][$key]['sum']    = bcadd($report['categories'][$key]['sum'], $journal['amount']);
                    // total spent in no category
                    $report['categories'][$key]['spent']  = -1 === bccomp($journal['amount'], '0') ? bcadd(
                        $report['categories'][$key]['spent'], $journal['amount']
                    ) : $report['categories'][$key]['spent'];
                    // total earned in no category
                    $report['categories'][$key]['earned'] = 1 === bccomp($journal['amount'], '0') ? bcadd(
                        $report['categories'][$key]['earned'], $journal['amount']
                    ) : $report['categories'][$key]['earned'];
                }
            }
        }

        // @codeCoverageIgnoreStart
        try {
            $result = view('reports.partials.categories', compact('report'))->render();
            $cache->store($result);
        } catch (Throwable $e) {
            Log::error(sprintf('Could not render category::expenses: %s', $e->getMessage()));
            $result = sprintf('An error prevented Firefly III from rendering: %s. Apologies.', $e->getMessage());
        }

        // @codeCoverageIgnoreEnd

        return $result;
    }

    /**
     * @param array $array
     *
     * @return bool
     */
    private function noAmountInArray(array $array): bool
    {
        if (0 === count($array)) {
            return true;
        }

        return false;
    }


}