firefly-iii/app/Http/Controllers/Transaction/BulkController.php

<?php
/**
 * BulkController.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\Transaction;


use ExpandedForm;
use FireflyIII\Http\Controllers\Controller;
use FireflyIII\Http\Requests\BulkEditJournalRequest;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Models\TransactionType;
use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
use FireflyIII\Repositories\Journal\JournalRepositoryInterface;
use Illuminate\Http\Request;
use Illuminate\Support\Collection;
use Log;
use Preferences;
use View;

/**
 * Class BulkController
 */
class BulkController extends Controller
{


    /**
     *
     */
    public function __construct()
    {
        parent::__construct();

        $this->middleware(
            function ($request, $next) {
                app('view')->share('title', trans('firefly.transactions'));
                app('view')->share('mainTitleIcon', 'fa-repeat');

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

    /**
     * @param Collection $journals
     *
     * @return View
     */
    public function edit(Request $request, Collection $journals)
    {

        $subTitle = trans('firefly.mass_bulk_journals');

        // skip transactions that have multiple destinations, multiple sources or are an opening balance.
        $filtered = new Collection;
        $messages = [];
        /** @var TransactionJournal $journal */
        foreach ($journals as $journal) {
            $sources      = $journal->sourceAccountList();
            $destinations = $journal->destinationAccountList();
            if ($sources->count() > 1) {
                $messages[] = trans('firefly.cannot_edit_multiple_source', ['description' => $journal->description, 'id' => $journal->id]);
                continue;
            }

            if ($destinations->count() > 1) {
                $messages[] = trans('firefly.cannot_edit_multiple_dest', ['description' => $journal->description, 'id' => $journal->id]);
                continue;
            }
            if (TransactionType::OPENING_BALANCE === $journal->transactionType->type) {
                $messages[] = trans('firefly.cannot_edit_opening_balance');
                continue;
            }

            // cannot edit reconciled transactions / journals:
            if ($journal->transactions->first()->reconciled) {
                $messages[] = trans('firefly.cannot_edit_reconciled', ['description' => $journal->description, 'id' => $journal->id]);
                continue;
            }

            $filtered->push($journal);
        }

        if (count($messages) > 0) {
            $request->session()->flash('info', $messages);
        }

        // put previous url in session
        $this->rememberPreviousUri('transactions.bulk-edit.uri');

        // get list of budgets:
        /** @var BudgetRepositoryInterface $repository */
        $repository = app(BudgetRepositoryInterface::class);
        $budgetList = ExpandedForm::makeSelectListWithEmpty($repository->getActiveBudgets());
        // collect some useful meta data for the mass edit:
        $filtered->each(
            function (TransactionJournal $journal) {
                $journal->transaction_count = $journal->transactions()->count();
            }
        );

        if (0 === $filtered->count()) {
            $request->session()->flash('error', trans('firefly.no_edit_multiple_left'));
        }

        $journals = $filtered;

        return view('transactions.bulk.edit', compact('journals', 'subTitle', 'budgetList'));
    }


    /**
     * @param BulkEditJournalRequest     $request
     * @param JournalRepositoryInterface $repository
     *
     * @return mixed
     */
    public function update(BulkEditJournalRequest $request, JournalRepositoryInterface $repository)
    {
        $journalIds     = $request->get('journals');
        $ignoreCategory = intval($request->get('ignore_category')) === 1;
        $ignoreBudget   = intval($request->get('ignore_budget')) === 1;
        $ignoreTags     = intval($request->get('ignore_tags')) === 1;
        $count          = 0;
        if (is_array($journalIds)) {
            foreach ($journalIds as $journalId) {
                $journal = $repository->find(intval($journalId));
                if (!is_null($journal)) {
                    $count++;
                    Log::debug(sprintf('Found journal #%d', $journal->id));
                    // update category if not told to ignore
                    if ($ignoreCategory === false) {
                        Log::debug(sprintf('Set category to %s', $request->string('category')));
                        $repository->updateCategory($journal, $request->string('category'));
                    }
                    // update budget if not told to ignore (and is withdrawal)
                    if ($ignoreBudget === false) {
                        Log::debug(sprintf('Set budget to %d', $request->integer('budget_id')));
                        $repository->updateBudget($journal, $request->integer('budget_id'));
                    }
                    if ($ignoreTags === false) {
                        Log::debug(sprintf('Set tags to %s', $request->string('budget_id')));
                        $repository->updateTags($journal, explode(',', $request->string('tags')));
                    }
                    // update tags if not told to ignore (and is withdrawal)
                }
            }
        }

        Preferences::mark();
        $request->session()->flash('success', trans('firefly.mass_edited_transactions_success', ['amount' => $count]));

        // redirect to previous URL:
        return redirect($this->getPreviousUri('transactions.bulk-edit.uri'));
    }

}