From d5022f883e86f1d7e9e2fd62a1f5786d44ebc2e1 Mon Sep 17 00:00:00 2001 From: eikek Date: Sat, 21 Aug 2021 15:08:46 +0200 Subject: [PATCH] Enhance search mode to search in all items --- .../src/main/scala/docspell/backend/ops/OSimpleSearch.scala | 2 ++ .../common/src/main/scala/docspell/common/ItemState.scala | 3 +++ .../common/src/main/scala/docspell/common/SearchMode.scala | 2 ++ .../shared/src/main/scala/docspell/query/ItemQuery.scala | 5 +++-- .../src/main/scala/docspell/query/internal/ExprUtil.scala | 2 ++ modules/restapi/src/main/resources/docspell-openapi.yml | 5 ++++- .../docspell/store/qb/generator/ItemQueryGenerator.scala | 3 +++ 7 files changed, 19 insertions(+), 3 deletions(-) diff --git a/modules/backend/src/main/scala/docspell/backend/ops/OSimpleSearch.scala b/modules/backend/src/main/scala/docspell/backend/ops/OSimpleSearch.scala index 63c13a7a..17b57c17 100644 --- a/modules/backend/src/main/scala/docspell/backend/ops/OSimpleSearch.scala +++ b/modules/backend/src/main/scala/docspell/backend/ops/OSimpleSearch.scala @@ -220,6 +220,7 @@ object OSimpleSearch { settings.searchMode match { case SearchMode.Trashed => q.withFix(_.andQuery(ItemQuery.Expr.Trashed)) case SearchMode.Normal => q.withFix(_.andQuery(ItemQuery.Expr.ValidItemStates)) + case SearchMode.All => q.withFix(_.andQuery(ItemQuery.Expr.ValidItemsOrTrashed)) } fulltextQuery match { case Some(ftq) if settings.useFTS => @@ -282,6 +283,7 @@ object OSimpleSearch { settings.searchMode match { case SearchMode.Trashed => q.withFix(_.andQuery(ItemQuery.Expr.Trashed)) case SearchMode.Normal => q.withFix(_.andQuery(ItemQuery.Expr.ValidItemStates)) + case SearchMode.All => q.withFix(_.andQuery(ItemQuery.Expr.ValidItemsOrTrashed)) } fulltextQuery match { case Some(ftq) if settings.useFTS => diff --git a/modules/common/src/main/scala/docspell/common/ItemState.scala b/modules/common/src/main/scala/docspell/common/ItemState.scala index e59d5049..d6648063 100644 --- a/modules/common/src/main/scala/docspell/common/ItemState.scala +++ b/modules/common/src/main/scala/docspell/common/ItemState.scala @@ -52,6 +52,9 @@ object ItemState { val invalidStates: NonEmptyList[ItemState] = NonEmptyList.of(Premature, Processing) + val validStatesAndDeleted: NonEmptyList[ItemState] = + validStates.append(deleted) + def unsafe(str: String): ItemState = fromString(str).fold(sys.error, identity) diff --git a/modules/common/src/main/scala/docspell/common/SearchMode.scala b/modules/common/src/main/scala/docspell/common/SearchMode.scala index 451f5de9..3a89a820 100644 --- a/modules/common/src/main/scala/docspell/common/SearchMode.scala +++ b/modules/common/src/main/scala/docspell/common/SearchMode.scala @@ -22,11 +22,13 @@ object SearchMode { final case object Normal extends SearchMode final case object Trashed extends SearchMode + final case object All extends SearchMode def fromString(str: String): Either[String, SearchMode] = str.toLowerCase match { case "normal" => Right(Normal) case "trashed" => Right(Trashed) + case "all" => Right(All) case _ => Left(s"Invalid search mode: $str") } diff --git a/modules/query/shared/src/main/scala/docspell/query/ItemQuery.scala b/modules/query/shared/src/main/scala/docspell/query/ItemQuery.scala index 974f9d6e..22c5605c 100644 --- a/modules/query/shared/src/main/scala/docspell/query/ItemQuery.scala +++ b/modules/query/shared/src/main/scala/docspell/query/ItemQuery.scala @@ -123,8 +123,9 @@ object ItemQuery { final case class ChecksumMatch(checksum: String) extends Expr final case class AttachId(id: String) extends Expr - final case object ValidItemStates extends Expr - final case object Trashed extends Expr + final case object ValidItemStates extends Expr + final case object Trashed extends Expr + final case object ValidItemsOrTrashed extends Expr // things that can be expressed with terms above sealed trait MacroExpr extends Expr { diff --git a/modules/query/shared/src/main/scala/docspell/query/internal/ExprUtil.scala b/modules/query/shared/src/main/scala/docspell/query/internal/ExprUtil.scala index 6a6755a0..0cc89aca 100644 --- a/modules/query/shared/src/main/scala/docspell/query/internal/ExprUtil.scala +++ b/modules/query/shared/src/main/scala/docspell/query/internal/ExprUtil.scala @@ -79,6 +79,8 @@ object ExprUtil { expr case Trashed => expr + case ValidItemsOrTrashed => + expr } private def spliceAnd(nodes: Nel[Expr]): Nel[Expr] = diff --git a/modules/restapi/src/main/resources/docspell-openapi.yml b/modules/restapi/src/main/resources/docspell-openapi.yml index c686f217..fd5031a7 100644 --- a/modules/restapi/src/main/resources/docspell-openapi.yml +++ b/modules/restapi/src/main/resources/docspell-openapi.yml @@ -4228,6 +4228,7 @@ components: enum: - normal - trashed + - all default: normal description: | Specify whether the search query should apply to @@ -5978,10 +5979,12 @@ components: searchMode: name: searchMode in: query - description: Whether to search in soft-deleted items only. schema: type: string format: searchmode + description: | + Specify whether the search query should apply to soft-deleted + items or not. name: name: name in: path diff --git a/modules/store/src/main/scala/docspell/store/qb/generator/ItemQueryGenerator.scala b/modules/store/src/main/scala/docspell/store/qb/generator/ItemQueryGenerator.scala index 10bf7dec..c4292df4 100644 --- a/modules/store/src/main/scala/docspell/store/qb/generator/ItemQueryGenerator.scala +++ b/modules/store/src/main/scala/docspell/store/qb/generator/ItemQueryGenerator.scala @@ -129,6 +129,9 @@ object ItemQueryGenerator { case Expr.Trashed => tables.item.state === ItemState.Deleted + case Expr.ValidItemsOrTrashed => + tables.item.state.in(ItemState.validStatesAndDeleted) + case Expr.TagIdsMatch(op, tags) => val ids = tags.toList.flatMap(s => Ident.fromString(s).toOption) Nel