nextcloud / server

lib/public/Federation/Exceptions/ActionNotSupportedException.php

Indentation +12 added lines, -12 removed lines

@@ -32,17 +32,17 @@
  */
 class ActionNotSupportedException extends HintException {
 
-	/**
-	 * ActionNotSupportedException constructor.
-	 *
-	 * @since 14.0.0
-	 *
-	 */
-	public function __construct($action) {
-		$l = \OC::$server->getL10N('federation');
-		$message = 'Action "' . $action . '" not supported or implemented.';
-		$hint = $l->t('Action "%s" not supported or implemented.', [$action]);
-		parent::__construct($message, $hint);
-	}
+    /**
+     * ActionNotSupportedException constructor.
+     *
+     * @since 14.0.0
+     *
+     */
+    public function __construct($action) {
+        $l = \OC::$server->getL10N('federation');
+        $message = 'Action "' . $action . '" not supported or implemented.';
+        $hint = $l->t('Action "%s" not supported or implemented.', [$action]);
+        parent::__construct($message, $hint);
+    }
 
 }

lib/public/Federation/ICloudFederationFactory.php

Indentation +28 added lines, -28 removed lines

@@ -30,33 +30,33 @@
  */
 interface 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);
+    /**
+     * 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);
 
-	/**
-	 * get a Cloud FederationNotification object to prepare a notification you
-	 * want to send
-	 *
-	 * @return ICloudFederationNotification
-	 *
-	 * @since 14.0.0
-	 */
-	public function getCloudFederationNotification();
+    /**
+     * get a Cloud FederationNotification object to prepare a notification you
+     * want to send
+     *
+     * @return ICloudFederationNotification
+     *
+     * @since 14.0.0
+     */
+    public function getCloudFederationNotification();
 }

lib/public/Federation/Exceptions/AuthenticationFailedException.php

Indentation +12 added lines, -12 removed lines

@@ -32,17 +32,17 @@
  */
 class AuthenticationFailedException extends HintException {
 
-	/**
-	 * BadRequestException constructor.
-	 *
-	 * @since 14.0.0
-	 *
-	 */
-	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.
+     *
+     * @since 14.0.0
+     *
+     */
+    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);
+    }
 
 }

apps/federatedfilesharing/lib/Controller/RequestHandlerController.php

Indentation +427 added lines, -427 removed lines

