-
-
Notifications
You must be signed in to change notification settings - Fork 11
/
TalkerNode.js
921 lines (863 loc) · 30.8 KB
/
TalkerNode.js
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
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
// https://github.com/marado/TalkerNode
"use strict";
var net = require('net');
var crypto = require('crypto');
var valid = require('password-strength');
var chalk = require('chalk');
const stripAnsi = require('strip-ansi');
var sockets = [];
var port = process.env.PORT || 8888;
var version = require('./package.json').version;
// Instantiates the users database
const low = require('lowdb');
const FileSync = require('lowdb/adapters/FileSync')
var loadeddb = 0; // number of databases loaded so far // TODO: this probably is no longer needed with lowdb
const usersadapter = new FileSync('user.db');
const usersdb = low(usersadapter);
loadeddb++;
// Instantiates the talker settings database
var commands = {};
var commandAliases = {};
const talkeradapter = new FileSync('talker.db');
const talkerdb = low(talkeradapter);
var ranks = talkerdb.get('ranks').value();
if (typeof ranks === 'undefined') {
ranks = {list:[
"Jailed",
"Newcomer",
"Newbie",
"Juvie",
"Learner",
"Adult",
"Wiseman",
"Hero",
"Mage",
"Imortal",
"God"
], entrylevel: 10};
talkerdb.set("ranks", ranks).write();
}
var watchdog = talkerdb.get('watchdog').value();
if (typeof watchdog === 'undefined') {
// value in seconds; if set to 0 watchdog feature will be disabled
watchdog = 24*60*60;
talkerdb.set("watchdog", watchdog).write();
}
loadeddb++;
// Instantiates the universe
var nodiverse = require('nodiverse');
const {monotone, colorize} = require("./utils/formatters");
var universe;
var talkername = "Moosville"; // TODO: make this configurable
const universeadapter = new FileSync('universe.db');
const universedb = low(universeadapter);
universe = universedb.get("universe").value();
if (typeof universe === 'undefined') {
universe = nodiverse(); // new universe
universe.create([0,0,0],0);
var limbo = universe.get([0,0,0]);
limbo.name = "Limbo"; // at the beginning there was just the limbo
universe.update(limbo);
universe.entrypoint=[0,0,0]; // where everyone was meant to be
universedb.set("universe", universe).write();
} else {
// assign the correct prototype to universe
// this is somewhat ugly, since we're falling back from
// Object.?etPrototypeOf to __proto__ in order not to depend on
// nodejs 0.12
// TODO: now that we already depend on a nodejs >= 0.12, this ugly hack
// can be cleaned up
var setProtoOf = function(obj, proto) { obj.__proto__ = proto; };
var mixinProperties = function(obj, proto) {
for (var prop in proto) { obj[prop] = proto[prop]; }
};
var setPrototypeOf = Object.setPrototypeOf ||
{__proto__:[]} instanceof Array ? setProtoOf : mixinProperties;
var getPrototypeOf = Object.getPrototypeOf ||
function(obj) { return obj.__proto__; };
setPrototypeOf(universe, getPrototypeOf(nodiverse()));
}
if (typeof universe.name !== 'undefined') talkername = universe.name;
loadeddb++;
/*
* Returns a standard formatted date time string
*/
function getDateTimeString(datetimestring=0) {
var datetime = (datetimestring > 0) ? new Date(datetimestring) : Date();
return datetime.toString().split(' ').slice(0,6).join(' ');
}
/*
* Cleans the input of carriage return, newline and control characters
*/
function cleanInput(data) {
var newString = data.toString().replace("[\u0000-\u001a]", "").replace("[\u001c-\u001f]", "").replace(/(\r\n|\n|\r)/gm,"").replace(/\u001b\[./gm,"");
while (newString.charAt(0) === " ") newString=newString.substring(1);
return newString;
}
/*
* Turns client's echo on or off. echo off is usually wanted on passwords
*/
function echo(bool) {
var bytes = Array(3);
bytes[0] = 0xFF;
bytes[1] = bool ? 0xFC : 0xFB; // 0xFF 0xFC 0x01 for off, 0xFF 0xFB 0x01 for on
bytes[2] = 0x01;
return new Buffer.from(bytes);
}
/*
* Saves total time for user or all users to the db
*/
function saveTotalTime(username) {
if(typeof username === 'undefined') { // save time for all users
for (let index = 0; index < sockets.length; index++) {
const socket = sockets[index];
var socketdb = usersdb.get(socket.username).value();
if (typeof socketdb !== 'undefined') {
if (typeof socketdb.totalTime === 'undefined') {
socketdb.totalTime = (Date.now() - socketdb.loginTime);
} else {
socketdb.totalTime += (Date.now() - socketdb.loginTime);
}
usersdb.set(socket.username, socketdb).write();
}
}
} else { // save time for given user
var userdb = usersdb.get(username).value();
if (typeof userdb !== 'undefined') {
if (typeof userdb.totalTime === 'undefined') {
userdb.totalTime = (Date.now() - userdb.loginTime);
} else {
userdb.totalTime += (Date.now() - userdb.loginTime);
}
usersdb.set(username, userdb).write();
}
}
}
/*
* Method used to send data to a socket
*/
function sendData(socket, data) {
var datalines;
if (typeof(data) === 'object') {
var decoder;
if (typeof TextDecoder === 'undefined') {
// 8.3.0 <= nodejs < 11
decoder = require('util').TextDecoder;
} else {
// nodejs >= 11
decoder = TextDecoder;
}
datalines = new decoder("utf-8").decode(data).split(/\r\n|\r|\n/).length;
} else {
datalines = data.split(/\r\n|\r|\n/).length;
}
try {
if (typeof socket.db === 'undefined' ||
typeof socket.db.pager === 'undefined' ||
parseInt(socket.db.pager) === 0 ||
parseInt(socket.db.pager) >= datalines
) {
if (typeof socket.db !== 'undefined' && typeof socket.db.color !== 'undefined' && !(socket.db.color)) {
socket.write(monotone(stripAnsi(data)));
} else {
socket.write(colorize(data));
}
} else {
// TODO: react to socket.db.pager :
// cut the message in two, send the first, save the second
// - and get ready an interactive mechanism, like the one used in .pass, for eg.
//
// While that's not done...
// socket.write("This message should be cut and within a pager.\r\n");
if (typeof socket.db !== 'undefined' && typeof socket.db.color !== 'undefined' && !(socket.db.color)) {
socket.write(monotone(stripAnsi(data)));
} else {
socket.write(colorize(data));
}
}
} catch (e) {
// This is being left intentionally empty: socket.write failures
// can, and are expected to happen, but we can ignore that and
// proceed in those cases.
}
}
/*
* Method executed when data is received from a socket
*/
function receiveData(socket, data) {
if(socket.receiveBuffer === undefined) {
socket.receiveBuffer = '';
}
// Detect IAC commands
if(data[0] == 0xFF) {
// TODO: We're just filtering out IAC commands. We should be dealing with them instead...
// See: https://github.com/marado/TalkerNode/issues/34
// console.log("Moo: IAC:", data);
return;
}
// Buffer received data and wait for newline before processing
// Fixes #121 (Windows uses character mode rather than line mode)
socket.receiveBuffer += data;
if (socket.receiveBuffer.indexOf('\r\n') === -1)
return;
// Clean input
var cleanData = cleanInput(socket.receiveBuffer);
if(cleanData.length == 0)
return;
// Useful when in debug mode, you don't want this otherwise... it wouldn't be nice for your users' privacy, would it?
// console.log('Moo: Buf:', socket.receiveBuffer);
// console.log("Moo [" + cleanData + "]");
// Empty the receive buffer, ready for the next input...
socket.receiveBuffer = '';
sendData(socket, echo(true));
if(socket.username == undefined) {
if (cleanData.toLowerCase() === "quit") return socket.end('Goodbye!\r\n');
if (cleanData.toLowerCase() === "who") { socket.db={rank:0}; doCommand(socket, ".who"); return sendData(socket, chalk.cyan("Give me a name: ")); }
if (cleanData.toLowerCase() === "version") { socket.db={rank:0}; doCommand(socket, ".version"); return sendData(socket, chalk.cyan("Give me a name: ")); }
var reservedNames=["who","quit","version"];
if (reservedNames.indexOf(cleanData.toLowerCase()) > -1) {
sendData(socket, "\r\nThat username is reserved, you cannot have it.\r\n" + chalk.cyan("Give me a name: "));
}
else if ((cleanData.match(/^[a-zA-Z]+$/) !== null) && (1 < cleanData.length) && (cleanData.length < 17)) {
socket.username = cleanData.toLowerCase().charAt(0).toUpperCase() + cleanData.toLowerCase().slice(1); // Capitalized name
socket.loggedin = false;
socket.db = usersdb.get(socket.username).value();
if (typeof socket.db === 'undefined') {
sendData(socket, chalk.cyan("\r\nNew user, welcome! Please choose a password: "));
sendData(socket, echo(false));
socket.registering=true;
} else {
sendData(socket, chalk.cyan("\r\nGive me your password: "));
sendData(socket, echo(false));
socket.registering=false;
}
return;
} else {
sendData(socket, chalk.red(
"\r\nInvalid username: it can only contain letters, have at least two characters and be no longer than 16 characters.\r\n") +
chalk.cyan("Give me a name: "
));
}
return;
} else if (socket.loggedin == false) {
// this is the password
if (socket.registering) {
if (typeof socket.password === 'undefined') {
if ((cleanData.toLowerCase() === socket.username.toLowerCase()) || !valid(cleanData).valid) {
sendData(socket, chalk.red("\r\nThat password is not valid"));
if (valid(cleanData).hint !== null) sendData(socket, " (" + valid(cleanData).hint + ")");
sendData(socket, chalk.red(". ") + "Let's try again...\r\n" + chalk.cyan("Give me a name: "));
delete socket.registering;
delete socket.username;
delete socket.loggedin;
delete socket.db;
return;
}
socket.password = crypto.createHash('sha512').update(cleanData).digest('hex');
sendData(socket, echo(false));
sendData(socket, chalk.cyan("\r\nConfirm the chosen password: "));
return;
} else {
if (socket.password === crypto.createHash('sha512').update(cleanData).digest('hex')) {
// password confirmed
socket.db={
"password":crypto.createHash('sha512').update(cleanData).digest('hex'),
"rank":ranks.entrylevel,
"where":universe.entrypoint,
"registerTime":Date.now(),
};
if (ranks.list.length - 1 == ranks.entrylevel) {
if (ranks.list.length == 1) {
ranks.entrylevel = 0;
} else {
ranks.entrylevel = 1;
}
talkerdb.set("ranks", ranks).write();
}
usersdb.set(socket.username, socket.db).write();
delete socket.password;
delete socket.registering;
} else {
// wrong confirmation password
delete socket.password;
delete socket.registering;
delete socket.username;
delete socket.db;
sendData(socket, chalk.red("\r\nPasswords don't match!") + "\r\nLet's start from the beginning...\r\n" + chalk.cyan("Tell me your name: "));
return;
}
}
} else if (socket.db.password !== crypto.createHash('sha512').update(cleanData).digest('hex')) {
require("fs").appendFileSync('auth.log', new Date().toISOString() + " " + socket.remoteAddress + " with port " + socket.remotePort + " failed to log in, username attempted was: " + socket.username + "\r\n");
delete socket.username;
delete socket.db;
sendData(socket, chalk.red("\r\nWrong password! ") + "\r\nLet's start from the beginning...\r\n" + chalk.cyan("Tell me your name: "));
return;
}
// entering the talker...
require("fs").appendFileSync('auth.log', new Date().toISOString() + " " + socket.remoteAddress + " with port " + socket.remotePort + " successfully logged in, username is: " + socket.username + "\r\n");
if (universe.get(socket.db.where) === null) { // there's no where, or that place doesn't exist anymore
socket.db.where = universe.entrypoint;
// save changes into the database
var tmp = usersdb.get(socket.username).value();
tmp.where = socket.db.where;
usersdb.set(socket.username, tmp).write();
}
if (command_utility().allButMe(socket,function(me,to){if(to.username.toLowerCase()===me.username.toLowerCase()){return true;}})) {
var old = command_utility().allButMe(socket,function(me,to){if(to.username.toLowerCase()===me.username.toLowerCase()){to.end('Session is being taken over...\n');}});
sendData(socket, 'Taking over session...\n');
} else {
socket.lastLogin = socket.db.loginTime;
socket.db.loginTime = Date.now();
if (typeof(socket.db.loginCount) === "undefined") {
socket.db.loginCount = 1;
} else {
socket.db.loginCount++;
}
socket.activityTime = Date.now();
command_utility().allButMe(socket,function(me,to){to.write("[Entering is: "+ me.username + " (" + universe.get(me.db.where).name + " " + me.db.where + ") ]\r\n");});
}
sendData(socket, "\r\n+----------------------------------------------------------------------------+\r\n");
sendData(socket, " Welcome to " + chalk.bold(talkername) + ", " + chalk.green(socket.username) + "!\r\n");
if (typeof(socket.lastLogin) !== "undefined") {
sendData(
socket,
" Your last login was at "
+ chalk.magenta(getDateTimeString(
socket.lastLogin
)) + ".\r\n"
);
}
sendData(socket, " Your rank is " + chalk.bold(ranks.list[socket.db.rank]) + ".\r\n");
sendData(socket, "+----------------------------------------------------------------------------+\r\n");
socket.loggedin = true;
doCommand(socket, ".look");
return;
} else if (typeof socket.interactive !== 'undefined') {
switch (socket.interactive.type) {
case "password":
if (socket.interactive.state === "old") {
// let's confirm the password
if (socket.db.password !== crypto.createHash('sha512').update(cleanData).digest('hex')) {
sendData(socket, "\r\n:: " + chalk.red("Wrong password!\r\n"));
delete socket.interactive;
} else {
// password is correct
sendData(socket, "\r\n:: " + chalk.green("Tell me the new password: "));
sendData(socket, echo(false));
socket.interactive.state = "new";
}
} else {
// let's set cleanData as the new password
if ((cleanData.toLowerCase() === socket.username.toLowerCase()) || !valid(cleanData).valid) {
sendData(socket, chalk.red("\r\nThat password is not valid"));
if (valid(cleanData).hint !== null) sendData(socket, " (" + valid(cleanData).hint + ")");
sendData(socket, chalk.red(". Password not changed.\r\n"));
delete socket.interactive;
return;
}
socket.db.password = crypto.createHash('sha512').update(cleanData).digest('hex');
usersdb.set(socket.username, socket.db).write();
sendData(socket, "\r\n:: " + chalk.cyan("Password changed, now don't you forget your new password!\r\n"));
delete socket.interactive;
}
break;
case "suicide":
if (socket.interactive.state === "confirmation") {
if (cleanData === "yes, I am sure") {
// they really want to .suicide, let's validate they are who they're supposed to be...
sendData(socket, chalk.bold("\r\n:: Alright then... just confirm you're who you're supposed to be, tell us your password: "));
sendData(socket, echo(false));
socket.interactive.state = "pass";
} else {
sendData(socket, chalk.bold("\r\n:: Ooof, we're glad you don't want to leave us!\r\n"));
delete socket.interactive;
}
} else {
// let's confirm the password
if (socket.db.password !== crypto.createHash('sha512').update(cleanData).digest('hex')) {
sendData(socket, "\r\n:: " + chalk.red("Wrong password!\r\n"));
delete socket.interactive;
} else {
// password is correct
sendData(socket, chalk.gray("\r\n:: Deleting all your data... We're sad to see you go!\r\n"));
command_utility().allButMe(socket,function(me,to){to.write("[Leaving is: "+ me.username + " ]\r\n");});
delete socket.interactive;
var quitter = socket.username;
socket.end(":'(\r\n");
// actually delete the user
var users = usersdb.getState();
delete users[quitter];
usersdb.setState(users).write();
}
}
break;
default:
sendData(socket, "\r\n:: Something really weird just happened... let's try to recover from it...\r\n");
delete socket.interactive;
break;
}
return;
}
// if we have a command...
if (cleanData === ".") {
if ((typeof socket.lastcommand) !== 'undefined')
doCommand(socket, socket.lastcommand);
} else if (cleanData.charAt(0) === ".") {
doCommand(socket, cleanData);
} else if (cleanData.charAt(0) in commandAliases) {
let alias = cleanData.charAt(0);
let re = new RegExp(`^\\${alias}( +)?`);
cleanData = cleanData.replace(re, '');
doCommand(socket, `.${commandAliases[alias]} ${cleanData}`);
} else {
doCommand(socket, ".say " + cleanData);
}
}
/*
* Load all commands from the command subdirectory
*/
function loadCommands() {
// Loop through all files, trying to load them
var normalizedPath = require("path").join(__dirname, "commands");
var output = "";
require("fs").readdirSync(normalizedPath).forEach(function(file) {
if (file.substr(file.length-3, 3) === ".js") {
try {
delete require.cache[require.resolve('./commands/' + file)]
var cmd_load = require('./commands/' + file);
var cmd = cmd_load.command;
// Only load the command if it's set to Autoload
if(cmd.autoload) {
output += "Loading Command: Command '"
+ cmd.name + "' loaded (from '"
+ file + "')\r\n";
cmd.loaded_date = new Date();
commands[cmd.name] = cmd;
if ('alias' in cmd) {
if (cmd.alias instanceof Array) {
cmd.alias.map(alias => {
commandAliases[alias] = cmd.name;
});
} else {
commandAliases[cmd.alias] = cmd.name;
}
}
} else {
output += "Loading Command: Skipping "
+ cmd.name + " (from '"
+ file
+ "'). Autoload = false\r\n";
}
} catch (e) {
throw file + ": " + e;
}
} else {
output += "Skipping " + file + ": file extension is not 'js'\r\n";
}
});
return output;
}
/*
* Method that returns the command rank.
* If a custom one exists, use it. Else, use the hardcoded one.
* In any case, validate if there's a rank as higher as the one of the command.
* If not, assign it to the highest rank available.
* If the command doesn't exist at all, return null.
*/
function getCmdRank(command) {
var r;
var cmdRanks = talkerdb.get("commands").value();
if (typeof (cmdRanks) !== 'undefined' && typeof (cmdRanks[command]) !== 'undefined') {
r = cmdRanks[command];
} else if (commands[command]) {
r = commands[command].min_rank;
} else {
return null;
}
if (r >= ranks.list.length) r = ranks.list.length - 1;
return r;
}
/*
* Method that changes the command rank.
*/
function setCmdRank(command, rank) {
var cmdRanks = talkerdb.get("commands").value();
if (typeof(cmdRanks) === 'undefined') cmdRanks = {};
if (commands[command]) {
var old = commands[command].min_rank;
if (typeof (cmdRanks[command]) !== 'undefined') {
old = cmdRanks[command];
}
if (rank != old) {
cmdRanks[command] = rank;
talkerdb.set("commands", cmdRanks).write();
}
}
}
/*
* Method to find a command
* hierarchy: direct match > alias direct match > weighted partial match
* The 'weighted partial match' gives precedence to commands of lower ranks
*/
function findCommand(socket, command) {
var c = command;
var userRank = socket.db.rank;
if(commands[c] && userRank >= getCmdRank(c)) {
// direct match
return [commands[c]];
} else {
// when we have more than one possible command, we
// choose the most heavier from the ones with lower
// getCmdRank
var results = [];
var weight = 0;
var rank = ranks.list.length - 1;
for (var cmd in commands) {
// alias direct match
if (
commands[cmd].aka !== 'undefined' &&
commands[cmd] !== "" && commands[cmd].aka === c &&
userRank >= getCmdRank(cmd)
) {
return [commands[cmd]];
}
// partial match
if(cmd.substr(0, c.length) == c &&
userRank >= getCmdRank(cmd))
{
var cweight = 0;
if (typeof commands[cmd].weight !== 'undefined')
cweight = commands[cmd].weight;
if (getCmdRank(cmd) < rank) {
rank = getCmdRank(cmd);
weight = cweight;
results = [commands[cmd]];
} else if (getCmdRank(cmd) === rank) {
if (cweight > weight) {
weight = commands[cmd].weight;
results = [commands[cmd]];
} else if (cweight === weight) {
results.push(commands[cmd]);
}
}
}
}
return results;
}
}
/*
* Method to execute commands.
*/
function doCommand(socket, command) {
socket.activityTime = Date.now();
try {
var c = command.split(' ')[0].toLowerCase().substring(1);
var userRank = socket.db.rank;
var cArr = findCommand(socket, c);
if (cArr.length === 1) {
socket.lastcommand = command;
return cArr[0].execute(socket, command.split(' ').slice(1).join(" "), command_utility())
}
if (cArr.length > 1) {
var possibilities = "";
for (var p = 0; p < cArr.length - 1; p++) {
possibilities += cArr[p].name + ", ";
}
possibilities += cArr[cArr.length - 1].name;
return sendData(socket, "Found " + cArr.length + " possible commands (" + possibilities + "). Please be more specific.\r\n");
} else {
return sendData(socket, "There's no such thing as a " + c + " command.\r\n");
}
}
catch(err) {
sendData(socket, "Error executing command '" + c + "': " + err + "\r\n");
console.error("Error executing command '" + c + "': " + err + "\r\n");
}
}
/*
* Method executed when a socket ends
*/
function closeSocket(socket) {
var i = sockets.indexOf(socket);
if (i != -1) {
// if the socket already belong to a user...
if (typeof socket.username !== 'undefined') {
// is there any other socket for this same user?
var announce = true;
for (var s = 0; s < sockets.length; s++) {
if (s !== i &&
socket.username.toLowerCase() ===
sockets[s].username.toLowerCase() &&
sockets[s].loggedin
) announce = false;
}
if (announce) {
// announce the user departure
command_utility().allButMe(socket,function(me,to){
try {
to.write(chalk.bold(
"[" + chalk.red("Leaving ") +
"is: " +
chalk.yellow(me.username) +
" ]\r\n"
));
} catch(err) {
// there are expectable and non-fatal
// errors that can happen here, but
// there can also be bugs. Let's print
// the error out so logs can be useful.
console.log(
"E: closeSocket's " +
"announcement failed for " +
"one socket: " + err
);
}
});
}
// write total time on socket db
saveTotalTime(sockets[i].username);
}
sockets.splice(i, 1);
}
}
/*
* Callback method executed when a new TCP socket is opened.
*/
function newSocket(socket) {
require("fs").appendFileSync('auth.log', new Date().toISOString() + " " + socket.remoteAddress + " connected with port " + socket.remotePort + "\r\n");
socket.setKeepAlive(true);
// FIXME: socket errors are expected, there is no point in logging
// them, at least if the error is
// "Error [ERR_STREAM_WRITE_AFTER_END]: write after end"
socket.on('error',e=>console.log("client socket error: " + e));
sockets.push(socket);
try { // load motd file
var motd = require("fs").readFileSync('motd.txt');
sendData(socket, motd);
} catch {
// no motd available; generic welcome
sendData(socket, chalk.green('Welcome to the ')
+ chalk.bold.white(talkername) + chalk.green("!"));
}
sendData(socket,chalk.cyan('\r\n\r\nGive me a name: '));
socket.on('data', function(data) {
receiveData(socket, data);
})
socket.on('end', function() {
closeSocket(socket);
})
}
/*
* COMMAND UTILITY - Should probably be moved to own module
* Object passed to commands. Gives them access to specific server properties, methods
*/
//
function command_utility() {
return {
version: version,
talkername: talkername,
sockets: sockets,
commands: commands,
ranks: ranks,
echo: echo,
getDateTimeString: getDateTimeString,
loadCommands: loadCommands,
getCmdRank: getCmdRank,
setCmdRank: setCmdRank,
findCommand: findCommand,
sendData: sendData,
saveTotalTime: saveTotalTime,
colorize: colorize,
monotone: monotone,
stripAnsi: stripAnsi,
/*
* Execute function to all connected users *but* the triggering
* one.
* It stops at the first connected user to which the function
* returns true, returning true.
*/
allButMe: function allButMe(socket,fn) {
for(var i = 0; i<sockets.length; i++) {
if (sockets[i] !== socket) {
if ((typeof sockets[i].loggedin != 'undefined') &&
sockets[i].loggedin &&
(sockets[i].readyState === 'open')
){
if(fn(socket,sockets[i])) return true;
}
}
}
},
// same as allButMe, but only for those in the same room as me
allHereButMe: function allHereButMe(socket,fn) {
for(var i = 0 ; i < sockets.length; i++) {
if (sockets[i] !== socket) {
if ((typeof sockets[i].loggedin != 'undefined') &&
sockets[i].loggedin &&
(sockets[i].readyState === 'open') &&
(sockets[i].db.where[0] == socket.db.where[0]) &&
(sockets[i].db.where[1] == socket.db.where[1]) &&
(sockets[i].db.where[2] == socket.db.where[2])
){
if(fn(socket,sockets[i])) return true;
}
}
}
},
// returns socket for the user, or false if he doesn't exist
getOnlineUser: function getOnlineUser(name) {
for (var i = 0; i < sockets.length; i++) {
if (name.toLowerCase() === sockets[i].username.toLowerCase() && sockets[i].loggedin) return sockets[i];
}
return false;
},
// returns array of sockets of the 'approximate' online users
// While 'getOnlineUser' is the correct function to use if you want
// to know if 'username' is online or not, sometimes users want to
// refer to another user in an 'human' way, abbreviating.
// Eg.: .wizlist tries to find if each wiz is online or not. Since
// the username is fully and correctly known, 'getOnlineUser' should be
// used. On the other hand, .tell gets an username as an argument. On
// that case, an user can type '.tell mr hello', meaning '.tell MrMe
// hello'. On that case, 'getAproxOnlineUser' should be used.
getAproxOnlineUser: function getOnlineUser(name) {
if (this.getOnlineUser(name) !== false) return [this.getOnlineUser(name)];
var possibilities = [];
for (var i = 0; i < sockets.length; i++) {
if (name.toLowerCase() === sockets[i].username.toLowerCase().substr(0,name.length) && sockets[i].loggedin && (name.length < sockets[i].username.length))
possibilities.push(sockets[i]);
}
return possibilities;
},
// As with `getAproxOnlineUser` except it will filter out the excluded
// user from the list (typically the person running the command)
getAproxOnlineUserExcluding: function getOnlineUser(name, excludeName, onlyIfMultiple = false) {
let possibilities = this.getAproxOnlineUser(name);
if (!onlyIfMultiple || (onlyIfMultiple && possibilities.length > 1)) {
possibilities = possibilities.filter(user => user.username.toLowerCase() !== excludeName.toLowerCase());
}
return possibilities;
},
// returns the user object, in all its db glory
// TODO: Let's give just a subset of data from the user, OK? I mean, we
// don't want any command to have access to other users' passwords, do
// we?
getUser: function getUser(name) {
name = name.toLowerCase().charAt(0).toUpperCase() + name.toLowerCase().slice(1);
return usersdb.get(name).value();
},
// returns the username of an "aproximate" user
// read 'getAproxOnlineUser' to understand the difference between
// 'getOnlineUser' and it, same happens here between 'getUser' and
// 'getAproxUser'.
getAproxUser: function getAproxUser(name) {
if (this.getUser(name) !== undefined) return [name];
var possibilities = [];
for (var key in usersdb.getState()) {
if (name.toLowerCase() === key.toLowerCase().substr(0,name.length) && (name.length < key.length)) {
possibilities.push(key);
}
}
if (possibilities.length === 0) return [];
return possibilities;
},
// updates a user in the database
// TODO: argh, we surely don't want this! harden it!
updateUser: function updateUser(username, userObj) {
username = username.toLowerCase().charAt(0).toUpperCase() + username.toLowerCase().slice(1);
usersdb.set(username,userObj).write();
},
// get users list, only insensitive information
getUsersList: function getUsersList() {
var list = [];
for (var key in usersdb.getState()) {
// retrieving username, rank, loginTime, totalTime and loginCount. If needed, we can always add stuff later
var val = usersdb.get(key).value();
list.push({username:key, rank:val.rank, loginTime:val.loginTime, totalTime:val.totalTime, loginCount:val.loginCount});
}
return list;
},
// gives a full view of the universe; TODO: we surely don't want this
// TODO: in the meantime, we don't need to define a function for this!
getUniverse: function getUniverse() {return universe; },
// update universe's database
saveUniverse: function setUniverse() {
return universedb.set("universe", universe).write();
},
// updates the ranks object, both in memory and on the database
updateRanks: function updateRanks(updated) {
ranks = updated;
return talkerdb.set("ranks", ranks).write();
},
// reloads Talker Name
reloadTalkerName: function reloadTalkerName() {
talkername = universe.name;
},
};
};
/*
* PROMPT UTILITY - adds a command prompt to the server.
* Implemented commands:
* rc: Reload commands. Useful for development/debug. Allows
* you to reload the commands on the fly!
*/
function setPrompt() {
var readline = require('readline');
var rl = readline.createInterface({
input: process.stdin,
output: process.stdout,
prompt: 'OHAI> '
});
rl.prompt();
rl.on('line', function(line) {
switch(line.trim()) {
case 'rc':
try {
console.log(loadCommands());
} catch (e) {
console.log(e);
}
break;
default:
console.log("Available commands: ");
console.log(" rc: Reload commands. Useful for development/debug. Allows");
console.log(" you to reload the commands on the fly!");
break;
}
rl.prompt();
}).on('close', function() {
console.log('Bye!');
process.exit(0);
});
}
/*
* Housekeeping function invoked periodically by watchdog feature
*/
function doHousekeeping() {
// All routine housekeeping calls should be added here
saveTotalTime();
}
/*
* AND FINALLY... THE ACTUAL main()!
*/
function main() {
if (loadeddb !== 3) {
console.log("Waiting for databases to load: " + loadeddb + "/3");
setTimeout(main, 100);
} else {
// Create a new server and provide a callback for when a connection occurs
var server = net.createServer(newSocket);
// Listen on defined port
server.listen(port);
server.on('error',e=>console.log("server socket error: " + e));
console.log(talkername + " initialized on port "+ port);
console.log(loadCommands());
if(talkerdb.get("watchdog").value() > 0) {
console.log("Unleashing watchdog for housekeeping each " + talkerdb.get("watchdog").value() + " seconds");
setInterval(doHousekeeping, (talkerdb.get("watchdog").value()*1000));
}
setPrompt();
}
}
main();