File: dunstctl

package info (click to toggle)
dunst 1.12.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,256 kB
  • sloc: ansic: 17,084; sh: 882; xml: 511; makefile: 256; awk: 14
file content (247 lines) | stat: -rwxr-xr-x 8,683 bytes parent folder | download
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
#!/bin/sh

set -eu

DBUS_NAME="org.freedesktop.Notifications"
DBUS_PATH="/org/freedesktop/Notifications"
DBUS_IFAC_DUNST="org.dunstproject.cmd0"
DBUS_IFAC_PROP="org.freedesktop.DBus.Properties"
DBUS_IFAC_FDN="org.freedesktop.Notifications"

die() {
	printf "%s\n" "${1}" >&2
	if [ -z "$DBUS_SESSION_BUS_ADDRESS" ]; then
		echo "DBUS_SESSION_BUS_ADDRESS is blank. Is the D-Bus session configured correctly?" >&2
	fi
	exit 1
}

show_help() {
	# Below, each line starts with a tab character
	cat <<-EOH
	Usage: dunstctl <command> [parameters]
	Commands:
	  action                            Perform the default action, or open the
	                                    context menu of the notification at the
	                                    given position
	  close [ID]                        Close the last notification or the
	                                    notification with given ID
	  close-all                         Close all the notifications
	  context                           Open context menu
	  count [displayed|history|waiting] Show the number of notifications
	  history                           Display notification history (in JSON)
	  history-clear                     Delete all notifications from history
	  history-pop [ID]                  Pop the latest notification from
	                                    history or optionally the
	                                    notification with given ID
	  history-rm ID                     Remove the notification from
	                                    history with given ID.
	  is-paused [-e|--exit-code]        Check if pause level is greater than 0, optionally with exit code instead of text output
	  set-paused true|false|toggle      Set the pause status
	  get-pause-level                   Get the current pause level
	  set-pause-level level             Set the pause level
	  rule name enable|disable|toggle   Enable or disable a rule by its name
	  rules [--json]                    Displays configured rules (optionally
	                                    in JSON)
	  reload [dunstrc ...]              Reload the settings of the running
	                                    instance, optionally with specific
	                                    config files (space/comma-separated)
	  debug                             Print debugging information
	  help                              Show help
	EOH
}

busctl_checked() {
	command -v busctl >/dev/null 2>/dev/null || die "Command busctl not found"
	busctl --user --json=pretty --no-pager call "${DBUS_NAME}" "${DBUS_PATH}" "${DBUS_IFAC_DUNST}" "$@"
}

dbus_send_checked() {
	dbus-send "$@" \
		|| die "Failed to communicate with dunst, is it running? Or maybe the version is outdated. You can try 'dunstctl debug' as a next debugging step."
}

method_call() {
	dbus_send_checked --print-reply=literal --dest="${DBUS_NAME}" "${DBUS_PATH}" "$@"
}

property_get() {
	dbus_send_checked --print-reply=literal --dest="${DBUS_NAME}" "${DBUS_PATH}" "${DBUS_IFAC_PROP}.Get" "string:${DBUS_IFAC_DUNST}" "string:${1}"
}

property_set() {
	dbus_send_checked --print-reply=literal --dest="${DBUS_NAME}" "${DBUS_PATH}" "${DBUS_IFAC_PROP}.Set" "string:${DBUS_IFAC_DUNST}" "string:${1}" "${2}"
}

command -v dbus-send >/dev/null 2>/dev/null || die "Command dbus-send not found"

