ob-shell.el (13798B)
1 ;;; ob-shell.el --- Babel Functions for Shell Evaluation -*- lexical-binding: t; -*- 2 3 ;; Copyright (C) 2009-2023 Free Software Foundation, Inc. 4 5 ;; Author: Eric Schulte 6 ;; Keywords: literate programming, reproducible research 7 ;; URL: https://orgmode.org 8 9 ;; This file is part of GNU Emacs. 10 11 ;; GNU Emacs is free software: you can redistribute it and/or modify 12 ;; it under the terms of the GNU General Public License as published by 13 ;; the Free Software Foundation, either version 3 of the License, or 14 ;; (at your option) any later version. 15 16 ;; GNU Emacs is distributed in the hope that it will be useful, 17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 ;; GNU General Public License for more details. 20 21 ;; You should have received a copy of the GNU General Public License 22 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. 23 24 ;;; Commentary: 25 26 ;; Org-Babel support for evaluating shell source code. 27 28 ;;; Code: 29 30 (require 'org-macs) 31 (org-assert-version) 32 33 (require 'ob) 34 (require 'org-macs) 35 (require 'shell) 36 (require 'cl-lib) 37 38 (declare-function org-babel-comint-in-buffer "ob-comint" (buffer &rest body) 39 t) 40 (declare-function org-babel-comint-wait-for-output "ob-comint" (buffer)) 41 (declare-function org-babel-comint-buffer-livep "ob-comint" (buffer)) 42 (declare-function org-babel-comint-with-output "ob-comint" (meta &rest body) 43 t) 44 (declare-function orgtbl-to-generic "org-table" (table params)) 45 46 (defvar org-babel-default-header-args:shell '()) 47 (defvar org-babel-shell-names) 48 49 (defconst org-babel-shell-set-prompt-commands 50 '(;; Fish has no PS2 equivalent. 51 ("fish" . "function fish_prompt\n\techo \"%s\"\nend") 52 ;; prompt2 is like PS2 in POSIX shells. 53 ("csh" . "set prompt=\"%s\"\nset prompt2=\"\"") 54 ;; PowerShell, similar to fish, does not have PS2 equivalent. 55 ("posh" . "function prompt { \"%s\" }") 56 ;; PROMPT_COMMAND can override PS1 settings. Disable it. 57 ;; Disable PS2 to avoid garbage in multi-line inputs. 58 (t . "PROMPT_COMMAND=;PS1=\"%s\";PS2=")) 59 "Alist assigning shells with their prompt setting command. 60 61 Each element of the alist associates a shell type from 62 `org-babel-shell-names' with a template used to create a command to 63 change the default prompt. The template is an argument to `format' 64 that will be called with a single additional argument: prompt string. 65 66 The fallback association template is defined in (t . \"template\") 67 alist element.") 68 69 (defvar org-babel-prompt-command) 70 71 (defun org-babel-shell-initialize () 72 "Define execution functions associated to shell names. 73 This function has to be called whenever `org-babel-shell-names' 74 is modified outside the Customize interface." 75 (interactive) 76 (dolist (name org-babel-shell-names) 77 (eval `(defun ,(intern (concat "org-babel-execute:" name)) 78 (body params) 79 ,(format "Execute a block of %s commands with Babel." name) 80 (let ((shell-file-name ,name) 81 (org-babel-prompt-command 82 (or (cdr (assoc ,name org-babel-shell-set-prompt-commands)) 83 (alist-get t org-babel-shell-set-prompt-commands)))) 84 (org-babel-execute:shell body params)))) 85 (eval `(defalias ',(intern (concat "org-babel-variable-assignments:" name)) 86 'org-babel-variable-assignments:shell 87 ,(format "Return list of %s statements assigning to the block's \ 88 variables." 89 name))) 90 (eval `(defvar ,(intern (concat "org-babel-default-header-args:" name)) '())))) 91 92 (defcustom org-babel-shell-names 93 '("sh" "bash" "zsh" "fish" "csh" "ash" "dash" "ksh" "mksh" "posh") 94 "List of names of shell supported by babel shell code blocks. 95 Call `org-babel-shell-initialize' when modifying this variable 96 outside the Customize interface." 97 :group 'org-babel 98 :type '(repeat (string :tag "Shell name: ")) 99 :set (lambda (symbol value) 100 (set-default-toplevel-value symbol value) 101 (org-babel-shell-initialize))) 102 103 (defcustom org-babel-shell-results-defaults-to-output t 104 "Let shell execution defaults to \":results output\". 105 106 When set to t, use \":results output\" when no :results setting 107 is set. This is especially useful for inline source blocks. 108 109 When set to nil, stick to the convention of using :results value 110 as the default setting when no :results is set, the \"value\" of 111 a shell execution being its exit code." 112 :group 'org-babel 113 :type 'boolean 114 :package-version '(Org . "9.4")) 115 116 (defun org-babel-execute:shell (body params) 117 "Execute a block of Shell commands with Babel. 118 This function is called by `org-babel-execute-src-block'." 119 (let* ((session (org-babel-sh-initiate-session 120 (cdr (assq :session params)))) 121 (stdin (let ((stdin (cdr (assq :stdin params)))) 122 (when stdin (org-babel-sh-var-to-string 123 (org-babel-ref-resolve stdin))))) 124 (results-params (cdr (assq :result-params params))) 125 (value-is-exit-status 126 (or (and 127 (equal '("replace") results-params) 128 (not org-babel-shell-results-defaults-to-output)) 129 (member "value" results-params))) 130 (cmdline (cdr (assq :cmdline params))) 131 (full-body (concat 132 (org-babel-expand-body:generic 133 body params (org-babel-variable-assignments:shell params)) 134 (when value-is-exit-status "\necho $?")))) 135 (org-babel-reassemble-table 136 (org-babel-sh-evaluate session full-body params stdin cmdline) 137 (org-babel-pick-name 138 (cdr (assq :colname-names params)) (cdr (assq :colnames params))) 139 (org-babel-pick-name 140 (cdr (assq :rowname-names params)) (cdr (assq :rownames params)))))) 141 142 (defun org-babel-prep-session:shell (session params) 143 "Prepare SESSION according to the header arguments specified in PARAMS." 144 (let* ((session (org-babel-sh-initiate-session session)) 145 (var-lines (org-babel-variable-assignments:shell params))) 146 (org-babel-comint-in-buffer session 147 (mapc (lambda (var) 148 (insert var) (comint-send-input nil t) 149 (org-babel-comint-wait-for-output session)) 150 var-lines)) 151 session)) 152 153 (defun org-babel-load-session:shell (session body params) 154 "Load BODY into SESSION." 155 (save-window-excursion 156 (let ((buffer (org-babel-prep-session:shell session params))) 157 (with-current-buffer buffer 158 (goto-char (process-mark (get-buffer-process (current-buffer)))) 159 (insert (org-babel-chomp body))) 160 buffer))) 161 162 163 ;;; Helper functions 164 (defun org-babel--variable-assignments:sh-generic 165 (varname values &optional sep hline) 166 "Return a list of statements declaring the values as a generic variable." 167 (format "%s=%s" varname (org-babel-sh-var-to-sh values sep hline))) 168 169 (defun org-babel--variable-assignments:bash_array 170 (varname values &optional sep hline) 171 "Return a list of statements declaring the values as a bash array." 172 (format "unset %s\ndeclare -a %s=( %s )" 173 varname varname 174 (mapconcat 175 (lambda (value) (org-babel-sh-var-to-sh value sep hline)) 176 values 177 " "))) 178 179 (defun org-babel--variable-assignments:bash_assoc 180 (varname values &optional sep hline) 181 "Return a list of statements declaring the values as bash associative array." 182 (format "unset %s\ndeclare -A %s\n%s" 183 varname varname 184 (mapconcat 185 (lambda (items) 186 (format "%s[%s]=%s" 187 varname 188 (org-babel-sh-var-to-sh (car items) sep hline) 189 (org-babel-sh-var-to-sh (cdr items) sep hline))) 190 values 191 "\n"))) 192 193 (defun org-babel--variable-assignments:bash (varname values &optional sep hline) 194 "Represent the parameters as useful Bash shell variables." 195 (pcase values 196 (`((,_ ,_ . ,_) . ,_) ;two-dimensional array 197 (org-babel--variable-assignments:bash_assoc varname values sep hline)) 198 (`(,_ . ,_) ;simple list 199 (org-babel--variable-assignments:bash_array varname values sep hline)) 200 (_ ;scalar value 201 (org-babel--variable-assignments:sh-generic varname values sep hline)))) 202 203 (defun org-babel-variable-assignments:shell (params) 204 "Return list of shell statements assigning the block's variables." 205 (let ((sep (cdr (assq :separator params))) 206 (hline (when (string= "yes" (cdr (assq :hlines params))) 207 (or (cdr (assq :hline-string params)) 208 "hline")))) 209 (mapcar 210 (lambda (pair) 211 (if (string-suffix-p "bash" shell-file-name) 212 (org-babel--variable-assignments:bash 213 (car pair) (cdr pair) sep hline) 214 (org-babel--variable-assignments:sh-generic 215 (car pair) (cdr pair) sep hline))) 216 (org-babel--get-vars params)))) 217 218 (defun org-babel-sh-var-to-sh (var &optional sep hline) 219 "Convert an elisp value to a shell variable. 220 Convert an elisp var into a string of shell commands specifying a 221 var of the same value." 222 (concat "'" (replace-regexp-in-string 223 "'" "'\"'\"'" 224 (org-babel-sh-var-to-string var sep hline)) 225 "'")) 226 227 (defun org-babel-sh-var-to-string (var &optional sep hline) 228 "Convert an elisp value to a string." 229 (let ((echo-var (lambda (v) (if (stringp v) v (format "%S" v))))) 230 (cond 231 ((and (listp var) (or (listp (car var)) (eq (car var) 'hline))) 232 (orgtbl-to-generic var (list :sep (or sep "\t") :fmt echo-var 233 :hline hline))) 234 ((listp var) 235 (mapconcat echo-var var "\n")) 236 (t (funcall echo-var var))))) 237 238 (defvar org-babel-sh-eoe-indicator "echo 'org_babel_sh_eoe'" 239 "String to indicate that evaluation has completed.") 240 (defvar org-babel-sh-eoe-output "org_babel_sh_eoe" 241 "String to indicate that evaluation has completed.") 242 (defvar org-babel-sh-prompt "org_babel_sh_prompt> " 243 "String to set prompt in session shell.") 244 245 (defun org-babel-sh-initiate-session (&optional session _params) 246 "Initiate a session named SESSION according to PARAMS." 247 (when (and session (not (string= session "none"))) 248 (save-window-excursion 249 (or (org-babel-comint-buffer-livep session) 250 (progn 251 (shell session) 252 ;; Set unique prompt for easier analysis of the output. 253 (org-babel-comint-wait-for-output (current-buffer)) 254 (org-babel-comint-input-command 255 (current-buffer) 256 (format org-babel-prompt-command org-babel-sh-prompt)) 257 (setq-local comint-prompt-regexp 258 (concat "^" (regexp-quote org-babel-sh-prompt) 259 " *")) 260 ;; Needed for Emacs 23 since the marker is initially 261 ;; undefined and the filter functions try to use it without 262 ;; checking. 263 (set-marker comint-last-output-start (point)) 264 (get-buffer (current-buffer))))))) 265 266 (defun org-babel-sh-evaluate (session body &optional params stdin cmdline) 267 "Pass BODY to the Shell process in BUFFER. 268 If RESULT-TYPE equals `output' then return a list of the outputs 269 of the statements in BODY, if RESULT-TYPE equals `value' then 270 return the value of the last statement in BODY." 271 (let* ((shebang (cdr (assq :shebang params))) 272 (results-params (cdr (assq :result-params params))) 273 (value-is-exit-status 274 (or (and 275 (equal '("replace") results-params) 276 (not org-babel-shell-results-defaults-to-output)) 277 (member "value" results-params))) 278 (results 279 (cond 280 ((or stdin cmdline) ; external shell script w/STDIN 281 (let ((script-file (org-babel-temp-file "sh-script-")) 282 (stdin-file (org-babel-temp-file "sh-stdin-")) 283 (padline (not (string= "no" (cdr (assq :padline params)))))) 284 (with-temp-file script-file 285 (when shebang (insert shebang "\n")) 286 (when padline (insert "\n")) 287 (insert body)) 288 (set-file-modes script-file #o755) 289 (with-temp-file stdin-file (insert (or stdin ""))) 290 (with-temp-buffer 291 (with-connection-local-variables 292 (apply #'process-file 293 (if shebang (file-local-name script-file) 294 shell-file-name) 295 stdin-file 296 (current-buffer) 297 nil 298 (if shebang (when cmdline (list cmdline)) 299 (list shell-command-switch 300 (concat (file-local-name script-file) " " cmdline))))) 301 (buffer-string)))) 302 (session ; session evaluation 303 (mapconcat 304 #'org-babel-sh-strip-weird-long-prompt 305 (mapcar 306 #'org-trim 307 (butlast ; Remove eoe indicator 308 (org-babel-comint-with-output 309 (session org-babel-sh-eoe-output t body) 310 (insert (org-trim body) "\n" 311 org-babel-sh-eoe-indicator) 312 (comint-send-input nil t)) 313 ;; Remove `org-babel-sh-eoe-indicator' output line. 314 1)) 315 "\n")) 316 ;; External shell script, with or without a predefined 317 ;; shebang. 318 ((org-string-nw-p shebang) 319 (let ((script-file (org-babel-temp-file "sh-script-")) 320 (padline (not (equal "no" (cdr (assq :padline params)))))) 321 (with-temp-file script-file 322 (insert shebang "\n") 323 (when padline (insert "\n")) 324 (insert body)) 325 (set-file-modes script-file #o755) 326 (org-babel-eval script-file ""))) 327 (t (org-babel-eval shell-file-name (org-trim body)))))) 328 (when (and results value-is-exit-status) 329 (setq results (car (reverse (split-string results "\n" t))))) 330 (when results 331 (let ((result-params (cdr (assq :result-params params)))) 332 (org-babel-result-cond result-params 333 results 334 (let ((tmp-file (org-babel-temp-file "sh-"))) 335 (with-temp-file tmp-file (insert results)) 336 (org-babel-import-elisp-from-file tmp-file))))))) 337 338 (defun org-babel-sh-strip-weird-long-prompt (string) 339 "Remove prompt cruft from a string of shell output." 340 (while (string-match "^% +[\r\n$]+ *" string) 341 (setq string (substring string (match-end 0)))) 342 string) 343 344 (provide 'ob-shell) 345 346 ;;; ob-shell.el ends here