Merge pull request #2289 from nextcloud/feat/share-access-update-event

Author: provokateurin

lib/Service/CircleService.php

@@ -51,6 +51,8 @@
 use OCA\Circles\Tools\Traits\TDeserialize;
 use OCA\Circles\Tools\Traits\TNCLogger;
 use OCA\Circles\Tools\Traits\TStringTools;
+use OCA\Files_Sharing\Event\UserShareAccessUpdatedEvent;
+use OCP\EventDispatcher\IEventDispatcher;
 use OCP\ICache;
 use OCP\ICacheFactory;
 use OCP\IL10N;
@@ -124,6 +126,7 @@ public function __construct(
 		MemberService $memberService,
 		PermissionService $permissionService,
 		ConfigService $configService,
+		private readonly IEventDispatcher $eventDispatcher,
 	) {
 		$this->l10n = $l10n;
 		$this->hasher = $hasher;
@@ -422,14 +425,16 @@ public function updateDescription(string $circleId, string $description): array
 	 */
 	public function circleJoin(string $circleId): array {
 		$this->federatedUserService->mustHaveCurrentUser();
+		/** @var FederatedUser $currentUser */
+		$currentUser = $this->federatedUserService->getCurrentUser();
 
 		$probe = new CircleProbe();
 		$probe->includeNonVisibleCircles()
 			->emulateVisitor();
 
 		$circle = $this->circleRequest->getCircle(
 			$circleId,
-			$this->federatedUserService->getCurrentUser(),
+			$currentUser,
 			$probe
 		);
 
@@ -442,6 +447,8 @@ public function circleJoin(string $circleId): array {
 
 		$this->federatedEventService->newEvent($event);
 
+		$this->eventDispatcher->dispatchTyped(new UserShareAccessUpdatedEvent($this->memberService->collectShareAccessUpdateUsers($currentUser)));
+
 		return $event->getOutcome();
 	}
 
@@ -465,14 +472,16 @@ public function circleJoin(string $circleId): array {
 	 */
 	public function circleLeave(string $circleId, bool $force = false): array {
 		$this->federatedUserService->mustHaveCurrentUser();
+		/** @var FederatedUser $currentUser */
+		$currentUser = $this->federatedUserService->getCurrentUser();
 
 		$probe = new CircleProbe();
 		$probe->includeNonVisibleCircles()
 			->emulateVisitor();
 
 		$circle = $this->circleRequest->getCircle(
 			$circleId,
-			$this->federatedUserService->getCurrentUser(),
+			$currentUser,
 			$probe
 		);
 
@@ -482,10 +491,11 @@ public function circleLeave(string $circleId, bool $force = false): array {
 
 		$this->federatedEventService->newEvent($event);
 
+		$this->eventDispatcher->dispatchTyped(new UserShareAccessUpdatedEvent($this->memberService->collectShareAccessUpdateUsers($currentUser)));
+
 		return $event->getOutcome();
 	}
 
-
 	/**
 	 * @param string $circleId
 	 * @param CircleProbe|null $probe

lib/Service/MemberService.php

@@ -44,6 +44,10 @@
 use OCA\Circles\Tools\Traits\TArrayTools;
 use OCA\Circles\Tools\Traits\TNCLogger;
 use OCA\Circles\Tools\Traits\TStringTools;
+use OCA\Files_Sharing\Event\UserShareAccessUpdatedEvent;
+use OCP\EventDispatcher\IEventDispatcher;
+use OCP\IUser;
+use OCP\IUserManager;
 
 /**
  * Class MemberService
@@ -91,6 +95,8 @@ public function __construct(
 		MembershipService $membershipService,
 		FederatedEventService $federatedEventService,
 		RemoteStreamService $remoteStreamService,
+		private readonly IEventDispatcher $eventDispatcher,
+		private readonly IUserManager $userManager,
 	) {
 		$this->circleRequest = $circleRequest;
 		$this->memberRequest = $memberRequest;
@@ -209,6 +215,8 @@ public function addMember(string $circleId, FederatedUser $federatedUser, bool $
 
 		$this->federatedEventService->newEvent($event);
 
+		$this->eventDispatcher->dispatchTyped(new UserShareAccessUpdatedEvent($this->collectShareAccessUpdateUsers($member)));
+
 		return $event->getOutcome();
 	}
 
@@ -257,6 +265,8 @@ function (FederatedUser $federatedUser) use ($patron) {
 
 		$this->federatedEventService->newEvent($event);
 
+		$this->eventDispatcher->dispatchTyped(new UserShareAccessUpdatedEvent(array_merge(...array_map(fn (Member $member) => $this->collectShareAccessUpdateUsers($member), array_values($members)))));
+
 		return $event->getOutcome();
 	}
 
@@ -291,9 +301,30 @@ public function removeMember(string $memberId, bool $forceSync = false): array {
 
 		$this->federatedEventService->newEvent($event);
 
+		$this->eventDispatcher->dispatchTyped(new UserShareAccessUpdatedEvent($this->collectShareAccessUpdateUsers($member)));
+
 		return $event->getOutcome();
 	}
 
+
+	/**
+	 * @return list<IUser>
+	 */
+	public function collectShareAccessUpdateUsers(Member|FederatedUser $member): array {
+		if ($member->getUserType() === Member::TYPE_USER) {
+			return [$this->userManager->getExistingUser($member->getUserId())];
+		}
+
+		if ($member->getUserType() === Member::TYPE_CIRCLE) {
+			$circle = $this->circleRequest->getCircle($member->getSingleId());
+			$members = $circle->getInheritedMembers();
+			$userMembers = array_filter($members, static fn (Member $inheritedMember) => $inheritedMember->getUserType() === Member::TYPE_USER);
+			return array_map(fn (Member $inheritedMember) => $this->userManager->getExistingUser($inheritedMember->getUserId()), $userMembers);
+		}
+
+		return [];
+	}
+
 	/**
 	 * @param string $memberId
 	 * @param int $level

psalm.xml

@@ -59,11 +59,12 @@
 		<file name="tests/stubs/oc_user_manager.php" />
 		<file name="tests/stubs/oc_user_nouserexception.php" />
 		<file name="tests/stubs/oc_user_user.php" />
-		<file name="tests/stubs/oca_user_ldap_mapping_abstractmapping.php" />
-		<file name="tests/stubs/oca_user_ldap_mapping_usermapping.php" />
 		<file name="tests/stubs/oca_dav_carddav_contactsmanager.php" />
 		<file name="tests/stubs/oca_federatedfilesharing_notifications.php" />
+		<file name="tests/stubs/oca_files_sharing_event_usershareaccessupdatedevent.php" />
 		<file name="tests/stubs/oca_files_sharing_external_manager.php" />
+		<file name="tests/stubs/oca_user_ldap_mapping_abstractmapping.php" />
+		<file name="tests/stubs/oca_user_ldap_mapping_usermapping.php" />
 		<file name="tests/stubs/stecman_component_symfony_console_bashcompletion_completion_completionawareinterface.php" />
 		<file name="tests/stubs/symfony_component_console_command_command.php" />
 		<file name="tests/stubs/symfony_component_console_helper_helper.php" />

tests/stubs/doctrine_dbal_connection.php

@@ -9,14 +9,19 @@
 use Doctrine\DBAL\Cache\QueryCacheProfile;
 use Doctrine\DBAL\Driver\API\ExceptionConverter;
 use Doctrine\DBAL\Driver\Connection as DriverConnection;
+use Doctrine\DBAL\Driver\Exception as TheDriverException;
 use Doctrine\DBAL\Driver\ServerInfoAwareConnection;
 use Doctrine\DBAL\Driver\Statement as DriverStatement;
 use Doctrine\DBAL\Event\TransactionBeginEventArgs;
 use Doctrine\DBAL\Event\TransactionCommitEventArgs;
 use Doctrine\DBAL\Event\TransactionRollBackEventArgs;
 use Doctrine\DBAL\Exception\ConnectionLost;
+use Doctrine\DBAL\Exception\DeadlockException;
 use Doctrine\DBAL\Exception\DriverException;
+use Doctrine\DBAL\Exception\ForeignKeyConstraintViolationException;
 use Doctrine\DBAL\Exception\InvalidArgumentException;
+use Doctrine\DBAL\Exception\TransactionRolledBack;
+use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Query\Expression\ExpressionBuilder;
 use Doctrine\DBAL\Query\QueryBuilder;
@@ -48,8 +53,8 @@
  * A database abstraction-level connection that implements features like events, transaction isolation levels,
  * configuration, emulated transaction nesting, lazy connecting and more.
  *
- * @psalm-import-type Params from DriverManager
- * @psalm-consistent-constructor
+ * @phpstan-import-type Params from DriverManager
+ * @phpstan-consistent-constructor
  */
 class Connection
 {
@@ -130,7 +135,7 @@ class Connection
      * @param Driver              $driver       The driver to use.
      * @param Configuration|null  $config       The configuration, optional.
      * @param EventManager|null   $eventManager The event manager, optional.
-     * @psalm-param Params $params
+     * @phpstan-param Params $params
      *
      * @throws Exception
      */
@@ -145,7 +150,7 @@ public function __construct(#[SensitiveParameter]
      * @internal
      *
      * @return array<string,mixed>
-     * @psalm-return Params
+     * @phpstan-return Params
      */
     public function getParams()
     {
@@ -232,7 +237,7 @@ public function getExpressionBuilder()
      *
      * @throws Exception
      *
-     * @psalm-assert !null $this->_conn
+     * @phpstan-assert !null $this->_conn
      */
     public function connect()
     {

tests/stubs/doctrine_dbal_connections_primaryreadreplicaconnection.php

@@ -59,7 +59,7 @@
  *
  * Instantiation through the DriverManager looks like:
  *
- * @psalm-import-type Params from DriverManager
+ * @phpstan-import-type Params from DriverManager
  * @example
  *
  * $conn = DriverManager::getConnection(array(
@@ -98,7 +98,7 @@ class PrimaryReadReplicaConnection extends Connection
      * @internal The connection can be only instantiated by the driver manager.
      *
      * @param array<string,mixed> $params
-     * @psalm-param Params $params
+     * @phpstan-param Params $params
      *
      * @throws Exception
      * @throws InvalidArgumentException

tests/stubs/doctrine_dbal_driver_exception.php

@@ -6,7 +6,6 @@
 
 use Throwable;
 
-/** @psalm-immutable */
 interface Exception extends Throwable
 {
     /**

tests/stubs/doctrine_dbal_exception.php

@@ -13,7 +13,6 @@
 use function spl_object_hash;
 use function sprintf;
 
-/** @psalm-immutable */
 class Exception extends \Exception
 {
     public static function notSupported(string $method): self

tests/stubs/doctrine_dbal_exception_constraintviolationexception.php

@@ -4,8 +4,6 @@
 
 /**
  * Base class for all constraint violation related errors detected in the driver.
- *
- * @psalm-immutable
  */
 class ConstraintViolationException extends ServerException
 {

tests/stubs/doctrine_dbal_exception_driverexception.php

@@ -10,8 +10,6 @@
 
 /**
  * Base class for all errors detected in the driver.
- *
- * @psalm-immutable
  */
 class DriverException extends Exception implements TheDriverException
 {

tests/stubs/doctrine_dbal_exception_serverexception.php

@@ -4,8 +4,6 @@
 
 /**
  * Base class for all server related errors detected in the driver.
- *
- * @psalm-immutable
  */
 class ServerException extends DriverException
 {