Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Paging support for fetchers #5507 #10916

Closed
wants to merge 3 commits into from
Closed

Paging support for fetchers #5507 #10916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2164a67
Add --next and previous buttons
Feb 25, 2024
cf7dc50
Merge remote-tracking branch 'origin/main'
Feb 25, 2024
a321748
Remove --comments
Feb 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/main/java/org/jabref/gui/importer/ImportEntriesDialog.fxml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
<Button onAction="#selectAllNewEntries" text="%Select all new entries"/>
<Button onAction="#selectAllEntries" text="%Select all entries"/>
<Button onAction="#unselectAll" text="%Unselect all"/>

</HBox>
<VBox fx:id="bibTeXDataBox" visible="false" managed="false">
<Label fx:id="bibTeXDataLabel"/>
Expand Down
2 changes: 0 additions & 2 deletions src/main/java/org/jabref/gui/importer/ImportEntriesViewModel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,8 +192,6 @@ public void importEntries(List<BibEntry> entriesToImport, boolean shouldDownload
parserResult.getMetaData(),
parserResult.getPath().map(path -> path.getFileName().toString()).orElse("unknown"),
parserResult.getDatabase().getEntries());

// JabRefGUI.getMainFrame().getCurrentLibraryTab().markBaseChanged();
}

private void buildImportHandlerThenImportEntries(List<BibEntry> entriesToImport) {
Expand Down
66 changes: 66 additions & 0 deletions src/main/java/org/jabref/gui/importer/WebImportEntriesDialog.fxml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
<?xml version="1.0" encoding="UTF-8"?>

<?import javafx.scene.control.Button?>
<?import javafx.scene.control.ButtonType?>
<?import javafx.scene.control.CheckBox?>
<?import javafx.scene.control.DialogPane?>
<?import javafx.scene.control.Label?>
<?import javafx.scene.layout.ColumnConstraints?>
<?import javafx.scene.layout.GridPane?>
<?import javafx.scene.layout.HBox?>
<?import javafx.scene.layout.RowConstraints?>
<?import javafx.scene.layout.VBox?>
<?import org.controlsfx.control.CheckListView?>
<?import javafx.scene.control.ComboBox?>
<?import org.fxmisc.richtext.CodeArea?>
<DialogPane prefHeight="700.0" prefWidth="1000.0" xmlns="http://javafx.com/javafx/10.0.2-internal"
xmlns:fx="http://javafx.com/fxml/1" fx:controller="org.jabref.gui.importer.WebImportEntriesDialog">
<content>
<VBox spacing="10.0">
<Label text="%Select the entries to be imported:"/>
<CheckListView fx:id="entriesListView" VBox.vgrow="ALWAYS"/>
<HBox spacing="4">
<VBox spacing="10">
<HBox spacing="4">
<Button onAction="#selectAllNewEntries" text="%Select all new entries"/>
<Button onAction="#selectAllEntries" text="%Select all entries"/>
<Button onAction="#unselectAll" text="%Unselect all"/>
<Button fx:id="previousButton" text="Previous" />
<Button fx:id="nextButton" text="Next" />
<Label fx:id="pageLabel"/>
</HBox>
<VBox fx:id="bibTeXDataBox" visible="false" managed="false">
<Label fx:id="bibTeXDataLabel"/>
<CodeArea fx:id="bibTeXData" editable="false" minHeight="30.0" prefHeight="200.0" prefWidth="700.0" wrapText="true"/>
</VBox>
<HBox spacing="4" alignment="CENTER_LEFT">
<Label text="%Library to import into"/>
<ComboBox fx:id="libraryListView" layoutX="16.0" layoutY="52.0"/>
</HBox>
</VBox>
<HBox HBox.hgrow="ALWAYS"/>
<GridPane hgap="4.0" vgap="4.0">
<columnConstraints>
<ColumnConstraints hgrow="SOMETIMES"/>
<ColumnConstraints hgrow="SOMETIMES" minWidth="30" halignment="RIGHT"/>
</columnConstraints>
<rowConstraints>
<RowConstraints minHeight="10.0"/>
<RowConstraints minHeight="10.0"/>
<RowConstraints minHeight="10.0"/>
</rowConstraints>
<Label styleClass="info-section" text="%Total items found:"/>
<Label fx:id="totalItems" GridPane.columnIndex="1"/>
<Label styleClass="info-section" text="%Selected items:" GridPane.rowIndex="1"/>
<Label fx:id="selectedItems" GridPane.rowIndex="1" GridPane.columnIndex="1"/>
</GridPane>
</HBox>
<HBox spacing="4">
<CheckBox fx:id="downloadLinkedOnlineFiles" text="%Download linked online files"/>
<CheckBox fx:id="showEntryInformation" text="%Show BibTeX source"/>
</HBox>
</VBox>
</content>
<ButtonType fx:id="importButton" buttonData="OK_DONE" text="%Import entries"/>
<ButtonType fx:constant="CANCEL"/>
</DialogPane>
313 changes: 313 additions & 0 deletions src/main/java/org/jabref/gui/importer/WebImportEntriesDialog.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,313 @@
package org.jabref.gui.importer;

import java.util.ArrayList;
import java.util.EnumSet;
import java.util.List;
import java.util.Optional;

import javax.swing.undo.UndoManager;

import javafx.beans.binding.Bindings;
import javafx.beans.binding.BooleanBinding;
import javafx.beans.property.IntegerProperty;
import javafx.beans.property.SimpleIntegerProperty;
import javafx.collections.FXCollections;
import javafx.collections.ObservableList;
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 javafx.scene.text.Text;

import org.jabref.gui.DialogService;
import org.jabref.gui.StateManager;
import org.jabref.gui.icon.IconTheme;
import org.jabref.gui.util.BackgroundTask;
import org.jabref.gui.util.BaseDialog;
import org.jabref.gui.util.NoSelectionModel;
import org.jabref.gui.util.TaskExecutor;
import org.jabref.gui.util.TextFlowLimited;
import org.jabref.gui.util.ViewModelListCellFactory;
import org.jabref.logic.importer.ParserResult;
import org.jabref.logic.l10n.Localization;
import org.jabref.logic.shared.DatabaseLocation;
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.entry.field.StandardField;
import org.jabref.model.entry.types.EntryType;
import org.jabref.model.entry.types.StandardEntryType;
import org.jabref.model.util.FileUpdateMonitor;
import org.jabref.preferences.PreferencesService;

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> {
public CheckListView<BibEntry> entriesListView;
public ComboBox<BibDatabaseContext> libraryListView;
public ButtonType importButton;
public Button previousButton;
public Button nextButton;
@FXML
public Label pageLabel;
public Label totalItems;
public Label selectedItems;
public Label bibTeXDataLabel;
public CheckBox downloadLinkedOnlineFiles;
public CheckBox showEntryInformation;
public CodeArea bibTeXData;
public VBox bibTeXDataBox;
private final BackgroundTask<ParserResult> task;
private final BibDatabaseContext database;
private ImportEntriesViewModel viewModel;
private List<BibEntry> entries = new ArrayList<>();
private IntegerProperty currentPage;
@Inject private TaskExecutor taskExecutor;
@Inject private DialogService dialogService;
@Inject private UndoManager undoManager;
@Inject private PreferencesService 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) {
this.database = database;
this.task = task;
this.currentPage = new SimpleIntegerProperty(1);
ViewLoader.view(this)
.load()
.setAsDialogPane(this);

task.onSuccess(parserResult -> {
entries = parserResult.getDatabase().getEntries();
setItemsForCurrentPage(currentPage.get(), 20);
});
previousButton.setOnAction(event -> {
if (currentPage.get() > 1) {
currentPage.set(currentPage.get() - 1);
setItemsForCurrentPage(currentPage.get(), 20);
}
});

nextButton.setOnAction(event -> {
int totalPages = (int) Math.ceil((double) entries.size() / 20);
if (currentPage.get() < totalPages) {
currentPage.set(currentPage.get() + 1);
setItemsForCurrentPage(currentPage.get(), 20);
}
});

task.executeWith(taskExecutor);

BooleanBinding booleanBind = Bindings.isEmpty(entriesListView.getCheckModel().getCheckedItems());
Button btn = (Button) this.getDialogPane().lookupButton(importButton);
btn.disableProperty().bind(booleanBind);
previousButton.disableProperty().bind(currentPage.lessThanOrEqualTo(1));

downloadLinkedOnlineFiles.setSelected(preferences.getFilePreferences().shouldDownloadLinkedFiles());

setResultConverter(button -> {
if (button == importButton) {
viewModel.importEntries(entriesListView.getCheckModel().getCheckedItems(), downloadLinkedOnlineFiles.isSelected());
} else {
dialogService.notify(Localization.lang("Import canceled"));
}

return false;
});
}

@FXML
private void initialize() {
viewModel = new ImportEntriesViewModel(task, taskExecutor, database, dialogService, undoManager, preferences, stateManager, entryTypesManager, fileUpdateMonitor);
Label placeholder = new Label();
placeholder.textProperty().bind(viewModel.messageProperty());
entriesListView.setPlaceholder(placeholder);
entriesListView.setItems(viewModel.getEntries());

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.collectAllDatabasePaths(), 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("entry-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 = getEntryNode(entry);
HBox.setHgrow(entryNode, Priority.ALWAYS);
HBox container = new HBox(entryNode, separator, addToggle);
container.getStyleClass().add("entry-container");

BackgroundTask.wrap(() -> viewModel.hasDuplicate(entry)).onSuccess(duplicateFound -> {
if (duplicateFound) {
Button duplicateButton = IconTheme.JabRefIcons.DUPLICATE.asButton();
duplicateButton.setTooltip(new Tooltip(Localization.lang("Possible duplicate of existing entry. Click to resolve.")));
duplicateButton.setOnAction(event -> viewModel.resolveDuplicate(entry));
container.getChildren().add(1, duplicateButton);
}
}).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(entriesListView.getCheckModel().getCheckedItems()).asString());
totalItems.textProperty().bind(Bindings.size(entriesListView.getItems()).asString());
entriesListView.setSelectionModel(new NoSelectionModel<>());
initBibTeX();
}

public void setItemsForCurrentPage(int pageNumber, int itemsPerPage) {
if (entries == null) {
return;
}
int startIndex = (pageNumber - 1) * itemsPerPage;
int endIndex = Math.min(startIndex + itemsPerPage, entries.size());
ObservableList<BibEntry> pageEntries = FXCollections.observableArrayList(entries.subList(startIndex, endIndex));
entriesListView.setItems(pageEntries);
int totalPages = (int) Math.ceil((double) entries.size() / itemsPerPage);
pageLabel.setText("Page " + pageNumber + " of " + totalPages);
}

private void displayBibTeX(BibEntry entry, String bibTeX) {
if (entriesListView.getCheckModel().isChecked(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);
});
}

