diff --git a/apps/dav/lib/AppInfo/Application.php b/apps/dav/lib/AppInfo/Application.php index 49d61dd354448..102a6c1306d60 100644 --- a/apps/dav/lib/AppInfo/Application.php +++ b/apps/dav/lib/AppInfo/Application.php @@ -262,12 +262,11 @@ private function setupContactsProvider(IContactsManager $contactsManager, $cm->setupContactsProvider($contactsManager, $userID, $urlGenerator); } - private function setupSystemContactsProvider(IContactsManager $contactsManager, - IAppContainer $container): void { + private function setupSystemContactsProvider(IContactsManager $contactsManager, IAppContainer $container): void { /** @var ContactsManager $cm */ $cm = $container->query(ContactsManager::class); $urlGenerator = $container->getServer()->getURLGenerator(); - $cm->setupSystemContactsProvider($contactsManager, $urlGenerator); + $cm->setupSystemContactsProvider($contactsManager, null, $urlGenerator); } public function registerCalendarManager(ICalendarManager $calendarManager, diff --git a/apps/dav/lib/CardDAV/AddressBookImpl.php b/apps/dav/lib/CardDAV/AddressBookImpl.php index 55f7f3b7639c8..44ff7b40752a1 100644 --- a/apps/dav/lib/CardDAV/AddressBookImpl.php +++ b/apps/dav/lib/CardDAV/AddressBookImpl.php @@ -7,15 +7,16 @@ */ namespace OCA\DAV\CardDAV; +use OCA\DAV\Db\PropertyMapper; use OCP\Constants; -use OCP\IAddressBook; +use OCP\IAddressBookEnabled; use OCP\IURLGenerator; use Sabre\VObject\Component\VCard; use Sabre\VObject\Property; use Sabre\VObject\Reader; use Sabre\VObject\UUIDUtil; -class AddressBookImpl implements IAddressBook { +class AddressBookImpl implements IAddressBookEnabled { /** @var CardDavBackend */ private $backend; @@ -29,6 +30,12 @@ class AddressBookImpl implements IAddressBook { /** @var IURLGenerator */ private $urlGenerator; + /** @var PropertyMapper */ + private $propertyMapper; + + /** @var ?string */ + private $userId; + /** * AddressBookImpl constructor. * @@ -36,16 +43,22 @@ class AddressBookImpl implements IAddressBook { * @param array $addressBookInfo * @param CardDavBackend $backend * @param IUrlGenerator $urlGenerator + * @param PropertyMapper $propertyMapper + * @param ?string $userId */ public function __construct( AddressBook $addressBook, array $addressBookInfo, CardDavBackend $backend, - IURLGenerator $urlGenerator) { + IURLGenerator $urlGenerator, + PropertyMapper $propertyMapper, + ?string $userId = null) { $this->addressBook = $addressBook; $this->addressBookInfo = $addressBookInfo; $this->backend = $backend; $this->urlGenerator = $urlGenerator; + $this->propertyMapper = $propertyMapper; + $this->userId = $userId; } /** @@ -323,4 +336,25 @@ public function isSystemAddressBook(): bool { $this->addressBookInfo['{DAV:}displayname'] === $this->urlGenerator->getBaseUrl() ); } + + public function isEnabled(): bool { + if (!$this->userId) { + return true; + } + + if ($this->isSystemAddressBook()) { + $user = $this->userId ; + $uri = 'z-server-generated--system'; + } else { + $user = str_replace('principals/users/', '', $this->addressBookInfo['principaluri']); + $uri = $this->addressBookInfo['uri']; + } + + $path = 'addressbooks/users/' . $user . '/' . $uri; + $properties = $this->propertyMapper->findPropertyByPathAndName($user, $path, '{http://owncloud.org/ns}enabled'); + if (count($properties) > 0) { + return (bool)$properties[0]->getPropertyvalue(); + } + return true; + } } diff --git a/apps/dav/lib/CardDAV/ContactsManager.php b/apps/dav/lib/CardDAV/ContactsManager.php index 6126ebc10eead..14bf8db7be58d 100644 --- a/apps/dav/lib/CardDAV/ContactsManager.php +++ b/apps/dav/lib/CardDAV/ContactsManager.php @@ -7,6 +7,7 @@ */ namespace OCA\DAV\CardDAV; +use OCA\DAV\Db\PropertyMapper; use OCP\Contacts\IManager; use OCP\IL10N; use OCP\IURLGenerator; @@ -18,15 +19,19 @@ class ContactsManager { /** @var IL10N */ private $l10n; + /** @var PropertyMapper */ + private $propertyMapper; + /** * ContactsManager constructor. * * @param CardDavBackend $backend * @param IL10N $l10n */ - public function __construct(CardDavBackend $backend, IL10N $l10n) { + public function __construct(CardDavBackend $backend, IL10N $l10n, PropertyMapper $propertyMapper) { $this->backend = $backend; $this->l10n = $l10n; + $this->propertyMapper = $propertyMapper; } /** @@ -36,25 +41,27 @@ public function __construct(CardDavBackend $backend, IL10N $l10n) { */ public function setupContactsProvider(IManager $cm, $userId, IURLGenerator $urlGenerator) { $addressBooks = $this->backend->getAddressBooksForUser("principals/users/$userId"); - $this->register($cm, $addressBooks, $urlGenerator); - $this->setupSystemContactsProvider($cm, $urlGenerator); + $this->register($cm, $addressBooks, $urlGenerator, $userId); + $this->setupSystemContactsProvider($cm, $userId, $urlGenerator); } /** * @param IManager $cm + * @param ?string $userId * @param IURLGenerator $urlGenerator */ - public function setupSystemContactsProvider(IManager $cm, IURLGenerator $urlGenerator) { + public function setupSystemContactsProvider(IManager $cm, ?string $userId, IURLGenerator $urlGenerator) { $addressBooks = $this->backend->getAddressBooksForUser("principals/system/system"); - $this->register($cm, $addressBooks, $urlGenerator); + $this->register($cm, $addressBooks, $urlGenerator, $userId); } /** * @param IManager $cm * @param $addressBooks * @param IURLGenerator $urlGenerator + * @param ?string $userId */ - private function register(IManager $cm, $addressBooks, $urlGenerator) { + private function register(IManager $cm, $addressBooks, $urlGenerator, ?string $userId) { foreach ($addressBooks as $addressBookInfo) { $addressBook = new \OCA\DAV\CardDAV\AddressBook($this->backend, $addressBookInfo, $this->l10n); $cm->registerAddressBook( @@ -62,7 +69,9 @@ private function register(IManager $cm, $addressBooks, $urlGenerator) { $addressBook, $addressBookInfo, $this->backend, - $urlGenerator + $urlGenerator, + $this->propertyMapper, + $userId, ) ); } diff --git a/apps/dav/tests/unit/CardDAV/AddressBookImplTest.php b/apps/dav/tests/unit/CardDAV/AddressBookImplTest.php index fb12b5b08848d..404db50b72967 100644 --- a/apps/dav/tests/unit/CardDAV/AddressBookImplTest.php +++ b/apps/dav/tests/unit/CardDAV/AddressBookImplTest.php @@ -10,6 +10,7 @@ use OCA\DAV\CardDAV\AddressBook; use OCA\DAV\CardDAV\AddressBookImpl; use OCA\DAV\CardDAV\CardDavBackend; +use OCA\DAV\Db\PropertyMapper; use OCP\IURLGenerator; use Sabre\VObject\Component\VCard; use Sabre\VObject\Property\Text; @@ -35,6 +36,9 @@ class AddressBookImplTest extends TestCase { /** @var VCard | \PHPUnit\Framework\MockObject\MockObject */ private $vCard; + /** @var PropertyMapper | \PHPUnit\Framework\MockObject\MockObject */ + private $propertyMapper; + protected function setUp(): void { parent::setUp(); @@ -50,12 +54,15 @@ protected function setUp(): void { ->disableOriginalConstructor()->getMock(); $this->vCard = $this->createMock(VCard::class); $this->urlGenerator = $this->createMock(IURLGenerator::class); + $this->propertyMapper = $this->createMock(PropertyMapper::class); $this->addressBookImpl = new AddressBookImpl( $this->addressBook, $this->addressBookInfo, $this->backend, - $this->urlGenerator + $this->urlGenerator, + $this->propertyMapper, + null ); } @@ -78,6 +85,8 @@ public function testSearch(): void { $this->addressBookInfo, $this->backend, $this->urlGenerator, + $this->propertyMapper, + null ] ) ->setMethods(['vCard2Array', 'readCard']) @@ -124,6 +133,8 @@ public function testCreate($properties): void { $this->addressBookInfo, $this->backend, $this->urlGenerator, + $this->propertyMapper, + null ] ) ->setMethods(['vCard2Array', 'createUid', 'createEmptyVCard']) @@ -174,6 +185,8 @@ public function testUpdate(): void { $this->addressBookInfo, $this->backend, $this->urlGenerator, + $this->propertyMapper, + null ] ) ->setMethods(['vCard2Array', 'createUid', 'createEmptyVCard', 'readCard']) @@ -211,6 +224,8 @@ public function testUpdateWithTypes(): void { $this->addressBookInfo, $this->backend, $this->urlGenerator, + $this->propertyMapper, + null ] ) ->setMethods(['vCard2Array', 'createUid', 'createEmptyVCard', 'readCard']) @@ -292,6 +307,8 @@ public function testCreateUid(): void { $this->addressBookInfo, $this->backend, $this->urlGenerator, + $this->propertyMapper, + null ] ) ->setMethods(['getUid']) @@ -488,7 +505,9 @@ public function testIsSystemAddressBook(): void { $this->addressBook, $addressBookInfo, $this->backend, - $this->urlGenerator + $this->urlGenerator, + $this->propertyMapper, + null ); $this->assertTrue($addressBookImpl->isSystemAddressBook()); @@ -507,7 +526,9 @@ public function testIsShared(): void { $this->addressBook, $addressBookInfo, $this->backend, - $this->urlGenerator + $this->urlGenerator, + $this->propertyMapper, + 'user2' ); $this->assertFalse($addressBookImpl->isSystemAddressBook()); @@ -527,7 +548,9 @@ public function testIsNotShared(): void { $this->addressBook, $addressBookInfo, $this->backend, - $this->urlGenerator + $this->urlGenerator, + $this->propertyMapper, + 'user2' ); $this->assertFalse($addressBookImpl->isSystemAddressBook()); diff --git a/apps/dav/tests/unit/CardDAV/ContactsManagerTest.php b/apps/dav/tests/unit/CardDAV/ContactsManagerTest.php index 6b1abb2718d0b..80f1f2a444516 100644 --- a/apps/dav/tests/unit/CardDAV/ContactsManagerTest.php +++ b/apps/dav/tests/unit/CardDAV/ContactsManagerTest.php @@ -9,6 +9,7 @@ use OCA\DAV\CardDAV\CardDavBackend; use OCA\DAV\CardDAV\ContactsManager; +use OCA\DAV\Db\PropertyMapper; use OCP\Contacts\IManager; use OCP\IL10N; use OCP\IURLGenerator; @@ -25,9 +26,10 @@ public function test(): void { $backEnd->method('getAddressBooksForUser')->willReturn([ ['{DAV:}displayname' => 'Test address book', 'uri' => 'default'], ]); + $propertyMapper = $this->createMock(PropertyMapper::class); $l = $this->createMock(IL10N::class); - $app = new ContactsManager($backEnd, $l); + $app = new ContactsManager($backEnd, $l, $propertyMapper); $app->setupContactsProvider($cm, 'user01', $urlGenerator); } } diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php index b0de799a58f8a..cd49c8b605c1e 100644 --- a/lib/composer/composer/autoload_classmap.php +++ b/lib/composer/composer/autoload_classmap.php @@ -513,6 +513,7 @@ 'OCP\\Http\\WellKnown\\IResponse' => $baseDir . '/lib/public/Http/WellKnown/IResponse.php', 'OCP\\Http\\WellKnown\\JrdResponse' => $baseDir . '/lib/public/Http/WellKnown/JrdResponse.php', 'OCP\\IAddressBook' => $baseDir . '/lib/public/IAddressBook.php', + 'OCP\\IAddressBookEnabled' => $baseDir . '/lib/public/IAddressBookEnabled.php', 'OCP\\IAppConfig' => $baseDir . '/lib/public/IAppConfig.php', 'OCP\\IAvatar' => $baseDir . '/lib/public/IAvatar.php', 'OCP\\IAvatarManager' => $baseDir . '/lib/public/IAvatarManager.php', diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php index 6d8e189efa3ee..17470114fb3b6 100644 --- a/lib/composer/composer/autoload_static.php +++ b/lib/composer/composer/autoload_static.php @@ -546,6 +546,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2 'OCP\\Http\\WellKnown\\IResponse' => __DIR__ . '/../../..' . '/lib/public/Http/WellKnown/IResponse.php', 'OCP\\Http\\WellKnown\\JrdResponse' => __DIR__ . '/../../..' . '/lib/public/Http/WellKnown/JrdResponse.php', 'OCP\\IAddressBook' => __DIR__ . '/../../..' . '/lib/public/IAddressBook.php', + 'OCP\\IAddressBookEnabled' => __DIR__ . '/../../..' . '/lib/public/IAddressBookEnabled.php', 'OCP\\IAppConfig' => __DIR__ . '/../../..' . '/lib/public/IAppConfig.php', 'OCP\\IAvatar' => __DIR__ . '/../../..' . '/lib/public/IAvatar.php', 'OCP\\IAvatarManager' => __DIR__ . '/../../..' . '/lib/public/IAvatarManager.php', diff --git a/lib/private/ContactsManager.php b/lib/private/ContactsManager.php index f67cb196eefb3..f9550144e5d03 100644 --- a/lib/private/ContactsManager.php +++ b/lib/private/ContactsManager.php @@ -10,6 +10,7 @@ use OCP\Constants; use OCP\Contacts\IManager; use OCP\IAddressBook; +use OCP\IAddressBookEnabled; class ContactsManager implements IManager { /** @@ -34,6 +35,9 @@ public function search($pattern, $searchProperties = [], $options = []) { $this->loadAddressBooks(); $result = []; foreach ($this->addressBooks as $addressBook) { + if ($addressBook instanceof IAddressBookEnabled && !$addressBook->isEnabled()) { + continue; + } $searchOptions = $options; $strictSearch = array_key_exists('strict_search', $options) && $options['strict_search'] === true; diff --git a/lib/public/IAddressBookEnabled.php b/lib/public/IAddressBookEnabled.php new file mode 100644 index 0000000000000..ad93aa3f59a09 --- /dev/null +++ b/lib/public/IAddressBookEnabled.php @@ -0,0 +1,26 @@ +getMockBuilder('\OCP\IAddressBook') + $addressbook1 = $this->getMockBuilder('\OCP\IAddressBookEnabled') ->disableOriginalConstructor() ->getMock(); + $addressbook1->expects($this->once()) + ->method('isEnabled') + ->willReturn(true); + $addressbook1->expects($this->once()) ->method('search') ->willReturn($search1); @@ -79,10 +83,14 @@ public function testSearch($search1, $search2, $expectedResult) { ->method('getKey') ->willReturn('simple:1'); - $addressbook2 = $this->getMockBuilder('\OCP\IAddressBook') + $addressbook2 = $this->getMockBuilder('\OCP\IAddressBookEnabled') ->disableOriginalConstructor() ->getMock(); + $addressbook2->expects($this->once()) + ->method('isEnabled') + ->willReturn(true); + $addressbook2->expects($this->once()) ->method('search') ->willReturn($search2); @@ -98,6 +106,44 @@ public function testSearch($search1, $search2, $expectedResult) { $this->assertEquals($expectedResult, $result); } + /** + * @dataProvider searchProvider + */ + public function testSearchDisabledAb($search1): void { + /** @var \PHPUnit\Framework\MockObject\MockObject|IAddressBookEnabled $addressbook */ + $addressbook1 = $this->getMockBuilder('\OCP\IAddressBookEnabled') + ->disableOriginalConstructor() + ->getMock(); + + $addressbook1->expects($this->once()) + ->method('isEnabled') + ->willReturn(true); + + $addressbook1->expects($this->once()) + ->method('search') + ->willReturn($search1); + + $addressbook1->expects($this->any()) + ->method('getKey') + ->willReturn('simple:1'); + + $addressbook2 = $this->getMockBuilder('\OCP\IAddressBookEnabled') + ->disableOriginalConstructor() + ->getMock(); + + $addressbook2->expects($this->once()) + ->method('isEnabled') + ->willReturn(false); + + $addressbook2->expects($this->never()) + ->method('search'); + + $this->cm->registerAddressBook($addressbook1); + $this->cm->registerAddressBook($addressbook2); + $result = $this->cm->search(''); + $this->assertEquals($search1, $result); + } + public function testDeleteHavePermission() { /** @var \PHPUnit\Framework\MockObject\MockObject|IAddressBook $addressbook */ @@ -247,8 +293,8 @@ public function testIsEnabledIfSo() { public function testAddressBookEnumeration() { // create mock for the addressbook - /** @var \PHPUnit\Framework\MockObject\MockObject|IAddressBook $addressbook */ - $addressbook = $this->getMockBuilder('\OCP\IAddressBook') + /** @var \PHPUnit\Framework\MockObject\MockObject|IAddressBookEnabled $addressbook */ + $addressbook = $this->getMockBuilder('\OCP\IAddressBookEnabled') ->disableOriginalConstructor() ->getMock();