firefly-iii/app/Http/Controllers/BudgetController.php

<?php namespace FireflyIII\Http\Controllers;

use Amount;
use Auth;
use Carbon\Carbon;
use Config;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Http\Requests\BudgetFormRequest;
use FireflyIII\Models\Budget;
use FireflyIII\Models\LimitRepetition;
use FireflyIII\Repositories\Account\AccountRepositoryInterface as ARI;
use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
use Illuminate\Pagination\LengthAwarePaginator;
use Illuminate\Support\Collection;
use Input;
use Navigation;
use Preferences;
use Response;
use Session;
use URL;
use View;

/**
 * Class BudgetController
 *
 * @package FireflyIII\Http\Controllers
 */
class BudgetController extends Controller
{

    /**
     *
     */
    public function __construct()
    {
        parent::__construct();
        View::share('title', trans('firefly.budgets'));
        View::share('mainTitleIcon', 'fa-tasks');
        View::share('hideBudgets', true);
    }

    /**
     * @param BudgetRepositoryInterface $repository
     * @param Budget                    $budget
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function amount(BudgetRepositoryInterface $repository, Budget $budget)
    {
        $amount = intval(Input::get('amount'));
        /** @var Carbon $start */
        $start = session('start', Carbon::now()->startOfMonth());
        /** @var Carbon $end */
        $end       = session('end', Carbon::now()->endOfMonth());
        $viewRange = Preferences::get('viewRange', '1M')->data;

        // is custom view range?
        if (session('is_custom_range') === true) {
            $viewRange = 'custom';
        }

        $limitRepetition = $repository->updateLimitAmount($budget, $start, $end, $viewRange, $amount);
        if ($amount == 0) {
            $limitRepetition = null;
        }
        Preferences::mark();