private Node getEntryNode(BibEntry entry) {
Node entryType = getIcon(entry.getType()).getGraphicNode();
entryType.getStyleClass().add("type");
Label authors = new Label(entry.getFieldOrAliasLatexFree(StandardField.AUTHOR).orElse(""));
authors.getStyleClass().add("authors");
Label title = new Label(entry.getFieldOrAliasLatexFree(StandardField.TITLE).orElse(""));
title.getStyleClass().add("title");
Label year = new Label(entry.getFieldOrAliasLatexFree(StandardField.YEAR).orElse(""));
year.getStyleClass().add("year");
Label journal = new Label(entry.getFieldOrAliasLatexFree(StandardField.JOURNAL).orElse(""));
journal.getStyleClass().add("journal");

VBox entryContainer = new VBox(
new HBox(10, entryType, title),
new HBox(5, year, journal),
authors
);
entry.getFieldOrAliasLatexFree(StandardField.ABSTRACT).ifPresent(summaryText -> {
TextFlowLimited summary = new TextFlowLimited(new Text(summaryText));
summary.getStyleClass().add("summary");
entryContainer.getChildren().add(summary);
});

entryContainer.getStyleClass().add("bibEntry");
return entryContainer;
}

private IconTheme.JabRefIcons getIcon(EntryType type) {
EnumSet<StandardEntryType> crossRefTypes = EnumSet.of(StandardEntryType.InBook, StandardEntryType.InProceedings, StandardEntryType.InCollection);
if (type == StandardEntryType.Book) {
return IconTheme.JabRefIcons.BOOK;
} else if (crossRefTypes.contains(type)) {
return IconTheme.JabRefIcons.OPEN_LINK;
}
return IconTheme.JabRefIcons.ARTICLE;
}

public void unselectAll() {
entriesListView.getCheckModel().clearChecks();
}

public void selectAllNewEntries() {
unselectAll();
for (BibEntry entry : entriesListView.getItems()) {
if (!viewModel.hasDuplicate(entry)) {
entriesListView.getCheckModel().check(entry);
displayBibTeX(entry, viewModel.getSourceString(entry));
}
}
}

public void selectAllEntries() {
unselectAll();
entriesListView.getCheckModel().checkAll();
}
}
Loading
Loading