nextcloud / server

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();
+    }
 }

apps/federatedfilesharing/lib/Notifications.php

Indentation +354 added lines, -354 removed lines

@@ -33,358 +33,358 @@
 use OCP\OCS\IDiscoveryService;
 
 class Notifications {
-	const RESPONSE_FORMAT = 'json'; // default response format for ocs calls
-
-	/** @var AddressHandler */
-	private $addressHandler;
-
-	/** @var IClientService */
-	private $httpClientService;
-
-	/** @var IDiscoveryService */
-	private $discoveryService;
-
-	/** @var IJobList  */
-	private $jobList;
-
-	/** @var ICloudFederationProviderManager */
-	private $federationProviderManager;
-
-	/** @var ICloudFederationFactory */
-	private $cloudFederationFactory;
-
-	/**
-	 * @param AddressHandler $addressHandler
-	 * @param IClientService $httpClientService
-	 * @param IDiscoveryService $discoveryService
-	 * @param IJobList $jobList
-	 * @param ICloudFederationProviderManager $federationProviderManager
-	 * @param ICloudFederationFactory $cloudFederationFactory
-	 */
-	public function __construct(
-		AddressHandler $addressHandler,
-		IClientService $httpClientService,
-		IDiscoveryService $discoveryService,
-		IJobList $jobList,
-		ICloudFederationProviderManager $federationProviderManager,
-		ICloudFederationFactory $cloudFederationFactory
-	) {
-		$this->addressHandler = $addressHandler;
-		$this->httpClientService = $httpClientService;
-		$this->discoveryService = $discoveryService;
-		$this->jobList = $jobList;
-		$this->federationProviderManager = $federationProviderManager;
-		$this->cloudFederationFactory = $cloudFederationFactory;
-	}
-
-	/**
-	 * send server-to-server share to remote server
-	 *
-	 * @param string $token
-	 * @param string $shareWith
-	 * @param string $name
-	 * @param int $remote_id
-	 * @param string $owner
-	 * @param string $ownerFederatedId
-	 * @param string $sharedBy
-	 * @param string $sharedByFederatedId
-	 * @return bool
-	 * @throws \OC\HintException
-	 * @throws \OC\ServerNotAvailableException
-	 */
-	public function sendRemoteShare($token, $shareWith, $name, $remote_id, $owner, $ownerFederatedId, $sharedBy, $sharedByFederatedId) {
-
-		list($user, $remote) = $this->addressHandler->splitUserRemote($shareWith);
-
-		if ($user && $remote) {
-			$local = $this->addressHandler->generateRemoteURL();
-
-			$fields = array(
-				'shareWith' => $user,
-				'token' => $token,
-				'name' => $name,
-				'remoteId' => $remote_id,
-				'owner' => $owner,
-				'ownerFederatedId' => $ownerFederatedId,
-				'sharedBy' => $sharedBy,
-				'sharedByFederatedId' => $sharedByFederatedId,
-				'remote' => $local,
-			);
-
-			$result = $this->tryHttpPostToShareEndpoint($remote, '', $fields);
-			$status = json_decode($result['result'], true);
-
-			$ocsStatus = isset($status['ocs']);
-			$ocsSuccess = $ocsStatus && ($status['ocs']['meta']['statuscode'] === 100 || $status['ocs']['meta']['statuscode'] === 200);
-
-			if ($result['success'] && (!$ocsStatus ||$ocsSuccess)) {
-				\OC_Hook::emit('OCP\Share', 'federated_share_added', ['server' => $remote]);
-				return true;
-			}
-
-		}
-
-		return false;
-	}
-
-	/**
-	 * ask owner to re-share the file with the given user
-	 *
-	 * @param string $token
-	 * @param int $id remote Id
-	 * @param int $shareId internal share Id
-	 * @param string $remote remote address of the owner
-	 * @param string $shareWith
-	 * @param int $permission
-	 * @return bool
-	 * @throws \OC\HintException
-	 * @throws \OC\ServerNotAvailableException
-	 */
-	public function requestReShare($token, $id, $shareId, $remote, $shareWith, $permission) {
-
-		$fields = array(
-			'shareWith' => $shareWith,
-			'token' => $token,
-			'permission' => $permission,
-			'remoteId' => $shareId
-		);
-
-		$result = $this->tryHttpPostToShareEndpoint(rtrim($remote, '/'), '/' . $id . '/reshare', $fields);
-		$status = json_decode($result['result'], true);
-
-		$httpRequestSuccessful = $result['success'];
-		$ocsCallSuccessful = $status['ocs']['meta']['statuscode'] === 100 || $status['ocs']['meta']['statuscode'] === 200;
-		$validToken = isset($status['ocs']['data']['token']) && is_string($status['ocs']['data']['token']);
-		$validRemoteId = isset($status['ocs']['data']['remoteId']);
-
-		if ($httpRequestSuccessful && $ocsCallSuccessful && $validToken && $validRemoteId) {
-			return [
-				$status['ocs']['data']['token'],
-				(int)$status['ocs']['data']['remoteId']
-			];
-		}
-
-		return false;
-	}
-
-	/**
-	 * send server-to-server unshare to remote server
-	 *
-	 * @param string $remote url
-	 * @param int $id share id
-	 * @param string $token
-	 * @return bool
-	 */
-	public function sendRemoteUnShare($remote, $id, $token) {
-		$this->sendUpdateToRemote($remote, $id, $token, 'unshare');
-	}
-
-	/**
-	 * send server-to-server unshare to remote server
-	 *
-	 * @param string $remote url
-	 * @param int $id share id
-	 * @param string $token
-	 * @return bool
-	 */
-	public function sendRevokeShare($remote, $id, $token) {
-		$this->sendUpdateToRemote($remote, $id, $token, 'revoke');
-	}
-
-	/**
-	 * send notification to remote server if the permissions was changed
-	 *
-	 * @param string $remote
-	 * @param int $remoteId
-	 * @param string $token
-	 * @param int $permissions
-	 * @return bool
-	 */
-	public function sendPermissionChange($remote, $remoteId, $token, $permissions) {
-		$this->sendUpdateToRemote($remote, $remoteId, $token, 'permissions', ['permissions' => $permissions]);
-	}
-
-	/**
-	 * forward accept reShare to remote server
-	 *
-	 * @param string $remote
-	 * @param int $remoteId
-	 * @param string $token
-	 */
-	public function sendAcceptShare($remote, $remoteId, $token) {
-		$this->sendUpdateToRemote($remote, $remoteId, $token, 'accept');
-	}
-
-	/**
-	 * forward decline reShare to remote server
-	 *
-	 * @param string $remote
-	 * @param int $remoteId
-	 * @param string $token
-	 */
-	public function sendDeclineShare($remote, $remoteId, $token) {
-		$this->sendUpdateToRemote($remote, $remoteId, $token, 'decline');
-	}
-
-	/**
-	 * inform remote server whether server-to-server share was accepted/declined
-	 *
-	 * @param string $remote
-	 * @param string $token
-	 * @param int $remoteId Share id on the remote host
-	 * @param string $action possible actions: accept, decline, unshare, revoke, permissions
-	 * @param array $data
-	 * @param int $try
-	 * @return boolean
-	 */
-	public function sendUpdateToRemote($remote, $remoteId, $token, $action, $data = [], $try = 0) {
-
-		$fields = array('token' => $token);
-		foreach ($data as $key => $value) {
-			$fields[$key] = $value;
-		}
-
-		$result = $this->tryHttpPostToShareEndpoint(rtrim($remote, '/'), '/' . $remoteId . '/' . $action, $fields);
-		$status = json_decode($result['result'], true);
-
-		if ($result['success'] &&
-			($status['ocs']['meta']['statuscode'] === 100 ||
-				$status['ocs']['meta']['statuscode'] === 200
-			)
-		) {
-			return true;
-		} elseif ($try === 0) {
-			// only add new job on first try
-			$this->jobList->add('OCA\FederatedFileSharing\BackgroundJob\RetryJob',
-				[
-					'remote' => $remote,
-					'remoteId' => $remoteId,
-					'token' => $token,
-					'action' => $action,
-					'data' => json_encode($data),
-					'try' => $try,
-					'lastRun' => $this->getTimestamp()
-				]
-			);
-		}
-
-		return false;
-	}
-
-
-	/**
-	 * return current timestamp
-	 *
-	 * @return int
-	 */
-	protected function getTimestamp() {
-		return time();
-	}
-
-	/**
-	 * try http post with the given protocol, if no protocol is given we pick
-	 * the secure one (https)
-	 *
-	 * @param string $remoteDomain
-	 * @param string $urlSuffix
-	 * @param array $fields post parameters
-	 * @param string $action define the action (possible values: share, reshare, accept, decline, unshare, revoke, permissions)
-	 * @return array
-	 * @throws \Exception
-	 */
-	protected function tryHttpPostToShareEndpoint($remoteDomain, $urlSuffix, array $fields, $action="share") {
-
-		if ($this->addressHandler->urlContainProtocol($remoteDomain) === false) {
-			$remoteDomain = 'https://' . $remoteDomain;
-		}
-
-		$result = [
-			'success' => false,
-			'result' => '',
-		];
-
-		// if possible we use the new OCM API
-		$ocmResult = $this->tryOCMEndPoint($remoteDomain, $fields, $action);
-		if ($ocmResult) {
-			$result['success'] = true;
-			return $result;
-		}
-
-		// Fall back to old API
-		$client = $this->httpClientService->newClient();
-		$federationEndpoints = $this->discoveryService->discover($remoteDomain, 'FEDERATED_SHARING');
-		$endpoint = isset($federationEndpoints['share']) ? $federationEndpoints['share'] : '/ocs/v2.php/cloud/shares';
-		try {
-			$response = $client->post($remoteDomain . $endpoint . $urlSuffix . '?format=' . self::RESPONSE_FORMAT, [
-				'body' => $fields,
-				'timeout' => 10,
-				'connect_timeout' => 10,
-			]);
-			$result['result'] = $response->getBody();
-			$result['success'] = 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 $result;
-	}
-
-	/**
-	 * check if server supports the new OCM api and ask for the correct end-point
-	 *
-	 * @param string $url
-	 * @return string
-	 */
-	protected function getOCMEndPoint($url) {
-		$client = $this->httpClientService->newClient();
-		try {
-			$response = $client->get($url, ['timeout' => 10, 'connect_timeout' => 10]);
-		} catch (\Exception $e) {
-			return '';
-		}
-
-		$result = $response->getBody();
-		$result = json_decode($result, true);
-
-		if (isset($result['end-point'])) {
-			return $result['end-point'];
-		}
-
-		return '';
-	}
-
-	/**
-	 * send action regarding federated sharing to the remote server using the OCM API
-	 *
-	 * @param $remoteDomain
-	 * @param $fields
-	 * @param $action
-	 *
-	 * @return bool
-	 */
-	protected function tryOCMEndPoint($remoteDomain, $fields, $action) {
-		switch ($action) {
-			case 'share':
-				$share = $this->cloudFederationFactory->getCloudFederationShare(
-					$fields['shareWith'] . '@' . $remoteDomain,
-					$fields['name'],
-					'',
-					$fields['remoteId'],
-					$fields['ownerFederatedId'],
-					$fields['owner'],
-					$fields['sharedByFederatedId'],
-					$fields['sharedBy'],
-					$fields['token'],
-					'user',
-					'file'
-				);
-				return $this->federationProviderManager->sendShare($share);
-		}
-
-	}
+    const RESPONSE_FORMAT = 'json'; // default response format for ocs calls
+
+    /** @var AddressHandler */
+    private $addressHandler;
+
+    /** @var IClientService */
+    private $httpClientService;
+
+    /** @var IDiscoveryService */
+    private $discoveryService;
+
+    /** @var IJobList  */
+    private $jobList;
+
+    /** @var ICloudFederationProviderManager */
+    private $federationProviderManager;
+
+    /** @var ICloudFederationFactory */
+    private $cloudFederationFactory;
+
+    /**
+     * @param AddressHandler $addressHandler
+     * @param IClientService $httpClientService
+     * @param IDiscoveryService $discoveryService
+     * @param IJobList $jobList
+     * @param ICloudFederationProviderManager $federationProviderManager
+     * @param ICloudFederationFactory $cloudFederationFactory
+     */
+    public function __construct(
+        AddressHandler $addressHandler,
+        IClientService $httpClientService,
+        IDiscoveryService $discoveryService,
+        IJobList $jobList,
+        ICloudFederationProviderManager $federationProviderManager,
+        ICloudFederationFactory $cloudFederationFactory
+    ) {
+        $this->addressHandler = $addressHandler;
+        $this->httpClientService = $httpClientService;
+        $this->discoveryService = $discoveryService;
+        $this->jobList = $jobList;
+        $this->federationProviderManager = $federationProviderManager;
+        $this->cloudFederationFactory = $cloudFederationFactory;
+    }
+
+    /**
+     * send server-to-server share to remote server
+     *
+     * @param string $token
+     * @param string $shareWith
+     * @param string $name
+     * @param int $remote_id
+     * @param string $owner
+     * @param string $ownerFederatedId
+     * @param string $sharedBy
+     * @param string $sharedByFederatedId
+     * @return bool
+     * @throws \OC\HintException
+     * @throws \OC\ServerNotAvailableException
+     */
+    public function sendRemoteShare($token, $shareWith, $name, $remote_id, $owner, $ownerFederatedId, $sharedBy, $sharedByFederatedId) {
+
+        list($user, $remote) = $this->addressHandler->splitUserRemote($shareWith);
+
+        if ($user && $remote) {
+            $local = $this->addressHandler->generateRemoteURL();
+
+            $fields = array(
+                'shareWith' => $user,
+                'token' => $token,
+                'name' => $name,
+                'remoteId' => $remote_id,
+                'owner' => $owner,
+                'ownerFederatedId' => $ownerFederatedId,
+                'sharedBy' => $sharedBy,
+                'sharedByFederatedId' => $sharedByFederatedId,
+                'remote' => $local,
+            );
+
+            $result = $this->tryHttpPostToShareEndpoint($remote, '', $fields);
+            $status = json_decode($result['result'], true);
+
+            $ocsStatus = isset($status['ocs']);
+            $ocsSuccess = $ocsStatus && ($status['ocs']['meta']['statuscode'] === 100 || $status['ocs']['meta']['statuscode'] === 200);
+
+            if ($result['success'] && (!$ocsStatus ||$ocsSuccess)) {
+                \OC_Hook::emit('OCP\Share', 'federated_share_added', ['server' => $remote]);
+                return true;
+            }
+
+        }
+
+        return false;
+    }
+
+    /**
+     * ask owner to re-share the file with the given user
+     *
+     * @param string $token
+     * @param int $id remote Id
+     * @param int $shareId internal share Id
+     * @param string $remote remote address of the owner
+     * @param string $shareWith
+     * @param int $permission
+     * @return bool
+     * @throws \OC\HintException
+     * @throws \OC\ServerNotAvailableException
+     */
+    public function requestReShare($token, $id, $shareId, $remote, $shareWith, $permission) {
+
+        $fields = array(
+            'shareWith' => $shareWith,
+            'token' => $token,
+            'permission' => $permission,
+            'remoteId' => $shareId
+        );
+
+        $result = $this->tryHttpPostToShareEndpoint(rtrim($remote, '/'), '/' . $id . '/reshare', $fields);
+        $status = json_decode($result['result'], true);
+
+        $httpRequestSuccessful = $result['success'];
+        $ocsCallSuccessful = $status['ocs']['meta']['statuscode'] === 100 || $status['ocs']['meta']['statuscode'] === 200;
+        $validToken = isset($status['ocs']['data']['token']) && is_string($status['ocs']['data']['token']);
+        $validRemoteId = isset($status['ocs']['data']['remoteId']);
+
+        if ($httpRequestSuccessful && $ocsCallSuccessful && $validToken && $validRemoteId) {
+            return [
+                $status['ocs']['data']['token'],
+                (int)$status['ocs']['data']['remoteId']
+            ];
+        }
+
+        return false;
+    }
+
+    /**
+     * send server-to-server unshare to remote server
+     *
+     * @param string $remote url
+     * @param int $id share id
+     * @param string $token
+     * @return bool
+     */
+    public function sendRemoteUnShare($remote, $id, $token) {
+        $this->sendUpdateToRemote($remote, $id, $token, 'unshare');
+    }
+
+    /**
+     * send server-to-server unshare to remote server
+     *
+     * @param string $remote url
+     * @param int $id share id
+     * @param string $token
+     * @return bool
+     */
+    public function sendRevokeShare($remote, $id, $token) {
+        $this->sendUpdateToRemote($remote, $id, $token, 'revoke');
+    }
+
+    /**
+     * send notification to remote server if the permissions was changed
+     *
+     * @param string $remote
+     * @param int $remoteId
+     * @param string $token
+     * @param int $permissions
+     * @return bool
+     */
+    public function sendPermissionChange($remote, $remoteId, $token, $permissions) {
+        $this->sendUpdateToRemote($remote, $remoteId, $token, 'permissions', ['permissions' => $permissions]);
+    }
+
+    /**
+     * forward accept reShare to remote server
+     *
+     * @param string $remote
+     * @param int $remoteId
+     * @param string $token
+     */
+    public function sendAcceptShare($remote, $remoteId, $token) {
+        $this->sendUpdateToRemote($remote, $remoteId, $token, 'accept');
+    }
+
+    /**
+     * forward decline reShare to remote server
+     *
+     * @param string $remote
+     * @param int $remoteId
+     * @param string $token
+     */
+    public function sendDeclineShare($remote, $remoteId, $token) {
+        $this->sendUpdateToRemote($remote, $remoteId, $token, 'decline');
+    }
+
+    /**
+     * inform remote server whether server-to-server share was accepted/declined
+     *
+     * @param string $remote
+     * @param string $token
+     * @param int $remoteId Share id on the remote host
+     * @param string $action possible actions: accept, decline, unshare, revoke, permissions
+     * @param array $data
+     * @param int $try
+     * @return boolean
+     */
+    public function sendUpdateToRemote($remote, $remoteId, $token, $action, $data = [], $try = 0) {
+
+        $fields = array('token' => $token);
+        foreach ($data as $key => $value) {
+            $fields[$key] = $value;
+        }
+
+        $result = $this->tryHttpPostToShareEndpoint(rtrim($remote, '/'), '/' . $remoteId . '/' . $action, $fields);
+        $status = json_decode($result['result'], true);
+
+        if ($result['success'] &&
+            ($status['ocs']['meta']['statuscode'] === 100 ||
+                $status['ocs']['meta']['statuscode'] === 200
+            )
+        ) {
+            return true;
+        } elseif ($try === 0) {
+            // only add new job on first try
+            $this->jobList->add('OCA\FederatedFileSharing\BackgroundJob\RetryJob',
+                [
+                    'remote' => $remote,
+                    'remoteId' => $remoteId,
+                    'token' => $token,
+                    'action' => $action,
+                    'data' => json_encode($data),
+                    'try' => $try,
+                    'lastRun' => $this->getTimestamp()
+                ]
+            );
+        }
+
+        return false;
+    }
+
+
+    /**
+     * return current timestamp
+     *
+     * @return int
+     */
+    protected function getTimestamp() {
+        return time();
+    }
+
+    /**
+     * try http post with the given protocol, if no protocol is given we pick
+     * the secure one (https)
+     *
+     * @param string $remoteDomain
+     * @param string $urlSuffix
+     * @param array $fields post parameters
+     * @param string $action define the action (possible values: share, reshare, accept, decline, unshare, revoke, permissions)
+     * @return array
+     * @throws \Exception
+     */
+    protected function tryHttpPostToShareEndpoint($remoteDomain, $urlSuffix, array $fields, $action="share") {
+
+        if ($this->addressHandler->urlContainProtocol($remoteDomain) === false) {
+            $remoteDomain = 'https://' . $remoteDomain;
+        }
+
+        $result = [
+            'success' => false,
+            'result' => '',
+        ];
+
+        // if possible we use the new OCM API
+        $ocmResult = $this->tryOCMEndPoint($remoteDomain, $fields, $action);
+        if ($ocmResult) {
+            $result['success'] = true;
+            return $result;
+        }
+
+        // Fall back to old API
+        $client = $this->httpClientService->newClient();
+        $federationEndpoints = $this->discoveryService->discover($remoteDomain, 'FEDERATED_SHARING');
+        $endpoint = isset($federationEndpoints['share']) ? $federationEndpoints['share'] : '/ocs/v2.php/cloud/shares';
+        try {
+            $response = $client->post($remoteDomain . $endpoint . $urlSuffix . '?format=' . self::RESPONSE_FORMAT, [
+                'body' => $fields,
+                'timeout' => 10,
+                'connect_timeout' => 10,
+            ]);
+            $result['result'] = $response->getBody();
+            $result['success'] = 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 $result;
+    }
+
+    /**
+     * check if server supports the new OCM api and ask for the correct end-point
+     *
+     * @param string $url
+     * @return string
+     */
+    protected function getOCMEndPoint($url) {
+        $client = $this->httpClientService->newClient();
+        try {
+            $response = $client->get($url, ['timeout' => 10, 'connect_timeout' => 10]);
+        } catch (\Exception $e) {
+            return '';
+        }
+
+        $result = $response->getBody();
+        $result = json_decode($result, true);
+
+        if (isset($result['end-point'])) {
+            return $result['end-point'];
+        }
+
+        return '';
+    }
+
+    /**
+     * send action regarding federated sharing to the remote server using the OCM API
+     *
+     * @param $remoteDomain
+     * @param $fields
+     * @param $action
+     *
+     * @return bool
+     */
+    protected function tryOCMEndPoint($remoteDomain, $fields, $action) {
+        switch ($action) {
+            case 'share':
+                $share = $this->cloudFederationFactory->getCloudFederationShare(
+                    $fields['shareWith'] . '@' . $remoteDomain,
+                    $fields['name'],
+                    '',
+                    $fields['remoteId'],
+                    $fields['ownerFederatedId'],
+                    $fields['owner'],
+                    $fields['sharedByFederatedId'],
+                    $fields['sharedBy'],
+                    $fields['token'],
+                    'user',
+                    'file'
+                );
+                return $this->federationProviderManager->sendShare($share);
+        }
+
+    }
 }

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;
+    }
 
 }

