nextcloud / server

lib/public/ITags.php

Indentation +188 added lines, -188 removed lines

@@ -25,192 +25,192 @@
  */
 
 interface ITags {
-	/**
-	 * @since 19.0.0
-	 */
-	public const TAG_FAVORITE = '_$!<Favorite>!$_';
-
-	/**
-	 * Check if any tags are saved for this type and user.
-	 * @since 6.0.0
-	 */
-	public function isEmpty(): bool;
-
-	/**
-	 * Returns an array mapping a given tag's properties to its values:
-	 * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
-	 *
-	 * @param string $id The ID of the tag that is going to be mapped
-	 * @return array|false
-	 * @since 8.0.0
-	 */
-	public function getTag(string $id);
-
-	/**
-	 * Get the tags for a specific user.
-	 *
-	 * This returns an array with id/name maps:
-	 *
-	 * ```php
-	 * [
-	 * 	['id' => 0, 'name' = 'First tag'],
-	 * 	['id' => 1, 'name' = 'Second tag'],
-	 * ]
-	 * ```
-	 *
-	 * @return array<array-key, array{id: int, name: string}>
-	 * @since 6.0.0
-	 */
-	public function getTags(): array;
-
-	/**
-	 * Get a list of tags for the given item ids.
-	 *
-	 * This returns an array with object id / tag names:
-	 *
-	 * ```php
-	 * [
-	 *   1 => array('First tag', 'Second tag'),
-	 *   2 => array('Second tag'),
-	 *   3 => array('Second tag', 'Third tag'),
-	 * ]
-	 * ```
-	 *
-	 * @param list<int> $objIds item ids
-	 * @return array<int, list<string>>|false with object id as key and an array
-	 *                                        of tag names as value or false if an error occurred
-	 * @since 8.0.0
-	 */
-	public function getTagsForObjects(array $objIds);
-
-	/**
-	 * Get a list of items tagged with $tag.
-	 *
-	 * Throws an exception if the tag could not be found.
-	 *
-	 * @param string|integer $tag Tag id or name.
-	 * @return array|false An array of object ids or false on error.
-	 * @since 6.0.0
-	 */
-	public function getIdsForTag($tag);
-
-	/**
-	 * Checks whether a tag is already saved.
-	 *
-	 * @param string $name The name to check for.
-	 * @since 6.0.0
-	 */
-	public function hasTag(string $name): bool;
-
-	/**
-	 * Checks whether a tag is saved for the given user,
-	 * disregarding the ones shared with them.
-	 *
-	 * @param string $name The tag name to check for.
-	 * @param string $user The user whose tags are to be checked.
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function userHasTag(string $name, string $user): bool;
-
-	/**
-	 * Add a new tag.
-	 *
-	 * @param string $name A string with a name of the tag
-	 * @return int|false the id of the added tag or false if it already exists.
-	 * @since 6.0.0
-	 */
-	public function add(string $name);
-
-	/**
-	 * Rename tag.
-	 *
-	 * @param string|integer $from The name or ID of the existing tag
-	 * @param string $to The new name of the tag.
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function rename($from, string $to): bool;
-
-	/**
-	 * Add a list of new tags.
-	 *
-	 * @param string|string[] $names A string with a name or an array of strings containing
-	 *                               the name(s) of the to add.
-	 * @param bool $sync When true, save the tags
-	 * @param int|null $id int Optional object id to add to this|these tag(s)
-	 * @return bool Returns false on error.
-	 * @since 6.0.0
-	 */
-	public function addMultiple($names, bool $sync = false, ?int $id = null): bool;
-
-	/**
-	 * Delete tag/object relations from the db
-	 *
-	 * @param array $ids The ids of the objects
-	 * @return boolean Returns false on error.
-	 * @since 6.0.0
-	 */
-	public function purgeObjects(array $ids);
-
-	/**
-	 * Get favorites for an object type
-	 *
-	 * @return array|false An array of object ids.
-	 * @since 6.0.0
-	 */
-	public function getFavorites();
-
-	/**
-	 * Add an object to favorites
-	 *
-	 * @param int $objid The id of the object
-	 * @return boolean
-	 * @since 6.0.0
-	 */
-	public function addToFavorites($objid);
-
-	/**
-	 * Remove an object from favorites
-	 *
-	 * @param int $objid The id of the object
-	 * @return boolean
-	 * @since 6.0.0
-	 */
-	public function removeFromFavorites($objid);
-
-	/**
-	 * Creates a tag/object relation.
-	 *
-	 * @param int $objid The id of the object
-	 * @param string $tag The id or name of the tag
-	 * @param string $path The optional path of the node. Used when dispatching the favorite change event.
-	 * @return boolean Returns false on database error.
-	 * @since 6.0.0
-	 * @since 31.0.0 Added the $path argument.
-	 * @since 33.0.0 Change $path default value from '' to null.
-	 */
-	public function tagAs($objid, $tag, ?string $path = null);
-
-	/**
-	 * Delete single tag/object relation from the db
-	 *
-	 * @param int $objid The id of the object
-	 * @param string $tag The id or name of the tag
-	 * @param string $path The optional path of the node. Used when dispatching the favorite change event.
-	 * @return boolean
-	 * @since 6.0.0
-	 * @since 31.0.0 Added the $path argument.
-	 * @since 33.0.0 Change $path default value from '' to null.
-	 */
-	public function unTag($objid, $tag, ?string $path = null);
-
-	/**
-	 * Delete tags from the database
-	 *
-	 * @param string[]|integer[] $names An array of tags (names or IDs) to delete
-	 * @return bool Returns false on error
-	 * @since 6.0.0
-	 */
-	public function delete($names);
+    /**
+     * @since 19.0.0
+     */
+    public const TAG_FAVORITE = '_$!<Favorite>!$_';
+
+    /**
+     * Check if any tags are saved for this type and user.
+     * @since 6.0.0
+     */
+    public function isEmpty(): bool;
+
+    /**
+     * Returns an array mapping a given tag's properties to its values:
+     * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
+     *
+     * @param string $id The ID of the tag that is going to be mapped
+     * @return array|false
+     * @since 8.0.0
+     */
+    public function getTag(string $id);
+
+    /**
+     * Get the tags for a specific user.
+     *
+     * This returns an array with id/name maps:
+     *
+     * ```php
+     * [
+     * 	['id' => 0, 'name' = 'First tag'],
+     * 	['id' => 1, 'name' = 'Second tag'],
+     * ]
+     * ```
+     *
+     * @return array<array-key, array{id: int, name: string}>
+     * @since 6.0.0
+     */
+    public function getTags(): array;
+
+    /**
+     * Get a list of tags for the given item ids.
+     *
+     * This returns an array with object id / tag names:
+     *
+     * ```php
+     * [
+     *   1 => array('First tag', 'Second tag'),
+     *   2 => array('Second tag'),
+     *   3 => array('Second tag', 'Third tag'),
+     * ]
+     * ```
+     *
+     * @param list<int> $objIds item ids
+     * @return array<int, list<string>>|false with object id as key and an array
+     *                                        of tag names as value or false if an error occurred
+     * @since 8.0.0
+     */
+    public function getTagsForObjects(array $objIds);
+
+    /**
+     * Get a list of items tagged with $tag.
+     *
+     * Throws an exception if the tag could not be found.
+     *
+     * @param string|integer $tag Tag id or name.
+     * @return array|false An array of object ids or false on error.
+     * @since 6.0.0
+     */
+    public function getIdsForTag($tag);
+
+    /**
+     * Checks whether a tag is already saved.
+     *
+     * @param string $name The name to check for.
+     * @since 6.0.0
+     */
+    public function hasTag(string $name): bool;
+
+    /**
+     * Checks whether a tag is saved for the given user,
+     * disregarding the ones shared with them.
+     *
+     * @param string $name The tag name to check for.
+     * @param string $user The user whose tags are to be checked.
+     * @return bool
+     * @since 8.0.0
+     */
+    public function userHasTag(string $name, string $user): bool;
+
+    /**
+     * Add a new tag.
+     *
+     * @param string $name A string with a name of the tag
+     * @return int|false the id of the added tag or false if it already exists.
+     * @since 6.0.0
+     */
+    public function add(string $name);
+
+    /**
+     * Rename tag.
+     *
+     * @param string|integer $from The name or ID of the existing tag
+     * @param string $to The new name of the tag.
+     * @return bool
+     * @since 6.0.0
+     */
+    public function rename($from, string $to): bool;
+
+    /**
+     * Add a list of new tags.
+     *
+     * @param string|string[] $names A string with a name or an array of strings containing
+     *                               the name(s) of the to add.
+     * @param bool $sync When true, save the tags
+     * @param int|null $id int Optional object id to add to this|these tag(s)
+     * @return bool Returns false on error.
+     * @since 6.0.0
+     */
+    public function addMultiple($names, bool $sync = false, ?int $id = null): bool;
+
+    /**
+     * Delete tag/object relations from the db
+     *
+     * @param array $ids The ids of the objects
+     * @return boolean Returns false on error.
+     * @since 6.0.0
+     */
+    public function purgeObjects(array $ids);
+
+    /**
+     * Get favorites for an object type
+     *
+     * @return array|false An array of object ids.
+     * @since 6.0.0
+     */
+    public function getFavorites();
+
+    /**
+     * Add an object to favorites
+     *
+     * @param int $objid The id of the object
+     * @return boolean
+     * @since 6.0.0
+     */
+    public function addToFavorites($objid);
+
+    /**
+     * Remove an object from favorites
+     *
+     * @param int $objid The id of the object
+     * @return boolean
+     * @since 6.0.0
+     */
+    public function removeFromFavorites($objid);
+
+    /**
+     * Creates a tag/object relation.
+     *
+     * @param int $objid The id of the object
+     * @param string $tag The id or name of the tag
+     * @param string $path The optional path of the node. Used when dispatching the favorite change event.
+     * @return boolean Returns false on database error.
+     * @since 6.0.0
+     * @since 31.0.0 Added the $path argument.
+     * @since 33.0.0 Change $path default value from '' to null.
+     */
+    public function tagAs($objid, $tag, ?string $path = null);
+
+    /**
+     * Delete single tag/object relation from the db
+     *
+     * @param int $objid The id of the object
+     * @param string $tag The id or name of the tag
+     * @param string $path The optional path of the node. Used when dispatching the favorite change event.
+     * @return boolean
+     * @since 6.0.0
+     * @since 31.0.0 Added the $path argument.
+     * @since 33.0.0 Change $path default value from '' to null.
+     */
+    public function unTag($objid, $tag, ?string $path = null);
+
+    /**
+     * Delete tags from the database
+     *
+     * @param string[]|integer[] $names An array of tags (names or IDs) to delete
+     * @return bool Returns false on error
+     * @since 6.0.0
+     */
+    public function delete($names);
 }

lib/private/TagManager.php

Indentation +100 added lines, -100 removed lines

@@ -26,115 +26,115 @@
  */
 class TagManager implements ITagManager, IEventListener {
 
-	public function __construct(
-		private TagMapper $mapper,
-		private IUserSession $userSession,
-		private IDBConnection $connection,
-		private LoggerInterface $logger,
-		private IEventDispatcher $dispatcher,
-		private IRootFolder $rootFolder,
-	) {
-	}
+    public function __construct(
+        private TagMapper $mapper,
+        private IUserSession $userSession,
+        private IDBConnection $connection,
+        private LoggerInterface $logger,
+        private IEventDispatcher $dispatcher,
+        private IRootFolder $rootFolder,
+    ) {
+    }
 
-	/**
-	 * Create a new \OCP\ITags instance and load tags from db.
-	 *
-	 * @see \OCP\ITags
-	 * @param string $type The type identifier e.g. 'contact' or 'event'.
-	 * @param array $defaultTags An array of default tags to be used if none are stored.
-	 * @param boolean $includeShared Whether to include tags for items shared with this user by others.
-	 * @param string $userId user for which to retrieve the tags, defaults to the currently
-	 *                       logged in user
-	 * @return \OCP\ITags
-	 *
-	 * since 20.0.0 $includeShared isn't used anymore
-	 */
-	public function load($type, $defaultTags = [], $includeShared = false, $userId = null) {
-		if (is_null($userId)) {
-			$user = $this->userSession->getUser();
-			if ($user === null) {
-				// nothing we can do without a user
-				return null;
-			}
-			$userId = $this->userSession->getUser()->getUId();
-		}
-		$userFolder = $this->rootFolder->getUserFolder($userId);
-		return new Tags($this->mapper, $userId, $type, $this->logger, $this->connection, $this->dispatcher, $this->userSession, $userFolder, $defaultTags);
-	}
+    /**
+     * Create a new \OCP\ITags instance and load tags from db.
+     *
+     * @see \OCP\ITags
+     * @param string $type The type identifier e.g. 'contact' or 'event'.
+     * @param array $defaultTags An array of default tags to be used if none are stored.
+     * @param boolean $includeShared Whether to include tags for items shared with this user by others.
+     * @param string $userId user for which to retrieve the tags, defaults to the currently
+     *                       logged in user
+     * @return \OCP\ITags
+     *
+     * since 20.0.0 $includeShared isn't used anymore
+     */
+    public function load($type, $defaultTags = [], $includeShared = false, $userId = null) {
+        if (is_null($userId)) {
+            $user = $this->userSession->getUser();
+            if ($user === null) {
+                // nothing we can do without a user
+                return null;
+            }
+            $userId = $this->userSession->getUser()->getUId();
+        }
+        $userFolder = $this->rootFolder->getUserFolder($userId);
+        return new Tags($this->mapper, $userId, $type, $this->logger, $this->connection, $this->dispatcher, $this->userSession, $userFolder, $defaultTags);
+    }
 
-	/**
-	 * Get all users who favorited an object
-	 *
-	 * @param string $objectType
-	 * @param int $objectId
-	 * @return array
-	 */
-	public function getUsersFavoritingObject(string $objectType, int $objectId): array {
-		$query = $this->connection->getQueryBuilder();
-		$query->select('uid')
-			->from('vcategory_to_object', 'o')
-			->innerJoin('o', 'vcategory', 'c', $query->expr()->eq('o.categoryid', 'c.id'))
-			->where($query->expr()->eq('objid', $query->createNamedParameter($objectId, IQueryBuilder::PARAM_INT)))
-			->andWhere($query->expr()->eq('c.type', $query->createNamedParameter($objectType)))
-			->andWhere($query->expr()->eq('c.category', $query->createNamedParameter(ITags::TAG_FAVORITE)));
+    /**
+     * Get all users who favorited an object
+     *
+     * @param string $objectType
+     * @param int $objectId
+     * @return array
+     */
+    public function getUsersFavoritingObject(string $objectType, int $objectId): array {
+        $query = $this->connection->getQueryBuilder();
+        $query->select('uid')
+            ->from('vcategory_to_object', 'o')
+            ->innerJoin('o', 'vcategory', 'c', $query->expr()->eq('o.categoryid', 'c.id'))
+            ->where($query->expr()->eq('objid', $query->createNamedParameter($objectId, IQueryBuilder::PARAM_INT)))
+            ->andWhere($query->expr()->eq('c.type', $query->createNamedParameter($objectType)))
+            ->andWhere($query->expr()->eq('c.category', $query->createNamedParameter(ITags::TAG_FAVORITE)));
 
-		$result = $query->executeQuery();
-		$users = $result->fetchAll(\PDO::FETCH_COLUMN);
-		$result->closeCursor();
+        $result = $query->executeQuery();
+        $users = $result->fetchAll(\PDO::FETCH_COLUMN);
+        $result->closeCursor();
 
-		return $users;
-	}
+        return $users;
+    }
 
-	public function handle(Event $event): void {
-		if (!($event instanceof UserDeletedEvent)) {
-			return;
-		}
+    public function handle(Event $event): void {
+        if (!($event instanceof UserDeletedEvent)) {
+            return;
+        }
 
-		// Find all objectid/tagId pairs.
-		$user = $event->getUser();
-		$qb = $this->connection->getQueryBuilder();
-		$qb->select('id')
-			->from('vcategory')
-			->where($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())));
-		try {
-			$result = $qb->executeQuery();
-		} catch (DBException $e) {
-			$this->logger->error($e->getMessage(), [
-				'app' => 'core',
-				'exception' => $e,
-			]);
-			return;
-		}
+        // Find all objectid/tagId pairs.
+        $user = $event->getUser();
+        $qb = $this->connection->getQueryBuilder();
+        $qb->select('id')
+            ->from('vcategory')
+            ->where($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())));
+        try {
+            $result = $qb->executeQuery();
+        } catch (DBException $e) {
+            $this->logger->error($e->getMessage(), [
+                'app' => 'core',
+                'exception' => $e,
+            ]);
+            return;
+        }
 
-		$tagsIds = array_map(fn (array $row) => (int)$row['id'], $result->fetchAll());
-		$result->closeCursor();
+        $tagsIds = array_map(fn (array $row) => (int)$row['id'], $result->fetchAll());
+        $result->closeCursor();
 
-		if (count($tagsIds) === 0) {
-			return;
-		}
+        if (count($tagsIds) === 0) {
+            return;
+        }
 
