Implement advanced search queries

Signed-off-by: Julius Härtl <jus@bitgrid.net>

lib/Search/CardCommentProvider.php

@@ -0,0 +1,84 @@
+<?php
+/**
+ * @copyright Copyright (c) 2020 Julius Härtl <jus@bitgrid.net>
+ *
+ * @author Julius Härtl <jus@bitgrid.net>
+ *
+ * @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/>.
+ *
+ */
+
+declare(strict_types=1);
+
+
+namespace OCA\Deck\Search;
+
+use OCA\Deck\Service\SearchService;
+use OCP\IL10N;
+use OCP\IUser;
+use OCP\Search\IProvider;
+use OCP\Search\ISearchQuery;
+use OCP\Search\SearchResult;
+
+class CardCommentProvider implements IProvider {
+
+	/** @var SearchService */
+	private $searchService;
+	/** @var IL10N */
+	private $l10n;
+
+	public function __construct(
+		SearchService $searchService,
+		IL10N $l10n
+	) {
+		$this->searchService = $searchService;
+		$this->l10n = $l10n;
+	}
+
+	public function getId(): string {
+		return 'deck-comment';
+	}
+
+	public function getName(): string {
+		return $this->l10n->t('Card comments');
+	}
+
+	public function search(IUser $user, ISearchQuery $query): SearchResult {
+		$cursor = $query->getCursor() !== null ? (int)$query->getCursor() : null;
+		$results = $this->searchService->searchComments($query->getTerm(), $query->getLimit(), $cursor);
+		if (count($results) < $query->getLimit()) {
+			return SearchResult::complete(
+				$this->l10n->t('Card comments'),
+				$results,
+			);
+		}
+		
+		return SearchResult::paginated(
+			$this->l10n->t('Card comments'),
+			$results,
+			$results[count($results) - 1]->getCommentId()
+		);
+	}
+
+	public function getOrder(string $route, array $routeParameters): int {
+		// Negative value to force showing deck providers on first position if the app is opened
+		// This provider always has an order 1 higher than the default DeckProvider
+		if ($route === 'deck.Page.index') {
+			return -4;
+		}
+		return 11;
+	}
+}

lib/Search/CommentSearchResultEntry.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ * @copyright Copyright (c) 2020 Julius Härtl <jus@bitgrid.net>
+ *
+ * @author Julius Härtl <jus@bitgrid.net>
+ *
+ * @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/>.
+ *
+ */
+
+declare(strict_types=1);
+
+
+namespace OCA\Deck\Search;
+
+use OCA\Deck\Db\Card;
+use OCP\IL10N;
+use OCP\IURLGenerator;
+use OCP\Search\SearchResultEntry;
+
+class CommentSearchResultEntry extends SearchResultEntry {
+	private $commentId;
+
+	public function __construct(string $commentId, string $commentMessage, string $commentAuthor, Card $card, IURLGenerator $urlGenerator, IL10N $l10n) {
+		parent::__construct(
+			'',
+			// TRANSLATORS This is describing the author and card title related to a comment e.g. "Jane on MyTask"
+			$l10n->t('%s on %s', [$commentAuthor, $card->getTitle()]),
+			$commentMessage,
+			$urlGenerator->linkToRouteAbsolute('deck.page.index') . '#/board/' . $card->getRelatedBoard()->getId() . '/card/' . $card->getId() . '/comments/' . $commentId, // $commentId
+			'icon-comment');
+		$this->commentId = $commentId;
+	}
+
+	public function getCommentId(): string {
+		return $this->commentId;
+	}
+}

lib/Search/DeckProvider.php

@@ -28,9 +28,7 @@ namespace OCA\Deck\Search;
 
 use OCA\Deck\Db\Board;
 use OCA\Deck\Db\Card;
-use OCA\Deck\Db\CardMapper;
-use OCA\Deck\Db\StackMapper;
-use OCA\Deck\Service\BoardService;
+use OCA\Deck\Service\SearchService;
 use OCP\IURLGenerator;
 use OCP\IUser;
 use OCP\Search\IProvider;
