Adding IMip scheduling which uses ownClouds mail delivery
This commit is contained in:
parent
2c76b77c76
commit
b3550db02d
|
@ -0,0 +1,110 @@
|
|||
<?php
|
||||
|
||||
namespace OCA\DAV\CalDAV\Schedule;
|
||||
|
||||
use OCP\ILogger;
|
||||
use OCP\Mail\IMailer;
|
||||
use Sabre\DAV;
|
||||
use Sabre\VObject\ITip;
|
||||
use Sabre\CalDAV\Schedule\IMipPlugin as SabreIMipPlugin;
|
||||
/**
|
||||
* iMIP handler.
|
||||
*
|
||||
* This class is responsible for sending out iMIP messages. iMIP is the
|
||||
* email-based transport for iTIP. iTIP deals with scheduling operations for
|
||||
* iCalendar objects.
|
||||
*
|
||||
* If you want to customize the email that gets sent out, you can do so by
|
||||
* extending this class and overriding the sendMessage method.
|
||||
*
|
||||
* @copyright Copyright (C) 2007-2015 fruux GmbH (https://fruux.com/).
|
||||
* @author Evert Pot (http://evertpot.com/)
|
||||
* @license http://sabre.io/license/ Modified BSD License
|
||||
*/
|
||||
class IMipPlugin extends SabreIMipPlugin {
|
||||
|
||||
/** @var IMailer */
|
||||
private $mailer;
|
||||
|
||||
/** @var ILogger */
|
||||
private $logger;
|
||||
|
||||
/**
|
||||
* Creates the email handler.
|
||||
*
|
||||
* @param IMailer $mailer
|
||||
*/
|
||||
function __construct(IMailer $mailer, ILogger $logger) {
|
||||
parent::__construct('');
|
||||
$this->mailer = $mailer;
|
||||
$this->logger = $logger;
|
||||
}
|
||||
|
||||
/**
|
||||
* Event handler for the 'schedule' event.
|
||||
*
|
||||
* @param ITip\Message $iTipMessage
|
||||
* @return void
|
||||
*/
|
||||
function schedule(ITip\Message $iTipMessage) {
|
||||
|
||||
// Not sending any emails if the system considers the update
|
||||
// insignificant.
|
||||
if (!$iTipMessage->significantChange) {
|
||||
if (!$iTipMessage->scheduleStatus) {
|
||||
$iTipMessage->scheduleStatus = '1.0;We got the message, but it\'s not significant enough to warrant an email';
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
$summary = $iTipMessage->message->VEVENT->SUMMARY;
|
||||
|
||||
if (parse_url($iTipMessage->sender, PHP_URL_SCHEME) !== 'mailto') {
|
||||
return;
|
||||
}
|
||||
|
||||
if (parse_url($iTipMessage->recipient, PHP_URL_SCHEME) !== 'mailto') {
|
||||
return;
|
||||
}
|
||||
|
||||
$sender = substr($iTipMessage->sender, 7);
|
||||
$recipient = substr($iTipMessage->recipient, 7);
|
||||
|
||||
$senderName = ($iTipMessage->senderName) ? $iTipMessage->senderName : null;
|
||||
$recipientName = ($iTipMessage->recipientName) ? $iTipMessage->recipientName : null;
|
||||
|
||||
$subject = 'SabreDAV iTIP message';
|
||||
switch (strtoupper($iTipMessage->method)) {
|
||||
case 'REPLY' :
|
||||
$subject = 'Re: ' . $summary;
|
||||
break;
|
||||
case 'REQUEST' :
|
||||
$subject = $summary;
|
||||
break;
|
||||
case 'CANCEL' :
|
||||
$subject = 'Cancelled: ' . $summary;
|
||||
break;
|
||||
}
|
||||
|
||||
$contentType = 'text/calendar; charset=UTF-8; method=' . $iTipMessage->method;
|
||||
|
||||
$message = $this->mailer->createMessage();
|
||||
|
||||
$message->setReplyTo([$sender => $senderName])
|
||||
->setTo([$recipient => $recipientName])
|
||||
->setSubject($subject)
|
||||
->setBody($iTipMessage->message->serialize(), $contentType);
|
||||
try {
|
||||
$failed = $this->mailer->send($message);
|
||||
if ($failed) {
|
||||
$this->logger->error('Unable to deliver message to {failed}', ['app' => 'dav', 'failed' => implode(', ', $failed)]);
|
||||
$iTipMessage->scheduleStatus = '5.0; EMail delivery failed';
|
||||
}
|
||||
$iTipMessage->scheduleStatus = '1.1; Scheduling message is sent via iMip';
|
||||
} catch(\Exception $ex) {
|
||||
$this->logger->logException($ex, ['app' => 'dav']);
|
||||
$iTipMessage->scheduleStatus = '5.0; EMail delivery failed';
|
||||
}
|
||||
}
|
||||
|
||||
}
|
|
@ -2,12 +2,12 @@
|
|||
|
||||
namespace OCA\DAV;
|
||||
|
||||
use OCA\DAV\CalDAV\Schedule\IMipPlugin;
|
||||
use OCA\DAV\Connector\Sabre\Auth;
|
||||
use OCA\DAV\Connector\Sabre\BlockLegacyClientPlugin;
|
||||
use OCA\DAV\Files\CustomPropertiesBackend;
|
||||
use OCP\IRequest;
|
||||
use Sabre\DAV\Auth\Plugin;
|
||||
use Sabre\HTTP\Util;
|
||||
|
||||
class Server {
|
||||
|
||||
|
@ -19,6 +19,7 @@ class Server {
|
|||
$this->baseUri = $baseUri;
|
||||
$logger = \OC::$server->getLogger();
|
||||
$dispatcher = \OC::$server->getEventDispatcher();
|
||||
$mailer = \OC::$server->getMailer();
|
||||
|
||||
$root = new RootCollection();
|
||||
$this->server = new \OCA\DAV\Connector\Sabre\Server($root);
|
||||
|
@ -49,9 +50,8 @@ class Server {
|
|||
// calendar plugins
|
||||
$this->server->addPlugin(new \Sabre\CalDAV\Plugin());
|
||||
$this->server->addPlugin(new \Sabre\CalDAV\ICSExportPlugin());
|
||||
$senderEmail = \OCP\Util::getDefaultEmailAddress('no-reply');
|
||||
$this->server->addPlugin(new \Sabre\CalDAV\Schedule\Plugin());
|
||||
$this->server->addPlugin(new \Sabre\CalDAV\Schedule\IMipPlugin($senderEmail));
|
||||
$this->server->addPlugin(new IMipPlugin($mailer, $logger));
|
||||
$this->server->addPlugin(new \Sabre\CalDAV\SharingPlugin());
|
||||
$this->server->addPlugin(new \Sabre\CalDAV\Subscriptions\Plugin());
|
||||
$this->server->addPlugin(new \Sabre\CalDAV\Notifications\Plugin());
|
||||
|
|
|
@ -0,0 +1,91 @@
|
|||
<?php
|
||||
/**
|
||||
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
||||
*
|
||||
* @copyright Copyright (c) 2015, ownCloud, Inc.
|
||||
* @license AGPL-3.0
|
||||
*
|
||||
* This code is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License, version 3,
|
||||
* as published by the Free Software Foundation.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License, version 3,
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
*/
|
||||
|
||||
namespace OCA\DAV\Tests\Unit\CalDAV\Schedule;
|
||||
|
||||
use OC\Mail\Mailer;
|
||||
use OCA\DAV\CalDAV\Schedule\IMipPlugin;
|
||||
use OCP\ILogger;
|
||||
use Sabre\VObject\Component\VCalendar;
|
||||
use Sabre\VObject\ITip\Message;
|
||||
use Test\TestCase;
|
||||
|
||||
class IMipPluginTest extends TestCase {
|
||||
|
||||
public function testDelivery() {
|
||||
$mailMessage = new \OC\Mail\Message(new \Swift_Message());
|
||||
/** @var Mailer | \PHPUnit_Framework_MockObject_MockObject $mailer */
|
||||
$mailer = $this->getMockBuilder('OC\Mail\Mailer')->disableOriginalConstructor()->getMock();
|
||||
$mailer->method('createMessage')->willReturn($mailMessage);
|
||||
$mailer->expects($this->once())->method('send');
|
||||
/** @var ILogger | \PHPUnit_Framework_MockObject_MockObject $logger */
|
||||
$logger = $this->getMockBuilder('OC\Log')->disableOriginalConstructor()->getMock();
|
||||
|
||||
$plugin = new IMipPlugin($mailer, $logger);
|
||||
$message = new Message();
|
||||
$message->method = 'REQUEST';
|
||||
$message->message = new VCalendar();
|
||||
$message->message->add('VEVENT', [
|
||||
'UID' => $message->uid,
|
||||
'SEQUENCE' => $message->sequence,
|
||||
'SUMMARY' => 'Fellowship meeting',
|
||||
]);
|
||||
$message->sender = 'mailto:gandalf@wiz.ard';
|
||||
$message->recipient = 'mailto:frodo@hobb.it';
|
||||
|
||||
$plugin->schedule($message);
|
||||
$this->assertEquals('1.1', $message->getScheduleStatus());
|
||||
$this->assertEquals('Fellowship meeting', $mailMessage->getSubject());
|
||||
$this->assertEquals(['frodo@hobb.it' => null], $mailMessage->getTo());
|
||||
$this->assertEquals(['gandalf@wiz.ard' => null], $mailMessage->getReplyTo());
|
||||
$this->assertEquals('text/calendar; charset=UTF-8; method=REQUEST', $mailMessage->getSwiftMessage()->getContentType());
|
||||
}
|
||||
|
||||
public function testFailedDelivery() {
|
||||
$mailMessage = new \OC\Mail\Message(new \Swift_Message());
|
||||
/** @var Mailer | \PHPUnit_Framework_MockObject_MockObject $mailer */
|
||||
$mailer = $this->getMockBuilder('OC\Mail\Mailer')->disableOriginalConstructor()->getMock();
|
||||
$mailer->method('createMessage')->willReturn($mailMessage);
|
||||
$mailer->method('send')->willThrowException(new \Exception());
|
||||
/** @var ILogger | \PHPUnit_Framework_MockObject_MockObject $logger */
|
||||
$logger = $this->getMockBuilder('OC\Log')->disableOriginalConstructor()->getMock();
|
||||
|
||||
$plugin = new IMipPlugin($mailer, $logger);
|
||||
$message = new Message();
|
||||
$message->method = 'REQUEST';
|
||||
$message->message = new VCalendar();
|
||||
$message->message->add('VEVENT', [
|
||||
'UID' => $message->uid,
|
||||
'SEQUENCE' => $message->sequence,
|
||||
'SUMMARY' => 'Fellowship meeting',
|
||||
]);
|
||||
$message->sender = 'mailto:gandalf@wiz.ard';
|
||||
$message->recipient = 'mailto:frodo@hobb.it';
|
||||
|
||||
$plugin->schedule($message);
|
||||
$this->assertEquals('5.0', $message->getScheduleStatus());
|
||||
$this->assertEquals('Fellowship meeting', $mailMessage->getSubject());
|
||||
$this->assertEquals(['frodo@hobb.it' => null], $mailMessage->getTo());
|
||||
$this->assertEquals(['gandalf@wiz.ard' => null], $mailMessage->getReplyTo());
|
||||
$this->assertEquals('text/calendar; charset=UTF-8; method=REQUEST', $mailMessage->getSwiftMessage()->getContentType());
|
||||
}
|
||||
|
||||
}
|
|
@ -238,4 +238,14 @@ class Message {
|
|||
public function getSwiftMessage() {
|
||||
return $this->swiftMessage;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $body
|
||||
* @param string $contentType
|
||||
* @return $this
|
||||
*/
|
||||
public function setBody($body, $contentType) {
|
||||
$this->swiftMessage->setBody($body, $contentType);
|
||||
return $this;
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue