Merge pull request #85 from pdsinterop/feature/notifications

Implementiation for webhooks and notification registration endpoints

Author: ylebre

.gitignore

@@ -0,0 +1,2 @@
+solid/bin
+solid/vendor

run-solid-test-suite.sh

@@ -57,6 +57,6 @@ startPubSub
 startSolidNextcloud server
 startSolidNextcloud thirdparty
 runTests webid-provider
-runTests solid-crud
 runTests web-access-control
+runTests solid-crud
 teardown

solid/TODO.Notifications

@@ -0,0 +1,19 @@
+TODO:
+- [ ] advertise the notifications channel in well-known
+- [ ] advertise the notifications channel in HTTP headers
+
+Backlog / later:
+- [ ] add actor to notifications
+- [ ] add UUID to notifications
+- [ ] Add support for the rate limit feature.
+- [ ] create a solid-notifications-lastsent database table - columns are subscription_id and lastsent;
+- [ ] how can we stop sending notifications when read access was revoked?
+- [ ] use a background process to send notifications so they are out of bound with requests
+
+Done:
+- [v] create a solid-notifications-subscription database table - columns should have: id, webid, path, url, expiry
+- [v] add notifications controller
+- [v] handle register requests - this must validate that the requestor has read access to the resource;
+- [v] handle unregister requests - only the webid that subscribed should be able to unsubscribe
+- [v] reinstate the updates-via header in HEAD requests, which was removed from solid-crud
+- [v] implement function to get subscription in SolidWebhook

solid/appinfo/routes.php

@@ -51,6 +51,12 @@
         ['name' => 'contacts#handlePatch', 'url' => '/@{userId}/contacts{path}', 'verb' => 'PATCH', 'requirements' => array('path' => '.+')],
         ['name' => 'contacts#handleHead', 'url' => '/@{userId}/contacts{path}', 'verb' => 'HEAD', 'requirements' => array('path' => '.+')],
 
+        ['name' => 'solidWebhook#listWebhooks', 'url' => '/webhook/list', 'verb' => 'GET'],
+        ['name' => 'solidWebhook#register', 'url' => '/webhook/register', 'verb' => 'POST'],
+        ['name' => 'solidWebhook#unregister', 'url' => '/webhook/unregister', 'verb' => 'POST'],
+
+        ['name' => 'solidWebsocket#register', 'url' => '/websocket/register', 'verb' => 'POST'],
+
         ['name' => 'app#appLauncher', 'url' => '/', 'verb' => 'GET'],
     ]
 ];

solid/composer.json

@@ -32,7 +32,7 @@
         "pdsinterop/flysystem-nextcloud": "^0.2",
         "pdsinterop/flysystem-rdf": "^0.5",
         "pdsinterop/solid-auth": "v0.10.1",
-        "pdsinterop/solid-crud": "^0.6",
+        "pdsinterop/solid-crud": "^0.7.0",
         "psr/log": "^1.1"
     },
     "require-dev": {

solid/composer.lock

@@ -11,6 +11,7 @@
 
 use OCA\Solid\Service\UserService;
 use OCA\Solid\WellKnown\OpenIdConfigurationHandler;
+use OCA\Solid\WellKnown\SolidHandler;
 use OCA\Solid\Middleware\SolidCorsMiddleware;
 
 use OCP\AppFramework\App;
@@ -42,10 +43,23 @@ public function __construct(array $urlParams = []) {
 
         // executed in the order that it is registered
         $container->registerMiddleware(SolidCorsMiddleware::class);
+
+        $container->registerService(SolidWebhookService::class, function($c): SolidWebhookService {
+            return new SolidWebhookService(
+                $c->query(SolidWebhookMapper::class)
+            );
+        });
+
+        $container->registerService(SolidWebhookMapper::class, function($c): SolidWebhookMapper {
+            return new SolidWebhookMapper(
+                $c->get(IDBConnection::class)
+            );
+        });
     }
 
     public function register(IRegistrationContext $context): void {
         $context->registerWellKnownHandler(\OCA\Solid\WellKnown\OpenIdConfigurationHandler::class);
+        $context->registerWellKnownHandler(\OCA\Solid\WellKnown\SolidHandler::class);
 
         /**
          * Core class wrappers

solid/lib/AppInfo/Application.php

@@ -3,6 +3,7 @@
 
 use OCA\Solid\DpopFactoryTrait;
 use OCA\Solid\PlainResponse;
+use OCA\Solid\Notifications\SolidNotifications;
 
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http;
@@ -129,14 +130,14 @@ public function handleRequest($userId, $path) {
 		$this->filesystem = $this->getFileSystem($userId);
 
 		$this->resourceServer = new ResourceServer($this->filesystem, $this->response);		
-        $this->WAC = new WAC($this->filesystem);
+		$this->WAC = new WAC($this->filesystem);
 
 		$request = $this->rawRequest;
 		$baseUrl = $this->getCalendarUrl($userId);		
 		$this->resourceServer->setBaseUrl($baseUrl);
 		$this->WAC->setBaseUrl($baseUrl);
-		$pubsub = getenv('PUBSUB_URL') ?: ("http://pubsub:8080/");
-		$this->resourceServer->setPubSubUrl($pubsub);
+		$notifications = new SolidNotifications();
+		$this->resourceServer->setNotifications($notifications);
 
 		$dpop = $this->getDpop();
 

solid/lib/Controller/CalendarController.php

@@ -3,6 +3,7 @@
 
 use OCA\Solid\DpopFactoryTrait;
 use OCA\Solid\PlainResponse;
+use OCA\Solid\Notifications\SolidNotifications;
 
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http;
@@ -130,14 +131,14 @@ public function handleRequest($userId, $path) {
 		$this->filesystem = $this->getFileSystem($userId);
 
 		$this->resourceServer = new ResourceServer($this->filesystem, $this->response);		
-       $this->WAC = new WAC($this->filesystem);
+		$this->WAC = new WAC($this->filesystem);
 
 		$request = $this->rawRequest;
 		$baseUrl = $this->getContactsUrl($userId);		
 		$this->resourceServer->setBaseUrl($baseUrl);
 		$this->WAC->setBaseUrl($baseUrl);
-		$pubsub = getenv('PUBSUB_URL') ?: ("http://pubsub:8080/");
-		$this->resourceServer->setPubSubUrl($pubsub);
+		$notifications = new SolidNotifications();
+		$this->resourceServer->setNotifications($notifications);
 
 		$dpop = $this->getDpop();
 

solid/lib/Controller/ContactsController.php

@@ -3,6 +3,7 @@
 
 use OCA\Solid\DpopFactoryTrait;
 use OCA\Solid\PlainResponse;
+use OCA\Solid\Notifications\SolidNotifications;
 
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http;
@@ -146,14 +147,14 @@ public function handleRequest($userId, $path) {
 		$this->filesystem = $this->getFileSystem($userId);
 
 		$this->resourceServer = new ResourceServer($this->filesystem, $this->response);		
-        $this->WAC = new WAC($this->filesystem);
+		$this->WAC = new WAC($this->filesystem);
 
 		$request = $this->rawRequest;
 		$baseUrl = $this->getProfileUrl($userId);		
 		$this->resourceServer->setBaseUrl($baseUrl);
 		$this->WAC->setBaseUrl($baseUrl);
-		$pubsub = getenv('PUBSUB_URL') ?: ("http://pubsub:8080/");
-		$this->resourceServer->setPubSubUrl($pubsub);
+		$notifications = new SolidNotifications();
+		$this->resourceServer->setNotifications($notifications);
 
 		$dpop = $this->getDpop();