mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-11-25 17:57:28 +08:00
c324ad928d
Included unit tests to cover validator functionality. Added to webhooks. Still need to do testing specifically for webhooks.
82 lines
2.6 KiB
PHP
82 lines
2.6 KiB
PHP
<?php
|
|
|
|
namespace BookStack\Activity;
|
|
|
|
use BookStack\Activity\Models\Loggable;
|
|
use BookStack\Activity\Models\Webhook;
|
|
use BookStack\Activity\Tools\WebhookFormatter;
|
|
use BookStack\Facades\Theme;
|
|
use BookStack\Theming\ThemeEvents;
|
|
use BookStack\Users\Models\User;
|
|
use BookStack\Util\SsrUrlValidator;
|
|
use Illuminate\Bus\Queueable;
|
|
use Illuminate\Contracts\Queue\ShouldQueue;
|
|
use Illuminate\Foundation\Bus\Dispatchable;
|
|
use Illuminate\Queue\InteractsWithQueue;
|
|
use Illuminate\Queue\SerializesModels;
|
|
use Illuminate\Support\Facades\Http;
|
|
use Illuminate\Support\Facades\Log;
|
|
|
|
class DispatchWebhookJob implements ShouldQueue
|
|
{
|
|
use Dispatchable;
|
|
use InteractsWithQueue;
|
|
use Queueable;
|
|
use SerializesModels;
|
|
|
|
protected Webhook $webhook;
|
|
protected User $initiator;
|
|
protected int $initiatedTime;
|
|
protected array $webhookData;
|
|
|
|
/**
|
|
* Create a new job instance.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function __construct(Webhook $webhook, string $event, Loggable|string $detail)
|
|
{
|
|
$this->webhook = $webhook;
|
|
$this->initiator = user();
|
|
$this->initiatedTime = time();
|
|
|
|
$themeResponse = Theme::dispatch(ThemeEvents::WEBHOOK_CALL_BEFORE, $event, $this->webhook, $detail, $this->initiator, $this->initiatedTime);
|
|
$this->webhookData = $themeResponse ?? WebhookFormatter::getDefault($event, $this->webhook, $detail, $this->initiator, $this->initiatedTime)->format();
|
|
}
|
|
|
|
/**
|
|
* Execute the job.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function handle()
|
|
{
|
|
$lastError = null;
|
|
|
|
try {
|
|
(new SsrUrlValidator())->ensureAllowed($this->webhook->endpoint);
|
|
|
|
$response = Http::asJson()
|
|
->withOptions(['allow_redirects' => ['strict' => true]])
|
|
->timeout($this->webhook->timeout)
|
|
->post($this->webhook->endpoint, $this->webhookData);
|
|
} catch (\Exception $exception) {
|
|
$lastError = $exception->getMessage();
|
|
Log::error("Webhook call to endpoint {$this->webhook->endpoint} failed with error \"{$lastError}\"");
|
|
}
|
|
|
|
if (isset($response) && $response->failed()) {
|
|
$lastError = "Response status from endpoint was {$response->status()}";
|
|
Log::error("Webhook call to endpoint {$this->webhook->endpoint} failed with status {$response->status()}");
|
|
}
|
|
|
|
$this->webhook->last_called_at = now();
|
|
if ($lastError) {
|
|
$this->webhook->last_errored_at = now();
|
|
$this->webhook->last_error = $lastError;
|
|
}
|
|
|
|
$this->webhook->save();
|
|
}
|
|
}
|