lisp/gnus-gravatar.el

   1 ;;; gnus-gravatar.el --- Gnus Gravatar support
   2
   3 ;; Copyright (C) 2010 Free Software Foundation, Inc.
   4
   5 ;; Author: Julien Danjou <julien@danjou.info>
   6 ;; Keywords: news
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software: you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation, either version 3 of the License, or
  13 ;; (at your option) any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  22
  23 ;;; Commentary:
  24
  25 ;;; Code:
  26
  27 (require 'gravatar)
  28 (require 'gnus-art)
  29
  30 (defgroup gnus-gravatar nil
  31   "Gnus Gravatar."
  32   :group 'gnus-visual)
  33
  34 (defcustom gnus-gravatar-size 32
  35   "How big should gravatars be displayed."
  36   :type 'integer
  37   :version "24.1"
  38   :group 'gnus-gravatar)
  39
  40 (defcustom gnus-gravatar-properties '(:ascent center :relief 1)
  41   "List of image properties applied to Gravatar images."
  42   :type 'list
  43   :version "24.1"
  44   :group 'gnus-gravatar)
  45
  46 (defcustom gnus-gravatar-too-ugly gnus-article-x-face-too-ugly
  47   "Regexp matching posters whose avatar shouldn't be shown automatically."
  48   :type '(choice regexp (const nil))
  49   :version "24.1"
  50   :group 'gnus-gravatar)
  51
  52 (defun gnus-gravatar-transform-address (header category &optional force)
  53   (gnus-with-article-headers
  54     (let ((addresses
  55            (mail-header-parse-addresses
  56             ;; mail-header-parse-addresses does not work (reliably) on
  57             ;; decoded headers.
  58             (or
  59              (ignore-errors
  60                (mail-encode-encoded-word-string
  61                 (or (mail-fetch-field header) "")))
  62              (mail-fetch-field header))))
  63           (gravatar-size gnus-gravatar-size)
  64           name)
  65       (dolist (address addresses)
  66         (when (and (setq name (cdr address))
  67                    (string-match "\\`\\*+ " name)) ;; (X-)Faces exist.
  68           (setcdr address (setq name (substring name (match-end 0)))))
  69         (when (or force
  70                   (not (and gnus-gravatar-too-ugly
  71                             (or (string-match gnus-gravatar-too-ugly
  72                                               (car address))
  73                                 (and name
  74                                      (string-match gnus-gravatar-too-ugly
  75                                                    name))))))
  76           (ignore-errors
  77             (gravatar-retrieve
  78              (car address)
  79              'gnus-gravatar-insert
  80              (list header address category))))))))
  81
  82 (defun gnus-gravatar-insert (gravatar header address category)
  83   "Insert GRAVATAR for ADDRESS in HEADER in current article buffer.
  84 Set image category to CATEGORY."
  85   (unless (eq gravatar 'error)
  86     (gnus-with-article-headers
  87       ;; The buffer can be gone at this time
  88       (when (buffer-live-p (current-buffer))
  89         (gnus-article-goto-header header)
  90         (mail-header-narrow-to-field)
  91         (let ((real-name (cdr address))
  92               (mail-address (car address)))
  93           (when (if real-name             ; have a realname, go for it!
  94                     (and (search-forward real-name nil t)
  95                          (search-backward real-name nil t))
  96                   (and (search-forward mail-address nil t)
  97                        (search-backward mail-address nil t)))
  98             (goto-char (1- (point)))
  99             ;; If we're on the " quoting the name, go backward
 100             (when (looking-at "[\"<]")
 101               (goto-char (1- (point))))
 102             ;; Do not do anything if there's already a gravatar. This can
 103             ;; happens if the buffer has been regenerated in the mean time, for
 104             ;; example we were fetching someaddress, and then we change to
 105             ;; another mail with the same someaddress.
 106             (unless (memq 'gnus-gravatar (text-properties-at (point)))
 107               (let ((inhibit-read-only t)
 108                     (point (point)))
 109                 (unless (featurep 'xemacs)
 110                   (setq gravatar (append gravatar gnus-gravatar-properties)))
 111                 (gnus-put-image gravatar nil category)
 112                 (put-text-property point (point) 'gnus-gravatar address)
 113                 (gnus-add-wash-type category)
 114                 (gnus-add-image category gravatar)))))))))
 115
 116 ;;;###autoload
 117 (defun gnus-treat-from-gravatar (&optional force)
 118   "Display gravatar in the From header.
 119 If gravatar is already displayed, remove it."
 120   (interactive (list t)) ;; When type `W D g'
 121   (gnus-with-article-buffer
 122     (if (memq 'from-gravatar gnus-article-wash-types)
 123         (gnus-delete-images 'from-gravatar)
 124       (gnus-gravatar-transform-address "from" 'from-gravatar force))))
 125
 126 ;;;###autoload
 127 (defun gnus-treat-mail-gravatar (&optional force)
 128   "Display gravatars in the Cc and To headers.
 129 If gravatars are already displayed, remove them."
 130   (interactive (list t)) ;; When type `W D h'
 131     (gnus-with-article-buffer
 132       (if (memq 'mail-gravatar gnus-article-wash-types)
 133           (gnus-delete-images 'mail-gravatar)
 134         (gnus-gravatar-transform-address "cc" 'mail-gravatar force)
 135         (gnus-gravatar-transform-address "to" 'mail-gravatar force))))
 136
 137 (provide 'gnus-gravatar)
 138
 139 ;;; gnus-gravatar.el ends here