Database::getGroups() - Code Metrics - Inspection of "Merge pull request #8780 from nextcloud/bugfix/noi..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 41215c...709589 )

by Joas

created 2018-03-27 14:10 UTC

Database::getGroups() B

↳ Parent: Database

Complexity

Conditions	3
Paths	4

Size

Total Lines	26
Code Lines	17

Duplication

Lines	5
Ratio	19.23 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	3
eloc	17
c	2
b	0
f	0
nc	4
nop	3
dl	5
loc	26
rs	8.8571

<?php
/**
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 *
 * @author Aaron Wood <[email protected]>
 * @author Loki3000 <[email protected]>
 * @author Roeland Jago Douma <[email protected]>
 *
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */
/*
 *
 * The following SQL statement is just a help for developers and will not be
 * executed!
 *
 * CREATE TABLE `groups` (
 *   `gid` varchar(64) COLLATE utf8_unicode_ci NOT NULL,
 *   PRIMARY KEY (`gid`)
 * ) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
 *
 * CREATE TABLE `group_user` (
 *   `gid` varchar(64) COLLATE utf8_unicode_ci NOT NULL,
 *   `uid` varchar(64) COLLATE utf8_unicode_ci NOT NULL
 * ) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
 *
 */

namespace OC\Group;

use OCP\IDBConnection;

/**
 * Class for group management in a SQL Database (e.g. MySQL, SQLite)
 */
class Database extends Backend {

