gnus-notifications.el 7.98 KB
Newer Older
Julien Danjou's avatar
Julien Danjou committed
1 2
;; gnus-notifications.el -- Send notification on new message in Gnus

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 2012-2015 Free Software Foundation, Inc.
Julien Danjou's avatar
Julien Danjou committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

;; Author: Julien Danjou <julien@danjou.info>
;; Keywords: news

;; This file is part of GNU Emacs.

;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; This implements notifications using `notifications-notify' on new
;; messages received.
;; Use (add-hook 'gnus-after-getting-new-news-hook 'gnus-notifications)
;; to get notifications just after getting the new news.

;;; Code:

32 33
(ignore-errors
  (require 'notifications))
Julien Danjou's avatar
Julien Danjou committed
34 35 36 37 38
(require 'gnus-sum)
(require 'gnus-group)
(require 'gnus-int)
(require 'gnus-art)
(require 'gnus-util)
39 40 41
(ignore-errors
  (require 'google-contacts))        ; Optional
(require 'gnus-fun)
Julien Danjou's avatar
Julien Danjou committed
42 43 44

(defgroup gnus-notifications nil
  "Send notifications on new message in Gnus."
Glenn Morris's avatar
Glenn Morris committed
45
  :version "24.3"
Julien Danjou's avatar
Julien Danjou committed
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
  :group 'gnus)

(defcustom gnus-notifications-use-google-contacts t
  "Use Google Contacts to retrieve photo."
  :type 'boolean
  :group 'gnus-notifications)

(defcustom gnus-notifications-use-gravatar t
  "Use Gravatar to retrieve photo."
  :type 'boolean
  :group 'gnus-notifications)

(defcustom gnus-notifications-minimum-level 1
  "Minimum group level the message should have to be notified.
Any message in a group that has a greater value than this will
not get notifications."
  :type 'integer
  :group 'gnus-notifications)

65 66
(defcustom gnus-notifications-timeout nil
  "Timeout used for notifications sent via `notifications-notify'."
67 68
  :type '(choice (const :tag "Server default" nil)
                 (integer :tag "Milliseconds"))
69 70
  :group 'gnus-notifications)

Julien Danjou's avatar
Julien Danjou committed
71 72 73
(defvar gnus-notifications-sent nil
  "Notifications already sent.")

74 75 76 77
(defvar gnus-notifications-id-to-msg nil
  "Map notifications ids to messages.")

