Change copy-paste function to handle string constants (follow up PR)

CHANGELOG.md

@@ -30,6 +30,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We added the ability to zoom in and out in the document viewer using <kbd>Ctrl</kbd> + <kbd>Scroll</kbd>. [#10964](https://github.com/JabRef/jabref/pull/10964)
 - We added a Cleanup for removing non-existent files and grouped the related options [#10929](https://github.com/JabRef/jabref/issues/10929)
 - We added the functionality to parse the bibliography of PDFs using the GROBID online service. [#10200](https://github.com/JabRef/jabref/issues/10200)
+- We added support for BibTeX String constants during copy & paste between libraries [#10872](https://github.com/JabRef/jabref/issues/10872)
 
 ### Changed
 
@@ -47,6 +48,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We enhanced the dialog for adding new fields in the content selector with a selection box containing a list of standard fields. [#10912](https://github.com/JabRef/jabref/pull/10912)
 - We store the citation relations in an LRU cache to avoid bloating the memory and out-of-memory exceptions. [#10958](https://github.com/JabRef/jabref/issues/10958)
 - Keywords filed are now displayed as tags. [#10910](https://github.com/JabRef/jabref/pull/10910)
+- When pasting, string constants are automatically added to the library database, while referenced constants are added to the clipboard during copying. [#10872](https://github.com/JabRef/jabref/issues/10872)
 
 ### Fixed
 

src/main/java/org/jabref/gui/ClipBoardManager.java

@@ -21,6 +21,7 @@
 import org.jabref.model.database.BibDatabaseMode;
 import org.jabref.model.entry.BibEntry;
 import org.jabref.model.entry.BibEntryTypesManager;
+import org.jabref.model.entry.BibtexString;
 import org.jabref.preferences.PreferencesService;
 
 import org.slf4j.Logger;
@@ -155,14 +156,23 @@ public void setContent(String string) {
     }
 
     public void setContent(List<BibEntry> entries, BibEntryTypesManager entryTypesManager) throws IOException {
-        final ClipboardContent content = new ClipboardContent();
-        BibEntryWriter writer = new BibEntryWriter(new FieldWriter(preferencesService.getFieldPreferences()), entryTypesManager);
-        String serializedEntries = writer.serializeAll(entries, BibDatabaseMode.BIBTEX);
+        String serializedEntries = serializeEntries(entries, entryTypesManager);
+        setContent(serializedEntries);
+    }
+
+    public void setContent(List<BibEntry> entries, BibEntryTypesManager entryTypesManager, List<BibtexString> stringConstants) throws IOException {
+        StringBuilder builder = new StringBuilder();
+        stringConstants.forEach(strConst -> builder.append(strConst.getParsedSerialization() == null ? "" : strConst.getParsedSerialization()));
+        String serializedEntries = serializeEntries(entries, entryTypesManager);
+        builder.append(serializedEntries);
+        setContent(builder.toString());
+    }
+
+    private String serializeEntries(List<BibEntry> entries, BibEntryTypesManager entryTypesManager) throws IOException {
         // BibEntry is not Java serializable. Thus, we need to do the serialization manually
         // At reading of the clipboard in JabRef, we parse the plain string in all cases, so we don't need to flag we put BibEntries here
         // Furthermore, storing a string also enables other applications to work with the data
-        content.putString(serializedEntries);
-        clipboard.setContent(content);
-        setPrimaryClipboardContent(content);
+        BibEntryWriter writer = new BibEntryWriter(new FieldWriter(preferencesService.getFieldPreferences()), entryTypesManager);
+        return writer.serializeAll(entries, BibDatabaseMode.BIBTEX);
     }
 }

src/main/java/org/jabref/gui/externalfiles/ImportHandler.java

@@ -18,6 +18,7 @@
 import org.jabref.gui.StateManager;
 import org.jabref.gui.duplicationFinder.DuplicateResolverDialog;
 import org.jabref.gui.fieldeditors.LinkedFileViewModel;
+import org.jabref.gui.libraryproperties.constants.ConstantsItemModel;
 import org.jabref.gui.undo.UndoableInsertEntries;
 import org.jabref.gui.util.BackgroundTask;
 import org.jabref.gui.util.DefaultTaskExecutor;
@@ -40,7 +41,9 @@
 import org.jabref.logic.util.io.FileUtil;
 import org.jabref.model.FieldChange;
 import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.model.database.KeyCollisionException;
 import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.BibtexString;
 import org.jabref.model.entry.LinkedFile;
 import org.jabref.model.entry.field.StandardField;
 import org.jabref.model.entry.identifier.ArXivIdentifier;
@@ -311,13 +314,36 @@ private void generateKeys(List<BibEntry> entries) {
     public List<BibEntry> handleBibTeXData(String entries) {
         BibtexParser parser = new BibtexParser(preferencesService.getImportFormatPreferences(), fileUpdateMonitor);
         try {
-            return parser.parseEntries(new ByteArrayInputStream(entries.getBytes(StandardCharsets.UTF_8)));
+            List<BibEntry> result = parser.parseEntries(new ByteArrayInputStream(entries.getBytes(StandardCharsets.UTF_8)));
+            List<BibtexString> stringConstants = parser.getStringValues();
+            importStringConstantsWithDuplicateCheck(stringConstants);
+            return result;
         } catch (ParseException ex) {
             LOGGER.error("Could not paste", ex);
             return Collections.emptyList();
         }
     }
 
+    public void importStringConstantsWithDuplicateCheck(List<BibtexString> stringConstants) {
+        List<String> failures = new ArrayList<>();
+
+        for (BibtexString stringConstantToAdd : stringConstants) {
+            try {
+                ConstantsItemModel checker = new ConstantsItemModel(stringConstantToAdd.getName(), stringConstantToAdd.getContent());
+                if (checker.combinedValidationValidProperty().get()) {
+                    bibDatabaseContext.getDatabase().addString(stringConstantToAdd);
+                } else {
+                    failures.add(Localization.lang("String constant \"%0\" was not imported because it is not a valid string constant", stringConstantToAdd.getName()));
+                }
+            } catch (KeyCollisionException ex) {
+                failures.add(Localization.lang("String constant %0 was not imported because it already exists in this library", stringConstantToAdd.getName()));
+            }
+        }
+        if (!failures.isEmpty()) {
+            dialogService.showWarningDialogAndWait(Localization.lang("Importing String constants"), Localization.lang("Could not import the following string constants:\n %0", String.join("\n", failures)));
+        }
+    }
+
     public List<BibEntry> handleStringData(String data) throws FetcherException {
         if ((data == null) || data.isEmpty()) {
             return Collections.emptyList();
@@ -356,7 +382,7 @@ private List<BibEntry> tryImportFormats(String data) {
     }
 
     private List<BibEntry> fetchByDOI(DOI doi) throws FetcherException {
-        LOGGER.info("Found DOI identifer in clipboard");
+        LOGGER.info("Found DOI identifier in clipboard");
         Optional<BibEntry> entry = new DoiFetcher(preferencesService.getImportFormatPreferences()).performSearchById(doi.getDOI());
         return OptionalUtil.toList(entry);
     }

src/main/java/org/jabref/gui/libraryproperties/constants/ConstantsPropertiesViewModel.java

@@ -1,9 +1,9 @@
 package org.jabref.gui.libraryproperties.constants;
 
 import java.util.Comparator;
+import java.util.List;
 import java.util.Locale;
 import java.util.Optional;
-import java.util.stream.Collectors;
 
 import javafx.beans.property.BooleanProperty;
 import javafx.beans.property.ListProperty;
@@ -18,6 +18,7 @@
 import org.jabref.gui.libraryproperties.PropertiesTabViewModel;
 import org.jabref.logic.bibtex.comparator.BibtexStringComparator;
 import org.jabref.logic.help.HelpFile;
+import org.jabref.logic.util.OS;
 import org.jabref.model.database.BibDatabaseContext;
 import org.jabref.model.entry.BibtexString;
 import org.jabref.preferences.FilePreferences;
@@ -86,9 +87,12 @@ private ConstantsItemModel convertFromBibTexString(BibtexString bibtexString) {
 
     @Override
     public void storeSettings() {
-        databaseContext.getDatabase().setStrings(stringsListProperty.stream()
-                                                                    .map(this::fromBibtexStringViewModel)
-                                                                    .collect(Collectors.toList()));
+        List<BibtexString> strings = stringsListProperty.stream()
+                                                        .map(this::fromBibtexStringViewModel)
+                                                        .toList();
+        strings.forEach(string -> string.setParsedSerialization("@String{" +
+                string.getName() + " = " + string.getContent() + "}" + OS.NEWLINE));
+        databaseContext.getDatabase().setStrings(strings);
     }
 
     private BibtexString fromBibtexStringViewModel(ConstantsItemModel viewModel) {

src/main/java/org/jabref/gui/maintable/MainTable.java

@@ -51,6 +51,7 @@
 import org.jabref.model.database.event.EntriesAddedEvent;
 import org.jabref.model.entry.BibEntry;
 import org.jabref.model.entry.BibEntryTypesManager;
+import org.jabref.model.entry.BibtexString;
 import org.jabref.model.util.FileUpdateMonitor;
 import org.jabref.preferences.PreferencesService;
 
@@ -257,8 +258,13 @@ public void copy() {
         List<BibEntry> selectedEntries = getSelectedEntries();
 
         if (!selectedEntries.isEmpty()) {
+            List<BibtexString> stringConstants = getUsedStringValues(selectedEntries);
             try {
-                clipBoardManager.setContent(selectedEntries, entryTypesManager);
+                if (!stringConstants.isEmpty()) {
+                    clipBoardManager.setContent(selectedEntries, entryTypesManager, stringConstants);
+                } else {
+                    clipBoardManager.setContent(selectedEntries, entryTypesManager);
+                }
                 dialogService.notify(Localization.lang("Copied %0 entry(ies)", selectedEntries.size()));
             } catch (IOException e) {
                 LOGGER.error("Error while copying selected entries to clipboard.", e);
@@ -489,4 +495,8 @@ private Optional<BibEntryTableViewModel> findEntry(BibEntry entry) {
                     .filter(viewModel -> viewModel.getEntry().equals(entry))
                     .findFirst();
     }
+
+    private List<BibtexString> getUsedStringValues(List<BibEntry> entries) {
+        return database.getDatabase().getUsedStrings(entries).stream().toList();
+    }
 }

src/main/java/org/jabref/logic/importer/fileformat/BibtexParser.java

@@ -144,6 +144,10 @@ public List<BibEntry> parseEntries(InputStream inputStream) throws ParseExceptio
         }
     }
 
+    public List<BibtexString> getStringValues() {
+        return database.getStringValues().stream().toList();
+    }
+
     public Optional<BibEntry> parseSingleEntry(String bibtexString) throws ParseException {
         return parseEntries(bibtexString).stream().findFirst();
     }

src/main/java/org/jabref/model/entry/BibtexString.java

@@ -158,6 +158,9 @@ public String getUserComments() {
     public Object clone() {
         BibtexString clone = new BibtexString(name, content);
         clone.setId(id);
+        if (parsedSerialization != null) {
+            clone.setParsedSerialization(parsedSerialization);
+        }
 
         return clone;
     }

src/main/resources/l10n/JabRef_en.properties

@@ -2646,3 +2646,9 @@ Source\ URL=Source URL
 Redownload\ file=Redownload file
 Redownload\ missing\ files=Redownload missing files
 Redownload\ missing\ files\ for\ current\ library?=Redownload missing files for current library?
+
+String\ constant\ "%0"\ was\ not\ imported\ because\ it\ is\ not\ a\ valid\ string\ constant=String constant "%0" was not imported because it is not a valid string constant
+String\ constant\ %0\ was\ not\ imported\ because\ it\ already\ exists\ in\ this\ library=String constant %0 was not imported because it already exists in this library
+Could\ not\ import\ the\ following\ string\ constants\:\n\ %0=Could not import the following string constants:\n %0
+Importing\ String\ constants=Importing String constants
+

src/test/java/org/jabref/gui/ClipBoardManagerTest.java

@@ -0,0 +1,128 @@
+package org.jabref.gui;
+
+import java.awt.Toolkit;
+import java.awt.datatransfer.StringSelection;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+
+import javafx.collections.FXCollections;
+import javafx.collections.ObservableList;
+import javafx.scene.input.Clipboard;
+
+import org.jabref.architecture.AllowedToUseAwt;
+import org.jabref.logic.bibtex.FieldPreferences;
+import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.BibEntryTypesManager;
+import org.jabref.model.entry.BibtexString;
+import org.jabref.model.entry.field.Field;
+import org.jabref.model.entry.field.StandardField;
+import org.jabref.model.entry.types.StandardEntryType;
+import org.jabref.preferences.PreferencesService;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+@AllowedToUseAwt("Requires AWT for clipboard access")
+public class ClipBoardManagerTest {
+
+    private BibEntryTypesManager entryTypesManager;
+    private ClipBoardManager clipBoardManager;
+
+    @BeforeEach
+    void setUp() {
+        // create preference service mock
+        PreferencesService preferencesService = mock(PreferencesService.class);
+        FieldPreferences fieldPreferences = mock(FieldPreferences.class);
+        List<Field> fields = List.of(StandardField.URL);
+        ObservableList<Field> nonWrappableFields = FXCollections.observableArrayList(fields);
+        // set up mock behaviours for preferences service
+        when(fieldPreferences.getNonWrappableFields()).thenReturn(nonWrappableFields);
+        when(preferencesService.getFieldPreferences()).thenReturn(fieldPreferences);
+
+        // create mock clipboard
+        Clipboard clipboard = mock(Clipboard.class);
+        // create primary clipboard and set a temporary value
+        StringSelection selection = new StringSelection("test");
+        java.awt.datatransfer.Clipboard clipboardPrimary = Toolkit.getDefaultToolkit().getSystemClipboard();
+        clipboardPrimary.setContents(selection, selection);
+
+        // create mock entry manager and set up behaviour for mock
+        entryTypesManager = new BibEntryTypesManager();
+
+        // initialize a clipBoardManager
+        clipBoardManager = new ClipBoardManager(clipboard, clipboardPrimary, preferencesService);
+    }
+
+    @DisplayName("Check that the ClipBoardManager can set a bibentry as its content from the clipboard")
+    @Test
+    void copyStringBibEntry() throws IOException {
+        // Arrange
+        String expected = "@Article{,\n author = {Claudepierre, S. G.},\n journal = {IEEE},\n}";
+
+        // create BibEntry
+        BibEntry bibEntry = new BibEntry();
+        // construct an entry
+        bibEntry.setType(StandardEntryType.Article);
+        bibEntry.setField(StandardField.JOURNAL, "IEEE");
+        bibEntry.setField(StandardField.AUTHOR, "Claudepierre, S. G.");
+        // add entry to list
+        List<BibEntry> bibEntries = new ArrayList<>();
+        bibEntries.add(bibEntry);
+
+        // Act
+        clipBoardManager.setContent(bibEntries, entryTypesManager);
+
+        // Assert
+        String actual = ClipBoardManager.getContentsPrimary();
+        // clean strings
+        actual = actual.replaceAll("\\s+", " ").trim();
+        expected = expected.replaceAll("\\s+", " ").trim();
+
+        assertEquals(expected, actual);
+    }
+
+    @Test
+    @DisplayName("Check that the ClipBoardManager can handle a bibentry with string constants correctly from the clipboard")
+    void copyStringBibEntryWithStringConstants() throws IOException {
+        // Arrange
+        String expected = "@String{grl = \"Geophys. Res. Lett.\"}@Article{,\n" + " author = {Claudepierre, S. G.},\n" +
+                " journal = {grl},\n" + "}";
+        // create BibEntry
+        BibEntry bibEntry = new BibEntry();
+        // construct an entry
+        bibEntry.setType(StandardEntryType.Article);
+        bibEntry.setField(StandardField.JOURNAL, "grl");
+        bibEntry.setField(StandardField.AUTHOR, "Claudepierre, S. G.");
+        // add entry to list
+        List<BibEntry> bibEntries = new ArrayList<>();
+        bibEntries.add(bibEntry);
+
+        // string constants
+        List<BibtexString> constants = new ArrayList<>();
+
+        // Mock BibtexString
+        BibtexString bibtexString = mock(BibtexString.class);
+
+        // define return value for getParsedSerialization()
+        when(bibtexString.getParsedSerialization()).thenReturn("@String{grl = \"Geophys. Res. Lett.\"}");
+        // add the constant
+        constants.add(bibtexString);
+
+        // Act
+        clipBoardManager.setContent(bibEntries, entryTypesManager, constants);
+
+        // Assert
+        String actual = ClipBoardManager.getContentsPrimary();
+        // clean strings
+        actual = actual.replaceAll("\\s+", " ").trim();
+        expected = expected.replaceAll("\\s+", " ").trim();
+
+        assertEquals(expected, actual);
+    }
+}