[GSOC22] - B - Implement merging fields in the three way merge UI

src/main/java/org/jabref/gui/actions/Action.java

@@ -1,5 +1,6 @@
 package org.jabref.gui.actions;
 
+import java.util.Objects;
 import java.util.Optional;
 
 import org.jabref.gui.icon.JabRefIcon;
@@ -19,4 +20,71 @@ default Optional<KeyBinding> getKeyBinding() {
     default String getDescription() {
         return "";
     }
+
+    class Builder {
+        private final ActionImpl actionImpl;
+
+        public Builder(String text) {
+            this.actionImpl = new ActionImpl();
+            setText(text);
+        }
+
+        public Builder() {
+            this("");
+        }
+
+        public Action setIcon(JabRefIcon icon) {
+            Objects.requireNonNull(icon);
+            actionImpl.icon = icon;
+            return actionImpl;
+        }
+
+        public Action setText(String text) {
+            Objects.requireNonNull(text);
+            actionImpl.text = text;
+            return actionImpl;
+        }
+
+        public Action setKeyBinding(KeyBinding keyBinding) {
+            Objects.requireNonNull(keyBinding);
+            actionImpl.keyBinding = keyBinding;
+            return actionImpl;
+        }
+
+        public Action setDescription(String description) {
+            Objects.requireNonNull(description);
+            actionImpl.description = description;
+            return actionImpl;
+        }
+    }
+
+    class ActionImpl implements Action {
+        private JabRefIcon icon;
+        private KeyBinding keyBinding;
+        private String text;
+        private String description;
+
+        private ActionImpl() {
+        }
+
+        @Override
+        public Optional<JabRefIcon> getIcon() {
+            return Optional.ofNullable(icon);
+        }
+
+        @Override
+        public Optional<KeyBinding> getKeyBinding() {
+            return Optional.ofNullable(keyBinding);
+        }
+
+        @Override
+        public String getText() {
+            return text != null ? text : "";
+        }
+
+        @Override
+        public String getDescription() {
+            return description != null ? description : "";
+        }
+    }
 }

src/main/java/org/jabref/gui/duplicationFinder/DuplicateResolverDialog.java

@@ -138,4 +138,12 @@ private void init(BibEntry one, BibEntry two, DuplicateResolverType type) {
     public BibEntry getMergedEntry() {
         return threeWayMerge.getMergedEntry();
     }
+
+    public BibEntry getNewLeftEntry() {
+        return threeWayMerge.getLeftEntry();
+    }
+
+    public BibEntry getNewRightEntry() {
+        return threeWayMerge.getRightEntry();
+    }
 }

src/main/java/org/jabref/gui/duplicationFinder/DuplicateSearch.java

@@ -152,16 +152,21 @@ private void askResolveStrategy(DuplicateSearchResult result, BibEntry first, Bi
         if ((resolverResult == DuplicateResolverResult.KEEP_LEFT)
                 || (resolverResult == DuplicateResolverResult.AUTOREMOVE_EXACT)) {
             result.remove(second);
+            result.replace(first, dialog.getNewLeftEntry());
             if (resolverResult == DuplicateResolverResult.AUTOREMOVE_EXACT) {
                 autoRemoveExactDuplicates.set(true); // Remember choice
             }
         } else if (resolverResult == DuplicateResolverResult.KEEP_RIGHT) {
             result.remove(first);
+            result.replace(second, dialog.getNewRightEntry());
         } else if (resolverResult == DuplicateResolverResult.BREAK) {
             libraryAnalyzed.set(true);
             duplicates.clear();
         } else if (resolverResult == DuplicateResolverResult.KEEP_MERGE) {
             result.replace(first, second, dialog.getMergedEntry());
+        } else if (resolverResult == DuplicateResolverResult.KEEP_BOTH) {
+            result.replace(first, dialog.getNewLeftEntry());
+            result.replace(second, dialog.getNewRightEntry());
         }
     }
 
@@ -225,6 +230,11 @@ public synchronized void replace(BibEntry first, BibEntry second, BibEntry repla
             duplicates++;
         }
 
+        public synchronized void replace(BibEntry entry, BibEntry replacement) {
+            remove(entry);
+            getToAdd().add(replacement);
+        }
+
         public synchronized boolean isToRemove(BibEntry entry) {
             return toRemove.containsKey(System.identityHashCode(entry));
         }

src/main/java/org/jabref/gui/icon/IconTheme.java

