1 ;;; gnus-picon.el --- displaying pretty icons in Gnus
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005
4 ;; Free Software Foundation, Inc.
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: news xpm annotation glyph faces
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
28 ;; There are three picon types relevant to Gnus:
30 ;; Persons: person@subdomain.dom
31 ;; users/dom/subdomain/person/face.gif
32 ;; usenix/dom/subdomain/person/face.gif
33 ;; misc/MISC/person/face.gif
34 ;; Domains: subdomain.dom
35 ;; domain/dom/subdomain/unknown/face.gif
36 ;; Groups: comp.lang.lisp
37 ;; news/comp/lang/lisp/unknown/face.gif
39 ;; Original implementation by Wes Hardaker <hardaker@ece.ucdavis.edu>.
43 (eval-when-compile (require 'cl))
50 (defcustom gnus-picon-news-directories '("news")
51 "*List of directories to search for newsgroups faces."
52 :type '(repeat string)
55 (defcustom gnus-picon-user-directories '("users" "usenix" "local" "misc")
56 "*List of directories to search for user faces."
57 :type '(repeat string)
60 (defcustom gnus-picon-domain-directories '("domains")
61 "*List of directories to search for domain faces.
62 Some people may want to add \"unknown\" to this list."
63 :type '(repeat string)
66 (defcustom gnus-picon-file-types
67 (let ((types (list "xbm")))
68 (if (gnus-image-type-available-p 'gif)
69 (setq types (cons "gif" types)))
70 (if (gnus-image-type-available-p 'xpm)
71 (setq types (cons "xpm" types)))
73 "*List of suffixes on picon file names to try."
74 :type '(repeat string)
77 (defcustom gnus-picon-style 'inline
78 "How should picons be displayed.
79 If `inline', the textual representation is replaced. If `right', picons are
80 added right to the textual representation."
81 ;; FIXME: `right' needs improvement for XEmacs.
82 :type '(choice (const inline)
86 (defface gnus-picon-xbm '((t (:foreground "black" :background "white")))
87 "Face to show xbm picon in."
89 ;; backward-compatibility alias
90 (put 'gnus-picon-xbm-face 'face-alias 'gnus-picon-xbm)
92 (defface gnus-picon '((t (:foreground "black" :background "white")))
93 "Face to show picon in."
95 ;; backward-compatibility alias
96 (put 'gnus-picon-face 'face-alias 'gnus-picon)
98 ;;; Internal variables:
100 (defvar gnus-picon-setup-p nil)
101 (defvar gnus-picon-glyph-alist nil
103 List of pairs (KEY . GLYPH) where KEY is either a filename or an URL.")
104 (defvar gnus-picon-cache nil)
108 (defsubst gnus-picon-split-address (address)
109 (setq address (split-string address "@"))
110 (if (stringp (cadr address))
111 (cons (car address) (split-string (cadr address) "\\."))
112 (if (stringp (car address))
113 (split-string (car address) "\\."))))
115 (defun gnus-picon-find-face (address directories &optional exact)
116 (let* ((address (gnus-picon-split-address address))
119 database directory result instance base)
121 (dolist (database gnus-picon-databases)
122 (dolist (directory directories)
123 (setq address faddress
124 base (expand-file-name directory database))
126 (when (setq result (gnus-picon-find-image
127 (concat base "/" (mapconcat 'downcase
130 "/" (downcase user) "/")))
131 (throw 'found result))
135 ;; Kludge to search MISC as well. But not in "news".
136 (unless (string= directory "news")
137 (when (setq result (gnus-picon-find-image
138 (concat base "/MISC/" user "/")))
139 (throw 'found result))))))))
141 (defun gnus-picon-find-image (directory)
142 (let ((types gnus-picon-file-types)
144 (while (and (not found)
145 (setq type (pop types)))
146 (setq found (file-exists-p (setq file (concat directory "face." type)))))
151 (defun gnus-picon-insert-glyph (glyph category &optional nostring)
152 "Insert GLYPH into the buffer.
153 GLYPH can be either a glyph or a string. When NOSTRING, no textual
154 replacement is added."
155 ;; Using NOSTRING prevents wrong BBDB entries with `gnus-picon-style' set to
159 (gnus-add-wash-type category)
160 (gnus-add-image category (car glyph))
161 (gnus-put-image (car glyph) (unless nostring (cdr glyph)) category)))
163 (defun gnus-picon-create-glyph (file)
164 (or (cdr (assoc file gnus-picon-glyph-alist))
165 (cdar (push (cons file (gnus-create-image file))
166 gnus-picon-glyph-alist))))
168 ;;; Functions that does picon transformations:
170 (defun gnus-picon-transform-address (header category)
171 (gnus-with-article-headers
173 (mail-header-parse-addresses
174 ;; mail-header-parse-addresses does not work (reliably) on
178 (mail-encode-encoded-word-string
179 (or (mail-fetch-field header) "")))
180 (mail-fetch-field header))))
181 spec file point cache len)
182 (dolist (address addresses)
183 (setq address (car address))
184 (when (and (stringp address)
185 (setq spec (gnus-picon-split-address address)))
186 (if (setq cache (cdr (assoc address gnus-picon-cache)))
188 (when (setq file (or (gnus-picon-find-face
189 address gnus-picon-user-directories)
190 (gnus-picon-find-face
193 'identity (cdr spec) "."))
194 gnus-picon-user-directories)))
195 (setcar spec (cons (gnus-picon-create-glyph file)
198 (dotimes (i (1- (length spec)))
199 (when (setq file (gnus-picon-find-face
202 'identity (nthcdr (1+ i) spec) "."))
203 gnus-picon-domain-directories t))
204 (setcar (nthcdr (1+ i) spec)
205 (cons (gnus-picon-create-glyph file)
206 (nth (1+ i) spec)))))
207 (setq spec (nreverse spec))
208 (push (cons address spec) gnus-picon-cache))
210 (gnus-article-goto-header header)
211 (mail-header-narrow-to-field)
212 (case gnus-picon-style
214 (when (= (length addresses) 1)
215 (setq len (apply '+ (mapcar (lambda (x)
217 (car (image-size (car x)))
220 (goto-char (point-at-eol))
224 (list :align-to (- (window-width) 1 len))))))
225 (goto-char (point-at-eol))
226 (setq point (point-at-eol))
228 (unless (stringp image)
230 (gnus-picon-insert-glyph image category 'nostring)))))
232 (when (search-forward address nil t)
233 (delete-region (match-beginning 0) (match-end 0))
237 (if (> (length spec) 2)
239 (if (= (length spec) 2)
241 (gnus-picon-insert-glyph (pop spec) category))))))))))
243 (defun gnus-picon-transform-newsgroups (header)
245 (gnus-with-article-headers
246 (gnus-article-goto-header header)
247 (mail-header-narrow-to-field)
248 (let ((groups (message-tokenize-header (mail-fetch-field header)))
250 (dolist (group groups)
251 (unless (setq spec (cdr (assoc group gnus-picon-cache)))
252 (setq spec (nreverse (split-string group "[.]")))
253 (dotimes (i (length spec))
254 (when (setq file (gnus-picon-find-face
257 'identity (nthcdr i spec) "."))
258 gnus-picon-news-directories t))
259 (setcar (nthcdr i spec)
260 (cons (gnus-picon-create-glyph file)
262 (push (cons group spec) gnus-picon-cache))
263 (when (search-forward group nil t)
264 (delete-region (match-beginning 0) (match-end 0))
266 (narrow-to-region (point) (point))
268 (goto-char (point-min))
269 (if (> (length spec) 1)
271 (gnus-picon-insert-glyph (pop spec) 'newsgroups-picon))
272 (goto-char (point-max))))))))
276 ;; #### NOTE: the test for buffer-read-only is the same as in
277 ;; article-display-[x-]face. See the comment up there.
280 (defun gnus-treat-from-picon ()
281 "Display picons in the From header.
282 If picons are already displayed, remove them."
284 (let ((wash-picon-p buffer-read-only))
285 (gnus-with-article-buffer
286 (if (and wash-picon-p (memq 'from-picon gnus-article-wash-types))
287 (gnus-delete-images 'from-picon)
288 (gnus-picon-transform-address "from" 'from-picon)))))
291 (defun gnus-treat-mail-picon ()
292 "Display picons in the Cc and To headers.
293 If picons are already displayed, remove them."
295 (let ((wash-picon-p buffer-read-only))
296 (gnus-with-article-buffer
297 (if (and wash-picon-p (memq 'mail-picon gnus-article-wash-types))
298 (gnus-delete-images 'mail-picon)
299 (gnus-picon-transform-address "cc" 'mail-picon)
300 (gnus-picon-transform-address "to" 'mail-picon)))))
303 (defun gnus-treat-newsgroups-picon ()
304 "Display picons in the Newsgroups and Followup-To headers.
305 If picons are already displayed, remove them."
307 (let ((wash-picon-p buffer-read-only))
308 (gnus-with-article-buffer
309 (if (and wash-picon-p (memq 'newsgroups-picon gnus-article-wash-types))
310 (gnus-delete-images 'newsgroups-picon)
311 (gnus-picon-transform-newsgroups "newsgroups")
312 (gnus-picon-transform-newsgroups "followup-to")))))
314 (provide 'gnus-picon)
316 ;;; gnus-picon.el ends here