Notificacations for simple @-mentioning in comments

(WIP) notify user when mentioned in comments

Fix doc, and create absolute URL for as notification link.

PSR-4 compatibility changes

also move notification creation to comments app

Do not notify yourself

unit test for controller and application

smaller fixes

- translatable app name
- remove doubles in mention array
- micro perf optimization
- display name: special label for deleted users, keep user id for users that could not be fetched from userManager

Comment Notification-Listener Unit Test

fix email adresses

remove notification when triggering comment was deleted

add and adjust tests

add missing @license tags

simplify NotificationsController registration

appinfo simplification, php docs

make string easier to translate

adjust test

replace dispatcher-based listeners with a registration method and interface

safer to not pass optional data parameter to setSubject for marking as processed. ID and mention suffices

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>

update comment

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>

4 files changed, 110 insertions, 21 deletions

diff --git a/lib/private/AppFramework/DependencyInjection/DIContainer.php b/lib/private/AppFramework/DependencyInjection/DIContainer.php
index b6f8d8f458d..3f2212a7f24 100644
--- a/lib/private/AppFramework/DependencyInjection/DIContainer.php
+++ b/lib/private/AppFramework/DependencyInjection/DIContainer.php
@@ -161,6 +161,10 @@ class DIContainer extends SimpleContainer implements IAppContainer {
 			return $this->getServer()->getRootFolder();
 		});
 
+		$this->registerService('OCP\\Files\\Folder', function() {
+			return $this->getServer()->getUserFolder();
+		});
+
 		$this->registerService('OCP\\Http\\Client\\IClientService', function($c) {
 			return $this->getServer()->getHTTPClientService();
 		});
diff --git a/lib/private/Comments/Manager.php b/lib/private/Comments/Manager.php
index 59678775d88..f7b23dd5f58 100644
--- a/lib/private/Comments/Manager.php
+++ b/lib/private/Comments/Manager.php
@@ -26,6 +26,7 @@ namespace OC\Comments;
 use Doctrine\DBAL\Exception\DriverException;
 use OCP\Comments\CommentsEvent;
 use OCP\Comments\IComment;
+use OCP\Comments\ICommentsEventHandler;
 use OCP\Comments\ICommentsManager;
 use OCP\Comments\NotFoundException;
 use OCP\DB\QueryBuilder\IQueryBuilder;
@@ -33,7 +34,6 @@ use OCP\IDBConnection;
 use OCP\IConfig;
 use OCP\ILogger;
 use OCP\IUser;
