Add pagination for search based fetchers

CHANGELOG.md

@@ -20,6 +20,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We added the field `monthfiled` to the default list of fields to resolve BibTeX-Strings for [#13375](https://github.com/JabRef/jabref/issues/13375)
 - We added a new ID based fetcher for [EuropePMC](https://europepmc.org/). [#13389](https://github.com/JabRef/jabref/pull/13389)
 - We added an initial [cite as you write](https://retorque.re/zotero-better-bibtex/citing/cayw/) endpoint. [#13187](https://github.com/JabRef/jabref/issues/13187)
+- We added pagination support for the web search entries dialog, improving navigation for large search results. [#5507](https://github.com/JabRef/jabref/issues/5507)
 
 ### Changed
 

jabgui/src/main/java/org/jabref/gui/importer/WebImportEntriesDialog.java

@@ -0,0 +1,298 @@
+package org.jabref.gui.importer;
+
+import java.util.Optional;
+
+import javax.swing.undo.UndoManager;
+
+import javafx.beans.binding.Bindings;
+import javafx.beans.binding.BooleanBinding;
+import javafx.collections.ListChangeListener;
+import javafx.css.PseudoClass;
+import javafx.fxml.FXML;
+import javafx.geometry.Insets;
+import javafx.scene.Node;
+import javafx.scene.control.Button;
+import javafx.scene.control.ButtonType;
+import javafx.scene.control.CheckBox;
+import javafx.scene.control.ComboBox;
+import javafx.scene.control.Label;
+import javafx.scene.control.ToggleButton;
+import javafx.scene.control.Tooltip;
+import javafx.scene.layout.Border;
+import javafx.scene.layout.BorderStroke;
+import javafx.scene.layout.BorderStrokeStyle;
+import javafx.scene.layout.BorderWidths;
+import javafx.scene.layout.CornerRadii;
+import javafx.scene.layout.HBox;
+import javafx.scene.layout.Priority;
+import javafx.scene.layout.VBox;
+import javafx.scene.paint.Color;
+
+import org.jabref.gui.DialogService;
+import org.jabref.gui.StateManager;
+import org.jabref.gui.entryeditor.citationrelationtab.BibEntryView;
+import org.jabref.gui.icon.IconTheme;
+import org.jabref.gui.preferences.GuiPreferences;
+import org.jabref.gui.util.BaseDialog;
+import org.jabref.gui.util.NoSelectionModel;
+import org.jabref.gui.util.ViewModelListCellFactory;
+import org.jabref.logic.importer.PagedSearchBasedFetcher;
+import org.jabref.logic.importer.ParserResult;
+import org.jabref.logic.importer.SearchBasedFetcher;
+import org.jabref.logic.l10n.Localization;
+import org.jabref.logic.shared.DatabaseLocation;
+import org.jabref.logic.util.BackgroundTask;
+import org.jabref.logic.util.TaskExecutor;
+import org.jabref.logic.util.io.FileUtil;
+import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.BibEntryTypesManager;
+import org.jabref.model.util.FileUpdateMonitor;
+
+import com.airhacks.afterburner.views.ViewLoader;
+import com.tobiasdiez.easybind.EasyBind;
+import jakarta.inject.Inject;
+import org.controlsfx.control.CheckListView;
+import org.fxmisc.richtext.CodeArea;
+
+public class WebImportEntriesDialog extends BaseDialog<Boolean> {
+
+    @FXML private Label pageNumberLabel;
+    @FXML private CheckListView<BibEntry> entriesListView;
+    @FXML private ComboBox<BibDatabaseContext> libraryListView;
+    @FXML private ButtonType importButton;
+    @FXML private Label totalItems;
+    @FXML private Label selectedItems;
+    @FXML private Label bibTeXDataLabel;
+    @FXML private CheckBox downloadLinkedOnlineFiles;
+    @FXML private CheckBox showEntryInformation;
+    @FXML private CodeArea bibTeXData;
+    @FXML private VBox bibTeXDataBox;
+
+    private final BackgroundTask<ParserResult> task;
+    private final BibDatabaseContext database;
+    private WebImportEntriesViewModel viewModel;
+    private final SearchBasedFetcher searchBasedFetcher;
+    private final String query;
+
+    @Inject private TaskExecutor taskExecutor;
+    @Inject private DialogService dialogService;
+    @Inject private UndoManager undoManager;
+    @Inject private GuiPreferences preferences;
+    @Inject private StateManager stateManager;
+    @Inject private BibEntryTypesManager entryTypesManager;
+    @Inject private FileUpdateMonitor fileUpdateMonitor;
+
+    /**
+     * Imports the given entries into the given database. The entries are provided using the BackgroundTask
+     *
+     * @param database the database to import into
+     * @param task     the task executed for parsing the selected files(s).
+     */
+    public WebImportEntriesDialog(BibDatabaseContext database, BackgroundTask<ParserResult> task, SearchBasedFetcher fetcher, String query) {
+        this.database = database;
+        this.task = task;
+        this.searchBasedFetcher = fetcher;
+        this.query = query;
+
+        ViewLoader.view(this)
+                  .load()
+                  .setAsDialogPane(this);
+
+        BooleanBinding booleanBind = Bindings.isEmpty(entriesListView.getCheckModel().getCheckedItems());
+        Button btn = (Button) this.getDialogPane().lookupButton(importButton);
+        btn.disableProperty().bind(booleanBind);
+
+        downloadLinkedOnlineFiles.setSelected(preferences.getFilePreferences().shouldDownloadLinkedFiles());
+
+        setResultConverter(button -> {
+            if (button == importButton) {
+                viewModel.importEntries(viewModel.getCheckedEntries().stream().toList(), downloadLinkedOnlineFiles.isSelected());
+            } else {
+                dialogService.notify(Localization.lang("Import canceled"));
+            }
+
+            return false;
+        });
+    }
+
+    @FXML
+    private void initialize() {
+        viewModel = new WebImportEntriesViewModel(task, taskExecutor, database, dialogService, undoManager, preferences, stateManager, entryTypesManager, fileUpdateMonitor, searchBasedFetcher, query);
+        Label placeholder = new Label();
+        placeholder.textProperty().bind(viewModel.messageProperty());
+        entriesListView.setPlaceholder(placeholder);
+        entriesListView.setItems(viewModel.getEntries());
+        entriesListView.getCheckModel().getCheckedItems().addListener((ListChangeListener<BibEntry>) change -> {
+            while (change.next()) {
+                if (change.wasAdded()) {
+                    for (BibEntry entry : change.getAddedSubList()) {
+                        viewModel.getCheckedEntries().add(entry);
+                    }
+                }
+                if (change.wasRemoved()) {
+                    for (BibEntry entry : change.getRemoved()) {
+                        viewModel.getCheckedEntries().remove(entry);
+                    }
+                }
+            }
+        });
+
+        libraryListView.setEditable(false);
+        libraryListView.getItems().addAll(stateManager.getOpenDatabases());
+        new ViewModelListCellFactory<BibDatabaseContext>()
+                .withText(database -> {
+                    Optional<String> dbOpt = Optional.empty();
+                    if (database.getDatabasePath().isPresent()) {
+                        dbOpt = FileUtil.getUniquePathFragment(stateManager.getAllDatabasePaths(), database.getDatabasePath().get());
+                    }
+                    if (database.getLocation() == DatabaseLocation.SHARED) {
+                        return database.getDBMSSynchronizer().getDBName() + " [" + Localization.lang("shared") + "]";
+                    }
+
+                    return dbOpt.orElseGet(() -> Localization.lang("untitled"));
+                })
+                .install(libraryListView);
+        viewModel.selectedDbProperty().bind(libraryListView.getSelectionModel().selectedItemProperty());
+        stateManager.getActiveDatabase().ifPresent(database1 -> libraryListView.getSelectionModel().select(database1));
+
+        PseudoClass entrySelected = PseudoClass.getPseudoClass("selected");
+        new ViewModelListCellFactory<BibEntry>()
+                .withGraphic(entry -> {
+                    ToggleButton addToggle = IconTheme.JabRefIcons.ADD.asToggleButton();
+                    EasyBind.subscribe(addToggle.selectedProperty(), selected -> {
+                        if (selected) {
+                            addToggle.setGraphic(IconTheme.JabRefIcons.ADD_FILLED.withColor(IconTheme.SELECTED_COLOR).getGraphicNode());
+                        } else {
+                            addToggle.setGraphic(IconTheme.JabRefIcons.ADD.getGraphicNode());
+                        }
+                    });
+                    addToggle.getStyleClass().add("addEntryButton");
+                    addToggle.selectedProperty().bindBidirectional(entriesListView.getItemBooleanProperty(entry));
+                    HBox separator = new HBox();
+                    HBox.setHgrow(separator, Priority.SOMETIMES);
+                    Node entryNode = BibEntryView.getEntryNode(entry);
+                    HBox.setHgrow(entryNode, Priority.ALWAYS);
+                    HBox container = new HBox(entryNode, separator, addToggle);
+                    container.getStyleClass().add("entry-container");
+                    container.prefWidthProperty().bind(entriesListView.widthProperty().subtract(25));
+
+                    BackgroundTask.wrap(() -> viewModel.hasDuplicate(entry)).onSuccess(duplicateFound -> {
+                        if (duplicateFound) {
+                            Node icon = IconTheme.JabRefIcons.ERROR.getGraphicNode();
+                            Tooltip tooltip = new Tooltip(Localization.lang("Possible duplicate of existing entry. Will be resolved on import."));
+                            Tooltip.install(icon, tooltip);
+                            container.getChildren().add(icon);
+                        }
+                    }).executeWith(taskExecutor);
+
+                    /*
+                    inserted the if-statement here, since a Platform.runLater() call did not work.
+                    also tried to move it to the end of the initialize method, but it did not select the entry.
+                    */
+                    if (entriesListView.getItems().size() == 1) {
+                        selectAllNewEntries();
+                    }
+
+                    return container;
+                })
+                .withOnMouseClickedEvent((entry, event) -> {
+                    entriesListView.getCheckModel().toggleCheckState(entry);
+                    displayBibTeX(entry, viewModel.getSourceString(entry));
+                })
+                .withPseudoClass(entrySelected, entriesListView::getItemBooleanProperty)
+                .install(entriesListView);
+
+        selectedItems.textProperty().bind(Bindings.size(viewModel.getCheckedEntries()).asString());
+        totalItems.textProperty().bind(Bindings.size(viewModel.getAllEntries()).asString());
+        entriesListView.setSelectionModel(new NoSelectionModel<>());
+        initBibTeX();
+        updatePageUI();
+    }
+
+    private void updatePageUI() {
+        pageNumberLabel.textProperty().bind(Bindings.createStringBinding(() -> {
+            int totalPages = viewModel.totalPagesProperty().get();
+            int currentPage = viewModel.currentPageProperty().get() + 1;
+            if (searchBasedFetcher instanceof PagedSearchBasedFetcher && currentPage == totalPages) {
+                return Localization.lang("Fetching...");
+            }
+            if (totalPages != 0) {
+                return currentPage + " " + Localization.lang("of") + " " + totalPages;
+            }
+            return "";
+        }, viewModel.currentPageProperty(), viewModel.totalPagesProperty()));
+        viewModel.getAllEntries().addListener((ListChangeListener<BibEntry>) change -> {
+            while (change.next()) {
+                if (change.wasAdded() || change.wasRemoved()) {
+                    viewModel.updateTotalPages();
+                }
+            }
+        });
+    }
+
+    private void displayBibTeX(BibEntry entry, String bibTeX) {
+        if (viewModel.getCheckedEntries().contains(entry)) {
+            bibTeXData.clear();
+            bibTeXData.appendText(bibTeX);
+            bibTeXData.moveTo(0);
+            bibTeXData.requestFollowCaret();
+        } else {
+            bibTeXData.clear();
+        }
+    }
+
+    private void initBibTeX() {
+        bibTeXDataLabel.setText(Localization.lang("%0 source", "BibTeX"));
+        bibTeXData.setBorder(new Border(new BorderStroke(Color.GREY, BorderStrokeStyle.SOLID, CornerRadii.EMPTY, BorderWidths.DEFAULT)));
+        bibTeXData.setPadding(new Insets(5.0));
+        showEntryInformation.selectedProperty().addListener((observableValue, old_val, new_val) -> {
+            bibTeXDataBox.setVisible(new_val);
+            bibTeXDataBox.setManaged(new_val);
+        });
+    }
+
+    public void unselectAll() {
+        viewModel.getCheckedEntries().clear();
+        for (int i = 0; i < entriesListView.getItems().size(); i++) {
+            entriesListView.getCheckModel().clearCheck(i);
+        }
+    }
+
+    public void selectAllNewEntries() {
+        unselectAll();
+        for (BibEntry entry : viewModel.getAllEntries()) {
+            if (!viewModel.hasDuplicate(entry)) {
+                entriesListView.getCheckModel().check(entry);
+                viewModel.getCheckedEntries().add(entry);
+                displayBibTeX(entry, viewModel.getSourceString(entry));
+            }
+        }
+    }
+
+    public void selectAllEntries() {
+        unselectAll();
+        entriesListView.getCheckModel().checkAll();
+        viewModel.getCheckedEntries().addAll(viewModel.getAllEntries());
+    }
+
+    @FXML
+    private void onPrevPage() {
+        viewModel.prevPage();
+        restoreCheckedEntries();
+    }
+
+    @FXML
+    private void onNextPage() {
+        viewModel.nextPage();
+        restoreCheckedEntries();
+    }
+
+    private void restoreCheckedEntries() {
+        for (BibEntry entry : viewModel.getEntries()) {
+            if (viewModel.getCheckedEntries().contains(entry)) {
+                entriesListView.getCheckModel().check(entry);
+            }
+        }
+    }
+}