GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

[PLUGIN][WebHooks] Add hook for subscriptions

Browse Source
This commit is contained in:
Hugo Sales 2022-03-24 21:59:24 +00:00 committed by Diogo Peralta Cordeiro
parent e3e14c53ef
commit ca5520edbf
Signed by: diogo
GPG Key ID: 18D2D35001FBFAB0
3 changed files with 43 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
components/Subscription/Subscription.php
View File

@ -112,8 +112,9 @@ class Subscription extends Component
\is_int($subject) ? $subject : Actor::getById($subscriber_id), \is_int($subject) ? $subject : Actor::getById($subscriber_id),
$activity, $activity,
[$subscribed_id], [$subscribed_id],
_m('{subject} subscribed to {object}.', ['{subject}' => $activity->getActorId(), '{object}' => $activity->getObjectId()]), $reason = _m('{subject} subscribed to {object}.', ['{subject}' => $activity->getActorId(), '{object}' => $activity->getObjectId()]),
]); ]);
Event::handle('NewSubscriptionEnd', [$subject, $activity, $object, $reason]);
} }
return $activity; return $activity;
} }

2
plugins/WebHooks/Controller/WebHooks.php
View File

@ -45,7 +45,7 @@ class WebHooks extends Controller
$hooks = F\reindex(DB::findBy(E\WebHook::class, ['actor_id' => $user->getId()]), fn (E\WebHook $wh) => $wh->getEvent()); $hooks = F\reindex(DB::findBy(E\WebHook::class, ['actor_id' => $user->getId()]), fn (E\WebHook $wh) => $wh->getEvent());
$form = Form::create([ $form = Form::create([
['notifications', TextType::class, ['label' => _m('Trigger this hook when I recieve a notification'), 'data' => ($hooks['notifications'] ?? null)?->getTarget()]], ['notifications', TextType::class, ['label' => _m('Trigger this hook when I recieve a notification'), 'data' => ($hooks['notifications'] ?? null)?->getTarget()]],
['follow', TextType::class, ['label' => _m('Trigger this hook when someone starts following me'), 'data' => ($hooks['follow'] ?? null)?->getTarget()]], ['subscriptions', TextType::class, ['label' => _m('Trigger this hook when someone subscribes to me'), 'data' => ($hooks['subscriptions'] ?? null)?->getTarget()]],
['save_webhooks', SubmitType::class, ['label' => _m('Submit')]], ['save_webhooks', SubmitType::class, ['label' => _m('Submit')]],
], form_options: ['action' => Router::url(P\WebHooks::controller_route)]); ], form_options: ['action' => Router::url(P\WebHooks::controller_route)]);

53
plugins/WebHooks/WebHooks.php
View File

