fixup! Switch to OCP proposal

juliusknorr · juliusknorr · commit 90ab8953c74d · 2022-03-23T15:52:04.000+01:00
diff --git a/README.md b/README.md
@@ -30,7 +30,8 @@ Administrators can also lock files using the `./occ` command:
 
 If locking is available the app will expose itself through the capabilties endpoint under the files key:
 ```
-curl http://admin:admin@nextcloud.local/ocs/v1.php/cloud/capabilities\?format\=json -H 'OCS-APIRequest: true' \
+curl http://admin:admin@nextcloud.local/ocs/v1.php/cloud/capabilities\?format\=json \
+	-H 'OCS-APIRequest: true' \
 	| jq .ocs.data.capabilities.files
 {
   ...
@@ -39,16 +40,97 @@ curl http://admin:admin@nextcloud.local/ocs/v1.php/cloud/capabilities\?format\=j
 }
 ```
 
-### Fetching lock details
+### WebDAV: Fetching lock details
 
 WebDAV returns the following additional properties if requests through a `PROPFIND`:
 
 - `{http://nextcloud.org/ns}lock`: `true` if the file is locked, otherwise `false`
+- `{http://nextcloud.org/ns}lock-owner-type`: User id of the lock owner
+  - `0` represents a manual lock by a user
+  - `1` represents a collaboratively locked file, e.g. when being edited through Office or Text
+  - `2` represents a WebDAV lock identified by a lock token, which will have the other properties set as if it was type 0
 - `{http://nextcloud.org/ns}lock-owner`: User id of the lock owner
 - `{http://nextcloud.org/ns}lock-owner-displayname`: Display name of the lock owner
 - `{http://nextcloud.org/ns}lock-time`: Timestamp of the log creation time
 
-### Locking a file
+```bash
+curl -X PROPFIND \
+  --url http://admin:admin@nextcloud.dev.local/remote.php/dav/files/admin/myfile.odt \
+  --data '<D:propfind xmlns:D="DAV:" xmlns:NC="http://nextcloud.org/ns">
+	<D:prop>
+		<NC:lock />
+		<NC:lock-owner-type />
+		<NC:lock-owner />
+		<NC:lock-owner-displayname />
+		<NC:lock-owner-editor />
+		<NC:lock-time />
+	</D:prop>
+</D:propfind>'
+```
+
+
+### WebDAV: Manually lock a file
+
+```
+curl -X LOCK \
+  --url http://admin:admin@nextcloud.dev.local/remote.php/dav/files/admin/myfile.odt \
+  --header 'X-User-Lock: 1'
+```
+
+#### Response
+
+The response will give back the updated properties after obtaining the lock with a `200 Success` status code or the existing lock details in case of a `423 Locked` status.
+
+```xml
+<?xml version="1.0"?>
+<d:prop
+	xmlns:d="DAV:"
+	xmlns:s="http://sabredav.org/ns"
+	xmlns:oc="http://owncloud.org/ns"
+	xmlns:nc="http://nextcloud.org/ns">
+	<nc:lock>1</nc:lock>
+	<nc:lock-owner-type>0</nc:lock-owner-type>
+	<nc:lock-owner>user1</nc:lock-owner>
+	<nc:lock-owner-displayname>user1</nc:lock-owner-displayname>
+	<nc:lock-owner-editor>user1</nc:lock-owner-editor>
+	<nc:lock-time>1648046707</nc:lock-time>
+</d:prop>
+```
+
+
+
+### WebDAV: Manually unlock a file
+
+```
+curl -X UNLOCK \
+  --url http://admin:admin@nextcloud.dev.local/remote.php/dav/files/admin/myfile.odt \
+  --header 'X-User-Lock: 1'
+```
+
+#### Response
+
+```xml
+<?xml version="1.0"?>
+<d:prop
+	xmlns:d="DAV:"
+	xmlns:s="http://sabredav.org/ns"
+	xmlns:oc="http://owncloud.org/ns"
+	xmlns:nc="http://nextcloud.org/ns">
+	<nc:lock></nc:lock>
+	<nc:lock-owner-type/>
+	<nc:lock-owner/>
+	<nc:lock-owner-displayname/>
+	<nc:lock-owner-editor/>
+	<nc:lock-time/>
+</d:prop>
+
+```
+
+#### Error types
+
+- 423 Locked
+
+### OCS: Locking a file
 
 `PUT /apps/files_lock/lock/{fileId}`
 