-		// Clean vcategory_to_object table
-		$qb = $this->connection->getQueryBuilder();
-		$qb = $qb->delete('vcategory_to_object')
-			->where($qb->expr()->in('categoryid', $qb->createParameter('chunk')));
+        // Clean vcategory_to_object table
+        $qb = $this->connection->getQueryBuilder();
+        $qb = $qb->delete('vcategory_to_object')
+            ->where($qb->expr()->in('categoryid', $qb->createParameter('chunk')));
 
-		// Clean vcategory
-		$qb1 = $this->connection->getQueryBuilder();
-		$qb1 = $qb1->delete('vcategory')
-			->where($qb1->expr()->in('uid', $qb1->createParameter('chunk')));
+        // Clean vcategory
+        $qb1 = $this->connection->getQueryBuilder();
+        $qb1 = $qb1->delete('vcategory')
+            ->where($qb1->expr()->in('uid', $qb1->createParameter('chunk')));
 
-		foreach (array_chunk($tagsIds, 1000) as $tagChunk) {
-			$qb->setParameter('chunk', $tagChunk, IQueryBuilder::PARAM_INT_ARRAY);
-			$qb1->setParameter('chunk', $tagChunk, IQueryBuilder::PARAM_INT_ARRAY);
-			try {
-				$qb->executeStatement();
-				$qb1->executeStatement();
-			} catch (DBException $e) {
-				$this->logger->error($e->getMessage(), [
-					'app' => 'core',
-					'exception' => $e,
-				]);
-			}
-		}
-	}
+        foreach (array_chunk($tagsIds, 1000) as $tagChunk) {
+            $qb->setParameter('chunk', $tagChunk, IQueryBuilder::PARAM_INT_ARRAY);
+            $qb1->setParameter('chunk', $tagChunk, IQueryBuilder::PARAM_INT_ARRAY);
+            try {
+                $qb->executeStatement();
+                $qb1->executeStatement();
+            } catch (DBException $e) {
+                $this->logger->error($e->getMessage(), [
+                    'app' => 'core',
+                    'exception' => $e,
+                ]);
+            }
+        }
+    }
 }

lib/private/Tags.php

Indentation +678 added lines, -678 removed lines