lib/public/Federation/Exceptions/AuthenticationFailedException.php

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/ICloudFederationProvider.php

Indentation +34 added lines, -34 removed lines

@@ -39,41 +39,41 @@
 
 interface ICloudFederationProvider {
 
-	/**
-	 * get the name of the share type, handled by this provider
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getShareType();
+    /**
+     * get the name of the share type, handled by this provider
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getShareType();
 
-	/**
-	 * share received from another server
-	 *
-	 * @param ICloudFederationShare $share
-	 * @return string provider specific unique ID of the share
-	 *
-	 * @throws ProviderCouldNotAddShareException
-	 *
-	 * @since 14.0.0
-	 */
-	public function shareReceived(ICloudFederationShare $share);
+    /**
+     * share received from another server
+     *
+     * @param ICloudFederationShare $share
+     * @return string provider specific unique ID of the share
+     *
+     * @throws ProviderCouldNotAddShareException
+     *
+     * @since 14.0.0
+     */
+    public function shareReceived(ICloudFederationShare $share);
 
-	/**
-	 * notification received from another server
-	 *
-	 * @param string $notificationType (e.g SHARE_ACCEPTED)
-	 * @param string $providerId share ID
-	 * @param array $notification provider specific notification
-	 *
-	 * @throws ShareNotFoundException
-	 * @throws ActionNotSupportedException
-	 * @throws BadRequestException
-	 * @throws AuthenticationFailedException
-	 *
-	 * @since 14.0.0
-	 */
-	public function notificationReceived($notificationType, $providerId, array $notification);
+    /**
+     * notification received from another server
+     *
+     * @param string $notificationType (e.g SHARE_ACCEPTED)
+     * @param string $providerId share ID
+     * @param array $notification provider specific notification
+     *
+     * @throws ShareNotFoundException
+     * @throws ActionNotSupportedException
+     * @throws BadRequestException
+     * @throws AuthenticationFailedException
+     *
+     * @since 14.0.0
+     */
+    public function notificationReceived($notificationType, $providerId, array $notification);
 
 }

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);
 }