@@ -40,31 +38,19 @@ use OCP\Search\SearchResult;
 class DeckProvider implements IProvider {
 
 	/**
-	 * @var BoardService
+	 * @var SearchService
 	 */
-	private $boardService;
-	/**
-	 * @var CardMapper
-	 */
-	private $cardMapper;
-	/**
-	 * @var StackMapper
-	 */
-	private $stackMapper;
+	private $searchService;
 	/**
 	 * @var IURLGenerator
 	 */
 	private $urlGenerator;
 
 	public function __construct(
-		BoardService $boardService,
-		StackMapper $stackMapper,
-		CardMapper $cardMapper,
+		SearchService $searchService,
 		IURLGenerator $urlGenerator
 	) {
-		$this->boardService = $boardService;
-		$this->stackMapper = $stackMapper;
-		$this->cardMapper = $cardMapper;
+		$this->searchService = $searchService;
 		$this->urlGenerator = $urlGenerator;
 	}
 
@@ -77,37 +63,34 @@ class DeckProvider implements IProvider {
 	}
 
 	public function search(IUser $user, ISearchQuery $query): SearchResult {
-		$boards = $this->boardService->getUserBoards();
-
-		$matchedBoards = array_filter($this->boardService->getUserBoards(), static function (Board $board) use ($query) {
-			return mb_stripos($board->getTitle(), $query->getTerm()) > -1;
-		});
-
-		$matchedCards = $this->cardMapper->search(array_map(static function (Board $board) {
-			return $board->getId();
-		}, $boards), $query->getTerm(), $query->getLimit(), $query->getCursor());
-
-		$self = $this;
+		$cursor = $query->getCursor() !== null ? (int)$query->getCursor() : null;
+		$boardResults = $this->searchService->searchBoards($query->getTerm(), $query->getLimit(), $cursor);
+		$cardResults = $this->searchService->searchCards($query->getTerm(), $query->getLimit(), $cursor);
 		$results = array_merge(
 			array_map(function (Board $board) {
 				return new BoardSearchResultEntry($board, $this->urlGenerator);
-			}, $matchedBoards),
-
-			array_map(function (Card $card) use ($self) {
-				$board = $self->boardService->find($self->cardMapper->findBoardId($card->getId()));
-				$stack = $self->stackMapper->find($card->getStackId());
-				return new CardSearchResultEntry($board, $stack, $card, $this->urlGenerator);
-			}, $matchedCards)
+			}, $boardResults),
+			array_map(function (Card $card) {
+				return new CardSearchResultEntry($card->getRelatedBoard(), $card->getRelatedStack(), $card, $this->urlGenerator);
+			}, $cardResults)
 		);
 
