Skip to content

feat(caldav): allow attendees to add guests to an event #63167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kesselb wants to merge 1 commit into
base: master
Choose a base branch
from
+462 −19
Open

feat(caldav): allow attendees to add guests to an event #63167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions apps/dav/lib/AppInfo/Application.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,7 @@ public function register(IRegistrationContext $context): void {
#[\Override]
public function boot(IBootContext $context): void {
VObject\Component\VCalendar::$propertyMap[TipBroker::INVITATION_FORWARDING_PROPERTY] = VObject\Property\Boolean::class;
VObject\Component\VCalendar::$propertyMap[TipBroker::ALLOW_ATTENDEE_GUESTS_PROPERTY] = VObject\Property\Boolean::class;

// Load all dav apps
$context->getServerContainer()->get(IAppManager::class)->loadApps(['dav']);
Expand Down
215 changes: 210 additions & 5 deletions apps/dav/lib/CalDAV/TipBroker.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@

class TipBroker extends Broker {
public const INVITATION_FORWARDING_PROPERTY = 'X-NC-INVITATION-FORWARDING';
public const ALLOW_ATTENDEE_GUESTS_PROPERTY = 'X-NC-ALLOW-ATTENDEE-GUESTS';
public const ADD_GUEST_PROPERTY = 'X-NC-ADD-GUEST';

public $significantChangeProperties = [
'DTSTART',
Expand Down Expand Up @@ -95,6 +97,7 @@ protected function processMessageReply(Message $itipMessage, ?VCalendar $existin
return null;
}
$instances = [];
$guests = [];
$requestStatus = '2.0';

/** @var list<VEvent> $vevents */
Expand All @@ -115,6 +118,7 @@ protected function processMessageReply(Message $itipMessage, ?VCalendar $existin
continue;
}
$instances[$recurId] = $partstat->getValue();
$guests[$recurId] = $this->getGuestsFromReply($vevent);
if (isset($vevent->{'REQUEST-STATUS'})) {
$requestStatus = $vevent->{'REQUEST-STATUS'}->getValue();
[$requestStatus] = explode(';', $requestStatus);
Expand Down Expand Up @@ -142,9 +146,12 @@ protected function processMessageReply(Message $itipMessage, ?VCalendar $existin
$attendeeFound = true;
$attendee['PARTSTAT'] = $instances[$recurId];
$attendee['SCHEDULE-STATUS'] = $requestStatus;
// Un-setting the RSVP status, because we now know
// that the attendee already replied.
unset($attendee['RSVP']);
if ($instances[$recurId] !== 'NEEDS-ACTION') {
// A reply leaving the attendee at NEEDS-ACTION, for
// example one only forwarding the invitation, is not
// an answer, so keep asking for one.
unset($attendee['RSVP']);
Comment on lines +149 to +153
}
break;
}
}
Expand All @@ -159,6 +166,10 @@ protected function processMessageReply(Message $itipMessage, ?VCalendar $existin
$parameters['CN'] = $itipMessage->senderName;
}
$vevent->add('ATTENDEE', $itipMessage->sender, $parameters);
} elseif ($attendeeFound && $this->allowAttendeeGuests($vevent)) {
// Only guests of a known attendee are invited, otherwise a
// party crasher could bring others along.
$this->addGuests($vevent, $guests[$recurId] ?? []);
}
unset($instances[$recurId]);
}
Expand Down Expand Up @@ -203,7 +214,10 @@ protected function processMessageReply(Message $itipMessage, ?VCalendar $existin
$attendeeFound = true;
$attendee['PARTSTAT'] = $partstat;
$attendee['SCHEDULE-STATUS'] = $requestStatus;
unset($attendee['RSVP']);
if ($partstat !== 'NEEDS-ACTION') {
// Not an answer yet, so keep asking for one.
unset($attendee['RSVP']);
}
break;
}
}
Expand Down Expand Up @@ -252,16 +266,207 @@ protected function getFirstAttendee(VEvent $vevent): ?CalAddress {
return null;
}

