nextcloud / server

lib/public/Federation/ICloudFederationNotification.php

Indentation +20 added lines, -20 removed lines

@@ -23,25 +23,25 @@
 
 interface ICloudFederationNotification {
 
-	/**
-	 * add a message to the notification
-	 *
-	 * @param string $notificationType (e.g. SHARE_ACCEPTED)
-	 * @param string $resourceType (e.g. file, calendar, contact,...)
-	 * @param $providerId id of the share
-	 * @param array $notification , payload of the notification
-	 *
-	 * @return
-	 * @since 14.0.0
-	 */
-	public function setMessage($notificationType, $resourceType, $providerId, array $notification);
+    /**
+     * add a message to the notification
+     *
+     * @param string $notificationType (e.g. SHARE_ACCEPTED)
+     * @param string $resourceType (e.g. file, calendar, contact,...)
+     * @param $providerId id of the share
+     * @param array $notification , payload of the notification
+     *
+     * @return
+     * @since 14.0.0
+     */
+    public function setMessage($notificationType, $resourceType, $providerId, array $notification);
 
-	/**
-	 * get message, ready to send out
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getMessage();
+    /**
+     * get message, ready to send out
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getMessage();
 }

lib/private/Federation/CloudFederationShare.php

Indentation +298 added lines, -298 removed lines

@@ -25,328 +25,328 @@
 
 class CloudFederationShare implements ICloudFederationShare {
 
-	private $share = [
-		'shareWith' => '',
-		'shareType' => '',
-		'name' => '',
-		'resourceType' => '',
-		'description' => '',
-		'providerId' => '',
-		'owner' => '',
-		'ownerDisplayName' => '',
-		'sharedBy' => '',
-		'sharedByDisplayName' => '',
-		'protocol' => []
-	];
+    private $share = [
+        'shareWith' => '',
+        'shareType' => '',
+        'name' => '',
+        'resourceType' => '',
+        'description' => '',
+        'providerId' => '',
+        'owner' => '',
+        'ownerDisplayName' => '',
+        'sharedBy' => '',
+        'sharedByDisplayName' => '',
+        'protocol' => []
+    ];
 
-	/**
-	 * get a CloudFederationShare Object to prepare a share you want to send
-	 *
-	 * @param string $shareWith
-	 * @param string $name resource name (e.g. document.odt)
-	 * @param string $description share description (optional)
-	 * @param string $providerId resource UID on the provider side
-	 * @param string $owner provider specific UID of the user who owns the resource
-	 * @param string $ownerDisplayName display name of the user who shared the item
-	 * @param string $sharedBy provider specific UID of the user who shared the resource
-	 * @param string $sharedByDisplayName display name of the user who shared the resource
-	 * @param string $shareType ('group' or 'user' share)
-	 * @param string $resourceType ('file', 'calendar',...)
-	 * @param string $sharedSecret
-	 */
-	public function __construct($shareWith = '',
-								$name = '',
-								$description = '',
-								$providerId = '',
-								$owner = '',
-								$ownerDisplayName = '',
-								$sharedBy = '',
-								$sharedByDisplayName = '',
-								$shareType = '',
-								$resourceType = '',
-								$sharedSecret = ''
-	) {
-		$this->setShareWith($shareWith);
-		$this->setResourceName($name);
-		$this->setDescription($description);
-		$this->setProviderId($providerId);
-		$this->setOwner($owner);
-		$this->setOwnerDisplayName($ownerDisplayName);
-		$this->setSharedBy($sharedBy);
-		$this->setSharedByDisplayName($sharedByDisplayName);
-		$this->setProtocol([
-			'name' => 'webdav',
-			'options' => [
-				'sharedSecret' => $sharedSecret,
-				'permissions' => '{http://open-collaboration-services.org/ns}share-permissions'
-			]
-		]);
-		$this->setShareType($shareType);
-		$this->setResourceType($resourceType);
+    /**
+     * get a CloudFederationShare Object to prepare a share you want to send
+     *
+     * @param string $shareWith
+     * @param string $name resource name (e.g. document.odt)
+     * @param string $description share description (optional)
+     * @param string $providerId resource UID on the provider side
+     * @param string $owner provider specific UID of the user who owns the resource
+     * @param string $ownerDisplayName display name of the user who shared the item
+     * @param string $sharedBy provider specific UID of the user who shared the resource
+     * @param string $sharedByDisplayName display name of the user who shared the resource
+     * @param string $shareType ('group' or 'user' share)
+     * @param string $resourceType ('file', 'calendar',...)
+     * @param string $sharedSecret
+     */
+    public function __construct($shareWith = '',
+                                $name = '',
+                                $description = '',
+                                $providerId = '',
+                                $owner = '',
+                                $ownerDisplayName = '',
+                                $sharedBy = '',
+                                $sharedByDisplayName = '',
+                                $shareType = '',
+                                $resourceType = '',
+                                $sharedSecret = ''
+    ) {
+        $this->setShareWith($shareWith);
+        $this->setResourceName($name);
+        $this->setDescription($description);
+        $this->setProviderId($providerId);
+        $this->setOwner($owner);
+        $this->setOwnerDisplayName($ownerDisplayName);
+        $this->setSharedBy($sharedBy);
+        $this->setSharedByDisplayName($sharedByDisplayName);
+        $this->setProtocol([
+            'name' => 'webdav',
+            'options' => [
+                'sharedSecret' => $sharedSecret,
+                'permissions' => '{http://open-collaboration-services.org/ns}share-permissions'
+            ]
+        ]);
+        $this->setShareType($shareType);
+        $this->setResourceType($resourceType);
 
-	}
+    }
 
-	/**
-	 * set uid of the recipient
-	 *
-	 * @param string $user
-	 *
-	 * @since 14.0.0
-	 */
-	public function setShareWith($user) {
-		$this->share['shareWith'] = $user;
-	}
+    /**
+     * set uid of the recipient
+     *
+     * @param string $user
+     *
+     * @since 14.0.0
+     */
+    public function setShareWith($user) {
+        $this->share['shareWith'] = $user;
+    }
 
-	/**
-	 * set resource name (e.g. document.odt)
-	 *
-	 * @param string $name
-	 *
-	 * @since 14.0.0
-	 */
-	public function setResourceName($name) {
-		$this->share['name'] = $name;
-	}
+    /**
+     * set resource name (e.g. document.odt)
+     *
+     * @param string $name
+     *
+     * @since 14.0.0
+     */
+    public function setResourceName($name) {
+        $this->share['name'] = $name;
+    }
 
-	/**
-	 * set resource type (e.g. file, calendar, contact,...)
-	 *
-	 * @param string $resourceType
-	 *
-	 * @since 14.0.0
-	 */
-	public function setResourceType($resourceType) {
-		$this->share['resourceType'] = $resourceType;
-	}
+    /**
+     * set resource type (e.g. file, calendar, contact,...)
+     *
+     * @param string $resourceType
+     *
+     * @since 14.0.0
+     */
+    public function setResourceType($resourceType) {
+        $this->share['resourceType'] = $resourceType;
+    }
 
-	/**
-	 * set resource description (optional)
-	 *
-	 * @param string $description
-	 *
-	 * @since 14.0.0
-	 */
-	public function setDescription($description) {
-		$this->share['description'] = $description;
-	}
+    /**
+     * set resource description (optional)
+     *
+     * @param string $description
+     *
+     * @since 14.0.0
+     */
+    public function setDescription($description) {
+        $this->share['description'] = $description;
+    }
 
-	/**
-	 * set provider ID (e.g. file ID)
-	 *
-	 * @param string $providerId
-	 *
-	 * @since 14.0.0
-	 */
-	public function setProviderId($providerId) {
-		$this->share['providerId'] = $providerId;
-	}
+    /**
+     * set provider ID (e.g. file ID)
+     *
+     * @param string $providerId
+     *
+     * @since 14.0.0
+     */
+    public function setProviderId($providerId) {
+        $this->share['providerId'] = $providerId;
+    }
 
-	/**
-	 * set owner UID
-	 *
-	 * @param string $owner
-	 *
-	 * @since 14.0.0
-	 */
-	public function setOwner($owner) {
-		$this->share['owner'] = $owner;
-	}
+    /**
+     * set owner UID
+     *
+     * @param string $owner
+     *
+     * @since 14.0.0
+     */
+    public function setOwner($owner) {
+        $this->share['owner'] = $owner;
+    }
 
-	/**
-	 * set owner display name
-	 *
-	 * @param string $ownerDisplayName
-	 *
-	 * @since 14.0.0
-	 */
-	public function setOwnerDisplayName($ownerDisplayName) {
-		$this->share['ownerDisplayName'] = $ownerDisplayName;
-	}
+    /**
+     * set owner display name
+     *
+     * @param string $ownerDisplayName
+     *
+     * @since 14.0.0
+     */
+    public function setOwnerDisplayName($ownerDisplayName) {
+        $this->share['ownerDisplayName'] = $ownerDisplayName;
+    }
 
-	/**
-	 * set UID of the user who sends the share
-	 *
-	 * @param string $sharedBy
-	 *
-	 * @since 14.0.0
-	 */
-	public function setSharedBy($sharedBy) {
-		$this->share['sharedBy'] = $sharedBy;
-	}
+    /**
+     * set UID of the user who sends the share
+     *
+     * @param string $sharedBy
+     *
+     * @since 14.0.0
+     */
+    public function setSharedBy($sharedBy) {
+        $this->share['sharedBy'] = $sharedBy;
+    }
 
-	/**
-	 * set display name of the user who sends the share
-	 *
-	 * @param $sharedByDisplayName
-	 *
-	 * @since 14.0.0
-	 */
-	public function setSharedByDisplayName($sharedByDisplayName) {
-		$this->share['sharedByDisplayName'] = $sharedByDisplayName;
-	}
+    /**
+     * set display name of the user who sends the share
+     *
+     * @param $sharedByDisplayName
+     *
+     * @since 14.0.0
+     */
+    public function setSharedByDisplayName($sharedByDisplayName) {
+        $this->share['sharedByDisplayName'] = $sharedByDisplayName;
+    }
 
-	/**
-	 * set protocol specification
-	 *
-	 * @param array $protocol
-	 *
-	 * @since 14.0.0
-	 */
-	public function setProtocol(array $protocol) {
-		$this->share['protocol'] = $protocol;
-	}
+    /**
+     * set protocol specification
+     *
+     * @param array $protocol
+     *
+     * @since 14.0.0
+     */
+    public function setProtocol(array $protocol) {
+        $this->share['protocol'] = $protocol;
+    }
 
-	/**
-	 * share type (group or user)
-	 *
-	 * @param string $shareType
-	 *
-	 * @since 14.0.0
-	 */
-	public function setShareType($shareType) {
-		$this->share['shareType'] = $shareType;
-	}
+    /**
+     * share type (group or user)
+     *
+     * @param string $shareType
+     *
+     * @since 14.0.0
+     */
+    public function setShareType($shareType) {
+        $this->share['shareType'] = $shareType;
+    }
 
-	/**
-	 * get the whole share, ready to send out
-	 *
-	 * @return array
-	 *
-	 * @since 14.0.0
-	 */
-	public function getShare() {
-		return $this->share;
-	}
+    /**
+     * get the whole share, ready to send out
+     *
+     * @return array
+     *
+     * @since 14.0.0
+     */
+    public function getShare() {
+        return $this->share;
+    }
 
-	/**
-	 * get uid of the recipient
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getShareWith() {
-		return $this->share['shareWith'];
-	}
+    /**
+     * get uid of the recipient
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getShareWith() {
+        return $this->share['shareWith'];
+    }
 
-	/**
-	 * get resource name (e.g. file, calendar, contact,...)
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getResourceName() {
-		return $this->share['name'];
-	}
+    /**
+     * get resource name (e.g. file, calendar, contact,...)
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getResourceName() {
+        return $this->share['name'];
+    }
 
-	/**
-	 * get resource type (e.g. file, calendar, contact,...)
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getResourceType() {
-		return $this->share['resourceType'];
-	}
+    /**
+     * get resource type (e.g. file, calendar, contact,...)
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getResourceType() {
+        return $this->share['resourceType'];
+    }
 
-	/**
-	 * get resource description (optional)
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getDescription() {
-		return $this->share['description'];
-	}
+    /**
+     * get resource description (optional)
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getDescription() {
+        return $this->share['description'];
+    }
 
-	/**
-	 * get provider ID (e.g. file ID)
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getProviderId() {
-		return $this->share['providerId'];
-	}
+    /**
+     * get provider ID (e.g. file ID)
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getProviderId() {
+        return $this->share['providerId'];
+    }
 
-	/**
-	 * get owner UID
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getOwner() {
-		return $this->share['owner'];
-	}
+    /**
+     * get owner UID
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getOwner() {
+        return $this->share['owner'];
+    }
 
-	/**
-	 * get owner display name
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getOwnerDisplayName() {
-		return $this->share['ownerDisplayName'];
-	}
+    /**
+     * get owner display name
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getOwnerDisplayName() {
+        return $this->share['ownerDisplayName'];
+    }
 
-	/**
-	 * get UID of the user who sends the share
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getSharedBy() {
-		return $this->share['sharedBy'];
-	}
+    /**
+     * get UID of the user who sends the share
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getSharedBy() {
+        return $this->share['sharedBy'];
+    }
 
-	/**
-	 * get display name of the user who sends the share
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getSharedByDisplayName() {
-		return $this->share['sharedByDisplayName'];
-	}
+    /**
+     * get display name of the user who sends the share
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getSharedByDisplayName() {
+        return $this->share['sharedByDisplayName'];
+    }
 
-	/**
-	 * get share type (group or user)
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getShareType() {
-		return $this->share['shareType'];
-	}
+    /**
+     * get share type (group or user)
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getShareType() {
+        return $this->share['shareType'];
+    }
 
-	/**
-	 * get share Secret
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getShareSecret() {
-		return $this->share['protocol']['options']['sharedSecret'];
-	}
+    /**
+     * get share Secret
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getShareSecret() {
+        return $this->share['protocol']['options']['sharedSecret'];
+    }
 
-	/**
-	 * get protocol specification
-	 *
-	 * @return array
-	 *
-	 * @since 14.0.0
-	 */
-	public function getProtocol() {
-		return $this->share['protocol'];
-	}
+    /**
+     * get protocol specification
+     *
+     * @return array
+     *
+     * @since 14.0.0
+     */
+    public function getProtocol() {
+        return $this->share['protocol'];
+    }
 }

