nextcloud / server

lib/public/SystemTag/ISystemTagManagerFactory.php

Indentation +22 added lines, -22 removed lines

@@ -34,28 +34,28 @@
  */
 interface ISystemTagManagerFactory {
 
-	/**
-	 * Constructor for the system tag manager factory
-	 *
-	 * @param IServerContainer $serverContainer server container
-	 * @since 9.0.0
-	 */
-	public function __construct(IServerContainer $serverContainer);
+    /**
+     * Constructor for the system tag manager factory
+     *
+     * @param IServerContainer $serverContainer server container
+     * @since 9.0.0
+     */
+    public function __construct(IServerContainer $serverContainer);
 
-	/**
-	 * creates and returns an instance of the system tag manager
-	 *
-	 * @return ISystemTagManager
-	 * @since 9.0.0
-	 */
-	public function getManager(): ISystemTagManager;
+    /**
+     * creates and returns an instance of the system tag manager
+     *
+     * @return ISystemTagManager
+     * @since 9.0.0
+     */
+    public function getManager(): ISystemTagManager;
 
-	/**
-	 * creates and returns an instance of the system tag object
-	 * mapper
-	 *
-	 * @return ISystemTagObjectMapper
-	 * @since 9.0.0
-	 */
-	public function getObjectMapper(): ISystemTagObjectMapper;
+    /**
+     * creates and returns an instance of the system tag object
+     * mapper
+     *
+     * @return ISystemTagObjectMapper
+     * @since 9.0.0
+     */
+    public function getObjectMapper(): ISystemTagObjectMapper;
 }

lib/public/SystemTag/ISystemTagManager.php

Indentation +120 added lines, -120 removed lines

@@ -33,133 +33,133 @@
  */
 interface ISystemTagManager {
 
-	/**
-	 * Returns the tag objects matching the given tag ids.
-	 *
-	 * @param array|string $tagIds id or array of unique ids of the tag to retrieve
-	 *
-	 * @return ISystemTag[] array of system tags with tag id as key
-	 *
-	 * @throws \InvalidArgumentException if at least one given tag ids is invalid (string instead of integer, etc.)
-	 * @throws TagNotFoundException if at least one given tag ids did no exist
-	 * 			The message contains a json_encoded array of the ids that could not be found
-	 *
-	 * @since 9.0.0
-	 */
-	public function getTagsByIds($tagIds): array;
+    /**
+     * Returns the tag objects matching the given tag ids.
+     *
+     * @param array|string $tagIds id or array of unique ids of the tag to retrieve
+     *
+     * @return ISystemTag[] array of system tags with tag id as key
+     *
+     * @throws \InvalidArgumentException if at least one given tag ids is invalid (string instead of integer, etc.)
+     * @throws TagNotFoundException if at least one given tag ids did no exist
+     * 			The message contains a json_encoded array of the ids that could not be found
+     *
+     * @since 9.0.0
+     */
+    public function getTagsByIds($tagIds): array;
 
-	/**
-	 * Returns the tag object matching the given attributes.
-	 *
-	 * @param string $tagName tag name
-	 * @param bool $userVisible whether the tag is visible by users
-	 * @param bool $userAssignable whether the tag is assignable by users
-	 *
-	 * @return ISystemTag system tag
-	 *
-	 * @throws TagNotFoundException if tag does not exist
-	 *
-	 * @since 9.0.0
-	 */
-	public function getTag(string $tagName, bool $userVisible, bool $userAssignable): ISystemTag;
+    /**
+     * Returns the tag object matching the given attributes.
+     *
+     * @param string $tagName tag name
+     * @param bool $userVisible whether the tag is visible by users
+     * @param bool $userAssignable whether the tag is assignable by users
+     *
+     * @return ISystemTag system tag
+     *
+     * @throws TagNotFoundException if tag does not exist
+     *
+     * @since 9.0.0
+     */
+    public function getTag(string $tagName, bool $userVisible, bool $userAssignable): ISystemTag;
 
-	/**
-	 * Creates the tag object using the given attributes.
-	 *
-	 * @param string $tagName tag name
-	 * @param bool $userVisible whether the tag is visible by users
-	 * @param bool $userAssignable whether the tag is assignable by users
-	 *
-	 * @return ISystemTag system tag
-	 *
-	 * @throws TagAlreadyExistsException if tag already exists
-	 *
-	 * @since 9.0.0
-	 */
-	public function createTag(string $tagName, bool $userVisible, bool $userAssignable): ISystemTag;
+    /**
+     * Creates the tag object using the given attributes.
+     *
+     * @param string $tagName tag name
+     * @param bool $userVisible whether the tag is visible by users
+     * @param bool $userAssignable whether the tag is assignable by users
+     *
+     * @return ISystemTag system tag
+     *
+     * @throws TagAlreadyExistsException if tag already exists
+     *
+     * @since 9.0.0
+     */
+    public function createTag(string $tagName, bool $userVisible, bool $userAssignable): ISystemTag;
 
-	/**
-	 * Returns all known tags, optionally filtered by visibility.
-	 *
-	 * @param bool|null $visibilityFilter filter by visibility if non-null
-	 * @param string $nameSearchPattern optional search pattern for the tag name
-	 *
-	 * @return ISystemTag[] array of system tags or empty array if none found
-	 *
-	 * @since 9.0.0
-	 */
-	public function getAllTags($visibilityFilter = null, $nameSearchPattern = null): array;
+    /**
+     * Returns all known tags, optionally filtered by visibility.
+     *
+     * @param bool|null $visibilityFilter filter by visibility if non-null
+     * @param string $nameSearchPattern optional search pattern for the tag name
+     *
+     * @return ISystemTag[] array of system tags or empty array if none found
+     *
+     * @since 9.0.0
+     */
+    public function getAllTags($visibilityFilter = null, $nameSearchPattern = null): array;
 
-	/**
-	 * Updates the given tag
-	 *
-	 * @param string $tagId tag id
-	 * @param string $newName the new tag name
-	 * @param bool $userVisible whether the tag is visible by users
-	 * @param bool $userAssignable whether the tag is assignable by users
-	 *
-	 * @throws TagNotFoundException if tag with the given id does not exist
-	 * @throws TagAlreadyExistsException if there is already another tag
-	 * with the same attributes
-	 *
-	 * @since 9.0.0
-	 */
-	public function updateTag(string $tagId, string $newName, bool $userVisible, bool $userAssignable);
+    /**
+     * Updates the given tag
+     *
+     * @param string $tagId tag id
+     * @param string $newName the new tag name
+     * @param bool $userVisible whether the tag is visible by users
+     * @param bool $userAssignable whether the tag is assignable by users
+     *
+     * @throws TagNotFoundException if tag with the given id does not exist
+     * @throws TagAlreadyExistsException if there is already another tag
+     * with the same attributes
+     *
+     * @since 9.0.0
+     */
+    public function updateTag(string $tagId, string $newName, bool $userVisible, bool $userAssignable);
 
-	/**
-	 * Delete the given tags from the database and all their relationships.
-	 *
-	 * @param string|array $tagIds array of tag ids
-	 *
-	 * @throws TagNotFoundException if at least one tag did not exist
-	 *
-	 * @since 9.0.0
-	 */
-	public function deleteTags($tagIds);
+    /**
+     * Delete the given tags from the database and all their relationships.
+     *
+     * @param string|array $tagIds array of tag ids
+     *
+     * @throws TagNotFoundException if at least one tag did not exist
+     *
+     * @since 9.0.0
+     */
+    public function deleteTags($tagIds);
 
-	/**
-	 * Checks whether the given user is allowed to assign/unassign the tag with the
-	 * given id.
-	 *
-	 * @param ISystemTag $tag tag to check permission for
-	 * @param IUser $user user to check permission for
-	 *
-	 * @return true if the user is allowed to assign/unassign the tag, false otherwise
-	 *
-	 * @since 9.1.0
-	 */
-	public function canUserAssignTag(ISystemTag $tag, IUser $user): bool;
+    /**
+     * Checks whether the given user is allowed to assign/unassign the tag with the
+     * given id.
+     *
+     * @param ISystemTag $tag tag to check permission for
+     * @param IUser $user user to check permission for
+     *
+     * @return true if the user is allowed to assign/unassign the tag, false otherwise
+     *
+     * @since 9.1.0
+     */
+    public function canUserAssignTag(ISystemTag $tag, IUser $user): bool;
 
-	/**
-	 * Checks whether the given user is allowed to see the tag with the given id.
-	 *
-	 * @param ISystemTag $tag tag to check permission for
-	 * @param IUser $user user to check permission for
-	 *
-	 * @return true if the user can see the tag, false otherwise
-	 *
-	 * @since 9.1.0
-	 */
-	public function canUserSeeTag(ISystemTag $tag, IUser $user): bool;
+    /**
+     * Checks whether the given user is allowed to see the tag with the given id.
+     *
+     * @param ISystemTag $tag tag to check permission for
+     * @param IUser $user user to check permission for
+     *
+     * @return true if the user can see the tag, false otherwise
+     *
+     * @since 9.1.0
+     */
+    public function canUserSeeTag(ISystemTag $tag, IUser $user): bool;
 
-	/**
-	 * Set groups that can assign a given tag.
-	 *
-	 * @param ISystemTag $tag tag for group assignment
-	 * @param string[] $groupIds group ids of groups that can assign/unassign the tag
-	 *
-	 * @since 9.1.0
-	 */
-	public function setTagGroups(ISystemTag $tag, array $groupIds);
+    /**
+     * Set groups that can assign a given tag.
+     *
+     * @param ISystemTag $tag tag for group assignment
+     * @param string[] $groupIds group ids of groups that can assign/unassign the tag
+     *
+     * @since 9.1.0
+     */
+    public function setTagGroups(ISystemTag $tag, array $groupIds);
 
-	/**
-	 * Get groups that can assign a given tag.
-	 *
-	 * @param ISystemTag $tag tag for group assignment
-	 *
-	 * @return string[] group ids of groups that can assign/unassign the tag
-	 *
-	 * @since 9.1.0
-	 */
-	public function getTagGroups(ISystemTag $tag): array;
+    /**
+     * Get groups that can assign a given tag.
+     *
+     * @param ISystemTag $tag tag for group assignment
+     *
+     * @return string[] group ids of groups that can assign/unassign the tag
+     *
+     * @since 9.1.0
+     */
+    public function getTagGroups(ISystemTag $tag): array;
 }

lib/public/SystemTag/TagNotFoundException.php

Indentation +22 added lines, -22 removed lines

@@ -32,28 +32,28 @@
  */
 class TagNotFoundException extends \RuntimeException {
 
-	/** @var string[] */
-	protected $tags;
+    /** @var string[] */
+    protected $tags;
 
-	/**
-	 * TagNotFoundException constructor.
-	 *
-	 * @param string $message
-	 * @param int $code
-	 * @param \Exception|null $previous
-	 * @param string[] $tags
-	 * @since 9.0.0
-	 */
-	public function __construct(string $message = '', int $code = 0, \Exception $previous = null, array $tags = []) {
-		parent::__construct($message, $code, $previous);
-		$this->tags = $tags;
-	}
+    /**
+     * TagNotFoundException constructor.
+     *
+     * @param string $message
+     * @param int $code
+     * @param \Exception|null $previous
+     * @param string[] $tags
+     * @since 9.0.0
+     */
+    public function __construct(string $message = '', int $code = 0, \Exception $previous = null, array $tags = []) {
+        parent::__construct($message, $code, $previous);
+        $this->tags = $tags;
+    }
 
-	/**
-	 * @return string[]
-	 * @since 9.0.0
-	 */
-	public function getMissingTags(): array {
-		return $this->tags;
-	}
+    /**
+     * @return string[]
+     * @since 9.0.0
+     */
+    public function getMissingTags(): array {
+        return $this->tags;
+    }
 }

lib/public/SystemTag/SystemTagsEntityEvent.php

