Generate an entry from ID

CHANGELOG.md

@@ -23,7 +23,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
 - We readded the possibility to keep the search string when switching tabs. It is implemented by a toggle button. [#4096](https://github.com/JabRef/jabref/issues/4096#issuecomment-575986882)
 - We allowed the user to also preview the available citation styles in the preferences besides the selected ones [#8108](https://github.com/JabRef/jabref/issues/8108)
 - We added an option to search the available citation styles by name in the preferences [#8108](https://github.com/JabRef/jabref/issues/8108)
-
+- We added an option to generate bib-entries from ID through a popover in the toolbar. [#4183](https://github.com/JabRef/jabref/issues/4183)
 ### Changed
 
 - We slightly changed the layout of the Journal tab in the preferences for ui consistency. [#7937](https://github.com/JabRef/jabref/pull/7937)

src/main/java/org/jabref/gui/JabRefFrame.java

@@ -86,6 +86,8 @@
 import org.jabref.gui.help.ErrorConsoleAction;
 import org.jabref.gui.help.HelpAction;
 import org.jabref.gui.help.SearchForUpdateAction;
+import org.jabref.gui.icon.IconTheme;
+import org.jabref.gui.importer.GenerateEntryFromIdDialog;
 import org.jabref.gui.importer.ImportCommand;
 import org.jabref.gui.importer.ImportEntriesDialog;
 import org.jabref.gui.importer.NewDatabaseAction;
@@ -172,6 +174,7 @@ public class JabRefFrame extends BorderPane {
     private TabPane tabbedPane;
     private SidePane sidePane;
     private PopOver progressViewPopOver;
+    private PopOver entryFromIdPopOver;
 
     private final TaskExecutor taskExecutor;
 
@@ -475,6 +478,8 @@ private Node createToolbar() {
         final Button pushToApplicationButton = factory.createIconButton(pushToApplicationAction.getActionInformation(), pushToApplicationAction);
         pushToApplicationsManager.registerReconfigurable(pushToApplicationButton);
 
+        // Setup Toolbar
+
         ToolBar toolBar = new ToolBar(
 
                 new HBox(
@@ -491,6 +496,7 @@ private Node createToolbar() {
                 new HBox(
                         factory.createIconButton(StandardActions.NEW_ARTICLE, new NewEntryAction(this, StandardEntryType.Article, dialogService, prefs, stateManager)),
                         factory.createIconButton(StandardActions.NEW_ENTRY, new NewEntryAction(this, dialogService, prefs, stateManager)),
+                        createNewEntryFromIdButton(),
                         factory.createIconButton(StandardActions.NEW_ENTRY_FROM_PLAIN_TEXT, new ExtractBibtexAction(dialogService, prefs, stateManager)),
                         factory.createIconButton(StandardActions.DELETE_ENTRY, new EditAction(StandardActions.DELETE_ENTRY, this, stateManager))
                 ),
@@ -906,6 +912,33 @@ private MenuBar createMenu() {
         return menu;
     }
 
+    private Button createNewEntryFromIdButton() {
+        Button newEntryFromIdButton = new Button();
+        newEntryFromIdButton.setGraphic(IconTheme.JabRefIcons.IMPORT.getGraphicNode());
+        newEntryFromIdButton.setStyle("-fx-background-color: transparent;");
+        newEntryFromIdButton.setStyle("-fx-border-color: transparent;");
+        newEntryFromIdButton.setOnMouseClicked(event -> {
+            GenerateEntryFromIdDialog entryFromId = new GenerateEntryFromIdDialog(getCurrentLibraryTab(), dialogService, prefs);
+
+            if (entryFromIdPopOver == null) {
+                entryFromIdPopOver = new PopOver(entryFromId.getDialogPane());
+                entryFromIdPopOver.setTitle(Localization.lang("Entry From ID"));
+                entryFromIdPopOver.setArrowLocation(PopOver.ArrowLocation.TOP_CENTER);
+                entryFromIdPopOver.setContentNode(entryFromId.getDialogPane());
+                entryFromIdPopOver.show(newEntryFromIdButton);
+            } else if (entryFromIdPopOver.isShowing()) {
+                entryFromIdPopOver.hide();
+            } else {
+                entryFromIdPopOver.setContentNode(entryFromId.getDialogPane());
+                entryFromIdPopOver.show(newEntryFromIdButton);
+            }
+        });
+
+        newEntryFromIdButton.disableProperty().bind(ActionHelper.needsDatabase(stateManager).not());
+
+        return newEntryFromIdButton;
+    }
+
     private Group createTaskIndicator() {
         ProgressIndicator indicator = new ProgressIndicator();
         indicator.getStyleClass().add("progress-indicatorToolbar");

src/main/java/org/jabref/gui/actions/StandardActions.java

@@ -131,7 +131,6 @@ public enum StandardActions implements Action {
     LIBRARY_PROPERTIES(Localization.lang("Library properties")),
     EDIT_PREAMBLE(Localization.lang("Edit preamble")),
     EDIT_STRINGS(Localization.lang("Edit string constants"), IconTheme.JabRefIcons.EDIT_STRINGS, KeyBinding.EDIT_STRINGS),
-
     FIND_DUPLICATES(Localization.lang("Find duplicates"), IconTheme.JabRefIcons.FIND_DUPLICATES),
     MERGE_ENTRIES(Localization.lang("Merge entries"), IconTheme.JabRefIcons.MERGE_ENTRIES, KeyBinding.MERGE_ENTRIES),
     RESOLVE_DUPLICATE_KEYS(Localization.lang("Resolve duplicate citation keys"), Localization.lang("Find and remove duplicate citation keys"), KeyBinding.RESOLVE_DUPLICATE_CITATION_KEYS),

src/main/java/org/jabref/gui/importer/GenerateEntryFromIdAction.java

@@ -0,0 +1,38 @@
+package org.jabref.gui.importer;
+
+import java.util.Optional;
+
+import org.jabref.gui.DialogService;
+import org.jabref.gui.LibraryTab;
+import org.jabref.gui.actions.SimpleCommand;
+import org.jabref.logic.importer.CompositeIdFetcher;
+import org.jabref.model.entry.BibEntry;
+import org.jabref.preferences.PreferencesService;
+
+public class GenerateEntryFromIdAction extends SimpleCommand {
+    private final LibraryTab libraryTab;
+    private final DialogService dialogService;
+    private final PreferencesService preferencesService;
+    private final String id;
+
+    public GenerateEntryFromIdAction(LibraryTab libraryTab, DialogService dialogService, PreferencesService preferencesService, String id) {
+        this.libraryTab = libraryTab;
+        this.dialogService = dialogService;
+        this.preferencesService = preferencesService;
+        this.id = id;
+    }
+
+    @Override
+    public void execute() {
+        Optional<BibEntry> fetchedEntry;
+
+        CompositeIdFetcher compositeIdFetcher = new CompositeIdFetcher(preferencesService.getImportFormatPreferences());
+        fetchedEntry = compositeIdFetcher.performSearchById(id);
+
+        fetchedEntry.ifPresentOrElse(
+                libraryTab::insertEntry,
+                () -> dialogService.showErrorDialogAndWait("Could not generate an entry from this ID")
+        );
+    }
+
+}

src/main/java/org/jabref/gui/importer/GenerateEntryFromIdDialog.fxml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<?import javafx.scene.control.Button?>
+<?import javafx.scene.control.DialogPane?>
+<?import javafx.scene.control.Label?>
+<?import javafx.scene.control.TextField?>
+<?import javafx.scene.layout.Pane?>
+<DialogPane fx:id="dialogPane" maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="92.0" prefWidth="392.0" xmlns="http://javafx.com/javafx/17" xmlns:fx="http://javafx.com/fxml/1" fx:controller="org.jabref.gui.importer.GenerateEntryFromIdDialog">
+   <content>
+       <Pane maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="102.0"
+             prefWidth="360.0">
+           <TextField fx:id="idTextField" layoutX="14.0" layoutY="40.0" maxHeight="-Infinity" maxWidth="-Infinity"
+                      minHeight="-Infinity" minWidth="-Infinity" prefHeight="29.0" prefWidth="238.0"/>
+           <Button fx:id="generateButton" layoutX="273.0" layoutY="40.0" maxHeight="-Infinity" maxWidth="-Infinity"
+                   minHeight="-Infinity" minWidth="-Infinity" mnemonicParsing="false" onAction="#generateEntry"
+                   prefHeight="30.0" prefWidth="96.0" text="Generate" textAlignment="CENTER"/>
+           <Label layoutX="14.0" layoutY="14.0" prefHeight="16.0" prefWidth="328.0"
+                  text="Fetch and generate an entry from an ID:"/>
+       </Pane>
+   </content>
+</DialogPane>

src/main/java/org/jabref/gui/importer/GenerateEntryFromIdDialog.java

@@ -0,0 +1,44 @@
+package org.jabref.gui.importer;
+
+import javafx.fxml.FXML;
+import javafx.scene.control.Button;
+import javafx.scene.control.DialogPane;
+import javafx.scene.control.TextField;
+
+import org.jabref.gui.DialogService;
+import org.jabref.gui.LibraryTab;
+import org.jabref.preferences.PreferencesService;
+
+import com.airhacks.afterburner.views.ViewLoader;
+
+public class GenerateEntryFromIdDialog {
+
+    @FXML DialogPane dialogPane;
+    @FXML TextField idTextField;
+    @FXML Button generateButton;
+
+    private final PreferencesService preferencesService;
+    private final DialogService dialogService;
+    private final LibraryTab libraryTab;
+
+    public GenerateEntryFromIdDialog(LibraryTab libraryTab, DialogService dialogService, PreferencesService preferencesService) {
+        ViewLoader.view(this).load();
+        this.preferencesService = preferencesService;
+        this.dialogService = dialogService;
+        this.libraryTab = libraryTab;
+    }
+
+    @FXML private void generateEntry() {
+        new GenerateEntryFromIdAction(
+                libraryTab,
+                dialogService,
+                preferencesService,
+                idTextField.getText()
+        ).execute();
+    }
+
+    public DialogPane getDialogPane() {
+        return dialogPane;
+    }
+
+}

src/main/java/org/jabref/logic/importer/CompositeIdFetcher.java

@@ -0,0 +1,83 @@
+package org.jabref.logic.importer;
+
+import java.util.Optional;
+
+import org.jabref.logic.importer.fetcher.ArXiv;
+import org.jabref.logic.importer.fetcher.CrossRef;
+import org.jabref.logic.importer.fetcher.DoiFetcher;
+import org.jabref.logic.importer.fetcher.IacrEprintFetcher;
+import org.jabref.logic.importer.fetcher.IsbnFetcher;
+import org.jabref.model.entry.BibEntry;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class CompositeIdFetcher implements IdBasedFetcher {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(CompositeIdFetcher.class);
+
+    private final ImportFormatPreferences importFormatPreferences;
+
+    public CompositeIdFetcher(ImportFormatPreferences importFormatPreferences) {
+        this.importFormatPreferences = importFormatPreferences;
+    }
+
+    @Override
+    public Optional<BibEntry> performSearchById(String identifier) {
+
+        Optional<BibEntry> fetchedEntry;
+
+        try {
+            fetchedEntry = new ArXiv(importFormatPreferences).performSearchById(identifier);
+            if (fetchedEntry.isPresent()) {
+                return fetchedEntry;
+            }
+        } catch (FetcherException fetcherException) {
+            LOGGER.debug(fetcherException.getMessage());
+        }
+
+        try {
+            fetchedEntry = new IsbnFetcher(importFormatPreferences).performSearchById(identifier);
+            if (fetchedEntry.isPresent()) {
+                return fetchedEntry;
+            }
+        } catch (FetcherException fetcherException) {
+            LOGGER.debug(fetcherException.getMessage());
+        }
+
+        try {
+            fetchedEntry = new DoiFetcher(importFormatPreferences).performSearchById(identifier);
+            if (fetchedEntry.isPresent()) {
+                return fetchedEntry;
+            }
+        } catch (FetcherException fetcherException) {
+            LOGGER.debug(fetcherException.getMessage());
+        }
+
+        try {
+            fetchedEntry = new IacrEprintFetcher(importFormatPreferences).performSearchById(identifier);
+            if (fetchedEntry.isPresent()) {
+                return fetchedEntry;
+            }
+        } catch (FetcherException fetcherException) {
+            LOGGER.debug(fetcherException.getMessage());
+        }
+
+        try {
+            fetchedEntry = new CrossRef().performSearchById(identifier);
+            if (fetchedEntry.isPresent()) {
+                return fetchedEntry;
+            }
+        } catch (FetcherException fetcherException) {
+            LOGGER.debug(fetcherException.getMessage());
+        }
+
+        return Optional.empty();
+
+    }
+
+    @Override
+    public String getName() {
+        return "CompositeIdFetcher";
+    }
+}