Merge pull request #63661 from nextcloud/unified-sharing-user-status

feat(Sharing): Add user status for shares

Author: skjnldsv

apps/sharing/appinfo/info.xml

@@ -27,8 +27,11 @@
 		<command>\OCA\Sharing\Command\GetShares</command>
 		<command>\OCA\Sharing\Command\RemoveShareRecipient</command>
 		<command>\OCA\Sharing\Command\RemoveShareSource</command>
+		<command>\OCA\Sharing\Command\SelectSharePermissionPreset</command>
 		<command>\OCA\Sharing\Command\UpdateSharePermission</command>
 		<command>\OCA\Sharing\Command\UpdateShareProperty</command>
+		<command>\OCA\Sharing\Command\UpdateShareRecipientSecret</command>
 		<command>\OCA\Sharing\Command\UpdateShareState</command>
+		<command>\OCA\Sharing\Command\UpdateShareUserStatus</command>
 	</commands>
 </info>

apps/sharing/composer/composer/autoload_classmap.php

@@ -23,9 +23,11 @@
     'OCA\\Sharing\\Command\\UpdateShareProperty' => $baseDir . '/../lib/Command/UpdateShareProperty.php',
     'OCA\\Sharing\\Command\\UpdateShareRecipientSecret' => $baseDir . '/../lib/Command/UpdateShareRecipientSecret.php',
     'OCA\\Sharing\\Command\\UpdateShareState' => $baseDir . '/../lib/Command/UpdateShareState.php',
+    'OCA\\Sharing\\Command\\UpdateShareUserStatus' => $baseDir . '/../lib/Command/UpdateShareUserStatus.php',
     'OCA\\Sharing\\Controller\\ApiV1Controller' => $baseDir . '/../lib/Controller/ApiV1Controller.php',
     'OCA\\Sharing\\Middleware\\ShareApiEnabledMiddleware' => $baseDir . '/../lib/Middleware/ShareApiEnabledMiddleware.php',
     'OCA\\Sharing\\Migration\\Version1000Date20250929161325' => $baseDir . '/../lib/Migration/Version1000Date20250929161325.php',
     'OCA\\Sharing\\Migration\\Version1000Date20260731171922' => $baseDir . '/../lib/Migration/Version1000Date20260731171922.php',
+    'OCA\\Sharing\\Migration\\Version1000Date20260826073021' => $baseDir . '/../lib/Migration/Version1000Date20260826073021.php',
     'OCA\\Sharing\\ResponseDefinitions' => $baseDir . '/../lib/ResponseDefinitions.php',
 );

apps/sharing/composer/composer/autoload_static.php

@@ -38,10 +38,12 @@ class ComposerStaticInitSharing
         'OCA\\Sharing\\Command\\UpdateShareProperty' => __DIR__ . '/..' . '/../lib/Command/UpdateShareProperty.php',
         'OCA\\Sharing\\Command\\UpdateShareRecipientSecret' => __DIR__ . '/..' . '/../lib/Command/UpdateShareRecipientSecret.php',
         'OCA\\Sharing\\Command\\UpdateShareState' => __DIR__ . '/..' . '/../lib/Command/UpdateShareState.php',
+        'OCA\\Sharing\\Command\\UpdateShareUserStatus' => __DIR__ . '/..' . '/../lib/Command/UpdateShareUserStatus.php',
         'OCA\\Sharing\\Controller\\ApiV1Controller' => __DIR__ . '/..' . '/../lib/Controller/ApiV1Controller.php',
         'OCA\\Sharing\\Middleware\\ShareApiEnabledMiddleware' => __DIR__ . '/..' . '/../lib/Middleware/ShareApiEnabledMiddleware.php',
         'OCA\\Sharing\\Migration\\Version1000Date20250929161325' => __DIR__ . '/..' . '/../lib/Migration/Version1000Date20250929161325.php',
         'OCA\\Sharing\\Migration\\Version1000Date20260731171922' => __DIR__ . '/..' . '/../lib/Migration/Version1000Date20260731171922.php',
+        'OCA\\Sharing\\Migration\\Version1000Date20260826073021' => __DIR__ . '/..' . '/../lib/Migration/Version1000Date20260826073021.php',
         'OCA\\Sharing\\ResponseDefinitions' => __DIR__ . '/..' . '/../lib/ResponseDefinitions.php',
     );
 

apps/sharing/lib/Command/GetShares.php

@@ -12,6 +12,7 @@
 use Exception;
 use NCU\Sharing\Share;
 use NCU\Sharing\ShareState;
+use NCU\Sharing\ShareUserStatus;
 use NCU\Sharing\Source\IShareSourceType;
 use OC\Core\Command\Base;
 use Symfony\Component\Console\Input\InputInterface;
@@ -29,6 +30,7 @@ public function configure(): void {
 			->addOption('filter-source-type-class', '', InputOption::VALUE_REQUIRED, 'Source type class to filter by')
 			->addOption('filter-source-type-value', '', InputOption::VALUE_REQUIRED, 'Source type value to filter by')
 			->addOption('filter-state', '', InputOption::VALUE_REQUIRED, 'State to filter by. Possible values: ' . implode(', ', array_map(static fn (UnitEnum $case) => $case->value, ShareState::cases())))
+			->addOption('filter-user-status', '', InputOption::VALUE_REQUIRED, 'User status to filter by. Possible values: ' . implode(', ', array_map(static fn (UnitEnum $case) => $case->value, ShareUserStatus::cases())))
 			->addOption('last-share-id', '', InputOption::VALUE_REQUIRED, 'Share ID to use as an offset')
 			->addOption('limit', '', InputOption::VALUE_REQUIRED, 'Maximum number of shares to return');
 		parent::configure();
@@ -53,6 +55,17 @@ public function execute(InputInterface $input, OutputInterface $output): int {
 			}
 		}
 
+		/** @var ?string $filterUserStatus */
+		$filterUserStatus = $input->getOption('filter-user-status');
+		if ($filterUserStatus !== null) {
+			try {
+				$filterUserStatus = ShareUserStatus::from($filterUserStatus);
+			} catch (ValueError $valueError) {
+				$output->writeln($valueError->getMessage());
+				return Base::FAILURE;
+			}
+		}
+
 		/** @var ?string $lastShareID */
 		$lastShareID = $input->getOption('last-share-id');
 		/** @var ?string $limit */
