Migrate fetchers to Search.g4 ANTLR parser.

jablib/src/main/java/org/jabref/logic/importer/PagedSearchBasedFetcher.java

@@ -3,22 +3,20 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import org.jabref.logic.search.query.SearchQueryExtractorVisitor;
 import org.jabref.model.entry.BibEntry;
 import org.jabref.model.paging.Page;
-
-import org.apache.lucene.queryparser.flexible.core.QueryNodeParseException;
-import org.apache.lucene.queryparser.flexible.core.nodes.QueryNode;
-import org.apache.lucene.queryparser.flexible.core.parser.SyntaxParser;
-import org.apache.lucene.queryparser.flexible.standard.parser.StandardSyntaxParser;
+import org.jabref.model.search.query.SearchQuery;
+import org.jabref.model.search.query.SearchQueryNode;
 
 public interface PagedSearchBasedFetcher extends SearchBasedFetcher {
 
     /**
-     * @param luceneQuery the root node of the lucene query
+     * @param queryList the list that contains the parsed nodes
      * @param pageNumber       requested site number indexed from 0
      * @return Page with search results
      */
-    Page<BibEntry> performSearchPaged(QueryNode luceneQuery, int pageNumber) throws FetcherException;
+    Page<BibEntry> performSearchPaged(List<SearchQueryNode> queryList, int pageNumber) throws FetcherException;
 
     /**
      * @param searchQuery query string that can be parsed into a lucene query
@@ -29,11 +27,11 @@ default Page<BibEntry> performSearchPaged(String searchQuery, int pageNumber) th
         if (searchQuery.isBlank()) {
             return new Page<>(searchQuery, pageNumber, List.of());
         }
-        SyntaxParser parser = new StandardSyntaxParser();
-        final String NO_EXPLICIT_FIELD = "default";
+        SearchQuery searchQueryObject = new SearchQuery(searchQuery);
+        SearchQueryExtractorVisitor visitor = new SearchQueryExtractorVisitor(searchQueryObject.getSearchFlags());
         try {
-            return this.performSearchPaged(parser.parse(searchQuery, NO_EXPLICIT_FIELD), pageNumber);
-        } catch (QueryNodeParseException e) {
+            return this.performSearchPaged(visitor.visitStart(searchQueryObject.getContext()), pageNumber);
+        } catch (Exception e) {
             throw new FetcherException("An error occurred during parsing of the query.");
         }
     }
@@ -48,11 +46,11 @@ default int getPageSize() {
     /**
      * This method is used to send complex queries using fielded search.
      *
-     * @param luceneQuery the root node of the lucene query
+     * @param queryList the list that contains the parsed nodes
      * @return a list of {@link BibEntry}, which are matched by the query (may be empty)
      */
     @Override
-    default List<BibEntry> performSearch(QueryNode luceneQuery) throws FetcherException {
-        return new ArrayList<>(performSearchPaged(luceneQuery, 0).getContent());
+    default List<BibEntry> performSearch(List<SearchQueryNode> queryList) throws FetcherException {
+        return new ArrayList<>(performSearchPaged(queryList, 0).getContent());
     }
 }

jablib/src/main/java/org/jabref/logic/importer/PagedSearchBasedParserFetcher.java

@@ -9,21 +9,20 @@
 
 import org.jabref.model.entry.BibEntry;
 import org.jabref.model.paging.Page;
-
-import org.apache.lucene.queryparser.flexible.core.nodes.QueryNode;
+import org.jabref.model.search.query.SearchQueryNode;
 
 public interface PagedSearchBasedParserFetcher extends SearchBasedParserFetcher, PagedSearchBasedFetcher, ParserFetcher {
 
     @Override
-    default Page<BibEntry> performSearchPaged(QueryNode luceneQuery, int pageNumber) throws FetcherException {
+    default Page<BibEntry> performSearchPaged(List<SearchQueryNode> queryList, int pageNumber) throws FetcherException {
         // ADR-0014
         URL urlForQuery;
         try {
-            urlForQuery = getURLForQuery(luceneQuery, pageNumber);
+            urlForQuery = getURLForQuery(queryList, pageNumber);
         } catch (URISyntaxException | MalformedURLException e) {
             throw new FetcherException("Search URI crafted from complex search query is malformed", e);
         }
-        return new Page<>(luceneQuery.toString(), pageNumber, getBibEntries(urlForQuery));
+        return new Page<>(queryList.toString(), pageNumber, getBibEntries(urlForQuery));
     }
 
     private List<BibEntry> getBibEntries(URL urlForQuery) throws FetcherException {
@@ -41,18 +40,18 @@ private List<BibEntry> getBibEntries(URL urlForQuery) throws FetcherException {
     /**
      * Constructs a URL based on the query, size and page number.
      *
-     * @param luceneQuery the search query
+     * @param queryList the list that contains the parsed nodes
      * @param pageNumber  the number of the page indexed from 0
      */
-    URL getURLForQuery(QueryNode luceneQuery, int pageNumber) throws URISyntaxException, MalformedURLException;
+    URL getURLForQuery(List<SearchQueryNode> queryList, int pageNumber) throws URISyntaxException, MalformedURLException;
 
     @Override
-    default URL getURLForQuery(QueryNode luceneQuery) throws URISyntaxException, MalformedURLException {
-        return getURLForQuery(luceneQuery, 0);
+    default URL getURLForQuery(List<SearchQueryNode> queryList) throws URISyntaxException, MalformedURLException {
+        return getURLForQuery(queryList, 0);
     }
 
     @Override
-    default List<BibEntry> performSearch(QueryNode luceneQuery) throws FetcherException {
-        return SearchBasedParserFetcher.super.performSearch(luceneQuery);
+    default List<BibEntry> performSearch(List<SearchQueryNode> queryList) throws FetcherException {
+        return SearchBasedParserFetcher.super.performSearch(queryList);
     }
 }

jablib/src/main/java/org/jabref/logic/importer/SearchBasedFetcher.java

@@ -2,14 +2,10 @@
 
 import java.util.List;
 
+import org.jabref.logic.search.query.SearchQueryExtractorVisitor;
 import org.jabref.model.entry.BibEntry;
-
-import org.apache.lucene.queryparser.flexible.core.QueryNodeParseException;
-import org.apache.lucene.queryparser.flexible.core.nodes.QueryNode;
-import org.apache.lucene.queryparser.flexible.core.parser.SyntaxParser;
-import org.apache.lucene.queryparser.flexible.standard.parser.StandardSyntaxParser;
-
-import static org.jabref.logic.importer.fetcher.transformers.AbstractQueryTransformer.NO_EXPLICIT_FIELD;
+import org.jabref.model.search.query.SearchQuery;
+import org.jabref.model.search.query.SearchQueryNode;
 
 /**
  * Searches web resources for bibliographic information based on a free-text query.
@@ -23,30 +19,31 @@ public interface SearchBasedFetcher extends WebFetcher {
     /**
      * This method is used to send complex queries using fielded search.
      *
-     * @param luceneQuery the root node of the lucene query
+     * @param queryList the list that contains the parsed nodes
      * @return a list of {@link BibEntry}, which are matched by the query (may be empty)
      */
-    List<BibEntry> performSearch(QueryNode luceneQuery) throws FetcherException;
+    List<BibEntry> performSearch(List<SearchQueryNode> queryList) throws FetcherException;
 
     /**
      * Looks for hits which are matched by the given free-text query.
      *
-     * @param searchQuery query string that can be parsed into a lucene query
+     * @param searchQuery query string that can be parsed into a search.g4 query
      * @return a list of {@link BibEntry}, which are matched by the query (may be empty)
      */
     default List<BibEntry> performSearch(String searchQuery) throws FetcherException {
         if (searchQuery.isBlank()) {
             return List.of();
         }
 
-        SyntaxParser parser = new StandardSyntaxParser();
-        QueryNode queryNode;
+        SearchQuery searchQueryObject = new SearchQuery(searchQuery);
+        SearchQueryExtractorVisitor visitor = new SearchQueryExtractorVisitor(searchQueryObject.getSearchFlags());
+        List<SearchQueryNode> queryList;
         try {
-            queryNode = parser.parse(searchQuery, NO_EXPLICIT_FIELD);
-        } catch (QueryNodeParseException e) {
+            queryList = visitor.visitStart(searchQueryObject.getContext());
+        } catch (Exception e) {
             throw new FetcherException("An error occurred when parsing the query");
         }
 
-        return this.performSearch(queryNode);
+        return this.performSearch(queryList);
     }
 }

jablib/src/main/java/org/jabref/logic/importer/SearchBasedParserFetcher.java

@@ -8,8 +8,7 @@
 import java.util.List;
 
 import org.jabref.model.entry.BibEntry;
-
-import org.apache.lucene.queryparser.flexible.core.nodes.QueryNode;
+import org.jabref.model.search.query.SearchQueryNode;
 
 /**
  * Provides a convenient interface for search-based fetcher, which follows the usual three-step procedure:
@@ -40,14 +39,14 @@ public interface SearchBasedParserFetcher extends SearchBasedFetcher, ParserFetc
      * This method is necessary as the performSearch method does not support certain URL parameters that are used for
      * fielded search, such as a title, author, or year parameter.
      *
-     * @param luceneQuery the root node of the lucene query
+     * @param queryList the list that contains the parsed nodes
      */
     @Override
-    default List<BibEntry> performSearch(QueryNode luceneQuery) throws FetcherException {
+    default List<BibEntry> performSearch(List<SearchQueryNode> queryList) throws FetcherException {
         // ADR-0014
         URL urlForQuery;
         try {
-            urlForQuery = getURLForQuery(luceneQuery);
+            urlForQuery = getURLForQuery(queryList);
         } catch (URISyntaxException | MalformedURLException | FetcherException e) {
             throw new FetcherException("Search URI crafted from complex search query is malformed", e);
         }
@@ -76,7 +75,7 @@ private List<BibEntry> getBibEntries(URL urlForQuery) throws FetcherException {
     /**
      * Constructs a URL based on the lucene query.
      *
-     * @param luceneQuery the root node of the lucene query
+     * @param queryList the list that contains the parsed nodes
      */
-    URL getURLForQuery(QueryNode luceneQuery) throws URISyntaxException, MalformedURLException, FetcherException;
+    URL getURLForQuery(List<SearchQueryNode> queryList) throws URISyntaxException, MalformedURLException, FetcherException;
 }

jablib/src/main/java/org/jabref/logic/importer/fetcher/ACMPortalFetcher.java

@@ -5,16 +5,16 @@
 import java.net.MalformedURLException;
 import java.net.URISyntaxException;
 import java.net.URL;
+import java.util.List;
 import java.util.Optional;
 
 import org.jabref.logic.help.HelpFile;
 import org.jabref.logic.importer.Parser;
 import org.jabref.logic.importer.SearchBasedParserFetcher;
-import org.jabref.logic.importer.fetcher.transformers.DefaultQueryTransformer;
 import org.jabref.logic.importer.fileformat.ACMPortalParser;
+import org.jabref.model.search.query.SearchQueryNode;
 
 import org.apache.hc.core5.net.URIBuilder;
-import org.apache.lucene.queryparser.flexible.core.nodes.QueryNode;
 
 public class ACMPortalFetcher implements SearchBasedParserFetcher {
 
@@ -37,20 +37,25 @@ public Optional<HelpFile> getHelpPage() {
         return Optional.of(HelpFile.FETCHER_ACM);
     }
 
-    private static String createQueryString(QueryNode query) {
-        return new DefaultQueryTransformer().transformLuceneQuery(query).orElse("");
+    private static String createQueryString(List<SearchQueryNode> queryList) {
+        StringBuilder stringBuilder = new StringBuilder();
+        for (SearchQueryNode term : queryList) {
+            stringBuilder.append(term.term());
+            stringBuilder.append(" "); // Append a space as a delimiter
+        }
+        return stringBuilder.toString().trim();
     }
 
     /**
      * Constructing the url for the searchpage.
      *
-     * @param query query node
+     * @param queryList list that contains the parsed nodes
      * @return query URL
      */
     @Override
-    public URL getURLForQuery(QueryNode query) throws URISyntaxException, MalformedURLException {
+    public URL getURLForQuery(List<SearchQueryNode> queryList) throws URISyntaxException, MalformedURLException {
         URIBuilder uriBuilder = new URIBuilder(SEARCH_URL);
-        uriBuilder.addParameter("AllField", createQueryString(query));
+        uriBuilder.addParameter("AllField", createQueryString(queryList));
         return uriBuilder.build().toURL();
     }