1 ;;; gnus-picon.el --- displaying pretty icons in Gnus
2 ;; Copyright (C) 1996 Free Software Foundation, Inc.
4 ;; Author: Wes Hardaker <hardaker@ece.ucdavis.edu>
5 ;; Keywords: news xpm annotation glyph faces
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
27 ;; - You must have XEmacs (19.12 or above I think) to use this.
28 ;; - Read the variable descriptions below.
32 ;; 1) display the icons in its own buffer:
34 ;; (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
35 ;; (add-hook 'gnus-summary-prepare-hook 'gnus-group-display-picons t)
36 ;; (setq gnus-picons-display-where 'picons)
38 ;; Then add the picons buffer to your display configuration:
39 ;; The picons buffer needs to be at least 48 pixels high,
40 ;; which for me is 5 lines:
42 ;; (gnus-add-configuration
43 ;; '(article (vertical 1.0
46 ;; (summary .25 point)
49 ;; (gnus-add-configuration
50 ;; '(summary (vertical 1.0 (group 6)
52 ;; (summary 1.0 point))))
54 ;; 2) display the icons in the summary buffer
56 ;; (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
57 ;; (add-hook 'gnus-summary-prepare-hook 'gnus-group-display-picons t)
58 ;; (setq gnus-picons-display-where 'summary)
60 ;; 3) display the icons in the article buffer
62 ;; (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
63 ;; (add-hook 'gnus-article-prepare-hook 'gnus-group-display-picons t)
64 ;; (setq gnus-picons-display-where 'article)
68 ;; - I'm not even close to being a lisp expert.
69 ;; - The 't' (append) flag MUST be in the add-hook line
72 ;; - Remove the TODO section in the headers.
78 (require 'annotations)
79 (eval-when-compile (require 'cl))
81 (defvar gnus-picons-buffer "*Icon Buffer*"
82 "Buffer name to display the icons in if gnus-picons-display-where is 'picons.")
84 (defvar gnus-picons-display-where 'picons
85 "Where to display the group and article icons.")
87 (defvar gnus-picons-database "/usr/local/faces"
88 "Defines the location of the faces database.
89 For information on obtaining this database of pretty pictures, please
90 see http://www.cs.indiana.edu/picons/ftp/index.html" )
92 (defvar gnus-picons-news-directory "news"
93 "Sub-directory of the faces database containing the icons for newsgroups."
96 (defvar gnus-picons-user-directories '("local" "users" "usenix" "misc/MISC")
97 "List of directories to search for user faces."
100 (defvar gnus-picons-domain-directories '("domains")
101 "List of directories to search for domain faces.
102 Some people may want to add \"unknown\" to this list."
105 (defvar gnus-picons-x-face-file-name
106 (format "/tmp/picon-xface.%s.xbm" (user-login-name))
107 "The name of the file in which to store the converted X-face header.")
109 (defvar gnus-picons-convert-x-face (format "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | pbmtoxbm > %s" gnus-picons-x-face-file-name)
110 "Command to convert the x-face header into a xbm file."
113 (defvar gnus-picons-file-suffixes
115 (let ((types (list "xbm")))
116 (when (featurep 'gif)
118 (when (featurep 'xpm)
121 "List of suffixes on picon file names to try.")
123 (defvar gnus-picons-display-article-move-p t
124 "*Whether to move point to first empty line when displaying picons.
125 This has only an effect if `gnus-picons-display-where' hs value article.")
127 ;;; Internal variables.
129 (defvar gnus-group-annotations nil)
130 (defvar gnus-article-annotations nil)
131 (defvar gnus-x-face-annotations nil)
133 (defun gnus-picons-remove (plist)
134 (let ((listitem (car plist)))
135 (while (setq listitem (car plist))
136 (if (annotationp listitem)
137 (delete-annotation listitem))
138 (setq plist (cdr plist))))
141 (defun gnus-picons-remove-all ()
142 "Removes all picons from the Gnus display(s)."
144 (gnus-picons-remove gnus-article-annotations)
145 (gnus-picons-remove gnus-group-annotations)
146 (gnus-picons-remove gnus-x-face-annotations)
147 (setq gnus-article-annotations nil
148 gnus-group-annotations nil
149 gnus-x-face-annotations nil)
150 (if (bufferp gnus-picons-buffer)
151 (kill-buffer gnus-picons-buffer))
154 (defun gnus-get-buffer-name (variable)
155 "Returns the buffer name associated with the contents of a variable."
156 (cond ((symbolp variable)
157 (let ((newvar (cdr (assq variable gnus-window-to-buffer))))
158 (cond ((symbolp newvar)
159 (symbol-value newvar))
160 ((stringp newvar) newvar))))
164 (defun gnus-picons-article-display-x-face ()
165 "Display the x-face header bitmap in the 'gnus-picons-display-where buffer."
166 ;; delete any old ones.
167 (gnus-picons-remove gnus-x-face-annotations)
168 (setq gnus-x-face-annotations nil)
169 ;; display the new one.
170 (let ((gnus-article-x-face-command 'gnus-picons-display-x-face))
171 (gnus-article-display-x-face)))
173 (defun gnus-picons-display-x-face (beg end)
174 "Function to display the x-face header in the picons window.
175 To use: (setq gnus-article-x-face-command 'gnus-picons-display-x-face)"
177 ;; convert the x-face header to a .xbm file
178 (let ((process-connection-type nil)
180 (process-kill-without-query
181 (setq process (start-process
182 "gnus-x-face" nil shell-file-name shell-command-switch
183 gnus-picons-convert-x-face)))
184 (process-send-region "gnus-x-face" beg end)
185 (process-send-eof "gnus-x-face")
187 (while (not (equal (process-status process) 'exit))
191 (set-buffer (get-buffer-create (gnus-get-buffer-name
192 gnus-picons-display-where)))
193 (gnus-add-current-to-buffer-list)
194 (goto-char (point-min))
195 (let (buffer-read-only)
197 (push (make-annotation "\n" (point) 'text)
198 gnus-x-face-annotations))
199 ;; append the annotation to gnus-article-annotations for deletion.
200 (setq gnus-x-face-annotations
202 (gnus-picons-try-to-find-face gnus-picons-x-face-file-name t)
203 gnus-x-face-annotations)))
204 ;; delete the tmp file
205 (delete-file gnus-picons-x-face-file-name)))
207 (defun gnus-article-display-picons ()
208 "Display faces for an author and his/her domain in gnus-picons-display-where."
210 (let (from at-idx databases)
211 (when (and (featurep 'xpm)
212 (or (not (fboundp 'device-type)) (equal (device-type) 'x))
213 (setq from (mail-fetch-field "from"))
214 (setq from (downcase (or (cadr (mail-extract-address-components
217 at-idx (string-match "@" from)))
219 (let ((username (substring from 0 at-idx))
221 (message-tokenize-header (substring from (1+ at-idx))
223 (set-buffer (get-buffer-create
224 (gnus-get-buffer-name gnus-picons-display-where)))
225 (gnus-add-current-to-buffer-list)
226 (goto-char (point-min))
227 (if (and (eq gnus-picons-display-where 'article)
228 gnus-picons-display-article-move-p)
229 (when (search-forward "\n\n" nil t)
232 (push (make-annotation "\n" (point) 'text)
233 gnus-article-annotations)))
235 (gnus-picons-remove gnus-article-annotations)
236 (setq gnus-article-annotations nil)
238 (setq databases (append gnus-picons-user-directories
239 gnus-picons-domain-directories))
241 (setq gnus-article-annotations
242 (nconc (gnus-picons-insert-face-if-exists
246 (gnus-picons-insert-face-if-exists
249 (downcase username) t)
250 gnus-article-annotations))
251 (setq databases (cdr databases)))
252 (add-hook 'gnus-summary-exit-hook 'gnus-picons-remove-all))))))
254 (defun gnus-group-display-picons ()
255 "Display icons for the group in the gnus-picons-display-where buffer."
257 (when (and (featurep 'xpm)
258 (or (not (fboundp 'device-type)) (equal (device-type) 'x)))
260 (set-buffer (get-buffer-create
261 (gnus-get-buffer-name gnus-picons-display-where)))
262 (gnus-add-current-to-buffer-list)
263 (goto-char (point-min))
264 (if (and (eq gnus-picons-display-where 'article)
265 gnus-picons-display-article-move-p)
266 (if (search-forward "\n\n" nil t)
269 (push (make-annotation "\n" (point) 'text)
270 gnus-group-annotations)))
272 ((listp gnus-group-annotations)
273 (mapcar 'delete-annotation gnus-group-annotations)
274 (setq gnus-group-annotations nil))
275 ((annotationp gnus-group-annotations)
276 (delete-annotation gnus-group-annotations)
277 (setq gnus-group-annotations nil)))
278 (gnus-picons-remove gnus-group-annotations)
279 (setq gnus-group-annotations
280 (gnus-picons-insert-face-if-exists
281 gnus-picons-news-directory
282 (message-tokenize-header gnus-newsgroup-name ".")
284 (add-hook 'gnus-summary-exit-hook 'gnus-picons-remove-all))))
286 (defsubst gnus-picons-try-suffixes (file)
287 (let ((suffixes gnus-picons-file-suffixes)
290 (not (file-exists-p (setq f (concat file (pop suffixes))))))
294 (defun gnus-picons-insert-face-if-exists (database addrs filename &optional
296 "Inserts a face at point if I can find one"
297 ;; '(gnus-picons-insert-face-if-exists
298 ; "Database" '("edu" "indiana" "cs") "Name")
300 ;; 1. edu/indiana/cs/Name
301 ;; 2. edu/indiana/Name
303 ;; '(gnus-picons-insert-face-if-exists
304 ;; "Database/MISC" '("edu" "indiana" "cs") "Name")
307 ;; The special treatment of MISC doesn't conform with the conventions for
308 ;; picon databases, but otherwise we would always see the MISC/unknown face.
309 (let ((bar (and (not nobar-p)
310 (annotations-in-region
311 (point) (min (point-max) (1+ (point)))
313 (path (concat (file-name-as-directory gnus-picons-database)
315 picons found bar-ann)
316 (if (string-match "/MISC" database)
319 (file-accessible-directory-p path))
320 (setq path (concat path (pop addrs) "/"))
322 (gnus-picons-try-suffixes
323 (concat path filename "/face.")))
325 (setq bar-ann (gnus-picons-try-to-find-face
326 (concat gnus-xmas-glyph-directory "bar.xbm")))
328 (setq picons (nconc picons bar-ann))
330 (setq picons (nconc (gnus-picons-try-to-find-face found)
334 (defvar gnus-picons-glyph-alist nil)
336 (defun gnus-picons-try-to-find-face (path &optional xface-p)
337 "If PATH exists, display it as a bitmap. Returns t if succedded."
338 (let ((glyph (and (not xface-p)
339 (cdr (assoc path gnus-picons-glyph-alist)))))
340 (when (or glyph (file-exists-p path))
342 (setq glyph (make-glyph path))
344 (push (cons path glyph) gnus-picons-glyph-alist))
345 (set-glyph-face glyph 'default))
347 (list (make-annotation glyph (point) 'text))
348 (when (eq major-mode 'gnus-article-mode)
349 (list (make-annotation " " (point) 'text)))))))
351 (defun gnus-picons-reverse-domain-path (str)
353 (mapconcat 'downcase (nreverse (message-tokenize-header str "/")) "/"))
355 (gnus-add-shutdown 'gnus-picons-close 'gnus)
357 (defun gnus-picons-close ()
358 "Shut down the picons."
359 (setq gnus-picons-glyph-alist nil))
361 (provide 'gnus-picon)
363 ;;; gnus-picon.el ends here