Save files again relative to bib file

CHANGELOG.md

@@ -36,8 +36,6 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
 - We removed "last-search-date" from the SLR feature, because the last-search-date can be deducted from the git logs. [#9116](https://github.com/JabRef/jabref/pull/9116)
 - A user can now add arbitrary data into `study.yml`. JabRef just ignores this data. [#9124](https://github.com/JabRef/jabref/pull/9124)
 - We reworked the External Changes Resolver dialog. [#9021](https://github.com/JabRef/jabref/pull/9021)
-- The fallback directory of the file folder now is the general file directory. In case there was a directory configured for a library and this directory was not found, JabRef placed the PDF next to the .bib file and not into the general file directory.
-- The global default directory for storing PDFs is now the subdirectory "JabRef" in the user's home.
 - We reworked the Define study parameters dialog. [#9123](https://github.com/JabRef/jabref/pull/9123)
 - We simplified the actions to fast-resolve duplicates to 'Keep Left', 'Keep Right', 'Keep Both' and 'Keep Merged'. [#9056](https://github.com/JabRef/jabref/issues/9056)
 - We fixed an issue where a message about changed metadata would occur on saving although nothing changed. [#9159](https://github.com/JabRef/jabref/issues/9159)

src/main/java/org/jabref/gui/desktop/JabRefDesktop.java

@@ -10,9 +10,6 @@
 import java.util.Optional;
 import java.util.regex.Pattern;
 
-import javax.swing.filechooser.FileSystemView;
-
-import org.jabref.architecture.AllowedToUseSwing;
 import org.jabref.gui.DialogService;
 import org.jabref.gui.Globals;
 import org.jabref.gui.desktop.os.DefaultDesktop;
@@ -40,7 +37,6 @@
  * TODO: Replace by http://docs.oracle.com/javase/7/docs/api/java/awt/Desktop.html
  * http://stackoverflow.com/questions/18004150/desktop-api-is-not-supported-on-the-current-platform
  */
-@AllowedToUseSwing("Needs access to swing for the user's os dependent file chooser path")
 public class JabRefDesktop {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(JabRefDesktop.class);
@@ -292,21 +288,6 @@ public static void openConsole(File file, PreferencesService preferencesService,
         }
     }
 
-    /**
-     * Get the user's default file chooser directory
-     *
-     * @return The path to the directory
-     */
-    public static String getDefaultFileChooserDirectory() {
-        // Property "user.home" might be "difficult" on Windows
-        // See https://stackoverflow.com/a/586917/873282 for a longer discussion
-        // The proposed solution is to use Swing's FileSystemView
-        // See https://stackoverflow.com/a/32914568/873282
-        // As of 2022, System.getProperty("user.home") returns c:\Users\USERNAME on Windows 10, whereas
-        // the FileSystemView returns C:\Users\USERNAME\Documents, which is the "better" directory
-        return FileSystemView.getFileSystemView().getDefaultDirectory().getPath();
-    }
-
     // TODO: Move to OS.java
     public static NativeDesktop getNativeDesktop() {
         if (OS.WINDOWS) {

src/main/java/org/jabref/logic/layout/format/FileLink.java

@@ -55,7 +55,7 @@ public String format(String field) {
         // ugly hack, the export routine has set a global variable before
         // starting the export, which contains the database's file directory:
         if (prefs.getFileDirForDatabase() == null) {
-            dirs = Collections.singletonList(Path.of(prefs.getMainFileDirectory()));
+            dirs = prefs.getMainFileDirectory().map(List::of).orElse(Collections.emptyList());
         } else {
             dirs = prefs.getFileDirForDatabase();
         }

src/main/java/org/jabref/logic/layout/format/FileLinkPreferences.java

@@ -2,18 +2,19 @@
 
 import java.nio.file.Path;
 import java.util.List;
+import java.util.Optional;
 
 public class FileLinkPreferences {
 
-    private final String mainFileDirectory;
+    private final Optional<Path> mainFileDirectory;
     private final List<Path> fileDirForDatabase;
 
-    public FileLinkPreferences(String mainFileDirectory, List<Path> fileDirForDatabase) {
+    public FileLinkPreferences(Optional<Path> mainFileDirectory, List<Path> fileDirForDatabase) {
         this.mainFileDirectory = mainFileDirectory;
         this.fileDirForDatabase = fileDirForDatabase;
     }
 
-    public String getMainFileDirectory() {
+    public Optional<Path> getMainFileDirectory() {
         return mainFileDirectory;
     }
 

src/main/java/org/jabref/logic/layout/format/WrapFileLinks.java

@@ -199,7 +199,7 @@ public String format(String field) {
                             // ugly hack, the export routine has set a global variable before
                             // starting the export, which contains the database's file directory:
                             if ((prefs.getFileDirForDatabase() == null) || prefs.getFileDirForDatabase().isEmpty()) {
-                                dirs = Collections.singletonList(Path.of(prefs.getMainFileDirectory()));
+                                dirs = prefs.getMainFileDirectory().map(List::of).orElse(Collections.emptyList());
                             } else {
                                 dirs = prefs.getFileDirForDatabase();
                             }

src/main/java/org/jabref/preferences/FilePreferences.java

@@ -16,14 +16,15 @@
 import javafx.collections.ObservableSet;
 
 import org.jabref.gui.externalfiletype.ExternalFileType;
+import org.jabref.gui.util.OptionalObjectProperty;
 import org.jabref.model.strings.StringUtil;
 
 public class FilePreferences {
 
     public static final String[] DEFAULT_FILENAME_PATTERNS = new String[] {"[bibtexkey]", "[bibtexkey] - [title]"};
 
     private final StringProperty user = new SimpleStringProperty();
-    private final SimpleStringProperty mainFileDirectory = new SimpleStringProperty();
+    private final OptionalObjectProperty<Path> mainFileDirectory = OptionalObjectProperty.empty();
     private final BooleanProperty storeFilesRelativeToBibFile = new SimpleBooleanProperty();
     private final StringProperty fileNamePattern = new SimpleStringProperty();
     private final StringProperty fileDirectoryPattern = new SimpleStringProperty();
@@ -42,7 +43,7 @@ public FilePreferences(String user,
                            Path workingDirectory,
                            Set<ExternalFileType> externalFileTypes) {
         this.user.setValue(user);
-        this.mainFileDirectory.setValue(mainFileDirectory);
+        this.setMainFileDirectory(mainFileDirectory);
         this.storeFilesRelativeToBibFile.setValue(storeFilesRelativeToBibFile);
         this.fileNamePattern.setValue(fileNamePattern);
         this.fileDirectoryPattern.setValue(fileDirectoryPattern);
@@ -57,19 +58,19 @@ public String getUser() {
     }
 
     public Optional<Path> getFileDirectory() {
-        if (StringUtil.isBlank(mainFileDirectory.getValue())) {
-            return Optional.empty();
-        } else {
-            return Optional.of(Path.of(mainFileDirectory.getValue()));
-        }
+        return mainFileDirectory.getValue();
     }
 
-    public StringProperty mainFileDirectoryProperty() {
+    public OptionalObjectProperty<Path> mainFileDirectoryProperty() {
         return mainFileDirectory;
     }
 
     public void setMainFileDirectory(String mainFileDirectory) {
-        this.mainFileDirectory.set(mainFileDirectory);
+        if (StringUtil.isBlank(mainFileDirectory)) {
+            this.mainFileDirectory.setValue(Optional.empty());
+        } else {
+            this.mainFileDirectory.setValue(Optional.of(Path.of(mainFileDirectory)));
+        }
     }
 
     public boolean shouldStoreFilesRelativeToBibFile() {

src/main/java/org/jabref/preferences/JabRefPreferences.java

@@ -1109,7 +1109,7 @@ public void importPreferences(Path file) throws JabRefException {
     @Override
     public FileLinkPreferences getFileLinkPreferences() {
         return new FileLinkPreferences(
-                getFilePreferences().mainFileDirectoryProperty().get(),
+                getFilePreferences().getFileDirectory(),
                 fileDirForDatabase);
     }
 
@@ -2179,20 +2179,6 @@ public FieldWriterPreferences getFieldWriterPreferences() {
                 getFieldContentParserPreferences());
     }
 
-    /**
-     * Ensures that the main file directory is a non-empty String.
-     * The directory is <emph>NOT</emph> created, because creation of the directory is the task of the respective methods.
-     *
-     * @param originalDirectory the directory as configured
-     */
-    private String determineMainFileDirectory(String originalDirectory) {
-        if ((originalDirectory != null) && !originalDirectory.isEmpty()) {
-            // A non-empty directory is kept
-            return originalDirectory;
-        }
-        return JabRefDesktop.getDefaultFileChooserDirectory();
-    }
-
     @Override
     public FilePreferences getFilePreferences() {
         if (Objects.nonNull(filePreferences)) {
@@ -2201,7 +2187,7 @@ public FilePreferences getFilePreferences() {
 
         filePreferences = new FilePreferences(
                 getInternalPreferences().getUser(),
-                determineMainFileDirectory(get(MAIN_FILE_DIRECTORY)),
+                get(MAIN_FILE_DIRECTORY),
                 getBoolean(STORE_RELATIVE_TO_BIB),
                 get(IMPORT_FILENAMEPATTERN),
                 get(IMPORT_FILEDIRPATTERN),
@@ -2211,7 +2197,7 @@ public FilePreferences getFilePreferences() {
                 ExternalFileTypes.fromString(get(EXTERNAL_FILE_TYPES))
         );
 
-        EasyBind.listen(filePreferences.mainFileDirectoryProperty(), (obs, oldValue, newValue) -> put(MAIN_FILE_DIRECTORY, newValue));
+        EasyBind.listen(filePreferences.mainFileDirectoryProperty(), (obs, oldValue, newValue) -> put(MAIN_FILE_DIRECTORY, newValue.map(Path::toString).orElse("")));
         EasyBind.listen(filePreferences.storeFilesRelativeToBibFileProperty(), (obs, oldValue, newValue) -> putBoolean(STORE_RELATIVE_TO_BIB, newValue));
         EasyBind.listen(filePreferences.fileNamePatternProperty(), (obs, oldValue, newValue) -> put(IMPORT_FILENAMEPATTERN, newValue));
         EasyBind.listen(filePreferences.fileDirectoryPatternProperty(), (obs, oldValue, newValue) -> put(IMPORT_FILEDIRPATTERN, newValue));

src/test/java/org/jabref/architecture/MainArchitectureTests.java

@@ -32,8 +32,7 @@ public static void doNotUseApacheCommonsLang3(JavaClasses classes) {
     @ArchTest
     public static void doNotUseSwing(JavaClasses classes) {
         // This checks for all Swing packages, but not the UndoManager
-        noClasses().that().areNotAnnotatedWith(AllowedToUseSwing.class)
-                   .should().accessClassesThat()
+        noClasses().should().accessClassesThat()
                    .resideInAnyPackage("javax.swing",
                                        "javax.swing.border..",
                                        "javax.swing.colorchooser..",

src/test/java/org/jabref/logic/layout/LayoutTest.java

@@ -5,6 +5,7 @@
 import java.io.StringReader;
 import java.nio.file.Path;
 import java.util.Collections;
+import java.util.Optional;
 
 import org.jabref.logic.layout.format.FileLinkPreferences;
 import org.jabref.logic.layout.format.NameFormatterPreferences;
@@ -135,7 +136,7 @@ void beginConditionals() throws IOException {
     @Test
     void wrapFileLinksExpandFile() throws IOException {
         when(layoutFormatterPreferences.getFileLinkPreferences()).thenReturn(
-                new FileLinkPreferences("", Collections.singletonList(Path.of("src/test/resources/pdfs/"))));
+                new FileLinkPreferences(Optional.empty(), Collections.singletonList(Path.of("src/test/resources/pdfs/"))));
         BibEntry entry = new BibEntry(StandardEntryType.Article);
         entry.addFile(new LinkedFile("Test file", Path.of("encrypted.pdf"), "PDF"));
 

src/test/java/org/jabref/logic/layout/format/WrapFileLinksTest.java

@@ -4,6 +4,7 @@
 import java.io.IOException;
 import java.nio.file.Path;
 import java.util.Collections;
+import java.util.Optional;
 
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -17,7 +18,7 @@ class WrapFileLinksTest {
 
     @BeforeEach
     void setUp() {
-        FileLinkPreferences preferences = new FileLinkPreferences("", Collections.emptyList());
+        FileLinkPreferences preferences = new FileLinkPreferences(Optional.empty(), Collections.emptyList());
         formatter = new WrapFileLinks(preferences);
     }
 
@@ -97,7 +98,7 @@ void testEndingBracket() {
 
     @Test
     void testPath() throws IOException {
-        FileLinkPreferences preferences = new FileLinkPreferences("",
+        FileLinkPreferences preferences = new FileLinkPreferences(Optional.empty(),
                 Collections.singletonList(Path.of("src/test/resources/pdfs/")));
         formatter = new WrapFileLinks(preferences);
         formatter.setArgument("\\p");
@@ -107,7 +108,7 @@ void testPath() throws IOException {
 
     @Test
     void testPathFallBackToGeneratedDir() throws IOException {
-        FileLinkPreferences preferences = new FileLinkPreferences("src/test/resources/pdfs/",
+        FileLinkPreferences preferences = new FileLinkPreferences(Optional.of(Path.of("src/test/resources/pdfs/")),
                 Collections.emptyList());
         formatter = new WrapFileLinks(preferences);
         formatter.setArgument("\\p");
@@ -117,7 +118,7 @@ void testPathFallBackToGeneratedDir() throws IOException {
 
     @Test
     void testPathReturnsRelativePathIfNotFound() {
-        FileLinkPreferences preferences = new FileLinkPreferences("",
+        FileLinkPreferences preferences = new FileLinkPreferences(Optional.empty(),
                 Collections.singletonList(Path.of("src/test/resources/pdfs/")));
         formatter = new WrapFileLinks(preferences);
         formatter.setArgument("\\p");

src/test/java/org/jabref/model/database/BibDatabaseContextTest.java

@@ -5,7 +5,6 @@
 import java.util.List;
 import java.util.Optional;
 
-import org.jabref.gui.desktop.JabRefDesktop;
 import org.jabref.model.entry.BibEntry;
 import org.jabref.model.entry.types.IEEETranEntryType;
 import org.jabref.model.metadata.MetaData;
@@ -94,13 +93,12 @@ void getFileDirectoriesWithMetadata() {
     @Test
     void getUserFileDirectoryIfAllAreEmpty() {
         when(fileDirPrefs.shouldStoreFilesRelativeToBibFile()).thenReturn(false);
+        Path userDirGlobal = Path.of("some random path").toAbsolutePath();
+        when(fileDirPrefs.getFileDirectory()).thenReturn(Optional.of(userDirGlobal));
 
-        Path userDirJabRef = Path.of(JabRefDesktop.getDefaultFileChooserDirectory(), "JabRef");
-
-        when(fileDirPrefs.getFileDirectory()).thenReturn(Optional.of(userDirJabRef));
         BibDatabaseContext database = new BibDatabaseContext();
         database.setDatabasePath(Path.of("biblio.bib"));
-        assertEquals(Collections.singletonList(userDirJabRef), database.getFileDirectories(fileDirPrefs));
+        assertEquals(Collections.singletonList(userDirGlobal), database.getFileDirectories(fileDirPrefs));
     }
 
     @Test