Allow to search by comments

Signed-off-by: Joas Schilling <coding@schilljs.com>

3 files changed, 208 insertions, 1 deletions

diff --git a/apps/comments/lib/AppInfo/Application.php b/apps/comments/lib/AppInfo/Application.php
index cbf2733cf3d..3ad00562736 100644
--- a/apps/comments/lib/AppInfo/Application.php
+++ b/apps/comments/lib/AppInfo/Application.php
@@ -27,6 +27,7 @@ use OCA\Comments\Controller\Notifications;
 use OCA\Comments\EventHandler;
 use OCA\Comments\JSSettingsHelper;
 use OCA\Comments\Notification\Notifier;
+use OCA\Comments\Search\Provider;
 use OCP\AppFramework\App;
 use OCP\Comments\CommentsEntityEvent;
 use OCP\Util;
@@ -45,11 +46,15 @@ class Application extends App {
 	}
 
 	public function register() {
-		$dispatcher = $this->getContainer()->getServer()->getEventDispatcher();
+		$server = $this->getContainer()->getServer();
+
+		$dispatcher = $server->getEventDispatcher();
 		$this->registerSidebarScripts($dispatcher);
 		$this->registerDavEntity($dispatcher);
 		$this->registerNotifier();
 		$this->registerCommentsEventHandler();
+
+		$server->getSearch()->registerProvider(Provider::class, ['apps' => ['files']]);
 	}
 
 	protected function registerSidebarScripts(EventDispatcherInterface $dispatcher) {
diff --git a/apps/comments/lib/Search/Provider.php b/apps/comments/lib/Search/Provider.php
new file mode 100644
index 00000000000..78442e3ce0b
--- /dev/null
+++ b/apps/comments/lib/Search/Provider.php
@@ -0,0 +1,93 @@
+<?php
+/**
+ * @copyright Copyright (c) 2018 Joas Schilling <coding@schilljs.com>
+ *
+ * @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 OCA\Comments\Search;
+
+use OCP\Comments\IComment;
+use OCP\Files\Folder;
+use OCP\Files\Node;
+use OCP\Files\NotFoundException;
+use OCP\IUser;
+
+class Provider extends \OCP\Search\Provider {
+
+	/**
+	 * Search for $query
+	 *
+	 * @param string $query
+	 * @return array An array of OCP\Search\Result's
+	 * @since 7.0.0
+	 */
+	public function search($query): array {
+		$cm = \OC::$server->getCommentsManager();
+		$us = \OC::$server->getUserSession();
+
+		$user = $us->getUser();
+		if (!$user instanceof IUser) {
+			return [];
+		}
+		$uf = \OC::$server->getUserFolder($user->getUID());
+
+		if ($uf === null) {
+			return [];
+		}
+
+		/** @var IComment[] $comments */
+		$comments = $cm->search($query, 'files', '', 'comment');
+
+		$result = [];
+		foreach ($comments as $comment) {
+			if ($comment->getActorType() !== 'users') {
+				continue;
+			}
+
+			$displayName = $cm->resolveDisplayName('user', $comment->getActorId());
+
+			try {
+				$file = $this->getFileForComment($uf, $comment);
+				$result[] = new Result($query,
+					$comment,
+					$displayName,
+					$file->getPath()
+				);
+			} catch (NotFoundException $e) {
+				continue;
+			}
+		}
+
+		return $result;
+	}
+
+	/**
+	 * @param Folder $userFolder
+	 * @param IComment $comment
+	 * @return Node
+	 * @throws NotFoundException
+	 */
+	protected function getFileForComment(Folder $userFolder, IComment $comment): Node {
+		$nodes = $userFolder->getById((int) $comment->getObjectId());
+		if (empty($nodes)) {
+			throw new NotFoundException('File not found');
+		}
+
+		return array_shift($nodes);
+	}
+}
diff --git a/apps/comments/lib/Search/Result.php b/apps/comments/lib/Search/Result.php
new file mode 100644
index 00000000000..0a48f9d7b5a
--- /dev/null
+++ b/apps/comments/lib/Search/Result.php
@@ -0,0 +1,109 @@
+<?php
+/**
+ * @copyright Copyright (c) 2018 Joas Schilling <coding@schilljs.com>
+ *
+ * @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 OCA\Comments\Search;
+
+use OCP\Comments\IComment;
+use OCP\Files\NotFoundException;
+use OCP\Search\Result as BaseResult;
+
+class Result extends BaseResult {
+
+	public $type = 'comment';
+	public $comment;
+	public $authorId;
+	public $authorName;
+	public $path;
+	public $fileName;
+
+	/**
+	 * @param string $search
+	 * @param IComment $comment
+	 * @param string $authorName
+	 * @param string $path
+	 * @throws NotFoundException
+	 */
+	public function __construct(string $search,
+								IComment $comment,
+								string $authorName,
+								string $path) {
+		parent::__construct(
+			(int) $comment->getId(),
+			$comment->getMessage()
+		/* @todo , [link to file] */
+		);
+
+		$this->comment = $this->getRelevantMessagePart($comment->getMessage(), $search);
+		$this->authorId = $comment->getActorId();
+		$this->authorName = $authorName;
+		$this->fileName = basename($path);
+		$this->path = $this->getVisiblePath($path);
+	}
+
+	/**
+	 * @param string $path
+	 * @return string
+	 * @throws NotFoundException
+	 */
+	protected function getVisiblePath(string $path): string {
+		$segments = explode('/', trim($path, '/'), 3);
+
+		if (!isset($segments[2])) {
+			throw new NotFoundException('Path not inside visible section');
+		}
+
+		return $segments[2];
+	}
+
+	/**
+	 * @param string $message
+	 * @param string $search
+	 * @return string
+	 * @throws NotFoundException
+	 */
+	protected function getRelevantMessagePart(string $message, string $search): string {
+		$start = stripos($message, $search);
+		if ($start === false) {
+			throw new NotFoundException('Comment section not found');
+		}
+
+		$end = $start + strlen($search);
+
+		if ($start <= 25) {
+			$start = 0;
+			$prefix = '';
+		} else {
+			$start -= 25;
+			$prefix = '…';
+		}
+
+		if ((strlen($message) - $end) <= 25) {
+			$end = strlen($message);
+			$suffix = '';
+		} else {
+			$end += 25;
+			$suffix = '…';
+		}
+
+		return $prefix . substr($message, $start, $end - $start) . $suffix;
+	}
+
+}