Skip to content
Navigation Menu
{{ message }}
forked from PhantomBot/PhantomBot
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathwelcomeSystem.js
More file actions
348 lines (323 loc) · 14.3 KB
/
Copy pathwelcomeSystem.js
File metadata and controls
348 lines (323 loc) · 14.3 KB
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
/*
* Copyright (C) 2016-2021 phantombot.github.io/PhantomBot
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* welcomeSystem.js
*
* Tags in welcomes:
* - (name) The username corresponding to the target user
*/
(function() {
var welcomeEnabled = $.getSetIniDbBoolean('welcome', 'welcomeEnabled', false),
welcomeMessage = $.getSetIniDbString('welcome', 'welcomeMessage', 'Welcome back, (names)!'),
welcomeMessageFirst = $.getSetIniDbString('welcome', 'welcomeMessageFirst', '(names) (1 is)(2 are) new here. Give them a warm welcome!'),
welcomeCooldown = $.getSetIniDbNumber('welcome', 'cooldown', (6 * 36e5)), // 6 Hours
welcomeQueue = new java.util.concurrent.ConcurrentLinkedQueue,
welcomeQueueFirst = new java.util.concurrent.ConcurrentLinkedQueue,
welcomeTimer = null,
// used to synchronize access to welcomeQueue, welcomeQueueFirst, and welcomeTimer
welcomeLock = new java.util.concurrent.locks.ReentrantLock;
/**
* @event ircChannelMessage
*/
$.bind('ircChannelMessage', function(event) {
var sender = event.getSender(),
now = $.systemTime();
if ($.equalsIgnoreCase(sender, $.channelName)) {
return;
}
if ($.equalsIgnoreCase(sender, $.botName)) {
return;
}
if ($.isOnline($.channelName) && welcomeEnabled && (welcomeMessage || welcomeMessageFirst)) {
var lastUserMessage = $.getIniDbNumber('welcomeLastUserMessage', sender),
firstTimeChatter = lastUserMessage === undefined,
queue = firstTimeChatter ? welcomeQueueFirst : welcomeQueue;
lastUserMessage = firstTimeChatter ? 0 : lastUserMessage;
if (!$.inidb.exists('welcome_disabled_users', sender.toLowerCase()) && lastUserMessage + welcomeCooldown < now) {
welcomeLock.lock();
try {
queue.add($.username.resolve(sender));
} finally {
welcomeLock.unlock();
}
sendUserWelcomes();
}
}
$.inidb.set('welcomeLastUserMessage', sender.toLowerCase(), now);
});
/**
* @function buildMessage
* build a welcome message from `message` (potentially containing tags).
* Supported tags:
* * (names) - replaced with the name(s) in `names`
* * (1 some text) - show 'some text' if and only if names has 1 entry
* * (2 some text) - show 'some text' if and only if names has 2 entries
* * (3 some text) - show 'some text' if and only if names has 3 or more entry
*
* @param {string} message: raw message with tags to replace message
* @param {array} names: array of user names to be welcomed
* @returns {string}: `message` with replaced tags or null if `message` or `names` is empty.
*/
function buildMessage(message, names) {
var match,
namesString;
if (!names.length || !message) {
return null;
}
return $.tags(null, message, false, {
'names': function command(args, event) {
if (!args) {
switch (names.length) {
case 1:
namesString = names[0];
break;
case 2:
namesString = names.join($.lang.get('welcomesystem.names.join1'));
break;
default:
namesString = names.slice(0, -1).join($.lang.get('welcomesystem.names.join1')) +
$.lang.get('welcomesystem.names.join2') + names[names.length - 1];
}
return {
result: String(namesString),
cache: true
};
}
},
'1': function (args, event) {
if (names.length !== 1) {
return {result: '', cache: true};
}
if ((match = args.match(/^\s?(.*)$/))) {
return {result: String(match[1]), cache: true};
}
},
'2': function (args, event) {
if (names.length !== 2) {
return {result: '', cache: true};
}
if ((match = args.match(/^\s?(.*)$/))) {
return {result: String(match[1]), cache: true};
}
},
'3': function (args, event) {
if (names.length < 3) {
return {result: '', cache: true};
}
if ((match = args.match(/^\s?(.*)$/))) {
return {result: String(match[1]), cache: true};
}
}
}, true)
}
/**
* @function processQueue
* Function to send welcome messages to the users in the queues.
* The function will start a timer to be called again if there are too many
* users in the queue to all be greeted at the same time.
*/
function processQueue() {
welcomeLock.lock();
try {
if (welcomeQueue.isEmpty() && welcomeQueueFirst.isEmpty()) {
// No welcomes within the last 15 seconds and none are waiting.
welcomeTimer = null;
}
else {
if (welcomeEnabled) {
var names = [],
message = welcomeMessageFirst ? welcomeMessageFirst : welcomeMessage;
while (names.length < 15 && !welcomeQueueFirst.isEmpty()) {
names.push(welcomeQueueFirst.poll());
}
if (!names.length) {
message = welcomeMessage;
while (names.length < 15 && !welcomeQueue.isEmpty()) {
names.push(welcomeQueue.poll());
}
}
message = buildMessage(message, names);
if (message) {
$.say(message);
}
// Check back later to see if more people are waiting to be welcomed.
welcomeTimer = setTimeout(processQueue, 15000, 'scripts::systems::welcomeSystem.js');
} else {
// There are welcomes, however, welcome has been disabled, so destroy the queues.
welcomeQueue = new java.util.concurrent.ConcurrentLinkedQueue;
welcomeQueueFirst = new java.util.concurrent.ConcurrentLinkedQueue;
welcomeTimer = null;
}
}
} finally {
welcomeLock.unlock();
}
}
/**
* @function sendUserWelcomes
* Function to handle sending welcome message. Call this function anytime
* a new user got placed in `welcomeQueue` or `welcomeQueueFirst`.
*/
function sendUserWelcomes() {
welcomeLock.lock();
try {
if (welcomeTimer == null) {
// no timer is running (implying that no welcome message was sent within
// the last 15 seconds. => send the message right away
processQueue();
}
} finally {
welcomeLock.unlock();
}
}
/**
* @function welcomepanelupdate
*/
function welcomepanelupdate() {
welcomeEnabled = $.getIniDbBoolean('welcome', 'welcomeEnabled');
welcomeMessage = $.getIniDbString('welcome', 'welcomeMessage');
welcomeMessageFirst = $.getIniDbString('welcome', 'welcomeMessageFirst');
welcomeCooldown = $.getIniDbNumber('welcome', 'cooldown');
}
/**
* @event command
*/
$.bind('command', function(event) {
var sender = event.getSender().toLowerCase(),
command = event.getCommand(),
args = event.getArgs(),
action = args[0],
cooldown,
username,
message;
/**
* @commandpath welcome - Base command for controlling welcomes.
*/
if (command.equalsIgnoreCase('welcome')) {
if (!action) {
$.say($.whisperPrefix(sender) + $.lang.get('welcomesystem.generalusage'));
return;
}
/**
* @commandpath welcome toggle - Enable/disable the welcome system.
*/
if (action.equalsIgnoreCase('toggle')) {
welcomeEnabled = !welcomeEnabled;
$.setIniDbBoolean('welcome', 'welcomeEnabled', welcomeEnabled);
if (welcomeEnabled) {
$.say($.whisperPrefix(sender) + $.lang.get('welcomesystem.set.autowelcome.enabled', $.username.resolve($.botName)));
} else {
$.say($.whisperPrefix(sender) + $.lang.get('welcomesystem.set.autowelcome.disabled', $.username.resolve($.botName)));
}
}
/**
* @commandpath welcome setmessage - Set the welcome message
*/
if (action.equalsIgnoreCase('setmessage')) {
message = args.splice(1, args.length - 1).join(' ');
$.inidb.set('welcome', 'welcomeMessage', message);
welcomeMessageFirst = message;
if (!message) {
$.say($.whisperPrefix(sender) + $.lang.get('welcomesystem.set.message.empty', $.username.resolve($.botName)));
} else {
$.say($.whisperPrefix(sender) + $.lang.get('welcomesystem.set.message.success', $.username.resolve($.botName), message));
}
return;
}
/**
* @commandpath welcome setfirstmessage - Set the welcome message
*/
if (action.equalsIgnoreCase('setfirstmessage')) {
message = args.splice(1, args.length - 1).join(' ');
$.inidb.set('welcome', 'welcomeMessageFirst', message);
welcomeMessage = message;
if (!message) {
$.say($.whisperPrefix(sender) + $.lang.get('welcomesystem.set.firstmessage.empty', $.username.resolve($.botName)));
} else {
$.say($.whisperPrefix(sender) + $.lang.get('welcomesystem.set.firstmessage.success', $.username.resolve($.botName), message));
}
return;
}
/**
* @commandpath welcome cooldown [hours] - Cooldown in hours before displaying a welcome for a person chatting.
*/
if (action.equalsIgnoreCase('cooldown')) {
if (!args[1]) {
$.say($.whisperPrefix(sender) + $.lang.get('welcomesystem.set.cooldown.show', $.getIniDbNumber('welcome', 'cooldown')));
return;
}
cooldown = parseInt(args[1]);
if (isNaN(cooldown)) {
$.say($.whisperPrefix(sender) + $.lang.get('welcomesystem.set.cooldown.usage'));
return;
}
welcomeCooldown = cooldown * 36e5; // Convert hours to ms
$.inidb.set('welcome', 'cooldown', welcomeCooldown);
$.say($.whisperPrefix(sender) + $.lang.get('welcomesystem.set.cooldown.success', cooldown));
return;
}
/**
* @commandpath welcome disable [user] - Disable welcoming of the given user.
*/
if (action.equalsIgnoreCase('disable')) {
username = !args[1] ? args[1] : $.jsString(args[1]).replace(/[^a-zA-Z0-9_]/g, '').toLowerCase();
if (!username) {
$.say($.whisperPrefix(sender) + $.lang.get('welcomesystem.set.disableuser.usage'));
return;
}
if ($.inidb.exists('welcome_disabled_users', username)) {
$.say($.whisperPrefix(sender) + $.lang.get('welcomesystem.set.disableuser.fail', username));
return;
}
$.inidb.set('welcome_disabled_users', username, true);
$.say($.whisperPrefix(sender) + $.lang.get('welcomesystem.set.disableuser.success', $.botName, username));
return;
}
/**
* @commandpath welcome enable [user] - Disable welcoming of the given user.
*/
if (action.equalsIgnoreCase('enable')) {
username = !args[1] ? args[1] : $.jsString(args[1]).replace(/[^a-zA-Z0-9_]/g, '').toLowerCase();
if (!username) {
$.say($.whisperPrefix(sender) + $.lang.get('welcomesystem.set.enableuser.usage'));
return;
}
if (!$.inidb.exists('', username)) {
$.say($.whisperPrefix(sender) + $.lang.get('welcomesystem.set.enableuser.fail', username));
return;
}
$.inidb.del('welcome_disabled_users', username);
$.say($.whisperPrefix(sender) + $.lang.get('welcomesystem.set.enableuser.success', $.botName, username));
return;
}
}
});
/**
* @event initReady
*/
$.bind('initReady', function() {
$.registerChatCommand('./systems/welcomeSystem.js', 'welcome', 2);
$.registerChatSubcommand('welcome', 'cooldown', 1);
$.registerChatSubcommand('welcome', 'toggle', 1);
$.registerChatSubcommand('welcome', 'setmessage', 2);
$.registerChatSubcommand('welcome', 'setfirstmessage', 2);
$.registerChatSubcommand('welcome', 'disable', 2);
$.registerChatSubcommand('welcome', 'enable', 2);
sendUserWelcomes();
});
$.welcomepanelupdate = welcomepanelupdate;
})();
You can’t perform that action at this time.