@ -30,6 +30,8 @@ use App\Core\Queue\Queue;
use App\Core\Router\RouteLoader; use App\Core\Router\RouteLoader;
use App\Entity\Activity; use App\Entity\Activity;
use App\Entity\Actor; use App\Entity\Actor;
use App\Entity\LocalUser;
use App\Util\Common;
use App\Util\Exception\ServerException; use App\Util\Exception\ServerException;
use Exception; use Exception;
use Functional as F; use Functional as F;
@ -59,21 +61,32 @@ class WebHooks extends Plugin
return Event::next; return Event::next;
} }
private function maybeEnqueue(Actor $actor, string $event, array $args): void
{
$hook_target = DB::findOneBy(E\WebHook::class, ['actor_id' => $actor->getId(), 'event' => $event], return_null: true)?->getTarget();
if (!\is_null($hook_target)) {
Queue::enqueue([$event, $hook_target, $actor, $args], queue: 'webhook');
}
}
public function onNewNotificationEnd(Actor $sender, Activity $activity, array $effective_targets, ?string $reason) public function onNewNotificationEnd(Actor $sender, Activity $activity, array $effective_targets, ?string $reason)
{ {
foreach ($effective_targets as $actor) { foreach ($effective_targets as $actor) {
$target = DB::findOneBy(E\WebHook::class, ['actor_id' => $actor->getId(), 'event' => 'notifications'], return_null: true)?->getTarget(); $this->maybeEnqueue($actor, 'notifications', [$sender, $activity, $effective_targets, $reason]);
if (!\is_null($target)) {
Queue::enqueue(['notifications', $target, $actor, [$sender, $activity, $effective_targets, $reason]], queue: 'webhook');
} }
return Event::next;
} }
public function onNewSubscriptionEnd(LocalUser|Actor $subscriber, Activity $activity, Actor $hook_target, ?string $reason)
{
$this->maybeEnqueue($hook_target, 'subscriptions', [$subscriber, $activity, $hook_target, $reason]);
return Event::next; return Event::next;
} }
/** /**
* @param array<Actor $sender, Activity $activity, array $effective_targets, ?string $reason> $args * @param array<Actor $sender, Activity $activity, array $effective_targets, ?string $reason> $args
*/ */
public function onQueueWebhook(string $type, string $target, Actor $actor, array $args) public function onQueueWebhook(string $type, string $hook_target, Actor $actor, array $args)
{ {
switch ($type) { switch ($type) {
case 'notifications': case 'notifications':
@ -85,18 +98,30 @@ class WebHooks extends Plugin
'targets' => F\map(array_values($targets), fn (Actor $actor) => ['id' => $actor->getId(), 'nickname' => $actor->getNickname()]), 'targets' => F\map(array_values($targets), fn (Actor $actor) => ['id' => $actor->getId(), 'nickname' => $actor->getNickname()]),
'reason' => $reason, 'reason' => $reason,
]; ];
// toJson(Activity) is already JSON (hopefully that's obvious :') ), so replace it after converting the rest to JSON break;
$json = str_replace('"activity":"%activity%"', '"activity":' . \Plugin\ActivityPub\Util\Model\Activity::toJson($activity), json_encode($data)); case 'subscriptions':
Log::debug("WebHooks: POST {$target} on behalf of actor {$actor->getId()} ({$actor->getNickname()})", [$data, ['json' => $json]]); [$subscriber, $activity, $target, $reason] = $args;
try { $data = [
$method = Common::config('plugin_webhooks', 'method'); 'type' => 'subscription',
HTTPClient::{$method}($target, ['body' => $json, 'headers' => ['content-type' => 'application/json', 'user-agent' => 'GNU social']]); 'activity' => '%activity%',
} catch (Exception $e) { 'actor' => ['id' => $subscriber->getId(), 'nickname' => $subscriber->getNickname()],
Log::debug("WebHooks: Failed POST {$target} on behalf of actor {$actor->getId()} ({$actor->getNickname()})", [$e]); 'targets' => [['id' => $target->getId(), 'nickname' => $target->getNickname()]],
} 'reason' => $reason,
return Event::stop; ];
break;
default: default:
throw new ServerException("Webhook notification handler for event {$type} not implemented"); throw new ServerException("Webhook notification handler for event {$type} not implemented");
} }
// toJson(Activity) is already JSON (hopefully that's obvious :') ), so replace it after converting the rest to JSON
$json = str_replace('"activity":"%activity%"', '"activity":' . \Plugin\ActivityPub\Util\Model\Activity::toJson($activity), json_encode($data));
Log::debug("WebHooks: POST {$hook_target} on behalf of actor {$actor->getId()} ({$actor->getNickname()})", [$data, ['json' => $json]]);
try {
$method = Common::config('plugin_webhooks', 'method');
HTTPClient::{$method}($hook_target, ['body' => $json, 'headers' => ['content-type' => 'application/json', 'user-agent' => 'GNU social']]);
} catch (Exception $e) {
Log::debug("WebHooks: Failed POST {$hook_target} on behalf of actor {$actor->getId()} ({$actor->getNickname()})", [$e]);
}
return Event::stop;
} }
} }