Improve entrytype customization

CHANGELOG.md

@@ -25,12 +25,21 @@ We refer to [GitHub issues](https://github.com/JabRef/jabref/issues) by using `#
 - Replaces manual thread management with cached thread pool
 - Files can now be moved to subfolders named by a custom format pattern, e.g., based on `entrytype`.
   The pattern can be specified in the settings like the filename pattern. [#1092](https://github.com/JabRef/jabref/issues/1092)
+- Custom EntryTypes are now stored independently for BibTeX and BibLatex mode.
+  - Upon the first start of JabRef 3.8 old entry type customizations will be converted to custom types for the set default database mode (BibTeX if not changed to BibLatex)
+- Upon opening a file with customized entry types it is now possible to choose which customizations should be stored in local preferences.
 
 ### Fixed
 - We fixed a few groups related issues:
   - "Remove entries from group" no longer removes entries from groups with similar names. [#2334](https://github.com/JabRef/jabref/issues/2334)
   - If an entry's group field contains 'a b' it is no longer considered a member the groups 'a', 'b', and 'a b'. [1873](https://github.com/JabRef/jabref/issues/1873)
   - Reading and writing now works for groups that contain special escaped characters in their names. [1681](https://github.com/JabRef/jabref/issues/1681)
+- We fixed various problems with customized entry types:
+  - Resetting the preferences now also resets custom entry types. [#2261](https://github.com/JabRef/jabref/issues/2261)
+  - Importing preferences does no longer duplicate custom entry types. [#772](https://github.com/JabRef/jabref/issues/772)
+  - Potenial problems upon resetting to defaults should be fixed. [#772](https://github.com/JabRef/jabref/issues/772)
+  - Customized standard types (such as `@article`) are no longer listed as "custom" type in "New Entry" dialog. 
+  - Applying changes in the "Custom Entry Types" dialog is now faster. [#2318](https://github.com/JabRef/jabref/issues/2318)
 - We fixed an issue which prevented JabRef from closing using the "Quit" menu command. [#2336](https://github.com/JabRef/jabref/issues/2336)
 - We fixed an issue where the file permissions of the .bib-file were changed upon saving [#2279](https://github.com/JabRef/jabref/issues/2279).
 - We fixed an issue which prevented that a database was saved successfully if JabRef failed to generate new BibTeX-keys [#2285](https://github.com/JabRef/jabref/issues/2285).

src/main/java/net/sf/jabref/JabRefMain.java

@@ -7,7 +7,6 @@
 
 import net.sf.jabref.cli.ArgumentProcessor;
 import net.sf.jabref.gui.remote.JabRefMessageHandler;
-import net.sf.jabref.logic.CustomEntryTypesManager;
 import net.sf.jabref.logic.exporter.ExportFormat;
 import net.sf.jabref.logic.exporter.ExportFormats;
 import net.sf.jabref.logic.exporter.SavePreferences;
@@ -23,6 +22,8 @@
 import net.sf.jabref.logic.remote.client.RemoteListenerClient;
 import net.sf.jabref.logic.util.OS;
 import net.sf.jabref.migrations.PreferencesMigrations;
+import net.sf.jabref.model.EntryTypes;
+import net.sf.jabref.model.database.BibDatabaseMode;
 import net.sf.jabref.model.entry.InternalBibtexFields;
 import net.sf.jabref.preferences.JabRefPreferences;
 
@@ -60,6 +61,7 @@ private static void start(String[] args) {
         PreferencesMigrations.upgradeSortOrder();
         PreferencesMigrations.upgradeFaultyEncodingStrings();
         PreferencesMigrations.upgradeLabelPatternToBibtexKeyPattern();
+        PreferencesMigrations.upgradeStoredCustomEntryTypes();
 
         // Update handling of special fields based on preferences
         InternalBibtexFields
@@ -75,7 +77,8 @@ private static void start(String[] args) {
         /* Build list of Import and Export formats */
         Globals.IMPORT_FORMAT_READER.resetImportFormats(Globals.prefs.getImportFormatPreferences(),
                 Globals.prefs.getXMPPreferences());
-        CustomEntryTypesManager.loadCustomEntryTypes(preferences);
+        EntryTypes.loadCustomEntryTypes(preferences.loadCustomEntryTypes(BibDatabaseMode.BIBTEX),
+                preferences.loadCustomEntryTypes(BibDatabaseMode.BIBLATEX));
         Map<String, ExportFormat> customFormats = Globals.prefs.customExports.getCustomExportFormats(Globals.prefs,
                 Globals.journalAbbreviationLoader);
         LayoutFormatterPreferences layoutPreferences = Globals.prefs

src/main/java/net/sf/jabref/cli/ArgumentProcessor.java

@@ -18,7 +18,6 @@
 import net.sf.jabref.gui.externalfiles.AutoSetLinks;
 import net.sf.jabref.gui.importer.fetcher.EntryFetcher;
 import net.sf.jabref.gui.importer.fetcher.EntryFetchers;
-import net.sf.jabref.logic.CustomEntryTypesManager;
 import net.sf.jabref.logic.bibtexkeypattern.BibtexKeyPatternUtil;
 import net.sf.jabref.logic.exporter.BibDatabaseWriter;
 import net.sf.jabref.logic.exporter.BibtexDatabaseWriter;
@@ -42,13 +41,13 @@
 import net.sf.jabref.logic.search.SearchQuery;
 import net.sf.jabref.logic.util.OS;
 import net.sf.jabref.model.Defaults;
+import net.sf.jabref.model.EntryTypes;
 import net.sf.jabref.model.database.BibDatabase;
 import net.sf.jabref.model.database.BibDatabaseContext;
 import net.sf.jabref.model.database.BibDatabaseMode;
 import net.sf.jabref.model.entry.BibEntry;
 import net.sf.jabref.model.metadata.MetaData;
 import net.sf.jabref.model.strings.StringUtil;
-import net.sf.jabref.preferences.JabRefPreferences;
 import net.sf.jabref.preferences.SearchPreferences;
 import net.sf.jabref.shared.prefs.SharedDatabasePreferences;
 
@@ -299,8 +298,7 @@ private boolean generateAux(List<ParserResult> loaded, String[] data) {
                     System.out.println(Localization.lang("Saving") + ": " + subName);
                     SavePreferences prefs = SavePreferences.loadForSaveFromPreferences(Globals.prefs);
                     BibDatabaseWriter<SaveSession> databaseWriter = new BibtexDatabaseWriter<>(FileSaveSession::new);
-                    Defaults defaults = new Defaults(BibDatabaseMode
-                            .fromPreference(Globals.prefs.getBoolean(JabRefPreferences.BIBLATEX_DEFAULT_MODE)));
+                    Defaults defaults = new Defaults(Globals.prefs.getDefaultBibDatabaseMode());
                     SaveSession session = databaseWriter.saveDatabase(new BibDatabaseContext(newBase, defaults), prefs);
 
                     // Show just a warning message if encoding did not work for all characters:
@@ -338,8 +336,7 @@ private void exportFile(List<ParserResult> loaded, String[] data) {
                     try {
                         System.out.println(Localization.lang("Saving") + ": " + data[0]);
                         SavePreferences prefs = SavePreferences.loadForSaveFromPreferences(Globals.prefs);
-                        Defaults defaults = new Defaults(BibDatabaseMode
-                                .fromPreference(Globals.prefs.getBoolean(JabRefPreferences.BIBLATEX_DEFAULT_MODE)));
+                        Defaults defaults = new Defaults(Globals.prefs.getDefaultBibDatabaseMode());
                         BibDatabaseWriter<SaveSession> databaseWriter = new BibtexDatabaseWriter<>(
                                 FileSaveSession::new);
                         SaveSession session = databaseWriter.saveDatabase(
@@ -401,7 +398,8 @@ private void exportFile(List<ParserResult> loaded, String[] data) {
     private void importPreferences() {
         try {
             Globals.prefs.importPreferences(cli.getPreferencesImport());
-            CustomEntryTypesManager.loadCustomEntryTypes(Globals.prefs);
+            EntryTypes.loadCustomEntryTypes(Globals.prefs.loadCustomEntryTypes(BibDatabaseMode.BIBTEX),
+                    Globals.prefs.loadCustomEntryTypes(BibDatabaseMode.BIBLATEX));
             Map<String, ExportFormat> customFormats = Globals.prefs.customExports.getCustomExportFormats(Globals.prefs,
                     Globals.journalAbbreviationLoader);
             LayoutFormatterPreferences layoutPreferences = Globals.prefs

src/main/java/net/sf/jabref/collab/ChangeScanner.java

@@ -32,14 +32,12 @@
 import net.sf.jabref.model.DuplicateCheck;
 import net.sf.jabref.model.database.BibDatabase;
 import net.sf.jabref.model.database.BibDatabaseContext;
-import net.sf.jabref.model.database.BibDatabaseMode;
 import net.sf.jabref.model.database.EntrySorter;
 import net.sf.jabref.model.entry.BibEntry;
 import net.sf.jabref.model.entry.BibtexString;
 import net.sf.jabref.model.entry.FieldName;
 import net.sf.jabref.model.groups.GroupTreeNode;
 import net.sf.jabref.model.metadata.MetaData;
-import net.sf.jabref.preferences.JabRefPreferences;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
@@ -152,8 +150,7 @@ private void storeTempDatabase() {
                         .withEncoding(panel.getBibDatabaseContext().getMetaData().getEncoding()
                                 .orElse(Globals.prefs.getDefaultEncoding()));
 
-                Defaults defaults = new Defaults(BibDatabaseMode
-                        .fromPreference(Globals.prefs.getBoolean(JabRefPreferences.BIBLATEX_DEFAULT_MODE)));
+                Defaults defaults = new Defaults(Globals.prefs.getDefaultBibDatabaseMode());
                 BibDatabaseWriter<SaveSession> databaseWriter = new BibtexDatabaseWriter<>(FileSaveSession::new);
                 SaveSession ss = databaseWriter.saveDatabase(new BibDatabaseContext(databaseInTemp, metadataInTemp, defaults), prefs);
                 ss.commit(Globals.getFileUpdateMonitor().getTempFile(panel.fileMonitorHandle()));

src/main/java/net/sf/jabref/gui/EntryTypeDialog.java

@@ -9,6 +9,7 @@
 import java.awt.event.WindowAdapter;
 import java.awt.event.WindowEvent;
 import java.util.Collection;
+import java.util.List;
 import java.util.Optional;
 import java.util.concurrent.ExecutionException;
 
@@ -28,13 +29,13 @@
 import net.sf.jabref.Globals;
 import net.sf.jabref.gui.importer.fetcher.EntryFetchers;
 import net.sf.jabref.gui.keyboard.KeyBinding;
-import net.sf.jabref.logic.CustomEntryTypesManager;
 import net.sf.jabref.logic.importer.FetcherException;
 import net.sf.jabref.logic.importer.IdBasedFetcher;
 import net.sf.jabref.logic.l10n.Localization;
 import net.sf.jabref.model.EntryTypes;
-import net.sf.jabref.model.database.BibDatabaseContext;
+import net.sf.jabref.model.database.BibDatabaseMode;
 import net.sf.jabref.model.entry.BibEntry;
+import net.sf.jabref.model.entry.BibLatexEntryTypes;
 import net.sf.jabref.model.entry.BibtexEntryTypes;
 import net.sf.jabref.model.entry.EntryType;
 import net.sf.jabref.model.entry.IEEETranEntryTypes;
@@ -59,10 +60,8 @@ public class EntryTypeDialog extends JDialog implements ActionListener {
     private JComboBox<String> comboBox;
     private final JabRefFrame frame;
     private static final int COLUMN = 3;
-    private final boolean biblatexMode;
 
     private final CancelAction cancelAction = new CancelAction();
-    private final BibDatabaseContext bibDatabaseContext;
 
     static class TypeButton extends JButton implements Comparable<TypeButton> {
 
@@ -90,10 +89,6 @@ public EntryTypeDialog(JabRefFrame frame) {
 
         this.frame = frame;
 
-        bibDatabaseContext = frame.getCurrentBasePanel().getBibDatabaseContext();
-        biblatexMode = bibDatabaseContext.isBiblatexMode();
-
-
         setTitle(Localization.lang("Select entry type"));
 
         addWindowListener(new WindowAdapter() {
@@ -115,14 +110,21 @@ private JPanel createEntryGroupsPanel() {
         JPanel panel = new JPanel();
         panel.setLayout(new VerticalLayout());
 
-        if (biblatexMode) {
-            panel.add(createEntryGroupPanel("BibLateX", EntryTypes.getAllValues(bibDatabaseContext.getMode())));
+        if (frame.getCurrentBasePanel().getBibDatabaseContext().isBiblatexMode()) {
+            panel.add(createEntryGroupPanel("BibLateX", BibLatexEntryTypes.ALL));
+
+            List<EntryType> customTypes = EntryTypes.getAllCustomTypes(BibDatabaseMode.BIBLATEX);
+            if (!customTypes.isEmpty()) {
+                panel.add(createEntryGroupPanel(Localization.lang("Custom"), customTypes));
+            }
+
         } else {
             panel.add(createEntryGroupPanel("BibTeX", BibtexEntryTypes.ALL));
             panel.add(createEntryGroupPanel("IEEETran", IEEETranEntryTypes.ALL));
 
-            if (!CustomEntryTypesManager.ALL.isEmpty()) {
-                panel.add(createEntryGroupPanel(Localization.lang("Custom"), CustomEntryTypesManager.ALL));
+            List<EntryType> customTypes = EntryTypes.getAllCustomTypes(BibDatabaseMode.BIBTEX);
+            if (!customTypes.isEmpty()) {
+                panel.add(createEntryGroupPanel(Localization.lang("Custom"), customTypes));
             }
         }
         panel.add(createIdFetcherPanel());
@@ -146,7 +148,7 @@ private JPanel createCancelButtonBarPanel() {
         return buttons;
     }
 
-    private JPanel createEntryGroupPanel(String groupTitle, Collection<EntryType> entries) {
+    private JPanel createEntryGroupPanel(String groupTitle, Collection<? extends EntryType> entries) {
         JPanel panel = new JPanel();
         GridBagLayout bagLayout = new GridBagLayout();
         panel.setLayout(bagLayout);

src/main/java/net/sf/jabref/gui/JabRefFrame.java

@@ -76,6 +76,7 @@
 import net.sf.jabref.gui.actions.SortTabsAction;
 import net.sf.jabref.gui.autosaveandbackup.AutosaveUIManager;
 import net.sf.jabref.gui.bibtexkeypattern.BibtexKeyPatternDialog;
+import net.sf.jabref.gui.customentrytypes.EntryCustomizationDialog;
 import net.sf.jabref.gui.dbproperties.DatabasePropertiesDialog;
 import net.sf.jabref.gui.exporter.ExportAction;
 import net.sf.jabref.gui.exporter.ExportCustomizationDialog;
@@ -109,7 +110,6 @@
 import net.sf.jabref.gui.specialfields.SpecialFieldValueViewModel;
 import net.sf.jabref.gui.util.WindowLocation;
 import net.sf.jabref.gui.worker.MarkEntriesAction;
-import net.sf.jabref.logic.CustomEntryTypesManager;
 import net.sf.jabref.logic.autosaveandbackup.AutosaveManager;
 import net.sf.jabref.logic.autosaveandbackup.BackupManager;
 import net.sf.jabref.logic.help.HelpFile;
@@ -788,7 +788,6 @@ private void tearDownJabRef(List<String> filenames) {
         fileHistory.storeHistory();
         prefs.customExports.store(Globals.prefs);
         prefs.customImports.store();
-        CustomEntryTypesManager.saveCustomEntryTypes(prefs);
 
         prefs.flush();
 

src/main/java/net/sf/jabref/gui/actions/NewSubDatabaseAction.java

@@ -12,8 +12,6 @@
 import net.sf.jabref.logic.l10n.Localization;
 import net.sf.jabref.model.Defaults;
 import net.sf.jabref.model.database.BibDatabaseContext;
-import net.sf.jabref.model.database.BibDatabaseMode;
-import net.sf.jabref.preferences.JabRefPreferences;
 
 /**
  * The action concerned with generate a new (sub-)database from latex AUX file.
@@ -39,8 +37,7 @@ public void actionPerformed(ActionEvent e) {
         dialog.setVisible(true);
 
         if (dialog.generatePressed()) {
-            Defaults defaults = new Defaults(
-                    BibDatabaseMode.fromPreference(Globals.prefs.getBoolean(JabRefPreferences.BIBLATEX_DEFAULT_MODE)));
+            Defaults defaults = new Defaults(Globals.prefs.getDefaultBibDatabaseMode());
             BasePanel bp = new BasePanel(jabRefFrame, new BibDatabaseContext(dialog.getGenerateDB(), defaults));
             jabRefFrame.addTab(bp, true);
             jabRefFrame.output(Localization.lang("New database created."));

src/main/java/net/sf/jabref/gui/customentrytypes/CustomEntryTypesManager.java

@@ -0,0 +1,32 @@
+package net.sf.jabref.gui.customentrytypes;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+import net.sf.jabref.model.EntryTypes;
+import net.sf.jabref.model.database.BibDatabaseMode;
+import net.sf.jabref.model.entry.CustomEntryType;
+import net.sf.jabref.preferences.JabRefPreferences;
+
+public class CustomEntryTypesManager {
+
+    /**
+     * Iterate through all entry types, and store those that are
+     * custom defined to preferences. This method is called from
+     * JabRefFrame when the program closes.
+     */
+    public static void saveCustomEntryTypes(JabRefPreferences prefs) {
+        saveCustomEntryTypes(prefs, BibDatabaseMode.BIBTEX);
+        saveCustomEntryTypes(prefs, BibDatabaseMode.BIBLATEX);
+
+    }
+
+    private static void saveCustomEntryTypes(JabRefPreferences prefs, BibDatabaseMode mode) {
+        List<CustomEntryType> customBiblatexTypes = EntryTypes.getAllValues(mode).stream()
+                .filter(type -> type instanceof CustomEntryType)
+                .map(entryType -> (CustomEntryType) entryType).collect(Collectors.toList());
+
+        prefs.storeCustomEntryTypes(customBiblatexTypes, mode);
+    }
+
+}