Add fix options for integrity issues

CHANGELOG.md

@@ -11,6 +11,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 
 ### Added
 
+- We added a feature to fix integrity issues one at a time or similar issues by selecting a type, or to fix all at once. [#11419](https://github.com/JabRef/jabref/issues/11419)
 - We added <kbd>F5</kbd> as a shortcut key for fetching data and <kbd>Alt+F</kbd> as a shortcut for looking up data using DOI. [#11802](https://github.com/JabRef/jabref/issues/11802)
 - We added a feature to rename the subgroup, with the keybinding (<kbd>F2</kbd>) for quick access. [#11896](https://github.com/JabRef/jabref/issues/11896)
 - We added a new functionality that displays a drop-down list of matching suggestions when typing a citation key pattern. [#12502](https://github.com/JabRef/jabref/issues/12502)

src/main/java/org/jabref/gui/integrity/IntegrityCheckAction.java

@@ -78,7 +78,7 @@ protected List<IntegrityMessage> call() {
             if (messages.isEmpty()) {
                 dialogService.notify(Localization.lang("No problems found."));
             } else {
-                dialogService.showCustomDialogAndWait(new IntegrityCheckDialog(messages, tabSupplier.get()));
+                dialogService.showCustomDialogAndWait(new IntegrityCheckDialog(messages, tabSupplier.get(), dialogService));
             }
         });
         task.setOnFailed(event -> dialogService.showErrorDialogAndWait("Integrity check failed.", task.getException()));

src/main/java/org/jabref/gui/integrity/IntegrityCheckDialog.fxml

@@ -8,25 +8,33 @@
 <?import javafx.scene.control.TableView?>
 <?import javafx.scene.layout.HBox?>
 <?import javafx.scene.layout.VBox?>
+<?import javafx.scene.control.ComboBox?>
 <DialogPane xmlns:fx="http://javafx.com/fxml/1" prefHeight="600.0" prefWidth="700.0"
             xmlns="http://javafx.com/javafx/8.0.121" fx:controller="org.jabref.gui.integrity.IntegrityCheckDialog">
     <content>
-        <VBox spacing="4.0">
-            <TableView fx:id="messagesTable" prefHeight="550" prefWidth="700.0" VBox.vgrow="ALWAYS" HBox.hgrow="ALWAYS">
+        <VBox spacing="10.0">
+            <TableView fx:id="messagesTable" prefHeight="600" prefWidth="750.0" VBox.vgrow="ALWAYS" HBox.hgrow="ALWAYS">
                 <columns>
                     <TableColumn fx:id="keyColumn" prefWidth="150.0" maxWidth="200"  text="%Citation key"/>
-                    <TableColumn fx:id="fieldColumn" prefWidth="110.0" maxWidth="200" text="%Field"/>
-                    <TableColumn fx:id="messageColumn" prefWidth="400" text="%Message"/>
+                    <TableColumn fx:id="fieldColumn" prefWidth="150.0" maxWidth="200" text="%Field"/>
+                    <TableColumn fx:id="messageColumn" prefWidth="300" text="%Message"/>
+                    <TableColumn fx:id="fixesColumn" prefWidth="200.0" maxWidth="200" text="%Fix"/>
                 </columns>
                 <columnResizePolicy>
                     <TableView fx:constant="CONSTRAINED_RESIZE_POLICY_FLEX_LAST_COLUMN"/>
                 </columnResizePolicy>
             </TableView>
             <HBox maxHeight="30" spacing="4.0">
-                <MenuButton fx:id="keyFilterButton" prefHeight="30.0" maxHeight="30.0" text="%Citation key filters"/>
-                <MenuButton fx:id="fieldFilterButton" prefHeight="30.0" maxHeight="30.0" text="%Field filters"/>
-                <MenuButton fx:id="messageFilterButton" prefHeight="30.0" maxHeight="30.0" text="%Message filters"/>
-                <Button onAction="#clearFilters" text="%Clear filters"/>
+                <MenuButton fx:id="keyFilterButton" prefHeight="30.0" maxHeight="30.0" text="%Citation key filter"/>
+                <MenuButton fx:id="fieldFilterButton" prefHeight="30.0" maxHeight="30.0" text="%Field filter"/>
+                <MenuButton fx:id="messageFilterButton" prefHeight="30.0" maxHeight="30.0" text="%Message filter"/>
+            </HBox>
+            <HBox maxHeight="30" spacing="10.0" alignment="CENTER_RIGHT">
+                <HBox spacing="4.0">
+                    <ComboBox fx:id="entryTypeCombo" maxWidth="400"  />
+                    <Button onAction="#fixByType" prefHeight="20.0" text="%Fix by type"/>
+                </HBox>
+                <Button onAction="#fixAll" prefHeight="20.0" text="%Fix all"/>
             </HBox>
         </VBox>
     </content>

src/main/java/org/jabref/gui/integrity/IntegrityCheckDialog.java

@@ -1,23 +1,36 @@
 package org.jabref.gui.integrity;
 
+import java.util.Arrays;
+import java.util.HashSet;
 import java.util.List;
+import java.util.Objects;
+import java.util.Optional;
+import java.util.Set;
+import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.function.Function;
 
+import javafx.application.Platform;
 import javafx.beans.property.ReadOnlyStringWrapper;
 import javafx.fxml.FXML;
+import javafx.scene.control.Button;
+import javafx.scene.control.ComboBox;
 import javafx.scene.control.ContextMenu;
+import javafx.scene.control.Label;
 import javafx.scene.control.MenuButton;
+import javafx.scene.control.TableCell;
 import javafx.scene.control.TableColumn;
 import javafx.scene.control.TableView;
 import javafx.scene.input.MouseButton;
 import javafx.scene.input.MouseEvent;
 import javafx.stage.Modality;
 
+import org.jabref.gui.DialogService;
 import org.jabref.gui.LibraryTab;
 import org.jabref.gui.theme.ThemeManager;
 import org.jabref.gui.util.BaseDialog;
 import org.jabref.gui.util.ValueTableCellFactory;
 import org.jabref.gui.util.ViewModelTableRowFactory;
+import org.jabref.logic.integrity.IntegrityIssue;
 import org.jabref.logic.integrity.IntegrityMessage;
 import org.jabref.logic.l10n.Localization;
 
@@ -31,20 +44,30 @@ public class IntegrityCheckDialog extends BaseDialog<Void> {
     @FXML private TableColumn<IntegrityMessage, String> keyColumn;
     @FXML private TableColumn<IntegrityMessage, String> fieldColumn;
     @FXML private TableColumn<IntegrityMessage, String> messageColumn;
+    @FXML private TableColumn<IntegrityMessage, String> fixesColumn;
     @FXML private MenuButton keyFilterButton;
     @FXML private MenuButton fieldFilterButton;
     @FXML private MenuButton messageFilterButton;
+    @FXML private ComboBox<String> entryTypeCombo;
 
     @Inject private ThemeManager themeManager;
 
     private final List<IntegrityMessage> messages;
     private final LibraryTab libraryTab;
+    private final DialogService dialogService;
+
     private IntegrityCheckDialogViewModel viewModel;
     private TableFilter<IntegrityMessage> tableFilter;
 
-    public IntegrityCheckDialog(List<IntegrityMessage> messages, LibraryTab libraryTab) {
+    private final double FIX_BUTTON_HEIGHT = 20.0;
+
+    public IntegrityCheckDialog(List<IntegrityMessage> messages,
+                                LibraryTab libraryTab,
+                                DialogService dialogService) {
         this.messages = messages;
         this.libraryTab = libraryTab;
+        this.dialogService = dialogService;
+
         this.setTitle(Localization.lang("Check integrity"));
         this.initModality(Modality.NONE);
 
@@ -76,10 +99,55 @@ private void initialize() {
                 .withOnMouseClickedEvent(this::handleRowClick)
                 .install(messagesTable);
         messagesTable.setItems(viewModel.getMessages());
+        updateEntryTypeCombo();
         keyColumn.setCellValueFactory(row -> new ReadOnlyStringWrapper(row.getValue().entry().getCitationKey().orElse("")));
         fieldColumn.setCellValueFactory(row -> new ReadOnlyStringWrapper(row.getValue().field().getDisplayName()));
         messageColumn.setCellValueFactory(row -> new ReadOnlyStringWrapper(row.getValue().message()));
 
+        fixesColumn.setCellFactory(row -> new TableCell<>() {
+            private final Button button = new Button();
+
+            @Override
+            protected void updateItem(String item, boolean empty) {
+                super.updateItem(item, empty);
+                if (empty || getTableRow() == null || getTableRow().getItem() == null) {
+                    setGraphic(null);
+                    return;
+                }
+                IntegrityMessage rowData = getTableRow().getItem();
+                configureAction(rowData);
+            }
+
+            /**
+             * Configures the action for the button based on the provided {@link IntegrityMessage}.
+             * If a fix is available for the message, the button is configured to apply the fix when clicked.
+             *
+             * @param message the {@link IntegrityMessage} to check for available fixes
+             */
+            private void configureAction(IntegrityMessage message) {
+                Optional<IntegrityIssue> issue = IntegrityIssue.fromMessage(message);
+                if (issue.isEmpty()) {
+                    return;
+                }
+                if (issue.get().getFix().isEmpty()) {
+                    setGraphic(new Label(Localization.lang("No fix available")));
+                    return;
+                }
+                configureButton(issue.get().getFix().toString(), () -> {
+                    viewModel.fix(issue.get(), message);
+                    viewModel.removeFromEntryTypes(message.field().getDisplayName());
+                    Platform.runLater(() -> viewModel.columnsListProperty().getValue().removeIf(column -> Objects.equals(column.message(), message.message())));
+                });
+                setGraphic(button);
+            }
+
+            private void configureButton(String text, Runnable action) {
+                button.setText(text);
+                button.setPrefHeight(FIX_BUTTON_HEIGHT);
+                button.setOnAction(event -> action.run());
+            }
+        });
+
         new ValueTableCellFactory<IntegrityMessage, String>()
                 .withText(Function.identity())
                 .withTooltip(Function.identity())
@@ -91,6 +159,8 @@ private void initialize() {
         addMessageColumnFilter(keyColumn, keyFilterButton);
         addMessageColumnFilter(fieldColumn, fieldFilterButton);
         addMessageColumnFilter(messageColumn, messageFilterButton);
+
+       messagesTable.itemsProperty().bind(viewModel.columnsListProperty());
     }
 
     private void addMessageColumnFilter(TableColumn<IntegrityMessage, String> messageColumn, MenuButton messageFilterButton) {
@@ -121,4 +191,84 @@ public void clearFilters() {
             });
         }
     }
+
+    private void updateEntryTypeCombo() {
+        Set<String> entryTypes = viewModel.getEntryTypes();
+        Set<String> uniqueTexts = new HashSet<>();
+        entryTypeCombo.getItems().clear();
+
+        Arrays.stream(IntegrityIssue.values())
+              .filter(issue -> issue.getFix().isPresent())
+              .filter(issue -> entryTypes.contains(issue.getText()))
+              .filter(issue -> uniqueTexts.add(issue.getText()))
+              .forEach(issue -> entryTypeCombo.getItems().add(issue.getText()));
+
+        if (entryTypeCombo.getItems().isEmpty()) {
+            entryTypeCombo.getItems().add(Localization.lang("No fix available"));
+        }
+        entryTypeCombo.getSelectionModel().selectFirst();
+    }
+
+    public void fix(IntegrityIssue issue, IntegrityMessage message) {
+        viewModel.fix(issue, message);
+        viewModel.removeFromEntryTypes(message.field().getDisplayName());
+        Platform.runLater(() -> viewModel.columnsListProperty().getValue().removeIf(column -> Objects.equals(column.message(), message.message())));
+    }
+
+    /**
+     * Checks if a given {@link IntegrityMessage} has a fix available.
+     *
+     * @param message the {@link IntegrityMessage} to check
+     * @return {@code true} if a fix is available, {@code false} otherwise
+     */
+    private boolean hasFix(IntegrityMessage message) {
+        return message != null && message.field() != null && IntegrityIssue.fromMessage(message)
+                                                                           .map(issue -> issue.getFix().isPresent())
+                                                                           .orElse(false);
+    }
+
+    /**
+     * Attempts to fix all {@link IntegrityMessage} objects of the selected type.
+     * If fixes are available, they are applied, and the fixed messages are removed.
+     * A notification is shown to indicate success or failure.
+     */
+    @FXML
+    private void fixByType() {
+        AtomicBoolean fixed = new AtomicBoolean(false);
+
+        String selectedType = entryTypeCombo.getSelectionModel().getSelectedItem();
+        Optional<IntegrityIssue> selectedIssue = Arrays.stream(IntegrityIssue.values())
+                                                       .filter(issue -> issue.getText().equals(selectedType))
+                                                       .findFirst();
+
+        selectedIssue.ifPresent(issue -> {
+            messagesTable.getItems().stream()
+                    .filter(message -> message.message().equals(issue.getText()) && hasFix(message)) // Filter messages matching the selected issue type and have a fix
+                    .forEach(message -> {
+                        fix(issue, message);
+                        fixed.set(true);
+                    });
+        });
+
+        updateEntryTypeCombo();
+
+        if (fixed.get()) {
+            dialogService.notify(Localization.lang("Fixed successfully."));
+        } else {
+            dialogService.notify(Localization.lang("No fixes available."));
+        }
+    }
+
+    /**
+     * Attempts to fix all {@link IntegrityMessage} objects that have a fix available.
+     * Messages with applicable fixes are processed, and the corresponding UI elements are updated.
+     */
+    @FXML
+    private void fixAll() {
+        messagesTable.getItems().stream()
+                .filter(this::hasFix)   // Filter all messages that have a fix
+                .forEach(message -> IntegrityIssue.fromMessage(message).ifPresent(issue -> fix(issue, message)));
+
+        updateEntryTypeCombo();
+    }
 }