Implement get ocm invites route.

Author: redblom

Makefile

@@ -2,8 +2,10 @@
 # SPDX-FileCopyrightText: 2015-2016 ownCloud, Inc. 
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
-app_name=$(notdir $(CURDIR))
-project_directory=$(CURDIR)/../$(app_name)
+app_name="contacts"
+project_folder="nextcloud-contacts"
+
+project_directory=$(CURDIR)/../$(project_folder)
 appstore_build_directory=$(CURDIR)/build/artifacts
 appstore_package_name=$(appstore_build_directory)/$(app_name)
 
@@ -20,3 +22,55 @@ clean-dev:
 # Builds the source package for the app store, ignores php and js tests
 appstore:
 	krankerl package
+
+# Builds the source package for the app store, ignores php and js tests
+# command: make version={version_number} buildapp
+# concatenate cd, ls and tar commands with '&&' otherwise the script context will remain the root instead of build
+.PHONY: buildapp
+buildapp:
+	make check-version
+
+	version=$(version)
+
+	make clean-buildapp
+
+	mkdir -p $(appstore_build_directory)
+	cd build &&	\
+	ln -s ../ $(app_name) && \
+	tar cvzfh $(appstore_build_directory)/$(app_name)_$(version).tar.gz \
+	--exclude="$(app_name)/build" \
+	--exclude="$(app_name)/release" \
+	--exclude="$(app_name)/tests" \
+	--exclude="$(app_name)/src" \
+	--exclude="$(app_name)/tests" \
+	--exclude="$(app_name)/vite.config.js" \
+	--exclude="$(app_name)/*.log" \
+	--exclude="$(app_name)/phpunit*xml" \
+	--exclude="$(app_name)/composer.*" \
+	--exclude="$(app_name)/node_modules" \
+	--exclude="$(app_name)/js/node_modules" \
+	--exclude="$(app_name)/js/tests" \
+	--exclude="$(app_name)/js/test" \
+	--exclude="$(app_name)/js/*.log" \
+	--exclude="$(app_name)/js/package.json" \
+	--exclude="$(app_name)/js/bower.json" \
+	--exclude="$(app_name)/js/karma.*" \
+	--exclude="$(app_name)/js/protractor.*" \
+	--exclude="$(app_name)/package.json" \
+	--exclude="$(app_name)/bower.json" \
+	--exclude="$(app_name)/karma.*" \
+	--exclude="$(app_name)/protractor\.*" \
+	--exclude="$(app_name)/.*" \
+	--exclude="$(app_name)/js/.*" \
+	--exclude-vcs \
+	$(app_name) && \
+	rm $(app_name)
+
+clean-buildapp:
+	rm -rf ${appstore_build_directory}
+
+check-version:
+	@if [ "${version}" = "" ]; then\
+		echo "Error: You must set version, eg. make -e version=v0.0.1 buildapp";\
+		exit 1;\
+	fi

appinfo/routes.php

@@ -14,8 +14,9 @@
 		['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#create_invite', 'url' => '/ocm/invitations', 'verb' => 'POST'],
-		['name' => 'federated_invites#invite_accepted', 'url' => '/ocm/invitations/accept', 'verb' => 'PATCH'],
+		['name' => 'federated_invites#invite_accepted', 'url' => '/ocm/invitations/{token}/accept', 'verb' => 'PATCH'],
 		['name' => 'federated_invites#invite_accept_dialog', 'url' => $inviteAcceptDialogPath, 'verb' => 'GET'],
 
 		['name' => 'page#index', 'url' => '/', 'verb' => 'GET'],

lib/AppInfo/Application.php

@@ -6,8 +6,10 @@
  */
 namespace OCA\Contacts\AppInfo;
 
+use OCA\CloudFederationAPI\Events\FederatedInviteAcceptedEvent;
 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\Files\Event\LoadAdditionalScriptsEvent;
