summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--apps/dav/lib/DAV/GroupPrincipalBackend.php141
-rw-r--r--apps/dav/lib/RootCollection.php2
-rw-r--r--apps/dav/tests/unit/DAV/GroupPrincipalTest.php189
3 files changed, 313 insertions, 19 deletions
diff --git a/apps/dav/lib/DAV/GroupPrincipalBackend.php b/apps/dav/lib/DAV/GroupPrincipalBackend.php
index 1f182445dbd..166af7c6b27 100644
--- a/apps/dav/lib/DAV/GroupPrincipalBackend.php
+++ b/apps/dav/lib/DAV/GroupPrincipalBackend.php
@@ -1,9 +1,11 @@
<?php
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @copyright Copyright (c) 2018, Georg Ehrke
*
* @author Roeland Jago Douma <roeland@famdouma.nl>
* @author Thomas Müller <thomas.mueller@tmit.eu>
+ * @author Georg Ehrke <oc.list@georgehrke.com>
*
* @license AGPL-3.0
*
@@ -24,6 +26,9 @@ namespace OCA\DAV\DAV;
use OCP\IGroup;
use OCP\IGroupManager;
+use OCP\IUserSession;
+use OCP\Share\IManager as IShareManager;
+use OCP\IL10N;
use OCP\IUser;
use Sabre\DAV\Exception;
use \Sabre\DAV\PropPatch;
@@ -36,11 +41,29 @@ class GroupPrincipalBackend implements BackendInterface {
/** @var IGroupManager */
private $groupManager;
+ /** @var IUserSession */
+ private $userSession;
+
+ /** @var IShareManager */
+ private $shareManager;
+
+ /** @var IL10N */
+ private $l10n;
+
/**
* @param IGroupManager $IGroupManager
+ * @param IUserSession $userSession
+ * @param IShareManager $shareManager
+ * @param IL10N $l10n
*/
- public function __construct(IGroupManager $IGroupManager) {
+ public function __construct(IGroupManager $IGroupManager,
+ IUserSession $userSession,
+ IShareManager $shareManager,
+ IL10N $l10n) {
$this->groupManager = $IGroupManager;
+ $this->userSession = $userSession;
+ $this->shareManager = $shareManager;
+ $this->l10n = $l10n;
}
/**
@@ -161,7 +184,71 @@ class GroupPrincipalBackend implements BackendInterface {
* @return array
*/
function searchPrincipals($prefixPath, array $searchProperties, $test = 'allof') {
- return [];
+ $results = [];
+
+ if (\count($searchProperties) === 0) {
+ return [];
+ }
+ if ($prefixPath !== self::PRINCIPAL_PREFIX) {
+ return [];
+ }
+ // 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 '{DAV:}displayname':
+ $groups = $this->groupManager->search($value);
+
+ $results[] = array_reduce($groups, function(array $carry, IGroup $group) use ($restrictGroups) {
+ $gid = $group->getGID();
+ // is sharing restricted to groups only?
+ if ($restrictGroups !== false) {
+ if (!\in_array($gid, $restrictGroups, true)) {
+ return $carry;
+ }
+ }
+
+ $carry[] = self::PRINCIPAL_PREFIX . '/' . $gid;
+ 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));
+ }
}
/**
@@ -170,7 +257,34 @@ class GroupPrincipalBackend implements BackendInterface {
* @return string
*/
function findByUri($uri, $principalPrefix) {
- return '';
+ // 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, 'principal:principals/groups/') === 0) {
+ $name = urlencode(substr($uri, 28));
+ if ($restrictGroups !== false && !\in_array($name, $restrictGroups, true)) {
+ return null;
+ }
+
+ return substr($uri, 10);
+ }
+
+ return null;
}
/**
@@ -179,12 +293,12 @@ class GroupPrincipalBackend implements BackendInterface {
*/
protected function groupToPrincipal($group) {
$groupId = $group->getGID();
- $principal = [
+
+ return [
'uri' => 'principals/groups/' . urlencode($groupId),
- '{DAV:}displayname' => $groupId,
+ '{DAV:}displayname' => $this->l10n->t('%s (group)', [$groupId]),
+ '{urn:ietf:params:xml:ns:caldav}calendar-user-type' => 'GROUP',
];
-
- return $principal;
}
/**
@@ -192,11 +306,20 @@ class GroupPrincipalBackend implements BackendInterface {
* @return array
*/
protected function userToPrincipal($user) {
+ $userId = $user->getUID();
+ $displayName = $user->getDisplayName();
+
$principal = [
- 'uri' => 'principals/users/' . $user->getUID(),
- '{DAV:}displayname' => $user->getDisplayName(),
+ 'uri' => 'principals/users/' . $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;
}
}
diff --git a/apps/dav/lib/RootCollection.php b/apps/dav/lib/RootCollection.php
index 9a3261c388c..a05781a7621 100644
--- a/apps/dav/lib/RootCollection.php
+++ b/apps/dav/lib/RootCollection.php
@@ -57,7 +57,7 @@ class RootCollection extends SimpleCollection {
\OC::$server->getUserSession(),
$config
);
- $groupPrincipalBackend = new GroupPrincipalBackend($groupManager);
+ $groupPrincipalBackend = new GroupPrincipalBackend($groupManager, $userSession, $shareManager, $l10n);
$calendarResourcePrincipalBackend = new ResourcePrincipalBackend($db, $userSession, $groupManager, $logger);
$calendarRoomPrincipalBackend = new RoomPrincipalBackend($db, $userSession, $groupManager, $logger);
// as soon as debug mode is enabled we allow listing of principals
diff --git a/apps/dav/tests/unit/DAV/GroupPrincipalTest.php b/apps/dav/tests/unit/DAV/GroupPrincipalTest.php
index 214054176ae..af94df05254 100644
--- a/apps/dav/tests/unit/DAV/GroupPrincipalTest.php
+++ b/apps/dav/tests/unit/DAV/GroupPrincipalTest.php
@@ -1,10 +1,12 @@
<?php
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @copyright Copyright (c) 2018, Georg Ehrke
*
* @author Joas Schilling <coding@schilljs.com>
* @author Roeland Jago Douma <roeland@famdouma.nl>
* @author Thomas Müller <thomas.mueller@tmit.eu>
+ * @author Georg Ehrke <oc.list@georgehrke.com>
*
* @license AGPL-3.0
*
@@ -26,22 +28,42 @@ namespace OCA\DAV\Tests\unit\DAV;
use OC\Group\Group;
use OCA\DAV\DAV\GroupPrincipalBackend;
+use OCP\IGroup;
use OCP\IGroupManager;
-use PHPUnit_Framework_MockObject_MockObject;
+use OCP\IL10N;
+use OCP\IUser;
+use OCP\IUserSession;
+use OCP\Share\IManager;
use \Sabre\DAV\PropPatch;
class GroupPrincipalTest extends \Test\TestCase {
- /** @var IGroupManager | PHPUnit_Framework_MockObject_MockObject */
+ /** @var IGroupManager | \PHPUnit_Framework_MockObject_MockObject */
private $groupManager;
+ /** @var IUserSession | \PHPUnit_Framework_MockObject_MockObject */
+ private $userSession;
+
+ /** @var IManager | \PHPUnit_Framework_MockObject_MockObject */
+ private $shareManager;
+
+ /** @var IL10N | \PHPUnit_Framework_MockObject_MockObject */
+ private $l10n;
+
/** @var GroupPrincipalBackend */
private $connector;
public function setUp() {
$this->groupManager = $this->createMock(IGroupManager::class);
+ $this->userSession = $this->createMock(IUserSession::class);
+ $this->shareManager = $this->createMock(IManager::class);
+ $this->l10n = $this->createMock(IL10N::class);
- $this->connector = new GroupPrincipalBackend($this->groupManager);
+ $this->connector = new GroupPrincipalBackend(
+ $this->groupManager,
+ $this->userSession,
+ $this->shareManager,
+ $this->l10n);
parent::setUp();
}
@@ -59,14 +81,26 @@ class GroupPrincipalTest extends \Test\TestCase {
->with('')
->will($this->returnValue([$group1, $group2]));
+ $this->l10n->expects($this->at(0))
+ ->method('t')
+ ->with('%s (group)', ['foo'])
+ ->will($this->returnValue('foo (Gruppe)'));
+
+ $this->l10n->expects($this->at(1))
+ ->method('t')
+ ->with('%s (group)', ['bar'])
+ ->will($this->returnValue('bar (Gruppe)'));
+
$expectedResponse = [
0 => [
'uri' => 'principals/groups/foo',
- '{DAV:}displayname' => 'foo'
+ '{DAV:}displayname' => 'foo (Gruppe)',
+ '{urn:ietf:params:xml:ns:caldav}calendar-user-type' => 'GROUP',
],
1 => [
'uri' => 'principals/groups/bar',
- '{DAV:}displayname' => 'bar',
+ '{DAV:}displayname' => 'bar (Gruppe)',
+ '{urn:ietf:params:xml:ns:caldav}calendar-user-type' => 'GROUP',
]
];
$response = $this->connector->getPrincipalsByPrefix('principals/groups');
@@ -92,9 +126,15 @@ class GroupPrincipalTest extends \Test\TestCase {
->with('foo')
->will($this->returnValue($group1));
+ $this->l10n->expects($this->at(0))
+ ->method('t')
+ ->with('%s (group)', ['foo'])
+ ->will($this->returnValue('foo (Gruppe)'));
+
$expectedResponse = [
'uri' => 'principals/groups/foo',
- '{DAV:}displayname' => 'foo'
+ '{DAV:}displayname' => 'foo (Gruppe)',
+ '{urn:ietf:params:xml:ns:caldav}calendar-user-type' => 'GROUP',
];
$response = $this->connector->getPrincipalByPath('principals/groups/foo');
$this->assertSame($expectedResponse, $response);
@@ -108,9 +148,15 @@ class GroupPrincipalTest extends \Test\TestCase {
->with('foo')
->will($this->returnValue($fooUser));
+ $this->l10n->expects($this->at(0))
+ ->method('t')
+ ->with('%s (group)', ['foo'])
+ ->will($this->returnValue('foo (Gruppe)'));
+
$expectedResponse = [
'uri' => 'principals/groups/foo',
- '{DAV:}displayname' => 'foo',
+ '{DAV:}displayname' => 'foo (Gruppe)',
+ '{urn:ietf:params:xml:ns:caldav}calendar-user-type' => 'GROUP',
];
$response = $this->connector->getPrincipalByPath('principals/groups/foo');
$this->assertSame($expectedResponse, $response);
@@ -135,9 +181,15 @@ class GroupPrincipalTest extends \Test\TestCase {
->with('foo/bar')
->will($this->returnValue($group1));
+ $this->l10n->expects($this->at(0))
+ ->method('t')
+ ->with('%s (group)', ['foo/bar'])
+ ->will($this->returnValue('foo/bar (Gruppe)'));
+
$expectedResponse = [
'uri' => 'principals/groups/foo%2Fbar',
- '{DAV:}displayname' => 'foo/bar'
+ '{DAV:}displayname' => 'foo/bar (Gruppe)',
+ '{urn:ietf:params:xml:ns:caldav}calendar-user-type' => 'GROUP',
];
$response = $this->connector->getPrincipalByPath('principals/groups/foo/bar');
$this->assertSame($expectedResponse, $response);
@@ -165,10 +217,129 @@ class GroupPrincipalTest extends \Test\TestCase {
$this->assertSame(0, $this->connector->updatePrincipal('foo', new PropPatch(array())));
}
- public function testSearchPrincipals() {
+ public function testSearchPrincipalsWithEmptySearchProperties() {
$this->assertSame([], $this->connector->searchPrincipals('principals/groups', []));
}
+ public function testSearchPrincipalsWithWrongPrefixPath() {
+ $this->assertSame([], $this->connector->searchPrincipals('principals/users',
+ ['{DAV:}displayname' => 'Foo']));
+ }
+
+ /**
+ * @dataProvider searchPrincipalsDataProvider
+ */
+ public function testSearchPrincipals($sharingEnabled, $groupsOnly, $test, $result) {
+ $this->shareManager->expects($this->once())
+ ->method('shareAPIEnabled')
+ ->will($this->returnValue($sharingEnabled));
+
+ if ($sharingEnabled) {
+ $this->shareManager->expects($this->once())
+ ->method('shareWithGroupMembersOnly')
+ ->will($this->returnValue($groupsOnly));
+
+ if ($groupsOnly) {
+ $user = $this->createMock(IUser::class);
+ $this->userSession->expects($this->once())
+ ->method('getUser')
+ ->will($this->returnValue($user));
+
+ $this->groupManager->expects($this->once())
+ ->method('getUserGroupIds')
+ ->with($user)
+ ->will($this->returnValue(['group1', 'group2', 'group5']));
+ }
+ } else {
+ $this->shareManager->expects($this->never())
+ ->method('shareWithGroupMembersOnly');
+ $this->groupManager->expects($this->never())
+ ->method($this->anything());
+ }
+
+ $group1 = $this->createMock(IGroup::class);
+ $group1->method('getGID')->will($this->returnValue('group1'));
+ $group2 = $this->createMock(IGroup::class);
+ $group2->method('getGID')->will($this->returnValue('group2'));
+ $group3 = $this->createMock(IGroup::class);
+ $group3->method('getGID')->will($this->returnValue('group3'));
+ $group4 = $this->createMock(IGroup::class);
+ $group4->method('getGID')->will($this->returnValue('group4'));
+ $group5 = $this->createMock(IGroup::class);
+ $group5->method('getGID')->will($this->returnValue('group5'));
+
+ if ($sharingEnabled) {
+ $this->groupManager->expects($this->once())
+ ->method('search')
+ ->with('Foo')
+ ->will($this->returnValue([$group1, $group2, $group3, $group4, $group5]));
+ } else {
+ $this->groupManager->expects($this->never())
+ ->method('search');
+ }
+
+ $this->assertSame($result, $this->connector->searchPrincipals('principals/groups',
+ ['{DAV:}displayname' => 'Foo'], $test));
+ }
+
+ public function searchPrincipalsDataProvider() {
+ return [
+ [true, false, 'allof', ['principals/groups/group1', 'principals/groups/group2', 'principals/groups/group3', 'principals/groups/group4', 'principals/groups/group5']],
+ [true, false, 'anyof', ['principals/groups/group1', 'principals/groups/group2', 'principals/groups/group3', 'principals/groups/group4', 'principals/groups/group5']],
+ [true, true, 'allof', ['principals/groups/group1', 'principals/groups/group2', 'principals/groups/group5']],
+ [true, true, 'anyof', ['principals/groups/group1', 'principals/groups/group2', 'principals/groups/group5']],
+ [false, false, 'allof', []],
+ [false, false, 'anyof', []],
+ ];
+ }
+
+ /**
+ * @dataProvider findByUriDataProvider
+ */
+ public function testFindByUri($sharingEnabled, $groupsOnly, $findUri, $result) {
+ $this->shareManager->expects($this->once())
+ ->method('shareAPIEnabled')
+ ->will($this->returnValue($sharingEnabled));
+
+ if ($sharingEnabled) {
+ $this->shareManager->expects($this->once())
+ ->method('shareWithGroupMembersOnly')
+ ->will($this->returnValue($groupsOnly));
+
+ if ($groupsOnly) {
+ $user = $this->createMock(IUser::class);
+ $this->userSession->expects($this->once())
+ ->method('getUser')
+ ->will($this->returnValue($user));
+
+ $this->groupManager->expects($this->at(0))
+ ->method('getUserGroupIds')
+ ->with($user)
+ ->will($this->returnValue(['group1', 'group2', 'group5']));
+ }
+ } else {
+ $this->shareManager->expects($this->never())
+ ->method('shareWithGroupMembersOnly');
+ $this->groupManager->expects($this->never())
+ ->method($this->anything());
+ }
+
+ $this->assertEquals($result, $this->connector->findByUri($findUri, 'principals/groups'));
+ }
+
+ public function findByUriDataProvider() {
+ return [
+ [false, false, 'principal:principals/groups/group1', null],
+ [false, false, 'principal:principals/groups/group3', null],
+ [false, true, 'principal:principals/groups/group1', null],
+ [false, true, 'principal:principals/groups/group3', null],
+ [true, true, 'principal:principals/groups/group1', 'principals/groups/group1'],
+ [true, true, 'principal:principals/groups/group3', null],
+ [true, false, 'principal:principals/groups/group1', 'principals/groups/group1'],
+ [true, false, 'principal:principals/groups/group3', 'principals/groups/group3'],
+ ];
+ }
+
/**
* @return Group|\PHPUnit_Framework_MockObject_MockObject
*/
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-26 14:03:33 +0000