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: Sat, 23 Sep 2023 20:24:07 +0000 (UTC) Message-ID: <87zg1cprix.fsf@catern.com> References: <80d8aeb0-c9f1-410f-b83d-60f83ca5b3af@email.android.com> <83led8ls3z.fsf@gnu.org> <835y4ckkzu.fsf@gnu.org> <874jjnvvip.fsf@catern.com> <835y4290kf.fsf@gnu.org> 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="22567"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: jporterbugs@gmail.com, 65902@debbugs.gnu.org, sbaugh@janestreet.com To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Sep 23 22:25:22 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 1qk9Bp-0005dX-9x for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 23 Sep 2023 22:25:22 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qk9BT-0008PN-Pk; Sat, 23 Sep 2023 16:24:59 -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 1qk9BR-0008Ox-Ab for bug-gnu-emacs@gnu.org; Sat, 23 Sep 2023 16:24: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 1qk9BL-000108-Bo for bug-gnu-emacs@gnu.org; Sat, 23 Sep 2023 16:24:57 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qk9BW-0004GL-6c for bug-gnu-emacs@gnu.org; Sat, 23 Sep 2023 16:25:02 -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: Sat, 23 Sep 2023 20:25:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 65902 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 65902-submit@debbugs.gnu.org id=B65902.169550066916341 (code B ref 65902); Sat, 23 Sep 2023 20:25:02 +0000 Original-Received: (at 65902) by debbugs.gnu.org; 23 Sep 2023 20:24:29 +0000 Original-Received: from localhost ([127.0.0.1]:40682 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qk9Ay-0004FU-7s for submit@debbugs.gnu.org; Sat, 23 Sep 2023 16:24:28 -0400 Original-Received: from s.wfbtzhsw.outbound-mail.sendgrid.net ([159.183.224.105]:42924) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qk9Av-0004FE-Bl for 65902@debbugs.gnu.org; Sat, 23 Sep 2023 16:24:26 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=catern.com; h=from:subject:in-reply-to:references:mime-version:to:cc:content-type: cc:content-type:from:subject:to; s=s1; bh=DndJ8w3HDoAMjhJnLnwDwtFVxeMh5OntqXVj1yBjys0=; b=RdX9ATqALGTQvJye+HDHAjNWNmBgHzeUJ9IbkGf5KdnAWMhSVohP66Kk+IdwzdT0phYt /fkUMhq6BdV6B8HoD/Z7aACz3KNDIJ+4Faq83+42HMqfqJfFm3rKxenSfoZeM2Nxk8CfXw gq0izosjNsuaI52Jx7Av8CWy43CVXZc2sEDr0bMGbrqphhx+rL492KciwD7P8l5bFFEhY/ F7v2GtFJXC+NvRpUYeilIN0iXZwowJiF0BY4cuf//sQVmF47odB18RSIPGA7DfnvkdC/L1 CJCdTUqfpakHg0JsviJ6Cdtie1gc93UTiqYTDG0G2Q3riK6P8oBi4r2csNlrEw9A== Original-Received: by filterdrecv-d7bbbc8bf-7m5fp with SMTP id filterdrecv-d7bbbc8bf-7m5fp-1-650F4967-F 2023-09-23 20:24:07.43747357 +0000 UTC m=+717150.530742951 Original-Received: from earth.catern.com (unknown) by geopod-ismtpd-7 (SG) with ESMTP id idtM00KnTP2A_fJTOugs9Q Sat, 23 Sep 2023 20:24:07.245 +0000 (UTC) X-Comment: SPF check N/A for local connections - client-ip=::1; helo=localhost; envelope-from=sbaugh@catern.com; receiver=gnu.org Original-Received: from localhost (localhost [IPv6:::1]) by earth.catern.com (Postfix) with ESMTPSA id 5F65160166; Sat, 23 Sep 2023 16:24:06 -0400 (EDT) In-Reply-To: <835y4290kf.fsf@gnu.org> (Eli Zaretskii's message of "Fri, 22 Sep 2023 09:36:16 +0300") X-SG-EID: ZgbRq7gjGrt0q/Pjvxk7wM0yQFRdOkTJAtEbkjCkHbKT9PHbWLcohoUdn1o940HESvMq7/mhUBwQJCe3dIXZGZPqnz3kmrHzVXNi/uacdx/bdUuXJpwqnVYLqFCnThc+g6J0+c6Uh2mybD5oqD+hadEPfuK8n3z/BALHxVZJUAN+OooINiSfJggM7yBYnWrDmUYjIR2g3gDQtUqxF080vg== 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:271191 Archived-At: --=-=-= Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit Eli Zaretskii writes: >> From: sbaugh@catern.com >> Date: Fri, 22 Sep 2023 01:36:47 +0000 (UTC) >> Cc: Spencer Baugh , jporterbugs@gmail.com, >> 65902@debbugs.gnu.org >> >> > Currently, when emacsclient is invoked like this: >> > >> > $ emacsclient --eval '(func args)' foo bar >> > >> > we send to the server the following commands: >> > >> > -eval (func args) >> > -eval foo >> > -eval bar >> > >> > IOW, every command-line argument after --eval is treated as being >> > implicitly preceded with --eval. >> > >> > With your proposal, how will the server know that some of "-eval foo" >> > commands should cause foo to be added to server-eval-args-left instead >> > of being evaluated as it does now? >> >> As in the attached patch. > > I wish you'd accompanied the patch with some plain-text description of > the idea, to make it easier to understand and to avoid unnecessary > misunderstandings. Ah, well, the basic idea is that for each -eval request we receive in the protocol, we accumulate the argument as a string into a single list (instead of immediately turning it into a closure which calls server-eval-and-print). Then we let-bind server-eval-args-left to that list around the calls to to server-eval-and-print, and consume each argument from the list one by one. > IIUC, this kind of solution is fine by me, but the protocol of > accessing and using server-eval-args-left in the Lisp expressions > specified on the emacsclient command line should be well-documented to > avoid any confusion and UB. Added a docstring and included it in NEWS. I would have put it in the manual, but it seems rather niche to put in the Emacs manual and I didn't see a natural place to put it in the Emacs Lisp manual. --=-=-= Content-Type: text/x-patch Content-Disposition: inline; filename=0001-Add-server-eval-args-left-to-server.el.patch >From cf7fcda1374491cc73a751d5636f36a95b2e8669 Mon Sep 17 00:00:00 2001 From: Spencer Baugh Date: Thu, 21 Sep 2023 21:35:50 -0400 Subject: [PATCH] Add server-eval-args-left to server.el Passing arbitrary arguments to functions through emacsclient --eval requires complicated escaping to avoid them being parsed as Lisp (as seen in emacsclient-mail.desktop before this change). This new variable server-eval-args-left allows access to the arguments before they are parsed as Lisp. By removing arguments from the variable before they're parsed, a snippet of Lisp can consume arguments, as in emacsclient-mail.desktop. org-protocol might be able to use this as well, which might allow it to drop its current advice on server-visit-files. * etc/emacsclient-mail.desktop: Use server-eval-args-left. (bug#65902) * lisp/server.el (server-eval-args-left): Add. (server-process-filter, server-execute): Make -eval arguments available through server-eval-args-left. * lisp/startup.el (argv): Mention server-eval-args-left in docstring. * etc/NEWS: Announce server-eval-args-left. --- etc/NEWS | 10 ++++++++++ etc/emacsclient-mail.desktop | 7 ++----- lisp/server.el | 35 ++++++++++++++++++++++++++++------- lisp/startup.el | 5 ++++- 4 files changed, 44 insertions(+), 13 deletions(-) diff --git a/etc/NEWS b/etc/NEWS index cd4c414a64c..de1d79fcb98 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -121,6 +121,16 @@ Anything following the symbol 'mode-line-format-right-align' in right-aligned to is controlled by the new user option 'mode-line-right-align-edge'. +** Emacs Server and Client + +--- +*** 'server-eval-args-left' can be used to pop subsequent eval args +When '--eval' is passed to emacsclient and Emacs is evaluating each +argument, this variable is set to those which have not yet been +evaluated. It can be used to 'pop' arguments to prevent them from +being evaluated, which is useful when those arguments contain +arbitrary data. + * Editing Changes in Emacs 30.1 diff --git a/etc/emacsclient-mail.desktop b/etc/emacsclient-mail.desktop index 0a2420ddead..5962fa1764c 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= --eval '(message-mailto (pop server-eval-args-left))' %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 --eval '(message-mailto (pop server-eval-args-left))' %u [Desktop Action new-instance] Name=New Instance diff --git a/lisp/server.el b/lisp/server.el index c3325e5a24c..65f28cdea23 100644 --- a/lisp/server.el +++ b/lisp/server.el @@ -1189,6 +1189,7 @@ server-process-filter parent-id ; Window ID for XEmbed dontkill ; t if client should not be killed. commands + evalexprs dir use-current-frame frame-parameters ;parameters for newly created frame @@ -1319,8 +1320,7 @@ server-process-filter (let ((expr (pop args-left))) (if coding-system (setq expr (decode-coding-string expr coding-system))) - (push (lambda () (server-eval-and-print expr proc)) - commands) + (push expr evalexprs) (setq filepos nil))) ;; -env NAME=VALUE: An environment variable. @@ -1345,7 +1345,7 @@ server-process-filter ;; arguments, use an existing frame. (and nowait (not (eq tty-name 'window-system)) - (or files commands) + (or files commands evalexprs) (setq use-current-frame t)) (setq frame @@ -1394,7 +1394,7 @@ server-process-filter (let ((default-directory (if (and dir (file-directory-p dir)) dir default-directory))) - (server-execute proc files nowait commands + (server-execute proc files nowait commands evalexprs dontkill frame tty-name))))) (when (or frame files) @@ -1404,22 +1404,43 @@ server-process-filter ;; condition-case (t (server-return-error proc err)))) -(defun server-execute (proc files nowait commands dontkill frame tty-name) +(defvar server-eval-args-left nil + "List of eval args not yet processed. + +When the server receives a request to eval one or more strings, +it stores them in this variable. Then, until this variable is +nil, it `pop's a string from this variable and evaluates it with +`server-eval-and-print'. Adding or removing strings from this +variable during this process will affect what is evaluated. + +This allows an expression passed to \"emacsclient --eval\" to +consume one or more subsequent arguments before they're parsed or +evaluated, with (pop server-eval-args-left). This is useful if +those arguments are arbitrary strings which should not be +evaluated. + +See also `command-line-args-left' for a similar variable which +works for command line invocations of \"emacs\".") + +(defun server-execute (proc files nowait commands evalexprs dontkill frame tty-name) ;; This is run from timers and process-filters, i.e. "asynchronously". ;; But w.r.t the user, this is not really asynchronous since the timer ;; is run after 0s and the process-filter is run in response to the ;; user running `emacsclient'. So it is OK to override the - ;; inhibit-quit flag, which is good since `commands' (as well as + ;; inhibit-quit flag, which is good since `evalexprs' (as well as ;; find-file-noselect via the major-mode) can run arbitrary code, ;; including code that needs to wait. (with-local-quit (condition-case err (let ((buffers (server-visit-files files proc nowait))) (mapc 'funcall (nreverse commands)) + (let ((server-eval-args-left (nreverse evalexprs))) + (while server-eval-args-left + (server-eval-and-print (pop server-eval-args-left) proc))) ;; If we were told only to open a new client, obey ;; `initial-buffer-choice' if it specifies a file ;; or a function. - (unless (or files commands) + (unless (or files commands evalexprs) (let ((buf (cond ((stringp initial-buffer-choice) (find-file-noselect initial-buffer-choice)) diff --git a/lisp/startup.el b/lisp/startup.el index 7f601668369..f2c84751211 100644 --- a/lisp/startup.el +++ b/lisp/startup.el @@ -120,7 +120,10 @@ command-switch-alist "List of command-line args not yet processed. This is a convenience alias, so that one can write (pop argv) inside of --eval command line arguments in order to access -following arguments.")) +following arguments. + +See also `server-eval-args-left' for a similar variable which +works for invocations of \"emacsclient --eval\".")) (internal-make-var-non-special 'argv) (defvar command-line-args-left nil -- 2.41.0 --=-=-=--