nextcloud/lib/private/connector/sabre/principal.php

206 lines
5.6 KiB
PHP
Raw Normal View History

<?php
/**
2015-03-26 13:44:34 +03:00
* @author Bart Visscher <bartv@thisnet.nl>
* @author Felix Moeller <mail@felixmoeller.de>
* @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 Sebastian Döll <sebastian.doell@libasys.de>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Thomas Tanghus <thomas@tanghus.net>
* @author Vincent Petry <pvince81@owncloud.com>
*
* @copyright Copyright (c) 2015, 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/>
2014-12-19 15:28:11 +03:00
*
*/
2014-12-19 18:50:32 +03:00
namespace OC\Connector\Sabre;
2014-12-19 15:28:11 +03:00
use OCP\IUserManager;
use OCP\IConfig;
use \Sabre\DAV\PropPatch;
2014-12-19 15:28:11 +03:00
2014-12-19 18:50:32 +03:00
class Principal implements \Sabre\DAVACL\PrincipalBackend\BackendInterface {
2014-12-19 15:28:11 +03:00
/** @var IConfig */
private $config;
/** @var IUserManager */
private $userManager;
2014-12-19 18:50:32 +03:00
/**
* @param IConfig $config
* @param IUserManager $userManager
*/
2014-12-19 15:28:11 +03:00
public function __construct(IConfig $config,
IUserManager $userManager) {
$this->config = $config;
$this->userManager = $userManager;
}
/**
* 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 = [];
2014-12-19 15:28:11 +03:00
if ($prefixPath === 'principals') {
foreach($this->userManager->search('') as $user) {
2014-12-19 15:28:11 +03:00
$principal = [
'uri' => 'principals/' . $user->getUID(),
2014-12-19 18:50:32 +03:00
'{DAV:}displayname' => $user->getUID(),
2014-12-19 15:28:11 +03:00
];
2014-12-19 15:28:11 +03:00
$email = $this->config->getUserValue($user->getUID(), 'settings', 'email');
if(!empty($email)) {
2014-10-31 20:46:47 +03:00
$principal['{http://sabredav.org/ns}email-address'] = $email;
}
2014-10-31 20:46:47 +03:00
$principals[] = $principal;
}
}
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) {
2012-11-02 22:53:02 +04:00
list($prefix, $name) = explode('/', $path);
2014-12-19 15:28:11 +03:00
$user = $this->userManager->get($name);
2014-12-19 15:28:11 +03:00
if ($prefix === 'principals' && !is_null($user)) {
$principal = [
'uri' => 'principals/' . $user->getUID(),
'{DAV:}displayname' => $user->getUID(),
];
2014-12-19 15:28:11 +03:00
$email = $this->config->getUserValue($user->getUID(), 'settings', 'email');
if($email) {
2014-10-31 20:46:47 +03:00
$principal['{http://sabredav.org/ns}email-address'] = $email;
}
2014-10-31 20:46:47 +03:00
return $principal;
}
return null;
}
/**
* Returns the list of members for a group-principal
*
* @param string $principal
* @return string[]
2014-12-19 13:48:43 +03:00
* @throws \Sabre\DAV\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 \Sabre\DAV\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
* @return array
2014-12-19 13:48:43 +03:00
* @throws \Sabre\DAV\Exception
*/
public function getGroupMembership($principal) {
list($prefix, $name) = \Sabre\HTTP\URLUtil::splitPath($principal);
$group_membership = array();
2014-12-19 15:28:11 +03:00
if ($prefix === 'principals') {
$principal = $this->getPrincipalByPath($principal);
if (!$principal) {
throw new \Sabre\DAV\Exception('Principal not found');
}
// TODO: for now the user principal has only its own groups
return array(
'principals/'.$name.'/calendar-proxy-read',
'principals/'.$name.'/calendar-proxy-write',
// The addressbook groups are not supported in Sabre,
// see http://groups.google.com/group/sabredav-discuss/browse_thread/thread/ef2fa9759d55f8c#msg_5720afc11602e753
//'principals/'.$name.'/addressbook-proxy-read',
//'principals/'.$name.'/addressbook-proxy-write',
);
}
return $group_membership;
}
/**
* 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 array $members
2014-12-19 13:48:43 +03:00
* @throws \Sabre\DAV\Exception
*/
public function setGroupMemberSet($principal, array $members) {
throw new \Sabre\DAV\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 '';
}
}