RetroArch/network/discord.c
Cthulhu-throwaway 690c802921
Netplay Stuff (#13375)
* Netplay Stuff

## PROTOCOL FALLBACK
In order to support older clients a protocol fallback system was introduced.
The host will no longer send its header automatically after a TCP connection is established, instead, it awaits for the client to send his before determining which protocol this connection is going to operate on.
Netplay has now two protocols, a low protocol and a high protocol; the low protocol is the minimum protocol it supports, while the high protocol is the highest protocol it can operate on.
To fully support older clients, a hack was necessary: sending the high protocol in the unused client's header salt field, while keeping the protocol field to the low protocol. Without this hack we would only be able to support older clients if a newer client was the host.
Any future system can make use of this system by checking connection->netplay_protocol, which is available for both the client and host.

## NETPLAY CHAT
Starting with protocol 6, netplay chat is available through the new NETPLAY_CMD_PLAYER_CHAT command.
Limitations of the command code, which causes a disconnection on unknown commands, makes this system not possible on protocol 5.
Protocol 5 connections can neither send nor receive chat, but other netplay operations are unaffected.
Clients send chat as a string to the server, and it's the server's sole responsability to relay chat messages.
As of now, sending chat uses RetroArch's input menu, while the display of on-screen chat uses a widget overlay and RetroArch's notifications as a fallback.
If a new overlay and/or input system is desired, no backwards compatibility changes need to be made.
Only clients in playing mode (as opposed to spectating mode) can send and receive chat.

## SETTINGS SHARING
Some settings are better used when both host and clients share the same configuration.
As of protocol 6, the following settings will be shared from host to clients (without altering a client's configuration file): input latency frames and allow pausing.

## NETPLAY TUNNEL/MITM
With the current MITM system being defunct (at least as of 1.9.X), a new system was in order to solve most if not all of the problems with the current system.
This new system uses a tunneling approach, which is similar to most VPN and tunneling services around.

Tunnel commands:
RATS[unique id] (RetroArch Tunnel Session) - 16 bytes -> When this command is sent with a zeroed unique id, the tunnel server interprets this as a netplay host wanting to create a new session, in this case, the same command is returned to the host, but now with its unique session id. When a client needs to connect to a host, this command is sent with the unique session id of the host, causing the tunnel server to send a RATL command to the host.
RATL[unique id] (RetroArch Tunnel Link) - 16 bytes -> The tunnel server sends this command to the host when a client wants to connect to the host. Once the host receives this command, it establishes a new connection to the tunnel server, sending this command together with the client's unique id through this new connection, causing the tunnel server to link this connection to the connection of the client.
RATP (RetroArch Tunnel Ping) - 4 bytes -> The tunnel server sends this command to verify that the host, whom the session belongs to, is still around. The host replies with the same command. A session is closed if the tunnel server can not verify that the host is alive.

Operations:
Host -> Instead of listening and accepting connections, it connects to the tunnel server, requests a new session and then monitor this connection for new linking requests. Once a request is received, it establishes a new connection to the tunnel server for linking with a client. The tunnel server's address and port are obtained by querying the lobby server. The host will publish its session id together with the rest of its info to the lobby server.
Client -> It connects to the tunnel server and then sends the session id of the host it wants to connect to. A host's session id is obtained from the json data sent by the lobby server.

Improvements (from current MITM system):
No longer a risk of TCP port exhaustion; we only use one port now at the tunnel server.
Very little cpu usage. About 95% net I/O bound now.
Future backwards compatible with any and all changes to netplay as it no longer runs any netplay logic at MITM servers.
No longer operates the host in client mode, which was a source of many of the current problems.
Cleaner and more maintainable system and code.

Notable functions:
netplay_mitm_query -> Grabs the tunnel's address and port from the lobby server.
init_tcp_socket -> Handles the creation and operation mode of the TCP socket based on whether it's host, host+MITM or client.
handle_mitm_connection -> Creates and completes linking connections and replies to ping commands (only 1 of each per call to not affect performance).

## MISC
Ping Limiter: If a client's estimated latency to the server is higher than this value, connection will be dropped just before finishing the netplay handshake.
Ping Counter: A ping counter (similar to the FPS one) can be shown in the bottom right corner of the screen, if you are connected to a host.
LAN Discovery: Refactored and moved to its own "Refresh Netplay LAN List" button.

## FIXES
Many minor fixes to the current netplay implementation are also included.

* Remove NETPLAY_TEST_BUILD
2021-12-19 16:58:01 +01:00

484 lines
16 KiB
C
Raw Blame History

/* RetroArch - A frontend for libretro.
* Copyright (C) 2011-2021 - Daniel De Matteis
* Copyright (C) 2016-2019 - Andr<64>s Su<53>rez
*
* RetroArch 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 Found-
* ation, either version 3 of the License, or (at your option) any later version.
*
* RetroArch 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 RetroArch.
* If not, see <http://www.gnu.org/licenses/>.
*/
#include <retro_miscellaneous.h>
#include <file/file_path.h>
#include <string/stdstring.h>
#include <net/net_http.h>
#include <features/features_cpu.h>
#include <time/rtime.h>
#ifdef HAVE_CHEEVOS
#include "../cheevos/cheevos.h"
#endif
#ifdef HAVE_NETWORKING
#include "netplay/netplay.h"
#endif
#include "../paths.h"
#include "../file_path_special.h"
#include "../tasks/tasks_internal.h"
#include "../tasks/task_file_transfer.h"
#ifdef HAVE_MENU
#include "../menu/menu_cbs.h"
#include "../menu/menu_driver.h"
#endif
#include "discord.h"
#define CDN_URL "https://cdn.discordapp.com/avatars"
/* Forward declaration */
#if defined(__cplusplus) && !defined(CXX_BUILD)
extern "C"
{
#endif
void Discord_Register(const char *a, const char *b);
#if defined(__cplusplus) && !defined(CXX_BUILD)
}
#endif
static discord_state_t discord_state_st; /* int64_t alignment */
discord_state_t *discord_state_get_ptr(void)
{
return &discord_state_st;
}
bool discord_is_ready(void)
{
discord_state_t *discord_st = &discord_state_st;
return discord_st->ready;
}
char *discord_get_own_username(void)
{
discord_state_t *discord_st = &discord_state_st;
if (discord_st->ready)
return discord_st->user_name;
return NULL;
}
char *discord_get_own_avatar(void)
{
discord_state_t *discord_st = &discord_state_st;
if (discord_st->ready)
return discord_st->user_avatar;
return NULL;
}
bool discord_avatar_is_ready(void)
{
return false;
}
void discord_avatar_set_ready(bool ready)
{
discord_state_t *discord_st = &discord_state_st;
discord_st->avatar_ready = ready;
}
#ifdef HAVE_MENU
static bool discord_download_avatar(
discord_state_t *discord_st,
const char* user_id, const char* avatar_id)
{
static char url[PATH_MAX_LENGTH];
static char url_encoded[PATH_MAX_LENGTH];
static char full_path[PATH_MAX_LENGTH];
static char buf[PATH_MAX_LENGTH];
file_transfer_t *transf = NULL;
fill_pathname_application_special(buf,
sizeof(buf),
APPLICATION_SPECIAL_DIRECTORY_THUMBNAILS_DISCORD_AVATARS);
fill_pathname_join(full_path, buf, avatar_id, sizeof(full_path));
strlcpy(discord_st->user_avatar,
avatar_id, sizeof(discord_st->user_avatar));
if (path_is_valid(full_path))
return true;
if (string_is_empty(avatar_id))
return false;
snprintf(url, sizeof(url), "%s/%s/%s" FILE_PATH_PNG_EXTENSION, CDN_URL, user_id, avatar_id);
net_http_urlencode_full(url_encoded, url, sizeof(url_encoded));
snprintf(buf, sizeof(buf), "%s" FILE_PATH_PNG_EXTENSION, avatar_id);
transf = (file_transfer_t*)malloc(sizeof(*transf));
transf->enum_idx = MENU_ENUM_LABEL_CB_DISCORD_AVATAR;
strlcpy(transf->path, buf, sizeof(transf->path));
transf->user_data = NULL;
task_push_http_transfer_file(url_encoded, true, NULL, cb_generic_download, transf);
return false;
}
#endif
static void handle_discord_ready(const DiscordUser* connectedUser)
{
discord_state_t *discord_st = &discord_state_st;
strlcpy(discord_st->user_name,
connectedUser->username, sizeof(discord_st->user_name));
#ifdef HAVE_MENU
discord_download_avatar(discord_st,
connectedUser->userId, connectedUser->avatar);
#endif
}
static void handle_discord_disconnected(int errcode, const char* message)
{
}
static void handle_discord_error(int errcode, const char* message)
{
}
static void handle_discord_join_cb(retro_task_t *task,
void *task_data, void *user_data, const char *err)
{
char join_hostname[PATH_MAX_LENGTH];
struct netplay_room *room = NULL;
http_transfer_data_t *data = (http_transfer_data_t*)task_data;
discord_state_t *discord_st = &discord_state_st;
if (!data || err || !data->data || !data->len)
goto finish;
data->data = (char*)realloc(data->data, data->len + 1);
data->data[data->len] = '\0';
netplay_rooms_parse(data->data);
room = netplay_room_get(0);
if (room)
{
if (room->host_method == NETPLAY_HOST_METHOD_MITM)
snprintf(join_hostname, sizeof(join_hostname), "%s|%d|%s",
room->mitm_address, room->mitm_port, room->mitm_session);
else
snprintf(join_hostname, sizeof(join_hostname), "%s|%d",
room->address, room->port);
if (netplay_driver_ctl(RARCH_NETPLAY_CTL_IS_DATA_INITED, NULL))
deinit_netplay();
netplay_driver_ctl(RARCH_NETPLAY_CTL_ENABLE_CLIENT, NULL);
task_push_netplay_crc_scan(room->gamecrc,
room->gamename, join_hostname, room->corename, room->subsystem_name);
discord_st->connecting = true;
if (discord_st->ready)
discord_update(DISCORD_PRESENCE_NETPLAY_CLIENT);
}
finish:
if (user_data)
free(user_data);
}
static void handle_discord_join(const char* secret)
{
char url[2048];
struct string_list *list = string_split(secret, "|");
discord_state_t *discord_st = &discord_state_st;
strlcpy(discord_st->peer_party_id,
list->elems[0].data, sizeof(discord_st->peer_party_id));
snprintf(url, sizeof(url), FILE_PATH_LOBBY_LIBRETRO_URL "%s/",
discord_st->peer_party_id);
task_push_http_transfer(url, true, NULL, handle_discord_join_cb, NULL);
}
static void handle_discord_spectate(const char* secret)
{
}
#ifdef HAVE_MENU
#if 0
static void handle_discord_join_response(void *ignore, const char *line)
{
/* TODO/FIXME: needs in-game widgets */
if (strstr(line, "yes"))
Discord_Respond(user_id, DISCORD_REPLY_YES);
#ifdef HAVE_MENU
menu_input_dialog_end();
retroarch_menu_running_finished(false);
#endif
}
#endif
#endif
static void handle_discord_join_request(const DiscordUser* request)
{
#ifdef HAVE_MENU
#if 0
char buf[PATH_MAX_LENGTH];
menu_input_ctx_line_t line;
#endif
discord_state_t *discord_st = &discord_state_st;
discord_download_avatar(discord_st, request->userId, request->avatar);
#if 0
/* TODO/FIXME: Needs in-game widgets */
retroarch_menu_running();
memset(&line, 0, sizeof(line));
snprintf(buf, sizeof(buf), "%s %s?",
msg_hash_to_str(MSG_DISCORD_CONNECTION_REQUEST), request->username);
line.label = buf;
line.label_setting = "no_setting";
line.cb = handle_discord_join_response;
/* TODO/FIXME: needs in-game widgets
* TODO/FIXME: bespoke dialog, should show while in-game
* and have a hotkey to accept
* TODO/FIXME: show avatar of the user connecting
*/
if (!menu_input_dialog_start(&line))
return;
#endif
#endif
}
void discord_update(enum discord_presence presence)
{
discord_state_t *discord_st = &discord_state_st;
#ifdef HAVE_CHEEVOS
char cheevos_richpresence[256];
#endif
if (presence == discord_st->status)
return;
if (!discord_st->connecting
&&
( presence == DISCORD_PRESENCE_NONE
|| presence == DISCORD_PRESENCE_MENU))
{
memset(&discord_st->presence,
0, sizeof(discord_st->presence));
discord_st->peer_party_id[0] = '\0';
}
switch (presence)
{
case DISCORD_PRESENCE_MENU:
discord_st->presence.details = msg_hash_to_str(
MENU_ENUM_LABEL_VALUE_DISCORD_IN_MENU);
discord_st->presence.largeImageKey = "base";
discord_st->presence.largeImageText = msg_hash_to_str(
MENU_ENUM_LABEL_VALUE_NO_CORE);
discord_st->presence.instance = 0;
break;
case DISCORD_PRESENCE_GAME_PAUSED:
discord_st->presence.smallImageKey = "paused";
discord_st->presence.smallImageText = msg_hash_to_str(
MENU_ENUM_LABEL_VALUE_DISCORD_STATUS_PAUSED);
discord_st->presence.details = msg_hash_to_str(
MENU_ENUM_LABEL_VALUE_DISCORD_IN_GAME_PAUSED);
discord_st->pause_time = time(0);
discord_st->elapsed_time = difftime(discord_st->pause_time,
discord_st->start_time);
discord_st->presence.startTimestamp = discord_st->pause_time;
break;
case DISCORD_PRESENCE_GAME:
{
core_info_t *core_info = NULL;
core_info_get_current_core(&core_info);
if (core_info)
{
const char *system_id =
core_info->system_id
? core_info->system_id
: "core";
const char *label = NULL;
const struct playlist_entry *entry = NULL;
playlist_t *current_playlist = playlist_get_cached();
if (current_playlist)
{
playlist_get_index_by_path(
current_playlist,
path_get(RARCH_PATH_CONTENT),
&entry);
if (entry && !string_is_empty(entry->label))
label = entry->label;
}
if (!label)
label = path_basename(path_get(RARCH_PATH_BASENAME));
discord_st->presence.largeImageKey = system_id;
if (core_info->display_name)
discord_st->presence.largeImageText =
core_info->display_name;
discord_st->start_time = time(0);
if (discord_st->pause_time != 0)
discord_st->start_time = time(0) -
discord_st->elapsed_time;
discord_st->pause_time = 0;
discord_st->elapsed_time = 0;
discord_st->presence.smallImageKey = "playing";
discord_st->presence.smallImageText = msg_hash_to_str(
MENU_ENUM_LABEL_VALUE_DISCORD_STATUS_PLAYING);
discord_st->presence.startTimestamp = discord_st->start_time;
#ifdef HAVE_CHEEVOS
if (rcheevos_get_richpresence(cheevos_richpresence, sizeof(cheevos_richpresence)) > 0)
discord_st->presence.details = cheevos_richpresence;
else
#endif
discord_st->presence.details = msg_hash_to_str(
MENU_ENUM_LABEL_VALUE_DISCORD_IN_GAME);
discord_st->presence.state = label;
discord_st->presence.instance = 0;
if (!netplay_driver_ctl(RARCH_NETPLAY_CTL_IS_ENABLED, NULL))
{
discord_st->peer_party_id[0] = '\0';
discord_st->connecting = false;
discord_st->presence.partyId = NULL;
discord_st->presence.partyMax = 0;
discord_st->presence.partySize = 0;
discord_st->presence.joinSecret = (const char*)'\0';
}
}
}
break;
case DISCORD_PRESENCE_NETPLAY_HOSTING:
{
char join_secret[128];
struct netplay_room *room = &networking_state_get_ptr()->host_room;
if (room->id == 0)
return;
snprintf(discord_st->self_party_id,
sizeof(discord_st->self_party_id), "%d", room->id);
snprintf(join_secret,
sizeof(join_secret), "%d|%" PRId64,
room->id, cpu_features_get_time_usec());
discord_st->presence.joinSecret = strdup(join_secret);
#if 0
discord_st->presence.spectateSecret = "SPECSPECSPEC";
#endif
discord_st->presence.partyId = strdup(discord_st->self_party_id);
discord_st->presence.partyMax = 2;
discord_st->presence.partySize = 1;
}
break;
case DISCORD_PRESENCE_NETPLAY_CLIENT:
discord_st->presence.partyId = strdup(discord_st->peer_party_id);
break;
case DISCORD_PRESENCE_NETPLAY_NETPLAY_STOPPED:
{
if (!netplay_driver_ctl(RARCH_NETPLAY_CTL_IS_ENABLED, NULL) &&
!netplay_driver_ctl(RARCH_NETPLAY_CTL_IS_CONNECTED, NULL))
{
discord_st->peer_party_id[0] = '\0';
discord_st->connecting = false;
discord_st->presence.partyId = NULL;
discord_st->presence.partyMax = 0;
discord_st->presence.partySize = 0;
discord_st->presence.joinSecret = (const char*)'\0';
}
}
break;
#ifdef HAVE_CHEEVOS
case DISCORD_PRESENCE_RETROACHIEVEMENTS:
if (discord_st->pause_time)
return;
if (rcheevos_get_richpresence(cheevos_richpresence, sizeof(cheevos_richpresence)) > 0)
discord_st->presence.details = cheevos_richpresence;
presence = DISCORD_PRESENCE_GAME;
break;
#endif
case DISCORD_PRESENCE_SHUTDOWN:
discord_st->presence.partyId = NULL;
discord_st->presence.partyMax = 0;
discord_st->presence.partySize = 0;
discord_st->presence.joinSecret = (const char*)'\0';
discord_st->connecting = false;
default:
break;
}
Discord_UpdatePresence(&discord_st->presence);
#ifdef DISCORD_DISABLE_IO_THREAD
Discord_UpdateConnection();
#endif
discord_st->status = presence;
}
void discord_init(const char *discord_app_id, char *args)
{
DiscordEventHandlers handlers;
#ifdef _WIN32
char full_path[PATH_MAX_LENGTH];
#endif
char command[PATH_MAX_LENGTH];
discord_state_t *discord_st = &discord_state_st;
discord_st->start_time = time(0);
handlers.ready = handle_discord_ready;
handlers.disconnected = handle_discord_disconnected;
handlers.errored = handle_discord_error;
handlers.joinGame = handle_discord_join;
handlers.spectateGame = handle_discord_spectate;
handlers.joinRequest = handle_discord_join_request;
Discord_Initialize(discord_app_id, &handlers, 0, NULL);
#ifdef DISCORD_DISABLE_IO_THREAD
Discord_UpdateConnection();
#endif
#ifdef _WIN32
fill_pathname_application_path(full_path, sizeof(full_path));
if (strstr(args, full_path))
strlcpy(command, args, sizeof(command));
else
{
path_basedir(full_path);
strlcpy(command, full_path, sizeof(command));
strlcat(command, args, sizeof(command));
}
#else
strcpy_literal(command, "sh -c ");
strlcat(command, args, sizeof(command));
#endif
Discord_Register(discord_app_id, command);
#ifdef DISCORD_DISABLE_IO_THREAD
Discord_UpdateConnection();
#endif
discord_st->ready = true;
}