Add dav plugin for rich workspaces

Signed-off-by: Julius Härtl <[email protected]>

appinfo/info.xml

@@ -11,11 +11,14 @@
 - **💾 Open format:** Files are saved as [Markdown](https://en.wikipedia.org/wiki/Markdown), so you can edit them from any other text app too.
 - **✊ Strong foundation:** We use [🐈 tiptap](https://tiptap.scrumpy.io) which is based on [🦉 ProseMirror](https://prosemirror.net) – huge thanks to them!
 	]]></description>
-	<version>1.2.0</version>
+	<version>1.2.3</version>
 	<licence>agpl</licence>
 	<author mail="[email protected]">Julius Härtl</author>
 	<namespace>Text</namespace>
 	<default_enable/>
+	<types>
+		<dav />
+	</types>
 	<category>office</category>
 	<website>https://github.com/nextcloud/text</website>
 	<bugs>https://github.com/nextcloud/text/issues</bugs>
@@ -29,4 +32,9 @@
 	<background-jobs>
 		<job>OCA\Text\Cron\Cleanup</job>
 	</background-jobs>
+	<sabre>
+		<plugins>
+			<plugin>OCA\Text\DAV\WorkspacePlugin</plugin>
+		</plugins>
+	</sabre>
 </info>

lib/Controller/WorkspaceController.php

@@ -48,6 +48,7 @@
 
 use OCA\Text\AppInfo\Application;
 use OCA\Text\Service\SessionService;
+use OCA\Text\Service\WorkspaceService;
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http;
 use OCP\AppFramework\Http\DataResponse;
@@ -68,17 +69,18 @@ class WorkspaceController extends OCSController {
 	/** @var IManager */
 	private $shareManager;
 
-	private const SUPPORTED_FILENAMES = [
-		'README.md',
-		'Readme.md',
-		'readme.md'
-	];
+	/** @var WorkspaceService */
+	private $workspaceService;
 
+	/** @var string */
+	private $userId;
 
-	public function __construct($appName, IRequest $request, IRootFolder $rootFolder, IManager $shareManager, $userId) {
+
+	public function __construct($appName, IRequest $request, IRootFolder $rootFolder, IManager $shareManager, WorkspaceService $workspaceService, $userId) {
 		parent::__construct($appName, $request);
 		$this->rootFolder = $rootFolder;
 		$this->shareManager = $shareManager;
+		$this->workspaceService = $workspaceService;
 		$this->userId = $userId;
 	}
 
@@ -92,7 +94,7 @@ public function folder(string $path = '/'): DataResponse {
 		try {
 			$folder = $this->rootFolder->getUserFolder($this->userId)->get($path);
 			if ($folder instanceof Folder) {
-				$file = $this->getFile($folder);
+				$file = $this->workspaceService->getFile($folder);
 				if ($file === null) {
 					return new DataResponse(['message' => 'No workspace file found'], Http::STATUS_NOT_FOUND);
 				}
@@ -122,7 +124,7 @@ public function publicFolder(string $shareToken, string $path = '/'): DataRespon
 			$share = $this->shareManager->getShareByToken($shareToken);
 			$folder = $share->getNode()->get($path);
 			if ($folder instanceof Folder) {
-				$file = $this->getFile($folder);
+				$file = $this->workspaceService->getFile($folder);
 				if ($file === null) {
 					return new DataResponse(['message' => 'No workspace file found'], Http::STATUS_NOT_FOUND);
 				}
@@ -143,15 +145,4 @@ public function publicFolder(string $shareToken, string $path = '/'): DataRespon
 		}
 	}
 
-	private function getFile(Folder $folder) {
-		$file = null;
-		foreach (self::SUPPORTED_FILENAMES as $filename) {
-			if ($folder->nodeExists($filename)) {
-				$file = $folder->get($filename);
-				continue;
-			}
-		}
-		return $file;
-	}
-
 }

lib/DAV/WorkspacePlugin.php

@@ -0,0 +1,97 @@
+<?php
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2019 Julius Härtl <[email protected]>
+ *
+ * @author Julius Härtl <[email protected]>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\Text\DAV;
+
+use OC\Files\Node\File;
+use OC\Files\Node\Folder;
+use OCA\DAV\Connector\Sabre\Directory;
+use OCA\DAV\Files\FilesHome;
+use OCA\Text\Service\WorkspaceService;
+use OCP\Files\IRootFolder;
+use Sabre\DAV\INode;
+use Sabre\DAV\PropFind;
+use Sabre\DAV\Server;
+use Sabre\DAV\ServerPlugin;
+
+class WorkspacePlugin extends ServerPlugin {
+
+	public const WORKSPACE = '{http://nextcloud.org/ns}rich-workspace';
+
+	/** @var Server */
+	private $server;
+
+	/** @var WorkspaceService */
+	private $workspaceService;
+
+	/**  @var IRootFolder */
+	private $rootFolder;
+
+	/** @var string|null */
+	private $userId;
+
+	public function __construct(WorkspaceService $workspaceService, IRootFolder $rootFolder, $userId) {
+		$this->workspaceService = $workspaceService;
+		$this->rootFolder = $rootFolder;
+		$this->userId = $userId;
+	}
+
+	/**
+	 * This initializes the plugin.
+	 *
+	 * This function is called by Sabre\DAV\Server, after
+	 * addPlugin is called.
+	 *
+	 * This method should set up the required event subscriptions.
+	 *
+	 * @param Server $server
+	 * @return void
+	 */
+	function initialize(Server $server) {
+		$this->server = $server;
+
+		$this->server->on('propFind', [$this, 'propFind']);
+	}
+
+
+	public function propFind(PropFind $propFind, INode $node) {
+		if (!$node instanceof Directory && !$node instanceof FilesHome) {
+			return;
+		}
+
+		$propFind->handle(self::WORKSPACE, function () use ($node) {
+			/** @var Folder[] $nodes */
+			$nodes = $this->rootFolder->getUserFolder($this->userId)->getById($node->getId());
+			if (count($nodes) > 0) {
+				/** @var File $file */
+				$file = $this->workspaceService->getFile($nodes[0]);
+				if ($file instanceof File) {
+					return $file->getContent();
+				}
+			}
+		});
+
+	}
+
+}

lib/Service/WorkspaceService.php

@@ -0,0 +1,31 @@
+<?php
+
+
+namespace OCA\Text\Service;
+
+
+use OCP\Files\Folder;
+use OCP\Files\NotFoundException;
+
+class WorkspaceService {
+
+	private const SUPPORTED_FILENAMES = [
+		'README.md',
+		'Readme.md',
+		'readme.md'
+	];
+
+	public function getFile(Folder $folder) {
+		$file = null;
+		foreach (self::SUPPORTED_FILENAMES as $filename) {
+			if ($folder->nodeExists($filename)) {
+				try {
+					$file = $folder->get($filename);
+				} catch (NotFoundException $e) {
+				}
+				continue;
+			}
+		}
+		return $file;
+	}
+}