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>.
41 ;; For Emacs <22.2 and XEmacs.
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 (defcustom gnus-picon-inhibit-top-level-domains t
89 "If non-nil, don't piconify top-level domains.
90 These are often not very interesting."
94 ;;; Internal variables:
96 (defvar gnus-picon-glyph-alist nil
98 List of pairs (KEY . GLYPH) where KEY is either a filename or an URL.")
99 (defvar gnus-picon-cache nil)
103 (defsubst gnus-picon-split-address (address)
104 (setq address (split-string address "@"))
105 (if (stringp (cadr address))
106 (cons (car address) (split-string (cadr address) "\\."))
107 (if (stringp (car address))
108 (split-string (car address) "\\."))))
110 (defun gnus-picon-find-face (address directories &optional exact)
111 (let* ((address (gnus-picon-split-address address))
114 database directory result instance base)
116 (dolist (database gnus-picon-databases)
117 (dolist (directory directories)
118 (setq address faddress
119 base (expand-file-name directory database))
121 (when (setq result (gnus-picon-find-image
122 (concat base "/" (mapconcat 'downcase
125 "/" (downcase user) "/")))
126 (throw 'found result))
130 ;; Kludge to search MISC as well. But not in "news".
131 (unless (string= directory "news")
132 (when (setq result (gnus-picon-find-image
133 (concat base "/MISC/" user "/")))
134 (throw 'found result))))))))
136 (defun gnus-picon-find-image (directory)
137 (let ((types gnus-picon-file-types)
139 (while (and (not found)
140 (setq type (pop types)))
141 (setq found (file-exists-p (setq file (concat directory "face." type)))))
146 (defun gnus-picon-insert-glyph (glyph category &optional nostring)
147 "Insert GLYPH into the buffer.
148 GLYPH can be either a glyph or a string. When NOSTRING, no textual
149 replacement is added."
150 ;; Using NOSTRING prevents wrong BBDB entries with `gnus-picon-style' set to
154 (gnus-add-wash-type category)
155 (gnus-add-image category (car glyph))
156 (gnus-put-image (car glyph) (unless nostring (cdr glyph)) category)))
158 (defun gnus-picon-create-glyph (file)
159 (or (cdr (assoc file gnus-picon-glyph-alist))
160 (cdar (push (cons file (gnus-create-image
162 :color-symbols '(("None" . "white"))))
163 gnus-picon-glyph-alist))))
165 ;;; Functions that does picon transformations:
167 (declare-function image-size "image.c" (spec &optional pixels frame))
169 (defun gnus-picon-transform-address (header category)
170 (gnus-with-article-headers
172 (mail-header-parse-addresses
173 ;; mail-header-parse-addresses does not work (reliably) on