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-group-annotations nil)
114 (defvar gnus-article-annotations nil)
115 (defvar gnus-x-face-annotations nil)
117 (defun gnus-picons-remove (plist)
118 (let ((listitem (car plist)))
119 (while (setq listitem (car plist))
120 (if (annotationp listitem)
121 (delete-annotation listitem))
122 (setq plist (cdr plist))))
125 (defun gnus-picons-remove-all ()
126 "Removes all picons from the Gnus display(s)."
128 (gnus-picons-remove gnus-article-annotations)
129 (gnus-picons-remove gnus-group-annotations)
130 (gnus-picons-remove gnus-x-face-annotations)
131 (setq gnus-article-annotations nil
132 gnus-group-annotations nil
133 gnus-x-face-annotations nil)
134 (if (bufferp gnus-picons-buffer)
135 (kill-buffer gnus-picons-buffer))
138 (defun gnus-get-buffer-name (variable)
139 "Returns the buffer name associated with the contents of a variable."
140 (cond ((symbolp variable)
141 (let ((newvar (cdr (assq variable gnus-window-to-buffer))))
142 (cond ((symbolp newvar)
143 (symbol-value newvar))
144 ((stringp newvar) newvar))))
148 (defun gnus-picons-article-display-x-face ()
149 "Display the x-face header bitmap in the 'gnus-picons-display-where buffer."
150 ;; delete any old ones.
151 (gnus-picons-remove gnus-x-face-annotations)
152 (setq gnus-x-face-annotations nil)
153 ;; display the new one.
154 (let ((gnus-article-x-face-command 'gnus-picons-display-x-face))
155 (gnus-article-display-x-face)))
157 (defun gnus-picons-display-x-face (beg end)
158 "Function to display the x-face header in the picons window.
159 To use: (setq gnus-article-x-face-command 'gnus-picons-display-x-face)"
161 ;; convert the x-face header to a .xbm file
162 (let ((process-connection-type nil)
164 (process-kill-without-query
165 (setq process (start-process
166 "gnus-x-face" nil "sh" "-c" gnus-picons-convert-x-face)))
167 (process-send-region "gnus-x-face" beg end)
168 (process-send-eof "gnus-x-face")
170 (while (not (equal (process-status process) 'exit))
174 (set-buffer (get-buffer-create (gnus-get-buffer-name
175 gnus-picons-display-where)))
176 (gnus-add-current-to-buffer-list)
177 (beginning-of-buffer)
178 (let ((iconpoint (point)))
179 (if (not (looking-at "^$"))
188 ;; append the annotation to gnus-article-annotations for deletion.
189 (setq gnus-x-face-annotations
191 (gnus-picons-try-to-find-face
192 gnus-picons-x-face-file-name iconpoint)
193 gnus-x-face-annotations)))
194 ;; delete the tmp file
195 (delete-file gnus-picons-x-face-file-name)))
197 (defun gnus-article-display-picons ()
198 "Display faces for an author and his/her domain in gnus-picons-display-where."
200 (if (and (featurep 'xpm)
201 (or (not (fboundp 'device-type)) (equal (device-type) 'x)))
203 (let* ((iconpoint (point)) (from (mail-fetch-field "from"))
206 (string-match "\\([-_a-zA-Z0-9]+\\)@" from)
207 (match-string 1 from)))
209 (concat (gnus-picons-reverse-domain-path
211 (replace-in-string from ".*@\\([_a-zA-Z0-9-.]+\\).*"
214 (switch-to-buffer (gnus-get-buffer-name gnus-picons-display-where))
215 (gnus-add-current-to-buffer-list)
216 (beginning-of-buffer)
217 (setq iconpoint (point))
218 (if (not (looking-at "^$"))
228 (gnus-picons-remove gnus-article-annotations)
229 (setq gnus-article-annotations 'nil)
230 (if (equal username from)
231 (setq username (progn
232 (string-match "<\\([_a-zA-Z0-9-.]+\\)>" from)
233 (match-string 1 from))))
234 (mapcar '(lambda (pathpart)
235 (setq gnus-article-annotations
237 (gnus-picons-insert-face-if-exists
239 (file-name-as-directory
240 gnus-picons-database) pathpart)
241 (concat hostpath username)
243 gnus-article-annotations)))
244 gnus-picons-user-directories)
245 (mapcar '(lambda (pathpart)
246 (setq gnus-article-annotations
248 (gnus-picons-insert-face-if-exists
249 (concat (file-name-as-directory
250 gnus-picons-database) pathpart)
251 (concat hostpath "unknown")
253 gnus-article-annotations)))
254 gnus-picons-domain-directories)
255 (add-hook 'gnus-summary-exit-hook 'gnus-picons-remove-all)
258 (defun gnus-group-display-picons ()
259 "Display icons for the group in the gnus-picons-display-where buffer."
261 (if (and (featurep 'xpm)
262 (or (not (fboundp 'device-type)) (equal (device-type) 'x)))
265 ((iconpoint (point)))
266 (switch-to-buffer (gnus-get-buffer-name gnus-picons-display-where))
267 (gnus-add-current-to-buffer-list)
268 (beginning-of-buffer)
270 ((listp gnus-group-annotations)
271 (mapcar 'delete-annotation gnus-group-annotations)
272 (setq gnus-group-annotations nil))
273 ((annotationp gnus-group-annotations)
274 (delete-annotation gnus-group-annotations)
275 (setq gnus-group-annotations nil))
277 (setq iconpoint (point))
278 (if (not (looking-at "^$"))
280 (gnus-picons-remove gnus-group-annotations)
281 (setq gnus-group-annotations nil)
282 (setq gnus-group-annotations
283 (gnus-picons-insert-face-if-exists
284 (concat (file-name-as-directory gnus-picons-database)
285 gnus-picons-news-directory)
286 (concat (replace-in-string gnus-newsgroup-name "\\." "/")
289 (add-hook 'gnus-summary-exit-hook 'gnus-picons-remove-all)))))
292 (defun gnus-picons-insert-face-if-exists (path filename ipoint &optional rev)
293 "Inserts a face at point if I can find one"
294 (let ((pathfile (concat path "/" filename "/face"))
296 (replace-in-string filename
297 "[_a-zA-Z0-9-]+/\\([_A-Za-z0-9-]+\\)$" "\\1"))
300 (not (equal filename newfilename)))
301 (setq annotations (append
302 (gnus-picons-insert-face-if-exists path newfilename ipoint rev)
304 (if (eq (length annotations) (length (setq annotations (append
305 (gnus-picons-try-to-find-face (concat pathfile ".xpm") ipoint)
307 (setq annotations (append
308 (gnus-picons-try-to-find-face
309 (concat pathfile ".xbm") ipoint)
312 (not (equal filename newfilename)))
313 (setq annotations (append
314 (gnus-picons-insert-face-if-exists path newfilename ipoint rev)
320 (defun gnus-picons-try-to-find-face (path ipoint)
321 "If PATH exists, display it as a bitmap. Returns t if succedded."
322 (when (file-exists-p path)
323 (let ((gl (make-glyph path)))
324 (set-glyph-face gl 'default)
325 (list (make-annotation gl ipoint 'text)))))
327 (defun gnus-picons-reverse-domain-path (str)
329 (if (equal (replace-in-string str "^[^/]*$" "") "")
331 (concat (replace-in-string str "^.*/\\([_a-zA-Z0-9-]+\\)$" "\\1") "/"
332 (gnus-picons-reverse-domain-path
333 (replace-in-string str "^\\(.*\\)/[_a-zA-Z0-9-]+$" "\\1")))))
335 (provide 'gnus-picon)
337 ;;; gnus-picon.el ends here