]> git.notmuchmail.org Git - notmuch/blob - notmuch.el
062beafc322a2da725d414e228f1bba1c35c4a35
[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 (defvar notmuch-show-mode-map
23   (let ((map (make-sparse-keymap)))
24     ; I don't actually want all of these toggle commands occupying
25     ; keybindings. They steal valuable key-binding space, are hard
26     ; to remember, and act globally rather than locally.
27     ;
28     ; Will be much preferable to switch to direct manipulation for
29     ; toggling visibility of these components. Probably using
30     ; overlays-at to query and manipulate the current overlay.
31     (define-key map "a" 'notmuch-show-archive-thread)
32     (define-key map "b" 'notmuch-show-toggle-body-read-visible)
33     (define-key map "c" 'notmuch-show-toggle-citations-visible)
34     (define-key map "h" 'notmuch-show-toggle-headers-visible)
35     (define-key map "n" 'notmuch-show-mark-read-then-next-message)
36     (define-key map "p" 'notmuch-show-previous-message)
37     (define-key map "q" 'kill-this-buffer)
38     (define-key map "s" 'notmuch-show-toggle-signatures-visible)
39     (define-key map "x" 'kill-this-buffer)
40     (define-key map "+" 'notmuch-show-add-tag)
41     (define-key map "-" 'notmuch-show-remove-tag)
42     (define-key map " " 'notmuch-show-advance-marking-read)
43     map)
44   "Keymap for \"notmuch show\" buffers.")
45 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
46
47 (defvar notmuch-show-message-begin-regexp    "\fmessage{")
48 (defvar notmuch-show-message-end-regexp      "\fmessage}")
49 (defvar notmuch-show-header-begin-regexp     "\fheader{")
50 (defvar notmuch-show-header-end-regexp       "\fheader}")
51 (defvar notmuch-show-body-begin-regexp       "\fbody{")
52 (defvar notmuch-show-body-end-regexp         "\fbody}")
53 (defvar notmuch-show-attachment-begin-regexp "\fattachment{")
54 (defvar notmuch-show-attachment-end-regexp   "\fattachment}")
55 (defvar notmuch-show-part-begin-regexp       "\fpart{")
56 (defvar notmuch-show-part-end-regexp         "\fpart}")
57 (defvar notmuch-show-marker-regexp "\f\\(message\\|header\\|body\\|attachment\\|part\\)[{}].*$")
58
59 (defvar notmuch-show-id-regexp "ID: \\(.*\\)$")
60 (defvar notmuch-show-tags-regexp "(\\([^)]*\\))$")
61
62 (defun notmuch-show-get-message-id ()
63   (save-excursion
64     (beginning-of-line)
65     (if (not (looking-at notmuch-show-message-begin-regexp))
66         (re-search-backward notmuch-show-message-begin-regexp))
67     (re-search-forward notmuch-show-id-regexp)
68     (buffer-substring (match-beginning 1) (match-end 1))))
69
70 (defun notmuch-show-set-tags (tags)
71   (save-excursion
72     (beginning-of-line)
73     (if (not (looking-at notmuch-show-message-begin-regexp))
74         (re-search-backward notmuch-show-message-begin-regexp))
75     (re-search-forward notmuch-show-tags-regexp)
76     (let ((inhibit-read-only t)
77           (beg (match-beginning 1))
78           (end (match-end 1)))
79       (delete-region beg end)
80       (goto-char beg)
81       (insert (mapconcat 'identity tags " ")))))
82
83 (defun notmuch-show-get-tags ()
84   (save-excursion
85     (beginning-of-line)
86     (if (not (looking-at notmuch-show-message-begin-regexp))
87         (re-search-backward notmuch-show-message-begin-regexp))
88     (re-search-forward notmuch-show-tags-regexp)
89     (split-string (buffer-substring (match-beginning 1) (match-end 1)))))
90
91 (defun notmuch-show-add-tag (tag)
92   (interactive "sTag to add: ")
93   (notmuch-call-notmuch-process "tag" (concat "+" tag) (concat "id:" (notmuch-show-get-message-id)))
94   (notmuch-show-set-tags (delete-dups (sort (cons tag (notmuch-show-get-tags)) 'string<))))
95
96 (defun notmuch-show-remove-tag (tag)
97   (interactive "sTag to remove: ")
98   (notmuch-call-notmuch-process "tag" (concat "-" tag) (concat "id:" (notmuch-show-get-message-id)))
99   (notmuch-show-set-tags (delete tag (notmuch-show-get-tags))))
100
101 (defun notmuch-show-archive-thread ()
102   "Archive each message currrently shown by removing the \"inbox\" tag from each.
103
104 This command is safe from any race condition of new messages
105 being delivered to the same thread. It does not archive the
106 entire thread, but only the messages shown in the current
107 buffer."
108   (interactive)
109   (save-excursion
110     (goto-char (point-min))
111     (while (not (eobp))
112       (notmuch-show-remove-tag "inbox")
113       (if (not (eobp))
114           (forward-char))
115       (if (not (re-search-forward notmuch-show-message-begin-regexp nil t))
116           (goto-char (point-max))))))
117
118 (defun notmuch-show-move-to-current-message-summary-line ()
119   "Move to the beginning of the one-line summary of the current message.
120
121 This gives us a stable place to move to and work from since the
122 summary line is always visible. This is important since moving to
123 an invisible location is unreliable, (the main command loop moves
124 point either forward or backward to the next visible character
125 when a command ends with point on an invisible character).
126
127 Emits an error if point is not within a valid message, (that is
128 not pattern of `notmuch-show-message-begin-regexp' could be found
129 by searching backward)."
130   (beginning-of-line)
131   (if (not (looking-at notmuch-show-message-begin-regexp))
132       (if (re-search-backward notmuch-show-message-begin-regexp nil t)
133           (forward-line 2)
134         (error "Not within a valid message."))
135     (forward-line 2)))
136
137 (defun notmuch-show-next-message ()
138   "Advance to the beginning of the next message in the buffer.
139
140 Moves to the beginning of the current message if already on the
141 last message in the buffer."
142   (interactive)
143   (notmuch-show-move-to-current-message-summary-line)
144   (re-search-forward notmuch-show-message-begin-regexp nil t)
145   (notmuch-show-move-to-current-message-summary-line)
146   (recenter 0))
147
148 (defun notmuch-show-find-next-message ()
149   "Returns the position of the next message in the buffer.
150
151 Or the beginning of the current message if already within the last
152 message in the buffer."
153   ; save-excursion doesn't save our window position
154   ; save-window-excursion doesn't save point
155   ; Looks like we have to use both.
156   (save-excursion
157     (save-window-excursion
158       (notmuch-show-next-message)
159       (point))))
160
161 (defun notmuch-show-previous-message ()
162   "Backup to the beginning of the previous message in the buffer.
163
164 If within a message rather than at the beginning of it, then
165 simply move to the beginning of the current message."
166   (interactive)
167   (let ((start (point)))
168     (notmuch-show-move-to-current-message-summary-line)
169     (if (not (< (point) start))
170         ; Go backward twice to skip the current message's marker
171         (progn
172           (re-search-backward notmuch-show-message-begin-regexp nil t)
173           (re-search-backward notmuch-show-message-begin-regexp nil t)
174           (notmuch-show-move-to-current-message-summary-line)
175           ))
176     (recenter 0)))
177
178 (defun notmuch-show-mark-read-then-next-message ()
179   "Remove unread tag from current message, then advance to next message."
180   (interactive)
181   (if (member "unread" (notmuch-show-get-tags))
182       (notmuch-show-remove-tag "unread"))
183   (notmuch-show-next-message))
184
185 (defun notmuch-show-advance-marking-read ()
186   "Advance through buffer, marking messages as read.
187
188 This command is intended to be one of the simplest ways to
189 process a thread of email. It does the following:
190
191 If the current message in the thread is not yet fully visible,
192 scroll by a near screenful to read more of the message.
193
194 Otherwise, (the end of the current message is already within the
195 current window), remove the \"unread\" tag from the current
196 message and advance to the next message."
197   (interactive)
198   (if (< (notmuch-show-find-next-message) (window-end))
199       (notmuch-show-mark-read-then-next-message)
200     (scroll-up nil)))
201
202 (defun notmuch-show-markup-citations-region (beg end)
203   (goto-char beg)
204   (beginning-of-line)
205   (while (< (point) end)
206     (let ((beg-sub (point)))
207       (if (looking-at ">")
208           (progn
209             (while (looking-at ">")
210               (next-line))
211             (let ((overlay (make-overlay beg-sub (point))))
212               (overlay-put overlay 'invisible 'notmuch-show-citation)
213               (overlay-put overlay 'before-string
214                            (concat "[" (number-to-string (count-lines beg-sub (point)))
215                                    " quoted lines.]")))))
216       (if (looking-at "--[ ]?$")
217           (let ((overlay (make-overlay beg-sub end)))
218             (overlay-put overlay 'invisible 'notmuch-show-signature)
219             (overlay-put overlay 'before-string
220                          (concat "[" (number-to-string (count-lines beg-sub (point)))
221                                  "-line signature.]"))
222             (goto-char end)))
223       (next-line))))
224
225 (defun notmuch-show-markup-body ()
226   (re-search-forward notmuch-show-body-begin-regexp)
227   (next-line 1)
228   (beginning-of-line)
229   (let ((beg (point)))
230     (re-search-forward notmuch-show-body-end-regexp)
231     (let ((end (match-beginning 0)))
232       (notmuch-show-markup-citations-region beg end)
233       (if (not (member "unread" (notmuch-show-get-tags)))
234           (overlay-put (make-overlay beg end)
235                        'invisible 'notmuch-show-body-read)))))
236
237 (defun notmuch-show-markup-header ()
238   (re-search-forward notmuch-show-header-begin-regexp)
239   (next-line 2)
240   (beginning-of-line)
241   (let ((beg (point)))
242     (re-search-forward notmuch-show-header-end-regexp)
243     (overlay-put (make-overlay beg (match-beginning 0))
244                  'invisible 'notmuch-show-header)))
245
246 (defun notmuch-show-markup-message ()
247   (if (re-search-forward notmuch-show-message-begin-regexp nil t)
248       (progn
249         (notmuch-show-markup-header)
250         (notmuch-show-markup-body))
251     (goto-char (point-max))))
252
253 (defun notmuch-show-hide-markers ()
254   (save-excursion
255     (goto-char (point-min))
256     (while (not (eobp))
257       (if (re-search-forward notmuch-show-marker-regexp nil t)
258           (progn
259             (overlay-put (make-overlay (match-beginning 0) (+ (match-end 0) 1))
260                          'invisible 'notmuch-show-marker))
261         (goto-char (point-max))))))
262
263 (defun notmuch-show-markup-messages ()
264   (save-excursion
265     (goto-char (point-min))
266     (while (not (eobp))
267       (notmuch-show-markup-message)))
268   (notmuch-show-hide-markers))
269
270 (defun notmuch-show-toggle-citations-visible ()
271   "Toggle visibility of citations"
272   (interactive)
273   (if notmuch-show-citations-visible
274       (add-to-invisibility-spec 'notmuch-show-citation)
275     (remove-from-invisibility-spec 'notmuch-show-citation))
276   (set 'notmuch-show-citations-visible (not notmuch-show-citations-visible))
277   ; Need to force the redisplay for some reason
278   (force-window-update)
279   (redisplay t))
280
281 (defun notmuch-show-toggle-signatures-visible ()
282   "Toggle visibility of signatures"
283   (interactive)
284   (if notmuch-show-signatures-visible
285       (add-to-invisibility-spec 'notmuch-show-signature)
286     (remove-from-invisibility-spec 'notmuch-show-signature))
287   (set 'notmuch-show-signatures-visible (not notmuch-show-signatures-visible))
288   ; Need to force the redisplay for some reason
289   (force-window-update)
290   (redisplay t))
291
292 (defun notmuch-show-toggle-headers-visible ()
293   "Toggle visibility of header fields"
294   (interactive)
295   (if notmuch-show-headers-visible
296       (add-to-invisibility-spec 'notmuch-show-header)
297     (remove-from-invisibility-spec 'notmuch-show-header))
298   (set 'notmuch-show-headers-visible (not notmuch-show-headers-visible))
299   ; Need to force the redisplay for some reason
300   (force-window-update)
301   (redisplay t))
302
303 (defun notmuch-show-toggle-body-read-visible ()
304   "Toggle visibility of message bodies of read messages"
305   (interactive)
306   (if notmuch-show-body-read-visible
307       (add-to-invisibility-spec 'notmuch-show-body-read)
308     (remove-from-invisibility-spec 'notmuch-show-body-read))
309   (set 'notmuch-show-body-read-visible (not notmuch-show-body-read-visible))
310   ; Need to force the redisplay for some reason
311   (force-window-update)
312   (redisplay t))
313
314 ;;;###autoload
315 (defun notmuch-show-mode ()
316   "Major mode for viewing a thread with notmuch.
317
318 This buffer contains the results of the \"notmuch show\" command
319 for displaying a single thread of email from your email archives.
320
321 By default, various components of email messages, (citations,
322 signatures, already-read messages), are invisible to help you
323 focus on the most important things, (new text from unread
324 messages). See the various commands below for toggling the
325 visibility of hidden components.
326
327 The `notmuch-show-next-message' and
328 `notmuch-show-previous-message' commands, (bound to 'n' and 'p by
329 default), allow you to navigate to the next and previous
330 messages. Each time you navigate away from a message with
331 `notmuch-show-next-message' the current message will have its
332 \"unread\" tag removed.
333
334 You can add or remove tags from the current message with '+' and
335 '-'.  You can also archive all messages in the current
336 view, (remove the \"inbox\" tag from each), with
337 `notmuch-show-archive-thread' (bound to 'a' by default).
338
339 \\{notmuch-show-mode-map}"
340   (interactive)
341   (kill-all-local-variables)
342   (set (make-local-variable 'notmuch-show-headers-visible) t)
343   (notmuch-show-toggle-headers-visible)
344   (set (make-local-variable 'notmuch-show-body-read-visible) t)
345   (notmuch-show-toggle-body-read-visible)
346   (set (make-local-variable 'notmuch-show-citations-visible) t)
347   (notmuch-show-toggle-citations-visible)
348   (set (make-local-variable 'notmuch-show-signatures-visible) t)
349   (notmuch-show-toggle-signatures-visible)
350   (add-to-invisibility-spec 'notmuch-show-marker)
351   (use-local-map notmuch-show-mode-map)
352   (setq major-mode 'notmuch-show-mode
353         mode-name "notmuch-show")
354   (setq buffer-read-only t))
355
356 (defun notmuch-show (thread-id)
357   "Run \"notmuch show\" with the given thread ID and display results."
358   (interactive "sNotmuch show: ")
359   (let ((buffer (get-buffer-create (concat "*notmuch-show-" thread-id "*"))))
360     (switch-to-buffer buffer)
361     (notmuch-show-mode)
362     (let ((proc (get-buffer-process (current-buffer)))
363           (inhibit-read-only t))
364       (if proc
365           (error "notmuch search process already running for query `%s'" query)
366         )
367       (erase-buffer)
368       (goto-char (point-min))
369       (save-excursion
370         (call-process "notmuch" nil t nil "show" thread-id)
371         (notmuch-show-markup-messages)
372         )
373       )))
374
375 (defvar notmuch-search-mode-map
376   (let ((map (make-sparse-keymap)))
377     (define-key map "a" 'notmuch-search-archive-thread)
378     (define-key map "b" 'scroll-down)
379     (define-key map "f" 'notmuch-search-filter)
380     (define-key map "n" 'next-line)
381     (define-key map "p" 'previous-line)
382     (define-key map "q" 'kill-this-buffer)
383     (define-key map "s" 'notmuch-search)
384     (define-key map "t" 'notmuch-search-filter-by-tag)
385     (define-key map "x" 'kill-this-buffer)
386     (define-key map "\r" 'notmuch-search-show-thread)
387     (define-key map "+" 'notmuch-search-add-tag)
388     (define-key map "-" 'notmuch-search-remove-tag)
389     (define-key map "<" 'beginning-of-buffer)
390     (define-key map ">" 'notmuch-search-goto-last-thread)
391     (define-key map "=" 'notmuch-search-refresh-view)
392     (define-key map "\M->" 'notmuch-search-goto-last-thread)
393     (define-key map " " 'scroll-up)
394     (define-key map (kbd "<DEL>") 'scroll-down)
395     map)
396   "Keymap for \"notmuch search\" buffers.")
397 (fset 'notmuch-search-mode-map notmuch-search-mode-map)
398
399 (defun notmuch-search-goto-last-thread (&optional arg)
400   "Move point to the last thread in the buffer."
401   (interactive "^P")
402   (end-of-buffer arg)
403   (beginning-of-line))
404
405 ;;;###autoload
406 (defun notmuch-search-mode ()
407   "Major mode for searching mail with notmuch.
408
409 This buffer contains the results of a \"notmuch search\" of your
410 email archives. Each line in the buffer represents a single
411 thread giving a relative date for the thread and a subject.
412
413 Pressing RET on any line displays that thread. The '+' and '-'
414 keys can be used to add or remove tags from a thread. The 'a' key
415 is a convenience key for archiving a thread (removing the
416 \"inbox\" tag).
417
418 Other useful commands are `notmuch-search-filter' for filtering
419 the current search based on an additional query string,
420 `notmuch-search-filter-by-tag' for filtering to include only
421 messages with a given tag, and `notmuch-search' to execute a new,
422 global search.
423
424 \\{notmuch-search-mode-map}"
425   (interactive)
426   (kill-all-local-variables)
427   (make-local-variable 'notmuch-search-query-string)
428   (set (make-local-variable 'scroll-preserve-screen-position) t)
429   (add-to-invisibility-spec 'notmuch-search)
430   (use-local-map notmuch-search-mode-map)
431   (setq major-mode 'notmuch-search-mode
432         mode-name "notmuch-search")
433   (setq buffer-read-only t))
434
435 (defun notmuch-search-find-thread-id ()
436   (save-excursion
437     (beginning-of-line)
438     (let ((beg (point)))
439       (re-search-forward "[a-fA-F0-9]*")
440       (filter-buffer-substring beg (point)))))
441
442 (defun notmuch-search-markup-this-thread-id ()
443   (beginning-of-line)
444   (let ((beg (point)))
445     (re-search-forward "[a-fA-F0-9]*")
446     (forward-char)
447     (overlay-put (make-overlay beg (point)) 'invisible 'notmuch-search)))
448
449 (defun notmuch-search-markup-thread-ids ()
450   (save-excursion
451     (goto-char (point-min))
452     (while (not (eobp))
453       (notmuch-search-markup-this-thread-id)
454       (next-line))))
455
456 (defun notmuch-search-hide-thread-ids ()
457   (interactive)
458   (add-to-invisibility-spec 'notmuch-search)
459   (force-window-update)
460   (redisplay t))
461
462 (defun notmuch-search-show-thread-ids ()
463   (interactive)
464   (remove-from-invisibility-spec 'notmuch-search)
465   (force-window-update)
466   (redisplay t))
467
468 (defun notmuch-search-show-thread ()
469   (interactive)
470   (notmuch-show (notmuch-search-find-thread-id)))
471
472 (defun notmuch-call-notmuch-process (&rest args)
473   (let ((error-buffer (get-buffer-create "*Notmuch errors*")))
474     (with-current-buffer error-buffer
475         (erase-buffer))
476     (if (eq (apply 'call-process "notmuch" nil error-buffer nil args) 0)
477         (point)
478       (progn
479         (with-current-buffer error-buffer
480           (let ((beg (point-min))
481                 (end (- (point-max) 1)))
482             (error (buffer-substring beg end))
483             ))))))
484
485 (defun notmuch-search-set-tags (tags)
486   (save-excursion
487     (end-of-line)
488     (re-search-backward "(")
489     (forward-char)
490     (let ((beg (point))
491           (inhibit-read-only t))
492       (re-search-forward ")")
493       (backward-char)
494       (let ((end (point)))
495         (delete-region beg end)
496         (insert (mapconcat  'identity tags " "))))))
497
498 (defun notmuch-search-get-tags ()
499   (save-excursion
500     (end-of-line)
501     (re-search-backward "(")
502     (let ((beg (+ (point) 1)))
503       (re-search-forward ")")
504       (let ((end (- (point) 1)))
505         (split-string (buffer-substring beg end))))))
506
507 (defun notmuch-search-add-tag (tag)
508   (interactive "sTag to add: ")
509   (notmuch-call-notmuch-process "tag" (concat "+" tag) (concat "thread:" (notmuch-search-find-thread-id)))
510   (notmuch-search-set-tags (delete-dups (sort (cons tag (notmuch-search-get-tags)) 'string<))))
511
512 (defun notmuch-search-remove-tag (tag)
513   (interactive "sTag to remove: ")
514   (notmuch-call-notmuch-process "tag" (concat "-" tag) (concat "thread:" (notmuch-search-find-thread-id)))
515   (notmuch-search-set-tags (delete tag (notmuch-search-get-tags))))
516
517 (defun notmuch-search-archive-thread ()
518   "Archive the current thread (remove its \"inbox\" tag).
519
520 This function advances point to the next line when finished."
521   (interactive)
522   (notmuch-search-remove-tag "inbox")
523   (next-line))
524
525 (defun notmuch-search (query)
526   "Run \"notmuch search\" with the given query string and display results."
527   (interactive "sNotmuch search: ")
528   (let ((buffer (get-buffer-create (concat "*notmuch-search-" query "*"))))
529     (switch-to-buffer buffer)
530     (notmuch-search-mode)
531     (set 'notmuch-search-query-string query)
532     (let ((proc (get-buffer-process (current-buffer)))
533           (inhibit-read-only t))
534       (if proc
535           (error "notmuch search process already running for query `%s'" query)
536         )
537       (erase-buffer)
538       (goto-char (point-min))
539       (save-excursion
540         (call-process "notmuch" nil t nil "search" query)
541         (notmuch-search-markup-thread-ids)
542         ; A well-behaved program ends its output with a newline, but we
543         ; don't actually want the blank line at the end of the file.
544         (goto-char (point-max))
545         (if (looking-at "^$")
546             (delete-backward-char 1)
547           )
548         ))))
549
550 (defun notmuch-search-refresh-view ()
551   "Refresh the current view.
552
553 Kills the current buffer and runs a new search with the same
554 query string as the current search. If the current thread is in
555 the new search results, then point will be placed on the same
556 thread. Otherwise, point will be moved to attempt to be in the
557 same relative position within the new buffer."
558   (interactive)
559   (let ((here (point))
560         (thread (notmuch-search-find-thread-id))
561         (query notmuch-search-query-string))
562     (kill-this-buffer)
563     (notmuch-search query)
564     (goto-char (point-min))
565     (if (re-search-forward (concat "^" thread) nil t)
566         (beginning-of-line)
567       (goto-char here))))
568
569 (defun notmuch-search-filter (query)
570   "Filter the current search results based on an additional query string.
571
572 Runs a new search matching only messages that match both the
573 current search results AND the additional query string provided."
574   (interactive "sFilter search: ")
575   (notmuch-search (concat notmuch-search-query-string " and " query)))
576
577 (defun notmuch-search-filter-by-tag (tag)
578   "Filter the current search results based on a single tag.
579
580 Runs a new search matching only messages that match both the
581 current search results AND that are tagged with the given tag."
582   (interactive "sFilter by tag: ")
583   (notmuch-search (concat notmuch-search-query-string " and tag:" tag)))
584
585 (defun notmuch ()
586   "Run notmuch to display all mail with tag of 'inbox'"
587   (interactive)
588   (notmuch-search "tag:inbox"))
589
590 (provide 'notmuch)