Convert AutoLinkFilesAction to JavaFX

Fixes #4819.
JabRef · Mar 28, 2019 · 9199672 · 9199672
1 parent a731679
commit 9199672
Show file tree

Hide file tree

Showing 6 changed files with 127 additions and 242 deletions.
diff --git a/src/main/java/org/jabref/cli/ArgumentProcessor.java b/src/main/java/org/jabref/cli/ArgumentProcessor.java
@@ -13,7 +13,9 @@
 
 import org.jabref.Globals;
 import org.jabref.JabRefException;
-import org.jabref.gui.externalfiles.AutoSetLinks;
+import org.jabref.gui.externalfiles.AutoSetFileLinksUtil;
+import org.jabref.gui.externalfiletype.ExternalFileTypes;
+import org.jabref.gui.undo.NamedCompound;
 import org.jabref.logic.bibtexkeypattern.BibtexKeyGenerator;
 import org.jabref.logic.exporter.AtomicFileWriter;
 import org.jabref.logic.exporter.BibDatabaseWriter;
@@ -496,7 +498,8 @@ private void automaticallySetFileLinks(List<ParserResult> loaded) {
         for (ParserResult parserResult : loaded) {
             BibDatabase database = parserResult.getDatabase();
             LOGGER.info(Localization.lang("Automatically setting file links"));
-            AutoSetLinks.autoSetLinks(database.getEntries(), parserResult.getDatabaseContext());
+            AutoSetFileLinksUtil util = new AutoSetFileLinksUtil(parserResult.getDatabaseContext(), Globals.prefs.getFilePreferences(), Globals.prefs.getAutoLinkPreferences(), ExternalFileTypes.getInstance());
+            util.linkAssociatedFiles(database.getEntries(), new NamedCompound(""));
         }
     }
 

diff --git a/src/main/java/org/jabref/gui/JabRefFrame.java b/src/main/java/org/jabref/gui/JabRefFrame.java
@@ -56,7 +56,6 @@
 import org.jabref.JabRefExecutorService;
 import org.jabref.gui.actions.ActionFactory;
 import org.jabref.gui.actions.Actions;
-import org.jabref.gui.actions.AutoLinkFilesAction;
 import org.jabref.gui.actions.BibtexKeyPatternAction;
 import org.jabref.gui.actions.ConnectToSharedDatabaseCommand;
 import org.jabref.gui.actions.CopyFilesAction;
@@ -88,6 +87,7 @@
 import org.jabref.gui.exporter.ExportToClipboardAction;
 import org.jabref.gui.exporter.SaveAllAction;
 import org.jabref.gui.exporter.SaveDatabaseAction;
+import org.jabref.gui.externalfiles.AutoLinkFilesAction;
 import org.jabref.gui.externalfiles.FindUnlinkedFilesAction;
 import org.jabref.gui.externalfiletype.ExternalFileTypes;
 import org.jabref.gui.help.AboutAction;
@@ -821,7 +821,7 @@ private MenuBar createMenu() {
 
                 new SeparatorMenuItem(),
 
-                factory.createMenuItem(StandardActions.SET_FILE_LINKS, new AutoLinkFilesAction())
+                factory.createMenuItem(StandardActions.SET_FILE_LINKS, new AutoLinkFilesAction(this, prefs))
         );
 
         PushToApplicationButton pushToExternal = new PushToApplicationButton(this, pushApplications.getApplications());

