From 91ae89f8b42d288ef96966d2e7b92d8cd9a63dd0 Mon Sep 17 00:00:00 2001
From: u7978428 <u7978428@anu.edu.au>
Date: Wed, 8 Oct 2025 16:51:57 +1100
Subject: [PATCH] Provide a switch to let users choose whether to enable the
 texkeys function

---
 .../gui/preferences/websearch/WebSearchTab.java |  4 ++++
 .../websearch/WebSearchTabViewModel.java        | 10 ++++++++++
 .../gui/preferences/websearch/WebSearchTab.fxml |  5 +++++
 .../logic/importer/ImporterPreferences.java     | 17 ++++++++++++++++-
 .../logic/preferences/JabRefCliPreferences.java |  6 +++++-
 5 files changed, 40 insertions(+), 2 deletions(-)

diff --git a/jabgui/src/main/java/org/jabref/gui/preferences/websearch/WebSearchTab.java b/jabgui/src/main/java/org/jabref/gui/preferences/websearch/WebSearchTab.java
index 12064d26e92..ff3ae253b6a 100644
--- a/jabgui/src/main/java/org/jabref/gui/preferences/websearch/WebSearchTab.java
+++ b/jabgui/src/main/java/org/jabref/gui/preferences/websearch/WebSearchTab.java
@@ -45,6 +45,8 @@ public class WebSearchTab extends AbstractPreferenceTabView<WebSearchTabViewMode
     @FXML private CheckBox grobidEnabled;
     @FXML private TextField grobidURL;
 
+    @FXML private CheckBox preferInspireTexkeys;
+
     @FXML private VBox fetchersContainer;
 
     private final ReadOnlyBooleanProperty refAiEnabled;