lib/private/Federation/CloudFederationProviderManager.php

Indentation +184 added lines, -184 removed lines

@@ -42,190 +42,190 @@
  */
 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 bool
-	 */
-	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_OK) {
-				return true;
-			}
-		} 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 bool
+     */
+    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_OK) {
+                return true;
+            }
+        } 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 '';
+    }
 
 
 }

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;
+    }
 }

apps/cloud_federation_api/lib/Controller/RequestHandlerController.php

Indentation +203 added lines, -203 removed lines

@@ -51,233 +51,233 @@
  */
 class RequestHandlerController extends Controller {
 
-	/** @var ILogger */
-	private $logger;
+    /** @var ILogger */
+    private $logger;
 
-	/** @var IUserManager */
-	private $userManager;
+    /** @var IUserManager */
+    private $userManager;
 
-	/** @var IURLGenerator */
-	private $urlGenerator;
+    /** @var IURLGenerator */
+    private $urlGenerator;
 
-	/** @var ICloudFederationProviderManager */
-	private $cloudFederationProviderManager;
+    /** @var ICloudFederationProviderManager */
+    private $cloudFederationProviderManager;
 
-	/** @var Config */
-	private $config;
+    /** @var Config */
+    private $config;
 
-	/** @var ICloudFederationFactory */
-	private $factory;
+    /** @var ICloudFederationFactory */
+    private $factory;
 
-	/** @var ICloudIdManager */
-	private $cloudIdManager;
+    /** @var ICloudIdManager */
+    private $cloudIdManager;
 
-	public function __construct($appName,
-								IRequest $request,
-								ILogger $logger,
-								IUserManager $userManager,
-								IURLGenerator $urlGenerator,
-								ICloudFederationProviderManager $cloudFederationProviderManager,
-								Config $config,
-								ICloudFederationFactory $factory,
-								ICloudIdManager $cloudIdManager
-	) {
-		parent::__construct($appName, $request);
+    public function __construct($appName,
+                                IRequest $request,
+                                ILogger $logger,
+                                IUserManager $userManager,
+                                IURLGenerator $urlGenerator,
+                                ICloudFederationProviderManager $cloudFederationProviderManager,
+                                Config $config,
+                                ICloudFederationFactory $factory,
+                                ICloudIdManager $cloudIdManager
+    ) {
+        parent::__construct($appName, $request);
 
-		$this->logger = $logger;
-		$this->userManager = $userManager;
-		$this->urlGenerator = $urlGenerator;
-		$this->cloudFederationProviderManager = $cloudFederationProviderManager;
-		$this->config = $config;
-		$this->factory = $factory;
-		$this->cloudIdManager = $cloudIdManager;
-	}
+        $this->logger = $logger;
+        $this->userManager = $userManager;
+        $this->urlGenerator = $urlGenerator;
+        $this->cloudFederationProviderManager = $cloudFederationProviderManager;
+        $this->config = $config;
+        $this->factory = $factory;
+        $this->cloudIdManager = $cloudIdManager;
+    }
 
-	/**
-	 * add share
-	 *
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 * @BruteForceProtection(action=receiveFederatedShare)
-	 *
-	 * @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 use to authenticate accross servers
-	 * @param array $protocol (e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]])
-	 * @param string $shareType ('group' or 'user' share)
-	 * @param $resourceType ('file', 'calendar',...)
-	 * @return Http\DataResponse|JSONResponse
-	 *
-	 * Example: curl -H "Content-Type: application/json" -X POST -d '{"shareWith":"admin1@serve1","name":"welcome server2.txt","description":"desc","providerId":"2","owner":"admin2@http://localhost/server2","ownerDisplayName":"admin2 display","shareType":"user","resourceType":"file","protocol":{"name":"webdav","options":{"sharedSecret":"secret","permissions":"webdav-property"}}}' http://localhost/server/index.php/ocm/shares
-	 */
-	public function addShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) {
-		if (!$this->config->incomingRequestsEnabled()) {
-			return new JSONResponse(
-				['message' => 'This server doesn\'t support outgoing federated shares'],
-			Http::STATUS_NOT_IMPLEMENTED
-			);
-		}
+    /**
+     * add share
+     *
+     * @NoCSRFRequired
+     * @PublicPage
+     * @BruteForceProtection(action=receiveFederatedShare)
+     *
+     * @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 use to authenticate accross servers
+     * @param array $protocol (e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]])
+     * @param string $shareType ('group' or 'user' share)
+     * @param $resourceType ('file', 'calendar',...)
+     * @return Http\DataResponse|JSONResponse
+     *
+     * Example: curl -H "Content-Type: application/json" -X POST -d '{"shareWith":"admin1@serve1","name":"welcome server2.txt","description":"desc","providerId":"2","owner":"admin2@http://localhost/server2","ownerDisplayName":"admin2 display","shareType":"user","resourceType":"file","protocol":{"name":"webdav","options":{"sharedSecret":"secret","permissions":"webdav-property"}}}' http://localhost/server/index.php/ocm/shares
+     */
+    public function addShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) {
+        if (!$this->config->incomingRequestsEnabled()) {
+            return new JSONResponse(
+                ['message' => 'This server doesn\'t support outgoing federated shares'],
+            Http::STATUS_NOT_IMPLEMENTED
+            );
+        }
 
-		// check if all required parameters are set
-		if ($shareWith === null ||
-			$name === null ||
-			$providerId === null ||
-			$owner === null ||
-			$resourceType === null ||
-			$shareType === null ||
-			!is_array($protocol) ||
-			!isset($protocol['name']) ||
-			!isset ($protocol['options']) ||
-			!is_array($protocol['options']) ||
-			!isset($protocol['options']['sharedSecret'])
-		) {
-			return new JSONResponse(
-				['message' => 'Missing arguments'],
-				Http::STATUS_BAD_REQUEST
-			);
-		}
+        // check if all required parameters are set
+        if ($shareWith === null ||
+            $name === null ||
+            $providerId === null ||
+            $owner === null ||
+            $resourceType === null ||
+            $shareType === null ||
+            !is_array($protocol) ||
+            !isset($protocol['name']) ||
+            !isset ($protocol['options']) ||
+            !is_array($protocol['options']) ||
+            !isset($protocol['options']['sharedSecret'])
+        ) {
+            return new JSONResponse(
+                ['message' => 'Missing arguments'],
+                Http::STATUS_BAD_REQUEST
+            );
+        }
 
-		$cloudId = $this->cloudIdManager->resolveCloudId($shareWith);
-		$shareWithLocalId = $cloudId->getUser();
-		$shareWith = $this->mapUid($shareWithLocalId);
+        $cloudId = $this->cloudIdManager->resolveCloudId($shareWith);
+        $shareWithLocalId = $cloudId->getUser();
+        $shareWith = $this->mapUid($shareWithLocalId);
 
-		if (!$this->userManager->userExists($shareWith)) {
-			return new JSONResponse(
-				['message' => 'User "' . $shareWith . '" does not exists at ' . $this->urlGenerator->getBaseUrl()],
-				Http::STATUS_BAD_REQUEST
-			);
-		}
+        if (!$this->userManager->userExists($shareWith)) {
+            return new JSONResponse(
+                ['message' => 'User "' . $shareWith . '" does not exists at ' . $this->urlGenerator->getBaseUrl()],
+                Http::STATUS_BAD_REQUEST
+            );
+        }
 
-		// if no explicit display name is given, we use the uid as display name
-		$ownerDisplayName = $ownerDisplayName === null ? $owner : $ownerDisplayName;
-		$sharedByDisplayName = $sharedByDisplayName === null ? $sharedBy : $sharedByDisplayName;
+        // if no explicit display name is given, we use the uid as display name
+        $ownerDisplayName = $ownerDisplayName === null ? $owner : $ownerDisplayName;
+        $sharedByDisplayName = $sharedByDisplayName === null ? $sharedBy : $sharedByDisplayName;
 
-		// sharedBy* parameter is optional, if nothing is set we assume that it is the same user as the owner
-		if ($sharedBy === null) {
-			$sharedBy = $owner;
-			$sharedByDisplayName = $ownerDisplayName;
-		}
+        // sharedBy* parameter is optional, if nothing is set we assume that it is the same user as the owner
+        if ($sharedBy === null) {
+            $sharedBy = $owner;
+            $sharedByDisplayName = $ownerDisplayName;
+        }
 
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
-			$share = $this->factory->getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, '', $shareType, $resourceType);
-			$share->setProtocol($protocol);
-			$id = $provider->shareReceived($share);
-		} catch (ProviderDoesNotExistsException $e) {
-			return new JSONResponse(
-				['message' => $e->getMessage()],
-				Http::STATUS_NOT_IMPLEMENTED
-			);
-		} catch (ProviderCouldNotAddShareException $e) {
-			return new JSONResponse(
-				['message' => $e->getMessage()],
-				$e->getCode()
-			);
-		} catch (\Exception $e) {
-			return new JSONResponse(
-				['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()],
-				Http::STATUS_BAD_REQUEST
-			);
-		}
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
+            $share = $this->factory->getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, '', $shareType, $resourceType);
+            $share->setProtocol($protocol);
+            $id = $provider->shareReceived($share);
+        } catch (ProviderDoesNotExistsException $e) {
+            return new JSONResponse(
+                ['message' => $e->getMessage()],
+                Http::STATUS_NOT_IMPLEMENTED
+            );
+        } catch (ProviderCouldNotAddShareException $e) {
+            return new JSONResponse(
+                ['message' => $e->getMessage()],
+                $e->getCode()
+            );
+        } catch (\Exception $e) {
+            return new JSONResponse(
+                ['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()],
+                Http::STATUS_BAD_REQUEST
+            );
+        }
 
-		return new JSONResponse(
-			['id' => $id, 'createdAt' => time()],
-			Http::STATUS_CREATED);
+        return new JSONResponse(
+            ['id' => $id, 'createdAt' => time()],
+            Http::STATUS_CREATED);
 
-	}
+    }
 
