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-bury-or-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-bury-or-kill-this-buffer ()
243 "Undisplay the current buffer.
245 Bury the current buffer, unless there is only one window showing
246 it, in which case it is killed."
248 (if (> (length (get-buffer-window-list nil nil t)) 1)
252 (defun notmuch-documentation-first-line (symbol)
253 "Return the first line of the documentation string for SYMBOL."
254 (let ((doc (documentation symbol)))
257 (insert (documentation symbol t))
258 (goto-char (point-min))
261 (buffer-substring beg (point))))
264 (defun notmuch-prefix-key-description (key)
265 "Given a prefix key code, return a human-readable string representation.
267 This is basically just `format-kbd-macro' but we also convert ESC to M-."
268 (let* ((key-vector (if (vectorp key) key (vector key)))
269 (desc (format-kbd-macro key-vector)))
270 (if (string= desc "ESC")
275 (defun notmuch-describe-key (actual-key binding prefix ua-keys tail)
276 "Prepend cons cells describing prefix-arg ACTUAL-KEY and ACTUAL-KEY to TAIL
278 It does not prepend if ACTUAL-KEY is already listed in TAIL."
279 (let ((key-string (concat prefix (format-kbd-macro actual-key))))
280 ;; We don't include documentation if the key-binding is
281 ;; over-ridden. Note, over-riding a binding automatically hides the
282 ;; prefixed version too.
283 (unless (assoc key-string tail)
284 (when (and ua-keys (symbolp binding)
285 (get binding 'notmuch-prefix-doc))
286 ;; Documentation for prefixed command
287 (let ((ua-desc (key-description ua-keys)))
288 (push (cons (concat ua-desc " " prefix (format-kbd-macro actual-key))
289 (get binding 'notmuch-prefix-doc))
291 ;; Documentation for command
292 (push (cons key-string
293 (or (and (symbolp binding) (get binding 'notmuch-doc))
294 (notmuch-documentation-first-line binding)))
298 (defun notmuch-describe-remaps (remap-keymap ua-keys base-keymap prefix tail)
299 ;; Remappings are represented as a binding whose first "event" is
300 ;; 'remap. Hence, if the keymap has any remappings, it will have a
301 ;; binding whose "key" is 'remap, and whose "binding" is itself a
302 ;; keymap that maps not from keys to commands, but from old (remapped)
303 ;; functions to the commands to use in their stead.
305 (lambda (command binding)
308 (setq tail (notmuch-describe-key actual-key binding prefix ua-keys tail)))
309 (where-is-internal command base-keymap)))
313 (defun notmuch-describe-keymap (keymap ua-keys base-keymap &optional prefix tail)
314 "Return a list of cons cells, each describing one binding in KEYMAP.
316 Each cons cell consists of a string giving a human-readable
317 description of the key, and a one-line description of the bound
318 function. See `notmuch-help' for an overview of how this
319 documentation is extracted.
321 UA-KEYS should be a key sequence bound to `universal-argument'.
322 It will be used to describe bindings of commands that support a
323 prefix argument. PREFIX and TAIL are used internally."
325 (lambda (key binding)
326 (cond ((mouse-event-p key) nil)
330 (notmuch-describe-remaps
331 binding ua-keys base-keymap prefix tail)
332 (notmuch-describe-keymap
333 binding ua-keys base-keymap (notmuch-prefix-key-description key) tail))))
335 (setq tail (notmuch-describe-key (vector key) binding prefix ua-keys tail)))))
339 (defun notmuch-substitute-command-keys (doc)
340 "Like `substitute-command-keys' but with documentation, not function names."
342 (while (string-match "\\\\{\\([^}[:space:]]*\\)}" doc beg)
345 (let* ((keymap-name (substring doc (match-beginning 1) (match-end 1)))
346 (keymap (symbol-value (intern keymap-name)))
347 (ua-keys (where-is-internal 'universal-argument keymap t))
348 (desc-alist (notmuch-describe-keymap keymap ua-keys keymap))
349 (desc-list (mapcar (lambda (arg) (concat (car arg) "\t" (cdr arg))) desc-alist)))
350 (mapconcat #'identity desc-list "\n")))))
351 (setq doc (replace-match desc 1 1 doc)))
352 (setq beg (match-end 0)))
355 (defun notmuch-help ()
356 "Display help for the current notmuch mode.
358 This is similar to `describe-function' for the current major
359 mode, but bindings tables are shown with documentation strings
360 rather than command names. By default, this uses the first line
361 of each command's documentation string. A command can override
362 this by setting the 'notmuch-doc property of its command symbol.
363 A command that supports a prefix argument can explicitly document
364 its prefixed behavior by setting the 'notmuch-prefix-doc property
365 of its command symbol."
367 (let* ((mode major-mode)
368 (doc (substitute-command-keys (notmuch-substitute-command-keys (documentation mode t)))))
369 (with-current-buffer (generate-new-buffer "*notmuch-help*")
371 (goto-char (point-min))
372 (set-buffer-modified-p nil)
373 (view-buffer (current-buffer) 'kill-buffer-if-not-modified))))
375 (defun notmuch-subkeymap-help ()
376 "Show help for a subkeymap."
378 (let* ((key (this-command-keys-vector))
379 (prefix (make-vector (1- (length key)) nil))
381 (while (< i (length prefix))
382 (aset prefix i (aref key i))
385 (let* ((subkeymap (key-binding prefix))
386 (ua-keys (where-is-internal 'universal-argument nil t))
387 (prefix-string (notmuch-prefix-key-description prefix))
388 (desc-alist (notmuch-describe-keymap subkeymap ua-keys subkeymap prefix-string))
389 (desc-list (mapcar (lambda (arg) (concat (car arg) "\t" (cdr arg))) desc-alist))
390 (desc (mapconcat #'identity desc-list "\n")))
391 (with-help-window (help-buffer)
392 (with-current-buffer standard-output
393 (insert "\nPress 'q' to quit this window.\n\n")
395 (pop-to-buffer (help-buffer)))))
397 (defvar notmuch-buffer-refresh-function nil
398 "Function to call to refresh the current buffer.")
399 (make-variable-buffer-local 'notmuch-buffer-refresh-function)
401 (defun notmuch-refresh-this-buffer ()
402 "Refresh the current buffer."
404 (when notmuch-buffer-refresh-function
405 (if (commandp notmuch-buffer-refresh-function)
406 ;; Pass prefix argument, etc.
407 (call-interactively notmuch-buffer-refresh-function)
408 (funcall notmuch-buffer-refresh-function))))
410 (defun notmuch-poll-and-refresh-this-buffer ()
411 "Invoke `notmuch-poll' to import mail, then refresh the current buffer."
414 (notmuch-refresh-this-buffer))
416 (defun notmuch-prettify-subject (subject)
417 ;; This function is used by `notmuch-search-process-filter' which
418 ;; requires that we not disrupt its' matching state.
421 (string-match "^[ \t]*$" subject))
425 (defun notmuch-sanitize (str)
426 "Sanitize control character in STR.
428 This includes newlines, tabs, and other funny characters."
429 (replace-regexp-in-string "[[:cntrl:]\x7f\u2028\u2029]+" " " str))
431 (defun notmuch-escape-boolean-term (term)
432 "Escape a boolean term for use in a query.
434 The caller is responsible for prepending the term prefix and a
435 colon. This performs minimal escaping in order to produce
436 user-friendly queries."
439 (if (or (equal term "")
440 ;; To be pessimistic, only pass through terms composed
441 ;; entirely of ASCII printing characters other than ", (,
443 (string-match "[^!#-'*-~]" term))
445 (concat "\"" (replace-regexp-in-string "\"" "\"\"" term t t) "\"")
448 (defun notmuch-id-to-query (id)
449 "Return a query that matches the message with id ID."
450 (concat "id:" (notmuch-escape-boolean-term id)))
452 (defun notmuch-hex-encode (str)
453 "Hex-encode STR (e.g., as used by batch tagging).
455 This replaces spaces, percents, and double quotes in STR with
456 %NN where NN is the hexadecimal value of the character."
457 (replace-regexp-in-string
458 "[ %\"]" (lambda (match) (format "%%%02x" (aref match 0))) str))
462 (defun notmuch-common-do-stash (text)
463 "Common function to stash text in kill ring, and display in minibuffer."
467 (message "Stashed: %s" text))
468 ;; There is nothing to stash so stash an empty string so the user
469 ;; doesn't accidentally paste something else somewhere.
471 (message "Nothing to stash!")))
475 (defun notmuch-remove-if-not (predicate list)
476 "Return a copy of LIST with all items not satisfying PREDICATE removed."
479 (when (funcall predicate (car list))
480 (push (car list) out))
481 (setq list (cdr list)))
484 (defun notmuch-plist-delete (plist property)
485 (let* ((xplist (cons nil plist))
488 (when (eq (cadr pred) property)
489 (setcdr pred (cdddr pred)))
490 (setq pred (cddr pred)))
493 (defun notmuch-split-content-type (content-type)
494 "Split content/type into 'content' and 'type'"
495 (split-string content-type "/"))
497 (defun notmuch-match-content-type (t1 t2)
498 "Return t if t1 and t2 are matching content types, taking wildcards into account"
499 (let ((st1 (notmuch-split-content-type t1))
500 (st2 (notmuch-split-content-type t2)))
501 (if (or (string= (cadr st1) "*")
502 (string= (cadr st2) "*"))
503 ;; Comparison of content types should be case insensitive.
504 (string= (downcase (car st1)) (downcase (car st2)))
505 (string= (downcase t1) (downcase t2)))))
507 (defvar notmuch-multipart/alternative-discouraged
511 ;; multipart/related usually contain a text/html part and some associated graphics.
515 (defun notmuch-multipart/alternative-choose (types)
516 "Return a list of preferred types from the given list of types"
517 ;; Based on `mm-preferred-alternative-precedence'.
519 (dolist (pref (reverse notmuch-multipart/alternative-discouraged))
520 (dolist (elem (copy-sequence seq))
521 (when (string-match pref elem)
522 (setq seq (nconc (delete elem seq) (list elem))))))
525 (defun notmuch-parts-filter-by-type (parts type)
526 "Given a list of message parts, return a list containing the ones matching
529 (lambda (part) (notmuch-match-content-type (plist-get part :content-type) type))
532 (defun notmuch-get-bodypart-binary (msg part process-crypto)
533 "Return the unprocessed content of PART in MSG as a unibyte string.
535 This returns the \"raw\" content of the given part after content
536 transfer decoding, but with no further processing (see the
537 discussion of --format=raw in man notmuch-show). In particular,
538 this does no charset conversion."
539 (let ((args `("show" "--format=raw"
540 ,(format "--part=%d" (plist-get part :id))
541 ,@(when process-crypto '("--decrypt"))
542 ,(notmuch-id-to-query (plist-get msg :id)))))
544 ;; Emacs internally uses a UTF-8-like multibyte string
545 ;; representation by default (regardless of the coding system,
546 ;; which only affects how it goes from outside data to this
547 ;; internal representation). This *almost* never matters.
548 ;; Annoyingly, it does matter if we use this data in an image
549 ;; descriptor, since Emacs will use its internal data buffer
550 ;; directly and this multibyte representation corrupts binary
551 ;; image formats. Since the caller is asking for binary data, a
552 ;; unibyte string is a more appropriate representation anyway.
553 (set-buffer-multibyte nil)
554 (let ((coding-system-for-read 'no-conversion))
555 (apply #'call-process notmuch-command nil '(t nil) nil args)
558 (defun notmuch-get-bodypart-text (msg part process-crypto)
559 "Return the text content of PART in MSG.
561 This returns the content of the given part as a multibyte Lisp
562 string after performing content transfer decoding and any
563 necessary charset decoding. It is an error to use this for
565 (let ((content (plist-get part :content)))
567 ;; Use show --format=sexp to fetch decoded content
568 (let* ((args `("show" "--format=sexp" "--include-html"
569 ,(format "--part=%s" (plist-get part :id))
570 ,@(when process-crypto '("--decrypt"))
571 ,(notmuch-id-to-query (plist-get msg :id))))
572 (npart (apply #'notmuch-call-notmuch-sexp args)))
573 (setq content (plist-get npart :content))
575 (error "Internal error: No :content from %S" args))))
578 ;; Workaround: The call to `mm-display-part' below triggers a bug in
579 ;; Emacs 24 if it attempts to use the shr renderer to display an HTML
580 ;; part with images in it (demonstrated in 24.1 and 24.2 on Debian and
581 ;; Fedora 17, though unreproducable in other configurations).
582 ;; `mm-shr' references the variable `gnus-inhibit-images' without
583 ;; first loading gnus-art, which defines it, resulting in a
584 ;; void-variable error. Hence, we advise `mm-shr' to ensure gnus-art
586 (if (>= emacs-major-version 24)
587 (defadvice mm-shr (before load-gnus-arts activate)
588 (require 'gnus-art nil t)
589 (ad-disable-advice 'mm-shr 'before 'load-gnus-arts)
590 (ad-activate 'mm-shr)))
592 (defun notmuch-mm-display-part-inline (msg part content-type process-crypto)
593 "Use the mm-decode/mm-view functions to display a part in the
594 current buffer, if possible."
595 (let ((display-buffer (current-buffer)))
597 ;; In case we already have :content, use it and tell mm-* that
598 ;; it's already been charset-decoded by using the fake
599 ;; `gnus-decoded' charset. Otherwise, we'll fetch the binary
600 ;; part content and let mm-* decode it.
601 (let* ((have-content (plist-member part :content))
602 (charset (if have-content 'gnus-decoded
603 (plist-get part :content-charset)))
604 (handle (mm-make-handle (current-buffer) `(,content-type (charset . ,charset)))))
605 ;; If the user wants the part inlined, insert the content and
606 ;; test whether we are able to inline it (which includes both
607 ;; capability and suitability tests).
608 (when (mm-inlined-p handle)
610 (insert (notmuch-get-bodypart-text msg part process-crypto))
611 (insert (notmuch-get-bodypart-binary msg part process-crypto)))
612 (when (mm-inlinable-p handle)
613 (set-buffer display-buffer)
614 (mm-display-part handle)
617 ;; Converts a plist of headers to an alist of headers. The input plist should
618 ;; have symbols of the form :Header as keys, and the resulting alist will have
619 ;; symbols of the form 'Header as keys.
620 (defun notmuch-headers-plist-to-alist (plist)
621 (loop for (key value . rest) on plist by #'cddr
622 collect (cons (intern (substring (symbol-name key) 1)) value)))
624 (defun notmuch-face-ensure-list-form (face)
625 "Return FACE in face list form.
627 If FACE is already a face list, it will be returned as-is. If
628 FACE is a face name or face plist, it will be returned as a
629 single element face list."
630 (if (and (listp face) (not (keywordp (car face))))
634 (defun notmuch-apply-face (object face &optional below start end)
635 "Combine FACE into the 'face text property of OBJECT between START and END.
637 This function combines FACE with any existing faces between START
638 and END in OBJECT. Attributes specified by FACE take precedence
639 over existing attributes unless BELOW is non-nil.
641 OBJECT may be a string, a buffer, or nil (which means the current
642 buffer). If object is a string, START and END are 0-based;
643 otherwise they are buffer positions (integers or markers). FACE
644 must be a face name (a symbol or string), a property list of face
645 attributes, or a list of these. If START and/or END are omitted,
646 they default to the beginning/end of OBJECT. For convenience
647 when applied to strings, this returns OBJECT."
649 ;; A face property can have three forms: a face name (a string or
650 ;; symbol), a property list, or a list of these two forms. In the
651 ;; list case, the faces will be combined, with the earlier faces
652 ;; taking precedent. Here we canonicalize everything to list form
653 ;; to make it easy to combine.
654 (let ((pos (cond (start start)
658 ((stringp object) (length object))
659 (t (1+ (buffer-size object)))))
660 (face-list (notmuch-face-ensure-list-form face)))
662 (let* ((cur (get-text-property pos 'face object))
663 (cur-list (notmuch-face-ensure-list-form cur))
664 (new (cond ((null cur-list) face)
665 (below (append cur-list face-list))
666 (t (append face-list cur-list))))
667 (next (next-single-property-change pos 'face object end)))
668 (put-text-property pos next 'face new object)
672 (defun notmuch-map-text-property (start end prop func &optional object)
673 "Transform text property PROP using FUNC.
675 Applies FUNC to each distinct value of the text property PROP
676 between START and END of OBJECT, setting PROP to the value
679 (let ((value (get-text-property start prop object))
680 (next (next-single-property-change start prop object end)))
681 (put-text-property start next prop (funcall func value) object)
684 (defun notmuch-logged-error (msg &optional extra)
685 "Log MSG and EXTRA to *Notmuch errors* and signal MSG.
687 This logs MSG and EXTRA to the *Notmuch errors* buffer and
688 signals MSG as an error. If EXTRA is non-nil, text referring the
689 user to the *Notmuch errors* buffer will be appended to the
690 signaled error. This function does not return."
692 (with-current-buffer (get-buffer-create "*Notmuch errors*")
693 (goto-char (point-max))
697 (insert "[" (current-time-string) "]\n" msg)
704 (error "%s" (concat msg (when extra
705 " (see *Notmuch errors* for more details)"))))
707 (defun notmuch-check-async-exit-status (proc msg &optional command err-file)
708 "If PROC exited abnormally, pop up an error buffer and signal an error.
710 This is a wrapper around `notmuch-check-exit-status' for
711 asynchronous process sentinels. PROC and MSG must be the
712 arguments passed to the sentinel. COMMAND and ERR-FILE, if
713 provided, are passed to `notmuch-check-exit-status'. If COMMAND
714 is not provided, it is taken from `process-command'."
716 (case (process-status proc)
717 ((exit) (process-exit-status proc))
720 (notmuch-check-exit-status exit-status (or command (process-command proc))
723 (defun notmuch-check-exit-status (exit-status command &optional output err-file)
724 "If EXIT-STATUS is non-zero, pop up an error buffer and signal an error.
726 If EXIT-STATUS is non-zero, pop up a notmuch error buffer
727 describing the error and signal an Elisp error. EXIT-STATUS must
728 be a number indicating the exit status code of a process or a
729 string describing the signal that terminated the process (such as
730 returned by `call-process'). COMMAND must be a list giving the
731 command and its arguments. OUTPUT, if provided, is a string
732 giving the output of command. ERR-FILE, if provided, is the name
733 of a file containing the error output of command. OUTPUT and the
734 contents of ERR-FILE will be included in the error message."
737 ((eq exit-status 0) t)
739 (notmuch-logged-error "notmuch CLI version mismatch
740 Emacs requested an older output format than supported by the notmuch CLI.
741 You may need to restart Emacs or upgrade your notmuch Emacs package."))
743 (notmuch-logged-error "notmuch CLI version mismatch
744 Emacs requested a newer output format than supported by the notmuch CLI.
745 You may need to restart Emacs or upgrade your notmuch package."))
747 (let* ((err (when err-file
749 (insert-file-contents err-file)
754 "command: " (mapconcat #'shell-quote-argument command " ") "\n"
755 (if (integerp exit-status)
756 (format "exit status: %s\n" exit-status)
757 (format "exit signal: %s\n" exit-status))
759 (concat "stderr:\n" err))
761 (concat "stdout:\n" output)))))
763 ;; We have an error message straight from the CLI.
764 (notmuch-logged-error
765 (replace-regexp-in-string "[ \n\r\t\f]*\\'" "" err) extra)
766 ;; We only have combined output from the CLI; don't inundate
767 ;; the user with it. Mimic `process-lines'.
768 (notmuch-logged-error (format "%s exited with status %s"
769 (car command) exit-status)
771 ;; `notmuch-logged-error' does not return.
774 (defun notmuch-call-notmuch--helper (destination args)
775 "Helper for synchronous notmuch invocation commands.
777 This wraps `call-process'. DESTINATION has the same meaning as
778 for `call-process'. ARGS is as described for
779 `notmuch-call-notmuch-process'."
782 (while (keywordp (car args))
784 (:stdin-string (setq stdin-string (cadr args)
787 (error "Unknown keyword argument: %s" (car args)))))
788 (if (null stdin-string)
789 (apply #'call-process notmuch-command nil destination nil args)
790 (insert stdin-string)
791 (apply #'call-process-region (point-min) (point-max)
792 notmuch-command t destination nil args))))
794 (defun notmuch-call-notmuch-process (&rest args)
795 "Synchronously invoke `notmuch-command' with ARGS.
797 The caller may provide keyword arguments before ARGS. Currently
798 supported keyword arguments are:
800 :stdin-string STRING - Write STRING to stdin
802 If notmuch exits with a non-zero status, output from the process
803 will appear in a buffer named \"*Notmuch errors*\" and an error
806 (let ((status (notmuch-call-notmuch--helper t args)))
807 (notmuch-check-exit-status status (cons notmuch-command args)
810 (defun notmuch-call-notmuch-sexp (&rest args)
811 "Invoke `notmuch-command' with ARGS and return the parsed S-exp output.
813 This is equivalent to `notmuch-call-notmuch-process', but parses
814 notmuch's output as an S-expression and returns the parsed value.
815 Like `notmuch-call-notmuch-process', if notmuch exits with a
816 non-zero status, this will report its output and signal an
820 (let ((err-file (make-temp-file "nmerr")))
822 (let ((status (notmuch-call-notmuch--helper (list t err-file) args)))
823 (notmuch-check-exit-status status (cons notmuch-command args)
824 (buffer-string) err-file)
825 (goto-char (point-min))
826 (read (current-buffer)))
827 (delete-file err-file)))))
829 (defun notmuch-start-notmuch (name buffer sentinel &rest args)
830 "Start and return an asynchronous notmuch command.
832 This starts and returns an asynchronous process running
833 `notmuch-command' with ARGS. The exit status is checked via
834 `notmuch-check-async-exit-status'. Output written to stderr is
835 redirected and displayed when the process exits (even if the
836 process exits successfully). NAME and BUFFER are the same as in
837 `start-process'. SENTINEL is a process sentinel function to call
838 when the process exits, or nil for none. The caller must *not*
839 invoke `set-process-sentinel' directly on the returned process,
840 as that will interfere with the handling of stderr and the exit
843 ;; There is no way (as of Emacs 24.3) to capture stdout and stderr
844 ;; separately for asynchronous processes, or even to redirect stderr
845 ;; to a file, so we use a trivial shell wrapper to send stderr to a
846 ;; temporary file and clean things up in the sentinel.
847 (let* ((err-file (make-temp-file "nmerr"))
849 (process-connection-type nil)
850 ;; Find notmuch using Emacs' `exec-path'
851 (command (or (executable-find notmuch-command)
852 (error "command not found: %s" notmuch-command)))
853 (proc (apply #'start-process name buffer
855 "exec 2>\"$1\"; shift; exec \"$0\" \"$@\""
856 command err-file args)))
857 (process-put proc 'err-file err-file)
858 (process-put proc 'sub-sentinel sentinel)
859 (process-put proc 'real-command (cons notmuch-command args))
860 (set-process-sentinel proc #'notmuch-start-notmuch-sentinel)
863 (defun notmuch-start-notmuch-sentinel (proc event)
864 (let ((err-file (process-get proc 'err-file))
865 (sub-sentinel (process-get proc 'sub-sentinel))
866 (real-command (process-get proc 'real-command)))
869 ;; Invoke the sub-sentinel, if any
871 (funcall sub-sentinel proc event))
872 ;; Check the exit status. This will signal an error if the
873 ;; exit status is non-zero. Don't do this if the process
874 ;; buffer is dead since that means Emacs killed the process
875 ;; and there's no point in telling the user that (but we
876 ;; still check for and report stderr output below).
877 (when (buffer-live-p (process-buffer proc))
878 (notmuch-check-async-exit-status proc event real-command err-file))
879 ;; If that didn't signal an error, then any error output was
880 ;; really warning output. Show warnings, if any.
883 (unless (= (second (insert-file-contents err-file)) 0)
885 ;; Show first line; stuff remaining lines in the
887 (let ((l1 (buffer-substring (point-min) (point))))
888 (skip-chars-forward "\n")
889 (cons l1 (unless (eobp)
890 (buffer-substring (point) (point-max)))))))))
892 (notmuch-logged-error (car warnings) (cdr warnings)))))
894 ;; Emacs behaves strangely if an error escapes from a sentinel,
895 ;; so turn errors into messages.
896 (message "%s" (error-message-string err))))
897 (ignore-errors (delete-file err-file))))
899 ;; This variable is used only buffer local, but it needs to be
900 ;; declared globally first to avoid compiler warnings.
901 (defvar notmuch-show-process-crypto nil)
902 (make-variable-buffer-local 'notmuch-show-process-crypto)
904 (provide 'notmuch-lib)
907 ;; byte-compile-warnings: (not cl-functions)