lisp/gnus/gravatar.el

   1 ;;; gravatar.el --- Get Gravatars
   2
   3 ;; Copyright (C) 2010-2013 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 'url)
  28 (require 'url-cache)
  29
  30 (defgroup gravatar nil
  31   "Gravatar."
  32   :version "24.1"
  33   :group 'comm)
  34
  35 (defcustom gravatar-automatic-caching t
  36   "Whether cache retrieved gravatar."
  37   :group 'gravatar)
  38
  39 (defcustom gravatar-cache-ttl (days-to-time 30)
  40   "Time to live for gravatar cache entries."
  41   :group 'gravatar)
  42
  43 (defcustom gravatar-rating "g"
  44   "Default rating for gravatar."
  45   :group 'gravatar)
  46
  47 (defcustom gravatar-size 32
  48   "Default size in pixels for gravatars."
  49   :group 'gravatar)
  50
  51 (defconst gravatar-base-url
  52   "http://www.gravatar.com/avatar"
  53   "Base URL for getting gravatars.")
  54
  55 (defun gravatar-hash (mail-address)
  56   "Create an hash from MAIL-ADDRESS."
  57   (md5 (downcase mail-address)))
  58
  59 (defun gravatar-build-url (mail-address)
  60   "Return an URL to retrieve MAIL-ADDRESS gravatar."
  61   (format "%s/%s?d=404&r=%s&s=%d"
  62           gravatar-base-url
  63           (gravatar-hash mail-address)
  64           gravatar-rating
  65           gravatar-size))
  66
  67 (defun gravatar-cache-expired (url)
  68   "Check if URL is cached for more than `gravatar-cache-ttl'."
  69   (cond (url-standalone-mode
  70          (not (file-exists-p (url-cache-create-filename url))))
  71         (t (let ((cache-time (url-is-cached url)))
  72              (if cache-time
  73                  (time-less-p
  74                   (time-add
  75                    cache-time
  76                    gravatar-cache-ttl)
  77                   (current-time))
  78                t)))))
  79
  80 (defun gravatar-get-data ()
  81   "Get data from current buffer."
  82   (save-excursion
  83     (goto-char (point-min))
  84     (when (re-search-forward "^HTTP/.+ 200 OK$" nil (line-end-position))
  85       (when (search-forward "\n\n" nil t)
  86         (buffer-substring (point) (point-max))))))
  87
  88 (eval-and-compile
  89   (cond ((featurep 'xemacs)
  90          (require 'gnus-xmas)
  91          (defalias 'gravatar-create-image 'gnus-xmas-create-image))
  92         ((featurep 'gnus-ems)
  93          (defalias 'gravatar-create-image 'gnus-create-image))
  94         (t
  95          (require 'image)
  96          (defalias 'gravatar-create-image 'create-image))))
  97
  98 (defun gravatar-data->image ()
  99   "Get data of current buffer and return an image.
 100 If no image available, return 'error."
 101   (let ((data (gravatar-get-data)))
 102     (if data
 103         (gravatar-create-image data nil t)
 104       'error)))
 105
 106 (autoload 'help-function-arglist "help-fns")
 107
 108 ;;;###autoload
 109 (defun gravatar-retrieve (mail-address cb &optional cbargs)
 110   "Retrieve MAIL-ADDRESS gravatar and call CB on retrieval.
 111 You can provide a list of argument to pass to CB in CBARGS."
 112   (let ((url (gravatar-build-url mail-address)))
 113     (if (gravatar-cache-expired url)
 114         (let ((args (list url
 115                           'gravatar-retrieved
 116                           (list cb (when cbargs cbargs)))))
 117           (when (> (length (if (featurep 'xemacs)
 118                                (cdr (split-string (function-arglist 'url-retrieve)))
 119                              (help-function-arglist 'url-retrieve)))
 120                    4)
 121             (setq args (nconc args (list t))))
 122           (apply #'url-retrieve args))
 123       (apply cb
 124                (with-temp-buffer
 125                  (mm-disable-multibyte)
 126                  (url-cache-extract (url-cache-create-filename url))
 127                  (gravatar-data->image))
 128                cbargs))))
 129
 130 ;;;###autoload
 131 (defun gravatar-retrieve-synchronously (mail-address)
 132   "Retrieve MAIL-ADDRESS gravatar and returns it."
 133   (let ((url (gravatar-build-url mail-address)))
 134     (if (gravatar-cache-expired url)
 135         (with-current-buffer (if (featurep 'xemacs)
 136                                  (url-retrieve url)
 137                                (url-retrieve-synchronously url))
 138           (when gravatar-automatic-caching
 139             (url-store-in-cache (current-buffer)))
 140           (let ((data (gravatar-data->image)))
 141             (kill-buffer (current-buffer))
 142             data))
 143       (with-temp-buffer
 144         (mm-disable-multibyte)
 145         (url-cache-extract (url-cache-create-filename url))
 146         (gravatar-data->image)))))
 147
 148
 149 (defun gravatar-retrieved (status cb &optional cbargs)
 150   "Callback function used by `gravatar-retrieve'."
 151   ;; Store gravatar?
 152   (when gravatar-automatic-caching
 153     (url-store-in-cache (current-buffer)))
 154   (if (plist-get status :error)
 155       ;; Error happened.
 156       (apply cb 'error cbargs)
 157     (apply cb (gravatar-data->image) cbargs))
 158   (kill-buffer (current-buffer)))
 159
 160 (provide 'gravatar)
 161
 162 ;;; gravatar.el ends here