Add context menu for multi-file entries (#12567)

CHANGELOG.md

@@ -38,6 +38,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We added support for finding CSL-Styles based on their short title (e.g. apa instead of "american psychological association"). [#13728](https://github.com/JabRef/jabref/pull/13728)
 - We added a field for the latest ICORE conference ranking lookup on the General Tab. [#13476](https://github.com/JabRef/jabref/issues/13476)
 - We added BibLaTeX datamodel validation support in order to improve error message quality in entries' fields validation. [#13318](https://github.com/JabRef/jabref/issues/13318)
+- We added support for managing multiple linked files via the entry context menu. [#12567](https://github.com/JabRef/jabref/issues/12567)
 - We added more supported formats of CAYW endpoint of HTTP server. [#13578](https://github.com/JabRef/jabref/issues/13578)
 - We added chronological navigation for entries in each library. [#6352](https://github.com/JabRef/jabref/issues/6352)
 - We added support for using Medline/Pubmed fetcher with an API key. [#11296](https://github.com/JabRef/jabref/issues/11296#issuecomment-3289005011)

jabgui/src/main/java/org/jabref/gui/actions/StandardActions.java

@@ -115,8 +115,8 @@ public enum StandardActions implements Action {
     EDIT_EXISTING_STUDY(Localization.lang("Manage study definition")),
 
     OPEN_DATABASE_FOLDER(Localization.lang("Reveal in file explorer")),
-    OPEN_FOLDER(Localization.lang("Open folder"), Localization.lang("Open folder"), IconTheme.JabRefIcons.FOLDER, KeyBinding.OPEN_FOLDER),
-    OPEN_FILE(Localization.lang("Open file"), Localization.lang("Open file"), IconTheme.JabRefIcons.FILE, KeyBinding.OPEN_FILE),
+    OPEN_FOLDER(Localization.lang("Open folder(s)"), Localization.lang("Open folder"), IconTheme.JabRefIcons.FOLDER, KeyBinding.OPEN_FOLDER),
+    OPEN_FILE(Localization.lang("Open file(s)"), Localization.lang("Open file"), IconTheme.JabRefIcons.FILE, KeyBinding.OPEN_FILE),
     OPEN_CONSOLE(Localization.lang("Open terminal here"), Localization.lang("Open terminal here"), IconTheme.JabRefIcons.CONSOLE, KeyBinding.OPEN_CONSOLE),
     COPY_LINKED_FILES(Localization.lang("Copy linked files to folder...")),
     COPY_DOI(Localization.lang("Copy DOI")),
@@ -169,16 +169,16 @@ public enum StandardActions implements Action {
     SET_FILE_LINKS(Localization.lang("Automatically set file links"), KeyBinding.AUTOMATICALLY_LINK_FILES),
 
     EDIT_FILE_LINK(Localization.lang("Edit"), IconTheme.JabRefIcons.EDIT, KeyBinding.OPEN_CLOSE_ENTRY_EDITOR),
-    DOWNLOAD_FILE(Localization.lang("Download file"), IconTheme.JabRefIcons.DOWNLOAD_FILE),
-    REDOWNLOAD_FILE(Localization.lang("Redownload file"), IconTheme.JabRefIcons.DOWNLOAD_FILE),
+    DOWNLOAD_FILE(Localization.lang("Download file(s)"), IconTheme.JabRefIcons.DOWNLOAD_FILE),
+    REDOWNLOAD_FILE(Localization.lang("Redownload file(s)"), IconTheme.JabRefIcons.DOWNLOAD_FILE),
     RENAME_FILE_TO_PATTERN(Localization.lang("Rename file to defined pattern"), IconTheme.JabRefIcons.AUTO_RENAME),
-    RENAME_FILE_TO_NAME(Localization.lang("Rename files to configured filename format pattern"), IconTheme.JabRefIcons.RENAME, KeyBinding.REPLACE_STRING),
-    MOVE_FILE_TO_FOLDER(Localization.lang("Move file to file directory"), IconTheme.JabRefIcons.MOVE_TO_FOLDER),
+    RENAME_FILE_TO_NAME(Localization.lang("Rename file(s) to configured filename format pattern"), IconTheme.JabRefIcons.RENAME, KeyBinding.REPLACE_STRING),
+    MOVE_FILE_TO_FOLDER(Localization.lang("Move file(s) to file directory"), IconTheme.JabRefIcons.MOVE_TO_FOLDER),
     MOVE_FILE_TO_FOLDER_AND_RENAME(Localization.lang("Move file to file directory and rename file")),
-    COPY_FILE_TO_FOLDER(Localization.lang("Copy linked file to folder..."), IconTheme.JabRefIcons.COPY_TO_FOLDER, KeyBinding.COPY),
+    COPY_FILE_TO_FOLDER(Localization.lang("Copy linked file(s) to folder..."), IconTheme.JabRefIcons.COPY_TO_FOLDER, KeyBinding.COPY),
     REMOVE_LINK(Localization.lang("Remove link"), IconTheme.JabRefIcons.REMOVE_LINK),
     REMOVE_LINKS(Localization.lang("Remove links"), IconTheme.JabRefIcons.REMOVE_LINK),
-    DELETE_FILE(Localization.lang("Permanently delete local file"), IconTheme.JabRefIcons.DELETE_FILE, KeyBinding.DELETE_ENTRY),
+    DELETE_FILE(Localization.lang("Permanently delete local file(s)"), IconTheme.JabRefIcons.DELETE_FILE, KeyBinding.DELETE_ENTRY),
 
     HELP(Localization.lang("Online help"), IconTheme.JabRefIcons.HELP, KeyBinding.HELP),
     HELP_GROUPS(Localization.lang("Open Help page"), IconTheme.JabRefIcons.HELP, KeyBinding.HELP),

jabgui/src/main/java/org/jabref/gui/copyfiles/CopyLinkedFilesAction.java

@@ -0,0 +1,112 @@
+package org.jabref.gui.copyfiles;
+
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import java.util.Optional;
+import java.util.function.BiFunction;
+
+import javafx.beans.Observable;
+import javafx.beans.binding.Bindings;
+
+import org.jabref.gui.DialogService;
+import org.jabref.gui.actions.SimpleCommand;
+import org.jabref.gui.util.DirectoryDialogConfiguration;
+import org.jabref.logic.FilePreferences;
+import org.jabref.logic.l10n.Localization;
+import org.jabref.logic.util.io.FileUtil;
+import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.model.entry.LinkedFile;
+
+public class CopyLinkedFilesAction extends SimpleCommand {
+
+    private final List<LinkedFile> linkedFiles;
+    private final DialogService dialogService;
+    private final BibDatabaseContext databaseContext;
+    private final FilePreferences filePreferences;
+
+    private final BiFunction<Path, Path, Path> resolvePathFilename = (dir, file) -> dir.resolve(file.getFileName());
+
+    public CopyLinkedFilesAction(LinkedFile linkedFile,
+                                 DialogService dialogService,
+                                 BibDatabaseContext databaseContext,
+                                 FilePreferences filePreferences) {
+        this(List.of(linkedFile), dialogService, databaseContext, filePreferences);
+    }
+
+    public CopyLinkedFilesAction(Collection<LinkedFile> linkedFiles,
+                                 DialogService dialogService,
+                                 BibDatabaseContext databaseContext,
+                                 FilePreferences filePreferences) {
+        this.linkedFiles = new ArrayList<>(linkedFiles);
+        this.dialogService = dialogService;
+        this.databaseContext = databaseContext;
+        this.filePreferences = filePreferences;
+
+        this.executable.bind(Bindings.createBooleanBinding(
+                () -> this.linkedFiles.stream().anyMatch(this::isLocalExisting),
+                dependencies(this.linkedFiles)));
+    }
+
+    @Override
+    public void execute() {
+        DirectoryDialogConfiguration dirDialogConfiguration = new DirectoryDialogConfiguration.Builder()
+                .withInitialDirectory(filePreferences.getWorkingDirectory())
+                .build();
+
+        Optional<Path> exportDir = dialogService.showDirectorySelectionDialog(dirDialogConfiguration);
+        if (exportDir.isEmpty()) {
+            return;
+        }
+
+        int copiedFiles = 0;
+        int failedCount = 0;
+
+        for (LinkedFile file : linkedFiles) {
+            Optional<Path> srcOpt = file.findIn(databaseContext, filePreferences);
+            if (srcOpt.isEmpty()) {
+                failedCount++;
+                continue;
+            }
+
+            Path src = srcOpt.get();
+            Path dst = resolvePathFilename.apply(exportDir.get(), src);
+
+            if (FileUtil.copyFile(src, dst, false)) {
+                copiedFiles++;
+            } else {
+                failedCount++;
+            }
+        }
+
+        String title = Localization.lang("Copy linked file");
+        String target = exportDir.map(Path::toString).orElse("");
+
+        if (linkedFiles.size() == 1) {
+            if (copiedFiles == 1) {
+                dialogService.notify(Localization.lang("Successfully copied %0 file(s) to %1.", copiedFiles, target));
+            } else {
+                dialogService.showErrorDialogAndWait(
+                        title,
+                        Localization.lang("Could not copy file to %0, maybe the file is already existing?", target));
+            }
+        } else {
+            if (failedCount == 0) {
+                dialogService.notify(Localization.lang("Successfully copied %0 file(s) to %1.", copiedFiles, target));
+            } else {
+                dialogService.showErrorDialogAndWait(
+                        title,
+                        Localization.lang("Copied %0 file(s). Failed: %1", copiedFiles, failedCount));
+            }
+        }
+    }
+
+    private boolean isLocalExisting(LinkedFile lf) {
+        return !lf.isOnlineLink() && lf.findIn(databaseContext, filePreferences).isPresent();
+    }
+
+    private static Observable[] dependencies(Collection<LinkedFile> files) {
+        return files.stream().map(LinkedFile::linkProperty).toArray(Observable[]::new);
+    }
+}

jabgui/src/main/java/org/jabref/gui/fieldeditors/LinkedFileViewModel.java

@@ -203,8 +203,6 @@ public void acceptAsLinked() {
 
     public Observable[] getObservables() {
         List<Observable> observables = new ArrayList<>(Arrays.asList(linkedFile.getObservables()));
-        observables.add(downloadOngoing);
-        observables.add(downloadProgress);
         observables.add(isAutomaticallyFound);
         return observables.toArray(new Observable[0]);
     }
@@ -442,9 +440,15 @@ public void redownload() {
             throw new UnsupportedOperationException("In order to download the file, the source url has to be an online link");
         }
 
+        DownloadLinkedFileAction downloadLinkedFileAction = getDownloadLinkedFileAction();
+        downloadProgress.bind(downloadLinkedFileAction.downloadProgress());
+        downloadLinkedFileAction.execute();
+    }
+
+    private DownloadLinkedFileAction getDownloadLinkedFileAction() {
         String fileName = Path.of(linkedFile.getLink()).getFileName().toString();
 
-        DownloadLinkedFileAction downloadLinkedFileAction = new DownloadLinkedFileAction(
+        return new DownloadLinkedFileAction(
                 databaseContext,
                 entry,
                 linkedFile,
@@ -455,8 +459,6 @@ public void redownload() {
                 taskExecutor,
                 fileName,
                 true);
-        downloadProgress.bind(downloadLinkedFileAction.downloadProgress());
-        downloadLinkedFileAction.execute();
     }
 
     public void download(boolean keepHtmlLink) {