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 <https://www.gnu.org/licenses/>.
20 ;; Authors: Carl Worth <cworth@cworth.org>
30 (require 'notmuch-compat)
32 (unless (require 'notmuch-version nil t)
33 (defconst notmuch-emacs-version "unknown"
34 "Placeholder variable when notmuch-version.el[c] is not available."))
37 "Notmuch mail reader for Emacs."
40 (defgroup notmuch-hello nil
41 "Overview of saved searches, tags, etc."
44 (defgroup notmuch-search nil
45 "Searching and sorting mail."
48 (defgroup notmuch-show nil
49 "Showing messages and threads."
52 (defgroup notmuch-send nil
53 "Sending messages from Notmuch."
57 (defgroup notmuch-tag nil
58 "Tags and tagging in Notmuch."
61 (defgroup notmuch-crypto nil
62 "Processing and display of cryptographic MIME parts."
65 (defgroup notmuch-hooks nil
66 "Running custom code on well-defined occasions."
69 (defgroup notmuch-external nil
70 "Running external commands from within Notmuch."
73 (defgroup notmuch-address nil
77 (defgroup notmuch-faces nil
78 "Graphical attributes for displaying text"
81 (defcustom notmuch-command "notmuch"
82 "Name of the notmuch binary.
84 This can be a relative or absolute path to the notmuch binary.
85 If this is a relative path, it will be searched for in all of the
86 directories given in `exec-path' (which is, by default, based on
89 :group 'notmuch-external)
91 (defcustom notmuch-search-oldest-first t
92 "Show the oldest mail first when searching.
94 This variable defines the default sort order for displaying
95 search results. Note that any filtered searches created by
96 `notmuch-search-filter' retain the search order of the parent
99 :group 'notmuch-search)
101 (defcustom notmuch-poll-script nil
102 "[Deprecated] Command to run to incorporate new mail into the notmuch database.
104 This option has been deprecated in favor of \"notmuch new\"
105 hooks (see man notmuch-hooks). To change the path to the notmuch
106 binary, customize `notmuch-command'.
108 This variable controls the action invoked by
109 `notmuch-poll-and-refresh-this-buffer' (bound by default to 'G')
110 to incorporate new mail into the notmuch database.
112 If set to nil (the default), new mail is processed by invoking
113 \"notmuch new\". Otherwise, this should be set to a string that
114 gives the name of an external script that processes new mail. If
115 set to the empty string, no command will be run.
117 The external script could do any of the following depending on
120 1. Invoke a program to transfer mail to the local mail store
121 2. Invoke \"notmuch new\" to incorporate the new mail
122 3. Invoke one or more \"notmuch tag\" commands to classify the mail"
123 :type '(choice (const :tag "notmuch new" nil)
124 (const :tag "Disabled" "")
125 (string :tag "Custom script"))
126 :group 'notmuch-external)
130 (defvar notmuch-search-history nil
131 "Variable to store notmuch searches history.")
133 (defcustom notmuch-archive-tags '("-inbox")
134 "List of tag changes to apply to a message or a thread when it is archived.
136 Tags starting with \"+\" (or not starting with either \"+\" or
137 \"-\") in the list will be added, and tags starting with \"-\"
138 will be removed from the message or thread being archived.
140 For example, if you wanted to remove an \"inbox\" tag and add an
141 \"archived\" tag, you would set:
142 (\"-inbox\" \"+archived\")"
143 :type '(repeat string)
144 :group 'notmuch-search
145 :group 'notmuch-show)
147 (defvar notmuch-common-keymap
148 (let ((map (make-sparse-keymap)))
149 (define-key map "?" 'notmuch-help)
150 (define-key map "v" 'notmuch-version)
151 (define-key map "q" 'notmuch-bury-or-kill-this-buffer)
152 (define-key map "s" 'notmuch-search)
153 (define-key map "t" 'notmuch-search-by-tag)
154 (define-key map "z" 'notmuch-tree)
155 (define-key map "u" 'notmuch-unthreaded)
156 (define-key map "m" 'notmuch-mua-new-mail)
157 (define-key map "g" 'notmuch-refresh-this-buffer)
158 (define-key map "=" 'notmuch-refresh-this-buffer)
159 (define-key map (kbd "M-=") 'notmuch-refresh-all-buffers)
160 (define-key map "G" 'notmuch-poll-and-refresh-this-buffer)
161 (define-key map "j" 'notmuch-jump-search)
163 "Keymap shared by all notmuch modes.")
165 ;; By default clicking on a button does not select the window
166 ;; containing the button (as opposed to clicking on a widget which
167 ;; does). This means that the button action is then executed in the
168 ;; current selected window which can cause problems if the button
169 ;; changes the buffer (e.g., id: links) or moves point.
171 ;; This provides a button type which overrides mouse-action so that
172 ;; the button's window is selected before the action is run. Other
173 ;; notmuch buttons can get the same behaviour by inheriting from this
175 (define-button-type 'notmuch-button-type
176 'mouse-action (lambda (button)
177 (select-window (posn-window (event-start last-input-event)))
178 (button-activate button)))
180 (defun notmuch-command-to-string (&rest args)
181 "Synchronously invoke \"notmuch\" with the given list of arguments.
183 If notmuch exits with a non-zero status, output from the process
184 will appear in a buffer named \"*Notmuch errors*\" and an error
187 Otherwise the output will be returned."
189 (let* ((status (apply #'call-process notmuch-command nil t nil args))
190 (output (buffer-string)))
191 (notmuch-check-exit-status status (cons notmuch-command args) output)
194 (defvar notmuch--cli-sane-p nil
195 "Cache whether the CLI seems to be configured sanely.")
197 (defun notmuch-cli-sane-p ()
198 "Return t if the cli seems to be configured sanely."
199 (unless notmuch--cli-sane-p
200 (let ((status (call-process notmuch-command nil nil nil
201 "config" "get" "user.primary_email")))
202 (setq notmuch--cli-sane-p (= status 0))))
205 (defun notmuch-assert-cli-sane ()
206 (unless (notmuch-cli-sane-p)
207 (notmuch-logged-error
208 "notmuch cli seems misconfigured or unconfigured."
209 "Perhaps you haven't run \"notmuch setup\" yet? Try running this
210 on the command line, and then retry your notmuch command")))
212 (defun notmuch-cli-version ()
213 "Return a string with the notmuch cli command version number."
215 ;; Trim off the trailing newline.
216 (substring (notmuch-command-to-string "--version") 0 -1)))
217 (if (string-match "^notmuch\\( version\\)? \\(.*\\)$"
219 (match-string 2 long-string)
222 (defvar notmuch-emacs-version)
224 (defun notmuch-version ()
225 "Display the notmuch version.
226 The versions of the Emacs package and the `notmuch' executable
227 should match, but if and only if they don't, then this command
228 displays both values separately."
230 (let ((cli-version (notmuch-cli-version)))
231 (message "notmuch version %s"
232 (if (string= notmuch-emacs-version cli-version)
235 " (emacs mua version " notmuch-emacs-version ")")))))
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-user-emails ()
264 (cons (notmuch-user-primary-email) (notmuch-user-other-email)))
266 (defun notmuch-poll ()
267 "Run \"notmuch new\" or an external script to import mail.
269 Invokes `notmuch-poll-script', \"notmuch new\", or does nothing
270 depending on the value of `notmuch-poll-script'."
272 (message "Polling mail...")
273 (if (stringp notmuch-poll-script)
274 (unless (string= notmuch-poll-script "")
275 (unless (equal (call-process notmuch-poll-script nil nil) 0)
276 (error "Notmuch: poll script `%s' failed!" notmuch-poll-script)))
277 (notmuch-call-notmuch-process "new"))
278 (message "Polling mail...done"))
280 (defun notmuch-bury-or-kill-this-buffer ()
281 "Undisplay the current buffer.
283 Bury the current buffer, unless there is only one window showing
284 it, in which case it is killed."
286 (if (> (length (get-buffer-window-list nil nil t)) 1)
290 (defun notmuch-documentation-first-line (symbol)
291 "Return the first line of the documentation string for SYMBOL."
292 (let ((doc (documentation symbol)))
295 (insert (documentation symbol t))
296 (goto-char (point-min))
299 (buffer-substring beg (point))))
302 (defun notmuch-prefix-key-description (key)
303 "Given a prefix key code, return a human-readable string representation.
305 This is basically just `format-kbd-macro' but we also convert ESC to M-."
306 (let* ((key-vector (if (vectorp key) key (vector key)))
307 (desc (format-kbd-macro key-vector)))
308 (if (string= desc "ESC")
313 (defun notmuch-describe-key (actual-key binding prefix ua-keys tail)
314 "Prepend cons cells describing prefix-arg ACTUAL-KEY and ACTUAL-KEY to TAIL.
316 It does not prepend if ACTUAL-KEY is already listed in TAIL."
317 (let ((key-string (concat prefix (key-description actual-key))))
318 ;; We don't include documentation if the key-binding is
319 ;; over-ridden. Note, over-riding a binding automatically hides the
320 ;; prefixed version too.
321 (unless (assoc key-string tail)
322 (when (and ua-keys (symbolp binding)
323 (get binding 'notmuch-prefix-doc))
324 ;; Documentation for prefixed command
325 (let ((ua-desc (key-description ua-keys)))
326 (push (cons (concat ua-desc " " prefix (format-kbd-macro actual-key))
327 (get binding 'notmuch-prefix-doc))
329 ;; Documentation for command
330 (push (cons key-string
331 (or (and (symbolp binding)
332 (get binding 'notmuch-doc))
333 (and (functionp binding)
334 (notmuch-documentation-first-line binding))))
338 (defun notmuch-describe-remaps (remap-keymap ua-keys base-keymap prefix tail)
339 ;; Remappings are represented as a binding whose first "event" is
340 ;; 'remap. Hence, if the keymap has any remappings, it will have a
341 ;; binding whose "key" is 'remap, and whose "binding" is itself a
342 ;; keymap that maps not from keys to commands, but from old (remapped)
343 ;; functions to the commands to use in their stead.
344 (map-keymap (lambda (command binding)
345 (mapc (lambda (actual-key)
347 (notmuch-describe-key actual-key binding
348 prefix ua-keys tail)))
349 (where-is-internal command base-keymap)))
353 (defun notmuch-describe-keymap (keymap ua-keys base-keymap &optional prefix tail)
354 "Return a list of cons cells, each describing one binding in KEYMAP.
356 Each cons cell consists of a string giving a human-readable
357 description of the key, and a one-line description of the bound
358 function. See `notmuch-help' for an overview of how this
359 documentation is extracted.
361 UA-KEYS should be a key sequence bound to `universal-argument'.
362 It will be used to describe bindings of commands that support a
363 prefix argument. PREFIX and TAIL are used internally."
365 (lambda (key binding)
366 (cond ((mouse-event-p key) nil)
370 (notmuch-describe-remaps
371 binding ua-keys base-keymap prefix tail)
372 (notmuch-describe-keymap
373 binding ua-keys base-keymap
374 (notmuch-prefix-key-description key)
378 (notmuch-describe-key (vector key)
379 binding prefix ua-keys tail)))))
383 (defun notmuch-substitute-command-keys (doc)
384 "Like `substitute-command-keys' but with documentation, not function names."
386 (while (string-match "\\\\{\\([^}[:space:]]*\\)}" doc beg)
389 (let* ((keymap-name (substring doc
392 (keymap (symbol-value (intern keymap-name)))
393 (ua-keys (where-is-internal 'universal-argument keymap t))
394 (desc-alist (notmuch-describe-keymap keymap ua-keys keymap))
395 (desc-list (mapcar (lambda (arg)
396 (concat (car arg) "\t" (cdr arg)))
398 (mapconcat #'identity desc-list "\n")))))
399 (setq doc (replace-match desc 1 1 doc)))
400 (setq beg (match-end 0)))
403 (defun notmuch-help ()
404 "Display help for the current notmuch mode.
406 This is similar to `describe-function' for the current major
407 mode, but bindings tables are shown with documentation strings
408 rather than command names. By default, this uses the first line
409 of each command's documentation string. A command can override
410 this by setting the 'notmuch-doc property of its command symbol.
411 A command that supports a prefix argument can explicitly document
412 its prefixed behavior by setting the 'notmuch-prefix-doc property
413 of its command symbol."
415 (let* ((mode major-mode)
416 (doc (substitute-command-keys
417 (notmuch-substitute-command-keys (documentation mode t)))))
418 (with-current-buffer (generate-new-buffer "*notmuch-help*")
420 (goto-char (point-min))
421 (set-buffer-modified-p nil)
422 (view-buffer (current-buffer) 'kill-buffer-if-not-modified))))
424 (defun notmuch-subkeymap-help ()
425 "Show help for a subkeymap."
427 (let* ((key (this-command-keys-vector))
428 (prefix (make-vector (1- (length key)) nil))
430 (while (< i (length prefix))
431 (aset prefix i (aref key i))
433 (let* ((subkeymap (key-binding prefix))
434 (ua-keys (where-is-internal 'universal-argument nil t))
435 (prefix-string (notmuch-prefix-key-description prefix))
436 (desc-alist (notmuch-describe-keymap
437 subkeymap ua-keys subkeymap prefix-string))
438 (desc-list (mapcar (lambda (arg) (concat (car arg) "\t" (cdr arg)))
440 (desc (mapconcat #'identity desc-list "\n")))
441 (with-help-window (help-buffer)
442 (with-current-buffer standard-output
443 (insert "\nPress 'q' to quit this window.\n\n")
445 (pop-to-buffer (help-buffer)))))
447 (defvar notmuch-buffer-refresh-function nil
448 "Function to call to refresh the current buffer.")
449 (make-variable-buffer-local 'notmuch-buffer-refresh-function)
451 (defun notmuch-refresh-this-buffer ()
452 "Refresh the current buffer."
454 (when notmuch-buffer-refresh-function
455 ;; Pass prefix argument, etc.
456 (call-interactively notmuch-buffer-refresh-function)))
458 (defun notmuch-poll-and-refresh-this-buffer ()
459 "Invoke `notmuch-poll' to import mail, then refresh the current buffer."
462 (notmuch-refresh-this-buffer))
464 (defun notmuch-refresh-all-buffers ()
465 "Invoke `notmuch-refresh-this-buffer' on all notmuch major-mode buffers.
467 The buffers are silently refreshed, i.e. they are not forced to
470 (dolist (buffer (buffer-list))
471 (let ((buffer-mode (buffer-local-value 'major-mode buffer)))
472 (when (memq buffer-mode '(notmuch-show-mode
476 (with-current-buffer buffer
477 (notmuch-refresh-this-buffer))))))
479 (defun notmuch-prettify-subject (subject)
480 ;; This function is used by `notmuch-search-process-filter' which
481 ;; requires that we not disrupt its' matching state.
484 (string-match "^[ \t]*$" subject))
488 (defun notmuch-sanitize (str)
489 "Sanitize control character in STR.
491 This includes newlines, tabs, and other funny characters."
492 (replace-regexp-in-string "[[:cntrl:]\x7f\u2028\u2029]+" " " str))
494 (defun notmuch-escape-boolean-term (term)
495 "Escape a boolean term for use in a query.
497 The caller is responsible for prepending the term prefix and a
498 colon. This performs minimal escaping in order to produce
499 user-friendly queries."
501 (if (or (equal term "")
502 ;; To be pessimistic, only pass through terms composed
503 ;; entirely of ASCII printing characters other than ", (,
505 (string-match "[^!#-'*-~]" term))
507 (concat "\"" (replace-regexp-in-string "\"" "\"\"" term t t) "\"")
510 (defun notmuch-id-to-query (id)
511 "Return a query that matches the message with id ID."
512 (concat "id:" (notmuch-escape-boolean-term id)))
514 (defun notmuch-hex-encode (str)
515 "Hex-encode STR (e.g., as used by batch tagging).
517 This replaces spaces, percents, and double quotes in STR with
518 %NN where NN is the hexadecimal value of the character."
519 (replace-regexp-in-string
520 "[ %\"]" (lambda (match) (format "%%%02x" (aref match 0))) str))
524 (defun notmuch-common-do-stash (text)
525 "Common function to stash text in kill ring, and display in minibuffer."
529 (message "Stashed: %s" text))
530 ;; There is nothing to stash so stash an empty string so the user
531 ;; doesn't accidentally paste something else somewhere.
533 (message "Nothing to stash!")))
537 (defun notmuch-plist-delete (plist property)
538 (let* ((xplist (cons nil plist))
541 (when (eq (cadr pred) property)
542 (setcdr pred (cdddr pred)))
543 (setq pred (cddr pred)))
546 (defun notmuch-split-content-type (content-type)
547 "Split content/type into 'content' and 'type'."
548 (split-string content-type "/"))
550 (defun notmuch-match-content-type (t1 t2)
551 "Return t if t1 and t2 are matching content types, taking wildcards into account."
552 (let ((st1 (notmuch-split-content-type t1))
553 (st2 (notmuch-split-content-type t2)))
554 (if (or (string= (cadr st1) "*")
555 (string= (cadr st2) "*"))
556 ;; Comparison of content types should be case insensitive.
557 (string= (downcase (car st1)) (downcase (car st2)))
558 (string= (downcase t1) (downcase t2)))))
560 (defvar notmuch-multipart/alternative-discouraged
561 '(;; Avoid HTML parts.
563 ;; multipart/related usually contain a text/html part and some
564 ;; associated graphics.
565 "multipart/related"))
567 (defun notmuch-multipart/alternative-determine-discouraged (msg)
568 "Return the discouraged alternatives for the specified message."
569 ;; If a function, return the result of calling it.
570 (if (functionp notmuch-multipart/alternative-discouraged)
571 (funcall notmuch-multipart/alternative-discouraged msg)
572 ;; Otherwise simply return the value of the variable, which is
573 ;; assumed to be a list of discouraged alternatives. This is the
574 ;; default behaviour.
575 notmuch-multipart/alternative-discouraged))
577 (defun notmuch-multipart/alternative-choose (msg types)
578 "Return a list of preferred types from the given list of types
579 for this message, if present."
580 ;; Based on `mm-preferred-alternative-precedence'.
581 (let ((discouraged (notmuch-multipart/alternative-determine-discouraged msg))
583 (dolist (pref (reverse discouraged))
584 (dolist (elem (copy-sequence seq))
585 (when (string-match pref elem)
586 (setq seq (nconc (delete elem seq) (list elem))))))
589 (defun notmuch-parts-filter-by-type (parts type)
590 "Given a list of message parts, return a list containing the ones matching
593 (lambda (part) (notmuch-match-content-type (plist-get part :content-type) type))
596 (defun notmuch--get-bodypart-raw (msg part process-crypto binaryp cache)
597 (let* ((plist-elem (if binaryp :content-binary :content))
598 (data (or (plist-get part plist-elem)
600 ;; Emacs internally uses a UTF-8-like multibyte string
601 ;; representation by default (regardless of the coding
602 ;; system, which only affects how it goes from outside data
603 ;; to this internal representation). This *almost* never
604 ;; matters. Annoyingly, it does matter if we use this data
605 ;; in an image descriptor, since Emacs will use its internal
606 ;; data buffer directly and this multibyte representation
607 ;; corrupts binary image formats. Since the caller is
608 ;; asking for binary data, a unibyte string is a more
609 ;; appropriate representation anyway.
611 (set-buffer-multibyte nil))
612 (let ((args `("show" "--format=raw"
613 ,(format "--part=%s" (plist-get part :id))
614 ,@(and process-crypto '("--decrypt=true"))
615 ,(notmuch-id-to-query (plist-get msg :id))))
616 (coding-system-for-read
620 (mm-charset-to-coding-system
621 (plist-get part :content-charset))))
623 ;; `mm-charset-to-coding-system' seems
624 ;; to return things that are not
625 ;; considered acceptable values for
626 ;; `coding-system-for-read'.
627 (if (coding-system-p coding-system)
629 ;; RFC 2047 says that the default
630 ;; charset is US-ASCII. RFC6657
631 ;; complicates this somewhat.
633 (apply #'call-process
634 notmuch-command nil '(t nil) nil args)
636 (when (and cache data)
637 (plist-put part plist-elem data))
640 (defun notmuch-get-bodypart-binary (msg part process-crypto &optional cache)
641 "Return the unprocessed content of PART in MSG as a unibyte string.
643 This returns the \"raw\" content of the given part after content
644 transfer decoding, but with no further processing (see the
645 discussion of --format=raw in man notmuch-show). In particular,
646 this does no charset conversion.
648 If CACHE is non-nil, the content of this part will be saved in
649 MSG (if it isn't already)."
650 (notmuch--get-bodypart-raw msg part process-crypto t cache))
652 (defun notmuch-get-bodypart-text (msg part process-crypto &optional cache)
653 "Return the text content of PART in MSG.
655 This returns the content of the given part as a multibyte Lisp
656 string after performing content transfer decoding and any
657 necessary charset decoding.
659 If CACHE is non-nil, the content of this part will be saved in
660 MSG (if it isn't already)."
661 (notmuch--get-bodypart-raw msg part process-crypto nil cache))
663 (defun notmuch-mm-display-part-inline (msg part content-type process-crypto)
664 "Use the mm-decode/mm-view functions to display a part in the
665 current buffer, if possible."
666 (let ((display-buffer (current-buffer)))
668 ;; In case we already have :content, use it and tell mm-* that
669 ;; it's already been charset-decoded by using the fake
670 ;; `gnus-decoded' charset. Otherwise, we'll fetch the binary
671 ;; part content and let mm-* decode it.
672 (let* ((have-content (plist-member part :content))
673 (charset (if have-content
675 (plist-get part :content-charset)))
676 (handle (mm-make-handle (current-buffer)
677 `(,content-type (charset . ,charset)))))
678 ;; If the user wants the part inlined, insert the content and
679 ;; test whether we are able to inline it (which includes both
680 ;; capability and suitability tests).
681 (when (mm-inlined-p handle)
683 (insert (notmuch-get-bodypart-text msg part process-crypto))
684 (insert (notmuch-get-bodypart-binary msg part process-crypto)))
685 (when (mm-inlinable-p handle)
686 (set-buffer display-buffer)
687 (mm-display-part handle)
690 ;; Converts a plist of headers to an alist of headers. The input plist should
691 ;; have symbols of the form :Header as keys, and the resulting alist will have
692 ;; symbols of the form 'Header as keys.
693 (defun notmuch-headers-plist-to-alist (plist)
694 (cl-loop for (key value . rest) on plist by #'cddr
695 collect (cons (intern (substring (symbol-name key) 1)) value)))
697 (defun notmuch-face-ensure-list-form (face)
698 "Return FACE in face list form.
700 If FACE is already a face list, it will be returned as-is. If
701 FACE is a face name or face plist, it will be returned as a
702 single element face list."
703 (if (and (listp face) (not (keywordp (car face))))
707 (defun notmuch-apply-face (object face &optional below start end)
708 "Combine FACE into the 'face text property of OBJECT between START and END.
710 This function combines FACE with any existing faces between START
711 and END in OBJECT. Attributes specified by FACE take precedence
712 over existing attributes unless BELOW is non-nil.
714 OBJECT may be a string, a buffer, or nil (which means the current
715 buffer). If object is a string, START and END are 0-based;
716 otherwise they are buffer positions (integers or markers). FACE
717 must be a face name (a symbol or string), a property list of face
718 attributes, or a list of these. If START and/or END are omitted,
719 they default to the beginning/end of OBJECT. For convenience
720 when applied to strings, this returns OBJECT."
721 ;; A face property can have three forms: a face name (a string or
722 ;; symbol), a property list, or a list of these two forms. In the
723 ;; list case, the faces will be combined, with the earlier faces
724 ;; taking precedent. Here we canonicalize everything to list form
725 ;; to make it easy to combine.
726 (let ((pos (cond (start start)
730 ((stringp object) (length object))
731 (t (1+ (buffer-size object)))))
732 (face-list (notmuch-face-ensure-list-form face)))
734 (let* ((cur (get-text-property pos 'face object))
735 (cur-list (notmuch-face-ensure-list-form cur))
736 (new (cond ((null cur-list) face)
737 (below (append cur-list face-list))
738 (t (append face-list cur-list))))
739 (next (next-single-property-change pos 'face object end)))
740 (put-text-property pos next 'face new object)
744 (defun notmuch-map-text-property (start end prop func &optional object)
745 "Transform text property PROP using FUNC.
747 Applies FUNC to each distinct value of the text property PROP
748 between START and END of OBJECT, setting PROP to the value
751 (let ((value (get-text-property start prop object))
752 (next (next-single-property-change start prop object end)))
753 (put-text-property start next prop (funcall func value) object)
756 (defun notmuch-logged-error (msg &optional extra)
757 "Log MSG and EXTRA to *Notmuch errors* and signal MSG.
759 This logs MSG and EXTRA to the *Notmuch errors* buffer and
760 signals MSG as an error. If EXTRA is non-nil, text referring the
761 user to the *Notmuch errors* buffer will be appended to the
762 signaled error. This function does not return."
763 (with-current-buffer (get-buffer-create "*Notmuch errors*")
764 (goto-char (point-max))
768 (insert "[" (current-time-string) "]\n" msg)
775 (error "%s%s" msg (if extra " (see *Notmuch errors* for more details)" "")))
777 (defun notmuch-check-async-exit-status (proc msg &optional command err)
778 "If PROC exited abnormally, pop up an error buffer and signal an error.
780 This is a wrapper around `notmuch-check-exit-status' for
781 asynchronous process sentinels. PROC and MSG must be the
782 arguments passed to the sentinel. COMMAND and ERR, if provided,
783 are passed to `notmuch-check-exit-status'. If COMMAND is not
784 provided, it is taken from `process-command'."
786 (cl-case (process-status proc)
787 ((exit) (process-exit-status proc))
790 (notmuch-check-exit-status exit-status
791 (or command (process-command proc))
794 (defun notmuch-check-exit-status (exit-status command &optional output err)
795 "If EXIT-STATUS is non-zero, pop up an error buffer and signal an error.
797 If EXIT-STATUS is non-zero, pop up a notmuch error buffer
798 describing the error and signal an Elisp error. EXIT-STATUS must
799 be a number indicating the exit status code of a process or a
800 string describing the signal that terminated the process (such as
801 returned by `call-process'). COMMAND must be a list giving the
802 command and its arguments. OUTPUT, if provided, is a string
803 giving the output of command. ERR, if provided, is the error
804 output of command. OUTPUT and ERR will be included in the error
807 ((eq exit-status 0) t)
809 (notmuch-logged-error "notmuch CLI version mismatch
810 Emacs requested an older output format than supported by the notmuch CLI.
811 You may need to restart Emacs or upgrade your notmuch Emacs package."))
813 (notmuch-logged-error "notmuch CLI version mismatch
814 Emacs requested a newer output format than supported by the notmuch CLI.
815 You may need to restart Emacs or upgrade your notmuch package."))
817 (let* ((command-string
818 (mapconcat (lambda (arg)
819 (shell-quote-argument
820 (cond ((stringp arg) arg)
821 ((symbolp arg) (symbol-name arg))
822 (t "*UNKNOWN ARGUMENT*"))))
825 (concat "command: " command-string "\n"
826 (if (integerp exit-status)
827 (format "exit status: %s\n" exit-status)
828 (format "exit signal: %s\n" exit-status))
829 (and err (concat "stderr:\n" err))
830 (and output (concat "stdout:\n" output)))))
832 ;; We have an error message straight from the CLI.
833 (notmuch-logged-error
834 (replace-regexp-in-string "[ \n\r\t\f]*\\'" "" err) extra)
835 ;; We only have combined output from the CLI; don't inundate
836 ;; the user with it. Mimic `process-lines'.
837 (notmuch-logged-error (format "%s exited with status %s"
838 (car command) exit-status)
840 ;; `notmuch-logged-error' does not return.
843 (defun notmuch-call-notmuch--helper (destination args)
844 "Helper for synchronous notmuch invocation commands.
846 This wraps `call-process'. DESTINATION has the same meaning as
847 for `call-process'. ARGS is as described for
848 `notmuch-call-notmuch-process'."
850 (while (keywordp (car args))
852 (:stdin-string (setq stdin-string (cadr args))
853 (setq args (cddr args)))
855 (error "Unknown keyword argument: %s" (car args)))))
856 (if (null stdin-string)
857 (apply #'call-process notmuch-command nil destination nil args)
858 (insert stdin-string)
859 (apply #'call-process-region (point-min) (point-max)
860 notmuch-command t destination nil args))))
862 (defun notmuch-call-notmuch-process (&rest args)
863 "Synchronously invoke `notmuch-command' with ARGS.
865 The caller may provide keyword arguments before ARGS. Currently
866 supported keyword arguments are:
868 :stdin-string STRING - Write STRING to stdin
870 If notmuch exits with a non-zero status, output from the process
871 will appear in a buffer named \"*Notmuch errors*\" and an error
874 (let ((status (notmuch-call-notmuch--helper t args)))
875 (notmuch-check-exit-status status (cons notmuch-command args)
878 (defun notmuch-call-notmuch-sexp (&rest args)
879 "Invoke `notmuch-command' with ARGS and return the parsed S-exp output.
881 This is equivalent to `notmuch-call-notmuch-process', but parses
882 notmuch's output as an S-expression and returns the parsed value.
883 Like `notmuch-call-notmuch-process', if notmuch exits with a
884 non-zero status, this will report its output and signal an
887 (let ((err-file (make-temp-file "nmerr")))
889 (let ((status (notmuch-call-notmuch--helper (list t err-file) args))
890 (err (with-temp-buffer
891 (insert-file-contents err-file)
894 (notmuch-check-exit-status status (cons notmuch-command args)
896 (goto-char (point-min))
897 (read (current-buffer)))
898 (delete-file err-file)))))
900 (defun notmuch-start-notmuch (name buffer sentinel &rest args)
901 "Start and return an asynchronous notmuch command.
903 This starts and returns an asynchronous process running
904 `notmuch-command' with ARGS. The exit status is checked via
905 `notmuch-check-async-exit-status'. Output written to stderr is
906 redirected and displayed when the process exits (even if the
907 process exits successfully). NAME and BUFFER are the same as in
908 `start-process'. SENTINEL is a process sentinel function to call
909 when the process exits, or nil for none. The caller must *not*
910 invoke `set-process-sentinel' directly on the returned process,
911 as that will interfere with the handling of stderr and the exit
913 (let (err-file err-buffer proc err-proc
914 ;; Find notmuch using Emacs' `exec-path'
915 (command (or (executable-find notmuch-command)
916 (error "Command not found: %s" notmuch-command))))
917 (if (fboundp 'make-process)
919 (setq err-buffer (generate-new-buffer " *notmuch-stderr*"))
920 ;; Emacs 25 and newer has `make-process', which allows
921 ;; redirecting stderr independently from stdout to a
922 ;; separate buffer. As this allows us to avoid using a
923 ;; temporary file and shell invocation, use it when
925 (setq proc (make-process
928 :command (cons command args)
929 :connection-type 'pipe
931 (setq err-proc (get-buffer-process err-buffer))
932 (process-put proc 'err-buffer err-buffer)
934 (process-put err-proc 'err-file err-file)
935 (process-put err-proc 'err-buffer err-buffer)
936 (set-process-sentinel err-proc #'notmuch-start-notmuch-error-sentinel))
937 ;; On Emacs versions before 25, there is no way to capture
938 ;; stdout and stderr separately for asynchronous processes, or
939 ;; even to redirect stderr to a file, so we use a trivial shell
940 ;; wrapper to send stderr to a temporary file and clean things
941 ;; up in the sentinel.
942 (setq err-file (make-temp-file "nmerr"))
943 (let ((process-connection-type nil)) ;; Use a pipe
944 (setq proc (apply #'start-process name buffer
946 "exec 2>\"$1\"; shift; exec \"$0\" \"$@\""
947 command err-file args)))
948 (process-put proc 'err-file err-file))
949 (process-put proc 'sub-sentinel sentinel)
950 (process-put proc 'real-command (cons notmuch-command args))
951 (set-process-sentinel proc #'notmuch-start-notmuch-sentinel)
954 (defun notmuch-start-notmuch-sentinel (proc event)
955 "Process sentinel function used by `notmuch-start-notmuch'."
956 (let* ((err-file (process-get proc 'err-file))
957 (err-buffer (or (process-get proc 'err-buffer)
958 (find-file-noselect err-file)))
959 (err (and (not (zerop (buffer-size err-buffer)))
960 (with-current-buffer err-buffer (buffer-string))))
961 (sub-sentinel (process-get proc 'sub-sentinel))
962 (real-command (process-get proc 'real-command)))
965 ;; Invoke the sub-sentinel, if any
967 (funcall sub-sentinel proc event))
968 ;; Check the exit status. This will signal an error if the
969 ;; exit status is non-zero. Don't do this if the process
970 ;; buffer is dead since that means Emacs killed the process
971 ;; and there's no point in telling the user that (but we
972 ;; still check for and report stderr output below).
973 (when (buffer-live-p (process-buffer proc))
974 (notmuch-check-async-exit-status proc event real-command err))
975 ;; If that didn't signal an error, then any error output was
976 ;; really warning output. Show warnings, if any.
979 (with-current-buffer err-buffer
980 (goto-char (point-min))
982 ;; Show first line; stuff remaining lines in the
984 (let ((l1 (buffer-substring (point-min) (point))))
985 (skip-chars-forward "\n")
986 (cons l1 (and (not (eobp))
987 (buffer-substring (point)
990 (notmuch-logged-error (car warnings) (cdr warnings)))))
992 ;; Emacs behaves strangely if an error escapes from a sentinel,
993 ;; so turn errors into messages.
994 (message "%s" (error-message-string err))))
995 (when err-file (ignore-errors (delete-file err-file)))))
997 (defun notmuch-start-notmuch-error-sentinel (proc event)
998 (let* ((err-file (process-get proc 'err-file))
999 ;; When `make-process' is available, use the error buffer
1000 ;; associated with the process, otherwise the error file.
1001 (err-buffer (or (process-get proc 'err-buffer)
1002 (find-file-noselect err-file))))
1003 (when err-buffer (kill-buffer err-buffer))))
1005 ;; This variable is used only buffer local, but it needs to be
1006 ;; declared globally first to avoid compiler warnings.
1007 (defvar notmuch-show-process-crypto nil)
1008 (make-variable-buffer-local 'notmuch-show-process-crypto)
1010 (defun notmuch-interactive-region ()
1011 "Return the bounds of the current interactive region.
1013 This returns (BEG END), where BEG and END are the bounds of the
1014 region if the region is active, or both `point' otherwise."
1015 (if (region-active-p)
1016 (list (region-beginning) (region-end))
1017 (list (point) (point))))
1019 (define-obsolete-function-alias
1020 'notmuch-search-interactive-region
1021 'notmuch-interactive-region
1024 (provide 'notmuch-lib)
1026 ;;; notmuch-lib.el ends here