X-Git-Url: https://cgit.sxemacs.org/?a=blobdiff_plain;f=lisp%2Fgnus-picon.el;h=188f07168fee71d70b5cd2b6919df703688bc3b3;hb=f7214ffc48a0e4ff482a4aaa1844f1806cf30d4d;hp=23c38183b9b4c1f75357fa3890c880f95fa23819;hpb=a3628c5a6916f7584ac6c1e8177140dd5cbd9680;p=gnus diff --git a/lisp/gnus-picon.el b/lisp/gnus-picon.el index 23c38183b..188f07168 100644 --- a/lisp/gnus-picon.el +++ b/lisp/gnus-picon.el @@ -1,5 +1,7 @@ ;;; gnus-picon.el --- displaying pretty icons in Gnus -;; Copyright (C) 1996 Free Software Foundation, Inc. + +;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002 +;; Free Software Foundation, Inc. ;; Author: Wes Hardaker ;; Keywords: news xpm annotation glyph faces @@ -23,335 +25,239 @@ ;;; 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)))) -;; -;; 2) display the icons in the summary 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 'summary) -;; -;; 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. +;; There are three picon types relevant to Gnus: ;; +;; 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 ;;; 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 'custom) +(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) + +(defface gnus-picon-xbm-face '((t (:foreground "black" :background "white"))) + "Face to show xbm picon in." + :group 'gnus-picon) + +(defface gnus-picon-face '((t (:foreground "black" :background "white"))) + "Face to show picon in." + :group '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) + "Insert GLYPH into the buffer. +GLYPH can be either a glyph or a string." + (if (stringp glyph) + (insert glyph) + (gnus-add-wash-type category) + (gnus-add-image category (car glyph)) + (gnus-put-image (car glyph) (cdr glyph)))) + +(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-fetch-field header))) + spec file point cache) + (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) + (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: + +;;;###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) - 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." + (gnus-with-article-buffer + (if (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) - (if (and (featurep 'xpm) - (or (not (fboundp 'device-type)) (equal (device-type) 'x)) - (mail-fetch-field "from")) - (save-excursion - (let* ((from (mail-fetch-field "from")) - (username - (progn - (string-match "\\([^ \t]+\\)@" from) - (match-string 1 from))) - (hostpath - (concat - (gnus-picons-reverse-domain-path - (replace-in-string - (replace-in-string - (cadr (mail-extract-address-components from)) - ".*@\\(.*\\)\\'" "\\1") - "\\." "/")) "/"))) - (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) - (when username - (when (equal username from) - (setq username (progn - (string-match "<\\([_a-zA-Z0-9-.]+\\)>" from) - (match-string 1 from)))) - (mapcar (lambda (pathpart) - (setq gnus-article-annotations - (append - (gnus-picons-insert-face-if-exists - (concat - (file-name-as-directory - gnus-picons-database) pathpart) - (concat hostpath (downcase username))) - gnus-article-annotations))) - gnus-picons-user-directories) - (mapcar (lambda (pathpart) - (setq gnus-article-annotations - (append - (gnus-picons-insert-face-if-exists - (concat (file-name-as-directory - gnus-picons-database) pathpart) - (concat hostpath)) - gnus-article-annotations))) - gnus-picons-domain-directories) - (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." + (gnus-with-article-buffer + (if (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 - (concat (file-name-as-directory gnus-picons-database) - gnus-picons-news-directory) - (replace-in-string gnus-newsgroup-name "\\." "/"))) - (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 (path filename) - "Inserts a face at point if I can find one" - (let ((bar (annotations-in-region - (point) (min (point-max) (1+ (point))) - (current-buffer))) - (files (message-tokenize-header filename "/")) - picons found bar-ann) - (while (and files - (file-exists-p path)) - (setq path (concat path "/" (pop files))) - (when (setq found - (or - (gnus-picons-try-suffixes (concat path "/face.")) - (gnus-picons-try-suffixes (concat path "/unknown/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) - "If PATH exists, display it as a bitmap. Returns t if succedded." - (let ((glyph (cdr (assoc path gnus-picons-glyph-alist)))) - (when (or glyph (file-exists-p path)) - (unless glyph - (push (cons path (setq glyph (make-glyph path))) - 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)) + (gnus-with-article-buffer + (if (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)