@@ -52,431 +52,431 @@
 
 class RequestHandlerController extends OCSController {
 
-	/** @var FederatedShareProvider */
-	private $federatedShareProvider;
-
-	/** @var IDBConnection */
-	private $connection;
-
-	/** @var Share\IManager */
-	private $shareManager;
-
-	/** @var Notifications */
-	private $notifications;
-
-	/** @var AddressHandler */
-	private $addressHandler;
-
-	/** @var  IUserManager */
-	private $userManager;
-
-	/** @var string */
-	private $shareTable = 'share';
-
-	/** @var ICloudIdManager */
-	private $cloudIdManager;
-
-	/** @var ILogger */
-	private $logger;
-
-	/** @var ICloudFederationFactory */
-	private $cloudFederationFactory;
-
-	/** @var ICloudFederationProviderManager */
-	private $cloudFederationProviderManager;
-
-	/**
-	 * Server2Server constructor.
-	 *
-	 * @param string $appName
-	 * @param IRequest $request
-	 * @param FederatedShareProvider $federatedShareProvider
-	 * @param IDBConnection $connection
-	 * @param Share\IManager $shareManager
-	 * @param Notifications $notifications
-	 * @param AddressHandler $addressHandler
-	 * @param IUserManager $userManager
-	 * @param ICloudIdManager $cloudIdManager
-	 * @param ILogger $logger
-	 * @param ICloudFederationFactory $cloudFederationFactory
-	 * @param ICloudFederationProviderManager $cloudFederationProviderManager
-	 */
-	public function __construct($appName,
-								IRequest $request,
-								FederatedShareProvider $federatedShareProvider,
-								IDBConnection $connection,
-								Share\IManager $shareManager,
-								Notifications $notifications,
-								AddressHandler $addressHandler,
-								IUserManager $userManager,
-								ICloudIdManager $cloudIdManager,
-								ILogger $logger,
-								ICloudFederationFactory $cloudFederationFactory,
-								ICloudFederationProviderManager $cloudFederationProviderManager
-	) {
-		parent::__construct($appName, $request);
-
-		$this->federatedShareProvider = $federatedShareProvider;
-		$this->connection = $connection;
-		$this->shareManager = $shareManager;
-		$this->notifications = $notifications;
-		$this->addressHandler = $addressHandler;
-		$this->userManager = $userManager;
-		$this->cloudIdManager = $cloudIdManager;
-		$this->logger = $logger;
-		$this->cloudFederationFactory = $cloudFederationFactory;
-		$this->cloudFederationProviderManager = $cloudFederationProviderManager;
-	}
-
-	/**
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 *
-	 * create a new share
-	 *
-	 * @return Http\DataResponse
-	 * @throws OCSException
-	 */
-	public function createShare() {
-
-		$remote = isset($_POST['remote']) ? $_POST['remote'] : null;
-		$token = isset($_POST['token']) ? $_POST['token'] : null;
-		$name = isset($_POST['name']) ? $_POST['name'] : null;
-		$owner = isset($_POST['owner']) ? $_POST['owner'] : null;
-		$sharedBy = isset($_POST['sharedBy']) ? $_POST['sharedBy'] : null;
-		$shareWith = isset($_POST['shareWith']) ? $_POST['shareWith'] : null;
-		$remoteId = isset($_POST['remoteId']) ? (int)$_POST['remoteId'] : null;
-		$sharedByFederatedId = isset($_POST['sharedByFederatedId']) ? $_POST['sharedByFederatedId'] : null;
-		$ownerFederatedId = isset($_POST['ownerFederatedId']) ? $_POST['ownerFederatedId'] : null;
-
-		if ($ownerFederatedId === null) {
-			$ownerFederatedId = $this->cloudIdManager->getCloudId($owner, $this->cleanupRemote($remote))->getId();
-		}
-		// if the owner of the share and the initiator are the same user
-		// we also complete the federated share ID for the initiator
-		if ($sharedByFederatedId === null && $owner === $sharedBy) {
-			$sharedByFederatedId = $ownerFederatedId;
-		}
-
-		$share = $this->cloudFederationFactory->getCloudFederationShare(
-			$shareWith,
-			$name,
-			'',
-			$remoteId,
-			$ownerFederatedId,
-			$owner,
-			$sharedByFederatedId,
-			$sharedBy,
-			$token,
-			'user',
-			'file'
-		);
-
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
-			$provider->shareReceived($share);
-		} catch (ProviderDoesNotExistsException $e) {
-			throw new OCSException('Server does not support federated cloud sharing', 503);
-		} catch (ProviderCouldNotAddShareException $e) {
-			throw new OCSException($e->getMessage(), 400);
-		} catch (\Exception $e) {
-			throw new OCSException('internal server error, was not able to add share from ' . $remote, 500);
-		}
-
-		return new Http\DataResponse();
-	}
-
-	/**
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 *
-	 * create re-share on behalf of another user
-	 *
-	 * @param int $id
-	 * @return Http\DataResponse
-	 * @throws OCSBadRequestException
-	 * @throws OCSException
-	 * @throws OCSForbiddenException
-	 */
-	public function reShare($id) {
-
-		$token = $this->request->getParam('token', null);
-		$shareWith = $this->request->getParam('shareWith', null);
-		$permission = (int)$this->request->getParam('permission', null);
-		$remoteId = (int)$this->request->getParam('remoteId', null);
-
-		if ($id === null ||
-			$token === null ||
-			$shareWith === null ||
-			$permission === null ||
-			$remoteId === null
-		) {
-			throw new OCSBadRequestException();
-		}
-
-		$notification = [
-			'sharedSecret' => $token,
-			'shareWith' => $shareWith,
-			'senderId' => $remoteId,
-			'message' => 'Recipient of a share ask the owner to reshare the file'
-		];
-
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
-			list($newToken, $localId) = $provider->notificationReceived('REQUEST_RESHARE', $id, $notification);
-			return new Http\DataResponse([
-				'token' => $newToken,
-				'remoteId' => $localId
-			]);
-		} catch (ProviderDoesNotExistsException $e) {
-			throw new OCSException('Server does not support federated cloud sharing', 503);
-		} catch (ShareNotFound $e) {
-			$this->logger->debug('Share not found: ' . $e->getMessage());
-		} catch (\Exception $e) {
-			$this->logger->debug('internal server error, can not process notification: ' . $e->getMessage());
-		}
-
-		throw new OCSBadRequestException();
-	}
-
-
-	/**
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 *
-	 * accept server-to-server share
-	 *
-	 * @param int $id
-	 * @return Http\DataResponse
-	 * @throws OCSException
-	 * @throws ShareNotFound
-	 * @throws \OC\HintException
-	 */
-	public function acceptShare($id) {
-
-		$token = isset($_POST['token']) ? $_POST['token'] : null;
-
-		$notification = [
-			'sharedSecret' => $token,
-			'message' => 'Recipient accept the share'
-		];
-
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
-			$provider->notificationReceived('SHARE_ACCEPTED', $id, $notification);
-		} catch (ProviderDoesNotExistsException $e) {
-			throw new OCSException('Server does not support federated cloud sharing', 503);
-		} catch (ShareNotFound $e) {
-			$this->logger->debug('Share not found: ' . $e->getMessage());
-		} catch (\Exception $e) {
-			$this->logger->debug('internal server error, can not process notification: ' . $e->getMessage());
-		}
-
-		return new Http\DataResponse();
-	}
-
-	/**
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 *
-	 * decline server-to-server share
-	 *
-	 * @param int $id
-	 * @return Http\DataResponse
-	 * @throws OCSException
-	 */
-	public function declineShare($id) {
-
-		$token = isset($_POST['token']) ? $_POST['token'] : null;
-
-		$notification = [
-			'sharedSecret' => $token,
-			'message' => 'Recipient declined the share'
-		];
-
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
-			$provider->notificationReceived('SHARE_DECLINED', $id, $notification);
-		} catch (ProviderDoesNotExistsException $e) {
-			throw new OCSException('Server does not support federated cloud sharing', 503);
-		} catch (ShareNotFound $e) {
-			$this->logger->debug('Share not found: ' . $e->getMessage());
-		} catch (\Exception $e) {
-			$this->logger->debug('internal server error, can not process notification: ' . $e->getMessage());
-		}
-
-		return new Http\DataResponse();
-	}
-
-	/**
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 *
-	 * remove server-to-server share if it was unshared by the owner
-	 *
-	 * @param int $id
-	 * @return Http\DataResponse
-	 * @throws OCSException
-	 */
-	public function unshare($id) {
-
-		if (!$this->isS2SEnabled()) {
-			throw new OCSException('Server does not support federated cloud sharing', 503);
-		}
-
-		$token = isset($_POST['token']) ? $_POST['token'] : null;
-
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
-			$notification = ['sharedSecret' => $token];
-			$provider->notificationReceived('SHARE_UNSHARED', $id, $notification);
-		} catch (\Exception $e) {
-			$this->logger->debug('processing unshare notification failed: ' . $e->getMessage());
-		}
-
-		return new Http\DataResponse();
-	}
-
-	private function cleanupRemote($remote) {
-		$remote = substr($remote, strpos($remote, '://') + 3);
-
-		return rtrim($remote, '/');
-	}
-
-
-	/**
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 *
-	 * federated share was revoked, either by the owner or the re-sharer
-	 *
-	 * @param int $id
-	 * @return Http\DataResponse
-	 * @throws OCSBadRequestException
-	 */
-	public function revoke($id) {
-
-		$token = $this->request->getParam('token');
-
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
-			$notification = ['sharedSecret' => $token];
-			$provider->notificationReceived('RESHARE_UNDO', $id, $notification);
-			return new Http\DataResponse();
-		} catch (\Exception $e) {
-			throw new OCSBadRequestException();
-		}
-
-	}
-
-	/**
-	 * check if server-to-server sharing is enabled
-	 *
-	 * @param bool $incoming
-	 * @return bool
-	 */
-	private function isS2SEnabled($incoming = false) {
-
-		$result = \OCP\App::isEnabled('files_sharing');
-
-		if ($incoming) {
-			$result = $result && $this->federatedShareProvider->isIncomingServer2serverShareEnabled();
-		} else {
-			$result = $result && $this->federatedShareProvider->isOutgoingServer2serverShareEnabled();
-		}
-
-		return $result;
-	}
-
-	/**
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 *
-	 * update share information to keep federated re-shares in sync
-	 *
-	 * @param int $id
-	 * @return Http\DataResponse
-	 * @throws OCSBadRequestException
-	 */
-	public function updatePermissions($id) {
-		$token = $this->request->getParam('token', null);
-		$ncPermissions = $this->request->getParam('permissions', null);
-
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
-			$ocmPermissions = $this->ncPermissions2ocmPermissions((int)$ncPermissions);
-			$notification = ['sharedSecret' => $token, 'permission' => $ocmPermissions];
-			$provider->notificationReceived('RESHARE_CHANGE_PERMISSION', $id, $notification);
-		} catch (\Exception $e) {
-			$this->logger->debug($e->getMessage());
-			throw new OCSBadRequestException();
-		}
-
-		return new Http\DataResponse();
-	}
-
-	/**
-	 * translate Nextcloud permissions to OCM Permissions
-	 *
-	 * @param $ncPermissions
-	 * @return array
-	 */
-	protected function ncPermissions2ocmPermissions($ncPermissions) {
-
-		$ocmPermissions = [];
-
-		if ($ncPermissions & Constants::PERMISSION_SHARE) {
-			$ocmPermissions[] = 'share';
-		}
-
-		if ($ncPermissions & Constants::PERMISSION_READ) {
-			$ocmPermissions[] = 'read';
-		}
-
-		if (($ncPermissions & Constants::PERMISSION_CREATE) ||
-			($ncPermissions & Constants::PERMISSION_UPDATE)) {
-			$ocmPermissions[] = 'write';
-		}
-
-		return $ocmPermissions;
-
-	}
-
-	/**
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 *
-	 * change the owner of a server-to-server share
-	 *
-	 * @param int $id
-	 * @return Http\DataResponse
-	 * @throws \InvalidArgumentException
-	 * @throws OCSException
-	 */
-	public function move($id) {
-
-		if (!$this->isS2SEnabled()) {
-			throw new OCSException('Server does not support federated cloud sharing', 503);
-		}
-
-		$token = $this->request->getParam('token');
-		$remote = $this->request->getParam('remote');
-		$newRemoteId = $this->request->getParam('remote_id', $id);
-		$cloudId = $this->cloudIdManager->resolveCloudId($remote);
-
-		$qb = $this->connection->getQueryBuilder();
-		$query = $qb->update('share_external')
-			->set('remote', $qb->createNamedParameter($cloudId->getRemote()))
-			->set('owner', $qb->createNamedParameter($cloudId->getUser()))
-			->set('remote_id', $qb->createNamedParameter($newRemoteId))
-			->where($qb->expr()->eq('remote_id', $qb->createNamedParameter($id)))
-			->andWhere($qb->expr()->eq('share_token', $qb->createNamedParameter($token)));
-		$affected = $query->execute();
-
-		if ($affected > 0) {
-			return new Http\DataResponse(['remote' => $cloudId->getRemote(), 'owner' => $cloudId->getUser()]);
-		} else {
-			throw new OCSBadRequestException('Share not found or token invalid');
-		}
-	}
+    /** @var FederatedShareProvider */
+    private $federatedShareProvider;
+
+    /** @var IDBConnection */
+    private $connection;
+
+    /** @var Share\IManager */
+    private $shareManager;
+
+    /** @var Notifications */
+    private $notifications;
+
+    /** @var AddressHandler */
+    private $addressHandler;
+
+    /** @var  IUserManager */
+    private $userManager;
+
+    /** @var string */
+    private $shareTable = 'share';
+
+    /** @var ICloudIdManager */
+    private $cloudIdManager;
+
+    /** @var ILogger */
+    private $logger;
+
+    /** @var ICloudFederationFactory */
+    private $cloudFederationFactory;
+
+    /** @var ICloudFederationProviderManager */
+    private $cloudFederationProviderManager;
+
+    /**
+     * Server2Server constructor.
+     *
+     * @param string $appName
+     * @param IRequest $request
+     * @param FederatedShareProvider $federatedShareProvider
+     * @param IDBConnection $connection
+     * @param Share\IManager $shareManager
+     * @param Notifications $notifications
+     * @param AddressHandler $addressHandler
+     * @param IUserManager $userManager
+     * @param ICloudIdManager $cloudIdManager
+     * @param ILogger $logger
+     * @param ICloudFederationFactory $cloudFederationFactory
+     * @param ICloudFederationProviderManager $cloudFederationProviderManager
+     */
+    public function __construct($appName,
+                                IRequest $request,
+                                FederatedShareProvider $federatedShareProvider,
+                                IDBConnection $connection,
+                                Share\IManager $shareManager,
+                                Notifications $notifications,
+                                AddressHandler $addressHandler,
+                                IUserManager $userManager,
+                                ICloudIdManager $cloudIdManager,
+                                ILogger $logger,
+                                ICloudFederationFactory $cloudFederationFactory,
+                                ICloudFederationProviderManager $cloudFederationProviderManager
+    ) {
+        parent::__construct($appName, $request);
+
+        $this->federatedShareProvider = $federatedShareProvider;
+        $this->connection = $connection;
+        $this->shareManager = $shareManager;
+        $this->notifications = $notifications;
+        $this->addressHandler = $addressHandler;
+        $this->userManager = $userManager;
+        $this->cloudIdManager = $cloudIdManager;
+        $this->logger = $logger;
+        $this->cloudFederationFactory = $cloudFederationFactory;
+        $this->cloudFederationProviderManager = $cloudFederationProviderManager;
+    }
+
+    /**
+     * @NoCSRFRequired
+     * @PublicPage
+     *
+     * create a new share
+     *
+     * @return Http\DataResponse
+     * @throws OCSException
+     */
+    public function createShare() {
+
+        $remote = isset($_POST['remote']) ? $_POST['remote'] : null;
+        $token = isset($_POST['token']) ? $_POST['token'] : null;
+        $name = isset($_POST['name']) ? $_POST['name'] : null;
+        $owner = isset($_POST['owner']) ? $_POST['owner'] : null;
+        $sharedBy = isset($_POST['sharedBy']) ? $_POST['sharedBy'] : null;
+        $shareWith = isset($_POST['shareWith']) ? $_POST['shareWith'] : null;
+        $remoteId = isset($_POST['remoteId']) ? (int)$_POST['remoteId'] : null;
+        $sharedByFederatedId = isset($_POST['sharedByFederatedId']) ? $_POST['sharedByFederatedId'] : null;
+        $ownerFederatedId = isset($_POST['ownerFederatedId']) ? $_POST['ownerFederatedId'] : null;
+
+        if ($ownerFederatedId === null) {
+            $ownerFederatedId = $this->cloudIdManager->getCloudId($owner, $this->cleanupRemote($remote))->getId();
+        }
+        // if the owner of the share and the initiator are the same user
+        // we also complete the federated share ID for the initiator
+        if ($sharedByFederatedId === null && $owner === $sharedBy) {
+            $sharedByFederatedId = $ownerFederatedId;
+        }
+
+        $share = $this->cloudFederationFactory->getCloudFederationShare(
+            $shareWith,
+            $name,
+            '',
+            $remoteId,
+            $ownerFederatedId,
+            $owner,
+            $sharedByFederatedId,
+            $sharedBy,
+            $token,
+            'user',
+            'file'
+        );
+
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
+            $provider->shareReceived($share);
+        } catch (ProviderDoesNotExistsException $e) {
+            throw new OCSException('Server does not support federated cloud sharing', 503);
+        } catch (ProviderCouldNotAddShareException $e) {
+            throw new OCSException($e->getMessage(), 400);
+        } catch (\Exception $e) {
+            throw new OCSException('internal server error, was not able to add share from ' . $remote, 500);
+        }
+
+        return new Http\DataResponse();
+    }
+
+    /**
+     * @NoCSRFRequired
+     * @PublicPage
+     *
+     * create re-share on behalf of another user
+     *
+     * @param int $id
+     * @return Http\DataResponse
+     * @throws OCSBadRequestException
+     * @throws OCSException
+     * @throws OCSForbiddenException
+     */
+    public function reShare($id) {
+
+        $token = $this->request->getParam('token', null);
+        $shareWith = $this->request->getParam('shareWith', null);
+        $permission = (int)$this->request->getParam('permission', null);
+        $remoteId = (int)$this->request->getParam('remoteId', null);
+
+        if ($id === null ||
+            $token === null ||
+            $shareWith === null ||
+            $permission === null ||
+            $remoteId === null
+        ) {
+            throw new OCSBadRequestException();
+        }
+
+        $notification = [
+            'sharedSecret' => $token,
+            'shareWith' => $shareWith,
+            'senderId' => $remoteId,
+            'message' => 'Recipient of a share ask the owner to reshare the file'
+        ];
+
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
+            list($newToken, $localId) = $provider->notificationReceived('REQUEST_RESHARE', $id, $notification);
+            return new Http\DataResponse([
+                'token' => $newToken,
+                'remoteId' => $localId
+            ]);
+        } catch (ProviderDoesNotExistsException $e) {
+            throw new OCSException('Server does not support federated cloud sharing', 503);
+        } catch (ShareNotFound $e) {
+            $this->logger->debug('Share not found: ' . $e->getMessage());
+        } catch (\Exception $e) {
+            $this->logger->debug('internal server error, can not process notification: ' . $e->getMessage());
+        }
+
+        throw new OCSBadRequestException();
+    }
+
+
+    /**
+     * @NoCSRFRequired
+     * @PublicPage
+     *
+     * accept server-to-server share
+     *
+     * @param int $id
+     * @return Http\DataResponse
+     * @throws OCSException
+     * @throws ShareNotFound
+     * @throws \OC\HintException
+     */
+    public function acceptShare($id) {
+
+        $token = isset($_POST['token']) ? $_POST['token'] : null;
+
+        $notification = [
+            'sharedSecret' => $token,
+            'message' => 'Recipient accept the share'
+        ];
+
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
+            $provider->notificationReceived('SHARE_ACCEPTED', $id, $notification);
+        } catch (ProviderDoesNotExistsException $e) {
+            throw new OCSException('Server does not support federated cloud sharing', 503);
+        } catch (ShareNotFound $e) {
+            $this->logger->debug('Share not found: ' . $e->getMessage());
+        } catch (\Exception $e) {
+            $this->logger->debug('internal server error, can not process notification: ' . $e->getMessage());
+        }
+
+        return new Http\DataResponse();
+    }
+
+    /**
+     * @NoCSRFRequired
+     * @PublicPage
+     *
+     * decline server-to-server share
+     *
+     * @param int $id
+     * @return Http\DataResponse
+     * @throws OCSException
+     */
+    public function declineShare($id) {
+
+        $token = isset($_POST['token']) ? $_POST['token'] : null;
+
+        $notification = [
+            'sharedSecret' => $token,
+            'message' => 'Recipient declined the share'
+        ];
+
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
+            $provider->notificationReceived('SHARE_DECLINED', $id, $notification);
+        } catch (ProviderDoesNotExistsException $e) {
+            throw new OCSException('Server does not support federated cloud sharing', 503);
+        } catch (ShareNotFound $e) {
+            $this->logger->debug('Share not found: ' . $e->getMessage());
+        } catch (\Exception $e) {
+            $this->logger->debug('internal server error, can not process notification: ' . $e->getMessage());
+        }
+
+        return new Http\DataResponse();
+    }
+
+    /**
+     * @NoCSRFRequired
+     * @PublicPage
+     *
+     * remove server-to-server share if it was unshared by the owner
+     *
+     * @param int $id
+     * @return Http\DataResponse
+     * @throws OCSException
+     */
+    public function unshare($id) {
+
+        if (!$this->isS2SEnabled()) {
+            throw new OCSException('Server does not support federated cloud sharing', 503);
+        }
+
+        $token = isset($_POST['token']) ? $_POST['token'] : null;
+
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
+            $notification = ['sharedSecret' => $token];
+            $provider->notificationReceived('SHARE_UNSHARED', $id, $notification);
+        } catch (\Exception $e) {
+            $this->logger->debug('processing unshare notification failed: ' . $e->getMessage());
+        }
+
+        return new Http\DataResponse();
+    }
+
+    private function cleanupRemote($remote) {
+        $remote = substr($remote, strpos($remote, '://') + 3);
+
+        return rtrim($remote, '/');
+    }
+
+
+    /**
+     * @NoCSRFRequired
+     * @PublicPage
+     *
+     * federated share was revoked, either by the owner or the re-sharer
+     *
+     * @param int $id
+     * @return Http\DataResponse
+     * @throws OCSBadRequestException
+     */
+    public function revoke($id) {
+
+        $token = $this->request->getParam('token');
+
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
+            $notification = ['sharedSecret' => $token];
+            $provider->notificationReceived('RESHARE_UNDO', $id, $notification);
+            return new Http\DataResponse();
+        } catch (\Exception $e) {
+            throw new OCSBadRequestException();
+        }
+
+    }
+
+    /**
+     * check if server-to-server sharing is enabled
+     *
+     * @param bool $incoming
+     * @return bool
+     */
+    private function isS2SEnabled($incoming = false) {
+
+        $result = \OCP\App::isEnabled('files_sharing');
+
+        if ($incoming) {
+            $result = $result && $this->federatedShareProvider->isIncomingServer2serverShareEnabled();
+        } else {
+            $result = $result && $this->federatedShareProvider->isOutgoingServer2serverShareEnabled();
+        }
+
+        return $result;
+    }
+
+    /**
+     * @NoCSRFRequired
+     * @PublicPage
+     *
+     * update share information to keep federated re-shares in sync
+     *
+     * @param int $id
+     * @return Http\DataResponse
+     * @throws OCSBadRequestException
+     */
+    public function updatePermissions($id) {
+        $token = $this->request->getParam('token', null);
+        $ncPermissions = $this->request->getParam('permissions', null);
+
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
+            $ocmPermissions = $this->ncPermissions2ocmPermissions((int)$ncPermissions);
+            $notification = ['sharedSecret' => $token, 'permission' => $ocmPermissions];
+            $provider->notificationReceived('RESHARE_CHANGE_PERMISSION', $id, $notification);
+        } catch (\Exception $e) {
+            $this->logger->debug($e->getMessage());
+            throw new OCSBadRequestException();
+        }
+
+        return new Http\DataResponse();
+    }
+
+    /**
+     * translate Nextcloud permissions to OCM Permissions
+     *
+     * @param $ncPermissions
+     * @return array
+     */
+    protected function ncPermissions2ocmPermissions($ncPermissions) {
+
+        $ocmPermissions = [];
+
+        if ($ncPermissions & Constants::PERMISSION_SHARE) {
+            $ocmPermissions[] = 'share';
+        }
+
+        if ($ncPermissions & Constants::PERMISSION_READ) {
+            $ocmPermissions[] = 'read';
+        }
+
+        if (($ncPermissions & Constants::PERMISSION_CREATE) ||
+            ($ncPermissions & Constants::PERMISSION_UPDATE)) {
+            $ocmPermissions[] = 'write';
+        }
+
+        return $ocmPermissions;
+
+    }
+
+    /**
+     * @NoCSRFRequired
+     * @PublicPage
+     *
+     * change the owner of a server-to-server share
+     *
+     * @param int $id
+     * @return Http\DataResponse
+     * @throws \InvalidArgumentException
+     * @throws OCSException
+     */
+    public function move($id) {
+
+        if (!$this->isS2SEnabled()) {
+            throw new OCSException('Server does not support federated cloud sharing', 503);
+        }
+
+        $token = $this->request->getParam('token');
+        $remote = $this->request->getParam('remote');
+        $newRemoteId = $this->request->getParam('remote_id', $id);
+        $cloudId = $this->cloudIdManager->resolveCloudId($remote);
+
+        $qb = $this->connection->getQueryBuilder();
+        $query = $qb->update('share_external')
+            ->set('remote', $qb->createNamedParameter($cloudId->getRemote()))
+            ->set('owner', $qb->createNamedParameter($cloudId->getUser()))
+            ->set('remote_id', $qb->createNamedParameter($newRemoteId))
+            ->where($qb->expr()->eq('remote_id', $qb->createNamedParameter($id)))
+            ->andWhere($qb->expr()->eq('share_token', $qb->createNamedParameter($token)));
+        $affected = $query->execute();
+
+        if ($affected > 0) {
+            return new Http\DataResponse(['remote' => $cloudId->getRemote(), 'owner' => $cloudId->getUser()]);
+        } else {
+            throw new OCSBadRequestException('Share not found or token invalid');
+        }
+    }
 }

