Web Import: Add New Entries to 'Imported Entries' Group (#12998)

* Add field to configure imported entries group under web search preference

* Add 'Import entries' group feature for web import entries

* Add few test case

* Add JabRef_en.properties entry and revert access modifier

* Fix methods in test

* Add CHANGELOG.md entry

* Refactor method for storing and setting group name

---------

Co-authored-by: Christoph <[email protected]>

Author: paudelritij

CHANGELOG.md

@@ -19,6 +19,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We added [LOBID](https://lobid.org/) as an alternative ISBN-Fetcher. [#13076](https://github.com/JabRef/jabref/issues/13076)
 - We added a success dialog when using the "Copy to" option, indicating whether the entry was successfully copied and specifying if a cross-reference entry was included. [#12486](https://github.com/JabRef/jabref/issues/12486)
 - We added a new button to toggle the file path between an absolute and relative formats in context of library properties. [#13031](https://github.com/JabRef/jabref/issues/13031)
+- We introduced user-configurable group 'Imported entries' for automatic import of entries from web search, PDF import and web fetchers. [#12548](https://github.com/JabRef/jabref/issues/12548)
 - We added automatic selection of the “Enter Identifier” tab with pre-filled clipboard content if the clipboard contains a valid identifier when opening the “Create New Entry” dialog. [#13087](https://github.com/JabRef/jabref/issues/13087)
 - We added an "Open example library" button to Welcome Tab. [#13014](https://github.com/JabRef/jabref/issues/13014)
 - We added automatic detection and selection of the identifier type (e.g., DOI, ISBN, arXiv) based on clipboard content when opening the "New Entry" dialog [#13111](https://github.com/JabRef/jabref/pull/13111)

jabgui/src/main/java/org/jabref/gui/externalfiles/ImportHandler.java

@@ -56,6 +56,7 @@
 import org.jabref.model.entry.field.StandardField;
 import org.jabref.model.groups.GroupEntryChanger;
 import org.jabref.model.groups.GroupTreeNode;
+import org.jabref.model.groups.SmartGroup;
 import org.jabref.model.util.FileUpdateMonitor;
 import org.jabref.model.util.OptionalUtil;
 
@@ -164,6 +165,7 @@ public List<ImportFilesResultItemViewModel> call() {
                                     // Modifiers do not work on macOS: https://bugs.openjdk.org/browse/JDK-8264172
                                     // Similar code as org.jabref.gui.preview.PreviewPanel.PreviewPanel
                                     DragDrop.handleDropOfFiles(List.of(file), transferMode, fileLinker, entry);
+                                    addToImportEntriesGroup(pdfEntriesInFile);
                                     entriesToAdd.addAll(pdfEntriesInFile);
                                     addResultToList(file, true, Localization.lang("File was successfully imported as a new entry"));
                                 });
@@ -267,6 +269,7 @@ private void importEntryWithDuplicateCheck(BibDatabaseContext bibDatabaseContext
                               finalEntry = duplicateHandledEntry.get();
                           }
                           importCleanedEntries(bibDatabaseContext, List.of(finalEntry));
+                          addToImportEntriesGroup(List.of(finalEntry));
                           downloadLinkedFiles(finalEntry);
                           BibEntry entryToFocus = finalEntry;
                           stateManager.activeTabProperty().get().ifPresent(tab -> tab.clearAndSelect(entryToFocus));
@@ -510,4 +513,17 @@ private List<BibEntry> handlePdfUrl(String pdfUrl) throws IOException {
             return List.of();
         }
     }
+
+    private void addToImportEntriesGroup(List<BibEntry> entriesToInsert) {
+        if (preferences.getLibraryPreferences().isAddImportedEntriesEnabled()) {
+            // Only one SmartGroup
+            this.bibDatabaseContext.getMetaData()
+                                   .getGroups()
+                                   .flatMap(grp -> grp.getChildren()
+                                                      .stream()
+                                                      .filter(node -> node.getGroup() instanceof SmartGroup)
+                                                      .findFirst())
+                                   .ifPresent(smtGrp -> smtGrp.addEntriesToGroup(entriesToInsert));
+        }
+    }
 }

jabgui/src/main/java/org/jabref/gui/groups/GroupDescriptions.java

@@ -4,6 +4,7 @@
 import org.jabref.model.groups.ExplicitGroup;
 import org.jabref.model.groups.KeywordGroup;
 import org.jabref.model.groups.SearchGroup;
+import org.jabref.model.groups.SmartGroup;
 import org.jabref.model.strings.StringUtil;
 
 public class GroupDescriptions {
@@ -61,6 +62,10 @@ public static String getShortDescriptionAllEntriesGroup() {
         return Localization.lang("<b>All Entries</b> (this group cannot be edited or removed)");
     }
 
+    public static String getShortDescriptionSmartGroup(SmartGroup smartGroup) {
+        return Localization.lang("<b>Smart Group</b> (Import Entries)");
+    }
+
     public static String getShortDescription(SearchGroup searchGroup, boolean showDynamic) {
         StringBuilder sb = new StringBuilder();
         sb.append("<b>");

jabgui/src/main/java/org/jabref/gui/groups/GroupNodeViewModel.java

@@ -46,6 +46,7 @@
 import org.jabref.model.groups.LastNameGroup;
 import org.jabref.model.groups.RegexKeywordGroup;
 import org.jabref.model.groups.SearchGroup;
+import org.jabref.model.groups.SmartGroup;
 import org.jabref.model.groups.TexGroup;
 import org.jabref.model.search.event.IndexAddedOrUpdatedEvent;
 import org.jabref.model.search.event.IndexClosedEvent;
@@ -432,6 +433,8 @@ public boolean canAddEntriesIn() {
         AbstractGroup group = groupNode.getGroup();
         if (group instanceof AllEntriesGroup) {
             return false;
+        } else if (group instanceof SmartGroup) {
+            return false;
         } else if (group instanceof ExplicitGroup) {
             return true;
         } else if (group instanceof LastNameGroup || group instanceof RegexKeywordGroup) {
@@ -458,7 +461,7 @@ public boolean canAddEntriesIn() {
     public boolean canBeDragged() {
         AbstractGroup group = groupNode.getGroup();
         return switch (group) {
-            case AllEntriesGroup _ -> false;
+            case AllEntriesGroup _, SmartGroup _ -> false;
             case ExplicitGroup _, SearchGroup _, AutomaticKeywordGroup _, AutomaticPersonsGroup _, TexGroup _ -> true;
             case KeywordGroup _ ->
                 // KeywordGroup is parent of LastNameGroup, RegexKeywordGroup and WordKeywordGroup
@@ -477,13 +480,13 @@ public boolean canAddGroupsIn() {
         AbstractGroup group = groupNode.getGroup();
         return switch (group) {
             case AllEntriesGroup _, ExplicitGroup _, SearchGroup _, TexGroup _ -> true;
+            case AutomaticKeywordGroup _, AutomaticPersonsGroup _, SmartGroup _ -> false;
             case KeywordGroup _ ->
                 // KeywordGroup is parent of LastNameGroup, RegexKeywordGroup and WordKeywordGroup
                     groupNode.getParent()
                             .map(GroupTreeNode::getGroup)
                             .map(groupParent -> !(groupParent instanceof AutomaticKeywordGroup || groupParent instanceof AutomaticPersonsGroup))
                             .orElse(false);
-            case AutomaticKeywordGroup _, AutomaticPersonsGroup _ -> false;
             case null -> throw new IllegalArgumentException("Group cannot be null");
             default -> throw new UnsupportedOperationException("canAddGroupsIn method not yet implemented in group: " + group.getClass().getName());
         };
@@ -492,7 +495,7 @@ public boolean canAddGroupsIn() {
     public boolean canRemove() {
         AbstractGroup group = groupNode.getGroup();
         return switch (group) {
-            case AllEntriesGroup _ -> false;
+            case AllEntriesGroup _, SmartGroup _ -> false;
             case ExplicitGroup _, SearchGroup _, AutomaticKeywordGroup _, AutomaticPersonsGroup _, TexGroup _ -> true;
             case KeywordGroup _ ->
                 // KeywordGroup is parent of LastNameGroup, RegexKeywordGroup and WordKeywordGroup
@@ -508,7 +511,7 @@ public boolean canRemove() {
     public boolean isEditable() {
         AbstractGroup group = groupNode.getGroup();
         return switch (group) {
-            case AllEntriesGroup _ -> false;
+            case AllEntriesGroup _, SmartGroup _ -> false;
             case ExplicitGroup _, SearchGroup _, AutomaticKeywordGroup _, AutomaticPersonsGroup _, TexGroup _ -> true;
             case KeywordGroup _ ->
                 // KeywordGroup is parent of LastNameGroup, RegexKeywordGroup and WordKeywordGroup

jabgui/src/main/java/org/jabref/gui/groups/GroupTreeNodeViewModel.java

@@ -17,6 +17,7 @@
 import org.jabref.model.groups.GroupTreeNode;
 import org.jabref.model.groups.KeywordGroup;
 import org.jabref.model.groups.SearchGroup;
+import org.jabref.model.groups.SmartGroup;
 
 public class GroupTreeNodeViewModel {
     private final GroupTreeNode node;
@@ -51,6 +52,8 @@ public String getDescription() {
         String shortDescription = "";
         boolean showDynamic = true;
         shortDescription = switch (group) {
+            case SmartGroup smartGroup ->
+                    GroupDescriptions.getShortDescriptionSmartGroup(smartGroup);
             case ExplicitGroup explicitGroup ->
                     GroupDescriptions.getShortDescriptionExplicitGroup(explicitGroup);
             case KeywordGroup keywordGroup ->

jabgui/src/main/java/org/jabref/gui/groups/GroupTreeViewModel.java

@@ -37,9 +37,11 @@
 import org.jabref.model.groups.AutomaticKeywordGroup;
 import org.jabref.model.groups.AutomaticPersonsGroup;
 import org.jabref.model.groups.ExplicitGroup;
+import org.jabref.model.groups.GroupHierarchyType;
 import org.jabref.model.groups.GroupTreeNode;
 import org.jabref.model.groups.RegexKeywordGroup;
 import org.jabref.model.groups.SearchGroup;
+import org.jabref.model.groups.SmartGroup;
 import org.jabref.model.groups.TexGroup;
 import org.jabref.model.groups.WordKeywordGroup;
 import org.jabref.model.metadata.MetaData;
@@ -176,6 +178,29 @@ private void onActiveDatabaseChanged(Optional<BibDatabaseContext> newDatabase) {
             rootGroup.setValue(null);
         }
         currentDatabase = newDatabase;
+        newDatabase.ifPresent(db -> addGroupImportEntries(rootGroup.get()));
+    }
+
+    private void addGroupImportEntries(GroupNodeViewModel parent) {
+        if (!preferences.getLibraryPreferences().isAddImportedEntriesEnabled()) {
+            return;
+        }
+
+        String grpName = preferences.getLibraryPreferences().getAddImportedEntriesGroupName();
+        AbstractGroup importEntriesGroup = new SmartGroup(grpName, GroupHierarchyType.INDEPENDENT, ',');
+        boolean isGrpExist = parent.getGroupNode()
+                                 .getChildren()
+                                 .stream()
+                                 .map(GroupTreeNode::getGroup)
+                                 .anyMatch(grp -> grp instanceof SmartGroup);
+        if (!isGrpExist) {
+            currentDatabase.ifPresent(db -> {
+                GroupTreeNode newSubgroup = parent.addSubgroup(importEntriesGroup);
+                newSubgroup.moveTo(parent.getGroupNode(), 0);
+                selectedGroups.setAll(new GroupNodeViewModel(db, stateManager, taskExecutor, newSubgroup, localDragboard, preferences));
+                writeGroupChangesToMetaData();
+            });
+        }
     }
 
     /**

jabgui/src/main/java/org/jabref/gui/preferences/websearch/WebSearchTab.java

@@ -33,6 +33,8 @@ public class WebSearchTab extends AbstractPreferenceTabView<WebSearchTabViewMode
     @FXML private CheckBox warnAboutDuplicatesOnImport;
     @FXML private CheckBox downloadLinkedOnlineFiles;
     @FXML private CheckBox keepDownloadUrl;
+    @FXML private CheckBox addImportedEntries;
+    @FXML private TextField addImportedEntriesGroupName;
     @FXML private ComboBox<PlainCitationParserChoice> defaultPlainCitationParser;
 
     @FXML private CheckBox useCustomDOI;
@@ -76,6 +78,10 @@ public void initialize() {
         downloadLinkedOnlineFiles.selectedProperty().bindBidirectional(viewModel.shouldDownloadLinkedOnlineFiles());
         keepDownloadUrl.selectedProperty().bindBidirectional(viewModel.shouldKeepDownloadUrl());
 
+        addImportedEntries.selectedProperty().bindBidirectional(viewModel.getAddImportedEntries());
+        addImportedEntriesGroupName.textProperty().bindBidirectional(viewModel.getAddImportedEntriesGroupName());
+        addImportedEntriesGroupName.disableProperty().bind(addImportedEntries.selectedProperty().not());
+
         new ViewModelListCellFactory<PlainCitationParserChoice>()
                 .withText(PlainCitationParserChoice::getLocalizedName)
                 .install(defaultPlainCitationParser);

jabgui/src/main/java/org/jabref/gui/preferences/websearch/WebSearchTabViewModel.java

@@ -21,6 +21,7 @@
 import org.jabref.gui.preferences.PreferenceTabViewModel;
 import org.jabref.gui.slr.StudyCatalogItem;
 import org.jabref.logic.FilePreferences;
+import org.jabref.logic.LibraryPreferences;
 import org.jabref.logic.importer.ImportFormatPreferences;
 import org.jabref.logic.importer.ImporterPreferences;
 import org.jabref.logic.importer.SearchBasedFetcher;
@@ -48,6 +49,9 @@ public class WebSearchTabViewModel implements PreferenceTabViewModel {
             new SimpleListProperty<>(FXCollections.observableArrayList(PlainCitationParserChoice.values()));
     private final ObjectProperty<PlainCitationParserChoice> defaultPlainCitationParser = new SimpleObjectProperty<>();
 
+    private final BooleanProperty addImportedEntries = new SimpleBooleanProperty();
+    private final StringProperty addImportedEntriesGroupName = new SimpleStringProperty("");
+
     private final BooleanProperty useCustomDOIProperty = new SimpleBooleanProperty();
     private final StringProperty useCustomDOINameProperty = new SimpleStringProperty("");
 
@@ -67,6 +71,7 @@ public class WebSearchTabViewModel implements PreferenceTabViewModel {
     private final ImporterPreferences importerPreferences;
     private final FilePreferences filePreferences;
     private final ImportFormatPreferences importFormatPreferences;
+    private final LibraryPreferences libraryPreferences;
 
     private final ReadOnlyBooleanProperty refAiEnabled;
 
@@ -78,6 +83,7 @@ public WebSearchTabViewModel(CliPreferences preferences, DialogService dialogSer
         this.doiPreferences = preferences.getDOIPreferences();
         this.filePreferences = preferences.getFilePreferences();
         this.importFormatPreferences = preferences.getImportFormatPreferences();
+        this.libraryPreferences = preferences.getLibraryPreferences();
 
         this.refAiEnabled = refAiEnabled;
 
@@ -128,6 +134,8 @@ public void setValues() {
         warnAboutDuplicatesOnImportProperty.setValue(importerPreferences.shouldWarnAboutDuplicatesOnImport());
         shouldDownloadLinkedOnlineFiles.setValue(filePreferences.shouldDownloadLinkedFiles());
         shouldkeepDownloadUrl.setValue(filePreferences.shouldKeepDownloadUrl());
+        addImportedEntries.setValue(libraryPreferences.isAddImportedEntriesEnabled());
+        addImportedEntriesGroupName.setValue(libraryPreferences.getAddImportedEntriesGroupName());
         defaultPlainCitationParser.setValue(importerPreferences.getDefaultPlainCitationParser());
 
         useCustomDOIProperty.setValue(doiPreferences.isUseCustom());
@@ -159,7 +167,14 @@ public void storeSettings() {
         importerPreferences.setWarnAboutDuplicatesOnImport(warnAboutDuplicatesOnImportProperty.getValue());
         filePreferences.setDownloadLinkedFiles(shouldDownloadLinkedOnlineFiles.getValue());
         filePreferences.setKeepDownloadUrl(shouldkeepDownloadUrl.getValue());
+        libraryPreferences.setAddImportedEntries(addImportedEntries.getValue());
+        if (addImportedEntriesGroupName.getValue().isEmpty() || addImportedEntriesGroupName.getValue().startsWith(" ")) {
+            libraryPreferences.setAddImportedEntriesGroupName(Localization.lang("Imported entries"));
+        } else {
+            libraryPreferences.setAddImportedEntriesGroupName(addImportedEntriesGroupName.getValue());
+        }
         importerPreferences.setDefaultPlainCitationParser(defaultPlainCitationParser.getValue());
+
         grobidPreferences.setGrobidEnabled(grobidEnabledProperty.getValue());
         grobidPreferences.setGrobidUseAsked(grobidPreferences.isGrobidUseAsked());
         grobidPreferences.setGrobidURL(grobidURLProperty.getValue());
@@ -189,6 +204,14 @@ public ObjectProperty<PlainCitationParserChoice> defaultPlainCitationParserPrope
         return defaultPlainCitationParser;
     }
 
+    public BooleanProperty getAddImportedEntries() {
+        return addImportedEntries;
+    }
+
+    public StringProperty getAddImportedEntriesGroupName() {
+        return addImportedEntriesGroupName;
+    }
+
     public BooleanProperty useCustomDOIProperty() {
         return this.useCustomDOIProperty;
     }

jabgui/src/main/resources/org/jabref/gui/preferences/websearch/WebSearchTab.fxml

@@ -21,6 +21,10 @@
     <CheckBox fx:id="warnAboutDuplicatesOnImport" text="%Warn about duplicates on import"/>
     <CheckBox fx:id="downloadLinkedOnlineFiles" text="%Download referenced files (PDFs, ...)"/>
     <CheckBox fx:id="keepDownloadUrl" text="%Store url for downloaded file" />
+    <HBox alignment="CENTER_LEFT" spacing="10.0">
+        <CheckBox fx:id="addImportedEntries" text="%Add imported entries to group"/>
+        <TextField fx:id="addImportedEntriesGroupName" HBox.hgrow="ALWAYS"/>
+    </HBox>
     <HBox alignment="BASELINE_LEFT" spacing="10">
         <Label text="%Default plain citation parser"/>
         <ComboBox fx:id="defaultPlainCitationParser" HBox.hgrow="ALWAYS"/>

jabgui/src/test/java/org/jabref/gui/groups/GroupTreeViewModelTest.java

@@ -1,13 +1,15 @@
 package org.jabref.gui.groups;
 
 import java.util.EnumSet;
+import java.util.List;
 import java.util.Optional;
 
 import org.jabref.gui.DialogService;
 import org.jabref.gui.StateManager;
 import org.jabref.gui.entryeditor.AdaptVisibleTabs;
 import org.jabref.gui.preferences.GuiPreferences;
 import org.jabref.gui.util.CustomLocalDragboard;
+import org.jabref.logic.LibraryPreferences;
 import org.jabref.logic.ai.AiService;
 import org.jabref.logic.util.CurrentThreadTaskExecutor;
 import org.jabref.logic.util.TaskExecutor;
@@ -48,6 +50,13 @@ void setUp() {
         preferences = mock(GuiPreferences.class);
         dialogService = mock(DialogService.class, Answers.RETURNS_DEEP_STUBS);
 
+        when(preferences.getLibraryPreferences()).thenReturn(new LibraryPreferences(
+                databaseContext.getMode(),
+                false,
+                false,
+                false,
+                "Imported entries"
+        ));
         when(preferences.getGroupsPreferences()).thenReturn(new GroupsPreferences(
                 EnumSet.noneOf(GroupViewMode.class),
                 true,
@@ -185,4 +194,27 @@ void shouldNotAddSuggestedGroupsWhenAllExist() {
         assertEquals(2, rootGroup.getChildren().size());
         assertTrue(rootGroup.hasAllSuggestedGroups());
     }
+
+    @Test
+    void shouldCreateImportedEntriesGroupWhenEnabled() {
+        preferences.getLibraryPreferences().setAddImportedEntries(true);
+
+        List<GroupNodeViewModel> prevModel = groupTree.rootGroupProperty().getValue().getChildren();
+        GroupTreeViewModel model = new GroupTreeViewModel(stateManager, dialogService, mock(AiService.class), preferences, mock(AdaptVisibleTabs.class), taskExecutor, new CustomLocalDragboard());
+        String actualGrpName = model.rootGroupProperty().getValue().getChildren().getFirst().getDisplayName();
+
+        assertEquals(0, prevModel.size());
+        assertEquals("Imported entries", actualGrpName);
+    }
+
+    @Test
+    void shouldReflectUpdatedNameForImportedEntriesGroup() {
+        preferences.getLibraryPreferences().setAddImportedEntries(true);
+        preferences.getLibraryPreferences().setAddImportedEntriesGroupName("Review list");
+
+        GroupTreeViewModel model = new GroupTreeViewModel(stateManager, dialogService, mock(AiService.class), preferences, mock(AdaptVisibleTabs.class), taskExecutor, new CustomLocalDragboard());
+        String actualGrpName = model.rootGroupProperty().getValue().getChildren().getFirst().getDisplayName();
+
+        assertEquals("Review list", actualGrpName);
+    }
 }