/**
* Collects the guests a replying attendee added to the event.
*
* @return array<string, string|null> Calendar user address => common name
*/
protected function getGuestsFromReply(VEvent $vevent): array {
$guests = [];
/** @var list<Property> $properties */
$properties = $vevent->select(self::ADD_GUEST_PROPERTY);
foreach ($properties as $property) {
$href = $property->getValue();
if ($href === null || $href === '') {
continue;
}
$commonName = $property->offsetGet('CN');
$guests[$href] = $commonName instanceof Parameter ? $commonName->getValue() : null;
}

return $guests;
}

/**
* Adds guests that are not part of the event yet as attendees.
*
* @param array<string, string|null> $guests Calendar user address => common name
*/
protected function addGuests(VEvent $vevent, array $guests): void {
$known = [];
/** @var list<Property> $properties */
$properties = $vevent->select('ATTENDEE');
foreach ($properties as $property) {
if ($property instanceof CalAddress) {
$known[strtolower($property->getNormalizedValue())] = true;
}
}
$organizer = $this->getOrganizerHref($vevent);
if ($organizer !== null) {
$known[strtolower($organizer)] = true;
}

foreach ($guests as $href => $commonName) {
if (isset($known[strtolower($href)])) {
continue;
}
$parameters = [
'PARTSTAT' => 'NEEDS-ACTION',
'RSVP' => 'TRUE',
];
if ($commonName !== null) {
$parameters['CN'] = $commonName;
}
$vevent->add('ATTENDEE', $href, $parameters);
}
}

protected function getOrganizerHref(VEvent $vevent): ?string {
/** @var list<Property> $properties */
$properties = $vevent->select('ORGANIZER');
foreach ($properties as $property) {
if ($property instanceof CalAddress) {
return $property->getNormalizedValue();
}
}
return null;
}

/**
* Unlike forwarding, this has to be turned on by the organizer, so it is
* also absent on invitations we could not report guests back to.
*/
protected function allowAttendeeGuests(VEvent $vevent): bool {
$properties = $vevent->select(self::ALLOW_ATTENDEE_GUESTS_PROPERTY);
foreach ($properties as $property) {
if ($property instanceof Boolean) {
return $property->getValue() === true;
}
}
return false;
}

protected function allowInvitationForwarding(VEvent $vevent): bool {
$properties = $vevent->select(self::INVITATION_FORWARDING_PROPERTY);
foreach ($properties as $property) {
if ($property instanceof Boolean) {
return $property->getValue() === 'TRUE';
return $property->getValue() === true;
}
}
return true;
}

/**
* On top of the participation status handled by the parent, an attendee may
* add guests to an event they were invited to. Those go out as a separate
* reply, from which the organizer invites them.
*
* @param string $attendee
*
* @return array<int,Message>
*/
#[\Override]
protected function parseEventForAttendee(VCalendar $calendar, array $eventInfo, array $oldEventInfo, $attendee) {
$messages = parent::parseEventForAttendee($calendar, $eventInfo, $oldEventInfo, $attendee);

$guests = $this->extractAddedGuests($eventInfo, $oldEventInfo, $attendee);
if ($guests !== []) {
$messages[] = $this->generateGuestReply($eventInfo, $attendee, $guests);
}

return $messages;
}

/**
* Collects the guests an attendee added to their own copy of an event.
*
* Only guests of the base instance are picked up, guests on a recurrence
* exception are ignored. The calendar app therefore does not offer this
* for recurring events.
*
* @return array<string, string|null> Calendar user address => common name
*/
protected function extractAddedGuests(array $eventInfo, array $oldEventInfo, string $attendee): array {
$master = $eventInfo['instances']['master'] ?? null;
if (!$master instanceof VEvent || !$this->allowAttendeeGuests($master)) {
return [];
}

$guests = [];
foreach ($eventInfo['attendees'] as $href => $info) {
if ($href === $attendee || $href === $eventInfo['organizer']) {
continue;
}
// Already invited, so not a guest of this attendee
if (isset($oldEventInfo['attendees'][$href])) {
continue;
}
// Added to a recurrence exception instead of the whole event
if (!isset($info['instances']['master'])) {
continue;
}
$guests[$href] = $info['name'];
}

return $guests;
}

