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>
22 ;; This is an part of an emacs-based interface to the notmuch mail system.
31 (unless (require 'notmuch-version nil t)
32 (defconst notmuch-emacs-version "unknown"
33 "Placeholder variable when notmuch-version.el[c] is not available."))
35 (autoload 'notmuch-jump-search "notmuch-jump"
36 "Jump to a saved search by shortcut key." t)
39 "Notmuch mail reader for Emacs."
42 (defgroup notmuch-hello nil
43 "Overview of saved searches, tags, etc."
46 (defgroup notmuch-search nil
47 "Searching and sorting mail."
50 (defgroup notmuch-show nil
51 "Showing messages and threads."
54 (defgroup notmuch-send nil
55 "Sending messages from Notmuch."
58 (custom-add-to-group 'notmuch-send 'message 'custom-group)
60 (defgroup notmuch-tag nil
61 "Tags and tagging in Notmuch."
64 (defgroup notmuch-crypto nil
65 "Processing and display of cryptographic MIME parts."
68 (defgroup notmuch-hooks nil
69 "Running custom code on well-defined occasions."
72 (defgroup notmuch-external nil
73 "Running external commands from within Notmuch."
76 (defgroup notmuch-faces nil
77 "Graphical attributes for displaying text"
80 (defcustom notmuch-command "notmuch"
81 "Name of the notmuch binary.
83 This can be a relative or absolute path to the notmuch binary.
84 If this is a relative path, it will be searched for in all of the
85 directories given in `exec-path' (which is, by default, based on
88 :group 'notmuch-external)
90 (defcustom notmuch-search-oldest-first t
91 "Show the oldest mail first when searching.
93 This variable defines the default sort order for displaying
94 search results. Note that any filtered searches created by
95 `notmuch-search-filter' retain the search order of the parent
98 :group 'notmuch-search)
100 (defcustom notmuch-poll-script nil
101 "[Deprecated] Command to run to incorporate new mail into the notmuch database.
103 This option has been deprecated in favor of \"notmuch new\"
104 hooks (see man notmuch-hooks). To change the path to the notmuch
105 binary, customize `notmuch-command'.
107 This variable controls the action invoked by
108 `notmuch-poll-and-refresh-this-buffer' (bound by default to 'G')
109 to incorporate new mail into the notmuch database.
111 If set to nil (the default), new mail is processed by invoking
112 \"notmuch new\". Otherwise, this should be set to a string that
113 gives the name of an external script that processes new mail. If
114 set to the empty string, no command will be run.
116 The external script could do any of the following depending on
119 1. Invoke a program to transfer mail to the local mail store
120 2. Invoke \"notmuch new\" to incorporate the new mail
121 3. Invoke one or more \"notmuch tag\" commands to classify the mail"
122 :type '(choice (const :tag "notmuch new" nil)
123 (const :tag "Disabled" "")
124 (string :tag "Custom script"))
125 :group 'notmuch-external)
129 (defvar notmuch-search-history nil
130 "Variable to store notmuch searches history.")
132 (defcustom notmuch-archive-tags '("-inbox")
133 "List of tag changes to apply to a message or a thread when it is archived.
135 Tags starting with \"+\" (or not starting with either \"+\" or
136 \"-\") in the list will be added, and tags starting with \"-\"
137 will be removed from the message or thread being archived.
139 For example, if you wanted to remove an \"inbox\" tag and add an
140 \"archived\" tag, you would set:
141 (\"-inbox\" \"+archived\")"
142 :type '(repeat string)
143 :group 'notmuch-search
144 :group 'notmuch-show)
146 (defvar notmuch-common-keymap
147 (let ((map (make-sparse-keymap)))
148 (define-key map "?" 'notmuch-help)
149 (define-key map "q" 'notmuch-bury-or-kill-this-buffer)
150 (define-key map "s" 'notmuch-search)
151 (define-key map "z" 'notmuch-tree)
152 (define-key map "m" 'notmuch-mua-new-mail)
153 (define-key map "=" 'notmuch-refresh-this-buffer)
154 (define-key map "G" 'notmuch-poll-and-refresh-this-buffer)
155 (define-key map "j" 'notmuch-jump-search)
157 "Keymap shared by all notmuch modes.")
159 ;; By default clicking on a button does not select the window
160 ;; containing the button (as opposed to clicking on a widget which
161 ;; does). This means that the button action is then executed in the
162 ;; current selected window which can cause problems if the button
163 ;; changes the buffer (e.g., id: links) or moves point.
165 ;; This provides a button type which overrides mouse-action so that
166 ;; the button's window is selected before the action is run. Other
167 ;; notmuch buttons can get the same behaviour by inheriting from this
169 (define-button-type 'notmuch-button-type
170 'mouse-action (lambda (button)
171 (select-window (posn-window (event-start last-input-event)))
172 (button-activate button)))
174 (defun notmuch-command-to-string (&rest args)
175 "Synchronously invoke \"notmuch\" with the given list of arguments.
177 If notmuch exits with a non-zero status, output from the process
178 will appear in a buffer named \"*Notmuch errors*\" and an error
181 Otherwise the output will be returned"
183 (let* ((status (apply #'call-process notmuch-command nil t nil args))
184 (output (buffer-string)))
185 (notmuch-check-exit-status status (cons notmuch-command args) output)
188 (defvar notmuch--cli-sane-p nil
189 "Cache whether the CLI seems to be configured sanely.")
191 (defun notmuch-cli-sane-p ()
192 "Return t if the cli seems to be configured sanely."
193 (unless notmuch--cli-sane-p
194 (let ((status (call-process notmuch-command nil nil nil
195 "config" "get" "user.primary_email")))
196 (setq notmuch--cli-sane-p (= status 0))))
199 (defun notmuch-assert-cli-sane ()
200 (unless (notmuch-cli-sane-p)
201 (notmuch-logged-error
202 "notmuch cli seems misconfigured or unconfigured."
203 "Perhaps you haven't run \"notmuch setup\" yet? Try running this
204 on the command line, and then retry your notmuch command")))
206 (defun notmuch-cli-version ()
207 "Return a string with the notmuch cli command version number."
209 ;; Trim off the trailing newline.
210 (substring (notmuch-command-to-string "--version") 0 -1)))
211 (if (string-match "^notmuch\\( version\\)? \\(.*\\)$"
213 (match-string 2 long-string)
216 (defun notmuch-config-get (item)
217 "Return a value from the notmuch configuration."
218 (let* ((val (notmuch-command-to-string "config" "get" item))
220 ;; Trim off the trailing newline (if the value is empty or not
221 ;; configured, there will be no newline)
222 (if (and (> len 0) (= (aref val (- len 1)) ?\n))
226 (defun notmuch-database-path ()
227 "Return the database.path value from the notmuch configuration."
228 (notmuch-config-get "database.path"))
230 (defun notmuch-user-name ()
231 "Return the user.name value from the notmuch configuration."
232 (notmuch-config-get "user.name"))
234 (defun notmuch-user-primary-email ()
235 "Return the user.primary_email value from the notmuch configuration."
236 (notmuch-config-get "user.primary_email"))
238 (defun notmuch-user-other-email ()
239 "Return the user.other_email value (as a list) from the notmuch configuration."
240 (split-string (notmuch-config-get "user.other_email") "\n" t))
242 (defun notmuch-user-emails ()
243 (cons (notmuch-user-primary-email) (notmuch-user-other-email)))
245 (defun notmuch-poll ()
246 "Run \"notmuch new\" or an external script to import mail.
248 Invokes `notmuch-poll-script', \"notmuch new\", or does nothing
249 depending on the value of `notmuch-poll-script'."
251 (if (stringp notmuch-poll-script)
252 (unless (string= notmuch-poll-script "")
253 (unless (equal (call-process notmuch-poll-script nil nil) 0)
254 (error "Notmuch: poll script `%s' failed!" notmuch-poll-script)))
255 (notmuch-call-notmuch-process "new")))
257 (defun notmuch-bury-or-kill-this-buffer ()
258 "Undisplay the current buffer.
260 Bury the current buffer, unless there is only one window showing
261 it, in which case it is killed."
263 (if (> (length (get-buffer-window-list nil nil t)) 1)
267 (defun notmuch-documentation-first-line (symbol)
268 "Return the first line of the documentation string for SYMBOL."
269 (let ((doc (documentation symbol)))
272 (insert (documentation symbol t))
273 (goto-char (point-min))
276 (buffer-substring beg (point))))
279 (defun notmuch-prefix-key-description (key)
280 "Given a prefix key code, return a human-readable string representation.
282 This is basically just `format-kbd-macro' but we also convert ESC to M-."
283 (let* ((key-vector (if (vectorp key) key (vector key)))
284 (desc (format-kbd-macro key-vector)))
285 (if (string= desc "ESC")
290 (defun notmuch-describe-key (actual-key binding prefix ua-keys tail)
291 "Prepend cons cells describing prefix-arg ACTUAL-KEY and ACTUAL-KEY to TAIL
293 It does not prepend if ACTUAL-KEY is already listed in TAIL."
294 (let ((key-string (concat prefix (format-kbd-macro actual-key))))
295 ;; We don't include documentation if the key-binding is
296 ;; over-ridden. Note, over-riding a binding automatically hides the
297 ;; prefixed version too.
298 (unless (assoc key-string tail)
299 (when (and ua-keys (symbolp binding)
300 (get binding 'notmuch-prefix-doc))
301 ;; Documentation for prefixed command
302 (let ((ua-desc (key-description ua-keys)))
303 (push (cons (concat ua-desc " " prefix (format-kbd-macro actual-key))
304 (get binding 'notmuch-prefix-doc))
306 ;; Documentation for command
307 (push (cons key-string
308 (or (and (symbolp binding) (get binding 'notmuch-doc))
309 (notmuch-documentation-first-line binding)))
313 (defun notmuch-describe-remaps (remap-keymap ua-keys base-keymap prefix tail)
314 ;; Remappings are represented as a binding whose first "event" is
315 ;; 'remap. Hence, if the keymap has any remappings, it will have a
316 ;; binding whose "key" is 'remap, and whose "binding" is itself a
317 ;; keymap that maps not from keys to commands, but from old (remapped)
318 ;; functions to the commands to use in their stead.
320 (lambda (command binding)
323 (setq tail (notmuch-describe-key actual-key binding prefix ua-keys tail)))
324 (where-is-internal command base-keymap)))
328 (defun notmuch-describe-keymap (keymap ua-keys base-keymap &optional prefix tail)
329 "Return a list of cons cells, each describing one binding in KEYMAP.
331 Each cons cell consists of a string giving a human-readable
332 description of the key, and a one-line description of the bound
333 function. See `notmuch-help' for an overview of how this
334 documentation is extracted.
336 UA-KEYS should be a key sequence bound to `universal-argument'.
337 It will be used to describe bindings of commands that support a
338 prefix argument. PREFIX and TAIL are used internally."
340 (lambda (key binding)
341 (cond ((mouse-event-p key) nil)
345 (notmuch-describe-remaps
346 binding ua-keys base-keymap prefix tail)
347 (notmuch-describe-keymap
348 binding ua-keys base-keymap (notmuch-prefix-key-description key) tail))))
350 (setq tail (notmuch-describe-key (vector key) binding prefix ua-keys tail)))))
354 (defun notmuch-substitute-command-keys (doc)
355 "Like `substitute-command-keys' but with documentation, not function names."
357 (while (string-match "\\\\{\\([^}[:space:]]*\\)}" doc beg)
360 (let* ((keymap-name (substring doc (match-beginning 1) (match-end 1)))
361 (keymap (symbol-value (intern keymap-name)))
362 (ua-keys (where-is-internal 'universal-argument keymap t))
363 (desc-alist (notmuch-describe-keymap keymap ua-keys keymap))
364 (desc-list (mapcar (lambda (arg) (concat (car arg) "\t" (cdr arg))) desc-alist)))
365 (mapconcat #'identity desc-list "\n")))))
366 (setq doc (replace-match desc 1 1 doc)))
367 (setq beg (match-end 0)))
370 (defun notmuch-help ()
371 "Display help for the current notmuch mode.
373 This is similar to `describe-function' for the current major
374 mode, but bindings tables are shown with documentation strings
375 rather than command names. By default, this uses the first line
376 of each command's documentation string. A command can override
377 this by setting the 'notmuch-doc property of its command symbol.
378 A command that supports a prefix argument can explicitly document
379 its prefixed behavior by setting the 'notmuch-prefix-doc property
380 of its command symbol."
382 (let* ((mode major-mode)
383 (doc (substitute-command-keys (notmuch-substitute-command-keys (documentation mode t)))))
384 (with-current-buffer (generate-new-buffer "*notmuch-help*")
386 (goto-char (point-min))
387 (set-buffer-modified-p nil)
388 (view-buffer (current-buffer) 'kill-buffer-if-not-modified))))
390 (defun notmuch-subkeymap-help ()
391 "Show help for a subkeymap."
393 (let* ((key (this-command-keys-vector))
394 (prefix (make-vector (1- (length key)) nil))
396 (while (< i (length prefix))
397 (aset prefix i (aref key i))
400 (let* ((subkeymap (key-binding prefix))
401 (ua-keys (where-is-internal 'universal-argument nil t))
402 (prefix-string (notmuch-prefix-key-description prefix))
403 (desc-alist (notmuch-describe-keymap subkeymap ua-keys subkeymap prefix-string))
404 (desc-list (mapcar (lambda (arg) (concat (car arg) "\t" (cdr arg))) desc-alist))
405 (desc (mapconcat #'identity desc-list "\n")))
406 (with-help-window (help-buffer)
407 (with-current-buffer standard-output
408 (insert "\nPress 'q' to quit this window.\n\n")
410 (pop-to-buffer (help-buffer)))))
412 (defvar notmuch-buffer-refresh-function nil
413 "Function to call to refresh the current buffer.")
414 (make-variable-buffer-local 'notmuch-buffer-refresh-function)
416 (defun notmuch-refresh-this-buffer ()
417 "Refresh the current buffer."
419 (when notmuch-buffer-refresh-function
420 ;; Pass prefix argument, etc.
421 (call-interactively notmuch-buffer-refresh-function)))
423 (defun notmuch-poll-and-refresh-this-buffer ()
424 "Invoke `notmuch-poll' to import mail, then refresh the current buffer."
427 (notmuch-refresh-this-buffer))
429 (defun notmuch-prettify-subject (subject)
430 ;; This function is used by `notmuch-search-process-filter' which
431 ;; requires that we not disrupt its' matching state.
434 (string-match "^[ \t]*$" subject))
438 (defun notmuch-sanitize (str)
439 "Sanitize control character in STR.
441 This includes newlines, tabs, and other funny characters."
442 (replace-regexp-in-string "[[:cntrl:]\x7f\u2028\u2029]+" " " str))
444 (defun notmuch-escape-boolean-term (term)
445 "Escape a boolean term for use in a query.
447 The caller is responsible for prepending the term prefix and a
448 colon. This performs minimal escaping in order to produce
449 user-friendly queries."
452 (if (or (equal term "")
453 ;; To be pessimistic, only pass through terms composed
454 ;; entirely of ASCII printing characters other than ", (,
456 (string-match "[^!#-'*-~]" term))
458 (concat "\"" (replace-regexp-in-string "\"" "\"\"" term t t) "\"")
461 (defun notmuch-id-to-query (id)
462 "Return a query that matches the message with id ID."
463 (concat "id:" (notmuch-escape-boolean-term id)))
465 (defun notmuch-hex-encode (str)
466 "Hex-encode STR (e.g., as used by batch tagging).
468 This replaces spaces, percents, and double quotes in STR with
469 %NN where NN is the hexadecimal value of the character."
470 (replace-regexp-in-string
471 "[ %\"]" (lambda (match) (format "%%%02x" (aref match 0))) str))
475 (defun notmuch-common-do-stash (text)
476 "Common function to stash text in kill ring, and display in minibuffer."
480 (message "Stashed: %s" text))
481 ;; There is nothing to stash so stash an empty string so the user
482 ;; doesn't accidentally paste something else somewhere.
484 (message "Nothing to stash!")))
488 (defun notmuch-remove-if-not (predicate list)
489 "Return a copy of LIST with all items not satisfying PREDICATE removed."
492 (when (funcall predicate (car list))
493 (push (car list) out))
494 (setq list (cdr list)))
497 (defun notmuch-plist-delete (plist property)
498 (let* ((xplist (cons nil plist))
501 (when (eq (cadr pred) property)
502 (setcdr pred (cdddr pred)))
503 (setq pred (cddr pred)))
506 (defun notmuch-split-content-type (content-type)
507 "Split content/type into 'content' and 'type'"
508 (split-string content-type "/"))
510 (defun notmuch-match-content-type (t1 t2)
511 "Return t if t1 and t2 are matching content types, taking wildcards into account"
512 (let ((st1 (notmuch-split-content-type t1))
513 (st2 (notmuch-split-content-type t2)))
514 (if (or (string= (cadr st1) "*")
515 (string= (cadr st2) "*"))
516 ;; Comparison of content types should be case insensitive.
517 (string= (downcase (car st1)) (downcase (car st2)))
518 (string= (downcase t1) (downcase t2)))))
520 (defvar notmuch-multipart/alternative-discouraged
524 ;; multipart/related usually contain a text/html part and some associated graphics.
528 (defun notmuch-multipart/alternative-determine-discouraged (msg)
529 "Return the discouraged alternatives for the specified message."
530 ;; If a function, return the result of calling it.
531 (if (functionp notmuch-multipart/alternative-discouraged)
532 (funcall notmuch-multipart/alternative-discouraged msg)
533 ;; Otherwise simply return the value of the variable, which is
534 ;; assumed to be a list of discouraged alternatives. This is the
535 ;; default behaviour.
536 notmuch-multipart/alternative-discouraged))
538 (defun notmuch-multipart/alternative-choose (msg types)
539 "Return a list of preferred types from the given list of types
540 for this message, if present."
541 ;; Based on `mm-preferred-alternative-precedence'.
542 (let ((discouraged (notmuch-multipart/alternative-determine-discouraged msg))
544 (dolist (pref (reverse discouraged))
545 (dolist (elem (copy-sequence seq))
546 (when (string-match pref elem)
547 (setq seq (nconc (delete elem seq) (list elem))))))
550 (defun notmuch-parts-filter-by-type (parts type)
551 "Given a list of message parts, return a list containing the ones matching
554 (lambda (part) (notmuch-match-content-type (plist-get part :content-type) type))
557 (defun notmuch--get-bodypart-raw (msg part process-crypto binaryp cache)
558 (let* ((plist-elem (if binaryp :content-binary :content))
559 (data (or (plist-get part plist-elem)
561 ;; Emacs internally uses a UTF-8-like multibyte string
562 ;; representation by default (regardless of the coding
563 ;; system, which only affects how it goes from outside data
564 ;; to this internal representation). This *almost* never
565 ;; matters. Annoyingly, it does matter if we use this data
566 ;; in an image descriptor, since Emacs will use its internal
567 ;; data buffer directly and this multibyte representation
568 ;; corrupts binary image formats. Since the caller is
569 ;; asking for binary data, a unibyte string is a more
570 ;; appropriate representation anyway.
572 (set-buffer-multibyte nil))
573 (let ((args `("show" "--format=raw"
574 ,(format "--part=%s" (plist-get part :id))
575 ,@(when process-crypto '("--decrypt"))
576 ,(notmuch-id-to-query (plist-get msg :id))))
577 (coding-system-for-read
578 (if binaryp 'no-conversion
579 (let ((coding-system (mm-charset-to-coding-system
580 (plist-get part :content-charset))))
582 ;; `mm-charset-to-coding-system' seems
583 ;; to return things that are not
584 ;; considered acceptable values for
585 ;; `coding-system-for-read'.
586 (if (coding-system-p coding-system)
588 ;; RFC 2047 says that the default
589 ;; charset is US-ASCII. RFC6657
590 ;; complicates this somewhat.
592 (apply #'call-process notmuch-command nil '(t nil) nil args)
594 (when (and cache data)
595 (plist-put part plist-elem data))
598 (defun notmuch-get-bodypart-binary (msg part process-crypto &optional cache)
599 "Return the unprocessed content of PART in MSG as a unibyte string.
601 This returns the \"raw\" content of the given part after content
602 transfer decoding, but with no further processing (see the
603 discussion of --format=raw in man notmuch-show). In particular,
604 this does no charset conversion.
606 If CACHE is non-nil, the content of this part will be saved in
607 MSG (if it isn't already)."
608 (notmuch--get-bodypart-raw msg part process-crypto t cache))
610 (defun notmuch-get-bodypart-text (msg part process-crypto &optional cache)
611 "Return the text content of PART in MSG.
613 This returns the content of the given part as a multibyte Lisp
614 string after performing content transfer decoding and any
615 necessary charset decoding.
617 If CACHE is non-nil, the content of this part will be saved in
618 MSG (if it isn't already)."
619 (notmuch--get-bodypart-raw msg part process-crypto nil cache))
621 ;; Workaround: The call to `mm-display-part' below triggers a bug in
622 ;; Emacs 24 if it attempts to use the shr renderer to display an HTML
623 ;; part with images in it (demonstrated in 24.1 and 24.2 on Debian and
624 ;; Fedora 17, though unreproducable in other configurations).
625 ;; `mm-shr' references the variable `gnus-inhibit-images' without
626 ;; first loading gnus-art, which defines it, resulting in a
627 ;; void-variable error. Hence, we advise `mm-shr' to ensure gnus-art
629 (if (>= emacs-major-version 24)
630 (defadvice mm-shr (before load-gnus-arts activate)
631 (require 'gnus-art nil t)
632 (ad-disable-advice 'mm-shr 'before 'load-gnus-arts)
633 (ad-activate 'mm-shr)))
635 (defun notmuch-mm-display-part-inline (msg part content-type process-crypto)
636 "Use the mm-decode/mm-view functions to display a part in the
637 current buffer, if possible."
638 (let ((display-buffer (current-buffer)))
640 ;; In case we already have :content, use it and tell mm-* that
641 ;; it's already been charset-decoded by using the fake
642 ;; `gnus-decoded' charset. Otherwise, we'll fetch the binary
643 ;; part content and let mm-* decode it.
644 (let* ((have-content (plist-member part :content))
645 (charset (if have-content 'gnus-decoded
646 (plist-get part :content-charset)))
647 (handle (mm-make-handle (current-buffer) `(,content-type (charset . ,charset)))))
648 ;; If the user wants the part inlined, insert the content and
649 ;; test whether we are able to inline it (which includes both
650 ;; capability and suitability tests).
651 (when (mm-inlined-p handle)
653 (insert (notmuch-get-bodypart-text msg part process-crypto))
654 (insert (notmuch-get-bodypart-binary msg part process-crypto)))
655 (when (mm-inlinable-p handle)
656 (set-buffer display-buffer)
657 (mm-display-part handle)
660 ;; Converts a plist of headers to an alist of headers. The input plist should
661 ;; have symbols of the form :Header as keys, and the resulting alist will have
662 ;; symbols of the form 'Header as keys.
663 (defun notmuch-headers-plist-to-alist (plist)
664 (loop for (key value . rest) on plist by #'cddr
665 collect (cons (intern (substring (symbol-name key) 1)) value)))
667 (defun notmuch-face-ensure-list-form (face)
668 "Return FACE in face list form.
670 If FACE is already a face list, it will be returned as-is. If
671 FACE is a face name or face plist, it will be returned as a
672 single element face list."
673 (if (and (listp face) (not (keywordp (car face))))
677 (defun notmuch-apply-face (object face &optional below start end)
678 "Combine FACE into the 'face text property of OBJECT between START and END.
680 This function combines FACE with any existing faces between START
681 and END in OBJECT. Attributes specified by FACE take precedence
682 over existing attributes unless BELOW is non-nil.
684 OBJECT may be a string, a buffer, or nil (which means the current
685 buffer). If object is a string, START and END are 0-based;
686 otherwise they are buffer positions (integers or markers). FACE
687 must be a face name (a symbol or string), a property list of face
688 attributes, or a list of these. If START and/or END are omitted,
689 they default to the beginning/end of OBJECT. For convenience
690 when applied to strings, this returns OBJECT."
692 ;; A face property can have three forms: a face name (a string or
693 ;; symbol), a property list, or a list of these two forms. In the
694 ;; list case, the faces will be combined, with the earlier faces
695 ;; taking precedent. Here we canonicalize everything to list form
696 ;; to make it easy to combine.
697 (let ((pos (cond (start start)
701 ((stringp object) (length object))
702 (t (1+ (buffer-size object)))))
703 (face-list (notmuch-face-ensure-list-form face)))
705 (let* ((cur (get-text-property pos 'face object))
706 (cur-list (notmuch-face-ensure-list-form cur))
707 (new (cond ((null cur-list) face)
708 (below (append cur-list face-list))
709 (t (append face-list cur-list))))
710 (next (next-single-property-change pos 'face object end)))
711 (put-text-property pos next 'face new object)
715 (defun notmuch-map-text-property (start end prop func &optional object)
716 "Transform text property PROP using FUNC.
718 Applies FUNC to each distinct value of the text property PROP
719 between START and END of OBJECT, setting PROP to the value
722 (let ((value (get-text-property start prop object))
723 (next (next-single-property-change start prop object end)))
724 (put-text-property start next prop (funcall func value) object)
727 (defun notmuch-logged-error (msg &optional extra)
728 "Log MSG and EXTRA to *Notmuch errors* and signal MSG.
730 This logs MSG and EXTRA to the *Notmuch errors* buffer and
731 signals MSG as an error. If EXTRA is non-nil, text referring the
732 user to the *Notmuch errors* buffer will be appended to the
733 signaled error. This function does not return."
735 (with-current-buffer (get-buffer-create "*Notmuch errors*")
736 (goto-char (point-max))
740 (insert "[" (current-time-string) "]\n" msg)
747 (error "%s" (concat msg (when extra
748 " (see *Notmuch errors* for more details)"))))
750 (defun notmuch-check-async-exit-status (proc msg &optional command err-file)
751 "If PROC exited abnormally, pop up an error buffer and signal an error.
753 This is a wrapper around `notmuch-check-exit-status' for
754 asynchronous process sentinels. PROC and MSG must be the
755 arguments passed to the sentinel. COMMAND and ERR-FILE, if
756 provided, are passed to `notmuch-check-exit-status'. If COMMAND
757 is not provided, it is taken from `process-command'."
759 (case (process-status proc)
760 ((exit) (process-exit-status proc))
763 (notmuch-check-exit-status exit-status (or command (process-command proc))
766 (defun notmuch-check-exit-status (exit-status command &optional output err-file)
767 "If EXIT-STATUS is non-zero, pop up an error buffer and signal an error.
769 If EXIT-STATUS is non-zero, pop up a notmuch error buffer
770 describing the error and signal an Elisp error. EXIT-STATUS must
771 be a number indicating the exit status code of a process or a
772 string describing the signal that terminated the process (such as
773 returned by `call-process'). COMMAND must be a list giving the
774 command and its arguments. OUTPUT, if provided, is a string
775 giving the output of command. ERR-FILE, if provided, is the name
776 of a file containing the error output of command. OUTPUT and the
777 contents of ERR-FILE will be included in the error message."
780 ((eq exit-status 0) t)
782 (notmuch-logged-error "notmuch CLI version mismatch
783 Emacs requested an older output format than supported by the notmuch CLI.
784 You may need to restart Emacs or upgrade your notmuch Emacs package."))
786 (notmuch-logged-error "notmuch CLI version mismatch
787 Emacs requested a newer output format than supported by the notmuch CLI.
788 You may need to restart Emacs or upgrade your notmuch package."))
790 (let* ((err (when err-file
792 (insert-file-contents err-file)
796 (mapconcat (lambda (arg)
797 (shell-quote-argument
798 (cond ((stringp arg) arg)
799 ((symbolp arg) (symbol-name arg))
800 (t "*UNKNOWN ARGUMENT*"))))
803 (concat "command: " command-string "\n"
804 (if (integerp exit-status)
805 (format "exit status: %s\n" exit-status)
806 (format "exit signal: %s\n" exit-status))
808 (concat "stderr:\n" err))
810 (concat "stdout:\n" output)))))
812 ;; We have an error message straight from the CLI.
813 (notmuch-logged-error
814 (replace-regexp-in-string "[ \n\r\t\f]*\\'" "" err) extra)
815 ;; We only have combined output from the CLI; don't inundate
816 ;; the user with it. Mimic `process-lines'.
817 (notmuch-logged-error (format "%s exited with status %s"
818 (car command) exit-status)
820 ;; `notmuch-logged-error' does not return.
823 (defun notmuch-call-notmuch--helper (destination args)
824 "Helper for synchronous notmuch invocation commands.
826 This wraps `call-process'. DESTINATION has the same meaning as
827 for `call-process'. ARGS is as described for
828 `notmuch-call-notmuch-process'."
831 (while (keywordp (car args))
833 (:stdin-string (setq stdin-string (cadr args)
836 (error "Unknown keyword argument: %s" (car args)))))
837 (if (null stdin-string)
838 (apply #'call-process notmuch-command nil destination nil args)
839 (insert stdin-string)
840 (apply #'call-process-region (point-min) (point-max)
841 notmuch-command t destination nil args))))
843 (defun notmuch-call-notmuch-process (&rest args)
844 "Synchronously invoke `notmuch-command' with ARGS.
846 The caller may provide keyword arguments before ARGS. Currently
847 supported keyword arguments are:
849 :stdin-string STRING - Write STRING to stdin
851 If notmuch exits with a non-zero status, output from the process
852 will appear in a buffer named \"*Notmuch errors*\" and an error
855 (let ((status (notmuch-call-notmuch--helper t args)))
856 (notmuch-check-exit-status status (cons notmuch-command args)
859 (defun notmuch-call-notmuch-sexp (&rest args)
860 "Invoke `notmuch-command' with ARGS and return the parsed S-exp output.
862 This is equivalent to `notmuch-call-notmuch-process', but parses
863 notmuch's output as an S-expression and returns the parsed value.
864 Like `notmuch-call-notmuch-process', if notmuch exits with a
865 non-zero status, this will report its output and signal an
869 (let ((err-file (make-temp-file "nmerr")))
871 (let ((status (notmuch-call-notmuch--helper (list t err-file) args)))
872 (notmuch-check-exit-status status (cons notmuch-command args)
873 (buffer-string) err-file)
874 (goto-char (point-min))
875 (read (current-buffer)))
876 (delete-file err-file)))))
878 (defun notmuch-start-notmuch (name buffer sentinel &rest args)
879 "Start and return an asynchronous notmuch command.
881 This starts and returns an asynchronous process running
882 `notmuch-command' with ARGS. The exit status is checked via
883 `notmuch-check-async-exit-status'. Output written to stderr is
884 redirected and displayed when the process exits (even if the
885 process exits successfully). NAME and BUFFER are the same as in
886 `start-process'. SENTINEL is a process sentinel function to call
887 when the process exits, or nil for none. The caller must *not*
888 invoke `set-process-sentinel' directly on the returned process,
889 as that will interfere with the handling of stderr and the exit
892 ;; There is no way (as of Emacs 24.3) to capture stdout and stderr
893 ;; separately for asynchronous processes, or even to redirect stderr
894 ;; to a file, so we use a trivial shell wrapper to send stderr to a
895 ;; temporary file and clean things up in the sentinel.
896 (let* ((err-file (make-temp-file "nmerr"))
898 (process-connection-type nil)
899 ;; Find notmuch using Emacs' `exec-path'
900 (command (or (executable-find notmuch-command)
901 (error "command not found: %s" notmuch-command)))
902 (proc (apply #'start-process name buffer
904 "exec 2>\"$1\"; shift; exec \"$0\" \"$@\""
905 command err-file args)))
906 (process-put proc 'err-file err-file)
907 (process-put proc 'sub-sentinel sentinel)
908 (process-put proc 'real-command (cons notmuch-command args))
909 (set-process-sentinel proc #'notmuch-start-notmuch-sentinel)
912 (defun notmuch-start-notmuch-sentinel (proc event)
913 (let ((err-file (process-get proc 'err-file))
914 (sub-sentinel (process-get proc 'sub-sentinel))
915 (real-command (process-get proc 'real-command)))
918 ;; Invoke the sub-sentinel, if any
920 (funcall sub-sentinel proc event))
921 ;; Check the exit status. This will signal an error if the
922 ;; exit status is non-zero. Don't do this if the process
923 ;; buffer is dead since that means Emacs killed the process
924 ;; and there's no point in telling the user that (but we
925 ;; still check for and report stderr output below).
926 (when (buffer-live-p (process-buffer proc))
927 (notmuch-check-async-exit-status proc event real-command err-file))
928 ;; If that didn't signal an error, then any error output was
929 ;; really warning output. Show warnings, if any.
932 (unless (= (second (insert-file-contents err-file)) 0)
934 ;; Show first line; stuff remaining lines in the
936 (let ((l1 (buffer-substring (point-min) (point))))
937 (skip-chars-forward "\n")
938 (cons l1 (unless (eobp)
939 (buffer-substring (point) (point-max)))))))))
941 (notmuch-logged-error (car warnings) (cdr warnings)))))
943 ;; Emacs behaves strangely if an error escapes from a sentinel,
944 ;; so turn errors into messages.
945 (message "%s" (error-message-string err))))
946 (ignore-errors (delete-file err-file))))
948 ;; This variable is used only buffer local, but it needs to be
949 ;; declared globally first to avoid compiler warnings.
950 (defvar notmuch-show-process-crypto nil)
951 (make-variable-buffer-local 'notmuch-show-process-crypto)
953 (provide 'notmuch-lib)
956 ;; byte-compile-warnings: (not cl-functions)
959 ;;; notmuch-lib.el ends here