1 ;;; notmuch-tag.el --- tag messages within emacs
3 ;; Copyright © Damien Cassou
4 ;; Copyright © Carl Worth
6 ;; This file is part of Notmuch.
8 ;; Notmuch is free software: you can redistribute it and/or modify it
9 ;; under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; Notmuch is distributed in the hope that it will be useful, but
14 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 ;; General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with Notmuch. If not, see <https://www.gnu.org/licenses/>.
21 ;; Authors: Carl Worth <cworth@cworth.org>
22 ;; Damien Cassou <damien.cassou@gmail.com>
32 (require 'notmuch-lib)
34 (declare-function notmuch-search-tag "notmuch"
35 (tag-changes &optional beg end only-matched))
36 (declare-function notmuch-show-tag "notmuch-show" (tag-changes))
37 (declare-function notmuch-tree-tag "notmuch-tree" (tag-changes))
38 (declare-function notmuch-jump "notmuch-jump" (action-map prompt))
42 (define-widget 'notmuch-tag-key-type 'list
43 "A single key tagging binding."
45 :args '((list :inline t
47 (key-sequence :tag "Key")
48 (radio :tag "Tag operations"
49 (repeat :tag "Tag list"
50 (string :format "%v" :tag "change"))
51 (variable :tag "Tag variable"))
52 (string :tag "Name"))))
54 (defcustom notmuch-tagging-keys
55 `((,(kbd "a") notmuch-archive-tags "Archive")
56 (,(kbd "u") notmuch-show-mark-read-tags "Mark read")
57 (,(kbd "f") ("+flagged") "Flag")
58 (,(kbd "s") ("+spam" "-inbox") "Mark as spam")
59 (,(kbd "d") ("+deleted" "-inbox") "Delete"))
60 "A list of keys and corresponding tagging operations.
62 For each key (or key sequence) you can specify a sequence of
63 tagging operations to apply, or a variable which contains a list
64 of tagging operations such as `notmuch-archive-tags'. The final
65 element is a name for this tagging operation. If the name is
66 omitted or empty then the list of tag changes, or the variable
67 name is used as the name.
69 The key `notmuch-tag-jump-reverse-key' (k by default) should not
70 be used (either as a key, or as the start of a key sequence) as
71 it is already bound: it switches the menu to a menu of the
72 reverse tagging operations. The reverse of a tagging operation is
73 the same list of individual tag-ops but with `+tag' replaced by
74 `-tag' and vice versa.
76 If setting this variable outside of customize then it should be a
77 list of triples (lists of three elements). Each triple should be
78 of the form (key-binding tagging-operations name). KEY-BINDING
79 can be a single character or a key sequence; TAGGING-OPERATIONS
80 should either be a list of individual tag operations each of the
81 form `+tag' or `-tag', or the variable name of a variable that is
82 a list of tagging operations; NAME should be a name for the
83 tagging operation, if omitted or empty than then name is taken
84 from TAGGING-OPERATIONS."
85 :tag "List of tagging bindings"
86 :type '(repeat notmuch-tag-key-type)
91 (define-widget 'notmuch-tag-format-type 'lazy
92 "Customize widget for notmuch-tag-format and friends."
93 :type '(alist :key-type (regexp :tag "Tag")
97 (const :tag "Hidden" nil)
99 (string :tag "Display as")
100 (list :tag "Face" :extra-offset -4
101 (const :format "" :inline t
102 (notmuch-apply-face tag))
104 (const :format "" quote)
106 (list :format "%v" :extra-offset -4
107 (const :format "" :inline t
108 (notmuch-tag-format-image-data tag))
111 (notmuch-tag-star-icon))
112 (const :tag "Empty star"
113 (notmuch-tag-star-empty-icon))
115 (notmuch-tag-tag-icon))
116 (string :tag "Custom")))
117 (sexp :tag "Custom")))))
119 (defface notmuch-tag-unread
120 '((t :foreground "red"))
121 "Default face used for the unread tag.
123 Used in the default value of `notmuch-tag-formats'."
124 :group 'notmuch-faces)
126 (defface notmuch-tag-flagged
129 (:foreground "LightBlue1"))
132 (:foreground "blue")))
133 "Face used for the flagged tag.
135 Used in the default value of `notmuch-tag-formats'."
136 :group 'notmuch-faces)
138 (defcustom notmuch-tag-formats
139 '(("unread" (propertize tag 'face 'notmuch-tag-unread))
140 ("flagged" (propertize tag 'face 'notmuch-tag-flagged)
141 (notmuch-tag-format-image-data tag (notmuch-tag-star-icon))))
142 "Custom formats for individual tags.
144 This is an association list that maps from tag name regexps to
145 lists of formatting expressions. The first entry whose car
146 regexp-matches a tag will be used to format that tag. The regexp
147 is implicitly anchored, so to match a literal tag name, just use
148 that tag name (if it contains special regexp characters like
149 \".\" or \"*\", these have to be escaped). The cdr of the
150 matching entry gives a list of Elisp expressions that modify the
151 tag. If the list is empty, the tag will simply be hidden.
152 Otherwise, each expression will be evaluated in order: for the
153 first expression, the variable `tag' will be bound to the tag
154 name; for each later expression, the variable `tag' will be bound
155 to the result of the previous expression. In this way, each
156 expression can build on the formatting performed by the previous
157 expression. The result of the last expression will displayed in
160 For example, to replace a tag with another string, simply use
161 that string as a formatting expression. To change the foreground
162 of a tag to red, use the expression
163 (propertize tag 'face '(:foreground \"red\"))
165 See also `notmuch-tag-format-image', which can help replace tags
167 :group 'notmuch-search
169 :group 'notmuch-faces
170 :type 'notmuch-tag-format-type)
172 (defface notmuch-tag-deleted
173 '((((class color) (supports :strike-through "red")) :strike-through "red")
174 (t :inverse-video t))
175 "Face used to display deleted tags.
177 Used in the default value of `notmuch-tag-deleted-formats'."
178 :group 'notmuch-faces)
180 (defcustom notmuch-tag-deleted-formats
181 '(("unread" (notmuch-apply-face bare-tag `notmuch-tag-deleted))
182 (".*" (notmuch-apply-face tag `notmuch-tag-deleted)))
183 "Custom formats for tags when deleted.
185 For deleted tags the formats in `notmuch-tag-formats' are applied
186 first and then these formats are applied on top; that is `tag'
187 passed to the function is the tag with all these previous
188 formattings applied. The formatted can access the original
189 unformatted tag as `bare-tag'.
191 By default this shows deleted tags with strike-through in red,
192 unless strike-through is not available (e.g., emacs is running in
193 a terminal) in which case it uses inverse video. To hide deleted
194 tags completely set this to
197 See `notmuch-tag-formats' for full documentation."
199 :group 'notmuch-faces
200 :type 'notmuch-tag-format-type)
202 (defface notmuch-tag-added
203 '((t :underline "green"))
204 "Default face used for added tags.
206 Used in the default value for `notmuch-tag-added-formats'."
207 :group 'notmuch-faces)
209 (defcustom notmuch-tag-added-formats
210 '((".*" (notmuch-apply-face tag 'notmuch-tag-added)))
211 "Custom formats for tags when added.
213 For added tags the formats in `notmuch-tag-formats' are applied
214 first and then these formats are applied on top.
216 To disable special formatting of added tags, set this variable to
219 See `notmuch-tag-formats' for full documentation."
221 :group 'notmuch-faces
222 :type 'notmuch-tag-format-type)
226 (defun notmuch-tag-format-image-data (tag data)
227 "Replace TAG with image DATA, if available.
229 This function returns a propertized string that will display image
230 DATA in place of TAG.This is designed for use in
231 `notmuch-tag-formats'.
233 DATA is the content of an SVG picture (e.g., as returned by
234 `notmuch-tag-star-icon')."
235 (propertize tag 'display
241 (defun notmuch-tag-star-icon ()
242 "Return SVG data representing a star icon.
243 This can be used with `notmuch-tag-format-image-data'."
244 "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>
245 <svg version=\"1.1\" width=\"16\" height=\"16\">
246 <g transform=\"translate(-242.81601,-315.59635)\">
248 d=\"m 290.25762,334.31206 -17.64143,-11.77975 -19.70508,7.85447 5.75171,-20.41814 -13.55925,-16.31348 21.19618,-0.83936 11.325,-17.93675 7.34825,19.89939 20.55849,5.22795 -16.65471,13.13786 z\"
249 transform=\"matrix(0.2484147,-0.02623394,0.02623394,0.2484147,174.63605,255.37691)\"
250 style=\"fill:#ffff00;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />
254 (defun notmuch-tag-star-empty-icon ()
255 "Return SVG data representing an empty star icon.
256 This can be used with `notmuch-tag-format-image-data'."
257 "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>
258 <svg version=\"1.1\" width=\"16\" height=\"16\">
259 <g transform=\"translate(-242.81601,-315.59635)\">
261 d=\"m 290.25762,334.31206 -17.64143,-11.77975 -19.70508,7.85447 5.75171,-20.41814 -13.55925,-16.31348 21.19618,-0.83936 11.325,-17.93675 7.34825,19.89939 20.55849,5.22795 -16.65471,13.13786 z\"
262 transform=\"matrix(0.2484147,-0.02623394,0.02623394,0.2484147,174.63605,255.37691)\"
263 style=\"fill:#d6d6d1;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1\" />
267 (defun notmuch-tag-tag-icon ()
268 "Return SVG data representing a tag icon.
269 This can be used with `notmuch-tag-format-image-data'."
270 "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>
271 <svg version=\"1.1\" width=\"16\" height=\"16\">
272 <g transform=\"translate(0,-1036.3622)\">
274 d=\"m 0.44642857,1040.9336 12.50000043,0 2.700893,3.6161 -2.700893,3.616 -12.50000043,0 z\"
275 style=\"fill:#ffff00;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.25;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1\" />
281 (defvar notmuch-tag--format-cache (make-hash-table :test 'equal)
282 "Cache of tag format lookup. Internal to `notmuch-tag-format-tag'.")
284 (defun notmuch-tag-clear-cache ()
285 "Clear the internal cache of tag formats."
286 (clrhash notmuch-tag--format-cache))
288 (defun notmuch-tag--get-formats (tag format-alist)
289 "Find the first item whose car regexp-matches TAG."
291 ;; Don't use assoc-default since there's no way to distinguish a
292 ;; missing key from a present key with a null cdr.
293 (cl-assoc tag format-alist
294 :test (lambda (tag key)
295 (and (eq (string-match key tag) 0)
296 (= (match-end 0) (length tag)))))))
298 (defun notmuch-tag--do-format (tag formatted-tag formats)
299 "Apply a tag-formats entry to TAG."
300 (cond ((null formats) ;; - Tag not in `formats',
301 formatted-tag) ;; the format is the tag itself.
302 ((null (cdr formats)) ;; - Tag was deliberately hidden,
303 nil) ;; no format must be returned
305 ;; Tag was found and has formats, we must apply all the
306 ;; formats. TAG may be null so treat that as a special case.
308 (tag (copy-sequence (or formatted-tag ""))))
309 (dolist (format (cdr formats))
310 (setq tag (eval format)))
311 (if (and (null formatted-tag) (equal tag ""))
315 (defun notmuch-tag-format-tag (tags orig-tags tag)
316 "Format TAG according to `notmuch-tag-formats'.
318 TAGS and ORIG-TAGS are lists of the current tags and the original
319 tags; tags which have been deleted (i.e., are in ORIG-TAGS but
320 are not in TAGS) are shown using formats from
321 `notmuch-tag-deleted-formats'; tags which have been added (i.e.,
322 are in TAGS but are not in ORIG-TAGS) are shown using formats
323 from `notmuch-tag-added-formats' and tags which have not been
324 changed (the normal case) are shown using formats from
325 `notmuch-tag-formats'."
326 (let* ((tag-state (cond ((not (member tag tags)) 'deleted)
327 ((not (member tag orig-tags)) 'added)))
328 (formatted-tag (gethash (cons tag tag-state)
329 notmuch-tag--format-cache
331 (when (eq formatted-tag 'missing)
332 (let ((base (notmuch-tag--get-formats tag notmuch-tag-formats))
333 (over (cl-case tag-state
334 (deleted (notmuch-tag--get-formats
335 tag notmuch-tag-deleted-formats))
336 (added (notmuch-tag--get-formats
337 tag notmuch-tag-added-formats))
339 (setq formatted-tag (notmuch-tag--do-format tag tag base))
340 (setq formatted-tag (notmuch-tag--do-format tag formatted-tag over))
341 (puthash (cons tag tag-state) formatted-tag notmuch-tag--format-cache)))
344 (defun notmuch-tag-format-tags (tags orig-tags &optional face)
345 "Return a string representing formatted TAGS."
346 (let ((face (or face 'notmuch-tag-face))
347 (all-tags (sort (delete-dups (append tags orig-tags nil)) #'string<)))
349 (mapconcat #'identity
350 ;; nil indicated that the tag was deliberately hidden
351 (delq nil (mapcar (apply-partially #'notmuch-tag-format-tag
360 (defcustom notmuch-before-tag-hook nil
361 "Hooks that are run before tags of a message are modified.
363 'tag-changes' will contain the tags that are about to be added or removed as
364 a list of strings of the form \"+TAG\" or \"-TAG\".
365 'query' will be a string containing the search query that determines
366 the messages that are about to be tagged."
368 :options '(notmuch-hl-line-mode)
369 :group 'notmuch-hooks)
371 (defcustom notmuch-after-tag-hook nil
372 "Hooks that are run after tags of a message are modified.
374 'tag-changes' will contain the tags that were added or removed as
375 a list of strings of the form \"+TAG\" or \"-TAG\".
376 'query' will be a string containing the search query that determines
377 the messages that were tagged."
379 :options '(notmuch-hl-line-mode)
380 :group 'notmuch-hooks)
384 (defvar notmuch-select-tag-history nil
385 "Variable to store minibuffer history for
386 `notmuch-select-tag-with-completion' function.")
388 (defvar notmuch-read-tag-changes-history nil
389 "Variable to store minibuffer history for
390 `notmuch-read-tag-changes' function.")
392 (defun notmuch-tag-completions (&rest search-terms)
393 "Return a list of tags for messages matching SEARCH-TERMS.
395 Returns all tags if no search terms are given."
397 (setq search-terms (list "*")))
399 (with-output-to-string
400 (with-current-buffer standard-output
401 (apply 'call-process notmuch-command nil t
402 nil "search" "--output=tags" "--exclude=false" search-terms)))
405 (defun notmuch-select-tag-with-completion (prompt &rest search-terms)
406 (let ((tag-list (apply #'notmuch-tag-completions search-terms)))
407 (completing-read prompt tag-list nil nil nil 'notmuch-select-tag-history)))
409 (defun notmuch-read-tag-changes (current-tags &optional prompt initial-input)
410 "Prompt for tag changes in the minibuffer.
412 CURRENT-TAGS is a list of tags that are present on the message or
413 messages to be changed. These are offered as tag removal
414 completions. CURRENT-TAGS may contain duplicates. PROMPT, if
415 non-nil, is the query string to present in the minibuffer. It
416 defaults to \"Tags\". INITIAL-INPUT, if non-nil, will be the
417 initial input in the minibuffer."
418 (let* ((all-tag-list (notmuch-tag-completions))
419 (add-tag-list (mapcar (apply-partially 'concat "+") all-tag-list))
420 (remove-tag-list (mapcar (apply-partially 'concat "-") current-tags))
421 (tag-list (append add-tag-list remove-tag-list))
422 (prompt (concat (or prompt "Tags") " (+add -drop): "))
424 ;; By default, space is bound to "complete word" function.
425 ;; Re-bind it to insert a space instead. Note that <tab>
426 ;; still does the completion.
427 (crm-local-completion-map
428 (let ((map (make-sparse-keymap)))
429 (set-keymap-parent map crm-local-completion-map)
430 (define-key map " " 'self-insert-command)
432 (delete "" (completing-read-multiple
434 ;; Append the separator to each completion so when the
435 ;; user completes a tag they can immediately begin
436 ;; entering another. `completing-read-multiple'
437 ;; ultimately splits the input on crm-separator, so we
438 ;; don't need to strip this back off (we just need to
439 ;; delete "empty" entries caused by trailing spaces).
440 (mapcar (lambda (tag-op) (concat tag-op crm-separator)) tag-list)
441 nil nil initial-input
442 'notmuch-read-tag-changes-history))))
446 (defun notmuch-update-tags (tags tag-changes)
447 "Return a copy of TAGS with additions and removals from TAG-CHANGES.
449 TAG-CHANGES must be a list of tags names, each prefixed with
450 either a \"+\" to indicate the tag should be added to TAGS if not
451 present or a \"-\" to indicate that the tag should be removed
452 from TAGS if present."
453 (let ((result-tags (copy-sequence tags)))
454 (dolist (tag-change tag-changes)
455 (let ((op (string-to-char tag-change))
456 (tag (unless (string= tag-change "") (substring tag-change 1))))
458 (?+ (unless (member tag result-tags)
459 (push tag result-tags)))
460 (?- (setq result-tags (delete tag result-tags)))
462 (error "Changed tag must be of the form `+this_tag' or `-that_tag'")))))
463 (sort result-tags 'string<)))
465 (defconst notmuch-tag-argument-limit 1000
466 "Use batch tagging if the tagging query is longer than this.
468 This limits the length of arguments passed to the notmuch CLI to
469 avoid system argument length limits and performance problems.")
471 (defun notmuch-tag (query tag-changes)
472 "Add/remove tags in TAG-CHANGES to messages matching QUERY.
474 QUERY should be a string containing the search-terms.
475 TAG-CHANGES is a list of strings of the form \"+tag\" or
476 \"-tag\" to add or remove tags, respectively.
478 Note: Other code should always use this function to alter tags of
479 messages instead of running (notmuch-call-notmuch-process \"tag\" ..)
480 directly, so that hooks specified in notmuch-before-tag-hook and
481 notmuch-after-tag-hook will be run."
482 ;; Perform some validation
483 (mapc (lambda (tag-change)
484 (unless (string-match-p "^[-+]\\S-+$" tag-change)
485 (error "Tag must be of the form `+this_tag' or `-that_tag'")))
488 (error "Nothing to tag!"))
489 (unless (null tag-changes)
490 (run-hooks 'notmuch-before-tag-hook)
491 (if (<= (length query) notmuch-tag-argument-limit)
492 (apply 'notmuch-call-notmuch-process "tag"
493 (append tag-changes (list "--" query)))
494 ;; Use batch tag mode to avoid argument length limitations
495 (let ((batch-op (concat (mapconcat #'notmuch-hex-encode tag-changes " ")
497 (notmuch-call-notmuch-process :stdin-string batch-op "tag" "--batch")))
498 (run-hooks 'notmuch-after-tag-hook)))
500 (defun notmuch-tag-change-list (tags &optional reverse)
501 "Convert TAGS into a list of tag changes.
503 Add a \"+\" prefix to any tag in TAGS list that doesn't already
504 begin with a \"+\" or a \"-\". If REVERSE is non-nil, replace all
505 \"+\" prefixes with \"-\" and vice versa in the result."
506 (mapcar (lambda (str)
507 (let ((s (if (string-match "^[+-]" str) str (concat "+" str))))
509 (concat (if (= (string-to-char s) ?-) "+" "-")
514 (defvar notmuch-tag-jump-reverse-key "k"
515 "The key in tag-jump to switch to the reverse tag changes.")
517 (defun notmuch-tag-jump (reverse)
518 "Create a jump menu for tagging operations.
520 Creates and displays a jump menu for the tagging operations
521 specified in `notmuch-tagging-keys'. If REVERSE is set then it
522 offers a menu of the reverses of the operations specified in
523 `notmuch-tagging-keys'; i.e. each `+tag' is replaced by `-tag'
525 ;; In principle this function is simple, but it has to deal with
526 ;; lots of cases: different modes (search/show/tree), whether a name
527 ;; is specified, whether the tagging operations is a list of
528 ;; tag-ops, or a symbol that evaluates to such a list, and whether
529 ;; REVERSE is specified.
532 (pcase-dolist (`(,key ,tag ,name) notmuch-tagging-keys)
533 (let* ((tag-function (cl-case major-mode
534 (notmuch-search-mode #'notmuch-search-tag)
535 (notmuch-show-mode #'notmuch-show-tag)
536 (notmuch-tree-mode #'notmuch-tree-tag)))
537 (tag (if (symbolp tag)
540 (tag-change (if reverse
541 (notmuch-tag-change-list tag t)
543 (name (or (and (not (string= name ""))
546 (symbol-name name))))
547 (name-string (if name
549 (concat "Reverse " name)
551 (mapconcat #'identity tag-change " "))))
552 (push (list key name-string
553 `(lambda () (,tag-function ',tag-change)))
555 (push (list notmuch-tag-jump-reverse-key
557 "Forward tag changes "
558 "Reverse tag changes")
559 (apply-partially 'notmuch-tag-jump (not reverse)))
561 (setq action-map (nreverse action-map))
562 (notmuch-jump action-map "Tag: ")))
566 (provide 'notmuch-tag)
568 ;;; notmuch-tag.el ends here