lib/private/Group/Group.php
<?php
/**
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
* @author Bart Visscher <bartv@thisnet.nl>
* @author Lukas Reschke <lukas@statuscode.ch>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <icewind@owncloud.com>
* @author Robin McCorkell <robin@mccorkell.me.uk>
* @author Roeland Jago Douma <rullzer@owncloud.com>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Vincent Petry <pvince81@owncloud.com>
*
* @copyright Copyright (c) 2018, ownCloud GmbH
* @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/>
*
*/
namespace OC\Group;
use OCP\IGroup;
use OCP\IUser;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\GenericEvent;
class Group implements IGroup {
/**
* @var string $id
*/
private $gid;
/**
* @var \OC\User\User[] $users
*/
private $users = [];
/**
* @var bool $usersLoaded
*/
private $usersLoaded;
/**
* @var \OC\Group\Backend[]|\OC\Group\Database[] $backend
*/
private $backends;
/**
* @var \OC\Hooks\PublicEmitter $emitter
*/
private $emitter;
/**
* @var \OC\User\Manager $userManager
*/
private $userManager;
/** @var EventDispatcherInterface */
private $eventDispatcher;
/** @var null|string */
private $displayName;
/**
* @param string $gid
* @param \OC\Group\Backend[] $backends
* @param \OC\User\Manager $userManager
* @param \OC\Hooks\PublicEmitter $emitter
* @param string $displayName
*/
public function __construct($gid, $backends, $userManager, EventDispatcherInterface $eventDispatcher, $emitter = null, $displayName = null) {
$this->gid = $gid;
$this->backends = $backends;
$this->userManager = $userManager;
$this->eventDispatcher = $eventDispatcher;
$this->emitter = $emitter;
$this->displayName = $displayName;
}
public function getGID() {
return $this->gid;
}
public function getDisplayName() {
if ($this->displayName === null) {
return $this->gid;
}
return $this->displayName;
}
/**
* get all users in the group
*
* @return \OC\User\User[]
*/
public function getUsers() {
if ($this->usersLoaded) {
return $this->users;
}
$userIds = [];
foreach ($this->backends as $backend) {
$diff = \array_diff(
$backend->usersInGroup($this->gid),
$userIds
);
if ($diff) {
$userIds = \array_merge($userIds, $diff);
}
}
$this->users = $this->getVerifiedUsers($userIds);
$this->usersLoaded = true;
return $this->users;
}
/**
* check if a user is in the group
*
* @param IUser $user
* @return bool
*/
public function inGroup($user) {
if (isset($this->users[$user->getUID()])) {
return true;
}
foreach ($this->backends as $backend) {
if ($backend->inGroup($user->getUID(), $this->gid)) {
$this->users[$user->getUID()] = $user;
return true;
}
}
return false;
}
/**
* add a user to the group
*
* @param \OC\User\User $user
*/
public function addUser($user) {
if ($this->inGroup($user)) {
return;
}
if ($this->emitter) {
$this->emitter->emit('\OC\Group', 'preAddUser', [$this, $user]);
}
$this->eventDispatcher->dispatch(new GenericEvent($this, ['user' => $user]), 'group.preAddUser');
foreach ($this->backends as $backend) {
if ($backend->implementsActions(\OC\Group\Backend::ADD_TO_GROUP)) {
$backend->addToGroup($user->getUID(), $this->gid);
if ($this->users) {
$this->users[$user->getUID()] = $user;
}
if ($this->emitter) {
$this->emitter->emit('\OC\Group', 'postAddUser', [$this, $user]);
}
$this->eventDispatcher->dispatch(new GenericEvent($this, ['user' => $user]), 'group.postAddUser');
return;
}
}
}
/**
* remove a user from the group
*
* @param \OC\User\User $user
*/
public function removeUser($user) {
$result = false;
if ($this->emitter) {
$this->emitter->emit('\OC\Group', 'preRemoveUser', [$this, $user]);
}
$this->eventDispatcher->dispatch(new GenericEvent($this, ['user' => $user]), 'group.preRemoveUser');
foreach ($this->backends as $backend) {
if ($backend->implementsActions(\OC\Group\Backend::REMOVE_FROM_GOUP) and $backend->inGroup($user->getUID(), $this->gid)) {
$backend->removeFromGroup($user->getUID(), $this->gid);
$result = true;
}
}
if ($result) {
if ($this->emitter) {
$this->emitter->emit('\OC\Group', 'postRemoveUser', [$this, $user]);
}
$this->eventDispatcher->dispatch(new GenericEvent($this, ['user' => $user]), 'group.postRemoveUser');
if ($this->users) {
foreach ($this->users as $index => $groupUser) {
if ($groupUser->getUID() === $user->getUID()) {
unset($this->users[$index]);
return;
}
}
}
}
}
/**
* search for users in the group by userid
*
* @param string $search
* @param int $limit
* @param int $offset
* @return \OC\User\User[]
*/
public function searchUsers($search, $limit = null, $offset = null) {
$users = [];
foreach ($this->backends as $backend) {
$userIds = $backend->usersInGroup($this->gid, $search, $limit, $offset);
$users += $this->getVerifiedUsers($userIds);
if ($limit !== null and $limit <= 0) {
return \array_values($users);
}
}
return \array_values($users);
}
/**
* returns the number of users matching the search string
*
* @param string $search
* @return int|bool
*/
public function count($search = '') {
$users = false;
foreach ($this->backends as $backend) {
if ($backend->implementsActions(\OC\Group\Backend::COUNT_USERS)) {
if ($users === false) {
//we could directly add to a bool variable, but this would
//be ugly
$users = 0;
}
$users += $backend->countUsersInGroup($this->gid, $search);
}
}
return $users;
}
/**
* search for users in the group by displayname
*
* @param string $search
* @param int $limit
* @param int $offset
* @return \OC\User\User[]
*/
public function searchDisplayName($search, $limit = null, $offset = null) {
$users = [];
foreach ($this->backends as $backend) {
$userIds = $backend->usersInGroup($this->gid, $search, $limit, $offset);
$users = $this->getVerifiedUsers($userIds);
if ($limit !== null and $limit <= 0) {
return \array_values($users);
}
}
return \array_values($users);
}
/**
* delete the group
*
* @return bool
*/
public function delete() {
// Prevent users from deleting group admin
if ($this->getGID() === 'admin') {
return false;
}
$result = false;
if ($this->emitter) {
$this->emitter->emit('\OC\Group', 'preDelete', [$this]);
}
$this->eventDispatcher->dispatch(new GenericEvent($this), 'group.preDelete');
foreach ($this->backends as $backend) {
if ($backend->implementsActions(\OC\Group\Backend::DELETE_GROUP)) {
$result = true;
$backend->deleteGroup($this->gid);
}
}
if ($result and $this->emitter) {
$this->emitter->emit('\OC\Group', 'postDelete', [$this]);
}
$this->eventDispatcher->dispatch(new GenericEvent($this), 'group.postDelete');
return $result;
}
/**
* returns all the Users from an array that really exists
* @param string[] $userIds an array containing user IDs
* @return \OC\User\User[] an Array with the userId as Key and \OC\User\User as value
*/
private function getVerifiedUsers($userIds) {
if (!\is_array($userIds)) {
return [];
}
$users = [];
foreach ($userIds as $userId) {
$user = $this->userManager->get($userId);
if ($user !== null) {
$users[$userId] = $user;
}
}
return $users;
}
/**
* Returns the backend for this group
*
* @return \OC\Group\Backend
* @since 10.0.0
*/
public function getBackend() {
// multiple backends can exist for the same group name,
// but in practice there is only a single one, so return that one
return $this->backends[0];
}
}