firefly-iii/app/Api/V1/Requests/Models/Webhook/UpdateRequest.php

<?php

/*
 * UpdateRequest.php
 * Copyright (c) 2021 james@firefly-iii.org
 *
 * 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\Requests\Models\Webhook;

use FireflyIII\Enums\WebhookResponse;
use FireflyIII\Enums\WebhookTrigger;
use FireflyIII\Models\Webhook;
use FireflyIII\Rules\IsBoolean;
use FireflyIII\Support\Request\ChecksLogin;
use FireflyIII\Support\Request\ConvertsDataTypes;
use Illuminate\Contracts\Validation\Validator;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Support\Facades\Log;

/**
 * Class UpdateRequest
 */
class UpdateRequest extends FormRequest
{
    use ChecksLogin;
    use ConvertsDataTypes;

    public function getData(): array
    {
        $triggers         = Webhook::getTriggersForValidation();
        $responses        = Webhook::getResponsesForValidation();
        $deliveries       = Webhook::getDeliveriesForValidation();

        $fields           = [
            'title'    => ['title', 'convertString'],
            'active'   => ['active', 'boolean'],
            'trigger'  => ['trigger', 'convertString'],
            'response' => ['response', 'convertString'],
            'delivery' => ['delivery', 'convertString'],
            'url'      => ['url', 'convertString'],
        ];

        // this is the way.
        $return           = $this->getAllData($fields);
        if (array_key_exists('trigger', $return)) {
            $return['trigger'] = $triggers[$return['trigger']] ?? 0;
        }
        if (array_key_exists('response', $return)) {
            $return['response'] = $responses[$return['response']] ?? 0;
        }
        if (array_key_exists('delivery', $return)) {
            $return['delivery'] = $deliveries[$return['delivery']] ?? 0;
        }
        $return['secret'] = null !== $this->get('secret');
        if (null !== $this->get('title')) {
            $return['title'] = $this->convertString('title');
        }

        return $return;
    }

    /**
     * Rules for this request.
     */
    public function rules(): array
    {
        $triggers       = implode(',', array_keys(Webhook::getTriggersForValidation()));
        $responses      = implode(',', array_keys(Webhook::getResponsesForValidation()));
        $deliveries     = implode(',', array_keys(Webhook::getDeliveriesForValidation()));
        $validProtocols = config('firefly.valid_url_protocols');

        /** @var Webhook $webhook */
        $webhook        = $this->route()->parameter('webhook');

        return [
            'title'    => sprintf('min:1|max:255|uniqueObjectForUser:webhooks,title,%d', $webhook->id),
            'active'   => [new IsBoolean()],
            'trigger'  => sprintf('in:%s', $triggers),
            'response' => sprintf('in:%s', $responses),
            'delivery' => sprintf('in:%s', $deliveries),
            'url'      => [sprintf('url:%s', $validProtocols), sprintf('uniqueExistingWebhook:%d', $webhook->id)],
        ];
    }

    public function withValidator(Validator $validator): void
    {
        $validator->after(
            function (Validator $validator): void {
                Log::debug('Validating webhook');
                $data      = $validator->getData();
                $trigger   = $data['trigger'] ?? null;
                $response  = $data['response'] ?? null;
                if (null === $trigger || null === $response) {
                    Log::debug('No trigger or response, return.');

                    return;
                }
                $triggers  = array_keys(Webhook::getTriggersForValidation());
                $responses = array_keys(Webhook::getResponsesForValidation());
                if (!in_array($trigger, $triggers, true) || !in_array($response, $responses, true)) {
                    return;
                }
                // cannot deliver budget info.
                if (is_int($trigger)) {
                    Log::debug(sprintf('Trigger was integer (%d).', $trigger));
                    $trigger = WebhookTrigger::from($trigger)->name;
                }
                if (is_int($response)) {
                    Log::debug(sprintf('Response was integer (%d).', $response));
                    $response = WebhookResponse::from($response)->name;
                }
                Log::debug(sprintf('Trigger is %s, response is %s', $trigger, $response));
                if (str_contains($trigger, 'TRANSACTION') && str_contains($response, 'BUDGET')) {
                    $validator->errors()->add('response', trans('validation.webhook_budget_info'));
                }
                if (str_contains($trigger, 'BUDGET') && str_contains($response, 'ACCOUNT')) {
                    $validator->errors()->add('response', trans('validation.webhook_account_info'));
                }
                if (str_contains($trigger, 'BUDGET') && str_contains($response, 'TRANSACTION')) {
                    $validator->errors()->add('response', trans('validation.webhook_transaction_info'));
                }
            }
        );
    }
}