Added webhook call functionality

diff --git a/app/Actions/ActivityLogger.php b/app/Actions/ActivityLogger.php
index 3a329387f7d19ab1bef05d689c4fbec1c58134d9..ad4ee73752b91331ad105dc9b5edfce4aae6a9c2 100644 (file)
--- a/app/Actions/ActivityLogger.php
+++ b/app/Actions/ActivityLogger.php
@@ -5,6 +5,7 @@ namespace BookStack\Actions;
 use BookStack\Auth\Permissions\PermissionService;
 use BookStack\Entities\Models\Entity;
 use BookStack\Interfaces\Loggable;
 use BookStack\Auth\Permissions\PermissionService;
 use BookStack\Entities\Models\Entity;
 use BookStack\Interfaces\Loggable;

+use Illuminate\Database\Eloquent\Builder;

 use Illuminate\Support\Facades\Log;
 
 class ActivityLogger
 use Illuminate\Support\Facades\Log;
 
 class ActivityLogger


@@ -35,6 +36,7 @@ class ActivityLogger
 
         $activity->save();
         $this->setNotification($type);
 
         $activity->save();
         $this->setNotification($type);

+        $this->dispatchWebhooks($type, $detail);

     }
 
     /**
     }
 
     /**


@@ -68,7 +70,7 @@ class ActivityLogger
     /**
      * Flashes a notification message to the session if an appropriate message is available.
      */
     /**
      * Flashes a notification message to the session if an appropriate message is available.
      */

-    protected function setNotification(string $type)
+    protected function setNotification(string $type): void

     {
         $notificationTextKey = 'activities.' . $type . '_notification';
         if (trans()->has($notificationTextKey)) {
     {
         $notificationTextKey = 'activities.' . $type . '_notification';
         if (trans()->has($notificationTextKey)) {


@@ -77,6 +79,21 @@ class ActivityLogger
         }
     }
 
         }
     }
 

+    /**
+     * @param string|Loggable $detail
+     */
+    protected function dispatchWebhooks(string $type, $detail): void
+    {
+        $webhooks = Webhook::query()->whereHas('trackedEvents', function(Builder $query) use ($type) {
+            $query->where('event', '=', $type)
+                ->orWhere('event', '=', 'all');
+        })->get();
+
+        foreach ($webhooks as $webhook) {
+            dispatch(new DispatchWebhookJob($webhook, $type, $detail));
+        }
+    }
+

     /**
      * Log out a failed login attempt, Providing the given username
      * as part of the message if the '%u' string is used.
     /**
      * Log out a failed login attempt, Providing the given username
      * as part of the message if the '%u' string is used.

diff --git a/app/Actions/DispatchWebhookJob.php b/app/Actions/DispatchWebhookJob.php
new file mode 100644 (file)
index 0000000..4cc749a
--- /dev/null
+++ b/app/Actions/DispatchWebhookJob.php
@@ -0,0 +1,120 @@
+<?php
+
+namespace BookStack\Actions;
+
+use BookStack\Auth\User;
+use BookStack\Entities\Models\Entity;
+use BookStack\Interfaces\Loggable;
+use BookStack\Model;
+use GuzzleHttp\Client;
+use GuzzleHttp\Psr7\Request;
+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;
+use Illuminate\Support\Facades\Log;
+use Psr\Http\Client\ClientExceptionInterface;
+
+class DispatchWebhookJob implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    /**
+     * @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()
+    {
+        $httpClient = new Client([
+            'timeout' => 3,
+            'allow_redirects' => ['strict' => true],
+        ]);
+
+        $request = new Request('POST', $this->webhook->endpoint, [
+            'Content-Type' => 'application/json'
+        ], json_encode($this->buildWebhookData()));
+
+        try {
+            $response = $httpClient->send($request);
+            if ($response->getStatusCode() >= 400) {
+                Log::error("Webhook call to endpoint {$this->webhook->endpoint} failed with status {$response->getStatusCode()}");
+            }
+        } catch (ClientExceptionInterface $exception) {
+            Log::error("Received error during webhook call to endpoint {$this->webhook->endpoint}: {$exception->getMessage()}");
+        }
+    }
+
+    protected function buildWebhookData(): array
+    {
+        $textParts = [
+            $this->initiator->name,
+            trans('activities.' . $this->event),
+        ];
+
+        if ($this->detail instanceof Entity) {
+            $textParts[] = '"' . $this->detail->name . '"';
+        }
+
+        $data =  [
+            'event' => $this->event,
+            'text' => implode(' ', $textParts),
+            'triggered_at' => Carbon::createFromTimestampUTC($this->initiatedTime)->toISOString(),
+            'triggered_by' => $this->initiator->attributesToArray(),
+            'triggered_by_profile_url' => $this->initiator->getProfileUrl(),
+            'webhook_id' => $this->webhook->id,
+            'webhook_name' => $this->webhook->name,
+        ];
+
+        if (method_exists($this->detail, 'getUrl')) {
+            $data['url'] = $this->detail->getUrl();
+        }
+
+        if ($this->detail instanceof Model) {
+            $data['related_item'] = $this->detail->attributesToArray();
+        }
+
+        return $data;
+    }
+}

diff --git a/resources/views/common/activity-item.blade.php b/resources/views/common/activity-item.blade.php
index eebfb591a4af40713816963b5c978d5a6b3ba171..89d44b15231a37037a4fe6475f6e4b8e3672cf15 100644 (file)
--- a/resources/views/common/activity-item.blade.php
+++ b/resources/views/common/activity-item.blade.php
@@ -24,8 +24,6 @@
         "{{ $activity->entity->name }}"
     @endif
 
         "{{ $activity->entity->name }}"
     @endif
 

-    @if($activity->extra) "{{ $activity->extra }}" @endif
-

     <br>
 
     <span class="text-muted"><small>@icon('time'){{ $activity->created_at->diffForHumans() }}</small></span>
     <br>
 
     <span class="text-muted"><small>@icon('time'){{ $activity->created_at->diffForHumans() }}</small></span>