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

<?php namespace FireflyIII\Http\Controllers;

use Amount;
use App;
use Auth;
use Carbon\Carbon;
use Crypt;
use DB;
use Exception;
use FireflyIII\Helpers\Report\ReportQueryInterface;
use FireflyIII\Models\Account;
use FireflyIII\Models\Bill;
use FireflyIII\Models\Budget;
use FireflyIII\Models\Category;
use FireflyIII\Models\LimitRepetition;
use FireflyIII\Models\PiggyBank;
use FireflyIII\Models\Preference;
use FireflyIII\Models\Transaction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Repositories\Bill\BillRepositoryInterface;
use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
use Grumpydictator\Gchart\GChart;
use Illuminate\Support\Collection;
use Navigation;
use Preferences;
use Response;
use Session;
use Steam;

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


    /**
     * @param Account $account
     * @param string  $view
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function accountBalanceChart(Account $account, GChart $chart)
    {
        $chart->addColumn('Day of month', 'date');
        $chart->addColumn('Balance for ' . $account->name, 'number');
        $chart->addCertainty(1);

        $start   = Session::get('start', Carbon::now()->startOfMonth());
        $end     = Session::get('end', Carbon::now()->endOfMonth());
        $current = clone $start;
        $today   = new Carbon;

        while ($end >= $current) {
            $certain = $current < $today;
            $chart->addRow(clone $current, Steam::balance($account, $current), $certain);
            $current->addDay();
        }


        $chart->generate();

        return Response::json($chart->getData());
    }

    /**
     * @param GChart $chart
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function allAccountsBalanceChart(GChart $chart, AccountRepositoryInterface $repository)
    {
        $chart->addColumn('Day of the month', 'date');

        $frontPage = Preferences::get('frontPageAccounts', []);
        $start     = Session::get('start', Carbon::now()->startOfMonth());
        $end       = Session::get('end', Carbon::now()->endOfMonth());
        $accounts  = $repository->getFrontpageAccounts($frontPage);

        $index = 1;
        /** @var Account $account */
        foreach ($accounts as $account) {
            $accountName = $account->name;
            $chart->addColumn('Balance for ' . $accountName, 'number');
            $chart->addCertainty($index);
            $index++;
        }
        $current = clone $start;
        $current->subDay();
        $today = Carbon::now();
        while ($end >= $current) {
            $row     = [clone $current];
            $certain = $current < $today;
            foreach ($accounts as $account) {
                $row[] = Steam::balance($account, $current);
                $row[] = $certain;
            }
            $chart->addRowArray($row);
            $current->addDay();
        }
        $chart->generate();

        return Response::json($chart->getData());

    }

    /**
     * @param int $year
     *
     * @return $this|\Illuminate\Http\JsonResponse
     */
    public function allBudgetsAndSpending($year, GChart $chart, BudgetRepositoryInterface $repository)
    {
        $budgets = $repository->getBudgets();
        $chart->addColumn('Month', 'date');
        foreach ($budgets as $budget) {
            $chart->addColumn($budget->name, 'number');
        }

        $start = Carbon::createFromDate(intval($year), 1, 1);
        $end   = clone $start;
        $end->endOfYear();

        while ($start <= $end) {
            $row = [clone $start];
            foreach ($budgets as $budget) {
                $spent = $repository->spentInMonth($budget, $start);
                $row[] = $spent;
            }
            $chart->addRowArray($row);
            $start->addMonth();
        }

        $chart->generate();

        return Response::json($chart->getData());

    }

    /**
     * @param GChart $chart
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function allBudgetsHomeChart(GChart $chart, BudgetRepositoryInterface $repository)
    {
        $chart->addColumn('Budget', 'string');
        $chart->addColumn('Budgeted', 'number');
        $chart->addColumn('Spent', 'number');

        $budgets    = $repository->getBudgets();
        $start      = Session::get('start', Carbon::now()->startOfMonth());
        $end        = Session::get('end', Carbon::now()->endOfMonth());
        $allEntries = new Collection;

        foreach ($budgets as $budget) {
            $repetitions = $repository->getBudgetLimitRepetitions($budget, $start, $end);
            if ($repetitions->count() == 0) {
                $expenses = $repository->sumBudgetExpensesInPeriod($budget, $start, $end);
                $allEntries->push([$budget->name, 0, $expenses]);
                continue;
            }
            /** @var LimitRepetition $repetition */
            foreach ($repetitions as $repetition) {
                $expenses = $repository->sumBudgetExpensesInPeriod($budget, $repetition->startdate, $repetition->enddate);
                $allEntries->push([$budget->name . ' (' . $repetition->startdate->format('j M Y') . ')', floatval($repetition->amount), $expenses]);
            }
        }

        $noBudgetExpenses = $repository->getWithoutBudgetSum($start, $end);
        $allEntries->push(['(no budget)', 0, $noBudgetExpenses]);

        foreach ($allEntries as $entry) {
            if ($entry[2] > 0) {
                $chart->addRow($entry[0], $entry[1], $entry[2]);
            }
        }

        $chart->generate();

        return Response::json($chart->getData());

    }

    /**
     * @param GChart $chart
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function allCategoriesHomeChart(GChart $chart, CategoryRepositoryInterface $repository)
    {
        $chart->addColumn('Category', 'string');
        $chart->addColumn('Spent', 'number');

        $start = Session::get('start', Carbon::now()->startOfMonth());
        $end   = Session::get('end', Carbon::now()->endOfMonth());
        $set   = $repository->getCategoriesAndExpenses($start, $end);

        foreach ($set as $entry) {
            $isEncrypted = intval($entry->encrypted) == 1 ? true : false;
            $name        = strlen($entry->name) == 0 ? '(no category)' : $entry->name;
            $name        = $isEncrypted ? Crypt::decrypt($name) : $name;
            $chart->addRow($name, floatval($entry->sum));
        }

        $chart->generate();

        return Response::json($chart->getData());

    }

    /**
     * @param Bill   $bill
     * @param GChart $chart
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function billOverview(Bill $bill, GChart $chart, BillRepositoryInterface $repository)
    {

        $chart->addColumn('Date', 'date');
        $chart->addColumn('Max amount', 'number');
        $chart->addColumn('Min amount', 'number');
        $chart->addColumn('Recorded bill entry', 'number');

        // get first transaction or today for start:
        $results = $repository->getJournals($bill);
        /** @var TransactionJournal $result */
        foreach ($results as $result) {
            $chart->addRow(clone $result->date, floatval($bill->amount_max), floatval($bill->amount_min), floatval($result->amount));
        }

        $chart->generate();

        return Response::json($chart->getData());

    }

    /**
     * @param GChart $chart
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function billsOverview(GChart $chart, BillRepositoryInterface $repository)
    {
        $chart->addColumn('Name', 'string');
        $chart->addColumn('Amount', 'number');


        $paid   = ['items' => [], 'amount' => 0];
        $unpaid = ['items' => [], 'amount' => 0];
        $start  = Session::get('start', Carbon::now()->startOfMonth());
        $end    = Session::get('end', Carbon::now()->endOfMonth());

        $bills = $repository->getActiveBills();

        /** @var Bill $bill */
        foreach ($bills as $bill) {
            $ranges = $repository->getRanges($bill, $start, $end);

            foreach ($ranges as $range) {
                // paid a bill in this range?
                $count = $bill->transactionjournals()->before($range['end'])->after($range['start'])->count();
                if ($count == 0) {
                    $unpaid['items'][] = $bill->name . ' (' . $range['start']->format('jS M Y') . ')';
                    $unpaid['amount'] += ($bill->amount_max + $bill->amount_min / 2);

                } else {
                    $journal         = $bill->transactionjournals()->with('transactions')->before($range['end'])->after($range['start'])->first();
                    $paid['items'][] = $journal->description;
                    $amount          = 0;
                    foreach ($journal->transactions as $t) {
                        if (floatval($t->amount) > 0) {
                            $amount = floatval($t->amount);
                        }
                    }
                    $paid['amount'] += $amount;
                }

            }
        }

        /**
         * Find credit card accounts and possibly unpaid credit card bills.
         */
        $creditCards = Auth::user()->accounts()
                           ->hasMetaValue('accountRole', 'ccAsset')
                           ->hasMetaValue('ccType', 'monthlyFull')
                           ->get(
                               [
                                   'accounts.*',
                                   'ccType.data as ccType',
                                   'accountRole.data as accountRole'
                               ]
                           );
        // if the balance is not zero, the monthly payment is still underway.
        /** @var Account $creditCard */
        foreach ($creditCards as $creditCard) {
            $balance = Steam::balance($creditCard, null, true);
            $date    = new Carbon($creditCard->getMeta('ccMonthlyPaymentDate'));
            if ($balance < 0) {
                // unpaid!
                $unpaid['amount'] += $balance * -1;
                $unpaid['items'][] = $creditCard->name . ' (expected ' . Amount::format(($balance * -1), false) . ') on the ' . $date->format('jS') . ')';
            }
            if ($balance == 0) {
                // find a transfer TO the credit card which should account for
                // anything paid. If not, the CC is not yet used.
                $transactions = $creditCard->transactions()
                                           ->leftJoin('transaction_journals', 'transaction_journals.id', '=', 'transactions.transaction_journal_id')
                                           ->before($end)->after($start)->get();
                if ($transactions->count() > 0) {
                    /** @var Transaction $transaction */
                    foreach ($transactions as $transaction) {
                        $journal = $transaction->transactionJournal;
                        if ($journal->transactionType->type == 'Transfer') {
                            $paid['amount'] += floatval($transaction->amount);
                            $paid['items'][] = $creditCard->name .
                                               ' (paid ' . Amount::format((floatval($transaction->amount)), false) .
                                               ' on the ' . $journal->date->format('jS') . ')';
                        }
                    }
                }
            }
        }
        $chart->addRow('Unpaid: ' . join(', ', $unpaid['items']), $unpaid['amount']);
        $chart->addRow('Paid: ' . join(', ', $paid['items']), $paid['amount']);
        $chart->generate();

        return Response::json($chart->getData());
    }

    /**
     *
     * @param Budget          $budget
     * @param LimitRepetition $repetition
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function budgetLimitSpending(Budget $budget, LimitRepetition $repetition, GChart $chart)
    {
        $start = clone $repetition->startdate;
        $end   = $repetition->enddate;

        $chart->addColumn('Day', 'date');
        $chart->addColumn('Left', 'number');


        $amount = $repetition->amount;

        while ($start <= $end) {
            /*
             * Sum of expenses on this day:
             */
            $sum = floatval($budget->transactionjournals()->lessThan(0)->transactionTypes(['Withdrawal'])->onDate($start)->sum('amount'));
            $amount += $sum;
            $chart->addRow(clone $start, $amount);
            $start->addDay();
        }
        $chart->generate();

        return Response::json($chart->getData());

    }

    /**
     *
     * @param Budget $budget
     *
     * @param int    $year
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function budgetsAndSpending(Budget $budget, $year = 0)
    {

        $chart      = App::make('Grumpydictator\Gchart\GChart');
        $repository = App::make('FireflyIII\Repositories\Budget\BudgetRepository');
        $chart->addColumn('Month', 'date');
        $chart->addColumn('Budgeted', 'number');
        $chart->addColumn('Spent', 'number');
        if ($year == 0) {
            // grab the first budgetlimit ever:
            $firstLimit = $budget->budgetlimits()->orderBy('startdate', 'ASC')->first();
            if ($firstLimit) {
                $start = new Carbon($firstLimit->startdate);
            } else {
                $start = Carbon::now()->startOfYear();
            }

            // grab the last budget limit ever:
            $lastLimit = $budget->budgetlimits()->orderBy('startdate', 'DESC')->first();
            if ($lastLimit) {
                $end = new Carbon($lastLimit->startdate);
            } else {
                $end = Carbon::now()->endOfYear();
            }
        } else {
            $start = Carbon::createFromDate(intval($year), 1, 1);
            $end   = clone $start;
            $end->endOfYear();
        }

        while ($start <= $end) {
            $spent      = $repository->spentInMonth($budget, $start);
            $repetition = LimitRepetition::leftJoin('budget_limits', 'limit_repetitions.budget_limit_id', '=', 'budget_limits.id')
                                         ->where('limit_repetitions.startdate', $start->format('Y-m-d 00:00:00'))
                                         ->where('budget_limits.budget_id', $budget->id)
                                         ->first(['limit_repetitions.*']);

            if ($repetition) {
                $budgeted = floatval($repetition->amount);
                \Log::debug('Found a repetition on ' . $start->format('Y-m-d') . ' for budget ' . $budget->name . '!');
            } else {
                \Log::debug('No repetition on ' . $start->format('Y-m-d') . ' for budget ' . $budget->name);
                $budgeted = null;
            }
            $chart->addRow(clone $start, $budgeted, $spent);
            $start->addMonth();
        }

        $chart->generate();

        return Response::json($chart->getData());


    }

    /**
     *
     * @param Category $category
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function categoryOverviewChart(Category $category, GChart $chart)
    {
        // oldest transaction in category:
        /** @var TransactionJournal $first */
        $first = $category->transactionjournals()->orderBy('date', 'ASC')->first();
        $start = $first->date;
        /** @var Preference $range */
        $range = Preferences::get('viewRange', '1M');
        // jump to start of week / month / year / etc (TODO).
        $start = Navigation::startOfPeriod($start, $range->data);

        $chart->addColumn('Period', 'date');
        $chart->addColumn('Spent', 'number');

        $end = new Carbon;
        while ($start <= $end) {

            $currentEnd = Navigation::endOfPeriod($start, $range->data);
            $spent      = floatval($category->transactionjournals()->before($currentEnd)->after($start)->lessThan(0)->sum('amount')) * -1;
            $chart->addRow(clone $start, $spent);

            $start = Navigation::addPeriod($start, $range->data, 0);
        }


        $chart->generate();

        return Response::json($chart->getData());


    }

    /**
     *
     * @param Category $category
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function categoryPeriodChart(Category $category, GChart $chart)
    {
        // oldest transaction in category:
        /** @var TransactionJournal $first */
        $start = clone Session::get('start');
        $chart->addColumn('Period', 'date');
        $chart->addColumn('Spent', 'number');

        $end = Session::get('end');
        while ($start <= $end) {
            $spent = floatval($category->transactionjournals()->onDate($start)->lessThan(0)->sum('amount')) * -1;
            $chart->addRow(clone $start, $spent);
            $start->addDay();
        }

        $chart->generate();

        return Response::json($chart->getData());


    }


    /**
     * @param PiggyBank $piggyBank
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function piggyBankHistory(PiggyBank $piggyBank, GChart $chart)
    {
        $chart->addColumn('Date', 'date');
        $chart->addColumn('Balance', 'number');

        /** @var Collection $set */
        $set = DB::table('piggy_bank_events')->where('piggy_bank_id', $piggyBank->id)->groupBy('date')->get(['date', DB::Raw('SUM(`amount`) AS `sum`')]);
        $sum = 0;

        foreach ($set as $entry) {
            $sum += floatval($entry->sum);
            $chart->addRow(new Carbon($entry->date), $sum);
        }

        $chart->generate();

        return Response::json($chart->getData());

    }

    /**
     *
     * @param $year
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function yearInExp($year, GChart $chart, ReportQueryInterface $query)
    {
        try {
            $start = new Carbon('01-01-' . $year);
        } catch (Exception $e) {
            return view('error')->with('message', 'Invalid year.');
        }
        $chart->addColumn('Month', 'date');
        $chart->addColumn('Income', 'number');
        $chart->addColumn('Expenses', 'number');

        $pref              = Preferences::get('showSharedReports', false);
        $showSharedReports = $pref->data;

        // get report query interface.

        $end = clone $start;
        $end->endOfYear();
        while ($start < $end) {
            $currentEnd = clone $start;
            $currentEnd->endOfMonth();
            // total income:
            $income    = $query->incomeByPeriod($start, $currentEnd, $showSharedReports);
            $incomeSum = 0;
            foreach ($income as $entry) {
                $incomeSum += floatval($entry->amount);
            }

            // total expenses:
            $expense    = $query->journalsByExpenseAccount($start, $currentEnd, $showSharedReports);
            $expenseSum = 0;
            foreach ($expense as $entry) {
                $expenseSum += floatval($entry->amount);
            }

            $chart->addRow(clone $start, $incomeSum, $expenseSum);
            $start->addMonth();
        }


        $chart->generate();

        return Response::json($chart->getData());

    }

    /**
     *
     * @param $year
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function yearInExpSum($year, GChart $chart, ReportQueryInterface $query)
    {
        try {
            $start = new Carbon('01-01-' . $year);
        } catch (Exception $e) {
            return view('error')->with('message', 'Invalid year.');
        }
        $chart->addColumn('Summary', 'string');
        $chart->addColumn('Income', 'number');
        $chart->addColumn('Expenses', 'number');

        $pref              = Preferences::get('showSharedReports', false);
        $showSharedReports = $pref->data;

        $income  = 0;
        $expense = 0;
        $count   = 0;

        $end = clone $start;
        $end->endOfYear();
        while ($start < $end) {
            $currentEnd = clone $start;
            $currentEnd->endOfMonth();
            // total income:
            $incomeResult = $query->incomeByPeriod($start, $currentEnd, $showSharedReports);
            $incomeSum    = 0;
            foreach ($incomeResult as $entry) {
                $incomeSum += floatval($entry->amount);
            }

            // total expenses:
            $expenseResult = $query->journalsByExpenseAccount($start, $currentEnd, $showSharedReports);
            $expenseSum    = 0;
            foreach ($expenseResult as $entry) {
                $expenseSum += floatval($entry->amount);
            }

            $income += $incomeSum;
            $expense += $expenseSum;
            $count++;
            $start->addMonth();
        }


        $chart->addRow('Sum', $income, $expense);
        $count = $count > 0 ? $count : 1;
        $chart->addRow('Average', ($income / $count), ($expense / $count));

        $chart->generate();

        return Response::json($chart->getData());

    }


}