@@ -32,6 +34,7 @@ public function __construct() {
 	public function register(IRegistrationContext $context): void {
 		$context->registerEventListener(LoadAdditionalScriptsEvent::class, LoadContactsFilesActions::class);
 		$context->registerEventListener(LoadContactsOcaApiEvent::class, LoadContactsOcaApi::class);
+		$context->registerEventListener(FederatedInviteAcceptedEvent::class, FederatedInviteAcceptedListener::class);
 	}
 
 	public function boot(IBootContext $context): void {

lib/Controller/FederatedInvitesController.php

@@ -10,15 +10,18 @@
 use Exception;
 use OC\App\CompareVersion;
 use OCA\DAV\CardDAV\CardDavBackend;
-use OCA\CloudFederationAPI\Db\FederatedInviteMapper;
 use OCA\Contacts\AppInfo\Application;
+use OCA\Contacts\Db\FederatedInvite;
+use OCA\Contacts\Db\FederatedInviteMapper;
+use OCA\Contacts\Service\FederatedInvitesService;
 use OCA\Contacts\Service\GroupSharingService;
 use OCA\Contacts\Service\SocialApiService;
 use OCA\FederatedFileSharing\AddressHandler;
 use OCP\App\IAppManager;
 use OCP\AppFramework\Http;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\Http\TemplateResponse;
+use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\Contacts\IManager;
 use OCP\Http\Client\IClientService;
 use OCP\IConfig;
@@ -30,6 +33,7 @@
 use OCP\IUserSession;
 use OCP\L10N\IFactory;
 use Psr\Log\LoggerInterface;
+use Sabre\DAV\UUIDUtil;
 
 /**
  * Controller for federated invites related routes.
@@ -43,24 +47,27 @@ public function __construct(
 		IRequest $request,
 		private AddressHandler $addressHandler,
 		private CardDavBackend $cardDavBackend,
+		private FederatedInviteMapper $federatedInviteMapper,
+		private FederatedInvitesService $federatedInvitesService,
+		private IAppManager $appManager,
 		private IClientService $httpClient,
 		private IConfig $config,
 		private IInitialStateService $initialStateService,
 		private IFactory $languageFactory,
 		private IManager $contactsManager,
 		private IUserSession $userSession,
 		private SocialApiService $socialApiService,
-		private IAppManager $appManager,
+		private ITimeFactory $timeFactory,
 		private CompareVersion $compareVersion,
 		private GroupSharingService $groupSharingService,
 		private IL10N $il10,
 		private IURLGenerator $urlGenerator,
 		private IUserManager $userManager,
-		private FederatedInviteMapper $federatedInviteMapper,
 		private LoggerInterface $logger,
 	) {
 		parent::__construct(
 			$request,
+			$federatedInvitesService,
 			$config,
 			$initialStateService,
 			$languageFactory,
@@ -73,6 +80,28 @@ public function __construct(
 		);
 	}
 
+	/**
+	 * @NoAdminRequired
+	 * @NoCSRFRequired
+	 *
+	 * Returns all open (not yet accepted) invites.
+	 * 
+	 * @return DataResponse
+	 */
+	public function getInvites(): DataResponse {
+		$_invites = $this->federatedInviteMapper->findOpenInvitesByUiddd($this->userSession->getUser()->getUID());
+		$invites = [];
+		foreach ($_invites as $invite) {
+			if ($invite instanceof FederatedInvite) {
+				array_push(
+					$invites, 
+					$invite->jsonSerialize()
+				);
+			}
+		}
+		return new DataResponse($invites, Http::STATUS_OK);
+	}
+
 	/**
 	 * @NoAdminRequired
 	 * @NoCSRFRequired
@@ -82,9 +111,7 @@ public function __construct(
 	 * @param string $token
 	 * @param string $provider
 	 */
-	public function inviteAcceptDialog(string $token = "", string $provider = ""): TemplateResponse
-	{
-		$this->logger->debug(" - FederatedInvitesController inviteAcceptDialog method: setting initial state ($token, $provider) and returning PageController index ", ['app' => Application::APP_ID]);
+	public function inviteAcceptDialog(string $token = "", string $provider = ""): TemplateResponse {
 		$this->initialStateService->provideInitialState(Application::APP_ID, 'inviteToken', $token);
 		$this->initialStateService->provideInitialState(Application::APP_ID, 'inviteProvider', $provider);
 		// TODO read from config
@@ -99,11 +126,29 @@ public function inviteAcceptDialog(string $token = "", string $provider = ""): T
 	 *
 	 * Creates an invitation to exchange contact info for the user with the specified uid.
 	 * 
-	 * @return DataResponse 
+	 * @param string $email the recipient email to send the invitation to
+	 * @param string $message the optional message to send with the invitation 
+	 * @return DataResponse with data signature ['token' | 'error'] - the token of the invitation or an error message in case of error
 	 */
-	public function createInvite(string $uid = ''): DataResponse
-	{
-		return new DataResponse(['message' => "Route not implemented"], Http::STATUS_NOT_IMPLEMENTED);
+	public function createInvite(string $email = null, string $message = null): DataResponse {
+		if(!isset($email)) {
+			return new DataResponse(['error' => 'Recipient email is required'], Http::STATUS_BAD_REQUEST);
+		}
+		$invite = new FederatedInvite();
+		$invite->setUserId($this->userSession->getUser()->getUID());
+		$token = UUIDUtil::getUUID();
+		$invite->setToken($token);
+		$invite->setCreatedAt($this->timeFactory->getTime());
+		// TODO get expiration period from config
+		// take 30 days
+		$invite->setExpiredAt($invite->getCreatedAt() + 2592000000);
+		$invite->setRecipientEmail($email);
+		$invite->setAccepted(false);
+		$this->federatedInviteMapper->insert($invite);
+
+		// TODO send email
+
+		return new DataResponse(['token' => $token], Http::STATUS_OK);
 	}
 
 	/**
@@ -115,12 +160,12 @@ public function createInvite(string $uid = ''): DataResponse
 	 * 
 	 * @param string $token the token of the invite
 	 * @param string $provider the provider of the sender of the invite 
-	 * @return DataResponse with data signature ['contact' | 'message'] - the new contact url or a message in case of error
+	 * @return DataResponse with data signature ['contact' | 'error'] - the new contact url or an error message in case of error
 	 */
 	public function inviteAccepted(string $token = "", string $provider = ""): DataResponse {
 		if ($token === "" || $provider === "") {
 			$this->logger->error("Both token and provider must be specified. Received: token=$token, provider=$provider", ['app' => Application::APP_ID]);
-			return new DataResponse(['message' => 'Both token and provider must be specified.'], Http::STATUS_NOT_FOUND);
+			return new DataResponse(['error' => 'Both token and provider must be specified.'], Http::STATUS_NOT_FOUND);
 		}
 		try {
 			// delegate further to OCM /invite-accepted
@@ -147,14 +192,14 @@ public function inviteAccepted(string $token = "", string $provider = ""): DataR
 			$responseData = $response->getBody();
 			$data = json_decode($responseData, true);
 			$newContact = $this->socialApiService->createFederatedContact(
-				// nextcloud cloud id format, ie. the ocm address
+				// the ocm address: nextcloud cloud id format
 				$data['userID'] . "@" . $this->addressHandler->removeProtocolFromUrl($provider),
 				$data['email'],
 				$data['name'],
 				$localUser->getUID(),
 			);
 			if (!isset($newContact)) {
-				return new DataResponse(['message' => 'An unexpected error occurred trying to accept invite: could not create new contact'], Http::STATUS_NOT_FOUND);
+				return new DataResponse(['error' => 'An unexpected error occurred trying to accept invite: could not create new contact'], Http::STATUS_NOT_FOUND);
 			}
 			$this->logger->info("Created new contact with UID: " . $newContact['UID'] . " for user with UID: " . $localUser->getUID(), ['app' => Application::APP_ID]);
 
@@ -172,15 +217,15 @@ public function inviteAccepted(string $token = "", string $provider = ""): DataR
 			$statusCode = $e->getCode();
 			switch ($statusCode) {
 				case Http::STATUS_BAD_REQUEST:
-					return new DataResponse(['message' => 'Invalid, non existing or expired token'], $e->getCode());
+					return new DataResponse(['error' => 'Invalid, non existing or expired token'], $e->getCode());
 				case Http::STATUS_CONFLICT:
-					return new DataResponse(['message' => 'Invite already accepted'], $e->getCode());
+					return new DataResponse(['error' => 'Invite already accepted'], $e->getCode());
 			}
 			$this->logger->error("An unexpected error occurred accepting invite with token=$token and provider=$provider. Stacktrace: " . $e->getTraceAsString(), ['app' => Application::APP_ID]);
-			return new DataResponse(['message' => 'An unexpected error occurred trying to accept invite.'], Http::STATUS_NOT_FOUND);
+			return new DataResponse(['error' => 'An unexpected error occurred trying to accept invite.'], Http::STATUS_NOT_FOUND);
 		} catch (Exception $e) {
 			$this->logger->error("An unexpected error occurred accepting invite with token=$token and provider=$provider. Stacktrace: " . $e->getTraceAsString(), ['app' => Application::APP_ID]);
-			return new DataResponse(['message' => 'An unexpected error occurred trying to accept invite'], Http::STATUS_NOT_FOUND);
+			return new DataResponse(['error' => 'An unexpected error occurred trying to accept invite'], Http::STATUS_NOT_FOUND);
 		}
 	}
 }

lib/Controller/PageController.php

@@ -9,6 +9,7 @@
 
 use OC\App\CompareVersion;
 use OCA\Contacts\AppInfo\Application;
+use OCA\Contacts\Service\FederatedInvitesService;
 use OCA\Contacts\Service\GroupSharingService;
 use OCA\Contacts\Service\SocialApiService;
 use OCP\App\IAppManager;
@@ -25,6 +26,7 @@ class PageController extends Controller {
 
 	public function __construct(
 		IRequest $request,
+		private FederatedInvitesService $federatedInvitesService,
 		private IConfig $config,
 		private IInitialStateService $initialStateService,
 		private IFactory $languageFactory,
@@ -67,6 +69,7 @@ public function index(): TemplateResponse {
 		$isTalkEnabled = $this->appManager->isEnabledForUser('spreed') === true;
 
 		$isTalkVersionCompatible = $this->compareVersion->isCompatible($talkVersion ? $talkVersion : '0.0.0', 2);
+		$isOcmInvitesEnabled = $this->federatedInvitesService->isOcmInvitesEnabled();
 
 		$this->initialStateService->provideInitialState(Application::APP_ID, 'isGroupSharingEnabled', $isGroupSharingEnabled);
 		$this->initialStateService->provideInitialState(Application::APP_ID, 'locales', $locales);
@@ -77,6 +80,7 @@ public function index(): TemplateResponse {
 		$this->initialStateService->provideInitialState(Application::APP_ID, 'isContactsInteractionEnabled', $isContactsInteractionEnabled);
 		$this->initialStateService->provideInitialState(Application::APP_ID, 'isCirclesEnabled', $isCirclesEnabled && $isCircleVersionCompatible);
 		$this->initialStateService->provideInitialState(Application::APP_ID, 'isTalkEnabled', $isTalkEnabled && $isTalkVersionCompatible);
+		$this->initialStateService->provideInitialState(Application::APP_ID, 'isOcmInvitesEnabled', $isOcmInvitesEnabled);
 
 		Util::addStyle(Application::APP_ID, 'contacts-main');
 		Util::addScript(Application::APP_ID, 'contacts-main');

lib/Db/FederatedInvite.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Contacts\Db;
+
+use OCA\CloudFederationAPI\Db\FederatedInvite as DbFederatedInvite;
+
+class FederatedInvite extends DbFederatedInvite {
+
+	public function __construct() {
+	}
+	public function jsonSerialize(): array {
+		return [
+			'accepted' => $this->accepted,
+			'acceptedAt' => $this->acceptedAt,
+			'createdAt' => $this->createdAt,
+			'expiredAt' => $this->expiredAt,
+			'recipientEmail' => $this->recipientEmail,
+			'recipientName' => $this->recipientName,
+			'recipientProvider' => $this->recipientProvider,
+			'recipientUserId' => $this->recipientUserId,
+			'token' => $this->token,
+			'userId' => $this->userId,
+		];
+	}
+
+}

lib/Db/FederatedInviteMapper.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Contacts\Db;
+
+use OCA\CloudFederationAPI\Db\FederatedInviteMapper as DbFederatedInviteMapper;
+use OCP\DB\QueryBuilder\IQueryBuilder;
+use OCP\IDBConnection;
+use Psr\Log\LoggerInterface;
+
+/**
+ * @template-extends QBMapper<FederatedInvite>
+ */
+class FederatedInviteMapper extends DbFederatedInviteMapper {
+
+   	public function __construct(
+        IDBConnection $db,
+        private LoggerInterface $logger,
+    ) {
+		parent::__construct($db, self::TABLE_NAME);
+	}
+
+    /**
+     * Returns all open federated invites of the specified user
+     * 
+     * @return array a list of FederatedInvite objects
+     */
+	public function findOpenInvitesByUiddd(string $userId):array {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('*')
+			->from(self::TABLE_NAME)
+			->where($qb->expr()->eq('user_id', $qb->createNamedParameter($userId)))
+            ->andWhere($qb->expr()->eq('accepted', $qb->createNamedParameter(false, IQueryBuilder::PARAM_BOOL)));
+		$entities = $this->findEntities($qb);
+        foreach($entities as $entity) {
+            $this->logger->debug(get_class($entity));
+        }
+        return $entities;
+	}
+
+}