Add source to changes dialog

CHANGELOG.md

@@ -11,7 +11,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
 
 ### Added
 
-
+- We added a field showing the BibTeX/biblatex source for added and deleted entries in the "External Changes Resolver" dialog. [#9509](https://github.com/JabRef/jabref/issues/9509)
 
 
 

src/main/java/org/jabref/gui/Base.css

@@ -1310,6 +1310,12 @@ We want to have a look that matches our icons in the tool-bar */
     -fx-fill: -fx-text-background-color;
 }
 
+
+#bibtexcodearea {
+    -fx-padding: 4 4 4 4;
+    -fx-background-color: -fx-control-inner-background;
+}
+
 .code-area .selection {
     -fx-fill: -jr-accent;
 }

src/main/java/org/jabref/gui/LibraryTab.java

@@ -770,8 +770,6 @@ public void resetChangeMonitor() {
                 Globals.TASK_EXECUTOR,
                 dialogService,
                 preferencesService,
-                stateManager,
-                themeManager,
                 databaseNotificationPane));
     }
 

src/main/java/org/jabref/gui/collab/DatabaseChangeDetailsView.java

@@ -2,9 +2,8 @@
 
 import javafx.scene.layout.AnchorPane;
 
-import org.jabref.gui.collab.entryadd.EntryAddDetailsView;
 import org.jabref.gui.collab.entrychange.EntryChangeDetailsView;
-import org.jabref.gui.collab.entrydelete.EntryDeleteDetailsView;
+import org.jabref.gui.collab.entrychange.EntryWithPreviewAndSourceDetailsView;
 import org.jabref.gui.collab.groupchange.GroupChangeDetailsView;
 import org.jabref.gui.collab.metedatachange.MetadataChangeDetailsView;
 import org.jabref.gui.collab.preamblechange.PreambleChangeDetailsView;
@@ -13,5 +12,5 @@
 import org.jabref.gui.collab.stringdelete.BibTexStringDeleteDetailsView;
 import org.jabref.gui.collab.stringrename.BibTexStringRenameDetailsView;
 