case "${1:-}" in
	"action")
		method_call "${DBUS_IFAC_DUNST}.NotificationAction" "uint32:${2:-0}" >/dev/null
		;;
	"close")
		if [ $# -eq 1 ]; then
			method_call "${DBUS_IFAC_DUNST}.NotificationCloseLast" >/dev/null
		elif [ $# -eq 2 ]; then
			method_call "${DBUS_IFAC_FDN}.CloseNotification" "uint32:$2" >/dev/null
		else
			die "Please pass the right number of arguments. Close takes 0 or 1 arguments"
		fi
		;;
	"close-all")
		method_call "${DBUS_IFAC_DUNST}.NotificationCloseAll" >/dev/null
		;;
	"context")
		method_call "${DBUS_IFAC_DUNST}.ContextMenuCall" >/dev/null
		;;
	"count")
		[ $# -eq 1 ] || [ "${2}" = "displayed" ] || [ "${2}" = "history" ] || [ "${2}" = "waiting" ] \
			|| die "Please give either 'displayed', 'history', 'waiting' or none as count parameter."
		if [ $# -eq 1 ]; then
			property_get waitingLength   | ( read -r _ _ waiting;   printf "              Waiting: %s\n" "${waiting}" )
			property_get displayedLength | ( read -r _ _ displayed; printf "  Currently displayed: %s\n" "${displayed}" )
			property_get historyLength   | ( read -r _ _ history;   printf "              History: %s\n" "${history}")
		else
			property_get ${2}Length | ( read -r _ _ notifications; printf "%s\n" "${notifications}"; )
		fi
		;;
	"history-clear")
		method_call "${DBUS_IFAC_DUNST}.NotificationClearHistory" >/dev/null
		;;
	"history-pop")
		if [ "$#" -eq 1 ]
		then
			method_call "${DBUS_IFAC_DUNST}.NotificationShow" >/dev/null
		elif [ "$#" -eq 2 ]
		then
			method_call "${DBUS_IFAC_DUNST}.NotificationPopHistory" "uint32:${2:-0}" >/dev/null
		else
			die "Please pass the right number of arguments. History-pop takes 0 or 1 arguments"
		fi
		;;
	"history-rm")
		if [ $# -eq 2 ]; then
			method_call "${DBUS_IFAC_DUNST}.NotificationRemoveFromHistory" "uint32:${2}" >/dev/null
		else
			die "Please pass the right number of arguments. History-rm takes 1 arguments"
		fi
		;;
	"is-paused")
		exit=false
		case "${2:-}" in
			-e | --exit-code)
					exit=true
				;;
		esac
		property_get paused | {
			read -r _ _ paused
			if [ "$exit" = "false" ]; then
				printf "%s\n" "${paused}"
			elif [ "${paused}" = "false" ]; then
				exit 1
			fi
		}
		;;
	"set-paused")
		[ "${2:-}" ] \
			|| die "No status parameter specified. Please give either 'true', 'false' or 'toggle' as paused parameter."
		[ "${2}" = "true" ] || [ "${2}" = "false" ] || [ "${2}" = "toggle" ] \
			|| die "Please give either 'true', 'false' or 'toggle' as paused parameter."
		if [ "${2}" = "toggle" ]; then
			paused=$(property_get paused | ( read -r _ _ paused; printf "%s\n" "${paused}"; ))
			if [ "${paused}" = "true" ]; then
				property_set paused variant:boolean:false
			else
				property_set paused variant:boolean:true
			fi
		else
			property_set paused variant:boolean:"$2"
		fi
		;;
	"rules")
		case "${2:-}" in
			"" | --json)
				busctl_checked RuleList \
				| {
					if [ "${2:-}" = '--json' ]
					then
						cat
					else
						command -v jq >/dev/null 2>/dev/null || die "Command jq not found"
						jq --raw-output '.data[][] | ["[\(.name.data)]"], [to_entries[] | select(.key != "name") | "    \(.key) = \(.value.data)"] | join("\n")'
					fi
				} \
					|| die "Dunst is unreachable or the version is too old."
			;;
			*)
				die "Unknown format \"${2}\". Please use either \"--json\" or no option at all."
			;;
		esac
		;;
	"rule")
		[ "${2:-}" ] \
			|| die "No rule name parameter specified. Please give the rule name"
		case "${3:-}" in
			"disable")
				state=0
				;;
			"enable")
				state=1
				;;
			"toggle")
				state=2
				;;
			*)
				die "No valid rule state parameter specified. Please give either 'enable', 'disable' or 'toggle'"
				;;
		esac
		method_call "${DBUS_IFAC_DUNST}.RuleEnable" "string:${2:-1}" "int32:${state}" >/dev/null
		;;
	"get-pause-level")
		property_get pauseLevel | ( read -r _ _ paused; printf "%s\n" "${paused}"; )
		;;
	"set-pause-level")
		[ "${2:-}" ] \
			|| die "No status parameter specified. Please give a number as paused parameter."
		case "$2" in
			(*[!0123456789]*)
				die "Please give a number as paused level parameter." ;;
			('')
				die "Please give a number as paused level parameter." ;;
		esac
		property_set pauseLevel variant:uint32:"$2"
		;;
	"help"|"--help"|"-h")
		show_help
		;;
	"debug")
		dbus-send --print-reply=literal --dest="${DBUS_NAME}" "${DBUS_PATH}" "${DBUS_IFAC_FDN}.GetServerInformation" >/dev/null 2>/dev/null \
			|| die "No notification manager is running."

		dbus-send --print-reply=literal --dest="${DBUS_NAME}" "${DBUS_PATH}" "${DBUS_IFAC_FDN}.GetServerInformation" \
			| (
					read -r name _ version _
					[ "${name}" = "dunst" ]
					printf "dunst version: %s\n" "${version}"
				) \
			|| die "Another notification manager is running. It's not dunst"

		dbus-send --print-reply=literal --dest="${DBUS_NAME}" "${DBUS_PATH}" "${DBUS_IFAC_DUNST}.Ping" >/dev/null 2>/dev/null \
			|| die "Dunst controlling interface not available. Is the version too old?"
		;;
	"history")
		busctl_checked NotificationListHistory \
			|| die "Dunst is not running or unreachable."
		;;
	"reload")
		shift
		method_call "${DBUS_IFAC_DUNST}.ConfigReload" "array:string:$(IFS=','; echo "$*")" >/dev/null
		;;
	"")
		die "dunstctl: No command specified. Use dunstctl help"
		;;
	*)
		die "dunstctl: unrecognized command '${1:-}'. Please consult the usage."
		;;
esac
# vim: noexpandtab