nextcloud/apps/dav/lib/connector/sabre/principal.php

227 lines
5.7 KiB
PHP
Raw Normal View History

<?php
/**
2015-03-26 13:44:34 +03:00
* @author Bart Visscher <bartv@thisnet.nl>
* @author Jakob Sack <mail@jakobsack.de>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Lukas Reschke <lukas@owncloud.com>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Thomas Tanghus <thomas@tanghus.net>
* @author Vincent Petry <pvince81@owncloud.com>
*
2016-01-12 17:02:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
2015-03-26 13:44:34 +03:00
* @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/>
2014-12-19 15:28:11 +03:00
*
*/
namespace OCA\DAV\Connector\Sabre;
2014-12-19 18:50:32 +03:00
2016-01-11 19:29:01 +03:00
use OCP\IGroup;
use OCP\IGroupManager;
use OCP\IUser;
2014-12-19 15:28:11 +03:00
use OCP\IUserManager;
use Sabre\DAV\Exception;
use \Sabre\DAV\PropPatch;
use Sabre\DAVACL\PrincipalBackend\BackendInterface;
use Sabre\HTTP\URLUtil;
2014-12-19 15:28:11 +03:00
class Principal implements BackendInterface {
2014-12-19 15:28:11 +03:00
/** @var IUserManager */
private $userManager;
2016-01-11 19:29:01 +03:00
/** @var IGroupManager */
private $groupManager;
/** @var string */
private $principalPrefix;
2016-02-10 12:43:32 +03:00
/** @var bool */
private $hasGroups;
2014-12-19 18:50:32 +03:00
/**
* @param IUserManager $userManager
* @param IGroupManager $groupManager
* @param string $principalPrefix
2014-12-19 18:50:32 +03:00
*/
public function __construct(IUserManager $userManager,
IGroupManager $groupManager,
$principalPrefix = 'principals/users/') {
2014-12-19 15:28:11 +03:00
$this->userManager = $userManager;
2016-01-11 19:29:01 +03:00
$this->groupManager = $groupManager;
$this->principalPrefix = trim($principalPrefix, '/');
2016-02-10 12:43:32 +03:00
$this->hasGroups = ($principalPrefix === 'principals/users/');
2014-12-19 15:28:11 +03:00
}
/**
* 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
2014-12-19 15:28:11 +03:00
* @return string[]
*/
2014-12-19 15:28:11 +03:00
public function getPrincipalsByPrefix($prefixPath) {
$principals = [];
if ($prefixPath === $this->principalPrefix) {
2014-12-19 15:28:11 +03:00
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) = URLUtil::splitPath($path);
if ($prefix === $this->principalPrefix) {
$user = $this->userManager->get($name);
if (!is_null($user)) {
return $this->userToPrincipal($user);
}
}
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');
}
2014-12-19 15:28:11 +03:00
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) = URLUtil::splitPath($principal);
if ($prefix === $this->principalPrefix) {
2016-01-11 22:04:33 +03:00
$user = $this->userManager->get($name);
if (!$user) {
throw new Exception('Principal not found');
}
if ($this->hasGroups || $needGroups) {
2016-02-10 12:43:32 +03:00
$groups = $this->groupManager->getUserGroups($user);
$groups = array_map(function($group) {
/** @var IGroup $group */
return 'principals/groups/' . $group->getGID();
}, $groups);
2016-01-11 19:29:01 +03:00
2016-02-10 12:43:32 +03:00
return $groups;
}
}
2016-01-11 19:29:01 +03:00
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');
}
2012-10-14 23:04:08 +04:00
2014-12-19 18:50:32 +03:00
/**
* @param string $path
* @param PropPatch $propPatch
2014-12-19 18:50:32 +03:00
* @return int
*/
function updatePrincipal($path, PropPatch $propPatch) {
2012-09-10 13:28:09 +04:00
return 0;
}
2012-10-14 23:04:08 +04:00
2014-12-19 18:50:32 +03:00
/**
* @param string $prefixPath
* @param array $searchProperties
* @param string $test
2014-12-19 18:50:32 +03:00
* @return array
*/
function searchPrincipals($prefixPath, array $searchProperties, $test = 'allof') {
2014-12-19 15:28:11 +03:00
return [];
2012-09-10 13:28:09 +04:00
}
/**
* @param string $uri
2015-03-17 14:22:29 +03:00
* @param string $principalPrefix
* @return string
*/
2015-03-17 14:22:29 +03:00
function findByUri($uri, $principalPrefix) {
return '';
}
/**
* @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,
];
$email = $user->getEMailAddress();
if (!empty($email)) {
$principal['{http://sabredav.org/ns}email-address'] = $email;
return $principal;
}
return $principal;
}
2016-01-11 22:04:33 +03:00
public function getPrincipalPrefix() {
return $this->principalPrefix;
}
}