@@ -343,7 +343,9 @@ public enum JabRefIcons implements JabRefIcon {
 
         ACCEPT_LEFT(MaterialDesignS.SUBDIRECTORY_ARROW_LEFT),
 
-        ACCEPT_RIGHT(MaterialDesignS.SUBDIRECTORY_ARROW_RIGHT);
+        ACCEPT_RIGHT(MaterialDesignS.SUBDIRECTORY_ARROW_RIGHT),
+
+        MERGE_GROUPS(MaterialDesignS.SOURCE_MERGE);
 
         private final JabRefIcon icon;
 

src/main/java/org/jabref/gui/mergeentries/FetchAndMergeEntry.java

@@ -99,7 +99,7 @@ private void showMergeDialog(BibEntry originalEntry, BibEntry fetchedEntry, WebF
         dialog.setTitle(Localization.lang("Merge entry with %0 information", fetcher.getName()));
         dialog.setLeftHeaderText(Localization.lang("Original entry"));
         dialog.setRightHeaderText(Localization.lang("Entry from %0", fetcher.getName()));
-        Optional<BibEntry> mergedEntry = dialogService.showCustomDialogAndWait(dialog);
+        Optional<BibEntry> mergedEntry = dialogService.showCustomDialogAndWait(dialog).map(MergeResult::mergedEntry);
         if (mergedEntry.isPresent()) {
             NamedCompound ce = new NamedCompound(Localization.lang("Merge entry with %0 information", fetcher.getName()));
 

src/main/java/org/jabref/gui/mergeentries/MergeEntriesAction.java

@@ -66,28 +66,24 @@ public void execute() {
             second = one;
         }
 
-        MergeEntriesDialog dlg = new MergeEntriesDialog(first, second);
-        dlg.setTitle(Localization.lang("Merge entries"));
-        Optional<BibEntry> mergedEntry = dialogService.showCustomDialogAndWait(dlg);
-        if (mergedEntry.isPresent()) {
-            // ToDo: BibDatabase::insertEntry does not contain logic to mark the BasePanel as changed and to mark
+        MergeEntriesDialog dialog = new MergeEntriesDialog(first, second);
+        dialog.setTitle(Localization.lang("Merge entries"));
+        Optional<MergeResult> mergeResultOpt = dialogService.showCustomDialogAndWait(dialog);
+        mergeResultOpt.ifPresentOrElse(mergeResult -> {
+            // TODO: BibDatabase::insertEntry does not contain logic to mark the BasePanel as changed and to mark
             //  entries with a timestamp, only BasePanel::insertEntry does. Workaround for the moment is to get the
             //  BasePanel from the constructor injected JabRefFrame. Should be refactored and extracted!
-            frame.getCurrentLibraryTab().insertEntry(mergedEntry.get());
+            frame.getCurrentLibraryTab().insertEntry(mergeResult.mergedEntry());
 
-            // Create a new entry and add it to the undo stack
-            // Remove the other two entries and add them to the undo stack (which is not working...)
             NamedCompound ce = new NamedCompound(Localization.lang("Merge entries"));
-            ce.addEdit(new UndoableInsertEntries(databaseContext.getDatabase(), mergedEntry.get()));
+            ce.addEdit(new UndoableInsertEntries(databaseContext.getDatabase(), mergeResult.mergedEntry()));
             List<BibEntry> entriesToRemove = Arrays.asList(one, two);
             ce.addEdit(new UndoableRemoveEntries(databaseContext.getDatabase(), entriesToRemove));
             databaseContext.getDatabase().removeEntries(entriesToRemove);
             ce.end();
-            Globals.undoManager.addEdit(ce); // ToDo: Rework UndoManager and extract Globals
+            Globals.undoManager.addEdit(ce);
 
             dialogService.notify(Localization.lang("Merged entries"));
-        } else {
-            dialogService.notify(Localization.lang("Canceled merging entries"));
-        }
+        }, () -> dialogService.notify(Localization.lang("Canceled merging entries")));
     }
 }

src/main/java/org/jabref/gui/mergeentries/MergeEntriesDialog.java

@@ -8,7 +8,7 @@
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.entry.BibEntry;
 
-public class MergeEntriesDialog extends BaseDialog<BibEntry> {
+public class MergeEntriesDialog extends BaseDialog<MergeResult> {
     private final ThreeWayMergeView threeWayMergeView;
 
     public MergeEntriesDialog(BibEntry one, BibEntry two) {
@@ -31,7 +31,7 @@ private void init() {
         this.getDialogPane().getButtonTypes().setAll(ButtonType.CANCEL, replaceEntries);
         this.setResultConverter(buttonType -> {
             if (buttonType.equals(replaceEntries)) {
-                return threeWayMergeView.getMergedEntry();
+                return new MergeResult(threeWayMergeView.getLeftEntry(), threeWayMergeView.getRightEntry(), threeWayMergeView.getMergedEntry());
             } else {
                 return null;
             }

src/main/java/org/jabref/gui/mergeentries/MergeResult.java

@@ -0,0 +1,8 @@
+package org.jabref.gui.mergeentries;
+
+import org.jabref.model.entry.BibEntry;
+
+public record MergeResult(
+        BibEntry leftEntry, BibEntry rightEntry, BibEntry mergedEntry
+) {
+}