* @author Jakob Sack * @author Jörn Friedrich Dreyer * @author Lukas Reschke * @author Morris Jobke * @author Roeland Jago Douma * @author Thomas Müller * @author Thomas Tanghus * @author Vincent Petry * @author Georg Ehrke * @author Vinicius Cubas Brand * @author Daniel Tygel * * @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 * */ namespace OCA\DAV\Connector\Sabre; use OCA\Circles\Exceptions\CircleDoesNotExistException; use OCP\AppFramework\QueryException; use OCP\IConfig; use OCP\IGroup; use OCP\IGroupManager; use OCP\IUser; use OCP\IUserManager; use OCP\IUserSession; use OCP\Share\IManager as IShareManager; use Sabre\DAV\Exception; use \Sabre\DAV\PropPatch; use Sabre\DAVACL\PrincipalBackend\BackendInterface; class Principal implements BackendInterface { /** @var IUserManager */ private $userManager; /** @var IGroupManager */ private $groupManager; /** @var IShareManager */ private $shareManager; /** @var IUserSession */ private $userSession; /** @var IConfig */ private $config; /** @var string */ private $principalPrefix; /** @var bool */ private $hasGroups; /** @var bool */ private $hasCircles; /** * @param IUserManager $userManager * @param IGroupManager $groupManager * @param IShareManager $shareManager * @param IUserSession $userSession * @param IConfig $config * @param string $principalPrefix */ public function __construct(IUserManager $userManager, IGroupManager $groupManager, IShareManager $shareManager, IUserSession $userSession, IConfig $config, $principalPrefix = 'principals/users/') { $this->userManager = $userManager; $this->groupManager = $groupManager; $this->shareManager = $shareManager; $this->userSession = $userSession; $this->config = $config; $this->principalPrefix = trim($principalPrefix, '/'); $this->hasGroups = $this->hasCircles = ($principalPrefix === 'principals/users/'); } /** * Returns a list of principals based on a prefix. * * This prefix will often contain something like 'principals'. You are only * expected to return principals that are in this base path. * * You are expected to return at least a 'uri' for every user, you can * return any additional properties if you wish so. Common properties are: * {DAV:}displayname * * @param string $prefixPath * @return string[] */ public function getPrincipalsByPrefix($prefixPath) { $principals = []; if ($prefixPath === $this->principalPrefix) { foreach($this->userManager->search('') as $user) { $principals[] = $this->userToPrincipal($user); } } return $principals; } /** * Returns a specific principal, specified by it's path. * The returned structure should be the exact same as from * getPrincipalsByPrefix. * * @param string $path * @return array */ public function getPrincipalByPath($path) { list($prefix, $name) = \Sabre\Uri\split($path); if ($prefix === $this->principalPrefix) { $user = $this->userManager->get($name); if ($user !== null) { return $this->userToPrincipal($user); } } else if ($prefix === 'principals/circles') { return $this->circleToPrincipal($name); } return null; } /** * Returns the list of members for a group-principal * * @param string $principal * @return string[] * @throws Exception */ public function getGroupMemberSet($principal) { // TODO: for now the group principal has only one member, the user itself $principal = $this->getPrincipalByPath($principal); if (!$principal) { throw new Exception('Principal not found'); } return [$principal['uri']]; } /** * Returns the list of groups a principal is a member of * * @param string $principal * @param bool $needGroups * @return array * @throws Exception */ public function getGroupMembership($principal, $needGroups = false) { list($prefix, $name) = \Sabre\Uri\split($principal); if ($prefix === $this->principalPrefix) { $user = $this->userManager->get($name); if (!$user) { throw new Exception('Principal not found'); } if ($this->hasGroups || $needGroups) { $groups = $this->groupManager->getUserGroups($user); $groups = array_map(function($group) { /** @var IGroup $group */ return 'principals/groups/' . urlencode($group->getGID()); }, $groups); return $groups; } } return []; } /** * Updates the list of group members for a group principal. * * The principals should be passed as a list of uri's. * * @param string $principal * @param string[] $members * @throws Exception */ public function setGroupMemberSet($principal, array $members) { throw new Exception('Setting members of the group is not supported yet'); } /** * @param string $path * @param PropPatch $propPatch * @return int */ function updatePrincipal($path, PropPatch $propPatch) { return 0; } /** * Search user principals * * @param array $searchProperties * @param string $test * @return array */ protected function searchUserPrincipals(array $searchProperties, $test = 'allof') { $results = []; // If sharing is disabled, return the empty array $shareAPIEnabled = $this->shareManager->shareApiEnabled(); if (!$shareAPIEnabled) { return []; } // If sharing is restricted to group members only, // return only members that have groups in common $restrictGroups = false; if ($this->shareManager->shareWithGroupMembersOnly()) { $user = $this->userSession->getUser(); if (!$user) { return []; } $restrictGroups = $this->groupManager->getUserGroupIds($user); } foreach ($searchProperties as $prop => $value) { switch ($prop) { case '{http://sabredav.org/ns}email-address': $users = $this->userManager->getByEmail($value); $results[] = array_reduce($users, function(array $carry, IUser $user) use ($restrictGroups) { // is sharing restricted to groups only? if ($restrictGroups !== false) { $userGroups = $this->groupManager->getUserGroupIds($user); if (count(array_intersect($userGroups, $restrictGroups)) === 0) { return $carry; } } $carry[] = $this->principalPrefix . '/' . $user->getUID(); return $carry; }, []); break; case '{DAV:}displayname': $users = $this->userManager->searchDisplayName($value); $results[] = array_reduce($users, function(array $carry, IUser $user) use ($restrictGroups) { // is sharing restricted to groups only? if ($restrictGroups !== false) { $userGroups = $this->groupManager->getUserGroupIds($user); if (count(array_intersect($userGroups, $restrictGroups)) === 0) { return $carry; } } $carry[] = $this->principalPrefix . '/' . $user->getUID(); return $carry; }, []); break; default: $results[] = []; break; } } // results is an array of arrays, so this is not the first search result // but the results of the first searchProperty if (count($results) === 1) { return $results[0]; } switch ($test) { case 'anyof': return array_values(array_unique(array_merge(...$results))); case 'allof': default: return array_values(array_intersect(...$results)); } } /** * @param string $prefixPath * @param array $searchProperties * @param string $test * @return array */ function searchPrincipals($prefixPath, array $searchProperties, $test = 'allof') { if (count($searchProperties) === 0) { return []; } switch ($prefixPath) { case 'principals/users': return $this->searchUserPrincipals($searchProperties, $test); default: return []; } } /** * @param string $uri * @param string $principalPrefix * @return string */ function findByUri($uri, $principalPrefix) { // If sharing is disabled, return the empty array $shareAPIEnabled = $this->shareManager->shareApiEnabled(); if (!$shareAPIEnabled) { return null; } // If sharing is restricted to group members only, // return only members that have groups in common $restrictGroups = false; if ($this->shareManager->shareWithGroupMembersOnly()) { $user = $this->userSession->getUser(); if (!$user) { return null; } $restrictGroups = $this->groupManager->getUserGroupIds($user); } if (strpos($uri, 'mailto:') === 0) { if ($principalPrefix === 'principals/users') { $users = $this->userManager->getByEmail(substr($uri, 7)); if (count($users) !== 1) { return null; } $user = $users[0]; if ($restrictGroups !== false) { $userGroups = $this->groupManager->getUserGroupIds($user); if (count(array_intersect($userGroups, $restrictGroups)) === 0) { return null; } } return $this->principalPrefix . '/' . $user->getUID(); } } if (substr($uri, 0, 10) === 'principal:') { $principal = substr($uri, 10); $principal = $this->getPrincipalByPath($principal); if ($principal !== null) { return $principal['uri']; } } return null; } /** * @param IUser $user * @return array */ protected function userToPrincipal($user) { $userId = $user->getUID(); $displayName = $user->getDisplayName(); $principal = [ 'uri' => $this->principalPrefix . '/' . $userId, '{DAV:}displayname' => is_null($displayName) ? $userId : $displayName, '{urn:ietf:params:xml:ns:caldav}calendar-user-type' => 'INDIVIDUAL', ]; $email = $user->getEMailAddress(); if (!empty($email)) { $principal['{http://sabredav.org/ns}email-address'] = $email; } return $principal; } public function getPrincipalPrefix() { return $this->principalPrefix; } /** * @param string $circleUniqueId * @return array|null */ protected function circleToPrincipal($circleUniqueId) { if (!\OC::$server->getAppManager()->isEnabledForUser('circles') || !class_exists('\OCA\Circles\ShareByCircleProvider')) { return null; } try { $circle = \OCA\Circles\Api\v1\Circles::detailsCircle($circleUniqueId, true); } catch(QueryException $ex) { return null; } catch(CircleDoesNotExistException $ex) { return null; } if (!$circle) { return null; } $principal = [ 'uri' => 'principals/circles/' . $circleUniqueId, '{DAV:}displayname' => $circle->getName(), ]; return $principal; } /** * Returns the list of circles a principal is a member of * * @param string $principal * @param bool $needGroups * @return array * @throws Exception */ public function getCircleMembership($principal):array { if (!\OC::$server->getAppManager()->isEnabledForUser('circles') || !class_exists('\OCA\Circles\ShareByCircleProvider')) { return []; } list($prefix, $name) = \Sabre\Uri\split($principal); if ($this->hasCircles && $prefix === $this->principalPrefix) { $user = $this->userManager->get($name); if (!$user) { throw new Exception('Principal not found'); } $circles = \OCA\Circles\Api\v1\Circles::joinedCircles($name, true); $circles = array_map(function($circle) { /** @var \OCA\Circles\Model\Circle $group */ return 'principals/circles/' . urlencode($circle->getUniqueId()); }, $circles); return $circles; } return []; } }