2021-12-11 22:29:33 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace BookStack\Actions;
|
|
|
|
|
|
|
|
use BookStack\Auth\User;
|
|
|
|
use BookStack\Entities\Models\Entity;
|
|
|
|
use BookStack\Interfaces\Loggable;
|
|
|
|
use BookStack\Model;
|
|
|
|
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\Carbon;
|
2021-12-12 19:01:50 +00:00
|
|
|
use Illuminate\Support\Facades\Http;
|
2021-12-11 22:29:33 +00:00
|
|
|
use Illuminate\Support\Facades\Log;
|
|
|
|
|
|
|
|
class DispatchWebhookJob implements ShouldQueue
|
|
|
|
{
|
2021-12-18 11:43:05 +00:00
|
|
|
use Dispatchable;
|
|
|
|
use InteractsWithQueue;
|
|
|
|
use Queueable;
|
|
|
|
use SerializesModels;
|
2021-12-11 22:29:33 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @var Webhook
|
|
|
|
*/
|
|
|
|
protected $webhook;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
protected $event;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var string|Loggable
|
|
|
|
*/
|
|
|
|
protected $detail;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var User
|
|
|
|
*/
|
|
|
|
protected $initiator;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var int
|
|
|
|
*/
|
|
|
|
protected $initiatedTime;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Create a new job instance.
|
|
|
|
*
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
public function __construct(Webhook $webhook, string $event, $detail)
|
|
|
|
{
|
|
|
|
$this->webhook = $webhook;
|
|
|
|
$this->event = $event;
|
|
|
|
$this->detail = $detail;
|
|
|
|
$this->initiator = user();
|
|
|
|
$this->initiatedTime = time();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Execute the job.
|
|
|
|
*
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
public function handle()
|
|
|
|
{
|
2021-12-12 19:01:50 +00:00
|
|
|
$response = Http::asJson()
|
|
|
|
->withOptions(['allow_redirects' => ['strict' => true]])
|
|
|
|
->timeout(3)
|
|
|
|
->post($this->webhook->endpoint, $this->buildWebhookData());
|
2021-12-11 22:29:33 +00:00
|
|
|
|
2021-12-12 19:01:50 +00:00
|
|
|
if ($response->failed()) {
|
|
|
|
Log::error("Webhook call to endpoint {$this->webhook->endpoint} failed with status {$response->status()}");
|
2021-12-11 22:29:33 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
protected function buildWebhookData(): array
|
|
|
|
{
|
|
|
|
$textParts = [
|
|
|
|
$this->initiator->name,
|
|
|
|
trans('activities.' . $this->event),
|
|
|
|
];
|
|
|
|
|
|
|
|
if ($this->detail instanceof Entity) {
|
|
|
|
$textParts[] = '"' . $this->detail->name . '"';
|
|
|
|
}
|
|
|
|
|
2021-12-18 11:43:05 +00:00
|
|
|
$data = [
|
|
|
|
'event' => $this->event,
|
|
|
|
'text' => implode(' ', $textParts),
|
|
|
|
'triggered_at' => Carbon::createFromTimestampUTC($this->initiatedTime)->toISOString(),
|
|
|
|
'triggered_by' => $this->initiator->attributesToArray(),
|
2021-12-11 22:29:33 +00:00
|
|
|
'triggered_by_profile_url' => $this->initiator->getProfileUrl(),
|
2021-12-18 11:43:05 +00:00
|
|
|
'webhook_id' => $this->webhook->id,
|
|
|
|
'webhook_name' => $this->webhook->name,
|
2021-12-11 22:29:33 +00:00
|
|
|
];
|
|
|
|
|
|
|
|
if (method_exists($this->detail, 'getUrl')) {
|
|
|
|
$data['url'] = $this->detail->getUrl();
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($this->detail instanceof Model) {
|
|
|
|
$data['related_item'] = $this->detail->attributesToArray();
|
|
|
|
}
|
|
|
|
|
|
|
|
return $data;
|
|
|
|
}
|
|
|
|
}
|