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