lisp/gnus/gnus-gravatar.el

   1 ;;; gnus-gravatar.el --- Gnus Gravatar support
   2
   3 ;; Copyright (C) 2010-2017 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 (require 'mail-extr) ;; Because of binding `mail-extr-disable-voodoo'.
  30
  31 (defgroup gnus-gravatar nil
  32   "Gnus Gravatar."
  33   :group 'gnus-visual)
  34
  35 (defcustom gnus-gravatar-size nil
  36   "How big should gravatars be displayed.
  37 If nil, default to `gravatar-size'."
  38   :type '(choice (const nil) integer)
  39   :version "24.1"
  40   :group 'gnus-gravatar)
  41
  42 (defcustom gnus-gravatar-properties '(:ascent center :relief 1)
  43   "List of image properties applied to Gravatar images."
  44   :type 'plist
  45   :version "24.1"
  46   :group 'gnus-gravatar)
  47
  48 (defcustom gnus-gravatar-too-ugly gnus-article-x-face-too-ugly
  49   "Regexp matching posters whose avatar shouldn't be shown automatically."
  50   :type '(choice regexp (const nil))
  51   :version "24.1"
  52   :group 'gnus-gravatar)
  53
  54 (defun gnus-gravatar-transform-address (header category &optional force)
  55   (gnus-with-article-headers
  56     (let* ((mail-extr-disable-voodoo t)
  57            (mail-extr-ignore-realname-equals-mailbox-name nil)
  58            (addresses (mail-extract-address-components
  59                        (or (mail-fetch-field header) "") t))
  60            (gravatar-size (or gnus-gravatar-size gravatar-size))
  61            name)
  62       (dolist (address addresses)
  63         (when (and (setq name (car address))
  64                    (string-match "\\` +" name))
  65           (setcar address (setq name (substring name (match-end 0)))))
  66         (when (or force
  67                   (not (and gnus-gravatar-too-ugly
  68                             (or (string-match gnus-gravatar-too-ugly
  69                                               (or (cadr address) ""))
  70                                 (and name
  71                                      (string-match gnus-gravatar-too-ugly
  72                                                    name))))))
  73           (ignore-errors
  74             (gravatar-retrieve
  75              (cadr address)
  76              'gnus-gravatar-insert
  77              (list header address category))))))))
  78
  79 (defun gnus-gravatar-insert (gravatar header address category)
  80   "Insert GRAVATAR for ADDRESS in HEADER in current article buffer.
  81 Set image category to CATEGORY."
  82   (unless (eq gravatar 'error)
  83     (gnus-with-article-buffer
  84       (let ((mark (point-marker))
  85             (inhibit-point-motion-hooks t)
  86             (case-fold-search t))
  87         (save-restriction
  88           (article-narrow-to-head)
  89           ;; The buffer can be gone at this time
  90           (when (buffer-live-p (current-buffer))
  91             (gnus-article-goto-header header)
  92             (mail-header-narrow-to-field)
  93             (let ((real-name (car address))
  94                   (mail-address (cadr address)))
  95               (when (if real-name
  96                         (re-search-forward
  97                          (concat (replace-regexp-in-string
  98                                   "[\t ]+" "[\t\n ]+"
  99                                   (regexp-quote real-name))
 100                                  "\\|"
 101                                  (regexp-quote mail-address))
 102                          nil t)
 103                       (search-forward mail-address nil t))
 104                 (goto-char (1- (match-beginning 0)))
 105                 ;; If we're on the " quoting the name, go backward
 106                 (when (looking-at "[\"<]")
 107                   (goto-char (1- (point))))
 108                 ;; Do not do anything if there's already a gravatar. This can
 109                 ;; happens if the buffer has been regenerated in the mean time, for
 110                 ;; example we were fetching someaddress, and then we change to
 111                 ;; another mail with the same someaddress.
 112                 (unless (memq 'gnus-gravatar (text-properties-at (point)))
 113                   (let ((point (point)))
 114                     (setq gravatar (append gravatar gnus-gravatar-properties))
 115                     (gnus-put-image gravatar (buffer-substring (point) (1+ point)) category)
 116                     (put-text-property point (point) 'gnus-gravatar address)
 117                     (gnus-add-wash-type category)
 118                     (gnus-add-image category gravatar)))))))
 119         (goto-char (marker-position mark))))))
 120
 121 ;;;###autoload
 122 (defun gnus-treat-from-gravatar (&optional force)
 123   "Display gravatar in the From header.
 124 If gravatar is already displayed, remove it."
 125   (interactive (list t)) ;; When type `W D g'
 126   (gnus-with-article-buffer
 127     (if (memq 'from-gravatar gnus-article-wash-types)
 128         (gnus-delete-images 'from-gravatar)
 129       (gnus-gravatar-transform-address "from" 'from-gravatar force))))
 130
 131 ;;;###autoload
 132 (defun gnus-treat-mail-gravatar (&optional force)
 133   "Display gravatars in the Cc and To headers.
 134 If gravatars are already displayed, remove them."
 135   (interactive (list t)) ;; When type `W D h'
 136     (gnus-with-article-buffer
 137       (if (memq 'mail-gravatar gnus-article-wash-types)
 138           (gnus-delete-images 'mail-gravatar)
 139         (gnus-gravatar-transform-address "cc" 'mail-gravatar force)
 140         (gnus-gravatar-transform-address "to" 'mail-gravatar force))))
 141
 142 (provide 'gnus-gravatar)
 143
 144 ;;; gnus-gravatar.el ends here