cgit.sxemacs.org Git - gnus/blob - lisp/gnus-picon.el

   1 ;;; gnus-picon.el --- displaying pretty icons in Gnus
   2 ;; Copyright (C) 1996,97,98 Free Software Foundation, Inc.
   3
   4 ;; Author: Wes Hardaker <hardaker@ece.ucdavis.edu>
   5 ;; Keywords: news xpm annotation glyph faces
   6
   7 ;; This file is part of GNU Emacs.
   8
   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)
  12 ;; any later version.
  13
  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.
  18
  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.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27
  28 (require 'gnus)
  29 (require 'xpm)
  30 (require 'annotations)
  31 (require 'custom)
  32 (require 'gnus-art)
  33 (require 'gnus-win)
  34
  35 ;;; User variables:
  36
  37 (defgroup picons nil
  38   "Show pictures of people, domains, and newsgroups (XEmacs).
  39 For this to work, you must add gnus-group-display-picons to the
  40 gnus-summary-display-hook or to the gnus-article-display-hook
  41 depending on what gnus-picons-display-where is set to.  You must
  42 also add gnus-article-display-picons to gnus-article-display-hook."
  43   :group 'gnus-visual)
  44
  45 (defcustom gnus-picons-display-where 'picons
  46   "Where to display the group and article icons.
  47 Legal values are `article' and `picons'."
  48   :type '(choice symbol string)
  49   :group 'picons)
  50
  51 (defcustom gnus-picons-has-modeline-p t
  52   "*Whether the picons window should have a modeline.
  53 This is only useful if `gnus-picons-display-where' is `picons'."
  54   :type 'boolean
  55   :group 'picons)
  56
  57 (defcustom gnus-picons-database "/usr/local/faces"
  58   "*Defines the location of the faces database.
  59 For information on obtaining this database of pretty pictures, please
  60 see http://www.cs.indiana.edu/picons/ftp/index.html"
  61   :type 'directory
  62   :group 'picons)
  63
  64 (defcustom gnus-picons-news-directories '("news")
  65   "*List of directories to search for newsgroups faces."
  66   :type '(repeat string)
  67   :group 'picons)
  68 (define-obsolete-variable-alias 'gnus-picons-news-directory
  69   'gnus-picons-news-directories)
  70
  71 (defcustom gnus-picons-user-directories '("local" "users" "usenix" "misc")
  72   "*List of directories to search for user faces."
  73   :type '(repeat string)
  74   :group 'picons)
  75
  76 (defcustom gnus-picons-domain-directories '("domains")
  77   "*List of directories to search for domain faces.
  78 Some people may want to add \"unknown\" to this list."
  79   :type '(repeat string)
  80   :group 'picons)
  81
  82 (defcustom gnus-picons-refresh-before-display nil
  83   "*If non-nil, display the article buffer before computing the picons."
  84   :type 'boolean
  85   :group 'picons)
  86
  87 (defcustom gnus-picons-group-excluded-groups nil
  88   "*If this regexp matches the group name, group picons will be disabled."
  89   :type 'regexp
  90   :group 'picons)
  91
  92 (defcustom gnus-picons-x-face-file-name
  93   (format "/tmp/picon-xface.%s.xbm" (user-login-name))
  94   "*The name of the file in which to store the converted X-face header."
  95   :type 'string
  96   :group 'picons)
  97
  98 (defcustom gnus-picons-convert-x-face (format "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | pbmtoxbm > %s" gnus-picons-x-face-file-name)
  99   "*Command to convert the x-face header into a xbm file."
 100   :type 'string
 101   :group 'picons)
 102
 103 (defcustom gnus-picons-display-as-address t
 104   "*If t display textual email addresses along with pictures."
 105   :type 'boolean
 106   :group 'picons)
 107
 108 (defcustom gnus-picons-file-suffixes
 109   (when (featurep 'x)
 110     (let ((types (list "xbm")))
 111       (when (featurep 'gif)
 112         (push "gif" types))
 113       (when (featurep 'xpm)
 114         (push "xpm" types))
 115       types))
 116   "*List of suffixes on picon file names to try."
 117   :type '(repeat string)
 118   :group 'picons)
 119
 120 (defcustom gnus-picons-display-article-move-p t
 121   "*Whether to move point to first empty line when displaying picons.
 122 This has only an effect if `gnus-picons-display-where' has value `article'."
 123   :type 'boolean
 124   :group 'picons)
 125
 126 (defcustom gnus-picons-clear-cache-on-shutdown t
 127   "*Whether to clear the picons cache when exiting gnus.
 128 Gnus caches every picons it finds while it is running.  This saves
 129 some time in the search process but eats some memory.  If this
 130 variable is set to nil, Gnus will never clear the cache itself; you
 131 will have to manually call `gnus-picons-clear-cache' to clear it.
 132 Otherwise the cache will be cleared every time you exit Gnus."
 133   :type 'boolean
 134   :group 'picons)
 135
 136 (defcustom gnus-picons-piconsearch-url nil
 137   "*The url to query for picons.  Setting this to nil will disable it.
 138 The only publicly available address currently known is
 139 http://www.cs.indiana.edu:800/piconsearch.  If you know of any other,
 140 please tell me so that we can list it."
 141   :type '(choice (const :tag "Disable" :value nil)
 142                  (const :tag "www.cs.indiana.edu"
 143                         :value "http://www.cs.indiana.edu:800/piconsearch")
 144                  (string))
 145   :group 'picons)
 146
 147 (defface gnus-picons-xbm-face '((t (:foreground "black" :background "white")))
 148   "Face to show X face"
 149   :group 'picons)
 150
 151 ;;; Internal variables:
 152
 153 (defvar gnus-picons-processes-alist nil
 154   "Picons processes currently running and their environment.")
 155 (defvar gnus-picons-glyph-alist nil
 156   "Picons glyphs cache.
 157 List of pairs (KEY . GLYPH) where KEY is either a filename or an URL.")
 158 (defvar gnus-picons-url-alist nil
 159   "Picons file names cache.
 160 List of pairs (KEY . NAME) where KEY is (USER HOST DBS) and NAME is an URL.")
 161
 162 (defvar gnus-picons-jobs-alist nil
 163   "List of jobs that still need be done.
 164 This is a list of (SYM-ANN TAG ARGS...) where SYM-ANN three annotations list,
 165 TAG is one of `picon' or `search' indicating that the job should query a
 166 picon or do a search for picons file names, and ARGS is some additionnal
 167 arguments necessary for the job.")
 168
 169 (defvar gnus-picons-job-already-running nil
 170   "Lock to ensure only one stream of http requests is running.")
 171
 172 ;;; Functions:
 173
 174 (defun gnus-picons-remove-all ()
 175   "Removes all picons from the Gnus display(s)."
 176   (interactive)
 177   (map-extents (function (lambda (ext unused) (delete-annotation ext) nil))
 178                nil nil nil nil nil 'gnus-picon)
 179   (setq gnus-picons-jobs-alist '())
 180   ;; notify running job that it may have been preempted
 181   (if (and (listp gnus-picons-job-already-running)
 182            gnus-picons-job-already-running)
 183       (setq gnus-picons-job-already-running t)))
 184
 185 (defun gnus-get-buffer-name (variable)
 186   "Returns the buffer name associated with the contents of a variable."
 187   (buffer-name (get-buffer (gnus-window-to-buffer-helper
 188                             (cdr (assq variable gnus-window-to-buffer))))))
 189
 190 (defun gnus-picons-buffer-name ()
 191   (cond ((or (stringp gnus-picons-display-where)
 192              (bufferp gnus-picons-display-where))
 193          gnus-picons-display-where)
 194         ((eq gnus-picons-display-where 'picons)
 195          (if gnus-single-article-buffer
 196              "*Picons*"
 197            (concat "*Picons " gnus-newsgroup-name "*")))
 198         (t
 199          (gnus-get-buffer-name gnus-picons-display-where))))
 200
 201 (defun gnus-picons-kill-buffer ()
 202   (let ((buf (get-buffer (gnus-picons-buffer-name))))
 203     (if (buffer-live-p buf)
 204         (kill-buffer buf))))
 205
 206 (defun gnus-picons-setup-buffer ()
 207   (let ((name (gnus-picons-buffer-name)))
 208     (save-excursion
 209       (if (get-buffer name)
 210           (set-buffer name)
 211         (set-buffer (get-buffer-create name))
 212         (buffer-disable-undo)
 213         (setq buffer-read-only t)
 214         (gnus-add-current-to-buffer-list)
 215         (add-hook 'gnus-summary-prepare-exit-hook 'gnus-picons-kill-buffer))
 216       (current-buffer))))
 217
 218 (defun gnus-picons-set-buffer ()
 219   (set-buffer (gnus-picons-setup-buffer))
 220   (goto-char (point-min))
 221   (if (and (eq gnus-picons-display-where 'article)
 222            gnus-picons-display-article-move-p)
 223       (if (search-forward "\n\n" nil t)
 224           (forward-line -1)
 225         (goto-char (point-max)))
 226     (setq buffer-read-only t)
 227     (unless gnus-picons-has-modeline-p
 228       (set-specifier has-modeline-p
 229                      (list (list (current-buffer)
 230                                  (cons nil gnus-picons-has-modeline-p)))))))
 231
 232 (defun gnus-picons-prepare-for-annotations ()
 233   "Prepare picons buffer for putting annotations."
 234   ;; let drawing catch up
 235   (when gnus-picons-refresh-before-display
 236     (sit-for 0))
 237   (gnus-picons-set-buffer)
 238   (gnus-picons-remove-all))
 239
 240 (defun gnus-picons-make-annotation (&rest args)
 241   (let ((annot (apply 'make-annotation args)))
 242     (set-extent-property annot 'gnus-picon t)
 243     (set-extent-property annot 'duplicable t)
 244     annot))
 245
 246 (defun gnus-picons-article-display-x-face ()
 247   "Display the x-face header bitmap in the 'gnus-picons-display-where buffer."
 248   (let ((gnus-article-x-face-command 'gnus-picons-display-x-face))
 249     (gnus-article-display-x-face)))
 250
 251 (defun gnus-picons-x-face-sentinel (process event)
 252   (when (memq process gnus-picons-processes-alist)
 253     (setq gnus-picons-processes-alist
 254           (delq process gnus-picons-processes-alist))
 255     (gnus-picons-set-buffer)
 256     (gnus-picons-make-annotation (make-glyph gnus-picons-x-face-file-name)
 257                                  nil 'text)
 258     (when (file-exists-p gnus-picons-x-face-file-name)
 259       (delete-file gnus-picons-x-face-file-name))))
 260
 261 (defun gnus-picons-display-x-face (beg end)
 262   "Function to display the x-face header in the picons window.
 263 To use:  (setq gnus-article-x-face-command 'gnus-picons-display-x-face)"
 264   (interactive)
 265   (if (featurep 'xface)
 266       ;; Use builtin support
 267       (save-excursion
 268         ;; Don't remove this binding, it is really needed: when
 269         ;; `gnus-picons-set-buffer' changes buffer (like when it is
 270         ;; set to display picons outside of the article buffer), BEG
 271         ;; and END still refer the buffer current now !
 272         (let ((buf (current-buffer)))
 273           (gnus-picons-set-buffer)
 274           (gnus-picons-make-annotation
 275            (vector 'xface
 276                    :data (concat "X-Face: " (buffer-substring beg end buf)))
 277            nil 'text nil nil nil t)))
 278     ;; convert the x-face header to a .xbm file
 279     (let* ((process-connection-type nil)
 280            (process (start-process-shell-command "gnus-x-face" nil
 281                                                  gnus-picons-convert-x-face)))
 282       (push process gnus-picons-processes-alist)
 283       (process-kill-without-query process)
 284       (set-process-sentinel process 'gnus-picons-x-face-sentinel)
 285       (process-send-region process beg end)
 286       (process-send-eof process))))
 287
 288 (defun gnus-article-display-picons ()
 289   "Display faces for an author and her domain in gnus-picons-display-where."
 290   (interactive)
 291   (let (from at-idx)
 292     (when (and (featurep 'xpm)
 293                (or (not (fboundp 'device-type)) (equal (device-type) 'x))
 294                (setq from (mail-fetch-field "from"))
 295                (setq from (downcase (or (cadr (mail-extract-address-components
 296                                                from))
 297                                         "")))
 298                (or (setq at-idx (string-match "@" from))
 299                    (setq at-idx (length from))))
 300       (save-excursion
 301         (let ((username (downcase (substring from 0 at-idx)))
 302               (addrs (if (eq at-idx (length from))
 303                          (if gnus-local-domain
 304                              (message-tokenize-header gnus-local-domain "."))
 305                        (message-tokenize-header (substring from (1+ at-idx))
 306                                                 "."))))
 307           (gnus-picons-prepare-for-annotations)
 308           (gnus-group-display-picons)
 309           (if (null gnus-picons-piconsearch-url)
 310               (progn
 311                 (gnus-picons-display-pairs (gnus-picons-lookup-pairs
 312                                             addrs
 313                                             gnus-picons-domain-directories)
 314                                            gnus-picons-display-as-address
 315                                            "." t)
 316                 (if (and gnus-picons-display-as-address addrs)
 317                     (gnus-picons-make-annotation
 318                      [string :data "@"] nil 'text nil nil nil t))
 319                 (gnus-picons-display-picon-or-name
 320                  (gnus-picons-lookup-user username addrs)
 321                  username t))
 322             (push (list 'gnus-article-annotations 'search username addrs
 323                         gnus-picons-domain-directories t)
 324                   gnus-picons-jobs-alist)
 325             (gnus-picons-next-job)))))))
 326
 327 (defun gnus-group-display-picons ()
 328   "Display icons for the group in the `gnus-picons-display-where' buffer."
 329   (interactive)
 330   (when (and (featurep 'xpm)
 331              (or (not (fboundp 'device-type)) (equal (device-type) 'x))
 332              (or (null gnus-picons-group-excluded-groups)
 333                  (not (string-match gnus-picons-group-excluded-groups
 334                                     gnus-newsgroup-name))))
 335     (save-excursion
 336       (gnus-picons-prepare-for-annotations)
 337       (if (null gnus-picons-piconsearch-url)
 338           (gnus-picons-display-pairs
 339                  (gnus-picons-lookup-pairs
 340                   (reverse (message-tokenize-header
 341                             (gnus-group-real-name gnus-newsgroup-name)
 342                             "."))
 343                   gnus-picons-news-directories)
 344                  t ".")
 345         (push (list 'gnus-group-annotations 'search nil
 346                     (message-tokenize-header
 347                      (gnus-group-real-name gnus-newsgroup-name) ".")
 348                     (if (listp gnus-picons-news-directories)
 349                         gnus-picons-news-directories
 350                       (list gnus-picons-news-directories))
 351                     nil)
 352               gnus-picons-jobs-alist)
 353         (gnus-picons-next-job))
 354
 355       (add-hook 'gnus-summary-exit-hook 'gnus-picons-remove-all))))
 356
 357 (defun gnus-picons-lookup-internal (addrs dir)
 358   (setq dir (expand-file-name dir gnus-picons-database))
 359   (gnus-picons-try-face (dolist (part (reverse addrs) dir)
 360                           (setq dir (expand-file-name part dir)))))
 361
 362 (defun gnus-picons-lookup (addrs dirs)
 363   "Lookup the picon for ADDRS in databases DIRS.
 364 Returns the picon filename or NIL if none found."
 365   (let (result)
 366     (while (and dirs (null result))
 367       (setq result (gnus-picons-lookup-internal addrs (pop dirs))))
 368     result))
 369
 370 (defun gnus-picons-lookup-user-internal (user domains)
 371   (let ((dirs gnus-picons-user-directories)
 372         domains-tmp dir picon)
 373     (while (and dirs (null picon))
 374       (setq domains-tmp domains
 375             dir (pop dirs))
 376       (while (and domains-tmp
 377                   (null (setq picon (gnus-picons-lookup-internal
 378                                      (cons user domains-tmp) dir))))
 379         (pop domains-tmp))
 380       ;; Also make a try in MISC subdir
 381       (unless picon
 382         (setq picon (gnus-picons-lookup-internal (list user "MISC") dir))))
 383     picon))
 384
 385 (defun gnus-picons-lookup-user (user domains)
 386   "Lookup the picon for USER at DOMAINS.
 387 USER is a string containing a name.
 388 DOMAINS is a list of strings from the fully qualified domain name."
 389   (or (gnus-picons-lookup-user-internal user domains)
 390       (gnus-picons-lookup-user-internal "unknown" domains)))
 391
 392 (defun gnus-picons-lookup-pairs (domains directories)
 393   "Lookup picons for DOMAINS and all its parents in DIRECTORIES.
 394 Returns a list of PAIRS whose CAR is the picon filename or NIL if
 395 none, and whose CDR is the corresponding element of DOMAINS."
 396   (let (picons)
 397     (setq directories (if (listp directories)
 398                           directories
 399                         (list directories)))
 400     (while domains
 401       (push (list (gnus-picons-lookup (cons "unknown" domains) directories)
 402                   (pop domains))
 403             picons))
 404     picons))
 405
 406 (defun gnus-picons-display-picon-or-name (picon name &optional right-p)
 407   (cond (picon (gnus-picons-display-glyph picon name right-p))
 408         (gnus-picons-display-as-address (list (gnus-picons-make-annotation
 409                                                (vector 'string :data name)
 410                                                nil 'text
 411                                                nil nil nil right-p)))))
 412
 413 (defun gnus-picons-display-pairs (pairs &optional bar-p dot-p right-p)
 414   "Display picons in list PAIRS."
 415   (let ((domain-p (and gnus-picons-display-as-address dot-p))
 416         pair picons)
 417     (when (and bar-p domain-p right-p)
 418       (setq picons (gnus-picons-display-glyph
 419                     (let ((gnus-picons-file-suffixes '("xbm")))
 420                       (gnus-picons-try-face
 421                        gnus-xmas-glyph-directory "bar."))
 422                     nil right-p)))
 423     (while (setq pair (pop pairs))
 424       (setq picons (nconc picons
 425                           (gnus-picons-display-picon-or-name
 426                            (car pair) (cadr pair) right-p)
 427                           (if (and domain-p pairs)
 428                               (list (gnus-picons-make-annotation
 429                                      (vector 'string :data dot-p)
 430                                      nil 'text nil nil nil right-p))))))
 431     picons))
 432
 433 (defun gnus-picons-try-face (dir &optional filebase)
 434   (let* ((dir (file-name-as-directory dir))
 435          (filebase (or filebase "face."))
 436          (key (concat dir filebase))
 437          (glyph (cdr (assoc key gnus-picons-glyph-alist)))
 438          (suffixes gnus-picons-file-suffixes)
 439          f suf)
 440     (while (setq suf (pop suffixes))
 441       (when (file-exists-p (setq f (expand-file-name
 442                                     (concat filebase suf)
 443                                     dir)))
 444         (setq suffixes nil
 445               glyph (make-glyph f))
 446         (when (equal suf "xbm")
 447           (set-glyph-face glyph 'gnus-picons-xbm-face))
 448         (push (cons key glyph) gnus-picons-glyph-alist)))
 449     glyph))
 450
 451 (defun gnus-picons-display-glyph (glyph &optional part rightp)
 452   (let ((new (gnus-picons-make-annotation
 453               glyph (point) 'text nil nil nil rightp)))
 454     (when (and part gnus-picons-display-as-address)
 455       (set-annotation-data
 456        new (cons new (make-glyph (vector 'string :data part))))
 457       (set-annotation-action new 'gnus-picons-action-toggle))
 458     (nconc
 459      (list new)
 460      (if (and (eq major-mode 'gnus-article-mode)
 461               (not gnus-picons-display-as-address)
 462               (not part))
 463          (list (gnus-picons-make-annotation [string :data " "] (point)
 464                                             'text nil nil nil rightp))))))
 465
 466 (defun gnus-picons-action-toggle (data)
 467   "Toggle annotation"
 468   (interactive "e")
 469   (let* ((annot (car data))
 470          (glyph (annotation-glyph annot)))
 471     (set-annotation-glyph annot (cdr data))
 472     (set-annotation-data annot (cons annot glyph))))
 473
 474 (defun gnus-picons-clear-cache ()
 475   "Clear the picons cache"
 476   (interactive)
 477   (setq gnus-picons-glyph-alist nil
 478         gnus-picons-url-alist nil))
 479
 480 (gnus-add-shutdown 'gnus-picons-close 'gnus)
 481
 482 (defun gnus-picons-close ()
 483   "Shut down the picons."
 484   (if gnus-picons-clear-cache-on-shutdown
 485       (gnus-picons-clear-cache)))
 486
 487 ;;; Query a remote DB.  This requires some stuff from w3 !
 488
 489 (require 'url)
 490 (require 'w3-forms)
 491
 492 (defun gnus-picons-url-retrieve (url fn arg)
 493   (let ((old-asynch (default-value 'url-be-asynchronous))
 494         (url-working-buffer (generate-new-buffer " *picons*"))
 495         (url-package-name "Gnus")
 496         (url-package-version gnus-version-number)
 497         url-request-method)
 498     (setq-default url-be-asynchronous t)
 499     (save-excursion
 500       (set-buffer url-working-buffer)
 501       (setq url-be-asynchronous t
 502             url-current-callback-data arg
 503             url-current-callback-func fn)
 504       (url-retrieve url t))
 505     (setq-default url-be-asynchronous old-asynch)))
 506
 507 (defun gnus-picons-make-glyph (type)
 508   "Make a TYPE glyph using current buffer as data.  Handles xbm nicely."
 509   (cond ((null type) nil)
 510         ((eq type 'xbm) (let ((fname (make-temp-name "/tmp/picon")))
 511                           (write-region (point-min) (point-max) fname
 512                                         nil 'quiet)
 513                           (prog1 (make-glyph (vector 'xbm :file fname))
 514                             (delete-file fname))))
 515         (t (make-glyph (vector type :data (buffer-string))))))
 516
 517 ;;; Parsing of piconsearch result page.
 518
 519 ;; Assumes:
 520 ;; 1 - each value field has the form: "<strong>key</strong> = <kbd>value</kbd>"
 521 ;; 2 - a "<p>" separates the keywords from the results
 522 ;; 3 - every results begins by the path within the database at the beginning
 523 ;;     of the line in raw text.
 524 ;; 3b - and the href following it is the preferred image type.
 525
 526 ;; if 1 or 2 is not met, it will probably cause an error.  The other
 527 ;; will go undetected
 528
 529 (defun gnus-picons-parse-value (name)
 530   (goto-char (point-min))
 531   (re-search-forward (concat "<strong>"
 532                              (regexp-quote name)
 533                              "</strong> *= *<kbd> *\\([^ <][^<]*\\) *</kbd>"))
 534   (buffer-substring (match-beginning 1) (match-end 1)))
 535
 536 (defun gnus-picons-parse-filenames ()
 537   ;; returns an alist of ((USER ADDRS DB) . URL)
 538   (let* ((case-fold-search t)
 539          (user (gnus-picons-parse-value "user"))
 540          (host (gnus-picons-parse-value "host"))
 541          (dbs (message-tokenize-header (gnus-picons-parse-value "db") " "))
 542          (start-re
 543           (concat
 544            ;; dbs
 545            "^\\(" (mapconcat 'identity dbs "\\|") "\\)/"
 546            ;; host
 547            "\\(\\(" (replace-in-string host "\\." "/\\|" t) "/\\|MISC/\\)*\\)"
 548            ;; user
 549            "\\(" (regexp-quote user) "\\|unknown\\)/"
 550            "face\\."))
 551          cur-db cur-host cur-user types res)
 552     ;; now point will be somewhere in the header.  Find beginning of
 553     ;; entries
 554     (re-search-forward "<p>[ \t\n]*")
 555     (while (re-search-forward start-re nil t)
 556       (setq cur-db (buffer-substring (match-beginning 1) (match-end 1))
 557             cur-host (buffer-substring (match-beginning 2) (match-end 2))
 558             cur-user (buffer-substring (match-beginning 4) (match-end 4))
 559             cur-host (nreverse (message-tokenize-header cur-host "/")))
 560       ;; XXX - KLUDGE: there is a blank picon in news/MISC/unknown
 561       (unless (and (string-equal cur-db "news")
 562                    (string-equal cur-user "unknown")
 563                    (equal cur-host '("MISC")))
 564         ;; ok now we have found an entry (USER HOST DB), find the
 565         ;; corresponding picon URL
 566         (save-restriction
 567           ;; restrict region to this entry
 568           (narrow-to-region (point) (search-forward "<br>"))
 569           (goto-char (point-min))
 570           (setq types gnus-picons-file-suffixes)
 571           (while (and types
 572                       (not (re-search-forward
 573                             (concat "<a[ \t\n]+href=\"\\([^\"]*\\."
 574                                     (regexp-quote (car types)) "\\)\"")
 575                             nil t)))
 576             (pop types))
 577           (push (cons (list cur-user cur-host cur-db)
 578                       (buffer-substring (match-beginning 1) (match-end 1)))
 579                 res))))
 580     (nreverse res)))
 581
 582 ;;; picon network display functions :
 583
 584 (defun gnus-picons-network-display-internal (sym-ann glyph part right-p)
 585   (gnus-picons-set-buffer)
 586   (gnus-picons-display-picon-or-name glyph part right-p)
 587   (gnus-picons-next-job-internal))
 588
 589 (defun gnus-picons-network-display-callback (url part sym-ann right-p)
 590   (let ((glyph (gnus-picons-make-glyph (cdr (assoc url-current-mime-type
 591                                                    w3-image-mappings)))))
 592     (kill-buffer (current-buffer))
 593     (push (cons url glyph) gnus-picons-glyph-alist)
 594     ;; only do the job if it has not been preempted.
 595     (if (equal gnus-picons-job-already-running
 596                (list sym-ann 'picon url part right-p))
 597         (gnus-picons-network-display-internal sym-ann glyph part right-p)
 598       (gnus-picons-next-job-internal))))
 599
 600 (defun gnus-picons-network-display (url part sym-ann right-p)
 601   (let ((cache (assoc url gnus-picons-glyph-alist)))
 602     (if (or cache (null url))
 603         (gnus-picons-network-display-internal sym-ann (cdr cache) part right-p)
 604       (gnus-picons-url-retrieve url 'gnus-picons-network-display-callback
 605                                 (list url part sym-ann right-p)))))
 606
 607 ;;; search job functions
 608
 609 (defun gnus-picons-network-search-internal (user addrs dbs sym-ann right-p
 610                                                  &optional fnames)
 611   (let (curkey dom pfx url dbs-tmp cache new-jobs)
 612     ;; First do the domain search
 613     (dolist (part (if right-p
 614                       (reverse addrs)
 615                     addrs))
 616       (setq pfx (nconc (list part) pfx)
 617             dom (cond ((and dom right-p) (concat part "." dom))
 618                       (dom (concat dom "." part))
 619                       (t part))
 620             curkey (list "unknown" dom dbs))
 621       (when (null (setq cache (assoc curkey gnus-picons-url-alist)))
 622         ;; This one is not yet in the cache, create a new entry
 623         ;; Search for an entry
 624         (setq dbs-tmp dbs
 625               url nil)
 626         (while (and dbs-tmp (null url))
 627           (setq url (or (cdr (assoc (list "unknown" pfx (car dbs-tmp)) fnames))
 628                         (and (eq dom part)
 629                              ;; This is the first component.  Try the
 630                              ;; catch-all MISC component
 631                              (cdr (assoc (list "unknown"
 632                                                '("MISC")
 633                                                (car dbs-tmp))
 634                                          fnames)))))
 635           (pop dbs-tmp))
 636         (push (setq cache (cons curkey url)) gnus-picons-url-alist))
 637       ;; Put this glyph in the job list
 638       (if (and (not (eq dom part)) gnus-picons-display-as-address)
 639           (push (list sym-ann "." right-p) new-jobs))
 640       (push (list sym-ann 'picon (cdr cache) part right-p) new-jobs))
 641     ;; next, the user search
 642     (when user
 643       (setq curkey (list user dom gnus-picons-user-directories))
 644       (if (null (setq cache (assoc curkey gnus-picons-url-alist)))
 645           (let ((users (list user "unknown"))
 646                 dirs usr domains-tmp dir picon)
 647             (while (and users (null picon))
 648               (setq dirs gnus-picons-user-directories
 649                     usr (pop users))
 650               (while (and dirs (null picon))
 651                 (setq domains-tmp addrs
 652                       dir (pop dirs))
 653                 (while (and domains-tmp
 654                             (null (setq picon (assoc (list usr domains-tmp dir)
 655                                                      fnames))))
 656                   (pop domains-tmp))
 657                 (unless picon
 658                   (setq picon (assoc (list usr '("MISC") dir) fnames)))))
 659             (push (setq cache (cons curkey (cdr picon)))
 660                   gnus-picons-url-alist)))
 661       (if (and gnus-picons-display-as-address new-jobs)
 662           (push (list sym-ann "@" right-p) new-jobs))
 663       (push (list sym-ann 'picon (cdr cache) user right-p) new-jobs))
 664     (if (and gnus-picons-display-as-address (not right-p))
 665         (push (list sym-ann 'bar right-p) new-jobs))
 666     ;; only put the jobs in the queue if this job has not been preempted.
 667     (if (equal gnus-picons-job-already-running
 668                (list sym-ann 'search user addrs dbs right-p))
 669         (setq gnus-picons-jobs-alist
 670               (nconc (if (and gnus-picons-display-as-address right-p)
 671                          (list (list sym-ann 'bar right-p)))
 672                      (nreverse new-jobs)
 673                      gnus-picons-jobs-alist)))
 674     (gnus-picons-next-job-internal)))
 675
 676 (defun gnus-picons-network-search-callback (user addrs dbs sym-ann right-p)
 677   (gnus-picons-network-search-internal user addrs dbs sym-ann right-p
 678                                        (prog1 (gnus-picons-parse-filenames)
 679                                          (kill-buffer (current-buffer)))))
 680
 681 ;; Initiate a query on the picon database
 682 (defun gnus-picons-network-search (user addrs dbs sym-ann right-p)
 683   (let* ((host (mapconcat 'identity addrs "."))
 684          (key (list (or user "unknown") host (if user
 685                                                   gnus-picons-user-directories
 686                                                 dbs)))
 687          (cache (assoc key gnus-picons-url-alist)))
 688     (if (null cache)
 689         (gnus-picons-url-retrieve
 690          (concat gnus-picons-piconsearch-url
 691                  "?user=" (w3-form-encode-xwfu (or user "unknown"))
 692                  "&host=" (w3-form-encode-xwfu host)
 693                  "&db=" (mapconcat 'w3-form-encode-xwfu
 694                                    (if user
 695                                        (append dbs
 696                                                gnus-picons-user-directories)
 697                                      dbs)
 698                                    "+"))
 699          'gnus-picons-network-search-callback
 700          (list user addrs dbs sym-ann right-p))
 701       (gnus-picons-network-search-internal user addrs dbs sym-ann right-p))))
 702
 703 ;;; Main jobs dispatcher function
 704
 705 (defun gnus-picons-next-job-internal ()
 706   (if (setq gnus-picons-job-already-running (pop gnus-picons-jobs-alist))
 707       (let* ((job gnus-picons-job-already-running)
 708              (sym-ann (pop job))
 709              (tag (pop job)))
 710         (if tag
 711             (cond ((stringp tag);; (SYM-ANN "..." RIGHT-P)
 712                    (gnus-picons-network-display-internal sym-ann nil tag
 713                                                          (pop job)))
 714                   ((eq 'bar tag)
 715                    (gnus-picons-network-display-internal
 716                     sym-ann
 717                     (let ((gnus-picons-file-suffixes '("xbm")))
 718                       (gnus-picons-try-face
 719                        gnus-xmas-glyph-directory "bar."))
 720                     nil (pop job)))
 721                   ((eq 'search tag);; (SYM-ANN 'search USER ADDRS DBS RIGHT-P)
 722                    (gnus-picons-network-search
 723                     (pop job) (pop job) (pop job) sym-ann (pop job)))
 724                   ((eq 'picon tag);; (SYM-ANN 'picon URL PART RIGHT-P)
 725                    (gnus-picons-network-display
 726                     (pop job) (pop job) sym-ann (pop job)))
 727                   (t (setq gnus-picons-job-already-running nil)
 728                      (error "Unknown picon job tag %s" tag)))))))
 729
 730 (defun gnus-picons-next-job ()
 731   "Start processing the job queue if it is not in progress"
 732   (unless gnus-picons-job-already-running
 733     (gnus-picons-next-job-internal)))
 734
 735 (provide 'gnus-picon)
 736
 737 ;;; gnus-picon.el ends here