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

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

@@ -1,4 +1,13 @@
+
+
 .root {
+    -jr-row-odd-background: -fx-control-inner-background-alt;
+    -jr-row-even-background: -fx-control-inner-background;
+    /*
+    On light theme, the text is hard to see when it's on top of the accent color. This is an alternative lighter accent color
+    for better text visibility.
+    */
+    -jr-accent-alt: derive(-jr-accent, 15%);
 
     /*
     The theme color and some derived colors from it are used for icons, tab-headers, marking of selected inputs and
@@ -9,6 +18,7 @@
     /* This theme is the original JabRef dark blue color */
     -jr-theme: #50618F;
     -jr-accent: #a3b7e6;
+    -jr-transparent-accent: rgba(163, 183, 230, 0.16);
     -jr-selected: -jr-accent;
     -jr-checked: -jr-theme;
     -jr-hover: #0002;
@@ -245,6 +255,23 @@
     -jr-header-height: 3em;
 }
 
+.unchanged {
+    -rtfx-background-color:#0000;
+}
+
+.updated {
+    -rtfx-background-color: rgba(41, 166, 236, 0.66);
+}
+
+.addition {
+    -rtfx-background-color: rgba(29, 209, 161, 0.5);
+}
+
+.deletion {
+    -rtfx-background-color: rgba(255, 107, 107, 0.55);
+}
+
+
 #frame {
     -fx-background-color: -jr-background-alt;
 }
@@ -607,6 +634,27 @@ TextFlow > .tooltip-text-monospaced {
     -fx-background-insets: 0;
 }
 
+.merge-field-value .action-icon {
+    -fx-blend-mode: multiply;
+    -fx-opacity: 69%;
+    -fx-icon-size: 14;
+    -fx-icon-color: -fx-text-background-color;
+}
+
+.merge-field-value:disabled .action-icon {
+    -fx-opacity: 0%;
+}
+
+.merge-header-cell {
+    -fx-border-width: 0 0 1 0;
+    -fx-border-color: -jr-gray-1;
+    -fx-background-color: -jr-row-even-background;
+}
+
+.merge-header {
+    -fx-background-color: -jr-row-even-background;
+}
+
 .table-view .groupColumnBackground {
     -fx-stroke: -jr-gray-2;
 }

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

@@ -4,6 +4,9 @@
     -jr-selected: -jr-accent;
     -jr-hover: #fff1;
 
+    -jr-row-odd-background: #272b38;
+    -jr-row-even-background: #212330;
+    -jr-accent-alt: -jr-accent;
 
     -jr-red: #b71c1f;
     -jr-light-red: #db1d2b;
@@ -60,6 +63,18 @@
     -js-summary-text-color-selected: derive( -fx-dark-text-color, 70%);
 }
 
+.unchanged {
+
+}
+
+.addition {
+    -rtfx-background-color: -jr-green;
+}
+
+.deletion {
+    -rtfx-background-color: -jr-red;
+}
+
 #previewBody {
     background-color: #272b38; /* -fx-control-inner-background*/
     color: #7d8591; /* -fx-mid-text-color*/
@@ -82,6 +97,21 @@
     -fx-background-color: -jr-hover;
 }
 
+.merge-field-value .action-icon {
+    -fx-blend-mode: none;
+    -fx-opacity: 90%;
+}
+
+.merge-header-cell {
+    -fx-border-width: 0 0 1 0;
+    -fx-border-color: -fx-outer-border;
+    -fx-background-color: -jr-row-odd-background;
+}
+
+.merge-header {
+    -fx-background-color: -jr-row-odd-background;
+}
+
 .table-view .groupColumnBackground {
     -fx-stroke: -jr-gray-3;
 }

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/collab/EntryChangeViewModel.java

@@ -5,8 +5,10 @@
 import javafx.scene.control.Label;
 import javafx.scene.layout.VBox;
 
-import org.jabref.gui.mergeentries.MergeEntries;
-import org.jabref.gui.mergeentries.MergeEntries.DefaultRadioButtonSelectionMode;
+import org.jabref.gui.mergeentries.newmergedialog.ShowDiffConfig;
+import org.jabref.gui.mergeentries.newmergedialog.ThreeWayMergeView;
+import org.jabref.gui.mergeentries.newmergedialog.diffhighlighter.DiffHighlighter;
+import org.jabref.gui.mergeentries.newmergedialog.toolbar.ThreeWayMergeToolbar;
 import org.jabref.gui.undo.NamedCompound;
 import org.jabref.gui.undo.UndoableInsertEntries;
 import org.jabref.logic.l10n.Localization;
