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))
 734           (tags-str (mapconcat 'identity tags " ")))
 735       (dolist (spec notmuch-search-result-format)
 736         (notmuch-search-insert-field (car spec) (cdr spec)
 737                                      date count authors subject tags-str))
 738       (insert "\n")
 739       (notmuch-search-color-line beg (point) tags)
 740       (put-text-property beg (point) 'notmuch-search-thread-id thread-id)
 741       (put-text-property beg (point) 'notmuch-search-authors authors)
 742       (put-text-property beg (point) 'notmuch-search-subject subject))))
 743
 744 (defun notmuch-search-show-error (string &rest objects)
 745   (insert "Error: Unexpected output from notmuch search:\n")
 746   (insert (apply #'format string objects))
 747   (insert "\n"))
 748
 749 (defun notmuch-search-process-filter (proc string)
 750   "Process and filter the output of \"notmuch search\""
 751   (let ((buffer (process-buffer proc))
 752         (found-target nil))
 753     (if (buffer-live-p buffer)
 754         (with-current-buffer buffer
 755           (save-excursion
 756             (let ((line 0)
 757                   (more t)
 758                   (inhibit-read-only t)
 759                   (string (concat notmuch-search-process-filter-data string)))
 760               (setq notmuch-search-process-filter-data nil)
 761               (while more
 762                 (while (and (< line (length string)) (= (elt string line) ?\n))
 763                   (setq line (1+ line)))
 764                 (if (string-match "^\\(thread:[0-9A-Fa-f]*\\) \\([^][]*\\) \\(\\[[0-9/]*\\]\\) \\([^;]*\\); \\(.*\\) (\\([^()]*\\))$" string line)
 765                     (let* ((thread-id (match-string 1 string))
 766                            (date (match-string 2 string))
 767                            (count (match-string 3 string))
 768                            (authors (match-string 4 string))
 769                            (subject (match-string 5 string))
 770                            (tags (match-string 6 string))
 771                            (tag-list (if tags (save-match-data (split-string tags)))))
 772                       (goto-char (point-max))
 773                       (if (/= (match-beginning 1) line)
 774                           (notmuch-search-show-error
 775                            (substring string line (match-beginning 1))))
 776                       (when (string= thread-id notmuch-search-target-thread)
 777                         (set 'found-target (point))
 778                         (set 'notmuch-search-target-thread "found"))
 779                       (notmuch-search-show-result thread-id date count authors subject tag-list)
 780                       (set 'line (match-end 0)))
 781                   (set 'more nil)
 782                   (while (and (< line (length string)) (= (elt string line) ?\n))
 783                     (setq line (1+ line)))
 784                   (if (< line (length string))
 785                       (setq notmuch-search-process-filter-data (substring string line)))
 786                   ))))
 787           (if found-target
 788               (goto-char found-target)))
 789       (delete-process proc))))
 790
 791 (defun notmuch-search-tag-all (&optional tag-changes)
 792   "Add/remove tags from all messages in current search buffer.
 793
 794 See `notmuch-tag' for information on the format of TAG-CHANGES."
 795   (interactive)
 796   (apply 'notmuch-tag notmuch-search-query-string tag-changes))
 797
 798 (defun notmuch-search-buffer-title (query)
 799   "Returns the title for a buffer with notmuch search results."
 800   (let* ((saved-search
 801           (let (longest
 802                 (longest-length 0))
 803             (loop for tuple in notmuch-saved-searches
 804                   if (let ((quoted-query (regexp-quote (cdr tuple))))
 805                        (and (string-match (concat "^" quoted-query) query)
 806                             (> (length (match-string 0 query))
 807                                longest-length)))
 808                   do (setq longest tuple))
 809             longest))
 810          (saved-search-name (car saved-search))
 811          (saved-search-query (cdr saved-search)))
 812     (cond ((and saved-search (equal saved-search-query query))
 813            ;; Query is the same as saved search (ignoring case)
 814            (concat "*notmuch-saved-search-" saved-search-name "*"))
 815           (saved-search
 816            (concat "*notmuch-search-"
 817                    (replace-regexp-in-string (concat "^" (regexp-quote saved-search-query))
 818                                              (concat "[ " saved-search-name " ]")
 819                                              query)
 820                    "*"))
 821           (t
 822            (concat "*notmuch-search-" query "*"))
 823           )))
 824
 825 (defun notmuch-read-query (prompt)
 826   "Read a notmuch-query from the minibuffer with completion.
 827
 828 PROMPT is the string to prompt with."
 829   (lexical-let
 830       ((completions
 831         (append (list "folder:" "thread:" "id:" "date:" "from:" "to:"
 832                       "subject:" "attachment:")
 833                 (mapcar (lambda (tag)
 834                           (concat "tag:" tag))
 835                         (process-lines notmuch-command "search" "--output=tags" "*")))))
 836     (let ((keymap (copy-keymap minibuffer-local-map))
 837           (minibuffer-completion-table
 838            (completion-table-dynamic
 839             (lambda (string)
 840               ;; generate a list of possible completions for the current input
 841               (cond
 842                ;; this ugly regexp is used to get the last word of the input
 843                ;; possibly preceded by a '('
 844                ((string-match "\\(^\\|.* (?\\)\\([^ ]*\\)$" string)
 845                 (mapcar (lambda (compl)
 846                           (concat (match-string-no-properties 1 string) compl))
 847                         (all-completions (match-string-no-properties 2 string)
 848                                          completions)))
 849                (t (list string)))))))
 850       ;; this was simpler than convincing completing-read to accept spaces:
 851       (define-key keymap (kbd "TAB") 'minibuffer-complete)
 852       (let ((history-delete-duplicates t))
 853         (read-from-minibuffer prompt nil keymap nil
 854                               'notmuch-search-history nil nil)))))
 855
 856 ;;;###autoload
 857 (defun notmuch-search (&optional query oldest-first target-thread target-line continuation)
 858   "Run \"notmuch search\" with the given `query' and display results.
 859
 860 If `query' is nil, it is read interactively from the minibuffer.
 861 Other optional parameters are used as follows:
 862
 863   oldest-first: A Boolean controlling the sort order of returned threads
 864   target-thread: A thread ID (with the thread: prefix) that will be made
 865                  current if it appears in the search results.
 866   target-line: The line number to move to if the target thread does not
 867                appear in the search results."
 868   (interactive)
 869   (if (null query)
 870       (setq query (notmuch-read-query "Notmuch search: ")))
 871   (let ((buffer (get-buffer-create (notmuch-search-buffer-title query))))
 872     (switch-to-buffer buffer)
 873     (notmuch-search-mode)
 874     ;; Don't track undo information for this buffer
 875     (set 'buffer-undo-list t)
 876     (set 'notmuch-search-query-string query)
 877     (set 'notmuch-search-oldest-first oldest-first)
 878     (set 'notmuch-search-target-thread target-thread)
 879     (set 'notmuch-search-target-line target-line)
 880     (set 'notmuch-search-continuation continuation)
 881     (let ((proc (get-buffer-process (current-buffer)))
 882           (inhibit-read-only t))
 883       (if proc
 884           (error "notmuch search process already running for query `%s'" query)
 885         )
 886       (erase-buffer)
 887       (goto-char (point-min))
 888       (save-excursion
 889         (let ((proc (start-process
 890                      "notmuch-search" buffer
 891                      notmuch-command "search"
 892                      (if oldest-first
 893                          "--sort=oldest-first"
 894                        "--sort=newest-first")
 895                      query)))
 896           (set-process-sentinel proc 'notmuch-search-process-sentinel)
 897           (set-process-filter proc 'notmuch-search-process-filter)
 898           (set-process-query-on-exit-flag proc nil))))
 899     (run-hooks 'notmuch-search-hook)))
 900
 901 (defun notmuch-search-refresh-view ()
 902   "Refresh the current view.
 903
 904 Kills the current buffer and runs a new search with the same
 905 query string as the current search. If the current thread is in
 906 the new search results, then point will be placed on the same
 907 thread. Otherwise, point will be moved to attempt to be in the
 908 same relative position within the new buffer."
 909   (interactive)
 910   (let ((target-line (line-number-at-pos))
 911         (oldest-first notmuch-search-oldest-first)
 912         (target-thread (notmuch-search-find-thread-id))
 913         (query notmuch-search-query-string)
 914         (continuation notmuch-search-continuation))
 915     (notmuch-kill-this-buffer)
 916     (notmuch-search query oldest-first target-thread target-line continuation)
 917     (goto-char (point-min))))
 918
 919 (defcustom notmuch-poll-script nil
 920   "An external script to incorporate new mail into the notmuch database.
 921
 922 This variable controls the action invoked by
 923 `notmuch-search-poll-and-refresh-view' and
 924 `notmuch-hello-poll-and-update' (each have a default keybinding
 925 of 'G') to incorporate new mail into the notmuch database.
 926
 927 If set to nil (the default), new mail is processed by invoking
 928 \"notmuch new\". Otherwise, this should be set to a string that
 929 gives the name of an external script that processes new mail. If
 930 set to the empty string, no command will be run.
 931
 932 The external script could do any of the following depending on
 933 the user's needs:
 934
 935 1. Invoke a program to transfer mail to the local mail store
 936 2. Invoke \"notmuch new\" to incorporate the new mail
 937 3. Invoke one or more \"notmuch tag\" commands to classify the mail
 938
 939 Note that the recommended way of achieving the same is using
 940 \"notmuch new\" hooks."
 941   :type '(choice (const :tag "notmuch new" nil)
 942                  (const :tag "Disabled" "")
 943                  (string :tag "Custom script"))
 944   :group 'notmuch-external)
 945
 946 (defun notmuch-poll ()
 947   "Run \"notmuch new\" or an external script to import mail.
 948
 949 Invokes `notmuch-poll-script', \"notmuch new\", or does nothing
 950 depending on the value of `notmuch-poll-script'."
 951   (interactive)
 952   (if (stringp notmuch-poll-script)
 953       (unless (string= notmuch-poll-script "")
 954         (call-process notmuch-poll-script nil nil))
 955     (call-process notmuch-command nil nil nil "new")))
 956
 957 (defun notmuch-search-poll-and-refresh-view ()
 958   "Invoke `notmuch-poll' to import mail, then refresh the current view."
 959   (interactive)
 960   (notmuch-poll)
 961   (notmuch-search-refresh-view))
 962
 963 (defun notmuch-search-toggle-order ()
 964   "Toggle the current search order.
 965
 966 By default, the \"inbox\" view created by `notmuch' is displayed
 967 in chronological order (oldest thread at the beginning of the
 968 buffer), while any global searches created by `notmuch-search'
 969 are displayed in reverse-chronological order (newest thread at
 970 the beginning of the buffer).
 971
 972 This command toggles the sort order for the current search.
 973
 974 Note that any filtered searches created by
 975 `notmuch-search-filter' retain the search order of the parent
 976 search."
 977   (interactive)
 978   (set 'notmuch-search-oldest-first (not notmuch-search-oldest-first))
 979   (notmuch-search-refresh-view))
 980
 981 (defun notmuch-search-filter (query)
 982   "Filter the current search results based on an additional query string.
 983
 984 Runs a new search matching only messages that match both the
 985 current search results AND the additional query string provided."
 986   (interactive (list (notmuch-read-query "Filter search: ")))
 987   (let ((grouped-query (if (string-match-p notmuch-search-disjunctive-regexp query)
 988                            (concat "( " query " )")
 989                          query)))
 990     (notmuch-search (if (string= notmuch-search-query-string "*")
 991                         grouped-query
 992                       (concat notmuch-search-query-string " and " grouped-query)) notmuch-search-oldest-first)))
 993
 994 (defun notmuch-search-filter-by-tag (tag)
 995   "Filter the current search results based on a single tag.
 996
 997 Runs a new search matching only messages that match both the
 998 current search results AND that are tagged with the given tag."
 999   (interactive
1000    (list (notmuch-select-tag-with-completion "Filter by tag: ")))
1001   (notmuch-search (concat notmuch-search-query-string " and tag:" tag) notmuch-search-oldest-first))
1002
1003 ;;;###autoload
1004 (defun notmuch ()
1005   "Run notmuch and display saved searches, known tags, etc."
1006   (interactive)
1007   (notmuch-hello))
1008
1009 (defun notmuch-interesting-buffer (b)
1010   "Is the current buffer of interest to a notmuch user?"
1011   (with-current-buffer b
1012     (memq major-mode '(notmuch-show-mode
1013                        notmuch-search-mode
1014                        notmuch-hello-mode
1015                        message-mode))))
1016
1017 ;;;###autoload
1018 (defun notmuch-cycle-notmuch-buffers ()
1019   "Cycle through any existing notmuch buffers (search, show or hello).
1020
1021 If the current buffer is the only notmuch buffer, bury it. If no
1022 notmuch buffers exist, run `notmuch'."
1023   (interactive)
1024
1025   (let (start first)
1026     ;; If the current buffer is a notmuch buffer, remember it and then
1027     ;; bury it.
1028     (when (notmuch-interesting-buffer (current-buffer))
1029       (setq start (current-buffer))
1030       (bury-buffer))
1031
1032     ;; Find the first notmuch buffer.
1033     (setq first (loop for buffer in (buffer-list)
1034                      if (notmuch-interesting-buffer buffer)
1035                      return buffer))
1036
1037     (if first
1038         ;; If the first one we found is any other than the starting
1039         ;; buffer, switch to it.
1040         (unless (eq first start)
1041           (switch-to-buffer first))
1042       (notmuch))))
1043
1044 (setq mail-user-agent 'notmuch-user-agent)
1045
1046 (provide 'notmuch)