Skip to content

Commit

Permalink
fix(scheduling): don't send iMIP emails to rooms / resources
Browse files Browse the repository at this point in the history 
Signed-off-by: Anna Larch <anna@nextcloud.com>
  • Loading branch information
@miaulalala @Jerome-Herbinet
miaulalala authored and Jerome-Herbinet committed Nov 27, 2023
1 parent d416299 commit e7d9b84
Show file tree
Hide file tree
Showing 3 changed files with 188 additions and 12 deletions.
24 changes: 14 additions & 10 deletions apps/dav/lib/CalDAV/Schedule/IMipPlugin.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,28 +41,18 @@
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\Defaults;
use OCP\IConfig;
use OCP\IDBConnection;
use OCP\IL10N;
use OCP\IURLGenerator;
use OCP\IUserManager;
use OCP\L10N\IFactory as L10NFactory;
use OCP\Mail\IEMailTemplate;
use OCP\Mail\IMailer;
use OCP\Security\ISecureRandom;
use OCP\Util;
use Psr\Log\LoggerInterface;
use Sabre\CalDAV\Schedule\IMipPlugin as SabreIMipPlugin;
use Sabre\DAV;
use Sabre\DAV\INode;
use Sabre\VObject\Component\VCalendar;
use Sabre\VObject\Component\VEvent;
use Sabre\VObject\Component\VTimeZone;
use Sabre\VObject\DateTimeParser;
use Sabre\VObject\ITip\Message;
use Sabre\VObject\Parameter;
use Sabre\VObject\Property;
use Sabre\VObject\Reader;
use Sabre\VObject\Recur\EventIterator;

