Merge pull request #39574 from nextcloud/fix/noid/ocm-controller

OCM Services
nextcloud · Sep 20, 2023 · 4954c9f · 4954c9f
2 parents dead436 + b5dcd04
commit 4954c9f
Show file tree

Hide file tree

Showing 26 changed files with 1,237 additions and 254 deletions.
diff --git a/apps/cloud_federation_api/appinfo/routes.php b/apps/cloud_federation_api/appinfo/routes.php
@@ -6,6 +6,7 @@
  * @copyright Copyright (c) 2020 Joas Schilling <coding@schilljs.com>
  *
  * @author Joas Schilling <coding@schilljs.com>
+ * @author Maxence Lange <maxence@artificial-owl.com>
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -27,15 +28,21 @@
 	'routes' => [
 		[
 			'name' => 'RequestHandler#addShare',
-			'url' => '/ocm/shares',
+			'url' => '/shares',
 			'verb' => 'POST',
-			'root' => '',
+			'root' => '/ocm',
 		],
 		[
 			'name' => 'RequestHandler#receiveNotification',
-			'url' => '/ocm/notifications',
+			'url' => '/notifications',
 			'verb' => 'POST',
-			'root' => '',
+			'root' => '/ocm',
 		],
+//		[
+//			'name' => 'RequestHandler#inviteAccepted',
+//			'url' => '/invite-accepted',
+//			'verb' => 'POST',
+//			'root' => '/ocm',
+//		]
 	],
 ];
diff --git a/apps/cloud_federation_api/lib/Capabilities.php b/apps/cloud_federation_api/lib/Capabilities.php
@@ -1,9 +1,13 @@
 <?php
+
+declare(strict_types=1);
+
 /**
  * @copyright Copyright (c) 2017 Bjoern Schiessle <bjoern@schiessle.org>
  *
  * @author Bjoern Schiessle <bjoern@schiessle.org>
  * @author Kate Döen <kate.doeen@nextcloud.com>
+ * @author Maxence Lange <maxence@artificial-owl.com>
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -21,18 +25,22 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  *
  */
+
 namespace OCA\CloudFederationAPI;
 
+use OC\OCM\Model\OCMProvider;
+use OC\OCM\Model\OCMResource;
 use OCP\Capabilities\ICapability;
 use OCP\IURLGenerator;
