Merge pull request #59982 from nextcloud/backport/59312/stable31

[stable31] Fix removed address book items not being synced between federated instances

apps/dav/lib/CardDAV/CardDavBackend.php

@@ -479,6 +479,13 @@ class CardDavBackend implements BackendInterface, SyncSupport {
 			->from($this->dbCardsTable)
 			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressbookId)));
 
+		return $this->getCardsFromQuery($query);
+	}
+
+	/**
+	 * @return array[]
+	 */
+	private function getCardsFromQuery(IQueryBuilder $query): array {
 		$cards = [];
 
 		$result = $query->executeQuery();
@@ -973,7 +980,8 @@ class CardDavBackend implements BackendInterface, SyncSupport {
 					->from('cards')
 					->where(
 						$qb->expr()->eq('addressbookid', $qb->createNamedParameter($addressBookId))
-					);
+					)
+					->orderBy('id');
 				// No synctoken supplied, this is the initial sync.
 				$qb->setMaxResults($limit);
 				$stmt = $qb->executeQuery();
@@ -1532,4 +1540,32 @@ class CardDavBackend implements BackendInterface, SyncSupport {
 		// should already be handled, but just in case
 		throw new BadRequest('vCard can not be empty');
 	}
+
+	/**
+	 * Mark all cards in an address book as needing to be validated
+	 *
+	 * This is done by setting the modified date to `null`, once a sync runs
+	 * the mtime will be set to a non-null value. Leaving all deleted items with
+	 * a null modified date.
+	 */
+	public function markCardsAsPending(int $addressBookId): void {
+		$query = $this->db->getQueryBuilder();
+		$query->update($this->dbCardsTable)
+			->set('lastmodified', $query->createNamedParameter(null))
+			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+			->executeStatement();
+	}
+
+	/**
+	 * @return array[]
+	 */
+	public function getPendingCards(int $addressBookId): array {
+		$query = $this->db->getQueryBuilder();
+		$query->select(['id', 'addressbookid', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
+			->from($this->dbCardsTable)
+			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+			->andWhere($query->expr()->isNull('lastmodified'));
+
+		return $this->getCardsFromQuery($query);
+	}
 }

apps/dav/lib/CardDAV/SyncService.php

@@ -355,4 +355,15 @@ class SyncService {
 	public static function getCardUri(IUser $user): string {
 		return $user->getBackendClassName() . ':' . $user->getUID() . '.vcf';
 	}
+
+	public function markCardsAsPending(int $addressBookId): void {
+		$this->backend->markCardsAsPending($addressBookId);
+	}
+
+	public function deletePendingCards(int $addressBookId): void {
+		$cards = $this->backend->getPendingCards($addressBookId);
+		foreach ($cards as $card) {
+			$this->backend->deleteCard($addressBookId, $card['uri']);
+		}
+	}
 }

apps/dav/lib/CardDAV/SystemAddressbook.php

@@ -232,7 +232,8 @@ class SystemAddressbook extends AddressBook {
 			return $changed;
 		}
 
-		$added = $modified = $deleted = [];
+		$added = $modified = [];
+		$deleted = array_values($changed['deleted']);
 		foreach ($changed['added'] as $uri) {
 			try {
 				$this->getChild($uri);

apps/dav/tests/unit/CardDAV/SyncServiceTest.php

@@ -5,6 +5,7 @@
  * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
  * SPDX-License-Identifier: AGPL-3.0-only
  */
+
 namespace OCA\DAV\Tests\unit\CardDAV;
 
 use GuzzleHttp\Exception\ClientException;
@@ -100,7 +101,7 @@ class SyncServiceTest extends TestCase {
 			'system',
 			'system',
 			'1234567890',
-			null,
+			'1',
 			'1',
 			'principals/system/system',
 			[]
@@ -171,7 +172,7 @@ END:VCARD';
 			'system',
 			'system',
 			'1234567890',
-			null,
+			'1',
 			'1',
 			'principals/system/system',
 			[]
@@ -242,7 +243,7 @@ END:VCARD';
 			'system',
 			'system',
 			'1234567890',
-			null,
+			'1',
 			'1',
 			'principals/system/system',
 			[]
@@ -283,7 +284,7 @@ END:VCARD';
 			'system',
 			'system',
 			'1234567890',
-			null,
+			'1',
 			'1',
 			'principals/system/system',
 			[]
@@ -292,6 +293,97 @@ END:VCARD';
 		$this->assertEquals('http://sabre.io/ns/sync/4', $token);
 	}
 
+	public function testFullSyncWithOrphanElement(): void {
+		$pendingCards = [];
+		$this->backend->expects($this->exactly(0))
+			->method('createCard');
+		$this->backend->expects($this->exactly(1))
+			->method('updateCard')
+			->willReturnCallback(function ($id, $uri) use (&$pendingCards) {
+				unset($pendingCards[$uri]);
+			});
+		$this->backend->expects($this->exactly(1))
+			->method('markCardsAsPending')
+			->willReturnCallback(function ($id) use (&$pendingCards) {
+				$cards = array_values($this->backend->getCards($id));
+				$uris = array_map(fn ($card) => $card['uri'], $cards);
+				$pendingCards = array_combine($uris, $cards);
+			});
+		$this->backend->expects($this->exactly(1))
+			->method('getPendingCards')
+			->willReturnCallback(function ($id) use (&$pendingCards) {
+				return array_values($pendingCards);
+			});
+		$this->backend->expects($this->exactly(1))
+			->method('deleteCard');
+
+		$body = '<?xml version="1.0"?>
+<d:multistatus xmlns:d="DAV:" xmlns:s="http://sabredav.org/ns" xmlns:card="urn:ietf:params:xml:ns:carddav" xmlns:oc="http://owncloud.org/ns">
+    <d:response>
+        <d:href>/remote.php/dav/addressbooks/system/system/system/Database:alice.vcf</d:href>
+        <d:propstat>
+            <d:prop>
+                <d:getcontenttype>text/vcard; charset=utf-8</d:getcontenttype>
+                <d:getetag>&quot;2df155fa5c2a24cd7f750353fc63f037&quot;</d:getetag>
+            </d:prop>
+            <d:status>HTTP/1.1 200 OK</d:status>
+        </d:propstat>
+    </d:response>
+    <d:sync-token>http://sabre.io/ns/sync/3</d:sync-token>
+</d:multistatus>';
+
+		$reportResponse = new Response(new PsrResponse(
+			207,
+			['Content-Type' => 'application/xml; charset=utf-8', 'Content-Length' => strlen($body)],
+			$body
+		));
+
+		$this->client
+			->method('request')
+			->willReturn($reportResponse);
+
+		$vCard = 'BEGIN:VCARD
+VERSION:3.0
+PRODID:-//Sabre//Sabre VObject 4.5.4//EN
+UID:alice
+FN;X-NC-SCOPE=v2-federated:alice
+N;X-NC-SCOPE=v2-federated:alice;;;;
+X-SOCIALPROFILE;TYPE=NEXTCLOUD;X-NC-SCOPE=v2-published:https://server2.internal/index.php/u/alice
+CLOUD:alice@server2.internal
+END:VCARD';
+
+		$getResponse = new Response(new PsrResponse(
+			200,
+			['Content-Type' => 'text/vcard; charset=utf-8', 'Content-Length' => strlen($vCard)],
+			$vCard,
+		));
+
+		$this->client
+			->method('get')
+			->willReturn($getResponse);
+
+		$this->backend->method('getCards')
+			->willReturn([
+				['uri' => 'Database:alice.vcf'],
+				['uri' => 'Database:bob.vcf'],
+			]);
+
+		$this->service->markCardsAsPending(1);
+		$token = $this->service->syncRemoteAddressBook(
+			'',
+			'system',
+			'system',
+			'1234567890',
+			null,
+			'1',
+			'principals/system/system',
+			[]
+		)[0];
+		$this->service->deletePendingCards(1);
+
+		$this->assertEquals('http://sabre.io/ns/sync/3', $token);
+	}
+
 	public function testEnsureSystemAddressBookExists(): void {
 		/** @var CardDavBackend | \PHPUnit\Framework\MockObject\MockObject $backend */
 		$backend = $this->getMockBuilder(CardDavBackend::class)->disableOriginalConstructor()->getMock();
@@ -468,7 +560,7 @@ END:VCARD';
 			'system',
 			'remote.php/dav/addressbooks/system/system/system',
 			'1234567890',
-			null,
+			'1',
 			'1',
 			'principals/system/system',
 			[]

apps/federation/lib/Command/SyncFederationAddressBooks.php

@@ -11,6 +11,7 @@ use OCA\Federation\SyncFederationAddressBooks as SyncService;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Helper\ProgressBar;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
 class SyncFederationAddressBooks extends Command {
@@ -23,19 +24,21 @@ class SyncFederationAddressBooks extends Command {
 	protected function configure() {
 		$this
 			->setName('federation:sync-addressbooks')
-			->setDescription('Synchronizes addressbooks of all federated clouds');
+			->setDescription('Synchronizes addressbooks of all federated clouds')
+			->addOption('full', null, InputOption::VALUE_NONE, 'Perform a full sync instead of a delta sync');
 	}
 
 	protected function execute(InputInterface $input, OutputInterface $output): int {
 		$progress = new ProgressBar($output);
 		$progress->start();
+		$full = (bool)$input->getOption('full');
 		$this->syncService->syncThemAll(function ($url, $ex) use ($progress, $output): void {
 			if ($ex instanceof \Exception) {
 				$output->writeln("Error while syncing $url : " . $ex->getMessage());
 			} else {
 				$progress->advance();
 			}
-		});
+		}, $full);
 
 		$progress->finish();
 		$output->writeln('');

apps/federation/lib/SyncFederationAddressBooks.php

@@ -28,7 +28,7 @@ class SyncFederationAddressBooks {
 	/**
 	 * @param \Closure $callback
 	 */
-	public function syncThemAll(\Closure $callback) {
+	public function syncThemAll(\Closure $callback, bool $full = false) {
 		$trustedServers = $this->dbHandler->getAllServer();
 		foreach ($trustedServers as $trustedServer) {
 			$url = $trustedServer['url'];
@@ -51,7 +51,12 @@ class SyncFederationAddressBooks {
 			];
 
 			try {
-				$syncToken = $oldSyncToken;
+				$syncToken = $full ? null : $oldSyncToken;
+
+				$book = $this->syncService->ensureSystemAddressBookExists($targetPrincipal, $targetBookId, $targetBookProperties);
+				if ($full) {
+					$this->syncService->markCardsAsPending($book['id']);
+				}
 
 				do {
 					[$syncToken, $truncated] = $this->syncService->syncRemoteAddressBook(
@@ -66,6 +71,10 @@ class SyncFederationAddressBooks {
 					);
 				} while ($truncated);
 
+				if ($full) {
+					$this->syncService->deletePendingCards($book['id']);
+				}
+
 				if ($syncToken !== $oldSyncToken) {
 					$this->dbHandler->setServerStatus($url, TrustedServers::STATUS_OK, $syncToken);
 				} else {