@@ -22,682 +22,682 @@
 use Psr\Log\LoggerInterface;
 
 class Tags implements ITags {
-	/**
-	 * Used for storing objectid/categoryname pairs while rescanning.
-	 */
-	private static array $relations = [];
-	private array $tags = [];
-
-	/**
-	 * Are we including tags for shared items?
-	 */
-	private bool $includeShared = false;
-
-	/**
-	 * The current user, plus any owners of the items shared with the current
-	 * user, if $this->includeShared === true.
-	 */
-	private array $owners = [];
-
-	/**
-	 * The sharing backend for objects of $this->type. Required if
-	 * $this->includeShared === true to determine ownership of items.
-	 */
-	private ?Share_Backend $backend = null;
-
-	public const TAG_TABLE = 'vcategory';
-	public const RELATION_TABLE = 'vcategory_to_object';
-
-	/**
-	 * Constructor.
-	 *
-	 * @param TagMapper $mapper Instance of the TagMapper abstraction layer.
-	 * @param string $user The user whose data the object will operate on.
-	 * @param string $type The type of items for which tags will be loaded.
-	 * @param array $defaultTags Tags that should be created at construction.
-	 *
-	 * since 20.0.0 $includeShared isn't used anymore
-	 */
-	public function __construct(
-		private TagMapper $mapper,
-		private string $user,
-		private string $type,
-		private LoggerInterface $logger,
-		private IDBConnection $db,
-		private IEventDispatcher $dispatcher,
-		private IUserSession $userSession,
-		private Folder $userFolder,
-		array $defaultTags = [],
-	) {
-		$this->owners = [$this->user];
-		$this->tags = $this->mapper->loadTags($this->owners, $this->type);
-
-		if (count($defaultTags) > 0 && count($this->tags) === 0) {
-			$this->addMultiple($defaultTags, true);
-		}
-	}
-
-	/**
-	 * Check if any tags are saved for this type and user.
-	 *
-	 * @return boolean
-	 */
-	public function isEmpty(): bool {
-		return count($this->tags) === 0;
-	}
-
-	/**
-	 * Returns an array mapping a given tag's properties to its values:
-	 * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
-	 *
-	 * @param string $id The ID of the tag that is going to be mapped
-	 * @return array|false
-	 */
-	public function getTag(string $id) {
-		$key = $this->getTagById($id);
-		if ($key !== false) {
-			return $this->tagMap($this->tags[$key]);
-		}
-		return false;
-	}
-
-	/**
-	 * Get the tags for a specific user.
-	 *
-	 * This returns an array with maps containing each tag's properties:
-	 * [
-	 * 	['id' => 0, 'name' = 'First tag', 'owner' = 'User', 'type' => 'tagtype'],
-	 * 	['id' => 1, 'name' = 'Shared tag', 'owner' = 'Other user', 'type' => 'tagtype'],
-	 * ]
-	 *
-	 * @return array<array-key, array{id: int, name: string}>
-	 */
-	public function getTags(): array {
-		if (!count($this->tags)) {
-			return [];
-		}
-
-		usort($this->tags, function ($a, $b) {
-			return strnatcasecmp($a->getName(), $b->getName());
-		});
-		$tagMap = [];
-
-		foreach ($this->tags as $tag) {
-			if ($tag->getName() !== ITags::TAG_FAVORITE) {
-				$tagMap[] = $this->tagMap($tag);
-			}
-		}
-		return $tagMap;
-	}
-
-	/**
-	 * Return only the tags owned by the given user, omitting any tags shared
-	 * by other users.
-	 *
-	 * @param string $user The user whose tags are to be checked.
-	 * @return array An array of Tag objects.
-	 */
-	public function getTagsForUser(string $user): array {
-		return array_filter($this->tags,
-			function ($tag) use ($user) {
-				return $tag->getOwner() === $user;
-			}
-		);
-	}
-
-	/**
-	 * Get the list of tags for the given ids.
-	 *
-	 * @param list<int> $objIds array of object ids
-	 * @return array<int, list<string>>|false of tags id as key to array of tag names
-	 *                                        or false if an error occurred
-	 */
-	public function getTagsForObjects(array $objIds) {
-		$entries = [];
-
-		try {
-			$chunks = array_chunk($objIds, 900, false);
-			$qb = $this->db->getQueryBuilder();
-			$qb->select('category', 'categoryid', 'objid')
-				->from(self::RELATION_TABLE, 'r')
-				->join('r', self::TAG_TABLE, 't', $qb->expr()->eq('r.categoryid', 't.id'))
-				->where($qb->expr()->eq('uid', $qb->createParameter('uid')))
-				->andWhere($qb->expr()->eq('r.type', $qb->createParameter('type')))
-				->andWhere($qb->expr()->in('objid', $qb->createParameter('chunk')));
-			foreach ($chunks as $chunk) {
-				$qb->setParameter('uid', $this->user, IQueryBuilder::PARAM_STR);
-				$qb->setParameter('type', $this->type, IQueryBuilder::PARAM_STR);
-				$qb->setParameter('chunk', $chunk, IQueryBuilder::PARAM_INT_ARRAY);
-				$result = $qb->executeQuery();
-				while ($row = $result->fetch()) {
-					$objId = (int)$row['objid'];
-					if (!isset($entries[$objId])) {
-						$entries[$objId] = [];
-					}
-					$entries[$objId][] = $row['category'];
-				}
-				$result->closeCursor();
-			}
-		} catch (\Exception $e) {
-			$this->logger->error($e->getMessage(), [
-				'exception' => $e,
-				'app' => 'core',
-			]);
-			return false;
-		}
-
-		return $entries;
-	}
-
-	/**
-	 * Get the a list if items tagged with $tag.
-	 *
-	 * Throws an exception if the tag could not be found.
-	 *
-	 * @param string $tag Tag id or name.
-	 * @return int[]|false An array of object ids or false on error.
-	 * @throws \Exception
-	 */
-	public function getIdsForTag($tag) {
-		$tagId = false;
-		if (is_numeric($tag)) {
-			$tagId = $tag;
-		} elseif (is_string($tag)) {
-			$tag = trim($tag);
-			if ($tag === '') {
-				$this->logger->debug(__METHOD__ . ' Cannot use empty tag names', ['app' => 'core']);
-				return false;
-			}
-			$tagId = $this->getTagId($tag);
-		}
-
-		if ($tagId === false) {
-			$l10n = \OCP\Util::getL10N('core');
-			throw new \Exception(
-				$l10n->t('Could not find category "%s"', [$tag])
-			);
-		}
-
-		$ids = [];
-		try {
-			$qb = $this->db->getQueryBuilder();
-			$qb->select('objid')
-				->from(self::RELATION_TABLE)
-				->where($qb->expr()->eq('categoryid', $qb->createNamedParameter($tagId, IQueryBuilder::PARAM_STR)));
-			$result = $qb->executeQuery();
-		} catch (Exception $e) {
-			$this->logger->error($e->getMessage(), [
-				'app' => 'core',
-				'exception' => $e,
-			]);
-			return false;
-		}
-
-		while ($row = $result->fetch()) {
-			$ids[] = (int)$row['objid'];
-		}
-		$result->closeCursor();
-
-		return $ids;
-	}
-
-	/**
-	 * Checks whether a tag is saved for the given user,
-	 * disregarding the ones shared with them.
-	 *
-	 * @param string $name The tag name to check for.
-	 * @param string $user The user whose tags are to be checked.
-	 */
-	public function userHasTag(string $name, string $user): bool {
-		return $this->array_searchi($name, $this->getTagsForUser($user)) !== false;
-	}
-
-	/**
-	 * Checks whether a tag is saved for or shared with the current user.
-	 *
-	 * @param string $name The tag name to check for.
-	 */
-	public function hasTag(string $name): bool {
-		return $this->getTagId($name) !== false;
-	}
-
-	/**
-	 * Add a new tag.
-	 *
-	 * @param string $name A string with a name of the tag
-	 * @return false|int the id of the added tag or false on error.
-	 */
-	public function add(string $name) {
-		$name = trim($name);
-
-		if ($name === '') {
-			$this->logger->debug(__METHOD__ . ' Cannot add an empty tag', ['app' => 'core']);
-			return false;
-		}
-		if ($this->userHasTag($name, $this->user)) {
-			$this->logger->debug(__METHOD__ . ' Tag with name already exists', ['app' => 'core']);
-			return false;
-		}
-		try {
-			$tag = new Tag($this->user, $this->type, $name);
-			$tag = $this->mapper->insert($tag);
-			$this->tags[] = $tag;
-		} catch (\Exception $e) {
-			$this->logger->error($e->getMessage(), [
-				'exception' => $e,
-				'app' => 'core',
-			]);
-			return false;
-		}
-		$this->logger->debug(__METHOD__ . ' Added an tag with ' . $tag->getId(), ['app' => 'core']);
-		return $tag->getId();
-	}
-
-	/**
-	 * Rename tag.
-	 *
-	 * @param string|integer $from The name or ID of the existing tag
-	 * @param string $to The new name of the tag.
-	 * @return bool
-	 */
-	public function rename($from, string $to): bool {
-		$from = trim($from);
-		$to = trim($to);
-
-		if ($to === '' || $from === '') {
-			$this->logger->debug(__METHOD__ . 'Cannot use an empty tag names', ['app' => 'core']);
-			return false;
-		}
-
-		if (is_numeric($from)) {
-			$key = $this->getTagById($from);
-		} else {
-			$key = $this->getTagByName($from);
-		}
-		if ($key === false) {
-			$this->logger->debug(__METHOD__ . 'Tag ' . $from . 'does not exist', ['app' => 'core']);
-			return false;
-		}
-		$tag = $this->tags[$key];
-
-		if ($this->userHasTag($to, $tag->getOwner())) {
-			$this->logger->debug(__METHOD__ . 'A tag named' . $to . 'already exists for user' . $tag->getOwner(), ['app' => 'core']);
-			return false;
-		}
-
-		try {
-			$tag->setName($to);
-			$this->tags[$key] = $this->mapper->update($tag);
-		} catch (\Exception $e) {
-			$this->logger->error($e->getMessage(), [
-				'exception' => $e,
-				'app' => 'core',
-			]);
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	 * Add a list of new tags.
-	 *
-	 * @param string|string[] $names A string with a name or an array of strings containing
-	 *                               the name(s) of the tag(s) to add.
-	 * @param bool $sync When true, save the tags
-	 * @param int|null $id int Optional object id to add to this|these tag(s)
-	 * @return bool Returns false on error.
-	 */
-	public function addMultiple($names, bool $sync = false, ?int $id = null): bool {
-		if (!is_array($names)) {
-			$names = [$names];
-		}
-		$names = array_map('trim', $names);
-		array_filter($names);
-
-		$newones = [];
-		foreach ($names as $name) {
-			if (!$this->hasTag($name) && $name !== '') {
-				$newones[] = new Tag($this->user, $this->type, $name);
-			}
-			if (!is_null($id)) {
-				// Insert $objectid, $categoryid  pairs if not exist.
-				self::$relations[] = ['objid' => $id, 'tag' => $name];
-			}
-		}
-		$this->tags = array_merge($this->tags, $newones);
-		if ($sync === true) {
-			$this->save();
-		}
-
-		return true;
-	}
-
-	/**
-	 * Save the list of tags and their object relations
-	 */
-	protected function save(): void {
-		foreach ($this->tags as $tag) {
-			try {
-				if (!$this->mapper->tagExists($tag)) {
-					$this->mapper->insert($tag);
-				}
-			} catch (\Exception $e) {
-				$this->logger->error($e->getMessage(), [
-					'exception' => $e,
-					'app' => 'core',
-				]);
-			}
-		}
-
-		// reload tags to get the proper ids.
-		$this->tags = $this->mapper->loadTags($this->owners, $this->type);
-		$this->logger->debug(__METHOD__ . 'tags' . print_r($this->tags, true), ['app' => 'core']);
-		// Loop through temporarily cached objectid/tagname pairs
-		// and save relations.
-		$tags = $this->tags;
-		// For some reason this is needed or array_search(i) will return 0..?
-		ksort($tags);
-		foreach (self::$relations as $relation) {
-			$tagId = $this->getTagId($relation['tag']);
-			$this->logger->debug(__METHOD__ . 'catid ' . $relation['tag'] . ' ' . $tagId, ['app' => 'core']);
-			if ($tagId) {
-				$qb = $this->db->getQueryBuilder();
-				$qb->insert(self::RELATION_TABLE)
-					->values([
-						'objid' => $qb->createNamedParameter($relation['objid'], IQueryBuilder::PARAM_INT),
-						'categoryid' => $qb->createNamedParameter($tagId, IQueryBuilder::PARAM_INT),
-						'type' => $qb->createNamedParameter($this->type),
-					]);
-				try {
-					$qb->executeStatement();
-				} catch (Exception $e) {
-					$this->logger->error($e->getMessage(), [
-						'exception' => $e,
-						'app' => 'core',
-					]);
-				}
-			}
-		}
-		self::$relations = []; // reset
-	}
-
-	/**
-	 * Delete tag/object relations from the db
-	 *
-	 * @param array $ids The ids of the objects
-	 * @return boolean Returns false on error.
-	 */
-	public function purgeObjects(array $ids): bool {
-		if (count($ids) === 0) {
-			// job done ;)
-			return true;
-		}
-		$updates = $ids;
-		$qb = $this->db->getQueryBuilder();
-		$qb->delete(self::RELATION_TABLE)
-			->where($qb->expr()->in('objid', $qb->createNamedParameter($ids)));
-		try {
-			$qb->executeStatement();
-		} catch (Exception $e) {
-			$this->logger->error($e->getMessage(), [
-				'app' => 'core',
-				'exception' => $e,
-			]);
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	 * Get favorites for an object type
-	 *
-	 * @return array|false An array of object ids.
-	 */
-	public function getFavorites() {
-		if (!$this->userHasTag(ITags::TAG_FAVORITE, $this->user)) {
-			return [];
-		}
-
-		try {
-			return $this->getIdsForTag(ITags::TAG_FAVORITE);
-		} catch (\Exception $e) {
-			\OCP\Server::get(LoggerInterface::class)->error(
-				$e->getMessage(),
-				[
-					'app' => 'core',
-					'exception' => $e,
-				]
-			);
-			return [];
-		}
-	}
-
-	/**
-	 * Add an object to favorites
-	 *
-	 * @param int $objid The id of the object
-	 * @return boolean
-	 */
-	public function addToFavorites($objid) {
-		if (!$this->userHasTag(ITags::TAG_FAVORITE, $this->user)) {
-			$this->add(ITags::TAG_FAVORITE);
-		}
-		return $this->tagAs($objid, ITags::TAG_FAVORITE);
-	}
-
-	/**
-	 * Remove an object from favorites
-	 *
-	 * @param int $objid The id of the object
-	 * @return boolean
-	 */
-	public function removeFromFavorites($objid) {
-		return $this->unTag($objid, ITags::TAG_FAVORITE);
-	}
-
-	/**
-	 * Creates a tag/object relation.
-	 */
-	public function tagAs($objid, $tag, ?string $path = null) {
-		if (is_string($tag) && !is_numeric($tag)) {
-			$tag = trim($tag);
-			if ($tag === '') {
-				$this->logger->debug(__METHOD__ . ', Cannot add an empty tag');
-				return false;
-			}
-			if (!$this->hasTag($tag)) {
-				$this->add($tag);
-			}
-			$tagId = $this->getTagId($tag);
-		} else {
-			$tagId = $tag;
-		}
-		$qb = $this->db->getQueryBuilder();
-		$qb->insert(self::RELATION_TABLE)
-			->values([
-				'objid' => $qb->createNamedParameter($objid, IQueryBuilder::PARAM_INT),
-				'categoryid' => $qb->createNamedParameter($tagId, IQueryBuilder::PARAM_INT),
-				'type' => $qb->createNamedParameter($this->type, IQueryBuilder::PARAM_STR),
-			]);
-		try {
-			$qb->executeStatement();
-		} catch (\Exception $e) {
-			\OCP\Server::get(LoggerInterface::class)->error($e->getMessage(), [
-				'app' => 'core',
-				'exception' => $e,
-			]);
-			return false;
-		}
-		if ($tag === ITags::TAG_FAVORITE) {
-			if ($path === null) {
-				$node = $this->userFolder->getFirstNodeById($objid);
-				if ($node !== null) {
-					$path = $node->getPath();
-				} else {
-					throw new Exception('Failed to favorite: node with id ' . $objid . ' not found');
-				}
-			}
-
-			$this->dispatcher->dispatchTyped(new NodeAddedToFavorite($this->userSession->getUser(), $objid, $path));
-		}
-		return true;
-	}
-
-	/**
-	 * Delete single tag/object relation from the db
-	 */
-	public function unTag($objid, $tag, ?string $path = null) {
-		if (is_string($tag) && !is_numeric($tag)) {
-			$tag = trim($tag);
-			if ($tag === '') {
-				$this->logger->debug(__METHOD__ . ', Tag name is empty');
-				return false;
-			}
-			$tagId = $this->getTagId($tag);
-		} else {
-			$tagId = $tag;
-		}
-
-		try {
-			$qb = $this->db->getQueryBuilder();
-			$qb->delete(self::RELATION_TABLE)
-				->where($qb->expr()->andX(
-					$qb->expr()->eq('objid', $qb->createNamedParameter($objid)),
-					$qb->expr()->eq('categoryid', $qb->createNamedParameter($tagId)),
-					$qb->expr()->eq('type', $qb->createNamedParameter($this->type)),
-				))->executeStatement();
-		} catch (\Exception $e) {
-			$this->logger->error($e->getMessage(), [
-				'app' => 'core',
-				'exception' => $e,
-			]);
-			return false;
-		}
-		if ($tag === ITags::TAG_FAVORITE) {
-			if ($path === null) {
-				$node = $this->userFolder->getFirstNodeById($objid);
-				if ($node !== null) {
-					$path = $node->getPath();
-				} else {
-					throw new Exception('Failed to unfavorite: node with id ' . $objid . ' not found');
-				}
-			}
-
-			$this->dispatcher->dispatchTyped(new NodeRemovedFromFavorite($this->userSession->getUser(), $objid, $path));
-		}
-		return true;
-	}
-
-	/**
-	 * Delete tags from the database.
-	 *
-	 * @param string[]|integer[] $names An array of tags (names or IDs) to delete
-	 * @return bool Returns false on error
-	 */
-	public function delete($names) {
-		if (!is_array($names)) {
-			$names = [$names];
-		}
-
-		$names = array_map('trim', $names);
-		array_filter($names);
-
-		$this->logger->debug(__METHOD__ . ', before: ' . print_r($this->tags, true));
-		foreach ($names as $name) {
-			$id = null;
-
-			if (is_numeric($name)) {
-				$key = $this->getTagById($name);
-			} else {
-				$key = $this->getTagByName($name);
-			}
-			if ($key !== false) {
-				$tag = $this->tags[$key];
-				$id = $tag->getId();
-				unset($this->tags[$key]);
-				$this->mapper->delete($tag);
-			} else {
-				$this->logger->error(__METHOD__ . 'Cannot delete tag ' . $name . ': not found.');
-			}
-			if (!is_null($id) && $id !== false) {
-				try {
-					$qb = $this->db->getQueryBuilder();
-					$qb->delete(self::RELATION_TABLE)
-						->where($qb->expr()->eq('categoryid', $qb->createNamedParameter($id, IQueryBuilder::PARAM_INT)))
-						->executeStatement();
-				} catch (\Exception $e) {
-					$this->logger->error($e->getMessage(), [
-						'app' => 'core',
-						'exception' => $e,
-					]);
-					return false;
-				}
-			}
-		}
-		return true;
-	}
-
-	// case-insensitive array_search
-	protected function array_searchi($needle, $haystack, $mem = 'getName') {
-		if (!is_array($haystack)) {
-			return false;
-		}
-		return array_search(strtolower($needle), array_map(
-			function ($tag) use ($mem) {
-				return strtolower(call_user_func([$tag, $mem]));
-			}, $haystack)
-		);
-	}
-
-	/**
-	 * Get a tag's ID.
-	 *
-	 * @param string $name The tag name to look for.
-	 * @return string|bool The tag's id or false if no matching tag is found.
-	 */
-	private function getTagId($name) {
-		$key = $this->array_searchi($name, $this->tags);
-		if ($key !== false) {
-			return $this->tags[$key]->getId();
-		}
-		return false;
-	}
-
-	/**
-	 * Get a tag by its name.
-	 *
-	 * @param string $name The tag name.
-	 * @return integer|bool The tag object's offset within the $this->tags
-	 *                      array or false if it doesn't exist.
-	 */
-	private function getTagByName($name) {
-		return $this->array_searchi($name, $this->tags, 'getName');
-	}
-
-	/**
-	 * Get a tag by its ID.
-	 *
-	 * @param string $id The tag ID to look for.
-	 * @return integer|bool The tag object's offset within the $this->tags
-	 *                      array or false if it doesn't exist.
-	 */
-	private function getTagById($id) {
-		return $this->array_searchi($id, $this->tags, 'getId');
-	}
-
-	/**
-	 * Returns an array mapping a given tag's properties to its values:
-	 * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
-	 *
-	 * @param Tag $tag The tag that is going to be mapped
-	 * @return array
-	 */
-	private function tagMap(Tag $tag) {
-		return [
-			'id' => $tag->getId(),
-			'name' => $tag->getName(),
-			'owner' => $tag->getOwner(),
-			'type' => $tag->getType()
-		];
-	}
+    /**
+     * Used for storing objectid/categoryname pairs while rescanning.
+     */
+    private static array $relations = [];
+    private array $tags = [];
+
+    /**
+     * Are we including tags for shared items?
+     */
+    private bool $includeShared = false;
+
+    /**
+     * The current user, plus any owners of the items shared with the current
+     * user, if $this->includeShared === true.
+     */
+    private array $owners = [];
+
+    /**
+     * The sharing backend for objects of $this->type. Required if
+     * $this->includeShared === true to determine ownership of items.
+     */
+    private ?Share_Backend $backend = null;
+
+    public const TAG_TABLE = 'vcategory';
+    public const RELATION_TABLE = 'vcategory_to_object';
+
+    /**
+     * Constructor.
+     *
+     * @param TagMapper $mapper Instance of the TagMapper abstraction layer.
+     * @param string $user The user whose data the object will operate on.
+     * @param string $type The type of items for which tags will be loaded.
+     * @param array $defaultTags Tags that should be created at construction.
+     *
+     * since 20.0.0 $includeShared isn't used anymore
+     */
+    public function __construct(
+        private TagMapper $mapper,
+        private string $user,
+        private string $type,
+        private LoggerInterface $logger,
+        private IDBConnection $db,
+        private IEventDispatcher $dispatcher,
+        private IUserSession $userSession,
+        private Folder $userFolder,
+        array $defaultTags = [],
+    ) {
+        $this->owners = [$this->user];
+        $this->tags = $this->mapper->loadTags($this->owners, $this->type);
+
+        if (count($defaultTags) > 0 && count($this->tags) === 0) {
+            $this->addMultiple($defaultTags, true);
+        }
+    }
+
+    /**
+     * Check if any tags are saved for this type and user.
+     *
+     * @return boolean
+     */
+    public function isEmpty(): bool {
+        return count($this->tags) === 0;
+    }
+
+    /**
+     * Returns an array mapping a given tag's properties to its values:
+     * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
+     *
+     * @param string $id The ID of the tag that is going to be mapped
+     * @return array|false
+     */
+    public function getTag(string $id) {
+        $key = $this->getTagById($id);
+        if ($key !== false) {
+            return $this->tagMap($this->tags[$key]);
+        }
+        return false;
+    }
+
+    /**
+     * Get the tags for a specific user.
+     *
+     * This returns an array with maps containing each tag's properties:
+     * [
+     * 	['id' => 0, 'name' = 'First tag', 'owner' = 'User', 'type' => 'tagtype'],
+     * 	['id' => 1, 'name' = 'Shared tag', 'owner' = 'Other user', 'type' => 'tagtype'],
+     * ]
+     *
+     * @return array<array-key, array{id: int, name: string}>
+     */
+    public function getTags(): array {
+        if (!count($this->tags)) {
+            return [];
+        }
+
+        usort($this->tags, function ($a, $b) {
+            return strnatcasecmp($a->getName(), $b->getName());
+        });
+        $tagMap = [];
+
+        foreach ($this->tags as $tag) {
+            if ($tag->getName() !== ITags::TAG_FAVORITE) {
+                $tagMap[] = $this->tagMap($tag);
+            }
+        }
+        return $tagMap;
+    }
+
+    /**
+     * Return only the tags owned by the given user, omitting any tags shared
+     * by other users.
+     *
+     * @param string $user The user whose tags are to be checked.
+     * @return array An array of Tag objects.
+     */
+    public function getTagsForUser(string $user): array {
+        return array_filter($this->tags,
+            function ($tag) use ($user) {
+                return $tag->getOwner() === $user;
+            }
+        );
+    }
+
+    /**
+     * Get the list of tags for the given ids.
+     *
+     * @param list<int> $objIds array of object ids
+     * @return array<int, list<string>>|false of tags id as key to array of tag names
+     *                                        or false if an error occurred
+     */
+    public function getTagsForObjects(array $objIds) {
+        $entries = [];
+
+        try {
+            $chunks = array_chunk($objIds, 900, false);
+            $qb = $this->db->getQueryBuilder();
+            $qb->select('category', 'categoryid', 'objid')
+                ->from(self::RELATION_TABLE, 'r')
+                ->join('r', self::TAG_TABLE, 't', $qb->expr()->eq('r.categoryid', 't.id'))
+                ->where($qb->expr()->eq('uid', $qb->createParameter('uid')))
+                ->andWhere($qb->expr()->eq('r.type', $qb->createParameter('type')))
+                ->andWhere($qb->expr()->in('objid', $qb->createParameter('chunk')));
+            foreach ($chunks as $chunk) {
+                $qb->setParameter('uid', $this->user, IQueryBuilder::PARAM_STR);
+                $qb->setParameter('type', $this->type, IQueryBuilder::PARAM_STR);
+                $qb->setParameter('chunk', $chunk, IQueryBuilder::PARAM_INT_ARRAY);
+                $result = $qb->executeQuery();
+                while ($row = $result->fetch()) {
+                    $objId = (int)$row['objid'];
+                    if (!isset($entries[$objId])) {
+                        $entries[$objId] = [];
+                    }
+                    $entries[$objId][] = $row['category'];
+                }
+                $result->closeCursor();
+            }
+        } catch (\Exception $e) {
+            $this->logger->error($e->getMessage(), [
+                'exception' => $e,
+                'app' => 'core',
+            ]);
+            return false;
+        }
+
+        return $entries;
+    }
+
+    /**
+     * Get the a list if items tagged with $tag.
+     *
+     * Throws an exception if the tag could not be found.
+     *
+     * @param string $tag Tag id or name.
+     * @return int[]|false An array of object ids or false on error.
+     * @throws \Exception
+     */
+    public function getIdsForTag($tag) {
+        $tagId = false;
+        if (is_numeric($tag)) {
+            $tagId = $tag;
+        } elseif (is_string($tag)) {
+            $tag = trim($tag);
+            if ($tag === '') {
+                $this->logger->debug(__METHOD__ . ' Cannot use empty tag names', ['app' => 'core']);
+                return false;
+            }
+            $tagId = $this->getTagId($tag);
+        }
+
+        if ($tagId === false) {
+            $l10n = \OCP\Util::getL10N('core');
+            throw new \Exception(
+                $l10n->t('Could not find category "%s"', [$tag])
+            );
+        }
+
+        $ids = [];
+        try {
+            $qb = $this->db->getQueryBuilder();
+            $qb->select('objid')
+                ->from(self::RELATION_TABLE)
+                ->where($qb->expr()->eq('categoryid', $qb->createNamedParameter($tagId, IQueryBuilder::PARAM_STR)));
+            $result = $qb->executeQuery();
+        } catch (Exception $e) {
+            $this->logger->error($e->getMessage(), [
+                'app' => 'core',
+                'exception' => $e,
+            ]);
+            return false;
+        }
+
+        while ($row = $result->fetch()) {
+            $ids[] = (int)$row['objid'];
+        }
+        $result->closeCursor();
+
+        return $ids;
+    }
+
+    /**
+     * Checks whether a tag is saved for the given user,
+     * disregarding the ones shared with them.
+     *
+     * @param string $name The tag name to check for.
+     * @param string $user The user whose tags are to be checked.
+     */
+    public function userHasTag(string $name, string $user): bool {
+        return $this->array_searchi($name, $this->getTagsForUser($user)) !== false;
+    }
+
+    /**
+     * Checks whether a tag is saved for or shared with the current user.
+     *
+     * @param string $name The tag name to check for.
+     */
+    public function hasTag(string $name): bool {
+        return $this->getTagId($name) !== false;
+    }
+
+    /**
+     * Add a new tag.
+     *
+     * @param string $name A string with a name of the tag
+     * @return false|int the id of the added tag or false on error.
+     */
+    public function add(string $name) {
+        $name = trim($name);
+
+        if ($name === '') {
+            $this->logger->debug(__METHOD__ . ' Cannot add an empty tag', ['app' => 'core']);
+            return false;
+        }
+        if ($this->userHasTag($name, $this->user)) {
+            $this->logger->debug(__METHOD__ . ' Tag with name already exists', ['app' => 'core']);
+            return false;
+        }
+        try {
+            $tag = new Tag($this->user, $this->type, $name);
+            $tag = $this->mapper->insert($tag);
+            $this->tags[] = $tag;
+        } catch (\Exception $e) {
+            $this->logger->error($e->getMessage(), [
+                'exception' => $e,
+                'app' => 'core',
+            ]);
+            return false;
+        }
+        $this->logger->debug(__METHOD__ . ' Added an tag with ' . $tag->getId(), ['app' => 'core']);
+        return $tag->getId();
+    }
+
+    /**
+     * Rename tag.
+     *
+     * @param string|integer $from The name or ID of the existing tag
+     * @param string $to The new name of the tag.
+     * @return bool
+     */
+    public function rename($from, string $to): bool {
+        $from = trim($from);
+        $to = trim($to);
+
+        if ($to === '' || $from === '') {
+            $this->logger->debug(__METHOD__ . 'Cannot use an empty tag names', ['app' => 'core']);
+            return false;
+        }
+
+        if (is_numeric($from)) {
+            $key = $this->getTagById($from);
+        } else {
+            $key = $this->getTagByName($from);
+        }
+        if ($key === false) {
+            $this->logger->debug(__METHOD__ . 'Tag ' . $from . 'does not exist', ['app' => 'core']);
+            return false;
+        }
+        $tag = $this->tags[$key];
+
+        if ($this->userHasTag($to, $tag->getOwner())) {
+            $this->logger->debug(__METHOD__ . 'A tag named' . $to . 'already exists for user' . $tag->getOwner(), ['app' => 'core']);
+            return false;
+        }
+
+        try {
+            $tag->setName($to);
+            $this->tags[$key] = $this->mapper->update($tag);
+        } catch (\Exception $e) {
+            $this->logger->error($e->getMessage(), [
+                'exception' => $e,
+                'app' => 'core',
+            ]);
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Add a list of new tags.
+     *
+     * @param string|string[] $names A string with a name or an array of strings containing
+     *                               the name(s) of the tag(s) to add.
+     * @param bool $sync When true, save the tags
+     * @param int|null $id int Optional object id to add to this|these tag(s)
+     * @return bool Returns false on error.
+     */
+    public function addMultiple($names, bool $sync = false, ?int $id = null): bool {
+        if (!is_array($names)) {
+            $names = [$names];
+        }
+        $names = array_map('trim', $names);
+        array_filter($names);
+
+        $newones = [];
+        foreach ($names as $name) {
+            if (!$this->hasTag($name) && $name !== '') {
+                $newones[] = new Tag($this->user, $this->type, $name);
+            }
+            if (!is_null($id)) {
+                // Insert $objectid, $categoryid  pairs if not exist.
+                self::$relations[] = ['objid' => $id, 'tag' => $name];
+            }
+        }
+        $this->tags = array_merge($this->tags, $newones);
+        if ($sync === true) {
+            $this->save();
+        }
+
+        return true;
+    }
+
+    /**
+     * Save the list of tags and their object relations
+     */
+    protected function save(): void {
+        foreach ($this->tags as $tag) {
+            try {
+                if (!$this->mapper->tagExists($tag)) {
+                    $this->mapper->insert($tag);
+                }
+            } catch (\Exception $e) {
+                $this->logger->error($e->getMessage(), [
+                    'exception' => $e,
+                    'app' => 'core',
+                ]);
+            }
+        }
+
+        // reload tags to get the proper ids.
+        $this->tags = $this->mapper->loadTags($this->owners, $this->type);
+        $this->logger->debug(__METHOD__ . 'tags' . print_r($this->tags, true), ['app' => 'core']);
+        // Loop through temporarily cached objectid/tagname pairs
+        // and save relations.
+        $tags = $this->tags;
+        // For some reason this is needed or array_search(i) will return 0..?
+        ksort($tags);
+        foreach (self::$relations as $relation) {
+            $tagId = $this->getTagId($relation['tag']);
+            $this->logger->debug(__METHOD__ . 'catid ' . $relation['tag'] . ' ' . $tagId, ['app' => 'core']);
+            if ($tagId) {
+                $qb = $this->db->getQueryBuilder();
+                $qb->insert(self::RELATION_TABLE)
+                    ->values([
+                        'objid' => $qb->createNamedParameter($relation['objid'], IQueryBuilder::PARAM_INT),
+                        'categoryid' => $qb->createNamedParameter($tagId, IQueryBuilder::PARAM_INT),
+                        'type' => $qb->createNamedParameter($this->type),
+                    ]);
+                try {
+                    $qb->executeStatement();
+                } catch (Exception $e) {
+                    $this->logger->error($e->getMessage(), [
+                        'exception' => $e,
+                        'app' => 'core',
+                    ]);
+                }
+            }
+        }
+        self::$relations = []; // reset
+    }
+
+    /**
+     * Delete tag/object relations from the db
+     *
+     * @param array $ids The ids of the objects
+     * @return boolean Returns false on error.
+     */
+    public function purgeObjects(array $ids): bool {
+        if (count($ids) === 0) {
+            // job done ;)
+            return true;
+        }
+        $updates = $ids;
+        $qb = $this->db->getQueryBuilder();
+        $qb->delete(self::RELATION_TABLE)
+            ->where($qb->expr()->in('objid', $qb->createNamedParameter($ids)));
+        try {
+            $qb->executeStatement();
+        } catch (Exception $e) {
+            $this->logger->error($e->getMessage(), [
+                'app' => 'core',
+                'exception' => $e,
+            ]);
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Get favorites for an object type
+     *
+     * @return array|false An array of object ids.
+     */
+    public function getFavorites() {
+        if (!$this->userHasTag(ITags::TAG_FAVORITE, $this->user)) {
+            return [];
+        }
+
+        try {
+            return $this->getIdsForTag(ITags::TAG_FAVORITE);
+        } catch (\Exception $e) {
+            \OCP\Server::get(LoggerInterface::class)->error(
+                $e->getMessage(),
+                [
+                    'app' => 'core',
+                    'exception' => $e,
+                ]
+            );
+            return [];
+        }
+    }
+
+    /**
+     * Add an object to favorites
+     *
+     * @param int $objid The id of the object
+     * @return boolean
+     */
+    public function addToFavorites($objid) {
+        if (!$this->userHasTag(ITags::TAG_FAVORITE, $this->user)) {
+            $this->add(ITags::TAG_FAVORITE);
+        }
+        return $this->tagAs($objid, ITags::TAG_FAVORITE);
+    }
+
+    /**
+     * Remove an object from favorites
+     *
+     * @param int $objid The id of the object
+     * @return boolean
+     */
+    public function removeFromFavorites($objid) {
+        return $this->unTag($objid, ITags::TAG_FAVORITE);
+    }
+
+    /**
+     * Creates a tag/object relation.
+     */
+    public function tagAs($objid, $tag, ?string $path = null) {
+        if (is_string($tag) && !is_numeric($tag)) {
+            $tag = trim($tag);
+            if ($tag === '') {
+                $this->logger->debug(__METHOD__ . ', Cannot add an empty tag');
+                return false;
+            }
+            if (!$this->hasTag($tag)) {
+                $this->add($tag);
+            }
+            $tagId = $this->getTagId($tag);
+        } else {
+            $tagId = $tag;
+        }
+        $qb = $this->db->getQueryBuilder();
+        $qb->insert(self::RELATION_TABLE)
+            ->values([
+                'objid' => $qb->createNamedParameter($objid, IQueryBuilder::PARAM_INT),
+                'categoryid' => $qb->createNamedParameter($tagId, IQueryBuilder::PARAM_INT),
+                'type' => $qb->createNamedParameter($this->type, IQueryBuilder::PARAM_STR),
+            ]);
+        try {
+            $qb->executeStatement();
+        } catch (\Exception $e) {
+            \OCP\Server::get(LoggerInterface::class)->error($e->getMessage(), [
+                'app' => 'core',
+                'exception' => $e,
+            ]);
+            return false;
+        }
+        if ($tag === ITags::TAG_FAVORITE) {
+            if ($path === null) {
+                $node = $this->userFolder->getFirstNodeById($objid);
+                if ($node !== null) {
+                    $path = $node->getPath();
+                } else {
+                    throw new Exception('Failed to favorite: node with id ' . $objid . ' not found');
+                }
+            }
+
+            $this->dispatcher->dispatchTyped(new NodeAddedToFavorite($this->userSession->getUser(), $objid, $path));
+        }
+        return true;
+    }
+
+    /**
+     * Delete single tag/object relation from the db
+     */
+    public function unTag($objid, $tag, ?string $path = null) {
+        if (is_string($tag) && !is_numeric($tag)) {
+            $tag = trim($tag);
+            if ($tag === '') {
+                $this->logger->debug(__METHOD__ . ', Tag name is empty');
+                return false;
+            }
+            $tagId = $this->getTagId($tag);
+        } else {
+            $tagId = $tag;
+        }
+
+        try {
+            $qb = $this->db->getQueryBuilder();
+            $qb->delete(self::RELATION_TABLE)
+                ->where($qb->expr()->andX(
+                    $qb->expr()->eq('objid', $qb->createNamedParameter($objid)),
+                    $qb->expr()->eq('categoryid', $qb->createNamedParameter($tagId)),
+                    $qb->expr()->eq('type', $qb->createNamedParameter($this->type)),
+                ))->executeStatement();
+        } catch (\Exception $e) {
+            $this->logger->error($e->getMessage(), [
+                'app' => 'core',
+                'exception' => $e,
+            ]);
+            return false;
+        }
+        if ($tag === ITags::TAG_FAVORITE) {
+            if ($path === null) {
+                $node = $this->userFolder->getFirstNodeById($objid);
+                if ($node !== null) {
+                    $path = $node->getPath();
+                } else {
+                    throw new Exception('Failed to unfavorite: node with id ' . $objid . ' not found');
+                }
+            }
+
+            $this->dispatcher->dispatchTyped(new NodeRemovedFromFavorite($this->userSession->getUser(), $objid, $path));
+        }
+        return true;
+    }
+
+    /**
+     * Delete tags from the database.
+     *
+     * @param string[]|integer[] $names An array of tags (names or IDs) to delete
+     * @return bool Returns false on error
+     */
+    public function delete($names) {
+        if (!is_array($names)) {
+            $names = [$names];
+        }
+
+        $names = array_map('trim', $names);
+        array_filter($names);
+
+        $this->logger->debug(__METHOD__ . ', before: ' . print_r($this->tags, true));
+        foreach ($names as $name) {
+            $id = null;
+
+            if (is_numeric($name)) {
+                $key = $this->getTagById($name);
+            } else {
+                $key = $this->getTagByName($name);
+            }
+            if ($key !== false) {
+                $tag = $this->tags[$key];
+                $id = $tag->getId();
+                unset($this->tags[$key]);
+                $this->mapper->delete($tag);
+            } else {
+                $this->logger->error(__METHOD__ . 'Cannot delete tag ' . $name . ': not found.');
+            }
+            if (!is_null($id) && $id !== false) {
+                try {
+                    $qb = $this->db->getQueryBuilder();
+                    $qb->delete(self::RELATION_TABLE)
+                        ->where($qb->expr()->eq('categoryid', $qb->createNamedParameter($id, IQueryBuilder::PARAM_INT)))
+                        ->executeStatement();
+                } catch (\Exception $e) {
+                    $this->logger->error($e->getMessage(), [
+                        'app' => 'core',
+                        'exception' => $e,
+                    ]);
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
+
+    // case-insensitive array_search
+    protected function array_searchi($needle, $haystack, $mem = 'getName') {
+        if (!is_array($haystack)) {
+            return false;
+        }
+        return array_search(strtolower($needle), array_map(
+            function ($tag) use ($mem) {
+                return strtolower(call_user_func([$tag, $mem]));
+            }, $haystack)
+        );
+    }
+
+    /**
+     * Get a tag's ID.
+     *
+     * @param string $name The tag name to look for.
+     * @return string|bool The tag's id or false if no matching tag is found.
+     */
+    private function getTagId($name) {
+        $key = $this->array_searchi($name, $this->tags);
+        if ($key !== false) {
+            return $this->tags[$key]->getId();
+        }
+        return false;
+    }
+
+    /**
+     * Get a tag by its name.
+     *
+     * @param string $name The tag name.
+     * @return integer|bool The tag object's offset within the $this->tags
+     *                      array or false if it doesn't exist.
+     */
+    private function getTagByName($name) {
+        return $this->array_searchi($name, $this->tags, 'getName');
+    }
+
+    /**
+     * Get a tag by its ID.
+     *
+     * @param string $id The tag ID to look for.
+     * @return integer|bool The tag object's offset within the $this->tags
+     *                      array or false if it doesn't exist.
+     */
+    private function getTagById($id) {
+        return $this->array_searchi($id, $this->tags, 'getId');
+    }
+
+    /**
+     * Returns an array mapping a given tag's properties to its values:
+     * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
+     *
+     * @param Tag $tag The tag that is going to be mapped
+     * @return array
+     */
+    private function tagMap(Tag $tag) {
+        return [
+            'id' => $tag->getId(),
+            'name' => $tag->getName(),
+            'owner' => $tag->getOwner(),
+            'type' => $tag->getType()
+        ];
+    }
 }

Spacing +20 added lines, -20 removed lines

@@ -117,7 +117,7 @@ 
 			return [];
 		}
 
-		usort($this->tags, function ($a, $b) {
+		usort($this->tags, function($a, $b) {
 			return strnatcasecmp($a->getName(), $b->getName());
 		});
 		$tagMap = [];
@@ -139,7 +139,7 @@ 
 	 */
 	public function getTagsForUser(string $user): array {
 		return array_filter($this->tags,
-			function ($tag) use ($user) {
+			function($tag) use ($user) {
 				return $tag->getOwner() === $user;
 			}
 		);
@@ -170,7 +170,7 @@ 
 				$qb->setParameter('chunk', $chunk, IQueryBuilder::PARAM_INT_ARRAY);
 				$result = $qb->executeQuery();
 				while ($row = $result->fetch()) {
-					$objId = (int)$row['objid'];
+					$objId = (int) $row['objid'];
 					if (!isset($entries[$objId])) {
 						$entries[$objId] = [];
 					}
@@ -205,7 +205,7 @@ 
 		} elseif (is_string($tag)) {
 			$tag = trim($tag);
 			if ($tag === '') {
-				$this->logger->debug(__METHOD__ . ' Cannot use empty tag names', ['app' => 'core']);
+				$this->logger->debug(__METHOD__.' Cannot use empty tag names', ['app' => 'core']);
 				return false;
 			}
 			$tagId = $this->getTagId($tag);
@@ -234,7 +234,7 @@ 
 		}
 
 		while ($row = $result->fetch()) {
-			$ids[] = (int)$row['objid'];
+			$ids[] = (int) $row['objid'];
 		}
 		$result->closeCursor();
 
@@ -271,11 +271,11 @@ 
 		$name = trim($name);
 
 		if ($name === '') {
-			$this->logger->debug(__METHOD__ . ' Cannot add an empty tag', ['app' => 'core']);
+			$this->logger->debug(__METHOD__.' Cannot add an empty tag', ['app' => 'core']);
 			return false;
 		}
 		if ($this->userHasTag($name, $this->user)) {
-			$this->logger->debug(__METHOD__ . ' Tag with name already exists', ['app' => 'core']);
+			$this->logger->debug(__METHOD__.' Tag with name already exists', ['app' => 'core']);
 			return false;
 		}
 		try {
@@ -289,7 +289,7 @@ 
 			]);
 			return false;
 		}
-		$this->logger->debug(__METHOD__ . ' Added an tag with ' . $tag->getId(), ['app' => 'core']);
+		$this->logger->debug(__METHOD__.' Added an tag with '.$tag->getId(), ['app' => 'core']);
 		return $tag->getId();
 	}
 
@@ -305,7 +305,7 @@ 
 		$to = trim($to);
 
 		if ($to === '' || $from === '') {
-			$this->logger->debug(__METHOD__ . 'Cannot use an empty tag names', ['app' => 'core']);
+			$this->logger->debug(__METHOD__.'Cannot use an empty tag names', ['app' => 'core']);
 			return false;
 		}
 
@@ -315,13 +315,13 @@ 
 			$key = $this->getTagByName($from);
 		}
 		if ($key === false) {
-			$this->logger->debug(__METHOD__ . 'Tag ' . $from . 'does not exist', ['app' => 'core']);
+			$this->logger->debug(__METHOD__.'Tag '.$from.'does not exist', ['app' => 'core']);
 			return false;
 		}
 		$tag = $this->tags[$key];
 
 		if ($this->userHasTag($to, $tag->getOwner())) {
-			$this->logger->debug(__METHOD__ . 'A tag named' . $to . 'already exists for user' . $tag->getOwner(), ['app' => 'core']);
+			$this->logger->debug(__METHOD__.'A tag named'.$to.'already exists for user'.$tag->getOwner(), ['app' => 'core']);
 			return false;
 		}
 
@@ -391,7 +391,7 @@ 
 
 		// reload tags to get the proper ids.
 		$this->tags = $this->mapper->loadTags($this->owners, $this->type);
-		$this->logger->debug(__METHOD__ . 'tags' . print_r($this->tags, true), ['app' => 'core']);
+		$this->logger->debug(__METHOD__.'tags'.print_r($this->tags, true), ['app' => 'core']);
 		// Loop through temporarily cached objectid/tagname pairs
 		// and save relations.
 		$tags = $this->tags;
@@ -399,7 +399,7 @@ 
 		ksort($tags);
 		foreach (self::$relations as $relation) {
 			$tagId = $this->getTagId($relation['tag']);
-			$this->logger->debug(__METHOD__ . 'catid ' . $relation['tag'] . ' ' . $tagId, ['app' => 'core']);
+			$this->logger->debug(__METHOD__.'catid '.$relation['tag'].' '.$tagId, ['app' => 'core']);
 			if ($tagId) {
 				$qb = $this->db->getQueryBuilder();
 				$qb->insert(self::RELATION_TABLE)
@@ -502,7 +502,7 @@ 
 		if (is_string($tag) && !is_numeric($tag)) {
 			$tag = trim($tag);
 			if ($tag === '') {
-				$this->logger->debug(__METHOD__ . ', Cannot add an empty tag');
+				$this->logger->debug(__METHOD__.', Cannot add an empty tag');
 				return false;
 			}
 			if (!$this->hasTag($tag)) {
@@ -534,7 +534,7 @@ 
 				if ($node !== null) {
 					$path = $node->getPath();
 				} else {
-					throw new Exception('Failed to favorite: node with id ' . $objid . ' not found');
+					throw new Exception('Failed to favorite: node with id '.$objid.' not found');
 				}
 			}
 
@@ -550,7 +550,7 @@ 
 		if (is_string($tag) && !is_numeric($tag)) {
 			$tag = trim($tag);
 			if ($tag === '') {
-				$this->logger->debug(__METHOD__ . ', Tag name is empty');
+				$this->logger->debug(__METHOD__.', Tag name is empty');
 				return false;
 			}
 			$tagId = $this->getTagId($tag);
@@ -579,7 +579,7 @@ 
 				if ($node !== null) {
 					$path = $node->getPath();
 				} else {
-					throw new Exception('Failed to unfavorite: node with id ' . $objid . ' not found');
+					throw new Exception('Failed to unfavorite: node with id '.$objid.' not found');
 				}
 			}
 
@@ -602,7 +602,7 @@ 
 		$names = array_map('trim', $names);
 		array_filter($names);
 
-		$this->logger->debug(__METHOD__ . ', before: ' . print_r($this->tags, true));
+		$this->logger->debug(__METHOD__.', before: '.print_r($this->tags, true));
 		foreach ($names as $name) {
 			$id = null;
 
@@ -617,7 +617,7 @@ 
 				unset($this->tags[$key]);
 				$this->mapper->delete($tag);
 			} else {
-				$this->logger->error(__METHOD__ . 'Cannot delete tag ' . $name . ': not found.');
+				$this->logger->error(__METHOD__.'Cannot delete tag '.$name.': not found.');
 			}
 			if (!is_null($id) && $id !== false) {
 				try {
@@ -643,7 +643,7 @@ 
 			return false;
 		}
 		return array_search(strtolower($needle), array_map(
-			function ($tag) use ($mem) {
+			function($tag) use ($mem) {
 				return strtolower(call_user_func([$tag, $mem]));
 			}, $haystack)
 		);

apps/files/lib/Service/TagService.php

Indentation +41 added lines, -41 removed lines

@@ -18,51 +18,51 @@
  */
 class TagService {
 
-	public function __construct(
-		private IUserSession $userSession,
-		private IManager $activityManager,
-		private ?ITags $tagger,
-		private ?Folder $homeFolder,
-	) {
-	}
+    public function __construct(
+        private IUserSession $userSession,
+        private IManager $activityManager,
+        private ?ITags $tagger,
+        private ?Folder $homeFolder,
+    ) {
+    }
 
-	/**
-	 * Updates the tags of the specified file path.
-	 * The passed tags are absolute, which means they will
-	 * replace the actual tag selection.
-	 *
-	 * @param string $path path
-	 * @param array $tags array of tags
-	 * @return array list of tags
-	 * @throws NotFoundException if the file does not exist
-	 */
-	public function updateFileTags($path, $tags) {
-		if ($this->tagger === null) {
-			throw new \RuntimeException('No tagger set');
-		}
-		if ($this->homeFolder === null) {
-			throw new \RuntimeException('No homeFolder set');
-		}
+    /**
+     * Updates the tags of the specified file path.
+     * The passed tags are absolute, which means they will
+     * replace the actual tag selection.
+     *
+     * @param string $path path
+     * @param array $tags array of tags
+     * @return array list of tags
+     * @throws NotFoundException if the file does not exist
+     */
+    public function updateFileTags($path, $tags) {
+        if ($this->tagger === null) {
+            throw new \RuntimeException('No tagger set');
+        }
+        if ($this->homeFolder === null) {
+            throw new \RuntimeException('No homeFolder set');
+        }
 
-		$fileId = $this->homeFolder->get($path)->getId();
+        $fileId = $this->homeFolder->get($path)->getId();
 
-		$currentTags = $this->tagger->getTagsForObjects([$fileId]);
+        $currentTags = $this->tagger->getTagsForObjects([$fileId]);
 
-		if (!empty($currentTags)) {
-			$currentTags = current($currentTags);
-		}
+        if (!empty($currentTags)) {
+            $currentTags = current($currentTags);
+        }
 
-		$newTags = array_diff($tags, $currentTags);
-		foreach ($newTags as $tag) {
-			$this->tagger->tagAs($fileId, $tag, $path);
-		}
-		$deletedTags = array_diff($currentTags, $tags);
-		foreach ($deletedTags as $tag) {
-			$this->tagger->unTag($fileId, $tag, $path);
-		}
+        $newTags = array_diff($tags, $currentTags);
+        foreach ($newTags as $tag) {
+            $this->tagger->tagAs($fileId, $tag, $path);
+        }
+        $deletedTags = array_diff($currentTags, $tags);
+        foreach ($deletedTags as $tag) {
+            $this->tagger->unTag($fileId, $tag, $path);
+        }
 
-		// TODO: re-read from tagger to make sure the
-		// list is up to date, in case of concurrent changes ?
-		return $tags;
-	}
+        // TODO: re-read from tagger to make sure the
+        // list is up to date, in case of concurrent changes ?
+        return $tags;
+    }
 }

apps/dav/lib/Connector/Sabre/TagsPlugin.php

Indentation +238 added lines, -238 removed lines

@@ -37,267 +37,267 @@
 
 class TagsPlugin extends \Sabre\DAV\ServerPlugin {
 
-	// namespace
-	public const NS_OWNCLOUD = 'http://owncloud.org/ns';
-	public const TAGS_PROPERTYNAME = '{http://owncloud.org/ns}tags';
-	public const FAVORITE_PROPERTYNAME = '{http://owncloud.org/ns}favorite';
-	public const TAG_FAVORITE = '_$!<Favorite>!$_';
+    // namespace
+    public const NS_OWNCLOUD = 'http://owncloud.org/ns';
+    public const TAGS_PROPERTYNAME = '{http://owncloud.org/ns}tags';
+    public const FAVORITE_PROPERTYNAME = '{http://owncloud.org/ns}favorite';
+    public const TAG_FAVORITE = '_$!<Favorite>!$_';
 
-	/**
-	 * Reference to main server object
-	 *
-	 * @var \Sabre\DAV\Server
-	 */
-	private $server;
+    /**
+     * Reference to main server object
+     *
+     * @var \Sabre\DAV\Server
+     */
+    private $server;
 
-	/**
-	 * @var ITags
-	 */
-	private $tagger;
+    /**
+     * @var ITags
+     */
+    private $tagger;
 
-	/**
-	 * Array of file id to tags array
-	 * The null value means the cache wasn't initialized.
-	 *
-	 * @var array
-	 */
-	private $cachedTags;
-	private array $cachedDirectories;
+    /**
+     * Array of file id to tags array
+     * The null value means the cache wasn't initialized.
+     *
+     * @var array
+     */
+    private $cachedTags;
+    private array $cachedDirectories;
 
-	/**
-	 * @param \Sabre\DAV\Tree $tree tree
-	 * @param ITagManager $tagManager tag manager
-	 */
-	public function __construct(
-		private \Sabre\DAV\Tree $tree,
-		private ITagManager $tagManager,
-		private IEventDispatcher $eventDispatcher,
-		private IUserSession $userSession,
-	) {
-		$this->tagger = null;
-		$this->cachedTags = [];
-	}
+    /**
+     * @param \Sabre\DAV\Tree $tree tree
+     * @param ITagManager $tagManager tag manager
+     */
+    public function __construct(
+        private \Sabre\DAV\Tree $tree,
+        private ITagManager $tagManager,
+        private IEventDispatcher $eventDispatcher,
+        private IUserSession $userSession,
+    ) {
+        $this->tagger = null;
+        $this->cachedTags = [];
+    }
 
-	/**
-	 * This initializes the plugin.
-	 *
-	 * This function is called by \Sabre\DAV\Server, after
-	 * addPlugin is called.
-	 *
-	 * This method should set up the required event subscriptions.
-	 *
-	 * @param \Sabre\DAV\Server $server
-	 * @return void
-	 */
-	public function initialize(\Sabre\DAV\Server $server) {
-		$server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc';
-		$server->xml->elementMap[self::TAGS_PROPERTYNAME] = TagList::class;
+    /**
+     * This initializes the plugin.
+     *
+     * This function is called by \Sabre\DAV\Server, after
+     * addPlugin is called.
+     *
+     * This method should set up the required event subscriptions.
+     *
+     * @param \Sabre\DAV\Server $server
+     * @return void
+     */
+    public function initialize(\Sabre\DAV\Server $server) {
+        $server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc';
+        $server->xml->elementMap[self::TAGS_PROPERTYNAME] = TagList::class;
 
-		$this->server = $server;
-		$this->server->on('preloadCollection', $this->preloadCollection(...));
-		$this->server->on('propFind', [$this, 'handleGetProperties']);
-		$this->server->on('propPatch', [$this, 'handleUpdateProperties']);
-		$this->server->on('preloadProperties', [$this, 'handlePreloadProperties']);
-	}
+        $this->server = $server;
+        $this->server->on('preloadCollection', $this->preloadCollection(...));
+        $this->server->on('propFind', [$this, 'handleGetProperties']);
+        $this->server->on('propPatch', [$this, 'handleUpdateProperties']);
+        $this->server->on('preloadProperties', [$this, 'handlePreloadProperties']);
+    }
 
-	/**
-	 * Returns the tagger
-	 *
-	 * @return ITags tagger
-	 */
-	private function getTagger() {
-		if (!$this->tagger) {
-			$this->tagger = $this->tagManager->load('files');
-		}
-		return $this->tagger;
-	}
+    /**
+     * Returns the tagger
+     *
+     * @return ITags tagger
+     */
+    private function getTagger() {
+        if (!$this->tagger) {
+            $this->tagger = $this->tagManager->load('files');
+        }
+        return $this->tagger;
+    }
 
-	/**
-	 * Returns tags and favorites.
-	 *
-	 * @param integer $fileId file id
-	 * @return array list($tags, $favorite) with $tags as tag array
-	 *               and $favorite is a boolean whether the file was favorited
-	 */
-	private function getTagsAndFav($fileId) {
-		$isFav = false;
-		$tags = $this->getTags($fileId);
-		if ($tags) {
-			$favPos = array_search(self::TAG_FAVORITE, $tags);
-			if ($favPos !== false) {
-				$isFav = true;
-				unset($tags[$favPos]);
-			}
-		}
-		return [$tags, $isFav];
-	}
+    /**
+     * Returns tags and favorites.
+     *
+     * @param integer $fileId file id
+     * @return array list($tags, $favorite) with $tags as tag array
+     *               and $favorite is a boolean whether the file was favorited
+     */
+    private function getTagsAndFav($fileId) {
+        $isFav = false;
+        $tags = $this->getTags($fileId);
+        if ($tags) {
+            $favPos = array_search(self::TAG_FAVORITE, $tags);
+            if ($favPos !== false) {
+                $isFav = true;
+                unset($tags[$favPos]);
+            }
+        }
+        return [$tags, $isFav];
+    }
 
-	/**
-	 * Returns tags for the given file id
-	 *
-	 * @param integer $fileId file id
-	 * @return array list of tags for that file
-	 */
-	private function getTags($fileId) {
-		if (isset($this->cachedTags[$fileId])) {
-			return $this->cachedTags[$fileId];
-		} else {
-			$tags = $this->getTagger()->getTagsForObjects([$fileId]);
-			if ($tags !== false) {
-				if (empty($tags)) {
-					return [];
-				}
-				return current($tags);
-			}
-		}
-		return null;
-	}
+    /**
+     * Returns tags for the given file id
+     *
+     * @param integer $fileId file id
+     * @return array list of tags for that file
+     */
+    private function getTags($fileId) {
+        if (isset($this->cachedTags[$fileId])) {
+            return $this->cachedTags[$fileId];
+        } else {
+            $tags = $this->getTagger()->getTagsForObjects([$fileId]);
+            if ($tags !== false) {
+                if (empty($tags)) {
+                    return [];
+                }
+                return current($tags);
+            }
+        }
+        return null;
+    }
 
-	/**
-	 * Prefetches tags for a list of file IDs and caches the results
-	 *
-	 * @param array $fileIds List of file IDs to prefetch tags for
-	 * @return void
-	 */
-	private function prefetchTagsForFileIds(array $fileIds) {
-		$tags = $this->getTagger()->getTagsForObjects($fileIds);
-		if ($tags === false) {
-			// the tags API returns false on error...
-			$tags = [];
-		}
+    /**
+     * Prefetches tags for a list of file IDs and caches the results
+     *
+     * @param array $fileIds List of file IDs to prefetch tags for
+     * @return void
+     */
+    private function prefetchTagsForFileIds(array $fileIds) {
+        $tags = $this->getTagger()->getTagsForObjects($fileIds);
+        if ($tags === false) {
+            // the tags API returns false on error...
+            $tags = [];
+        }
 
-		foreach ($fileIds as $fileId) {
-			$this->cachedTags[$fileId] = $tags[$fileId] ?? [];
-		}
-	}
+        foreach ($fileIds as $fileId) {
+            $this->cachedTags[$fileId] = $tags[$fileId] ?? [];
+        }
+    }
 
-	/**
-	 * Updates the tags of the given file id
-	 *
-	 * @param int $fileId
-	 * @param array $tags array of tag strings
-	 * @param string $path path of the file
-	 */
-	private function updateTags($fileId, $tags, string $path) {
-		$tagger = $this->getTagger();
-		$currentTags = $this->getTags($fileId);
+    /**
+     * Updates the tags of the given file id
+     *
+     * @param int $fileId
+     * @param array $tags array of tag strings
+     * @param string $path path of the file
+     */
+    private function updateTags($fileId, $tags, string $path) {
+        $tagger = $this->getTagger();
+        $currentTags = $this->getTags($fileId);
 
-		$newTags = array_diff($tags, $currentTags);
-		foreach ($newTags as $tag) {
-			if ($tag === self::TAG_FAVORITE) {
-				continue;
-			}
-			$tagger->tagAs($fileId, $tag, $path);
-		}
-		$deletedTags = array_diff($currentTags, $tags);
-		foreach ($deletedTags as $tag) {
-			if ($tag === self::TAG_FAVORITE) {
-				continue;
-			}
-			$tagger->unTag($fileId, $tag, $path);
-		}
-	}
+        $newTags = array_diff($tags, $currentTags);
+        foreach ($newTags as $tag) {
+            if ($tag === self::TAG_FAVORITE) {
+                continue;
+            }
+            $tagger->tagAs($fileId, $tag, $path);
+        }
+        $deletedTags = array_diff($currentTags, $tags);
+        foreach ($deletedTags as $tag) {
+            if ($tag === self::TAG_FAVORITE) {
+                continue;
+            }
+            $tagger->unTag($fileId, $tag, $path);
+        }
+    }
 
-	private function preloadCollection(PropFind $propFind, ICollection $collection):
-	void {
-		if (!($collection instanceof Node)) {
-			return;
-		}
+    private function preloadCollection(PropFind $propFind, ICollection $collection):
+    void {
+        if (!($collection instanceof Node)) {
+            return;
+        }
 
-		// need prefetch ?
-		if ($collection instanceof Directory
-			&& !isset($this->cachedDirectories[$collection->getPath()])
-			&& (!is_null($propFind->getStatus(self::TAGS_PROPERTYNAME))
-				|| !is_null($propFind->getStatus(self::FAVORITE_PROPERTYNAME))
-			)) {
-			// note: pre-fetching only supported for depth <= 1
-			$folderContent = $collection->getChildren();
-			$fileIds = [(int)$collection->getId()];
-			foreach ($folderContent as $info) {
-				$fileIds[] = (int)$info->getId();
-			}
-			$this->prefetchTagsForFileIds($fileIds);
-			$this->cachedDirectories[$collection->getPath()] = true;
-		}
-	}
+        // need prefetch ?
+        if ($collection instanceof Directory
+            && !isset($this->cachedDirectories[$collection->getPath()])
+            && (!is_null($propFind->getStatus(self::TAGS_PROPERTYNAME))
+                || !is_null($propFind->getStatus(self::FAVORITE_PROPERTYNAME))
+            )) {
+            // note: pre-fetching only supported for depth <= 1
+            $folderContent = $collection->getChildren();
+            $fileIds = [(int)$collection->getId()];
+            foreach ($folderContent as $info) {
+                $fileIds[] = (int)$info->getId();
+            }
+            $this->prefetchTagsForFileIds($fileIds);
+            $this->cachedDirectories[$collection->getPath()] = true;
+        }
+    }
 
-	/**
-	 * Adds tags and favorites properties to the response,
-	 * if requested.
-	 *
-	 * @param PropFind $propFind
-	 * @param \Sabre\DAV\INode $node
-	 * @return void
-	 */
-	public function handleGetProperties(
-		PropFind $propFind,
-		\Sabre\DAV\INode $node,
-	) {
-		if (!($node instanceof Node)) {
-			return;
-		}
+    /**
+     * Adds tags and favorites properties to the response,
+     * if requested.
+     *
+     * @param PropFind $propFind
+     * @param \Sabre\DAV\INode $node
+     * @return void
+     */
+    public function handleGetProperties(
+        PropFind $propFind,
+        \Sabre\DAV\INode $node,
+    ) {
+        if (!($node instanceof Node)) {
+            return;
+        }
 
-		$isFav = null;
+        $isFav = null;
 
-		$propFind->handle(self::TAGS_PROPERTYNAME, function () use (&$isFav, $node) {
-			[$tags, $isFav] = $this->getTagsAndFav($node->getId());
-			return new TagList($tags);
-		});
+        $propFind->handle(self::TAGS_PROPERTYNAME, function () use (&$isFav, $node) {
+            [$tags, $isFav] = $this->getTagsAndFav($node->getId());
+            return new TagList($tags);
+        });
 
-		$propFind->handle(self::FAVORITE_PROPERTYNAME, function () use ($isFav, $node) {
-			if (is_null($isFav)) {
-				[, $isFav] = $this->getTagsAndFav($node->getId());
-			}
-			if ($isFav) {
-				return 1;
-			} else {
-				return 0;
-			}
-		});
-	}
+        $propFind->handle(self::FAVORITE_PROPERTYNAME, function () use ($isFav, $node) {
+            if (is_null($isFav)) {
+                [, $isFav] = $this->getTagsAndFav($node->getId());
+            }
+            if ($isFav) {
+                return 1;
+            } else {
+                return 0;
+            }
+        });
+    }
 
-	/**
-	 * Updates tags and favorites properties, if applicable.
-	 *
-	 * @param string $path
-	 * @param PropPatch $propPatch
-	 *
-	 * @return void
-	 */
-	public function handleUpdateProperties($path, PropPatch $propPatch) {
-		$node = $this->tree->getNodeForPath($path);
-		if (!($node instanceof Node)) {
-			return;
-		}
+    /**
+     * Updates tags and favorites properties, if applicable.
+     *
+     * @param string $path
+     * @param PropPatch $propPatch
+     *
+     * @return void
+     */
+    public function handleUpdateProperties($path, PropPatch $propPatch) {
+        $node = $this->tree->getNodeForPath($path);
+        if (!($node instanceof Node)) {
+            return;
+        }
 
-		$propPatch->handle(self::TAGS_PROPERTYNAME, function ($tagList) use ($node, $path) {
-			$this->updateTags($node->getId(), $tagList->getTags(), $path);
-			return true;
-		});
+        $propPatch->handle(self::TAGS_PROPERTYNAME, function ($tagList) use ($node, $path) {
+            $this->updateTags($node->getId(), $tagList->getTags(), $path);
+            return true;
+        });
 
-		$propPatch->handle(self::FAVORITE_PROPERTYNAME, function ($favState) use ($node, $path) {
-			if ((int)$favState === 1 || $favState === 'true') {
-				$this->getTagger()->tagAs($node->getId(), self::TAG_FAVORITE, $path);
-			} else {
-				$this->getTagger()->unTag($node->getId(), self::TAG_FAVORITE, $path);
-			}
+        $propPatch->handle(self::FAVORITE_PROPERTYNAME, function ($favState) use ($node, $path) {
+            if ((int)$favState === 1 || $favState === 'true') {
+                $this->getTagger()->tagAs($node->getId(), self::TAG_FAVORITE, $path);
+            } else {
+                $this->getTagger()->unTag($node->getId(), self::TAG_FAVORITE, $path);
+            }
 
-			if (is_null($favState)) {
-				// confirm deletion
-				return 204;
-			}
+            if (is_null($favState)) {
+                // confirm deletion
+                return 204;
+            }
 
-			return 200;
-		});
-	}
+            return 200;
+        });
+    }
 
-	public function handlePreloadProperties(array $nodes, array $requestProperties): void {
-		if (
-			!in_array(self::FAVORITE_PROPERTYNAME, $requestProperties, true)
-			&& !in_array(self::TAGS_PROPERTYNAME, $requestProperties, true)
-		) {
-			return;
-		}
-		$this->prefetchTagsForFileIds(array_map(fn ($node) => $node->getId(), $nodes));
-	}
+    public function handlePreloadProperties(array $nodes, array $requestProperties): void {
+        if (
+            !in_array(self::FAVORITE_PROPERTYNAME, $requestProperties, true)
+            && !in_array(self::TAGS_PROPERTYNAME, $requestProperties, true)
+        ) {
+            return;
+        }
+        $this->prefetchTagsForFileIds(array_map(fn ($node) => $node->getId(), $nodes));
+    }
 }

Spacing +7 added lines, -7 removed lines

@@ -212,9 +212,9 @@ 
 			)) {
 			// note: pre-fetching only supported for depth <= 1
 			$folderContent = $collection->getChildren();
-			$fileIds = [(int)$collection->getId()];
+			$fileIds = [(int) $collection->getId()];
 			foreach ($folderContent as $info) {
-				$fileIds[] = (int)$info->getId();
+				$fileIds[] = (int) $info->getId();
 			}
 			$this->prefetchTagsForFileIds($fileIds);
 			$this->cachedDirectories[$collection->getPath()] = true;
@@ -239,12 +239,12 @@ 
 
 		$isFav = null;
 
-		$propFind->handle(self::TAGS_PROPERTYNAME, function () use (&$isFav, $node) {
+		$propFind->handle(self::TAGS_PROPERTYNAME, function() use (&$isFav, $node) {
 			[$tags, $isFav] = $this->getTagsAndFav($node->getId());
 			return new TagList($tags);
 		});
 
-		$propFind->handle(self::FAVORITE_PROPERTYNAME, function () use ($isFav, $node) {
+		$propFind->handle(self::FAVORITE_PROPERTYNAME, function() use ($isFav, $node) {
 			if (is_null($isFav)) {
 				[, $isFav] = $this->getTagsAndFav($node->getId());
 			}
@@ -270,13 +270,13 @@ 
 			return;
 		}
 
-		$propPatch->handle(self::TAGS_PROPERTYNAME, function ($tagList) use ($node, $path) {
+		$propPatch->handle(self::TAGS_PROPERTYNAME, function($tagList) use ($node, $path) {
 			$this->updateTags($node->getId(), $tagList->getTags(), $path);
 			return true;
 		});
 
-		$propPatch->handle(self::FAVORITE_PROPERTYNAME, function ($favState) use ($node, $path) {
-			if ((int)$favState === 1 || $favState === 'true') {
+		$propPatch->handle(self::FAVORITE_PROPERTYNAME, function($favState) use ($node, $path) {
+			if ((int) $favState === 1 || $favState === 'true') {
 				$this->getTagger()->tagAs($node->getId(), self::TAG_FAVORITE, $path);
 			} else {
 				$this->getTagger()->unTag($node->getId(), self::TAG_FAVORITE, $path);

apps/dav/tests/unit/Connector/Sabre/TagsPluginTest.php

Indentation +384 added lines, -384 removed lines

@@ -23,388 +23,388 @@
 use Sabre\DAV\Tree;
 
 class TagsPluginTest extends \Test\TestCase {
-	public const TAGS_PROPERTYNAME = TagsPlugin::TAGS_PROPERTYNAME;
-	public const FAVORITE_PROPERTYNAME = TagsPlugin::FAVORITE_PROPERTYNAME;
-	public const TAG_FAVORITE = TagsPlugin::TAG_FAVORITE;
-
-	private \Sabre\DAV\Server $server;
-	private Tree&MockObject $tree;
-	private ITagManager&MockObject $tagManager;
-	private ITags&MockObject $tagger;
-	private IEventDispatcher&MockObject $eventDispatcher;
-	private IUserSession&MockObject $userSession;
-	private TagsPlugin $plugin;
-
-	protected function setUp(): void {
-		parent::setUp();
-
-		$this->server = new \Sabre\DAV\Server();
-		$this->tree = $this->createMock(Tree::class);
-		$this->tagger = $this->createMock(ITags::class);
-		$this->tagManager = $this->createMock(ITagManager::class);
-		$this->eventDispatcher = $this->createMock(IEventDispatcher::class);
-		$user = $this->createMock(IUser::class);
-
-		$this->userSession = $this->createMock(IUserSession::class);
-		$this->userSession->expects($this->any())
-			->method('getUser')
-			->withAnyParameters()
-			->willReturn($user);
-		$this->tagManager->expects($this->any())
-			->method('load')
-			->with('files')
-			->willReturn($this->tagger);
-		$this->plugin = new TagsPlugin($this->tree, $this->tagManager, $this->eventDispatcher, $this->userSession);
-		$this->plugin->initialize($this->server);
-	}
-
-	#[\PHPUnit\Framework\Attributes\DataProvider('tagsGetPropertiesDataProvider')]
-	public function testGetProperties(array $tags, array $requestedProperties, array $expectedProperties): void {
-		$node = $this->createMock(Node::class);
-		$node->expects($this->any())
-			->method('getId')
-			->willReturn(123);
-
-		$expectedCallCount = 0;
-		if (count($requestedProperties) > 0) {
-			$expectedCallCount = 1;
-		}
-
-		$this->tagger->expects($this->exactly($expectedCallCount))
-			->method('getTagsForObjects')
-			->with($this->equalTo([123]))
-			->willReturn([123 => $tags]);
-
-		$propFind = new \Sabre\DAV\PropFind(
-			'/dummyPath',
-			$requestedProperties,
-			0
-		);
-
-		$this->plugin->handleGetProperties(
-			$propFind,
-			$node
-		);
-
-		$result = $propFind->getResultForMultiStatus();
-
-		$this->assertEmpty($result[404]);
-		unset($result[404]);
-		$this->assertEquals($expectedProperties, $result);
-	}
-
-	#[\PHPUnit\Framework\Attributes\DataProvider('tagsGetPropertiesDataProvider')]
-	public function testPreloadThenGetProperties(array $tags, array $requestedProperties, array $expectedProperties): void {
-		$node1 = $this->createMock(File::class);
-		$node1->expects($this->any())
-			->method('getId')
-			->willReturn(111);
-		$node2 = $this->createMock(File::class);
-		$node2->expects($this->any())
-			->method('getId')
-			->willReturn(222);
-
-		$expectedCallCount = 0;
-		if (count($requestedProperties) > 0) {
-			// this guarantees that getTagsForObjects
-			// is only called once and then the tags
-			// are cached
-			$expectedCallCount = 1;
-		}
-
-		$node = $this->createMock(Directory::class);
-		$node->expects($this->any())
-			->method('getId')
-			->willReturn(123);
-		$node->expects($this->exactly($expectedCallCount))
-			->method('getChildren')
-			->willReturn([$node1, $node2]);
-
-		$this->tagger->expects($this->exactly($expectedCallCount))
-			->method('getTagsForObjects')
-			->with($this->equalTo([123, 111, 222]))
-			->willReturn(
-				[
-					111 => $tags,
-					123 => $tags
-				]
-			);
-
-		// simulate sabre recursive PROPFIND traversal
-		$propFindRoot = new \Sabre\DAV\PropFind(
-			'/subdir',
-			$requestedProperties,
-			1
-		);
-		$propFind1 = new \Sabre\DAV\PropFind(
-			'/subdir/test.txt',
-			$requestedProperties,
-			0
-		);
-		$propFind2 = new \Sabre\DAV\PropFind(
-			'/subdir/test2.txt',
-			$requestedProperties,
-			0
-		);
-
-		$this->server->emit('preloadCollection', [$propFindRoot, $node]);
-
-		$this->plugin->handleGetProperties(
-			$propFindRoot,
-			$node
-		);
-		$this->plugin->handleGetProperties(
-			$propFind1,
-			$node1
-		);
-		$this->plugin->handleGetProperties(
-			$propFind2,
-			$node2
-		);
-
-		$result = $propFind1->getResultForMultiStatus();
-
-		$this->assertEmpty($result[404]);
-		unset($result[404]);
-		$this->assertEquals($expectedProperties, $result);
-	}
-
-	public static function tagsGetPropertiesDataProvider(): array {
-		return [
-			// request both, receive both
-			[
-				['tag1', 'tag2', self::TAG_FAVORITE],
-				[self::TAGS_PROPERTYNAME, self::FAVORITE_PROPERTYNAME],
-				[
-					200 => [
-						self::TAGS_PROPERTYNAME => new TagList(['tag1', 'tag2']),
-						self::FAVORITE_PROPERTYNAME => true,
-					]
-				]
-			],
-			// request tags alone
-			[
-				['tag1', 'tag2', self::TAG_FAVORITE],
-				[self::TAGS_PROPERTYNAME],
-				[
-					200 => [
-						self::TAGS_PROPERTYNAME => new TagList(['tag1', 'tag2']),
-					]
-				]
-			],
-			// request fav alone
-			[
-				['tag1', 'tag2', self::TAG_FAVORITE],
-				[self::FAVORITE_PROPERTYNAME],
-				[
-					200 => [
-						self::FAVORITE_PROPERTYNAME => true,
-					]
-				]
-			],
-			// request none
-			[
-				['tag1', 'tag2', self::TAG_FAVORITE],
-				[],
-				[
-					200 => []
-				],
-			],
-			// request both with none set, receive both
-			[
-				[],
-				[self::TAGS_PROPERTYNAME, self::FAVORITE_PROPERTYNAME],
-				[
-					200 => [
-						self::TAGS_PROPERTYNAME => new TagList([]),
-						self::FAVORITE_PROPERTYNAME => false,
-					]
-				]
-			],
-		];
-	}
-
-	public function testGetPropertiesSkipChunks(): void {
-		$sabreNode = $this->createMock(UploadFile::class);
-
-		$propFind = new \Sabre\DAV\PropFind(
-			'/dummyPath',
-			[self::TAGS_PROPERTYNAME, self::TAG_FAVORITE],
-			0
-		);
-
-		$this->plugin->handleGetProperties(
-			$propFind,
-			$sabreNode
-		);
-
-		$result = $propFind->getResultForMultiStatus();
-		$this->assertCount(2, $result[404]);
-	}
-
-	public function testUpdateTags(): void {
-		// this test will replace the existing tags "tagremove" with "tag1" and "tag2"
-		// and keep "tagkeep"
-		$node = $this->createMock(Node::class);
-		$node->expects($this->any())
-			->method('getId')
-			->willReturn(123);
-
-		$this->tree->expects($this->any())
-			->method('getNodeForPath')
-			->with('/dummypath')
-			->willReturn($node);
-
-		$this->tagger->expects($this->once())
-			->method('getTagsForObjects')
-			->with($this->equalTo([123]))
-			->willReturn([123 => ['tagkeep', 'tagremove', self::TAG_FAVORITE]]);
-
-		// then tag as tag1 and tag2
-		$calls = [
-			[123, 'tag1', '/dummypath'],
-			[123, 'tag2', '/dummypath'],
-		];
-		$this->tagger->expects($this->exactly(count($calls)))
-			->method('tagAs')
-			->willReturnCallback(function () use (&$calls): void {
-				$expected = array_shift($calls);
-				$this->assertEquals($expected, func_get_args());
-			});
-
-		// it will untag tag3
-		$this->tagger->expects($this->once())
-			->method('unTag')
-			->with(123, 'tagremove');
-
-		// properties to set
-		$propPatch = new \Sabre\DAV\PropPatch([
-			self::TAGS_PROPERTYNAME => new TagList(['tag1', 'tag2', 'tagkeep'])
-		]);
-
-		$this->plugin->handleUpdateProperties(
-			'/dummypath',
-			$propPatch
-		);
-
-		$propPatch->commit();
-
-		// all requested properties removed, as they were processed already
-		$this->assertEmpty($propPatch->getRemainingMutations());
-
-		$result = $propPatch->getResult();
-		$this->assertEquals(200, $result[self::TAGS_PROPERTYNAME]);
-		$this->assertArrayNotHasKey(self::FAVORITE_PROPERTYNAME, $result);
-	}
-
-	public function testUpdateTagsFromScratch(): void {
-		$node = $this->createMock(Node::class);
-		$node->expects($this->any())
-			->method('getId')
-			->willReturn(123);
-
-		$this->tree->expects($this->any())
-			->method('getNodeForPath')
-			->with('/dummypath')
-			->willReturn($node);
-
-		$this->tagger->expects($this->once())
-			->method('getTagsForObjects')
-			->with($this->equalTo([123]))
-			->willReturn([]);
-
-		// then tag as tag1 and tag2
-		$calls = [
-			[123, 'tag1', '/dummypath'],
-			[123, 'tag2', '/dummypath'],
-		];
-		$this->tagger->expects($this->exactly(count($calls)))
-			->method('tagAs')
-			->willReturnCallback(function () use (&$calls): void {
-				$expected = array_shift($calls);
-				$this->assertEquals($expected, func_get_args());
-			});
-
-		// properties to set
-		$propPatch = new \Sabre\DAV\PropPatch([
-			self::TAGS_PROPERTYNAME => new TagList(['tag1', 'tag2'])
-		]);
-
-		$this->plugin->handleUpdateProperties(
-			'/dummypath',
-			$propPatch
-		);
-
-		$propPatch->commit();
-
-		// all requested properties removed, as they were processed already
-		$this->assertEmpty($propPatch->getRemainingMutations());
-
-		$result = $propPatch->getResult();
-		$this->assertEquals(200, $result[self::TAGS_PROPERTYNAME]);
-		$this->assertArrayNotHasKey(self::FAVORITE_PROPERTYNAME, $result);
-	}
-
-	public function testUpdateFav(): void {
-		// this test will replace the existing tags "tagremove" with "tag1" and "tag2"
-		// and keep "tagkeep"
-		$node = $this->createMock(Node::class);
-		$node->expects($this->any())
-			->method('getId')
-			->willReturn(123);
-
-		$this->tree->expects($this->any())
-			->method('getNodeForPath')
-			->with('/dummypath')
-			->willReturn($node);
-
-		// set favorite tag
-		$this->tagger->expects($this->once())
-			->method('tagAs')
-			->with(123, self::TAG_FAVORITE);
-
-		// properties to set
-		$propPatch = new \Sabre\DAV\PropPatch([
-			self::FAVORITE_PROPERTYNAME => true
-		]);
-
-		$this->plugin->handleUpdateProperties(
-			'/dummypath',
-			$propPatch
-		);
-
-		$propPatch->commit();
-
-		// all requested properties removed, as they were processed already
-		$this->assertEmpty($propPatch->getRemainingMutations());
-
-		$result = $propPatch->getResult();
-		$this->assertArrayNotHasKey(self::TAGS_PROPERTYNAME, $result);
-		$this->assertEquals(200, $result[self::FAVORITE_PROPERTYNAME]);
-
-		// unfavorite now
-		// set favorite tag
-		$this->tagger->expects($this->once())
-			->method('unTag')
-			->with(123, self::TAG_FAVORITE);
-
-		// properties to set
-		$propPatch = new \Sabre\DAV\PropPatch([
-			self::FAVORITE_PROPERTYNAME => false
-		]);
-
-		$this->plugin->handleUpdateProperties(
-			'/dummypath',
-			$propPatch
-		);
-
-		$propPatch->commit();
-
-		// all requested properties removed, as they were processed already
-		$this->assertEmpty($propPatch->getRemainingMutations());
-
-		$result = $propPatch->getResult();
-		$this->assertArrayNotHasKey(self::TAGS_PROPERTYNAME, $result);
-		$this->assertEquals(200, $result[self::FAVORITE_PROPERTYNAME]);
-	}
+    public const TAGS_PROPERTYNAME = TagsPlugin::TAGS_PROPERTYNAME;
+    public const FAVORITE_PROPERTYNAME = TagsPlugin::FAVORITE_PROPERTYNAME;
+    public const TAG_FAVORITE = TagsPlugin::TAG_FAVORITE;
+
+    private \Sabre\DAV\Server $server;
+    private Tree&MockObject $tree;
+    private ITagManager&MockObject $tagManager;
+    private ITags&MockObject $tagger;
+    private IEventDispatcher&MockObject $eventDispatcher;
+    private IUserSession&MockObject $userSession;
+    private TagsPlugin $plugin;
+
+    protected function setUp(): void {
+        parent::setUp();
+
+        $this->server = new \Sabre\DAV\Server();
+        $this->tree = $this->createMock(Tree::class);
+        $this->tagger = $this->createMock(ITags::class);
+        $this->tagManager = $this->createMock(ITagManager::class);
+        $this->eventDispatcher = $this->createMock(IEventDispatcher::class);
+        $user = $this->createMock(IUser::class);
+
+        $this->userSession = $this->createMock(IUserSession::class);
+        $this->userSession->expects($this->any())
+            ->method('getUser')
+            ->withAnyParameters()
+            ->willReturn($user);
+        $this->tagManager->expects($this->any())
+            ->method('load')
+            ->with('files')
+            ->willReturn($this->tagger);
+        $this->plugin = new TagsPlugin($this->tree, $this->tagManager, $this->eventDispatcher, $this->userSession);
+        $this->plugin->initialize($this->server);
+    }
+
+    #[\PHPUnit\Framework\Attributes\DataProvider('tagsGetPropertiesDataProvider')]
+    public function testGetProperties(array $tags, array $requestedProperties, array $expectedProperties): void {
+        $node = $this->createMock(Node::class);
+        $node->expects($this->any())
+            ->method('getId')
+            ->willReturn(123);
+
+        $expectedCallCount = 0;
+        if (count($requestedProperties) > 0) {
+            $expectedCallCount = 1;
+        }
+
+        $this->tagger->expects($this->exactly($expectedCallCount))
+            ->method('getTagsForObjects')
+            ->with($this->equalTo([123]))
+            ->willReturn([123 => $tags]);
+
+        $propFind = new \Sabre\DAV\PropFind(
+            '/dummyPath',
+            $requestedProperties,
+            0
+        );
+
+        $this->plugin->handleGetProperties(
+            $propFind,
+            $node
+        );
+
+        $result = $propFind->getResultForMultiStatus();
+
+        $this->assertEmpty($result[404]);
+        unset($result[404]);
+        $this->assertEquals($expectedProperties, $result);
+    }
+
+    #[\PHPUnit\Framework\Attributes\DataProvider('tagsGetPropertiesDataProvider')]
+    public function testPreloadThenGetProperties(array $tags, array $requestedProperties, array $expectedProperties): void {
+        $node1 = $this->createMock(File::class);
+        $node1->expects($this->any())
+            ->method('getId')
+            ->willReturn(111);
+        $node2 = $this->createMock(File::class);
+        $node2->expects($this->any())
+            ->method('getId')
+            ->willReturn(222);
+
+        $expectedCallCount = 0;
+        if (count($requestedProperties) > 0) {
+            // this guarantees that getTagsForObjects
+            // is only called once and then the tags
+            // are cached
+            $expectedCallCount = 1;
+        }
+
+        $node = $this->createMock(Directory::class);
+        $node->expects($this->any())
+            ->method('getId')
+            ->willReturn(123);
+        $node->expects($this->exactly($expectedCallCount))
+            ->method('getChildren')
+            ->willReturn([$node1, $node2]);
+
+        $this->tagger->expects($this->exactly($expectedCallCount))
+            ->method('getTagsForObjects')
+            ->with($this->equalTo([123, 111, 222]))
+            ->willReturn(
+                [
+                    111 => $tags,
+                    123 => $tags
+                ]
+            );
+
+        // simulate sabre recursive PROPFIND traversal
+        $propFindRoot = new \Sabre\DAV\PropFind(
+            '/subdir',
+            $requestedProperties,
+            1
+        );
+        $propFind1 = new \Sabre\DAV\PropFind(
+            '/subdir/test.txt',
+            $requestedProperties,
+            0
+        );
+        $propFind2 = new \Sabre\DAV\PropFind(
+            '/subdir/test2.txt',
+            $requestedProperties,
+            0
+        );
+
+        $this->server->emit('preloadCollection', [$propFindRoot, $node]);
+
+        $this->plugin->handleGetProperties(
+            $propFindRoot,
+            $node
+        );
+        $this->plugin->handleGetProperties(
+            $propFind1,
+            $node1
+        );
+        $this->plugin->handleGetProperties(
+            $propFind2,
+            $node2
+        );
+
+        $result = $propFind1->getResultForMultiStatus();
+
+        $this->assertEmpty($result[404]);
+        unset($result[404]);
+        $this->assertEquals($expectedProperties, $result);
+    }
+
+    public static function tagsGetPropertiesDataProvider(): array {
+        return [
+            // request both, receive both
+            [
+                ['tag1', 'tag2', self::TAG_FAVORITE],
+                [self::TAGS_PROPERTYNAME, self::FAVORITE_PROPERTYNAME],
+                [
+                    200 => [
+                        self::TAGS_PROPERTYNAME => new TagList(['tag1', 'tag2']),
+                        self::FAVORITE_PROPERTYNAME => true,
+                    ]
+                ]
+            ],
+            // request tags alone
+            [
+                ['tag1', 'tag2', self::TAG_FAVORITE],
+                [self::TAGS_PROPERTYNAME],
+                [
+                    200 => [
+                        self::TAGS_PROPERTYNAME => new TagList(['tag1', 'tag2']),
+                    ]
+                ]
+            ],
+            // request fav alone
+            [
+                ['tag1', 'tag2', self::TAG_FAVORITE],
+                [self::FAVORITE_PROPERTYNAME],
+                [
+                    200 => [
+                        self::FAVORITE_PROPERTYNAME => true,
+                    ]
+                ]
+            ],
+            // request none
+            [
+                ['tag1', 'tag2', self::TAG_FAVORITE],
+                [],
+                [
+                    200 => []
+                ],
+            ],
+            // request both with none set, receive both
+            [
+                [],
+                [self::TAGS_PROPERTYNAME, self::FAVORITE_PROPERTYNAME],
+                [
+                    200 => [
+                        self::TAGS_PROPERTYNAME => new TagList([]),
+                        self::FAVORITE_PROPERTYNAME => false,
+                    ]
+                ]
+            ],
+        ];
+    }
+
+    public function testGetPropertiesSkipChunks(): void {
+        $sabreNode = $this->createMock(UploadFile::class);
+
+        $propFind = new \Sabre\DAV\PropFind(
+            '/dummyPath',
+            [self::TAGS_PROPERTYNAME, self::TAG_FAVORITE],
+            0
+        );
+
+        $this->plugin->handleGetProperties(
+            $propFind,
+            $sabreNode
+        );
+
+        $result = $propFind->getResultForMultiStatus();
+        $this->assertCount(2, $result[404]);
+    }
+
+    public function testUpdateTags(): void {
+        // this test will replace the existing tags "tagremove" with "tag1" and "tag2"
+        // and keep "tagkeep"
+        $node = $this->createMock(Node::class);
+        $node->expects($this->any())
+            ->method('getId')
+            ->willReturn(123);
+
+        $this->tree->expects($this->any())
+            ->method('getNodeForPath')
+            ->with('/dummypath')
+            ->willReturn($node);
+
+        $this->tagger->expects($this->once())
+            ->method('getTagsForObjects')
+            ->with($this->equalTo([123]))
+            ->willReturn([123 => ['tagkeep', 'tagremove', self::TAG_FAVORITE]]);
+
+        // then tag as tag1 and tag2
+        $calls = [
+            [123, 'tag1', '/dummypath'],
+            [123, 'tag2', '/dummypath'],
+        ];
+        $this->tagger->expects($this->exactly(count($calls)))
+            ->method('tagAs')
+            ->willReturnCallback(function () use (&$calls): void {
+                $expected = array_shift($calls);
+                $this->assertEquals($expected, func_get_args());
+            });
+
+        // it will untag tag3
+        $this->tagger->expects($this->once())
+            ->method('unTag')
+            ->with(123, 'tagremove');
+
+        // properties to set
+        $propPatch = new \Sabre\DAV\PropPatch([
+            self::TAGS_PROPERTYNAME => new TagList(['tag1', 'tag2', 'tagkeep'])
+        ]);
+
+        $this->plugin->handleUpdateProperties(
+            '/dummypath',
+            $propPatch
+        );
+
+        $propPatch->commit();
+
+        // all requested properties removed, as they were processed already
+        $this->assertEmpty($propPatch->getRemainingMutations());
+
+        $result = $propPatch->getResult();
+        $this->assertEquals(200, $result[self::TAGS_PROPERTYNAME]);
+        $this->assertArrayNotHasKey(self::FAVORITE_PROPERTYNAME, $result);
+    }
+
+    public function testUpdateTagsFromScratch(): void {
+        $node = $this->createMock(Node::class);
+        $node->expects($this->any())
+            ->method('getId')
+            ->willReturn(123);
+
+        $this->tree->expects($this->any())
+            ->method('getNodeForPath')
+            ->with('/dummypath')
+            ->willReturn($node);
+
+        $this->tagger->expects($this->once())
+            ->method('getTagsForObjects')
+            ->with($this->equalTo([123]))
+            ->willReturn([]);
+
+        // then tag as tag1 and tag2
+        $calls = [
+            [123, 'tag1', '/dummypath'],
+            [123, 'tag2', '/dummypath'],
+        ];
+        $this->tagger->expects($this->exactly(count($calls)))
+            ->method('tagAs')
+            ->willReturnCallback(function () use (&$calls): void {
+                $expected = array_shift($calls);
+                $this->assertEquals($expected, func_get_args());
+            });
+
+        // properties to set
+        $propPatch = new \Sabre\DAV\PropPatch([
+            self::TAGS_PROPERTYNAME => new TagList(['tag1', 'tag2'])
+        ]);
+
+        $this->plugin->handleUpdateProperties(
+            '/dummypath',
+            $propPatch
+        );
+
+        $propPatch->commit();
+
+        // all requested properties removed, as they were processed already
+        $this->assertEmpty($propPatch->getRemainingMutations());
+
+        $result = $propPatch->getResult();
+        $this->assertEquals(200, $result[self::TAGS_PROPERTYNAME]);
+        $this->assertArrayNotHasKey(self::FAVORITE_PROPERTYNAME, $result);
+    }
+
+    public function testUpdateFav(): void {
+        // this test will replace the existing tags "tagremove" with "tag1" and "tag2"
+        // and keep "tagkeep"
+        $node = $this->createMock(Node::class);
+        $node->expects($this->any())
+            ->method('getId')
+            ->willReturn(123);
+
+        $this->tree->expects($this->any())
+            ->method('getNodeForPath')
+            ->with('/dummypath')
+            ->willReturn($node);
+
+        // set favorite tag
+        $this->tagger->expects($this->once())
+            ->method('tagAs')
+            ->with(123, self::TAG_FAVORITE);
+
+        // properties to set
+        $propPatch = new \Sabre\DAV\PropPatch([
+            self::FAVORITE_PROPERTYNAME => true
+        ]);
+
+        $this->plugin->handleUpdateProperties(
+            '/dummypath',
+            $propPatch
+        );
+
+        $propPatch->commit();
+
+        // all requested properties removed, as they were processed already
+        $this->assertEmpty($propPatch->getRemainingMutations());
+
+        $result = $propPatch->getResult();
+        $this->assertArrayNotHasKey(self::TAGS_PROPERTYNAME, $result);
+        $this->assertEquals(200, $result[self::FAVORITE_PROPERTYNAME]);
+
+        // unfavorite now
+        // set favorite tag
+        $this->tagger->expects($this->once())
+            ->method('unTag')
+            ->with(123, self::TAG_FAVORITE);
+
+        // properties to set
+        $propPatch = new \Sabre\DAV\PropPatch([
+            self::FAVORITE_PROPERTYNAME => false
+        ]);
+
+        $this->plugin->handleUpdateProperties(
+            '/dummypath',
+            $propPatch
+        );
+
+        $propPatch->commit();
+
+        // all requested properties removed, as they were processed already
+        $this->assertEmpty($propPatch->getRemainingMutations());
+
+        $result = $propPatch->getResult();
+        $this->assertArrayNotHasKey(self::TAGS_PROPERTYNAME, $result);
+        $this->assertEquals(200, $result[self::FAVORITE_PROPERTYNAME]);
+    }
 }

tests/lib/TagsTest.php

Indentation +267 added lines, -267 removed lines

@@ -28,271 +28,271 @@
  * @group DB
  */
 class TagsTest extends \Test\TestCase {
-	protected $objectType;
-	/** @var IUser */
-	protected $user;
-	/** @var IUserSession */
-	protected $userSession;
-	protected $backupGlobals = false;
-	/** @var \OC\Tagging\TagMapper */
-	protected $tagMapper;
-	/** @var ITagManager */
-	protected $tagMgr;
-
-	protected function setUp(): void {
-		parent::setUp();
-
-		Server::get(IUserManager::class)->clearBackends();
-		Server::get(IUserManager::class)->registerBackend(new \Test\Util\User\Dummy());
-		$userId = $this->getUniqueID('user_');
-		Server::get(IUserManager::class)->createUser($userId, 'pass');
-		\OC_User::setUserId($userId);
-		$this->user = $this->createMock(IUser::class);
-		$this->user->method('getUID')
-			->willReturn($userId);
-		$this->userSession = $this->createMock(IUserSession::class);
-		$this->userSession
-			->expects($this->any())
-			->method('getUser')
-			->willReturn($this->user);
-		$userFolder = $this->createMock(Folder::class);
-		$node = $this->createMock(Node::class);
-		$this->rootFolder = $this->createMock(IRootFolder::class);
-		$this->rootFolder
-			->method('getUserFolder')
-			->willReturnCallback(fn () => $userFolder);
-		$userFolder
-			->method('getFirstNodeById')
-			->willReturnCallback(fn () => $node);
-		$node
-			->method('getPath')
-			->willReturnCallback(fn () => 'file.txt');
-
-		$this->objectType = $this->getUniqueID('type_');
-		$this->tagMapper = new TagMapper(Server::get(IDBConnection::class));
-		$this->tagMgr = new TagManager($this->tagMapper, $this->userSession, Server::get(IDBConnection::class), Server::get(LoggerInterface::class), Server::get(IEventDispatcher::class), $this->rootFolder);
-	}
-
-	protected function tearDown(): void {
-		$conn = Server::get(IDBConnection::class);
-		$conn->executeQuery('DELETE FROM `*PREFIX*vcategory_to_object`');
-		$conn->executeQuery('DELETE FROM `*PREFIX*vcategory`');
-
-		parent::tearDown();
-	}
-
-	public function testTagManagerWithoutUserReturnsNull(): void {
-		$this->userSession = $this->createMock(IUserSession::class);
-		$this->userSession
-			->expects($this->any())
-			->method('getUser')
-			->willReturn(null);
-		$this->tagMgr = new TagManager($this->tagMapper, $this->userSession, Server::get(IDBConnection::class), Server::get(LoggerInterface::class), Server::get(IEventDispatcher::class), $this->rootFolder);
-		$this->assertNull($this->tagMgr->load($this->objectType));
-	}
-
-	public function testInstantiateWithDefaults(): void {
-		$defaultTags = ['Friends', 'Family', 'Work', 'Other'];
-
-		$tagger = $this->tagMgr->load($this->objectType, $defaultTags);
-
-		$this->assertEquals(4, count($tagger->getTags()));
-	}
-
-	public function testAddTags(): void {
-		$tags = ['Friends', 'Family', 'Work', 'Other'];
-
-		$tagger = $this->tagMgr->load($this->objectType);
-
-		foreach ($tags as $tag) {
-			$result = $tagger->add($tag);
-			$this->assertGreaterThan(0, $result, 'add() returned an ID <= 0');
-			$this->assertTrue((bool)$result);
-		}
-
-		$this->assertFalse($tagger->add('Family'));
-		$this->assertFalse($tagger->add('fAMILY'));
-
-		$this->assertCount(4, $tagger->getTags(), 'Wrong number of added tags');
-	}
-
-	public function testAddMultiple(): void {
-		$tags = ['Friends', 'Family', 'Work', 'Other'];
-
-		$tagger = $this->tagMgr->load($this->objectType);
-
-		foreach ($tags as $tag) {
-			$this->assertFalse($tagger->hasTag($tag));
-		}
-
-		$result = $tagger->addMultiple($tags);
-		$this->assertTrue((bool)$result);
-
-		foreach ($tags as $tag) {
-			$this->assertTrue($tagger->hasTag($tag));
-		}
-
-		$tagMaps = $tagger->getTags();
-		$this->assertCount(4, $tagMaps, 'Not all tags added');
-		foreach ($tagMaps as $tagMap) {
-			$this->assertEquals(null, $tagMap['id']);
-		}
-
-		// As addMultiple has been called without $sync=true, the tags aren't
-		// saved to the database, so they're gone when we reload $tagger:
-
-		$tagger = $this->tagMgr->load($this->objectType);
-		$this->assertEquals(0, count($tagger->getTags()));
-
-		// Now, we call addMultiple() with $sync=true so the tags will be
-		// be saved to the database.
-		$result = $tagger->addMultiple($tags, true);
-		$this->assertTrue((bool)$result);
-
-		$tagMaps = $tagger->getTags();
-		foreach ($tagMaps as $tagMap) {
-			$this->assertNotEquals(null, $tagMap['id']);
-		}
-
-		// Reload the tagger.
-		$tagger = $this->tagMgr->load($this->objectType);
-
-		foreach ($tags as $tag) {
-			$this->assertTrue($tagger->hasTag($tag));
-		}
-
-		$this->assertCount(4, $tagger->getTags(), 'Not all previously saved tags found');
-	}
-
-	public function testIsEmpty(): void {
-		$tagger = $this->tagMgr->load($this->objectType);
-
-		$this->assertEquals(0, count($tagger->getTags()));
-		$this->assertTrue($tagger->isEmpty());
-
-		$result = $tagger->add('Tag');
-		$this->assertGreaterThan(0, $result, 'add() returned an ID <= 0');
-		$this->assertNotEquals(false, $result, 'add() returned false');
-		$this->assertFalse($tagger->isEmpty());
-	}
-
-	public function testGetTagsForObjects(): void {
-		$defaultTags = ['Friends', 'Family', 'Work', 'Other'];
-		$tagger = $this->tagMgr->load($this->objectType, $defaultTags);
-
-		$tagger->tagAs(1, 'Friends');
-		$tagger->tagAs(1, 'Other');
-		$tagger->tagAs(2, 'Family');
-
-		$tags = $tagger->getTagsForObjects([1]);
-		$this->assertEquals(1, count($tags));
-		$tags = current($tags);
-		sort($tags);
-		$this->assertSame(['Friends', 'Other'], $tags);
-
-		$tags = $tagger->getTagsForObjects([1, 2]);
-		$this->assertEquals(2, count($tags));
-		$tags1 = $tags[1];
-		sort($tags1);
-		$this->assertSame(['Friends', 'Other'], $tags1);
-		$this->assertSame(['Family'], $tags[2]);
-		$this->assertEquals(
-			[],
-			$tagger->getTagsForObjects([4])
-		);
-		$this->assertEquals(
-			[],
-			$tagger->getTagsForObjects([4, 5])
-		);
-	}
-
-	public function testGetTagsForObjectsMassiveResults(): void {
-		$defaultTags = ['tag1'];
-		$tagger = $this->tagMgr->load($this->objectType, $defaultTags);
-		$tagData = $tagger->getTags();
-		$tagId = $tagData[0]['id'];
-		$tagType = $tagData[0]['type'];
-
-		$conn = Server::get(IDBConnection::class);
-		$statement = $conn->prepare(
-			'INSERT INTO `*PREFIX*vcategory_to_object` '
-			. '(`objid`, `categoryid`, `type`) VALUES '
-			. '(?, ?, ?)'
-		);
-
-		// insert lots of entries
-		$idsArray = [];
-		for ($i = 1; $i <= 1500; $i++) {
-			$statement->execute([$i, $tagId, $tagType]);
-			$idsArray[] = $i;
-		}
-
-		$tags = $tagger->getTagsForObjects($idsArray);
-		$this->assertEquals(1500, count($tags));
-	}
-
-	public function testDeleteTags(): void {
-		$defaultTags = ['Friends', 'Family', 'Work', 'Other'];
-		$tagger = $this->tagMgr->load($this->objectType, $defaultTags);
-
-		$this->assertEquals(4, count($tagger->getTags()));
-
-		$tagger->delete('family');
-		$this->assertEquals(3, count($tagger->getTags()));
-
-		$tagger->delete(['Friends', 'Work', 'Other']);
-		$this->assertEquals(0, count($tagger->getTags()));
-	}
-
-	public function testRenameTag(): void {
-		$defaultTags = ['Friends', 'Family', 'Wrok', 'Other'];
-		$tagger = $this->tagMgr->load($this->objectType, $defaultTags);
-
-		$this->assertTrue($tagger->rename('Wrok', 'Work'));
-		$this->assertTrue($tagger->hasTag('Work'));
-		$this->assertFalse($tagger->hasTag('Wrok'));
-		$this->assertFalse($tagger->rename('Wrok', 'Work')); // Rename non-existant tag.
-		$this->assertFalse($tagger->rename('Work', 'Family')); // Collide with existing tag.
-	}
-
-	public function testTagAs(): void {
-		$objids = [1, 2, 3, 4, 5, 6, 7, 8, 9];
-
-		$tagger = $this->tagMgr->load($this->objectType);
-
-		foreach ($objids as $id) {
-			$this->assertTrue($tagger->tagAs($id, 'Family'));
-		}
-
-		$this->assertEquals(1, count($tagger->getTags()));
-		$this->assertEquals(9, count($tagger->getIdsForTag('Family')));
-	}
-
-	/**
-	 * @depends testTagAs
-	 */
-	public function testUnTag(): void {
-		$objIds = [1, 2, 3, 4, 5, 6, 7, 8, 9];
-
-		// Is this "legal"?
-		$this->testTagAs();
-		$tagger = $this->tagMgr->load($this->objectType);
-
-		foreach ($objIds as $id) {
-			$this->assertTrue(in_array($id, $tagger->getIdsForTag('Family')));
-			$tagger->unTag($id, 'Family');
-			$this->assertFalse(in_array($id, $tagger->getIdsForTag('Family')));
-		}
-
-		$this->assertEquals(1, count($tagger->getTags()));
-		$this->assertEquals(0, count($tagger->getIdsForTag('Family')));
-	}
-
-	public function testFavorite(): void {
-		$tagger = $this->tagMgr->load($this->objectType);
-		$this->assertTrue($tagger->addToFavorites(1));
-		$this->assertEquals([1], $tagger->getFavorites());
-		$this->assertTrue($tagger->removeFromFavorites(1));
-		$this->assertEquals([], $tagger->getFavorites());
-	}
+    protected $objectType;
+    /** @var IUser */
+    protected $user;
+    /** @var IUserSession */
+    protected $userSession;
+    protected $backupGlobals = false;
+    /** @var \OC\Tagging\TagMapper */
+    protected $tagMapper;
+    /** @var ITagManager */
+    protected $tagMgr;
+
+    protected function setUp(): void {
+        parent::setUp();
+
+        Server::get(IUserManager::class)->clearBackends();
+        Server::get(IUserManager::class)->registerBackend(new \Test\Util\User\Dummy());
+        $userId = $this->getUniqueID('user_');
+        Server::get(IUserManager::class)->createUser($userId, 'pass');
+        \OC_User::setUserId($userId);
+        $this->user = $this->createMock(IUser::class);
+        $this->user->method('getUID')
+            ->willReturn($userId);
+        $this->userSession = $this->createMock(IUserSession::class);
+        $this->userSession
+            ->expects($this->any())
+            ->method('getUser')
+            ->willReturn($this->user);
+        $userFolder = $this->createMock(Folder::class);
+        $node = $this->createMock(Node::class);
+        $this->rootFolder = $this->createMock(IRootFolder::class);
+        $this->rootFolder
+            ->method('getUserFolder')
+            ->willReturnCallback(fn () => $userFolder);
+        $userFolder
+            ->method('getFirstNodeById')
+            ->willReturnCallback(fn () => $node);
+        $node
+            ->method('getPath')
+            ->willReturnCallback(fn () => 'file.txt');
+
+        $this->objectType = $this->getUniqueID('type_');
+        $this->tagMapper = new TagMapper(Server::get(IDBConnection::class));
+        $this->tagMgr = new TagManager($this->tagMapper, $this->userSession, Server::get(IDBConnection::class), Server::get(LoggerInterface::class), Server::get(IEventDispatcher::class), $this->rootFolder);
+    }
+
+    protected function tearDown(): void {
+        $conn = Server::get(IDBConnection::class);
+        $conn->executeQuery('DELETE FROM `*PREFIX*vcategory_to_object`');
+        $conn->executeQuery('DELETE FROM `*PREFIX*vcategory`');
+
+        parent::tearDown();
+    }
+
+    public function testTagManagerWithoutUserReturnsNull(): void {
+        $this->userSession = $this->createMock(IUserSession::class);
+        $this->userSession
+            ->expects($this->any())
+            ->method('getUser')
+            ->willReturn(null);
+        $this->tagMgr = new TagManager($this->tagMapper, $this->userSession, Server::get(IDBConnection::class), Server::get(LoggerInterface::class), Server::get(IEventDispatcher::class), $this->rootFolder);
+        $this->assertNull($this->tagMgr->load($this->objectType));
+    }
+
+    public function testInstantiateWithDefaults(): void {
+        $defaultTags = ['Friends', 'Family', 'Work', 'Other'];
+
+        $tagger = $this->tagMgr->load($this->objectType, $defaultTags);
+
+        $this->assertEquals(4, count($tagger->getTags()));
+    }
+
+    public function testAddTags(): void {
+        $tags = ['Friends', 'Family', 'Work', 'Other'];
+
+        $tagger = $this->tagMgr->load($this->objectType);
+
+        foreach ($tags as $tag) {
+            $result = $tagger->add($tag);
+            $this->assertGreaterThan(0, $result, 'add() returned an ID <= 0');
+            $this->assertTrue((bool)$result);
+        }
+
+        $this->assertFalse($tagger->add('Family'));
+        $this->assertFalse($tagger->add('fAMILY'));
+
+        $this->assertCount(4, $tagger->getTags(), 'Wrong number of added tags');
+    }
+
+    public function testAddMultiple(): void {
+        $tags = ['Friends', 'Family', 'Work', 'Other'];
+
+        $tagger = $this->tagMgr->load($this->objectType);
+
+        foreach ($tags as $tag) {
+            $this->assertFalse($tagger->hasTag($tag));
+        }
+
+        $result = $tagger->addMultiple($tags);
+        $this->assertTrue((bool)$result);
+
+        foreach ($tags as $tag) {
+            $this->assertTrue($tagger->hasTag($tag));
+        }
+
+        $tagMaps = $tagger->getTags();
+        $this->assertCount(4, $tagMaps, 'Not all tags added');
+        foreach ($tagMaps as $tagMap) {
+            $this->assertEquals(null, $tagMap['id']);
+        }
+
+        // As addMultiple has been called without $sync=true, the tags aren't
+        // saved to the database, so they're gone when we reload $tagger:
+
+        $tagger = $this->tagMgr->load($this->objectType);
+        $this->assertEquals(0, count($tagger->getTags()));
+
+        // Now, we call addMultiple() with $sync=true so the tags will be
+        // be saved to the database.
+        $result = $tagger->addMultiple($tags, true);
+        $this->assertTrue((bool)$result);
+
+        $tagMaps = $tagger->getTags();
+        foreach ($tagMaps as $tagMap) {
+            $this->assertNotEquals(null, $tagMap['id']);
+        }
+
+        // Reload the tagger.
+        $tagger = $this->tagMgr->load($this->objectType);
+
+        foreach ($tags as $tag) {
+            $this->assertTrue($tagger->hasTag($tag));
+        }
+
+        $this->assertCount(4, $tagger->getTags(), 'Not all previously saved tags found');
+    }
+
+    public function testIsEmpty(): void {
+        $tagger = $this->tagMgr->load($this->objectType);
+
+        $this->assertEquals(0, count($tagger->getTags()));
+        $this->assertTrue($tagger->isEmpty());
+
+        $result = $tagger->add('Tag');
+        $this->assertGreaterThan(0, $result, 'add() returned an ID <= 0');
+        $this->assertNotEquals(false, $result, 'add() returned false');
+        $this->assertFalse($tagger->isEmpty());
+    }
+
+    public function testGetTagsForObjects(): void {
+        $defaultTags = ['Friends', 'Family', 'Work', 'Other'];
+        $tagger = $this->tagMgr->load($this->objectType, $defaultTags);
+
+        $tagger->tagAs(1, 'Friends');
+        $tagger->tagAs(1, 'Other');
+        $tagger->tagAs(2, 'Family');
+
+        $tags = $tagger->getTagsForObjects([1]);
+        $this->assertEquals(1, count($tags));
+        $tags = current($tags);
+        sort($tags);
+        $this->assertSame(['Friends', 'Other'], $tags);
+
+        $tags = $tagger->getTagsForObjects([1, 2]);
+        $this->assertEquals(2, count($tags));
+        $tags1 = $tags[1];
+        sort($tags1);
+        $this->assertSame(['Friends', 'Other'], $tags1);
+        $this->assertSame(['Family'], $tags[2]);
+        $this->assertEquals(
+            [],
+            $tagger->getTagsForObjects([4])
+        );
+        $this->assertEquals(
+            [],
+            $tagger->getTagsForObjects([4, 5])
+        );
+    }
+
+    public function testGetTagsForObjectsMassiveResults(): void {
+        $defaultTags = ['tag1'];
+        $tagger = $this->tagMgr->load($this->objectType, $defaultTags);
+        $tagData = $tagger->getTags();
+        $tagId = $tagData[0]['id'];
+        $tagType = $tagData[0]['type'];
+
+        $conn = Server::get(IDBConnection::class);
+        $statement = $conn->prepare(
+            'INSERT INTO `*PREFIX*vcategory_to_object` '
+            . '(`objid`, `categoryid`, `type`) VALUES '
+            . '(?, ?, ?)'
+        );
+
+        // insert lots of entries
+        $idsArray = [];
+        for ($i = 1; $i <= 1500; $i++) {
+            $statement->execute([$i, $tagId, $tagType]);
+            $idsArray[] = $i;
+        }
+
+        $tags = $tagger->getTagsForObjects($idsArray);
+        $this->assertEquals(1500, count($tags));
+    }
+
+    public function testDeleteTags(): void {
+        $defaultTags = ['Friends', 'Family', 'Work', 'Other'];
+        $tagger = $this->tagMgr->load($this->objectType, $defaultTags);
+
+        $this->assertEquals(4, count($tagger->getTags()));
+
+        $tagger->delete('family');
+        $this->assertEquals(3, count($tagger->getTags()));
+
+        $tagger->delete(['Friends', 'Work', 'Other']);
+        $this->assertEquals(0, count($tagger->getTags()));
+    }
+
+    public function testRenameTag(): void {
+        $defaultTags = ['Friends', 'Family', 'Wrok', 'Other'];
+        $tagger = $this->tagMgr->load($this->objectType, $defaultTags);
+
+        $this->assertTrue($tagger->rename('Wrok', 'Work'));
+        $this->assertTrue($tagger->hasTag('Work'));
+        $this->assertFalse($tagger->hasTag('Wrok'));
+        $this->assertFalse($tagger->rename('Wrok', 'Work')); // Rename non-existant tag.
+        $this->assertFalse($tagger->rename('Work', 'Family')); // Collide with existing tag.
+    }
+
+    public function testTagAs(): void {
+        $objids = [1, 2, 3, 4, 5, 6, 7, 8, 9];
+
+        $tagger = $this->tagMgr->load($this->objectType);
+
+        foreach ($objids as $id) {
+            $this->assertTrue($tagger->tagAs($id, 'Family'));
+        }
+
+        $this->assertEquals(1, count($tagger->getTags()));
+        $this->assertEquals(9, count($tagger->getIdsForTag('Family')));
+    }
+
+    /**
+     * @depends testTagAs
+     */
+    public function testUnTag(): void {
+        $objIds = [1, 2, 3, 4, 5, 6, 7, 8, 9];
+
+        // Is this "legal"?
+        $this->testTagAs();
+        $tagger = $this->tagMgr->load($this->objectType);
+
+        foreach ($objIds as $id) {
+            $this->assertTrue(in_array($id, $tagger->getIdsForTag('Family')));
+            $tagger->unTag($id, 'Family');
+            $this->assertFalse(in_array($id, $tagger->getIdsForTag('Family')));
+        }
+
+        $this->assertEquals(1, count($tagger->getTags()));
+        $this->assertEquals(0, count($tagger->getIdsForTag('Family')));
+    }
+
+    public function testFavorite(): void {
+        $tagger = $this->tagMgr->load($this->objectType);
+        $this->assertTrue($tagger->addToFavorites(1));
+        $this->assertEquals([1], $tagger->getFavorites());
+        $this->assertTrue($tagger->removeFromFavorites(1));
+        $this->assertEquals([], $tagger->getFavorites());
+    }
 }