Merge pull request #63650 from nextcloud/backport/63565/stable35

[stable35] feat(Sharing): Implement API kill switch

Author: susnux

apps/sharing/lib/Capabilities.php

@@ -9,14 +9,13 @@
 
 namespace OCA\Sharing;
 
+use NCU\Sharing\ISharingManager;
 use NCU\Sharing\ISharingRegistry;
 use NCU\Sharing\Permission\ISharePermissionPreset;
 use NCU\Sharing\Source\IShareSourceType;
 use OCA\Sharing\AppInfo\Application;
 use OCP\Capabilities\ICapability;
 use OCP\L10N\IFactory;
-use OCP\Server;
-use OCP\Share\IManager;
 
 /**
  * @psalm-import-type SharingSourceType from ResponseDefinitions
@@ -26,6 +25,7 @@
 	public function __construct(
 		private IFactory $l10nFactory,
 		private ISharingRegistry $registry,
+		private ISharingManager $manager,
 	) {
 	}
 
@@ -40,7 +40,7 @@ public function __construct(
 	 */
 	#[\Override]
 	public function getCapabilities(): array {
-		if (!Server::get(IManager::class)->shareApiEnabled()) {
+		if (!$this->manager->isApiEnabled()) {
 			return [];
 		}
 

apps/sharing/lib/Middleware/ShareApiEnabledMiddleware.php

@@ -9,18 +9,18 @@
 
 namespace OCA\Sharing\Middleware;
 
+use NCU\Sharing\ISharingManager;
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http;
 use OCP\AppFramework\Middleware;
 use OCP\AppFramework\OCS\OCSException;
 use OCP\Server;
-use OCP\Share\IManager;
 
 final class ShareApiEnabledMiddleware extends Middleware {
 	#[\Override]
 	public function beforeController(Controller $controller, string $methodName): void {
-		if (!Server::get(IManager::class)->shareApiEnabled()) {
-			throw new OCSException('The Share API is not enabled.', Http::STATUS_NOT_IMPLEMENTED);
+		if (!Server::get(ISharingManager::class)->isApiEnabled()) {
+			throw new OCSException('The Unified Sharing API is not enabled.', Http::STATUS_NOT_IMPLEMENTED);
 		}
 	}
 }

apps/sharing/tests/CapabilitiesTest.php

@@ -12,6 +12,7 @@
 use NCU\Sharing\ISharingRegistry;
 use OCA\Sharing\AppInfo\Application;
 use OCA\Sharing\Capabilities;
+use OCP\IConfig;
 use OCP\Server;
 use PHPUnit\Framework\Attributes\Group;
 use Test\Sharing\TestSharePermissionPreset1;
@@ -44,6 +45,9 @@ protected function tearDown(): void {
 	}
 
 	public function testGetCapabilities(): void {
+		$config = Server::get(IConfig::class);
+		$config->setSystemValue('sharing.unified_api_enable', true);
+
 		$this->registry->registerSourceType(new TestShareSourceType1([]));
 		$this->registry->registerSourceType(new TestShareSourceType2([]));
 		$this->registry->registerPermissionPreset(new TestSharePermissionPreset1());
@@ -77,5 +81,16 @@ public function testGetCapabilities(): void {
 			],
 			$this->capabilities->getCapabilities(),
 		);
+
+		$config->deleteSystemValue('sharing.unified_api_enable');
+	}
+
+	public function testGetCapabilitiesDisableUnifiedSharingApi(): void {
+		$config = Server::get(IConfig::class);
+		$config->setSystemValue('sharing.unified_api_enable', false);
+
+		$this->assertEquals([], $this->capabilities->getCapabilities());
+
+		$config->deleteSystemValue('sharing.unified_api_enable');
 	}
 }

lib/private/Sharing/SharingManager.php

@@ -33,6 +33,7 @@
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventDispatcher;
 use OCP\EventDispatcher\IEventListener;
+use OCP\IConfig;
 use OCP\IDBConnection;
 use OCP\IL10N;
 use OCP\Interaction\Actions\ShareAction;
@@ -41,6 +42,7 @@
 use OCP\IUserManager;
 use OCP\L10N\IFactory;
 use OCP\Security\ISecureRandom;
+use OCP\Share\IManager;
 use OCP\Snowflake\ISnowflakeGenerator;
 use OCP\User\Events\BeforeUserDeletedEvent;
 use Psr\Clock\ClockInterface;
@@ -71,6 +73,8 @@ public function __construct(
 		private ISharingRegistry $registry,
 		private ISharingBackend $backend,
 		private ClockInterface $clock,
+		private IManager $legacySharingManager,
+		private IConfig $config,
 	) {
 		$this->randomizer = new Randomizer();
 		$this->l10n = $l10nFactory->get('sharing');
@@ -147,6 +151,12 @@ public function getTime(): \DateTimeImmutable {
 		return $this->clock->now();
 	}
 
+	#[\Override]
+	public function isApiEnabled(): bool {
+		// TODO: Enable Unified Sharing API by default
+		return $this->legacySharingManager->shareApiEnabled() && $this->config->getSystemValueBool('sharing.unified_api_enable');
+	}
+
 	#[\Override]
 	public function createShare(ShareAccessContext $accessContext): Share {
 		if (!($currentUser = $accessContext->currentUser) instanceof IUser) {

lib/unstable/Sharing/ISharingManager.php

@@ -54,6 +54,11 @@ public function generateSecret(): string;
 	 */
 	public function getTime(): \DateTimeImmutable;
 
+	/**
+	 * @experimental 35.0.0
+	 */
+	public function isApiEnabled(): bool;
+
 	/**
 	 * Create a new share.
 	 *