From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Joseph Turner via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#63336: [PATCH] package-vc: Process :make and :shell-command spec args Date: Mon, 15 May 2023 12:03:14 -0700 Message-ID: <87h6sdtnq4.fsf@breatheoutbreathe.in> 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> <871qjiiucw.fsf@posteo.net> <87jzxafotr.fsf@breatheoutbreathe.in> <87sfbynekl.fsf@posteo.net> Reply-To: Joseph Turner Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="26808"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 63336@debbugs.gnu.org To: Philip Kaludercic Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Mon May 15 21:11:28 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 1pydbU-0006nj-Kz for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 15 May 2023 21:11:28 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pydbF-0002pd-Tu; Mon, 15 May 2023 15:11:13 -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 1pydb7-0002pB-IF for bug-gnu-emacs@gnu.org; Mon, 15 May 2023 15:11:07 -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 1pydb4-0003F9-2P for bug-gnu-emacs@gnu.org; Mon, 15 May 2023 15:11:05 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pydb3-0003Wr-Tx for bug-gnu-emacs@gnu.org; Mon, 15 May 2023 15:11:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Joseph Turner Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 15 May 2023 19:11:01 +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.168417783713534 (code B ref 63336); Mon, 15 May 2023 19:11:01 +0000 Original-Received: (at 63336) by debbugs.gnu.org; 15 May 2023 19:10:37 +0000 Original-Received: from localhost ([127.0.0.1]:44436 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pydae-0003WD-Da for submit@debbugs.gnu.org; Mon, 15 May 2023 15:10:37 -0400 Original-Received: from out-4.mta0.migadu.com ([91.218.175.4]:50287) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pydaZ-0003W1-Ks for 63336@debbugs.gnu.org; Mon, 15 May 2023 15:10:35 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=breatheoutbreathe.in; s=key1; t=1684177830; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=UBU2wswkC5d4kvR12AmPPfoU6iF3yWaCN8KWoFvlD1s=; b=D3lk/iRYlvZZDB/j/W7gUdwAA2VrA58FN8QeM4H6W/iDYVGbJ+NYC/a6ZUi66csPVIyALb 9oI2zC5VMAqj9qT/unKKhqQK5KsAvfNwvjcAHwZvgwKLBSN7fr1CwnIgi62bcv8h3wpk9m hmcK2ZBA5Cghu+wouRVyhErST84SDxk= X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. In-reply-to: <87sfbynekl.fsf@posteo.net> X-Migadu-Flow: FLOW_OUT 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:261764 Archived-At: Philip Kaludercic writes: > Joseph Turner writes: > >> Philip Kaludercic writes: >> >>> Joseph Turner writes: >>> >>>> Philip Kaludercic writes: >>>> >>>>> Joseph Turner writes: >>>>> >>>>>> Philip Kaludercic writes: >>>>>> >>>>>>> Joseph Turner writes: >> >>>> 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. >> >> Okay! >> >>>> 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. >> >> See patch. >> >>>>> 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. >> >> +1 >> >>>> 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. >> >> Thank you! I like pcase here. >> >>>> +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. >> >> Thank you! What do you think about the version in the attached patch? >> >>>> +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. >> >> Good to know! Fixed. >> >> From 812e32ea6c3f7b2d71174658db0e272b0b4fb84b 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 >> >> --- >> doc/emacs/package.texi | 9 ++++++++ >> lisp/emacs-lisp/package-vc.el | 42 +++++++++++++++++++++++++++++++++++ >> 2 files changed, 51 insertions(+) >> >> diff --git a/doc/emacs/package.texi b/doc/emacs/package.texi >> index 6722185cb20..4f606b22e54 100644 >> --- a/doc/emacs/package.texi >> +++ b/doc/emacs/package.texi >> @@ -682,6 +682,15 @@ A string providing the repository-relative name of the documentation >> file from which to build an Info file. This can be a Texinfo file or >> an Org file. >> >> +@item :make >> +A string or list of strings providing the target or targets defined in >> +the repository Makefile which should run before building the Info >> +file. Only takes effect when package-vc-allow-side-effects is non-nil. > > A @var is missing here Thank you! >> + >> +@item :shell-command >> +A string providing the shell command to run before building the Info >> +file. Only takes effect when package-vc-allow-side-effects is non-nil. > > and here. I can take care of that. Thank you! >> + >> @item :vc-backend >> A symbol naming the VC backend to use for downloading a copy of the >> package's repository (@pxref{Version Control Systems,,,emacs, The GNU >> diff --git a/lisp/emacs-lisp/package-vc.el b/lisp/emacs-lisp/package-vc.el >> index beca0bd00e2..d2f6d287224 100644 >> --- a/lisp/emacs-lisp/package-vc.el >> +++ b/lisp/emacs-lisp/package-vc.el >> @@ -344,6 +344,38 @@ asynchronously." >> "\n") >> nil pkg-file nil 'silent)))) >> >> +(defcustom package-vc-allow-side-effects nil >> + "Whether to process :make and :shell-command spec arguments. >> + >> +It may be necessary to run :make and :shell-command arguments in >> +order to initialize a package or build its documentation, but >> +please be careful when changing this option, as installing and >> +updating a package can run potentially harmful code. >> + >> +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)) >> + (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 +518,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))) > > Thinking about this again, I am still not convinced. Isn't > > --8<---------------cut here---------------start------------->8--- > (when (or (eq package-vc-allow-side-effects t) > (memq (package-desc-name pkg-desc) > package-vc-allow-side-effects)) > (package-vc--make pkg-spec pkg-desc)) > --8<---------------cut here---------------end--------------->8--- > > much simpler? Again, you don't have to prepare another patch, I'm just > interested in what you think. I take it all back and insist upon the opposite :) You are right, that's much simpler. >> + >> ;; Detect a manual >> (when (executable-find "install-info") >> (dolist (doc-file (ensure-list (plist-get pkg-spec :doc)))