Mercurial > irccd
annotate plugins/history/history.js @ 157:9672dc88a158
Plugin history: style
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Mon, 23 May 2016 13:15:07 +0200 |
| parents | 11113212576c |
| children | 70ed0753ce0d |
| rev | line source |
|---|---|
| 0 | 1 /* |
| 2 * history.js -- track nickname's history | |
| 3 * | |
| 4 * Copyright (c) 2013-2016 David Demelier <markand@malikania.fr> | |
| 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 = { |
|
9672dc88a158
Plugin history: style
David Demelier <markand@malikania.fr>
parents:
143
diff
changeset
|
21 author: "David Demelier <markand@malikania.fr>", |
|
9672dc88a158
Plugin history: style
David Demelier <markand@malikania.fr>
parents:
143
diff
changeset
|
22 license: "ISC", |
|
9672dc88a158
Plugin history: style
David Demelier <markand@malikania.fr>
parents:
143
diff
changeset
|
23 summary: "track nickname's history", |
|
9672dc88a158
Plugin history: style
David Demelier <markand@malikania.fr>
parents:
143
diff
changeset
|
24 version: "@IRCCD_VERSION@" |
|
9672dc88a158
Plugin history: style
David Demelier <markand@malikania.fr>
parents:
143
diff
changeset
|
25 }; |
|
9672dc88a158
Plugin history: style
David Demelier <markand@malikania.fr>
parents:
143
diff
changeset
|
26 |
|
143
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
27 // Modules. |
| 0 | 28 var Directory = Irccd.Directory; |
| 29 var File = Irccd.File; | |
| 30 var Logger = Irccd.Logger; | |
| 31 var Plugin = Irccd.Plugin; | |
| 32 var Server = Irccd.Server; | |
| 33 var Util = Irccd.Util; | |
| 34 | |
|
143
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
35 Plugin.format = { |
| 0 | 36 "error": "#{nickname}, I'm sorry, something went wrong.", |
| 37 "seen": "#{nickname}, I've seen #{target} for the last time the %d-%m-%Y %H:%M", | |
| 38 "said": "#{nickname}, #{target} said on %d-%m-%Y %H:%M: #{message}", | |
| 39 "unknown": "#{nickname}, I've never seen #{target}.", | |
| 40 "usage": "#{nickname}, usage: #{plugin} seen | said <target>." | |
| 41 }; | |
| 42 | |
| 43 function isSelf(server, origin) | |
| 44 { | |
| 45 return server.info().nickname === Util.splituser(origin); | |
| 46 } | |
| 47 | |
| 48 function command(server) | |
| 49 { | |
| 50 return server.info().commandChar + "history"; | |
| 51 } | |
| 52 | |
| 53 function path(server, channel) | |
| 54 { | |
| 55 var p; | |
| 56 | |
| 31 | 57 if (Plugin.config["file"] !== undefined) { |
| 58 p = Util.format(Plugin.config["file"], { | |
| 0 | 59 "server": server.toString(), |
| 60 "channel": channel | |
| 61 }); | |
|
143
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
62 } else |
| 0 | 63 p = Plugin.cachePath + "db.json"; |
| 64 | |
| 65 return p; | |
| 66 } | |
| 67 | |
| 68 function read(server, channel, nickname) | |
| 69 { | |
| 70 var p = path(server, channel); | |
| 71 var db = {}; | |
| 72 | |
| 73 if (File.exists(p)) { | |
| 74 var file = new File(path(server, channel), "r"); | |
| 75 var str = file.read(); | |
| 76 | |
| 77 db = JSON.parse(str); | |
| 78 } | |
| 79 | |
|
157
9672dc88a158
Plugin history: style
David Demelier <markand@malikania.fr>
parents:
143
diff
changeset
|
80 // Complete if needed. |
| 0 | 81 if (!db[server]) |
| 82 db[server] = {}; | |
| 83 if (!db[server][channel]) | |
| 84 db[server][channel] = {}; | |
| 85 if (!db[server][channel][nickname]) | |
| 86 db[server][channel][nickname] = {}; | |
| 87 | |
| 88 return db; | |
| 89 } | |
| 90 | |
| 91 function write(server, channel, nickname, message) | |
| 92 { | |
| 93 var db = read(server, channel, nickname); | |
| 94 var entry = db[server][channel][nickname]; | |
| 95 var p = path(server, channel); | |
| 96 | |
| 97 if (!File.exists(File.dirname(p))) { | |
| 98 Logger.debug("creating directory " + File.dirname(p)); | |
| 99 Directory.mkdir(File.dirname(p)); | |
| 100 } | |
| 101 | |
| 102 var file = new File(path(server, channel), "wt"); | |
| 103 | |
| 104 entry.timestamp = Date.now(); | |
| 105 entry.message = (message) ? message : entry.message; | |
| 106 | |
| 107 file.write(JSON.stringify(db)); | |
| 108 } | |
| 109 | |
| 110 function find(server, channel, target) | |
| 111 { | |
| 112 var db = read(server, channel, target); | |
| 113 var it = db[server][channel][target]; | |
| 114 | |
| 115 if (it.timestamp) | |
| 116 return it; | |
| 117 } | |
| 118 | |
| 119 function loadFormats() | |
| 120 { | |
|
157
9672dc88a158
Plugin history: style
David Demelier <markand@malikania.fr>
parents:
143
diff
changeset
|
121 // --- DEPRECATED ------------------------------------------- |
|
143
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
122 // |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
123 // This code will be removed. |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
124 // |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
125 // Since: 2.1.0 |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
126 // Until: 3.0.0 |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
127 // Reason: new [format] section replaces it. |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
128 // |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
129 // ---------------------------------------------------------- |
|
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
130 for (var key in Plugin.format) { |
| 0 | 131 var optname = "format-" + key; |
| 132 | |
| 133 if (typeof (Plugin.config[optname]) !== "string") | |
| 134 continue; | |
| 135 | |
| 136 if (Plugin.config[optname].length === 0) | |
| 137 Logger.warning("skipping empty '" + optname + "' format"); | |
| 138 else | |
|
143
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
139 Plugin.format[key] = Plugin.config[optname]; |
| 0 | 140 } |
| 141 } | |
| 142 | |
| 143 function onCommand(server, origin, channel, message) | |
| 144 { | |
| 145 var args = message.trim().split(" "); | |
| 146 var kw = { | |
|
45
aa205621d7d6
Plugin history: add command keyword, #392
David Demelier <markand@malikania.fr>
parents:
31
diff
changeset
|
147 channel: channel, |
|
aa205621d7d6
Plugin history: add command keyword, #392
David Demelier <markand@malikania.fr>
parents:
31
diff
changeset
|
148 command: command(server), |
|
aa205621d7d6
Plugin history: add command keyword, #392
David Demelier <markand@malikania.fr>
parents:
31
diff
changeset
|
149 nickname: Util.splituser(origin), |
|
aa205621d7d6
Plugin history: add command keyword, #392
David Demelier <markand@malikania.fr>
parents:
31
diff
changeset
|
150 origin: origin, |
|
aa205621d7d6
Plugin history: add command keyword, #392
David Demelier <markand@malikania.fr>
parents:
31
diff
changeset
|
151 plugin: Plugin.info().name, |
|
aa205621d7d6
Plugin history: add command keyword, #392
David Demelier <markand@malikania.fr>
parents:
31
diff
changeset
|
152 server: server.toString() |
| 0 | 153 }; |
| 154 | |
| 155 if (args.length !== 2 || args[0].length === 0 || args[1].length === 0) { | |
|
143
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
156 server.message(channel, Util.format(Plugin.format.usage, kw)); |
| 0 | 157 return; |
| 158 } | |
| 159 | |
| 160 if (args[0] !== "seen" && args[0] !== "said") { | |
|
143
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
161 server.message(channel, Util.format(Plugin.format.usage, kw)); |
| 0 | 162 return; |
| 163 } | |
| 164 | |
| 165 if (isSelf(server, args[1])) | |
| 166 return; | |
| 167 | |
| 168 try { | |
| 169 var info = find(server, channel, args[1]); | |
| 170 | |
| 171 kw.target = args[1]; | |
| 172 | |
| 173 if (!info) { | |
|
143
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
174 server.message(channel, Util.format(Plugin.format.unknown, kw)); |
| 0 | 175 return; |
| 176 } | |
| 177 | |
| 178 kw.date = info.timestamp; | |
| 179 kw.message = info.message ? info.message : ""; | |
| 180 | |
|
143
11113212576c
Plugin history: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
45
diff
changeset
|
181 server.message(channel, Util.format(Plugin.format[args[0] == "seen" ? "seen" : "said"], kw)); |
| 0 | 182 } catch (e) { |
| 183 server.message(channel, Util.format(kw)); | |
| 184 } | |
| 185 } | |
| 186 | |
| 187 function onJoin(server, origin, channel) | |
| 188 { | |
| 189 write(server, channel, Util.splituser(origin)); | |
| 190 } | |
| 191 | |
| 192 function onMessage(server, origin, channel, message) | |
| 193 { | |
| 194 write(server, channel, Util.splituser(origin), message); | |
| 195 } | |
| 196 | |
| 197 onMe = onMessage; | |
| 198 | |
| 199 function onTopic(server, origin, channel) | |
| 200 { | |
| 201 write(server, channel, Util.splituser(origin)); | |
| 202 } | |
| 203 | |
| 204 function onLoad() | |
| 205 { | |
| 206 var table = Server.list(); | |
| 207 | |
| 208 for (var k in table) | |
| 209 for (var c in table[k].info().channels) | |
| 210 table[k].names(c); | |
| 211 | |
| 212 loadFormats(); | |
| 213 } | |
| 214 | |
| 215 function onReload() | |
| 216 { | |
| 217 loadFormats(); | |
| 218 } | |
| 219 | |
| 220 function onNames(server, channel, list) | |
| 221 { | |
| 222 for (var i = 0; i < list.length; ++i) | |
| 223 write(server, channel, list[i]); | |
| 31 | 224 } |