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.

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

Implement mass addition of bib information (Closes #372) #12025

Draft
wants to merge 46 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
887dd35
feat: enhance right-click context menu with new actions (extract refe…
KUMOAWAI Oct 19, 2024
656facf
fix: Restore MERGE_WITH_FETCHED_ENTRY and add BATCH_MERGE_WITH_FETCHE…
KUMOAWAI Oct 19, 2024
0409856
Refactor and optimize FetchAndMergeEntry class
KUMOAWAI Oct 19, 2024
489b512
Merge branch 'JabRef:main' into fix-for-issue-#372
KUMOAWAI Oct 19, 2024
dc138ce
Updated CHANGELOG.md
KUMOAWAI Oct 19, 2024
0532df4
Added a period at the end of the description in CHANGELOG.md.
KUMOAWAI Oct 19, 2024
012dd9a
Updated JabRef_en.properties
KUMOAWAI Oct 19, 2024
f8267ac
Move and rename "Mass Getting bibliographic data" action
KUMOAWAI Oct 20, 2024
74f2473
Refactor FetchAndMergeEntry class for improved functionality and read…
KUMOAWAI Oct 20, 2024
29759a6
Merge branch 'main' into fix-for-issue-#372
koppor Oct 20, 2024
37cfeae
Refactor entry fetching and merging process
KUMOAWAI Oct 20, 2024
77e0d51
Updated CHANGELOG.md
KUMOAWAI Oct 20, 2024
e6f0ad2
Merge branch 'main' into fix-for-issue-#372
KUMOAWAI Oct 20, 2024
c5b7b4c
refactor: Separate UI and core logic in entry merging system
KUMOAWAI Oct 25, 2024
5b829b1
Merge remote-tracking branch 'upstream/fix-for-issue-#372' into fix-f…
KUMOAWAI Oct 25, 2024
350502e
Merge branch 'main' into fix-for-issue-#372
KUMOAWAI Oct 25, 2024
fe46c0c
Refactored updateFieldIfNecessaryWithUndo method in MergeEntriesHelpe…
KUMOAWAI Oct 25, 2024
8eac6a9
Merge remote-tracking branch 'upstream/fix-for-issue-#372' into fix-f…
KUMOAWAI Oct 25, 2024
5d54083
refactor: Replace String.format with string concatenation in MergingI…
KUMOAWAI Oct 25, 2024
93072cf
refactor: Fixed incorrect placeholder in updateProgress Method
KUMOAWAI Oct 25, 2024
262d25d
Updated JabRef_en.properties to fix the failing LocalizationConsisten…
KUMOAWAI Oct 25, 2024
4667124
Merge branch 'main' into fix-for-issue-#372
KUMOAWAI Oct 26, 2024
ae4df14
refactor: optimize BibEntry merging and fetching logic:
KUMOAWAI Oct 26, 2024
5ed3d70
Roll Back: FetchAndMergeEntry.java and MergeWithFetchedEntryAction.java.
KUMOAWAI Oct 27, 2024
74a6285
Merge branch 'main' into fix-for-issue-#372
koppor Oct 27, 2024
8d9bdce
Refactor: improve MergingIdBasedFetcher, BatchEntryMergeWithFetchedD…
KUMOAWAI Oct 27, 2024
95e9ae8
Fixed the minor import format issue.
KUMOAWAI Oct 27, 2024
9fdbbb4
Merge remote-tracking branch 'upstream/fix-for-issue-#372' into fix-f…
KUMOAWAI Oct 27, 2024
ce1ea3e
Merge branch 'main' into fix-for-issue-#372
KUMOAWAI Oct 27, 2024
7305f3c
Apply suggestions from code review
KUMOAWAI Oct 27, 2024
9dce81a
Refactor: Reorder parameters to (fetcher, library) in merge operations
KUMOAWAI Oct 27, 2024
5f24815
Merge branch 'main' into fix-for-issue-#372
KUMOAWAI Oct 27, 2024
d17fd88
Merge branch 'main' into fix-for-issue-#372
KUMOAWAI Oct 30, 2024
61f5a8f
Refactor: Deleted the empty line before package
KUMOAWAI Oct 31, 2024
86051ac
Merge branch 'main' into fix-for-issue-#372
KUMOAWAI Oct 31, 2024
198f2d0
Merge branch 'main' into fix-for-issue-#372
KUMOAWAI Oct 31, 2024
ace1975
Merge branch 'main' into fix-for-issue-#372
KUMOAWAI Nov 13, 2024
74681e1
Refactor: Deleted the empty line before package
KUMOAWAI Nov 16, 2024
3197ef4
refactor: Extract background processing into BatchEntryMergeTask, opt…
KUMOAWAI Nov 16, 2024
c04a2fa
Updated JabRef_en.properties
KUMOAWAI Nov 16, 2024
d2566db
Merge branch 'main' into fix-for-issue-#372
KUMOAWAI Nov 17, 2024
4d1b88d
Apply suggestions from code review
KUMOAWAI Nov 17, 2024
e8645a2
Modify log messages correspondingly.
KUMOAWAI Nov 17, 2024
ac8c59d
Refactor: Move string normalization from StringNormalizer to StringUtil
KUMOAWAI Nov 17, 2024
5172bc2
Merge branch 'main' into fix-for-issue-#372
KUMOAWAI Nov 18, 2024
05b3c42
Merge branch 'main' into fix-for-issue-#372
KUMOAWAI Dec 5, 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 CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
- We added automatic browser extension install on Windows for Chrome and Edge. [#6076](https://github.com/JabRef/jabref/issues/6076)
- We added a search bar for filtering keyboard shortcuts. [#11686](https://github.com/JabRef/jabref/issues/11686)
- By double clicking on a local citation in the Citation Relations Tab you can now jump the linked entry. [#11955](https://github.com/JabRef/jabref/pull/11955)
- Added functionality for mass addition of bibliographic information for multiple entries. [#372](https://github.com/JabRef/jabref/issues/372)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add where you added it.

It really needs to be in the "Lookup" menu.

image

We want to keep the right click menu small.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Added functionality for mass addition of bibliographic information for multiple entries. [#372](https://github.com/JabRef/jabref/issues/372)
- Added functionality for mass addition of bibliographic information for multiple entries to the "Lookup" menu. [#372](https://github.com/JabRef/jabref/issues/372)


### Changed

Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/jabref/gui/actions/StandardActions.java
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ public enum StandardActions implements Action {
OPEN_URL(Localization.lang("Open URL or DOI"), IconTheme.JabRefIcons.WWW, KeyBinding.OPEN_URL_OR_DOI),
SEARCH_SHORTSCIENCE(Localization.lang("Search ShortScience")),
MERGE_WITH_FETCHED_ENTRY(Localization.lang("Get bibliographic data from %0", "DOI/ISBN/...")),
MASS_GET_BIBLIOGRAPHIC_DATA(Localization.lang("Get bibliographic data from %0 (fully automated)", "DOI/ISBN/...")),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe rename MASS_GET_BIBLIOGRAPHIC_DATA to MULTI_MERGE_WITH_FETCHED_ENTRY - to be (somehow) in line with the label and the other code. -- consistent terms from user to code.

ATTACH_FILE(Localization.lang("Attach file"), IconTheme.JabRefIcons.ATTACH_FILE),
ATTACH_FILE_FROM_URL(Localization.lang("Attach file from URL"), IconTheme.JabRefIcons.DOWNLOAD_FILE),
PRIORITY(Localization.lang("Priority"), IconTheme.JabRefIcons.PRIORITY),
Expand Down
18 changes: 17 additions & 1 deletion src/main/java/org/jabref/gui/frame/MainMenu.java
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
import org.jabref.gui.maintable.NewLibraryFromPdfActionOffline;
import org.jabref.gui.maintable.NewLibraryFromPdfActionOnline;
import org.jabref.gui.mergeentries.MergeEntriesAction;
import org.jabref.gui.mergeentries.MultiEntryMergeWithFetchedDataAction;
import org.jabref.gui.plaincitationparser.PlainCitationParserAction;
import org.jabref.gui.preferences.GuiPreferences;
import org.jabref.gui.preferences.ShowPreferencesAction;
Expand Down Expand Up @@ -273,7 +274,22 @@ private void createMenu() {

new SeparatorMenuItem(),

factory.createMenuItem(StandardActions.FIND_UNLINKED_FILES, new FindUnlinkedFilesAction(dialogService, stateManager))
factory.createMenuItem(StandardActions.FIND_UNLINKED_FILES, new FindUnlinkedFilesAction(dialogService, stateManager)),

new SeparatorMenuItem(),

// Adding new menu item for mass bibliographic data fetching
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not useful comment. Remove it.

factory.createMenuItem(
StandardActions.MASS_GET_BIBLIOGRAPHIC_DATA,
new MultiEntryMergeWithFetchedDataAction(
frame::getCurrentLibraryTab,
preferences,
taskExecutor,
dialogService,
undoManager,
stateManager
)
)
);

final MenuItem pushToApplicationMenuItem = factory.createMenuItem(pushToApplicationCommand.getAction(), pushToApplicationCommand);
Expand Down
289 changes: 194 additions & 95 deletions src/main/java/org/jabref/gui/mergeentries/FetchAndMergeEntry.java

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public MergeWithFetchedEntryAction(DialogService dialogService,
this.undoManager = undoManager;

this.executable.bind(ActionHelper.needsEntriesSelected(1, stateManager)
.and(ActionHelper.isAnyFieldSetForSelectedEntry(FetchAndMergeEntry.SUPPORTED_FIELDS, stateManager)));
.and(ActionHelper.isAnyFieldSetForSelectedEntry(FetchAndMergeEntry.SUPPORTED_IDENTIFIER_FIELDS, stateManager)));
}

@Override
Expand All @@ -49,6 +49,14 @@ public void execute() {
}

BibEntry originalEntry = stateManager.getSelectedEntries().getFirst();
new FetchAndMergeEntry(stateManager.getActiveDatabase().get(), taskExecutor, preferences, dialogService, undoManager).fetchAndMerge(originalEntry);
FetchAndMergeEntry fetchAndMergeEntry = new FetchAndMergeEntry(
stateManager.getActiveDatabase().get(),
taskExecutor,
preferences,
dialogService,
undoManager
);

fetchAndMergeEntry.fetchAndMerge(originalEntry);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
package org.jabref.gui.mergeentries;

import java.util.List;
import java.util.function.Supplier;

import javax.swing.undo.UndoManager;

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.preferences.GuiPreferences;
import org.jabref.logic.util.TaskExecutor;
import org.jabref.model.database.BibDatabaseContext;
import org.jabref.model.entry.BibEntry;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
* Action for merging multiple entries with fetched data from identifiers like DOI or arXiv.
*/
public class MultiEntryMergeWithFetchedDataAction extends SimpleCommand {

private static final Logger LOGGER = LoggerFactory.getLogger(MultiEntryMergeWithFetchedDataAction.class);

private final Supplier<LibraryTab> tabSupplier;
private final GuiPreferences preferences;
private final TaskExecutor taskExecutor;
private final DialogService dialogService;
private final UndoManager undoManager;

public MultiEntryMergeWithFetchedDataAction(Supplier<LibraryTab> tabSupplier,
GuiPreferences preferences,
TaskExecutor taskExecutor,
DialogService dialogService,
UndoManager undoManager,
StateManager stateManager) {
this.tabSupplier = tabSupplier;
this.preferences = preferences;
this.taskExecutor = taskExecutor;
this.dialogService = dialogService;
this.undoManager = undoManager;

// Binding to only execute if a database is open
this.executable.bind(ActionHelper.needsDatabase(stateManager));
}

@Override
public void execute() {
LibraryTab libraryTab = tabSupplier.get();

// Ensure that libraryTab is present
if (libraryTab == null) {
LOGGER.error("Action 'Multi Entry Merge' must be disabled when no database is open.");
return;
}

List<BibEntry> selectedEntries = libraryTab.getDatabase().getEntries();

// If no entries are selected, log and do not execute
if (selectedEntries.isEmpty()) {
dialogService.notify("No entries selected for merging.");
return;
}

// Create an instance of FetchAndMergeEntry to perform the batch fetch and merge operation
BibDatabaseContext bibDatabaseContext = libraryTab.getBibDatabaseContext();
FetchAndMergeEntry fetchAndMergeEntry = new FetchAndMergeEntry(bibDatabaseContext, taskExecutor, preferences, dialogService, undoManager);

fetchAndMergeEntry.fetchAndMergeBatch(selectedEntries);
}
}
4 changes: 4 additions & 0 deletions src/main/resources/l10n/JabRef_en.properties
Original file line number Diff line number Diff line change
Expand Up @@ -1679,6 +1679,10 @@ No\ %0\ found=No %0 found
Entry\ from\ %0=Entry from %0
Merge\ entry\ with\ %0\ information=Merge entry with %0 information
Updated\ entry\ with\ info\ from\ %0=Updated entry with info from %0
Mass\ getting\ bibliographic\ data\ from\ %0=Mass getting bibliographic data from %0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think, this string should get obsoelete

Merge\ entry\ without\ user\ interaction=Merge entry without user interaction
No\ new\ information\ was\ added=No new information was added
Updated\ entry\ with\ fetched\ information=Updated entry with fetched information

Add\ new\ list=Add new list
Open\ existing\ list=Open existing list
Expand Down
Loading