@@ -119,6 +121,8 @@ public void initialize() {
         useCustomDOIName.textProperty().bindBidirectional(viewModel.useCustomDOINameProperty());
         useCustomDOIName.disableProperty().bind(useCustomDOI.selectedProperty().not());
 
+        preferInspireTexkeys.selectedProperty().bindBidirectional(viewModel.preferInspireTexkeysProperty());
+
         InvalidationListener listener = _ -> fetchersContainer
                 .getChildren()
                 .setAll(viewModel.getFetchers()
diff --git a/jabgui/src/main/java/org/jabref/gui/preferences/websearch/WebSearchTabViewModel.java b/jabgui/src/main/java/org/jabref/gui/preferences/websearch/WebSearchTabViewModel.java
index dca966ff906..811b9ce866b 100644
--- a/jabgui/src/main/java/org/jabref/gui/preferences/websearch/WebSearchTabViewModel.java
+++ b/jabgui/src/main/java/org/jabref/gui/preferences/websearch/WebSearchTabViewModel.java
@@ -69,6 +69,8 @@ public class WebSearchTabViewModel implements PreferenceTabViewModel {
     private final BooleanProperty grobidEnabledProperty = new SimpleBooleanProperty();
     private final StringProperty grobidURLProperty = new SimpleStringProperty("");
 
+    private final BooleanProperty preferInspireTexkeysProperty = new SimpleBooleanProperty();
+
     private final BooleanProperty apikeyPersistProperty = new SimpleBooleanProperty();
     private final BooleanProperty apikeyPersistAvailableProperty = new SimpleBooleanProperty();
 
@@ -153,6 +155,8 @@ public void setValues() {
         grobidEnabledProperty.setValue(grobidPreferences.isGrobidEnabled());
         grobidURLProperty.setValue(grobidPreferences.getGrobidURL());
 
+        preferInspireTexkeysProperty.setValue(preferences.getImporterPreferences().isPreferInspireTexkeys());
+
         Set<FetcherApiKey> savedApiKeys = preferences.getImporterPreferences().getApiKeys();
         Set<String> enabledCatalogs = new HashSet<>(importerPreferences.getCatalogs());
 
@@ -207,6 +211,8 @@ public void storeSettings() {
         doiPreferences.setUseCustom(useCustomDOIProperty.get());
         doiPreferences.setDefaultBaseURI(useCustomDOINameProperty.getValue().trim());
 
+        importerPreferences.setPreferInspireTexkeys(preferInspireTexkeysProperty.getValue());
+
         importerPreferences.setCatalogs(
                 fetchers.stream()
                         .filter(FetcherViewModel::isEnabled)
@@ -289,6 +295,10 @@ public IntegerProperty citationsRelationsStoreTTLProperty() {
         return citationsRelationStoreTTL;
     }
 
+    public BooleanProperty preferInspireTexkeysProperty() {
+        return preferInspireTexkeysProperty;
+    }
+
     public void checkApiKey(FetcherViewModel fetcherViewModel, String apiKey, Consumer<Boolean> onFinished) {
         Callable<Boolean> tester = () -> {
             WebFetcher webFetcher = fetcherViewModel.getFetcher();
diff --git a/jabgui/src/main/resources/org/jabref/gui/preferences/websearch/WebSearchTab.fxml b/jabgui/src/main/resources/org/jabref/gui/preferences/websearch/WebSearchTab.fxml
index cf9d45183de..db25d349073 100644
--- a/jabgui/src/main/resources/org/jabref/gui/preferences/websearch/WebSearchTab.fxml
+++ b/jabgui/src/main/resources/org/jabref/gui/preferences/websearch/WebSearchTab.fxml
@@ -47,6 +47,11 @@
         <TextField fx:id="grobidURL" HBox.hgrow="ALWAYS"/>
     </HBox>
 
+    <Label styleClass="sectionHeader" text="%INSPIRE preferences"/>
+    <FlowPane styleClass="checkbox-flowpane">
+        <CheckBox fx:id="preferInspireTexkeys" text="%Prefer INSPIRE texkeys; clean URL-like citation keys"/>
+    </FlowPane>
+
     <Label styleClass="sectionHeader" text="%Web search fetchers"/>
     <VBox fx:id="fetchersContainer"/>
 </fx:root>
diff --git a/jablib/src/main/java/org/jabref/logic/importer/ImporterPreferences.java b/jablib/src/main/java/org/jabref/logic/importer/ImporterPreferences.java
index 3e1c27449e5..96dd6db589c 100644
--- a/jablib/src/main/java/org/jabref/logic/importer/ImporterPreferences.java
+++ b/jablib/src/main/java/org/jabref/logic/importer/ImporterPreferences.java
@@ -32,6 +32,7 @@ public class ImporterPreferences {
     private final ObservableList<String> catalogs;
     private final ObjectProperty<PlainCitationParserChoice> defaultPlainCitationParser;
     private final IntegerProperty citationsRelationsStoreTTL;
+    private final BooleanProperty preferInspireTexkeys;
 
     public ImporterPreferences(boolean importerEnabled,
                                boolean generateNewKeyOnImport,
@@ -43,7 +44,8 @@ public ImporterPreferences(boolean importerEnabled,
                                boolean persistCustomKeys,
                                List<String> catalogs,
                                PlainCitationParserChoice defaultPlainCitationParser,
-                               int citationsRelationsStoreTTL
+                               int citationsRelationsStoreTTL,
+                               boolean preferInspireTexkeys
     ) {
         this.importerEnabled = new SimpleBooleanProperty(importerEnabled);
         this.generateNewKeyOnImport = new SimpleBooleanProperty(generateNewKeyOnImport);
@@ -56,6 +58,7 @@ public ImporterPreferences(boolean importerEnabled,
         this.catalogs = FXCollections.observableArrayList(catalogs);
         this.defaultPlainCitationParser = new SimpleObjectProperty<>(defaultPlainCitationParser);
         this.citationsRelationsStoreTTL = new SimpleIntegerProperty(citationsRelationsStoreTTL);
+        this.preferInspireTexkeys = new SimpleBooleanProperty(preferInspireTexkeys);
     }
 
     public boolean areImporterEnabled() {
@@ -176,4 +179,16 @@ public IntegerProperty citationsRelationsStoreTTLProperty() {
     public void setCitationsRelationsStoreTTL(int citationsRelationsStoreTTL) {
         this.citationsRelationsStoreTTL.set(citationsRelationsStoreTTL);
     }
+
+    public boolean isPreferInspireTexkeys() {
+        return preferInspireTexkeys.get();
+    }
+
+    public BooleanProperty preferInspireTexkeysProperty() {
+        return preferInspireTexkeys;
+    }
+
+    public void setPreferInspireTexkeys(boolean preferInspireTexkeys) {
+        this.preferInspireTexkeys.set(preferInspireTexkeys);
+    }
 }
diff --git a/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java b/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java
index c0f87ed2ddb..ae4cc677890 100644
--- a/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java
+++ b/jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java
@@ -230,6 +230,7 @@ public class JabRefCliPreferences implements CliPreferences {
     public static final String SEARCH_CATALOGS = "searchCatalogs";
     public static final String DEFAULT_PLAIN_CITATION_PARSER = "defaultPlainCitationParser";
     public static final String CITATIONS_RELATIONS_STORE_TTL = "citationsRelationsStoreTTL";
+    public static final String PREFER_INSPIRE_TEXKEYS = "preferInspireTexkeys";
     public static final String IMPORTERS_ENABLED = "importersEnabled";
     public static final String GENERATE_KEY_ON_IMPORT = "generateKeyOnImport";
     public static final String GROBID_ENABLED = "grobidEnabled";
@@ -527,6 +528,7 @@ public JabRefCliPreferences() {
         defaults.put(IMPORTERS_ENABLED, Boolean.TRUE);
         defaults.put(GENERATE_KEY_ON_IMPORT, Boolean.TRUE);
         defaults.put(CITATIONS_RELATIONS_STORE_TTL, 30);
+        defaults.put(PREFER_INSPIRE_TEXKEYS, Boolean.TRUE);
 
         defaults.put(ADD_IMPORTED_ENTRIES, Boolean.FALSE);
         defaults.put(ADD_IMPORTED_ENTRIES_GROUP_NAME, Localization.lang("Imported entries"));
@@ -2223,7 +2225,8 @@ public ImporterPreferences getImporterPreferences() {
                 getBoolean(FETCHER_CUSTOM_KEY_PERSIST),
                 getStringList(SEARCH_CATALOGS),
                 PlainCitationParserChoice.valueOf(get(DEFAULT_PLAIN_CITATION_PARSER)),
-                getInt(CITATIONS_RELATIONS_STORE_TTL)
+                getInt(CITATIONS_RELATIONS_STORE_TTL),
+                getBoolean(PREFER_INSPIRE_TEXKEYS)
         );
 
         EasyBind.listen(importerPreferences.importerEnabledProperty(), (_, _, newValue) -> putBoolean(IMPORTERS_ENABLED, newValue));
@@ -2236,6 +2239,7 @@ public ImporterPreferences getImporterPreferences() {
         importerPreferences.getCatalogs().addListener((InvalidationListener) _ -> putStringList(SEARCH_CATALOGS, importerPreferences.getCatalogs()));
         EasyBind.listen(importerPreferences.defaultPlainCitationParserProperty(), (_, _, newValue) -> put(DEFAULT_PLAIN_CITATION_PARSER, newValue.name()));
         EasyBind.listen(importerPreferences.citationsRelationsStoreTTLProperty(), (_, _, newValue) -> put(CITATIONS_RELATIONS_STORE_TTL, newValue.toString()));
+        EasyBind.listen(importerPreferences.preferInspireTexkeysProperty(), (_, _, newValue) -> putBoolean(PREFER_INSPIRE_TEXKEYS, newValue));
 
         return importerPreferences;
     }