mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-08-27 20:51:57 +00:00
86 lines
2.2 KiB
PHP
86 lines
2.2 KiB
PHP
<?php
|
|
|
|
namespace BookStack\Actions;
|
|
|
|
use BookStack\Interfaces\Loggable;
|
|
use Carbon\Carbon;
|
|
use Illuminate\Database\Eloquent\Collection;
|
|
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
|
|
|
/**
|
|
* @property int $id
|
|
* @property string $name
|
|
* @property string $endpoint
|
|
* @property Collection $trackedEvents
|
|
* @property bool $active
|
|
* @property int $timeout
|
|
* @property string $last_error
|
|
* @property Carbon $last_called_at
|
|
* @property Carbon $last_errored_at
|
|
*/
|
|
class Webhook extends Model implements Loggable
|
|
{
|
|
use HasFactory;
|
|
|
|
protected $fillable = ['name', 'endpoint', 'timeout'];
|
|
|
|
protected $casts = [
|
|
'last_called_at' => 'datetime',
|
|
'last_errored_at' => 'datetime',
|
|
];
|
|
|
|
/**
|
|
* Define the tracked event relation a webhook.
|
|
*/
|
|
public function trackedEvents(): HasMany
|
|
{
|
|
return $this->hasMany(WebhookTrackedEvent::class);
|
|
}
|
|
|
|
/**
|
|
* Update the tracked events for a webhook from the given list of event types.
|
|
*/
|
|
public function updateTrackedEvents(array $events): void
|
|
{
|
|
$this->trackedEvents()->delete();
|
|
|
|
$eventsToStore = array_intersect($events, array_values(ActivityType::all()));
|
|
if (in_array('all', $events)) {
|
|
$eventsToStore = ['all'];
|
|
}
|
|
|
|
$trackedEvents = [];
|
|
foreach ($eventsToStore as $event) {
|
|
$trackedEvents[] = new WebhookTrackedEvent(['event' => $event]);
|
|
}
|
|
|
|
$this->trackedEvents()->saveMany($trackedEvents);
|
|
}
|
|
|
|
/**
|
|
* Check if this webhook tracks the given event.
|
|
*/
|
|
public function tracksEvent(string $event): bool
|
|
{
|
|
return $this->trackedEvents->pluck('event')->contains($event);
|
|
}
|
|
|
|
/**
|
|
* Get a URL for this webhook within the settings interface.
|
|
*/
|
|
public function getUrl(string $path = ''): string
|
|
{
|
|
return url('/settings/webhooks/' . $this->id . '/' . ltrim($path, '/'));
|
|
}
|
|
|
|
/**
|
|
* Get the string descriptor for this item.
|
|
*/
|
|
public function logDescriptor(): string
|
|
{
|
|
return "({$this->id}) {$this->name}";
|
|
}
|
|
}
|