From 5cfe20675dfa1f895af47b4a8c93cf479d53b200 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Wed, 18 Apr 2018 16:05:11 +0200 Subject: [PATCH 01/39] start implementing federated sharing 2.0 Signed-off-by: Bjoern Schiessle --- .../composer/composer/autoload_classmap.php | 1 + .../composer/composer/autoload_static.php | 1 + .../lib/AppInfo/Application.php | 8 + .../lib/FederatedShareProvider.php | 10 +- .../lib/ocm/CloudFederationProvider.php | 83 +++++ core/routes.php | 28 ++ lib/composer/composer/autoload_classmap.php | 13 + lib/composer/composer/autoload_static.php | 13 + .../Federation/CloudFederationFactory.php | 63 ++++ .../CloudFederationNotification.php | 52 +++ .../CloudFederationProviderManager.php | 108 ++++++ .../Federation/CloudFederationShare.php | 336 ++++++++++++++++++ lib/private/Server.php | 38 ++ lib/private/Share20/ProviderFactory.php | 4 +- .../ProviderAlreadyExistsException.php | 41 +++ .../ProviderCouldNotAddShareException.php | 28 ++ .../ProviderDoesNotExistsException.php | 40 +++ .../Exceptions/ShareNotFoundException.php | 29 ++ .../Federation/ICloudFederationFactory.php | 55 +++ .../ICloudFederationNotification.php | 44 +++ .../Federation/ICloudFederationProvider.php | 81 +++++ .../ICloudFederationProviderManager.php | 97 +++++ .../Federation/ICloudFederationShare.php | 233 ++++++++++++ lib/public/IServerContainer.php | 19 + ocm-provider/index.php | 39 ++ 25 files changed, 1461 insertions(+), 3 deletions(-) create mode 100644 apps/federatedfilesharing/lib/ocm/CloudFederationProvider.php create mode 100644 lib/private/Federation/CloudFederationFactory.php create mode 100644 lib/private/Federation/CloudFederationNotification.php create mode 100644 lib/private/Federation/CloudFederationProviderManager.php create mode 100644 lib/private/Federation/CloudFederationShare.php create mode 100644 lib/public/Federation/Exceptions/ProviderAlreadyExistsException.php create mode 100644 lib/public/Federation/Exceptions/ProviderCouldNotAddShareException.php create mode 100644 lib/public/Federation/Exceptions/ProviderDoesNotExistsException.php create mode 100644 lib/public/Federation/Exceptions/ShareNotFoundException.php create mode 100644 lib/public/Federation/ICloudFederationFactory.php create mode 100644 lib/public/Federation/ICloudFederationNotification.php create mode 100644 lib/public/Federation/ICloudFederationProvider.php create mode 100644 lib/public/Federation/ICloudFederationProviderManager.php create mode 100644 lib/public/Federation/ICloudFederationShare.php create mode 100644 ocm-provider/index.php diff --git a/apps/federatedfilesharing/composer/composer/autoload_classmap.php b/apps/federatedfilesharing/composer/composer/autoload_classmap.php index 387ea8bee3..c81b0cc87f 100644 --- a/apps/federatedfilesharing/composer/composer/autoload_classmap.php +++ b/apps/federatedfilesharing/composer/composer/autoload_classmap.php @@ -14,6 +14,7 @@ return array( 'OCA\\FederatedFileSharing\\FederatedShareProvider' => $baseDir . '/../lib/FederatedShareProvider.php', 'OCA\\FederatedFileSharing\\Notifications' => $baseDir . '/../lib/Notifications.php', 'OCA\\FederatedFileSharing\\Notifier' => $baseDir . '/../lib/Notifier.php', + 'OCA\\FederatedFileSharing\\OCM\\CloudFederationProviderFiles' => $baseDir . '/../lib/ocm/CloudFederationProviderFiles.php', 'OCA\\FederatedFileSharing\\Settings\\Admin' => $baseDir . '/../lib/Settings/Admin.php', 'OCA\\FederatedFileSharing\\Settings\\Personal' => $baseDir . '/../lib/Settings/Personal.php', 'OCA\\FederatedFileSharing\\Settings\\PersonalSection' => $baseDir . '/../lib/Settings/PersonalSection.php', diff --git a/apps/federatedfilesharing/composer/composer/autoload_static.php b/apps/federatedfilesharing/composer/composer/autoload_static.php index 95b8775384..ea98739fba 100644 --- a/apps/federatedfilesharing/composer/composer/autoload_static.php +++ b/apps/federatedfilesharing/composer/composer/autoload_static.php @@ -29,6 +29,7 @@ class ComposerStaticInitFederatedFileSharing 'OCA\\FederatedFileSharing\\FederatedShareProvider' => __DIR__ . '/..' . '/../lib/FederatedShareProvider.php', 'OCA\\FederatedFileSharing\\Notifications' => __DIR__ . '/..' . '/../lib/Notifications.php', 'OCA\\FederatedFileSharing\\Notifier' => __DIR__ . '/..' . '/../lib/Notifier.php', + 'OCA\\FederatedFileSharing\\OCM\\CloudFederationProviderFiles' => __DIR__ . '/..' . '/../lib/ocm/CloudFederationProviderFiles.php', 'OCA\\FederatedFileSharing\\Settings\\Admin' => __DIR__ . '/..' . '/../lib/Settings/Admin.php', 'OCA\\FederatedFileSharing\\Settings\\Personal' => __DIR__ . '/..' . '/../lib/Settings/Personal.php', 'OCA\\FederatedFileSharing\\Settings\\PersonalSection' => __DIR__ . '/..' . '/../lib/Settings/PersonalSection.php', diff --git a/apps/federatedfilesharing/lib/AppInfo/Application.php b/apps/federatedfilesharing/lib/AppInfo/Application.php index 2c863de21c..23f521a51c 100644 --- a/apps/federatedfilesharing/lib/AppInfo/Application.php +++ b/apps/federatedfilesharing/lib/AppInfo/Application.php @@ -32,6 +32,7 @@ use OCA\FederatedFileSharing\AddressHandler; use OCA\FederatedFileSharing\Controller\RequestHandlerController; use OCA\FederatedFileSharing\FederatedShareProvider; use OCA\FederatedFileSharing\Notifications; +use OCA\FederatedFileSharing\OCM\CloudFederationProvider; use OCP\AppFramework\App; use OCP\GlobalScale\IConfig; @@ -46,6 +47,13 @@ class Application extends App { $container = $this->getContainer(); $server = $container->getServer(); + $cloudFederationManager = $server->getCloudFederationProviderManager(); + $cloudFederationManager->addCloudFederationProvider('file', + 'Federated Files Sharing', + function() use ($container) { + return new CloudFederationProvider('file'); + }); + $container->registerService('RequestHandlerController', function(SimpleContainer $c) use ($server) { $addressHandler = new AddressHandler( $server->getURLGenerator(), diff --git a/apps/federatedfilesharing/lib/FederatedShareProvider.php b/apps/federatedfilesharing/lib/FederatedShareProvider.php index ecc1e1710b..d2962d9c59 100644 --- a/apps/federatedfilesharing/lib/FederatedShareProvider.php +++ b/apps/federatedfilesharing/lib/FederatedShareProvider.php @@ -30,6 +30,7 @@ namespace OCA\FederatedFileSharing; use OC\Share20\Share; +use OCA\FederatedFileSharing\OCM\CloudFederationProvider; use OCP\Federation\ICloudIdManager; use OCP\DB\QueryBuilder\IQueryBuilder; use OCP\Files\Folder; @@ -91,6 +92,9 @@ class FederatedShareProvider implements IShareProvider { /** @var \OCP\GlobalScale\IConfig */ private $gsConfig; + /** @var CloudFederationProvider */ + private $cloudFederationProvider; + /** * DefaultShareProvider constructor. * @@ -105,6 +109,7 @@ class FederatedShareProvider implements IShareProvider { * @param IUserManager $userManager * @param ICloudIdManager $cloudIdManager * @param \OCP\GlobalScale\IConfig $globalScaleConfig + * @param CloudFederationProvider $cloudFederationProvider */ public function __construct( IDBConnection $connection, @@ -117,7 +122,8 @@ class FederatedShareProvider implements IShareProvider { IConfig $config, IUserManager $userManager, ICloudIdManager $cloudIdManager, - \OCP\GlobalScale\IConfig $globalScaleConfig + \OCP\GlobalScale\IConfig $globalScaleConfig, + CloudFederationProvider $cloudFederationProvider ) { $this->dbConnection = $connection; $this->addressHandler = $addressHandler; @@ -130,6 +136,8 @@ class FederatedShareProvider implements IShareProvider { $this->userManager = $userManager; $this->cloudIdManager = $cloudIdManager; $this->gsConfig = $globalScaleConfig; + $this->cloudFederationProvider = $cloudFederationProvider; + } /** diff --git a/apps/federatedfilesharing/lib/ocm/CloudFederationProvider.php b/apps/federatedfilesharing/lib/ocm/CloudFederationProvider.php new file mode 100644 index 0000000000..36b2d282b9 --- /dev/null +++ b/apps/federatedfilesharing/lib/ocm/CloudFederationProvider.php @@ -0,0 +1,83 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCA\FederatedFileSharing\OCM; + +use OCP\Federation\ICloudFederationFactory; +use OCP\Federation\ICloudFederationProvider; +use OCP\Federation\ICloudFederationShare; + +class CloudFederationProvider implements ICloudFederationProvider { + + /** @var string */ + private $shareType; + + /** + * CloudFederationProvider constructor. + * + * @param string $shareType + */ + public function __construct($shareType) { + $this->shareType = $shareType; + } + + /** + * @return string + */ + public function getShareType() { + return $this->shareType; + } + + /** + * send new share to another server + * + * @since 14.0.0 + */ + public function sendShare() { + // TODO: Implement sendShare() method. + } + + /** + * share received from another server + * + * @param ICloudFederationShare $share + * @return string provider specific unique ID of the share + * + * @since 14.0.0 + */ + public function shareReceived(ICloudFederationShare $share) { + // TODO: Implement shareReceived() method. + } + + /** + * notification received from another server + * + * @param string $id unique ID of a already existing share + * @param array $notification provider specific notification + * + * @throws \OCP\Federation\Exceptions\ShareNotFoundException + * + * @since 14.0.0 + */ + public function notificationReceived($id, $notification) { + // TODO: Implement notificationReceived() method. + } +} diff --git a/core/routes.php b/core/routes.php index cc1bd34d89..90282c5ebf 100644 --- a/core/routes.php +++ b/core/routes.php @@ -107,6 +107,34 @@ $this->create('spreed.pagecontroller.showCall', '/call/{token}')->action(functio } }); +// OCM routes +/** + * @suppress PhanUndeclaredClassConstant + * @suppress PhanUndeclaredClassMethod + */ +$this->create('cloud_federation_api.requesthandlercontroller.addShare', '/ocm/shares')->post()->action(function($urlParams) { + if (class_exists(\OCA\CloudFederationAPI\AppInfo\Application::class, false)) { + $app = new \OCA\CloudFederationAPI\AppInfo\Application($urlParams); + $app->dispatch('RequestHandlerController', 'addShare'); + } else { + throw new \OC\HintException('Cloud Federation API not enabled'); + } +}); + +/** + * @suppress PhanUndeclaredClassConstant + * @suppress PhanUndeclaredClassMethod + */ +$this->create('cloud_federation_api.requesthandlercontroller.receiveNotification', '/ocm/notifications')->post()->action(function($urlParams) { + if (class_exists(\OCA\CloudFederationAPI\AppInfo\Application::class, false)) { + $app = new \OCA\CloudFederationAPI\AppInfo\Application($urlParams); + $app->dispatch('RequestHandlerController', 'receiveNotification'); + } else { + throw new \OC\HintException('Cloud Federation API not enabled'); + } +}); + + // Sharing routes $this->create('files_sharing.sharecontroller.showShare', '/s/{token}')->action(function($urlParams) { if (class_exists(\OCA\Files_Sharing\AppInfo\Application::class, false)) { diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php index f818bc2840..8b5410919c 100644 --- a/lib/composer/composer/autoload_classmap.php +++ b/lib/composer/composer/autoload_classmap.php @@ -132,6 +132,15 @@ return array( 'OCP\\Encryption\\IFile' => $baseDir . '/lib/public/Encryption/IFile.php', 'OCP\\Encryption\\IManager' => $baseDir . '/lib/public/Encryption/IManager.php', 'OCP\\Encryption\\Keys\\IStorage' => $baseDir . '/lib/public/Encryption/Keys/IStorage.php', + 'OCP\\Federation\\Exceptions\\ProviderAlreadyExistsException' => $baseDir . '/lib/public/Federation/Exceptions/ProviderAlreadyExistsException.php', + 'OCP\\Federation\\Exceptions\\ProviderCouldNotAddShareException' => $baseDir . '/lib/public/Federation/Exceptions/ProviderCouldNotAddShareException.php', + 'OCP\\Federation\\Exceptions\\ProviderDoesNotExistsException' => $baseDir . '/lib/public/Federation/Exceptions/ProviderDoesNotExistsException.php', + 'OCP\\Federation\\Exceptions\\ShareNotFoundException' => $baseDir . '/lib/public/Federation/Exceptions/ShareNotFoundException.php', + 'OCP\\Federation\\ICloudFederationFactory' => $baseDir . '/lib/public/Federation/ICloudFederationFactory.php', + 'OCP\\Federation\\ICloudFederationNotification' => $baseDir . '/lib/public/Federation/ICloudFederationNotification.php', + 'OCP\\Federation\\ICloudFederationProvider' => $baseDir . '/lib/public/Federation/ICloudFederationProvider.php', + 'OCP\\Federation\\ICloudFederationProviderManager' => $baseDir . '/lib/public/Federation/ICloudFederationProviderManager.php', + 'OCP\\Federation\\ICloudFederationShare' => $baseDir . '/lib/public/Federation/ICloudFederationShare.php', 'OCP\\Federation\\ICloudId' => $baseDir . '/lib/public/Federation/ICloudId.php', 'OCP\\Federation\\ICloudIdManager' => $baseDir . '/lib/public/Federation/ICloudIdManager.php', 'OCP\\Files' => $baseDir . '/lib/public/Files.php', @@ -660,6 +669,10 @@ return array( 'OC\\Encryption\\Manager' => $baseDir . '/lib/private/Encryption/Manager.php', 'OC\\Encryption\\Update' => $baseDir . '/lib/private/Encryption/Update.php', 'OC\\Encryption\\Util' => $baseDir . '/lib/private/Encryption/Util.php', + 'OC\\Federation\\CloudFederationFactory' => $baseDir . '/lib/private/Federation/CloudFederationFactory.php', + 'OC\\Federation\\CloudFederationNotification' => $baseDir . '/lib/private/Federation/CloudFederationNotification.php', + 'OC\\Federation\\CloudFederationProviderManager' => $baseDir . '/lib/private/Federation/CloudFederationProviderManager.php', + 'OC\\Federation\\CloudFederationShare' => $baseDir . '/lib/private/Federation/CloudFederationShare.php', 'OC\\Federation\\CloudId' => $baseDir . '/lib/private/Federation/CloudId.php', 'OC\\Federation\\CloudIdManager' => $baseDir . '/lib/private/Federation/CloudIdManager.php', 'OC\\Files\\AppData\\AppData' => $baseDir . '/lib/private/Files/AppData/AppData.php', diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php index 05128f65c4..36c582ccdb 100644 --- a/lib/composer/composer/autoload_static.php +++ b/lib/composer/composer/autoload_static.php @@ -162,6 +162,15 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c 'OCP\\Encryption\\IFile' => __DIR__ . '/../../..' . '/lib/public/Encryption/IFile.php', 'OCP\\Encryption\\IManager' => __DIR__ . '/../../..' . '/lib/public/Encryption/IManager.php', 'OCP\\Encryption\\Keys\\IStorage' => __DIR__ . '/../../..' . '/lib/public/Encryption/Keys/IStorage.php', + 'OCP\\Federation\\Exceptions\\ProviderAlreadyExistsException' => __DIR__ . '/../../..' . '/lib/public/Federation/Exceptions/ProviderAlreadyExistsException.php', + 'OCP\\Federation\\Exceptions\\ProviderCouldNotAddShareException' => __DIR__ . '/../../..' . '/lib/public/Federation/Exceptions/ProviderCouldNotAddShareException.php', + 'OCP\\Federation\\Exceptions\\ProviderDoesNotExistsException' => __DIR__ . '/../../..' . '/lib/public/Federation/Exceptions/ProviderDoesNotExistsException.php', + 'OCP\\Federation\\Exceptions\\ShareNotFoundException' => __DIR__ . '/../../..' . '/lib/public/Federation/Exceptions/ShareNotFoundException.php', + 'OCP\\Federation\\ICloudFederationFactory' => __DIR__ . '/../../..' . '/lib/public/Federation/ICloudFederationFactory.php', + 'OCP\\Federation\\ICloudFederationNotification' => __DIR__ . '/../../..' . '/lib/public/Federation/ICloudFederationNotification.php', + 'OCP\\Federation\\ICloudFederationProvider' => __DIR__ . '/../../..' . '/lib/public/Federation/ICloudFederationProvider.php', + 'OCP\\Federation\\ICloudFederationProviderManager' => __DIR__ . '/../../..' . '/lib/public/Federation/ICloudFederationProviderManager.php', + 'OCP\\Federation\\ICloudFederationShare' => __DIR__ . '/../../..' . '/lib/public/Federation/ICloudFederationShare.php', 'OCP\\Federation\\ICloudId' => __DIR__ . '/../../..' . '/lib/public/Federation/ICloudId.php', 'OCP\\Federation\\ICloudIdManager' => __DIR__ . '/../../..' . '/lib/public/Federation/ICloudIdManager.php', 'OCP\\Files' => __DIR__ . '/../../..' . '/lib/public/Files.php', @@ -690,6 +699,10 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c 'OC\\Encryption\\Manager' => __DIR__ . '/../../..' . '/lib/private/Encryption/Manager.php', 'OC\\Encryption\\Update' => __DIR__ . '/../../..' . '/lib/private/Encryption/Update.php', 'OC\\Encryption\\Util' => __DIR__ . '/../../..' . '/lib/private/Encryption/Util.php', + 'OC\\Federation\\CloudFederationFactory' => __DIR__ . '/../../..' . '/lib/private/Federation/CloudFederationFactory.php', + 'OC\\Federation\\CloudFederationNotification' => __DIR__ . '/../../..' . '/lib/private/Federation/CloudFederationNotification.php', + 'OC\\Federation\\CloudFederationProviderManager' => __DIR__ . '/../../..' . '/lib/private/Federation/CloudFederationProviderManager.php', + 'OC\\Federation\\CloudFederationShare' => __DIR__ . '/../../..' . '/lib/private/Federation/CloudFederationShare.php', 'OC\\Federation\\CloudId' => __DIR__ . '/../../..' . '/lib/private/Federation/CloudId.php', 'OC\\Federation\\CloudIdManager' => __DIR__ . '/../../..' . '/lib/private/Federation/CloudIdManager.php', 'OC\\Files\\AppData\\AppData' => __DIR__ . '/../../..' . '/lib/private/Files/AppData/AppData.php', diff --git a/lib/private/Federation/CloudFederationFactory.php b/lib/private/Federation/CloudFederationFactory.php new file mode 100644 index 0000000000..4f42eb50bc --- /dev/null +++ b/lib/private/Federation/CloudFederationFactory.php @@ -0,0 +1,63 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OC\Federation; + +use OCP\Federation\ICloudFederationFactory; +use OCP\Federation\ICloudFederationNotification; +use OCP\Federation\ICloudFederationShare; + +class CloudFederationFactory implements ICloudFederationFactory { + + /** + * get a CloudFederationShare Object to prepare a share you want to send + * + * @param string $shareWith + * @param string $name resource name (e.g. document.odt) + * @param string $description share description (optional) + * @param string $providerId resource UID on the provider side + * @param string $owner provider specific UID of the user who owns the resource + * @param string $ownerDisplayName display name of the user who shared the item + * @param string $sharedBy provider specific UID of the user who shared the resource + * @param $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 ICloudFederationShare + * + * @since 14.0.0 + */ + public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) { + return new CloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType); + } + + /** + * get a Cloud FederationNotification object to prepare a notification you + * want to send + * + * @return ICloudFederationNotification + * + * @since 14.0.0 + */ + public function getCloudFederationNotification() { + return new CloudFederationNotification(); + } +} diff --git a/lib/private/Federation/CloudFederationNotification.php b/lib/private/Federation/CloudFederationNotification.php new file mode 100644 index 0000000000..ed87b9b0e5 --- /dev/null +++ b/lib/private/Federation/CloudFederationNotification.php @@ -0,0 +1,52 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OC\Federation; + +use OCP\Federation\ICloudFederationNotification; + +class CloudFederationNotification implements ICloudFederationNotification { + + private $message = []; + + /** + * add a message to the notification + * + * @param string $identifier + * @param string $message + * + * @since 14.0.0 + */ + public function setMessage($identifier, $message) { + $this->message[$identifier] = $message; + } + + /** + * get JSON encoded Message, ready to send out + * + * @return string + * + * @since 14.0.0 + */ + public function getMessage() { + return json_encode($this->message); + } +} diff --git a/lib/private/Federation/CloudFederationProviderManager.php b/lib/private/Federation/CloudFederationProviderManager.php new file mode 100644 index 0000000000..925d42a688 --- /dev/null +++ b/lib/private/Federation/CloudFederationProviderManager.php @@ -0,0 +1,108 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + + +namespace OC\Federation; + +use OCP\Federation\Exceptions\ProviderAlreadyExistsException; +use OCP\Federation\Exceptions\ProviderDoesNotExistsException; +use OCP\Federation\ICloudFederationNotification; +use OCP\Federation\ICloudFederationProvider; +use OCP\Federation\ICloudFederationProviderManager; +use OCP\Federation\ICloudFederationShare; + +/** + * Class Manager + * + * Manage Cloud Federation Providers + * + * @package OC\Federation + */ +class CloudFederationProviderManager implements ICloudFederationProviderManager { + + /** @var array list of available cloud federation providers */ + private $cloudFederationProvider; + + public function __construct() { + $this->cloudFederationProvider= []; + } + + + /** + * Registers an callback function which must return an cloud federation provider + * + * @param string $shareType which share type does the provider handles + * @param string $displayName user facing name of the federated share provider + * @param callable $callback + */ + public function addCloudFederationProvider($shareType, $displayName, callable $callback) { + \OC::$server->getRemoteApiFactory(); + + $this->cloudFederationProvider[$shareType] = [ + 'shareType' => $shareType, + 'displayName' => $displayName, + 'callback' => $callback, + ]; + + } + + /** + * remove cloud federation provider + * + * @param string $providerId + */ + public function removeCloudFederationProvider($providerId) { + unset($this->cloudFederationProvider[$providerId]); + } + + /** + * get a list of all cloudFederationProviders + * + * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]] + */ + public function getAllCloudFederationProviders() { + return $this->cloudFederationProvider; + } + + /** + * get a specific cloud federation provider + * + * @param string $shareType + * @return ICloudFederationProvider + * @throws ProviderDoesNotExistsException + */ + public function getCloudFederationProvider($shareType) { + if (isset($this->cloudFederationProvider[$shareType])) { + return call_user_func($this->cloudFederationProvider[$shareType]['callback']); + } else { + throw new ProviderDoesNotExistsException($shareType); + } + } + + public function sendShare(ICloudFederationShare $share) { + // TODO: Implement sendShare() method. + } + + public function sendNotification(ICloudFederationNotification $notification) { + // TODO: Implement sendNotification() method. + } + +} diff --git a/lib/private/Federation/CloudFederationShare.php b/lib/private/Federation/CloudFederationShare.php new file mode 100644 index 0000000000..4622dc096d --- /dev/null +++ b/lib/private/Federation/CloudFederationShare.php @@ -0,0 +1,336 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OC\Federation; + +use OCP\Federation\ICloudFederationShare; + +class CloudFederationShare implements ICloudFederationShare { + + 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 array $protocol (e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]]) + * @param string $shareType ('group' or 'user' share) + * @param $resourceType ('file', 'calendar',...) + * + */ + public function __construct($shareWith = '', + $name = '', + $description = '', + $providerId = '', + $owner = '', + $ownerDisplayName = '', + $sharedBy = '', + $sharedByDisplayName = '', + $protocol = [], + $shareType = '', + $resourceType = '' + ) { + $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($protocol); + $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 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 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 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 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 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; + } + + /** + * get JSON encoded share, ready to send out + * + * @return string + * + * @since 14.0.0 + */ + public function getShare() { + return json_encode($this->share); + } + + /** + * 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 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 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 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 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 protocol specification + * + * @return array + * + * @since 14.0.0 + */ + public function getProtocol() { + return $this->share['protocol']; + } +} diff --git a/lib/private/Server.php b/lib/private/Server.php index 3c15873206..170bc6b258 100644 --- a/lib/private/Server.php +++ b/lib/private/Server.php @@ -68,6 +68,8 @@ use OC\Contacts\ContactsMenu\ActionFactory; use OC\Contacts\ContactsMenu\ContactsStore; use OC\Diagnostics\EventLogger; use OC\Diagnostics\QueryLogger; +use OC\Federation\CloudFederationFactory; +use OC\Federation\CloudFederationProviderManager; use OC\Federation\CloudIdManager; use OC\Files\Config\UserMountCache; use OC\Files\Config\UserMountCacheListener; @@ -124,9 +126,12 @@ use OCP\Collaboration\AutoComplete\IManager; use OCP\Contacts\ContactsMenu\IContactsStore; use OCP\Defaults; use OCA\Theming\Util; +use OCP\Federation\ICloudFederationFactory; +use OCP\Federation\ICloudFederationProviderManager; use OCP\Federation\ICloudIdManager; use OCP\Authentication\LoginCredentials\IStore; use OCP\Files\NotFoundException; +use OCP\GlobalScale\IConfig; use OCP\ICacheFactory; use OCP\IDBConnection; use OCP\IL10N; @@ -1107,6 +1112,18 @@ class Server extends ServerContainer implements IServerContainer { return new CloudIdManager(); }); + $this->registerService(IConfig::class, function (Server $c) { + return new GlobalScale\Config($c->getConfig()); + }); + + $this->registerService(ICloudFederationProviderManager::class, function (Server $c) { + return new CloudFederationProviderManager(); + }); + + $this->registerService(ICloudFederationFactory::class, function (Server $c) { + return new CloudFederationFactory(); + }); + $this->registerAlias(\OCP\AppFramework\Utility\IControllerMethodReflector::class, \OC\AppFramework\Utility\ControllerMethodReflector::class); $this->registerAlias('ControllerMethodReflector', \OCP\AppFramework\Utility\IControllerMethodReflector::class); @@ -1973,6 +1990,20 @@ class Server extends ServerContainer implements IServerContainer { return $this->query(ICloudIdManager::class); } + /** + * @return \OCP\GlobalScale\IConfig + */ + public function getGlobalScaleConfig() { + return $this->query(IConfig::class); + } + + /** + * @return \OCP\Federation\ICloudFederationProviderManager + */ + public function getCloudFederationProviderManager() { + return $this->query(ICloudFederationProviderManager::class); + } + /** * @return \OCP\Remote\Api\IApiFactory */ @@ -1980,6 +2011,13 @@ class Server extends ServerContainer implements IServerContainer { return $this->query(IApiFactory::class); } + /** + * @return \OCP\Federation\ICloudFederationFactory + */ + public function getCloudFederationFactory() { + return $this->query(ICloudFederationFactory::class); + } + /** * @return \OCP\Remote\IInstanceFactory */ diff --git a/lib/private/Share20/ProviderFactory.php b/lib/private/Share20/ProviderFactory.php index 3716189445..456b6dbc59 100644 --- a/lib/private/Share20/ProviderFactory.php +++ b/lib/private/Share20/ProviderFactory.php @@ -29,10 +29,10 @@ namespace OC\Share20; use OC\CapabilitiesManager; -use OC\GlobalScale\Config; use OCA\FederatedFileSharing\AddressHandler; use OCA\FederatedFileSharing\FederatedShareProvider; use OCA\FederatedFileSharing\Notifications; +use OCA\FederatedFileSharing\OCM\CloudFederationProvider; use OCA\FederatedFileSharing\TokenHandler; use OCA\ShareByMail\Settings\SettingsManager; use OCA\ShareByMail\ShareByMailProvider; @@ -133,7 +133,7 @@ class ProviderFactory implements IProviderFactory { $this->serverContainer->getConfig(), $this->serverContainer->getUserManager(), $this->serverContainer->getCloudIdManager(), - $this->serverContainer->query(Config::class) + $this->serverContainer->getGlobalScaleConfig() ); } diff --git a/lib/public/Federation/Exceptions/ProviderAlreadyExistsException.php b/lib/public/Federation/Exceptions/ProviderAlreadyExistsException.php new file mode 100644 index 0000000000..f053a02fbe --- /dev/null +++ b/lib/public/Federation/Exceptions/ProviderAlreadyExistsException.php @@ -0,0 +1,41 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCP\Federation\Exceptions; + +use OC\HintException; + +class ProviderAlreadyExistsException extends HintException { + + /** + * ProviderAlreadyExistsException constructor. + * + * @param string $newProviderId cloud federation provider ID of the new provider + * @param string $existingProviderName name of cloud federation provider which already use the same ID + */ + public function __construct($newProviderId, $existingProviderName) { + $l = \OC::$server->getL10N('federation'); + $message = 'Id "' . $newProviderId . '" already used by cloud federation provider "' . $existingProviderName . '"'; + $hint = $l->t('Id "%s" already used by cloud federation provider "%s"', [$newProviderId, $existingProviderName]); + parent::__construct($message, $hint); + } + +} diff --git a/lib/public/Federation/Exceptions/ProviderCouldNotAddShareException.php b/lib/public/Federation/Exceptions/ProviderCouldNotAddShareException.php new file mode 100644 index 0000000000..b608437aa3 --- /dev/null +++ b/lib/public/Federation/Exceptions/ProviderCouldNotAddShareException.php @@ -0,0 +1,28 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCP\Federation\Exceptions; + +use OC\HintException; + +class ProviderCouldNotAddShareException extends HintException { + +} diff --git a/lib/public/Federation/Exceptions/ProviderDoesNotExistsException.php b/lib/public/Federation/Exceptions/ProviderDoesNotExistsException.php new file mode 100644 index 0000000000..8f760d6abf --- /dev/null +++ b/lib/public/Federation/Exceptions/ProviderDoesNotExistsException.php @@ -0,0 +1,40 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCP\Federation\Exceptions; + +use OC\HintException; + +class ProviderDoesNotExistsException extends HintException { + + /** + * ProviderDoesNotExistsException constructor. + * + * @param string $providerId cloud federation provider ID + */ + public function __construct($providerId) { + $l = \OC::$server->getL10N('federation'); + $message = 'Cloud Federation Provider with ID: "' . $providerId . '" does not exist.'; + $hint = $l->t('Cloud Federation Provider with ID: "%s" does not exist.', [$providerId]); + parent::__construct($message, $hint); + } + +} diff --git a/lib/public/Federation/Exceptions/ShareNotFoundException.php b/lib/public/Federation/Exceptions/ShareNotFoundException.php new file mode 100644 index 0000000000..6655d5b443 --- /dev/null +++ b/lib/public/Federation/Exceptions/ShareNotFoundException.php @@ -0,0 +1,29 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCP\Federation\Exceptions; + + +use OC\HintException; + +class ShareNotFoundException extends HintException { + +} diff --git a/lib/public/Federation/ICloudFederationFactory.php b/lib/public/Federation/ICloudFederationFactory.php new file mode 100644 index 0000000000..e33608bcab --- /dev/null +++ b/lib/public/Federation/ICloudFederationFactory.php @@ -0,0 +1,55 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCP\Federation; + +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 $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 ICloudFederationShare + * + * @since 14.0.0 + */ + public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType); + + /** + * get a Cloud FederationNotification object to prepare a notification you + * want to send + * + * @return ICloudFederationNotification + * + * @since 14.0.0 + */ + public function getCloudFederationNotification(); +} diff --git a/lib/public/Federation/ICloudFederationNotification.php b/lib/public/Federation/ICloudFederationNotification.php new file mode 100644 index 0000000000..5db93ef0a8 --- /dev/null +++ b/lib/public/Federation/ICloudFederationNotification.php @@ -0,0 +1,44 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCP\Federation; + +interface ICloudFederationNotification { + + /** + * add a message to the notification + * + * @param string $identifier + * @param string $message + * + * @since 14.0.0 + */ + public function setMessage($identifier, $message); + + /** + * get JSON encoded Message, ready to send out + * + * @return string + * + * @since 14.0.0 + */ + public function getMessage(); +} diff --git a/lib/public/Federation/ICloudFederationProvider.php b/lib/public/Federation/ICloudFederationProvider.php new file mode 100644 index 0000000000..4c11fc2039 --- /dev/null +++ b/lib/public/Federation/ICloudFederationProvider.php @@ -0,0 +1,81 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCP\Federation; + +use OCP\Federation\Exceptions\ShareNotFoundException; + +/** + * Interface ICloudFederationProvider + * + * Enable apps to create their own cloud federation provider + * + * @since 14.0.0 + * + * @package OCP\Federation + */ + +interface ICloudFederationProvider { + + /** + * ICloudFederationProvider constructor. + * + * @param $shareType define the share type, handled by this provider + */ + public function __construct($shareType); + + /** + * get the name of the share type, handled by this provider + * + * @return string + */ + public function getShareType(); + + /** + * send new share to another server + * + * @since 14.0.0 + */ + public function sendShare(); + + /** + * share received from another server + * + * @param ICloudFederationShare $share + * @return string provider specific unique ID of the share + * + * @since 14.0.0 + */ + public function shareReceived(ICloudFederationShare $share); + + /** + * notification received from another server + * + * @param string $id unique ID of a already existing share + * @param array $notification provider specific notification + * + * @throws ShareNotFoundException + * + * @since 14.0.0 + */ + public function notificationReceived($id, $notification); + +} diff --git a/lib/public/Federation/ICloudFederationProviderManager.php b/lib/public/Federation/ICloudFederationProviderManager.php new file mode 100644 index 0000000000..c978994924 --- /dev/null +++ b/lib/public/Federation/ICloudFederationProviderManager.php @@ -0,0 +1,97 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCP\Federation; + +/** + * Class ICloudFederationProviderManager + * + * Manage cloud federation providers + * + * @since 14.0.0 + * + * @package OCP\Federation + */ +interface ICloudFederationProviderManager { + + /** + * Registers an callback function which must return an cloud federation provider + * + * @param string $shareType which share type does the provider handles + * @param string $displayName user facing name of the federated share provider + * @param callable $callback + * @throws Exceptions\ProviderAlreadyExistsException + * + * @since 14.0.0 + */ + public function addCloudFederationProvider($shareType, $displayName, callable $callback); + + /** + * remove cloud federation provider + * + * @param string $shareType + * + * @since 14.0.0 + */ + public function removeCloudFederationProvider($shareType); + + /** + * get a list of all cloudFederationProviders + * + * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]] + * + * @since 14.0.0 + */ + public function getAllCloudFederationProviders(); + + /** + * get a specific cloud federation provider + * + * @param string $shareType + * @return ICloudFederationProvider + * @throws Exceptions\ProviderDoesNotExistsException; + * + * @since 14.0.0 + */ + public function getCloudFederationProvider($shareType); + + /** + * send federated share + * + * @param ICloudFederationShare $share + * @return mixed + * + * @since 14.0.0 + */ + public function sendShare(ICloudFederationShare $share); + + /** + * send notification about existing share + * + * @param ICloudFederationNotification $notification + * @return mixed + * + * @since 14.0.0 + */ + public function sendNotification(ICloudFederationNotification $notification); + + +} diff --git a/lib/public/Federation/ICloudFederationShare.php b/lib/public/Federation/ICloudFederationShare.php new file mode 100644 index 0000000000..b116da0fb5 --- /dev/null +++ b/lib/public/Federation/ICloudFederationShare.php @@ -0,0 +1,233 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCP\Federation; + +interface ICloudFederationShare { + + /** + * set uid of the recipient + * + * @param string $user + * + * @since 14.0.0 + */ + public function setShareWith($user); + + /** + * set resource name (e.g. file, calendar, contact,...) + * + * @param string $name + * + * @since 14.0.0 + */ + public function setResourceName($name); + + /** + * set resource type (e.g. file, calendar, contact,...) + * + * @param string $resourceType + * + * @since 14.0.0 + */ + public function setResourceType($resourceType); + + /** + * set resource description (optional) + * + * @param string $description + * + * @since 14.0.0 + */ + public function setDescription($description); + + /** + * set provider ID (e.g. file ID) + * + * @param string $providerId + * + * @since 14.0.0 + */ + public function setProviderId($providerId); + + /** + * set owner UID + * + * @param string $owner + * + * @since 14.0.0 + */ + public function setOwner($owner); + + /** + * set owner display name + * + * @param string $ownerDisplayName + * + * @since 14.0.0 + */ + public function setOwnerDisplayName($ownerDisplayName); + + /** + * set UID of the user who sends the share + * + * @param string $sharedBy + * + * @since 14.0.0 + */ + public function setSharedBy($sharedBy); + + /** + * set display name of the user who sends the share + * + * @param $sharedByDisplayName + * + * @since 14.0.0 + */ + public function setSharedByDisplayName($sharedByDisplayName); + + /** + * set protocol specification + * + * @param array $protocol + * + * @since 14.0.0 + */ + public function setProtocol(array $protocol); + + /** + * share type (group or user) + * + * @param string $shareType + * + * @since 14.0.0 + */ + public function setShareType($shareType); + + /** + * get JSON encoded share, ready to send out + * + * @return string + * + * @since 14.0.0 + */ + public function getShare(); + + /** + * get uid of the recipient + * + * @return string + * + * @since 14.0.0 + */ + public function getShareWith(); + + /** + * get resource name (e.g. file, calendar, contact,...) + * + * @return string + * + * @since 14.0.0 + */ + public function getResourceName(); + + /** + * get resource type (e.g. file, calendar, contact,...) + * + * @return string + * + * @since 14.0.0 + */ + public function getResourceType(); + + /** + * get resource description (optional) + * + * @return string + * + * @since 14.0.0 + */ + public function getDescription(); + + /** + * get provider ID (e.g. file ID) + * + * @return string + * + * @since 14.0.0 + */ + public function getProviderId(); + + /** + * get owner UID + * + * @return string + * + * @since 14.0.0 + */ + public function getOwner(); + + /** + * get owner display name + * + * @return string + * + * @since 14.0.0 + */ + public function getOwnerDisplayName(); + + /** + * get UID of the user who sends the share + * + * @return string + * + * @since 14.0.0 + */ + public function getSharedBy(); + + /** + * get display name of the user who sends the share + * + * @return string + * + * @since 14.0.0 + */ + public function getSharedByDisplayName(); + + /** + * get share type (group or user) + * + * @return string + * + * @since 14.0.0 + */ + public function getShareType(); + + /** + * get protocol specification + * + * @return array + * + * @since 14.0.0 + */ + public function getProtocol(); + +} diff --git a/lib/public/IServerContainer.php b/lib/public/IServerContainer.php index 96015d3f8a..ebe92274a4 100644 --- a/lib/public/IServerContainer.php +++ b/lib/public/IServerContainer.php @@ -45,6 +45,8 @@ // This means that they should be used by apps instead of the internal ownCloud classes namespace OCP; use OCP\Log\ILogFactory; +use OCP\Federation\ICloudFederationFactory; +use OCP\Federation\ICloudFederationProviderManager; use OCP\Security\IContentSecurityPolicyManager; use Symfony\Component\EventDispatcher\EventDispatcherInterface; @@ -553,6 +555,23 @@ interface IServerContainer extends IContainer { */ public function getCloudIdManager(); + /** + * @return \OCP\GlobalScale\IConfig + */ + public function getGlobalScaleConfig(); + + /** + * @return ICloudFederationFactory + * @since 14.0.0 + */ + public function getCloudFederationFactory(); + + /** + * @return ICloudFederationProviderManager + * @since 14.0.0 + */ + public function getCloudFederationProviderManager(); + /** * @return \OCP\Remote\Api\IApiFactory * @since 13.0.0 diff --git a/ocm-provider/index.php b/ocm-provider/index.php new file mode 100644 index 0000000000..079ef790fa --- /dev/null +++ b/ocm-provider/index.php @@ -0,0 +1,39 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + + +require_once __DIR__ . '/../lib/base.php'; + +header('Content-Type: application/json'); + +$server = \OC::$server; + +$isEnabled = $server->getAppManager()->isEnabledForUser('cloud_federation_api'); + +if ($isEnabled) { + $capabilities = new OCA\CloudFederationAPI\Capabilities($server->getURLGenerator()); + header('Content-Type: application/json'); + echo json_encode($capabilities->getCapabilities()['ocm']); +} else { + header($_SERVER["SERVER_PROTOCOL"]." 501 Not Implemented", true, 501); + exit("501 Not Implemented"); +} + From 21e64ec7f41dcf5424c3357f7ce07b22a817a16e Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Mon, 30 Apr 2018 11:49:24 +0200 Subject: [PATCH 02/39] implement receiving of federated shares Signed-off-by: Bjoern Schiessle --- .../lib/AppInfo/Application.php | 18 +- .../Controller/RequestHandlerController.php | 140 ++++----- .../lib/FederatedShareProvider.php | 10 +- .../lib/ocm/CloudFederationProvider.php | 83 ------ .../lib/ocm/CloudFederationProviderFiles.php | 272 ++++++++++++++++++ .../ProviderCouldNotAddShareException.php | 6 + .../Federation/ICloudFederationProvider.php | 12 +- 7 files changed, 351 insertions(+), 190 deletions(-) delete mode 100644 apps/federatedfilesharing/lib/ocm/CloudFederationProvider.php create mode 100644 apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php diff --git a/apps/federatedfilesharing/lib/AppInfo/Application.php b/apps/federatedfilesharing/lib/AppInfo/Application.php index 23f521a51c..655c01cf85 100644 --- a/apps/federatedfilesharing/lib/AppInfo/Application.php +++ b/apps/federatedfilesharing/lib/AppInfo/Application.php @@ -33,6 +33,7 @@ use OCA\FederatedFileSharing\Controller\RequestHandlerController; use OCA\FederatedFileSharing\FederatedShareProvider; use OCA\FederatedFileSharing\Notifications; use OCA\FederatedFileSharing\OCM\CloudFederationProvider; +use OCA\FederatedFileSharing\OCM\CloudFederationProviderFiles; use OCP\AppFramework\App; use OCP\GlobalScale\IConfig; @@ -51,7 +52,18 @@ class Application extends App { $cloudFederationManager->addCloudFederationProvider('file', 'Federated Files Sharing', function() use ($container) { - return new CloudFederationProvider('file'); + $server = $container->getServer(); + return new CloudFederationProviderFiles( + $server->getAppManager(), + $server->query(FederatedShareProvider::class), + $server->query(AddressHandler::class), + $server->getLogger(), + $server->getUserManager(), + $server->getCloudIdManager(), + $server->getActivityManager(), + $server->getNotificationManager(), + $server->getURLGenerator() + ); }); $container->registerService('RequestHandlerController', function(SimpleContainer $c) use ($server) { @@ -76,7 +88,9 @@ class Application extends App { $addressHandler, $server->getUserManager(), $server->getCloudIdManager(), - $server->getLogger() + $server->getLogger(), + $server->getCloudFederationFactory(), + $server->getCloudFederationProviderManager() ); }); } diff --git a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php index 422f12dda2..2d0a3c528f 100644 --- a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php +++ b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php @@ -40,6 +40,10 @@ use OCP\AppFramework\OCS\OCSForbiddenException; use OCP\AppFramework\OCS\OCSNotFoundException; use OCP\AppFramework\OCSController; use OCP\Constants; +use OCP\Federation\Exceptions\ProviderCouldNotAddShareException; +use OCP\Federation\Exceptions\ProviderDoesNotExistsException; +use OCP\Federation\ICloudFederationFactory; +use OCP\Federation\ICloudFederationProviderManager; use OCP\Federation\ICloudIdManager; use OCP\Files\NotFoundException; use OCP\IDBConnection; @@ -78,6 +82,12 @@ class RequestHandlerController extends OCSController { /** @var ILogger */ private $logger; + /** @var ICloudFederationFactory */ + private $cloudFederationFactory; + + /** @var ICloudFederationProviderManager */ + private $cloudFederationProviderManager; + /** * Server2Server constructor. * @@ -90,6 +100,9 @@ class RequestHandlerController extends OCSController { * @param AddressHandler $addressHandler * @param IUserManager $userManager * @param ICloudIdManager $cloudIdManager + * @param ILogger $logger + * @param ICloudFederationFactory $cloudFederationFactory + * @param ICloudFederationProviderManager $cloudFederationProviderManager */ public function __construct($appName, IRequest $request, @@ -100,7 +113,9 @@ class RequestHandlerController extends OCSController { AddressHandler $addressHandler, IUserManager $userManager, ICloudIdManager $cloudIdManager, - ILogger $logger + ILogger $logger, + ICloudFederationFactory $cloudFederationFactory, + ICloudFederationProviderManager $cloudFederationProviderManager ) { parent::__construct($appName, $request); @@ -112,6 +127,8 @@ class RequestHandlerController extends OCSController { $this->userManager = $userManager; $this->cloudIdManager = $cloudIdManager; $this->logger = $logger; + $this->cloudFederationFactory = $cloudFederationFactory; + $this->cloudFederationProviderManager = $cloudFederationProviderManager; } /** @@ -125,10 +142,6 @@ class RequestHandlerController extends OCSController { */ public function createShare() { - if (!$this->isS2SEnabled(true)) { - throw new OCSException('Server does not support federated cloud sharing', 503); - } - $remote = isset($_POST['remote']) ? $_POST['remote'] : null; $token = isset($_POST['token']) ? $_POST['token'] : null; $name = isset($_POST['name']) ? $_POST['name'] : null; @@ -139,92 +152,41 @@ class RequestHandlerController extends OCSController { $sharedByFederatedId = isset($_POST['sharedByFederatedId']) ? $_POST['sharedByFederatedId'] : null; $ownerFederatedId = isset($_POST['ownerFederatedId']) ? $_POST['ownerFederatedId'] : null; - if ($remote && $token && $name && $owner && $remoteId && $shareWith) { - - if (!\OCP\Util::isValidFileName($name)) { - throw new OCSException('The mountpoint name contains invalid characters.', 400); - } - - // FIXME this should be a method in the user management instead - $this->logger->debug('shareWith before, ' . $shareWith, ['app' => 'files_sharing']); - \OCP\Util::emitHook( - '\OCA\Files_Sharing\API\Server2Server', - 'preLoginNameUsedAsUserName', - array('uid' => &$shareWith) - ); - $this->logger->debug('shareWith after, ' . $shareWith, ['app' => 'files_sharing']); - - if (!\OC::$server->getUserManager()->userExists($shareWith)) { - throw new OCSException('User does not exists', 400); - } - - \OC_Util::setupFS($shareWith); - - $externalManager = new \OCA\Files_Sharing\External\Manager( - \OC::$server->getDatabaseConnection(), - \OC\Files\Filesystem::getMountManager(), - \OC\Files\Filesystem::getLoader(), - \OC::$server->getHTTPClientService(), - \OC::$server->getNotificationManager(), - \OC::$server->query(\OCP\OCS\IDiscoveryService::class), - $shareWith - ); - - try { - $externalManager->addShare($remote, $token, '', $name, $owner, false, $shareWith, $remoteId); - $shareId = \OC::$server->getDatabaseConnection()->lastInsertId('*PREFIX*share_external'); - - 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; - } - - $event = \OC::$server->getActivityManager()->generateEvent(); - $event->setApp('files_sharing') - ->setType('remote_share') - ->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_RECEIVED, [$ownerFederatedId, trim($name, '/')]) - ->setAffectedUser($shareWith) - ->setObject('remote_share', (int)$shareId, $name); - \OC::$server->getActivityManager()->publish($event); - - $urlGenerator = \OC::$server->getURLGenerator(); - - $notificationManager = \OC::$server->getNotificationManager(); - $notification = $notificationManager->createNotification(); - $notification->setApp('files_sharing') - ->setUser($shareWith) - ->setDateTime(new \DateTime()) - ->setObject('remote_share', $shareId) - ->setSubject('remote_share', [$ownerFederatedId, $sharedByFederatedId, trim($name, '/')]); - - $declineAction = $notification->createAction(); - $declineAction->setLabel('decline') - ->setLink($urlGenerator->getAbsoluteURL($urlGenerator->linkTo('', 'ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending/' . $shareId)), 'DELETE'); - $notification->addAction($declineAction); - - $acceptAction = $notification->createAction(); - $acceptAction->setLabel('accept') - ->setLink($urlGenerator->getAbsoluteURL($urlGenerator->linkTo('', 'ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending/' . $shareId)), 'POST'); - $notification->addAction($acceptAction); - - $notificationManager->notify($notification); - - return new Http\DataResponse(); - } catch (\Exception $e) { - $this->logger->logException($e, [ - 'message' => 'Server can not add remote share.', - 'level' => ILogger::ERROR, - 'app' => 'files_sharing' - ]); - throw new OCSException('internal server error, was not able to add share from ' . $remote, 500); - } + 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; } - throw new OCSException('server can not add remote share, missing parameter', 400); + $share = $this->cloudFederationFactory->getCloudFederationShare( + $shareWith, + $name, + '', + $remoteId, + $ownerFederatedId, + $owner, + $sharedByFederatedId, + $sharedBy, + ['name' => 'webdav', 'options' => ['access_token' => $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(), $e->getCode()); + } catch (\Exception $e) { + throw new OCSException('internal server error, was not able to add share from ' . $remote, 500); + } + + return new Http\DataResponse(); } /** diff --git a/apps/federatedfilesharing/lib/FederatedShareProvider.php b/apps/federatedfilesharing/lib/FederatedShareProvider.php index d2962d9c59..ecc1e1710b 100644 --- a/apps/federatedfilesharing/lib/FederatedShareProvider.php +++ b/apps/federatedfilesharing/lib/FederatedShareProvider.php @@ -30,7 +30,6 @@ namespace OCA\FederatedFileSharing; use OC\Share20\Share; -use OCA\FederatedFileSharing\OCM\CloudFederationProvider; use OCP\Federation\ICloudIdManager; use OCP\DB\QueryBuilder\IQueryBuilder; use OCP\Files\Folder; @@ -92,9 +91,6 @@ class FederatedShareProvider implements IShareProvider { /** @var \OCP\GlobalScale\IConfig */ private $gsConfig; - /** @var CloudFederationProvider */ - private $cloudFederationProvider; - /** * DefaultShareProvider constructor. * @@ -109,7 +105,6 @@ class FederatedShareProvider implements IShareProvider { * @param IUserManager $userManager * @param ICloudIdManager $cloudIdManager * @param \OCP\GlobalScale\IConfig $globalScaleConfig - * @param CloudFederationProvider $cloudFederationProvider */ public function __construct( IDBConnection $connection, @@ -122,8 +117,7 @@ class FederatedShareProvider implements IShareProvider { IConfig $config, IUserManager $userManager, ICloudIdManager $cloudIdManager, - \OCP\GlobalScale\IConfig $globalScaleConfig, - CloudFederationProvider $cloudFederationProvider + \OCP\GlobalScale\IConfig $globalScaleConfig ) { $this->dbConnection = $connection; $this->addressHandler = $addressHandler; @@ -136,8 +130,6 @@ class FederatedShareProvider implements IShareProvider { $this->userManager = $userManager; $this->cloudIdManager = $cloudIdManager; $this->gsConfig = $globalScaleConfig; - $this->cloudFederationProvider = $cloudFederationProvider; - } /** diff --git a/apps/federatedfilesharing/lib/ocm/CloudFederationProvider.php b/apps/federatedfilesharing/lib/ocm/CloudFederationProvider.php deleted file mode 100644 index 36b2d282b9..0000000000 --- a/apps/federatedfilesharing/lib/ocm/CloudFederationProvider.php +++ /dev/null @@ -1,83 +0,0 @@ - - * - * @license GNU AGPL version 3 or any later version - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Affero General Public License for more details. - * - * You should have received a copy of the GNU Affero General Public License - * along with this program. If not, see . - * - */ - -namespace OCA\FederatedFileSharing\OCM; - -use OCP\Federation\ICloudFederationFactory; -use OCP\Federation\ICloudFederationProvider; -use OCP\Federation\ICloudFederationShare; - -class CloudFederationProvider implements ICloudFederationProvider { - - /** @var string */ - private $shareType; - - /** - * CloudFederationProvider constructor. - * - * @param string $shareType - */ - public function __construct($shareType) { - $this->shareType = $shareType; - } - - /** - * @return string - */ - public function getShareType() { - return $this->shareType; - } - - /** - * send new share to another server - * - * @since 14.0.0 - */ - public function sendShare() { - // TODO: Implement sendShare() method. - } - - /** - * share received from another server - * - * @param ICloudFederationShare $share - * @return string provider specific unique ID of the share - * - * @since 14.0.0 - */ - public function shareReceived(ICloudFederationShare $share) { - // TODO: Implement shareReceived() method. - } - - /** - * notification received from another server - * - * @param string $id unique ID of a already existing share - * @param array $notification provider specific notification - * - * @throws \OCP\Federation\Exceptions\ShareNotFoundException - * - * @since 14.0.0 - */ - public function notificationReceived($id, $notification) { - // TODO: Implement notificationReceived() method. - } -} diff --git a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php new file mode 100644 index 0000000000..f05f446914 --- /dev/null +++ b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php @@ -0,0 +1,272 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCA\FederatedFileSharing\OCM; + +use OC\AppFramework\Http; +use OCA\Files_Sharing\Activity\Providers\RemoteShares; +use OCA\FederatedFileSharing\AddressHandler; +use OCA\FederatedFileSharing\FederatedShareProvider; +use OCP\Activity\IManager as IActivityManager; +use OCP\App\IAppManager; +use OCP\Federation\Exceptions\ProviderCouldNotAddShareException; +use OCP\Federation\ICloudFederationProvider; +use OCP\Federation\ICloudFederationShare; +use OCP\Federation\ICloudIdManager; +use OCP\ILogger; +use OCP\IURLGenerator; +use OCP\IUserManager; +use OCP\Notification\IManager as INotificationManager; + +class CloudFederationProviderFiles implements ICloudFederationProvider { + + /** @var IAppManager */ + private $appManager; + + /** @var FederatedShareProvider */ + private $federatedShareProvider; + + /** @var AddressHandler */ + private $addressHandler; + + /** @var ILogger */ + private $logger; + + /** @var IUserManager */ + private $userManager; + + /** @var ICloudIdManager */ + private $cloudIdManager; + + /** @var IActivityManager */ + private $activityManager; + + /** @var INotificationManager */ + private $notificationManager; + + /** @var IURLGenerator */ + private $urlGenerator; + + /** + * CloudFederationProvider constructor. + * + * @param IAppManager $appManager + * @param FederatedShareProvider $federatedShareProvider + * @param AddressHandler $addressHandler + * @param ILogger $logger + * @param IUserManager $userManager + * @param ICloudIdManager $cloudIdManager + * @param IActivityManager $activityManager + * @param INotificationManager $notificationManager + * @param IURLGenerator $urlGenerator + */ + public function __construct(IAppManager $appManager, + FederatedShareProvider $federatedShareProvider, + AddressHandler $addressHandler, + ILogger $logger, + IUserManager $userManager, + ICloudIdManager $cloudIdManager, + IActivityManager $activityManager, + INotificationManager $notificationManager, + IURLGenerator $urlGenerator + ) { + $this->appManager = $appManager; + $this->federatedShareProvider = $federatedShareProvider; + $this->addressHandler = $addressHandler; + $this->logger = $logger; + $this->userManager = $userManager; + $this->cloudIdManager = $cloudIdManager; + $this->activityManager = $activityManager; + $this->notificationManager = $notificationManager; + $this->urlGenerator = $urlGenerator; + } + + + + /** + * @return string + */ + public function getShareType() { + return 'file'; + } + + /** + * send new share to another server + * + * @since 14.0.0 + */ + public function sendShare() { + // TODO: Implement sendShare() method. + } + + /** + * share received from another server + * + * @param ICloudFederationShare $share + * @return string provider specific unique ID of the share + * + * @throws ProviderCouldNotAddShareException + * @throws \OCP\AppFramework\QueryException + * @throws \OC\HintException + * @since 14.0.0 + */ + public function shareReceived(ICloudFederationShare $share) { + + if (!$this->isS2SEnabled(true)) { + throw new ProviderCouldNotAddShareException('Server does not support federated cloud sharing', '', Http::STATUS_SERVICE_UNAVAILABLE); + } + + $protocol = $share->getProtocol(); + if ($protocol['name'] !== 'webdav') { + throw new ProviderCouldNotAddShareException('Unsupported protocol for data exchange.', '', Http::STATUS_NOT_IMPLEMENTED); + } + + list($ownerUid, $remote) = $this->addressHandler->splitUserRemote($share->getOwner()); + + $remote = $remote; + $token = isset($protocol['options']['access_token']) ? $protocol['options']['access_token'] : null; + $name = $share->getResourceName(); + $owner = $share->getOwnerDisplayName(); + $sharedBy = $share->getSharedByDisplayName(); + $shareWith = $share->getShareWith(); + $remoteId = $share->getProviderId(); + $sharedByFederatedId = $share->getSharedBy(); + $ownerFederatedId = $share->getOwner(); + + // if no explicit information about the person who created the share was send + // we assume that the share comes from the owner + if ($sharedByFederatedId === null) { + $sharedBy = $owner; + $sharedByFederatedId = $ownerFederatedId; + } + + if ($remote && $token && $name && $owner && $remoteId && $shareWith) { + + if (!\OCP\Util::isValidFileName($name)) { + throw new ProviderCouldNotAddShareException('The mountpoint name contains invalid characters.', '', Http::STATUS_BAD_REQUEST); + } + + // FIXME this should be a method in the user management instead + $this->logger->debug('shareWith before, ' . $shareWith, ['app' => 'files_sharing']); + \OCP\Util::emitHook( + '\OCA\Files_Sharing\API\Server2Server', + 'preLoginNameUsedAsUserName', + array('uid' => &$shareWith) + ); + $this->logger->debug('shareWith after, ' . $shareWith, ['app' => 'files_sharing']); + + if (!$this->userManager->userExists($shareWith)) { + throw new ProviderCouldNotAddShareException('User does not exists', '',Http::STATUS_BAD_REQUEST); + } + + \OC_Util::setupFS($shareWith); + + $externalManager = new \OCA\Files_Sharing\External\Manager( + \OC::$server->getDatabaseConnection(), + \OC\Files\Filesystem::getMountManager(), + \OC\Files\Filesystem::getLoader(), + \OC::$server->getHTTPClientService(), + \OC::$server->getNotificationManager(), + \OC::$server->query(\OCP\OCS\IDiscoveryService::class), + $shareWith + ); + + try { + $externalManager->addShare($remote, $token, '', $name, $owner, false, $shareWith, $remoteId); + $shareId = \OC::$server->getDatabaseConnection()->lastInsertId('*PREFIX*share_external'); + + $event = $this->activityManager->generateEvent(); + $event->setApp('files_sharing') + ->setType('remote_share') + ->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_RECEIVED, [$ownerFederatedId, trim($name, '/')]) + ->setAffectedUser($shareWith) + ->setObject('remote_share', (int)$shareId, $name); + \OC::$server->getActivityManager()->publish($event); + + $notification = $this->notificationManager->createNotification(); + $notification->setApp('files_sharing') + ->setUser($shareWith) + ->setDateTime(new \DateTime()) + ->setObject('remote_share', $shareId) + ->setSubject('remote_share', [$ownerFederatedId, $sharedByFederatedId, trim($name, '/')]); + + $declineAction = $notification->createAction(); + $declineAction->setLabel('decline') + ->setLink($this->urlGenerator->getAbsoluteURL($this->urlGenerator->linkTo('', 'ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending/' . $shareId)), 'DELETE'); + $notification->addAction($declineAction); + + $acceptAction = $notification->createAction(); + $acceptAction->setLabel('accept') + ->setLink($this->urlGenerator->getAbsoluteURL($this->urlGenerator->linkTo('', 'ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending/' . $shareId)), 'POST'); + $notification->addAction($acceptAction); + + $this->notificationManager->notify($notification); + + return $shareId; + } catch (\Exception $e) { + $this->logger->logException($e, [ + 'message' => 'Server can not add remote share.', + 'level' => \OCP\Util::ERROR, + 'app' => 'files_sharing' + ]); + throw new ProviderCouldNotAddShareException('internal server error, was not able to add share from ' . $remote, '', HTTP::STATUS_INTERNAL_SERVER_ERROR); + } + } + + throw new ProviderCouldNotAddShareException('server can not add remote share, missing parameter', '', HTTP::STATUS_BAD_REQUEST); + + } + + /** + * notification received from another server + * + * @param string $id unique ID of a already existing share + * @param array $notification provider specific notification + * + * @throws \OCP\Federation\Exceptions\ShareNotFoundException + * + * @since 14.0.0 + */ + public function notificationReceived($id, $notification) { + // TODO: Implement notificationReceived() method. + } + + /** + * check if server-to-server sharing is enabled + * + * @param bool $incoming + * @return bool + */ + private function isS2SEnabled($incoming = false) { + + $result = $this->appManager->isEnabledForUser('files_sharing'); + + if ($incoming) { + $result = $result && $this->federatedShareProvider->isIncomingServer2serverShareEnabled(); + } else { + $result = $result && $this->federatedShareProvider->isOutgoingServer2serverShareEnabled(); + } + + return $result; + } + + +} diff --git a/lib/public/Federation/Exceptions/ProviderCouldNotAddShareException.php b/lib/public/Federation/Exceptions/ProviderCouldNotAddShareException.php index b608437aa3..205206d5af 100644 --- a/lib/public/Federation/Exceptions/ProviderCouldNotAddShareException.php +++ b/lib/public/Federation/Exceptions/ProviderCouldNotAddShareException.php @@ -22,7 +22,13 @@ namespace OCP\Federation\Exceptions; use OC\HintException; +use OCP\AppFramework\Http; class ProviderCouldNotAddShareException extends HintException { + public function __construct($message, $hint = '', $code = Http::STATUS_BAD_REQUEST, \Exception $previous = null) { + parent::__construct($message, $hint, $code, $previous); + } + + } diff --git a/lib/public/Federation/ICloudFederationProvider.php b/lib/public/Federation/ICloudFederationProvider.php index 4c11fc2039..535f61aae8 100644 --- a/lib/public/Federation/ICloudFederationProvider.php +++ b/lib/public/Federation/ICloudFederationProvider.php @@ -21,6 +21,7 @@ namespace OCP\Federation; +use OCP\Federation\Exceptions\ProviderCouldNotAddShareException; use OCP\Federation\Exceptions\ShareNotFoundException; /** @@ -35,17 +36,12 @@ use OCP\Federation\Exceptions\ShareNotFoundException; interface ICloudFederationProvider { - /** - * ICloudFederationProvider constructor. - * - * @param $shareType define the share type, handled by this provider - */ - public function __construct($shareType); - /** * get the name of the share type, handled by this provider * * @return string + * + * @since 14.0.0 */ public function getShareType(); @@ -62,6 +58,8 @@ interface ICloudFederationProvider { * @param ICloudFederationShare $share * @return string provider specific unique ID of the share * + * @throws ProviderCouldNotAddShareException + * * @since 14.0.0 */ public function shareReceived(ICloudFederationShare $share); From 4c8f3d6d77c5a6bb4a7eced86890039d15d9ca67 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Mon, 30 Apr 2018 16:29:56 +0200 Subject: [PATCH 03/39] add cloud federation api app Signed-off-by: Bjoern Schiessle --- apps/cloud_federation_api/LICENSE | 661 ++++++++++++++++++ apps/cloud_federation_api/Makefile | 50 ++ apps/cloud_federation_api/README.md | 2 + apps/cloud_federation_api/appinfo/app.php | 22 + apps/cloud_federation_api/appinfo/info.xml | 20 + .../lib/AppInfo/Application.php | 37 + .../cloud_federation_api/lib/Capabilities.php | 56 ++ apps/cloud_federation_api/lib/Config.php | 46 ++ .../Controller/RequestHandlerController.php | 258 +++++++ 9 files changed, 1152 insertions(+) create mode 100644 apps/cloud_federation_api/LICENSE create mode 100644 apps/cloud_federation_api/Makefile create mode 100644 apps/cloud_federation_api/README.md create mode 100644 apps/cloud_federation_api/appinfo/app.php create mode 100644 apps/cloud_federation_api/appinfo/info.xml create mode 100644 apps/cloud_federation_api/lib/AppInfo/Application.php create mode 100644 apps/cloud_federation_api/lib/Capabilities.php create mode 100644 apps/cloud_federation_api/lib/Config.php create mode 100644 apps/cloud_federation_api/lib/Controller/RequestHandlerController.php diff --git a/apps/cloud_federation_api/LICENSE b/apps/cloud_federation_api/LICENSE new file mode 100644 index 0000000000..dbbe355815 --- /dev/null +++ b/apps/cloud_federation_api/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/apps/cloud_federation_api/Makefile b/apps/cloud_federation_api/Makefile new file mode 100644 index 0000000000..bfaffcb4b1 --- /dev/null +++ b/apps/cloud_federation_api/Makefile @@ -0,0 +1,50 @@ +app_name=end_to_end_encryption + +project_dir=$(CURDIR)/../$(app_name) +build_dir=$(CURDIR)/build/artifacts +appstore_dir=$(build_dir)/appstore +source_dir=$(build_dir)/source +sign_dir=$(build_dir)/sign +package_name=$(app_name) +cert_dir=$(HOME)/.nextcloud/certificates +version+=1.0.1 + +all: appstore + +release: appstore create-tag + +create-tag: + git tag -s -a v$(version) -m "Tagging the $(version) release." + git push origin v$(version) + +clean: + rm -rf $(build_dir) + rm -rf node_modules + +appstore: clean + mkdir -p $(sign_dir) + rsync -a \ + --exclude=/build \ + --exclude=/docs \ + --exclude=/l10n/templates \ + --exclude=/l10n/.tx \ + --exclude=/tests \ + --exclude=/.git \ + --exclude=/.github \ + --exclude=/l10n/l10n.pl \ + --exclude=/CONTRIBUTING.md \ + --exclude=/issue_template.md \ + --exclude=/README.md \ + --exclude=/.gitattributes \ + --exclude=/.gitignore \ + --exclude=/.scrutinizer.yml \ + --exclude=/.drone.yml \ + --exclude=/.travis.yml \ + --exclude=/Makefile \ + $(project_dir)/ $(sign_dir)/$(app_name) + tar -czf $(build_dir)/$(app_name)-$(version).tar.gz \ + -C $(sign_dir) $(app_name) + @if [ -f $(cert_dir)/$(app_name).key ]; then \ + echo "Signing package…"; \ + openssl dgst -sha512 -sign $(cert_dir)/$(app_name).key $(build_dir)/$(app_name)-$(version).tar.gz | openssl base64; \ + fi diff --git a/apps/cloud_federation_api/README.md b/apps/cloud_federation_api/README.md new file mode 100644 index 0000000000..34b5045eaf --- /dev/null +++ b/apps/cloud_federation_api/README.md @@ -0,0 +1,2 @@ +# cloud_federation_api +The cloud federation API allows to share information like files, contacts, calendars, incoming calls, etc accross Nextcloud instances diff --git a/apps/cloud_federation_api/appinfo/app.php b/apps/cloud_federation_api/appinfo/app.php new file mode 100644 index 0000000000..9b79832d81 --- /dev/null +++ b/apps/cloud_federation_api/appinfo/app.php @@ -0,0 +1,22 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +$app = new \OCA\CloudFederationAPI\AppInfo\Application(); diff --git a/apps/cloud_federation_api/appinfo/info.xml b/apps/cloud_federation_api/appinfo/info.xml new file mode 100644 index 0000000000..c733d26c0d --- /dev/null +++ b/apps/cloud_federation_api/appinfo/info.xml @@ -0,0 +1,20 @@ + + + cloud_federation_api + Cloud Federation API + Enable clouds to communicate with each other and exchange data + The Coud Federation API enabled various Nextcloud instances to communitcate with each other and to exchange data + 0.0.1 + agpl + Bjoern Schiessle + CloudFederationAPI + + + + files + https://github.com/nextcloud/cloud_federation/issues + + + + diff --git a/apps/cloud_federation_api/lib/AppInfo/Application.php b/apps/cloud_federation_api/lib/AppInfo/Application.php new file mode 100644 index 0000000000..3ea3037d12 --- /dev/null +++ b/apps/cloud_federation_api/lib/AppInfo/Application.php @@ -0,0 +1,37 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + + +namespace OCA\CloudFederationAPI\AppInfo; + + +use OCA\CloudFederationAPI\Capabilities; +use OCP\AppFramework\App; + +class Application extends App { + + public function __construct() { + parent::__construct('cloud_federation_api'); + + $container = $this->getContainer(); + $container->registerCapability(Capabilities::class); + } +} diff --git a/apps/cloud_federation_api/lib/Capabilities.php b/apps/cloud_federation_api/lib/Capabilities.php new file mode 100644 index 0000000000..17d3b2cfaf --- /dev/null +++ b/apps/cloud_federation_api/lib/Capabilities.php @@ -0,0 +1,56 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + + +namespace OCA\CloudFederationAPI; + + +use OCP\Capabilities\ICapability; +use OCP\IURLGenerator; + +class Capabilities implements ICapability { + + /** @var IURLGenerator */ + private $urlGenerator; + + public function __construct(IURLGenerator $urlGenerator) { + $this->urlGenerator = $urlGenerator; + } + + /** + * Function an app uses to return the capabilities + * + * @return array Array containing the apps capabilities + * @since 8.2.0 + */ + public function getCapabilities() { + $url = $this->urlGenerator->linkToRouteAbsolute('cloud_federation_api.requesthandlercontroller.addShare'); + $capabilities = ['ocm' => + [ + 'enabled' => true, + 'api-version' => '2.0-draft', + 'end-point' => substr($url, 0, strrpos($url, '/')), + ] + ]; + + return $capabilities; + } +} diff --git a/apps/cloud_federation_api/lib/Config.php b/apps/cloud_federation_api/lib/Config.php new file mode 100644 index 0000000000..90c36a4f79 --- /dev/null +++ b/apps/cloud_federation_api/lib/Config.php @@ -0,0 +1,46 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + + +namespace OCA\CloudFederationAPI; + + +/** + * Class config + * + * handles all the config parameters + * + * @package OCA\CloudFederationAPI + */ +class Config { + + public function __construct() { + } + + public function incomingRequestsEnabled() { + return true; + } + + public function outgoingRequestsEnabled() { + return true; + } + +} diff --git a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php new file mode 100644 index 0000000000..d551f464c2 --- /dev/null +++ b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php @@ -0,0 +1,258 @@ + + * + * @author Bjoern Schiessle + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCA\CloudFederationAPI\Controller; + +use OCA\CloudFederationAPI\Config; +use OCP\AppFramework\Controller; +use OCP\AppFramework\Http; +use OCP\AppFramework\Http\JSONResponse; +use OCP\Federation\Exceptions\ProviderCouldNotAddShareException; +use OCP\Federation\Exceptions\ShareNotFoundException; +use OCP\Federation\ICloudFederationFactory; +use OCP\Federation\ICloudFederationProviderManager; +use OCP\Federation\Exceptions\ProviderDoesNotExistsException; +use OCP\ILogger; +use OCP\IRequest; +use OCP\IURLGenerator; +use OCP\IUserManager; + + +/** + * Class RequestHandlerController + * + * handle API between different Cloud instances + * + * @package OCA\CloudFederationAPI\Controller + */ +class RequestHandlerController extends Controller { + + /** @var ILogger */ + private $logger; + + /** @var IUserManager */ + private $userManager; + + /** @var IURLGenerator */ + private $urlGenerator; + + /** @var ICloudFederationProviderManager */ + private $cloudFederationProviderManager; + + /** @var Config */ + private $config; + + /** @var ICloudFederationFactory */ + private $factory; + + public function __construct($appName, + IRequest $request, + ILogger $logger, + IUserManager $userManager, + IURLGenerator $urlGenerator, + ICloudFederationProviderManager $cloudFederationProviderManager, + Config $config, + ICloudFederationFactory $factory + ) { + parent::__construct($appName, $request); + + $this->logger = $logger; + $this->userManager = $userManager; + $this->urlGenerator = $urlGenerator; + $this->cloudFederationProviderManager = $cloudFederationProviderManager; + $this->config = $config; + $this->factory = $factory; + } + + /** + * 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 $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","name":"welcome server2.txt","description":"desc","providerId":"2","owner":"admin2@http://localhost/server2","ownerDisplayName":"admin2 display","shareType":"user","resourceType":"file","protocol":{"name":"webdav","options":{"access_token":"8Lrd1FVEREthux7","permissions":31}}}' http://localhost/server/index.php/ocm/shares + */ + public function addShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) { + + if (!$this->config->incomingRequestsEnabled()) { + return new JSONResponse( + ['message' => 'This server doesn\'t support outgoing federated shares'], + Http::STATUS_NOT_IMPLEMENTED + ); + } + + // check if all required parameters are set + if ($shareWith === null || + $name === null || + $providerId === null || + $owner === null || + $resourceType === null || + $shareType === null || + !is_array($protocol) || + !isset($protocol['name']) || + !isset ($protocol['options']) || + !is_array($protocol['options']) + ) { + return new JSONResponse( + ['message' => 'Missing arguments'], + Http::STATUS_BAD_REQUEST + ); + } + + $shareWith = $this->mapUid($shareWith); + + 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; + + // 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, $protocol, $shareType, $resourceType); + $id = $provider->shareReceived($share); + } catch (ProviderDoesNotExistsException $e) { + return new JSONResponse( + ['message' => $e->getMessage()], + Http::STATUS_NOT_IMPLEMENTED + ); + } catch (ProviderCouldNotAddShareException $e) { + return new JSONResponse( + ['message' => $e->getMessage()], + $e->getCode() + ); + } catch (\Exception $e) { + return new JSONResponse( + ['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()], + Http::STATUS_BAD_REQUEST + ); + } + + return new JSONResponse( + ['id' => $id, 'createdAt' => time()], + Http::STATUS_CREATED); + + } + + /** + * receive notification about existing share + * + * @param $resourceType ('file', 'calendar',...) + * @param string $name resource name (e.g "file", "calendar",...) + * @param string $id unique id of the corresponding item on the receiving site + * @param array $notification contain the actual notification, content is defined by cloud federation provider + * @return JSONResponse + */ + public function receiveNotification($resourceType, $name, $id, $notification) { + if (!$this->config->incomingRequestsEnabled()) { + return new JSONResponse( + ['message' => 'This server doesn\'t support outgoing federated shares'], + Http::STATUS_NOT_IMPLEMENTED + ); + } + + // check if all required parameters are set + if ($name === null || + $id === null || + !is_array($notification) + ) { + return new JSONResponse( + ['message' => 'Missing arguments'], + Http::STATUS_BAD_REQUEST + ); + } + + try { + $provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType); + $provider->notificationReceived($id, $notification); + } catch (ProviderDoesNotExistsException $e) { + return new JSONResponse( + ['message' => $e->getMessage()], + Http::STATUS_BAD_REQUEST + ); + } catch (ShareNotFoundException $e) { + return new JSONResponse( + ['message' => $e->getMessage()], + Http::STATUS_BAD_REQUEST + ); + } catch (\Exception $e) { + return new JSONResponse( + ['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()], + Http::STATUS_BAD_REQUEST + ); + } + + + return new JSONResponse( + ['id' => $id, 'createdAt' => date()], + 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]); + + return $uid; + } + +} From 6208f250e88a15794ac5b7eeef6d701aa91e131b Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Wed, 2 May 2018 17:15:07 +0200 Subject: [PATCH 04/39] check if cloud federation api is ready Signed-off-by: Bjoern Schiessle --- .../CloudFederationProviderManager.php | 16 +++++++++++++++- lib/private/Server.php | 2 +- .../ICloudFederationProviderManager.php | 9 +++++++++ 3 files changed, 25 insertions(+), 2 deletions(-) diff --git a/lib/private/Federation/CloudFederationProviderManager.php b/lib/private/Federation/CloudFederationProviderManager.php index 925d42a688..73e1dd99c6 100644 --- a/lib/private/Federation/CloudFederationProviderManager.php +++ b/lib/private/Federation/CloudFederationProviderManager.php @@ -22,6 +22,7 @@ namespace OC\Federation; +use OCP\App\IAppManager; use OCP\Federation\Exceptions\ProviderAlreadyExistsException; use OCP\Federation\Exceptions\ProviderDoesNotExistsException; use OCP\Federation\ICloudFederationNotification; @@ -41,8 +42,12 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager /** @var array list of available cloud federation providers */ private $cloudFederationProvider; - public function __construct() { + /** @var IAppManager */ + private $appManager; + + public function __construct(IAppManager $appManager) { $this->cloudFederationProvider= []; + $this->appManager = $appManager; } @@ -105,4 +110,13 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager // TODO: Implement sendNotification() method. } + /** + * check if the new cloud federation API is ready to be used + * + * @return bool + */ + public function isReady() { + return $this->appManager->isEnabledForUser('cloud_federation_api', false); + } + } diff --git a/lib/private/Server.php b/lib/private/Server.php index 170bc6b258..7156c8a2c2 100644 --- a/lib/private/Server.php +++ b/lib/private/Server.php @@ -1117,7 +1117,7 @@ class Server extends ServerContainer implements IServerContainer { }); $this->registerService(ICloudFederationProviderManager::class, function (Server $c) { - return new CloudFederationProviderManager(); + return new CloudFederationProviderManager($c->getAppManager()); }); $this->registerService(ICloudFederationFactory::class, function (Server $c) { diff --git a/lib/public/Federation/ICloudFederationProviderManager.php b/lib/public/Federation/ICloudFederationProviderManager.php index c978994924..81558c631f 100644 --- a/lib/public/Federation/ICloudFederationProviderManager.php +++ b/lib/public/Federation/ICloudFederationProviderManager.php @@ -93,5 +93,14 @@ interface ICloudFederationProviderManager { */ public function sendNotification(ICloudFederationNotification $notification); + /** + * check if the new cloud federation API is ready to be used + * + * @return bool + * + * @since 14.0.0 + */ + public function isReady(); + } From a3948e8a126d6f84629841c8886fe0819ab04ad5 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Fri, 4 May 2018 15:25:02 +0200 Subject: [PATCH 05/39] use new API to send a federated share if possible Signed-off-by: Bjoern Schiessle --- .../Controller/RequestHandlerController.php | 14 ++- .../lib/AppInfo/Application.php | 8 +- .../lib/BackgroundJob/RetryJob.php | 4 +- .../lib/Notifications.php | 88 ++++++++++++++++++- .../lib/ocm/CloudFederationProviderFiles.php | 10 +-- .../CloudFederationProviderManager.php | 73 ++++++++++++++- .../Federation/CloudFederationShare.php | 6 +- lib/private/Server.php | 2 +- lib/private/Share20/ProviderFactory.php | 4 +- .../Federation/ICloudFederationProvider.php | 7 -- .../Federation/ICloudFederationShare.php | 4 +- 11 files changed, 185 insertions(+), 35 deletions(-) diff --git a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php index d551f464c2..4f16c369a2 100644 --- a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php +++ b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php @@ -32,6 +32,7 @@ use OCP\Federation\Exceptions\ShareNotFoundException; use OCP\Federation\ICloudFederationFactory; use OCP\Federation\ICloudFederationProviderManager; use OCP\Federation\Exceptions\ProviderDoesNotExistsException; +use OCP\Federation\ICloudIdManager; use OCP\ILogger; use OCP\IRequest; use OCP\IURLGenerator; @@ -65,6 +66,9 @@ class RequestHandlerController extends Controller { /** @var ICloudFederationFactory */ private $factory; + /** @var ICloudIdManager */ + private $cloudIdManager; + public function __construct($appName, IRequest $request, ILogger $logger, @@ -72,7 +76,8 @@ class RequestHandlerController extends Controller { IURLGenerator $urlGenerator, ICloudFederationProviderManager $cloudFederationProviderManager, Config $config, - ICloudFederationFactory $factory + ICloudFederationFactory $factory, + ICloudIdManager $cloudIdManager ) { parent::__construct($appName, $request); @@ -82,6 +87,7 @@ class RequestHandlerController extends Controller { $this->cloudFederationProviderManager = $cloudFederationProviderManager; $this->config = $config; $this->factory = $factory; + $this->cloudIdManager = $cloudIdManager; } /** @@ -104,7 +110,7 @@ class RequestHandlerController extends Controller { * @param $resourceType ('file', 'calendar',...) * @return Http\DataResponse|JSONResponse * - * Example: curl -H "Content-Type: application/json" -X POST -d '{"shareWith":"admin1","name":"welcome server2.txt","description":"desc","providerId":"2","owner":"admin2@http://localhost/server2","ownerDisplayName":"admin2 display","shareType":"user","resourceType":"file","protocol":{"name":"webdav","options":{"access_token":"8Lrd1FVEREthux7","permissions":31}}}' http://localhost/server/index.php/ocm/shares + * 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":{"access_token":"8Lrd1FVEREthux7","permissions":31}}}' http://localhost/server/index.php/ocm/shares */ public function addShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) { @@ -133,7 +139,9 @@ class RequestHandlerController extends Controller { ); } - $shareWith = $this->mapUid($shareWith); + $cloudId = $this->cloudIdManager->resolveCloudId($shareWith); + $shareWithLocalId = $cloudId->getUser(); + $shareWith = $this->mapUid($shareWithLocalId); if (!$this->userManager->userExists($shareWith)) { return new JSONResponse( diff --git a/apps/federatedfilesharing/lib/AppInfo/Application.php b/apps/federatedfilesharing/lib/AppInfo/Application.php index 655c01cf85..0b61e0a0b0 100644 --- a/apps/federatedfilesharing/lib/AppInfo/Application.php +++ b/apps/federatedfilesharing/lib/AppInfo/Application.php @@ -76,7 +76,9 @@ class Application extends App { $addressHandler, $server->getHTTPClientService(), $server->query(\OCP\OCS\IDiscoveryService::class), - \OC::$server->getJobList() + \OC::$server->getJobList(), + \OC::$server->getCloudFederationProviderManager(), + \OC::$server->getCloudFederationFactory() ); return new RequestHandlerController( $c->query('AppName'), @@ -121,7 +123,9 @@ class Application extends App { $addressHandler, \OC::$server->getHTTPClientService(), \OC::$server->query(\OCP\OCS\IDiscoveryService::class), - \OC::$server->getJobList() + \OC::$server->getJobList(), + \OC::$server->getCloudFederationProviderManager(), + \OC::$server->getCloudFederationFactory() ); $tokenHandler = new \OCA\FederatedFileSharing\TokenHandler( \OC::$server->getSecureRandom() diff --git a/apps/federatedfilesharing/lib/BackgroundJob/RetryJob.php b/apps/federatedfilesharing/lib/BackgroundJob/RetryJob.php index de2edfe60f..e3d7028ef6 100644 --- a/apps/federatedfilesharing/lib/BackgroundJob/RetryJob.php +++ b/apps/federatedfilesharing/lib/BackgroundJob/RetryJob.php @@ -75,7 +75,9 @@ class RetryJob extends Job { $addressHandler, \OC::$server->getHTTPClientService(), \OC::$server->query(\OCP\OCS\IDiscoveryService::class), - \OC::$server->getJobList() + \OC::$server->getJobList(), + \OC::$server->getCloudFederationProviderManager(), + \OC::$server->getCloudFederationFactory() ); } diff --git a/apps/federatedfilesharing/lib/Notifications.php b/apps/federatedfilesharing/lib/Notifications.php index 6f3f699e5c..65151e3413 100644 --- a/apps/federatedfilesharing/lib/Notifications.php +++ b/apps/federatedfilesharing/lib/Notifications.php @@ -27,6 +27,8 @@ namespace OCA\FederatedFileSharing; use OCP\AppFramework\Http; use OCP\BackgroundJob\IJobList; +use OCP\Federation\ICloudFederationFactory; +use OCP\Federation\ICloudFederationProviderManager; use OCP\Http\Client\IClientService; use OCP\OCS\IDiscoveryService; @@ -45,22 +47,34 @@ class Notifications { /** @var IJobList */ private $jobList; + /** @var ICloudFederationProviderManager */ + private $federationProviderManager; + + /** @var ICloudFederationFactory */ + private $cloudFederationFactory; + /** * @param AddressHandler $addressHandler * @param IClientService $httpClientService * @param IDiscoveryService $discoveryService * @param IJobList $jobList + * @param ICloudFederationProviderManager $federationProviderManager + * @param ICloudFederationFactory $cloudFederationFactory */ public function __construct( AddressHandler $addressHandler, IClientService $httpClientService, IDiscoveryService $discoveryService, - IJobList $jobList + IJobList $jobList, + ICloudFederationProviderManager $federationProviderManager, + ICloudFederationFactory $cloudFederationFactory ) { $this->addressHandler = $addressHandler; $this->httpClientService = $httpClientService; $this->discoveryService = $discoveryService; $this->jobList = $jobList; + $this->federationProviderManager = $federationProviderManager; + $this->cloudFederationFactory = $cloudFederationFactory; } /** @@ -100,7 +114,10 @@ class Notifications { $result = $this->tryHttpPostToShareEndpoint($remote, '', $fields); $status = json_decode($result['result'], true); - if ($result['success'] && ($status['ocs']['meta']['statuscode'] === 100 || $status['ocs']['meta']['statuscode'] === 200)) { + $ocsStatus = isset($status['ocs']); + $ocsSuccess = $ocsStatus && ($status['ocs']['meta']['statuscode'] === 100 || $status['ocs']['meta']['statuscode'] === 200); + + if ($result['success'] && (!$ocsStatus ||$ocsSuccess)) { \OC_Hook::emit('OCP\Share', 'federated_share_added', ['server' => $remote]); return true; } @@ -271,11 +288,11 @@ class Notifications { * @param string $remoteDomain * @param string $urlSuffix * @param array $fields post parameters + * @param string $action define the action (possible values: share, reshare, accept, decline, unshare, revoke, permissions) * @return array * @throws \Exception */ - protected function tryHttpPostToShareEndpoint($remoteDomain, $urlSuffix, array $fields) { - $client = $this->httpClientService->newClient(); + protected function tryHttpPostToShareEndpoint($remoteDomain, $urlSuffix, array $fields, $action="share") { if ($this->addressHandler->urlContainProtocol($remoteDomain) === false) { $remoteDomain = 'https://' . $remoteDomain; @@ -286,6 +303,15 @@ class Notifications { 'result' => '', ]; + // if possible we use the new OCM API + $ocmResult = $this->tryOCMEndPoint($remoteDomain, $fields, $action); + if ($ocmResult) { + $result['success'] = true; + return $result; + } + + // Fall back to old API + $client = $this->httpClientService->newClient(); $federationEndpoints = $this->discoveryService->discover($remoteDomain, 'FEDERATED_SHARING'); $endpoint = isset($federationEndpoints['share']) ? $federationEndpoints['share'] : '/ocs/v2.php/cloud/shares'; try { @@ -307,4 +333,58 @@ class Notifications { return $result; } + + /** + * check if server supports the new OCM api and ask for the correct end-point + * + * @param string $url + * @return string + */ + protected function getOCMEndPoint($url) { + $client = $this->httpClientService->newClient(); + try { + $response = $client->get($url, ['timeout' => 10, 'connect_timeout' => 10]); + } catch (\Exception $e) { + return ''; + } + + $result = $response->getBody(); + $result = json_decode($result, true); + + if (isset($result['end-point'])) { + return $result['end-point']; + } + + return ''; + } + + /** + * send action regarding federated sharing to the remote server using the OCM API + * + * @param $remoteDomain + * @param $fields + * @param $action + * + * @return bool + */ + protected function tryOCMEndPoint($remoteDomain, $fields, $action) { + switch ($action) { + case 'share': + $share = $this->cloudFederationFactory->getCloudFederationShare( + $fields['shareWith'] . '@' . $remoteDomain, + $fields['name'], + '', + $fields['remoteId'], + $fields['ownerFederatedId'], + $fields['owner'], + $fields['sharedByFederatedId'], + $fields['sharedBy'], + ['name' => 'webdav', 'options' => ['access_token' => $fields['token'], 'permissions' => ['read', 'write', 'share']]], + 'user', + 'file' + ); + return $this->federationProviderManager->sendShare($share); + } + + } } diff --git a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php index f05f446914..dea4c3f5fc 100644 --- a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php +++ b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php @@ -108,15 +108,6 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { return 'file'; } - /** - * send new share to another server - * - * @since 14.0.0 - */ - public function sendShare() { - // TODO: Implement sendShare() method. - } - /** * share received from another server * @@ -186,6 +177,7 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { \OC::$server->getHTTPClientService(), \OC::$server->getNotificationManager(), \OC::$server->query(\OCP\OCS\IDiscoveryService::class), + \OC::$server->getCloudFederationProviderManager(), $shareWith ); diff --git a/lib/private/Federation/CloudFederationProviderManager.php b/lib/private/Federation/CloudFederationProviderManager.php index 73e1dd99c6..dcf666ca26 100644 --- a/lib/private/Federation/CloudFederationProviderManager.php +++ b/lib/private/Federation/CloudFederationProviderManager.php @@ -29,6 +29,8 @@ use OCP\Federation\ICloudFederationNotification; use OCP\Federation\ICloudFederationProvider; use OCP\Federation\ICloudFederationProviderManager; use OCP\Federation\ICloudFederationShare; +use OCP\Federation\ICloudIdManager; +use OCP\Http\Client\IClientService; /** * Class Manager @@ -45,9 +47,26 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager /** @var IAppManager */ private $appManager; - public function __construct(IAppManager $appManager) { + /** @var IClientService */ + private $httpClientService; + + /** @var ICloudIdManager */ + private $cloudIdManager; + + /** + * CloudFederationProviderManager constructor. + * + * @param IAppManager $appManager + * @param IClientService $httpClientService + * @param ICloudIdManager $cloudIdManager + */ + public function __construct(IAppManager $appManager, + IClientService $httpClientService, + ICloudIdManager $cloudIdManager) { $this->cloudFederationProvider= []; $this->appManager = $appManager; + $this->httpClientService = $httpClientService; + $this->cloudIdManager = $cloudIdManager; } @@ -103,7 +122,32 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager } public function sendShare(ICloudFederationShare $share) { - // TODO: Implement sendShare() method. + $ocmEndPoint = $this->getOCMEndPoint($share->getShareWith()); + + if (empty($ocmEndPoint)) { + return false; + } + + $client = $this->httpClientService->newClient(); + try { + $response = $client->post($ocmEndPoint . '/shares', [ + 'body' => $share->getShare(), + 'timeout' => 10, + 'connect_timeout' => 10, + ]); + $result['result'] = $response->getBody(); + $result['success'] = true; + } catch (\Exception $e) { + // if flat re-sharing is not supported by the remote server + // we re-throw the exception and fall back to the old behaviour. + // (flat re-shares has been introduced in Nextcloud 9.1) + if ($e->getCode() === Http::STATUS_INTERNAL_SERVER_ERROR) { + throw $e; + } + } + + return true; + } public function sendNotification(ICloudFederationNotification $notification) { @@ -118,5 +162,30 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager public function isReady() { return $this->appManager->isEnabledForUser('cloud_federation_api', false); } + /** + * check if server supports the new OCM api and ask for the correct end-point + * + * @param string $recipient full federated cloud ID of the recipient of a share + * @return string + */ + protected function getOCMEndPoint($recipient) { + $cloudId = $this->cloudIdManager->resolveCloudId($recipient); + $client = $this->httpClientService->newClient(); + try { + $response = $client->get($cloudId->getRemote() . '/ocm-provider/', ['timeout' => 10, 'connect_timeout' => 10]); + } catch (\Exception $e) { + return ''; + } + + $result = $response->getBody(); + $result = json_decode($result, true); + + if (isset($result['end-point'])) { + return $result['end-point']; + } + + return ''; + } + } diff --git a/lib/private/Federation/CloudFederationShare.php b/lib/private/Federation/CloudFederationShare.php index 4622dc096d..5bc172ab6b 100644 --- a/lib/private/Federation/CloudFederationShare.php +++ b/lib/private/Federation/CloudFederationShare.php @@ -203,14 +203,14 @@ class CloudFederationShare implements ICloudFederationShare { } /** - * get JSON encoded share, ready to send out + * get the whole share, ready to send out * - * @return string + * @return array * * @since 14.0.0 */ public function getShare() { - return json_encode($this->share); + return $this->share; } /** diff --git a/lib/private/Server.php b/lib/private/Server.php index 7156c8a2c2..8f1b24eb11 100644 --- a/lib/private/Server.php +++ b/lib/private/Server.php @@ -1117,7 +1117,7 @@ class Server extends ServerContainer implements IServerContainer { }); $this->registerService(ICloudFederationProviderManager::class, function (Server $c) { - return new CloudFederationProviderManager($c->getAppManager()); + return new CloudFederationProviderManager($c->getAppManager(), $c->getHTTPClientService(), $c->getCloudIdManager()); }); $this->registerService(ICloudFederationFactory::class, function (Server $c) { diff --git a/lib/private/Share20/ProviderFactory.php b/lib/private/Share20/ProviderFactory.php index 456b6dbc59..7d866db24f 100644 --- a/lib/private/Share20/ProviderFactory.php +++ b/lib/private/Share20/ProviderFactory.php @@ -116,7 +116,9 @@ class ProviderFactory implements IProviderFactory { $addressHandler, $this->serverContainer->getHTTPClientService(), $this->serverContainer->query(\OCP\OCS\IDiscoveryService::class), - $this->serverContainer->getJobList() + $this->serverContainer->getJobList(), + \OC::$server->getCloudFederationProviderManager(), + \OC::$server->getCloudFederationFactory() ); $tokenHandler = new TokenHandler( $this->serverContainer->getSecureRandom() diff --git a/lib/public/Federation/ICloudFederationProvider.php b/lib/public/Federation/ICloudFederationProvider.php index 535f61aae8..38a551000f 100644 --- a/lib/public/Federation/ICloudFederationProvider.php +++ b/lib/public/Federation/ICloudFederationProvider.php @@ -45,13 +45,6 @@ interface ICloudFederationProvider { */ public function getShareType(); - /** - * send new share to another server - * - * @since 14.0.0 - */ - public function sendShare(); - /** * share received from another server * diff --git a/lib/public/Federation/ICloudFederationShare.php b/lib/public/Federation/ICloudFederationShare.php index b116da0fb5..ce5065c70b 100644 --- a/lib/public/Federation/ICloudFederationShare.php +++ b/lib/public/Federation/ICloudFederationShare.php @@ -123,9 +123,9 @@ interface ICloudFederationShare { public function setShareType($shareType); /** - * get JSON encoded share, ready to send out + * get the whole share, ready to send out * - * @return string + * @return array * * @since 14.0.0 */ From db428ea5471a5be5517911b3bf2f3a6d3f86e297 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Wed, 9 May 2018 17:06:35 +0200 Subject: [PATCH 06/39] send accept share notification (WIP) Signed-off-by: Bjoern Schiessle --- .../Controller/RequestHandlerController.php | 23 +++++---- .../lib/ocm/CloudFederationProviderFiles.php | 20 ++++++-- .../files_sharing/lib/AppInfo/Application.php | 2 + apps/files_sharing/lib/External/Manager.php | 45 +++++++++++++++++ apps/files_sharing/lib/Hooks.php | 2 + .../CloudFederationNotification.php | 19 ++++--- .../CloudFederationProviderManager.php | 50 ++++++++++++++++--- lib/private/Server.php | 2 +- .../ActionNotSupportedException.php | 39 +++++++++++++++ .../ICloudFederationNotification.php | 9 ++-- .../Federation/ICloudFederationProvider.php | 8 +-- .../ICloudFederationProviderManager.php | 5 +- 12 files changed, 186 insertions(+), 38 deletions(-) create mode 100644 lib/public/Federation/Exceptions/ActionNotSupportedException.php diff --git a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php index 4f16c369a2..319380ec3c 100644 --- a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php +++ b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php @@ -27,6 +27,7 @@ use OCA\CloudFederationAPI\Config; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; use OCP\AppFramework\Http\JSONResponse; +use OCP\Federation\Exceptions\ActionNotSupportedException; use OCP\Federation\Exceptions\ProviderCouldNotAddShareException; use OCP\Federation\Exceptions\ShareNotFoundException; use OCP\Federation\ICloudFederationFactory; @@ -190,13 +191,12 @@ class RequestHandlerController extends Controller { /** * receive notification about existing share * - * @param $resourceType ('file', 'calendar',...) - * @param string $name resource name (e.g "file", "calendar",...) - * @param string $id unique id of the corresponding item on the receiving site - * @param array $notification contain the actual notification, content is defined by cloud federation provider + * @param string $notificationType (notification type, e.g. SHARE_ACCEPTED) + * @param string $resourceType (calendar, file, contact,...) + * @param array $message contain the actual notification, content is defined by cloud federation provider * @return JSONResponse */ - public function receiveNotification($resourceType, $name, $id, $notification) { + public function receiveNotification($notificationType, $resourceType, $message) { if (!$this->config->incomingRequestsEnabled()) { return new JSONResponse( ['message' => 'This server doesn\'t support outgoing federated shares'], @@ -205,9 +205,9 @@ class RequestHandlerController extends Controller { } // check if all required parameters are set - if ($name === null || - $id === null || - !is_array($notification) + if ($notificationType === null || + $resourceType === null || + !is_array($message) ) { return new JSONResponse( ['message' => 'Missing arguments'], @@ -217,7 +217,7 @@ class RequestHandlerController extends Controller { try { $provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType); - $provider->notificationReceived($id, $notification); + $provider->notificationReceived($notificationType, $message); } catch (ProviderDoesNotExistsException $e) { return new JSONResponse( ['message' => $e->getMessage()], @@ -228,6 +228,11 @@ class RequestHandlerController extends Controller { ['message' => $e->getMessage()], Http::STATUS_BAD_REQUEST ); + } catch (ActionNotSupportedException $e) { + return new JSONResponse( + ['message' => $e->getMessage()], + Http::STATUS_NOT_IMPLEMENTED + ); } catch (\Exception $e) { return new JSONResponse( ['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()], diff --git a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php index dea4c3f5fc..6c5b63b1cd 100644 --- a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php +++ b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php @@ -27,7 +27,9 @@ use OCA\FederatedFileSharing\AddressHandler; use OCA\FederatedFileSharing\FederatedShareProvider; use OCP\Activity\IManager as IActivityManager; use OCP\App\IAppManager; +use OCP\Federation\Exceptions\ActionNotSupportedException; use OCP\Federation\Exceptions\ProviderCouldNotAddShareException; +use OCP\Federation\Exceptions\ShareNotFoundException; use OCP\Federation\ICloudFederationProvider; use OCP\Federation\ICloudFederationShare; use OCP\Federation\ICloudIdManager; @@ -178,6 +180,7 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { \OC::$server->getNotificationManager(), \OC::$server->query(\OCP\OCS\IDiscoveryService::class), \OC::$server->getCloudFederationProviderManager(), + \OC::$server->getCloudFederationFactory(), $shareWith ); @@ -230,15 +233,22 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { /** * notification received from another server * - * @param string $id unique ID of a already existing share - * @param array $notification provider specific notification + * @param string $notificationType (e.g. SHARE_ACCEPTED) + * @param array $message * - * @throws \OCP\Federation\Exceptions\ShareNotFoundException + * @throws ShareNotFoundException + * @throws ActionNotSupportedException * * @since 14.0.0 */ - public function notificationReceived($id, $notification) { - // TODO: Implement notificationReceived() method. + public function notificationReceived($notificationType, array $message) { + switch ($notificationType) { + case 'SHARE_ACCEPTED' : + return; + } + + + throw new ActionNotSupportedException($notificationType); } /** diff --git a/apps/files_sharing/lib/AppInfo/Application.php b/apps/files_sharing/lib/AppInfo/Application.php index e0c40730b3..e6ab4eb2cf 100644 --- a/apps/files_sharing/lib/AppInfo/Application.php +++ b/apps/files_sharing/lib/AppInfo/Application.php @@ -103,6 +103,8 @@ class Application extends App { $server->getHTTPClientService(), $server->getNotificationManager(), $server->query(\OCP\OCS\IDiscoveryService::class), + $server->getCloudFederationProviderManager(), + $server->getCloudFederationFactory(), $uid ); }); diff --git a/apps/files_sharing/lib/External/Manager.php b/apps/files_sharing/lib/External/Manager.php index c9303ac224..cb1e947f60 100644 --- a/apps/files_sharing/lib/External/Manager.php +++ b/apps/files_sharing/lib/External/Manager.php @@ -33,6 +33,8 @@ namespace OCA\Files_Sharing\External; use OC\Files\Filesystem; use OCA\Files_Sharing\Helper; +use OCP\Federation\ICloudFederationFactory; +use OCP\Federation\ICloudFederationProviderManager; use OCP\Files; use OCP\Files\Storage\IStorageFactory; use OCP\Http\Client\IClientService; @@ -79,6 +81,12 @@ class Manager { */ private $discoveryService; + /** @var ICloudFederationProviderManager */ + private $cloudFederationProviderManager; + + /** @var ICloudFederationFactory */ + private $cloudFederationFactory; + /** * @param IDBConnection $connection * @param \OC\Files\Mount\Manager $mountManager @@ -86,6 +94,8 @@ class Manager { * @param IClientService $clientService * @param IManager $notificationManager * @param IDiscoveryService $discoveryService + * @param ICloudFederationProviderManager $cloudFederationProviderManager + * @param ICloudFederationFactory $cloudFederationFactory * @param string $uid */ public function __construct(IDBConnection $connection, @@ -94,6 +104,8 @@ class Manager { IClientService $clientService, IManager $notificationManager, IDiscoveryService $discoveryService, + ICloudFederationProviderManager $cloudFederationProviderManager, + ICloudFederationFactory $cloudFederationFactory, $uid) { $this->connection = $connection; $this->mountManager = $mountManager; @@ -102,6 +114,8 @@ class Manager { $this->uid = $uid; $this->notificationManager = $notificationManager; $this->discoveryService = $discoveryService; + $this->cloudFederationProviderManager = $cloudFederationProviderManager; + $this->cloudFederationFactory = $cloudFederationFactory; } /** @@ -274,6 +288,12 @@ class Manager { */ private function sendFeedbackToRemote($remote, $token, $remoteId, $feedback) { + $result = $this->tryOCMEndPoint($remote, $token, $remoteId, $feedback); + + if($result === true) { + return true; + } + $federationEndpoints = $this->discoveryService->discover($remote, 'FEDERATED_SHARING'); $endpoint = isset($federationEndpoints['share']) ? $federationEndpoints['share'] : '/ocs/v2.php/cloud/shares'; @@ -299,6 +319,31 @@ class Manager { return ($status['ocs']['meta']['statuscode'] === 100 || $status['ocs']['meta']['statuscode'] === 200); } + /** + * try send accept message to ocm end-point + * + * @param string $remoteDomain + * @param string $token + * @param $remoteId + * @param string $feedback + * @return mixed + */ + protected function tryOCMEndPoint($remoteDomain, $token, $remoteId, $feedback) { + switch ($feedback) { + case 'accept': + $notification = $this->cloudFederationFactory->getCloudFederationNotification(); + $notification->setMessage('SHARE_ACCEPTED', 'file', + [ + 'id' => $remoteId, + 'access_token' => $token + ] + ); + return $this->cloudFederationProviderManager->sendNotification($remoteDomain, $notification); + } + + } + + /** * remove '/user/files' from the path and trailing slashes * diff --git a/apps/files_sharing/lib/Hooks.php b/apps/files_sharing/lib/Hooks.php index 51511ca6b6..cd66fd7702 100644 --- a/apps/files_sharing/lib/Hooks.php +++ b/apps/files_sharing/lib/Hooks.php @@ -40,6 +40,8 @@ class Hooks { \OC::$server->getHTTPClientService(), \OC::$server->getNotificationManager(), \OC::$server->query(\OCP\OCS\IDiscoveryService::class), + \OC::$server->getCloudFederationProviderManager(), + \OC::$server->getCloudFederationFactory(), $params['uid']); $manager->removeUserShares($params['uid']); diff --git a/lib/private/Federation/CloudFederationNotification.php b/lib/private/Federation/CloudFederationNotification.php index ed87b9b0e5..356c47968f 100644 --- a/lib/private/Federation/CloudFederationNotification.php +++ b/lib/private/Federation/CloudFederationNotification.php @@ -30,23 +30,28 @@ class CloudFederationNotification implements ICloudFederationNotification { /** * add a message to the notification * - * @param string $identifier - * @param string $message + * @param string $notificationType (e.g. SHARE_ACCEPTED) + * @param string $resourceType (e.g. file, calendar, contact,...) + * @param array $message * * @since 14.0.0 */ - public function setMessage($identifier, $message) { - $this->message[$identifier] = $message; + public function setMessage($notificationType, $resourceType, array $message) { + $this->message = [ + 'notificationType' => $notificationType, + 'resourceType' => $resourceType, + 'message' => $message, + ]; } /** - * get JSON encoded Message, ready to send out + * get message, ready to send out * - * @return string + * @return array * * @since 14.0.0 */ public function getMessage() { - return json_encode($this->message); + return $this->message; } } diff --git a/lib/private/Federation/CloudFederationProviderManager.php b/lib/private/Federation/CloudFederationProviderManager.php index dcf666ca26..c302659fb6 100644 --- a/lib/private/Federation/CloudFederationProviderManager.php +++ b/lib/private/Federation/CloudFederationProviderManager.php @@ -22,8 +22,8 @@ namespace OC\Federation; +use OC\AppFramework\Http; use OCP\App\IAppManager; -use OCP\Federation\Exceptions\ProviderAlreadyExistsException; use OCP\Federation\Exceptions\ProviderDoesNotExistsException; use OCP\Federation\ICloudFederationNotification; use OCP\Federation\ICloudFederationProvider; @@ -31,6 +31,7 @@ use OCP\Federation\ICloudFederationProviderManager; use OCP\Federation\ICloudFederationShare; use OCP\Federation\ICloudIdManager; use OCP\Http\Client\IClientService; +use OCP\ILogger; /** * Class Manager @@ -53,20 +54,26 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager /** @var ICloudIdManager */ private $cloudIdManager; + /** @var ILogger */ + private $logger; + /** * CloudFederationProviderManager constructor. * * @param IAppManager $appManager * @param IClientService $httpClientService * @param ICloudIdManager $cloudIdManager + * @param ILogger $logger */ public function __construct(IAppManager $appManager, IClientService $httpClientService, - ICloudIdManager $cloudIdManager) { + ICloudIdManager $cloudIdManager, + ILogger $logger) { $this->cloudFederationProvider= []; $this->appManager = $appManager; $this->httpClientService = $httpClientService; $this->cloudIdManager = $cloudIdManager; + $this->logger = $logger; } @@ -135,8 +142,11 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager 'timeout' => 10, 'connect_timeout' => 10, ]); - $result['result'] = $response->getBody(); - $result['success'] = true; + + if ($response->getStatusCode() === Http::STATUS_OK) { + return true; + } + } catch (\Exception $e) { // if flat re-sharing is not supported by the remote server // we re-throw the exception and fall back to the old behaviour. @@ -146,12 +156,38 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager } } - return true; + return false; } - public function sendNotification(ICloudFederationNotification $notification) { - // TODO: Implement sendNotification() method. + /** + * @param string $url + * @param ICloudFederationNotification $notification + * @return bool + */ + public function sendNotification($url, ICloudFederationNotification $notification) { + $ocmEndPoint = $this->getOCMEndPoint($url); + + if (empty($ocmEndPoint)) { + return false; + } + + $client = $this->httpClientService->newClient(); + try { + $response = $client->post($ocmEndPoint . '/notifications', [ + 'body' => $notification->getMessage(), + 'timeout' => 10, + 'connect_timeout' => 10, + ]); + if ($response->getStatusCode() === Http::STATUS_OK) { + return true; + } + } catch (\Exception $e) { + // log the error and return false + $this->logger->error('error while sending notification for federated share: ' . $e->getMessage()); + } + + return false; } /** diff --git a/lib/private/Server.php b/lib/private/Server.php index 8f1b24eb11..90e9e81c10 100644 --- a/lib/private/Server.php +++ b/lib/private/Server.php @@ -1117,7 +1117,7 @@ class Server extends ServerContainer implements IServerContainer { }); $this->registerService(ICloudFederationProviderManager::class, function (Server $c) { - return new CloudFederationProviderManager($c->getAppManager(), $c->getHTTPClientService(), $c->getCloudIdManager()); + return new CloudFederationProviderManager($c->getAppManager(), $c->getHTTPClientService(), $c->getCloudIdManager(), $c->getLogger()); }); $this->registerService(ICloudFederationFactory::class, function (Server $c) { diff --git a/lib/public/Federation/Exceptions/ActionNotSupportedException.php b/lib/public/Federation/Exceptions/ActionNotSupportedException.php new file mode 100644 index 0000000000..7e7fe70f48 --- /dev/null +++ b/lib/public/Federation/Exceptions/ActionNotSupportedException.php @@ -0,0 +1,39 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCP\Federation\Exceptions; + +use OC\HintException; + +class ActionNotSupportedException extends HintException { + + /** + * ActionNotSupportedException constructor. + * + */ + 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); + } + +} diff --git a/lib/public/Federation/ICloudFederationNotification.php b/lib/public/Federation/ICloudFederationNotification.php index 5db93ef0a8..dcdb5b73bd 100644 --- a/lib/public/Federation/ICloudFederationNotification.php +++ b/lib/public/Federation/ICloudFederationNotification.php @@ -26,15 +26,16 @@ interface ICloudFederationNotification { /** * add a message to the notification * - * @param string $identifier - * @param string $message + * @param string $notificationType (e.g. SHARE_ACCEPTED) + * @param string $resourceType (e.g. file, calendar, contact,...) + * @param array $message * * @since 14.0.0 */ - public function setMessage($identifier, $message); + public function setMessage($notificationType, $resourceType, array $message); /** - * get JSON encoded Message, ready to send out + * get message, ready to send out * * @return string * diff --git a/lib/public/Federation/ICloudFederationProvider.php b/lib/public/Federation/ICloudFederationProvider.php index 38a551000f..0d87d76ee5 100644 --- a/lib/public/Federation/ICloudFederationProvider.php +++ b/lib/public/Federation/ICloudFederationProvider.php @@ -21,6 +21,7 @@ namespace OCP\Federation; +use OCP\Federation\Exceptions\ActionNotSupportedException; use OCP\Federation\Exceptions\ProviderCouldNotAddShareException; use OCP\Federation\Exceptions\ShareNotFoundException; @@ -60,13 +61,14 @@ interface ICloudFederationProvider { /** * notification received from another server * - * @param string $id unique ID of a already existing share - * @param array $notification provider specific notification + * @param string $notificationType (e.g SHARE_ACCEPTED) + * @param array $message provider specific notification * * @throws ShareNotFoundException + * @throws ActionNotSupportedException * * @since 14.0.0 */ - public function notificationReceived($id, $notification); + public function notificationReceived($notificationType, array $message); } diff --git a/lib/public/Federation/ICloudFederationProviderManager.php b/lib/public/Federation/ICloudFederationProviderManager.php index 81558c631f..714c6234b7 100644 --- a/lib/public/Federation/ICloudFederationProviderManager.php +++ b/lib/public/Federation/ICloudFederationProviderManager.php @@ -86,12 +86,13 @@ interface ICloudFederationProviderManager { /** * send notification about existing share * + * @param string $url * @param ICloudFederationNotification $notification - * @return mixed + * @return bool * * @since 14.0.0 */ - public function sendNotification(ICloudFederationNotification $notification); + public function sendNotification($url, ICloudFederationNotification $notification); /** * check if the new cloud federation API is ready to be used From af178ef19a8ead9943efe9b13de8fd3ec96bf447 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Mon, 14 May 2018 12:37:10 +0200 Subject: [PATCH 07/39] check API Version Signed-off-by: Bjoern Schiessle --- lib/private/Federation/CloudFederationProviderManager.php | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lib/private/Federation/CloudFederationProviderManager.php b/lib/private/Federation/CloudFederationProviderManager.php index c302659fb6..b0f5c58f51 100644 --- a/lib/private/Federation/CloudFederationProviderManager.php +++ b/lib/private/Federation/CloudFederationProviderManager.php @@ -57,6 +57,8 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager /** @var ILogger */ private $logger; + private $supportedAPIVersion = '2.0-draft'; + /** * CloudFederationProviderManager constructor. * @@ -216,7 +218,9 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager $result = $response->getBody(); $result = json_decode($result, true); - if (isset($result['end-point'])) { + $supportedVersion = isset($result['api-version']) && $result['api-version'] === $this->supportedAPIVersion; + + if (isset($result['end-point']) && $supportedVersion) { return $result['end-point']; } From daba042d269bfd701c78e014c0ad7794975d2133 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Mon, 28 May 2018 12:28:08 +0200 Subject: [PATCH 08/39] update capabilities Signed-off-by: Bjoern Schiessle --- apps/cloud_federation_api/lib/Capabilities.php | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/apps/cloud_federation_api/lib/Capabilities.php b/apps/cloud_federation_api/lib/Capabilities.php index 17d3b2cfaf..15417f8522 100644 --- a/apps/cloud_federation_api/lib/Capabilities.php +++ b/apps/cloud_federation_api/lib/Capabilities.php @@ -46,8 +46,12 @@ class Capabilities implements ICapability { $capabilities = ['ocm' => [ 'enabled' => true, - 'api-version' => '2.0-draft', + 'api-version' => '1.0-proposal1', 'end-point' => substr($url, 0, strrpos($url, '/')), + 'share-types' => ['file'], + 'protocol' => [ + 'webdav' => '/public.php/webdav/', + ] ] ]; From bbce8c3ea1c73726f233961fe7bdb16b8a08bb67 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Mon, 28 May 2018 17:13:19 +0200 Subject: [PATCH 09/39] adjust to latest api version Signed-off-by: Bjoern Schiessle --- .../cloud_federation_api/lib/Capabilities.php | 6 ++-- .../Controller/RequestHandlerController.php | 31 +++++++++++-------- .../Controller/RequestHandlerController.php | 2 +- .../lib/Notifications.php | 2 +- .../lib/ocm/CloudFederationProviderFiles.php | 9 +++--- apps/files_sharing/lib/External/Manager.php | 12 ++++--- .../Federation/CloudFederationFactory.php | 8 ++--- .../CloudFederationNotification.php | 9 ++++-- .../CloudFederationProviderManager.php | 18 +++++------ .../Federation/CloudFederationShare.php | 28 +++++++++++++---- .../Federation/ICloudFederationFactory.php | 6 ++-- .../ICloudFederationNotification.php | 6 ++-- .../Federation/ICloudFederationProvider.php | 5 +-- .../Federation/ICloudFederationShare.php | 10 ++++++ 14 files changed, 97 insertions(+), 55 deletions(-) diff --git a/apps/cloud_federation_api/lib/Capabilities.php b/apps/cloud_federation_api/lib/Capabilities.php index 15417f8522..88b8c7b391 100644 --- a/apps/cloud_federation_api/lib/Capabilities.php +++ b/apps/cloud_federation_api/lib/Capabilities.php @@ -46,9 +46,9 @@ class Capabilities implements ICapability { $capabilities = ['ocm' => [ 'enabled' => true, - 'api-version' => '1.0-proposal1', - 'end-point' => substr($url, 0, strrpos($url, '/')), - 'share-types' => ['file'], + 'apiVersion' => '1.0-proposal1', + 'endPoint' => substr($url, 0, strrpos($url, '/')), + 'shareTypes' => ['file'], 'protocol' => [ 'webdav' => '/public.php/webdav/', ] diff --git a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php index 319380ec3c..5ec1496ce6 100644 --- a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php +++ b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php @@ -105,16 +105,16 @@ class RequestHandlerController extends Controller { * @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 $sharedByDisplayName display name of the user who shared the resource + * @param string $sharedByDisplayName display name of the user who shared the resource + * @param string $sharedSecret use to authenticate accross servers * @param array $protocol (e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]]) * @param string $shareType ('group' or 'user' share) * @param $resourceType ('file', 'calendar',...) * @return Http\DataResponse|JSONResponse * - * Example: curl -H "Content-Type: application/json" -X POST -d '{"shareWith":"admin1@serve1","name":"welcome server2.txt","description":"desc","providerId":"2","owner":"admin2@http://localhost/server2","ownerDisplayName":"admin2 display","shareType":"user","resourceType":"file","protocol":{"name":"webdav","options":{"access_token":"8Lrd1FVEREthux7","permissions":31}}}' http://localhost/server/index.php/ocm/shares + * Example: curl -H "Content-Type: application/json" -X POST -d '{"shareWith":"admin1@serve1","name":"welcome server2.txt","description":"desc","providerId":"2","owner":"admin2@http://localhost/server2","ownerDisplayName":"admin2 display","shareType":"user","resourceType":"file","protocol":{"name":"webdav","options":{"sharedSecret":"secret","permissions":"webdav-property"}}}' http://localhost/server/index.php/ocm/shares */ public function addShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) { - if (!$this->config->incomingRequestsEnabled()) { return new JSONResponse( ['message' => 'This server doesn\'t support outgoing federated shares'], @@ -132,7 +132,8 @@ class RequestHandlerController extends Controller { !is_array($protocol) || !isset($protocol['name']) || !isset ($protocol['options']) || - !is_array($protocol['options']) + !is_array($protocol['options']) || + !isset($protocol['options']['sharedSecret']) ) { return new JSONResponse( ['message' => 'Missing arguments'], @@ -163,7 +164,8 @@ class RequestHandlerController extends Controller { try { $provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType); - $share = $this->factory->getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $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( @@ -191,12 +193,17 @@ class RequestHandlerController extends Controller { /** * 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 array $message contain the actual notification, content is defined by cloud federation provider + * @param string $providerId id of the share + * @param array $notification the actual payload of the notification * @return JSONResponse */ - public function receiveNotification($notificationType, $resourceType, $message) { + public function receiveNotification($notificationType, $resourceType, $providerId, array $notification) { if (!$this->config->incomingRequestsEnabled()) { return new JSONResponse( ['message' => 'This server doesn\'t support outgoing federated shares'], @@ -207,7 +214,8 @@ class RequestHandlerController extends Controller { // check if all required parameters are set if ($notificationType === null || $resourceType === null || - !is_array($message) + $providerId === null || + !is_array($notification) ) { return new JSONResponse( ['message' => 'Missing arguments'], @@ -217,7 +225,7 @@ class RequestHandlerController extends Controller { try { $provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType); - $provider->notificationReceived($notificationType, $message); + $provider->notificationReceived($notificationType, $providerId, $notification); } catch (ProviderDoesNotExistsException $e) { return new JSONResponse( ['message' => $e->getMessage()], @@ -241,10 +249,7 @@ class RequestHandlerController extends Controller { } - return new JSONResponse( - ['id' => $id, 'createdAt' => date()], - Http::STATUS_CREATED); - + return new JSONResponse([],Http::STATUS_CREATED); } diff --git a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php index 2d0a3c528f..e2cc050d87 100644 --- a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php +++ b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php @@ -170,7 +170,7 @@ class RequestHandlerController extends OCSController { $owner, $sharedByFederatedId, $sharedBy, - ['name' => 'webdav', 'options' => ['access_token' => $token]], + $token, 'user', 'file' ); diff --git a/apps/federatedfilesharing/lib/Notifications.php b/apps/federatedfilesharing/lib/Notifications.php index 65151e3413..e0f8735f90 100644 --- a/apps/federatedfilesharing/lib/Notifications.php +++ b/apps/federatedfilesharing/lib/Notifications.php @@ -379,7 +379,7 @@ class Notifications { $fields['owner'], $fields['sharedByFederatedId'], $fields['sharedBy'], - ['name' => 'webdav', 'options' => ['access_token' => $fields['token'], 'permissions' => ['read', 'write', 'share']]], + $fields['token'], 'user', 'file' ); diff --git a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php index 6c5b63b1cd..e7f6f1b919 100644 --- a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php +++ b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php @@ -135,7 +135,7 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { list($ownerUid, $remote) = $this->addressHandler->splitUserRemote($share->getOwner()); $remote = $remote; - $token = isset($protocol['options']['access_token']) ? $protocol['options']['access_token'] : null; + $token = $share->getShareSecret(); $name = $share->getResourceName(); $owner = $share->getOwnerDisplayName(); $sharedBy = $share->getSharedByDisplayName(); @@ -234,21 +234,22 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { * notification received from another server * * @param string $notificationType (e.g. SHARE_ACCEPTED) - * @param array $message + * @param string $providerId id of the share + * @param array $notification payload of the notification * * @throws ShareNotFoundException * @throws ActionNotSupportedException * * @since 14.0.0 */ - public function notificationReceived($notificationType, array $message) { + public function notificationReceived($notificationType, $providerId, array $notification) { switch ($notificationType) { case 'SHARE_ACCEPTED' : return; } - throw new ActionNotSupportedException($notificationType); + throw new ActionNotSupportedException($notification); } /** diff --git a/apps/files_sharing/lib/External/Manager.php b/apps/files_sharing/lib/External/Manager.php index cb1e947f60..0bbbbea767 100644 --- a/apps/files_sharing/lib/External/Manager.php +++ b/apps/files_sharing/lib/External/Manager.php @@ -324,7 +324,7 @@ class Manager { * * @param string $remoteDomain * @param string $token - * @param $remoteId + * @param $remoteId id of the share * @param string $feedback * @return mixed */ @@ -332,11 +332,15 @@ class Manager { switch ($feedback) { case 'accept': $notification = $this->cloudFederationFactory->getCloudFederationNotification(); - $notification->setMessage('SHARE_ACCEPTED', 'file', + $notification->setMessage( + 'SHARE_ACCEPTED', + 'file', + $remoteId, [ - 'id' => $remoteId, - 'access_token' => $token + 'sharedSecret' => $token, + 'message' => 'Recipient accept the share' ] + ); return $this->cloudFederationProviderManager->sendNotification($remoteDomain, $notification); } diff --git a/lib/private/Federation/CloudFederationFactory.php b/lib/private/Federation/CloudFederationFactory.php index 4f42eb50bc..11566dd44a 100644 --- a/lib/private/Federation/CloudFederationFactory.php +++ b/lib/private/Federation/CloudFederationFactory.php @@ -37,16 +37,16 @@ class CloudFederationFactory implements ICloudFederationFactory { * @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 $sharedByDisplayName display name of the user who shared the resource - * @param array $protocol (e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]]) + * @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, $protocol, $shareType, $resourceType) { - return new CloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType); + public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $sharedSecret, $shareType, $resourceType) { + return new CloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $shareType, $resourceType, $sharedSecret); } /** diff --git a/lib/private/Federation/CloudFederationNotification.php b/lib/private/Federation/CloudFederationNotification.php index 356c47968f..fec69174a2 100644 --- a/lib/private/Federation/CloudFederationNotification.php +++ b/lib/private/Federation/CloudFederationNotification.php @@ -32,16 +32,19 @@ class CloudFederationNotification implements ICloudFederationNotification { * * @param string $notificationType (e.g. SHARE_ACCEPTED) * @param string $resourceType (e.g. file, calendar, contact,...) - * @param array $message + * @param string $providerId id of the share + * @param array $notification payload of the notification * * @since 14.0.0 */ - public function setMessage($notificationType, $resourceType, array $message) { + public function setMessage($notificationType, $resourceType, $providerId, array $notification) { $this->message = [ 'notificationType' => $notificationType, 'resourceType' => $resourceType, - 'message' => $message, + 'providerId' => $providerId, + 'notification' => $notification, ]; + } /** diff --git a/lib/private/Federation/CloudFederationProviderManager.php b/lib/private/Federation/CloudFederationProviderManager.php index b0f5c58f51..77866795c3 100644 --- a/lib/private/Federation/CloudFederationProviderManager.php +++ b/lib/private/Federation/CloudFederationProviderManager.php @@ -57,7 +57,7 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager /** @var ILogger */ private $logger; - private $supportedAPIVersion = '2.0-draft'; + private $supportedAPIVersion = '1.0-proposal1'; /** * CloudFederationProviderManager constructor. @@ -131,7 +131,8 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager } public function sendShare(ICloudFederationShare $share) { - $ocmEndPoint = $this->getOCMEndPoint($share->getShareWith()); + $cloudID = $this->cloudIdManager->resolveCloudId($share->getShareWith()); + $ocmEndPoint = $this->getOCMEndPoint($cloudID->getRemote()); if (empty($ocmEndPoint)) { return false; @@ -203,14 +204,13 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager /** * check if server supports the new OCM api and ask for the correct end-point * - * @param string $recipient full federated cloud ID of the recipient of a share + * @param string $url full base URL of the cloud server * @return string */ - protected function getOCMEndPoint($recipient) { - $cloudId = $this->cloudIdManager->resolveCloudId($recipient); + protected function getOCMEndPoint($url) { $client = $this->httpClientService->newClient(); try { - $response = $client->get($cloudId->getRemote() . '/ocm-provider/', ['timeout' => 10, 'connect_timeout' => 10]); + $response = $client->get($url . '/ocm-provider/', ['timeout' => 10, 'connect_timeout' => 10]); } catch (\Exception $e) { return ''; } @@ -218,10 +218,10 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager $result = $response->getBody(); $result = json_decode($result, true); - $supportedVersion = isset($result['api-version']) && $result['api-version'] === $this->supportedAPIVersion; + $supportedVersion = isset($result['apiVersion']) && $result['apiVersion'] === $this->supportedAPIVersion; - if (isset($result['end-point']) && $supportedVersion) { - return $result['end-point']; + if (isset($result['endPoint']) && $supportedVersion) { + return $result['endPoint']; } return ''; diff --git a/lib/private/Federation/CloudFederationShare.php b/lib/private/Federation/CloudFederationShare.php index 5bc172ab6b..d26073be82 100644 --- a/lib/private/Federation/CloudFederationShare.php +++ b/lib/private/Federation/CloudFederationShare.php @@ -50,10 +50,9 @@ class CloudFederationShare implements ICloudFederationShare { * @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',...) - * + * @param string $resourceType ('file', 'calendar',...) + * @param string $sharedSecret */ public function __construct($shareWith = '', $name = '', @@ -63,9 +62,9 @@ class CloudFederationShare implements ICloudFederationShare { $ownerDisplayName = '', $sharedBy = '', $sharedByDisplayName = '', - $protocol = [], $shareType = '', - $resourceType = '' + $resourceType = '', + $sharedSecret = '' ) { $this->setShareWith($shareWith); $this->setResourceName($name); @@ -75,7 +74,13 @@ class CloudFederationShare implements ICloudFederationShare { $this->setOwnerDisplayName($ownerDisplayName); $this->setSharedBy($sharedBy); $this->setSharedByDisplayName($sharedByDisplayName); - $this->setProtocol($protocol); + $this->setProtocol([ + 'name' => 'webdav', + 'options' => [ + 'sharedSecret' => $sharedSecret, + 'permissions' => '{http://open-collaboration-services.org/ns}share-permissions' + ] + ]); $this->setShareType($shareType); $this->setResourceType($resourceType); @@ -323,6 +328,17 @@ class CloudFederationShare implements ICloudFederationShare { return $this->share['shareType']; } + /** + * get share Secret + * + * @return string + * + * @since 14.0.0 + */ + public function getShareSecret() { + return $this->share['protocol']['options']['sharedSecret']; + } + /** * get protocol specification * diff --git a/lib/public/Federation/ICloudFederationFactory.php b/lib/public/Federation/ICloudFederationFactory.php index e33608bcab..8c6925c2b6 100644 --- a/lib/public/Federation/ICloudFederationFactory.php +++ b/lib/public/Federation/ICloudFederationFactory.php @@ -33,15 +33,15 @@ interface ICloudFederationFactory { * @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 $sharedByDisplayName display name of the user who shared the resource - * @param array $protocol (e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]]) + * @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, $protocol, $shareType, $resourceType); + public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $sharedSecret, $shareType, $resourceType); /** * get a Cloud FederationNotification object to prepare a notification you diff --git a/lib/public/Federation/ICloudFederationNotification.php b/lib/public/Federation/ICloudFederationNotification.php index dcdb5b73bd..c68cd7b5e4 100644 --- a/lib/public/Federation/ICloudFederationNotification.php +++ b/lib/public/Federation/ICloudFederationNotification.php @@ -28,11 +28,13 @@ interface ICloudFederationNotification { * * @param string $notificationType (e.g. SHARE_ACCEPTED) * @param string $resourceType (e.g. file, calendar, contact,...) - * @param array $message + * @param $providerId id of the share + * @param array $notification , payload of the notification * + * @return * @since 14.0.0 */ - public function setMessage($notificationType, $resourceType, array $message); + public function setMessage($notificationType, $resourceType, $providerId, array $notification); /** * get message, ready to send out diff --git a/lib/public/Federation/ICloudFederationProvider.php b/lib/public/Federation/ICloudFederationProvider.php index 0d87d76ee5..f11ed4fde3 100644 --- a/lib/public/Federation/ICloudFederationProvider.php +++ b/lib/public/Federation/ICloudFederationProvider.php @@ -62,13 +62,14 @@ interface ICloudFederationProvider { * notification received from another server * * @param string $notificationType (e.g SHARE_ACCEPTED) - * @param array $message provider specific notification + * @param string $providerId share ID + * @param array $notification provider specific notification * * @throws ShareNotFoundException * @throws ActionNotSupportedException * * @since 14.0.0 */ - public function notificationReceived($notificationType, array $message); + public function notificationReceived($notificationType, $providerId, array $notification); } diff --git a/lib/public/Federation/ICloudFederationShare.php b/lib/public/Federation/ICloudFederationShare.php index ce5065c70b..b721ffb168 100644 --- a/lib/public/Federation/ICloudFederationShare.php +++ b/lib/public/Federation/ICloudFederationShare.php @@ -221,6 +221,16 @@ interface ICloudFederationShare { */ public function getShareType(); + /** + * get share Secret + * + * @return string + * + * @since 14.0.0 + */ + public function getShareSecret(); + + /** * get protocol specification * From 8889e14c7cb848634895d8bbdedd13194c37301c Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Tue, 29 May 2018 16:21:13 +0200 Subject: [PATCH 10/39] implement accept share notification Signed-off-by: Bjoern Schiessle --- .../Controller/RequestHandlerController.php | 9 +- .../Controller/RequestHandlerController.php | 78 ++------- .../lib/FederatedShareProvider.php | 5 +- .../lib/ocm/CloudFederationProviderFiles.php | 157 +++++++++++++++++- .../AuthenticationFailedException.php | 40 +++++ .../Exceptions/BadRequestException.php | 66 ++++++++ .../Federation/ICloudFederationProvider.php | 4 + lib/public/Share/IShareProvider.php | 6 +- 8 files changed, 289 insertions(+), 76 deletions(-) create mode 100644 lib/public/Federation/Exceptions/AuthenticationFailedException.php create mode 100644 lib/public/Federation/Exceptions/BadRequestException.php diff --git a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php index 5ec1496ce6..4ee8344b6b 100644 --- a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php +++ b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php @@ -28,6 +28,8 @@ use OCP\AppFramework\Controller; use OCP\AppFramework\Http; use OCP\AppFramework\Http\JSONResponse; use OCP\Federation\Exceptions\ActionNotSupportedException; +use OCP\Federation\Exceptions\AuthenticationFailedException; +use OCP\Federation\Exceptions\BadRequestException; use OCP\Federation\Exceptions\ProviderCouldNotAddShareException; use OCP\Federation\Exceptions\ShareNotFoundException; use OCP\Federation\ICloudFederationFactory; @@ -241,7 +243,12 @@ class RequestHandlerController extends Controller { ['message' => $e->getMessage()], Http::STATUS_NOT_IMPLEMENTED ); - } catch (\Exception $e) { + } 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 diff --git a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php index e2cc050d87..628e306e99 100644 --- a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php +++ b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php @@ -42,6 +42,7 @@ use OCP\AppFramework\OCSController; use OCP\Constants; use OCP\Federation\Exceptions\ProviderCouldNotAddShareException; use OCP\Federation\Exceptions\ProviderDoesNotExistsException; +use OCP\Federation\Exceptions\ShareNotFoundException; use OCP\Federation\ICloudFederationFactory; use OCP\Federation\ICloudFederationProviderManager; use OCP\Federation\ICloudIdManager; @@ -265,47 +266,32 @@ class RequestHandlerController extends OCSController { * @param int $id * @return Http\DataResponse * @throws OCSException + * @throws Share\Exceptions\ShareNotFound + * @throws \OC\HintException */ public function acceptShare($id) { - if (!$this->isS2SEnabled()) { - throw new OCSException('Server does not support federated cloud sharing', 503); - } - $token = isset($_POST['token']) ? $_POST['token'] : null; - try { - $share = $this->federatedShareProvider->getShareById($id); - } catch (Share\Exceptions\ShareNotFound $e) { - return new Http\DataResponse(); - } + $notification = [ + 'sharedSecret' => $token, + 'message' => 'Recipient accept the share' + ]; - if ($this->verifyShare($share, $token)) { - $this->executeAcceptShare($share); - if ($share->getShareOwner() !== $share->getSharedBy()) { - list(, $remote) = $this->addressHandler->splitUserRemote($share->getSharedBy()); - $remoteId = $this->federatedShareProvider->getRemoteId($share); - $this->notifications->sendAcceptShare($remote, $remoteId, $share->getToken()); - } + 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 (ShareNotFoundException $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(); } - protected function executeAcceptShare(Share\IShare $share) { - $fileId = (int) $share->getNode()->getId(); - list($file, $link) = $this->getFile($this->getCorrectUid($share), $fileId); - - $event = \OC::$server->getActivityManager()->generateEvent(); - $event->setApp('files_sharing') - ->setType('remote_share') - ->setAffectedUser($this->getCorrectUid($share)) - ->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_ACCEPTED, [$share->getSharedWith(), [$fileId => $file]]) - ->setObject('files', $fileId, $file) - ->setLink($link); - \OC::$server->getActivityManager()->publish($event); - } - /** * @NoCSRFRequired * @PublicPage @@ -363,20 +349,6 @@ class RequestHandlerController extends OCSController { } - /** - * check if we are the initiator or the owner of a re-share and return the correct UID - * - * @param Share\IShare $share - * @return string - */ - protected function getCorrectUid(Share\IShare $share) { - if ($this->userManager->userExists($share->getShareOwner())) { - return $share->getShareOwner(); - } - - return $share->getSharedBy(); - } - /** * @NoCSRFRequired * @PublicPage @@ -548,24 +520,6 @@ class RequestHandlerController extends OCSController { return $result; } - /** - * check if we got the right share - * - * @param Share\IShare $share - * @param string $token - * @return bool - */ - protected function verifyShare(Share\IShare $share, $token) { - if ( - $share->getShareType() === FederatedShareProvider::SHARE_TYPE_REMOTE && - $share->getToken() === $token - ) { - return true; - } - - return false; - } - /** * @NoCSRFRequired * @PublicPage diff --git a/apps/federatedfilesharing/lib/FederatedShareProvider.php b/apps/federatedfilesharing/lib/FederatedShareProvider.php index ecc1e1710b..07597cae8e 100644 --- a/apps/federatedfilesharing/lib/FederatedShareProvider.php +++ b/apps/federatedfilesharing/lib/FederatedShareProvider.php @@ -30,6 +30,7 @@ namespace OCA\FederatedFileSharing; use OC\Share20\Share; +use OCP\Federation\Exceptions\ShareNotFoundException; use OCP\Federation\ICloudIdManager; use OCP\DB\QueryBuilder\IQueryBuilder; use OCP\Files\Folder; @@ -708,13 +709,13 @@ class FederatedShareProvider implements IShareProvider { $cursor->closeCursor(); if ($data === false) { - throw new ShareNotFound(); + throw new ShareNotFoundException(); } try { $share = $this->createShareObject($data); } catch (InvalidShare $e) { - throw new ShareNotFound(); + throw new ShareNotFoundException(); } return $share; diff --git a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php index e7f6f1b919..798b0bef3f 100644 --- a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php +++ b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php @@ -22,21 +22,29 @@ namespace OCA\FederatedFileSharing\OCM; use OC\AppFramework\Http; +use OC\Files\Filesystem; use OCA\Files_Sharing\Activity\Providers\RemoteShares; use OCA\FederatedFileSharing\AddressHandler; use OCA\FederatedFileSharing\FederatedShareProvider; use OCP\Activity\IManager as IActivityManager; +use OCP\Activity\IManager; use OCP\App\IAppManager; use OCP\Federation\Exceptions\ActionNotSupportedException; +use OCP\Federation\Exceptions\AuthenticationFailedException; +use OCP\Federation\Exceptions\BadRequestException; use OCP\Federation\Exceptions\ProviderCouldNotAddShareException; use OCP\Federation\Exceptions\ShareNotFoundException; use OCP\Federation\ICloudFederationProvider; use OCP\Federation\ICloudFederationShare; use OCP\Federation\ICloudIdManager; +use OCP\Files\NotFoundException; use OCP\ILogger; use OCP\IURLGenerator; use OCP\IUserManager; use OCP\Notification\IManager as INotificationManager; +use OCP\Share\Exceptions\ShareNotFound; +use OCP\Share\IShare; +use OCP\Util; class CloudFederationProviderFiles implements ICloudFederationProvider { @@ -153,13 +161,13 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { if ($remote && $token && $name && $owner && $remoteId && $shareWith) { - if (!\OCP\Util::isValidFileName($name)) { + if (!Util::isValidFileName($name)) { throw new ProviderCouldNotAddShareException('The mountpoint name contains invalid characters.', '', Http::STATUS_BAD_REQUEST); } // FIXME this should be a method in the user management instead $this->logger->debug('shareWith before, ' . $shareWith, ['app' => 'files_sharing']); - \OCP\Util::emitHook( + Util::emitHook( '\OCA\Files_Sharing\API\Server2Server', 'preLoginNameUsedAsUserName', array('uid' => &$shareWith) @@ -174,8 +182,8 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { $externalManager = new \OCA\Files_Sharing\External\Manager( \OC::$server->getDatabaseConnection(), - \OC\Files\Filesystem::getMountManager(), - \OC\Files\Filesystem::getLoader(), + Filesystem::getMountManager(), + Filesystem::getLoader(), \OC::$server->getHTTPClientService(), \OC::$server->getNotificationManager(), \OC::$server->query(\OCP\OCS\IDiscoveryService::class), @@ -219,7 +227,7 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { } catch (\Exception $e) { $this->logger->logException($e, [ 'message' => 'Server can not add remote share.', - 'level' => \OCP\Util::ERROR, + 'level' => Util::ERROR, 'app' => 'files_sharing' ]); throw new ProviderCouldNotAddShareException('internal server error, was not able to add share from ' . $remote, '', HTTP::STATUS_INTERNAL_SERVER_ERROR); @@ -237,14 +245,18 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { * @param string $providerId id of the share * @param array $notification payload of the notification * - * @throws ShareNotFoundException * @throws ActionNotSupportedException - * + * @throws AuthenticationFailedException + * @throws BadRequestException + * @throws ShareNotFoundException + * @throws \OC\HintException * @since 14.0.0 */ public function notificationReceived($notificationType, $providerId, array $notification) { + switch ($notificationType) { - case 'SHARE_ACCEPTED' : + case 'SHARE_ACCEPTED': + $this->shareAccepted($providerId, $notification); return; } @@ -252,6 +264,135 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { throw new ActionNotSupportedException($notification); } + /** + * @param $id + * @param $notification + * @return bool + * @throws ActionNotSupportedException + * @throws AuthenticationFailedException + * @throws BadRequestException + * @throws ShareNotFoundException + * @throws \OC\HintException + */ + private function shareAccepted($id, $notification) { + + if (!$this->isS2SEnabled(true)) { + throw new ActionNotSupportedException('Server does not support federated cloud sharing', '', Http::STATUS_SERVICE_UNAVAILABLE); + } + + if (!isset($notification['sharedSecret'])) { + throw new BadRequestException(['sharedSecret']); + } + + $token = $notification['sharedSecret']; + + $share = $this->federatedShareProvider->getShareById($id); + + $this->verifyShare($share, $token); + $this->executeAcceptShare($share); + if ($share->getShareOwner() !== $share->getSharedBy()) { + list(, $remote) = $this->addressHandler->splitUserRemote($share->getSharedBy()); + $remoteId = $this->federatedShareProvider->getRemoteId($share); + $notification = $this->cloudFederationFactory->getCloudFederationNotification(); + $notification->setMessage( + 'SHARE_ACCEPTED', + 'file', + $remoteId, + [ + 'sharedSecret' => $token, + 'message' => 'Recipient accepted the re-share' + ] + + ); + $this->cloudFederationProviderManager->sendNotification($remote, $notification); + + } + + return true; + } + + + /** + * @param IShare $share + * @throws ShareNotFoundException + */ + protected function executeAcceptShare(IShare $share) { + try { + $fileId = (int)$share->getNode()->getId(); + list($file, $link) = $this->getFile($this->getCorrectUid($share), $fileId); + } catch (\Exception $e) { + throw new ShareNotFoundException(); + } + + $event = $this->activityManager->generateEvent(); + $event->setApp('files_sharing') + ->setType('remote_share') + ->setAffectedUser($this->getCorrectUid($share)) + ->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_ACCEPTED, [$share->getSharedWith(), [$fileId => $file]]) + ->setObject('files', $fileId, $file) + ->setLink($link); + $this->activityManager->publish($event); + } + + /** + * get file + * + * @param string $user + * @param int $fileSource + * @return array with internal path of the file and a absolute link to it + */ + private function getFile($user, $fileSource) { + \OC_Util::setupFS($user); + + try { + $file = Filesystem::getPath($fileSource); + } catch (NotFoundException $e) { + $file = null; + } + $args = Filesystem::is_dir($file) ? array('dir' => $file) : array('dir' => dirname($file), 'scrollto' => $file); + $link = Util::linkToAbsolute('files', 'index.php', $args); + + return array($file, $link); + + } + + /** + * check if we are the initiator or the owner of a re-share and return the correct UID + * + * @param IShare $share + * @return string + */ + protected function getCorrectUid(IShare $share) { + if ($this->userManager->userExists($share->getShareOwner())) { + return $share->getShareOwner(); + } + + return $share->getSharedBy(); + } + + + + /** + * check if we got the right share + * + * @param IShare $share + * @param string $token + * @return bool + * @throws AuthenticationFailedException + */ + protected function verifyShare(IShare $share, $token) { + if ( + $share->getShareType() === FederatedShareProvider::SHARE_TYPE_REMOTE && + $share->getToken() === $token + ) { + return true; + } + + throw new AuthenticationFailedException(); + } + + + /** * check if server-to-server sharing is enabled * diff --git a/lib/public/Federation/Exceptions/AuthenticationFailedException.php b/lib/public/Federation/Exceptions/AuthenticationFailedException.php new file mode 100644 index 0000000000..a9a412dd83 --- /dev/null +++ b/lib/public/Federation/Exceptions/AuthenticationFailedException.php @@ -0,0 +1,40 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCP\Federation\Exceptions; + +use OC\HintException; + +class AuthenticationFailedException extends HintException { + + /** + * BadRequestException constructor. + * + * @param array $missingParameters + */ + public function __construct() { + $l = \OC::$server->getL10N('federation'); + $message = 'Authentication failed, wrong token or provider ID given'; + $hint = $l->t('Authentication failed, wrong token or provider ID given'); + parent::__construct($message, $hint); + } + +} diff --git a/lib/public/Federation/Exceptions/BadRequestException.php b/lib/public/Federation/Exceptions/BadRequestException.php new file mode 100644 index 0000000000..67cf911c2a --- /dev/null +++ b/lib/public/Federation/Exceptions/BadRequestException.php @@ -0,0 +1,66 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCP\Federation\Exceptions; + +use OC\HintException; + +class BadRequestException extends HintException { + + private $parameterList; + + /** + * BadRequestException constructor. + * + * @param array $missingParameters + */ + public function __construct(array $missingParameters) { + $l = \OC::$server->getL10N('federation'); + $this->parameterList = $missingParameters; + $parameterList = implode(',', $missingParameters); + $message = 'Parameters missing in order to complete the request. Missing Parameters: ' . $parameterList; + $hint = $l->t('Parameters missing in order to complete the request. Missing Parameters: "%s"', [$parameterList]); + parent::__construct($message, $hint); + } + + /** + * get array with the return message as defined in the OCM API + * + * @return array + */ + public function getReturnMessage() { + $result = [ + 'message' => 'RESOURCE_NOT_FOUND', + 'validationErrors' =>[ + ] + ]; + + foreach ($this->parameterList as $missingParameter) { + $result['validationErrors'] = [ + 'name' => $missingParameter, + 'message' => 'NOT_FOUND' + ]; + } + + return $result; + } + +} diff --git a/lib/public/Federation/ICloudFederationProvider.php b/lib/public/Federation/ICloudFederationProvider.php index f11ed4fde3..36af413cdc 100644 --- a/lib/public/Federation/ICloudFederationProvider.php +++ b/lib/public/Federation/ICloudFederationProvider.php @@ -22,6 +22,8 @@ namespace OCP\Federation; use OCP\Federation\Exceptions\ActionNotSupportedException; +use OCP\Federation\Exceptions\AuthenticationFailedException; +use OCP\Federation\Exceptions\BadRequestException; use OCP\Federation\Exceptions\ProviderCouldNotAddShareException; use OCP\Federation\Exceptions\ShareNotFoundException; @@ -67,6 +69,8 @@ interface ICloudFederationProvider { * * @throws ShareNotFoundException * @throws ActionNotSupportedException + * @throws BadRequestException + * @throws AuthenticationFailedException * * @since 14.0.0 */ diff --git a/lib/public/Share/IShareProvider.php b/lib/public/Share/IShareProvider.php index 4db43d953c..bcb12de8b8 100644 --- a/lib/public/Share/IShareProvider.php +++ b/lib/public/Share/IShareProvider.php @@ -24,8 +24,8 @@ namespace OCP\Share; +use OCP\Federation\Exceptions\ShareNotFoundException; use OCP\Files\Folder; -use OCP\Share\Exceptions\ShareNotFound; use OCP\Files\Node; /** @@ -46,7 +46,7 @@ interface IShareProvider { /** * Create a share - * + * * @param \OCP\Share\IShare $share * @return \OCP\Share\IShare The share object * @since 9.0.0 @@ -125,7 +125,7 @@ interface IShareProvider { * @param int $id * @param string|null $recipientId * @return \OCP\Share\IShare - * @throws ShareNotFound + * @throws ShareNotFoundException * @since 9.0.0 */ public function getShareById($id, $recipientId = null); From c572e84ad9d408b1bb4c537748d4c8c25bf19f3f Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Tue, 29 May 2018 18:04:10 +0200 Subject: [PATCH 11/39] detect correctly if a share was send successful Signed-off-by: Bjoern Schiessle --- lib/private/Federation/CloudFederationProviderManager.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/private/Federation/CloudFederationProviderManager.php b/lib/private/Federation/CloudFederationProviderManager.php index 77866795c3..9aab1753a4 100644 --- a/lib/private/Federation/CloudFederationProviderManager.php +++ b/lib/private/Federation/CloudFederationProviderManager.php @@ -146,7 +146,7 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager 'connect_timeout' => 10, ]); - if ($response->getStatusCode() === Http::STATUS_OK) { + if ($response->getStatusCode() === Http::STATUS_CREATED) { return true; } From b7b84305a3388af3b678c95d105f6553952b0959 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Tue, 29 May 2018 18:04:22 +0200 Subject: [PATCH 12/39] fix capabilities Signed-off-by: Bjoern Schiessle --- apps/cloud_federation_api/lib/Capabilities.php | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/apps/cloud_federation_api/lib/Capabilities.php b/apps/cloud_federation_api/lib/Capabilities.php index 88b8c7b391..a3db8530ef 100644 --- a/apps/cloud_federation_api/lib/Capabilities.php +++ b/apps/cloud_federation_api/lib/Capabilities.php @@ -48,9 +48,13 @@ class Capabilities implements ICapability { 'enabled' => true, 'apiVersion' => '1.0-proposal1', 'endPoint' => substr($url, 0, strrpos($url, '/')), - 'shareTypes' => ['file'], - 'protocol' => [ - 'webdav' => '/public.php/webdav/', + 'shareTypes' => [ + [ + 'name' => 'file', + 'protocols' => [ + 'webdav' => '/public.php/webdav/', + ] + ], ] ] ]; From 41a1528888062610af58e319ce7bfa3ef8784da3 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Wed, 30 May 2018 17:44:08 +0200 Subject: [PATCH 13/39] implement decline share Signed-off-by: Bjoern Schiessle --- .../lib/AppInfo/Application.php | 4 +- .../Controller/RequestHandlerController.php | 50 +++------ .../lib/FederatedShareProvider.php | 2 +- .../lib/ocm/CloudFederationProviderFiles.php | 105 ++++++++++++++++-- apps/files_sharing/lib/External/Manager.php | 17 ++- 5 files changed, 131 insertions(+), 47 deletions(-) diff --git a/apps/federatedfilesharing/lib/AppInfo/Application.php b/apps/federatedfilesharing/lib/AppInfo/Application.php index 0b61e0a0b0..093e1e44f9 100644 --- a/apps/federatedfilesharing/lib/AppInfo/Application.php +++ b/apps/federatedfilesharing/lib/AppInfo/Application.php @@ -62,7 +62,9 @@ class Application extends App { $server->getCloudIdManager(), $server->getActivityManager(), $server->getNotificationManager(), - $server->getURLGenerator() + $server->getURLGenerator(), + $server->getCloudFederationFactory(), + $server->getCloudFederationProviderManager() ); }); diff --git a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php index 628e306e99..8514adb5e8 100644 --- a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php +++ b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php @@ -304,51 +304,27 @@ class RequestHandlerController extends OCSController { */ public function declineShare($id) { - if (!$this->isS2SEnabled()) { - throw new OCSException('Server does not support federated cloud sharing', 503); - } - $token = isset($_POST['token']) ? $_POST['token'] : null; - try { - $share = $this->federatedShareProvider->getShareById($id); - } catch (Share\Exceptions\ShareNotFound $e) { - return new Http\DataResponse(); - } + $notification = [ + 'sharedSecret' => $token, + 'message' => 'Recipient declined the share' + ]; - if ($this->verifyShare($share, $token)) { - if ($share->getShareOwner() !== $share->getSharedBy()) { - list(, $remote) = $this->addressHandler->splitUserRemote($share->getSharedBy()); - $remoteId = $this->federatedShareProvider->getRemoteId($share); - $this->notifications->sendDeclineShare($remote, $remoteId, $share->getToken()); - } - $this->executeDeclineShare($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 (ShareNotFoundException $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(); } - /** - * delete declined share and create a activity - * - * @param Share\IShare $share - */ - protected function executeDeclineShare(Share\IShare $share) { - $this->federatedShareProvider->removeShareFromTable($share); - $fileId = (int) $share->getNode()->getId(); - list($file, $link) = $this->getFile($this->getCorrectUid($share), $fileId); - - $event = \OC::$server->getActivityManager()->generateEvent(); - $event->setApp('files_sharing') - ->setType('remote_share') - ->setAffectedUser($this->getCorrectUid($share)) - ->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_DECLINED, [$share->getSharedWith(), [$fileId => $file]]) - ->setObject('files', $fileId, $file) - ->setLink($link); - \OC::$server->getActivityManager()->publish($event); - - } - /** * @NoCSRFRequired * @PublicPage diff --git a/apps/federatedfilesharing/lib/FederatedShareProvider.php b/apps/federatedfilesharing/lib/FederatedShareProvider.php index 07597cae8e..84aeb8b78c 100644 --- a/apps/federatedfilesharing/lib/FederatedShareProvider.php +++ b/apps/federatedfilesharing/lib/FederatedShareProvider.php @@ -709,7 +709,7 @@ class FederatedShareProvider implements IShareProvider { $cursor->closeCursor(); if ($data === false) { - throw new ShareNotFoundException(); + throw new ShareNotFoundException('Can not find share with ID: ' . $id); } try { diff --git a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php index 798b0bef3f..a271fd454b 100644 --- a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php +++ b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php @@ -34,7 +34,9 @@ use OCP\Federation\Exceptions\AuthenticationFailedException; use OCP\Federation\Exceptions\BadRequestException; use OCP\Federation\Exceptions\ProviderCouldNotAddShareException; use OCP\Federation\Exceptions\ShareNotFoundException; +use OCP\Federation\ICloudFederationFactory; use OCP\Federation\ICloudFederationProvider; +use OCP\Federation\ICloudFederationProviderManager; use OCP\Federation\ICloudFederationShare; use OCP\Federation\ICloudIdManager; use OCP\Files\NotFoundException; @@ -75,6 +77,12 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { /** @var IURLGenerator */ private $urlGenerator; + /** @var ICloudFederationFactory */ + private $cloudFederationFactory; + + /** @var ICloudFederationProviderManager */ + private $cloudFederationProviderManager; + /** * CloudFederationProvider constructor. * @@ -87,6 +95,8 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { * @param IActivityManager $activityManager * @param INotificationManager $notificationManager * @param IURLGenerator $urlGenerator + * @param ICloudFederationFactory $cloudFederationFactory + * @param ICloudFederationProviderManager $cloudFederationProviderManager */ public function __construct(IAppManager $appManager, FederatedShareProvider $federatedShareProvider, @@ -96,7 +106,9 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { ICloudIdManager $cloudIdManager, IActivityManager $activityManager, INotificationManager $notificationManager, - IURLGenerator $urlGenerator + IURLGenerator $urlGenerator, + ICloudFederationFactory $cloudFederationFactory, + ICloudFederationProviderManager $cloudFederationProviderManager ) { $this->appManager = $appManager; $this->federatedShareProvider = $federatedShareProvider; @@ -107,6 +119,8 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { $this->activityManager = $activityManager; $this->notificationManager = $notificationManager; $this->urlGenerator = $urlGenerator; + $this->cloudFederationFactory = $cloudFederationFactory; + $this->cloudFederationProviderManager = $cloudFederationProviderManager; } @@ -258,15 +272,18 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { case 'SHARE_ACCEPTED': $this->shareAccepted($providerId, $notification); return; + case 'SHARE_DECLINED': + $this->shareDeclined($providerId, $notification); + return; } - throw new ActionNotSupportedException($notification); + throw new BadRequestException([$notificationType]); } /** - * @param $id - * @param $notification + * @param string $id + * @param array $notification * @return bool * @throws ActionNotSupportedException * @throws AuthenticationFailedException @@ -276,8 +293,8 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { */ private function shareAccepted($id, $notification) { - if (!$this->isS2SEnabled(true)) { - throw new ActionNotSupportedException('Server does not support federated cloud sharing', '', Http::STATUS_SERVICE_UNAVAILABLE); + if (!$this->isS2SEnabled()) { + throw new ActionNotSupportedException('Server does not support federated cloud sharing'); } if (!isset($notification['sharedSecret'])) { @@ -311,7 +328,6 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { return true; } - /** * @param IShare $share * @throws ShareNotFoundException @@ -334,6 +350,81 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { $this->activityManager->publish($event); } + /** + * @param string $id + * @param array $notification + * @throws ActionNotSupportedException + * @throws AuthenticationFailedException + * @throws BadRequestException + * @throws ShareNotFound + * @throws ShareNotFoundException + * @throws \OC\HintException + */ + protected function shareDeclined($id, $notification) { + + if (!$this->isS2SEnabled()) { + throw new ActionNotSupportedException('Server does not support federated cloud sharing'); + } + + if (!isset($notification['sharedSecret'])) { + throw new BadRequestException(['sharedSecret']); + } + + $token = $notification['sharedSecret']; + + $share = $this->federatedShareProvider->getShareById($id); + + $this->verifyShare($share, $token); + + if ($share->getShareOwner() !== $share->getSharedBy()) { + list(, $remote) = $this->addressHandler->splitUserRemote($share->getSharedBy()); + $remoteId = $this->federatedShareProvider->getRemoteId($share); + $notification = $this->cloudFederationFactory->getCloudFederationNotification(); + $notification->setMessage( + 'SHARE_DECLINED', + 'file', + $remoteId, + [ + 'sharedSecret' => $token, + 'message' => 'Recipient declined the re-share' + ] + + ); + $this->cloudFederationProviderManager->sendNotification($remote, $notification); + } + + $this->executeDeclineShare($share); + + } + + /** + * delete declined share and create a activity + * + * @param IShare $share + * @throws ShareNotFoundException + */ + protected function executeDeclineShare(IShare $share) { + $this->federatedShareProvider->removeShareFromTable($share); + + try { + $fileId = (int)$share->getNode()->getId(); + list($file, $link) = $this->getFile($this->getCorrectUid($share), $fileId); + } catch (\Exception $e) { + throw new ShareNotFoundException(); + } + + $event = $this->activityManager->generateEvent(); + $event->setApp('files_sharing') + ->setType('remote_share') + ->setAffectedUser($this->getCorrectUid($share)) + ->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_DECLINED, [$share->getSharedWith(), [$fileId => $file]]) + ->setObject('files', $fileId, $file) + ->setLink($link); + $this->activityManager->publish($event); + + } + + /** * get file * diff --git a/apps/files_sharing/lib/External/Manager.php b/apps/files_sharing/lib/External/Manager.php index 0bbbbea767..02783560af 100644 --- a/apps/files_sharing/lib/External/Manager.php +++ b/apps/files_sharing/lib/External/Manager.php @@ -326,7 +326,7 @@ class Manager { * @param string $token * @param $remoteId id of the share * @param string $feedback - * @return mixed + * @return bool */ protected function tryOCMEndPoint($remoteDomain, $token, $remoteId, $feedback) { switch ($feedback) { @@ -341,10 +341,25 @@ class Manager { 'message' => 'Recipient accept the share' ] + ); + return $this->cloudFederationProviderManager->sendNotification($remoteDomain, $notification); + case 'decline': + $notification = $this->cloudFederationFactory->getCloudFederationNotification(); + $notification->setMessage( + 'SHARE_DECLINED', + 'file', + $remoteId, + [ + 'sharedSecret' => $token, + 'message' => 'Recipient declined the share' + ] + ); return $this->cloudFederationProviderManager->sendNotification($remoteDomain, $notification); } + return false; + } From fab4e561f4f3ea9a3cf90a01c39c8d1e87ee9eab Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Mon, 4 Jun 2018 12:16:03 +0200 Subject: [PATCH 14/39] send reshare over OCM API Signed-off-by: Bjoern Schiessle --- .../Controller/RequestHandlerController.php | 6 +- .../Controller/RequestHandlerController.php | 54 +++++-------- .../lib/FederatedShareProvider.php | 3 +- .../lib/Notifications.php | 52 +++++++++++- .../lib/ocm/CloudFederationProviderFiles.php | 80 +++++++++++++++++-- .../CloudFederationProviderManager.php | 7 +- .../Federation/ICloudFederationProvider.php | 1 + .../ICloudFederationProviderManager.php | 4 +- 8 files changed, 157 insertions(+), 50 deletions(-) diff --git a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php index 4ee8344b6b..a7601d1ce1 100644 --- a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php +++ b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php @@ -117,6 +117,7 @@ class RequestHandlerController extends Controller { * Example: curl -H "Content-Type: application/json" -X POST -d '{"shareWith":"admin1@serve1","name":"welcome server2.txt","description":"desc","providerId":"2","owner":"admin2@http://localhost/server2","ownerDisplayName":"admin2 display","shareType":"user","resourceType":"file","protocol":{"name":"webdav","options":{"sharedSecret":"secret","permissions":"webdav-property"}}}' http://localhost/server/index.php/ocm/shares */ public function addShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) { + if (!$this->config->incomingRequestsEnabled()) { return new JSONResponse( ['message' => 'This server doesn\'t support outgoing federated shares'], @@ -227,7 +228,7 @@ class RequestHandlerController extends Controller { try { $provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType); - $provider->notificationReceived($notificationType, $providerId, $notification); + $result = $provider->notificationReceived($notificationType, $providerId, $notification); } catch (ProviderDoesNotExistsException $e) { return new JSONResponse( ['message' => $e->getMessage()], @@ -255,8 +256,7 @@ class RequestHandlerController extends Controller { ); } - - return new JSONResponse([],Http::STATUS_CREATED); + return new JSONResponse($result,Http::STATUS_CREATED); } diff --git a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php index 8514adb5e8..041232c83e 100644 --- a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php +++ b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php @@ -218,45 +218,35 @@ class RequestHandlerController extends OCSController { throw new OCSBadRequestException(); } + $notification = [ + 'sharedSecret' => $token, + 'shareWith' => $shareWith, + 'senderId' => $remoteId, + 'message' => 'Recipient of a share ask the owner to reshare the file' + ]; + try { - $share = $this->federatedShareProvider->getShareById($id); - } catch (Share\Exceptions\ShareNotFound $e) { - throw new OCSNotFoundException(); - } - - // don't allow to share a file back to the owner - list($user, $remote) = $this->addressHandler->splitUserRemote($shareWith); - $owner = $share->getShareOwner(); - $currentServer = $this->addressHandler->generateRemoteURL(); - if ($this->addressHandler->compareAddresses($user, $remote, $owner, $currentServer)) { + $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 (ShareNotFoundException $e) { + $this->logger->debug('Share not found: ' . $e->getMessage()); + } catch (ProviderCouldNotAddShareException $e) { + $this->logger->debug('Could not add reshare: ' . $e->getMessage()); throw new OCSForbiddenException(); + } catch (\Exception $e) { + $this->logger->debug('internal server error, can not process notification: ' . $e->getMessage()); } - if ($this->verifyShare($share, $token)) { - - // check if re-sharing is allowed - if ($share->getPermissions() | ~Constants::PERMISSION_SHARE) { - $share->setPermissions($share->getPermissions() & $permission); - // the recipient of the initial share is now the initiator for the re-share - $share->setSharedBy($share->getSharedWith()); - $share->setSharedWith($shareWith); - try { - $result = $this->federatedShareProvider->create($share); - $this->federatedShareProvider->storeRemoteId((int)$result->getId(), $remoteId); - return new Http\DataResponse([ - 'token' => $result->getToken(), - 'remoteId' => $result->getId() - ]); - } catch (\Exception $e) { - throw new OCSBadRequestException(); - } - } else { - throw new OCSForbiddenException(); - } - } throw new OCSBadRequestException(); } + /** * @NoCSRFRequired * @PublicPage diff --git a/apps/federatedfilesharing/lib/FederatedShareProvider.php b/apps/federatedfilesharing/lib/FederatedShareProvider.php index 84aeb8b78c..62be96dfa0 100644 --- a/apps/federatedfilesharing/lib/FederatedShareProvider.php +++ b/apps/federatedfilesharing/lib/FederatedShareProvider.php @@ -304,7 +304,8 @@ class FederatedShareProvider implements IShareProvider { $shareId, $remote, $shareWith, - $share->getPermissions() + $share->getPermissions(), + $share->getNode()->getName() ); return [$token, $remoteId]; diff --git a/apps/federatedfilesharing/lib/Notifications.php b/apps/federatedfilesharing/lib/Notifications.php index e0f8735f90..33254774e2 100644 --- a/apps/federatedfilesharing/lib/Notifications.php +++ b/apps/federatedfilesharing/lib/Notifications.php @@ -136,20 +136,31 @@ class Notifications { * @param string $remote remote address of the owner * @param string $shareWith * @param int $permission + * @param string $filename * @return bool * @throws \OC\HintException * @throws \OC\ServerNotAvailableException */ - public function requestReShare($token, $id, $shareId, $remote, $shareWith, $permission) { + public function requestReShare($token, $id, $shareId, $remote, $shareWith, $permission, $filename) { $fields = array( 'shareWith' => $shareWith, 'token' => $token, 'permission' => $permission, - 'remoteId' => $shareId + 'remoteId' => $shareId, ); - $result = $this->tryHttpPostToShareEndpoint(rtrim($remote, '/'), '/' . $id . '/reshare', $fields); + $ocmFields = $fields; + $ocmFields['remoteId'] = $id; + $ocmFields['localId'] = $shareId; + $ocmFields['name'] = $filename; + + $ocmResult = $this->tryOCMEndPoint($remote, $ocmFields, 'reshare'); + if (is_array($ocmResult) && isset($ocmResult['token']) && isset($ocmResult['providerId'])) { + return [$ocmResult['token'], $ocmResult['providerId']]; + } + + $result = $this->tryLegacyEndPoint(rtrim($remote, '/'), '/' . $id . '/reshare', $fields); $status = json_decode($result['result'], true); $httpRequestSuccessful = $result['success']; @@ -310,6 +321,25 @@ class Notifications { return $result; } + return $this->tryLegacyEndPoint($remoteDomain, $urlSuffix, $fields); + } + + /** + * try old federated sharing API if the OCM api doesn't work + * + * @param $remoteDomain + * @param $urlSuffix + * @param array $fields + * @return mixed + * @throws \Exception + */ + protected function tryLegacyEndPoint($remoteDomain, $urlSuffix, array $fields) { + + $result = [ + 'success' => false, + 'result' => '', + ]; + // Fall back to old API $client = $this->httpClientService->newClient(); $federationEndpoints = $this->discoveryService->discover($remoteDomain, 'FEDERATED_SHARING'); @@ -332,6 +362,7 @@ class Notifications { } return $result; + } /** @@ -384,7 +415,22 @@ class Notifications { 'file' ); return $this->federationProviderManager->sendShare($share); + case 'reshare': + $notification = $this->cloudFederationFactory->getCloudFederationNotification(); + $notification->setMessage('REQUEST_RESHARE', + 'file', + $fields['remoteId'], + [ + 'sharedSecret' => $fields['token'], + 'shareWith' => $fields['shareWith'], + 'senderId' => $fields['localId'], + 'message' => 'Ask owner to reshare the file' + ] + ); + return $this->federationProviderManager->sendNotification($remoteDomain, $notification); } + return false; + } } diff --git a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php index a271fd454b..565a46c6cf 100644 --- a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php +++ b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php @@ -29,6 +29,7 @@ use OCA\FederatedFileSharing\FederatedShareProvider; use OCP\Activity\IManager as IActivityManager; use OCP\Activity\IManager; use OCP\App\IAppManager; +use OCP\Constants; use OCP\Federation\Exceptions\ActionNotSupportedException; use OCP\Federation\Exceptions\AuthenticationFailedException; use OCP\Federation\Exceptions\BadRequestException; @@ -258,6 +259,7 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { * @param string $notificationType (e.g. SHARE_ACCEPTED) * @param string $providerId id of the share * @param array $notification payload of the notification + * @return array data send back to the sender * * @throws ActionNotSupportedException * @throws AuthenticationFailedException @@ -270,11 +272,11 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { switch ($notificationType) { case 'SHARE_ACCEPTED': - $this->shareAccepted($providerId, $notification); - return; + return $this->shareAccepted($providerId, $notification); case 'SHARE_DECLINED': - $this->shareDeclined($providerId, $notification); - return; + return $this->shareDeclined($providerId, $notification); + case 'REQUEST_RESHARE': + return $this->reshareRequested($providerId, $notification); } @@ -282,9 +284,11 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { } /** + * process notification that the recipient accepted a share + * * @param string $id * @param array $notification - * @return bool + * @return array * @throws ActionNotSupportedException * @throws AuthenticationFailedException * @throws BadRequestException @@ -325,7 +329,7 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { } - return true; + return []; } /** @@ -351,14 +355,18 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { } /** + * process notification that the recipient declined a share + * * @param string $id * @param array $notification + * @return array * @throws ActionNotSupportedException * @throws AuthenticationFailedException * @throws BadRequestException * @throws ShareNotFound * @throws ShareNotFoundException * @throws \OC\HintException + * */ protected function shareDeclined($id, $notification) { @@ -395,6 +403,8 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { $this->executeDeclineShare($share); + return []; + } /** @@ -424,6 +434,64 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { } + /** + * recipient of a share request to re-share the file with another user + * + * @param $id + * @param $notification + * @return array + * @throws AuthenticationFailedException + * @throws BadRequestException + * @throws ProviderCouldNotAddShareException + * @throws ShareNotFoundException + * @throws ShareNotFound + */ + protected function reshareRequested($id, $notification) { + + if (!isset($notification['sharedSecret'])) { + throw new BadRequestException(['sharedSecret']); + } + $token = $notification['sharedSecret']; + + if (!isset($notification['shareWith'])) { + throw new BadRequestException(['shareWith']); + } + $shareWith = $notification['shareWith']; + + if (!isset($notification['senderId'])) { + throw new BadRequestException(['senderId']); + } + $senderId = $notification['senderId']; + + $share = $this->federatedShareProvider->getShareById($id); + // don't allow to share a file back to the owner + try { + list($user, $remote) = $this->addressHandler->splitUserRemote($shareWith); + $owner = $share->getShareOwner(); + $currentServer = $this->addressHandler->generateRemoteURL(); + if ($this->addressHandler->compareAddresses($user, $remote, $owner, $currentServer)) { + throw new ProviderCouldNotAddShareException('Resharing back to the owner is not allowed: ' . $id); + } + } catch (\Exception $e) { + throw new ProviderCouldNotAddShareException($e->getMessage()); + } + + $this->verifyShare($share, $token); + + // check if re-sharing is allowed + if ($share->getPermissions() | ~Constants::PERMISSION_SHARE) { + // the recipient of the initial share is now the initiator for the re-share + $share->setSharedBy($share->getSharedWith()); + $share->setSharedWith($shareWith); + $result = $this->federatedShareProvider->create($share); + $this->federatedShareProvider->storeRemoteId((int)$result->getId(), $senderId); + return ['token' => $result->getToken(), 'providerId' => $result->getId()]; + } else { + throw new ProviderCouldNotAddShareException('resharing not allowed for share: ' . $id); + } + + throw new BadRequestException([]); + } /** * get file diff --git a/lib/private/Federation/CloudFederationProviderManager.php b/lib/private/Federation/CloudFederationProviderManager.php index 9aab1753a4..aa25ba9dee 100644 --- a/lib/private/Federation/CloudFederationProviderManager.php +++ b/lib/private/Federation/CloudFederationProviderManager.php @@ -166,7 +166,7 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager /** * @param string $url * @param ICloudFederationNotification $notification - * @return bool + * @return mixed */ public function sendNotification($url, ICloudFederationNotification $notification) { $ocmEndPoint = $this->getOCMEndPoint($url); @@ -182,8 +182,9 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager 'timeout' => 10, 'connect_timeout' => 10, ]); - if ($response->getStatusCode() === Http::STATUS_OK) { - return true; + if ($response->getStatusCode() === Http::STATUS_CREATED) { + $result = json_decode($response->getBody(), true); + return (is_array($result)) ? $result : []; } } catch (\Exception $e) { // log the error and return false diff --git a/lib/public/Federation/ICloudFederationProvider.php b/lib/public/Federation/ICloudFederationProvider.php index 36af413cdc..5260cbf9aa 100644 --- a/lib/public/Federation/ICloudFederationProvider.php +++ b/lib/public/Federation/ICloudFederationProvider.php @@ -66,6 +66,7 @@ interface ICloudFederationProvider { * @param string $notificationType (e.g SHARE_ACCEPTED) * @param string $providerId share ID * @param array $notification provider specific notification + * @return array $data send back to sender * * @throws ShareNotFoundException * @throws ActionNotSupportedException diff --git a/lib/public/Federation/ICloudFederationProviderManager.php b/lib/public/Federation/ICloudFederationProviderManager.php index 714c6234b7..7a14e49a7b 100644 --- a/lib/public/Federation/ICloudFederationProviderManager.php +++ b/lib/public/Federation/ICloudFederationProviderManager.php @@ -77,7 +77,7 @@ interface ICloudFederationProviderManager { * send federated share * * @param ICloudFederationShare $share - * @return mixed + * @return bool * * @since 14.0.0 */ @@ -88,7 +88,7 @@ interface ICloudFederationProviderManager { * * @param string $url * @param ICloudFederationNotification $notification - * @return bool + * @return mixed * * @since 14.0.0 */ From a176a1f318501ecf344a43b66811985eee99c426 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Mon, 4 Jun 2018 16:36:37 +0200 Subject: [PATCH 15/39] implement unshare notification Signed-off-by: Bjoern Schiessle --- .../lib/AppInfo/Application.php | 3 +- .../Controller/RequestHandlerController.php | 72 +++--------- .../lib/Notifications.php | 22 +++- .../lib/ocm/CloudFederationProviderFiles.php | 111 +++++++++++++++++- 4 files changed, 145 insertions(+), 63 deletions(-) diff --git a/apps/federatedfilesharing/lib/AppInfo/Application.php b/apps/federatedfilesharing/lib/AppInfo/Application.php index 093e1e44f9..7034783121 100644 --- a/apps/federatedfilesharing/lib/AppInfo/Application.php +++ b/apps/federatedfilesharing/lib/AppInfo/Application.php @@ -64,7 +64,8 @@ class Application extends App { $server->getNotificationManager(), $server->getURLGenerator(), $server->getCloudFederationFactory(), - $server->getCloudFederationProviderManager() + $server->getCloudFederationProviderManager(), + $server->getDatabaseConnection() ); }); diff --git a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php index 041232c83e..0b490b5757 100644 --- a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php +++ b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php @@ -333,60 +333,12 @@ class RequestHandlerController extends OCSController { $token = isset($_POST['token']) ? $_POST['token'] : null; - $qb = $this->connection->getQueryBuilder(); - $qb->select('*') - ->from('share_external') - ->where( - $qb->expr()->andX( - $qb->expr()->eq('remote_id', $qb->createNamedParameter($id)), - $qb->expr()->eq('share_token', $qb->createNamedParameter($token)) - ) - ); - - $result = $qb->execute(); - $share = $result->fetch(); - $result->closeCursor(); - - if ($token && $id && !empty($share)) { - - $remote = $this->cleanupRemote($share['remote']); - - $owner = $this->cloudIdManager->getCloudId($share['owner'], $remote); - $mountpoint = $share['mountpoint']; - $user = $share['user']; - - $qb = $this->connection->getQueryBuilder(); - $qb->delete('share_external') - ->where( - $qb->expr()->andX( - $qb->expr()->eq('remote_id', $qb->createNamedParameter($id)), - $qb->expr()->eq('share_token', $qb->createNamedParameter($token)) - ) - ); - - $result = $qb->execute(); - $result->closeCursor(); - - if ($share['accepted']) { - $path = trim($mountpoint, '/'); - } else { - $path = trim($share['name'], '/'); - } - - $notificationManager = \OC::$server->getNotificationManager(); - $notification = $notificationManager->createNotification(); - $notification->setApp('files_sharing') - ->setUser($share['user']) - ->setObject('remote_share', (int)$share['id']); - $notificationManager->markProcessed($notification); - - $event = \OC::$server->getActivityManager()->generateEvent(); - $event->setApp('files_sharing') - ->setType('remote_share') - ->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_UNSHARED, [$owner->getId(), $path]) - ->setAffectedUser($user) - ->setObject('remote_share', (int)$share['id'], $path); - \OC::$server->getActivityManager()->publish($event); + 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(); @@ -410,16 +362,20 @@ class RequestHandlerController extends OCSController { * @throws OCSBadRequestException */ public function revoke($id) { + $token = $this->request->getParam('token'); - $share = $this->federatedShareProvider->getShareById($id); + $notification = $this->cloudFederationFactory->getCloudFederationNotification(); + $notification->setMessage(['sharedSecret' => $token]); - if ($this->verifyShare($share, $token)) { - $this->federatedShareProvider->removeShareFromTable($share); + try { + $provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file'); + $provider->notificationReceived('SHARE_UNSHARE', $id, $notification); return new Http\DataResponse(); + } catch (\Exception $e) { + throw new OCSBadRequestException(); } - throw new OCSBadRequestException(); } /** diff --git a/apps/federatedfilesharing/lib/Notifications.php b/apps/federatedfilesharing/lib/Notifications.php index 33254774e2..36eb88e31a 100644 --- a/apps/federatedfilesharing/lib/Notifications.php +++ b/apps/federatedfilesharing/lib/Notifications.php @@ -199,7 +199,7 @@ class Notifications { * @return bool */ public function sendRevokeShare($remote, $id, $token) { - $this->sendUpdateToRemote($remote, $id, $token, 'revoke'); + $this->sendUpdateToRemote($remote, $id, $token, 'reshare_undo'); } /** @@ -250,12 +250,15 @@ class Notifications { */ public function sendUpdateToRemote($remote, $remoteId, $token, $action, $data = [], $try = 0) { - $fields = array('token' => $token); + $fields = [ + 'token' => $token, + 'remoteId' => $remoteId + ]; foreach ($data as $key => $value) { $fields[$key] = $value; } - $result = $this->tryHttpPostToShareEndpoint(rtrim($remote, '/'), '/' . $remoteId . '/' . $action, $fields); + $result = $this->tryHttpPostToShareEndpoint(rtrim($remote, '/'), '/' . $remoteId . '/' . $action, $fields, $action); $status = json_decode($result['result'], true); if ($result['success'] && @@ -416,6 +419,7 @@ class Notifications { ); return $this->federationProviderManager->sendShare($share); case 'reshare': + // ask owner to reshare a file $notification = $this->cloudFederationFactory->getCloudFederationNotification(); $notification->setMessage('REQUEST_RESHARE', 'file', @@ -428,6 +432,18 @@ class Notifications { ] ); return $this->federationProviderManager->sendNotification($remoteDomain, $notification); + case 'unshare': + //owner unshares the file from the recipient again + $notification = $this->cloudFederationFactory->getCloudFederationNotification(); + $notification->setMessage('SHARE_UNSHARED', + 'file', + $fields['remoteId'], + [ + 'sharedSecret' => $fields['token'], + ] + ); + return $this->federationProviderManager->sendNotification($remoteDomain, $notification); + return false; } return false; diff --git a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php index 565a46c6cf..dc022e4f9c 100644 --- a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php +++ b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php @@ -41,6 +41,7 @@ use OCP\Federation\ICloudFederationProviderManager; use OCP\Federation\ICloudFederationShare; use OCP\Federation\ICloudIdManager; use OCP\Files\NotFoundException; +use OCP\IDBConnection; use OCP\ILogger; use OCP\IURLGenerator; use OCP\IUserManager; @@ -84,6 +85,9 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { /** @var ICloudFederationProviderManager */ private $cloudFederationProviderManager; + /** @var IDBConnection */ + private $connection; + /** * CloudFederationProvider constructor. * @@ -98,6 +102,7 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { * @param IURLGenerator $urlGenerator * @param ICloudFederationFactory $cloudFederationFactory * @param ICloudFederationProviderManager $cloudFederationProviderManager + * @param IDBConnection $connection */ public function __construct(IAppManager $appManager, FederatedShareProvider $federatedShareProvider, @@ -109,7 +114,8 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { INotificationManager $notificationManager, IURLGenerator $urlGenerator, ICloudFederationFactory $cloudFederationFactory, - ICloudFederationProviderManager $cloudFederationProviderManager + ICloudFederationProviderManager $cloudFederationProviderManager, + IDBConnection $connection ) { $this->appManager = $appManager; $this->federatedShareProvider = $federatedShareProvider; @@ -122,6 +128,7 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { $this->urlGenerator = $urlGenerator; $this->cloudFederationFactory = $cloudFederationFactory; $this->cloudFederationProviderManager = $cloudFederationProviderManager; + $this->connection = $connection; } @@ -275,8 +282,12 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { return $this->shareAccepted($providerId, $notification); case 'SHARE_DECLINED': return $this->shareDeclined($providerId, $notification); + case 'SHARE_UNSHARED': + return $this->unshare($providerId, $notification); case 'REQUEST_RESHARE': return $this->reshareRequested($providerId, $notification); + case 'RESHARE_UNDO': + return $this->undoReshare($providerId, $notification); } @@ -434,6 +445,104 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { } + /** + * received the notification that the owner unshared a file from you + * + * @param string $id + * @param string $notification + * @return array + * @throws AuthenticationFailedException + * @throws BadRequestException + * @throws ShareNotFoundException + */ + private function undoReshare($id, $notification) { + + if (!isset($notification['sharedSecret'])) { + throw new BadRequestException(['sharedSecret']); + } + $token = $notification['sharedSecret']; + + $share = $this->federatedShareProvider->getShareById($id); + + $this->verifyShare($share, $token); + $this->federatedShareProvider->removeShareFromTable($share); + return []; + } + + private function unshare($id, $notification) { + error_log("new unshare!"); + if (!$this->isS2SEnabled(true)) { + throw new ActionNotSupportedException("incoming shares disabled!"); + } + + if (!isset($notification['sharedSecret'])) { + throw new BadRequestException(['sharedSecret']); + } + $token = $notification['sharedSecret']; + + $qb = $this->connection->getQueryBuilder(); + $qb->select('*') + ->from('share_external') + ->where( + $qb->expr()->andX( + $qb->expr()->eq('remote_id', $qb->createNamedParameter($id)), + $qb->expr()->eq('share_token', $qb->createNamedParameter($token)) + ) + ); + + $result = $qb->execute(); + $share = $result->fetch(); + $result->closeCursor(); + + if ($token && $id && !empty($share)) { + + $remote = $this->cleanupRemote($share['remote']); + + $owner = $this->cloudIdManager->getCloudId($share['owner'], $remote); + $mountpoint = $share['mountpoint']; + $user = $share['user']; + + $qb = $this->connection->getQueryBuilder(); + $qb->delete('share_external') + ->where( + $qb->expr()->andX( + $qb->expr()->eq('remote_id', $qb->createNamedParameter($id)), + $qb->expr()->eq('share_token', $qb->createNamedParameter($token)) + ) + ); + + $qb->execute(); + + if ($share['accepted']) { + $path = trim($mountpoint, '/'); + } else { + $path = trim($share['name'], '/'); + } + + $notification = $this->notificationManager->createNotification(); + $notification->setApp('files_sharing') + ->setUser($share['user']) + ->setObject('remote_share', (int)$share['id']); + $this->notificationManager->markProcessed($notification); + + $event = $this->activityManager->generateEvent(); + $event->setApp('files_sharing') + ->setType('remote_share') + ->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_UNSHARED, [$owner->getId(), $path]) + ->setAffectedUser($user) + ->setObject('remote_share', (int)$share['id'], $path); + \OC::$server->getActivityManager()->publish($event); + } + + return []; + } + + private function cleanupRemote($remote) { + $remote = substr($remote, strpos($remote, '://') + 3); + + return rtrim($remote, '/'); + } + /** * recipient of a share request to re-share the file with another user * From d77eedd23bac7f9d28a5d478263914c34b8003c4 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Tue, 5 Jun 2018 17:19:42 +0200 Subject: [PATCH 16/39] - Don't remove share before all notifications are created, otherwise we miss information necessary to create the notifications - Don't send message to owner/sharer about revoked re-shares twice. Signed-off-by: Bjoern Schiessle --- .../lib/FederatedShareProvider.php | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/apps/federatedfilesharing/lib/FederatedShareProvider.php b/apps/federatedfilesharing/lib/FederatedShareProvider.php index 62be96dfa0..370ba44a0b 100644 --- a/apps/federatedfilesharing/lib/FederatedShareProvider.php +++ b/apps/federatedfilesharing/lib/FederatedShareProvider.php @@ -514,29 +514,19 @@ class FederatedShareProvider implements IShareProvider { $isOwner = false; - $this->removeShareFromTable($share); - // if the local user is the owner we can send the unShare request directly... if ($this->userManager->userExists($share->getShareOwner())) { $this->notifications->sendRemoteUnShare($remote, $share->getId(), $share->getToken()); $this->revokeShare($share, true); - $isOwner = true; } else { // ... if not we need to correct ID for the unShare request $remoteId = $this->getRemoteId($share); $this->notifications->sendRemoteUnShare($remote, $remoteId, $share->getToken()); $this->revokeShare($share, false); } - // send revoke notification to the other user, if initiator and owner are not the same user - if ($share->getShareOwner() !== $share->getSharedBy()) { - $remoteId = $this->getRemoteId($share); - if ($isOwner) { - list(, $remote) = $this->addressHandler->splitUserRemote($share->getSharedBy()); - } else { - list(, $remote) = $this->addressHandler->splitUserRemote($share->getShareOwner()); - } - $this->notifications->sendRevokeShare($remote, $remoteId, $share->getToken()); - } + // only remove the share when all messages are send to not lose information + // about the share to early + $this->removeShareFromTable($share); } /** From 2bb1956c1f69ea7159e65d49ed0cc2a127749be6 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Tue, 5 Jun 2018 17:21:51 +0200 Subject: [PATCH 17/39] implement RESHARE_UNDO notification Signed-off-by: Bjoern Schiessle --- .../Controller/RequestHandlerController.php | 2 +- .../federatedfilesharing/lib/Notifications.php | 18 ++++++++++++++++-- .../lib/ocm/CloudFederationProviderFiles.php | 3 +-- 3 files changed, 18 insertions(+), 5 deletions(-) diff --git a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php index 0b490b5757..30330accdd 100644 --- a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php +++ b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php @@ -370,7 +370,7 @@ class RequestHandlerController extends OCSController { try { $provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file'); - $provider->notificationReceived('SHARE_UNSHARE', $id, $notification); + $provider->notificationReceived('RESHARE_UNDO', $id, $notification); return new Http\DataResponse(); } catch (\Exception $e) { throw new OCSBadRequestException(); diff --git a/apps/federatedfilesharing/lib/Notifications.php b/apps/federatedfilesharing/lib/Notifications.php index 36eb88e31a..e15e9c2f6a 100644 --- a/apps/federatedfilesharing/lib/Notifications.php +++ b/apps/federatedfilesharing/lib/Notifications.php @@ -319,8 +319,10 @@ class Notifications { // if possible we use the new OCM API $ocmResult = $this->tryOCMEndPoint($remoteDomain, $fields, $action); - if ($ocmResult) { + if (is_array($ocmResult)) { $result['success'] = true; + $result['result'] = json_encode([ + 'ocs' => ['meta' => ['statuscode' => 200]]]); return $result; } @@ -440,10 +442,22 @@ class Notifications { $fields['remoteId'], [ 'sharedSecret' => $fields['token'], + 'messgage' => 'file is no longer shared with you' + ] + ); + return $this->federationProviderManager->sendNotification($remoteDomain, $notification); + case 'reshare_undo': + // if a reshare was unshared we send the information to the initiator/owner + $notification = $this->cloudFederationFactory->getCloudFederationNotification(); + $notification->setMessage('RESHARE_UNDO', + 'file', + $fields['remoteId'], + [ + 'sharedSecret' => $fields['token'], + 'message' => 'reshare was revoked' ] ); return $this->federationProviderManager->sendNotification($remoteDomain, $notification); - return false; } return false; diff --git a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php index dc022e4f9c..cc14d35a3d 100644 --- a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php +++ b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php @@ -456,7 +456,6 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { * @throws ShareNotFoundException */ private function undoReshare($id, $notification) { - if (!isset($notification['sharedSecret'])) { throw new BadRequestException(['sharedSecret']); } @@ -470,7 +469,7 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { } private function unshare($id, $notification) { - error_log("new unshare!"); + if (!$this->isS2SEnabled(true)) { throw new ActionNotSupportedException("incoming shares disabled!"); } From ed415726d35b019ef085330ee8573d00415bb771 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Tue, 5 Jun 2018 19:43:57 +0200 Subject: [PATCH 18/39] send RESHARE_CHANGE_PERMISSION message Signed-off-by: Bjoern Schiessle --- .../Controller/RequestHandlerController.php | 77 ++++++++--------- .../lib/ocm/CloudFederationProviderFiles.php | 82 +++++++++++++++++++ 2 files changed, 114 insertions(+), 45 deletions(-) diff --git a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php index 30330accdd..653c41c3ba 100644 --- a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php +++ b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php @@ -40,6 +40,8 @@ use OCP\AppFramework\OCS\OCSForbiddenException; use OCP\AppFramework\OCS\OCSNotFoundException; use OCP\AppFramework\OCSController; use OCP\Constants; +use OCP\Federation\Exceptions\AuthenticationFailedException; +use OCP\Federation\Exceptions\BadRequestException; use OCP\Federation\Exceptions\ProviderCouldNotAddShareException; use OCP\Federation\Exceptions\ProviderDoesNotExistsException; use OCP\Federation\Exceptions\ShareNotFoundException; @@ -365,11 +367,9 @@ class RequestHandlerController extends OCSController { $token = $this->request->getParam('token'); - $notification = $this->cloudFederationFactory->getCloudFederationNotification(); - $notification->setMessage(['sharedSecret' => $token]); - try { $provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file'); + $notification = ['sharedSecret' => $token]; $provider->notificationReceived('RESHARE_UNDO', $id, $notification); return new Http\DataResponse(); } catch (\Exception $e) { @@ -401,28 +401,6 @@ class RequestHandlerController extends OCSController { return false; } - /** - * get file - * - * @param string $user - * @param int $fileSource - * @return array with internal path of the file and a absolute link to it - */ - private function getFile($user, $fileSource) { - \OC_Util::setupFS($user); - - try { - $file = \OC\Files\Filesystem::getPath($fileSource); - } catch (NotFoundException $e) { - $file = null; - } - $args = \OC\Files\Filesystem::is_dir($file) ? array('dir' => $file) : array('dir' => dirname($file), 'scrollto' => $file); - $link = \OCP\Util::linkToAbsolute('files', 'index.php', $args); - - return array($file, $link); - - } - /** * check if server-to-server sharing is enabled * @@ -454,19 +432,15 @@ class RequestHandlerController extends OCSController { */ public function updatePermissions($id) { $token = $this->request->getParam('token', null); - $permissions = $this->request->getParam('permissions', null); + $ncPermissions = $this->request->getParam('permissions', null); try { - $share = $this->federatedShareProvider->getShareById($id); - } catch (Share\Exceptions\ShareNotFound $e) { - throw new OCSBadRequestException(); - } - - $validPermission = ctype_digit($permissions); - $validToken = $this->verifyShare($share, $token); - if ($validPermission && $validToken) { - $this->updatePermissionsInDatabase($share, (int)$permissions); - } else { + $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(); } @@ -474,17 +448,30 @@ class RequestHandlerController extends OCSController { } /** - * update permissions in database + * translate Nextcloud permissions to OCM Permissions * - * @param IShare $share - * @param int $permissions + * @param $ncPermissions + * @return array */ - protected function updatePermissionsInDatabase(IShare $share, $permissions) { - $query = $this->connection->getQueryBuilder(); - $query->update('share') - ->where($query->expr()->eq('id', $query->createNamedParameter($share->getId()))) - ->set('permissions', $query->createNamedParameter($permissions)) - ->execute(); + 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; + } /** diff --git a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php index cc14d35a3d..0f28abc945 100644 --- a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php +++ b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php @@ -21,6 +21,7 @@ namespace OCA\FederatedFileSharing\OCM; +use function GuzzleHttp\default_ca_bundle; use OC\AppFramework\Http; use OC\Files\Filesystem; use OCA\Files_Sharing\Activity\Providers\RemoteShares; @@ -288,6 +289,8 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { return $this->reshareRequested($providerId, $notification); case 'RESHARE_UNDO': return $this->undoReshare($providerId, $notification); + case 'RESHARE_CHANGE_PERMISSION': + return $this->updateResharePermissions($providerId, $notification); } @@ -601,6 +604,85 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { throw new BadRequestException([]); } + /** + * update permission of a re-share so that the share dialog shows the right + * permission if the owner or the sender changes the permission + * + * @param string $id + * @param array $notification + * @return array + * @throws AuthenticationFailedException + * @throws BadRequestException + * @throws ShareNotFoundException + */ + protected function updateResharePermissions($id, $notification) { + + if (!isset($notification['sharedSecret'])) { + throw new BadRequestException(['sharedSecret']); + } + $token = $notification['sharedSecret']; + + if (!isset($notification['permission'])) { + throw new BadRequestException(['permission']); + } + $ocmPermissions = $notification['permission']; + + $share = $this->federatedShareProvider->getShareById($id); + + $ncPermission = $this->ocmPermissions2ncPermissions($ocmPermissions); + + $this->verifyShare($share, $token); + $this->updatePermissionsInDatabase($share, $ncPermission); + + return []; + } + + /** + * translate OCM Permissions to Nextcloud permissions + * + * @param $ocmPermissions + * @return int + * @throws BadRequestException + */ + protected function ocmPermissions2ncPermissions($ocmPermissions) { + error_log("ocm permissions: " . json_encode($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 BadRequestException(['permission']); + } + + error_log("new permissions: " . $ncPermissions); + } + + return $ncPermissions; + } + + /** + * update permissions in database + * + * @param IShare $share + * @param int $permissions + */ + protected function updatePermissionsInDatabase(IShare $share, $permissions) { + $query = $this->connection->getQueryBuilder(); + $query->update('share') + ->where($query->expr()->eq('id', $query->createNamedParameter($share->getId()))) + ->set('permissions', $query->createNamedParameter($permissions)) + ->execute(); + } + + /** * get file * From 61485e3e600d5a9359ac215602c4778f00d38823 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Tue, 5 Jun 2018 19:54:42 +0200 Subject: [PATCH 19/39] fix check for reshare permissions Signed-off-by: Bjoern Schiessle --- .../lib/ocm/CloudFederationProviderFiles.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php index 0f28abc945..ae2e12bb89 100644 --- a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php +++ b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php @@ -590,7 +590,7 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { $this->verifyShare($share, $token); // check if re-sharing is allowed - if ($share->getPermissions() | ~Constants::PERMISSION_SHARE) { + if ($share->getPermissions() & Constants::PERMISSION_SHARE) { // the recipient of the initial share is now the initiator for the re-share $share->setSharedBy($share->getSharedWith()); $share->setSharedWith($shareWith); From 957b27f28267fd95bec9c8a041ca1e7be9d32aa6 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Thu, 7 Jun 2018 14:40:12 +0200 Subject: [PATCH 20/39] replace \OCP\Federation\Exception\ShareNotFoundException with the generic \OCP\Share\Exception\ShareNotFound exception Signed-off-by: Bjoern Schiessle --- .../Controller/RequestHandlerController.php | 4 +-- .../Controller/RequestHandlerController.php | 21 ++++---------- .../lib/FederatedShareProvider.php | 5 ++-- .../lib/ocm/CloudFederationProviderFiles.php | 28 +++++++++--------- lib/composer/composer/autoload_classmap.php | 4 ++- lib/composer/composer/autoload_static.php | 4 ++- .../Exceptions/ShareNotFoundException.php | 29 ------------------- .../Federation/ICloudFederationProvider.php | 4 +-- lib/public/Share/IShareProvider.php | 3 +- 9 files changed, 33 insertions(+), 69 deletions(-) delete mode 100644 lib/public/Federation/Exceptions/ShareNotFoundException.php diff --git a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php index a7601d1ce1..f79b774770 100644 --- a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php +++ b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php @@ -31,7 +31,6 @@ use OCP\Federation\Exceptions\ActionNotSupportedException; use OCP\Federation\Exceptions\AuthenticationFailedException; use OCP\Federation\Exceptions\BadRequestException; use OCP\Federation\Exceptions\ProviderCouldNotAddShareException; -use OCP\Federation\Exceptions\ShareNotFoundException; use OCP\Federation\ICloudFederationFactory; use OCP\Federation\ICloudFederationProviderManager; use OCP\Federation\Exceptions\ProviderDoesNotExistsException; @@ -40,6 +39,7 @@ use OCP\ILogger; use OCP\IRequest; use OCP\IURLGenerator; use OCP\IUserManager; +use OCP\Share\Exceptions\ShareNotFound; /** @@ -234,7 +234,7 @@ class RequestHandlerController extends Controller { ['message' => $e->getMessage()], Http::STATUS_BAD_REQUEST ); - } catch (ShareNotFoundException $e) { + } catch (ShareNotFound $e) { return new JSONResponse( ['message' => $e->getMessage()], Http::STATUS_BAD_REQUEST diff --git a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php index 653c41c3ba..eb434c30c9 100644 --- a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php +++ b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php @@ -29,7 +29,6 @@ namespace OCA\FederatedFileSharing\Controller; -use OCA\Files_Sharing\Activity\Providers\RemoteShares; use OCA\FederatedFileSharing\AddressHandler; use OCA\FederatedFileSharing\FederatedShareProvider; use OCA\FederatedFileSharing\Notifications; @@ -37,24 +36,19 @@ use OCP\AppFramework\Http; use OCP\AppFramework\OCS\OCSBadRequestException; use OCP\AppFramework\OCS\OCSException; use OCP\AppFramework\OCS\OCSForbiddenException; -use OCP\AppFramework\OCS\OCSNotFoundException; use OCP\AppFramework\OCSController; use OCP\Constants; -use OCP\Federation\Exceptions\AuthenticationFailedException; -use OCP\Federation\Exceptions\BadRequestException; use OCP\Federation\Exceptions\ProviderCouldNotAddShareException; use OCP\Federation\Exceptions\ProviderDoesNotExistsException; -use OCP\Federation\Exceptions\ShareNotFoundException; use OCP\Federation\ICloudFederationFactory; use OCP\Federation\ICloudFederationProviderManager; use OCP\Federation\ICloudIdManager; -use OCP\Files\NotFoundException; use OCP\IDBConnection; use OCP\ILogger; use OCP\IRequest; use OCP\IUserManager; use OCP\Share; -use OCP\Share\IShare; +use OCP\Share\Exceptions\ShareNotFound; class RequestHandlerController extends OCSController { @@ -201,8 +195,8 @@ class RequestHandlerController extends OCSController { * @param int $id * @return Http\DataResponse * @throws OCSBadRequestException + * @throws OCSException * @throws OCSForbiddenException - * @throws OCSNotFoundException */ public function reShare($id) { @@ -236,11 +230,8 @@ class RequestHandlerController extends OCSController { ]); } catch (ProviderDoesNotExistsException $e) { throw new OCSException('Server does not support federated cloud sharing', 503); - } catch (ShareNotFoundException $e) { + } catch (ShareNotFound $e) { $this->logger->debug('Share not found: ' . $e->getMessage()); - } catch (ProviderCouldNotAddShareException $e) { - $this->logger->debug('Could not add reshare: ' . $e->getMessage()); - throw new OCSForbiddenException(); } catch (\Exception $e) { $this->logger->debug('internal server error, can not process notification: ' . $e->getMessage()); } @@ -258,7 +249,7 @@ class RequestHandlerController extends OCSController { * @param int $id * @return Http\DataResponse * @throws OCSException - * @throws Share\Exceptions\ShareNotFound + * @throws ShareNotFound * @throws \OC\HintException */ public function acceptShare($id) { @@ -275,7 +266,7 @@ class RequestHandlerController extends OCSController { $provider->notificationReceived('SHARE_ACCEPTED', $id, $notification); } catch (ProviderDoesNotExistsException $e) { throw new OCSException('Server does not support federated cloud sharing', 503); - } catch (ShareNotFoundException $e) { + } 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()); @@ -308,7 +299,7 @@ class RequestHandlerController extends OCSController { $provider->notificationReceived('SHARE_DECLINED', $id, $notification); } catch (ProviderDoesNotExistsException $e) { throw new OCSException('Server does not support federated cloud sharing', 503); - } catch (ShareNotFoundException $e) { + } 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()); diff --git a/apps/federatedfilesharing/lib/FederatedShareProvider.php b/apps/federatedfilesharing/lib/FederatedShareProvider.php index 370ba44a0b..27fbfeef61 100644 --- a/apps/federatedfilesharing/lib/FederatedShareProvider.php +++ b/apps/federatedfilesharing/lib/FederatedShareProvider.php @@ -30,7 +30,6 @@ namespace OCA\FederatedFileSharing; use OC\Share20\Share; -use OCP\Federation\Exceptions\ShareNotFoundException; use OCP\Federation\ICloudIdManager; use OCP\DB\QueryBuilder\IQueryBuilder; use OCP\Files\Folder; @@ -700,13 +699,13 @@ class FederatedShareProvider implements IShareProvider { $cursor->closeCursor(); if ($data === false) { - throw new ShareNotFoundException('Can not find share with ID: ' . $id); + throw new ShareNotFound('Can not find share with ID: ' . $id); } try { $share = $this->createShareObject($data); } catch (InvalidShare $e) { - throw new ShareNotFoundException(); + throw new ShareNotFound(); } return $share; diff --git a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php index ae2e12bb89..422d008ffd 100644 --- a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php +++ b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php @@ -21,21 +21,18 @@ namespace OCA\FederatedFileSharing\OCM; -use function GuzzleHttp\default_ca_bundle; use OC\AppFramework\Http; use OC\Files\Filesystem; use OCA\Files_Sharing\Activity\Providers\RemoteShares; use OCA\FederatedFileSharing\AddressHandler; use OCA\FederatedFileSharing\FederatedShareProvider; use OCP\Activity\IManager as IActivityManager; -use OCP\Activity\IManager; use OCP\App\IAppManager; use OCP\Constants; use OCP\Federation\Exceptions\ActionNotSupportedException; use OCP\Federation\Exceptions\AuthenticationFailedException; use OCP\Federation\Exceptions\BadRequestException; use OCP\Federation\Exceptions\ProviderCouldNotAddShareException; -use OCP\Federation\Exceptions\ShareNotFoundException; use OCP\Federation\ICloudFederationFactory; use OCP\Federation\ICloudFederationProvider; use OCP\Federation\ICloudFederationProviderManager; @@ -272,7 +269,6 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { * @throws ActionNotSupportedException * @throws AuthenticationFailedException * @throws BadRequestException - * @throws ShareNotFoundException * @throws \OC\HintException * @since 14.0.0 */ @@ -306,7 +302,6 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { * @throws ActionNotSupportedException * @throws AuthenticationFailedException * @throws BadRequestException - * @throws ShareNotFoundException * @throws \OC\HintException */ private function shareAccepted($id, $notification) { @@ -348,14 +343,14 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { /** * @param IShare $share - * @throws ShareNotFoundException + * @throws ShareNotFound */ protected function executeAcceptShare(IShare $share) { try { $fileId = (int)$share->getNode()->getId(); list($file, $link) = $this->getFile($this->getCorrectUid($share), $fileId); } catch (\Exception $e) { - throw new ShareNotFoundException(); + throw new ShareNotFound(); } $event = $this->activityManager->generateEvent(); @@ -378,7 +373,6 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { * @throws AuthenticationFailedException * @throws BadRequestException * @throws ShareNotFound - * @throws ShareNotFoundException * @throws \OC\HintException * */ @@ -425,7 +419,7 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { * delete declined share and create a activity * * @param IShare $share - * @throws ShareNotFoundException + * @throws ShareNotFound */ protected function executeDeclineShare(IShare $share) { $this->federatedShareProvider->removeShareFromTable($share); @@ -434,7 +428,7 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { $fileId = (int)$share->getNode()->getId(); list($file, $link) = $this->getFile($this->getCorrectUid($share), $fileId); } catch (\Exception $e) { - throw new ShareNotFoundException(); + throw new ShareNotFound(); } $event = $this->activityManager->generateEvent(); @@ -456,7 +450,6 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { * @return array * @throws AuthenticationFailedException * @throws BadRequestException - * @throws ShareNotFoundException */ private function undoReshare($id, $notification) { if (!isset($notification['sharedSecret'])) { @@ -471,7 +464,16 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { return []; } - private function unshare($id, $notification) { + /** + * unshare file from self + * + * @param string $id + * @param array $notification + * @return array + * @throws ActionNotSupportedException + * @throws BadRequestException + */ + private function unshare($id, array $notification) { if (!$this->isS2SEnabled(true)) { throw new ActionNotSupportedException("incoming shares disabled!"); @@ -554,7 +556,6 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { * @throws AuthenticationFailedException * @throws BadRequestException * @throws ProviderCouldNotAddShareException - * @throws ShareNotFoundException * @throws ShareNotFound */ protected function reshareRequested($id, $notification) { @@ -613,7 +614,6 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { * @return array * @throws AuthenticationFailedException * @throws BadRequestException - * @throws ShareNotFoundException */ protected function updateResharePermissions($id, $notification) { diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php index 8b5410919c..d2648c2db6 100644 --- a/lib/composer/composer/autoload_classmap.php +++ b/lib/composer/composer/autoload_classmap.php @@ -132,10 +132,12 @@ return array( 'OCP\\Encryption\\IFile' => $baseDir . '/lib/public/Encryption/IFile.php', 'OCP\\Encryption\\IManager' => $baseDir . '/lib/public/Encryption/IManager.php', 'OCP\\Encryption\\Keys\\IStorage' => $baseDir . '/lib/public/Encryption/Keys/IStorage.php', + 'OCP\\Federation\\Exceptions\\ActionNotSupportedException' => $baseDir . '/lib/public/Federation/Exceptions/ActionNotSupportedException.php', + 'OCP\\Federation\\Exceptions\\AuthenticationFailedException' => $baseDir . '/lib/public/Federation/Exceptions/AuthenticationFailedException.php', + 'OCP\\Federation\\Exceptions\\BadRequestException' => $baseDir . '/lib/public/Federation/Exceptions/BadRequestException.php', 'OCP\\Federation\\Exceptions\\ProviderAlreadyExistsException' => $baseDir . '/lib/public/Federation/Exceptions/ProviderAlreadyExistsException.php', 'OCP\\Federation\\Exceptions\\ProviderCouldNotAddShareException' => $baseDir . '/lib/public/Federation/Exceptions/ProviderCouldNotAddShareException.php', 'OCP\\Federation\\Exceptions\\ProviderDoesNotExistsException' => $baseDir . '/lib/public/Federation/Exceptions/ProviderDoesNotExistsException.php', - 'OCP\\Federation\\Exceptions\\ShareNotFoundException' => $baseDir . '/lib/public/Federation/Exceptions/ShareNotFoundException.php', 'OCP\\Federation\\ICloudFederationFactory' => $baseDir . '/lib/public/Federation/ICloudFederationFactory.php', 'OCP\\Federation\\ICloudFederationNotification' => $baseDir . '/lib/public/Federation/ICloudFederationNotification.php', 'OCP\\Federation\\ICloudFederationProvider' => $baseDir . '/lib/public/Federation/ICloudFederationProvider.php', diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php index 36c582ccdb..4a2580fe75 100644 --- a/lib/composer/composer/autoload_static.php +++ b/lib/composer/composer/autoload_static.php @@ -162,10 +162,12 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c 'OCP\\Encryption\\IFile' => __DIR__ . '/../../..' . '/lib/public/Encryption/IFile.php', 'OCP\\Encryption\\IManager' => __DIR__ . '/../../..' . '/lib/public/Encryption/IManager.php', 'OCP\\Encryption\\Keys\\IStorage' => __DIR__ . '/../../..' . '/lib/public/Encryption/Keys/IStorage.php', + 'OCP\\Federation\\Exceptions\\ActionNotSupportedException' => __DIR__ . '/../../..' . '/lib/public/Federation/Exceptions/ActionNotSupportedException.php', + 'OCP\\Federation\\Exceptions\\AuthenticationFailedException' => __DIR__ . '/../../..' . '/lib/public/Federation/Exceptions/AuthenticationFailedException.php', + 'OCP\\Federation\\Exceptions\\BadRequestException' => __DIR__ . '/../../..' . '/lib/public/Federation/Exceptions/BadRequestException.php', 'OCP\\Federation\\Exceptions\\ProviderAlreadyExistsException' => __DIR__ . '/../../..' . '/lib/public/Federation/Exceptions/ProviderAlreadyExistsException.php', 'OCP\\Federation\\Exceptions\\ProviderCouldNotAddShareException' => __DIR__ . '/../../..' . '/lib/public/Federation/Exceptions/ProviderCouldNotAddShareException.php', 'OCP\\Federation\\Exceptions\\ProviderDoesNotExistsException' => __DIR__ . '/../../..' . '/lib/public/Federation/Exceptions/ProviderDoesNotExistsException.php', - 'OCP\\Federation\\Exceptions\\ShareNotFoundException' => __DIR__ . '/../../..' . '/lib/public/Federation/Exceptions/ShareNotFoundException.php', 'OCP\\Federation\\ICloudFederationFactory' => __DIR__ . '/../../..' . '/lib/public/Federation/ICloudFederationFactory.php', 'OCP\\Federation\\ICloudFederationNotification' => __DIR__ . '/../../..' . '/lib/public/Federation/ICloudFederationNotification.php', 'OCP\\Federation\\ICloudFederationProvider' => __DIR__ . '/../../..' . '/lib/public/Federation/ICloudFederationProvider.php', diff --git a/lib/public/Federation/Exceptions/ShareNotFoundException.php b/lib/public/Federation/Exceptions/ShareNotFoundException.php deleted file mode 100644 index 6655d5b443..0000000000 --- a/lib/public/Federation/Exceptions/ShareNotFoundException.php +++ /dev/null @@ -1,29 +0,0 @@ - - * - * @license GNU AGPL version 3 or any later version - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Affero General Public License for more details. - * - * You should have received a copy of the GNU Affero General Public License - * along with this program. If not, see . - * - */ - -namespace OCP\Federation\Exceptions; - - -use OC\HintException; - -class ShareNotFoundException extends HintException { - -} diff --git a/lib/public/Federation/ICloudFederationProvider.php b/lib/public/Federation/ICloudFederationProvider.php index 5260cbf9aa..49a2b4bc77 100644 --- a/lib/public/Federation/ICloudFederationProvider.php +++ b/lib/public/Federation/ICloudFederationProvider.php @@ -25,7 +25,7 @@ use OCP\Federation\Exceptions\ActionNotSupportedException; use OCP\Federation\Exceptions\AuthenticationFailedException; use OCP\Federation\Exceptions\BadRequestException; use OCP\Federation\Exceptions\ProviderCouldNotAddShareException; -use OCP\Federation\Exceptions\ShareNotFoundException; +use \OCP\Share\Exceptions\ShareNotFound; /** * Interface ICloudFederationProvider @@ -68,7 +68,7 @@ interface ICloudFederationProvider { * @param array $notification provider specific notification * @return array $data send back to sender * - * @throws ShareNotFoundException + * @throws ShareNotFound * @throws ActionNotSupportedException * @throws BadRequestException * @throws AuthenticationFailedException diff --git a/lib/public/Share/IShareProvider.php b/lib/public/Share/IShareProvider.php index bcb12de8b8..4a1ac9b8b8 100644 --- a/lib/public/Share/IShareProvider.php +++ b/lib/public/Share/IShareProvider.php @@ -24,7 +24,6 @@ namespace OCP\Share; -use OCP\Federation\Exceptions\ShareNotFoundException; use OCP\Files\Folder; use OCP\Files\Node; @@ -125,7 +124,7 @@ interface IShareProvider { * @param int $id * @param string|null $recipientId * @return \OCP\Share\IShare - * @throws ShareNotFoundException + * @throws ShareNotFound * @since 9.0.0 */ public function getShareById($id, $recipientId = null); From 84fc188dfc73ab16510bc80a6c091d1a017d4368 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Thu, 7 Jun 2018 16:36:26 +0200 Subject: [PATCH 21/39] some minor fixes and clode cleanup Signed-off-by: Bjoern Schiessle --- .../Controller/RequestHandlerController.php | 1 - .../lib/FederatedShareProvider.php | 4 +-- .../lib/ocm/CloudFederationProviderFiles.php | 27 +++++++++---------- .../CloudFederationNotification.php | 7 +++++ .../CloudFederationProviderManager.php | 2 +- .../ActionNotSupportedException.php | 9 +++++++ .../AuthenticationFailedException.php | 10 ++++++- .../Exceptions/BadRequestException.php | 11 ++++++++ .../ProviderAlreadyExistsException.php | 9 +++++++ .../ProviderCouldNotAddShareException.php | 17 ++++++++++++ .../ProviderDoesNotExistsException.php | 9 +++++++ .../Federation/ICloudFederationFactory.php | 7 +++++ .../ICloudFederationNotification.php | 10 +++++-- .../Federation/ICloudFederationShare.php | 7 +++++ lib/public/IServerContainer.php | 1 + 15 files changed, 109 insertions(+), 22 deletions(-) diff --git a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php index f79b774770..518cb88dff 100644 --- a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php +++ b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php @@ -108,7 +108,6 @@ class RequestHandlerController extends Controller { * @param string $ownerDisplayName display name of the user who shared the item * @param string $sharedBy provider specific UID of the user who shared the resource * @param string $sharedByDisplayName display name of the user who shared the resource - * @param string $sharedSecret use to authenticate accross servers * @param array $protocol (e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]]) * @param string $shareType ('group' or 'user' share) * @param $resourceType ('file', 'calendar',...) diff --git a/apps/federatedfilesharing/lib/FederatedShareProvider.php b/apps/federatedfilesharing/lib/FederatedShareProvider.php index 27fbfeef61..5a12f8e9be 100644 --- a/apps/federatedfilesharing/lib/FederatedShareProvider.php +++ b/apps/federatedfilesharing/lib/FederatedShareProvider.php @@ -506,13 +506,13 @@ class FederatedShareProvider implements IShareProvider { * Delete a share (owner unShares the file) * * @param IShare $share + * @throws ShareNotFound + * @throws \OC\HintException */ public function delete(IShare $share) { list(, $remote) = $this->addressHandler->splitUserRemote($share->getSharedWith()); - $isOwner = false; - // if the local user is the owner we can send the unShare request directly... if ($this->userManager->userExists($share->getShareOwner())) { $this->notifications->sendRemoteUnShare($remote, $share->getId(), $share->getToken()); diff --git a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php index 422d008ffd..230af99448 100644 --- a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php +++ b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php @@ -162,7 +162,6 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { list($ownerUid, $remote) = $this->addressHandler->splitUserRemote($share->getOwner()); - $remote = $remote; $token = $share->getShareSecret(); $name = $share->getResourceName(); $owner = $share->getOwnerDisplayName(); @@ -247,7 +246,7 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { } catch (\Exception $e) { $this->logger->logException($e, [ 'message' => 'Server can not add remote share.', - 'level' => Util::ERROR, + 'level' => ILogger::ERROR, 'app' => 'files_sharing' ]); throw new ProviderCouldNotAddShareException('internal server error, was not able to add share from ' . $remote, '', HTTP::STATUS_INTERNAL_SERVER_ERROR); @@ -304,7 +303,7 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { * @throws BadRequestException * @throws \OC\HintException */ - private function shareAccepted($id, $notification) { + private function shareAccepted($id, array $notification) { if (!$this->isS2SEnabled()) { throw new ActionNotSupportedException('Server does not support federated cloud sharing'); @@ -376,7 +375,7 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { * @throws \OC\HintException * */ - protected function shareDeclined($id, $notification) { + protected function shareDeclined($id, array $notification) { if (!$this->isS2SEnabled()) { throw new ActionNotSupportedException('Server does not support federated cloud sharing'); @@ -446,12 +445,12 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { * received the notification that the owner unshared a file from you * * @param string $id - * @param string $notification + * @param array $notification * @return array * @throws AuthenticationFailedException * @throws BadRequestException */ - private function undoReshare($id, $notification) { + private function undoReshare($id, array $notification) { if (!isset($notification['sharedSecret'])) { throw new BadRequestException(['sharedSecret']); } @@ -550,15 +549,15 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { /** * recipient of a share request to re-share the file with another user * - * @param $id - * @param $notification + * @param string $id + * @param array $notification * @return array * @throws AuthenticationFailedException * @throws BadRequestException * @throws ProviderCouldNotAddShareException * @throws ShareNotFound */ - protected function reshareRequested($id, $notification) { + protected function reshareRequested($id, array $notification) { if (!isset($notification['sharedSecret'])) { throw new BadRequestException(['sharedSecret']); @@ -602,7 +601,6 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { throw new ProviderCouldNotAddShareException('resharing not allowed for share: ' . $id); } - throw new BadRequestException([]); } /** @@ -615,7 +613,7 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { * @throws AuthenticationFailedException * @throws BadRequestException */ - protected function updateResharePermissions($id, $notification) { + protected function updateResharePermissions($id, array $notification) { if (!isset($notification['sharedSecret'])) { throw new BadRequestException(['sharedSecret']); @@ -640,12 +638,11 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { /** * translate OCM Permissions to Nextcloud permissions * - * @param $ocmPermissions + * @param array $ocmPermissions * @return int * @throws BadRequestException */ - protected function ocmPermissions2ncPermissions($ocmPermissions) { - error_log("ocm permissions: " . json_encode($ocmPermissions)); + protected function ocmPermissions2ncPermissions(array $ocmPermissions) { $ncPermissions = 0; foreach($ocmPermissions as $permission) { switch (strtolower($permission)) { @@ -701,7 +698,7 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { $args = Filesystem::is_dir($file) ? array('dir' => $file) : array('dir' => dirname($file), 'scrollto' => $file); $link = Util::linkToAbsolute('files', 'index.php', $args); - return array($file, $link); + return [$file, $link]; } diff --git a/lib/private/Federation/CloudFederationNotification.php b/lib/private/Federation/CloudFederationNotification.php index fec69174a2..62af67079e 100644 --- a/lib/private/Federation/CloudFederationNotification.php +++ b/lib/private/Federation/CloudFederationNotification.php @@ -23,6 +23,13 @@ namespace OC\Federation; use OCP\Federation\ICloudFederationNotification; +/** + * Class CloudFederationNotification + * + * @package OC\Federation + * + * @since 14.0.0 + */ class CloudFederationNotification implements ICloudFederationNotification { private $message = []; diff --git a/lib/private/Federation/CloudFederationProviderManager.php b/lib/private/Federation/CloudFederationProviderManager.php index aa25ba9dee..5c26afe13f 100644 --- a/lib/private/Federation/CloudFederationProviderManager.php +++ b/lib/private/Federation/CloudFederationProviderManager.php @@ -200,7 +200,7 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager * @return bool */ public function isReady() { - return $this->appManager->isEnabledForUser('cloud_federation_api', false); + return $this->appManager->isEnabledForUser('cloud_federation_api'); } /** * check if server supports the new OCM api and ask for the correct end-point diff --git a/lib/public/Federation/Exceptions/ActionNotSupportedException.php b/lib/public/Federation/Exceptions/ActionNotSupportedException.php index 7e7fe70f48..2d295bd9d8 100644 --- a/lib/public/Federation/Exceptions/ActionNotSupportedException.php +++ b/lib/public/Federation/Exceptions/ActionNotSupportedException.php @@ -23,11 +23,20 @@ namespace OCP\Federation\Exceptions; use OC\HintException; +/** + * Class ActionNotSupportedException + * + * @package OCP\Federation\Exceptions + * + * @since 14.0.0 + */ class ActionNotSupportedException extends HintException { /** * ActionNotSupportedException constructor. * + * @since 14.0.0 + * */ public function __construct($action) { $l = \OC::$server->getL10N('federation'); diff --git a/lib/public/Federation/Exceptions/AuthenticationFailedException.php b/lib/public/Federation/Exceptions/AuthenticationFailedException.php index a9a412dd83..1ea7ec5cd3 100644 --- a/lib/public/Federation/Exceptions/AuthenticationFailedException.php +++ b/lib/public/Federation/Exceptions/AuthenticationFailedException.php @@ -23,12 +23,20 @@ namespace OCP\Federation\Exceptions; use OC\HintException; +/** + * Class AuthenticationFailedException + * + * @package OCP\Federation\Exceptions + * + * @since 14.0.0 + */ class AuthenticationFailedException extends HintException { /** * BadRequestException constructor. * - * @param array $missingParameters + * @since 14.0.0 + * */ public function __construct() { $l = \OC::$server->getL10N('federation'); diff --git a/lib/public/Federation/Exceptions/BadRequestException.php b/lib/public/Federation/Exceptions/BadRequestException.php index 67cf911c2a..9d9e48157a 100644 --- a/lib/public/Federation/Exceptions/BadRequestException.php +++ b/lib/public/Federation/Exceptions/BadRequestException.php @@ -23,6 +23,13 @@ namespace OCP\Federation\Exceptions; use OC\HintException; +/** + * Class BadRequestException + * + * @package OCP\Federation\Exceptions + * + * @since 14.0.0 + */ class BadRequestException extends HintException { private $parameterList; @@ -30,6 +37,8 @@ class BadRequestException extends HintException { /** * BadRequestException constructor. * + * @since 14.0.0 + * * @param array $missingParameters */ public function __construct(array $missingParameters) { @@ -44,6 +53,8 @@ class BadRequestException extends HintException { /** * get array with the return message as defined in the OCM API * + * @since 14.0.0 + * * @return array */ public function getReturnMessage() { diff --git a/lib/public/Federation/Exceptions/ProviderAlreadyExistsException.php b/lib/public/Federation/Exceptions/ProviderAlreadyExistsException.php index f053a02fbe..e5022500d1 100644 --- a/lib/public/Federation/Exceptions/ProviderAlreadyExistsException.php +++ b/lib/public/Federation/Exceptions/ProviderAlreadyExistsException.php @@ -23,11 +23,20 @@ namespace OCP\Federation\Exceptions; use OC\HintException; +/** + * Class ProviderAlreadyExistsException + * + * @package OCP\Federation\Exceptions + * + * @since 14.0.0 + */ class ProviderAlreadyExistsException extends HintException { /** * ProviderAlreadyExistsException constructor. * + * @since 14.0.0 + * * @param string $newProviderId cloud federation provider ID of the new provider * @param string $existingProviderName name of cloud federation provider which already use the same ID */ diff --git a/lib/public/Federation/Exceptions/ProviderCouldNotAddShareException.php b/lib/public/Federation/Exceptions/ProviderCouldNotAddShareException.php index 205206d5af..80613cc29a 100644 --- a/lib/public/Federation/Exceptions/ProviderCouldNotAddShareException.php +++ b/lib/public/Federation/Exceptions/ProviderCouldNotAddShareException.php @@ -24,8 +24,25 @@ namespace OCP\Federation\Exceptions; use OC\HintException; use OCP\AppFramework\Http; +/** + * Class ProviderCouldNotAddShareException + * + * @package OCP\Federation\Exceptions + * + * @since 14.0.0 + */ class ProviderCouldNotAddShareException extends HintException { + /** + * ProviderCouldNotAddShareException constructor. + * + * @since 14.0.0 + * + * @param string $message + * @param string $hint + * @param int $code + * @param \Exception|null $previous + */ public function __construct($message, $hint = '', $code = Http::STATUS_BAD_REQUEST, \Exception $previous = null) { parent::__construct($message, $hint, $code, $previous); } diff --git a/lib/public/Federation/Exceptions/ProviderDoesNotExistsException.php b/lib/public/Federation/Exceptions/ProviderDoesNotExistsException.php index 8f760d6abf..761fcaf809 100644 --- a/lib/public/Federation/Exceptions/ProviderDoesNotExistsException.php +++ b/lib/public/Federation/Exceptions/ProviderDoesNotExistsException.php @@ -23,11 +23,20 @@ namespace OCP\Federation\Exceptions; use OC\HintException; +/** + * Class ProviderDoesNotExistsException + * + * @package OCP\Federation\Exceptions + * + * @since 14.0.0 + */ class ProviderDoesNotExistsException extends HintException { /** * ProviderDoesNotExistsException constructor. * + * @since 14.0.0 + * * @param string $providerId cloud federation provider ID */ public function __construct($providerId) { diff --git a/lib/public/Federation/ICloudFederationFactory.php b/lib/public/Federation/ICloudFederationFactory.php index 8c6925c2b6..5cb4dc3106 100644 --- a/lib/public/Federation/ICloudFederationFactory.php +++ b/lib/public/Federation/ICloudFederationFactory.php @@ -21,6 +21,13 @@ namespace OCP\Federation; +/** + * Interface ICloudFederationFactory + * + * @package OCP\Federation + * + * @since 14.0.0 + */ interface ICloudFederationFactory { /** diff --git a/lib/public/Federation/ICloudFederationNotification.php b/lib/public/Federation/ICloudFederationNotification.php index c68cd7b5e4..c7ceb6d239 100644 --- a/lib/public/Federation/ICloudFederationNotification.php +++ b/lib/public/Federation/ICloudFederationNotification.php @@ -21,6 +21,13 @@ namespace OCP\Federation; +/** + * Interface ICloudFederationNotification + * + * @package OCP\Federation + * + * @since 14.0.0 + */ interface ICloudFederationNotification { /** @@ -31,7 +38,6 @@ interface ICloudFederationNotification { * @param $providerId id of the share * @param array $notification , payload of the notification * - * @return * @since 14.0.0 */ public function setMessage($notificationType, $resourceType, $providerId, array $notification); @@ -39,7 +45,7 @@ interface ICloudFederationNotification { /** * get message, ready to send out * - * @return string + * @return array * * @since 14.0.0 */ diff --git a/lib/public/Federation/ICloudFederationShare.php b/lib/public/Federation/ICloudFederationShare.php index b721ffb168..fda934d9e8 100644 --- a/lib/public/Federation/ICloudFederationShare.php +++ b/lib/public/Federation/ICloudFederationShare.php @@ -21,6 +21,13 @@ namespace OCP\Federation; +/** + * Interface ICloudFederationShare + * + * @package OCP\Federation + * + * @since 14.0.0 + */ interface ICloudFederationShare { /** diff --git a/lib/public/IServerContainer.php b/lib/public/IServerContainer.php index ebe92274a4..639487660b 100644 --- a/lib/public/IServerContainer.php +++ b/lib/public/IServerContainer.php @@ -557,6 +557,7 @@ interface IServerContainer extends IContainer { /** * @return \OCP\GlobalScale\IConfig + * @since 14.0.0 */ public function getGlobalScaleConfig(); From 34c4527cc44d312fa274aea26986aff748cc5442 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Mon, 11 Jun 2018 11:23:16 +0200 Subject: [PATCH 22/39] add ocm-provider to the list of expected files Signed-off-by: Bjoern Schiessle --- build/files-checker.php | 1 + 1 file changed, 1 insertion(+) diff --git a/build/files-checker.php b/build/files-checker.php index 473955d625..9fa84b58a2 100644 --- a/build/files-checker.php +++ b/build/files-checker.php @@ -66,6 +66,7 @@ $expectedFiles = [ 'occ', 'ocs', 'ocs-provider', + 'ocm-provider', 'public.php', 'README.md', 'remote.php', From 5d0d33a0d4a8cca80ba873140aeca0d3f96a3379 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Mon, 11 Jun 2018 15:29:51 +0200 Subject: [PATCH 23/39] remove unused method Signed-off-by: Bjoern Schiessle --- .../Controller/RequestHandlerController.php | 25 +------------------ 1 file changed, 1 insertion(+), 24 deletions(-) diff --git a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php index eb434c30c9..e0d8299da4 100644 --- a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php +++ b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php @@ -178,7 +178,7 @@ class RequestHandlerController extends OCSController { } catch (ProviderDoesNotExistsException $e) { throw new OCSException('Server does not support federated cloud sharing', 503); } catch (ProviderCouldNotAddShareException $e) { - throw new OCSException($e->getMessage(), $e->getCode()); + throw new OCSException($e->getMessage(), 400); } catch (\Exception $e) { throw new OCSException('internal server error, was not able to add share from ' . $remote, 500); } @@ -369,29 +369,6 @@ class RequestHandlerController extends OCSController { } - /** - * get share - * - * @param int $id - * @param string $token - * @return array|bool - */ - protected function getShare($id, $token) { - $query = $this->connection->getQueryBuilder(); - $query->select('*')->from($this->shareTable) - ->where($query->expr()->eq('token', $query->createNamedParameter($token))) - ->andWhere($query->expr()->eq('share_type', $query->createNamedParameter(FederatedShareProvider::SHARE_TYPE_REMOTE))) - ->andWhere($query->expr()->eq('id', $query->createNamedParameter($id))); - - $result = $query->execute()->fetchAll(); - - if (!empty($result) && isset($result[0])) { - return $result[0]; - } - - return false; - } - /** * check if server-to-server sharing is enabled * From 9d145bb5dd488beee1e04044f201863ee005a73e Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Mon, 11 Jun 2018 15:30:04 +0200 Subject: [PATCH 24/39] update tests Signed-off-by: Bjoern Schiessle --- .../RequestHandlerControllerTest.php | 392 ++++++------------ 1 file changed, 126 insertions(+), 266 deletions(-) diff --git a/apps/federatedfilesharing/tests/Controller/RequestHandlerControllerTest.php b/apps/federatedfilesharing/tests/Controller/RequestHandlerControllerTest.php index cb535f33c6..7edcb56d0c 100644 --- a/apps/federatedfilesharing/tests/Controller/RequestHandlerControllerTest.php +++ b/apps/federatedfilesharing/tests/Controller/RequestHandlerControllerTest.php @@ -29,18 +29,28 @@ namespace OCA\FederatedFileSharing\Tests; +use OC\AppFramework\Http; use OC\Federation\CloudIdManager; use OC\Files\Filesystem; use OCA\FederatedFileSharing\FederatedShareProvider; use OCA\FederatedFileSharing\Controller\RequestHandlerController; +use OCP\AppFramework\Http\DataResponse; +use OCP\Federation\ICloudFederationFactory; +use OCP\Federation\ICloudFederationProvider; +use OCP\Federation\ICloudFederationProviderManager; +use OCP\Federation\ICloudFederationShare; use OCP\Federation\ICloudIdManager; use OCP\Http\Client\IClient; use OCP\Http\Client\IClientService; use OCP\Http\Client\IResponse; use OCP\IConfig; +use OCP\IDBConnection; use OCP\ILogger; +use OCP\IRequest; use OCP\IUserManager; +use OCP\Share; use OCP\Share\IShare; +use PHPUnit\Framework\MockObject\Builder\InvocationMocker; /** * Class RequestHandlerTest @@ -48,19 +58,17 @@ use OCP\Share\IShare; * @package OCA\FederatedFileSharing\Tests * @group DB */ -class RequestHandlerControllerTest extends TestCase { +class RequestHandlerControllerTest extends \Test\TestCase { - const TEST_FOLDER_NAME = '/folder_share_api_test'; + private $owner = 'owner'; + private $user1 = 'user1'; + private $user2 = 'user2'; + private $ownerCloudId = 'owner@server0.org'; + private $user1CloudId = 'user1@server1.org'; + private $user2CloudId = 'user2@server2.org'; - /** - * @var \OCP\IDBConnection - */ - private $connection; - - /** - * @var RequestHandlerController - */ - private $s2s; + /** @var RequestHandlerController */ + private $requestHandler; /** @var \OCA\FederatedFileSharing\FederatedShareProvider|\PHPUnit_Framework_MockObject_MockObject */ private $federatedShareProvider; @@ -77,17 +85,34 @@ class RequestHandlerControllerTest extends TestCase { /** @var IShare|\PHPUnit_Framework_MockObject_MockObject */ private $share; - /** @var ICloudIdManager */ + /** @var ICloudIdManager|\PHPUnit_Framework_MockObject_MockObject */ private $cloudIdManager; /** @var ILogger|\PHPUnit_Framework_MockObject_MockObject */ private $logger; - protected function setUp() { - parent::setUp(); + /** @var IRequest|\PHPUnit_Framework_MockObject_MockObject */ + private $request; - self::loginHelper(self::TEST_FILES_SHARING_API_USER1); - \OC\Share\Share::registerBackend('test', 'Test\Share\Backend'); + /** @var IDBConnection|\PHPUnit_Framework_MockObject_MockObject */ + private $connection; + + /** @var Share\IManager|\PHPUnit_Framework_MockObject_MockObject */ + private $shareManager; + + /** @var ICloudFederationFactory|\PHPUnit_Framework_MockObject_MockObject */ + private $cloudFederationFactory; + + /** @var ICloudFederationProviderManager|\PHPUnit_Framework_MockObject_MockObject */ + private $cloudFederationProviderManager; + + /** @var ICloudFederationProvider|\PHPUnit_Framework_MockObject_MockObject */ + private $cloudFederationProvider; + + /** @var ICloudFederationShare|\PHPUnit_Framework_MockObject_MockObject */ + private $cloudFederationShare; + + protected function setUp() { $this->share = $this->getMockBuilder(IShare::class)->getMock(); $this->federatedShareProvider = $this->getMockBuilder('OCA\FederatedFileSharing\FederatedShareProvider') @@ -104,292 +129,127 @@ class RequestHandlerControllerTest extends TestCase { $this->addressHandler = $this->getMockBuilder('OCA\FederatedFileSharing\AddressHandler') ->disableOriginalConstructor()->getMock(); $this->userManager = $this->getMockBuilder(IUserManager::class)->getMock(); + $this->cloudIdManager = $this->createMock(ICloudIdManager::class); + $this->request = $this->createMock(IRequest::class); + $this->connection = $this->createMock(IDBConnection::class); + $this->shareManager = $this->createMock(Share\IManager::class); + $this->cloudFederationFactory = $this->createMock(ICloudFederationFactory::class); + $this->cloudFederationProviderManager = $this->createMock(ICloudFederationProviderManager::class); + $this->cloudFederationProvider = $this->createMock(ICloudFederationProvider::class); + $this->cloudFederationShare = $this->createMock(ICloudFederationShare::class); - $this->cloudIdManager = new CloudIdManager(); $this->logger = $this->createMock(ILogger::class); - $this->s2s = new RequestHandlerController( + $this->requestHandler = new RequestHandlerController( 'federatedfilesharing', - \OC::$server->getRequest(), + $this->request, $this->federatedShareProvider, - \OC::$server->getDatabaseConnection(), - \OC::$server->getShareManager(), + $this->connection, + $this->shareManager, $this->notifications, $this->addressHandler, $this->userManager, $this->cloudIdManager, - $this->logger + $this->logger, + $this->cloudFederationFactory, + $this->cloudFederationProviderManager ); - $this->connection = \OC::$server->getDatabaseConnection(); } - protected function tearDown() { - $qb = $this->connection->getQueryBuilder(); - $qb->delete('share_external'); - $qb->execute(); - - $qb = $this->connection->getQueryBuilder(); - $qb->delete('share'); - $qb->execute(); - - parent::tearDown(); - } - - /** - * @medium - */ function testCreateShare() { // simulate a post request $_POST['remote'] = 'localhost'; $_POST['token'] = 'token'; $_POST['name'] = 'name'; - $_POST['owner'] = 'owner'; - $_POST['shareWith'] = self::TEST_FILES_SHARING_API_USER2; + $_POST['owner'] = $this->owner; + $_POST['sharedBy'] = $this->user1; + $_POST['shareWith'] = $this->user2; $_POST['remoteId'] = 1; + $_POST['sharedByFederatedId'] = $this->user1CloudId; + $_POST['ownerFederatedId'] = $this->ownerCloudId; - $this->s2s->createShare(null); + $this->cloudFederationFactory->expects($this->once())->method('getCloudFederationShare') + ->with( + $this->user2, + 'name', + '', + 1, + $this->ownerCloudId, + $this->owner, + $this->user1CloudId, + $this->user1, + 'token', + 'user', + 'file' + )->willReturn($this->cloudFederationShare); - $qb = $this->connection->getQueryBuilder(); - $qb->select('*') - ->from('share_external') - ->where( - $qb->expr()->eq('remote_id', $qb->createNamedParameter(1)) - ); - $result = $qb->execute(); - $data = $result->fetch(); - $result->closeCursor(); + /** @var ICloudFederationProvider|\PHPUnit_Framework_MockObject_MockObject $provider */ + $this->cloudFederationProviderManager->expects($this->once()) + ->method('getCloudFederationProvider') + ->with('file') + ->willReturn($this->cloudFederationProvider); + + $this->cloudFederationProvider->expects($this->once())->method('shareReceived') + ->with($this->cloudFederationShare); + + $result = $this->requestHandler->createShare(); + + $this->assertInstanceOf(DataResponse::class, $result); - $this->assertSame('localhost', $data['remote']); - $this->assertSame('token', $data['share_token']); - $this->assertSame('/name', $data['name']); - $this->assertSame('owner', $data['owner']); - $this->assertSame(self::TEST_FILES_SHARING_API_USER2, $data['user']); - $this->assertSame(1, (int)$data['remote_id']); - $this->assertSame(0, (int)$data['accepted']); } - function testDeclineShare() { - $this->s2s = $this->getMockBuilder('\OCA\FederatedFileSharing\Controller\RequestHandlerController') - ->setConstructorArgs( - [ - 'federatedfilessharing', - \OC::$server->getRequest(), - $this->federatedShareProvider, - \OC::$server->getDatabaseConnection(), - \OC::$server->getShareManager(), - $this->notifications, - $this->addressHandler, - $this->userManager, - $this->cloudIdManager, - $this->logger, - ] - )->setMethods(['executeDeclineShare', 'verifyShare'])->getMock(); - - $this->s2s->expects($this->once())->method('executeDeclineShare'); - - $this->s2s->expects($this->any())->method('verifyShare')->willReturn(true); - + $id = 42; $_POST['token'] = 'token'; - $this->s2s->declineShare(42); - - } - - function XtestDeclineShareMultiple() { - - $this->share->expects($this->any())->method('verifyShare')->willReturn(true); - - $dummy = \OC_DB::prepare(' - INSERT INTO `*PREFIX*share` - (`share_type`, `uid_owner`, `item_type`, `item_source`, `item_target`, `file_source`, `file_target`, `permissions`, `stime`, `token`, `share_with`) - VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?) - '); - $dummy->execute(array(\OCP\Share::SHARE_TYPE_REMOTE, self::TEST_FILES_SHARING_API_USER1, 'test', '1', '/1', '1', '/test.txt', '1', time(), 'token1', 'foo@bar')); - $dummy->execute(array(\OCP\Share::SHARE_TYPE_REMOTE, self::TEST_FILES_SHARING_API_USER1, 'test', '1', '/1', '1', '/test.txt', '1', time(), 'token2', 'bar@bar')); - - $verify = \OC_DB::prepare('SELECT * FROM `*PREFIX*share`'); - $result = $verify->execute(); - $data = $result->fetchAll(); - $this->assertCount(2, $data); - - $_POST['token'] = 'token1'; - $this->s2s->declineShare(array('id' => $data[0]['id'])); - - $verify = \OC_DB::prepare('SELECT * FROM `*PREFIX*share`'); - $result = $verify->execute(); - $data = $result->fetchAll(); - $this->assertCount(1, $data); - $this->assertEquals('bar@bar', $data[0]['share_with']); - - $_POST['token'] = 'token2'; - $this->s2s->declineShare(array('id' => $data[0]['id'])); - - $verify = \OC_DB::prepare('SELECT * FROM `*PREFIX*share`'); - $result = $verify->execute(); - $data = $result->fetchAll(); - $this->assertEmpty($data); - } - - /** - * @dataProvider dataTestDeleteUser - */ - function testDeleteUser($toDelete, $expected, $remainingUsers) { - $this->createDummyS2SShares(); - - $httpClientService = $this->createMock(IClientService::class); - $client = $this->createMock(IClient::class); - $response = $this->createMock(IResponse::class); - $client - ->expects($this->any()) - ->method('get') - ->willReturn($response); - $client - ->expects($this->any()) - ->method('post') - ->willReturn($response); - $httpClientService - ->expects($this->any()) - ->method('newClient') - ->willReturn($client); - - $manager = new \OCA\Files_Sharing\External\Manager( - \OC::$server->getDatabaseConnection(), - Filesystem::getMountManager(), - Filesystem::getLoader(), - $httpClientService, - \OC::$server->getNotificationManager(), - \OC::$server->query(\OCP\OCS\IDiscoveryService::class), - $toDelete - ); - - $manager->removeUserShares($toDelete); - - $query = $this->connection->prepare('SELECT `user` FROM `*PREFIX*share_external`'); - $query->execute(); - $result = $query->fetchAll(); - - foreach ($result as $r) { - $remainingShares[$r['user']] = isset($remainingShares[$r['user']]) ? $remainingShares[$r['user']] + 1 : 1; - } - - $this->assertSame($remainingUsers, count($remainingShares)); - - foreach ($expected as $key => $value) { - if ($key === $toDelete) { - $this->assertArrayNotHasKey($key, $remainingShares); - } else { - $this->assertSame($value, $remainingShares[$key]); - } - } - - } - - function dataTestDeleteUser() { - return array( - array('user1', array('user1' => 0, 'user2' => 3, 'user3' => 3), 2), - array('user2', array('user1' => 4, 'user2' => 0, 'user3' => 3), 2), - array('user3', array('user1' => 4, 'user2' => 3, 'user3' => 0), 2), - array('user4', array('user1' => 4, 'user2' => 3, 'user3' => 3), 3), - ); - } - - private function createDummyS2SShares() { - $query = $this->connection->prepare(' - INSERT INTO `*PREFIX*share_external` - (`remote`, `share_token`, `password`, `name`, `owner`, `user`, `mountpoint`, `mountpoint_hash`, `remote_id`, `accepted`) - VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?) - '); - - $users = array('user1', 'user2', 'user3'); - - for ($i = 0; $i < 10; $i++) { - $user = $users[$i%3]; - $query->execute(array('remote', 'token', 'password', 'name', 'owner', $user, 'mount point', $i, $i, 0)); - } - - $query = $this->connection->prepare('SELECT `id` FROM `*PREFIX*share_external`'); - $query->execute(); - $dummyEntries = $query->fetchAll(); - - $this->assertSame(10, count($dummyEntries)); - } - - /** - * @dataProvider dataTestGetShare - * - * @param bool $found - * @param bool $correctId - * @param bool $correctToken - */ - public function testGetShare($found, $correctId, $correctToken) { - - $connection = \OC::$server->getDatabaseConnection(); - $query = $connection->getQueryBuilder(); - $stime = time(); - $query->insert('share') - ->values( - [ - 'share_type' => $query->createNamedParameter(FederatedShareProvider::SHARE_TYPE_REMOTE), - 'uid_owner' => $query->createNamedParameter(self::TEST_FILES_SHARING_API_USER1), - 'uid_initiator' => $query->createNamedParameter(self::TEST_FILES_SHARING_API_USER2), - 'item_type' => $query->createNamedParameter('test'), - 'item_source' => $query->createNamedParameter('1'), - 'item_target' => $query->createNamedParameter('/1'), - 'file_source' => $query->createNamedParameter('1'), - 'file_target' => $query->createNamedParameter('/test.txt'), - 'permissions' => $query->createNamedParameter('1'), - 'stime' => $query->createNamedParameter($stime), - 'token' => $query->createNamedParameter('token'), - 'share_with' => $query->createNamedParameter('foo@bar'), - ] - )->execute(); - $id = $query->getLastInsertId(); - - $expected = [ - 'share_type' => (string)FederatedShareProvider::SHARE_TYPE_REMOTE, - 'uid_owner' => self::TEST_FILES_SHARING_API_USER1, - 'item_type' => 'test', - 'item_source' => '1', - 'item_target' => '/1', - 'file_source' => '1', - 'file_target' => '/test.txt', - 'permissions' => '1', - 'stime' => (string)$stime, - 'token' => 'token', - 'share_with' => 'foo@bar', - 'id' => (string)$id, - 'uid_initiator' => self::TEST_FILES_SHARING_API_USER2, - 'parent' => null, - 'accepted' => '0', - 'expiration' => null, - 'password' => null, - 'mail_send' => '0', - 'share_name' => null, + $notification = [ + 'sharedSecret' => 'token', + 'message' => 'Recipient declined the share' ]; - $searchToken = $correctToken ? 'token' : 'wrongToken'; - $searchId = $correctId ? $id : -1; + $this->cloudFederationProviderManager->expects($this->once()) + ->method('getCloudFederationProvider') + ->with('file') + ->willReturn($this->cloudFederationProvider); - $result = $this->invokePrivate($this->s2s, 'getShare', [$searchId, $searchToken]); + $this->cloudFederationProvider->expects($this->once()) + ->method('notificationReceived') + ->with('SHARE_DECLINED', $id, $notification); + + $result = $this->requestHandler->declineShare($id); + + $this->assertInstanceOf(DataResponse::class, $result); - if ($found) { - $this->assertEquals($expected, $result); - } else { - $this->assertSame(false, $result); - } } - public function dataTestGetShare() { - return [ - [true, true, true], - [false, false, true], - [false, true, false], - [false, false, false], + + function testAcceptShare() { + + $id = 42; + $_POST['token'] = 'token'; + + $notification = [ + 'sharedSecret' => 'token', + 'message' => 'Recipient accept the share' ]; + + $this->cloudFederationProviderManager->expects($this->once()) + ->method('getCloudFederationProvider') + ->with('file') + ->willReturn($this->cloudFederationProvider); + + $this->cloudFederationProvider->expects($this->once()) + ->method('notificationReceived') + ->with('SHARE_ACCEPTED', $id, $notification); + + $result = $this->requestHandler->acceptShare($id); + + $this->assertInstanceOf(DataResponse::class, $result); + } + } From 2e19213695d8bf9bc55eb57f4db9c7f04e8cc6fe Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Tue, 12 Jun 2018 16:00:43 +0200 Subject: [PATCH 25/39] fix notification tests Signed-off-by: Bjoern Schiessle --- .../tests/NotificationsTest.php | 23 +++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/apps/federatedfilesharing/tests/NotificationsTest.php b/apps/federatedfilesharing/tests/NotificationsTest.php index c2ad1b2030..4c491ba2f9 100644 --- a/apps/federatedfilesharing/tests/NotificationsTest.php +++ b/apps/federatedfilesharing/tests/NotificationsTest.php @@ -29,6 +29,8 @@ namespace OCA\FederatedFileSharing\Tests; use OCA\FederatedFileSharing\AddressHandler; use OCA\FederatedFileSharing\Notifications; use OCP\BackgroundJob\IJobList; +use OCP\Federation\ICloudFederationFactory; +use OCP\Federation\ICloudFederationProviderManager; use OCP\Http\Client\IClientService; use OCP\OCS\IDiscoveryService; @@ -46,6 +48,12 @@ class NotificationsTest extends \Test\TestCase { /** @var IJobList | \PHPUnit_Framework_MockObject_MockObject */ private $jobList; + /** @var ICloudFederationProviderManager|\PHPUnit_Framework_MockObject_MockObject */ + private $cloudFederationProviderManager; + + /** @var ICloudFederationFactory|\PHPUnit_Framework_MockObject_MockObject */ + private $cloudFederationFactory; + public function setUp() { parent::setUp(); @@ -54,6 +62,8 @@ class NotificationsTest extends \Test\TestCase { $this->httpClientService = $this->getMockBuilder('OCP\Http\Client\IClientService')->getMock(); $this->addressHandler = $this->getMockBuilder('OCA\FederatedFileSharing\AddressHandler') ->disableOriginalConstructor()->getMock(); + $this->cloudFederationProviderManager = $this->createMock(ICloudFederationProviderManager::class); + $this->cloudFederationFactory = $this->createMock(ICloudFederationFactory::class); } @@ -69,7 +79,9 @@ class NotificationsTest extends \Test\TestCase { $this->addressHandler, $this->httpClientService, $this->discoveryService, - $this->jobList + $this->jobList, + $this->cloudFederationProviderManager, + $this->cloudFederationFactory ); } else { $instance = $this->getMockBuilder('OCA\FederatedFileSharing\Notifications') @@ -78,7 +90,9 @@ class NotificationsTest extends \Test\TestCase { $this->addressHandler, $this->httpClientService, $this->discoveryService, - $this->jobList + $this->jobList, + $this->cloudFederationProviderManager, + $this->cloudFederationFactory ] )->setMethods($mockedMethods)->getMock(); } @@ -99,12 +113,13 @@ class NotificationsTest extends \Test\TestCase { $id = 42; $timestamp = 63576; $token = 'token'; + $action = 'unshare'; $instance = $this->getInstance(['tryHttpPostToShareEndpoint', 'getTimestamp']); $instance->expects($this->any())->method('getTimestamp')->willReturn($timestamp); $instance->expects($this->once())->method('tryHttpPostToShareEndpoint') - ->with($remote, '/'.$id.'/unshare', ['token' => $token, 'data1Key' => 'data1Value']) + ->with($remote, '/'.$id.'/unshare', ['token' => $token, 'data1Key' => 'data1Value', 'remoteId' => $id], $action) ->willReturn($httpRequestResult); // only add background job on first try @@ -127,7 +142,7 @@ class NotificationsTest extends \Test\TestCase { } $this->assertSame($expected, - $instance->sendUpdateToRemote($remote, $id, $token, 'unshare', ['data1Key' => 'data1Value'], $try) + $instance->sendUpdateToRemote($remote, $id, $token, $action, ['data1Key' => 'data1Value'], $try) ); } From 9365fd2534eeff4cc0804a1ee794ed89b986bb1d Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Tue, 12 Jun 2018 16:20:53 +0200 Subject: [PATCH 26/39] fix external manager tests Signed-off-by: Bjoern Schiessle --- .../tests/External/ManagerTest.php | 39 ++++++++++++++----- 1 file changed, 29 insertions(+), 10 deletions(-) diff --git a/apps/files_sharing/tests/External/ManagerTest.php b/apps/files_sharing/tests/External/ManagerTest.php index 6756f91fb7..2cc88160a8 100644 --- a/apps/files_sharing/tests/External/ManagerTest.php +++ b/apps/files_sharing/tests/External/ManagerTest.php @@ -32,6 +32,8 @@ use OC\Files\Storage\StorageFactory; use OCA\Files_Sharing\External\Manager; use OCA\Files_Sharing\External\MountProvider; use OCA\Files_Sharing\Tests\TestCase; +use OCP\Federation\ICloudFederationFactory; +use OCP\Federation\ICloudFederationProviderManager; use OCP\Http\Client\IClientService; use Test\Traits\UserTrait; @@ -45,7 +47,7 @@ use Test\Traits\UserTrait; class ManagerTest extends TestCase { use UserTrait; - /** @var Manager **/ + /** @var Manager|\PHPUnit_Framework_MockObject_MockObject **/ private $manager; /** @var \OC\Files\Mount\Manager */ @@ -54,6 +56,12 @@ class ManagerTest extends TestCase { /** @var IClientService|\PHPUnit_Framework_MockObject_MockObject */ private $clientService; + /** @var ICloudFederationProviderManager|\PHPUnit_Framework_MockObject_MockObject */ + private $cloudFederationProviderManager; + + /** @var ICloudFederationFactory|\PHPUnit_Framework_MockObject_MockObject */ + private $cloudFederationFactory; + private $uid; /** @@ -71,16 +79,24 @@ class ManagerTest extends TestCase { $this->mountManager = new \OC\Files\Mount\Manager(); $this->clientService = $this->getMockBuilder(IClientService::class) ->disableOriginalConstructor()->getMock(); + $this->cloudFederationProviderManager = $this->createMock(ICloudFederationProviderManager::class); + $this->cloudFederationFactory = $this->createMock(ICloudFederationFactory::class); + + $this->manager = $this->getMockBuilder(Manager::class) + ->setConstructorArgs( + [ + \OC::$server->getDatabaseConnection(), + $this->mountManager, + new StorageFactory(), + $this->clientService, + \OC::$server->getNotificationManager(), + \OC::$server->query(\OCP\OCS\IDiscoveryService::class), + $this->cloudFederationProviderManager, + $this->cloudFederationFactory, + $this->uid + ] + )->setMethods(['tryOCMEndPoint'])->getMock(); - $this->manager = new Manager( - \OC::$server->getDatabaseConnection(), - $this->mountManager, - new StorageFactory(), - $this->clientService, - \OC::$server->getNotificationManager(), - \OC::$server->query(\OCP\OCS\IDiscoveryService::class), - $this->uid - ); $this->testMountProvider = new MountProvider(\OC::$server->getDatabaseConnection(), function() { return $this->manager; }, new CloudIdManager()); @@ -109,6 +125,9 @@ class ManagerTest extends TestCase { $shareData3 = $shareData1; $shareData3['token'] = 'token3'; + $this->manager->expects($this->at(0))->method('tryOCMEndPoint')->with('http://localhost', 'token1', -1, 'accept')->willReturn(false); + $this->manager->expects($this->at(1))->method('tryOCMEndPoint')->with('http://localhost', 'token3', -1, 'decline')->willReturn(false); + // Add a share for "user" $this->assertSame(null, call_user_func_array([$this->manager, 'addShare'], $shareData1)); $openShares = $this->manager->getOpenShares(); From 21b8a873d5c93e5d815fd37bfcbf1d5ed162d12d Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Tue, 12 Jun 2018 16:58:30 +0200 Subject: [PATCH 27/39] implement config check Signed-off-by: Bjoern Schiessle --- apps/cloud_federation_api/lib/Config.php | 26 +++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/apps/cloud_federation_api/lib/Config.php b/apps/cloud_federation_api/lib/Config.php index 90c36a4f79..386f27b199 100644 --- a/apps/cloud_federation_api/lib/Config.php +++ b/apps/cloud_federation_api/lib/Config.php @@ -21,6 +21,8 @@ namespace OCA\CloudFederationAPI; +use OCP\GlobalScale\IConfig as IGsConfig; +use OCP\IConfig; /** @@ -32,15 +34,33 @@ namespace OCA\CloudFederationAPI; */ class Config { - public function __construct() { + /** @var IGsConfig */ + private $gsConfig; + + /** @var IConfig */ + private $config; + + public function __construct(IGsConfig $globalScaleConfig, IConfig $config) { + $this->gsConfig = $globalScaleConfig; + $this->config = $config; } public function incomingRequestsEnabled() { - return true; + if ($this->gsConfig->onlyInternalFederation()) { + return false; + } + $result = $this->config->getAppValue('files_sharing', 'incoming_server2server_share_enabled', 'yes'); + return ($result === 'yes'); } public function outgoingRequestsEnabled() { - return true; + + if ($this->gsConfig->onlyInternalFederation()) { + return false; + } + $result = $this->config->getAppValue('files_sharing', 'outgoing_server2server_share_enabled', 'yes'); + return ($result === 'yes'); + } } From 27814127ddce1c1859fdd42890262144aa410314 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Tue, 12 Jun 2018 20:07:27 +0200 Subject: [PATCH 28/39] make sure that remote url gets stored with a trailing '/' Signed-off-by: Bjoern Schiessle --- .../lib/ocm/CloudFederationProviderFiles.php | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php index 230af99448..8191d5065c 100644 --- a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php +++ b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php @@ -161,6 +161,11 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { } list($ownerUid, $remote) = $this->addressHandler->splitUserRemote($share->getOwner()); + // for backward compatibility make sure that the remote url stored in the + // database ends with a trailing slash + if (substr($remote, -1) !== '/') { + $remote = $remote . '/'; + } $token = $share->getShareSecret(); $name = $share->getResourceName(); From 22d92461346a795ed9ec7047ba191f02db81c4d1 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Wed, 13 Jun 2018 11:57:00 +0200 Subject: [PATCH 29/39] send the display name back after a federated share was received Signed-off-by: Bjoern Schiessle --- .../lib/Controller/RequestHandlerController.php | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php index 518cb88dff..2020dcce01 100644 --- a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php +++ b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php @@ -186,8 +186,14 @@ class RequestHandlerController extends Controller { ); } + $user = $this->userManager->get($shareWithLocalId); + $recipientDisplayName = ''; + if($user) { + $recipientDisplayName = $user->getDisplayName(); + } + return new JSONResponse( - ['id' => $id, 'createdAt' => time()], + ['recipientDisplayName' => $recipientDisplayName], Http::STATUS_CREATED); } From 5c8b26248b58d89f6225e2042fc95dda1823e67e Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Wed, 13 Jun 2018 14:33:11 +0200 Subject: [PATCH 30/39] let the actual federated share provider check if incoming/outgoing shares are enabled for the specific resource type Signed-off-by: Bjoern Schiessle --- .../lib/Controller/RequestHandlerController.php | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php index 2020dcce01..27dd89f2ab 100644 --- a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php +++ b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php @@ -117,13 +117,6 @@ class RequestHandlerController extends Controller { */ public function addShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) { - if (!$this->config->incomingRequestsEnabled()) { - return new JSONResponse( - ['message' => 'This server doesn\'t support outgoing federated shares'], - Http::STATUS_NOT_IMPLEMENTED - ); - } - // check if all required parameters are set if ($shareWith === null || $name === null || @@ -212,12 +205,6 @@ class RequestHandlerController extends Controller { * @return JSONResponse */ public function receiveNotification($notificationType, $resourceType, $providerId, array $notification) { - if (!$this->config->incomingRequestsEnabled()) { - return new JSONResponse( - ['message' => 'This server doesn\'t support outgoing federated shares'], - Http::STATUS_NOT_IMPLEMENTED - ); - } // check if all required parameters are set if ($notificationType === null || From e251b34a8c5ba0c06ff8eecf73374895180f7d03 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Wed, 13 Jun 2018 14:34:03 +0200 Subject: [PATCH 31/39] cleanup variable naming, it is actually a resource type Signed-off-by: Bjoern Schiessle --- .../CloudFederationProviderManager.php | 22 +++++++++---------- .../ICloudFederationProviderManager.php | 14 ++++++------ 2 files changed, 17 insertions(+), 19 deletions(-) diff --git a/lib/private/Federation/CloudFederationProviderManager.php b/lib/private/Federation/CloudFederationProviderManager.php index 5c26afe13f..2776ad8cac 100644 --- a/lib/private/Federation/CloudFederationProviderManager.php +++ b/lib/private/Federation/CloudFederationProviderManager.php @@ -82,15 +82,13 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager /** * Registers an callback function which must return an cloud federation provider * - * @param string $shareType which share type does the provider handles + * @param string $resourceType which resource type does the provider handles * @param string $displayName user facing name of the federated share provider * @param callable $callback */ - public function addCloudFederationProvider($shareType, $displayName, callable $callback) { - \OC::$server->getRemoteApiFactory(); - - $this->cloudFederationProvider[$shareType] = [ - 'shareType' => $shareType, + public function addCloudFederationProvider($resourceType, $displayName, callable $callback) { + $this->cloudFederationProvider[$resourceType] = [ + 'resourceType' => $resourceType, 'displayName' => $displayName, 'callback' => $callback, ]; @@ -109,7 +107,7 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager /** * get a list of all cloudFederationProviders * - * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]] + * @return array [resourceType => ['resourceType' => $resourceType, 'displayName' => $displayName, 'callback' => callback]] */ public function getAllCloudFederationProviders() { return $this->cloudFederationProvider; @@ -118,15 +116,15 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager /** * get a specific cloud federation provider * - * @param string $shareType + * @param string $resourceType * @return ICloudFederationProvider * @throws ProviderDoesNotExistsException */ - public function getCloudFederationProvider($shareType) { - if (isset($this->cloudFederationProvider[$shareType])) { - return call_user_func($this->cloudFederationProvider[$shareType]['callback']); + public function getCloudFederationProvider($resourceType) { + if (isset($this->cloudFederationProvider[$resourceType])) { + return call_user_func($this->cloudFederationProvider[$resourceType]['callback']); } else { - throw new ProviderDoesNotExistsException($shareType); + throw new ProviderDoesNotExistsException($resourceType); } } diff --git a/lib/public/Federation/ICloudFederationProviderManager.php b/lib/public/Federation/ICloudFederationProviderManager.php index 7a14e49a7b..94bbe3ed21 100644 --- a/lib/public/Federation/ICloudFederationProviderManager.php +++ b/lib/public/Federation/ICloudFederationProviderManager.php @@ -35,28 +35,28 @@ interface ICloudFederationProviderManager { /** * Registers an callback function which must return an cloud federation provider * - * @param string $shareType which share type does the provider handles + * @param string $resourceType which resource type does the provider handles * @param string $displayName user facing name of the federated share provider * @param callable $callback * @throws Exceptions\ProviderAlreadyExistsException * * @since 14.0.0 */ - public function addCloudFederationProvider($shareType, $displayName, callable $callback); + public function addCloudFederationProvider($resourceType, $displayName, callable $callback); /** * remove cloud federation provider * - * @param string $shareType + * @param string $resourceType * * @since 14.0.0 */ - public function removeCloudFederationProvider($shareType); + public function removeCloudFederationProvider($resourceType); /** * get a list of all cloudFederationProviders * - * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]] + * @return array [resourceType => ['resourceType' => $resourceType, 'displayName' => $displayName, 'callback' => callback]] * * @since 14.0.0 */ @@ -65,13 +65,13 @@ interface ICloudFederationProviderManager { /** * get a specific cloud federation provider * - * @param string $shareType + * @param string $resourceType * @return ICloudFederationProvider * @throws Exceptions\ProviderDoesNotExistsException; * * @since 14.0.0 */ - public function getCloudFederationProvider($shareType); + public function getCloudFederationProvider($resourceType); /** * send federated share From 8d4da30bf59ca12a81f13ea93b7fdd6c84cb1c2b Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Wed, 13 Jun 2018 14:46:23 +0200 Subject: [PATCH 32/39] add support for different share types Signed-off-by: Bjoern Schiessle --- apps/cloud_federation_api/lib/Config.php | 39 +++++++------------ .../lib/ocm/CloudFederationProviderFiles.php | 10 +++++ .../Federation/ICloudFederationProvider.php | 9 +++++ 3 files changed, 34 insertions(+), 24 deletions(-) diff --git a/apps/cloud_federation_api/lib/Config.php b/apps/cloud_federation_api/lib/Config.php index 386f27b199..7d42960dea 100644 --- a/apps/cloud_federation_api/lib/Config.php +++ b/apps/cloud_federation_api/lib/Config.php @@ -21,6 +21,7 @@ namespace OCA\CloudFederationAPI; +use OCP\Federation\ICloudFederationProviderManager; use OCP\GlobalScale\IConfig as IGsConfig; use OCP\IConfig; @@ -34,33 +35,23 @@ use OCP\IConfig; */ class Config { - /** @var IGsConfig */ - private $gsConfig; + /** @var ICloudFederationProviderManager */ + private $cloudFederationProviderManager; - /** @var IConfig */ - private $config; - - public function __construct(IGsConfig $globalScaleConfig, IConfig $config) { - $this->gsConfig = $globalScaleConfig; - $this->config = $config; + public function __construct(ICloudFederationProviderManager $cloudFederationProviderManager) { + $this->cloudFederationProviderManager = $cloudFederationProviderManager; } - public function incomingRequestsEnabled() { - if ($this->gsConfig->onlyInternalFederation()) { - return false; - } - $result = $this->config->getAppValue('files_sharing', 'incoming_server2server_share_enabled', 'yes'); - return ($result === 'yes'); - } - - public function outgoingRequestsEnabled() { - - if ($this->gsConfig->onlyInternalFederation()) { - return false; - } - $result = $this->config->getAppValue('files_sharing', 'outgoing_server2server_share_enabled', 'yes'); - return ($result === 'yes'); - + /** + * 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(); } } diff --git a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php index 8191d5065c..cf40a6381d 100644 --- a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php +++ b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php @@ -764,4 +764,14 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { } + /** + * get the supported share types, e.g. "user", "group", etc. + * + * @return array + * + * @since 14.0.0 + */ + public function getSupportedShareTypes() { + return ['user']; + } } diff --git a/lib/public/Federation/ICloudFederationProvider.php b/lib/public/Federation/ICloudFederationProvider.php index 49a2b4bc77..b3574535cb 100644 --- a/lib/public/Federation/ICloudFederationProvider.php +++ b/lib/public/Federation/ICloudFederationProvider.php @@ -77,4 +77,13 @@ interface ICloudFederationProvider { */ public function notificationReceived($notificationType, $providerId, array $notification); + /** + * get the supported share types, e.g. "user", "group", etc. + * + * @return array + * + * @since 14.0.0 + */ + public function getSupportedShareTypes(); + } From cfb3e80d1bb549383d86ca795749d78c7eacfcf1 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Thu, 14 Jun 2018 11:15:02 +0200 Subject: [PATCH 33/39] remove the makefile --- apps/cloud_federation_api/Makefile | 50 ------------------------------ 1 file changed, 50 deletions(-) delete mode 100644 apps/cloud_federation_api/Makefile diff --git a/apps/cloud_federation_api/Makefile b/apps/cloud_federation_api/Makefile deleted file mode 100644 index bfaffcb4b1..0000000000 --- a/apps/cloud_federation_api/Makefile +++ /dev/null @@ -1,50 +0,0 @@ -app_name=end_to_end_encryption - -project_dir=$(CURDIR)/../$(app_name) -build_dir=$(CURDIR)/build/artifacts -appstore_dir=$(build_dir)/appstore -source_dir=$(build_dir)/source -sign_dir=$(build_dir)/sign -package_name=$(app_name) -cert_dir=$(HOME)/.nextcloud/certificates -version+=1.0.1 - -all: appstore - -release: appstore create-tag - -create-tag: - git tag -s -a v$(version) -m "Tagging the $(version) release." - git push origin v$(version) - -clean: - rm -rf $(build_dir) - rm -rf node_modules - -appstore: clean - mkdir -p $(sign_dir) - rsync -a \ - --exclude=/build \ - --exclude=/docs \ - --exclude=/l10n/templates \ - --exclude=/l10n/.tx \ - --exclude=/tests \ - --exclude=/.git \ - --exclude=/.github \ - --exclude=/l10n/l10n.pl \ - --exclude=/CONTRIBUTING.md \ - --exclude=/issue_template.md \ - --exclude=/README.md \ - --exclude=/.gitattributes \ - --exclude=/.gitignore \ - --exclude=/.scrutinizer.yml \ - --exclude=/.drone.yml \ - --exclude=/.travis.yml \ - --exclude=/Makefile \ - $(project_dir)/ $(sign_dir)/$(app_name) - tar -czf $(build_dir)/$(app_name)-$(version).tar.gz \ - -C $(sign_dir) $(app_name) - @if [ -f $(cert_dir)/$(app_name).key ]; then \ - echo "Signing package…"; \ - openssl dgst -sha512 -sign $(cert_dir)/$(app_name).key $(build_dir)/$(app_name)-$(version).tar.gz | openssl base64; \ - fi From 086e7a0aa2556cdcba1e246875448f9616ef3b72 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Mon, 18 Jun 2018 10:00:36 +0200 Subject: [PATCH 34/39] remove debug output --- .../lib/ocm/CloudFederationProviderFiles.php | 1 - 1 file changed, 1 deletion(-) diff --git a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php index cf40a6381d..00750f924e 100644 --- a/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php +++ b/apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php @@ -664,7 +664,6 @@ class CloudFederationProviderFiles implements ICloudFederationProvider { throw new BadRequestException(['permission']); } - error_log("new permissions: " . $ncPermissions); } return $ncPermissions; From cdf8abb060c596fec937bdc7ec4f287b22b240a3 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Mon, 25 Jun 2018 11:14:26 +0200 Subject: [PATCH 35/39] look for correct OCM permissions Signed-off-by: Bjoern Schiessle --- apps/dav/lib/Connector/Sabre/FilesPlugin.php | 38 ++++++++++++ apps/files_sharing/lib/External/Storage.php | 62 +++++++++++++++++-- .../Federation/CloudFederationShare.php | 2 +- 3 files changed, 95 insertions(+), 7 deletions(-) diff --git a/apps/dav/lib/Connector/Sabre/FilesPlugin.php b/apps/dav/lib/Connector/Sabre/FilesPlugin.php index f36ebe5636..f53f13c568 100644 --- a/apps/dav/lib/Connector/Sabre/FilesPlugin.php +++ b/apps/dav/lib/Connector/Sabre/FilesPlugin.php @@ -33,6 +33,7 @@ namespace OCA\DAV\Connector\Sabre; use OC\AppFramework\Http\Request; +use OCP\Constants; use OCP\Files\ForbiddenException; use OCP\IPreview; use Sabre\DAV\Exception\Forbidden; @@ -57,6 +58,7 @@ class FilesPlugin extends ServerPlugin { 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'; @@ -149,6 +151,7 @@ class FilesPlugin extends ServerPlugin { $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; @@ -318,6 +321,14 @@ class FilesPlugin extends ServerPlugin { ); }); + $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(); }); @@ -394,6 +405,33 @@ class FilesPlugin extends ServerPlugin { } } + /** + * 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 * diff --git a/apps/files_sharing/lib/External/Storage.php b/apps/files_sharing/lib/External/Storage.php index a631a029ab..dadb1def70 100644 --- a/apps/files_sharing/lib/External/Storage.php +++ b/apps/files_sharing/lib/External/Storage.php @@ -36,6 +36,7 @@ use OC\Files\Storage\DAV; use OC\ForbiddenException; use OCA\Files_Sharing\ISharedStorage; use OCP\AppFramework\Http; +use OCP\Constants; use OCP\Federation\ICloudId; use OCP\Files\NotFoundException; use OCP\Files\StorageInvalidException; @@ -347,20 +348,20 @@ class Storage extends DAV implements ISharedStorage { if (\OCP\Util::isSharingDisabledForUser() || !\OC\Share\Share::isResharingAllowed()) { return false; } - return ($this->getPermissions($path) & \OCP\Constants::PERMISSION_SHARE); + 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 - if ($this->is_dir($path)) { - $permissions = \OCP\Constants::PERMISSION_ALL; - } else { - $permissions = \OCP\Constants::PERMISSION_ALL & ~\OCP\Constants::PERMISSION_CREATE; - } + $permissions = $this->getDefaultPermissions($path); } return $permissions; @@ -369,4 +370,53 @@ class Storage extends DAV implements ISharedStorage { 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; + } } diff --git a/lib/private/Federation/CloudFederationShare.php b/lib/private/Federation/CloudFederationShare.php index d26073be82..0c2795188f 100644 --- a/lib/private/Federation/CloudFederationShare.php +++ b/lib/private/Federation/CloudFederationShare.php @@ -78,7 +78,7 @@ class CloudFederationShare implements ICloudFederationShare { 'name' => 'webdav', 'options' => [ 'sharedSecret' => $sharedSecret, - 'permissions' => '{http://open-collaboration-services.org/ns}share-permissions' + 'permissions' => '{http://open-cloud-mesh.org/ns}share-permissions' ] ]); $this->setShareType($shareType); From 511a34b08f3c66dd354dc188eec4cbca170ad6a9 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Fri, 29 Jun 2018 10:46:09 +0200 Subject: [PATCH 36/39] always enable cloud federation api Signed-off-by: Bjoern Schiessle --- core/shipped.json | 2 ++ tests/lib/App/AppManagerTest.php | 4 ++++ tests/lib/AppTest.php | 9 +++++++-- 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/core/shipped.json b/core/shipped.json index d31fff95ca..4caa8e0d17 100644 --- a/core/shipped.json +++ b/core/shipped.json @@ -3,6 +3,7 @@ "accessibility", "activity", "admin_audit", + "cloud_federation_api", "comments", "dav", "encryption", @@ -38,6 +39,7 @@ ], "alwaysEnabled": [ "files", + "cloud_federation_api", "dav", "federatedfilesharing", "lookup_server_connector", diff --git a/tests/lib/App/AppManagerTest.php b/tests/lib/App/AppManagerTest.php index 3565005410..bea39d1bc1 100644 --- a/tests/lib/App/AppManagerTest.php +++ b/tests/lib/App/AppManagerTest.php @@ -330,6 +330,7 @@ class AppManagerTest extends TestCase { $this->appConfig->setValue('test2', 'enabled', 'no'); $this->appConfig->setValue('test3', 'enabled', '["foo"]'); $apps = [ + 'cloud_federation_api', 'dav', 'federatedfilesharing', 'files', @@ -356,6 +357,7 @@ class AppManagerTest extends TestCase { $this->appConfig->setValue('test3', 'enabled', '["foo"]'); $this->appConfig->setValue('test4', 'enabled', '["asd"]'); $enabled = [ + 'cloud_federation_api', 'dav', 'federatedfilesharing', 'files', @@ -378,6 +380,7 @@ class AppManagerTest extends TestCase { ->getMock(); $appInfos = [ + 'cloud_federation_api' => ['id' => 'cloud_federation_api'], 'dav' => ['id' => 'dav'], 'files' => ['id' => 'files'], 'federatedfilesharing' => ['id' => 'federatedfilesharing'], @@ -425,6 +428,7 @@ class AppManagerTest extends TestCase { ->getMock(); $appInfos = [ + 'cloud_federation_api' => ['id' => 'cloud_federation_api'], 'dav' => ['id' => 'dav'], 'files' => ['id' => 'files'], 'federatedfilesharing' => ['id' => 'federatedfilesharing'], diff --git a/tests/lib/AppTest.php b/tests/lib/AppTest.php index 1334aa62f1..5d98dc7df5 100644 --- a/tests/lib/AppTest.php +++ b/tests/lib/AppTest.php @@ -338,6 +338,7 @@ class AppTest extends \Test\TestCase { 'app3', 'appforgroup1', 'appforgroup12', + 'cloud_federation_api', 'dav', 'federatedfilesharing', 'lookup_server_connector', @@ -357,6 +358,7 @@ class AppTest extends \Test\TestCase { 'app3', 'appforgroup12', 'appforgroup2', + 'cloud_federation_api', 'dav', 'federatedfilesharing', 'lookup_server_connector', @@ -377,6 +379,7 @@ class AppTest extends \Test\TestCase { 'appforgroup1', 'appforgroup12', 'appforgroup2', + 'cloud_federation_api', 'dav', 'federatedfilesharing', 'lookup_server_connector', @@ -397,6 +400,7 @@ class AppTest extends \Test\TestCase { 'appforgroup1', 'appforgroup12', 'appforgroup2', + 'cloud_federation_api', 'dav', 'federatedfilesharing', 'lookup_server_connector', @@ -417,6 +421,7 @@ class AppTest extends \Test\TestCase { 'appforgroup1', 'appforgroup12', 'appforgroup2', + 'cloud_federation_api', 'dav', 'federatedfilesharing', 'lookup_server_connector', @@ -501,11 +506,11 @@ class AppTest extends \Test\TestCase { ); $apps = \OC_App::getEnabledApps(); - $this->assertEquals(array('files', 'app3', 'dav', 'federatedfilesharing', 'lookup_server_connector', 'oauth2', 'provisioning_api', 'twofactor_backupcodes', 'workflowengine'), $apps); + $this->assertEquals(array('files', 'app3', 'cloud_federation_api', 'dav', 'federatedfilesharing', 'lookup_server_connector', 'oauth2', 'provisioning_api', 'twofactor_backupcodes', 'workflowengine'), $apps); // mock should not be called again here $apps = \OC_App::getEnabledApps(); - $this->assertEquals(array('files', 'app3', 'dav', 'federatedfilesharing', 'lookup_server_connector', 'oauth2', 'provisioning_api', 'twofactor_backupcodes', 'workflowengine'), $apps); + $this->assertEquals(array('files', 'app3', 'cloud_federation_api', 'dav', 'federatedfilesharing', 'lookup_server_connector', 'oauth2', 'provisioning_api', 'twofactor_backupcodes', 'workflowengine'), $apps); $this->restoreAppConfig(); \OC_User::setUserId(null); From 411bae51639b19d0a3ae122eda82dc872f276887 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Fri, 29 Jun 2018 11:32:40 +0200 Subject: [PATCH 37/39] fix return type from send share Signed-off-by: Bjoern Schiessle --- lib/private/Federation/CloudFederationProviderManager.php | 3 ++- lib/public/Federation/ICloudFederationProviderManager.php | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/private/Federation/CloudFederationProviderManager.php b/lib/private/Federation/CloudFederationProviderManager.php index 2776ad8cac..10d28d0287 100644 --- a/lib/private/Federation/CloudFederationProviderManager.php +++ b/lib/private/Federation/CloudFederationProviderManager.php @@ -145,7 +145,8 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager ]); if ($response->getStatusCode() === Http::STATUS_CREATED) { - return true; + $result = json_decode($response->getBody(), true); + return (is_array($result)) ? $result : []; } } catch (\Exception $e) { diff --git a/lib/public/Federation/ICloudFederationProviderManager.php b/lib/public/Federation/ICloudFederationProviderManager.php index 94bbe3ed21..f1e932388b 100644 --- a/lib/public/Federation/ICloudFederationProviderManager.php +++ b/lib/public/Federation/ICloudFederationProviderManager.php @@ -77,7 +77,7 @@ interface ICloudFederationProviderManager { * send federated share * * @param ICloudFederationShare $share - * @return bool + * @return mixed * * @since 14.0.0 */ From ce567b61216c8b41d28a484e04eba35d185fa08a Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Mon, 2 Jul 2018 11:36:11 +0200 Subject: [PATCH 38/39] remove unused code Signed-off-by: Bjoern Schiessle --- .../lib/Notifications.php | 24 ------------------- 1 file changed, 24 deletions(-) diff --git a/apps/federatedfilesharing/lib/Notifications.php b/apps/federatedfilesharing/lib/Notifications.php index e15e9c2f6a..fdba3e113d 100644 --- a/apps/federatedfilesharing/lib/Notifications.php +++ b/apps/federatedfilesharing/lib/Notifications.php @@ -370,30 +370,6 @@ class Notifications { } - /** - * check if server supports the new OCM api and ask for the correct end-point - * - * @param string $url - * @return string - */ - protected function getOCMEndPoint($url) { - $client = $this->httpClientService->newClient(); - try { - $response = $client->get($url, ['timeout' => 10, 'connect_timeout' => 10]); - } catch (\Exception $e) { - return ''; - } - - $result = $response->getBody(); - $result = json_decode($result, true); - - if (isset($result['end-point'])) { - return $result['end-point']; - } - - return ''; - } - /** * send action regarding federated sharing to the remote server using the OCM API * From 7ff74ae8eda8feb232a9b2c2094ec98641543721 Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Mon, 2 Jul 2018 11:36:35 +0200 Subject: [PATCH 39/39] cache results from ocm end-point discovery Signed-off-by: Bjoern Schiessle --- .../Federation/CloudFederationProviderManager.php | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/lib/private/Federation/CloudFederationProviderManager.php b/lib/private/Federation/CloudFederationProviderManager.php index 10d28d0287..254ceb03bf 100644 --- a/lib/private/Federation/CloudFederationProviderManager.php +++ b/lib/private/Federation/CloudFederationProviderManager.php @@ -57,6 +57,9 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager /** @var ILogger */ private $logger; + /** @var array cache OCM end-points */ + private $ocmEndPoints = []; + private $supportedAPIVersion = '1.0-proposal1'; /** @@ -208,10 +211,16 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager * @return string */ protected function getOCMEndPoint($url) { + + if (isset($this->ocmEndPoints[$url])) { + return $this->ocmEndPoints[$url]; + } + $client = $this->httpClientService->newClient(); try { $response = $client->get($url . '/ocm-provider/', ['timeout' => 10, 'connect_timeout' => 10]); } catch (\Exception $e) { + $this->ocmEndPoints[$url] = ''; return ''; } @@ -221,9 +230,11 @@ class CloudFederationProviderManager implements ICloudFederationProviderManager $supportedVersion = isset($result['apiVersion']) && $result['apiVersion'] === $this->supportedAPIVersion; if (isset($result['endPoint']) && $supportedVersion) { + $this->ocmEndPoints[$url] = $result['endPoint']; return $result['endPoint']; } + $this->ocmEndPoints[$url] = ''; return ''; }