principal.js

/**
 * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

import {
	PRINCIPAL_PREFIX_CALENDAR_RESOURCE,
	PRINCIPAL_PREFIX_CALENDAR_ROOM,
	PRINCIPAL_PREFIX_CIRCLE,
	PRINCIPAL_PREFIX_GROUP,
	PRINCIPAL_PREFIX_USER,
} from './consts.js'

/**
 * Creates a complete principal-object based on given props
 *
 * @param {object} props Principal-props already provided
 * @return {any}
 */
function getDefaultPrincipalObject(props) {
	return { // Id of the principal
		id: null,
		// Calendar-user-type. This can be INDIVIDUAL, GROUP, RESOURCE or ROOM
		calendarUserType: 'INDIVIDUAL',
		// E-Mail address of principal used for scheduling
		emailAddress: null,
		// The principals display-name
		// TODO: this should be renamed to displayName
		displayname: null,
		// principalScheme
		principalScheme: null,
		// The internal user-id in case it is of type INDIVIDUAL and a user
		// TODO: userId is deprecrated, use principalId instead
		userId: null,
		// url to the DAV-principal-resource
		url: null,
		// The cdav-library object
		dav: null,
		// Whether or not this principal represents a circle
		isCircle: false,
		// Whether or not this principal represents a user
		isUser: false,
		// Whether or not this principal represents a group
		isGroup: false,
		// Whether or not this principal represents a calendar-resource
		isCalendarResource: false,
		// Whether or not this principal represents a calendar-room
		isCalendarRoom: false,
		// The id of the principal without prefix. e.g. userId / groupId / etc.
		principalId: null,
		// The url of the default calendar for invitations
		scheduleDefaultCalendarUrl: null,
		// Room-specific properties (only for calendar-rooms)
		roomSeatingCapacity: null,
		roomType: null,
		roomAddress: null,
		roomFeatures: null,
		roomBuildingName: null,
		roomBuildingAddress: null,
		roomNumber: null,
		...props,
	}
}

/**
 * converts a dav principal into a vuex object
 *
 * @param {object} dav cdav-library Principal object
 * @return {object}
 */
function mapDavToPrincipal(dav) {
	const id = btoa(encodeURI(dav.url))
	const calendarUserType = dav.calendarUserType
	const principalScheme = dav.principalScheme
	const emailAddress = dav.email

	const displayname = dav.displayname
	const scheduleDefaultCalendarUrl = dav.scheduleDefaultCalendarUrl

	const isUser = dav.principalScheme.startsWith(PRINCIPAL_PREFIX_USER)
	const isGroup = dav.principalScheme.startsWith(PRINCIPAL_PREFIX_GROUP)
	const isCircle = dav.principalScheme.startsWith(PRINCIPAL_PREFIX_CIRCLE)
	const isCalendarResource = dav.principalScheme.startsWith(PRINCIPAL_PREFIX_CALENDAR_RESOURCE)
	const isCalendarRoom = dav.principalScheme.startsWith(PRINCIPAL_PREFIX_CALENDAR_ROOM)

	let principalId = null
	if (isUser) {
		principalId = dav.principalScheme.substring(PRINCIPAL_PREFIX_USER.length)
	} else if (isGroup) {
		principalId = dav.principalScheme.substring(PRINCIPAL_PREFIX_GROUP.length)
	} else if (isCircle) {
		principalId = dav.principalScheme.substring(PRINCIPAL_PREFIX_CIRCLE.length)
	} else if (isCalendarResource) {
		principalId = dav.principalScheme.substring(PRINCIPAL_PREFIX_CALENDAR_RESOURCE.length)
	} else if (isCalendarRoom) {
		principalId = dav.principalScheme.substring(PRINCIPAL_PREFIX_CALENDAR_ROOM.length)
	}

	const url = dav.principalUrl
	const userId = dav.userId

	// Extract room-specific properties from DAV object, trimming string values defensively
	const roomSeatingCapacity = dav.roomSeatingCapacity ?? null
	const roomType = (dav.roomType ?? '').toString().trim() || null
	const roomFeatures = (dav.roomFeatures ?? '').toString().trim() || null
	// Strip leading/trailing whitespace and commas from building address to handle empty
	// building-name fields, e.g. ", Science Park 140, 1098 XG, Amsterdam" → "Science Park 140, 1098 XG, Amsterdam"
	const rawBuildingAddress = dav.roomBuildingAddress ?? null
	const roomBuildingAddress = rawBuildingAddress
		? rawBuildingAddress.replace(/^[\s,]+|[\s,]+$/g, '').trim() || null
		: null
	// Derive building name from address (everything before first comma): "Poppodium, Kerkstraat 10" → "Poppodium"
	const roomBuildingName = roomBuildingAddress ? roomBuildingAddress.split(',')[0].trim() || null : null
	// Room number (floor.room format, e.g. "2.17") is stored in room-building-room-number
	const roomNumber = (dav.roomBuildingRoomNumber ?? '').toString().trim() || null

	// Construct roomAddress for event LOCATION field from available properties
	// Format: "Street (Building, Room X.XX)" — street-first for map/navigation apps
	let roomAddress = null
	if (roomBuildingAddress) {
		const commaIdx = roomBuildingAddress.indexOf(',')
		if (commaIdx > 0) {
			const building = roomBuildingAddress.substring(0, commaIdx).trim()
			const street = roomBuildingAddress.substring(commaIdx + 1).trim()
			const detail = roomNumber ? building + ', Room ' + roomNumber : building
			roomAddress = street + ' (' + detail + ')'
		} else {
			roomAddress = roomNumber
				? roomBuildingAddress + ' (Room ' + roomNumber + ')'
				: roomBuildingAddress
		}
	}

	return getDefaultPrincipalObject({
		id,
		calendarUserType,
		principalScheme,
		emailAddress,
		displayname,
		url,
		dav,
		isUser,
		isGroup,
		isCircle,
		isCalendarResource,
		isCalendarRoom,
		principalId,
		userId,
		scheduleDefaultCalendarUrl,
		roomSeatingCapacity,
		roomType,
		roomAddress,
		roomFeatures,
		roomBuildingName,
		roomBuildingAddress,
		roomNumber,
	})
}

export {
	getDefaultPrincipalObject,
	mapDavToPrincipal,
}