        return Response::json(['name' => $budget->name, 'repetition' => $limitRepetition ? $limitRepetition->id : 0]);

    }

    /**
     * @return \Illuminate\View\View
     */
    public function create()
    {
        // put previous url in session if not redirect from store (not "create another").
        if (session('budgets.create.fromStore') !== true) {
            Session::put('budgets.create.url', URL::previous());
        }
        Session::forget('budgets.create.fromStore');
        Session::flash('gaEventCategory', 'budgets');
        Session::flash('gaEventAction', 'create');
        $subTitle = (string)trans('firefly.create_new_budget');

        return view('budgets.create', compact('subTitle'));
    }

    /**
     * @param Budget $budget
     *
     * @return \Illuminate\View\View
     */
    public function delete(Budget $budget)
    {
        $subTitle = trans('firefly.delete_budget', ['name' => $budget->name]);

        // put previous url in session
        Session::put('budgets.delete.url', URL::previous());
        Session::flash('gaEventCategory', 'budgets');
        Session::flash('gaEventAction', 'delete');

        return view('budgets.delete', compact('budget', 'subTitle'));
    }

    /**
     * @param Budget                    $budget
     * @param BudgetRepositoryInterface $repository
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function destroy(Budget $budget, BudgetRepositoryInterface $repository)
    {

        $name = $budget->name;
        $repository->destroy($budget);


        Session::flash('success', strval(trans('firefly.deleted_budget', ['name' => e($name)])));
        Preferences::mark();


        return redirect(session('budgets.delete.url'));
    }

    /**
     * @param Budget $budget
     *
     * @return \Illuminate\View\View
     */
    public function edit(Budget $budget)
    {
        $subTitle = trans('firefly.edit_budget', ['name' => $budget->name]);

        // put previous url in session if not redirect from store (not "return_to_edit").
        if (session('budgets.edit.fromUpdate') !== true) {
            Session::put('budgets.edit.url', URL::previous());
        }
        Session::forget('budgets.edit.fromUpdate');
        Session::flash('gaEventCategory', 'budgets');
        Session::flash('gaEventAction', 'edit');

        return view('budgets.edit', compact('budget', 'subTitle'));

    }

    /**
     * @param BudgetRepositoryInterface $repository
     *
     * @param ARI                       $accountRepository
     *
     * @return \Illuminate\View\View
     */
    public function index(BudgetRepositoryInterface $repository, ARI $accountRepository)
    {
        $budgets    = $repository->getActiveBudgets();
        $inactive   = $repository->getInactiveBudgets();
        $spent      = '0';
        $budgeted   = '0';
        $range      = Preferences::get('viewRange', '1M')->data;
        $repeatFreq = Config::get('firefly.range_to_repeat_freq.' . $range);

        if (session('is_custom_range') === true) {
            $repeatFreq = 'custom';
        }

        /** @var Carbon $start */
        $start = session('start', new Carbon);
        /** @var Carbon $end */
        $end               = session('end', new Carbon);
        $key               = 'budgetIncomeTotal' . $start->format('Ymd') . $end->format('Ymd');
        $budgetIncomeTotal = Preferences::get($key, 1000)->data;
        $period            = Navigation::periodShow($start, $range);
        $periodStart       = $start->formatLocalized($this->monthAndDayFormat);
        $periodEnd         = $end->formatLocalized($this->monthAndDayFormat);
        $accounts          = $accountRepository->getAccounts(['Default account', 'Asset account', 'Cash account']);

        /**
         * Do some cleanup:
         */
        // $repository->cleanupBudgets();

        // loop the budgets:
        /** @var Budget $budget */
        foreach ($budgets as $budget) {
            $budget->spent            = '0';//$repository->balanceInPeriod($budget, $start, $end, $accounts); // TODO BUDGET spentInPeriod
            $budget->currentRep       = new LimitRepetition(
            ); // $repository->getCurrentRepetition($budget, $repeatFreq, $start, $end); // TODO BUDGET getBudgetLimitRepetitions
            $budget->otherRepetitions = new Collection(
            );//$repository->getValidRepetitions($budget, $start, $end, $budget->currentRep); // TODO BUDGET getBudgetLimitRepetitions
            if (!is_null($budget->currentRep->id)) {
                $budgeted = bcadd($budgeted, $budget->currentRep->amount);
            }
            $spent = bcadd($spent, $budget->spent);

        }


        $budgetMaximum   = Preferences::get('budgetMaximum', 1000)->data;
        $defaultCurrency = Amount::getDefaultCurrency();

        return view(
            'budgets.index', compact(
                               'budgetMaximum', 'periodStart', 'periodEnd',
                               'period', 'range', 'budgetIncomeTotal',
                               'defaultCurrency', 'inactive', 'budgets',
                               'spent', 'budgeted'
                           )
        );
    }

    /**
     * @param BudgetRepositoryInterface $repository
     *
     * @return \Illuminate\View\View
     */
    public function noBudget(BudgetRepositoryInterface $repository)
    {
        /** @var Carbon $start */
        $start = session('start', Carbon::now()->startOfMonth());
        /** @var Carbon $end */
        $end = session('end', Carbon::now()->endOfMonth());

        $page     = intval(Input::get('page')) == 0 ? 1 : intval(Input::get('page'));
        $pageSize = Preferences::get('transactionPageSize', 50)->data;
        $list     = new LengthAwarePaginator([], 0, $pageSize); // $repository->getWithoutBudget($start, $end, $page, $pageSize); // TODO BUDGET journalsInPeriodWithoutBudget
        $subTitle = trans(
            'firefly.without_budget_between',
            ['start' => $start->formatLocalized($this->monthAndDayFormat), 'end' => $end->formatLocalized($this->monthAndDayFormat)]
        );
        $list->setPath('/budgets/list/noBudget');

        return view('budgets.noBudget', compact('list', 'subTitle'));
    }

    /**
     * @return \Illuminate\Http\RedirectResponse
     */
    public function postUpdateIncome()
    {
        $range = Preferences::get('viewRange', '1M')->data;
        /** @var Carbon $date */
        $date  = session('start', new Carbon);
        $start = Navigation::startOfPeriod($date, $range);
        $end   = Navigation::endOfPeriod($start, $range);
        $key   = 'budgetIncomeTotal' . $start->format('Ymd') . $end->format('Ymd');

        Preferences::set($key, intval(Input::get('amount')));
        Preferences::mark();

        return redirect(route('budgets.index'));
    }

    /**
     * @param BudgetRepositoryInterface $repository
     * @param Budget                    $budget
     *
     * @return View
     * @throws FireflyException
     */
    public function show(BudgetRepositoryInterface $repository, Budget $budget)
    {
        $pageSize = Preferences::get('transactionPageSize', 50)->data;
        $journals = new LengthAwarePaginator(
            [], 0, $pageSize
        ); //$repository->getJournals($budget, new LimitRepetition, $pageSize); // TODO BUDGET journalsInPeriod
        $start    = new Carbon; //$repository->firstActivity($budget); // TODO BUDGET getOldestJournal
        $end      = new Carbon;
        $set      = $budget->limitrepetitions()->orderBy('startdate', 'DESC')->get();
        $subTitle = e($budget->name);
        $journals->setPath('/budgets/show/' . $budget->id);
        $spentArray = []; //$repository->spentPerDay($budget, $start, $end, new Collection); // TODO BUDGET spentInPeriod
        $limits     = new Collection();

        /** @var LimitRepetition $entry */
        foreach ($set as $entry) {
            $entry->spent = $this->getSumOfRange($entry->startdate, $entry->enddate, $spentArray);
            $limits->push($entry);
        }


        return view('budgets.show', compact('limits', 'budget', 'repetition', 'journals', 'subTitle'));
    }

    /**
     * @param BudgetRepositoryInterface $repository
     * @param Budget                    $budget
     * @param LimitRepetition           $repetition
     *
     * @return View
     * @throws FireflyException
     */
    public function showWithRepetition(BudgetRepositoryInterface $repository, Budget $budget, LimitRepetition $repetition)
    {
        if ($repetition->budgetLimit->budget->id != $budget->id) {
            throw new FireflyException('This budget limit is not part of this budget.');
        }

        $pageSize = Preferences::get('transactionPageSize', 50)->data;
        $journals = new LengthAwarePaginator([], 0, $pageSize); // $repository->getJournals($budget, $repetition, $pageSize); // TODO BUDGET journalsInPeriod
        $start    = $repetition->startdate;
        $end      = $repetition->enddate;
        $set      = new Collection([$repetition]);
        $subTitle = trans('firefly.budget_in_month', ['name' => $budget->name, 'month' => $repetition->startdate->formatLocalized($this->monthFormat)]);
        $journals->setPath('/budgets/show/' . $budget->id . '/' . $repetition->id);
        $spentArray = []; //$repository->spentPerDay($budget, $start, $end, new Collection); // TODO BUDGET spentInPeriod
        $limits     = new Collection();

        /** @var LimitRepetition $entry */
        foreach ($set as $entry) {
            $entry->spent = $this->getSumOfRange($entry->startdate, $entry->enddate, $spentArray);
            $limits->push($entry);
        }


        return view('budgets.show', compact('limits', 'budget', 'repetition', 'journals', 'subTitle'));

    }

    /**
     * @param BudgetFormRequest         $request
     * @param BudgetRepositoryInterface $repository
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function store(BudgetFormRequest $request, BudgetRepositoryInterface $repository)
    {
        $budgetData = [
            'name' => $request->input('name'),
            'user' => Auth::user()->id,
        ];
        $budget     = $repository->store($budgetData);

        Session::flash('success', strval(trans('firefly.stored_new_budget', ['name' => e($budget->name)])));
        Preferences::mark();

        if (intval(Input::get('create_another')) === 1) {
            // set value so create routine will not overwrite URL:
            Session::put('budgets.create.fromStore', true);

            return redirect(route('budgets.create'))->withInput();
        }

        // redirect to previous URL.
        return redirect(session('budgets.create.url'));

    }

    /**
     * @param BudgetFormRequest         $request
     * @param BudgetRepositoryInterface $repository
     * @param Budget                    $budget
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function update(BudgetFormRequest $request, BudgetRepositoryInterface $repository, Budget $budget)
    {
        $budgetData = [
            'name'   => $request->input('name'),
            'active' => intval($request->input('active')) == 1,
        ];

        $repository->update($budget, $budgetData);

        Session::flash('success', strval(trans('firefly.updated_budget', ['name' => e($budget->name)])));
        Preferences::mark();

        if (intval(Input::get('return_to_edit')) === 1) {
            // set value so edit routine will not overwrite URL:
            Session::put('budgets.edit.fromUpdate', true);

            return redirect(route('budgets.edit', [$budget->id]))->withInput(['return_to_edit' => 1]);
        }

        // redirect to previous URL.
        return redirect(session('budgets.edit.url'));

    }

    /**
     * @return \Illuminate\View\View
     */
    public function updateIncome()
    {
        $range  = Preferences::get('viewRange', '1M')->data;
        $format = strval(trans('config.month_and_day'));

        /** @var Carbon $date */
        $date         = session('start', new Carbon);
        $start        = Navigation::startOfPeriod($date, $range);
        $end          = Navigation::endOfPeriod($start, $range);
        $key          = 'budgetIncomeTotal' . $start->format('Ymd') . $end->format('Ymd');
        $amount       = Preferences::get($key, 1000);
        $displayStart = $start->formatLocalized($format);
        $displayEnd   = $end->formatLocalized($format);

        return view('budgets.income', compact('amount', 'displayStart', 'displayEnd'));
    }

}