feat: support open reference at semantic scholar by brandon-lau0 · Pull Request #13278 · JabRef/jabref

brandon-lau0 · 2025-06-08T02:31:54Z

This PR adds new "Search Semantic Scholar" option to the list of available search engines to allow users to directly link to within Jabref.

The URL is also configurable within the "Search Engine URL Templates" section in the "Web search" tab in Preferences. For example, we add the {author} parameter to search via title and author.

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.

jabref-machine · 2025-06-08T02:32:57Z

Your pull request needs to link an issue correctly.

To ease organizational workflows, please link this pull-request to the issue with syntax as described in https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue:

Linking a pull request to an issue using a keyword

You can link a pull request to an issue by using a supported keyword in the pull request's description or in a commit message.

Examples

✅ Fixes #xyz links pull-request to issue. Merging the PR will close the issue.
✅ Fixes https://github.com/JabRef/jabref/issues/xyz links pull-request to issue. Merging the PR will close the issue.
✅ Fixes https://github.com/Koppor/jabref/issues/xyz links pull-request to issue. Merging the PR will close the issue.
❌ Fixes [#xyz](https://github.com/JabRef/jabref/issues/xyz) links pull-request to issue. Merging the PR will NOT close the issue.

trag-bot · 2025-06-08T02:34:34Z

    EXTRACT_FILE_REFERENCES_OFFLINE(Localization.lang("Extract references from file (offline)"), IconTheme.JabRefIcons.FILE_STAR),
    OPEN_URL(Localization.lang("Open URL or DOI"), IconTheme.JabRefIcons.WWW, KeyBinding.OPEN_URL_OR_DOI),
    SEARCH_SHORTSCIENCE(Localization.lang("Search ShortScience")),
+    SEARCH_GOOGLE_SCHOLAR(Localization.lang("Search Google Scholar")),


The new string 'Search Google Scholar' should be consistent with existing strings and grouped semantically with similar search actions.

trag-bot · 2025-06-08T02:34:48Z

    OPEN_URL(Localization.lang("Open URL or DOI"), IconTheme.JabRefIcons.WWW, KeyBinding.OPEN_URL_OR_DOI),
    SEARCH_SHORTSCIENCE(Localization.lang("Search ShortScience")),
+    SEARCH_GOOGLE_SCHOLAR(Localization.lang("Search Google Scholar")),
+    SEARCH_SEMANTIC_SCHOLAR(Localization.lang("Search Semantic Scholar")),


The new string 'Search Semantic Scholar' should be consistent with existing strings and grouped semantically with similar search actions.

trag-bot · 2025-06-08T02:34:49Z

    SEARCH_SHORTSCIENCE(Localization.lang("Search ShortScience")),
+    SEARCH_GOOGLE_SCHOLAR(Localization.lang("Search Google Scholar")),
+    SEARCH_SEMANTIC_SCHOLAR(Localization.lang("Search Semantic Scholar")),
+    SEARCH(Localization.lang("Search...")),


The new string 'Search...' should be consistent with existing strings and grouped semantically with similar search actions.

trag-bot · 2025-06-08T02:35:58Z

 import org.jabref.gui.specialfields.SpecialFieldMenuItemFactory;
 import org.jabref.logic.citationstyle.CitationStyleOutputFormat;
 import org.jabref.logic.citationstyle.CitationStylePreviewLayout;
+import org.jabref.logic.importer.ImporterPreferences;


The ImporterPreferences import is added but not used in the patch. Unused imports should be removed to maintain clean code.

trag-bot · 2025-06-08T02:37:53Z

+            final List<BibEntry> bibEntries = stateManager.getSelectedEntries();
+
+            if (bibEntries.size() != 1) {
+                dialogService.notify(Localization.lang("This operation requires exactly one item to be selected."));


The notification message should be in sentence case, not title case, to maintain consistency with other user interface texts.

trag-bot · 2025-06-08T02:37:54Z

+                try {
+                    NativeDesktop.openExternalViewer(databaseContext, preferences, url, StandardField.URL, dialogService, bibEntries.getFirst());
+                } catch (IOException ex) {


The try block covers too many statements. It should be minimized to cover only the statement that might throw the IOException.

trag-bot · 2025-06-08T02:38:57Z

+            final List<BibEntry> bibEntries = stateManager.getSelectedEntries();
+
+            if (bibEntries.size() != 1) {
+                dialogService.notify(Localization.lang("This operation requires exactly one item to be selected."));


The notification message should be in sentence case, not title case, to maintain consistency with other user interface texts.

trag-bot · 2025-06-08T02:38:59Z

+                dialogService.notify(Localization.lang("This operation requires exactly one item to be selected."));
+                return;
+            }
+            externalLinkCreator.getGoogleScholarSearchURL(bibEntries.getFirst()).ifPresent(url -> {


The method getGoogleScholarSearchURL should not return null. It should return an Optional to avoid null checks and improve code safety.

trag-bot · 2025-06-08T02:38:59Z

+                try {
+                    NativeDesktop.openExternalViewer(databaseContext, preferences, url, StandardField.URL, dialogService, bibEntries.getFirst());
+                } catch (IOException ex) {


The try block covers too many statements. It should be minimized to only cover the statement that might throw the IOException.

jabref-machine · 2025-06-08T02:40:11Z

JUnit tests of jablib are failing. You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page. To see the test output, locate "Tests / Unit tests (pull_request)" and click on it.

You can then run these tests in IntelliJ to reproduce the failing tests locally. We offer a quick test running howto in the section Final build system checks in our setup guide.

trag-bot · 2025-06-08T02:40:34Z

                return;
            }
-            ExternalLinkCreator.getShortScienceSearchURL(bibEntries.getFirst()).ifPresent(url -> {
+            externalLinkCreator.getShortScienceSearchURL(bibEntries.getFirst()).ifPresent(url -> {


The try block covers too many statements. It should only cover the statement that might throw an IOException to improve readability and maintainability.

trag-bot · 2025-06-08T02:40:35Z

+            final List<BibEntry> bibEntries = stateManager.getSelectedEntries();
+
+            if (bibEntries.size() != 1) {
+                dialogService.notify(Localization.lang("This operation requires exactly one item to be selected."));


The notification message should be in sentence case, not title case, to maintain consistency with other user interface texts.

trag-bot · 2025-06-08T02:41:50Z

                return;
            }
-            ExternalLinkCreator.getShortScienceSearchURL(bibEntries.getFirst()).ifPresent(url -> {
+            externalLinkCreator.getShortScienceSearchURL(bibEntries.getFirst()).ifPresent(url -> {


The try block covers too many statements, which can make it harder to identify the exact source of an exception. It should cover as few statements as possible.

trag-bot · 2025-06-08T02:45:21Z

        }
+
+        // Save custom URL templates to preferences
+        Map<String, String> templates = searchEngines.stream()


Using Collectors.toMap without handling duplicate keys can lead to runtime exceptions. Ensure that duplicate keys are handled appropriately.

trag-bot · 2025-06-08T02:50:37Z

+                    author.ifPresent(a -> uriBuilder.addParameter("author", a));
+                    return uriBuilder.toString();
+                } catch (URISyntaxException ex) {
+                    throw new AssertionError("ShortScience URL is invalid.", ex);


Using exceptions for control flow is not recommended. Instead, handle the exception in a way that does not rely on throwing an AssertionError for normal operations.

trag-bot · 2025-06-08T02:50:38Z

+                    author.ifPresent(a -> uriBuilder.addParameter("author", a));
+                    return uriBuilder.toString();
+                } catch (URISyntaxException ex) {
+                    throw new AssertionError("Default Google Scholar URL is invalid.", ex);


Using exceptions for control flow is not recommended. Instead, handle the exception in a way that does not rely on throwing an AssertionError for normal operations.

trag-bot · 2025-06-08T02:50:53Z

+                    author.ifPresent(a -> uriBuilder.addParameter("author", a));
+                    return uriBuilder.toString();
+                } catch (URISyntaxException ex) {
+                    throw new AssertionError("Default Semantic Scholar URL is invalid.", ex);


Using exceptions for control flow is not recommended. Instead, handle the exception in a way that does not rely on throwing an AssertionError for normal operations.

trag-bot · 2025-06-08T02:50:54Z

+                    author.ifPresent(a -> uriBuilder.addParameter("author", a));
+                    return uriBuilder.toString();
+                } catch (URISyntaxException ex) {
+                    throw new AssertionError("ShortScience URL is invalid.", ex);


Using exceptions for control flow is not recommended. Exceptions should be reserved for truly exceptional conditions, not for normal control flow.

trag-bot · 2025-06-08T02:51:01Z

+                    author.ifPresent(a -> uriBuilder.addParameter("author", a));
+                    return uriBuilder.toString();
+                } catch (URISyntaxException ex) {
+                    throw new AssertionError("Default Google Scholar URL is invalid.", ex);


Using exceptions for control flow is not recommended. Exceptions should be reserved for truly exceptional conditions, not for normal control flow.

trag-bot · 2025-06-08T02:51:03Z

+                    author.ifPresent(a -> uriBuilder.addParameter("author", a));
+                    return uriBuilder.toString();
+                } catch (URISyntaxException ex) {
+                    throw new AssertionError("Default Semantic Scholar URL is invalid.", ex);


Using exceptions for control flow is not recommended. Exceptions should be reserved for truly exceptional conditions, not for normal control flow.

trag-bot · 2025-06-08T02:59:08Z

 package org.jabref.logic.util;

 import java.net.MalformedURLException;
+import java.util.Collections;


The import statement for Collections is unnecessary as the code should use List.of() for creating empty lists instead of Collections.emptyList().

trag-bot · 2025-06-08T02:59:09Z


 import java.net.MalformedURLException;
+import java.util.Collections;
+import java.util.List;


The import statement for List is unnecessary as the code should use List.of() for creating empty lists instead of Collections.emptyList().

koppor · 2025-06-08T08:34:57Z

Follow up at #13153

@brandon-lau0 please, just push to your branch and do not create a new PR. New PRs cost time on our side and reduce time to give feedback.

brandon-lau0 added 11 commits June 7, 2025 17:35

feat: support searching via google scholar

3ddf7aa

feat: move search short science and google scholar under search sub-menu

9deeb9c

feat: allow shortscience and googlescholar search to be configurable

eab0d25

feat: update change log

667308a

feat: fix tests

9f06f1b

feat: fix import errors

2a33b4e

test to use List.of()

d5b7033

fix import err

2d65f10

fix merge conflicts and external link creator tests

eade1cf

fix test to use mock for importerpreferences

8463aeb

support semantic scholar search engine

bd0e67b

brandon-lau0 marked this pull request as ready for review June 8, 2025 02:32

brandon-lau0 changed the title ~~Semantic scholar search option 2~~ feat: support open reference at semantic scholar Jun 8, 2025

trag-bot Bot reviewed Jun 8, 2025

View reviewed changes

brandon-lau0 closed this Jun 8, 2025

trag-bot Bot reviewed Jun 8, 2025

View reviewed changes

Uh oh!

Conversation

brandon-lau0 commented Jun 8, 2025

Mandatory checks

Uh oh!

jabref-machine commented Jun 8, 2025

Linking a pull request to an issue using a keyword

Examples

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

jabref-machine commented Jun 8, 2025

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot Bot Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

koppor commented Jun 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects