Skip to content

Commit e654985

Browse files
ArtificialOwlArtificialOwl
committed
include circles to acl
Signed-off-by: Maxence Lange <[email protected]>
1 parent cf39897 commit e654985

12 files changed

+862
-31
lines changed

‎lib/ACL/UserMapping/IUserMapping.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
namespace OCA\GroupFolders\ACL\UserMapping;
1010

1111
interface IUserMapping {
12-
/** @return 'user'|'group'|'dummy' */
12+
/** @return 'user'|'group'|'dummy'|'circle' */
1313
public function getType(): string;
1414

1515
public function getId(): string;

‎lib/ACL/UserMapping/UserMapping.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ class UserMapping implements IUserMapping {
1212
private string $displayName;
1313

1414
/**
15-
* @param 'user'|'group'|'dummy' $type
15+
* @param 'user'|'group'|'dummy'|'circle' $type
1616
*/
1717
public function __construct(
1818
private string $type,

‎lib/ACL/UserMapping/UserMappingManager.php

+83-7
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,109 @@
88

99
namespace OCA\GroupFolders\ACL\UserMapping;
1010

11+
use OCA\Circles\CirclesManager;
12+
use OCA\Circles\Exceptions\CircleNotFoundException;
13+
use OCA\Circles\Model\Circle;
14+
use OCA\Circles\Model\Probes\CircleProbe;
15+
use OCP\AutoloadNotAllowedException;
1116
use OCP\IGroup;
1217
use OCP\IGroupManager;
1318
use OCP\IUser;
1419
use OCP\IUserManager;
20+
use OCP\Server;
21+
use Psr\Container\ContainerExceptionInterface;
22+
use Psr\Log\LoggerInterface;
1523

1624
class UserMappingManager implements IUserMappingManager {
1725
public function __construct(
1826
private IGroupManager $groupManager,
1927
private IUserManager $userManager,
28+
private LoggerInterface $logger,
2029
) {
2130
}
2231

2332
public function getMappingsForUser(IUser $user, bool $userAssignable = true): array {
2433
$groupMappings = array_values(array_map(fn (IGroup $group): UserMapping => new UserMapping('group', $group->getGID(), $group->getDisplayName()), $this->groupManager->getUserGroups($user)));
34+
$circleMappings = array_values(array_map(fn (Circle $circle): UserMapping => new UserMapping('circle', $circle->getSingleId(), $circle->getDisplayName()), $this->getUserCircles($user->getUID())));
2535

2636
return array_merge([
2737
new UserMapping('user', $user->getUID(), $user->getDisplayName()),
28-
], $groupMappings);
38+
], $groupMappings, $circleMappings);
2939
}
3040

3141
public function mappingFromId(string $type, string $id): ?IUserMapping {
32-
$mappingObject = ($type === 'group' ? $this->groupManager : $this->userManager)->get($id);
33-
if ($mappingObject) {
34-
$displayName = $mappingObject->getDisplayName();
35-
/** @var 'user'|'group' $type */
36-
return new UserMapping($type, $id, $displayName);
37-
} else {
42+
switch ($type) {
43+
case 'group':
44+
$displayName = $this->groupManager->get($id)?->getDisplayName();
45+
break;
46+
case 'user':
47+
$displayName = $this->userManager->get($id)?->getDisplayName();
48+
break;
49+
case 'circle':
50+
$displayName = $this->getCircle($id)?->getDisplayName();
51+
break;
52+
default:
53+
return null;
54+
}
55+
if ($displayName === null) {
56+
return null;
57+
}
58+
59+
return new UserMapping($type, $id, $displayName);
60+
}
61+
62+
63+
64+
/**
65+
* returns the Circle from its single Id, or NULL if not available
66+
*/
67+
private function getCircle(string $groupId): ?Circle {
68+
$circlesManager = $this->getCirclesManager();
69+
if ($circlesManager === null) {
70+
return null;
71+
}
72+
73+
$circlesManager->startSuperSession();
74+
$probe = new CircleProbe();
75+
$probe->includeSystemCircles();
76+
$probe->includeSingleCircles();
77+
try {
78+
return $circlesManager->getCircle($groupId, $probe);
79+
} catch (CircleNotFoundException) {
80+
} catch (\Exception $e) {
81+
$this->logger->warning('', ['exception' => $e]);
82+
} finally {
83+
$circlesManager->stopSession();
84+
}
85+
86+
return null;
87+
}
88+
89+
/**
90+
* returns list of circles a user is member of
91+
*/
92+
private function getUserCircles(string $userId): array {
93+
$circlesManager = $this->getCirclesManager();
94+
if ($circlesManager === null) {
95+
return [];
96+
}
97+
98+
$circlesManager->startSession($circlesManager->getLocalFederatedUser($userId));
99+
try {
100+
return $circlesManager->probeCircles();
101+
} catch (\Exception $e) {
102+
$this->logger->warning('', ['exception' => $e]);
103+
} finally {
104+
$circlesManager->stopSession();
105+
}
106+
107+
return [];
108+
}
109+
110+
public function getCirclesManager(): ?CirclesManager {
111+
try {
112+
return Server::get(CirclesManager::class);
113+
} catch (ContainerExceptionInterface|AutoloadNotAllowedException) {
38114
return null;
39115
}
40116
}

‎lib/Command/ListCommand.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
106106
}, array_keys($folder['groups']), array_values($folder['groups']));
107107
$folder['groups'] = implode("\n", $groupStrings);
108108
$folder['acl'] = $folder['acl'] ? 'Enabled' : 'Disabled';
109-
$manageStrings = array_map(fn (array $manage): string => $manage['id'] . ' (' . $manage['type'] . ')', $folder['manage']);
109+
$manageStrings = array_map(fn (array $manage): string => $manage['displayname'] . ' (' . $manage['type'] . ')', $folder['manage']);
110110
$folder['manage'] = implode("\n", $manageStrings);
111111

112112
return $folder;

‎lib/Controller/FolderController.php

+5-3
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030

3131
/**
3232
* @psalm-import-type GroupFoldersGroup from ResponseDefinitions
33+
* @psalm-import-type GroupFoldersCircle from ResponseDefinitions
3334
* @psalm-import-type GroupFoldersUser from ResponseDefinitions
3435
* @psalm-import-type GroupFoldersFolder from ResponseDefinitions
3536
* @psalm-import-type InternalFolderOut from FolderManager
@@ -474,16 +475,15 @@ private function folderDataForXML(array $data): array {
474475
*
475476
* @param int $id The ID of the Groupfolder
476477
* @param string $search String to search by
477-
* @return DataResponse<Http::STATUS_OK, array{users: list<GroupFoldersUser>, groups: list<GroupFoldersGroup>}, array{}>
478+
* @return DataResponse<Http::STATUS_OK, array{users: list<GroupFoldersUser>, groups: list<GroupFoldersGroup>, circles: list<GroupFoldersCircle>}, array{}>
478479
* @throws OCSForbiddenException Not allowed to search
479480
*
480481
* 200: ACL Mappings returned
481482
*/
482483
#[NoAdminRequired]
483484
#[FrontpageRoute(verb: 'GET', url: '/folders/{id}/search')]
484485
public function aclMappingSearch(int $id, string $search = ''): DataResponse {
485-
$users = [];
486-
$groups = [];
486+
$users = $groups = $circles = [];
487487

488488
if ($this->user === null) {
489489
throw new OCSForbiddenException();
@@ -492,11 +492,13 @@ public function aclMappingSearch(int $id, string $search = ''): DataResponse {
492492
if ($this->manager->canManageACL($id, $this->user) === true) {
493493
$groups = $this->manager->searchGroups($id, $search);
494494
$users = $this->manager->searchUsers($id, $search);
495+
$circles = $this->manager->searchCircles($id, $search);
495496
}
496497

497498
return new DataResponse([
498499
'users' => $users,
499500
'groups' => $groups,
501+
'circles' => $circles
500502
]);
501503
}
502504
}

‎lib/Folder/FolderManager.php

+86-14
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@
1111
use OC\Files\Node\Node;
1212
use OCA\Circles\CirclesManager;
1313
use OCA\Circles\Exceptions\CircleNotFoundException;
14+
use OCA\Circles\Model\Circle;
15+
use OCA\Circles\Model\Member;
1416
use OCA\Circles\Model\Probes\CircleProbe;
1517
use OCA\GroupFolders\Mount\GroupMountPoint;
1618
use OCA\GroupFolders\ResponseDefinitions;
17-
use OCA\GroupFolders\Settings\Admin;
1819
use OCP\AutoloadNotAllowedException;
1920
use OCP\Constants;
2021
use OCP\DB\Exception;
@@ -36,6 +37,7 @@
3637

3738
/**
3839
* @psalm-import-type GroupFoldersGroup from ResponseDefinitions
40+
* @psalm-import-type GroupFoldersCircle from ResponseDefinitions
3941
* @psalm-import-type GroupFoldersUser from ResponseDefinitions
4042
* @psalm-import-type GroupFoldersAclManage from ResponseDefinitions
4143
* @psalm-import-type GroupFoldersApplicable from ResponseDefinitions
@@ -264,16 +266,33 @@ private function getManageAcl(array $mappings): array {
264266
];
265267
}
266268

267-
$group = Server::get(IGroupManager::class)->get($entry['mapping_id']);
268-
if ($group === null) {
269-
return null;
269+
if ($entry['mapping_type'] === 'group') {
270+
$group = Server::get(IGroupManager::class)->get($entry['mapping_id']);
271+
if ($group === null) {
272+
return null;
273+
}
274+
275+
return [
276+
'type' => 'group',
277+
'id' => $group->getGID(),
278+
'displayname' => $group->getDisplayName()
279+
];
270280
}
271281

272-
return [
273-
'type' => 'group',
274-
'id' => $group->getGID(),
275-
'displayname' => $group->getDisplayName()
276-
];
282+
if ($entry['mapping_type'] === 'circle') {
283+
$circle = $this->getCircle($entry['mapping_id']);
284+
if ($circle === null) {
285+
return null;
286+
}
287+
288+
return [
289+
'type' => 'circle',
290+
'id' => $circle->getSingleId(),
291+
'displayname' => $circle->getDisplayName()
292+
];
293+
}
294+
295+
return null;
277296
}, $mappings)));
278297
}
279298

@@ -401,6 +420,20 @@ private function getGroups(int $id): array {
401420
], array_values(array_filter($groups)));
402421
}
403422

423+
/**
424+
* @throws Exception
425+
* @return list<GroupFoldersCircle>
426+
*/
427+
private function getCircles(int $id): array {
428+
$circles = $this->getAllApplicable()[$id] ?? [];
429+
$circles = array_map(fn (string $singleId): ?Circle => $this->getCircle($singleId), array_keys($circles));
430+
431+
return array_map(fn (Circle $circle): array => [
432+
'sid' => $circle->getSingleId(),
433+
'displayname' => $circle->getDisplayName()
434+
], array_values(array_filter($circles)));
435+
}
436+
404437
/**
405438
* Check if the user is able to configure the advanced folder permissions. This
406439
* is the case if the user is an admin, has admin permissions for the group folder
@@ -460,6 +493,19 @@ public function searchGroups(int $id, string $search = ''): array {
460493
return array_values(array_filter($groups, fn (array $group): bool => (stripos($group['gid'], $search) !== false) || (stripos($group['displayname'], $search) !== false)));
461494
}
462495

496+
/**
497+
* @throws Exception
498+
* @return list<GroupFoldersCircle>
499+
*/
500+
public function searchCircles(int $id, string $search = ''): array {
501+
$circles = $this->getCircles($id);
502+
if ($search === '') {
503+
return $circles;
504+
}
505+
506+
return array_values(array_filter($circles, fn (array $circle): bool => (stripos($circle['displayname'], $search) !== false)));
507+
}
508+
463509
/**
464510
* @throws Exception
465511
* @return list<GroupFoldersUser>
@@ -482,6 +528,27 @@ public function searchUsers(int $id, string $search = '', int $limit = 10, int $
482528
}
483529
}
484530

531+
foreach ($this->getCircles($id) as $circleData) {
532+
$circle = $this->getCircle($circleData['sid']);
533+
if ($circle === null) {
534+
continue;
535+
}
536+
537+
foreach ($circle->getInheritedMembers(false) as $member) {
538+
if ($member->getUserType() !== Member::TYPE_USER) {
539+
continue;
540+
}
541+
542+
$uid = $member->getUserId();
543+
if (!isset($users[$uid])) {
544+
$users[$uid] = [
545+
'uid' => $uid,
546+
'displayname' => $member->getDisplayName()
547+
];
548+
}
549+
}
550+
}
551+
485552
return array_values($users);
486553
}
487554

@@ -918,27 +985,32 @@ public function getFolderPermissionsForUser(IUser $user, int $folderId): int {
918985
* returns if the groupId is in fact the singleId of an existing Circle
919986
*/
920987
public function isACircle(string $groupId): bool {
988+
return ($this->getCircle($groupId) !== null);
989+
}
990+
991+
/**
992+
* returns the Circle from its single Id, or NULL if not available
993+
*/
994+
public function getCircle(string $groupId): ?Circle {
921995
$circlesManager = $this->getCirclesManager();
922996
if ($circlesManager === null) {
923-
return false;
997+
return null;
924998
}
925999

9261000
$circlesManager->startSuperSession();
9271001
$probe = new CircleProbe();
9281002
$probe->includeSystemCircles();
9291003
$probe->includeSingleCircles();
9301004
try {
931-
$circlesManager->getCircle($groupId, $probe);
932-
933-
return true;
1005+
return $circlesManager->getCircle($groupId, $probe);
9341006
} catch (CircleNotFoundException) {
9351007
} catch (\Exception $e) {
9361008
$this->logger->warning('', ['exception' => $e]);
9371009
} finally {
9381010
$circlesManager->stopSession();
9391011
}
9401012

941-
return false;
1013+
return null;
9421014
}
9431015

9441016
public function getCirclesManager(): ?CirclesManager {

‎lib/ResponseDefinitions.php

+6-1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@
2323
* displayname: string,
2424
* }
2525
*
26+
* @psalm-type GroupFoldersCircle = array{
27+
* sid: string,
28+
* displayname: string,
29+
* }
30+
*
2631
* @psalm-type GroupFoldersUser = array{
2732
* uid: string,
2833
* displayname: string,
@@ -31,7 +36,7 @@
3136
* @psalm-type GroupFoldersAclManage = array{
3237
* displayname: string,
3338
* id: string,
34-
* type: 'user'|'group',
39+
* type: 'user'|'group'|'circle',
3540
* }
3641
*
3742
* @psalm-type GroupFoldersApplicable = array{

0 commit comments

Comments
 (0)