feat: federated calendar sharing

src/components/AppNavigation/EditCalendarModal/ShareItem.vue

@@ -16,13 +16,15 @@
 			</p>
 		</div>
 
-		<input :id="`${id}-can-edit`"
-			:disabled="updatingSharee"
-			:checked="sharee.writeable"
-			type="checkbox"
-			class="checkbox"
-			@change="updatePermission">
-		<label :for="`${id}-can-edit`">{{ $t('calendar', 'can edit') }}</label>
+		<template v-if="canBeSharedWritable">
+			<input :id="`${id}-can-edit`"
+				:disabled="updatingSharee"
+				:checked="sharee.writeable"
+				type="checkbox"
+				class="checkbox"
+				@change="updatePermission">
+			<label :for="`${id}-can-edit`">{{ $t('calendar', 'can edit') }}</label>
+		</template>
 
 		<NcActions>
 			<NcActionButton :disabled="updatingSharee"
@@ -93,6 +95,13 @@
 
 			return this.sharee.displayName
 		},
+		/**
+		 * @return {boolean}
+		 */
+		canBeSharedWritable() {
+			// TODO: read-write sharing is not implemented for federated calendars yet
+			return !this.sharee.isRemoteUser
+		}
 	},
 	mounted() {
 		this.updateShareeEmail()

src/components/AppNavigation/EditCalendarModal/SharingSearch.vue

@@ -77,6 +77,16 @@
 	},
 	computed: {
 		...mapStores(usePrincipalsStore, useCalendarsStore),
+
+		/**
+		 * True, if the Nextcloud server supports read-only federated calendar shares.
+		 *
+		 * @return {boolean}
+		 */
+		supportsFederatedCalendars() {
+			const nextcloudMajorVersion = parseInt(window.OC.config.version.split('.')[0])
+			return nextcloudMajorVersion >= 32
+		},
 	},
 	methods: {
 		/**
@@ -88,23 +98,25 @@
 		 * @param {string} data.uri the sharing principalScheme uri
 		 * @param {boolean} data.isGroup is this a group ?
 		 * @param {boolean} data.isCircle is this a circle-group ?
+		 * @param {boolean} data.isRemoteUser is this a remote user (on a federated instance)?
 		 */
-		shareCalendar({ user, displayName, uri, isGroup, isCircle }) {
+		shareCalendar({ user, displayName, uri, isGroup, isCircle, isRemoteUser }) {
 			this.calendarsStore.shareCalendar({
 				calendar: this.calendar,
 				user,
 				displayName,
 				uri,
 				isGroup,
 				isCircle,
+				isRemoteUser,
 			})
 		},
 		/**
 		 * Function to filter results in NcSelect
 		 *
 		 * @param {object} option
 		 * @param {string} label
 		 * @param {string} search
 		 */
 		filterResults(option, label, search) {
 			return true
@@ -133,11 +145,13 @@
 			if (query.length > 0) {
 				const davPromise = this.findShareesFromDav(query, hiddenPrincipalSchemes, hiddenUrls)
 				const ocsPromise = this.findShareesFromCircles(query, hiddenPrincipalSchemes, hiddenUrls)
+				const remotePromise = this.findRemoteSharees(query)
 
-				const [davResults, ocsResults] = await Promise.all([davPromise, ocsPromise])
+				const [davResults, ocsResults, remoteResults] = await Promise.all([davPromise, ocsPromise, remotePromise])
 				this.usersOrGroups = [
 					...davResults,
 					...ocsResults,
+					...remoteResults,
 				]
 
 				this.isLoading = false
@@ -192,6 +206,7 @@
 					uri: decodedPrincipalScheme,
 					isGroup,
 					isCircle: false,
+					isRemoteUser: false,
 					isNoUser: isGroup,
 					search: query,
 					email: result.email,
@@ -246,10 +261,60 @@
 				uri: 'principal:principals/circles/' + circle.value.shareWith,
 				isGroup: false,
 				isCircle: true,
+				isRemoteUser: false,
 				isNoUser: true,
 				search: query,
 			}))
 		},
+		/**
+		 *
+		 * @param {string} query The search query
+		 * @return {Promise<object[]>}
+		 */
+		async findRemoteSharees(query) {
+			if (!this.supportsFederatedCalendars) {
+				return []
+			}
+
+			let results
+			try {
+				results = await HttpClient.get(generateOcsUrl('apps/files_sharing/api/v1/') + 'sharees', {
+					params: {
+						format: 'json',
+						search: query,
+						perPage: 200,
+						itemType: 'calendar',
+						shareType: [4, 6, 9],
+						lookup: false,
+					},
+				})
+			} catch (error) {
+				return []
+			}
+
+			if (results.data.ocs.meta.status === 'failure') {
+				return []
+			}
+
+			const remoteUsers = []
+			if (Array.isArray(results.data.ocs.data.remotes)) {
+				remoteUsers.push(...results.data.ocs.data.remotes)
+			}
+			if (Array.isArray(results.data.ocs.data.exact.remotes)) {
+				remoteUsers.push(...results.data.ocs.data.exact.remotes)
+			}
+			return remoteUsers.map((user) => ({
+				user: user.uuid,
+				displayName: `${user.name}@${user.value.server}`,
+				icon: 'icon-circle',
+				uri: `principal:principals/remote-users/${btoa(user.value.shareWith)}`,
+				isGroup: false,
+				isCircle: false,
+				isRemoteUser: true,
+				isNoUser: false,
+				search: query,
+			}))
+		},
 	},
 }
 </script>

