1 ;; notmuch-hello.el --- welcome to notmuch, a frontend
3 ;; Copyright © David Edmondson
5 ;; This file is part of Notmuch.
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.
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.
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/>.
20 ;; Authors: David Edmondson <dme@dme.org>
23 (require 'wid-edit) ; For `widget-forward'.
26 (require 'notmuch-lib)
27 (require 'notmuch-mua)
29 (declare-function notmuch-search "notmuch" (query &optional oldest-first target-thread target-line continuation))
30 (declare-function notmuch-poll "notmuch" ())
32 (defvar notmuch-hello-search-bar-marker nil
33 "The position of the search bar within the notmuch-hello buffer.")
35 (defcustom notmuch-recent-searches-max 10
36 "The number of recent searches to store and display."
40 (defcustom notmuch-show-empty-saved-searches nil
41 "Should saved searches with no messages be listed?"
45 (defvar notmuch-hello-indent 4
46 "How much to indent non-headers.")
48 (defcustom notmuch-show-logo t
49 "Should the notmuch logo be shown?"
53 (defcustom notmuch-show-all-tags-list nil
54 "Should all tags be shown in the notmuch-hello view?"
58 (defface notmuch-hello-logo-background
61 (:background "#5f5f5f"))
64 (:background "white")))
65 "Background colour for the notmuch logo."
68 (defcustom notmuch-column-control t
69 "Controls the number of columns for saved searches/tags in notmuch view.
71 This variable has three potential sets of values:
73 - t: automatically calculate the number of columns possible based
74 on the tags to be shown and the window width,
75 - an integer: a lower bound on the number of characters that will
76 be used to display each column,
77 - a float: a fraction of the window width that is the lower bound
78 on the number of characters that should be used for each
82 - if you would like two columns of tags, set this to 0.5.
83 - if you would like a single column of tags, set this to 1.0.
84 - if you would like tags to be 30 characters wide, set this to
86 - if you don't want to worry about all of this nonsense, leave
90 (const :tag "Automatically calculated" t)
91 (integer :tag "Number of characters")
92 (float :tag "Fraction of window")))
94 (defcustom notmuch-decimal-separator ","
95 "The string used as a decimal separator.
97 Typically \",\" in the US and UK and \".\" in Europe."
101 (defvar notmuch-hello-url "http://notmuchmail.org"
102 "The `notmuch' web site.")
104 (defvar notmuch-hello-recent-searches nil)
106 (defun notmuch-hello-remember-search (search)
107 (if (not (member search notmuch-hello-recent-searches))
108 (push search notmuch-hello-recent-searches))
109 (if (> (length notmuch-hello-recent-searches)
110 notmuch-recent-searches-max)
111 (setq notmuch-hello-recent-searches (butlast notmuch-hello-recent-searches))))
113 (defun notmuch-hello-nice-number (n)
116 (push (% n 1000) result)
119 (number-to-string (car result))
120 (mapcar (lambda (elem)
121 (format "%s%03d" notmuch-decimal-separator elem))
124 (defun notmuch-hello-trim (search)
126 (if (string-match "^[[:space:]]*\\(.*[^[:space:]]\\)[[:space:]]*$" search)
127 (match-string 1 search)
130 (defun notmuch-hello-search (search)
131 (let ((search (notmuch-hello-trim search)))
132 (notmuch-hello-remember-search search)
133 (notmuch-search search notmuch-search-oldest-first nil nil #'notmuch-hello-search-continuation)))
135 (defun notmuch-hello-add-saved-search (widget)
137 (let ((search (widget-value
139 (widget-get widget :notmuch-saved-search-widget))))
140 (name (completing-read "Name for saved search: "
141 notmuch-saved-searches)))
142 ;; If an existing saved search with this name exists, remove it.
143 (setq notmuch-saved-searches
144 (loop for elem in notmuch-saved-searches
149 (customize-save-variable 'notmuch-saved-searches
150 (push (cons name search)
151 notmuch-saved-searches))
152 (message "Saved '%s' as '%s'." search name)
153 (notmuch-hello-update)))
155 (defun notmuch-hello-longest-label (tag-alist)
156 (or (loop for elem in tag-alist
157 maximize (length (car elem)))
160 (defun notmuch-hello-reflect-generate-row (ncols nrows row list)
161 (let ((len (length list)))
162 (loop for col from 0 to (- ncols 1)
163 collect (let ((offset (+ (* nrows col) row)))
166 ;; Don't forget to insert an empty slot in the
167 ;; output matrix if there is no corresponding
168 ;; value in the input matrix.
171 (defun notmuch-hello-reflect (list ncols)
172 "Reflect a `ncols' wide matrix represented by `list' along the
175 (let ((nrows (ceiling (length list) ncols)))
176 (loop for row from 0 to (- nrows 1)
177 append (notmuch-hello-reflect-generate-row ncols nrows row list))))
179 (defun notmuch-hello-widget-search (widget &rest ignore)
180 (notmuch-search (widget-get widget
181 :notmuch-search-terms)
182 notmuch-search-oldest-first
183 nil nil #'notmuch-hello-search-continuation))
185 (defun notmuch-saved-search-count (search)
186 (car (process-lines notmuch-command "count" search)))
188 (defun notmuch-hello-tags-per-line (widest)
189 "Determine how many tags to show per line and how wide they
190 should be. Returns a cons cell `(tags-per-line width)'."
193 ((integerp notmuch-column-control)
195 (/ (- (window-width) notmuch-hello-indent)
196 ;; Count is 9 wide (8 digits plus space), 1 for the space
198 (+ 9 1 (max notmuch-column-control widest)))))
200 ((floatp notmuch-column-control)
201 (let* ((available-width (- (window-width) notmuch-hello-indent))
202 (proposed-width (max (* available-width notmuch-column-control) widest)))
203 (floor available-width proposed-width)))
207 (/ (- (window-width) notmuch-hello-indent)
208 ;; Count is 9 wide (8 digits plus space), 1 for the space
212 (cons tags-per-line (/ (- (window-width) notmuch-hello-indent
213 ;; Count is 9 wide (8 digits plus
214 ;; space), 1 for the space after the
216 (* tags-per-line (+ 9 1)))
219 (defun notmuch-hello-insert-tags (tag-alist widest target)
220 (let* ((tags-and-width (notmuch-hello-tags-per-line widest))
221 (tags-per-line (car tags-and-width))
222 (widest (cdr tags-and-width))
224 (reordered-list (notmuch-hello-reflect tag-alist tags-per-line))
225 ;; Hack the display of the buttons used.
226 (widget-push-button-prefix "")
227 (widget-push-button-suffix "")
228 (found-target-pos nil))
229 ;; dme: It feels as though there should be a better way to
230 ;; implement this loop than using an incrementing counter.
232 ;; (not elem) indicates an empty slot in the matrix.
234 (let* ((name (car elem))
236 (formatted-name (format "%s " name)))
237 (widget-insert (format "%8s "
238 (notmuch-hello-nice-number
239 (string-to-number (notmuch-saved-search-count query)))))
240 (if (string= formatted-name target)
241 (setq found-target-pos (point-marker)))
242 (widget-create 'push-button
243 :notify #'notmuch-hello-widget-search
244 :notmuch-search-terms query
246 ;; Insert enough space to consume the rest of the
247 ;; column. Because the button for the name is `(1+
248 ;; (length name))' long (due to the trailing space) we
249 ;; can just insert `(- widest (length name))' spaces -
250 ;; the column separator is included in the button if
251 ;; `(equal widest (length name)'.
252 (widget-insert (make-string (- widest (length name)) ? ))))
253 (setq count (1+ count))
254 (if (eq (% count tags-per-line) 0)
255 (widget-insert "\n")))
258 ;; If the last line was not full (and hence did not include a
259 ;; carriage return), insert one now.
260 (if (not (eq (% count tags-per-line) 0))
261 (widget-insert "\n"))
264 (defun notmuch-hello-goto-search ()
265 "Put point inside the `search' widget."
267 (goto-char notmuch-hello-search-bar-marker))
269 (defimage notmuch-hello-logo ((:type png :file "notmuch-logo.png")))
271 (defun notmuch-hello-search-continuation()
272 (notmuch-hello-update t))
274 (defun notmuch-hello-update (&optional no-display)
275 "Update the current notmuch view."
276 ;; Lazy - rebuild everything.
278 (notmuch-hello no-display))
280 (defun notmuch-hello-poll-and-update ()
281 "Invoke `notmuch-poll' to import mail, then refresh the current view."
284 (notmuch-hello-update))
287 (defvar notmuch-hello-mode-map
288 (let ((map (make-sparse-keymap)))
289 (set-keymap-parent map widget-keymap)
290 (define-key map "v" '(lambda () "Display the notmuch version" (interactive)
291 (message "notmuch version %s" (notmuch-version))))
292 (define-key map "?" 'notmuch-help)
293 (define-key map "q" 'kill-this-buffer)
294 (define-key map "=" 'notmuch-hello-update)
295 (define-key map "G" 'notmuch-hello-poll-and-update)
296 (define-key map (kbd "<C-tab>") 'widget-backward)
297 (define-key map "m" 'notmuch-mua-mail)
298 (define-key map "s" 'notmuch-hello-goto-search)
300 "Keymap for \"notmuch hello\" buffers.")
301 (fset 'notmuch-hello-mode-map notmuch-hello-mode-map)
303 (defun notmuch-hello-mode ()
304 "Major mode for convenient notmuch navigation. This is your entry portal into notmuch.
306 Complete list of currently available key bindings:
308 \\{notmuch-hello-mode-map}"
310 (kill-all-local-variables)
311 (use-local-map notmuch-hello-mode-map)
312 (setq major-mode 'notmuch-hello-mode
313 mode-name "notmuch-hello")
314 ;;(setq buffer-read-only t)
317 (defun notmuch-hello (&optional no-display)
320 ; Jump through a hoop to get this value from the deprecated variable
321 ; name (`notmuch-folders') or from the default value.
322 (if (not notmuch-saved-searches)
323 (setq notmuch-saved-searches (notmuch-saved-searches)))
326 (set-buffer "*notmuch-hello*")
327 (switch-to-buffer "*notmuch-hello*"))
329 (let ((target (if (widget-at)
330 (widget-value (widget-at))
334 (widget-value (widget-at)))
337 (kill-all-local-variables)
338 (let ((inhibit-read-only t))
341 (unless (eq major-mode 'notmuch-hello-mode)
342 (notmuch-hello-mode))
344 (let ((all (overlay-lists)))
345 ;; Delete all the overlays.
346 (mapc 'delete-overlay (car all))
347 (mapc 'delete-overlay (cdr all)))
349 (when notmuch-show-logo
350 (let ((image notmuch-hello-logo))
351 ;; The notmuch logo uses transparency. That can display poorly
352 ;; when inserting the image into an emacs buffer (black logo on
353 ;; a black background), so force the background colour of the
354 ;; image. We use a face to represent the colour so that
355 ;; `defface' can be used to declare the different possible
356 ;; colours, which depend on whether the frame has a light or
358 (setq image (cons 'image
360 (list :background (face-background 'notmuch-hello-logo-background)))))
361 (insert-image image))
364 (widget-insert "Welcome to ")
365 ;; Hack the display of the links used.
366 (let ((widget-link-prefix "")
367 (widget-link-suffix ""))
369 :notify (lambda (&rest ignore)
370 (browse-url notmuch-hello-url))
371 :help-echo "Visit the notmuch website."
374 (widget-insert "You have ")
376 :notify (lambda (&rest ignore)
377 (notmuch-hello-update))
379 (notmuch-hello-nice-number
380 (string-to-number (car (process-lines notmuch-command "count")))))
381 (widget-insert " messages (that's not much mail).\n"))
383 (let ((found-target-pos nil)
384 (final-target-pos nil))
386 ;; Filter out empty saved seaches if required.
387 (if notmuch-show-empty-saved-searches
388 notmuch-saved-searches
389 (loop for elem in notmuch-saved-searches
390 if (> (string-to-number (notmuch-saved-search-count (cdr elem))) 0)
392 (saved-widest (notmuch-hello-longest-label saved-alist))
393 (alltags-alist (if notmuch-show-all-tags-list
394 (mapcar '(lambda (tag) (cons tag (concat "tag:" tag)))
395 (process-lines notmuch-command "search-tags"))))
396 (alltags-widest (notmuch-hello-longest-label alltags-alist))
397 (widest (max saved-widest alltags-widest)))
400 (widget-insert "\nSaved searches: ")
401 (widget-create 'push-button
402 :notify (lambda (&rest ignore)
403 (customize-variable 'notmuch-saved-searches))
405 (widget-insert "\n\n")
406 (setq final-target-pos (point-marker))
407 (let ((start (point)))
408 (setq found-target-pos (notmuch-hello-insert-tags saved-alist widest target))
410 (setq final-target-pos found-target-pos))
411 (indent-rigidly start (point) notmuch-hello-indent)))
413 (widget-insert "\nSearch: ")
414 (setq notmuch-hello-search-bar-marker (point-marker))
415 (widget-create 'editable-field
416 ;; Leave some space at the start and end of the
418 :size (max 8 (- (window-width) notmuch-hello-indent
419 (length "Search: ")))
420 :action (lambda (widget &rest ignore)
421 (notmuch-hello-search (widget-value widget))))
424 (when notmuch-hello-recent-searches
425 (widget-insert "\nRecent searches: ")
426 (widget-create 'push-button
427 :notify (lambda (&rest ignore)
428 (setq notmuch-hello-recent-searches nil)
429 (notmuch-hello-update))
431 (widget-insert "\n\n")
432 (let ((start (point))
434 (mapc '(lambda (search)
435 (let ((widget-symbol (intern (format "notmuch-hello-search-%d" nth))))
437 (widget-create 'editable-field
438 ;; Don't let the search boxes be
439 ;; less than 8 characters wide.
446 (* 2 notmuch-hello-indent)
449 ;; `[save]' button. 6
453 :action (lambda (widget &rest ignore)
454 (notmuch-hello-search (widget-value widget)))
457 (widget-create 'push-button
458 :notify (lambda (widget &rest ignore)
459 (notmuch-hello-add-saved-search widget))
460 :notmuch-saved-search-widget widget-symbol
464 notmuch-hello-recent-searches)
465 (indent-rigidly start (point) notmuch-hello-indent)))
468 (widget-insert "\nAll tags: ")
469 (widget-create 'push-button
470 :notify (lambda (widget &rest ignore)
471 (setq notmuch-show-all-tags-list nil)
472 (notmuch-hello-update))
474 (widget-insert "\n\n")
475 (let ((start (point)))
476 (setq found-target-pos (notmuch-hello-insert-tags alltags-alist widest target))
477 (if (not final-target-pos)
478 (setq final-target-pos found-target-pos))
479 (indent-rigidly start (point) notmuch-hello-indent)))
483 (if (not notmuch-show-all-tags-list)
484 (widget-create 'push-button
485 :notify (lambda (widget &rest ignore)
486 (setq notmuch-show-all-tags-list t)
487 (notmuch-hello-update))
490 (let ((start (point)))
491 (widget-insert "\n\n")
492 (widget-insert "Type a search query and hit RET to view matching threads.\n")
493 (when notmuch-hello-recent-searches
494 (widget-insert "Hit RET to re-submit a previous search. Edit it first if you like.\n")
495 (widget-insert "Save recent searches with the `save' button.\n"))
496 (when notmuch-saved-searches
497 (widget-insert "Edit saved searches with the `edit' button.\n"))
498 (widget-insert "Hit RET or click on a saved search or tag name to view matching threads.\n")
499 (widget-insert "`=' refreshes this screen. `s' jumps to the search box. `q' to quit.\n")
500 (let ((fill-column (- (window-width) notmuch-hello-indent)))
501 (center-region start (point))))
505 (when final-target-pos
506 (goto-char final-target-pos)
511 (notmuch-hello-goto-search)))))
514 (defun notmuch-folder ()
515 "Deprecated function for invoking notmuch---calling `notmuch' is preferred now."
521 (provide 'notmuch-hello)