nextcloud / server

lib/private/Group/Database.php

Indentation +354 added lines, -354 removed lines

@@ -56,362 +56,362 @@
  * Class for group management in a SQL Database (e.g. MySQL, SQLite)
  */
 class Database extends ABackend
-	implements IAddToGroupBackend,
-	           ICountDisabledInGroup,
-	           ICountUsersBackend,
-	           ICreateGroupBackend,
-	           IDeleteGroupBackend,
-	           IRemoveFromGroupBackend {
-
-	/** @var string[] */
-	private $groupCache = [];
-
-	/** @var IDBConnection */
-	private $dbConn;
-
-	/**
-	 * \OC\Group\Database constructor.
-	 *
-	 * @param IDBConnection|null $dbConn
-	 */
-	public function __construct(IDBConnection $dbConn = null) {
-		$this->dbConn = $dbConn;
-	}
-
-	/**
-	 * FIXME: This function should not be required!
-	 */
-	private function fixDI() {
-		if ($this->dbConn === null) {
-			$this->dbConn = \OC::$server->getDatabaseConnection();
-		}
-	}
-
-	/**
-	 * Try to create a new group
-	 * @param string $gid The name of the group to create
-	 * @return bool
-	 *
-	 * Tries to create a new group. If the group name already exists, false will
-	 * be returned.
-	 */
-	public function createGroup(string $gid): bool {
-		$this->fixDI();
-
-		try {
-			// Add group
-			$builder = $this->dbConn->getQueryBuilder();
-			$result = $builder->insert('groups')
-				->setValue('gid', $builder->createNamedParameter($gid))
-				->execute();
-		} catch(UniqueConstraintViolationException $e) {
-			$result = 0;
-		}
-
-		// Add to cache
-		$this->groupCache[$gid] = $gid;
-
-		return $result === 1;
-	}
-
-	/**
-	 * 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)))
-			->execute();
-
-		// Delete the group-user relation
-		$qb = $this->dbConn->getQueryBuilder();
-		$qb->delete('group_user')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->execute();
-
-		// Delete the group-groupadmin relation
-		$qb = $this->dbConn->getQueryBuilder();
-		$qb->delete('group_admin')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->execute();
-
-		// 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)))
-			->execute();
-
-		$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))
-				->execute();
-			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)))
-			->execute();
-
-		return true;
-	}
-
-	/**
-	 * Get all groups a user belongs to
-	 * @param string $uid Name of the user
-	 * @return array 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('gid')
-			->from('group_user')
-			->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
-			->execute();
-
-		$groups = [];
-		while( $row = $cursor->fetch()) {
-			$groups[] = $row['gid'];
-			$this->groupCache[$row['gid']] = $row['gid'];
-		}
-		$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($search = '', $limit = null, $offset = null) {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select('gid')
-			->from('groups')
-			->orderBy('gid', 'ASC');
-
-		if ($search !== '') {
-			$query->where($query->expr()->iLike('gid', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
-			)));
-		}
-
-		$query->setMaxResults($limit)
-			->setFirstResult($offset);
-		$result = $query->execute();
-
-		$groups = [];
-		while ($row = $result->fetch()) {
-			$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')
-			->from('groups')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->execute();
-		$result = $cursor->fetch();
-		$cursor->closeCursor();
-
-		if ($result !== false) {
-			$this->groupCache[$gid] = $gid;
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * get a list of all users in a group
-	 * @param string $gid
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array an array of user ids
-	 */
-	public function usersInGroup($gid, $search = '', $limit = null, $offset = null) {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select('uid')
-			->from('group_user')
-			->where($query->expr()->eq('gid', $query->createNamedParameter($gid)))
-			->orderBy('uid', 'ASC');
-
-		if ($search !== '') {
-			$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
-			)));
-		}
-
-		$query->setMaxResults($limit)
-			->setFirstResult($offset);
-		$result = $query->execute();
-
-		$users = [];
-		while ($row = $result->fetch()) {
-			$users[] = $row['uid'];
-		}
-		$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->execute();
-		$count = $result->fetchColumn();
-		$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|bool
-	 */
-	public function countDisabledInGroup(string $gid): int {
-		$this->fixDI();
+    implements IAddToGroupBackend,
+                ICountDisabledInGroup,
+                ICountUsersBackend,
+                ICreateGroupBackend,
+                IDeleteGroupBackend,
+                IRemoveFromGroupBackend {
+
+    /** @var string[] */
+    private $groupCache = [];
+
+    /** @var IDBConnection */
+    private $dbConn;
+
+    /**
+     * \OC\Group\Database constructor.
+     *
+     * @param IDBConnection|null $dbConn
+     */
+    public function __construct(IDBConnection $dbConn = null) {
+        $this->dbConn = $dbConn;
+    }
+
+    /**
+     * FIXME: This function should not be required!
+     */
+    private function fixDI() {
+        if ($this->dbConn === null) {
+            $this->dbConn = \OC::$server->getDatabaseConnection();
+        }
+    }
+
+    /**
+     * Try to create a new group
+     * @param string $gid The name of the group to create
+     * @return bool
+     *
+     * Tries to create a new group. If the group name already exists, false will
+     * be returned.
+     */
+    public function createGroup(string $gid): bool {
+        $this->fixDI();
+
+        try {
+            // Add group
+            $builder = $this->dbConn->getQueryBuilder();
+            $result = $builder->insert('groups')
+                ->setValue('gid', $builder->createNamedParameter($gid))
+                ->execute();
+        } catch(UniqueConstraintViolationException $e) {
+            $result = 0;
+        }
+
+        // Add to cache
+        $this->groupCache[$gid] = $gid;
+
+        return $result === 1;
+    }
+
+    /**
+     * 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)))
+            ->execute();
+
+        // Delete the group-user relation
+        $qb = $this->dbConn->getQueryBuilder();
+        $qb->delete('group_user')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->execute();
+
+        // Delete the group-groupadmin relation
+        $qb = $this->dbConn->getQueryBuilder();
+        $qb->delete('group_admin')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->execute();
+
+        // 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)))
+            ->execute();
+
+        $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))
+                ->execute();
+            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)))
+            ->execute();
+
+        return true;
+    }
+
+    /**
+     * Get all groups a user belongs to
+     * @param string $uid Name of the user
+     * @return array 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('gid')
+            ->from('group_user')
+            ->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
+            ->execute();
+
+        $groups = [];
+        while( $row = $cursor->fetch()) {
+            $groups[] = $row['gid'];
+            $this->groupCache[$row['gid']] = $row['gid'];
+        }
+        $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($search = '', $limit = null, $offset = null) {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select('gid')
+            ->from('groups')
+            ->orderBy('gid', 'ASC');
+
+        if ($search !== '') {
+            $query->where($query->expr()->iLike('gid', $query->createNamedParameter(
+                '%' . $this->dbConn->escapeLikeParameter($search) . '%'
+            )));
+        }
+
+        $query->setMaxResults($limit)
+            ->setFirstResult($offset);
+        $result = $query->execute();
+
+        $groups = [];
+        while ($row = $result->fetch()) {
+            $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')
+            ->from('groups')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->execute();
+        $result = $cursor->fetch();
+        $cursor->closeCursor();
+
+        if ($result !== false) {
+            $this->groupCache[$gid] = $gid;
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * get a list of all users in a group
+     * @param string $gid
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array an array of user ids
+     */
+    public function usersInGroup($gid, $search = '', $limit = null, $offset = null) {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select('uid')
+            ->from('group_user')
+            ->where($query->expr()->eq('gid', $query->createNamedParameter($gid)))
+            ->orderBy('uid', 'ASC');
+
+        if ($search !== '') {
+            $query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
+                '%' . $this->dbConn->escapeLikeParameter($search) . '%'
+            )));
+        }
+
+        $query->setMaxResults($limit)
+            ->setFirstResult($offset);
+        $result = $query->execute();
+
+        $users = [];
+        while ($row = $result->fetch()) {
+            $users[] = $row['uid'];
+        }
+        $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->execute();
+        $count = $result->fetchColumn();
+        $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|bool
+     */
+    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));
+        $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->execute();
-		$count = $result->fetchColumn();
-		$result->closeCursor();
+        $result = $query->execute();
+        $count = $result->fetchColumn();
+        $result->closeCursor();
 		
