1
2
3
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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
| | ;;; erc-desktop-notifications.el --- Send notification on PRIVMSG or mentions -*- lexical-binding:t -*-
;; Copyright (C) 2012-2024 Free Software Foundation, Inc.
;; Author: Julien Danjou <julien@danjou.info>
;; Maintainer: Amin Bandali <bandali@gnu.org>, F. Jason Park <jp@neverwas.me>
;; Keywords: comm
;; 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 <https://www.gnu.org/licenses/>.
;;; Commentary:
;; This implements notifications using `notifications-notify' on
;; PRIVMSG received and on public nickname mentions.
;;; Code:
(require 'erc)
(require 'xml)
(require 'notifications)
(require 'erc-goodies)
(require 'erc-match)
(require 'dbus)
(defgroup erc-notifications nil
"Send notifications on PRIVMSG or mentions."
:version "24.3"
:group 'erc)
(defvar erc-notifications-last-notification nil
"Last notification id.")
(defcustom erc-notifications-icon nil
"Icon to use for notification."
:type '(choice (const :tag "No icon" nil) file))
(defcustom erc-notifications-focused-contexts '(query mention)
"Where to notify even if a match appears in the selected window."
:package-version '(ERC . "5.7") ; FIXME sync on release
:type '(set (const query) (const mention)))
(defcustom erc-notifications-bus :session
"D-Bus bus to use for notification."
:version "25.1"
:type '(choice (const :tag "Session bus" :session) string))
(defvar dbus-debug) ; used in the macroexpansion of dbus-ignore-errors
(declare-function haiku-notifications-notify "haikuselect.c")
(declare-function android-notifications-notify "androidselect.c")
(defun erc-notifications-notify (nick msg &optional privp)
"Notify that NICK send some MSG, where PRIVP should be non-nil for PRIVMSGs.
This will replace the last notification sent with this function."
(dbus-ignore-errors
(setq erc-notifications-last-notification
(let* ((channel (or (and privp (not (equal nick (erc-target)))
(erc-get-buffer nick))
(current-buffer)))
(title (if (or privp (equal nick (erc-target)))
(xml-escape-string nick t)
(format "%s in %s"
(xml-escape-string nick t) channel)))
(body (xml-escape-string (erc-controls-strip msg) t)))
(funcall (cond ((featurep 'android)
#'android-notifications-notify)
((featurep 'haiku)
#'haiku-notifications-notify)
(t #'notifications-notify))
:bus erc-notifications-bus
:title title
:body body
:replaces-id erc-notifications-last-notification
:app-icon erc-notifications-icon
:actions '("default" "Switch to buffer")
:on-action (lambda (&rest _)
(pop-to-buffer channel)))))))
(defun erc-notifications-PRIVMSG (_proc parsed)
(declare (obsolete "switched to `erc-match-type' API" "31.1"))
(let ((nick (car (erc-parse-user (erc-response.sender parsed))))
(target (car (erc-response.command-args parsed)))
(msg (erc-response.contents parsed)))
(when (and (erc-current-nick-p target)
(not (and (boundp 'erc-track-exclude)
(member nick erc-track-exclude)))
(not (erc-is-message-ctcp-and-not-action-p msg)))
(erc-notifications-notify nick msg t)))
;; Return nil to continue processing by ERC
nil)
(defun erc-notifications-notify-on-match (match-type nickuserhost msg)
(when (eq match-type 'current-nick)
(let ((nick (nth 0 (erc-parse-user nickuserhost))))
(unless (or (string-match-p "^Server:" nick)
(and (eq (current-buffer) (window-buffer))
(frame-focus-state) ; t or unknown
(not (memq 'mention
erc-notifications-focused-contexts)))
(and (boundp 'erc-track-exclude)
(member nick erc-track-exclude)))
(erc-notifications-notify nick msg)))))
;;;###autoload(autoload 'erc-notifications-mode "erc-desktop-notifications" "" t)
(define-erc-module notifications nil
"Send notifications on private message reception and mentions."
;; Enable
((unless erc--updating-modules-p
(erc-buffer-do #'erc-desktop-notifications--setup))
(add-hook 'erc-mode-hook #'erc-desktop-notifications--setup)
(add-hook 'erc-text-matched-hook #'erc-notifications-notify-on-match))
;; Disable
((erc-buffer-do #'erc-desktop-notifications--setup)
(remove-hook 'erc-text-matched-hook #'erc-notifications-notify-on-match)))
(defun erc-desktop-notifications--setup ()
(if erc-notifications-mode
(erc-match-add-local-type #'erc-desktop-notifications--match-type-query)
(erc-match-remove-local-type
#'erc-desktop-notifications--match-type-query)))
(defvar erc-desktop-notifications-match-query-commands '(PRIVMSG)
"IRC commands considered in query buffers for notification.
Omits \"NOTICE\"s by default because they're typically reserved for bots
and services that you interact with directly.")
(cl-defstruct (erc-desktop-notifications--match-type-query
(:constructor erc-desktop-notifications--match-type-query)
(:include erc-match-user
(category nil)
(data erc-desktop-notifications-match-query-commands)
(predicate #'erc-desktop-notifications--query-p)
(handler #'erc-desktop-notifications--query-notify)))
"Notification match type for queries.")
(defun erc-desktop-notifications--query-p (match)
"Return non-nil if MATCH object describes a \"PRIVMSG\" query."
(and (erc-query-buffer-p)
(or (memq 'query erc-notifications-focused-contexts)
(null (frame-focus-state))
(not (eq (current-buffer) (window-buffer))))
(memq (erc-match-command match) (erc-match-user-data match))
(always (cl-assert (erc-match-nick match)))
(not (and (boundp 'erc-track-exclude)
(member (erc-target) erc-track-exclude)))))
(defun erc-desktop-notifications--query-notify (match)
;; No need to pass argument PRIVP because current buffer is correct.
(erc-notifications-notify (erc-target)
(erc-match-get-message-body match)))
(provide 'erc-desktop-notifications)
;;; erc-desktop-notifications.el ends here
;; Local Variables:
;; generated-autoload-file: "erc-loaddefs.el"
;; End:
|