Indentation +37 added lines, -37 removed lines

@@ -33,46 +33,46 @@
  */
 class SystemTagsEntityEvent extends Event {
 
-	const EVENT_ENTITY = 'OCP\SystemTag\ISystemTagManager::registerEntity';
+    const EVENT_ENTITY = 'OCP\SystemTag\ISystemTagManager::registerEntity';
 
-	/** @var string */
-	protected $event;
-	/** @var \Closure[] */
-	protected $collections;
+    /** @var string */
+    protected $event;
+    /** @var \Closure[] */
+    protected $collections;
 
-	/**
-	 * SystemTagsEntityEvent constructor.
-	 *
-	 * @param string $event
-	 * @since 9.1.0
-	 */
-	public function __construct(string $event) {
-		$this->event = $event;
-		$this->collections = [];
-	}
+    /**
+     * SystemTagsEntityEvent constructor.
+     *
+     * @param string $event
+     * @since 9.1.0
+     */
+    public function __construct(string $event) {
+        $this->event = $event;
+        $this->collections = [];
+    }
 
-	/**
-	 * @param string $name
-	 * @param \Closure $entityExistsFunction The closure should take one
-	 *                 argument, which is the id of the entity, that tags
-	 *                 should be handled for. The return should then be bool,
-	 *                 depending on whether tags are allowed (true) or not.
-	 * @throws \OutOfBoundsException when the entity name is already taken
-	 * @since 9.1.0
-	 */
-	public function addEntityCollection(string $name, \Closure $entityExistsFunction) {
-		if (isset($this->collections[$name])) {
-			throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"');
-		}
+    /**
+     * @param string $name
+     * @param \Closure $entityExistsFunction The closure should take one
+     *                 argument, which is the id of the entity, that tags
+     *                 should be handled for. The return should then be bool,
+     *                 depending on whether tags are allowed (true) or not.
+     * @throws \OutOfBoundsException when the entity name is already taken
+     * @since 9.1.0
+     */
+    public function addEntityCollection(string $name, \Closure $entityExistsFunction) {
+        if (isset($this->collections[$name])) {
+            throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"');
+        }
 
-		$this->collections[$name] = $entityExistsFunction;
-	}
+        $this->collections[$name] = $entityExistsFunction;
+    }
 
-	/**
-	 * @return \Closure[]
-	 * @since 9.1.0
-	 */
-	public function getEntityCollections(): array {
-		return $this->collections;
-	}
+    /**
+     * @return \Closure[]
+     * @since 9.1.0
+     */
+    public function getEntityCollections(): array {
+        return $this->collections;
+    }
 }

lib/public/SystemTag/ManagerEvent.php

Indentation +47 added lines, -47 removed lines

@@ -34,56 +34,56 @@
  */
 class ManagerEvent extends Event {
 
-	const EVENT_CREATE = 'OCP\SystemTag\ISystemTagManager::createTag';
-	const EVENT_UPDATE = 'OCP\SystemTag\ISystemTagManager::updateTag';
-	const EVENT_DELETE = 'OCP\SystemTag\ISystemTagManager::deleteTag';
+    const EVENT_CREATE = 'OCP\SystemTag\ISystemTagManager::createTag';
+    const EVENT_UPDATE = 'OCP\SystemTag\ISystemTagManager::updateTag';
+    const EVENT_DELETE = 'OCP\SystemTag\ISystemTagManager::deleteTag';
 
-	/** @var string */
-	protected $event;
-	/** @var ISystemTag */
-	protected $tag;
-	/** @var ISystemTag */
-	protected $beforeTag;
+    /** @var string */
+    protected $event;
+    /** @var ISystemTag */
+    protected $tag;
+    /** @var ISystemTag */
+    protected $beforeTag;
 
-	/**
-	 * DispatcherEvent constructor.
-	 *
-	 * @param string $event
-	 * @param ISystemTag $tag
-	 * @param ISystemTag|null $beforeTag
-	 * @since 9.0.0
-	 */
-	public function __construct(string $event, ISystemTag $tag, ISystemTag $beforeTag = null) {
-		$this->event = $event;
-		$this->tag = $tag;
-		$this->beforeTag = $beforeTag;
-	}
+    /**
+     * DispatcherEvent constructor.
+     *
+     * @param string $event
+     * @param ISystemTag $tag
+     * @param ISystemTag|null $beforeTag
+     * @since 9.0.0
+     */
+    public function __construct(string $event, ISystemTag $tag, ISystemTag $beforeTag = null) {
+        $this->event = $event;
+        $this->tag = $tag;
+        $this->beforeTag = $beforeTag;
+    }
 
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getEvent(): string {
-		return $this->event;
-	}
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getEvent(): string {
+        return $this->event;
+    }
 
-	/**
-	 * @return ISystemTag
-	 * @since 9.0.0
-	 */
-	public function getTag(): ISystemTag {
-		return $this->tag;
-	}
+    /**
+     * @return ISystemTag
+     * @since 9.0.0
+     */
+    public function getTag(): ISystemTag {
+        return $this->tag;
+    }
 
-	/**
-	 * @return ISystemTag
-	 * @since 9.0.0
-	 * @throws \BadMethodCallException
-	 */
-	public function getTagBefore(): ISystemTag {
-		if ($this->event !== self::EVENT_UPDATE) {
-			throw new \BadMethodCallException('getTagBefore is only available on the update Event');
-		}
-		return $this->beforeTag;
-	}
+    /**
+     * @return ISystemTag
+     * @since 9.0.0
+     * @throws \BadMethodCallException
+     */
+    public function getTagBefore(): ISystemTag {
+        if ($this->event !== self::EVENT_UPDATE) {
+            throw new \BadMethodCallException('getTagBefore is only available on the update Event');
+        }
+        return $this->beforeTag;
+    }
 }

lib/public/SystemTag/ISystemTag.php

Indentation +32 added lines, -32 removed lines

