feat(contactsinteraction): allow users to disable contacts interactio…

…n addressbook

This allows simple users to opt-out of the contacts interaction
addressbook even if admins have the app installed.

Similar to how the birthday calendar works, the functionnality can be
toggled in the user's settings or by doing a DELETE on the addressbook.

A new contacts personal section has been added to contain this new
setting.

Signed-off-by: Thomas Citharel <[email protected]>

apps/contactsinteraction/appinfo/info.xml

@@ -30,5 +30,11 @@
 		<address-book-plugins>
 			<plugin>OCA\ContactsInteraction\AddressBookProvider</plugin>
 		</address-book-plugins>
+		<plugins>
+			<plugin>OCA\ContactsInteraction\DAV\Plugin</plugin>
+		</plugins>
 	</sabre>
+	<settings>
+		<personal>OCA\ContactsInteraction\Settings\Personal</personal>
+	</settings>
 </info>

apps/contactsinteraction/appinfo/routes.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2023 Thomas Citharel <[email protected]>
+ *
+ * @author Thomas Citharel <[email protected]>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+return [
+	'ocs' => [
+		['name' => 'config#disable', 'url' => '/config/user/disable', 'verb' => 'POST'],
+	],
+];

apps/contactsinteraction/composer/composer/autoload_classmap.php

@@ -12,9 +12,12 @@
     'OCA\\ContactsInteraction\\AppInfo\\Application' => $baseDir . '/../lib/AppInfo/Application.php',
     'OCA\\ContactsInteraction\\BackgroundJob\\CleanupJob' => $baseDir . '/../lib/BackgroundJob/CleanupJob.php',
     'OCA\\ContactsInteraction\\Card' => $baseDir . '/../lib/Card.php',
+    'OCA\\ContactsInteraction\\DAV\\Plugin' => $baseDir . '/../lib/DAV/Plugin.php',
     'OCA\\ContactsInteraction\\Db\\CardSearchDao' => $baseDir . '/../lib/Db/CardSearchDao.php',
     'OCA\\ContactsInteraction\\Db\\RecentContact' => $baseDir . '/../lib/Db/RecentContact.php',
     'OCA\\ContactsInteraction\\Db\\RecentContactMapper' => $baseDir . '/../lib/Db/RecentContactMapper.php',
     'OCA\\ContactsInteraction\\Listeners\\ContactInteractionListener' => $baseDir . '/../lib/Listeners/ContactInteractionListener.php',
+    'OCA\\ContactsInteraction\\Listeners\\UserPreferenceListener' => $baseDir . '/../lib/Listeners/UserPreferenceListener.php',
     'OCA\\ContactsInteraction\\Migration\\Version010000Date20200304152605' => $baseDir . '/../lib/Migration/Version010000Date20200304152605.php',
+    'OCA\\ContactsInteraction\\Settings\\Personal' => $baseDir . '/../lib/Settings/Personal.php',
 );

apps/contactsinteraction/composer/composer/autoload_static.php

@@ -27,11 +27,14 @@ class ComposerStaticInitContactsInteraction
         'OCA\\ContactsInteraction\\AppInfo\\Application' => __DIR__ . '/..' . '/../lib/AppInfo/Application.php',
         'OCA\\ContactsInteraction\\BackgroundJob\\CleanupJob' => __DIR__ . '/..' . '/../lib/BackgroundJob/CleanupJob.php',
         'OCA\\ContactsInteraction\\Card' => __DIR__ . '/..' . '/../lib/Card.php',
+        'OCA\\ContactsInteraction\\DAV\\Plugin' => __DIR__ . '/..' . '/../lib/DAV/Plugin.php',
         'OCA\\ContactsInteraction\\Db\\CardSearchDao' => __DIR__ . '/..' . '/../lib/Db/CardSearchDao.php',
         'OCA\\ContactsInteraction\\Db\\RecentContact' => __DIR__ . '/..' . '/../lib/Db/RecentContact.php',
         'OCA\\ContactsInteraction\\Db\\RecentContactMapper' => __DIR__ . '/..' . '/../lib/Db/RecentContactMapper.php',
         'OCA\\ContactsInteraction\\Listeners\\ContactInteractionListener' => __DIR__ . '/..' . '/../lib/Listeners/ContactInteractionListener.php',
