Skip to content

Update the search syntax highlight for web search #13801

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Sep 8, 2025
Merged

Update the search syntax highlight for web search #13801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
7bda35c
Renamed DefaultLuceneQueryTransformer class to DefaultSearchQueryTran…
turhantolgaunal Aug 29, 2025
a2b5b5c
Merge branch 'main' into followupfetcherconversion
turhantolgaunal Aug 29, 2025
d4c4ac9
Changed the highlighting logic for web search to use the new ANTLR ba…
turhantolgaunal Sep 1, 2025
b2f8617
Merge branch 'main' into websearchsyntaxhighlight
turhantolgaunal Sep 1, 2025
25aece5
Merge branch 'main' into websearchsyntaxhighlight
turhantolgaunal Sep 2, 2025
7c5e623
Ran rewrite
turhantolgaunal Sep 2, 2025
368cdba
Merge branch 'main' into websearchsyntaxhighlight
turhantolgaunal Sep 3, 2025
cdfd931
Removed invalid DOI check as the new parser doesn't support checking …
turhantolgaunal Sep 3, 2025
7334b70
Merge remote-tracking branch 'origin/websearchsyntaxhighlight' into w…
turhantolgaunal Sep 3, 2025
a7d584d
Merge branch 'main' into websearchsyntaxhighlight
turhantolgaunal Sep 3, 2025
3aa0bfe
Reused the existing l10n for error message
turhantolgaunal Sep 7, 2025
53d52e8
Merge remote-tracking branch 'origin/websearchsyntaxhighlight' into w…
turhantolgaunal Sep 7, 2025
2d0c95a
Re-use existing code
koppor Sep 8, 2025
a7cf98f
Modern Java
koppor Sep 8, 2025
8c4693d
Fix comment
koppor Sep 8, 2025
252a944
Re-add test
koppor Sep 8, 2025
c12355c
Fix position
koppor Sep 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 19 additions & 17 deletions jabgui/src/main/java/org/jabref/gui/importer/fetcher/WebSearchPaneViewModel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import org.jabref.logic.importer.WebFetchers;
import org.jabref.logic.l10n.Localization;
import org.jabref.logic.util.BackgroundTask;
import org.jabref.model.search.query.SearchQuery;
import org.jabref.model.strings.StringUtil;
import org.jabref.model.util.OptionalUtil;

Expand All @@ -30,12 +31,9 @@
import de.saxsys.mvvmfx.utils.validation.ValidationMessage;
import de.saxsys.mvvmfx.utils.validation.ValidationStatus;
import de.saxsys.mvvmfx.utils.validation.Validator;
import org.apache.lucene.queryparser.flexible.core.QueryNodeParseException;
import org.apache.lucene.queryparser.flexible.core.parser.SyntaxParser;
import org.apache.lucene.queryparser.flexible.standard.parser.ParseException;
import org.apache.lucene.queryparser.flexible.standard.parser.StandardSyntaxParser;

import static org.jabref.logic.importer.fetcher.transformers.AbstractQueryTransformer.NO_EXPLICIT_FIELD;
import org.antlr.v4.runtime.RecognitionException;
import org.antlr.v4.runtime.Token;
import org.antlr.v4.runtime.misc.ParseCancellationException;

public class WebSearchPaneViewModel {

Expand All @@ -47,7 +45,6 @@ public class WebSearchPaneViewModel {
private final StateManager stateManager;

private final Validator searchQueryValidator;
private final SyntaxParser parser = new StandardSyntaxParser();

public WebSearchPaneViewModel(GuiPreferences preferences, DialogService dialogService, StateManager stateManager) {
this.dialogService = dialogService;
Expand Down Expand Up @@ -85,18 +82,23 @@ public WebSearchPaneViewModel(GuiPreferences preferences, DialogService dialogSe
}

try {
parser.parse(queryText, NO_EXPLICIT_FIELD);
// The result is ignored because we just check for validity
SearchQuery.getStartContext(queryText);
return null;
} catch (ParseException e) {
String element = e.currentToken.image;
int position = e.currentToken.beginColumn;
if (element == null) {
return ValidationMessage.error(Localization.lang("Invalid query. Check position %0.", position));
} else {
return ValidationMessage.error(Localization.lang("Invalid query element '%0' at position %1", element, position));
} catch (ParseCancellationException e) {
// RecognitionException can point out the exact error
if (e.getCause() instanceof RecognitionException recEx) {
Token offendingToken = recEx.getOffendingToken();

// The character position is 0-based, so we add 1 for user-friendliness.
int line = offendingToken.getLine();
int charPositionInLine = offendingToken.getCharPositionInLine() + 1;

return ValidationMessage.error(Localization.lang("Invalid query element '%0' at position %1", line, charPositionInLine));
}
} catch (QueryNodeParseException e) {
return ValidationMessage.error("");

// Fallback for other failing reasons
return ValidationMessage.error(Localization.lang("Invalid query"));
}
});
}
Expand Down
7 changes: 4 additions & 3 deletions jabgui/src/test/java/org/jabref/gui/importer/fetcher/WebSearchPaneViewModelTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,10 @@ void canExtractDOIFromQueryText() {
}

@Test
void queryConsistingOfInvalidDOIIsInvalid() {
void queryConsistingOfInvalidDOIIsValid() {
viewModel.queryProperty().setValue("101.1007/JHEP02(2023)082");
assertFalse(viewModel.queryValidationStatus().validProperty().getValue());
// There is currently no interpretation of nearly-valid identifiers, therefore, this is concidered as "regular" search term
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comment merely restates what the code does and contains a spelling error ('concidered'). Comments should provide additional information not obvious from the code.

assertTrue(viewModel.queryValidationStatus().validProperty().getValue());
}

@Test
Expand All @@ -90,7 +91,7 @@ void canExtractISBNFromQueryText() {

@Test
void queryConsistingOfArXivIdIsValid() {
viewModel.queryProperty().setValue("arXiv:2110.02957");
viewModel.queryProperty().setValue("arXiv=2110.02957");
assertTrue(viewModel.queryValidationStatus().validProperty().getValue());
}

Expand Down
2 changes: 1 addition & 1 deletion jablib/src/main/resources/l10n/JabRef_en.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1001,7 +1001,7 @@ You\ must\ restart\ JabRef\ for\ this\ to\ come\ into\ effect.=You must restart

Could\ not\ find\ fetcher\ '%0'=Could not find fetcher '%0'
Running\ query\ '%0'\ with\ fetcher\ '%1'.=Running query '%0' with fetcher '%1'.
Invalid\ query.\ Check\ position\ %0.=Invalid query. Check position %0.
Invalid\ query=Invalid query
Invalid\ query\ element\ '%0'\ at\ position\ %1=Invalid query element '%0' at position %1

Move\ file=Move file
Expand Down
Loading