Federated Sync

appinfo/info.xml

@@ -66,7 +66,7 @@ Those groups of users (or "circles") can then be used by any other app for shari
 		<command>OCA\Circles\Command\MembersDetails</command>
 		<command>OCA\Circles\Command\MembersLevel</command>
 		<command>OCA\Circles\Command\MembersRemove</command>
-		<!--		<command>OCA\Circles\Command\SyncContact</command>-->
+		<command>OCA\Circles\Command\CirclesDebug</command>
 	</commands>
 
 	<!--	<activity>-->

appinfo/routes.php

@@ -101,7 +101,8 @@
 	],
 
 	'routes' => [
-		['name' => 'EventWrapper#asyncBroadcast', 'url' => '/async/{token}/', 'verb' => 'POST'],
+		['name' => 'EventWrapper#asyncBroadcast', 'url' => '/async/broadcast/{token}', 'verb' => 'POST'],
+		['name' => 'EventWrapper#asyncInternal', 'url' => '/async/internal/{token}', 'verb' => 'POST'],
 
 		['name' => 'Remote#appService', 'url' => '/', 'verb' => 'GET'],
 		['name' => 'Remote#test', 'url' => '/test', 'verb' => 'GET'],
@@ -112,6 +113,14 @@
 		['name' => 'Remote#members', 'url' => '/members/{circleId}/', 'verb' => 'GET'],
 		['name' => 'Remote#member', 'url' => '/member/{type}/{userId}/', 'verb' => 'GET'],
 		['name' => 'Remote#inherited', 'url' => '/inherited/{circleId}/', 'verb' => 'GET'],
-		['name' => 'Remote#memberships', 'url' => '/memberships/{circleId}/', 'verb' => 'GET']
+		['name' => 'Remote#memberships', 'url' => '/memberships/{circleId}/', 'verb' => 'GET'],
+
+		['name' => 'Sync#syncItem', 'url' => '/sync/item', 'verb' => 'GET'],
+		['name' => 'Sync#updateSyncedItem', 'url' => '/sync/item', 'verb' => 'PUT'],
+//		['name' => 'Remote#syncItem', 'url' => '/sync/item/{singleId}', 'verb' => 'GET'],
+		['name' => 'Sync#syncShare', 'url' => '/sync/share', 'verb' => 'GET'],
+		['name' => 'Sync#createSyncedShare', 'url' => '/sync/share', 'verb' => 'PUT'],
+		['name' => 'Debug#debugDaemon', 'url' => '/debug', 'verb' => 'POST']
+
 	]
 ];

lib/CircleSharesManager.php

