From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: taylanbayirli@gmail.com (Taylan Ulrich =?utf-8?Q?Bay=C4=B1rl=C4=B1?= =?utf-8?Q?=2FKammer?=) Newsgroups: gmane.emacs.devel Subject: Re: [PATCH] Add shell-quasiquote. Date: Mon, 19 Oct 2015 14:35:26 +0200 Message-ID: <878u6znii9.fsf@T420.taylan> References: <87si59wj42.fsf@T420.taylan> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Trace: ger.gmane.org 1445258169 23156 80.91.229.3 (19 Oct 2015 12:36:09 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 19 Oct 2015 12:36:09 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Oct 19 14:36:07 2015 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1Zo9fO-0000Fu-N6 for ged-emacs-devel@m.gmane.org; Mon, 19 Oct 2015 14:35:54 +0200 Original-Received: from localhost ([::1]:39252 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Zo9fN-0007e7-Po for ged-emacs-devel@m.gmane.org; Mon, 19 Oct 2015 08:35:53 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:39975) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Zo9f4-0007ce-G8 for emacs-devel@gnu.org; Mon, 19 Oct 2015 08:35:42 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Zo9ez-0005Sr-Te for emacs-devel@gnu.org; Mon, 19 Oct 2015 08:35:34 -0400 Original-Received: from mail-wi0-x22f.google.com ([2a00:1450:400c:c05::22f]:34529) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Zo9ez-0005Sf-JY for emacs-devel@gnu.org; Mon, 19 Oct 2015 08:35:29 -0400 Original-Received: by wikq8 with SMTP id q8so3643230wik.1 for ; Mon, 19 Oct 2015 05:35:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:subject:references:date:in-reply-to:message-id:user-agent :mime-version:content-type; bh=V30HzZA7KdD2WPP9D/HBV5dCb5Upj9iVyYjex4RqQNI=; b=M2XqS34E6kRLSG90+xeOZ//XKdTzg/ObeNZCki7QL2Vrydd9+zAkydw22+jvVVD+pe 7jH1rZumCYabA/GCi8bXP9VGAfrG0Tc2druFPIhx/NpAtEWo78axiDU0NzWcvg8kAgTT 8DSw863zekB8zCD5OfNaTmHNBkZQkSpWPvwAAsy6jEiiD91yDCh0/yF7kIzSeywlX8bX gyYV4oBRvFnb9cUuA6XWWTfmrqSX4srCG0fXG7RP3fbdFV3wefxscT98ZIgcpZ1pft7f iPh3XF0fK+nk4WMiTYYl6ikcbgu8oF3HdG6A+EpWH79XnRe9yvwmhNCi7WrNxK7Kwazb QNLw== X-Received: by 10.194.171.3 with SMTP id aq3mr33308889wjc.54.1445258128985; Mon, 19 Oct 2015 05:35:28 -0700 (PDT) Original-Received: from T420.taylan ([2a02:908:c32:4740:221:ccff:fe66:68f0]) by smtp.gmail.com with ESMTPSA id bf8sm39934121wjc.22.2015.10.19.05.35.27 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 19 Oct 2015 05:35:27 -0700 (PDT) In-Reply-To: <87si59wj42.fsf@T420.taylan> ("Taylan Ulrich \=\?utf-8\?Q\?\=5C\=22Bay\=C4\=B1rl\=C4\=B1\=2FKammer\=5C\=22\=22's\?\= message of "Sat, 17 Oct 2015 18:33:01 +0200") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.5 (gnu/linux) X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-Received-From: 2a00:1450:400c:c05::22f X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:192081 Archived-At: --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable taylanbayirli@gmail.com (Taylan Ulrich "Bay=C4=B1rl=C4=B1/Kammer") writes: > This is for ELPA. > > [...] Here's a version with slightly improved documentation and a clearer reasoning for why shell-quote-argument is avoided. Eli refused to clarify the safety guarantees of shell-quote-argument in bug#21702, and after all it has significantly different semantics anyway (it doesn't quote shell keywords like 'if'), so I will not be using shell-quote-argument. --=-=-= Content-Type: text/x-diff; charset=utf-8 Content-Disposition: inline; filename=0001-Add-shell-quasiquote.patch Content-Transfer-Encoding: quoted-printable >From 276e3adc61b2f083b0348fd231a97feaa7017e36 Mon Sep 17 00:00:00 2001 From: =3D?UTF-8?q?Taylan=3D20Ulrich=3D20Bay=3DC4=3DB1rl=3DC4=3DB1/Kammer?=3D Date: Sat, 17 Oct 2015 18:32:22 +0200 Subject: [PATCH 1/3] Add shell-quasiquote. --- packages/shell-quasiquote/shell-quasiquote.el | 151 ++++++++++++++++++++++= ++++ 1 file changed, 151 insertions(+) create mode 100644 packages/shell-quasiquote/shell-quasiquote.el diff --git a/packages/shell-quasiquote/shell-quasiquote.el b/packages/shell= -quasiquote/shell-quasiquote.el new file mode 100644 index 0000000..1f18862 --- /dev/null +++ b/packages/shell-quasiquote/shell-quasiquote.el @@ -0,0 +1,151 @@ +;;; shell-quasiquote.el --- Turn s-expressions into shell command strings. + +;; Copyright (C) 2015 Free Software Foundation, Inc. + +;; Author: Taylan Ulrich Bay=C4=B1rl=C4=B1/Kammer +;; Keywords: extensions, unix + +;; This program is free software; you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. + +;; This program is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with this program. If not, see . + +;;; Commentary: + +;; "Shell quasiquote" -- turn s-expressions into POSIX shell command strin= gs. +;; +;; Shells other than POSIX sh are not supported. +;; +;; Quoting is automatic and safe against injection. +;; +;; (let ((file1 "file one") +;; (file2 "file two")) +;; (shqq (cp -r ,file1 ,file2 "My Files"))) +;; =3D> "cp -r 'file one' 'file two' 'My Files'" +;; +;; You can splice many arguments into place with ,@foo. +;; +;; (let ((files (list "file one" "file two"))) +;; (shqq (cp -r ,@files "My Files"))) +;; =3D> "cp -r 'file one' 'file two' 'My Files'" +;; +;; Note that the quoting disables a variety of shell expansions like ~/foo, +;; $ENV_VAR, and e.g. {x..y} in GNU Bash. +;; +;; You can use ,,foo to escape the quoting. +;; +;; (let ((files "file1 file2")) +;; (shqq (cp -r ,,files "My Files"))) +;; =3D> "cp -r file1 file2 'My Files'" +;; +;; And ,,@foo to splice and escape quoting. +;; +;; (let* ((arglist '("-x 'foo bar' -y baz")) +;; (arglist (append arglist '("-z 'qux fux'")))) +;; (shqq (command ,,@arglist))) +;; =3D> "command -x 'foo bar' -y baz -z 'qux fux'" +;; +;; Neat, eh? + + +;;; Code: + +;;; We don't use `shell-quote-argument' because it doesn't provide any saf= ety +;;; guarantees, and this quotes shell keywords as well. +(defun shqq--quote-string (string) + (concat "'" (replace-regexp-in-string "'" "'\\\\''" string) "'")) + +(defun shqq--atom-to-string (atom) + (cond + ((symbolp atom) (symbol-name atom)) + ((stringp atom) atom) + ((numberp atom) (number-to-string atom)) + (t (error "Bad shqq atom: %S" atom)))) + +(defun shqq--quote-atom (atom) + (shqq--quote-string (shqq--atom-to-string atom))) + +(defun shqq--match-comma (form) + "Matches FORM against ,foo i.e. (\, foo) and returns foo. +Returns nil if FORM didn't match. You can't disambiguate between +FORM matching ,nil and not matching." + (if (and (consp form) + (eq '\, (car form)) + (consp (cdr form)) + (null (cddr form))) + (cadr form))) + +(defun shqq--match-comma2 (form) + "Matches FORM against ,,foo i.e. (\, (\, foo)) and returns foo. +Returns nil if FORM didn't match. You can't disambiguate between +FORM matching ,,nil and not matching." + (if (and (consp form) + (eq '\, (car form)) + (consp (cdr form)) + (null (cddr form))) + (shqq--match-comma (cadr form)))) + + +(defmacro shqq (parts) + "First, PARTS is turned into a list of strings. For this, +every element of PARTS must be one of: + +- a symbol, evaluating to its name, + +- a string, evaluating to itself, + +- a number, evaluating to its decimal representation, + +- \",expr\", where EXPR must evaluate to an atom that will be + interpreted according to the previous rules, + +- \",@list-expr\", where LIST-EXPR must evaluate to a list whose + elements will each be interpreted like the EXPR in an \",EXPR\" + form, and spliced into the list of strings, + +- \",,expr\", where EXPR is interpreted like in \",expr\", + +- or \",,@expr\", where EXPR is interpreted like in \",@expr\". + +In the resulting list of strings, all elements except the ones +resulting from \",,expr\" and \",,@expr\" forms are quoted for +shell grammar. + +Finally, the resulting list of strings is concatenated with +separating spaces." + (let ((parts + (mapcar + (lambda (part) + (cond + ((atom part) (shqq--quote-atom part)) + ;; We use the match-comma helpers because pcase can't match ,= foo. + (t (pcase part + ;; ,,foo i.e. (, (, foo)) + ((pred shqq--match-comma2) + (shqq--match-comma2 part)) + ;; ,,@foo i.e. (, (,@ foo)) + ((and (pred shqq--match-comma) + (let `,@,form (shqq--match-comma part))) + `(mapconcat #'identity ,form " ")) + ;; ,foo + ;; Insert redundant 'and x' to work around debbugs#18554. + ((and x (pred shqq--match-comma)) + `(shqq--quote-atom ,(shqq--match-comma part))) + ;; ,@foo + (`,@,form + `(mapconcat #'shqq--quote-atom ,form " ")) + (_ + (error "Bad shqq part: %S" part)))))) + parts))) + `(mapconcat #'identity (list ,@parts) " "))) + +(provide 'shell-quasiquote) +;;; shell-quasiquote.el ends here --=20 2.5.0 --=-=-=--