Move any circles API usage to internal service

Signed-off-by: Julius Härtl <jus@bitgrid.net>
2021-12-29 16:09:24 +01:00
parent bfc8222e6f
commit eaf6defe59
6 changed files with 60 additions and 50 deletions
--- a/lib/Db/BoardMapper.php
+++ b/lib/Db/BoardMapper.php
@@ -24,6 +24,7 @@
 namespace OCA\Deck\Db;

 use OC\Cache\CappedMemoryCache;
+use OCA\Deck\Service\CirclesService;
 use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\AppFramework\Db\QBMapper;
 use OCP\DB\QueryBuilder\IQueryBuilder;
@@ -38,10 +39,9 @@ class BoardMapper extends QBMapper implements IPermissionMapper {
 	private $stackMapper;
 	private $userManager;
 	private $groupManager;
+	private $circlesService;
 	private $logger;

-	private $circlesEnabled;
-
 	/** @var CappedMemoryCache */
 	private $userBoardCache;
 	/** @var CappedMemoryCache */
@@ -54,6 +54,7 @@ class BoardMapper extends QBMapper implements IPermissionMapper {
 		StackMapper $stackMapper,
 		IUserManager $userManager,
 		IGroupManager $groupManager,
+		CirclesService $circlesService,
 		LoggerInterface $logger
 	) {
 		parent::__construct($db, 'deck_boards', Board::class);
@@ -62,12 +63,11 @@ class BoardMapper extends QBMapper implements IPermissionMapper {
 		$this->stackMapper = $stackMapper;
 		$this->userManager = $userManager;
 		$this->groupManager = $groupManager;
+		$this->circlesService = $circlesService;
 		$this->logger = $logger;

 		$this->userBoardCache = new CappedMemoryCache();
 		$this->boardCache = new CappedMemoryCache();
-
-		$this->circlesEnabled = \OC::$server->getAppManager()->isEnabledForUser('circles');
 	}


@@ -315,12 +315,7 @@ class BoardMapper extends QBMapper implements IPermissionMapper {

 	public function findAllByCircles(string $userId, ?int $limit = null, ?int $offset = null, ?int $since = null,
 									 bool $includeArchived = true, ?int $before = null, ?string $term = null) {
-		if (!$this->circlesEnabled) {
-			return [];
-		}
-		$circles = array_map(function ($circle) {
-			return $circle->getUniqueId();
-		}, \OCA\Circles\Api\v1\Circles::joinedCircles($userId, true));
+		$circles = $this->circlesService->getUserCircles($userId);
 		if (count($circles) === 0) {
 			return [];
 		}
@@ -449,11 +444,11 @@ class BoardMapper extends QBMapper implements IPermissionMapper {
 				return null;
 			}
 			if ($acl->getType() === Acl::PERMISSION_TYPE_CIRCLE) {
-				if (!$this->circlesEnabled) {
+				if (!$this->circlesService->isCirclesEnabled()) {
 					return null;
 				}
 				try {
-					$circle = \OCA\Circles\Api\v1\Circles::detailsCircle($acl->getParticipant(), true);
+					$circle = $this->circlesService->getCircle($acl->getParticipant());
 					if ($circle) {
 						return new Circle($circle);
 					}
--- a/lib/Service/CirclesService.php
+++ b/lib/Service/CirclesService.php
@@ -27,8 +27,11 @@ declare(strict_types=1);
 namespace OCA\Deck\Service;

 use OCA\Circles\CirclesManager;
+use OCA\Circles\Model\Circle;
 use OCA\Circles\Model\Member;
+use OCA\Circles\Model\Probes\CircleProbe;
 use OCP\App\IAppManager;
+use Throwable;

 /**
 * Wrapper around circles app API since it is not in a public namespace so we need to make sure that
@@ -45,15 +48,24 @@ class CirclesService {
 		return $this->circlesEnabled;
 	}

-	public function getCircle($circleId) {
+	public function getCircle(string $circleId): ?Circle {
 		if (!$this->circlesEnabled) {
 			return null;
 		}

-		return \OCA\Circles\Api\v1\Circles::detailsCircle($circleId, true);
+		try {
+
+			// Enforce current user condition since we always want the full list of members
+			/** @var CirclesManager $circlesManager */
+			$circlesManager = \OC::$server->get(CirclesManager::class);
+			$circlesManager->startSuperSession();
+			return $circlesManager->getCircle($circleId);
+		} catch (Throwable $e) {
+		}
+		return null;
 	}

-	public function isUserInCircle($circleId, $userId): bool {
+	public function isUserInCircle(string $circleId, string $userId): bool {
 		if (!$this->circlesEnabled) {
 			return false;
 		}
@@ -66,8 +78,32 @@ class CirclesService {
 			$circle = $circlesManager->getCircle($circleId);
 			$member = $circle->getInitiator();
 			return $member !== null && $member->getLevel() >= Member::LEVEL_MEMBER;
-		} catch (\Exception $e) {
+		} catch (Throwable $e) {
 		}
 		return false;
 	}
+
+	/**
+	 * @param string $userId
+	 * @return string[] circle single ids
+	 */
+	public function getUserCircles(string $userId): array {
+		if (!$this->circlesEnabled) {
+			return [];
+		}
+
+		try {
+			/** @var CirclesManager $circlesManager */
+			$circlesManager = \OC::$server->get(CirclesManager::class);
+			$federatedUser = $circlesManager->getFederatedUser($userId, Member::TYPE_USER);
+			$circlesManager->startSession($federatedUser);
+			$probe = new CircleProbe();
+			$probe->mustBeMember();
+			return array_map(function (Circle $circle) {
+				return $circle->getSingleId();
+			}, $circlesManager->getCircles($probe));
+		} catch (Throwable $e) {
+		}
+		return [];
+	}
 }
--- a/lib/Service/PermissionService.php
+++ b/lib/Service/PermissionService.php
@@ -280,14 +280,14 @@ class PermissionService {

 			if ($this->circlesService->isCirclesEnabled() && $acl->getType() === Acl::PERMISSION_TYPE_CIRCLE) {
 				try {
-					$circle = \OCA\Circles\Api\v1\Circles::detailsCircle($acl->getParticipant(), true);
+					$circle = $this->circlesService->getCircle($acl->getParticipant());
 					if ($circle === null) {
 						$this->logger->info('No circle found for acl rule ' . $acl->getId());
 						continue;
 					}

 					foreach ($circle->getInheritedMembers() as $member) {
-						if ($member->getUserType() !== 1 || $member->getLevel() >= Member::LEVEL_MEMBER) {
+						if ($member->getUserType() !== 1 || $member->getLevel() < Member::LEVEL_MEMBER) {
 							// deck currently only supports user members in circles
 							continue;
 						}
--- a/tests/psalm-baseline.xml
+++ b/tests/psalm-baseline.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="4.11.2@6fba5eb554f9507b72932f9c75533d8af593688d">
+<files psalm-version="4.16.1@aa7e400908833b10c0333861f86cd48c510b60eb">
  <file src="lib/Activity/ActivityManager.php">
    <TypeDoesNotContainType occurrences="1">
      <code>$message !== null</code>
@@ -124,10 +124,6 @@
      <code>$offset !== null</code>
      <code>$offset !== null</code>
    </TypeDoesNotContainType>
-    <UndefinedClass occurrences="2">
-      <code>\OCA\Circles\Api\v1\Circles</code>
-      <code>\OCA\Circles\Api\v1\Circles</code>
-    </UndefinedClass>
  </file>
  <file src="lib/Db/Card.php">
    <UndefinedClass occurrences="2">
@@ -136,7 +132,6 @@
    </UndefinedClass>
  </file>
  <file src="lib/Db/CardMapper.php">
-    <InvalidArgument occurrences="1"/>
    <InvalidScalarArgument occurrences="1">
      <code>$entity-&gt;getId()</code>
    </InvalidScalarArgument>
@@ -224,9 +219,11 @@
  </file>
  <file src="lib/Service/CirclesService.php">
    <UndefinedClass occurrences="1">
-      <code>\OCA\Circles\Api\v1\Circles</code>
+      <code>?Circle</code>
    </UndefinedClass>
-    <UndefinedDocblockClass occurrences="1">
+    <UndefinedDocblockClass occurrences="3">
+      <code>$circlesManager</code>
+      <code>$circlesManager</code>
      <code>$circlesManager</code>
    </UndefinedDocblockClass>
  </file>
@@ -272,17 +269,16 @@
    </RedundantCondition>
  </file>
  <file src="lib/Service/FilesAppService.php">
-    <MissingDependency occurrences="4">
+    <MissingDependency occurrences="3">
      <code>$this-&gt;rootFolder</code>
      <code>$this-&gt;rootFolder</code>
      <code>IRootFolder</code>
-      <code>ShareNotFound</code>
    </MissingDependency>
  </file>
  <file src="lib/Service/PermissionService.php">
    <UndefinedClass occurrences="2">
+      <code>$circle</code>
      <code>Member</code>
-      <code>\OCA\Circles\Api\v1\Circles</code>
    </UndefinedClass>
  </file>
  <file src="lib/Service/StackService.php">
@@ -290,27 +286,6 @@
      <code>BadRquestException</code>
    </UndefinedClass>
  </file>
-  <file src="lib/Sharing/DeckShareProvider.php">
-    <InvalidReturnStatement occurrences="1">
-      <code>$shares</code>
-    </InvalidReturnStatement>
-    <InvalidReturnType occurrences="1">
-      <code>getSharesInFolder</code>
-    </InvalidReturnType>
-    <InvalidThrow occurrences="1">
-      <code>throw new GenericShareException('Already shared', $this-&gt;l-&gt;t('Path is already shared with this card'), 403);</code>
-    </InvalidThrow>
-    <MissingDependency occurrences="8">
-      <code>GenericShareException</code>
-      <code>GenericShareException</code>
-      <code>ShareNotFound</code>
-      <code>ShareNotFound</code>
-      <code>ShareNotFound</code>
-      <code>ShareNotFound</code>
-      <code>ShareNotFound</code>
-      <code>ShareNotFound</code>
-    </MissingDependency>
-  </file>
  <file src="lib/Sharing/Listener.php">
    <InvalidArgument occurrences="1">
      <code>[self::class, 'listenPreShare']</code>
--- a/tests/unit/Db/AclMapperTest.php
+++ b/tests/unit/Db/AclMapperTest.php
@@ -23,6 +23,7 @@

 namespace OCA\Deck\Db;

+use OCA\Deck\Service\CirclesService;
 use OCP\IGroupManager;
 use OCP\IUserManager;
 use Psr\Log\LoggerInterface;
@@ -56,6 +57,7 @@ class AclMapperTest extends MapperTestUtility {
 			\OC::$server->query(StackMapper::class),
 			$this->userManager,
 			$this->groupManager,
+			$this->createMock(CirclesService::class),
 			$this->createMock(LoggerInterface::class)
 		);

--- a/tests/unit/Db/BoardMapperTest.php
+++ b/tests/unit/Db/BoardMapperTest.php
@@ -23,6 +23,7 @@

 namespace OCA\Deck\Db;

+use OCA\Deck\Service\CirclesService;
 use OCP\IDBConnection;
 use OCP\IGroupManager;
 use OCP\IUserManager;
@@ -63,6 +64,7 @@ class BoardMapperTest extends MapperTestUtility {
 			\OC::$server->query(StackMapper::class),
 			$this->userManager,
 			$this->groupManager,
+			$this->createMock(CirclesService::class),
 			$this->createMock(LoggerInterface::class)
 		);
 		$this->aclMapper = \OC::$server->query(AclMapper::class);