fix: Add acceptShare as an interface

It was commented out because at that time no other share provider supported the `acceptShare` method. Today it is the same no other provider supports it, but we should make it discoverable by adding it to the public API as an additional interface. Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
nextcloud · Jun 25, 2024 · e3d9d6d · e3d9d6d
1 parent eed6216
commit e3d9d6d
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 11 deletions.
diff --git a/lib/private/Share20/DefaultShareProvider.php b/lib/private/Share20/DefaultShareProvider.php
@@ -29,6 +29,7 @@
 use OCP\Share\IAttributes;
 use OCP\Share\IShare;
 use OCP\Share\IShareProvider;
+use OCP\Share\IShareProviderSupportsAccept;
 use Psr\Log\LoggerInterface;
 use function str_starts_with;
 
@@ -37,7 +38,7 @@
  *
  * @package OC\Share20
  */
-class DefaultShareProvider implements IShareProvider {
+class DefaultShareProvider implements IShareProvider, IShareProviderSupportsAccept {
 	// Special share type for user modified group shares
 	public const SHARE_TYPE_USERGROUP = 2;
 

diff --git a/lib/private/Share20/Manager.php b/lib/private/Share20/Manager.php
@@ -44,6 +44,7 @@
 use OCP\Share\IProviderFactory;
 use OCP\Share\IShare;
 use OCP\Share\IShareProvider;
+use OCP\Share\IShareProviderSupportsAccept;
 use Psr\Log\LoggerInterface;
 
 /**
@@ -1018,6 +1019,7 @@ public function acceptShare(IShare $share, string $recipientId): IShare {
 			// TODO FIX ME
 			throw new \InvalidArgumentException('Share provider does not support accepting');
 		}
+		/** @var IShareProvider&IShareProviderSupportsAccept $provider */
 		$provider->acceptShare($share, $recipientId);
 
 		$event = new ShareAcceptedEvent($share);

diff --git a/lib/public/Share/IShareProvider.php b/lib/public/Share/IShareProvider.php
@@ -44,16 +44,6 @@ public function create(\OCP\Share\IShare $share);
 	 */
 	public function update(\OCP\Share\IShare $share);
 
-	/**
-	 * Accept a share.
-	 *
-	 * @param IShare $share
-	 * @param string $recipient
-	 * @return IShare The share object
-	 * @since 17.0.0
-	 */
-	//	public function acceptShare(IShare $share, string $recipient): IShare;
-
 	/**
 	 * Delete a share
 	 *

diff --git a/lib/public/Share/IShareProviderSupportsAccept.php b/lib/public/Share/IShareProviderSupportsAccept.php
@@ -0,0 +1,27 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Share;
+
+/**
+ * Interface IShareProviderSupportsAccept
+ *
+ * This interface allows to define IShareProvider that can handle the `acceptShare` method,
+ * which is available since Nextcloud 17.
+ *
+ * @since 30.0.0
+ */
+interface IShareProviderSupportsAccept {
+	/**
+	 * Accept a share.
+	 *
+	 * @param IShare $share
+	 * @param string $recipient
+	 * @return IShare The share object
+	 * @since 17.0.0
+	 */
+	public function acceptShare(IShare $share, string $recipient): IShare;
+}