Mercurial > irccd

annotate examples/sample-hook.sh @ 1119:74aba215dc3c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
examples: add sample-hook example
author David Demelier <markand@malikania.fr>
date Mon, 22 Nov 2021 16:30:28 +0100
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1119
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 #!/bin/sh
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 # This sample hook is a minimalist logger to show events and their arguments.
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 # Please note that origin is always the fully qualified username with its host
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 # so you have to split it as shown below.
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 # Those arguments are always available:
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 # $0: hook path
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 # $1: event name (e.g. onConnect)
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 # $2: server identifier (as used in the configuration file)
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 # $3: full origin
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
15
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 case $1 in
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 # onConnect
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 # ---------------------------------------
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 # $1: onConnect
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 # $2: server-id
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 onConnect)
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 printf "[%s] connected\n" "$2"
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 ;;
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
26
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 # onDisconnect
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 # ---------------------------------------
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 # $1: onDisconnect
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 # $2: server-id
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 onDisconnect)
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 printf "[%s] connection lost\n" "$2"
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 ;;
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
36
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 # onInvite
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 # ---------------------------------------
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 # $1: onInvite
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 # $2: server-id
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 # $3: origin
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 # $4: channel
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 onInvite)
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 printf "[%s] %s invited me on %s\n" "$2" "${3%\!*}" "$4"
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 ;;
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
48
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 # onJoin
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 # ---------------------------------------
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 # $1: onJoin
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 # $2: server-id
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 # $3: origin
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 # $4: channel
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 onJoin)
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 printf "[%s] %s joined %s\n" "$2" "${3%\!*}" "$4"
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 ;;
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
60
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 # onMode
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 # ---------------------------------------
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 # $1: onMode
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 # $2: server-id
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 # $3: origin
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 # $N: arguments...
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 onMode)
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 printf "[%s] %s changed mode " "$2" "${3%\!*}"
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 shift 3
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 printf "$@"
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 printf "\n"
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 ;;
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
75
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 # onMessage
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 # ---------------------------------------
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 # $1: onMessage
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 # $2: server-id
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 # $3: origin
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 # $4: channel
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 # $5: message
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 onMessage)
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 printf "[%s] (%s) %s: %s\n" "$2" "$4" "${3%\!*}" "$5"
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 ;;
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
88
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
89 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 # onMe
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
91 # ---------------------------------------
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
92 # $1: onMe
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
93 # $2: server-id
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 # $3: origin
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
95 # $4: channel
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 # $4: message
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
97 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
98 onMe)
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
99 printf "[%s] (%s) * %s %s\n" "$2" "$4" "${3%\!*}" "$5"
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
100 ;;
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
101
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
102 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
103 # onKick
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
104 # ---------------------------------------
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
105 # $1: onKick
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
106 # $2: server-id
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
107 # $3: origin
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
108 # $4: channel
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
109 # $5: target
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
110 # $6: reason
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
111 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
112 onKick)
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
113 printf "[%s] %s has been kicked from %s by %s [%s]\n" "$2" "$5" "$4" "${3%\!*}" "$6"
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
114 ;;
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
115
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
116 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
117 # onNick
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
118 # ---------------------------------------
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
119 # $1: onKick
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
120 # $2: server-id
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
121 # $3: origin
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
122 # $4: nickname
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
123 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
124 onNick)
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
125 printf "[%s] %s -> %s\n" "$2" "${3%\!*}" "$4"
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
126 ;;
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
127
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
128 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
129 # onNotice
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
130 # ---------------------------------------
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
131 # $1: onNotice
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
132 # $2: server-id
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
133 # $3: origin
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
134 # $4: channel
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
135 # $5: message
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
136 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
137 onNotice)
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
138 printf "[%s] (notice) %s %s: %s\n" "$2" "$4" "${3%\!*}" "$5"
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
139 ;;
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
140
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
141 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
142 # onPart
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
143 # ---------------------------------------
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
144 # $1: onPart
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
145 # $2: server-id
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
146 # $3: origin
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
147 # $4: channel
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
148 # $5: reason
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
149 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
150 onPart)
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
151 printf "[%s] %s left %s [%s]\n" "$2" "${3%\!*}" "$4" "$5"
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
152 ;;
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
153
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
154 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
155 # onTopic
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
156 # ---------------------------------------
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
157 # $1: onTopic
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
158 # $2: server-id
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
159 # $3: origin
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
160 # $4: channel
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
161 # $5: new topic
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
162 #
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
163 onTopic)
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
164 printf "[%s] %s has changed topic of %s to %s\n" "$2" "${3%\!*}" "$4" "$5"
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
165 ;;
74aba215dc3c examples: add sample-hook example
David Demelier <markand@malikania.fr>
parents:
diff changeset
166 esac