From 14e07a337c6557b62e87362943855d6998891876 Mon Sep 17 00:00:00 2001 From: Alexander Piskun <13381981+bigcat88@users.noreply.github.com> Date: Thu, 18 Jul 2024 18:12:00 +0300 Subject: [PATCH] feat: allow to use webhook_listeners without user context Signed-off-by: Alexander Piskun --- apps/webhook_listeners/appinfo/info.xml | 2 +- .../composer/composer/autoload_classmap.php | 1 + .../composer/composer/autoload_static.php | 1 + .../lib/Controller/WebhooksController.php | 10 +++--- .../lib/Db/WebhookListener.php | 8 ++--- .../lib/Db/WebhookListenerMapper.php | 4 +-- .../Version1001Date20240716184935.php | 36 +++++++++++++++++++ 7 files changed, 51 insertions(+), 11 deletions(-) create mode 100755 apps/webhook_listeners/lib/Migration/Version1001Date20240716184935.php diff --git a/apps/webhook_listeners/appinfo/info.xml b/apps/webhook_listeners/appinfo/info.xml index 04d2ec7a012..0da6d2582f4 100644 --- a/apps/webhook_listeners/appinfo/info.xml +++ b/apps/webhook_listeners/appinfo/info.xml @@ -9,7 +9,7 @@ Nextcloud webhook support Nextcloud webhook support Nextcloud webhook support - 1.0.0-dev + 1.1.0-dev agpl Côme Chilliet WebhookListeners diff --git a/apps/webhook_listeners/composer/composer/autoload_classmap.php b/apps/webhook_listeners/composer/composer/autoload_classmap.php index 0501a86df2c..3a8e2fe16ae 100644 --- a/apps/webhook_listeners/composer/composer/autoload_classmap.php +++ b/apps/webhook_listeners/composer/composer/autoload_classmap.php @@ -16,6 +16,7 @@ return array( 'OCA\\WebhookListeners\\Db\\WebhookListenerMapper' => $baseDir . '/../lib/Db/WebhookListenerMapper.php', 'OCA\\WebhookListeners\\Listener\\WebhooksEventListener' => $baseDir . '/../lib/Listener/WebhooksEventListener.php', 'OCA\\WebhookListeners\\Migration\\Version1000Date20240527153425' => $baseDir . '/../lib/Migration/Version1000Date20240527153425.php', + 'OCA\\WebhookListeners\\Migration\\Version1001Date20240716184935' => $baseDir . '/../lib/Migration/Version1001Date20240716184935.php', 'OCA\\WebhookListeners\\ResponseDefinitions' => $baseDir . '/../lib/ResponseDefinitions.php', 'OCA\\WebhookListeners\\Service\\PHPMongoQuery' => $baseDir . '/../lib/Service/PHPMongoQuery.php', 'OCA\\WebhookListeners\\Settings\\Admin' => $baseDir . '/../lib/Settings/Admin.php', diff --git a/apps/webhook_listeners/composer/composer/autoload_static.php b/apps/webhook_listeners/composer/composer/autoload_static.php index 43a9b4779d9..d63fe31af47 100644 --- a/apps/webhook_listeners/composer/composer/autoload_static.php +++ b/apps/webhook_listeners/composer/composer/autoload_static.php @@ -31,6 +31,7 @@ class ComposerStaticInitWebhookListeners 'OCA\\WebhookListeners\\Db\\WebhookListenerMapper' => __DIR__ . '/..' . '/../lib/Db/WebhookListenerMapper.php', 'OCA\\WebhookListeners\\Listener\\WebhooksEventListener' => __DIR__ . '/..' . '/../lib/Listener/WebhooksEventListener.php', 'OCA\\WebhookListeners\\Migration\\Version1000Date20240527153425' => __DIR__ . '/..' . '/../lib/Migration/Version1000Date20240527153425.php', + 'OCA\\WebhookListeners\\Migration\\Version1001Date20240716184935' => __DIR__ . '/..' . '/../lib/Migration/Version1001Date20240716184935.php', 'OCA\\WebhookListeners\\ResponseDefinitions' => __DIR__ . '/..' . '/../lib/ResponseDefinitions.php', 'OCA\\WebhookListeners\\Service\\PHPMongoQuery' => __DIR__ . '/..' . '/../lib/Service/PHPMongoQuery.php', 'OCA\\WebhookListeners\\Settings\\Admin' => __DIR__ . '/..' . '/../lib/Settings/Admin.php', diff --git a/apps/webhook_listeners/lib/Controller/WebhooksController.php b/apps/webhook_listeners/lib/Controller/WebhooksController.php index 852d0db65da..eeb26b57030 100644 --- a/apps/webhook_listeners/lib/Controller/WebhooksController.php +++ b/apps/webhook_listeners/lib/Controller/WebhooksController.php @@ -17,6 +17,7 @@ use OCA\WebhookListeners\Settings\Admin; use OCP\AppFramework\Db\DoesNotExistException; use OCP\AppFramework\Http; use OCP\AppFramework\Http\Attribute\ApiRoute; +use OCP\AppFramework\Http\Attribute\AppApiAdminAccessWithoutUser; use OCP\AppFramework\Http\Attribute\AuthorizedAdminSetting; use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\DataResponse; @@ -56,6 +57,7 @@ class WebhooksController extends OCSController { */ #[ApiRoute(verb: 'GET', url: '/api/v1/webhooks')] #[AuthorizedAdminSetting(settings:Admin::class)] + #[AppApiAdminAccessWithoutUser] public function index(?string $uri = null): DataResponse { try { if ($uri !== null) { @@ -89,6 +91,7 @@ class WebhooksController extends OCSController { */ #[ApiRoute(verb: 'GET', url: '/api/v1/webhooks/{id}')] #[AuthorizedAdminSetting(settings:Admin::class)] + #[AppApiAdminAccessWithoutUser] public function show(int $id): DataResponse { try { return new DataResponse($this->mapper->getById($id)->jsonSerialize()); @@ -122,6 +125,7 @@ class WebhooksController extends OCSController { */ #[ApiRoute(verb: 'POST', url: '/api/v1/webhooks')] #[AuthorizedAdminSetting(settings:Admin::class)] + #[AppApiAdminAccessWithoutUser] public function create( string $httpMethod, string $uri, @@ -143,8 +147,6 @@ class WebhooksController extends OCSController { throw new OCSBadRequestException('This auth method does not exist'); } try { - /* We can never reach here without a user in session */ - assert(is_string($this->userId)); $webhookListener = $this->mapper->addWebhookListener( $appId, $this->userId, @@ -191,6 +193,7 @@ class WebhooksController extends OCSController { */ #[ApiRoute(verb: 'POST', url: '/api/v1/webhooks/{id}')] #[AuthorizedAdminSetting(settings:Admin::class)] + #[AppApiAdminAccessWithoutUser] public function update( int $id, string $httpMethod, @@ -213,8 +216,6 @@ class WebhooksController extends OCSController { throw new OCSBadRequestException('This auth method does not exist'); } try { - /* We can never reach here without a user in session */ - assert(is_string($this->userId)); $webhookListener = $this->mapper->updateWebhookListener( $id, $appId, @@ -254,6 +255,7 @@ class WebhooksController extends OCSController { */ #[ApiRoute(verb: 'DELETE', url: '/api/v1/webhooks/{id}')] #[AuthorizedAdminSetting(settings:Admin::class)] + #[AppApiAdminAccessWithoutUser] public function destroy(int $id): DataResponse { try { $deleted = $this->mapper->deleteById($id); diff --git a/apps/webhook_listeners/lib/Db/WebhookListener.php b/apps/webhook_listeners/lib/Db/WebhookListener.php index 8053fc318dc..2e194261d64 100644 --- a/apps/webhook_listeners/lib/Db/WebhookListener.php +++ b/apps/webhook_listeners/lib/Db/WebhookListener.php @@ -13,9 +13,9 @@ use OCP\AppFramework\Db\Entity; use OCP\Security\ICrypto; /** - * @method void setUserId(string $userId) + * @method void setUserId(?string $userId) * @method ?string getAppId() - * @method string getUserId() + * @method ?string getUserId() * @method string getHttpMethod() * @method string getUri() * @method ?array getHeaders() @@ -31,10 +31,10 @@ class WebhookListener extends Entity implements \JsonSerializable { protected $appId = null; /** - * @var string id of the user who added the webhook listener + * @var ?string id of the user who added the webhook listener * @psalm-suppress PropertyNotSetInConstructor */ - protected $userId; + protected $userId = null; /** * @var string diff --git a/apps/webhook_listeners/lib/Db/WebhookListenerMapper.php b/apps/webhook_listeners/lib/Db/WebhookListenerMapper.php index 7f4636f652b..a55a8c7f6a0 100644 --- a/apps/webhook_listeners/lib/Db/WebhookListenerMapper.php +++ b/apps/webhook_listeners/lib/Db/WebhookListenerMapper.php @@ -72,7 +72,7 @@ class WebhookListenerMapper extends QBMapper { */ public function addWebhookListener( ?string $appId, - string $userId, + ?string $userId, string $httpMethod, string $uri, string $event, @@ -112,7 +112,7 @@ class WebhookListenerMapper extends QBMapper { public function updateWebhookListener( int $id, ?string $appId, - string $userId, + ?string $userId, string $httpMethod, string $uri, string $event, diff --git a/apps/webhook_listeners/lib/Migration/Version1001Date20240716184935.php b/apps/webhook_listeners/lib/Migration/Version1001Date20240716184935.php new file mode 100755 index 00000000000..58c3ce6c181 --- /dev/null +++ b/apps/webhook_listeners/lib/Migration/Version1001Date20240716184935.php @@ -0,0 +1,36 @@ +hasTable(WebhookListenerMapper::TABLE_NAME)) { + $table = $schema->getTable(WebhookListenerMapper::TABLE_NAME); + $table->getColumn('user_id')->setNotnull(false)->setDefault(null); + return $schema; + } + return null; + } +}