feat(OCM-Invites): Implement exchanging cloud IDs through OCM invitation workflow

see https://github.com/cs3org/OCM-API/blob/v1.2.1/IETF-RFC.md

Features:
 - Button to invite remote users to exchange cloudIDs.
 - Button to manually accept invite to exchange cloudIDs.
 - WAYF page allowing the receiver of the invite to open and accept the invitation.
 - Listing of open invitations.
 - Option to resend, revoke open invitations.

Signed-off-by: Antoon P. <antoon.prins@surf.nl>
Co-authored-by: Micke Nordin <kano@sunet.se>

Author: redblom

appinfo/info.xml

@@ -49,6 +49,7 @@
 
 	<background-jobs>
 		<job>OCA\Contacts\Cron\SocialUpdateRegistration</job>
+		<job>OCA\Contacts\Cron\UpdateOcmProviders</job>
 	</background-jobs>
 
 	<settings>
@@ -67,4 +68,10 @@
 	<contactsmenu>
 		<provider>OCA\Contacts\ContactsMenu\Providers\DetailsProvider</provider>
 	</contactsmenu>
+
+	<commands>
+		<command>OCA\Contacts\Command\EnableOcmInvites</command>
+		<command>OCA\Contacts\Command\DisableOcmInvites</command>
+		<command>OCA\Contacts\Command\SetMeshProvidersService</command>
+	</commands>
 </info>

appinfo/routes.php

