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 nil
 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 xbm picons in."
 149   :group 'picons)
 150
 151 (defcustom gnus-picons-setup-hook nil
 152   "Hook run in Picons buffers."
 153   :group 'picons
 154   :type 'hook)
 155
 156 ;;; Internal variables:
 157
 158 (defvar gnus-picons-processes-alist nil
 159   "Picons processes currently running and their environment.")
 160 (defvar gnus-picons-glyph-alist nil
 161   "Picons glyphs cache.
 162 List of pairs (KEY . GLYPH) where KEY is either a filename or an URL.")
 163 (defvar gnus-picons-url-alist nil
 164   "Picons file names cache.
 165 List of pairs (KEY . NAME) where KEY is (USER HOST DBS) and NAME is an URL.")
 166
 167 (defvar gnus-picons-jobs-alist nil
 168   "List of jobs that still need be done.
 169 This is a list of (SYM-ANN TAG ARGS...) where SYM-ANN three annotations list,
 170 TAG is one of `picon' or `search' indicating that the job should query a
 171 picon or do a search for picons file names, and ARGS is some additionnal
 172 arguments necessary for the job.")
 173
 174 (defvar gnus-picons-job-already-running nil
 175   "Lock to ensure only one stream of http requests is running.")
 176
 177 ;;; Functions:
 178
 179 (defun gnus-picons-remove-all ()
 180   "Removes all picons from the Gnus display(s)."
 181   (interactive)
 182   (map-extents (function (lambda (ext unused) (delete-annotation ext) nil))
 183                nil nil nil nil nil 'gnus-picon)
 184   (setq gnus-picons-jobs-alist '())
 185   ;; notify running job that it may have been preempted
 186   (if (and (listp gnus-picons-job-already-running)
 187            gnus-picons-job-already-running)
 188       (setq gnus-picons-job-already-running t)))
 189
 190 (defun gnus-get-buffer-name (variable)
 191   "Returns the buffer name associated with the contents of a variable."
 192   (let ((buf (gnus-get-buffer-create
 193               (gnus-window-to-buffer-helper
 194                (cdr (assq variable gnus-window-to-buffer))))))
 195     (and buf
 196          (buffer-name buf))))
 197
 198 (defun gnus-picons-buffer-name ()
 199   (cond ((or (stringp gnus-picons-display-where)
 200              (bufferp gnus-picons-display-where))
 201          gnus-picons-display-where)
 202         ((eq gnus-picons-display-where 'picons)
 203          (if gnus-single-article-buffer
 204              "*Picons*"
 205            (concat "*Picons " gnus-newsgroup-name "*")))
 206         (t
 207          (gnus-get-buffer-name gnus-picons-display-where))))
 208
 209 (defun gnus-picons-kill-buffer ()
 210   (let ((buf (get-buffer (gnus-picons-buffer-name))))
 211     (when (buffer-live-p buf)
 212       (kill-buffer buf))))
 213
 214 (defun gnus-picons-setup-buffer ()
 215   (let ((name (gnus-picons-buffer-name)))
 216     (save-excursion
 217       (if (get-buffer name)
 218           (set-buffer name)
 219         (set-buffer (gnus-get-buffer-create name))
 220         (buffer-disable-undo)
 221         (setq buffer-read-only t)
 222         (run-hooks 'gnus-picons-setup-hook)
 223         (add-hook 'gnus-summary-prepare-exit-hook 'gnus-picons-kill-buffer))
 224       (current-buffer))))
 225
 226 (defun gnus-picons-set-buffer ()
 227   (set-buffer (gnus-picons-setup-buffer))
 228   (goto-char (point-min))
 229   (if (and (eq gnus-picons-display-where 'article)
 230            gnus-picons-display-article-move-p)
 231       (if (search-forward "\n\n" nil t)
 232           (forward-line -1)
 233         (goto-char (point-max)))
 234     (setq buffer-read-only t)
 235     (unless gnus-picons-has-modeline-p
 236       (set-specifier has-modeline-p
 237                      (list (list (current-buffer)
 238                                  (cons nil gnus-picons-has-modeline-p)))))))
 239
 240 (defun gnus-picons-prepare-for-annotations ()
 241   "Prepare picons buffer for putting annotations."
 242   ;; let drawing catch up
 243   (when gnus-picons-refresh-before-display
 244     (sit-for 0))
 245   (gnus-picons-set-buffer)
 246   (gnus-picons-remove-all))
 247
 248 (defun gnus-picons-make-annotation (&rest args)
 249   (let ((annot (apply 'make-annotation args)))
 250     (set-extent-property annot 'gnus-picon t)
 251     (set-extent-property annot 'duplicable t)
 252     annot))
 253
 254 (defun gnus-picons-article-display-x-face ()
 255   "Display the x-face header bitmap in the 'gnus-picons-display-where buffer."
 256   (let ((gnus-article-x-face-command 'gnus-picons-display-x-face))
 257     (gnus-article-display-x-face)))
 258
 259 (defun gnus-picons-x-face-sentinel (process event)
 260   (when (memq process gnus-picons-processes-alist)
 261     (setq gnus-picons-processes-alist
 262           (delq process gnus-picons-processes-alist))
 263     (gnus-picons-set-buffer)
 264     (gnus-picons-make-annotation (make-glyph gnus-picons-x-face-file-name)
 265                                  nil 'text)
 266     (when (file-exists-p gnus-picons-x-face-file-name)
 267       (delete-file gnus-picons-x-face-file-name))))
 268
 269 (defun gnus-picons-display-x-face (beg end)
 270   "Function to display the x-face header in the picons window.
 271 To use:  (setq gnus-article-x-face-command 'gnus-picons-display-x-face)"
 272   (interactive)
 273   (if (featurep 'xface)
 274       ;; Use builtin support
 275       (save-excursion
 276         ;; Don't remove this binding, it is really needed: when
 277         ;; `gnus-picons-set-buffer' changes buffer (like when it is
 278         ;; set to display picons outside of the article buffer), BEG
 279         ;; and END still refer the buffer current now !
 280         (let ((buf (current-buffer)))
 281           (gnus-picons-set-buffer)
 282           (gnus-picons-make-annotation
 283            (vector 'xface
 284                    :data (concat "X-Face: " (buffer-substring beg end buf)))
 285            nil 'text nil nil nil t)))
 286     ;; convert the x-face header to a .xbm file
 287     (let* ((process-connection-type nil)
 288            (process (start-process-shell-command "gnus-x-face" nil
 289                                                  gnus-picons-convert-x-face)))
 290       (push process gnus-picons-processes-alist)
 291       (process-kill-without-query process)
 292       (set-process-sentinel process 'gnus-picons-x-face-sentinel)
 293       (process-send-region process beg end)
 294       (process-send-eof process))))
 295
 296 (defun gnus-article-display-picons ()
 297   "Display faces for an author and her domain in gnus-picons-display-where."
 298   (interactive)
 299   (let (from at-idx)
 300     (when (and (featurep 'xpm)
 301                (or (not (fboundp 'device-type)) (equal (device-type) 'x))
 302                (setq from (mail-fetch-field "from"))
 303                (setq from (downcase (or (cadr (mail-extract-address-components
 304                                                from))
 305                                         "")))
 306                (or (setq at-idx (string-match "@" from))
 307                    (setq at-idx (length from))))
 308       (save-excursion
 309         (let ((username (downcase (substring from 0 at-idx)))
 310               (addrs (if (eq at-idx (length from))
 311                          (if gnus-local-domain
 312                              (message-tokenize-header gnus-local-domain "."))
 313                        (message-tokenize-header (substring from (1+ at-idx))
 314                                                 "."))))
 315           (gnus-picons-prepare-for-annotations)
 316           (gnus-group-display-picons)
 317           (unless gnus-picons-display-article-move-p
 318             (save-restriction
 319               (let ((buffer-read-only nil))
 320                 (when (re-search-forward "^From: " nil t)
 321                   (narrow-to-region (point) (gnus-point-at-eol))
 322                   (when (search-forward from nil t)
 323                     (gnus-put-text-property
 324                      (match-beginning 0) (match-end 0)
 325                      'invisible t))))))
 326           (if (null gnus-picons-piconsearch-url)
 327               (progn
 328                 (gnus-picons-display-pairs (gnus-picons-lookup-pairs
 329                                             addrs
 330                                             gnus-picons-domain-directories)
 331                                            gnus-picons-display-as-address
 332                                            "." t)
 333                 (if (and gnus-picons-display-as-address addrs)
 334                     (gnus-picons-make-annotation
 335                      [string :data "@"] nil 'text nil nil nil t))
 336                 (gnus-picons-display-picon-or-name
 337                  (gnus-picons-lookup-user username addrs)
 338                  username t))
 339             (push (list 'gnus-article-annotations 'search username addrs
 340                         gnus-picons-domain-directories t)
 341                   gnus-picons-jobs-alist)
 342             (gnus-picons-next-job)))))))
 343
 344 (defun gnus-group-display-picons ()
 345   "Display icons for the group in the `gnus-picons-display-where' buffer."
 346   (interactive)
 347   (when (and (featurep 'xpm)
 348              (or (not (fboundp 'device-type)) (equal (device-type) 'x))
 349              (or (null gnus-picons-group-excluded-groups)
 350                  (not (string-match gnus-picons-group-excluded-groups
 351                                     gnus-newsgroup-name))))
 352     (let* ((newsgroups (mail-fetch-field "newsgroups"))
 353            (groups
 354             (if (or gnus-picons-display-article-move-p
 355                     (not newsgroups))(mail-fetch-field "newsgroups")
 356                 (list (gnus-group-real-name gnus-newsgroup-name))
 357               (split-string newsgroups ",")))
 358            group)
 359       (save-excursion
 360         (gnus-picons-prepare-for-annotations)
 361         (while (setq group (pop groups))
 362           (unless gnus-picons-display-article-move-p
 363             (save-restriction
 364               (let ((buffer-read-only nil))
 365                 (goto-char (point-min))
 366                 (when (re-search-forward "^Newsgroups:" nil t)
 367                   (narrow-to-region (point) (gnus-point-at-eol))
 368                   (when (search-forward group nil t)
 369                     (gnus-put-text-property
 370                      (match-beginning 0) (match-end 0)
 371                      'invisible t))))))
 372           (if (null gnus-picons-piconsearch-url)
 373               (gnus-picons-display-pairs
 374                (gnus-picons-lookup-pairs
 375                 (reverse (split-string group "\\."))
 376                 gnus-picons-news-directories)
 377                t ".")
 378             (push (list 'gnus-group-annotations 'search nil
 379                         (split-string group "\\.")
 380                         (if (listp gnus-picons-news-directories)
 381                             gnus-picons-news-directories
 382                           (list gnus-picons-news-directories))
 383                         nil)
 384                   gnus-picons-jobs-alist)
 385             (gnus-picons-next-job))
 386
 387           (add-hook 'gnus-summary-exit-hook 'gnus-picons-remove-all))))))
 388
 389 (defun gnus-picons-lookup-internal (addrs dir)
 390   (setq dir (expand-file-name dir gnus-picons-database))
 391   (gnus-picons-try-face (dolist (part (reverse addrs) dir)
 392                           (setq dir (expand-file-name part dir)))))
 393
 394 (defun gnus-picons-lookup (addrs dirs)
 395   "Lookup the picon for ADDRS in databases DIRS.
 396 Returns the picon filename or NIL if none found."
 397   (let (result)
 398     (while (and dirs (null result))
 399       (setq result (gnus-picons-lookup-internal addrs (pop dirs))))
 400     result))
 401
 402 (defun gnus-picons-lookup-user-internal (user domains)
 403   (let ((dirs gnus-picons-user-directories)
 404         domains-tmp dir picon)
 405     (while (and dirs (null picon))
 406       (setq domains-tmp domains
 407             dir (pop dirs))
 408       (while (and domains-tmp
 409                   (null (setq picon (gnus-picons-lookup-internal
 410                                      (cons user domains-tmp) dir))))
 411         (pop domains-tmp))
 412       ;; Also make a try in MISC subdir
 413       (unless picon
 414         (setq picon (gnus-picons-lookup-internal (list user "MISC") dir))))
 415     picon))
 416
 417 (defun gnus-picons-lookup-user (user domains)
 418   "Lookup the picon for USER at DOMAINS.
 419 USER is a string containing a name.
 420 DOMAINS is a list of strings from the fully qualified domain name."
 421   (or (gnus-picons-lookup-user-internal user domains)
 422       (gnus-picons-lookup-user-internal "unknown" domains)))
 423
 424 (defun gnus-picons-lookup-pairs (domains directories)
 425   "Lookup picons for DOMAINS and all its parents in DIRECTORIES.
 426 Returns a list of PAIRS whose CAR is the picon filename or NIL if
 427 none, and whose CDR is the corresponding element of DOMAINS."
 428   (let (picons)
 429     (setq directories (if (listp directories)
 430                           directories
 431                         (list directories)))
 432     (while domains
 433       (push (list (gnus-picons-lookup (cons "unknown" domains) directories)
 434                   (pop domains))
 435             picons))
 436     picons))
 437
 438 (defun gnus-picons-display-picon-or-name (picon name &optional right-p)
 439   (cond (picon (gnus-picons-display-glyph picon name right-p))
 440         (gnus-picons-display-as-address (list (gnus-picons-make-annotation
 441                                                (vector 'string :data name)
 442                                                nil 'text
 443                                                nil nil nil right-p)))))
 444
 445 (defun gnus-picons-display-pairs (pairs &optional bar-p dot-p right-p)
 446   "Display picons in list PAIRS."
 447   (let ((domain-p (and gnus-picons-display-as-address dot-p))
 448         pair picons)
 449     (when (and bar-p domain-p right-p
 450                gnus-picons-display-article-move-p)
 451       (setq picons (gnus-picons-display-glyph
 452                     (let ((gnus-picons-file-suffixes '("xbm")))
 453                       (gnus-picons-try-face
 454                        gnus-xmas-glyph-directory "bar."))
 455                     nil right-p)))
 456     (while (setq pair (pop pairs))
 457       (setq picons (nconc picons
 458                           (gnus-picons-display-picon-or-name
 459                            (car pair) (cadr pair) right-p)
 460                           (if (and domain-p pairs)
 461                               (list (gnus-picons-make-annotation
 462                                      (vector 'string :data dot-p)
 463                                      nil 'text nil nil nil right-p))))))
 464     picons))
 465
 466 (defun gnus-picons-try-face (dir &optional filebase)
 467   (let* ((dir (file-name-as-directory dir))
 468          (filebase (or filebase "face."))
 469          (key (concat dir filebase))
 470          (glyph (cdr (assoc key gnus-picons-glyph-alist)))
 471          (suffixes gnus-picons-file-suffixes)
 472          f suf)
 473     (while (setq suf (pop suffixes))
 474       (when (file-exists-p (setq f (expand-file-name
 475                                     (concat filebase suf)
 476                                     dir)))
 477         (setq suffixes nil
 478               glyph (make-glyph f))
 479         (when (equal suf "xbm")
 480           (set-glyph-face glyph 'gnus-picons-xbm-face))
 481         (push (cons key glyph) gnus-picons-glyph-alist)))
 482     glyph))
 483
 484 (defun gnus-picons-display-glyph (glyph &optional part rightp)
 485   (set-glyph-baseline glyph 70)
 486   (let ((new (gnus-picons-make-annotation
 487               glyph (point) 'text nil nil nil rightp)))
 488     (when (and part gnus-picons-display-as-address)
 489       (set-annotation-data
 490        new (cons new (make-glyph (vector 'string :data part))))
 491       (set-annotation-action new 'gnus-picons-action-toggle))
 492     (nconc
 493      (list new)
 494      (if (and (eq major-mode 'gnus-article-mode)
 495               (not gnus-picons-display-as-address)
 496               (not part))
 497          (list (gnus-picons-make-annotation [string :data " "] (point)
 498                                             'text nil nil nil rightp))))))
 499
 500 (defun gnus-picons-action-toggle (data)
 501   "Toggle annotation."
 502   (interactive "e")
 503   (let* ((annot (car data))
 504          (glyph (annotation-glyph annot)))
 505     (set-annotation-glyph annot (cdr data))
 506     (set-annotation-data annot (cons annot glyph))))
 507
 508 (defun gnus-picons-clear-cache ()
 509   "Clear the picons cache."
 510   (interactive)
 511   (setq gnus-picons-glyph-alist nil
 512         gnus-picons-url-alist nil))
 513
 514 (gnus-add-shutdown 'gnus-picons-close 'gnus)
 515
 516 (defun gnus-picons-close ()
 517   "Shut down the picons."
 518   (if gnus-picons-clear-cache-on-shutdown
 519       (gnus-picons-clear-cache)))
 520
 521 ;;; Query a remote DB.  This requires some stuff from w3 !
 522
 523 (eval-and-compile
 524   (ignore-errors
 525     (require 'url)
 526     (require 'w3-forms)))
 527
 528 (defun gnus-picons-url-retrieve (url fn arg)
 529   (let ((old-asynch (default-value 'url-be-asynchronous))
 530         (url-working-buffer (generate-new-buffer " *picons*"))
 531         (url-package-name "Gnus")
 532         (url-package-version gnus-version-number)
 533         url-request-method)
 534     (setq-default url-be-asynchronous t)
 535     (save-excursion
 536       (set-buffer url-working-buffer)
 537       (setq url-be-asynchronous t
 538             url-current-callback-data arg
 539             url-current-callback-func fn)
 540       (url-retrieve url t))
 541     (setq-default url-be-asynchronous old-asynch)))
 542
 543 (defun gnus-picons-make-glyph (type)
 544   "Make a TYPE glyph using current buffer as data.  Handles xbm nicely."
 545   (cond ((null type) nil)
 546         ((eq type 'xbm) (let ((fname (make-temp-name "/tmp/picon")))
 547                           (write-region (point-min) (point-max) fname
 548                                         nil 'quiet)
 549                           (prog1 (make-glyph (vector 'xbm :file fname))
 550                             (delete-file fname))))
 551         (t (make-glyph (vector type :data (buffer-string))))))
 552
 553 ;;; Parsing of piconsearch result page.
 554
 555 ;; Assumes:
 556 ;; 1 - each value field has the form: "<strong>key</strong> = <kbd>value</kbd>"
 557 ;; 2 - a "<p>" separates the keywords from the results
 558 ;; 3 - every results begins by the path within the database at the beginning
 559 ;;     of the line in raw text.
 560 ;; 3b - and the href following it is the preferred image type.
 561
 562 ;; if 1 or 2 is not met, it will probably cause an error.  The other
 563 ;; will go undetected
 564
 565 (defun gnus-picons-parse-value (name)
 566   (goto-char (point-min))
 567   (re-search-forward (concat "<strong>"
 568                              (regexp-quote name)
 569                              "</strong> *= *<kbd> *\\([^ <][^<]*\\) *</kbd>"))
 570   (buffer-substring (match-beginning 1) (match-end 1)))
 571
 572 (defun gnus-picons-parse-filenames ()
 573   ;; returns an alist of ((USER ADDRS DB) . URL)
 574   (let* ((case-fold-search t)
 575          (user (gnus-picons-parse-value "user"))
 576          (host (gnus-picons-parse-value "host"))
 577          (dbs (message-tokenize-header (gnus-picons-parse-value "db") " "))
 578          (start-re
 579           (concat
 580            ;; dbs
 581            "^\\(" (mapconcat 'identity dbs "\\|") "\\)/"
 582            ;; host
 583            "\\(\\(" (replace-in-string host "\\." "/\\|" t) "/\\|MISC/\\)*\\)"
 584            ;; user
 585            "\\(" (regexp-quote user) "\\|unknown\\)/"
 586            "face\\."))
 587          cur-db cur-host cur-user types res)
 588     ;; now point will be somewhere in the header.  Find beginning of
 589     ;; entries
 590     (re-search-forward "<p>[ \t\n]*")
 591     (while (re-search-forward start-re nil t)
 592       (setq cur-db (buffer-substring (match-beginning 1) (match-end 1))
 593             cur-host (buffer-substring (match-beginning 2) (match-end 2))
 594             cur-user (buffer-substring (match-beginning 4) (match-end 4))
 595             cur-host (nreverse (message-tokenize-header cur-host "/")))
 596       ;; XXX - KLUDGE: there is a blank picon in news/MISC/unknown
 597       (unless (and (string-equal cur-db "news")
 598                    (string-equal cur-user "unknown")
 599                    (equal cur-host '("MISC")))
 600         ;; ok now we have found an entry (USER HOST DB), find the
 601         ;; corresponding picon URL
 602         (save-restriction
 603           ;; restrict region to this entry
 604           (narrow-to-region (point) (search-forward "<br>"))
 605           (goto-char (point-min))
 606           (setq types gnus-picons-file-suffixes)
 607           (while (and types
 608                       (not (re-search-forward
 609                             (concat "<a[ \t\n]+href=\"\\([^\"]*\\."
 610                                     (regexp-quote (car types)) "\\)\"")
 611                             nil t)))
 612             (pop types))
 613           (push (cons (list cur-user cur-host cur-db)
 614                       (buffer-substring (match-beginning 1) (match-end 1)))
 615                 res))))
 616     (nreverse res)))
 617
 618 ;;; picon network display functions :
 619
 620 (defun gnus-picons-network-display-internal (sym-ann glyph part right-p)
 621   (gnus-picons-set-buffer)
 622   (gnus-picons-display-picon-or-name glyph part right-p)
 623   (gnus-picons-next-job-internal))
 624
 625 (defun gnus-picons-network-display-callback (url part sym-ann right-p)
 626   (let ((glyph (gnus-picons-make-glyph (cdr (assoc url-current-mime-type
 627                                                    w3-image-mappings)))))
 628     (kill-buffer (current-buffer))
 629     (push (cons url glyph) gnus-picons-glyph-alist)
 630     ;; only do the job if it has not been preempted.
 631     (if (equal gnus-picons-job-already-running
 632                (list sym-ann 'picon url part right-p))
 633         (gnus-picons-network-display-internal sym-ann glyph part right-p)
 634       (gnus-picons-next-job-internal))))
 635
 636 (defun gnus-picons-network-display (url part sym-ann right-p)
 637   (let ((cache (assoc url gnus-picons-glyph-alist)))
 638     (if (or cache (null url))
 639         (gnus-picons-network-display-internal sym-ann (cdr cache) part right-p)
 640       (gnus-picons-url-retrieve url 'gnus-picons-network-display-callback
 641                                 (list url part sym-ann right-p)))))
 642
 643 ;;; search job functions
 644
 645 (defun gnus-picons-network-search-internal (user addrs dbs sym-ann right-p
 646                                                  &optional fnames)
 647   (let (curkey dom pfx url dbs-tmp cache new-jobs)
 648     ;; First do the domain search
 649     (dolist (part (if right-p
 650                       (reverse addrs)
 651                     addrs))
 652       (setq pfx (nconc (list part) pfx)
 653             dom (cond ((and dom right-p) (concat part "." dom))
 654                       (dom (concat dom "." part))
 655                       (t part))
 656             curkey (list "unknown" dom dbs))
 657       (when (null (setq cache (assoc curkey gnus-picons-url-alist)))
 658         ;; This one is not yet in the cache, create a new entry
 659         ;; Search for an entry
 660         (setq dbs-tmp dbs
 661               url nil)
 662         (while (and dbs-tmp (null url))
 663           (setq url (or (cdr (assoc (list "unknown" pfx (car dbs-tmp)) fnames))
 664                         (and (eq dom part)
 665                              ;; This is the first component.  Try the
 666                              ;; catch-all MISC component
 667                              (cdr (assoc (list "unknown"
 668                                                '("MISC")
 669                                                (car dbs-tmp))
 670                                          fnames)))))
 671           (pop dbs-tmp))
 672         (push (setq cache (cons curkey url)) gnus-picons-url-alist))
 673       ;; Put this glyph in the job list
 674       (if (and (not (eq dom part)) gnus-picons-display-as-address)
 675           (push (list sym-ann "." right-p) new-jobs))
 676       (push (list sym-ann 'picon (cdr cache) part right-p) new-jobs))
 677     ;; next, the user search
 678     (when user
 679       (setq curkey (list user dom gnus-picons-user-directories))
 680       (if (null (setq cache (assoc curkey gnus-picons-url-alist)))
 681           (let ((users (list user "unknown"))
 682                 dirs usr domains-tmp dir picon)
 683             (while (and users (null picon))
 684               (setq dirs gnus-picons-user-directories
 685                     usr (pop users))
 686               (while (and dirs (null picon))
 687                 (setq domains-tmp addrs
 688                       dir (pop dirs))
 689                 (while (and domains-tmp
 690                             (null (setq picon (assoc (list usr domains-tmp dir)
 691                                                      fnames))))
 692                   (pop domains-tmp))
 693                 (unless picon
 694                   (setq picon (assoc (list usr '("MISC") dir) fnames)))))
 695             (push (setq cache (cons curkey (cdr picon)))
 696                   gnus-picons-url-alist)))
 697       (if (and gnus-picons-display-as-address new-jobs)
 698           (push (list sym-ann "@" right-p) new-jobs))
 699       (push (list sym-ann 'picon (cdr cache) user right-p) new-jobs))
 700     (if (and gnus-picons-display-as-address (not right-p))
 701         (push (list sym-ann 'bar right-p) new-jobs))
 702     ;; only put the jobs in the queue if this job has not been preempted.
 703     (if (equal gnus-picons-job-already-running
 704                (list sym-ann 'search user addrs dbs right-p))
 705         (setq gnus-picons-jobs-alist
 706               (nconc (if (and gnus-picons-display-as-address right-p)
 707                          (list (list sym-ann 'bar right-p)))
 708                      (nreverse new-jobs)
 709                      gnus-picons-jobs-alist)))
 710     (gnus-picons-next-job-internal)))
 711
 712 (defun gnus-picons-network-search-callback (user addrs dbs sym-ann right-p)
 713   (gnus-picons-network-search-internal user addrs dbs sym-ann right-p
 714                                        (prog1 (gnus-picons-parse-filenames)
 715                                          (kill-buffer (current-buffer)))))
 716
 717 ;; Initiate a query on the picon database
 718 (defun gnus-picons-network-search (user addrs dbs sym-ann right-p)
 719   (let* ((host (mapconcat 'identity addrs "."))
 720          (key (list (or user "unknown") host (if user
 721                                                   gnus-picons-user-directories
 722                                                 dbs)))
 723          (cache (assoc key gnus-picons-url-alist)))
 724     (if (null cache)
 725         (gnus-picons-url-retrieve
 726          (concat gnus-picons-piconsearch-url
 727                  "?user=" (w3-form-encode-xwfu (or user "unknown"))
 728                  "&host=" (w3-form-encode-xwfu host)
 729                  "&db=" (mapconcat 'w3-form-encode-xwfu
 730                                    (if user
 731                                        (append dbs
 732                                                gnus-picons-user-directories)
 733                                      dbs)
 734                                    "+"))
 735          'gnus-picons-network-search-callback
 736          (list user addrs dbs sym-ann right-p))
 737       (gnus-picons-network-search-internal user addrs dbs sym-ann right-p))))
 738
 739 ;;; Main jobs dispatcher function
 740
 741 (defun gnus-picons-next-job-internal ()
 742   (when (setq gnus-picons-job-already-running (pop gnus-picons-jobs-alist))
 743     (let* ((job gnus-picons-job-already-running)
 744            (sym-ann (pop job))
 745            (tag (pop job)))
 746       (when tag
 747         (cond
 748          ((stringp tag);; (SYM-ANN "..." RIGHT-P)
 749           (gnus-picons-network-display-internal
 750            sym-ann nil tag (pop job)))
 751          ((eq 'bar tag)
 752           (gnus-picons-network-display-internal
 753            sym-ann
 754            (let ((gnus-picons-file-suffixes '("xbm")))
 755              (gnus-picons-try-face
 756               gnus-xmas-glyph-directory "bar."))
 757            nil (pop job)))
 758          ((eq 'search tag);; (SYM-ANN 'search USER ADDRS DBS RIGHT-P)
 759           (gnus-picons-network-search
 760            (pop job) (pop job) (pop job) sym-ann (pop job)))
 761          ((eq 'picon tag);; (SYM-ANN 'picon URL PART RIGHT-P)
 762           (gnus-picons-network-display
 763            (pop job) (pop job) sym-ann (pop job)))
 764          (t
 765           (setq gnus-picons-job-already-running nil)
 766           (error "Unknown picon job tag %s" tag)))))))
 767
 768 (defun gnus-picons-next-job ()
 769   "Start processing the job queue if it is not in progress."
 770   (unless gnus-picons-job-already-running
 771     (gnus-picons-next-job-internal)))
 772
 773 (provide 'gnus-picon)
 774
 775 ;;; gnus-picon.el ends here