;;; notifications.el --- Client interface to desktop notifications.
-;; Copyright (C) 2010 Free Software Foundation, Inc.
+;; Copyright (C) 2010-2012 Free Software Foundation, Inc.
;; Author: Julien Danjou <julien@danjou.info>
;; Keywords: comm desktop notifications
;;
;; (require 'notifications)
+;; For proper usage, Emacs must be started in an environment with an
+;; active D-Bus session bus.
+
;;; Code:
(eval-when-compile
(require 'cl))
(require 'dbus)
+(defconst notifications-specification-version "1.1"
+ "The version of the Desktop Notifications Specification implemented.")
+
(defconst notifications-application-name "Emacs"
"Default application name.")
(defun notifications-on-action-signal (id action)
"Dispatch signals to callback functions from `notifications-on-action-map'."
- (let ((entry (assoc id notifications-on-action-map)))
+ (let* ((unique-name (dbus-event-service-name last-input-event))
+ (entry (assoc (cons unique-name id) notifications-on-action-map)))
(when entry
(funcall (cadr entry) id action)
- (remove entry 'notifications-on-action-map))))
-
-(dbus-register-signal
- :session
- notifications-service
- notifications-path
- notifications-interface
- notifications-action-signal
- 'notifications-on-action-signal)
-
-(defun notifications-on-closed-signal (id reason)
+ (remove entry notifications-on-action-map))))
+
+(when (fboundp 'dbus-register-signal)
+ (dbus-register-signal
+ :session
+ nil
+ notifications-path
+ notifications-interface
+ notifications-action-signal
+ 'notifications-on-action-signal))
+
+(defun notifications-on-closed-signal (id &optional reason)
"Dispatch signals to callback functions from `notifications-on-closed-map'."
- (let ((entry (assoc id notifications-on-close-map)))
+ ;; notification-daemon prior 0.4.0 does not send a reason. So we
+ ;; make it optional, and assume `undefined' as default.
+ (let* ((unique-name (dbus-event-service-name last-input-event))
+ (entry (assoc (cons unique-name id) notifications-on-close-map))
+ (reason (or reason 4)))
(when entry
(funcall (cadr entry)
id (cadr (assoc reason notifications-closed-reason)))
- (remove entry 'notifications-on-close-map))))
+ (remove entry notifications-on-close-map))))
-(dbus-register-signal
- :session
- notifications-service
- notifications-path
- notifications-interface
- notifications-closed-signal
- 'notifications-on-closed-signal)
+(when (fboundp 'dbus-register-signal)
+ (dbus-register-signal
+ :session
+ nil
+ notifications-path
+ notifications-interface
+ notifications-closed-signal
+ 'notifications-on-closed-signal))
(defun notifications-notify (&rest params)
"Send notification via D-Bus using the Freedesktop notification protocol.
:image-data This is a raw data image format which describes the width,
height, rowstride, has alpha, bits per sample, channels and
image data respectively.
+ :image-path This is represented either as a URI (file:// is the
+ only URI schema supported right now) or a name
+ in a freedesktop.org-compliant icon theme.
:sound-file The path to a sound file to play when the notification pops up.
+ :sound-name A themable named sound from the freedesktop.org sound naming
+ specification to play when the notification pops up.
+ Similar to icon-name,only for sounds. An example would
+ be \"message-new-instant\".
:suppress-sound Causes the server to suppress playing any sounds, if it has
that ability.
:x Specifies the X location on the screen that the notification
This function returns a notification id, an integer, which can be
used to manipulate the notification item with
-`notifications-close'."
+`notifications-close-notification'."
(let ((title (plist-get params :title))
(body (plist-get params :body))
(app-name (plist-get params :app-name))
(category (plist-get params :category))
(desktop-entry (plist-get params :desktop-entry))
(image-data (plist-get params :image-data))
+ (image-path (plist-get params :image-path))
(sound-file (plist-get params :sound-file))
+ (sound-name (plist-get params :sound-name))
(suppress-sound (plist-get params :suppress-sound))
(x (plist-get params :x))
(y (plist-get params :y))
(add-to-list 'hints `(:dict-entry
"urgency"
(:variant :byte ,(case urgency
- ('low 0)
- ('critical 2)
+ (low 0)
+ (critical 2)
(t 1)))) t))
(when category
(add-to-list 'hints `(:dict-entry
(add-to-list 'hints `(:dict-entry
"image_data"
(:variant :struct ,image-data)) t))
+ (when image-path
+ (add-to-list 'hints `(:dict-entry
+ "image_path"
+ (:variant :string ,image-path)) t))
(when sound-file
(add-to-list 'hints `(:dict-entry
"sound-file"
(:variant :string ,sound-file)) t))
+ (when sound-name
+ (add-to-list 'hints `(:dict-entry
+ "sound-name"
+ (:variant :string ,sound-name)) t))
(when suppress-sound
(add-to-list 'hints `(:dict-entry
"suppress-sound"
(or hints '(:array :signature "{sv}"))
:int32 (or timeout -1)))
- ;; Register close/action callback function
+ ;; Register close/action callback function. We must also remember
+ ;; the daemon's unique name, because the daemon could have
+ ;; restarted.
(let ((on-action (plist-get params :on-action))
- (on-close (plist-get params :on-close)))
+ (on-close (plist-get params :on-close))
+ (unique-name (dbus-get-name-owner :session notifications-service)))
(when on-action
- (add-to-list 'notifications-on-action-map (list id on-action)))
+ (add-to-list 'notifications-on-action-map
+ (list (cons unique-name id) on-action)))
(when on-close
- (add-to-list 'notifications-on-close-map (list id on-close))))
+ (add-to-list 'notifications-on-close-map
+ (list (cons unique-name id) on-close))))
;; Return notification id
id))
HCoop / bpt / emacs.git / blobdiff