lisp/ob-shell.el

   1 ;;; ob-shell.el --- Babel Functions for Shell Evaluation -*- lexical-binding: t; -*-
   2
   3 ;; Copyright (C) 2009-2016 Free Software Foundation, Inc.
   4
   5 ;; Author: Eric Schulte
   6 ;; Keywords: literate programming, reproducible research
   7 ;; Homepage: http://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 <http://www.gnu.org/licenses/>.
  23
  24 ;;; Commentary:
  25
  26 ;; Org-Babel support for evaluating shell source code.
  27
  28 ;;; Code:
  29 (require 'ob)
  30 (require 'shell)
  31 (eval-when-compile (require 'cl))
  32
  33 (declare-function org-babel-comint-in-buffer "ob-comint" (buffer &rest body)
  34                   t)
  35 (declare-function org-babel-comint-wait-for-output "ob-comint" (buffer))
  36 (declare-function org-babel-comint-buffer-livep "ob-comint" (buffer))
  37 (declare-function org-babel-comint-with-output "ob-comint" (meta &rest body)
  38                   t)
  39 (declare-function orgtbl-to-generic "org-table" (table params))
  40
  41 (defvar org-babel-default-header-args:shell '())
  42
  43 (defcustom org-babel-shell-names
  44   '("sh" "bash" "csh" "ash" "dash" "ksh" "mksh" "posh")
  45   "List of names of shell supported by babel shell code blocks."
  46   :group 'org-babel
  47   :type '(repeat (string :tag "Shell name: "))
  48   :set (lambda (symbol value)
  49          (set-default symbol value)
  50          (dolist (name value)
  51            (eval `(defun ,(intern (concat "org-babel-execute:" name))
  52                       (body params)
  53                     ,(format "Execute a block of %s commands with Babel." name)
  54                     (let ((shell-file-name ,name))
  55                       (org-babel-execute:shell body params)))
  56                  t))))
  57
  58 (defun org-babel-execute:shell (body params)
  59   "Execute a block of Shell commands with Babel.
  60 This function is called by `org-babel-execute-src-block'."
  61   (let* ((session (org-babel-sh-initiate-session
  62                    (cdr (assoc :session params))))
  63          (stdin (let ((stdin (cdr (assoc :stdin params))))
  64                   (when stdin (org-babel-sh-var-to-string
  65                                (org-babel-ref-resolve stdin)))))
  66          (cmdline (cdr (assoc :cmdline params)))
  67          (full-body (org-babel-expand-body:generic
  68                      body params (org-babel-variable-assignments:shell params))))
  69     (org-babel-reassemble-table
  70      (org-babel-sh-evaluate session full-body params stdin cmdline)
  71      (org-babel-pick-name
  72       (cdr (assoc :colname-names params)) (cdr (assoc :colnames params)))
  73      (org-babel-pick-name
  74       (cdr (assoc :rowname-names params)) (cdr (assoc :rownames params))))))
  75
  76 (defun org-babel-prep-session:shell (session params)
  77   "Prepare SESSION according to the header arguments specified in PARAMS."
  78   (let* ((session (org-babel-sh-initiate-session session))
  79          (var-lines (org-babel-variable-assignments:shell params)))
  80     (org-babel-comint-in-buffer session
  81       (mapc (lambda (var)
  82               (insert var) (comint-send-input nil t)
  83               (org-babel-comint-wait-for-output session)) var-lines))
  84     session))
  85
  86 (defun org-babel-load-session:shell (session body params)
  87   "Load BODY into SESSION."
  88   (save-window-excursion
  89     (let ((buffer (org-babel-prep-session:shell session params)))
  90       (with-current-buffer buffer
  91         (goto-char (process-mark (get-buffer-process (current-buffer))))
  92         (insert (org-babel-chomp body)))
  93       buffer)))
  94
  95 ;; helper functions
  96 (defun org-babel-variable-assignments:sh-generic
  97     (varname values &optional sep hline)
  98   "Returns a list of statements declaring the values as a generic variable."
  99   (format "%s=%s" varname (org-babel-sh-var-to-sh values sep hline)))
 100
 101 (defun org-babel-variable-assignments:bash_array
 102     (varname values &optional sep hline)
 103   "Returns a list of statements declaring the values as a bash array."
 104   (format "unset %s\ndeclare -a %s=( %s )"
 105           varname varname
 106           (mapconcat
 107            (lambda (value) (org-babel-sh-var-to-sh value sep hline))
 108            values
 109            " ")))
 110
 111 (defun org-babel-variable-assignments:bash_assoc
 112     (varname values &optional sep hline)
 113   "Returns a list of statements declaring the values as bash associative array."
 114   (format "unset %s\ndeclare -A %s\n%s"
 115     varname varname
 116     (mapconcat
 117      (lambda (items)
 118        (format "%s[%s]=%s"
 119                varname
 120                (org-babel-sh-var-to-sh (car items) sep hline)
 121                (org-babel-sh-var-to-sh (cdr items) sep hline)))
 122      values
 123      "\n")))
 124
 125 (defun org-babel-variable-assignments:bash (varname values &optional sep hline)
 126   "Represents the parameters as useful Bash shell variables."
 127   (if (listp values)
 128       (if (and (listp (car values)) (= 1 (length (car values))))
 129           (org-babel-variable-assignments:bash_array varname values sep hline)
 130         (org-babel-variable-assignments:bash_assoc varname values sep hline))
 131     (org-babel-variable-assignments:sh-generic varname values sep hline)))
 132
 133 (defun org-babel-variable-assignments:shell (params)
 134   "Return list of shell statements assigning the block's variables."
 135   (let ((sep (cdr (assoc :separator params)))
 136         (hline (when (string= "yes" (cdr (assoc :hlines params)))
 137                  (or (cdr (assoc :hline-string params))
 138                      "hline"))))
 139     (mapcar
 140      (lambda (pair)
 141        (if (string-match "bash$" shell-file-name)
 142            (org-babel-variable-assignments:bash
 143             (car pair) (cdr pair) sep hline)
 144          (org-babel-variable-assignments:sh-generic
 145           (car pair) (cdr pair) sep hline)))
 146      (org-babel--get-vars params))))
 147
 148 (defun org-babel-sh-var-to-sh (var &optional sep hline)
 149   "Convert an elisp value to a shell variable.
 150 Convert an elisp var into a string of shell commands specifying a
 151 var of the same value."
 152   (concat "'" (replace-regexp-in-string
 153                "'" "'\"'\"'"
 154                (org-babel-sh-var-to-string var sep hline))
 155           "'"))
 156
 157 (defun org-babel-sh-var-to-string (var &optional sep hline)
 158   "Convert an elisp value to a string."
 159   (let ((echo-var (lambda (v) (if (stringp v) v (format "%S" v)))))
 160     (cond
 161      ((and (listp var) (or (listp (car var)) (equal (car var) 'hline)))
 162       (orgtbl-to-generic var  (list :sep (or sep "\t") :fmt echo-var
 163                                     :hline hline)))
 164      ((listp var)
 165       (mapconcat echo-var var "\n"))
 166      (t (funcall echo-var var)))))
 167
 168 (defun org-babel-sh-initiate-session (&optional session _params)
 169   "Initiate a session named SESSION according to PARAMS."
 170   (when (and session (not (string= session "none")))
 171     (save-window-excursion
 172       (or (org-babel-comint-buffer-livep session)
 173           (progn
 174             (shell session)
 175             ;; Needed for Emacs 23 since the marker is initially
 176             ;; undefined and the filter functions try to use it without
 177             ;; checking.
 178             (set-marker comint-last-output-start (point))
 179             (get-buffer (current-buffer)))))))
 180
 181 (defvar org-babel-sh-eoe-indicator "echo 'org_babel_sh_eoe'"
 182   "String to indicate that evaluation has completed.")
 183 (defvar org-babel-sh-eoe-output "org_babel_sh_eoe"
 184   "String to indicate that evaluation has completed.")
 185
 186 (defun org-babel-sh-evaluate (session body &optional params stdin cmdline)
 187   "Pass BODY to the Shell process in BUFFER.
 188 If RESULT-TYPE equals `output' then return a list of the outputs
 189 of the statements in BODY, if RESULT-TYPE equals `value' then
 190 return the value of the last statement in BODY."
 191   (let ((results
 192          (cond
 193           ((or stdin cmdline)          ; external shell script w/STDIN
 194            (let ((script-file (org-babel-temp-file "sh-script-"))
 195                  (stdin-file (org-babel-temp-file "sh-stdin-"))
 196                  (shebang (cdr (assoc :shebang params)))
 197                  (padline (not (string= "no" (cdr (assoc :padline params))))))
 198              (with-temp-file script-file
 199                (when shebang (insert (concat shebang "\n")))
 200                (when padline (insert "\n"))
 201                (insert body))
 202              (set-file-modes script-file #o755)
 203              (with-temp-file stdin-file (insert (or stdin "")))
 204              (with-temp-buffer
 205                (call-process-shell-command
 206                 (concat (if shebang script-file
 207                           (format "%s %s" shell-file-name script-file))
 208                         (and cmdline (concat " " cmdline)))
 209                 stdin-file
 210                 (current-buffer))
 211                (buffer-string))))
 212           (session                      ; session evaluation
 213            (mapconcat
 214             #'org-babel-sh-strip-weird-long-prompt
 215             (mapcar
 216              #'org-babel-trim
 217              (butlast
 218               (org-babel-comint-with-output
 219                   (session org-babel-sh-eoe-output t body)
 220                 (mapc
 221                  (lambda (line)
 222                    (insert line)
 223                    (comint-send-input nil t)
 224                    (while (save-excursion
 225                             (goto-char comint-last-input-end)
 226                             (not (re-search-forward
 227                                   comint-prompt-regexp nil t)))
 228                      (accept-process-output
 229                       (get-buffer-process (current-buffer)))))
 230                  (append
 231                   (split-string (org-babel-trim body) "\n")
 232                   (list org-babel-sh-eoe-indicator))))
 233               2)) "\n"))
 234           ('otherwise                   ; external shell script
 235            (if (and (cdr (assoc :shebang params))
 236                     (> (length (cdr (assoc :shebang params))) 0))
 237                (let ((script-file (org-babel-temp-file "sh-script-"))
 238                      (shebang (cdr (assoc :shebang params)))
 239                      (padline (not (equal "no" (cdr (assoc :padline params))))))
 240                  (with-temp-file script-file
 241                    (when shebang (insert (concat shebang "\n")))
 242                    (when padline (insert "\n"))
 243                    (insert body))
 244                  (set-file-modes script-file #o755)
 245                  (org-babel-eval script-file ""))
 246              (org-babel-eval shell-file-name (org-babel-trim body)))))))
 247     (when results
 248       (let ((result-params (cdr (assoc :result-params params))))
 249         (org-babel-result-cond result-params
 250           results
 251           (let ((tmp-file (org-babel-temp-file "sh-")))
 252             (with-temp-file tmp-file (insert results))
 253             (org-babel-import-elisp-from-file tmp-file)))))))
 254
 255 (defun org-babel-sh-strip-weird-long-prompt (string)
 256   "Remove prompt cruft from a string of shell output."
 257   (while (string-match "^% +[\r\n$]+ *" string)
 258     (setq string (substring string (match-end 0))))
 259   string)
 260
 261 (provide 'ob-shell)
 262
 263
 264
 265 ;;; ob-shell.el ends here