summaryrefslogtreecommitdiffstats
path: root/lib/private/group/manager.php
diff options
context:
space:
mode:
authorRoeland Jago Douma <rullzer@owncloud.com>2016-05-01 13:10:07 +0200
committerRoeland Jago Douma <rullzer@owncloud.com>2016-05-01 13:10:07 +0200
commit0caa09e8452cebd55fc1ce5ffeb588d499c8e094 (patch)
tree76faffcf66f1e60e12f7ba5cc34764d3dd8b77c2 /lib/private/group/manager.php
parentd89b533fa56cd3f1f4add2a60894c98c78650a09 (diff)
downloadnextcloud-server-0caa09e8452cebd55fc1ce5ffeb588d499c8e094.tar.gz
nextcloud-server-0caa09e8452cebd55fc1ce5ffeb588d499c8e094.zip
Move \OC\Group to PSR-4
Diffstat (limited to 'lib/private/group/manager.php')
-rw-r--r--lib/private/group/manager.php351
1 files changed, 0 insertions, 351 deletions
diff --git a/lib/private/group/manager.php b/lib/private/group/manager.php
deleted file mode 100644
index e82a1d4f2e6..00000000000
--- a/lib/private/group/manager.php
+++ /dev/null
@@ -1,351 +0,0 @@
-<?php
-/**
- * @author Arthur Schiwon <blizzz@owncloud.com>
- * @author Bart Visscher <bartv@thisnet.nl>
- * @author Bernhard Posselt <dev@bernhard-posselt.com>
- * @author Joas Schilling <nickvergessen@owncloud.com>
- * @author Jörn Friedrich Dreyer <jfd@butonic.de>
- * @author Lukas Reschke <lukas@owncloud.com>
- * @author macjohnny <estebanmarin@gmx.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 Roman Kreisel <mail@romankreisel.de>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- * @author voxsim <Simon Vocella>
- *
- * @copyright Copyright (c) 2016, 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/>
- *
- */
-
-namespace OC\Group;
-
-use OC\Hooks\PublicEmitter;
-use OCP\GroupInterface;
-use OCP\IGroupManager;
-
-/**
- * Class Manager
- *
- * Hooks available in scope \OC\Group:
- * - preAddUser(\OC\Group\Group $group, \OC\User\User $user)
- * - postAddUser(\OC\Group\Group $group, \OC\User\User $user)
- * - preRemoveUser(\OC\Group\Group $group, \OC\User\User $user)
- * - postRemoveUser(\OC\Group\Group $group, \OC\User\User $user)
- * - preDelete(\OC\Group\Group $group)
- * - postDelete(\OC\Group\Group $group)
- * - preCreate(string $groupId)
- * - postCreate(\OC\Group\Group $group)
- *
- * @package OC\Group
- */
-class Manager extends PublicEmitter implements IGroupManager {
- /**
- * @var GroupInterface[] $backends
- */
- private $backends = array();
-
- /**
- * @var \OC\User\Manager $userManager
- */
- private $userManager;
-
- /**
- * @var \OC\Group\Group[]
- */
- private $cachedGroups = array();
-
- /**
- * @var \OC\Group\Group[]
- */
- private $cachedUserGroups = array();
-
- /** @var \OC\SubAdmin */
- private $subAdmin = null;
-
- /**
- * @param \OC\User\Manager $userManager
- */
- public function __construct(\OC\User\Manager $userManager) {
- $this->userManager = $userManager;
- $cachedGroups = & $this->cachedGroups;
- $cachedUserGroups = & $this->cachedUserGroups;
- $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) {
- /**
- * @var \OC\Group\Group $group
- */
- unset($cachedGroups[$group->getGID()]);
- $cachedUserGroups = array();
- });
- $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) {
- /**
- * @var \OC\Group\Group $group
- */
- $cachedUserGroups = array();
- });
- $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) {
- /**
- * @var \OC\Group\Group $group
- */
- $cachedUserGroups = array();
- });
- }
-
- /**
- * Checks whether a given backend is used
- *
- * @param string $backendClass Full classname including complete namespace
- * @return bool
- */
- public function isBackendUsed($backendClass) {
- $backendClass = strtolower(ltrim($backendClass, '\\'));
-
- foreach ($this->backends as $backend) {
- if (strtolower(get_class($backend)) === $backendClass) {
- return true;
- }
- }
-
- return false;
- }
-
- /**
- * @param \OCP\GroupInterface $backend
- */
- public function addBackend($backend) {
- $this->backends[] = $backend;
- $this->clearCaches();
- }
-
- public function clearBackends() {
- $this->backends = array();
- $this->clearCaches();
- }
-
- protected function clearCaches() {
- $this->cachedGroups = array();
- $this->cachedUserGroups = array();
- }
-
- /**
- * @param string $gid
- * @return \OC\Group\Group
- */
- public function get($gid) {
- if (isset($this->cachedGroups[$gid])) {
- return $this->cachedGroups[$gid];
- }
- return $this->getGroupObject($gid);
- }
-
- /**
- * @param string $gid
- * @return \OCP\IGroup
- */
- protected function getGroupObject($gid) {
- $backends = array();
- foreach ($this->backends as $backend) {
- if ($backend->groupExists($gid)) {
- $backends[] = $backend;
- }
- }
- if (count($backends) === 0) {
- return null;
- }
- $this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this);
- return $this->cachedGroups[$gid];
- }
-
- /**
- * @param string $gid
- * @return bool
- */
- public function groupExists($gid) {
- return !is_null($this->get($gid));
- }
-
- /**
- * @param string $gid
- * @return \OC\Group\Group
- */
- public function createGroup($gid) {
- if ($gid === '' || is_null($gid)) {
- return false;
- } else if ($group = $this->get($gid)) {
- return $group;
- } else {
- $this->emit('\OC\Group', 'preCreate', array($gid));
- foreach ($this->backends as $backend) {
- if ($backend->implementsActions(\OC_Group_Backend::CREATE_GROUP)) {
- $backend->createGroup($gid);
- $group = $this->getGroupObject($gid);
- $this->emit('\OC\Group', 'postCreate', array($group));
- return $group;
- }
- }
- return null;
- }
- }
-
- /**
- * @param string $search
- * @param int $limit
- * @param int $offset
- * @return \OC\Group\Group[]
- */
- public function search($search, $limit = null, $offset = null) {
- $groups = array();
- foreach ($this->backends as $backend) {
- $groupIds = $backend->getGroups($search, $limit, $offset);
- foreach ($groupIds as $groupId) {
- $groups[$groupId] = $this->get($groupId);
- }
- if (!is_null($limit) and $limit <= 0) {
- return array_values($groups);
- }
- }
- return array_values($groups);
- }
-
- /**
- * @param \OC\User\User|null $user
- * @return \OC\Group\Group[]
- */
- public function getUserGroups($user) {
- if (is_null($user)) {
- return [];
- }
- return $this->getUserIdGroups($user->getUID());
- }
-
- /**
- * @param string $uid the user id
- * @return \OC\Group\Group[]
- */
- public function getUserIdGroups($uid) {
- if (isset($this->cachedUserGroups[$uid])) {
- return $this->cachedUserGroups[$uid];
- }
- $groups = array();
- foreach ($this->backends as $backend) {
- $groupIds = $backend->getUserGroups($uid);
- if (is_array($groupIds)) {
- foreach ($groupIds as $groupId) {
- $groups[$groupId] = $this->get($groupId);
- }
- }
- }
- $this->cachedUserGroups[$uid] = $groups;
- return $this->cachedUserGroups[$uid];
- }
-
- /**
- * Checks if a userId is in the admin group
- * @param string $userId
- * @return bool if admin
- */
- public function isAdmin($userId) {
- return $this->isInGroup($userId, 'admin');
- }
-
- /**
- * Checks if a userId is in a group
- * @param string $userId
- * @param string $group
- * @return bool if in group
- */
- public function isInGroup($userId, $group) {
- return array_key_exists($group, $this->getUserIdGroups($userId));
- }
-
- /**
- * get a list of group ids for a user
- * @param \OC\User\User $user
- * @return array with group ids
- */
- public function getUserGroupIds($user) {
- return array_map(function($value) {
- return (string) $value;
- }, array_keys($this->getUserGroups($user)));
- }
-
- /**
- * get a list of all display names in a group
- * @param string $gid
- * @param string $search
- * @param int $limit
- * @param int $offset
- * @return array an array of display names (value) and user ids (key)
- */
- public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
- $group = $this->get($gid);
- if(is_null($group)) {
- return array();
- }
-
- $search = trim($search);
- $groupUsers = array();
-
- if(!empty($search)) {
- // only user backends have the capability to do a complex search for users
- $searchOffset = 0;
- $searchLimit = $limit * 100;
- if($limit === -1) {
- $searchLimit = 500;
- }
-
- do {
- $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset);
- foreach($filteredUsers as $filteredUser) {
- if($group->inGroup($filteredUser)) {
- $groupUsers[]= $filteredUser;
- }
- }
- $searchOffset += $searchLimit;
- } while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit);
-
- if($limit === -1) {
- $groupUsers = array_slice($groupUsers, $offset);
- } else {
- $groupUsers = array_slice($groupUsers, $offset, $limit);
- }
- } else {
- $groupUsers = $group->searchUsers('', $limit, $offset);
- }
-
- $matchingUsers = array();
- foreach($groupUsers as $groupUser) {
- $matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName();
- }
- return $matchingUsers;
- }
-
- /**
- * @return \OC\SubAdmin
- */
- public function getSubAdmin() {
- if (!$this->subAdmin) {
- $this->subAdmin = new \OC\SubAdmin(
- $this->userManager,
- $this,
- \OC::$server->getDatabaseConnection()
- );
- }
-
- return $this->subAdmin;
- }
-}