> searchFlagsProperty() {
return searchFlagsProperty;
}
+ public void setSearchFlag(SearchFlags searchFlag, boolean value) {
+ if (value) {
+ searchFlagsProperty.getValue().add(searchFlag);
+ } else {
+ searchFlagsProperty.getValue().remove(searchFlag);
+ }
+ }
+
public BooleanProperty autoGroupKeywordsOptionProperty() {
return autoGroupKeywordsOptionProperty;
}
diff --git a/src/main/java/org/jabref/gui/groups/GroupNodeViewModel.java b/src/main/java/org/jabref/gui/groups/GroupNodeViewModel.java
index cc64665235f..812674cdd65 100644
--- a/src/main/java/org/jabref/gui/groups/GroupNodeViewModel.java
+++ b/src/main/java/org/jabref/gui/groups/GroupNodeViewModel.java
@@ -101,13 +101,10 @@ public GroupNodeViewModel(BibDatabaseContext databaseContext, StateManager state
if (groupNode.getGroup() instanceof TexGroup) {
databaseContext.getMetaData().groupsBinding().addListener(new WeakInvalidationListener(onInvalidatedGroup));
} else if (groupNode.getGroup() instanceof SearchGroup searchGroup) {
- stateManager.getLuceneManager(databaseContext).ifPresent(luceneManager -> {
- BackgroundTask.wrap(() -> {
- searchGroup.setMatchedEntries(luceneManager.search(searchGroup.getQuery()).getMatchedEntries());
- }).onSuccess(success -> {
- refreshGroup();
- databaseContext.getMetaData().groupsBinding().invalidate();
- }).executeWith(taskExecutor);
+ stateManager.getIndexManager(databaseContext).ifPresent(indexManager -> {
+ searchGroup.setMatchedEntries(indexManager.search(searchGroup.getSearchQuery()).getMatchedEntries());
+ refreshGroup();
+ databaseContext.getMetaData().groupsBinding().invalidate();
});
}
@@ -127,7 +124,7 @@ public GroupNodeViewModel(BibDatabaseContext databaseContext, StateManager state
// 'all' returns 'true' for empty streams, so this has to be checked explicitly
allSelectedEntriesMatched = selectedEntriesMatchStatus.isEmptyBinding().not().and(selectedEntriesMatchStatus.allMatch(matched -> matched));
- this.databaseContext.getDatabase().registerListener(new LuceneIndexListener());
+ this.databaseContext.getDatabase().registerListener(new SearchIndexListener());
}
public GroupNodeViewModel(BibDatabaseContext databaseContext, StateManager stateManager, TaskExecutor taskExecutor, AbstractGroup group, CustomLocalDragboard localDragboard, GuiPreferences preferences) {
@@ -251,7 +248,7 @@ public GroupTreeNode getGroupNode() {
/**
* Gets invoked if an entry in the current database changes.
*
- * @implNote Search groups are updated in {@link LuceneIndexListener}.
+ * @implNote Search groups are updated in {@link SearchIndexListener}.
*/
private void onDatabaseChanged(ListChangeListener.Change change) {
if (groupNode.getGroup() instanceof SearchGroup) {
@@ -536,17 +533,14 @@ public boolean isEditable() {
}
}
- class LuceneIndexListener {
+ class SearchIndexListener {
@Subscribe
public void listen(IndexStartedEvent event) {
if (groupNode.getGroup() instanceof SearchGroup searchGroup) {
- stateManager.getLuceneManager(databaseContext).ifPresent(luceneManager -> {
- BackgroundTask.wrap(() -> {
- searchGroup.setMatchedEntries(luceneManager.search(searchGroup.getQuery()).getMatchedEntries());
- }).onSuccess(success -> {
- refreshGroup();
- databaseContext.getMetaData().groupsBinding().invalidate();
- }).executeWith(taskExecutor);
+ stateManager.getIndexManager(databaseContext).ifPresent(indexManager -> {
+ searchGroup.setMatchedEntries(indexManager.search(searchGroup.getSearchQuery()).getMatchedEntries());
+ refreshGroup();
+ databaseContext.getMetaData().groupsBinding().invalidate();
});
}
}
@@ -554,10 +548,10 @@ public void listen(IndexStartedEvent event) {
@Subscribe
public void listen(IndexAddedOrUpdatedEvent event) {
if (groupNode.getGroup() instanceof SearchGroup searchGroup) {
- stateManager.getLuceneManager(databaseContext).ifPresent(luceneManager -> {
+ stateManager.getIndexManager(databaseContext).ifPresent(indexManager -> {
BackgroundTask.wrap(() -> {
for (BibEntry entry : event.entries()) {
- searchGroup.updateMatches(entry, luceneManager.isEntryMatched(entry, searchGroup.getQuery()));
+ searchGroup.updateMatches(entry, indexManager.isEntryMatched(entry, searchGroup.getSearchQuery()));
}
}).onFinished(() -> {
for (BibEntry entry : event.entries()) {
diff --git a/src/main/java/org/jabref/gui/icon/IconTheme.java b/src/main/java/org/jabref/gui/icon/IconTheme.java
index 0cd33366896..aa6cff98462 100644
--- a/src/main/java/org/jabref/gui/icon/IconTheme.java
+++ b/src/main/java/org/jabref/gui/icon/IconTheme.java
@@ -169,6 +169,7 @@ public enum JabRefIcons implements JabRefIcon {
ADD_NOBOX(MaterialDesignP.PLUS),
ADD_ARTICLE(MaterialDesignP.PLUS),
ADD_ENTRY(MaterialDesignP.PLAYLIST_PLUS),
+ CASE_SENSITIVE(MaterialDesignA.ALPHABETICAL),
EDIT_ENTRY(MaterialDesignT.TOOLTIP_EDIT),
EDIT_STRINGS(MaterialDesignT.TOOLTIP_TEXT),
FOLDER(MaterialDesignF.FOLDER_OUTLINE),
diff --git a/src/main/java/org/jabref/gui/importer/actions/CheckForNewEntryTypesAction.java b/src/main/java/org/jabref/gui/importer/actions/CheckForNewEntryTypesAction.java
index 68b086f4ba8..e63af24ab95 100644
--- a/src/main/java/org/jabref/gui/importer/actions/CheckForNewEntryTypesAction.java
+++ b/src/main/java/org/jabref/gui/importer/actions/CheckForNewEntryTypesAction.java
@@ -21,7 +21,7 @@
public class CheckForNewEntryTypesAction implements GUIPostOpenAction {
@Override
- public boolean isActionNecessary(ParserResult parserResult, CliPreferences preferences) {
+ public boolean isActionNecessary(ParserResult parserResult, DialogService dialogService, CliPreferences preferences) {
return !getListOfUnknownAndUnequalCustomizations(parserResult, preferences.getLibraryPreferences()).isEmpty();
}
diff --git a/src/main/java/org/jabref/gui/importer/actions/GUIPostOpenAction.java b/src/main/java/org/jabref/gui/importer/actions/GUIPostOpenAction.java
index 2551845ea61..f4eec73e339 100644
--- a/src/main/java/org/jabref/gui/importer/actions/GUIPostOpenAction.java
+++ b/src/main/java/org/jabref/gui/importer/actions/GUIPostOpenAction.java
@@ -9,7 +9,7 @@
* opening a BIB file into JabRef. This can for instance be file upgrade actions
* that should be offered due to new features in JabRef, and may depend on e.g.
* which JabRef version the file was last written by.
- *
+ *
* This interface is introduced in an attempt to add such functionality in a
* flexible manner.
*/
@@ -22,12 +22,12 @@ public interface GUIPostOpenAction {
* @param pr The result of the BIB parse operation.
* @return true if the action should be called, false otherwise.
*/
- boolean isActionNecessary(ParserResult pr, CliPreferences preferences);
+ boolean isActionNecessary(ParserResult pr, DialogService dialogService, CliPreferences preferences);
/**
* This method is called after the new database has been added to the GUI, if
* the isActionNecessary() method returned true.
- *
+ *
* Note: if several such methods need to be called sequentially, it is
* important that all implementations of this method do not return
* until the operation is finished.
diff --git a/src/main/java/org/jabref/gui/importer/actions/MergeReviewIntoCommentAction.java b/src/main/java/org/jabref/gui/importer/actions/MergeReviewIntoCommentAction.java
index 9ccec061d23..3d69e620558 100644
--- a/src/main/java/org/jabref/gui/importer/actions/MergeReviewIntoCommentAction.java
+++ b/src/main/java/org/jabref/gui/importer/actions/MergeReviewIntoCommentAction.java
@@ -11,7 +11,7 @@
public class MergeReviewIntoCommentAction implements GUIPostOpenAction {
@Override
- public boolean isActionNecessary(ParserResult parserResult, CliPreferences preferences) {
+ public boolean isActionNecessary(ParserResult parserResult, DialogService dialogService, CliPreferences preferences) {
return MergeReviewIntoCommentMigration.needsMigration(parserResult);
}
diff --git a/src/main/java/org/jabref/gui/importer/actions/OpenDatabaseAction.java b/src/main/java/org/jabref/gui/importer/actions/OpenDatabaseAction.java
index 605e389e76a..748c78db227 100644
--- a/src/main/java/org/jabref/gui/importer/actions/OpenDatabaseAction.java
+++ b/src/main/java/org/jabref/gui/importer/actions/OpenDatabaseAction.java
@@ -34,12 +34,14 @@
import org.jabref.logic.shared.exception.InvalidDBMSConnectionPropertiesException;
import org.jabref.logic.shared.exception.NotASharedDatabaseException;
import org.jabref.logic.util.BackgroundTask;
+import org.jabref.logic.util.Directories;
import org.jabref.logic.util.StandardFileType;
import org.jabref.logic.util.TaskExecutor;
import org.jabref.logic.util.io.FileHistory;
import org.jabref.model.entry.BibEntryTypesManager;
import org.jabref.model.util.FileUpdateMonitor;
+import com.google.common.annotations.VisibleForTesting;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -56,7 +58,7 @@ public class OpenDatabaseAction extends SimpleCommand {
new MergeReviewIntoCommentAction(),
// Check for new custom entry types loaded from the BIB file:
new CheckForNewEntryTypesAction(),
- // Migrate search groups from Search.g4 to Lucene syntax
+ // Migrate search groups fielded terms to use the new operators (RegEx, case sensitive)
new SearchGroupsMigrationAction());
private final LibraryTabContainer tabContainer;
@@ -94,7 +96,7 @@ public OpenDatabaseAction(LibraryTabContainer tabContainer,
public static void performPostOpenActions(ParserResult result, DialogService dialogService, CliPreferences preferences) {
for (GUIPostOpenAction action : OpenDatabaseAction.POST_OPEN_ACTIONS) {
- if (action.isActionNecessary(result, preferences)) {
+ if (action.isActionNecessary(result, dialogService, preferences)) {
action.performAction(result, dialogService, preferences);
}
}
@@ -102,20 +104,47 @@ public static void performPostOpenActions(ParserResult result, DialogService dia
@Override
public void execute() {
- FileDialogConfiguration fileDialogConfiguration = new FileDialogConfiguration.Builder()
+ List filesToOpen = getFilesToOpen();
+ openFiles(new ArrayList<>(filesToOpen));
+ }
+
+ @VisibleForTesting
+ List getFilesToOpen() {
+ List filesToOpen;
+
+ try {
+ FileDialogConfiguration initialDirectoryConfig = getFileDialogConfiguration(getInitialDirectory());
+ filesToOpen = dialogService.showFileOpenDialogAndGetMultipleFiles(initialDirectoryConfig);
+ } catch (IllegalArgumentException e) {
+ // See https://github.com/JabRef/jabref/issues/10548 for details
+ // Rebuild a new config with the home directory
+ FileDialogConfiguration homeDirectoryConfig = getFileDialogConfiguration(Directories.getUserDirectory());
+ filesToOpen = dialogService.showFileOpenDialogAndGetMultipleFiles(homeDirectoryConfig);
+ }
+
+ return filesToOpen;
+ }
+
+ /**
+ * Builds a new FileDialogConfiguration using the given path as the initial directory for use in
+ * dialogService.showFileOpenDialogAndGetMultipleFiles().
+ *
+ * @param initialDirectory Path to use as the initial directory
+ * @return new FileDialogConfig with given initial directory
+ */
+ public FileDialogConfiguration getFileDialogConfiguration(Path initialDirectory) {
+ return new FileDialogConfiguration.Builder()
.addExtensionFilter(StandardFileType.BIBTEX_DB)
.withDefaultExtension(StandardFileType.BIBTEX_DB)
- .withInitialDirectory(getInitialDirectory())
+ .withInitialDirectory(initialDirectory)
.build();
-
- List filesToOpen = dialogService.showFileOpenDialogAndGetMultipleFiles(fileDialogConfiguration);
- openFiles(new ArrayList<>(filesToOpen));
}
/**
* @return Path of current panel database directory or the working directory
*/
- private Path getInitialDirectory() {
+ @VisibleForTesting
+ Path getInitialDirectory() {
if (tabContainer.getLibraryTabs().isEmpty()) {
return preferences.getFilePreferences().getWorkingDirectory();
} else {
diff --git a/src/main/java/org/jabref/gui/importer/actions/SearchGroupsMigrationAction.java b/src/main/java/org/jabref/gui/importer/actions/SearchGroupsMigrationAction.java
index 9e2ca086ab6..c7f85f5bd54 100644
--- a/src/main/java/org/jabref/gui/importer/actions/SearchGroupsMigrationAction.java
+++ b/src/main/java/org/jabref/gui/importer/actions/SearchGroupsMigrationAction.java
@@ -7,11 +7,10 @@
import org.jabref.logic.importer.ParserResult;
import org.jabref.logic.l10n.Localization;
import org.jabref.logic.preferences.CliPreferences;
+import org.jabref.logic.search.query.SearchQueryConversion;
import org.jabref.logic.util.Version;
-import org.jabref.migrations.SearchToLuceneMigration;
import org.jabref.model.groups.GroupTreeNode;
import org.jabref.model.groups.SearchGroup;
-import org.jabref.model.search.SearchFlags;
import org.antlr.v4.runtime.misc.ParseCancellationException;
@@ -24,11 +23,17 @@ public class SearchGroupsMigrationAction implements GUIPostOpenAction {
// We cannot have this constant in `Version.java` because of recursion errors
// Thus, we keep it here, because it is (currently) used only in the context of groups migration.
public static final Version VERSION_6_0_ALPHA = Version.parse("6.0-alpha");
+ public static final Version VERSION_6_0_ALPHA_1 = Version.parse("6.0-alpha_1");
@Override
- public boolean isActionNecessary(ParserResult parserResult, CliPreferences preferences) {
- if (parserResult.getMetaData().getGroupSearchSyntaxVersion().isPresent()) {
- // Currently the presence of any version is enough to know that no migration is necessary
+ public boolean isActionNecessary(ParserResult parserResult, DialogService dialogService, CliPreferences preferences) {
+ Optional currentVersion = parserResult.getMetaData().getGroupSearchSyntaxVersion();
+ if (currentVersion.isPresent()) {
+ if (currentVersion.get().equals(VERSION_6_0_ALPHA)) {
+ // TODO: This text will only be shown after releasing 6.0-alpha and then removed
+ dialogService.showErrorDialogAndWait("Search groups migration of " + parserResult.getPath().map(Path::toString).orElse(""),
+ "The search groups syntax has been reverted to the old one. Please use the backup you made before using 6.0-alpha.");
+ }
return false;
}
@@ -57,21 +62,22 @@ public void performAction(ParserResult parserResult, DialogService dialogService
}
parserResult.getMetaData().getGroups().ifPresent(groupTreeNode -> migrateGroups(groupTreeNode, dialogService));
- parserResult.getMetaData().setGroupSearchSyntaxVersion(VERSION_6_0_ALPHA);
+ parserResult.getMetaData().setGroupSearchSyntaxVersion(VERSION_6_0_ALPHA_1);
parserResult.setChangedOnMigration(true);
}
private void migrateGroups(GroupTreeNode node, DialogService dialogService) {
if (node.getGroup() instanceof SearchGroup searchGroup) {
try {
- String luceneSearchExpression = SearchToLuceneMigration.migrateToLuceneSyntax(searchGroup.getSearchExpression(), searchGroup.getSearchFlags().contains(SearchFlags.REGULAR_EXPRESSION));
- searchGroup.setSearchExpression(luceneSearchExpression);
+ String newSearchExpression = SearchQueryConversion.flagsToSearchExpression(searchGroup.getSearchQuery());
+ searchGroup.setSearchExpression(newSearchExpression);
} catch (ParseCancellationException e) {
- Optional luceneSearchExpression = dialogService.showInputDialogWithDefaultAndWait(
+ Optional newSearchExpression = dialogService.showInputDialogWithDefaultAndWait(
Localization.lang("Search group migration failed"),
- Localization.lang("The search group '%0' could not be migrated. Please enter the new search expression.", searchGroup.getName()),
+ Localization.lang("The search group '%0' could not be migrated. Please enter the new search expression.",
+ searchGroup.getName()),
searchGroup.getSearchExpression());
- luceneSearchExpression.ifPresent(searchGroup::setSearchExpression);
+ newSearchExpression.ifPresent(searchGroup::setSearchExpression);
}
}
for (GroupTreeNode child : node.getChildren()) {
diff --git a/src/main/java/org/jabref/gui/importer/fetcher/LookupIdentifierAction.java b/src/main/java/org/jabref/gui/importer/fetcher/LookupIdentifierAction.java
index 953020e6c61..0b73e3bccab 100644
--- a/src/main/java/org/jabref/gui/importer/fetcher/LookupIdentifierAction.java
+++ b/src/main/java/org/jabref/gui/importer/fetcher/LookupIdentifierAction.java
@@ -85,7 +85,7 @@ private String lookupIdentifiers(List bibEntries) {
LOGGER.error("Could not fetch {}", fetcher.getIdentifierName(), e);
}
if (identifier.isPresent() && !bibEntry.hasField(identifier.get().getDefaultField())) {
- Optional fieldChange = bibEntry.setField(identifier.get().getDefaultField(), identifier.get().getNormalized());
+ Optional fieldChange = bibEntry.setField(identifier.get().getDefaultField(), identifier.get().asString());
if (fieldChange.isPresent()) {
namedCompound.addEdit(new UndoableFieldChange(fieldChange.get()));
foundCount++;
diff --git a/src/main/java/org/jabref/gui/maintable/BibEntryTableViewModel.java b/src/main/java/org/jabref/gui/maintable/BibEntryTableViewModel.java
index aa8fdc38ec3..613a102d9df 100644
--- a/src/main/java/org/jabref/gui/maintable/BibEntryTableViewModel.java
+++ b/src/main/java/org/jabref/gui/maintable/BibEntryTableViewModel.java
@@ -14,11 +14,9 @@
import javafx.beans.binding.Binding;
import javafx.beans.binding.Bindings;
import javafx.beans.property.BooleanProperty;
-import javafx.beans.property.FloatProperty;
import javafx.beans.property.ObjectProperty;
import javafx.beans.property.ReadOnlyStringWrapper;
import javafx.beans.property.SimpleBooleanProperty;
-import javafx.beans.property.SimpleFloatProperty;
import javafx.beans.property.SimpleObjectProperty;
import javafx.beans.property.StringProperty;
import javafx.beans.value.ObservableValue;
@@ -50,7 +48,6 @@ public class BibEntryTableViewModel {
private final EasyBinding> linkedIdentifiers;
private final Binding> matchedGroups;
private final BibDatabaseContext bibDatabaseContext;
- private final FloatProperty searchScore = new SimpleFloatProperty(0);
private final BooleanProperty hasFullTextResults = new SimpleBooleanProperty(false);
private final BooleanProperty isMatchedBySearch = new SimpleBooleanProperty(true);
private final BooleanProperty isVisibleBySearch = new SimpleBooleanProperty(true);
@@ -163,10 +160,6 @@ public BibDatabaseContext getBibDatabaseContext() {
return bibDatabaseContext;
}
- public FloatProperty searchScoreProperty() {
- return searchScore;
- }
-
public BooleanProperty hasFullTextResultsProperty() {
return hasFullTextResults;
}
diff --git a/src/main/java/org/jabref/gui/maintable/MainTable.java b/src/main/java/org/jabref/gui/maintable/MainTable.java
index 70285478536..4d66704856f 100644
--- a/src/main/java/org/jabref/gui/maintable/MainTable.java
+++ b/src/main/java/org/jabref/gui/maintable/MainTable.java
@@ -34,6 +34,7 @@
import org.jabref.gui.StateManager;
import org.jabref.gui.actions.StandardActions;
import org.jabref.gui.edit.EditAction;
+import org.jabref.gui.externalfiles.ExternalFilesEntryLinker;
import org.jabref.gui.externalfiles.ImportHandler;
import org.jabref.gui.keyboard.KeyBinding;
import org.jabref.gui.keyboard.KeyBindingRepository;
@@ -44,6 +45,7 @@
import org.jabref.gui.search.MatchCategory;
import org.jabref.gui.util.ControlHelper;
import org.jabref.gui.util.CustomLocalDragboard;
+import org.jabref.gui.util.DragDrop;
import org.jabref.gui.util.UiTaskExecutor;
import org.jabref.gui.util.ViewModelTableRowFactory;
import org.jabref.logic.FilePreferences;
@@ -433,28 +435,19 @@ private void handleOnDragDropped(TableRow row, BibEntryT
if (event.getDragboard().hasFiles()) {
List files = event.getDragboard().getFiles().stream().map(File::toPath).collect(Collectors.toList());
- // Different actions depending on where the user releases the drop in the target row
- // Bottom + top -> import entries
- // Center -> link files to entry
// Depending on the pressed modifier, move/copy/link files to drop target
+ // Modifiers do not work on macOS: https://bugs.openjdk.org/browse/JDK-8264172
+ TransferMode transferMode = event.getTransferMode();
+
switch (ControlHelper.getDroppingMouseLocation(row, event)) {
- case TOP, BOTTOM -> importHandler.importFilesInBackground(files, database, filePreferences).executeWith(taskExecutor);
+ // Different actions depending on where the user releases the drop in the target row
+ // - Bottom + top -> import entries
+ case TOP, BOTTOM -> importHandler.importFilesInBackground(files, database, filePreferences, transferMode).executeWith(taskExecutor);
+ // - Center -> modify entry: link files to entry
case CENTER -> {
BibEntry entry = target.getEntry();
- switch (event.getTransferMode()) {
- case LINK -> {
- LOGGER.debug("Mode LINK"); // shift on win or no modifier
- importHandler.getLinker().addFilesToEntry(entry, files);
- }
- case MOVE -> {
- LOGGER.debug("Mode MOVE"); // alt on win
- importHandler.getLinker().moveFilesToFileDirRenameAndAddToEntry(entry, files, libraryTab.getLuceneManager());
- }
- case COPY -> {
- LOGGER.debug("Mode Copy"); // ctrl on win
- importHandler.getLinker().copyFilesToFileDirAndAddToEntry(entry, files, libraryTab.getLuceneManager());
- }
- }
+ ExternalFilesEntryLinker fileLinker = importHandler.getFileLinker();
+ DragDrop.handleDropOfFiles(files, transferMode, fileLinker, entry);
}
}
@@ -470,7 +463,9 @@ private void handleOnDragDroppedTableView(DragEvent event) {
if (event.getDragboard().hasFiles()) {
List files = event.getDragboard().getFiles().stream().map(File::toPath).toList();
- importHandler.importFilesInBackground(files, this.database, filePreferences).executeWith(taskExecutor);
+ importHandler
+ .importFilesInBackground(files, this.database, filePreferences, event.getTransferMode())
+ .executeWith(taskExecutor);
success = true;
}
diff --git a/src/main/java/org/jabref/gui/maintable/MainTableColumnFactory.java b/src/main/java/org/jabref/gui/maintable/MainTableColumnFactory.java
index bd592f6b22c..d4d9b8fb576 100644
--- a/src/main/java/org/jabref/gui/maintable/MainTableColumnFactory.java
+++ b/src/main/java/org/jabref/gui/maintable/MainTableColumnFactory.java
@@ -33,7 +33,6 @@
import org.jabref.gui.maintable.columns.SpecialFieldColumn;
import org.jabref.gui.preferences.GuiPreferences;
import org.jabref.gui.search.MatchCategory;
-import org.jabref.gui.search.SearchType;
import org.jabref.gui.specialfields.SpecialFieldValueViewModel;
import org.jabref.gui.theme.ThemeManager;
import org.jabref.gui.util.ValueTableCellFactory;
@@ -87,9 +86,6 @@ public MainTableColumnFactory(BibDatabaseContext database,
public TableColumn createColumn(MainTableColumnModel column) {
TableColumn returnColumn = null;
switch (column.getType()) {
- case MATCH_SCORE:
- returnColumn = createScoreColumn(column);
- break;
case INDEX:
returnColumn = createIndexColumn(column);
break;
@@ -163,21 +159,6 @@ private TableColumn createMatchCategoryCo
return column;
}
- private TableColumn createScoreColumn(MainTableColumnModel columnModel) {
- TableColumn column = new MainTableColumn<>(columnModel);
- Node header = new Text(Localization.lang("Score"));
- header.getStyleClass().add("mainTable-header");
- Tooltip.install(header, new Tooltip(MainTableColumnModel.Type.MATCH_SCORE.getDisplayName()));
- column.setGraphic(header);
- column.setStyle("-fx-alignment: CENTER-RIGHT;");
- column.setCellValueFactory(cellData -> cellData.getValue().searchScoreProperty());
- new ValueTableCellFactory().withText(String::valueOf).install(column);
- column.setSortable(true);
- column.setReorderable(false);
- column.visibleProperty().bind(stateManager.activeSearchQuery(SearchType.NORMAL_SEARCH).isPresent());
- return column;
- }
-
/**
* Creates a column with a continuous number
*/
diff --git a/src/main/java/org/jabref/gui/maintable/MainTableColumnModel.java b/src/main/java/org/jabref/gui/maintable/MainTableColumnModel.java
index d0d5f7366de..b8f89ac144e 100644
--- a/src/main/java/org/jabref/gui/maintable/MainTableColumnModel.java
+++ b/src/main/java/org/jabref/gui/maintable/MainTableColumnModel.java
@@ -36,7 +36,6 @@ public class MainTableColumnModel {
private static final Logger LOGGER = LoggerFactory.getLogger(MainTableColumnModel.class);
public enum Type {
MATCH_CATEGORY("match_category"), // Not localized, because this column is always hidden
- MATCH_SCORE("match_score", Localization.lang("Match score")),
INDEX("index", Localization.lang("Index")),
EXTRAFILE("extrafile", Localization.lang("File type")),
FILES("files", Localization.lang("Linked files")),
@@ -153,7 +152,7 @@ public String getName() {
public String getDisplayName() {
if ((Type.ICON_COLUMNS.contains(typeProperty.getValue()) && qualifierProperty.getValue().isBlank())
- || (typeProperty.getValue() == Type.INDEX) || typeProperty.getValue() == Type.MATCH_SCORE) {
+ || (typeProperty.getValue() == Type.INDEX)) {
return typeProperty.getValue().getDisplayName();
} else {
// In case an OrField is used, `FieldFactory.parseField` returns UnknownField, which leads to
diff --git a/src/main/java/org/jabref/gui/maintable/MainTableDataModel.java b/src/main/java/org/jabref/gui/maintable/MainTableDataModel.java
index 5339d4220b7..4c4d6a11c75 100644
--- a/src/main/java/org/jabref/gui/maintable/MainTableDataModel.java
+++ b/src/main/java/org/jabref/gui/maintable/MainTableDataModel.java
@@ -12,7 +12,6 @@
import javafx.collections.transformation.FilteredList;
import javafx.collections.transformation.SortedList;
-import org.jabref.gui.StateManager;
import org.jabref.gui.groups.GroupViewMode;
import org.jabref.gui.groups.GroupsPreferences;
import org.jabref.gui.preferences.GuiPreferences;
@@ -20,27 +19,28 @@
import org.jabref.gui.util.BindingsHelper;
import org.jabref.gui.util.FilteredListProxy;
import org.jabref.gui.util.OptionalObjectProperty;
-import org.jabref.logic.search.LuceneManager;
-import org.jabref.logic.search.SearchDisplayMode;
+import org.jabref.logic.search.IndexManager;
import org.jabref.logic.search.SearchPreferences;
import org.jabref.logic.util.BackgroundTask;
import org.jabref.logic.util.TaskExecutor;
import org.jabref.model.database.BibDatabaseContext;
import org.jabref.model.entry.BibEntry;
import org.jabref.model.groups.GroupTreeNode;
-import org.jabref.model.search.SearchFieldConstants;
-import org.jabref.model.search.SearchQuery;
-import org.jabref.model.search.SearchResults;
+import org.jabref.model.search.SearchDisplayMode;
import org.jabref.model.search.event.IndexAddedOrUpdatedEvent;
import org.jabref.model.search.event.IndexStartedEvent;
import org.jabref.model.search.matchers.MatcherSet;
import org.jabref.model.search.matchers.MatcherSets;
+import org.jabref.model.search.query.SearchQuery;
+import org.jabref.model.search.query.SearchResults;
import com.google.common.eventbus.Subscribe;
import com.tobiasdiez.easybind.EasyBind;
import com.tobiasdiez.easybind.Subscription;
import org.jspecify.annotations.Nullable;
+import static org.jabref.model.search.PostgreConstants.ENTRY_ID;
+
public class MainTableDataModel {
private final ObservableList entriesViewModel;
@@ -51,23 +51,21 @@ public class MainTableDataModel {
private final SearchPreferences searchPreferences;
private final NameDisplayPreferences nameDisplayPreferences;
private final BibDatabaseContext bibDatabaseContext;
- private final StateManager stateManager;
private final TaskExecutor taskExecutor;
private final Subscription searchQuerySubscription;
private final Subscription searchDisplayModeSubscription;
private final Subscription selectedGroupsSubscription;
private final Subscription groupViewModeSubscription;
- private final LuceneIndexListener indexUpdatedListener;
+ private final SearchIndexListener indexUpdatedListener;
private final OptionalObjectProperty searchQueryProperty;
- @Nullable private final LuceneManager luceneManager;
+ @Nullable private final IndexManager indexManager;
private Optional groupsMatcher;
public MainTableDataModel(BibDatabaseContext context,
GuiPreferences preferences,
TaskExecutor taskExecutor,
- StateManager stateManager,
- @Nullable LuceneManager luceneManager,
+ @Nullable IndexManager indexManager,
ListProperty selectedGroupsProperty,
OptionalObjectProperty searchQueryProperty,
IntegerProperty resultSizeProperty) {
@@ -75,11 +73,10 @@ public MainTableDataModel(BibDatabaseContext context,
this.searchPreferences = preferences.getSearchPreferences();
this.nameDisplayPreferences = preferences.getNameDisplayPreferences();
this.taskExecutor = taskExecutor;
- this.stateManager = stateManager;
- this.luceneManager = luceneManager;
+ this.indexManager = indexManager;
this.bibDatabaseContext = context;
this.searchQueryProperty = searchQueryProperty;
- this.indexUpdatedListener = new LuceneIndexListener();
+ this.indexUpdatedListener = new SearchIndexListener();
this.groupsMatcher = createGroupMatcher(selectedGroupsProperty.get(), groupsPreferences);
this.bibDatabaseContext.getDatabase().registerListener(indexUpdatedListener);
@@ -102,8 +99,7 @@ public MainTableDataModel(BibDatabaseContext context,
private void updateSearchMatches(Optional query) {
BackgroundTask.wrap(() -> {
if (query.isPresent()) {
- SearchResults results = luceneManager.search(query.get());
- setSearchMatches(results);
+ setSearchMatches(indexManager.search(query.get()));
} else {
clearSearchMatches();
}
@@ -113,16 +109,15 @@ private void updateSearchMatches(Optional query) {
private void setSearchMatches(SearchResults results) {
boolean isFloatingMode = searchPreferences.getSearchDisplayMode() == SearchDisplayMode.FLOAT;
entriesViewModel.forEach(entry -> {
- entry.searchScoreProperty().set(results.getSearchScoreForEntry(entry.getEntry()));
entry.hasFullTextResultsProperty().set(results.hasFulltextResults(entry.getEntry()));
- updateEntrySearchMatch(entry, entry.searchScoreProperty().get() > 0, isFloatingMode);
+ updateEntrySearchMatch(entry, results.isMatched(entry.getEntry()), isFloatingMode);
});
}
private void clearSearchMatches() {
boolean isFloatingMode = searchPreferences.getSearchDisplayMode() == SearchDisplayMode.FLOAT;
entriesViewModel.forEach(entry -> {
- entry.searchScoreProperty().set(0);
+ entry.isMatchedBySearch().set(true);
entry.hasFullTextResultsProperty().set(false);
updateEntrySearchMatch(entry, true, isFloatingMode);
});
@@ -204,7 +199,7 @@ public void resetFieldFormatter() {
this.fieldValueFormatter.setValue(new MainTableFieldValueFormatter(nameDisplayPreferences, bibDatabaseContext));
}
- class LuceneIndexListener {
+ class SearchIndexListener {
@Subscribe
public void listen(IndexAddedOrUpdatedEvent indexAddedOrUpdatedEvent) {
indexAddedOrUpdatedEvent.entries().forEach(entry -> {
@@ -213,18 +208,17 @@ public void listen(IndexAddedOrUpdatedEvent indexAddedOrUpdatedEvent) {
if (index >= 0) {
BibEntryTableViewModel viewModel = entriesViewModel.get(index);
boolean isFloatingMode = searchPreferences.getSearchDisplayMode() == SearchDisplayMode.FLOAT;
- boolean isMatched = true;
+ boolean isMatched;
if (searchQueryProperty.get().isPresent()) {
SearchQuery searchQuery = searchQueryProperty.get().get();
- String newSearchExpression = "+" + SearchFieldConstants.ENTRY_ID + ":" + entry.getId() + " +" + searchQuery.getSearchExpression();
+ String newSearchExpression = "(" + ENTRY_ID + "= " + entry.getId() + ") AND (" + searchQuery.getSearchExpression() + ")";
SearchQuery entryQuery = new SearchQuery(newSearchExpression, searchQuery.getSearchFlags());
- SearchResults results = luceneManager.search(entryQuery);
+ SearchResults results = indexManager.search(entryQuery);
- viewModel.searchScoreProperty().set(results.getSearchScoreForEntry(entry));
+ isMatched = results.isMatched(entry);
viewModel.hasFullTextResultsProperty().set(results.hasFulltextResults(entry));
- isMatched = viewModel.searchScoreProperty().get() > 0;
} else {
- viewModel.searchScoreProperty().set(0);
+ isMatched = true;
viewModel.hasFullTextResultsProperty().set(false);
}
diff --git a/src/main/java/org/jabref/gui/mergeentries/FetchAndMergeEntry.java b/src/main/java/org/jabref/gui/mergeentries/FetchAndMergeEntry.java
index dbe205a24c4..c14e0770c15 100644
--- a/src/main/java/org/jabref/gui/mergeentries/FetchAndMergeEntry.java
+++ b/src/main/java/org/jabref/gui/mergeentries/FetchAndMergeEntry.java
@@ -40,6 +40,7 @@
*/
public class FetchAndMergeEntry {
+ // All identifiers listed here should also appear at {@link org.jabref.logic.importer.CompositeIdFetcher#performSearchById}
public static List SUPPORTED_FIELDS = Arrays.asList(StandardField.DOI, StandardField.EPRINT, StandardField.ISBN);
private static final Logger LOGGER = LoggerFactory.getLogger(FetchAndMergeEntry.class);
diff --git a/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java b/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java
index d3cfb4de424..fac88f00239 100644
--- a/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java
+++ b/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java
@@ -373,8 +373,8 @@ private JabRefGuiPreferences() {
// region: Main table, main table column, and search dialog column preferences
defaults.put(EXTRA_FILE_COLUMNS, Boolean.FALSE);
- defaults.put(COLUMN_NAMES, "search_score;groups;group_icons;files;linked_id;field:entrytype;field:author/editor;field:title;field:year;field:journal/booktitle;special:ranking;special:readstatus;special:priority");
- defaults.put(COLUMN_WIDTHS, "50;28;40;28;28;75;300;470;60;130;50;50;50");
+ defaults.put(COLUMN_NAMES, "groups;group_icons;files;linked_id;field:entrytype;field:author/editor;field:title;field:year;field:journal/booktitle;special:ranking;special:readstatus;special:priority");
+ defaults.put(COLUMN_WIDTHS, "28;40;28;28;75;300;470;60;130;50;50;50");
defaults.put(SIDE_PANE_COMPONENT_NAMES, "");
defaults.put(SIDE_PANE_COMPONENT_PREFERRED_POSITIONS, "");
@@ -394,6 +394,11 @@ private JabRefGuiPreferences() {
// endregion
}
+ /**
+ * @deprecated Never ever add a call to this method. There should be only one caller.
+ * All other usages should get the preferences passed (or injected).
+ * The JabRef team leaves the @deprecated annotation to have IntelliJ listing this method with a strike-through.
+ */
@Deprecated
public static JabRefGuiPreferences getInstance() {
if (JabRefGuiPreferences.singleton == null) {
diff --git a/src/main/java/org/jabref/gui/preferences/table/TableTabViewModel.java b/src/main/java/org/jabref/gui/preferences/table/TableTabViewModel.java
index 1df137f28e4..12ae933265e 100644
--- a/src/main/java/org/jabref/gui/preferences/table/TableTabViewModel.java
+++ b/src/main/java/org/jabref/gui/preferences/table/TableTabViewModel.java
@@ -123,7 +123,6 @@ public void setValues() {
availableColumnsProperty.clear();
availableColumnsProperty.addAll(
- new MainTableColumnModel(MainTableColumnModel.Type.MATCH_SCORE),
new MainTableColumnModel(MainTableColumnModel.Type.INDEX),
new MainTableColumnModel(MainTableColumnModel.Type.LINKED_IDENTIFIER),
new MainTableColumnModel(MainTableColumnModel.Type.GROUPS),
diff --git a/src/main/java/org/jabref/gui/preview/PreviewPanel.java b/src/main/java/org/jabref/gui/preview/PreviewPanel.java
index 1120ad4fc61..ed05024c02a 100644
--- a/src/main/java/org/jabref/gui/preview/PreviewPanel.java
+++ b/src/main/java/org/jabref/gui/preview/PreviewPanel.java
@@ -14,6 +14,7 @@
import javafx.scene.input.Dragboard;
import javafx.scene.input.KeyEvent;
import javafx.scene.input.TransferMode;
+import javafx.scene.layout.Priority;
import javafx.scene.layout.VBox;
import org.jabref.gui.DialogService;
@@ -23,22 +24,17 @@
import org.jabref.gui.keyboard.KeyBindingRepository;
import org.jabref.gui.preferences.GuiPreferences;
import org.jabref.gui.theme.ThemeManager;
+import org.jabref.gui.util.DragDrop;
import org.jabref.gui.util.OptionalObjectProperty;
import org.jabref.logic.l10n.Localization;
import org.jabref.logic.preview.PreviewLayout;
-import org.jabref.logic.search.LuceneManager;
import org.jabref.logic.util.TaskExecutor;
import org.jabref.model.database.BibDatabaseContext;
import org.jabref.model.entry.BibEntry;
-import org.jabref.model.search.SearchQuery;
-
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.jabref.model.search.query.SearchQuery;
public class PreviewPanel extends VBox {
- private static final Logger LOGGER = LoggerFactory.getLogger(PreviewPanel.class);
-
private final ExternalFilesEntryLinker fileLinker;
private final KeyBindingRepository keyBindingRepository;
private final PreviewViewer previewView;
@@ -52,7 +48,6 @@ public PreviewPanel(BibDatabaseContext database,
GuiPreferences preferences,
ThemeManager themeManager,
TaskExecutor taskExecutor,
- LuceneManager luceneManager,
OptionalObjectProperty searchQueryProperty) {
this.keyBindingRepository = keyBindingRepository;
this.dialogService = dialogService;
@@ -84,20 +79,9 @@ public PreviewPanel(BibDatabaseContext database,
previewView.setOnDragDropped(event -> {
boolean success = false;
if (event.getDragboard().hasContent(DataFormat.FILES)) {
+ TransferMode transferMode = event.getTransferMode();
List files = event.getDragboard().getFiles().stream().map(File::toPath).collect(Collectors.toList());
-
- if (event.getTransferMode() == TransferMode.MOVE) {
- LOGGER.debug("Mode MOVE"); // shift on win or no modifier
- fileLinker.moveFilesToFileDirRenameAndAddToEntry(entry, files, luceneManager);
- }
- if (event.getTransferMode() == TransferMode.LINK) {
- LOGGER.debug("Node LINK"); // alt on win
- fileLinker.addFilesToEntry(entry, files);
- }
- if (event.getTransferMode() == TransferMode.COPY) {
- LOGGER.debug("Mode Copy"); // ctrl on win, no modifier on Xubuntu
- fileLinker.copyFilesToFileDirAndAddToEntry(entry, files, luceneManager);
- }
+ DragDrop.handleDropOfFiles(files, transferMode, fileLinker, entry);
success = true;
}
@@ -105,6 +89,7 @@ public PreviewPanel(BibDatabaseContext database,
event.consume();
});
this.getChildren().add(previewView);
+ VBox.setVgrow(previewView, Priority.ALWAYS);
createKeyBindings();
previewView.setLayout(previewPreferences.getSelectedPreviewLayout());
diff --git a/src/main/java/org/jabref/gui/preview/PreviewViewer.java b/src/main/java/org/jabref/gui/preview/PreviewViewer.java
index 26322517004..29d6ed72ea8 100644
--- a/src/main/java/org/jabref/gui/preview/PreviewViewer.java
+++ b/src/main/java/org/jabref/gui/preview/PreviewViewer.java
@@ -6,11 +6,9 @@
import java.net.MalformedURLException;
import java.util.Objects;
import java.util.Optional;
-import java.util.regex.Pattern;
import javafx.beans.InvalidationListener;
import javafx.beans.Observable;
-import javafx.beans.value.ChangeListener;
import javafx.concurrent.Worker;
import javafx.print.PrinterJob;
import javafx.scene.control.ScrollPane;
@@ -26,12 +24,13 @@
import org.jabref.logic.l10n.Localization;
import org.jabref.logic.layout.format.Number;
import org.jabref.logic.preview.PreviewLayout;
+import org.jabref.logic.search.retrieval.Highlighter;
import org.jabref.logic.util.BackgroundTask;
import org.jabref.logic.util.TaskExecutor;
import org.jabref.logic.util.WebViewStore;
import org.jabref.model.database.BibDatabaseContext;
import org.jabref.model.entry.BibEntry;
-import org.jabref.model.search.SearchQuery;
+import org.jabref.model.search.query.SearchQuery;
import com.airhacks.afterburner.injection.Injector;
import org.slf4j.Logger;
@@ -71,69 +70,16 @@ function getSelectionHtml() {
}
getSelectionHtml();
""";
- private static final String JS_HIGHLIGHT_FUNCTION =
- """
-
-
-
-
-
- """;
- // This is a string format, and it takes a variable name as an argument to pass to the markInstance.markRegExp() Javascript method.
- private static final String JS_MARK_REG_EXP_CALLBACK =
- """
- {done: function(){
- markInstance.markRegExp(%s);}
- }""";
-
- // This is a string format, and it takes a variable name as an argument to pass to the markInstance.unmark() Javascript method.
- private static final String JS_UNMARK_WITH_CALLBACK =
- """
- var markInstance = new Mark(document.getElementById("content"));
- markInstance.unmark(%s);""";
- private static final Pattern UNESCAPED_FORWARD_SLASH = Pattern.compile("(?> listener = (queryObservable, queryOldValue, queryNewValue) -> {
- searchHighlightPattern = queryNewValue.flatMap(SearchQuery::getJavaScriptPatternForWords);
- highlightSearchPattern();
- };
+ private final OptionalObjectProperty searchQueryProperty;
private Optional entry = Optional.empty();
- private Optional searchHighlightPattern = Optional.empty();
private PreviewLayout layout;
- private boolean registered;
+ private String layoutText;
/**
* @param database Used for resolving strings and pdf directories for links.
@@ -148,25 +94,21 @@ public PreviewViewer(BibDatabaseContext database,
this.dialogService = dialogService;
this.clipBoardManager = Injector.instantiateModelOrService(ClipBoardManager.class);
this.taskExecutor = taskExecutor;
+ this.searchQueryProperty = searchQueryProperty;
+ this.searchQueryProperty.addListener((queryObservable, queryOldValue, queryNewValue) -> highlightLayoutText());
setFitToHeight(true);
setFitToWidth(true);
previewView = WebViewStore.get();
setContent(previewView);
previewView.setContextMenuEnabled(false);
+ previewView.getEngine().setJavaScriptEnabled(true);
previewView.getEngine().getLoadWorker().stateProperty().addListener((observable, oldValue, newValue) -> {
if (newValue != Worker.State.SUCCEEDED) {
return;
}
- if (!registered) {
- searchHighlightPattern = searchQueryProperty.get().flatMap(SearchQuery::getJavaScriptPatternForWords);
- searchQueryProperty.addListener(listener);
- registered = true;
- }
- highlightSearchPattern();
-
// https://stackoverflow.com/questions/15555510/javafx-stop-opening-url-in-webview-open-in-browser-instead
NodeList anchorList = previewView.getEngine().getDocument().getElementsByTagName("a");
for (int i = 0; i < anchorList.getLength(); i++) {
@@ -201,30 +143,6 @@ public PreviewViewer(BibDatabaseContext database,
this(database, dialogService, preferences, themeManager, taskExecutor, OptionalObjectProperty.empty());
}
- private void highlightSearchPattern() {
- String callbackForUnmark = "";
- if (searchHighlightPattern.isPresent()) {
- String javaScriptRegex = createJavaScriptRegex(searchHighlightPattern.get());
- callbackForUnmark = JS_MARK_REG_EXP_CALLBACK.formatted(javaScriptRegex);
- }
- String unmarkInstance = JS_UNMARK_WITH_CALLBACK.formatted(callbackForUnmark);
- previewView.getEngine().executeScript(unmarkInstance);
- }
-
- /**
- * Returns the String representation of a JavaScript regex object. The method does not take into account differences between the regex implementations in Java and JavaScript.
- *
- * @param regex Java regex to print as a JavaScript regex
- * @return JavaScript regex object
- */
- private static String createJavaScriptRegex(Pattern regex) {
- String pattern = regex.pattern();
- // Create a JavaScript regular expression literal (https://ecma-international.org/ecma-262/10.0/index.html#sec-literals-regular-expression-literals)
- // Forward slashes are reserved to delimit the regular expression body. Hence, they must be escaped.
- pattern = UNESCAPED_FORWARD_SLASH.matcher(pattern).replaceAll("\\\\/");
- return "/" + pattern + "/gmi";
- }
-
public void setLayout(PreviewLayout newLayout) {
// Change listeners might set the layout to null while the update method is executing, therefore we need to prevent this here
if (newLayout == null || newLayout.equals(layout)) {
@@ -267,7 +185,6 @@ private void update() {
final BibEntry theEntry = entry.get();
BackgroundTask
.wrap(() -> layout.generatePreview(theEntry, database))
- .onRunning(() -> setPreviewText("" + Localization.lang("Processing Citation Style \"%0\"...", layout.getDisplayName()) + ""))
.onSuccess(this::setPreviewText)
.onFailure(exception -> {
LOGGER.error("Error while generating citation style", exception);
@@ -285,20 +202,29 @@ private void update() {
}
private void setPreviewText(String text) {
- String myText = """
+ layoutText = """
- %s
%s
- """.formatted(JS_HIGHLIGHT_FUNCTION, text);
- previewView.getEngine().setJavaScriptEnabled(true);
- previewView.getEngine().loadContent(myText);
-
+ """.formatted(text);
+ highlightLayoutText();
this.setHvalue(0);
}
+ private void highlightLayoutText() {
+ if (layoutText == null) {
+ return;
+ }
+ if (searchQueryProperty.get().isPresent()) {
+ String highlightedHtml = Highlighter.highlightHtml(layoutText, searchQueryProperty.get().get());
+ previewView.getEngine().loadContent(highlightedHtml);
+ } else {
+ previewView.getEngine().loadContent(layoutText);
+ }
+ }
+
public void print() {
PrinterJob job = PrinterJob.createPrinterJob();
boolean proceed = dialogService.showPrintDialog(job);
diff --git a/src/main/java/org/jabref/gui/push/AbstractPushToApplication.java b/src/main/java/org/jabref/gui/push/AbstractPushToApplication.java
index 40c04c97a8d..15615c88691 100644
--- a/src/main/java/org/jabref/gui/push/AbstractPushToApplication.java
+++ b/src/main/java/org/jabref/gui/push/AbstractPushToApplication.java
@@ -1,6 +1,7 @@
package org.jabref.gui.push;
import java.io.IOException;
+import java.nio.file.Path;
import java.util.List;
import java.util.Optional;
@@ -181,4 +182,28 @@ public Optional getKeyBinding() {
return Optional.of(KeyBinding.PUSH_TO_APPLICATION);
}
}
+
+ public void jumpToLine(Path fileName, int line, int column) {
+ commandPath = preferences.getPushToApplicationPreferences().getCommandPaths().get(this.getDisplayName());
+
+ if (StringUtil.isNullOrEmpty(commandPath)) {
+ notDefined = true;
+ return;
+ }
+
+ String[] command = jumpToLineCommandlineArguments(fileName, line, column);
+ ProcessBuilder processBuilder = new ProcessBuilder();
+ try {
+ processBuilder.command(command);
+ processBuilder.start();
+ } catch (IOException excep) {
+ LOGGER.warn("Error: Could not call executable '{}'", commandPath, excep);
+ couldNotCall = true;
+ }
+ }
+
+ protected String[] jumpToLineCommandlineArguments(Path fileName, int line, int column) {
+ LOGGER.error("Not yet implemented");
+ return new String[0];
+ }
}
diff --git a/src/main/java/org/jabref/gui/push/PushToApplication.java b/src/main/java/org/jabref/gui/push/PushToApplication.java
index 18e012e904f..9292b433fb9 100644
--- a/src/main/java/org/jabref/gui/push/PushToApplication.java
+++ b/src/main/java/org/jabref/gui/push/PushToApplication.java
@@ -1,5 +1,6 @@
package org.jabref.gui.push;
+import java.nio.file.Path;
import java.util.List;
import org.jabref.gui.actions.Action;
@@ -56,4 +57,6 @@ public interface PushToApplication {
PushToApplicationSettings getSettings(PushToApplication application, PushToApplicationPreferences pushToApplicationPreferences);
String getDelimiter();
+
+ void jumpToLine(Path fileName, int line, int column);
}
diff --git a/src/main/java/org/jabref/gui/push/PushToApplicationCommand.java b/src/main/java/org/jabref/gui/push/PushToApplicationCommand.java
index c5fa4c905eb..5ab1c532d4d 100644
--- a/src/main/java/org/jabref/gui/push/PushToApplicationCommand.java
+++ b/src/main/java/org/jabref/gui/push/PushToApplicationCommand.java
@@ -104,7 +104,7 @@ private static String getKeyString(List entries, String delimiter) {
for (BibEntry bes : entries) {
citeKey = bes.getCitationKey();
if (citeKey.isEmpty() || citeKey.get().isEmpty()) {
- // Should never occur, because we made sure that all entries have keys
+ LOGGER.warn("Should never occur, because we made sure that all entries have keys");
continue;
}
if (first) {
diff --git a/src/main/java/org/jabref/gui/push/PushToEmacs.java b/src/main/java/org/jabref/gui/push/PushToEmacs.java
index c3d612b2d48..0139dc02da1 100644
--- a/src/main/java/org/jabref/gui/push/PushToEmacs.java
+++ b/src/main/java/org/jabref/gui/push/PushToEmacs.java
@@ -2,6 +2,7 @@
import java.io.IOException;
import java.io.InputStream;
+import java.nio.file.Path;
import java.util.Arrays;
import java.util.List;
@@ -147,4 +148,9 @@ protected String getCommandName() {
public PushToApplicationSettings getSettings(PushToApplication application, PushToApplicationPreferences preferences) {
return new PushToEmacsSettings(application, dialogService, this.preferences.getFilePreferences(), preferences);
}
+
+ @Override
+ protected String[] jumpToLineCommandlineArguments(Path fileName, int line, int column) {
+ return new String[] {commandPath, "+%s".formatted(line), fileName.toString()};
+ }
}
diff --git a/src/main/java/org/jabref/gui/push/PushToSublimeText.java b/src/main/java/org/jabref/gui/push/PushToSublimeText.java
index af0820e7ab2..fbcef0b4cc2 100644
--- a/src/main/java/org/jabref/gui/push/PushToSublimeText.java
+++ b/src/main/java/org/jabref/gui/push/PushToSublimeText.java
@@ -86,4 +86,9 @@ protected String[] getCommandLine(String keyString) {
return new String[] {"sh", "-c", "\"" + commandPath + "\"" + " --command 'insert {\"characters\": \"" + citeCommand + keyString + getCiteSuffix() + "\"}'"};
}
}
+
+ @Override
+ protected String[] jumpToLineCommandlineArguments(Path fileName, int line, int column) {
+ return new String[] {commandPath, "%s:%s:%s".formatted(fileName.toString(), line, column)};
+ }
}
diff --git a/src/main/java/org/jabref/gui/push/PushToTeXstudio.java b/src/main/java/org/jabref/gui/push/PushToTeXstudio.java
index 17c6d5650c6..ac5ba327275 100644
--- a/src/main/java/org/jabref/gui/push/PushToTeXstudio.java
+++ b/src/main/java/org/jabref/gui/push/PushToTeXstudio.java
@@ -1,5 +1,7 @@
package org.jabref.gui.push;
+import java.nio.file.Path;
+
import org.jabref.gui.DialogService;
import org.jabref.gui.icon.IconTheme;
import org.jabref.gui.icon.JabRefIcon;
@@ -27,4 +29,9 @@ public JabRefIcon getApplicationIcon() {
protected String[] getCommandLine(String keyString) {
return new String[] {commandPath, "--insert-cite", "%s%s%s".formatted(getCitePrefix(), keyString, getCiteSuffix())};
}
+
+ @Override
+ public String[] jumpToLineCommandlineArguments(Path fileName, int line, int column) {
+ return new String[] {commandPath, "--line", Integer.toString(line), fileName.toString()};
+ }
}
diff --git a/src/main/java/org/jabref/gui/push/PushToTeXworks.java b/src/main/java/org/jabref/gui/push/PushToTeXworks.java
index c59df18ba0f..6459d848c13 100644
--- a/src/main/java/org/jabref/gui/push/PushToTeXworks.java
+++ b/src/main/java/org/jabref/gui/push/PushToTeXworks.java
@@ -1,5 +1,7 @@
package org.jabref.gui.push;
+import java.nio.file.Path;
+
import org.jabref.gui.DialogService;
import org.jabref.gui.icon.IconTheme;
import org.jabref.gui.icon.JabRefIcon;
@@ -33,4 +35,10 @@ public JabRefIcon getApplicationIcon() {
protected String[] getCommandLine(String keyString) {
return new String[] {commandPath, "--insert-text", "%s%s%s".formatted(getCitePrefix(), keyString, getCiteSuffix())};
}
+
+ @Override
+ protected String[] jumpToLineCommandlineArguments(Path fileName, int line, int column) {
+ // No command known to jump to a specific line
+ return new String[] {commandPath, fileName.toString()};
+ }
}
diff --git a/src/main/java/org/jabref/gui/push/PushToTexmaker.java b/src/main/java/org/jabref/gui/push/PushToTexmaker.java
index 75bae32116a..509fb6626ff 100644
--- a/src/main/java/org/jabref/gui/push/PushToTexmaker.java
+++ b/src/main/java/org/jabref/gui/push/PushToTexmaker.java
@@ -1,5 +1,7 @@
package org.jabref.gui.push;
+import java.nio.file.Path;
+
import org.jabref.gui.DialogService;
import org.jabref.gui.icon.IconTheme;
import org.jabref.gui.icon.JabRefIcon;
@@ -30,4 +32,9 @@ public JabRefIcon getApplicationIcon() {
protected String[] getCommandLine(String keyString) {
return new String[] {commandPath, "-insert", getCitePrefix() + keyString + getCiteSuffix()};
}
+
+ @Override
+ protected String[] jumpToLineCommandlineArguments(Path fileName, int line, int column) {
+ return new String[] {commandPath, "-line", Integer.toString(line), fileName.toString()};
+ }
}
diff --git a/src/main/java/org/jabref/gui/push/PushToVim.java b/src/main/java/org/jabref/gui/push/PushToVim.java
index 8702cd11eed..3e2f3d4fb04 100644
--- a/src/main/java/org/jabref/gui/push/PushToVim.java
+++ b/src/main/java/org/jabref/gui/push/PushToVim.java
@@ -2,6 +2,7 @@
import java.io.IOException;
import java.io.InputStream;
+import java.nio.file.Path;
import java.util.Arrays;
import java.util.List;
@@ -10,6 +11,7 @@
import org.jabref.gui.icon.JabRefIcon;
import org.jabref.gui.preferences.GuiPreferences;
import org.jabref.logic.l10n.Localization;
+import org.jabref.logic.os.OS;
import org.jabref.logic.util.HeadlessExecutorService;
import org.jabref.model.database.BibDatabaseContext;
import org.jabref.model.entry.BibEntry;
@@ -44,14 +46,7 @@ public PushToApplicationSettings getSettings(PushToApplication application, Push
@Override
public void pushEntries(BibDatabaseContext database, List entries, String keys) {
- couldNotPush = false;
- couldNotCall = false;
- notDefined = false;
-
- commandPath = preferences.getPushToApplicationPreferences().getCommandPaths().get(this.getDisplayName());
-
- if ((commandPath == null) || commandPath.trim().isEmpty()) {
- notDefined = true;
+ if (!determineCommandPath()) {
return;
}
@@ -105,4 +100,65 @@ public void onOperationCompleted() {
super.onOperationCompleted();
}
}
+
+ @Override
+ public void jumpToLine(Path fileName, int line, int column) {
+ if (!determineCommandPath()) {
+ return;
+ }
+
+ ProcessBuilder processBuilder = new ProcessBuilder();
+ try {
+ String[] command = jumpToLineCommandlineArguments(fileName, line, column);
+ if (OS.WINDOWS) {
+ processBuilder.command("cmd",
+ "/c",
+ "start",
+ "",
+ "\"%s\"".formatted(command[0]),
+ "\"%s\"".formatted(command[1]),
+ "\"%s\"".formatted(command[2]),
+ "\"+normal %s|\"".formatted(Integer.toString(column)));
+ } else if (OS.LINUX) {
+ processBuilder.command("gnome-terminal",
+ "--",
+ command[0],
+ command[1],
+ command[2],
+ command[3]);
+ } else if (OS.OS_X) {
+ processBuilder.command("open",
+ "-a",
+ "Terminal",
+ "--args",
+ command[0],
+ command[1],
+ command[2],
+ command[3]);
+ }
+ processBuilder.start();
+ } catch (IOException e) {
+ LOGGER.warn("Problem pushing to Vim.", e);
+ couldNotCall = true;
+ }
+ }
+
+ private boolean determineCommandPath() {
+ couldNotPush = false;
+ couldNotCall = false;
+ notDefined = false;
+
+ commandPath = preferences.getPushToApplicationPreferences().getCommandPaths().get(this.getDisplayName());
+
+ if ((commandPath == null) || commandPath.trim().isEmpty()) {
+ notDefined = true;
+ return false;
+ }
+ return true;
+ }
+
+ @Override
+ protected String[] jumpToLineCommandlineArguments(Path fileName, int line, int column) {
+ return new String[] {commandPath, "+%s".formatted(line), fileName.toString(), "+\"normal %s|\"".formatted(column)};
+ }
}
diff --git a/src/main/java/org/jabref/gui/push/PushToWinEdt.java b/src/main/java/org/jabref/gui/push/PushToWinEdt.java
index 7545a75244c..e1c8269d7b9 100644
--- a/src/main/java/org/jabref/gui/push/PushToWinEdt.java
+++ b/src/main/java/org/jabref/gui/push/PushToWinEdt.java
@@ -1,5 +1,7 @@
package org.jabref.gui.push;
+import java.nio.file.Path;
+
import org.jabref.gui.DialogService;
import org.jabref.gui.icon.IconTheme;
import org.jabref.gui.icon.JabRefIcon;
@@ -28,4 +30,9 @@ protected String[] getCommandLine(String keyString) {
return new String[] {commandPath,
"\"[InsText('" + getCitePrefix() + keyString.replace("'", "''") + getCiteSuffix() + "');]\""};
}
+
+ @Override
+ protected String[] jumpToLineCommandlineArguments(Path fileName, int line, int column) {
+ return new String[] {commandPath, "\"[Open(|%s|);SelLine(%s,%s);]\"".formatted(fileName.toString(), line, column)};
+ }
}
diff --git a/src/main/java/org/jabref/gui/search/GlobalSearchBar.java b/src/main/java/org/jabref/gui/search/GlobalSearchBar.java
index a4cad4a6ccb..ea6633a2a34 100644
--- a/src/main/java/org/jabref/gui/search/GlobalSearchBar.java
+++ b/src/main/java/org/jabref/gui/search/GlobalSearchBar.java
@@ -2,12 +2,9 @@
import java.lang.reflect.Field;
import java.time.Duration;
-import java.util.EnumSet;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
-import java.util.regex.Pattern;
-import java.util.regex.PatternSyntaxException;
import javax.swing.undo.UndoManager;
@@ -61,11 +58,11 @@
import org.jabref.logic.FilePreferences;
import org.jabref.logic.l10n.Localization;
import org.jabref.logic.preferences.AutoCompleteFirstNameMode;
-import org.jabref.logic.search.SearchDisplayMode;
import org.jabref.logic.search.SearchPreferences;
import org.jabref.model.entry.Author;
+import org.jabref.model.search.SearchDisplayMode;
import org.jabref.model.search.SearchFlags;
-import org.jabref.model.search.SearchQuery;
+import org.jabref.model.search.query.SearchQuery;
import com.tobiasdiez.easybind.EasyBind;
import impl.org.controlsfx.skin.AutoCompletePopup;
@@ -85,10 +82,12 @@ public class GlobalSearchBar extends HBox {
private static final PseudoClass ILLEGAL_SEARCH = PseudoClass.getPseudoClass("illegal-search");
private final CustomTextField searchField;
- private final ToggleButton fulltextButton;
private final Button openGlobalSearchButton;
+ private final ToggleButton fulltextButton;
private final ToggleButton keepSearchString;
private final ToggleButton filterModeButton;
+ private final ToggleButton regexButton;
+ private final ToggleButton caseSensitiveButton;
private final Tooltip searchFieldTooltip = new Tooltip();
private final StateManager stateManager;
private final GuiPreferences preferences;
@@ -130,17 +129,14 @@ public GlobalSearchBar(LibraryTabContainer tabContainer,
currentResults.textProperty().bind(EasyBind.combine(
stateManager.activeSearchQuery(searchType), stateManager.searchResultSize(searchType), illegalSearch,
(searchQuery, matched, illegal) -> {
+ searchField.pseudoClassStateChanged(ILLEGAL_SEARCH, illegal);
if (illegal) {
- searchField.pseudoClassStateChanged(ILLEGAL_SEARCH, true);
- return Localization.lang("Search failed: illegal search expression");
+ return Localization.lang("Illegal search expression");
} else if (searchQuery.isEmpty()) {
- searchField.pseudoClassStateChanged(ILLEGAL_SEARCH, false);
return "";
} else if (matched.intValue() == 0) {
- searchField.pseudoClassStateChanged(ILLEGAL_SEARCH, false);
return Localization.lang("No results found.");
} else {
- searchField.pseudoClassStateChanged(ILLEGAL_SEARCH, false);
return Localization.lang("Found %0 results.", String.valueOf(matched));
}
}
@@ -149,7 +145,7 @@ public GlobalSearchBar(LibraryTabContainer tabContainer,
searchField.setTooltip(searchFieldTooltip);
searchFieldTooltip.setContentDisplay(ContentDisplay.GRAPHIC_ONLY);
searchFieldTooltip.setMaxHeight(10);
- updateHintVisibility();
+ setSearchBarHint();
searchField.addEventFilter(KeyEvent.KEY_PRESSED, event -> {
if (keyBindingRepository.matches(event, KeyBinding.CLEAR_SEARCH)) {
@@ -172,6 +168,8 @@ public GlobalSearchBar(LibraryTabContainer tabContainer,
searchField.getContextMenu().getItems().add(SearchFieldRightClickMenu.createSearchFromHistorySubMenu(stateManager, searchField));
});
+ regexButton = IconTheme.JabRefIcons.REG_EX.asToggleButton();
+ caseSensitiveButton = IconTheme.JabRefIcons.CASE_SENSITIVE.asToggleButton();
fulltextButton = IconTheme.JabRefIcons.FULLTEXT.asToggleButton();
openGlobalSearchButton = IconTheme.JabRefIcons.OPEN_GLOBAL_SEARCH.asButton();
keepSearchString = IconTheme.JabRefIcons.KEEP_SEARCH_STRING.asToggleButton();
@@ -180,11 +178,17 @@ public GlobalSearchBar(LibraryTabContainer tabContainer,
initSearchModifierButtons();
BooleanBinding focusedOrActive = searchField.focusedProperty()
+ .or(regexButton.focusedProperty())
+ .or(caseSensitiveButton.focusedProperty())
.or(fulltextButton.focusedProperty())
.or(keepSearchString.focusedProperty())
.or(filterModeButton.focusedProperty())
.or(searchField.textProperty().isNotEmpty());
+ regexButton.visibleProperty().unbind();
+ regexButton.visibleProperty().bind(focusedOrActive);
+ caseSensitiveButton.visibleProperty().unbind();
+ caseSensitiveButton.visibleProperty().bind(focusedOrActive);
fulltextButton.visibleProperty().unbind();
fulltextButton.visibleProperty().bind(focusedOrActive);
keepSearchString.visibleProperty().unbind();
@@ -194,10 +198,11 @@ public GlobalSearchBar(LibraryTabContainer tabContainer,
StackPane modifierButtons;
if (searchType == SearchType.NORMAL_SEARCH) {
- modifierButtons = new StackPane(new HBox(fulltextButton, keepSearchString, filterModeButton));
+ modifierButtons = new StackPane(new HBox(regexButton, caseSensitiveButton, fulltextButton, keepSearchString, filterModeButton));
} else {
- modifierButtons = new StackPane(new HBox(fulltextButton));
+ modifierButtons = new StackPane(new HBox(regexButton, caseSensitiveButton, fulltextButton));
}
+
modifierButtons.setAlignment(Pos.CENTER);
searchField.setRight(new HBox(searchField.getRight(), modifierButtons));
searchField.getStyleClass().add("global-search-bar");
@@ -221,7 +226,7 @@ public GlobalSearchBar(LibraryTabContainer tabContainer,
// Async update
searchTask.restart();
},
- query -> setSearchTerm(query.orElseGet(() -> new SearchQuery("", EnumSet.noneOf(SearchFlags.class)))));
+ query -> setSearchTerm(query.orElseGet(() -> new SearchQuery(""))));
/*
* The listener tracks a change on the focus property value.
@@ -269,6 +274,24 @@ private void initSearchModifierButtons() {
updateSearchQuery();
});
+ regexButton.setSelected(searchPreferences.isRegularExpression());
+ regexButton.setTooltip(new Tooltip(Localization.lang("Regular expression") + "\n" + Localization.lang("This only affects unfielded terms. For using RegEx in a fielded term, use =~ operator.")));
+ initSearchModifierButton(regexButton);
+ regexButton.setOnAction(event -> {
+ searchPreferences.setSearchFlag(SearchFlags.REGULAR_EXPRESSION, regexButton.isSelected());
+ searchField.requestFocus();
+ updateSearchQuery();
+ });
+
+ caseSensitiveButton.setSelected(searchPreferences.isCaseSensitive());
+ caseSensitiveButton.setTooltip(new Tooltip(Localization.lang("Case sensitive") + "\n" + Localization.lang("This only affects unfielded terms. For using case-sensitive in a fielded term, use =! operator.")));
+ initSearchModifierButton(caseSensitiveButton);
+ caseSensitiveButton.setOnAction(event -> {
+ searchPreferences.setSearchFlag(SearchFlags.CASE_SENSITIVE, caseSensitiveButton.isSelected());
+ searchField.requestFocus();
+ updateSearchQuery();
+ });
+
keepSearchString.setSelected(searchPreferences.shouldKeepSearchString());
keepSearchString.setTooltip(new Tooltip(Localization.lang("Keep search string across libraries")));
initSearchModifierButton(keepSearchString);
@@ -290,7 +313,11 @@ private void initSearchModifierButtons() {
initSearchModifierButton(openGlobalSearchButton);
openGlobalSearchButton.setOnAction(evt -> openGlobalSearchDialog());
- searchPreferences.getObservableSearchFlags().addListener((SetChangeListener.Change change) -> fulltextButton.setSelected(searchPreferences.isFulltext()));
+ searchPreferences.getObservableSearchFlags().addListener((SetChangeListener.Change change) -> {
+ regexButton.setSelected(searchPreferences.isRegularExpression());
+ caseSensitiveButton.setSelected(searchPreferences.isCaseSensitive());
+ fulltextButton.setSelected(searchPreferences.isFulltext());
+ });
}
public void openGlobalSearchDialog() {
@@ -342,25 +369,10 @@ public void updateSearchQuery() {
}
SearchQuery searchQuery = new SearchQuery(this.searchField.getText(), searchPreferences.getSearchFlags());
- if (!searchQuery.isValid()) {
- illegalSearch.set(true);
- return;
- } else {
- illegalSearch.set(false);
- }
+ illegalSearch.set(!searchQuery.isValid());
stateManager.activeSearchQuery(searchType).set(Optional.of(searchQuery));
}
- private boolean validRegex() {
- try {
- Pattern.compile(searchField.getText());
- } catch (PatternSyntaxException e) {
- LOGGER.debug(e.getMessage());
- return false;
- }
- return true;
- }
-
public void setAutoCompleter(SuggestionProvider searchCompleter) {
if (preferences.getAutoCompletePreferences().shouldAutoComplete()) {
AutoCompletionTextInputBinding autoComplete = AutoCompletionTextInputBinding.autoComplete(searchField,
@@ -388,9 +400,9 @@ private AutoCompletePopup getPopup(AutoCompletionBinding autoCompletio
}
}
- public void updateHintVisibility() {
+ public void setSearchBarHint() {
if (preferences.getWorkspacePreferences().shouldShowAdvancedHints()) {
- String genericDescription = Localization.lang("Hint:\n\nTo search all fields for Smith, enter:\nsmith\n\nTo search the field author for Smith and the field title for electrical, enter:\nauthor:Smith AND title:electrical");
+ String genericDescription = Localization.lang("Hint:\n\nTo search all fields for Smith, enter:\nsmith\n\nTo search the field author for Smith and the field title for electrical, enter:\nauthor=Smith AND title=electrical");
List genericDescriptionTexts = TooltipTextUtil.createTextsFromHtml(genericDescription);
TextFlow emptyHintTooltip = new TextFlow();
diff --git a/src/main/java/org/jabref/gui/search/RebuildFulltextSearchIndexAction.java b/src/main/java/org/jabref/gui/search/RebuildFulltextSearchIndexAction.java
index c623edb60e4..1e1ce28a72c 100644
--- a/src/main/java/org/jabref/gui/search/RebuildFulltextSearchIndexAction.java
+++ b/src/main/java/org/jabref/gui/search/RebuildFulltextSearchIndexAction.java
@@ -53,6 +53,6 @@ private void rebuildIndex() {
if (!shouldContinue || stateManager.getActiveDatabase().isEmpty()) {
return;
}
- tabSupplier.get().getLuceneManager().rebuildIndex();
+ tabSupplier.get().getIndexManager().rebuildFullTextIndex();
}
}
diff --git a/src/main/java/org/jabref/gui/search/SearchResultsTableDataModel.java b/src/main/java/org/jabref/gui/search/SearchResultsTableDataModel.java
index b6f7503ccbb..435372a2cb2 100644
--- a/src/main/java/org/jabref/gui/search/SearchResultsTableDataModel.java
+++ b/src/main/java/org/jabref/gui/search/SearchResultsTableDataModel.java
@@ -21,8 +21,8 @@
import org.jabref.logic.util.TaskExecutor;
import org.jabref.model.database.BibDatabaseContext;
import org.jabref.model.entry.BibEntry;
-import org.jabref.model.search.SearchQuery;
-import org.jabref.model.search.SearchResults;
+import org.jabref.model.search.query.SearchQuery;
+import org.jabref.model.search.query.SearchResults;
import com.tobiasdiez.easybind.EasyBind;
@@ -66,18 +66,16 @@ private void updateSearchMatches(Optional query) {
if (query.isPresent()) {
SearchResults searchResults = new SearchResults();
for (BibDatabaseContext context : stateManager.getOpenDatabases()) {
- stateManager.getLuceneManager(context).ifPresent(luceneManager -> {
- searchResults.mergeSearchResults(luceneManager.search(query.get()));
+ stateManager.getIndexManager(context).ifPresent(indexManager -> {
+ searchResults.mergeSearchResults(indexManager.search(query.get()));
});
}
for (BibEntryTableViewModel entry : entriesViewModel) {
- entry.searchScoreProperty().set(searchResults.getSearchScoreForEntry(entry.getEntry()));
entry.hasFullTextResultsProperty().set(searchResults.hasFulltextResults(entry.getEntry()));
- entry.isVisibleBySearch().set(entry.searchScoreProperty().get() > 0);
+ entry.isVisibleBySearch().set(searchResults.isMatched(entry.getEntry()));
}
} else {
for (BibEntryTableViewModel entry : entriesViewModel) {
- entry.searchScoreProperty().set(0);
entry.hasFullTextResultsProperty().set(false);
entry.isVisibleBySearch().set(true);
}
diff --git a/src/main/java/org/jabref/gui/shared/SharedDatabaseUIManager.java b/src/main/java/org/jabref/gui/shared/SharedDatabaseUIManager.java
index c1ecff23cfb..6c70e7653f0 100644
--- a/src/main/java/org/jabref/gui/shared/SharedDatabaseUIManager.java
+++ b/src/main/java/org/jabref/gui/shared/SharedDatabaseUIManager.java
@@ -97,7 +97,7 @@ public void listen(ConnectionLostEvent connectionLostEvent) {
tabContainer.closeTab(tabContainer.getCurrentLibraryTab());
dialogService.showCustomDialogAndWait(new SharedDatabaseLoginDialogView(tabContainer));
} else if (answer.get().equals(workOffline)) {
- connectionLostEvent.getBibDatabaseContext().convertToLocalDatabase();
+ connectionLostEvent.bibDatabaseContext().convertToLocalDatabase();
tabContainer.getLibraryTabs().forEach(tab -> tab.updateTabTitle(tab.isModified()));
dialogService.notify(Localization.lang("Working offline."));
}
@@ -110,8 +110,8 @@ public void listen(ConnectionLostEvent connectionLostEvent) {
public void listen(UpdateRefusedEvent updateRefusedEvent) {
dialogService.notify(Localization.lang("Update refused."));
- BibEntry localBibEntry = updateRefusedEvent.getLocalBibEntry();
- BibEntry sharedBibEntry = updateRefusedEvent.getSharedBibEntry();
+ BibEntry localBibEntry = updateRefusedEvent.localBibEntry();
+ BibEntry sharedBibEntry = updateRefusedEvent.sharedBibEntry();
String message = Localization.lang("Update could not be performed due to existing change conflicts.") + "\r\n" +
Localization.lang("You are not working on the newest version of BibEntry.") + "\r\n" +
@@ -144,9 +144,9 @@ public void listen(SharedEntriesNotPresentEvent event) {
LibraryTab libraryTab = tabContainer.getCurrentLibraryTab();
EntryEditor entryEditor = libraryTab.getEntryEditor();
- libraryTab.getUndoManager().addEdit(new UndoableRemoveEntries(libraryTab.getDatabase(), event.getBibEntries()));
+ libraryTab.getUndoManager().addEdit(new UndoableRemoveEntries(libraryTab.getDatabase(), event.bibEntries()));
- if (entryEditor != null && (event.getBibEntries().contains(entryEditor.getCurrentlyEditedEntry()))) {
+ if (entryEditor != null && (event.bibEntries().contains(entryEditor.getCurrentlyEditedEntry()))) {
dialogService.showInformationDialogAndWait(Localization.lang("Shared entry is no longer present"),
Localization.lang("The entry you currently work on has been deleted on the shared side.")
+ "\n"
diff --git a/src/main/java/org/jabref/gui/util/DragDrop.java b/src/main/java/org/jabref/gui/util/DragDrop.java
new file mode 100644
index 00000000000..26a668d1c26
--- /dev/null
+++ b/src/main/java/org/jabref/gui/util/DragDrop.java
@@ -0,0 +1,35 @@
+package org.jabref.gui.util;
+
+import java.nio.file.Path;
+import java.util.List;
+
+import javafx.scene.input.TransferMode;
+
+import org.jabref.gui.externalfiles.ExternalFilesEntryLinker;
+import org.jabref.model.entry.BibEntry;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class DragDrop {
+ private static final Logger LOGGER = LoggerFactory.getLogger(DragDrop.class);
+
+ public static void handleDropOfFiles(List files, TransferMode transferMode, ExternalFilesEntryLinker fileLinker, BibEntry entry) {
+ // Depending on the pressed modifier, move/copy/link files to drop target
+ // Modifiers do not work on macOS: https://bugs.openjdk.org/browse/JDK-8264172
+ switch (transferMode) {
+ case COPY -> {
+ LOGGER.debug("Mode Copy"); // ctrl on win, no modifier on Xubuntu
+ fileLinker.coveOrMoveFilesSteps(entry, files, false);
+ }
+ case MOVE -> {
+ LOGGER.debug("Mode MOVE"); // shift on win or no modifier
+ fileLinker.coveOrMoveFilesSteps(entry, files, true);
+ }
+ case LINK -> {
+ LOGGER.debug("Node LINK"); // alt on win
+ fileLinker.linkFilesToEntry(entry, files);
+ }
+ }
+ }
+}
diff --git a/src/main/java/org/jabref/logic/bibtex/BibEntryWriter.java b/src/main/java/org/jabref/logic/bibtex/BibEntryWriter.java
index 2d0f63e51dc..1b025046813 100644
--- a/src/main/java/org/jabref/logic/bibtex/BibEntryWriter.java
+++ b/src/main/java/org/jabref/logic/bibtex/BibEntryWriter.java
@@ -4,9 +4,11 @@
import java.io.StringWriter;
import java.util.Collection;
import java.util.Comparator;
+import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
+import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.SortedSet;
@@ -25,6 +27,7 @@
import org.jabref.model.entry.field.InternalField;
import org.jabref.model.entry.field.OrFields;
import org.jabref.model.strings.StringUtil;
+import org.jabref.model.util.Range;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -33,6 +36,7 @@ public class BibEntryWriter {
private static final Logger LOGGER = LoggerFactory.getLogger(BibEntryWriter.class);
+ private final Map fieldPositions = new HashMap<>();
private final BibEntryTypesManager entryTypesManager;
private final FieldWriter fieldWriter;
@@ -90,10 +94,7 @@ private void writeUserComments(BibEntry entry, BibWriter out) throws IOException
*/
private void writeRequiredFieldsFirstRemainingFieldsSecond(BibEntry entry, BibWriter out,
BibDatabaseMode bibDatabaseMode) throws IOException {
- // Write header with type and bibtex-key
- TypedBibEntry typedEntry = new TypedBibEntry(entry, bibDatabaseMode);
- out.write('@' + typedEntry.getTypeForDisplay() + '{');
-
+ writeEntryType(entry, out, bibDatabaseMode);
writeKeyField(entry, out);
Set written = new HashSet<>();
@@ -141,9 +142,22 @@ private void writeRequiredFieldsFirstRemainingFieldsSecond(BibEntry entry, BibWr
out.writeLine("}");
}
+ private void writeEntryType(BibEntry entry, BibWriter out, BibDatabaseMode bibDatabaseMode) throws IOException {
+ int start = out.getCurrentPosition();
+ TypedBibEntry typedEntry = new TypedBibEntry(entry, bibDatabaseMode);
+ out.write('@' + typedEntry.getTypeForDisplay());
+ int end = out.getCurrentPosition();
+ fieldPositions.put(InternalField.TYPE_HEADER, new Range(start, end));
+ out.write("{");
+ }
+
private void writeKeyField(BibEntry entry, BibWriter out) throws IOException {
+ int start = out.getCurrentPosition();
String keyField = StringUtil.shaveString(entry.getCitationKey().orElse(""));
- out.writeLine(keyField + ',');
+ out.write(keyField);
+ int end = out.getCurrentPosition();
+ fieldPositions.put(InternalField.KEY_FIELD, new Range(start, end));
+ out.writeLine(",");
}
/**
@@ -162,9 +176,12 @@ private void writeField(BibEntry entry, BibWriter out, Field field, int indent)
out.write(" ");
out.write(getFormattedFieldName(field, indent));
try {
+ int start = out.getCurrentPosition();
out.write(fieldWriter.write(field, value.get()));
+ int end = out.getCurrentPosition();
+ fieldPositions.put(field, new Range(start, end));
} catch (InvalidFieldValueException ex) {
- LOGGER.warn("Invalid field value {} of field {} of entry {]", value.get(), field, entry.getCitationKey().orElse(""), ex);
+ LOGGER.warn("Invalid field value {} of field {} of entry {}", value.get(), field, entry.getCitationKey().orElse(""), ex);
throw new IOException("Error in field '" + field + " of entry " + entry.getCitationKey().orElse("") + "': " + ex.getMessage(), ex);
}
out.writeLine(",");
@@ -197,4 +214,8 @@ static String getFormattedFieldName(Field field, int indent) {
String fieldName = field.getName();
return fieldName.toLowerCase(Locale.ROOT) + StringUtil.repeatSpaces(indent - fieldName.length()) + " = ";
}
+
+ public Map getFieldPositions() {
+ return fieldPositions;
+ }
}
diff --git a/src/main/java/org/jabref/logic/bibtex/FieldWriter.java b/src/main/java/org/jabref/logic/bibtex/FieldWriter.java
index 1a6702242eb..b069b307fe5 100644
--- a/src/main/java/org/jabref/logic/bibtex/FieldWriter.java
+++ b/src/main/java/org/jabref/logic/bibtex/FieldWriter.java
@@ -85,10 +85,10 @@ public String write(Field field, String content) throws InvalidFieldValueExcepti
}
if (!shouldResolveStrings(field) || field.equals(InternalField.BIBTEX_STRING)) {
- return formatWithoutResolvingStrings(content, field);
+ return formatWithoutResolvingStrings(content);
}
- return formatAndResolveStrings(content, field);
+ return formatAndResolveStrings(content);
}
/**
@@ -96,7 +96,7 @@ public String write(Field field, String content) throws InvalidFieldValueExcepti
*
* For instance, #jan# - #feb# gets jan #{ - } # feb (see @link{org.jabref.logic.bibtex.LatexFieldFormatterTests#makeHashEnclosedWordsRealStringsInMonthField()})
*/
- private String formatAndResolveStrings(String content, Field field) throws InvalidFieldValueException {
+ private String formatAndResolveStrings(String content) throws InvalidFieldValueException {
checkBraces(content);
content = content.replace("##", "");
@@ -123,7 +123,7 @@ private String formatAndResolveStrings(String content, Field field) throws Inval
if (neverFailOnHashes) {
pos1 = content.length(); // just write out the rest of the text, and throw no exception
} else {
- LOGGER.error("The character {} is not allowed in BibTeX strings unless escaped as in '\\{}'. "
+ LOGGER.error("The character {} is not allowed in BibTeX strings unless escaped as in '\\\\{}'. "
+ "In JabRef, use pairs of # characters to indicate a string. "
+ "Note that the entry causing the problem has been selected. Field value: {}",
BIBTEX_STRING_START_END_SYMBOL,
@@ -183,12 +183,9 @@ private boolean shouldResolveStrings(Field field) {
return false;
}
- private String formatWithoutResolvingStrings(String content, Field field) throws InvalidFieldValueException {
+ private String formatWithoutResolvingStrings(String content) throws InvalidFieldValueException {
checkBraces(content);
- StringBuilder stringBuilder = new StringBuilder(String.valueOf(FIELD_START));
- stringBuilder.append(content);
- stringBuilder.append(FIELD_END);
- return stringBuilder.toString();
+ return FIELD_START + content + FIELD_END;
}
/**
diff --git a/src/main/java/org/jabref/logic/bibtex/InvalidFieldValueException.java b/src/main/java/org/jabref/logic/bibtex/InvalidFieldValueException.java
index 6ee28e171d5..98e33f90b7f 100644
--- a/src/main/java/org/jabref/logic/bibtex/InvalidFieldValueException.java
+++ b/src/main/java/org/jabref/logic/bibtex/InvalidFieldValueException.java
@@ -1,7 +1,9 @@
package org.jabref.logic.bibtex;
/**
- * @deprecated implement as {@link org.jabref.logic.integrity.IntegrityCheck} instead.
+ * @deprecated Use only if you know what you are doing.
+ * Otherwise, you should implement your functionality as {@link org.jabref.logic.integrity.IntegrityCheck} instead.
+ * The JabRef team leaves the @deprecated annotation to have IntelliJ listing this method with a strike-through.
*/
@Deprecated
public class InvalidFieldValueException extends Exception {
diff --git a/src/main/java/org/jabref/logic/cleanup/DoiCleanup.java b/src/main/java/org/jabref/logic/cleanup/DoiCleanup.java
index 1cb3f2d04e3..2e565cf9710 100644
--- a/src/main/java/org/jabref/logic/cleanup/DoiCleanup.java
+++ b/src/main/java/org/jabref/logic/cleanup/DoiCleanup.java
@@ -42,7 +42,7 @@ public List cleanup(BibEntry entry) {
Optional doi = DOI.parse(doiFieldValue);
if (doi.isPresent()) {
- String newValue = doi.get().getDOI();
+ String newValue = doi.get().asString();
if (!doiFieldValue.equals(newValue)) {
entry.setField(StandardField.DOI, newValue);
@@ -65,7 +65,7 @@ public List cleanup(BibEntry entry) {
if (doi.isPresent()) {
// Update Doi
- Optional change = entry.setField(StandardField.DOI, doi.get().getDOI());
+ Optional change = entry.setField(StandardField.DOI, doi.get().asString());
change.ifPresent(changes::add);
removeFieldValue(entry, field, changes);
}
@@ -74,7 +74,7 @@ public List cleanup(BibEntry entry) {
fieldContentOpt.flatMap(ArXivIdentifier::parse)
.flatMap(ArXivIdentifier::inferDOI)
.ifPresent(inferredDoi -> {
- Optional change = entry.setField(StandardField.DOI, inferredDoi.getDOI());
+ Optional change = entry.setField(StandardField.DOI, inferredDoi.asString());
change.ifPresent(changes::add);
});
}
diff --git a/src/main/java/org/jabref/logic/cleanup/EprintCleanup.java b/src/main/java/org/jabref/logic/cleanup/EprintCleanup.java
index abc56b9db6a..4d1fb957f70 100644
--- a/src/main/java/org/jabref/logic/cleanup/EprintCleanup.java
+++ b/src/main/java/org/jabref/logic/cleanup/EprintCleanup.java
@@ -29,7 +29,7 @@ public List cleanup(BibEntry entry) {
Optional arXivIdentifier = entry.getField(field).flatMap(ArXivIdentifier::parse);
if (arXivIdentifier.isPresent()) {
- String normalizedEprint = arXivIdentifier.get().getNormalized();
+ String normalizedEprint = arXivIdentifier.get().asString();
if (version.isPresent() && !normalizedEprint.contains("v" + version.get())) {
normalizedEprint += "v" + version.get();
diff --git a/src/main/java/org/jabref/logic/cleanup/MoveFilesCleanup.java b/src/main/java/org/jabref/logic/cleanup/MoveFilesCleanup.java
index c05a5c1a807..c55fb8a090d 100644
--- a/src/main/java/org/jabref/logic/cleanup/MoveFilesCleanup.java
+++ b/src/main/java/org/jabref/logic/cleanup/MoveFilesCleanup.java
@@ -17,6 +17,9 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * Moves the file into the default file directory. Does not rename the file.
+ */
public class MoveFilesCleanup implements CleanupJob {
private static final Logger LOGGER = LoggerFactory.getLogger(MoveFilesCleanup.class);
@@ -37,10 +40,7 @@ public List cleanup(BibEntry entry) {
for (LinkedFile file : files) {
LinkedFileHandler fileHandler = new LinkedFileHandler(file, entry, databaseContext, filePreferences);
try {
- boolean fileChanged = fileHandler.moveToDefaultDirectory();
- if (fileChanged) {
- changed = true;
- }
+ changed = fileHandler.moveToDefaultDirectory() || changed;
} catch (IOException exception) {
LOGGER.error("Error while moving file {}", file.getLink(), exception);
}
diff --git a/src/main/java/org/jabref/logic/exporter/BibWriter.java b/src/main/java/org/jabref/logic/exporter/BibWriter.java
index f6931653542..86422e9adf4 100644
--- a/src/main/java/org/jabref/logic/exporter/BibWriter.java
+++ b/src/main/java/org/jabref/logic/exporter/BibWriter.java
@@ -16,6 +16,7 @@ public class BibWriter {
private boolean precedingNewLineRequired = false;
private boolean somethingWasWritten = false;
private boolean lastWriteWasNewline = false;
+ private int currentPosition = 0;
/**
* @param newLineSeparator the string used for a line break
@@ -35,6 +36,7 @@ public void write(String string) throws IOException {
}
string = StringUtil.unifyLineBreaks(string, newLineSeparator);
writer.write(string);
+ currentPosition += string.length();
lastWriteWasNewline = string.endsWith(newLineSeparator);
somethingWasWritten = true;
}
@@ -69,4 +71,8 @@ public void finishBlock() throws IOException {
this.somethingWasWritten = false;
this.precedingNewLineRequired = true;
}
+
+ public int getCurrentPosition() {
+ return currentPosition;
+ }
}
diff --git a/src/main/java/org/jabref/logic/externalfiles/LinkedFileHandler.java b/src/main/java/org/jabref/logic/externalfiles/LinkedFileHandler.java
index eebfe864e75..caf712b51b4 100644
--- a/src/main/java/org/jabref/logic/externalfiles/LinkedFileHandler.java
+++ b/src/main/java/org/jabref/logic/externalfiles/LinkedFileHandler.java
@@ -25,29 +25,39 @@ public class LinkedFileHandler {
private final FilePreferences filePreferences;
private final BibEntry entry;
- private final LinkedFile fileEntry;
+ private final LinkedFile linkedFile;
- public LinkedFileHandler(LinkedFile fileEntry,
+ public LinkedFileHandler(LinkedFile linkedFile,
BibEntry entry,
BibDatabaseContext databaseContext,
FilePreferences filePreferences) {
- this.fileEntry = fileEntry;
+ this.linkedFile = linkedFile;
this.entry = entry;
this.databaseContext = Objects.requireNonNull(databaseContext);
this.filePreferences = Objects.requireNonNull(filePreferences);
}
public boolean moveToDefaultDirectory() throws IOException {
- Optional targetDirectory = databaseContext.getFirstExistingFileDir(filePreferences);
- if (targetDirectory.isEmpty()) {
+ return copyOrMoveToDefaultDirectory(true, false);
+ }
+
+ /**
+ * @return true if the file was copied/moved or the same file exists in the target directory
+ */
+ public boolean copyOrMoveToDefaultDirectory(boolean shouldMove, boolean shouldRenameToFilenamePattern) throws IOException {
+ Optional databaseFileDirectoryOpt = databaseContext.getFirstExistingFileDir(filePreferences);
+ if (databaseFileDirectoryOpt.isEmpty()) {
+ LOGGER.warn("No existing file directory found");
return false;
}
+ Path databaseFileDirectory = databaseFileDirectoryOpt.get();
- Optional oldFile = fileEntry.findIn(databaseContext, filePreferences);
- if (oldFile.isEmpty()) {
- // Could not find file
+ Optional sourcePathOpt = linkedFile.findIn(databaseContext, filePreferences);
+ if (sourcePathOpt.isEmpty()) {
+ LOGGER.warn("Could not find file {}", linkedFile.getLink());
return false;
}
+ Path sourcePath = sourcePathOpt.get();
String targetDirectoryName = "";
if (!filePreferences.getFileDirectoryPattern().isEmpty()) {
@@ -57,30 +67,95 @@ public boolean moveToDefaultDirectory() throws IOException {
filePreferences.getFileDirectoryPattern());
}
- Path targetPath = targetDirectory.get().resolve(targetDirectoryName).resolve(oldFile.get().getFileName());
- if (Files.exists(targetPath)) {
- // We do not overwrite already existing files
- LOGGER.debug("The file {} would have been moved to {}. However, there exists already a file with that name so we do nothing.", oldFile.get(), targetPath);
- return false;
- } else {
- // Make sure sub-directories exist
- Files.createDirectories(targetPath.getParent());
+ Path targetDirectory = databaseFileDirectory.resolve(targetDirectoryName);
+ // Ensure that this directory exists
+ Files.createDirectories(targetDirectory);
+
+ GetTargetPathResult getTargetPathResult = null;
+ if (shouldRenameToFilenamePattern) {
+ getTargetPathResult = getTargetPath(sourcePath, targetDirectory, true);
+ if (getTargetPathResult.exists) {
+ if (shouldMove && !Files.isSameFile(sourcePath, getTargetPathResult.path)) {
+ Files.delete(sourcePath);
+ }
+ linkedFile.setLink(FileUtil.relativize(getTargetPathResult.path(), databaseContext, filePreferences).toString());
+ return true;
+ }
+ }
+ if (!shouldRenameToFilenamePattern || (getTargetPathResult.renamed && !entry.getFiles().isEmpty())) {
+ // Either we do not rename to pattern - or UX feature:
+ // UX feature: If user adds a file to the entry and JabRef could only add it when renaming to the suggested pattern,
+ // JabRef should keep the original file name
+ getTargetPathResult = getTargetPath(sourcePath, targetDirectory, false);
+ if (getTargetPathResult.exists) {
+ if (shouldMove && !Files.isSameFile(sourcePath, getTargetPathResult.path)) {
+ Files.delete(sourcePath);
+ }
+ linkedFile.setLink(FileUtil.relativize(getTargetPathResult.path(), databaseContext, filePreferences).toString());
+ return true;
+ }
}
- // Move
- Files.move(oldFile.get(), targetPath);
+ assert !Files.exists(getTargetPathResult.path);
+ if (shouldMove) {
+ Files.move(sourcePath, getTargetPathResult.path);
+ } else {
+ Files.copy(sourcePath, getTargetPathResult.path);
+ }
+ assert Files.exists(getTargetPathResult.path);
- // Update path
- fileEntry.setLink(FileUtil.relativize(targetPath, databaseContext, filePreferences).toString());
+ linkedFile.setLink(FileUtil.relativize(getTargetPathResult.path, databaseContext, filePreferences).toString());
return true;
}
+ /**
+ * If exists: the path already exists and has the same content as the given sourcePath
+ *
+ * @param renamed The original/suggested filename was adapted to fit it
+ */
+ private record GetTargetPathResult(boolean exists, boolean renamed, Path path) {
+ }
+
+ private GetTargetPathResult getTargetPath(Path sourcePath, Path targetDirectory, boolean useSuggestedName) throws IOException {
+ Path suggestedFileName;
+ if (useSuggestedName) {
+ suggestedFileName = Path.of(getSuggestedFileName(FileUtil.getFileExtension(sourcePath).orElse("")));
+ } else {
+ suggestedFileName = sourcePath.getFileName();
+ }
+
+ Path targetPath = targetDirectory.resolve(suggestedFileName);
+ boolean renamed = false;
+ if (Files.exists(targetPath)) {
+ if (Files.mismatch(sourcePath, targetPath) == -1) {
+ // In case of source == target, we pretend, we have success
+ LOGGER.debug("The file {} would have been copied/moved to {}. However, there exists already a file with that name so we do nothing.", sourcePath, targetPath);
+ return new GetTargetPathResult(true, false, targetPath);
+ }
+ Integer count = 1;
+ boolean exists = false;
+ do {
+ targetPath = targetDirectory.resolve(sourcePath.getFileName() + " (" + count + ")");
+ exists = Files.exists(targetPath);
+ if (exists && Files.mismatch(sourcePath, targetPath) == -1) {
+ // In case of source == target, we pretend, we have success
+ LOGGER.debug("The file {} would have been copied/moved to {}. However, there exists already a file with that name so we do nothing.", sourcePath, targetPath);
+ return new GetTargetPathResult(true, true, targetPath);
+ }
+ count++;
+ } while (exists);
+ LOGGER.debug("The file {} existed in the target path somehow (but with different content). Chose new name {}.", sourcePath, targetPath);
+ renamed = true;
+ }
+ return new GetTargetPathResult(false, renamed, targetPath);
+ }
+
public boolean renameToSuggestedName() throws IOException {
return renameToName(getSuggestedFileName(), false);
}
public boolean renameToName(String targetFileName, boolean overwriteExistingFile) throws IOException {
- Optional oldFile = fileEntry.findIn(databaseContext, filePreferences);
+ Optional oldFile = linkedFile.findIn(databaseContext, filePreferences);
if (oldFile.isEmpty()) {
return false;
}
@@ -118,24 +193,27 @@ public boolean renameToName(String targetFileName, boolean overwriteExistingFile
}
// Update path
- fileEntry.setLink(FileUtil.relativize(newPath, databaseContext, filePreferences).toString());
+ linkedFile.setLink(FileUtil.relativize(newPath, databaseContext, filePreferences).toString());
return true;
}
public String getSuggestedFileName() {
- String oldFileName = fileEntry.getLink();
+ String oldFileName = linkedFile.getLink();
- String extension = FileUtil.getFileExtension(oldFileName).orElse(fileEntry.getFileType());
+ String extension = FileUtil.getFileExtension(oldFileName).orElse(linkedFile.getFileType());
return getSuggestedFileName(extension);
}
+ /**
+ * @param extension The extension of the file. If empty, no extension is added.
+ * @return A filename based on the pattern specified in the preferences and valid for the file system.
+ */
public String getSuggestedFileName(String extension) {
- String targetFileName = FileUtil.createFileNameFromPattern(databaseContext.getDatabase(), entry, filePreferences.getFileNamePattern()).trim()
- + '.'
- + extension;
-
- // Only create valid file names
+ String targetFileName = FileUtil.createFileNameFromPattern(databaseContext.getDatabase(), entry, filePreferences.getFileNamePattern()).trim();
+ if (!extension.isEmpty()) {
+ targetFileName = targetFileName + '.' + extension;
+ }
return FileUtil.getValidFileName(targetFileName);
}
diff --git a/src/main/java/org/jabref/logic/formatter/bibtexfields/ShortenDOIFormatter.java b/src/main/java/org/jabref/logic/formatter/bibtexfields/ShortenDOIFormatter.java
index 56ee1af1c0f..b0e59354f2b 100644
--- a/src/main/java/org/jabref/logic/formatter/bibtexfields/ShortenDOIFormatter.java
+++ b/src/main/java/org/jabref/logic/formatter/bibtexfields/ShortenDOIFormatter.java
@@ -34,7 +34,7 @@ public String format(String value) {
return SHORT_DOI_FORMAT.test(value) ? value : DOI.parse(value)
.map(doi -> {
try {
- return new ShortDOIService().getShortDOI(doi).getDOI();
+ return new ShortDOIService().getShortDOI(doi).asString();
} catch (ShortDOIServiceException e) {
LOGGER.error(e.getMessage(), e);
return value;
diff --git a/src/main/java/org/jabref/logic/importer/CompositeIdFetcher.java b/src/main/java/org/jabref/logic/importer/CompositeIdFetcher.java
index 83d939a3085..5a8f881b8ea 100644
--- a/src/main/java/org/jabref/logic/importer/CompositeIdFetcher.java
+++ b/src/main/java/org/jabref/logic/importer/CompositeIdFetcher.java
@@ -5,11 +5,14 @@
import org.jabref.logic.importer.fetcher.ArXivFetcher;
import org.jabref.logic.importer.fetcher.DoiFetcher;
+import org.jabref.logic.importer.fetcher.RfcFetcher;
import org.jabref.logic.importer.fetcher.isbntobibtex.IsbnFetcher;
import org.jabref.model.entry.BibEntry;
import org.jabref.model.entry.identifier.ArXivIdentifier;
import org.jabref.model.entry.identifier.DOI;
import org.jabref.model.entry.identifier.ISBN;
+import org.jabref.model.entry.identifier.RFC;
+import org.jabref.model.entry.identifier.SSRN;
public class CompositeIdFetcher {
@@ -20,20 +23,22 @@ public CompositeIdFetcher(ImportFormatPreferences importFormatPreferences) {
}
public Optional performSearchById(String identifier) throws FetcherException {
+ // All identifiers listed here should also be appear at {@link org.jabref.gui.mergeentries.FetchAndMergeEntry.SUPPORTED_FIELDS} and vice versa.
+
Optional doi = DOI.findInText(identifier);
if (doi.isPresent()) {
- return new DoiFetcher(importFormatPreferences).performSearchById(doi.get().getNormalized());
+ return new DoiFetcher(importFormatPreferences).performSearchById(doi.get().asString());
}
Optional arXivIdentifier = ArXivIdentifier.parse(identifier);
if (arXivIdentifier.isPresent()) {
- return new ArXivFetcher(importFormatPreferences).performSearchById(arXivIdentifier.get().getNormalized());
+ return new ArXivFetcher(importFormatPreferences).performSearchById(arXivIdentifier.get().asString());
}
Optional isbn = ISBN.parse(identifier);
if (isbn.isPresent()) {
return new IsbnFetcher(importFormatPreferences)
// .addRetryFetcher(new EbookDeIsbnFetcher(importFormatPreferences))
// .addRetryFetcher(new DoiToBibtexConverterComIsbnFetcher(importFormatPreferences))
- .performSearchById(isbn.get().getNormalized());
+ .performSearchById(isbn.get().asString());
}
/* TODO: IACR is currently disabled, because it needs to be reworked: https://github.com/JabRef/jabref/issues/8876
Optional iacrEprint = IacrEprint.parse(identifier);
@@ -41,6 +46,16 @@ public Optional performSearchById(String identifier) throws FetcherExc
return new IacrEprintFetcher(importFormatPreferences).performSearchById(iacrEprint.get().getNormalized());
}*/
+ Optional ssrn = SSRN.parse(identifier);
+ if (ssrn.isPresent()) {
+ return new DoiFetcher(importFormatPreferences).performSearchById(ssrn.get().toDoi().asString());
+ }
+
+ Optional rfcId = RFC.parse(identifier);
+ if (rfcId.isPresent()) {
+ return new RfcFetcher(importFormatPreferences).performSearchById(rfcId.get().asString());
+ }
+
return Optional.empty();
}
@@ -52,7 +67,9 @@ public static boolean containsValidId(String identifier) {
Optional doi = DOI.findInText(identifier);
Optional arXivIdentifier = ArXivIdentifier.parse(identifier);
Optional isbn = ISBN.parse(identifier);
+ Optional ssrn = SSRN.parse(identifier);
+ Optional rfcId = RFC.parse(identifier);
- return Stream.of(doi, arXivIdentifier, isbn).anyMatch(Optional::isPresent);
+ return Stream.of(doi, arXivIdentifier, isbn, ssrn, rfcId).anyMatch(Optional::isPresent);
}
}
diff --git a/src/main/java/org/jabref/logic/importer/FulltextFetchers.java b/src/main/java/org/jabref/logic/importer/FulltextFetchers.java
index 2b8a86dd842..313f6447d77 100644
--- a/src/main/java/org/jabref/logic/importer/FulltextFetchers.java
+++ b/src/main/java/org/jabref/logic/importer/FulltextFetchers.java
@@ -79,7 +79,7 @@ private void findDoiForEntry(BibEntry clonedEntry) {
try {
WebFetchers.getIdFetcherForIdentifier(DOI.class)
.findIdentifier(clonedEntry)
- .ifPresent(e -> clonedEntry.setField(StandardField.DOI, e.getDOI()));
+ .ifPresent(e -> clonedEntry.setField(StandardField.DOI, e.asString()));
} catch (FetcherException e) {
LOGGER.debug("Failed to find DOI", e);
}
diff --git a/src/main/java/org/jabref/logic/importer/fetcher/ACS.java b/src/main/java/org/jabref/logic/importer/fetcher/ACS.java
index 11cf1fd9ca3..964ad8f38f3 100644
--- a/src/main/java/org/jabref/logic/importer/fetcher/ACS.java
+++ b/src/main/java/org/jabref/logic/importer/fetcher/ACS.java
@@ -38,7 +38,7 @@ public Optional findFullText(BibEntry entry) throws IOException {
return Optional.empty();
}
- String source = SOURCE.formatted(doi.get().getDOI());
+ String source = SOURCE.formatted(doi.get().asString());
// Retrieve PDF link
Document html = Jsoup.connect(source).ignoreHttpErrors(true).get();
Element link = html.select("a.button_primary").first();
diff --git a/src/main/java/org/jabref/logic/importer/fetcher/ApsFetcher.java b/src/main/java/org/jabref/logic/importer/fetcher/ApsFetcher.java
index 88de237ab9b..64ca0c70c1b 100644
--- a/src/main/java/org/jabref/logic/importer/fetcher/ApsFetcher.java
+++ b/src/main/java/org/jabref/logic/importer/fetcher/ApsFetcher.java
@@ -39,7 +39,7 @@ public Optional findFullText(BibEntry entry) throws IOException {
return Optional.empty();
}
- Optional id = getId(doi.get().getDOI());
+ Optional id = getId(doi.get().asString());
if (id.isPresent()) {
String pdfRequestUrl = PDF_URL + id.get();
diff --git a/src/main/java/org/jabref/logic/importer/fetcher/ArXivFetcher.java b/src/main/java/org/jabref/logic/importer/fetcher/ArXivFetcher.java
index 5607f681dd4..e7b72137944 100644
--- a/src/main/java/org/jabref/logic/importer/fetcher/ArXivFetcher.java
+++ b/src/main/java/org/jabref/logic/importer/fetcher/ArXivFetcher.java
@@ -200,7 +200,7 @@ private static Optional getAutomaticDoi(BibEntry arXivBibEntry) {
* @return ArXiv-issued DOI
*/
private static String getAutomaticDoi(ArXivIdentifier arXivId) {
- return getAutomaticDoi(arXivId.getNormalizedWithoutVersion());
+ return getAutomaticDoi(arXivId.asStringWithoutVersion());
}
/**
@@ -473,7 +473,7 @@ private List searchForEntries(BibEntry originalEntry) throws Fetcher
String query;
Optional doiString = entry.getField(StandardField.DOI)
.flatMap(DOI::parse)
- .map(DOI::getNormalized);
+ .map(DOI::asString);
// ArXiv-issued DOIs seem to be unsearchable from ArXiv API's "query string", so ignore it
if (doiString.isPresent() && ArXivFetcher.isManualDoi(doiString.get())) {
@@ -543,7 +543,7 @@ private Document callApi(String searchQuery, List ids, int star
}
if (!ids.isEmpty()) {
uriBuilder.addParameter("id_list",
- ids.stream().map(ArXivIdentifier::getNormalized).collect(Collectors.joining(",")));
+ ids.stream().map(ArXivIdentifier::asString).collect(Collectors.joining(",")));
}
uriBuilder.addParameter("start", String.valueOf(start));
uriBuilder.addParameter("max_results", String.valueOf(maxResults));
@@ -748,7 +748,7 @@ public Optional getPdfUrl() {
* Returns the arXiv identifier
*/
public Optional getIdString() {
- return urlAbstractPage.flatMap(ArXivIdentifier::parse).map(ArXivIdentifier::getNormalizedWithoutVersion);
+ return urlAbstractPage.flatMap(ArXivIdentifier::parse).map(ArXivIdentifier::asStringWithoutVersion);
}
public Optional getId() {
diff --git a/src/main/java/org/jabref/logic/importer/fetcher/DoiFetcher.java b/src/main/java/org/jabref/logic/importer/fetcher/DoiFetcher.java
index 2647b73a70f..19f01d025a0 100644
--- a/src/main/java/org/jabref/logic/importer/fetcher/DoiFetcher.java
+++ b/src/main/java/org/jabref/logic/importer/fetcher/DoiFetcher.java
@@ -219,7 +219,7 @@ public List performSearch(BibEntry entry) throws FetcherException {
public Optional getAgency(DOI doi) throws FetcherException, MalformedURLException {
Optional agency = Optional.empty();
try {
- URLDownload download = getUrlDownload(URI.create(DOI.AGENCY_RESOLVER + "/" + doi.getDOI()).toURL());
+ URLDownload download = getUrlDownload(URI.create(DOI.AGENCY_RESOLVER + "/" + doi.asString()).toURL());
JSONObject response = new JSONArray(download.asString()).getJSONObject(0);
if (response != null) {
agency = Optional.ofNullable(response.optString("RA"));
diff --git a/src/main/java/org/jabref/logic/importer/fetcher/IEEE.java b/src/main/java/org/jabref/logic/importer/fetcher/IEEE.java
index fc09fd9fd4d..cfbf973162a 100644
--- a/src/main/java/org/jabref/logic/importer/fetcher/IEEE.java
+++ b/src/main/java/org/jabref/logic/importer/fetcher/IEEE.java
@@ -158,7 +158,7 @@ public Optional findFullText(BibEntry entry) throws FetcherException {
// If not, try DOI
if (stampString.isEmpty()) {
Optional doi = entry.getField(StandardField.DOI).flatMap(DOI::parse);
- if (doi.isPresent() && doi.get().getDOI().startsWith(IEEE_DOI) && doi.get().getExternalURI().isPresent()) {
+ if (doi.isPresent() && doi.get().asString().startsWith(IEEE_DOI) && doi.get().getExternalURI().isPresent()) {
// Download the HTML page from IEEE
URLDownload urlDownload = null;
try {
diff --git a/src/main/java/org/jabref/logic/importer/fetcher/MathSciNet.java b/src/main/java/org/jabref/logic/importer/fetcher/MathSciNet.java
index 2a8662f1095..9ed293c9378 100644
--- a/src/main/java/org/jabref/logic/importer/fetcher/MathSciNet.java
+++ b/src/main/java/org/jabref/logic/importer/fetcher/MathSciNet.java
@@ -183,7 +183,7 @@ private BibEntry jsonItemToBibEntry(JSONObject item) throws ParseException {
String doi = item.optString("articleUrl");
if (!doi.isEmpty()) {
try {
- DOI.parse(doi).ifPresent(validDoi -> entry.setField(StandardField.DOI, validDoi.getNormalized()));
+ DOI.parse(doi).ifPresent(validDoi -> entry.setField(StandardField.DOI, validDoi.asString()));
} catch (IllegalArgumentException e) {
// If DOI parsing fails, use the original DOI string
entry.setField(StandardField.DOI, doi);
diff --git a/src/main/java/org/jabref/logic/importer/fetcher/OpenAccessDoi.java b/src/main/java/org/jabref/logic/importer/fetcher/OpenAccessDoi.java
index 9e12625e4fd..05d247b6032 100644
--- a/src/main/java/org/jabref/logic/importer/fetcher/OpenAccessDoi.java
+++ b/src/main/java/org/jabref/logic/importer/fetcher/OpenAccessDoi.java
@@ -53,7 +53,7 @@ public TrustLevel getTrustLevel() {
}
public Optional findFullText(DOI doi) throws UnirestException {
- HttpResponse request = Unirest.get(API_URL + doi.getDOI() + "?email=developers@jabref.org")
+ HttpResponse request = Unirest.get(API_URL + doi.asString() + "?email=developers@jabref.org")
.header("accept", "application/json")
.asJson();
diff --git a/src/main/java/org/jabref/logic/importer/fetcher/ResearchGate.java b/src/main/java/org/jabref/logic/importer/fetcher/ResearchGate.java
index 6e4f3269fdd..1691bff0ebe 100644
--- a/src/main/java/org/jabref/logic/importer/fetcher/ResearchGate.java
+++ b/src/main/java/org/jabref/logic/importer/fetcher/ResearchGate.java
@@ -152,9 +152,9 @@ Optional getURLByDoi(DOI doi) throws IOException, NullPointerException {
try {
URIBuilder source = new URIBuilder(SEARCH);
source.addParameter("type", "publication");
- source.addParameter("query", doi.getDOI());
+ source.addParameter("query", doi.asString());
- source = new URIBuilder(GOOGLE_SEARCH + doi.getDOI() + GOOGLE_SITE);
+ source = new URIBuilder(GOOGLE_SEARCH + doi.asString() + GOOGLE_SITE);
Connection connection = Jsoup.connect(source.toString());
Document html = connection
.cookieStore(connection.cookieStore())
diff --git a/src/main/java/org/jabref/logic/importer/fetcher/ScienceDirect.java b/src/main/java/org/jabref/logic/importer/fetcher/ScienceDirect.java
index cf64ae0f92e..f2559d2f0ec 100644
--- a/src/main/java/org/jabref/logic/importer/fetcher/ScienceDirect.java
+++ b/src/main/java/org/jabref/logic/importer/fetcher/ScienceDirect.java
@@ -56,7 +56,7 @@ public Optional findFullText(BibEntry entry) throws IOException {
return Optional.empty();
}
- String urlFromDoi = getUrlByDoi(doi.get().getDOI());
+ String urlFromDoi = getUrlByDoi(doi.get().asString());
if (urlFromDoi.isEmpty()) {
return Optional.empty();
}
diff --git a/src/main/java/org/jabref/logic/importer/fetcher/SemanticScholar.java b/src/main/java/org/jabref/logic/importer/fetcher/SemanticScholar.java
index 1a03c17c55e..45aa343a333 100644
--- a/src/main/java/org/jabref/logic/importer/fetcher/SemanticScholar.java
+++ b/src/main/java/org/jabref/logic/importer/fetcher/SemanticScholar.java
@@ -73,7 +73,7 @@ public Optional findFullText(BibEntry entry) throws IOException, FetcherExc
if (doi.isPresent()) {
try {
// Retrieve PDF link
- String source = SOURCE_ID_SEARCH + doi.get().getDOI();
+ String source = SOURCE_ID_SEARCH + doi.get().asString();
var jsoupRequest = Jsoup.connect(getURLBySource(source))
.userAgent(URLDownload.USER_AGENT)
.header("Accept", "text/html; charset=utf-8")
diff --git a/src/main/java/org/jabref/logic/importer/fetcher/SpringerLink.java b/src/main/java/org/jabref/logic/importer/fetcher/SpringerLink.java
index 25a23c7b7ae..b5115601528 100644
--- a/src/main/java/org/jabref/logic/importer/fetcher/SpringerLink.java
+++ b/src/main/java/org/jabref/logic/importer/fetcher/SpringerLink.java
@@ -54,7 +54,7 @@ public Optional findFullText(BibEntry entry) throws IOException {
try {
HttpResponse jsonResponse = Unirest.get(API_URL)
.queryString("api_key", importerPreferences.getApiKey(getName()).orElse(""))
- .queryString("q", "doi:%s".formatted(doi.get().getDOI()))
+ .queryString("q", "doi:%s".formatted(doi.get().asString()))
.asJson();
if (jsonResponse.getBody() != null) {
JSONObject json = jsonResponse.getBody().getObject();
@@ -62,7 +62,7 @@ public Optional findFullText(BibEntry entry) throws IOException {
if (results > 0) {
LOGGER.info("Fulltext PDF found @ Springer.");
- return Optional.of(new URI("http", null, CONTENT_HOST, -1, "/content/pdf/%s.pdf".formatted(doi.get().getDOI()), null, null).toURL());
+ return Optional.of(new URI("http", null, CONTENT_HOST, -1, "/content/pdf/%s.pdf".formatted(doi.get().asString()), null, null).toURL());
}
}
} catch (UnirestException | URISyntaxException e) {
diff --git a/src/main/java/org/jabref/logic/importer/fetcher/TitleFetcher.java b/src/main/java/org/jabref/logic/importer/fetcher/TitleFetcher.java
index ce10b69b6da..b5c654b44d6 100644
--- a/src/main/java/org/jabref/logic/importer/fetcher/TitleFetcher.java
+++ b/src/main/java/org/jabref/logic/importer/fetcher/TitleFetcher.java
@@ -44,6 +44,6 @@ public Optional performSearchById(String identifier) throws FetcherExc
}
DoiFetcher doiFetcher = new DoiFetcher(this.preferences);
- return doiFetcher.performSearchById(doi.get().getDOI());
+ return doiFetcher.performSearchById(doi.get().asString());
}
}
diff --git a/src/main/java/org/jabref/logic/importer/fetcher/isbntobibtex/IsbnFetcher.java b/src/main/java/org/jabref/logic/importer/fetcher/isbntobibtex/IsbnFetcher.java
index 7df0fb6fab5..ac94fe5f919 100644
--- a/src/main/java/org/jabref/logic/importer/fetcher/isbntobibtex/IsbnFetcher.java
+++ b/src/main/java/org/jabref/logic/importer/fetcher/isbntobibtex/IsbnFetcher.java
@@ -63,7 +63,7 @@ public Optional performSearchById(String identifier) throws FetcherExc
identifier = removeNewlinesAndSpacesFromIdentifier(identifier);
Optional isbn = ISBN.parse(identifier);
if (isbn.isPresent()) {
- bibEntry = gvkIsbnFetcher.performSearchById(isbn.get().getNormalized());
+ bibEntry = gvkIsbnFetcher.performSearchById(isbn.get().asString());
}
} catch (FetcherException ex) {
LOGGER.debug("Got a fetcher exception for IBSN search", ex);
diff --git a/src/main/java/org/jabref/logic/importer/fileformat/PdfContentImporter.java b/src/main/java/org/jabref/logic/importer/fileformat/PdfContentImporter.java
index b8a74ee790d..ef4c25321e5 100644
--- a/src/main/java/org/jabref/logic/importer/fileformat/PdfContentImporter.java
+++ b/src/main/java/org/jabref/logic/importer/fileformat/PdfContentImporter.java
@@ -474,7 +474,7 @@ private String getDoi(String doi) {
pos = curString.indexOf(StandardField.DOI.getName());
}
if (pos >= 0) {
- return DOI.findInText(curString).map(DOI::getDOI).orElse(null);
+ return DOI.findInText(curString).map(DOI::asString).orElse(null);
}
}
return doi;
diff --git a/src/main/java/org/jabref/logic/importer/fileformat/RisImporter.java b/src/main/java/org/jabref/logic/importer/fileformat/RisImporter.java
index fd1d26864da..4944b0bf77a 100644
--- a/src/main/java/org/jabref/logic/importer/fileformat/RisImporter.java
+++ b/src/main/java/org/jabref/logic/importer/fileformat/RisImporter.java
@@ -310,6 +310,6 @@ public ParserResult importDatabase(BufferedReader reader) throws IOException {
private void addDoi(Map hm, String val) {
Optional parsedDoi = DOI.parse(val);
- parsedDoi.ifPresent(doi -> hm.put(StandardField.DOI, doi.getDOI()));
+ parsedDoi.ifPresent(doi -> hm.put(StandardField.DOI, doi.asString()));
}
}
diff --git a/src/main/java/org/jabref/logic/importer/util/ShortDOIService.java b/src/main/java/org/jabref/logic/importer/util/ShortDOIService.java
index e9c6446fc19..2a1aeee0a38 100644
--- a/src/main/java/org/jabref/logic/importer/util/ShortDOIService.java
+++ b/src/main/java/org/jabref/logic/importer/util/ShortDOIService.java
@@ -41,7 +41,7 @@ private JSONObject makeRequest(DOI doi) throws ShortDOIServiceException {
try {
uriBuilder = new URIBuilder(BASIC_URL);
- uriBuilder.setPath(uriBuilder.getPath() + doi.getDOI());
+ uriBuilder.setPath(uriBuilder.getPath() + doi.asString());
uriBuilder.addParameter("format", "json");
URI uri = uriBuilder.build();
diff --git a/src/main/java/org/jabref/logic/layout/format/DOIStrip.java b/src/main/java/org/jabref/logic/layout/format/DOIStrip.java
index 0aaa27c5f9a..88b861e0ddf 100644
--- a/src/main/java/org/jabref/logic/layout/format/DOIStrip.java
+++ b/src/main/java/org/jabref/logic/layout/format/DOIStrip.java
@@ -13,6 +13,6 @@ public String format(String fieldText) {
return null;
}
- return DOI.parse(fieldText).map(DOI::getDOI).orElse(fieldText);
+ return DOI.parse(fieldText).map(DOI::asString).orElse(fieldText);
}
}
diff --git a/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java b/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java
index 79492a8f72c..f3ecebe41d9 100644
--- a/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java
+++ b/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java
@@ -81,7 +81,6 @@
import org.jabref.logic.protectedterms.ProtectedTermsLoader;
import org.jabref.logic.protectedterms.ProtectedTermsPreferences;
import org.jabref.logic.remote.RemotePreferences;
-import org.jabref.logic.search.SearchDisplayMode;
import org.jabref.logic.search.SearchPreferences;
import org.jabref.logic.shared.prefs.SharedDatabasePreferences;
import org.jabref.logic.shared.security.Password;
@@ -105,6 +104,7 @@
import org.jabref.model.entry.types.EntryTypeFactory;
import org.jabref.model.metadata.SaveOrder;
import org.jabref.model.metadata.SelfContainedSaveOrder;
+import org.jabref.model.search.SearchDisplayMode;
import org.jabref.model.search.SearchFlags;
import org.jabref.model.strings.StringUtil;
@@ -209,6 +209,8 @@ public class JabRefCliPreferences implements CliPreferences {
public static final String MAIN_FILE_DIRECTORY = "fileDirectory";
public static final String SEARCH_DISPLAY_MODE = "searchDisplayMode";
+ public static final String SEARCH_CASE_SENSITIVE = "caseSensitiveSearch";
+ public static final String SEARCH_REG_EXP = "regExpSearch";
public static final String SEARCH_FULLTEXT = "fulltextSearch";
public static final String SEARCH_KEEP_SEARCH_STRING = "keepSearchString";
public static final String SEARCH_KEEP_GLOBAL_WINDOW_ON_TOP = "keepOnTop";
@@ -434,6 +436,8 @@ protected JabRefCliPreferences() {
Localization.setLanguage(getLanguage());
defaults.put(SEARCH_DISPLAY_MODE, Boolean.TRUE);
+ defaults.put(SEARCH_CASE_SENSITIVE, Boolean.FALSE);
+ defaults.put(SEARCH_REG_EXP, Boolean.FALSE);
defaults.put(SEARCH_FULLTEXT, Boolean.FALSE);
defaults.put(SEARCH_KEEP_SEARCH_STRING, Boolean.FALSE);
defaults.put(SEARCH_KEEP_GLOBAL_WINDOW_ON_TOP, Boolean.TRUE);
@@ -665,8 +669,9 @@ public void setLanguageDependentDefaultValues() {
}
/**
- * @return Instance of JaRefPreferences
- * @deprecated Use {@link CliPreferences} instead
+ * @deprecated Never ever add a call to this method. There should be only one caller.
+ * All other usages should get the preferences passed (or injected).
+ * The JabRef team leaves the @deprecated annotation to have IntelliJ listing this method with a strike-through.
*/
@Deprecated
public static JabRefCliPreferences getInstance() {
@@ -1882,6 +1887,8 @@ public SearchPreferences getSearchPreferences() {
searchPreferences = new SearchPreferences(
getBoolean(SEARCH_DISPLAY_MODE) ? SearchDisplayMode.FILTER : SearchDisplayMode.FLOAT,
+ getBoolean(SEARCH_REG_EXP),
+ getBoolean(SEARCH_CASE_SENSITIVE),
getBoolean(SEARCH_FULLTEXT),
getBoolean(SEARCH_KEEP_SEARCH_STRING),
getBoolean(SEARCH_KEEP_GLOBAL_WINDOW_ON_TOP),
diff --git a/src/main/java/org/jabref/logic/search/DatabaseSearcher.java b/src/main/java/org/jabref/logic/search/DatabaseSearcher.java
index 09f15d48207..6b51f651539 100644
--- a/src/main/java/org/jabref/logic/search/DatabaseSearcher.java
+++ b/src/main/java/org/jabref/logic/search/DatabaseSearcher.java
@@ -5,12 +5,12 @@
import java.util.List;
import java.util.Objects;
-import org.jabref.logic.FilePreferences;
+import org.jabref.logic.preferences.CliPreferences;
import org.jabref.logic.util.TaskExecutor;
import org.jabref.model.database.BibDatabaseContext;
import org.jabref.model.database.BibDatabases;
import org.jabref.model.entry.BibEntry;
-import org.jabref.model.search.SearchQuery;
+import org.jabref.model.search.query.SearchQuery;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -20,13 +20,13 @@ public class DatabaseSearcher {
private final BibDatabaseContext databaseContext;
private final SearchQuery query;
- private final LuceneManager luceneManager;
+ private final IndexManager indexManager;
- // get rid of task executor here or add a constuctor overload?
- public DatabaseSearcher(SearchQuery query, BibDatabaseContext databaseContext, TaskExecutor taskExecutor, FilePreferences filePreferences) throws IOException {
+ // get rid of task executor here or add a constructor overload?
+ public DatabaseSearcher(SearchQuery query, BibDatabaseContext databaseContext, TaskExecutor taskExecutor, CliPreferences preferences) throws IOException {
this.databaseContext = databaseContext;
this.query = Objects.requireNonNull(query);
- this.luceneManager = new LuceneManager(databaseContext, taskExecutor, filePreferences);
+ this.indexManager = new IndexManager(databaseContext, taskExecutor, preferences);
}
/**
@@ -37,15 +37,15 @@ public List getMatches() {
if (!query.isValid()) {
LOGGER.warn("Search failed: invalid search expression");
- luceneManager.closeAndWait();
+ indexManager.closeAndWait();
return Collections.emptyList();
}
- List matchEntries = luceneManager.search(query)
- .getMatchedEntries()
- .stream()
- .map(entryId -> databaseContext.getDatabase().getEntryById(entryId))
- .toList();
- luceneManager.closeAndWait();
+ List matchEntries = indexManager.search(query)
+ .getMatchedEntries()
+ .stream()
+ .map(entryId -> databaseContext.getDatabase().getEntryById(entryId))
+ .toList();
+ indexManager.closeAndWait();
return BibDatabases.purgeEmptyEntries(matchEntries);
}
}
diff --git a/src/main/java/org/jabref/logic/search/LuceneManager.java b/src/main/java/org/jabref/logic/search/IndexManager.java
similarity index 65%
rename from src/main/java/org/jabref/logic/search/LuceneManager.java
rename to src/main/java/org/jabref/logic/search/IndexManager.java
index 3e9a3bf4c14..33c215a9c90 100644
--- a/src/main/java/org/jabref/logic/search/LuceneManager.java
+++ b/src/main/java/org/jabref/logic/search/IndexManager.java
@@ -1,62 +1,73 @@
package org.jabref.logic.search;
import java.io.IOException;
+import java.util.ArrayList;
import java.util.List;
+import java.util.concurrent.Callable;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.Future;
import javafx.beans.property.BooleanProperty;
-import javafx.beans.property.SimpleBooleanProperty;
import javafx.beans.value.ChangeListener;
-import org.jabref.logic.FilePreferences;
+import org.jabref.logic.preferences.CliPreferences;
import org.jabref.logic.search.indexing.BibFieldsIndexer;
import org.jabref.logic.search.indexing.DefaultLinkedFilesIndexer;
import org.jabref.logic.search.indexing.ReadOnlyLinkedFilesIndexer;
-import org.jabref.logic.search.retrieval.LuceneSearcher;
+import org.jabref.logic.search.retrieval.BibFieldsSearcher;
+import org.jabref.logic.search.retrieval.LinkedFilesSearcher;
import org.jabref.logic.util.BackgroundTask;
+import org.jabref.logic.util.HeadlessExecutorService;
import org.jabref.logic.util.TaskExecutor;
import org.jabref.model.database.BibDatabaseContext;
import org.jabref.model.entry.BibEntry;
-import org.jabref.model.search.SearchQuery;
-import org.jabref.model.search.SearchResults;
+import org.jabref.model.entry.event.FieldChangedEvent;
+import org.jabref.model.entry.field.StandardField;
+import org.jabref.model.search.SearchFlags;
import org.jabref.model.search.event.IndexAddedOrUpdatedEvent;
import org.jabref.model.search.event.IndexClosedEvent;
import org.jabref.model.search.event.IndexRemovedEvent;
import org.jabref.model.search.event.IndexStartedEvent;
+import org.jabref.model.search.query.SearchQuery;
+import org.jabref.model.search.query.SearchResults;
+import com.airhacks.afterburner.injection.Injector;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-public class LuceneManager {
- private static final Logger LOGGER = LoggerFactory.getLogger(LuceneManager.class);
+public class IndexManager {
+ private static final Logger LOGGER = LoggerFactory.getLogger(IndexManager.class);
private final TaskExecutor taskExecutor;
private final BibDatabaseContext databaseContext;
private final BooleanProperty shouldIndexLinkedFiles;
- private final BooleanProperty isLinkedFilesIndexerBlocked = new SimpleBooleanProperty(false);
private final ChangeListener preferencesListener;
- private final LuceneIndexer bibFieldsIndexer;
+ private final BibFieldsIndexer bibFieldsIndexer;
private final LuceneIndexer linkedFilesIndexer;
- private final LuceneSearcher luceneSearcher;
+ private final BibFieldsSearcher bibFieldsSearcher;
+ private final LinkedFilesSearcher linkedFilesSearcher;
- public LuceneManager(BibDatabaseContext databaseContext, TaskExecutor executor, FilePreferences preferences) {
+ public IndexManager(BibDatabaseContext databaseContext, TaskExecutor executor, CliPreferences preferences) {
this.taskExecutor = executor;
this.databaseContext = databaseContext;
- this.shouldIndexLinkedFiles = preferences.fulltextIndexLinkedFilesProperty();
+ this.shouldIndexLinkedFiles = preferences.getFilePreferences().fulltextIndexLinkedFilesProperty();
this.preferencesListener = (observable, oldValue, newValue) -> bindToPreferences(newValue);
this.shouldIndexLinkedFiles.addListener(preferencesListener);
- this.bibFieldsIndexer = new BibFieldsIndexer(databaseContext);
+ PostgreServer postgreServer = Injector.instantiateModelOrService(PostgreServer.class);
+ bibFieldsIndexer = new BibFieldsIndexer(preferences.getBibEntryPreferences(), databaseContext, postgreServer.getConnection());
LuceneIndexer indexer;
try {
- indexer = new DefaultLinkedFilesIndexer(databaseContext, preferences);
+ indexer = new DefaultLinkedFilesIndexer(databaseContext, preferences.getFilePreferences());
} catch (IOException e) {
LOGGER.debug("Error initializing linked files index - using read only index");
indexer = new ReadOnlyLinkedFilesIndexer(databaseContext);
}
linkedFilesIndexer = indexer;
- this.luceneSearcher = new LuceneSearcher(databaseContext, bibFieldsIndexer, linkedFilesIndexer, preferences);
+ this.bibFieldsSearcher = new BibFieldsSearcher(postgreServer.getConnection(), bibFieldsIndexer.getTable());
+ this.linkedFilesSearcher = new LinkedFilesSearcher(databaseContext, linkedFilesIndexer, preferences.getFilePreferences());
updateOnStart();
}
@@ -106,7 +117,7 @@ public Object call() {
}.onFinished(() -> this.databaseContext.getDatabase().postEvent(new IndexAddedOrUpdatedEvent(entries)))
.executeWith(taskExecutor);
- if (shouldIndexLinkedFiles.get() && !isLinkedFilesIndexerBlocked.get()) {
+ if (shouldIndexLinkedFiles.get()) {
new BackgroundTask<>() {
@Override
public Object call() {
@@ -138,58 +149,28 @@ public Object call() {
}
}
- public void updateEntry(BibEntry entry, String oldValue, String newValue, boolean isLinkedFile) {
- new BackgroundTask<>() {
- @Override
- public Object call() {
- bibFieldsIndexer.updateEntry(entry, oldValue, newValue, this);
- return null;
- }
- }.onFinished(() -> this.databaseContext.getDatabase().postEvent(new IndexAddedOrUpdatedEvent(List.of(entry))))
- .executeWith(taskExecutor);
-
- if (isLinkedFile && shouldIndexLinkedFiles.get() && !isLinkedFilesIndexerBlocked.get()) {
- new BackgroundTask<>() {
- @Override
- public Object call() {
- linkedFilesIndexer.updateEntry(entry, oldValue, newValue, this);
- return null;
- }
- }.executeWith(taskExecutor);
- }
- }
-
- public void updateAfterDropFiles(BibEntry entry) {
+ public void updateEntry(FieldChangedEvent event) {
new BackgroundTask<>() {
@Override
public Object call() {
- bibFieldsIndexer.updateEntry(entry, "", "", this);
+ bibFieldsIndexer.updateEntry(event.getBibEntry(), event.getField());
return null;
}
- }.onFinished(() -> this.databaseContext.getDatabase().postEvent(new IndexAddedOrUpdatedEvent(List.of(entry))))
+ }.onFinished(() -> this.databaseContext.getDatabase().postEvent(new IndexAddedOrUpdatedEvent(List.of(event.getBibEntry()))))
.executeWith(taskExecutor);
- if (shouldIndexLinkedFiles.get() && !isLinkedFilesIndexerBlocked.get()) {
+ if (shouldIndexLinkedFiles.get() && event.getField().equals(StandardField.FILE)) {
new BackgroundTask<>() {
@Override
public Object call() {
- linkedFilesIndexer.addToIndex(List.of(entry), this);
+ linkedFilesIndexer.updateEntry(event.getBibEntry(), event.getOldValue(), event.getNewValue(), this);
return null;
}
}.executeWith(taskExecutor);
}
}
- public void rebuildIndex() {
- new BackgroundTask<>() {
- @Override
- public Object call() {
- bibFieldsIndexer.rebuildIndex(this);
- return null;
- }
- }.onFinished(() -> this.databaseContext.getDatabase().postEvent(new IndexStartedEvent()))
- .executeWith(taskExecutor);
-
+ public void rebuildFullTextIndex() {
if (shouldIndexLinkedFiles.get()) {
new BackgroundTask<>() {
@Override
@@ -215,22 +196,32 @@ public void closeAndWait() {
databaseContext.getDatabase().postEvent(new IndexClosedEvent());
}
- public AutoCloseable blockLinkedFileIndexer() {
- LOGGER.debug("Blocking linked files indexer");
- isLinkedFilesIndexerBlocked.set(true);
- return () -> isLinkedFilesIndexerBlocked.set(false);
- }
-
public SearchResults search(SearchQuery query) {
- if (query.isValid()) {
- query.setSearchResults(luceneSearcher.search(query.getParsedQuery(), query.getSearchFlags()));
- } else {
- query.setSearchResults(new SearchResults());
+ List> tasks = new ArrayList<>();
+ tasks.add(() -> bibFieldsSearcher.search(query));
+
+ if (query.getSearchFlags().contains(SearchFlags.FULLTEXT)) {
+ tasks.add(() -> linkedFilesSearcher.search(query));
+ }
+
+ List> futures = HeadlessExecutorService.INSTANCE.executeAll(tasks);
+
+ SearchResults searchResults = new SearchResults();
+ for (Future future : futures) {
+ try {
+ searchResults.mergeSearchResults(future.get());
+ } catch (InterruptedException | ExecutionException e) {
+ LOGGER.error("Error while searching", e);
+ }
}
- return query.getSearchResults();
+ query.setSearchResults(searchResults);
+ return searchResults;
}
+ /**
+ * @implNote No need to check for full-text searches as this method only used by the search groups
+ */
public boolean isEntryMatched(BibEntry entry, SearchQuery query) {
- return luceneSearcher.isEntryMatched(entry, query);
+ return bibFieldsSearcher.isMatched(entry, query);
}
}
diff --git a/src/main/java/org/jabref/logic/search/PostgreServer.java b/src/main/java/org/jabref/logic/search/PostgreServer.java
new file mode 100644
index 00000000000..13a113c441a
--- /dev/null
+++ b/src/main/java/org/jabref/logic/search/PostgreServer.java
@@ -0,0 +1,98 @@
+package org.jabref.logic.search;
+
+import java.io.IOException;
+import java.sql.Connection;
+import java.sql.SQLException;
+
+import javax.sql.DataSource;
+
+import org.jabref.model.search.PostgreConstants;
+
+import io.zonky.test.db.postgres.embedded.EmbeddedPostgres;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import static org.jabref.model.search.PostgreConstants.BIB_FIELDS_SCHEME;
+
+public class PostgreServer {
+ private static final Logger LOGGER = LoggerFactory.getLogger(PostgreServer.class);
+ private final EmbeddedPostgres embeddedPostgres;
+ private final DataSource dataSource;
+
+ public PostgreServer() {
+ EmbeddedPostgres embeddedPostgres;
+ try {
+ embeddedPostgres = EmbeddedPostgres.builder()
+ .start();
+ LOGGER.info("Postgres server started, connection port: {}", embeddedPostgres.getPort());
+ } catch (IOException e) {
+ LOGGER.error("Could not start Postgres server", e);
+ this.embeddedPostgres = null;
+ this.dataSource = null;
+ return;
+ }
+
+ this.embeddedPostgres = embeddedPostgres;
+ this.dataSource = embeddedPostgres.getPostgresDatabase();
+ addTrigramExtension();
+ createScheme();
+ addFunctions();
+ }
+
+ private void createScheme() {
+ try (Connection connection = getConnection()) {
+ if (connection != null) {
+ LOGGER.debug("Creating scheme for bib fields");
+ connection.createStatement().execute("DROP SCHEMA IF EXISTS " + BIB_FIELDS_SCHEME);
+ connection.createStatement().execute("CREATE SCHEMA " + BIB_FIELDS_SCHEME);
+ }
+ } catch (SQLException e) {
+ LOGGER.error("Could not create scheme for bib fields", e);
+ }
+ }
+
+ private void addTrigramExtension() {
+ try (Connection connection = getConnection()) {
+ if (connection != null) {
+ LOGGER.debug("Adding trigram extension to Postgres server");
+ connection.createStatement().execute("CREATE EXTENSION IF NOT EXISTS pg_trgm");
+ }
+ } catch (SQLException e) {
+ LOGGER.error("Could not add trigram extension to Postgres server", e);
+ }
+ }
+
+ private void addFunctions() {
+ try (Connection connection = getConnection()) {
+ if (connection != null) {
+ LOGGER.debug("Adding functions to Postgres server");
+ for (String function : PostgreConstants.POSTGRES_FUNCTIONS) {
+ connection.createStatement().execute(function);
+ }
+ }
+ } catch (SQLException e) {
+ LOGGER.error("Could not add functions to Postgres server", e);
+ }
+ }
+
+ public Connection getConnection() {
+ if (dataSource != null) {
+ try {
+ return dataSource.getConnection();
+ } catch (SQLException e) {
+ LOGGER.error("Could not get connection to Postgres server", e);
+ }
+ }
+ return null;
+ }
+
+ public void shutdown() {
+ if (embeddedPostgres != null) {
+ try {
+ embeddedPostgres.close();
+ } catch (IOException e) {
+ LOGGER.error("Could not shutdown Postgres server", e);
+ }
+ }
+ }
+}
diff --git a/src/main/java/org/jabref/logic/search/SearchPreferences.java b/src/main/java/org/jabref/logic/search/SearchPreferences.java
index 07a687c75ee..e75269f53a4 100644
--- a/src/main/java/org/jabref/logic/search/SearchPreferences.java
+++ b/src/main/java/org/jabref/logic/search/SearchPreferences.java
@@ -11,6 +11,7 @@
import javafx.collections.FXCollections;
import javafx.collections.ObservableSet;
+import org.jabref.model.search.SearchDisplayMode;
import org.jabref.model.search.SearchFlags;
import com.google.common.annotations.VisibleForTesting;
@@ -25,8 +26,22 @@ public class SearchPreferences {
private final BooleanProperty keepSearchSting;
private final ObjectProperty searchDisplayMode;
- public SearchPreferences(SearchDisplayMode searchDisplayMode, boolean isFulltext, boolean keepSearchString, boolean keepWindowOnTop, double searchWindowHeight, double searchWindowWidth, double searchWindowDividerPosition) {
+ public SearchPreferences(SearchDisplayMode searchDisplayMode,
+ boolean isRegularExpression,
+ boolean isCaseSensitive,
+ boolean isFulltext,
+ boolean keepSearchString,
+ boolean keepWindowOnTop,
+ double searchWindowHeight,
+ double searchWindowWidth,
+ double searchWindowDividerPosition) {
this(searchDisplayMode, EnumSet.noneOf(SearchFlags.class), keepSearchString, keepWindowOnTop, searchWindowHeight, searchWindowWidth, searchWindowDividerPosition);
+ if (isRegularExpression) {
+ searchFlags.add(SearchFlags.REGULAR_EXPRESSION);
+ }
+ if (isCaseSensitive) {
+ searchFlags.add(SearchFlags.CASE_SENSITIVE);
+ }
if (isFulltext) {
searchFlags.add(SearchFlags.FULLTEXT);
}
@@ -64,6 +79,14 @@ public void setSearchFlag(SearchFlags flag, boolean value) {
}
}
+ public boolean isRegularExpression() {
+ return searchFlags.contains(SearchFlags.REGULAR_EXPRESSION);
+ }
+
+ public boolean isCaseSensitive() {
+ return searchFlags.contains(SearchFlags.CASE_SENSITIVE);
+ }
+
public boolean isFulltext() {
return searchFlags.contains(SearchFlags.FULLTEXT);
}
diff --git a/src/main/java/org/jabref/logic/search/indexing/BibFieldsIndexer.java b/src/main/java/org/jabref/logic/search/indexing/BibFieldsIndexer.java
index 0c0d3106e72..6312ba54ffb 100644
--- a/src/main/java/org/jabref/logic/search/indexing/BibFieldsIndexer.java
+++ b/src/main/java/org/jabref/logic/search/indexing/BibFieldsIndexer.java
@@ -1,60 +1,166 @@
package org.jabref.logic.search.indexing;
-import java.io.IOException;
+import java.sql.Connection;
+import java.sql.PreparedStatement;
+import java.sql.SQLException;
+import java.util.Arrays;
import java.util.Collection;
import java.util.Map;
+import java.util.Optional;
+import java.util.regex.Pattern;
import org.jabref.logic.l10n.Localization;
-import org.jabref.logic.search.LuceneIndexer;
+import org.jabref.logic.layout.format.LatexToUnicodeFormatter;
import org.jabref.logic.util.BackgroundTask;
import org.jabref.logic.util.HeadlessExecutorService;
import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.model.entry.AuthorList;
import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.BibEntryPreferences;
+import org.jabref.model.entry.KeywordList;
import org.jabref.model.entry.field.Field;
+import org.jabref.model.entry.field.FieldProperty;
import org.jabref.model.entry.field.StandardField;
-import org.jabref.model.search.SearchFieldConstants;
-
-import org.apache.lucene.document.Document;
-import org.apache.lucene.document.StringField;
-import org.apache.lucene.document.TextField;
-import org.apache.lucene.index.IndexWriter;
-import org.apache.lucene.index.IndexWriterConfig;
-import org.apache.lucene.index.Term;
-import org.apache.lucene.search.SearcherManager;
-import org.apache.lucene.store.ByteBuffersDirectory;
-import org.apache.lucene.store.Directory;
+import org.jabref.model.search.PostgreConstants;
+
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-public class BibFieldsIndexer implements LuceneIndexer {
+import static org.jabref.model.entry.field.InternalField.TYPE_HEADER;
+import static org.jabref.model.search.PostgreConstants.ENTRY_ID;
+import static org.jabref.model.search.PostgreConstants.FIELD_NAME;
+import static org.jabref.model.search.PostgreConstants.FIELD_VALUE_LITERAL;
+import static org.jabref.model.search.PostgreConstants.FIELD_VALUE_TRANSFORMED;
+import static org.jabref.model.search.PostgreConstants.SPLIT_TABLE_SUFFIX;
+
+public class BibFieldsIndexer {
private static final Logger LOGGER = LoggerFactory.getLogger(BibFieldsIndexer.class);
+ private static final LatexToUnicodeFormatter LATEX_TO_UNICODE_FORMATTER = new LatexToUnicodeFormatter();
+ private static final Pattern GROUPS_SEPARATOR_REGEX = Pattern.compile("\s*,\s*");
+
private final BibDatabaseContext databaseContext;
+ private final Connection connection;
private final String libraryName;
- private final Directory indexDirectory;
- private IndexWriter indexWriter;
- private SearcherManager searcherManager;
+ private final String mainTable;
+ private final String schemaMainTableReference;
+ private final String splitValuesTable;
+ private final String schemaSplitValuesTableReference;
+ private final Character keywordSeparator;
- public BibFieldsIndexer(BibDatabaseContext databaseContext) {
+ public BibFieldsIndexer(BibEntryPreferences bibEntryPreferences, BibDatabaseContext databaseContext, Connection connection) {
this.databaseContext = databaseContext;
+ this.connection = connection;
+ this.keywordSeparator = bibEntryPreferences.getKeywordSeparator();
this.libraryName = databaseContext.getDatabasePath().map(path -> path.getFileName().toString()).orElse("unsaved");
- IndexWriterConfig config = new IndexWriterConfig(SearchFieldConstants.LATEX_AWARE_NGRAM_ANALYZER);
+ this.mainTable = databaseContext.getUniqueName();
+ this.splitValuesTable = mainTable + SPLIT_TABLE_SUFFIX;
- this.indexDirectory = new ByteBuffersDirectory();
+ this.schemaMainTableReference = PostgreConstants.getMainTableSchemaReference(mainTable);
+ this.schemaSplitValuesTableReference = PostgreConstants.getSplitTableSchemaReference(mainTable);
+ // TODO: Set-up should be in a background task
+ setup();
+ }
+
+ /**
+ * Creates a table for the library in the database, and sets up indexes on the columns.
+ */
+ private void setup() {
try {
- this.indexWriter = new IndexWriter(indexDirectory, config);
- this.searcherManager = new SearcherManager(indexWriter, null);
- } catch (IOException e) {
- LOGGER.error("Error initializing bib fields index", e);
+ connection.createStatement().executeUpdate("""
+ CREATE TABLE IF NOT EXISTS %s (
+ %s TEXT NOT NULL,
+ %s TEXT NOT NULL,
+ %s TEXT,
+ %s TEXT,
+ PRIMARY KEY (%s, %s)
+ )
+ """.formatted(
+ schemaMainTableReference,
+ ENTRY_ID,
+ FIELD_NAME,
+ FIELD_VALUE_LITERAL,
+ FIELD_VALUE_TRANSFORMED,
+ ENTRY_ID, FIELD_NAME));
+
+ connection.createStatement().executeUpdate("""
+ CREATE TABLE IF NOT EXISTS %s (
+ %s TEXT NOT NULL,
+ %s TEXT NOT NULL,
+ %s TEXT,
+ %s TEXT
+ )
+ """.formatted(
+ schemaSplitValuesTableReference,
+ ENTRY_ID,
+ FIELD_NAME,
+ FIELD_VALUE_LITERAL,
+ FIELD_VALUE_TRANSFORMED));
+
+ LOGGER.debug("Created tables for library: {}", libraryName);
+ } catch (SQLException e) {
+ LOGGER.error("Could not create tables for library: {}", libraryName, e);
+ }
+ try {
+ // region btree index on id column
+ connection.createStatement().executeUpdate("""
+ CREATE INDEX IF NOT EXISTS "%s_%s_index" ON %s ("%s")
+ """.formatted(
+ mainTable, ENTRY_ID,
+ schemaMainTableReference,
+ ENTRY_ID));
+
+ connection.createStatement().executeUpdate("""
+ CREATE INDEX IF NOT EXISTS "%s_%s_index" ON %s ("%s")
+ """.formatted(
+ splitValuesTable, ENTRY_ID,
+ schemaSplitValuesTableReference,
+ ENTRY_ID));
+ // endregion
+
+ // region btree index on field name column
+ connection.createStatement().executeUpdate("""
+ CREATE INDEX IF NOT EXISTS "%s_%s_index" ON %s ("%s")
+ """.formatted(
+ mainTable, FIELD_NAME,
+ schemaMainTableReference,
+ FIELD_NAME));
+
+ connection.createStatement().executeUpdate("""
+ CREATE INDEX IF NOT EXISTS "%s_%s_index" ON %s ("%s")
+ """.formatted(
+ splitValuesTable, FIELD_NAME,
+ schemaSplitValuesTableReference,
+ FIELD_NAME));
+ // endregion
+
+ // trigram index on field value column
+ connection.createStatement().executeUpdate("""
+ CREATE INDEX IF NOT EXISTS "%s_%s_index" ON %s USING gin ("%s" gin_trgm_ops, "%s" gin_trgm_ops)
+ """.formatted(
+ mainTable, FIELD_VALUE_LITERAL,
+ schemaMainTableReference,
+ FIELD_VALUE_LITERAL, FIELD_VALUE_TRANSFORMED));
+
+ // region btree index on spilt table
+ connection.createStatement().executeUpdate("""
+ CREATE INDEX IF NOT EXISTS "%s_%s_index" ON %s ("%s", "%s")
+ """.formatted(
+ splitValuesTable, FIELD_VALUE_LITERAL,
+ schemaSplitValuesTableReference,
+ FIELD_VALUE_LITERAL, FIELD_VALUE_TRANSFORMED));
+ // endregion
+
+ LOGGER.debug("Created indexes for library: {}", libraryName);
+ } catch (SQLException e) {
+ LOGGER.error("Could not create indexes for library: {}", libraryName, e);
}
}
- @Override
public void updateOnStart(BackgroundTask task) {
addToIndex(databaseContext.getDatabase().getEntries(), task);
}
- @Override
public void addToIndex(Collection entries, BackgroundTask task) {
if (entries.size() > 1) {
task.showToUser(true);
@@ -77,30 +183,72 @@ public void addToIndex(Collection entries, BackgroundTask task) {
}
private void addToIndex(BibEntry bibEntry) {
- try {
- Document document = new Document();
- org.apache.lucene.document.Field.Store storeEnabled = org.apache.lucene.document.Field.Store.YES;
- org.apache.lucene.document.Field.Store storeDisabled = org.apache.lucene.document.Field.Store.NO;
- document.add(new StringField(SearchFieldConstants.ENTRY_ID.toString(), bibEntry.getId(), storeEnabled));
- document.add(new TextField(SearchFieldConstants.ENTRY_TYPE.toString(), bibEntry.getType().getName(), storeDisabled));
-
- StringBuilder allFields = new StringBuilder(bibEntry.getType().getName());
- for (Map.Entry mapEntry : bibEntry.getFieldMap().entrySet()) {
- document.add(new TextField(mapEntry.getKey().getName(), mapEntry.getValue(), storeDisabled));
- if (mapEntry.getKey().equals(StandardField.GROUPS)) {
- // Do not add groups to the allFields field: https://github.com/JabRef/jabref/issues/7996
- continue;
+ String insertFieldQuery = """
+ INSERT INTO %s ("%s", "%s", "%s", "%s")
+ VALUES (?, ?, ?, ?)
+ """.formatted(
+ schemaMainTableReference,
+ ENTRY_ID,
+ FIELD_NAME,
+ FIELD_VALUE_LITERAL,
+ FIELD_VALUE_TRANSFORMED);
+
+ String insertIntoSplitTable = """
+ INSERT INTO %s ("%s", "%s", "%s", "%s")
+ VALUES (?, ?, ?, ?)
+ """.formatted(
+ schemaSplitValuesTableReference,
+ ENTRY_ID,
+ FIELD_NAME,
+ FIELD_VALUE_LITERAL,
+ FIELD_VALUE_TRANSFORMED);
+
+ try (PreparedStatement preparedStatement = connection.prepareStatement(insertFieldQuery);
+ PreparedStatement preparedStatementSplitValues = connection.prepareStatement(insertIntoSplitTable)) {
+ String entryId = bibEntry.getId();
+ for (Map.Entry fieldPair : bibEntry.getFieldMap().entrySet()) {
+ Field field = fieldPair.getKey();
+ String value = fieldPair.getValue();
+
+ // If a field exists, there also exists a resolved field latex free.
+ // We add a `.orElse("")` only because there could be some flaw in the future in the code - and we want to have search working even if the flaws are present.
+ // To uncover these flaws, we add the "assert" statement.
+ // One potential future flaw is that the bibEntry is modified concurrently and the field being deleted.
+ Optional resolvedFieldLatexFree = bibEntry.getResolvedFieldOrAliasLatexFree(field, this.databaseContext.getDatabase());
+ assert resolvedFieldLatexFree.isPresent();
+ addBatch(preparedStatement, entryId, field, value, resolvedFieldLatexFree.orElse(""));
+
+ // region Handling of known multi-value fields
+ // split and convert to Unicode
+ if (field.getProperties().contains(FieldProperty.PERSON_NAMES)) {
+ addAuthors(value, preparedStatementSplitValues, entryId, field);
+ } else if (field == StandardField.KEYWORDS) {
+ addKeywords(value, preparedStatementSplitValues, entryId, field, keywordSeparator);
+ } else if (field == StandardField.GROUPS) {
+ addGroups(value, preparedStatementSplitValues, entryId, field);
+ } else if (field.getProperties().contains(FieldProperty.MULTIPLE_ENTRY_LINK)) {
+ addEntryLinks(bibEntry, field, preparedStatementSplitValues, entryId);
+ } else if (field == StandardField.FILE) {
+ // No handling of File, because due to relative paths, we think, there won't be any exact match operation
+ // We could add the filename itself (with and without extension). However, the user can also use regular expressions to achieve the same.
+ // The use case to search for file names seems pretty seldom, therefore we omit it.
+ } else {
+ // No other multi-value fields are known
+ // No action needed -> main table has the value
}
- allFields.append('\n').append(mapEntry.getValue());
+ // endregion
}
- document.add(new TextField(SearchFieldConstants.DEFAULT_FIELD.toString(), allFields.toString(), storeDisabled));
- indexWriter.addDocument(document);
- } catch (IOException e) {
- LOGGER.warn("Could not add an entry to the index.", e);
+
+ // add entry type
+ addBatch(preparedStatement, entryId, TYPE_HEADER, bibEntry.getType().getName());
+
+ preparedStatement.executeBatch();
+ preparedStatementSplitValues.executeBatch();
+ } catch (SQLException e) {
+ LOGGER.error("Could not add an entry to the index.", e);
}
}
- @Override
public void removeFromIndex(Collection entries, BackgroundTask task) {
if (entries.size() > 1) {
task.showToUser(true);
@@ -121,61 +269,171 @@ public void removeFromIndex(Collection entries, BackgroundTask task
private void removeFromIndex(BibEntry entry) {
try {
- indexWriter.deleteDocuments((new Term(SearchFieldConstants.ENTRY_ID.toString(), entry.getId())));
+ connection.createStatement().executeUpdate("""
+ DELETE FROM %s
+ WHERE "%s" = '%s'
+ """.formatted(schemaMainTableReference, ENTRY_ID, entry.getId()));
+ connection.createStatement().executeUpdate("""
+ DELETE FROM %s
+ WHERE "%s" = '%s'
+ """.formatted(schemaSplitValuesTableReference, ENTRY_ID, entry.getId()));
LOGGER.debug("Entry {} removed from index", entry.getId());
- } catch (IOException e) {
+ } catch (SQLException e) {
LOGGER.error("Error deleting entry from index", e);
}
}
- @Override
- public void updateEntry(BibEntry entry, String oldValue, String newValue, BackgroundTask task) {
- LOGGER.debug("Updating entry {} in index", entry.getId());
- removeFromIndex(entry);
- addToIndex(entry);
+ public void updateEntry(BibEntry entry, Field field) {
+ removeField(entry, field);
+ insertField(entry, field);
}
- @Override
- public void removeAllFromIndex() {
- try {
- LOGGER.debug("Removing all bib fields from index");
- indexWriter.deleteAll();
- LOGGER.debug("All bib fields removed from index");
- } catch (IOException e) {
- LOGGER.error("Error deleting all linked files from index", e);
+ private void insertField(BibEntry entry, Field field) {
+ String insertFieldQuery = """
+ INSERT INTO %s ("%s", "%s", "%s", "%s")
+ VALUES (?, ?, ?, ?)
+ """.formatted(
+ schemaMainTableReference,
+ ENTRY_ID,
+ FIELD_NAME,
+ FIELD_VALUE_LITERAL,
+ FIELD_VALUE_TRANSFORMED);
+
+ try (PreparedStatement preparedStatement = connection.prepareStatement(insertFieldQuery)) {
+ String entryId = entry.getId();
+ String value = entry.getField(field).orElse("");
+
+ Optional resolvedFieldLatexFree = entry.getResolvedFieldOrAliasLatexFree(field, this.databaseContext.getDatabase());
+ assert resolvedFieldLatexFree.isPresent();
+ addBatch(preparedStatement, entryId, field, value, resolvedFieldLatexFree.orElse(""));
+ preparedStatement.executeBatch();
+ } catch (SQLException e) {
+ LOGGER.error("Could not add an entry to the index.", e);
}
- }
- @Override
- public void rebuildIndex(BackgroundTask task) {
- removeAllFromIndex();
- addToIndex(databaseContext.getDatabase().getEntries(), task);
+ String insertIntoSplitTable = """
+ INSERT INTO %s ("%s", "%s", "%s", "%s")
+ VALUES (?, ?, ?, ?)
+ """.formatted(
+ schemaSplitValuesTableReference,
+ ENTRY_ID,
+ FIELD_NAME,
+ FIELD_VALUE_LITERAL,
+ FIELD_VALUE_TRANSFORMED);
+
+ try (PreparedStatement preparedStatement = connection.prepareStatement(insertIntoSplitTable)) {
+ String entryId = entry.getId();
+ String value = entry.getField(field).orElse("");
+
+ if (field.getProperties().contains(FieldProperty.PERSON_NAMES)) {
+ addAuthors(value, preparedStatement, entryId, field);
+ } else if (field == StandardField.KEYWORDS) {
+ addKeywords(value, preparedStatement, entryId, field, keywordSeparator);
+ } else if (field == StandardField.GROUPS) {
+ addGroups(value, preparedStatement, entryId, field);
+ } else if (field.getProperties().contains(FieldProperty.MULTIPLE_ENTRY_LINK)) {
+ addEntryLinks(entry, field, preparedStatement, entryId);
+ } else if (field == StandardField.FILE) {
+ // No handling of File, because due to relative paths, we think, there won't be any exact match operation
+ }
+ preparedStatement.executeBatch();
+ } catch (SQLException e) {
+ LOGGER.error("Could not add an entry to the index.", e);
+ }
}
- @Override
- public SearcherManager getSearcherManager() {
- return searcherManager;
+ private void removeField(BibEntry entry, Field field) {
+ try {
+ connection.createStatement().executeUpdate("""
+ DELETE FROM %s
+ WHERE "%s" = '%s' AND "%s" = '%s'
+ """.formatted(schemaMainTableReference, ENTRY_ID, entry.getId(), FIELD_NAME, field.getName()));
+ connection.createStatement().executeUpdate("""
+ DELETE FROM %s
+ WHERE "%s" = '%s' AND "%s" = '%s'
+ """.formatted(schemaSplitValuesTableReference, ENTRY_ID, entry.getId(), FIELD_NAME, field.getName()));
+ LOGGER.debug("Field {} removed from entry {} in index", field.getName(), entry.getId());
+ } catch (SQLException e) {
+ LOGGER.error("Error deleting field from entry in index", e);
+ }
}
- @Override
public void close() {
HeadlessExecutorService.INSTANCE.execute(this::closeIndex);
}
- @Override
public void closeAndWait() {
HeadlessExecutorService.INSTANCE.executeAndWait(this::closeIndex);
}
private void closeIndex() {
try {
- LOGGER.debug("Closing bib fields index");
- searcherManager.close();
- indexWriter.close();
- indexDirectory.close();
- LOGGER.debug("Bib fields index closed");
- } catch (IOException e) {
- LOGGER.error("Error while closing bib fields index", e);
+ LOGGER.debug("Closing connection to Postgres server for library: {}", libraryName);
+ connection.createStatement().executeUpdate("""
+ DROP TABLE IF EXISTS %s
+ """.formatted(schemaMainTableReference));
+ connection.createStatement().executeUpdate("""
+ DROP TABLE IF EXISTS %s
+ """.formatted(schemaSplitValuesTableReference));
+ connection.close();
+ } catch (SQLException e) {
+ LOGGER.error("Could not drop table for library: {}", libraryName, e);
+ }
+ }
+
+ public String getTable() {
+ return mainTable;
+ }
+
+ private void addEntryLinks(BibEntry bibEntry, Field field, PreparedStatement preparedStatementSplitValues, String entryId) {
+ bibEntry.getEntryLinkList(field, databaseContext.getDatabase()).stream().distinct().forEach(link -> {
+ addBatch(preparedStatementSplitValues, entryId, field, link.getKey());
+ });
+ }
+
+ private static void addGroups(String value, PreparedStatement preparedStatementSplitValues, String entryId, Field field) {
+ // We could use KeywordList, but we are afraid that group names could have ">" in their name, and then they would not be handled correctly
+ Arrays.stream(GROUPS_SEPARATOR_REGEX.split(value))
+ .distinct()
+ .forEach(group -> {
+ addBatch(preparedStatementSplitValues, entryId, field, group);
+ });
+ }
+
+ private static void addKeywords(String keywordsString, PreparedStatement preparedStatementSplitValues, String entryId, Field field, Character keywordSeparator) {
+ KeywordList keywordList = KeywordList.parse(keywordsString, keywordSeparator);
+ keywordList.stream().flatMap(keyword -> keyword.flatten().stream()).forEach(keyword -> {
+ String value = keyword.toString();
+ addBatch(preparedStatementSplitValues, entryId, field, value);
+ });
+ }
+
+ private static void addAuthors(String value, PreparedStatement preparedStatementSplitValues, String entryId, Field field) {
+ AuthorList.parse(value).getAuthors().forEach(author -> {
+ // Author object does not support literal values
+ // We use the method giving us the most complete information for the literal value;
+ String literal = author.getGivenFamily(false);
+ String transformed = author.latexFree().getGivenFamily(false);
+ addBatch(preparedStatementSplitValues, entryId, field, literal, transformed);
+ });
+ }
+
+ private static void addBatch(PreparedStatement preparedStatement, String entryId, Field field, String value) {
+ addBatch(preparedStatement, entryId, field, value, LATEX_TO_UNICODE_FORMATTER.format(value));
+ }
+
+ /**
+ * The values are passed as they should be inserted into the database table
+ */
+ private static void addBatch(PreparedStatement preparedStatement, String entryId, Field field, String value, String normalized) {
+ try {
+ preparedStatement.setString(1, entryId);
+ preparedStatement.setString(2, field.getName());
+ preparedStatement.setString(3, value);
+ preparedStatement.setString(4, normalized);
+ preparedStatement.addBatch();
+ } catch (SQLException e) {
+ LOGGER.error("Could not add field {} having value {} of entry {} to the index.", field.getName(), value, entryId, e);
}
}
}
diff --git a/src/main/java/org/jabref/logic/search/indexing/DefaultLinkedFilesIndexer.java b/src/main/java/org/jabref/logic/search/indexing/DefaultLinkedFilesIndexer.java
index 78c9d736e72..50683c8d8f6 100644
--- a/src/main/java/org/jabref/logic/search/indexing/DefaultLinkedFilesIndexer.java
+++ b/src/main/java/org/jabref/logic/search/indexing/DefaultLinkedFilesIndexer.java
@@ -26,7 +26,7 @@
import org.jabref.model.database.BibDatabaseContext;
import org.jabref.model.entry.BibEntry;
import org.jabref.model.entry.LinkedFile;
-import org.jabref.model.search.SearchFieldConstants;
+import org.jabref.model.search.LinkedFilesConstants;
import org.apache.commons.io.FileUtils;
import org.apache.lucene.document.Document;
@@ -65,7 +65,7 @@ public DefaultLinkedFilesIndexer(BibDatabaseContext databaseContext, FilePrefere
this.indexedFiles = new ConcurrentHashMap<>();
indexDirectoryPath = databaseContext.getFulltextIndexPath();
- IndexWriterConfig config = new IndexWriterConfig(SearchFieldConstants.LINKED_FILES_ANALYZER);
+ IndexWriterConfig config = new IndexWriterConfig(LinkedFilesConstants.LINKED_FILES_ANALYZER);
if ("unsaved".equals(indexDirectoryPath.getFileName().toString())) {
config.setOpenMode(IndexWriterConfig.OpenMode.CREATE);
indexDirectoryPath = indexDirectoryPath.resolveSibling("unsaved" + NUMBER_OF_UNSAVED_LIBRARIES++);
@@ -192,7 +192,7 @@ private void removeFromIndex(Set links) {
for (String fileLink : links) {
try {
LOGGER.debug("Removing file {} from index.", fileLink);
- indexWriter.deleteDocuments(new Term(SearchFieldConstants.PATH.toString(), fileLink));
+ indexWriter.deleteDocuments(new Term(LinkedFilesConstants.PATH.toString(), fileLink));
indexedFiles.remove(fileLink);
} catch (IOException e) {
LOGGER.warn("Could not remove linked file {} from index.", fileLink, e);
@@ -236,15 +236,15 @@ private Map getLinkedFilesFromIndex() {
LOGGER.debug("Getting all linked files from index.");
Map linkedFiles = new HashMap<>();
try {
- TermQuery query = new TermQuery(new Term(SearchFieldConstants.PAGE_NUMBER.toString(), "1"));
+ TermQuery query = new TermQuery(new Term(LinkedFilesConstants.PAGE_NUMBER.toString(), "1"));
searcherManager.maybeRefresh();
IndexSearcher searcher = searcherManager.acquire();
StoredFields storedFields = searcher.storedFields();
TopDocs allDocs = searcher.search(query, Integer.MAX_VALUE);
for (ScoreDoc scoreDoc : allDocs.scoreDocs) {
Document doc = storedFields.document(scoreDoc.doc);
- var pathField = doc.getField(SearchFieldConstants.PATH.toString());
- var modifiedField = doc.getField(SearchFieldConstants.MODIFIED.toString());
+ var pathField = doc.getField(LinkedFilesConstants.PATH.toString());
+ var modifiedField = doc.getField(LinkedFilesConstants.MODIFIED.toString());
if (pathField != null && modifiedField != null) {
linkedFiles.put(pathField.stringValue(), Long.valueOf(modifiedField.stringValue()));
}
diff --git a/src/main/java/org/jabref/logic/search/indexing/DocumentReader.java b/src/main/java/org/jabref/logic/search/indexing/DocumentReader.java
index eca0723827a..b0437d45a12 100644
--- a/src/main/java/org/jabref/logic/search/indexing/DocumentReader.java
+++ b/src/main/java/org/jabref/logic/search/indexing/DocumentReader.java
@@ -23,11 +23,11 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import static org.jabref.model.search.SearchFieldConstants.ANNOTATIONS;
-import static org.jabref.model.search.SearchFieldConstants.CONTENT;
-import static org.jabref.model.search.SearchFieldConstants.MODIFIED;
-import static org.jabref.model.search.SearchFieldConstants.PAGE_NUMBER;
-import static org.jabref.model.search.SearchFieldConstants.PATH;
+import static org.jabref.model.search.LinkedFilesConstants.ANNOTATIONS;
+import static org.jabref.model.search.LinkedFilesConstants.CONTENT;
+import static org.jabref.model.search.LinkedFilesConstants.MODIFIED;
+import static org.jabref.model.search.LinkedFilesConstants.PAGE_NUMBER;
+import static org.jabref.model.search.LinkedFilesConstants.PATH;
/**
* Utility class for reading the data from LinkedFiles of a BibEntry for Lucene.
diff --git a/src/main/java/org/jabref/logic/search/query/SearchFlagsToExpressionVisitor.java b/src/main/java/org/jabref/logic/search/query/SearchFlagsToExpressionVisitor.java
new file mode 100644
index 00000000000..431cca878f5
--- /dev/null
+++ b/src/main/java/org/jabref/logic/search/query/SearchFlagsToExpressionVisitor.java
@@ -0,0 +1,127 @@
+package org.jabref.logic.search.query;
+
+import java.util.EnumSet;
+import java.util.List;
+
+import org.jabref.model.search.SearchFlags;
+import org.jabref.search.SearchBaseVisitor;
+import org.jabref.search.SearchParser;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import static org.jabref.model.search.SearchFlags.CASE_INSENSITIVE;
+import static org.jabref.model.search.SearchFlags.CASE_SENSITIVE;
+import static org.jabref.model.search.SearchFlags.EXACT_MATCH;
+import static org.jabref.model.search.SearchFlags.INEXACT_MATCH;
+import static org.jabref.model.search.SearchFlags.NEGATION;
+import static org.jabref.model.search.SearchFlags.REGULAR_EXPRESSION;
+
+/**
+ * Tests are located in {@link org.jabref.logic.search.query.SearchQueryFlagsConversionTest}.
+ */
+public class SearchFlagsToExpressionVisitor extends SearchBaseVisitor {
+
+ private static final Logger LOGGER = LoggerFactory.getLogger(SearchFlagsToExpressionVisitor.class);
+
+ private final boolean isCaseSensitive;
+ private final boolean isRegularExpression;
+
+ public SearchFlagsToExpressionVisitor(EnumSet searchFlags) {
+ LOGGER.debug("Converting search flags to search expression: {}", searchFlags);
+ this.isCaseSensitive = searchFlags.contains(SearchFlags.CASE_SENSITIVE);
+ this.isRegularExpression = searchFlags.contains(SearchFlags.REGULAR_EXPRESSION);
+ }
+
+ @Override
+ public String visitStart(SearchParser.StartContext ctx) {
+ return visit(ctx.andExpression());
+ }
+
+ @Override
+ public String visitImplicitAndExpression(SearchParser.ImplicitAndExpressionContext ctx) {
+ List children = ctx.expression().stream().map(this::visit).toList();
+ if (children.size() == 1) {
+ return children.getFirst();
+ }
+ return String.join(" ", children);
+ }
+
+ @Override
+ public String visitParenExpression(SearchParser.ParenExpressionContext ctx) {
+ return "(" + visit(ctx.andExpression()) + ")";
+ }
+
+ @Override
+ public String visitNegatedExpression(SearchParser.NegatedExpressionContext ctx) {
+ return "NOT " + visit(ctx.expression());
+ }
+
+ @Override
+ public String visitBinaryExpression(SearchParser.BinaryExpressionContext ctx) {
+ return visit(ctx.left) + " " + ctx.bin_op.getText() + " " + visit(ctx.right);
+ }
+
+ @Override
+ public String visitComparisonExpression(SearchParser.ComparisonExpressionContext ctx) {
+ return visit(ctx.comparison());
+ }
+
+ @Override
+ public String visitComparison(SearchParser.ComparisonContext ctx) {
+ String term = ctx.searchValue().getText();
+
+ // unfielded expression
+ if (ctx.FIELD() == null) {
+ return term;
+ }
+
+ // fielded expression
+ EnumSet searchFlags = EnumSet.noneOf(SearchFlags.class);
+ String field = ctx.FIELD().getText();
+ int operator = ctx.operator().getStart().getType();
+
+ searchFlags.add(isCaseSensitive ? CASE_SENSITIVE : CASE_INSENSITIVE);
+ if (operator == SearchParser.NEQUAL) {
+ searchFlags.add(NEGATION);
+ }
+
+ if (isRegularExpression) {
+ searchFlags.add(REGULAR_EXPRESSION);
+ } else {
+ if (operator == SearchParser.EQUAL || operator == SearchParser.CONTAINS || operator == SearchParser.NEQUAL) {
+ searchFlags.add(INEXACT_MATCH);
+ } else if (operator == SearchParser.EEQUAL || operator == SearchParser.MATCHES) {
+ searchFlags.add(EXACT_MATCH);
+ }
+ }
+ return getFieldQueryNode(field, term, searchFlags);
+ }
+
+ private String getFieldQueryNode(String field, String term, EnumSet searchFlags) {
+ String operator = getOperator(searchFlags);
+ return field + " " + operator + " " + term;
+ }
+
+ private static String getOperator(EnumSet searchFlags) {
+ StringBuilder operator = new StringBuilder();
+
+ if (searchFlags.contains(NEGATION)) {
+ operator.append("!");
+ }
+
+ if (searchFlags.contains(INEXACT_MATCH)) {
+ operator.append("=");
+ } else if (searchFlags.contains(EXACT_MATCH)) {
+ operator.append("==");
+ } else if (searchFlags.contains(REGULAR_EXPRESSION)) {
+ operator.append("=~");
+ }
+
+ if (searchFlags.contains(CASE_SENSITIVE)) {
+ operator.append("!");
+ }
+
+ return operator.toString();
+ }
+}
diff --git a/src/main/java/org/jabref/logic/search/query/SearchQueryConversion.java b/src/main/java/org/jabref/logic/search/query/SearchQueryConversion.java
new file mode 100644
index 00000000000..9c2b8ea0ff2
--- /dev/null
+++ b/src/main/java/org/jabref/logic/search/query/SearchQueryConversion.java
@@ -0,0 +1,62 @@
+package org.jabref.logic.search.query;
+
+import java.util.List;
+
+import org.jabref.model.search.query.SearchQuery;
+import org.jabref.model.search.query.SearchQueryNode;
+import org.jabref.model.search.query.SqlQueryNode;
+import org.jabref.search.SearchParser;
+
+import org.apache.lucene.search.Query;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class SearchQueryConversion {
+ private static final Logger LOGGER = LoggerFactory.getLogger(SearchQueryConversion.class);
+
+ public static SqlQueryNode searchToSql(String table, SearchQuery searchQuery) {
+ LOGGER.debug("Converting search expression to SQL: {}", searchQuery.getSearchExpression());
+ return new SearchToSqlVisitor(table, searchQuery.getSearchFlags()).visit(searchQuery.getContext());
+ }
+
+ public static String flagsToSearchExpression(SearchQuery searchQuery) {
+ LOGGER.debug("Converting search flags to search expression: {}, flags {}", searchQuery.getSearchExpression(), searchQuery.getSearchFlags());
+ return new SearchFlagsToExpressionVisitor(searchQuery.getSearchFlags()).visit(searchQuery.getContext());
+ }
+
+ public static Query searchToLucene(SearchQuery searchQuery) {
+ LOGGER.debug("Converting search expression to Lucene: {}", searchQuery.getSearchExpression());
+ return new SearchToLuceneVisitor().visit(searchQuery.getContext());
+ }
+
+ public static List extractSearchTerms(SearchQuery searchQuery) {
+ LOGGER.debug("Extracting search terms from search expression: {}", searchQuery.getSearchExpression());
+ return new SearchQueryExtractorVisitor(searchQuery.getSearchFlags()).visit(searchQuery.getContext());
+ }
+
+ /**
+ * Unescapes search value based on the Search grammar rules.
+ *
+ * - STRING_LITERAL: Removes enclosing quotes and unescapes {@code \"}
+ *
+ * - TERM: Unescapes {@code \=, \!, \~, \(, \)}
+ */
+ public static String unescapeSearchValue(SearchParser.SearchValueContext ctx) {
+ if (ctx == null) {
+ return "";
+ }
+
+ String term = ctx.getText();
+
+ if (ctx.getStart().getType() == SearchParser.STRING_LITERAL) {
+ return term.substring(1, term.length() - 1)
+ .replace("\\\"", "\"");
+ }
+
+ if (ctx.getStart().getType() == SearchParser.TERM) {
+ return term.replaceAll("\\\\([=!~()])", "$1");
+ }
+
+ return term;
+ }
+}
diff --git a/src/main/java/org/jabref/logic/search/query/SearchQueryExtractorVisitor.java b/src/main/java/org/jabref/logic/search/query/SearchQueryExtractorVisitor.java
new file mode 100644
index 00000000000..51255fa1442
--- /dev/null
+++ b/src/main/java/org/jabref/logic/search/query/SearchQueryExtractorVisitor.java
@@ -0,0 +1,125 @@
+package org.jabref.logic.search.query;
+
+import java.util.ArrayList;
+import java.util.EnumSet;
+import java.util.List;
+import java.util.Locale;
+import java.util.Optional;
+
+import org.jabref.model.entry.field.FieldFactory;
+import org.jabref.model.entry.field.InternalField;
+import org.jabref.model.entry.field.StandardField;
+import org.jabref.model.search.SearchFlags;
+import org.jabref.model.search.query.SearchQueryNode;
+import org.jabref.search.SearchBaseVisitor;
+import org.jabref.search.SearchParser;
+
+/**
+ * Tests are located in {@link org.jabref.logic.search.query.SearchQueryExtractorConversionTest}.
+ */
+public class SearchQueryExtractorVisitor extends SearchBaseVisitor> {
+
+ private final boolean searchBarRegex;
+ private boolean isNegated = false;
+
+ public SearchQueryExtractorVisitor(EnumSet searchFlags) {
+ searchBarRegex = searchFlags.contains(SearchFlags.REGULAR_EXPRESSION);
+ }
+
+ @Override
+ public List visitStart(SearchParser.StartContext ctx) {
+ return visit(ctx.andExpression());
+ }
+
+ @Override
+ public List visitImplicitAndExpression(SearchParser.ImplicitAndExpressionContext ctx) {
+ List> children = ctx.expression().stream().map(this::visit).toList();
+ if (children.size() == 1) {
+ return children.getFirst();
+ } else {
+ List terms = new ArrayList<>();
+ for (List child : children) {
+ terms.addAll(child);
+ }
+ return terms;
+ }
+ }
+
+ @Override
+ public List visitNegatedExpression(SearchParser.NegatedExpressionContext ctx) {
+ isNegated = !isNegated;
+ List terms = visit(ctx.expression());
+ isNegated = !isNegated;
+ return terms;
+ }
+
+ @Override
+ public List visitBinaryExpression(SearchParser.BinaryExpressionContext ctx) {
+ List terms = new ArrayList<>();
+ terms.addAll(visit(ctx.left));
+ terms.addAll(visit(ctx.right));
+ return terms;
+ }
+
+ @Override
+ public List visitParenExpression(SearchParser.ParenExpressionContext ctx) {
+ return visit(ctx.andExpression());
+ }
+
+ @Override
+ public List visitComparisonExpression(SearchParser.ComparisonExpressionContext ctx) {
+ return visit(ctx.comparison());
+ }
+
+ @Override
+ public List visitComparison(SearchParser.ComparisonContext ctx) {
+ // ignore negated comparisons
+ if (isNegated) {
+ return List.of();
+ }
+ if (ctx.operator() != null) {
+ int operator = ctx.operator().getStart().getType();
+ if (operator == SearchParser.NEQUAL
+ || operator == SearchParser.NCEQUAL
+ || operator == SearchParser.NEEQUAL
+ || operator == SearchParser.NCEEQUAL
+ || operator == SearchParser.NREQUAL
+ || operator == SearchParser.NCREEQUAL) {
+ return List.of();
+ }
+ }
+ String term = SearchQueryConversion.unescapeSearchValue(ctx.searchValue());
+
+ // if not regex, escape the backslashes, because the highlighter uses regex
+
+ // unfielded terms, check the search bar flags
+ if (ctx.FIELD() == null) {
+ if (!searchBarRegex) {
+ term = term.replace("\\", "\\\\");
+ }
+ return List.of(new SearchQueryNode(Optional.empty(), term));
+ }
+
+ String field = ctx.FIELD().getText().toLowerCase(Locale.ROOT);
+
+ // Pseudo-fields
+ field = switch (field) {
+ case "key" -> InternalField.KEY_FIELD.getName();
+ case "anykeyword" -> StandardField.KEYWORDS.getName();
+ case "anyfield" -> "any";
+ default -> field;
+ };
+
+ if (ctx.operator() != null) {
+ int operator = ctx.operator().getStart().getType();
+ if (operator != SearchParser.REQUAL && operator != SearchParser.CREEQUAL) {
+ term = term.replace("\\", "\\\\");
+ }
+ }
+
+ if ("any".equals(field)) {
+ return List.of(new SearchQueryNode(Optional.empty(), term));
+ }
+ return List.of(new SearchQueryNode(Optional.of(FieldFactory.parseField(field)), term));
+ }
+}
diff --git a/src/main/java/org/jabref/logic/search/query/SearchToLuceneVisitor.java b/src/main/java/org/jabref/logic/search/query/SearchToLuceneVisitor.java
new file mode 100644
index 00000000000..4f38a0ed1e2
--- /dev/null
+++ b/src/main/java/org/jabref/logic/search/query/SearchToLuceneVisitor.java
@@ -0,0 +1,152 @@
+package org.jabref.logic.search.query;
+
+import java.util.List;
+
+import org.jabref.model.search.LinkedFilesConstants;
+import org.jabref.search.SearchBaseVisitor;
+import org.jabref.search.SearchParser;
+
+import org.apache.lucene.index.Term;
+import org.apache.lucene.search.BooleanClause;
+import org.apache.lucene.search.BooleanQuery;
+import org.apache.lucene.search.MatchNoDocsQuery;
+import org.apache.lucene.search.Query;
+import org.apache.lucene.search.RegexpQuery;
+import org.apache.lucene.search.TermQuery;
+import org.apache.lucene.util.QueryBuilder;
+
+/**
+ * Tests are located in {@link org.jabref.logic.search.query.SearchQueryLuceneConversionTest}.
+ */
+public class SearchToLuceneVisitor extends SearchBaseVisitor {
+
+ private static final List SEARCH_FIELDS = LinkedFilesConstants.PDF_FIELDS;
+
+ private final QueryBuilder queryBuilder;
+
+ public SearchToLuceneVisitor() {
+ this.queryBuilder = new QueryBuilder(LinkedFilesConstants.LINKED_FILES_ANALYZER);
+ }
+
+ @Override
+ public Query visitStart(SearchParser.StartContext ctx) {
+ return visit(ctx.andExpression());
+ }
+
+ @Override
+ public Query visitImplicitAndExpression(SearchParser.ImplicitAndExpressionContext ctx) {
+ List children = ctx.expression().stream().map(this::visit).toList();
+ if (children.size() == 1) {
+ return children.getFirst();
+ }
+ BooleanQuery.Builder builder = new BooleanQuery.Builder();
+ for (Query child : children) {
+ builder.add(child, BooleanClause.Occur.MUST);
+ }
+ return builder.build();
+ }
+
+ @Override
+ public Query visitParenExpression(SearchParser.ParenExpressionContext ctx) {
+ return visit(ctx.andExpression());
+ }
+
+ @Override
+ public Query visitNegatedExpression(SearchParser.NegatedExpressionContext ctx) {
+ Query innerQuery = visit(ctx.expression());
+ if (innerQuery instanceof MatchNoDocsQuery) {
+ return innerQuery;
+ }
+ BooleanQuery.Builder builder = new BooleanQuery.Builder();
+ builder.add(innerQuery, BooleanClause.Occur.MUST_NOT);
+ return builder.build();
+ }
+
+ @Override
+ public Query visitBinaryExpression(SearchParser.BinaryExpressionContext ctx) {
+ Query left = visit(ctx.left);
+ Query right = visit(ctx.right);
+
+ if (left instanceof MatchNoDocsQuery) {
+ return right;
+ }
+ if (right instanceof MatchNoDocsQuery) {
+ return left;
+ }
+
+ BooleanQuery.Builder builder = new BooleanQuery.Builder();
+
+ if (ctx.bin_op.getType() == SearchParser.AND) {
+ builder.add(left, BooleanClause.Occur.MUST);
+ builder.add(right, BooleanClause.Occur.MUST);
+ } else if (ctx.bin_op.getType() == SearchParser.OR) {
+ builder.add(left, BooleanClause.Occur.SHOULD);
+ builder.add(right, BooleanClause.Occur.SHOULD);
+ }
+
+ return builder.build();
+ }
+
+ @Override
+ public Query visitComparisonExpression(SearchParser.ComparisonExpressionContext ctx) {
+ return visit(ctx.comparison());
+ }
+
+ @Override
+ public Query visitComparison(SearchParser.ComparisonContext ctx) {
+ String field = ctx.FIELD() == null ? null : ctx.FIELD().getText();
+ String term = SearchQueryConversion.unescapeSearchValue(ctx.searchValue());
+
+ // unfielded expression
+ if (field == null || "anyfield".equals(field) || "any".equals(field)) {
+ return createMultiFieldQuery(term, ctx.operator());
+ } else if (SEARCH_FIELDS.contains(field)) {
+ return createFieldQuery(field, term, ctx.operator());
+ } else {
+ return new MatchNoDocsQuery();
+ }
+ }
+
+ private Query createMultiFieldQuery(String value, SearchParser.OperatorContext operator) {
+ BooleanQuery.Builder builder = new BooleanQuery.Builder();
+ for (String field : SEARCH_FIELDS) {
+ builder.add(createFieldQuery(field, value, operator), BooleanClause.Occur.SHOULD);
+ }
+ return builder.build();
+ }
+
+ private Query createFieldQuery(String field, String value, SearchParser.OperatorContext operator) {
+ if (operator == null) {
+ return createTermOrPhraseQuery(field, value);
+ }
+
+ return switch (operator.getStart().getType()) {
+ case SearchParser.REQUAL,
+ SearchParser.CREEQUAL ->
+ new RegexpQuery(new Term(field, value));
+ case SearchParser.NEQUAL,
+ SearchParser.NCEQUAL,
+ SearchParser.NEEQUAL,
+ SearchParser.NCEEQUAL ->
+ createNegatedQuery(createTermOrPhraseQuery(field, value));
+ case SearchParser.NREQUAL,
+ SearchParser.NCREEQUAL ->
+ createNegatedQuery(new RegexpQuery(new Term(field, value)));
+ default ->
+ createTermOrPhraseQuery(field, value);
+ };
+ }
+
+ private Query createNegatedQuery(Query query) {
+ BooleanQuery.Builder negatedQuery = new BooleanQuery.Builder();
+ negatedQuery.add(query, BooleanClause.Occur.MUST_NOT);
+ return negatedQuery.build();
+ }
+
+ private Query createTermOrPhraseQuery(String field, String value) {
+ if (value.contains("*") || value.contains("?")) {
+ return new TermQuery(new Term(field, value));
+ }
+ return queryBuilder.createPhraseQuery(field, value);
+ }
+}
diff --git a/src/main/java/org/jabref/logic/search/query/SearchToSqlVisitor.java b/src/main/java/org/jabref/logic/search/query/SearchToSqlVisitor.java
new file mode 100644
index 00000000000..e204ea9de78
--- /dev/null
+++ b/src/main/java/org/jabref/logic/search/query/SearchToSqlVisitor.java
@@ -0,0 +1,552 @@
+package org.jabref.logic.search.query;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.EnumSet;
+import java.util.List;
+import java.util.Locale;
+import java.util.stream.Collectors;
+
+import org.jabref.logic.search.indexing.BibFieldsIndexer;
+import org.jabref.model.entry.field.InternalField;
+import org.jabref.model.entry.field.StandardField;
+import org.jabref.model.search.PostgreConstants;
+import org.jabref.model.search.SearchFlags;
+import org.jabref.model.search.query.SqlQueryNode;
+import org.jabref.search.SearchBaseVisitor;
+import org.jabref.search.SearchParser;
+
+import static org.jabref.model.search.PostgreConstants.ENTRY_ID;
+import static org.jabref.model.search.PostgreConstants.FIELD_NAME;
+import static org.jabref.model.search.PostgreConstants.FIELD_VALUE_LITERAL;
+import static org.jabref.model.search.PostgreConstants.FIELD_VALUE_TRANSFORMED;
+import static org.jabref.model.search.SearchFlags.CASE_INSENSITIVE;
+import static org.jabref.model.search.SearchFlags.CASE_SENSITIVE;
+import static org.jabref.model.search.SearchFlags.EXACT_MATCH;
+import static org.jabref.model.search.SearchFlags.INEXACT_MATCH;
+import static org.jabref.model.search.SearchFlags.NEGATION;
+import static org.jabref.model.search.SearchFlags.REGULAR_EXPRESSION;
+
+/**
+ * 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 {
+
+ 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 EnumSet searchBarFlags;
+ private final String mainTableName;
+ private final String splitValuesTableName;
+ private final List nodes = new ArrayList<>();
+ private int cteCounter = 0;
+
+ public SearchToSqlVisitor(String table, EnumSet searchBarFlags) {
+ this.searchBarFlags = searchBarFlags;
+ this.mainTableName = PostgreConstants.getMainTableSchemaReference(table);
+ this.splitValuesTableName = PostgreConstants.getSplitTableSchemaReference(table);
+ }
+
+ @Override
+ public SqlQueryNode visitStart(SearchParser.StartContext ctx) {
+ SqlQueryNode finalNode = visit(ctx.andExpression());
+
+ StringBuilder sql = new StringBuilder("WITH\n");
+ List params = new ArrayList<>();
+
+ for (SqlQueryNode node : nodes) {
+ sql.append(node.cte()).append(",\n");
+ params.addAll(node.params());
+ }
+
+ // Remove the last comma and newline
+ if (!nodes.isEmpty()) {
+ sql.setLength(sql.length() - 2);
+ }
+
+ sql.append("SELECT * FROM ").append(finalNode.cte()).append(" GROUP BY ").append(ENTRY_ID);
+ params.addAll(finalNode.params());
+
+ return new SqlQueryNode(sql.toString(), params);
+ }
+
+ @Override
+ public SqlQueryNode visitImplicitAndExpression(SearchParser.ImplicitAndExpressionContext ctx) {
+ List children = ctx.expression().stream().map(this::visit).toList();
+
+ if (children.size() == 1) {
+ return children.getFirst();
+ } else {
+ String cte = """
+ cte%d AS (
+ %s
+ )
+ """.formatted(
+ cteCounter,
+ children.stream().map(node -> " SELECT %s FROM %s".formatted(ENTRY_ID, node.cte())).collect(Collectors.joining("\n INTERSECT\n")));
+
+ List params = children.stream().flatMap(node -> node.params().stream()).toList();
+ SqlQueryNode node = new SqlQueryNode(cte, params);
+ nodes.add(node);
+ return new SqlQueryNode("cte" + cteCounter++);
+ }
+ }
+
+ @Override
+ public SqlQueryNode visitParenExpression(SearchParser.ParenExpressionContext ctx) {
+ return visit(ctx.andExpression());
+ }
+
+ @Override
+ public SqlQueryNode visitNegatedExpression(SearchParser.NegatedExpressionContext ctx) {
+ SqlQueryNode subNode = visit(ctx.expression());
+ String cte = """
+ cte%d AS (
+ SELECT %s.%s
+ FROM %s AS %s
+ WHERE %s.%s NOT IN (
+ SELECT %s
+ FROM %s
+ )
+ )
+ """.formatted(
+ cteCounter,
+ MAIN_TABLE, ENTRY_ID,
+ mainTableName, MAIN_TABLE,
+ MAIN_TABLE, ENTRY_ID,
+ ENTRY_ID,
+ subNode.cte());
+
+ SqlQueryNode node = new SqlQueryNode(cte, subNode.params());
+ nodes.add(node);
+ return new SqlQueryNode("cte" + cteCounter++);
+ }
+
+ @Override
+ public SqlQueryNode visitBinaryExpression(SearchParser.BinaryExpressionContext ctx) {
+ SqlQueryNode left = visit(ctx.left);
+ SqlQueryNode right = visit(ctx.right);
+ String operator = ctx.bin_op.getType() == SearchParser.AND ? "INTERSECT" : "UNION";
+
+ String cte = """
+ cte%d AS (
+ SELECT %s
+ FROM %s
+ %s
+ SELECT %s
+ FROM %s
+ )
+ """.formatted(
+ cteCounter,
+ ENTRY_ID,
+ left.cte(),
+ operator,
+ ENTRY_ID,
+ right.cte());
+
+ List params = new ArrayList<>(left.params());
+ params.addAll(right.params());
+
+ SqlQueryNode node = new SqlQueryNode(cte, params);
+ nodes.add(node);
+ return new SqlQueryNode("cte" + cteCounter++);
+ }
+
+ @Override
+ public SqlQueryNode visitComparisonExpression(SearchParser.ComparisonExpressionContext ctx) {
+ return visit(ctx.comparison());
+ }
+
+ @Override
+ public SqlQueryNode visitComparison(SearchParser.ComparisonContext ctx) {
+ EnumSet searchFlags = EnumSet.noneOf(SearchFlags.class);
+ String term = SearchQueryConversion.unescapeSearchValue(ctx.searchValue());
+
+ // unfielded expression
+ if (ctx.FIELD() == null) {
+ // apply search bar flags to unfielded expressions
+ boolean isCaseSensitive = searchBarFlags.contains(CASE_SENSITIVE);
+ if (searchBarFlags.contains(REGULAR_EXPRESSION)) {
+ setFlags(searchFlags, REGULAR_EXPRESSION, isCaseSensitive, false);
+ } else {
+ setFlags(searchFlags, INEXACT_MATCH, isCaseSensitive, false);
+ }
+ return getFieldQueryNode("any", term, searchFlags);
+ }
+
+ // fielded expression
+ String field = ctx.FIELD().getText();
+ int operator = ctx.operator().getStart().getType();
+
+ if (operator == SearchParser.EQUAL || operator == SearchParser.CONTAINS) {
+ setFlags(searchFlags, INEXACT_MATCH, false, false);
+ } else if (operator == SearchParser.CEQUAL) {
+ setFlags(searchFlags, INEXACT_MATCH, true, false);
+ } else if (operator == SearchParser.EEQUAL || operator == SearchParser.MATCHES) {
+ setFlags(searchFlags, EXACT_MATCH, false, false);
+ } else if (operator == SearchParser.CEEQUAL) {
+ setFlags(searchFlags, EXACT_MATCH, true, false);
+ } else if (operator == SearchParser.REQUAL) {
+ setFlags(searchFlags, REGULAR_EXPRESSION, false, false);
+ } else if (operator == SearchParser.CREEQUAL) {
+ setFlags(searchFlags, REGULAR_EXPRESSION, true, false);
+ } else if (operator == SearchParser.NEQUAL) {
+ setFlags(searchFlags, INEXACT_MATCH, false, true);
+ } else if (operator == SearchParser.NCEQUAL) {
+ setFlags(searchFlags, INEXACT_MATCH, true, true);
+ } else if (operator == SearchParser.NEEQUAL) {
+ setFlags(searchFlags, EXACT_MATCH, false, true);
+ } else if (operator == SearchParser.NCEEQUAL) {
+ setFlags(searchFlags, EXACT_MATCH, true, true);
+ } else if (operator == SearchParser.NREQUAL) {
+ setFlags(searchFlags, REGULAR_EXPRESSION, false, true);
+ } else if (operator == SearchParser.NCREEQUAL) {
+ setFlags(searchFlags, REGULAR_EXPRESSION, true, true);
+ }
+
+ return getFieldQueryNode(field.toLowerCase(Locale.ROOT), term, searchFlags);
+ }
+
+ private SqlQueryNode getFieldQueryNode(String field, String term, EnumSet searchFlags) {
+ String sqlOperator = getSqlOperator(searchFlags);
+ String prefixSuffix = searchFlags.contains(INEXACT_MATCH) ? "%" : "";
+
+ if (!searchFlags.contains(REGULAR_EXPRESSION)) {
+ term = escapeTermForSql(term);
+ }
+
+ // Pseudo-fields
+ field = switch (field) {
+ case "key" -> InternalField.KEY_FIELD.getName();
+ case "anykeyword" -> StandardField.KEYWORDS.getName();
+ case "anyfield" -> "any";
+ default -> field;
+ };
+
+ if (ENTRY_ID.toString().equals(field)) {
+ return buildEntryIdQuery(term);
+ } else if ("any".equals(field)) {
+ if (searchFlags.contains(EXACT_MATCH)) {
+ return searchFlags.contains(NEGATION)
+ ? buildExactNegationAnyFieldQuery(sqlOperator, term)
+ : buildExactAnyFieldQuery(sqlOperator, term);
+ } else {
+ return searchFlags.contains(NEGATION)
+ ? buildContainsNegationAnyFieldQuery(sqlOperator, prefixSuffix, term)
+ : buildContainsAnyFieldQuery(sqlOperator, prefixSuffix, term);
+ }
+ } else {
+ if (searchFlags.contains(EXACT_MATCH)) {
+ return searchFlags.contains(NEGATION)
+ ? buildExactNegationFieldQuery(field, sqlOperator, term)
+ : buildExactFieldQuery(field, sqlOperator, term);
+ } else {
+ return searchFlags.contains(NEGATION)
+ ? buildContainsNegationFieldQuery(field, sqlOperator, prefixSuffix, term)
+ : buildContainsFieldQuery(field, sqlOperator, prefixSuffix, term);
+ }
+ }
+ }
+
+ private SqlQueryNode buildEntryIdQuery(String entryId) {
+ String cte = """
+ cte%d AS (
+ SELECT %s
+ FROM %s
+ WHERE %s = ?
+ )
+ """.formatted(cteCounter, ENTRY_ID, mainTableName, ENTRY_ID);
+ SqlQueryNode node = new SqlQueryNode(cte, List.of(entryId));
+ nodes.add(node);
+ return new SqlQueryNode("cte" + cteCounter++);
+ }
+
+ private SqlQueryNode buildContainsAnyFieldQuery(String operator, String prefixSuffix, String term) {
+ String cte = """
+ cte%d AS (
+ SELECT %s.%s
+ FROM %s AS %s
+ WHERE (
+ (%s.%s != '%s') AND ((%s.%s %s ?) OR (%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,
+ MAIN_TABLE, FIELD_VALUE_TRANSFORMED,
+ operator);
+
+ List