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

CHANGELOG.md

@@ -28,6 +28,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We added "copy preview as markdown" feature. [#12552](https://github.com/JabRef/jabref/issues/12552)
 - In case no citation relation information can be fetched, we show the data providers reason. [#13549](https://github.com/JabRef/jabref/pull/13549)
 - We added a new button for shortening the DOI near the DOI field in the general tab when viewing an entry. [#13639](https://github.com/JabRef/jabref/issues/13639)
+- We added support for managing multiple linked files via the entry context menu. [#12567](https://github.com/JabRef/jabref/issues/12567)
 
 ### Changed
 

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

@@ -106,7 +106,9 @@ public enum StandardActions implements Action {
 
     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_FOLDERS(Localization.lang("Open folders"), Localization.lang("Open folders"), IconTheme.JabRefIcons.FOLDER, KeyBinding.OPEN_FOLDER),
     OPEN_FILE(Localization.lang("Open file"), Localization.lang("Open file"), IconTheme.JabRefIcons.FILE, KeyBinding.OPEN_FILE),
+    OPEN_FILES(Localization.lang("Open files"), Localization.lang("Open files"), 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")),
@@ -160,15 +162,20 @@ public enum StandardActions implements Action {
 
     EDIT_FILE_LINK(Localization.lang("Edit"), IconTheme.JabRefIcons.EDIT, KeyBinding.OPEN_CLOSE_ENTRY_EDITOR),
     DOWNLOAD_FILE(Localization.lang("Download file"), IconTheme.JabRefIcons.DOWNLOAD_FILE),
+    DOWNLOAD_FILES(Localization.lang("Download files"), IconTheme.JabRefIcons.DOWNLOAD_FILE),
     REDOWNLOAD_FILE(Localization.lang("Redownload file"), IconTheme.JabRefIcons.DOWNLOAD_FILE),
+    REDOWNLOAD_FILES(Localization.lang("Redownload files"), 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),
+    MOVE_FILES_TO_FOLDER(Localization.lang("Move files 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_FILES_TO_FOLDER(Localization.lang("Copy linked files 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_FILES(Localization.lang("Permanently delete local files"), 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/CopyMultipleFilesAction.java

@@ -0,0 +1,89 @@
+package org.jabref.gui.copyfiles;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.StandardCopyOption;
+import java.util.Objects;
+import java.util.Optional;
+
+import javafx.beans.binding.Bindings;
+import javafx.collections.ObservableList;
+
+import org.jabref.gui.DialogService;
+import org.jabref.gui.actions.SimpleCommand;
+import org.jabref.gui.fieldeditors.LinkedFileViewModel;
+import org.jabref.gui.util.DirectoryDialogConfiguration;
+import org.jabref.logic.FilePreferences;
+import org.jabref.logic.l10n.Localization;
+import org.jabref.model.database.BibDatabaseContext;
+
+public class CopyMultipleFilesAction extends SimpleCommand {
+
+    private final ObservableList<LinkedFileViewModel> selectedFiles;
+    private final DialogService dialogService;
+    private final BibDatabaseContext databaseContext;
+    private final FilePreferences filePreferences;
+
+    public CopyMultipleFilesAction(ObservableList<LinkedFileViewModel> selectedFiles,
+                                   DialogService dialogService,
+                                   BibDatabaseContext databaseContext,
+                                   FilePreferences filePreferences) {
+        this.selectedFiles = Objects.requireNonNull(selectedFiles);
+        this.dialogService = Objects.requireNonNull(dialogService);
+        this.databaseContext = Objects.requireNonNull(databaseContext);
+        this.filePreferences = Objects.requireNonNull(filePreferences);
+        this.executable.bind(Bindings.createBooleanBinding(
+                () -> !selectedFiles.isEmpty() && selectedFiles.stream().allMatch(vm ->
+                        !vm.getFile().isOnlineLink()
+                                && vm.getFile().findIn(databaseContext, filePreferences).isPresent()),
+                selectedFiles
+        ));
+    }
+
+    @Override
+    public void execute() {
+        DirectoryDialogConfiguration conf = new DirectoryDialogConfiguration.Builder().build();
+        dialogService.showDirectorySelectionDialog(conf).ifPresent(this::copyAllTo);
+    }
+
+    private void copyAllTo(Path targetDir) {
+        try {
+            Files.createDirectories(targetDir);
+        } catch (IOException e) {
+            dialogService.showErrorDialogAndWait(Localization.lang("Cannot create directory '%0'", targetDir));
+            return;
+        }
+
+        int copied = 0;
+
+        for (LinkedFileViewModel vm : selectedFiles) {
+            Optional<Path> srcOpt = vm.getFile().findIn(databaseContext, filePreferences);
+            if (srcOpt.isEmpty()) {
+                continue;
+            }
+
+            Path src = srcOpt.get();
+            Path dst = targetDir.resolve(src.getFileName());
+
+            if (Files.exists(dst) && Files.isDirectory(dst)) {
+                IOException ex = new IOException("Destination is a directory: " + dst);
+                dialogService.showErrorDialogAndWait(
+                        Localization.lang("Cannot copy '%0' to '%1'", src, dst), ex);
+                continue;
+            }
+
+            try {
+                Files.copy(src, dst, StandardCopyOption.REPLACE_EXISTING);
+                copied++;
+            } catch (IOException ex) {
+                dialogService.showErrorDialogAndWait(
+                        Localization.lang("Cannot copy '%0' to '%1'", src, dst), ex);
+            }
+        }
+
+        if (copied > 0) {
+            dialogService.notify(Localization.lang("Copied %0 file(s) to %1", copied, targetDir));
+        }
+    }
+}

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

@@ -203,8 +203,11 @@ public void acceptAsLinked() {
 
     public Observable[] getObservables() {
         List<Observable> observables = new ArrayList<>(Arrays.asList(linkedFile.getObservables()));
+        /*
+        Fix: JavaFX crashes with these 2 options lower while multi-downloading 2 or more files
         observables.add(downloadOngoing);
         observables.add(downloadProgress);
+        */
         observables.add(isAutomaticallyFound);
         return observables.toArray(new Observable[0]);
     }

jabgui/src/main/java/org/jabref/gui/fieldeditors/contextmenu/ContextAction.java

@@ -59,15 +59,23 @@ public ContextAction(StandardActions command,
     public void execute() {
         switch (command) {
             case EDIT_FILE_LINK -> linkedFile.edit();
-            case OPEN_FILE -> linkedFile.open();
-            case OPEN_FOLDER -> linkedFile.openFolder();
-            case DOWNLOAD_FILE -> linkedFile.download(true);
-            case REDOWNLOAD_FILE -> linkedFile.redownload();
+            case OPEN_FILE, OPEN_FILES -> linkedFile.open();
+            case OPEN_FOLDER, OPEN_FOLDERS -> linkedFile.openFolder();
+            case DOWNLOAD_FILE, DOWNLOAD_FILES -> {
+                if (linkedFile.getFile().isOnlineLink()) {
+                    linkedFile.download(true);
+                }
+            }
+            case REDOWNLOAD_FILE, REDOWNLOAD_FILES -> {
+                if (!linkedFile.getFile().getSourceUrl().isEmpty()) {
+                    linkedFile.redownload();
+                }
+            }
             case RENAME_FILE_TO_PATTERN -> linkedFile.renameToSuggestion();
             case RENAME_FILE_TO_NAME -> linkedFile.askForNameAndRename();
-            case MOVE_FILE_TO_FOLDER -> linkedFile.moveToDefaultDirectory();
+            case MOVE_FILE_TO_FOLDER, MOVE_FILES_TO_FOLDER -> linkedFile.moveToDefaultDirectory();
             case MOVE_FILE_TO_FOLDER_AND_RENAME -> linkedFile.moveToDefaultDirectoryAndRename();
-            case DELETE_FILE -> viewModel.deleteFile(linkedFile);
+            case DELETE_FILE, DELETE_FILES -> viewModel.deleteFile(linkedFile);
             case REMOVE_LINK, REMOVE_LINKS -> viewModel.removeFileLink(linkedFile);
         }
     }

jabgui/src/main/java/org/jabref/gui/fieldeditors/contextmenu/ContextMenuFactory.java

@@ -7,6 +7,7 @@
 import org.jabref.gui.DialogService;
 import org.jabref.gui.actions.ActionFactory;
 import org.jabref.gui.actions.StandardActions;
+import org.jabref.gui.copyfiles.CopyMultipleFilesAction;
 import org.jabref.gui.copyfiles.CopySingleFileAction;
 import org.jabref.gui.fieldeditors.LinkedFileViewModel;
 import org.jabref.gui.fieldeditors.LinkedFilesEditorViewModel;
@@ -21,8 +22,6 @@ public class ContextMenuFactory {
     private final DialogService dialogService;
     private final GuiPreferences preferences;
     private final BibDatabaseContext databaseContext;
-    private final ObservableOptionalValue<BibEntry> bibEntry;
-    private final LinkedFilesEditorViewModel viewModel;
     private final SingleContextCommandFactory singleCommandFactory;
     private final MultiContextCommandFactory multiCommandFactory;
 
@@ -36,8 +35,6 @@ public ContextMenuFactory(DialogService dialogService,
         this.dialogService = dialogService;
         this.preferences = preferences;
         this.databaseContext = databaseContext;
-        this.bibEntry = bibEntry;
-        this.viewModel = viewModel;
         this.singleCommandFactory = singleCommandFactory;
         this.multiCommandFactory = multiCommandFactory;
     }
@@ -56,10 +53,33 @@ private ContextMenu createContextMenuForMultiFile(ObservableList<LinkedFileViewM
         ActionFactory factory = new ActionFactory();
 
         menu.getItems().addAll(
+                factory.createMenuItem(
+                        StandardActions.OPEN_FILES,
+                        multiCommandFactory.build(StandardActions.OPEN_FILES, selectedFiles)),
+                factory.createMenuItem(
+                        StandardActions.OPEN_FOLDERS,
+                        multiCommandFactory.build(StandardActions.OPEN_FOLDERS, selectedFiles)),
+                new SeparatorMenuItem(),
+                factory.createMenuItem(
+                        StandardActions.DOWNLOAD_FILES,
+                        multiCommandFactory.build(StandardActions.DOWNLOAD_FILES, selectedFiles)),
+                factory.createMenuItem(
+                        StandardActions.REDOWNLOAD_FILES,
+                        multiCommandFactory.build(StandardActions.REDOWNLOAD_FILES, selectedFiles)),
+                new SeparatorMenuItem(),
+                factory.createMenuItem(
+                        StandardActions.MOVE_FILES_TO_FOLDER,
+                        multiCommandFactory.build(StandardActions.MOVE_FILES_TO_FOLDER, selectedFiles)),
+                factory.createMenuItem(
+                        StandardActions.COPY_FILES_TO_FOLDER,
+                        new CopyMultipleFilesAction(selectedFiles, dialogService, databaseContext, preferences.getFilePreferences())),
+                new SeparatorMenuItem(),
                 factory.createMenuItem(
                         StandardActions.REMOVE_LINKS,
-                        multiCommandFactory.build(StandardActions.REMOVE_LINKS, selectedFiles)
-                )
+                        multiCommandFactory.build(StandardActions.REMOVE_LINKS, selectedFiles)),
+                factory.createMenuItem(
+                        StandardActions.DELETE_FILES,
+                        multiCommandFactory.build(StandardActions.DELETE_FILES, selectedFiles))
         );
 
         return menu;