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-search-poll-and-refresh-view' and
84 `notmuch-hello-poll-and-update' (each have a default keybinding
85 of 'G') to incorporate new mail into the notmuch database.
87 If set to nil (the default), new mail is processed by invoking
88 \"notmuch new\". Otherwise, this should be set to a string that
89 gives the name of an external script that processes new mail. If
90 set to the empty string, no command will be run.
92 The external script could do any of the following depending on
95 1. Invoke a program to transfer mail to the local mail store
96 2. Invoke \"notmuch new\" to incorporate the new mail
97 3. Invoke one or more \"notmuch tag\" commands to classify the mail
99 Note that the recommended way of achieving the same is using
100 \"notmuch new\" hooks."
101 :type '(choice (const :tag "notmuch new" nil)
102 (const :tag "Disabled" "")
103 (string :tag "Custom script"))
104 :group 'notmuch-external)
108 (defvar notmuch-search-history nil
109 "Variable to store notmuch searches history.")
111 (defcustom notmuch-saved-searches '(("inbox" . "tag:inbox")
112 ("unread" . "tag:unread"))
113 "A list of saved searches to display."
114 :type '(alist :key-type string :value-type string)
115 :group 'notmuch-hello)
117 (defcustom notmuch-archive-tags '("-inbox")
118 "List of tag changes to apply to a message or a thread when it is archived.
120 Tags starting with \"+\" (or not starting with either \"+\" or
121 \"-\") in the list will be added, and tags starting with \"-\"
122 will be removed from the message or thread being archived.
124 For example, if you wanted to remove an \"inbox\" tag and add an
125 \"archived\" tag, you would set:
126 (\"-inbox\" \"+archived\")"
127 :type '(repeat string)
128 :group 'notmuch-search
129 :group 'notmuch-show)
131 (defvar notmuch-common-keymap
132 (let ((map (make-sparse-keymap)))
133 (define-key map "?" 'notmuch-help)
134 (define-key map "q" 'notmuch-kill-this-buffer)
135 (define-key map "s" 'notmuch-search)
136 (define-key map "m" 'notmuch-mua-new-mail)
137 (define-key map "=" 'notmuch-refresh-this-buffer)
138 (define-key map "G" 'notmuch-poll-and-refresh-this-buffer)
140 "Keymap shared by all notmuch modes.")
142 ;; By default clicking on a button does not select the window
143 ;; containing the button (as opposed to clicking on a widget which
144 ;; does). This means that the button action is then executed in the
145 ;; current selected window which can cause problems if the button
146 ;; changes the buffer (e.g., id: links) or moves point.
148 ;; This provides a button type which overrides mouse-action so that
149 ;; the button's window is selected before the action is run. Other
150 ;; notmuch buttons can get the same behaviour by inheriting from this
152 (define-button-type 'notmuch-button-type
153 'mouse-action (lambda (button)
154 (select-window (posn-window (event-start last-input-event)))
155 (button-activate button)))
157 (defun notmuch-command-to-string (&rest args)
158 "Synchronously invoke \"notmuch\" with the given list of arguments.
160 If notmuch exits with a non-zero status, output from the process
161 will appear in a buffer named \"*Notmuch errors*\" and an error
164 Otherwise the output will be returned"
166 (let* ((status (apply #'call-process notmuch-command nil t nil args))
167 (output (buffer-string)))
168 (notmuch-check-exit-status status (cons notmuch-command args) output)
171 (defun notmuch-version ()
172 "Return a string with the notmuch version number."
174 ;; Trim off the trailing newline.
175 (substring (notmuch-command-to-string "--version") 0 -1)))
176 (if (string-match "^notmuch\\( version\\)? \\(.*\\)$"
178 (match-string 2 long-string)
181 (defun notmuch-config-get (item)
182 "Return a value from the notmuch configuration."
183 ;; Trim off the trailing newline
184 (substring (notmuch-command-to-string "config" "get" item) 0 -1))
186 (defun notmuch-database-path ()
187 "Return the database.path value from the notmuch configuration."
188 (notmuch-config-get "database.path"))
190 (defun notmuch-user-name ()
191 "Return the user.name value from the notmuch configuration."
192 (notmuch-config-get "user.name"))
194 (defun notmuch-user-primary-email ()
195 "Return the user.primary_email value from the notmuch configuration."
196 (notmuch-config-get "user.primary_email"))
198 (defun notmuch-user-other-email ()
199 "Return the user.other_email value (as a list) from the notmuch configuration."
200 (split-string (notmuch-config-get "user.other_email") "\n"))
202 (defun notmuch-poll ()
203 "Run \"notmuch new\" or an external script to import mail.
205 Invokes `notmuch-poll-script', \"notmuch new\", or does nothing
206 depending on the value of `notmuch-poll-script'."
208 (if (stringp notmuch-poll-script)
209 (unless (string= notmuch-poll-script "")
210 (call-process notmuch-poll-script nil nil))
211 (call-process notmuch-command nil nil nil "new")))
213 (defun notmuch-kill-this-buffer ()
214 "Kill the current buffer."
216 (kill-buffer (current-buffer)))
218 (defvar notmuch-buffer-refresh-function nil
219 "Function to call to refresh the current buffer.")
220 (make-variable-buffer-local 'notmuch-buffer-refresh-function)
222 (defun notmuch-refresh-this-buffer ()
223 "Refresh the current buffer."
225 (when notmuch-buffer-refresh-function
226 (if (commandp notmuch-buffer-refresh-function)
227 ;; Pass prefix argument, etc.
228 (call-interactively notmuch-buffer-refresh-function)
229 (funcall notmuch-buffer-refresh-function))))
231 (defun notmuch-poll-and-refresh-this-buffer ()
232 "Invoke `notmuch-poll' to import mail, then refresh the current buffer."
235 (notmuch-refresh-this-buffer))
237 (defun notmuch-prettify-subject (subject)
238 ;; This function is used by `notmuch-search-process-filter' which
239 ;; requires that we not disrupt its' matching state.
242 (string-match "^[ \t]*$" subject))
246 (defun notmuch-sanitize (str)
247 "Sanitize control character in STR.
249 This includes newlines, tabs, and other funny characters."
250 (replace-regexp-in-string "[[:cntrl:]\x7f\u2028\u2029]+" " " str))
252 (defun notmuch-escape-boolean-term (term)
253 "Escape a boolean term for use in a query.
255 The caller is responsible for prepending the term prefix and a
256 colon. This performs minimal escaping in order to produce
257 user-friendly queries."
260 (if (or (equal term "")
261 (string-match "[ ()]\\|^\"" term))
263 (concat "\"" (replace-regexp-in-string "\"" "\"\"" term t t) "\"")
266 (defun notmuch-id-to-query (id)
267 "Return a query that matches the message with id ID."
268 (concat "id:" (notmuch-escape-boolean-term id)))
272 (defun notmuch-common-do-stash (text)
273 "Common function to stash text in kill ring, and display in minibuffer."
277 (message "Stashed: %s" text))
278 ;; There is nothing to stash so stash an empty string so the user
279 ;; doesn't accidentally paste something else somewhere.
281 (message "Nothing to stash!")))
285 (defun notmuch-remove-if-not (predicate list)
286 "Return a copy of LIST with all items not satisfying PREDICATE removed."
289 (when (funcall predicate (car list))
290 (push (car list) out))
291 (setq list (cdr list)))
294 (defun notmuch-split-content-type (content-type)
295 "Split content/type into 'content' and 'type'"
296 (split-string content-type "/"))
298 (defun notmuch-match-content-type (t1 t2)
299 "Return t if t1 and t2 are matching content types, taking wildcards into account"
300 (let ((st1 (notmuch-split-content-type t1))
301 (st2 (notmuch-split-content-type t2)))
302 (if (or (string= (cadr st1) "*")
303 (string= (cadr st2) "*"))
304 ;; Comparison of content types should be case insensitive.
305 (string= (downcase (car st1)) (downcase (car st2)))
306 (string= (downcase t1) (downcase t2)))))
308 (defvar notmuch-multipart/alternative-discouraged
312 ;; multipart/related usually contain a text/html part and some associated graphics.
316 (defun notmuch-multipart/alternative-choose (types)
317 "Return a list of preferred types from the given list of types"
318 ;; Based on `mm-preferred-alternative-precedence'.
320 (dolist (pref (reverse notmuch-multipart/alternative-discouraged))
321 (dolist (elem (copy-sequence seq))
322 (when (string-match pref elem)
323 (setq seq (nconc (delete elem seq) (list elem))))))
326 (defun notmuch-parts-filter-by-type (parts type)
327 "Given a list of message parts, return a list containing the ones matching
330 (lambda (part) (notmuch-match-content-type (plist-get part :content-type) type))
333 ;; Helper for parts which are generally not included in the default
335 (defun notmuch-get-bodypart-internal (query part-number process-crypto)
336 (let ((args '("show" "--format=raw"))
337 (part-arg (format "--part=%s" part-number)))
338 (setq args (append args (list part-arg)))
340 (setq args (append args '("--decrypt"))))
341 (setq args (append args (list query)))
343 (let ((coding-system-for-read 'no-conversion))
345 (apply 'call-process (append (list notmuch-command nil (list t nil) nil) args))
348 (defun notmuch-get-bodypart-content (msg part nth process-crypto)
349 (or (plist-get part :content)
350 (notmuch-get-bodypart-internal (notmuch-id-to-query (plist-get msg :id)) nth process-crypto)))
352 ;; Workaround: The call to `mm-display-part' below triggers a bug in
353 ;; Emacs 24 if it attempts to use the shr renderer to display an HTML
354 ;; part with images in it (demonstrated in 24.1 and 24.2 on Debian and
355 ;; Fedora 17, though unreproducable in other configurations).
356 ;; `mm-shr' references the variable `gnus-inhibit-images' without
357 ;; first loading gnus-art, which defines it, resulting in a
358 ;; void-variable error. Hence, we advise `mm-shr' to ensure gnus-art
360 (if (>= emacs-major-version 24)
361 (defadvice mm-shr (before load-gnus-arts activate)
362 (require 'gnus-art nil t)
363 (ad-disable-advice 'mm-shr 'before 'load-gnus-arts)))
365 (defun notmuch-mm-display-part-inline (msg part nth content-type process-crypto)
366 "Use the mm-decode/mm-view functions to display a part in the
367 current buffer, if possible."
368 (let ((display-buffer (current-buffer)))
370 ;; In case there is :content, the content string is already converted
371 ;; into emacs internal format. `gnus-decoded' is a fake charset,
372 ;; which means no further decoding (to be done by mm- functions).
373 (let* ((charset (if (plist-member part :content)
375 (plist-get part :content-charset)))
376 (handle (mm-make-handle (current-buffer) `(,content-type (charset . ,charset)))))
377 ;; If the user wants the part inlined, insert the content and
378 ;; test whether we are able to inline it (which includes both
379 ;; capability and suitability tests).
380 (when (mm-inlined-p handle)
381 (insert (notmuch-get-bodypart-content msg part nth process-crypto))
382 (when (mm-inlinable-p handle)
383 (set-buffer display-buffer)
384 (mm-display-part handle)
387 ;; Converts a plist of headers to an alist of headers. The input plist should
388 ;; have symbols of the form :Header as keys, and the resulting alist will have
389 ;; symbols of the form 'Header as keys.
390 (defun notmuch-headers-plist-to-alist (plist)
391 (loop for (key value . rest) on plist by #'cddr
392 collect (cons (intern (substring (symbol-name key) 1)) value)))
394 (defun notmuch-face-ensure-list-form (face)
395 "Return FACE in face list form.
397 If FACE is already a face list, it will be returned as-is. If
398 FACE is a face name or face plist, it will be returned as a
399 single element face list."
400 (if (and (listp face) (not (keywordp (car face))))
404 (defun notmuch-combine-face-text-property (start end face &optional below object)
405 "Combine FACE into the 'face text property between START and END.
407 This function combines FACE with any existing faces between START
408 and END in OBJECT (which defaults to the current buffer).
409 Attributes specified by FACE take precedence over existing
410 attributes unless BELOW is non-nil. FACE must be a face name (a
411 symbol or string), a property list of face attributes, or a list
412 of these. For convenience when applied to strings, this returns
415 ;; A face property can have three forms: a face name (a string or
416 ;; symbol), a property list, or a list of these two forms. In the
417 ;; list case, the faces will be combined, with the earlier faces
418 ;; taking precedent. Here we canonicalize everything to list form
419 ;; to make it easy to combine.
421 (face-list (notmuch-face-ensure-list-form face)))
423 (let* ((cur (get-text-property pos 'face object))
424 (cur-list (notmuch-face-ensure-list-form cur))
425 (new (cond ((null cur-list) face)
426 (below (append cur-list face-list))
427 (t (append face-list cur-list))))
428 (next (next-single-property-change pos 'face object end)))
429 (put-text-property pos next 'face new object)
433 (defun notmuch-combine-face-text-property-string (string face &optional below)
434 (notmuch-combine-face-text-property
441 (defun notmuch-map-text-property (start end prop func &optional object)
442 "Transform text property PROP using FUNC.
444 Applies FUNC to each distinct value of the text property PROP
445 between START and END of OBJECT, setting PROP to the value
448 (let ((value (get-text-property start prop object))
449 (next (next-single-property-change start prop object end)))
450 (put-text-property start next prop (funcall func value) object)
453 (defun notmuch-logged-error (msg &optional extra)
454 "Log MSG and EXTRA to *Notmuch errors* and signal MSG.
456 This logs MSG and EXTRA to the *Notmuch errors* buffer and
457 signals MSG as an error. If EXTRA is non-nil, text referring the
458 user to the *Notmuch errors* buffer will be appended to the
459 signaled error. This function does not return."
461 (with-current-buffer (get-buffer-create "*Notmuch errors*")
462 (goto-char (point-max))
466 (insert "[" (current-time-string) "]\n" msg)
473 (error "%s" (concat msg (when extra
474 " (see *Notmuch errors* for more details)"))))
476 (defun notmuch-check-async-exit-status (proc msg &optional command err-file)
477 "If PROC exited abnormally, pop up an error buffer and signal an error.
479 This is a wrapper around `notmuch-check-exit-status' for
480 asynchronous process sentinels. PROC and MSG must be the
481 arguments passed to the sentinel. COMMAND and ERR-FILE, if
482 provided, are passed to `notmuch-check-exit-status'. If COMMAND
483 is not provided, it is taken from `process-command'."
485 (case (process-status proc)
486 ((exit) (process-exit-status proc))
489 (notmuch-check-exit-status exit-status (or command (process-command proc))
492 (defun notmuch-check-exit-status (exit-status command &optional output err-file)
493 "If EXIT-STATUS is non-zero, pop up an error buffer and signal an error.
495 If EXIT-STATUS is non-zero, pop up a notmuch error buffer
496 describing the error and signal an Elisp error. EXIT-STATUS must
497 be a number indicating the exit status code of a process or a
498 string describing the signal that terminated the process (such as
499 returned by `call-process'). COMMAND must be a list giving the
500 command and its arguments. OUTPUT, if provided, is a string
501 giving the output of command. ERR-FILE, if provided, is the name
502 of a file containing the error output of command. OUTPUT and the
503 contents of ERR-FILE will be included in the error message."
506 ((eq exit-status 0) t)
508 (notmuch-logged-error "notmuch CLI version mismatch
509 Emacs requested an older output format than supported by the notmuch CLI.
510 You may need to restart Emacs or upgrade your notmuch Emacs package."))
512 (notmuch-logged-error "notmuch CLI version mismatch
513 Emacs requested a newer output format than supported by the notmuch CLI.
514 You may need to restart Emacs or upgrade your notmuch package."))
516 (let* ((err (when err-file
518 (insert-file-contents err-file)
523 "command: " (mapconcat #'shell-quote-argument command " ") "\n"
524 (if (integerp exit-status)
525 (format "exit status: %s\n" exit-status)
526 (format "exit signal: %s\n" exit-status))
528 (concat "stderr:\n" err))
530 (concat "stdout:\n" output)))))
532 ;; We have an error message straight from the CLI.
533 (notmuch-logged-error
534 (replace-regexp-in-string "[ \n\r\t\f]*\\'" "" err) extra)
535 ;; We only have combined output from the CLI; don't inundate
536 ;; the user with it. Mimic `process-lines'.
537 (notmuch-logged-error (format "%s exited with status %s"
538 (car command) exit-status)
540 ;; `notmuch-logged-error' does not return.
543 (defun notmuch-call-notmuch-sexp (&rest args)
544 "Invoke `notmuch-command' with ARGS and return the parsed S-exp output.
546 If notmuch exits with a non-zero status, this will pop up a
547 buffer containing notmuch's output and signal an error."
550 (let ((err-file (make-temp-file "nmerr")))
552 (let ((status (apply #'call-process
553 notmuch-command nil (list t err-file) nil args)))
554 (notmuch-check-exit-status status (cons notmuch-command args)
555 (buffer-string) err-file)
556 (goto-char (point-min))
557 (read (current-buffer)))
558 (delete-file err-file)))))
560 (defun notmuch-start-notmuch (name buffer sentinel &rest args)
561 "Start and return an asynchronous notmuch command.
563 This starts and returns an asynchronous process running
564 `notmuch-command' with ARGS. The exit status is checked via
565 `notmuch-check-async-exit-status'. Output written to stderr is
566 redirected and displayed when the process exits (even if the
567 process exits successfully). NAME and BUFFER are the same as in
568 `start-process'. SENTINEL is a process sentinel function to call
569 when the process exits, or nil for none. The caller must *not*
570 invoke `set-process-sentinel' directly on the returned process,
571 as that will interfere with the handling of stderr and the exit
574 ;; There is no way (as of Emacs 24.3) to capture stdout and stderr
575 ;; separately for asynchronous processes, or even to redirect stderr
576 ;; to a file, so we use a trivial shell wrapper to send stderr to a
577 ;; temporary file and clean things up in the sentinel.
578 (let* ((err-file (make-temp-file "nmerr"))
580 (process-connection-type nil)
581 ;; Find notmuch using Emacs' `exec-path'
582 (command (or (executable-find notmuch-command)
583 (error "command not found: %s" notmuch-command)))
584 (proc (apply #'start-process name buffer
586 "exec 2>\"$1\"; shift; exec \"$0\" \"$@\""
587 command err-file args)))
588 (process-put proc 'err-file err-file)
589 (process-put proc 'sub-sentinel sentinel)
590 (process-put proc 'real-command (cons notmuch-command args))
591 (set-process-sentinel proc #'notmuch-start-notmuch-sentinel)
594 (defun notmuch-start-notmuch-sentinel (proc event)
595 (let ((err-file (process-get proc 'err-file))
596 (sub-sentinel (process-get proc 'sub-sentinel))
597 (real-command (process-get proc 'real-command)))
600 ;; Invoke the sub-sentinel, if any
602 (funcall sub-sentinel proc event))
603 ;; Check the exit status. This will signal an error if the
604 ;; exit status is non-zero. Don't do this if the process
605 ;; buffer is dead since that means Emacs killed the process
606 ;; and there's no point in telling the user that (but we
607 ;; still check for and report stderr output below).
608 (when (buffer-live-p (process-buffer proc))
609 (notmuch-check-async-exit-status proc event real-command err-file))
610 ;; If that didn't signal an error, then any error output was
611 ;; really warning output. Show warnings, if any.
614 (unless (= (second (insert-file-contents err-file)) 0)
616 ;; Show first line; stuff remaining lines in the
618 (let ((l1 (buffer-substring (point-min) (point))))
619 (skip-chars-forward "\n")
620 (cons l1 (unless (eobp)
621 (buffer-substring (point) (point-max)))))))))
623 (notmuch-logged-error (car warnings) (cdr warnings)))))
625 ;; Emacs behaves strangely if an error escapes from a sentinel,
626 ;; so turn errors into messages.
627 (message "%s" (error-message-string err))))
628 (ignore-errors (delete-file err-file))))
630 ;; This variable is used only buffer local, but it needs to be
631 ;; declared globally first to avoid compiler warnings.
632 (defvar notmuch-show-process-crypto nil)
633 (make-variable-buffer-local 'notmuch-show-process-crypto)
635 (provide 'notmuch-lib)
638 ;; byte-compile-warnings: (not cl-functions)