feat: add search engine support used by lucene. (#324)

* feat: add search engine support used by lucene.

* update: search engine used by lucene

* test: disable unit test SubjectRelationServiceTest, api may change in the future.

* build: gen new api-client@0.0.21 and publish to npm center repo in @runikaros/api-client

* update: finish global search vue component in console.

* build: adjust git ignore config

* fix: console build.

* docs: move rfcs to single repo.

* build: move app to single repo

* docs: update github issue template.

* build: gen new api-client@0.0.22 and publish to npm center repo in @runikaros/api-client

* feat: add file search in global search vue component.

* docs: update changelog for pr #324.

* feat: add build console task before build server, and fix checkstyle run fail.

* fix: unit test cases run fail, and update github workflows build fail package save time.

* build: appoint version for package @runikaros.

* fix: github ci

* fix: SubjectServiceTest

Author: chivehao

.github/ISSUE_TEMPLATE/bug-report.en.yml

@@ -30,9 +30,7 @@ body:
       options:
         - "server"
         - "console"
-        - "app"
         - "plugin"
-        - "rfc"
     validations:
       required: true
 

.github/ISSUE_TEMPLATE/bug-report.zh.yml

@@ -29,9 +29,7 @@ body:
       options:
         - "服务端 (server)"
         - "控制台 (console)"
-        - "客户端 (app)"
         - "插件 (plugin)"
-        - "RFC (rfcs)"
     validations:
       required: true
 

.github/workflows/ikaros-server-ci.yml

@@ -44,11 +44,11 @@ jobs:
           # Artifact name
           name: checkBuild
           # A file, directory or wildcard pattern that describes what to upload
-          path: /home/runner/work/ikaros/ikaros/server/build/reports
+          path: /home/runner/work/ikaros/ikaros/server/build
           # The desired behavior if no files are found using the provided path.
           if-no-files-found: warn
           # Duration after which artifact will expire in days. 0 means using default retention.Minimum 1 day. Maximum 90 days unless changed from the repository settings page.
-          retention-days: 3
+          retention-days: 7
   test:
     runs-on: ubuntu-latest
     steps:
@@ -79,9 +79,9 @@ jobs:
           # Artifact name
           name: testBuild
           # A file, directory or wildcard pattern that describes what to upload
-          path: /home/runner/work/ikaros/ikaros/server/build/reports
+          path: /home/runner/work/ikaros/ikaros/server/build
           # The desired behavior if no files are found using the provided path.
           if-no-files-found: warn
           # Duration after which artifact will expire in days. 0 means using default retention.Minimum 1 day. Maximum 90 days unless changed from the repository settings page.
-          retention-days: 3
+          retention-days: 7
 

CHANGELOG.MD

@@ -33,6 +33,7 @@
 - 插件的安装卸载
 - 文件的管理如展示上传移除查询等
 - 条目剧集的展示和修改
+- 后台全局查询条目和文件支持
 
 ## 依赖
 

api/build.gradle

@@ -40,6 +40,13 @@ dependencies {
     api "org.springframework.integration:spring-integration-core"
     api "org.thymeleaf.extras:thymeleaf-extras-springsecurity6"
 
+    // Apache Lucene
+    api "org.apache.lucene:lucene-core"
+    api "org.apache.lucene:lucene-queryparser"
+    api "org.apache.lucene:lucene-highlighter"
+    api "org.apache.lucene:lucene-backward-codecs"
+    api 'cn.shenyanchao.ik-analyzer:ik-analyzer'
+
     runtimeOnly 'io.r2dbc:r2dbc-h2'
     runtimeOnly 'org.postgresql:postgresql'
     runtimeOnly 'org.postgresql:r2dbc-postgresql'

api/src/main/java/run/ikaros/api/constant/StringConst.java

@@ -0,0 +1,5 @@
+package run.ikaros.api.constant;
+
+public interface StringConst {
+    String SPACE = " ";
+}

api/src/main/java/run/ikaros/api/search/IndicesSearchService.java

@@ -0,0 +1,9 @@
+package run.ikaros.api.search;
+
+import java.util.Set;
+import org.pf4j.ExtensionPoint;
+
+public interface IndicesSearchService extends ExtensionPoint {
+
+    void removeDocuments(Set<String> termTexts) throws Exception;
+}

api/src/main/java/run/ikaros/api/search/SearchParam.java

@@ -0,0 +1,70 @@
+package run.ikaros.api.search;
+
+import static io.swagger.v3.oas.annotations.media.Schema.RequiredMode.REQUIRED;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import org.springframework.util.MultiValueMap;
+import org.springframework.util.StringUtils;
+import org.springframework.web.server.ServerWebInputException;
+
+public class SearchParam {
+
+    private static final int DEFAULT_LIMIT = 10;
+    private static final String DEFAULT_HIGHLIGHT_PRE_TAG = "<B>";
+    private static final String DEFAULT_HIGHLIGHT_POST_TAG = "</B>";
+
+    private final MultiValueMap<String, String> query;
+
+    public SearchParam(MultiValueMap<String, String> query) {
+        this.query = query;
+    }
+
+    /**
+     * Get keyword.
+     *
+     * @return keyword
+     */
+    @Schema(name = "keyword", requiredMode = REQUIRED)
+    public String getKeyword() {
+        var keyword = query.getFirst("keyword");
+        if (!StringUtils.hasText(keyword)) {
+            throw new ServerWebInputException("keyword is required");
+        }
+        return keyword;
+    }
+
+    @Schema(name = "limit", defaultValue = "100", maximum = "1000")
+    public int getLimit() {
+        var limitString = query.getFirst("limit");
+        int limit = 0;
+        if (StringUtils.hasText(limitString)) {
+            try {
+                limit = Integer.parseInt(limitString);
+            } catch (NumberFormatException nfe) {
+                throw new ServerWebInputException("Failed to get ");
+            }
+        }
+        if (limit <= 0) {
+            limit = DEFAULT_LIMIT;
+        }
+        return limit;
+    }
+
+    @Schema(name = "highlightPreTag", defaultValue = DEFAULT_HIGHLIGHT_PRE_TAG)
+    public String getHighlightPreTag() {
+        var highlightPreTag = query.getFirst("highlightPreTag");
+        if (!StringUtils.hasText(highlightPreTag)) {
+            highlightPreTag = DEFAULT_HIGHLIGHT_PRE_TAG;
+        }
+        return highlightPreTag;
+    }
+
+    @Schema(name = "highlightPostTag", defaultValue = DEFAULT_HIGHLIGHT_POST_TAG)
+    public String getHighlightPostTag() {
+        var highlightPostTag = query.getFirst("highlightPostTag");
+        if (!StringUtils.hasText(highlightPostTag)) {
+            highlightPostTag = DEFAULT_HIGHLIGHT_POST_TAG;
+        }
+        return highlightPostTag;
+    }
+}

api/src/main/java/run/ikaros/api/search/SearchResult.java

@@ -0,0 +1,13 @@
+package run.ikaros.api.search;
+
+import java.util.List;
+import lombok.Data;
+
+@Data
+public class SearchResult<T> {
+    private List<T> hits;
+    private String keyword;
+    private Long total;
+    private int limit;
+    private long processingTimeMillis;
+}

api/src/main/java/run/ikaros/api/search/file/FileDoc.java

@@ -0,0 +1,16 @@
+package run.ikaros.api.search.file;
+
+import lombok.Data;
+import run.ikaros.api.store.enums.FilePlace;
+import run.ikaros.api.store.enums.FileType;
+
+@Data
+public class FileDoc {
+    private Long id;
+    private String name;
+    private String originalPath;
+    private String url;
+    private FileType type;
+    private FilePlace place;
+    private String originalName;
+}