@@ -17,7 +19,7 @@ class EntryChangeViewModel extends DatabaseChangeViewModel {
 
     private final BibEntry oldEntry;
     private final BibEntry newEntry;
-    private MergeEntries mergePanel;
+    private ThreeWayMergeView threeWayMergeView;
 
     public EntryChangeViewModel(BibEntry entry, BibEntry newEntry) {
         super();
@@ -37,17 +39,17 @@ public EntryChangeViewModel(BibEntry entry, BibEntry newEntry) {
     public void setAccepted(boolean accepted) {
         super.setAccepted(accepted);
         if (accepted) {
-            mergePanel.selectAllRightRadioButtons();
+            threeWayMergeView.selectRightEntryValues();
         } else {
-            mergePanel.selectAllLeftRadioButtons();
+            threeWayMergeView.selectLeftEntryValues();
         }
     }
 
     @Override
     public void makeChange(BibDatabaseContext database, NamedCompound undoEdit) {
         this.description(); // Init dialog to prevent NPE
         database.getDatabase().removeEntry(oldEntry);
-        BibEntry mergedEntry = mergePanel.getMergedEntry();
+        BibEntry mergedEntry = threeWayMergeView.getMergedEntry();
         mergedEntry.setId(oldEntry.getId()); // Keep ID
         database.getDatabase().insertEntry(mergedEntry);
         undoEdit.addEdit(new UndoableInsertEntries(database.getDatabase(), oldEntry));
@@ -56,13 +58,15 @@ public void makeChange(BibDatabaseContext database, NamedCompound undoEdit) {
 
     @Override
     public Node description() {
-        mergePanel = new MergeEntries(oldEntry, newEntry, Localization.lang("In JabRef"), Localization.lang("On disk"), DefaultRadioButtonSelectionMode.LEFT);
+        threeWayMergeView = new ThreeWayMergeView(oldEntry, newEntry, Localization.lang("In JabRef"), Localization.lang("On disk"));
+        threeWayMergeView.selectLeftEntryValues();
+        threeWayMergeView.showDiff(new ShowDiffConfig(ThreeWayMergeToolbar.DiffView.SPLIT, DiffHighlighter.DiffMethod.WORDS));
         VBox container = new VBox(10);
         Label header = new Label(name);
         header.getStyleClass().add("sectionHeader");
         container.getChildren().add(header);
-        container.getChildren().add(mergePanel);
-        VBox.setMargin(mergePanel, new Insets(5, 5, 5, 5));
+        container.getChildren().add(threeWayMergeView);
+        VBox.setMargin(threeWayMergeView, new Insets(5, 5, 5, 5));
         return container;
     }
 }

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

@@ -10,7 +10,7 @@
 import org.jabref.gui.StateManager;
 import org.jabref.gui.duplicationFinder.DuplicateResolverDialog.DuplicateResolverResult;
 import org.jabref.gui.help.HelpAction;
-import org.jabref.gui.mergeentries.MergeEntries;
+import org.jabref.gui.mergeentries.newmergedialog.ThreeWayMergeView;
 import org.jabref.gui.util.BaseDialog;
 import org.jabref.gui.util.DialogWindowState;
 import org.jabref.logic.help.HelpFile;
@@ -39,7 +39,7 @@ public enum DuplicateResolverResult {
         BREAK
     }
 
-    private MergeEntries mergeEntries;
+    private ThreeWayMergeView threeWayMerge;
     private final DialogService dialogService;
 
     public DuplicateResolverDialog(BibEntry one, BibEntry two, DuplicateResolverType type, BibDatabaseContext database, StateManager stateManager, DialogService dialogService) {
@@ -69,14 +69,14 @@ private void init(BibEntry one, BibEntry two, DuplicateResolverType type) {
                 first = new ButtonType(Localization.lang("Keep left"), ButtonData.APPLY);
                 second = new ButtonType(Localization.lang("Keep right"), ButtonData.APPLY);
                 both = new ButtonType(Localization.lang("Keep both"), ButtonData.APPLY);
-                mergeEntries = new MergeEntries(one, two);
+                threeWayMerge = new ThreeWayMergeView(one, two);
                 break;
             case INSPECTION:
                 first = new ButtonType(Localization.lang("Remove old entry"), ButtonData.APPLY);
                 second = new ButtonType(Localization.lang("Remove entry from import"), ButtonData.APPLY);
                 both = new ButtonType(Localization.lang("Keep both"), ButtonData.APPLY);
-                mergeEntries = new MergeEntries(one, two, Localization.lang("Old entry"),
-                        Localization.lang("From import"));
+                threeWayMerge = new ThreeWayMergeView(one, two, Localization.lang("Old entry"),
+                                                      Localization.lang("From import"));
                 break;
             case DUPLICATE_SEARCH_WITH_EXACT:
                 first = new ButtonType(Localization.lang("Keep left"), ButtonData.APPLY);
@@ -85,14 +85,14 @@ private void init(BibEntry one, BibEntry two, DuplicateResolverType type) {
 
                 removeExactVisible = true;
 
-                mergeEntries = new MergeEntries(one, two);
+                threeWayMerge = new ThreeWayMergeView(one, two);
                 break;
             default:
                 first = new ButtonType(Localization.lang("Import and remove old entry"), ButtonData.APPLY);
                 second = new ButtonType(Localization.lang("Do not import entry"), ButtonData.APPLY);
                 both = new ButtonType(Localization.lang("Import and keep old entry"), ButtonData.APPLY);
-                mergeEntries = new MergeEntries(one, two, Localization.lang("Old entry"),
-                        Localization.lang("From import"));
+                threeWayMerge = new ThreeWayMergeView(one, two, Localization.lang("Old entry"),
+                                                      Localization.lang("From import"));
                 break;
         }
         if (removeExactVisible) {
@@ -109,7 +109,7 @@ private void init(BibEntry one, BibEntry two, DuplicateResolverType type) {
             this.setY(state.getY());
         }
 
-        BorderPane borderPane = new BorderPane(mergeEntries);
+        BorderPane borderPane = new BorderPane(threeWayMerge);
         borderPane.setBottom(options);
 
         this.setResultConverter(button -> {
@@ -136,6 +136,14 @@ private void init(BibEntry one, BibEntry two, DuplicateResolverType type) {
     }
 
     public BibEntry getMergedEntry() {
-        return mergeEntries.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/fieldeditors/URLUtil.java

@@ -74,7 +74,12 @@ public static String cleanGoogleSearchURL(String url) {
      * @return true if <c>url</c> contains a valid URL
      */
     public static boolean isURL(String url) {
-        return url.contains("://");
+        try {
+            new URL(url);
+            return true;
+        } catch (MalformedURLException e) {
+            return false;
+        }
     }
 
     /**