Change default behavior of resolve bibtex strings

CHANGELOG.md

@@ -14,12 +14,14 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
 ### Changed
 
 - We integrated the external file types dialog directly inside the preferences. [#8341](https://github.com/JabRef/jabref/pull/8341)
+- We inverted the logic for resolving [BibTeX strings](https://docs.jabref.org/advanced/strings). This helps to keep `#` chars. By default String resolving is only activated for a couple of standard fields. The list of fields can be modified in the preferences. [#7010](https://github.com/JabRef/jabref/issues/7010), [#7102](https://github.com/JabRef/jabref/issues/7012), [#8303](https://github.com/JabRef/jabref/issues/8303)
 - We moved the search box in preview preferences closer to the available citation styles list. [#8370](https://github.com/JabRef/jabref/pull/8370)
 - Changing the preference to show the preview panel as a separate tab now has effect without restarting JabRef. [#8370](https://github.com/JabRef/jabref/pull/8370)
 - We enabled switching themes in JabRef without the need to restart JabRef. [#7335](https://github.com/JabRef/jabref/pull/7335)
 
 ### Fixed
 
+- We fixed an issue where `#`chars in certain fields would be interpreted as BibTeX strings [#7010](https://github.com/JabRef/jabref/issues/7010), [#7102](https://github.com/JabRef/jabref/issues/7012), [#8303](https://github.com/JabRef/jabref/issues/8303)
 - We fixed an issue where clicking on "Accept changes" in the merge dialog would lead to an exception [forum#2418](https://discourse.jabref.org/t/the-library-has-been-modified-by-another-program/2418/8)
 - We fixed an issue where clicking on headings in the entry preview could lead to an exception. [#8292](https://github.com/JabRef/jabref/issues/8292)
 - We fixed an issue where IntegrityCheck used the system's character encoding instead of the one set by the library or in preferences [#8022](https://github.com/JabRef/jabref/issues/8022)

src/main/java/org/jabref/gui/preferences/file/FileTab.fxml

@@ -11,31 +11,41 @@
 <?import javafx.scene.layout.HBox?>
 <?import javafx.scene.layout.VBox?>
 
+<?import javafx.scene.control.Separator?>
 <fx:root spacing="10.0" type="VBox"
          xmlns="http://javafx.com/javafx" xmlns:fx="http://javafx.com/fxml"
          fx:controller="org.jabref.gui.preferences.file.FileTab">
     <Label text="%File" styleClass="titleHeader"/>
+
+    <Label styleClass="sectionHeader" text="%String constants"/>
     <fx:define>
         <ToggleGroup fx:id="stringsResolveToggleGroup"/>
     </fx:define>
+    <HBox alignment="CENTER_LEFT" spacing="10.0">
+        <RadioButton fx:id="resolveStrings" text="%Resolve BibTeX strings for the following fields"
+                     toggleGroup="$stringsResolveToggleGroup"/>
+        <TextField fx:id="resolveStringsForFields" HBox.hgrow="ALWAYS"/>
+    </HBox>
+    <RadioButton fx:id="doNotResolveStrings" text="%Do not resolve BibTeX strings"
+                 toggleGroup="$stringsResolveToggleGroup"/>
+
+    <Label styleClass="sectionHeader" text="%Loading"/>
 
     <CheckBox fx:id="openLastStartup" text="%Open last edited libraries at startup"/>
+
+    <Label styleClass="sectionHeader" text="%Saving"/>
+
     <HBox alignment="CENTER_LEFT" spacing="10.0">
         <Label text="%Do not wrap the following fields when saving"/>
         <TextField fx:id="noWrapFiles" HBox.hgrow="ALWAYS"/>
     </HBox>
-    <RadioButton fx:id="resolveStringsBibTex" text="%Resolve strings for standard BibTeX fields only"
-                 toggleGroup="$stringsResolveToggleGroup"/>
-    <HBox alignment="CENTER_LEFT" spacing="10.0">
-        <RadioButton fx:id="resolveStringsAll" text="%Resolve strings for all fields except"
-                     toggleGroup="$stringsResolveToggleGroup"/>
-        <TextField fx:id="resolveStringsExcept" HBox.hgrow="ALWAYS"/>
-    </HBox>
-    <CheckBox fx:id="alwaysReformatBib" text="%Always reformat BIB file on save and export"/>
 
-    <Label styleClass="sectionHeader" text="%Autosave"/>
     <HBox alignment="CENTER_LEFT" spacing="10.0">
         <CheckBox fx:id="autosaveLocalLibraries" text="%Autosave local libraries"/>
         <Button fx:id="autosaveLocalLibrariesHelp"/>
     </HBox>
+
+    <CheckBox fx:id="alwaysReformatBib" text="%Always reformat BIB file on save and export"/>
+
+
 </fx:root>

src/main/java/org/jabref/gui/preferences/file/FileTab.java

@@ -21,9 +21,9 @@ public class FileTab extends AbstractPreferenceTabView<FileTabViewModel> impleme
 
     @FXML private CheckBox openLastStartup;
     @FXML private TextField noWrapFiles;
-    @FXML private RadioButton resolveStringsBibTex;
-    @FXML private RadioButton resolveStringsAll;
-    @FXML private TextField resolveStringsExcept;
+    @FXML private RadioButton doNotResolveStrings;
+    @FXML private RadioButton resolveStrings;
+    @FXML private TextField resolveStringsForFields;
     @FXML private CheckBox alwaysReformatBib;
 
     @FXML private CheckBox autosaveLocalLibraries;
@@ -39,12 +39,13 @@ public void initialize() {
         this.viewModel = new FileTabViewModel(preferencesService);
         openLastStartup.selectedProperty().bindBidirectional(viewModel.openLastStartupProperty());
         noWrapFiles.textProperty().bindBidirectional(viewModel.noWrapFilesProperty());
-        resolveStringsBibTex.selectedProperty().bindBidirectional(viewModel.resolveStringsBibTexProperty());
-        resolveStringsAll.selectedProperty().bindBidirectional(viewModel.resolveStringsAllProperty());
-        resolveStringsExcept.textProperty().bindBidirectional(viewModel.resolveStringsExceptProperty());
-        resolveStringsExcept.disableProperty().bind(resolveStringsAll.selectedProperty().not());
-        alwaysReformatBib.selectedProperty().bindBidirectional(viewModel.alwaysReformatBibProperty());
 
+        doNotResolveStrings.selectedProperty().bindBidirectional(viewModel.doNotResolveStringsProperty());
+        resolveStrings.selectedProperty().bindBidirectional(viewModel.resolveStringsProperty());
+        resolveStringsForFields.textProperty().bindBidirectional(viewModel.resolveStringsForFieldsProperty());
+        resolveStringsForFields.disableProperty().bind(doNotResolveStrings.selectedProperty());
+
+        alwaysReformatBib.selectedProperty().bindBidirectional(viewModel.alwaysReformatBibProperty());
         autosaveLocalLibraries.selectedProperty().bindBidirectional(viewModel.autosaveLocalLibrariesProperty());
 
         ActionFactory actionFactory = new ActionFactory(Globals.getKeyPrefs());

src/main/java/org/jabref/gui/preferences/file/FileTabViewModel.java

@@ -13,9 +13,9 @@ public class FileTabViewModel implements PreferenceTabViewModel {
 
     private final BooleanProperty openLastStartupProperty = new SimpleBooleanProperty();
     private final StringProperty noWrapFilesProperty = new SimpleStringProperty("");
-    private final BooleanProperty resolveStringsBibTexProperty = new SimpleBooleanProperty();
-    private final BooleanProperty resolveStringsAllProperty = new SimpleBooleanProperty();
-    private final StringProperty resolveStringsExceptProperty = new SimpleStringProperty("");
+    private final BooleanProperty doNotResolveStringsProperty = new SimpleBooleanProperty();
+    private final BooleanProperty resolveStringsProperty = new SimpleBooleanProperty();
+    private final StringProperty resolveStringsForFieldsProperty = new SimpleStringProperty("");
     private final BooleanProperty alwaysReformatBibProperty = new SimpleBooleanProperty();
     private final BooleanProperty autosaveLocalLibraries = new SimpleBooleanProperty();
 
@@ -30,25 +30,22 @@ public class FileTabViewModel implements PreferenceTabViewModel {
     @Override
     public void setValues() {
         openLastStartupProperty.setValue(preferences.shouldOpenLastFilesOnStartup());
-
         noWrapFilesProperty.setValue(importExportPreferences.getNonWrappableFields());
-        resolveStringsAllProperty.setValue(importExportPreferences.shouldResolveStringsForAllStrings()); // Flipped around
-        resolveStringsBibTexProperty.setValue(importExportPreferences.shouldResolveStringsForStandardBibtexFields());
-        resolveStringsExceptProperty.setValue(importExportPreferences.getNonResolvableFields());
 
+        doNotResolveStringsProperty.setValue(importExportPreferences.doNotResolveStrings());
+        resolveStringsProperty.setValue(!importExportPreferences.doNotResolveStrings());
+        resolveStringsForFieldsProperty.setValue(importExportPreferences.getResolvableFields());
         alwaysReformatBibProperty.setValue(importExportPreferences.shouldAlwaysReformatOnSave());
-
         autosaveLocalLibraries.setValue(preferences.shouldAutosave());
     }
 
     @Override
     public void storeSettings() {
         preferences.storeOpenLastFilesOnStartup(openLastStartupProperty.getValue());
 
+        importExportPreferences.setDoNotResolveStrings(doNotResolveStringsProperty.getValue());
         importExportPreferences.setNonWrappableFields(noWrapFilesProperty.getValue().trim());
-        importExportPreferences.setResolveStringsForStandardBibtexFields(resolveStringsBibTexProperty.getValue());
-        importExportPreferences.setResolveStringsForAllStrings(resolveStringsAllProperty.getValue());
-        importExportPreferences.setNonResolvableFields(resolveStringsExceptProperty.getValue().trim());
+        importExportPreferences.setResolvableFields(resolveStringsForFieldsProperty.getValue().trim());
         importExportPreferences.setAlwaysReformatOnSave(alwaysReformatBibProperty.getValue());
 
         preferences.storeShouldAutosave(autosaveLocalLibraries.getValue());
@@ -66,16 +63,16 @@ public StringProperty noWrapFilesProperty() {
         return noWrapFilesProperty;
     }
 
-    public BooleanProperty resolveStringsBibTexProperty() {
-        return resolveStringsBibTexProperty;
+    public BooleanProperty doNotResolveStringsProperty() {
+        return doNotResolveStringsProperty;
     }
 
-    public BooleanProperty resolveStringsAllProperty() {
-        return resolveStringsAllProperty;
+    public BooleanProperty resolveStringsProperty() {
+        return resolveStringsProperty;
     }
 
-    public StringProperty resolveStringsExceptProperty() {
-        return resolveStringsExceptProperty;
+    public StringProperty resolveStringsForFieldsProperty() {
+        return resolveStringsForFieldsProperty;
     }
 
     public BooleanProperty alwaysReformatBibProperty() {

src/main/java/org/jabref/logic/bibtex/FieldWriter.java

@@ -2,8 +2,6 @@
 
 import org.jabref.logic.util.OS;
 import org.jabref.model.entry.field.Field;
-import org.jabref.model.entry.field.InternalField;
-import org.jabref.model.entry.field.StandardField;
 import org.jabref.model.strings.StringUtil;
 
 import org.slf4j.Logger;
@@ -165,13 +163,11 @@ private String formatAndResolveStrings(String content, Field field) throws Inval
     }
 
     private boolean shouldResolveStrings(Field field) {
-        if (preferences.isResolveStringsAllFields()) {
-            // Resolve strings for all fields except some:
-            return !preferences.getDoNotResolveStringsFor().contains(field);
-        } else {
-            // Default operation - we only resolve strings for standard fields:
-            return field instanceof StandardField || InternalField.BIBTEX_STRING.equals(field);
+        if (!preferences.isDoNotResolveStrings()) {
+            // Resolve strings for the list of fields only
+            return preferences.getResolveStringsForFields().contains(field);
         }
+        return false;
     }
 
     private String formatWithoutResolvingStrings(String content, Field field) throws InvalidFieldValueException {

src/main/java/org/jabref/logic/bibtex/FieldWriterPreferences.java

@@ -1,39 +1,41 @@
 package org.jabref.logic.bibtex;
 
-import java.util.Collections;
 import java.util.List;
 
 import org.jabref.model.entry.field.Field;
+import org.jabref.model.entry.field.StandardField;
 
 public class FieldWriterPreferences {
 
-    private final boolean resolveStringsAllFields;
-    private final List<Field> doNotResolveStringsFor;
+    private final boolean doNotResolveStrings;
+    private final List<Field> resolveStringsForFields;
     private final int lineLength = 65; // Constant
     private final FieldContentFormatterPreferences fieldContentFormatterPreferences;
 
-    public FieldWriterPreferences(boolean resolveStringsAllFields, List<Field> doNotResolveStringsFor,
+    public FieldWriterPreferences(boolean doNotResolveFields, List<Field> resolveStringsForFields,
                                   FieldContentFormatterPreferences fieldContentFormatterPreferences) {
-        this.resolveStringsAllFields = resolveStringsAllFields;
-        this.doNotResolveStringsFor = doNotResolveStringsFor;
+        this.doNotResolveStrings = doNotResolveFields;
+        this.resolveStringsForFields = resolveStringsForFields;
         this.fieldContentFormatterPreferences = fieldContentFormatterPreferences;
     }
 
     /**
+     * ONLY USE IN TEST: ONLY resolves BibTex String for the Field Month
      * Creates an instance with default values (not obeying any user preferences). This constructor should be used with
      * caution. The other constructor has to be preferred.
+     * @deprecated
      */
+    @Deprecated
     public FieldWriterPreferences() {
-        // This constructor is only to allow an empty constructor in SavePreferences
-        this(true, Collections.emptyList(), new FieldContentFormatterPreferences());
+        this(false, List.of(StandardField.MONTH), new FieldContentFormatterPreferences());
     }
 
-    public boolean isResolveStringsAllFields() {
-        return resolveStringsAllFields;
+    public boolean isDoNotResolveStrings() {
+        return doNotResolveStrings;
     }
 
-    public List<Field> getDoNotResolveStringsFor() {
-        return doNotResolveStringsFor;
+    public List<Field> getResolveStringsForFields() {
+        return resolveStringsForFields;
     }
 
     public int getLineLength() {

src/main/java/org/jabref/logic/bst/VM.java

@@ -14,6 +14,7 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+import org.jabref.logic.bibtex.FieldContentFormatterPreferences;
 import org.jabref.logic.bibtex.FieldWriter;
 import org.jabref.logic.bibtex.FieldWriterPreferences;
 import org.jabref.logic.bibtex.InvalidFieldValueException;
@@ -927,7 +928,7 @@ public String run(Collection<BibEntry> bibEntries, BibDatabase bibDatabase) {
      * @param bibDatabase
      */
     private void read(BibDatabase bibDatabase) {
-        FieldWriter fieldWriter = new FieldWriter(new FieldWriterPreferences());
+        FieldWriter fieldWriter = new FieldWriter(new FieldWriterPreferences(false, List.of(StandardField.MONTH), new FieldContentFormatterPreferences()));
         for (BstEntry e : entries) {
             for (Map.Entry<String, String> mEntry : e.fields.entrySet()) {
                 Field field = FieldFactory.parseField(mEntry.getKey());

src/main/java/org/jabref/preferences/ImportExportPreferences.java

@@ -10,27 +10,25 @@
 import javafx.beans.property.StringProperty;
 
 public class ImportExportPreferences {
+
     private final StringProperty nonWrappableFields;
-    private final BooleanProperty resolveStringsForStandardBibtexFields;
-    private final BooleanProperty resolveStringsForAllStrings;
-    private final StringProperty nonResolvableFields;
+    private final BooleanProperty doNotResolveStrings;
+    private final StringProperty resolvableFields;
     private final BooleanProperty alwaysReformatOnSave;
     private final ObjectProperty<Path> importWorkingDirectory;
     private final StringProperty lastExportExtension;
     private final ObjectProperty<Path> exportWorkingDirectory;
 
     public ImportExportPreferences(String nonWrappableFields,
-                                   boolean resolveStringsForStandardBibtexFields,
-                                   boolean resolveStringsForAllStrings,
-                                   String nonResolvableFields,
+                                   boolean doNotResolveStrings,
+                                   String resolvableFields,
                                    boolean alwaysReformatOnSave,
                                    Path importWorkingDirectory,
                                    String lastExportExtension,
                                    Path exportWorkingDirectory) {
         this.nonWrappableFields = new SimpleStringProperty(nonWrappableFields);
-        this.resolveStringsForStandardBibtexFields = new SimpleBooleanProperty(resolveStringsForStandardBibtexFields);
-        this.resolveStringsForAllStrings = new SimpleBooleanProperty(resolveStringsForAllStrings);
-        this.nonResolvableFields = new SimpleStringProperty(nonResolvableFields);
+        this.doNotResolveStrings = new SimpleBooleanProperty(doNotResolveStrings);
+        this.resolvableFields = new SimpleStringProperty(resolvableFields);
         this.alwaysReformatOnSave = new SimpleBooleanProperty(alwaysReformatOnSave);
         this.importWorkingDirectory = new SimpleObjectProperty<>(importWorkingDirectory);
         this.lastExportExtension = new SimpleStringProperty(lastExportExtension);
@@ -49,40 +47,28 @@ public void setNonWrappableFields(String nonWrappableFields) {
         this.nonWrappableFields.set(nonWrappableFields);
     }
 
-    public boolean shouldResolveStringsForStandardBibtexFields() {
-        return resolveStringsForStandardBibtexFields.get();
-    }
-
-    public BooleanProperty resolveStringsForStandardBibtexFieldsProperty() {
-        return resolveStringsForStandardBibtexFields;
-    }
-
-    public void setResolveStringsForStandardBibtexFields(boolean resolveStringsForStandardBibtexFields) {
-        this.resolveStringsForStandardBibtexFields.set(resolveStringsForStandardBibtexFields);
-    }
-
-    public boolean shouldResolveStringsForAllStrings() {
-        return resolveStringsForAllStrings.get();
+    public boolean doNotResolveStrings() {
+        return doNotResolveStrings.get();
     }
 
-    public BooleanProperty resolveStringsForAllStringsProperty() {
-        return resolveStringsForAllStrings;
+    public BooleanProperty doNotResolveStringsProperty() {
+        return doNotResolveStrings;
     }
 
-    public void setResolveStringsForAllStrings(boolean resolveStringsForAllStrings) {
-        this.resolveStringsForAllStrings.set(resolveStringsForAllStrings);
+    public void setDoNotResolveStrings(boolean doNotResolveStrings) {
+        this.doNotResolveStrings.set(doNotResolveStrings);
     }
 
-    public String getNonResolvableFields() {
-        return nonResolvableFields.get();
+    public String getResolvableFields() {
+        return resolvableFields.get();
     }
 
-    public StringProperty nonResolvableFieldsProperty() {
-        return nonResolvableFields;
+    public StringProperty resolvableFieldsProperty() {
+        return resolvableFields;
     }
 
-    public void setNonResolvableFields(String nonResolvableFields) {
-        this.nonResolvableFields.set(nonResolvableFields);
+    public void setResolvableFields(String resolvableFields) {
+        this.resolvableFields.set(resolvableFields);
     }
 
     public boolean shouldAlwaysReformatOnSave() {
@@ -132,4 +118,5 @@ public ObjectProperty<Path> exportWorkingDirectoryProperty() {
     public void setExportWorkingDirectory(Path exportWorkingDirectory) {
         this.exportWorkingDirectory.set(exportWorkingDirectory);
     }
+
 }