Merge pull request #2275 from nextcloud/feature/54562/implement-ipartialshareprovider

feature: implement IPartialShareProvider support

Author: artonge

lib/Db/CoreQueryBuilder.php

@@ -345,6 +345,20 @@ public function limitToFileSource(int $nodeId): void {
 		$this->limitInt('file_source', $nodeId);
 	}
 
+	public function limitToFileTarget(string $target, string $alias): void {
+		$this->orWhere(
+			$this->exprLimit('file_target', $target),
+			$this->exprLimit('file_target', $target, $alias),
+		);
+	}
+
+	public function limitToFileTargetLike(string $target, string $alias): void {
+		$this->orWhere(
+			$this->exprLike('file_target', $target),
+			$this->exprLike('file_target', $target, $alias),
+		);
+	}
+
 	/**
 	 * @param array $files
 	 */
@@ -1465,9 +1479,11 @@ public function leftJoinFileCache(string $aliasShare) {
 	 * @param string $aliasShare
 	 * @param string $aliasShareMemberships
 	 *
+	 * @return string the alias generated for the join
+	 *
 	 * @throws RequestBuilderException
 	 */
-	public function leftJoinShareChild(string $aliasShare, string $aliasShareMemberships = '') {
+	public function leftJoinShareChild(string $aliasShare, string $aliasShareMemberships = ''): string {
 		$expr = $this->expr();
 
 		$aliasShareChild = $this->generateAlias($aliasShare, self::SHARE);
@@ -1491,6 +1507,7 @@ public function leftJoinShareChild(string $aliasShare, string $aliasShareMembers
 		);
 
 		//		$this->selectAlias($aliasShareParent . '.permissions', 'parent_perms');
+		return $aliasShareChild;
 	}
 
 

lib/Db/ShareWrapperRequest.php

@@ -359,6 +359,40 @@ public function getSharedWith(
 		return $this->getItemsFromRequest($qb);
 	}
 
+	public function getSharedWithByPath(
+		FederatedUser $federatedUser,
+		string $path,
+		bool $forChildren,
+		CircleProbe $probe,
+	): array {
+		$qb = $this->getShareSelectSql();
+		$qb->setOptions(
+			[CoreQueryBuilder::SHARE],
+			array_merge(
+				$probe->getAsOptions(),
+				['getData' => true]
+			)
+		);
+
+		$qb->leftJoinCircle(CoreQueryBuilder::SHARE, null, 'share_with');
+
+		$aliasCircle = $qb->generateAlias(CoreQueryBuilder::SHARE, CoreQueryBuilder::CIRCLE);
+		$qb->limitToFederatedUserMemberships(CoreQueryBuilder::SHARE, $aliasCircle, $federatedUser);
+
+		$qb->leftJoinFileCache(CoreQueryBuilder::SHARE);
+		$qb->limitNull('parent', false);
+		$childAlias = $qb->leftJoinShareChild(CoreQueryBuilder::SHARE);
+
+		if ($forChildren) {
+			$qb->limitToFileTargetLike($path . '_%', $childAlias);
+		} else {
+			$qb->limitToFileTarget($path, $childAlias);
+		}
+
+		$qb->chunk($probe->getItemsOffset(), $probe->getItemsLimit());
+
+		return $this->getItemsFromRequest($qb);
+	}
 
 	/**
 	 * @param FederatedUser $federatedUser

lib/Service/ShareWrapperService.php

@@ -239,6 +239,29 @@ public function getSharedWith(
 		return $shares;
 	}
 
+	public function getSharedWithByPath(
+		FederatedUser $federatedUser,
+		string $path,
+		bool $forChildren,
+		?CircleProbe $probe,
+	): array {
+		$key = $this->generateSharedWithByPathCacheKey($federatedUser, $path, $forChildren, $probe?->getChecksum());
+
+		$cachedData = $this->cache->get($key);
+		try {
+			if (!is_string($cachedData)) {
+				throw new InvalidItemException();
+			}
+
+			return $this->deserializeList($cachedData, ShareWrapper::class);
+		} catch (InvalidItemException $e) {
+		}
+
+		$shares = $this->shareWrapperRequest->getSharedWithByPath($federatedUser, $path, $forChildren, $probe);
+		$this->cache->set($key, json_encode($shares), self::CACHE_SHARED_WITH_TTL);
+
+		return $shares;
+	}
 
 	/**
 	 * @param FederatedUser $federatedUser
@@ -322,6 +345,18 @@ private function createChild(IShare $share, FederatedUser $federatedUser): Share
 		return $this->getShareById($childId, $federatedUser);
 	}
 
+	private function generateSharedWithByPathCacheKey(
+		FederatedUser $federatedUser,
+		string $path,
+		bool $forChildren,
+		?string $probeSum,
+	): string {
+		$pathHash = \md5($path);
+		return $federatedUser->getSingleId() . '#'
+			. $pathHash . '#'
+			. $forChildren . '#'
+			. $probeSum;
+	}
 
 	/**
 	 * @param FederatedUser $federatedUser

lib/ShareByCircleProvider.php

@@ -56,6 +56,7 @@
 use OCP\Share\Exceptions\AlreadySharedException;
 use OCP\Share\Exceptions\IllegalIDChangeException;
 use OCP\Share\Exceptions\ShareNotFound;
+use OCP\Share\IPartialShareProvider;
 use OCP\Share\IShare;
 use OCP\Share\IShareProvider;
 use Psr\Log\LoggerInterface;
@@ -65,7 +66,7 @@
  *
  * @package OCA\Circles
  */
-class ShareByCircleProvider implements IShareProvider {
+class ShareByCircleProvider implements IShareProvider, IPartialShareProvider {
 	use TArrayTools;
 	use TStringTools;
 	use TNCLogger;
@@ -522,6 +523,44 @@ function (ShareWrapper $wrapper) {
 		);
 	}
 
+	public function getSharedWithByPath(
+		string $userId,
+		int $shareType,
+		string $path,
+		bool $forChildren,
+		int $limit,
+		int $offset,
+	): iterable {
+		if ($shareType !== IShare::TYPE_CIRCLE) {
+			return [];
+		}
+
+		$federatedUser = $this->federatedUserService->getLocalFederatedUser($userId);
+		$probe = new CircleProbe();
+		$probe->includePersonalCircles()
+			->includeSystemCircles()
+			->mustBeMember()
+			->setItemsLimit($limit)
+			->setItemsOffset($offset);
+
+		$wrappedShares = $this->shareWrapperService->getSharedWithByPath(
+			$federatedUser,
+			$path,
+			$forChildren,
+			$probe,
+		);
+
+		/** @var array<string, IShare> */
+		return array_filter(
+			array_map(
+				function (ShareWrapper $wrapper) {
+					return $wrapper->getShare(
+						$this->rootFolder, $this->userManager, $this->urlGenerator, true
+					);
+				}, $wrappedShares
+			)
+		);
+	}
 
 	/**
 	 * @param string $token

tests/psalm-baseline.xml

@@ -374,9 +374,6 @@
     </UndefinedDocblockClass>
   </file>
   <file src="lib/ShareByCircleProvider.php">
-    <ImplementedParamTypeMismatch>
-      <code><![CDATA[$shareId]]></code>
-    </ImplementedParamTypeMismatch>
     <InvalidNullableReturnType>
       <code><![CDATA[IShare]]></code>
       <code><![CDATA[IShare]]></code>
@@ -386,6 +383,7 @@
     </InvalidNullableReturnType>
     <LessSpecificImplementedReturnType>
       <code><![CDATA[array]]></code>
+      <code><![CDATA[iterable]]></code>
     </LessSpecificImplementedReturnType>
     <NullableReturnStatement>
       <code><![CDATA[$wrappedShare->getShare($this->rootFolder, $this->userManager, $this->urlGenerator)]]></code>