244 lines
7.0 KiB
PHP
244 lines
7.0 KiB
PHP
<?php
|
|
/**
|
|
* @author Arthur Schiwon <blizzz@owncloud.com>
|
|
* @author Bart Visscher <bartv@thisnet.nl>
|
|
* @author Jakob Sack <mail@jakobsack.de>
|
|
* @author Joas Schilling <nickvergessen@owncloud.com>
|
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
|
|
* @author Michael Gapczynski <GapczynskiM@gmail.com>
|
|
* @author michag86 <micha_g@arcor.de>
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
* @author Robin Appelman <icewind@owncloud.com>
|
|
* @author Robin McCorkell <rmccorkell@karoshi.org.uk>
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
|
*
|
|
* @copyright Copyright (c) 2015, ownCloud, Inc.
|
|
* @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;
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* Class for group management in a SQL Database (e.g. MySQL, SQLite)
|
|
*/
|
|
class OC_Group_Database extends OC_Group_Backend {
|
|
|
|
/**
|
|
* 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 ) {
|
|
// Check for existence
|
|
$stmt = OC_DB::prepare( "SELECT `gid` FROM `*PREFIX*groups` WHERE `gid` = ?" );
|
|
$result = $stmt->execute( array( $gid ));
|
|
|
|
if( $result->fetchRow() ) {
|
|
// Can not add an existing group
|
|
return false;
|
|
}
|
|
else{
|
|
// Add group and exit
|
|
$stmt = OC_DB::prepare( "INSERT INTO `*PREFIX*groups` ( `gid` ) VALUES( ? )" );
|
|
$result = $stmt->execute( array( $gid ));
|
|
|
|
return $result ? true : false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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 ) {
|
|
// Delete the group
|
|
$stmt = OC_DB::prepare( "DELETE FROM `*PREFIX*groups` WHERE `gid` = ?" );
|
|
$stmt->execute( array( $gid ));
|
|
|
|
// Delete the group-user relation
|
|
$stmt = OC_DB::prepare( "DELETE FROM `*PREFIX*group_user` WHERE `gid` = ?" );
|
|
$stmt->execute( array( $gid ));
|
|
|
|
// Delete the group-groupadmin relation
|
|
$stmt = OC_DB::prepare( "DELETE FROM `*PREFIX*group_admin` WHERE `gid` = ?" );
|
|
$stmt->execute( array( $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 ) {
|
|
// check
|
|
$stmt = OC_DB::prepare( "SELECT `uid` FROM `*PREFIX*group_user` WHERE `gid` = ? AND `uid` = ?" );
|
|
$result = $stmt->execute( array( $gid, $uid ));
|
|
|
|
return $result->fetchRow() ? 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 ) {
|
|
// No duplicate entries!
|
|
if( !$this->inGroup( $uid, $gid )) {
|
|
$stmt = OC_DB::prepare( "INSERT INTO `*PREFIX*group_user` ( `uid`, `gid` ) VALUES( ?, ? )" );
|
|
$stmt->execute( array( $uid, $gid ));
|
|
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 ) {
|
|
$stmt = OC_DB::prepare( "DELETE FROM `*PREFIX*group_user` WHERE `uid` = ? AND `gid` = ?" );
|
|
$stmt->execute( array( $uid, $gid ));
|
|
|
|
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 ) {
|
|
// No magic!
|
|
$stmt = OC_DB::prepare( "SELECT `gid` FROM `*PREFIX*group_user` WHERE `uid` = ?" );
|
|
$result = $stmt->execute( array( $uid ));
|
|
|
|
$groups = array();
|
|
while( $row = $result->fetchRow()) {
|
|
$groups[] = $row["gid"];
|
|
}
|
|
|
|
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) {
|
|
$stmt = OC_DB::prepare('SELECT `gid` FROM `*PREFIX*groups` WHERE LOWER(`gid`) LIKE LOWER(?) ORDER BY `gid` ASC', $limit, $offset);
|
|
$result = $stmt->execute(array('%' . $search . '%'));
|
|
$groups = array();
|
|
while ($row = $result->fetchRow()) {
|
|
$groups[] = $row['gid'];
|
|
}
|
|
return $groups;
|
|
}
|
|
|
|
/**
|
|
* check if a group exists
|
|
* @param string $gid
|
|
* @return bool
|
|
*/
|
|
public function groupExists($gid) {
|
|
$query = OC_DB::prepare('SELECT `gid` FROM `*PREFIX*groups` WHERE `gid` = ?');
|
|
$result = $query->execute(array($gid))->fetchOne();
|
|
if ($result !== false) {
|
|
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) {
|
|
$stmt = OC_DB::prepare('SELECT `uid` FROM `*PREFIX*group_user` WHERE `gid` = ? AND `uid` LIKE ? ORDER BY `uid` ASC',
|
|
$limit,
|
|
$offset);
|
|
$result = $stmt->execute(array($gid, '%'.$search.'%'));
|
|
$users = array();
|
|
while ($row = $result->fetchRow()) {
|
|
$users[] = $row['uid'];
|
|
}
|
|
return $users;
|
|
}
|
|
|
|
/**
|
|
* get the number of all users matching the search string in a group
|
|
* @param string $gid
|
|
* @param string $search
|
|
* @return int|false
|
|
* @throws \OC\DatabaseException
|
|
*/
|
|
public function countUsersInGroup($gid, $search = '') {
|
|
$stmt = OC_DB::prepare('SELECT COUNT(`uid`) AS `count` FROM `*PREFIX*group_user` WHERE `gid` = ? AND `uid` LIKE ?');
|
|
$result = $stmt->execute(array($gid, '%' . $search . '%'));
|
|
$count = $result->fetchOne();
|
|
if($count !== false) {
|
|
$count = intval($count);
|
|
}
|
|
return $count;
|
|
}
|
|
|
|
}
|