Skip to content

Commit c896c5f

Browse files
hamza221hamza221
authored
Merge pull request #51537 from nextcloud/backport/51380/stable29
[stable29] fix(cardav): only show users from enabled addressBooks in contacts menu
2 parents 6a4e973 + 408c4bf commit c896c5f

File tree

10 files changed

+167
-22
lines changed

10 files changed

+167
-22
lines changed

‎apps/dav/lib/AppInfo/Application.php‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -285,12 +285,11 @@ private function setupContactsProvider(IContactsManager $contactsManager,
285285
$cm->setupContactsProvider($contactsManager, $userID, $urlGenerator);
286286
}
287287

288-
private function setupSystemContactsProvider(IContactsManager $contactsManager,
289-
IAppContainer $container): void {
288+
private function setupSystemContactsProvider(IContactsManager $contactsManager, IAppContainer $container): void {
290289
/** @var ContactsManager $cm */
291290
$cm = $container->query(ContactsManager::class);
292291
$urlGenerator = $container->getServer()->getURLGenerator();
293-
$cm->setupSystemContactsProvider($contactsManager, $urlGenerator);
292+
$cm->setupSystemContactsProvider($contactsManager, null, $urlGenerator);
294293
}
295294

296295
public function registerCalendarManager(ICalendarManager $calendarManager,

‎apps/dav/lib/CardDAV/AddressBookImpl.php‎

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,16 @@
3232
*/
3333
namespace OCA\DAV\CardDAV;
3434

35+
use OCA\DAV\Db\PropertyMapper;
3536
use OCP\Constants;
36-
use OCP\IAddressBook;
37+
use OCP\IAddressBookEnabled;
3738
use OCP\IURLGenerator;
3839
use Sabre\VObject\Component\VCard;
3940
use Sabre\VObject\Property;
4041
use Sabre\VObject\Reader;
4142
use Sabre\VObject\UUIDUtil;
4243

43-
class AddressBookImpl implements IAddressBook {
44+
class AddressBookImpl implements IAddressBookEnabled {
4445

4546
/** @var CardDavBackend */
4647
private $backend;
@@ -54,23 +55,35 @@ class AddressBookImpl implements IAddressBook {
5455
/** @var IURLGenerator */
5556
private $urlGenerator;
5657

58+
/** @var PropertyMapper */
59+
private $propertyMapper;
60+
61+
/** @var string|null */
62+
private $userId;
63+
5764
/**
5865
* AddressBookImpl constructor.
5966
*
6067
* @param AddressBook $addressBook
6168
* @param array $addressBookInfo
6269
* @param CardDavBackend $backend
6370
* @param IUrlGenerator $urlGenerator
71+
* @param PropertyMapper $propertyMapper
72+
* @param string|null $userId
6473
*/
6574
public function __construct(
6675
AddressBook $addressBook,
6776
array $addressBookInfo,
6877
CardDavBackend $backend,
69-
IURLGenerator $urlGenerator) {
78+
IURLGenerator $urlGenerator,
79+
PropertyMapper $propertyMapper,
80+
?string $userId) {
7081
$this->addressBook = $addressBook;
7182
$this->addressBookInfo = $addressBookInfo;
7283
$this->backend = $backend;
7384
$this->urlGenerator = $urlGenerator;
85+
$this->propertyMapper = $propertyMapper;
86+
$this->userId = $userId;
7487
}
7588

7689
/**
@@ -348,4 +361,25 @@ public function isSystemAddressBook(): bool {
348361
$this->addressBookInfo['{DAV:}displayname'] === $this->urlGenerator->getBaseUrl()
349362
);
350363
}
364+
365+
public function isEnabled(): bool {
366+
if (!$this->userId) {
367+
return true;
368+
}
369+
370+
if ($this->isSystemAddressBook()) {
371+
$user = $this->userId ;
372+
$uri = 'z-server-generated--system';
373+
} else {
374+
$user = str_replace('principals/users/', '', $this->addressBookInfo['principaluri']);
375+
$uri = $this->addressBookInfo['uri'];
376+
}
377+
378+
$path = 'addressbooks/users/' . $user . '/' . $uri;
379+
$properties = $this->propertyMapper->findPropertyByPathAndName($user, $path, '{http://owncloud.org/ns}enabled');
380+
if (count($properties) > 0) {
381+
return (bool)$properties[0]->getPropertyvalue();
382+
}
383+
return true;
384+
}
351385
}

‎apps/dav/lib/CardDAV/ContactsManager.php‎

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
*/
2626
namespace OCA\DAV\CardDAV;
2727

28+
use OCA\DAV\Db\PropertyMapper;
2829
use OCP\Contacts\IManager;
2930
use OCP\IL10N;
3031
use OCP\IURLGenerator;
@@ -36,15 +37,19 @@ class ContactsManager {
3637
/** @var IL10N */
3738
private $l10n;
3839

40+
/** @var PropertyMapper */
41+
private $propertyMapper;
42+
3943
/**
4044
* ContactsManager constructor.
4145
*
4246
* @param CardDavBackend $backend
4347
* @param IL10N $l10n
4448
*/
45-
public function __construct(CardDavBackend $backend, IL10N $l10n) {
49+
public function __construct(CardDavBackend $backend, IL10N $l10n, PropertyMapper $propertyMapper) {
4650
$this->backend = $backend;
4751
$this->l10n = $l10n;
52+
$this->propertyMapper = $propertyMapper;
4853
}
4954

5055
/**
@@ -54,33 +59,37 @@ public function __construct(CardDavBackend $backend, IL10N $l10n) {
5459
*/
5560
public function setupContactsProvider(IManager $cm, $userId, IURLGenerator $urlGenerator) {
5661
$addressBooks = $this->backend->getAddressBooksForUser("principals/users/$userId");
57-
$this->register($cm, $addressBooks, $urlGenerator);
58-
$this->setupSystemContactsProvider($cm, $urlGenerator);
62+
$this->register($cm, $addressBooks, $urlGenerator, $userId);
63+
$this->setupSystemContactsProvider($cm, $userId, $urlGenerator);
5964
}
6065

6166
/**
6267
* @param IManager $cm
68+
* @param ?string $userId
6369
* @param IURLGenerator $urlGenerator
6470
*/
65-
public function setupSystemContactsProvider(IManager $cm, IURLGenerator $urlGenerator) {
71+
public function setupSystemContactsProvider(IManager $cm, ?string $userId, IURLGenerator $urlGenerator) {
6672
$addressBooks = $this->backend->getAddressBooksForUser("principals/system/system");
67-
$this->register($cm, $addressBooks, $urlGenerator);
73+
$this->register($cm, $addressBooks, $urlGenerator, $userId);
6874
}
6975

7076
/**
7177
* @param IManager $cm
7278
* @param $addressBooks
7379
* @param IURLGenerator $urlGenerator
80+
* @param ?string $userId
7481
*/
75-
private function register(IManager $cm, $addressBooks, $urlGenerator) {
82+
private function register(IManager $cm, $addressBooks, $urlGenerator, ?string $userId) {
7683
foreach ($addressBooks as $addressBookInfo) {
7784
$addressBook = new \OCA\DAV\CardDAV\AddressBook($this->backend, $addressBookInfo, $this->l10n);
7885
$cm->registerAddressBook(
7986
new AddressBookImpl(
8087
$addressBook,
8188
$addressBookInfo,
8289
$this->backend,
83-
$urlGenerator
90+
$urlGenerator,
91+
$this->propertyMapper,
92+
$userId,
8493
)
8594
);
8695
}

‎apps/dav/tests/unit/CardDAV/AddressBookImplTest.php‎

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
use OCA\DAV\CardDAV\AddressBook;
3434
use OCA\DAV\CardDAV\AddressBookImpl;
3535
use OCA\DAV\CardDAV\CardDavBackend;
36+
use OCA\DAV\Db\PropertyMapper;
3637
use OCP\IURLGenerator;
3738
use Sabre\VObject\Component\VCard;
3839
use Sabre\VObject\Property\Text;
@@ -58,6 +59,9 @@ class AddressBookImplTest extends TestCase {
5859
/** @var VCard | \PHPUnit\Framework\MockObject\MockObject */
5960
private $vCard;
6061

62+
/** @var PropertyMapper | \PHPUnit\Framework\MockObject\MockObject */
63+
private $propertyMapper;
64+
6165
protected function setUp(): void {
6266
parent::setUp();
6367

@@ -73,12 +77,15 @@ protected function setUp(): void {
7377
->disableOriginalConstructor()->getMock();
7478
$this->vCard = $this->createMock(VCard::class);
7579
$this->urlGenerator = $this->createMock(IURLGenerator::class);
80+
$this->propertyMapper = $this->createMock(PropertyMapper::class);
7681

7782
$this->addressBookImpl = new AddressBookImpl(
7883
$this->addressBook,
7984
$this->addressBookInfo,
8085
$this->backend,
81-
$this->urlGenerator
86+
$this->urlGenerator,
87+
$this->propertyMapper,
88+
null
8289
);
8390
}
8491

@@ -101,6 +108,8 @@ public function testSearch(): void {
101108
$this->addressBookInfo,
102109
$this->backend,
103110
$this->urlGenerator,
111+
$this->propertyMapper,
112+
null
104113
]
105114
)
106115
->setMethods(['vCard2Array', 'readCard'])
@@ -147,6 +156,8 @@ public function testCreate($properties): void {
147156
$this->addressBookInfo,
148157
$this->backend,
149158
$this->urlGenerator,
159+
$this->propertyMapper,
160+
null
150161
]
151162
)
152163
->setMethods(['vCard2Array', 'createUid', 'createEmptyVCard'])
@@ -197,6 +208,8 @@ public function testUpdate(): void {
197208
$this->addressBookInfo,
198209
$this->backend,
199210
$this->urlGenerator,
211+
$this->propertyMapper,
212+
null
200213
]
201214
)
202215
->setMethods(['vCard2Array', 'createUid', 'createEmptyVCard', 'readCard'])
@@ -234,6 +247,8 @@ public function testUpdateWithTypes(): void {
234247
$this->addressBookInfo,
235248
$this->backend,
236249
$this->urlGenerator,
250+
$this->propertyMapper,
251+
null
237252
]
238253
)
239254
->setMethods(['vCard2Array', 'createUid', 'createEmptyVCard', 'readCard'])
@@ -315,6 +330,8 @@ public function testCreateUid(): void {
315330
$this->addressBookInfo,
316331
$this->backend,
317332
$this->urlGenerator,
333+
$this->propertyMapper,
334+
null
318335
]
319336
)
320337
->setMethods(['getUid'])
@@ -511,7 +528,9 @@ public function testIsSystemAddressBook(): void {
511528
$this->addressBook,
512529
$addressBookInfo,
513530
$this->backend,
514-
$this->urlGenerator
531+
$this->urlGenerator,
532+
$this->propertyMapper,
533+
null
515534
);
516535

517536
$this->assertTrue($addressBookImpl->isSystemAddressBook());
@@ -530,7 +549,9 @@ public function testIsShared(): void {
530549
$this->addressBook,
531550
$addressBookInfo,
532551
$this->backend,
533-
$this->urlGenerator
552+
$this->urlGenerator,
553+
$this->propertyMapper,
554+
'user2'
534555
);
535556

536557
$this->assertFalse($addressBookImpl->isSystemAddressBook());
@@ -550,7 +571,9 @@ public function testIsNotShared(): void {
550571
$this->addressBook,
551572
$addressBookInfo,
552573
$this->backend,
553-
$this->urlGenerator
574+
$this->urlGenerator,
575+
$this->propertyMapper,
576+
'user2'
554577
);
555578

556579
$this->assertFalse($addressBookImpl->isSystemAddressBook());

‎apps/dav/tests/unit/CardDAV/ContactsManagerTest.php‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727

2828
use OCA\DAV\CardDAV\CardDavBackend;
2929
use OCA\DAV\CardDAV\ContactsManager;
30+
use OCA\DAV\Db\PropertyMapper;
3031
use OCP\Contacts\IManager;
3132
use OCP\IL10N;
3233
use OCP\IURLGenerator;
@@ -43,9 +44,10 @@ public function test(): void {
4344
$backEnd->method('getAddressBooksForUser')->willReturn([
4445
['{DAV:}displayname' => 'Test address book', 'uri' => 'default'],
4546
]);
47+
$propertyMapper = $this->createMock(PropertyMapper::class);
4648

4749
$l = $this->createMock(IL10N::class);
48-
$app = new ContactsManager($backEnd, $l);
50+
$app = new ContactsManager($backEnd, $l, $propertyMapper);
4951
$app->setupContactsProvider($cm, 'user01', $urlGenerator);
5052
}
5153
}

‎lib/composer/composer/autoload_classmap.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -491,6 +491,7 @@
491491
'OCP\\Http\\WellKnown\\IResponse' => $baseDir . '/lib/public/Http/WellKnown/IResponse.php',
492492
'OCP\\Http\\WellKnown\\JrdResponse' => $baseDir . '/lib/public/Http/WellKnown/JrdResponse.php',
493493
'OCP\\IAddressBook' => $baseDir . '/lib/public/IAddressBook.php',
494+
'OCP\\IAddressBookEnabled' => $baseDir . '/lib/public/IAddressBookEnabled.php',
494495
'OCP\\IAppConfig' => $baseDir . '/lib/public/IAppConfig.php',
495496
'OCP\\IAvatar' => $baseDir . '/lib/public/IAvatar.php',
496497
'OCP\\IAvatarManager' => $baseDir . '/lib/public/IAvatarManager.php',

‎lib/composer/composer/autoload_static.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -524,6 +524,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
524524
'OCP\\Http\\WellKnown\\IResponse' => __DIR__ . '/../../..' . '/lib/public/Http/WellKnown/IResponse.php',
525525
'OCP\\Http\\WellKnown\\JrdResponse' => __DIR__ . '/../../..' . '/lib/public/Http/WellKnown/JrdResponse.php',
526526
'OCP\\IAddressBook' => __DIR__ . '/../../..' . '/lib/public/IAddressBook.php',
527+
'OCP\\IAddressBookEnabled' => __DIR__ . '/../../..' . '/lib/public/IAddressBookEnabled.php',
527528
'OCP\\IAppConfig' => __DIR__ . '/../../..' . '/lib/public/IAppConfig.php',
528529
'OCP\\IAvatar' => __DIR__ . '/../../..' . '/lib/public/IAvatar.php',
529530
'OCP\\IAvatarManager' => __DIR__ . '/../../..' . '/lib/public/IAvatarManager.php',

‎lib/private/ContactsManager.php‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
use OCP\Constants;
3131
use OCP\Contacts\IManager;
3232
use OCP\IAddressBook;
33+
use OCP\IAddressBookEnabled;
3334

3435
class ContactsManager implements IManager {
3536
/**
@@ -54,6 +55,9 @@ public function search($pattern, $searchProperties = [], $options = []) {
5455
$this->loadAddressBooks();
5556
$result = [];
5657
foreach ($this->addressBooks as $addressBook) {
58+
if ($addressBook instanceof IAddressBookEnabled && !$addressBook->isEnabled()) {
59+
continue;
60+
}
5761
$searchOptions = $options;
5862
$strictSearch = array_key_exists('strict_search', $options) && $options['strict_search'] === true;
5963

‎lib/public/IAddressBookEnabled.php‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
/**
6+
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors"
7+
* SPDX-License-Identifier: AGPL-3.0-only
8+
*/
9+
// use OCP namespace for all classes that are considered public.
10+
// This means that they should be used by apps instead of the internal Nextcloud classes
11+
12+
namespace OCP;
13+
14+
/**
15+
* IAddressBook Interface extension for checking if the address book is enabled
16+
*
17+
* @since 32.0.0
18+
*/
19+
interface IAddressBookEnabled extends IAddressBook {
20+
/**
21+
* Check if the address book is enabled
22+
* @return bool
23+
* @since 32.0.0
24+
*/
25+
public function isEnabled(): bool;
26+
}

0 commit comments

Comments
 (0)