bcc097b7d0f60351a4191ec9970aaea6596c08e9
[gnus] / 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)
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       (let ((gravatar-size gnus-gravatar-size))
64         (dolist (address addresses)
65           (unless (and gnus-gravatar-too-ugly
66                        (or (string-match gnus-gravatar-too-ugly
67                                          (car address))
68                            (and (cdr address)
69                                 (string-match gnus-gravatar-too-ugly
70                                               (cdr address)))))
71             (ignore-errors
72               (gravatar-retrieve
73                (car address)
74                'gnus-gravatar-insert
75                (list header address category)))))))))
76
77 (defun gnus-gravatar-insert (gravatar header address category)
78   "Insert GRAVATAR for ADDRESS in HEADER in current article buffer.
79 Set image category to CATEGORY."
80   (unless (eq gravatar 'error)
81     (gnus-with-article-headers
82       ;; The buffer can be gone at this time
83       (when (buffer-live-p (current-buffer))
84         (gnus-article-goto-header header)
85         (mail-header-narrow-to-field)
86         (let ((real-name (cdr address))
87               (mail-address (car address)))
88           (when (if real-name             ; have a realname, go for it!
89                     (and (search-forward real-name nil t)
90                          (search-backward real-name nil t))
91                   (and (search-forward mail-address nil t)
92                        (search-backward mail-address nil t)))
93             (goto-char (1- (point)))
94             ;; If we're on the " quoting the name, go backward
95             (when (looking-at "[\"<]")
96               (goto-char (1- (point))))
97             ;; Do not do anything if there's already a gravatar. This can
98             ;; happens if the buffer has been regenerated in the mean time, for
99             ;; example we were fetching someaddress, and then we change to
100             ;; another mail with the same someaddress.
101             (unless (memq 'gnus-gravatar (text-properties-at (point)))
102               (let ((inhibit-read-only t)
103                     (point (point)))
104                 (unless (featurep 'xemacs)
105                   (setq gravatar (append gravatar gnus-gravatar-properties)))
106                 (gnus-put-image gravatar nil category)
107                 (put-text-property point (point) 'gnus-gravatar address)
108                 (gnus-add-wash-type category)
109                 (gnus-add-image category gravatar)))))))))
110
111 ;;;###autoload
112 (defun gnus-treat-from-gravatar ()
113   "Display gravatar in the From header.
114 If gravatar is already displayed, remove it."
115   (interactive)
116   (gnus-with-article-buffer
117     (if (memq 'from-gravatar gnus-article-wash-types)
118         (gnus-delete-images 'from-gravatar)
119       (let ((gnus-gravatar-too-ugly
120              (unless buffer-read-only ;; When type `W D g'
121                gnus-gravatar-too-ugly)))
122         (gnus-gravatar-transform-address "from" 'from-gravatar)))))
123
124 ;;;###autoload
125 (defun gnus-treat-mail-gravatar ()
126   "Display gravatars in the Cc and To headers.
127 If gravatars are already displayed, remove them."
128   (interactive)
129     (gnus-with-article-buffer
130       (if (memq 'mail-gravatar gnus-article-wash-types)
131           (gnus-delete-images 'mail-gravatar)
132         (let ((gnus-gravatar-too-ugly
133                (unless buffer-read-only ;; When type `W D h'
134                  gnus-gravatar-too-ugly)))
135           (gnus-gravatar-transform-address "cc" 'mail-gravatar)
136           (gnus-gravatar-transform-address "to" 'mail-gravatar)))))
137
138 (provide 'gnus-gravatar)
139
140 ;;; gnus-gravatar.el ends here