867b5635a2b335ce9828e59957437cd195a2379f
[notmuch] / 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 (require 'cl)
51 (require 'mm-view)
52 (require 'message)
53
54 (defvar notmuch-show-mode-map
55   (let ((map (make-sparse-keymap)))
56     (define-key map "?" 'notmuch-help)
57     (define-key map "q" 'kill-this-buffer)
58     (define-key map (kbd "C-p") 'notmuch-show-previous-line)
59     (define-key map (kbd "C-n") 'notmuch-show-next-line)
60     (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
61     (define-key map (kbd "TAB") 'notmuch-show-next-button)
62     (define-key map "s" 'notmuch-search)
63     (define-key map "m" 'message-mail)
64     (define-key map "f" 'notmuch-show-forward-current)
65     (define-key map "r" 'notmuch-show-reply)
66     (define-key map "|" 'notmuch-show-pipe-message)
67     (define-key map "w" 'notmuch-show-save-attachments)
68     (define-key map "V" 'notmuch-show-view-raw-message)
69     (define-key map "v" 'notmuch-show-view-all-mime-parts)
70     (define-key map "-" 'notmuch-show-remove-tag)
71     (define-key map "+" 'notmuch-show-add-tag)
72     (define-key map "X" 'notmuch-show-mark-read-then-archive-then-exit)
73     (define-key map "x" 'notmuch-show-archive-thread-then-exit)
74     (define-key map "A" 'notmuch-show-mark-read-then-archive-thread)
75     (define-key map "a" 'notmuch-show-archive-thread)
76     (define-key map "p" 'notmuch-show-previous-message)
77     (define-key map "N" 'notmuch-show-mark-read-then-next-open-message)
78     (define-key map "n" 'notmuch-show-next-message)
79     (define-key map (kbd "DEL") 'notmuch-show-rewind)
80     (define-key map " " 'notmuch-show-advance-marking-read-and-archiving)
81     map)
82   "Keymap for \"notmuch show\" buffers.")
83 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
84
85 (defvar notmuch-show-signature-regexp "\\(-- ?\\|_+\\)$"
86   "Pattern to match a line that separates content from signature.
87
88 The regexp can (and should) include $ to match the end of the
89 line, but should not include ^ to match the beginning of the
90 line. This is because notmuch may have inserted additional space
91 for indentation at the beginning of the line. But notmuch will
92 move past the indentation when testing this pattern, (so that the
93 pattern can still test against the entire line).")
94
95 (defvar notmuch-show-signature-lines-max 12
96   "Maximum length of signature that will be hidden by default.")
97
98 (defvar notmuch-command "notmuch"
99   "Command to run the notmuch binary.")
100
101 (defvar notmuch-show-message-begin-regexp    "\fmessage{")
102 (defvar notmuch-show-message-end-regexp      "\fmessage}")
103 (defvar notmuch-show-header-begin-regexp     "\fheader{")
104 (defvar notmuch-show-header-end-regexp       "\fheader}")
105 (defvar notmuch-show-body-begin-regexp       "\fbody{")
106 (defvar notmuch-show-body-end-regexp         "\fbody}")
107 (defvar notmuch-show-attachment-begin-regexp "\fattachment{")
108 (defvar notmuch-show-attachment-end-regexp   "\fattachment}")
109 (defvar notmuch-show-part-begin-regexp       "\fpart{")
110 (defvar notmuch-show-part-end-regexp         "\fpart}")
111 (defvar notmuch-show-marker-regexp "\f\\(message\\|header\\|body\\|attachment\\|part\\)[{}].*$")
112
113 (defvar notmuch-show-id-regexp "\\(id:[^ ]*\\)")
114 (defvar notmuch-show-depth-match-regexp " depth:\\([0-9]*\\).*match:\\([01]\\) ")
115 (defvar notmuch-show-filename-regexp "filename:\\(.*\\)$")
116 (defvar notmuch-show-tags-regexp "(\\([^)]*\\))$")
117
118 (defvar notmuch-show-parent-buffer nil)
119 (defvar notmuch-show-body-read-visible nil)
120 (defvar notmuch-show-citations-visible nil)
121 (defvar notmuch-show-signatures-visible nil)
122 (defvar notmuch-show-headers-visible nil)
123
124 ; XXX: This should be a generic function in emacs somewhere, not here
125 (defun point-invisible-p ()
126   "Return whether the character at point is invisible.
127
128 Here visibility is determined by `buffer-invisibility-spec' and
129 the invisible property of any overlays for point. It doesn't have
130 anything to do with whether point is currently being displayed
131 within the current window."
132   (let ((prop (get-char-property (point) 'invisible)))
133     (if (eq buffer-invisibility-spec t)
134         prop
135       (or (memq prop buffer-invisibility-spec)
136           (assq prop buffer-invisibility-spec)))))
137
138 (defun notmuch-select-tag-with-completion (prompt &rest search-terms)
139   (let ((tag-list
140          (with-output-to-string
141            (with-current-buffer standard-output
142              (apply 'call-process notmuch-command nil t nil "search-tags" search-terms)))))
143     (completing-read prompt (split-string tag-list "\n+" t) nil nil nil)))
144
145 (defun notmuch-show-next-line ()
146   "Like builtin `next-line' but ensuring we end on a visible character.
147
148 By advancing forward until reaching a visible character.
149
150 Unlike builtin `next-line' this version accepts no arguments."
151   (interactive)
152   (set 'this-command 'next-line)
153   (call-interactively 'next-line)
154   (while (point-invisible-p)
155     (forward-char)))
156
157 (defun notmuch-show-previous-line ()
158   "Like builtin `previous-line' but ensuring we end on a visible character.
159
160 By advancing forward until reaching a visible character.
161
162 Unlike builtin `previous-line' this version accepts no arguments."
163   (interactive)
164   (set 'this-command 'previous-line)
165   (call-interactively 'previous-line)
166   (while (point-invisible-p)
167     (forward-char)))
168
169 (defun notmuch-show-get-message-id ()
170   (save-excursion
171     (beginning-of-line)
172     (if (not (looking-at notmuch-show-message-begin-regexp))
173         (re-search-backward notmuch-show-message-begin-regexp))
174     (re-search-forward notmuch-show-id-regexp)
175     (buffer-substring-no-properties (match-beginning 1) (match-end 1))))
176
177 (defun notmuch-show-get-filename ()
178   (save-excursion
179     (beginning-of-line)
180     (if (not (looking-at notmuch-show-message-begin-regexp))
181         (re-search-backward notmuch-show-message-begin-regexp))
182     (re-search-forward notmuch-show-filename-regexp)
183     (buffer-substring-no-properties (match-beginning 1) (match-end 1))))
184
185 (defun notmuch-show-set-tags (tags)
186   (save-excursion
187     (beginning-of-line)
188     (if (not (looking-at notmuch-show-message-begin-regexp))
189         (re-search-backward notmuch-show-message-begin-regexp))
190     (re-search-forward notmuch-show-tags-regexp)
191     (let ((inhibit-read-only t)
192           (beg (match-beginning 1))
193           (end (match-end 1)))
194       (delete-region beg end)
195       (goto-char beg)
196       (insert (mapconcat 'identity tags " ")))))
197
198 (defun notmuch-show-get-tags ()
199   (save-excursion
200     (beginning-of-line)
201     (if (not (looking-at notmuch-show-message-begin-regexp))
202         (re-search-backward notmuch-show-message-begin-regexp))
203     (re-search-forward notmuch-show-tags-regexp)
204     (split-string (buffer-substring (match-beginning 1) (match-end 1)))))
205
206 (defun notmuch-show-add-tag (&rest toadd)
207   "Add a tag to the current message."
208   (interactive
209    (list (notmuch-select-tag-with-completion "Tag to add: ")))
210   (apply 'notmuch-call-notmuch-process
211          (append (cons "tag"
212                        (mapcar (lambda (s) (concat "+" s)) toadd))
213                  (cons (notmuch-show-get-message-id) nil)))
214   (notmuch-show-set-tags (sort (union toadd (notmuch-show-get-tags) :test 'string=) 'string<)))
215
216 (defun notmuch-show-remove-tag (&rest toremove)
217   "Remove a tag from the current message."
218   (interactive
219    (list (notmuch-select-tag-with-completion "Tag to remove: " (notmuch-show-get-message-id))))
220   (let ((tags (notmuch-show-get-tags)))
221     (if (intersection tags toremove :test 'string=)
222         (progn
223           (apply 'notmuch-call-notmuch-process
224                  (append (cons "tag"
225                                (mapcar (lambda (s) (concat "-" s)) toremove))
226                          (cons (notmuch-show-get-message-id) nil)))
227           (notmuch-show-set-tags (sort (set-difference tags toremove :test 'string=) 'string<))))))
228
229 (defun notmuch-show-archive-thread-maybe-mark-read (markread)
230   (save-excursion
231     (goto-char (point-min))
232     (while (not (eobp))
233       (if markread
234           (notmuch-show-remove-tag "unread" "inbox")
235         (notmuch-show-remove-tag "inbox"))
236       (if (not (eobp))
237           (forward-char))
238       (if (not (re-search-forward notmuch-show-message-begin-regexp nil t))
239           (goto-char (point-max)))))
240   (let ((parent-buffer notmuch-show-parent-buffer))
241     (kill-this-buffer)
242     (if parent-buffer
243         (progn
244           (switch-to-buffer parent-buffer)
245           (forward-line)
246           (notmuch-search-show-thread)))))
247
248 (defun notmuch-show-mark-read-then-archive-thread ()
249   "Remove unread tags from thread, then archive and show next thread.
250
251 Archive each message currently shown by removing the \"unread\"
252 and \"inbox\" tag from each. Then kill this buffer and show the
253 next thread from the search from which this thread was originally
254 shown.
255
256 Note: This command is safe from any race condition of new messages
257 being delivered to the same thread. It does not archive the
258 entire thread, but only the messages shown in the current
259 buffer."
260   (interactive)
261   (notmuch-show-archive-thread-maybe-mark-read t))
262
263 (defun notmuch-show-archive-thread ()
264   "Archive each message in thread, then show next thread from search.
265
266 Archive each message currently shown by removing the \"inbox\"
267 tag from each. Then kill this buffer and show the next thread
268 from the search from which this thread was originally shown.
269
270 Note: This command is safe from any race condition of new messages
271 being delivered to the same thread. It does not archive the
272 entire thread, but only the messages shown in the current
273 buffer."
274   (interactive)
275   (notmuch-show-archive-thread-maybe-mark-read nil))
276
277 (defun notmuch-show-archive-thread-then-exit ()
278   "Archive each message in thread, then exit back to search results."
279   (interactive)
280   (notmuch-show-archive-thread)
281   (kill-this-buffer))
282
283 (defun notmuch-show-mark-read-then-archive-then-exit ()
284   "Remove unread tags from thread, then archive and exit to search results."
285   (interactive)
286   (notmuch-show-mark-read-then-archive-thread)
287   (kill-this-buffer))
288
289 (defun notmuch-show-view-raw-message ()
290   "View the raw email of the current message."
291   (interactive)
292   (view-file (notmuch-show-get-filename)))
293
294 (defmacro with-current-notmuch-show-message (&rest body)
295   "Evaluate body with current buffer set to the text of current message"
296   `(save-excursion
297      (let ((filename (notmuch-show-get-filename)))
298        (let ((buf (generate-new-buffer (concat "*notmuch-msg-" filename "*"))))
299          (with-current-buffer buf
300            (insert-file-contents filename nil nil nil t)
301            ,@body)
302         (kill-buffer buf)))))
303
304 (defun notmuch-show-view-all-mime-parts ()
305   "Use external viewers to view all attachments from the current message."
306   (interactive)
307   (with-current-notmuch-show-message
308    (mm-display-parts (mm-dissect-buffer))))
309
310 (defun notmuch-foreach-mime-part (function mm-handle)
311   (cond ((stringp (car mm-handle))
312          (dolist (part (cdr mm-handle))
313            (notmuch-foreach-mime-part function part)))
314         ((bufferp (car mm-handle))
315          (funcall function mm-handle))
316         (t (dolist (part mm-handle)
317              (notmuch-foreach-mime-part function part)))))
318
319 (defun notmuch-count-attachments (mm-handle)
320   (let ((count 0))
321     (notmuch-foreach-mime-part
322      (lambda (p)
323        (let ((disposition (mm-handle-disposition p)))
324          (and (listp disposition)
325               (equal (car disposition) "attachment")
326               (incf count))))
327      mm-handle)
328     count))
329
330 (defun notmuch-save-attachments (mm-handle &optional queryp)
331   (notmuch-foreach-mime-part
332    (lambda (p)
333      (let ((disposition (mm-handle-disposition p)))
334        (and (listp disposition)
335             (equal (car disposition) "attachment")
336             (or (not queryp)
337                 (y-or-n-p
338                  (concat "Save '" (cdr (assq 'filename disposition)) "' ")))
339             (mm-save-part p))))
340    mm-handle))
341
342 (defun notmuch-show-save-attachments ()
343   "Save all attachments from the current message."
344   (interactive)
345   (with-current-notmuch-show-message
346    (let ((mm-handle (mm-dissect-buffer)))
347      (notmuch-save-attachments
348       mm-handle (> (notmuch-count-attachments mm-handle) 1))))
349   (message "Done"))
350
351 (defun notmuch-reply (query-string)
352   (switch-to-buffer (generate-new-buffer "notmuch-draft"))
353   (call-process notmuch-command nil t nil "reply" query-string)
354   (message-insert-signature)
355   (goto-char (point-min))
356   (if (re-search-forward "^$" nil t)
357       (progn
358         (insert "--text follows this line--")
359         (forward-line)))
360   (message-mode))
361
362 (defun notmuch-show-reply ()
363   "Begin composing a reply to the current message in a new buffer."
364   (interactive)
365   (let ((message-id (notmuch-show-get-message-id)))
366     (notmuch-reply message-id)))
367
368 (defun notmuch-show-forward-current ()
369   "Forward the current message."
370   (interactive)
371   (with-current-notmuch-show-message
372    (message-forward)))
373
374 (defun notmuch-show-pipe-message (command)
375   "Pipe the contents of the current message to the given command.
376
377 The given command will be executed with the raw contents of the
378 current email message as stdin. Anything printed by the command
379 to stdout or stderr will appear in the *Messages* buffer."
380   (interactive "sPipe message to command: ")
381   (apply 'start-process-shell-command "notmuch-pipe-command" "*notmuch-pipe*"
382          (list command " < " (shell-quote-argument (notmuch-show-get-filename)))))
383
384 (defun notmuch-show-move-to-current-message-summary-line ()
385   "Move to the beginning of the one-line summary of the current message.
386
387 This gives us a stable place to move to and work from since the
388 summary line is always visible. This is important since moving to
389 an invisible location is unreliable, (the main command loop moves
390 point either forward or backward to the next visible character
391 when a command ends with point on an invisible character).
392
393 Emits an error if point is not within a valid message, (that is
394 no pattern of `notmuch-show-message-begin-regexp' could be found
395 by searching backward)."
396   (beginning-of-line)
397   (if (not (looking-at notmuch-show-message-begin-regexp))
398       (if (re-search-backward notmuch-show-message-begin-regexp nil t)
399           (forward-line 2)
400         (error "Not within a valid message."))
401     (forward-line 2)))
402
403 (defun notmuch-show-last-message-p ()
404   "Predicate testing whether point is within the last message."
405   (save-window-excursion
406     (save-excursion
407       (notmuch-show-move-to-current-message-summary-line)
408       (not (re-search-forward notmuch-show-message-begin-regexp nil t)))))
409
410 (defun notmuch-show-message-unread-p ()
411   "Predicate testing whether current message is unread."
412   (member "unread" (notmuch-show-get-tags)))
413
414 (defun notmuch-show-message-open-p ()
415   "Predicate testing whether current message is open (body is visible)."
416   (let ((btn (previous-button (point) t)))
417     (while (not (button-has-type-p btn 'notmuch-button-body-toggle-type))
418       (setq btn (previous-button (button-start btn))))
419     (not (invisible-p (button-get btn 'invisibility-spec)))))
420
421 (defun notmuch-show-next-message ()
422   "Advance to the beginning of the next message in the buffer.
423
424 Moves to the last visible character of the current message if
425 already on the last message in the buffer.
426
427 Returns nil if already on the last message in the buffer."
428   (interactive)
429   (notmuch-show-move-to-current-message-summary-line)
430   (if (re-search-forward notmuch-show-message-begin-regexp nil t)
431       (progn
432         (notmuch-show-move-to-current-message-summary-line)
433         (recenter 0)
434         t)
435     (goto-char (- (point-max) 1))
436     (while (point-invisible-p)
437       (backward-char))
438     (recenter 0)
439     nil))
440
441 (defun notmuch-show-find-next-message ()
442   "Returns the position of the next message in the buffer.
443
444 Or the position of the last visible character of the current
445 message if already within the last message in the buffer."
446   ; save-excursion doesn't save our window position
447   ; save-window-excursion doesn't save point
448   ; Looks like we have to use both.
449   (save-excursion
450     (save-window-excursion
451       (notmuch-show-next-message)
452       (point))))
453
454 (defun notmuch-show-next-unread-message ()
455   "Advance to the beginning of the next unread message in the buffer.
456
457 Moves to the last visible character of the current message if
458 there are no more unread messages past the current point."
459   (notmuch-show-next-message)
460   (while (and (not (notmuch-show-last-message-p))
461               (not (notmuch-show-message-unread-p)))
462     (notmuch-show-next-message))
463   (if (not (notmuch-show-message-unread-p))
464       (notmuch-show-next-message)))
465
466 (defun notmuch-show-next-open-message ()
467   "Advance to the next open message (that is, body is not invisible)."
468   (while (and (notmuch-show-next-message)
469               (not (notmuch-show-message-open-p)))))
470
471 (defun notmuch-show-previous-message ()
472   "Backup to the beginning of the previous message in the buffer.
473
474 If within a message rather than at the beginning of it, then
475 simply move to the beginning of the current message."
476   (interactive)
477   (let ((start (point)))
478     (notmuch-show-move-to-current-message-summary-line)
479     (if (not (< (point) start))
480         ; Go backward twice to skip the current message's marker
481         (progn
482           (re-search-backward notmuch-show-message-begin-regexp nil t)
483           (re-search-backward notmuch-show-message-begin-regexp nil t)
484           (notmuch-show-move-to-current-message-summary-line)
485           ))
486     (recenter 0)))
487
488 (defun notmuch-show-find-previous-message ()
489   "Returns the position of the previous message in the buffer.
490
491 Or the position of the beginning of the current message if point
492 is originally within the message rather than at the beginning of
493 it."
494   ; save-excursion doesn't save our window position
495   ; save-window-excursion doesn't save point
496   ; Looks like we have to use both.
497   (save-excursion
498     (save-window-excursion
499       (notmuch-show-previous-message)
500       (point))))
501
502 (defun notmuch-show-mark-read-then-next-open-message ()
503   "Remove unread tag from this message, then advance to next open message."
504   (interactive)
505   (notmuch-show-remove-tag "unread")
506   (notmuch-show-next-open-message))
507
508 (defun notmuch-show-rewind ()
509   "Backup through the thread, (reverse scrolling compared to \\[notmuch-show-advance-marking-read-and-archiving]).
510
511 Specifically, if the beginning of the previous email is fewer
512 than `window-height' lines from the current point, move to it
513 just like `notmuch-show-previous-message'.
514
515 Otherwise, just scroll down a screenful of the current message.
516
517 This command does not modify any message tags, (it does not undo
518 any effects from previous calls to
519 `notmuch-show-advance-marking-read-and-archiving'."
520   (interactive)
521   (let ((previous (notmuch-show-find-previous-message)))
522     (if (> (count-lines previous (point)) (- (window-height) next-screen-context-lines))
523         (progn
524           (condition-case nil
525               (scroll-down nil)
526             ((beginning-of-buffer) nil))
527           (goto-char (window-start)))
528       (notmuch-show-previous-message))))
529
530 (defun notmuch-show-advance-marking-read-and-archiving ()
531   "Advance through thread, marking read and archiving.
532
533 This command is intended to be one of the simplest ways to
534 process a thread of email. It does the following:
535
536 If the current message in the thread is not yet fully visible,
537 scroll by a near screenful to read more of the message.
538
539 Otherwise, (the end of the current message is already within the
540 current window), remove the \"unread\" tag (if present) from the
541 current message and advance to the next open message.
542
543 Finally, if there is no further message to advance to, and this
544 last message is already read, then archive the entire current
545 thread, (remove the \"inbox\" tag from each message). Also kill
546 this buffer, and display the next thread from the search from
547 which this thread was originally shown."
548   (interactive)
549   (let ((next (notmuch-show-find-next-message))
550         (unread (notmuch-show-message-unread-p)))
551     (if (> next (window-end))
552         (scroll-up nil)
553       (let ((last (notmuch-show-last-message-p)))
554         (notmuch-show-mark-read-then-next-open-message)
555         (if last
556             (notmuch-show-archive-thread))))))
557
558 (defun notmuch-show-next-button ()
559   "Advance point to the next button in the buffer."
560   (interactive)
561   (goto-char (button-start (next-button (point)))))
562
563 (defun notmuch-show-previous-button ()
564   "Move point back to the previous button in the buffer."
565   (interactive)
566   (goto-char (button-start (previous-button (point)))))
567
568 (defun notmuch-toggle-invisible-action (cite-button)
569   (let ((invis-spec (button-get cite-button 'invisibility-spec)))
570         (if (invisible-p invis-spec)
571             (remove-from-invisibility-spec invis-spec)
572           (add-to-invisibility-spec invis-spec)
573           ))
574   (force-window-update)
575   (redisplay t))
576
577 (define-button-type 'notmuch-button-invisibility-toggle-type
578   'action 'notmuch-toggle-invisible-action
579   'follow-link t
580   'face "default")
581 (define-button-type 'notmuch-button-citation-toggle-type 'help-echo "mouse-1, RET: Show citation"
582   :supertype 'notmuch-button-invisibility-toggle-type)
583 (define-button-type 'notmuch-button-signature-toggle-type 'help-echo "mouse-1, RET: Show signature"
584   :supertype 'notmuch-button-invisibility-toggle-type)
585 (define-button-type 'notmuch-button-headers-toggle-type 'help-echo "mouse-1, RET: Show headers"
586   :supertype 'notmuch-button-invisibility-toggle-type)
587 (define-button-type 'notmuch-button-body-toggle-type
588   'help-echo "mouse-1, RET: Show message"
589   'face 'notmuch-message-summary-face
590   :supertype 'notmuch-button-invisibility-toggle-type)
591
592 (defun notmuch-show-markup-citations-region (beg end depth)
593   (goto-char beg)
594   (beginning-of-line)
595   (while (< (point) end)
596     (let ((beg-sub (point-marker))
597           (indent (make-string depth ? ))
598           (citation "[[:space:]]*>"))
599       (if (looking-at citation)
600           (progn
601             (while (looking-at citation)
602               (forward-line))
603             (let ((overlay (make-overlay beg-sub (point)))
604                   (invis-spec (make-symbol "notmuch-citation-region")))
605               (add-to-invisibility-spec invis-spec)
606               (overlay-put overlay 'invisible invis-spec)
607               (let ((p (point))
608                     (cite-button-text
609                      (concat "["  (number-to-string (count-lines beg-sub (point)))
610                              "-line citation.]")))
611                 (goto-char (- beg-sub 1))
612                 (insert (concat "\n" indent))
613                 (insert-button cite-button-text
614                                'invisibility-spec invis-spec
615                                :type 'notmuch-button-citation-toggle-type)
616                 (insert "\n")
617                 (goto-char (+ (length cite-button-text) p))
618               ))))
619       (move-to-column depth)
620       (if (looking-at notmuch-show-signature-regexp)
621           (let ((sig-lines (- (count-lines beg-sub end) 1)))
622             (if (<= sig-lines notmuch-show-signature-lines-max)
623                 (progn
624                   (let ((invis-spec (make-symbol "notmuch-signature-region")))
625                     (add-to-invisibility-spec invis-spec)
626                     (overlay-put (make-overlay beg-sub end)
627                                  'invisible invis-spec)
628                   
629                     (goto-char (- beg-sub 1))
630                     (insert (concat "\n" indent))
631                     (let ((sig-button-text (concat "[" (number-to-string sig-lines)
632                                                    "-line signature.]")))
633                       (insert-button sig-button-text 'invisibility-spec invis-spec
634                                      :type 'notmuch-button-signature-toggle-type)
635                      )
636                     (insert "\n")
637                     (goto-char end))))))
638       (forward-line))))
639
640 (defun notmuch-show-markup-part (beg end depth mime-message)
641   (if (re-search-forward notmuch-show-part-begin-regexp nil t)
642       (progn
643         (if (eq mime-message nil)
644             (let ((filename (notmuch-show-get-filename)))
645               (with-temp-buffer
646                 (insert-file-contents filename nil nil nil t)
647                 (setq mime-message (mm-dissect-buffer)))))
648         (forward-line)
649         (let ((part-beg (point-marker)))
650           (re-search-forward notmuch-show-part-end-regexp)
651
652           (let ((part-end (copy-marker (match-beginning 0))))
653             (goto-char part-end)
654             (if (not (bolp))
655                 (insert "\n"))
656             (indent-rigidly part-beg part-end depth)
657             (save-excursion
658               (goto-char part-beg)
659               (forward-line -1)
660               (beginning-of-line)
661               (let ((handle-type (mm-handle-type mime-message))
662                     mime-type)
663                 (if (sequencep (car handle-type))
664                     (setq mime-type (car handle-type))
665                   (setq mime-type (car (car (cdr handle-type))))
666                   )
667                 (if (equal mime-type "text/html")
668                     (mm-display-part mime-message))))
669
670             (notmuch-show-markup-citations-region part-beg part-end depth)
671             ; Advance to the next part (if any) (so the outer loop can
672             ; determine whether we've left the current message.
673             (if (re-search-forward notmuch-show-part-begin-regexp nil t)
674                 (beginning-of-line)))))
675     (goto-char end))
676   mime-message)
677
678 (defun notmuch-show-markup-parts-region (beg end depth)
679   (save-excursion
680     (goto-char beg)
681     (let (mime-message)
682       (while (< (point) end)
683         (setq mime-message
684               (notmuch-show-markup-part
685                beg end depth mime-message))))))
686
687 (defun notmuch-show-markup-body (depth match btn)
688   "Markup a message body, (indenting, buttonizing citations,
689 etc.), and conditionally hiding the body itself if the message
690 has been read and does not match the current search.
691
692 DEPTH specifies the depth at which this message appears in the
693 tree of the current thread, (the top-level messages have depth 0
694 and each reply increases depth by 1). MATCH indicates whether
695 this message is regarded as matching the current search. BTN is
696 the button which is used to toggle the visibility of this
697 message.
698
699 When this function is called, point must be within the message, but
700 before the delimiter marking the beginning of the body."
701   (re-search-forward notmuch-show-body-begin-regexp)
702   (forward-line)
703   (let ((beg (point-marker)))
704     (re-search-forward notmuch-show-body-end-regexp)
705     (let ((end (copy-marker (match-beginning 0))))
706       (notmuch-show-markup-parts-region beg end depth)
707       (let ((invis-spec (make-symbol "notmuch-show-body-read")))
708         (overlay-put (make-overlay beg end)
709                      'invisible invis-spec)
710         (button-put btn 'invisibility-spec invis-spec)
711         (if (not (or (notmuch-show-message-unread-p) match))
712             (add-to-invisibility-spec invis-spec)))
713       (set-marker beg nil)
714       (set-marker end nil)
715       )))
716
717 (defun notmuch-fontify-headers ()
718   (while (looking-at "[[:space:]]")
719     (forward-char))
720   (if (looking-at "[Tt]o:")
721       (progn
722         (overlay-put (make-overlay (point) (re-search-forward ":"))
723                      'face 'message-header-name)
724         (overlay-put (make-overlay (point) (re-search-forward ".*$"))
725                      'face 'message-header-to))
726     (if (looking-at "[B]?[Cc][Cc]:")
727         (progn
728           (overlay-put (make-overlay (point) (re-search-forward ":"))
729                        'face 'message-header-name)
730           (overlay-put (make-overlay (point) (re-search-forward ".*$"))
731                        'face 'message-header-cc))
732       (if (looking-at "[Ss]ubject:")
733           (progn
734             (overlay-put (make-overlay (point) (re-search-forward ":"))
735                          'face 'message-header-name)
736             (overlay-put (make-overlay (point) (re-search-forward ".*$"))
737                          'face 'message-header-subject))
738         (if (looking-at "[Ff]rom:")
739             (progn
740               (overlay-put (make-overlay (point) (re-search-forward ":"))
741                            'face 'message-header-name)
742               (overlay-put (make-overlay (point) (re-search-forward ".*$"))
743                            'face 'message-header-other)))))))
744
745 (defun notmuch-show-markup-header (message-begin depth)
746   "Buttonize and decorate faces in a message header.
747
748 MESSAGE-BEGIN is the position of the absolute first character in
749 the message (including all delimiters that will end up being
750 invisible etc.). This is to allow a button to reliably extend to
751 the beginning of the message even if point is positioned at an
752 invisible character (such as the beginning of the buffer).
753
754 DEPTH specifies the depth at which this message appears in the
755 tree of the current thread, (the top-level messages have depth 0
756 and each reply increases depth by 1)."
757   (re-search-forward notmuch-show-header-begin-regexp)
758   (forward-line)
759   (let ((beg (point-marker))
760         (summary-end (copy-marker (line-beginning-position 2)))
761         (subject-end (copy-marker (line-end-position 2)))
762         (invis-spec (make-symbol "notmuch-show-header"))
763         (btn nil))
764     (re-search-forward notmuch-show-header-end-regexp)
765     (beginning-of-line)
766     (let ((end (point-marker)))
767       (indent-rigidly beg end depth)
768       (goto-char beg)
769       (setq btn (make-button message-begin summary-end :type 'notmuch-button-body-toggle-type))
770       (forward-line)
771       (add-to-invisibility-spec invis-spec)
772       (overlay-put (make-overlay subject-end end)
773                    'invisible invis-spec)
774       (make-button (line-beginning-position) subject-end
775                    'invisibility-spec invis-spec
776                    :type 'notmuch-button-headers-toggle-type)
777       (while (looking-at "[[:space:]]*[A-Za-z][-A-Za-z0-9]*:")
778         (beginning-of-line)
779         (notmuch-fontify-headers)
780         (forward-line)
781         )
782       (goto-char end)
783       (insert "\n")
784       (set-marker beg nil)
785       (set-marker summary-end nil)
786       (set-marker subject-end nil)
787       (set-marker end nil)
788       )
789   btn))
790
791 (defun notmuch-show-markup-message ()
792   (if (re-search-forward notmuch-show-message-begin-regexp nil t)
793       (let ((message-begin (match-beginning 0)))
794         (re-search-forward notmuch-show-depth-match-regexp)
795         (let ((depth (string-to-number (buffer-substring (match-beginning 1) (match-end 1))))
796               (match (string= "1" (buffer-substring (match-beginning 2) (match-end 2))))
797               (btn nil))
798           (setq btn (notmuch-show-markup-header message-begin depth))
799           (notmuch-show-markup-body depth match btn)))
800     (goto-char (point-max))))
801
802 (defun notmuch-show-hide-markers ()
803   (save-excursion
804     (goto-char (point-min))
805     (while (not (eobp))
806       (if (re-search-forward notmuch-show-marker-regexp nil t)
807           (progn
808             (overlay-put (make-overlay (match-beginning 0) (+ (match-end 0) 1))
809                          'invisible 'notmuch-show-marker))
810         (goto-char (point-max))))))
811
812 (defun notmuch-show-markup-messages ()
813   (save-excursion
814     (goto-char (point-min))
815     (while (not (eobp))
816       (notmuch-show-markup-message)))
817   (notmuch-show-hide-markers))
818
819 (defun notmuch-documentation-first-line (symbol)
820   "Return the first line of the documentation string for SYMBOL."
821   (let ((doc (documentation symbol)))
822     (if doc
823         (with-temp-buffer
824           (insert (documentation symbol t))
825           (goto-char (point-min))
826           (let ((beg (point)))
827             (end-of-line)
828             (buffer-substring beg (point))))
829       "")))
830
831 (defun notmuch-prefix-key-description (key)
832   "Given a prefix key code, return a human-readable string representation.
833
834 This is basically just `format-kbd-macro' but we also convert ESC to M-."
835   (let ((desc (format-kbd-macro (vector key))))
836     (if (string= desc "ESC")
837         "M-"
838       (concat desc " "))))
839
840 ; I would think that emacs would have code handy for walking a keymap
841 ; and generating strings for each key, and I would prefer to just call
842 ; that. But I couldn't find any (could be all implemented in C I
843 ; suppose), so I wrote my own here.
844 (defun notmuch-substitute-one-command-key-with-prefix (prefix binding)
845   "For a key binding, return a string showing a human-readable
846 representation of the prefixed key as well as the first line of
847 documentation from the bound function.
848
849 For a mouse binding, return nil."
850   (let ((key (car binding))
851         (action (cdr binding)))
852     (if (mouse-event-p key)
853         nil
854       (if (keymapp action)
855           (let ((substitute (apply-partially 'notmuch-substitute-one-command-key-with-prefix (notmuch-prefix-key-description key))))
856             (mapconcat substitute (cdr action) "\n"))
857         (concat prefix (format-kbd-macro (vector key))
858                 "\t"
859                 (notmuch-documentation-first-line action))))))
860
861 (defalias 'notmuch-substitute-one-command-key
862   (apply-partially 'notmuch-substitute-one-command-key-with-prefix nil))
863
864 (defun notmuch-substitute-command-keys (doc)
865   "Like `substitute-command-keys' but with documentation, not function names."
866   (let ((beg 0))
867     (while (string-match "\\\\{\\([^}[:space:]]*\\)}" doc beg)
868       (let ((map (substring doc (match-beginning 1) (match-end 1))))
869         (setq doc (replace-match (mapconcat 'notmuch-substitute-one-command-key
870                                             (cdr (symbol-value (intern map))) "\n") 1 1 doc)))
871       (setq beg (match-end 0)))
872     doc))
873
874 (defun notmuch-help ()
875   "Display help for the current notmuch mode."
876   (interactive)
877   (let* ((mode major-mode)
878          (doc (substitute-command-keys (notmuch-substitute-command-keys (documentation mode t)))))
879     (with-current-buffer (generate-new-buffer "*notmuch-help*")
880       (insert doc)
881       (goto-char (point-min))
882       (set-buffer-modified-p nil)
883       (view-buffer (current-buffer) 'kill-buffer-if-not-modified))))
884
885 ;;;###autoload
886 (defun notmuch-show-mode ()
887   "Major mode for viewing a thread with notmuch.
888
889 This buffer contains the results of the \"notmuch show\" command
890 for displaying a single thread of email from your email archives.
891
892 By default, various components of email messages, (citations,
893 signatures, already-read messages), are hidden. You can make
894 these parts visible by clicking with the mouse button or by
895 pressing RET after positioning the cursor on a hidden part, (for
896 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
897
898 Reading the thread sequentially is well-supported by pressing
899 \\[notmuch-show-advance-marking-read-and-archiving]. This will scroll the current message (if necessary),
900 advance to the next message, or advance to the next thread (if
901 already on the last message of a thread). As each message is
902 scrolled away its \"unread\" tag will be removed, and as each
903 thread is scrolled away the \"inbox\" tag will be removed from
904 each message in the thread.
905
906 Other commands are available to read or manipulate the thread more
907 selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages without
908 removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread without
909 scrolling through with \\[notmuch-show-advance-marking-read-and-archiving]).
910
911 You can add or remove arbitary tags from the current message with
912 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
913
914 All currently available key bindings:
915
916 \\{notmuch-show-mode-map}"
917   (interactive)
918   (kill-all-local-variables)
919   (add-to-invisibility-spec 'notmuch-show-marker)
920   (use-local-map notmuch-show-mode-map)
921   (setq major-mode 'notmuch-show-mode
922         mode-name "notmuch-show")
923   (setq buffer-read-only t))
924
925 (defgroup notmuch nil
926   "Notmuch mail reader for Emacs."
927   :group 'mail)
928
929 (defcustom notmuch-show-hook nil
930   "List of functions to call when notmuch displays a message."
931   :type 'hook
932   :options '(goto-address)
933   :group 'notmuch)
934
935 (defcustom notmuch-search-hook nil
936   "List of functions to call when notmuch displays the search results."
937   :type 'hook
938   :options '(hl-line-mode)
939   :group 'notmuch)
940
941 ; Make show mode a bit prettier, highlighting URLs and using word wrap
942
943 (defun notmuch-show-pretty-hook ()
944   (goto-address-mode 1)
945   (visual-line-mode))
946
947 (add-hook 'notmuch-show-hook 'notmuch-show-pretty-hook)
948 (add-hook 'notmuch-search-hook
949           (lambda()
950             (hl-line-mode 1) ))
951
952 (defun notmuch-show (thread-id &optional parent-buffer)
953   "Run \"notmuch show\" with the given thread ID and display results.
954
955 The optional PARENT-BUFFER is the notmuch-search buffer from
956 which this notmuch-show command was executed, (so that the next
957 thread from that buffer can be show when done with this one)."
958   (interactive "sNotmuch show: ")
959   (let ((query notmuch-search-query-string)
960         (buffer (get-buffer-create (concat "*notmuch-show-" thread-id "*"))))
961     (switch-to-buffer buffer)
962     (notmuch-show-mode)
963     (set (make-local-variable 'notmuch-show-parent-buffer) parent-buffer)
964     (let ((proc (get-buffer-process (current-buffer)))
965           (inhibit-read-only t))
966       (if proc
967           (error "notmuch search process already running for query `%s'" thread-id)
968         )
969       (erase-buffer)
970       (goto-char (point-min))
971       (save-excursion
972         (call-process notmuch-command nil t nil "show" "--entire-thread" thread-id "and (" query ")")
973         (notmuch-show-markup-messages)
974         )
975       (run-hooks 'notmuch-show-hook)
976       ; Move straight to the first open message
977       (if (not (notmuch-show-message-open-p))
978           (notmuch-show-next-open-message))
979       )))
980
981 (defvar notmuch-search-authors-width 40
982   "Number of columns to use to display authors in a notmuch-search buffer.")
983
984 (defvar notmuch-search-mode-map
985   (let ((map (make-sparse-keymap)))
986     (define-key map "?" 'notmuch-help)
987     (define-key map "q" 'kill-this-buffer)
988     (define-key map "x" 'kill-this-buffer)
989     (define-key map (kbd "<DEL>") 'notmuch-search-scroll-down)
990     (define-key map "b" 'notmuch-search-scroll-down)
991     (define-key map " " 'notmuch-search-scroll-up)
992     (define-key map "<" 'notmuch-search-first-thread)
993     (define-key map ">" 'notmuch-search-last-thread)
994     (define-key map "p" 'notmuch-search-previous-thread)
995     (define-key map "n" 'notmuch-search-next-thread)
996     (define-key map "r" 'notmuch-search-reply-to-thread)
997     (define-key map "m" 'message-mail)
998     (define-key map "s" 'notmuch-search)
999     (define-key map "o" 'notmuch-search-toggle-order)
1000     (define-key map "=" 'notmuch-search-refresh-view)
1001     (define-key map "t" 'notmuch-search-filter-by-tag)
1002     (define-key map "f" 'notmuch-search-filter)
1003     (define-key map [mouse-1] 'notmuch-search-show-thread)
1004     (define-key map "*" 'notmuch-search-operate-all)
1005     (define-key map "a" 'notmuch-search-archive-thread)
1006     (define-key map "-" 'notmuch-search-remove-tag)
1007     (define-key map "+" 'notmuch-search-add-tag)
1008     (define-key map (kbd "RET") 'notmuch-search-show-thread)
1009     map)
1010   "Keymap for \"notmuch search\" buffers.")
1011 (fset 'notmuch-search-mode-map notmuch-search-mode-map)
1012
1013 (defvar notmuch-search-query-string)
1014 (defvar notmuch-search-oldest-first t
1015   "Show the oldest mail first in the search-mode")
1016
1017 (defun notmuch-search-scroll-up ()
1018   "Move forward through search results by one window's worth."
1019   (interactive)
1020   (condition-case nil
1021       (scroll-up nil)
1022     ((end-of-buffer) (notmuch-search-last-thread))))
1023
1024 (defun notmuch-search-scroll-down ()
1025   "Move backward through the search results by one window's worth."
1026   (interactive)
1027   ; I don't know why scroll-down doesn't signal beginning-of-buffer
1028   ; the way that scroll-up signals end-of-buffer, but c'est la vie.
1029   ;
1030   ; So instead of trapping a signal we instead check whether the
1031   ; window begins on the first line of the buffer and if so, move
1032   ; directly to that position. (We have to count lines since the
1033   ; window-start position is not the same as point-min due to the
1034   ; invisible thread-ID characters on the first line.
1035   (if (equal (count-lines (point-min) (window-start)) 0)
1036       (goto-char (point-min))
1037     (scroll-down nil)))
1038
1039 (defun notmuch-search-next-thread ()
1040   "Select the next thread in the search results."
1041   (interactive)
1042   (forward-line 1))
1043
1044 (defun notmuch-search-previous-thread ()
1045   "Select the previous thread in the search results."
1046   (interactive)
1047   (forward-line -1))
1048
1049 (defun notmuch-search-last-thread ()
1050   "Select the last thread in the search results."
1051   (interactive)
1052   (goto-char (point-max))
1053   (forward-line -2))
1054
1055 (defun notmuch-search-first-thread ()
1056   "Select the first thread in the search results."
1057   (interactive)
1058   (goto-char (point-min)))
1059
1060 (defface notmuch-message-summary-face
1061  '((((class color) (background light)) (:background "#f0f0f0"))
1062    (((class color) (background dark)) (:background "#303030")))
1063  "Face for the single-line message summary in notmuch-show-mode."
1064  :group 'notmuch)
1065
1066 (defface notmuch-tag-face
1067   '((((class color)
1068       (background dark))
1069      (:foreground "OliveDrab1"))
1070     (((class color)
1071       (background light))
1072      (:foreground "navy blue" :bold t))
1073     (t
1074      (:bold t)))
1075   "Notmuch search mode face used to highligh tags."
1076   :group 'notmuch)
1077
1078 (defvar notmuch-tag-face-alist nil
1079   "List containing the tag list that need to be highlighed")
1080
1081 (defvar notmuch-search-font-lock-keywords  nil)
1082
1083 ;;;###autoload
1084 (defun notmuch-search-mode ()
1085   "Major mode displaying results of a notmuch search.
1086
1087 This buffer contains the results of a \"notmuch search\" of your
1088 email archives. Each line in the buffer represents a single
1089 thread giving a summary of the thread (a relative date, the
1090 number of matched messages and total messages in the thread,
1091 participants in the thread, a representative subject line, and
1092 any tags).
1093
1094 Pressing \\[notmuch-search-show-thread] on any line displays that thread. The '\\[notmuch-search-add-tag]' and '\\[notmuch-search-remove-tag]'
1095 keys can be used to add or remove tags from a thread. The '\\[notmuch-search-archive-thread]' key
1096 is a convenience for archiving a thread (removing the \"inbox\"
1097 tag). The '\\[notmuch-search-operate-all]' key can be used to add or remove a tag from all
1098 threads in the current buffer.
1099
1100 Other useful commands are '\\[notmuch-search-filter]' for filtering the current search
1101 based on an additional query string, '\\[notmuch-search-filter-by-tag]' for filtering to include
1102 only messages with a given tag, and '\\[notmuch-search]' to execute a new, global
1103 search.
1104
1105 Complete list of currently available key bindings:
1106
1107 \\{notmuch-search-mode-map}"
1108   (interactive)
1109   (kill-all-local-variables)
1110   (make-local-variable 'notmuch-search-query-string)
1111   (make-local-variable 'notmuch-search-oldest-first)
1112   (set (make-local-variable 'scroll-preserve-screen-position) t)
1113   (add-to-invisibility-spec 'notmuch-search)
1114   (use-local-map notmuch-search-mode-map)
1115   (setq truncate-lines t)
1116   (setq major-mode 'notmuch-search-mode
1117         mode-name "notmuch-search")
1118   (setq buffer-read-only t)
1119   (if (not notmuch-tag-face-alist)
1120       (add-to-list 'notmuch-search-font-lock-keywords (list
1121                 "(\\([^)]*\\))$" '(1  'notmuch-tag-face)))
1122     (let ((notmuch-search-tags (mapcar 'car notmuch-tag-face-alist)))
1123       (loop for notmuch-search-tag  in notmuch-search-tags
1124             do (add-to-list 'notmuch-search-font-lock-keywords (list
1125                         (concat "([^)]*\\(" notmuch-search-tag "\\)[^)]*)$")
1126                         `(1  ,(cdr (assoc notmuch-search-tag notmuch-tag-face-alist))))))))
1127   (set (make-local-variable 'font-lock-defaults)
1128          '(notmuch-search-font-lock-keywords t)))
1129
1130 (defun notmuch-search-find-thread-id ()
1131   "Return the thread for the current thread"
1132   (get-text-property (point) 'notmuch-search-thread-id))
1133
1134 (defun notmuch-search-show-thread ()
1135   "Display the currently selected thread."
1136   (interactive)
1137   (let ((thread-id (notmuch-search-find-thread-id)))
1138     (if (> (length thread-id) 0)
1139         (notmuch-show thread-id (current-buffer))
1140       (error "End of search results"))))
1141
1142 (defun notmuch-search-reply-to-thread ()
1143   "Begin composing a reply to the entire current thread in a new buffer."
1144   (interactive)
1145   (let ((message-id (notmuch-search-find-thread-id)))
1146     (notmuch-reply message-id)))
1147
1148 (defun notmuch-call-notmuch-process (&rest args)
1149   "Synchronously invoke \"notmuch\" with the given list of arguments.
1150
1151 Output from the process will be presented to the user as an error
1152 and will also appear in a buffer named \"*Notmuch errors*\"."
1153   (let ((error-buffer (get-buffer-create "*Notmuch errors*")))
1154     (with-current-buffer error-buffer
1155         (erase-buffer))
1156     (if (eq (apply 'call-process notmuch-command nil error-buffer nil args) 0)
1157         (point)
1158       (progn
1159         (with-current-buffer error-buffer
1160           (let ((beg (point-min))
1161                 (end (- (point-max) 1)))
1162             (error (buffer-substring beg end))
1163             ))))))
1164
1165 (defun notmuch-search-set-tags (tags)
1166   (save-excursion
1167     (end-of-line)
1168     (re-search-backward "(")
1169     (forward-char)
1170     (let ((beg (point))
1171           (inhibit-read-only t))
1172       (re-search-forward ")")
1173       (backward-char)
1174       (let ((end (point)))
1175         (delete-region beg end)
1176         (insert (mapconcat  'identity tags " "))))))
1177
1178 (defun notmuch-search-get-tags ()
1179   (save-excursion
1180     (end-of-line)
1181     (re-search-backward "(")
1182     (let ((beg (+ (point) 1)))
1183       (re-search-forward ")")
1184       (let ((end (- (point) 1)))
1185         (split-string (buffer-substring beg end))))))
1186
1187 (defun notmuch-search-add-tag (tag)
1188   "Add a tag to the currently selected thread.
1189
1190 The tag is added to messages in the currently selected thread
1191 which match the current search terms."
1192   (interactive
1193    (list (notmuch-select-tag-with-completion "Tag to add: ")))
1194   (notmuch-call-notmuch-process "tag" (concat "+" tag) (notmuch-search-find-thread-id) " and " notmuch-search-query-string)
1195   (notmuch-search-set-tags (delete-dups (sort (cons tag (notmuch-search-get-tags)) 'string<))))
1196
1197 (defun notmuch-search-remove-tag (tag)
1198   "Remove a tag from the currently selected thread.
1199
1200 The tag is removed from messages in the currently selected thread
1201 which match the current search terms."
1202   (interactive
1203    (list (notmuch-select-tag-with-completion "Tag to remove: " (notmuch-search-find-thread-id))))
1204   (notmuch-call-notmuch-process "tag" (concat "-" tag) (notmuch-search-find-thread-id) " and " notmuch-search-query-string)
1205   (notmuch-search-set-tags (delete tag (notmuch-search-get-tags))))
1206
1207 (defun notmuch-search-archive-thread ()
1208   "Archive the currently selected thread (remove its \"inbox\" tag).
1209
1210 This function advances the next thread when finished."
1211   (interactive)
1212   (notmuch-search-remove-tag "inbox")
1213   (forward-line))
1214
1215 (defun notmuch-search-process-sentinel (proc msg)
1216   "Add a message to let user know when \"notmuch search\" exits"
1217   (let ((buffer (process-buffer proc))
1218         (status (process-status proc))
1219         (exit-status (process-exit-status proc)))
1220     (if (memq status '(exit signal))
1221         (if (buffer-live-p buffer)
1222             (with-current-buffer buffer
1223               (save-excursion
1224                 (let ((inhibit-read-only t))
1225                   (goto-char (point-max))
1226                   (if (eq status 'signal)
1227                       (insert "Incomplete search results (search process was killed).\n"))
1228                   (if (eq status 'exit)
1229                       (progn
1230                         (insert "End of search results.")
1231                         (if (not (= exit-status 0))
1232                             (insert (format " (process returned %d)" exit-status)))
1233                         (insert "\n"))))))))))
1234
1235 (defun notmuch-search-process-filter (proc string)
1236   "Process and filter the output of \"notmuch search\""
1237   (let ((buffer (process-buffer proc)))
1238     (if (buffer-live-p buffer)
1239         (with-current-buffer buffer
1240           (save-excursion
1241             (let ((line 0)
1242                   (more t)
1243                   (inhibit-read-only t))
1244               (while more
1245                 (if (string-match "^\\(thread:[0-9A-Fa-f]*\\) \\(.*\\) \\(\\[[0-9/]*\\]\\) \\([^:]*\\); \\(.*\\) (\\([^()]*\\))$" string line)
1246                     (let* ((thread-id (match-string 1 string))
1247                            (date (match-string 2 string))
1248                            (count (match-string 3 string))
1249                            (authors (match-string 4 string))
1250                            (authors-length (length authors))
1251                            (subject (match-string 5 string))
1252                            (tags (match-string 6 string)))
1253                       (if (> authors-length 40)
1254                           (set 'authors (concat (substring authors 0 (- 40 3)) "...")))
1255                       (goto-char (point-max))
1256                       (let ((beg (point-marker)))
1257                         (insert (format "%s %-7s %-40s %s (%s)\n" date count authors subject tags))
1258                         (put-text-property beg (point-marker) 'notmuch-search-thread-id thread-id))
1259                       (set 'line (match-end 0)))
1260                   (set 'more nil))))))
1261       (delete-process proc))))
1262
1263 (defun notmuch-search-operate-all (action)
1264   "Add/remove tags from all matching messages.
1265
1266 Tis command adds or removes tags from all messages matching the
1267 current search terms. When called interactively, this command
1268 will prompt for tags to be added or removed. Tags prefixed with
1269 '+' will be added and tags prefixed with '-' will be removed.
1270
1271 Each character of the tag name may consist of alphanumeric
1272 characters as well as `_.+-'.
1273 "
1274   (interactive "sOperation (+add -drop): notmuch tag ")
1275   (let ((action-split (split-string action " +")))
1276     ;; Perform some validation
1277     (let ((words action-split))
1278       (when (null words) (error "No operation given"))
1279       (while words
1280         (unless (string-match-p "^[-+][-+_.[:word:]]+$" (car words))
1281           (error "Action must be of the form `+thistag -that_tag'"))
1282         (setq words (cdr words))))
1283     (apply 'notmuch-call-notmuch-process "tag"
1284            (append action-split (list notmuch-search-query-string) nil))))
1285
1286 ;;;###autoload
1287 (defun notmuch-search (query &optional oldest-first)
1288   "Run \"notmuch search\" with the given query string and display results."
1289   (interactive "sNotmuch search: ")
1290   (let ((buffer (get-buffer-create (concat "*notmuch-search-" query "*"))))
1291     (switch-to-buffer buffer)
1292     (notmuch-search-mode)
1293     (set 'notmuch-search-query-string query)
1294     (set 'notmuch-search-oldest-first oldest-first)
1295     (let ((proc (get-buffer-process (current-buffer)))
1296           (inhibit-read-only t))
1297       (if proc
1298           (error "notmuch search process already running for query `%s'" query)
1299         )
1300       (erase-buffer)
1301       (goto-char (point-min))
1302       (save-excursion
1303         (let ((proc (start-process-shell-command
1304                      "notmuch-search" buffer notmuch-command "search"
1305                      (if oldest-first "--sort=oldest-first" "--sort=newest-first")
1306                      (shell-quote-argument query))))
1307           (set-process-sentinel proc 'notmuch-search-process-sentinel)
1308           (set-process-filter proc 'notmuch-search-process-filter))))
1309     (run-hooks 'notmuch-search-hook)))
1310
1311 (defun notmuch-search-refresh-view ()
1312   "Refresh the current view.
1313
1314 Kills the current buffer and runs a new search with the same
1315 query string as the current search. If the current thread is in
1316 the new search results, then point will be placed on the same
1317 thread. Otherwise, point will be moved to attempt to be in the
1318 same relative position within the new buffer."
1319   (interactive)
1320   (let ((here (point))
1321         (oldest-first notmuch-search-oldest-first)
1322         (thread (notmuch-search-find-thread-id))
1323         (query notmuch-search-query-string))
1324     (kill-this-buffer)
1325     (notmuch-search query oldest-first)
1326     (goto-char (point-min))
1327     (if (re-search-forward (concat "^" thread) nil t)
1328         (beginning-of-line)
1329       (goto-char here))))
1330
1331 (defun notmuch-search-toggle-order ()
1332   "Toggle the current search order.
1333
1334 By default, the \"inbox\" view created by `notmuch' is displayed
1335 in chronological order (oldest thread at the beginning of the
1336 buffer), while any global searches created by `notmuch-search'
1337 are displayed in reverse-chronological order (newest thread at
1338 the beginning of the buffer).
1339
1340 This command toggles the sort order for the current search.
1341
1342 Note that any filtered searches created by
1343 `notmuch-search-filter' retain the search order of the parent
1344 search."
1345   (interactive)
1346   (set 'notmuch-search-oldest-first (not notmuch-search-oldest-first))
1347   (notmuch-search-refresh-view))
1348
1349 (defun notmuch-search-filter (query)
1350   "Filter the current search results based on an additional query string.
1351
1352 Runs a new search matching only messages that match both the
1353 current search results AND the additional query string provided."
1354   (interactive "sFilter search: ")
1355   (notmuch-search (concat notmuch-search-query-string " and " query) notmuch-search-oldest-first))
1356
1357 (defun notmuch-search-filter-by-tag (tag)
1358   "Filter the current search results based on a single tag.
1359
1360 Runs a new search matching only messages that match both the
1361 current search results AND that are tagged with the given tag."
1362   (interactive
1363    (list (notmuch-select-tag-with-completion "Filter by tag: ")))
1364   (notmuch-search (concat notmuch-search-query-string " and tag:" tag) notmuch-search-oldest-first))
1365
1366
1367 ;;;###autoload
1368 (defun notmuch ()
1369   "Run notmuch to display all mail with tag of 'inbox'"
1370   (interactive)
1371   (notmuch-search "tag:inbox" notmuch-search-oldest-first))
1372
1373 (setq mail-user-agent 'message-user-agent)
1374
1375 (defvar notmuch-folder-mode-map
1376   (let ((map (make-sparse-keymap)))
1377     (define-key map "?" 'notmuch-help)
1378     (define-key map "x" 'kill-this-buffer)
1379     (define-key map "q" 'kill-this-buffer)
1380     (define-key map ">" 'notmuch-folder-last)
1381     (define-key map "<" 'notmuch-folder-first)
1382     (define-key map "=" 'notmuch-folder)
1383     (define-key map "s" 'notmuch-search)
1384     (define-key map [mouse-1] 'notmuch-folder-show-search)
1385     (define-key map (kbd "RET") 'notmuch-folder-show-search)
1386     (define-key map "p" 'notmuch-folder-previous)
1387     (define-key map "n" 'notmuch-folder-next)
1388     map)
1389   "Keymap for \"notmuch folder\" buffers.")
1390
1391 (fset 'notmuch-folder-mode-map notmuch-folder-mode-map)
1392
1393 (defcustom notmuch-folders (quote (("inbox" . "tag:inbox") ("unread" . "tag:unread")))
1394   "List of searches for the notmuch folder view"
1395   :type '(alist :key-type (string) :value-type (string))
1396   :group 'notmuch)
1397
1398 (defun notmuch-folder-mode ()
1399   "Major mode for showing notmuch 'folders'.
1400
1401 This buffer contains a list of message counts returned by a
1402 customizable set of searches of your email archives. Each line in
1403 the buffer shows the name of a saved search and the resulting
1404 message count.
1405
1406 Pressing RET on any line opens a search window containing the
1407 results for the saved search on that line.
1408
1409 Here is an example of how the search list could be
1410 customized, (the following text would be placed in your ~/.emacs
1411 file):
1412
1413 (setq notmuch-folders '((\"inbox\" . \"tag:inbox\")
1414                         (\"unread\" . \"tag:inbox AND tag:unread\")
1415                         (\"notmuch\" . \"tag:inbox AND to:notmuchmail.org\")))
1416
1417 Of course, you can have any number of folders, each configured
1418 with any supported search terms (see \"notmuch help search-terms\").
1419
1420 Currently available key bindings:
1421
1422 \\{notmuch-folder-mode-map}"
1423   (interactive)
1424   (kill-all-local-variables)
1425   (use-local-map 'notmuch-folder-mode-map)
1426   (setq truncate-lines t)
1427   (hl-line-mode 1)
1428   (setq major-mode 'notmuch-folder-mode
1429         mode-name "notmuch-folder")
1430   (setq buffer-read-only t))
1431
1432 (defun notmuch-folder-next ()
1433   "Select the next folder in the list."
1434   (interactive)
1435   (forward-line 1)
1436   (if (eobp)
1437       (forward-line -1)))
1438
1439 (defun notmuch-folder-previous ()
1440   "Select the previous folder in the list."
1441   (interactive)
1442   (forward-line -1))
1443
1444 (defun notmuch-folder-first ()
1445   "Select the first folder in the list."
1446   (interactive)
1447   (goto-char (point-min)))
1448
1449 (defun notmuch-folder-last ()
1450   "Select the last folder in the list."
1451   (interactive)
1452   (goto-char (point-max))
1453   (forward-line -1))
1454
1455 (defun notmuch-folder-add (folders)
1456   (if folders
1457       (let ((name (car (car folders)))
1458             (inhibit-read-only t)
1459             (search (cdr (car folders))))
1460         (insert name)
1461         (indent-to 16 1)
1462         (call-process notmuch-command nil t nil "count" search)
1463         (notmuch-folder-add (cdr folders)))))
1464
1465 (defun notmuch-folder-find-name ()
1466   (save-excursion
1467     (beginning-of-line)
1468     (let ((beg (point)))
1469       (forward-word)
1470       (filter-buffer-substring beg (point)))))
1471
1472 (defun notmuch-folder-show-search (&optional folder)
1473   "Show a search window for the search related to the specified folder."
1474   (interactive)
1475   (if (null folder)
1476       (setq folder (notmuch-folder-find-name)))
1477   (let ((search (assoc folder notmuch-folders)))
1478     (if search
1479         (notmuch-search (cdr search) notmuch-search-oldest-first))))
1480
1481 ;;;###autoload
1482 (defun notmuch-folder ()
1483   "Show the notmuch folder view and update the displayed counts."
1484   (interactive)
1485   (let ((buffer (get-buffer-create "*notmuch-folders*")))
1486     (switch-to-buffer buffer)
1487     (let ((inhibit-read-only t)
1488           (n (line-number-at-pos)))
1489       (erase-buffer)
1490       (notmuch-folder-mode)
1491       (notmuch-folder-add notmuch-folders)
1492       (goto-char (point-min))
1493       (goto-line n))))
1494
1495 (provide 'notmuch)