From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: sbaugh@catern.com Newsgroups: gmane.emacs.bugs Subject: bug#65902: 29.0.92; emacsclient-mail.desktop fails due to complicated escaping Date: Wed, 13 Sep 2023 02:30:08 +0000 (UTC) Message-ID: <87v8ceu7o0.fsf@catern.com> References: <871qf2vmi4.fsf@catern.com> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="8142"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) To: 65902@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Sep 13 04:31:15 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1qgFes-0001sI-52 for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 13 Sep 2023 04:31:14 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qgFec-00074O-No; Tue, 12 Sep 2023 22:30:58 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qgFeb-0006sz-7q for bug-gnu-emacs@gnu.org; Tue, 12 Sep 2023 22:30:57 -0400 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qgFea-0004gw-Ny for bug-gnu-emacs@gnu.org; Tue, 12 Sep 2023 22:30:56 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qgFef-0008MP-MB for bug-gnu-emacs@gnu.org; Tue, 12 Sep 2023 22:31:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: sbaugh@catern.com Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 13 Sep 2023 02:31:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 65902 X-GNU-PR-Package: emacs Original-Received: via spool by 65902-submit@debbugs.gnu.org id=B65902.169457222632093 (code B ref 65902); Wed, 13 Sep 2023 02:31:01 +0000 Original-Received: (at 65902) by debbugs.gnu.org; 13 Sep 2023 02:30:26 +0000 Original-Received: from localhost ([127.0.0.1]:60417 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qgFe5-0008LY-Dw for submit@debbugs.gnu.org; Tue, 12 Sep 2023 22:30:25 -0400 Original-Received: from s.wfbtzhsv.outbound-mail.sendgrid.net ([159.183.224.104]:28810) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qgFe0-0008L2-Pd for 65902@debbugs.gnu.org; Tue, 12 Sep 2023 22:30:21 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=catern.com; h=from:subject:in-reply-to:references:mime-version:to:content-type:cc: content-type:from:subject:to; s=s1; bh=ezrooZthfeKLIZmlQWNKH3PwgULf5uR0Ly6cTSrcCwo=; b=ouySX6E9PvVrLS2RbwEvDz4t5aRRv65Yr/WyFPiZw/xQeSiNjxhRrOI4b95BTHLXYSD5 iRrdGBgcbV3cSXis+lxTUhRsy8AjC0vCHRAxzMXAfJCK8pkMYEU75ND0xX9du2mRni5wGc tJGA0FcZjgnyLDiMw0+IbhRaMavu29WpV2dfs8mjKV/lMqFcj6mNwBsBLMxDldMTHdX0yH +x/v2RyAe1eS8At9YzlS+3msu0zBF0qbQ6TX0nd54yFBfS0glcvwfERN68fAV5b2FZbvGD +rPZc6nZr019l69qpndijFruNnTNOdFMs3S/z9KQqX6lG8+W10oAOXvFvjo4023g== Original-Received: by filterdrecv-7765c6879f-k58xv with SMTP id filterdrecv-7765c6879f-k58xv-1-65011EB0-6 2023-09-13 02:30:08.059200673 +0000 UTC m=+2892946.207112839 Original-Received: from earth.catern.com (unknown) by geopod-ismtpd-28 (SG) with ESMTP id 2L1baOyrSvu-Pq0rNjY-Ig Wed, 13 Sep 2023 02:30:07.855 +0000 (UTC) X-Comment: SPF check N/A for local connections - client-ip=::1; helo=localhost; envelope-from=sbaugh@catern.com; receiver=debbugs.gnu.org Original-Received: from localhost (localhost [IPv6:::1]) by earth.catern.com (Postfix) with ESMTPSA id 686B460105; Tue, 12 Sep 2023 22:30:07 -0400 (EDT) In-Reply-To: <871qf2vmi4.fsf@catern.com> (sbaugh@catern.com's message of "Wed, 13 Sep 2023 02:24:20 +0000 (UTC)") X-SG-EID: ZgbRq7gjGrt0q/Pjvxk7wM0yQFRdOkTJAtEbkjCkHbKxr19SAD9NJYU1Ku8aAGCFUMWKaDOWr+YZ9dhHmLDMgTtXKW3akTp2WNkZ0aunVw0DB3I7wGVUA4jPyisIsPVyMe7plinQlroKybsT9ftJmWFZ+rulY6nO7jaTGBD/GVx7atB7Yb93yp/ANnuCemkcOJTPkoDDSP13r09GqBajkg== X-Entity-ID: d/0VcHixlS0t7iB1YKCv4Q== X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:270242 Archived-At: --=-=-= Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit tags 65902 + patch quit This patch avoids the complicated scripting needed for emacsclient-mail.desktop by adding a new flag to emacsclient, --funcall, which mirrors emacs --funcall and allows emacsclient-mail.desktop to be basically the same as emacs-mail.desktop. I expect this to also be useful in other places; the need to escape arbitrary inputs before passing them to emacsclient is frequently annoying. --=-=-= Content-Type: text/x-patch Content-Disposition: inline; filename=0001-Add-funcall-to-emacsclient-to-avoid-escaping-argumen.patch >From 6c9dbda3aa5e3f1e3a5003bc0a15cf662b880d99 Mon Sep 17 00:00:00 2001 From: Spencer Baugh Date: Tue, 12 Sep 2023 22:20:15 -0400 Subject: [PATCH] Add --funcall to emacsclient to avoid escaping arguments Passing arguments to functions through emacsclient --eval requires complicated escaping (as seen in emacsclient-mail.desktop before this change). The new --funcall argument behaves like emacs -f, and just passes the arguments as uninterpreted strings to the specified function. This simplifies use cases where arbitrary input needs to be passed to emacsclient. * etc/emacsclient-mail.desktop: Use --funcall. (bug#65902) * lib-src/emacsclient.c (longopts, decode_options, main): Add support for --funcall. * lisp/server.el (server-funcall-and-print): Add. (server-process-filter): Add support for -funcall and -funcallargs --- etc/emacsclient-mail.desktop | 7 ++----- lib-src/emacsclient.c | 36 ++++++++++++++++++++++++++++++++++-- lisp/server.el | 34 ++++++++++++++++++++++++++++++++++ 3 files changed, 70 insertions(+), 7 deletions(-) diff --git a/etc/emacsclient-mail.desktop b/etc/emacsclient-mail.desktop index 0a2420ddead..fc6773a963b 100644 --- a/etc/emacsclient-mail.desktop +++ b/etc/emacsclient-mail.desktop @@ -1,10 +1,7 @@ [Desktop Entry] Categories=Network;Email; Comment=GNU Emacs is an extensible, customizable text editor - and more -# We want to pass the following commands to the shell wrapper: -# u=$(echo "$1" | sed 's/[\"]/\\&/g'); exec emacsclient --alternate-editor= --display="$DISPLAY" --eval "(message-mailto \"$u\")" -# Special chars '"', '$', and '\' must be escaped as '\\"', '\\$', and '\\\\'. -Exec=sh -c "u=\\$(echo \\"\\$1\\" | sed 's/[\\\\\\"]/\\\\\\\\&/g'); exec emacsclient --alternate-editor= --display=\\"\\$DISPLAY\\" --eval \\"(message-mailto \\\\\\"\\$u\\\\\\")\\"" sh %u +Exec=emacsclient --alternate-editor= --funcall message-mailto %u Icon=emacs Name=Emacs (Mail, Client) MimeType=x-scheme-handler/mailto; @@ -16,7 +13,7 @@ Actions=new-window;new-instance; [Desktop Action new-window] Name=New Window -Exec=sh -c "u=\\$(echo \\"\\$1\\" | sed 's/[\\\\\\"]/\\\\\\\\&/g'); exec emacsclient --alternate-editor= --create-frame --eval \\"(message-mailto \\\\\\"\\$u\\\\\\")\\"" sh %u +Exec=emacsclient --alternate-editor= --create-frame --funcall message-mailto %u [Desktop Action new-instance] Name=New Instance diff --git a/lib-src/emacsclient.c b/lib-src/emacsclient.c index 698bf9b50ae..5bf6c05ef37 100644 --- a/lib-src/emacsclient.c +++ b/lib-src/emacsclient.c @@ -116,6 +116,9 @@ #define DEFAULT_TIMEOUT (30) /* True means args are expressions to be evaluated. --eval. */ static bool eval; +/* The function to call. Other arguments are passed as strings. --funcall. */ +static char *funcall; + /* True means open a new frame. --create-frame etc. */ static bool create_frame; @@ -169,6 +172,7 @@ #define DEFAULT_TIMEOUT (30) { "quiet", no_argument, NULL, 'q' }, { "suppress-output", no_argument, NULL, 'u' }, { "eval", no_argument, NULL, 'e' }, + { "funcall", required_argument, NULL, 'l' }, { "help", no_argument, NULL, 'H' }, { "version", no_argument, NULL, 'V' }, { "tty", no_argument, NULL, 't' }, @@ -552,6 +556,10 @@ decode_options (int argc, char **argv) eval = true; break; + case 'l': + funcall = optarg; + break; + case 'q': quiet = true; break; @@ -690,6 +698,7 @@ print_help_and_exit (void) -F ALIST, --frame-parameters=ALIST\n\ Set the parameters of a new frame\n\ -e, --eval Evaluate the FILE arguments as ELisp expressions\n\ +-l, --funcall FUNC Call ELisp FUNC, passing FILE arguments as strings\n\ -n, --no-wait Don't wait for the server to return\n\ -w, --timeout=SECONDS Seconds to wait before timing out\n\ -q, --quiet Don't display messages on success\n\ @@ -1953,7 +1962,7 @@ main (int argc, char **argv) /* Process options. */ decode_options (argc, argv); - if (! (optind < argc || eval || create_frame)) + if (! (optind < argc || eval || funcall || create_frame)) { message (true, ("%s: file name or argument required\n" "Try '%s --help' for more information\n"), @@ -1961,6 +1970,14 @@ main (int argc, char **argv) exit (EXIT_FAILURE); } + if (eval && funcall) + { + message (true, ("%s: can't pass both --eval and --funcall\n" + "Try '%s --help' for more information\n"), + progname, progname); + exit (EXIT_FAILURE); + } + #ifdef SOCKETS_IN_FILE_SYSTEM if (tty) { @@ -2080,6 +2097,13 @@ main (int argc, char **argv) send_to_emacs (emacs_socket, " "); continue; } + else if (funcall) + { + send_to_emacs (emacs_socket, "-funcallarg "); + quote_argument (emacs_socket, argv[i]); + send_to_emacs (emacs_socket, " "); + continue; + } char *p = argv[i]; if (*p == '+') @@ -2136,10 +2160,18 @@ main (int argc, char **argv) send_to_emacs (emacs_socket, " "); } + if (funcall) + { + send_to_emacs (emacs_socket, "-funcall "); + quote_argument (emacs_socket, funcall); + send_to_emacs (emacs_socket, " "); + } + + send_to_emacs (emacs_socket, "\n"); /* Wait for an answer. */ - if (!eval && !tty && !nowait && !quiet && 0 <= process_grouping ()) + if (!eval && !funcall && !tty && !nowait && !quiet && 0 <= process_grouping ()) { printf ("Waiting for Emacs..."); skiplf = false; diff --git a/lisp/server.el b/lisp/server.el index c3325e5a24c..da3319581ea 100644 --- a/lisp/server.el +++ b/lisp/server.el @@ -873,6 +873,17 @@ server-eval-and-print (point-min) (point-max)))) (server-reply-print (server-quote-arg text) proc))))))) +(defun server-funcall-and-print (func args proc) + "Call FUNC on ARGS and send the result back to client PROC." + (let ((v (with-local-quit (eval (apply (intern func) args) t)))) + (when proc + (with-temp-buffer + (let ((standard-output (current-buffer))) + (pp v) + (let ((text (buffer-substring-no-properties + (point-min) (point-max)))) + (server-reply-print (server-quote-arg text) proc))))))) + (defconst server-msg-size 1024 "Maximum size of a message sent to a client.") @@ -1196,6 +1207,7 @@ server-process-filter tty-type ; string. files filepos + funcallargs args-left) ;; Remove this line from STRING. (setq string (substring string (match-end 0))) @@ -1323,6 +1335,28 @@ server-process-filter commands) (setq filepos nil))) + ;; -funcall FUNC: Call a function on arguments. + ("-funcall" + (if use-current-frame + (setq use-current-frame 'always)) + (let ((func (pop args-left))) + (if coding-system + (setq func (decode-coding-string func coding-system))) + (push (lambda () (server-funcall-and-print func funcallargs proc)) + commands) + (setq funcallargs nil) + (setq filepos nil))) + + ;; -funcallarg ARG: Add an argument for later -funcall. + ("-funcallarg" + (if use-current-frame + (setq use-current-frame 'always)) + (let ((arg (pop args-left))) + (if coding-system + (setq arg (decode-coding-string arg coding-system))) + (push arg funcallargs) + (setq filepos nil))) + ;; -env NAME=VALUE: An environment variable. ("-env" (let ((var (pop args-left))) -- 2.41.0 --=-=-=--