/**
* Generates a reply carrying the guests an attendee added to the event.
*
* The organizer invites them from there.
*
* @param array<string, string|null> $guests Calendar user address => common name
*/
protected function generateGuestReply(array $eventInfo, string $attendee, array $guests): Message {
// A reply only carries scheduling information, the organizer already
// knows the event itself.
$calendar = new VCalendar();
$calendar->add('METHOD', 'REPLY');
/** @var VEvent $vevent */
$vevent = $calendar->add('VEVENT', [
'UID' => $eventInfo['uid'],
'SEQUENCE' => $eventInfo['sequence'],
]);
$organizerParameters = [];
if ($eventInfo['organizerName']) {
$organizerParameters['CN'] = $eventInfo['organizerName'];
}
$vevent->add('ORGANIZER', $eventInfo['organizer'], $organizerParameters);

$attendeeParameters = [
'PARTSTAT' => $eventInfo['attendees'][$attendee]['instances']['master']['partstat'] ?? 'NEEDS-ACTION',
];
if ($eventInfo['attendees'][$attendee]['name']) {
$attendeeParameters['CN'] = $eventInfo['attendees'][$attendee]['name'];
}
$vevent->add('ATTENDEE', $attendee, $attendeeParameters);

foreach ($guests as $href => $commonName) {
$guestParameters = [];
if ($commonName) {
$guestParameters['CN'] = $commonName;
}
$vevent->add(self::ADD_GUEST_PROPERTY, $href, $guestParameters);
}

$message = new Message();
$message->uid = $eventInfo['uid'];
$message->method = 'REPLY';
$message->component = 'VEVENT';
$message->sequence = $eventInfo['sequence'];
$message->sender = $attendee;
$message->senderName = $eventInfo['attendees'][$attendee]['name'];
$message->recipient = $eventInfo['organizer'];
$message->recipientName = $eventInfo['organizerName'];
// The participation status did not necessarily change, so an email about
// this reply would be misleading.
$message->significantChange = false;
$message->message = $calendar;

return $message;
}

/**
* This method is used in cases where an event got updated, and we
* potentially need to send emails to attendees to let them know of updates
Expand Down
4 changes: 3 additions & 1 deletion apps/dav/lib/Capabilities.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ public function __construct(
}

/**
* @return array{dav: array{chunking: string, public_shares_chunking: bool, search_supports_creation_time: bool, search_supports_upload_time: bool, search_supports_last_activity: bool, bulkupload?: string, absence-supported?: bool, absence-replacement?: bool}}
* @return array{dav: array{chunking: string, public_shares_chunking: bool, search_supports_creation_time: bool, search_supports_upload_time: bool, search_supports_last_activity: bool, attendee_guests: bool, bulkupload?: string, absence-supported?: bool, absence-replacement?: bool}}
*/
#[\Override]
public function getCapabilities() {
Expand All @@ -32,6 +32,8 @@ public function getCapabilities() {
'search_supports_creation_time' => true,
'search_supports_upload_time' => true,
'search_supports_last_activity' => true,
// An attendee can add guests, which the server reports to the organizer
'attendee_guests' => true,
]
];
if ($this->config->getSystemValueBool('bulkupload.enabled', true)) {
Expand Down
6 changes: 5 additions & 1 deletion apps/dav/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@
"public_shares_chunking",
"search_supports_creation_time",
"search_supports_upload_time",
"search_supports_last_activity"
"search_supports_last_activity",
"attendee_guests"
],
"properties": {
"chunking": {
Expand All @@ -51,6 +52,9 @@
"search_supports_last_activity": {
"type": "boolean"
},
"attendee_guests": {
"type": "boolean"
},
"bulkupload": {
"type": "string"
},
Expand Down
Loading
Loading