feat(cardav): support result truncation for addressbook federation

Signed-off-by: Hamza Mahjoubi <[email protected]>

apps/dav/lib/CardDAV/AddressBook.php

@@ -234,9 +234,6 @@ private function canWrite(): bool {
 	}
 
 	public function getChanges($syncToken, $syncLevel, $limit = null) {
-		if (!$syncToken && $limit) {
-			throw new UnsupportedLimitOnInitialSyncException();
-		}
 
 		return parent::getChanges($syncToken, $syncLevel, $limit);
 	}

apps/dav/lib/CardDAV/CardDavBackend.php

@@ -873,8 +873,29 @@ public function getChangesForAddressBook($addressBookId, $syncToken, $syncLevel,
 				'modified' => [],
 				'deleted' => [],
 			];
-
-			if ($syncToken) {
+			if(str_starts_with($syncToken, "init_")) {
+				$syncValues = explode("_", $syncToken);
+				$lastID = $syncValues[1];
+				$initialSyncToken = $syncValues[2];
+				$qb = $this->db->getQueryBuilder();
+				$qb->select('id','uri')
+					->from('cards')
+					->where(
+						$qb->expr()->eq('addressbookid', $qb->createNamedParameter($addressBookId))
+					)->setMaxResults($limit);
+				$stmt = $qb->executeQuery();
+				$values = $stmt->fetchAll(\PDO::FETCH_KEY_PAIR); 
+				$lastID = array_key_last($values);
+				$result['syncToken'] = 'init_'.	$lastID.'_'.$initialSyncToken;
+				$result['added'] = array_values($values);
+				$stmt->closeCursor();
+				$result['result_truncated'] = true;
+				if (count($result['added']) < $limit ) {
+					$result['syncToken'] = $initialSyncToken;
+					$result['result_truncated'] = false;
+				}
+			}
+			else if ($syncToken) {
 				$qb = $this->db->getQueryBuilder();
 				$qb->select('uri', 'operation')
 					->from('addressbookchanges')
@@ -899,6 +920,8 @@ public function getChangesForAddressBook($addressBookId, $syncToken, $syncLevel,
 				// last change on a node is relevant.
 				while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
 					$changes[$row['uri']] = $row['operation'];
+					// get the last synctoken, needed in case a limit was set 
+					$result['syncToken'] = $row['synctoken'];
 				}
 				$stmt->closeCursor();
 
@@ -917,14 +940,27 @@ public function getChangesForAddressBook($addressBookId, $syncToken, $syncLevel,
 				}
 			} else {
 				$qb = $this->db->getQueryBuilder();
-				$qb->select('uri')
+				$qb->select('id','uri')
 					->from('cards')
 					->where(
 						$qb->expr()->eq('addressbookid', $qb->createNamedParameter($addressBookId))
 					);
 				// No synctoken supplied, this is the initial sync.
-				$stmt = $qb->executeQuery();
-				$result['added'] = $stmt->fetchAll(\PDO::FETCH_COLUMN);
+				if (is_int($limit) && $limit > 0) {
+					$qb->setMaxResults($limit);
+					$stmt = $qb->executeQuery();
+					$values = $stmt->fetchAll(\PDO::FETCH_KEY_PAIR); 
+					$lastID = array_key_last($values);
+					if(count(array_values($values)) === $limit ){
+						$result['syncToken'] = 'init_'.	$lastID.'_'.$currentToken;	
+						$result['result_truncated'] = true;
+					}			
+				}
+				else {
+					$stmt = $qb->executeQuery();
+				}
+				$result['added'] = array_values($values);
+
 				$stmt->closeCursor();
 			}
 			return $result;

apps/dav/lib/CardDAV/SyncService.php

@@ -162,7 +162,7 @@ protected function requestSyncReport(string $url, string $userName, string $addr
 			'auth' => [$userName, $sharedSecret],
 			'body' => $this->buildSyncCollectionRequestBody($syncToken),
 			'headers' => ['Content-Type' => 'application/xml'],
-			'timeout' => $this->config->getSystemValueInt('carddav_sync_request_timeout', IClient::DEFAULT_REQUEST_TIMEOUT)
+			'timeout' => $this->config->getSystemValueInt('carddav_sync_request_timeout', IClient::DEFAULT_REQUEST_TIMEOUT),
 		];
 
 		$response = $client->request(
@@ -194,17 +194,23 @@ protected function download(string $url, string $userName, string $sharedSecret,
 	}
 
 	private function buildSyncCollectionRequestBody(?string $syncToken): string {
+
 		$dom = new \DOMDocument('1.0', 'UTF-8');
 		$dom->formatOutput = true;
 		$root = $dom->createElementNS('DAV:', 'd:sync-collection');
 		$sync = $dom->createElement('d:sync-token', $syncToken ?? '');
+		$limit = $dom->createElement('d:limit');
+		$nresuts = $dom->createElement('d:nresults',$this->config->getSystemValueInt('carddav_sync_request_limit',IClient::DEFAULT_ADDRESSBOOK_INITIAL_SYNC_LIMIT));
+		$limit->appendChild($nresuts);
 		$prop = $dom->createElement('d:prop');
 		$cont = $dom->createElement('d:getcontenttype');
 		$etag = $dom->createElement('d:getetag');
 
+
 		$prop->appendChild($cont);
 		$prop->appendChild($etag);
 		$root->appendChild($sync);
+		$root->appendChild($limit);
 		$root->appendChild($prop);
 		$dom->appendChild($root);
 		return $dom->saveXML();

apps/dav/lib/CardDAV/SystemAddressbook.php

@@ -211,15 +211,8 @@ public function getChild($name): Card {
 			$obj['carddata'] = $carddata;
 		}
 		return new Card($this->carddavBackend, $this->addressBookInfo, $obj);
-	}
-
-	/**
-	 * @throws UnsupportedLimitOnInitialSyncException
-	 */
+	}	
 	public function getChanges($syncToken, $syncLevel, $limit = null) {
-		if (!$syncToken && $limit) {
-			throw new UnsupportedLimitOnInitialSyncException();
-		}
 
 		if (!$this->carddavBackend instanceof SyncSupport) {
 			return null;

config/config.sample.php

@@ -347,6 +347,11 @@
  */
 'carddav_sync_request_timeout' => 30,
 
+/**
+ * The limit applied to the initial synchronization report request, e.g. federated system address books (as run by `occ federation:sync-addressbooks`).
+ */
+'carddav_initial_sync_request_limit' => 1000,
+
 /**
  * `true` enabled a relaxed session timeout, where the session timeout would no longer be
  * handled by Nextcloud but by either the PHP garbage collection or the expiration of

lib/public/Http/Client/IClient.php

@@ -22,6 +22,14 @@ interface IClient {
 	 */
 	public const DEFAULT_REQUEST_TIMEOUT = 30;
 
+	/**
+	 * Default limit for address book intial sync
+	 *
+	 * @since 31.0.0
+	 */
+
+	public const DEFAULT_ADDRESSBOOK_INITIAL_SYNC_LIMIT = 1;
+
 	/**
 	 * Sends a GET request
 	 * @param string $uri