1 ;;; riece-desktop-notify.el --- Display notification to desktop -*- lexical-binding: t -*-
2 ;; Copyright (C) 2009 OHASHI Akira
4 ;; Author: OHASHI Akira <bg66@koka-in.org>
6 ;; Keywords: IRC, riece
8 ;; This file is part of Riece.
10 ;; This program 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 2, or (at your option)
15 ;; This program 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.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
27 ;; NOTE: This is an add-on module for Riece.
29 ;; riece-desktop-notify.el needs an external program to notify desktop.
30 ;; The setting prepared beforehand for most popular OS uses the
31 ;; following external programs.
34 ;; growlnotify <URL:http://growl.info/extras.php#growlnotify>
35 ;; (of course you need Growl <URL:http://growl.info>)
38 ;; notify-send (which is included in libnotify)
39 ;; <URL:http://www.galago-project.org/news/index.php>
41 ;; If you use Debian, you can install it by the following command:
43 ;; % sudo aptitude install libnotify-bin
46 ;; Snarl_CMD.exe <URL:http://tlhan-ghun.de/?q=node/59>
47 ;; (of course you need Snarl <URL:http://www.fullphat.net/>)
51 (require 'riece-message)
52 (eval-when-compile (require 'riece-keyword))
54 (defconst riece-desktop-notify-description
55 "Display notification to desktop.")
57 (defgroup riece-desktop-notify nil
58 "Display notification to desktop."
61 (defcustom riece-desktop-notify-title-function
63 (riece-identity-prefix (riece-message-target message)))
64 "*The function which make title.
65 This function must have only one message object as argument."
67 :group 'riece-desktop-notify)
69 (defcustom riece-desktop-notify-message-function 'riece-format-message
70 "*The function which make message.
71 This function must have only one message object as argument."
73 :group 'riece-desktop-notify)
75 (defcustom riece-desktop-notify-coding-system (terminal-coding-system)
76 "*Coding system used to notify desktop."
78 :group 'riece-desktop-notify)
80 (defcustom riece-desktop-notify-type
81 (if (eq system-type 'linux) 'gnu/linux system-type)
82 "*The type to notify desktop."
83 :type '(radio (const :tag "Like Darwin" darwin)
84 (const :tag "Like GNU/Linux" gnu/linux)
85 (const :tag "Like Windows" windows-nt)
86 (symbol :tag "The other type"))
87 :group 'riece-desktop-notify)
90 (defcustom riece-desktop-notify-darwin-program "growlnotify"
91 "*The program name to notify for darwin."
93 :group 'riece-desktop-notify)
95 (defcustom riece-desktop-notify-darwin-args
96 '("-t" title "-m" message "-H" "localhost")
97 "*The Arguments to notify for darwin."
98 :type '(repeat (radio (string :tag "Argument")
99 (const :tag "Title" title)
100 (const :tag "Message" message)))
101 :group 'riece-desktop-notify)
104 (defcustom riece-desktop-notify-gnu/linux-program "notify-send"
105 "*The program name to notify for GNU/Linux."
107 :group 'riece-desktop-notify)
109 (defcustom riece-desktop-notify-gnu/linux-args '("-u" "low" title message)
110 "*The Arguments to notify for GNU/Linux."
111 :type '(repeat (radio (string :tag "Argument")
112 (const :tag "Title" title)
113 (const :tag "Message" message)))
114 :group 'riece-desktop-notify)
117 (defcustom riece-desktop-notify-windows-nt-program "snarl_cmd.exe"
118 "*The program name to notify for Windows."
120 :group 'riece-desktop-notify)
122 (defcustom riece-desktop-notify-windows-nt-args
123 '("snShowMessage" "-1" title message)
124 "*The Arguments string to notify for Windows."
125 :type '(repeat (radio (string :tag "Argument")
126 (const :tag "Title" title)
127 (const :tag "Message" message)))
128 :group 'riece-desktop-notify)
130 ;; stolen and modified from riece-ruby.el
131 (defun riece-desktop-notify-substitute-variables (args alist)
132 "Substitute symbols in ARGS by looking up ALIST."
133 (setq args (copy-sequence args))
135 (let ((pointer args))
137 (setq pointer (memq (car (car alist)) args))
139 (setcar pointer (cdr (car alist))))))
140 (setq alist (cdr alist)))
143 (defsubst riece-desktop-notify-make-symbol (symbol)
144 (intern (format "riece-desktop-notify-%s-%s"
145 (symbol-name riece-desktop-notify-type)
146 (symbol-name symbol))))
148 (defvar riece-desktop-notify-last-message nil
149 "The previous message we have seen in
150 `riece-desktop-notify-keyword-notify-function'.")
152 (defun riece-desktop-notify-keyword-notify-function (_keyword message)
153 ;; Don't send notification multiple times for a single message.
154 (unless (eq riece-desktop-notify-last-message message)
155 (let ((program-symbol (riece-desktop-notify-make-symbol 'program))
156 (args-symbol (riece-desktop-notify-make-symbol 'args)))
157 (when (and (boundp program-symbol) (boundp args-symbol))
158 (let ((program (eval program-symbol))
159 (args (eval args-symbol)))
160 (when (fboundp 'executable-find)
161 (setq program (executable-find program)))
162 (when (stringp program)
163 (let ((title (funcall riece-desktop-notify-title-function message))
164 (message (funcall riece-desktop-notify-message-function
167 (apply #'call-process program nil 0 nil
168 (riece-desktop-notify-substitute-variables
171 (encode-coding-string
173 riece-desktop-notify-coding-system))
175 (encode-coding-string
177 riece-desktop-notify-coding-system)))))
178 (file-error nil))))))))
179 (setq riece-desktop-notify-last-message message))
181 (defun riece-desktop-notify-requires ()
184 (defun riece-desktop-notify-insinuate ()
185 (add-hook 'riece-keyword-notify-functions
186 'riece-desktop-notify-keyword-notify-function))
188 (defun riece-desktop-notify-uninstall ()
189 (remove-hook 'riece-keyword-notify-functions
190 'riece-desktop-notify-keyword-notify-function))
192 (provide 'riece-desktop-notify)
194 ;;; riece-desktop-notify.el ends here