-		return SearchResult::complete(
+		if (count($cardResults) < $query->getLimit()) {
+			return SearchResult::complete(
+				'Deck',
+				$results,
+			);
+		}
+		
+		return SearchResult::paginated(
 			'Deck',
-			$results
+			$results,
+			$cardResults[count($results) - 1]->getLastModified()
 		);
 	}
 
 	public function getOrder(string $route, array $routeParameters): int {
-		if ($route === 'deck.page.index') {
+		if ($route === 'deck.Page.index') {
 			return -5;
 		}
 		return 10;

lib/Search/FilterStringParser.php

@@ -0,0 +1,107 @@
+<?php
+/*
+ * @copyright Copyright (c) 2021 Julius Härtl <jus@bitgrid.net>
+ *
+ * @author Julius Härtl <jus@bitgrid.net>
+ *
+ * @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/>.
+ *
+ */
+
+declare(strict_types=1);
+
+
+namespace OCA\Deck\Search;
+
+use OCA\Deck\Search\Query\DateQueryParameter;
+use OCA\Deck\Search\Query\SearchQuery;
+use OCA\Deck\Search\Query\StringQueryParameter;
+use OCP\IL10N;
+
+class FilterStringParser {
+
+	/**
+	 * @var IL10N
+	 */
+	private $l10n;
+
+	public function __construct(IL10N $l10n) {
+		$this->l10n = $l10n;
+	}
+	
+	public function parse(?string $filter): SearchQuery {
+		$query = new SearchQuery();
+		if (empty($filter)) {
+			return $query;
+		}
+		$tokens = preg_split('/\s(?=([^"]*"[^"]*")*[^"]*$)/', $filter);
+		foreach ($tokens as $token) {
+			if (!$this->parseFilterToken($query, $token)) {
+				$token = ($token[0] === '"' && $token[mb_strlen($token) - 1] === '"') ? mb_substr($token, 1, -1): $token;
+				$query->addTextToken($token);
+			}
+		}
+
+		return $query;
+	}
+
+	private function parseFilterToken(SearchQuery $query, string $token): bool {
+		if (strpos($token, ':') === false) {
+			return false;
+		}
+
+		[$type, $param] = explode(':', $token, 2);
+		$type = strtolower($type);
+
+		$qualifier = null;
+
+		switch ($type) {
+			case 'date':
+				$comparator = SearchQuery::COMPARATOR_EQUAL;
+				$value = $param;
+				if ($param[0] === '<' || $param[0] === '>') {
+					$orEquals = $param[1] === '=';
+					$value = $orEquals ? substr($param, 2) : substr($param, 1);
+					$comparator = (
+						($param[0] === '<' ? SearchQuery::COMPARATOR_LESS : 0) |
+						($param[0] === '>' ? SearchQuery::COMPARATOR_MORE : 0) |
+						($orEquals ? SearchQuery::COMPARATOR_EQUAL : 0)
+					);
+				}
+				$value = ($value[0] === '"' && $value[mb_strlen($value) - 1] === '"') ? mb_substr($value, 1, -1): $value;
+
+				$query->addDuedate(new DateQueryParameter('date',	$comparator, $value));
+				return true;
+			case 'title':
+				$query->addTitle(new StringQueryParameter('title', SearchQuery::COMPARATOR_EQUAL, $param));
+				return true;
+			case 'description':
+				$query->addDescription(new StringQueryParameter('description', SearchQuery::COMPARATOR_EQUAL, $param));
+				return true;
+			case 'list':
+				$query->addStack(new StringQueryParameter('list', SearchQuery::COMPARATOR_EQUAL, $param));
+				return true;
+			case 'tag':
+				$query->addTag(new StringQueryParameter('tag', SearchQuery::COMPARATOR_EQUAL, $param));
+				return true;
+			case 'assigned':
+				$query->addAssigned(new StringQueryParameter('assigned', SearchQuery::COMPARATOR_EQUAL, $param));
+				return true;
+		}
+
+		return false;
+	}
+}

lib/Search/Query/AQueryParameter.php

@@ -0,0 +1,49 @@
+<?php
+/*
+ * @copyright Copyright (c) 2021 Julius Härtl <jus@bitgrid.net>
+ *
+ * @author Julius Härtl <jus@bitgrid.net>
+ *
+ * @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/>.
+ *
+ */
+
+declare(strict_types=1);
+
+
+namespace OCA\Deck\Search\Query;
+
+class AQueryParameter {
+
+	/** @var string */
+	protected $field;
+	/** @var int */
+	protected $comparator;
+	/** @var mixed */
+	protected $value;
+	
+	public function getValue() {
+		if (is_string($this->value)) {
+			$param = ($this->value[0] === '"' && $this->value[mb_strlen($this->value) - 1] === '"') ? mb_substr($this->value, 1, -1): $this->value;
+			return $param;
+		}
+		return $this->value;
+	}
+	
+	public function getComparator(): int {
+		return $this->comparator;
+	}
+}

lib/Search/Query/DateQueryParameter.php

@@ -0,0 +1,38 @@
+<?php
+/*
+ * @copyright Copyright (c) 2021 Julius Härtl <jus@bitgrid.net>
+ *
+ * @author Julius Härtl <jus@bitgrid.net>
+ *
+ * @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/>.
+ *
+ */
+
+declare(strict_types=1);
+
+
+namespace OCA\Deck\Search\Query;
+
+class DateQueryParameter extends AQueryParameter {
+	/** @var string|null */
+	protected $value;
+
+	public function __construct(string $field, int $comparator, ?string $value) {
+		$this->field = $field;
+		$this->comparator = $comparator;
+		$this->value = $value;
+	}
+}

lib/Search/Query/SearchQuery.php

@@ -0,0 +1,109 @@
+<?php
+/*
+ * @copyright Copyright (c) 2021 Julius Härtl <jus@bitgrid.net>
+ *
+ * @author Julius Härtl <jus@bitgrid.net>
+ *
+ * @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/>.
+ *
+ */
+
+declare(strict_types=1);
+
+
+namespace OCA\Deck\Search\Query;
+
+class SearchQuery {
+	public const COMPARATOR_EQUAL = 1;
+	
+	public const COMPARATOR_LESS = 2;
+	public const COMPARATOR_MORE = 4;
+	
+	public const COMPARATOR_LESS_EQUAL = 3;
+	public const COMPARATOR_MORE_EQUAL = 5;
+
+	/** @var string[] */
+	private $textTokens = [];
+	/** @var StringQueryParameter[] */
+	private $title = [];
+	/** @var StringQueryParameter[] */
+	private $description = [];
+	/** @var StringQueryParameter[] */
+	private $stack = [];
+	/** @var StringQueryParameter[] */
+	private $tag = [];
+	/** @var StringQueryParameter[] */
+	private $assigned = [];
+	/** @var DateQueryParameter[] */
+	private $duedate = [];
+
+
+	public function addTextToken(string $textToken): void {
+		$this->textTokens[] = $textToken;
+	}
+
+	public function getTextTokens(): array {
+		return $this->textTokens;
+	}
+	
+	public function addTitle(StringQueryParameter $title): void {
+		$this->title[] = $title;
+	}
+	
+	public function getTitle(): array {
+		return $this->title;
+	}
+
+	public function addDescription(StringQueryParameter $description): void {
+		$this->description[] = $description;
+	}
+
+	public function getDescription(): array {
+		return $this->description;
+	}
+
+	public function addStack(StringQueryParameter $stack): void {
+		$this->stack[] = $stack;
+	}
+
+	public function getStack(): array {
+		return $this->stack;
+	}
+
+	public function addTag(StringQueryParameter $tag): void {
+		$this->tag[] = $tag;
+	}
+
+	public function getTag(): array {
+		return $this->tag;
+	}
+
+	public function addAssigned(StringQueryParameter $assigned): void {
+		$this->assigned[] = $assigned;
+	}
+
+	public function getAssigned(): array {
+		return $this->assigned;
+	}
+
+	public function addDuedate(DateQueryParameter $date): void {
+		$this->duedate[] = $date;
+	}
+
+	public function getDuedate(): array {
+		return $this->duedate;
+	}
+}

lib/Search/Query/StringQueryParameter.php

@@ -0,0 +1,39 @@
+<?php
+/*
+ * @copyright Copyright (c) 2021 Julius Härtl <jus@bitgrid.net>
+ *
+ * @author Julius Härtl <jus@bitgrid.net>
+ *
+ * @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/>.
+ *
+ */
+
+declare(strict_types=1);
+
+
+namespace OCA\Deck\Search\Query;
+
+class StringQueryParameter extends AQueryParameter {
+	
+	/** @var string */
+	protected $value;
+	
+	public function __construct(string $field, int $comparator, string $value) {
+		$this->field = $field;
+		$this->comparator = $comparator;
+		$this->value = $value;
+	}
+}