-		if ($count !== false) {
-			$count = (int)$count;
-		} else {
-			$count = 0;
-		}
-
-		return $count;
-	}
+        if ($count !== false) {
+            $count = (int)$count;
+        } else {
+            $count = 0;
+        }
+
+        return $count;
+    }
 
 }

Spacing +12 added lines, -12 removed lines

@@ -104,7 +104,7 @@ 
 			$result = $builder->insert('groups')
 				->setValue('gid', $builder->createNamedParameter($gid))
 				->execute();
-		} catch(UniqueConstraintViolationException $e) {
+		} catch (UniqueConstraintViolationException $e) {
 			$result = 0;
 		}
 
@@ -156,7 +156,7 @@ 
 	 *
 	 * Checks whether the user is member of a group or not.
 	 */
-	public function inGroup( $uid, $gid ) {
+	public function inGroup($uid, $gid) {
 		$this->fixDI();
 
 		// check
@@ -185,14 +185,14 @@ 
 		$this->fixDI();
 
 		// No duplicate entries!
-		if( !$this->inGroup( $uid, $gid )) {
+		if (!$this->inGroup($uid, $gid)) {
 			$qb = $this->dbConn->getQueryBuilder();
 			$qb->insert('group_user')
 				->setValue('uid', $qb->createNamedParameter($uid))
 				->setValue('gid', $qb->createNamedParameter($gid))
 				->execute();
 			return true;
-		}else{
+		} else {
 			return false;
 		}
 	}
@@ -225,7 +225,7 @@ 
 	 * This function fetches all groups a user belongs to. It does not check
 	 * if the user exists at all.
 	 */
-	public function getUserGroups( $uid ) {
+	public function getUserGroups($uid) {
 		//guests has empty or null $uid
 		if ($uid === null || $uid === '') {
 			return [];
@@ -241,7 +241,7 @@ 
 			->execute();
 
 		$groups = [];
-		while( $row = $cursor->fetch()) {
+		while ($row = $cursor->fetch()) {
 			$groups[] = $row['gid'];
 			$this->groupCache[$row['gid']] = $row['gid'];
 		}
@@ -269,7 +269,7 @@ 
 
 		if ($search !== '') {
 			$query->where($query->expr()->iLike('gid', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
+				'%'.$this->dbConn->escapeLikeParameter($search).'%'
 			)));
 		}
 
@@ -333,7 +333,7 @@ 
 
 		if ($search !== '') {
 			$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
+				'%'.$this->dbConn->escapeLikeParameter($search).'%'
 			)));
 		}
 
@@ -366,7 +366,7 @@ 
 
 		if ($search !== '') {
 			$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
+				'%'.$this->dbConn->escapeLikeParameter($search).'%'
 			)));
 		}
 
@@ -375,7 +375,7 @@ 
 		$result->closeCursor();
 
 		if ($count !== false) {
-			$count = (int)$count;
+			$count = (int) $count;
 		} else {
 			$count = 0;
 		}
@@ -393,7 +393,7 @@ 
 		$this->fixDI();
 		
 		$query = $this->dbConn->getQueryBuilder();
-		$query->select($query->createFunction('COUNT(DISTINCT ' . $query->getColumnName('uid') . ')'))
+		$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')))
@@ -406,7 +406,7 @@ 
 		$result->closeCursor();
 		
 		if ($count !== false) {
-			$count = (int)$count;
+			$count = (int) $count;
 		} else {
 			$count = 0;
 		}