apps/cloud_federation_api/lib/Controller/RequestHandlerController.php

Indentation +195 added lines, -195 removed lines

@@ -51,225 +51,225 @@
  */
 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 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) {
+    /**
+     * 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 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) {
 
-		// 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
+            );
+        }
 
-		$user = $this->userManager->get($shareWithLocalId);
-		$recipientDisplayName = '';
-		if($user) {
-			$recipientDisplayName = $user->getDisplayName();
-		}
+        $user = $this->userManager->get($shareWithLocalId);
+        $recipientDisplayName = '';
+        if($user) {
+            $recipientDisplayName = $user->getDisplayName();
+        }
 
-		return new JSONResponse(
-			['recipientDisplayName' => $recipientDisplayName],
-			Http::STATUS_CREATED);
+        return new JSONResponse(
+            ['recipientDisplayName' => $recipientDisplayName],
+            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) {
+    /**
+     * 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) {
 
-		// 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);
-			$result = $provider->notificationReceived($notificationType, $providerId, $notification);
-		} catch (ProviderDoesNotExistsException $e) {
-			return new JSONResponse(
-				['message' => $e->getMessage()],
-				Http::STATUS_BAD_REQUEST
-			);
-		} catch (ShareNotFound $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);
+            $result = $provider->notificationReceived($notificationType, $providerId, $notification);
+        } catch (ProviderDoesNotExistsException $e) {
+            return new JSONResponse(
+                ['message' => $e->getMessage()],
+                Http::STATUS_BAD_REQUEST
+            );
+        } catch (ShareNotFound $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($result,Http::STATUS_CREATED);
+        return new JSONResponse($result,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;
+    }
 
 }

apps/cloud_federation_api/lib/Config.php

Indentation +18 added lines, -18 removed lines

@@ -35,23 +35,23 @@
  */
 class Config {
 
-	/** @var ICloudFederationProviderManager */
-	private $cloudFederationProviderManager;
-
-	public function __construct(ICloudFederationProviderManager $cloudFederationProviderManager) {
-		$this->cloudFederationProviderManager = $cloudFederationProviderManager;
-	}
-
-	/**
-	 * get a list of supported share types
-	 *
-	 * @param string $resourceType
-	 * @return array
-	 * @throws \OCP\Federation\Exceptions\ProviderDoesNotExistsException
-	 */
-	public function getSupportedShareTypes($resourceType) {
-		$provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
-		return $provider->getSupportedShareTypes();
-	}
+    /** @var ICloudFederationProviderManager */
+    private $cloudFederationProviderManager;
+
+    public function __construct(ICloudFederationProviderManager $cloudFederationProviderManager) {
+        $this->cloudFederationProviderManager = $cloudFederationProviderManager;
+    }
+
+    /**
+     * get a list of supported share types
+     *
+     * @param string $resourceType
+     * @return array
+     * @throws \OCP\Federation\Exceptions\ProviderDoesNotExistsException
+     */
+    public function getSupportedShareTypes($resourceType) {
+        $provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
+        return $provider->getSupportedShareTypes();
+    }
 
 }

apps/files_sharing/lib/External/Storage.php

Indentation +376 added lines, -376 removed lines

@@ -43,380 +43,380 @@
 use OCP\Files\StorageNotAvailableException;
 
 class Storage extends DAV implements ISharedStorage {
-	/** @var ICloudId */
-	private $cloudId;
-	/** @var string */
-	private $mountPoint;
-	/** @var string */
-	private $token;
-	/** @var \OCP\ICacheFactory */
-	private $memcacheFactory;
-	/** @var \OCP\Http\Client\IClientService */
-	private $httpClient;
-	/** @var bool */
-	private $updateChecked = false;
-
-	/**
-	 * @var \OCA\Files_Sharing\External\Manager
-	 */
-	private $manager;
-
-	public function __construct($options) {
-		$this->memcacheFactory = \OC::$server->getMemCacheFactory();
-		$this->httpClient = $options['HttpClientService'];
-
-		$this->manager = $options['manager'];
-		$this->cloudId = $options['cloudId'];
-		$discoveryService = \OC::$server->query(\OCP\OCS\IDiscoveryService::class);
-
-		list($protocol, $remote) = explode('://', $this->cloudId->getRemote());
-		if (strpos($remote, '/')) {
-			list($host, $root) = explode('/', $remote, 2);
-		} else {
-			$host = $remote;
-			$root = '';
-		}
-		$secure = $protocol === 'https';
-		$federatedSharingEndpoints = $discoveryService->discover($this->cloudId->getRemote(), 'FEDERATED_SHARING');
-		$webDavEndpoint = isset($federatedSharingEndpoints['webdav']) ? $federatedSharingEndpoints['webdav'] : '/public.php/webdav';
-		$root = rtrim($root, '/') . $webDavEndpoint;
-		$this->mountPoint = $options['mountpoint'];
-		$this->token = $options['token'];
-
-		parent::__construct(array(
-			'secure' => $secure,
-			'host' => $host,
-			'root' => $root,
-			'user' => $options['token'],
-			'password' => (string)$options['password']
-		));
-	}
-
-	public function getWatcher($path = '', $storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		if (!isset($this->watcher)) {
-			$this->watcher = new Watcher($storage);
-			$this->watcher->setPolicy(\OC\Files\Cache\Watcher::CHECK_ONCE);
-		}
-		return $this->watcher;
-	}
-
-	public function getRemoteUser() {
-		return $this->cloudId->getUser();
-	}
-
-	public function getRemote() {
-		return $this->cloudId->getRemote();
-	}
-
-	public function getMountPoint() {
-		return $this->mountPoint;
-	}
-
-	public function getToken() {
-		return $this->token;
-	}
-
-	public function getPassword() {
-		return $this->password;
-	}
-
-	/**
-	 * @brief get id of the mount point
-	 * @return string
-	 */
-	public function getId() {
-		return 'shared::' . md5($this->token . '@' . $this->getRemote());
-	}
-
-	public function getCache($path = '', $storage = null) {
-		if (is_null($this->cache)) {
-			$this->cache = new Cache($this, $this->cloudId);
-		}
-		return $this->cache;
-	}
-
-	/**
-	 * @param string $path
-	 * @param \OC\Files\Storage\Storage $storage
-	 * @return \OCA\Files_Sharing\External\Scanner
-	 */
-	public function getScanner($path = '', $storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		if (!isset($this->scanner)) {
-			$this->scanner = new Scanner($storage);
-		}
-		return $this->scanner;
-	}
-
-	/**
-	 * check if a file or folder has been updated since $time
-	 *
-	 * @param string $path
-	 * @param int $time
-	 * @throws \OCP\Files\StorageNotAvailableException
-	 * @throws \OCP\Files\StorageInvalidException
-	 * @return bool
-	 */
-	public function hasUpdated($path, $time) {
-		// since for owncloud webdav servers we can rely on etag propagation we only need to check the root of the storage
-		// because of that we only do one check for the entire storage per request
-		if ($this->updateChecked) {
-			return false;
-		}
-		$this->updateChecked = true;
-		try {
-			return parent::hasUpdated('', $time);
-		} catch (StorageInvalidException $e) {
-			// check if it needs to be removed
-			$this->checkStorageAvailability();
-			throw $e;
-		} catch (StorageNotAvailableException $e) {
-			// check if it needs to be removed or just temp unavailable
-			$this->checkStorageAvailability();
-			throw $e;
-		}
-	}
-
-	public function test() {
-		try {
-			return parent::test();
-		} catch (StorageInvalidException $e) {
-			// check if it needs to be removed
-			$this->checkStorageAvailability();
-			throw $e;
-		} catch (StorageNotAvailableException $e) {
-			// check if it needs to be removed or just temp unavailable
-			$this->checkStorageAvailability();
-			throw $e;
-		}
-	}
-
-	/**
-	 * Check whether this storage is permanently or temporarily
-	 * unavailable
-	 *
-	 * @throws \OCP\Files\StorageNotAvailableException
-	 * @throws \OCP\Files\StorageInvalidException
-	 */
-	public function checkStorageAvailability() {
-		// see if we can find out why the share is unavailable
-		try {
-			$this->getShareInfo();
-		} catch (NotFoundException $e) {
-			// a 404 can either mean that the share no longer exists or there is no Nextcloud on the remote
-			if ($this->testRemote()) {
-				// valid Nextcloud instance means that the public share no longer exists
-				// since this is permanent (re-sharing the file will create a new token)
-				// we remove the invalid storage
-				$this->manager->removeShare($this->mountPoint);
-				$this->manager->getMountManager()->removeMount($this->mountPoint);
-				throw new StorageInvalidException();
-			} else {
-				// Nextcloud instance is gone, likely to be a temporary server configuration error
-				throw new StorageNotAvailableException();
-			}
-		} catch (ForbiddenException $e) {
-			// auth error, remove share for now (provide a dialog in the future)
-			$this->manager->removeShare($this->mountPoint);
-			$this->manager->getMountManager()->removeMount($this->mountPoint);
-			throw new StorageInvalidException();
-		} catch (\GuzzleHttp\Exception\ConnectException $e) {
-			throw new StorageNotAvailableException();
-		} catch (\GuzzleHttp\Exception\RequestException $e) {
-			throw new StorageNotAvailableException();
-		} catch (\Exception $e) {
-			throw $e;
-		}
-	}
-
-	public function file_exists($path) {
-		if ($path === '') {
-			return true;
-		} else {
-			return parent::file_exists($path);
-		}
-	}
-
-	/**
-	 * check if the configured remote is a valid federated share provider
-	 *
-	 * @return bool
-	 */
-	protected function testRemote() {
-		try {
-			return $this->testRemoteUrl($this->getRemote() . '/ocs-provider/index.php')
-				|| $this->testRemoteUrl($this->getRemote() . '/ocs-provider/')
-				|| $this->testRemoteUrl($this->getRemote() . '/status.php');
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * @param string $url
-	 * @return bool
-	 */
-	private function testRemoteUrl($url) {
-		$cache = $this->memcacheFactory->createDistributed('files_sharing_remote_url');
-		if($cache->hasKey($url)) {
-			return (bool)$cache->get($url);
-		}
-
-		$client = $this->httpClient->newClient();
-		try {
-			$result = $client->get($url, [
-				'timeout' => 10,
-				'connect_timeout' => 10,
-			])->getBody();
-			$data = json_decode($result);
-			$returnValue = (is_object($data) && !empty($data->version));
-		} catch (ConnectException $e) {
-			$returnValue = false;
-		} catch (ClientException $e) {
-			$returnValue = false;
-		}
-
-		$cache->set($url, $returnValue, 60*60*24);
-		return $returnValue;
-	}
-
-	/**
-	 * Whether the remote is an ownCloud/Nextcloud, used since some sharing features are not
-	 * standardized. Let's use this to detect whether to use it.
-	 *
-	 * @return bool
-	 */
-	public function remoteIsOwnCloud() {
-		if(defined('PHPUNIT_RUN') || !$this->testRemoteUrl($this->getRemote() . '/status.php')) {
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	 * @return mixed
-	 * @throws ForbiddenException
-	 * @throws NotFoundException
-	 * @throws \Exception
-	 */
-	public function getShareInfo() {
-		$remote = $this->getRemote();
-		$token = $this->getToken();
-		$password = $this->getPassword();
-
-		// If remote is not an ownCloud do not try to get any share info
-		if(!$this->remoteIsOwnCloud()) {
-			return ['status' => 'unsupported'];
-		}
-
-		$url = rtrim($remote, '/') . '/index.php/apps/files_sharing/shareinfo?t=' . $token;
-
-		// TODO: DI
-		$client = \OC::$server->getHTTPClientService()->newClient();
-		try {
-			$response = $client->post($url, [
-				'body' => ['password' => $password],
-				'timeout' => 10,
-				'connect_timeout' => 10,
-			]);
-		} catch (\GuzzleHttp\Exception\RequestException $e) {
-			if ($e->getCode() === Http::STATUS_UNAUTHORIZED || $e->getCode() === Http::STATUS_FORBIDDEN) {
-				throw new ForbiddenException();
-			}
-			if ($e->getCode() === Http::STATUS_NOT_FOUND) {
-				throw new NotFoundException();
-			}
-			// throw this to be on the safe side: the share will still be visible
-			// in the UI in case the failure is intermittent, and the user will
-			// be able to decide whether to remove it if it's really gone
-			throw new StorageNotAvailableException();
-		}
-
-		return json_decode($response->getBody(), true);
-	}
-
-	public function getOwner($path) {
-		return $this->cloudId->getDisplayId();
-	}
-
-	public function isSharable($path) {
-		if (\OCP\Util::isSharingDisabledForUser() || !\OC\Share\Share::isResharingAllowed()) {
-			return false;
-		}
-		return ($this->getPermissions($path) & Constants::PERMISSION_SHARE);
-	}
-
-	public function getPermissions($path) {
-		$response = $this->propfind($path);
-		// old federated sharing permissions
-		if (isset($response['{http://open-collaboration-services.org/ns}share-permissions'])) {
-			$permissions = $response['{http://open-collaboration-services.org/ns}share-permissions'];
-		} else if (isset($response['{http://open-cloud-mesh.org/ns}share-permissions'])) {
-			// permissions provided by the OCM API
-			$permissions = $this->ocmPermissions2ncPermissions($response['{http://open-collaboration-services.org/ns}share-permissions']);
-		} else {
-			// use default permission if remote server doesn't provide the share permissions
-			$permissions = $this->getDefaultPermissions($path);
-		}
-
-		return $permissions;
-	}
-
-	public function needsPartFile() {
-		return false;
-	}
-
-	/**
-	 * translate OCM Permissions to Nextcloud permissions
-	 *
-	 * @param string $ocmPermissions json encoded OCM permissions
-	 * @param string $path path to file
-	 * @return int
-	 */
-	protected function ocmPermissions2ncPermissions($ocmPermissions, $path) {
-		try {
-			$ocmPermissions = json_decode($ocmPermissions);
-			$ncPermissions = 0;
-			foreach($ocmPermissions as $permission) {
-				switch (strtolower($permission)) {
-					case 'read':
-						$ncPermissions += Constants::PERMISSION_READ;
-						break;
-					case 'write':
-						$ncPermissions += Constants::PERMISSION_CREATE + Constants::PERMISSION_UPDATE;
-						break;
-					case 'share':
-						$ncPermissions += Constants::PERMISSION_SHARE;
-						break;
-					default:
-						throw new \Exception();
-				}
-			}
-		} catch (\Exception $e) {
-			$ncPermissions = $this->getDefaultPermissions($path);
-		}
-
-		return $ncPermissions;
-	}
-
-	/**
-	 * calculate default permissions in case no permissions are provided
-	 *
-	 * @param $path
-	 * @return int
-	 */
-	protected function getDefaultPermissions($path) {
-		if ($this->is_dir($path)) {
-			$permissions = Constants::PERMISSION_ALL;
-		} else {
-			$permissions = Constants::PERMISSION_ALL & ~Constants::PERMISSION_CREATE;
-		}
-
-		return $permissions;
-	}
+    /** @var ICloudId */
+    private $cloudId;
+    /** @var string */
+    private $mountPoint;
+    /** @var string */
+    private $token;
+    /** @var \OCP\ICacheFactory */
+    private $memcacheFactory;
+    /** @var \OCP\Http\Client\IClientService */
+    private $httpClient;
+    /** @var bool */
+    private $updateChecked = false;
+
+    /**
+     * @var \OCA\Files_Sharing\External\Manager
+     */
+    private $manager;
+
+    public function __construct($options) {
+        $this->memcacheFactory = \OC::$server->getMemCacheFactory();
+        $this->httpClient = $options['HttpClientService'];
+
+        $this->manager = $options['manager'];
+        $this->cloudId = $options['cloudId'];
+        $discoveryService = \OC::$server->query(\OCP\OCS\IDiscoveryService::class);
+
+        list($protocol, $remote) = explode('://', $this->cloudId->getRemote());
+        if (strpos($remote, '/')) {
+            list($host, $root) = explode('/', $remote, 2);
+        } else {
+            $host = $remote;
+            $root = '';
+        }
+        $secure = $protocol === 'https';
+        $federatedSharingEndpoints = $discoveryService->discover($this->cloudId->getRemote(), 'FEDERATED_SHARING');
+        $webDavEndpoint = isset($federatedSharingEndpoints['webdav']) ? $federatedSharingEndpoints['webdav'] : '/public.php/webdav';
+        $root = rtrim($root, '/') . $webDavEndpoint;
+        $this->mountPoint = $options['mountpoint'];
+        $this->token = $options['token'];
+
+        parent::__construct(array(
+            'secure' => $secure,
+            'host' => $host,
+            'root' => $root,
+            'user' => $options['token'],
+            'password' => (string)$options['password']
+        ));
+    }
+
+    public function getWatcher($path = '', $storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        if (!isset($this->watcher)) {
+            $this->watcher = new Watcher($storage);
+            $this->watcher->setPolicy(\OC\Files\Cache\Watcher::CHECK_ONCE);
+        }
+        return $this->watcher;
+    }
+
+    public function getRemoteUser() {
+        return $this->cloudId->getUser();
+    }
+
+    public function getRemote() {
+        return $this->cloudId->getRemote();
+    }
+
+    public function getMountPoint() {
+        return $this->mountPoint;
+    }
+
+    public function getToken() {
+        return $this->token;
+    }
+
+    public function getPassword() {
+        return $this->password;
+    }
+
+    /**
+     * @brief get id of the mount point
+     * @return string
+     */
+    public function getId() {
+        return 'shared::' . md5($this->token . '@' . $this->getRemote());
+    }
+
+    public function getCache($path = '', $storage = null) {
+        if (is_null($this->cache)) {
+            $this->cache = new Cache($this, $this->cloudId);
+        }
+        return $this->cache;
+    }
+
+    /**
+     * @param string $path
+     * @param \OC\Files\Storage\Storage $storage
+     * @return \OCA\Files_Sharing\External\Scanner
+     */
+    public function getScanner($path = '', $storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        if (!isset($this->scanner)) {
+            $this->scanner = new Scanner($storage);
+        }
+        return $this->scanner;
+    }
+
+    /**
+     * check if a file or folder has been updated since $time
+     *
+     * @param string $path
+     * @param int $time
+     * @throws \OCP\Files\StorageNotAvailableException
+     * @throws \OCP\Files\StorageInvalidException
+     * @return bool
+     */
+    public function hasUpdated($path, $time) {
+        // since for owncloud webdav servers we can rely on etag propagation we only need to check the root of the storage
+        // because of that we only do one check for the entire storage per request
+        if ($this->updateChecked) {
+            return false;
+        }
+        $this->updateChecked = true;
+        try {
+            return parent::hasUpdated('', $time);
+        } catch (StorageInvalidException $e) {
+            // check if it needs to be removed
+            $this->checkStorageAvailability();
+            throw $e;
+        } catch (StorageNotAvailableException $e) {
+            // check if it needs to be removed or just temp unavailable
+            $this->checkStorageAvailability();
+            throw $e;
+        }
+    }
+
+    public function test() {
+        try {
+            return parent::test();
+        } catch (StorageInvalidException $e) {
+            // check if it needs to be removed
+            $this->checkStorageAvailability();
+            throw $e;
+        } catch (StorageNotAvailableException $e) {
+            // check if it needs to be removed or just temp unavailable
+            $this->checkStorageAvailability();
+            throw $e;
+        }
+    }
+
+    /**
+     * Check whether this storage is permanently or temporarily
+     * unavailable
+     *
+     * @throws \OCP\Files\StorageNotAvailableException
+     * @throws \OCP\Files\StorageInvalidException
+     */
+    public function checkStorageAvailability() {
+        // see if we can find out why the share is unavailable
+        try {
+            $this->getShareInfo();
+        } catch (NotFoundException $e) {
+            // a 404 can either mean that the share no longer exists or there is no Nextcloud on the remote
+            if ($this->testRemote()) {
+                // valid Nextcloud instance means that the public share no longer exists
+                // since this is permanent (re-sharing the file will create a new token)
+                // we remove the invalid storage
+                $this->manager->removeShare($this->mountPoint);
+                $this->manager->getMountManager()->removeMount($this->mountPoint);
+                throw new StorageInvalidException();
+            } else {
+                // Nextcloud instance is gone, likely to be a temporary server configuration error
+                throw new StorageNotAvailableException();
+            }
+        } catch (ForbiddenException $e) {
+            // auth error, remove share for now (provide a dialog in the future)
+            $this->manager->removeShare($this->mountPoint);
+            $this->manager->getMountManager()->removeMount($this->mountPoint);
+            throw new StorageInvalidException();
+        } catch (\GuzzleHttp\Exception\ConnectException $e) {
+            throw new StorageNotAvailableException();
+        } catch (\GuzzleHttp\Exception\RequestException $e) {
+            throw new StorageNotAvailableException();
+        } catch (\Exception $e) {
+            throw $e;
+        }
+    }
+
+    public function file_exists($path) {
+        if ($path === '') {
+            return true;
+        } else {
+            return parent::file_exists($path);
+        }
+    }
+
+    /**
+     * check if the configured remote is a valid federated share provider
+     *
+     * @return bool
+     */
+    protected function testRemote() {
+        try {
+            return $this->testRemoteUrl($this->getRemote() . '/ocs-provider/index.php')
+                || $this->testRemoteUrl($this->getRemote() . '/ocs-provider/')
+                || $this->testRemoteUrl($this->getRemote() . '/status.php');
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * @param string $url
+     * @return bool
+     */
+    private function testRemoteUrl($url) {
+        $cache = $this->memcacheFactory->createDistributed('files_sharing_remote_url');
+        if($cache->hasKey($url)) {
+            return (bool)$cache->get($url);
+        }
+
+        $client = $this->httpClient->newClient();
+        try {
+            $result = $client->get($url, [
+                'timeout' => 10,
+                'connect_timeout' => 10,
+            ])->getBody();
+            $data = json_decode($result);
+            $returnValue = (is_object($data) && !empty($data->version));
+        } catch (ConnectException $e) {
+            $returnValue = false;
+        } catch (ClientException $e) {
+            $returnValue = false;
+        }
+
+        $cache->set($url, $returnValue, 60*60*24);
+        return $returnValue;
+    }
+
+    /**
+     * Whether the remote is an ownCloud/Nextcloud, used since some sharing features are not
+     * standardized. Let's use this to detect whether to use it.
+     *
+     * @return bool
+     */
+    public function remoteIsOwnCloud() {
+        if(defined('PHPUNIT_RUN') || !$this->testRemoteUrl($this->getRemote() . '/status.php')) {
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * @return mixed
+     * @throws ForbiddenException
+     * @throws NotFoundException
+     * @throws \Exception
+     */
+    public function getShareInfo() {
+        $remote = $this->getRemote();
+        $token = $this->getToken();
+        $password = $this->getPassword();
+
+        // If remote is not an ownCloud do not try to get any share info
+        if(!$this->remoteIsOwnCloud()) {
+            return ['status' => 'unsupported'];
+        }
+
+        $url = rtrim($remote, '/') . '/index.php/apps/files_sharing/shareinfo?t=' . $token;
+
+        // TODO: DI
+        $client = \OC::$server->getHTTPClientService()->newClient();
+        try {
+            $response = $client->post($url, [
+                'body' => ['password' => $password],
+                'timeout' => 10,
+                'connect_timeout' => 10,
+            ]);
+        } catch (\GuzzleHttp\Exception\RequestException $e) {
+            if ($e->getCode() === Http::STATUS_UNAUTHORIZED || $e->getCode() === Http::STATUS_FORBIDDEN) {
+                throw new ForbiddenException();
+            }
+            if ($e->getCode() === Http::STATUS_NOT_FOUND) {
+                throw new NotFoundException();
+            }
+            // throw this to be on the safe side: the share will still be visible
+            // in the UI in case the failure is intermittent, and the user will
+            // be able to decide whether to remove it if it's really gone
+            throw new StorageNotAvailableException();
+        }
+
+        return json_decode($response->getBody(), true);
+    }
+
+    public function getOwner($path) {
+        return $this->cloudId->getDisplayId();
+    }
+
+    public function isSharable($path) {
+        if (\OCP\Util::isSharingDisabledForUser() || !\OC\Share\Share::isResharingAllowed()) {
+            return false;
+        }
+        return ($this->getPermissions($path) & Constants::PERMISSION_SHARE);
+    }
+
+    public function getPermissions($path) {
+        $response = $this->propfind($path);
+        // old federated sharing permissions
+        if (isset($response['{http://open-collaboration-services.org/ns}share-permissions'])) {
+            $permissions = $response['{http://open-collaboration-services.org/ns}share-permissions'];
+        } else if (isset($response['{http://open-cloud-mesh.org/ns}share-permissions'])) {
+            // permissions provided by the OCM API
+            $permissions = $this->ocmPermissions2ncPermissions($response['{http://open-collaboration-services.org/ns}share-permissions']);
+        } else {
+            // use default permission if remote server doesn't provide the share permissions
+            $permissions = $this->getDefaultPermissions($path);
+        }
+
+        return $permissions;
+    }
+
+    public function needsPartFile() {
+        return false;
+    }
+
+    /**
+     * translate OCM Permissions to Nextcloud permissions
+     *
+     * @param string $ocmPermissions json encoded OCM permissions
+     * @param string $path path to file
+     * @return int
+     */
+    protected function ocmPermissions2ncPermissions($ocmPermissions, $path) {
+        try {
+            $ocmPermissions = json_decode($ocmPermissions);
+            $ncPermissions = 0;
+            foreach($ocmPermissions as $permission) {
+                switch (strtolower($permission)) {
+                    case 'read':
+                        $ncPermissions += Constants::PERMISSION_READ;
+                        break;
+                    case 'write':
+                        $ncPermissions += Constants::PERMISSION_CREATE + Constants::PERMISSION_UPDATE;
+                        break;
+                    case 'share':
+                        $ncPermissions += Constants::PERMISSION_SHARE;
+                        break;
+                    default:
+                        throw new \Exception();
+                }
+            }
+        } catch (\Exception $e) {
+            $ncPermissions = $this->getDefaultPermissions($path);
+        }
+
+        return $ncPermissions;
+    }
+
+    /**
+     * calculate default permissions in case no permissions are provided
+     *
+     * @param $path
+     * @return int
+     */
+    protected function getDefaultPermissions($path) {
+        if ($this->is_dir($path)) {
+            $permissions = Constants::PERMISSION_ALL;
+        } else {
+            $permissions = Constants::PERMISSION_ALL & ~Constants::PERMISSION_CREATE;
+        }
+
+        return $permissions;
+    }
 }

apps/dav/lib/Connector/Sabre/FilesPlugin.php

Indentation +436 added lines, -436 removed lines

@@ -50,444 +50,444 @@
 
 class FilesPlugin extends ServerPlugin {
 
-	// namespace
-	const NS_OWNCLOUD = 'http://owncloud.org/ns';
-	const NS_NEXTCLOUD = 'http://nextcloud.org/ns';
-	const FILEID_PROPERTYNAME = '{http://owncloud.org/ns}id';
-	const INTERNAL_FILEID_PROPERTYNAME = '{http://owncloud.org/ns}fileid';
-	const PERMISSIONS_PROPERTYNAME = '{http://owncloud.org/ns}permissions';
-	const SHARE_PERMISSIONS_PROPERTYNAME = '{http://open-collaboration-services.org/ns}share-permissions';
-	const OCM_SHARE_PERMISSIONS_PROPERTYNAME = '{http://open-cloud-mesh.org/ns}share-permissions';
-	const DOWNLOADURL_PROPERTYNAME = '{http://owncloud.org/ns}downloadURL';
-	const SIZE_PROPERTYNAME = '{http://owncloud.org/ns}size';
-	const GETETAG_PROPERTYNAME = '{DAV:}getetag';
-	const LASTMODIFIED_PROPERTYNAME = '{DAV:}lastmodified';
-	const OWNER_ID_PROPERTYNAME = '{http://owncloud.org/ns}owner-id';
-	const OWNER_DISPLAY_NAME_PROPERTYNAME = '{http://owncloud.org/ns}owner-display-name';
-	const CHECKSUMS_PROPERTYNAME = '{http://owncloud.org/ns}checksums';
-	const DATA_FINGERPRINT_PROPERTYNAME = '{http://owncloud.org/ns}data-fingerprint';
-	const HAS_PREVIEW_PROPERTYNAME = '{http://nextcloud.org/ns}has-preview';
-	const MOUNT_TYPE_PROPERTYNAME = '{http://nextcloud.org/ns}mount-type';
-	const IS_ENCRYPTED_PROPERTYNAME = '{http://nextcloud.org/ns}is-encrypted';
-
-	/**
-	 * Reference to main server object
-	 *
-	 * @var \Sabre\DAV\Server
-	 */
-	private $server;
-
-	/**
-	 * @var Tree
-	 */
-	private $tree;
-
-	/**
-	 * Whether this is public webdav.
-	 * If true, some returned information will be stripped off.
-	 *
-	 * @var bool
-	 */
-	private $isPublic;
-
-	/**
-	 * @var bool
-	 */
-	private $downloadAttachment;
-
-	/**
-	 * @var IConfig
-	 */
-	private $config;
-
-	/**
-	 * @var IRequest
-	 */
-	private $request;
-
-	/**
-	 * @var IPreview
-	 */
-	private $previewManager;
-
-	/**
-	 * @param Tree $tree
-	 * @param IConfig $config
-	 * @param IRequest $request
-	 * @param IPreview $previewManager
-	 * @param bool $isPublic
-	 * @param bool $downloadAttachment
-	 */
-	public function __construct(Tree $tree,
-								IConfig $config,
-								IRequest $request,
-								IPreview $previewManager,
-								$isPublic = false,
-								$downloadAttachment = true) {
-		$this->tree = $tree;
-		$this->config = $config;
-		$this->request = $request;
-		$this->isPublic = $isPublic;
-		$this->downloadAttachment = $downloadAttachment;
-		$this->previewManager = $previewManager;
-	}
-
-	/**
-	 * This initializes the plugin.
-	 *
-	 * This function is called by \Sabre\DAV\Server, after
-	 * addPlugin is called.
-	 *
-	 * This method should set up the required event subscriptions.
-	 *
-	 * @param \Sabre\DAV\Server $server
-	 * @return void
-	 */
-	public function initialize(\Sabre\DAV\Server $server) {
-		$server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc';
-		$server->xml->namespaceMap[self::NS_NEXTCLOUD] = 'nc';
-		$server->protectedProperties[] = self::FILEID_PROPERTYNAME;
-		$server->protectedProperties[] = self::INTERNAL_FILEID_PROPERTYNAME;
-		$server->protectedProperties[] = self::PERMISSIONS_PROPERTYNAME;
-		$server->protectedProperties[] = self::SHARE_PERMISSIONS_PROPERTYNAME;
-		$server->protectedProperties[] = self::OCM_SHARE_PERMISSIONS_PROPERTYNAME;
-		$server->protectedProperties[] = self::SIZE_PROPERTYNAME;
-		$server->protectedProperties[] = self::DOWNLOADURL_PROPERTYNAME;
-		$server->protectedProperties[] = self::OWNER_ID_PROPERTYNAME;
-		$server->protectedProperties[] = self::OWNER_DISPLAY_NAME_PROPERTYNAME;
-		$server->protectedProperties[] = self::CHECKSUMS_PROPERTYNAME;
-		$server->protectedProperties[] = self::DATA_FINGERPRINT_PROPERTYNAME;
-		$server->protectedProperties[] = self::HAS_PREVIEW_PROPERTYNAME;
-		$server->protectedProperties[] = self::MOUNT_TYPE_PROPERTYNAME;
-		$server->protectedProperties[] = self::IS_ENCRYPTED_PROPERTYNAME;
-
-		// normally these cannot be changed (RFC4918), but we want them modifiable through PROPPATCH
-		$allowedProperties = ['{DAV:}getetag'];
-		$server->protectedProperties = array_diff($server->protectedProperties, $allowedProperties);
-
-		$this->server = $server;
-		$this->server->on('propFind', array($this, 'handleGetProperties'));
-		$this->server->on('propPatch', array($this, 'handleUpdateProperties'));
-		$this->server->on('afterBind', array($this, 'sendFileIdHeader'));
-		$this->server->on('afterWriteContent', array($this, 'sendFileIdHeader'));
-		$this->server->on('afterMethod:GET', [$this,'httpGet']);
-		$this->server->on('afterMethod:GET', array($this, 'handleDownloadToken'));
-		$this->server->on('afterResponse', function($request, ResponseInterface $response) {
-			$body = $response->getBody();
-			if (is_resource($body)) {
-				fclose($body);
-			}
-		});
-		$this->server->on('beforeMove', [$this, 'checkMove']);
-	}
-
-	/**
-	 * Plugin that checks if a move can actually be performed.
-	 *
-	 * @param string $source source path
-	 * @param string $destination destination path
-	 * @throws Forbidden
-	 * @throws NotFound
-	 */
-	function checkMove($source, $destination) {
-		$sourceNode = $this->tree->getNodeForPath($source);
-		if (!$sourceNode instanceof Node) {
-			return;
-		}
-		list($sourceDir,) = \Sabre\Uri\split($source);
-		list($destinationDir,) = \Sabre\Uri\split($destination);
-
-		if ($sourceDir !== $destinationDir) {
-			$sourceNodeFileInfo = $sourceNode->getFileInfo();
-			if ($sourceNodeFileInfo === null) {
-				throw new NotFound($source . ' does not exist');
- 			}
-
-			if (!$sourceNodeFileInfo->isDeletable()) {
-				throw new Forbidden($source . " cannot be deleted");
-			}
-		}
-	}
-
-	/**
-	 * This sets a cookie to be able to recognize the start of the download
-	 * the content must not be longer than 32 characters and must only contain
-	 * alphanumeric characters
-	 *
-	 * @param RequestInterface $request
-	 * @param ResponseInterface $response
-	 */
-	function handleDownloadToken(RequestInterface $request, ResponseInterface $response) {
-		$queryParams = $request->getQueryParameters();
-
-		/**
-		 * this sets a cookie to be able to recognize the start of the download
-		 * the content must not be longer than 32 characters and must only contain
-		 * alphanumeric characters
-		 */
-		if (isset($queryParams['downloadStartSecret'])) {
-			$token = $queryParams['downloadStartSecret'];
-			if (!isset($token[32])
-				&& preg_match('!^[a-zA-Z0-9]+$!', $token) === 1) {
-				// FIXME: use $response->setHeader() instead
-				setcookie('ocDownloadStarted', $token, time() + 20, '/');
-			}
-		}
-	}
-
-	/**
-	 * Add headers to file download
-	 *
-	 * @param RequestInterface $request
-	 * @param ResponseInterface $response
-	 */
-	function httpGet(RequestInterface $request, ResponseInterface $response) {
-		// Only handle valid files
-		$node = $this->tree->getNodeForPath($request->getPath());
-		if (!($node instanceof IFile)) return;
-
-		// adds a 'Content-Disposition: attachment' header in case no disposition
-		// header has been set before
-		if ($this->downloadAttachment &&
-			$response->getHeader('Content-Disposition') === null) {
-			$filename = $node->getName();
-			if ($this->request->isUserAgent(
-				[
-					Request::USER_AGENT_IE,
-					Request::USER_AGENT_ANDROID_MOBILE_CHROME,
-					Request::USER_AGENT_FREEBOX,
-				])) {
-				$response->addHeader('Content-Disposition', 'attachment; filename="' . rawurlencode($filename) . '"');
-			} else {
-				$response->addHeader('Content-Disposition', 'attachment; filename*=UTF-8\'\'' . rawurlencode($filename)
-													 . '; filename="' . rawurlencode($filename) . '"');
-			}
-		}
-
-		if ($node instanceof \OCA\DAV\Connector\Sabre\File) {
-			//Add OC-Checksum header
-			/** @var $node File */
-			$checksum = $node->getChecksum();
-			if ($checksum !== null && $checksum !== '') {
-				$response->addHeader('OC-Checksum', $checksum);
-			}
-		}
-	}
-
-	/**
-	 * Adds all ownCloud-specific properties
-	 *
-	 * @param PropFind $propFind
-	 * @param \Sabre\DAV\INode $node
-	 * @return void
-	 */
-	public function handleGetProperties(PropFind $propFind, \Sabre\DAV\INode $node) {
-
-		$httpRequest = $this->server->httpRequest;
-
-		if ($node instanceof \OCA\DAV\Connector\Sabre\Node) {
-			/**
-			 * This was disabled, because it made dir listing throw an exception,
-			 * so users were unable to navigate into folders where one subitem
-			 * is blocked by the files_accesscontrol app, see:
-			 * https://github.com/nextcloud/files_accesscontrol/issues/65
+    // namespace
+    const NS_OWNCLOUD = 'http://owncloud.org/ns';
+    const NS_NEXTCLOUD = 'http://nextcloud.org/ns';
+    const FILEID_PROPERTYNAME = '{http://owncloud.org/ns}id';
+    const INTERNAL_FILEID_PROPERTYNAME = '{http://owncloud.org/ns}fileid';
+    const PERMISSIONS_PROPERTYNAME = '{http://owncloud.org/ns}permissions';
+    const SHARE_PERMISSIONS_PROPERTYNAME = '{http://open-collaboration-services.org/ns}share-permissions';
+    const OCM_SHARE_PERMISSIONS_PROPERTYNAME = '{http://open-cloud-mesh.org/ns}share-permissions';
+    const DOWNLOADURL_PROPERTYNAME = '{http://owncloud.org/ns}downloadURL';
+    const SIZE_PROPERTYNAME = '{http://owncloud.org/ns}size';
+    const GETETAG_PROPERTYNAME = '{DAV:}getetag';
+    const LASTMODIFIED_PROPERTYNAME = '{DAV:}lastmodified';
+    const OWNER_ID_PROPERTYNAME = '{http://owncloud.org/ns}owner-id';
+    const OWNER_DISPLAY_NAME_PROPERTYNAME = '{http://owncloud.org/ns}owner-display-name';
+    const CHECKSUMS_PROPERTYNAME = '{http://owncloud.org/ns}checksums';
+    const DATA_FINGERPRINT_PROPERTYNAME = '{http://owncloud.org/ns}data-fingerprint';
+    const HAS_PREVIEW_PROPERTYNAME = '{http://nextcloud.org/ns}has-preview';
+    const MOUNT_TYPE_PROPERTYNAME = '{http://nextcloud.org/ns}mount-type';
+    const IS_ENCRYPTED_PROPERTYNAME = '{http://nextcloud.org/ns}is-encrypted';
+
+    /**
+     * Reference to main server object
+     *
+     * @var \Sabre\DAV\Server
+     */
+    private $server;
+
+    /**
+     * @var Tree
+     */
+    private $tree;
+
+    /**
+     * Whether this is public webdav.
+     * If true, some returned information will be stripped off.
+     *
+     * @var bool
+     */
+    private $isPublic;
+
+    /**
+     * @var bool
+     */
+    private $downloadAttachment;
+
+    /**
+     * @var IConfig
+     */
+    private $config;
+
+    /**
+     * @var IRequest
+     */
+    private $request;
+
+    /**
+     * @var IPreview
+     */
+    private $previewManager;
+
+    /**
+     * @param Tree $tree
+     * @param IConfig $config
+     * @param IRequest $request
+     * @param IPreview $previewManager
+     * @param bool $isPublic
+     * @param bool $downloadAttachment
+     */
+    public function __construct(Tree $tree,
+                                IConfig $config,
+                                IRequest $request,
+                                IPreview $previewManager,
+                                $isPublic = false,
+                                $downloadAttachment = true) {
+        $this->tree = $tree;
+        $this->config = $config;
+        $this->request = $request;
+        $this->isPublic = $isPublic;
+        $this->downloadAttachment = $downloadAttachment;
+        $this->previewManager = $previewManager;
+    }
+
+    /**
+     * This initializes the plugin.
+     *
+     * This function is called by \Sabre\DAV\Server, after
+     * addPlugin is called.
+     *
+     * This method should set up the required event subscriptions.
+     *
+     * @param \Sabre\DAV\Server $server
+     * @return void
+     */
+    public function initialize(\Sabre\DAV\Server $server) {
+        $server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc';
+        $server->xml->namespaceMap[self::NS_NEXTCLOUD] = 'nc';
+        $server->protectedProperties[] = self::FILEID_PROPERTYNAME;
+        $server->protectedProperties[] = self::INTERNAL_FILEID_PROPERTYNAME;
+        $server->protectedProperties[] = self::PERMISSIONS_PROPERTYNAME;
+        $server->protectedProperties[] = self::SHARE_PERMISSIONS_PROPERTYNAME;
+        $server->protectedProperties[] = self::OCM_SHARE_PERMISSIONS_PROPERTYNAME;
+        $server->protectedProperties[] = self::SIZE_PROPERTYNAME;
+        $server->protectedProperties[] = self::DOWNLOADURL_PROPERTYNAME;
+        $server->protectedProperties[] = self::OWNER_ID_PROPERTYNAME;
+        $server->protectedProperties[] = self::OWNER_DISPLAY_NAME_PROPERTYNAME;
+        $server->protectedProperties[] = self::CHECKSUMS_PROPERTYNAME;
+        $server->protectedProperties[] = self::DATA_FINGERPRINT_PROPERTYNAME;
+        $server->protectedProperties[] = self::HAS_PREVIEW_PROPERTYNAME;
+        $server->protectedProperties[] = self::MOUNT_TYPE_PROPERTYNAME;
+        $server->protectedProperties[] = self::IS_ENCRYPTED_PROPERTYNAME;
+
+        // normally these cannot be changed (RFC4918), but we want them modifiable through PROPPATCH
+        $allowedProperties = ['{DAV:}getetag'];
+        $server->protectedProperties = array_diff($server->protectedProperties, $allowedProperties);
+
+        $this->server = $server;
+        $this->server->on('propFind', array($this, 'handleGetProperties'));
+        $this->server->on('propPatch', array($this, 'handleUpdateProperties'));
+        $this->server->on('afterBind', array($this, 'sendFileIdHeader'));
+        $this->server->on('afterWriteContent', array($this, 'sendFileIdHeader'));
+        $this->server->on('afterMethod:GET', [$this,'httpGet']);
+        $this->server->on('afterMethod:GET', array($this, 'handleDownloadToken'));
+        $this->server->on('afterResponse', function($request, ResponseInterface $response) {
+            $body = $response->getBody();
+            if (is_resource($body)) {
+                fclose($body);
+            }
+        });
+        $this->server->on('beforeMove', [$this, 'checkMove']);
+    }
+
+    /**
+     * Plugin that checks if a move can actually be performed.
+     *
+     * @param string $source source path
+     * @param string $destination destination path
+     * @throws Forbidden
+     * @throws NotFound
+     */
+    function checkMove($source, $destination) {
+        $sourceNode = $this->tree->getNodeForPath($source);
+        if (!$sourceNode instanceof Node) {
+            return;
+        }
+        list($sourceDir,) = \Sabre\Uri\split($source);
+        list($destinationDir,) = \Sabre\Uri\split($destination);
+
+        if ($sourceDir !== $destinationDir) {
+            $sourceNodeFileInfo = $sourceNode->getFileInfo();
+            if ($sourceNodeFileInfo === null) {
+                throw new NotFound($source . ' does not exist');
+                }
+
+            if (!$sourceNodeFileInfo->isDeletable()) {
+                throw new Forbidden($source . " cannot be deleted");
+            }
+        }
+    }
+
+    /**
+     * This sets a cookie to be able to recognize the start of the download
+     * the content must not be longer than 32 characters and must only contain
+     * alphanumeric characters
+     *
+     * @param RequestInterface $request
+     * @param ResponseInterface $response
+     */
+    function handleDownloadToken(RequestInterface $request, ResponseInterface $response) {
+        $queryParams = $request->getQueryParameters();
+
+        /**
+         * this sets a cookie to be able to recognize the start of the download
+         * the content must not be longer than 32 characters and must only contain
+         * alphanumeric characters
+         */
+        if (isset($queryParams['downloadStartSecret'])) {
+            $token = $queryParams['downloadStartSecret'];
+            if (!isset($token[32])
+                && preg_match('!^[a-zA-Z0-9]+$!', $token) === 1) {
+                // FIXME: use $response->setHeader() instead
+                setcookie('ocDownloadStarted', $token, time() + 20, '/');
+            }
+        }
+    }
+
+    /**
+     * Add headers to file download
+     *
+     * @param RequestInterface $request
+     * @param ResponseInterface $response
+     */
+    function httpGet(RequestInterface $request, ResponseInterface $response) {
+        // Only handle valid files
+        $node = $this->tree->getNodeForPath($request->getPath());
+        if (!($node instanceof IFile)) return;
+
+        // adds a 'Content-Disposition: attachment' header in case no disposition
+        // header has been set before
+        if ($this->downloadAttachment &&
+            $response->getHeader('Content-Disposition') === null) {
+            $filename = $node->getName();
+            if ($this->request->isUserAgent(
+                [
+                    Request::USER_AGENT_IE,
+                    Request::USER_AGENT_ANDROID_MOBILE_CHROME,
+                    Request::USER_AGENT_FREEBOX,
+                ])) {
+                $response->addHeader('Content-Disposition', 'attachment; filename="' . rawurlencode($filename) . '"');
+            } else {
+                $response->addHeader('Content-Disposition', 'attachment; filename*=UTF-8\'\'' . rawurlencode($filename)
+                                                        . '; filename="' . rawurlencode($filename) . '"');
+            }
+        }
+
+        if ($node instanceof \OCA\DAV\Connector\Sabre\File) {
+            //Add OC-Checksum header
+            /** @var $node File */
+            $checksum = $node->getChecksum();
+            if ($checksum !== null && $checksum !== '') {
+                $response->addHeader('OC-Checksum', $checksum);
+            }
+        }
+    }
+
+    /**
+     * Adds all ownCloud-specific properties
+     *
+     * @param PropFind $propFind
+     * @param \Sabre\DAV\INode $node
+     * @return void
+     */
+    public function handleGetProperties(PropFind $propFind, \Sabre\DAV\INode $node) {
+
+        $httpRequest = $this->server->httpRequest;
+
+        if ($node instanceof \OCA\DAV\Connector\Sabre\Node) {
+            /**
+             * This was disabled, because it made dir listing throw an exception,
+             * so users were unable to navigate into folders where one subitem
+             * is blocked by the files_accesscontrol app, see:
+             * https://github.com/nextcloud/files_accesscontrol/issues/65
 			if (!$node->getFileInfo()->isReadable()) {
 				// avoid detecting files through this means
 				throw new NotFound();
 			}
-			 */
-
-			$propFind->handle(self::FILEID_PROPERTYNAME, function() use ($node) {
-				return $node->getFileId();
-			});
-
-			$propFind->handle(self::INTERNAL_FILEID_PROPERTYNAME, function() use ($node) {
-				return $node->getInternalFileId();
-			});
-
-			$propFind->handle(self::PERMISSIONS_PROPERTYNAME, function() use ($node) {
-				$perms = $node->getDavPermissions();
-				if ($this->isPublic) {
-					// remove mount information
-					$perms = str_replace(['S', 'M'], '', $perms);
-				}
-				return $perms;
-			});
-
-			$propFind->handle(self::SHARE_PERMISSIONS_PROPERTYNAME, function() use ($node, $httpRequest) {
-				return $node->getSharePermissions(
-					$httpRequest->getRawServerValue('PHP_AUTH_USER')
-				);
-			});
-
-			$propFind->handle(self::OCM_SHARE_PERMISSIONS_PROPERTYNAME, function() use ($node, $httpRequest) {
-				$ncPermissions = $node->getSharePermissions(
-					$httpRequest->getRawServerValue('PHP_AUTH_USER')
-				);
-				$ocmPermissions = $this->ncPermissions2ocmPermissions($ncPermissions);
-				return json_encode($ocmPermissions);
-			});
-
-			$propFind->handle(self::GETETAG_PROPERTYNAME, function() use ($node) {
-				return $node->getETag();
-			});
-
-			$propFind->handle(self::OWNER_ID_PROPERTYNAME, function() use ($node) {
-				$owner = $node->getOwner();
-				if (!$owner) {
-					return null;
-				} else {
-					return $owner->getUID();
-				}
-			});
-			$propFind->handle(self::OWNER_DISPLAY_NAME_PROPERTYNAME, function() use ($node) {
-				$owner = $node->getOwner();
-				if (!$owner) {
-					return null;
-				} else {
-					return $owner->getDisplayName();
-				}
-			});
-
-			$propFind->handle(self::HAS_PREVIEW_PROPERTYNAME, function () use ($node) {
-				return json_encode($this->previewManager->isAvailable($node->getFileInfo()));
-			});
-			$propFind->handle(self::SIZE_PROPERTYNAME, function() use ($node) {
-				return $node->getSize();
-			});
-			$propFind->handle(self::MOUNT_TYPE_PROPERTYNAME, function () use ($node) {
-				return $node->getFileInfo()->getMountPoint()->getMountType();
-			});
-		}
-
-		if ($node instanceof \OCA\DAV\Connector\Sabre\Node) {
-			$propFind->handle(self::DATA_FINGERPRINT_PROPERTYNAME, function() use ($node) {
-				return $this->config->getSystemValue('data-fingerprint', '');
-			});
-		}
-
-		if ($node instanceof \OCA\DAV\Connector\Sabre\File) {
-			$propFind->handle(self::DOWNLOADURL_PROPERTYNAME, function() use ($node) {
-				/** @var $node \OCA\DAV\Connector\Sabre\File */
-				try {
-					$directDownloadUrl = $node->getDirectDownload();
-					if (isset($directDownloadUrl['url'])) {
-						return $directDownloadUrl['url'];
-					}
-				} catch (StorageNotAvailableException $e) {
-					return false;
-				} catch (ForbiddenException $e) {
-					return false;
-				}
-				return false;
-			});
-
-			$propFind->handle(self::CHECKSUMS_PROPERTYNAME, function() use ($node) {
-				$checksum = $node->getChecksum();
-				if ($checksum === NULL || $checksum === '') {
-					return null;
-				}
-
-				return new ChecksumList($checksum);
-			});
-
-		}
-
-		if ($node instanceof \OCA\DAV\Connector\Sabre\Directory) {
-			$propFind->handle(self::SIZE_PROPERTYNAME, function() use ($node) {
-				return $node->getSize();
-			});
-
-			$propFind->handle(self::IS_ENCRYPTED_PROPERTYNAME, function() use ($node) {
-				return $node->getFileInfo()->isEncrypted() ? '1' : '0';
-			});
-		}
-	}
-
-	/**
-	 * translate Nextcloud permissions to OCM Permissions
-	 *
-	 * @param $ncPermissions
-	 * @return array
-	 */
-	protected function ncPermissions2ocmPermissions($ncPermissions) {
-
-		$ocmPermissions = [];
-
-		if ($ncPermissions & Constants::PERMISSION_SHARE) {
-			$ocmPermissions[] = 'share';
-		}
-
-		if ($ncPermissions & Constants::PERMISSION_READ) {
-			$ocmPermissions[] = 'read';
-		}
-
-		if (($ncPermissions & Constants::PERMISSION_CREATE) ||
-			($ncPermissions & Constants::PERMISSION_UPDATE)) {
-			$ocmPermissions[] = 'write';
-		}
-
-		return $ocmPermissions;
-
-	}
-
-	/**
-	 * Update ownCloud-specific properties
-	 *
-	 * @param string $path
-	 * @param PropPatch $propPatch
-	 *
-	 * @return void
-	 */
-	public function handleUpdateProperties($path, PropPatch $propPatch) {
-		$node = $this->tree->getNodeForPath($path);
-		if (!($node instanceof \OCA\DAV\Connector\Sabre\Node)) {
-			return;
-		}
-
-		$propPatch->handle(self::LASTMODIFIED_PROPERTYNAME, function($time) use ($node) {
-			if (empty($time)) {
-				return false;
-			}
-			$node->touch($time);
-			return true;
-		});
-		$propPatch->handle(self::GETETAG_PROPERTYNAME, function($etag) use ($node) {
-			if (empty($etag)) {
-				return false;
-			}
-			if ($node->setEtag($etag) !== -1) {
-				return true;
-			}
-			return false;
-		});
-	}
-
-	/**
-	 * @param string $filePath
-	 * @param \Sabre\DAV\INode $node
-	 * @throws \Sabre\DAV\Exception\BadRequest
-	 */
-	public function sendFileIdHeader($filePath, \Sabre\DAV\INode $node = null) {
-		// chunked upload handling
-		if (isset($_SERVER['HTTP_OC_CHUNKED'])) {
-			list($path, $name) = \Sabre\Uri\split($filePath);
-			$info = \OC_FileChunking::decodeName($name);
-			if (!empty($info)) {
-				$filePath = $path . '/' . $info['name'];
-			}
-		}
-
-		// we get the node for the given $filePath here because in case of afterCreateFile $node is the parent folder
-		if (!$this->server->tree->nodeExists($filePath)) {
-			return;
-		}
-		$node = $this->server->tree->getNodeForPath($filePath);
-		if ($node instanceof \OCA\DAV\Connector\Sabre\Node) {
-			$fileId = $node->getFileId();
-			if (!is_null($fileId)) {
-				$this->server->httpResponse->setHeader('OC-FileId', $fileId);
-			}
-		}
-	}
+             */
+
+            $propFind->handle(self::FILEID_PROPERTYNAME, function() use ($node) {
+                return $node->getFileId();
+            });
+
+            $propFind->handle(self::INTERNAL_FILEID_PROPERTYNAME, function() use ($node) {
+                return $node->getInternalFileId();
+            });
+
+            $propFind->handle(self::PERMISSIONS_PROPERTYNAME, function() use ($node) {
+                $perms = $node->getDavPermissions();
+                if ($this->isPublic) {
+                    // remove mount information
+                    $perms = str_replace(['S', 'M'], '', $perms);
+                }
+                return $perms;
+            });
+
+            $propFind->handle(self::SHARE_PERMISSIONS_PROPERTYNAME, function() use ($node, $httpRequest) {
+                return $node->getSharePermissions(
+                    $httpRequest->getRawServerValue('PHP_AUTH_USER')
+                );
+            });
+
+            $propFind->handle(self::OCM_SHARE_PERMISSIONS_PROPERTYNAME, function() use ($node, $httpRequest) {
+                $ncPermissions = $node->getSharePermissions(
+                    $httpRequest->getRawServerValue('PHP_AUTH_USER')
+                );
+                $ocmPermissions = $this->ncPermissions2ocmPermissions($ncPermissions);
+                return json_encode($ocmPermissions);
+            });
+
+            $propFind->handle(self::GETETAG_PROPERTYNAME, function() use ($node) {
+                return $node->getETag();
+            });
+
+            $propFind->handle(self::OWNER_ID_PROPERTYNAME, function() use ($node) {
+                $owner = $node->getOwner();
+                if (!$owner) {
+                    return null;
+                } else {
+                    return $owner->getUID();
+                }
+            });
+            $propFind->handle(self::OWNER_DISPLAY_NAME_PROPERTYNAME, function() use ($node) {
+                $owner = $node->getOwner();
+                if (!$owner) {
+                    return null;
+                } else {
+                    return $owner->getDisplayName();
+                }
+            });
+
+            $propFind->handle(self::HAS_PREVIEW_PROPERTYNAME, function () use ($node) {
+                return json_encode($this->previewManager->isAvailable($node->getFileInfo()));
+            });
+            $propFind->handle(self::SIZE_PROPERTYNAME, function() use ($node) {
+                return $node->getSize();
+            });
+            $propFind->handle(self::MOUNT_TYPE_PROPERTYNAME, function () use ($node) {
+                return $node->getFileInfo()->getMountPoint()->getMountType();
+            });
+        }
+
+        if ($node instanceof \OCA\DAV\Connector\Sabre\Node) {
+            $propFind->handle(self::DATA_FINGERPRINT_PROPERTYNAME, function() use ($node) {
+                return $this->config->getSystemValue('data-fingerprint', '');
+            });
+        }
+
+        if ($node instanceof \OCA\DAV\Connector\Sabre\File) {
+            $propFind->handle(self::DOWNLOADURL_PROPERTYNAME, function() use ($node) {
+                /** @var $node \OCA\DAV\Connector\Sabre\File */
+                try {
+                    $directDownloadUrl = $node->getDirectDownload();
+                    if (isset($directDownloadUrl['url'])) {
+                        return $directDownloadUrl['url'];
+                    }
+                } catch (StorageNotAvailableException $e) {
+                    return false;
+                } catch (ForbiddenException $e) {
+                    return false;
+                }
+                return false;
+            });
+
+            $propFind->handle(self::CHECKSUMS_PROPERTYNAME, function() use ($node) {
+                $checksum = $node->getChecksum();
+                if ($checksum === NULL || $checksum === '') {
+                    return null;
+                }
+
+                return new ChecksumList($checksum);
+            });
+
+        }
+
+        if ($node instanceof \OCA\DAV\Connector\Sabre\Directory) {
+            $propFind->handle(self::SIZE_PROPERTYNAME, function() use ($node) {
+                return $node->getSize();
+            });
+
+            $propFind->handle(self::IS_ENCRYPTED_PROPERTYNAME, function() use ($node) {
+                return $node->getFileInfo()->isEncrypted() ? '1' : '0';
+            });
+        }
+    }
+
+    /**
+     * translate Nextcloud permissions to OCM Permissions
+     *
+     * @param $ncPermissions
+     * @return array
+     */
+    protected function ncPermissions2ocmPermissions($ncPermissions) {
+
+        $ocmPermissions = [];
+
+        if ($ncPermissions & Constants::PERMISSION_SHARE) {
+            $ocmPermissions[] = 'share';
+        }
+
+        if ($ncPermissions & Constants::PERMISSION_READ) {
+            $ocmPermissions[] = 'read';
+        }
+
+        if (($ncPermissions & Constants::PERMISSION_CREATE) ||
+            ($ncPermissions & Constants::PERMISSION_UPDATE)) {
+            $ocmPermissions[] = 'write';
+        }
+
+        return $ocmPermissions;
+
+    }
+
+    /**
+     * Update ownCloud-specific properties
+     *
+     * @param string $path
+     * @param PropPatch $propPatch
+     *
+     * @return void
+     */
+    public function handleUpdateProperties($path, PropPatch $propPatch) {
+        $node = $this->tree->getNodeForPath($path);
+        if (!($node instanceof \OCA\DAV\Connector\Sabre\Node)) {
+            return;
+        }
+
+        $propPatch->handle(self::LASTMODIFIED_PROPERTYNAME, function($time) use ($node) {
+            if (empty($time)) {
+                return false;
+            }
+            $node->touch($time);
+            return true;
+        });
+        $propPatch->handle(self::GETETAG_PROPERTYNAME, function($etag) use ($node) {
+            if (empty($etag)) {
+                return false;
+            }
+            if ($node->setEtag($etag) !== -1) {
+                return true;
+            }
+            return false;
+        });
+    }
+
+    /**
+     * @param string $filePath
+     * @param \Sabre\DAV\INode $node
+     * @throws \Sabre\DAV\Exception\BadRequest
+     */
+    public function sendFileIdHeader($filePath, \Sabre\DAV\INode $node = null) {
+        // chunked upload handling
+        if (isset($_SERVER['HTTP_OC_CHUNKED'])) {
+            list($path, $name) = \Sabre\Uri\split($filePath);
+            $info = \OC_FileChunking::decodeName($name);
+            if (!empty($info)) {
+                $filePath = $path . '/' . $info['name'];
+            }
+        }
+
+        // we get the node for the given $filePath here because in case of afterCreateFile $node is the parent folder
+        if (!$this->server->tree->nodeExists($filePath)) {
+            return;
+        }
+        $node = $this->server->tree->getNodeForPath($filePath);
+        if ($node instanceof \OCA\DAV\Connector\Sabre\Node) {
+            $fileId = $node->getFileId();
+            if (!is_null($fileId)) {
+                $this->server->httpResponse->setHeader('OC-FileId', $fileId);
+            }
+        }
+    }
 }

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-cloud-mesh.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-cloud-mesh.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'];
+    }
 }