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 pathgreetingSystem.js
More file actions
336 lines (294 loc) · 13.7 KB
/
Copy pathgreetingSystem.js
File metadata and controls
336 lines (294 loc) · 13.7 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
/*
* Copyright (C) 2016-2026 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/>.
*/
/* global Packages */
/**
* greetingSystem.js
*
* Tags in greetings:
* - (name) The username corresponding to the target user
*/
(function () {
let autoGreetEnabled = $.getSetIniDbBoolean('greetingSettings', 'autoGreetEnabled', false),
defaultJoinMessage = $.getSetIniDbString('greetingSettings', 'defaultJoin', '(name) joined!'),
greetingCooldown = $.getSetIniDbNumber('greetingSettings', 'cooldown', (6 * 36e5)),
/* 6 Hours */
greetingQueue = new Packages.java.util.concurrent.ConcurrentLinkedQueue,
onJoin = $.getSetIniDbBoolean('greetingSettings', 'onJoin', true),
userSelfService = $.getSetIniDbBoolean('greetingSettings', 'userSelfService', false);
function resetGreetingCooldowns() {
let table = Packages.com.gmt2001.datastore.SectionVariableValueTable.instance("phantombot_greetingCoolDown");
if (table !== null) {
$.inidb.dsl().batched(function (c) {
try {
c.dsl().startTransaction().execute();
} catch (ex) {
if (!ex.getMessage().contains("cannot start a transaction within a transaction")) {
throw ex;
}
}
c.dsl().update(table)
.set(Packages.java.util.Collections.singletonMap(table.VALUE, '0')).execute();
c.dsl().commit().execute();
});
}
}
resetGreetingCooldowns();
/**
* @event ircChannelJoin
* @usestransformers global twitch noevent
*/
$.bind('ircChannelJoin', function (event) {
if ($.isOnline($.channelName) && autoGreetEnabled && onJoin) {
addToQueue(event.getUser().toLowerCase());
}
});
/**
* @event ircChannelMessage
* @usestransformers global twitch noevent
*/
$.bind('ircChannelMessage', function (event) {
if ($.isOnline($.channelName) && autoGreetEnabled && !onJoin) {
addToQueue(event.getSender().toLowerCase());
}
});
function addToQueue(sender) {
let rankStr = $.resolveRank(sender),
message = $.optIniDbString('greeting', sender),
lastUserGreeting = $.getIniDbNumber('greetingCoolDown', sender, 0),
now = $.systemTime();
if (lastUserGreeting + greetingCooldown < now) {
if (message.isPresent()) {
message = message.get().replace('(name)', rankStr); // Keep (name)
message = $.transformers.tags(null, message, ['twitch', ['noevent']]);
greetingQueue.add(message);
$.inidb.set('greetingCoolDown', sender, now);
}
}
}
/**
* @function doUserGreetings
* Provides timer function for sending greetings into chat. Will delete messages if the
* host disables autoGreetings in the middle of a loop. The reason for a delay is to
* ensure that the output queue does not become overwhelmed.
*/
function doUserGreetings() {
setInterval(function () {
/* Send a greeting out into chat. */
if (!greetingQueue.isEmpty() && autoGreetEnabled) {
$.say(greetingQueue.poll());
}
/* There are greetings, however, autoGreet has been disabled, so destroy the queue. */
if (!greetingQueue.isEmpty() && !autoGreetEnabled) {
greetingQueue = new Packages.java.util.concurrent.ConcurrentLinkedQueue;
}
}, 15000, 'scripts::systems::greetingSystem.js');
}
/**
* @function greetingspanelupdate
*/
function greetingspanelupdate() {
autoGreetEnabled = $.getIniDbBoolean('greetingSettings', 'autoGreetEnabled');
defaultJoinMessage = $.getIniDbString('greetingSettings', 'defaultJoin');
greetingCooldown = $.getIniDbNumber('greetingSettings', 'cooldown');
}
/**
* @event command
*/
$.bind('command', function (event) {
let sender = event.getSender().toLowerCase(),
command = event.getCommand(),
args = event.getArgs(),
action = args[0],
cooldown,
message,
username,
isSilent;
/**
* @commandpath greeting - Base command for controlling greetings.
*/
if ($.equalsIgnoreCase(command, 'greeting')) {
if (!action) {
if ($.checkUserPermission(sender, event.getTags(), $.PERMISSION.Admin)) {
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.generalusage.admin'));
} else if (userSelfService) {
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.generalusage.other'));
}
return;
}
/**
* @commandpath greeting cooldown [hours] - Cooldown in hours before displaying a greeting for a person rejoining chat.
*/
if ($.equalsIgnoreCase(action, 'cooldown')) {
if (!args[1]) {
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.cooldown.usage'));
return;
}
cooldown = parseInt(args[1]);
if (isNaN(cooldown)) {
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.cooldown.usage'));
return;
}
greetingCooldown = cooldown * 36e5; // Convert hours to ms
$.inidb.set('greetingSettings', 'cooldown', greetingCooldown);
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.cooldown.success', cooldown));
return;
}
/**
* @commandpath greeting toggle - Enable/disable the greeting system.
*/
if ($.equalsIgnoreCase(action, 'toggle')) {
autoGreetEnabled = !autoGreetEnabled;
$.setIniDbBoolean('greetingSettings', 'autoGreetEnabled', autoGreetEnabled);
if (autoGreetEnabled) {
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.set.autogreet.enabled', $.viewer.getByLogin($.botName).name()));
} else {
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.set.autogreet.disabled', $.viewer.getByLogin($.botName).name()));
}
return;
}
/**
* @commandpath greeting setdefault - Set the default greeting message
*/
if ($.equalsIgnoreCase(action, 'setdefault')) {
message = args.splice(1, args.length - 1).join(' ');
if (!message) {
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.generalusage.admin'));
return;
}
$.inidb.set('greetingSettings', 'defaultJoin', message);
defaultJoinMessage = message;
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.set.default.success', defaultJoinMessage));
return;
}
/**
* @commandpath greeting enable [default | message] - Enable greetings and use the default or set a message.
*/
if ($.equalsIgnoreCase(action, 'enable') && userSelfService) {
message = args.splice(1, args.length - 1).join(' ');
if (!message) {
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.generalusage.other'));
return;
}
if ($.equalsIgnoreCase(message, 'default')) {
$.inidb.set('greeting', sender, defaultJoinMessage);
} else {
$.inidb.set('greeting', sender, message);
}
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.set.personal.success', $.getIniDbString('greeting', sender)));
return;
}
/**
* @commandpath greeting set [username] [default | message] - Set greetings for a user and use the default or set a message.
*/
if ($.equalsIgnoreCase(action, 'set') || $.equalsIgnoreCase(action, 'setsilent')) {
isSilent = $.equalsIgnoreCase(action, 'setsilent');
username = args[1].toLowerCase();
message = args.splice(2, args.length - 1).join(' ');
if (!message || !username) {
if (!isSilent) {
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.generalusage.other'));
}
return;
}
if ($.equalsIgnoreCase(message, 'default')) {
$.inidb.set('greeting', username, defaultJoinMessage);
} else {
$.inidb.set('greeting', username, message);
}
if (!isSilent) {
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.set.success', username, $.getIniDbString('greeting', username)));
}
return;
}
/**
* @commandpath greeting remove [username] - Delete a users greeting and automated greeting at join
*/
if ($.equalsIgnoreCase(action, 'remove') || $.equalsIgnoreCase(action, 'removesilent')) {
isSilent = $.equalsIgnoreCase(action, 'removesilent');
username = args[1].toLowerCase();
if (args[1] === undefined) {
if (!isSilent) {
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.remove.error'));
}
return;
}
if ($.inidb.exists('greeting', args[1])) {
$.inidb.del('greeting', args[1]);
if (!isSilent) {
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.remove.success', args[1]));
}
}
return;
}
/**
* @commandpath greeting disable - Delete personal greeting and automated greeting at join
*/
if ($.equalsIgnoreCase(action, 'disable') && userSelfService) {
if ($.inidb.exists('greeting', sender)) {
$.inidb.del('greeting', sender);
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.remove.personal.success'));
}
return;
}
/**
* @commandpath greeting toggleblockselfservice - Toggles between users being allowed or prevented to set their own greeting message
*/
if ($.equalsIgnoreCase(action, 'toggleuserselfservice')) {
userSelfService = !userSelfService;
$.inidb.SetBoolean('greetingSettings', '', 'userSelfService', userSelfService);
if (userSelfService) {
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.set.userselfservice.on'));
} else {
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.set.userselfservice.off'));
}
return;
}
/**
* @commandpath greeting toggleonjoin - Toggles if greetings are sent when a users joins the chat or when a user first sends a message
*/
if ($.equalsIgnoreCase(action, 'toggleonjoin')) {
onJoin = !onJoin;
$.inidb.SetBoolean('greetingSettings', '', 'onJoin', onJoin);
if (onJoin) {
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.set.onJoin.on'));
} else {
$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.set.onJoin.off'));
}
return;
}
}
});
/**
* @event initReady
*/
$.bind('initReady', function () {
$.registerChatCommand('./systems/greetingSystem.js', 'greeting', $.PERMISSION.Regular);
$.registerChatSubcommand('greeting', 'cooldown', $.PERMISSION.Admin);
$.registerChatSubcommand('greeting', 'toggle', $.PERMISSION.Admin);
$.registerChatSubcommand('greeting', 'set', $.PERMISSION.Mod);
$.registerChatSubcommand('greeting', 'setsilent', $.PERMISSION.Admin);
$.registerChatSubcommand('greeting', 'setdefault', $.PERMISSION.Mod);
$.registerChatSubcommand('greeting', 'enable', $.PERMISSION.Regular);
$.registerChatSubcommand('greeting', 'remove', $.PERMISSION.Mod);
$.registerChatSubcommand('greeting', 'removesilent', $.PERMISSION.Admin);
$.registerChatSubcommand('greeting', 'disable', $.PERMISSION.Regular);
$.registerChatSubcommand('greeting', 'toggleuserselfservice', $.PERMISSION.Admin);
$.registerChatSubcommand('greeting', 'toggleonjoin', $.PERMISSION.Admin);
doUserGreetings();
});
$.greetingspanelupdate = greetingspanelupdate;
})();
You can’t perform that action at this time.