fix: automatically disable sab #50605

SebastianKrupinski · 2025-02-01T02:07:11Z

Resolves: Automatically disable the system address book for large instances #49431

Summary

Automatically disables system address book when a configured limit is reached.

Checklist

Code is properly formatted
Sign-off message is added to all commits
Tests (unit, integration, api and/or acceptance) are included
Screenshots before/after for front-end changes
Documentation (manuals or wiki) has been updated or is not required
Backports requested where applicable (ex: critical bugfixes)

ChristophWurst

Looks good

st3iny

Looks good and tests are included.

SebastianKrupinski · 2025-02-17T19:27:13Z

@st3iny thank you

SebastianKrupinski · 2025-02-17T19:27:54Z

Temporarily converted to draft to adjust logic.

st3iny · 2025-02-17T19:29:43Z

Temporarily converted to draft to adjust logic.

What is the problem? The sync being run despite the exposed config being set to no?

kesselb · 2025-02-17T20:10:17Z

What is the problem?

The code is only executed when running the sync command via occ or when installing nextcloud (but then you don't have a 5k user directory connected). It should be a migration / repair step to automatically disable sab. Not as side effection when calling the sync command.

SebastianKrupinski · 2025-02-17T20:55:40Z

What is the problem? The sync being run despite the exposed config being set to no?

No... at the moment the logic disables the system address book automatically even if the admin forces the "system_addressbook_exposed" to yes, if the limit is reached. And during our 1 on 1 today, we thought that is might cause confusion. So the solution is to only automatically disable the address book if the "system_addressbook_exposed" has not been set yet, I just have not made the adjustment yet.

st3iny

Daniel is right though. The syncInstance() method is only called from the occ command (or during an old migration).

ChristophWurst · 2025-05-13T14:53:19Z

@SebastianKrupinski have the change requests been addressed in the last push?

SebastianKrupinski · 2025-06-02T22:01:18Z

@SebastianKrupinski have the change requests been addressed in the last push?

yes, new code is up

apps/dav/lib/CardDAV/SyncService.php

st3iny · 2025-08-06T13:45:04Z

apps/dav/lib/CardDAV/Notification/Notifier.php

+	 * @inheritDoc
+	 */
+	public function getName(): string {
+		return $this->name;


Suggested change

return $this->name;

return $this->l10nFactory->get(Application::APP_ID)->t('Contacts');

Copied from Calendar. I'm not sure if a changing name is a good idea. Especially given that the cached name will depend on the last notification to be prepared which is a bit arbitrary.

st3iny · 2025-08-06T13:45:41Z

apps/dav/lib/CardDAV/Notification/Notifier.php

+	private string $name = 'CardDAV';
+


Suggested change

private string $name = 'CardDAV';

Not required anymore. See my other comment above.

apps/dav/tests/unit/SetupChecks/SystemAddressBookSizeTest.php

apps/dav/lib/CardDAV/Notification/Notifier.php

st3iny · 2025-08-06T13:59:18Z

apps/dav/lib/SetupChecks/SystemAddressBookSize.php

+		$limit = $this->appConfig->getValueInt(Application::APP_ID, 'system_addressbook_limit', 5000);
+
+		if ($count > $limit) {
+			return SetupResult::warning($this->l10n->t('The system address book is enabled, but has more than the configured limit of %s users', (string)$limit));


Can you derive something from the problem description at #49431?

Contacts rendering and mobile client syncing are the big issues I can think of

Does not seem to be addressed, as far as I can see.

(I don't care too much about the message. Just noticed this when I checked open conversations.)

Proposed additional text: This can cause performance issues in the Contacts app and when syncing with external CardDAV clients.

st3iny · 2025-08-06T14:08:05Z

apps/dav/lib/Migration/Version1032Date20250701000000.php

+				->setUser($user->getUID())
+				->setDateTime(new \DateTime())
+				->setSubject('SystemSystemAddressBookDisabled', []);
+			$this->notificationManager->notify($notification);


This is really dangerous as it will call the newly created INotifier implementation.

I'd recommend to move this logic in a repair step. Let me know in case you need to know more.

(This is the only point of feedback I would like to see addressed hence the changes requested state.)

Done. Changed it to a repair step that only runs on 32

@st3iny what is the dangerous aspect? That the notifier executes during schema migration?

This has to be a one-time thing. A regular repair step will execute again and again.

#50605 (comment)

st3iny

Looks good otherwise.

apps/dav/lib/Migration/DisableSystemAddressBook.php

st3iny · 2025-09-01T08:21:11Z

apps/dav/lib/Migration/DisableSystemAddressBook.php

+	 */
+	public function run(IOutput $output) {
+		$output->info('Running repair step to disable system address book');
+		if ($this->serverVersion->getMajorVersion() !== 32) {


Nope, this won't work.

Please remove the version check. Repair steps should be idempotent, i.e., be run over and over again.

st3iny · 2025-09-01T08:24:36Z

apps/dav/lib/Migration/DisableSystemAddressBook.php

+	public function run(IOutput $output) {
+		$output->info('Running repair step to disable system address book');
+		if ($this->serverVersion->getMajorVersion() !== 32) {
+			$output->info('Skipping repair step system address book this only applies to Nextcloud 32');
+			return;
+		}
+		// If the system address book is not exposed there is nothing to do
+		if ($this->appConfig->getAppValueBool('system_addressbook_exposed', true) === false) {
+			$output->info('Skipping repair step system address book is already disabled');
+			return;
+		}
+		// We use count seen because getting a user count from the backend can be very slow
+		$limit = $this->appConfig->getAppValueInt('system_addressbook_limit', 5000);
+		if ($this->userManager->countSeenUsers() <= $limit) {
+			$output->info("Skipping repair step system address book has less then the threshold $limit of contacts no need to disable");
+			return;
+		}
+		$this->appConfig->setAppValueBool('system_addressbook_exposed', false);
+		$output->warning("System address book disabled because it has more then the threshold of $limit contacts this can be re-enabled later");
+		// Notify all admin users about the system address book being disabled
+		foreach ($this->groupManager->get('admin')->getUsers() as $user) {
+			$notification = $this->notificationManager->createNotification();
+			$notification->setApp(Application::APP_ID)
+				->setUser($user->getUID())
+				->setDateTime(new \DateTime())
+				->setSubject('SystemSystemAddressBookDisabled', []);
+			$this->notificationManager->notify($notification);
+		}
+	}
+}


The whole step is not really idempotent. If an admin re-enables the system address book (system_addressbook_exposed => true), it will be disabled again and again.

I think you need to check if the config has been set manually by admins and then skip this repair step. Just checking for false is not sufficient.

It will only run if the setting has not been set before now

ChristophWurst · 2025-09-15T14:14:13Z

We will leave this as repair step and only take action when they config key is not set. So this is only executed once.

SebastianKrupinski · 2025-09-15T14:39:35Z

We will leave this as repair step and only take action when they config key is not set. So this is only executed once.

Done.

SebastianKrupinski · 2025-09-15T14:40:31Z

I think reuse is drunk today lol

* Bad licenses: AGPL-3.0-later
* Missing licenses: AGPL-3.0-later

ChristophWurst · 2025-09-18T05:54:20Z

apps/dav/lib/Migration/DisableSystemAddressBook.php

+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-later


Suggested change

* SPDX-License-Identifier: AGPL-3.0-later

* SPDX-License-Identifier: AGPL-3.0-or-later

the SPDX check is right. This license identifier is invalid

Done. If that was the issue the error message was very misleading

# BAD LICENSES 'AGPL-3.0-later' found in: * apps/dav/lib/Migration/DisableSystemAddressBook.php # MISSING LICENSES 'AGPL-3.0-later' found in: * apps/dav/lib/Migration/DisableSystemAddressBook.php

Exactly misleading

st3iny

Repair step makes sense now. Please address Christoph's feedback.

Signed-off-by: SebastianKrupinski <krupinskis05@gmail.com>

SebastianKrupinski added the 3. to review Waiting for reviews label Feb 1, 2025

SebastianKrupinski self-assigned this Feb 1, 2025

SebastianKrupinski requested a review from hamza221 as a code owner February 1, 2025 02:07

AndyScherzinger added this to the Nextcloud 32 milestone Feb 11, 2025

AndyScherzinger requested a review from ChristophWurst February 11, 2025 21:25

SebastianKrupinski requested review from kesselb and st3iny February 12, 2025 05:18

SebastianKrupinski force-pushed the fix/49431-automatically-disable-sab branch from 4950879 to f81af1e Compare February 12, 2025 05:34

ChristophWurst approved these changes Feb 13, 2025

View reviewed changes

backportbot bot added the backport-request label Feb 17, 2025

SebastianKrupinski force-pushed the fix/49431-automatically-disable-sab branch from f81af1e to a288ada Compare February 17, 2025 14:06

st3iny approved these changes Feb 17, 2025

View reviewed changes

SebastianKrupinski marked this pull request as draft February 17, 2025 19:28

SebastianKrupinski force-pushed the fix/49431-automatically-disable-sab branch from a288ada to 0ee3572 Compare February 17, 2025 23:46

st3iny previously requested changes Feb 18, 2025

View reviewed changes

SebastianKrupinski force-pushed the fix/49431-automatically-disable-sab branch from 0ee3572 to 5d5e11b Compare March 4, 2025 00:21

SebastianKrupinski force-pushed the fix/49431-automatically-disable-sab branch 4 times, most recently from f4e0035 to 5077b81 Compare June 2, 2025 21:52

SebastianKrupinski requested a review from st3iny June 2, 2025 22:00

SebastianKrupinski marked this pull request as ready for review June 2, 2025 22:04

ChristophWurst reviewed Jun 3, 2025

View reviewed changes

apps/dav/lib/CardDAV/SyncService.php Outdated Show resolved Hide resolved

apps/dav/lib/CardDAV/SyncService.php Outdated Show resolved Hide resolved

ChristophWurst approved these changes Jul 22, 2025

View reviewed changes

st3iny requested changes Aug 6, 2025

View reviewed changes

This was referenced Aug 22, 2025

32.0.0 beta 2 #54581

Merged

32.0.0 beta 3 #54606

Merged

SebastianKrupinski force-pushed the fix/49431-automatically-disable-sab branch from 1ab1b60 to b39ccb4 Compare August 26, 2025 15:22

nextcloud-bot mentioned this pull request Aug 28, 2025

32.0.0 beta 4 #54688

Merged

SebastianKrupinski force-pushed the fix/49431-automatically-disable-sab branch from a38c00e to 5e40b3b Compare August 28, 2025 19:29

st3iny reviewed Aug 29, 2025

View reviewed changes

apps/dav/lib/Migration/DisableSystemAddressBook.php Outdated Show resolved Hide resolved

st3iny requested changes Sep 1, 2025

View reviewed changes

st3iny reviewed Sep 1, 2025

View reviewed changes

This was referenced Sep 2, 2025

32.0.0 beta 5 #54796

Merged

[stable32] 32.0.0 RC1 #54864

Merged

nextcloud-bot mentioned this pull request Sep 10, 2025

[stable32] 32.0.0 RC2 #55000

Merged

SebastianKrupinski force-pushed the fix/49431-automatically-disable-sab branch from 5e40b3b to 3712caa Compare September 15, 2025 14:36

ChristophWurst requested a review from st3iny September 15, 2025 15:01

ChristophWurst approved these changes Sep 18, 2025

View reviewed changes

ChristophWurst reviewed Sep 18, 2025

View reviewed changes

nextcloud-bot mentioned this pull request Sep 18, 2025

[stable32] 32.0.0 RC3 #55162

Merged

st3iny approved these changes Sep 18, 2025

View reviewed changes

fix: automatically disable sab

cab9a5d

Signed-off-by: SebastianKrupinski <krupinskis05@gmail.com>

SebastianKrupinski force-pushed the fix/49431-automatically-disable-sab branch from e636b0e to cab9a5d Compare September 18, 2025 15:01

ChristophWurst merged commit 09eb205 into master Sep 18, 2025
199 checks passed

ChristophWurst deleted the fix/49431-automatically-disable-sab branch September 18, 2025 15:39

skjnldsv modified the milestones: Nextcloud 32, Nextcloud 33 Sep 28, 2025

	return $this->name;
	return $this->l10nFactory->get(Application::APP_ID)->t('Contacts');

	* SPDX-License-Identifier: AGPL-3.0-later
	* SPDX-License-Identifier: AGPL-3.0-or-later

Uh oh!

fix: automatically disable sab #50605

fix: automatically disable sab #50605

Uh oh!

Conversation

SebastianKrupinski commented Feb 1, 2025 • edited by st3iny Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

ChristophWurst left a comment

Choose a reason for hiding this comment

Uh oh!

st3iny left a comment

Choose a reason for hiding this comment

Uh oh!

SebastianKrupinski commented Feb 17, 2025

Uh oh!

SebastianKrupinski commented Feb 17, 2025

Uh oh!

st3iny commented Feb 17, 2025

Uh oh!

kesselb commented Feb 17, 2025

Uh oh!

SebastianKrupinski commented Feb 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

st3iny left a comment

Choose a reason for hiding this comment

Uh oh!

ChristophWurst commented May 13, 2025

Uh oh!

SebastianKrupinski commented Jun 2, 2025

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

st3iny Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

st3iny Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

st3iny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ChristophWurst commented Sep 15, 2025

Uh oh!

SebastianKrupinski commented Sep 15, 2025

Uh oh!

SebastianKrupinski commented Feb 1, 2025 •

edited by st3iny

Loading

SebastianKrupinski commented Feb 17, 2025 •

edited

Loading

st3iny Aug 6, 2025 •

edited

Loading

st3iny Aug 6, 2025 •

edited

Loading