nextcloud / server

lib/private/Group/Database.php

Indentation +574 added lines, -574 removed lines

@@ -30,578 +30,578 @@
  * Class for group management in a SQL Database (e.g. MySQL, SQLite)
  */
 class Database extends ABackend implements
-	IAddToGroupBackend,
-	ICountDisabledInGroup,
-	ICountUsersBackend,
-	ICreateNamedGroupBackend,
-	IDeleteGroupBackend,
-	IGetDisplayNameBackend,
-	IGroupDetailsBackend,
-	IRemoveFromGroupBackend,
-	ISetDisplayNameBackend,
-	ISearchableGroupBackend,
-	IBatchMethodsBackend,
-	INamedBackend {
-	/** @var array<string, array{gid: string, displayname: string}> */
-	private $groupCache = [];
-
-	/**
-	 * \OC\Group\Database constructor.
-	 *
-	 * @param IDBConnection|null $dbConn
-	 */
-	public function __construct(
-		private ?IDBConnection $dbConn = null,
-	) {
-	}
-
-	/**
-	 * FIXME: This function should not be required!
-	 */
-	private function fixDI() {
-		if ($this->dbConn === null) {
-			$this->dbConn = \OC::$server->getDatabaseConnection();
-		}
-	}
-
-	public function createGroup(string $name): ?string {
-		$this->fixDI();
-
-		$name = $this->sanitizeGroupName($name);
-		$gid = $this->computeGid($name);
-		try {
-			// Add group
-			$builder = $this->dbConn->getQueryBuilder();
-			$builder->insert('groups')
-				->setValue('gid', $builder->createNamedParameter($gid))
-				->setValue('displayname', $builder->createNamedParameter($name))
-				->executeStatement();
-		} catch (Exception $e) {
-			if ($e->getReason() === Exception::REASON_UNIQUE_CONSTRAINT_VIOLATION) {
-				return null;
-			} else {
-				throw $e;
-			}
-		}
-
-		// Add to cache
-		$this->groupCache[$gid] = [
-			'gid' => $gid,
-			'displayname' => $name
-		];
-
-		return $gid;
-	}
-
-	/**
-	 * delete a group
-	 * @param string $gid gid of the group to delete
-	 * @return bool
-	 *
-	 * Deletes a group and removes it from the group_user-table
-	 */
-	public function deleteGroup(string $gid): bool {
-		$this->fixDI();
-
-		// Delete the group
-		$qb = $this->dbConn->getQueryBuilder();
-		$qb->delete('groups')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->executeStatement();
-
-		// Delete the group-user relation
-		$qb = $this->dbConn->getQueryBuilder();
-		$qb->delete('group_user')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->executeStatement();
-
-		// Delete the group-groupadmin relation
-		$qb = $this->dbConn->getQueryBuilder();
-		$qb->delete('group_admin')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->executeStatement();
-
-		// Delete from cache
-		unset($this->groupCache[$gid]);
-
-		return true;
-	}
-
-	/**
-	 * is user in group?
-	 * @param string $uid uid of the user
-	 * @param string $gid gid of the group
-	 * @return bool
-	 *
-	 * Checks whether the user is member of a group or not.
-	 */
-	public function inGroup($uid, $gid) {
-		$this->fixDI();
-
-		// check
-		$qb = $this->dbConn->getQueryBuilder();
-		$cursor = $qb->select('uid')
-			->from('group_user')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
-			->executeQuery();
-
-		$result = $cursor->fetch();
-		$cursor->closeCursor();
-
-		return $result ? true : false;
-	}
-
-	/**
-	 * Add a user to a group
-	 * @param string $uid Name of the user to add to group
-	 * @param string $gid Name of the group in which add the user
-	 * @return bool
-	 *
-	 * Adds a user to a group.
-	 */
-	public function addToGroup(string $uid, string $gid): bool {
-		$this->fixDI();
-
-		// No duplicate entries!
-		if (!$this->inGroup($uid, $gid)) {
-			$qb = $this->dbConn->getQueryBuilder();
-			$qb->insert('group_user')
-				->setValue('uid', $qb->createNamedParameter($uid))
-				->setValue('gid', $qb->createNamedParameter($gid))
-				->executeStatement();
-			return true;
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * Removes a user from a group
-	 * @param string $uid Name of the user to remove from group
-	 * @param string $gid Name of the group from which remove the user
-	 * @return bool
-	 *
-	 * removes the user from a group.
-	 */
-	public function removeFromGroup(string $uid, string $gid): bool {
-		$this->fixDI();
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$qb->delete('group_user')
-			->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
-			->andWhere($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->executeStatement();
-
-		return true;
-	}
-
-	/**
-	 * Get all groups a user belongs to
-	 * @param string $uid Name of the user
-	 * @return list<string> an array of group names
-	 *
-	 * This function fetches all groups a user belongs to. It does not check
-	 * if the user exists at all.
-	 */
-	public function getUserGroups($uid) {
-		//guests has empty or null $uid
-		if ($uid === null || $uid === '') {
-			return [];
-		}
-
-		$this->fixDI();
-
-		// No magic!
-		$qb = $this->dbConn->getQueryBuilder();
-		$cursor = $qb->select('gu.gid', 'g.displayname')
-			->from('group_user', 'gu')
-			->leftJoin('gu', 'groups', 'g', $qb->expr()->eq('gu.gid', 'g.gid'))
-			->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
-			->executeQuery();
-
-		$groups = [];
-		while ($row = $cursor->fetch()) {
-			$groups[] = $row['gid'];
-			$this->groupCache[$row['gid']] = [
-				'gid' => $row['gid'],
-				'displayname' => $row['displayname'],
-			];
-		}
-		$cursor->closeCursor();
-
-		return $groups;
-	}
-
-	/**
-	 * get a list of all groups
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array an array of group names
-	 *
-	 * Returns a list with all groups
-	 */
-	public function getGroups(string $search = '', int $limit = -1, int $offset = 0) {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select('gid', 'displayname')
-			->from('groups')
-			->orderBy('gid', 'ASC');
-
-		if ($search !== '') {
-			$query->where($query->expr()->iLike('gid', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
-			)));
-			$query->orWhere($query->expr()->iLike('displayname', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
-			)));
-		}
-
-		if ($limit > 0) {
-			$query->setMaxResults($limit);
-		}
-		if ($offset > 0) {
-			$query->setFirstResult($offset);
-		}
-		$result = $query->executeQuery();
-
-		$groups = [];
-		while ($row = $result->fetch()) {
-			$this->groupCache[$row['gid']] = [
-				'displayname' => $row['displayname'],
-				'gid' => $row['gid'],
-			];
-			$groups[] = $row['gid'];
-		}
-		$result->closeCursor();
-
-		return $groups;
-	}
-
-	/**
-	 * check if a group exists
-	 * @param string $gid
-	 * @return bool
-	 */
-	public function groupExists($gid) {
-		$this->fixDI();
-
-		// Check cache first
-		if (isset($this->groupCache[$gid])) {
-			return true;
-		}
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$cursor = $qb->select('gid', 'displayname')
-			->from('groups')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->executeQuery();
-		$result = $cursor->fetch();
-		$cursor->closeCursor();
-
-		if ($result !== false) {
-			$this->groupCache[$gid] = [
-				'gid' => $gid,
-				'displayname' => $result['displayname'],
-			];
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function groupsExists(array $gids): array {
-		$notFoundGids = [];
-		$existingGroups = [];
-
-		// In case the data is already locally accessible, not need to do SQL query
-		// or do a SQL query but with a smaller in clause
-		foreach ($gids as $gid) {
-			if (isset($this->groupCache[$gid])) {
-				$existingGroups[] = $gid;
-			} else {
-				$notFoundGids[] = $gid;
-			}
-		}
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$qb->select('gid', 'displayname')
-			->from('groups')
-			->where($qb->expr()->in('gid', $qb->createParameter('ids')));
-		foreach (array_chunk($notFoundGids, 1000) as $chunk) {
-			$qb->setParameter('ids', $chunk, IQueryBuilder::PARAM_STR_ARRAY);
-			$result = $qb->executeQuery();
-			while ($row = $result->fetch()) {
-				$this->groupCache[(string)$row['gid']] = [
-					'displayname' => (string)$row['displayname'],
-					'gid' => (string)$row['gid'],
-				];
-				$existingGroups[] = (string)$row['gid'];
-			}
-			$result->closeCursor();
-		}
-
-		return $existingGroups;
-	}
-
-	/**
-	 * Get a list of all users in a group
-	 * @param string $gid
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array<int,string> an array of user ids
-	 */
-	public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0): array {
-		return array_values(array_map(fn ($user) => $user->getUid(), $this->searchInGroup($gid, $search, $limit, $offset)));
-	}
-
-	public function searchInGroup(string $gid, string $search = '', int $limit = -1, int $offset = 0): array {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select('g.uid', 'dn.value AS displayname');
-
-		$query->from('group_user', 'g')
-			->where($query->expr()->eq('gid', $query->createNamedParameter($gid)))
-			->orderBy('g.uid', 'ASC');
-
-		// Join displayname and email from oc_accounts_data
-		$query->leftJoin('g', 'accounts_data', 'dn',
-			$query->expr()->andX(
-				$query->expr()->eq('dn.uid', 'g.uid'),
-				$query->expr()->eq('dn.name', $query->expr()->literal('displayname'))
-			)
-		);
-
-		$query->leftJoin('g', 'accounts_data', 'em',
-			$query->expr()->andX(
-				$query->expr()->eq('em.uid', 'g.uid'),
-				$query->expr()->eq('em.name', $query->expr()->literal('email'))
-			)
-		);
-
-		if ($search !== '') {
-			// sqlite doesn't like re-using a single named parameter here
-			$searchParam1 = $query->createNamedParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%');
-			$searchParam2 = $query->createNamedParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%');
-			$searchParam3 = $query->createNamedParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%');
-
-			$query->andWhere(
-				$query->expr()->orX(
-					$query->expr()->ilike('g.uid', $searchParam1),
-					$query->expr()->ilike('dn.value', $searchParam2),
-					$query->expr()->ilike('em.value', $searchParam3)
-				)
-			)
-				->orderBy('g.uid', 'ASC');
-		}
-
-
-		if ($limit !== -1) {
-			$query->setMaxResults($limit);
-		}
-		if ($offset !== 0) {
-			$query->setFirstResult($offset);
-		}
-
-		$result = $query->executeQuery();
-
-		$users = [];
-		$userManager = \OCP\Server::get(IUserManager::class);
-		while ($row = $result->fetch()) {
-			$users[$row['uid']] = new LazyUser($row['uid'], $userManager, $row['displayname'] ?? null);
-		}
-		$result->closeCursor();
-
-		return $users;
-	}
-
-	/**
-	 * get the number of all users matching the search string in a group
-	 * @param string $gid
-	 * @param string $search
-	 * @return int
-	 */
-	public function countUsersInGroup(string $gid, string $search = ''): int {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select($query->func()->count('*', 'num_users'))
-			->from('group_user')
-			->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
-
-		if ($search !== '') {
-			$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
-			)));
-		}
-
-		$result = $query->executeQuery();
-		$count = $result->fetchOne();
-		$result->closeCursor();
-
-		if ($count !== false) {
-			$count = (int)$count;
-		} else {
-			$count = 0;
-		}
-
-		return $count;
-	}
-
-	/**
-	 * get the number of disabled users in a group
-	 *
-	 * @param string $search
-	 *
-	 * @return int
-	 */
-	public function countDisabledInGroup(string $gid): int {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select($query->createFunction('COUNT(DISTINCT ' . $query->getColumnName('uid') . ')'))
-			->from('preferences', 'p')
-			->innerJoin('p', 'group_user', 'g', $query->expr()->eq('p.userid', 'g.uid'))
-			->where($query->expr()->eq('appid', $query->createNamedParameter('core')))
-			->andWhere($query->expr()->eq('configkey', $query->createNamedParameter('enabled')))
-			->andWhere($query->expr()->eq('configvalue', $query->createNamedParameter('false'), IQueryBuilder::PARAM_STR))
-			->andWhere($query->expr()->eq('gid', $query->createNamedParameter($gid), IQueryBuilder::PARAM_STR));
-
-		$result = $query->executeQuery();
-		$count = $result->fetchOne();
-		$result->closeCursor();
-
-		if ($count !== false) {
-			$count = (int)$count;
-		} else {
-			$count = 0;
-		}
-
-		return $count;
-	}
-
-	public function getDisplayName(string $gid): string {
-		if (isset($this->groupCache[$gid])) {
-			$displayName = $this->groupCache[$gid]['displayname'];
-
-			if (isset($displayName) && trim($displayName) !== '') {
-				return $displayName;
-			}
-		}
-
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select('displayname')
-			->from('groups')
-			->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
-
-		$result = $query->executeQuery();
-		$displayName = $result->fetchOne();
-		$result->closeCursor();
-
-		return (string)$displayName;
-	}
-
-	public function getGroupDetails(string $gid): array {
-		$displayName = $this->getDisplayName($gid);
-		if ($displayName !== '') {
-			return ['displayName' => $displayName];
-		}
-
-		return [];
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function getGroupsDetails(array $gids): array {
-		$notFoundGids = [];
-		$details = [];
-
-		$this->fixDI();
-
-		// In case the data is already locally accessible, not need to do SQL query
-		// or do a SQL query but with a smaller in clause
-		foreach ($gids as $gid) {
-			if (isset($this->groupCache[$gid])) {
-				$details[$gid] = ['displayName' => $this->groupCache[$gid]['displayname']];
-			} else {
-				$notFoundGids[] = $gid;
-			}
-		}
-
-		foreach (array_chunk($notFoundGids, 1000) as $chunk) {
-			$query = $this->dbConn->getQueryBuilder();
-			$query->select('gid', 'displayname')
-				->from('groups')
-				->where($query->expr()->in('gid', $query->createNamedParameter($chunk, IQueryBuilder::PARAM_STR_ARRAY)));
-
-			$result = $query->executeQuery();
-			while ($row = $result->fetch()) {
-				$details[(string)$row['gid']] = ['displayName' => (string)$row['displayname']];
-				$this->groupCache[(string)$row['gid']] = [
-					'displayname' => (string)$row['displayname'],
-					'gid' => (string)$row['gid'],
-				];
-			}
-			$result->closeCursor();
-		}
-
-		return $details;
-	}
-
-	public function setDisplayName(string $gid, string $displayName): bool {
-		if (!$this->groupExists($gid)) {
-			return false;
-		}
-
-		$this->fixDI();
-
-		$displayName = trim($displayName);
-		if ($displayName === '') {
-			$displayName = $gid;
-		}
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->update('groups')
-			->set('displayname', $query->createNamedParameter($displayName))
-			->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
-		$query->executeStatement();
-
-		return true;
-	}
-
-	/**
-	 * Backend name to be shown in group management
-	 * @return string the name of the backend to be shown
-	 * @since 21.0.0
-	 */
-	public function getBackendName(): string {
-		return 'Database';
-	}
-
-	/**
-	 * Merge any white spaces to a single space in group name, then trim it.
-	 */
-	private function sanitizeGroupName(string $displayName): string {
-		$cleanedDisplayName = preg_replace('/\s+/', ' ', $displayName);
-		return trim($cleanedDisplayName);
-	}
-
-	/**
-	 * Compute group ID from display name (GIDs are limited to 64 characters in database)
-	 */
-	private function computeGid(string $displayName): string {
-		$displayNameWithoutWhitespace = preg_replace('/\s+/', '_', $displayName);
-		return mb_strlen($displayNameWithoutWhitespace) > 64
-			? hash('sha256', $displayNameWithoutWhitespace)
-			: $displayNameWithoutWhitespace;
-	}
+    IAddToGroupBackend,
+    ICountDisabledInGroup,
+    ICountUsersBackend,
+    ICreateNamedGroupBackend,
+    IDeleteGroupBackend,
+    IGetDisplayNameBackend,
+    IGroupDetailsBackend,
+    IRemoveFromGroupBackend,
+    ISetDisplayNameBackend,
+    ISearchableGroupBackend,
+    IBatchMethodsBackend,
+    INamedBackend {
+    /** @var array<string, array{gid: string, displayname: string}> */
+    private $groupCache = [];
+
+    /**
+     * \OC\Group\Database constructor.
+     *
+     * @param IDBConnection|null $dbConn
+     */
+    public function __construct(
+        private ?IDBConnection $dbConn = null,
+    ) {
+    }
+
+    /**
+     * FIXME: This function should not be required!
+     */
+    private function fixDI() {
+        if ($this->dbConn === null) {
+            $this->dbConn = \OC::$server->getDatabaseConnection();
+        }
+    }
+
+    public function createGroup(string $name): ?string {
+        $this->fixDI();
+
+        $name = $this->sanitizeGroupName($name);
+        $gid = $this->computeGid($name);
+        try {
+            // Add group
+            $builder = $this->dbConn->getQueryBuilder();
+            $builder->insert('groups')
+                ->setValue('gid', $builder->createNamedParameter($gid))
+                ->setValue('displayname', $builder->createNamedParameter($name))
+                ->executeStatement();
+        } catch (Exception $e) {
+            if ($e->getReason() === Exception::REASON_UNIQUE_CONSTRAINT_VIOLATION) {
+                return null;
+            } else {
+                throw $e;
+            }
+        }
+
+        // Add to cache
+        $this->groupCache[$gid] = [
+            'gid' => $gid,
+            'displayname' => $name
+        ];
+
+        return $gid;
+    }
+
+    /**
+     * delete a group
+     * @param string $gid gid of the group to delete
+     * @return bool
+     *
+     * Deletes a group and removes it from the group_user-table
+     */
+    public function deleteGroup(string $gid): bool {
+        $this->fixDI();
+
+        // Delete the group
+        $qb = $this->dbConn->getQueryBuilder();
+        $qb->delete('groups')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->executeStatement();
+
+        // Delete the group-user relation
+        $qb = $this->dbConn->getQueryBuilder();
+        $qb->delete('group_user')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->executeStatement();
+
+        // Delete the group-groupadmin relation
+        $qb = $this->dbConn->getQueryBuilder();
+        $qb->delete('group_admin')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->executeStatement();
+
+        // Delete from cache
+        unset($this->groupCache[$gid]);
+
+        return true;
+    }
+
+    /**
+     * is user in group?
+     * @param string $uid uid of the user
+     * @param string $gid gid of the group
+     * @return bool
+     *
+     * Checks whether the user is member of a group or not.
+     */
+    public function inGroup($uid, $gid) {
+        $this->fixDI();
+
+        // check
+        $qb = $this->dbConn->getQueryBuilder();
+        $cursor = $qb->select('uid')
+            ->from('group_user')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
+            ->executeQuery();
+
+        $result = $cursor->fetch();
+        $cursor->closeCursor();
+
+        return $result ? true : false;
+    }
+
+    /**
+     * Add a user to a group
+     * @param string $uid Name of the user to add to group
+     * @param string $gid Name of the group in which add the user
+     * @return bool
+     *
+     * Adds a user to a group.
+     */
+    public function addToGroup(string $uid, string $gid): bool {
+        $this->fixDI();
+
+        // No duplicate entries!
+        if (!$this->inGroup($uid, $gid)) {
+            $qb = $this->dbConn->getQueryBuilder();
+            $qb->insert('group_user')
+                ->setValue('uid', $qb->createNamedParameter($uid))
+                ->setValue('gid', $qb->createNamedParameter($gid))
+                ->executeStatement();
+            return true;
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * Removes a user from a group
+     * @param string $uid Name of the user to remove from group
+     * @param string $gid Name of the group from which remove the user
+     * @return bool
+     *
+     * removes the user from a group.
+     */
+    public function removeFromGroup(string $uid, string $gid): bool {
+        $this->fixDI();
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $qb->delete('group_user')
+            ->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
+            ->andWhere($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->executeStatement();
+
+        return true;
+    }
+
+    /**
+     * Get all groups a user belongs to
+     * @param string $uid Name of the user
+     * @return list<string> an array of group names
+     *
+     * This function fetches all groups a user belongs to. It does not check
+     * if the user exists at all.
+     */
+    public function getUserGroups($uid) {
+        //guests has empty or null $uid
+        if ($uid === null || $uid === '') {
+            return [];
+        }
+
+        $this->fixDI();
+
+        // No magic!
+        $qb = $this->dbConn->getQueryBuilder();
+        $cursor = $qb->select('gu.gid', 'g.displayname')
+            ->from('group_user', 'gu')
+            ->leftJoin('gu', 'groups', 'g', $qb->expr()->eq('gu.gid', 'g.gid'))
+            ->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
+            ->executeQuery();
+
+        $groups = [];
+        while ($row = $cursor->fetch()) {
+            $groups[] = $row['gid'];
+            $this->groupCache[$row['gid']] = [
+                'gid' => $row['gid'],
+                'displayname' => $row['displayname'],
+            ];
+        }
+        $cursor->closeCursor();
+
+        return $groups;
+    }
+
+    /**
+     * get a list of all groups
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array an array of group names
+     *
+     * Returns a list with all groups
+     */
+    public function getGroups(string $search = '', int $limit = -1, int $offset = 0) {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select('gid', 'displayname')
+            ->from('groups')
+            ->orderBy('gid', 'ASC');
+
+        if ($search !== '') {
+            $query->where($query->expr()->iLike('gid', $query->createNamedParameter(
+                '%' . $this->dbConn->escapeLikeParameter($search) . '%'
+            )));
+            $query->orWhere($query->expr()->iLike('displayname', $query->createNamedParameter(
+                '%' . $this->dbConn->escapeLikeParameter($search) . '%'
+            )));
+        }
+
+        if ($limit > 0) {
+            $query->setMaxResults($limit);
+        }
+        if ($offset > 0) {
+            $query->setFirstResult($offset);
+        }
+        $result = $query->executeQuery();
+
+        $groups = [];
+        while ($row = $result->fetch()) {
+            $this->groupCache[$row['gid']] = [
+                'displayname' => $row['displayname'],
+                'gid' => $row['gid'],
+            ];
+            $groups[] = $row['gid'];
+        }
+        $result->closeCursor();
+
+        return $groups;
+    }
+
+    /**
+     * check if a group exists
+     * @param string $gid
+     * @return bool
+     */
+    public function groupExists($gid) {
+        $this->fixDI();
+
+        // Check cache first
+        if (isset($this->groupCache[$gid])) {
+            return true;
+        }
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $cursor = $qb->select('gid', 'displayname')
+            ->from('groups')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->executeQuery();
+        $result = $cursor->fetch();
+        $cursor->closeCursor();
+
+        if ($result !== false) {
+            $this->groupCache[$gid] = [
+                'gid' => $gid,
+                'displayname' => $result['displayname'],
+            ];
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function groupsExists(array $gids): array {
+        $notFoundGids = [];
+        $existingGroups = [];
+
+        // In case the data is already locally accessible, not need to do SQL query
+        // or do a SQL query but with a smaller in clause
+        foreach ($gids as $gid) {
+            if (isset($this->groupCache[$gid])) {
+                $existingGroups[] = $gid;
+            } else {
+                $notFoundGids[] = $gid;
+            }
+        }
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $qb->select('gid', 'displayname')
+            ->from('groups')
+            ->where($qb->expr()->in('gid', $qb->createParameter('ids')));
+        foreach (array_chunk($notFoundGids, 1000) as $chunk) {
+            $qb->setParameter('ids', $chunk, IQueryBuilder::PARAM_STR_ARRAY);
+            $result = $qb->executeQuery();
+            while ($row = $result->fetch()) {
+                $this->groupCache[(string)$row['gid']] = [
+                    'displayname' => (string)$row['displayname'],
+                    'gid' => (string)$row['gid'],
+                ];
+                $existingGroups[] = (string)$row['gid'];
+            }
+            $result->closeCursor();
+        }
+
+        return $existingGroups;
+    }
+
+    /**
+     * Get a list of all users in a group
+     * @param string $gid
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array<int,string> an array of user ids
+     */
+    public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0): array {
+        return array_values(array_map(fn ($user) => $user->getUid(), $this->searchInGroup($gid, $search, $limit, $offset)));
+    }
+
+    public function searchInGroup(string $gid, string $search = '', int $limit = -1, int $offset = 0): array {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select('g.uid', 'dn.value AS displayname');
+
+        $query->from('group_user', 'g')
+            ->where($query->expr()->eq('gid', $query->createNamedParameter($gid)))
+            ->orderBy('g.uid', 'ASC');
+
+        // Join displayname and email from oc_accounts_data
+        $query->leftJoin('g', 'accounts_data', 'dn',
+            $query->expr()->andX(
+                $query->expr()->eq('dn.uid', 'g.uid'),
+                $query->expr()->eq('dn.name', $query->expr()->literal('displayname'))
+            )
+        );
+
+        $query->leftJoin('g', 'accounts_data', 'em',
+            $query->expr()->andX(
+                $query->expr()->eq('em.uid', 'g.uid'),
+                $query->expr()->eq('em.name', $query->expr()->literal('email'))
+            )
+        );
+
+        if ($search !== '') {
+            // sqlite doesn't like re-using a single named parameter here
+            $searchParam1 = $query->createNamedParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%');
+            $searchParam2 = $query->createNamedParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%');
+            $searchParam3 = $query->createNamedParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%');
+
+            $query->andWhere(
+                $query->expr()->orX(
+                    $query->expr()->ilike('g.uid', $searchParam1),
+                    $query->expr()->ilike('dn.value', $searchParam2),
+                    $query->expr()->ilike('em.value', $searchParam3)
+                )
+            )
+                ->orderBy('g.uid', 'ASC');
+        }
+
+
+        if ($limit !== -1) {
+            $query->setMaxResults($limit);
+        }
+        if ($offset !== 0) {
+            $query->setFirstResult($offset);
+        }
+
+        $result = $query->executeQuery();
+
+        $users = [];
+        $userManager = \OCP\Server::get(IUserManager::class);
+        while ($row = $result->fetch()) {
+            $users[$row['uid']] = new LazyUser($row['uid'], $userManager, $row['displayname'] ?? null);
+        }
+        $result->closeCursor();
+
+        return $users;
+    }
+
+    /**
+     * get the number of all users matching the search string in a group
+     * @param string $gid
+     * @param string $search
+     * @return int
+     */
+    public function countUsersInGroup(string $gid, string $search = ''): int {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select($query->func()->count('*', 'num_users'))
+            ->from('group_user')
+            ->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
+
+        if ($search !== '') {
+            $query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
+                '%' . $this->dbConn->escapeLikeParameter($search) . '%'
+            )));
+        }
+
+        $result = $query->executeQuery();
+        $count = $result->fetchOne();
+        $result->closeCursor();
+
+        if ($count !== false) {
+            $count = (int)$count;
+        } else {
+            $count = 0;
+        }
+
+        return $count;
+    }
+
+    /**
+     * get the number of disabled users in a group
+     *
+     * @param string $search
+     *
+     * @return int
+     */
+    public function countDisabledInGroup(string $gid): int {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select($query->createFunction('COUNT(DISTINCT ' . $query->getColumnName('uid') . ')'))
+            ->from('preferences', 'p')
+            ->innerJoin('p', 'group_user', 'g', $query->expr()->eq('p.userid', 'g.uid'))
+            ->where($query->expr()->eq('appid', $query->createNamedParameter('core')))
+            ->andWhere($query->expr()->eq('configkey', $query->createNamedParameter('enabled')))
+            ->andWhere($query->expr()->eq('configvalue', $query->createNamedParameter('false'), IQueryBuilder::PARAM_STR))
+            ->andWhere($query->expr()->eq('gid', $query->createNamedParameter($gid), IQueryBuilder::PARAM_STR));
+
+        $result = $query->executeQuery();
+        $count = $result->fetchOne();
+        $result->closeCursor();
+
+        if ($count !== false) {
+            $count = (int)$count;
+        } else {
+            $count = 0;
+        }
+
+        return $count;
+    }
+
+    public function getDisplayName(string $gid): string {
+        if (isset($this->groupCache[$gid])) {
+            $displayName = $this->groupCache[$gid]['displayname'];
+
+            if (isset($displayName) && trim($displayName) !== '') {
+                return $displayName;
+            }
+        }
+
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select('displayname')
+            ->from('groups')
+            ->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
+
+        $result = $query->executeQuery();
+        $displayName = $result->fetchOne();
+        $result->closeCursor();
+
+        return (string)$displayName;
+    }
+
+    public function getGroupDetails(string $gid): array {
+        $displayName = $this->getDisplayName($gid);
+        if ($displayName !== '') {
+            return ['displayName' => $displayName];
+        }
+
+        return [];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getGroupsDetails(array $gids): array {
+        $notFoundGids = [];
+        $details = [];
+
+        $this->fixDI();
+
+        // In case the data is already locally accessible, not need to do SQL query
+        // or do a SQL query but with a smaller in clause
+        foreach ($gids as $gid) {
+            if (isset($this->groupCache[$gid])) {
+                $details[$gid] = ['displayName' => $this->groupCache[$gid]['displayname']];
+            } else {
+                $notFoundGids[] = $gid;
+            }
+        }
+
+        foreach (array_chunk($notFoundGids, 1000) as $chunk) {
+            $query = $this->dbConn->getQueryBuilder();
+            $query->select('gid', 'displayname')
+                ->from('groups')
+                ->where($query->expr()->in('gid', $query->createNamedParameter($chunk, IQueryBuilder::PARAM_STR_ARRAY)));
+
+            $result = $query->executeQuery();
+            while ($row = $result->fetch()) {
+                $details[(string)$row['gid']] = ['displayName' => (string)$row['displayname']];
+                $this->groupCache[(string)$row['gid']] = [
+                    'displayname' => (string)$row['displayname'],
+                    'gid' => (string)$row['gid'],
+                ];
+            }
+            $result->closeCursor();
+        }
+
+        return $details;
+    }
+
+    public function setDisplayName(string $gid, string $displayName): bool {
+        if (!$this->groupExists($gid)) {
+            return false;
+        }
+
+        $this->fixDI();
+
+        $displayName = trim($displayName);
+        if ($displayName === '') {
+            $displayName = $gid;
+        }
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->update('groups')
+            ->set('displayname', $query->createNamedParameter($displayName))
+            ->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
+        $query->executeStatement();
+
+        return true;
+    }
+
+    /**
+     * Backend name to be shown in group management
+     * @return string the name of the backend to be shown
+     * @since 21.0.0
+     */
+    public function getBackendName(): string {
+        return 'Database';
+    }
+
+    /**
+     * Merge any white spaces to a single space in group name, then trim it.
+     */
+    private function sanitizeGroupName(string $displayName): string {
+        $cleanedDisplayName = preg_replace('/\s+/', ' ', $displayName);
+        return trim($cleanedDisplayName);
+    }
+
+    /**
+     * Compute group ID from display name (GIDs are limited to 64 characters in database)
+     */
+    private function computeGid(string $displayName): string {
+        $displayNameWithoutWhitespace = preg_replace('/\s+/', '_', $displayName);
+        return mb_strlen($displayNameWithoutWhitespace) > 64
+            ? hash('sha256', $displayNameWithoutWhitespace)
+            : $displayNameWithoutWhitespace;
+    }
 }

tests/lib/Group/DatabaseTest.php

Indentation +55 added lines, -55 removed lines

@@ -15,59 +15,59 @@
  */
 #[\PHPUnit\Framework\Attributes\Group('DB')]
 class DatabaseTest extends Backend {
-	private $groups = [];
-
-	/**
-	 * get a new unique group name
-	 * test cases can override this in order to clean up created groups
-	 */
-	public function getGroupName($name = null): string {
-		$name = parent::getGroupName($name);
-		$this->groups[] = $name;
-		return $name;
-	}
-
-	protected function setUp(): void {
-		parent::setUp();
-		$this->backend = new Database();
-	}
-
-	protected function tearDown(): void {
-		foreach ($this->groups as $group) {
-			$this->backend->deleteGroup($group);
-		}
-		parent::tearDown();
-	}
-
-	public function testAddDoubleNoCache(): void {
-		$group = $this->getGroupName();
-
-		$this->backend->createGroup($group);
-
-		$backend = new Database();
-		$this->assertNull($backend->createGroup($group));
-	}
-
-	public function testAddLongGroupName(): void {
-		$groupName = $this->getUniqueID('test_', 100);
-
-		$gidCreated = $this->backend->createGroup($groupName);
-		$this->assertEquals(64, strlen($gidCreated));
-
-		$group = $this->backend->getGroupDetails($gidCreated);
-		$this->assertEquals(['displayName' => $groupName], $group);
-	}
-
-	public function testWhiteSpaceInGroupName(): void {
-		$randomId = $this->getUniqueID('test_', 10);
-		$groupName = " 	group  name	with  	weird spaces \n" . $randomId;
-		$expectedGroupName = 'group name with weird spaces ' . $randomId;
-		$expectedGroupId = 'group_name_with_weird_spaces_' . $randomId;
-
-		$gidCreated = $this->backend->createGroup($groupName);
-		$this->assertEquals($expectedGroupId, $gidCreated);
-
-		$group = $this->backend->getGroupDetails($gidCreated);
-		$this->assertEquals(['displayName' => $expectedGroupName], $group);
-	}
+    private $groups = [];
+
+    /**
+     * get a new unique group name
+     * test cases can override this in order to clean up created groups
+     */
+    public function getGroupName($name = null): string {
+        $name = parent::getGroupName($name);
+        $this->groups[] = $name;
+        return $name;
+    }
+
+    protected function setUp(): void {
+        parent::setUp();
+        $this->backend = new Database();
+    }
+
+    protected function tearDown(): void {
+        foreach ($this->groups as $group) {
+            $this->backend->deleteGroup($group);
+        }
+        parent::tearDown();
+    }
+
+    public function testAddDoubleNoCache(): void {
+        $group = $this->getGroupName();
+
+        $this->backend->createGroup($group);
+
+        $backend = new Database();
+        $this->assertNull($backend->createGroup($group));
+    }
+
+    public function testAddLongGroupName(): void {
+        $groupName = $this->getUniqueID('test_', 100);
+
+        $gidCreated = $this->backend->createGroup($groupName);
+        $this->assertEquals(64, strlen($gidCreated));
+
+        $group = $this->backend->getGroupDetails($gidCreated);
+        $this->assertEquals(['displayName' => $groupName], $group);
+    }
+
+    public function testWhiteSpaceInGroupName(): void {
+        $randomId = $this->getUniqueID('test_', 10);
+        $groupName = " 	group  name	with  	weird spaces \n" . $randomId;
+        $expectedGroupName = 'group name with weird spaces ' . $randomId;
+        $expectedGroupId = 'group_name_with_weird_spaces_' . $randomId;
+
+        $gidCreated = $this->backend->createGroup($groupName);
+        $this->assertEquals($expectedGroupId, $gidCreated);
+
+        $group = $this->backend->getGroupDetails($gidCreated);
+        $this->assertEquals(['displayName' => $expectedGroupName], $group);
+    }
 }

Spacing +3 added lines, -3 removed lines

@@ -60,9 +60,9 @@
 
 	public function testWhiteSpaceInGroupName(): void {
 		$randomId = $this->getUniqueID('test_', 10);
-		$groupName = " 	group  name	with  	weird spaces \n" . $randomId;
-		$expectedGroupName = 'group name with weird spaces ' . $randomId;
-		$expectedGroupId = 'group_name_with_weird_spaces_' . $randomId;
+		$groupName = " 	group  name	with  	weird spaces \n".$randomId;
+		$expectedGroupName = 'group name with weird spaces '.$randomId;
+		$expectedGroupId = 'group_name_with_weird_spaces_'.$randomId;
 
 		$gidCreated = $this->backend->createGroup($groupName);
 		$this->assertEquals($expectedGroupId, $gidCreated);