lib/private/Federation/CloudFederationProviderManager.php

Spacing +5 added lines, -5 removed lines

@@ -71,7 +71,7 @@ 
 								IClientService $httpClientService,
 								ICloudIdManager $cloudIdManager,
 								ILogger $logger) {
-		$this->cloudFederationProvider= [];
+		$this->cloudFederationProvider = [];
 		$this->appManager = $appManager;
 		$this->httpClientService = $httpClientService;
 		$this->cloudIdManager = $cloudIdManager;
@@ -140,7 +140,7 @@ 
 
 		$client = $this->httpClientService->newClient();
 		try {
-			$response = $client->post($ocmEndPoint . '/shares', [
+			$response = $client->post($ocmEndPoint.'/shares', [
 				'body' => $share->getShare(),
 				'timeout' => 10,
 				'connect_timeout' => 10,
@@ -177,7 +177,7 @@ 
 
 		$client = $this->httpClientService->newClient();
 		try {
-			$response = $client->post($ocmEndPoint . '/notifications', [
+			$response = $client->post($ocmEndPoint.'/notifications', [
 				'body' => $notification->getMessage(),
 				'timeout' => 10,
 				'connect_timeout' => 10,
@@ -187,7 +187,7 @@ 
 			}
 		} catch (\Exception $e) {
 			// log the error and return false
-			$this->logger->error('error while sending notification for federated share: ' . $e->getMessage());
+			$this->logger->error('error while sending notification for federated share: '.$e->getMessage());
 		}
 
 		return false;
@@ -210,7 +210,7 @@ 
 	protected function getOCMEndPoint($url) {
 		$client = $this->httpClientService->newClient();
 		try {
-			$response = $client->get($url . '/ocm-provider/', ['timeout' => 10, 'connect_timeout' => 10]);
+			$response = $client->get($url.'/ocm-provider/', ['timeout' => 10, 'connect_timeout' => 10]);
 		} catch (\Exception $e) {
 			return '';
 		}

Indentation +185 added lines, -185 removed lines

@@ -42,191 +42,191 @@
  */
 class CloudFederationProviderManager implements ICloudFederationProviderManager {
 
-	/** @var array list of available cloud federation providers */
-	private $cloudFederationProvider;
-
-	/** @var IAppManager */
-	private $appManager;
-
-	/** @var IClientService */
-	private $httpClientService;
-
-	/** @var ICloudIdManager */
-	private $cloudIdManager;
-
-	/** @var ILogger */
-	private $logger;
-
-	private $supportedAPIVersion = '1.0-proposal1';
-
-	/**
-	 * CloudFederationProviderManager constructor.
-	 *
-	 * @param IAppManager $appManager
-	 * @param IClientService $httpClientService
-	 * @param ICloudIdManager $cloudIdManager
-	 * @param ILogger $logger
-	 */
-	public function __construct(IAppManager $appManager,
-								IClientService $httpClientService,
-								ICloudIdManager $cloudIdManager,
-								ILogger $logger) {
-		$this->cloudFederationProvider= [];
-		$this->appManager = $appManager;
-		$this->httpClientService = $httpClientService;
-		$this->cloudIdManager = $cloudIdManager;
-		$this->logger = $logger;
-	}
-
-
-	/**
-	 * Registers an callback function which must return an cloud federation provider
-	 *
-	 * @param string $shareType which share type does the provider handles
-	 * @param string $displayName user facing name of the federated share provider
-	 * @param callable $callback
-	 */
-	public function addCloudFederationProvider($shareType, $displayName, callable $callback) {
-		\OC::$server->getRemoteApiFactory();
-
-		$this->cloudFederationProvider[$shareType] = [
-			'shareType' => $shareType,
-			'displayName' => $displayName,
-			'callback' => $callback,
-		];
-
-	}
-
-	/**
-	 * remove cloud federation provider
-	 *
-	 * @param string $providerId
-	 */
-	public function removeCloudFederationProvider($providerId) {
-		unset($this->cloudFederationProvider[$providerId]);
-	}
-
-	/**
-	 * get a list of all cloudFederationProviders
-	 *
-	 * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]]
-	 */
-	public function getAllCloudFederationProviders() {
-		return $this->cloudFederationProvider;
-	}
-
-	/**
-	 * get a specific cloud federation provider
-	 *
-	 * @param string $shareType
-	 * @return ICloudFederationProvider
-	 * @throws ProviderDoesNotExistsException
-	 */
-	public function getCloudFederationProvider($shareType) {
-		if (isset($this->cloudFederationProvider[$shareType])) {
-			return call_user_func($this->cloudFederationProvider[$shareType]['callback']);
-		} else {
-			throw new ProviderDoesNotExistsException($shareType);
-		}
-	}
-
-	public function sendShare(ICloudFederationShare $share) {
-		$cloudID = $this->cloudIdManager->resolveCloudId($share->getShareWith());
-		$ocmEndPoint = $this->getOCMEndPoint($cloudID->getRemote());
-
-		if (empty($ocmEndPoint)) {
-			return false;
-		}
-
-		$client = $this->httpClientService->newClient();
-		try {
-			$response = $client->post($ocmEndPoint . '/shares', [
-				'body' => $share->getShare(),
-				'timeout' => 10,
-				'connect_timeout' => 10,
-			]);
-
-			if ($response->getStatusCode() === Http::STATUS_CREATED) {
-				return true;
-			}
-
-		} catch (\Exception $e) {
-			// if flat re-sharing is not supported by the remote server
-			// we re-throw the exception and fall back to the old behaviour.
-			// (flat re-shares has been introduced in Nextcloud 9.1)
-			if ($e->getCode() === Http::STATUS_INTERNAL_SERVER_ERROR) {
-				throw $e;
-			}
-		}
-
-		return false;
-
-	}
-
-	/**
-	 * @param string $url
-	 * @param ICloudFederationNotification $notification
-	 * @return mixed
-	 */
-	public function sendNotification($url, ICloudFederationNotification $notification) {
-		$ocmEndPoint = $this->getOCMEndPoint($url);
-
-		if (empty($ocmEndPoint)) {
-			return false;
-		}
-
-		$client = $this->httpClientService->newClient();
-		try {
-			$response = $client->post($ocmEndPoint . '/notifications', [
-				'body' => $notification->getMessage(),
-				'timeout' => 10,
-				'connect_timeout' => 10,
-			]);
-			if ($response->getStatusCode() === Http::STATUS_CREATED) {
-				$result = json_decode($response->getBody(), true);
-				return (is_array($result)) ? $result : [];
-			}
-		} catch (\Exception $e) {
-			// log the error and return false
-			$this->logger->error('error while sending notification for federated share: ' . $e->getMessage());
-		}
-
-		return false;
-	}
-
-	/**
-	 * check if the new cloud federation API is ready to be used
-	 *
-	 * @return bool
-	 */
-	public function isReady() {
-		return $this->appManager->isEnabledForUser('cloud_federation_api', false);
-	}
-	/**
-	 * check if server supports the new OCM api and ask for the correct end-point
-	 *
-	 * @param string $url full base URL of the cloud server
-	 * @return string
-	 */
-	protected function getOCMEndPoint($url) {
-		$client = $this->httpClientService->newClient();
-		try {
-			$response = $client->get($url . '/ocm-provider/', ['timeout' => 10, 'connect_timeout' => 10]);
-		} catch (\Exception $e) {
-			return '';
-		}
-
-		$result = $response->getBody();
-		$result = json_decode($result, true);
-
-		$supportedVersion = isset($result['apiVersion']) && $result['apiVersion'] === $this->supportedAPIVersion;
-
-		if (isset($result['endPoint']) && $supportedVersion) {
-			return $result['endPoint'];
-		}
-
-		return '';
-	}
+    /** @var array list of available cloud federation providers */
+    private $cloudFederationProvider;
+
+    /** @var IAppManager */
+    private $appManager;
+
+    /** @var IClientService */
+    private $httpClientService;
+
+    /** @var ICloudIdManager */
+    private $cloudIdManager;
+
+    /** @var ILogger */
+    private $logger;
+
+    private $supportedAPIVersion = '1.0-proposal1';
+
+    /**
+     * CloudFederationProviderManager constructor.
+     *
+     * @param IAppManager $appManager
+     * @param IClientService $httpClientService
+     * @param ICloudIdManager $cloudIdManager
+     * @param ILogger $logger
+     */
+    public function __construct(IAppManager $appManager,
+                                IClientService $httpClientService,
+                                ICloudIdManager $cloudIdManager,
+                                ILogger $logger) {
+        $this->cloudFederationProvider= [];
+        $this->appManager = $appManager;
+        $this->httpClientService = $httpClientService;
+        $this->cloudIdManager = $cloudIdManager;
+        $this->logger = $logger;
+    }
+
+
+    /**
+     * Registers an callback function which must return an cloud federation provider
+     *
+     * @param string $shareType which share type does the provider handles
+     * @param string $displayName user facing name of the federated share provider
+     * @param callable $callback
+     */
+    public function addCloudFederationProvider($shareType, $displayName, callable $callback) {
+        \OC::$server->getRemoteApiFactory();
+
+        $this->cloudFederationProvider[$shareType] = [
+            'shareType' => $shareType,
+            'displayName' => $displayName,
+            'callback' => $callback,
+        ];
+
+    }
+
+    /**
+     * remove cloud federation provider
+     *
+     * @param string $providerId
+     */
+    public function removeCloudFederationProvider($providerId) {
+        unset($this->cloudFederationProvider[$providerId]);
+    }
+
+    /**
+     * get a list of all cloudFederationProviders
+     *
+     * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]]
+     */
+    public function getAllCloudFederationProviders() {
+        return $this->cloudFederationProvider;
+    }
+
+    /**
+     * get a specific cloud federation provider
+     *
+     * @param string $shareType
+     * @return ICloudFederationProvider
+     * @throws ProviderDoesNotExistsException
+     */
+    public function getCloudFederationProvider($shareType) {
+        if (isset($this->cloudFederationProvider[$shareType])) {
+            return call_user_func($this->cloudFederationProvider[$shareType]['callback']);
+        } else {
+            throw new ProviderDoesNotExistsException($shareType);
+        }
+    }
+
+    public function sendShare(ICloudFederationShare $share) {
+        $cloudID = $this->cloudIdManager->resolveCloudId($share->getShareWith());
+        $ocmEndPoint = $this->getOCMEndPoint($cloudID->getRemote());
+
+        if (empty($ocmEndPoint)) {
+            return false;
+        }
+
+        $client = $this->httpClientService->newClient();
+        try {
+            $response = $client->post($ocmEndPoint . '/shares', [
+                'body' => $share->getShare(),
+                'timeout' => 10,
+                'connect_timeout' => 10,
+            ]);
+
+            if ($response->getStatusCode() === Http::STATUS_CREATED) {
+                return true;
+            }
+
+        } catch (\Exception $e) {
+            // if flat re-sharing is not supported by the remote server
+            // we re-throw the exception and fall back to the old behaviour.
+            // (flat re-shares has been introduced in Nextcloud 9.1)
+            if ($e->getCode() === Http::STATUS_INTERNAL_SERVER_ERROR) {
+                throw $e;
+            }
+        }
+
+        return false;
+
+    }
+
+    /**
+     * @param string $url
+     * @param ICloudFederationNotification $notification
+     * @return mixed
+     */
+    public function sendNotification($url, ICloudFederationNotification $notification) {
+        $ocmEndPoint = $this->getOCMEndPoint($url);
+
+        if (empty($ocmEndPoint)) {
+            return false;
+        }
+
+        $client = $this->httpClientService->newClient();
+        try {
+            $response = $client->post($ocmEndPoint . '/notifications', [
+                'body' => $notification->getMessage(),
+                'timeout' => 10,
+                'connect_timeout' => 10,
+            ]);
+            if ($response->getStatusCode() === Http::STATUS_CREATED) {
+                $result = json_decode($response->getBody(), true);
+                return (is_array($result)) ? $result : [];
+            }
+        } catch (\Exception $e) {
+            // log the error and return false
+            $this->logger->error('error while sending notification for federated share: ' . $e->getMessage());
+        }
+
+        return false;
+    }
+
+    /**
+     * check if the new cloud federation API is ready to be used
+     *
+     * @return bool
+     */
+    public function isReady() {
+        return $this->appManager->isEnabledForUser('cloud_federation_api', false);
+    }
+    /**
+     * check if server supports the new OCM api and ask for the correct end-point
+     *
+     * @param string $url full base URL of the cloud server
+     * @return string
+     */
+    protected function getOCMEndPoint($url) {
+        $client = $this->httpClientService->newClient();
+        try {
+            $response = $client->get($url . '/ocm-provider/', ['timeout' => 10, 'connect_timeout' => 10]);
+        } catch (\Exception $e) {
+            return '';
+        }
+
+        $result = $response->getBody();
+        $result = json_decode($result, true);
+
+        $supportedVersion = isset($result['apiVersion']) && $result['apiVersion'] === $this->supportedAPIVersion;
+
+        if (isset($result['endPoint']) && $supportedVersion) {
+            return $result['endPoint'];
+        }
+
+        return '';
+    }
 
 
 }

lib/private/Federation/CloudFederationNotification.php

Indentation +29 added lines, -29 removed lines

@@ -25,36 +25,36 @@
 
 class CloudFederationNotification implements ICloudFederationNotification {
 
-	private $message = [];
+    private $message = [];
 
-	/**
-	 * add a message to the notification
-	 *
-	 * @param string $notificationType (e.g. SHARE_ACCEPTED)
-	 * @param string $resourceType (e.g. file, calendar, contact,...)
-	 * @param string $providerId id of the share
-	 * @param array $notification payload of the notification
-	 *
-	 * @since 14.0.0
-	 */
-	public function setMessage($notificationType, $resourceType, $providerId, array $notification) {
-		$this->message = [
-			'notificationType' => $notificationType,
-			'resourceType' => $resourceType,
-			'providerId' => $providerId,
-			'notification' => $notification,
-		];
+    /**
+     * add a message to the notification
+     *
+     * @param string $notificationType (e.g. SHARE_ACCEPTED)
+     * @param string $resourceType (e.g. file, calendar, contact,...)
+     * @param string $providerId id of the share
+     * @param array $notification payload of the notification
+     *
+     * @since 14.0.0
+     */
+    public function setMessage($notificationType, $resourceType, $providerId, array $notification) {
+        $this->message = [
+            'notificationType' => $notificationType,
+            'resourceType' => $resourceType,
+            'providerId' => $providerId,
+            'notification' => $notification,
+        ];
 
-	}
+    }
 
-	/**
-	 * get message, ready to send out
-	 *
-	 * @return array
-	 *
-	 * @since 14.0.0
-	 */
-	public function getMessage() {
-		return $this->message;
-	}
+    /**
+     * get message, ready to send out
+     *
+     * @return array
+     *
+     * @since 14.0.0
+     */
+    public function getMessage() {
+        return $this->message;
+    }
 }

lib/private/Federation/CloudFederationFactory.php

Indentation +32 added lines, -32 removed lines

@@ -27,37 +27,37 @@
 
 class CloudFederationFactory implements ICloudFederationFactory {
 
-	/**
-	 * get a CloudFederationShare Object to prepare a share you want to send
-	 *
-	 * @param string $shareWith
-	 * @param string $name resource name (e.g. document.odt)
-	 * @param string $description share description (optional)
-	 * @param string $providerId resource UID on the provider side
-	 * @param string $owner provider specific UID of the user who owns the resource
-	 * @param string $ownerDisplayName display name of the user who shared the item
-	 * @param string $sharedBy provider specific UID of the user who shared the resource
-	 * @param string $sharedByDisplayName display name of the user who shared the resource
-	 * @param string $sharedSecret used to authenticate requests across servers
-	 * @param string $shareType ('group' or 'user' share)
-	 * @param $resourceType ('file', 'calendar',...)
-	 * @return ICloudFederationShare
-	 *
-	 * @since 14.0.0
-	 */
-	public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $sharedSecret, $shareType, $resourceType) {
-		return new CloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $shareType, $resourceType, $sharedSecret);
-	}
+    /**
+     * get a CloudFederationShare Object to prepare a share you want to send
+     *
+     * @param string $shareWith
+     * @param string $name resource name (e.g. document.odt)
+     * @param string $description share description (optional)
+     * @param string $providerId resource UID on the provider side
+     * @param string $owner provider specific UID of the user who owns the resource
+     * @param string $ownerDisplayName display name of the user who shared the item
+     * @param string $sharedBy provider specific UID of the user who shared the resource
+     * @param string $sharedByDisplayName display name of the user who shared the resource
+     * @param string $sharedSecret used to authenticate requests across servers
+     * @param string $shareType ('group' or 'user' share)
+     * @param $resourceType ('file', 'calendar',...)
+     * @return ICloudFederationShare
+     *
+     * @since 14.0.0
+     */
+    public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $sharedSecret, $shareType, $resourceType) {
+        return new CloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $shareType, $resourceType, $sharedSecret);
+    }
 
-	/**
-	 * get a Cloud FederationNotification object to prepare a notification you
-	 * want to send
-	 *
-	 * @return ICloudFederationNotification
-	 *
-	 * @since 14.0.0
-	 */
-	public function getCloudFederationNotification() {
-		return new CloudFederationNotification();
-	}
+    /**
+     * get a Cloud FederationNotification object to prepare a notification you
+     * want to send
+     *
+     * @return ICloudFederationNotification
+     *
+     * @since 14.0.0
+     */
+    public function getCloudFederationNotification() {
+        return new CloudFederationNotification();
+    }
 }

lib/public/Federation/Exceptions/AuthenticationFailedException.php

Doc Comments -1 removed lines

@@ -28,7 +28,6 @@
 	/**
 	 * BadRequestException constructor.
 	 *
-	 * @param array $missingParameters
 	 */
 	public function __construct() {
 		$l = \OC::$server->getL10N('federation');

Indentation +11 added lines, -11 removed lines

@@ -25,16 +25,16 @@
 
 class AuthenticationFailedException extends HintException {
 
-	/**
-	 * BadRequestException constructor.
-	 *
-	 * @param array $missingParameters
-	 */
-	public function __construct() {
-		$l = \OC::$server->getL10N('federation');
-		$message = 'Authentication failed, wrong token or provider ID given';
-		$hint = $l->t('Authentication failed, wrong token or provider ID given');
-		parent::__construct($message, $hint);
-	}
+    /**
+     * BadRequestException constructor.
+     *
+     * @param array $missingParameters
+     */
+    public function __construct() {
+        $l = \OC::$server->getL10N('federation');
+        $message = 'Authentication failed, wrong token or provider ID given';
+        $hint = $l->t('Authentication failed, wrong token or provider ID given');
+        parent::__construct($message, $hint);
+    }
 
 }

lib/public/Federation/Exceptions/BadRequestException.php

Indentation +33 added lines, -33 removed lines

@@ -25,42 +25,42 @@
 
 class BadRequestException extends HintException {
 
-	private $parameterList;
+    private $parameterList;
 
-	/**
-	 * BadRequestException constructor.
-	 *
-	 * @param array $missingParameters
-	 */
-	public function __construct(array $missingParameters) {
-		$l = \OC::$server->getL10N('federation');
-		$this->parameterList = $missingParameters;
-		$parameterList = implode(',', $missingParameters);
-		$message = 'Parameters missing in order to complete the request. Missing Parameters: ' . $parameterList;
-		$hint = $l->t('Parameters missing in order to complete the request. Missing Parameters: "%s"', [$parameterList]);
-		parent::__construct($message, $hint);
-	}
+    /**
+     * BadRequestException constructor.
+     *
+     * @param array $missingParameters
+     */
+    public function __construct(array $missingParameters) {
+        $l = \OC::$server->getL10N('federation');
+        $this->parameterList = $missingParameters;
+        $parameterList = implode(',', $missingParameters);
+        $message = 'Parameters missing in order to complete the request. Missing Parameters: ' . $parameterList;
+        $hint = $l->t('Parameters missing in order to complete the request. Missing Parameters: "%s"', [$parameterList]);
+        parent::__construct($message, $hint);
+    }
 
-	/**
-	 * get array with the return message as defined in the OCM API
-	 *
-	 * @return array
-	 */
-	public function getReturnMessage() {
-		$result = [
-			'message' => 'RESOURCE_NOT_FOUND',
-			'validationErrors' =>[
-			]
-		];
+    /**
+     * get array with the return message as defined in the OCM API
+     *
+     * @return array
+     */
+    public function getReturnMessage() {
+        $result = [
+            'message' => 'RESOURCE_NOT_FOUND',
+            'validationErrors' =>[
+            ]
+        ];
 
-		foreach ($this->parameterList as $missingParameter) {
-			$result['validationErrors'] = [
-				'name' => $missingParameter,
-				'message' => 'NOT_FOUND'
-			];
-		}
+        foreach ($this->parameterList as $missingParameter) {
+            $result['validationErrors'] = [
+                'name' => $missingParameter,
+                'message' => 'NOT_FOUND'
+            ];
+        }
 
-		return $result;
-	}
+        return $result;
+    }
 
 }

Spacing +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
 		$l = \OC::$server->getL10N('federation');
 		$this->parameterList = $missingParameters;
 		$parameterList = implode(',', $missingParameters);
-		$message = 'Parameters missing in order to complete the request. Missing Parameters: ' . $parameterList;
+		$message = 'Parameters missing in order to complete the request. Missing Parameters: '.$parameterList;
 		$hint = $l->t('Parameters missing in order to complete the request. Missing Parameters: "%s"', [$parameterList]);
 		parent::__construct($message, $hint);
 	}

lib/public/Share/IShareProvider.php

Indentation +168 added lines, -168 removed lines

@@ -36,172 +36,172 @@
  */
 interface IShareProvider {
 
-	/**
-	 * Return the identifier of this provider.
-	 *
-	 * @return string Containing only [a-zA-Z0-9]
-	 * @since 9.0.0
-	 */
-	public function identifier();
-
-	/**
-	 * Create a share
-	 *
-	 * @param \OCP\Share\IShare $share
-	 * @return \OCP\Share\IShare The share object
-	 * @since 9.0.0
-	 */
-	public function create(\OCP\Share\IShare $share);
-
-	/**
-	 * Update a share
-	 *
-	 * @param \OCP\Share\IShare $share
-	 * @return \OCP\Share\IShare The share object
-	 * @since 9.0.0
-	 */
-	public function update(\OCP\Share\IShare $share);
-
-	/**
-	 * Delete a share
-	 *
-	 * @param \OCP\Share\IShare $share
-	 * @since 9.0.0
-	 */
-	public function delete(\OCP\Share\IShare $share);
-
-	/**
-	 * Unshare a file from self as recipient.
-	 * This may require special handling. If a user unshares a group
-	 * share from their self then the original group share should still exist.
-	 *
-	 * @param \OCP\Share\IShare $share
-	 * @param string $recipient UserId of the recipient
-	 * @since 9.0.0
-	 */
-	public function deleteFromSelf(\OCP\Share\IShare $share, $recipient);
-
-	/**
-	 * Move a share as a recipient.
-	 * This is updating the share target. Thus the mount point of the recipient.
-	 * This may require special handling. If a user moves a group share
-	 * the target should only be changed for them.
-	 *
-	 * @param \OCP\Share\IShare $share
-	 * @param string $recipient userId of recipient
-	 * @return \OCP\Share\IShare
-	 * @since 9.0.0
-	 */
-	public function move(\OCP\Share\IShare $share, $recipient);
-
-	/**
-	 * Get all shares by the given user in a folder
-	 *
-	 * @param string $userId
-	 * @param Folder $node
-	 * @param bool $reshares Also get the shares where $user is the owner instead of just the shares where $user is the initiator
-	 * @return \OCP\Share\IShare[]
-	 * @since 11.0.0
-	 */
-	public function getSharesInFolder($userId, Folder $node, $reshares);
-
-	/**
-	 * Get all shares by the given user
-	 *
-	 * @param string $userId
-	 * @param int $shareType
-	 * @param Node|null $node
-	 * @param bool $reshares Also get the shares where $user is the owner instead of just the shares where $user is the initiator
-	 * @param int $limit The maximum number of shares to be returned, -1 for all shares
-	 * @param int $offset
-	 * @return \OCP\Share\IShare[]
-	 * @since 9.0.0
-	 */
-	public function getSharesBy($userId, $shareType, $node, $reshares, $limit, $offset);
-
-	/**
-	 * Get share by id
-	 *
-	 * @param int $id
-	 * @param string|null $recipientId
-	 * @return \OCP\Share\IShare
-	 * @throws ShareNotFoundException
-	 * @since 9.0.0
-	 */
-	public function getShareById($id, $recipientId = null);
-
-	/**
-	 * Get shares for a given path
-	 *
-	 * @param Node $path
-	 * @return \OCP\Share\IShare[]
-	 * @since 9.0.0
-	 */
-	public function getSharesByPath(Node $path);
-
-	/**
-	 * Get shared with the given user
-	 *
-	 * @param string $userId get shares where this user is the recipient
-	 * @param int $shareType
-	 * @param Node|null $node
-	 * @param int $limit The max number of entries returned, -1 for all
-	 * @param int $offset
-	 * @return \OCP\Share\IShare[]
-	 * @since 9.0.0
-	 */
-	public function getSharedWith($userId, $shareType, $node, $limit, $offset);
-
-	/**
-	 * Get a share by token
-	 *
-	 * @param string $token
-	 * @return \OCP\Share\IShare
-	 * @throws ShareNotFound
-	 * @since 9.0.0
-	 */
-	public function getShareByToken($token);
-
-	/**
-	 * A user is deleted from the system
-	 * So clean up the relevant shares.
-	 *
-	 * @param string $uid
-	 * @param int $shareType
-	 * @since 9.1.0
-	 */
-	public function userDeleted($uid, $shareType);
-
-	/**
-	 * A group is deleted from the system.
-	 * We have to clean up all shares to this group.
-	 * Providers not handling group shares should just return
-	 *
-	 * @param string $gid
-	 * @since 9.1.0
-	 */
-	public function groupDeleted($gid);
-
-	/**
-	 * A user is deleted from a group
-	 * We have to clean up all the related user specific group shares
-	 * Providers not handling group shares should just return
-	 *
-	 * @param string $uid
-	 * @param string $gid
-	 * @since 9.1.0
-	 */
-	public function userDeletedFromGroup($uid, $gid);
-
-	/**
-	 * Get the access list to the array of provided nodes.
-	 *
-	 * @see IManager::getAccessList() for sample docs
-	 *
-	 * @param Node[] $nodes The list of nodes to get access for
-	 * @param bool $currentAccess If current access is required (like for removed shares that might get revived later)
-	 * @return array
-	 * @since 12
-	 */
-	public function getAccessList($nodes, $currentAccess);
+    /**
+     * Return the identifier of this provider.
+     *
+     * @return string Containing only [a-zA-Z0-9]
+     * @since 9.0.0
+     */
+    public function identifier();
+
+    /**
+     * Create a share
+     *
+     * @param \OCP\Share\IShare $share
+     * @return \OCP\Share\IShare The share object
+     * @since 9.0.0
+     */
+    public function create(\OCP\Share\IShare $share);
+
+    /**
+     * Update a share
+     *
+     * @param \OCP\Share\IShare $share
+     * @return \OCP\Share\IShare The share object
+     * @since 9.0.0
+     */
+    public function update(\OCP\Share\IShare $share);
+
+    /**
+     * Delete a share
+     *
+     * @param \OCP\Share\IShare $share
+     * @since 9.0.0
+     */
+    public function delete(\OCP\Share\IShare $share);
+
+    /**
+     * Unshare a file from self as recipient.
+     * This may require special handling. If a user unshares a group
+     * share from their self then the original group share should still exist.
+     *
+     * @param \OCP\Share\IShare $share
+     * @param string $recipient UserId of the recipient
+     * @since 9.0.0
+     */
+    public function deleteFromSelf(\OCP\Share\IShare $share, $recipient);
+
+    /**
+     * Move a share as a recipient.
+     * This is updating the share target. Thus the mount point of the recipient.
+     * This may require special handling. If a user moves a group share
+     * the target should only be changed for them.
+     *
+     * @param \OCP\Share\IShare $share
+     * @param string $recipient userId of recipient
+     * @return \OCP\Share\IShare
+     * @since 9.0.0
+     */
+    public function move(\OCP\Share\IShare $share, $recipient);
+
+    /**
+     * Get all shares by the given user in a folder
+     *
+     * @param string $userId
+     * @param Folder $node
+     * @param bool $reshares Also get the shares where $user is the owner instead of just the shares where $user is the initiator
+     * @return \OCP\Share\IShare[]
+     * @since 11.0.0
+     */
+    public function getSharesInFolder($userId, Folder $node, $reshares);
+
+    /**
+     * Get all shares by the given user
+     *
+     * @param string $userId
+     * @param int $shareType
+     * @param Node|null $node
+     * @param bool $reshares Also get the shares where $user is the owner instead of just the shares where $user is the initiator
+     * @param int $limit The maximum number of shares to be returned, -1 for all shares
+     * @param int $offset
+     * @return \OCP\Share\IShare[]
+     * @since 9.0.0
+     */
+    public function getSharesBy($userId, $shareType, $node, $reshares, $limit, $offset);
+
+    /**
+     * Get share by id
+     *
+     * @param int $id
+     * @param string|null $recipientId
+     * @return \OCP\Share\IShare
+     * @throws ShareNotFoundException
+     * @since 9.0.0
+     */
+    public function getShareById($id, $recipientId = null);
+
+    /**
+     * Get shares for a given path
+     *
+     * @param Node $path
+     * @return \OCP\Share\IShare[]
+     * @since 9.0.0
+     */
+    public function getSharesByPath(Node $path);
+
+    /**
+     * Get shared with the given user
+     *
+     * @param string $userId get shares where this user is the recipient
+     * @param int $shareType
+     * @param Node|null $node
+     * @param int $limit The max number of entries returned, -1 for all
+     * @param int $offset
+     * @return \OCP\Share\IShare[]
+     * @since 9.0.0
+     */
+    public function getSharedWith($userId, $shareType, $node, $limit, $offset);
+
+    /**
+     * Get a share by token
+     *
+     * @param string $token
+     * @return \OCP\Share\IShare
+     * @throws ShareNotFound
+     * @since 9.0.0
+     */
+    public function getShareByToken($token);
+
+    /**
+     * A user is deleted from the system
+     * So clean up the relevant shares.
+     *
+     * @param string $uid
+     * @param int $shareType
+     * @since 9.1.0
+     */
+    public function userDeleted($uid, $shareType);
+
+    /**
+     * A group is deleted from the system.
+     * We have to clean up all shares to this group.
+     * Providers not handling group shares should just return
+     *
+     * @param string $gid
+     * @since 9.1.0
+     */
+    public function groupDeleted($gid);
+
+    /**
+     * A user is deleted from a group
+     * We have to clean up all the related user specific group shares
+     * Providers not handling group shares should just return
+     *
+     * @param string $uid
+     * @param string $gid
+     * @since 9.1.0
+     */
+    public function userDeletedFromGroup($uid, $gid);
+
+    /**
+     * Get the access list to the array of provided nodes.
+     *
+     * @see IManager::getAccessList() for sample docs
+     *
+     * @param Node[] $nodes The list of nodes to get access for
+     * @param bool $currentAccess If current access is required (like for removed shares that might get revived later)
+     * @return array
+     * @since 12
+     */
+    public function getAccessList($nodes, $currentAccess);
 }

apps/cloud_federation_api/lib/Capabilities.php

Indentation +30 added lines, -30 removed lines

@@ -28,37 +28,37 @@
 
 class Capabilities implements ICapability {
 
-	/** @var IURLGenerator */
-	private $urlGenerator;
+    /** @var IURLGenerator */
+    private $urlGenerator;
 
-	public function __construct(IURLGenerator $urlGenerator) {
-		$this->urlGenerator = $urlGenerator;
-	}
+    public function __construct(IURLGenerator $urlGenerator) {
+        $this->urlGenerator = $urlGenerator;
+    }
 
-	/**
-	 * Function an app uses to return the capabilities
-	 *
-	 * @return array Array containing the apps capabilities
-	 * @since 8.2.0
-	 */
-	public function getCapabilities() {
-		$url = $this->urlGenerator->linkToRouteAbsolute('cloud_federation_api.requesthandlercontroller.addShare');
-		$capabilities = ['ocm' =>
-			[
-				'enabled' => true,
-				'apiVersion' => '1.0-proposal1',
-				'endPoint' => substr($url, 0, strrpos($url, '/')),
-				'shareTypes' => [
-					[
-						'name' => 'file',
-						'protocols' => [
-							'webdav' => '/public.php/webdav/',
-						]
-					],
-				]
-			]
-		];
+    /**
+     * Function an app uses to return the capabilities
+     *
+     * @return array Array containing the apps capabilities
+     * @since 8.2.0
+     */
+    public function getCapabilities() {
+        $url = $this->urlGenerator->linkToRouteAbsolute('cloud_federation_api.requesthandlercontroller.addShare');
+        $capabilities = ['ocm' =>
+            [
+                'enabled' => true,
+                'apiVersion' => '1.0-proposal1',
+                'endPoint' => substr($url, 0, strrpos($url, '/')),
+                'shareTypes' => [
+                    [
+                        'name' => 'file',
+                        'protocols' => [
+                            'webdav' => '/public.php/webdav/',
+                        ]
+                    ],
+                ]
+            ]
+        ];
 
-		return $capabilities;
-	}
+        return $capabilities;
+    }
 }