-	/**
-	 * receive notification about existing share
-	 *
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 * @BruteForceProtection(action=receiveFederatedShareNotification)
-	 *
-	 * @param string $notificationType (notification type, e.g. SHARE_ACCEPTED)
-	 * @param string $resourceType (calendar, file, contact,...)
-	 * @param string $providerId id of the share
-	 * @param array $notification the actual payload of the notification
-	 * @return JSONResponse
-	 */
-	public function receiveNotification($notificationType, $resourceType, $providerId, array $notification) {
-		if (!$this->config->incomingRequestsEnabled()) {
-			return new JSONResponse(
-				['message' => 'This server doesn\'t support outgoing federated shares'],
-				Http::STATUS_NOT_IMPLEMENTED
-			);
-		}
+    /**
+     * receive notification about existing share
+     *
+     * @NoCSRFRequired
+     * @PublicPage
+     * @BruteForceProtection(action=receiveFederatedShareNotification)
+     *
+     * @param string $notificationType (notification type, e.g. SHARE_ACCEPTED)
+     * @param string $resourceType (calendar, file, contact,...)
+     * @param string $providerId id of the share
+     * @param array $notification the actual payload of the notification
+     * @return JSONResponse
+     */
+    public function receiveNotification($notificationType, $resourceType, $providerId, array $notification) {
+        if (!$this->config->incomingRequestsEnabled()) {
+            return new JSONResponse(
+                ['message' => 'This server doesn\'t support outgoing federated shares'],
+                Http::STATUS_NOT_IMPLEMENTED
+            );
+        }
 
-		// check if all required parameters are set
-		if ($notificationType === null ||
-			$resourceType === null ||
-			$providerId === null ||
-			!is_array($notification)
-		) {
-			return new JSONResponse(
-				['message' => 'Missing arguments'],
-				Http::STATUS_BAD_REQUEST
-			);
-		}
+        // check if all required parameters are set
+        if ($notificationType === null ||
+            $resourceType === null ||
+            $providerId === null ||
+            !is_array($notification)
+        ) {
+            return new JSONResponse(
+                ['message' => 'Missing arguments'],
+                Http::STATUS_BAD_REQUEST
+            );
+        }
 
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
-			$provider->notificationReceived($notificationType, $providerId, $notification);
-		} catch (ProviderDoesNotExistsException $e) {
-			return new JSONResponse(
-				['message' => $e->getMessage()],
-				Http::STATUS_BAD_REQUEST
-			);
-		} catch (ShareNotFoundException $e) {
-			return new JSONResponse(
-				['message' => $e->getMessage()],
-				Http::STATUS_BAD_REQUEST
-			);
-		} catch (ActionNotSupportedException $e) {
-			return new JSONResponse(
-				['message' => $e->getMessage()],
-				Http::STATUS_NOT_IMPLEMENTED
-			);
-		} catch (BadRequestException $e) {
-			return new JSONResponse($e->getReturnMessage(), Http::STATUS_BAD_REQUEST);
-		} catch (AuthenticationFailedException $e) {
-			return new JSONResponse(["message" => "RESOURCE_NOT_FOUND"], Http::STATUS_FORBIDDEN);
-		}
-		catch (\Exception $e) {
-			return new JSONResponse(
-				['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()],
-				Http::STATUS_BAD_REQUEST
-			);
-		}
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
+            $provider->notificationReceived($notificationType, $providerId, $notification);
+        } catch (ProviderDoesNotExistsException $e) {
+            return new JSONResponse(
+                ['message' => $e->getMessage()],
+                Http::STATUS_BAD_REQUEST
+            );
+        } catch (ShareNotFoundException $e) {
+            return new JSONResponse(
+                ['message' => $e->getMessage()],
+                Http::STATUS_BAD_REQUEST
+            );
+        } catch (ActionNotSupportedException $e) {
+            return new JSONResponse(
+                ['message' => $e->getMessage()],
+                Http::STATUS_NOT_IMPLEMENTED
+            );
+        } catch (BadRequestException $e) {
+            return new JSONResponse($e->getReturnMessage(), Http::STATUS_BAD_REQUEST);
+        } catch (AuthenticationFailedException $e) {
+            return new JSONResponse(["message" => "RESOURCE_NOT_FOUND"], Http::STATUS_FORBIDDEN);
+        }
+        catch (\Exception $e) {
+            return new JSONResponse(
+                ['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()],
+                Http::STATUS_BAD_REQUEST
+            );
+        }
 
 
-		return new JSONResponse([],Http::STATUS_CREATED);
+        return new JSONResponse([],Http::STATUS_CREATED);
 
-	}
+    }
 
