-
-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy pathWASimModule.cpp
1839 lines (1629 loc) · 65.8 KB
/
WASimModule.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
/*
This file is part of the WASimCommander project.
https://github.com/mpaperno/WASimCommander
COPYRIGHT: (c) Maxim Paperno; All Rights Reserved.
This file may be used under the terms of the GNU General Public License (GPL)
as published by the Free Software Foundation, either version 3 of the Licenses,
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.
A copy of the GNU GPL is included with this project
and is also available at <http://www.gnu.org/licenses/>.
*/
#include <cstdio>
#include <cstring>
#include <charconv>
#include <iomanip>
#include <iostream>
#include <map>
#include <memory>
#include <sstream>
#include <string>
#include <string_view>
#include <system_error>
// the order of includes below here matters (because the MSFS/SC headers are wonky)
#include "inipp.h"
#include <MSFS/MSFS.h>
#include <MSFS/MSFS_WindowsTypes.h>
#include <MSFS/Legacy/gauges.h>
#include <SimConnect.h>
#define LOGFAULT_THREAD_NAME WSMCMND_SERVER_NAME
#include "WASimCommander.h"
#include "utilities.h"
#include "SimConnectHelper.h"
#include "token_vars.h"
#include "key_events.h"
using namespace std;
using namespace std::chrono;
using namespace WASimCommander;
using namespace WASimCommander::Utilities;
using namespace WASimCommander::Enums;
static const time_t CONN_HEARTBEAT_SEC = CONN_TIMEOUT_SEC / 3; // Number of seconds between checks for an active client.
//----------------------------------------------------------------------------
#pragma region Enum definitions
//----------------------------------------------------------------------------
enum SimConnectIDs : uint8_t
{
SIMCONNECTID_INIT = 0,
// SIMCONNECT_NOTIFICATION_GROUP_ID
GROUP_DEFAULT, // default notification group for all standard sim events
// SIMCONNECT_EVENT_ID
EVENT_FRAME, // for frame event trigger
// SIMCONNECT_CLIENT_EVENT_ID
CLI_EVENT_CONNECT, // initial client connection event
CLI_EVENT_PING, // incoming ping event
SIMCONNECTID_LAST // dynamic IDs will start here
};
enum class ClientStatus : uint8_t
{
Unknown, Connected, Disconnected, TimedOut
};
enum class RecordType : uint8_t
{
Unknown, CommandData, RequestData, KeyEventData
};
#pragma endregion Enums
//----------------------------------------------------------------------------
#pragma region Struct and type definitions
//----------------------------------------------------------------------------
// DataRequest tracking meta data
struct TrackedRequest : DataRequest
{
DWORD dataId; // our area and def ID for SimConnect
uint32_t dataSize = 0; // actual size of value data, since valueSize may be a special value
ID variableId = -1; // result of local var name lookup
ENUM unitId = -1; // result of unit name lookup
steady_clock::time_point nextUpdate = steady_clock::now(); // time of next pending value check/update
vector<uint8_t> data {}; // the last data value is stored here, for comparison to detect value changes
string calcBytecode {}; // compiled calculator string byte code
bool compareCheck = true; // indicates that a result value should be compared for equality with last value before sending update
explicit TrackedRequest(const DataRequest &req, uint32_t dataId) :
DataRequest(req),
dataId{dataId},
dataSize{Utilities::getActualValueSize(req.valueSize)},
data((size_t)dataSize, -1),
compareCheck{req.deltaEpsilon >= 0.0f}
{
checkRequestType();
}
TrackedRequest &operator=(const DataRequest &req) {
// reset data array size
if (!dataSize || req.valueSize != valueSize) {
dataSize = Utilities::getActualValueSize(req.valueSize);
data = vector<uint8_t>(dataSize, -1);
}
// reset lookup data
if (strncmp(req.nameOrCode, nameOrCode, STRSZ_REQ)) {
variableId = -1;
calcBytecode.clear();
}
if (strncmp(req.unitName, unitName, STRSZ_UNIT))
unitId = -1;
// reset comparison flag
compareCheck = (req.deltaEpsilon >= 0.0f);
DataRequest::operator=(req);
checkRequestType();
return *this;
}
void checkRequestType()
{
// Anything besides L/A/T type vars just gets converted to calc code, as well as any A vars with "string" unit type.
bool isString = false;
if (requestType == RequestType::Named && variableId < 0 &&
(!Utilities::isIndexedVariableType(varTypePrefix) || (isString = (unitId < 0 && varTypePrefix == 'A' && !strcasecmp(unitName, "string"))))
) {
ostringstream codeStr = ostringstream() << '(' << varTypePrefix << ':' << nameOrCode;
if (unitName[0] != '\0')
codeStr << ',' << unitName;
codeStr << ')';
setNameOrCode(codeStr.str().c_str());
requestType = RequestType::Calculated;
if (isString)
calcResultType = CalcResultType::String;
else if (valueSize > DATA_TYPE_INT64 || valueSize < 4)
calcResultType = CalcResultType::Integer;
else
calcResultType = CalcResultType::Double;
}
}
friend inline std::ostream& operator<<(std::ostream& os, const TrackedRequest &c) {
os << (const DataRequest&)c;
return os << " TrackedRequest{dataId: " << c.dataId << "; dataSize: " << c.dataSize
<< "; variableId: " << c.variableId << "; unitId: " << c.unitId
<< "; calcBytecode: " << Utilities::byteArrayToHex(c.calcBytecode.data(), c.calcBytecode.size()) << "; nextUpdate: " << Utilities::timePointToString(c.nextUpdate)
<< "; data: " << Utilities::byteArrayToHex(c.data.data(), c.dataSize) << '}';
}
};
struct TrackedEvent
{
uint32_t eventId;
string code {};
string name {};
string execCode {}; // actual code to exec, most likely bytecode
};
typedef map<uint32_t, TrackedRequest> requestMap_t;
typedef map<uint32_t, TrackedEvent> clientEventMap_t;
// WASim Client record
struct Client
{
const uint32_t clientId;
const string name;
ClientStatus status = ClientStatus::Unknown;
LogLevel logLevel = LogLevel::None;
bool pauseDataUpdates = false;
steady_clock::time_point nextTimeout = steady_clock::now();
steady_clock::time_point nextHearbeat = steady_clock::now();
// Data Definition IDs
DWORD cddID_command = 0;
DWORD cddID_response = 0;
DWORD cddID_request = 0;
DWORD cddID_log = 0;
DWORD cddID_keyEvent = 0;
// request and custom event tracking
requestMap_t requests {};
clientEventMap_t events {};
Client(uint32_t id, ClientStatus status = ClientStatus::Connected) :
clientId(id),
name{(ostringstream() << STREAM_HEX8(id)).str()},
status(status)
{ }
};
struct DefinitionIdRecord
{
const RecordType type;
Client *const client;
explicit DefinitionIdRecord(const RecordType t, Client * const c) : type(t), client(c) {}
};
struct EventIdRecord
{
const uint32_t eventId;
Client *const client;
explicit EventIdRecord(const uint32_t eId, Client * const c) : eventId(eId), client(c) {}
};
struct calcResult_t
{
CalcResultType type;
size_t strSize;
int32_t varId = -1;
int32_t unitId = -1;
uint8_t varIndex = 0;
const char *varName = nullptr;
size_t resultSize = 0;
int8_t resultMemberIndex = -1;
FLOAT64 fVal = 0.0;
SINT32 iVal = 0;
string sVal {};
void setF(const FLOAT64 val) { fVal = val; resultSize = sizeof(FLOAT64); resultMemberIndex = 0; }
void setI(const SINT32 val) { iVal = val; resultSize = sizeof(SINT32); resultMemberIndex = 1; }
void setS(const string &&val) { sVal = std::move(val); sVal.resize(strSize); resultSize = strSize; resultMemberIndex = 2; }
};
typedef map<uint32_t, Client> clientMap_t;
typedef map<DWORD, DefinitionIdRecord> definitionIdMap_t;
typedef map<SIMCONNECT_CLIENT_EVENT_ID, EventIdRecord> eventIdMap_t;
typedef map<uint32_t, SIMCONNECT_CLIENT_EVENT_ID> pingRespEventMap_t;
#pragma endregion Structs
//----------------------------------------------------------------------------
#pragma region Globals
//----------------------------------------------------------------------------
HANDLE g_hSimConnect { INVALID_HANDLE_VALUE };
clientMap_t g_mClients {};
definitionIdMap_t g_mDefinitionIds {};
eventIdMap_t g_mEventIds {};
pingRespEventMap_t g_pingRespEventIds {};
steady_clock::time_point g_tpNextTick { steady_clock::now() };
SIMCONNECT_CLIENT_EVENT_ID g_nextClientEventId = SIMCONNECTID_LAST;
SIMCONNECT_CLIENT_DATA_DEFINITION_ID g_nextClienDataId = SIMCONNECTID_LAST;
bool g_triggersRegistered = false;
#pragma endregion Globals
//----------------------------------------------------------------------------
#pragma region Client Responses
//----------------------------------------------------------------------------
bool sendResponse(const Client *c, const Command &cmd)
{
if (c->status != ClientStatus::Connected)
return false;
LOG_TRC << "Sending command to " << c->name << ": " << cmd;
return INVOKE_SIMCONNECT(
SetClientData, g_hSimConnect,
c->cddID_response, c->cddID_response,
SIMCONNECT_CLIENT_DATA_SET_FLAG_DEFAULT, 0UL,
(DWORD)sizeof(Command), (void *)&cmd
);
}
bool sendAckNak(const Client *c, const Command &forCmd, bool ack = true, const char *msg = nullptr, double fData = 0.0) {
return sendResponse(c, Command(ack ? CommandId::Ack : CommandId::Nak, +forCmd.commandId, msg, fData, forCmd.token));
}
bool sendAckNak(const Client *c, CommandId commandId, bool ack = true, uint32_t token = 0, const char *msg = nullptr, double fData = 0.0) {
return sendResponse(c, Command(ack ? CommandId::Ack : CommandId::Nak, +commandId, msg, fData, token));
}
void logAndNak(const Client *c, const Command &forCmd, const ostringstream &ss) {
sendAckNak(c, forCmd.commandId, false, forCmd.token, ss.str().c_str());
LOG_ERR << ss.str();
}
void logAndNak(const Client *c, CommandId commandId, uint32_t token, const ostringstream &ss) {
sendAckNak(c, commandId, false, token, ss.str().c_str());
LOG_ERR << ss.str();
}
bool sendPing(const Client *c) {
return sendResponse(c, Command(CommandId::Ping, c->clientId));
}
bool sendLogRecord(const Client *c, const LogRecord &log)
{
if (c->status != ClientStatus::Connected)
return false;
//if (c->logLevel < LogLevel::Trace) LOG_TRC << "Sending LogRecord to " << c->name << ": " << log;
return INVOKE_SIMCONNECT(
SetClientData, g_hSimConnect,
c->cddID_log, c->cddID_log,
SIMCONNECT_CLIENT_DATA_SET_FLAG_DEFAULT, 0UL,
(DWORD)sizeof(LogRecord), (void *)&log
);
}
bool writeRequestData(const Client *c, const TrackedRequest *tr, void *data)
{
if (c->status != ClientStatus::Connected)
return false;
LOG_TRC << "Writing request ID " << tr->requestId << " data for " << c->name << " to CDA / CDD ID " << tr->dataId << " of size " << tr->dataSize;
return INVOKE_SIMCONNECT(
SetClientData, g_hSimConnect,
tr->dataId, tr->dataId,
SIMCONNECT_CLIENT_DATA_SET_FLAG_DEFAULT, 0UL,
(DWORD)tr->dataSize, data
);
}
#pragma endregion Client Responses
//----------------------------------------------------------------------------
#pragma region Client Setup/lookup
//----------------------------------------------------------------------------
Client *findClient(uint32_t id)
{
const clientMap_t::iterator pos = g_mClients.find(id);
if (pos != g_mClients.cend())
return &pos->second;
return nullptr;
}
const DefinitionIdRecord *findDefinitionRecord(uint32_t definitionId)
{
const definitionIdMap_t::const_iterator pos = g_mDefinitionIds.find(definitionId);
if (pos != g_mDefinitionIds.cend())
return &pos->second;
return nullptr;
}
const EventIdRecord *findEventRecord(uint32_t id)
{
const eventIdMap_t::const_iterator pos = g_mEventIds.find(id);
if (pos != g_mEventIds.cend())
return &pos->second;
return nullptr;
}
TrackedRequest *findClientRequest(Client *c, uint32_t id)
{
const requestMap_t::iterator pos = c->requests.find(id);
if (pos != c->requests.cend())
return &pos->second;
return nullptr;
}
TrackedEvent *findClientEvent(Client *c, uint32_t id)
{
const clientEventMap_t::iterator pos = c->events.find(id);
if (pos != c->events.cend())
return &pos->second;
return nullptr;
}
const string *getClientEventExecString(const Client *c, uint32_t id)
{
const clientEventMap_t::const_iterator pos = c->events.find(id);
if (pos != c->events.cend())
return &pos->second.execCode;
return nullptr;
}
bool registerClientCommandDataAreas(const Client *c)
{
// Register data area for reading commands from client; client can write to this.
const string cmdCdaName(CDA_NAME_CMD_PFX + c->name);
if FAILED(SimConnectHelper::registerDataArea(g_hSimConnect, cmdCdaName, c->cddID_command, c->cddID_command, sizeof(Command), false))
return false;
LOG_DBG << "Created CDA ID " << c->cddID_command << " named " << quoted(cmdCdaName) << " of size " << sizeof(Command);
// data area for writing command responses to client; read-only for client
const string respCdaName(CDA_NAME_RESP_PFX + c->name);
if FAILED(SimConnectHelper::registerDataArea(g_hSimConnect, respCdaName, c->cddID_response, c->cddID_response, sizeof(Command), false))
return false;
LOG_DBG << "Created CDA ID " << c->cddID_response << " named " << quoted(respCdaName) << " of size " << sizeof(Command);
// Listen for client commands
return SUCCEEDED(INVOKE_SIMCONNECT(RequestClientData, g_hSimConnect, c->cddID_command, c->cddID_command, c->cddID_command, SIMCONNECT_CLIENT_DATA_PERIOD_ON_SET, 0UL, 0UL, 0UL, 0UL));
}
bool registerClientRequestDataArea(const Client *c)
{
// DataRequest area is named "WASimCommander.Data.<client_name>"; client can write to this.
const string cdaName(CDA_NAME_DATA_PFX + c->name);
if FAILED(SimConnectHelper::registerDataArea(g_hSimConnect, cdaName, c->cddID_request, c->cddID_request, sizeof(DataRequest), false))
return false;
LOG_DBG << "Created CDA ID " << c->cddID_request << " named " << quoted(cdaName) << " of size " << sizeof(DataRequest);
// Listen for client data subscription requests
return SUCCEEDED(INVOKE_SIMCONNECT(RequestClientData, g_hSimConnect, c->cddID_request, c->cddID_request, c->cddID_request, SIMCONNECT_CLIENT_DATA_PERIOD_ON_SET, 0UL, 0UL, 0UL, 0UL));
}
bool registerClientKeyEventDataArea(const Client *c)
{
// DataRequest area is named "WASimCommander.KeyEvent.<client_name>"; client can write to this.
const string cdaName(CDA_NAME_KEYEV_PFX + c->name);
if FAILED(SimConnectHelper::registerDataArea(g_hSimConnect, cdaName, c->cddID_keyEvent, c->cddID_keyEvent, sizeof(KeyEvent), false))
return false;
LOG_DBG << "Created CDA ID " << c->cddID_keyEvent << " named " << quoted(cdaName) << " of size " << sizeof(KeyEvent);
// Listen for key events
return SUCCEEDED(INVOKE_SIMCONNECT(RequestClientData, g_hSimConnect, c->cddID_keyEvent, c->cddID_keyEvent, c->cddID_keyEvent, SIMCONNECT_CLIENT_DATA_PERIOD_ON_SET, 0UL, 0UL, 0UL, 0UL));
}
bool registerClientLogDataArea(const Client *c)
{
// Log area is named "WASimCommander.Log.<client_name>"; read-only for client
const string cdaName(CDA_NAME_LOG_PFX + c->name);
if FAILED(SimConnectHelper::registerDataArea(g_hSimConnect, cdaName, c->cddID_log, c->cddID_log, sizeof(LogRecord), false))
return false;
LOG_DBG << "Created CDA ID " << c->cddID_log << " named " << quoted(cdaName) << " of size " << sizeof(LogRecord);
return true;
}
bool registerClientVariableDataArea(const Client *c, uint32_t areaId, uint32_t dataId, DWORD dataAreaSize, DWORD sizeOrType)
{
// Individual variable value data areas are named "WASimCommander.Data.<client_name>.<areaId>"; read-only for client
const string cdaName(CDA_NAME_DATA_PFX + c->name + '.' + to_string(areaId));
if FAILED(SimConnectHelper::registerDataArea(g_hSimConnect, cdaName, dataId, dataId, sizeOrType, false))
return false;
LOG_DBG << "Created CDA ID " << dataId << " named " << quoted(cdaName) << " of size " << dataAreaSize;
return true;
}
void removeClientVariableDataArea(const TrackedRequest *tr)
{
// remove definition
if FAILED(SimConnectHelper::removeClientDataDefinition(g_hSimConnect, tr->dataId))
LOG_WRN << "Failed to clear ClientDataDefinition for requestId " << tr->requestId << ", check log messages.";
}
void removeClientCustomEvent(const Client *c, uint32_t eventId)
{
SIMCONNECT_CLIENT_EVENT_ID clientEventId = 0;
for (auto it = g_mEventIds.cbegin(), en = g_mEventIds.cend(); !clientEventId && it != en; ++it) {
if (it->second.client == c && it->second.eventId == eventId)
clientEventId = it->first;
}
if (!clientEventId) {
LOG_WRN << "Could not find SIMCONNECT_CLIENT_EVENT_ID record for client " << c->name << " with event ID " << eventId;
return;
}
INVOKE_SIMCONNECT(RemoveClientEvent, g_hSimConnect, (DWORD)c->clientId, clientEventId);
g_mEventIds.erase(clientEventId);
//LOG_INF << "Deleted registered event ID " << eventId << " for Client " << c->name;
}
Client *getOrCreateClient(uint32_t clientId)
{
if (!clientId) {
LOG_ERR << "Client ID must be greater than zero.";
return nullptr;
}
if (Client *c = findClient(clientId)) {
LOG_DBG << "Found Client " << c->name << " stat " << (int)c->status;
return c;
}
// New client
Client c(clientId);
// assign unique IDs for SimConnect data definitions (these are used for ClientDataID, DefineID and RequestID)
c.cddID_command = g_nextClienDataId++;
c.cddID_response = g_nextClienDataId++;
c.cddID_request = g_nextClienDataId++;
c.cddID_keyEvent = g_nextClienDataId++;
// register all data areas for this client with SimConnect
if (!registerClientCommandDataAreas(&c))
return nullptr; // dispose client on failure
registerClientRequestDataArea(&c);
registerClientKeyEventDataArea(&c);
// move client record into map
Client *pC = &g_mClients.emplace(clientId, std::move(c)).first->second;
// save mappings of the command and request data IDs (which SimConnect sends us) to the client record; for lookup in message dispatch.
g_mDefinitionIds.emplace(piecewise_construct, forward_as_tuple(c.cddID_command), forward_as_tuple(RecordType::CommandData, pC)); // no try_emplace?
g_mDefinitionIds.emplace(piecewise_construct, forward_as_tuple(c.cddID_request), forward_as_tuple(RecordType::RequestData, pC));
g_mDefinitionIds.emplace(piecewise_construct, forward_as_tuple(c.cddID_keyEvent), forward_as_tuple(RecordType::KeyEventData, pC));
LOG_INF << "Created new Client with name " << pC->name << " from ID " << clientId;
return pC;
}
void updateClientTimeout(Client *c)
{
const auto now = steady_clock::now();
c->nextTimeout = now + seconds(CONN_TIMEOUT_SEC);
c->nextHearbeat = now + seconds(CONN_HEARTBEAT_SEC);
}
Client *connectClient(Client *c)
{
if (c) {
c->status = ClientStatus::Connected;
updateClientTimeout(c);
LOG_INF << "Client connected with ID/Name " << c->name;
}
return c;
}
Client *connectClient(uint32_t id)
{
return connectClient(getOrCreateClient(id));
}
// forwards, in Utility Functions just below
void checkTriggerEventNeeded();
void resumeTriggerEvent();
// marks client as disconnected or timed out and clears any saved requests/events
void disconnectClient(Client *c, ClientStatus newStatus = ClientStatus::Disconnected)
{
if (!c || c->status == newStatus)
return;
c->status = newStatus;
// clear all data requests
for (const auto &req : c->requests)
removeClientVariableDataArea(&req.second);
c->requests.clear();
// clear all registered events
for (const auto &ev : c->events)
removeClientCustomEvent(c, ev.first);
c->events.clear();
LOG_INF << "Disconnected Client " << c->name;
checkTriggerEventNeeded(); // check if anyone is still connected
}
// disconnects _and_ sends a Disconnect command to client with given message
void disconnectClient(Client *c, const char *message, ClientStatus newStatus = ClientStatus::Disconnected)
{
disconnectClient(c, newStatus);
sendResponse(c, Command(CommandId::Disconnect, 0, message));
}
void disconnectAllClients(const char *message = nullptr)
{
for (auto &it : g_mClients)
disconnectClient(&it.second, message, ClientStatus::Disconnected);
}
void disableAllClients()
{
for (auto &it : g_mClients)
it.second.status = ClientStatus::Disconnected;
}
// callback for logfault IdProxyHandler log handler
void CALLBACK clientLogHandler(const uint32_t id, const logfault::Message &msg)
{
const Client *c = findClient(id);
if (c && c->status == ClientStatus::Connected)
sendLogRecord(c, LogRecord((LogLevel)msg.level_, msg.msg_.c_str(), msg.when_));
}
bool setClientLogLevel(Client *c, LogLevel level)
{
if (c->logLevel == level)
return true;
c->logLevel = level;
if (!c->cddID_log) {
// first time level is set > None, set up log CDA and log proxy handler
c->cddID_log = g_nextClienDataId++;
if (!registerClientLogDataArea(c))
return false;
logfault::LogManager::Instance().AddHandler(
make_unique<logfault::IdProxyHandler>(logfault::IdProxyHandler(&clientLogHandler, (logfault::LogLevel)level, c->name, c->clientId))
);
return true;
}
// change level on existing logger
logfault::LogManager::Instance().SetLevel(c->name, (logfault::LogLevel)level);
LOG_DBG << "Set log level for client " << c->name << " to " << Utilities::getEnumName(level, LogLevelNames);
return true;
}
#pragma endregion Client Setup
//----------------------------------------------------------------------------
#pragma region Utility Functions
//----------------------------------------------------------------------------
// this runs once we have any requests to keep updated which essentially starts the tick() processing.
void resumeTriggerEvent()
{
// use "Frame" event as trigger for our tick() loop
if FAILED(INVOKE_SIMCONNECT(SetSystemEventState, g_hSimConnect, (SIMCONNECT_CLIENT_EVENT_ID)EVENT_FRAME, SIMCONNECT_STATE_ON))
return;
g_triggersRegistered = true;
LOG_INF << "DataRequest data update processing started.";
}
// and here is the opposite... if all clients disconnect we can stop the ticker loop.
void pauseTriggerEvent()
{
if FAILED(INVOKE_SIMCONNECT(SetSystemEventState, g_hSimConnect, (SIMCONNECT_CLIENT_EVENT_ID)EVENT_FRAME, SIMCONNECT_STATE_OFF))
return;
g_triggersRegistered = false;
LOG_INF << "DataRequest update processing stopped.";
}
// check if any clients are connected and stop the tick() trigger if none are;
// we could also call this from removeRequest() and check each connected client if
// they still have any active data subscriptions... but that seems excessive.
void checkTriggerEventNeeded()
{
for (const clientMap_t::value_type &it : g_mClients) {
const Client &c = it.second;
if (c.status == ClientStatus::Connected && !c.pauseDataUpdates && c.requests.size())
return;
}
pauseTriggerEvent();
}
bool execCalculatorCode(const char *code, calcResult_t &result, bool precompiled = false)
{
// DO NOT try to log a compiled code "string" -- it's byte code and may crash the logger
LOG_TRC << "Executing calculator code: " << quoted(precompiled ? "Compiled code" : code) << " with result type " << Utilities::getEnumName(result.type, CalcResultTypeNames);
if (code[0] == '\0')
return false;
bool ok = false;
if (result.type == CalcResultType::None) {
ok = execute_calculator_code(code, nullptr, nullptr, nullptr);
LOG_TRC << "execute_calculator_code() returned: ok: " << boolalpha << ok;
return ok;
}
if (result.type == CalcResultType::Formatted) {
result.setS(string(result.strSize, '\0'));
ok = format_calculator_string(&result.sVal[0], result.strSize, code);
LOG_TRC << "format_calculator_string() returned: ok: " << boolalpha << ok << "; sVal: " << quoted(result.sVal);
return ok;
}
PCSTRINGZ cVal = nullptr;
if ((ok = execute_calculator_code(code, &result.fVal, &result.iVal, &cVal))) {
// exec_calc always produces a string, so store that in the result regardless of the requested type (unlikely to be null but check JIC)
if (!!cVal)
result.setS(string(cVal, strnlen(cVal, result.strSize)));
switch (result.type) {
case CalcResultType::Double:
result.resultMemberIndex = 0;
result.resultSize = 8;
break;
case CalcResultType::Integer:
result.resultMemberIndex = 1;
result.resultSize = 4;
break;
case CalcResultType::String:
// in case the string result was null (unlikely), set an empty string
if (!cVal)
result.setS(string());
break;
default:
break;
}
}
LOG_TRC << "execute_calculator_code() returned: ok: " << boolalpha << ok << "; fVal: " << result.fVal << "; iVal: " << result.iVal << "; sVal: " << quoted(result.sVal);
return ok;
}
bool getNamedVariableValue(char varType, calcResult_t &result)
{
switch (varType)
{
case 'L':
if (result.varId < 0)
return false;
if (result.unitId > -1)
result.setF(get_named_variable_typed_value(result.varId, result.unitId));
else
result.setF(get_named_variable_value(result.varId));
break;
case 'A':
if (result.varId < 0 || result.unitId < 0)
return false;
result.setF(aircraft_varget(result.varId, result.unitId, result.varIndex));
break;
case 'T': {
MODULE_VAR gs_var;
if (result.varId > -1)
gs_var = { (GAUGE_TOKEN)result.varId };
else if (result.varName)
initialize_var_by_name(&gs_var, const_cast<char*>(result.varName));
lookup_var(&gs_var);
switch (gs_var.var_type) {
case TYPE_FLOAT64:
case TYPE_ANGL48:
case TYPE_SINT48:
case TYPE_UIF48:
case TYPE_SIF48:
result.setF(gs_var.var_value.n);
break;
case TYPE_BOOL:
case TYPE_BOOL8:
case TYPE_BOOL16:
case TYPE_BOOL32:
result.setI(gs_var.var_value.b);
break;
case TYPE_FLAGS:
case TYPE_FLAGS8:
case TYPE_FLAGS16:
case TYPE_FLAGS32:
result.setI(gs_var.var_value.f);
break;
case TYPE_ENUM:
case TYPE_ENUM8:
case TYPE_ENUM16:
case TYPE_ENUM32:
result.setI(gs_var.var_value.e);
break;
case TYPE_BCD16:
result.setI(gs_var.var_value.d);
break;
case TYPE_BCO16:
result.setI(gs_var.var_value.o);
break;
case TYPE_PUINT32:
case TYPE_PSINT32:
result.setI(*((int32_t*)gs_var.var_value.p));
break;
case TYPE_PFLOAT64:
result.setF(*((double*)gs_var.var_value.p));
break;
case TYPE_PVOID: {
const char *cVal = reinterpret_cast<const char *>(gs_var.var_value.p);
result.setS(string(cVal, strnlen(cVal, result.strSize)));
break;
}
case TYPE_VOID:
return false;
default:
result.setI(gs_var.var_value.n);
break;
} // result type switch
break;
} // case T
default:
LOG_WRN << "Unknown variable type " << varType << " for getNamedVariableValue()";
return false;
} // var type switch
LOG_TRC << "Result for " << varType << " var " << result.varName << " result: f:" << result.fVal << " i:" << result.iVal << " s:" << quoted(result.sVal);
return true;
}
int getVariableId(char varType, const char *name, bool createLocal = false)
{
switch (varType)
{
case 'L':
// local vars return -1 for invalid, and zero is a valid index
if (createLocal)
return register_named_variable(name);
return check_named_variable(name);
case 'A': {
// SimVars return zero for invalid, normalize return value to match local vars.
const ENUM id = get_aircraft_var_enum(name);
return id > 0 ? id : -1;
}
case 'T': {
// Token vars may also return zero for invalid (MODULE_VAR_NONE), normalize return value to match local vars.
const GAUGE_TOKEN id = Utilities::getTokenVariableId(name); // Intellicode erroneous error flag
return id > MODULE_VAR_NONE ? (int)id : -1;
}
default:
return -1;
}
}
// Parse a command string to find a variable name/unit/index and populates the respective reference params.
// Lookups are done on var names, depending on varType, and unit strings, to attempt conversion to IDs.
// Used by setVariable() and getVariable(). Only handles A/L/T var types (not needed for others).
bool parseVariableString(const char varType, const char *data, ID &varId, bool createLocal, ENUM *unitId = nullptr, uint8_t *varIndex = nullptr, string *varName = nullptr, bool *existed = nullptr)
{
string_view svVar(data, strlen(data)), svUnit{};
if (varType != 'T') {
// Check for unit type after variable name/id and comma
const size_t idx = svVar.find(',');
if (idx != string::npos) {
svUnit = svVar.substr(idx + 1);
svVar.remove_suffix(svVar.size() - idx);
}
// check for index value at end of SimVar name/ID
if (varType == 'A' && svVar.size() > 3) {
const string_view &svIndex = svVar.substr(svVar.size() - 3);
const size_t idx = svIndex.find(':');
if (idx != string::npos) {
// strtoul returns zero if conversion fails, which works fine since zero is not a valid simvar index
if (!!varIndex)
*varIndex = strtoul(svIndex.data() + idx + 1, nullptr, 10);
svVar.remove_suffix(3 - idx);
}
}
}
// empty variable name/id is invalid
if (svVar.empty())
return false;
// Try to parse the remaining var name string as a numeric ID
auto result = from_chars(svVar.data(), svVar.data() + svVar.size(), varId);
// if number conversion failed, look up variable id
if (result.ec != errc()) {
const std::string vname(svVar);
if (createLocal && !!existed) {
varId = check_named_variable(vname.c_str());
*existed = varId > -1;
if (!*existed)
varId = register_named_variable(vname.c_str());
}
else {
varId = getVariableId(varType, vname.c_str(), createLocal);
}
if (!!varName)
*varName = vname;
}
// failed to find a numeric id, whole input was invalid
if (varId < 0)
return false;
// check for unit specification
if (!!unitId && !svUnit.empty()) {
// try to parse the string as a numeric ID
result = from_chars(svUnit.data(), svUnit.data() + svUnit.size(), *unitId);
// if number conversion failed, look up unit id
if (result.ec != errc()) {
*unitId = get_units_enum(string(svUnit).c_str()); // this may also fail but unit ID is not "critical" (caller can decide what to do)
if (*unitId < 0)
LOG_WRN << "Could not resolve Unit ID from string " << quoted(data);
}
}
return true;
}
#pragma endregion Utility
//----------------------------------------------------------------------------
#pragma region Command Handlers
//----------------------------------------------------------------------------
void returnPingEvent(DWORD data)
{
SIMCONNECT_CLIENT_EVENT_ID evId = 0;
const pingRespEventMap_t::const_iterator pos = g_pingRespEventIds.find(data);
if (pos != g_pingRespEventIds.cend()) {
evId = pos->second;
}
else {
evId = g_nextClientEventId++;
g_pingRespEventIds.emplace(data, evId);
const ostringstream nameBuff = ostringstream() << EVENT_NAME_PING_PFX << STREAM_HEX8(data);
LOG_DBG << "Registering ping response event name " << quoted(nameBuff.str());
if FAILED(SimConnectHelper::newClientEvent(g_hSimConnect, evId, nameBuff.str()))
return;
}
LOG_DBG << "Responding to Ping for event name " << EVENT_NAME_PING_PFX << STREAM_HEX8(data);
INVOKE_SIMCONNECT(TransmitClientEvent, g_hSimConnect, SIMCONNECT_OBJECT_ID_USER, evId, WSMCMND_VERSION,
SIMCONNECT_GROUP_PRIORITY_HIGHEST, SIMCONNECT_EVENT_FLAG_GROUPID_IS_PRIORITY);
}
bool setLogLevel(Client *c, const Command *const cmd, string *ackMsg = nullptr)
{
bool ret = true;
bool validFac = false;
uint8_t fac = (uint8_t)cmd->fData;
if (fac == +LogFacility::None || (fac & +LogFacility::Remote)) {
ret = setClientLogLevel(c, static_cast<LogLevel>(cmd->uData));
validFac = true;
}
if (fac & +LogFacility::File) {
logfault::LogManager::Instance().SetLevel("File", (logfault::LogLevel)cmd->uData); // Intellicode erroneous error flag
validFac = true;
LOG_DBG << "Set log level for File logger to " << Utilities::getEnumName((LogLevel)cmd->uData, LogLevelNames);
}
if (fac & +LogFacility::Console) {
logfault::LogManager::Instance().SetLevel(LOGFAULT_THREAD_NAME, (logfault::LogLevel)cmd->uData); // Intellicode erroneous error flag
validFac = true;
LOG_DBG << "Set log level for Console logger to " << Utilities::getEnumName((LogLevel)cmd->uData, LogLevelNames);
}
if (!validFac) {
if (ackMsg)
*ackMsg = "Unknown LogFacility";
LOG_ERR << "Unknown LogFacility: " << fac;
return false;
}
return ret;
}
void listItems(const Client *c, const Command *const cmd)
{
LOG_DBG << "Got List request of type " << Utilities::getEnumName((LookupItemType)cmd->uData, LookupItemTypeNames) << " for client " << c->name;
Command resp(CommandId::List);
resp.token = cmd->token;
switch ((LookupItemType)cmd->uData) {
case LookupItemType::LocalVariable: {
int i = 0;
while (true) {
PCSTRINGZ varName = get_name_of_named_variable(i);
if (!varName)
break;
resp.uData = i++;
resp.setStringData(varName);
sendResponse(c, resp);
}
break;
}
case LookupItemType::DataRequest: {
for (const auto &r : c->requests) {
resp.uData = r.first;
resp.setStringData(r.second.nameOrCode);
sendResponse(c, resp);
}
break;
}
case LookupItemType::RegisteredEvent: {
for (const auto &r : c->events) {
resp.uData = r.first;
resp.setStringData(r.second.code.c_str());
sendResponse(c, resp);
}
break;
}
default:
logAndNak(c, *cmd, ostringstream() << "Unknown LookupItemType " << Utilities::getEnumName((LookupItemType)cmd->uData, LookupItemTypeNames) << " (" << cmd->uData << ") for List command.");
return;
}
sendAckNak(c, CommandId::List, true, cmd->token, "List results completed");
}
void lookup(const Client *c, const Command *const cmd)
{
LookupItemType type = LookupItemType(cmd->uData);
const char *name = cmd->sData;
LOG_TRC << "Performing Lookup of type " << Utilities::getEnumName((LookupItemType)cmd->uData, LookupItemTypeNames) << " with name " << quoted(name) << " for client " << c->name;
int itemId = -1;
switch (LookupItemType(cmd->uData))
{
case LookupItemType::LocalVariable:
itemId = getVariableId('L', name);
break;
case LookupItemType::SimulatorVariable:
itemId = getVariableId('A', name);
break;
case LookupItemType::TokenVariable:
itemId = getVariableId('T', name);
break;
case LookupItemType::UnitType:
itemId = get_units_enum(name);
break;
case LookupItemType::KeyEventId:
itemId = Utilities::getKeyEventId(name); // Intellicode erroneous error flag
break;
case LookupItemType::DataRequest:
for (const auto &r : c->requests)
if (!strcmp(name, r.second.nameOrCode))
itemId = (int)r.first;
break;
case LookupItemType::RegisteredEvent:
for (const auto &e : c->events)
if (!strcmp(name, e.second.code.c_str()))
itemId = (int)e.first;
break;
default:
logAndNak(c, *cmd, ostringstream() << "Unknown LookupItemType: " << cmd->uData);
return;
}
if (itemId > -1)
sendResponse(c, Command(CommandId::Ack, (uint32_t)CommandId::Lookup, name, (double)itemId, cmd->token));
else
logAndNak(c, *cmd, ostringstream() << "Lookup type " << Utilities::getEnumName(type, LookupItemTypeNames) << " failed for name " << quoted(name));
}
void execCalculatorCode(const Client *c, const Command *const cmd)
{