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 pathtimeSystem.js
More file actions
575 lines (508 loc) · 23.7 KB
/
Copy pathtimeSystem.js
File metadata and controls
575 lines (508 loc) · 23.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
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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
/*
* Copyright (C) 2016-2023 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 */
/**
* timeSystem.js
*
* Keep track of users in the channel and log their time in the channel
* Exports various time formatting functions
* Use the $ API
*/
(function () {
var levelWithTime = $.getSetIniDbBoolean('timeSettings', 'timeLevel', false),
timeLevelWarning = $.getSetIniDbBoolean('timeSettings', 'timeLevelWarning', true),
keepTimeWhenOffline = $.getSetIniDbBoolean('timeSettings', 'keepTimeWhenOffline', true),
hoursForLevelUp = $.getSetIniDbNumber('timeSettings', 'timePromoteHours', 50),
interval,
inter;
/**
* @function updateTimeSettings
*/
function updateTimeSettings() {
levelWithTime = $.getIniDbBoolean('timeSettings', 'timeLevel');
keepTimeWhenOffline = $.getIniDbBoolean('timeSettings', 'keepTimeWhenOffline');
hoursForLevelUp = $.getIniDbNumber('timeSettings', 'timePromoteHours');
timeLevelWarning = $.getIniDbBoolean('timeSettings', 'timeLevelWarning');
}
function getZoneId(zone) {
try {
return Packages.java.time.ZoneId.of(zone);
} catch (ex) {
$.log.error(ex.message);
throw ex.message + ' -> Reference: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/ZoneId.html';
}
}
/**
* @function getCurLocalTimeString
* @export $
* @param {String} timeformat
* @returns {String}
*
* timeformat = Packages.java.time.format.DateTimeFormatter allowed formats:
* Letter Date or Time Component Presentation Examples
* G Era designator Text AD
* y Year Year 1996; 96
* M Month in year Month July; Jul; 07
* w Week in year Number 27
* W Week in month Number 2
* D Day in year Number 189
* d Day in month Number 9
* F Day of week in month Number 2
* E Day in week Text Tuesday; Tue
* a AM/PM marker Text PM
* H Hour in day (0-23) Number 0
* k Hour in day (1-24) Number 24
* K Hour in am/pm (0-11) Number 0
* h Hour in am/pm (1-12) Number 12
* m Minute in hour Number 30
* s Second in minute Number 55
* S Millisecond Number 978
* z Time zone General time zone Pacific Standard Time; PST; GMT-08:00
* Z Time zone RFC 822 time zone -0800
*
* Note that fixed strings must be encapsulated with quotes. For example, the below inserts a comma
* and paranthesis into the returned time string:
*
* getCurLocalTimeString("MMMM dd', 'yyyy hh:mm:ss zzz '('Z')'");
*/
function getCurLocalTimeString(format) {
var zone = $.inidb.exists('settings', 'timezone') ? $.inidb.get('settings', 'timezone') : "GMT";
try {
return Packages.java.time.ZonedDateTime.now(getZoneId(zone)).format(Packages.java.time.format.DateTimeFormatter.ofPattern(format));
} catch (ex) {
return ex.message;
}
}
/**
* @function getLocalTimeString
* @export $
* @param {String} timeformat
* @param {Number} utc_seconds
* @return {String}
*/
function getLocalTimeString(format, utc_secs) {
var zone = $.inidb.exists('settings', 'timezone') ? $.inidb.get('settings', 'timezone') : "GMT";
try {
return Packages.java.time.ZonedDateTime.ofInstant(Packages.java.time.Instant.ofEpochMilli(utc_secs), getZoneId(zone)).format(Packages.java.time.format.DateTimeFormatter.ofPattern(format));
} catch (ex) {
return ex.message;
}
}
/**
* @function getCurrentLocalTimeString
* @export $
* @param {String} timeformat
* @param {String} timeZone
* @return {String}
*/
function getCurrentLocalTimeString(format, timeZone) {
try {
return Packages.java.time.ZonedDateTime.now(getZoneId(timeZone)).format(Packages.java.time.format.DateTimeFormatter.ofPattern(format));
} catch (ex) {
return ex.message;
}
}
/**
* @function getLocalTime
* @export $
* @param {String} timeformat
* @param {String} timeZone
* @return {String}
*/
function getLocalTime() {
var zone = $.inidb.exists('settings', 'timezone') ? $.inidb.get('settings', 'timezone') : "GMT";
try {
return Packages.java.time.ZonedDateTime.now(getZoneId(zone)).format(Packages.java.time.format.DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ssZ"));
} catch (ex) {
return ex.message;
}
}
/**
* @function dateToString
* @export $
* @param {Date} date
* @param {boolean} [timeOnly]
* @returns {string}
*/
function dateToString(date, timeOnly) {
var year = date.getFullYear(),
month = date.getMonth() + 1,
day = date.getDate(),
hours = date.getHours(),
minutes = date.getMinutes();
if (timeOnly) {
return hours + ':' + minutes;
} else {
return day + '-' + month + '-' + year + ' @ ' + hours + ':' + minutes;
}
}
/**
* @function getTimeString
* @export $
* @param {Number} time
* @param {boolean} [hoursOnly]
* @returns {string}
*/
function getTimeString(time, hoursOnly) {
var floor = Math.floor,
months = (time / 2628000);
days = ((months % 1) * 30.42),
hours = ((days % 1) * 24),
minutes = ((hours % 1) * 60),
seconds = ((minutes % 1) * 60);
if (hoursOnly) {
return floor(time / 3600) + $.lang.get('common.hours3');
} else {
var timeStringParts = [],
timeString = '';
// Append months if greater than one.
if (months >= 1) {
timeStringParts.push(floor(months) + ' ' + (months < 2 ? $.lang.get('common.time.month') : $.lang.get('common.time.months')));
}
// Append days if greater than one.
if (days >= 1) {
timeStringParts.push(floor(days) + ' ' + (days < 2 ? $.lang.get('common.time.day') : $.lang.get('common.time.days')));
}
// Append hours if greater than one.
if (hours >= 1) {
timeStringParts.push(floor(hours) + ' ' + (hours < 2 ? $.lang.get('common.time.hour') : $.lang.get('common.time.hours')));
}
// Append minutes if greater than one.
if (minutes >= 1) {
timeStringParts.push(floor(minutes) + ' ' + (minutes < 2 ? $.lang.get('common.time.minute') : $.lang.get('common.time.minutes')));
}
// Append seconds if greater than one.
if (seconds >= 1) {
timeStringParts.push(floor(seconds) + ' ' + (seconds < 2 ? $.lang.get('common.time.second') : $.lang.get('common.time.seconds')));
}
// If the array is empty, return 0 seconds.
if (timeStringParts.length === 0) {
return ('0 ' + $.lang.get('common.time.seconds'));
}
// Join the array to make a string.
timeString = timeStringParts.join(', ');
// Replace last comma with ", and".
if (timeString.indexOf(',') !== -1) {
timeString = (timeString.slice(0, timeString.lastIndexOf(',')) + $.lang.get('common.time.and') + timeString.slice(timeString.lastIndexOf(',') + 2));
}
return timeString;
}
}
/**
* @function getCountString
* @export $
* @param {Number} time
* @param {boolean} [countUp]
* @returns {string}
*/
function getCountString(time, countUp) {
var floor = Math.floor,
months = (time / 2628000);
days = ((months % 1) * 30.42),
hours = ((days % 1) * 24),
minutes = ((hours % 1) * 60),
seconds = ((minutes % 1) * 60);
var timeStringParts = [],
timeString = '';
// Append months if greater than one.
if (months >= 1) {
timeStringParts.push(floor(months) + ' ' + (months < 2 ? $.lang.get('common.time.month') : $.lang.get('common.time.months')));
}
// Append days if greater than one.
if (days >= 1) {
timeStringParts.push(floor(days) + ' ' + (days < 2 ? $.lang.get('common.time.day') : $.lang.get('common.time.days')));
}
// Append hours if greater than one.
if (hours >= 1) {
timeStringParts.push(floor(hours) + ' ' + (hours < 2 ? $.lang.get('common.time.hour') : $.lang.get('common.time.hours')));
}
// Append minutes if greater than one.
if (minutes >= 1) {
timeStringParts.push(floor(minutes) + ' ' + (minutes < 2 ? $.lang.get('common.time.minute') : $.lang.get('common.time.minutes')));
}
// Append seconds if greater than one.
if (seconds >= 1) {
timeStringParts.push(floor(seconds) + ' ' + (seconds < 2 ? $.lang.get('common.time.second') : $.lang.get('common.time.seconds')));
}
// If the array is empty, return 0 seconds.
if (timeStringParts.length === 0) {
if (countUp) {
return ($.lang.get('common.time.nostart'));
} else {
return ($.lang.get('common.time.expired'));
}
}
// Join the array to make a string.
timeString = timeStringParts.join(', ');
// Replace last comma with ", and".
if (timeString.indexOf(',') !== -1) {
timeString = (timeString.slice(0, timeString.lastIndexOf(',')) + $.lang.get('common.time.and') + timeString.slice(timeString.lastIndexOf(',') + 2));
}
return timeString;
}
/**
* @function getTimeStringMinutes
* @export $
* @param {Number} time
* @param {boolean} [hoursOnly]
* @returns {string}
*/
function getTimeStringMinutes(time) {
var floor = Math.floor,
cHours = time / 3600,
cMins = cHours % 1 * 60;
if (cHours === 0 || cHours < 1) {
return (floor(~~cMins) + $.lang.get('common.minutes2'));
} else {
return (floor(cHours) + $.lang.get('common.hours2') + floor(~~cMins) + $.lang.get('common.minutes2'));
}
}
/**
* @function getUserTime
* @export $
* @param {string} username
* @returns {number}
*/
function getUserTime(username) {
return ($.inidb.exists('time', username.toLowerCase()) ? $.inidb.get('time', username.toLowerCase()) : 0);
}
/**
* @function getUserTimeString
* @export $
* @param {string} username
* @returns {string}
*/
function getUserTimeString(username) {
var floor = Math.floor,
time = $.getUserTime(username.toLowerCase()),
cHours = time / 3600,
cMins = cHours % 1 * 60;
if (floor(cHours) > 0) {
return ($.lang.get('user.time.string.hours', floor(cHours), floor(~~cMins)));
} else {
return ($.lang.get('user.time.string.minutes', floor(~~cMins)));
}
}
/**
* @event command
*/
$.bind('command', function (event) {
var sender = event.getSender().toLowerCase(),
username = $.username.resolve(sender),
command = event.getCommand(),
args = event.getArgs(),
action = args[0],
subject,
timeArg;
/**
* @commandpath time - Announce amount of time spent in channel
*/
if (command.equalsIgnoreCase('time')) {
if (!action) {
$.say($.whisperPrefix(sender) + $.lang.get("timesystem.get.self", $.resolveRank(sender), getUserTimeString(sender)));
} else if (action && $.inidb.exists('time', action.toLowerCase())) {
$.say($.whisperPrefix(sender) + $.lang.get("timesystem.get.other", $.username.resolve(action), getUserTimeString(action)));
} else {
subject = args[1];
timeArg = parseInt(args[2]);
/**
* @commandpath time add [user] [seconds] - Add seconds to a user's logged time (for correction purposes)
*/
if (action.equalsIgnoreCase('add')) {
if (!subject || isNaN(timeArg)) {
$.say($.whisperPrefix(sender) + $.lang.get('timesystem.add.usage'));
return;
}
subject = $.user.sanitize(subject);
if (timeArg < 0) {
$.say($.whisperPrefix(sender) + $.lang.get('timesystem.add.error.negative'));
return;
}
if ($.user.isKnown(subject)) {
$.inidb.incr('time', subject, timeArg);
$.say($.whisperPrefix(sender) + $.lang.get('timesystem.add.success', getTimeString(timeArg), $.username.resolve(subject), getUserTimeString(subject)));
} else {
$.say($.whisperPrefix(sender) + $.lang.get('common.user.404', $.username.resolve(subject)));
}
}
/**
* @commandpath time take [user] [seconds] - Take seconds from a user's logged time
*/
if (action.equalsIgnoreCase('take')) {
if (!subject || isNaN(timeArg)) {
$.say($.whisperPrefix(sender) + $.lang.get('timesystem.take.usage'));
return;
}
subject = $.user.sanitize(subject);
if (!$.user.isKnown(subject)) {
$.say($.whisperPrefix(sender) + $.lang.get('common.user.404', subject));
}
if (timeArg > $.getUserTime(subject)) {
$.say($.whisperPrefix(sender) + $.lang.get('timesystem.take.error.toomuch', subject));
return;
}
$.inidb.decr('time', subject, timeArg);
$.say($.whisperPrefix(sender) + $.lang.get('timesystem.take.success', $.getTimeString(timeArg), $.username.resolve(subject), getUserTimeString(subject)));
}
if (action.equalsIgnoreCase('set')) {
if (!subject || isNaN(timeArg)) {
$.say($.whisperPrefix(sender) + $.lang.get('timesystem.settime.usage'));
return;
}
if (timeArg < 0) {
$.say($.whisperPrefix(sender) + $.lang.get('timesystem.settime.error.negative'));
return;
}
subject = $.user.sanitize(subject);
if ($.user.isKnown(subject)) {
$.inidb.set('time', subject, timeArg);
$.say($.whisperPrefix(sender) + $.lang.get('timesystem.settime.success', $.username.resolve(subject), $.getUserTimeString(subject)));
} else {
$.say($.whisperPrefix(sender) + $.lang.get('common.user.404', subject));
}
}
/**
* @commandpath time promotehours [hours] - Set the amount of hours a user has to be logged to automatically become a regular
*/
if (action.equalsIgnoreCase('promotehours')) {
if (isNaN(subject)) {
$.say($.whisperPrefix(sender) + $.lang.get('timesystem.set.promotehours.usage'));
return;
}
if (subject < 0) {
$.say($.whisperPrefix(sender) + $.lang.get('timesystem.set.promotehours.error.negative', $.getGroupNameById($.PERMISSION.Regular)));
return;
}
hoursForLevelUp = parseInt(subject);
$.inidb.set('timeSettings', 'timePromoteHours', hoursForLevelUp);
$.say($.whisperPrefix(sender) + $.lang.get('timesystem.set.promotehours.success', $.getGroupNameById($.PERMISSION.Regular), hoursForLevelUp));
}
/**
* @commandpath time autolevel - Auto levels a user to regular after hitting 50 hours.
*/
if (action.equalsIgnoreCase('autolevel')) {
levelWithTime = !levelWithTime;
$.setIniDbBoolean('timeSettings', 'timeLevel', levelWithTime);
$.say($.whisperPrefix(sender) + (levelWithTime ? $.lang.get('timesystem.autolevel.enabled', $.getGroupNameById($.PERMISSION.Regular), hoursForLevelUp) : $.lang.get('timesystem.autolevel.disabled', $.getGroupNameById($.PERMISSION.Regular), hoursForLevelUp)));
}
/**
* @commandpath time autolevelnotification - Toggles if a chat announcement is made when a user is promoted to a regular.
*/
if (action.equalsIgnoreCase('autolevelnotification')) {
timeLevelWarning = !timeLevelWarning;
$.setIniDbBoolean('timeSettings', 'timeLevelWarning', timeLevelWarning);
$.say($.whisperPrefix(sender) + (timeLevelWarning ? $.lang.get('timesystem.autolevel.chat.enabled') : $.lang.get('timesystem.autolevel.chat.disabled')));
}
/**
* @commandpath time offlinetime - Toggle logging a user's time when the channel is offline
*/
if (action.equalsIgnoreCase('offlinetime')) {
keepTimeWhenOffline = !keepTimeWhenOffline;
$.setIniDbBoolean('timeSettings', 'keepTimeWhenOffline', keepTimeWhenOffline);
$.say($.whisperPrefix(sender) + (keepTimeWhenOffline ? $.lang.get('timesystem.offlinetime.enabled') : $.lang.get('timesystem.offlinetime.disabled')));
}
}
}
/**
* @commandpath streamertime - Announce the caster's local time
*/
if (command.equalsIgnoreCase('streamertime')) {
$.say($.whisperPrefix(sender) + $.lang.get('timesystem.streamertime', getCurLocalTimeString("MMMM dd', 'yyyy hh:mm:ss a zzz '('Z')'"), $.username.resolve($.ownerName)));
}
/**
* @commandpath timezone [timezone name] - Show configured timezone or optionally set the timezone. See List: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
*/
if (command.equalsIgnoreCase('timezone')) {
var tzData;
if (!action) {
$.say($.whisperPrefix(sender) + $.lang.get('timesystem.set.timezone.usage', ($.inidb.exists('settings', 'timezone') ? $.inidb.get('settings', 'timezone') : "GMT")));
return;
}
tzData = Packages.java.util.TimeZone.getTimeZone(action);
if (tzData.getID().equals("GMT") && !action.equals("GMT")) {
$.say($.whisperPrefix(sender) + $.lang.get('timesystem.set.timezone.invalid', action));
return;
} else {
$.say($.whisperPrefix(sender) + $.lang.get('timesystem.set.timezone.success', tzData.getID(), tzData.observesDaylightTime()));
$.inidb.set('settings', 'timezone', tzData.getID());
}
}
});
// Set an interval for increasing all current users logged time
interval = setInterval(function () {
var username,
i;
if ($.isOnline($.channelName) || keepTimeWhenOffline) {
$.inidb.IncreaseBatchString('time', '', $.users, '60');
}
}, 6e4, 'scripts::systems::timeSystem.js#1');
// Interval for auto level to regular
inter = setInterval(function () {
var username,
i;
if (levelWithTime) {
for (i in $.users) {
if ($.users[i] !== null) {
username = $.users[i].toLowerCase();
// Only level viewers to regulars and ignore TwitchBots
if (!$.isTwitchBot(username)
&& (!$.hasPermissionLevel(username) || $.isViewer(username)) //Assume users without permissions level are viewers, if they are too new the check will fail in the next condition
&& $.inidb.exists('time', username)
&& Math.floor(parseInt($.inidb.get('time', username)) / 3600) >= hoursForLevelUp) {
if (!$.isMod(username)) { // Added a second check here to be 100% sure the user is not a mod.
$.setUserGroupById(username, $.PERMISSION.Regular);
if (timeLevelWarning) {
$.say($.lang.get(
'timesystem.autolevel.promoted',
$.username.resolve(username),
$.getGroupNameById($.PERMISSION.Regular).toLowerCase(),
hoursForLevelUp
)); //No whisper mode needed here.
}
}
}
}
}
}
}, 9e5, 'scripts::systems::timeSystem.js#2');
/**
* @event initReady
*/
$.bind('initReady', function () {
$.registerChatCommand('./core/timeSystem.js', 'streamertime');
$.registerChatCommand('./core/timeSystem.js', 'timezone', $.PERMISSION.Admin);
$.registerChatCommand('./core/timeSystem.js', 'time');
$.registerChatSubcommand('time', 'add', $.PERMISSION.Admin);
$.registerChatSubcommand('time', 'take', $.PERMISSION.Admin);
$.registerChatSubcommand('time', 'set', $.PERMISSION.Admin);
$.registerChatSubcommand('time', 'autolevel', $.PERMISSION.Admin);
$.registerChatSubcommand('time', 'promotehours', $.PERMISSION.Admin);
$.registerChatSubcommand('time', 'autolevelnotification', $.PERMISSION.Admin);
});
/** Export functions to API */
$.dateToString = dateToString;
$.getTimeString = getTimeString;
$.getCountString = getCountString;
$.getUserTime = getUserTime;
$.getUserTimeString = getUserTimeString;
$.getCurLocalTimeString = getCurLocalTimeString;
$.getLocalTimeString = getLocalTimeString;
$.getTimeStringMinutes = getTimeStringMinutes;
$.updateTimeSettings = updateTimeSettings;
$.getCurrentLocalTimeString = getCurrentLocalTimeString;
$.getLocalTime = getLocalTime;
})();
You can’t perform that action at this time.