7 files changed, 433 insertions, 0 deletions
diff --git a/lib/public/OCM/Events/ResourceTypeRegisterEvent.php b/lib/public/OCM/Events/ResourceTypeRegisterEvent.php
new file mode 100644
index 00000000000..c0129197566
--- /dev/null
+++ b/lib/public/OCM/Events/ResourceTypeRegisterEvent.php
@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\OCM\Events;
+
+use OCP\EventDispatcher\Event;
+use OCP\OCM\IOCMProvider;
+
+/**
+ * Use this event to register additional OCM resources before the API returns
+ * them in the OCM provider list and capability
+ *
+ * @since 28.0.0
+ */
+class ResourceTypeRegisterEvent extends Event {
+	/**
+	 * @param IOCMProvider $provider
+	 * @since 28.0.0
+	 */
+	public function __construct(
+		protected IOCMProvider $provider,
+	) {
+		parent::__construct();
+	}
+
+	/**
+	 * @param string $name
+	 * @param list<string> $shareTypes List of supported share recipients, e.g. 'user', 'group', …
+	 * @param array<string, string> $protocols List of supported protocols and their location,
+	 *                                         e.g. ['webdav' => '/remote.php/webdav/']
+	 * @since 28.0.0
+	 */
+	public function registerResourceType(string $name, array $shareTypes, array $protocols): void {
+		$resourceType = $this->provider->createNewResourceType();
+		$resourceType->setName($name)
+			->setShareTypes($shareTypes)
+			->setProtocols($protocols);
+		$this->provider->addResourceType($resourceType);
+	}
+}
diff --git a/lib/public/OCM/Exceptions/OCMArgumentException.php b/lib/public/OCM/Exceptions/OCMArgumentException.php
new file mode 100644
index 00000000000..386c8c39b48
--- /dev/null
+++ b/lib/public/OCM/Exceptions/OCMArgumentException.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\OCM\Exceptions;
+
+use Exception;
+
+/**
+ * @since 28.0.0
+ */
+class OCMArgumentException extends Exception {
+}
diff --git a/lib/public/OCM/Exceptions/OCMProviderException.php b/lib/public/OCM/Exceptions/OCMProviderException.php
new file mode 100644
index 00000000000..b24f1d1e1b1
--- /dev/null
+++ b/lib/public/OCM/Exceptions/OCMProviderException.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\OCM\Exceptions;
+
+use Exception;
+
+/**
+ * @since 28.0.0
+ */
+class OCMProviderException extends Exception {
+}
diff --git a/lib/public/OCM/ICapabilityAwareOCMProvider.php b/lib/public/OCM/ICapabilityAwareOCMProvider.php
new file mode 100644
index 00000000000..ae290abd2f8
--- /dev/null
+++ b/lib/public/OCM/ICapabilityAwareOCMProvider.php
@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\OCM;
+
+/**
+ * Version 1.1 and 1.2 extensions to the Open Cloud Mesh Discovery API
+ * @link https://github.com/cs3org/OCM-API/
+ * @since 32.0.0
+ */
+interface ICapabilityAwareOCMProvider extends IOCMProvider {
+	/**
+	 * get the capabilities
+	 *
+	 * @return array
+	 * @since 32.0.0
+	 */
+	public function getCapabilities(): array;
+
+	/**
+	 * get the provider name
+	 *
+	 * @return string
+	 * @since 32.0.0
+	 */
+	public function getProvider(): string;
+
+	/**
+	 * returns the invite accept dialog
+	 *
+	 * @return string
+	 * @since 32.0.0
+	 */
+	public function getInviteAcceptDialog(): string;
+
+	/**
+	 * set the capabilities
+	 *
+	 * @param array $capabilities
+	 *
+	 * @return $this
+	 * @since 32.0.0
+	 */
+	public function setCapabilities(array $capabilities): static;
+
+	/**
+	 * set the invite accept dialog
+	 *
+	 * @param string $inviteAcceptDialog
+	 *
+	 * @return $this
+	 * @since 32.0.0
+	 */
+	public function setInviteAcceptDialog(string $inviteAcceptDialog): static;
+}
diff --git a/lib/public/OCM/IOCMDiscoveryService.php b/lib/public/OCM/IOCMDiscoveryService.php
new file mode 100644
index 00000000000..743c9d78958
--- /dev/null
+++ b/lib/public/OCM/IOCMDiscoveryService.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\OCM;
+
+use OCP\OCM\Exceptions\OCMProviderException;
+
+/**
+ * Discover remote OCM services
+ *
+ * @since 28.0.0
+ */
+interface IOCMDiscoveryService {
+	/**
+	 * Discover remote OCM services
+	 *
+	 * @param string $remote address of the remote provider
+	 * @param bool $skipCache ignore cache, refresh data
+	 *
+	 * @return IOCMProvider
+	 * @throws OCMProviderException if no valid discovery data can be returned
+	 * @since 28.0.0
+	 */
+	public function discover(string $remote, bool $skipCache = false): IOCMProvider;
+}
diff --git a/lib/public/OCM/IOCMProvider.php b/lib/public/OCM/IOCMProvider.php
new file mode 100644
index 00000000000..7141b0a9ab9
--- /dev/null
+++ b/lib/public/OCM/IOCMProvider.php
@@ -0,0 +1,169 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\OCM;
+
+use JsonSerializable;
+use OCP\OCM\Exceptions\OCMArgumentException;
+use OCP\OCM\Exceptions\OCMProviderException;
+
+/**
+ * Model based on the Open Cloud Mesh Discovery API
+ * @link https://github.com/cs3org/OCM-API/
+ * @since 28.0.0
+ * @deprecated 32.0.0 Please use {@see \OCP\OCM\ICapabilityAwareOCMProvider}
+ */
+interface IOCMProvider extends JsonSerializable {
+	/**
+	 * enable OCM
+	 *
+	 * @param bool $enabled
+	 *
+	 * @return $this
+	 * @since 28.0.0
+	 */
+	public function setEnabled(bool $enabled): static;
+
+	/**
+	 * is set as enabled ?
+	 *
+	 * @return bool
+	 * @since 28.0.0
+	 */
+	public function isEnabled(): bool;
+
+	/**
+	 * get set API Version
+	 *
+	 * @param string $apiVersion
+	 *
+	 * @return $this
+	 * @since 28.0.0
+	 */
+	public function setApiVersion(string $apiVersion): static;
+
+	/**
+	 * returns API version
+	 *
+	 * @return string
+	 * @since 28.0.0
+	 */
+	public function getApiVersion(): string;
+
+	/**
+	 * configure endpoint
+	 *
+	 * @param string $endPoint
+	 *
+	 * @return $this
+	 * @since 28.0.0
+	 */
+	public function setEndPoint(string $endPoint): static;
+
+	/**
+	 * get configured endpoint
+	 *
+	 * @return string
+	 * @since 28.0.0
+	 */
+	public function getEndPoint(): string;
+
+	/**
+	 * create a new resource to later add it with {@see addResourceType()}
+	 * @return IOCMResource
+	 * @since 28.0.0
+	 */
+	public function createNewResourceType(): IOCMResource;
+
+	/**
+	 * add a single resource to the object
+	 *
+	 * @param IOCMResource $resource
+	 *
+	 * @return $this
+	 * @since 28.0.0
+	 */
+	public function addResourceType(IOCMResource $resource): static;
+
+	/**
+	 * set resources
+	 *
+	 * @param IOCMResource[] $resourceTypes
+	 *
+	 * @return $this
+	 * @since 28.0.0
+	 */
+	public function setResourceTypes(array $resourceTypes): static;
+
+	/**
+	 * get all set resources
+	 *
+	 * @return IOCMResource[]
+	 * @since 28.0.0
+	 */
+	public function getResourceTypes(): array;
+
+	/**
+	 * extract a specific string value from the listing of protocols, based on resource-name and protocol-name
+	 *
+	 * @param string $resourceName
+	 * @param string $protocol
+	 *
+	 * @return string
+	 * @throws OCMArgumentException
+	 * @since 28.0.0
+	 */
+	public function extractProtocolEntry(string $resourceName, string $protocol): string;
+
+	//	/**
+	//	 * store signatory (public/private key pair) to sign outgoing/incoming request
+	//	 *
+	//	 * @param Signatory $signatory
+	//	 * @experimental 31.0.0
+	//	 */
+	//	public function setSignatory(Signatory $signatory): void;
+
+	//	/**
+	//	 * signatory (public/private key pair) used to sign outgoing/incoming request
+	//	 *
+	//	 * @return Signatory|null returns null if no Signatory available
+	//	 * @experimental 31.0.0
+	//	 */
+	//	public function getSignatory(): ?Signatory;
+
+	/**
+	 * import data from an array
+	 *
+	 * @param array<string, int|string|bool|array> $data
+	 *
+	 * @return $this
+	 * @throws OCMProviderException in case a descent provider cannot be generated from data
+	 * @since 28.0.0
+	 */
+	public function import(array $data): static;
+
+	/**
+	 * @return array{
+	 *     enabled: bool,
+	 *     apiVersion: '1.0-proposal1',
+	 *     endPoint: string,
+	 *     publicKey?: array{
+	 *         keyId: string,
+	 *         publicKeyPem: string
+	 *	   },
+	 *     resourceTypes: list<array{
+	 *         name: string,
+	 *         shareTypes: list<string>,
+	 *         protocols: array<string, string>
+	 *     }>,
+	 *     version: string
+	 * }
+	 * @since 28.0.0
+	 */
+	public function jsonSerialize(): array;
+}
diff --git a/lib/public/OCM/IOCMResource.php b/lib/public/OCM/IOCMResource.php
new file mode 100644
index 00000000000..60bf701e8ea
--- /dev/null
+++ b/lib/public/OCM/IOCMResource.php
@@ -0,0 +1,94 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\OCM;
+
+use JsonSerializable;
+
+/**
+ * Model based on the Open Cloud Mesh Discovery API
+ *
+ * @link https://github.com/cs3org/OCM-API/
+ * @since 28.0.0
+ */
+interface IOCMResource extends JsonSerializable {
+	/**
+	 * set name of the resource
+	 *
+	 * @param string $name
+	 *
+	 * @return $this
+	 * @since 28.0.0
+	 */
+	public function setName(string $name): static;
+
+	/**
+	 * get name of the resource
+	 *
+	 * @return string
+	 * @since 28.0.0
+	 */
+	public function getName(): string;
+
+	/**
+	 * set share types
+	 *
+	 * @param list<string> $shareTypes
+	 *
+	 * @return $this
+	 * @since 28.0.0
+	 */
+	public function setShareTypes(array $shareTypes): static;
+
+	/**
+	 * get share types
+	 *
+	 * @return list<string>
+	 * @since 28.0.0
+	 */
+	public function getShareTypes(): array;
+
+	/**
+	 * set available protocols
+	 *
+	 * @param array<string, string> $protocols
+	 *
+	 * @return $this
+	 * @since 28.0.0
+	 */
+	public function setProtocols(array $protocols): static;
+
+	/**
+	 * get configured protocols
+	 *
+	 * @return array<string, string>
+	 * @since 28.0.0
+	 */
+	public function getProtocols(): array;
+
+	/**
+	 * import data from an array
+	 *
+	 * @param array $data
+	 *
+	 * @return $this
+	 * @since 28.0.0
+	 */
+	public function import(array $data): static;
+
+	/**
+	 * @return array{
+	 *     name: string,
+	 *     shareTypes: list<string>,
+	 *     protocols: array<string, string>
+	 * }
+	 * @since 28.0.0
+	 */
+	public function jsonSerialize(): array;
+}