	/** @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( $gid ) {
		$this->fixDI();

		// Add group
		$result = $this->dbConn->insertIfNotExist('*PREFIX*groups', [
			'gid' => $gid,
		]);

		// 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( $gid ) {
		$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( $uid, $gid ) {
		$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( $uid, $gid ) {
		$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|false
	 */
	public function countUsersInGroup($gid, $search = '') {
		$this->fixDI();

		$query = $this->dbConn->getQueryBuilder();
		$query->selectAlias($query->createFunction('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;
		}
		return $count;
	}

}


1		<?php
2		/**
3		* @copyright Copyright (c) 2016, ownCloud, Inc.
4		*
5		* @author Aaron Wood <[email protected]>
6		* @author Loki3000 <[email protected]>
7		* @author Roeland Jago Douma <[email protected]>
8		*
9		* @license AGPL-3.0
10		*
11		* This code is free software: you can redistribute it and/or modify
12		* it under the terms of the GNU Affero General Public License, version 3,
13		* as published by the Free Software Foundation.
14		*
15		* This program is distributed in the hope that it will be useful,
16		* but WITHOUT ANY WARRANTY; without even the implied warranty of
17		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18		* GNU Affero General Public License for more details.
19		*
20		* You should have received a copy of the GNU Affero General Public License, version 3,
21		* along with this program. If not, see <http://www.gnu.org/licenses/>
22		*
23		*/
24		/*
25		*
26		* The following SQL statement is just a help for developers and will not be
27		* executed!
28		*
29		* CREATE TABLE `groups` (
30		* `gid` varchar(64) COLLATE utf8_unicode_ci NOT NULL,
31		* PRIMARY KEY (`gid`)
32		* ) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
33		*
34		* CREATE TABLE `group_user` (
35		* `gid` varchar(64) COLLATE utf8_unicode_ci NOT NULL,
36		* `uid` varchar(64) COLLATE utf8_unicode_ci NOT NULL
37		* ) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
38		*
39		*/
40
41		namespace OC\Group;
42
43		use OCP\IDBConnection;
44
45		/**
46		* Class for group management in a SQL Database (e.g. MySQL, SQLite)
47		*/
48		class Database extends Backend {
49
50		/** @var string[] */
51		private $groupCache = [];
52
53		/** @var IDBConnection */
54		private $dbConn;
55
56		/**
57		* \OC\Group\Database constructor.
58		*
59		* @param IDBConnection\|null $dbConn
60		*/
61		public function __construct(IDBConnection $dbConn = null) {
62		$this->dbConn = $dbConn;
63		}
64
65		/**
66		* FIXME: This function should not be required!
67		*/
68		private function fixDI() {
69		if ($this->dbConn === null) {
70		$this->dbConn = \OC::$server->getDatabaseConnection();
71		}
72		}
73
74		/**
75		* Try to create a new group
76		* @param string $gid The name of the group to create
77		* @return bool
78		*
79		* Tries to create a new group. If the group name already exists, false will
80		* be returned.
81		*/
82		public function createGroup( $gid ) {
83		$this->fixDI();
84
85		// Add group
86		$result = $this->dbConn->insertIfNotExist('PREFIXgroups', [
87		'gid' => $gid,
88		]);
89
90		// Add to cache
91		$this->groupCache[$gid] = $gid;
92
93		return $result === 1;
94		}
95
96		/**
97		* delete a group
98		* @param string $gid gid of the group to delete
99		* @return bool
100		*
101		* Deletes a group and removes it from the group_user-table
102		*/
103		public function deleteGroup( $gid ) {
104		$this->fixDI();
105
106		// Delete the group
107		$qb = $this->dbConn->getQueryBuilder();
108		$qb->delete('groups')
109		->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
110		->execute();
111
112		// Delete the group-user relation
113		$qb = $this->dbConn->getQueryBuilder();
114		$qb->delete('group_user')
115		->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
116		->execute();
117
118		// Delete the group-groupadmin relation
119		$qb = $this->dbConn->getQueryBuilder();
120		$qb->delete('group_admin')
121		->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
122		->execute();
123
124		// Delete from cache
125		unset($this->groupCache[$gid]);
126
127		return true;
128		}
129
130		/**
131		* is user in group?
132		* @param string $uid uid of the user
133		* @param string $gid gid of the group
134		* @return bool
135		*
136		* Checks whether the user is member of a group or not.
137		*/
138	View Code Duplication	public function inGroup( $uid, $gid ) {
139		$this->fixDI();
140
141		// check
142		$qb = $this->dbConn->getQueryBuilder();
143		$cursor = $qb->select('uid')
144		->from('group_user')
145		->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
146		->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
147		->execute();
148
149		$result = $cursor->fetch();
150		$cursor->closeCursor();
151
152		return $result ? true : false;
153		}
154
155		/**
156		* Add a user to a group
157		* @param string $uid Name of the user to add to group
158		* @param string $gid Name of the group in which add the user
159		* @return bool
160		*
161		* Adds a user to a group.
162		*/
163		public function addToGroup( $uid, $gid ) {
164		$this->fixDI();
165
166		// No duplicate entries!
167		if( !$this->inGroup( $uid, $gid )) {
168		$qb = $this->dbConn->getQueryBuilder();
169		$qb->insert('group_user')
170		->setValue('uid', $qb->createNamedParameter($uid))
171		->setValue('gid', $qb->createNamedParameter($gid))
172		->execute();
173		return true;
174		}else{
175		return false;
176		}
177		}
178
179		/**
180		* Removes a user from a group
181		* @param string $uid Name of the user to remove from group
182		* @param string $gid Name of the group from which remove the user
183		* @return bool
184		*
185		* removes the user from a group.
186		*/
187		public function removeFromGroup( $uid, $gid ) {
188		$this->fixDI();
189
190		$qb = $this->dbConn->getQueryBuilder();
191		$qb->delete('group_user')
192		->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
193		->andWhere($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
194		->execute();
195
196		return true;
197		}
198
199		/**
200		* Get all groups a user belongs to
201		* @param string $uid Name of the user
202		* @return array an array of group names
203		*
204		* This function fetches all groups a user belongs to. It does not check
205		* if the user exists at all.
206		*/
207		public function getUserGroups( $uid ) {
208		//guests has empty or null $uid
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-21 00:52 UTC by Report Bug Copy Issue Report `37%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
209		if ($uid === null \|\| $uid === '') {
210		return [];
211		}
212
213		$this->fixDI();
214
215		// No magic!
216		$qb = $this->dbConn->getQueryBuilder();
217		$cursor = $qb->select('gid')
218		->from('group_user')
219		->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
220		->execute();
221
222		$groups = [];
223		while( $row = $cursor->fetch()) {
224		$groups[] = $row['gid'];
225		$this->groupCache[$row['gid']] = $row['gid'];
226		}
227		$cursor->closeCursor();
228
229		return $groups;
230		}
231
232		/**
233		* get a list of all groups
234		* @param string $search
235		* @param int $limit
236		* @param int $offset
237		* @return array an array of group names
238		*
239		* Returns a list with all groups
240		*/
241		public function getGroups($search = '', $limit = null, $offset = null) {
242		$this->fixDI();
243
244		$query = $this->dbConn->getQueryBuilder();
245		$query->select('gid')
246		->from('groups')
247		->orderBy('gid', 'ASC');
248
249	View Code Duplication	if ($search !== '') {
250		$query->where($query->expr()->iLike('gid', $query->createNamedParameter(
251		'%' . $this->dbConn->escapeLikeParameter($search) . '%'
252		)));
253		}
254
255		$query->setMaxResults($limit)
256		->setFirstResult($offset);
257		$result = $query->execute();
258
259		$groups = [];
260		while ($row = $result->fetch()) {
261		$groups[] = $row['gid'];
262		}
263		$result->closeCursor();
264
265		return $groups;
266		}
267
268		/**
269		* check if a group exists
270		* @param string $gid
271		* @return bool
272		*/
273		public function groupExists($gid) {
274		$this->fixDI();
275
276		// Check cache first
277		if (isset($this->groupCache[$gid])) {
278		return true;
279		}
280
281		$qb = $this->dbConn->getQueryBuilder();
282		$cursor = $qb->select('gid')
283		->from('groups')
284		->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
285		->execute();
286		$result = $cursor->fetch();
287		$cursor->closeCursor();
288
289		if ($result !== false) {
290		$this->groupCache[$gid] = $gid;
291		return true;
292		}
293		return false;
294		}
295
296		/**
297		* get a list of all users in a group
298		* @param string $gid
299		* @param string $search
300		* @param int $limit
301		* @param int $offset
302		* @return array an array of user ids
303		*/
304		public function usersInGroup($gid, $search = '', $limit = null, $offset = null) {
305		$this->fixDI();
306
307		$query = $this->dbConn->getQueryBuilder();
308		$query->select('uid')
309		->from('group_user')
310		->where($query->expr()->eq('gid', $query->createNamedParameter($gid)))
311		->orderBy('uid', 'ASC');
312
313	View Code Duplication	if ($search !== '') {
314		$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
315		'%' . $this->dbConn->escapeLikeParameter($search) . '%'
316		)));
317		}
318
319		$query->setMaxResults($limit)
320		->setFirstResult($offset);
321		$result = $query->execute();
322
323		$users = [];
324		while ($row = $result->fetch()) {
325		$users[] = $row['uid'];
326		}
327		$result->closeCursor();
328
329		return $users;
330		}
331
332		/**
333		* get the number of all users matching the search string in a group
334		* @param string $gid
335		* @param string $search
336		* @return int\|false
337		*/
338		public function countUsersInGroup($gid, $search = '') {
339		$this->fixDI();
340
341		$query = $this->dbConn->getQueryBuilder();
342		$query->selectAlias($query->createFunction('COUNT(*)'), 'num_users')
343		->from('group_user')
344		->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
345
346	View Code Duplication	if ($search !== '') {
347		$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
348		'%' . $this->dbConn->escapeLikeParameter($search) . '%'
349		)));
350		}
351
352		$result = $query->execute();
353		$count = $result->fetchColumn();
354		$result->closeCursor();
355
356		if ($count !== false) {
357		$count = (int)$count;
358		}
359		return $count;
360		}
361
362		}
363

nextcloud / server

Push — master ( 41215c...709589 )

Database::getGroups() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like