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 pathnoticeSystem.js
More file actions
366 lines (331 loc) · 14.5 KB
/
Copy pathnoticeSystem.js
File metadata and controls
366 lines (331 loc) · 14.5 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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
/*
* 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/>.
*/
/**
* noticeSystem.js
*
* Will say a message or a command every x amount of minutes.
*/
(function() {
var noticeReqMessages = $.getSetIniDbNumber('noticeSettings', 'reqmessages', 25),
noticeInterval = $.getSetIniDbNumber('noticeSettings', 'interval', 10),
noticeToggle = $.getSetIniDbBoolean('noticeSettings', 'noticetoggle', false),
numberOfNotices = (parseInt($.inidb.GetKeyList('notices', '').length) ? parseInt($.inidb.GetKeyList('notices', '').length) : 0),
noticeOffline = $.getSetIniDbBoolean('noticeSettings', 'noticeOfflineToggle', false),
isReloading = false,
messageCount = 0,
RandomNotice = 0,
lastNoticeSent = 0,
interval;
/**
* @function reloadNotices
*/
function reloadNotices() {
if (!isReloading) {
isReloading = true;
var keys = $.inidb.GetKeyList('notices', ''),
count = 0,
temp = [],
i;
for (i = 0; i < keys.length; i++) {
if ($.inidb.get('notices', keys[i]) != null) {
temp[i] = $.inidb.get('notices', keys[i])
}
}
$.inidb.RemoveFile('notices');
for (i = 0; i < temp.length; i++) {
$.inidb.set('notices', 'message_' + count, temp[i]);
count++;
}
numberOfNotices = $.inidb.GetKeyList('notices', '').length;
if (RandomNotice >= numberOfNotices) {
RandomNotice = 0;
}
isReloading = false;
}
};
/**
* @function sendNotice
*/
function sendNotice() {
var EventBus = Packages.tv.phantombot.event.EventBus,
CommandEvent = Packages.tv.phantombot.event.command.CommandEvent,
start = RandomNotice,
notice = null;
do {
notice = $.inidb.get('notices', 'message_' + RandomNotice);
RandomNotice++;
if (RandomNotice >= numberOfNotices) {
RandomNotice = 0;
}
if (notice && notice.match(/\(gameonly=.*\)/g)) {
var game = notice.match(/\(gameonly=(.*)\)/)[1];
if ($.getGame($.channelName).equalsIgnoreCase(game)) {
notice = $.replace(notice, notice.match(/(\(gameonly=.*\))/)[1], "");
} else {
notice = null;
}
}
} while(!notice && start !== RandomNotice);
if (notice == null) {
return;
}
if (notice.startsWith('command:')) {
notice = notice.substring(8).replace('!', '');
EventBus.instance().post(new CommandEvent($.botName, notice, ' '));
} else if (notice.startsWith('!')) {
notice = notice.substring(1);
EventBus.instance().post(new CommandEvent($.botName, notice, ' '));
} else {
$.say(notice);
}
};
/**
* @function reloadNoticeSettings
*/
function reloadNoticeSettings() {
noticeReqMessages = $.getIniDbNumber('noticeSettings', 'reqmessages');
noticeToggle = $.getIniDbBoolean('noticeSettings', 'noticetoggle');
noticeOffline = $.getIniDbBoolean('noticeSettings', 'noticeOfflineToggle');
noticeInterval = $.getIniDbNumber('noticeSettings', 'interval');
};
/**
* @event ircChannelMessage
*/
$.bind('ircChannelMessage', function(event) {
messageCount++;
});
/**
* @event command
*/
$.bind('command', function(event) {
var sender = event.getSender(),
command = event.getCommand(),
argsString = event.getArguments().trim(),
args = event.getArgs(),
action = args[0],
message = '';
/**
* @commandpath notice - Base command for managing notices
*/
if (command.equalsIgnoreCase('notice')) {
if (args.length == 0) {
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-usage'));
return;
}
/**
* @commandpath notice get [id] - Gets the notice related to the ID
*/
if (action.equalsIgnoreCase('get')) {
if (args.length < 2) {
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-get-usage', numberOfNotices));
return;
} else if (!$.inidb.exists('notices', 'message_' + args[1])) {
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-error-notice-404'));
return;
} else {
$.say($.inidb.get('notices', 'message_' + args[1]));
return;
}
}
/**
* @commandpath notice edit [id] [new message] - Replace the notice at the given ID
*/
if (action.equalsIgnoreCase('edit')) {
if (args.length < 3) {
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-edit-usage', numberOfNotices));
return;
} else if (!$.inidb.exists('notices', 'message_' + args[1])) {
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-error-notice-404'));
return;
} else {
argsString = args.slice(2).join(' ');
$.inidb.set('notices', 'message_' + args[1], argsString);
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-edit-success'));
return;
}
}
/**
* USED FOR THE PANEL
*/
if (action.equalsIgnoreCase('editsilent')) {
if (args.length < 3) {
//$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-edit-usage', numberOfNotices));
return;
} else if (!$.inidb.exists('notices', 'message_' + args[1])) {
//$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-error-notice-404'));
return;
} else {
argsString = args.slice(2).join(' ');
$.inidb.set('notices', 'message_' + args[1], argsString);
//$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-edit-success'));
return;
}
}
/**
* @commandpath notice remove [id] - Removes the notice related to the given ID
*/
if (action.equalsIgnoreCase('remove')) {
if (args.length < 2) {
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-remove-usage', numberOfNotices));
return;
} else if (!$.inidb.exists('notices', 'message_' + args[1])) {
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-error-notice-404'));
return;
} else {
$.inidb.del('notices', 'message_' + args[1]);
numberOfNotices--;
reloadNotices();
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-remove-success'));
return;
}
}
/**
* USED BY THE PANEL
*/
if (action.equalsIgnoreCase('removesilent')) {
if (args.length < 2) {
//$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-remove-usage', numberOfNotices));
return;
} else if (!$.inidb.exists('notices', 'message_' + args[1])) {
//$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-error-notice-404'));
return;
} else {
$.inidb.del('notices', 'message_' + args[1]);
numberOfNotices--;
reloadNotices();
//$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-remove-success'));
return;
}
}
/**
* @commandpath notice add [message or command] - Adds a notice, with a custom message, or a command ex: !notice add command:COMMANDS_NAME
*/
if (action.equalsIgnoreCase('add')) {
if (args.length < 2) {
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-add-usage'));
return;
} else {
argsString = args.slice(1).join(' ');
$.inidb.set('notices', 'message_' + numberOfNotices, argsString);
numberOfNotices++;
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-add-success'));
return;
}
}
/**
* USED BY THE PANEL
*/
if (action.equalsIgnoreCase('addsilent')) {
if (args.length < 2) {
//$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-add-usage'));
return;
} else {
argsString = args.slice(1).join(' ');
$.inidb.set('notices', 'message_' + numberOfNotices, argsString);
numberOfNotices++;
//$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-add-success'));
return;
}
}
/**
* @commandpath notice interval [minutes] - Sets the notice interval in minutes
*/
if (action.equalsIgnoreCase('interval')) {
if (args.length < 2) {
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-interval-usage'));
return;
} else if (isNaN(args[1]) || parseInt(args[1]) < 5) {
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-interval-404'));
return;
} else {
$.inidb.set('noticeSettings', 'interval', parseInt(args[1]));
noticeInterval = parseInt(args[1]);
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-inteval-success'));
reloadNoticeSettings();
return;
}
}
/**
* @commandpath notice req [message count] - Set the number of messages needed to trigger a notice
*/
if (action.equalsIgnoreCase('req')) {
if (args.length < 2) {
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-req-usage'));
return;
}
$.inidb.set('noticeSettings', 'reqmessages', args[1]);
noticeReqMessages = parseInt(args[1]);
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-req-success'));
return;
}
/**
* @commandpath notice config - Shows current notice configuration
*/
if (action.equalsIgnoreCase('config')) {
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-config', noticeToggle, noticeInterval, noticeReqMessages, numberOfNotices, noticeOffline));
return;
}
/**
* @commandpath notice toggle - Toggles notices on and off
*/
if (action.equalsIgnoreCase('toggle')) {
if (noticeToggle) {
noticeToggle = false;
$.inidb.set('noticeSettings', 'noticetoggle', 'false');
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-disabled'));
} else {
noticeToggle = true;
$.inidb.set('noticeSettings', 'noticetoggle', 'true');
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-enabled'));
}
}
/**
* @commandpath notice toggleoffline - Toggles on and off if notices can be said in chat if the channel is offline
*/
if (action.equalsIgnoreCase('toggleoffline')) {
if (noticeOffline) {
noticeOffline = false;
$.inidb.set('noticeSettings', 'noticeOfflineToggle', 'false');
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-disabled.offline'));
} else {
noticeOffline = true;
$.inidb.set('noticeSettings', 'noticeOfflineToggle', 'true');
$.say($.whisperPrefix(sender) + $.lang.get('noticehandler.notice-enabled.offline'));
}
}
}
});
// Set the interval to announce
interval = setInterval(function() {
if (noticeToggle && $.bot.isModuleEnabled('./systems/noticeSystem.js') && numberOfNotices > 0) {
if ((noticeReqMessages < 0 || messageCount >= noticeReqMessages) && (lastNoticeSent + (noticeInterval * 6e4)) <= $.systemTime()) {
if ((noticeOffline && !$.isOnline($.channelName)) || $.isOnline($.channelName)) {
sendNotice();
messageCount = 0;
lastNoticeSent = $.systemTime();
}
}
}
}, 1e4, 'scripts::handlers::noticeSystem.js');
/**
* @event initReady
*/
$.bind('initReady', function() {
$.registerChatCommand('./systems/noticeSystem.js', 'notice', 1);
});
$.reloadNoticeSettings = reloadNoticeSettings;
})();
You can’t perform that action at this time.