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