Improve Automatic Field Editor Dialog

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

@@ -8,16 +8,19 @@
 import javafx.beans.Observable;
 import javafx.beans.binding.Bindings;
 import javafx.beans.property.IntegerProperty;
+import javafx.beans.property.ObjectProperty;
 import javafx.beans.property.ReadOnlyListProperty;
 import javafx.beans.property.ReadOnlyListWrapper;
 import javafx.beans.property.SimpleIntegerProperty;
+import javafx.beans.property.SimpleObjectProperty;
 import javafx.collections.FXCollections;
 import javafx.collections.ObservableList;
 import javafx.collections.ObservableMap;
 import javafx.concurrent.Task;
 import javafx.scene.Node;
 import javafx.util.Pair;
 
+import org.jabref.gui.edit.automaticfiededitor.LastAutomaticFieldEditorEdit;
 import org.jabref.gui.sidepane.SidePaneType;
 import org.jabref.gui.util.BackgroundTask;
 import org.jabref.gui.util.CustomLocalDragboard;
@@ -62,6 +65,8 @@ public class StateManager {
     private final ObservableMap<String, DialogWindowState> dialogWindowStates = FXCollections.observableHashMap();
     private final ObservableList<SidePaneType> visibleSidePanes = FXCollections.observableArrayList();
 
+    private final ObjectProperty<LastAutomaticFieldEditorEdit> lastAutomaticFieldEditorEdit = new SimpleObjectProperty<>();
+
     public StateManager() {
         activeGroups.bind(Bindings.valueAt(selectedGroups, activeDatabase.orElse(null)));
     }
@@ -172,4 +177,16 @@ public DialogWindowState getDialogWindowState(String className) {
     public void setDialogWindowState(String className, DialogWindowState state) {
         dialogWindowStates.put(className, state);
     }
+
+    public ObjectProperty<LastAutomaticFieldEditorEdit> lastAutomaticFieldEditorEditProperty() {
+        return lastAutomaticFieldEditorEdit;
+    }
+
+    public LastAutomaticFieldEditorEdit getLastAutomaticFieldEditorEdit() {
+        return lastAutomaticFieldEditorEditProperty().get();
+    }
+
+    public void setLastAutomaticFieldEditorEdit(LastAutomaticFieldEditorEdit automaticFieldEditorEdit) {
+        lastAutomaticFieldEditorEditProperty().set(automaticFieldEditorEdit);
+    }
 }

src/main/java/org/jabref/gui/edit/automaticfiededitor/AbstractAutomaticFieldEditorTabViewModel.java

@@ -0,0 +1,48 @@
+package org.jabref.gui.edit.automaticfiededitor;
+
+import java.util.Collection;
+import java.util.Comparator;
+import java.util.EnumSet;
+import java.util.HashSet;
+import java.util.Objects;
+import java.util.Set;
+
+import javafx.collections.FXCollections;
+import javafx.collections.ObservableList;
+
+import org.jabref.gui.AbstractViewModel;
+import org.jabref.gui.StateManager;
+import org.jabref.model.database.BibDatabase;
+import org.jabref.model.entry.field.Field;
+import org.jabref.model.entry.field.StandardField;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public abstract class AbstractAutomaticFieldEditorTabViewModel extends AbstractViewModel {
+    public static final Logger LOGGER = LoggerFactory.getLogger(AbstractAutomaticFieldEditorTabViewModel.class);
+
+    protected final StateManager stateManager;
+
+    private final ObservableList<Field> allFields = FXCollections.observableArrayList();
+
+    public AbstractAutomaticFieldEditorTabViewModel(BibDatabase bibDatabase, StateManager stateManager) {
+        Objects.requireNonNull(bibDatabase);
+        Objects.requireNonNull(stateManager);
+        this.stateManager = stateManager;
+
+        addFields(EnumSet.allOf(StandardField.class));
+        addFields(bibDatabase.getAllVisibleFields());
+        allFields.sort(Comparator.comparing(Field::getName));
+    }
+
+    public ObservableList<Field> getAllFields() {
+        return allFields;
+    }
+
+    private void addFields(Collection<? extends Field> fields) {
+        Set<Field> fieldsSet = new HashSet<>(allFields);
+        fieldsSet.addAll(fields);
+        allFields.setAll(fieldsSet);
+    }
+}

src/main/java/org/jabref/gui/edit/automaticfiededitor/AutomaticFieldEditorAction.java

@@ -20,7 +20,6 @@ public AutomaticFieldEditorAction(StateManager stateManager, DialogService dialo
 
     @Override
     public void execute() {
-        dialogService.showCustomDialogAndWait(new AutomaticFieldEditorDialog(stateManager.getSelectedEntries(),
-                stateManager.getActiveDatabase().orElseThrow()));
+        dialogService.showCustomDialogAndWait(new AutomaticFieldEditorDialog(stateManager));
     }
 }

src/main/java/org/jabref/gui/edit/automaticfiededitor/AutomaticFieldEditorDialog.fxml

@@ -10,6 +10,5 @@
         <TabPane fx:id="tabPane" tabClosingPolicy="UNAVAILABLE"/>
     </content>
     <ButtonType fx:id="saveButton" text="Keep Modifications" buttonData="OK_DONE"/>
-    <ButtonType fx:id="cancelButton"
-                text="Revert" buttonData="CANCEL_CLOSE"/>
+    <ButtonType fx:constant="CANCEL"/>
 </DialogPane>

src/main/java/org/jabref/gui/edit/automaticfiededitor/AutomaticFieldEditorDialog.java

@@ -1,39 +1,44 @@
 package org.jabref.gui.edit.automaticfiededitor;
 
+import java.util.ArrayList;
 import java.util.List;
 
 import javax.swing.undo.UndoManager;
 
 import javafx.fxml.FXML;
 import javafx.scene.control.ButtonBar;
-import javafx.scene.control.ButtonType;
 import javafx.scene.control.Tab;
 import javafx.scene.control.TabPane;
 
 import org.jabref.gui.Globals;
+import org.jabref.gui.StateManager;
 import org.jabref.gui.util.BaseDialog;
-import org.jabref.gui.util.ControlHelper;
 import org.jabref.logic.l10n.Localization;
-import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.model.database.BibDatabase;
 import org.jabref.model.entry.BibEntry;
 
 import com.airhacks.afterburner.views.ViewLoader;
+import com.tobiasdiez.easybind.EasyBind;
 
-public class AutomaticFieldEditorDialog extends BaseDialog<Void> {
-    @FXML public ButtonType saveButton;
-    @FXML public ButtonType cancelButton;
+public class AutomaticFieldEditorDialog extends BaseDialog<String> {
     @FXML
     private TabPane tabPane;
 
     private final UndoManager undoManager;
 
-    private final BibDatabaseContext databaseContext;
+    private final BibDatabase database;
     private final List<BibEntry> selectedEntries;
+
+    private final StateManager stateManager;
+
     private AutomaticFieldEditorViewModel viewModel;
 
-    public AutomaticFieldEditorDialog(List<BibEntry> selectedEntries, BibDatabaseContext databaseContext) {
-        this.selectedEntries = selectedEntries;
-        this.databaseContext = databaseContext;
+    private List<NotificationPaneAdapter> notificationPanes = new ArrayList<>();
+
+    public AutomaticFieldEditorDialog(StateManager stateManager) {
+        this.selectedEntries = stateManager.getSelectedEntries();
+        this.database = stateManager.getActiveDatabase().orElseThrow().getDatabase();
+        this.stateManager = stateManager;
         this.undoManager = Globals.undoManager;
 
         this.setTitle(Localization.lang("Automatic field editor"));
@@ -42,8 +47,14 @@ public AutomaticFieldEditorDialog(List<BibEntry> selectedEntries, BibDatabaseCon
                   .load()
                   .setAsDialogPane(this);
 
-        ControlHelper.setAction(saveButton, getDialogPane(), event -> saveChangesAndCloseDialog());
-        ControlHelper.setAction(cancelButton, getDialogPane(), event -> cancelChangesAndCloseDialog());
+        setResultConverter(buttonType -> {
+            if (buttonType != null && buttonType.getButtonData() == ButtonBar.ButtonData.OK_DONE) {
+                saveChanges();
+            } else {
+                cancelChanges();
+            }
+            return "";
+        });
 
         // This will prevent all dialog buttons from having the same size
         // Read more: https://stackoverflow.com/questions/45866249/javafx-8-alert-different-button-sizes
@@ -54,20 +65,26 @@ public AutomaticFieldEditorDialog(List<BibEntry> selectedEntries, BibDatabaseCon
 
     @FXML
     public void initialize() {
-        viewModel = new AutomaticFieldEditorViewModel(selectedEntries, databaseContext, undoManager);
+        viewModel = new AutomaticFieldEditorViewModel(selectedEntries, database, undoManager, stateManager);
 
         for (AutomaticFieldEditorTab tabModel : viewModel.getFieldEditorTabs()) {
-            tabPane.getTabs().add(new Tab(tabModel.getTabName(), tabModel.getContent()));
+            NotificationPaneAdapter notificationPane = new NotificationPaneAdapter(tabModel.getContent());
+            notificationPanes.add(notificationPane);
+            tabPane.getTabs().add(new Tab(tabModel.getTabName(), notificationPane));
         }
+
+        EasyBind.listen(stateManager.lastAutomaticFieldEditorEditProperty(), (obs, old, lastEdit) -> {
+            viewModel.getDialogEdits().addEdit(lastEdit.getEdit());
+            notificationPanes.get(lastEdit.getTabIndex())
+                             .notify(lastEdit.getAffectedEntries(), selectedEntries.size());
+        });
     }
 
-    private void saveChangesAndCloseDialog() {
+    private void saveChanges() {
         viewModel.saveChanges();
-        close();
     }
 
-    private void cancelChangesAndCloseDialog() {
+    private void cancelChanges() {
         viewModel.cancelChanges();
-        close();
     }
 }

src/main/java/org/jabref/gui/edit/automaticfiededitor/AutomaticFieldEditorViewModel.java

@@ -8,29 +8,32 @@
 import javafx.collections.ObservableList;
 
 import org.jabref.gui.AbstractViewModel;
-import org.jabref.gui.edit.automaticfiededitor.editfieldvalue.EditFieldValueTabView;
+import org.jabref.gui.StateManager;
+import org.jabref.gui.edit.automaticfiededitor.copyormovecontent.CopyOrMoveFieldContentTabView;
+import org.jabref.gui.edit.automaticfiededitor.editfieldcontent.EditFieldContentTabView;
 import org.jabref.gui.edit.automaticfiededitor.renamefield.RenameFieldTabView;
-import org.jabref.gui.edit.automaticfiededitor.twofields.TwoFieldsTabView;
 import org.jabref.gui.undo.NamedCompound;
-import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.model.database.BibDatabase;
 import org.jabref.model.entry.BibEntry;
 
 public class AutomaticFieldEditorViewModel extends AbstractViewModel {
     public static final String NAMED_COMPOUND_EDITS = "EDIT_FIELDS";
     private final ObservableList<AutomaticFieldEditorTab> fieldEditorTabs = FXCollections.observableArrayList();
     private final NamedCompound dialogEdits = new NamedCompound(NAMED_COMPOUND_EDITS);
 
-    private final BibDatabaseContext databaseContext;
     private final UndoManager undoManager;
 
-    public AutomaticFieldEditorViewModel(List<BibEntry> selectedEntries, BibDatabaseContext databaseContext, UndoManager undoManager) {
+    public AutomaticFieldEditorViewModel(List<BibEntry> selectedEntries, BibDatabase database, UndoManager undoManager, StateManager stateManager) {
+        this.undoManager = undoManager;
         fieldEditorTabs.addAll(
-                new EditFieldValueTabView(selectedEntries, databaseContext, dialogEdits),
-                new TwoFieldsTabView(selectedEntries, databaseContext, dialogEdits),
-                new RenameFieldTabView(selectedEntries, databaseContext, dialogEdits)
+                new EditFieldContentTabView(database, stateManager),
+                new CopyOrMoveFieldContentTabView(database, stateManager),
+                new RenameFieldTabView(database, stateManager)
         );
-        this.databaseContext = databaseContext;
-        this.undoManager = undoManager;
+    }
+
+    public NamedCompound getDialogEdits() {
+        return dialogEdits;
     }
 
     public ObservableList<AutomaticFieldEditorTab> getFieldEditorTabs() {

src/main/java/org/jabref/gui/edit/automaticfiededitor/LastAutomaticFieldEditorEdit.java

@@ -0,0 +1,44 @@
+package org.jabref.gui.edit.automaticfiededitor;
+
+import javax.swing.undo.AbstractUndoableEdit;
+import javax.swing.undo.CannotRedoException;
+import javax.swing.undo.CannotUndoException;
+
+import org.jabref.gui.undo.NamedCompound;
+
+public class LastAutomaticFieldEditorEdit extends AbstractUndoableEdit {
+    private final Integer affectedEntries;
+    private final NamedCompound edit;
+
+    private final Integer tabIndex;
+
+    public LastAutomaticFieldEditorEdit(Integer affectedEntries, Integer tabIndex, NamedCompound edit) {
+        this.affectedEntries = affectedEntries;
+        this.edit = edit;
+        this.tabIndex = tabIndex;
+    }
+
+    public Integer getAffectedEntries() {
+        return affectedEntries;
+    }
+
+    public NamedCompound getEdit() {
+        return edit;
+    }
+
+    public Integer getTabIndex() {
+        return tabIndex;
+    }
+
+    @Override
+    public void undo() throws CannotUndoException {
+        super.undo();
+        edit.undo();
+    }
+
+    @Override
+    public void redo() throws CannotRedoException {
+        super.redo();
+        edit.redo();
+    }
+}

src/main/java/org/jabref/gui/edit/automaticfiededitor/MoveFieldValueAction.java

@@ -16,27 +16,48 @@ public class MoveFieldValueAction extends SimpleCommand {
 
     private final NamedCompound edits;
 
-    public MoveFieldValueAction(Field fromField, Field toField, List<BibEntry> entries, NamedCompound edits) {
+    private int affectedEntriesCount;
+
+    private final boolean overwriteToFieldContent;
+
+    public MoveFieldValueAction(Field fromField, Field toField, List<BibEntry> entries, NamedCompound edits, boolean overwriteToFieldContent) {
         this.fromField = fromField;
         this.toField = toField;
         this.entries = entries;
         this.edits = edits;
+        this.overwriteToFieldContent = overwriteToFieldContent;
+    }
+
+    public MoveFieldValueAction(Field fromField, Field toField, List<BibEntry> entries, NamedCompound edits) {
+        this(fromField, toField, entries, edits, true);
     }
 
     @Override
     public void execute() {
+        affectedEntriesCount = 0;
         for (BibEntry entry : entries) {
             String fromFieldValue = entry.getField(fromField).orElse("");
             String toFieldValue = entry.getField(toField).orElse("");
-
             if (StringUtil.isNotBlank(fromFieldValue)) {
-                entry.setField(toField, fromFieldValue);
-                entry.setField(fromField, "");
-
-                edits.addEdit(new UndoableFieldChange(entry, fromField, fromFieldValue, null));
-                edits.addEdit(new UndoableFieldChange(entry, toField, toFieldValue, fromFieldValue));
+                if (overwriteToFieldContent || toFieldValue.isEmpty()) {
+                    entry.setField(toField, fromFieldValue);
+                    entry.setField(fromField, "");
+
+                    edits.addEdit(new UndoableFieldChange(entry, fromField, fromFieldValue, null));
+                    edits.addEdit(new UndoableFieldChange(entry, toField, toFieldValue, fromFieldValue));
+                    affectedEntriesCount++;
+                }
             }
         }
+
         edits.end();
     }
+
+    /**
+     * @return the number of affected entries
+     * */
+    public int executeAndGetAffectedEntriesCount() {
+        execute();
+        return affectedEntriesCount;
+    }
 }

src/main/java/org/jabref/gui/edit/automaticfiededitor/NotificationPaneAdapter.java

@@ -0,0 +1,23 @@
+package org.jabref.gui.edit.automaticfiededitor;
+
+import java.util.Collections;
+
+import javafx.scene.Node;
+import javafx.util.Duration;
+
+import org.jabref.gui.LibraryTab;
+import org.jabref.gui.icon.IconTheme;
+
+public class NotificationPaneAdapter extends LibraryTab.DatabaseNotification {
+
+    public NotificationPaneAdapter(Node content) {
+        super(content);
+    }
+
+    public void notify(int affectedEntries, int totalEntries) {
+        String notificationMessage = String.format("%d/%d affected entries", affectedEntries, totalEntries);
+        Node notificationGraphic = IconTheme.JabRefIcons.INTEGRITY_INFO.getGraphicNode();
+
+        notify(notificationGraphic, notificationMessage, Collections.emptyList(), Duration.seconds(2));
+    }
+}