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 (/ (max 1
213 (- (window-width) notmuch-hello-indent
214 ;; Count is 9 wide (8 digits plus
215 ;; space), 1 for the space after the
217 (* tags-per-line (+ 9 1))))
220 (defun notmuch-hello-insert-tags (tag-alist widest target)
221 (let* ((tags-and-width (notmuch-hello-tags-per-line widest))
222 (tags-per-line (car tags-and-width))
223 (widest (cdr tags-and-width))
225 (reordered-list (notmuch-hello-reflect tag-alist tags-per-line))
226 ;; Hack the display of the buttons used.
227 (widget-push-button-prefix "")
228 (widget-push-button-suffix "")
229 (found-target-pos nil))
230 ;; dme: It feels as though there should be a better way to
231 ;; implement this loop than using an incrementing counter.
233 ;; (not elem) indicates an empty slot in the matrix.
235 (let* ((name (car elem))
237 (formatted-name (format "%s " name)))
238 (widget-insert (format "%8s "
239 (notmuch-hello-nice-number
240 (string-to-number (notmuch-saved-search-count query)))))
241 (if (string= formatted-name target)
242 (setq found-target-pos (point-marker)))
243 (widget-create 'push-button
244 :notify #'notmuch-hello-widget-search
245 :notmuch-search-terms query
247 ;; Insert enough space to consume the rest of the
248 ;; column. Because the button for the name is `(1+
249 ;; (length name))' long (due to the trailing space) we
250 ;; can just insert `(- widest (length name))' spaces -
251 ;; the column separator is included in the button if
252 ;; `(equal widest (length name)'.
253 (widget-insert (make-string (max 1
254 (- widest (length name)))
256 (setq count (1+ count))
257 (if (eq (% count tags-per-line) 0)
258 (widget-insert "\n")))
261 ;; If the last line was not full (and hence did not include a
262 ;; carriage return), insert one now.
263 (if (not (eq (% count tags-per-line) 0))
264 (widget-insert "\n"))
267 (defun notmuch-hello-goto-search ()
268 "Put point inside the `search' widget."
270 (goto-char notmuch-hello-search-bar-marker))
272 (defimage notmuch-hello-logo ((:type png :file "notmuch-logo.png")))
274 (defun notmuch-hello-search-continuation()
275 (notmuch-hello-update t))
277 (defun notmuch-hello-update (&optional no-display)
278 "Update the current notmuch view."
279 ;; Lazy - rebuild everything.
281 (notmuch-hello no-display))
283 (defun notmuch-hello-poll-and-update ()
284 "Invoke `notmuch-poll' to import mail, then refresh the current view."
287 (notmuch-hello-update))
290 (defvar notmuch-hello-mode-map
291 (let ((map (make-sparse-keymap)))
292 (set-keymap-parent map widget-keymap)
293 (define-key map "v" '(lambda () "Display the notmuch version" (interactive)
294 (message "notmuch version %s" (notmuch-version))))
295 (define-key map "?" 'notmuch-help)
296 (define-key map "q" 'kill-this-buffer)
297 (define-key map "=" 'notmuch-hello-update)
298 (define-key map "G" 'notmuch-hello-poll-and-update)
299 (define-key map (kbd "<C-tab>") 'widget-backward)
300 (define-key map "m" 'notmuch-mua-mail)
301 (define-key map "s" 'notmuch-hello-goto-search)
303 "Keymap for \"notmuch hello\" buffers.")
304 (fset 'notmuch-hello-mode-map notmuch-hello-mode-map)
306 (defun notmuch-hello-mode ()
307 "Major mode for convenient notmuch navigation. This is your entry portal into notmuch.
309 Complete list of currently available key bindings:
311 \\{notmuch-hello-mode-map}"
313 (kill-all-local-variables)
314 (use-local-map notmuch-hello-mode-map)
315 (setq major-mode 'notmuch-hello-mode
316 mode-name "notmuch-hello")
317 ;;(setq buffer-read-only t)
320 (defun notmuch-hello (&optional no-display)
323 ; Jump through a hoop to get this value from the deprecated variable
324 ; name (`notmuch-folders') or from the default value.
325 (if (not notmuch-saved-searches)
326 (setq notmuch-saved-searches (notmuch-saved-searches)))
329 (set-buffer "*notmuch-hello*")
330 (switch-to-buffer "*notmuch-hello*"))
332 (let ((target (if (widget-at)
333 (widget-value (widget-at))
337 (widget-value (widget-at)))
340 (kill-all-local-variables)
341 (let ((inhibit-read-only t))
344 (unless (eq major-mode 'notmuch-hello-mode)
345 (notmuch-hello-mode))
347 (let ((all (overlay-lists)))
348 ;; Delete all the overlays.
349 (mapc 'delete-overlay (car all))
350 (mapc 'delete-overlay (cdr all)))
352 (when notmuch-show-logo
353 (let ((image notmuch-hello-logo))
354 ;; The notmuch logo uses transparency. That can display poorly
355 ;; when inserting the image into an emacs buffer (black logo on
356 ;; a black background), so force the background colour of the
357 ;; image. We use a face to represent the colour so that
358 ;; `defface' can be used to declare the different possible
359 ;; colours, which depend on whether the frame has a light or
361 (setq image (cons 'image
363 (list :background (face-background 'notmuch-hello-logo-background)))))
364 (insert-image image))
367 (widget-insert "Welcome to ")
368 ;; Hack the display of the links used.
369 (let ((widget-link-prefix "")
370 (widget-link-suffix ""))
372 :notify (lambda (&rest ignore)
373 (browse-url notmuch-hello-url))
374 :help-echo "Visit the notmuch website."
377 (widget-insert "You have ")
379 :notify (lambda (&rest ignore)
380 (notmuch-hello-update))
382 (notmuch-hello-nice-number
383 (string-to-number (car (process-lines notmuch-command "count")))))
384 (widget-insert " messages.\n"))
386 (let ((found-target-pos nil)
387 (final-target-pos nil))
389 ;; Filter out empty saved seaches if required.
390 (if notmuch-show-empty-saved-searches
391 notmuch-saved-searches
392 (loop for elem in notmuch-saved-searches
393 if (> (string-to-number (notmuch-saved-search-count (cdr elem))) 0)
395 (saved-widest (notmuch-hello-longest-label saved-alist))
396 (alltags-alist (if notmuch-show-all-tags-list
397 (mapcar '(lambda (tag) (cons tag (concat "tag:" tag)))
398 (process-lines notmuch-command "search-tags"))))
399 (alltags-widest (notmuch-hello-longest-label alltags-alist))
400 (widest (max saved-widest alltags-widest)))
403 (widget-insert "\nSaved searches: ")
404 (widget-create 'push-button
405 :notify (lambda (&rest ignore)
406 (customize-variable 'notmuch-saved-searches))
408 (widget-insert "\n\n")
409 (setq final-target-pos (point-marker))
410 (let ((start (point)))
411 (setq found-target-pos (notmuch-hello-insert-tags saved-alist widest target))
413 (setq final-target-pos found-target-pos))
414 (indent-rigidly start (point) notmuch-hello-indent)))
416 (widget-insert "\nSearch: ")
417 (setq notmuch-hello-search-bar-marker (point-marker))
418 (widget-create 'editable-field
419 ;; Leave some space at the start and end of the
421 :size (max 8 (- (window-width) notmuch-hello-indent
422 (length "Search: ")))
423 :action (lambda (widget &rest ignore)
424 (notmuch-hello-search (widget-value widget))))
427 (when notmuch-hello-recent-searches
428 (widget-insert "\nRecent searches: ")
429 (widget-create 'push-button
430 :notify (lambda (&rest ignore)
431 (setq notmuch-hello-recent-searches nil)
432 (notmuch-hello-update))
434 (widget-insert "\n\n")
435 (let ((start (point))
437 (mapc '(lambda (search)
438 (let ((widget-symbol (intern (format "notmuch-hello-search-%d" nth))))
440 (widget-create 'editable-field
441 ;; Don't let the search boxes be
442 ;; less than 8 characters wide.
449 (* 2 notmuch-hello-indent)
452 ;; `[save]' button. 6
456 :action (lambda (widget &rest ignore)
457 (notmuch-hello-search (widget-value widget)))
460 (widget-create 'push-button
461 :notify (lambda (widget &rest ignore)
462 (notmuch-hello-add-saved-search widget))
463 :notmuch-saved-search-widget widget-symbol
467 notmuch-hello-recent-searches)
468 (indent-rigidly start (point) notmuch-hello-indent)))
471 (widget-insert "\nAll tags: ")
472 (widget-create 'push-button
473 :notify (lambda (widget &rest ignore)
474 (setq notmuch-show-all-tags-list nil)
475 (notmuch-hello-update))
477 (widget-insert "\n\n")
478 (let ((start (point)))
479 (setq found-target-pos (notmuch-hello-insert-tags alltags-alist widest target))
480 (if (not final-target-pos)
481 (setq final-target-pos found-target-pos))
482 (indent-rigidly start (point) notmuch-hello-indent)))
486 (if (not notmuch-show-all-tags-list)
487 (widget-create 'push-button
488 :notify (lambda (widget &rest ignore)
489 (setq notmuch-show-all-tags-list t)
490 (notmuch-hello-update))
493 (let ((start (point)))
494 (widget-insert "\n\n")
495 (widget-insert "Type a search query and hit RET to view matching threads.\n")
496 (when notmuch-hello-recent-searches
497 (widget-insert "Hit RET to re-submit a previous search. Edit it first if you like.\n")
498 (widget-insert "Save recent searches with the `save' button.\n"))
499 (when notmuch-saved-searches
500 (widget-insert "Edit saved searches with the `edit' button.\n"))
501 (widget-insert "Hit RET or click on a saved search or tag name to view matching threads.\n")
502 (widget-insert "`=' refreshes this screen. `s' jumps to the search box. `q' to quit.\n")
503 (let ((fill-column (- (window-width) notmuch-hello-indent)))
504 (center-region start (point))))
508 (when final-target-pos
509 (goto-char final-target-pos)
514 (notmuch-hello-goto-search)))))
517 (defun notmuch-folder ()
518 "Deprecated function for invoking notmuch---calling `notmuch' is preferred now."
524 (provide 'notmuch-hello)