Implement advanced search queries

Signed-off-by: Julius Härtl <jus@bitgrid.net>
2021-04-01 11:45:11 +02:00
parent 88a5e420b9
commit 840c143b92
23 changed files with 942 additions and 99 deletions
--- a/lib/Search/FilterStringParser.php
+++ b/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;
+	}
+}