@@ -30,41 +30,41 @@
  */
 interface ISystemTag {
 
-	/**
-	 * Returns the tag id
-	 *
-	 * @return string id
-	 *
-	 * @since 9.0.0
-	 */
-	public function getId(): string;
+    /**
+     * Returns the tag id
+     *
+     * @return string id
+     *
+     * @since 9.0.0
+     */
+    public function getId(): string;
 
-	/**
-	 * Returns the tag display name
-	 *
-	 * @return string tag display name
-	 *
-	 * @since 9.0.0
-	 */
-	public function getName(): string;
+    /**
+     * Returns the tag display name
+     *
+     * @return string tag display name
+     *
+     * @since 9.0.0
+     */
+    public function getName(): string;
 
-	/**
-	 * Returns whether the tag is visible for regular users
-	 *
-	 * @return bool true if visible, false otherwise
-	 *
-	 * @since 9.0.0
-	 */
-	public function isUserVisible(): bool;
+    /**
+     * Returns whether the tag is visible for regular users
+     *
+     * @return bool true if visible, false otherwise
+     *
+     * @since 9.0.0
+     */
+    public function isUserVisible(): bool;
 
-	/**
-	 * Returns whether the tag can be assigned to objects by regular users
-	 *
-	 * @return bool true if assignable, false otherwise
-	 *
-	 * @since 9.0.0
-	 */
-	public function isUserAssignable(): bool;
+    /**
+     * Returns whether the tag can be assigned to objects by regular users
+     *
+     * @return bool true if assignable, false otherwise
+     *
+     * @since 9.0.0
+     */
+    public function isUserAssignable(): bool;
 
 }
 

lib/private/SystemTag/SystemTagManager.php

Indentation +385 added lines, -385 removed lines

