Merge pull request #96 from pdsinterop/well-known-solid

Add /.well-known/solid and websocket endpoint

Author: ylebre

.gitignore

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

solid/appinfo/routes.php

@@ -54,7 +54,9 @@
         ['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/lib/AppInfo/Application.php

@@ -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;
@@ -58,6 +59,7 @@ public function __construct(array $urlParams = []) {
 
     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/Controller/SolidWebsocketController.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace OCA\Solid\Controller;
+
+use OCP\AppFramework\Controller;
+use OCP\AppFramework\Http\DataResponse;
+
+class SolidWebsocketController extends Controller
+{
+    /**
+     * @PublicPage
+     * @NoAdminRequired
+     * @NoCSRFRequired
+     */
+    public function register(): DataResponse
+    {
+        $pubsub = getenv("PUBSUB_URL") ?: "http://pubsub:8080";
+        return new DataResponse([
+            "@context" => "https://www.w3.org/ns/solid/notification/v1",
+            "type" => "WebSocketSubscription2021",
+            "source" => $pubsub . "/?type=WebSocketSubscription2021"
+        ]);
+    }
+}

solid/lib/Middleware/SolidCorsMiddleware.php

@@ -36,7 +36,16 @@ public function afterController($controller, $methodName, Response $response) {
 
             $pubsub = getenv("PUBSUB_URL") ?: "http://pubsub:8080";
             $response->addHeader('updates-via', $pubsub);
+            $linkHeaders = '</.well-known/solid>; rel="http://www.w3.org/ns/solid#storageDescription"';
+            $existingHeaders = $response->getHeaders();
+            if (isset($existingHeaders['Link'])) { // careful - this dictionary key is case sensitive here
+                $linkHeaders .= ', ' . $existingHeaders['Link'];
+            }
+            $response->addHeader('Link', $linkHeaders);
 
+            // Note that apart from these, the Link header with rel="acl" and the WAC-Allow header
+            // are already added by these lines in vendor/pdsinterop/solid-auth:
+            // https://github.com/pdsinterop/php-solid-auth/blob/e07c22d/src/WAC.php#L39-L40
             return $response;
         }
     }

solid/lib/Notifications/SolidNotifications.php

@@ -13,12 +13,12 @@ public function __construct() {
             $this->notifications = [
             	new SolidWebhook(),
             	new SolidPubSub($pubsub)
-	    ];
+	        ];
         }
 
         public function send($path, $type) {
             foreach ($this->notifications as $notification) {
                 $notification->send($path, $type);
+	        }
 	    }
-	}
     }

solid/lib/WellKnown/SolidHandler.php

@@ -0,0 +1,64 @@
+<?php
+namespace OCA\Solid\WellKnown;
+
+use OCP\IRequest;
+use OCP\IUserManager;
+use OCP\IURLGenerator;
+use OCP\IConfig;
+
+use OCP\AppFramework\Http\JSONResponse;
+use OCP\Http\WellKnown\GenericResponse;
+use OCP\Http\WellKnown\IHandler;
+use OCP\Http\WellKnown\IRequestContext;
+use OCP\Http\WellKnown\IResponse;
+
+class SolidHandler implements IHandler {
+	/* @var IURLGenerator */
+	private $urlGenerator;
+	
+	public function __construct(IRequest $request, IURLGenerator $urlGenerator, IConfig $config, IUserManager $userManager) 
+	{
+		require_once(__DIR__.'/../../vendor/autoload.php');
+		$this->urlGenerator = $urlGenerator;
+	}
+
+        public function handle(string $service, IRequestContext $context, ?IResponse $previousResponse): ?IResponse {
+                if ($service !== 'solid') {
+                        return $previousResponse;
+                }
+		$webhooksRegisterEndpoint = $this->urlGenerator->linkToRoute('solid.solidWebhook.register');
+		// FIXME: this shouldn't happen:
+		if (strlen($webhooksRegisterEndpoint) == 0) {
+			$webhooksRegisterEndpoint = $this->urlGenerator->linkToRoute('solid.app.appLauncher') . 'webhook/register';
+		}
+
+		$websocketsRegisterEndpoint = $this->urlGenerator->linkToRoute('solid.solidWebsocket.register');
+		// FIXME: this shouldn't happen:
+		if (strlen($websocketsRegisterEndpoint) == 0) {
+			$websocketsRegisterEndpoint = $this->urlGenerator->linkToRoute('solid.app.appLauncher') . 'websocket/register';
+		}
+		$body = [
+			"@context" => [
+				"https://www.w3.org/ns/solid/notification/v1"
+			],
+			"notificationChannel" => [
+				[
+					"id" => "websocketNotification",
+					"type" => ["WebSocketSubscription2021"],
+					"subscription" => $websocketsRegisterEndpoint,
+					"feature" => []
+				],
+				[
+					"id" => "webhookNotification",
+					"type" => ["WebHookSubscription2022"],
+					"subscription" => $webhooksRegisterEndpoint,
+					"feature" => []
+				]
+			]
+		];
+		$result = new JSONResponse($body);
+		$result->addHeader("Access-Control-Allow-Origin", "*");
+		$result->setStatus(200);
+		return new GenericResponse($result);
+	}
+}