Create a typed \OCP\Mail\Events\BeforeMessageSent in lib/public/Mail/Events

Signed-off-by: Arne Hamann <kontakt+github@arne.email>

Author: tacruc

lib/private/Mail/Mailer.php

@@ -35,6 +35,7 @@
 use Egulias\EmailValidator\EmailValidator;
 use Egulias\EmailValidator\Validation\RFCValidation;
 use OCP\Defaults;
+use OCP\EventDispatcher\IEventDispatcher;
 use OCP\IConfig;
 use OCP\IL10N;
 use OCP\ILogger;
@@ -43,8 +44,7 @@
 use OCP\Mail\IEMailTemplate;
 use OCP\Mail\IMailer;
 use OCP\Mail\IMessage;
-use Symfony\Component\EventDispatcher\EventDispatcherInterface;
-use Symfony\Component\EventDispatcher\GenericEvent;
+use OCP\Mail\Events\BeforeMessageSent;
 
 
 /**
@@ -78,7 +78,7 @@ class Mailer implements IMailer {
 	private $urlGenerator;
 	/** @var IL10N */
 	private $l10n;
-	/** @var EventDispatcherInterface */
+	/** @var IEventDispatcher */
     private $dispatcher;
 
 	/**
@@ -87,14 +87,14 @@ class Mailer implements IMailer {
 	 * @param Defaults $defaults
 	 * @param IURLGenerator $urlGenerator
 	 * @param IL10N $l10n
-	 * @param EventDispatcherInterface $dispatcher
+	 * @param IEventDispatcher $dispatcher
 	 */
 	public function __construct(IConfig $config,
 						 ILogger $logger,
 						 Defaults $defaults,
 						 IURLGenerator $urlGenerator,
 						 IL10N $l10n,
-						 EventDispatcherInterface $dispatcher) {
+						 IEventDispatcher $dispatcher) {
 		$this->config = $config;
 		$this->logger = $logger;
 		$this->defaults = $defaults;
@@ -191,8 +191,8 @@ public function send(IMessage $message): array {
 			$mailer->registerPlugin(new \Swift_Plugins_LoggerPlugin($mailLogger));
 		}
 
-		$this->dispatcher->dispatch('\OC\Mail::preSendMessage',
-			new GenericEvent($message));
+
+		$this->dispatcher->dispatchTyped(new BeforeMessageSent($message));
 
 		$mailer->send($message->getSwiftMessage(), $failedRecipients);
 

lib/private/Server.php

@@ -947,7 +947,7 @@ public function __construct($webRoot, \OC\Config $config) {
 				$c->query(Defaults::class),
 				$c->getURLGenerator(),
 				$c->getL10N('lib'),
-				$c->getEventDispatcher()
+				$c->query(IEventDispatcher::class)
 			);
 		});
 		$this->registerAlias('Mailer', \OCP\Mail\IMailer::class);

tests/lib/Mail/MailerTest.php

@@ -11,19 +11,19 @@
 
 namespace Test\Mail;
 
-use OC\Activity\Event;
+
 use OC\Mail\EMailTemplate;
 use OC\Mail\Mailer;
 use OCP\Defaults;
+use OCP\EventDispatcher\IEventDispatcher;
 use OCP\IConfig;
 use OCP\IL10N;
 use OCP\ILogger;
 use OCP\IURLGenerator;
+use OCP\Mail\Events\BeforeMessageSent;
 use OCP\Mail\IMessage;
 use Test\TestCase;
 use Swift_SwiftException;
-use Symfony\Component\EventDispatcher\EventDispatcherInterface;
-use Symfony\Component\EventDispatcher\GenericEvent;
 
 class MailerTest extends TestCase {
 	/** @var IConfig|\PHPUnit_Framework_MockObject_MockObject */
@@ -38,9 +38,10 @@ class MailerTest extends TestCase {
 	private $l10n;
 	/** @var Mailer */
 	private $mailer;
-	/** @var EventDispatcherInterface */
+	/** @var IEventDispatcher */
 	private $dispatcher;
 
+
 	protected function setUp(): void {
 		parent::setUp();
 
@@ -49,7 +50,7 @@ protected function setUp(): void {
 		$this->logger = $this->createMock(ILogger::class);
 		$this->urlGenerator = $this->createMock(IURLGenerator::class);
 		$this->l10n = $this->createMock(IL10N::class);
-        $this->dispatcher = $this->createMock(EventDispatcherInterface::class);
+        $this->dispatcher = $this->createMock(IEventDispatcher::class);
 		$this->mailer = new Mailer(
 			$this->config,
 			$this->logger,
@@ -136,9 +137,9 @@ public function testEvents() {
 
 
 		$this->dispatcher->expects($this->at(0))
-			->method('dispatch')
-			->with('\OC\Mail::preSendMessage', $this->callback(function(GenericEvent $e) use ($test, $message, &$count) {
-				$m = $e->getSubject('message');
+			->method('dispatchTyped')
+			->with($this->callback(function(BeforeMessageSent $e) use ($test, $message, &$count) {
+				$m = $e->getMessage();
 				$test->assertEquals($message, $m);
 				$count++;
 				return $m === $message;