2011-08-06 09:36:56 +00:00
|
|
|
<?php
|
2012-02-11 20:24:22 +00:00
|
|
|
/**
|
2015-03-26 10:44:34 +00: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>
|
2016-01-12 14:02:16 +00:00
|
|
|
* @author Scrutinizer Auto-Fixer <auto-fixer@scrutinizer-ci.com>
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
|
|
|
* @author Thomas Tanghus <thomas@tanghus.net>
|
|
|
|
* @author Vincent Petry <pvince81@owncloud.com>
|
|
|
|
*
|
2016-01-12 14:02:16 +00:00
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
2015-03-26 10:44:34 +00: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 12:28:11 +00:00
|
|
|
*
|
2012-02-11 20:24:22 +00:00
|
|
|
*/
|
2015-02-26 10:37:37 +00:00
|
|
|
|
2015-08-30 17:13:01 +00:00
|
|
|
namespace OCA\DAV\Connector\Sabre;
|
2014-12-19 15:50:32 +00:00
|
|
|
|
2016-01-11 16:29:01 +00:00
|
|
|
use OCP\IGroup;
|
|
|
|
use OCP\IGroupManager;
|
2015-11-24 10:15:31 +00:00
|
|
|
use OCP\IUser;
|
2014-12-19 12:28:11 +00:00
|
|
|
use OCP\IUserManager;
|
2016-01-08 11:11:02 +00:00
|
|
|
use Sabre\DAV\Exception;
|
2015-02-12 11:29:01 +00:00
|
|
|
use \Sabre\DAV\PropPatch;
|
2016-01-08 11:11:02 +00:00
|
|
|
use Sabre\DAVACL\PrincipalBackend\BackendInterface;
|
2015-11-24 10:15:31 +00:00
|
|
|
use Sabre\HTTP\URLUtil;
|
2014-12-19 12:28:11 +00:00
|
|
|
|
2016-01-08 11:11:02 +00:00
|
|
|
class Principal implements BackendInterface {
|
|
|
|
|
2014-12-19 12:28:11 +00:00
|
|
|
/** @var IUserManager */
|
|
|
|
private $userManager;
|
|
|
|
|
2016-01-11 16:29:01 +00:00
|
|
|
/** @var IGroupManager */
|
|
|
|
private $groupManager;
|
|
|
|
|
2014-12-19 15:50:32 +00:00
|
|
|
/**
|
|
|
|
* @param IUserManager $userManager
|
|
|
|
*/
|
2016-01-11 16:29:01 +00:00
|
|
|
public function __construct(IUserManager $userManager, IGroupManager $groupManager) {
|
2014-12-19 12:28:11 +00:00
|
|
|
$this->userManager = $userManager;
|
2016-01-11 16:29:01 +00:00
|
|
|
$this->groupManager = $groupManager;
|
2014-12-19 12:28:11 +00:00
|
|
|
}
|
|
|
|
|
2011-08-06 09:36:56 +00: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 12:28:11 +00:00
|
|
|
* @return string[]
|
2011-08-06 09:36:56 +00:00
|
|
|
*/
|
2014-12-19 12:28:11 +00:00
|
|
|
public function getPrincipalsByPrefix($prefixPath) {
|
|
|
|
$principals = [];
|
2011-08-06 09:36:56 +00:00
|
|
|
|
2015-11-24 10:15:31 +00:00
|
|
|
if ($prefixPath === 'principals/users') {
|
2014-12-19 12:28:11 +00:00
|
|
|
foreach($this->userManager->search('') as $user) {
|
2015-11-24 10:15:31 +00:00
|
|
|
$principals[] = $this->userToPrincipal($user);
|
2012-02-11 20:09:51 +00:00
|
|
|
}
|
2011-08-06 09:36:56 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
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) {
|
2015-11-24 10:15:31 +00:00
|
|
|
$elements = explode('/', $path);
|
|
|
|
if ($elements[0] !== 'principals') {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
if ($elements[1] !== 'users') {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
$name = $elements[2];
|
2014-12-19 12:28:11 +00:00
|
|
|
$user = $this->userManager->get($name);
|
2011-08-06 09:36:56 +00:00
|
|
|
|
2015-11-24 10:15:31 +00:00
|
|
|
if (!is_null($user)) {
|
|
|
|
return $this->userToPrincipal($user);
|
2012-02-11 20:09:51 +00:00
|
|
|
}
|
2011-08-06 09:36:56 +00:00
|
|
|
|
2012-02-11 20:09:51 +00:00
|
|
|
return null;
|
2011-08-06 09:36:56 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the list of members for a group-principal
|
|
|
|
*
|
|
|
|
* @param string $principal
|
2014-02-06 15:30:58 +00:00
|
|
|
* @return string[]
|
2016-01-08 11:11:02 +00:00
|
|
|
* @throws Exception
|
2011-08-06 09:36:56 +00:00
|
|
|
*/
|
|
|
|
public function getGroupMemberSet($principal) {
|
2012-02-11 20:09:51 +00:00
|
|
|
// TODO: for now the group principal has only one member, the user itself
|
2013-08-18 13:53:52 +00:00
|
|
|
$principal = $this->getPrincipalByPath($principal);
|
|
|
|
if (!$principal) {
|
2016-01-08 11:11:02 +00:00
|
|
|
throw new Exception('Principal not found');
|
2013-08-18 13:53:52 +00:00
|
|
|
}
|
2011-08-06 09:36:56 +00:00
|
|
|
|
2014-12-19 12:28:11 +00:00
|
|
|
return [$principal['uri']];
|
2011-08-06 09:36:56 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the list of groups a principal is a member of
|
|
|
|
*
|
|
|
|
* @param string $principal
|
|
|
|
* @return array
|
2016-01-08 11:11:02 +00:00
|
|
|
* @throws Exception
|
2011-08-06 09:36:56 +00:00
|
|
|
*/
|
|
|
|
public function getGroupMembership($principal) {
|
2015-11-24 10:15:31 +00:00
|
|
|
list($prefix, $name) = URLUtil::splitPath($principal);
|
2012-02-11 20:09:51 +00:00
|
|
|
|
2015-11-24 10:15:31 +00:00
|
|
|
if ($prefix === 'principals/users') {
|
2016-01-11 19:04:33 +00:00
|
|
|
$user = $this->userManager->get($name);
|
|
|
|
if (!$user) {
|
2016-01-08 11:11:02 +00:00
|
|
|
throw new Exception('Principal not found');
|
2013-08-18 13:53:52 +00:00
|
|
|
}
|
2012-02-11 20:09:51 +00:00
|
|
|
|
2016-01-11 16:29:01 +00:00
|
|
|
$groups = $this->groupManager->getUserGroups($user);
|
|
|
|
$groups = array_map(function($group) {
|
|
|
|
/** @var IGroup $group */
|
|
|
|
return 'principals/groups/' . $group->getGID();
|
|
|
|
}, $groups);
|
|
|
|
|
|
|
|
$groups[]= 'principals/users/'.$name.'/calendar-proxy-read';
|
|
|
|
$groups[]= 'principals/users/'.$name.'/calendar-proxy-write';
|
|
|
|
return $groups;
|
2011-08-06 09:36:56 +00:00
|
|
|
}
|
2016-01-11 16:29:01 +00:00
|
|
|
return [];
|
2011-08-06 09:36:56 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Updates the list of group members for a group principal.
|
|
|
|
*
|
|
|
|
* The principals should be passed as a list of uri's.
|
|
|
|
*
|
|
|
|
* @param string $principal
|
2015-11-20 15:42:34 +00:00
|
|
|
* @param string[] $members
|
2016-01-08 11:11:02 +00:00
|
|
|
* @throws Exception
|
2011-08-06 09:36:56 +00:00
|
|
|
*/
|
|
|
|
public function setGroupMemberSet($principal, array $members) {
|
2016-01-08 11:11:02 +00:00
|
|
|
throw new Exception('Setting members of the group is not supported yet');
|
2011-08-06 09:36:56 +00:00
|
|
|
}
|
2012-10-14 19:04:08 +00:00
|
|
|
|
2014-12-19 15:50:32 +00:00
|
|
|
/**
|
|
|
|
* @param string $path
|
2015-02-12 11:29:01 +00:00
|
|
|
* @param PropPatch $propPatch
|
2014-12-19 15:50:32 +00:00
|
|
|
* @return int
|
|
|
|
*/
|
2015-02-12 11:29:01 +00:00
|
|
|
function updatePrincipal($path, PropPatch $propPatch) {
|
2012-09-10 09:28:09 +00:00
|
|
|
return 0;
|
|
|
|
}
|
2012-10-14 19:04:08 +00:00
|
|
|
|
2014-12-19 15:50:32 +00:00
|
|
|
/**
|
|
|
|
* @param string $prefixPath
|
|
|
|
* @param array $searchProperties
|
2015-02-12 11:29:01 +00:00
|
|
|
* @param string $test
|
2014-12-19 15:50:32 +00:00
|
|
|
* @return array
|
|
|
|
*/
|
2015-02-12 11:29:01 +00:00
|
|
|
function searchPrincipals($prefixPath, array $searchProperties, $test = 'allof') {
|
2014-12-19 12:28:11 +00:00
|
|
|
return [];
|
2012-09-10 09:28:09 +00:00
|
|
|
}
|
2015-02-12 11:29:01 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @param string $uri
|
2015-03-17 11:22:29 +00:00
|
|
|
* @param string $principalPrefix
|
2015-02-12 11:29:01 +00:00
|
|
|
* @return string
|
|
|
|
*/
|
2015-03-17 11:22:29 +00:00
|
|
|
function findByUri($uri, $principalPrefix) {
|
2015-02-12 11:29:01 +00:00
|
|
|
return '';
|
|
|
|
}
|
2015-11-24 10:15:31 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @param IUser $user
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
protected function userToPrincipal($user) {
|
|
|
|
$userId = $user->getUID();
|
|
|
|
$displayName = $user->getDisplayName();
|
|
|
|
$principal = [
|
|
|
|
'uri' => "principals/users/$userId",
|
|
|
|
'{DAV:}displayname' => is_null($displayName) ? $userId : $displayName,
|
|
|
|
];
|
|
|
|
|
2015-11-24 22:28:24 +00:00
|
|
|
$email = $user->getEMailAddress();
|
2015-11-24 10:15:31 +00:00
|
|
|
if (!empty($email)) {
|
|
|
|
$principal['{http://sabredav.org/ns}email-address'] = $email;
|
|
|
|
return $principal;
|
|
|
|
}
|
|
|
|
return $principal;
|
|
|
|
}
|
2016-01-11 19:04:33 +00:00
|
|
|
|
2011-08-06 09:36:56 +00:00
|
|
|
}
|