+        'OCA\\ContactsInteraction\\Listeners\\UserPreferenceListener' => __DIR__ . '/..' . '/../lib/Listeners/UserPreferenceListener.php',
         'OCA\\ContactsInteraction\\Migration\\Version010000Date20200304152605' => __DIR__ . '/..' . '/../lib/Migration/Version010000Date20200304152605.php',
+        'OCA\\ContactsInteraction\\Settings\\Personal' => __DIR__ . '/..' . '/../lib/Settings/Personal.php',
     );
 
     public static function getInitializer(ClassLoader $loader)

apps/contactsinteraction/lib/AddressBookProvider.php

@@ -12,15 +12,16 @@
 use OCA\ContactsInteraction\Db\RecentContactMapper;
 use OCA\DAV\CardDAV\Integration\ExternalAddressBook;
 use OCA\DAV\CardDAV\Integration\IAddressBookProvider;
+use OCP\IConfig;
 use OCP\IL10N;
 
 class AddressBookProvider implements IAddressBookProvider {
 
 	public function __construct(
 		private RecentContactMapper $mapper,
 		private IL10N $l10n,
-	) {
-	}
+		private IConfig $config
+	) {	}
 
 	/**
 	 * @inheritDoc
@@ -33,6 +34,9 @@ public function getAppId(): string {
 	 * @inheritDoc
 	 */
 	public function fetchAllForAddressBookHome(string $principalUri): array {
+		if ($this->disabledForPrincipal($principalUri)) {
+			return [];
+		}
 		return [
 			new AddressBook($this->mapper, $this->l10n, $principalUri)
 		];
@@ -42,17 +46,29 @@ public function fetchAllForAddressBookHome(string $principalUri): array {
 	 * @inheritDoc
 	 */
 	public function hasAddressBookInAddressBookHome(string $principalUri, string $uri): bool {
-		return $uri === AddressBook::URI;
+		return $uri === AddressBook::URI && !$this->disabledForPrincipal($principalUri);
 	}
 
 	/**
 	 * @inheritDoc
 	 */
 	public function getAddressBookInAddressBookHome(string $principalUri, string $uri): ?ExternalAddressBook {
-		if ($uri === AddressBook::URI) {
+		if ($uri === AddressBook::URI && !$this->disabledForPrincipal($principalUri)) {
 			return new AddressBook($this->mapper, $this->l10n, $principalUri);
 		}
 
 		return null;
 	}
+
+	private function disabledForPrincipal(string $principalUri): bool {
+		$userId = $this->principalToUserId($principalUri);
+		return $userId !== null && $this->config->getUserValue($userId, Application::APP_ID, 'disableContactsInteractionAddressBook', 'no') === 'yes';
+	}
+
+	private function principalToUserId(string $userPrincipal):?string {
+		if (str_starts_with($userPrincipal, 'principals/users/')) {
+			return substr($userPrincipal, 17);
+		}
+		return null;
+	}
 }

apps/contactsinteraction/lib/AppInfo/Application.php

@@ -9,10 +9,13 @@
 namespace OCA\ContactsInteraction\AppInfo;
 
 use OCA\ContactsInteraction\Listeners\ContactInteractionListener;
+use OCA\ContactsInteraction\Listeners\UserPreferenceListener;
 use OCP\AppFramework\App;
 use OCP\AppFramework\Bootstrap\IBootContext;
 use OCP\AppFramework\Bootstrap\IBootstrap;
 use OCP\AppFramework\Bootstrap\IRegistrationContext;
+use OCP\Config\BeforePreferenceDeletedEvent;
+use OCP\Config\BeforePreferenceSetEvent;
 use OCP\Contacts\Events\ContactInteractedWithEvent;
 
 class Application extends App implements IBootstrap {
@@ -24,6 +27,9 @@ public function __construct() {
 
 	public function register(IRegistrationContext $context): void {
 		$context->registerEventListener(ContactInteractedWithEvent::class, ContactInteractionListener::class);
+
+		$context->registerEventListener(BeforePreferenceDeletedEvent::class, UserPreferenceListener::class);
+		$context->registerEventListener(BeforePreferenceSetEvent::class, UserPreferenceListener::class);
 	}
 
 	public function boot(IBootContext $context): void {

apps/contactsinteraction/lib/DAV/Plugin.php

@@ -0,0 +1,110 @@
+<?php
+/**
+ * @copyright 2023, Thomas Citharel <[email protected]>
+ *
+ * @author Thomas Citharel <[email protected]>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+namespace OCA\ContactsInteraction\DAV;
+
+use OCA\ContactsInteraction\AddressBook;
+use OCA\ContactsInteraction\AppInfo\Application;
+use OCA\ContactsInteraction\Db\RecentContactMapper;
+use OCP\IConfig;
+use Sabre\DAV\Server;
+use Sabre\DAV\ServerPlugin;
+use Sabre\HTTP\RequestInterface;
+use Sabre\HTTP\ResponseInterface;
+
+/**
+ * Allows users to disable the feature by deleting the addressbook
+ *
+ * @package OCA\DAV\CalDAV\BirthdayCalendar
+ */
+class Plugin extends ServerPlugin {
+
+	protected Server $server;
+
+	public function __construct(protected IConfig $config, protected RecentContactMapper $recentContactMapper) {
+	}
+
+	/**
+	 * This method should return a list of server-features.
+	 *
+	 * This is for example 'versioning' and is added to the DAV: header
+	 * in an OPTIONS response.
+	 *
+	 * @return string[]
+	 */
+	public function getFeatures() {
+		return ['nc-disable-recently-contacted'];
+	}
+
+	/**
+	 * Returns a plugin name.
+	 *
+	 * Using this name other plugins will be able to access other plugins
+	 * using Sabre\DAV\Server::getPlugin
+	 *
+	 * @return string
+	 */
+	public function getPluginName() {
+		return 'nc-disable-recently-contacted';
+	}
+
+	/**
+	 * This initializes the plugin.
+	 *
+	 * This function is called by Sabre\DAV\Server, after
+	 * addPlugin is called.
+	 *
+	 * This method should set up the required event subscriptions.
+	 *
+	 * @param Server $server
+	 */
+	public function initialize(Server $server) {
+		$this->server = $server;
+
+		$this->server->on('method:DELETE', [$this, 'httpDelete']);
+	}
+
+	/**
+	 * We intercept this to handle POST requests on contacts homes.
+	 *
+	 * @param RequestInterface $request
+	 * @param ResponseInterface $response
+	 *
+	 * @return bool|void
+	 */
+	public function httpDelete(RequestInterface $request, ResponseInterface $response) {
+		$node = $this->server->tree->getNodeForPath($this->server->getRequestUri());
+		if (!($node instanceof AddressBook)) {
+			return;
+		}
+
+		$principalUri = $node->getOwner();
+		$userId = substr($principalUri, 17);
+
+		$this->config->setUserValue($userId, Application::APP_ID, 'disableContactsInteractionAddressBook', 'yes');
+		$this->recentContactMapper->cleanForUser($userId);
+
+		$this->server->httpResponse->setStatus(204);
+
+		return false;
+	}
+}

apps/contactsinteraction/lib/Db/RecentContactMapper.php

@@ -112,4 +112,14 @@ public function cleanUp(int $olderThan): void {
 
 		$delete->executeStatement();
 	}
+
+	public function cleanForUser(string $userId): void {
+		$qb = $this->db->getQueryBuilder();
+
+		$delete = $qb
+			->delete($this->getTableName())
+			->where($qb->expr()->eq('actor_uid', $qb->createNamedParameter($userId)));
+
+		$delete->executeStatement();
+	}
 }

apps/contactsinteraction/lib/Listeners/ContactInteractionListener.php

@@ -8,6 +8,7 @@
  */
 namespace OCA\ContactsInteraction\Listeners;
 
+use OCA\ContactsInteraction\AppInfo\Application;
 use OCA\ContactsInteraction\Db\CardSearchDao;
 use OCA\ContactsInteraction\Db\RecentContact;
 use OCA\ContactsInteraction\Db\RecentContactMapper;
@@ -16,6 +17,7 @@
 use OCP\Contacts\Events\ContactInteractedWithEvent;
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventListener;
+use OCP\IConfig;
 use OCP\IDBConnection;
 use OCP\IL10N;
 use OCP\IUserManager;
@@ -35,6 +37,7 @@ public function __construct(
 		private IDBConnection $dbConnection,
 		private ITimeFactory $timeFactory,
 		private IL10N $l10n,
+		private IConfig $config,
 		private LoggerInterface $logger,
 	) {
 	}
@@ -54,6 +57,11 @@ public function handle(Event $event): void {
 			return;
 		}
 
+		if ($this->config->getUserValue($event->getActor()->getUID(), Application::APP_ID, 'disableContactsInteractionAddressBook', 'no') === 'yes') {
+			$this->logger->debug("Ignoring contact interaction as it's disabled for this user");
+			return;
+		}
+
 		$this->atomic(function () use ($event) {
 			$uid = $event->getUid();
 			$email = $event->getEmail();
@@ -75,9 +83,9 @@ public function handle(Event $event): void {
 				$federatedCloudId
 			);
 			if (!empty($existingRecentlyContacted)) {
-				$now = $this->timeFactory->getTime();
+				$now = $this->timeFactory->now();
 				foreach ($existingRecentlyContacted as $c) {
-					$c->setLastContact($now);
+					$c->setLastContact($now->getTimestamp());
 					$this->mapper->update($c);
 				}
 
@@ -95,7 +103,7 @@ public function handle(Event $event): void {
 			if ($federatedCloudId !== null) {
 				$contact->setFederatedCloudId($federatedCloudId);
 			}
-			$contact->setLastContact($this->timeFactory->getTime());
+			$contact->setLastContact($this->timeFactory->now()->getTimestamp());
 			$contact->setCard($this->generateCard($contact));
 
 			$this->mapper->insert($contact);

apps/contactsinteraction/lib/Listeners/UserPreferenceListener.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCA\ContactsInteraction\Listeners;
+
+use OCA\ContactsInteraction\AppInfo\Application;
+use OCA\ContactsInteraction\Db\RecentContactMapper;
+use OCP\BackgroundJob\IJobList;
+use OCP\Config\BeforePreferenceDeletedEvent;
+use OCP\Config\BeforePreferenceSetEvent;
+use OCP\EventDispatcher\Event;
+use OCP\EventDispatcher\IEventListener;
+
+/** @template-implements IEventListener<BeforePreferenceSetEvent|BeforePreferenceDeletedEvent> */
+class UserPreferenceListener implements IEventListener {
+
+	public function __construct(protected IJobList $jobList, private RecentContactMapper $recentContactMapper) { }
+
+	public function handle(Event $event): void {
+		if (!$event instanceof BeforePreferenceSetEvent && !$event instanceof BeforePreferenceDeletedEvent) {
+			return;
+		}
+
+		if ($event->getAppId() !== Application::APP_ID || $event->getConfigKey() !== 'disableContactsInteractionAddressBook') {
+			return;
+		}
+
+		$enabled = $event->getConfigValue() === 'yes';
+		$event->setValid($enabled);
+		if (!$enabled) {
+			$this->recentContactMapper->cleanForUser($event->getUserId());
+		}
+	}
+}