* The save operation is loaded off of the GUI thread using {@link BackgroundTask}. Callers can query whether the * operation was canceled, or whether it was successful. */ @@ -69,12 +69,10 @@ public SaveDatabaseAction(BasePanel panel, JabRefPreferences prefs, BibEntryType } private boolean saveDatabase(Path file, boolean selectedOnly, Charset encoding, SavePreferences.DatabaseSaveType saveType) throws SaveException { - try { - SavePreferences preferences = prefs.loadForSaveFromPreferences() - .withEncoding(encoding) - .withSaveType(saveType); - - AtomicFileWriter fileWriter = new AtomicFileWriter(file, preferences.getEncoding(), preferences.makeBackup()); + SavePreferences preferences = prefs.loadForSaveFromPreferences() + .withEncoding(encoding) + .withSaveType(saveType); + try (AtomicFileWriter fileWriter = new AtomicFileWriter(file, preferences.getEncoding(), preferences.makeBackup())) { BibtexDatabaseWriter databaseWriter = new BibtexDatabaseWriter(fileWriter, preferences, entryTypesManager); if (selectedOnly) { @@ -148,7 +146,7 @@ private boolean doSave() { // Reset title of tab frame.setTabTitle(panel, panel.getTabTitle(), - panel.getBibDatabaseContext().getDatabaseFile().get().getAbsolutePath()); + panel.getBibDatabaseContext().getDatabasePath().get().toAbsolutePath().toString()); frame.setWindowTitle(); frame.updateAllTabTitles(); } diff --git a/src/main/java/org/jabref/gui/util/DefaultFileUpdateMonitor.java b/src/main/java/org/jabref/gui/util/DefaultFileUpdateMonitor.java index bdf0b51e2a6..f5600df45c5 100644 --- a/src/main/java/org/jabref/gui/util/DefaultFileUpdateMonitor.java +++ b/src/main/java/org/jabref/gui/util/DefaultFileUpdateMonitor.java @@ -7,6 +7,7 @@ import java.nio.file.WatchEvent; import java.nio.file.WatchKey; import java.nio.file.WatchService; +import java.util.Objects; import org.jabref.model.util.FileUpdateListener; import org.jabref.model.util.FileUpdateMonitor; @@ -19,7 +20,7 @@ /** * This class monitors a set of files for changes. Upon detecting a change it notifies the registered {@link * FileUpdateListener}s. - * + *
* Implementation based on https://stackoverflow.com/questions/16251273/can-i-watch-for-single-file-change-with-watchservice-not-the-whole-directory
*/
public class DefaultFileUpdateMonitor implements Runnable, FileUpdateMonitor {
@@ -69,9 +70,7 @@ private void notifyAboutChange(Path path) {
@Override
public void addListenerForFile(Path file, FileUpdateListener listener) throws IOException {
- if (watcher == null) {
- throw new IllegalStateException("You need to start the file monitor before watching files");
- }
+ Objects.requireNonNull(watcher, "You need to start the file monitor before watching files");
// We can't watch files directly, so monitor their parent directory for updates
Path directory = file.toAbsolutePath().getParent();
diff --git a/src/main/java/org/jabref/logic/exporter/BibDatabaseWriter.java b/src/main/java/org/jabref/logic/exporter/BibDatabaseWriter.java
index 94a8beb41c1..d5c238b09cd 100644
--- a/src/main/java/org/jabref/logic/exporter/BibDatabaseWriter.java
+++ b/src/main/java/org/jabref/logic/exporter/BibDatabaseWriter.java
@@ -151,8 +151,8 @@ public void saveDatabase(BibDatabaseContext bibDatabaseContext) throws IOExcepti
*/
public void savePartOfDatabase(BibDatabaseContext bibDatabaseContext, Listtrue, if parts of the entry changed. This causes the entry to be serialized based on the internal state (and not based on the old serialization)
*/
private boolean changed;
diff --git a/src/test/java/org/jabref/gui/exporter/SaveDatabaseActionTest.java b/src/test/java/org/jabref/gui/exporter/SaveDatabaseActionTest.java
index 7e06be4af15..285f06c5611 100644
--- a/src/test/java/org/jabref/gui/exporter/SaveDatabaseActionTest.java
+++ b/src/test/java/org/jabref/gui/exporter/SaveDatabaseActionTest.java
@@ -1,20 +1,36 @@
package org.jabref.gui.exporter;
+import java.io.IOException;
+import java.nio.charset.Charset;
+import java.nio.file.Files;
import java.nio.file.Path;
+import java.util.Collections;
+import java.util.List;
import java.util.Optional;
+import java.util.stream.Collectors;
import org.jabref.gui.BasePanel;
import org.jabref.gui.DialogService;
import org.jabref.gui.JabRefFrame;
+import org.jabref.gui.undo.CountingUndoManager;
import org.jabref.gui.util.FileDialogConfiguration;
+import org.jabref.logic.bibtex.FieldContentParserPreferences;
+import org.jabref.logic.bibtex.LatexFieldFormatterPreferences;
+import org.jabref.logic.exporter.SavePreferences;
+import org.jabref.model.bibtexkeypattern.GlobalBibtexKeyPattern;
+import org.jabref.model.database.BibDatabase;
import org.jabref.model.database.BibDatabaseContext;
import org.jabref.model.database.shared.DatabaseLocation;
+import org.jabref.model.entry.BibEntry;
import org.jabref.model.entry.BibEntryTypesManager;
+import org.jabref.model.entry.field.StandardField;
+import org.jabref.model.metadata.MetaData;
import org.jabref.preferences.JabRefPreferences;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.mockito.Mockito.any;
import static org.mockito.Mockito.doNothing;
@@ -27,8 +43,7 @@
class SaveDatabaseActionTest {
private static final String TEST_BIBTEX_LIBRARY_LOCATION = "C:\\Users\\John_Doe\\Jabref\\literature.bib";
- private final Path file = Path.of(TEST_BIBTEX_LIBRARY_LOCATION);
-
+ private Path file = Path.of(TEST_BIBTEX_LIBRARY_LOCATION);
private DialogService dialogService = mock(DialogService.class);
private JabRefPreferences preferences = mock(JabRefPreferences.class);
private BasePanel basePanel = mock(BasePanel.class);
@@ -91,6 +106,58 @@ public void saveShouldShowSaveAsIfDatabaseNotSelected() {
verify(saveDatabaseAction, times(1)).saveAs(file);
}
+ private SaveDatabaseAction createSaveDatabaseActionForBibDatabase(BibDatabase database) throws IOException {
+ file = Files.createTempFile("JabRef", ".bib");
+ file.toFile().deleteOnExit();
+
+ LatexFieldFormatterPreferences latexFieldFormatterPreferences = mock(LatexFieldFormatterPreferences.class);
+ when(latexFieldFormatterPreferences.getFieldContentParserPreferences()).thenReturn(mock(FieldContentParserPreferences.class));
+ SavePreferences savePreferences = mock(SavePreferences.class);
+ // In case a "thenReturn" is modified, the whole mock has to be recreated
+ dbContext = mock(BibDatabaseContext.class);
+ basePanel = mock(BasePanel.class);
+ MetaData metaData = mock(MetaData.class);
+ when(savePreferences.withEncoding(any(Charset.class))).thenReturn(savePreferences);
+ when(savePreferences.withSaveType(any(SavePreferences.DatabaseSaveType.class))).thenReturn(savePreferences);
+ when(savePreferences.getEncoding()).thenReturn(Charset.forName("UTF-8"));
+ when(savePreferences.getLatexFieldFormatterPreferences()).thenReturn(latexFieldFormatterPreferences);
+ GlobalBibtexKeyPattern emptyGlobalBibtexKeyPattern = GlobalBibtexKeyPattern.fromPattern("");
+ when(savePreferences.getGlobalCiteKeyPattern()).thenReturn(emptyGlobalBibtexKeyPattern);
+ when(metaData.getCiteKeyPattern(any(GlobalBibtexKeyPattern.class))).thenReturn(emptyGlobalBibtexKeyPattern);
+ when(dbContext.getDatabasePath()).thenReturn(Optional.of(file));
+ when(dbContext.getLocation()).thenReturn(DatabaseLocation.LOCAL);
+ when(dbContext.getDatabase()).thenReturn(database);
+ when(dbContext.getMetaData()).thenReturn(metaData);
+ when(dbContext.getEntries()).thenReturn(database.getEntries());
+ when(preferences.getBoolean(JabRefPreferences.LOCAL_AUTO_SAVE)).thenReturn(false);
+ when(preferences.getDefaultEncoding()).thenReturn(Charset.forName("UTF-8"));
+ when(preferences.getFieldContentParserPreferences()).thenReturn(mock(FieldContentParserPreferences.class));
+ when(preferences.loadForSaveFromPreferences()).thenReturn(savePreferences);
+ when(basePanel.frame()).thenReturn(jabRefFrame);
+ when(basePanel.getBibDatabaseContext()).thenReturn(dbContext);
+ when(basePanel.getUndoManager()).thenReturn(mock(CountingUndoManager.class));
+ when(basePanel.getBibDatabaseContext()).thenReturn(dbContext);
+ saveDatabaseAction = new SaveDatabaseAction(basePanel, preferences, mock(BibEntryTypesManager.class));
+ return saveDatabaseAction;
+ }
+
+ @Test
+ public void saveKeepsChangedFlag() throws Exception {
+ BibEntry firstEntry = new BibEntry().withField(StandardField.AUTHOR, "first");
+ firstEntry.setChanged(true);
+ BibEntry secondEntry = new BibEntry().withField(StandardField.AUTHOR, "second");
+ secondEntry.setChanged(true);
+ BibDatabase database = new BibDatabase(List.of(firstEntry, secondEntry));
+
+ saveDatabaseAction = createSaveDatabaseActionForBibDatabase(database);
+ saveDatabaseAction.save();
+
+ assertEquals(database
+ .getEntries().stream()
+ .map(entry -> entry.hasChanged()).filter(changed -> false).collect(Collectors.toList()),
+ Collections.emptyList());
+ }
+
@Test
public void saveShouldNotSaveDatabaseIfPathNotSet() {
when(dbContext.getDatabasePath()).thenReturn(Optional.empty());
diff --git a/src/test/java/org/jabref/logic/exporter/BibtexDatabaseWriterTest.java b/src/test/java/org/jabref/logic/exporter/BibtexDatabaseWriterTest.java
index f6ee7f5c92b..1d779dd50c0 100644
--- a/src/test/java/org/jabref/logic/exporter/BibtexDatabaseWriterTest.java
+++ b/src/test/java/org/jabref/logic/exporter/BibtexDatabaseWriterTest.java
@@ -4,11 +4,12 @@
import java.io.StringWriter;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Arrays;
+import java.util.Collection;
import java.util.Collections;
-import java.util.Scanner;
import org.jabref.logic.formatter.casechanger.LowerCaseFormatter;
import org.jabref.logic.formatter.casechanger.TitleCaseFormatter;
@@ -332,9 +333,7 @@ void roundtripWithArticleMonths() throws Exception {
new Defaults(BibDatabaseMode.BIBTEX));
databaseWriter.savePartOfDatabase(context, result.getDatabase().getEntries());
- try (Scanner scanner = new Scanner(testBibtexFile, encoding.name())) {
- assertEquals(scanner.useDelimiter("\\A").next(), stringWriter.toString());
- }
+ assertEquals(Files.readString(testBibtexFile, encoding), stringWriter.toString());
}
@Test
@@ -349,9 +348,7 @@ void roundtripWithComplexBib() throws Exception {
new Defaults(BibDatabaseMode.BIBTEX));
databaseWriter.savePartOfDatabase(context, result.getDatabase().getEntries());
- try (Scanner scanner = new Scanner(testBibtexFile, encoding.name())) {
- assertEquals(scanner.useDelimiter("\\A").next(), stringWriter.toString());
- }
+ assertEquals(Files.readString(testBibtexFile, encoding), stringWriter.toString());
}
@Test
@@ -366,9 +363,7 @@ void roundtripWithUserComment() throws Exception {
new Defaults(BibDatabaseMode.BIBTEX));
databaseWriter.savePartOfDatabase(context, result.getDatabase().getEntries());
- try (Scanner scanner = new Scanner(testBibtexFile, encoding.name())) {
- assertEquals(scanner.useDelimiter("\\A").next(), stringWriter.toString());
- }
+ assertEquals(Files.readString(testBibtexFile, encoding), stringWriter.toString());
}
@Test
@@ -386,10 +381,7 @@ void roundtripWithUserCommentAndEntryChange() throws Exception {
new Defaults(BibDatabaseMode.BIBTEX));
databaseWriter.savePartOfDatabase(context, result.getDatabase().getEntries());
-
- try (Scanner scanner = new Scanner(Paths.get("src/test/resources/testbib/bibWithUserCommentAndEntryChange.bib"), encoding.name())) {
- assertEquals(scanner.useDelimiter("\\A").next(), stringWriter.toString());
- }
+ assertEquals(Files.readString(Paths.get("src/test/resources/testbib/bibWithUserCommentAndEntryChange.bib"), encoding), stringWriter.toString());
}
@Test
@@ -410,9 +402,7 @@ void roundtripWithUserCommentBeforeStringAndChange() throws Exception {
databaseWriter.savePartOfDatabase(context, result.getDatabase().getEntries());
- try (Scanner scanner = new Scanner(testBibtexFile, encoding.name())) {
- assertEquals(scanner.useDelimiter("\\A").next(), stringWriter.toString());
- }
+ assertEquals(Files.readString(testBibtexFile, encoding), stringWriter.toString());
}
@Test
@@ -427,9 +417,7 @@ void roundtripWithUnknownMetaData() throws Exception {
new Defaults(BibDatabaseMode.BIBTEX));
databaseWriter.savePartOfDatabase(context, result.getDatabase().getEntries());
- try (Scanner scanner = new Scanner(testBibtexFile, encoding.name())) {
- assertEquals(scanner.useDelimiter("\\A").next(), stringWriter.toString());
- }
+ assertEquals(Files.readString(testBibtexFile, encoding), stringWriter.toString());
}
@Test
@@ -570,7 +558,7 @@ void writeFileDirectories() throws Exception {
assertEquals(OS.NEWLINE + "@Comment{jabref-meta: fileDirectory:\\\\Literature\\\\;}" + OS.NEWLINE +
OS.NEWLINE + "@Comment{jabref-meta: fileDirectory-defaultOwner-user:D:\\\\Documents;}"
- + OS.NEWLINE + OS.NEWLINE + "@Comment{jabref-meta: fileDirectoryLatex-defaultOwner-user:D:\\\\Latex;}" + OS.NEWLINE, stringWriter.toString());
+ + OS.NEWLINE + OS.NEWLINE + "@Comment{jabref-meta: fileDirectoryLatex-defaultOwner-user:D:\\\\Latex;}" + OS.NEWLINE, stringWriter.toString());
}
@Test
@@ -683,4 +671,122 @@ void roundtripWithContentSelectorsAndUmlauts() throws Exception {
assertEquals(fileContent, stringWriter.toString());
}
+
+ @Test
+ public void saveAlsoSavesSecondModification() throws Exception {
+ // @formatter:off
+ String bibtexEntry = OS.NEWLINE + "@Article{test," + OS.NEWLINE +
+ " Author = {Foo Bar}," + OS.NEWLINE +
+ " Journal = {International Journal of Something}," + OS.NEWLINE +
+ " Note = {some note}," + OS.NEWLINE +
+ " Number = {1}," + OS.NEWLINE +
+ "}";
+ // @formatter:on
+
+ // read in bibtex string
+ ImportFormatPreferences importFormatPreferences = mock(ImportFormatPreferences.class, Answers.RETURNS_DEEP_STUBS);
+ ParserResult firstParse = new BibtexParser(importFormatPreferences, new DummyFileUpdateMonitor()).parse(new StringReader(bibtexEntry));
+ Collection