diff --git a/src/main/java/org/jabref/gui/actions/AutoLinkFilesAction.java b/src/main/java/org/jabref/gui/actions/AutoLinkFilesAction.java
diff --git a/src/main/java/org/jabref/gui/externalfiles/AutoLinkFilesAction.java b/src/main/java/org/jabref/gui/externalfiles/AutoLinkFilesAction.java
@@ -0,0 +1,68 @@
+package org.jabref.gui.externalfiles;
+
+import java.util.List;
+
+import javafx.concurrent.Task;
+
+import org.jabref.gui.DialogService;
+import org.jabref.gui.JabRefFrame;
+import org.jabref.gui.actions.SimpleCommand;
+import org.jabref.gui.externalfiletype.ExternalFileTypes;
+import org.jabref.gui.undo.NamedCompound;
+import org.jabref.logic.l10n.Localization;
+import org.jabref.model.entry.BibEntry;
+import org.jabref.preferences.JabRefPreferences;
+
+/**
+ * This Action may only be used in a menu or button.
+ * Never in the entry editor. FileListEditor and EntryEditor have other ways to update the file links
+ */
+public class AutoLinkFilesAction extends SimpleCommand {
+
+    private final DialogService dialogService;
+    private final JabRefFrame frame;
+    private final JabRefPreferences preferences;
+
+    public AutoLinkFilesAction(JabRefFrame frame, JabRefPreferences preferences) {
+        this.frame = frame;
+        this.dialogService = frame.getDialogService();
+        this.preferences = preferences;
+    }
+
+    @Override
+    public void execute() {
+        List<BibEntry> entries = frame.getCurrentBasePanel().getSelectedEntries();
+        if (entries.isEmpty()) {
+            dialogService.notify(Localization.lang("This operation requires one or more entries to be selected."));
+            return;
+        }
+
+        final NamedCompound nc = new NamedCompound(Localization.lang("Automatically set file links"));
+        AutoSetFileLinksUtil util = new AutoSetFileLinksUtil(frame.getCurrentBasePanel().getBibDatabaseContext(), preferences.getFilePreferences(), preferences.getAutoLinkPreferences(), ExternalFileTypes.getInstance());
+        Task<List<BibEntry>> linkFilesTask = new Task<List<BibEntry>>() {
+            @Override
+            protected List<BibEntry> call() {
+                return util.linkAssociatedFiles(entries, nc);
+            }
+
+            @Override
+            protected void succeeded() {
+                if (!getValue().isEmpty()) {
+                    if (nc.hasEdits()) {
+                        nc.end();
+                        frame.getCurrentBasePanel().getUndoManager().addEdit(nc);
+                    }
+                    dialogService.notify(Localization.lang("Finished automatically setting external links."));
+                } else {
+                    dialogService.notify(Localization.lang("Finished automatically setting external links.") + " " + Localization.lang("No files found."));
+                }
+            }
+        };
+
+        dialogService.showProgressDialogAndWait(
+                Localization.lang("Automatically setting file links"),
+                Localization.lang("Searching for files"),
+                linkFilesTask
+        );
+    }
+}
diff --git a/src/main/java/org/jabref/gui/externalfiles/AutoSetFileLinksUtil.java b/src/main/java/org/jabref/gui/externalfiles/AutoSetFileLinksUtil.java
@@ -11,12 +11,17 @@
 import org.jabref.gui.externalfiletype.ExternalFileType;
 import org.jabref.gui.externalfiletype.ExternalFileTypes;
 import org.jabref.gui.externalfiletype.UnknownExternalFileType;
+import org.jabref.gui.undo.NamedCompound;
+import org.jabref.gui.undo.UndoableFieldChange;
+import org.jabref.gui.util.DefaultTaskExecutor;
 import org.jabref.logic.util.io.AutoLinkPreferences;
 import org.jabref.logic.util.io.FileFinder;
 import org.jabref.logic.util.io.FileFinders;
 import org.jabref.logic.util.io.FileUtil;
 import org.jabref.model.database.BibDatabaseContext;
 import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.FieldName;
+import org.jabref.model.entry.FileFieldWriter;
 import org.jabref.model.entry.LinkedFile;
 import org.jabref.model.metadata.FilePreferences;
 import org.jabref.model.util.FileHelper;