(defun gnus-notifications-action (id key)
78 79 80 81 82 83 84 85 86 87 88 89 90
  (let ((group-article (assoc id gnus-notifications-id-to-msg)))
    (when group-article
      (let ((group (cadr group-article))
            (article (nth 2 group-article)))
        (cond ((string= key "read")
               (gnus-fetch-group group (list article))
               (when (and window-system (fboundp 'x-focus-frame)) (x-focus-frame (selected-frame))))
              ((string= key "mark-read")
               (gnus-update-read-articles
                group
                (delq article (gnus-list-of-unread-articles group)))
               ;; gnus-group-refresh-group
               (gnus-group-update-group group)))))))
91

Julien Danjou's avatar
Julien Danjou committed
92
(defun gnus-notifications-notify (from subject photo-file)
93 94
  "Send a notification about a new mail.
Return a notification id if any, or t on success."
Julien Danjou's avatar
Julien Danjou committed
95
  (if (fboundp 'notifications-notify)
96 97
      (gnus-funcall-no-warning
       'notifications-notify
Julien Danjou's avatar
Julien Danjou committed
98 99
       :title from
       :body subject
100
       :actions '("read" "Read" "mark-read" "Mark As Read")
101
       :on-action 'gnus-notifications-action
102 103 104
       :app-icon (gnus-funcall-no-warning
                  'image-search-load-path "gnus/gnus.png")
       :image-path photo-file
Julien Danjou's avatar
Julien Danjou committed
105 106
       :app-name "Gnus"
       :category "email.arrived"
107
       :timeout gnus-notifications-timeout)
108 109 110
    (message "New message from %s: %s" from subject)
    ;; Don't return an id
    t))
Julien Danjou's avatar
Julien Danjou committed
111

Gnus developers's avatar
Gnus developers committed
112 113 114
(declare-function gravatar-retrieve-synchronously "gravatar.el"
		  (mail-address))

Julien Danjou's avatar
Julien Danjou committed
115 116 117 118 119
(defun gnus-notifications-get-photo (mail-address)
  "Get photo for mail address."
  (let ((google-photo (when (and gnus-notifications-use-google-contacts
                                 (fboundp 'google-contacts-get-photo))
                        (ignore-errors
120 121
                          (gnus-funcall-no-warning
			   'google-contacts-get-photo mail-address)))))
Julien Danjou's avatar
Julien Danjou committed
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
    (if google-photo
        google-photo
      (when gnus-notifications-use-gravatar
        (let ((gravatar (ignore-errors
                          (gravatar-retrieve-synchronously mail-address))))
          (if (eq gravatar 'error)
              nil
            (plist-get (cdr gravatar) :data)))))))

(defun gnus-notifications-get-photo-file (mail-address)
  "Get a temporary file with an image for MAIL-ADDRESS.
You have to delete the temporary image yourself using
`delete-image'.

Returns nil if no image found."
  (let ((photo (gnus-notifications-get-photo mail-address)))
    (when photo
      (let ((photo-file (make-temp-file "gnus-notifications-photo-"))
            (coding-system-for-write 'binary))
        (with-temp-file photo-file
          (insert photo))
        photo-file))))

;;;###autoload
(defun gnus-notifications ()
  "Send a notification on new message.
This check for new messages that are in group with a level lower
or equal to `gnus-notifications-minimum-level' and send a
notification using `notifications-notify' for it.

This is typically a function to add in
`gnus-after-getting-new-news-hook'"
  (dolist (entry gnus-newsrc-alist)
    (let ((group (car entry)))
      ;; Check that the group level is less than
      ;; `gnus-notifications-minimum-level' and the the group has unread
      ;; messages.
      (when (and (<= (gnus-group-level group) gnus-notifications-minimum-level)
                 (let ((unread (gnus-group-unread group)))
                   (and (numberp unread)
                        (> unread 0))))
        ;; Each group should have an entry in the `gnus-notifications-sent'
        ;; alist. If not, we add one at this time.
        (let ((group-notifications (or (assoc group gnus-notifications-sent)
                                       ;; Nothing, add one and return it.
                                       (assoc group
                                              (add-to-list
                                               'gnus-notifications-sent
                                               (cons group nil))))))
          (dolist (article (gnus-list-of-unread-articles group))
            ;; Check if the article already has been notified
            (unless (memq article (cdr group-notifications))
              (with-current-buffer nntp-server-buffer
                (gnus-request-head article group)
                (article-decode-encoded-words) ; to decode mail addresses, subjects, etc
                (let* ((address-components (mail-extract-address-components
                                            (or (mail-fetch-field "From") "")))
179 180
                       (address (cadr address-components)))
                  ;; Ignore mails from ourselves
181 182 183 184
                  (unless (and gnus-ignored-from-addresses
                               address
                               (gnus-string-match-p gnus-ignored-from-addresses
                                                    address))
185 186 187 188 189 190 191 192 193 194 195 196 197
                    (let* ((photo-file (gnus-notifications-get-photo-file address))
                           (notification-id (gnus-notifications-notify
                                             (or (car address-components) address)
                                             (mail-fetch-field "Subject")
                                             photo-file)))
                      (when notification-id
                        ;; Register that we did notify this message
                        (setcdr group-notifications (cons article (cdr group-notifications)))
                        (unless (eq notification-id t)
                          ;; Register the notification id for later actions
                          (add-to-list 'gnus-notifications-id-to-msg (list notification-id group article))))
                      (when photo-file
                        (delete-file photo-file)))))))))))))
Julien Danjou's avatar
Julien Danjou committed
198 199 200 201

(provide 'gnus-notifications)

;;; gnus-notifications.el ends here