@@ -68,7 +81,7 @@ public function execute(InputInterface $input, OutputInterface $output): int {
 		try {
 			$this->dbConnection->beginTransaction();
 
-			$shares = $this->manager->getShares($this->accessContext, $filterSourceTypeClass, $filterSourceTypeValue, $filterState, $lastShareID, $limit);
+			$shares = $this->manager->getShares($this->accessContext, $filterSourceTypeClass, $filterSourceTypeValue, $filterState, $filterUserStatus, $lastShareID, $limit);
 			$this->dbConnection->commit();
 
 			$data = Share::formatMultiple($this->registry, $this->l10nFactory, $this->urlGenerator, $this->userManager, $shares);

apps/sharing/lib/Command/UpdateShareUserStatus.php

@@ -0,0 +1,42 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+declare(strict_types=1);
+
+namespace OCA\Sharing\Command;
+
+use NCU\Sharing\Share;
+use NCU\Sharing\ShareUserStatus;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+final class UpdateShareUserStatus extends SharingBase {
+	#[\Override]
+	public function configure(): void {
+		$this
+			->setName('sharing:update-share-user-status')
+			->setDescription('Update the user status for a share.')
+			->addArgument('id', InputArgument::REQUIRED, 'Share ID')
+			->addArgument('user-status', InputArgument::REQUIRED, 'User status');
+		parent::configure();
+	}
+
+	#[\Override]
+	public function execute(InputInterface $input, OutputInterface $output): int {
+		/** @var string $id */
+		$id = $input->getArgument('id');
+		/** @var string $userStatus */
+		$userStatus = $input->getArgument('user-status');
+		$userStatus = ShareUserStatus::from($userStatus);
+
+		return $this->wrapExecution($input, $output, function () use ($id, $userStatus): Share {
+			$share = $this->manager->getShare($this->accessContext, $id);
+			return $this->manager->updateShareUserStatus($this->accessContext, $share, $userStatus);
+		});
+	}
+}

apps/sharing/lib/Controller/ApiV1Controller.php

@@ -26,6 +26,7 @@
 use NCU\Sharing\Share;
 use NCU\Sharing\ShareAccessContext;
 use NCU\Sharing\ShareState;
+use NCU\Sharing\ShareUserStatus;
 use NCU\Sharing\Source\IShareSourceType;
 use NCU\Sharing\Source\ShareSource;
 use OCA\Sharing\ResponseDefinitions;
@@ -51,6 +52,7 @@
  * @psalm-import-type SharingShare from ResponseDefinitions
  * @psalm-import-type SharingRecipient from ResponseDefinitions
  * @psalm-import-type SharingState from ResponseDefinitions
+ * @psalm-import-type SharingUserStatus from ResponseDefinitions
  * @psalm-import-type SharingPermissionPreset from ResponseDefinitions
  */
 final class ApiV1Controller extends OCSController {
@@ -186,8 +188,7 @@ public function updateShareState(string $id, string $state): DataResponse {
 				$this->dbConnection->beginTransaction();
 
 				$share = $this->manager->getShare($this->accessContext, $id);
-				$this->manager->updateShareState($this->accessContext, $share, $shareState);
-				$share = $this->manager->getShare($this->accessContext, $id);
+				$share = $this->manager->updateShareState($this->accessContext, $share, $shareState);
 				$this->dbConnection->commit();
 				return new DataResponse($share->format($this->registry, $this->l10nFactory, $this->urlGenerator, $this->userManager));
 			} catch (Exception $exception) {
@@ -201,6 +202,43 @@ public function updateShareState(string $id, string $state): DataResponse {
 		}
 	}
 
+	/**
+	 * Update the user status for a share.
+	 *
+	 * @param string $id ID of the share
+	 * @param SharingUserStatus $userStatus New user status for the share
+	 * @return DataResponse<Http::STATUS_OK, SharingShare, array{}>|DataResponse<Http::STATUS_BAD_REQUEST|Http::STATUS_NOT_FOUND, string, array{}>
+	 *
+	 * 200: User status for share updated successfully
+	 * 400: Invalid share user status
+	 * 404: Share not found
+	 */
+	#[NoAdminRequired]
+	#[ApiRoute(verb: 'PUT', url: '/api/v1/share/{id}/user-status')]
+	public function updateShareUserStatus(string $id, string $userStatus): DataResponse {
+		try {
+			$shareUserStatus = ShareUserStatus::from($userStatus);
+		} catch (ValueError $valueError) {
+			return new DataResponse($valueError->getMessage(), Http::STATUS_BAD_REQUEST);
+		}
+
+		try {
+			try {
+				$this->dbConnection->beginTransaction();
+
+				$share = $this->manager->getShare($this->accessContext, $id);
+				$share = $this->manager->updateShareUserStatus($this->accessContext, $share, $shareUserStatus);
+				$this->dbConnection->commit();
+				return new DataResponse($share->format($this->registry, $this->l10nFactory, $this->urlGenerator, $this->userManager));
+			} catch (Exception $exception) {
+				$this->dbConnection->rollBack();
+				throw $exception;
+			}
+		} catch (ShareNotFoundException $shareNotFoundException) {
+			return new DataResponse($shareNotFoundException->getHint(), Http::STATUS_NOT_FOUND);
+		}
+	}
+
 	/**
 	 * Add a new source to a share.
 	 *
@@ -561,6 +599,7 @@ public function getShare(string $id, ?string $secret = null, array $arguments =
 	 * @param ?class-string<IShareSourceType> $filterSourceTypeClass Source type class to filter by.
 	 * @param ?non-empty-string $filterSourceTypeValue Source type value to filter by.
 	 * @param ?SharingState $filterState State to filter by.
+	 * @param ?SharingUserStatus $filterUserStatus User status to filter by.
 	 * @param ?string $lastShareID The ID of the previous share. This is used as an offset and only shares with higher IDs are returned.
 	 * @param int<1, 100> $limit The number of shares to return.
 	 * @return DataResponse<Http::STATUS_OK, list<SharingShare>, array{}>|DataResponse<Http::STATUS_BAD_REQUEST, string, array{}>
@@ -570,7 +609,7 @@ public function getShare(string $id, ?string $secret = null, array $arguments =
 	 */
 	#[NoAdminRequired]
 	#[ApiRoute(verb: 'GET', url: '/api/v1/shares')]
-	public function getShares(?string $filterSourceTypeClass, ?string $filterSourceTypeValue, ?string $filterState, ?string $lastShareID, int $limit = 100): DataResponse {
+	public function getShares(?string $filterSourceTypeClass, ?string $filterSourceTypeValue, ?string $filterState, ?string $filterUserStatus, ?string $lastShareID, int $limit = 100): DataResponse {
 		/** @psalm-suppress DocblockTypeContradiction */
 		if ($limit < 1) {
 			return new DataResponse('The limit is too low.', Http::STATUS_BAD_REQUEST);
@@ -598,10 +637,18 @@ public function getShares(?string $filterSourceTypeClass, ?string $filterSourceT
 			}
 		}
 
+		if ($filterUserStatus !== null) {
+			try {
+				$filterUserStatus = ShareUserStatus::from($filterUserStatus);
+			} catch (ValueError $valueError) {
+				return new DataResponse($valueError->getMessage(), Http::STATUS_BAD_REQUEST);
+			}
+		}
+
 		try {
 			$this->dbConnection->beginTransaction();
 
-			$shares = $this->manager->getShares($this->accessContext, $filterSourceTypeClass, $filterSourceTypeValue, $filterState, $lastShareID, $limit);
+			$shares = $this->manager->getShares($this->accessContext, $filterSourceTypeClass, $filterSourceTypeValue, $filterState, $filterUserStatus, $lastShareID, $limit);
 			$this->dbConnection->commit();
 			return new DataResponse(Share::formatMultiple($this->registry, $this->l10nFactory, $this->urlGenerator, $this->userManager, $shares));
 		} catch (Exception $exception) {

apps/sharing/lib/Migration/Version1000Date20260826073021.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Sharing\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\DB\Types;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+use Override;
+
+final class Version1000Date20260826073021 extends SimpleMigrationStep {
+	#[Override]
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		$schema = $schemaClosure();
+
+		if (!$schema->hasTable('sharing_share_user_status')) {
+			$shareTable = $schema->getTable('sharing_share');
+
+			$userStatusTable = $schema->createTable('sharing_share_user_status');
+			$userStatusTable->addColumn('share_id', Types::BIGINT);
+			$userStatusTable->addColumn('user_id', Types::STRING, ['length' => 64]);
+			$userStatusTable->addColumn('status', Types::STRING, ['length' => 16]);
+			$userStatusTable->setPrimaryKey(['share_id', 'user_id']);
+			$userStatusTable->addForeignKeyConstraint($shareTable->getName(), ['share_id'], ['id'], ['onDelete' => 'CASCADE']);
+		}
+
+		return $schema;
+	}
+}

apps/sharing/lib/ResponseDefinitions.php

@@ -62,6 +62,8 @@
  *
  * @psalm-type SharingState = 'active'|'draft'|'deleted'
  *
+ * @psalm-type SharingUserStatus = 'pending'|'accepted'|'rejected'
+ *
  * @psalm-type SharingProperty = array{
  *     class: class-string<ISharePropertyType>,
  *     display_name: non-empty-string,
@@ -125,6 +127,7 @@
  *     // Unix time in milliseconds
  *     last_updated: numeric-string,
  *     state: SharingState,
+ *     user_status: ?SharingUserStatus,
  *     sources: list<SharingSource>,
  *     recipients: list<SharingRecipient>,
  *     properties: list<SharingPropertyDate|SharingPropertyEnum|SharingPropertyBoolean|SharingPropertyPassword|SharingPropertyString>,