From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Philip Kaludercic Newsgroups: gmane.emacs.bugs Subject: bug#63336: [PATCH] package-vc: Process :make and :shell-command spec args Date: Sun, 14 May 2023 19:30:23 +0000 Message-ID: <871qjiiucw.fsf@posteo.net> References: <874joprxmx.fsf@breatheoutbreathe.in> <87jzxkecnk.fsf@posteo.net> <87pm7b7up0.fsf@breatheoutbreathe.in> <877ctghey0.fsf@posteo.net> <873540rqkm.fsf@breatheoutbreathe.in> <87ilcvichb.fsf@posteo.net> <87cz33parh.fsf@breatheoutbreathe.in> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="22566"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 63336@debbugs.gnu.org To: Joseph Turner Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun May 14 21:31:18 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 1pyHR7-0005h7-8i for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 14 May 2023 21:31:17 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pyHQv-0007uY-Ig; Sun, 14 May 2023 15:31:05 -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 1pyHQt-0007uL-Dj for bug-gnu-emacs@gnu.org; Sun, 14 May 2023 15:31:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pyHQs-0007wp-UL for bug-gnu-emacs@gnu.org; Sun, 14 May 2023 15:31:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pyHQs-0004uK-GN for bug-gnu-emacs@gnu.org; Sun, 14 May 2023 15:31:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Philip Kaludercic Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 14 May 2023 19:31:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 63336 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 63336-submit@debbugs.gnu.org id=B63336.168409263318825 (code B ref 63336); Sun, 14 May 2023 19:31:02 +0000 Original-Received: (at 63336) by debbugs.gnu.org; 14 May 2023 19:30:33 +0000 Original-Received: from localhost ([127.0.0.1]:41604 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pyHQO-0004tY-LN for submit@debbugs.gnu.org; Sun, 14 May 2023 15:30:33 -0400 Original-Received: from mout01.posteo.de ([185.67.36.65]:55551) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pyHQM-0004tH-DQ for 63336@debbugs.gnu.org; Sun, 14 May 2023 15:30:31 -0400 Original-Received: from submission (posteo.de [185.67.36.169]) by mout01.posteo.de (Postfix) with ESMTPS id 78BCC240033 for <63336@debbugs.gnu.org>; Sun, 14 May 2023 21:30:24 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1684092624; bh=hXhQKjK0PEYXSwg+7GbH2uYuIAflyIjk9hksVc0YWWI=; h=From:To:Cc:Subject:Autocrypt:Date:Message-ID:MIME-Version:From; b=gWGrvw9lO/eQxkuen1VuPV73FTTEm5Eb4A8hnIvcal9Mb66qFYLU3wnS6Sf3zaDjV 1djNE0Fc0bIeFHSqWU3LrxVSjNhuTbQB2/btEW5aEbiWnT5cG1+Wit7ewyOXfPL+Ky hKgi2Cf8O1r1J8+7HT0m9HR9CzW/yWsxsWNMYLbCGF4xi5s2uDW7f/ZfQOAG//ortD 2ab2qtJwRbMwot4D+VhmNkNNxYLu2wiXify9rxoXkzua8zWBXFz6sTiotHOS7v+XGn EB6fUuxhftWavZ0ZFQPmC2zZIbYHYHs8QOZ39Y0nJPycMMBjy2pbBSrnc+MnrA+12P 7NKwzLtHL8BAA== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4QKCJc0JYVz6twF; Sun, 14 May 2023 21:30:23 +0200 (CEST) In-Reply-To: <87cz33parh.fsf@breatheoutbreathe.in> (Joseph Turner's message of "Sun, 14 May 2023 01:08:29 -0700") Autocrypt: addr=philipk@posteo.net; keydata= mDMEZBBQQhYJKwYBBAHaRw8BAQdAHJuofBrfqFh12uQu0Yi7mrl525F28eTmwUDflFNmdui0QlBo aWxpcCBLYWx1ZGVyY2ljIChnZW5lcmF0ZWQgYnkgYXV0b2NyeXB0LmVsKSA8cGhpbGlwa0Bwb3N0 ZW8ubmV0PoiWBBMWCAA+FiEEDg7HY17ghYlni8XN8xYDWXahwukFAmQQUEICGwMFCQHhM4AFCwkI BwIGFQoJCAsCBBYCAwECHgECF4AACgkQ8xYDWXahwulikAEA77hloUiSrXgFkUVJhlKBpLCHUjA0 mWZ9j9w5d08+jVwBAK6c4iGP7j+/PhbkxaEKa4V3MzIl7zJkcNNjHCXmvFcEuDgEZBBQQhIKKwYB BAGXVQEFAQEHQI5NLiLRjZy3OfSt1dhCmFyn+fN/QKELUYQetiaoe+MMAwEIB4h+BBgWCAAmFiEE Dg7HY17ghYlni8XN8xYDWXahwukFAmQQUEICGwwFCQHhM4AACgkQ8xYDWXahwukm+wEA8cml4JpK NeAu65rg+auKrPOP6TP/4YWRCTIvuYDm0joBALw98AMz7/qMHvSCeU/hw9PL6u6R2EScxtpKnWof z4oM 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:261721 Archived-At: Joseph Turner writes: > Philip Kaludercic writes: > >> Joseph Turner writes: >> >>> Philip Kaludercic writes: >>> >>>> Joseph Turner writes: >>> From b27724197acd4ee72f9d336843f0e6ed9fcee87b Mon Sep 17 00:00:00 2001 >>> From: Joseph Turner >>> Date: Sat, 13 May 2023 10:05:04 -0700 >>> Subject: [PATCH] package-vc: Process :make and :shell-command spec args >>> >>> --- >>> lisp/emacs-lisp/package-vc.el | 37 +++++++++++++++++++++++++++++++++++ >>> 1 file changed, 37 insertions(+) >>> >>> diff --git a/lisp/emacs-lisp/package-vc.el b/lisp/emacs-lisp/package-vc.el >>> index beca0bd00e2..8529d1dad5c 100644 >>> --- a/lisp/emacs-lisp/package-vc.el >>> +++ b/lisp/emacs-lisp/package-vc.el >>> @@ -344,6 +344,33 @@ asynchronously." >>> "\n") >>> nil pkg-file nil 'silent)))) >>> >>> +(defcustom package-vc-process-make nil >> >> Have we discussed the name of this user option? I feel it is too >> immediate, and therefore not intuitively obvious what purpose it serves. >> I would imagine something along the lines of >> "package-vc-allow-side-effects" or "package-vc-permit-building" could be >> better? WDYT? > > I like "package-vc-allow-side-effects". Changed in attached patch. > >>> + "Whether to process :make and :shell-command spec arguments. >> >> I guess here too an explanation would be warranted (and in the manual). >> Explaining what the issue is, and why one might be wary to enable the option. > > Does my addition suffice? > > We also might want to add another option for > package-vc-allow-side-effects like 'user-defined, which only runs :make > and :shell-command args which were specified by the user (as opposed to > those which were downloaded from elpa). WDYT? That sounds like a good idea, but let us do that in a separate patch. > To update the manual, shall I edit doc/emacs/package.texi directly or is > there another file to edit? Yes, just update the table under the "Specifying Package Sources" subsection. >>> +When set to a list of symbols (packages), run commands for only >>> +packages in the list. When `nil', never run commands. Otherwise >>> +when non-`nil', run commands for any package with :make or >>> +:shell-command specified. >>> + >>> +Package specs are loaded from trusted package archives." >>> + :type '(choice (const :tag "Run for all packages" t) >>> + (repeat :tag "Run only for selected packages" (symbol :tag "Package name")) >>> + (const :tag "Never run" nil)) >>> + :version "30.1") >>> + >>> +(defun package-vc--make (pkg-spec pkg-desc) >>> + "Process :make and :shell-command PKG-SPEC arguments for PKG-DESC." >>> + (let ((target (plist-get pkg-spec :make)) >>> + (cmd (plist-get pkg-spec :shell-command))) >>> + (when (or cmd target) >>> + (with-current-buffer (get-buffer-create >> >> I'd format the buffer name in the top let to prevent this line-break here. > > Done. > >>> + (format " *package-vc make %s*" (package-desc-name pkg-desc))) >>> + (erase-buffer) >>> + (when (and cmd (/= 0 (call-process shell-file-name nil t nil shell-command-switch cmd))) >>> + (warn "Failed to run %s, see buffer %S" cmd (buffer-name))) >>> + (when (and target (/= 0 (apply #'call-process "make" nil t nil (if (consp target) target (list target))))) >>> + (warn "Failed to make %s, see buffer %S" target (buffer-name))))))) >> >> If :shell-command fails, do we really want to proceed to :make? > > Up to you! I was following the lead of elpa-admin.el. In that case let us do that too, unless there is a good reason not to. >>> (declare-function org-export-to-file "ox" (backend file)) >>> >>> (defun package-vc--build-documentation (pkg-desc file) >>> @@ -486,6 +513,16 @@ documentation and marking the package as installed." >>> ;; Generate package file >>> (package-vc--generate-description-file pkg-desc pkg-file) >>> >>> + ;; Process :make and :shell-command arguments before building documentation >>> + (pcase package-vc-process-make >>> + ((pred consp) ; When non-`nil' list, check if package is on the list. >>> + (when (memq (package-desc-name pkg-desc) package-vc-process-make) >>> + (package-vc--make pkg-spec pkg-desc))) >>> + ('nil ; When `nil', do nothing. >>> + nil) >> >> Perhaps swap the two conditions, first checking nil then listp which I >> think reads more natural. Then again, is pcase actually serving >> anything here? > > I switched the first two cases. I think pcase is readable here, > especially if we add an 'user-defined option. What would you use > instead? I would have just used a regular cond. --8<---------------cut here---------------start------------->8--- (cond ((null package-vc-process-make) ...) ((listp package-vc-process-make) ...) (...)) --8<---------------cut here---------------end--------------->8--- But this doesn't matter, do what you prefer. >>> + (_ ; When otherwise non-`nil', run commands. >>> + (package-vc--make pkg-spec pkg-desc))) >>> + >>> ;; Detect a manual >>> (when (executable-find "install-info") >>> (dolist (doc-file (ensure-list (plist-get pkg-spec :doc))) > > From 3e7084e8e3e3ba142f383e90bfa656f59f3cc1ad Mon Sep 17 00:00:00 2001 > From: Joseph Turner > Date: Sat, 13 May 2023 10:05:04 -0700 > Subject: [PATCH] package-vc: Process :make and :shell-command spec args > > --- > lisp/emacs-lisp/package-vc.el | 40 +++++++++++++++++++++++++++++++++++ > 1 file changed, 40 insertions(+) > > diff --git a/lisp/emacs-lisp/package-vc.el b/lisp/emacs-lisp/package-vc.el > index beca0bd00e2..8403add364c 100644 > --- a/lisp/emacs-lisp/package-vc.el > +++ b/lisp/emacs-lisp/package-vc.el > @@ -344,6 +344,36 @@ asynchronously." > "\n") > nil pkg-file nil 'silent)))) > > +(defcustom package-vc-allow-side-effects nil > + "Whether to process :make and :shell-command spec arguments. > + > +Be careful when changing this option as processing :make and > +:shell-command will run potentially harmful code. Sounds scary. I guess that is the point, but what do you think about something like Be careful when changing this option, as installing and updating a package can potentially run harmful code. If possible, allow packages you trust to run code, if it is necessary for a package to be properly initialised. > + > +When set to a list of symbols (packages), run commands for only > +packages in the list. When `nil', never run commands. Otherwise > +when non-`nil', run commands for any package with :make or > +:shell-command specified. Watch out. According to (elisp) Documentation Tips, nil is not quoted. > + > +Package specs are loaded from trusted package archives." > + :type '(choice (const :tag "Run for all packages" t) > + (repeat :tag "Run only for selected packages" (symbol :tag "Package name")) > + (const :tag "Never run" nil)) > + :version "30.1") > + > +(defun package-vc--make (pkg-spec pkg-desc) > + "Process :make and :shell-command PKG-SPEC arguments for PKG-DESC." > + (let ((target (plist-get pkg-spec :make)) > + (cmd (plist-get pkg-spec :shell-command)) > + (buf (format " *package-vc make %s*" (package-desc-name pkg-desc)))) > + (when (or cmd target) > + (with-current-buffer (get-buffer-create buf) > + (erase-buffer) > + (when (and cmd (/= 0 (call-process shell-file-name nil t nil shell-command-switch cmd))) > + (warn "Failed to run %s, see buffer %S" cmd (buffer-name))) > + (when (and target (/= 0 (apply #'call-process "make" nil t nil (if (consp target) target (list target))))) > + (warn "Failed to make %s, see buffer %S" target (buffer-name))))))) > + > (declare-function org-export-to-file "ox" (backend file)) > > (defun package-vc--build-documentation (pkg-desc file) > @@ -486,6 +516,16 @@ documentation and marking the package as installed." > ;; Generate package file > (package-vc--generate-description-file pkg-desc pkg-file) > > + ;; Process :make and :shell-command arguments before building documentation > + (pcase package-vc-allow-side-effects > + ('nil ; When `nil', do nothing. > + nil) > + ((pred consp) ; When non-`nil' list, check if package is on the list. > + (when (memq (package-desc-name pkg-desc) package-vc-allow-side-effects) > + (package-vc--make pkg-spec pkg-desc))) > + (_ ; When otherwise non-`nil', run commands. > + (package-vc--make pkg-spec pkg-desc))) > + > ;; Detect a manual > (when (executable-find "install-info") > (dolist (doc-file (ensure-list (plist-get pkg-spec :doc)))