-	/**
-	 * map login name to internal LDAP UID if a LDAP backend is in use
-	 *
-	 * @param string $uid
-	 * @return string mixed
-	 */
-	private function mapUid($uid) {
-		\OC::$server->getURLGenerator()->linkToDocs('key');
-		// FIXME this should be a method in the user management instead
-		$this->logger->debug('shareWith before, ' . $uid, ['app' => $this->appName]);
-		\OCP\Util::emitHook(
-			'\OCA\Files_Sharing\API\Server2Server',
-			'preLoginNameUsedAsUserName',
-			array('uid' => &$uid)
-		);
-		$this->logger->debug('shareWith after, ' . $uid, ['app' => $this->appName]);
+    /**
+     * map login name to internal LDAP UID if a LDAP backend is in use
+     *
+     * @param string $uid
+     * @return string mixed
+     */
+    private function mapUid($uid) {
+        \OC::$server->getURLGenerator()->linkToDocs('key');
+        // FIXME this should be a method in the user management instead
+        $this->logger->debug('shareWith before, ' . $uid, ['app' => $this->appName]);
+        \OCP\Util::emitHook(
+            '\OCA\Files_Sharing\API\Server2Server',
+            'preLoginNameUsedAsUserName',
+            array('uid' => &$uid)
+        );
+        $this->logger->debug('shareWith after, ' . $uid, ['app' => $this->appName]);
 
-		return $uid;
-	}
+        return $uid;
+    }
 
 }