src/models/calendarShare.js

@@ -5,6 +5,7 @@
 import {
 	PRINCIPAL_PREFIX_CIRCLE,
 	PRINCIPAL_PREFIX_GROUP,
+	PRINCIPAL_PREFIX_REMOTE_USER,
 	PRINCIPAL_PREFIX_USER,
 } from './consts.js'
 
@@ -27,6 +28,8 @@ const getDefaultCalendarShareObject = (props = {}) => Object.assign({}, {
 	isGroup: false,
 	// Whether or not sharee is a user-defined group
 	isCircle: false,
+	// Whether or not sharee is a remote user (on a federated instance)
+	isRemoteUser: false,
 	// Uri necessary for deleting / updating share
 	uri: null,
 }, props)
@@ -48,6 +51,8 @@ const mapDavShareeToCalendarShareObject = (sharee) => {
 		displayName = decodeURIComponent(sharee.href.slice(28))
 	} else if (sharee.href.startsWith(PRINCIPAL_PREFIX_USER)) {
 		displayName = decodeURIComponent(sharee.href.slice(27))
+	} else if (sharee.href.startsWith(PRINCIPAL_PREFIX_REMOTE_USER)) {
+		displayName = atob(sharee.href.slice(34))
 	} else {
 		displayName = sharee.href
 	}
@@ -56,6 +61,7 @@ const mapDavShareeToCalendarShareObject = (sharee) => {
 	const isUser = sharee.href.startsWith(PRINCIPAL_PREFIX_USER)
 	const isGroup = sharee.href.startsWith(PRINCIPAL_PREFIX_GROUP)
 	const isCircle = sharee.href.startsWith(PRINCIPAL_PREFIX_CIRCLE)
+	const isRemoteUser = sharee.href.startsWith(PRINCIPAL_PREFIX_REMOTE_USER)
 	const uri = sharee.href
 
 	return getDefaultCalendarShareObject({
@@ -65,6 +71,7 @@ const mapDavShareeToCalendarShareObject = (sharee) => {
 		isUser,
 		isGroup,
 		isCircle,
+		isRemoteUser,
 		uri,
 	})
 }

src/models/consts.js

@@ -20,6 +20,7 @@ const PRINCIPAL_PREFIX_GROUP = 'principal:principals/groups/'
 const PRINCIPAL_PREFIX_CIRCLE = 'principal:principals/circles/'
 const PRINCIPAL_PREFIX_CALENDAR_RESOURCE = 'principal:principals/calendar-resources/'
 const PRINCIPAL_PREFIX_CALENDAR_ROOM = 'principal:principals/calendar-rooms/'
+const PRINCIPAL_PREFIX_REMOTE_USER = 'principal:principals/remote-users/'
 
 const CALDAV_BIRTHDAY_CALENDAR = 'contact_birthdays'
 const CALDAV_PERSONAL_CALENDAR = 'personal'
@@ -46,6 +47,7 @@ export {
 	PRINCIPAL_PREFIX_CIRCLE,
 	PRINCIPAL_PREFIX_CALENDAR_RESOURCE,
 	PRINCIPAL_PREFIX_CALENDAR_ROOM,
+	PRINCIPAL_PREFIX_REMOTE_USER,
 	CALDAV_BIRTHDAY_CALENDAR,
 	CALDAV_PERSONAL_CALENDAR,
 	IMPORT_STAGE_DEFAULT,

src/store/calendars.js

@@ -599,8 +599,9 @@ export default defineStore('calendars', {
 		 * @param {string} data.uri the sharing principalScheme uri
 		 * @param {boolean} data.isGroup is this a group?
 		 * @param {boolean} data.isCircle is this a circle?
+		 * @param {boolean} data.isRemoteUser is this a remote user (on a federated instance)?
 		 */
-		async shareCalendar({ calendar, user, displayName, uri, isGroup, isCircle }) {
+		async shareCalendar({ calendar, user, displayName, uri, isGroup, isCircle, isRemoteUser }) {
 			// Share calendar with entered group or user
 			await calendar.dav.share(uri)
 			const newSharee = {
@@ -609,6 +610,7 @@ export default defineStore('calendars', {
 				writeable: false,
 				isGroup,
 				isCircle,
+				isRemoteUser,
 				uri,
 			}
 			this.calendarsById[calendar.id].shares.push(newSharee)

tests/javascript/unit/models/calendarShare.test.js

@@ -18,6 +18,7 @@ describe('Test suite: Calendar share model (models/calendarShare.js)', () => {
 			isUser: false,
 			isGroup: false,
 			isCircle: false,
+			isRemoteUser: false,
 			uri: null,
 		})
 	})
@@ -33,6 +34,7 @@ describe('Test suite: Calendar share model (models/calendarShare.js)', () => {
 			isUser: false,
 			isGroup: false,
 			isCircle: false,
+			isRemoteUser: false,
 			uri: null,
 			otherProp: 'foo',
 		})
@@ -55,6 +57,7 @@ describe('Test suite: Calendar share model (models/calendarShare.js)', () => {
 			isUser: true,
 			isGroup: false,
 			isCircle: false,
+			isRemoteUser: false,
 			uri: 'principal:principals/users/user4',
 		})
 	})
@@ -76,6 +79,7 @@ describe('Test suite: Calendar share model (models/calendarShare.js)', () => {
 			isUser: true,
 			isGroup: false,
 			isCircle: false,
+			isRemoteUser: false,
 			uri: 'principal:principals/users/user4',
 		})
 	})
@@ -97,6 +101,7 @@ describe('Test suite: Calendar share model (models/calendarShare.js)', () => {
 			isUser: false,
 			isGroup: true,
 			isCircle: false,
+			isRemoteUser: false,
 			uri: 'principal:principals/groups/admin',
 		})
 	})
