Merge pull request #890 from nextcloud/feat/find-principal-collections

feat: find principal collections
nextcloud · Jun 10, 2024 · b078ef9 · b078ef9
2 parents 486fea8 + 47cd7a5
commit b078ef9
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 0 deletions.
diff --git a/src/index.js b/src/index.js
@@ -4,6 +4,7 @@
  * This library is part of the Nextcloud project
  *
  * @author Georg Ehrke
+ * @author Richard Steinmetz <richard@steinmetz.cloud>
  * @copyright 2019 Georg Ehrke <oc.list@georgehrke.com>
  *
  * This library is free software; you can redistribute it and/or
@@ -445,10 +446,40 @@ export default class DavClient {
 		return this._request.propFind(principalUrl, Principal.getPropFindList()).then(({ body }) => {
 			return new Principal(null, this._request, principalUrl, body)
 		}).catch((err) => {
+			// TODO: improve error handling
 			console.debug(err)
 		})
 	}
 
+	/**
+	 * finds all principals in a collection at a given principalCollectionUrl
+	 *
+	 * @param {string} principalCollectionUrl
+	 * @param {import('./models/principal.js').PrincipalPropfindOptions} options Passed to Principal.getPropFindList()
+	 * @return {Promise<Principal[]>}
+	 */
+	async findPrincipalsInCollection(principalCollectionUrl, options = {}) {
+		try {
+			const { body } = await this._request.propFind(
+				principalCollectionUrl,
+				Principal.getPropFindList(options),
+				1,
+			)
+			const principals = Object.entries(body)
+				.filter(([principalUrl]) => !principalCollectionUrl.endsWith(principalUrl))
+				.map(([principalUrl, principal]) => new Principal(
+					null,
+					this._request,
+					principalUrl,
+					principal,
+				))
+			return principals
+		} catch (err) {
+			// TODO: improve error handling
+			console.debug(err)
+		}
+	}
+
 	/**
 	 * discovers the accounts principal uri solely based on rootURL
 	 *

diff --git a/src/models/principal.js b/src/models/principal.js
@@ -28,6 +28,13 @@ import * as XMLUtility from '../utility/xmlUtility.js'
 
 import prinicipalPropSet from '../propset/principalPropSet.js'
 
+/**
+ * @typedef  {object}   PrincipalPropfindOptions
+ * @property {boolean=} PrincipalPropfindOptions.enableCalDAV
+ * @property {boolean=} PrincipalPropfindOptions.enableCalDAVResourceBooking
+ * @property {boolean=} PrincipalPropfindOptions.enableCardDAV
+ */
+
 /**
  * @class
  */
@@ -178,6 +185,8 @@ export class Principal extends DavObject {
 
 	/**
 	 * @inheritDoc
+	 *
+	 * @param {PrincipalPropfindOptions} options
 	 */
 	static getPropFindList(options = {}) {
 		const list = [
@@ -196,6 +205,10 @@ export class Principal extends DavObject {
 				[NS.IETF_CALDAV, 'schedule-inbox-URL'],
 				[NS.IETF_CALDAV, 'schedule-outbox-URL'],
 				[NS.IETF_CALDAV, 'schedule-default-calendar-URL'],
+			)
+		}
+		if (options.enableCalDAVResourceBooking || options.enableCalDAV) {
+			list.push(
 				// Room and Resource booking related
 				[NS.NEXTCLOUD, 'resource-type'],
 				[NS.NEXTCLOUD, 'resource-vehicle-type'],