1 ;; notmuch-lib.el --- common variables, functions and function declarations
3 ;; Copyright © Carl Worth
5 ;; This file is part of Notmuch.
7 ;; Notmuch is free software: you can redistribute it and/or modify it
8 ;; under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation, either version 3 of the License, or
10 ;; (at your option) any later version.
12 ;; Notmuch is distributed in the hope that it will be useful, but
13 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 ;; General Public License for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with Notmuch. If not, see <http://www.gnu.org/licenses/>.
20 ;; Authors: Carl Worth <cworth@cworth.org>
22 ;; This is an part of an emacs-based interface to the notmuch mail system.
28 (autoload 'notmuch-jump-search "notmuch-jump"
29 "Jump to a saved search by shortcut key." t)
32 "Notmuch mail reader for Emacs."
35 (defgroup notmuch-hello nil
36 "Overview of saved searches, tags, etc."
39 (defgroup notmuch-search nil
40 "Searching and sorting mail."
43 (defgroup notmuch-show nil
44 "Showing messages and threads."
47 (defgroup notmuch-send nil
48 "Sending messages from Notmuch."
51 (custom-add-to-group 'notmuch-send 'message 'custom-group)
53 (defgroup notmuch-crypto nil
54 "Processing and display of cryptographic MIME parts."
57 (defgroup notmuch-hooks nil
58 "Running custom code on well-defined occasions."
61 (defgroup notmuch-external nil
62 "Running external commands from within Notmuch."
65 (defgroup notmuch-faces nil
66 "Graphical attributes for displaying text"
69 (defcustom notmuch-command "notmuch"
70 "Name of the notmuch binary.
72 This can be a relative or absolute path to the notmuch binary.
73 If this is a relative path, it will be searched for in all of the
74 directories given in `exec-path' (which is, by default, based on
77 :group 'notmuch-external)
79 (defcustom notmuch-search-oldest-first t
80 "Show the oldest mail first when searching.
82 This variable defines the default sort order for displaying
83 search results. Note that any filtered searches created by
84 `notmuch-search-filter' retain the search order of the parent
87 :group 'notmuch-search)
89 (defcustom notmuch-poll-script nil
90 "[Deprecated] Command to run to incorporate new mail into the notmuch database.
92 This option has been deprecated in favor of \"notmuch new\"
93 hooks (see man notmuch-hooks). To change the path to the notmuch
94 binary, customize `notmuch-command'.
96 This variable controls the action invoked by
97 `notmuch-poll-and-refresh-this-buffer' (bound by default to 'G')
98 to incorporate new mail into the notmuch database.
100 If set to nil (the default), new mail is processed by invoking
101 \"notmuch new\". Otherwise, this should be set to a string that
102 gives the name of an external script that processes new mail. If
103 set to the empty string, no command will be run.
105 The external script could do any of the following depending on
108 1. Invoke a program to transfer mail to the local mail store
109 2. Invoke \"notmuch new\" to incorporate the new mail
110 3. Invoke one or more \"notmuch tag\" commands to classify the mail"
111 :type '(choice (const :tag "notmuch new" nil)
112 (const :tag "Disabled" "")
113 (string :tag "Custom script"))
114 :group 'notmuch-external)
118 (defvar notmuch-search-history nil
119 "Variable to store notmuch searches history.")
121 (defcustom notmuch-archive-tags '("-inbox")
122 "List of tag changes to apply to a message or a thread when it is archived.
124 Tags starting with \"+\" (or not starting with either \"+\" or
125 \"-\") in the list will be added, and tags starting with \"-\"
126 will be removed from the message or thread being archived.
128 For example, if you wanted to remove an \"inbox\" tag and add an
129 \"archived\" tag, you would set:
130 (\"-inbox\" \"+archived\")"
131 :type '(repeat string)
132 :group 'notmuch-search
133 :group 'notmuch-show)
135 (defvar notmuch-common-keymap
136 (let ((map (make-sparse-keymap)))
137 (define-key map "?" 'notmuch-help)
138 (define-key map "q" 'notmuch-kill-this-buffer)
139 (define-key map "s" 'notmuch-search)
140 (define-key map "z" 'notmuch-tree)
141 (define-key map "m" 'notmuch-mua-new-mail)
142 (define-key map "=" 'notmuch-refresh-this-buffer)
143 (define-key map "G" 'notmuch-poll-and-refresh-this-buffer)
144 (define-key map "j" 'notmuch-jump-search)
146 "Keymap shared by all notmuch modes.")
148 ;; By default clicking on a button does not select the window
149 ;; containing the button (as opposed to clicking on a widget which
150 ;; does). This means that the button action is then executed in the
151 ;; current selected window which can cause problems if the button
152 ;; changes the buffer (e.g., id: links) or moves point.
154 ;; This provides a button type which overrides mouse-action so that
155 ;; the button's window is selected before the action is run. Other
156 ;; notmuch buttons can get the same behaviour by inheriting from this
158 (define-button-type 'notmuch-button-type
159 'mouse-action (lambda (button)
160 (select-window (posn-window (event-start last-input-event)))
161 (button-activate button)))
163 (defun notmuch-command-to-string (&rest args)
164 "Synchronously invoke \"notmuch\" with the given list of arguments.
166 If notmuch exits with a non-zero status, output from the process
167 will appear in a buffer named \"*Notmuch errors*\" and an error
170 Otherwise the output will be returned"
172 (let* ((status (apply #'call-process notmuch-command nil t nil args))
173 (output (buffer-string)))
174 (notmuch-check-exit-status status (cons notmuch-command args) output)
177 (defvar notmuch--cli-sane-p nil
178 "Cache whether the CLI seems to be configured sanely.")
180 (defun notmuch-cli-sane-p ()
181 "Return t if the cli seems to be configured sanely."
182 (unless notmuch--cli-sane-p
183 (let ((status (call-process notmuch-command nil nil nil
184 "config" "get" "user.primary_email")))
185 (setq notmuch--cli-sane-p (= status 0))))
188 (defun notmuch-assert-cli-sane ()
189 (unless (notmuch-cli-sane-p)
190 (notmuch-logged-error
191 "notmuch cli seems misconfigured or unconfigured."
192 "Perhaps you haven't run \"notmuch setup\" yet? Try running this
193 on the command line, and then retry your notmuch command")))
195 (defun notmuch-version ()
196 "Return a string with the notmuch version number."
198 ;; Trim off the trailing newline.
199 (substring (notmuch-command-to-string "--version") 0 -1)))
200 (if (string-match "^notmuch\\( version\\)? \\(.*\\)$"
202 (match-string 2 long-string)
205 (defun notmuch-config-get (item)
206 "Return a value from the notmuch configuration."
207 (let* ((val (notmuch-command-to-string "config" "get" item))
209 ;; Trim off the trailing newline (if the value is empty or not
210 ;; configured, there will be no newline)
211 (if (and (> len 0) (= (aref val (- len 1)) ?\n))
215 (defun notmuch-database-path ()
216 "Return the database.path value from the notmuch configuration."
217 (notmuch-config-get "database.path"))
219 (defun notmuch-user-name ()
220 "Return the user.name value from the notmuch configuration."
221 (notmuch-config-get "user.name"))
223 (defun notmuch-user-primary-email ()
224 "Return the user.primary_email value from the notmuch configuration."
225 (notmuch-config-get "user.primary_email"))
227 (defun notmuch-user-other-email ()
228 "Return the user.other_email value (as a list) from the notmuch configuration."
229 (split-string (notmuch-config-get "user.other_email") "\n" t))
231 (defun notmuch-poll ()
232 "Run \"notmuch new\" or an external script to import mail.
234 Invokes `notmuch-poll-script', \"notmuch new\", or does nothing
235 depending on the value of `notmuch-poll-script'."
237 (if (stringp notmuch-poll-script)
238 (unless (string= notmuch-poll-script "")
239 (call-process notmuch-poll-script nil nil))
240 (call-process notmuch-command nil nil nil "new")))
242 (defun notmuch-kill-this-buffer ()
243 "Kill the current buffer."
245 (kill-buffer (current-buffer)))
247 (defun notmuch-documentation-first-line (symbol)
248 "Return the first line of the documentation string for SYMBOL."
249 (let ((doc (documentation symbol)))
252 (insert (documentation symbol t))
253 (goto-char (point-min))
256 (buffer-substring beg (point))))
259 (defun notmuch-prefix-key-description (key)
260 "Given a prefix key code, return a human-readable string representation.
262 This is basically just `format-kbd-macro' but we also convert ESC to M-."
263 (let* ((key-vector (if (vectorp key) key (vector key)))
264 (desc (format-kbd-macro key-vector)))
265 (if (string= desc "ESC")
270 (defun notmuch-describe-key (actual-key binding prefix ua-keys tail)
271 "Prepend cons cells describing prefix-arg ACTUAL-KEY and ACTUAL-KEY to TAIL
273 It does not prepend if ACTUAL-KEY is already listed in TAIL."
274 (let ((key-string (concat prefix (format-kbd-macro actual-key))))
275 ;; We don't include documentation if the key-binding is
276 ;; over-ridden. Note, over-riding a binding automatically hides the
277 ;; prefixed version too.
278 (unless (assoc key-string tail)
279 (when (and ua-keys (symbolp binding)
280 (get binding 'notmuch-prefix-doc))
281 ;; Documentation for prefixed command
282 (let ((ua-desc (key-description ua-keys)))
283 (push (cons (concat ua-desc " " prefix (format-kbd-macro actual-key))
284 (get binding 'notmuch-prefix-doc))
286 ;; Documentation for command
287 (push (cons key-string
288 (or (and (symbolp binding) (get binding 'notmuch-doc))
289 (notmuch-documentation-first-line binding)))
293 (defun notmuch-describe-remaps (remap-keymap ua-keys base-keymap prefix tail)
294 ;; Remappings are represented as a binding whose first "event" is
295 ;; 'remap. Hence, if the keymap has any remappings, it will have a
296 ;; binding whose "key" is 'remap, and whose "binding" is itself a
297 ;; keymap that maps not from keys to commands, but from old (remapped)
298 ;; functions to the commands to use in their stead.
300 (lambda (command binding)
303 (setq tail (notmuch-describe-key actual-key binding prefix ua-keys tail)))
304 (where-is-internal command base-keymap)))
308 (defun notmuch-describe-keymap (keymap ua-keys base-keymap &optional prefix tail)
309 "Return a list of cons cells, each describing one binding in KEYMAP.
311 Each cons cell consists of a string giving a human-readable
312 description of the key, and a one-line description of the bound
313 function. See `notmuch-help' for an overview of how this
314 documentation is extracted.
316 UA-KEYS should be a key sequence bound to `universal-argument'.
317 It will be used to describe bindings of commands that support a
318 prefix argument. PREFIX and TAIL are used internally."
320 (lambda (key binding)
321 (cond ((mouse-event-p key) nil)
325 (notmuch-describe-remaps
326 binding ua-keys base-keymap prefix tail)
327 (notmuch-describe-keymap
328 binding ua-keys base-keymap (notmuch-prefix-key-description key) tail))))
330 (setq tail (notmuch-describe-key (vector key) binding prefix ua-keys tail)))))
334 (defun notmuch-substitute-command-keys (doc)
335 "Like `substitute-command-keys' but with documentation, not function names."
337 (while (string-match "\\\\{\\([^}[:space:]]*\\)}" doc beg)
340 (let* ((keymap-name (substring doc (match-beginning 1) (match-end 1)))
341 (keymap (symbol-value (intern keymap-name)))
342 (ua-keys (where-is-internal 'universal-argument keymap t))
343 (desc-alist (notmuch-describe-keymap keymap ua-keys keymap))
344 (desc-list (mapcar (lambda (arg) (concat (car arg) "\t" (cdr arg))) desc-alist)))
345 (mapconcat #'identity desc-list "\n")))))
346 (setq doc (replace-match desc 1 1 doc)))
347 (setq beg (match-end 0)))
350 (defun notmuch-help ()
351 "Display help for the current notmuch mode.
353 This is similar to `describe-function' for the current major
354 mode, but bindings tables are shown with documentation strings
355 rather than command names. By default, this uses the first line
356 of each command's documentation string. A command can override
357 this by setting the 'notmuch-doc property of its command symbol.
358 A command that supports a prefix argument can explicitly document
359 its prefixed behavior by setting the 'notmuch-prefix-doc property
360 of its command symbol."
362 (let* ((mode major-mode)
363 (doc (substitute-command-keys (notmuch-substitute-command-keys (documentation mode t)))))
364 (with-current-buffer (generate-new-buffer "*notmuch-help*")
366 (goto-char (point-min))
367 (set-buffer-modified-p nil)
368 (view-buffer (current-buffer) 'kill-buffer-if-not-modified))))
370 (defun notmuch-subkeymap-help ()
371 "Show help for a subkeymap."
373 (let* ((key (this-command-keys-vector))
374 (prefix (make-vector (1- (length key)) nil))
376 (while (< i (length prefix))
377 (aset prefix i (aref key i))
380 (let* ((subkeymap (key-binding prefix))
381 (ua-keys (where-is-internal 'universal-argument nil t))
382 (prefix-string (notmuch-prefix-key-description prefix))
383 (desc-alist (notmuch-describe-keymap subkeymap ua-keys subkeymap prefix-string))
384 (desc-list (mapcar (lambda (arg) (concat (car arg) "\t" (cdr arg))) desc-alist))
385 (desc (mapconcat #'identity desc-list "\n")))
386 (with-help-window (help-buffer)
387 (with-current-buffer standard-output
388 (insert "\nPress 'q' to quit this window.\n\n")
390 (pop-to-buffer (help-buffer)))))
392 (defvar notmuch-buffer-refresh-function nil
393 "Function to call to refresh the current buffer.")
394 (make-variable-buffer-local 'notmuch-buffer-refresh-function)
396 (defun notmuch-refresh-this-buffer ()
397 "Refresh the current buffer."
399 (when notmuch-buffer-refresh-function
400 (if (commandp notmuch-buffer-refresh-function)
401 ;; Pass prefix argument, etc.
402 (call-interactively notmuch-buffer-refresh-function)
403 (funcall notmuch-buffer-refresh-function))))
405 (defun notmuch-poll-and-refresh-this-buffer ()
406 "Invoke `notmuch-poll' to import mail, then refresh the current buffer."
409 (notmuch-refresh-this-buffer))
411 (defun notmuch-prettify-subject (subject)
412 ;; This function is used by `notmuch-search-process-filter' which
413 ;; requires that we not disrupt its' matching state.
416 (string-match "^[ \t]*$" subject))
420 (defun notmuch-sanitize (str)
421 "Sanitize control character in STR.
423 This includes newlines, tabs, and other funny characters."
424 (replace-regexp-in-string "[[:cntrl:]\x7f\u2028\u2029]+" " " str))
426 (defun notmuch-escape-boolean-term (term)
427 "Escape a boolean term for use in a query.
429 The caller is responsible for prepending the term prefix and a
430 colon. This performs minimal escaping in order to produce
431 user-friendly queries."
434 (if (or (equal term "")
435 ;; To be pessimistic, only pass through terms composed
436 ;; entirely of ASCII printing characters other than ", (,
438 (string-match "[^!#-'*-~]" term))
440 (concat "\"" (replace-regexp-in-string "\"" "\"\"" term t t) "\"")
443 (defun notmuch-id-to-query (id)
444 "Return a query that matches the message with id ID."
445 (concat "id:" (notmuch-escape-boolean-term id)))
447 (defun notmuch-hex-encode (str)
448 "Hex-encode STR (e.g., as used by batch tagging).
450 This replaces spaces, percents, and double quotes in STR with
451 %NN where NN is the hexadecimal value of the character."
452 (replace-regexp-in-string
453 "[ %\"]" (lambda (match) (format "%%%02x" (aref match 0))) str))
457 (defun notmuch-common-do-stash (text)
458 "Common function to stash text in kill ring, and display in minibuffer."
462 (message "Stashed: %s" text))
463 ;; There is nothing to stash so stash an empty string so the user
464 ;; doesn't accidentally paste something else somewhere.
466 (message "Nothing to stash!")))
470 (defun notmuch-remove-if-not (predicate list)
471 "Return a copy of LIST with all items not satisfying PREDICATE removed."
474 (when (funcall predicate (car list))
475 (push (car list) out))
476 (setq list (cdr list)))
479 (defun notmuch-plist-delete (plist property)
480 (let* ((xplist (cons nil plist))
483 (when (eq (cadr pred) property)
484 (setcdr pred (cdddr pred)))
485 (setq pred (cddr pred)))
488 (defun notmuch-split-content-type (content-type)
489 "Split content/type into 'content' and 'type'"
490 (split-string content-type "/"))
492 (defun notmuch-match-content-type (t1 t2)
493 "Return t if t1 and t2 are matching content types, taking wildcards into account"
494 (let ((st1 (notmuch-split-content-type t1))
495 (st2 (notmuch-split-content-type t2)))
496 (if (or (string= (cadr st1) "*")
497 (string= (cadr st2) "*"))
498 ;; Comparison of content types should be case insensitive.
499 (string= (downcase (car st1)) (downcase (car st2)))
500 (string= (downcase t1) (downcase t2)))))
502 (defvar notmuch-multipart/alternative-discouraged
506 ;; multipart/related usually contain a text/html part and some associated graphics.
510 (defun notmuch-multipart/alternative-choose (types)
511 "Return a list of preferred types from the given list of types"
512 ;; Based on `mm-preferred-alternative-precedence'.
514 (dolist (pref (reverse notmuch-multipart/alternative-discouraged))
515 (dolist (elem (copy-sequence seq))
516 (when (string-match pref elem)
517 (setq seq (nconc (delete elem seq) (list elem))))))
520 (defun notmuch-parts-filter-by-type (parts type)
521 "Given a list of message parts, return a list containing the ones matching
524 (lambda (part) (notmuch-match-content-type (plist-get part :content-type) type))
527 ;; Helper for parts which are generally not included in the default
529 (defun notmuch-get-bodypart-internal (query part-number process-crypto)
530 (let ((args '("show" "--format=raw"))
531 (part-arg (format "--part=%s" part-number)))
532 (setq args (append args (list part-arg)))
534 (setq args (append args '("--decrypt"))))
535 (setq args (append args (list query)))
537 (let ((coding-system-for-read 'no-conversion))
539 (apply 'call-process (append (list notmuch-command nil (list t nil) nil) args))
542 (defun notmuch-get-bodypart-content (msg part process-crypto)
543 (or (plist-get part :content)
544 (notmuch-get-bodypart-internal (notmuch-id-to-query (plist-get msg :id))
545 (plist-get part :id) process-crypto)))
547 ;; Workaround: The call to `mm-display-part' below triggers a bug in
548 ;; Emacs 24 if it attempts to use the shr renderer to display an HTML
549 ;; part with images in it (demonstrated in 24.1 and 24.2 on Debian and
550 ;; Fedora 17, though unreproducable in other configurations).
551 ;; `mm-shr' references the variable `gnus-inhibit-images' without
552 ;; first loading gnus-art, which defines it, resulting in a
553 ;; void-variable error. Hence, we advise `mm-shr' to ensure gnus-art
555 (if (>= emacs-major-version 24)
556 (defadvice mm-shr (before load-gnus-arts activate)
557 (require 'gnus-art nil t)
558 (ad-disable-advice 'mm-shr 'before 'load-gnus-arts)
559 (ad-activate 'mm-shr)))
561 (defun notmuch-mm-display-part-inline (msg part content-type process-crypto)
562 "Use the mm-decode/mm-view functions to display a part in the
563 current buffer, if possible."
564 (let ((display-buffer (current-buffer)))
566 ;; In case there is :content, the content string is already converted
567 ;; into emacs internal format. `gnus-decoded' is a fake charset,
568 ;; which means no further decoding (to be done by mm- functions).
569 (let* ((charset (if (plist-member part :content)
571 (plist-get part :content-charset)))
572 (handle (mm-make-handle (current-buffer) `(,content-type (charset . ,charset)))))
573 ;; If the user wants the part inlined, insert the content and
574 ;; test whether we are able to inline it (which includes both
575 ;; capability and suitability tests).
576 (when (mm-inlined-p handle)
577 (insert (notmuch-get-bodypart-content msg part process-crypto))
578 (when (mm-inlinable-p handle)
579 (set-buffer display-buffer)
580 (mm-display-part handle)
583 ;; Converts a plist of headers to an alist of headers. The input plist should
584 ;; have symbols of the form :Header as keys, and the resulting alist will have
585 ;; symbols of the form 'Header as keys.
586 (defun notmuch-headers-plist-to-alist (plist)
587 (loop for (key value . rest) on plist by #'cddr
588 collect (cons (intern (substring (symbol-name key) 1)) value)))
590 (defun notmuch-face-ensure-list-form (face)
591 "Return FACE in face list form.
593 If FACE is already a face list, it will be returned as-is. If
594 FACE is a face name or face plist, it will be returned as a
595 single element face list."
596 (if (and (listp face) (not (keywordp (car face))))
600 (defun notmuch-apply-face (object face &optional below start end)
601 "Combine FACE into the 'face text property of OBJECT between START and END.
603 This function combines FACE with any existing faces between START
604 and END in OBJECT. Attributes specified by FACE take precedence
605 over existing attributes unless BELOW is non-nil.
607 OBJECT may be a string, a buffer, or nil (which means the current
608 buffer). If object is a string, START and END are 0-based;
609 otherwise they are buffer positions (integers or markers). FACE
610 must be a face name (a symbol or string), a property list of face
611 attributes, or a list of these. If START and/or END are omitted,
612 they default to the beginning/end of OBJECT. For convenience
613 when applied to strings, this returns OBJECT."
615 ;; A face property can have three forms: a face name (a string or
616 ;; symbol), a property list, or a list of these two forms. In the
617 ;; list case, the faces will be combined, with the earlier faces
618 ;; taking precedent. Here we canonicalize everything to list form
619 ;; to make it easy to combine.
620 (let ((pos (cond (start start)
624 ((stringp object) (length object))
625 (t (1+ (buffer-size object)))))
626 (face-list (notmuch-face-ensure-list-form face)))
628 (let* ((cur (get-text-property pos 'face object))
629 (cur-list (notmuch-face-ensure-list-form cur))
630 (new (cond ((null cur-list) face)
631 (below (append cur-list face-list))
632 (t (append face-list cur-list))))
633 (next (next-single-property-change pos 'face object end)))
634 (put-text-property pos next 'face new object)
638 (defun notmuch-map-text-property (start end prop func &optional object)
639 "Transform text property PROP using FUNC.
641 Applies FUNC to each distinct value of the text property PROP
642 between START and END of OBJECT, setting PROP to the value
645 (let ((value (get-text-property start prop object))
646 (next (next-single-property-change start prop object end)))
647 (put-text-property start next prop (funcall func value) object)
650 (defun notmuch-logged-error (msg &optional extra)
651 "Log MSG and EXTRA to *Notmuch errors* and signal MSG.
653 This logs MSG and EXTRA to the *Notmuch errors* buffer and
654 signals MSG as an error. If EXTRA is non-nil, text referring the
655 user to the *Notmuch errors* buffer will be appended to the
656 signaled error. This function does not return."
658 (with-current-buffer (get-buffer-create "*Notmuch errors*")
659 (goto-char (point-max))
663 (insert "[" (current-time-string) "]\n" msg)
670 (error "%s" (concat msg (when extra
671 " (see *Notmuch errors* for more details)"))))
673 (defun notmuch-check-async-exit-status (proc msg &optional command err-file)
674 "If PROC exited abnormally, pop up an error buffer and signal an error.
676 This is a wrapper around `notmuch-check-exit-status' for
677 asynchronous process sentinels. PROC and MSG must be the
678 arguments passed to the sentinel. COMMAND and ERR-FILE, if
679 provided, are passed to `notmuch-check-exit-status'. If COMMAND
680 is not provided, it is taken from `process-command'."
682 (case (process-status proc)
683 ((exit) (process-exit-status proc))
686 (notmuch-check-exit-status exit-status (or command (process-command proc))
689 (defun notmuch-check-exit-status (exit-status command &optional output err-file)
690 "If EXIT-STATUS is non-zero, pop up an error buffer and signal an error.
692 If EXIT-STATUS is non-zero, pop up a notmuch error buffer
693 describing the error and signal an Elisp error. EXIT-STATUS must
694 be a number indicating the exit status code of a process or a
695 string describing the signal that terminated the process (such as
696 returned by `call-process'). COMMAND must be a list giving the
697 command and its arguments. OUTPUT, if provided, is a string
698 giving the output of command. ERR-FILE, if provided, is the name
699 of a file containing the error output of command. OUTPUT and the
700 contents of ERR-FILE will be included in the error message."
703 ((eq exit-status 0) t)
705 (notmuch-logged-error "notmuch CLI version mismatch
706 Emacs requested an older output format than supported by the notmuch CLI.
707 You may need to restart Emacs or upgrade your notmuch Emacs package."))
709 (notmuch-logged-error "notmuch CLI version mismatch
710 Emacs requested a newer output format than supported by the notmuch CLI.
711 You may need to restart Emacs or upgrade your notmuch package."))
713 (let* ((err (when err-file
715 (insert-file-contents err-file)
720 "command: " (mapconcat #'shell-quote-argument command " ") "\n"
721 (if (integerp exit-status)
722 (format "exit status: %s\n" exit-status)
723 (format "exit signal: %s\n" exit-status))
725 (concat "stderr:\n" err))
727 (concat "stdout:\n" output)))))
729 ;; We have an error message straight from the CLI.
730 (notmuch-logged-error
731 (replace-regexp-in-string "[ \n\r\t\f]*\\'" "" err) extra)
732 ;; We only have combined output from the CLI; don't inundate
733 ;; the user with it. Mimic `process-lines'.
734 (notmuch-logged-error (format "%s exited with status %s"
735 (car command) exit-status)
737 ;; `notmuch-logged-error' does not return.
740 (defun notmuch-call-notmuch--helper (destination args)
741 "Helper for synchronous notmuch invocation commands.
743 This wraps `call-process'. DESTINATION has the same meaning as
744 for `call-process'. ARGS is as described for
745 `notmuch-call-notmuch-process'."
748 (while (keywordp (car args))
750 (:stdin-string (setq stdin-string (cadr args)
753 (error "Unknown keyword argument: %s" (car args)))))
754 (if (null stdin-string)
755 (apply #'call-process notmuch-command nil destination nil args)
756 (insert stdin-string)
757 (apply #'call-process-region (point-min) (point-max)
758 notmuch-command t destination nil args))))
760 (defun notmuch-call-notmuch-process (&rest args)
761 "Synchronously invoke `notmuch-command' with ARGS.
763 The caller may provide keyword arguments before ARGS. Currently
764 supported keyword arguments are:
766 :stdin-string STRING - Write STRING to stdin
768 If notmuch exits with a non-zero status, output from the process
769 will appear in a buffer named \"*Notmuch errors*\" and an error
772 (let ((status (notmuch-call-notmuch--helper t args)))
773 (notmuch-check-exit-status status (cons notmuch-command args)
776 (defun notmuch-call-notmuch-sexp (&rest args)
777 "Invoke `notmuch-command' with ARGS and return the parsed S-exp output.
779 This is equivalent to `notmuch-call-notmuch-process', but parses
780 notmuch's output as an S-expression and returns the parsed value.
781 Like `notmuch-call-notmuch-process', if notmuch exits with a
782 non-zero status, this will report its output and signal an
786 (let ((err-file (make-temp-file "nmerr")))
788 (let ((status (notmuch-call-notmuch--helper (list t err-file) args)))
789 (notmuch-check-exit-status status (cons notmuch-command args)
790 (buffer-string) err-file)
791 (goto-char (point-min))
792 (read (current-buffer)))
793 (delete-file err-file)))))
795 (defun notmuch-start-notmuch (name buffer sentinel &rest args)
796 "Start and return an asynchronous notmuch command.
798 This starts and returns an asynchronous process running
799 `notmuch-command' with ARGS. The exit status is checked via
800 `notmuch-check-async-exit-status'. Output written to stderr is
801 redirected and displayed when the process exits (even if the
802 process exits successfully). NAME and BUFFER are the same as in
803 `start-process'. SENTINEL is a process sentinel function to call
804 when the process exits, or nil for none. The caller must *not*
805 invoke `set-process-sentinel' directly on the returned process,
806 as that will interfere with the handling of stderr and the exit
809 ;; There is no way (as of Emacs 24.3) to capture stdout and stderr
810 ;; separately for asynchronous processes, or even to redirect stderr
811 ;; to a file, so we use a trivial shell wrapper to send stderr to a
812 ;; temporary file and clean things up in the sentinel.
813 (let* ((err-file (make-temp-file "nmerr"))
815 (process-connection-type nil)
816 ;; Find notmuch using Emacs' `exec-path'
817 (command (or (executable-find notmuch-command)
818 (error "command not found: %s" notmuch-command)))
819 (proc (apply #'start-process name buffer
821 "exec 2>\"$1\"; shift; exec \"$0\" \"$@\""
822 command err-file args)))
823 (process-put proc 'err-file err-file)
824 (process-put proc 'sub-sentinel sentinel)
825 (process-put proc 'real-command (cons notmuch-command args))
826 (set-process-sentinel proc #'notmuch-start-notmuch-sentinel)
829 (defun notmuch-start-notmuch-sentinel (proc event)
830 (let ((err-file (process-get proc 'err-file))
831 (sub-sentinel (process-get proc 'sub-sentinel))
832 (real-command (process-get proc 'real-command)))
835 ;; Invoke the sub-sentinel, if any
837 (funcall sub-sentinel proc event))
838 ;; Check the exit status. This will signal an error if the
839 ;; exit status is non-zero. Don't do this if the process
840 ;; buffer is dead since that means Emacs killed the process
841 ;; and there's no point in telling the user that (but we
842 ;; still check for and report stderr output below).
843 (when (buffer-live-p (process-buffer proc))
844 (notmuch-check-async-exit-status proc event real-command err-file))
845 ;; If that didn't signal an error, then any error output was
846 ;; really warning output. Show warnings, if any.
849 (unless (= (second (insert-file-contents err-file)) 0)
851 ;; Show first line; stuff remaining lines in the
853 (let ((l1 (buffer-substring (point-min) (point))))
854 (skip-chars-forward "\n")
855 (cons l1 (unless (eobp)
856 (buffer-substring (point) (point-max)))))))))
858 (notmuch-logged-error (car warnings) (cdr warnings)))))
860 ;; Emacs behaves strangely if an error escapes from a sentinel,
861 ;; so turn errors into messages.
862 (message "%s" (error-message-string err))))
863 (ignore-errors (delete-file err-file))))
865 ;; This variable is used only buffer local, but it needs to be
866 ;; declared globally first to avoid compiler warnings.
867 (defvar notmuch-show-process-crypto nil)
868 (make-variable-buffer-local 'notmuch-show-process-crypto)
870 (provide 'notmuch-lib)
873 ;; byte-compile-warnings: (not cl-functions)