git.notmuchmail.org Git - notmuch/blob - emacs/notmuch.el

   1 ;; notmuch.el --- run notmuch within emacs
   2 ;;
   3 ;; Copyright © Carl Worth
   4 ;;
   5 ;; This file is part of Notmuch.
   6 ;;
   7 ;; Notmuch is free software: you can redistribute it and/or modify it
   8 ;; under the terms of the GNU General Public License as published by
   9 ;; the Free Software Foundation, either version 3 of the License, or
  10 ;; (at your option) any later version.
  11 ;;
  12 ;; Notmuch is distributed in the hope that it will be useful, but
  13 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 ;; General Public License for more details.
  16 ;;
  17 ;; You should have received a copy of the GNU General Public License
  18 ;; along with Notmuch.  If not, see <http://www.gnu.org/licenses/>.
  19 ;;
  20 ;; Authors: Carl Worth <cworth@cworth.org>
  21
  22 ;; This is an emacs-based interface to the notmuch mail system.
  23 ;;
  24 ;; You will first need to have the notmuch program installed and have a
  25 ;; notmuch database built in order to use this. See
  26 ;; http://notmuchmail.org for details.
  27 ;;
  28 ;; To install this software, copy it to a directory that is on the
  29 ;; `load-path' variable within emacs (a good candidate is
  30 ;; /usr/local/share/emacs/site-lisp). If you are viewing this from the
  31 ;; notmuch source distribution then you can simply run:
  32 ;;
  33 ;;      sudo make install-emacs
  34 ;;
  35 ;; to install it.
  36 ;;
  37 ;; Then, to actually run it, add:
  38 ;;
  39 ;;      (require 'notmuch)
  40 ;;
  41 ;; to your ~/.emacs file, and then run "M-x notmuch" from within emacs,
  42 ;; or run:
  43 ;;
  44 ;;      emacs -f notmuch
  45 ;;
  46 ;; Have fun, and let us know if you have any comment, questions, or
  47 ;; kudos: Notmuch list <notmuch@notmuchmail.org> (subscription is not
  48 ;; required, but is available from http://notmuchmail.org).
  49
  50 (eval-when-compile (require 'cl))
  51 (require 'mm-view)
  52 (require 'message)
  53
  54 (require 'notmuch-lib)
  55 (require 'notmuch-tag)
  56 (require 'notmuch-show)
  57 (require 'notmuch-mua)
  58 (require 'notmuch-hello)
  59 (require 'notmuch-maildir-fcc)
  60 (require 'notmuch-message)
  61 (require 'notmuch-parser)
  62
  63 (defcustom notmuch-search-result-format
  64   `(("date" . "%12s ")
  65     ("count" . "%-7s ")
  66     ("authors" . "%-20s ")
  67     ("subject" . "%s ")
  68     ("tags" . "(%s)"))
  69   "Search result formatting. Supported fields are:
  70         date, count, authors, subject, tags
  71 For example:
  72         (setq notmuch-search-result-format \(\(\"authors\" . \"%-40s\"\)
  73                                              \(\"subject\" . \"%s\"\)\)\)
  74 Line breaks are permitted in format strings (though this is
  75 currently experimental).  Note that a line break at the end of an
  76 \"authors\" field will get elided if the authors list is long;
  77 place it instead at the beginning of the following field.  To
  78 enter a line break when setting this variable with setq, use \\n.
  79 To enter a line break in customize, press \\[quoted-insert] C-j."
  80   :type '(alist :key-type (string) :value-type (string))
  81   :group 'notmuch-search)
  82
  83 (defvar notmuch-query-history nil
  84   "Variable to store minibuffer history for notmuch queries")
  85
  86 (defun notmuch-foreach-mime-part (function mm-handle)
  87   (cond ((stringp (car mm-handle))
  88          (dolist (part (cdr mm-handle))
  89            (notmuch-foreach-mime-part function part)))
  90         ((bufferp (car mm-handle))
  91          (funcall function mm-handle))
  92         (t (dolist (part mm-handle)
  93              (notmuch-foreach-mime-part function part)))))
  94
  95 (defun notmuch-count-attachments (mm-handle)
  96   (let ((count 0))
  97     (notmuch-foreach-mime-part
  98      (lambda (p)
  99        (let ((disposition (mm-handle-disposition p)))
 100          (and (listp disposition)
 101               (or (equal (car disposition) "attachment")
 102                   (and (equal (car disposition) "inline")
 103                        (assq 'filename disposition)))
 104               (incf count))))
 105      mm-handle)
 106     count))
 107
 108 (defun notmuch-save-attachments (mm-handle &optional queryp)
 109   (notmuch-foreach-mime-part
 110    (lambda (p)
 111      (let ((disposition (mm-handle-disposition p)))
 112        (and (listp disposition)
 113             (or (equal (car disposition) "attachment")
 114                 (and (equal (car disposition) "inline")
 115                      (assq 'filename disposition)))
 116             (or (not queryp)
 117                 (y-or-n-p
 118                  (concat "Save '" (cdr (assq 'filename disposition)) "' ")))
 119             (mm-save-part p))))
 120    mm-handle))
 121
 122 (defun notmuch-documentation-first-line (symbol)
 123   "Return the first line of the documentation string for SYMBOL."
 124   (let ((doc (documentation symbol)))
 125     (if doc
 126         (with-temp-buffer
 127           (insert (documentation symbol t))
 128           (goto-char (point-min))
 129           (let ((beg (point)))
 130             (end-of-line)
 131             (buffer-substring beg (point))))
 132       "")))
 133
 134 (defun notmuch-prefix-key-description (key)
 135   "Given a prefix key code, return a human-readable string representation.
 136
 137 This is basically just `format-kbd-macro' but we also convert ESC to M-."
 138   (let ((desc (format-kbd-macro (vector key))))
 139     (if (string= desc "ESC")
 140         "M-"
 141       (concat desc " "))))
 142
 143 ;; I would think that emacs would have code handy for walking a keymap
 144 ;; and generating strings for each key, and I would prefer to just call
 145 ;; that. But I couldn't find any (could be all implemented in C I
 146 ;; suppose), so I wrote my own here.
 147 (defun notmuch-substitute-one-command-key-with-prefix (prefix binding)
 148   "For a key binding, return a string showing a human-readable
 149 representation of the prefixed key as well as the first line of
 150 documentation from the bound function.
 151
 152 For a mouse binding, return nil."
 153   (let ((key (car binding))
 154         (action (cdr binding)))
 155     (if (mouse-event-p key)
 156         nil
 157       (if (keymapp action)
 158           (let ((substitute (apply-partially 'notmuch-substitute-one-command-key-with-prefix (notmuch-prefix-key-description key)))
 159                 (as-list))
 160             (map-keymap (lambda (a b)
 161                           (push (cons a b) as-list))
 162                         action)
 163             (mapconcat substitute as-list "\n"))
 164         (concat prefix (format-kbd-macro (vector key))
 165                 "\t"
 166                 (notmuch-documentation-first-line action))))))
 167
 168 (defun notmuch-substitute-command-keys-one (key)
 169   ;; A `keymap' key indicates inheritance from a parent keymap - the
 170   ;; inherited mappings follow, so there is nothing to print for
 171   ;; `keymap' itself.
 172   (when (not (eq key 'keymap))
 173     (notmuch-substitute-one-command-key-with-prefix nil key)))
 174
 175 (defun notmuch-substitute-command-keys (doc)
 176   "Like `substitute-command-keys' but with documentation, not function names."
 177   (let ((beg 0))
 178     (while (string-match "\\\\{\\([^}[:space:]]*\\)}" doc beg)
 179       (let* ((keymap-name (substring doc (match-beginning 1) (match-end 1)))
 180              (keymap (symbol-value (intern keymap-name))))
 181         (setq doc (replace-match
 182                    (mapconcat #'notmuch-substitute-command-keys-one
 183                               (cdr keymap) "\n")
 184                    1 1 doc)))
 185       (setq beg (match-end 0)))
 186     doc))
 187
 188 (defun notmuch-help ()
 189   "Display help for the current notmuch mode."
 190   (interactive)
 191   (let* ((mode major-mode)
 192          (doc (substitute-command-keys (notmuch-substitute-command-keys (documentation mode t)))))
 193     (with-current-buffer (generate-new-buffer "*notmuch-help*")
 194       (insert doc)
 195       (goto-char (point-min))
 196       (set-buffer-modified-p nil)
 197       (view-buffer (current-buffer) 'kill-buffer-if-not-modified))))
 198
 199 (require 'hl-line)
 200
 201 (defun notmuch-hl-line-mode ()
 202   (prog1 (hl-line-mode)
 203     (when hl-line-overlay
 204       (overlay-put hl-line-overlay 'priority 1))))
 205
 206 (defcustom notmuch-search-hook '(notmuch-hl-line-mode)
 207   "List of functions to call when notmuch displays the search results."
 208   :type 'hook
 209   :options '(notmuch-hl-line-mode)
 210   :group 'notmuch-search
 211   :group 'notmuch-hooks)
 212
 213 (defvar notmuch-search-mode-map
 214   (let ((map (make-sparse-keymap)))
 215     (define-key map "?" 'notmuch-help)
 216     (define-key map "q" 'notmuch-kill-this-buffer)
 217     (define-key map "x" 'notmuch-kill-this-buffer)
 218     (define-key map (kbd "<DEL>") 'notmuch-search-scroll-down)
 219     (define-key map "b" 'notmuch-search-scroll-down)
 220     (define-key map " " 'notmuch-search-scroll-up)
 221     (define-key map "<" 'notmuch-search-first-thread)
 222     (define-key map ">" 'notmuch-search-last-thread)
 223     (define-key map "p" 'notmuch-search-previous-thread)
 224     (define-key map "n" 'notmuch-search-next-thread)
 225     (define-key map "r" 'notmuch-search-reply-to-thread-sender)
 226     (define-key map "R" 'notmuch-search-reply-to-thread)
 227     (define-key map "m" 'notmuch-mua-new-mail)
 228     (define-key map "s" 'notmuch-search)
 229     (define-key map "o" 'notmuch-search-toggle-order)
 230     (define-key map "c" 'notmuch-search-stash-map)
 231     (define-key map "=" 'notmuch-refresh-this-buffer)
 232     (define-key map "G" 'notmuch-poll-and-refresh-this-buffer)
 233     (define-key map "t" 'notmuch-search-filter-by-tag)
 234     (define-key map "f" 'notmuch-search-filter)
 235     (define-key map [mouse-1] 'notmuch-search-show-thread)
 236     (define-key map "*" 'notmuch-search-tag-all)
 237     (define-key map "a" 'notmuch-search-archive-thread)
 238     (define-key map "-" 'notmuch-search-remove-tag)
 239     (define-key map "+" 'notmuch-search-add-tag)
 240     (define-key map (kbd "RET") 'notmuch-search-show-thread)
 241     map)
 242   "Keymap for \"notmuch search\" buffers.")
 243 (fset 'notmuch-search-mode-map notmuch-search-mode-map)
 244
 245 (defvar notmuch-search-stash-map
 246   (let ((map (make-sparse-keymap)))
 247     (define-key map "i" 'notmuch-search-stash-thread-id)
 248     map)
 249   "Submap for stash commands")
 250 (fset 'notmuch-search-stash-map notmuch-search-stash-map)
 251
 252 (defun notmuch-search-stash-thread-id ()
 253   "Copy thread ID of current thread to kill-ring."
 254   (interactive)
 255   (notmuch-common-do-stash (notmuch-search-find-thread-id)))
 256
 257 (defvar notmuch-search-query-string)
 258 (defvar notmuch-search-target-thread)
 259 (defvar notmuch-search-target-line)
 260
 261 (defvar notmuch-search-disjunctive-regexp      "\\<[oO][rR]\\>")
 262
 263 (defun notmuch-search-scroll-up ()
 264   "Move forward through search results by one window's worth."
 265   (interactive)
 266   (condition-case nil
 267       (scroll-up nil)
 268     ((end-of-buffer) (notmuch-search-last-thread))))
 269
 270 (defun notmuch-search-scroll-down ()
 271   "Move backward through the search results by one window's worth."
 272   (interactive)
 273   ;; I don't know why scroll-down doesn't signal beginning-of-buffer
 274   ;; the way that scroll-up signals end-of-buffer, but c'est la vie.
 275   ;;
 276   ;; So instead of trapping a signal we instead check whether the
 277   ;; window begins on the first line of the buffer and if so, move
 278   ;; directly to that position. (We have to count lines since the
 279   ;; window-start position is not the same as point-min due to the
 280   ;; invisible thread-ID characters on the first line.
 281   (if (equal (count-lines (point-min) (window-start)) 0)
 282       (goto-char (point-min))
 283     (scroll-down nil)))
 284
 285 (defun notmuch-search-next-thread ()
 286   "Select the next thread in the search results."
 287   (interactive)
 288   (when (notmuch-search-get-result)
 289     (goto-char (notmuch-search-result-end))))
 290
 291 (defun notmuch-search-previous-thread ()
 292   "Select the previous thread in the search results."
 293   (interactive)
 294   (if (notmuch-search-get-result)
 295       (unless (bobp)
 296         (goto-char (notmuch-search-result-beginning (- (point) 1))))
 297     ;; We must be past the end; jump to the last result
 298     (notmuch-search-last-thread)))
 299
 300 (defun notmuch-search-last-thread ()
 301   "Select the last thread in the search results."
 302   (interactive)
 303   (goto-char (point-max))
 304   (forward-line -2)
 305   (let ((beg (notmuch-search-result-beginning)))
 306     (when beg (goto-char beg))))
 307
 308 (defun notmuch-search-first-thread ()
 309   "Select the first thread in the search results."
 310   (interactive)
 311   (goto-char (point-min)))
 312
 313 (defface notmuch-message-summary-face
 314  '((((class color) (background light)) (:background "#f0f0f0"))
 315    (((class color) (background dark)) (:background "#303030")))
 316  "Face for the single-line message summary in notmuch-show-mode."
 317  :group 'notmuch-show
 318  :group 'notmuch-faces)
 319
 320 (defface notmuch-search-date
 321   '((t :inherit default))
 322   "Face used in search mode for dates."
 323   :group 'notmuch-search
 324   :group 'notmuch-faces)
 325
 326 (defface notmuch-search-count
 327   '((t :inherit default))
 328   "Face used in search mode for the count matching the query."
 329   :group 'notmuch-search
 330   :group 'notmuch-faces)
 331
 332 (defface notmuch-search-subject
 333   '((t :inherit default))
 334   "Face used in search mode for subjects."
 335   :group 'notmuch-search
 336   :group 'notmuch-faces)
 337
 338 (defface notmuch-search-matching-authors
 339   '((t :inherit default))
 340   "Face used in search mode for authors matching the query."
 341   :group 'notmuch-search
 342   :group 'notmuch-faces)
 343
 344 (defface notmuch-search-non-matching-authors
 345   '((((class color)
 346       (background dark))
 347      (:foreground "grey30"))
 348     (((class color)
 349       (background light))
 350      (:foreground "grey60"))
 351     (t
 352      (:italic t)))
 353   "Face used in search mode for authors not matching the query."
 354   :group 'notmuch-search
 355   :group 'notmuch-faces)
 356
 357 (defface notmuch-tag-face
 358   '((((class color)
 359       (background dark))
 360      (:foreground "OliveDrab1"))
 361     (((class color)
 362       (background light))
 363      (:foreground "navy blue" :bold t))
 364     (t
 365      (:bold t)))
 366   "Face used in search mode face for tags."
 367   :group 'notmuch-search
 368   :group 'notmuch-faces)
 369
 370 (defun notmuch-search-mode ()
 371   "Major mode displaying results of a notmuch search.
 372
 373 This buffer contains the results of a \"notmuch search\" of your
 374 email archives. Each line in the buffer represents a single
 375 thread giving a summary of the thread (a relative date, the
 376 number of matched messages and total messages in the thread,
 377 participants in the thread, a representative subject line, and
 378 any tags).
 379
 380 Pressing \\[notmuch-search-show-thread] on any line displays that
 381 thread. The '\\[notmuch-search-add-tag]' and
 382 '\\[notmuch-search-remove-tag]' keys can be used to add or remove
 383 tags from a thread. The '\\[notmuch-search-archive-thread]' key
 384 is a convenience for archiving a thread (applying changes in
 385 `notmuch-archive-tags'). The '\\[notmuch-search-tag-all]' key can
 386 be used to add and/or remove tags from all messages (as opposed
 387 to threads) that match the current query.  Use with caution, as
 388 this will also tag matching messages that arrived *after*
 389 constructing the buffer.
 390
 391 Other useful commands are '\\[notmuch-search-filter]' for
 392 filtering the current search based on an additional query string,
 393 '\\[notmuch-search-filter-by-tag]' for filtering to include only
 394 messages with a given tag, and '\\[notmuch-search]' to execute a
 395 new, global search.
 396
 397 Complete list of currently available key bindings:
 398
 399 \\{notmuch-search-mode-map}"
 400   (interactive)
 401   (kill-all-local-variables)
 402   (make-local-variable 'notmuch-search-query-string)
 403   (make-local-variable 'notmuch-search-oldest-first)
 404   (make-local-variable 'notmuch-search-target-thread)
 405   (make-local-variable 'notmuch-search-target-line)
 406   (setq notmuch-buffer-refresh-function #'notmuch-search-refresh-view)
 407   (set (make-local-variable 'scroll-preserve-screen-position) t)
 408   (add-to-invisibility-spec (cons 'ellipsis t))
 409   (use-local-map notmuch-search-mode-map)
 410   (setq truncate-lines t)
 411   (setq major-mode 'notmuch-search-mode
 412         mode-name "notmuch-search")
 413   (setq buffer-read-only t))
 414
 415 (defun notmuch-search-get-result (&optional pos)
 416   "Return the result object for the thread at POS (or point).
 417
 418 If there is no thread at POS (or point), returns nil."
 419   (get-text-property (or pos (point)) 'notmuch-search-result))
 420
 421 (defun notmuch-search-result-beginning (&optional pos)
 422   "Return the point at the beginning of the thread at POS (or point).
 423
 424 If there is no thread at POS (or point), returns nil."
 425   (when (notmuch-search-get-result pos)
 426     ;; We pass 1+point because previous-single-property-change starts
 427     ;; searching one before the position we give it.
 428     (previous-single-property-change (1+ (or pos (point)))
 429                                      'notmuch-search-result nil (point-min))))
 430
 431 (defun notmuch-search-result-end (&optional pos)
 432   "Return the point at the end of the thread at POS (or point).
 433
 434 The returned point will be just after the newline character that
 435 ends the result line.  If there is no thread at POS (or point),
 436 returns nil"
 437   (when (notmuch-search-get-result pos)
 438     (next-single-property-change (or pos (point)) 'notmuch-search-result
 439                                  nil (point-max))))
 440
 441 (defun notmuch-search-foreach-result (beg end function)
 442   "Invoke FUNCTION for each result between BEG and END.
 443
 444 FUNCTION should take one argument.  It will be applied to the
 445 character position of the beginning of each result that overlaps
 446 the region between points BEG and END.  As a special case, if (=
 447 BEG END), FUNCTION will be applied to the result containing point
 448 BEG."
 449
 450   (lexical-let ((pos (notmuch-search-result-beginning beg))
 451                 ;; End must be a marker in case function changes the
 452                 ;; text.
 453                 (end (copy-marker end))
 454                 ;; Make sure we examine at least one result, even if
 455                 ;; (= beg end).
 456                 (first t))
 457     ;; We have to be careful if the region extends beyond the results.
 458     ;; In this case, pos could be null or there could be no result at
 459     ;; pos.
 460     (while (and pos (or (< pos end) first))
 461       (when (notmuch-search-get-result pos)
 462         (funcall function pos))
 463       (setq pos (notmuch-search-result-end pos)
 464             first nil))))
 465 ;; Unindent the function argument of notmuch-search-foreach-result so
 466 ;; the indentation of callers doesn't get out of hand.
 467 (put 'notmuch-search-foreach-result 'lisp-indent-function 2)
 468
 469 (defun notmuch-search-properties-in-region (property beg end)
 470   (let (output)
 471     (notmuch-search-foreach-result beg end
 472       (lambda (pos)
 473         (push (plist-get (notmuch-search-get-result pos) property) output)))
 474     output))
 475
 476 (defun notmuch-search-find-thread-id (&optional bare)
 477   "Return the thread for the current thread
 478
 479 If BARE is set then do not prefix with \"thread:\""
 480   (let ((thread (plist-get (notmuch-search-get-result) :thread)))
 481     (when thread (concat (unless bare "thread:") thread))))
 482
 483 (defun notmuch-search-find-thread-id-region (beg end)
 484   "Return a list of threads for the current region"
 485   (mapcar (lambda (thread) (concat "thread:" thread))
 486           (notmuch-search-properties-in-region :thread beg end)))
 487
 488 (defun notmuch-search-find-thread-id-region-search (beg end)
 489   "Return a search string for threads for the current region"
 490   (mapconcat 'identity (notmuch-search-find-thread-id-region beg end) " or "))
 491
 492 (defun notmuch-search-find-authors ()
 493   "Return the authors for the current thread"
 494   (plist-get (notmuch-search-get-result) :authors))
 495
 496 (defun notmuch-search-find-authors-region (beg end)
 497   "Return a list of authors for the current region"
 498   (notmuch-search-properties-in-region :authors beg end))
 499
 500 (defun notmuch-search-find-subject ()
 501   "Return the subject for the current thread"
 502   (plist-get (notmuch-search-get-result) :subject))
 503
 504 (defun notmuch-search-find-subject-region (beg end)
 505   "Return a list of authors for the current region"
 506   (notmuch-search-properties-in-region :subject beg end))
 507
 508 (defun notmuch-search-show-thread ()
 509   "Display the currently selected thread."
 510   (interactive)
 511   (let ((thread-id (notmuch-search-find-thread-id))
 512         (subject (notmuch-search-find-subject)))
 513     (if (> (length thread-id) 0)
 514         (notmuch-show thread-id
 515                       (current-buffer)
 516                       notmuch-search-query-string
 517                       ;; Name the buffer based on the subject.
 518                       (concat "*" (truncate-string-to-width subject 30 nil nil t) "*"))
 519       (message "End of search results."))))
 520
 521 (defun notmuch-search-reply-to-thread (&optional prompt-for-sender)
 522   "Begin composing a reply-all to the entire current thread in a new buffer."
 523   (interactive "P")
 524   (let ((message-id (notmuch-search-find-thread-id)))
 525     (notmuch-mua-new-reply message-id prompt-for-sender t)))
 526
 527 (defun notmuch-search-reply-to-thread-sender (&optional prompt-for-sender)
 528   "Begin composing a reply to the entire current thread in a new buffer."
 529   (interactive "P")
 530   (let ((message-id (notmuch-search-find-thread-id)))
 531     (notmuch-mua-new-reply message-id prompt-for-sender nil)))
 532
 533 (defun notmuch-call-notmuch-process (&rest args)
 534   "Synchronously invoke \"notmuch\" with the given list of arguments.
 535
 536 If notmuch exits with a non-zero status, output from the process
 537 will appear in a buffer named \"*Notmuch errors*\" and an error
 538 will be signaled."
 539   (with-temp-buffer
 540     (let ((status (apply #'call-process notmuch-command nil t nil args)))
 541       (notmuch-check-exit-status status (cons notmuch-command args)
 542                                  (buffer-string)))))
 543
 544 (defun notmuch-search-set-tags (tags &optional pos)
 545   (let ((new-result (plist-put (notmuch-search-get-result pos) :tags tags)))
 546     (notmuch-search-update-result new-result pos)))
 547
 548 (defun notmuch-search-get-tags (&optional pos)
 549   (plist-get (notmuch-search-get-result pos) :tags))
 550
 551 (defun notmuch-search-get-tags-region (beg end)
 552   (let (output)
 553     (notmuch-search-foreach-result beg end
 554       (lambda (pos)
 555         (setq output (append output (notmuch-search-get-tags pos)))))
 556     output))
 557
 558 (defun notmuch-search-tag-region (beg end &optional tag-changes)
 559   "Change tags for threads in the given region."
 560   (let ((search-string (notmuch-search-find-thread-id-region-search beg end)))
 561     (setq tag-changes (notmuch-tag search-string tag-changes))
 562     (notmuch-search-foreach-result beg end
 563       (lambda (pos)
 564         (notmuch-search-set-tags
 565          (notmuch-update-tags (notmuch-search-get-tags pos) tag-changes)
 566          pos)))))
 567
 568 (defun notmuch-search-tag (&optional tag-changes)
 569   "Change tags for the currently selected thread or region.
 570
 571 See `notmuch-tag' for information on the format of TAG-CHANGES."
 572   (interactive)
 573   (let* ((beg (if (region-active-p) (region-beginning) (point)))
 574          (end (if (region-active-p) (region-end) (point))))
 575     (notmuch-search-tag-region beg end tag-changes)))
 576
 577 (defun notmuch-search-add-tag ()
 578   "Same as `notmuch-search-tag' but sets initial input to '+'."
 579   (interactive)
 580   (notmuch-search-tag "+"))
 581
 582 (defun notmuch-search-remove-tag ()
 583   "Same as `notmuch-search-tag' but sets initial input to '-'."
 584   (interactive)
 585   (notmuch-search-tag "-"))
 586
 587 (defun notmuch-search-archive-thread (&optional unarchive)
 588   "Archive the currently selected thread.
 589
 590 Archive each message in the currently selected thread by applying
 591 the tag changes in `notmuch-archive-tags' to each (remove the
 592 \"inbox\" tag by default). If a prefix argument is given, the
 593 messages will be \"unarchived\" (i.e. the tag changes in
 594 `notmuch-archive-tags' will be reversed).
 595
 596 This function advances the next thread when finished."
 597   (interactive "P")
 598   (when notmuch-archive-tags
 599     (notmuch-search-tag
 600      (notmuch-tag-change-list notmuch-archive-tags unarchive)))
 601   (notmuch-search-next-thread))
 602
 603 (defun notmuch-search-update-result (result &optional pos)
 604   "Replace the result object of the thread at POS (or point) by
 605 RESULT and redraw it.
 606
 607 This will keep point in a reasonable location.  However, if there
 608 are enclosing save-excursions and the saved point is in the
 609 result being updated, the point will be restored to the beginning
 610 of the result."
 611   (let ((start (notmuch-search-result-beginning pos))
 612         (end (notmuch-search-result-end pos))
 613         (init-point (point))
 614         (inhibit-read-only t))
 615     ;; Delete the current thread
 616     (delete-region start end)
 617     ;; Insert the updated thread
 618     (notmuch-search-show-result result start)
 619     ;; If point was inside the old result, make an educated guess
 620     ;; about where to place it now.  Unfortunately, this won't work
 621     ;; with save-excursion (or any other markers that would be nice to
 622     ;; preserve, such as the window start), but there's nothing we can
 623     ;; do about that without a way to retrieve markers in a region.
 624     (when (and (>= init-point start) (<= init-point end))
 625       (let* ((new-end (notmuch-search-result-end start))
 626              (new-point (if (= init-point end)
 627                             new-end
 628                           (min init-point (- new-end 1)))))
 629         (goto-char new-point)))))
 630
 631 (defun notmuch-search-process-sentinel (proc msg)
 632   "Add a message to let user know when \"notmuch search\" exits"
 633   (let ((buffer (process-buffer proc))
 634         (status (process-status proc))
 635         (exit-status (process-exit-status proc))
 636         (never-found-target-thread nil))
 637     (when (memq status '(exit signal))
 638       (catch 'return
 639         (kill-buffer (process-get proc 'parse-buf))
 640         (if (buffer-live-p buffer)
 641             (with-current-buffer buffer
 642               (save-excursion
 643                 (let ((inhibit-read-only t)
 644                       (atbob (bobp)))
 645                   (goto-char (point-max))
 646                   (if (eq status 'signal)
 647                       (insert "Incomplete search results (search process was killed).\n"))
 648                   (when (eq status 'exit)
 649                     (insert "End of search results.\n")
 650                     ;; For version mismatch, there's no point in
 651                     ;; showing the search buffer
 652                     (when (or (= exit-status 20) (= exit-status 21))
 653                       (kill-buffer)
 654                       (throw 'return nil))
 655                     (if (and atbob
 656                              (not (string= notmuch-search-target-thread "found")))
 657                         (set 'never-found-target-thread t)))))
 658               (when (and never-found-target-thread
 659                        notmuch-search-target-line)
 660                   (goto-char (point-min))
 661                   (forward-line (1- notmuch-search-target-line)))))))))
 662
 663 (defcustom notmuch-search-line-faces '(("unread" :weight bold)
 664                                        ("flagged" :foreground "blue"))
 665   "Tag/face mapping for line highlighting in notmuch-search.
 666
 667 Here is an example of how to color search results based on tags.
 668  (the following text would be placed in your ~/.emacs file):
 669
 670  (setq notmuch-search-line-faces '((\"deleted\" . (:foreground \"red\"
 671                                                   :background \"blue\"))
 672                                    (\"unread\" . (:foreground \"green\"))))
 673
 674 The attributes defined for matching tags are merged, with later
 675 attributes overriding earlier. A message having both \"deleted\"
 676 and \"unread\" tags with the above settings would have a green
 677 foreground and blue background."
 678   :type '(alist :key-type (string) :value-type (custom-face-edit))
 679   :group 'notmuch-search
 680   :group 'notmuch-faces)
 681
 682 (defun notmuch-search-color-line (start end line-tag-list)
 683   "Colorize lines in `notmuch-show' based on tags."
 684   (mapc (lambda (elem)
 685           (let ((tag (car elem))
 686                 (attributes (cdr elem)))
 687             (when (member tag line-tag-list)
 688               (notmuch-combine-face-text-property start end attributes))))
 689         ;; Reverse the list so earlier entries take precedence
 690         (reverse notmuch-search-line-faces)))
 691
 692 (defun notmuch-search-author-propertize (authors)
 693   "Split `authors' into matching and non-matching authors and
 694 propertize appropriately. If no boundary between authors and
 695 non-authors is found, assume that all of the authors match."
 696   (if (string-match "\\(.*\\)|\\(.*\\)" authors)
 697       (concat (propertize (concat (match-string 1 authors) ",")
 698                           'face 'notmuch-search-matching-authors)
 699               (propertize (match-string 2 authors)
 700                           'face 'notmuch-search-non-matching-authors))
 701     (propertize authors 'face 'notmuch-search-matching-authors)))
 702
 703 (defun notmuch-search-insert-authors (format-string authors)
 704   ;; Save the match data to avoid interfering with
 705   ;; `notmuch-search-process-filter'.
 706   (save-match-data
 707     (let* ((formatted-authors (format format-string authors))
 708            (formatted-sample (format format-string ""))
 709            (visible-string formatted-authors)
 710            (invisible-string "")
 711            (padding ""))
 712
 713       ;; Truncate the author string to fit the specification.
 714       (if (> (length formatted-authors)
 715              (length formatted-sample))
 716           (let ((visible-length (- (length formatted-sample)
 717                                    (length "... "))))
 718             ;; Truncate the visible string according to the width of
 719             ;; the display string.
 720             (setq visible-string (substring formatted-authors 0 visible-length)
 721                   invisible-string (substring formatted-authors visible-length))
 722             ;; If possible, truncate the visible string at a natural
 723             ;; break (comma or pipe), as incremental search doesn't
 724             ;; match across the visible/invisible border.
 725             (when (string-match "\\(.*\\)\\([,|] \\)\\([^,|]*\\)" visible-string)
 726               ;; Second clause is destructive on `visible-string', so
 727               ;; order is important.
 728               (setq invisible-string (concat (match-string 3 visible-string)
 729                                              invisible-string)
 730                     visible-string (concat (match-string 1 visible-string)
 731                                            (match-string 2 visible-string))))
 732             ;; `visible-string' may be shorter than the space allowed
 733             ;; by `format-string'. If so we must insert some padding
 734             ;; after `invisible-string'.
 735             (setq padding (make-string (- (length formatted-sample)
 736                                           (length visible-string)
 737                                           (length "..."))
 738                                        ? ))))
 739
 740       ;; Use different faces to show matching and non-matching authors.
 741       (if (string-match "\\(.*\\)|\\(.*\\)" visible-string)
 742           ;; The visible string contains both matching and
 743           ;; non-matching authors.
 744           (setq visible-string (notmuch-search-author-propertize visible-string)
 745                 ;; The invisible string must contain only non-matching
 746                 ;; authors, as the visible-string contains both.
 747                 invisible-string (propertize invisible-string
 748                                              'face 'notmuch-search-non-matching-authors))
 749         ;; The visible string contains only matching authors.
 750         (setq visible-string (propertize visible-string
 751                                          'face 'notmuch-search-matching-authors)
 752               ;; The invisible string may contain both matching and
 753               ;; non-matching authors.
 754               invisible-string (notmuch-search-author-propertize invisible-string)))
 755
 756       ;; If there is any invisible text, add it as a tooltip to the
 757       ;; visible text.
 758       (when (not (string= invisible-string ""))
 759         (setq visible-string (propertize visible-string 'help-echo (concat "..." invisible-string))))
 760
 761       ;; Insert the visible and, if present, invisible author strings.
 762       (insert visible-string)
 763       (when (not (string= invisible-string ""))
 764         (let ((start (point))
 765               overlay)
 766           (insert invisible-string)
 767           (setq overlay (make-overlay start (point)))
 768           (overlay-put overlay 'invisible 'ellipsis)
 769           (overlay-put overlay 'isearch-open-invisible #'delete-overlay)))
 770       (insert padding))))
 771
 772 (defun notmuch-search-insert-field (field format-string result)
 773   (cond
 774    ((string-equal field "date")
 775     (insert (propertize (format format-string (plist-get result :date_relative))
 776                         'face 'notmuch-search-date)))
 777    ((string-equal field "count")
 778     (insert (propertize (format format-string
 779                                 (format "[%s/%s]" (plist-get result :matched)
 780                                         (plist-get result :total)))
 781                         'face 'notmuch-search-count)))
 782    ((string-equal field "subject")
 783     (insert (propertize (format format-string (plist-get result :subject))
 784                         'face 'notmuch-search-subject)))
 785
 786    ((string-equal field "authors")
 787     (notmuch-search-insert-authors format-string (plist-get result :authors)))
 788
 789    ((string-equal field "tags")
 790     (let ((tags (plist-get result :tags)))
 791       (insert (format format-string (notmuch-tag-format-tags tags)))))))
 792
 793 (defun notmuch-search-show-result (result &optional pos)
 794   "Insert RESULT at POS or the end of the buffer if POS is null."
 795   ;; Ignore excluded matches
 796   (unless (= (plist-get result :matched) 0)
 797     (let ((beg (or pos (point-max))))
 798       (save-excursion
 799         (goto-char beg)
 800         (dolist (spec notmuch-search-result-format)
 801           (notmuch-search-insert-field (car spec) (cdr spec) result))
 802         (insert "\n")
 803         (notmuch-search-color-line beg (point) (plist-get result :tags))
 804         (put-text-property beg (point) 'notmuch-search-result result))
 805       (when (string= (plist-get result :thread) notmuch-search-target-thread)
 806         (setq notmuch-search-target-thread "found")
 807         (goto-char beg)))))
 808
 809 (defun notmuch-search-process-filter (proc string)
 810   "Process and filter the output of \"notmuch search\""
 811   (let ((results-buf (process-buffer proc))
 812         (parse-buf (process-get proc 'parse-buf))
 813         (inhibit-read-only t)
 814         done)
 815     (when (buffer-live-p results-buf)
 816       (with-current-buffer parse-buf
 817         ;; Insert new data
 818         (save-excursion
 819           (goto-char (point-max))
 820           (insert string))
 821         (notmuch-sexp-parse-partial-list 'notmuch-search-show-result
 822                                          results-buf)))))
 823
 824 (defun notmuch-search-tag-all (&optional tag-changes)
 825   "Add/remove tags from all messages in current search buffer.
 826
 827 See `notmuch-tag' for information on the format of TAG-CHANGES."
 828   (interactive)
 829   (apply 'notmuch-tag notmuch-search-query-string tag-changes))
 830
 831 (defun notmuch-search-buffer-title (query)
 832   "Returns the title for a buffer with notmuch search results."
 833   (let* ((saved-search
 834           (let (longest
 835                 (longest-length 0))
 836             (loop for tuple in notmuch-saved-searches
 837                   if (let ((quoted-query (regexp-quote (cdr tuple))))
 838                        (and (string-match (concat "^" quoted-query) query)
 839                             (> (length (match-string 0 query))
 840                                longest-length)))
 841                   do (setq longest tuple))
 842             longest))
 843          (saved-search-name (car saved-search))
 844          (saved-search-query (cdr saved-search)))
 845     (cond ((and saved-search (equal saved-search-query query))
 846            ;; Query is the same as saved search (ignoring case)
 847            (concat "*notmuch-saved-search-" saved-search-name "*"))
 848           (saved-search
 849            (concat "*notmuch-search-"
 850                    (replace-regexp-in-string (concat "^" (regexp-quote saved-search-query))
 851                                              (concat "[ " saved-search-name " ]")
 852                                              query)
 853                    "*"))
 854           (t
 855            (concat "*notmuch-search-" query "*"))
 856           )))
 857
 858 (defun notmuch-read-query (prompt)
 859   "Read a notmuch-query from the minibuffer with completion.
 860
 861 PROMPT is the string to prompt with."
 862   (lexical-let
 863       ((completions
 864         (append (list "folder:" "thread:" "id:" "date:" "from:" "to:"
 865                       "subject:" "attachment:")
 866                 (mapcar (lambda (tag)
 867                           (concat "tag:" (notmuch-escape-boolean-term tag)))
 868                         (process-lines notmuch-command "search" "--output=tags" "*")))))
 869     (let ((keymap (copy-keymap minibuffer-local-map))
 870           (minibuffer-completion-table
 871            (completion-table-dynamic
 872             (lambda (string)
 873               ;; generate a list of possible completions for the current input
 874               (cond
 875                ;; this ugly regexp is used to get the last word of the input
 876                ;; possibly preceded by a '('
 877                ((string-match "\\(^\\|.* (?\\)\\([^ ]*\\)$" string)
 878                 (mapcar (lambda (compl)
 879                           (concat (match-string-no-properties 1 string) compl))
 880                         (all-completions (match-string-no-properties 2 string)
 881                                          completions)))
 882                (t (list string)))))))
 883       ;; this was simpler than convincing completing-read to accept spaces:
 884       (define-key keymap (kbd "TAB") 'minibuffer-complete)
 885       (let ((history-delete-duplicates t))
 886         (read-from-minibuffer prompt nil keymap nil
 887                               'notmuch-search-history nil nil)))))
 888
 889 ;;;###autoload
 890 (defun notmuch-search (&optional query oldest-first target-thread target-line)
 891   "Run \"notmuch search\" with the given `query' and display results.
 892
 893 If `query' is nil, it is read interactively from the minibuffer.
 894 Other optional parameters are used as follows:
 895
 896   oldest-first: A Boolean controlling the sort order of returned threads
 897   target-thread: A thread ID (without the thread: prefix) that will be made
 898                  current if it appears in the search results.
 899   target-line: The line number to move to if the target thread does not
 900                appear in the search results.
 901
 902 When called interactively, this will prompt for a query and use
 903 the configured default sort order."
 904   (interactive
 905    (list
 906     ;; Prompt for a query
 907     nil
 908     ;; Use the default search order (if we're doing a search from a
 909     ;; search buffer, ignore any buffer-local overrides)
 910     (default-value notmuch-search-oldest-first)))
 911
 912   (let* ((query (or query (notmuch-read-query "Notmuch search: ")))
 913          (buffer (get-buffer-create (notmuch-search-buffer-title query))))
 914     (switch-to-buffer buffer)
 915     (notmuch-search-mode)
 916     ;; Don't track undo information for this buffer
 917     (set 'buffer-undo-list t)
 918     (set 'notmuch-search-query-string query)
 919     (set 'notmuch-search-oldest-first oldest-first)
 920     (set 'notmuch-search-target-thread target-thread)
 921     (set 'notmuch-search-target-line target-line)
 922     (let ((proc (get-buffer-process (current-buffer)))
 923           (inhibit-read-only t))
 924       (if proc
 925           (error "notmuch search process already running for query `%s'" query)
 926         )
 927       (erase-buffer)
 928       (goto-char (point-min))
 929       (save-excursion
 930         (let ((proc (notmuch-start-notmuch
 931                      "notmuch-search" buffer #'notmuch-search-process-sentinel
 932                      "search" "--format=sexp" "--format-version=1"
 933                      (if oldest-first
 934                          "--sort=oldest-first"
 935                        "--sort=newest-first")
 936                      query))
 937               ;; Use a scratch buffer to accumulate partial output.
 938               ;; This buffer will be killed by the sentinel, which
 939               ;; should be called no matter how the process dies.
 940               (parse-buf (generate-new-buffer " *notmuch search parse*")))
 941           (process-put proc 'parse-buf parse-buf)
 942           (set-process-filter proc 'notmuch-search-process-filter)
 943           (set-process-query-on-exit-flag proc nil))))
 944     (run-hooks 'notmuch-search-hook)))
 945
 946 (defun notmuch-search-refresh-view ()
 947   "Refresh the current view.
 948
 949 Kills the current buffer and runs a new search with the same
 950 query string as the current search. If the current thread is in
 951 the new search results, then point will be placed on the same
 952 thread. Otherwise, point will be moved to attempt to be in the
 953 same relative position within the new buffer."
 954   (let ((target-line (line-number-at-pos))
 955         (oldest-first notmuch-search-oldest-first)
 956         (target-thread (notmuch-search-find-thread-id 'bare))
 957         (query notmuch-search-query-string))
 958     (notmuch-kill-this-buffer)
 959     (notmuch-search query oldest-first target-thread target-line)
 960     (goto-char (point-min))))
 961
 962 (defun notmuch-search-toggle-order ()
 963   "Toggle the current search order.
 964
 965 This command toggles the sort order for the current search. The
 966 default sort order is defined by `notmuch-search-oldest-first'."
 967   (interactive)
 968   (set 'notmuch-search-oldest-first (not notmuch-search-oldest-first))
 969   (notmuch-search-refresh-view))
 970
 971 (defun notmuch-search-filter (query)
 972   "Filter the current search results based on an additional query string.
 973
 974 Runs a new search matching only messages that match both the
 975 current search results AND the additional query string provided."
 976   (interactive (list (notmuch-read-query "Filter search: ")))
 977   (let ((grouped-query (if (string-match-p notmuch-search-disjunctive-regexp query)
 978                            (concat "( " query " )")
 979                          query)))
 980     (notmuch-search (if (string= notmuch-search-query-string "*")
 981                         grouped-query
 982                       (concat notmuch-search-query-string " and " grouped-query)) notmuch-search-oldest-first)))
 983
 984 (defun notmuch-search-filter-by-tag (tag)
 985   "Filter the current search results based on a single tag.
 986
 987 Runs a new search matching only messages that match both the
 988 current search results AND that are tagged with the given tag."
 989   (interactive
 990    (list (notmuch-select-tag-with-completion "Filter by tag: ")))
 991   (notmuch-search (concat notmuch-search-query-string " and tag:" tag) notmuch-search-oldest-first))
 992
 993 ;;;###autoload
 994 (defun notmuch ()
 995   "Run notmuch and display saved searches, known tags, etc."
 996   (interactive)
 997   (notmuch-hello))
 998
 999 (defun notmuch-interesting-buffer (b)
1000   "Is the current buffer of interest to a notmuch user?"
1001   (with-current-buffer b
1002     (memq major-mode '(notmuch-show-mode
1003                        notmuch-search-mode
1004                        notmuch-hello-mode
1005                        message-mode))))
1006
1007 ;;;###autoload
1008 (defun notmuch-cycle-notmuch-buffers ()
1009   "Cycle through any existing notmuch buffers (search, show or hello).
1010
1011 If the current buffer is the only notmuch buffer, bury it. If no
1012 notmuch buffers exist, run `notmuch'."
1013   (interactive)
1014
1015   (let (start first)
1016     ;; If the current buffer is a notmuch buffer, remember it and then
1017     ;; bury it.
1018     (when (notmuch-interesting-buffer (current-buffer))
1019       (setq start (current-buffer))
1020       (bury-buffer))
1021
1022     ;; Find the first notmuch buffer.
1023     (setq first (loop for buffer in (buffer-list)
1024                      if (notmuch-interesting-buffer buffer)
1025                      return buffer))
1026
1027     (if first
1028         ;; If the first one we found is any other than the starting
1029         ;; buffer, switch to it.
1030         (unless (eq first start)
1031           (switch-to-buffer first))
1032       (notmuch))))
1033
1034 (setq mail-user-agent 'notmuch-user-agent)
1035
1036 (provide 'notmuch)