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