Mercurial > irccd
annotate plugins/history/history.js @ 947:95201fd9ad88
irccd: servers are now linked lists
- Add reference counting to be shared with Javascript.
- Implement server-disconnect command.
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sat, 16 Jan 2021 09:45:33 +0100 |
parents | 5e25439fe98d |
children | 0d71bfa6c97a |
rev | line source |
---|---|
0 | 1 /* |
2 * history.js -- track nickname's history | |
3 * | |
913 | 4 * Copyright (c) 2013-2020 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 | |
157
9672dc88a158
Plugin history: style
David Demelier <markand@malikania.fr>
parents:
143
diff
changeset
|
19 // Plugin information. |
9672dc88a158
Plugin history: style
David Demelier <markand@malikania.fr>
parents:
143
diff
changeset
|
20 info = { |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
21 name: "history", |
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: "track nickname's history", |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
25 version: "@IRCCD_VERSION@" |
157
9672dc88a158
Plugin history: style
David Demelier <markand@malikania.fr>
parents:
143
diff
changeset
|
26 }; |
9672dc88a158
Plugin history: style
David Demelier <markand@malikania.fr>
parents:
143
diff
changeset
|
27 |
143
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
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 Server = Irccd.Server; |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
34 var Util = Irccd.Util; |
0 | 35 |
847
a23b7b574ed2
irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents:
824
diff
changeset
|
36 Plugin.templates = { |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
37 "error": "#{nickname}, I'm sorry, something went wrong.", |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
38 "seen": "#{nickname}, I've seen #{target} for the last time the %d-%m-%Y %H:%M", |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
39 "said": "#{nickname}, #{target} said on %d-%m-%Y %H:%M: #{message}", |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
40 "unknown": "#{nickname}, I've never seen #{target}.", |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
41 "usage": "#{nickname}, usage: #{plugin} seen | said <target>." |
0 | 42 }; |
43 | |
44 function isSelf(server, origin) | |
45 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
46 return server.info().nickname === Util.splituser(origin); |
0 | 47 } |
48 | |
49 function command(server) | |
50 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
51 return server.info().commandChar + "history"; |
0 | 52 } |
53 | |
54 function path(server, channel) | |
55 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
56 var p; |
0 | 57 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
58 if (Plugin.config["file"] !== undefined) { |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
59 p = Util.format(Plugin.config["file"], { |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
60 "server": server.toString(), |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
61 "channel": channel |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
62 }); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
63 } else |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
64 p = Plugin.paths.cache + "/db.json"; |
0 | 65 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
66 return p; |
0 | 67 } |
68 | |
69 function read(server, channel, nickname) | |
70 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
71 var p = path(server, channel); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
72 var db = {}; |
0 | 73 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
74 if (File.exists(p)) { |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
75 var file = new File(path(server, channel), "r"); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
76 var str = file.read(); |
0 | 77 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
78 db = JSON.parse(str); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
79 } |
0 | 80 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
81 // Complete if needed. |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
82 if (!db[server]) |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
83 db[server] = {}; |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
84 if (!db[server][channel]) |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
85 db[server][channel] = {}; |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
86 if (!db[server][channel][nickname]) |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
87 db[server][channel][nickname] = {}; |
0 | 88 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
89 return db; |
0 | 90 } |
91 | |
92 function write(server, channel, nickname, message) | |
93 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
94 var db = read(server, channel, nickname); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
95 var entry = db[server][channel][nickname]; |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
96 var p = path(server, channel); |
0 | 97 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
98 if (!File.exists(File.dirname(p))) { |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
99 Logger.debug("creating directory " + File.dirname(p)); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
100 Directory.mkdir(File.dirname(p)); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
101 } |
0 | 102 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
103 var file = new File(path(server, channel), "wt"); |
0 | 104 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
105 entry.timestamp = Date.now(); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
106 entry.message = (message) ? message : entry.message; |
0 | 107 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
108 file.write(JSON.stringify(db)); |
0 | 109 } |
110 | |
111 function find(server, channel, target) | |
112 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
113 var db = read(server, channel, target); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
114 var it = db[server][channel][target]; |
0 | 115 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
116 if (it.timestamp) |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
117 return it; |
0 | 118 } |
119 | |
120 function onCommand(server, origin, channel, message) | |
121 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
122 channel = channel.toLowerCase(); |
454
8b615d37d303
Fix #642: plugins must be case sensitive
David Demelier <markand@malikania.fr>
parents:
394
diff
changeset
|
123 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
124 var args = message.trim().split(" "); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
125 var kw = { |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
126 channel: channel, |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
127 command: command(server), |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
128 nickname: Util.splituser(origin), |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
129 origin: origin, |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
130 plugin: Plugin.info().name, |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
131 server: server.toString() |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
132 }; |
0 | 133 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
134 if (args.length !== 2 || args[0].length === 0 || args[1].length === 0) { |
847
a23b7b574ed2
irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents:
824
diff
changeset
|
135 server.message(channel, Util.format(Plugin.templates.usage, kw)); |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
136 return; |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
137 } |
0 | 138 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
139 if (args[0] !== "seen" && args[0] !== "said") { |
847
a23b7b574ed2
irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents:
824
diff
changeset
|
140 server.message(channel, Util.format(Plugin.templates.usage, kw)); |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
141 return; |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
142 } |
0 | 143 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
144 args[1] = args[1].toLowerCase(); |
454
8b615d37d303
Fix #642: plugins must be case sensitive
David Demelier <markand@malikania.fr>
parents:
394
diff
changeset
|
145 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
146 if (isSelf(server, args[1])) |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
147 return; |
0 | 148 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
149 try { |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
150 var info = find(server, channel, args[1]); |
0 | 151 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
152 kw.target = args[1]; |
0 | 153 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
154 if (!info) { |
847
a23b7b574ed2
irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents:
824
diff
changeset
|
155 server.message(channel, Util.format(Plugin.templates.unknown, kw)); |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
156 return; |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
157 } |
0 | 158 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
159 kw.date = info.timestamp; |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
160 kw.message = info.message ? info.message : ""; |
0 | 161 |
847
a23b7b574ed2
irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents:
824
diff
changeset
|
162 server.message(channel, Util.format(Plugin.templates[args[0] == "seen" ? "seen" : "said"], kw)); |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
163 } catch (e) { |
847
a23b7b574ed2
irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents:
824
diff
changeset
|
164 server.message(channel, Util.format(Plugin.templates["error"], kw)); |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
165 } |
0 | 166 } |
167 | |
168 function onJoin(server, origin, channel) | |
169 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
170 origin = Util.splituser(origin).toLowerCase(); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
171 channel = channel.toLowerCase(); |
454
8b615d37d303
Fix #642: plugins must be case sensitive
David Demelier <markand@malikania.fr>
parents:
394
diff
changeset
|
172 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
173 write(server, channel, origin); |
0 | 174 } |
175 | |
176 function onMessage(server, origin, channel, message) | |
177 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
178 origin = Util.splituser(origin).toLowerCase(); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
179 channel = channel.toLowerCase(); |
454
8b615d37d303
Fix #642: plugins must be case sensitive
David Demelier <markand@malikania.fr>
parents:
394
diff
changeset
|
180 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
181 write(server, channel, origin, message); |
0 | 182 } |
183 | |
184 onMe = onMessage; | |
185 | |
186 function onTopic(server, origin, channel) | |
187 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
188 origin = Util.splituser(origin).toLowerCase(); |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
189 channel = channel.toLowerCase(); |
454
8b615d37d303
Fix #642: plugins must be case sensitive
David Demelier <markand@malikania.fr>
parents:
394
diff
changeset
|
190 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
191 write(server, origin, channel) |
0 | 192 } |
193 | |
194 function onLoad() | |
195 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
196 var table = Server.list(); |
0 | 197 |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
198 for (var k in table) |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
199 for (var c in table[k].info().channels) |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
200 table[k].names(c); |
0 | 201 } |
202 | |
203 function onNames(server, channel, list) | |
204 { | |
773
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
205 for (var i = 0; i < list.length; ++i) |
8c44bbcbbab9
Misc: style, cleanup and update
David Demelier <markand@malikania.fr>
parents:
722
diff
changeset
|
206 write(server, channel.toLowerCase(), list[i]); |
31 | 207 } |