1 ;;; gnus-picon.el --- displaying pretty icons in Gnus
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009, 2010 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 3 of the License, or
14 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
26 ;; There are three picon types relevant to Gnus:
28 ;; Persons: person@subdomain.dom
29 ;; users/dom/subdomain/person/face.gif
30 ;; usenix/dom/subdomain/person/face.gif
31 ;; misc/MISC/person/face.gif
32 ;; Domains: subdomain.dom
33 ;; domain/dom/subdomain/unknown/face.gif
34 ;; Groups: comp.lang.lisp
35 ;; news/comp/lang/lisp/unknown/face.gif
37 ;; Original implementation by Wes Hardaker <hardaker@ece.ucdavis.edu>.
43 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
45 (eval-when-compile (require 'cl))
52 (defcustom gnus-picon-news-directories '("news")
53 "*List of directories to search for newsgroups faces."
54 :type '(repeat string)
57 (defcustom gnus-picon-user-directories '("users" "usenix" "local" "misc")
58 "*List of directories to search for user faces."
59 :type '(repeat string)
62 (defcustom gnus-picon-domain-directories '("domains")
63 "*List of directories to search for domain faces.
64 Some people may want to add \"unknown\" to this list."
65 :type '(repeat string)
68 (defcustom gnus-picon-file-types
69 (let ((types (list "xbm")))
70 (when (gnus-image-type-available-p 'gif)
72 (when (gnus-image-type-available-p 'xpm)
75 "*List of suffixes on picon file names to try."
76 :type '(repeat string)
79 (defcustom gnus-picon-style 'inline
80 "How should picons be displayed.
81 If `inline', the textual representation is replaced. If `right', picons are
82 added right to the textual representation."
83 ;; FIXME: `right' needs improvement for XEmacs.
84 :type '(choice (const inline)
88 (defface gnus-picon '((t (:foreground "black" :background "white")))
89 "Face to show picon in."
92 ;;; Internal variables:
94 (defvar gnus-picon-glyph-alist nil
96 List of pairs (KEY . GLYPH) where KEY is either a filename or an URL.")
97 (defvar gnus-picon-cache nil)
101 (defsubst gnus-picon-split-address (address)
102 (setq address (split-string address "@"))
103 (if (stringp (cadr address))
104 (cons (car address) (split-string (cadr address) "\\."))
105 (if (stringp (car address))
106 (split-string (car address) "\\."))))
108 (defun gnus-picon-find-face (address directories &optional exact)
109 (let* ((address (gnus-picon-split-address address))
112 database directory result instance base)
114 (dolist (database gnus-picon-databases)
115 (dolist (directory directories)
116 (setq address faddress
117 base (expand-file-name directory database))
119 (when (setq result (gnus-picon-find-image
120 (concat base "/" (mapconcat 'downcase
123 "/" (downcase user) "/")))
124 (throw 'found result))
128 ;; Kludge to search MISC as well. But not in "news".
129 (unless (string= directory "news")
130 (when (setq result (gnus-picon-find-image
131 (concat base "/MISC/" user "/")))
132 (throw 'found result))))))))
134 (defun gnus-picon-find-image (directory)
135 (let ((types gnus-picon-file-types)
137 (while (and (not found)
138 (setq type (pop types)))
139 (setq found (file-exists-p (setq file (concat directory "face." type)))))
144 (defun gnus-picon-insert-glyph (glyph category &optional nostring)
145 "Insert GLYPH into the buffer.
146 GLYPH can be either a glyph or a string. When NOSTRING, no textual
147 replacement is added."
148 ;; Using NOSTRING prevents wrong BBDB entries with `gnus-picon-style' set to
152 (gnus-add-wash-type category)
153 (gnus-add-image category (car glyph))
154 (let ((start (point)))
155 (gnus-put-image (car glyph) (unless nostring (cdr glyph)) category)
156 (put-text-property start (point) 'face 'gnus-picon))))
158 (defun gnus-picon-create-glyph (file)
159 (or (cdr (assoc file gnus-picon-glyph-alist))
160 (cdar (push (cons file (gnus-create-image file))
161 gnus-picon-glyph-alist))))
163 ;;; Functions that does picon transformations:
165 (declare-function image-size "image.c" (spec &optional pixels frame))
167 (defun gnus-picon-transform-address (header category)
168 (gnus-with-article-headers
170 (mail-header-parse-addresses
171 ;; mail-header-parse-addresses does not work (reliably) on
175 (mail-encode-encoded-word-string
176 (or (mail-fetch-field header) "")))
177 (mail-fetch-field header))))
178 spec file point cache len)
179 (dolist (address addresses)
180 (setq address (car address))
181 (when (and (stringp address)
182 (setq spec (gnus-picon-split-address address)))
183 (if (setq cache (cdr (assoc address gnus-picon-cache)))
185 (when (setq file (or (gnus-picon-find-face
186 address gnus-picon-user-directories)
187 (gnus-picon-find-face
190 'identity (cdr spec) "."))
191 gnus-picon-user-directories)))
192 (setcar spec (cons (gnus-picon-create-glyph file)
195 (dotimes (i (1- (length spec)))
196 (when (setq file (gnus-picon-find-face
199 'identity (nthcdr (1+ i) spec) "."))
200 gnus-picon-domain-directories t))
201 (setcar (nthcdr (1+ i) spec)
202 (cons (gnus-picon-create-glyph file)
203 (nth (1+ i) spec)))))
204 (setq spec (nreverse spec))
205 (push (cons address spec) gnus-picon-cache))
207 (gnus-article-goto-header header)
208 (mail-header-narrow-to-field)
209 (case gnus-picon-style
211 (when (= (length addresses) 1)
212 (setq len (apply '+ (mapcar (lambda (x)
214 (car (image-size (car x)))
217 (goto-char (point-at-eol))
221 (list :align-to (- (window-width) 1 len))))))
222 (goto-char (point-at-eol))
223 (setq point (point-at-eol))
225 (unless (stringp image)
227 (gnus-picon-insert-glyph image category 'nostring)))))
229 (when (search-forward address nil t)
230 (delete-region (match-beginning 0) (match-end 0))
234 (if (> (length spec) 2)
236 (if (= (length spec) 2)
238 (gnus-picon-insert-glyph (pop spec) category))))))))))
240 (defun gnus-picon-transform-newsgroups (header)
242 (gnus-with-article-headers
243 (gnus-article-goto-header header)
244 (mail-header-narrow-to-field)
245 (let ((groups (message-tokenize-header (mail-fetch-field header)))
247 (dolist (group groups)
248 (unless (setq spec (cdr (assoc group gnus-picon-cache)))
249 (setq spec (nreverse (split-string group "[.]")))
250 (dotimes (i (length spec))
251 (when (setq file (gnus-picon-find-face
254 'identity (nthcdr i spec) "."))
255 gnus-picon-news-directories t))
256 (setcar (nthcdr i spec)
257 (cons (gnus-picon-create-glyph file)
259 (push (cons group spec) gnus-picon-cache))
260 (when (search-forward group nil t)
261 (delete-region (match-beginning 0) (match-end 0))
263 (narrow-to-region (point) (point))
265 (goto-char (point-min))
266 (if (> (length spec) 1)
268 (gnus-picon-insert-glyph (pop spec) 'newsgroups-picon))
269 (goto-char (point-max))))))))
273 ;; #### NOTE: the test for buffer-read-only is the same as in
274 ;; article-display-[x-]face. See the comment up there.
277 (defun gnus-treat-from-picon ()
278 "Display picons in the From header.
279 If picons are already displayed, remove them."
281 (let ((wash-picon-p buffer-read-only))
282 (gnus-with-article-buffer
283 (if (and wash-picon-p (memq 'from-picon gnus-article-wash-types))
284 (gnus-delete-images 'from-picon)
285 (gnus-picon-transform-address "from" 'from-picon)))))
288 (defun gnus-treat-mail-picon ()
289 "Display picons in the Cc and To headers.
290 If picons are already displayed, remove them."
292 (let ((wash-picon-p buffer-read-only))
293 (gnus-with-article-buffer
294 (if (and wash-picon-p (memq 'mail-picon gnus-article-wash-types))
295 (gnus-delete-images 'mail-picon)
296 (gnus-picon-transform-address "cc" 'mail-picon)
297 (gnus-picon-transform-address "to" 'mail-picon)))))
300 (defun gnus-treat-newsgroups-picon ()
301 "Display picons in the Newsgroups and Followup-To headers.
302 If picons are already displayed, remove them."
304 (let ((wash-picon-p buffer-read-only))
305 (gnus-with-article-buffer
306 (if (and wash-picon-p (memq 'newsgroups-picon gnus-article-wash-types))
307 (gnus-delete-images 'newsgroups-picon)
308 (gnus-picon-transform-newsgroups "newsgroups")
309 (gnus-picon-transform-newsgroups "followup-to")))))
311 (provide 'gnus-picon)
313 ;;; gnus-picon.el ends here