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 (defvar notmuch-command "notmuch"
29 "Command to run the notmuch binary.")
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-search-oldest-first t
70 "Show the oldest mail first when searching.
72 This variable defines the default sort order for displaying
73 search results. Note that any filtered searches created by
74 `notmuch-search-filter' retain the search order of the parent
77 :group 'notmuch-search)
79 (defcustom notmuch-poll-script nil
80 "An external script to incorporate new mail into the notmuch database.
82 This variable controls the action invoked by
83 `notmuch-poll-and-refresh-this-buffer' (bound by default to 'G')
84 to incorporate new mail into the notmuch database.
86 If set to nil (the default), new mail is processed by invoking
87 \"notmuch new\". Otherwise, this should be set to a string that
88 gives the name of an external script that processes new mail. If
89 set to the empty string, no command will be run.
91 The external script could do any of the following depending on
94 1. Invoke a program to transfer mail to the local mail store
95 2. Invoke \"notmuch new\" to incorporate the new mail
96 3. Invoke one or more \"notmuch tag\" commands to classify the mail
98 Note that the recommended way of achieving the same is using
99 \"notmuch new\" hooks."
100 :type '(choice (const :tag "notmuch new" nil)
101 (const :tag "Disabled" "")
102 (string :tag "Custom script"))
103 :group 'notmuch-external)
107 (defvar notmuch-search-history nil
108 "Variable to store notmuch searches history.")
110 (defun notmuch--saved-searches-to-plist (symbol)
111 "Extract a saved-search variable into plist form.
113 The new style saved search is just a plist, but for backwards
114 compatatibility we use this function to extract old style saved
115 searches so they still work in customize."
116 (let ((saved-searches (default-value symbol)))
117 (mapcar #'notmuch-hello-saved-search-to-plist saved-searches)))
119 (define-widget 'notmuch-saved-search-plist 'list
120 "A single saved search property list."
122 :args '((list :inline t
124 (group :format "%v" :inline t (const :format " Name: " :name) (string :format "%v"))
125 (group :format "%v" :inline t (const :format " Query: " :query) (string :format "%v")))
128 (group :format "%v" :inline t (const :format "Count-Query: " :count-query) (string :format "%v")))))
130 (defcustom notmuch-saved-searches '((:name "inbox" :query "tag:inbox")
131 (:name "unread" :query "tag:unread"))
132 "A list of saved searches to display.
134 The saved search can be given in 3 forms. The preferred way is as
135 a plist. Supported properties are
137 :name Name of the search (required).
138 :query Search to run (required).
139 :count-query Optional extra query to generate the count
140 shown. If not present then the :query property
143 Other accepted forms are a cons cell of the form (NAME . QUERY)
144 or a list of the form (NAME QUERY COUNT-QUERY)."
145 ;; The saved-search format is also used by the all-tags notmuch-hello
146 ;; section. This section generates its own saved-search list in one of
147 ;; the latter two forms.
149 :get 'notmuch--saved-searches-to-plist
150 :type '(repeat notmuch-saved-search-plist)
151 :tag "List of Saved Searches"
152 :group 'notmuch-hello)
154 (defcustom notmuch-archive-tags '("-inbox")
155 "List of tag changes to apply to a message or a thread when it is archived.
157 Tags starting with \"+\" (or not starting with either \"+\" or
158 \"-\") in the list will be added, and tags starting with \"-\"
159 will be removed from the message or thread being archived.
161 For example, if you wanted to remove an \"inbox\" tag and add an
162 \"archived\" tag, you would set:
163 (\"-inbox\" \"+archived\")"
164 :type '(repeat string)
165 :group 'notmuch-search
166 :group 'notmuch-show)
168 (defvar notmuch-common-keymap
169 (let ((map (make-sparse-keymap)))
170 (define-key map "?" 'notmuch-help)
171 (define-key map "q" 'notmuch-kill-this-buffer)
172 (define-key map "s" 'notmuch-search)
173 (define-key map "z" 'notmuch-tree)
174 (define-key map "m" 'notmuch-mua-new-mail)
175 (define-key map "=" 'notmuch-refresh-this-buffer)
176 (define-key map "G" 'notmuch-poll-and-refresh-this-buffer)
178 "Keymap shared by all notmuch modes.")
180 ;; By default clicking on a button does not select the window
181 ;; containing the button (as opposed to clicking on a widget which
182 ;; does). This means that the button action is then executed in the
183 ;; current selected window which can cause problems if the button
184 ;; changes the buffer (e.g., id: links) or moves point.
186 ;; This provides a button type which overrides mouse-action so that
187 ;; the button's window is selected before the action is run. Other
188 ;; notmuch buttons can get the same behaviour by inheriting from this
190 (define-button-type 'notmuch-button-type
191 'mouse-action (lambda (button)
192 (select-window (posn-window (event-start last-input-event)))
193 (button-activate button)))
195 (defun notmuch-command-to-string (&rest args)
196 "Synchronously invoke \"notmuch\" with the given list of arguments.
198 If notmuch exits with a non-zero status, output from the process
199 will appear in a buffer named \"*Notmuch errors*\" and an error
202 Otherwise the output will be returned"
204 (let* ((status (apply #'call-process notmuch-command nil t nil args))
205 (output (buffer-string)))
206 (notmuch-check-exit-status status (cons notmuch-command args) output)
209 (defvar notmuch--cli-sane-p nil
210 "Cache whether the CLI seems to be configured sanely.")
212 (defun notmuch-cli-sane-p ()
213 "Return t if the cli seems to be configured sanely."
214 (unless notmuch--cli-sane-p
215 (let ((status (call-process notmuch-command nil nil nil
216 "config" "get" "user.primary_email")))
217 (setq notmuch--cli-sane-p (= status 0))))
220 (defun notmuch-assert-cli-sane ()
221 (unless (notmuch-cli-sane-p)
222 (notmuch-logged-error
223 "notmuch cli seems misconfigured or unconfigured."
224 "Perhaps you haven't run \"notmuch setup\" yet? Try running this
225 on the command line, and then retry your notmuch command")))
227 (defun notmuch-version ()
228 "Return a string with the notmuch version number."
230 ;; Trim off the trailing newline.
231 (substring (notmuch-command-to-string "--version") 0 -1)))
232 (if (string-match "^notmuch\\( version\\)? \\(.*\\)$"
234 (match-string 2 long-string)
237 (defun notmuch-config-get (item)
238 "Return a value from the notmuch configuration."
239 (let* ((val (notmuch-command-to-string "config" "get" item))
241 ;; Trim off the trailing newline (if the value is empty or not
242 ;; configured, there will be no newline)
243 (if (and (> len 0) (= (aref val (- len 1)) ?\n))
247 (defun notmuch-database-path ()
248 "Return the database.path value from the notmuch configuration."
249 (notmuch-config-get "database.path"))
251 (defun notmuch-user-name ()
252 "Return the user.name value from the notmuch configuration."
253 (notmuch-config-get "user.name"))
255 (defun notmuch-user-primary-email ()
256 "Return the user.primary_email value from the notmuch configuration."
257 (notmuch-config-get "user.primary_email"))
259 (defun notmuch-user-other-email ()
260 "Return the user.other_email value (as a list) from the notmuch configuration."
261 (split-string (notmuch-config-get "user.other_email") "\n" t))
263 (defun notmuch-poll ()
264 "Run \"notmuch new\" or an external script to import mail.
266 Invokes `notmuch-poll-script', \"notmuch new\", or does nothing
267 depending on the value of `notmuch-poll-script'."
269 (if (stringp notmuch-poll-script)
270 (unless (string= notmuch-poll-script "")
271 (call-process notmuch-poll-script nil nil))
272 (call-process notmuch-command nil nil nil "new")))
274 (defun notmuch-kill-this-buffer ()
275 "Kill the current buffer."
277 (kill-buffer (current-buffer)))
279 (defun notmuch-documentation-first-line (symbol)
280 "Return the first line of the documentation string for SYMBOL."
281 (let ((doc (documentation symbol)))
284 (insert (documentation symbol t))
285 (goto-char (point-min))
288 (buffer-substring beg (point))))
291 (defun notmuch-prefix-key-description (key)
292 "Given a prefix key code, return a human-readable string representation.
294 This is basically just `format-kbd-macro' but we also convert ESC to M-."
295 (let* ((key-vector (if (vectorp key) key (vector key)))
296 (desc (format-kbd-macro key-vector)))
297 (if (string= desc "ESC")
302 (defun notmuch-describe-key (actual-key binding prefix ua-keys tail)
303 "Prepend cons cells describing prefix-arg ACTUAL-KEY and ACTUAL-KEY to TAIL
305 It does not prepend if ACTUAL-KEY is already listed in TAIL."
306 (let ((key-string (concat prefix (format-kbd-macro actual-key))))
307 ;; We don't include documentation if the key-binding is
308 ;; over-ridden. Note, over-riding a binding automatically hides the
309 ;; prefixed version too.
310 (unless (assoc key-string tail)
311 (when (and ua-keys (symbolp binding)
312 (get binding 'notmuch-prefix-doc))
313 ;; Documentation for prefixed command
314 (let ((ua-desc (key-description ua-keys)))
315 (push (cons (concat ua-desc " " prefix (format-kbd-macro actual-key))
316 (get binding 'notmuch-prefix-doc))
318 ;; Documentation for command
319 (push (cons key-string
320 (or (and (symbolp binding) (get binding 'notmuch-doc))
321 (notmuch-documentation-first-line binding)))
325 (defun notmuch-describe-remaps (remap-keymap ua-keys base-keymap prefix tail)
326 ;; Remappings are represented as a binding whose first "event" is
327 ;; 'remap. Hence, if the keymap has any remappings, it will have a
328 ;; binding whose "key" is 'remap, and whose "binding" is itself a
329 ;; keymap that maps not from keys to commands, but from old (remapped)
330 ;; functions to the commands to use in their stead.
332 (lambda (command binding)
335 (setq tail (notmuch-describe-key actual-key binding prefix ua-keys tail)))
336 (where-is-internal command base-keymap)))
340 (defun notmuch-describe-keymap (keymap ua-keys base-keymap &optional prefix tail)
341 "Return a list of cons cells, each describing one binding in KEYMAP.
343 Each cons cell consists of a string giving a human-readable
344 description of the key, and a one-line description of the bound
345 function. See `notmuch-help' for an overview of how this
346 documentation is extracted.
348 UA-KEYS should be a key sequence bound to `universal-argument'.
349 It will be used to describe bindings of commands that support a
350 prefix argument. PREFIX and TAIL are used internally."
352 (lambda (key binding)
353 (cond ((mouse-event-p key) nil)
357 (notmuch-describe-remaps
358 binding ua-keys base-keymap prefix tail)
359 (notmuch-describe-keymap
360 binding ua-keys base-keymap (notmuch-prefix-key-description key) tail))))
362 (setq tail (notmuch-describe-key (vector key) binding prefix ua-keys tail)))))
366 (defun notmuch-substitute-command-keys (doc)
367 "Like `substitute-command-keys' but with documentation, not function names."
369 (while (string-match "\\\\{\\([^}[:space:]]*\\)}" doc beg)
372 (let* ((keymap-name (substring doc (match-beginning 1) (match-end 1)))
373 (keymap (symbol-value (intern keymap-name)))
374 (ua-keys (where-is-internal 'universal-argument keymap t))
375 (desc-alist (notmuch-describe-keymap keymap ua-keys keymap))
376 (desc-list (mapcar (lambda (arg) (concat (car arg) "\t" (cdr arg))) desc-alist)))
377 (mapconcat #'identity desc-list "\n")))))
378 (setq doc (replace-match desc 1 1 doc)))
379 (setq beg (match-end 0)))
382 (defun notmuch-help ()
383 "Display help for the current notmuch mode.
385 This is similar to `describe-function' for the current major
386 mode, but bindings tables are shown with documentation strings
387 rather than command names. By default, this uses the first line
388 of each command's documentation string. A command can override
389 this by setting the 'notmuch-doc property of its command symbol.
390 A command that supports a prefix argument can explicitly document
391 its prefixed behavior by setting the 'notmuch-prefix-doc property
392 of its command symbol."
394 (let* ((mode major-mode)
395 (doc (substitute-command-keys (notmuch-substitute-command-keys (documentation mode t)))))
396 (with-current-buffer (generate-new-buffer "*notmuch-help*")
398 (goto-char (point-min))
399 (set-buffer-modified-p nil)
400 (view-buffer (current-buffer) 'kill-buffer-if-not-modified))))
402 (defun notmuch-subkeymap-help ()
403 "Show help for a subkeymap."
405 (let* ((key (this-command-keys-vector))
406 (prefix (make-vector (1- (length key)) nil))
408 (while (< i (length prefix))
409 (aset prefix i (aref key i))
412 (let* ((subkeymap (key-binding prefix))
413 (ua-keys (where-is-internal 'universal-argument nil t))
414 (prefix-string (notmuch-prefix-key-description prefix))
415 (desc-alist (notmuch-describe-keymap subkeymap ua-keys subkeymap prefix-string))
416 (desc-list (mapcar (lambda (arg) (concat (car arg) "\t" (cdr arg))) desc-alist))
417 (desc (mapconcat #'identity desc-list "\n")))
418 (with-help-window (help-buffer)
419 (with-current-buffer standard-output
420 (insert "\nPress 'q' to quit this window.\n\n")
422 (pop-to-buffer (help-buffer)))))
424 (defvar notmuch-buffer-refresh-function nil
425 "Function to call to refresh the current buffer.")
426 (make-variable-buffer-local 'notmuch-buffer-refresh-function)
428 (defun notmuch-refresh-this-buffer ()
429 "Refresh the current buffer."
431 (when notmuch-buffer-refresh-function
432 (if (commandp notmuch-buffer-refresh-function)
433 ;; Pass prefix argument, etc.
434 (call-interactively notmuch-buffer-refresh-function)
435 (funcall notmuch-buffer-refresh-function))))
437 (defun notmuch-poll-and-refresh-this-buffer ()
438 "Invoke `notmuch-poll' to import mail, then refresh the current buffer."
441 (notmuch-refresh-this-buffer))
443 (defun notmuch-prettify-subject (subject)
444 ;; This function is used by `notmuch-search-process-filter' which
445 ;; requires that we not disrupt its' matching state.
448 (string-match "^[ \t]*$" subject))
452 (defun notmuch-sanitize (str)
453 "Sanitize control character in STR.
455 This includes newlines, tabs, and other funny characters."
456 (replace-regexp-in-string "[[:cntrl:]\x7f\u2028\u2029]+" " " str))
458 (defun notmuch-escape-boolean-term (term)
459 "Escape a boolean term for use in a query.
461 The caller is responsible for prepending the term prefix and a
462 colon. This performs minimal escaping in order to produce
463 user-friendly queries."
466 (if (or (equal term "")
467 ;; To be pessimistic, only pass through terms composed
468 ;; entirely of ASCII printing characters other than ", (,
470 (string-match "[^!#-'*-~]" term))
472 (concat "\"" (replace-regexp-in-string "\"" "\"\"" term t t) "\"")
475 (defun notmuch-id-to-query (id)
476 "Return a query that matches the message with id ID."
477 (concat "id:" (notmuch-escape-boolean-term id)))
479 (defun notmuch-hex-encode (str)
480 "Hex-encode STR (e.g., as used by batch tagging).
482 This replaces spaces, percents, and double quotes in STR with
483 %NN where NN is the hexadecimal value of the character."
484 (replace-regexp-in-string
485 "[ %\"]" (lambda (match) (format "%%%02x" (aref match 0))) str))
489 (defun notmuch-common-do-stash (text)
490 "Common function to stash text in kill ring, and display in minibuffer."
494 (message "Stashed: %s" text))
495 ;; There is nothing to stash so stash an empty string so the user
496 ;; doesn't accidentally paste something else somewhere.
498 (message "Nothing to stash!")))
502 (defun notmuch-remove-if-not (predicate list)
503 "Return a copy of LIST with all items not satisfying PREDICATE removed."
506 (when (funcall predicate (car list))
507 (push (car list) out))
508 (setq list (cdr list)))
511 (defun notmuch-split-content-type (content-type)
512 "Split content/type into 'content' and 'type'"
513 (split-string content-type "/"))
515 (defun notmuch-match-content-type (t1 t2)
516 "Return t if t1 and t2 are matching content types, taking wildcards into account"
517 (let ((st1 (notmuch-split-content-type t1))
518 (st2 (notmuch-split-content-type t2)))
519 (if (or (string= (cadr st1) "*")
520 (string= (cadr st2) "*"))
521 ;; Comparison of content types should be case insensitive.
522 (string= (downcase (car st1)) (downcase (car st2)))
523 (string= (downcase t1) (downcase t2)))))
525 (defvar notmuch-multipart/alternative-discouraged
529 ;; multipart/related usually contain a text/html part and some associated graphics.
533 (defun notmuch-multipart/alternative-choose (types)
534 "Return a list of preferred types from the given list of types"
535 ;; Based on `mm-preferred-alternative-precedence'.
537 (dolist (pref (reverse notmuch-multipart/alternative-discouraged))
538 (dolist (elem (copy-sequence seq))
539 (when (string-match pref elem)
540 (setq seq (nconc (delete elem seq) (list elem))))))
543 (defun notmuch-parts-filter-by-type (parts type)
544 "Given a list of message parts, return a list containing the ones matching
547 (lambda (part) (notmuch-match-content-type (plist-get part :content-type) type))
550 ;; Helper for parts which are generally not included in the default
552 (defun notmuch-get-bodypart-internal (query part-number process-crypto)
553 (let ((args '("show" "--format=raw"))
554 (part-arg (format "--part=%s" part-number)))
555 (setq args (append args (list part-arg)))
557 (setq args (append args '("--decrypt"))))
558 (setq args (append args (list query)))
560 (let ((coding-system-for-read 'no-conversion))
562 (apply 'call-process (append (list notmuch-command nil (list t nil) nil) args))
565 (defun notmuch-get-bodypart-content (msg part nth process-crypto)
566 (or (plist-get part :content)
567 (notmuch-get-bodypart-internal (notmuch-id-to-query (plist-get msg :id)) nth process-crypto)))
569 ;; Workaround: The call to `mm-display-part' below triggers a bug in
570 ;; Emacs 24 if it attempts to use the shr renderer to display an HTML
571 ;; part with images in it (demonstrated in 24.1 and 24.2 on Debian and
572 ;; Fedora 17, though unreproducable in other configurations).
573 ;; `mm-shr' references the variable `gnus-inhibit-images' without
574 ;; first loading gnus-art, which defines it, resulting in a
575 ;; void-variable error. Hence, we advise `mm-shr' to ensure gnus-art
577 (if (>= emacs-major-version 24)
578 (defadvice mm-shr (before load-gnus-arts activate)
579 (require 'gnus-art nil t)
580 (ad-disable-advice 'mm-shr 'before 'load-gnus-arts)
581 (ad-activate 'mm-shr)))
583 (defun notmuch-mm-display-part-inline (msg part nth content-type process-crypto)
584 "Use the mm-decode/mm-view functions to display a part in the
585 current buffer, if possible."
586 (let ((display-buffer (current-buffer)))
588 ;; In case there is :content, the content string is already converted
589 ;; into emacs internal format. `gnus-decoded' is a fake charset,
590 ;; which means no further decoding (to be done by mm- functions).
591 (let* ((charset (if (plist-member part :content)
593 (plist-get part :content-charset)))
594 (handle (mm-make-handle (current-buffer) `(,content-type (charset . ,charset)))))
595 ;; If the user wants the part inlined, insert the content and
596 ;; test whether we are able to inline it (which includes both
597 ;; capability and suitability tests).
598 (when (mm-inlined-p handle)
599 (insert (notmuch-get-bodypart-content msg part nth process-crypto))
600 (when (mm-inlinable-p handle)
601 (set-buffer display-buffer)
602 (mm-display-part handle)
605 ;; Converts a plist of headers to an alist of headers. The input plist should
606 ;; have symbols of the form :Header as keys, and the resulting alist will have
607 ;; symbols of the form 'Header as keys.
608 (defun notmuch-headers-plist-to-alist (plist)
609 (loop for (key value . rest) on plist by #'cddr
610 collect (cons (intern (substring (symbol-name key) 1)) value)))
612 (defun notmuch-face-ensure-list-form (face)
613 "Return FACE in face list form.
615 If FACE is already a face list, it will be returned as-is. If
616 FACE is a face name or face plist, it will be returned as a
617 single element face list."
618 (if (and (listp face) (not (keywordp (car face))))
622 (defun notmuch-apply-face (object face &optional below start end)
623 "Combine FACE into the 'face text property of OBJECT between START and END.
625 This function combines FACE with any existing faces between START
626 and END in OBJECT. Attributes specified by FACE take precedence
627 over existing attributes unless BELOW is non-nil.
629 OBJECT may be a string, a buffer, or nil (which means the current
630 buffer). If object is a string, START and END are 0-based;
631 otherwise they are buffer positions (integers or markers). FACE
632 must be a face name (a symbol or string), a property list of face
633 attributes, or a list of these. If START and/or END are omitted,
634 they default to the beginning/end of OBJECT. For convenience
635 when applied to strings, this returns OBJECT."
637 ;; A face property can have three forms: a face name (a string or
638 ;; symbol), a property list, or a list of these two forms. In the
639 ;; list case, the faces will be combined, with the earlier faces
640 ;; taking precedent. Here we canonicalize everything to list form
641 ;; to make it easy to combine.
642 (let ((pos (cond (start start)
646 ((stringp object) (length object))
647 (t (1+ (buffer-size object)))))
648 (face-list (notmuch-face-ensure-list-form face)))
650 (let* ((cur (get-text-property pos 'face object))
651 (cur-list (notmuch-face-ensure-list-form cur))
652 (new (cond ((null cur-list) face)
653 (below (append cur-list face-list))
654 (t (append face-list cur-list))))
655 (next (next-single-property-change pos 'face object end)))
656 (put-text-property pos next 'face new object)
660 (defun notmuch-map-text-property (start end prop func &optional object)
661 "Transform text property PROP using FUNC.
663 Applies FUNC to each distinct value of the text property PROP
664 between START and END of OBJECT, setting PROP to the value
667 (let ((value (get-text-property start prop object))
668 (next (next-single-property-change start prop object end)))
669 (put-text-property start next prop (funcall func value) object)
672 (defun notmuch-logged-error (msg &optional extra)
673 "Log MSG and EXTRA to *Notmuch errors* and signal MSG.
675 This logs MSG and EXTRA to the *Notmuch errors* buffer and
676 signals MSG as an error. If EXTRA is non-nil, text referring the
677 user to the *Notmuch errors* buffer will be appended to the
678 signaled error. This function does not return."
680 (with-current-buffer (get-buffer-create "*Notmuch errors*")
681 (goto-char (point-max))
685 (insert "[" (current-time-string) "]\n" msg)
692 (error "%s" (concat msg (when extra
693 " (see *Notmuch errors* for more details)"))))
695 (defun notmuch-check-async-exit-status (proc msg &optional command err-file)
696 "If PROC exited abnormally, pop up an error buffer and signal an error.
698 This is a wrapper around `notmuch-check-exit-status' for
699 asynchronous process sentinels. PROC and MSG must be the
700 arguments passed to the sentinel. COMMAND and ERR-FILE, if
701 provided, are passed to `notmuch-check-exit-status'. If COMMAND
702 is not provided, it is taken from `process-command'."
704 (case (process-status proc)
705 ((exit) (process-exit-status proc))
708 (notmuch-check-exit-status exit-status (or command (process-command proc))
711 (defun notmuch-check-exit-status (exit-status command &optional output err-file)
712 "If EXIT-STATUS is non-zero, pop up an error buffer and signal an error.
714 If EXIT-STATUS is non-zero, pop up a notmuch error buffer
715 describing the error and signal an Elisp error. EXIT-STATUS must
716 be a number indicating the exit status code of a process or a
717 string describing the signal that terminated the process (such as
718 returned by `call-process'). COMMAND must be a list giving the
719 command and its arguments. OUTPUT, if provided, is a string
720 giving the output of command. ERR-FILE, if provided, is the name
721 of a file containing the error output of command. OUTPUT and the
722 contents of ERR-FILE will be included in the error message."
725 ((eq exit-status 0) t)
727 (notmuch-logged-error "notmuch CLI version mismatch
728 Emacs requested an older output format than supported by the notmuch CLI.
729 You may need to restart Emacs or upgrade your notmuch Emacs package."))
731 (notmuch-logged-error "notmuch CLI version mismatch
732 Emacs requested a newer output format than supported by the notmuch CLI.
733 You may need to restart Emacs or upgrade your notmuch package."))
735 (let* ((err (when err-file
737 (insert-file-contents err-file)
742 "command: " (mapconcat #'shell-quote-argument command " ") "\n"
743 (if (integerp exit-status)
744 (format "exit status: %s\n" exit-status)
745 (format "exit signal: %s\n" exit-status))
747 (concat "stderr:\n" err))
749 (concat "stdout:\n" output)))))
751 ;; We have an error message straight from the CLI.
752 (notmuch-logged-error
753 (replace-regexp-in-string "[ \n\r\t\f]*\\'" "" err) extra)
754 ;; We only have combined output from the CLI; don't inundate
755 ;; the user with it. Mimic `process-lines'.
756 (notmuch-logged-error (format "%s exited with status %s"
757 (car command) exit-status)
759 ;; `notmuch-logged-error' does not return.
762 (defun notmuch-call-notmuch--helper (destination args)
763 "Helper for synchronous notmuch invocation commands.
765 This wraps `call-process'. DESTINATION has the same meaning as
766 for `call-process'. ARGS is as described for
767 `notmuch-call-notmuch-process'."
770 (while (keywordp (car args))
772 (:stdin-string (setq stdin-string (cadr args)
775 (error "Unknown keyword argument: %s" (car args)))))
776 (if (null stdin-string)
777 (apply #'call-process notmuch-command nil destination nil args)
778 (insert stdin-string)
779 (apply #'call-process-region (point-min) (point-max)
780 notmuch-command t destination nil args))))
782 (defun notmuch-call-notmuch-process (&rest args)
783 "Synchronously invoke `notmuch-command' with ARGS.
785 The caller may provide keyword arguments before ARGS. Currently
786 supported keyword arguments are:
788 :stdin-string STRING - Write STRING to stdin
790 If notmuch exits with a non-zero status, output from the process
791 will appear in a buffer named \"*Notmuch errors*\" and an error
794 (let ((status (notmuch-call-notmuch--helper t args)))
795 (notmuch-check-exit-status status (cons notmuch-command args)
798 (defun notmuch-call-notmuch-sexp (&rest args)
799 "Invoke `notmuch-command' with ARGS and return the parsed S-exp output.
801 This is equivalent to `notmuch-call-notmuch-process', but parses
802 notmuch's output as an S-expression and returns the parsed value.
803 Like `notmuch-call-notmuch-process', if notmuch exits with a
804 non-zero status, this will report its output and signal an
808 (let ((err-file (make-temp-file "nmerr")))
810 (let ((status (notmuch-call-notmuch--helper (list t err-file) args)))
811 (notmuch-check-exit-status status (cons notmuch-command args)
812 (buffer-string) err-file)
813 (goto-char (point-min))
814 (read (current-buffer)))
815 (delete-file err-file)))))
817 (defun notmuch-start-notmuch (name buffer sentinel &rest args)
818 "Start and return an asynchronous notmuch command.
820 This starts and returns an asynchronous process running
821 `notmuch-command' with ARGS. The exit status is checked via
822 `notmuch-check-async-exit-status'. Output written to stderr is
823 redirected and displayed when the process exits (even if the
824 process exits successfully). NAME and BUFFER are the same as in
825 `start-process'. SENTINEL is a process sentinel function to call
826 when the process exits, or nil for none. The caller must *not*
827 invoke `set-process-sentinel' directly on the returned process,
828 as that will interfere with the handling of stderr and the exit
831 ;; There is no way (as of Emacs 24.3) to capture stdout and stderr
832 ;; separately for asynchronous processes, or even to redirect stderr
833 ;; to a file, so we use a trivial shell wrapper to send stderr to a
834 ;; temporary file and clean things up in the sentinel.
835 (let* ((err-file (make-temp-file "nmerr"))
837 (process-connection-type nil)
838 ;; Find notmuch using Emacs' `exec-path'
839 (command (or (executable-find notmuch-command)
840 (error "command not found: %s" notmuch-command)))
841 (proc (apply #'start-process name buffer
843 "exec 2>\"$1\"; shift; exec \"$0\" \"$@\""
844 command err-file args)))
845 (process-put proc 'err-file err-file)
846 (process-put proc 'sub-sentinel sentinel)
847 (process-put proc 'real-command (cons notmuch-command args))
848 (set-process-sentinel proc #'notmuch-start-notmuch-sentinel)
851 (defun notmuch-start-notmuch-sentinel (proc event)
852 (let ((err-file (process-get proc 'err-file))
853 (sub-sentinel (process-get proc 'sub-sentinel))
854 (real-command (process-get proc 'real-command)))
857 ;; Invoke the sub-sentinel, if any
859 (funcall sub-sentinel proc event))
860 ;; Check the exit status. This will signal an error if the
861 ;; exit status is non-zero. Don't do this if the process
862 ;; buffer is dead since that means Emacs killed the process
863 ;; and there's no point in telling the user that (but we
864 ;; still check for and report stderr output below).
865 (when (buffer-live-p (process-buffer proc))
866 (notmuch-check-async-exit-status proc event real-command err-file))
867 ;; If that didn't signal an error, then any error output was
868 ;; really warning output. Show warnings, if any.
871 (unless (= (second (insert-file-contents err-file)) 0)
873 ;; Show first line; stuff remaining lines in the
875 (let ((l1 (buffer-substring (point-min) (point))))
876 (skip-chars-forward "\n")
877 (cons l1 (unless (eobp)
878 (buffer-substring (point) (point-max)))))))))
880 (notmuch-logged-error (car warnings) (cdr warnings)))))
882 ;; Emacs behaves strangely if an error escapes from a sentinel,
883 ;; so turn errors into messages.
884 (message "%s" (error-message-string err))))
885 (ignore-errors (delete-file err-file))))
887 ;; This variable is used only buffer local, but it needs to be
888 ;; declared globally first to avoid compiler warnings.
889 (defvar notmuch-show-process-crypto nil)
890 (make-variable-buffer-local 'notmuch-show-process-crypto)
892 (provide 'notmuch-lib)
895 ;; byte-compile-warnings: (not cl-functions)