Merge pull request #12392 from brad2014/feature/properly-present-buttons-from-imip-mails

Customize presentation of accept/decline buttons in iMip mail

2 files changed, 198 insertions, 213 deletions

diff --git a/apps/dav/lib/CalDAV/Schedule/IMipPlugin.php b/apps/dav/lib/CalDAV/Schedule/IMipPlugin.php
index 3ff3ed0c569..56b3ab04ddc 100644
--- a/apps/dav/lib/CalDAV/Schedule/IMipPlugin.php
+++ b/apps/dav/lib/CalDAV/Schedule/IMipPlugin.php
@@ -239,9 +239,42 @@ class IMipPlugin extends SabreIMipPlugin {
 			$meetingAttendeeName, $meetingInviteeName);
 		$this->addBulletList($template, $l10n, $meetingWhen, $meetingLocation,
 			$meetingDescription, $meetingUrl);
-		$this->addResponseButtons($template, $l10n, $iTipMessage, $lastOccurrence);
+
+
+		// Only add response buttons to invitation requests: Fix Issue #11230
+		if (($method == self::METHOD_REQUEST) && $this->getAttendeeRSVP($attendee)) {
+
+			/*
+			** Only offer invitation accept/reject buttons, which link back to the
+			** nextcloud server, to recipients who can access the nextcloud server via
+			** their internet/intranet.  Issue #12156
+			**
+			** The app setting is stored in the appconfig database table.
+			**
+			** For nextcloud servers accessible to the public internet, the default
+			** "invitation_link_recipients" value "yes" (all recipients) is appropriate.
+			**
+			** When the nextcloud server is restricted behind a firewall, accessible
+			** only via an internal network or via vpn, you can set "dav.invitation_link_recipients"
+			** to the email address or email domain, or comma separated list of addresses or domains,
+			** of recipients who can access the server.
+			**
+			** To always deliver URLs, set invitation_link_recipients to "yes".
+			** To suppress URLs entirely, set invitation_link_recipients to boolean "no".
+			*/
+
+			$recipientDomain = substr(strrchr($recipient, "@"), 1);
+			$invitationLinkRecipients = explode(',', preg_replace('/\s+/', '', strtolower($this->config->getAppValue('dav', 'invitation_link_recipients', 'yes'))));
+
+			if (strcmp('yes', $invitationLinkRecipients[0]) === 0
+				 || in_array(strtolower($recipient), $invitationLinkRecipients)
+				 || in_array(strtolower($recipientDomain), $invitationLinkRecipients)) {
+				$this->addResponseButtons($template, $l10n, $iTipMessage, $lastOccurrence);
+			}
+		}
 
 		$template->addFooter();
