-
-
Notifications
You must be signed in to change notification settings - Fork 525
/
wzdiscordrpc.cpp
1188 lines (1068 loc) · 43.9 KB
/
wzdiscordrpc.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 Warzone 2100.
Copyright (C) 2020 Warzone 2100 Project
Warzone 2100 is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
Warzone 2100 is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Warzone 2100; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#include "lib/framework/frame.h"
#include "lib/framework/wzapp.h"
#include "lib/gamelib/gtime.h"
#include "lib/netplay/netplay.h"
#include "lib/netplay/netsocket.h"
#include "../activity.h"
#include "../frontend.h"
#include "../multiint.h"
#include "../nethelpers.h"
#include "../notifications.h"
#include "../urlhelpers.h"
#include "../urlrequest.h"
#include "../version.h"
#include <sstream>
#include <algorithm>
#include <chrono>
#include <functional>
#include <memory>
#include <discord_rpc.h>
#include <sodium.h>
#include <EmbeddedJSONSignature.h>
#include <optional-lite/optional.hpp>
using nonstd::optional;
using nonstd::nullopt;
static const char* APPID = "505520727521361941";
static const size_t MAX_DISCORD_STR_LEN = 127; // 128 - 1 (for null terminator)
static bool presenceUpdatesEnabled = true;
static std::unordered_map<std::string, std::chrono::system_clock::time_point> lastDismissedJoinRequestByUserId;
#define WZ_DISCORD_JOIN_SPAM_INTERVAL_SECS 60
#define JOIN_NOTIFICATION_TAG_PREFIX "joinNotify::"
#define JOIN_FIND_AND_CONNECT_TAG std::string(JOIN_NOTIFICATION_TAG_PREFIX "findandconnect")
static std::string b64Tob64UrlSafe(const std::string& inputb64)
{
std::string b64urlsafe = inputb64;
std::replace(b64urlsafe.begin(), b64urlsafe.end(), '+', '-');
std::replace(b64urlsafe.begin(), b64urlsafe.end(), '/', '_');
return b64urlsafe;
}
static std::string b64UrlSafeTob64(const std::string& inputb64urlsafe)
{
std::string b64 = inputb64urlsafe;
std::replace(b64.begin(), b64.end(), '-', '+');
std::replace(b64.begin(), b64.end(), '_', '/');
return b64;
}
static void asyncGetDiscordDefaultUserAvatar(const std::string& discord_user_discriminator, const std::function<void (optional<std::vector<unsigned char>> memoryBuffer)>& callback)
{
unsigned long user_discriminator = 0;
try {
user_discriminator = std::stoul(discord_user_discriminator);
}
catch (const std::exception&) {
// Failed to convert discriminator to unsigned long
callback(nullopt);
return;
}
std::string user_discriminator_img_str = std::to_string(user_discriminator % 5);
URLDataRequest urlRequest;
urlRequest.url = std::string("https://cdn.discordapp.com/embed/avatars/") + urlEncode(user_discriminator_img_str.c_str()) + ".png?size=128";
urlRequest.onSuccess = [callback](const std::string& url, const HTTPResponseDetails& responseDetails, const std::shared_ptr<MemoryStruct>& data) {
long httpStatusCode = responseDetails.httpStatusCode();
if (httpStatusCode != 200)
{
wzAsyncExecOnMainThread([httpStatusCode]{
debug(LOG_WARNING, "Query for default Discord user avatar returned HTTP status code: %ld", httpStatusCode);
});
callback(nullopt);
return;
}
if (!data || data->memory == nullptr || data->size == 0)
{
// Invalid data response
callback(nullopt);
return;
}
std::vector<unsigned char> memoryBuffer((unsigned char *)data->memory, ((unsigned char*)data->memory) + data->size);
callback(memoryBuffer);
};
urlRequest.onFailure = [callback](const std::string& url, URLRequestFailureType type, optional<HTTPResponseDetails> transferDetails) {
callback(nullopt);
};
urlRequest.maxDownloadSizeLimit = 4 * 1024 * 1024; // response should never be > 4 MB
urlRequestData(urlRequest);
}
static void asyncGetDiscordDefaultUserAvatar(const DiscordUser* request, const std::function<void (optional<std::vector<unsigned char>> memoryBuffer)>& callback)
{
if (request->discriminator == nullptr)
{
callback(nullopt);
return;
}
asyncGetDiscordDefaultUserAvatar(request->discriminator, callback);
}
static void asyncGetDiscordUserAvatar(const DiscordUser* request, const std::function<void (optional<std::vector<unsigned char>> memoryBuffer)>& callback)
{
if (request->avatar == nullptr || strlen(request->avatar) == 0)
{
asyncGetDiscordDefaultUserAvatar(request, callback);
return;
}
const std::string discord_user_discriminator = (request->discriminator) ? request->discriminator : "";
URLDataRequest urlRequest;
urlRequest.url = std::string("https://cdn.discordapp.com/avatars/") + urlEncode(request->userId) + "/" + urlEncode(request->avatar) + ".png?size=128";
urlRequest.onSuccess = [callback, discord_user_discriminator](const std::string& url, const HTTPResponseDetails& responseDetails, const std::shared_ptr<MemoryStruct>& data) {
long httpStatusCode = responseDetails.httpStatusCode();
if (httpStatusCode != 200)
{
wzAsyncExecOnMainThread([httpStatusCode]{
debug(LOG_WARNING, "Query for Discord user avatar returned HTTP status code: %ld", httpStatusCode);
});
// fallback
asyncGetDiscordDefaultUserAvatar(discord_user_discriminator, callback);
return;
}
if (!data || data->memory == nullptr || data->size == 0)
{
// Invalid data response
// fallback
asyncGetDiscordDefaultUserAvatar(discord_user_discriminator, callback);
return;
}
std::vector<unsigned char> memoryBuffer((unsigned char *)data->memory, ((unsigned char*)data->memory) + data->size);
callback(memoryBuffer);
};
urlRequest.onFailure = [callback, discord_user_discriminator](const std::string& url, URLRequestFailureType type, optional<HTTPResponseDetails> transferDetails) {
// fallback
asyncGetDiscordDefaultUserAvatar(discord_user_discriminator, callback);
};
urlRequest.maxDownloadSizeLimit = 4 * 1024 * 1024; // response should never be > 4 MB
urlRequestData(urlRequest);
}
static std::string getAllianceString(const ActivitySink::MultiplayerGameInfo& info)
{
switch (info.alliances)
{
case ActivitySink::SkirmishGameInfo::AllianceOption::NO_ALLIANCES:
return "\xf0\x9f\x9a\xab"; // 🚫
case ActivitySink::SkirmishGameInfo::AllianceOption::ALLIANCES:
return "\xf0\x9f\x91\x8d"; // 👍
case ActivitySink::SkirmishGameInfo::AllianceOption::ALLIANCES_TEAMS:
return "\xf0\x9f\x94\x92\xf0\x9f\x94\xac"; // 🔒🔬
case ActivitySink::SkirmishGameInfo::AllianceOption::ALLIANCES_UNSHARED:
return "\xf0\x9f\x94\x92\xf0\x9f\x9a\xab"; // 🔒🚫
}
return ""; // silence warning
}
static std::string truncateStringIfExceedsLength(const std::string& inputStr, size_t maxLen, std::string ellipsis = "...")
{
if (inputStr.size() > maxLen)
{
size_t truncatedSize = maxLen - ellipsis.size();
std::string outputStr = inputStr.substr(0, truncatedSize);
outputStr += ellipsis;
return outputStr;
}
return inputStr;
}
static void displayCantJoinWhileInGameNotification()
{
WZ_Notification notification;
notification.duration = 0;
notification.contentTitle = _("Discord: Can't Join Game");
notification.contentText = _("You can't join a game while you're in a game. Please save / quit your current game, exit to the main menu, and try again.");
addNotification(notification, WZ_Notification_Trigger::Immediate());
}
static void joinGameImpl(const std::vector<JoinConnectionDescription>& joinConnectionDetails)
{
const auto currentGameMode = ActivityManager::instance().getCurrentGameMode();
if (currentGameMode != ActivitySink::GameMode::MENUS)
{
// Can't join a game while already in a game
cancelOrDismissNotificationsWithTag(JOIN_FIND_AND_CONNECT_TAG);
debug(LOG_ERROR, "Can't join a game while already in a game / lobby.");
return;
}
// join the game!
NetPlay.bComms = true; // use network = true
NETinit(true);
// Ensure the joinGame has a place to return to
changeTitleMode(TITLE);
JoinGameResult result = joinGame(joinConnectionDetails);
if (result != JoinGameResult::JOINED)
{
cancelOrDismissNotificationsWithTag(JOIN_FIND_AND_CONNECT_TAG);
}
}
static void findAndJoinLobbyGameImpl(const std::string& lobbyAddress, unsigned int lobbyPort, uint32_t lobbyGameId)
{
WZ_Notification notification;
notification.duration = 60 * GAME_TICKS_PER_SEC;
notification.contentTitle = _("Discord: Finding & Connecting to Game");
std::string contentStr = _("Attempting to find & connect to the game specified by the Discord invite.");
contentStr += "\n\n";
contentStr += _("This may take a moment...");
notification.contentText = contentStr;
notification.onDisplay = [lobbyAddress, lobbyPort, lobbyGameId](const WZ_Notification&) {
// once the notification is completely displayed, trigger the lookup & join
const auto currentGameMode = ActivityManager::instance().getCurrentGameMode();
if (currentGameMode != ActivitySink::GameMode::MENUS)
{
// Can't join a game while in a game - abort
cancelOrDismissNotificationsWithTag(JOIN_FIND_AND_CONNECT_TAG);
displayCantJoinWhileInGameNotification();
return;
}
// For now, it is necessary to call `NETinit(true)` before calling findLobbyGame
// Obviously this wouldn't be a good idea to do *during* a game, hence the check above to
// ensure we're still in the menus...
NETinit(true);
ingame.side = InGameSide::MULTIPLAYER_CLIENT;
auto joinConnectionDetails = findLobbyGame(lobbyAddress, lobbyPort, lobbyGameId);
if (joinConnectionDetails.empty())
{
cancelOrDismissNotificationsWithTag(JOIN_FIND_AND_CONNECT_TAG);
debug(LOG_ERROR, "Join code: Failed to find game in the lobby server: %s:%u", lobbyAddress.c_str(), lobbyPort);
std::string contentText = _("Failed to find game in the lobby server: ");
contentText += lobbyAddress + ":" + std::to_string(lobbyPort) + "\n\n";
contentText += _("The game may have already started, or the host may have disbanded the game lobby.");
WZ_Notification notification;
notification.duration = 0;
notification.contentTitle = _("Failed to Find Game");
notification.contentText = contentText;
notification.largeIcon = WZ_Notification_Image("images/notifications/exclamation_triangle.png");
notification.tag = std::string(JOIN_NOTIFICATION_TAG_PREFIX "failedtoconnect");
addNotification(notification, WZ_Notification_Trigger::Immediate());
return;
}
ActivityManager::instance().willAttemptToJoinLobbyGame(lobbyAddress, lobbyPort, lobbyGameId, joinConnectionDetails);
joinGameImpl(joinConnectionDetails);
};
notification.largeIcon = WZ_Notification_Image("images/notifications/connect_wait.png");
notification.tag = JOIN_FIND_AND_CONNECT_TAG;
addNotification(notification, WZ_Notification_Trigger::Immediate());
}
static bool isTrustedLobbyServer(const std::string& lobbyAddress, unsigned int lobbyPort)
{
return lobbyAddress == "lobby.wz2100.net";
}
static void joinGameFromSecret_v1(const std::string joinSecretStr)
{
std::vector<JoinConnectionDescription> joinConnectionDetails;
auto displayErrorNotification = [](const std::string& errorMessage){
debug(LOG_ERROR, "%s", errorMessage.c_str());
std::string contentText = _("Failed to join the game from the specified invite link, with error:");
contentText += "\n" + errorMessage;
WZ_Notification notification;
notification.duration = 0;
notification.contentTitle = _("Failed to Join Game");
notification.contentText = contentText;
notification.largeIcon = WZ_Notification_Image("images/notifications/exclamation_triangle.png");
notification.tag = std::string(JOIN_NOTIFICATION_TAG_PREFIX "failedtojoin");
addNotification(notification, WZ_Notification_Trigger::Immediate());
return;
};
std::vector<WzString> joinSecretComponents = WzString::fromUtf8(joinSecretStr).split("/");
if (joinSecretComponents.size() < 3) {
displayErrorNotification("Join code: Invalid format");
return;
}
if (joinSecretComponents[0] != "v1") {
displayErrorNotification("Join code: Invalid format version");
return;
}
auto convertStringToUint32 = [](const std::string& inputStr) -> unsigned int
{
unsigned int result = 0;
try {
unsigned long ulongValue = std::stoul(inputStr);
if (ulongValue > static_cast<unsigned long>(std::numeric_limits<unsigned int>::max()))
{
debug(LOG_WARNING, "Failed to convert string '%s' to unsigned int because of error: value is > std::numeric_limits<unsigned int>::max()", inputStr.c_str());
}
result = static_cast<uint32_t>(ulongValue);
}
catch (const std::exception &e) {
debug(LOG_WARNING, "Failed to convert string '%s' to unsigned int because of error: %s", inputStr.c_str(), e.what());
}
return result;
};
if (joinSecretComponents[1] == "l")
{
// lobby game
// format: "v1/l/<lobbyAddress>:<lobbyPort>/<lobbyGameId>"
if (joinSecretComponents.size() == 4)
{
std::vector<WzString> lobbyDetails = joinSecretComponents[2].split(":");
if (lobbyDetails.size() != 2)
{
displayErrorNotification(astringf("Join code: Invalid format for subcomponent - size: %zu", lobbyDetails.size()));
return;
}
std::string lobbyAddress = lobbyDetails[0].toUtf8();
unsigned int lobbyPort = convertStringToUint32(lobbyDetails[1].toUtf8());
uint32_t lobbyGameId = convertStringToUint32(joinSecretComponents[3].toUtf8());
if (lobbyGameId == 0)
{
// Invalid lobby gameId
displayErrorNotification(astringf("Join code: Invalid lobby gameId: %s", joinSecretComponents[3].toUtf8().c_str()));
return;
}
if (isTrustedLobbyServer(lobbyAddress, lobbyPort))
{
// trusted lobby servers can proceed directly to finding and joining the game
findAndJoinLobbyGameImpl(lobbyAddress, lobbyPort, lobbyGameId);
return;
}
else
{
// asynchronously prompt via notification system to trust lobby server before connecting
std::ostringstream content;
content << _("The invite link you have followed specifies a non-default lobby server:") << "\n";
content << " ⇢ " << lobbyAddress << " : " << lobbyPort << "\n";
content << "\n";
content << _("Do you wish to trust this lobby server, and continue?") << "\n";
WZ_Notification notification;
notification.duration = 0;
notification.contentTitle = _("Discord: Connect to Untrusted Lobby?");
notification.contentText = content.str();
notification.action = WZ_Notification_Action(_("Trust & Connect"), [lobbyAddress, lobbyPort, lobbyGameId](const WZ_Notification&){
wzAsyncExecOnMainThread([lobbyAddress, lobbyPort, lobbyGameId]{
findAndJoinLobbyGameImpl(lobbyAddress, lobbyPort, lobbyGameId);
});
});
notification.largeIcon = WZ_Notification_Image("images/notifications/shield_questionmark.png");
notification.tag = JOIN_NOTIFICATION_TAG_PREFIX "untrusted_lobby_server_prompt";
addNotification(notification, WZ_Notification_Trigger::Immediate());
return;
}
}
else
{
displayErrorNotification(astringf("Join code: Invalid number of components: %zu", joinSecretComponents.size()));
}
}
else if (joinSecretComponents[1] == "i")
{
// direct connection join code
// format: "v1/i/<uniqueGameStr>/<base64url-network-binary-format-ip-address>:<port>/..."
// for now, skip the uniqueGameStr
// joinSecretComponents[2]
for (size_t i = 3; i < joinSecretComponents.size(); i++)
{
// each component should be a "<base64url-network-binary-format-ip-address>:<port>" combo
std::vector<WzString> connectionDetails = joinSecretComponents[i].split(":");
if (connectionDetails.size() != 2)
{
// Invalid format
displayErrorNotification(astringf("Join code: Invalid format for subcomponent - size: %zu", connectionDetails.size()));
return;
}
std::vector<unsigned char> ipNetworkBinaryFormat = EmbeddedJSONSignature::b64Decode(b64UrlSafeTob64(connectionDetails[0].toUtf8()));
std::string ipAddressStr = ipv6_NetBinary_To_AddressString(ipNetworkBinaryFormat);
if (ipAddressStr.empty())
{
ipAddressStr = ipv4_NetBinary_To_AddressString(ipNetworkBinaryFormat);
}
if (ipAddressStr.empty())
{
// Invalid ip address binary format contents
displayErrorNotification("Join code: Invalid connecting IP address");
return;
}
uint32_t port = convertStringToUint32(connectionDetails[1].toUtf8());
if (port == 0)
{
// Invalid port provided
displayErrorNotification("Join code: Invalid connecting port");
return;
}
joinConnectionDetails.push_back(JoinConnectionDescription(ipAddressStr, port));
}
if (joinConnectionDetails.empty())
{
// no connection details provided...
displayErrorNotification("Join code: Missing connection details");
return;
}
// Prompt the user to permit direct connection join
std::ostringstream content;
content << _("The invite link you have followed specifies a direct connection.") << "\n";
content << _("It has not been vetted / verified by a lobby server.") << "\n";
content << "\n";
content << _("Do you wish to trust this direct connection invite?") << "\n";
WZ_Notification notification;
notification.duration = 0;
notification.contentTitle = _("Discord: Direct Connection Invite");
notification.contentText = content.str();
notification.action = WZ_Notification_Action(_("Trust & Connect"), [joinConnectionDetails](const WZ_Notification&){
wzAsyncExecOnMainThread([joinConnectionDetails]{
joinGameImpl(joinConnectionDetails);
});
});
notification.largeIcon = WZ_Notification_Image("images/notifications/user_questionmark.png");
notification.tag = JOIN_NOTIFICATION_TAG_PREFIX "direct_invite_prompt";
addNotification(notification, WZ_Notification_Trigger::Immediate());
}
}
// May complete asynchronously / prompt the user / etc
static void joinGameFromSecret(const std::string joinSecret)
{
if (joinSecret.rfind("v1/", 0) == 0)
{
// v1 join secret
joinGameFromSecret_v1(joinSecret);
return;
}
else
{
// unknown / unsupported join code version
std::string firstComponent;
size_t firstComponentEnd = joinSecret.find("/");
if (firstComponentEnd != std::string::npos)
{
firstComponent = joinSecret.substr(0, firstComponentEnd);
}
debug(LOG_ERROR, "Unsupported join code version: \"%s\"", firstComponent.c_str());
// Display a notification that a new version of WZ may be required
std::ostringstream content;
content << _("The invite link you have followed isn't supported by this version of Warzone 2100.") << "\n";
content << _("A newer version of Warzone 2100 may be required, if available.") << "\n";
WZ_Notification notification;
notification.duration = 0;
notification.contentTitle = _("Discord: Unsupported / Invalid Invite");
notification.contentText = content.str();
notification.tag = JOIN_NOTIFICATION_TAG_PREFIX "invite_unsupported_version_message";
addNotification(notification, WZ_Notification_Trigger::Immediate());
return;
}
}
// MARK: - DiscordRPCActivitySink
#define WZ_DISCORD_RICH_PRESENCE_UPDATE_TICKS 3 * GAME_TICKS_PER_SEC
class DiscordRPCActivitySink : public ActivitySink {
private:
struct DiscordRichPresence_Internal {
std::string state; /* max 128 bytes */
std::string details; /* max 128 bytes */
int64_t startTimestamp;
int64_t endTimestamp;
std::string largeImageKey; /* max 32 bytes */
std::string largeImageText; /* max 128 bytes */
std::string smallImageKey; /* max 32 bytes */
std::string smallImageText; /* max 128 bytes */
std::string partyId; /* max 128 bytes */
int partySize;
int partyMax;
std::string matchSecret; /* max 128 bytes */
std::string joinSecret; /* max 128 bytes */
std::string spectateSecret; /* max 128 bytes */
int8_t instance;
void clear() {
state.clear();
details.clear();
startTimestamp = 0;
endTimestamp = 0;
largeImageKey.clear();
largeImageText.clear();
smallImageKey.clear();
smallImageText.clear();
partyId.clear();
partySize = 0;
partyMax = 0;
matchSecret.clear();
joinSecret.clear();
spectateSecret.clear();
instance = 0;
}
};
DiscordRichPresence_Internal currentRichPresenceData;
uint32_t lastDiscordPresenceUpdate = 0;
bool queuedPresenceUpdate = false;
public:
DiscordRPCActivitySink()
{
setDiscordStatus_InMenus();
updateDiscordPresence();
}
// campaign games
virtual void startedCampaignMission(const std::string& campaign, const std::string& levelName) override
{
cancelOrDismissJoinNotifications();
int64_t oldStartTimestamp = currentRichPresenceData.startTimestamp;
currentRichPresenceData.clear();
currentRichPresenceData.state = _("Playing: Campaign");
currentRichPresenceData.details = campaign + " - " + levelName;
currentRichPresenceData.startTimestamp = (oldStartTimestamp != 0) ? oldStartTimestamp : currentDiscordTimestamp();
currentRichPresenceData.largeImageKey = "wz_icon";
currentRichPresenceData.smallImageKey = "campaign_sm";
updateDiscordPresence();
}
virtual void endedCampaignMission(const std::string& campaign, const std::string& levelName, GameEndReason result, END_GAME_STATS_DATA stats, bool cheatsUsed) override
{
if (result == GameEndReason::QUIT)
{
setDiscordStatus_InMenus();
updateDiscordPresence();
return;
}
currentRichPresenceData.endTimestamp = currentDiscordTimestamp();
updateDiscordPresence();
}
// challenges
virtual void startedChallenge(const std::string& challengeName) override
{
cancelOrDismissJoinNotifications();
currentRichPresenceData.clear();
currentRichPresenceData.state = _("Playing: Challenge");
currentRichPresenceData.details = std::string("\"") + challengeName + "\"";
currentRichPresenceData.startTimestamp = currentDiscordTimestamp();
currentRichPresenceData.largeImageKey = "wz_icon";
updateDiscordPresence();
}
virtual void endedChallenge(const std::string& challengeName, GameEndReason result, const END_GAME_STATS_DATA& stats, bool cheatsUsed) override
{
setDiscordStatus_InMenus();
updateDiscordPresence();
}
virtual void startedSkirmishGame(const SkirmishGameInfo& info) override
{
cancelOrDismissJoinNotifications();
currentRichPresenceData.clear();
std::string stateStr = _("Playing: Skirmish");
std::string teamDescription = ActivitySink::getTeamDescription(info);
if (!teamDescription.empty())
{
// TRANSLATORS: "%s" is a team description, ex. "2v2"
stateStr = std::string(astringf(_("Playing: %s Skirmish"), teamDescription.c_str()));
}
currentRichPresenceData.state = stateStr;
std::string details = std::string(_("Map:")) + " " + info.game.map;
if (info.numAIBotPlayers > 0)
{
details += std::string(" | ") + _("Bots:") + " " + std::to_string(info.numAIBotPlayers);
}
currentRichPresenceData.details = details;
currentRichPresenceData.startTimestamp = currentDiscordTimestamp();
currentRichPresenceData.largeImageKey = "wz_icon";
currentRichPresenceData.smallImageKey = "skirmish_sm";
updateDiscordPresence();
}
virtual void endedSkirmishGame(const SkirmishGameInfo& info, GameEndReason result, const END_GAME_STATS_DATA& stats) override
{
setDiscordStatus_InMenus();
updateDiscordPresence();
}
// multiplayer
virtual void hostingMultiplayerGame(const MultiplayerGameInfo& info) override;
virtual void joinedMultiplayerGame(const MultiplayerGameInfo& info) override
{
cancelOrDismissNotificationsWithTag(JOIN_FIND_AND_CONNECT_TAG);
currentRichPresenceData.clear();
currentRichPresenceData.state = _("In Multiplayer Lobby");
currentRichPresenceData.startTimestamp = currentDiscordTimestamp();
setBaseMultiplayerGameInfo(info);
updateDiscordPresence();
}
virtual void updateMultiplayerGameInfo(const MultiplayerGameInfo& info) override
{
setBaseMultiplayerGameInfo(info);
updateDiscordPresence();
}
virtual void leftMultiplayerGameLobby(bool wasHost, LOBBY_ERROR_TYPES type) override
{
setDiscordStatus_InMenus();
updateDiscordPresence();
}
virtual void startedMultiplayerGame(const MultiplayerGameInfo& info) override
{
cancelOrDismissJoinNotifications();
lastDismissedJoinRequestByUserId.clear();
currentRichPresenceData.endTimestamp = 0;
currentRichPresenceData.matchSecret.clear();
currentRichPresenceData.joinSecret.clear();
currentRichPresenceData.spectateSecret.clear();
currentRichPresenceData.state = _("In Multiplayer Game");
currentRichPresenceData.startTimestamp = currentDiscordTimestamp();
setBaseMultiplayerGameInfo(info);
updateDiscordPresence();
}
virtual void endedMultiplayerGame(const MultiplayerGameInfo& info, GameEndReason result, const END_GAME_STATS_DATA& stats) override
{
lastDismissedJoinRequestByUserId.clear();
setDiscordStatus_InMenus();
updateDiscordPresence();
}
public:
void processQueuedPresenceUpdate();
private:
void setJoinInformation(const ActivitySink::MultiplayerGameInfo& info, int64_t startTimestamp);
void setBaseMultiplayerGameInfo(const ActivitySink::MultiplayerGameInfo& info);
void cancelOrDismissJoinNotifications()
{
cancelOrDismissNotificationIfTag([](const std::string& tag) {
return (tag.rfind(JOIN_NOTIFICATION_TAG_PREFIX, 0) == 0);
});
}
void updateDiscordPresence();
void setDiscordStatus_InMenus();
int64_t currentDiscordTimestamp()
{
// NOTE: Only C++20+ guarantees that system_clock's epoch is the Unix epoch, but for earlier versions it's the case for almost all platforms.
int64_t secondsSinceUnixEpoch = std::chrono::duration_cast<std::chrono::seconds>(std::chrono::system_clock::now().time_since_epoch()).count();
return secondsSinceUnixEpoch;
}
};
static std::shared_ptr<DiscordRPCActivitySink> discordSink;
static std::string hashAndB64EncodePartyId(const std::string& rawPartyId)
{
std::vector<unsigned char> hash(crypto_generichash_BYTES, 0);
crypto_generichash(hash.data(), hash.size(),
reinterpret_cast<const unsigned char*>(rawPartyId.data()), rawPartyId.size(),
nullptr, 0);
return EmbeddedJSONSignature::b64Encode(hash);
}
// NOTE: Uses host byte order
std::vector<unsigned char> int64_tToUnsignedCharVector(int64_t value)
{
std::vector<unsigned char> result(sizeof(int64_t), '\0');
memcpy(result.data(), &value, sizeof(int64_t));
return result;
}
void DiscordRPCActivitySink::setJoinInformation(const ActivitySink::MultiplayerGameInfo& info, int64_t startTimestamp)
{
if (info.lobbyGameId != 0)
{
// construct a "lobby game" join secret
std::string lobbyAddressAndPort = info.lobbyAddress + ":" + std::to_string(info.lobbyPort);
// join secret must be <= 127 characters
// support a custom lobby + port if they are <= 64 chars long
if (lobbyAddressAndPort.size() > 64)
{
// lobby address is too long
debug(LOG_WARNING, "Lobby address exceeds maximum supported length for join code: %s", lobbyAddressAndPort.c_str());
return;
}
std::string joinSecretDetails = lobbyAddressAndPort + "/" + std::to_string(info.lobbyGameId);
std::string joinSecretStr = std::string("v1/l/") + joinSecretDetails;
currentRichPresenceData.joinSecret = joinSecretStr;
// construct a unique party id from the lobby address/port + lobbyGameId
std::string rawPartyId = std::to_string(info.lobbyGameId) + ":" + info.lobbyAddress + ":" + std::to_string(info.lobbyPort) + ":" + std::to_string(info.lobbyGameId);
currentRichPresenceData.partyId = hashAndB64EncodePartyId(rawPartyId);
return;
}
else
{
// no lobby id / connection
if (info.isHost)
{
// asynchronously try to determine the public ip address(es) for this host
// to construct a "direct connection" join secret
std::weak_ptr<DiscordRPCActivitySink> weakDiscordSink(discordSink);
const auto listeningInterfaces = info.listeningInterfaces;
getPublicIPAddress([weakDiscordSink, listeningInterfaces, startTimestamp](const std::string& ipv4Address, const std::string& ipv6Address, const std::vector<std::string>& errors) {
auto pSink = weakDiscordSink.lock();
if (!pSink)
{
return;
}
// Convert ip address strings to binary, in network-byte-order format, then base64-encode
// Append the port as a separate string component
std::string joinSecretDetails;
if (!ipv4Address.empty())
{
auto ipv4AddressBinaryForm = ipv4_AddressString_To_NetBinary(ipv4Address);
if (!ipv4AddressBinaryForm.empty())
{
joinSecretDetails += b64Tob64UrlSafe(EmbeddedJSONSignature::b64Encode(ipv4AddressBinaryForm));
joinSecretDetails += std::string(":") + std::to_string(listeningInterfaces.ipv4_port);
}
}
if (!ipv6Address.empty())
{
auto ipv6AddressBinaryForm = ipv6_AddressString_To_NetBinary(ipv6Address);
if (!ipv6AddressBinaryForm.empty())
{
if (!joinSecretDetails.empty())
{
joinSecretDetails += "/";
}
joinSecretDetails += b64Tob64UrlSafe(EmbeddedJSONSignature::b64Encode(ipv6AddressBinaryForm));
joinSecretDetails += std::string(":") + std::to_string(listeningInterfaces.ipv6_port);
}
}
if (joinSecretDetails.empty())
{
// no valid join details available - just exit
return;
}
// construct a unique code to distinguish multiple games that use the same direct connection details
// (particularly important for ensuring a unique partyId if hosting multiple successive games)
// for now, base64-encode startTimestamp
std::string uniqueGameStr = b64Tob64UrlSafe(EmbeddedJSONSignature::b64Encode(int64_tToUnsignedCharVector(startTimestamp)));
// construct "direct connection" join secret
std::string joinSecretStr = std::string("v1/i/") + uniqueGameStr + "/" + joinSecretDetails;
// construct a unique party id from the uniqueGameStr + ip addresses, hashed
std::string rawPartyId = std::string("direct_connection:") + uniqueGameStr + ":" + ipv4Address + ":" + std::to_string(listeningInterfaces.ipv4_port) + ":" + ipv6Address + ":" + std::to_string(listeningInterfaces.ipv6_port);
std::string partyIdStr = hashAndB64EncodePartyId(rawPartyId);
wzAsyncExecOnMainThread([pSink, joinSecretStr, partyIdStr](){
// Verify that game state is still "in lobby"
const auto currentGameMode = ActivityManager::instance().getCurrentGameMode();
if ((currentGameMode != ActivitySink::GameMode::HOSTING_IN_LOBBY) && (currentGameMode != ActivitySink::GameMode::JOINING_IN_LOBBY))
{
// game is no longer in lobby
return;
}
pSink->currentRichPresenceData.joinSecret = joinSecretStr;
pSink->currentRichPresenceData.partyId = partyIdStr;
// Trigger presence update
pSink->updateDiscordPresence();
});
}, info.listeningInterfaces.IPv4, info.listeningInterfaces.IPv6);
}
}
}
void DiscordRPCActivitySink::hostingMultiplayerGame(const MultiplayerGameInfo& info)
{
lastDismissedJoinRequestByUserId.clear();
currentRichPresenceData.clear();
currentRichPresenceData.state = _("In Multiplayer Lobby");
currentRichPresenceData.startTimestamp = currentDiscordTimestamp();
setJoinInformation(info, currentRichPresenceData.startTimestamp); // may set values asynchronously, if needed
setBaseMultiplayerGameInfo(info);
updateDiscordPresence();
}
void DiscordRPCActivitySink::setBaseMultiplayerGameInfo(const MultiplayerGameInfo& info)
{
std::string botsCountStr;
if (info.numAIBotPlayers > 0)
{
botsCountStr = std::string(" | ");
// TRANSLATORS: AI Bots. (Used to describe the number of bot players.)
// Should be a fairly short string - space is limited. Use an abbreviation / acronym if necessary.
botsCountStr += _("Bots:");
botsCountStr += " " + std::to_string(info.numAIBotPlayers);
}
// Truncate the map name to keep the details string < 128 chars
std::string details = truncateStringIfExceedsLength(std::string(_("Map:")) + " " + info.game.map, MAX_DISCORD_STR_LEN - botsCountStr.size());
details += botsCountStr;
currentRichPresenceData.details = details;
if (!info.privateGame)
{
currentRichPresenceData.largeImageKey = "wz_icon";
}
else
{
currentRichPresenceData.largeImageKey = "wz_icon_locked";
}
std::string hostNameStr = std::string("[") + truncateStringIfExceedsLength(info.hostName, MAX_DISCORD_STR_LEN / 2) + "]";
std::string nameAndHostStr = astringf(_("Game Name: \"%s\" by %s"), info.game.name, hostNameStr.c_str());
currentRichPresenceData.largeImageText = truncateStringIfExceedsLength(nameAndHostStr, MAX_DISCORD_STR_LEN);
const auto currentGameMode = ActivityManager::instance().getCurrentGameMode();
if (currentGameMode == ActivitySink::GameMode::MULTIPLAYER)
{
currentRichPresenceData.smallImageKey = "multiplayer_sm";
}
else
{
currentRichPresenceData.smallImageKey = "in_lobby_sm";
}
// Expanded Game Info
// 🔐 | No: Tanks,Cyborgs,VTOLs,Uplink,Lassat | T1P1B2 | Alliances: 🔒🔬 | WZ: 3.3.0
std::string gameInfoStr;
if (info.privateGame)
{
const std::string passwordEmoji = "\xf0\x9f\x94\x90"; // 🔐
gameInfoStr += passwordEmoji + " | ";
}
if (info.hasLimits())
{
std::vector<std::string> limits;
if (info.limit_no_tanks) ///< Flag for tanks disabled
{
limits.push_back("Tanks");
}
if (info.limit_no_cyborgs) ///< Flag for cyborgs disabled
{
limits.push_back("Cyborgs");
}
if (info.limit_no_vtols) ///< Flag for VTOLs disabled
{
limits.push_back("VTOLs");
}
if (info.limit_no_uplink) ///< Flag for Satellite Uplink disabled
{
limits.push_back("Uplink");
}
if (info.limit_no_lassat) ///< Flag for Laser Satellite Command Post disabled
{
limits.push_back("Lassat");
}
if (!limits.empty())
{
// TRANSLATORS: "No:" to signify limits - example usage: "No: Tanks,VTOLs"
// Should be a short string - space is limited. Use an abbreviation / symbol if necessary.
gameInfoStr += _("No:");
gameInfoStr += " ";
for (size_t i = 0; i < limits.size(); i++)
{
if (i > 0)
{
gameInfoStr += ",";
}
gameInfoStr += limits[i];
}
gameInfoStr += std::string(" | ");
}
}
gameInfoStr += "T" + std::to_string(info.game.techLevel) + "P" + std::to_string(info.game.power) + "B" + std::to_string(info.game.base);
gameInfoStr += std::string(" | ");
// TRANSLATORS: Should be a fairly short string - space is limited. Use an abbreviation if necessary.
gameInfoStr += _("Alliances:");
gameInfoStr += " " + getAllianceString(info);
if (gameInfoStr.size() < MAX_DISCORD_STR_LEN)
{
std::string versionStr = std::string(" | WZ:") + " " + version_getVersionString();
gameInfoStr += truncateStringIfExceedsLength(versionStr, MAX_DISCORD_STR_LEN - gameInfoStr.size()); // truncate version if too long;
}
currentRichPresenceData.smallImageText = truncateStringIfExceedsLength(gameInfoStr, MAX_DISCORD_STR_LEN); // Limits data, Version of WZ, etc
currentRichPresenceData.partySize = info.maxPlayers - info.numAvailableSlots;
currentRichPresenceData.partyMax = info.maxPlayers;
}
void DiscordRPCActivitySink::setDiscordStatus_InMenus()
{
currentRichPresenceData.clear();
currentRichPresenceData.state = _("In Menu");
currentRichPresenceData.largeImageKey = "wz_icon";
}
void DiscordRPCActivitySink::processQueuedPresenceUpdate()
{
if (!queuedPresenceUpdate) { return; }
if (realTime - lastDiscordPresenceUpdate >= WZ_DISCORD_RICH_PRESENCE_UPDATE_TICKS)
{
updateDiscordPresence();
}
}
void DiscordRPCActivitySink::updateDiscordPresence()
{
if (realTime - lastDiscordPresenceUpdate < WZ_DISCORD_RICH_PRESENCE_UPDATE_TICKS)
{
// throttle rich presence updates
queuedPresenceUpdate = true;
return;
}
if (presenceUpdatesEnabled)
{
DiscordRichPresence discordPresence;
memset(&discordPresence, 0, sizeof(discordPresence));
discordPresence.state = currentRichPresenceData.state.c_str(); /* max 128 bytes */
discordPresence.details = currentRichPresenceData.details.c_str(); /* max 128 bytes */
discordPresence.startTimestamp = currentRichPresenceData.startTimestamp;
discordPresence.endTimestamp = currentRichPresenceData.endTimestamp;
discordPresence.largeImageKey = currentRichPresenceData.largeImageKey.c_str(); /* max 32 bytes */
discordPresence.largeImageText = currentRichPresenceData.largeImageText.c_str(); /* max 128 bytes */
discordPresence.smallImageKey = currentRichPresenceData.smallImageKey.c_str(); /* max 32 bytes */
discordPresence.smallImageText = currentRichPresenceData.smallImageText.c_str(); /* max 128 bytes */
discordPresence.partyId = currentRichPresenceData.partyId.c_str(); /* max 128 bytes */
discordPresence.partySize = currentRichPresenceData.partySize;
discordPresence.partyMax = currentRichPresenceData.partyMax;
discordPresence.matchSecret = currentRichPresenceData.matchSecret.c_str(); /* max 128 bytes */
discordPresence.joinSecret = currentRichPresenceData.joinSecret.c_str(); /* max 128 bytes */
discordPresence.spectateSecret = currentRichPresenceData.spectateSecret.c_str(); /* max 128 bytes */
discordPresence.instance = currentRichPresenceData.instance;
Discord_UpdatePresence(&discordPresence);
}
else
{
Discord_ClearPresence();
}
queuedPresenceUpdate = false;
lastDiscordPresenceUpdate = realTime;
}
// MARK: - Discord Event Handlers
static void handleDiscordReady(const DiscordUser* connectedUser)
{
if (!connectedUser) { return; }
std::string userId = (connectedUser->userId) ? connectedUser->userId : "";
std::string username = (connectedUser->username) ? connectedUser->username : "";
std::string discriminator = (connectedUser->discriminator) ? connectedUser->discriminator : "";
debug(LOG_INFO, "Discord: connected to user %s#%s - %s", username.c_str(), discriminator.c_str(), userId.c_str());
}
static void handleDiscordDisconnected(int errcode, const char* message)
{
debug(LOG_INFO, "Discord: disconnected (%d: %s)", errcode, message);
}
static void handleDiscordError(int errcode, const char* message)
{
debug(LOG_ERROR, "Discord: error (%d: %s)", errcode, message);
}
static void handleDiscordJoin(const char* secret)