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.
29 (defvar notmuch-command "notmuch"
30 "Command to run the notmuch binary.")
33 "Notmuch mail reader for Emacs."
36 (defgroup notmuch-hello nil
37 "Overview of saved searches, tags, etc."
40 (defgroup notmuch-search nil
41 "Searching and sorting mail."
44 (defgroup notmuch-show nil
45 "Showing messages and threads."
48 (defgroup notmuch-send nil
49 "Sending messages from Notmuch."
52 (custom-add-to-group 'notmuch-send 'message 'custom-group)
54 (defgroup notmuch-crypto nil
55 "Processing and display of cryptographic MIME parts."
58 (defgroup notmuch-hooks nil
59 "Running custom code on well-defined occasions."
62 (defgroup notmuch-external nil
63 "Running external commands from within Notmuch."
66 (defgroup notmuch-faces nil
67 "Graphical attributes for displaying text"
70 (defcustom notmuch-search-oldest-first t
71 "Show the oldest mail first when searching."
73 :group 'notmuch-search)
77 (defvar notmuch-search-history nil
78 "Variable to store notmuch searches history.")
80 (defcustom notmuch-saved-searches '(("inbox" . "tag:inbox")
81 ("unread" . "tag:unread"))
82 "A list of saved searches to display."
83 :type '(alist :key-type string :value-type string)
84 :group 'notmuch-hello)
86 (defcustom notmuch-archive-tags '("-inbox")
87 "List of tag changes to apply to a message or a thread when it is archived.
89 Tags starting with \"+\" (or not starting with either \"+\" or
90 \"-\") in the list will be added, and tags starting with \"-\"
91 will be removed from the message or thread being archived.
93 For example, if you wanted to remove an \"inbox\" tag and add an
94 \"archived\" tag, you would set:
95 (\"-inbox\" \"+archived\")"
96 :type '(repeat string)
97 :group 'notmuch-search
100 (defun notmuch-version ()
101 "Return a string with the notmuch version number."
103 ;; Trim off the trailing newline.
104 (substring (shell-command-to-string
105 (concat notmuch-command " --version"))
107 (if (string-match "^notmuch\\( version\\)? \\(.*\\)$"
109 (match-string 2 long-string)
112 (defun notmuch-config-get (item)
113 "Return a value from the notmuch configuration."
114 ;; Trim off the trailing newline
115 (substring (shell-command-to-string
116 (concat notmuch-command " config get " item))
119 (defun notmuch-database-path ()
120 "Return the database.path value from the notmuch configuration."
121 (notmuch-config-get "database.path"))
123 (defun notmuch-user-name ()
124 "Return the user.name value from the notmuch configuration."
125 (notmuch-config-get "user.name"))
127 (defun notmuch-user-primary-email ()
128 "Return the user.primary_email value from the notmuch configuration."
129 (notmuch-config-get "user.primary_email"))
131 (defun notmuch-user-other-email ()
132 "Return the user.other_email value (as a list) from the notmuch configuration."
133 (split-string (notmuch-config-get "user.other_email") "\n"))
135 (defun notmuch-kill-this-buffer ()
136 "Kill the current buffer."
138 (kill-buffer (current-buffer)))
140 (defun notmuch-prettify-subject (subject)
141 ;; This function is used by `notmuch-search-process-filter' which
142 ;; requires that we not disrupt its' matching state.
145 (string-match "^[ \t]*$" subject))
149 (defun notmuch-escape-boolean-term (term)
150 "Escape a boolean term for use in a query.
152 The caller is responsible for prepending the term prefix and a
153 colon. This performs minimal escaping in order to produce
154 user-friendly queries."
157 (if (or (equal term "")
158 (string-match "[ ()]\\|^\"" term))
160 (concat "\"" (replace-regexp-in-string "\"" "\"\"" term t t) "\"")
163 (defun notmuch-id-to-query (id)
164 "Return a query that matches the message with id ID."
165 (concat "id:" (notmuch-escape-boolean-term id)))
169 (defun notmuch-common-do-stash (text)
170 "Common function to stash text in kill ring, and display in minibuffer."
174 (message "Stashed: %s" text))
175 ;; There is nothing to stash so stash an empty string so the user
176 ;; doesn't accidentally paste something else somewhere.
178 (message "Nothing to stash!")))
182 (defun notmuch-remove-if-not (predicate list)
183 "Return a copy of LIST with all items not satisfying PREDICATE removed."
186 (when (funcall predicate (car list))
187 (push (car list) out))
188 (setq list (cdr list)))
191 ;; This lets us avoid compiling these replacement functions when emacs
192 ;; is sufficiently new enough to supply them alone. We do the macro
193 ;; treatment rather than just wrapping our defun calls in a when form
194 ;; specifically so that the compiler never sees the code on new emacs,
195 ;; (since the code is triggering warnings that we don't know how to get
198 ;; A more clever macro here would accept a condition and a list of forms.
199 (defmacro compile-on-emacs-prior-to-23 (form)
200 "Conditionally evaluate form only on emacs < emacs-23."
201 (list 'when (< emacs-major-version 23)
204 (defun notmuch-split-content-type (content-type)
205 "Split content/type into 'content' and 'type'"
206 (split-string content-type "/"))
208 (defun notmuch-match-content-type (t1 t2)
209 "Return t if t1 and t2 are matching content types, taking wildcards into account"
210 (let ((st1 (notmuch-split-content-type t1))
211 (st2 (notmuch-split-content-type t2)))
212 (if (or (string= (cadr st1) "*")
213 (string= (cadr st2) "*"))
214 ;; Comparison of content types should be case insensitive.
215 (string= (downcase (car st1)) (downcase (car st2)))
216 (string= (downcase t1) (downcase t2)))))
218 (defvar notmuch-multipart/alternative-discouraged
222 ;; multipart/related usually contain a text/html part and some associated graphics.
226 (defun notmuch-multipart/alternative-choose (types)
227 "Return a list of preferred types from the given list of types"
228 ;; Based on `mm-preferred-alternative-precedence'.
230 (dolist (pref (reverse notmuch-multipart/alternative-discouraged))
231 (dolist (elem (copy-sequence seq))
232 (when (string-match pref elem)
233 (setq seq (nconc (delete elem seq) (list elem))))))
236 (defun notmuch-parts-filter-by-type (parts type)
237 "Given a list of message parts, return a list containing the ones matching
240 (lambda (part) (notmuch-match-content-type (plist-get part :content-type) type))
243 ;; Helper for parts which are generally not included in the default
245 (defun notmuch-get-bodypart-internal (query part-number process-crypto)
246 (let ((args '("show" "--format=raw"))
247 (part-arg (format "--part=%s" part-number)))
248 (setq args (append args (list part-arg)))
250 (setq args (append args '("--decrypt"))))
251 (setq args (append args (list query)))
253 (let ((coding-system-for-read 'no-conversion))
255 (apply 'call-process (append (list notmuch-command nil (list t nil) nil) args))
258 (defun notmuch-get-bodypart-content (msg part nth process-crypto)
259 (or (plist-get part :content)
260 (notmuch-get-bodypart-internal (notmuch-id-to-query (plist-get msg :id)) nth process-crypto)))
262 ;; Workaround: The call to `mm-display-part' below triggers a bug in
263 ;; Emacs 24 if it attempts to use the shr renderer to display an HTML
264 ;; part with images in it (demonstrated in 24.1 and 24.2 on Debian and
265 ;; Fedora 17, though unreproducable in other configurations).
266 ;; `mm-shr' references the variable `gnus-inhibit-images' without
267 ;; first loading gnus-art, which defines it, resulting in a
268 ;; void-variable error. Hence, we advise `mm-shr' to ensure gnus-art
270 (if (>= emacs-major-version 24)
271 (defadvice mm-shr (before load-gnus-arts activate)
272 (require 'gnus-art nil t)
273 (ad-disable-advice 'mm-shr 'before 'load-gnus-arts)))
275 (defun notmuch-mm-display-part-inline (msg part nth content-type process-crypto)
276 "Use the mm-decode/mm-view functions to display a part in the
277 current buffer, if possible."
278 (let ((display-buffer (current-buffer)))
280 ;; In case there is :content, the content string is already converted
281 ;; into emacs internal format. `gnus-decoded' is a fake charset,
282 ;; which means no further decoding (to be done by mm- functions).
283 (let* ((charset (if (plist-member part :content)
285 (plist-get part :content-charset)))
286 (handle (mm-make-handle (current-buffer) `(,content-type (charset . ,charset)))))
287 ;; If the user wants the part inlined, insert the content and
288 ;; test whether we are able to inline it (which includes both
289 ;; capability and suitability tests).
290 (when (mm-inlined-p handle)
291 (insert (notmuch-get-bodypart-content msg part nth process-crypto))
292 (when (mm-inlinable-p handle)
293 (set-buffer display-buffer)
294 (mm-display-part handle)
297 ;; Converts a plist of headers to an alist of headers. The input plist should
298 ;; have symbols of the form :Header as keys, and the resulting alist will have
299 ;; symbols of the form 'Header as keys.
300 (defun notmuch-headers-plist-to-alist (plist)
301 (loop for (key value . rest) on plist by #'cddr
302 collect (cons (intern (substring (symbol-name key) 1)) value)))
304 (defun notmuch-combine-face-text-property (start end face)
305 "Combine FACE into the 'face text property between START and END.
307 This function combines FACE with any existing faces between START
308 and END. Attributes specified by FACE take precedence over
309 existing attributes. FACE must be a face name (a symbol or
310 string), a property list of face attributes, or a list of these."
314 (let ((cur (get-text-property pos 'face))
315 (next (next-single-property-change pos 'face nil end)))
316 (put-text-property pos next 'face (cons face cur))
319 (defun notmuch-pop-up-error (msg)
320 "Pop up an error buffer displaying MSG.
322 This will accumulate error messages in the errors buffer until
323 the user dismisses it."
325 (let ((buf (get-buffer-create "*Notmuch errors*")))
326 (with-current-buffer buf
327 (view-mode-enter nil #'kill-buffer)
328 (let ((inhibit-read-only t))
329 (goto-char (point-max))
335 (pop-to-buffer buf)))
337 (defun notmuch-check-async-exit-status (proc msg)
338 "If PROC exited abnormally, pop up an error buffer and signal an error.
340 This is a wrapper around `notmuch-check-exit-status' for
341 asynchronous process sentinels. PROC and MSG must be the
342 arguments passed to the sentinel."
344 (case (process-status proc)
345 ((exit) (process-exit-status proc))
348 (notmuch-check-exit-status exit-status (process-command proc)))))
350 (defun notmuch-check-exit-status (exit-status command &optional output err-file)
351 "If EXIT-STATUS is non-zero, pop up an error buffer and signal an error.
353 If EXIT-STATUS is non-zero, pop up a notmuch error buffer
354 describing the error and signal an Elisp error. EXIT-STATUS must
355 be a number indicating the exit status code of a process or a
356 string describing the signal that terminated the process (such as
357 returned by `call-process'). COMMAND must be a list giving the
358 command and its arguments. OUTPUT, if provided, is a string
359 giving the output of command. ERR-FILE, if provided, is the name
360 of a file containing the error output of command. OUTPUT and the
361 contents of ERR-FILE will be included in the error message."
363 ;; This is implemented as a cond to make it easy to expand.
365 ((eq exit-status 0) t)
367 (notmuch-pop-up-error
369 (format "Error invoking notmuch. %s exited with %s%s.\n"
370 (mapconcat #'identity command " ")
371 ;; Signal strings look like "Terminated", hence the
373 (if (integerp exit-status) "status " "signal: ")
378 (insert-file-contents err-file)
380 "(no error output)\n"
382 (when (and output (not (equal output "")))
383 (format "Output:\n%s" output))))
384 ;; Mimic `process-lines'
385 (error "%s exited with status %s" (car command) exit-status))))
387 (defun notmuch-call-notmuch-json (&rest args)
388 "Invoke `notmuch-command' with `args' and return the parsed JSON output.
390 The returned output will represent objects using property lists
391 and arrays as lists. If notmuch exits with a non-zero status,
392 this will pop up a buffer containing notmuch's output and signal
396 (let ((err-file (make-temp-file "nmerr")))
398 (let ((status (apply #'call-process
399 notmuch-command nil (list t err-file) nil args)))
400 (notmuch-check-exit-status status (cons notmuch-command args)
401 (buffer-string) err-file)
402 (goto-char (point-min))
403 (let ((json-object-type 'plist)
404 (json-array-type 'list)
407 (delete-file err-file)))))
409 ;; Compatibility functions for versions of emacs before emacs 23.
411 ;; Both functions here were copied from emacs 23 with the following copyright:
413 ;; Copyright (C) 1985, 1986, 1992, 1994, 1995, 1999, 2000, 2001, 2002, 2003,
414 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
416 ;; and under the GPL version 3 (or later) exactly as notmuch itself.
417 (compile-on-emacs-prior-to-23
418 (defun apply-partially (fun &rest args)
419 "Return a function that is a partial application of FUN to ARGS.
420 ARGS is a list of the first N arguments to pass to FUN.
421 The result is a new function which does the same as FUN, except that
422 the first N arguments are fixed at the values with which this function
424 (lexical-let ((fun fun) (args1 args))
425 (lambda (&rest args2) (apply fun (append args1 args2))))))
427 (compile-on-emacs-prior-to-23
428 (defun mouse-event-p (object)
429 "Return non-nil if OBJECT is a mouse click event."
430 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement))))
432 ;; This variable is used only buffer local, but it needs to be
433 ;; declared globally first to avoid compiler warnings.
434 (defvar notmuch-show-process-crypto nil)
435 (make-variable-buffer-local 'notmuch-show-process-crypto)
437 ;; Incremental JSON parsing
439 ;; These two variables are internal variables to the parsing
440 ;; routines. They are always used buffer local but need to be declared
441 ;; globally to avoid compiler warnings.
443 (defvar notmuch-json-parser nil
444 "Internal incremental JSON parser object: local to the buffer being parsed.")
446 (defvar notmuch-json-state nil
447 "State of the internal JSON parser: local to the buffer being parsed.")
449 (defun notmuch-json-create-parser (buffer)
450 "Return a streaming JSON parser that consumes input from BUFFER.
452 This parser is designed to read streaming JSON whose structure is
453 known to the caller. Like a typical JSON parsing interface, it
454 provides a function to read a complete JSON value from the input.
455 However, it extends this with an additional function that
456 requires the next value in the input to be a compound value and
457 descends into it, allowing its elements to be read one at a time
458 or further descended into. Both functions can return 'retry to
459 indicate that not enough input is available.
461 The parser always consumes input from BUFFER's point. Hence, the
462 caller is allowed to delete and data before point and may
463 resynchronize after an error by moving point."
466 ;; Terminator stack: a stack of characters that indicate the
467 ;; end of the compound values enclosing point
470 ;; * 'expect-value if the next token must be a value, but a
471 ;; value has not yet been reached
472 ;; * 'value if point is at the beginning of a value
473 ;; * 'expect-comma if the next token must be a comma
475 ;; Allow terminator: non-nil if the next token may be a
478 ;; Partial parse position: If state is 'value, a marker for
479 ;; the position of the partial parser or nil if no partial
480 ;; parsing has happened yet
482 ;; Partial parse state: If state is 'value, the current
483 ;; `parse-partial-sexp' state
486 (defmacro notmuch-json-buffer (jp) `(first ,jp))
487 (defmacro notmuch-json-term-stack (jp) `(second ,jp))
488 (defmacro notmuch-json-next (jp) `(third ,jp))
489 (defmacro notmuch-json-allow-term (jp) `(fourth ,jp))
490 (defmacro notmuch-json-partial-pos (jp) `(fifth ,jp))
491 (defmacro notmuch-json-partial-state (jp) `(sixth ,jp))
493 (defvar notmuch-json-syntax-table
494 (let ((table (make-syntax-table)))
495 ;; The standard syntax table is what we need except that "." needs
496 ;; to have word syntax instead of punctuation syntax.
497 (modify-syntax-entry ?. "w" table)
499 "Syntax table used for incremental JSON parsing.")
501 (defun notmuch-json-scan-to-value (jp)
502 ;; Helper function that consumes separators, terminators, and
503 ;; whitespace from point. Returns nil if it successfully reached
504 ;; the beginning of a value, 'end if it consumed a terminator, or
505 ;; 'retry if not enough input was available to reach a value. Upon
506 ;; nil return, (notmuch-json-next jp) is always 'value.
508 (if (eq (notmuch-json-next jp) 'value)
509 ;; We're already at a value
511 ;; Drive the state toward 'expect-value
512 (skip-chars-forward " \t\r\n")
513 (or (when (eobp) 'retry)
514 ;; Test for the terminator for the current compound
515 (when (and (notmuch-json-allow-term jp)
516 (eq (char-after) (car (notmuch-json-term-stack jp))))
517 ;; Consume it and expect a comma or terminator next
519 (setf (notmuch-json-term-stack jp) (cdr (notmuch-json-term-stack jp))
520 (notmuch-json-next jp) 'expect-comma
521 (notmuch-json-allow-term jp) t)
523 ;; Test for a separator
524 (when (eq (notmuch-json-next jp) 'expect-comma)
525 (when (/= (char-after) ?,)
526 (signal 'json-readtable-error (list "expected ','")))
527 ;; Consume it, switch to 'expect-value, and disallow a
530 (skip-chars-forward " \t\r\n")
531 (setf (notmuch-json-next jp) 'expect-value
532 (notmuch-json-allow-term jp) nil)
533 ;; We moved point, so test for eobp again and fall through
534 ;; to the next test if there's more input
535 (when (eobp) 'retry))
536 ;; Next must be 'expect-value and we know this isn't
537 ;; whitespace, EOB, or a terminator, so point must be on a
540 (assert (eq (notmuch-json-next jp) 'expect-value))
541 (setf (notmuch-json-next jp) 'value)
544 (defun notmuch-json-begin-compound (jp)
545 "Parse the beginning of a compound value and traverse inside it.
547 Returns 'retry if there is insufficient input to parse the
548 beginning of the compound. If this is able to parse the
549 beginning of a compound, it moves point past the token that opens
550 the compound and returns t. Later calls to `notmuch-json-read'
551 will return the compound's elements.
553 Entering JSON objects is currently unimplemented."
555 (with-current-buffer (notmuch-json-buffer jp)
556 ;; Disallow terminators
557 (setf (notmuch-json-allow-term jp) nil)
558 ;; Save "next" so we can restore it if there's a syntax error
559 (let ((saved-next (notmuch-json-next jp)))
560 (or (notmuch-json-scan-to-value jp)
561 (if (/= (char-after) ?\[)
563 (setf (notmuch-json-next jp) saved-next)
564 (signal 'json-readtable-error (list "expected '['")))
566 (push ?\] (notmuch-json-term-stack jp))
567 ;; Expect a value or terminator next
568 (setf (notmuch-json-next jp) 'expect-value
569 (notmuch-json-allow-term jp) t)
572 (defun notmuch-json-read (jp)
573 "Parse the value at point in JP's buffer.
575 Returns 'retry if there is insufficient input to parse a complete
576 JSON value (though it may still move point over separators or
577 whitespace). If the parser is currently inside a compound value
578 and the next token ends the list or object, this moves point just
579 past the terminator and returns 'end. Otherwise, this moves
580 point to just past the end of the value and returns the value."
582 (with-current-buffer (notmuch-json-buffer jp)
584 ;; Get to a value state
585 (notmuch-json-scan-to-value jp)
587 ;; Can we parse a complete value?
589 (if (looking-at "[-+0-9tfn]")
590 ;; This is a number or a keyword, so the partial
591 ;; parser isn't going to help us because a truncated
592 ;; number or keyword looks like a complete symbol to
593 ;; it. Look for something that clearly ends it.
595 (skip-chars-forward "^]},: \t\r\n")
598 ;; We're looking at a string, object, or array, which we
599 ;; can partial parse. If we just reached the value, set
600 ;; up the partial parser.
601 (when (null (notmuch-json-partial-state jp))
602 (setf (notmuch-json-partial-pos jp) (point-marker)))
604 ;; Extend the partial parse until we either reach EOB or
605 ;; get the whole value
608 (with-syntax-table notmuch-json-syntax-table
610 (notmuch-json-partial-pos jp) (point-max) 0 nil
611 (notmuch-json-partial-state jp)))))
612 ;; A complete value is available if we've reached
613 ;; depth 0 or less and encountered a complete
615 (if (and (<= (first pstate) 0) (third pstate))
617 ;; Not complete. Update the partial parser state
618 (setf (notmuch-json-partial-pos jp) (point-marker)
619 (notmuch-json-partial-state jp) pstate)
624 ;; We have a value. Reset the partial parse state and expect
625 ;; a comma or terminator after the value.
626 (setf (notmuch-json-next jp) 'expect-comma
627 (notmuch-json-allow-term jp) t
628 (notmuch-json-partial-pos jp) nil
629 (notmuch-json-partial-state jp) nil)
631 (let ((json-object-type 'plist)
632 (json-array-type 'list)
636 (defun notmuch-json-eof (jp)
637 "Signal a json-error if there is more data in JP's buffer.
639 Moves point to the beginning of any trailing data or to the end
640 of the buffer if there is only trailing whitespace."
642 (with-current-buffer (notmuch-json-buffer jp)
643 (skip-chars-forward " \t\r\n")
645 (signal 'json-error (list "Trailing garbage following JSON data")))))
647 (defun notmuch-json-parse-partial-list (result-function error-function results-buf)
648 "Parse a partial JSON list from current buffer.
650 This function consumes a JSON list from the current buffer,
651 applying RESULT-FUNCTION in buffer RESULT-BUFFER to each complete
652 value in the list. It operates incrementally and should be
653 called whenever the buffer has been extended with additional
656 If there is a syntax error, this will attempt to resynchronize
657 with the input and will apply ERROR-FUNCTION in buffer
658 RESULT-BUFFER to any input that was skipped.
660 It sets up all the needed internal variables: the caller just
661 needs to call it with point in the same place that the parser
664 (unless (local-variable-p 'notmuch-json-parser)
665 (set (make-local-variable 'notmuch-json-parser)
666 (notmuch-json-create-parser (current-buffer)))
667 (set (make-local-variable 'notmuch-json-state) 'begin))
670 (case notmuch-json-state
672 ;; Enter the results list
673 (if (eq (notmuch-json-begin-compound
674 notmuch-json-parser) 'retry)
676 (setq notmuch-json-state 'result)))
679 (let ((result (notmuch-json-read notmuch-json-parser)))
681 ((retry) (setq done t))
682 ((end) (setq notmuch-json-state 'end))
683 (otherwise (with-current-buffer results-buf
684 (funcall result-function result))))))
686 ;; Any trailing data is unexpected
687 (notmuch-json-eof notmuch-json-parser)
690 ;; Do our best to resynchronize and ensure forward
692 (let ((bad (buffer-substring (line-beginning-position)
693 (line-end-position))))
695 (with-current-buffer results-buf
696 (funcall error-function "%s" bad))))))
697 ;; Clear out what we've parsed
698 (delete-region (point-min) (point))))
703 (provide 'notmuch-lib)
706 ;; byte-compile-warnings: (not cl-functions)