-public sealed abstract class DatabaseChangeDetailsView extends AnchorPane permits EntryAddDetailsView, EntryChangeDetailsView, EntryDeleteDetailsView, GroupChangeDetailsView, MetadataChangeDetailsView, PreambleChangeDetailsView, BibTexStringAddDetailsView, BibTexStringChangeDetailsView, BibTexStringDeleteDetailsView, BibTexStringRenameDetailsView {
+public sealed abstract class DatabaseChangeDetailsView extends AnchorPane permits EntryWithPreviewAndSourceDetailsView, GroupChangeDetailsView, MetadataChangeDetailsView, PreambleChangeDetailsView, BibTexStringAddDetailsView, BibTexStringChangeDetailsView, BibTexStringDeleteDetailsView, BibTexStringRenameDetailsView, EntryChangeDetailsView {
 }

src/main/java/org/jabref/gui/collab/DatabaseChangeDetailsViewFactory.java

@@ -3,11 +3,10 @@
 import org.jabref.gui.DialogService;
 import org.jabref.gui.StateManager;
 import org.jabref.gui.collab.entryadd.EntryAdd;
-import org.jabref.gui.collab.entryadd.EntryAddDetailsView;
 import org.jabref.gui.collab.entrychange.EntryChange;
 import org.jabref.gui.collab.entrychange.EntryChangeDetailsView;
+import org.jabref.gui.collab.entrychange.EntryWithPreviewAndSourceDetailsView;
 import org.jabref.gui.collab.entrydelete.EntryDelete;
-import org.jabref.gui.collab.entrydelete.EntryDeleteDetailsView;
 import org.jabref.gui.collab.groupchange.GroupChange;
 import org.jabref.gui.collab.groupchange.GroupChangeDetailsView;
 import org.jabref.gui.collab.metedatachange.MetadataChange;
@@ -24,6 +23,7 @@
 import org.jabref.gui.collab.stringrename.BibTexStringRenameDetailsView;
 import org.jabref.gui.theme.ThemeManager;
 import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.model.entry.BibEntryTypesManager;
 import org.jabref.preferences.PreferencesService;
 
 public class DatabaseChangeDetailsViewFactory {
@@ -32,23 +32,25 @@ public class DatabaseChangeDetailsViewFactory {
     private final StateManager stateManager;
     private final ThemeManager themeManager;
     private final PreferencesService preferencesService;
+    private final BibEntryTypesManager entryTypesManager;
 
-    public DatabaseChangeDetailsViewFactory(BibDatabaseContext databaseContext, DialogService dialogService, StateManager stateManager, ThemeManager themeManager, PreferencesService preferencesService) {
+    public DatabaseChangeDetailsViewFactory(BibDatabaseContext databaseContext, DialogService dialogService, StateManager stateManager, ThemeManager themeManager, PreferencesService preferencesService, BibEntryTypesManager entryTypesManager) {
         this.databaseContext = databaseContext;
         this.dialogService = dialogService;
         this.stateManager = stateManager;
         this.themeManager = themeManager;
         this.preferencesService = preferencesService;
+        this.entryTypesManager = entryTypesManager;
     }
 
     public DatabaseChangeDetailsView create(DatabaseChange databaseChange) {
         // TODO: Use Pattern Matching for switch once it's out of preview
         if (databaseChange instanceof EntryChange entryChange) {
-            return new EntryChangeDetailsView(entryChange, databaseContext, dialogService, stateManager, themeManager, preferencesService);
+            return new EntryChangeDetailsView(entryChange.getOldEntry(), entryChange.getNewEntry(), databaseContext, dialogService, stateManager, themeManager, preferencesService, entryTypesManager);
         } else if (databaseChange instanceof EntryAdd entryAdd) {
-            return new EntryAddDetailsView(entryAdd, databaseContext, dialogService, stateManager, themeManager, preferencesService);
+            return new EntryWithPreviewAndSourceDetailsView(entryAdd.getAddedEntry(), databaseContext, dialogService, stateManager, themeManager, preferencesService, entryTypesManager);
         } else if (databaseChange instanceof EntryDelete entryDelete) {
-            return new EntryDeleteDetailsView(entryDelete, databaseContext, dialogService, stateManager, themeManager, preferencesService);
+            return new EntryWithPreviewAndSourceDetailsView(entryDelete.getDeletedEntry(), databaseContext, dialogService, stateManager, themeManager, preferencesService, entryTypesManager);
         } else if (databaseChange instanceof BibTexStringAdd stringAdd) {
             return new BibTexStringAddDetailsView(stringAdd);
         } else if (databaseChange instanceof BibTexStringDelete stringDelete) {

src/main/java/org/jabref/gui/collab/DatabaseChangeMonitor.java

@@ -8,9 +8,7 @@
 
 import org.jabref.gui.DialogService;
 import org.jabref.gui.LibraryTab;
-import org.jabref.gui.StateManager;
 import org.jabref.gui.icon.IconTheme;
-import org.jabref.gui.theme.ThemeManager;
 import org.jabref.gui.util.BackgroundTask;
 import org.jabref.gui.util.TaskExecutor;
 import org.jabref.logic.l10n.Localization;
@@ -39,8 +37,6 @@ public DatabaseChangeMonitor(BibDatabaseContext database,
                                  TaskExecutor taskExecutor,
                                  DialogService dialogService,
                                  PreferencesService preferencesService,
-                                 StateManager stateManager,
-                                 ThemeManager themeManager,
                                  LibraryTab.DatabaseNotification notificationPane) {
         this.database = database;
         this.fileMonitor = fileMonitor;
@@ -63,7 +59,7 @@ public DatabaseChangeMonitor(BibDatabaseContext database,
                 Localization.lang("The library has been modified by another program."),
                 List.of(new Action(Localization.lang("Dismiss changes"), event -> notificationPane.hide()),
                         new Action(Localization.lang("Review changes"), event -> {
-                            dialogService.showCustomDialogAndWait(new DatabaseChangesResolverDialog(changes, database, dialogService, stateManager, themeManager, preferencesService, Localization.lang("External Changes Resolver")));
+                            dialogService.showCustomDialogAndWait(new DatabaseChangesResolverDialog(changes, database, Localization.lang("External Changes Resolver")));
                             notificationPane.hide();
                         })),
                 Duration.ZERO));

src/main/java/org/jabref/gui/collab/DatabaseChangesResolverDialog.java

@@ -19,6 +19,7 @@
 import org.jabref.gui.theme.ThemeManager;
 import org.jabref.gui.util.BaseDialog;
 import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.model.entry.BibEntryTypesManager;
 import org.jabref.preferences.PreferencesService;
 
 import com.airhacks.afterburner.views.ViewLoader;
@@ -46,12 +47,16 @@ public class DatabaseChangesResolverDialog extends BaseDialog<Boolean> {
     private BorderPane changeInfoPane;
 
     private final List<DatabaseChange> changes;
+    private final BibDatabaseContext database;
 
     private ExternalChangesResolverViewModel viewModel;
 
-    private final DatabaseChangeDetailsViewFactory databaseChangeDetailsViewFactory;
-
     @Inject private UndoManager undoManager;
+    @Inject private StateManager stateManager;
+    @Inject private DialogService dialogService;
+    @Inject private PreferencesService preferencesService;
+    @Inject private ThemeManager themeManager;
+    @Inject private BibEntryTypesManager entryTypesManager;
 
     /**
      * A dialog going through given <code>changes</code>, which are diffs to the provided <code>database</code>.
@@ -60,9 +65,9 @@ public class DatabaseChangesResolverDialog extends BaseDialog<Boolean> {
      * @param changes The list of changes
      * @param database The database to apply the changes to
      */
-    public DatabaseChangesResolverDialog(List<DatabaseChange> changes, BibDatabaseContext database, DialogService dialogService, StateManager stateManager, ThemeManager themeManager, PreferencesService preferencesService, String dialogTitle) {
+    public DatabaseChangesResolverDialog(List<DatabaseChange> changes, BibDatabaseContext database, String dialogTitle) {
         this.changes = changes;
-        this.databaseChangeDetailsViewFactory = new DatabaseChangeDetailsViewFactory(database, dialogService, stateManager, themeManager, preferencesService);
+        this.database = database;
 
         this.setTitle(dialogTitle);
         ViewLoader.view(this)
@@ -82,6 +87,8 @@ public DatabaseChangesResolverDialog(List<DatabaseChange> changes, BibDatabaseCo
 
     @FXML
     private void initialize() {
+        DatabaseChangeDetailsViewFactory databaseChangeDetailsViewFactory = new DatabaseChangeDetailsViewFactory(database, dialogService, stateManager, themeManager, preferencesService, entryTypesManager);
+
         viewModel = new ExternalChangesResolverViewModel(changes, undoManager);
 
         changeName.setCellValueFactory(data -> new SimpleStringProperty(data.getValue().getName()));

src/main/java/org/jabref/gui/collab/entrychange/EntryChangeDetailsView.java

@@ -1,24 +1,45 @@
 package org.jabref.gui.collab.entrychange;
 
+import javafx.geometry.Orientation;
+import javafx.scene.control.SplitPane;
+import javafx.scene.control.TabPane;
+
 import org.jabref.gui.DialogService;
 import org.jabref.gui.StateManager;
 import org.jabref.gui.collab.DatabaseChangeDetailsView;
-import org.jabref.gui.preview.PreviewViewer;
 import org.jabref.gui.theme.ThemeManager;
 import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.BibEntryTypesManager;
 import org.jabref.preferences.PreferencesService;
 
+import com.tobiasdiez.easybind.EasyBind;
+
 public final class EntryChangeDetailsView extends DatabaseChangeDetailsView {
-    public EntryChangeDetailsView(EntryChange entryChange, BibDatabaseContext bibDatabaseContext, DialogService dialogService, StateManager stateManager, ThemeManager themeManager, PreferencesService preferencesService) {
-        PreviewViewer previewViewer = new PreviewViewer(bibDatabaseContext, dialogService, stateManager, themeManager);
-        previewViewer.setLayout(preferencesService.getPreviewPreferences().getSelectedPreviewLayout());
-        previewViewer.setEntry(entryChange.getNewEntry());
+    private final PreviewWithSourceTab oldPreviewWithSourcesTab = new PreviewWithSourceTab();
+    private final PreviewWithSourceTab newPreviewWithSourcesTab = new PreviewWithSourceTab();
+
+    public EntryChangeDetailsView(BibEntry oldEntry, BibEntry newEntry, BibDatabaseContext databaseContext, DialogService dialogService, StateManager stateManager, ThemeManager themeManager, PreferencesService preferencesService, BibEntryTypesManager entryTypesManager) {
+        TabPane oldEntryTabPane = oldPreviewWithSourcesTab.getPreviewWithSourceTab(oldEntry, databaseContext, dialogService, stateManager, themeManager, preferencesService, entryTypesManager);
+        TabPane newEntryTabPane = newPreviewWithSourcesTab.getPreviewWithSourceTab(newEntry, databaseContext, dialogService, stateManager, themeManager, preferencesService, entryTypesManager);
+
+        EasyBind.subscribe(oldEntryTabPane.getSelectionModel().selectedIndexProperty(), selectedIndex -> {
+            newEntryTabPane.getSelectionModel().select(selectedIndex.intValue());
+        });
+
+        EasyBind.subscribe(newEntryTabPane.getSelectionModel().selectedIndexProperty(), selectedIndex -> {
+            if (oldEntryTabPane.getSelectionModel().getSelectedIndex() != selectedIndex.intValue()) {
+                oldEntryTabPane.getSelectionModel().select(selectedIndex.intValue());
+            }
+        });
 
-        setLeftAnchor(previewViewer, 8d);
-        setTopAnchor(previewViewer, 8d);
-        setRightAnchor(previewViewer, 8d);
-        setBottomAnchor(previewViewer, 8d);
+        SplitPane split = new SplitPane(oldEntryTabPane, newEntryTabPane);
+        split.setOrientation(Orientation.HORIZONTAL);
 
-        getChildren().setAll(previewViewer);
+        setLeftAnchor(split, 8d);
+        setTopAnchor(split, 8d);
+        setRightAnchor(split, 8d);
+        setBottomAnchor(split, 8d);
+        this.getChildren().add(split);
     }
 }

src/main/java/org/jabref/gui/collab/entrychange/EntryWithPreviewAndSourceDetailsView.java

@@ -0,0 +1,27 @@
+package org.jabref.gui.collab.entrychange;
+
+import javafx.scene.control.TabPane;
+
+import org.jabref.gui.DialogService;
+import org.jabref.gui.StateManager;
+import org.jabref.gui.collab.DatabaseChangeDetailsView;
+import org.jabref.gui.theme.ThemeManager;
+import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.BibEntryTypesManager;
+import org.jabref.preferences.PreferencesService;
+
+public final class EntryWithPreviewAndSourceDetailsView extends DatabaseChangeDetailsView {
+
+    private final PreviewWithSourceTab previewWithSourceTab = new PreviewWithSourceTab();
+
+    public EntryWithPreviewAndSourceDetailsView(BibEntry entry, BibDatabaseContext bibDatabaseContext, DialogService dialogService, StateManager stateManager, ThemeManager themeManager, PreferencesService preferencesService, BibEntryTypesManager entryTypesManager) {
+        TabPane tabPanePreviewCode = previewWithSourceTab.getPreviewWithSourceTab(entry, bibDatabaseContext, dialogService, stateManager, themeManager, preferencesService, entryTypesManager);
+        setLeftAnchor(tabPanePreviewCode, 8d);
+        setTopAnchor(tabPanePreviewCode, 8d);
+        setRightAnchor(tabPanePreviewCode, 8d);
+        setBottomAnchor(tabPanePreviewCode, 8d);
+
+        getChildren().setAll(tabPanePreviewCode);
+    }
+}

src/main/java/org/jabref/gui/collab/entrychange/PreviewWithSourceTab.java

@@ -0,0 +1,67 @@
+package org.jabref.gui.collab.entrychange;
+
+import java.io.IOException;
+import java.io.StringWriter;
+
+import javafx.scene.control.Tab;
+import javafx.scene.control.TabPane;
+
+import org.jabref.gui.DialogService;
+import org.jabref.gui.StateManager;
+import org.jabref.gui.preview.PreviewViewer;
+import org.jabref.gui.theme.ThemeManager;
+import org.jabref.logic.bibtex.BibEntryWriter;
+import org.jabref.logic.bibtex.FieldWriter;
+import org.jabref.logic.bibtex.FieldWriterPreferences;
+import org.jabref.logic.exporter.BibWriter;
+import org.jabref.logic.l10n.Localization;
+import org.jabref.logic.util.OS;
+import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.model.database.BibDatabaseMode;
+import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.BibEntryTypesManager;
+import org.jabref.preferences.PreferencesService;
+
+import org.fxmisc.richtext.CodeArea;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class PreviewWithSourceTab {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(PreviewWithSourceTab.class);
+
+    public TabPane getPreviewWithSourceTab(BibEntry entry, BibDatabaseContext bibDatabaseContext, DialogService dialogService, StateManager stateManager, ThemeManager themeManager, PreferencesService preferencesService, BibEntryTypesManager entryTypesManager) {
+        // TODO: Optimization: Each PreviewViewer instance creates a WebView on initialization. WebView instances are
+        //   very heavy on CPU and memory. Thus, we should consider sharing PreviewViewer between entry changes.
+        PreviewViewer previewViewer = new PreviewViewer(bibDatabaseContext, dialogService, stateManager, themeManager);
+        previewViewer.setLayout(preferencesService.getPreviewPreferences().getSelectedPreviewLayout());
+        previewViewer.setEntry(entry);
+
+        CodeArea codeArea = new CodeArea();
+        codeArea.setId("bibtexcodearea");
+        codeArea.setWrapText(true);
+        codeArea.setDisable(true);
+
+        TabPane tabPanePreviewCode = new TabPane();
+        Tab previewTab = new Tab(Localization.lang("Entry preview"), previewViewer);
+
+        try {
+            codeArea.appendText(getSourceString(entry, bibDatabaseContext.getMode(), preferencesService.getFieldWriterPreferences(), entryTypesManager));
+        } catch (IOException e) {
+            LOGGER.error("Error getting Bibtex: {}", entry);
+        }
+        codeArea.setEditable(true);
+        Tab codeTab = new Tab(Localization.lang("%0 source", bibDatabaseContext.getMode().getFormattedName()), codeArea);
+
+        tabPanePreviewCode.getTabs().addAll(previewTab, codeTab);
+        return tabPanePreviewCode;
+    }
+
+    private String getSourceString(BibEntry entry, BibDatabaseMode type, FieldWriterPreferences fieldWriterPreferences, BibEntryTypesManager entryTypesManager) throws IOException {
+        StringWriter writer = new StringWriter();
+        BibWriter bibWriter = new BibWriter(writer, OS.NEWLINE);
+        FieldWriter fieldWriter = FieldWriter.buildIgnoreHashes(fieldWriterPreferences);
+        new BibEntryWriter(fieldWriter, entryTypesManager).write(entry, bibWriter, type);
+        return writer.toString();
+    }
+}