+use OCP\OCM\Exceptions\OCMArgumentException;
 
 class Capabilities implements ICapability {
 
-	/** @var IURLGenerator */
-	private $urlGenerator;
+	public const API_VERSION = '1.0-proposal1';
 
-	public function __construct(IURLGenerator $urlGenerator) {
-		$this->urlGenerator = $urlGenerator;
+	public function __construct(
+		private IURLGenerator $urlGenerator,
+	) {
 	}
 
 	/**
@@ -46,32 +54,33 @@ public function __construct(IURLGenerator $urlGenerator) {
 	 *         resourceTypes: array{
 	 *             name: string,
 	 *             shareTypes: string[],
-	 *             protocols: array{
-	 *                 webdav: string,
-	 *	           },
-	 *	       }[],
-	 *	   },
+	 *             protocols: array<string, string>
+	 *           }[],
+	 *       },
 	 * }
+	 * @throws OCMArgumentException
 	 */
 	public function getCapabilities() {
 		$url = $this->urlGenerator->linkToRouteAbsolute('cloud_federation_api.requesthandlercontroller.addShare');
-		$capabilities = ['ocm' =>
-			[
-				'enabled' => true,
-				'apiVersion' => '1.0-proposal1',
-				'endPoint' => substr($url, 0, strrpos($url, '/')),
-				'resourceTypes' => [
-					[
-						'name' => 'file',
-						'shareTypes' => ['user', 'group'],
-						'protocols' => [
-							'webdav' => '/public.php/webdav/',
-						]
-					],
-				]
-			]
-		];
 
-		return $capabilities;
+		$provider = new OCMProvider();
+		$provider->setEnabled(true);
+		$provider->setApiVersion(self::API_VERSION);
+
+		$pos = strrpos($url, '/');
+		if (false === $pos) {
+			throw new OCMArgumentException('generated route should contains a slash character');
+		}
+
+		$provider->setEndPoint(substr($url, 0, $pos));
+
+		$resource = new OCMResource();
+		$resource->setName('file')
+				 ->setShareTypes(['user', 'group'])
+				 ->setProtocols(['webdav' => '/public.php/webdav/']);
+
+		$provider->setResourceTypes([$resource]);
+
+		return ['ocm' => $provider->jsonSerialize()];
 	}
 }
diff --git a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php
@@ -4,6 +4,7 @@
  *
  * @author Bjoern Schiessle <bjoern@schiessle.org>
  * @author Christoph Wurst <christoph@winzerhof-wurst.at>
+ * @author Maxence Lange <maxence@artificial-owl.com>
  * @author Roeland Jago Douma <roeland@famdouma.nl>
  * @author Kate Döen <kate.doeen@nextcloud.com>
  *
@@ -55,52 +56,19 @@
  * @psalm-import-type CloudFederationApiError from ResponseDefinitions
  */
 class RequestHandlerController extends Controller {
-
-	/** @var LoggerInterface */
-	private $logger;
-
-	/** @var IUserManager */
-	private $userManager;
-
-	/** @var IGroupManager */
-	private $groupManager;
-
-	/** @var IURLGenerator */
-	private $urlGenerator;
-
-	/** @var ICloudFederationProviderManager */
-	private $cloudFederationProviderManager;
-
-	/** @var Config */
-	private $config;
-
-	/** @var ICloudFederationFactory */
-	private $factory;
-
-	/** @var ICloudIdManager */
-	private $cloudIdManager;
-
-	public function __construct($appName,
-								IRequest $request,
-								LoggerInterface $logger,
-								IUserManager $userManager,
-								IGroupManager $groupManager,
-								IURLGenerator $urlGenerator,
-								ICloudFederationProviderManager $cloudFederationProviderManager,
-								Config $config,
-								ICloudFederationFactory $factory,
-								ICloudIdManager $cloudIdManager
+	public function __construct(
+		string $appName,
+		IRequest $request,
+		private LoggerInterface $logger,
+		private IUserManager $userManager,
+		private IGroupManager $groupManager,
+		private IURLGenerator $urlGenerator,
+		private ICloudFederationProviderManager $cloudFederationProviderManager,
+		private Config $config,
+		private ICloudFederationFactory $factory,
+		private ICloudIdManager $cloudIdManager
 	) {
 		parent::__construct($appName, $request);
-
-		$this->logger = $logger;
-		$this->userManager = $userManager;
-		$this->groupManager = $groupManager;
-		$this->urlGenerator = $urlGenerator;
-		$this->cloudFederationProviderManager = $cloudFederationProviderManager;
-		$this->config = $config;
-		$this->factory = $factory;
-		$this->cloudIdManager = $cloudIdManager;
 	}
 
 	/**
@@ -128,7 +96,6 @@ public function __construct($appName,
 	 * 501: Share type or the resource type is not supported
 	 */
 	public function addShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) {
-
 		// check if all required parameters are set
 		if ($shareWith === null ||
 			$name === null ||
@@ -253,7 +220,6 @@ public function addShare($shareWith, $name, $description, $providerId, $owner, $
 	 * 501: The resource type is not supported
 	 */
 	public function receiveNotification($notificationType, $resourceType, $providerId, ?array $notification) {
-
 		// check if all required parameters are set
 		if ($notificationType === null ||
 			$resourceType === null ||
@@ -311,7 +277,7 @@ public function receiveNotification($notificationType, $resourceType, $providerI
 			);
 		}
 
-		return new JSONResponse($result,Http::STATUS_CREATED);
+		return new JSONResponse($result, Http::STATUS_CREATED);
 	}
 
 	/**

diff --git a/apps/cloud_federation_api/openapi.json b/apps/cloud_federation_api/openapi.json
@@ -76,13 +76,8 @@
                                         },
                                         "protocols": {
                                             "type": "object",
-                                            "required": [
-                                                "webdav"
-                                            ],
-                                            "properties": {
-                                                "webdav": {
-                                                    "type": "string"
-                                                }
+                                            "additionalProperties": {
+                                                "type": "string"
                                             }
                                         }
                                     }

diff --git a/apps/files_sharing/lib/BackgroundJob/FederatedSharesDiscoverJob.php b/apps/files_sharing/lib/BackgroundJob/FederatedSharesDiscoverJob.php
@@ -6,6 +6,7 @@
  * @copyright 2018, Roeland Jago Douma <roeland@famdouma.nl>
  *
  * @author Christoph Wurst <christoph@winzerhof-wurst.at>
+ * @author Maxence Lange <maxence@artificial-owl.com>
  * @author Roeland Jago Douma <roeland@famdouma.nl>
  *
  * @license GNU AGPL version 3 or any later version
@@ -29,21 +30,21 @@
 use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\BackgroundJob\TimedJob;
 use OCP\IDBConnection;
+use OCP\OCM\Exceptions\OCMProviderException;
+use OCP\OCM\IOCMDiscoveryService;
 use OCP\OCS\IDiscoveryService;
+use Psr\Log\LoggerInterface;
 
 class FederatedSharesDiscoverJob extends TimedJob {
-	/** @var IDBConnection */
-	private $connection;
-	/** @var IDiscoveryService */
-	private $discoveryService;
-
-	public function __construct(ITimeFactory $time,
-								IDBConnection $connection,
-								IDiscoveryService $discoveryService) {
-		parent::__construct($time);
-		$this->connection = $connection;
-		$this->discoveryService = $discoveryService;
 
+	public function __construct(
+		ITimeFactory $time,
+		private IDBConnection $connection,
+		private IDiscoveryService $discoveryService,
+		private IOCMDiscoveryService $ocmDiscoveryService,
+		private LoggerInterface $logger,
+	) {
+		parent::__construct($time);
 		$this->setInterval(86400);
 	}
 
@@ -56,6 +57,11 @@ public function run($argument) {
 		$result = $qb->execute();
 		while ($row = $result->fetch()) {
 			$this->discoveryService->discover($row['remote'], 'FEDERATED_SHARING', true);
+			try {
+				$this->ocmDiscoveryService->discover($row['remote'], true);
+			} catch (OCMProviderException $e) {
+				$this->logger->info('exception while running files_sharing/lib/BackgroundJob/FederatedSharesDiscoverJob', ['exception' => $e]);
+			}
 		}
 		$result->closeCursor();
 	}

diff --git a/apps/files_sharing/lib/Controller/ExternalSharesController.php b/apps/files_sharing/lib/Controller/ExternalSharesController.php
@@ -134,14 +134,14 @@ public function testRemote($remote) {
 		}
 
 		if (
-			$this->testUrl('https://' . $remote . '/ocs-provider/') ||
-			$this->testUrl('https://' . $remote . '/ocs-provider/index.php') ||
+			$this->testUrl('https://' . $remote . '/ocm-provider/') ||
+			$this->testUrl('https://' . $remote . '/ocm-provider/index.php') ||
 			$this->testUrl('https://' . $remote . '/status.php', true)
 		) {
 			return new DataResponse('https');
 		} elseif (
-			$this->testUrl('http://' . $remote . '/ocs-provider/') ||
-			$this->testUrl('http://' . $remote . '/ocs-provider/index.php') ||
+			$this->testUrl('http://' . $remote . '/ocm-provider/') ||
+			$this->testUrl('http://' . $remote . '/ocm-provider/index.php') ||
 			$this->testUrl('http://' . $remote . '/status.php', true)
 		) {
 			return new DataResponse('http');