]> git.cworth.org Git - obsolete/notmuch-old/blob - emacs/notmuch-lib.el
9c4ee71811ed8e91b8378c96d2601533e39c5ad7
[obsolete/notmuch-old] / emacs / notmuch-lib.el
1 ;; notmuch-lib.el --- common variables, functions and function declarations
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 part of an emacs-based interface to the notmuch mail system.
23
24 (require 'mm-view)
25 (require 'mm-decode)
26 (require 'json)
27 (require 'cl)
28
29 (defvar notmuch-command "notmuch"
30   "Command to run the notmuch binary.")
31
32 (defgroup notmuch nil
33   "Notmuch mail reader for Emacs."
34   :group 'mail)
35
36 (defgroup notmuch-hello nil
37   "Overview of saved searches, tags, etc."
38   :group 'notmuch)
39
40 (defgroup notmuch-search nil
41   "Searching and sorting mail."
42   :group 'notmuch)
43
44 (defgroup notmuch-show nil
45   "Showing messages and threads."
46   :group 'notmuch)
47
48 (defgroup notmuch-send nil
49   "Sending messages from Notmuch."
50   :group 'notmuch)
51
52 (custom-add-to-group 'notmuch-send 'message 'custom-group)
53
54 (defgroup notmuch-crypto nil
55   "Processing and display of cryptographic MIME parts."
56   :group 'notmuch)
57
58 (defgroup notmuch-hooks nil
59   "Running custom code on well-defined occasions."
60   :group 'notmuch)
61
62 (defgroup notmuch-external nil
63   "Running external commands from within Notmuch."
64   :group 'notmuch)
65
66 (defgroup notmuch-faces nil
67   "Graphical attributes for displaying text"
68   :group 'notmuch)
69
70 (defcustom notmuch-search-oldest-first t
71   "Show the oldest mail first when searching."
72   :type 'boolean
73   :group 'notmuch-search)
74
75 ;;
76
77 (defvar notmuch-search-history nil
78   "Variable to store notmuch searches history.")
79
80 (defcustom notmuch-saved-searches '(("inbox" . "tag:inbox")
81                                     ("unread" . "tag:unread"))
82   "A list of saved searches to display."
83   :type '(alist :key-type string :value-type string)
84   :group 'notmuch-hello)
85
86 (defcustom notmuch-archive-tags '("-inbox")
87   "List of tag changes to apply to a message or a thread when it is archived.
88
89 Tags starting with \"+\" (or not starting with either \"+\" or
90 \"-\") in the list will be added, and tags starting with \"-\"
91 will be removed from the message or thread being archived.
92
93 For example, if you wanted to remove an \"inbox\" tag and add an
94 \"archived\" tag, you would set:
95     (\"-inbox\" \"+archived\")"
96   :type '(repeat string)
97   :group 'notmuch-search
98   :group 'notmuch-show)
99
100 (defun notmuch-version ()
101   "Return a string with the notmuch version number."
102   (let ((long-string
103          ;; Trim off the trailing newline.
104          (substring (shell-command-to-string
105                      (concat notmuch-command " --version"))
106                     0 -1)))
107     (if (string-match "^notmuch\\( version\\)? \\(.*\\)$"
108                       long-string)
109         (match-string 2 long-string)
110       "unknown")))
111
112 (defun notmuch-config-get (item)
113   "Return a value from the notmuch configuration."
114   ;; Trim off the trailing newline
115   (substring (shell-command-to-string
116               (concat notmuch-command " config get " item))
117               0 -1))
118
119 (defun notmuch-database-path ()
120   "Return the database.path value from the notmuch configuration."
121   (notmuch-config-get "database.path"))
122
123 (defun notmuch-user-name ()
124   "Return the user.name value from the notmuch configuration."
125   (notmuch-config-get "user.name"))
126
127 (defun notmuch-user-primary-email ()
128   "Return the user.primary_email value from the notmuch configuration."
129   (notmuch-config-get "user.primary_email"))
130
131 (defun notmuch-user-other-email ()
132   "Return the user.other_email value (as a list) from the notmuch configuration."
133   (split-string (notmuch-config-get "user.other_email") "\n"))
134
135 (defun notmuch-kill-this-buffer ()
136   "Kill the current buffer."
137   (interactive)
138   (kill-buffer (current-buffer)))
139
140 (defun notmuch-prettify-subject (subject)
141   ;; This function is used by `notmuch-search-process-filter' which
142   ;; requires that we not disrupt its' matching state.
143   (save-match-data
144     (if (and subject
145              (string-match "^[ \t]*$" subject))
146         "[No Subject]"
147       subject)))
148
149 (defun notmuch-escape-boolean-term (term)
150   "Escape a boolean term for use in a query.
151
152 The caller is responsible for prepending the term prefix and a
153 colon.  This performs minimal escaping in order to produce
154 user-friendly queries."
155
156   (save-match-data
157     (if (or (equal term "")
158             (string-match "[ ()]\\|^\"" term))
159         ;; Requires escaping
160         (concat "\"" (replace-regexp-in-string "\"" "\"\"" term t t) "\"")
161       term)))
162
163 (defun notmuch-id-to-query (id)
164   "Return a query that matches the message with id ID."
165   (concat "id:" (notmuch-escape-boolean-term id)))
166
167 ;;
168
169 (defun notmuch-common-do-stash (text)
170   "Common function to stash text in kill ring, and display in minibuffer."
171   (if text
172       (progn
173         (kill-new text)
174         (message "Stashed: %s" text))
175     ;; There is nothing to stash so stash an empty string so the user
176     ;; doesn't accidentally paste something else somewhere.
177     (kill-new "")
178     (message "Nothing to stash!")))
179
180 ;;
181
182 (defun notmuch-remove-if-not (predicate list)
183   "Return a copy of LIST with all items not satisfying PREDICATE removed."
184   (let (out)
185     (while list
186       (when (funcall predicate (car list))
187         (push (car list) out))
188       (setq list (cdr list)))
189     (nreverse out)))
190
191 ;; This lets us avoid compiling these replacement functions when emacs
192 ;; is sufficiently new enough to supply them alone. We do the macro
193 ;; treatment rather than just wrapping our defun calls in a when form
194 ;; specifically so that the compiler never sees the code on new emacs,
195 ;; (since the code is triggering warnings that we don't know how to get
196 ;; rid of.
197 ;;
198 ;; A more clever macro here would accept a condition and a list of forms.
199 (defmacro compile-on-emacs-prior-to-23 (form)
200   "Conditionally evaluate form only on emacs < emacs-23."
201   (list 'when (< emacs-major-version 23)
202         form))
203
204 (defun notmuch-split-content-type (content-type)
205   "Split content/type into 'content' and 'type'"
206   (split-string content-type "/"))
207
208 (defun notmuch-match-content-type (t1 t2)
209   "Return t if t1 and t2 are matching content types, taking wildcards into account"
210   (let ((st1 (notmuch-split-content-type t1))
211         (st2 (notmuch-split-content-type t2)))
212     (if (or (string= (cadr st1) "*")
213             (string= (cadr st2) "*"))
214         ;; Comparison of content types should be case insensitive.
215         (string= (downcase (car st1)) (downcase (car st2)))
216       (string= (downcase t1) (downcase t2)))))
217
218 (defvar notmuch-multipart/alternative-discouraged
219   '(
220     ;; Avoid HTML parts.
221     "text/html"
222     ;; multipart/related usually contain a text/html part and some associated graphics.
223     "multipart/related"
224     ))
225
226 (defun notmuch-multipart/alternative-choose (types)
227   "Return a list of preferred types from the given list of types"
228   ;; Based on `mm-preferred-alternative-precedence'.
229   (let ((seq types))
230     (dolist (pref (reverse notmuch-multipart/alternative-discouraged))
231       (dolist (elem (copy-sequence seq))
232         (when (string-match pref elem)
233           (setq seq (nconc (delete elem seq) (list elem))))))
234     seq))
235
236 (defun notmuch-parts-filter-by-type (parts type)
237   "Given a list of message parts, return a list containing the ones matching
238 the given type."
239   (remove-if-not
240    (lambda (part) (notmuch-match-content-type (plist-get part :content-type) type))
241    parts))
242
243 ;; Helper for parts which are generally not included in the default
244 ;; JSON output.
245 (defun notmuch-get-bodypart-internal (query part-number process-crypto)
246   (let ((args '("show" "--format=raw"))
247         (part-arg (format "--part=%s" part-number)))
248     (setq args (append args (list part-arg)))
249     (if process-crypto
250         (setq args (append args '("--decrypt"))))
251     (setq args (append args (list query)))
252     (with-temp-buffer
253       (let ((coding-system-for-read 'no-conversion))
254         (progn
255           (apply 'call-process (append (list notmuch-command nil (list t nil) nil) args))
256           (buffer-string))))))
257
258 (defun notmuch-get-bodypart-content (msg part nth process-crypto)
259   (or (plist-get part :content)
260       (notmuch-get-bodypart-internal (notmuch-id-to-query (plist-get msg :id)) nth process-crypto)))
261
262 ;; Workaround: The call to `mm-display-part' below triggers a bug in
263 ;; Emacs 24 if it attempts to use the shr renderer to display an HTML
264 ;; part with images in it (demonstrated in 24.1 and 24.2 on Debian and
265 ;; Fedora 17, though unreproducable in other configurations).
266 ;; `mm-shr' references the variable `gnus-inhibit-images' without
267 ;; first loading gnus-art, which defines it, resulting in a
268 ;; void-variable error.  Hence, we advise `mm-shr' to ensure gnus-art
269 ;; is loaded.
270 (if (>= emacs-major-version 24)
271     (defadvice mm-shr (before load-gnus-arts activate)
272       (require 'gnus-art nil t)
273       (ad-disable-advice 'mm-shr 'before 'load-gnus-arts)))
274
275 (defun notmuch-mm-display-part-inline (msg part nth content-type process-crypto)
276   "Use the mm-decode/mm-view functions to display a part in the
277 current buffer, if possible."
278   (let ((display-buffer (current-buffer)))
279     (with-temp-buffer
280       ;; In case there is :content, the content string is already converted
281       ;; into emacs internal format. `gnus-decoded' is a fake charset,
282       ;; which means no further decoding (to be done by mm- functions).
283       (let* ((charset (if (plist-member part :content)
284                           'gnus-decoded
285                         (plist-get part :content-charset)))
286              (handle (mm-make-handle (current-buffer) `(,content-type (charset . ,charset)))))
287         ;; If the user wants the part inlined, insert the content and
288         ;; test whether we are able to inline it (which includes both
289         ;; capability and suitability tests).
290         (when (mm-inlined-p handle)
291           (insert (notmuch-get-bodypart-content msg part nth process-crypto))
292           (when (mm-inlinable-p handle)
293             (set-buffer display-buffer)
294             (mm-display-part handle)
295             t))))))
296
297 ;; Converts a plist of headers to an alist of headers. The input plist should
298 ;; have symbols of the form :Header as keys, and the resulting alist will have
299 ;; symbols of the form 'Header as keys.
300 (defun notmuch-headers-plist-to-alist (plist)
301   (loop for (key value . rest) on plist by #'cddr
302         collect (cons (intern (substring (symbol-name key) 1)) value)))
303
304 (defun notmuch-combine-face-text-property (start end face)
305   "Combine FACE into the 'face text property between START and END.
306
307 This function combines FACE with any existing faces between START
308 and END.  Attributes specified by FACE take precedence over
309 existing attributes.  FACE must be a face name (a symbol or
310 string), a property list of face attributes, or a list of these."
311
312   (let ((pos start))
313     (while (< pos end)
314       (let ((cur (get-text-property pos 'face))
315             (next (next-single-property-change pos 'face nil end)))
316         (put-text-property pos next 'face (cons face cur))
317         (setq pos next)))))
318
319 ;; Compatibility functions for versions of emacs before emacs 23.
320 ;;
321 ;; Both functions here were copied from emacs 23 with the following copyright:
322 ;;
323 ;; Copyright (C) 1985, 1986, 1992, 1994, 1995, 1999, 2000, 2001, 2002, 2003,
324 ;;   2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
325 ;;
326 ;; and under the GPL version 3 (or later) exactly as notmuch itself.
327 (compile-on-emacs-prior-to-23
328  (defun apply-partially (fun &rest args)
329    "Return a function that is a partial application of FUN to ARGS.
330 ARGS is a list of the first N arguments to pass to FUN.
331 The result is a new function which does the same as FUN, except that
332 the first N arguments are fixed at the values with which this function
333 was called."
334    (lexical-let ((fun fun) (args1 args))
335      (lambda (&rest args2) (apply fun (append args1 args2))))))
336
337 (compile-on-emacs-prior-to-23
338  (defun mouse-event-p (object)
339    "Return non-nil if OBJECT is a mouse click event."
340    (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement))))
341
342 ;; This variable is used only buffer local, but it needs to be
343 ;; declared globally first to avoid compiler warnings.
344 (defvar notmuch-show-process-crypto nil)
345 (make-variable-buffer-local 'notmuch-show-process-crypto)
346
347 ;; Incremental JSON parsing
348
349 ;; These two variables are internal variables to the parsing
350 ;; routines. They are always used buffer local but need to be declared
351 ;; globally to avoid compiler warnings.
352
353 (defvar notmuch-json-parser nil
354   "Internal incremental JSON parser object: local to the buffer being parsed.")
355
356 (defvar notmuch-json-state nil
357   "State of the internal JSON parser: local to the buffer being parsed.")
358
359 (defun notmuch-json-create-parser (buffer)
360   "Return a streaming JSON parser that consumes input from BUFFER.
361
362 This parser is designed to read streaming JSON whose structure is
363 known to the caller.  Like a typical JSON parsing interface, it
364 provides a function to read a complete JSON value from the input.
365 However, it extends this with an additional function that
366 requires the next value in the input to be a compound value and
367 descends into it, allowing its elements to be read one at a time
368 or further descended into.  Both functions can return 'retry to
369 indicate that not enough input is available.
370
371 The parser always consumes input from BUFFER's point.  Hence, the
372 caller is allowed to delete and data before point and may
373 resynchronize after an error by moving point."
374
375   (list buffer
376         ;; Terminator stack: a stack of characters that indicate the
377         ;; end of the compound values enclosing point
378         '()
379         ;; Next: One of
380         ;; * 'expect-value if the next token must be a value, but a
381         ;;   value has not yet been reached
382         ;; * 'value if point is at the beginning of a value
383         ;; * 'expect-comma if the next token must be a comma
384         'expect-value
385         ;; Allow terminator: non-nil if the next token may be a
386         ;; terminator
387         nil
388         ;; Partial parse position: If state is 'value, a marker for
389         ;; the position of the partial parser or nil if no partial
390         ;; parsing has happened yet
391         nil
392         ;; Partial parse state: If state is 'value, the current
393         ;; `parse-partial-sexp' state
394         nil))
395
396 (defmacro notmuch-json-buffer (jp) `(first ,jp))
397 (defmacro notmuch-json-term-stack (jp) `(second ,jp))
398 (defmacro notmuch-json-next (jp) `(third ,jp))
399 (defmacro notmuch-json-allow-term (jp) `(fourth ,jp))
400 (defmacro notmuch-json-partial-pos (jp) `(fifth ,jp))
401 (defmacro notmuch-json-partial-state (jp) `(sixth ,jp))
402
403 (defvar notmuch-json-syntax-table
404   (let ((table (make-syntax-table)))
405     ;; The standard syntax table is what we need except that "." needs
406     ;; to have word syntax instead of punctuation syntax.
407     (modify-syntax-entry ?. "w" table)
408     table)
409   "Syntax table used for incremental JSON parsing.")
410
411 (defun notmuch-json-scan-to-value (jp)
412   ;; Helper function that consumes separators, terminators, and
413   ;; whitespace from point.  Returns nil if it successfully reached
414   ;; the beginning of a value, 'end if it consumed a terminator, or
415   ;; 'retry if not enough input was available to reach a value.  Upon
416   ;; nil return, (notmuch-json-next jp) is always 'value.
417
418   (if (eq (notmuch-json-next jp) 'value)
419       ;; We're already at a value
420       nil
421     ;; Drive the state toward 'expect-value
422     (skip-chars-forward " \t\r\n")
423     (or (when (eobp) 'retry)
424         ;; Test for the terminator for the current compound
425         (when (and (notmuch-json-allow-term jp)
426                    (eq (char-after) (car (notmuch-json-term-stack jp))))
427           ;; Consume it and expect a comma or terminator next
428           (forward-char)
429           (setf (notmuch-json-term-stack jp) (cdr (notmuch-json-term-stack jp))
430                 (notmuch-json-next jp) 'expect-comma
431                 (notmuch-json-allow-term jp) t)
432           'end)
433         ;; Test for a separator
434         (when (eq (notmuch-json-next jp) 'expect-comma)
435           (when (/= (char-after) ?,)
436             (signal 'json-readtable-error (list "expected ','")))
437           ;; Consume it, switch to 'expect-value, and disallow a
438           ;; terminator
439           (forward-char)
440           (skip-chars-forward " \t\r\n")
441           (setf (notmuch-json-next jp) 'expect-value
442                 (notmuch-json-allow-term jp) nil)
443           ;; We moved point, so test for eobp again and fall through
444           ;; to the next test if there's more input
445           (when (eobp) 'retry))
446         ;; Next must be 'expect-value and we know this isn't
447         ;; whitespace, EOB, or a terminator, so point must be on a
448         ;; value
449         (progn
450           (assert (eq (notmuch-json-next jp) 'expect-value))
451           (setf (notmuch-json-next jp) 'value)
452           nil))))
453
454 (defun notmuch-json-begin-compound (jp)
455   "Parse the beginning of a compound value and traverse inside it.
456
457 Returns 'retry if there is insufficient input to parse the
458 beginning of the compound.  If this is able to parse the
459 beginning of a compound, it moves point past the token that opens
460 the compound and returns t.  Later calls to `notmuch-json-read'
461 will return the compound's elements.
462
463 Entering JSON objects is currently unimplemented."
464
465   (with-current-buffer (notmuch-json-buffer jp)
466     ;; Disallow terminators
467     (setf (notmuch-json-allow-term jp) nil)
468     (or (notmuch-json-scan-to-value jp)
469         (if (/= (char-after) ?\[)
470             (signal 'json-readtable-error (list "expected '['"))
471           (forward-char)
472           (push ?\] (notmuch-json-term-stack jp))
473           ;; Expect a value or terminator next
474           (setf (notmuch-json-next jp) 'expect-value
475                 (notmuch-json-allow-term jp) t)
476           t))))
477
478 (defun notmuch-json-read (jp)
479   "Parse the value at point in JP's buffer.
480
481 Returns 'retry if there is insufficient input to parse a complete
482 JSON value (though it may still move point over separators or
483 whitespace).  If the parser is currently inside a compound value
484 and the next token ends the list or object, this moves point just
485 past the terminator and returns 'end.  Otherwise, this moves
486 point to just past the end of the value and returns the value."
487
488   (with-current-buffer (notmuch-json-buffer jp)
489     (or
490      ;; Get to a value state
491      (notmuch-json-scan-to-value jp)
492
493      ;; Can we parse a complete value?
494      (let ((complete
495             (if (looking-at "[-+0-9tfn]")
496                 ;; This is a number or a keyword, so the partial
497                 ;; parser isn't going to help us because a truncated
498                 ;; number or keyword looks like a complete symbol to
499                 ;; it.  Look for something that clearly ends it.
500                 (save-excursion
501                   (skip-chars-forward "^]},: \t\r\n")
502                   (not (eobp)))
503
504               ;; We're looking at a string, object, or array, which we
505               ;; can partial parse.  If we just reached the value, set
506               ;; up the partial parser.
507               (when (null (notmuch-json-partial-state jp))
508                 (setf (notmuch-json-partial-pos jp) (point-marker)))
509
510               ;; Extend the partial parse until we either reach EOB or
511               ;; get the whole value
512               (save-excursion
513                 (let ((pstate
514                        (with-syntax-table notmuch-json-syntax-table
515                          (parse-partial-sexp
516                           (notmuch-json-partial-pos jp) (point-max) 0 nil
517                           (notmuch-json-partial-state jp)))))
518                   ;; A complete value is available if we've reached
519                   ;; depth 0 or less and encountered a complete
520                   ;; subexpression.
521                   (if (and (<= (first pstate) 0) (third pstate))
522                       t
523                     ;; Not complete.  Update the partial parser state
524                     (setf (notmuch-json-partial-pos jp) (point-marker)
525                           (notmuch-json-partial-state jp) pstate)
526                     nil))))))
527
528        (if (not complete)
529            'retry
530          ;; We have a value.  Reset the partial parse state and expect
531          ;; a comma or terminator after the value.
532          (setf (notmuch-json-next jp) 'expect-comma
533                (notmuch-json-allow-term jp) t
534                (notmuch-json-partial-pos jp) nil
535                (notmuch-json-partial-state jp) nil)
536          ;; Parse the value
537          (let ((json-object-type 'plist)
538                (json-array-type 'list)
539                (json-false nil))
540            (json-read)))))))
541
542 (defun notmuch-json-eof (jp)
543   "Signal a json-error if there is more data in JP's buffer.
544
545 Moves point to the beginning of any trailing data or to the end
546 of the buffer if there is only trailing whitespace."
547
548   (with-current-buffer (notmuch-json-buffer jp)
549     (skip-chars-forward " \t\r\n")
550     (unless (eobp)
551       (signal 'json-error (list "Trailing garbage following JSON data")))))
552
553 (defun notmuch-json-parse-partial-list (result-function error-function results-buf)
554   "Parse a partial JSON list from current buffer.
555
556 This function consumes a JSON list from the current buffer,
557 applying RESULT-FUNCTION in buffer RESULT-BUFFER to each complete
558 value in the list.  It operates incrementally and should be
559 called whenever the buffer has been extended with additional
560 data.
561
562 If there is a syntax error, this will attempt to resynchronize
563 with the input and will apply ERROR-FUNCTION in buffer
564 RESULT-BUFFER to any input that was skipped.
565
566 It sets up all the needed internal variables: the caller just
567 needs to call it with point in the same place that the parser
568 left it."
569   (let (done)
570     (unless (local-variable-p 'notmuch-json-parser)
571       (set (make-local-variable 'notmuch-json-parser)
572            (notmuch-json-create-parser (current-buffer)))
573       (set (make-local-variable 'notmuch-json-state) 'begin))
574     (while (not done)
575       (condition-case nil
576           (case notmuch-json-state
577                 ((begin)
578                  ;; Enter the results list
579                  (if (eq (notmuch-json-begin-compound
580                           notmuch-json-parser) 'retry)
581                      (setq done t)
582                    (setq notmuch-json-state 'result)))
583                 ((result)
584                  ;; Parse a result
585                  (let ((result (notmuch-json-read notmuch-json-parser)))
586                    (case result
587                          ((retry) (setq done t))
588                          ((end) (setq notmuch-json-state 'end))
589                          (otherwise (with-current-buffer results-buf
590                                       (funcall result-function result))))))
591                 ((end)
592                  ;; Any trailing data is unexpected
593                  (notmuch-json-eof notmuch-json-parser)
594                  (setq done t)))
595         (json-error
596          ;; Do our best to resynchronize and ensure forward
597          ;; progress
598          (let ((bad (buffer-substring (line-beginning-position)
599                                       (line-end-position))))
600            (forward-line)
601            (with-current-buffer results-buf
602              (funcall error-function "%s" bad))))))
603     ;; Clear out what we've parsed
604     (delete-region (point-min) (point))))
605
606
607
608
609 (provide 'notmuch-lib)
610
611 ;; Local Variables:
612 ;; byte-compile-warnings: (not cl-functions)
613 ;; End: