Add toggle functionality for journal abbreviation lists #12912
+1,776
−212
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,11 @@ | ||
| package org.jabref.gui.journals; | ||
|
|
||
| import java.nio.file.Path; | ||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.function.Supplier; | ||
|
|
||
| import javax.swing.undo.UndoManager; | ||
|
|
@@ -12,13 +17,16 @@ | |
| import org.jabref.gui.actions.SimpleCommand; | ||
| import org.jabref.gui.actions.StandardActions; | ||
| import org.jabref.gui.undo.NamedCompound; | ||
| import org.jabref.logic.journals.Abbreviation; | ||
| import org.jabref.logic.journals.JournalAbbreviationLoader; | ||
| import org.jabref.logic.journals.JournalAbbreviationPreferences; | ||
| import org.jabref.logic.journals.JournalAbbreviationRepository; | ||
| import org.jabref.logic.l10n.Localization; | ||
| import org.jabref.logic.util.BackgroundTask; | ||
| import org.jabref.logic.util.TaskExecutor; | ||
| import org.jabref.model.database.BibDatabaseContext; | ||
| import org.jabref.model.entry.BibEntry; | ||
| import org.jabref.model.entry.field.Field; | ||
| import org.jabref.model.entry.field.FieldFactory; | ||
|
|
||
| import org.slf4j.Logger; | ||
|
|
@@ -36,7 +44,7 @@ public class AbbreviateAction extends SimpleCommand { | |
| private final DialogService dialogService; | ||
| private final StateManager stateManager; | ||
| private final JournalAbbreviationPreferences journalAbbreviationPreferences; | ||
| private JournalAbbreviationRepository abbreviationRepository; | ||
| private final TaskExecutor taskExecutor; | ||
| private final UndoManager undoManager; | ||
|
|
||
|
|
@@ -47,15 +55,13 @@ public AbbreviateAction(StandardActions action, | |
| DialogService dialogService, | ||
| StateManager stateManager, | ||
| JournalAbbreviationPreferences abbreviationPreferences, | ||
| TaskExecutor taskExecutor, | ||
| UndoManager undoManager) { | ||
| this.action = action; | ||
| this.tabSupplier = tabSupplier; | ||
| this.dialogService = dialogService; | ||
| this.stateManager = stateManager; | ||
| this.journalAbbreviationPreferences = abbreviationPreferences; | ||
| this.taskExecutor = taskExecutor; | ||
| this.undoManager = undoManager; | ||
|
|
||
|
|
@@ -77,6 +83,11 @@ public AbbreviateAction(StandardActions action, | |
|
|
||
| @Override | ||
| public void execute() { | ||
| if (action == StandardActions.UNABBREVIATE && !areAnyJournalSourcesEnabled()) { | ||
zikunz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| dialogService.notify(Localization.lang("Cannot unabbreviate: all journal lists are disabled.")); | ||
| return; | ||
| } | ||
|
|
||
| if ((action == StandardActions.ABBREVIATE_DEFAULT) | ||
| || (action == StandardActions.ABBREVIATE_DOTLESS) | ||
| || (action == StandardActions.ABBREVIATE_SHORTEST_UNIQUE) | ||
|
|
@@ -98,6 +109,9 @@ public void execute() { | |
| } | ||
|
|
||
| private String abbreviate(BibDatabaseContext databaseContext, List<BibEntry> entries) { | ||
| // Reload repository to ensure latest preferences are used | ||
| abbreviationRepository = JournalAbbreviationLoader.loadRepository(journalAbbreviationPreferences); | ||
|
|
||
| UndoableAbbreviator undoableAbbreviator = new UndoableAbbreviator( | ||
| abbreviationRepository, | ||
| abbreviationType, | ||
|
|
@@ -119,13 +133,77 @@ private String abbreviate(BibDatabaseContext databaseContext, List<BibEntry> ent | |
| return Localization.lang("Abbreviated %0 journal names.", String.valueOf(count)); | ||
| } | ||
|
|
||
| /** | ||
| * Unabbreviate journal names in entries, respecting the enabled/disabled state of sources. | ||
| * Only unabbreviates entries from enabled sources. | ||
| */ | ||
| private String unabbreviate(BibDatabaseContext databaseContext, List<BibEntry> entries) { | ||
| List<BibEntry> filteredEntries = new ArrayList<>(); | ||
zikunz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| JournalAbbreviationRepository freshRepository = JournalAbbreviationLoader.loadRepository(journalAbbreviationPreferences); | ||
|
There was a problem hiding this comment. We also had a question about this here - do you wish to create a new repository every time you want to call unabbreviate? There was a problem hiding this comment. I will resolve this conversation after I get approval for the latest approach stated in #12912 (comment) and #12912 (comment). :) |
||
|
|
||
| Map<String, Boolean> sourceEnabledStates = new HashMap<>(); | ||
|
There was a problem hiding this comment. Why do you collect a There was a problem hiding this comment. Oh yes, |
||
| String builtInId = JournalAbbreviationRepository.BUILTIN_LIST_ID; | ||
| sourceEnabledStates.put(builtInId, journalAbbreviationPreferences.isSourceEnabled(builtInId)); | ||
|
|
||
| for (String listPath : journalAbbreviationPreferences.getExternalJournalLists()) { | ||
| if (listPath != null && !listPath.isBlank()) { | ||
| String fileName = Path.of(listPath).getFileName().toString(); | ||
| sourceEnabledStates.put(fileName, journalAbbreviationPreferences.isSourceEnabled(fileName)); | ||
| } | ||
| } | ||
|
|
||
| var allAbbreviationsWithSources = freshRepository.getAllAbbreviationsWithSources(); | ||
| Map<String, List<JournalAbbreviationRepository.AbbreviationWithSource>> textToSourceMap = new HashMap<>(); | ||
InAnYan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| for (var abbrWithSource : allAbbreviationsWithSources) { | ||
| Abbreviation abbr = abbrWithSource.getAbbreviation(); | ||
| addToMap(textToSourceMap, abbr.getName(), abbrWithSource); | ||
| addToMap(textToSourceMap, abbr.getAbbreviation(), abbrWithSource); | ||
| addToMap(textToSourceMap, abbr.getDotlessAbbreviation(), abbrWithSource); | ||
| addToMap(textToSourceMap, abbr.getShortestUniqueAbbreviation(), abbrWithSource); | ||
| } | ||
|
|
||
| for (BibEntry entry : entries) { | ||
| boolean includeEntry = true; | ||
|
|
||
| for (Field journalField : FieldFactory.getJournalNameFields()) { | ||
| if (!entry.hasField(journalField)) { | ||
| continue; | ||
| } | ||
|
|
||
| String text = entry.getFieldLatexFree(journalField).orElse(""); | ||
| List<JournalAbbreviationRepository.AbbreviationWithSource> possibleSources = | ||
| textToSourceMap.getOrDefault(text, Collections.emptyList()); | ||
zikunz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| if (!possibleSources.isEmpty()) { | ||
| boolean allSourcesDisabled = true; | ||
| for (var abbrWithSource : possibleSources) { | ||
| String source = abbrWithSource.getSource(); | ||
| if (sourceEnabledStates.getOrDefault(source, true)) { | ||
| allSourcesDisabled = false; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| if (allSourcesDisabled) { | ||
| includeEntry = false; | ||
| break; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (includeEntry) { | ||
| filteredEntries.add(entry); | ||
| } | ||
| } | ||
|
|
||
| UndoableUnabbreviator undoableAbbreviator = new UndoableUnabbreviator(freshRepository); | ||
| NamedCompound ce = new NamedCompound(Localization.lang("Unabbreviate journal names")); | ||
| int count = filteredEntries.stream().mapToInt(entry -> | ||
| (int) FieldFactory.getJournalNameFields().stream().filter(journalField -> | ||
| undoableAbbreviator.unabbreviate(databaseContext.getDatabase(), entry, journalField, ce)).count()).sum(); | ||
|
|
||
| if (count == 0) { | ||
| return Localization.lang("No journal names could be unabbreviated."); | ||
| } | ||
|
|
@@ -135,4 +213,46 @@ private String unabbreviate(BibDatabaseContext databaseContext, List<BibEntry> e | |
| tabSupplier.get().markBaseChanged(); | ||
| return Localization.lang("Unabbreviated %0 journal names.", String.valueOf(count)); | ||
| } | ||
|
|
||
| /** | ||
| * Helper method to add an abbreviation to the text-to-source map | ||
| * | ||
| * @param map The map to add to | ||
| * @param text The text to use as key | ||
| * @param abbrWithSource The abbreviation with source to add | ||
| */ | ||
| private void addToMap(Map<String, List<JournalAbbreviationRepository.AbbreviationWithSource>> map, | ||
| String text, | ||
| JournalAbbreviationRepository.AbbreviationWithSource abbrWithSource) { | ||
| if (text == null || text.isBlank()) { | ||
zikunz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return; | ||
| } | ||
|
|
||
| map.computeIfAbsent(text, k -> new ArrayList<>()).add(abbrWithSource); | ||
| } | ||
|
|
||
| /** | ||
| * Checks if any journal abbreviation source is enabled in the preferences. | ||
| * This includes both the built-in list and any external journal lists. | ||
| * | ||
| * @return true if at least one source is enabled, false if all sources are disabled | ||
| */ | ||
| private boolean areAnyJournalSourcesEnabled() { | ||
InAnYan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| boolean anySourceEnabled = journalAbbreviationPreferences.isSourceEnabled(JournalAbbreviationRepository.BUILTIN_LIST_ID); | ||
|
|
||
| if (!anySourceEnabled) { | ||
| for (String listPath : journalAbbreviationPreferences.getExternalJournalLists()) { | ||
| if (listPath != null && !listPath.isBlank()) { | ||
| // Just check the filename since that's what's used as the source key | ||
| String fileName = Path.of(listPath).getFileName().toString(); | ||
| if (journalAbbreviationPreferences.isSourceEnabled(fileName)) { | ||
| anySourceEnabled = true; | ||
| break; | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return anySourceEnabled; | ||
| } | ||
| } | ||
|
There was a problem hiding this comment. I've seen that you removed line https://github.com/JabRef/jabref/pull/12912/files#diff-3fa252360fc27ea81a62af5e94c9a8263b2519ca8845cd50c55d0a001f334e41L123 -- is this class still used anywhere? There was a problem hiding this comment. Yes, but this class is still being used. I have simplified the filtering logic to determine which entries to process, but the actual unabbreviation is still performed by UndoableUnabbreviator undoableAbbreviator = new UndoableUnabbreviator(freshRepository);
NamedCompound ce = new NamedCompound(Localization.lang("Unabbreviate journal names"));
int count = filteredEntries.stream().mapToInt(entry ->
(int) FieldFactory.getJournalNameFields().stream().filter(journalField ->
undoableAbbreviator.unabbreviate(databaseContext.getDatabase(), entry, journalField, ce)).count()).sum();There are also tests that verify its functionality. This class is responsible for the actual unabbreviation and undo operations, while my changes simplified how we determine which entries to process. The class is still essential for the functionality to work correctly. May I ask whether this sounds right? |
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
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.