1c43d3ee19358fd9e891c53c9c60d3c6e818af4e
[notmuch] / emacs / notmuch.el
1 ;; notmuch.el --- run notmuch within emacs
2 ;;
3 ;; Copyright © Carl Worth
4 ;;
5 ;; This file is part of Notmuch.
6 ;;
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.
11 ;;
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.
16 ;;
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/>.
19 ;;
20 ;; Authors: Carl Worth <cworth@cworth.org>
21
22 ;; This is an emacs-based interface to the notmuch mail system.
23 ;;
24 ;; You will first need to have the notmuch program installed and have a
25 ;; notmuch database built in order to use this. See
26 ;; http://notmuchmail.org for details.
27 ;;
28 ;; To install this software, copy it to a directory that is on the
29 ;; `load-path' variable within emacs (a good candidate is
30 ;; /usr/local/share/emacs/site-lisp). If you are viewing this from the
31 ;; notmuch source distribution then you can simply run:
32 ;;
33 ;;      sudo make install-emacs
34 ;;
35 ;; to install it.
36 ;;
37 ;; Then, to actually run it, add:
38 ;;
39 ;;      (require 'notmuch)
40 ;;
41 ;; to your ~/.emacs file, and then run "M-x notmuch" from within emacs,
42 ;; or run:
43 ;;
44 ;;      emacs -f notmuch
45 ;;
46 ;; Have fun, and let us know if you have any comment, questions, or
47 ;; kudos: Notmuch list <notmuch@notmuchmail.org> (subscription is not
48 ;; required, but is available from http://notmuchmail.org).
49
50 (eval-when-compile (require 'cl))
51 (require 'mm-view)
52 (require 'message)
53
54 (require 'notmuch-lib)
55 (require 'notmuch-tag)
56 (require 'notmuch-show)
57 (require 'notmuch-mua)
58 (require 'notmuch-hello)
59 (require 'notmuch-maildir-fcc)
60 (require 'notmuch-message)
61
62 (defcustom notmuch-search-result-format
63   `(("date" . "%12s ")
64     ("count" . "%-7s ")
65     ("authors" . "%-20s ")
66     ("subject" . "%s ")
67     ("tags" . "(%s)"))
68   "Search result formatting. Supported fields are:
69         date, count, authors, subject, tags
70 For example:
71         (setq notmuch-search-result-format \(\(\"authors\" . \"%-40s\"\)
72                                              \(\"subject\" . \"%s\"\)\)\)
73 Line breaks are permitted in format strings (though this is
74 currently experimental).  Note that a line break at the end of an
75 \"authors\" field will get elided if the authors list is long;
76 place it instead at the beginning of the following field.  To
77 enter a line break when setting this variable with setq, use \\n.
78 To enter a line break in customize, press \\[quoted-insert] C-j."
79   :type '(alist :key-type (string) :value-type (string))
80   :group 'notmuch-search)
81
82 (defvar notmuch-query-history nil
83   "Variable to store minibuffer history for notmuch queries")
84
85 (defun notmuch-foreach-mime-part (function mm-handle)
86   (cond ((stringp (car mm-handle))
87          (dolist (part (cdr mm-handle))
88            (notmuch-foreach-mime-part function part)))
89         ((bufferp (car mm-handle))
90          (funcall function mm-handle))
91         (t (dolist (part mm-handle)
92              (notmuch-foreach-mime-part function part)))))
93
94 (defun notmuch-count-attachments (mm-handle)
95   (let ((count 0))
96     (notmuch-foreach-mime-part
97      (lambda (p)
98        (let ((disposition (mm-handle-disposition p)))
99          (and (listp disposition)
100               (or (equal (car disposition) "attachment")
101                   (and (equal (car disposition) "inline")
102                        (assq 'filename disposition)))
103               (incf count))))
104      mm-handle)
105     count))
106
107 (defun notmuch-save-attachments (mm-handle &optional queryp)
108   (notmuch-foreach-mime-part
109    (lambda (p)
110      (let ((disposition (mm-handle-disposition p)))
111        (and (listp disposition)
112             (or (equal (car disposition) "attachment")
113                 (and (equal (car disposition) "inline")
114                      (assq 'filename disposition)))
115             (or (not queryp)
116                 (y-or-n-p
117                  (concat "Save '" (cdr (assq 'filename disposition)) "' ")))
118             (mm-save-part p))))
119    mm-handle))
120
121 (defun notmuch-documentation-first-line (symbol)
122   "Return the first line of the documentation string for SYMBOL."
123   (let ((doc (documentation symbol)))
124     (if doc
125         (with-temp-buffer
126           (insert (documentation symbol t))
127           (goto-char (point-min))
128           (let ((beg (point)))
129             (end-of-line)
130             (buffer-substring beg (point))))
131       "")))
132
133 (defun notmuch-prefix-key-description (key)
134   "Given a prefix key code, return a human-readable string representation.
135
136 This is basically just `format-kbd-macro' but we also convert ESC to M-."
137   (let ((desc (format-kbd-macro (vector key))))
138     (if (string= desc "ESC")
139         "M-"
140       (concat desc " "))))
141
142 ;; I would think that emacs would have code handy for walking a keymap
143 ;; and generating strings for each key, and I would prefer to just call
144 ;; that. But I couldn't find any (could be all implemented in C I
145 ;; suppose), so I wrote my own here.
146 (defun notmuch-substitute-one-command-key-with-prefix (prefix binding)
147   "For a key binding, return a string showing a human-readable
148 representation of the prefixed key as well as the first line of
149 documentation from the bound function.
150
151 For a mouse binding, return nil."
152   (let ((key (car binding))
153         (action (cdr binding)))
154     (if (mouse-event-p key)
155         nil
156       (if (keymapp action)
157           (let ((substitute (apply-partially 'notmuch-substitute-one-command-key-with-prefix (notmuch-prefix-key-description key)))
158                 (as-list))
159             (map-keymap (lambda (a b)
160                           (push (cons a b) as-list))
161                         action)
162             (mapconcat substitute as-list "\n"))
163         (concat prefix (format-kbd-macro (vector key))
164                 "\t"
165                 (notmuch-documentation-first-line action))))))
166
167 (defun notmuch-substitute-command-keys-one (key)
168   ;; A `keymap' key indicates inheritance from a parent keymap - the
169   ;; inherited mappings follow, so there is nothing to print for
170   ;; `keymap' itself.
171   (when (not (eq key 'keymap))
172     (notmuch-substitute-one-command-key-with-prefix nil key)))
173
174 (defun notmuch-substitute-command-keys (doc)
175   "Like `substitute-command-keys' but with documentation, not function names."
176   (let ((beg 0))
177     (while (string-match "\\\\{\\([^}[:space:]]*\\)}" doc beg)
178       (let* ((keymap-name (substring doc (match-beginning 1) (match-end 1)))
179              (keymap (symbol-value (intern keymap-name))))
180         (setq doc (replace-match
181                    (mapconcat #'notmuch-substitute-command-keys-one
182                               (cdr keymap) "\n")
183                    1 1 doc)))
184       (setq beg (match-end 0)))
185     doc))
186
187 (defun notmuch-help ()
188   "Display help for the current notmuch mode."
189   (interactive)
190   (let* ((mode major-mode)
191          (doc (substitute-command-keys (notmuch-substitute-command-keys (documentation mode t)))))
192     (with-current-buffer (generate-new-buffer "*notmuch-help*")
193       (insert doc)
194       (goto-char (point-min))
195       (set-buffer-modified-p nil)
196       (view-buffer (current-buffer) 'kill-buffer-if-not-modified))))
197
198 (require 'hl-line)
199
200 (defun notmuch-hl-line-mode ()
201   (prog1 (hl-line-mode)
202     (when hl-line-overlay
203       (overlay-put hl-line-overlay 'priority 1))))
204
205 (defcustom notmuch-search-hook '(notmuch-hl-line-mode)
206   "List of functions to call when notmuch displays the search results."
207   :type 'hook
208   :options '(notmuch-hl-line-mode)
209   :group 'notmuch-search
210   :group 'notmuch-hooks)
211
212 (defvar notmuch-search-mode-map
213   (let ((map (make-sparse-keymap)))
214     (define-key map "?" 'notmuch-help)
215     (define-key map "q" 'notmuch-search-quit)
216     (define-key map "x" 'notmuch-search-quit)
217     (define-key map (kbd "<DEL>") 'notmuch-search-scroll-down)
218     (define-key map "b" 'notmuch-search-scroll-down)
219     (define-key map " " 'notmuch-search-scroll-up)
220     (define-key map "<" 'notmuch-search-first-thread)
221     (define-key map ">" 'notmuch-search-last-thread)
222     (define-key map "p" 'notmuch-search-previous-thread)
223     (define-key map "n" 'notmuch-search-next-thread)
224     (define-key map "r" 'notmuch-search-reply-to-thread-sender)
225     (define-key map "R" 'notmuch-search-reply-to-thread)
226     (define-key map "m" 'notmuch-mua-new-mail)
227     (define-key map "s" 'notmuch-search)
228     (define-key map "o" 'notmuch-search-toggle-order)
229     (define-key map "c" 'notmuch-search-stash-map)
230     (define-key map "=" 'notmuch-search-refresh-view)
231     (define-key map "G" 'notmuch-search-poll-and-refresh-view)
232     (define-key map "t" 'notmuch-search-filter-by-tag)
233     (define-key map "f" 'notmuch-search-filter)
234     (define-key map [mouse-1] 'notmuch-search-show-thread)
235     (define-key map "*" 'notmuch-search-tag-all)
236     (define-key map "a" 'notmuch-search-archive-thread)
237     (define-key map "-" 'notmuch-search-remove-tag)
238     (define-key map "+" 'notmuch-search-add-tag)
239     (define-key map (kbd "RET") 'notmuch-search-show-thread)
240     map)
241   "Keymap for \"notmuch search\" buffers.")
242 (fset 'notmuch-search-mode-map notmuch-search-mode-map)
243
244 (defvar notmuch-search-stash-map
245   (let ((map (make-sparse-keymap)))
246     (define-key map "i" 'notmuch-search-stash-thread-id)
247     map)
248   "Submap for stash commands")
249 (fset 'notmuch-search-stash-map notmuch-search-stash-map)
250
251 (defun notmuch-search-stash-thread-id ()
252   "Copy thread ID of current thread to kill-ring."
253   (interactive)
254   (notmuch-common-do-stash (notmuch-search-find-thread-id)))
255
256 (defvar notmuch-search-query-string)
257 (defvar notmuch-search-target-thread)
258 (defvar notmuch-search-target-line)
259 (defvar notmuch-search-continuation)
260
261 (defvar notmuch-search-disjunctive-regexp      "\\<[oO][rR]\\>")
262
263 (defun notmuch-search-quit ()
264   "Exit the search buffer, calling any defined continuation function."
265   (interactive)
266   (let ((continuation notmuch-search-continuation))
267     (notmuch-kill-this-buffer)
268     (when continuation
269       (funcall continuation))))
270
271 (defun notmuch-search-scroll-up ()
272   "Move forward through search results by one window's worth."
273   (interactive)
274   (condition-case nil
275       (scroll-up nil)
276     ((end-of-buffer) (notmuch-search-last-thread))))
277
278 (defun notmuch-search-scroll-down ()
279   "Move backward through the search results by one window's worth."
280   (interactive)
281   ;; I don't know why scroll-down doesn't signal beginning-of-buffer
282   ;; the way that scroll-up signals end-of-buffer, but c'est la vie.
283   ;;
284   ;; So instead of trapping a signal we instead check whether the
285   ;; window begins on the first line of the buffer and if so, move
286   ;; directly to that position. (We have to count lines since the
287   ;; window-start position is not the same as point-min due to the
288   ;; invisible thread-ID characters on the first line.
289   (if (equal (count-lines (point-min) (window-start)) 0)
290       (goto-char (point-min))
291     (scroll-down nil)))
292
293 (defun notmuch-search-next-thread ()
294   "Select the next thread in the search results."
295   (interactive)
296   (when (notmuch-search-get-result)
297     (goto-char (notmuch-search-result-end))))
298
299 (defun notmuch-search-previous-thread ()
300   "Select the previous thread in the search results."
301   (interactive)
302   (if (notmuch-search-get-result)
303       (unless (bobp)
304         (goto-char (notmuch-search-result-beginning (- (point) 1))))
305     ;; We must be past the end; jump to the last result
306     (notmuch-search-last-thread)))
307
308 (defun notmuch-search-last-thread ()
309   "Select the last thread in the search results."
310   (interactive)
311   (goto-char (point-max))
312   (forward-line -2)
313   (let ((beg (notmuch-search-result-beginning)))
314     (when beg (goto-char beg))))
315
316 (defun notmuch-search-first-thread ()
317   "Select the first thread in the search results."
318   (interactive)
319   (goto-char (point-min)))
320
321 (defface notmuch-message-summary-face
322  '((((class color) (background light)) (:background "#f0f0f0"))
323    (((class color) (background dark)) (:background "#303030")))
324  "Face for the single-line message summary in notmuch-show-mode."
325  :group 'notmuch-show
326  :group 'notmuch-faces)
327
328 (defface notmuch-search-date
329   '((t :inherit default))
330   "Face used in search mode for dates."
331   :group 'notmuch-search
332   :group 'notmuch-faces)
333
334 (defface notmuch-search-count
335   '((t :inherit default))
336   "Face used in search mode for the count matching the query."
337   :group 'notmuch-search
338   :group 'notmuch-faces)
339
340 (defface notmuch-search-subject
341   '((t :inherit default))
342   "Face used in search mode for subjects."
343   :group 'notmuch-search
344   :group 'notmuch-faces)
345
346 (defface notmuch-search-matching-authors
347   '((t :inherit default))
348   "Face used in search mode for authors matching the query."
349   :group 'notmuch-search
350   :group 'notmuch-faces)
351
352 (defface notmuch-search-non-matching-authors
353   '((((class color)
354       (background dark))
355      (:foreground "grey30"))
356     (((class color)
357       (background light))
358      (:foreground "grey60"))
359     (t
360      (:italic t)))
361   "Face used in search mode for authors not matching the query."
362   :group 'notmuch-search
363   :group 'notmuch-faces)
364
365 (defface notmuch-tag-face
366   '((((class color)
367       (background dark))
368      (:foreground "OliveDrab1"))
369     (((class color)
370       (background light))
371      (:foreground "navy blue" :bold t))
372     (t
373      (:bold t)))
374   "Face used in search mode face for tags."
375   :group 'notmuch-search
376   :group 'notmuch-faces)
377
378 (defun notmuch-search-mode ()
379   "Major mode displaying results of a notmuch search.
380
381 This buffer contains the results of a \"notmuch search\" of your
382 email archives. Each line in the buffer represents a single
383 thread giving a summary of the thread (a relative date, the
384 number of matched messages and total messages in the thread,
385 participants in the thread, a representative subject line, and
386 any tags).
387
388 Pressing \\[notmuch-search-show-thread] on any line displays that thread. The '\\[notmuch-search-add-tag]' and '\\[notmuch-search-remove-tag]'
389 keys can be used to add or remove tags from a thread. The '\\[notmuch-search-archive-thread]' key
390 is a convenience for archiving a thread (removing the \"inbox\"
391 tag). The '\\[notmuch-search-tag-all]' key can be used to add and/or remove tags from all
392 messages (as opposed to threads) that match the current query.  Use with caution, as this
393 will also tag matching messages that arrived *after* constructing the buffer.
394
395 Other useful commands are '\\[notmuch-search-filter]' for filtering the current search
396 based on an additional query string, '\\[notmuch-search-filter-by-tag]' for filtering to include
397 only messages with a given tag, and '\\[notmuch-search]' to execute a new, global
398 search.
399
400 Complete list of currently available key bindings:
401
402 \\{notmuch-search-mode-map}"
403   (interactive)
404   (kill-all-local-variables)
405   (make-local-variable 'notmuch-search-query-string)
406   (make-local-variable 'notmuch-search-oldest-first)
407   (make-local-variable 'notmuch-search-target-thread)
408   (make-local-variable 'notmuch-search-target-line)
409   (set (make-local-variable 'notmuch-search-continuation) nil)
410   (set (make-local-variable 'scroll-preserve-screen-position) t)
411   (add-to-invisibility-spec (cons 'ellipsis t))
412   (use-local-map notmuch-search-mode-map)
413   (setq truncate-lines t)
414   (setq major-mode 'notmuch-search-mode
415         mode-name "notmuch-search")
416   (setq buffer-read-only t))
417
418 (defun notmuch-search-get-result (&optional pos)
419   "Return the result object for the thread at POS (or point).
420
421 If there is no thread at POS (or point), returns nil."
422   (get-text-property (or pos (point)) 'notmuch-search-result))
423
424 (defun notmuch-search-result-beginning (&optional pos)
425   "Return the point at the beginning of the thread at POS (or point).
426
427 If there is no thread at POS (or point), returns nil."
428   (when (notmuch-search-get-result pos)
429     ;; We pass 1+point because previous-single-property-change starts
430     ;; searching one before the position we give it.
431     (previous-single-property-change (1+ (or pos (point)))
432                                      'notmuch-search-result nil (point-min))))
433
434 (defun notmuch-search-result-end (&optional pos)
435   "Return the point at the end of the thread at POS (or point).
436
437 The returned point will be just after the newline character that
438 ends the result line.  If there is no thread at POS (or point),
439 returns nil"
440   (when (notmuch-search-get-result pos)
441     (next-single-property-change (or pos (point)) 'notmuch-search-result
442                                  nil (point-max))))
443
444 (defun notmuch-search-foreach-result (beg end function)
445   "Invoke FUNCTION for each result between BEG and END.
446
447 FUNCTION should take one argument.  It will be applied to the
448 character position of the beginning of each result that overlaps
449 the region between points BEG and END.  As a special case, if (=
450 BEG END), FUNCTION will be applied to the result containing point
451 BEG."
452
453   (lexical-let ((pos (notmuch-search-result-beginning beg))
454                 ;; End must be a marker in case function changes the
455                 ;; text.
456                 (end (copy-marker end))
457                 ;; Make sure we examine at least one result, even if
458                 ;; (= beg end).
459                 (first t))
460     ;; We have to be careful if the region extends beyond the results.
461     ;; In this case, pos could be null or there could be no result at
462     ;; pos.
463     (while (and pos (or (< pos end) first))
464       (when (notmuch-search-get-result pos)
465         (funcall function pos))
466       (setq pos (notmuch-search-result-end pos)
467             first nil))))
468 ;; Unindent the function argument of notmuch-search-foreach-result so
469 ;; the indentation of callers doesn't get out of hand.
470 (put 'notmuch-search-foreach-result 'lisp-indent-function 2)
471
472 (defun notmuch-search-properties-in-region (property beg end)
473   (let (output)
474     (notmuch-search-foreach-result beg end
475       (lambda (pos)
476         (push (plist-get (notmuch-search-get-result pos) property) output)))
477     output))
478
479 (defun notmuch-search-find-thread-id (&optional bare)
480   "Return the thread for the current thread
481
482 If BARE is set then do not prefix with \"thread:\""
483   (let ((thread (plist-get (notmuch-search-get-result) :thread)))
484     (when thread (concat (unless bare "thread:") thread))))
485
486 (defun notmuch-search-find-thread-id-region (beg end)
487   "Return a list of threads for the current region"
488   (mapcar (lambda (thread) (concat "thread:" thread))
489           (notmuch-search-properties-in-region :thread beg end)))
490
491 (defun notmuch-search-find-thread-id-region-search (beg end)
492   "Return a search string for threads for the current region"
493   (mapconcat 'identity (notmuch-search-find-thread-id-region beg end) " or "))
494
495 (defun notmuch-search-find-authors ()
496   "Return the authors for the current thread"
497   (plist-get (notmuch-search-get-result) :authors))
498
499 (defun notmuch-search-find-authors-region (beg end)
500   "Return a list of authors for the current region"
501   (notmuch-search-properties-in-region :authors beg end))
502
503 (defun notmuch-search-find-subject ()
504   "Return the subject for the current thread"
505   (plist-get (notmuch-search-get-result) :subject))
506
507 (defun notmuch-search-find-subject-region (beg end)
508   "Return a list of authors for the current region"
509   (notmuch-search-properties-in-region :subject beg end))
510
511 (defun notmuch-search-show-thread ()
512   "Display the currently selected thread."
513   (interactive)
514   (let ((thread-id (notmuch-search-find-thread-id))
515         (subject (notmuch-search-find-subject)))
516     (if (> (length thread-id) 0)
517         (notmuch-show thread-id
518                       (current-buffer)
519                       notmuch-search-query-string
520                       ;; Name the buffer based on the subject.
521                       (concat "*" (truncate-string-to-width subject 30 nil nil t) "*"))
522       (message "End of search results."))))
523
524 (defun notmuch-search-reply-to-thread (&optional prompt-for-sender)
525   "Begin composing a reply-all to the entire current thread in a new buffer."
526   (interactive "P")
527   (let ((message-id (notmuch-search-find-thread-id)))
528     (notmuch-mua-new-reply message-id prompt-for-sender t)))
529
530 (defun notmuch-search-reply-to-thread-sender (&optional prompt-for-sender)
531   "Begin composing a reply to the entire current thread in a new buffer."
532   (interactive "P")
533   (let ((message-id (notmuch-search-find-thread-id)))
534     (notmuch-mua-new-reply message-id prompt-for-sender nil)))
535
536 (defun notmuch-call-notmuch-process (&rest args)
537   "Synchronously invoke \"notmuch\" with the given list of arguments.
538
539 Output from the process will be presented to the user as an error
540 and will also appear in a buffer named \"*Notmuch errors*\"."
541   (let ((error-buffer (get-buffer-create "*Notmuch errors*")))
542     (with-current-buffer error-buffer
543         (erase-buffer))
544     (if (eq (apply 'call-process notmuch-command nil error-buffer nil args) 0)
545         (point)
546       (progn
547         (with-current-buffer error-buffer
548           (let ((beg (point-min))
549                 (end (- (point-max) 1)))
550             (error (buffer-substring beg end))
551             ))))))
552
553 (defun notmuch-search-set-tags (tags &optional pos)
554   (let ((new-result (plist-put (notmuch-search-get-result pos) :tags tags)))
555     (notmuch-search-update-result new-result pos)))
556
557 (defun notmuch-search-get-tags (&optional pos)
558   (plist-get (notmuch-search-get-result pos) :tags))
559
560 (defun notmuch-search-get-tags-region (beg end)
561   (let (output)
562     (notmuch-search-foreach-result beg end
563       (lambda (pos)
564         (setq output (append output (notmuch-search-get-tags pos)))))
565     output))
566
567 (defun notmuch-search-tag-region (beg end &optional tag-changes)
568   "Change tags for threads in the given region."
569   (let ((search-string (notmuch-search-find-thread-id-region-search beg end)))
570     (setq tag-changes (funcall 'notmuch-tag search-string tag-changes))
571     (notmuch-search-foreach-result beg end
572       (lambda (pos)
573         (notmuch-search-set-tags
574          (notmuch-update-tags (notmuch-search-get-tags pos) tag-changes)
575          pos)))))
576
577 (defun notmuch-search-tag (&optional tag-changes)
578   "Change tags for the currently selected thread or region.
579
580 See `notmuch-tag' for information on the format of TAG-CHANGES."
581   (interactive)
582   (let* ((beg (if (region-active-p) (region-beginning) (point)))
583          (end (if (region-active-p) (region-end) (point))))
584     (funcall 'notmuch-search-tag-region beg end tag-changes)))
585
586 (defun notmuch-search-add-tag ()
587   "Same as `notmuch-search-tag' but sets initial input to '+'."
588   (interactive)
589   (notmuch-search-tag "+"))
590
591 (defun notmuch-search-remove-tag ()
592   "Same as `notmuch-search-tag' but sets initial input to '-'."
593   (interactive)
594   (notmuch-search-tag "-"))
595
596 (defun notmuch-search-archive-thread ()
597   "Archive the currently selected thread (remove its \"inbox\" tag).
598
599 This function advances the next thread when finished."
600   (interactive)
601   (notmuch-search-tag '("-inbox"))
602   (notmuch-search-next-thread))
603
604 (defun notmuch-search-update-result (result &optional pos)
605   "Replace the result object of the thread at POS (or point) by
606 RESULT and redraw it.
607
608 This will keep point in a reasonable location.  However, if there
609 are enclosing save-excursions and the saved point is in the
610 result being updated, the point will be restored to the beginning
611 of the result."
612   (let ((start (notmuch-search-result-beginning pos))
613         (end (notmuch-search-result-end pos))
614         (init-point (point))
615         (inhibit-read-only t))
616     ;; Delete the current thread
617     (delete-region start end)
618     ;; Insert the updated thread
619     (notmuch-search-show-result result start)
620     ;; If point was inside the old result, make an educated guess
621     ;; about where to place it now.  Unfortunately, this won't work
622     ;; with save-excursion (or any other markers that would be nice to
623     ;; preserve, such as the window start), but there's nothing we can
624     ;; do about that without a way to retrieve markers in a region.
625     (when (and (>= init-point start) (<= init-point end))
626       (let* ((new-end (notmuch-search-result-end start))
627              (new-point (if (= init-point end)
628                             new-end
629                           (min init-point (- new-end 1)))))
630         (goto-char new-point)))))
631
632 (defun notmuch-search-process-sentinel (proc msg)
633   "Add a message to let user know when \"notmuch search\" exits"
634   (let ((buffer (process-buffer proc))
635         (status (process-status proc))
636         (exit-status (process-exit-status proc))
637         (never-found-target-thread nil))
638     (when (memq status '(exit signal))
639         (kill-buffer (process-get proc 'parse-buf))
640         (if (buffer-live-p buffer)
641             (with-current-buffer buffer
642               (save-excursion
643                 (let ((inhibit-read-only t)
644                       (atbob (bobp)))
645                   (goto-char (point-max))
646                   (if (eq status 'signal)
647                       (insert "Incomplete search results (search process was killed).\n"))
648                   (when (eq status 'exit)
649                     (insert "End of search results.")
650                     (unless (= exit-status 0)
651                       (insert (format " (process returned %d)" exit-status)))
652                     (insert "\n")
653                     (if (and atbob
654                              (not (string= notmuch-search-target-thread "found")))
655                         (set 'never-found-target-thread t)))))
656               (when (and never-found-target-thread
657                        notmuch-search-target-line)
658                   (goto-char (point-min))
659                   (forward-line (1- notmuch-search-target-line))))))))
660
661 (defcustom notmuch-search-line-faces '(("unread" :weight bold)
662                                        ("flagged" :foreground "blue"))
663   "Tag/face mapping for line highlighting in notmuch-search.
664
665 Here is an example of how to color search results based on tags.
666  (the following text would be placed in your ~/.emacs file):
667
668  (setq notmuch-search-line-faces '((\"deleted\" . (:foreground \"red\"
669                                                   :background \"blue\"))
670                                    (\"unread\" . (:foreground \"green\"))))
671
672 The attributes defined for matching tags are merged, with later
673 attributes overriding earlier. A message having both \"deleted\"
674 and \"unread\" tags with the above settings would have a green
675 foreground and blue background."
676   :type '(alist :key-type (string) :value-type (custom-face-edit))
677   :group 'notmuch-search
678   :group 'notmuch-faces)
679
680 (defun notmuch-search-color-line (start end line-tag-list)
681   "Colorize lines in `notmuch-show' based on tags."
682   (mapc (lambda (elem)
683           (let ((tag (car elem))
684                 (attributes (cdr elem)))
685             (when (member tag line-tag-list)
686               (notmuch-combine-face-text-property start end attributes))))
687         ;; Reverse the list so earlier entries take precedence
688         (reverse notmuch-search-line-faces)))
689
690 (defun notmuch-search-author-propertize (authors)
691   "Split `authors' into matching and non-matching authors and
692 propertize appropriately. If no boundary between authors and
693 non-authors is found, assume that all of the authors match."
694   (if (string-match "\\(.*\\)|\\(.*\\)" authors)
695       (concat (propertize (concat (match-string 1 authors) ",")
696                           'face 'notmuch-search-matching-authors)
697               (propertize (match-string 2 authors)
698                           'face 'notmuch-search-non-matching-authors))
699     (propertize authors 'face 'notmuch-search-matching-authors)))
700
701 (defun notmuch-search-insert-authors (format-string authors)
702   ;; Save the match data to avoid interfering with
703   ;; `notmuch-search-process-filter'.
704   (save-match-data
705     (let* ((formatted-authors (format format-string authors))
706            (formatted-sample (format format-string ""))
707            (visible-string formatted-authors)
708            (invisible-string "")
709            (padding ""))
710
711       ;; Truncate the author string to fit the specification.
712       (if (> (length formatted-authors)
713              (length formatted-sample))
714           (let ((visible-length (- (length formatted-sample)
715                                    (length "... "))))
716             ;; Truncate the visible string according to the width of
717             ;; the display string.
718             (setq visible-string (substring formatted-authors 0 visible-length)
719                   invisible-string (substring formatted-authors visible-length))
720             ;; If possible, truncate the visible string at a natural
721             ;; break (comma or pipe), as incremental search doesn't
722             ;; match across the visible/invisible border.
723             (when (string-match "\\(.*\\)\\([,|] \\)\\([^,|]*\\)" visible-string)
724               ;; Second clause is destructive on `visible-string', so
725               ;; order is important.
726               (setq invisible-string (concat (match-string 3 visible-string)
727                                              invisible-string)
728                     visible-string (concat (match-string 1 visible-string)
729                                            (match-string 2 visible-string))))
730             ;; `visible-string' may be shorter than the space allowed
731             ;; by `format-string'. If so we must insert some padding
732             ;; after `invisible-string'.
733             (setq padding (make-string (- (length formatted-sample)
734                                           (length visible-string)
735                                           (length "..."))
736                                        ? ))))
737
738       ;; Use different faces to show matching and non-matching authors.
739       (if (string-match "\\(.*\\)|\\(.*\\)" visible-string)
740           ;; The visible string contains both matching and
741           ;; non-matching authors.
742           (setq visible-string (notmuch-search-author-propertize visible-string)
743                 ;; The invisible string must contain only non-matching
744                 ;; authors, as the visible-string contains both.
745                 invisible-string (propertize invisible-string
746                                              'face 'notmuch-search-non-matching-authors))
747         ;; The visible string contains only matching authors.
748         (setq visible-string (propertize visible-string
749                                          'face 'notmuch-search-matching-authors)
750               ;; The invisible string may contain both matching and
751               ;; non-matching authors.
752               invisible-string (notmuch-search-author-propertize invisible-string)))
753
754       ;; If there is any invisible text, add it as a tooltip to the
755       ;; visible text.
756       (when (not (string= invisible-string ""))
757         (setq visible-string (propertize visible-string 'help-echo (concat "..." invisible-string))))
758
759       ;; Insert the visible and, if present, invisible author strings.
760       (insert visible-string)
761       (when (not (string= invisible-string ""))
762         (let ((start (point))
763               overlay)
764           (insert invisible-string)
765           (setq overlay (make-overlay start (point)))
766           (overlay-put overlay 'invisible 'ellipsis)
767           (overlay-put overlay 'isearch-open-invisible #'delete-overlay)))
768       (insert padding))))
769
770 (defun notmuch-search-insert-field (field format-string result)
771   (cond
772    ((string-equal field "date")
773     (insert (propertize (format format-string (plist-get result :date_relative))
774                         'face 'notmuch-search-date)))
775    ((string-equal field "count")
776     (insert (propertize (format format-string
777                                 (format "[%s/%s]" (plist-get result :matched)
778                                         (plist-get result :total)))
779                         'face 'notmuch-search-count)))
780    ((string-equal field "subject")
781     (insert (propertize (format format-string (plist-get result :subject))
782                         'face 'notmuch-search-subject)))
783
784    ((string-equal field "authors")
785     (notmuch-search-insert-authors format-string (plist-get result :authors)))
786
787    ((string-equal field "tags")
788     (let ((tags-str (mapconcat 'identity (plist-get result :tags) " ")))
789       (insert (propertize (format format-string tags-str)
790                           'face 'notmuch-tag-face))))))
791
792 (defun notmuch-search-show-result (result &optional pos)
793   "Insert RESULT at POS or the end of the buffer if POS is null."
794   ;; Ignore excluded matches
795   (unless (= (plist-get result :matched) 0)
796     (let ((beg (or pos (point-max))))
797       (save-excursion
798         (goto-char beg)
799         (dolist (spec notmuch-search-result-format)
800           (notmuch-search-insert-field (car spec) (cdr spec) result))
801         (insert "\n")
802         (notmuch-search-color-line beg (point) (plist-get result :tags))
803         (put-text-property beg (point) 'notmuch-search-result result))
804       (when (string= (plist-get result :thread) notmuch-search-target-thread)
805         (setq notmuch-search-target-thread "found")
806         (goto-char beg)))))
807
808 (defun notmuch-search-show-error (string &rest objects)
809   (save-excursion
810     (goto-char (point-max))
811     (insert "Error: Unexpected output from notmuch search:\n")
812     (insert (apply #'format string objects))
813     (insert "\n")))
814
815 (defvar notmuch-search-process-state nil
816   "Parsing state of the search process filter.")
817
818 (defvar notmuch-search-json-parser nil
819   "Incremental JSON parser for the search process filter.")
820
821 (defun notmuch-search-process-filter (proc string)
822   "Process and filter the output of \"notmuch search\""
823   (let ((results-buf (process-buffer proc))
824         (parse-buf (process-get proc 'parse-buf))
825         (inhibit-read-only t)
826         done)
827     (if (not (buffer-live-p results-buf))
828         (delete-process proc)
829       (with-current-buffer parse-buf
830         ;; Insert new data
831         (save-excursion
832           (goto-char (point-max))
833           (insert string)))
834       (with-current-buffer results-buf
835         (while (not done)
836           (condition-case nil
837               (case notmuch-search-process-state
838                 ((begin)
839                  ;; Enter the results list
840                  (if (eq (notmuch-json-begin-compound
841                           notmuch-search-json-parser) 'retry)
842                      (setq done t)
843                    (setq notmuch-search-process-state 'result)))
844                 ((result)
845                  ;; Parse a result
846                  (let ((result (notmuch-json-read notmuch-search-json-parser)))
847                    (case result
848                      ((retry) (setq done t))
849                      ((end) (setq notmuch-search-process-state 'end))
850                      (otherwise (notmuch-search-show-result result)))))
851                 ((end)
852                  ;; Any trailing data is unexpected
853                  (notmuch-json-eof notmuch-search-json-parser)
854                  (setq done t)))
855             (json-error
856              ;; Do our best to resynchronize and ensure forward
857              ;; progress
858              (notmuch-search-show-error
859               "%s"
860               (with-current-buffer parse-buf
861                 (let ((bad (buffer-substring (line-beginning-position)
862                                              (line-end-position))))
863                   (forward-line)
864                   bad))))))
865         ;; Clear out what we've parsed
866         (with-current-buffer parse-buf
867           (delete-region (point-min) (point)))))))
868
869 (defun notmuch-search-tag-all (&optional tag-changes)
870   "Add/remove tags from all messages in current search buffer.
871
872 See `notmuch-tag' for information on the format of TAG-CHANGES."
873   (interactive)
874   (apply 'notmuch-tag notmuch-search-query-string tag-changes))
875
876 (defun notmuch-search-buffer-title (query)
877   "Returns the title for a buffer with notmuch search results."
878   (let* ((saved-search
879           (let (longest
880                 (longest-length 0))
881             (loop for tuple in notmuch-saved-searches
882                   if (let ((quoted-query (regexp-quote (cdr tuple))))
883                        (and (string-match (concat "^" quoted-query) query)
884                             (> (length (match-string 0 query))
885                                longest-length)))
886                   do (setq longest tuple))
887             longest))
888          (saved-search-name (car saved-search))
889          (saved-search-query (cdr saved-search)))
890     (cond ((and saved-search (equal saved-search-query query))
891            ;; Query is the same as saved search (ignoring case)
892            (concat "*notmuch-saved-search-" saved-search-name "*"))
893           (saved-search
894            (concat "*notmuch-search-"
895                    (replace-regexp-in-string (concat "^" (regexp-quote saved-search-query))
896                                              (concat "[ " saved-search-name " ]")
897                                              query)
898                    "*"))
899           (t
900            (concat "*notmuch-search-" query "*"))
901           )))
902
903 (defun notmuch-read-query (prompt)
904   "Read a notmuch-query from the minibuffer with completion.
905
906 PROMPT is the string to prompt with."
907   (lexical-let
908       ((completions
909         (append (list "folder:" "thread:" "id:" "date:" "from:" "to:"
910                       "subject:" "attachment:")
911                 (mapcar (lambda (tag)
912                           (concat "tag:" tag))
913                         (process-lines notmuch-command "search" "--output=tags" "*")))))
914     (let ((keymap (copy-keymap minibuffer-local-map))
915           (minibuffer-completion-table
916            (completion-table-dynamic
917             (lambda (string)
918               ;; generate a list of possible completions for the current input
919               (cond
920                ;; this ugly regexp is used to get the last word of the input
921                ;; possibly preceded by a '('
922                ((string-match "\\(^\\|.* (?\\)\\([^ ]*\\)$" string)
923                 (mapcar (lambda (compl)
924                           (concat (match-string-no-properties 1 string) compl))
925                         (all-completions (match-string-no-properties 2 string)
926                                          completions)))
927                (t (list string)))))))
928       ;; this was simpler than convincing completing-read to accept spaces:
929       (define-key keymap (kbd "TAB") 'minibuffer-complete)
930       (let ((history-delete-duplicates t))
931         (read-from-minibuffer prompt nil keymap nil
932                               'notmuch-search-history nil nil)))))
933
934 ;;;###autoload
935 (defun notmuch-search (&optional query oldest-first target-thread target-line continuation)
936   "Run \"notmuch search\" with the given `query' and display results.
937
938 If `query' is nil, it is read interactively from the minibuffer.
939 Other optional parameters are used as follows:
940
941   oldest-first: A Boolean controlling the sort order of returned threads
942   target-thread: A thread ID (without the thread: prefix) that will be made
943                  current if it appears in the search results.
944   target-line: The line number to move to if the target thread does not
945                appear in the search results."
946   (interactive)
947   (if (null query)
948       (setq query (notmuch-read-query "Notmuch search: ")))
949   (let ((buffer (get-buffer-create (notmuch-search-buffer-title query))))
950     (switch-to-buffer buffer)
951     (notmuch-search-mode)
952     ;; Don't track undo information for this buffer
953     (set 'buffer-undo-list t)
954     (set 'notmuch-search-query-string query)
955     (set 'notmuch-search-oldest-first oldest-first)
956     (set 'notmuch-search-target-thread target-thread)
957     (set 'notmuch-search-target-line target-line)
958     (set 'notmuch-search-continuation continuation)
959     (let ((proc (get-buffer-process (current-buffer)))
960           (inhibit-read-only t))
961       (if proc
962           (error "notmuch search process already running for query `%s'" query)
963         )
964       (erase-buffer)
965       (goto-char (point-min))
966       (save-excursion
967         (let ((proc (start-process
968                      "notmuch-search" buffer
969                      notmuch-command "search"
970                      "--format=json"
971                      (if oldest-first
972                          "--sort=oldest-first"
973                        "--sort=newest-first")
974                      query))
975               ;; Use a scratch buffer to accumulate partial output.
976               ;; This buffer will be killed by the sentinel, which
977               ;; should be called no matter how the process dies.
978               (parse-buf (generate-new-buffer " *notmuch search parse*")))
979           (set (make-local-variable 'notmuch-search-process-state) 'begin)
980           (set (make-local-variable 'notmuch-search-json-parser)
981                (notmuch-json-create-parser parse-buf))
982           (process-put proc 'parse-buf parse-buf)
983           (set-process-sentinel proc 'notmuch-search-process-sentinel)
984           (set-process-filter proc 'notmuch-search-process-filter)
985           (set-process-query-on-exit-flag proc nil))))
986     (run-hooks 'notmuch-search-hook)))
987
988 (defun notmuch-search-refresh-view ()
989   "Refresh the current view.
990
991 Kills the current buffer and runs a new search with the same
992 query string as the current search. If the current thread is in
993 the new search results, then point will be placed on the same
994 thread. Otherwise, point will be moved to attempt to be in the
995 same relative position within the new buffer."
996   (interactive)
997   (let ((target-line (line-number-at-pos))
998         (oldest-first notmuch-search-oldest-first)
999         (target-thread (notmuch-search-find-thread-id 'bare))
1000         (query notmuch-search-query-string)
1001         (continuation notmuch-search-continuation))
1002     (notmuch-kill-this-buffer)
1003     (notmuch-search query oldest-first target-thread target-line continuation)
1004     (goto-char (point-min))))
1005
1006 (defcustom notmuch-poll-script nil
1007   "An external script to incorporate new mail into the notmuch database.
1008
1009 This variable controls the action invoked by
1010 `notmuch-search-poll-and-refresh-view' and
1011 `notmuch-hello-poll-and-update' (each have a default keybinding
1012 of 'G') to incorporate new mail into the notmuch database.
1013
1014 If set to nil (the default), new mail is processed by invoking
1015 \"notmuch new\". Otherwise, this should be set to a string that
1016 gives the name of an external script that processes new mail. If
1017 set to the empty string, no command will be run.
1018
1019 The external script could do any of the following depending on
1020 the user's needs:
1021
1022 1. Invoke a program to transfer mail to the local mail store
1023 2. Invoke \"notmuch new\" to incorporate the new mail
1024 3. Invoke one or more \"notmuch tag\" commands to classify the mail
1025
1026 Note that the recommended way of achieving the same is using
1027 \"notmuch new\" hooks."
1028   :type '(choice (const :tag "notmuch new" nil)
1029                  (const :tag "Disabled" "")
1030                  (string :tag "Custom script"))
1031   :group 'notmuch-external)
1032
1033 (defun notmuch-poll ()
1034   "Run \"notmuch new\" or an external script to import mail.
1035
1036 Invokes `notmuch-poll-script', \"notmuch new\", or does nothing
1037 depending on the value of `notmuch-poll-script'."
1038   (interactive)
1039   (if (stringp notmuch-poll-script)
1040       (unless (string= notmuch-poll-script "")
1041         (call-process notmuch-poll-script nil nil))
1042     (call-process notmuch-command nil nil nil "new")))
1043
1044 (defun notmuch-search-poll-and-refresh-view ()
1045   "Invoke `notmuch-poll' to import mail, then refresh the current view."
1046   (interactive)
1047   (notmuch-poll)
1048   (notmuch-search-refresh-view))
1049
1050 (defun notmuch-search-toggle-order ()
1051   "Toggle the current search order.
1052
1053 By default, the \"inbox\" view created by `notmuch' is displayed
1054 in chronological order (oldest thread at the beginning of the
1055 buffer), while any global searches created by `notmuch-search'
1056 are displayed in reverse-chronological order (newest thread at
1057 the beginning of the buffer).
1058
1059 This command toggles the sort order for the current search.
1060
1061 Note that any filtered searches created by
1062 `notmuch-search-filter' retain the search order of the parent
1063 search."
1064   (interactive)
1065   (set 'notmuch-search-oldest-first (not notmuch-search-oldest-first))
1066   (notmuch-search-refresh-view))
1067
1068 (defun notmuch-search-filter (query)
1069   "Filter the current search results based on an additional query string.
1070
1071 Runs a new search matching only messages that match both the
1072 current search results AND the additional query string provided."
1073   (interactive (list (notmuch-read-query "Filter search: ")))
1074   (let ((grouped-query (if (string-match-p notmuch-search-disjunctive-regexp query)
1075                            (concat "( " query " )")
1076                          query)))
1077     (notmuch-search (if (string= notmuch-search-query-string "*")
1078                         grouped-query
1079                       (concat notmuch-search-query-string " and " grouped-query)) notmuch-search-oldest-first)))
1080
1081 (defun notmuch-search-filter-by-tag (tag)
1082   "Filter the current search results based on a single tag.
1083
1084 Runs a new search matching only messages that match both the
1085 current search results AND that are tagged with the given tag."
1086   (interactive
1087    (list (notmuch-select-tag-with-completion "Filter by tag: ")))
1088   (notmuch-search (concat notmuch-search-query-string " and tag:" tag) notmuch-search-oldest-first))
1089
1090 ;;;###autoload
1091 (defun notmuch ()
1092   "Run notmuch and display saved searches, known tags, etc."
1093   (interactive)
1094   (notmuch-hello))
1095
1096 (defun notmuch-interesting-buffer (b)
1097   "Is the current buffer of interest to a notmuch user?"
1098   (with-current-buffer b
1099     (memq major-mode '(notmuch-show-mode
1100                        notmuch-search-mode
1101                        notmuch-hello-mode
1102                        message-mode))))
1103
1104 ;;;###autoload
1105 (defun notmuch-cycle-notmuch-buffers ()
1106   "Cycle through any existing notmuch buffers (search, show or hello).
1107
1108 If the current buffer is the only notmuch buffer, bury it. If no
1109 notmuch buffers exist, run `notmuch'."
1110   (interactive)
1111
1112   (let (start first)
1113     ;; If the current buffer is a notmuch buffer, remember it and then
1114     ;; bury it.
1115     (when (notmuch-interesting-buffer (current-buffer))
1116       (setq start (current-buffer))
1117       (bury-buffer))
1118
1119     ;; Find the first notmuch buffer.
1120     (setq first (loop for buffer in (buffer-list)
1121                      if (notmuch-interesting-buffer buffer)
1122                      return buffer))
1123
1124     (if first
1125         ;; If the first one we found is any other than the starting
1126         ;; buffer, switch to it.
1127         (unless (eq first start)
1128           (switch-to-buffer first))
1129       (notmuch))))
1130
1131 (setq mail-user-agent 'notmuch-user-agent)
1132
1133 (provide 'notmuch)