-use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 
 class Manager implements ICommentsManager {
 
@@ -46,30 +46,30 @@ class Manager implements ICommentsManager {
 	/** @var IConfig */
 	protected $config;
 
-	/** @var EventDispatcherInterface */
-	protected $dispatcher;
-
 	/** @var IComment[]  */
 	protected $commentsCache = [];
 
+	/** @var  \Closure[] */
+	protected $eventHandlerClosures = [];
+
+	/** @var  ICommentsEventHandler[] */
+	protected $eventHandlers = [];
+
 	/**
 	 * Manager constructor.
 	 *
 	 * @param IDBConnection $dbConn
 	 * @param ILogger $logger
 	 * @param IConfig $config
-	 * @param EventDispatcherInterface $dispatcher
 	 */
 	public function __construct(
 		IDBConnection $dbConn,
 		ILogger $logger,
-		IConfig $config,
-		EventDispatcherInterface $dispatcher
+		IConfig $config
 	) {
 		$this->dbConn = $dbConn;
 		$this->logger = $logger;
 		$this->config = $config;
-		$this->dispatcher = $dispatcher;
 	}
 
 	/**
@@ -455,10 +455,7 @@ class Manager implements ICommentsManager {
 		}
 
 		if ($affectedRows > 0 && $comment instanceof IComment) {
-			$this->dispatcher->dispatch(CommentsEvent::EVENT_DELETE, new CommentsEvent(
-				CommentsEvent::EVENT_DELETE,
-				$comment
-			));
+			$this->sendEvent(CommentsEvent::EVENT_DELETE, $comment);
 		}
 
 		return ($affectedRows > 0);
@@ -525,13 +522,9 @@ class Manager implements ICommentsManager {
 
 		if ($affectedRows > 0) {
 			$comment->setId(strval($qb->getLastInsertId()));
+			$this->sendEvent(CommentsEvent::EVENT_ADD, $comment);
 		}
 
-		$this->dispatcher->dispatch(CommentsEvent::EVENT_ADD, new CommentsEvent(
-			CommentsEvent::EVENT_ADD,
-			$comment
-		));
-
 		return $affectedRows > 0;
 	}
 
@@ -565,10 +558,7 @@ class Manager implements ICommentsManager {
 			throw new NotFoundException('Comment to update does ceased to exist');
 		}
 
-		$this->dispatcher->dispatch(CommentsEvent::EVENT_UPDATE, new CommentsEvent(
-			CommentsEvent::EVENT_UPDATE,
-			$comment
-		));
+		$this->sendEvent(CommentsEvent::EVENT_UPDATE, $comment);
 
 		return $affectedRows > 0;
 	}
@@ -751,4 +741,51 @@ class Manager implements ICommentsManager {
 		}
 		return ($affectedRows > 0);
 	}
+
+	/**
+	 * registers an Entity to the manager, so event notifications can be send
+	 * to consumers of the comments infrastructure
+	 *
+	 * @param \Closure $closure
+	 */
+	public function registerEventHandler(\Closure $closure) {
+		$this->eventHandlerClosures[] = $closure;
+		$this->eventHandlers = [];
+	}
+
+	/**
+	 * returns valid, registered entities
+	 *
+	 * @return \OCP\Comments\ICommentsEventHandler[]
+	 */
+	private function getEventHandlers() {
+		if(!empty($this->eventHandlers)) {
+			return $this->eventHandlers;
+		}
+
+		$this->eventHandlers = [];
+		foreach ($this->eventHandlerClosures as $name => $closure) {
+			$entity = $closure();
+			if (!($entity instanceof ICommentsEventHandler)) {
+				throw new \InvalidArgumentException('The given entity does not implement the ICommentsEntity interface');
+			}
+			$this->eventHandlers[$name] = $entity;
+		}
+
+		return $this->eventHandlers;
+	}
+
+	/**
+	 * sends notifications to the registered entities
+	 *
+	 * @param $eventType
+	 * @param IComment $comment
+	 */
+	private function sendEvent($eventType, IComment $comment) {
+		$entities = $this->getEventHandlers();
+		$event = new CommentsEvent($eventType, $comment);
+		foreach ($entities as $entity) {
+			$entity->handle($event);
+		}
+	}
 }
diff --git a/lib/public/Comments/ICommentsEventHandler.php b/lib/public/Comments/ICommentsEventHandler.php
new file mode 100644
index 00000000000..33524199012
--- /dev/null
+++ b/lib/public/Comments/ICommentsEventHandler.php
@@ -0,0 +1,39 @@
+<?php
+/**
+ * @copyright Copyright (c) 2016 Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * 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
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Comments;
+
+/**
+ * Interface ICommentsEventHandler
+ *
+ * @package OCP\Comments
+ * @since 9.2.0
+ */
+interface ICommentsEventHandler {
+
+	/**
+	 * @param CommentsEvent $event
+	 * @since 9.2.0
+	 */
+	public function handle(CommentsEvent $event);
+}
diff --git a/lib/public/Comments/ICommentsManager.php b/lib/public/Comments/ICommentsManager.php
index f2edaaa5eaf..98169fb335f 100644
--- a/lib/public/Comments/ICommentsManager.php
+++ b/lib/public/Comments/ICommentsManager.php
@@ -237,4 +237,13 @@ interface ICommentsManager {
 	 */
 	public function deleteReadMarksOnObject($objectType, $objectId);
 
+	/**
+	 * registers an Entity to the manager, so event notifications can be send
+	 * to consumers of the comments infrastructure
+	 *
+	 * @param \Closure $closure
+	 * @since 9.2.0
+	 */
+	public function registerEventHandler(\Closure $closure);
+
 }