1 files changed, 297 insertions, 0 deletions
diff --git a/lib/private/OCM/Model/OCMProvider.php b/lib/private/OCM/Model/OCMProvider.php
new file mode 100644
index 00000000000..be13d65a40f
--- /dev/null
+++ b/lib/private/OCM/Model/OCMProvider.php
@@ -0,0 +1,297 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OC\OCM\Model;
+
+use NCU\Security\Signature\Model\Signatory;
+use OCP\EventDispatcher\IEventDispatcher;
+use OCP\IConfig;
+use OCP\OCM\Events\ResourceTypeRegisterEvent;
+use OCP\OCM\Exceptions\OCMArgumentException;
+use OCP\OCM\Exceptions\OCMProviderException;
+use OCP\OCM\ICapabilityAwareOCMProvider;
+use OCP\OCM\IOCMResource;
+
+/**
+ * @since 28.0.0
+ */
+class OCMProvider implements ICapabilityAwareOCMProvider {
+	private string $provider;
+	private bool $enabled = false;
+	private string $apiVersion = '';
+	private string $inviteAcceptDialog = '';
+	private array $capabilities = [];
+	private string $endPoint = '';
+	/** @var IOCMResource[] */
+	private array $resourceTypes = [];
+	private ?Signatory $signatory = null;
+	private bool $emittedEvent = false;
+
+	public function __construct(
+		protected IEventDispatcher $dispatcher,
+		protected IConfig $config,
+	) {
+		$this->provider = 'Nextcloud ' . $config->getSystemValue('version');
+	}
+
+	/**
+	 * @param bool $enabled
+	 *
+	 * @return $this
+	 */
+	public function setEnabled(bool $enabled): static {
+		$this->enabled = $enabled;
+
+		return $this;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function isEnabled(): bool {
+		return $this->enabled;
+	}
+
+	/**
+	 * @param string $apiVersion
+	 *
+	 * @return $this
+	 */
+	public function setApiVersion(string $apiVersion): static {
+		$this->apiVersion = $apiVersion;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getApiVersion(): string {
+		return $this->apiVersion;
+	}
+
+	/**
+	 * returns the invite accept dialog
+	 *
+	 * @return string
+	 * @since 32.0.0
+	 */
+	public function getInviteAcceptDialog(): string {
+		return $this->inviteAcceptDialog;
+	}
+
+	/**
+	 * set the invite accept dialog
+	 *
+	 * @param string $inviteAcceptDialog
+	 *
+	 * @return $this
+	 * @since 32.0.0
+	 */
+	public function setInviteAcceptDialog(string $inviteAcceptDialog): static {
+		$this->inviteAcceptDialog = $inviteAcceptDialog;
+
+		return $this;
+	}
+
+	/**
+	 * @param string $endPoint
+	 *
+	 * @return $this
+	 */
+	public function setEndPoint(string $endPoint): static {
+		$this->endPoint = $endPoint;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getEndPoint(): string {
+		return $this->endPoint;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getProvider(): string {
+		return $this->provider;
+	}
+
+	/**
+	 * @param array $capabilities
+	 *
+	 * @return $this
+	 */
+	public function setCapabilities(array $capabilities): static {
+		foreach ($capabilities as $value) {
+			if (!in_array($value, $this->capabilities)) {
+				array_push($this->capabilities, $value);
+			}
+		}
+
+		return $this;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getCapabilities(): array {
+		return $this->capabilities;
+	}
+	/**
+	 * create a new resource to later add it with {@see IOCMProvider::addResourceType()}
+	 * @return IOCMResource
+	 */
+	public function createNewResourceType(): IOCMResource {
+		return new OCMResource();
+	}
+
+	/**
+	 * @param IOCMResource $resource
+	 *
+	 * @return $this
+	 */
+	public function addResourceType(IOCMResource $resource): static {
+		$this->resourceTypes[] = $resource;
+
+		return $this;
+	}
+
+	/**
+	 * @param IOCMResource[] $resourceTypes
+	 *
+	 * @return $this
+	 */
+	public function setResourceTypes(array $resourceTypes): static {
+		$this->resourceTypes = $resourceTypes;
+
+		return $this;
+	}
+
+	/**
+	 * @return IOCMResource[]
+	 */
+	public function getResourceTypes(): array {
+		if (!$this->emittedEvent) {
+			$this->emittedEvent = true;
+			$event = new ResourceTypeRegisterEvent($this);
+			$this->dispatcher->dispatchTyped($event);
+		}
+
+		return $this->resourceTypes;
+	}
+
+	/**
+	 * @param string $resourceName
+	 * @param string $protocol
+	 *
+	 * @return string
+	 * @throws OCMArgumentException
+	 */
+	public function extractProtocolEntry(string $resourceName, string $protocol): string {
+		foreach ($this->getResourceTypes() as $resource) {
+			if ($resource->getName() === $resourceName) {
+				$entry = $resource->getProtocols()[$protocol] ?? null;
+				if (is_null($entry)) {
+					throw new OCMArgumentException('protocol not found');
+				}
+
+				return (string)$entry;
+			}
+		}
+
+		throw new OCMArgumentException('resource not found');
+	}
+
+	public function setSignatory(Signatory $signatory): void {
+		$this->signatory = $signatory;
+	}
+
+	public function getSignatory(): ?Signatory {
+		return $this->signatory;
+	}
+
+	/**
+	 * import data from an array
+	 *
+	 * @param array $data
+	 *
+	 * @return OCMProvider&static
+	 * @throws OCMProviderException in case a descent provider cannot be generated from data
+	 */
+	public function import(array $data): static {
+		$this->setEnabled(is_bool($data['enabled'] ?? '') ? $data['enabled'] : false)
+			// Fall back to old apiVersion for Nextcloud 30 compatibility
+			->setApiVersion((string)($data['version'] ?? $data['apiVersion'] ?? ''))
+			->setEndPoint($data['endPoint'] ?? '');
+
+		$resources = [];
+		foreach (($data['resourceTypes'] ?? []) as $resourceData) {
+			$resource = new OCMResource();
+			$resources[] = $resource->import($resourceData);
+		}
+		$this->setResourceTypes($resources);
+
+		if (isset($data['publicKey'])) {
+			// import details about the remote request signing public key, if available
+			$signatory = new Signatory();
+			$signatory->setKeyId($data['publicKey']['keyId'] ?? '');
+			$signatory->setPublicKey($data['publicKey']['publicKeyPem'] ?? '');
+			if ($signatory->getKeyId() !== '' && $signatory->getPublicKey() !== '') {
+				$this->setSignatory($signatory);
+			}
+		}
+
+		if (!$this->looksValid()) {
+			throw new OCMProviderException('remote provider does not look valid');
+		}
+
+		return $this;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function looksValid(): bool {
+		return ($this->getApiVersion() !== '' && $this->getEndPoint() !== '');
+	}
+
+	/**
+	 * @since 28.0.0
+	 */
+	public function jsonSerialize(): array {
+		$resourceTypes = [];
+		foreach ($this->getResourceTypes() as $res) {
+			$resourceTypes[] = $res->jsonSerialize();
+		}
+
+		$response = [
+			'enabled' => $this->isEnabled(),
+			'apiVersion' => '1.0-proposal1', // deprecated, but keep it to stay compatible with old version
+			'version' => $this->getApiVersion(), // informative but real version
+			'endPoint' => $this->getEndPoint(),
+			'publicKey' => $this->getSignatory()?->jsonSerialize(),
+			'resourceTypes' => $resourceTypes
+		];
+
+		$capabilities = $this->getCapabilities();
+		$inviteAcceptDialog = $this->getInviteAcceptDialog();
+		if ($capabilities) {
+			$response['capabilities'] = $capabilities;
+		}
+		if ($inviteAcceptDialog) {
+			$response['inviteAcceptDialog'] = $inviteAcceptDialog;
+		}
+		return $response;
+
+	}
+}