diff options
11 files changed, 214 insertions, 18 deletions
diff --git a/apps/dav/lib/CalDAV/Reminder/INotificationProvider.php b/apps/dav/lib/CalDAV/Reminder/INotificationProvider.php index a6b439c0b4f..505960ed662 100644 --- a/apps/dav/lib/CalDAV/Reminder/INotificationProvider.php +++ b/apps/dav/lib/CalDAV/Reminder/INotificationProvider.php @@ -8,6 +8,7 @@ declare(strict_types=1); * @author Christoph Wurst <christoph@winzerhof-wurst.at> * @author Georg Ehrke <oc.list@georgehrke.com> * @author Roeland Jago Douma <roeland@famdouma.nl> + * @author Richard Steinmetz <richard@steinmetz.cloud> * * @license GNU AGPL version 3 or any later version * @@ -42,10 +43,12 @@ interface INotificationProvider { * * @param VEvent $vevent * @param string $calendarDisplayName + * @param string[] $principalEmailAddresses All email addresses associated to the principal owning the calendar object * @param IUser[] $users * @return void */ public function send(VEvent $vevent, string $calendarDisplayName, + array $principalEmailAddresses, array $users = []): void; } diff --git a/apps/dav/lib/CalDAV/Reminder/NotificationProvider/AbstractProvider.php b/apps/dav/lib/CalDAV/Reminder/NotificationProvider/AbstractProvider.php index 49cf36f98ac..6986328facd 100644 --- a/apps/dav/lib/CalDAV/Reminder/NotificationProvider/AbstractProvider.php +++ b/apps/dav/lib/CalDAV/Reminder/NotificationProvider/AbstractProvider.php @@ -10,6 +10,7 @@ declare(strict_types=1); * @author Georg Ehrke <oc.list@georgehrke.com> * @author Joas Schilling <coding@schilljs.com> * @author Roeland Jago Douma <roeland@famdouma.nl> + * @author Richard Steinmetz <richard@steinmetz.cloud> * * @license GNU AGPL version 3 or any later version * @@ -82,11 +83,13 @@ abstract class AbstractProvider implements INotificationProvider { * * @param VEvent $vevent * @param string $calendarDisplayName + * @param string[] $principalEmailAddresses * @param IUser[] $users * @return void */ abstract public function send(VEvent $vevent, string $calendarDisplayName, + array $principalEmailAddresses, array $users = []): void; /** diff --git a/apps/dav/lib/CalDAV/Reminder/NotificationProvider/EmailProvider.php b/apps/dav/lib/CalDAV/Reminder/NotificationProvider/EmailProvider.php index d4aea6215ea..c2e68605d17 100644 --- a/apps/dav/lib/CalDAV/Reminder/NotificationProvider/EmailProvider.php +++ b/apps/dav/lib/CalDAV/Reminder/NotificationProvider/EmailProvider.php @@ -71,16 +71,28 @@ class EmailProvider extends AbstractProvider { * * @param VEvent $vevent * @param string $calendarDisplayName + * @param string[] $principalEmailAddresses * @param array $users * @throws \Exception */ public function send(VEvent $vevent, string $calendarDisplayName, + array $principalEmailAddresses, array $users = []):void { $fallbackLanguage = $this->getFallbackLanguage(); + $organizerEmailAddress = null; + if (isset($vevent->ORGANIZER)) { + $organizerEmailAddress = $this->getEMailAddressOfAttendee($vevent->ORGANIZER); + } + $emailAddressesOfSharees = $this->getEMailAddressesOfAllUsersWithWriteAccessToCalendar($users); - $emailAddressesOfAttendees = $this->getAllEMailAddressesFromEvent($vevent); + $emailAddressesOfAttendees = []; + if (count($principalEmailAddresses) === 0 + || ($organizerEmailAddress && in_array($organizerEmailAddress, $principalEmailAddresses, true)) + ) { + $emailAddressesOfAttendees = $this->getAllEMailAddressesFromEvent($vevent); + } // Quote from php.net: // If the input arrays have the same string keys, then the later value for that key will overwrite the previous one. diff --git a/apps/dav/lib/CalDAV/Reminder/NotificationProvider/PushProvider.php b/apps/dav/lib/CalDAV/Reminder/NotificationProvider/PushProvider.php index cb873020c38..833d74079aa 100644 --- a/apps/dav/lib/CalDAV/Reminder/NotificationProvider/PushProvider.php +++ b/apps/dav/lib/CalDAV/Reminder/NotificationProvider/PushProvider.php @@ -10,6 +10,7 @@ declare(strict_types=1); * @author Georg Ehrke <oc.list@georgehrke.com> * @author Roeland Jago Douma <roeland@famdouma.nl> * @author Thomas Citharel <nextcloud@tcit.fr> + * @author Richard Steinmetz <richard@steinmetz.cloud> * * @license GNU AGPL version 3 or any later version * @@ -73,11 +74,13 @@ class PushProvider extends AbstractProvider { * * @param VEvent $vevent * @param string $calendarDisplayName + * @param string[] $principalEmailAddresses * @param IUser[] $users * @throws \Exception */ public function send(VEvent $vevent, - string $calendarDisplayName = null, + string $calendarDisplayName, + array $principalEmailAddresses, array $users = []):void { if ($this->config->getAppValue('dav', 'sendEventRemindersPush', 'no') !== 'yes') { return; diff --git a/apps/dav/lib/CalDAV/Reminder/ReminderService.php b/apps/dav/lib/CalDAV/Reminder/ReminderService.php index 2a065469052..3fb8cf9ebe5 100644 --- a/apps/dav/lib/CalDAV/Reminder/ReminderService.php +++ b/apps/dav/lib/CalDAV/Reminder/ReminderService.php @@ -11,6 +11,7 @@ declare(strict_types=1); * @author Joas Schilling <coding@schilljs.com> * @author Roeland Jago Douma <roeland@famdouma.nl> * @author Thomas Citharel <nextcloud@tcit.fr> + * @author Richard Steinmetz <richard@steinmetz.cloud> * * @license GNU AGPL version 3 or any later version * @@ -32,6 +33,7 @@ namespace OCA\DAV\CalDAV\Reminder; use DateTimeImmutable; use OCA\DAV\CalDAV\CalDavBackend; +use OCA\DAV\Connector\Sabre\Principal; use OCP\AppFramework\Utility\ITimeFactory; use OCP\IConfig; use OCP\IGroup; @@ -76,6 +78,9 @@ class ReminderService { /** @var LoggerInterface */ private $logger; + /** @var Principal */ + private $principalConnector; + public const REMINDER_TYPE_EMAIL = 'EMAIL'; public const REMINDER_TYPE_DISPLAY = 'DISPLAY'; public const REMINDER_TYPE_AUDIO = 'AUDIO'; @@ -98,7 +103,8 @@ class ReminderService { CalDavBackend $caldavBackend, ITimeFactory $timeFactory, IConfig $config, - LoggerInterface $logger) { + LoggerInterface $logger, + Principal $principalConnector) { $this->backend = $backend; $this->notificationProviderManager = $notificationProviderManager; $this->userManager = $userManager; @@ -107,6 +113,7 @@ class ReminderService { $this->timeFactory = $timeFactory; $this->config = $config; $this->logger = $logger; + $this->principalConnector = $principalConnector; } /** @@ -175,12 +182,18 @@ class ReminderService { $users[] = $user; } + $userPrincipalEmailAddresses = []; + $userPrincipal = $this->principalConnector->getPrincipalByPath($reminder['principaluri']); + if ($userPrincipal) { + $userPrincipalEmailAddresses = $this->principalConnector->getEmailAddressesOfPrincipal($userPrincipal); + } + $this->logger->debug('Reminder {id} will be sent to {numUsers} users', [ 'id' => $reminder['id'], 'numUsers' => count($users), ]); $notificationProvider = $this->notificationProviderManager->getProvider($reminder['type']); - $notificationProvider->send($vevent, $reminder['displayname'], $users); + $notificationProvider->send($vevent, $reminder['displayname'], $userPrincipalEmailAddresses, $users); $this->deleteOrProcessNext($reminder, $vevent); } diff --git a/apps/dav/lib/CalDAV/Schedule/Plugin.php b/apps/dav/lib/CalDAV/Schedule/Plugin.php index 44517541faa..ed160cac2c2 100644 --- a/apps/dav/lib/CalDAV/Schedule/Plugin.php +++ b/apps/dav/lib/CalDAV/Schedule/Plugin.php @@ -9,6 +9,7 @@ * @author Joas Schilling <coding@schilljs.com> * @author Roeland Jago Douma <roeland@famdouma.nl> * @author Thomas Citharel <nextcloud@tcit.fr> + * @author Richard Steinmetz <richard@steinmetz.cloud> * * @license GNU AGPL version 3 or any later version * @@ -46,6 +47,7 @@ use Sabre\VObject\Component; use Sabre\VObject\Component\VCalendar; use Sabre\VObject\Component\VEvent; use Sabre\VObject\DateTimeParser; +use Sabre\VObject\Document; use Sabre\VObject\FreeBusyGenerator; use Sabre\VObject\ITip; use Sabre\VObject\Parameter; @@ -164,6 +166,14 @@ class Plugin extends \Sabre\CalDAV\Schedule\Plugin { * @inheritDoc */ public function scheduleLocalDelivery(ITip\Message $iTipMessage):void { + /** @var Component|null $vevent */ + $vevent = $iTipMessage->message->VEVENT ?? null; + + // Strip VALARMs from incoming VEVENT + if ($vevent && isset($vevent->VALARM)) { + $vevent->remove('VALARM'); + } + parent::scheduleLocalDelivery($iTipMessage); // We only care when the message was successfully delivered locally @@ -200,18 +210,10 @@ class Plugin extends \Sabre\CalDAV\Schedule\Plugin { return; } - if (!isset($iTipMessage->message)) { + if (!$vevent) { return; } - $vcalendar = $iTipMessage->message; - if (!isset($vcalendar->VEVENT)) { - return; - } - - /** @var Component $vevent */ - $vevent = $vcalendar->VEVENT; - // We don't support autoresponses for recurrencing events for now if (isset($vevent->RRULE) || isset($vevent->RDATE)) { return; diff --git a/apps/dav/lib/Connector/Sabre/Principal.php b/apps/dav/lib/Connector/Sabre/Principal.php index 75bee4e7b42..7b4b7090832 100644 --- a/apps/dav/lib/Connector/Sabre/Principal.php +++ b/apps/dav/lib/Connector/Sabre/Principal.php @@ -607,4 +607,44 @@ class Principal implements BackendInterface { return []; } + + /** + * Get all email addresses associated to a principal. + * + * @param array $principal Data from getPrincipal*() + * @return string[] All email addresses without the mailto: prefix + */ + public function getEmailAddressesOfPrincipal(array $principal): array { + $emailAddresses = []; + + if (($primaryAddress = $principal['{http://sabredav.org/ns}email-address'])) { + $emailAddresses[] = $primaryAddress; + } + + if (isset($principal['{DAV:}alternate-URI-set'])) { + foreach ($principal['{DAV:}alternate-URI-set'] as $address) { + if (str_starts_with($address, 'mailto:')) { + $emailAddresses[] = substr($address, 7); + } + } + } + + if (isset($principal['{urn:ietf:params:xml:ns:caldav}calendar-user-address-set'])) { + foreach ($principal['{urn:ietf:params:xml:ns:caldav}calendar-user-address-set'] as $address) { + if (str_starts_with($address, 'mailto:')) { + $emailAddresses[] = substr($address, 7); + } + } + } + + if (isset($principal['{http://calendarserver.org/ns/}email-address-set'])) { + foreach ($principal['{http://calendarserver.org/ns/}email-address-set'] as $address) { + if (str_starts_with($address, 'mailto:')) { + $emailAddresses[] = substr($address, 7); + } + } + } + + return array_values(array_unique($emailAddresses)); + } } diff --git a/apps/dav/tests/unit/CalDAV/Reminder/NotificationProvider/EmailProviderTest.php b/apps/dav/tests/unit/CalDAV/Reminder/NotificationProvider/EmailProviderTest.php index 273ad939144..9499e9e2ef1 100644 --- a/apps/dav/tests/unit/CalDAV/Reminder/NotificationProvider/EmailProviderTest.php +++ b/apps/dav/tests/unit/CalDAV/Reminder/NotificationProvider/EmailProviderTest.php @@ -65,6 +65,7 @@ class EmailProviderTest extends AbstractNotificationProviderTest { public function testSendWithoutAttendees():void { [$user1, $user2, $user3, , $user5] = $users = $this->getUsers(); + $principalEmailAddresses = [$user1->getEmailAddress()]; $enL10N = $this->createMock(IL10N::class); $enL10N->method('t') @@ -170,11 +171,12 @@ class EmailProviderTest extends AbstractNotificationProviderTest { $this->setupURLGeneratorMock(2); $vcalendar = $this->getNoAttendeeVCalendar(); - $this->provider->send($vcalendar->VEVENT, $this->calendarDisplayName, $users); + $this->provider->send($vcalendar->VEVENT, $this->calendarDisplayName, $principalEmailAddresses, $users); } - public function testSendWithAttendees(): void { + public function testSendWithAttendeesWhenOwnerIsOrganizer(): void { [$user1, $user2, $user3, , $user5] = $users = $this->getUsers(); + $principalEmailAddresses = [$user1->getEmailAddress()]; $enL10N = $this->createMock(IL10N::class); $enL10N->method('t') @@ -266,7 +268,81 @@ class EmailProviderTest extends AbstractNotificationProviderTest { $this->setupURLGeneratorMock(2); $vcalendar = $this->getAttendeeVCalendar(); - $this->provider->send($vcalendar->VEVENT, $this->calendarDisplayName, $users); + $this->provider->send($vcalendar->VEVENT, $this->calendarDisplayName, $principalEmailAddresses, $users); + } + + public function testSendWithAttendeesWhenOwnerIsAttendee(): void { + [$user1, $user2, $user3] = $this->getUsers(); + $users = [$user2, $user3]; + $principalEmailAddresses = [$user2->getEmailAddress()]; + + $deL10N = $this->createMock(IL10N::class); + $deL10N->method('t') + ->willReturnArgument(0); + $deL10N->method('l') + ->willReturnArgument(0); + + $this->l10nFactory + ->method('getUserLanguage') + ->willReturnMap([ + [$user2, 'de'], + [$user3, 'de'], + ]); + + $this->l10nFactory + ->method('findGenericLanguage') + ->willReturn('en'); + + $this->l10nFactory + ->method('languageExists') + ->willReturnMap([ + ['dav', 'de', true], + ]); + + $this->l10nFactory + ->method('get') + ->willReturnMap([ + ['dav', 'de', null, $deL10N], + ]); + + $template1 = $this->getTemplateMock(); + $message12 = $this->getMessageMock('uid2@example.com', $template1); + $message13 = $this->getMessageMock('uid3@example.com', $template1); + + $this->mailer->expects(self::once()) + ->method('createEMailTemplate') + ->with('dav.calendarReminder') + ->willReturnOnConsecutiveCalls( + $template1, + ); + $this->mailer->expects($this->atLeastOnce()) + ->method('validateMailAddress') + ->willReturnMap([ + ['foo1@example.org', true], + ['foo3@example.org', true], + ['foo4@example.org', true], + ['uid1@example.com', true], + ['uid2@example.com', true], + ['uid3@example.com', true], + ['invalid', false], + ]); + $this->mailer->expects($this->exactly(2)) + ->method('createMessage') + ->with() + ->willReturnOnConsecutiveCalls( + $message12, + $message13, + ); + $this->mailer->expects($this->exactly(2)) + ->method('send') + ->withConsecutive( + [$message12], + [$message13], + )->willReturn([]); + $this->setupURLGeneratorMock(1); + + $vcalendar = $this->getAttendeeVCalendar(); + $this->provider->send($vcalendar->VEVENT, $this->calendarDisplayName, $principalEmailAddresses, $users); } /** @@ -377,6 +453,14 @@ class EmailProviderTest extends AbstractNotificationProviderTest { ]); $vcalendar->VEVENT->add( + 'ORGANIZER', + 'mailto:uid1@example.com', + [ + 'LANG' => 'en' + ] + ); + + $vcalendar->VEVENT->add( 'ATTENDEE', 'mailto:foo1@example.org', [ diff --git a/apps/dav/tests/unit/CalDAV/Reminder/NotificationProvider/PushProviderTest.php b/apps/dav/tests/unit/CalDAV/Reminder/NotificationProvider/PushProviderTest.php index a62cb98a28f..64020b9dbd7 100644 --- a/apps/dav/tests/unit/CalDAV/Reminder/NotificationProvider/PushProviderTest.php +++ b/apps/dav/tests/unit/CalDAV/Reminder/NotificationProvider/PushProviderTest.php @@ -10,6 +10,7 @@ declare(strict_types=1); * @author Georg Ehrke <oc.list@georgehrke.com> * @author Roeland Jago Douma <roeland@famdouma.nl> * @author Thomas Citharel <nextcloud@tcit.fr> + * @author Richard Steinmetz <richard@steinmetz.cloud> * * @license GNU AGPL version 3 or any later version * @@ -90,7 +91,7 @@ class PushProviderTest extends AbstractNotificationProviderTest { $users = [$user1, $user2, $user3]; - $this->provider->send($this->vcalendar->VEVENT, $this->calendarDisplayName, $users); + $this->provider->send($this->vcalendar->VEVENT, $this->calendarDisplayName, [], $users); } public function testSend(): void { @@ -143,7 +144,7 @@ class PushProviderTest extends AbstractNotificationProviderTest { ->method('notify') ->with($notification3); - $this->provider->send($this->vcalendar->VEVENT, $this->calendarDisplayName, $users); + $this->provider->send($this->vcalendar->VEVENT, $this->calendarDisplayName, [], $users); } /** diff --git a/apps/dav/tests/unit/CalDAV/Reminder/ReminderServiceTest.php b/apps/dav/tests/unit/CalDAV/Reminder/ReminderServiceTest.php index 6242e8d0355..79d9376650b 100644 --- a/apps/dav/tests/unit/CalDAV/Reminder/ReminderServiceTest.php +++ b/apps/dav/tests/unit/CalDAV/Reminder/ReminderServiceTest.php @@ -9,6 +9,7 @@ declare(strict_types=1); * @author Georg Ehrke <oc.list@georgehrke.com> * @author Roeland Jago Douma <roeland@famdouma.nl> * @author Thomas Citharel <nextcloud@tcit.fr> + * @author Richard Steinmetz <richard@steinmetz.cloud> * * @license GNU AGPL version 3 or any later version * @@ -33,6 +34,7 @@ use OCA\DAV\CalDAV\Reminder\Backend; use OCA\DAV\CalDAV\Reminder\INotificationProvider; use OCA\DAV\CalDAV\Reminder\NotificationProviderManager; use OCA\DAV\CalDAV\Reminder\ReminderService; +use OCA\DAV\Connector\Sabre\Principal; use OCP\AppFramework\Utility\ITimeFactory; use OCP\IConfig; use OCP\IGroupManager; @@ -202,6 +204,7 @@ EOD; $this->timeFactory = $this->createMock(ITimeFactory::class); $this->config = $this->createMock(IConfig::class); $this->logger = $this->createMock(LoggerInterface::class); + $this->principalConnector = $this->createMock(Principal::class); $this->caldavBackend->method('getShares')->willReturn([]); @@ -214,6 +217,7 @@ EOD; $this->timeFactory, $this->config, $this->logger, + $this->principalConnector, ); } diff --git a/apps/dav/tests/unit/Connector/Sabre/PrincipalTest.php b/apps/dav/tests/unit/Connector/Sabre/PrincipalTest.php index 444c267b509..7cd31e3b8dd 100644 --- a/apps/dav/tests/unit/Connector/Sabre/PrincipalTest.php +++ b/apps/dav/tests/unit/Connector/Sabre/PrincipalTest.php @@ -11,6 +11,7 @@ * @author Morris Jobke <hey@morrisjobke.de> * @author Roeland Jago Douma <roeland@famdouma.nl> * @author Thomas Müller <thomas.mueller@tmit.eu> + * @author Richard Steinmetz <richard@steinmetz.cloud> * * @license AGPL-3.0 * @@ -974,4 +975,34 @@ class PrincipalTest extends TestCase { ['mailto:user3@foo.bar', 'user3@foo.bar', 'principals/users/user3'], ]; } + + public function testGetEmailAddressesOfPrincipal(): void { + $principal = [ + '{http://sabredav.org/ns}email-address' => 'bar@company.org', + '{DAV:}alternate-URI-set' => [ + '/some/url', + 'mailto:foo@bar.com', + 'mailto:duplicate@example.com', + ], + '{urn:ietf:params:xml:ns:caldav}calendar-user-address-set' => [ + 'mailto:bernard@example.com', + 'mailto:bernard.desruisseaux@example.com', + ], + '{http://calendarserver.org/ns/}email-address-set' => [ + 'mailto:duplicate@example.com', + 'mailto:user@some.org', + ], + ]; + + $expected = [ + 'bar@company.org', + 'foo@bar.com', + 'duplicate@example.com', + 'bernard@example.com', + 'bernard.desruisseaux@example.com', + 'user@some.org', + ]; + $actual = $this->connector->getEmailAddressesOfPrincipal($principal); + $this->assertEquals($expected, $actual); + } } |