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