1 files changed, 82 insertions, 0 deletions
diff --git a/lib/public/Files/Lock/LockContext.php b/lib/public/Files/Lock/LockContext.php
new file mode 100644
index 00000000000..5e61d3e2ec5
--- /dev/null
+++ b/lib/public/Files/Lock/LockContext.php
@@ -0,0 +1,82 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\Files\Lock;
+
+use OCP\Files\Node;
+
+/**
+ * Structure to identify a specific lock context to request or
+ * describe a lock with the affected node and ownership information
+ *
+ * This is used to match a lock/unlock request or file operation to existing locks
+ *
+ * @since 24.0.0
+ */
+final class LockContext {
+	private Node $node;
+	private int $type;
+	private string $owner;
+
+	/**
+	 * @param Node $node Node that is owned by the lock
+	 * @param int $type Type of the lock owner
+	 * @param string $owner Unique identifier for the lock owner based on the type
+	 * @since 24.0.0
+	 */
+	public function __construct(
+		Node $node,
+		int $type,
+		string $owner,
+	) {
+		$this->node = $node;
+		$this->type = $type;
+		$this->owner = $owner;
+	}
+
+	/**
+	 * @since 24.0.0
+	 */
+	public function getNode(): Node {
+		return $this->node;
+	}
+
+	/**
+	 * @return int
+	 * @since 24.0.0
+	 */
+	public function getType(): int {
+		return $this->type;
+	}
+
+	/**
+	 * @return string user id / app id / lock token depending on the type
+	 * @since 24.0.0
+	 */
+	public function getOwner(): string {
+		return $this->owner;
+	}
+
+	/**
+	 * @since 24.0.0
+	 */
+	public function __toString(): string {
+		$typeString = 'unknown';
+		if ($this->type === ILock::TYPE_USER) {
+			$typeString = 'ILock::TYPE_USER';
+		}
+		if ($this->type === ILock::TYPE_APP) {
+			$typeString = 'ILock::TYPE_APP';
+		}
+		if ($this->type === ILock::TYPE_TOKEN) {
+			$typeString = 'ILock::TYPE_TOKEN';
+		}
+		return "$typeString  $this->owner " . $this->getNode()->getId();
+	}
+}