Support customized entry types in BibliographyConsistencyCheck

jabgui/src/main/java/org/jabref/Launcher.java

@@ -27,6 +27,7 @@
 import org.jabref.logic.util.BuildInfo;
 import org.jabref.logic.util.Directories;
 import org.jabref.migrations.PreferencesMigrations;
+import org.jabref.model.entry.BibEntryTypesManager;
 
 import com.airhacks.afterburner.injection.Injector;
 import org.slf4j.Logger;
@@ -56,6 +57,7 @@ public static void main(String[] args) {
         Injector.setModelOrService(BuildInfo.class, new BuildInfo());
 
         final JabRefGuiPreferences preferences = JabRefGuiPreferences.getInstance();
+        final BibEntryTypesManager bibEntryTypesManager = new BibEntryTypesManager();
 
         ArgumentProcessor argumentProcessor = new ArgumentProcessor(
                 args,
@@ -87,7 +89,7 @@ public static void main(String[] args) {
             systemExit();
         }
 
-        PreferencesMigrations.runMigrations(preferences);
+        PreferencesMigrations.runMigrations(preferences, bibEntryTypesManager);
 
         PostgreServer postgreServer = new PostgreServer();
         Injector.setModelOrService(PostgreServer.class, postgreServer);

jabgui/src/main/java/org/jabref/gui/JabRefGUI.java

@@ -42,6 +42,7 @@
 import org.jabref.logic.l10n.Localization;
 import org.jabref.logic.net.ProxyRegisterer;
 import org.jabref.logic.os.OS;
+import org.jabref.logic.preferences.CliPreferences;
 import org.jabref.logic.protectedterms.ProtectedTermsLoader;
 import org.jabref.logic.remote.RemotePreferences;
 import org.jabref.logic.remote.server.RemoteListenerServerManager;
@@ -70,6 +71,7 @@ public class JabRefGUI extends Application {
 
     private static List<UiCommand> uiCommands;
     private static GuiPreferences preferences;
+    private static CliPreferences cliPreferences;
 
     // AI Service handles chat messages etc. Therefore, it is tightly coupled to the GUI.
     private static AiService aiService;
@@ -84,6 +86,7 @@ public class JabRefGUI extends Application {
     private static ClipBoardManager clipBoardManager;
     private static DialogService dialogService;
     private static JabRefFrame mainFrame;
+    private static BibEntryTypesManager bibEntryTypesManager;
 
     private static RemoteListenerServerManager remoteListenerServerManager;
     private static HttpServerManager httpServerManager;
@@ -114,6 +117,7 @@ public void start(Stage stage) {
                 dialogService,
                 fileUpdateMonitor,
                 preferences,
+                cliPreferences,
                 aiService,
                 stateManager,
                 countingUndoManager,
@@ -157,7 +161,7 @@ public void initialize() {
         DirectoryMonitor directoryMonitor = new DirectoryMonitor();
         Injector.setModelOrService(DirectoryMonitor.class, directoryMonitor);
 
-        BibEntryTypesManager entryTypesManager = preferences.getCustomEntryTypesRepository();
+        BibEntryTypesManager entryTypesManager = preferences.getCustomEntryTypesRepository(bibEntryTypesManager);
         JournalAbbreviationRepository journalAbbreviationRepository = JournalAbbreviationLoader.loadRepository(preferences.getJournalAbbreviationPreferences());
         Injector.setModelOrService(BibEntryTypesManager.class, entryTypesManager);
         Injector.setModelOrService(JournalAbbreviationRepository.class, journalAbbreviationRepository);

jabgui/src/main/java/org/jabref/gui/consistency/ConsistencyCheckAction.java

@@ -13,6 +13,7 @@
 import org.jabref.gui.preferences.GuiPreferences;
 import org.jabref.gui.util.UiTaskExecutor;
 import org.jabref.logic.l10n.Localization;
+import org.jabref.logic.preferences.CliPreferences;
 import org.jabref.logic.quality.consistency.BibliographyConsistencyCheck;
 import org.jabref.model.database.BibDatabaseContext;
 import org.jabref.model.entry.BibEntryTypesManager;
@@ -29,19 +30,22 @@ public class ConsistencyCheckAction extends SimpleCommand {
     private final DialogService dialogService;
     private final StateManager stateManager;
     private final GuiPreferences preferences;
+    private final CliPreferences cliPreferences;
     private final BibEntryTypesManager entryTypesManager;
     private final UiTaskExecutor taskExecutor;
 
     public ConsistencyCheckAction(Supplier<LibraryTab> tabSupplier,
                                   DialogService dialogService,
                                   StateManager stateManager,
                                   GuiPreferences preferences,
+                                  CliPreferences cliPreferences,
                                   BibEntryTypesManager entryTypesManager,
                                   UiTaskExecutor taskExecutor) {
         this.tabSupplier = tabSupplier;
         this.dialogService = dialogService;
         this.stateManager = stateManager;
         this.preferences = preferences;
+        this.cliPreferences = cliPreferences;
         this.entryTypesManager = entryTypesManager;
         this.taskExecutor = taskExecutor;
 
@@ -62,7 +66,7 @@ public BibliographyConsistencyCheck.Result call() {
 
                 BibDatabaseContext bibContext = databaseContext.get();
 
-                BibliographyConsistencyCheck consistencyCheck = new BibliographyConsistencyCheck();
+                BibliographyConsistencyCheck consistencyCheck = new BibliographyConsistencyCheck(cliPreferences, entryTypesManager);
                 return consistencyCheck.check(bibContext, (count, total) ->
                         UiTaskExecutor.runInJavaFXThread(() -> {
                             updateProgress(count, total);

jabgui/src/main/java/org/jabref/gui/frame/JabRefFrame.java

@@ -56,6 +56,7 @@
 import org.jabref.logic.UiCommand;
 import org.jabref.logic.ai.AiService;
 import org.jabref.logic.journals.JournalAbbreviationRepository;
+import org.jabref.logic.preferences.CliPreferences;
 import org.jabref.logic.util.BuildInfo;
 import org.jabref.logic.util.TaskExecutor;
 import org.jabref.model.database.BibDatabaseContext;
@@ -87,6 +88,7 @@ private enum PanelMode { MAIN_TABLE, MAIN_TABLE_AND_ENTRY_EDITOR }
     private static final Logger LOGGER = LoggerFactory.getLogger(JabRefFrame.class);
 
     private final GuiPreferences preferences;
+    private final CliPreferences cliPreferences;
     private final AiService aiService;
     private final GlobalSearchBar globalSearchBar;
 
@@ -120,6 +122,7 @@ public JabRefFrame(Stage mainStage,
                        DialogService dialogService,
                        FileUpdateMonitor fileUpdateMonitor,
                        GuiPreferences preferences,
+                       CliPreferences cliPreferences,
                        AiService aiService,
                        StateManager stateManager,
                        CountingUndoManager undoManager,
@@ -130,6 +133,7 @@ public JabRefFrame(Stage mainStage,
         this.dialogService = dialogService;
         this.fileUpdateMonitor = fileUpdateMonitor;
         this.preferences = preferences;
+        this.cliPreferences = cliPreferences;
         this.aiService = aiService;
         this.stateManager = stateManager;
         this.undoManager = undoManager;
@@ -236,6 +240,7 @@ private void initLayout() {
                 sidePane,
                 pushToApplicationCommand,
                 preferences,
+                cliPreferences,
                 stateManager,
                 fileUpdateMonitor,
                 taskExecutor,

jabgui/src/main/java/org/jabref/gui/frame/MainMenu.java

@@ -87,6 +87,7 @@
 import org.jabref.logic.journals.JournalAbbreviationRepository;
 import org.jabref.logic.l10n.Localization;
 import org.jabref.logic.os.OS;
+import org.jabref.logic.preferences.CliPreferences;
 import org.jabref.logic.util.TaskExecutor;
 import org.jabref.model.entry.BibEntryTypesManager;
 import org.jabref.model.entry.field.SpecialField;
@@ -100,6 +101,7 @@ public class MainMenu extends MenuBar {
     private final SidePane sidePane;
     private final GuiPushToApplicationCommand pushToApplicationCommand;
     private final GuiPreferences preferences;
+    private final CliPreferences cliPreferences;
     private final StateManager stateManager;
     private final FileUpdateMonitor fileUpdateMonitor;
     private final TaskExecutor taskExecutor;
@@ -117,6 +119,7 @@ public MainMenu(JabRefFrame frame,
                     SidePane sidePane,
                     GuiPushToApplicationCommand pushToApplicationCommand,
                     GuiPreferences preferences,
+                    CliPreferences cliPreferences,
                     StateManager stateManager,
                     FileUpdateMonitor fileUpdateMonitor,
                     TaskExecutor taskExecutor,
@@ -133,6 +136,7 @@ public MainMenu(JabRefFrame frame,
         this.sidePane = sidePane;
         this.pushToApplicationCommand = pushToApplicationCommand;
         this.preferences = preferences;
+        this.cliPreferences = cliPreferences;
         this.stateManager = stateManager;
         this.fileUpdateMonitor = fileUpdateMonitor;
         this.taskExecutor = taskExecutor;
@@ -270,7 +274,7 @@ private void createMenu() {
                 factory.createMenuItem(StandardActions.FIND_DUPLICATES, new DuplicateSearch(frame::getCurrentLibraryTab, dialogService, stateManager, preferences, entryTypesManager, taskExecutor)),
                 factory.createMenuItem(StandardActions.MERGE_ENTRIES, new MergeEntriesAction(dialogService, stateManager, undoManager, preferences)),
                 factory.createMenuItem(StandardActions.CHECK_INTEGRITY, new IntegrityCheckAction(frame::getCurrentLibraryTab, preferences, dialogService, stateManager, (UiTaskExecutor) taskExecutor, abbreviationRepository)),
-                factory.createMenuItem(StandardActions.CHECK_CONSISTENCY, new ConsistencyCheckAction(frame::getCurrentLibraryTab, dialogService, stateManager, preferences, entryTypesManager, (UiTaskExecutor) taskExecutor)),
+                factory.createMenuItem(StandardActions.CHECK_CONSISTENCY, new ConsistencyCheckAction(frame::getCurrentLibraryTab, dialogService, stateManager, preferences, cliPreferences, entryTypesManager, (UiTaskExecutor) taskExecutor)),
                 factory.createMenuItem(StandardActions.CLEANUP_ENTRIES, new CleanupAction(frame::getCurrentLibraryTab, preferences, dialogService, stateManager, taskExecutor, undoManager)),
 
                 new SeparatorMenuItem(),

jabgui/src/main/java/org/jabref/gui/preferences/PreferencesDialogView.java

@@ -17,6 +17,7 @@
 import org.jabref.gui.util.ControlHelper;
 import org.jabref.gui.util.ViewModelListCellFactory;
 import org.jabref.logic.l10n.Localization;
+import org.jabref.model.entry.BibEntryTypesManager;
 
 import com.airhacks.afterburner.views.ViewLoader;
 import com.tobiasdiez.easybind.EasyBind;
@@ -39,6 +40,7 @@ public class PreferencesDialogView extends BaseDialog<PreferencesDialogViewModel
 
     @Inject private DialogService dialogService;
     @Inject private GuiPreferences preferences;
+    @Inject private BibEntryTypesManager bibEntryTypesManager;
 
     private PreferencesDialogViewModel viewModel;
     private final Class<? extends PreferencesTab> preferencesTabToSelectClass;
@@ -67,7 +69,7 @@ public PreferencesDialogViewModel getViewModel() {
 
     @FXML
     private void initialize() {
-        viewModel = new PreferencesDialogViewModel(dialogService, preferences);
+        viewModel = new PreferencesDialogViewModel(dialogService, preferences, bibEntryTypesManager);
 
         preferenceTabList.itemsProperty().setValue(viewModel.getPreferenceTabs());
 

jabgui/src/main/java/org/jabref/gui/preferences/PreferencesDialogViewModel.java

@@ -54,10 +54,12 @@ public class PreferencesDialogViewModel extends AbstractViewModel {
     private final DialogService dialogService;
     private final GuiPreferences preferences;
     private final ObservableList<PreferencesTab> preferenceTabs;
+    private final BibEntryTypesManager bibEntryTypesManager;
 
-    public PreferencesDialogViewModel(DialogService dialogService, GuiPreferences preferences) {
+    public PreferencesDialogViewModel(DialogService dialogService, GuiPreferences preferences, BibEntryTypesManager bibEntryTypesManager) {
         this.dialogService = dialogService;
         this.preferences = preferences;
+        this.bibEntryTypesManager = bibEntryTypesManager;
 
         // This enables passing unsaved preference values from the AI tab to the "web search" tab.
         AiTab aiTab = new AiTab();
@@ -190,9 +192,9 @@ public void storeAllSettings() {
                             + Localization.lang("You must restart JabRef for this to come into effect."));
         }
 
-        Injector.setModelOrService(BibEntryTypesManager.class, preferences.getCustomEntryTypesRepository());
+        Injector.setModelOrService(BibEntryTypesManager.class, preferences.getCustomEntryTypesRepository(bibEntryTypesManager));
         dialogService.notify(Localization.lang("Preferences recorded."));
-    }
+    };
 
     /**
      * Inserts the preference values into the Properties of the ViewModel

jabgui/src/main/java/org/jabref/gui/preferences/customentrytypes/CustomEntryTypesTab.java

@@ -57,6 +57,7 @@ public class CustomEntryTypesTab extends AbstractPreferenceTabView<CustomEntryTy
     @FXML private Button addNewFieldButton;
 
     @Inject private StateManager stateManager;
+    @Inject private BibEntryTypesManager bibEntryTypesManager;
 
     private final ControlsFxVisualizer visualizer = new ControlsFxVisualizer();
 
@@ -76,7 +77,7 @@ public String getTabName() {
     public void initialize() {
         BibDatabaseMode mode = stateManager.getActiveDatabase().map(BibDatabaseContext::getMode)
                                            .orElse(preferences.getLibraryPreferences().getDefaultBibDatabaseMode());
-        BibEntryTypesManager entryTypesRepository = preferences.getCustomEntryTypesRepository();
+        BibEntryTypesManager entryTypesRepository = preferences.getCustomEntryTypesRepository(bibEntryTypesManager);
 
         this.viewModel = new CustomEntryTypesTabViewModel(mode, entryTypesRepository, dialogService, preferences);
 

jabgui/src/main/java/org/jabref/migrations/PreferencesMigrations.java

@@ -48,15 +48,15 @@ private PreferencesMigrations() {
     /**
      * Perform checks and changes for users with a preference set from an older JabRef version.
      */
-    public static void runMigrations(JabRefGuiPreferences preferences) {
+    public static void runMigrations(JabRefGuiPreferences preferences, BibEntryTypesManager bibEntryTypesManager) {
         Preferences mainPrefsNode = Preferences.userRoot().node("/org/jabref");
 
         upgradePrefsToOrgJabRef(mainPrefsNode);
         upgradeSortOrder(preferences);
         upgradeFaultyEncodingStrings(preferences);
         upgradeLabelPatternToCitationKeyPattern(preferences, mainPrefsNode);
         upgradeImportFileAndDirePatterns(preferences, mainPrefsNode);
-        upgradeStoredBibEntryTypes(preferences, mainPrefsNode, preferences.getCustomEntryTypesRepository());
+        upgradeStoredBibEntryTypes(preferences, mainPrefsNode, preferences.getCustomEntryTypesRepository(bibEntryTypesManager));
         upgradeKeyBindingsToJavaFX(preferences);
         addCrossRefRelatedFieldsForAutoComplete(preferences);
         upgradePreviewStyle(preferences);

jablib/src/main/java/org/jabref/logic/exporter/ExporterFactory.java

@@ -13,6 +13,7 @@
 import org.jabref.logic.util.StandardFileType;
 import org.jabref.logic.xmp.XmpPreferences;
 import org.jabref.model.database.BibDatabaseMode;
+import org.jabref.model.entry.BibEntryTypesManager;
 import org.jabref.model.metadata.SelfContainedSaveOrder;
 
 public class ExporterFactory {
@@ -30,6 +31,7 @@ public static ExporterFactory create(CliPreferences preferences) {
         XmpPreferences xmpPreferences = preferences.getXmpPreferences();
         FieldPreferences fieldPreferences = preferences.getFieldPreferences();
         BibDatabaseMode bibDatabaseMode = preferences.getLibraryPreferences().getDefaultBibDatabaseMode();
+        BibEntryTypesManager bibEntryTypesManager = new BibEntryTypesManager();
 
         List<Exporter> exporters = new ArrayList<>();
 
@@ -59,7 +61,7 @@ public static ExporterFactory create(CliPreferences preferences) {
         exporters.add(new ModsExporter());
         exporters.add(new XmpExporter(xmpPreferences));
         exporters.add(new XmpPdfExporter(xmpPreferences));
-        exporters.add(new EmbeddedBibFilePdfExporter(bibDatabaseMode, preferences.getCustomEntryTypesRepository(), fieldPreferences));
+        exporters.add(new EmbeddedBibFilePdfExporter(bibDatabaseMode, preferences.getCustomEntryTypesRepository(bibEntryTypesManager), fieldPreferences));
         exporters.add(new CffExporter());
         exporters.add(new EndnoteXmlExporter(preferences.getBibEntryPreferences()));
 

jablib/src/main/java/org/jabref/logic/preferences/CliPreferences.java

@@ -69,7 +69,7 @@ public interface CliPreferences {
      */
     SelfContainedSaveConfiguration getSelfContainedExportConfiguration();
 
-    BibEntryTypesManager getCustomEntryTypesRepository();
+    BibEntryTypesManager getCustomEntryTypesRepository(BibEntryTypesManager bibEntryTypesManager);
 
     void storeCustomEntryTypesRepository(BibEntryTypesManager entryTypesManager);
 

jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java

@@ -1222,8 +1222,7 @@ public JournalAbbreviationPreferences getJournalAbbreviationPreferences() {
     //*************************************************************************************************************
 
     @Override
-    public BibEntryTypesManager getCustomEntryTypesRepository() {
-        BibEntryTypesManager bibEntryTypesManager = new BibEntryTypesManager();
+    public BibEntryTypesManager getCustomEntryTypesRepository(BibEntryTypesManager bibEntryTypesManager) {
         EnumSet.allOf(BibDatabaseMode.class).forEach(mode ->
                 bibEntryTypesManager.addCustomOrModifiedTypes(getBibEntryTypes(mode), mode));
         return bibEntryTypesManager;

jablib/src/main/java/org/jabref/logic/quality/consistency/BibliographyConsistencyCheck.java

@@ -17,16 +17,14 @@
 import org.jabref.logic.bibtex.comparator.BibEntryByFieldsComparator;
 import org.jabref.logic.bibtex.comparator.FieldComparatorStack;
 import org.jabref.model.database.BibDatabaseContext;
-import org.jabref.model.database.BibDatabaseMode;
 import org.jabref.model.entry.BibEntry;
 import org.jabref.model.entry.BibEntryType;
+import org.jabref.model.entry.BibEntryTypesManager;
 import org.jabref.model.entry.field.Field;
 import org.jabref.model.entry.field.InternalField;
 import org.jabref.model.entry.field.SpecialField;
 import org.jabref.model.entry.field.StandardField;
 import org.jabref.model.entry.field.UserSpecificCommentField;
-import org.jabref.model.entry.types.BiblatexEntryTypeDefinitions;
-import org.jabref.model.entry.types.BibtexEntryTypeDefinitions;
 import org.jabref.model.entry.types.EntryType;
 
 import com.google.common.annotations.VisibleForTesting;
@@ -55,6 +53,12 @@ public class BibliographyConsistencyCheck {
             StandardField.MODIFICATIONDATE
     );
 
+    private final BibEntryTypesManager bibEntryTypesManager;
+
+    public BibliographyConsistencyCheck(org.jabref.logic.preferences.CliPreferences cliPreferences, BibEntryTypesManager bibEntryTypesManager) {
+        this.bibEntryTypesManager = cliPreferences.getCustomEntryTypesRepository(bibEntryTypesManager);
+    }
+
     private static Set<Field> filterExcludedFields(Collection<Field> fields) {
         return fields.stream()
                      .filter(field -> !EXPLICITLY_EXCLUDED_FIELDS.contains(field))
@@ -112,12 +116,10 @@ public Result check(BibDatabaseContext bibContext, BiConsumer<Integer, Integer>
 
         collectEntriesIntoMaps(bibContext, entryTypeToFieldsInAnyEntryMap, entryTypeToFieldsInAllEntriesMap, entryTypeToEntriesMap);
 
-        List<BibEntryType> entryTypeDefinitions;
-        if (bibContext.getMode() == BibDatabaseMode.BIBLATEX) {
-            entryTypeDefinitions = BiblatexEntryTypeDefinitions.ALL;
-        } else {
-            entryTypeDefinitions = BibtexEntryTypeDefinitions.ALL;
-        }
+        List<BibEntryType> entryTypeDefinitions = bibEntryTypesManager
+                .getAllTypes(bibContext.getMode())
+                .stream()
+                .toList();
 
         // Use LinkedHashMap to preserve the order of Bib(tex|latex)EntryTypeDefinitions.ALL
         Map<EntryType, EntryTypeResult> resultMap = new LinkedHashMap<>();
@@ -161,7 +163,6 @@ public Result check(BibDatabaseContext bibContext, BiConsumer<Integer, Integer>
     }
 
     private static void collectEntriesIntoMaps(BibDatabaseContext bibContext, Map<EntryType, Set<Field>> entryTypeToFieldsInAnyEntryMap, Map<EntryType, Set<Field>> entryTypeToFieldsInAllEntriesMap, Map<EntryType, Set<BibEntry>> entryTypeToEntriesMap) {
-        BibDatabaseMode mode = bibContext.getMode();
         List<BibEntry> entries = bibContext.getEntries();
 
         for (BibEntry entry : entries) {