@@ -118,6 +123,7 @@ describe('Test suite: Calendar share model (models/calendarShare.js)', () => {
 			isUser: false,
 			isGroup: false,
 			isCircle: true,
+			isRemoteUser: false,
 			uri: 'principal:principals/circles/c479c14bd82415',
 		})
 	})
@@ -141,10 +147,57 @@ describe('Test suite: Calendar share model (models/calendarShare.js)', () => {
 			isUser: false,
 			isGroup: false,
 			isCircle: true,
+			isRemoteUser: false,
 			uri: 'principal:principals/circles/c479c14bd82415',
 		})
 	})
 
+	it('should map a dav sharee to a calendar share object - remote user', () => {
+		const davSharee = {
+			// Decoded cloud id: [email protected]
+			'href': 'principal:principals/remote-users/bWFyY3VzQGZlZGVyYXRlZC5jbG91ZC5jb20=',
+			'common-name': 'Marcus [email protected]',
+			'invite-accepted': true,
+			'access': [
+				'{http://owncloud.org/ns}read'
+			]
+		}
+
+		expect(mapDavShareeToCalendarShareObject(davSharee)).toEqual({
+			id: 'cHJpbmNpcGFsOnByaW5jaXBhbHMvcmVtb3RlLXVzZXJzL2JXRnlZM1Z6UUdabFpHVnlZWFJsWkM1amJHOTFaQzVqYjIwPQ==',
+			displayName: 'Marcus [email protected]',
+			writeable: false,
+			isUser: false,
+			isGroup: false,
+			isCircle: false,
+			isRemoteUser: true,
+			uri: 'principal:principals/remote-users/bWFyY3VzQGZlZGVyYXRlZC5jbG91ZC5jb20=',
+		})
+	})
+
+	it('should map a dav sharee to a calendar share object - remote user without displayname', () => {
+		const davSharee = {
+			// Decoded cloud id: [email protected]
+			'href': 'principal:principals/remote-users/bWFyY3VzQGZlZGVyYXRlZC5jbG91ZC5jb20=',
+			'common-name': '',
+			'invite-accepted': true,
+			'access': [
+				'{http://owncloud.org/ns}read'
+			]
+		}
+
+		expect(mapDavShareeToCalendarShareObject(davSharee)).toEqual({
+			id: 'cHJpbmNpcGFsOnByaW5jaXBhbHMvcmVtb3RlLXVzZXJzL2JXRnlZM1Z6UUdabFpHVnlZWFJsWkM1amJHOTFaQzVqYjIwPQ==',
+			displayName: '[email protected]',
+			writeable: false,
+			isUser: false,
+			isGroup: false,
+			isCircle: false,
+			isRemoteUser: true,
+			uri: 'principal:principals/remote-users/bWFyY3VzQGZlZGVyYXRlZC5jbG91ZC5jb20=',
+		})
+	})
+
 	it('should properly handle sharee URIs with non-ascii characters', () => {
 		const davSharee = {
 			'href': 'principal:principals/groups/מַזָּל טוֹב',
@@ -162,8 +215,8 @@ describe('Test suite: Calendar share model (models/calendarShare.js)', () => {
 			isUser: false,
 			isGroup: true,
 			isCircle: false,
+			isRemoteUser: false,
 			uri: 'principal:principals/groups/מַזָּל טוֹב',
 		})
 	})
-
 })