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