Implement mass addition of bib information #12025
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,183 @@ | ||
| package org.jabref.gui.mergeentries; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Optional; | ||
| import java.util.concurrent.atomic.AtomicInteger; | ||
|
|
||
| import javax.swing.undo.UndoManager; | ||
calixtus marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| import org.jabref.gui.undo.NamedCompound; | ||
| import org.jabref.logic.importer.fetcher.MergingIdBasedFetcher; | ||
| import org.jabref.logic.l10n.Localization; | ||
| import org.jabref.logic.util.BackgroundTask; | ||
| import org.jabref.logic.util.NotificationService; | ||
| import org.jabref.model.entry.BibEntry; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * A background task that handles fetching and merging of bibliography entries. | ||
| * This implementation provides improved concurrency handling, better Optional usage, | ||
| * and more robust error handling. | ||
| */ | ||
| public class BatchEntryMergeTask extends BackgroundTask<List<String>> { | ||
|
|
||
| private static final Logger LOGGER = LoggerFactory.getLogger(BatchEntryMergeTask.class); | ||
| private final MergeContext context; | ||
| private final NamedCompound compoundEdit; | ||
| private final AtomicInteger processedEntries; | ||
| private final AtomicInteger successfulUpdates; | ||
|
|
||
| public BatchEntryMergeTask(MergeContext context) { | ||
| this.context = context; | ||
| this.compoundEdit = new NamedCompound(Localization.lang("Merge entries")); | ||
| this.processedEntries = new AtomicInteger(0); | ||
| this.successfulUpdates = new AtomicInteger(0); | ||
|
|
||
| configureTask(); | ||
| } | ||
|
|
||
| private void configureTask() { | ||
| setTitle(Localization.lang("Fetching and merging entry(s)")); | ||
calixtus marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| withInitialMessage(Localization.lang("Starting merge operation...")); | ||
| showToUser(true); | ||
| } | ||
|
|
||
| @Override | ||
| public List<String> call() throws Exception { | ||
| try { | ||
| if (isCancelled()) { | ||
| notifyCancellation(); | ||
| return List.of(); | ||
| } | ||
|
|
||
| List<String> updatedEntries = processMergeEntries(); | ||
|
|
||
| if (isCancelled()) { | ||
| notifyCancellation(); | ||
| finalizeOperation(updatedEntries); | ||
| return updatedEntries; | ||
| } | ||
|
|
||
| finalizeOperation(updatedEntries); | ||
| LOGGER.debug("Merge operation completed. Processed: {}, Successfully updated: {}", | ||
| processedEntries.get(), successfulUpdates.get()); | ||
| notifySuccess(successfulUpdates.get()); | ||
| return updatedEntries; | ||
| } catch (Exception e) { | ||
| if (isCancelled()) { | ||
| notifyCancellation(); | ||
| return List.of(); | ||
| } | ||
| LOGGER.error("Critical error during merge operation", e); | ||
| notifyError(e); | ||
| throw e; | ||
| } | ||
| } | ||
|
|
||
| private void notifyCancellation() { | ||
| LOGGER.debug("Merge operation was cancelled. Processed: {}, Successfully updated: {}", | ||
| processedEntries.get(), successfulUpdates.get()); | ||
| context.notificationService().notify( | ||
| Localization.lang("Merge operation cancelled after updating %0 entry(s)", successfulUpdates.get())); | ||
| } | ||
|
|
||
| private List<String> processMergeEntries() { | ||
| List<String> updatedEntries = new ArrayList<>(); | ||
|
|
||
| for (BibEntry entry : context.entries()) { | ||
| Optional<String> result = processSingleEntryWithProgress(entry); | ||
| result.ifPresent(updatedEntries::add); | ||
|
|
||
| if (isCancelled()) { | ||
| LOGGER.debug("Cancellation requested after processing entry {}", processedEntries.get()); | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| return updatedEntries; | ||
| } | ||
|
|
||
| private Optional<String> processSingleEntryWithProgress(BibEntry entry) { | ||
| updateProgress(processedEntries.incrementAndGet(), context.entries().size()); | ||
| updateMessage(Localization.lang("Processing entry %0 of %1", | ||
| processedEntries.get(), | ||
| context.entries().size())); | ||
| return processSingleEntry(entry); | ||
| } | ||
|
|
||
| private Optional<String> processSingleEntry(BibEntry entry) { | ||
| try { | ||
| LOGGER.debug("Processing entry: {}", entry); | ||
| return context.fetcher().fetchEntry(entry) | ||
| .filter(MergingIdBasedFetcher.FetcherResult::hasChanges) | ||
| .flatMap(result -> { | ||
| boolean changesApplied = applyMerge(entry, result); | ||
| if (changesApplied) { | ||
| successfulUpdates.incrementAndGet(); | ||
| return entry.getCitationKey(); | ||
| } | ||
| return Optional.empty(); | ||
| }); | ||
| } catch (Exception e) { | ||
| handleEntryProcessingError(entry, e); | ||
| return Optional.empty(); | ||
| } | ||
| } | ||
|
|
||
| private boolean applyMerge(BibEntry entry, MergingIdBasedFetcher.FetcherResult result) { | ||
| synchronized (compoundEdit) { | ||
calixtus marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| try { | ||
| return MergeEntriesHelper.mergeEntries(result.mergedEntry(), entry, compoundEdit); | ||
| } catch (Exception e) { | ||
|
There was a problem hiding this comment. One should not catch generic Exceptions |
||
| LOGGER.error("Error during merge operation for entry: {}", entry, e); | ||
| return false; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private void handleEntryProcessingError(BibEntry entry, Exception e) { | ||
| String citationKey = entry.getCitationKey().orElse("unknown"); | ||
| String message = Localization.lang("Error processing entry", citationKey, e.getMessage()); | ||
| LOGGER.error(message, e); | ||
| context.notificationService().notify(message); | ||
| } | ||
|
|
||
| private void finalizeOperation(List<String> updatedEntries) { | ||
| if (!updatedEntries.isEmpty()) { | ||
| synchronized (compoundEdit) { | ||
| compoundEdit.end(); | ||
| context.undoManager.addEdit(compoundEdit); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private void notifySuccess(int updateCount) { | ||
| String message = updateCount == 0 | ||
| ? Localization.lang("No updates found.") | ||
| : Localization.lang("Batch update successful. %0 entry(s) updated.", updateCount); | ||
| context.notificationService().notify(message); | ||
| } | ||
|
|
||
| private void notifyError(Exception e) { | ||
| context.notificationService().notify( | ||
| Localization.lang("Merge operation failed: %0", e.getMessage())); | ||
| } | ||
|
|
||
| /** | ||
| * Record containing all the context needed for the merge operation. | ||
| * Implements defensive copying to ensure immutability. | ||
| */ | ||
| public record MergeContext( | ||
| List<BibEntry> entries, | ||
| MergingIdBasedFetcher fetcher, | ||
| UndoManager undoManager, | ||
| NotificationService notificationService | ||
| ) { | ||
calixtus marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| public MergeContext { | ||
| entries = List.copyOf(entries); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| package org.jabref.gui.mergeentries; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| import javax.swing.undo.UndoManager; | ||
calixtus marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| 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.importer.fetcher.MergingIdBasedFetcher; | ||
| import org.jabref.logic.l10n.Localization; | ||
| import org.jabref.logic.util.NotificationService; | ||
| import org.jabref.logic.util.TaskExecutor; | ||
| import org.jabref.model.database.BibDatabaseContext; | ||
| import org.jabref.model.entry.BibEntry; | ||
|
|
||
| /** | ||
| * Handles batch merging of bibliography entries with fetched data. | ||
| */ | ||
| public class BatchEntryMergeWithFetchedDataAction extends SimpleCommand { | ||
|
|
||
| private final StateManager stateManager; | ||
| private final UndoManager undoManager; | ||
| private final GuiPreferences preferences; | ||
| private final NotificationService notificationService; | ||
| private final TaskExecutor taskExecutor; | ||
|
|
||
| public BatchEntryMergeWithFetchedDataAction(StateManager stateManager, | ||
| UndoManager undoManager, | ||
| GuiPreferences preferences, | ||
| NotificationService notificationService, | ||
| TaskExecutor taskExecutor) { | ||
| this.stateManager = stateManager; | ||
| this.undoManager = undoManager; | ||
| this.preferences = preferences; | ||
| this.notificationService = notificationService; | ||
| this.taskExecutor = taskExecutor; | ||
|
|
||
| this.executable.bind(ActionHelper.needsDatabase(stateManager)); | ||
| } | ||
|
|
||
| @Override | ||
| public void execute() { | ||
| if (stateManager.getActiveDatabase().isEmpty()) { | ||
| return; | ||
| } | ||
|
|
||
| List<BibEntry> entries = stateManager.getActiveDatabase() | ||
| .map(BibDatabaseContext::getEntries) | ||
| .orElse(List.of()); | ||
calixtus marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| if (entries.isEmpty()) { | ||
| notificationService.notify(Localization.lang("No entries available for merging")); | ||
calixtus marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return; | ||
| } | ||
|
|
||
| MergingIdBasedFetcher fetcher = new MergingIdBasedFetcher(preferences.getImportFormatPreferences()); | ||
| BatchEntryMergeTask mergeTask = new BatchEntryMergeTask( | ||
| new BatchEntryMergeTask.MergeContext(entries, | ||
| fetcher, | ||
| undoManager, | ||
| notificationService)); | ||
|
|
||
| mergeTask.executeWith(taskExecutor); | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.