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-thread (&rest tag-changes)
 521   "Change tags for the currently selected thread.
 522
 523 See `notmuch-search-tag-region' for details."
 524   (apply 'notmuch-search-tag-region (point) (point) tag-changes))
 525
 526 (defun notmuch-search-tag-region (beg end &optional tag-changes)
 527   "Change tags for threads in the given region."
 528   (let ((search-string (notmuch-search-find-thread-id-region-search beg end)))
 529     (setq tag-changes (funcall 'notmuch-tag search-string tag-changes))
 530     (save-excursion
 531       (let ((last-line (line-number-at-pos end))
 532             (max-line (- (line-number-at-pos (point-max)) 2)))
 533         (goto-char beg)
 534         (while (<= (line-number-at-pos) (min last-line max-line))
 535           (notmuch-search-set-tags
 536            (notmuch-update-tags (notmuch-search-get-tags) tag-changes))
 537           (forward-line))))))
 538
 539 (defun notmuch-search-tag (&optional tag-changes)
 540   "Change tags for the currently selected thread or region.
 541
 542 See `notmuch-tag' for information on the format of TAG-CHANGES."
 543   (interactive)
 544   (let* ((beg (if (region-active-p) (region-beginning) (point)))
 545          (end (if (region-active-p) (region-end) (point))))
 546     (funcall 'notmuch-search-tag-region beg end tag-changes)))
 547
 548 (defun notmuch-search-add-tag ()
 549   "Same as `notmuch-search-tag' but sets initial input to '+'."
 550   (interactive)
 551   (notmuch-search-tag "+"))
 552
 553 (defun notmuch-search-remove-tag ()
 554   "Same as `notmuch-search-tag' but sets initial input to '-'."
 555   (interactive)
 556   (notmuch-search-tag "-"))
 557
 558 (defun notmuch-search-archive-thread ()
 559   "Archive the currently selected thread (remove its \"inbox\" tag).
 560
 561 This function advances the next thread when finished."
 562   (interactive)
 563   (notmuch-search-tag-thread "-inbox")
 564   (notmuch-search-next-thread))
 565
 566 (defvar notmuch-search-process-filter-data nil
 567   "Data that has not yet been processed.")
 568 (make-variable-buffer-local 'notmuch-search-process-filter-data)
 569
 570 (defun notmuch-search-process-sentinel (proc msg)
 571   "Add a message to let user know when \"notmuch search\" exits"
 572   (let ((buffer (process-buffer proc))
 573         (status (process-status proc))
 574         (exit-status (process-exit-status proc))
 575         (never-found-target-thread nil))
 576     (if (memq status '(exit signal))
 577         (if (buffer-live-p buffer)
 578             (with-current-buffer buffer
 579               (save-excursion
 580                 (let ((inhibit-read-only t)
 581                       (atbob (bobp)))
 582                   (goto-char (point-max))
 583                   (if (eq status 'signal)
 584                       (insert "Incomplete search results (search process was killed).\n"))
 585                   (when (eq status 'exit)
 586                     (if notmuch-search-process-filter-data
 587                         (insert (concat "Error: Unexpected output from notmuch search:\n" notmuch-search-process-filter-data)))
 588                     (insert "End of search results.")
 589                     (unless (= exit-status 0)
 590                       (insert (format " (process returned %d)" exit-status)))
 591                     (insert "\n")
 592                     (if (and atbob
 593                              (not (string= notmuch-search-target-thread "found")))
 594                         (set 'never-found-target-thread t)))))
 595               (when (and never-found-target-thread
 596                        notmuch-search-target-line)
 597                   (goto-char (point-min))
 598                   (forward-line (1- notmuch-search-target-line))))))))
 599
 600 (defcustom notmuch-search-line-faces '(("unread" :weight bold)
 601                                        ("flagged" :foreground "blue"))
 602   "Tag/face mapping for line highlighting in notmuch-search.
 603
 604 Here is an example of how to color search results based on tags.
 605  (the following text would be placed in your ~/.emacs file):
 606
 607  (setq notmuch-search-line-faces '((\"deleted\" . (:foreground \"red\"
 608                                                   :background \"blue\"))
 609                                    (\"unread\" . (:foreground \"green\"))))
 610
 611 The attributes defined for matching tags are merged, with later
 612 attributes overriding earlier. A message having both \"deleted\"
 613 and \"unread\" tags with the above settings would have a green
 614 foreground and blue background."
 615   :type '(alist :key-type (string) :value-type (custom-face-edit))
 616   :group 'notmuch-search
 617   :group 'notmuch-faces)
 618
 619 (defun notmuch-search-color-line (start end line-tag-list)
 620   "Colorize lines in `notmuch-show' based on tags."
 621   ;; Create the overlay only if the message has tags which match one
 622   ;; of those specified in `notmuch-search-line-faces'.
 623   (let (overlay)
 624     (mapc (lambda (elem)
 625             (let ((tag (car elem))
 626                   (attributes (cdr elem)))
 627               (when (member tag line-tag-list)
 628                 (when (not overlay)
 629                   (setq overlay (make-overlay start end)))
 630                 ;; Merge the specified properties with any already
 631                 ;; applied from an earlier match.
 632                 (overlay-put overlay 'face
 633                              (append (overlay-get overlay 'face) attributes)))))
 634           notmuch-search-line-faces)))
 635
 636 (defun notmuch-search-author-propertize (authors)
 637   "Split `authors' into matching and non-matching authors and
 638 propertize appropriately. If no boundary between authors and
 639 non-authors is found, assume that all of the authors match."
 640   (if (string-match "\\(.*\\)|\\(.*\\)" authors)
 641       (concat (propertize (concat (match-string 1 authors) ",")
 642                           'face 'notmuch-search-matching-authors)
 643               (propertize (match-string 2 authors)
 644                           'face 'notmuch-search-non-matching-authors))
 645     (propertize authors 'face 'notmuch-search-matching-authors)))
 646
 647 (defun notmuch-search-insert-authors (format-string authors)
 648   ;; Save the match data to avoid interfering with
 649   ;; `notmuch-search-process-filter'.
 650   (save-match-data
 651     (let* ((formatted-authors (format format-string authors))
 652            (formatted-sample (format format-string ""))
 653            (visible-string formatted-authors)
 654            (invisible-string "")
 655            (padding ""))
 656
 657       ;; Truncate the author string to fit the specification.
 658       (if (> (length formatted-authors)
 659              (length formatted-sample))
 660           (let ((visible-length (- (length formatted-sample)
 661                                    (length "... "))))
 662             ;; Truncate the visible string according to the width of
 663             ;; the display string.
 664             (setq visible-string (substring formatted-authors 0 visible-length)
 665                   invisible-string (substring formatted-authors visible-length))
 666             ;; If possible, truncate the visible string at a natural
 667             ;; break (comma or pipe), as incremental search doesn't
 668             ;; match across the visible/invisible border.
 669             (when (string-match "\\(.*\\)\\([,|] \\)\\([^,|]*\\)" visible-string)
 670               ;; Second clause is destructive on `visible-string', so
 671               ;; order is important.
 672               (setq invisible-string (concat (match-string 3 visible-string)
 673                                              invisible-string)
 674                     visible-string (concat (match-string 1 visible-string)
 675                                            (match-string 2 visible-string))))
 676             ;; `visible-string' may be shorter than the space allowed
 677             ;; by `format-string'. If so we must insert some padding
 678             ;; after `invisible-string'.
 679             (setq padding (make-string (- (length formatted-sample)
 680                                           (length visible-string)
 681                                           (length "..."))
 682                                        ? ))))
 683
 684       ;; Use different faces to show matching and non-matching authors.
 685       (if (string-match "\\(.*\\)|\\(.*\\)" visible-string)
 686           ;; The visible string contains both matching and
 687           ;; non-matching authors.
 688           (setq visible-string (notmuch-search-author-propertize visible-string)
 689                 ;; The invisible string must contain only non-matching
 690                 ;; authors, as the visible-string contains both.
 691                 invisible-string (propertize invisible-string
 692                                              'face 'notmuch-search-non-matching-authors))
 693         ;; The visible string contains only matching authors.
 694         (setq visible-string (propertize visible-string
 695                                          'face 'notmuch-search-matching-authors)
 696               ;; The invisible string may contain both matching and
 697               ;; non-matching authors.
 698               invisible-string (notmuch-search-author-propertize invisible-string)))
 699
 700       ;; If there is any invisible text, add it as a tooltip to the
 701       ;; visible text.
 702       (when (not (string= invisible-string ""))
 703         (setq visible-string (propertize visible-string 'help-echo (concat "..." invisible-string))))
 704
 705       ;; Insert the visible and, if present, invisible author strings.
 706       (insert visible-string)
 707       (when (not (string= invisible-string ""))
 708         (let ((start (point))
 709               overlay)
 710           (insert invisible-string)
 711           (setq overlay (make-overlay start (point)))
 712           (overlay-put overlay 'invisible 'ellipsis)
 713           (overlay-put overlay 'isearch-open-invisible #'delete-overlay)))
 714       (insert padding))))
 715
 716 (defun notmuch-search-insert-field (field date count authors subject tags)
 717   (cond
 718    ((string-equal field "date")
 719     (insert (propertize (format (cdr (assoc field notmuch-search-result-format)) date)
 720                         'face 'notmuch-search-date)))
 721    ((string-equal field "count")
 722     (insert (propertize (format (cdr (assoc field notmuch-search-result-format)) count)
 723                         'face 'notmuch-search-count)))
 724    ((string-equal field "subject")
 725     (insert (propertize (format (cdr (assoc field notmuch-search-result-format)) subject)
 726                         'face 'notmuch-search-subject)))
 727
 728    ((string-equal field "authors")
 729     (notmuch-search-insert-authors (cdr (assoc field notmuch-search-result-format)) authors))
 730
 731    ((string-equal field "tags")
 732     (insert (concat "(" (propertize tags 'font-lock-face 'notmuch-tag-face) ")")))))
 733
 734 (defun notmuch-search-show-result (date count authors subject tags)
 735   (let ((fields) (field))
 736     (setq fields (mapcar 'car notmuch-search-result-format))
 737     (loop for field in fields
 738           do (notmuch-search-insert-field field date count authors subject tags)))
 739   (insert "\n"))
 740
 741 (defun notmuch-search-process-filter (proc string)
 742   "Process and filter the output of \"notmuch search\""
 743   (let ((buffer (process-buffer proc))
 744         (found-target nil))
 745     (if (buffer-live-p buffer)
 746         (with-current-buffer buffer
 747           (save-excursion
 748             (let ((line 0)
 749                   (more t)
 750                   (inhibit-read-only t)
 751                   (string (concat notmuch-search-process-filter-data string)))
 752               (setq notmuch-search-process-filter-data nil)
 753               (while more
 754                 (while (and (< line (length string)) (= (elt string line) ?\n))
 755                   (setq line (1+ line)))
 756                 (if (string-match "^\\(thread:[0-9A-Fa-f]*\\) \\([^][]*\\) \\(\\[[0-9/]*\\]\\) \\([^;]*\\); \\(.*\\) (\\([^()]*\\))$" string line)
 757                     (let* ((thread-id (match-string 1 string))
 758                            (date (match-string 2 string))
 759                            (count (match-string 3 string))
 760                            (authors (match-string 4 string))
 761                            (subject (match-string 5 string))
 762                            (tags (match-string 6 string))
 763                            (tag-list (if tags (save-match-data (split-string tags)))))
 764                       (goto-char (point-max))
 765                       (if (/= (match-beginning 1) line)
 766                           (insert (concat "Error: Unexpected output from notmuch search:\n" (substring string line (match-beginning 1)) "\n")))
 767                       ;; We currently just throw away excluded matches.
 768                       (unless (eq (aref count 1) ?0)
 769                         (let ((beg (point)))
 770                           (notmuch-search-show-result date count authors subject tags)
 771                           (notmuch-search-color-line beg (point) tag-list)
 772                           (put-text-property beg (point) 'notmuch-search-thread-id thread-id)
 773                           (put-text-property beg (point) 'notmuch-search-authors authors)
 774                           (put-text-property beg (point) 'notmuch-search-subject subject)
 775                           (when (string= thread-id notmuch-search-target-thread)
 776                             (set 'found-target beg)
 777                             (set 'notmuch-search-target-thread "found"))))
 778                       (set 'line (match-end 0)))
 779                   (set 'more nil)
 780                   (while (and (< line (length string)) (= (elt string line) ?\n))
 781                     (setq line (1+ line)))
 782                   (if (< line (length string))
 783                       (setq notmuch-search-process-filter-data (substring string line)))
 784                   ))))
 785           (if found-target
 786               (goto-char found-target)))
 787       (delete-process proc))))
 788
 789 (defun notmuch-search-tag-all (&optional tag-changes)
 790   "Add/remove tags from all messages in current search buffer.
 791
 792 See `notmuch-tag' for information on the format of TAG-CHANGES."
 793   (interactive)
 794   (apply 'notmuch-tag notmuch-search-query-string tag-changes))
 795
 796 (defun notmuch-search-buffer-title (query)
 797   "Returns the title for a buffer with notmuch search results."
 798   (let* ((saved-search
 799           (let (longest
 800                 (longest-length 0))
 801             (loop for tuple in notmuch-saved-searches
 802                   if (let ((quoted-query (regexp-quote (cdr tuple))))
 803                        (and (string-match (concat "^" quoted-query) query)
 804                             (> (length (match-string 0 query))
 805                                longest-length)))
 806                   do (setq longest tuple))
 807             longest))
 808          (saved-search-name (car saved-search))
 809          (saved-search-query (cdr saved-search)))
 810     (cond ((and saved-search (equal saved-search-query query))
 811            ;; Query is the same as saved search (ignoring case)
 812            (concat "*notmuch-saved-search-" saved-search-name "*"))
 813           (saved-search
 814            (concat "*notmuch-search-"
 815                    (replace-regexp-in-string (concat "^" (regexp-quote saved-search-query))
 816                                              (concat "[ " saved-search-name " ]")
 817                                              query)
 818                    "*"))
 819           (t
 820            (concat "*notmuch-search-" query "*"))
 821           )))
 822
 823 (defun notmuch-read-query (prompt)
 824   "Read a notmuch-query from the minibuffer with completion.
 825
 826 PROMPT is the string to prompt with."
 827   (lexical-let
 828       ((completions
 829         (append (list "folder:" "thread:" "id:" "date:" "from:" "to:"
 830                       "subject:" "attachment:")
 831                 (mapcar (lambda (tag)
 832                           (concat "tag:" tag))
 833                         (process-lines notmuch-command "search" "--output=tags" "*")))))
 834     (let ((keymap (copy-keymap minibuffer-local-map))
 835           (minibuffer-completion-table
 836            (completion-table-dynamic
 837             (lambda (string)
 838               ;; generate a list of possible completions for the current input
 839               (cond
 840                ;; this ugly regexp is used to get the last word of the input
 841                ;; possibly preceded by a '('
 842                ((string-match "\\(^\\|.* (?\\)\\([^ ]*\\)$" string)
 843                 (mapcar (lambda (compl)
 844                           (concat (match-string-no-properties 1 string) compl))
 845                         (all-completions (match-string-no-properties 2 string)
 846                                          completions)))
 847                (t (list string)))))))
 848       ;; this was simpler than convincing completing-read to accept spaces:
 849       (define-key keymap (kbd "TAB") 'minibuffer-complete)
 850       (let ((history-delete-duplicates t))
 851         (read-from-minibuffer prompt nil keymap nil
 852                               'notmuch-search-history nil nil)))))
 853
 854 ;;;###autoload
 855 (defun notmuch-search (&optional query oldest-first target-thread target-line continuation)
 856   "Run \"notmuch search\" with the given `query' and display results.
 857
 858 If `query' is nil, it is read interactively from the minibuffer.
 859 Other optional parameters are used as follows:
 860
 861   oldest-first: A Boolean controlling the sort order of returned threads
 862   target-thread: A thread ID (with the thread: prefix) that will be made
 863                  current if it appears in the search results.
 864   target-line: The line number to move to if the target thread does not
 865                appear in the search results."
 866   (interactive)
 867   (if (null query)
 868       (setq query (notmuch-read-query "Notmuch search: ")))
 869   (let ((buffer (get-buffer-create (notmuch-search-buffer-title query))))
 870     (switch-to-buffer buffer)
 871     (notmuch-search-mode)
 872     ;; Don't track undo information for this buffer
 873     (set 'buffer-undo-list t)
 874     (set 'notmuch-search-query-string query)
 875     (set 'notmuch-search-oldest-first oldest-first)
 876     (set 'notmuch-search-target-thread target-thread)
 877     (set 'notmuch-search-target-line target-line)
 878     (set 'notmuch-search-continuation continuation)
 879     (let ((proc (get-buffer-process (current-buffer)))
 880           (inhibit-read-only t))
 881       (if proc
 882           (error "notmuch search process already running for query `%s'" query)
 883         )
 884       (erase-buffer)
 885       (goto-char (point-min))
 886       (save-excursion
 887         (let ((proc (start-process
 888                      "notmuch-search" buffer
 889                      notmuch-command "search"
 890                      (if oldest-first
 891                          "--sort=oldest-first"
 892                        "--sort=newest-first")
 893                      query)))
 894           (set-process-sentinel proc 'notmuch-search-process-sentinel)
 895           (set-process-filter proc 'notmuch-search-process-filter)
 896           (set-process-query-on-exit-flag proc nil))))
 897     (run-hooks 'notmuch-search-hook)))
 898
 899 (defun notmuch-search-refresh-view ()
 900   "Refresh the current view.
 901
 902 Kills the current buffer and runs a new search with the same
 903 query string as the current search. If the current thread is in
 904 the new search results, then point will be placed on the same
 905 thread. Otherwise, point will be moved to attempt to be in the
 906 same relative position within the new buffer."
 907   (interactive)
 908   (let ((target-line (line-number-at-pos))
 909         (oldest-first notmuch-search-oldest-first)
 910         (target-thread (notmuch-search-find-thread-id))
 911         (query notmuch-search-query-string)
 912         (continuation notmuch-search-continuation))
 913     (notmuch-kill-this-buffer)
 914     (notmuch-search query oldest-first target-thread target-line continuation)
 915     (goto-char (point-min))))
 916
 917 (defcustom notmuch-poll-script nil
 918   "An external script to incorporate new mail into the notmuch database.
 919
 920 This variable controls the action invoked by
 921 `notmuch-search-poll-and-refresh-view' and
 922 `notmuch-hello-poll-and-update' (each have a default keybinding
 923 of 'G') to incorporate new mail into the notmuch database.
 924
 925 If set to nil (the default), new mail is processed by invoking
 926 \"notmuch new\". Otherwise, this should be set to a string that
 927 gives the name of an external script that processes new mail. If
 928 set to the empty string, no command will be run.
 929
 930 The external script could do any of the following depending on
 931 the user's needs:
 932
 933 1. Invoke a program to transfer mail to the local mail store
 934 2. Invoke \"notmuch new\" to incorporate the new mail
 935 3. Invoke one or more \"notmuch tag\" commands to classify the mail
 936
 937 Note that the recommended way of achieving the same is using
 938 \"notmuch new\" hooks."
 939   :type '(choice (const :tag "notmuch new" nil)
 940                  (const :tag "Disabled" "")
 941                  (string :tag "Custom script"))
 942   :group 'notmuch-external)
 943
 944 (defun notmuch-poll ()
 945   "Run \"notmuch new\" or an external script to import mail.
 946
 947 Invokes `notmuch-poll-script', \"notmuch new\", or does nothing
 948 depending on the value of `notmuch-poll-script'."
 949   (interactive)
 950   (if (stringp notmuch-poll-script)
 951       (unless (string= notmuch-poll-script "")
 952         (call-process notmuch-poll-script nil nil))
 953     (call-process notmuch-command nil nil nil "new")))
 954
 955 (defun notmuch-search-poll-and-refresh-view ()
 956   "Invoke `notmuch-poll' to import mail, then refresh the current view."
 957   (interactive)
 958   (notmuch-poll)
 959   (notmuch-search-refresh-view))
 960
 961 (defun notmuch-search-toggle-order ()
 962   "Toggle the current search order.
 963
 964 By default, the \"inbox\" view created by `notmuch' is displayed
 965 in chronological order (oldest thread at the beginning of the
 966 buffer), while any global searches created by `notmuch-search'
 967 are displayed in reverse-chronological order (newest thread at
 968 the beginning of the buffer).
 969
 970 This command toggles the sort order for the current search.
 971
 972 Note that any filtered searches created by
 973 `notmuch-search-filter' retain the search order of the parent
 974 search."
 975   (interactive)
 976   (set 'notmuch-search-oldest-first (not notmuch-search-oldest-first))
 977   (notmuch-search-refresh-view))
 978
 979 (defun notmuch-search-filter (query)
 980   "Filter the current search results based on an additional query string.
 981
 982 Runs a new search matching only messages that match both the
 983 current search results AND the additional query string provided."
 984   (interactive (list (notmuch-read-query "Filter search: ")))
 985   (let ((grouped-query (if (string-match-p notmuch-search-disjunctive-regexp query)
 986                            (concat "( " query " )")
 987                          query)))
 988     (notmuch-search (if (string= notmuch-search-query-string "*")
 989                         grouped-query
 990                       (concat notmuch-search-query-string " and " grouped-query)) notmuch-search-oldest-first)))
 991
 992 (defun notmuch-search-filter-by-tag (tag)
 993   "Filter the current search results based on a single tag.
 994
 995 Runs a new search matching only messages that match both the
 996 current search results AND that are tagged with the given tag."
 997   (interactive
 998    (list (notmuch-select-tag-with-completion "Filter by tag: ")))
 999   (notmuch-search (concat notmuch-search-query-string " and tag:" tag) notmuch-search-oldest-first))
1000
1001 ;;;###autoload
1002 (defun notmuch ()
1003   "Run notmuch and display saved searches, known tags, etc."
1004   (interactive)
1005   (notmuch-hello))
1006
1007 (defun notmuch-interesting-buffer (b)
1008   "Is the current buffer of interest to a notmuch user?"
1009   (with-current-buffer b
1010     (memq major-mode '(notmuch-show-mode
1011                        notmuch-search-mode
1012                        notmuch-hello-mode
1013                        message-mode))))
1014
1015 ;;;###autoload
1016 (defun notmuch-cycle-notmuch-buffers ()
1017   "Cycle through any existing notmuch buffers (search, show or hello).
1018
1019 If the current buffer is the only notmuch buffer, bury it. If no
1020 notmuch buffers exist, run `notmuch'."
1021   (interactive)
1022
1023   (let (start first)
1024     ;; If the current buffer is a notmuch buffer, remember it and then
1025     ;; bury it.
1026     (when (notmuch-interesting-buffer (current-buffer))
1027       (setq start (current-buffer))
1028       (bury-buffer))
1029
1030     ;; Find the first notmuch buffer.
1031     (setq first (loop for buffer in (buffer-list)
1032                      if (notmuch-interesting-buffer buffer)
1033                      return buffer))
1034
1035     (if first
1036         ;; If the first one we found is any other than the starting
1037         ;; buffer, switch to it.
1038         (unless (eq first start)
1039           (switch-to-buffer first))
1040       (notmuch))))
1041
1042 (setq mail-user-agent 'notmuch-user-agent)
1043
1044 (provide 'notmuch)