Add Worldcat fetcher

.github/workflows/deployment.yml

@@ -22,6 +22,7 @@ env:
   SpringerNatureAPIKey: ${{ secrets.SpringerNatureAPIKey }}
   AstrophysicsDataSystemAPIKey: ${{ secrets.AstrophysicsDataSystemAPIKey }}
   IEEEAPIKey: ${{ secrets.IEEEAPIKey }}
+  WorldCatAPIKey: ${{ secrets.WorldCatAPIKey }}
   OSXCERT: ${{ secrets.OSX_SIGNING_CERT }}
   GRADLE_OPTS: -Dorg.gradle.daemon=false -Dorg.gradle.vfs.watch=false
 

CHANGELOG.md

@@ -64,6 +64,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
 - We added some symbols and keybindings to the context menu in the entry editor. [#7268](https://github.com/JabRef/jabref/pull/7268)
 - We added keybindings for setting and clearing the read status. [#7264](https://github.com/JabRef/jabref/issues/7264)
 - We added two new fields to track the creation and most recent modification date and time for each entry. [koppor#130](https://github.com/koppor/jabref/issues/130)
+- We added a fetcher for [WorldCat](https://www.worldcat.org/). [#1065](https://github.com/JabRef/jabref/issues/1065) [#2581](https://github.com/JabRef/jabref/issues/2581)
 - We added a feature that allows the user to copy highlighted text in the preview window. [#6962](https://github.com/JabRef/jabref/issues/6962)
 - We added a feature that allows you to create new BibEntry via paste arxivId [#2292](https://github.com/JabRef/jabref/issues/2292)
 - We added support for conducting automated and systematic literature search across libraries and git support for persistence [#369](https://github.com/koppor/jabref/issues/369)

build.gradle

@@ -294,6 +294,7 @@ processResources {
                 "springerNatureAPIKey": System.getenv('SpringerNatureAPIKey') ? System.getenv('SpringerNatureAPIKey') : '',
                 "astrophysicsDataSystemAPIKey": System.getenv('AstrophysicsDataSystemAPIKey') ? System.getenv('AstrophysicsDataSystemAPIKey') : '',
                 "ieeeAPIKey": System.getenv('IEEEAPIKey') ? System.getenv('IEEEAPIKey') : '',
+                "worldCatAPIKey": System.getenv('worldCatAPIKey') ? System.getenv('worldCatAPIKey') : '',
                 "scienceDirectApiKey": System.getenv('SCIENCEDIRECTAPIKEY') ? System.getenv('SCIENCEDIRECTAPIKEY') : ''
         )
         filteringCharset = 'UTF-8'

docs/advanced-reading/fetchers.md

@@ -9,9 +9,10 @@ Fetchers are the implementation of the [search using online services](https://do
 | [SAO/NASA Astrophysics Data System](https://docs.jabref.org/collect/import-using-online-bibliographic-database#sao-nasa-astrophysics-data-system) | [ADS UI](https://ui.adsabs.harvard.edu/user/settings/token) | `AstrophysicsDataSystemAPIKey` | 5000 calls/day |
 | [ScienceDirect](https://www.sciencedirect.com/) |  | `ScienceDirectApiKey` |  |
 | [Springer Nature](https://docs.jabref.org/collect/import-using-online-bibliographic-database#springer) | [Springer Nature API Portal](https://dev.springernature.com/) | `SpringerNatureAPIKey` | 5000 calls/day |
+| [WorldCat](https://www.worldcat.org/) | [OCLC Developer Network](https://www.oclc.org/developer/develop/authentication/how-to-request-a-wskey.en.html) | `worldCatAPIKey` | \(none\) | 
 | [Zentralblatt Math](https://www.zbmath.org/) | \(none\) | \(none\) | Depending on the current network |
 
-"Depending on the current network" means that it depends whether your request is routed through a network having paid access. For instance, some universities have subscriptions to MathSciNet.
+"Depending on the current network" means that it depends on whether your request is routed through a network having paid access. For instance, some universities have subscriptions to MathSciNet.
 
 On Windows, you have to log-off and log-on to let IntelliJ know about the environment variable change. Execute the gradle task "processResources" in the group "others" within IntelliJ to ensure the values have been correctly written. Now, the fetcher tests should run without issues.
 

src/main/java/org/jabref/gui/entryeditor/EntryEditor.java

@@ -352,7 +352,7 @@ private void setupToolBar() {
 
         // Add menu for fetching bibliographic information
         ContextMenu fetcherMenu = new ContextMenu();
-        for (EntryBasedFetcher fetcher : WebFetchers.getEntryBasedFetchers(preferencesService.getImportFormatPreferences())) {
+        for (EntryBasedFetcher fetcher : WebFetchers.getEntryBasedFetchers(preferencesService.getImportFormatPreferences(), preferencesService.getApiKeyPreferences())) {
             MenuItem fetcherMenuItem = new MenuItem(fetcher.getName());
             fetcherMenuItem.setOnAction(event -> fetchAndMerge(fetcher));
             fetcherMenu.getItems().add(fetcherMenuItem);

src/main/java/org/jabref/gui/preferences/PreferencesDialogViewModel.java

@@ -19,6 +19,7 @@
 import org.jabref.gui.preferences.entryeditortabs.CustomEditorFieldsTab;
 import org.jabref.gui.preferences.exporter.ExportCustomizationTab;
 import org.jabref.gui.preferences.external.ExternalTab;
+import org.jabref.gui.preferences.fetcher.FetcherTab;
 import org.jabref.gui.preferences.file.FileTab;
 import org.jabref.gui.preferences.general.GeneralTab;
 import org.jabref.gui.preferences.groups.GroupsTab;

src/main/java/org/jabref/gui/preferences/fetcher/FetcherTab.fxml

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<?import javafx.scene.control.Button?>
+<?import javafx.scene.control.CheckBox?>
+<?import javafx.scene.control.Label?>
+<?import javafx.scene.control.TextField?>
+<?import javafx.scene.layout.ColumnConstraints?>
+<?import javafx.scene.layout.GridPane?>
+<?import javafx.scene.layout.HBox?>
+<?import javafx.scene.layout.RowConstraints?>
+<?import javafx.scene.layout.VBox?>
+<?import org.jabref.gui.icon.JabRefIconView?>
+<fx:root spacing="10.0" type="VBox" prefWidth="650.0"
+         xmlns="http://javafx.com/javafx" xmlns:fx="http://javafx.com/fxml"
+         fx:controller="org.jabref.gui.preferences.fetcher.FetcherTab">
+
+    <Label styleClass="titleHeader" text="%Fetcher API keys"/>
+
+    <Label text="Use custom API keys"/>
+    <GridPane hgap="10.0" vgap="4.0">
+        <columnConstraints>
+            <ColumnConstraints hgrow="SOMETIMES" percentWidth="30.0"/>
+            <ColumnConstraints hgrow="SOMETIMES"/>
+        </columnConstraints>
+        <rowConstraints>
+            <RowConstraints minHeight="10.0" />
+            <RowConstraints minHeight="10.0" />
+        </rowConstraints>
+        <CheckBox fx:id="useWorldcatKey" text="%WorldCat" GridPane.rowIndex="0" GridPane.columnIndex="0"/>
+        <TextField fx:id="worldcatKey" disable="${!useWorldcatKey.selected}"
+                   GridPane.rowIndex="0" GridPane.columnIndex="1"/>
+        <HBox alignment="BASELINE_LEFT" spacing="4.0" onMouseClicked="#openWorldcatWebpage"
+              GridPane.rowIndex="1" GridPane.columnIndex="1">
+            <Button styleClass="icon-button,narrow" onAction="#openWorldcatWebpage" text="%Request a key on the WorldCat platform."
+                    prefHeight="15.0" GridPane.columnIndex="2">
+                <graphic>
+                    <JabRefIconView glyph="LINK_VARIANT"/>
+                </graphic>
+            </Button>
+        </HBox>
+    </GridPane>
+</fx:root>

src/main/java/org/jabref/gui/preferences/fetcher/FetcherTab.java

@@ -0,0 +1,41 @@
+package org.jabref.gui.preferences.fetcher;
+
+import javafx.fxml.FXML;
+import javafx.scene.control.CheckBox;
+import javafx.scene.control.TextField;
+
+import org.jabref.gui.preferences.AbstractPreferenceTabView;
+import org.jabref.gui.preferences.PreferencesTab;
+import org.jabref.logic.l10n.Localization;
+
+import com.airhacks.afterburner.views.ViewLoader;
+
+public class FetcherTab extends AbstractPreferenceTabView<FetcherTabViewModel> implements PreferencesTab {
+
+    @FXML private CheckBox useWorldcatKey;
+    @FXML private TextField worldcatKey;
+
+    public FetcherTab() {
+        ViewLoader.view(this)
+                  .root(this)
+                  .load();
+    }
+
+    @FXML
+    private void initialize() {
+        viewModel = new FetcherTabViewModel(preferencesService);
+
+        useWorldcatKey.selectedProperty().bindBidirectional(viewModel.getUseWorldcatKeyProperty());
+        worldcatKey.textProperty().bindBidirectional(viewModel.getWorldcatKeyProperty());
+    }
+
+    @Override
+    public String getTabName() {
+        return Localization.lang("Fetcher API keys");
+    }
+
+    @FXML
+    private void openWorldcatWebpage() {
+        viewModel.openWorldcatWebpage();
+    }
+}

src/main/java/org/jabref/gui/preferences/fetcher/FetcherTabViewModel.java

@@ -0,0 +1,74 @@
+package org.jabref.gui.preferences.fetcher;
+
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import javafx.beans.property.BooleanProperty;
+import javafx.beans.property.SimpleBooleanProperty;
+import javafx.beans.property.SimpleStringProperty;
+import javafx.beans.property.StringProperty;
+
+import org.jabref.gui.desktop.JabRefDesktop;
+import org.jabref.gui.preferences.PreferenceTabViewModel;
+import org.jabref.logic.importer.FetcherApiPreferences;
+import org.jabref.model.strings.StringUtil;
+import org.jabref.preferences.PreferencesService;
+
+public class FetcherTabViewModel implements PreferenceTabViewModel {
+
+    private final String WORLDCAT_REQUEST_URL = "https://platform.worldcat.org/wskey";
+
+    private final BooleanProperty useWorldcatKeyProperty = new SimpleBooleanProperty();
+    private final StringProperty worldcatKeyProperty = new SimpleStringProperty();
+
+    private final PreferencesService preferencesService;
+    private final FetcherApiPreferences initialFetcherApiPreferences;
+
+    public FetcherTabViewModel(PreferencesService preferencesService) {
+        this.preferencesService = preferencesService;
+        this.initialFetcherApiPreferences = preferencesService.getApiKeyPreferences();
+    }
+
+    @Override
+    public void setValues() {
+        if (StringUtil.isNotBlank(initialFetcherApiPreferences.getWorldcatKey())) {
+            useWorldcatKeyProperty.setValue(true);
+            worldcatKeyProperty.setValue(initialFetcherApiPreferences.getWorldcatKey());
+        }
+    }
+
+    @Override
+    public void storeSettings() {
+        Map<String, String> keys = new HashMap<>();
+
+        keys.put("worldcat", useWorldcatKeyProperty.getValue() ? worldcatKeyProperty.getValue() : "");
+
+        preferencesService.storeApiKeyPreferences(new FetcherApiPreferences(
+                keys.get("worldcat"))
+        );
+    }
+
+    public void openWorldcatWebpage() {
+        JabRefDesktop.openBrowserShowPopup(WORLDCAT_REQUEST_URL);
+    }
+
+    @Override
+    public boolean validateSettings() {
+        return true;
+    }
+
+    @Override
+    public List<String> getRestartWarnings() {
+        return Collections.emptyList();
+    }
+
+    public BooleanProperty getUseWorldcatKeyProperty() {
+        return useWorldcatKeyProperty;
+    }
+
+    public StringProperty getWorldcatKeyProperty() {
+        return worldcatKeyProperty;
+    }
+}

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

@@ -0,0 +1,13 @@
+package org.jabref.logic.importer;
+
+public class FetcherApiPreferences {
+    private final String worldcatKey;
+
+    public FetcherApiPreferences(String worldcatKey) {
+        this.worldcatKey = worldcatKey;
+    }
+
+    public String getWorldcatKey() {
+        return worldcatKey;
+    }
+}

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

@@ -36,6 +36,7 @@
 import org.jabref.logic.importer.fetcher.SpringerFetcher;
 import org.jabref.logic.importer.fetcher.SpringerLink;
 import org.jabref.logic.importer.fetcher.TitleFetcher;
+import org.jabref.logic.importer.fetcher.WorldCatFetcher;
 import org.jabref.logic.importer.fetcher.ZbMATH;
 import org.jabref.model.entry.field.Field;
 import org.jabref.model.entry.field.StandardField;
@@ -133,13 +134,14 @@ public static SortedSet<IdBasedFetcher> getIdBasedFetchers(ImportFormatPreferenc
     /**
      * @return sorted set containing entry based fetchers
      */
-    public static SortedSet<EntryBasedFetcher> getEntryBasedFetchers(ImportFormatPreferences importFormatPreferences) {
+    public static SortedSet<EntryBasedFetcher> getEntryBasedFetchers(ImportFormatPreferences importFormatPreferences, FetcherApiPreferences fetcherApiPreferences) {
         SortedSet<EntryBasedFetcher> set = new TreeSet<>(Comparator.comparing(WebFetcher::getName));
         set.add(new AstrophysicsDataSystem(importFormatPreferences));
         set.add(new DoiFetcher(importFormatPreferences));
         set.add(new IsbnFetcher(importFormatPreferences));
         set.add(new MathSciNet(importFormatPreferences));
         set.add(new CrossRef());
+        set.add(new WorldCatFetcher(fetcherApiPreferences.getWorldcatKey()));
         set.add(new ZbMATH(importFormatPreferences));
         return set;
     }