emacs: Make message-summary button extend to very beginning of message.
[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-regexp " depth:\\([0-9]*\\) ")
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 btn)
688   (re-search-forward notmuch-show-body-begin-regexp)
689   (forward-line)
690   (let ((beg (point-marker)))
691     (re-search-forward notmuch-show-body-end-regexp)
692     (let ((end (copy-marker (match-beginning 0))))
693       (notmuch-show-markup-parts-region beg end depth)
694       (let ((invis-spec (make-symbol "notmuch-show-body-read")))
695         (overlay-put (make-overlay beg end)
696                      'invisible invis-spec)
697         (button-put btn 'invisibility-spec invis-spec)
698         (if (not (notmuch-show-message-unread-p))
699             (add-to-invisibility-spec invis-spec)))
700       (set-marker beg nil)
701       (set-marker end nil)
702       )))
703
704 (defun notmuch-fontify-headers ()
705   (while (looking-at "[[:space:]]")
706     (forward-char))
707   (if (looking-at "[Tt]o:")
708       (progn
709         (overlay-put (make-overlay (point) (re-search-forward ":"))
710                      'face 'message-header-name)
711         (overlay-put (make-overlay (point) (re-search-forward ".*$"))
712                      'face 'message-header-to))
713     (if (looking-at "[B]?[Cc][Cc]:")
714         (progn
715           (overlay-put (make-overlay (point) (re-search-forward ":"))
716                        'face 'message-header-name)
717           (overlay-put (make-overlay (point) (re-search-forward ".*$"))
718                        'face 'message-header-cc))
719       (if (looking-at "[Ss]ubject:")
720           (progn
721             (overlay-put (make-overlay (point) (re-search-forward ":"))
722                          'face 'message-header-name)
723             (overlay-put (make-overlay (point) (re-search-forward ".*$"))
724                          'face 'message-header-subject))
725         (if (looking-at "[Ff]rom:")
726             (progn
727               (overlay-put (make-overlay (point) (re-search-forward ":"))
728                            'face 'message-header-name)
729               (overlay-put (make-overlay (point) (re-search-forward ".*$"))
730                            'face 'message-header-other)))))))
731
732 (defun notmuch-show-markup-header (message-begin depth)
733   "Buttonize and decorate faces in a message header.
734
735 MESSAGE-BEGIN is the position of the absolute first character in
736 the message (including all delimiters that will end up being
737 invisible etc.). This is to allow a button to reliably extend to
738 the beginning of the message even if point is positioned at an
739 invisible character (such as the beginning of the buffer).
740
741 DEPTH specifies the depth at which this message appears in the
742 tree of the current thread, (the top-level messages have depth 0
743 and each reply increases depth by 1)."
744   (re-search-forward notmuch-show-header-begin-regexp)
745   (forward-line)
746   (let ((beg (point-marker))
747         (summary-end (copy-marker (line-beginning-position 2)))
748         (subject-end (copy-marker (line-end-position 2)))
749         (invis-spec (make-symbol "notmuch-show-header"))
750         (btn nil))
751     (re-search-forward notmuch-show-header-end-regexp)
752     (beginning-of-line)
753     (let ((end (point-marker)))
754       (indent-rigidly beg end depth)
755       (goto-char beg)
756       (setq btn (make-button message-begin summary-end :type 'notmuch-button-body-toggle-type))
757       (forward-line)
758       (add-to-invisibility-spec invis-spec)
759       (overlay-put (make-overlay subject-end end)
760                    'invisible invis-spec)
761       (make-button (line-beginning-position) subject-end
762                    'invisibility-spec invis-spec
763                    :type 'notmuch-button-headers-toggle-type)
764       (while (looking-at "[[:space:]]*[A-Za-z][-A-Za-z0-9]*:")
765         (beginning-of-line)
766         (notmuch-fontify-headers)
767         (forward-line)
768         )
769       (goto-char end)
770       (insert "\n")
771       (set-marker beg nil)
772       (set-marker summary-end nil)
773       (set-marker subject-end nil)
774       (set-marker end nil)
775       )
776   btn))
777
778 (defun notmuch-show-markup-message ()
779   (if (re-search-forward notmuch-show-message-begin-regexp nil t)
780       (let ((message-begin (match-beginning 0)))
781         (re-search-forward notmuch-show-depth-regexp)
782         (let ((depth (string-to-number (buffer-substring (match-beginning 1) (match-end 1))))
783               (btn nil))
784           (setq btn (notmuch-show-markup-header message-begin depth))
785           (notmuch-show-markup-body depth btn)))
786     (goto-char (point-max))))
787
788 (defun notmuch-show-hide-markers ()
789   (save-excursion
790     (goto-char (point-min))
791     (while (not (eobp))
792       (if (re-search-forward notmuch-show-marker-regexp nil t)
793           (progn
794             (overlay-put (make-overlay (match-beginning 0) (+ (match-end 0) 1))
795                          'invisible 'notmuch-show-marker))
796         (goto-char (point-max))))))
797
798 (defun notmuch-show-markup-messages ()
799   (save-excursion
800     (goto-char (point-min))
801     (while (not (eobp))
802       (notmuch-show-markup-message)))
803   (notmuch-show-hide-markers))
804
805 (defun notmuch-documentation-first-line (symbol)
806   "Return the first line of the documentation string for SYMBOL."
807   (let ((doc (documentation symbol)))
808     (if doc
809         (with-temp-buffer
810           (insert (documentation symbol t))
811           (goto-char (point-min))
812           (let ((beg (point)))
813             (end-of-line)
814             (buffer-substring beg (point))))
815       "")))
816
817 (defun notmuch-prefix-key-description (key)
818   "Given a prefix key code, return a human-readable string representation.
819
820 This is basically just `format-kbd-macro' but we also convert ESC to M-."
821   (let ((desc (format-kbd-macro (vector key))))
822     (if (string= desc "ESC")
823         "M-"
824       (concat desc " "))))
825
826 ; I would think that emacs would have code handy for walking a keymap
827 ; and generating strings for each key, and I would prefer to just call
828 ; that. But I couldn't find any (could be all implemented in C I
829 ; suppose), so I wrote my own here.
830 (defun notmuch-substitute-one-command-key-with-prefix (prefix binding)
831   "For a key binding, return a string showing a human-readable
832 representation of the prefixed key as well as the first line of
833 documentation from the bound function.
834
835 For a mouse binding, return nil."
836   (let ((key (car binding))
837         (action (cdr binding)))
838     (if (mouse-event-p key)
839         nil
840       (if (keymapp action)
841           (let ((substitute (apply-partially 'notmuch-substitute-one-command-key-with-prefix (notmuch-prefix-key-description key))))
842             (mapconcat substitute (cdr action) "\n"))
843         (concat prefix (format-kbd-macro (vector key))
844                 "\t"
845                 (notmuch-documentation-first-line action))))))
846
847 (defalias 'notmuch-substitute-one-command-key
848   (apply-partially 'notmuch-substitute-one-command-key-with-prefix nil))
849
850 (defun notmuch-substitute-command-keys (doc)
851   "Like `substitute-command-keys' but with documentation, not function names."
852   (let ((beg 0))
853     (while (string-match "\\\\{\\([^}[:space:]]*\\)}" doc beg)
854       (let ((map (substring doc (match-beginning 1) (match-end 1))))
855         (setq doc (replace-match (mapconcat 'notmuch-substitute-one-command-key
856                                             (cdr (symbol-value (intern map))) "\n") 1 1 doc)))
857       (setq beg (match-end 0)))
858     doc))
859
860 (defun notmuch-help ()
861   "Display help for the current notmuch mode."
862   (interactive)
863   (let* ((mode major-mode)
864          (doc (substitute-command-keys (notmuch-substitute-command-keys (documentation mode t)))))
865     (with-current-buffer (generate-new-buffer "*notmuch-help*")
866       (insert doc)
867       (goto-char (point-min))
868       (set-buffer-modified-p nil)
869       (view-buffer (current-buffer) 'kill-buffer-if-not-modified))))
870
871 ;;;###autoload
872 (defun notmuch-show-mode ()
873   "Major mode for viewing a thread with notmuch.
874
875 This buffer contains the results of the \"notmuch show\" command
876 for displaying a single thread of email from your email archives.
877
878 By default, various components of email messages, (citations,
879 signatures, already-read messages), are hidden. You can make
880 these parts visible by clicking with the mouse button or by
881 pressing RET after positioning the cursor on a hidden part, (for
882 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
883
884 Reading the thread sequentially is well-supported by pressing
885 \\[notmuch-show-advance-marking-read-and-archiving]. This will scroll the current message (if necessary),
886 advance to the next message, or advance to the next thread (if
887 already on the last message of a thread). As each message is
888 scrolled away its \"unread\" tag will be removed, and as each
889 thread is scrolled away the \"inbox\" tag will be removed from
890 each message in the thread.
891
892 Other commands are available to read or manipulate the thread more
893 selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages without
894 removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread without
895 scrolling through with \\[notmuch-show-advance-marking-read-and-archiving]).
896
897 You can add or remove arbitary tags from the current message with
898 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
899
900 All currently available key bindings:
901
902 \\{notmuch-show-mode-map}"
903   (interactive)
904   (kill-all-local-variables)
905   (add-to-invisibility-spec 'notmuch-show-marker)
906   (use-local-map notmuch-show-mode-map)
907   (setq major-mode 'notmuch-show-mode
908         mode-name "notmuch-show")
909   (setq buffer-read-only t))
910
911 (defgroup notmuch nil
912   "Notmuch mail reader for Emacs."
913   :group 'mail)
914
915 (defcustom notmuch-show-hook nil
916   "List of functions to call when notmuch displays a message."
917   :type 'hook
918   :options '(goto-address)
919   :group 'notmuch)
920
921 (defcustom notmuch-search-hook nil
922   "List of functions to call when notmuch displays the search results."
923   :type 'hook
924   :options '(hl-line-mode)
925   :group 'notmuch)
926
927 ; Make show mode a bit prettier, highlighting URLs and using word wrap
928
929 (defun notmuch-show-pretty-hook ()
930   (goto-address-mode 1)
931   (visual-line-mode))
932
933 (add-hook 'notmuch-show-hook 'notmuch-show-pretty-hook)
934 (add-hook 'notmuch-search-hook
935           (lambda()
936             (hl-line-mode 1) ))
937
938 (defun notmuch-show (thread-id &optional parent-buffer)
939   "Run \"notmuch show\" with the given thread ID and display results.
940
941 The optional PARENT-BUFFER is the notmuch-search buffer from
942 which this notmuch-show command was executed, (so that the next
943 thread from that buffer can be show when done with this one)."
944   (interactive "sNotmuch show: ")
945   (let ((buffer (get-buffer-create (concat "*notmuch-show-" thread-id "*"))))
946     (switch-to-buffer buffer)
947     (notmuch-show-mode)
948     (set (make-local-variable 'notmuch-show-parent-buffer) parent-buffer)
949     (let ((proc (get-buffer-process (current-buffer)))
950           (inhibit-read-only t))
951       (if proc
952           (error "notmuch search process already running for query `%s'" thread-id)
953         )
954       (erase-buffer)
955       (goto-char (point-min))
956       (save-excursion
957         (call-process notmuch-command nil t nil "show" "--entire-thread" thread-id)
958         (notmuch-show-markup-messages)
959         )
960       (run-hooks 'notmuch-show-hook)
961       ; Move straight to the first unread message
962       (if (not (notmuch-show-message-unread-p))
963           (progn
964             (notmuch-show-next-unread-message)
965             ; But if there are no unread messages, go back to the
966             ; beginning of the buffer, and open up the bodies of all
967             ; read message.
968             (if (not (notmuch-show-message-unread-p))
969                 (progn
970                   (goto-char (point-min))
971                   (let ((btn (forward-button 1)))
972                     (while btn
973                       (if (button-has-type-p btn 'notmuch-button-body-toggle-type)
974                           (push-button))
975                       (condition-case err
976                           (setq btn (forward-button 1))
977                         (error (setq btn nil)))
978                     ))
979                   (goto-char (point-min))
980                   ))))
981       )))
982
983 (defvar notmuch-search-authors-width 40
984   "Number of columns to use to display authors in a notmuch-search buffer.")
985
986 (defvar notmuch-search-mode-map
987   (let ((map (make-sparse-keymap)))
988     (define-key map "?" 'notmuch-help)
989     (define-key map "q" 'kill-this-buffer)
990     (define-key map "x" 'kill-this-buffer)
991     (define-key map (kbd "<DEL>") 'notmuch-search-scroll-down)
992     (define-key map "b" 'notmuch-search-scroll-down)
993     (define-key map " " 'notmuch-search-scroll-up)
994     (define-key map "<" 'notmuch-search-first-thread)
995     (define-key map ">" 'notmuch-search-last-thread)
996     (define-key map "p" 'notmuch-search-previous-thread)
997     (define-key map "n" 'notmuch-search-next-thread)
998     (define-key map "r" 'notmuch-search-reply-to-thread)
999     (define-key map "m" 'message-mail)
1000     (define-key map "s" 'notmuch-search)
1001     (define-key map "o" 'notmuch-search-toggle-order)
1002     (define-key map "=" 'notmuch-search-refresh-view)
1003     (define-key map "t" 'notmuch-search-filter-by-tag)
1004     (define-key map "f" 'notmuch-search-filter)
1005     (define-key map [mouse-1] 'notmuch-search-show-thread)
1006     (define-key map "*" 'notmuch-search-operate-all)
1007     (define-key map "a" 'notmuch-search-archive-thread)
1008     (define-key map "-" 'notmuch-search-remove-tag)
1009     (define-key map "+" 'notmuch-search-add-tag)
1010     (define-key map (kbd "RET") 'notmuch-search-show-thread)
1011     map)
1012   "Keymap for \"notmuch search\" buffers.")
1013 (fset 'notmuch-search-mode-map notmuch-search-mode-map)
1014
1015 (defvar notmuch-search-query-string)
1016 (defvar notmuch-search-oldest-first t
1017   "Show the oldest mail first in the search-mode")
1018
1019 (defun notmuch-search-scroll-up ()
1020   "Move forward through search results by one window's worth."
1021   (interactive)
1022   (condition-case nil
1023       (scroll-up nil)
1024     ((end-of-buffer) (notmuch-search-last-thread))))
1025
1026 (defun notmuch-search-scroll-down ()
1027   "Move backward through the search results by one window's worth."
1028   (interactive)
1029   ; I don't know why scroll-down doesn't signal beginning-of-buffer
1030   ; the way that scroll-up signals end-of-buffer, but c'est la vie.
1031   ;
1032   ; So instead of trapping a signal we instead check whether the
1033   ; window begins on the first line of the buffer and if so, move
1034   ; directly to that position. (We have to count lines since the
1035   ; window-start position is not the same as point-min due to the
1036   ; invisible thread-ID characters on the first line.
1037   (if (equal (count-lines (point-min) (window-start)) 0)
1038       (goto-char (point-min))
1039     (scroll-down nil)))
1040
1041 (defun notmuch-search-next-thread ()
1042   "Select the next thread in the search results."
1043   (interactive)
1044   (forward-line 1))
1045
1046 (defun notmuch-search-previous-thread ()
1047   "Select the previous thread in the search results."
1048   (interactive)
1049   (forward-line -1))
1050
1051 (defun notmuch-search-last-thread ()
1052   "Select the last thread in the search results."
1053   (interactive)
1054   (goto-char (point-max))
1055   (forward-line -2))
1056
1057 (defun notmuch-search-first-thread ()
1058   "Select the first thread in the search results."
1059   (interactive)
1060   (goto-char (point-min)))
1061
1062 (defface notmuch-message-summary-face
1063  '((((class color) (background light)) (:background "#f0f0f0"))
1064    (((class color) (background dark)) (:background "#303030")))
1065  "Face for the single-line message summary in notmuch-show-mode."
1066  :group 'notmuch)
1067
1068 (defface notmuch-tag-face
1069   '((((class color)
1070       (background dark))
1071      (:foreground "OliveDrab1"))
1072     (((class color)
1073       (background light))
1074      (:foreground "navy blue" :bold t))
1075     (t
1076      (:bold t)))
1077   "Notmuch search mode face used to highligh tags."
1078   :group 'notmuch)
1079
1080 (defvar notmuch-tag-face-alist nil
1081   "List containing the tag list that need to be highlighed")
1082
1083 (defvar notmuch-search-font-lock-keywords  nil)
1084
1085 ;;;###autoload
1086 (defun notmuch-search-mode ()
1087   "Major mode displaying results of a notmuch search.
1088
1089 This buffer contains the results of a \"notmuch search\" of your
1090 email archives. Each line in the buffer represents a single
1091 thread giving a summary of the thread (a relative date, the
1092 number of matched messages and total messages in the thread,
1093 participants in the thread, a representative subject line, and
1094 any tags).
1095
1096 Pressing \\[notmuch-search-show-thread] on any line displays that thread. The '\\[notmuch-search-add-tag]' and '\\[notmuch-search-remove-tag]'
1097 keys can be used to add or remove tags from a thread. The '\\[notmuch-search-archive-thread]' key
1098 is a convenience for archiving a thread (removing the \"inbox\"
1099 tag). The '\\[notmuch-search-operate-all]' key can be used to add or remove a tag from all
1100 threads in the current buffer.
1101
1102 Other useful commands are '\\[notmuch-search-filter]' for filtering the current search
1103 based on an additional query string, '\\[notmuch-search-filter-by-tag]' for filtering to include
1104 only messages with a given tag, and '\\[notmuch-search]' to execute a new, global
1105 search.
1106
1107 Complete list of currently available key bindings:
1108
1109 \\{notmuch-search-mode-map}"
1110   (interactive)
1111   (kill-all-local-variables)
1112   (make-local-variable 'notmuch-search-query-string)
1113   (make-local-variable 'notmuch-search-oldest-first)
1114   (set (make-local-variable 'scroll-preserve-screen-position) t)
1115   (add-to-invisibility-spec 'notmuch-search)
1116   (use-local-map notmuch-search-mode-map)
1117   (setq truncate-lines t)
1118   (setq major-mode 'notmuch-search-mode
1119         mode-name "notmuch-search")
1120   (setq buffer-read-only t)
1121   (if (not notmuch-tag-face-alist)
1122       (add-to-list 'notmuch-search-font-lock-keywords (list
1123                 "(\\([^)]*\\))$" '(1  'notmuch-tag-face)))
1124     (let ((notmuch-search-tags (mapcar 'car notmuch-tag-face-alist)))
1125       (loop for notmuch-search-tag  in notmuch-search-tags
1126             do (add-to-list 'notmuch-search-font-lock-keywords (list
1127                         (concat "([^)]*\\(" notmuch-search-tag "\\)[^)]*)$")
1128                         `(1  ,(cdr (assoc notmuch-search-tag notmuch-tag-face-alist))))))))
1129   (set (make-local-variable 'font-lock-defaults)
1130          '(notmuch-search-font-lock-keywords t)))
1131
1132 (defun notmuch-search-find-thread-id ()
1133   "Return the thread for the current thread"
1134   (get-text-property (point) 'notmuch-search-thread-id))
1135
1136 (defun notmuch-search-show-thread ()
1137   "Display the currently selected thread."
1138   (interactive)
1139   (let ((thread-id (notmuch-search-find-thread-id)))
1140     (if (> (length thread-id) 0)
1141         (notmuch-show thread-id (current-buffer))
1142       (error "End of search results"))))
1143
1144 (defun notmuch-search-reply-to-thread ()
1145   "Begin composing a reply to the entire current thread in a new buffer."
1146   (interactive)
1147   (let ((message-id (notmuch-search-find-thread-id)))
1148     (notmuch-reply message-id)))
1149
1150 (defun notmuch-call-notmuch-process (&rest args)
1151   "Synchronously invoke \"notmuch\" with the given list of arguments.
1152
1153 Output from the process will be presented to the user as an error
1154 and will also appear in a buffer named \"*Notmuch errors*\"."
1155   (let ((error-buffer (get-buffer-create "*Notmuch errors*")))
1156     (with-current-buffer error-buffer
1157         (erase-buffer))
1158     (if (eq (apply 'call-process notmuch-command nil error-buffer nil args) 0)
1159         (point)
1160       (progn
1161         (with-current-buffer error-buffer
1162           (let ((beg (point-min))
1163                 (end (- (point-max) 1)))
1164             (error (buffer-substring beg end))
1165             ))))))
1166
1167 (defun notmuch-search-set-tags (tags)
1168   (save-excursion
1169     (end-of-line)
1170     (re-search-backward "(")
1171     (forward-char)
1172     (let ((beg (point))
1173           (inhibit-read-only t))
1174       (re-search-forward ")")
1175       (backward-char)
1176       (let ((end (point)))
1177         (delete-region beg end)
1178         (insert (mapconcat  'identity tags " "))))))
1179
1180 (defun notmuch-search-get-tags ()
1181   (save-excursion
1182     (end-of-line)
1183     (re-search-backward "(")
1184     (let ((beg (+ (point) 1)))
1185       (re-search-forward ")")
1186       (let ((end (- (point) 1)))
1187         (split-string (buffer-substring beg end))))))
1188
1189 (defun notmuch-search-add-tag (tag)
1190   "Add a tag to the currently selected thread.
1191
1192 The tag is added to messages in the currently selected thread
1193 which match the current search terms."
1194   (interactive
1195    (list (notmuch-select-tag-with-completion "Tag to add: ")))
1196   (notmuch-call-notmuch-process "tag" (concat "+" tag) (notmuch-search-find-thread-id) " and " notmuch-search-query-string)
1197   (notmuch-search-set-tags (delete-dups (sort (cons tag (notmuch-search-get-tags)) 'string<))))
1198
1199 (defun notmuch-search-remove-tag (tag)
1200   "Remove a tag from the currently selected thread.
1201
1202 The tag is removed from messages in the currently selected thread
1203 which match the current search terms."
1204   (interactive
1205    (list (notmuch-select-tag-with-completion "Tag to remove: " (notmuch-search-find-thread-id))))
1206   (notmuch-call-notmuch-process "tag" (concat "-" tag) (notmuch-search-find-thread-id) " and " notmuch-search-query-string)
1207   (notmuch-search-set-tags (delete tag (notmuch-search-get-tags))))
1208
1209 (defun notmuch-search-archive-thread ()
1210   "Archive the currently selected thread (remove its \"inbox\" tag).
1211
1212 This function advances the next thread when finished."
1213   (interactive)
1214   (notmuch-search-remove-tag "inbox")
1215   (forward-line))
1216
1217 (defun notmuch-search-process-sentinel (proc msg)
1218   "Add a message to let user know when \"notmuch search\" exits"
1219   (let ((buffer (process-buffer proc))
1220         (status (process-status proc))
1221         (exit-status (process-exit-status proc)))
1222     (if (memq status '(exit signal))
1223         (if (buffer-live-p buffer)
1224             (with-current-buffer buffer
1225               (save-excursion
1226                 (let ((inhibit-read-only t))
1227                   (goto-char (point-max))
1228                   (if (eq status 'signal)
1229                       (insert "Incomplete search results (search process was killed).\n"))
1230                   (if (eq status 'exit)
1231                       (progn
1232                         (insert "End of search results.")
1233                         (if (not (= exit-status 0))
1234                             (insert (format " (process returned %d)" exit-status)))
1235                         (insert "\n"))))))))))
1236
1237 (defun notmuch-search-process-filter (proc string)
1238   "Process and filter the output of \"notmuch search\""
1239   (let ((buffer (process-buffer proc)))
1240     (if (buffer-live-p buffer)
1241         (with-current-buffer buffer
1242           (save-excursion
1243             (let ((line 0)
1244                   (more t)
1245                   (inhibit-read-only t))
1246               (while more
1247                 (if (string-match "^\\(thread:[0-9A-Fa-f]*\\) \\(.*\\) \\(\\[[0-9/]*\\]\\) \\([^:]*\\); \\(.*\\) (\\([^()]*\\))$" string line)
1248                     (let* ((thread-id (match-string 1 string))
1249                            (date (match-string 2 string))
1250                            (count (match-string 3 string))
1251                            (authors (match-string 4 string))
1252                            (authors-length (length authors))
1253                            (subject (match-string 5 string))
1254                            (tags (match-string 6 string)))
1255                       (if (> authors-length 40)
1256                           (set 'authors (concat (substring authors 0 (- 40 3)) "...")))
1257                       (goto-char (point-max))
1258                       (let ((beg (point-marker)))
1259                         (insert (format "%s %-7s %-40s %s (%s)\n" date count authors subject tags))
1260                         (put-text-property beg (point-marker) 'notmuch-search-thread-id thread-id))
1261                       (set 'line (match-end 0)))
1262                   (set 'more nil))))))
1263       (delete-process proc))))
1264
1265 (defun notmuch-search-operate-all (action)
1266   "Add/remove tags from all matching messages.
1267
1268 Tis command adds or removes tags from all messages matching the
1269 current search terms. When called interactively, this command
1270 will prompt for tags to be added or removed. Tags prefixed with
1271 '+' will be added and tags prefixed with '-' will be removed.
1272
1273 Each character of the tag name may consist of alphanumeric
1274 characters as well as `_.+-'.
1275 "
1276   (interactive "sOperation (+add -drop): notmuch tag ")
1277   (let ((action-split (split-string action " +")))
1278     ;; Perform some validation
1279     (let ((words action-split))
1280       (when (null words) (error "No operation given"))
1281       (while words
1282         (unless (string-match-p "^[-+][-+_.[:word:]]+$" (car words))
1283           (error "Action must be of the form `+thistag -that_tag'"))
1284         (setq words (cdr words))))
1285     (apply 'notmuch-call-notmuch-process "tag"
1286            (append action-split (list notmuch-search-query-string) nil))))
1287
1288 ;;;###autoload
1289 (defun notmuch-search (query &optional oldest-first)
1290   "Run \"notmuch search\" with the given query string and display results."
1291   (interactive "sNotmuch search: ")
1292   (let ((buffer (get-buffer-create (concat "*notmuch-search-" query "*"))))
1293     (switch-to-buffer buffer)
1294     (notmuch-search-mode)
1295     (set 'notmuch-search-query-string query)
1296     (set 'notmuch-search-oldest-first oldest-first)
1297     (let ((proc (get-buffer-process (current-buffer)))
1298           (inhibit-read-only t))
1299       (if proc
1300           (error "notmuch search process already running for query `%s'" query)
1301         )
1302       (erase-buffer)
1303       (goto-char (point-min))
1304       (save-excursion
1305         (let ((proc (start-process-shell-command
1306                      "notmuch-search" buffer notmuch-command "search"
1307                      (if oldest-first "--sort=oldest-first" "--sort=newest-first")
1308                      (shell-quote-argument query))))
1309           (set-process-sentinel proc 'notmuch-search-process-sentinel)
1310           (set-process-filter proc 'notmuch-search-process-filter))))
1311     (run-hooks 'notmuch-search-hook)))
1312
1313 (defun notmuch-search-refresh-view ()
1314   "Refresh the current view.
1315
1316 Kills the current buffer and runs a new search with the same
1317 query string as the current search. If the current thread is in
1318 the new search results, then point will be placed on the same
1319 thread. Otherwise, point will be moved to attempt to be in the
1320 same relative position within the new buffer."
1321   (interactive)
1322   (let ((here (point))
1323         (oldest-first notmuch-search-oldest-first)
1324         (thread (notmuch-search-find-thread-id))
1325         (query notmuch-search-query-string))
1326     (kill-this-buffer)
1327     (notmuch-search query oldest-first)
1328     (goto-char (point-min))
1329     (if (re-search-forward (concat "^" thread) nil t)
1330         (beginning-of-line)
1331       (goto-char here))))
1332
1333 (defun notmuch-search-toggle-order ()
1334   "Toggle the current search order.
1335
1336 By default, the \"inbox\" view created by `notmuch' is displayed
1337 in chronological order (oldest thread at the beginning of the
1338 buffer), while any global searches created by `notmuch-search'
1339 are displayed in reverse-chronological order (newest thread at
1340 the beginning of the buffer).
1341
1342 This command toggles the sort order for the current search.
1343
1344 Note that any filtered searches created by
1345 `notmuch-search-filter' retain the search order of the parent
1346 search."
1347   (interactive)
1348   (set 'notmuch-search-oldest-first (not notmuch-search-oldest-first))
1349   (notmuch-search-refresh-view))
1350
1351 (defun notmuch-search-filter (query)
1352   "Filter the current search results based on an additional query string.
1353
1354 Runs a new search matching only messages that match both the
1355 current search results AND the additional query string provided."
1356   (interactive "sFilter search: ")
1357   (notmuch-search (concat notmuch-search-query-string " and " query) notmuch-search-oldest-first))
1358
1359 (defun notmuch-search-filter-by-tag (tag)
1360   "Filter the current search results based on a single tag.
1361
1362 Runs a new search matching only messages that match both the
1363 current search results AND that are tagged with the given tag."
1364   (interactive
1365    (list (notmuch-select-tag-with-completion "Filter by tag: ")))
1366   (notmuch-search (concat notmuch-search-query-string " and tag:" tag) notmuch-search-oldest-first))
1367
1368
1369 ;;;###autoload
1370 (defun notmuch ()
1371   "Run notmuch to display all mail with tag of 'inbox'"
1372   (interactive)
1373   (notmuch-search "tag:inbox" notmuch-search-oldest-first))
1374
1375 (setq mail-user-agent 'message-user-agent)
1376
1377 (defvar notmuch-folder-mode-map
1378   (let ((map (make-sparse-keymap)))
1379     (define-key map "?" 'notmuch-help)
1380     (define-key map "x" 'kill-this-buffer)
1381     (define-key map "q" 'kill-this-buffer)
1382     (define-key map ">" 'notmuch-folder-last)
1383     (define-key map "<" 'notmuch-folder-first)
1384     (define-key map "=" 'notmuch-folder)
1385     (define-key map "s" 'notmuch-search)
1386     (define-key map [mouse-1] 'notmuch-folder-show-search)
1387     (define-key map (kbd "RET") 'notmuch-folder-show-search)
1388     (define-key map "p" 'notmuch-folder-previous)
1389     (define-key map "n" 'notmuch-folder-next)
1390     map)
1391   "Keymap for \"notmuch folder\" buffers.")
1392
1393 (fset 'notmuch-folder-mode-map notmuch-folder-mode-map)
1394
1395 (defcustom notmuch-folders (quote (("inbox" . "tag:inbox") ("unread" . "tag:unread")))
1396   "List of searches for the notmuch folder view"
1397   :type '(alist :key-type (string) :value-type (string))
1398   :group 'notmuch)
1399
1400 (defun notmuch-folder-mode ()
1401   "Major mode for showing notmuch 'folders'.
1402
1403 This buffer contains a list of message counts returned by a
1404 customizable set of searches of your email archives. Each line in
1405 the buffer shows the name of a saved search and the resulting
1406 message count.
1407
1408 Pressing RET on any line opens a search window containing the
1409 results for the saved search on that line.
1410
1411 Here is an example of how the search list could be
1412 customized, (the following text would be placed in your ~/.emacs
1413 file):
1414
1415 (setq notmuch-folders '((\"inbox\" . \"tag:inbox\")
1416                         (\"unread\" . \"tag:inbox AND tag:unread\")
1417                         (\"notmuch\" . \"tag:inbox AND to:notmuchmail.org\")))
1418
1419 Of course, you can have any number of folders, each configured
1420 with any supported search terms (see \"notmuch help search-terms\").
1421
1422 Currently available key bindings:
1423
1424 \\{notmuch-folder-mode-map}"
1425   (interactive)
1426   (kill-all-local-variables)
1427   (use-local-map 'notmuch-folder-mode-map)
1428   (setq truncate-lines t)
1429   (hl-line-mode 1)
1430   (setq major-mode 'notmuch-folder-mode
1431         mode-name "notmuch-folder")
1432   (setq buffer-read-only t))
1433
1434 (defun notmuch-folder-next ()
1435   "Select the next folder in the list."
1436   (interactive)
1437   (forward-line 1)
1438   (if (eobp)
1439       (forward-line -1)))
1440
1441 (defun notmuch-folder-previous ()
1442   "Select the previous folder in the list."
1443   (interactive)
1444   (forward-line -1))
1445
1446 (defun notmuch-folder-first ()
1447   "Select the first folder in the list."
1448   (interactive)
1449   (goto-char (point-min)))
1450
1451 (defun notmuch-folder-last ()
1452   "Select the last folder in the list."
1453   (interactive)
1454   (goto-char (point-max))
1455   (forward-line -1))
1456
1457 (defun notmuch-folder-add (folders)
1458   (if folders
1459       (let ((name (car (car folders)))
1460             (inhibit-read-only t)
1461             (search (cdr (car folders))))
1462         (insert name)
1463         (indent-to 16 1)
1464         (call-process notmuch-command nil t nil "count" search)
1465         (notmuch-folder-add (cdr folders)))))
1466
1467 (defun notmuch-folder-find-name ()
1468   (save-excursion
1469     (beginning-of-line)
1470     (let ((beg (point)))
1471       (forward-word)
1472       (filter-buffer-substring beg (point)))))
1473
1474 (defun notmuch-folder-show-search (&optional folder)
1475   "Show a search window for the search related to the specified folder."
1476   (interactive)
1477   (if (null folder)
1478       (setq folder (notmuch-folder-find-name)))
1479   (let ((search (assoc folder notmuch-folders)))
1480     (if search
1481         (notmuch-search (cdr search) notmuch-search-oldest-first))))
1482
1483 ;;;###autoload
1484 (defun notmuch-folder ()
1485   "Show the notmuch folder view and update the displayed counts."
1486   (interactive)
1487   (let ((buffer (get-buffer-create "*notmuch-folders*")))
1488     (switch-to-buffer buffer)
1489     (let ((inhibit-read-only t)
1490           (n (line-number-at-pos)))
1491       (erase-buffer)
1492       (notmuch-folder-mode)
1493       (notmuch-folder-add notmuch-folders)
1494       (goto-char (point-min))
1495       (goto-line n))))
1496
1497 (provide 'notmuch)