/**
* iMIP handler.
Expand Down Expand Up @@ -199,6 +189,20 @@ public function schedule(Message $iTipMessage) {
// we also might not have an old event as this could be a new
// invitation, or a new recurrence exception
$attendee = $this->imipService->getCurrentAttendee($iTipMessage);
if($attendee === null) {
$uid = $vEvent->UID ?? 'no UID found';
$this->logger->debug('Could not find recipient ' . $recipient . ' as attendee for event with UID ' . $uid);
$iTipMessage->scheduleStatus = '5.0;EMail delivery failed';
return;
}
// Don't send emails to things
if($this->imipService->isRoomOrResource($attendee)) {
$this->logger->debug('No invitation sent as recipient is room or resource', [
'attendee' => $recipient,
]);
$iTipMessage->scheduleStatus = '1.0;We got the message, but it\'s not significant enough to warrant an email';
return;
}
$this->imipService->setL10n($attendee);

// Build the sender name.
Expand Down
13 changes: 13 additions & 0 deletions apps/dav/lib/CalDAV/Schedule/IMipService.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -673,4 +673,17 @@ public function getReplyingAttendee(Message $iTipMessage): ?Property {
}
return null;
}

public function isRoomOrResource(Property $attendee): bool {
$cuType = $attendee->offsetGet('CUTYPE');
if(!$cuType instanceof Parameter) {
return false;
}
$type = $cuType->getValue() ?? 'INDIVIDUAL';
if (\in_array(strtoupper($type), ['RESOURCE', 'ROOM', 'UNKNOWN'], true)) {
// Don't send emails to things
return true;
}
return false;
}
}
163 changes: 161 additions & 2 deletions apps/dav/tests/unit/CalDAV/Schedule/IMipPluginTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
use Sabre\VObject\Component\VCalendar;
use Sabre\VObject\Component\VEvent;
use Sabre\VObject\ITip\Message;
use Sabre\VObject\Property;
use Test\TestCase;
use function array_merge;

Expand Down Expand Up @@ -183,6 +184,13 @@ public function testParsingSingle(): void {
'meeting_title' => 'Fellowship meeting without (!) Boromir',
'attendee_name' => 'frodo@hobb.it'
];
$attendees = $newVevent->select('ATTENDEE');
$atnd = '';
foreach ($attendees as $attendee) {
if (strcasecmp($attendee->getValue(), $message->recipient) === 0) {
$atnd = $attendee;
}
}
$this->plugin->setVCalendar($oldVCalendar);
$this->service->expects(self::once())
->method('getLastOccurrence')
Expand All @@ -194,6 +202,14 @@ public function testParsingSingle(): void {
$this->eventComparisonService->expects(self::once())
->method('findModified')
->willReturn(['new' => [$newVevent], 'old' => [$oldVEvent]]);
$this->service->expects(self::once())
->method('getCurrentAttendee')
->with($message)
->willReturn($atnd);
$this->service->expects(self::once())
->method('isRoomOrResource')
->with($atnd)
->willReturn(false);
$this->service->expects(self::once())
->method('buildBodyData')
->with($newVevent, $oldVEvent)
Expand Down Expand Up @@ -232,6 +248,91 @@ public function testParsingSingle(): void {
$this->assertEquals('1.1', $message->getScheduleStatus());
}

public function testAttendeeIsResource(): void {
$message = new Message();
$message->method = 'REQUEST';
$newVCalendar = new VCalendar();
$newVevent = new VEvent($newVCalendar, 'one', array_merge([
'UID' => 'uid-1234',
'SEQUENCE' => 1,
'SUMMARY' => 'Fellowship meeting without (!) Boromir',
'DTSTART' => new \DateTime('2016-01-01 00:00:00')
], []));
$newVevent->add('ORGANIZER', 'mailto:gandalf@wiz.ard');
$newVevent->add('ATTENDEE', 'mailto:' . 'the-shire@hobb.it', ['RSVP' => 'TRUE', 'CN' => 'The Shire', 'CUTYPE' => 'ROOM']);
$message->message = $newVCalendar;
$message->sender = 'mailto:gandalf@wiz.ard';
$message->senderName = 'Mr. Wizard';
$message->recipient = 'mailto:' . 'the-shire@hobb.it';
// save the old copy in the plugin
$oldVCalendar = new VCalendar();
$oldVEvent = new VEvent($oldVCalendar, 'one', [
'UID' => 'uid-1234',
'SEQUENCE' => 0,
'SUMMARY' => 'Fellowship meeting',
'DTSTART' => new \DateTime('2016-01-01 00:00:00')
]);
$oldVEvent->add('ORGANIZER', 'mailto:gandalf@wiz.ard');
$oldVEvent->add('ATTENDEE', 'mailto:' . 'the-shire@hobb.it', ['RSVP' => 'TRUE', 'CN' => 'The Shire', 'CUTYPE' => 'ROOM']);
$oldVEvent->add('ATTENDEE', 'mailto:' . 'boromir@tra.it.or', ['RSVP' => 'TRUE']);
$oldVCalendar->add($oldVEvent);
$data = ['invitee_name' => 'Mr. Wizard',
'meeting_title' => 'Fellowship meeting without (!) Boromir',
'attendee_name' => 'frodo@hobb.it'
];
$attendees = $newVevent->select('ATTENDEE');
$room = '';
foreach ($attendees as $attendee) {
if (strcasecmp($attendee->getValue(), $message->recipient) === 0) {
$room = $attendee;
}
}
$this->plugin->setVCalendar($oldVCalendar);
$this->service->expects(self::once())
->method('getLastOccurrence')
->willReturn('1496912700');
$this->mailer->expects(self::once())
->method('validateMailAddress')
->with('the-shire@hobb.it')
->willReturn(true);
$this->eventComparisonService->expects(self::once())
->method('findModified')
->willReturn(['new' => [$newVevent], 'old' => [$oldVEvent]]);
$this->service->expects(self::once())
->method('getCurrentAttendee')
->with($message)
->willReturn($room);
$this->service->expects(self::once())
->method('isRoomOrResource')
->with($room)
->willReturn(true);
$this->service->expects(self::never())
->method('buildBodyData');
$this->userManager->expects(self::never())
->method('getDisplayName');
$this->service->expects(self::never())
->method('getFrom');
$this->service->expects(self::never())
->method('addSubjectAndHeading');
$this->service->expects(self::never())
->method('addBulletList');
$this->service->expects(self::never())
->method('getAttendeeRsvpOrReqForParticipant');
$this->config->expects(self::never())
->method('getAppValue');
$this->service->expects(self::never())
->method('createInvitationToken');
$this->service->expects(self::never())
->method('addResponseButtons');
$this->service->expects(self::never())
->method('addMoreOptionsButton');
$this->mailer->expects(self::never())
->method('send');
$this->plugin->schedule($message);
$this->assertEquals('1.0', $message->getScheduleStatus());
}


public function testParsingRecurrence(): void {
$message = new Message();
$message->method = 'REQUEST';
Expand Down Expand Up @@ -274,6 +375,13 @@ public function testParsingRecurrence(): void {
'meeting_title' => 'Elevenses',
'attendee_name' => 'frodo@hobb.it'
];
$attendees = $newVevent->select('ATTENDEE');
$atnd = '';
foreach ($attendees as $attendee) {
if (strcasecmp($attendee->getValue(), $message->recipient) === 0) {
$atnd = $attendee;
}
}
$this->plugin->setVCalendar($oldVCalendar);
$this->service->expects(self::once())
->method('getLastOccurrence')
Expand All @@ -285,6 +393,14 @@ public function testParsingRecurrence(): void {
$this->eventComparisonService->expects(self::once())
->method('findModified')
->willReturn(['old' => [] ,'new' => [$newVevent]]);
$this->service->expects(self::once())
->method('getCurrentAttendee')
->with($message)
->willReturn($atnd);
$this->service->expects(self::once())
->method('isRoomOrResource')
->with($atnd)
->willReturn(false);
$this->service->expects(self::once())
->method('buildBodyData')
->with($newVevent, null)
Expand Down Expand Up @@ -384,6 +500,13 @@ public function testFailedDelivery(): void {
'meeting_title' => 'Fellowship meeting without (!) Boromir',
'attendee_name' => 'frodo@hobb.it'
];
$attendees = $newVevent->select('ATTENDEE');
$atnd = '';
foreach ($attendees as $attendee) {
if (strcasecmp($attendee->getValue(), $message->recipient) === 0) {
$atnd = $attendee;
}
}
$this->plugin->setVCalendar($oldVcalendar);
$this->service->expects(self::once())
->method('getLastOccurrence')
Expand All @@ -395,6 +518,14 @@ public function testFailedDelivery(): void {
$this->eventComparisonService->expects(self::once())
->method('findModified')
->willReturn(['old' => [] ,'new' => [$newVevent]]);
$this->service->expects(self::once())
->method('getCurrentAttendee')
->with($message)
->willReturn($atnd);
$this->service->expects(self::once())
->method('isRoomOrResource')
->with($atnd)
->willReturn(false);
$this->service->expects(self::once())
->method('buildBodyData')
->with($newVevent, null)
Expand Down Expand Up @@ -458,7 +589,13 @@ public function testNoOldEvent(): void {
'meeting_title' => 'Fellowship meeting',
'attendee_name' => 'frodo@hobb.it'
];

$attendees = $newVevent->select('ATTENDEE');
$atnd = '';
foreach ($attendees as $attendee) {
if (strcasecmp($attendee->getValue(), $message->recipient) === 0) {
$atnd = $attendee;
}
}
$this->service->expects(self::once())
->method('getLastOccurrence')
->willReturn('1496912700');
Expand All @@ -470,6 +607,14 @@ public function testNoOldEvent(): void {
->method('findModified')
->with($newVCalendar, null)
->willReturn(['old' => [] ,'new' => [$newVevent]]);
$this->service->expects(self::once())
->method('getCurrentAttendee')
->with($message)
->willReturn($atnd);
$this->service->expects(self::once())
->method('isRoomOrResource')
->with($atnd)
->willReturn(false);
$this->service->expects(self::once())
->method('buildBodyData')
->with($newVevent, null)
Expand Down Expand Up @@ -530,7 +675,13 @@ public function testNoButtons(): void {
'meeting_title' => 'Fellowship meeting',
'attendee_name' => 'frodo@hobb.it'
];

$attendees = $newVevent->select('ATTENDEE');
$atnd = '';
foreach ($attendees as $attendee) {
if (strcasecmp($attendee->getValue(), $message->recipient) === 0) {
$atnd = $attendee;
}
}
$this->service->expects(self::once())
->method('getLastOccurrence')
->willReturn('1496912700');
Expand All @@ -542,6 +693,14 @@ public function testNoButtons(): void {
->method('findModified')
->with($newVCalendar, null)
->willReturn(['old' => [] ,'new' => [$newVevent]]);
$this->service->expects(self::once())
->method('getCurrentAttendee')
->with($message)
->willReturn($atnd);
$this->service->expects(self::once())
->method('isRoomOrResource')
->with($atnd)
->willReturn(false);
$this->service->expects(self::once())
->method('buildBodyData')
->with($newVevent, null)
Expand Down

0 comments on commit e7d9b84

Please sign in to comment.