Skip to content

Firefly III: a personal finances manager

5.2 KB
Raw Blame
<?php

/*
 * UpdateController.php
 * Copyright (c) 2021 [email protected]
 *
 * This file is part of Firefly III (https://github.com/firefly-iii).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace FireflyIII\Api\V1\Controllers\Models\Transaction;

use FireflyIII\Api\V1\Controllers\Controller;
use FireflyIII\Api\V1\Requests\Models\Transaction\UpdateRequest;
use FireflyIII\Events\Model\TransactionGroup\TransactionGroupEventFlags;
use FireflyIII\Events\Model\TransactionGroup\TransactionGroupEventObjects;
use FireflyIII\Events\Model\TransactionGroup\UpdatedSingleTransactionGroup;
use FireflyIII\Events\Model\Webhook\WebhookMessagesRequestSending;
use FireflyIII\Helpers\Collector\GroupCollectorInterface;
use FireflyIII\Models\TransactionGroup;
use FireflyIII\Repositories\TransactionGroup\TransactionGroupRepositoryInterface;
use FireflyIII\Support\Facades\Preferences;
use FireflyIII\Support\JsonApi\Enrichments\TransactionGroupEnrichment;
use FireflyIII\Transformers\TransactionGroupTransformer;
use FireflyIII\User;
use Illuminate\Http\JsonResponse;
use Illuminate\Support\Facades\Log;
use League\Fractal\Resource\Item;
use Override;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

/**
 * Class UpdateController
 */
final class UpdateController extends Controller
{
    #[Override]
    protected array $acceptedRoles = [];
    private TransactionGroupRepositoryInterface $groupRepository;

    /**
     * TransactionController constructor.
     */
    public function __construct()
    {
        parent::__construct();
        $this->middleware(function ($request, $next) {
            /** @var User $admin */
            $admin                 = auth()->user();

            $this->groupRepository = app(TransactionGroupRepositoryInterface::class);
            $this->groupRepository->setUser($admin);

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

    /**
     * This endpoint is documented at:
     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/transactions/updateTransaction
     *
     * Update a transaction.
     */
    public function update(UpdateRequest $request, TransactionGroup $transactionGroup): JsonResponse
    {
        $data                     = $request->getAll();
        Log::debug('Now in update routine for transaction group', $data);
        $oldHash                  = $this->groupRepository->getCompareHash($transactionGroup);
        $objects                  = TransactionGroupEventObjects::collectFromTransactionGroup($transactionGroup);
        $transactionGroup         = $this->groupRepository->update($transactionGroup, $data);
        $objects->appendFromTransactionGroup($transactionGroup);
        $newHash                  = $this->groupRepository->getCompareHash($transactionGroup);
        $manager                  = $this->getManager();

        Preferences::mark();
        $applyRules               = $data['apply_rules'] ?? true;
        $fireWebhooks             = $data['fire_webhooks'] ?? true;
        $runRecalculations        = $oldHash !== $newHash;

        $flags                    = new TransactionGroupEventFlags();
        $flags->applyRules        = $applyRules;
        $flags->fireWebhooks      = $fireWebhooks;
        $flags->recalculateCredit = $runRecalculations;
        $flags->batchSubmission   = $data['batch_submission'] ?? false;
        event(new UpdatedSingleTransactionGroup($flags, $objects));
        event(new WebhookMessagesRequestSending());

        /** @var User $admin */
        $admin                    = auth()->user();

        // use new group collector:
        /** @var GroupCollectorInterface $collector */
        $collector                = app(GroupCollectorInterface::class);
        $collector
            ->setUser($admin)
            // filter on transaction group.
            ->setTransactionGroup($transactionGroup)
            // all info needed for the API:
            ->withAPIInformation()
        ;

        $selectedGroup            = $collector->getGroups()->first();
        if (null === $selectedGroup) {
            throw new NotFoundHttpException();
        }

        // enrich
        $enrichment               = new TransactionGroupEnrichment();
        $enrichment->setUser($admin);
        $selectedGroup            = $enrichment->enrichSingle($selectedGroup);

        /** @var TransactionGroupTransformer $transformer */
        $transformer              = app(TransactionGroupTransformer::class);
        $resource                 = new Item($selectedGroup, $transformer, 'transactions');

        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
    }
}