-
Notifications
You must be signed in to change notification settings - Fork 0
/
protocol.cpp
2649 lines (2312 loc) · 95.5 KB
/
protocol.cpp
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
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**************************************************************************
* File: protocol.cpp Part of World of Pain *
* Usage: Protocol negotiation and out of band data support *
* *
* Copyright (C) 2022 World of Pain *
* https://www.worldofpa.in *
* *
* Based upon protocol snippet by KaVir, *
* Released into the Public Domain in February 2011. *
***************************************************************************/
/******************************************************************************
Header files.
******************************************************************************/
#include "conf.h"
#include <string>
#include <variant>
#ifndef CIRCLE_WINDOWS
#include <arpa/telnet.h>
#endif
#include "protocol.h"
#include "structs.h"
#include <queue>
#include <map>
#include <nlohmann/json.hpp>
#include <sys/types.h>
/******************************************************************************
The following section is for Diku/Merc derivatives. Replace as needed.
******************************************************************************/
#include "comm.h"
#include "conf.h"
#include "db.h"
#include "handler.h"
#include "interpreter.h"
#include "olc.h"
#include "screen.h"
#include "structs.h"
#include "sysdep.h"
#include "utils.h"
//#include "dg_scripts.h"
//#include "act.h"
//#include "modify.h"
using namespace std;
using json = nlohmann::json;
/* Globals */
const char* RGBone = "F022";
const char* RGBtwo = "F055";
const char* RGBthree = "F555";
// from comm.c
extern char* parse_color(const char* txt, dPtr t);
static void Write(dPtr apDescriptor, const char* apData)
{
if (apDescriptor != NULL && apDescriptor->has_prompt) {
if (apDescriptor->pProtocol->WriteOOB > 0 || *(apDescriptor->output) == '\0') {
apDescriptor->pProtocol->WriteOOB = 2;
}
}
write_to_output(apData, apDescriptor);
}
static void ReportBug(const char* apText)
{
do_log("%s", apText);
}
static void InfoMessage(dPtr apDescriptor, const char* apData)
{
Write(apDescriptor, "\t[F210][\toINFO\t[F210]]\tn ");
Write(apDescriptor, apData);
}
const char COMPRESS_START[] = {(char)IAC, (char)SB, (char)TELOPT_MCCP, (char)IAC, (char)SE, (char)0};
static void CompressStart(dPtr apDescriptor)
{
/* If your mud uses MCCP (Mud Client Compression Protocol), you need to
* call whatever function normally starts compression from here - the
* ReportBug() call should then be deleted.
*
* Otherwise you can just ignore this function.
*/
/* Send start of the compression stream. */
write_to_descriptor(apDescriptor->descriptor, COMPRESS_START, NULL);
// init compression data
apDescriptor->comp = new compr();
/* Init the compression stream. */
apDescriptor->comp->stream = new z_stream();
apDescriptor->comp->stream->zalloc = z_alloc;
apDescriptor->comp->stream->zfree = z_free;
apDescriptor->comp->stream->opaque = Z_NULL;
deflateInit(apDescriptor->comp->stream, Z_DEFAULT_COMPRESSION);
/* Init the compression buffers. */
apDescriptor->comp->buff_out = new Bytef[SMALL_BUFSIZE]();
apDescriptor->comp->total_out = SMALL_BUFSIZE;
apDescriptor->comp->size_out = 0;
apDescriptor->comp->buff_in = new Bytef[SMALL_BUFSIZE]();
apDescriptor->comp->total_in = SMALL_BUFSIZE;
apDescriptor->comp->size_in = 0;
/* Turn compression state on. */
apDescriptor->comp->state = 2;
do_log("MCCP compression successfully negotiated.");
// ReportBug( "CompressStart() in protocol.c is being called, but it doesn't
// do anything!\n" );
}
void CompressEnd(dPtr apDescriptor)
{
/* If your mud uses MCCP (Mud Client Compression Protocol), you need to
* call whatever function normally starts compression from here - the
* ReportBug() call should then be deleted.
*
* Otherwise you can just ignore this function.
*/
unsigned char dummy[1];
int len, pending;
const char WontMCCP[] = {(char)IAC, (char)WONT, TELOPT_MCCP, '\0'};
int derr;
if (!apDescriptor->comp)
return;
// Write(apDescriptor, WontMCCP);
/* Stop compression and free structures. */
if (apDescriptor->comp->stream) {
pending = apDescriptor->comp->stream->avail_out;
apDescriptor->comp->stream->next_out = apDescriptor->comp->buff_out;
if ((derr = deflate(apDescriptor->comp->stream, Z_FINISH)) != Z_STREAM_END)
do_log("SYSERR: deflate returned %d upon Z_FINISH. (in: %d, out: %d)", derr, apDescriptor->comp->stream->avail_in,
apDescriptor->comp->stream->avail_out);
else
do_log("deflate Z_FINISH completed successfully.");
pending -= apDescriptor->comp->stream->avail_out;
if (pending)
write_to_descriptor(apDescriptor->descriptor, (const char*)apDescriptor->comp->buff_out, NULL);
if ((derr = deflateEnd(apDescriptor->comp->stream)) != Z_OK)
do_log("SYSERR: deflateEnd returned %d. (in: %d, out: %d)", derr, apDescriptor->comp->stream->avail_in,
apDescriptor->comp->stream->avail_out);
else
do_log("deflateEnd completed successfully.");
delete apDescriptor->comp->stream;
delete apDescriptor->comp->buff_out;
delete apDescriptor->comp->buff_in;
}
delete apDescriptor->comp;
apDescriptor->comp = nullptr;
do_log("MCCP compression disabled.");
// ReportBug( "CompressEnd() in protocol.c is being called, but it doesn't do
// anything!\n" );
}
/******************************************************************************
MSDP file-scope variables.
******************************************************************************/
/* These are for the GUI_VARIABLES, KaVir's unofficial extension of MSDP. They're
* intended for clients that wish to offer a generic GUI - not as nice as a
* custom GUI, admittedly, but still better than a plain terminal window.
*
* These are per-player so that they can be customised for different characters
* (eg changing 'mana' to 'blood' for vampires). You could even allow players
* to customise the buttons and gauges themselves if you wish.
*/
static const char s_Button1[] = "\005\002Help\002help\006";
static const char s_Button2[] = "\005\002Look\002look\006";
static const char s_Button3[] = "\005\002Score\002help\006";
static const char s_Button4[] = "\005\002Equipment\002equipment\006";
static const char s_Button5[] = "\005\002Inventory\002inventory\006";
static const char s_Gauge1[] = "\005\002Health\002red\002HEALTH\002HEALTH_MAX\006";
static const char s_Gauge2[] = "\005\002Mana\002blue\002MANA\002MANA_MAX\006";
static const char s_Gauge3[] = "\005\002Movement\002green\002MOVEMENT\002MOVEMENT_MAX\006";
static const char s_Gauge4[] = "\005\002Exp TNL\002yellow\002EXPERIENCE\002EXPERIENCE_MAX\006";
static const char s_Gauge5[] = "\005\002Opponent\002darkred\002OPPONENT_HEALTH\002OPPONENT_HEALTH_MAX\006";
/******************************************************************************
MSDP variable table.
******************************************************************************/
/* Macros for readability, but you can remove them if you don't like them */
#define NUMBER_READ_ONLY false, false, false, false, -1, -1, 0, NULL
#define NUMBER_READ_ONLY_SET_TO(x) false, false, false, false, -1, -1, x, NULL
#define STRING_READ_ONLY true, false, false, false, -1, -1, 0, NULL
#define BOOLEAN_SET_TO(x) false, true, false, false, 0, 1, x, NULL
#define STRING_WITH_LENGTH_OF(x, y) true, true, false, false, x, y, 0, NULL
#define STRING_WRITE_ONCE(x, y) true, true, true, false, -1, -1, 0, NULL
#define STRING_GUI(x) true, false, false, true, -1, -1, 0, x
// GMCP Modules
#define gGENERAL "General"
#define gCHAR "Char"
#define gCHAR_NAME "Char.Name"
#define gCHAR_VITALS "Char.Vitals"
#define gCHAR_STATUSVARS "Char.StatusVars"
#define gCHAR_STATUS "Char.Status"
#define gCHAR_STATS "Char.Stats"
#define gCOMBAT "Combat"
#define gWORLD "World"
#define gROOM_INFO "Room.Info"
#define gCONFIG "Config"
static variable_name_t VariableNameTable[eOOB_MAX + 1] = {
/* General */
{eOOB_CHARACTER_NAME, gCHAR_NAME, "Name", "name", "CHARACTER_NAME", STRING_READ_ONLY},
{eOOB_CHAR_FULL_NAME, gCHAR_NAME, "Full Name", "fullname", "CHAR_FULL_NAME", STRING_READ_ONLY},
{eOOB_SERVER_ID, gGENERAL, "Server ID", "server_id", "SERVER_ID", STRING_READ_ONLY},
{eOOB_SERVER_TIME, gGENERAL, "Server Time", "server_time", "SERVER_TIME", NUMBER_READ_ONLY},
{eOOB_SNIPPET_VERSION, gGENERAL, "Snippet Version", "snippet_version", "SNIPPET_VERSION",
NUMBER_READ_ONLY_SET_TO(SNIPPET_VERSION)},
/* Character */
{eOOB_AFFECTS, gCHAR_VITALS, "Affects", "affects", "AFFECTS", STRING_READ_ONLY},
{eOOB_ALIGNMENT, gCHAR_STATUS, "Alignment", "alignment", "ALIGNMENT", NUMBER_READ_ONLY},
{eOOB_EXPERIENCE, gCHAR_STATUS, "Experience", "xp", "EXPERIENCE", NUMBER_READ_ONLY},
{eOOB_EXPERIENCE_MAX, gCHAR_STATUS, "Max Exp", "xpmax", "EXPERIENCE_MAX", NUMBER_READ_ONLY},
{eOOB_EXPERIENCE_TNL, gCHAR_STATUS, "Exp TNL", "xptnl", "EXPERIENCE_TNL", NUMBER_READ_ONLY},
{eOOB_HEALTH, gCHAR_VITALS, "Health", "hp", "HEALTH", NUMBER_READ_ONLY},
{eOOB_HEALTH_MAX, gCHAR_VITALS, "Max Health", "maxhp", "HEALTH_MAX", NUMBER_READ_ONLY},
{eOOB_LEVEL, gCHAR_STATUS, "Level", "level", "LEVEL", NUMBER_READ_ONLY},
{eOOB_RACE, gCHAR_STATUS, "Race", "race", "RACE", STRING_READ_ONLY},
{eOOB_CLASS, gCHAR_STATUS, "Class", "class", "CLASS", STRING_READ_ONLY},
{eOOB_MANA, gCHAR_VITALS, "Mana", "mp", "MANA", NUMBER_READ_ONLY},
{eOOB_MANA_MAX, gCHAR_VITALS, "Max Mana", "maxmp", "MANA_MAX", NUMBER_READ_ONLY},
{eOOB_WIMPY, gCHAR_STATUS, "Wimpy", "wimpy", "WIMPY", NUMBER_READ_ONLY},
{eOOB_PRACTICE, gCHAR_STATUS, "Practice", "practice", "PRACTICE", NUMBER_READ_ONLY},
{eOOB_MONEY, gCHAR_STATUS, "Gold", "gold", "MONEY", NUMBER_READ_ONLY},
{eOOB_BANK, gCHAR_STATUS, "Bank", "bank", "BANK", NUMBER_READ_ONLY},
{eOOB_MOVEMENT, gCHAR_VITALS, "Movement", "mv", "MOVEMENT", NUMBER_READ_ONLY},
{eOOB_MOVEMENT_MAX, gCHAR_VITALS, "Max Movement", "maxmv", "MOVEMENT_MAX", NUMBER_READ_ONLY},
{eOOB_HITROLL, gCHAR_STATS, "Hitroll", "hitroll", "HITROLL", NUMBER_READ_ONLY},
{eOOB_DAMROLL, gCHAR_STATS, "Damroll", "damroll", "DAMROLL", NUMBER_READ_ONLY},
{eOOB_AC, gCHAR_STATS, "AC", "ac", "AC", NUMBER_READ_ONLY},
{eOOB_STR, gCHAR_STATS, "Strength", "str", "STR", NUMBER_READ_ONLY},
{eOOB_INT, gCHAR_STATS, "Intelligence", "int", "INT", NUMBER_READ_ONLY},
{eOOB_WIS, gCHAR_STATS, "Wisdom", "wis", "WIS", NUMBER_READ_ONLY},
{eOOB_DEX, gCHAR_STATS, "Dexterity", "dex", "DEX", NUMBER_READ_ONLY},
{eOOB_CON, gCHAR_STATS, "Constitution", "con", "CON", NUMBER_READ_ONLY},
{eOOB_CHA, gCHAR_STATS, "Charisma", "cha", "CHA", NUMBER_READ_ONLY},
{eOOB_STR_PERM, gCHAR_STATS, "Perm STR", "str_perm", "STR_PERM", NUMBER_READ_ONLY},
{eOOB_INT_PERM, gCHAR_STATS, "Perm INT", "int_perm", "INT_PERM", NUMBER_READ_ONLY},
{eOOB_WIS_PERM, gCHAR_STATS, "Perm WIS", "wis_perm", "WIS_PERM", NUMBER_READ_ONLY},
{eOOB_DEX_PERM, gCHAR_STATS, "Perm DEX", "dex_perm", "DEX_PERM", NUMBER_READ_ONLY},
{eOOB_CON_PERM, gCHAR_STATS, "Perm CON", "con_perm", "CON_PERM", NUMBER_READ_ONLY},
{eOOB_CHA_PERM, gCHAR_STATS, "Perm CHA", "cha_perm", "CHA_PERM", NUMBER_READ_ONLY},
/* Combat */
{eOOB_OPPONENT_HEALTH, gCOMBAT, "Opponent Health", "opp_hp", "OPPONENT_HEALTH", NUMBER_READ_ONLY},
{eOOB_OPPONENT_HEALTH_MAX, gCOMBAT, "Opponent Max Health", "opp_maxhp", "OPPONENT_HEALTH_MAX", NUMBER_READ_ONLY},
{eOOB_OPPONENT_LEVEL, gCOMBAT, "Opponent Level", "opp_level", "OPPONENT_LEVEL", NUMBER_READ_ONLY},
{eOOB_OPPONENT_NAME, gCOMBAT, "Opponent Name", "opp_name", "OPPONENT_NAME", STRING_READ_ONLY},
{eOOB_COMBAT_STYLE, gCOMBAT, "Combat Style", "style", "COMBAT_STYLE", STRING_READ_ONLY},
/* World */
{eOOB_AREA_NAME, gROOM_INFO, "Area", "area", "AREA_NAME", STRING_READ_ONLY},
{eOOB_ROOM_EXITS, gROOM_INFO, "Exits", "exits", "ROOM_EXITS", STRING_READ_ONLY},
{eOOB_ROOM_NAME, gROOM_INFO, "Name", "name", "ROOM_NAME", STRING_READ_ONLY},
{eOOB_ROOM_VNUM, gROOM_INFO, "Number", "num", "ROOM_VNUM", NUMBER_READ_ONLY},
{eOOB_WORLD_TIME, gWORLD, "Time", "time", "WORLD_TIME", NUMBER_READ_ONLY},
/* Configurable variables */
{eOOB_CLIENT_ID, gCONFIG, "", "", "CLIENT_ID", STRING_WRITE_ONCE(1, 40)},
{eOOB_CLIENT_VERSION, gCONFIG, "", "", "CLIENT_VERSION", STRING_WRITE_ONCE(1, 40)},
{eOOB_PLUGIN_ID, gCONFIG, "", "", "PLUGIN_ID", STRING_WITH_LENGTH_OF(1, 40)},
{eOOB_ANSI_COLORS, gCONFIG, "", "", "ANSI_COLORS", BOOLEAN_SET_TO(1)},
{eOOB_XTERM_256_COLORS, gCONFIG, "", "", "XTERM_256_COLORS", BOOLEAN_SET_TO(1)},
{eOOB_UTF_8, gCONFIG, "", "", "UTF_8", BOOLEAN_SET_TO(1)},
{eOOB_SOUND, gCONFIG, "", "", "SOUND", BOOLEAN_SET_TO(0)},
{eOOB_MXP, gCONFIG, "", "", "MXP", BOOLEAN_SET_TO(0)},
{eOOB_MAX, "", "", "", "", false, false, false, false, 0, 0, 0, NULL} /* This must always be last. */
};
/******************************************************************************
MSSP file-scope variables.
******************************************************************************/
static int s_Players = 0;
static time_t s_Uptime = 0;
/******************************************************************************
Local function prototypes.
******************************************************************************/
static void Negotiate(dPtr apDescriptor);
static void PerformHandshake(dPtr apDescriptor, char aCmd, char aProtocol);
static void PerformSubnegotiation(dPtr apDescriptor, char aCmd, char* apData, int aSize);
static void ParseOOB(dPtr apDescriptor, const char* apData);
static void ExecuteOOBPair(dPtr apDescriptor, const char* apVariable, const char* apValue);
static void ParseGMCP(dPtr apDescriptor, const char* apData);
string GMCPMessageMode(string key, string Message);
void SendGMCP(dPtr apDescriptor, const char* apVariable, const char* apValue);
static void SendMSSP(dPtr apDescriptor);
static char* GetMxpTag(const char* apTag, const char* apText);
static const char* GetAnsiColour(bool abBackground, int aRed, int aGreen, int aBlue);
static const char* GetRGBColour(bool abBackground, int aRed, int aGreen, int aBlue);
static bool IsValidColour(const char* apArgument);
static bool MatchString(const char* apFirst, const char* apSecond);
static bool PrefixString(const char* apPart, const char* apWhole);
static bool IsNumber(const char* apString);
static char* AllocString(const char* apString);
/******************************************************************************
ANSI colour codes.
******************************************************************************/
static const char s_Clean[] = "\033[0;00m"; /* Remove colour */
static const char s_DarkBlack[] = "\033[0;30m"; /* Black foreground */
static const char s_DarkRed[] = "\033[0;31m"; /* Red foreground */
static const char s_DarkGreen[] = "\033[0;32m"; /* Green foreground */
static const char s_DarkYellow[] = "\033[0;33m"; /* Yellow foreground */
static const char s_DarkBlue[] = "\033[0;34m"; /* Blue foreground */
static const char s_DarkMagenta[] = "\033[0;35m"; /* Magenta foreground */
static const char s_DarkCyan[] = "\033[0;36m"; /* Cyan foreground */
static const char s_DarkWhite[] = "\033[0;37m"; /* White foreground */
static const char s_BoldBlack[] = "\033[1;30m"; /* Grey foreground */
static const char s_BoldRed[] = "\033[1;31m"; /* Bright red foreground */
static const char s_BoldGreen[] = "\033[1;32m"; /* Bright green foreground */
static const char s_BoldYellow[] = "\033[1;33m"; /* Bright yellow foreground */
static const char s_BoldBlue[] = "\033[1;34m"; /* Bright blue foreground */
static const char s_BoldMagenta[] = "\033[1;35m"; /* Bright magenta foreground */
static const char s_BoldCyan[] = "\033[1;36m"; /* Bright cyan foreground */
static const char s_BoldWhite[] = "\033[1;37m"; /* Bright white foreground */
static const char s_BackBlack[] = "\033[1;40m"; /* Black background */
static const char s_BackRed[] = "\033[1;41m"; /* Red background */
static const char s_BackGreen[] = "\033[1;42m"; /* Green background */
static const char s_BackYellow[] = "\033[1;43m"; /* Yellow background */
static const char s_BackBlue[] = "\033[1;44m"; /* Blue background */
static const char s_BackMagenta[] = "\033[1;45m"; /* Magenta background */
static const char s_BackCyan[] = "\033[1;46m"; /* Cyan background */
static const char s_BackWhite[] = "\033[1;47m"; /* White background */
/******************************************************************************
Protocol global functions.
******************************************************************************/
protocol_t* ProtocolCreate(void)
{
int i; /* Loop counter */
protocol_t* pProtocol;
/* Called the first time we enter - make sure the table is correct */
static bool bInit = false;
if (!bInit) {
bInit = true;
for (i = eOOB_NONE + 1; i < eOOB_MAX; ++i) {
if (VariableNameTable[i].Variable != i) {
ReportBug("OOB: Variable table does not match the enums in the header.\n");
break;
}
}
}
pProtocol = new protocol_t();
pProtocol->WriteOOB = 0;
pProtocol->bIACMode = false;
pProtocol->bNegotiated = false;
pProtocol->bBlockMXP = false;
pProtocol->bTTYPE = false;
pProtocol->bNAWS = false;
pProtocol->bCHARSET = false;
pProtocol->bMSDP = false;
pProtocol->bMSP = false;
pProtocol->bMXP = false;
pProtocol->bGMCP = false;
pProtocol->bMCCP = false;
pProtocol->b256Support = eUNKNOWN;
pProtocol->ScreenWidth = 0;
pProtocol->ScreenHeight = 0;
pProtocol->pMXPVersion = AllocString("Unknown");
pProtocol->pLastTTYPE = NULL;
pProtocol->pVariables = (OOB_t**)malloc(sizeof(OOB_t*) * eOOB_MAX);
pProtocol->destroyed = false;
for (i = eOOB_NONE + 1; i < eOOB_MAX; ++i) {
pProtocol->pVariables[i] = (OOB_t*)malloc(sizeof(OOB_t));
pProtocol->pVariables[i]->bReport = false;
pProtocol->pVariables[i]->bDirty = false;
pProtocol->pVariables[i]->ValueInt = 0;
pProtocol->pVariables[i]->pValueString = NULL;
if (VariableNameTable[i].bString) {
if (VariableNameTable[i].pDefault != NULL)
pProtocol->pVariables[i]->pValueString = AllocString(VariableNameTable[i].pDefault);
else if (VariableNameTable[i].bConfigurable)
pProtocol->pVariables[i]->pValueString = AllocString("Unknown");
else /* Use an empty string */
pProtocol->pVariables[i]->pValueString = AllocString("");
} else if (VariableNameTable[i].Default != 0) {
pProtocol->pVariables[i]->ValueInt = VariableNameTable[i].Default;
}
}
return pProtocol;
}
void ProtocolDestroy(protocol_t* apProtocol)
{
int i; /* Loop counter */
if (!apProtocol || apProtocol->destroyed)
return;
apProtocol->destroyed = true;
for (i = eOOB_NONE + 1; i < eOOB_MAX; ++i) {
if (apProtocol->pVariables[i]->pValueString)
free(apProtocol->pVariables[i]->pValueString);
free(apProtocol->pVariables[i]);
}
free(apProtocol->pVariables);
if (apProtocol->pLastTTYPE) /* Isn't saved over copyover so may still be NULL */
free(apProtocol->pLastTTYPE);
free(apProtocol->pMXPVersion);
delete apProtocol;
}
ssize_t ProtocolInput(dPtr apDescriptor, char* apData, int aSize, char* apOut)
{
static char CmdBuf[MAX_PROTOCOL_BUFFER + 1];
static char IacBuf[MAX_PROTOCOL_BUFFER + 1];
ssize_t CmdIndex = 0;
ssize_t IacIndex = 0;
ssize_t Index;
protocol_t* pProtocol = apDescriptor ? apDescriptor->pProtocol : NULL;
for (Index = 0; Index < aSize; ++Index) {
/* If we'd overflow the buffer, we just ignore the input */
if (CmdIndex >= MAX_PROTOCOL_BUFFER || IacIndex >= MAX_PROTOCOL_BUFFER) {
ReportBug("ProtocolInput: Too much incoming data to store in the buffer.\n");
return (-1);
}
/* IAC IAC is treated as a single value of 255 */
if (apData[Index] == (char)IAC && apData[Index + 1] == (char)IAC) {
if (pProtocol->bIACMode)
IacBuf[IacIndex++] = (char)IAC;
else /* In-band command */
CmdBuf[CmdIndex++] = (char)IAC;
Index++;
} else if (pProtocol->bIACMode) {
/* End subnegotiation. */
if (apData[Index] == (char)IAC && apData[Index + 1] == (char)SE) {
Index++;
pProtocol->bIACMode = false;
IacBuf[IacIndex] = '\0';
if (IacIndex >= 2)
PerformSubnegotiation(apDescriptor, IacBuf[0], &IacBuf[1], IacIndex - 1);
IacIndex = 0;
} else
IacBuf[IacIndex++] = apData[Index];
} else if (apData[Index] == (char)27 && apData[Index + 1] == '[' && isdigit(apData[Index + 2])
&& apData[Index + 3] == 'z') {
char MXPBuffer[1024];
char* pMXPTag = NULL;
int i = 0; /* Loop counter */
Index += 4; /* Skip to the start of the MXP sequence. */
while (Index < aSize && apData[Index] != '>' && i < 1000) {
MXPBuffer[i++] = apData[Index++];
}
MXPBuffer[i++] = '>';
MXPBuffer[i] = '\0';
if ((pMXPTag = GetMxpTag("SUPPORTS", MXPBuffer)) != NULL) {
InfoMessage(apDescriptor, "MXP SUPPORTS: ");
Write(apDescriptor, MXPBuffer);
Write(apDescriptor, "\r\n");
}
if ((pMXPTag = GetMxpTag("CLIENT=", MXPBuffer)) != NULL) {
/* Overwrite the previous client name - this is harder to fake */
free(pProtocol->pVariables[eOOB_CLIENT_ID]->pValueString);
pProtocol->pVariables[eOOB_CLIENT_ID]->pValueString = AllocString(pMXPTag);
}
if ((pMXPTag = GetMxpTag("VERSION=", MXPBuffer)) != NULL) {
const char* pClientName = pProtocol->pVariables[eOOB_CLIENT_ID]->pValueString;
// InfoMessage(apDescriptor, "Received MXP Version From Client: ");
// Write(apDescriptor, pMXPTag);
// Write(apDescriptor, "\r\n");
// MXPSendTag( apDescriptor, "<SUPPORT>" );
free(pProtocol->pVariables[eOOB_CLIENT_VERSION]->pValueString);
pProtocol->pVariables[eOOB_CLIENT_VERSION]->pValueString = AllocString(pMXPTag);
if (MatchString("MUSHCLIENT", pClientName)) {
/* MUSHclient 4.02 and later supports 256 colours. */
if (strcmp(pMXPTag, "4.02") >= 0) {
pProtocol->pVariables[eOOB_XTERM_256_COLORS]->ValueInt = 1;
pProtocol->b256Support = eYES;
} else /* We know for sure that 256 colours are not supported */
pProtocol->b256Support = eNO;
} else if (MatchString("CMUD", pClientName)) {
/* CMUD 3.04 and later supports 256 colours. */
if (strcmp(pMXPTag, "3.04") >= 0) {
pProtocol->pVariables[eOOB_XTERM_256_COLORS]->ValueInt = 1;
pProtocol->b256Support = eYES;
} else /* We know for sure that 256 colours are not supported */
pProtocol->b256Support = eNO;
} else if (MatchString("ATLANTIS", pClientName)) {
/* Atlantis 0.9.9.0 supports XTerm 256 colours, but it doesn't
* yet have MXP. However MXP is planned, so once it responds
* to a <VERSION> tag we'll know we can use 256 colours.
*/
pProtocol->pVariables[eOOB_XTERM_256_COLORS]->ValueInt = 1;
pProtocol->b256Support = eYES;
}
}
if ((pMXPTag = GetMxpTag("MXP=", MXPBuffer)) != NULL) {
free(pProtocol->pMXPVersion);
pProtocol->pMXPVersion = AllocString(pMXPTag);
}
/* No longer necessary
*
if ( strcmp(pProtocol->pMXPVersion, "Unknown") )
{
Write( apDescriptor, "\n" );
sprintf( MXPBuffer, "MXP version %s detected and enabled.\r\n",
pProtocol->pMXPVersion );
InfoMessage( apDescriptor, MXPBuffer );
} */
} else /* In-band command */
{
if (apData[Index] == (char)IAC) {
switch (apData[Index + 1]) {
case (char)SB: /* Begin subnegotiation. */
Index++;
pProtocol->bIACMode = true;
break;
case (char)DO: /* Handshake. */
case (char)DONT:
case (char)WILL:
case (char)WONT:
PerformHandshake(apDescriptor, apData[Index + 1], apData[Index + 2]);
Index += 2;
break;
case (char)IAC: /* Two IACs count as one. */
CmdBuf[CmdIndex++] = (char)IAC;
Index++;
break;
default: /* Skip it. */
Index++;
break;
}
} else
CmdBuf[CmdIndex++] = apData[Index];
}
}
/* Terminate the two buffers */
IacBuf[IacIndex] = '\0';
CmdBuf[CmdIndex] = '\0';
/* Copy the input buffer back to the player. */
strcat(apOut, CmdBuf);
return (CmdIndex);
}
const char* ProtocolOutput(dPtr apDescriptor, const char* apData, int* apLength)
{
static char Result[MAX_OUTPUT_BUFFER + 1];
const char Tab[] = "\t";
const char MSP[] = "!!";
const char MXPStart[] = "\033[1z<";
const char MXPStop[] = ">\033[7z";
const char LinkStart[] = "\033[1z<send>\033[7z";
const char LinkStop[] = "\033[1z</send>\033[7z";
const char Ampersand[] = "&";
const char HelpStart[] = "\033[1z<send href=\"help ";
const char HelpStop[] = "\">\033[7z";
bool bTerminate = false, bUseMXP = false, bUseMSP = false;
int i = 0, j = 0; /* Index values */
protocol_t* pProtocol = apDescriptor ? apDescriptor->pProtocol : NULL;
if (pProtocol == NULL || apData == NULL)
return apData;
/* Strip !!SOUND() triggers if they support MSP or are using sound */
if (pProtocol->bMSP || pProtocol->pVariables[eOOB_SOUND]->ValueInt)
bUseMSP = true;
for (; i < MAX_OUTPUT_BUFFER && apData[j] != '\0' && !bTerminate && (*apLength <= 0 || j < *apLength); ++j) {
if (apData[j] == '\t') {
const char* pCopyFrom = NULL;
switch (apData[++j]) {
case '\t': /* Two tabs in a row will display an actual tab */
pCopyFrom = Tab;
break;
case '_':
pCopyFrom = "\x1B[4m"; /* Underline... if supported */
break;
case '+':
pCopyFrom = "\x1B[1m"; /* Bold... if supported */
break;
case '-':
pCopyFrom = "\x1B[5m"; /* Blinking... if supported */
break;
case '=':
pCopyFrom = "\x1B[7m"; /* Reverse... if supported */
break;
case '*':
pCopyFrom = "@"; /* The At Symbol... I don't really like this, but it seems like
a simple way to allow for the @ symbol while maintain
portability between pre-ProtocolOutput() muds and post
ProtocolOutput() muds.*/
break;
/* 1,2,3 to be used a MUD's base colour palette. Just to maintain
* some sort of common colouring scheme amongst coders/builders */
case '1':
pCopyFrom = ColourRGB(apDescriptor, RGBone);
break;
case '2':
pCopyFrom = ColourRGB(apDescriptor, RGBtwo);
break;
case '3':
pCopyFrom = ColourRGB(apDescriptor, RGBthree);
break;
case 'n':
pCopyFrom = s_Clean;
break;
case 'd': /* dark grey / black */
pCopyFrom = ColourRGB(apDescriptor, "F000");
break;
case 'D': /* light grey */
pCopyFrom = ColourRGB(apDescriptor, "F111");
break;
case 'a': /* dark azure */
pCopyFrom = ColourRGB(apDescriptor, "F021");
break;
case 'A': /* light Azure */
pCopyFrom = ColourRGB(apDescriptor, "F053");
break;
case 'r': /* dark red */
pCopyFrom = ColourRGB(apDescriptor, "F200");
break;
case 'R': /* light red */
pCopyFrom = ColourRGB(apDescriptor, "F500");
break;
case 'g': /* dark green */
pCopyFrom = ColourRGB(apDescriptor, "F020");
break;
case 'G': /* light green */
pCopyFrom = ColourRGB(apDescriptor, "F050");
break;
case 'y': /* dark yellow */
pCopyFrom = ColourRGB(apDescriptor, "F330");
break;
case 'Y': /* light yellow */
pCopyFrom = ColourRGB(apDescriptor, "F550");
break;
case 'b': /* dark blue */
pCopyFrom = ColourRGB(apDescriptor, "F012");
break;
case 'B': /* light blue */
pCopyFrom = ColourRGB(apDescriptor, "F025");
break;
case 'm': /* dark magenta */
pCopyFrom = ColourRGB(apDescriptor, "F202");
break;
case 'M': /* light magenta */
pCopyFrom = ColourRGB(apDescriptor, "F505");
break;
case 'c': /* dark cyan */
pCopyFrom = ColourRGB(apDescriptor, "F022");
break;
case 'C': /* light cyan */
pCopyFrom = ColourRGB(apDescriptor, "F055");
break;
case 'w': /* dark white */
pCopyFrom = ColourRGB(apDescriptor, "F333");
break;
case 'W': /* light white */
pCopyFrom = ColourRGB(apDescriptor, "F555");
break;
case 'o': /* dark orange */
pCopyFrom = ColourRGB(apDescriptor, "F520");
break;
case 'O': /* light orange */
pCopyFrom = ColourRGB(apDescriptor, "F530");
break;
case 'p': /* dark pink */
pCopyFrom = ColourRGB(apDescriptor, "F301");
break;
case 'P': /* light pink */
pCopyFrom = ColourRGB(apDescriptor, "F501");
break;
case '(': /* MXP link */
if (!pProtocol->bBlockMXP && pProtocol->pVariables[eOOB_MXP]->ValueInt)
pCopyFrom = LinkStart;
break;
case ')': /* MXP link */
if (!pProtocol->bBlockMXP && pProtocol->pVariables[eOOB_MXP]->ValueInt)
pCopyFrom = LinkStop;
pProtocol->bBlockMXP = false;
break;
case '~': // MXP Help link
if (!pProtocol->bBlockMXP && pProtocol->pVariables[eOOB_MXP]->ValueInt) {
char HelpText[MAX_OUTPUT_BUFFER], HelpBuffer[MAX_OUTPUT_BUFFER];
char BugString[MAX_OUTPUT_BUFFER];
int h = 0;
bool bDone = false;
while (apData[++j] != '\0') {
if (apData[j] == '\t' && apData[j + 1] == '~') {
j++;
bDone = true;
break;
} else
HelpText[h++] = apData[j];
}
HelpText[h] = '\0';
if (!bDone) {
sprintf(BugString, "BUG: MXP Help '%s' wasn't terminated with '@~'.\n", HelpText);
ReportBug(BugString);
if (h)
pCopyFrom = HelpText;
} else {
sprintf(HelpBuffer, "%s%s%s%s%s", HelpStart, HelpText, HelpStop, HelpText, LinkStop);
pCopyFrom = HelpBuffer;
pProtocol->bBlockMXP = false;
}
}
break;
case '<':
if (!pProtocol->bBlockMXP && pProtocol->pVariables[eOOB_MXP]->ValueInt) {
pCopyFrom = MXPStart;
bUseMXP = true;
} else /* No MXP support, so just strip it out */
{
while (apData[j] != '\0' && apData[j] != '>')
++j;
}
pProtocol->bBlockMXP = false;
break;
case '[':
if (tolower(apData[++j]) == 'u') {
char Buffer[8] = {'\0'}, BugString[256];
int Index = 0;
int Number = 0;
bool bDone = false, bValid = true;
while (isdigit(apData[++j])) {
Number *= 10;
Number += (apData[j]) - '0';
}
if (apData[j] == '/')
++j;
while (apData[j] != '\0' && !bDone) {
if (apData[j] == ']')
bDone = true;
else if (Index < 7)
Buffer[Index++] = apData[j++];
else /* It's too long, so ignore the rest and note the problem */
{
j++;
bValid = false;
}
}
if (!bDone) {
sprintf(BugString, "BUG: Unicode substitute '%s' wasn't terminated with ']'.\n", Buffer);
ReportBug(BugString);
} else if (!bValid) {
sprintf(BugString, "BUG: Unicode substitute '%s' truncated. Missing ']'?\n", Buffer);
ReportBug(BugString);
} else if (pProtocol->pVariables[eOOB_UTF_8]->ValueInt) {
pCopyFrom = UnicodeGet(Number);
} else /* Display the substitute string */
{
pCopyFrom = Buffer;
}
/* Terminate if we've reached the end of the string */
bTerminate = !bDone;
} else if (tolower(apData[j]) == 'f' || tolower(apData[j]) == 'b') {
char Buffer[8] = {'\0'}, BugString[256];
int Index = 0;
bool bDone = false, bValid = true;
/* Copy the 'f' (foreground) or 'b' (background) */
Buffer[Index++] = apData[j++];
while (apData[j] != '\0' && !bDone && bValid) {
if (apData[j] == ']')
bDone = true;
else if (Index < 4)
Buffer[Index++] = apData[j++];
else /* It's too long, so drop out - the colour code may still be
valid */
bValid = false;
}
if (!bDone || !bValid) {
sprintf(BugString, "BUG: RGB %sground colour '%s' wasn't terminated with ']'.\n",
(tolower(Buffer[0]) == 'f') ? "fore" : "back", &Buffer[1]);
ReportBug(BugString);
} else if (!IsValidColour(Buffer)) {
sprintf(BugString,
"BUG: RGB %sground colour '%s' invalid (each digit must be "
"in the range 0-5).\n",
(tolower(Buffer[0]) == 'f') ? "fore" : "back", &Buffer[1]);
ReportBug(BugString);
} else /* Success */
{
pCopyFrom = ColourRGB(apDescriptor, Buffer);
}
} else if (tolower(apData[j]) == 'x') {
char Buffer[8] = {'\0'}, BugString[256];
int Index = 0;
bool bDone = false, bValid = true;
++j; /* Skip the 'x' */
while (apData[j] != '\0' && !bDone) {
if (apData[j] == ']')
bDone = true;
else if (Index < 7)
Buffer[Index++] = apData[j++];
else /* It's too long, so ignore the rest and note the problem */
{
j++;
bValid = false;
}
}
if (!bDone) {
sprintf(BugString, "BUG: Required MXP version '%s' wasn't terminated with ']'.\n", Buffer);
ReportBug(BugString);
} else if (!bValid) {
sprintf(BugString, "BUG: Required MXP version '%s' too long. Missing ']'?\n", Buffer);
ReportBug(BugString);
} else if (!strcmp(pProtocol->pMXPVersion, "Unknown") || strcmp(pProtocol->pMXPVersion, Buffer) < 0) {
/* Their version of MXP isn't high enough */
pProtocol->bBlockMXP = true;
} else /* MXP is sufficient for this tag */
{
pProtocol->bBlockMXP = false;
}
/* Terminate if we've reached the end of the string */
bTerminate = !bDone;
}
break;
case '!': /* Used for in-band MSP sound triggers */
pCopyFrom = MSP;
break;
case '\0':
bTerminate = true;
break;
default:
break;
}
/* Copy the colour code, if any. */
if (pCopyFrom != NULL) {
while (*pCopyFrom != '\0' && i < MAX_OUTPUT_BUFFER)
Result[i++] = *pCopyFrom++;
}
} else if (bUseMXP && apData[j] == '>') {
const char* pCopyFrom = MXPStop;
while (*pCopyFrom != '\0' && i < MAX_OUTPUT_BUFFER)
Result[i++] = *pCopyFrom++;
bUseMXP = false;
} else if (bUseMSP && j > 0 && apData[j - 1] == '!' && apData[j] == '!' && PrefixString("SOUND(", &apData[j + 1])) {
/* Avoid accidental triggering of old-style MSP triggers */
Result[i++] = '?';
} else if (apData[j] == '&') {
/* Legacy World of Pain color support */
const char* pCopyFrom = NULL;
switch (apData[++j]) {
case '0': /* Removed the color check code's here to */
pCopyFrom = KNRM; /* speed up the exchange JB */
break;
case '1':
pCopyFrom = KRED;
break;
case '2':
pCopyFrom = KGRN;
break;
case '3':
pCopyFrom = KYEL;
break;
case '4':
pCopyFrom = KBLU;
break;
case '5':
pCopyFrom = KMAG;
break;
case '6':
pCopyFrom = KCYN;
break;
case '7':
pCopyFrom = KWHT;
break;
case '8': /* both cases did same thing JB */
case 'b':
pCopyFrom = KBLD;
break;
case '9':
pCopyFrom = KBLK;
break;
case 'u':
pCopyFrom = KUND;
break;
case 'd':
pCopyFrom = KDAR;
break;
case 'R':
pCopyFrom = KBRED;
break;
case 'G':
pCopyFrom = KBGRN;
break;
case 'Y':
pCopyFrom = KBYEL;
break;
case 'B':
pCopyFrom = KBBLU;
break;
case 'M':
pCopyFrom = KBMAG;
break;
case 'C':
pCopyFrom = KBCYN;
break;
case 'W':
pCopyFrom = KBWHT;
break;
case 'S':
pCopyFrom = KBBLK;
break;
case '&':
pCopyFrom = Ampersand;
break;
default:
break;
}
/* Copy the color code, if any. */
if (pCopyFrom != NULL) {
while (*pCopyFrom != '\0' && i < MAX_OUTPUT_BUFFER)
Result[i++] = *pCopyFrom++;
}
} else /* Just copy the character normally */
{
Result[i++] = apData[j];
}
}
/* If we'd overflow the buffer, we don't send any output */