From eaabae59ce3858290b7787d8fbdf06a8e8f14506 Mon Sep 17 00:00:00 2001
From: Christoph <siedlerkiller@gmail.com>
Date: Mon, 4 Sep 2023 15:35:56 +0200
Subject: [PATCH] Push to external application config (#10303)

* Introduce SelfContainedSaveConfiguration

* prepare adding cite key delimiter and start end chars

* Fix checkstyle

* Fix NPE

* add preferences and text fields

* fix sublime escaping

* fix emacs

* add

* fix checkstyle

* fix imports

* checkstyle

* checkstyle the xt

* Update JabRef_en.properties

* Introduced dissectCiteCommand

* Fixed compile

* fix cite key and add error logger

* fix npe

* fix

* fix index of

* Update JabRef_en.properties

fix l10n

* fix texstudio insert

* Shorten localization strings for emacs (and group the pushing localization)

* Rename "couldNotConnect" to "couldNotPush"

* Some debug

* New variable pushToApplicationPreferences

* Works on Windows

* Use "replace" instead of "replaceAll"

* Shorten messages for Vim

* Add logger to Vim execution, too

* Style: LOGGER first

* Modified test for linux

* Make emacs test "portable"

* Fix localization language

---------

Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>
Co-authored-by: Carl Christian Snethlage <50491877+calixtus@users.noreply.github.com>
---
 src/main/java/org/jabref/gui/JabRefFrame.java |  4 +-
 .../gui/preferences/external/ExternalTab.fxml |  2 +-
 .../gui/preferences/external/ExternalTab.java |  1 +
 .../external/ExternalTabViewModel.java        |  2 -
 .../gui/push/AbstractPushToApplication.java   | 48 +++++++++++++--
 .../jabref/gui/push/PushToApplication.java    |  2 +
 .../gui/push/PushToApplicationCommand.java    | 15 +++--
 .../java/org/jabref/gui/push/PushToEmacs.java | 58 ++++++++++++-------
 .../java/org/jabref/gui/push/PushToLyx.java   |  6 +-
 .../jabref/gui/push/PushToSublimeText.java    | 12 +++-
 .../org/jabref/gui/push/PushToTeXstudio.java  |  2 +-
 .../org/jabref/gui/push/PushToTexmaker.java   |  2 +-
 .../java/org/jabref/gui/push/PushToVim.java   | 23 +++++---
 .../org/jabref/gui/push/PushToWinEdt.java     |  2 +-
 .../ExternalApplicationsPreferences.java      |  1 +
 .../jabref/preferences/JabRefPreferences.java |  6 +-
 src/main/resources/l10n/JabRef_en.properties  | 16 ++---
 .../org/jabref/gui/push/PushToEmacsTest.java  | 54 +++++++++++++++++
 18 files changed, 191 insertions(+), 65 deletions(-)
 create mode 100644 src/test/java/org/jabref/gui/push/PushToEmacsTest.java

diff --git a/src/main/java/org/jabref/gui/JabRefFrame.java b/src/main/java/org/jabref/gui/JabRefFrame.java
index 9179188d593..e789ffa10c8 100644
--- a/src/main/java/org/jabref/gui/JabRefFrame.java
+++ b/src/main/java/org/jabref/gui/JabRefFrame.java
@@ -123,9 +123,9 @@ public JabRefFrame(Stage mainStage) {
         this.fileUpdateMonitor = Globals.getFileUpdateMonitor();
         this.entryTypesManager = Globals.entryTypesManager;
         this.globalSearchBar = new GlobalSearchBar(this, stateManager, prefs, undoManager, dialogService);
-        this.pushToApplicationCommand = new PushToApplicationCommand(stateManager, dialogService, prefs);
-        this.fileHistory = new FileHistoryMenu(prefs.getGuiPreferences().getFileHistory(), dialogService, getOpenDatabaseAction());
         this.taskExecutor = Globals.TASK_EXECUTOR;
+        this.pushToApplicationCommand = new PushToApplicationCommand(stateManager, dialogService, prefs, taskExecutor);
+        this.fileHistory = new FileHistoryMenu(prefs.getGuiPreferences().getFileHistory(), dialogService, getOpenDatabaseAction());
         this.setOnKeyTyped(key -> {
             if (this.fileHistory.isShowing()) {
                 if (this.fileHistory.openFileByKey(key)) {
diff --git a/src/main/java/org/jabref/gui/preferences/external/ExternalTab.fxml b/src/main/java/org/jabref/gui/preferences/external/ExternalTab.fxml
index baed6346b4d..e96004acdcd 100644
--- a/src/main/java/org/jabref/gui/preferences/external/ExternalTab.fxml
+++ b/src/main/java/org/jabref/gui/preferences/external/ExternalTab.fxml
@@ -55,7 +55,7 @@
 
             <Label text="%Cite command" GridPane.rowIndex="2"/>
             <TextField fx:id="citeCommand"
-                       prefWidth="200.0" GridPane.columnIndex="1" GridPane.rowIndex="2"/>
+                       prefWidth="300.0" GridPane.columnIndex="1" GridPane.rowIndex="2"/>
         </GridPane>
     </HBox>
 
diff --git a/src/main/java/org/jabref/gui/preferences/external/ExternalTab.java b/src/main/java/org/jabref/gui/preferences/external/ExternalTab.java
index 82368139cf9..df11e6f912c 100644
--- a/src/main/java/org/jabref/gui/preferences/external/ExternalTab.java
+++ b/src/main/java/org/jabref/gui/preferences/external/ExternalTab.java
@@ -23,6 +23,7 @@ public class ExternalTab extends AbstractPreferenceTabView<ExternalTabViewModel>
     @FXML private CheckBox autoOpenAttachedFolders;
     @FXML private ComboBox<PushToApplication> pushToApplicationCombo;
     @FXML private TextField citeCommand;
+
     @FXML private CheckBox useCustomTerminal;
     @FXML private TextField customTerminalCommand;
     @FXML private Button customTerminalBrowse;
diff --git a/src/main/java/org/jabref/gui/preferences/external/ExternalTabViewModel.java b/src/main/java/org/jabref/gui/preferences/external/ExternalTabViewModel.java
index 3700f93b5e4..59308f47c46 100644
--- a/src/main/java/org/jabref/gui/preferences/external/ExternalTabViewModel.java
+++ b/src/main/java/org/jabref/gui/preferences/external/ExternalTabViewModel.java
@@ -210,8 +210,6 @@ public StringProperty citeCommandProperty() {
         return this.citeCommandProperty;
     }
 
-    // Open console
-
     public BooleanProperty useCustomTerminalProperty() {
         return this.useCustomTerminalProperty;
     }
diff --git a/src/main/java/org/jabref/gui/push/AbstractPushToApplication.java b/src/main/java/org/jabref/gui/push/AbstractPushToApplication.java
index 5c3ceeac981..aa84c74d3e9 100644
--- a/src/main/java/org/jabref/gui/push/AbstractPushToApplication.java
+++ b/src/main/java/org/jabref/gui/push/AbstractPushToApplication.java
@@ -26,9 +26,11 @@
 public abstract class AbstractPushToApplication implements PushToApplication {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(AbstractPushToApplication.class);
+    private static final String CITE_KEY1 = "key1";
+    private static final String CITE_KEY2 = "key2";
 
     protected boolean couldNotCall; // Set to true in case the command could not be executed, e.g., if the file is not found
-    protected boolean couldNotConnect; // Set to true in case the tunnel to the program (if one is used) does not operate
+    protected boolean couldNotPush; // Set to true in case the tunnel to the program (if one is used) does not operate
     protected boolean notDefined; // Set to true if the corresponding path is not defined in the preferences
 
     protected String commandPath;
@@ -36,11 +38,36 @@ public abstract class AbstractPushToApplication implements PushToApplication {
     protected final DialogService dialogService;
     protected final PreferencesService preferencesService;
 
+    private String cachedCiteCommand;
+    private String cachedCitePrefix;
+    private String cachedCiteSuffix;
+    private String cachedCiteDelimiter;
+
     public AbstractPushToApplication(DialogService dialogService, PreferencesService preferencesService) {
         this.dialogService = dialogService;
         this.preferencesService = preferencesService;
     }
 
+    private void dissectCiteCommand() {
+        String preferencesCiteCommand = preferencesService.getExternalApplicationsPreferences().getCiteCommand();
+
+        if (preferencesCiteCommand != null && preferencesCiteCommand.equals(cachedCiteCommand)) {
+            return;
+        }
+
+        cachedCiteCommand = preferencesCiteCommand;
+
+        int indexKey1 = cachedCiteCommand.indexOf(CITE_KEY1);
+        int indexKey2 = cachedCiteCommand.indexOf(CITE_KEY2);
+        if (indexKey1 < 0 || indexKey2 < 0 || indexKey2 < (indexKey1 + CITE_KEY1.length())) {
+            return;
+        }
+
+        cachedCitePrefix = preferencesCiteCommand.substring(0, indexKey1);
+        cachedCiteDelimiter = preferencesCiteCommand.substring(preferencesCiteCommand.lastIndexOf(CITE_KEY1) + CITE_KEY1.length(), indexKey2);
+        cachedCiteSuffix = preferencesCiteCommand.substring(preferencesCiteCommand.lastIndexOf(CITE_KEY2) + CITE_KEY2.length());
+    }
+
     @Override
     public JabRefIcon getApplicationIcon() {
         return IconTheme.JabRefIcons.APPLICATION_GENERIC;
@@ -58,7 +85,7 @@ public Action getAction() {
 
     @Override
     public void pushEntries(BibDatabaseContext database, List<BibEntry> entries, String keyString) {
-        couldNotConnect = false;
+        couldNotPush = false;
         couldNotCall = false;
         notDefined = false;
 
@@ -108,7 +135,7 @@ public void onOperationCompleted() {
             dialogService.showErrorDialogAndWait(
                     Localization.lang("Error pushing entries"),
                     Localization.lang("Could not call executable") + " '" + commandPath + "'.");
-        } else if (couldNotConnect) {
+        } else if (couldNotPush) {
             dialogService.showErrorDialogAndWait(
                     Localization.lang("Error pushing entries"),
                     Localization.lang("Could not connect to %0", getDisplayName()) + ".");
@@ -142,8 +169,19 @@ protected String getCommandName() {
         return null;
     }
 
-    protected String getCiteCommand() {
-        return preferencesService.getExternalApplicationsPreferences().getCiteCommand();
+    protected String getCitePrefix() {
+        dissectCiteCommand();
+        return cachedCitePrefix;
+    }
+
+    public String getDelimiter() {
+        dissectCiteCommand();
+        return cachedCiteDelimiter;
+    }
+
+    protected String getCiteSuffix() {
+        dissectCiteCommand();
+        return cachedCiteSuffix;
     }
 
     @Override
diff --git a/src/main/java/org/jabref/gui/push/PushToApplication.java b/src/main/java/org/jabref/gui/push/PushToApplication.java
index 3b409717c2c..b7d5223e83d 100644
--- a/src/main/java/org/jabref/gui/push/PushToApplication.java
+++ b/src/main/java/org/jabref/gui/push/PushToApplication.java
@@ -41,4 +41,6 @@ public interface PushToApplication {
     Action getAction();
 
     PushToApplicationSettings getSettings(PushToApplication application, PushToApplicationPreferences pushToApplicationPreferences);
+
+    String getDelimiter();
 }
diff --git a/src/main/java/org/jabref/gui/push/PushToApplicationCommand.java b/src/main/java/org/jabref/gui/push/PushToApplicationCommand.java
index 1c5f1ee5e10..21be03170ec 100644
--- a/src/main/java/org/jabref/gui/push/PushToApplicationCommand.java
+++ b/src/main/java/org/jabref/gui/push/PushToApplicationCommand.java
@@ -9,13 +9,13 @@
 import javafx.scene.control.MenuItem;
 
 import org.jabref.gui.DialogService;
-import org.jabref.gui.Globals;
 import org.jabref.gui.StateManager;
 import org.jabref.gui.actions.Action;
 import org.jabref.gui.actions.ActionFactory;
 import org.jabref.gui.actions.SimpleCommand;
 import org.jabref.gui.util.BackgroundTask;
 import org.jabref.gui.util.BindingsHelper;
+import org.jabref.gui.util.TaskExecutor;
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.database.BibDatabaseContext;
 import org.jabref.model.entry.BibEntry;
@@ -41,13 +41,15 @@ public class PushToApplicationCommand extends SimpleCommand {
     private final PreferencesService preferencesService;
 
     private final List<Object> reconfigurableControls = new ArrayList<>();
+    private final TaskExecutor taskExecutor;
 
     private PushToApplication application;
 
-    public PushToApplicationCommand(StateManager stateManager, DialogService dialogService, PreferencesService preferencesService) {
+    public PushToApplicationCommand(StateManager stateManager, DialogService dialogService, PreferencesService preferencesService, TaskExecutor taskExecutor) {
         this.stateManager = stateManager;
         this.dialogService = dialogService;
         this.preferencesService = preferencesService;
+        this.taskExecutor = taskExecutor;
 
         setApplication(preferencesService.getPushToApplicationPreferences()
                                                             .getActiveApplicationName());
@@ -95,7 +97,7 @@ public Action getAction() {
         return application.getAction();
     }
 
-    private static String getKeyString(List<BibEntry> entries) {
+    private static String getKeyString(List<BibEntry> entries, String delimiter) {
         StringBuilder result = new StringBuilder();
         Optional<String> citeKey;
         boolean first = true;
@@ -109,7 +111,7 @@ private static String getKeyString(List<BibEntry> entries) {
                 result.append(citeKey.get());
                 first = false;
             } else {
-                result.append(',').append(citeKey.get());
+                result.append(delimiter).append(citeKey.get());
             }
         }
         return result.toString();
@@ -132,11 +134,12 @@ public void execute() {
         // All set, call the operation in a new thread:
         BackgroundTask.wrap(this::pushEntries)
                       .onSuccess(s -> application.onOperationCompleted())
-                      .executeWith(Globals.TASK_EXECUTOR);
+                      .onFailure(ex -> LOGGER.error("Error pushing citation", ex))
+                      .executeWith(taskExecutor);
     }
 
     private void pushEntries() {
         BibDatabaseContext database = stateManager.getActiveDatabase().orElseThrow(() -> new NullPointerException("Database null"));
-        application.pushEntries(database, stateManager.getSelectedEntries(), getKeyString(stateManager.getSelectedEntries()));
+        application.pushEntries(database, stateManager.getSelectedEntries(), getKeyString(stateManager.getSelectedEntries(), application.getDelimiter()));
     }
 }
diff --git a/src/main/java/org/jabref/gui/push/PushToEmacs.java b/src/main/java/org/jabref/gui/push/PushToEmacs.java
index 0ee71acdf45..1b9afb42af8 100644
--- a/src/main/java/org/jabref/gui/push/PushToEmacs.java
+++ b/src/main/java/org/jabref/gui/push/PushToEmacs.java
@@ -2,6 +2,7 @@
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.util.Arrays;
 import java.util.List;
 
 import org.jabref.gui.DialogService;
@@ -24,6 +25,9 @@ public class PushToEmacs extends AbstractPushToApplication {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(PushToEmacs.class);
 
+    /**
+     * @param preferencesService getPushToApplicationPreferences(), getExternalApplicationsPreferences(), and getFilePreferences() are used
+     */
     public PushToEmacs(DialogService dialogService, PreferencesService preferencesService) {
         super(dialogService, preferencesService);
     }
@@ -40,43 +44,60 @@ public JabRefIcon getApplicationIcon() {
 
     @Override
     public void pushEntries(BibDatabaseContext database, List<BibEntry> entries, String keys) {
-        couldNotConnect = false;
+        couldNotPush = false;
         couldNotCall = false;
         notDefined = false;
 
-        commandPath = preferencesService.getPushToApplicationPreferences().getCommandPaths().get(this.getDisplayName());
+        PushToApplicationPreferences pushToApplicationPreferences = preferencesService.getPushToApplicationPreferences();
+
+        commandPath = pushToApplicationPreferences.getCommandPaths().get(this.getDisplayName());
 
         if ((commandPath == null) || commandPath.trim().isEmpty()) {
             notDefined = true;
             return;
         }
 
-        commandPath = preferencesService.getPushToApplicationPreferences().getCommandPaths().get(this.getDisplayName());
+        commandPath = pushToApplicationPreferences.getCommandPaths().get(this.getDisplayName());
 
-        String[] addParams = preferencesService.getPushToApplicationPreferences().getEmacsArguments().split(" ");
+        String[] addParams = pushToApplicationPreferences.getEmacsArguments().split(" ");
         try {
             String[] com = new String[addParams.length + 2];
             com[0] = commandPath;
             System.arraycopy(addParams, 0, com, 1, addParams.length);
-            String prefix;
-            String suffix;
-            prefix = "(with-current-buffer (window-buffer) (insert ";
-            suffix = "))";
+
+            // Surrounding with is handled below
+            String prefix = "(with-current-buffer (window-buffer (selected-window)) (insert ";
+            String suffix = "))";
 
             if (OS.WINDOWS) {
                 // Windows gnuclient/emacsclient escaping:
                 // java string: "(insert \\\"\\\\cite{Blah2001}\\\")";
                 // so cmd receives: (insert \"\\cite{Blah2001}\")
                 // so emacs receives: (insert "\cite{Blah2001}")
-                com[com.length - 1] = prefix.concat("\\\"\\" + getCiteCommand().replaceAll("\\\\", "\\\\\\\\") + "{" + keys + "}\\\"").concat(suffix);
+
+                com[com.length - 1] = prefix.concat("\""
+                                                    + getCitePrefix().replace("\\", "\\\\")
+                                                    + keys
+                                                    + getCiteSuffix().replace("\\", "\\\\")
+                                                    + "\"").concat(suffix)
+                                            .replace("\"", "\\\"");
             } else {
                 // Linux gnuclient/emacslient escaping:
                 // java string: "(insert \"\\\\cite{Blah2001}\")"
                 // so sh receives: (insert "\\cite{Blah2001}")
                 // so emacs receives: (insert "\cite{Blah2001}")
-                com[com.length - 1] = prefix.concat("\"" + getCiteCommand().replaceAll("\\\\", "\\\\\\\\") + "{" + keys + "}\"").concat(suffix);
+                com[com.length - 1] = prefix.concat("\""
+                                                    + getCitePrefix().replace("\\", "\\\\")
+                                                    + keys
+                                                    + getCiteSuffix().replace("\\", "\\\\")
+                                                    + "\"").concat(suffix);
             }
 
+            LOGGER.atDebug()
+                  .setMessage("Executing command {}")
+                  .addArgument(() -> Arrays.toString(com))
+                  .log();
+
             final Process p = Runtime.getRuntime().exec(com);
 
             JabRefExecutorService.INSTANCE.executeAndWait(() -> {
@@ -92,30 +113,27 @@ public void pushEntries(BibDatabaseContext database, List<BibEntry> entries, Str
                     }
                     // Error stream has been closed. See if there were any errors:
                     if (!sb.toString().trim().isEmpty()) {
-                        LOGGER.warn("Push to Emacs error: " + sb);
-                        couldNotConnect = true;
+                        LOGGER.warn("Push to Emacs error: {}", sb);
+                        couldNotPush = true;
                     }
                 } catch (IOException e) {
-                    LOGGER.warn("File problem.", e);
+                    LOGGER.warn("Error handling std streams", e);
                 }
             });
         } catch (IOException excep) {
-            couldNotCall = true;
             LOGGER.warn("Problem pushing to Emacs.", excep);
+            couldNotCall = true;
         }
     }
 
     @Override
     public void onOperationCompleted() {
-        if (couldNotConnect) {
+        if (couldNotPush) {
             dialogService.showErrorDialogAndWait(Localization.lang("Error pushing entries"),
-                    Localization.lang("Could not connect to a running gnuserv process. Make sure that "
-                            + "Emacs or XEmacs is running, and that the server has been started "
-                            + "(by running the command 'server-start'/'gnuserv-start')."));
+                    Localization.lang("Could not push to a running emacs daemon."));
         } else if (couldNotCall) {
             dialogService.showErrorDialogAndWait(Localization.lang("Error pushing entries"),
-                    Localization.lang("Could not run the gnuclient/emacsclient program. Make sure you have "
-                            + "the emacsclient/gnuclient program installed and available in the PATH."));
+                    Localization.lang("Could not run the emacs client."));
         } else {
             super.onOperationCompleted();
         }
diff --git a/src/main/java/org/jabref/gui/push/PushToLyx.java b/src/main/java/org/jabref/gui/push/PushToLyx.java
index 02a043f30a7..9277529d592 100644
--- a/src/main/java/org/jabref/gui/push/PushToLyx.java
+++ b/src/main/java/org/jabref/gui/push/PushToLyx.java
@@ -42,7 +42,7 @@ public JabRefIcon getApplicationIcon() {
 
     @Override
     public void onOperationCompleted() {
-        if (couldNotConnect) {
+        if (couldNotPush) {
             dialogService.showErrorDialogAndWait(Localization.lang("Error pushing entries"),
                     Localization.lang("Verify that LyX is running and that the lyxpipe is valid.")
                             + "[" + commandPath + "]");
@@ -60,7 +60,7 @@ public PushToApplicationSettings getSettings(PushToApplication application, Push
 
     @Override
     public void pushEntries(BibDatabaseContext database, final List<BibEntry> entries, final String keyString) {
-        couldNotConnect = false;
+        couldNotPush = false;
         couldNotCall = false;
         notDefined = false;
 
@@ -79,7 +79,7 @@ public void pushEntries(BibDatabaseContext database, final List<BibEntry> entrie
             // See if it helps to append ".in":
             lp = new File(commandPath + ".in");
             if (!lp.exists() || !lp.canWrite()) {
-                couldNotConnect = true;
+                couldNotPush = true;
                 return;
             }
         }
diff --git a/src/main/java/org/jabref/gui/push/PushToSublimeText.java b/src/main/java/org/jabref/gui/push/PushToSublimeText.java
index 56567bf76b6..2096ae1e8bb 100644
--- a/src/main/java/org/jabref/gui/push/PushToSublimeText.java
+++ b/src/main/java/org/jabref/gui/push/PushToSublimeText.java
@@ -41,7 +41,7 @@ public JabRefIcon getApplicationIcon() {
 
     @Override
     public void pushEntries(BibDatabaseContext database, List<BibEntry> entries, String keyString) {
-        couldNotConnect = false;
+        couldNotPush = false;
         couldNotCall = false;
         notDefined = false;
 
@@ -74,11 +74,17 @@ public void pushEntries(BibDatabaseContext database, List<BibEntry> entries, Str
 
     @Override
     protected String[] getCommandLine(String keyString) {
+        String citeCommand = getCitePrefix();
+        // we need to escape the extra slashses
+        if (getCitePrefix().contains("\\")) {
+            citeCommand = "\"\\" + getCitePrefix();
+        }
+
         if (OS.WINDOWS) {
             // TODO we might need to escape the inner double quotes with """ """
-            return new String[] {"cmd.exe", "/c", "\"" + commandPath + "\"" + "--command \"insert {\\\"characters\\\": \"\\" + getCiteCommand() + "{" + keyString + "}\"}\""};
+            return new String[] {"cmd.exe", "/c", "\"" + commandPath + "\"" + "--command \"insert {\\\"characters\\\": \"\\" + getCitePrefix() + keyString + getCiteSuffix() + "\"}\""};
         } else {
-            return new String[] {"sh", "-c", "\"" + commandPath + "\"" + " --command 'insert {\"characters\": \"\\" + getCiteCommand() + "{" + keyString + "}\"}'"};
+            return new String[] {"sh", "-c", "\"" + commandPath + "\"" + " --command 'insert {\"characters\": \"" + citeCommand + keyString + getCiteSuffix() + "\"}'"};
         }
     }
 }
diff --git a/src/main/java/org/jabref/gui/push/PushToTeXstudio.java b/src/main/java/org/jabref/gui/push/PushToTeXstudio.java
index ad355f8fc69..a7a0a1657f1 100644
--- a/src/main/java/org/jabref/gui/push/PushToTeXstudio.java
+++ b/src/main/java/org/jabref/gui/push/PushToTeXstudio.java
@@ -25,6 +25,6 @@ public JabRefIcon getApplicationIcon() {
 
     @Override
     protected String[] getCommandLine(String keyString) {
-        return new String[] {commandPath, "--insert-cite", String.format("%s{%s}", getCiteCommand(), keyString)};
+        return new String[] {commandPath, "--insert-cite", String.format("%s%s%s", getCitePrefix(), keyString, getCiteSuffix())};
     }
 }
diff --git a/src/main/java/org/jabref/gui/push/PushToTexmaker.java b/src/main/java/org/jabref/gui/push/PushToTexmaker.java
index d7592b3d953..eccecdc5cff 100644
--- a/src/main/java/org/jabref/gui/push/PushToTexmaker.java
+++ b/src/main/java/org/jabref/gui/push/PushToTexmaker.java
@@ -28,6 +28,6 @@ public JabRefIcon getApplicationIcon() {
 
     @Override
     protected String[] getCommandLine(String keyString) {
-        return new String[] {commandPath, "-insert", getCiteCommand() + "{" + keyString + "}"};
+        return new String[] {commandPath, "-insert", getCitePrefix() + keyString + getCiteSuffix()};
     }
 }
diff --git a/src/main/java/org/jabref/gui/push/PushToVim.java b/src/main/java/org/jabref/gui/push/PushToVim.java
index 219e5d3537a..c31077a6671 100644
--- a/src/main/java/org/jabref/gui/push/PushToVim.java
+++ b/src/main/java/org/jabref/gui/push/PushToVim.java
@@ -2,6 +2,7 @@
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.util.Arrays;
 import java.util.List;
 
 import org.jabref.gui.DialogService;
@@ -44,7 +45,7 @@ public PushToApplicationSettings getSettings(PushToApplication application, Push
 
     @Override
     public void pushEntries(BibDatabaseContext database, List<BibEntry> entries, String keys) {
-        couldNotConnect = false;
+        couldNotPush = false;
         couldNotCall = false;
         notDefined = false;
 
@@ -58,8 +59,12 @@ public void pushEntries(BibDatabaseContext database, List<BibEntry> entries, Str
         try {
             String[] com = new String[]{commandPath, "--servername",
                     preferencesService.getPushToApplicationPreferences().getVimServer(), "--remote-send",
-                    "<C-\\><C-N>a" + getCiteCommand() +
-                            "{" + keys + "}"};
+                    "<C-\\><C-N>a" + getCitePrefix() + keys + getCiteSuffix()};
+
+            LOGGER.atDebug()
+                  .setMessage("Executing command {}")
+                  .addArgument(() -> Arrays.toString(com))
+                  .log();
 
             final Process p = Runtime.getRuntime().exec(com);
 
@@ -76,24 +81,24 @@ public void pushEntries(BibDatabaseContext database, List<BibEntry> entries, Str
                     }
                     // Error stream has been closed. See if there were any errors:
                     if (!sb.toString().trim().isEmpty()) {
-                        LOGGER.warn("Push to Vim error: " + sb);
-                        couldNotConnect = true;
+                        LOGGER.warn("Push to Vim error: {}", sb);
+                        couldNotPush = true;
                     }
                 } catch (IOException e) {
-                    LOGGER.warn("File problem.", e);
+                    LOGGER.warn("Error handling std streams", e);
                 }
             });
         } catch (IOException excep) {
-            couldNotCall = true;
             LOGGER.warn("Problem pushing to Vim.", excep);
+            couldNotCall = true;
         }
     }
 
     @Override
     public void onOperationCompleted() {
-        if (couldNotConnect) {
+        if (couldNotPush) {
             dialogService.showErrorDialogAndWait(Localization.lang("Error pushing entries"),
-                    Localization.lang("Could not connect to Vim server. Make sure that Vim is running with correct server name."));
+                    Localization.lang("Could not push to a running Vim server."));
         } else if (couldNotCall) {
             dialogService.showErrorDialogAndWait(Localization.lang("Error pushing entries"),
                     Localization.lang("Could not run the 'vim' program."));
diff --git a/src/main/java/org/jabref/gui/push/PushToWinEdt.java b/src/main/java/org/jabref/gui/push/PushToWinEdt.java
index ca76723b235..58374b36be4 100644
--- a/src/main/java/org/jabref/gui/push/PushToWinEdt.java
+++ b/src/main/java/org/jabref/gui/push/PushToWinEdt.java
@@ -26,6 +26,6 @@ public JabRefIcon getApplicationIcon() {
     @Override
     protected String[] getCommandLine(String keyString) {
         return new String[] {commandPath,
-                "\"[InsText('" + getCiteCommand() + "{" + keyString.replace("'", "''") + "}');]\""};
+                "\"[InsText('" + getCitePrefix() + keyString.replace("'", "''") + getCiteSuffix() + "');]\""};
     }
 }
diff --git a/src/main/java/org/jabref/preferences/ExternalApplicationsPreferences.java b/src/main/java/org/jabref/preferences/ExternalApplicationsPreferences.java
index 94be5b71307..2b64ebbe884 100644
--- a/src/main/java/org/jabref/preferences/ExternalApplicationsPreferences.java
+++ b/src/main/java/org/jabref/preferences/ExternalApplicationsPreferences.java
@@ -10,6 +10,7 @@ public class ExternalApplicationsPreferences {
     private final StringProperty eMailSubject;
     private final BooleanProperty shouldAutoOpenEmailAttachmentsFolder;
     private final StringProperty citeCommand;
+
     private final BooleanProperty useCustomTerminal;
     private final StringProperty customTerminalCommand;
     private final BooleanProperty useCustomFileBrowser;
diff --git a/src/main/java/org/jabref/preferences/JabRefPreferences.java b/src/main/java/org/jabref/preferences/JabRefPreferences.java
index 447026bd16b..129beb48274 100644
--- a/src/main/java/org/jabref/preferences/JabRefPreferences.java
+++ b/src/main/java/org/jabref/preferences/JabRefPreferences.java
@@ -287,7 +287,9 @@ public class JabRefPreferences implements PreferencesService {
     public static final String AUTOLINK_EXACT_KEY_ONLY = "autolinkExactKeyOnly";
     public static final String AUTOLINK_FILES_ENABLED = "autoLinkFilesEnabled";
     public static final String SIDE_PANE_WIDTH = "sidePaneWidthFX";
+
     public static final String CITE_COMMAND = "citeCommand";
+
     public static final String GENERATE_KEYS_BEFORE_SAVING = "generateKeysBeforeSaving";
     public static final String EMAIL_SUBJECT = "emailSubject";
     public static final String KINDLE_EMAIL = "kindleEmail";
@@ -702,8 +704,7 @@ private JabRefPreferences() {
 
         defaults.put(EXTERNAL_JOURNAL_LISTS, "");
         defaults.put(USE_AMS_FJOURNAL, true);
-        defaults.put(CITE_COMMAND, "\\cite"); // obsoleted by the app-specific ones (not any more?)
-
+        defaults.put(CITE_COMMAND, "\\cite{key1,key2}");
         defaults.put(LAST_USED_EXPORT, "");
         defaults.put(SIDE_PANE_WIDTH, 0.15);
 
@@ -1756,7 +1757,6 @@ public PushToApplicationPreferences getPushToApplicationPreferences() {
         pushToApplicationPreferences.getCommandPaths().addListener((obs, oldValue, newValue) -> storePushToApplicationPath(newValue));
         EasyBind.listen(pushToApplicationPreferences.emacsArgumentsProperty(), (obs, oldValue, newValue) -> put(PUSH_EMACS_ADDITIONAL_PARAMETERS, newValue));
         EasyBind.listen(pushToApplicationPreferences.vimServerProperty(), (obs, oldValue, newValue) -> put(PUSH_VIM_SERVER, newValue));
-
         return pushToApplicationPreferences;
     }
 
diff --git a/src/main/resources/l10n/JabRef_en.properties b/src/main/resources/l10n/JabRef_en.properties
index f80adee195a..755783a49c5 100644
--- a/src/main/resources/l10n/JabRef_en.properties
+++ b/src/main/resources/l10n/JabRef_en.properties
@@ -192,8 +192,6 @@ Could\ not\ instantiate\ %0.\ Have\ you\ chosen\ the\ correct\ package\ path?=Co
 
 Could\ not\ print\ preview=Could not print preview
 
-Could\ not\ run\ the\ 'vim'\ program.=Could not run the 'vim' program.
-
 Create\ custom\ fields\ for\ each\ BibTeX\ entry=Create custom fields for each BibTeX entry
 
 crossreferenced\ entries\ included=crossreferenced entries included
@@ -954,7 +952,6 @@ Value\ set\ externally\:\ %0=Value set externally: %0
 Verify\ that\ LyX\ is\ running\ and\ that\ the\ lyxpipe\ is\ valid.=Verify that LyX is running and that the lyxpipe is valid.
 
 View=View
-Vim\ server\ name=Vim server name
 
 View\ journal\ info=View journal info
 
@@ -1146,7 +1143,14 @@ No\ valid\ style\ file\ defined=No valid style file defined
 Choose\ pattern=Choose pattern
 Search\ and\ store\ files\ relative\ to\ library\ file\ location=Search and store files relative to library file location
 File\ directory=File directory
-Could\ not\ run\ the\ gnuclient/emacsclient\ program.\ Make\ sure\ you\ have\ the\ emacsclient/gnuclient\ program\ installed\ and\ available\ in\ the\ PATH.=Could not run the gnuclient/emacsclient program. Make sure you have the emacsclient/gnuclient program installed and available in the PATH.
+
+Error\ pushing\ entries=Error pushing entries
+Could\ not\ push\ to\ a\ running\ Vim\ server.=Could not push to a running Vim server.
+Vim\ server\ name=Vim server name
+Could\ not\ run\ the\ 'vim'\ program.=Could not run the 'vim' program.
+Could\ not\ push\ to\ a\ running\ emacs\ daemon.=Could not push to a running emacs daemon.
+Could\ not\ run\ the\ emacs\ client.=Could not run the emacs client.
+
 You\ must\ select\ either\ a\ valid\ style\ file,\ or\ use\ one\ of\ the\ default\ styles.=You must select either a valid style file, or use one of the default styles.
 
 This\ feature\ generates\ a\ new\ library\ based\ on\ which\ entries\ are\ needed\ in\ an\ existing\ LaTeX\ document.=This feature generates a new library based on which entries are needed in an existing LaTeX document.
@@ -1911,10 +1915,6 @@ Restore\ from\ backup=Restore from backup
 
 Shared\ database\ connection=Shared database connection
 
-Could\ not\ connect\ to\ Vim\ server.\ Make\ sure\ that\ Vim\ is\ running\ with\ correct\ server\ name.=Could not connect to Vim server. Make sure that Vim is running with correct server name.
-Could\ not\ connect\ to\ a\ running\ gnuserv\ process.\ Make\ sure\ that\ Emacs\ or\ XEmacs\ is\ running,\ and\ that\ the\ server\ has\ been\ started\ (by\ running\ the\ command\ 'server-start'/'gnuserv-start').=Could not connect to a running gnuserv process. Make sure that Emacs or XEmacs is running, and that the server has been started (by running the command 'server-start'/'gnuserv-start').
-Error\ pushing\ entries=Error pushing entries
-
 Preamble=Preamble
 Markings=Markings
 Use\ selected\ instance=Use selected instance
diff --git a/src/test/java/org/jabref/gui/push/PushToEmacsTest.java b/src/test/java/org/jabref/gui/push/PushToEmacsTest.java
new file mode 100644
index 00000000000..830cfff46b5
--- /dev/null
+++ b/src/test/java/org/jabref/gui/push/PushToEmacsTest.java
@@ -0,0 +1,54 @@
+package org.jabref.gui.push;
+
+import java.util.Map;
+
+import javafx.beans.property.SimpleMapProperty;
+import javafx.collections.FXCollections;
+import javafx.collections.ObservableMap;
+
+import org.jabref.gui.DialogService;
+import org.jabref.logic.util.OS;
+import org.jabref.preferences.ExternalApplicationsPreferences;
+import org.jabref.preferences.PreferencesService;
+import org.jabref.preferences.PushToApplicationPreferences;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
+import org.mockito.Answers;
+
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+@Disabled("Needs running emacs daemon. Start emacs with --daemon")
+class PushToEmacsTest {
+    PushToEmacs pushToEmacs;
+
+    @BeforeEach
+    public void setup() {
+        DialogService dialogService = mock(DialogService.class, Answers.RETURNS_DEEP_STUBS);
+        PreferencesService preferencesService = mock(PreferencesService.class);
+
+        PushToApplicationPreferences pushToApplicationPreferences = mock(PushToApplicationPreferences.class);
+
+        String emacsClient = OS.WINDOWS ? "\"C:\\tools\\emacs\\bin\\emacsclientw.exe\"" : "emacsclient";
+        Map<String, String> emacsConfig = Map.of("Emacs", emacsClient);
+        ObservableMap<String, String> emacsConfigObservableMap = FXCollections.observableMap(emacsConfig);
+        when(pushToApplicationPreferences.getCommandPaths()).thenReturn(new SimpleMapProperty<>(emacsConfigObservableMap));
+
+        when(pushToApplicationPreferences.getEmacsArguments()).thenReturn("-n -e");
+
+        when(preferencesService.getPushToApplicationPreferences()).thenReturn(pushToApplicationPreferences);
+
+        ExternalApplicationsPreferences externalApplicationsPreferences = mock(ExternalApplicationsPreferences.class);
+        when(externalApplicationsPreferences.getCiteCommand()).thenReturn("\\cite{key1,key2}");
+        when(preferencesService.getExternalApplicationsPreferences()).thenReturn(externalApplicationsPreferences);
+
+        pushToEmacs = new PushToEmacs(dialogService, preferencesService);
+    }
+
+    @Test
+    void pushEntries() {
+        pushToEmacs.pushEntries(null, null, "key1,key2");
+    }
+}