git.notmuchmail.org Git - notmuch/blob - 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               (or (equal (car disposition) "attachment")
 326                   (and (equal (car disposition) "inline")
 327                        (assq 'filename disposition)))
 328               (incf count))))
 329      mm-handle)
 330     count))
 331
 332 (defun notmuch-save-attachments (mm-handle &optional queryp)
 333   (notmuch-foreach-mime-part
 334    (lambda (p)
 335      (let ((disposition (mm-handle-disposition p)))
 336        (and (listp disposition)
 337             (or (equal (car disposition) "attachment")
 338                 (and (equal (car disposition) "inline")
 339                      (assq 'filename disposition)))
 340             (or (not queryp)
 341                 (y-or-n-p
 342                  (concat "Save '" (cdr (assq 'filename disposition)) "' ")))
 343             (mm-save-part p))))
 344    mm-handle))
 345
 346 (defun notmuch-show-save-attachments ()
 347   "Save all attachments from the current message."
 348   (interactive)
 349   (with-current-notmuch-show-message
 350    (let ((mm-handle (mm-dissect-buffer)))
 351      (notmuch-save-attachments
 352       mm-handle (> (notmuch-count-attachments mm-handle) 1))))
 353   (message "Done"))
 354
 355 (defun notmuch-reply (query-string)
 356   (switch-to-buffer (generate-new-buffer "notmuch-draft"))
 357   (call-process notmuch-command nil t nil "reply" query-string)
 358   (message-insert-signature)
 359   (goto-char (point-min))
 360   (if (re-search-forward "^$" nil t)
 361       (progn
 362         (insert "--text follows this line--")
 363         (forward-line)))
 364   (message-mode))
 365
 366 (defun notmuch-show-reply ()
 367   "Begin composing a reply to the current message in a new buffer."
 368   (interactive)
 369   (let ((message-id (notmuch-show-get-message-id)))
 370     (notmuch-reply message-id)))
 371
 372 (defun notmuch-show-forward-current ()
 373   "Forward the current message."
 374   (interactive)
 375   (with-current-notmuch-show-message
 376    (message-forward)))
 377
 378 (defun notmuch-show-pipe-message (command)
 379   "Pipe the contents of the current message to the given command.
 380
 381 The given command will be executed with the raw contents of the
 382 current email message as stdin. Anything printed by the command
 383 to stdout or stderr will appear in the *Messages* buffer."
 384   (interactive "sPipe message to command: ")
 385   (apply 'start-process-shell-command "notmuch-pipe-command" "*notmuch-pipe*"
 386          (list command " < " (shell-quote-argument (notmuch-show-get-filename)))))
 387
 388 (defun notmuch-show-move-to-current-message-summary-line ()
 389   "Move to the beginning of the one-line summary of the current message.
 390
 391 This gives us a stable place to move to and work from since the
 392 summary line is always visible. This is important since moving to
 393 an invisible location is unreliable, (the main command loop moves
 394 point either forward or backward to the next visible character
 395 when a command ends with point on an invisible character).
 396
 397 Emits an error if point is not within a valid message, (that is
 398 no pattern of `notmuch-show-message-begin-regexp' could be found
 399 by searching backward)."
 400   (beginning-of-line)
 401   (if (not (looking-at notmuch-show-message-begin-regexp))
 402       (if (re-search-backward notmuch-show-message-begin-regexp nil t)
 403           (forward-line 2)
 404         (error "Not within a valid message."))
 405     (forward-line 2)))
 406
 407 (defun notmuch-show-last-message-p ()
 408   "Predicate testing whether point is within the last message."
 409   (save-window-excursion
 410     (save-excursion
 411       (notmuch-show-move-to-current-message-summary-line)
 412       (not (re-search-forward notmuch-show-message-begin-regexp nil t)))))
 413
 414 (defun notmuch-show-message-unread-p ()
 415   "Predicate testing whether current message is unread."
 416   (member "unread" (notmuch-show-get-tags)))
 417
 418 (defun notmuch-show-message-open-p ()
 419   "Predicate testing whether current message is open (body is visible)."
 420   (let ((btn (previous-button (point) t)))
 421     (while (not (button-has-type-p btn 'notmuch-button-body-toggle-type))
 422       (setq btn (previous-button (button-start btn))))
 423     (not (invisible-p (button-get btn 'invisibility-spec)))))
 424
 425 (defun notmuch-show-next-message ()
 426   "Advance to the beginning of the next message in the buffer.
 427
 428 Moves to the last visible character of the current message if
 429 already on the last message in the buffer.
 430
 431 Returns nil if already on the last message in the buffer."
 432   (interactive)
 433   (notmuch-show-move-to-current-message-summary-line)
 434   (if (re-search-forward notmuch-show-message-begin-regexp nil t)
 435       (progn
 436         (notmuch-show-move-to-current-message-summary-line)
 437         (recenter 0)
 438         t)
 439     (goto-char (- (point-max) 1))
 440     (while (point-invisible-p)
 441       (backward-char))
 442     (recenter 0)
 443     nil))
 444
 445 (defun notmuch-show-find-next-message ()
 446   "Returns the position of the next message in the buffer.
 447
 448 Or the position of the last visible character of the current
 449 message if already within the last message in the buffer."
 450   ; save-excursion doesn't save our window position
 451   ; save-window-excursion doesn't save point
 452   ; Looks like we have to use both.
 453   (save-excursion
 454     (save-window-excursion
 455       (notmuch-show-next-message)
 456       (point))))
 457
 458 (defun notmuch-show-next-unread-message ()
 459   "Advance to the beginning of the next unread message in the buffer.
 460
 461 Moves to the last visible character of the current message if
 462 there are no more unread messages past the current point."
 463   (notmuch-show-next-message)
 464   (while (and (not (notmuch-show-last-message-p))
 465               (not (notmuch-show-message-unread-p)))
 466     (notmuch-show-next-message))
 467   (if (not (notmuch-show-message-unread-p))
 468       (notmuch-show-next-message)))
 469
 470 (defun notmuch-show-next-open-message ()
 471   "Advance to the next open message (that is, body is not invisible)."
 472   (while (and (notmuch-show-next-message)
 473               (not (notmuch-show-message-open-p)))))
 474
 475 (defun notmuch-show-previous-message ()
 476   "Backup to the beginning of the previous message in the buffer.
 477
 478 If within a message rather than at the beginning of it, then
 479 simply move to the beginning of the current message."
 480   (interactive)
 481   (let ((start (point)))
 482     (notmuch-show-move-to-current-message-summary-line)
 483     (if (not (< (point) start))
 484         ; Go backward twice to skip the current message's marker
 485         (progn
 486           (re-search-backward notmuch-show-message-begin-regexp nil t)
 487           (re-search-backward notmuch-show-message-begin-regexp nil t)
 488           (notmuch-show-move-to-current-message-summary-line)
 489           ))
 490     (recenter 0)))
 491
 492 (defun notmuch-show-find-previous-message ()
 493   "Returns the position of the previous message in the buffer.
 494
 495 Or the position of the beginning of the current message if point
 496 is originally within the message rather than at the beginning of
 497 it."
 498   ; save-excursion doesn't save our window position
 499   ; save-window-excursion doesn't save point
 500   ; Looks like we have to use both.
 501   (save-excursion
 502     (save-window-excursion
 503       (notmuch-show-previous-message)
 504       (point))))
 505
 506 (defun notmuch-show-mark-read-then-next-open-message ()
 507   "Remove unread tag from this message, then advance to next open message."
 508   (interactive)
 509   (notmuch-show-remove-tag "unread")
 510   (notmuch-show-next-open-message))
 511
 512 (defun notmuch-show-rewind ()
 513   "Backup through the thread, (reverse scrolling compared to \\[notmuch-show-advance-marking-read-and-archiving]).
 514
 515 Specifically, if the beginning of the previous email is fewer
 516 than `window-height' lines from the current point, move to it
 517 just like `notmuch-show-previous-message'.
 518
 519 Otherwise, just scroll down a screenful of the current message.
 520
 521 This command does not modify any message tags, (it does not undo
 522 any effects from previous calls to
 523 `notmuch-show-advance-marking-read-and-archiving'."
 524   (interactive)
 525   (let ((previous (notmuch-show-find-previous-message)))
 526     (if (> (count-lines previous (point)) (- (window-height) next-screen-context-lines))
 527         (progn
 528           (condition-case nil
 529               (scroll-down nil)
 530             ((beginning-of-buffer) nil))
 531           (goto-char (window-start)))
 532       (notmuch-show-previous-message))))
 533
 534 (defun notmuch-show-advance-marking-read-and-archiving ()
 535   "Advance through thread, marking read and archiving.
 536
 537 This command is intended to be one of the simplest ways to
 538 process a thread of email. It does the following:
 539
 540 If the current message in the thread is not yet fully visible,
 541 scroll by a near screenful to read more of the message.
 542
 543 Otherwise, (the end of the current message is already within the
 544 current window), remove the \"unread\" tag (if present) from the
 545 current message and advance to the next open message.
 546
 547 Finally, if there is no further message to advance to, and this
 548 last message is already read, then archive the entire current
 549 thread, (remove the \"inbox\" tag from each message). Also kill
 550 this buffer, and display the next thread from the search from
 551 which this thread was originally shown."
 552   (interactive)
 553   (let ((next (notmuch-show-find-next-message))
 554         (unread (notmuch-show-message-unread-p)))
 555     (if (> next (window-end))
 556         (scroll-up nil)
 557       (let ((last (notmuch-show-last-message-p)))
 558         (notmuch-show-mark-read-then-next-open-message)
 559         (if last
 560             (notmuch-show-archive-thread))))))
 561
 562 (defun notmuch-show-next-button ()
 563   "Advance point to the next button in the buffer."
 564   (interactive)
 565   (goto-char (button-start (next-button (point)))))
 566
 567 (defun notmuch-show-previous-button ()
 568   "Move point back to the previous button in the buffer."
 569   (interactive)
 570   (goto-char (button-start (previous-button (point)))))
 571
 572 (defun notmuch-toggle-invisible-action (cite-button)
 573   (let ((invis-spec (button-get cite-button 'invisibility-spec)))
 574         (if (invisible-p invis-spec)
 575             (remove-from-invisibility-spec invis-spec)
 576           (add-to-invisibility-spec invis-spec)
 577           ))
 578   (force-window-update)
 579   (redisplay t))
 580
 581 (define-button-type 'notmuch-button-invisibility-toggle-type
 582   'action 'notmuch-toggle-invisible-action
 583   'follow-link t
 584   'face "default")
 585 (define-button-type 'notmuch-button-citation-toggle-type 'help-echo "mouse-1, RET: Show citation"
 586   :supertype 'notmuch-button-invisibility-toggle-type)
 587 (define-button-type 'notmuch-button-signature-toggle-type 'help-echo "mouse-1, RET: Show signature"
 588   :supertype 'notmuch-button-invisibility-toggle-type)
 589 (define-button-type 'notmuch-button-headers-toggle-type 'help-echo "mouse-1, RET: Show headers"
 590   :supertype 'notmuch-button-invisibility-toggle-type)
 591 (define-button-type 'notmuch-button-body-toggle-type
 592   'help-echo "mouse-1, RET: Show message"
 593   'face 'notmuch-message-summary-face
 594   :supertype 'notmuch-button-invisibility-toggle-type)
 595
 596 (defun notmuch-show-markup-citations-region (beg end depth)
 597   (goto-char beg)
 598   (beginning-of-line)
 599   (while (< (point) end)
 600     (let ((beg-sub (point-marker))
 601           (indent (make-string depth ? ))
 602           (citation ">"))
 603       (move-to-column depth)
 604       (if (looking-at citation)
 605           (progn
 606             (while (looking-at citation)
 607               (forward-line)
 608               (move-to-column depth))
 609             (let ((overlay (make-overlay beg-sub (point)))
 610                   (invis-spec (make-symbol "notmuch-citation-region")))
 611               (add-to-invisibility-spec invis-spec)
 612               (overlay-put overlay 'invisible invis-spec)
 613               (let ((p (point-marker))
 614                     (cite-button-text
 615                      (concat "["  (number-to-string (count-lines beg-sub (point)))
 616                              "-line citation. Click/Enter to show.]")))
 617                 (goto-char (- beg-sub 1))
 618                 (insert (concat "\n" indent))
 619                 (insert-button cite-button-text
 620                                'invisibility-spec invis-spec
 621                                :type 'notmuch-button-citation-toggle-type)
 622                 (forward-line)
 623               ))))
 624       (move-to-column depth)
 625       (if (looking-at notmuch-show-signature-regexp)
 626           (let ((sig-lines (- (count-lines beg-sub end) 1)))
 627             (if (<= sig-lines notmuch-show-signature-lines-max)
 628                 (progn
 629                   (let ((invis-spec (make-symbol "notmuch-signature-region")))
 630                     (add-to-invisibility-spec invis-spec)
 631                     (overlay-put (make-overlay beg-sub end)
 632                                  'invisible invis-spec)
 633
 634                     (goto-char (- beg-sub 1))
 635                     (insert (concat "\n" indent))
 636                     (let ((sig-button-text (concat "[" (number-to-string sig-lines)
 637                                                    "-line signature. Click/Enter to show.]")))
 638                       (insert-button sig-button-text 'invisibility-spec invis-spec
 639                                      :type 'notmuch-button-signature-toggle-type)
 640                      )
 641                     (insert "\n")
 642                     (goto-char end))))))
 643       (forward-line))))
 644
 645 (defun notmuch-show-markup-part (beg end depth)
 646   (if (re-search-forward notmuch-show-part-begin-regexp nil t)
 647       (progn
 648         (forward-line)
 649         (let ((beg (point-marker)))
 650           (re-search-forward notmuch-show-part-end-regexp)
 651           (let ((end (copy-marker (match-beginning 0))))
 652             (goto-char end)
 653             (if (not (bolp))
 654                 (insert "\n"))
 655             (indent-rigidly beg end depth)
 656             (notmuch-show-markup-citations-region beg end depth)
 657             ; Advance to the next part (if any) (so the outer loop can
 658             ; determine whether we've left the current message.
 659             (if (re-search-forward notmuch-show-part-begin-regexp nil t)
 660                 (beginning-of-line)))))
 661     (goto-char end)))
 662
 663 (defun notmuch-show-markup-parts-region (beg end depth)
 664   (save-excursion
 665     (goto-char beg)
 666     (while (< (point) end)
 667       (notmuch-show-markup-part beg end depth))))
 668
 669 (defun notmuch-show-markup-body (depth match btn)
 670   "Markup a message body, (indenting, buttonizing citations,
 671 etc.), and conditionally hiding the body itself if the message
 672 has been read and does not match the current search.
 673
 674 DEPTH specifies the depth at which this message appears in the
 675 tree of the current thread, (the top-level messages have depth 0
 676 and each reply increases depth by 1). MATCH indicates whether
 677 this message is regarded as matching the current search. BTN is
 678 the button which is used to toggle the visibility of this
 679 message.
 680
 681 When this function is called, point must be within the message, but
 682 before the delimiter marking the beginning of the body."
 683   (re-search-forward notmuch-show-body-begin-regexp)
 684   (forward-line)
 685   (let ((beg (point-marker)))
 686     (re-search-forward notmuch-show-body-end-regexp)
 687     (let ((end (copy-marker (match-beginning 0))))
 688       (notmuch-show-markup-parts-region beg end depth)
 689       (let ((invis-spec (make-symbol "notmuch-show-body-read")))
 690         (overlay-put (make-overlay beg end)
 691                      'invisible invis-spec)
 692         (button-put btn 'invisibility-spec invis-spec)
 693         (if (not (or (notmuch-show-message-unread-p) match))
 694             (add-to-invisibility-spec invis-spec)))
 695       (set-marker beg nil)
 696       (set-marker end nil)
 697       )))
 698
 699 (defun notmuch-fontify-headers ()
 700   (while (looking-at "[[:space:]]")
 701     (forward-char))
 702   (if (looking-at "[Tt]o:")
 703       (progn
 704         (overlay-put (make-overlay (point) (re-search-forward ":"))
 705                      'face 'message-header-name)
 706         (overlay-put (make-overlay (point) (re-search-forward ".*$"))
 707                      'face 'message-header-to))
 708     (if (looking-at "[B]?[Cc][Cc]:")
 709         (progn
 710           (overlay-put (make-overlay (point) (re-search-forward ":"))
 711                        'face 'message-header-name)
 712           (overlay-put (make-overlay (point) (re-search-forward ".*$"))
 713                        'face 'message-header-cc))
 714       (if (looking-at "[Ss]ubject:")
 715           (progn
 716             (overlay-put (make-overlay (point) (re-search-forward ":"))
 717                          'face 'message-header-name)
 718             (overlay-put (make-overlay (point) (re-search-forward ".*$"))
 719                          'face 'message-header-subject))
 720         (if (looking-at "[Ff]rom:")
 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-other)))))))
 726
 727 (defun notmuch-show-markup-header (message-begin depth)
 728   "Buttonize and decorate faces in a message header.
 729
 730 MESSAGE-BEGIN is the position of the absolute first character in
 731 the message (including all delimiters that will end up being
 732 invisible etc.). This is to allow a button to reliably extend to
 733 the beginning of the message even if point is positioned at an
 734 invisible character (such as the beginning of the buffer).
 735
 736 DEPTH specifies the depth at which this message appears in the
 737 tree of the current thread, (the top-level messages have depth 0
 738 and each reply increases depth by 1)."
 739   (re-search-forward notmuch-show-header-begin-regexp)
 740   (forward-line)
 741   (let ((beg (point-marker))
 742         (summary-end (copy-marker (line-beginning-position 2)))
 743         (subject-end (copy-marker (line-end-position 2)))
 744         (invis-spec (make-symbol "notmuch-show-header"))
 745         (btn nil))
 746     (re-search-forward notmuch-show-header-end-regexp)
 747     (beginning-of-line)
 748     (let ((end (point-marker)))
 749       (indent-rigidly beg end depth)
 750       (goto-char beg)
 751       (setq btn (make-button message-begin summary-end :type 'notmuch-button-body-toggle-type))
 752       (forward-line)
 753       (add-to-invisibility-spec invis-spec)
 754       (overlay-put (make-overlay subject-end end)
 755                    'invisible invis-spec)
 756       (make-button (line-beginning-position) subject-end
 757                    'invisibility-spec invis-spec
 758                    :type 'notmuch-button-headers-toggle-type)
 759       (while (looking-at "[[:space:]]*[A-Za-z][-A-Za-z0-9]*:")
 760         (beginning-of-line)
 761         (notmuch-fontify-headers)
 762         (forward-line)
 763         )
 764       (goto-char end)
 765       (insert "\n")
 766       (set-marker beg nil)
 767       (set-marker summary-end nil)
 768       (set-marker subject-end nil)
 769       (set-marker end nil)
 770       )
 771   btn))
 772
 773 (defun notmuch-show-markup-message ()
 774   (if (re-search-forward notmuch-show-message-begin-regexp nil t)
 775       (let ((message-begin (match-beginning 0)))
 776         (re-search-forward notmuch-show-depth-match-regexp)
 777         (let ((depth (string-to-number (buffer-substring (match-beginning 1) (match-end 1))))
 778               (match (string= "1" (buffer-substring (match-beginning 2) (match-end 2))))
 779               (btn nil))
 780           (setq btn (notmuch-show-markup-header message-begin depth))
 781           (notmuch-show-markup-body depth match btn)))
 782     (goto-char (point-max))))
 783
 784 (defun notmuch-show-hide-markers ()
 785   (save-excursion
 786     (goto-char (point-min))
 787     (while (not (eobp))
 788       (if (re-search-forward notmuch-show-marker-regexp nil t)
 789           (progn
 790             (overlay-put (make-overlay (match-beginning 0) (+ (match-end 0) 1))
 791                          'invisible 'notmuch-show-marker))
 792         (goto-char (point-max))))))
 793
 794 (defun notmuch-show-markup-messages ()
 795   (save-excursion
 796     (goto-char (point-min))
 797     (while (not (eobp))
 798       (notmuch-show-markup-message)))
 799   (notmuch-show-hide-markers))
 800
 801 (defun notmuch-documentation-first-line (symbol)
 802   "Return the first line of the documentation string for SYMBOL."
 803   (let ((doc (documentation symbol)))
 804     (if doc
 805         (with-temp-buffer
 806           (insert (documentation symbol t))
 807           (goto-char (point-min))
 808           (let ((beg (point)))
 809             (end-of-line)
 810             (buffer-substring beg (point))))
 811       "")))
 812
 813 (defun notmuch-prefix-key-description (key)
 814   "Given a prefix key code, return a human-readable string representation.
 815
 816 This is basically just `format-kbd-macro' but we also convert ESC to M-."
 817   (let ((desc (format-kbd-macro (vector key))))
 818     (if (string= desc "ESC")
 819         "M-"
 820       (concat desc " "))))
 821
 822 ; I would think that emacs would have code handy for walking a keymap
 823 ; and generating strings for each key, and I would prefer to just call
 824 ; that. But I couldn't find any (could be all implemented in C I
 825 ; suppose), so I wrote my own here.
 826 (defun notmuch-substitute-one-command-key-with-prefix (prefix binding)
 827   "For a key binding, return a string showing a human-readable
 828 representation of the prefixed key as well as the first line of
 829 documentation from the bound function.
 830
 831 For a mouse binding, return nil."
 832   (let ((key (car binding))
 833         (action (cdr binding)))
 834     (if (mouse-event-p key)
 835         nil
 836       (if (keymapp action)
 837           (let ((substitute (apply-partially 'notmuch-substitute-one-command-key-with-prefix (notmuch-prefix-key-description key))))
 838             (mapconcat substitute (cdr action) "\n"))
 839         (concat prefix (format-kbd-macro (vector key))
 840                 "\t"
 841                 (notmuch-documentation-first-line action))))))
 842
 843 (defalias 'notmuch-substitute-one-command-key
 844   (apply-partially 'notmuch-substitute-one-command-key-with-prefix nil))
 845
 846 (defun notmuch-substitute-command-keys (doc)
 847   "Like `substitute-command-keys' but with documentation, not function names."
 848   (let ((beg 0))
 849     (while (string-match "\\\\{\\([^}[:space:]]*\\)}" doc beg)
 850       (let ((map (substring doc (match-beginning 1) (match-end 1))))
 851         (setq doc (replace-match (mapconcat 'notmuch-substitute-one-command-key
 852                                             (cdr (symbol-value (intern map))) "\n") 1 1 doc)))
 853       (setq beg (match-end 0)))
 854     doc))
 855
 856 (defun notmuch-help ()
 857   "Display help for the current notmuch mode."
 858   (interactive)
 859   (let* ((mode major-mode)
 860          (doc (substitute-command-keys (notmuch-substitute-command-keys (documentation mode t)))))
 861     (with-current-buffer (generate-new-buffer "*notmuch-help*")
 862       (insert doc)
 863       (goto-char (point-min))
 864       (set-buffer-modified-p nil)
 865       (view-buffer (current-buffer) 'kill-buffer-if-not-modified))))
 866
 867 ;;;###autoload
 868 (defun notmuch-show-mode ()
 869   "Major mode for viewing a thread with notmuch.
 870
 871 This buffer contains the results of the \"notmuch show\" command
 872 for displaying a single thread of email from your email archives.
 873
 874 By default, various components of email messages, (citations,
 875 signatures, already-read messages), are hidden. You can make
 876 these parts visible by clicking with the mouse button or by
 877 pressing RET after positioning the cursor on a hidden part, (for
 878 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
 879
 880 Reading the thread sequentially is well-supported by pressing
 881 \\[notmuch-show-advance-marking-read-and-archiving]. This will scroll the current message (if necessary),
 882 advance to the next message, or advance to the next thread (if
 883 already on the last message of a thread). As each message is
 884 scrolled away its \"unread\" tag will be removed, and as each
 885 thread is scrolled away the \"inbox\" tag will be removed from
 886 each message in the thread.
 887
 888 Other commands are available to read or manipulate the thread more
 889 selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages without
 890 removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread without
 891 scrolling through with \\[notmuch-show-advance-marking-read-and-archiving]).
 892
 893 You can add or remove arbitary tags from the current message with
 894 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
 895
 896 All currently available key bindings:
 897
 898 \\{notmuch-show-mode-map}"
 899   (interactive)
 900   (kill-all-local-variables)
 901   (add-to-invisibility-spec 'notmuch-show-marker)
 902   (use-local-map notmuch-show-mode-map)
 903   (setq major-mode 'notmuch-show-mode
 904         mode-name "notmuch-show")
 905   (setq buffer-read-only t))
 906
 907 (defgroup notmuch nil
 908   "Notmuch mail reader for Emacs."
 909   :group 'mail)
 910
 911 (defcustom notmuch-show-hook nil
 912   "List of functions to call when notmuch displays a message."
 913   :type 'hook
 914   :options '(goto-address)
 915   :group 'notmuch)
 916
 917 (defcustom notmuch-search-hook nil
 918   "List of functions to call when notmuch displays the search results."
 919   :type 'hook
 920   :options '(hl-line-mode)
 921   :group 'notmuch)
 922
 923 ; Make show mode a bit prettier, highlighting URLs and using word wrap
 924
 925 (defun notmuch-show-pretty-hook ()
 926   (goto-address-mode 1)
 927   (visual-line-mode))
 928
 929 (add-hook 'notmuch-show-hook 'notmuch-show-pretty-hook)
 930 (add-hook 'notmuch-search-hook
 931           (lambda()
 932             (hl-line-mode 1) ))
 933
 934 (defun notmuch-show (thread-id &optional parent-buffer query-context)
 935   "Run \"notmuch show\" with the given thread ID and display results.
 936
 937 The optional PARENT-BUFFER is the notmuch-search buffer from
 938 which this notmuch-show command was executed, (so that the next
 939 thread from that buffer can be show when done with this one).
 940
 941 The optional QUERY-CONTEXT is a notmuch search term. Only messages from the thread
 942 matching this search term are shown if non-nil. "
 943   (interactive "sNotmuch show: ")
 944   (let ((buffer (get-buffer-create (concat "*notmuch-show-" thread-id "*"))))
 945     (switch-to-buffer buffer)
 946     (notmuch-show-mode)
 947     (set (make-local-variable 'notmuch-show-parent-buffer) parent-buffer)
 948     (let ((proc (get-buffer-process (current-buffer)))
 949           (inhibit-read-only t))
 950       (if proc
 951           (error "notmuch search process already running for query `%s'" thread-id)
 952         )
 953       (erase-buffer)
 954       (goto-char (point-min))
 955       (save-excursion
 956         (let* ((basic-args (list notmuch-command nil t nil "show" "--entire-thread" thread-id))
 957                 (args (if query-context (append basic-args (list "and (" query-context ")")) basic-args)))
 958           (apply 'call-process args)
 959           (when (and (eq (buffer-size) 0) query-context)
 960             (apply 'call-process basic-args)))
 961         (notmuch-show-markup-messages)
 962         )
 963       (run-hooks 'notmuch-show-hook)
 964       ; Move straight to the first open message
 965       (if (not (notmuch-show-message-open-p))
 966           (notmuch-show-next-open-message))
 967       )))
 968
 969 (defvar notmuch-search-authors-width 40
 970   "Number of columns to use to display authors in a notmuch-search buffer.")
 971
 972 (defvar notmuch-search-mode-map
 973   (let ((map (make-sparse-keymap)))
 974     (define-key map "?" 'notmuch-help)
 975     (define-key map "q" 'kill-this-buffer)
 976     (define-key map "x" 'kill-this-buffer)
 977     (define-key map (kbd "<DEL>") 'notmuch-search-scroll-down)
 978     (define-key map "b" 'notmuch-search-scroll-down)
 979     (define-key map " " 'notmuch-search-scroll-up)
 980     (define-key map "<" 'notmuch-search-first-thread)
 981     (define-key map ">" 'notmuch-search-last-thread)
 982     (define-key map "p" 'notmuch-search-previous-thread)
 983     (define-key map "n" 'notmuch-search-next-thread)
 984     (define-key map "r" 'notmuch-search-reply-to-thread)
 985     (define-key map "m" 'message-mail)
 986     (define-key map "s" 'notmuch-search)
 987     (define-key map "o" 'notmuch-search-toggle-order)
 988     (define-key map "=" 'notmuch-search-refresh-view)
 989     (define-key map "t" 'notmuch-search-filter-by-tag)
 990     (define-key map "f" 'notmuch-search-filter)
 991     (define-key map [mouse-1] 'notmuch-search-show-thread)
 992     (define-key map "*" 'notmuch-search-operate-all)
 993     (define-key map "a" 'notmuch-search-archive-thread)
 994     (define-key map "-" 'notmuch-search-remove-tag)
 995     (define-key map "+" 'notmuch-search-add-tag)
 996     (define-key map (kbd "RET") 'notmuch-search-show-thread)
 997     map)
 998   "Keymap for \"notmuch search\" buffers.")
 999 (fset 'notmuch-search-mode-map notmuch-search-mode-map)
1000
1001 (defvar notmuch-search-query-string)
1002 (defvar notmuch-search-oldest-first t
1003   "Show the oldest mail first in the search-mode")
1004
1005 (defvar notmuch-search-disjunctive-regexp      "\\<[oO][rR]\\>")
1006
1007 (defun notmuch-search-scroll-up ()
1008   "Move forward through search results by one window's worth."
1009   (interactive)
1010   (condition-case nil
1011       (scroll-up nil)
1012     ((end-of-buffer) (notmuch-search-last-thread))))
1013
1014 (defun notmuch-search-scroll-down ()
1015   "Move backward through the search results by one window's worth."
1016   (interactive)
1017   ; I don't know why scroll-down doesn't signal beginning-of-buffer
1018   ; the way that scroll-up signals end-of-buffer, but c'est la vie.
1019   ;
1020   ; So instead of trapping a signal we instead check whether the
1021   ; window begins on the first line of the buffer and if so, move
1022   ; directly to that position. (We have to count lines since the
1023   ; window-start position is not the same as point-min due to the
1024   ; invisible thread-ID characters on the first line.
1025   (if (equal (count-lines (point-min) (window-start)) 0)
1026       (goto-char (point-min))
1027     (scroll-down nil)))
1028
1029 (defun notmuch-search-next-thread ()
1030   "Select the next thread in the search results."
1031   (interactive)
1032   (forward-line 1))
1033
1034 (defun notmuch-search-previous-thread ()
1035   "Select the previous thread in the search results."
1036   (interactive)
1037   (forward-line -1))
1038
1039 (defun notmuch-search-last-thread ()
1040   "Select the last thread in the search results."
1041   (interactive)
1042   (goto-char (point-max))
1043   (forward-line -2))
1044
1045 (defun notmuch-search-first-thread ()
1046   "Select the first thread in the search results."
1047   (interactive)
1048   (goto-char (point-min)))
1049
1050 (defface notmuch-message-summary-face
1051  '((((class color) (background light)) (:background "#f0f0f0"))
1052    (((class color) (background dark)) (:background "#303030")))
1053  "Face for the single-line message summary in notmuch-show-mode."
1054  :group 'notmuch)
1055
1056 (defface notmuch-tag-face
1057   '((((class color)
1058       (background dark))
1059      (:foreground "OliveDrab1"))
1060     (((class color)
1061       (background light))
1062      (:foreground "navy blue" :bold t))
1063     (t
1064      (:bold t)))
1065   "Notmuch search mode face used to highligh tags."
1066   :group 'notmuch)
1067
1068 (defvar notmuch-tag-face-alist nil
1069   "List containing the tag list that need to be highlighed")
1070
1071 (defvar notmuch-search-font-lock-keywords  nil)
1072
1073 ;;;###autoload
1074 (defun notmuch-search-mode ()
1075   "Major mode displaying results of a notmuch search.
1076
1077 This buffer contains the results of a \"notmuch search\" of your
1078 email archives. Each line in the buffer represents a single
1079 thread giving a summary of the thread (a relative date, the
1080 number of matched messages and total messages in the thread,
1081 participants in the thread, a representative subject line, and
1082 any tags).
1083
1084 Pressing \\[notmuch-search-show-thread] on any line displays that thread. The '\\[notmuch-search-add-tag]' and '\\[notmuch-search-remove-tag]'
1085 keys can be used to add or remove tags from a thread. The '\\[notmuch-search-archive-thread]' key
1086 is a convenience for archiving a thread (removing the \"inbox\"
1087 tag). The '\\[notmuch-search-operate-all]' key can be used to add or remove a tag from all
1088 threads in the current buffer.
1089
1090 Other useful commands are '\\[notmuch-search-filter]' for filtering the current search
1091 based on an additional query string, '\\[notmuch-search-filter-by-tag]' for filtering to include
1092 only messages with a given tag, and '\\[notmuch-search]' to execute a new, global
1093 search.
1094
1095 Complete list of currently available key bindings:
1096
1097 \\{notmuch-search-mode-map}"
1098   (interactive)
1099   (kill-all-local-variables)
1100   (make-local-variable 'notmuch-search-query-string)
1101   (make-local-variable 'notmuch-search-oldest-first)
1102   (set (make-local-variable 'scroll-preserve-screen-position) t)
1103   (add-to-invisibility-spec 'notmuch-search)
1104   (use-local-map notmuch-search-mode-map)
1105   (setq truncate-lines t)
1106   (setq major-mode 'notmuch-search-mode
1107         mode-name "notmuch-search")
1108   (setq buffer-read-only t)
1109   (if (not notmuch-tag-face-alist)
1110       (add-to-list 'notmuch-search-font-lock-keywords (list
1111                 "(\\([^)]*\\))$" '(1  'notmuch-tag-face)))
1112     (let ((notmuch-search-tags (mapcar 'car notmuch-tag-face-alist)))
1113       (loop for notmuch-search-tag  in notmuch-search-tags
1114             do (add-to-list 'notmuch-search-font-lock-keywords (list
1115                         (concat "([^)]*\\(" notmuch-search-tag "\\)[^)]*)$")
1116                         `(1  ,(cdr (assoc notmuch-search-tag notmuch-tag-face-alist))))))))
1117   (set (make-local-variable 'font-lock-defaults)
1118          '(notmuch-search-font-lock-keywords t)))
1119
1120 (defun notmuch-search-find-thread-id ()
1121   "Return the thread for the current thread"
1122   (get-text-property (point) 'notmuch-search-thread-id))
1123
1124 (defun notmuch-search-find-authors ()
1125   "Return the authors for the current thread"
1126   (get-text-property (point) 'notmuch-search-authors))
1127
1128 (defun notmuch-search-find-subject ()
1129   "Return the subject for the current thread"
1130   (get-text-property (point) 'notmuch-search-subject))
1131
1132 (defun notmuch-search-show-thread ()
1133   "Display the currently selected thread."
1134   (interactive)
1135   (let ((thread-id (notmuch-search-find-thread-id)))
1136     (if (> (length thread-id) 0)
1137         (notmuch-show thread-id (current-buffer) notmuch-search-query-string)
1138       (error "End of search results"))))
1139
1140 (defun notmuch-search-reply-to-thread ()
1141   "Begin composing a reply to the entire current thread in a new buffer."
1142   (interactive)
1143   (let ((message-id (notmuch-search-find-thread-id)))
1144     (notmuch-reply message-id)))
1145
1146 (defun notmuch-call-notmuch-process (&rest args)
1147   "Synchronously invoke \"notmuch\" with the given list of arguments.
1148
1149 Output from the process will be presented to the user as an error
1150 and will also appear in a buffer named \"*Notmuch errors*\"."
1151   (let ((error-buffer (get-buffer-create "*Notmuch errors*")))
1152     (with-current-buffer error-buffer
1153         (erase-buffer))
1154     (if (eq (apply 'call-process notmuch-command nil error-buffer nil args) 0)
1155         (point)
1156       (progn
1157         (with-current-buffer error-buffer
1158           (let ((beg (point-min))
1159                 (end (- (point-max) 1)))
1160             (error (buffer-substring beg end))
1161             ))))))
1162
1163 (defun notmuch-search-set-tags (tags)
1164   (save-excursion
1165     (end-of-line)
1166     (re-search-backward "(")
1167     (forward-char)
1168     (let ((beg (point))
1169           (inhibit-read-only t))
1170       (re-search-forward ")")
1171       (backward-char)
1172       (let ((end (point)))
1173         (delete-region beg end)
1174         (insert (mapconcat  'identity tags " "))))))
1175
1176 (defun notmuch-search-get-tags ()
1177   (save-excursion
1178     (end-of-line)
1179     (re-search-backward "(")
1180     (let ((beg (+ (point) 1)))
1181       (re-search-forward ")")
1182       (let ((end (- (point) 1)))
1183         (split-string (buffer-substring beg end))))))
1184
1185 (defun notmuch-search-add-tag (tag)
1186   "Add a tag to the currently selected thread.
1187
1188 The tag is added to messages in the currently selected thread
1189 which match the current search terms."
1190   (interactive
1191    (list (notmuch-select-tag-with-completion "Tag to add: ")))
1192   (notmuch-call-notmuch-process "tag" (concat "+" tag) (notmuch-search-find-thread-id))
1193   (notmuch-search-set-tags (delete-dups (sort (cons tag (notmuch-search-get-tags)) 'string<))))
1194
1195 (defun notmuch-search-remove-tag (tag)
1196   "Remove a tag from the currently selected thread.
1197
1198 The tag is removed from messages in the currently selected thread
1199 which match the current search terms."
1200   (interactive
1201    (list (notmuch-select-tag-with-completion "Tag to remove: " (notmuch-search-find-thread-id))))
1202   (notmuch-call-notmuch-process "tag" (concat "-" tag) (notmuch-search-find-thread-id))
1203   (notmuch-search-set-tags (delete tag (notmuch-search-get-tags))))
1204
1205 (defun notmuch-search-archive-thread ()
1206   "Archive the currently selected thread (remove its \"inbox\" tag).
1207
1208 This function advances the next thread when finished."
1209   (interactive)
1210   (notmuch-search-remove-tag "inbox")
1211   (forward-line))
1212
1213 (defun notmuch-search-process-sentinel (proc msg)
1214   "Add a message to let user know when \"notmuch search\" exits"
1215   (let ((buffer (process-buffer proc))
1216         (status (process-status proc))
1217         (exit-status (process-exit-status proc)))
1218     (if (memq status '(exit signal))
1219         (if (buffer-live-p buffer)
1220             (with-current-buffer buffer
1221               (save-excursion
1222                 (let ((inhibit-read-only t))
1223                   (goto-char (point-max))
1224                   (if (eq status 'signal)
1225                       (insert "Incomplete search results (search process was killed).\n"))
1226                   (if (eq status 'exit)
1227                       (progn
1228                         (insert "End of search results.")
1229                         (if (not (= exit-status 0))
1230                             (insert (format " (process returned %d)" exit-status)))
1231                         (insert "\n"))))))))))
1232
1233 (defun notmuch-search-process-filter (proc string)
1234   "Process and filter the output of \"notmuch search\""
1235   (let ((buffer (process-buffer proc)))
1236     (if (buffer-live-p buffer)
1237         (with-current-buffer buffer
1238           (save-excursion
1239             (let ((line 0)
1240                   (more t)
1241                   (inhibit-read-only t))
1242               (while more
1243                 (if (string-match "^\\(thread:[0-9A-Fa-f]*\\) \\(.*\\) \\(\\[[0-9/]*\\]\\) \\([^:]*\\); \\(.*\\) (\\([^()]*\\))$" string line)
1244                     (let* ((thread-id (match-string 1 string))
1245                            (date (match-string 2 string))
1246                            (count (match-string 3 string))
1247                            (authors (match-string 4 string))
1248                            (authors-length (length authors))
1249                            (subject (match-string 5 string))
1250                            (tags (match-string 6 string)))
1251                       (if (> authors-length 40)
1252                           (set 'authors (concat (substring authors 0 (- 40 3)) "...")))
1253                       (goto-char (point-max))
1254                       (let ((beg (point-marker)))
1255                         (insert (format "%s %-7s %-40s %s (%s)\n" date count authors subject tags))
1256                         (put-text-property beg (point-marker) 'notmuch-search-thread-id thread-id)
1257                         (put-text-property beg (point-marker) 'notmuch-search-authors authors)
1258                         (put-text-property beg (point-marker) 'notmuch-search-subject subject))
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   (let ((grouped-query (if (string-match-p notmuch-search-disjunctive-regexp query) (concat "( " query " )") query)))
1356     (notmuch-search (concat notmuch-search-query-string " and " grouped-query) notmuch-search-oldest-first)))
1357
1358 (defun notmuch-search-filter-by-tag (tag)
1359   "Filter the current search results based on a single tag.
1360
1361 Runs a new search matching only messages that match both the
1362 current search results AND that are tagged with the given tag."
1363   (interactive
1364    (list (notmuch-select-tag-with-completion "Filter by tag: ")))
1365   (notmuch-search (concat notmuch-search-query-string " and tag:" tag) notmuch-search-oldest-first))
1366
1367
1368 ;;;###autoload
1369 (defun notmuch ()
1370   "Run notmuch to display all mail with tag of 'inbox'"
1371   (interactive)
1372   (notmuch-search "tag:inbox" notmuch-search-oldest-first))
1373
1374 (setq mail-user-agent 'message-user-agent)
1375
1376 (defvar notmuch-folder-mode-map
1377   (let ((map (make-sparse-keymap)))
1378     (define-key map "?" 'notmuch-help)
1379     (define-key map "x" 'kill-this-buffer)
1380     (define-key map "q" 'kill-this-buffer)
1381     (define-key map ">" 'notmuch-folder-last)
1382     (define-key map "<" 'notmuch-folder-first)
1383     (define-key map "=" 'notmuch-folder)
1384     (define-key map "s" 'notmuch-search)
1385     (define-key map [mouse-1] 'notmuch-folder-show-search)
1386     (define-key map (kbd "RET") 'notmuch-folder-show-search)
1387     (define-key map "p" 'notmuch-folder-previous)
1388     (define-key map "n" 'notmuch-folder-next)
1389     map)
1390   "Keymap for \"notmuch folder\" buffers.")
1391
1392 (fset 'notmuch-folder-mode-map notmuch-folder-mode-map)
1393
1394 (defcustom notmuch-folders (quote (("inbox" . "tag:inbox") ("unread" . "tag:unread")))
1395   "List of searches for the notmuch folder view"
1396   :type '(alist :key-type (string) :value-type (string))
1397   :group 'notmuch)
1398
1399 (defun notmuch-folder-mode ()
1400   "Major mode for showing notmuch 'folders'.
1401
1402 This buffer contains a list of message counts returned by a
1403 customizable set of searches of your email archives. Each line in
1404 the buffer shows the name of a saved search and the resulting
1405 message count.
1406
1407 Pressing RET on any line opens a search window containing the
1408 results for the saved search on that line.
1409
1410 Here is an example of how the search list could be
1411 customized, (the following text would be placed in your ~/.emacs
1412 file):
1413
1414 (setq notmuch-folders '((\"inbox\" . \"tag:inbox\")
1415                         (\"unread\" . \"tag:inbox AND tag:unread\")
1416                         (\"notmuch\" . \"tag:inbox AND to:notmuchmail.org\")))
1417
1418 Of course, you can have any number of folders, each configured
1419 with any supported search terms (see \"notmuch help search-terms\").
1420
1421 Currently available key bindings:
1422
1423 \\{notmuch-folder-mode-map}"
1424   (interactive)
1425   (kill-all-local-variables)
1426   (use-local-map 'notmuch-folder-mode-map)
1427   (setq truncate-lines t)
1428   (hl-line-mode 1)
1429   (setq major-mode 'notmuch-folder-mode
1430         mode-name "notmuch-folder")
1431   (setq buffer-read-only t))
1432
1433 (defun notmuch-folder-next ()
1434   "Select the next folder in the list."
1435   (interactive)
1436   (forward-line 1)
1437   (if (eobp)
1438       (forward-line -1)))
1439
1440 (defun notmuch-folder-previous ()
1441   "Select the previous folder in the list."
1442   (interactive)
1443   (forward-line -1))
1444
1445 (defun notmuch-folder-first ()
1446   "Select the first folder in the list."
1447   (interactive)
1448   (goto-char (point-min)))
1449
1450 (defun notmuch-folder-last ()
1451   "Select the last folder in the list."
1452   (interactive)
1453   (goto-char (point-max))
1454   (forward-line -1))
1455
1456 (defun notmuch-folder-add (folders)
1457   (if folders
1458       (let ((name (car (car folders)))
1459             (inhibit-read-only t)
1460             (search (cdr (car folders))))
1461         (insert name)
1462         (indent-to 16 1)
1463         (call-process notmuch-command nil t nil "count" search)
1464         (notmuch-folder-add (cdr folders)))))
1465
1466 (defun notmuch-folder-find-name ()
1467   (save-excursion
1468     (beginning-of-line)
1469     (let ((beg (point)))
1470       (forward-word)
1471       (filter-buffer-substring beg (point)))))
1472
1473 (defun notmuch-folder-show-search (&optional folder)
1474   "Show a search window for the search related to the specified folder."
1475   (interactive)
1476   (if (null folder)
1477       (setq folder (notmuch-folder-find-name)))
1478   (let ((search (assoc folder notmuch-folders)))
1479     (if search
1480         (notmuch-search (cdr search) notmuch-search-oldest-first))))
1481
1482 ;;;###autoload
1483 (defun notmuch-folder ()
1484   "Show the notmuch folder view and update the displayed counts."
1485   (interactive)
1486   (let ((buffer (get-buffer-create "*notmuch-folders*")))
1487     (switch-to-buffer buffer)
1488     (let ((inhibit-read-only t)
1489           (n (line-number-at-pos)))
1490       (erase-buffer)
1491       (notmuch-folder-mode)
1492       (notmuch-folder-add notmuch-folders)
1493       (goto-char (point-min))
1494       (goto-line n))))
1495
1496 (provide 'notmuch)