From 9a35891a73d30964d0d8ccb62327c70a27f19416 Mon Sep 17 00:00:00 2001
From: Loay Ghreeb <loayahmed655@gmail.com>
Date: Fri, 4 Oct 2024 20:47:01 +0300
Subject: [PATCH] Ignores groups field from default searches

Fixes https://github.com/JabRef/jabref/issues/7996
---
 .../search/query/SearchToSqlVisitor.java      | 160 ++++++++++--------
 1 file changed, 90 insertions(+), 70 deletions(-)

diff --git a/src/main/java/org/jabref/logic/search/query/SearchToSqlVisitor.java b/src/main/java/org/jabref/logic/search/query/SearchToSqlVisitor.java
index 5f54170ee94..63592d2361f 100644
--- a/src/main/java/org/jabref/logic/search/query/SearchToSqlVisitor.java
+++ b/src/main/java/org/jabref/logic/search/query/SearchToSqlVisitor.java
@@ -29,6 +29,7 @@
 
 /**
  * Converts to a query processable by the scheme created by {@link BibFieldsIndexer}.
+ * Tests are located in {@link org.jabref.logic.search.query.SearchQuerySQLConversionTest}.
  */
 public class SearchToSqlVisitor extends SearchBaseVisitor<String> {
 
@@ -36,6 +37,7 @@ public class SearchToSqlVisitor extends SearchBaseVisitor<String> {
     private static final String MAIN_TABLE = "main_table";
     private static final String SPLIT_TABLE = "split_table";
     private static final String INNER_TABLE = "inner_table";
+    private static final String GROUPS_FIELD = StandardField.GROUPS.getName();
 
     private final String mainTableName;
     private final String splitValuesTableName;
@@ -70,12 +72,12 @@ public String visitUnaryExpression(SearchParser.UnaryExpressionContext ctx) {
         String subQuery = visit(ctx.expression());
         String cte = """
                 cte%d AS (
-                 SELECT %s.%s
-                 FROM %s AS %s
-                 WHERE %s.%s NOT IN (
-                    SELECT %s
-                    FROM %s
-                 )
+                    SELECT %s.%s
+                    FROM %s AS %s
+                    WHERE %s.%s NOT IN (
+                       SELECT %s
+                       FROM %s
+                    )
                 )
                 """.formatted(
                 cteCounter,
@@ -96,11 +98,11 @@ public String visitBinaryExpression(SearchParser.BinaryExpressionContext ctx) {
 
         String cte = """
                 cte%d AS (
-                 SELECT %s
-                 FROM %s
-                 %s
-                 SELECT %s
-                 FROM %s
+                    SELECT %s
+                    FROM %s
+                    %s
+                    SELECT %s
+                    FROM %s
                 )
                 """.formatted(
                 cteCounter,
@@ -196,9 +198,9 @@ private String getFieldQueryNode(String field, String term, EnumSet<SearchTermFl
         if (ENTRY_ID.toString().equals(field)) {
             cte = """
                     cte%d AS (
-                     SELECT %s
-                     FROM %s
-                     WHERE %s = '%s'
+                        SELECT %s
+                        FROM %s
+                        WHERE %s = '%s'
                     )
                     """.formatted(
                     cteCounter,
@@ -232,9 +234,11 @@ private String getFieldQueryNode(String field, String term, EnumSet<SearchTermFl
     private String buildContainsFieldQuery(String field, String operator, String prefixSuffix, String term) {
         return """
                 cte%d AS (
-                 SELECT %s.%s
-                 FROM %s AS %s
-                 WHERE (%s.%s = '%s') AND ((%s.%s %s '%s%s%s') OR (%s.%s %s '%s%s%s'))
+                    SELECT %s.%s
+                    FROM %s AS %s
+                    WHERE (
+                        (%s.%s = '%s') AND ((%s.%s %s '%s%s%s') OR (%s.%s %s '%s%s%s'))
+                    )
                 )
                 """.formatted(
                 cteCounter,
@@ -253,12 +257,14 @@ private String buildContainsFieldQuery(String field, String operator, String pre
     private String buildContainsNegationFieldQuery(String field, String operator, String prefixSuffix, String term) {
         return """
                 cte%d AS (
-                 SELECT %s.%s
-                 FROM %s AS %s
-                 WHERE %s.%s NOT IN (
                     SELECT %s.%s
                     FROM %s AS %s
-                    WHERE (%s.%s = '%s') AND ((%s.%s %s '%s%s%s') OR (%s.%s %s '%s%s%s'))
+                    WHERE %s.%s NOT IN (
+                        SELECT %s.%s
+                        FROM %s AS %s
+                        WHERE (
+                            (%s.%s = '%s') AND ((%s.%s %s '%s%s%s') OR (%s.%s %s '%s%s%s'))
+                        )
                     )
                 )
                 """.formatted(
@@ -281,15 +287,15 @@ private String buildContainsNegationFieldQuery(String field, String operator, St
     private String buildExactFieldQuery(String field, String operator, String term) {
         return """
                 cte%d AS (
-                 SELECT %s.%s
-                 FROM %s AS %s
-                 LEFT JOIN %s AS %s
-                 ON (%s.%s = %s.%s AND %s.%s = %s.%s)
-                 WHERE (
-                    (%s.%s = '%s') AND ((%s.%s %s '%s') OR (%s.%s %s '%s'))
-                    OR
-                    (%s.%s = '%s') AND ((%s.%s %s '%s') OR (%s.%s %s '%s'))
-                 )
+                    SELECT %s.%s
+                    FROM %s AS %s
+                    LEFT JOIN %s AS %s
+                    ON (%s.%s = %s.%s AND %s.%s = %s.%s)
+                    WHERE (
+                        ((%s.%s = '%s') AND ((%s.%s %s '%s') OR (%s.%s %s '%s')))
+                        OR
+                        ((%s.%s = '%s') AND ((%s.%s %s '%s') OR (%s.%s %s '%s')))
+                    )
                 )
                 """.formatted(
                 cteCounter,
@@ -309,19 +315,19 @@ private String buildExactFieldQuery(String field, String operator, String term)
     private String buildExactNegationFieldQuery(String field, String operator, String term) {
         return """
                 cte%d AS (
-                 SELECT %s.%s
-                 FROM %s AS %s
-                 WHERE %s.%s NOT IN (
                     SELECT %s.%s
                     FROM %s AS %s
-                    LEFT JOIN %s AS %s
-                    ON (%s.%s = %s.%s AND %s.%s = %s.%s)
-                    WHERE (
-                      (%s.%s = '%s') AND ((%s.%s %s '%s') OR (%s.%s %s '%s'))
-                      OR
-                      (%s.%s = '%s') AND ((%s.%s %s '%s') OR (%s.%s %s '%s'))
+                    WHERE %s.%s NOT IN (
+                        SELECT %s.%s
+                        FROM %s AS %s
+                        LEFT JOIN %s AS %s
+                        ON (%s.%s = %s.%s AND %s.%s = %s.%s)
+                        WHERE (
+                            ((%s.%s = '%s') AND ((%s.%s %s '%s') OR (%s.%s %s '%s')))
+                            OR
+                            ((%s.%s = '%s') AND ((%s.%s %s '%s') OR (%s.%s %s '%s')))
+                        )
                     )
-                 )
                 )
                 """.formatted(
                 cteCounter,
@@ -344,14 +350,17 @@ private String buildExactNegationFieldQuery(String field, String operator, Strin
     private String buildContainsAnyFieldQuery(String operator, String prefixSuffix, String term) {
         return """
                 cte%d AS (
-                 SELECT %s.%s
-                 FROM %s AS %s
-                 WHERE ((%s.%s %s '%s%s%s') OR (%s.%s %s '%s%s%s'))
+                    SELECT %s.%s
+                    FROM %s AS %s
+                    WHERE (
+                        (%s.%s != '%s') AND ((%s.%s %s '%s%s%s') OR (%s.%s %s '%s%s%s'))
+                    )
                 )
                 """.formatted(
                 cteCounter,
                 MAIN_TABLE, ENTRY_ID,
                 mainTableName, MAIN_TABLE,
+                MAIN_TABLE, FIELD_NAME, GROUPS_FIELD, // https://github.com/JabRef/jabref/issues/7996
                 MAIN_TABLE, FIELD_VALUE_LITERAL,
                 operator,
                 prefixSuffix, term, prefixSuffix,
@@ -363,15 +372,18 @@ private String buildContainsAnyFieldQuery(String operator, String prefixSuffix,
     private String buildExactAnyFieldQuery(String operator, String term) {
         return """
                 cte%d AS (
-                  SELECT %s.%s
-                  FROM %s AS %s
-                  LEFT JOIN %s AS %s
-                  ON (%s.%s = %s.%s AND %s.%s = %s.%s)
-                  WHERE (
-                    (%s.%s %s '%s') OR (%s.%s %s '%s')
-                    OR
-                    (%s.%s %s '%s') OR (%s.%s %s '%s')
-                  )
+                    SELECT %s.%s
+                    FROM %s AS %s
+                    LEFT JOIN %s AS %s
+                    ON (%s.%s = %s.%s AND %s.%s = %s.%s)
+                    WHERE (
+                        (%s.%s != '%s')
+                        AND (
+                            ((%s.%s %s '%s') OR (%s.%s %s '%s'))
+                            OR
+                            ((%s.%s %s '%s') OR (%s.%s %s '%s'))
+                        )
+                    )
                 )
                 """.formatted(
                 cteCounter,
@@ -380,6 +392,7 @@ private String buildExactAnyFieldQuery(String operator, String term) {
                 splitValuesTableName, SPLIT_TABLE,
                 MAIN_TABLE, ENTRY_ID, SPLIT_TABLE, ENTRY_ID,
                 MAIN_TABLE, FIELD_NAME, SPLIT_TABLE, FIELD_NAME,
+                MAIN_TABLE, FIELD_NAME, GROUPS_FIELD, // https://github.com/JabRef/jabref/issues/7996
                 MAIN_TABLE, FIELD_VALUE_LITERAL, operator, term,
                 MAIN_TABLE, FIELD_VALUE_TRANSFORMED, operator, term,
                 SPLIT_TABLE, FIELD_VALUE_LITERAL, operator, term,
@@ -389,19 +402,22 @@ private String buildExactAnyFieldQuery(String operator, String term) {
     private String buildExactNegationAnyFieldQuery(String operator, String term) {
         return """
                 cte%d AS (
-                 SELECT %s.%s
-                 FROM %s AS %s
-                 WHERE %s.%s NOT IN (
                     SELECT %s.%s
                     FROM %s AS %s
-                    LEFT JOIN %s AS %s
-                    ON (%s.%s = %s.%s AND %s.%s = %s.%s)
-                    WHERE (
-                      (%s.%s %s '%s') OR (%s.%s %s '%s')
-                      OR
-                      (%s.%s %s '%s') OR (%s.%s %s '%s')
+                    WHERE %s.%s NOT IN (
+                        SELECT %s.%s
+                        FROM %s AS %s
+                        LEFT JOIN %s AS %s
+                        ON (%s.%s = %s.%s AND %s.%s = %s.%s)
+                        WHERE (
+                            (%s.%s != '%s')
+                            AND (
+                                ((%s.%s %s '%s') OR (%s.%s %s '%s'))
+                                OR
+                                ((%s.%s %s '%s') OR (%s.%s %s '%s'))
+                            )
+                        )
                     )
-                 )
                 )
                 """.formatted(
                 cteCounter,
@@ -411,10 +427,11 @@ private String buildExactNegationAnyFieldQuery(String operator, String term) {
                 INNER_TABLE, ENTRY_ID,
                 mainTableName, INNER_TABLE,
                 splitValuesTableName, SPLIT_TABLE,
-                MAIN_TABLE, FIELD_NAME, SPLIT_TABLE, FIELD_NAME,
-                MAIN_TABLE, ENTRY_ID, SPLIT_TABLE, ENTRY_ID,
-                MAIN_TABLE, FIELD_VALUE_LITERAL, operator, term,
-                MAIN_TABLE, FIELD_VALUE_TRANSFORMED, operator, term,
+                INNER_TABLE, FIELD_NAME, SPLIT_TABLE, FIELD_NAME,
+                INNER_TABLE, ENTRY_ID, SPLIT_TABLE, ENTRY_ID,
+                INNER_TABLE, FIELD_NAME, GROUPS_FIELD, // https://github.com/JabRef/jabref/issues/7996
+                INNER_TABLE, FIELD_VALUE_LITERAL, operator, term,
+                INNER_TABLE, FIELD_VALUE_TRANSFORMED, operator, term,
                 SPLIT_TABLE, FIELD_VALUE_LITERAL, operator, term,
                 SPLIT_TABLE, FIELD_VALUE_TRANSFORMED, operator, term);
     }
@@ -422,12 +439,14 @@ private String buildExactNegationAnyFieldQuery(String operator, String term) {
     private String buildContainsNegationAnyFieldQuery(String operator, String prefixSuffix, String term) {
         return """
                 cte%d AS (
-                 SELECT %s.%s
-                 FROM %s AS %s
-                 WHERE %s.%s NOT IN (
                     SELECT %s.%s
                     FROM %s AS %s
-                    WHERE ((%s.%s %s '%s%s%s') OR (%s.%s %s '%s%s%s'))
+                    WHERE %s.%s NOT IN (
+                        SELECT %s.%s
+                        FROM %s AS %s
+                        WHERE (
+                            (%s.%s != '%s') AND ((%s.%s %s '%s%s%s') OR (%s.%s %s '%s%s%s'))
+                        )
                     )
                 )
                 """.formatted(
@@ -437,6 +456,7 @@ private String buildContainsNegationAnyFieldQuery(String operator, String prefix
                 MAIN_TABLE, ENTRY_ID,
                 INNER_TABLE, ENTRY_ID,
                 mainTableName, INNER_TABLE,
+                INNER_TABLE, FIELD_NAME, GROUPS_FIELD, // https://github.com/JabRef/jabref/issues/7996
                 INNER_TABLE, FIELD_VALUE_LITERAL,
                 operator,
                 prefixSuffix, term, prefixSuffix,