@@ -26,7 +31,7 @@
 
 public class AutoSetFileLinksUtil {
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(AutoSetLinks.class);
+    private static final Logger LOGGER = LoggerFactory.getLogger(AutoSetFileLinksUtil.class);
     private List<Path> directories;
     private AutoLinkPreferences autoLinkPreferences;
     private ExternalFileTypes externalFileTypes;
@@ -35,12 +40,44 @@ public AutoSetFileLinksUtil(BibDatabaseContext databaseContext, FilePreferences
         this(databaseContext.getFileDirectoriesAsPaths(filePreferences), autoLinkPreferences, externalFileTypes);
     }
 
-    public AutoSetFileLinksUtil(List<Path> directories, AutoLinkPreferences autoLinkPreferences, ExternalFileTypes externalFileTypes) {
+    private AutoSetFileLinksUtil(List<Path> directories, AutoLinkPreferences autoLinkPreferences, ExternalFileTypes externalFileTypes) {
         this.directories = directories;
         this.autoLinkPreferences = autoLinkPreferences;
         this.externalFileTypes = externalFileTypes;
     }
 
+    public List<BibEntry> linkAssociatedFiles(List<BibEntry> entries, NamedCompound ce) {
+        List<BibEntry> changedEntries = new ArrayList<>();
+        for (BibEntry entry : entries) {
+
+            List<LinkedFile> linkedFiles = new ArrayList<>();
+            try {
+                linkedFiles = findAssociatedNotLinkedFiles(entry);
+            } catch (IOException e) {
+                LOGGER.error("Problem finding files", e);
+            }
+
+            if (ce != null) {
+                for (LinkedFile linkedFile : linkedFiles) {
+                    // store undo information
+                    String newVal = FileFieldWriter.getStringRepresentation(linkedFile);
+
+                    String oldVal = entry.getField(FieldName.FILE).orElse(null);
+
+                    UndoableFieldChange fieldChange = new UndoableFieldChange(entry, FieldName.FILE, oldVal, newVal);
+                    ce.addEdit(fieldChange);
+
+                    DefaultTaskExecutor.runInJavaFXThread(() -> {
+                        entry.addFile(linkedFile);
+                    });
+                }
+
+                changedEntries.add(entry);
+            }
+        }
+        return changedEntries;
+    }
+
     public List<LinkedFile> findAssociatedNotLinkedFiles(BibEntry entry) throws IOException {
         List<LinkedFile> linkedFiles = new ArrayList<>();
 
@@ -53,22 +90,23 @@ public List<LinkedFile> findAssociatedNotLinkedFiles(BibEntry entry) throws IOEx
         // Collect the found files that are not yet linked
         for (Path foundFile : result) {
             boolean fileAlreadyLinked = entry.getFiles().stream()
-                    .map(file -> file.findIn(directories))
-                    .anyMatch(file -> {
-                        try {
-                            return file.isPresent() && Files.isSameFile(file.get(), foundFile);
-                        } catch (IOException e) {
-                            LOGGER.error("Problem with isSameFile", e);
-                        }
-                        return false;
-                    });
+                                             .map(file -> file.findIn(directories))
+                                             .anyMatch(file -> {
+                                                 try {
+                                                     return file.isPresent() && Files.isSameFile(file.get(), foundFile);
+                                                 } catch (IOException e) {
+                                                     LOGGER.error("Problem with isSameFile", e);
+                                                 }
+                                                 return false;
+                                             });
+
             if (!fileAlreadyLinked) {
                 Optional<ExternalFileType> type = FileHelper.getFileExtension(foundFile)
-                        .map(externalFileTypes::getExternalFileTypeByExt)
-                        .orElse(Optional.of(new UnknownExternalFileType("")));
+                                                            .map(externalFileTypes::getExternalFileTypeByExt)
+                                                            .orElse(Optional.of(new UnknownExternalFileType("")));
 
                 String strType = type.isPresent() ? type.get().getName() : "";
-                String relativeFilePath = FileUtil.relativize(foundFile, directories).toString();
+                Path relativeFilePath = FileUtil.relativize(foundFile, directories);
                 LinkedFile linkedFile = new LinkedFile("", relativeFilePath, strType);
                 linkedFiles.add(linkedFile);
             }