@@ -43,389 +43,389 @@
  */
 class SystemTagManager implements ISystemTagManager {
 
-	const TAG_TABLE = 'systemtag';
-	const TAG_GROUP_TABLE = 'systemtag_group';
-
-	/** @var IDBConnection */
-	protected $connection;
-
-	/** @var EventDispatcherInterface */
-	protected $dispatcher;
-
-	/** @var IGroupManager */
-	protected $groupManager;
-
-	/**
-	 * Prepared query for selecting tags directly
-	 *
-	 * @var \OCP\DB\QueryBuilder\IQueryBuilder
-	 */
-	private $selectTagQuery;
-
-	/**
-	 * Constructor.
-	 *
-	 * @param IDBConnection $connection database connection
-	 * @param IGroupManager $groupManager
-	 * @param EventDispatcherInterface $dispatcher
-	 */
-	public function __construct(
-		IDBConnection $connection,
-		IGroupManager $groupManager,
-		EventDispatcherInterface $dispatcher
-	) {
-		$this->connection = $connection;
-		$this->groupManager = $groupManager;
-		$this->dispatcher = $dispatcher;
-
-		$query = $this->connection->getQueryBuilder();
-		$this->selectTagQuery = $query->select('*')
-			->from(self::TAG_TABLE)
-			->where($query->expr()->eq('name', $query->createParameter('name')))
-			->andWhere($query->expr()->eq('visibility', $query->createParameter('visibility')))
-			->andWhere($query->expr()->eq('editable', $query->createParameter('editable')));
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function getTagsByIds($tagIds): array {
-		if (!\is_array($tagIds)) {
-			$tagIds = [$tagIds];
-		}
-
-		$tags = [];
-
-		// note: not all databases will fail if it's a string or starts with a number
-		foreach ($tagIds as $tagId) {
-			if (!is_numeric($tagId)) {
-				throw new \InvalidArgumentException('Tag id must be integer');
-			}
-		}
-
-		$query = $this->connection->getQueryBuilder();
-		$query->select('*')
-			->from(self::TAG_TABLE)
-			->where($query->expr()->in('id', $query->createParameter('tagids')))
-			->addOrderBy('name', 'ASC')
-			->addOrderBy('visibility', 'ASC')
-			->addOrderBy('editable', 'ASC')
-			->setParameter('tagids', $tagIds, IQueryBuilder::PARAM_INT_ARRAY);
-
-		$result = $query->execute();
-		while ($row = $result->fetch()) {
-			$tags[$row['id']] = $this->createSystemTagFromRow($row);
-		}
-
-		$result->closeCursor();
-
-		if (\count($tags) !== \count($tagIds)) {
-			throw new TagNotFoundException(
-				'Tag id(s) not found', 0, null, array_diff($tagIds, array_keys($tags))
-			);
-		}
-
-		return $tags;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function getAllTags($visibilityFilter = null, $nameSearchPattern = null): array {
-		$tags = [];
-
-		$query = $this->connection->getQueryBuilder();
-		$query->select('*')
-			->from(self::TAG_TABLE);
-
-		if (!\is_null($visibilityFilter)) {
-			$query->andWhere($query->expr()->eq('visibility', $query->createNamedParameter((int)$visibilityFilter)));
-		}
-
-		if (!empty($nameSearchPattern)) {
-			$query->andWhere(
-				$query->expr()->like(
-					'name',
-					$query->createNamedParameter('%' . $this->connection->escapeLikeParameter($nameSearchPattern). '%')
-				)
-			);
-		}
-
-		$query
-			->addOrderBy('name', 'ASC')
-			->addOrderBy('visibility', 'ASC')
-			->addOrderBy('editable', 'ASC');
-
-		$result = $query->execute();
-		while ($row = $result->fetch()) {
-			$tags[$row['id']] = $this->createSystemTagFromRow($row);
-		}
-
-		$result->closeCursor();
-
-		return $tags;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function getTag(string $tagName, bool $userVisible, bool $userAssignable): ISystemTag {
-		$result = $this->selectTagQuery
-			->setParameter('name', $tagName)
-			->setParameter('visibility', $userVisible ? 1 : 0)
-			->setParameter('editable', $userAssignable ? 1 : 0)
-			->execute();
-
-		$row = $result->fetch();
-		$result->closeCursor();
-		if (!$row) {
-			throw new TagNotFoundException(
-				'Tag ("' . $tagName . '", '. $userVisible . ', ' . $userAssignable . ') does not exist'
-			);
-		}
-
-		return $this->createSystemTagFromRow($row);
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function createTag(string $tagName, bool $userVisible, bool $userAssignable): ISystemTag {
-		$query = $this->connection->getQueryBuilder();
-		$query->insert(self::TAG_TABLE)
-			->values([
-				'name' => $query->createNamedParameter($tagName),
-				'visibility' => $query->createNamedParameter($userVisible ? 1 : 0),
-				'editable' => $query->createNamedParameter($userAssignable ? 1 : 0),
-			]);
-
-		try {
-			$query->execute();
-		} catch (UniqueConstraintViolationException $e) {
-			throw new TagAlreadyExistsException(
-				'Tag ("' . $tagName . '", '. $userVisible . ', ' . $userAssignable . ') already exists',
-				0,
-				$e
-			);
-		}
-
-		$tagId = $query->getLastInsertId();
-
-		$tag = new SystemTag(
-			(string)$tagId,
-			$tagName,
-			$userVisible,
-			$userAssignable
-		);
-
-		$this->dispatcher->dispatch(ManagerEvent::EVENT_CREATE, new ManagerEvent(
-			ManagerEvent::EVENT_CREATE, $tag
-		));
-
-		return $tag;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function updateTag(string $tagId, string $tagName, bool $userVisible, bool $userAssignable) {
-		try {
-			$tags = $this->getTagsByIds($tagId);
-		} catch (TagNotFoundException $e) {
-			throw new TagNotFoundException(
-				'Tag does not exist', 0, null, [$tagId]
-			);
-		}
-
-		$beforeUpdate = array_shift($tags);
-		$afterUpdate = new SystemTag(
-			$tagId,
-			$tagName,
-			$userVisible,
-			$userAssignable
-		);
-
-		$query = $this->connection->getQueryBuilder();
-		$query->update(self::TAG_TABLE)
-			->set('name', $query->createParameter('name'))
-			->set('visibility', $query->createParameter('visibility'))
-			->set('editable', $query->createParameter('editable'))
-			->where($query->expr()->eq('id', $query->createParameter('tagid')))
-			->setParameter('name', $tagName)
-			->setParameter('visibility', $userVisible ? 1 : 0)
-			->setParameter('editable', $userAssignable ? 1 : 0)
-			->setParameter('tagid', $tagId);
-
-		try {
-			if ($query->execute() === 0) {
-				throw new TagNotFoundException(
-					'Tag does not exist', 0, null, [$tagId]
-				);
-			}
-		} catch (UniqueConstraintViolationException $e) {
-			throw new TagAlreadyExistsException(
-				'Tag ("' . $tagName . '", '. $userVisible . ', ' . $userAssignable . ') already exists',
-				0,
-				$e
-			);
-		}
-
-		$this->dispatcher->dispatch(ManagerEvent::EVENT_UPDATE, new ManagerEvent(
-			ManagerEvent::EVENT_UPDATE, $afterUpdate, $beforeUpdate
-		));
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function deleteTags($tagIds) {
-		if (!\is_array($tagIds)) {
-			$tagIds = [$tagIds];
-		}
-
-		$tagNotFoundException = null;
-		$tags = [];
-		try {
-			$tags = $this->getTagsByIds($tagIds);
-		} catch (TagNotFoundException $e) {
-			$tagNotFoundException = $e;
-
-			// Get existing tag objects for the hooks later
-			$existingTags = array_diff($tagIds, $tagNotFoundException->getMissingTags());
-			if (!empty($existingTags)) {
-				try {
-					$tags = $this->getTagsByIds($existingTags);
-				} catch (TagNotFoundException $e) {
-					// Ignore further errors...
-				}
-			}
-		}
-
-		// delete relationships first
-		$query = $this->connection->getQueryBuilder();
-		$query->delete(SystemTagObjectMapper::RELATION_TABLE)
-			->where($query->expr()->in('systemtagid', $query->createParameter('tagids')))
-			->setParameter('tagids', $tagIds, IQueryBuilder::PARAM_INT_ARRAY)
-			->execute();
-
-		$query = $this->connection->getQueryBuilder();
-		$query->delete(self::TAG_TABLE)
-			->where($query->expr()->in('id', $query->createParameter('tagids')))
-			->setParameter('tagids', $tagIds, IQueryBuilder::PARAM_INT_ARRAY)
-			->execute();
-
-		foreach ($tags as $tag) {
-			$this->dispatcher->dispatch(ManagerEvent::EVENT_DELETE, new ManagerEvent(
-				ManagerEvent::EVENT_DELETE, $tag
-			));
-		}
-
-		if ($tagNotFoundException !== null) {
-			throw new TagNotFoundException(
-				'Tag id(s) not found', 0, $tagNotFoundException, $tagNotFoundException->getMissingTags()
-			);
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function canUserAssignTag(ISystemTag $tag, IUser $user): bool {
-		// early check to avoid unneeded group lookups
-		if ($tag->isUserAssignable() && $tag->isUserVisible()) {
-			return true;
-		}
-
-		if ($this->groupManager->isAdmin($user->getUID())) {
-			return true;
-		}
-
-		if (!$tag->isUserVisible()) {
-			return false;
-		}
-
-		$groupIds = $this->groupManager->getUserGroupIds($user);
-		if (!empty($groupIds)) {
-			$matchingGroups = array_intersect($groupIds, $this->getTagGroups($tag));
-			if (!empty($matchingGroups)) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function canUserSeeTag(ISystemTag $tag, IUser $user): bool {
-		if ($tag->isUserVisible()) {
-			return true;
-		}
-
-		if ($this->groupManager->isAdmin($user->getUID())) {
-			return true;
-		}
-
-		return false;
-	}
-
-	private function createSystemTagFromRow($row) {
-		return new SystemTag((string)$row['id'], $row['name'], (bool)$row['visibility'], (bool)$row['editable']);
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function setTagGroups(ISystemTag $tag, array $groupIds) {
-		// delete relationships first
-		$this->connection->beginTransaction();
-		try {
-			$query = $this->connection->getQueryBuilder();
-			$query->delete(self::TAG_GROUP_TABLE)
-				->where($query->expr()->eq('systemtagid', $query->createNamedParameter($tag->getId())))
-				->execute();
-
-			// add each group id
-			$query = $this->connection->getQueryBuilder();
-			$query->insert(self::TAG_GROUP_TABLE)
-				->values([
-					'systemtagid' => $query->createNamedParameter($tag->getId()),
-					'gid' => $query->createParameter('gid'),
-				]);
-			foreach ($groupIds as $groupId) {
-				if ($groupId === '') {
-					continue;
-				}
-				$query->setParameter('gid', $groupId);
-				$query->execute();
-			}
-
-			$this->connection->commit();
-		} catch (\Exception $e) {
-			$this->connection->rollBack();
-			throw $e;
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function getTagGroups(ISystemTag $tag): array {
-		$groupIds = [];
-		$query = $this->connection->getQueryBuilder();
-		$query->select('gid')
-			->from(self::TAG_GROUP_TABLE)
-			->where($query->expr()->eq('systemtagid', $query->createNamedParameter($tag->getId())))
-			->orderBy('gid');
-
-		$result = $query->execute();
-		while ($row = $result->fetch()) {
-			$groupIds[] = $row['gid'];
-		}
-
-		$result->closeCursor();
-
-		return $groupIds;
-	}
+    const TAG_TABLE = 'systemtag';
+    const TAG_GROUP_TABLE = 'systemtag_group';
+
+    /** @var IDBConnection */
+    protected $connection;
+
+    /** @var EventDispatcherInterface */
+    protected $dispatcher;
+
+    /** @var IGroupManager */
+    protected $groupManager;
+
+    /**
+     * Prepared query for selecting tags directly
+     *
+     * @var \OCP\DB\QueryBuilder\IQueryBuilder
+     */
+    private $selectTagQuery;
+
+    /**
+     * Constructor.
+     *
+     * @param IDBConnection $connection database connection
+     * @param IGroupManager $groupManager
+     * @param EventDispatcherInterface $dispatcher
+     */
+    public function __construct(
+        IDBConnection $connection,
+        IGroupManager $groupManager,
+        EventDispatcherInterface $dispatcher
+    ) {
+        $this->connection = $connection;
+        $this->groupManager = $groupManager;
+        $this->dispatcher = $dispatcher;
+
+        $query = $this->connection->getQueryBuilder();
+        $this->selectTagQuery = $query->select('*')
+            ->from(self::TAG_TABLE)
+            ->where($query->expr()->eq('name', $query->createParameter('name')))
+            ->andWhere($query->expr()->eq('visibility', $query->createParameter('visibility')))
+            ->andWhere($query->expr()->eq('editable', $query->createParameter('editable')));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getTagsByIds($tagIds): array {
+        if (!\is_array($tagIds)) {
+            $tagIds = [$tagIds];
+        }
+
+        $tags = [];
+
+        // note: not all databases will fail if it's a string or starts with a number
+        foreach ($tagIds as $tagId) {
+            if (!is_numeric($tagId)) {
+                throw new \InvalidArgumentException('Tag id must be integer');
+            }
+        }
+
+        $query = $this->connection->getQueryBuilder();
+        $query->select('*')
+            ->from(self::TAG_TABLE)
+            ->where($query->expr()->in('id', $query->createParameter('tagids')))
+            ->addOrderBy('name', 'ASC')
+            ->addOrderBy('visibility', 'ASC')
+            ->addOrderBy('editable', 'ASC')
+            ->setParameter('tagids', $tagIds, IQueryBuilder::PARAM_INT_ARRAY);
+
+        $result = $query->execute();
+        while ($row = $result->fetch()) {
+            $tags[$row['id']] = $this->createSystemTagFromRow($row);
+        }
+
+        $result->closeCursor();
+
+        if (\count($tags) !== \count($tagIds)) {
+            throw new TagNotFoundException(
+                'Tag id(s) not found', 0, null, array_diff($tagIds, array_keys($tags))
+            );
+        }
+
+        return $tags;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getAllTags($visibilityFilter = null, $nameSearchPattern = null): array {
+        $tags = [];
+
+        $query = $this->connection->getQueryBuilder();
+        $query->select('*')
+            ->from(self::TAG_TABLE);
+
+        if (!\is_null($visibilityFilter)) {
+            $query->andWhere($query->expr()->eq('visibility', $query->createNamedParameter((int)$visibilityFilter)));
+        }
+
+        if (!empty($nameSearchPattern)) {
+            $query->andWhere(
+                $query->expr()->like(
+                    'name',
+                    $query->createNamedParameter('%' . $this->connection->escapeLikeParameter($nameSearchPattern). '%')
+                )
+            );
+        }
+
+        $query
+            ->addOrderBy('name', 'ASC')
+            ->addOrderBy('visibility', 'ASC')
+            ->addOrderBy('editable', 'ASC');
+
+        $result = $query->execute();
+        while ($row = $result->fetch()) {
+            $tags[$row['id']] = $this->createSystemTagFromRow($row);
+        }
+
+        $result->closeCursor();
+
+        return $tags;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getTag(string $tagName, bool $userVisible, bool $userAssignable): ISystemTag {
+        $result = $this->selectTagQuery
+            ->setParameter('name', $tagName)
+            ->setParameter('visibility', $userVisible ? 1 : 0)
+            ->setParameter('editable', $userAssignable ? 1 : 0)
+            ->execute();
+
+        $row = $result->fetch();
+        $result->closeCursor();
+        if (!$row) {
+            throw new TagNotFoundException(
+                'Tag ("' . $tagName . '", '. $userVisible . ', ' . $userAssignable . ') does not exist'
+            );
+        }
+
+        return $this->createSystemTagFromRow($row);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function createTag(string $tagName, bool $userVisible, bool $userAssignable): ISystemTag {
+        $query = $this->connection->getQueryBuilder();
+        $query->insert(self::TAG_TABLE)
+            ->values([
+                'name' => $query->createNamedParameter($tagName),
+                'visibility' => $query->createNamedParameter($userVisible ? 1 : 0),
+                'editable' => $query->createNamedParameter($userAssignable ? 1 : 0),
+            ]);
+
+        try {
+            $query->execute();
+        } catch (UniqueConstraintViolationException $e) {
+            throw new TagAlreadyExistsException(
+                'Tag ("' . $tagName . '", '. $userVisible . ', ' . $userAssignable . ') already exists',
+                0,
+                $e
+            );
+        }
+
+        $tagId = $query->getLastInsertId();
+
+        $tag = new SystemTag(
+            (string)$tagId,
+            $tagName,
+            $userVisible,
+            $userAssignable
+        );
+
+        $this->dispatcher->dispatch(ManagerEvent::EVENT_CREATE, new ManagerEvent(
+            ManagerEvent::EVENT_CREATE, $tag
+        ));
+
+        return $tag;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function updateTag(string $tagId, string $tagName, bool $userVisible, bool $userAssignable) {
+        try {
+            $tags = $this->getTagsByIds($tagId);
+        } catch (TagNotFoundException $e) {
+            throw new TagNotFoundException(
+                'Tag does not exist', 0, null, [$tagId]
+            );
+        }
+
+        $beforeUpdate = array_shift($tags);
+        $afterUpdate = new SystemTag(
+            $tagId,
+            $tagName,
+            $userVisible,
+            $userAssignable
+        );
+
+        $query = $this->connection->getQueryBuilder();
+        $query->update(self::TAG_TABLE)
+            ->set('name', $query->createParameter('name'))
+            ->set('visibility', $query->createParameter('visibility'))
+            ->set('editable', $query->createParameter('editable'))
+            ->where($query->expr()->eq('id', $query->createParameter('tagid')))
+            ->setParameter('name', $tagName)
+            ->setParameter('visibility', $userVisible ? 1 : 0)
+            ->setParameter('editable', $userAssignable ? 1 : 0)
+            ->setParameter('tagid', $tagId);
+
+        try {
+            if ($query->execute() === 0) {
+                throw new TagNotFoundException(
+                    'Tag does not exist', 0, null, [$tagId]
+                );
+            }
+        } catch (UniqueConstraintViolationException $e) {
+            throw new TagAlreadyExistsException(
+                'Tag ("' . $tagName . '", '. $userVisible . ', ' . $userAssignable . ') already exists',
+                0,
+                $e
+            );
+        }
+
+        $this->dispatcher->dispatch(ManagerEvent::EVENT_UPDATE, new ManagerEvent(
+            ManagerEvent::EVENT_UPDATE, $afterUpdate, $beforeUpdate
+        ));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function deleteTags($tagIds) {
+        if (!\is_array($tagIds)) {
+            $tagIds = [$tagIds];
+        }
+
+        $tagNotFoundException = null;
+        $tags = [];
+        try {
+            $tags = $this->getTagsByIds($tagIds);
+        } catch (TagNotFoundException $e) {
+            $tagNotFoundException = $e;
+
+            // Get existing tag objects for the hooks later
+            $existingTags = array_diff($tagIds, $tagNotFoundException->getMissingTags());
+            if (!empty($existingTags)) {
+                try {
+                    $tags = $this->getTagsByIds($existingTags);
+                } catch (TagNotFoundException $e) {
+                    // Ignore further errors...
+                }
+            }
+        }
+
+        // delete relationships first
+        $query = $this->connection->getQueryBuilder();
+        $query->delete(SystemTagObjectMapper::RELATION_TABLE)
+            ->where($query->expr()->in('systemtagid', $query->createParameter('tagids')))
+            ->setParameter('tagids', $tagIds, IQueryBuilder::PARAM_INT_ARRAY)
+            ->execute();
+
+        $query = $this->connection->getQueryBuilder();
+        $query->delete(self::TAG_TABLE)
+            ->where($query->expr()->in('id', $query->createParameter('tagids')))
+            ->setParameter('tagids', $tagIds, IQueryBuilder::PARAM_INT_ARRAY)
+            ->execute();
+
+        foreach ($tags as $tag) {
+            $this->dispatcher->dispatch(ManagerEvent::EVENT_DELETE, new ManagerEvent(
+                ManagerEvent::EVENT_DELETE, $tag
+            ));
+        }
+
+        if ($tagNotFoundException !== null) {
+            throw new TagNotFoundException(
+                'Tag id(s) not found', 0, $tagNotFoundException, $tagNotFoundException->getMissingTags()
+            );
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function canUserAssignTag(ISystemTag $tag, IUser $user): bool {
+        // early check to avoid unneeded group lookups
+        if ($tag->isUserAssignable() && $tag->isUserVisible()) {
+            return true;
+        }
+
+        if ($this->groupManager->isAdmin($user->getUID())) {
+            return true;
+        }
+
+        if (!$tag->isUserVisible()) {
+            return false;
+        }
+
+        $groupIds = $this->groupManager->getUserGroupIds($user);
+        if (!empty($groupIds)) {
+            $matchingGroups = array_intersect($groupIds, $this->getTagGroups($tag));
+            if (!empty($matchingGroups)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function canUserSeeTag(ISystemTag $tag, IUser $user): bool {
+        if ($tag->isUserVisible()) {
+            return true;
+        }
+
+        if ($this->groupManager->isAdmin($user->getUID())) {
+            return true;
+        }
+
+        return false;
+    }
+
+    private function createSystemTagFromRow($row) {
+        return new SystemTag((string)$row['id'], $row['name'], (bool)$row['visibility'], (bool)$row['editable']);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setTagGroups(ISystemTag $tag, array $groupIds) {
+        // delete relationships first
+        $this->connection->beginTransaction();
+        try {
+            $query = $this->connection->getQueryBuilder();
+            $query->delete(self::TAG_GROUP_TABLE)
+                ->where($query->expr()->eq('systemtagid', $query->createNamedParameter($tag->getId())))
+                ->execute();
+
+            // add each group id
+            $query = $this->connection->getQueryBuilder();
+            $query->insert(self::TAG_GROUP_TABLE)
+                ->values([
+                    'systemtagid' => $query->createNamedParameter($tag->getId()),
+                    'gid' => $query->createParameter('gid'),
+                ]);
+            foreach ($groupIds as $groupId) {
+                if ($groupId === '') {
+                    continue;
+                }
+                $query->setParameter('gid', $groupId);
+                $query->execute();
+            }
+
+            $this->connection->commit();
+        } catch (\Exception $e) {
+            $this->connection->rollBack();
+            throw $e;
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getTagGroups(ISystemTag $tag): array {
+        $groupIds = [];
+        $query = $this->connection->getQueryBuilder();
+        $query->select('gid')
+            ->from(self::TAG_GROUP_TABLE)
+            ->where($query->expr()->eq('systemtagid', $query->createNamedParameter($tag->getId())))
+            ->orderBy('gid');
+
+        $result = $query->execute();
+        while ($row = $result->fetch()) {
+            $groupIds[] = $row['gid'];
+        }
+
+        $result->closeCursor();
+
+        return $groupIds;
+    }
 }

lib/private/SystemTag/SystemTag.php

Indentation +54 added lines, -54 removed lines

@@ -28,66 +28,66 @@
 
 class SystemTag implements ISystemTag {
 
-	/**
-	 * @var string
-	 */
-	private $id;
+    /**
+     * @var string
+     */
+    private $id;
 
-	/**
-	 * @var string
-	 */
-	private $name;
+    /**
+     * @var string
+     */
+    private $name;
 
-	/**
-	 * @var bool
-	 */
-	private $userVisible;
+    /**
+     * @var bool
+     */
+    private $userVisible;
 
-	/**
-	 * @var bool
-	 */
-	private $userAssignable;
+    /**
+     * @var bool
+     */
+    private $userAssignable;
 
-	/**
-	 * Constructor.
-	 *
-	 * @param string $id tag id
-	 * @param string $name tag name
-	 * @param bool $userVisible whether the tag is user visible
-	 * @param bool $userAssignable whether the tag is user assignable
-	 */
-	public function __construct(string $id, string $name, bool $userVisible, bool $userAssignable) {
-		$this->id = $id;
-		$this->name = $name;
-		$this->userVisible = $userVisible;
-		$this->userAssignable = $userAssignable;
-	}
+    /**
+     * Constructor.
+     *
+     * @param string $id tag id
+     * @param string $name tag name
+     * @param bool $userVisible whether the tag is user visible
+     * @param bool $userAssignable whether the tag is user assignable
+     */
+    public function __construct(string $id, string $name, bool $userVisible, bool $userAssignable) {
+        $this->id = $id;
+        $this->name = $name;
+        $this->userVisible = $userVisible;
+        $this->userAssignable = $userAssignable;
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function getId(): string {
-		return $this->id;
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function getId(): string {
+        return $this->id;
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function getName(): string {
-		return $this->name;
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function getName(): string {
+        return $this->name;
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function isUserVisible(): bool {
-		return $this->userVisible;
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function isUserVisible(): bool {
+        return $this->userVisible;
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function isUserAssignable(): bool {
-		return $this->userAssignable;
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function isUserAssignable(): bool {
+        return $this->userAssignable;
+    }
 }

lib/private/SystemTag/ManagerFactory.php

Indentation +41 added lines, -41 removed lines

@@ -36,48 +36,48 @@
  */
 class ManagerFactory implements ISystemTagManagerFactory {
 
-	/**
-	 * Server container
-	 *
-	 * @var IServerContainer
-	 */
-	private $serverContainer;
+    /**
+     * Server container
+     *
+     * @var IServerContainer
+     */
+    private $serverContainer;
 
-	/**
-	 * Constructor for the system tag manager factory
-	 *
-	 * @param IServerContainer $serverContainer server container
-	 */
-	public function __construct(IServerContainer $serverContainer) {
-		$this->serverContainer = $serverContainer;
-	}
+    /**
+     * Constructor for the system tag manager factory
+     *
+     * @param IServerContainer $serverContainer server container
+     */
+    public function __construct(IServerContainer $serverContainer) {
+        $this->serverContainer = $serverContainer;
+    }
 
-	/**
-	 * Creates and returns an instance of the system tag manager
-	 *
-	 * @return ISystemTagManager
-	 * @since 9.0.0
-	 */
-	public function getManager(): ISystemTagManager {
-		return new SystemTagManager(
-			$this->serverContainer->getDatabaseConnection(),
-			$this->serverContainer->getGroupManager(),
-			$this->serverContainer->getEventDispatcher()
-		);
-	}
+    /**
+     * Creates and returns an instance of the system tag manager
+     *
+     * @return ISystemTagManager
+     * @since 9.0.0
+     */
+    public function getManager(): ISystemTagManager {
+        return new SystemTagManager(
+            $this->serverContainer->getDatabaseConnection(),
+            $this->serverContainer->getGroupManager(),
+            $this->serverContainer->getEventDispatcher()
+        );
+    }
 
-	/**
-	 * Creates and returns an instance of the system tag object
-	 * mapper
-	 *
-	 * @return ISystemTagObjectMapper
-	 * @since 9.0.0
-	 */
-	public function getObjectMapper(): ISystemTagObjectMapper {
-		return new SystemTagObjectMapper(
-			$this->serverContainer->getDatabaseConnection(),
-			$this->getManager(),
-			$this->serverContainer->getEventDispatcher()
-		);
-	}
+    /**
+     * Creates and returns an instance of the system tag object
+     * mapper
+     *
+     * @return ISystemTagObjectMapper
+     * @since 9.0.0
+     */
+    public function getObjectMapper(): ISystemTagObjectMapper {
+        return new SystemTagObjectMapper(
+            $this->serverContainer->getDatabaseConnection(),
+            $this->getManager(),
+            $this->serverContainer->getEventDispatcher()
+        );
+    }
 }