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