@@ -5,10 +5,22 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
+use OCA\Contacts\Service\FederatedInvitesService;
+
 return [
 	'routes' => [
 		['name' => 'contacts#direct', 'url' => '/direct/contact/{contact}', 'verb' => 'GET'],
 		['name' => 'contacts#directcircle', 'url' => '/direct/circle/{singleId}', 'verb' => 'GET'],
+
+		['name' => 'federated_invites#get_invites', 'url' => '/ocm/invitations', 'verb' => 'GET'],
+		['name' => 'federated_invites#delete_invite', 'url' => '/ocm/invitations/{token}', 'verb' => 'DELETE'],
+		['name' => 'federated_invites#create_invite', 'url' => '/ocm/invitations', 'verb' => 'POST'],
+		['name' => 'federated_invites#accept_invite', 'url' => '/ocm/invitations/{token}/accept', 'verb' => 'PATCH'],
+		['name' => 'federated_invites#resend_invite', 'url' => '/ocm/invitations/{token}/resend', 'verb' => 'PATCH'],
+		['name' => 'federated_invites#invite_accept_dialog', 'url' => FederatedInvitesService::OCM_INVITE_ACCEPT_DIALOG_ROUTE, 'verb' => 'GET'],
+		['name' => 'federated_invites#wayf', 'url' => '/wayf', 'verb' => 'GET'],
+		['name' => 'federated_invites#discover', 'url' => '/discover', 'verb' => 'GET'],
+
 		['name' => 'page#index', 'url' => '/', 'verb' => 'GET'],
 		['name' => 'page#index', 'url' => '/{group}', 'verb' => 'GET', 'postfix' => 'group'],
 		['name' => 'page#index', 'url' => '/{group}/{contact}', 'verb' => 'GET', 'postfix' => 'group.contact'],

lib/AppInfo/Application.php

@@ -9,15 +9,19 @@
 use OCA\Contacts\Capabilities;
 use OCA\Contacts\Dav\PatchPlugin;
 use OCA\Contacts\Event\LoadContactsOcaApiEvent;
+use OCA\Contacts\Listener\FederatedInviteAcceptedListener;
 use OCA\Contacts\Listener\LoadContactsFilesActions;
 use OCA\Contacts\Listener\LoadContactsOcaApi;
+use OCA\Contacts\Listener\OcmDiscoveryListener;
 use OCA\DAV\Events\SabrePluginAddEvent;
 use OCA\Files\Event\LoadAdditionalScriptsEvent;
 use OCP\AppFramework\App;
 use OCP\AppFramework\Bootstrap\IBootContext;
 use OCP\AppFramework\Bootstrap\IBootstrap;
 use OCP\AppFramework\Bootstrap\IRegistrationContext;
 use OCP\EventDispatcher\IEventDispatcher;
+use OCP\OCM\Events\LocalOCMDiscoveryEvent;
+use OCP\OCM\Events\OCMEndpointRequestEvent;
 
 class Application extends App implements IBootstrap {
 	public const APP_ID = 'contacts';
@@ -33,8 +37,11 @@ public function __construct() {
 	#[\Override]
 	public function register(IRegistrationContext $context): void {
 		$context->registerCapability(Capabilities::class);
+
 		$context->registerEventListener(LoadAdditionalScriptsEvent::class, LoadContactsFilesActions::class);
 		$context->registerEventListener(LoadContactsOcaApiEvent::class, LoadContactsOcaApi::class);
+		$context->registerEventListener(OCMEndpointRequestEvent::class, FederatedInviteAcceptedListener::class);
+		$context->registerEventListener(LocalOCMDiscoveryEvent::class, OcmDiscoveryListener::class);
 	}
 
 	#[\Override]

lib/Command/DisableOcmInvites.php

@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+namespace OCA\Contacts\Command;
+
+use OC\Core\AppInfo\ConfigLexicon;
+use OCP\IAppConfig;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class DisableOcmInvites extends Command {
+	public function __construct(
+		protected IAppConfig $appConfig,
+	) {
+		parent::__construct();
+	}
+
+	protected function configure(): void {
+		$this
+			->setName('contacts:disable-ocm-invites')
+			->setDescription('Disable OCM Invites.');
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		$isEnabled = $this->appConfig->getValueBool('contacts', 'ocm_invites_enabled');
+		if (!$isEnabled) {
+			$output->writeln('OCM Invites already disabled.');
+			return self::SUCCESS;
+		}
+
+		$this->appConfig->setValueBool('contacts', 'ocm_invites_enabled', false);
+		$this->appConfig->deleteKey('core', ConfigLexicon::OCM_INVITE_ACCEPT_DIALOG);
+		$output->writeln('OCM Invites successfully disabled.');
+		return self::SUCCESS;
+	}
+}

lib/Command/EnableOcmInvites.php

@@ -0,0 +1,42 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+namespace OCA\Contacts\Command;
+
+use OCP\IAppConfig;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class EnableOcmInvites extends Command {
+	public function __construct(
+		protected IAppConfig $appConfig,
+	) {
+		parent::__construct();
+	}
+
+	protected function configure(): void {
+		$this
+			->setName('contacts:enable-ocm-invites')
+			->setDescription('Enable OCM Invites.');
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		$isAlreadyEnabled = $this->appConfig->getValueBool('contacts', 'ocm_invites_enabled');
+
+		if ($isAlreadyEnabled) {
+			$output->writeln('OCM Invites already enabled.');
+			return self::SUCCESS;
+		}
+
+		$this->appConfig->setValueBool('contacts', 'ocm_invites_enabled', true);
+		$this->appConfig->setValueString('core', 'ocm_invite_accept_dialog', 'contacts.federated_invites.invite_accept_dialog');
+
+		$output->writeln('OCM Invites successfully enabled.');
+		return self::SUCCESS;
+	}
+}

lib/Command/SetMeshProvidersService.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+namespace OCA\Contacts\Command;
+
+use OCP\IConfig;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class SetMeshProvidersService extends Command {
+
+	public function __construct(
+		protected IConfig $config,
+	) {
+		parent::__construct();
+	}
+
+	protected function configure(): void {
+		$this->setName('contacts:set-mesh-providers-service');
+		$this->addArgument(
+			'mesh-providers-service',
+			InputArgument::REQUIRED,
+			'The URL to the OCM Discovery Service'
+		);
+	}
+
+	public function execute(InputInterface $input, OutputInterface $output): int {
+		$disco = $input->getArgument('mesh-providers-service');
+		$this->config->setAppValue('contacts', 'mesh_providers_service', $disco);
+		$output->writeln('OCM Discovery Service successfully configured.');
+		return self::SUCCESS;
+	}
+}