+
 		$message->useTemplate($template);
 
 		$attachment = $this->mailer->createAttachment(
@@ -346,6 +379,21 @@ class IMipPlugin extends SabreIMipPlugin {
 	}
 
 	/**
+	 * @param Property|null $attendee
+	 * @return bool
+	 */
+	private function getAttendeeRSVP(Property $attendee = null) {
+		if ($attendee !== null) {
+			$rsvp = $attendee->offsetGet('RSVP');
+			if (($rsvp instanceof Parameter) && (strcasecmp($rsvp->getValue(), 'TRUE') === 0)) {
+				return true;
+			}
+		}
+		// RFC 5545 3.2.17: default RSVP is false
+		return false;
+	}
+
+	/**
 	 * @param IL10N $l10n
 	 * @param Property $dtstart
 	 * @param Property $dtend
@@ -447,7 +495,6 @@ class IMipPlugin extends SabreIMipPlugin {
 			$template->setSubject('Invitation: ' . $summary);
 			$template->addHeading($l10n->t('%1$s invited you to »%2$s«', [$inviteeName, $summary]), $l10n->t('Hello %s,', [$attendeeName]));
 		}
-
 	}
 
 	/**
@@ -504,7 +551,7 @@ class IMipPlugin extends SabreIMipPlugin {
 			$moreOptionsURL, $l10n->t('More options …')
 		]);
 		$text = $l10n->t('More options at %s', [$moreOptionsURL]);
-		
+
 		$template->addBodyText($html, $text);
 	}
 
diff --git a/apps/dav/tests/unit/CalDAV/Schedule/IMipPluginTest.php b/apps/dav/tests/unit/CalDAV/Schedule/IMipPluginTest.php
index c95b32041e0..967f3a51481 100644
--- a/apps/dav/tests/unit/CalDAV/Schedule/IMipPluginTest.php
+++ b/apps/dav/tests/unit/CalDAV/Schedule/IMipPluginTest.php
@@ -48,166 +48,76 @@ use Test\TestCase;
 
 class IMipPluginTest extends TestCase {
 
-	public function testDelivery() {
-		$mailMessage = $this->createMock(IMessage::class);
-		$mailMessage->method('setFrom')->willReturn($mailMessage);
-		$mailMessage->method('setReplyTo')->willReturn($mailMessage);
-		$mailMessage->method('setTo')->willReturn($mailMessage);
-		/** @var Mailer | \PHPUnit_Framework_MockObject_MockObject $mailer */
-		$mailer = $this->getMockBuilder(IMailer::class)->disableOriginalConstructor()->getMock();
-		$emailTemplate = $this->createMock(IEMailTemplate::class);
-		$emailAttachment = $this->createMock(IAttachment::class);
-		$mailer->method('createEMailTemplate')->willReturn($emailTemplate);
-		$mailer->method('createMessage')->willReturn($mailMessage);
-		$mailer->method('createAttachment')->willReturn($emailAttachment);
-		$mailer->expects($this->once())->method('send');
-		/** @var ILogger | \PHPUnit_Framework_MockObject_MockObject $logger */
-		$logger = $this->getMockBuilder(ILogger::class)->disableOriginalConstructor()->getMock();
-		$timeFactory = $this->getMockBuilder(ITimeFactory::class)->disableOriginalConstructor()->getMock();
-		$timeFactory->method('getTime')->willReturn(1);
-		/** @var IConfig | \PHPUnit_Framework_MockObject_MockObject $config */
-		$config = $this->createMock(IConfig::class);
-		$l10n = $this->createMock(IL10N::class);
-		/** @var IFactory | \PHPUnit_Framework_MockObject_MockObject $l10nFactory */
-		$l10nFactory = $this->createMock(IFactory::class);
-		$l10nFactory->method('get')->willReturn($l10n);
-		/** @var IURLGenerator | \PHPUnit_Framework_MockObject_MockObject $urlGenerator */
-		$urlGenerator = $this->createMock(IURLGenerator::class);
-		/** @var IDBConnection | \PHPUnit_Framework_MockObject_MockObject $db */
-		$db = $this->createMock(IDBConnection::class);
-		/** @var ISecureRandom | \PHPUnit_Framework_MockObject_MockObject $random */
-		$random = $this->createMock(ISecureRandom::class);
-		/** @var Defaults | \PHPUnit_Framework_MockObject_MockObject $defaults */
-		$defaults = $this->createMock(Defaults::class);
-		$defaults->expects($this->once())
-			->method('getName')
-			->will($this->returnValue('Instance Name 123'));
+        public function setUp() {
+		$this->mailMessage = $this->createMock(IMessage::class);
+		$this->mailMessage->method('setFrom')->willReturn($this->mailMessage);
+		$this->mailMessage->method('setReplyTo')->willReturn($this->mailMessage);
+		$this->mailMessage->method('setTo')->willReturn($this->mailMessage);
 
-		$random->expects($this->once())
-			->method('generate')
-			->with(60, 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789')
-			->will($this->returnValue('random_token'));
+		$this->mailer = $this->getMockBuilder(IMailer::class)->disableOriginalConstructor()->getMock();
+		$this->mailer->method('createMessage')->willReturn($this->mailMessage);
 
-		$queryBuilder = $this->createMock(IQueryBuilder::class);
+		$this->emailTemplate = $this->createMock(IEMailTemplate::class);
+		$this->mailer->method('createEMailTemplate')->willReturn($this->emailTemplate);
 
-		$db->expects($this->once())
-			->method('getQueryBuilder')
-			->with()
-			->will($this->returnValue($queryBuilder));
-		$queryBuilder->expects($this->at(0))
-			->method('insert')
-			->with('calendar_invitations')
-			->will($this->returnValue($queryBuilder));
-		$queryBuilder->expects($this->at(8))
-			->method('values')
-			->will($this->returnValue($queryBuilder));
-		$queryBuilder->expects($this->at(9))
-			->method('execute');
-
-		$plugin = new IMipPlugin($config, $mailer, $logger, $timeFactory, $l10nFactory, $urlGenerator, $defaults, $random, $db, 'user123');
-		$message = new Message();
-		$message->method = 'REQUEST';
-		$message->message = new VCalendar();
-		$message->message->add('VEVENT', [
-			'UID' => $message->uid,
-			'SEQUENCE' => $message->sequence,
-			'SUMMARY' => 'Fellowship meeting',
-			'DTSTART' => new \DateTime('2017-01-01 00:00:00') // 1483228800
-		]);
-		$message->sender = 'mailto:gandalf@wiz.ard';
-		$message->recipient = 'mailto:frodo@hobb.it';
+		$this->emailAttachment = $this->createMock(IAttachment::class);
+		$this->mailer->method('createAttachment')->willReturn($this->emailAttachment);
 
-		$emailTemplate->expects($this->once())
-			->method('setSubject')
-			->with('Invitation: Fellowship meeting');
-		$mailMessage->expects($this->once())
-			->method('setTo')
-			->with(['frodo@hobb.it' => null]);
-		$mailMessage->expects($this->once())
-			->method('setReplyTo')
-			->with(['gandalf@wiz.ard' => null]);
+		$logger = $this->getMockBuilder(ILogger::class)->disableOriginalConstructor()->getMock();
 
-		$plugin->schedule($message);
-		$this->assertEquals('1.1', $message->getScheduleStatus());
-	}
+		$this->timeFactory = $this->getMockBuilder(ITimeFactory::class)->disableOriginalConstructor()->getMock();
+		$this->timeFactory->method('getTime')->willReturn(1496912528); // 2017-01-01
+
+		$this->config = $this->createMock(IConfig::class);
 
-	public function testFailedDelivery() {
-		$mailMessage = $this->createMock(IMessage::class);
-		$mailMessage->method('setFrom')->willReturn($mailMessage);
-		$mailMessage->method('setReplyTo')->willReturn($mailMessage);
-		$mailMessage->method('setTo')->willReturn($mailMessage);
-		/** @var Mailer | \PHPUnit_Framework_MockObject_MockObject $mailer */
-		$mailer = $this->getMockBuilder(IMailer::class)->disableOriginalConstructor()->getMock();
-		$emailTemplate = $this->createMock(IEMailTemplate::class);
-		$emailAttachment = $this->createMock(IAttachment::class);
-		$mailer->method('createEMailTemplate')->willReturn($emailTemplate);
-		$mailer->method('createMessage')->willReturn($mailMessage);
-		$mailer->method('createAttachment')->willReturn($emailAttachment);
-		$mailer->method('send')->willThrowException(new \Exception());
-		/** @var ILogger | \PHPUnit_Framework_MockObject_MockObject $logger */
-		$logger = $this->getMockBuilder(ILogger::class)->disableOriginalConstructor()->getMock();
-		$timeFactory = $this->getMockBuilder(ITimeFactory::class)->disableOriginalConstructor()->getMock();
-		$timeFactory->method('getTime')->willReturn(1);
-		/** @var IConfig | \PHPUnit_Framework_MockObject_MockObject $config */
-		$config = $this->createMock(IConfig::class);
 		$l10n = $this->createMock(IL10N::class);
-		/** @var IFactory | \PHPUnit_Framework_MockObject_MockObject $l10nFactory */
 		$l10nFactory = $this->createMock(IFactory::class);
 		$l10nFactory->method('get')->willReturn($l10n);
-		/** @var IURLGenerator | \PHPUnit_Framework_MockObject_MockObject $urlGenerator */
+
 		$urlGenerator = $this->createMock(IURLGenerator::class);
-		/** @var IDBConnection | \PHPUnit_Framework_MockObject_MockObject $db */
+
+		$this->queryBuilder = $this->createMock(IQueryBuilder::class);
 		$db = $this->createMock(IDBConnection::class);
-		/** @var ISecureRandom | \PHPUnit_Framework_MockObject_MockObject $random */
-		$random = $this->createMock(ISecureRandom::class);
-		/** @var Defaults | \PHPUnit_Framework_MockObject_MockObject $defaults */
-		$defaults = $this->createMock(Defaults::class);
+		$db->method('getQueryBuilder')
+			->with()
+			->will($this->returnValue($this->queryBuilder));
 
-		$random->expects($this->once())
-			->method('generate')
+		$random = $this->createMock(ISecureRandom::class);
+		$random->method('generate')
 			->with(60, 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789')
 			->will($this->returnValue('random_token'));
 
-		$queryBuilder = $this->createMock(IQueryBuilder::class);
+		$defaults = $this->createMock(Defaults::class);
+		$defaults->method('getName')
+			->will($this->returnValue('Instance Name 123'));
 
-		$db->expects($this->once())
-			->method('getQueryBuilder')
-			->with()
-			->will($this->returnValue($queryBuilder));
-		$queryBuilder->expects($this->at(0))
-			->method('insert')
-			->with('calendar_invitations')
-			->will($this->returnValue($queryBuilder));
-		$queryBuilder->expects($this->at(8))
-			->method('values')
-			->will($this->returnValue($queryBuilder));
-		$queryBuilder->expects($this->at(9))
-			->method('execute');
-
-		$plugin = new IMipPlugin($config, $mailer, $logger, $timeFactory, $l10nFactory, $urlGenerator, $defaults, $random, $db, 'user123');
-		$message = new Message();
-		$message->method = 'REQUEST';
-		$message->message = new VCalendar();
-		$message->message->add('VEVENT', [
-			'UID' => $message->uid,
-			'SEQUENCE' => $message->sequence,
-			'SUMMARY' => 'Fellowship meeting',
-			'DTSTART' => new \DateTime('2017-01-01 00:00:00') // 1483228800
-		]);
-		$message->sender = 'mailto:gandalf@wiz.ard';
-		$message->recipient = 'mailto:frodo@hobb.it';
+		$this->plugin = new IMipPlugin($this->config, $this->mailer, $logger, $this->timeFactory, $l10nFactory, $urlGenerator, $defaults, $random, $db, 'user123');
+	}
 
-		$emailTemplate->expects($this->once())
-			->method('setSubject')
-			->with('Invitation: Fellowship meeting');
-		$mailMessage->expects($this->once())
-			->method('setTo')
-			->with(['frodo@hobb.it' => null]);
-		$mailMessage->expects($this->once())
-			->method('setReplyTo')
-			->with(['gandalf@wiz.ard' => null]);
+	public function testDelivery() {
+		$this->config
+			->method('getAppValue')
+			->with('dav', 'invitation_link_recipients', 'yes')
+			->willReturn('yes');
+
+		$message = $this->_testMessage();
+		$this->_expectSend();
+		$this->plugin->schedule($message);
+		$this->assertEquals('1.1', $message->getScheduleStatus());
+	}
 
-		$plugin->schedule($message);
+	public function testFailedDelivery() {
+		$this->config
+			->method('getAppValue')
+			->with('dav', 'invitation_link_recipients', 'yes')
+			->willReturn('yes');
+
+		$message = $this->_testMessage();
+		$this->mailer
+			->method('send')
+			->willThrowException(new \Exception());
+		$this->_expectSend();
+		$this->plugin->schedule($message);
 		$this->assertEquals('5.0', $message->getScheduleStatus());
 	}
 
@@ -215,77 +125,17 @@ class IMipPluginTest extends TestCase {
 	 * @dataProvider dataNoMessageSendForPastEvents
 	 */
 	public function testNoMessageSendForPastEvents($veventParams, $expectsMail) {
-		$mailMessage = $this->createMock(IMessage::class);
-		$mailMessage->method('setFrom')->willReturn($mailMessage);
-		$mailMessage->method('setReplyTo')->willReturn($mailMessage);
-		$mailMessage->method('setTo')->willReturn($mailMessage);
-		/** @var Mailer | \PHPUnit_Framework_MockObject_MockObject $mailer */
-		$mailer = $this->getMockBuilder(IMailer::class)->disableOriginalConstructor()->getMock();
-		$emailTemplate = $this->createMock(IEMailTemplate::class);
-		$emailAttachment = $this->createMock(IAttachment::class);
-		$mailer->method('createEMailTemplate')->willReturn($emailTemplate);
-		$mailer->method('createMessage')->willReturn($mailMessage);
-		$mailer->method('createAttachment')->willReturn($emailAttachment);
-		if ($expectsMail) {
-			$mailer->expects($this->once())->method('send');
-		} else {
-			$mailer->expects($this->never())->method('send');
-		}
-		/** @var ILogger | \PHPUnit_Framework_MockObject_MockObject $logger */
-		$logger = $this->getMockBuilder(ILogger::class)->disableOriginalConstructor()->getMock();
-		$timeFactory = $this->getMockBuilder(ITimeFactory::class)->disableOriginalConstructor()->getMock();
-		$timeFactory->method('getTime')->willReturn(1496912528);
-		/** @var IConfig | \PHPUnit_Framework_MockObject_MockObject $config */
-		$config = $this->createMock(IConfig::class);
-		$l10n = $this->createMock(IL10N::class);
-		/** @var IFactory | \PHPUnit_Framework_MockObject_MockObject $l10nFactory */
-		$l10nFactory = $this->createMock(IFactory::class);
-		$l10nFactory->method('get')->willReturn($l10n);
-		/** @var IURLGenerator | \PHPUnit_Framework_MockObject_MockObject $urlGenerator */
-		$urlGenerator = $this->createMock(IURLGenerator::class);
-		/** @var IDBConnection | \PHPUnit_Framework_MockObject_MockObject $db */
-		$db = $this->createMock(IDBConnection::class);
-		/** @var ISecureRandom | \PHPUnit_Framework_MockObject_MockObject $random */
-		$random = $this->createMock(ISecureRandom::class);
-		/** @var Defaults | \PHPUnit_Framework_MockObject_MockObject $defaults */
-		$defaults = $this->createMock(Defaults::class);
 
-		if ($expectsMail) {
-			$random->expects($this->once())
-				->method('generate')
-				->with(60, 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789')
-				->will($this->returnValue('random_token'));
-
-			$queryBuilder = $this->createMock(IQueryBuilder::class);
-
-			$db->expects($this->once())
-				->method('getQueryBuilder')
-				->with()
-				->will($this->returnValue($queryBuilder));
-			$queryBuilder->expects($this->at(0))
-				->method('insert')
-				->with('calendar_invitations')
-				->will($this->returnValue($queryBuilder));
-			$queryBuilder->expects($this->at(8))
-				->method('values')
-				->will($this->returnValue($queryBuilder));
-			$queryBuilder->expects($this->at(9))
-				->method('execute');
-		}
+		$this->config
+			->method('getAppValue')
+			->with('dav', 'invitation_link_recipients', 'yes')
+			->willReturn('yes');
 
-		$plugin = new IMipPlugin($config, $mailer, $logger, $timeFactory, $l10nFactory, $urlGenerator, $defaults, $random, $db, 'user123');
-		$message = new Message();
-		$message->method = 'REQUEST';
-		$message->message = new VCalendar();
-		$message->message->add('VEVENT', array_merge([
-			'UID' => 'uid1337',
-			'SEQUENCE' => 42,
-			'SUMMARY' => 'Fellowship meeting',
-		], $veventParams));
-		$message->sender = 'mailto:gandalf@wiz.ard';
-		$message->recipient = 'mailto:frodo@hobb.it';
+		$message = $this->_testMessage( $veventParams );
+
+		$this->_expectSend('frodo@hobb.it', $expectsMail, $expectsMail);
 
-		$plugin->schedule($message);
+		$this->plugin->schedule($message);
 
 		if ($expectsMail) {
 			$this->assertEquals('1.1', $message->getScheduleStatus());
@@ -308,4 +158,92 @@ class IMipPluginTest extends TestCase {
 			[['DTSTART' => new \DateTime('2017-01-01 00:00:00'), 'DTEND' => new \DateTime('2017-01-01 00:00:00'), 'RRULE' => 'FREQ=WEEKLY;UNTIL=20171001T000000Z'], true],
 		];
 	}
+
+	/**
+	* @dataProvider dataIncludeResponseButtons
+	*/
+	public function testIncludeResponseButtons( $config_setting, $recipient, $has_buttons ) {
+		$message = $this->_testMessage([],$recipient);
+
+		$this->_expectSend($recipient, true, $has_buttons);
+		$this->config
+			->method('getAppValue')
+			->with('dav', 'invitation_link_recipients', 'yes')
+			->willReturn($config_setting);
+
+		$this->plugin->schedule($message);
+		$this->assertEquals('1.1', $message->getScheduleStatus());
+	}
+
+	public function dataIncludeResponseButtons() {
+		return [
+			// dav.invitation_link_recipients, recipient, $has_buttons
+			[ 'yes', 'joe@internal.com', true],
+			[ 'joe@internal.com', 'joe@internal.com', true],
+			[ 'internal.com', 'joe@internal.com', true],
+			[ 'pete@otherinternal.com,internal.com', 'joe@internal.com', true],
+			[ 'no', 'joe@internal.com', false],
+			[ 'internal.com', 'joe@external.com', false],
+			[ 'jane@otherinternal.com,internal.com', 'joe@otherinternal.com', false],
+		];
+	}
+
+	private function _testMessage($attrs = [], $recipient = 'frodo@hobb.it' ) {
+		$message = new Message();
+		$message->method = 'REQUEST';
+		$message->message = new VCalendar();
+		$message->message->add('VEVENT', array_merge([
+			'UID' => 'uid-1234',
+			'SEQUENCE' => 0,
+			'SUMMARY' => 'Fellowship meeting',
+			'DTSTART' => new \DateTime('2018-01-01 00:00:00')
+		], $attrs));
+		$message->message->VEVENT->add( 'ORGANIZER', 'mailto:gandalf@wiz.ard' );
+		$message->message->VEVENT->add( 'ATTENDEE', 'mailto:'.$recipient, [ 'RSVP' => 'TRUE' ] );
+		$message->sender = 'mailto:gandalf@wiz.ard';
+		$message->recipient = 'mailto:'.$recipient;
+		return $message;
+	}
+
+
+        private function _expectSend( $recipient = 'frodo@hobb.it', $expectSend = true, $expectButtons = true ) {
+
+		// if the event is in the past, we skip out
+		if (!$expectSend) {
+			$this->mailer
+				->expects($this->never())
+				->method('send');
+			return;
+		}
+
+		$this->emailTemplate->expects($this->once())
+			->method('setSubject')
+			->with('Invitation: Fellowship meeting');
+		$this->mailMessage->expects($this->once())
+			->method('setTo')
+			->with([$recipient => null]);
+		$this->mailMessage->expects($this->once())
+			->method('setReplyTo')
+			->with(['gandalf@wiz.ard' => null]);
+		$this->mailer
+			->expects($this->once())
+			->method('send');
+
+		if ($expectButtons) {
+			$this->queryBuilder->expects($this->at(0))
+				->method('insert')
+				->with('calendar_invitations')
+				->will($this->returnValue($this->queryBuilder));
+			$this->queryBuilder->expects($this->at(8))
+				->method('values')
+				->will($this->returnValue($this->queryBuilder));
+			$this->queryBuilder->expects($this->at(9))
+				->method('execute');
+		}
+		else {
+			$this->queryBuilder->expects($this->never())
+				->method('insert')
+				->with('calendar_invitations');
+		}
+	}
 }