Mercurial > irccd
annotate plugins/logger/logger.js @ 865:a81136fc4b19
misc: add more warnings and fix some of them
author | David Demelier <markand@malikania.fr> |
---|---|
date | Thu, 25 Jul 2019 21:20:00 +0000 |
parents | 6b65493d97cf |
children | 5e25439fe98d |
rev | line source |
---|---|
0 | 1 /* |
2 * logger.js -- plugin to log everything | |
3 * | |
824
06cc2f95f479
misc: happy new year!
David Demelier <markand@malikania.fr>
parents:
773
diff
changeset
|
4 * Copyright (c) 2013-2019 David Demelier <markand@malikania.fr> |
0 | 5 * |
6 * Permission to use, copy, modify, and/or distribute this software for any | |
7 * purpose with or without fee is hereby granted, provided that the above | |
8 * copyright notice and this permission notice appear in all copies. | |
9 * | |
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | |
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | |
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | |
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | |
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
17 */ | |
18 | |
144
5ed0c78a6785
Plugin logger: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
19 // Plugin information. |
0 | 20 info = { |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
21 name: "logger", |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
22 author: "David Demelier <markand@malikania.fr>", |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
23 license: "ISC", |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
24 summary: "A plugin to log everything", |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
25 version: "@IRCCD_VERSION@" |
0 | 26 }; |
27 | |
164
3b38931801ff
Plugin logger: add initial unit test
David Demelier <markand@malikania.fr>
parents:
144
diff
changeset
|
28 // Modules. |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
29 var Directory = Irccd.Directory; |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
30 var File = Irccd.File; |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
31 var Logger = Irccd.Logger; |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
32 var Plugin = Irccd.Plugin; |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
33 var Util = Irccd.Util; |
164
3b38931801ff
Plugin logger: add initial unit test
David Demelier <markand@malikania.fr>
parents:
144
diff
changeset
|
34 |
0 | 35 /** |
847
a23b7b574ed2
irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents:
824
diff
changeset
|
36 * All available templates. |
0 | 37 */ |
847
a23b7b574ed2
irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents:
824
diff
changeset
|
38 Plugin.templates = { |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
39 "join": "%H:%M:%S >> #{nickname} joined #{channel}", |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
40 "kick": "%H:%M:%S :: #{target} has been kicked by #{nickname} [reason: #{reason}]", |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
41 "me": "%H:%M:%S * #{nickname} #{message}", |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
42 "message": "%H:%M:%S #{nickname}: #{message}", |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
43 "mode": "%H:%M:%S :: #{nickname} set mode #{mode} to #{arg}", |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
44 "notice": "%H:%M:%S [notice] #{channel} (#{nickname}) #{message}", |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
45 "part": "%H:%M:%S << #{nickname} left #{channel} [#{reason}]", |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
46 "query": "%H:%M:%S #{nickname}: #{message}", |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
47 "topic": "%H:%M:%S :: #{nickname} changed the topic of #{channel} to: #{topic}" |
0 | 48 }; |
49 | |
50 function keywords(server, channel, origin, extra) | |
51 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
52 var kw = { |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
53 "server": server.toString(), |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
54 "channel": channel, |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
55 "origin": origin, |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
56 "nickname": Util.splituser(origin) |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
57 }; |
0 | 58 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
59 for (var key in extra) |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
60 kw[key] = extra[key]; |
0 | 61 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
62 return kw; |
0 | 63 } |
64 | |
65 function write(fmt, args) | |
66 { | |
862
6b65493d97cf
plugin logger: rename path configuration to file, closes #1670
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
67 var path = Util.format(Plugin.config["file"], args); |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
68 var directory = File.dirname(path); |
0 | 69 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
70 // Try to create the directory. |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
71 if (!File.exists(directory)) { |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
72 Logger.debug("creating directory: " + directory); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
73 Directory.mkdir(directory); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
74 } |
0 | 75 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
76 Logger.debug("opening: " + path); |
0 | 77 |
847
a23b7b574ed2
irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents:
824
diff
changeset
|
78 var str = Util.format(Plugin.templates[fmt], args); |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
79 var file = new File(path, "a"); |
0 | 80 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
81 file.write(str + "\n"); |
0 | 82 } |
83 | |
84 function onLoad() | |
85 { | |
862
6b65493d97cf
plugin logger: rename path configuration to file, closes #1670
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
86 if (Plugin.config["file"] === undefined) |
6b65493d97cf
plugin logger: rename path configuration to file, closes #1670
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
87 throw new Error("Missing 'file' option"); |
0 | 88 } |
89 | |
90 function onInvite(server, origin, channel) | |
91 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
92 origin = origin.toLowerCase(); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
93 channel = channel.toLowerCase(); |
454
8b615d37d303
Fix #642: plugins must be case sensitive
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
94 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
95 write("invite", keywords(server, channel, origin)); |
0 | 96 } |
97 | |
98 function onJoin(server, origin, channel) | |
99 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
100 origin = origin.toLowerCase(); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
101 channel = channel.toLowerCase(); |
454
8b615d37d303
Fix #642: plugins must be case sensitive
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
102 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
103 write("join", keywords(server, channel, origin)); |
0 | 104 } |
105 | |
106 function onKick(server, origin, channel, target, reason) | |
107 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
108 origin = origin.toLowerCase(); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
109 channel = channel.toLowerCase(); |
454
8b615d37d303
Fix #642: plugins must be case sensitive
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
110 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
111 write("kick", keywords(server, channel, origin, { |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
112 "target": target, |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
113 "reason": reason |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
114 })); |
0 | 115 } |
116 | |
117 function onMe(server, origin, channel, message) | |
118 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
119 origin = origin.toLowerCase(); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
120 channel = channel.toLowerCase(); |
454
8b615d37d303
Fix #642: plugins must be case sensitive
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
121 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
122 write("me", keywords(server, channel, origin, { |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
123 "message": message, |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
124 })); |
0 | 125 } |
126 | |
127 function onMessage(server, origin, channel, message) | |
128 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
129 origin = origin.toLowerCase(); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
130 channel = channel.toLowerCase(); |
454
8b615d37d303
Fix #642: plugins must be case sensitive
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
131 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
132 write("message", keywords(server, channel, origin, { |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
133 "message": message, |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
134 })); |
0 | 135 } |
136 | |
577
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
454
diff
changeset
|
137 function onMode(server, origin, channel, mode, limit, user, mask) |
0 | 138 { |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
139 origin = origin.toLowerCase(); |
454
8b615d37d303
Fix #642: plugins must be case sensitive
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
140 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
141 write("mode", keywords(server, channel, origin, { |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
142 "mode": mode, |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
143 "limit": limit, |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
144 "user": user, |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
145 "mask": mask |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
146 })); |
0 | 147 } |
148 | |
149 function onNick(server, origin, nickname) | |
150 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
151 // TODO: write for all servers/channels a log entry |
0 | 152 } |
153 | |
577
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
454
diff
changeset
|
154 function onNotice(server, origin, channel, notice) |
0 | 155 { |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
156 origin = origin.toLowerCase(); |
454
8b615d37d303
Fix #642: plugins must be case sensitive
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
157 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
158 write("notice", keywords(server, channel, origin, { |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
159 "message": notice, |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
160 })); |
0 | 161 } |
162 | |
163 function onPart(server, origin, channel, reason) | |
164 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
165 origin = origin.toLowerCase(); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
166 channel = channel.toLowerCase(); |
454
8b615d37d303
Fix #642: plugins must be case sensitive
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
167 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
168 write("part", keywords(server, channel, origin, { |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
169 "reason": reason, |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
170 })); |
0 | 171 } |
172 | |
173 function onTopic(server, origin, channel, topic) | |
174 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
175 origin = origin.toLowerCase(); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
176 channel = channel.toLowerCase(); |
454
8b615d37d303
Fix #642: plugins must be case sensitive
David Demelier <markand@malikania.fr>
parents:
413
diff
changeset
|
177 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
178 write("topic", keywords(server, channel, origin, { |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
179 "topic": topic |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
180 })); |
0 | 181 } |