@@ -0,0 +1,318 @@
+<?php
+
+declare(strict_types=1);
+
+
+/**
+ * Circles - Bring cloud-users closer together.
+ *
+ * This file is licensed under the Affero General Public License version 3 or
+ * later. See the COPYING file.
+ *
+ * @author Maxence Lange <[email protected]>
+ * @copyright 2022
+ * @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\Circles;
+
+use Exception;
+use OCA\Circles\Exceptions\CircleSharesManagerException;
+use OCA\Circles\Exceptions\FederatedUserNotFoundException;
+use OCA\Circles\Model\SyncedItemLock;
+use OCA\Circles\Service\CircleService;
+use OCA\Circles\Service\ConfigService;
+use OCA\Circles\Service\DebugService;
+use OCA\Circles\Service\FederatedSyncItemService;
+use OCA\Circles\Service\FederatedSyncService;
+use OCA\Circles\Service\FederatedSyncShareService;
+use OCA\Circles\Service\FederatedUserService;
+use Psr\Container\ContainerExceptionInterface;
+use Psr\Container\NotFoundExceptionInterface;
+
+/**
+ * Class CircleSharesManager
+ *
+ * @package OCA\Circles
+ */
+class CircleSharesManager implements ICircleSharesManager {
+
+
+	private CircleService $circleService;
+	private FederatedUserService $federatedUserService;
+	private FederatedSyncService $federatedSyncService;
+	private FederatedSyncItemService $federatedSyncItemService;
+	private FederatedSyncShareService $federatedSyncShareService;
+	private ConfigService $configService;
+	private DebugService $debugService;
+
+	private string $originAppId = '';
+	private string $originItemType = '';
+
+
+	/**
+	 * @param CircleService $circleService
+	 * @param FederatedUserService $federatedUserService
+	 * @param FederatedSyncService $federatedSyncService
+	 * @param FederatedSyncItemService $federatedSyncItemService
+	 * @param FederatedSyncShareService $federatedSyncShareService
+	 * @param ConfigService $configService
+	 * @param DebugService $debugService
+	 */
+	public function __construct(
+		CircleService $circleService,
+		FederatedUserService $federatedUserService,
+		FederatedSyncService $federatedSyncService,
+		FederatedSyncItemService $federatedSyncItemService,
+		FederatedSyncShareService $federatedSyncShareService,
+		ConfigService $configService,
+		DebugService $debugService
+	) {
+		$this->circleService = $circleService;
+		$this->federatedUserService = $federatedUserService;
+		$this->federatedSyncService = $federatedSyncService;
+		$this->federatedSyncItemService = $federatedSyncItemService;
+		$this->federatedSyncShareService = $federatedSyncShareService;
+		$this->configService = $configService;
+		$this->debugService = $debugService;
+	}
+
+
+	/**
+	 * @param string $syncManager
+	 *
+	 * @throws ContainerExceptionInterface
+	 * @throws NotFoundExceptionInterface
+	 */
+	public function registerFederatedSyncManager(string $syncManager): void {
+		if ($this->originAppId !== '' || $this->originItemType !== '') {
+			return;
+		}
+
+		$federatedSyncManager = \OC::$server->get($syncManager);
+		if (!($federatedSyncManager instanceof IFederatedSyncManager)) {
+			// log something
+			return;
+		}
+
+		$this->federatedSyncService->addFederatedSyncManager($federatedSyncManager);
+	}
+
+
+	/**
+	 * @param string $itemId
+	 * @param string $circleId
+	 * @param array $extraData
+	 *
+	 * @throws CircleSharesManagerException
+	 * @throws Exceptions\CircleNotFoundException
+	 * @throws Exceptions\FederatedSyncConflictException
+	 * @throws Exceptions\FederatedSyncManagerNotFoundException
+	 * @throws Exceptions\InitiatorNotFoundException
+	 * @throws Exceptions\RequestBuilderException
+	 * @throws Exceptions\SyncedSharedAlreadyExistException
+	 */
+	public function createShare(
+		string $itemId,
+		string $circleId,
+		array $extraData = []
+	): void {
+		$this->debugService->setDebugType('federated_sync');
+		$this->debugService->info(
+			'{~New request to create a SyncedShare} based on {appId}.{itemType}.{itemId}',
+			$circleId,
+			[
+				'appId' => $this->originAppId,
+				'itemType' => $this->originItemType,
+				'itemId' => $itemId,
+				'extraData' => $extraData
+			]
+		);
+
+		try {
+			$this->mustHaveOrigin();
+
+			// get valid SyncedItem based on appId, itemType, itemId
+			$syncedItem = $this->federatedSyncItemService->initSyncedItem(
+				$this->originAppId,
+				$this->originItemType,
+				$itemId
+			);
+
+			$this->debugService->info(
+				'initiating the process of sharing {syncedItem.singleId} to {circle.id}',
+				$circleId, [
+					'circleId' => $circleId,
+					'syncedItem' => $syncedItem,
+					'extraData' => $extraData,
+					'isLocal' => $syncedItem->isLocal()
+				]
+			);
+
+			$federatedUser = $this->federatedUserService->getCurrentEntity();
+			if (!$federatedUser->isLocal()) {
+				throw new FederatedUserNotFoundException('unknown local user');
+			}
+
+			$this->federatedSyncShareService->requestSyncedShareCreation(
+				$federatedUser,
+				$syncedItem,
+				$circleId,
+				$extraData
+			);
+		} catch (Exception $e) {
+			$this->debugService->exception($e, $circleId);
+			throw $e;
+		}
+	}
+
+	/**
+	 * @param string $itemId
+	 * @param string $circleId
+	 * @param array $extraData
+	 *
+	 * @throws CircleSharesManagerException
+	 */
+	public function updateShare(
+		string $itemId,
+		string $circleId,
+		array $extraData = []
+	): void {
+	}
+
+	/**
+	 * @param string $itemId
+	 * @param string $circleId
+	 *
+	 * @throws CircleSharesManagerException
+	 */
+	public function deleteShare(string $itemId, string $circleId): void {
+		$this->mustHaveOrigin();
+	}
+
+	/**
+	 * @param string $itemId
+	 * @param string $updateType
+	 * @param string $updateTypeId
+	 * @param array $extraData
+	 * @param bool $sumCheck
+	 *
+	 * @throws CircleSharesManagerException
+	 * @throws Exceptions\FederatedEventException
+	 * @throws Exceptions\FederatedItemException
+	 * @throws Exceptions\FederatedSyncConflictException
+	 * @throws Exceptions\FederatedSyncManagerNotFoundException
+	 * @throws Exceptions\InitiatorNotConfirmedException
+	 * @throws Exceptions\OwnerNotFoundException
+	 * @throws Exceptions\RemoteInstanceException
+	 * @throws Exceptions\RemoteNotFoundException
+	 * @throws Exceptions\RemoteResourceNotFoundException
+	 * @throws Exceptions\RequestBuilderException
+	 * @throws Exceptions\UnknownRemoteException
+	 */
+	public function updateItem(
+		string $itemId,
+		string $updateType = '',
+		string $updateTypeId = '',
+		array $extraData = [],
+		bool $sumCheck = true
+	): void {
+		$this->mustHaveOrigin();
+
+		$this->debugService->setDebugType('federated_sync');
+		$this->debugService->info(
+			'{~New request to update a SyncedItem} based on {appId}.{itemType}.{itemId}',
+			'',
+			[
+				'appId' => $this->originAppId,
+				'itemType' => $this->originItemType,
+				'itemId' => $itemId,
+				'updateType' => $updateType,
+				'updateTypeId' => $updateTypeId,
+				'extraData' => $extraData
+			]
+		);
+
+		try {
+			// get valid SyncedItem based on appId, itemType, itemId
+			$syncedItem = $this->federatedSyncItemService->initSyncedItem(
+				$this->originAppId,
+				$this->originItemType,
+				$itemId
+			);
+
+			$this->debugService->info(
+				'initiating the process of updating SyncedItem {syncedItem.singleId}',
+				'', [
+					'itemId' => $itemId,
+					'syncedItem' => $syncedItem,
+					'extraData' => $extraData,
+					'isLocal' => $syncedItem->isLocal()
+				]
+			);
+
+			$federatedUser = $this->federatedUserService->getCurrentEntity();
+			if (!$federatedUser->isLocal()) {
+				throw new FederatedUserNotFoundException('unknown local user');
+			}
+
+			$this->federatedSyncItemService->requestSyncedItemUpdate(
+				$federatedUser,
+				$syncedItem,
+				new SyncedItemLock($updateType, $updateTypeId, $sumCheck),
+				$extraData
+			);
+		} catch (Exception $e) {
+			$this->debugService->exception($e);
+			throw $e;
+		}
+	}
+
+
+	/**
+	 * @param string $itemId
+	 *
+	 * @throws CircleSharesManagerException
+	 */
+	public function deleteItem(string $itemId): void {
+		$this->mustHaveOrigin();
+	}
+
+
+	/**
+	 * @param string $appId
+	 * @param string $itemType
+	 */
+	public function setOrigin(string $appId, string $itemType) {
+		$this->originAppId = $appId;
+		$this->originItemType = $itemType;
+	}
+
+	/**
+	 * @throws CircleSharesManagerException
+	 */
+	private function mustHaveOrigin(): void {
+		if ($this->originAppId !== '' && $this->originItemType !== '') {
+			return;
+		}
+
+		throw new CircleSharesManagerException(
+			'ICirclesManager::getShareManager(appId, itemType) used empty params'
+		);
+	}
+}