Remove dash from illegal characters. (#6300)

CHANGELOG.md

@@ -11,6 +11,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
 
 ### Added
 
+- We added a new field in the preferences in 'BibTeX key generator' for unwanted characters that can be user-specified. [#6295](https://github.com/JabRef/jabref/issues/6295)
 - We added support for searching ShortScience for an entry through the user's browser. [#6018](https://github.com/JabRef/jabref/pull/6018)
 - We updated EditionChecker to permit edition to start with a number. [#6144](https://github.com/JabRef/jabref/issues/6144)
 - We added tooltips for most fields in the entry editor containing a short description. [#5847](https://github.com/JabRef/jabref/issues/5847)
@@ -33,6 +34,8 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
 ### Fixed
 
 - We fixed wrong button order (Apply and Cancel) in ManageProtectedTermsDialog.
+- We fixed an issue with incompatible characters at BibTeX key [#6257](https://github.com/JabRef/jabref/issues/6257)
+- We fixed an issue where dash (`-`) was reported as illegal BibTeX key [#6295](https://github.com/JabRef/jabref/issues/6295)
 - We greatly improved the performance of the overall application and many operations. [#5071](https://github.com/JabRef/jabref/issues/5071)
 - We fixed an issue where sort by priority was broken. [#6222](https://github.com/JabRef/jabref/issues/6222)
 - We fixed an issue where opening a library from the recent libraries menu was not possible. [#5939](https://github.com/JabRef/jabref/issues/5939)
@@ -53,6 +56,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
 
 ### Removed
 
+- We removed the option of the "enforce legal key". [#6295](https://github.com/JabRef/jabref/issues/6295)
 - We removed the obsolete `External programs / Open PDF` section in the preferences, as the default application to open PDFs is now set in the `Manage external file types` dialog. [#6130](https://github.com/JabRef/jabref/pull/6130)
 - We removed the option to configure whether a `.bib.bak` file should be generated upon save. It is now always enabled. Documentation at <https://docs.jabref.org/general/autosave>. [#6092](https://github.com/JabRef/jabref/issues/6092)
 - We removed the built-in list of IEEE journal abbreviations using BibTeX strings. If you still want to use them, you have to download them separately from <https://abbrv.jabref.org>.

src/main/java/org/jabref/gui/customizefields/CustomizeGeneralFieldsDialogViewModel.java

@@ -58,7 +58,7 @@ public void saveFields() {
                 return;
             }
 
-            String testString = BibtexKeyGenerator.cleanKey(parts[1], preferences.getEnforceLegalKeys());
+            String testString = BibtexKeyGenerator.cleanKey(parts[1], preferences.getUnwantedCharacters());
             if (!testString.equals(parts[1]) || (parts[1].indexOf('&') >= 0)) {
                 dialogService.showInformationDialogAndWait(
                         Localization.lang("Error"),

src/main/java/org/jabref/gui/fieldeditors/FieldEditors.java

@@ -49,7 +49,6 @@ public static FieldEditorFX getForField(final Field field,
                 databaseContext,
                 preferences.getFilePreferences(),
                 journalAbbreviationRepository,
-                preferences.getBoolean(JabRefPreferences.ENFORCE_LEGAL_BIBTEX_KEY),
                 preferences.getBoolean(JabRefPreferences.ALLOW_INTEGER_EDITION_BIBTEX));
 
         final boolean isSingleLine = FieldFactory.isSingleLineField(field);

src/main/java/org/jabref/gui/integrity/IntegrityCheckAction.java

@@ -45,7 +45,6 @@ public void execute() {
                 Globals.prefs.getFilePreferences(),
                 Globals.prefs.getBibtexKeyPatternPreferences(),
                 Globals.journalAbbreviationRepository,
-                Globals.prefs.getBoolean(JabRefPreferences.ENFORCE_LEGAL_BIBTEX_KEY),
                 Globals.prefs.getBoolean(JabRefPreferences.ALLOW_INTEGER_EDITION_BIBTEX));
 
         Task<List<IntegrityMessage>> task = new Task<>() {

src/main/java/org/jabref/gui/preferences/BibtexKeyPatternTab.fxml

@@ -49,6 +49,11 @@
         </padding>
     </HBox>
 
+    <HBox alignment="CENTER_LEFT" spacing="10.0">
+        <Label text="%Remove the following characters:"/>
+        <TextField fx:id="unwantedCharacters" HBox.hgrow="ALWAYS"/>
+    </HBox>
+
     <HBox prefWidth="650.0">
         <Label styleClass="sectionHeader" text="%Key patterns"/>
         <HBox HBox.hgrow="ALWAYS"/>

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

@@ -28,6 +28,7 @@ public class BibtexKeyPatternTabView extends AbstractPreferenceTabView<BibtexKey
     @FXML public RadioButton letterAlwaysAdd;
     @FXML public TextField keyPatternRegex;
     @FXML public TextField keyPatternReplacement;
+    @FXML public TextField unwantedCharacters;
     @FXML public HBox keyPatternContainer;
     @FXML public Button keyPatternHelp;
 
@@ -61,6 +62,7 @@ public void initialize() {
         letterAlwaysAdd.selectedProperty().bindBidirectional(viewModel.letterAlwaysAddProperty());
         keyPatternRegex.textProperty().bindBidirectional(viewModel.keyPatternRegexProperty());
         keyPatternReplacement.textProperty().bindBidirectional(viewModel.keyPatternReplacementProperty());
+        unwantedCharacters.textProperty().bindBidirectional(viewModel.unwantedCharactersProperty());
 
         bibtexKeyPatternTable.setPrefWidth(650.0);
         bibtexKeyPatternTable.patternListProperty().bindBidirectional(viewModel.patternListProperty());

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

@@ -29,6 +29,7 @@ public class BibtexKeyPatternTabViewModel implements PreferenceTabViewModel {
     private BooleanProperty letterAlwaysAddProperty = new SimpleBooleanProperty();
     private StringProperty keyPatternRegexProperty = new SimpleStringProperty();
     private StringProperty keyPatternReplacementProperty = new SimpleStringProperty();
+    private StringProperty unwantedCharactersProperty = new SimpleStringProperty();
 
     // The list and the default properties are being overwritten by the bound properties of the tableView, but to
     // prevent an NPE on storing the preferences before lazy-loading of the setValues, they need to be initialized.
@@ -66,6 +67,7 @@ public void setValues() {
 
         keyPatternRegexProperty.setValue(preferences.get(JabRefPreferences.KEY_PATTERN_REGEX));
         keyPatternReplacementProperty.setValue(preferences.get(JabRefPreferences.KEY_PATTERN_REPLACEMENT));
+        unwantedCharactersProperty.setValue(preferences.get(JabRefPreferences.UNWANTED_BIBTEX_KEY_CHARACTERS));
     }
 
     @Override
@@ -92,6 +94,7 @@ public void storeSettings() {
 
         preferences.put(JabRefPreferences.KEY_PATTERN_REGEX, keyPatternRegexProperty.getValue());
         preferences.put(JabRefPreferences.KEY_PATTERN_REPLACEMENT, keyPatternReplacementProperty.getValue());
+        preferences.put(JabRefPreferences.UNWANTED_BIBTEX_KEY_CHARACTERS, unwantedCharactersProperty.getValue());
 
         GlobalBibtexKeyPattern newKeyPattern = GlobalBibtexKeyPattern.fromPattern(preferences.get(JabRefPreferences.DEFAULT_BIBTEX_KEY_PATTERN));
         patternListProperty.forEach(item -> {
@@ -136,4 +139,6 @@ public void storeSettings() {
     public ListProperty<BibtexKeyPatternPanelItemModel> patternListProperty() { return patternListProperty; }
 
     public ObjectProperty<BibtexKeyPatternPanelItemModel> defaultKeyPatternProperty() { return defaultKeyPatternProperty; }
+
+    public StringProperty unwantedCharactersProperty() { return unwantedCharactersProperty; }
 }

src/main/java/org/jabref/gui/preferences/GeneralTab.fxml

@@ -35,7 +35,6 @@
     <CheckBox fx:id="inspectionWarningDuplicate"
               text="%Warn about unresolved duplicates when closing inspection window"/>
     <CheckBox fx:id="confirmDelete" text="%Show confirmation dialog when deleting entries"/>
-    <CheckBox fx:id="enforceLegalKeys" text="%Enforce legal characters in BibTeX keys"/>
     <CheckBox fx:id="allowIntegerEdition" text="%Allow integers in 'edition' field in BibTeX mode"/>
     <CheckBox fx:id="memoryStickMode"
               text="%Load and Save preferences from/to jabref.xml on start-up (memory stick mode)"/>

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

@@ -32,7 +32,6 @@ public class GeneralTabView extends AbstractPreferenceTabView<GeneralTabViewMode
     @FXML private ComboBox<BibDatabaseMode> biblatexMode;
     @FXML private CheckBox inspectionWarningDuplicate;
     @FXML private CheckBox confirmDelete;
-    @FXML private CheckBox enforceLegalKeys;
     @FXML private CheckBox allowIntegerEdition;
     @FXML private CheckBox memoryStickMode;
     @FXML private CheckBox collectTelemetry;
@@ -86,7 +85,6 @@ public void initialize() {
 
         inspectionWarningDuplicate.selectedProperty().bindBidirectional(viewModel.inspectionWarningDuplicateProperty());
         confirmDelete.selectedProperty().bindBidirectional(viewModel.confirmDeleteProperty());
-        enforceLegalKeys.selectedProperty().bindBidirectional(viewModel.enforceLegalKeysProperty());
         allowIntegerEdition.selectedProperty().bindBidirectional(viewModel.allowIntegerEditionProperty());
         memoryStickMode.selectedProperty().bindBidirectional(viewModel.memoryStickModeProperty());
         collectTelemetry.selectedProperty().bindBidirectional(viewModel.collectTelemetryProperty());

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

@@ -43,7 +43,6 @@ public class GeneralTabViewModel implements PreferenceTabViewModel {
     private final BooleanProperty confirmDeleteProperty = new SimpleBooleanProperty();
     private final BooleanProperty memoryStickModeProperty = new SimpleBooleanProperty();
     private final BooleanProperty collectTelemetryProperty = new SimpleBooleanProperty();
-    private final BooleanProperty enforceLegalKeysProperty = new SimpleBooleanProperty();
     private final BooleanProperty allowIntegerEditionProperty = new SimpleBooleanProperty();
     private final BooleanProperty showAdvancedHintsProperty = new SimpleBooleanProperty();
     private final BooleanProperty markOwnerProperty = new SimpleBooleanProperty();
@@ -105,7 +104,6 @@ public void setValues() {
 
         inspectionWarningDuplicateProperty.setValue(initialGeneralPreferences.isWarnAboutDuplicatesInInspection());
         confirmDeleteProperty.setValue(initialGeneralPreferences.isConfirmDelete());
-        enforceLegalKeysProperty.setValue(initialGeneralPreferences.isEnforceLegalBibtexKey());
         allowIntegerEditionProperty.setValue(initialGeneralPreferences.isAllowIntegerEditionBibtex());
         memoryStickModeProperty.setValue(initialGeneralPreferences.isMemoryStickMode());
         collectTelemetryProperty.setValue(preferencesService.shouldCollectTelemetry());
@@ -141,7 +139,6 @@ public void storeSettings() {
                 selectedBiblatexModeProperty.getValue(),
                 inspectionWarningDuplicateProperty.getValue(),
                 confirmDeleteProperty.getValue(),
-                enforceLegalKeysProperty.getValue(),
                 allowIntegerEditionProperty.getValue(),
                 memoryStickModeProperty.getValue(),
                 collectTelemetryProperty.getValue(),
@@ -199,8 +196,6 @@ public boolean validateSettings() {
 
     public BooleanProperty collectTelemetryProperty() { return this.collectTelemetryProperty; }
 
-    public BooleanProperty enforceLegalKeysProperty() { return this.enforceLegalKeysProperty; }
-
     public BooleanProperty allowIntegerEditionProperty() { return this.allowIntegerEditionProperty; }
 
     public BooleanProperty showAdvancedHintsProperty() { return this.showAdvancedHintsProperty; }

src/main/java/org/jabref/logic/bibtexkeypattern/BibtexKeyGenerator.java

@@ -1,6 +1,7 @@
 package org.jabref.logic.bibtexkeypattern;
 
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
@@ -26,9 +27,10 @@ public class BibtexKeyGenerator extends BracketedPattern {
      * All single characters that we can use for extending a key to make it unique.
      */
     public static final String APPENDIX_CHARACTERS = "abcdefghijklmnopqrstuvwxyz";
+    public static final String DEFAULT_UNWANTED_CHARACTERS = "-`ʹ:!;?^+";
     private static final Logger LOGGER = LoggerFactory.getLogger(BibtexKeyGenerator.class);
-    private static final String KEY_ILLEGAL_CHARACTERS = "{}(),\\\"-#~^:'`ʹ";
-    private static final String KEY_UNWANTED_CHARACTERS = "{}(),\\\"-";
+    // Source of disallowed characters : https://tex.stackexchange.com/a/408548/9075
+    private static final List<Character> DISALLOWED_CHARACTERS = Arrays.asList('{', '}', '(', ')', ',', '=', '\\', '"', '#', '%', '~', '\'');
     private final AbstractBibtexKeyPattern citeKeyPattern;
     private final BibDatabase database;
     private final BibtexKeyPatternPreferences bibtexKeyPatternPreferences;
@@ -45,14 +47,16 @@ public BibtexKeyGenerator(AbstractBibtexKeyPattern citeKeyPattern, BibDatabase d
         this.bibtexKeyPatternPreferences = Objects.requireNonNull(bibtexKeyPatternPreferences);
     }
 
+    @Deprecated
     static String generateKey(BibEntry entry, String pattern) {
         return generateKey(entry, pattern, new BibDatabase());
     }
 
+    @Deprecated
     static String generateKey(BibEntry entry, String pattern, BibDatabase database) {
         GlobalBibtexKeyPattern keyPattern = new GlobalBibtexKeyPattern(Collections.emptyList());
         keyPattern.setDefaultValue("[" + pattern + "]");
-        return new BibtexKeyGenerator(keyPattern, database, new BibtexKeyPatternPreferences("", "", false, true, true, keyPattern, ',', false))
+        return new BibtexKeyGenerator(keyPattern, database, new BibtexKeyPatternPreferences("", "", false, true, keyPattern, ',', false, DEFAULT_UNWANTED_CHARACTERS))
                 .generateKey(entry);
     }
 
@@ -73,36 +77,21 @@ private static String getAppendix(int number) {
         }
     }
 
-    public static String removeUnwantedCharacters(String key, boolean enforceLegalKey) {
-        if (!enforceLegalKey) {
-            // User doesn't want us to enforce legal characters. We must still look
-            // for whitespace and some characters such as commas, since these would
-            // interfere with parsing:
-            StringBuilder newKey = new StringBuilder();
-            for (int i = 0; i < key.length(); i++) {
-                char c = key.charAt(i);
-                if (KEY_UNWANTED_CHARACTERS.indexOf(c) == -1) {
-                    newKey.append(c);
-                }
-            }
-            return newKey.toString();
-        }
-
-        StringBuilder newKey = new StringBuilder();
-        for (int i = 0; i < key.length(); i++) {
-            char c = key.charAt(i);
-            if (KEY_ILLEGAL_CHARACTERS.indexOf(c) == -1) {
-                newKey.append(c);
-            }
-        }
+    public static String removeUnwantedCharacters(String key, String unwantedCharacters) {
+        String newKey = key.chars()
+                           .filter(c -> unwantedCharacters.indexOf(c) == -1)
+                           .filter(c -> !DISALLOWED_CHARACTERS.contains((char) c))
+                           .collect(StringBuilder::new,
+                                   StringBuilder::appendCodePoint, StringBuilder::append)
+                           .toString();
 
         // Replace non-English characters like umlauts etc. with a sensible
         // letter or letter combination that bibtex can accept.
-        return StringUtil.replaceSpecialCharacters(newKey.toString());
+        return StringUtil.replaceSpecialCharacters(newKey);
     }
 
-    public static String cleanKey(String key, boolean enforceLegalKey) {
-        return removeUnwantedCharacters(key, enforceLegalKey).replaceAll("\\s", "");
+    public static String cleanKey(String key, String unwantedCharacters) {
+        return removeUnwantedCharacters(key, unwantedCharacters).replaceAll("\\s", "");
     }
 
     public String generateKey(BibEntry entry) {
@@ -128,17 +117,14 @@ public String generateKey(BibEntry entry) {
                     List<String> parts = parseFieldMarker(typeListEntry);
                     Character delimiter = bibtexKeyPatternPreferences.getKeywordDelimiter();
                     String pattern = "[" + parts.get(0) + "]";
-                    String label = expandBrackets(pattern, delimiter, entry, database, bibtexKeyPatternPreferences.isEnforceLegalKey());
+                    String label = expandBrackets(pattern, delimiter, entry, database);
                     // apply modifier if present
                     if (parts.size() > 1) {
                         label = applyModifiers(label, parts, 1);
                     }
-
                     // Remove all illegal characters from the label.
-                    label = cleanKey(label, bibtexKeyPatternPreferences.isEnforceLegalKey());
-
+                    label = cleanKey(label, bibtexKeyPatternPreferences.getUnwantedCharacters());
                     stringBuilder.append(label);
-
                 } else {
                     stringBuilder.append(typeListEntry);
                 }

src/main/java/org/jabref/logic/bibtexkeypattern/BibtexKeyPatternPreferences.java

@@ -8,28 +8,28 @@ public class BibtexKeyPatternPreferences {
     private final String keyPatternReplacement;
     private final boolean alwaysAddLetter;
     private final boolean firstLetterA;
-    private final boolean enforceLegalKey;
     private final GlobalBibtexKeyPattern keyPattern;
     private Character keywordDelimiter;
     private boolean avoidOverwritingCiteKey;
+    private String unwantedCharacters;
 
     public BibtexKeyPatternPreferences(String keyPatternRegex,
                                        String keyPatternReplacement,
                                        boolean alwaysAddLetter,
                                        boolean firstLetterA,
-                                       boolean enforceLegalKey,
                                        GlobalBibtexKeyPattern keyPattern,
                                        Character keywordDelimiter,
-                                       boolean avoidOverwritingCiteKey) {
+                                       boolean avoidOverwritingCiteKey,
+                                       String unwantedCharacters) {
 
         this.keyPatternRegex = keyPatternRegex;
         this.keyPatternReplacement = keyPatternReplacement;
         this.alwaysAddLetter = alwaysAddLetter;
         this.firstLetterA = firstLetterA;
-        this.enforceLegalKey = enforceLegalKey;
         this.keyPattern = keyPattern;
         this.keywordDelimiter = keywordDelimiter;
         this.avoidOverwritingCiteKey = avoidOverwritingCiteKey;
+        this.unwantedCharacters = unwantedCharacters;
     }
 
     public String getKeyPatternRegex() {
@@ -48,8 +48,8 @@ public boolean isFirstLetterA() {
         return firstLetterA;
     }
 
-    public boolean isEnforceLegalKey() {
-        return enforceLegalKey;
+    public String getUnwantedCharacters() {
+        return unwantedCharacters;
     }
 
     public GlobalBibtexKeyPattern getKeyPattern() {