firefly-iii/app/Models/WebhookMessage.php

<?php
/*
 * WebhookMessage.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\Models;

use Eloquent;
use FireflyIII\User;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Support\Carbon;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

/**
 * FireflyIII\Models\WebhookMessage
 *
 * @property int                              $id
 * @property Carbon|null                      $created_at
 * @property Carbon|null                      $updated_at
 * @property string|null                      $deleted_at
 * @property int                              $webhook_id
 * @property bool                             $sent
 * @property bool                             $errored
 * @property int                              $attempts
 * @property string                           $uuid
 * @property array                            $message
 * @property array|null                       $logs
 * @property-read Webhook                     $webhook
 * @method static Builder|WebhookMessage newModelQuery()
 * @method static Builder|WebhookMessage newQuery()
 * @method static Builder|WebhookMessage query()
 * @method static Builder|WebhookMessage whereAttempts($value)
 * @method static Builder|WebhookMessage whereCreatedAt($value)
 * @method static Builder|WebhookMessage whereDeletedAt($value)
 * @method static Builder|WebhookMessage whereErrored($value)
 * @method static Builder|WebhookMessage whereId($value)
 * @method static Builder|WebhookMessage whereLogs($value)
 * @method static Builder|WebhookMessage whereMessage($value)
 * @method static Builder|WebhookMessage whereSent($value)
 * @method static Builder|WebhookMessage whereUpdatedAt($value)
 * @method static Builder|WebhookMessage whereUuid($value)
 * @method static Builder|WebhookMessage whereWebhookId($value)
 * @mixin Eloquent
 * @property-read Collection|WebhookAttempt[] $webhookAttempts
 * @property-read int|null                    $webhook_attempts_count
 */
class WebhookMessage extends Model
{

    protected $casts
        = [
            'sent'    => 'boolean',
            'errored' => 'boolean',
            'uuid'    => 'string',
            'message' => 'json',
            'logs'    => 'json',
        ];

    /**
     * Route binder. Converts the key in the URL to the specified object (or throw 404).
     *
     * @param string $value
     *
     * @return WebhookMessage
     * @throws NotFoundHttpException
     */
    public static function routeBinder(string $value): WebhookMessage
    {
        if (auth()->check()) {
            $messageId = (int)$value;
            /** @var User $user */
            $user = auth()->user();
            /** @var WebhookMessage $message */
            $message = self::find($messageId);
            if (null !== $message && $message->webhook->user_id === $user->id) {
                return $message;
            }
        }
        throw new NotFoundHttpException;
    }

    /**
     * @codeCoverageIgnore
     * @return BelongsTo
     */
    public function webhook(): BelongsTo
    {
        return $this->belongsTo(Webhook::class);
    }

    /**
     * @codeCoverageIgnore
     * @return HasMany
     */
    public function webhookAttempts(): HasMany
    {
        return $this->hasMany(WebhookAttempt::class);
    }
}