;;; gnus-picon.el --- displaying pretty icons in Gnus
-;; Copyright (C) 1996 Free Software Foundation, Inc.
-;; Author: Wes Hardaker <hardaker@ece.ucdavis.edu>
+;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
+;; 2005, 2006 Free Software Foundation, Inc.
+
+;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
;; Keywords: news xpm annotation glyph faces
;; This file is part of GNU Emacs.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
;;; Commentary:
-;; Usage:
-;; - You must have XEmacs (19.12 or above I think) to use this.
-;; - Read the variable descriptions below.
-;;
-;; - chose a setup:
-;;
-;; 1) display the icons in its own buffer:
-;;
-;; (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
-;; (add-hook 'gnus-summary-prepare-hook 'gnus-group-display-picons t)
-;; (setq gnus-picons-display-where 'picons)
-;;
-;; Then add the picons buffer to your display configuration:
-;; The picons buffer needs to be at least 48 pixels high,
-;; which for me is 5 lines:
-;;
-;; (gnus-add-configuration
-;; '(article (vertical 1.0
-;; (group 6)
-;; (picons 5)
-;; (summary .25 point)
-;; (article 1.0))))
-;;
-;; (gnus-add-configuration
-;; '(summary (vertical 1.0 (group 6)
-;; (picons 5)
-;; (summary 1.0 point))))
+;; There are three picon types relevant to Gnus:
;;
-;; 2) display the icons in the summary buffer
+;; Persons: person@subdomain.dom
+;; users/dom/subdomain/person/face.gif
+;; usenix/dom/subdomain/person/face.gif
+;; misc/MISC/person/face.gif
+;; Domains: subdomain.dom
+;; domain/dom/subdomain/unknown/face.gif
+;; Groups: comp.lang.lisp
+;; news/comp/lang/lisp/unknown/face.gif
;;
-;; (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
-;; (add-hook 'gnus-summary-prepare-hook 'gnus-group-display-picons t)
-;; (setq gnus-picons-display-where 'summary)
+;; Original implementation by Wes Hardaker <hardaker@ece.ucdavis.edu>.
;;
-;; 3) display the icons in the article buffer
-;;
-;; (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
-;; (add-hook 'gnus-article-prepare-hook 'gnus-group-display-picons t)
-;; (setq gnus-picons-display-where 'article)
-;;
-;;
-;; Warnings:
-;; - I'm not even close to being a lisp expert.
-;; - The 't' (append) flag MUST be in the add-hook line
-;;
-;; TODO:
-;; - Remove the TODO section in the headers.
-;;
-
;;; Code:
-(require 'xpm)
-(require 'annotations)
(eval-when-compile (require 'cl))
-(defvar gnus-picons-buffer "*Icon Buffer*"
- "Buffer name to display the icons in if gnus-picons-display-where is 'picons.")
-
-(defvar gnus-picons-display-where 'picons
- "Where to display the group and article icons.")
+(require 'gnus)
+(require 'gnus-art)
-(defvar gnus-picons-database "/usr/local/faces"
- "Defines the location of the faces database.
-For information on obtaining this database of pretty pictures, please
-see http://www.cs.indiana.edu/picons/ftp/index.html" )
+;;; User variables:
-(defvar gnus-picons-news-directory "news"
- "Sub-directory of the faces database containing the icons for newsgroups."
-)
+(defcustom gnus-picon-news-directories '("news")
+ "*List of directories to search for newsgroups faces."
+ :type '(repeat string)
+ :group 'gnus-picon)
-(defvar gnus-picons-user-directories '("local" "users" "usenix" "misc/MISC")
- "List of directories to search for user faces."
-)
+(defcustom gnus-picon-user-directories '("users" "usenix" "local" "misc")
+ "*List of directories to search for user faces."
+ :type '(repeat string)
+ :group 'gnus-picon)
-(defvar gnus-picons-domain-directories '("domains")
- "List of directories to search for domain faces.
+(defcustom gnus-picon-domain-directories '("domains")
+ "*List of directories to search for domain faces.
Some people may want to add \"unknown\" to this list."
-)
-
-(defvar gnus-picons-x-face-file-name
- (format "/tmp/picon-xface.%s.xbm" (user-login-name))
- "The name of the file in which to store the converted X-face header.")
-
-(defvar gnus-picons-convert-x-face (format "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | pbmtoxbm > %s" gnus-picons-x-face-file-name)
- "Command to convert the x-face header into a xbm file."
-)
-
-(defvar gnus-picons-file-suffixes
- (when (featurep 'x)
- (let ((types (list "xbm")))
- (when (featurep 'gif)
- (push "gif" types))
- (when (featurep 'xpm)
- (push "xpm" types))
- types))
- "List of suffixes on picon file names to try.")
-
-(defvar gnus-picons-display-article-move-p t
- "*Whether to move point to first empty line when displaying picons.
-This has only an effect if `gnus-picons-display-where' hs value article.")
-
-;;; Internal variables.
-
-(defvar gnus-group-annotations nil)
-(defvar gnus-article-annotations nil)
-(defvar gnus-x-face-annotations nil)
-
-(defun gnus-picons-remove (plist)
- (let ((listitem (car plist)))
- (while (setq listitem (car plist))
- (if (annotationp listitem)
- (delete-annotation listitem))
- (setq plist (cdr plist))))
- )
-
-(defun gnus-picons-remove-all ()
- "Removes all picons from the Gnus display(s)."
+ :type '(repeat string)
+ :group 'gnus-picon)
+
+(defcustom gnus-picon-file-types
+ (let ((types (list "xbm")))
+ (when (gnus-image-type-available-p 'gif)
+ (push "gif" types))
+ (when (gnus-image-type-available-p 'xpm)
+ (push "xpm" types))
+ types)
+ "*List of suffixes on picon file names to try."
+ :type '(repeat string)
+ :group 'gnus-picon)
+
+(defcustom gnus-picon-style 'inline
+ "How should picons be displayed.
+If `inline', the textual representation is replaced. If `right', picons are
+added right to the textual representation."
+ ;; FIXME: `right' needs improvement for XEmacs.
+ :type '(choice (const inline)
+ (const right))
+ :group 'gnus-picon)
+
+(defface gnus-picon-xbm '((t (:foreground "black" :background "white")))
+ "Face to show xbm picon in."
+ :group 'gnus-picon)
+;; backward-compatibility alias
+(put 'gnus-picon-xbm-face 'face-alias 'gnus-picon-xbm)
+
+(defface gnus-picon '((t (:foreground "black" :background "white")))
+ "Face to show picon in."
+ :group 'gnus-picon)
+;; backward-compatibility alias
+(put 'gnus-picon-face 'face-alias 'gnus-picon)
+
+;;; Internal variables:
+
+(defvar gnus-picon-setup-p nil)
+(defvar gnus-picon-glyph-alist nil
+ "Picon glyphs cache.
+List of pairs (KEY . GLYPH) where KEY is either a filename or an URL.")
+(defvar gnus-picon-cache nil)
+
+;;; Functions:
+
+(defsubst gnus-picon-split-address (address)
+ (setq address (split-string address "@"))
+ (if (stringp (cadr address))
+ (cons (car address) (split-string (cadr address) "\\."))
+ (if (stringp (car address))
+ (split-string (car address) "\\."))))
+
+(defun gnus-picon-find-face (address directories &optional exact)
+ (let* ((address (gnus-picon-split-address address))
+ (user (pop address))
+ (faddress address)
+ database directory result instance base)
+ (catch 'found
+ (dolist (database gnus-picon-databases)
+ (dolist (directory directories)
+ (setq address faddress
+ base (expand-file-name directory database))
+ (while address
+ (when (setq result (gnus-picon-find-image
+ (concat base "/" (mapconcat 'downcase
+ (reverse address)
+ "/")
+ "/" (downcase user) "/")))
+ (throw 'found result))
+ (if exact
+ (setq address nil)
+ (pop address)))
+ ;; Kludge to search MISC as well. But not in "news".
+ (unless (string= directory "news")
+ (when (setq result (gnus-picon-find-image
+ (concat base "/MISC/" user "/")))
+ (throw 'found result))))))))
+
+(defun gnus-picon-find-image (directory)
+ (let ((types gnus-picon-file-types)
+ found type file)
+ (while (and (not found)
+ (setq type (pop types)))
+ (setq found (file-exists-p (setq file (concat directory "face." type)))))
+ (if found
+ file
+ nil)))
+
+(defun gnus-picon-insert-glyph (glyph category &optional nostring)
+ "Insert GLYPH into the buffer.
+GLYPH can be either a glyph or a string. When NOSTRING, no textual
+replacement is added."
+ ;; Using NOSTRING prevents wrong BBDB entries with `gnus-picon-style' set to
+ ;; 'right.
+ (if (stringp glyph)
+ (insert glyph)
+ (gnus-add-wash-type category)
+ (gnus-add-image category (car glyph))
+ (gnus-put-image (car glyph) (unless nostring (cdr glyph)) category)))
+
+(defun gnus-picon-create-glyph (file)
+ (or (cdr (assoc file gnus-picon-glyph-alist))
+ (cdar (push (cons file (gnus-create-image file))
+ gnus-picon-glyph-alist))))
+
+;;; Functions that does picon transformations:
+
+(defun gnus-picon-transform-address (header category)
+ (gnus-with-article-headers
+ (let ((addresses
+ (mail-header-parse-addresses
+ ;; mail-header-parse-addresses does not work (reliably) on
+ ;; decoded headers.
+ (or
+ (ignore-errors
+ (mail-encode-encoded-word-string
+ (or (mail-fetch-field header) "")))
+ (mail-fetch-field header))))
+ spec file point cache len)
+ (dolist (address addresses)
+ (setq address (car address))
+ (when (and (stringp address)
+ (setq spec (gnus-picon-split-address address)))
+ (if (setq cache (cdr (assoc address gnus-picon-cache)))
+ (setq spec cache)
+ (when (setq file (or (gnus-picon-find-face
+ address gnus-picon-user-directories)
+ (gnus-picon-find-face
+ (concat "unknown@"
+ (mapconcat
+ 'identity (cdr spec) "."))
+ gnus-picon-user-directories)))
+ (setcar spec (cons (gnus-picon-create-glyph file)
+ (car spec))))
+
+ (dotimes (i (1- (length spec)))
+ (when (setq file (gnus-picon-find-face
+ (concat "unknown@"
+ (mapconcat
+ 'identity (nthcdr (1+ i) spec) "."))
+ gnus-picon-domain-directories t))
+ (setcar (nthcdr (1+ i) spec)
+ (cons (gnus-picon-create-glyph file)
+ (nth (1+ i) spec)))))
+ (setq spec (nreverse spec))
+ (push (cons address spec) gnus-picon-cache))
+
+ (gnus-article-goto-header header)
+ (mail-header-narrow-to-field)
+ (case gnus-picon-style
+ (right
+ (when (= (length addresses) 1)
+ (setq len (apply '+ (mapcar (lambda (x)
+ (condition-case nil
+ (car (image-size (car x)))
+ (error 0))) spec)))
+ (when (> len 0)
+ (goto-char (point-at-eol))
+ (insert (propertize
+ " " 'display
+ (cons 'space
+ (list :align-to (- (window-width) 1 len))))))
+ (goto-char (point-at-eol))
+ (setq point (point-at-eol))
+ (dolist (image spec)
+ (unless (stringp image)
+ (goto-char point)
+ (gnus-picon-insert-glyph image category 'nostring)))))
+ (inline
+ (when (search-forward address nil t)
+ (delete-region (match-beginning 0) (match-end 0))
+ (setq point (point))
+ (while spec
+ (goto-char point)
+ (if (> (length spec) 2)
+ (insert ".")
+ (if (= (length spec) 2)
+ (insert "@")))
+ (gnus-picon-insert-glyph (pop spec) category))))))))))
+
+(defun gnus-picon-transform-newsgroups (header)
(interactive)
- (gnus-picons-remove gnus-article-annotations)
- (gnus-picons-remove gnus-group-annotations)
- (gnus-picons-remove gnus-x-face-annotations)
- (setq gnus-article-annotations nil
- gnus-group-annotations nil
- gnus-x-face-annotations nil)
- (if (bufferp gnus-picons-buffer)
- (kill-buffer gnus-picons-buffer))
- )
-
-(defun gnus-get-buffer-name (variable)
- "Returns the buffer name associated with the contents of a variable."
- (cond ((symbolp variable)
- (let ((newvar (cdr (assq variable gnus-window-to-buffer))))
- (cond ((symbolp newvar)
- (symbol-value newvar))
- ((stringp newvar) newvar))))
- ((stringp variable)
- variable)))
-
-(defun gnus-picons-article-display-x-face ()
- "Display the x-face header bitmap in the 'gnus-picons-display-where buffer."
- ;; delete any old ones.
- (gnus-picons-remove gnus-x-face-annotations)
- (setq gnus-x-face-annotations nil)
- ;; display the new one.
- (let ((gnus-article-x-face-command 'gnus-picons-display-x-face))
- (gnus-article-display-x-face)))
-
-(defun gnus-picons-display-x-face (beg end)
- "Function to display the x-face header in the picons window.
-To use: (setq gnus-article-x-face-command 'gnus-picons-display-x-face)"
+ (gnus-with-article-headers
+ (gnus-article-goto-header header)
+ (mail-header-narrow-to-field)
+ (let ((groups (message-tokenize-header (mail-fetch-field header)))
+ spec file point)
+ (dolist (group groups)
+ (unless (setq spec (cdr (assoc group gnus-picon-cache)))
+ (setq spec (nreverse (split-string group "[.]")))
+ (dotimes (i (length spec))
+ (when (setq file (gnus-picon-find-face
+ (concat "unknown@"
+ (mapconcat
+ 'identity (nthcdr i spec) "."))
+ gnus-picon-news-directories t))
+ (setcar (nthcdr i spec)
+ (cons (gnus-picon-create-glyph file)
+ (nth i spec)))))
+ (push (cons group spec) gnus-picon-cache))
+ (when (search-forward group nil t)
+ (delete-region (match-beginning 0) (match-end 0))
+ (save-restriction
+ (narrow-to-region (point) (point))
+ (while spec
+ (goto-char (point-min))
+ (if (> (length spec) 1)
+ (insert "."))
+ (gnus-picon-insert-glyph (pop spec) 'newsgroups-picon))
+ (goto-char (point-max))))))))
+
+;;; Commands:
+
+;; #### NOTE: the test for buffer-read-only is the same as in
+;; article-display-[x-]face. See the comment up there.
+
+;;;###autoload
+(defun gnus-treat-from-picon ()
+ "Display picons in the From header.
+If picons are already displayed, remove them."
(interactive)
- ;; convert the x-face header to a .xbm file
- (let ((process-connection-type nil)
- (process nil))
- (process-kill-without-query
- (setq process (start-process
- "gnus-x-face" nil shell-file-name shell-command-switch
- gnus-picons-convert-x-face)))
- (process-send-region "gnus-x-face" beg end)
- (process-send-eof "gnus-x-face")
- ;; wait for it.
- (while (not (equal (process-status process) 'exit))
- (sleep-for .1)))
- ;; display it
- (save-excursion
- (set-buffer (get-buffer-create (gnus-get-buffer-name
- gnus-picons-display-where)))
- (gnus-add-current-to-buffer-list)
- (goto-char (point-min))
- (let (buffer-read-only)
- (unless (eolp)
- (push (make-annotation "\n" (point) 'text)
- gnus-x-face-annotations))
- ;; append the annotation to gnus-article-annotations for deletion.
- (setq gnus-x-face-annotations
- (append
- (gnus-picons-try-to-find-face gnus-picons-x-face-file-name t)
- gnus-x-face-annotations)))
- ;; delete the tmp file
- (delete-file gnus-picons-x-face-file-name)))
-
-(defun gnus-article-display-picons ()
- "Display faces for an author and his/her domain in gnus-picons-display-where."
+ (let ((wash-picon-p buffer-read-only))
+ (gnus-with-article-buffer
+ (if (and wash-picon-p (memq 'from-picon gnus-article-wash-types))
+ (gnus-delete-images 'from-picon)
+ (gnus-picon-transform-address "from" 'from-picon)))))
+
+;;;###autoload
+(defun gnus-treat-mail-picon ()
+ "Display picons in the Cc and To headers.
+If picons are already displayed, remove them."
(interactive)
- (let (from at-idx databases)
- (when (and (featurep 'xpm)
- (or (not (fboundp 'device-type)) (equal (device-type) 'x))
- (setq from (mail-fetch-field "from"))
- (setq from (downcase (cadr (mail-extract-address-components
- from)))
- at-idx (string-match "@" from)))
- (save-excursion
- (let ((username (substring from 0 at-idx))
- (addrs (nreverse
- (message-tokenize-header (substring from (1+ at-idx))
- "."))))
- (set-buffer (get-buffer-create
- (gnus-get-buffer-name gnus-picons-display-where)))
- (gnus-add-current-to-buffer-list)
- (goto-char (point-min))
- (if (and (eq gnus-picons-display-where 'article)
- gnus-picons-display-article-move-p)
- (when (search-forward "\n\n" nil t)
- (forward-line -1))
- (unless (eolp)
- (push (make-annotation "\n" (point) 'text)
- gnus-article-annotations)))
-
- (gnus-picons-remove gnus-article-annotations)
- (setq gnus-article-annotations nil)
-
- (setq databases (append gnus-picons-user-directories
- gnus-picons-domain-directories))
- (while databases
- (setq gnus-article-annotations
- (nconc (gnus-picons-insert-face-if-exists
- (car databases)
- addrs
- "unknown")
- (gnus-picons-insert-face-if-exists
- (car databases)
- addrs
- (downcase username) t)
- gnus-article-annotations))
- (setq databases (cdr databases)))
- (add-hook 'gnus-summary-exit-hook 'gnus-picons-remove-all))))))
-
-(defun gnus-group-display-picons ()
- "Display icons for the group in the gnus-picons-display-where buffer."
+ (let ((wash-picon-p buffer-read-only))
+ (gnus-with-article-buffer
+ (if (and wash-picon-p (memq 'mail-picon gnus-article-wash-types))
+ (gnus-delete-images 'mail-picon)
+ (gnus-picon-transform-address "cc" 'mail-picon)
+ (gnus-picon-transform-address "to" 'mail-picon)))))
+
+;;;###autoload
+(defun gnus-treat-newsgroups-picon ()
+ "Display picons in the Newsgroups and Followup-To headers.
+If picons are already displayed, remove them."
(interactive)
- (when (and (featurep 'xpm)
- (or (not (fboundp 'device-type)) (equal (device-type) 'x)))
- (save-excursion
- (set-buffer (get-buffer-create
- (gnus-get-buffer-name gnus-picons-display-where)))
- (gnus-add-current-to-buffer-list)
- (goto-char (point-min))
- (if (and (eq gnus-picons-display-where 'article)
- gnus-picons-display-article-move-p)
- (if (search-forward "\n\n" nil t)
- (forward-line -1))
- (unless (eolp)
- (push (make-annotation "\n" (point) 'text)
- gnus-group-annotations)))
- (cond
- ((listp gnus-group-annotations)
- (mapcar 'delete-annotation gnus-group-annotations)
- (setq gnus-group-annotations nil))
- ((annotationp gnus-group-annotations)
- (delete-annotation gnus-group-annotations)
- (setq gnus-group-annotations nil)))
- (gnus-picons-remove gnus-group-annotations)
- (setq gnus-group-annotations
- (gnus-picons-insert-face-if-exists
- gnus-picons-news-directory
- (message-tokenize-header gnus-newsgroup-name ".")
- "unknown"))
- (add-hook 'gnus-summary-exit-hook 'gnus-picons-remove-all))))
-
-(defsubst gnus-picons-try-suffixes (file)
- (let ((suffixes gnus-picons-file-suffixes)
- f)
- (while (and suffixes
- (not (file-exists-p (setq f (concat file (pop suffixes))))))
- (setq f nil))
- f))
-
-(defun gnus-picons-insert-face-if-exists (database addrs filename &optional
- nobar-p)
- "Inserts a face at point if I can find one"
- ;; '(gnus-picons-insert-face-if-exists
- ; "Database" '("edu" "indiana" "cs") "Name")
- ;; looks for:
- ;; 1. edu/indiana/cs/Name
- ;; 2. edu/indiana/Name
- ;; 3. edu/Name
- ;; '(gnus-picons-insert-face-if-exists
- ;; "Database/MISC" '("edu" "indiana" "cs") "Name")
- ;; looks for:
- ;; 1. MISC/Name
- ;; The special treatment of MISC doesn't conform with the conventions for
- ;; picon databases, but otherwise we would always see the MISC/unknown face.
- (let ((bar (and (not nobar-p)
- (annotations-in-region
- (point) (min (point-max) (1+ (point)))
- (current-buffer))))
- (path (concat (file-name-as-directory gnus-picons-database)
- database "/"))
- picons found bar-ann)
- (if (string-match "/MISC" database)
- (setq addrs '("")))
- (while (and addrs
- (file-accessible-directory-p path))
- (setq path (concat path (pop addrs) "/"))
- (when (setq found
- (gnus-picons-try-suffixes
- (concat path filename "/face.")))
- (when bar
- (setq bar-ann (gnus-picons-try-to-find-face
- (concat gnus-xmas-glyph-directory "bar.xbm")))
- (when bar-ann
- (setq picons (nconc picons bar-ann))
- (setq bar nil)))
- (setq picons (nconc (gnus-picons-try-to-find-face found)
- picons))))
- (nreverse picons)))
-
-(defvar gnus-picons-glyph-alist nil)
-
-(defun gnus-picons-try-to-find-face (path &optional xface-p)
- "If PATH exists, display it as a bitmap. Returns t if succedded."
- (let ((glyph (and (not xface-p)
- (cdr (assoc path gnus-picons-glyph-alist)))))
- (when (or glyph (file-exists-p path))
- (unless glyph
- (setq glyph (make-glyph path))
- (unless xface-p
- (push (cons path glyph) gnus-picons-glyph-alist))
- (set-glyph-face glyph 'default))
- (nconc
- (list (make-annotation glyph (point) 'text))
- (when (eq major-mode 'gnus-article-mode)
- (list (make-annotation " " (point) 'text)))))))
-
-(defun gnus-picons-reverse-domain-path (str)
- "a/b/c/d -> d/c/b/a"
- (mapconcat 'downcase (nreverse (message-tokenize-header str "/")) "/"))
-
-(gnus-add-shutdown 'gnus-picons-close 'gnus)
-
-(defun gnus-picons-close ()
- "Shut down the picons."
- (setq gnus-picons-glyph-alist nil))
+ (let ((wash-picon-p buffer-read-only))
+ (gnus-with-article-buffer
+ (if (and wash-picon-p (memq 'newsgroups-picon gnus-article-wash-types))
+ (gnus-delete-images 'newsgroups-picon)
+ (gnus-picon-transform-newsgroups "newsgroups")
+ (gnus-picon-transform-newsgroups "followup-to")))))
(provide 'gnus-picon)
+;;; arch-tag: fe9aede0-1b1b-463a-b4ab-807f98bcb31f
;;; gnus-picon.el ends here
projects / gnus / blobdiff