Convert INSPIRE fetcher to new infrastructure (#4146)

* Convert INSPIRE fetcher to new infrastructure

* Remove obsolete language keys

Author: tobiasdiez

src/main/java/org/jabref/gui/importer/fetcher/EntryFetchers.java

@@ -15,7 +15,6 @@ public class EntryFetchers {
     public EntryFetchers(JournalAbbreviationLoader abbreviationLoader) {
         entryFetchers.add(new CiteSeerXFetcher());
         entryFetchers.add(new IEEEXploreFetcher(abbreviationLoader));
-        entryFetchers.add(new INSPIREFetcher());
         // entryFetchers.add(new OAI2Fetcher()); - new arXiv fetcher in place, see below
         entryFetchers.add(new ACMPortalFetcher());
 

src/main/java/org/jabref/gui/importer/fetcher/INSPIREFetcher.java

@@ -17,6 +17,7 @@
 import org.jabref.logic.importer.fetcher.GoogleScholar;
 import org.jabref.logic.importer.fetcher.GvkFetcher;
 import org.jabref.logic.importer.fetcher.IEEE;
+import org.jabref.logic.importer.fetcher.INSPIREFetcher;
 import org.jabref.logic.importer.fetcher.IacrEprintFetcher;
 import org.jabref.logic.importer.fetcher.IsbnFetcher;
 import org.jabref.logic.importer.fetcher.LibraryOfCongress;
@@ -76,6 +77,7 @@ public static Optional<IdFetcher<? extends Identifier>> getIdFetcherForField(Str
     public static List<SearchBasedFetcher> getSearchBasedFetchers(ImportFormatPreferences importFormatPreferences) {
         ArrayList<SearchBasedFetcher> list = new ArrayList<>();
         list.add(new ArXiv(importFormatPreferences));
+        list.add(new INSPIREFetcher(importFormatPreferences));
         list.add(new GvkFetcher());
         list.add(new MedlineFetcher());
         list.add(new AstrophysicsDataSystem(importFormatPreferences));

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

@@ -0,0 +1,92 @@
+package org.jabref.logic.importer.fetcher;
+
+import java.io.BufferedReader;
+import java.io.InputStreamReader;
+import java.net.MalformedURLException;
+import java.net.URISyntaxException;
+import java.net.URL;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+
+import org.jabref.logic.formatter.bibtexfields.ClearFormatter;
+import org.jabref.logic.formatter.bibtexfields.RemoveBracesFormatter;
+import org.jabref.logic.help.HelpFile;
+import org.jabref.logic.importer.FetcherException;
+import org.jabref.logic.importer.ImportFormatPreferences;
+import org.jabref.logic.importer.Parser;
+import org.jabref.logic.importer.SearchBasedParserFetcher;
+import org.jabref.logic.importer.fileformat.BibtexParser;
+import org.jabref.logic.util.OS;
+import org.jabref.model.cleanup.FieldFormatterCleanup;
+import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.FieldName;
+import org.jabref.model.util.DummyFileUpdateMonitor;
+
+import org.apache.http.client.utils.URIBuilder;
+
+/**
+ * Fetches data from the INSPIRE database.
+ *
+ * @implNote We just use the normal search interface since it provides direct BibTeX export while the API (http://inspirehep.net/info/hep/api) currently only supports JSON and XML
+ */
+public class INSPIREFetcher implements SearchBasedParserFetcher {
+
+    private static final String INSPIRE_HOST = "https://inspirehep.net/search";
+
+    private final ImportFormatPreferences preferences;
+
+    public INSPIREFetcher(ImportFormatPreferences preferences) {
+        this.preferences = preferences;
+    }
+
+    @Override
+    public String getName() {
+        return "INSPIRE";
+    }
+
+    @Override
+    public HelpFile getHelpPage() {
+        return HelpFile.FETCHER_INSPIRE;
+    }
+
+    @Override
+    public URL getURLForQuery(String query) throws URISyntaxException, MalformedURLException, FetcherException {
+        URIBuilder uriBuilder = new URIBuilder(INSPIRE_HOST);
+        uriBuilder.addParameter("p", query); // Query
+        //uriBuilder.addParameter("jrec", "1"); // Start index (not needed at the moment)
+        uriBuilder.addParameter("rg", "100"); // Should return up to 100 items (instead of default 25)
+        uriBuilder.addParameter("of", "hx"); // BibTeX format
+        return uriBuilder.build().toURL();
+    }
+
+    @Override
+    public Parser getParser() {
+        // Inspire returns the BibTeX result embedded in HTML
+        // So we extract the BibTeX string from the <pre>bibtex</pre> tags and pass the content to the BibTeX parser
+        return inputStream -> {
+            String response = new BufferedReader(new InputStreamReader(inputStream)).lines().collect(Collectors.joining(OS.NEWLINE));
+
+            List<BibEntry> entries = new ArrayList<>();
+            BibtexParser bibtexParser = new BibtexParser(preferences, new DummyFileUpdateMonitor());
+            Pattern pattern = Pattern.compile("<pre>(?s)(.*)</pre>");
+            Matcher matcher = pattern.matcher(response);
+            while (matcher.find()) {
+                String bibtexEntryString = matcher.group(1);
+                entries.addAll(bibtexParser.parseEntries(bibtexEntryString));
+            }
+            return entries;
+        };
+    }
+
+    @Override
+    public void doPostCleanup(BibEntry entry) {
+        // Remove strange "SLACcitation" field
+        new FieldFormatterCleanup("SLACcitation", new ClearFormatter()).cleanup(entry);
+
+        // Remove braces around content of "title" field
+        new FieldFormatterCleanup(FieldName.TITLE, new RemoveBracesFormatter()).cleanup(entry);
+    }
+}

src/main/java/org/jabref/logic/importer/fetcher/INSPIREFetcher.java

@@ -1750,10 +1750,8 @@ Error\ Occurred=Error Occurred
 Journal\ file\ %s\ already\ added=Journal file %s already added
 Name\ cannot\ be\ empty=Name cannot be empty
 
-Adding\ fetched\ entries=Adding fetched entries
 Display\ keywords\ appearing\ in\ ALL\ entries=Display keywords appearing in ALL entries
 Display\ keywords\ appearing\ in\ ANY\ entry=Display keywords appearing in ANY entry
-Fetching\ entries\ from\ Inspire=Fetching entries from Inspire
 None\ of\ the\ selected\ entries\ have\ titles.=None of the selected entries have titles.
 None\ of\ the\ selected\ entries\ have\ BibTeX\ keys.=None of the selected entries have BibTeX keys.
 Unabbreviate\ journal\ names=Unabbreviate journal names

src/main/resources/l10n/JabRef_en.properties

@@ -0,0 +1,44 @@
+package org.jabref.logic.importer.fetcher;
+
+import java.util.Collections;
+import java.util.List;
+
+import org.jabref.logic.bibtex.FieldContentParserPreferences;
+import org.jabref.logic.importer.ImportFormatPreferences;
+import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.BibtexEntryTypes;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+class INSPIREFetcherTest {
+    private INSPIREFetcher fetcher;
+
+    @BeforeEach
+    void setUp() {
+        ImportFormatPreferences importFormatPreferences = mock(ImportFormatPreferences.class);
+        when(importFormatPreferences.getFieldContentParserPreferences()).thenReturn(mock(FieldContentParserPreferences.class));
+        fetcher = new INSPIREFetcher(importFormatPreferences);
+    }
+
+    @Test
+    void searchByQueryFindsEntry() throws Exception {
+        BibEntry expected = new BibEntry(BibtexEntryTypes.MASTERSTHESIS.getName());
+        expected.setCiteKey("Diez:2014ppa");
+        expected.setField("author", "Diez, Tobias");
+        expected.setField("title", "Slice theorem for Fr\\'echet group actions and covariant symplectic field theory");
+        expected.setField("school", "Leipzig U.");
+        expected.setField("year", "2013");
+        expected.setField("url", "https://inspirehep.net/record/1295621/files/arXiv:1405.2249.pdf");
+        expected.setField("eprint", "1405.2249");
+        expected.setField("archivePrefix", "arXiv");
+        expected.setField("primaryClass", "math-ph");
+
+        List<BibEntry> fetchedEntries = fetcher.performSearch("Fr\\'echet group actions field");
+        assertEquals(Collections.singletonList(expected), fetchedEntries);
+    }
+}