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

paudelritij · 2025-04-25T00:36:58Z

Closes #12548
This PR introduce feature to add new group "Imported Entries"

Introduce Smart Group
Create configurable field for "Imported entries" group (under web search preferences)
Sync configuration with group-tree (for enable/disable or name-change of group)
Configure entries (web search / PDF import /web fetchers) to be auto-import
Add a few test cases

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (if change is visible to the user)
Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

…ence

…r-issue-12548

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

trag-bot · 2025-05-04T12:41:35Z

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

@@ -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) {


The method getShortDescriptionSmartGroup returns a String, which could potentially be null. New public methods should not return null and should use java.util.Optional instead.

trag-bot · 2025-05-04T12:41:44Z

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

@@ -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)");


The string 'Smart Group' should be in sentence case as per the guidelines, so it should be 'Smart group'.

trag-bot · 2025-05-04T12:43:06Z

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;


The code uses Java SWING imports, which contradicts the instruction to use only JavaFX for UI technology. This could lead to inconsistencies in the UI framework used.

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

trag-bot · 2025-05-04T12:46:27Z

jablib/src/main/java/org/jabref/logic/exporter/GroupSerializer.java

@@ -26,6 +27,19 @@ private static String serializeAllEntriesGroup() {
        return MetadataSerializationConfiguration.ALL_ENTRIES_GROUP_ID;
    }

+    private String serializeSmartGroup(SmartGroup group) {


The method serializeSmartGroup is private and returns a String. If this method is intended to be used externally, it should return an Optional instead of null, following modern Java practices.

trag-bot · 2025-05-04T12:47:27Z

jablib/src/main/java/org/jabref/logic/importer/util/GroupsParser.java

@@ -206,6 +210,24 @@ private static KeywordGroup keywordGroupFromString(String s, Character keywordSe
        return newGroup;
    }

+    private static SmartGroup smartGroupFromString(String input, Character keywordSeparator) throws ParseException {
+        if (!input.startsWith(MetadataSerializationConfiguration.SMART_GROUP_ID)) {


Using exceptions for control flow is not recommended. Instead of throwing an IllegalArgumentException, consider using a different approach to handle this condition.

trag-bot · 2025-05-04T12:48:28Z

jablib/src/main/java/org/jabref/logic/exporter/GroupSerializer.java

@@ -26,6 +27,19 @@ private static String serializeAllEntriesGroup() {
        return MetadataSerializationConfiguration.ALL_ENTRIES_GROUP_ID;
    }

+    private String serializeSmartGroup(SmartGroup group) {


The method serializeSmartGroup is private and returns a String. According to the special instructions, new public methods should not return null and should use java.util.Optional. Consider making this method public and returning Optional.

trag-bot · 2025-05-04T12:49:34Z

jablib/src/main/java/org/jabref/logic/importer/util/GroupsParser.java

@@ -206,6 +210,24 @@ private static KeywordGroup keywordGroupFromString(String s, Character keywordSe
        return newGroup;
    }

+    private static SmartGroup smartGroupFromString(String input, Character keywordSeparator) throws ParseException {


The method 'smartGroupFromString' throws a ParseException for normal control flow when parsing context fails. Exceptions should be used for exceptional states, not for normal control flow.

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

trag-bot · 2025-05-07T16:27:24Z

jablib/src/main/java/org/jabref/logic/LibraryPreferences.java

+        this.addImportedEntries.set(addImportedEntries);
+    }
+
+    public String getAddImportedEntriesGroupName() {


The method should return an Optional instead of a potentially null String to prevent null-related issues and align with modern Java practices.

trag-bot · 2025-05-07T16:28:01Z

jablib/src/main/java/org/jabref/logic/importer/util/GroupsParser.java

@@ -206,6 +210,24 @@ private static KeywordGroup keywordGroupFromString(String s, Character keywordSe
        return newGroup;
    }

+    private static SmartGroup smartGroupFromString(String input, Character keywordSeparator) throws ParseException {
+        if (!input.startsWith(MetadataSerializationConfiguration.SMART_GROUP_ID)) {
+            throw new IllegalArgumentException("SmartGroup cannot be created from \"" + input + "\".");


Avoid using exceptions for normal control flow. Consider using a different approach to handle this condition.

jablib/src/main/java/org/jabref/logic/util/MetadataSerializationConfiguration.java

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

trag-bot · 2025-05-10T09:04:32Z

@trag-bot didn't find any issues in the code! ✅✨

Add field to configure imported entries group under web search prefer…

2732800

…ence

paudelritij closed this May 4, 2025

paudelritij force-pushed the fix-for-issue-12548 branch from 2732800 to d9ea011 Compare May 4, 2025 04:20

paudelritij added 3 commits May 4, 2025 13:54

Merge remote-tracking branch 'origin/fix-for-issue-12548' into fix-fo…

badbb25

…r-issue-12548

Merge remote-tracking branch 'origin/fix-for-issue-12548' into fix-fo…

878b42c

…r-issue-12548

Add 'Import entries' group feature for web import entries

91575ba

paudelritij reopened this May 4, 2025

trag-bot bot reviewed May 4, 2025

View reviewed changes

jabgui/src/main/java/org/jabref/gui/externalfiles/ImportHandler.java Outdated Show resolved Hide resolved

trag-bot bot reviewed May 4, 2025

View reviewed changes

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

trag-bot bot reviewed May 4, 2025

View reviewed changes

paudelritij added 4 commits May 6, 2025 23:30

Merge branch 'JabRef:main' into fix-for-issue-12548

6697a64

Add few test case

152cfed

Add JabRef_en.properties entry and revert access modifier

46dec7a

Merge branch 'JabRef:main' into fix-for-issue-12548

571d436

paudelritij marked this pull request as ready for review May 7, 2025 16:17

trag-bot bot reviewed May 7, 2025

View reviewed changes

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

trag-bot bot reviewed May 7, 2025

View reviewed changes

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

trag-bot bot reviewed May 7, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/util/MetadataSerializationConfiguration.java Show resolved Hide resolved

Merge branch 'main' into fix-for-issue-12548

2dd0ed4

trag-bot bot reviewed May 10, 2025

View reviewed changes

jabgui/src/main/java/org/jabref/gui/groups/GroupTreeViewModel.java Show resolved Hide resolved

paudelritij added 2 commits May 10, 2025 16:36

Fix methods in test

1067b99

Add CHANGELOG.md entry

3ac2590

Refactor method for storing and setting group name

e5a9dff

koppor added component: groups status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers labels May 12, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

paudelritij commented Apr 25, 2025 •

edited

Loading

trag-bot bot May 4, 2025

trag-bot bot May 4, 2025

trag-bot bot May 4, 2025

trag-bot bot May 4, 2025

trag-bot bot May 4, 2025

trag-bot bot May 4, 2025

trag-bot bot May 4, 2025

trag-bot bot May 7, 2025

trag-bot bot May 7, 2025

trag-bot bot commented May 10, 2025

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

Are you sure you want to change the base?

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

Conversation

paudelritij commented Apr 25, 2025 • edited Loading

Mandatory checks

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

trag-bot bot May 7, 2025

Choose a reason for hiding this comment

trag-bot bot May 7, 2025

Choose a reason for hiding this comment

trag-bot bot commented May 10, 2025

paudelritij commented Apr 25, 2025 •

edited

Loading