@@ -86,7 +168,7 @@ curl -X PUT 'http://admin:admin@nextcloud.local/ocs/v2.php/apps/files_lock/lock/
 ```
 
 
-### Unlocking a file
+### OCS: Unlocking a file
 
 `DELETE /apps/files_lock/lock/{fileId}`
 
diff --git a/lib/Command/Lock.php b/lib/Command/Lock.php
@@ -33,7 +33,6 @@
 use OC\Core\Command\Base;
 use OC\User\NoUserException;
 use OCA\FilesLock\Db\LocksRequest;
-use OCA\FilesLock\Exceptions\AlreadyLockedException;
 use OCA\FilesLock\Exceptions\LockNotFoundException;
 use OCA\FilesLock\Exceptions\NotFileException;
 use OCA\FilesLock\Exceptions\SuccessException;
@@ -118,7 +117,6 @@ protected function configure() {
 	 * @throws NoUserException
 	 * @throws NotFoundException
 	 * @throws UnauthorizedUnlockException
-	 * @throws AlreadyLockedException
 	 * @throws NotFileException
 	 * @throws InvalidPathException
 	 */
@@ -178,7 +176,6 @@ private function getStatus(InputInterface $input, OutputInterface $output, int $
 	 * @param int $fileId
 	 * @param string|null $userId
 	 *
-	 * @throws AlreadyLockedException
 	 * @throws InvalidPathException
 	 * @throws NoUserException
 	 * @throws NotFileException
diff --git a/lib/DAV/LockPlugin.php b/lib/DAV/LockPlugin.php
@@ -6,14 +6,20 @@
 use OCA\DAV\Connector\Sabre\Node as SabreNode;
 use OCA\DAV\Connector\Sabre\ObjectTree;
 use OCA\FilesLock\AppInfo\Application;
+use OCA\FilesLock\Exceptions\LockNotFoundException;
+use OCA\FilesLock\Exceptions\NotFileException;
+use OCA\FilesLock\Exceptions\UnauthorizedUnlockException;
 use OCA\FilesLock\Model\FileLock;
 use OCA\FilesLock\Service\AppLockService;
 use OCA\FilesLock\Service\FileService;
 use OCA\FilesLock\Service\LockService;
 use OCP\DirectEditing\IManager;
 use OCP\DirectEditing\RegisterDirectEditorEvent;
 use OCP\EventDispatcher\IEventDispatcher;
+use OCP\Files\InvalidPathException;
 use OCP\Files\Lock\ILock;
+use OCP\Files\Lock\OwnerLockedException;
+use OCP\Files\NotFoundException;
 use OCP\IUserManager;
 use OCP\IUserSession;
 use Sabre\DAV\INode;
@@ -130,29 +136,72 @@ public function customProperties(PropFind $propFind, INode $node) {
 		});
 	}
 
+	private function getLockDisplayName(ILock $lock): ?string {
+		$user = $this->userManager->get($lock->getOwner());
+		if ($user !== null) {
+			return $user->getDisplayName();
+		}
+
+		return null;
+	}
+
 	public function httpLock(RequestInterface $request, ResponseInterface $response) {
 		if ($request->getHeader('X-User-Lock')) {
-			$file = $this->fileService->getFileFromAbsoluteUri($this->server->getRequestUri());
-			$this->lockService->lockFileAsUser($file, $this->userSession->getUser());
 			$response->setHeader('Content-Type', 'application/xml; charset=utf-8');
-			//$response->setHeader('Lock-Token', '<opaquelocktoken:'.$lockInfo->token.'>');
-			//$response->setStatus($newFile ? 201 : 200);
-			//$response->setBody($this->generateLockResponse($lockInfo));
-			$response->setStatus(200);
+
+			try {
+				$file = $this->fileService->getFileFromAbsoluteUri($this->server->getRequestUri());
+				$lockInfo = $this->lockService->lockFileAsUser($file, $this->userSession->getUser());
+				$response->setStatus(200);
+				$response->setBody($this->server->xml->write('{DAV:}prop', [
+					Application::DAV_PROPERTY_LOCK => true,
+					Application::DAV_PROPERTY_LOCK_OWNER_TYPE => $lockInfo->getLockType(),
+					Application::DAV_PROPERTY_LOCK_OWNER => $lockInfo->getOwner(),
+					Application::DAV_PROPERTY_LOCK_OWNER_DISPLAYNAME => $this->getLockDisplayName($lockInfo),
+					Application::DAV_PROPERTY_LOCK_EDITOR => $lockInfo->getOwner(),
+					Application::DAV_PROPERTY_LOCK_TIME => $lockInfo->getCreatedAt(),
+				]));
+			} catch (OwnerLockedException $e) {
+				$lockInfo = $e->getLock();
+				$response->setStatus(423);
+				$response->setBody($this->server->xml->write('{DAV:}prop', [
+					Application::DAV_PROPERTY_LOCK => true,
+					Application::DAV_PROPERTY_LOCK_OWNER_TYPE => $lockInfo->getLockType(),
+					Application::DAV_PROPERTY_LOCK_OWNER => $lockInfo->getOwner(),
+					Application::DAV_PROPERTY_LOCK_OWNER_DISPLAYNAME => $this->getLockDisplayName($lockInfo),
+					Application::DAV_PROPERTY_LOCK_EDITOR => $lockInfo->getOwner(),
+					Application::DAV_PROPERTY_LOCK_TIME => $lockInfo->getCreatedAt(),
+				]));
+			}
+
 			return false;
 		}
 		return parent::httpLock($request, $response);
 	}
 
 	public function httpUnlock(RequestInterface $request, ResponseInterface $response) {
 		if ($request->getHeader('X-User-Lock')) {
-			$file = $this->fileService->getFileFromAbsoluteUri($this->server->getRequestUri());
-			$this->lockService->unlockFile($file->getId(), $this->userSession->getUser()->getUID());
 			$response->setHeader('Content-Type', 'application/xml; charset=utf-8');
-			//$response->setHeader('Lock-Token', '<opaquelocktoken:'.$lockInfo->token.'>');
-			//$response->setStatus($newFile ? 201 : 200);
-			//$response->setBody($this->generateLockResponse($lockInfo));
-			$response->setStatus(200);
+
+			try {
+				$file = $this->fileService->getFileFromAbsoluteUri($this->server->getRequestUri());
+				$lockInfo = $this->lockService->unlockFile($file->getId(), $this->userSession->getUser()->getUID());
+				$response->setStatus(200);
+				$response->setBody($this->server->xml->write('{DAV:}prop', [
+					Application::DAV_PROPERTY_LOCK => false,
+					Application::DAV_PROPERTY_LOCK_OWNER_TYPE => null,
+					Application::DAV_PROPERTY_LOCK_OWNER => null,
+					Application::DAV_PROPERTY_LOCK_OWNER_DISPLAYNAME => null,
+					Application::DAV_PROPERTY_LOCK_EDITOR => null,
+					Application::DAV_PROPERTY_LOCK_TIME => null,
+				]));
+			} catch (LockNotFoundException $e) {
+				$response->setStatus(403);
+			} catch (UnauthorizedUnlockException $e) {
+				$response->setStatus(403);
+			} catch (InvalidPathException $e) {
+			} catch (NotFoundException $e) {
+			}
 			return false;
 		}
 		return parent::httpLock($request, $response);
diff --git a/lib/Exceptions/AlreadyLockedException.php b/lib/Exceptions/AlreadyLockedException.php
diff --git a/lib/Service/LockService.php b/lib/Service/LockService.php
@@ -31,30 +31,22 @@
 
 
 use Exception;
-use OCA\DAV\Connector\Sabre\Node as SabreNode;
-use OCA\FilesLock\AppInfo\Application;
 use OCA\FilesLock\Db\LocksRequest;
-use OCA\FilesLock\Exceptions\AlreadyLockedException;
 use OCA\FilesLock\Exceptions\LockNotFoundException;
 use OCA\FilesLock\Exceptions\NotFileException;
 use OCA\FilesLock\Exceptions\UnauthorizedUnlockException;
 use OCA\FilesLock\Model\FileLock;
 use OCA\FilesLock\Tools\Traits\TLogger;
 use OCA\FilesLock\Tools\Traits\TStringTools;
 use OCP\App\IAppManager;
-use OCP\DirectEditing\IManager;
-use OCP\DirectEditing\RegisterDirectEditorEvent;
-use OCP\EventDispatcher\IEventDispatcher;
 use OCP\Files\InvalidPathException;
+use OCP\Files\Lock\OwnerLockedException;
 use OCP\Files\Node;
 use OCP\Files\NotFoundException;
 use OCP\IL10N;
 use OCP\IUser;
 use OCP\IUserManager;
-use OCP\Notification\IApp;
 use OCP\PreConditionNotMetException;
-use Sabre\DAV\INode;
-use Sabre\DAV\PropFind;
 
 
 /**
@@ -129,16 +121,19 @@ public function getLockForNodeId(int $nodeId) {
 	/**
 	 * @param FileLock $lock
 	 *
-	 * @throws AlreadyLockedException
+	 * @throws OwnerLockedException
 	 */
 	public function lock(FileLock $lock) {
 		$this->generateToken($lock);
 		$this->notice('locking file', false, ['fileLock' => $lock]);
 
 		try {
 			$known = $this->getLockFromFileId($lock->getFileId());
-
-			throw new AlreadyLockedException('File is already locked by ' . $known->getOwner());
+			if ($known->getLockType() === $lock->getLockType() && $known->getOwner() === $lock->getOwner()) {
+				// TODO refresh
+				return;
+			}
+			throw new OwnerLockedException($known);
 		} catch (LockNotFoundException $e) {
 			$this->locksRequest->save($lock);
 		}
@@ -150,10 +145,10 @@ public function lock(FileLock $lock) {
 	 * @param IUser $user
 	 *
 	 * @return FileLock
-	 * @throws AlreadyLockedException
 	 * @throws InvalidPathException
 	 * @throws NotFileException
 	 * @throws NotFoundException
+	 * @throws OwnerLockedException
 	 */
 	public function lockFileAsUser(Node $file, IUser $user): FileLock {
 		if ($file->getType() !== Node::TYPE_FILE) {
