Add tabs to Clean Up Entries dialog

CHANGELOG.md

@@ -97,6 +97,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We improved the event viewer for debugging [#13783](https://github.com/JabRef/jabref/pull/13783).
 - We improved "REDACTED" replacement of API key value in web fetcher search URL [#13796](https://github.com/JabRef/jabref/issues/13796)
 - When the pin "Keep dialog always on top" in the global search dialog is selected, the search window stays open when double-clicking on an entry. [#13840](https://github.com/JabRef/jabref/issues/13840)
+- We separated the "Clean up entries" dialog into three tabs for clarity [#13819](https://github.com/JabRef/jabref/issues/13819)
 - We improved the way we check for matching curly braces in BibTeX fields and made error messages easier to understand. [#12605](https://github.com/JabRef/jabref/issues/12605)
 
 ### Fixed

jabgui/src/main/java/org/jabref/gui/cleanup/CleanupAction.java

@@ -1,32 +1,16 @@
 package org.jabref.gui.cleanup;
 
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Optional;
 import java.util.function.Supplier;
-import java.util.stream.Collectors;
 
 import javax.swing.undo.UndoManager;
 
-import javafx.application.Platform;
-
 import org.jabref.gui.DialogService;
 import org.jabref.gui.LibraryTab;
 import org.jabref.gui.StateManager;
 import org.jabref.gui.actions.ActionHelper;
 import org.jabref.gui.actions.SimpleCommand;
-import org.jabref.gui.undo.NamedCompoundEdit;
-import org.jabref.gui.undo.UndoableFieldChange;
-import org.jabref.logic.JabRefException;
-import org.jabref.logic.cleanup.CleanupPreferences;
-import org.jabref.logic.cleanup.CleanupWorker;
-import org.jabref.logic.l10n.Localization;
 import org.jabref.logic.preferences.CliPreferences;
-import org.jabref.logic.util.BackgroundTask;
 import org.jabref.logic.util.TaskExecutor;
-import org.jabref.model.FieldChange;
-import org.jabref.model.database.BibDatabaseContext;
-import org.jabref.model.entry.BibEntry;
 
 public class CleanupAction extends SimpleCommand {
 
@@ -36,10 +20,6 @@ public class CleanupAction extends SimpleCommand {
     private final StateManager stateManager;
     private final TaskExecutor taskExecutor;
     private final UndoManager undoManager;
-    private final List<JabRefException> failures;
-
-    private boolean isCanceled;
-    private int modifiedEntriesCount;
 
     public CleanupAction(Supplier<LibraryTab> tabSupplier,
                          CliPreferences preferences,
@@ -53,7 +33,6 @@ public CleanupAction(Supplier<LibraryTab> tabSupplier,
         this.stateManager = stateManager;
         this.taskExecutor = taskExecutor;
         this.undoManager = undoManager;
-        this.failures = new ArrayList<>();
 
         this.executable.bind(ActionHelper.needsEntriesSelected(stateManager));
     }
@@ -64,119 +43,16 @@ public void execute() {
             return;
         }
 
-        if (stateManager.getSelectedEntries().isEmpty()) { // None selected. Inform the user to select entries first.
-            dialogService.showInformationDialogAndWait(Localization.lang("Cleanup entry"), Localization.lang("First select entries to clean up."));
-            return;
-        }
-
-        isCanceled = false;
-        modifiedEntriesCount = 0;
-
         CleanupDialog cleanupDialog = new CleanupDialog(
                 stateManager.getActiveDatabase().get(),
-                preferences.getCleanupPreferences(),
-                preferences.getFilePreferences()
-        );
-
-        Optional<CleanupPreferences> chosenPreset = dialogService.showCustomDialogAndWait(cleanupDialog);
-
-        chosenPreset.ifPresent(preset -> {
-            if (preset.isActive(CleanupPreferences.CleanupStep.RENAME_PDF) && preferences.getAutoLinkPreferences().shouldAskAutoNamingPdfs()) {
-                boolean confirmed = dialogService.showConfirmationDialogWithOptOutAndWait(Localization.lang("Autogenerate PDF Names"),
-                        Localization.lang("Auto-generating PDF-Names does not support undo. Continue?"),
-                        Localization.lang("Autogenerate PDF Names"),
-                        Localization.lang("Cancel"),
-                        Localization.lang("Do not ask again"),
-                        optOut -> preferences.getAutoLinkPreferences().setAskAutoNamingPdfs(!optOut));
-                if (!confirmed) {
-                    isCanceled = true;
-                    return;
-                }
-            }
-
-            preferences.getCleanupPreferences().setActiveJobs(preset.getActiveJobs());
-            preferences.getCleanupPreferences().setFieldFormatterCleanups(preset.getFieldFormatterCleanups());
-
-            BackgroundTask.wrap(() -> cleanup(stateManager.getActiveDatabase().get(), preset))
-                          .onSuccess(result -> showResults())
-                          .onFailure(dialogService::showErrorDialogAndWait)
-                          .executeWith(taskExecutor);
-        });
-    }
-
-    /**
-     * Runs the cleanup on the entry and records the change.
-     *
-     * @return true iff entry was modified
-     */
-    private boolean doCleanup(BibDatabaseContext databaseContext, CleanupPreferences preset, BibEntry entry, NamedCompoundEdit compoundEdit) {
-        // Create and run cleaner
-        CleanupWorker cleaner = new CleanupWorker(
-                databaseContext,
-                preferences.getFilePreferences(),
-                preferences.getTimestampPreferences()
+                preferences,
+                dialogService,
+                stateManager,
+                undoManager,
+                tabSupplier,
+                taskExecutor
         );
 
-        List<FieldChange> changes = cleaner.cleanup(preset, entry);
-
-        // Register undo action
-        for (FieldChange change : changes) {
-            compoundEdit.addEdit(new UndoableFieldChange(change));
-        }
-
-        failures.addAll(cleaner.getFailures());
-
-        return !changes.isEmpty();
-    }
-
-    private void showResults() {
-        if (isCanceled) {
-            return;
-        }
-
-        if (modifiedEntriesCount > 0) {
-            tabSupplier.get().markBaseChanged();
-        }
-
-        if (modifiedEntriesCount == 0) {
-            dialogService.notify(Localization.lang("No entry needed a clean up"));
-        } else if (modifiedEntriesCount == 1) {
-            dialogService.notify(Localization.lang("One entry needed a clean up"));
-        } else {
-            dialogService.notify(Localization.lang("%0 entries needed a clean up", Integer.toString(modifiedEntriesCount)));
-        }
-    }
-
-    private void cleanup(BibDatabaseContext databaseContext, CleanupPreferences cleanupPreferences) {
-        this.failures.clear();
-
-        // undo granularity is on set of all entries
-        NamedCompoundEdit compoundEdit = new NamedCompoundEdit(Localization.lang("Clean up entries"));
-
-        for (BibEntry entry : List.copyOf(stateManager.getSelectedEntries())) {
-            if (doCleanup(databaseContext, cleanupPreferences, entry, compoundEdit)) {
-                modifiedEntriesCount++;
-            }
-        }
-
-        compoundEdit.end();
-
-        if (compoundEdit.hasEdits()) {
-            undoManager.addEdit(compoundEdit);
-        }
-
-        if (!failures.isEmpty()) {
-            showFailures(failures);
-        }
-    }
-
-    private void showFailures(List<JabRefException> failures) {
-        String message = failures.stream()
-                                 .map(exception -> "- " + exception.getLocalizedMessage())
-                                 .collect(Collectors.joining("\n"));
-
-        Platform.runLater(() ->
-                dialogService.showErrorDialogAndWait(Localization.lang("File Move Errors"), message)
-        );
+        dialogService.showCustomDialogAndWait(cleanupDialog);
     }
 }

jabgui/src/main/java/org/jabref/gui/cleanup/CleanupDialog.java

@@ -1,35 +1,87 @@
 package org.jabref.gui.cleanup;
 
-import javafx.scene.control.ButtonType;
-import javafx.scene.control.ScrollPane;
+import java.util.List;
+import java.util.function.Supplier;
 
+import javax.swing.undo.UndoManager;
+
+import javafx.fxml.FXML;
+import javafx.scene.control.Tab;
+import javafx.scene.control.TabPane;
+
+import org.jabref.gui.DialogService;
+import org.jabref.gui.LibraryTab;
+import org.jabref.gui.StateManager;
 import org.jabref.gui.util.BaseDialog;
 import org.jabref.logic.FilePreferences;
 import org.jabref.logic.cleanup.CleanupPreferences;
 import org.jabref.logic.l10n.Localization;
+import org.jabref.logic.preferences.CliPreferences;
+import org.jabref.logic.util.TaskExecutor;
 import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.model.entry.BibEntry;
+
+import com.airhacks.afterburner.views.ViewLoader;
+
+public class CleanupDialog extends BaseDialog<Void> {
+
+    @FXML private TabPane tabPane;
+
+    private final CleanupDialogViewModel viewModel;
+
+    // Constructor for multiple-entry cleanup
+    public CleanupDialog(BibDatabaseContext databaseContext,
+                         CliPreferences preferences,
+                         DialogService dialogService,
+                         StateManager stateManager,
+                         UndoManager undoManager,
+                         Supplier<LibraryTab> tabSupplier,
+                         TaskExecutor taskExecutor) {
+
+        this.viewModel = new CleanupDialogViewModel(
+                databaseContext, preferences, dialogService,
+                stateManager, undoManager, tabSupplier, taskExecutor
+        );
+
+        init(databaseContext, preferences);
+    }
 
-public class CleanupDialog extends BaseDialog<CleanupPreferences> {
-    public CleanupDialog(BibDatabaseContext databaseContext, CleanupPreferences initialPreset, FilePreferences filePreferences) {
+    // Constructor for single-entry cleanup
+    public CleanupDialog(BibEntry targetEntry,
+                         BibDatabaseContext databaseContext,
+                         CliPreferences preferences,
+                         DialogService dialogService,
+                         StateManager stateManager,
+                         UndoManager undoManager) {
+
+        this.viewModel = new CleanupDialogViewModel(
+                databaseContext, preferences, dialogService,
+                stateManager, undoManager, null, null
+        );
+
+        viewModel.setTargetEntries(List.of(targetEntry));
+
+        init(databaseContext, preferences);
+    }
+
+    private void init(BibDatabaseContext databaseContext, CliPreferences preferences) {
         setTitle(Localization.lang("Clean up entries"));
-        getDialogPane().setPrefSize(600, 650);
-        getDialogPane().getButtonTypes().setAll(ButtonType.OK, ButtonType.CANCEL);
-
-        CleanupPresetPanel presetPanel = new CleanupPresetPanel(databaseContext, initialPreset, filePreferences);
-
-        // placing the content of the presetPanel in a scroll pane
-        ScrollPane scrollPane = new ScrollPane();
-        scrollPane.setFitToWidth(true);
-        scrollPane.setFitToHeight(true);
-        scrollPane.setContent(presetPanel);
-
-        getDialogPane().setContent(scrollPane);
-        setResultConverter(button -> {
-            if (button == ButtonType.OK) {
-                return presetPanel.getCleanupPreset();
-            } else {
-                return null;
-            }
-        });
+
+        ViewLoader.view(this)
+                  .load()
+                  .setAsDialogPane(this);
+
+        CleanupPreferences initialPreset = preferences.getCleanupPreferences();
+        FilePreferences filePreferences = preferences.getFilePreferences();
+
+        CleanupSingleFieldPanel singleFieldPanel = new CleanupSingleFieldPanel(initialPreset, viewModel);
+        CleanupFileRelatedPanel fileRelatedPanel = new CleanupFileRelatedPanel(databaseContext, initialPreset, filePreferences, viewModel);
+        CleanupMultiFieldPanel multiFieldPanel = new CleanupMultiFieldPanel(initialPreset, viewModel);
+
+        tabPane.getTabs().setAll(
+                new Tab(Localization.lang("Single field"), singleFieldPanel),
+                new Tab(Localization.lang("File-related"), fileRelatedPanel),
+                new Tab(Localization.lang("Multi-field"), multiFieldPanel)
+        );
     }
 }