xash3d-fwgs/engine/common/masterlist.c

/*
masterlist.c - multi-master list
Copyright (C) 2018 mittorn

This program 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 3 of the License, 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.
*/
#include "common.h"
#include "netchan.h"
#include "net_ws.h"
#include "server.h"
#include "client.h"

typedef struct master_s
{
	struct master_s *next;
	qboolean sent; // TODO: get rid of this internal state
	qboolean save;
	qboolean v6only;
	qboolean gs;
	string address;
	netadr_t adr; // temporary, rewritten after each send

	uint heartbeat_challenge;
	double last_heartbeat;

	double resolve_time;
} master_t;

typedef struct masterstatic_s
{
	struct masterstatic_s *next;
	qboolean save;
	qboolean in_flight;
	char base[];
} masterstatic_t;

static struct masterlist_s
{
	master_t *head, *tail;
	masterstatic_t *static_head, *static_tail;
	qboolean modified;
} ml;

static CVAR_DEFINE_AUTO( sv_verbose_heartbeats, "0", 0, "print every heartbeat to console" );

#define HEARTBEAT_SECONDS               ((sv_nat.value > 0.0f) ? 60.0f : 300.0f) // 1 or 5 minutes
#define RESOLVE_EXPIRE_SECONDS          (60.0f)  // positive cache: 1 minute
#define NEGATIVE_RESOLVE_EXPIRE_SECONDS (300.0f) // negative cache: 5 minutes

static size_t NET_BuildMasterServerScanRequest( char *buf, size_t size, uint32_t key, qboolean nat, const char *filter, connprotocol_t proto )
{
	// TODO: pagination and region
	Q_strncpy( buf, A2M_SCAN_REQUEST, size );

	char *info = buf + sizeof( A2M_SCAN_REQUEST ) - 1;
	size_t remaining = size - sizeof( A2M_SCAN_REQUEST );

	Q_strncpy( info, filter, remaining );

	Info_SetValueForKey( info, "gamedir", GI->gamefolder, remaining );

	if( proto != PROTO_GOLDSRC )
	{
		char temp[32];

		// let master know about client version
		Info_SetValueForKey( info, "clver", XASH_VERSION, remaining );
		Info_SetValueForKey( info, "nat", nat ? "1" : "0", remaining );
		Info_SetValueForKey( info, "commit", g_buildcommit, remaining );
		Info_SetValueForKey( info, "branch", g_buildbranch, remaining );
		Info_SetValueForKey( info, "os", Q_buildos(), remaining );
		Info_SetValueForKey( info, "arch", Q_buildarch(), remaining );

		Q_snprintf( temp, sizeof( temp ), "%d", Q_buildnum() );
		Info_SetValueForKey( info, "buildnum", temp, remaining );

		Q_snprintf( temp, sizeof( temp ), "%x", key );
		Info_SetValueForKey( info, "key", temp, remaining );
	}

	return sizeof( A2M_SCAN_REQUEST ) + Q_strlen( info );
}

/*
========================
NET_GetMasterHostByName
========================
*/
static net_gai_state_t NET_GetMasterHostByName( master_t *m )
{
	if( host.realtime < m->resolve_time )
		return m->adr.type ? NET_EAI_OK : NET_EAI_NONAME;

	m->adr.type = 0;

	net_gai_state_t res = NET_StringToAdrNB( m->address, &m->adr, m->v6only );

	if( res == NET_EAI_OK )
	{
		m->resolve_time = host.realtime + RESOLVE_EXPIRE_SECONDS;
		return res;
	}

	if( res == NET_EAI_NONAME )
	{
		Con_Reportf( "Can't resolve adr: %s\n", m->address );
		m->resolve_time = host.realtime + NEGATIVE_RESOLVE_EXPIRE_SECONDS;
	}

	m->adr.type = 0;
	return res;
}

static void NET_ClearSendState( void )
{
	// reset sent state
	for( master_t *master = ml.head; master; master = master->next )
		master->sent = false;
}

/*
========================
NET_SendToMasters

Send request to all masterservers list
return true if would block
========================
*/
static qboolean NET_SendToMasters( netsrc_t sock, size_t len, const void *data, connprotocol_t proto )
{
	qboolean wait = false;

	for( master_t *master = ml.head; master; master = master->next )
	{
		if( master->gs )
		{
			if( proto != PROTO_GOLDSRC )
				continue;
		}
		else
		{
			if( proto != PROTO_CURRENT )
				continue;
		}

		if( master->sent )
			continue;

		switch( NET_GetMasterHostByName( master ))
		{
		case NET_EAI_AGAIN:
			master->sent = false;
			wait = true;
			break;
		case NET_EAI_NONAME:
			master->sent = true;
			break;
		case NET_EAI_OK:
			master->sent = true;
			NET_SendPacket( sock, len, data, master->adr );
			break;
		}
	}

	return wait;
}

/*
========================
NET_AnnounceToMaster

========================
*/
static void NET_AnnounceToMaster( master_t *m )
{
	sizebuf_t msg;
	char buf[16];

	m->heartbeat_challenge = COM_RandomLong( 0, INT_MAX );

	MSG_Init( &msg, "Master Join", buf, sizeof( buf ));
	MSG_WriteBytes( &msg, S2M_HEARTBEAT, 2 );
	MSG_WriteDword( &msg, m->heartbeat_challenge );

	NET_SendPacket( NS_SERVER, MSG_GetNumBytesWritten( &msg ), MSG_GetData( &msg ), m->adr );

	if( sv_verbose_heartbeats.value )
	{
		Con_Printf( S_NOTE "sent heartbeat to %s (%s, 0x%x)\n",
			m->address, NET_AdrToString( m->adr ), m->heartbeat_challenge );
	}
}

/*
========================
NET_AnnounceToMaster

========================
*/
void NET_MasterClear( void )
{
	for( master_t *m = ml.head; m; m = m->next )
		m->last_heartbeat = MAX_HEARTBEAT;
}

/*
========================
NET_QueryServerByAddress

========================
*/
void NET_QueryServerByAddress( netadr_t adr, connprotocol_t proto )
{
	if( proto == PROTO_GOLDSRC )
		Netchan_OutOfBand( NS_CLIENT, adr, sizeof( A2S_GOLDSRC_INFO ), (const byte *)A2S_GOLDSRC_INFO ); // includes null terminator
	else
		Netchan_OutOfBandPrint( NS_CLIENT, adr, A2A_INFO " %i", PROTOCOL_VERSION );
}

static int NET_ParseMasterStaticBody( const byte *body, size_t size )
{
	char line[1024];
	int offset = 0;
	int count = 0;

	while( Q_memfgets( (byte *)body, size, &offset, line, sizeof( line )) != NULL )
	{
		char token[MAX_TOKEN];
		char *pfile = line;
		qboolean gs;
		netadr_t adr = { 0 };

		pfile = COM_ParseFileSafe( pfile, token, sizeof( token ), PFILE_HASH_AS_COMMENT, NULL, NULL );
		if( !pfile || token[0] == '\0' )
			continue;

		if( !Q_strcmp( token, "ip" ))
			gs = false;
		else if( !Q_strcmp( token, "gs" ))
			gs = true;
		else
			continue;

		pfile = COM_ParseFileSafe( pfile, token, sizeof( token ), PFILE_HASH_AS_COMMENT, NULL, NULL );
		if( !pfile )
			continue;

		if( !NET_StringToAdr( token, &adr ))
		{
			Con_Reportf( S_WARN "masterstatic: can't parse address \"%s\"\n", token );
			continue;
		}

		if( adr.port == 0 )
			adr.port = MSG_BigShort( PORT_SERVER );

		NET_QueryServerByAddress( adr, gs );
		count++;
	}

	return count;
}

/*
========================
NET_MasterStaticResponse

========================
*/
static void NET_MasterStaticResponse( const char *url, qboolean success, const byte *data, size_t size, void *userdata )
{
	masterstatic_t *ms = (masterstatic_t *)userdata;

	if( ms )
		ms->in_flight = false;

	if( !success || !data || size == 0 )
	{
		Con_Reportf( "masterstatic: %s returned no data\n", url );
		return;
	}

	NET_Config( true, false ); // allow remote sends

	int count = NET_ParseMasterStaticBody( data, size );

	Con_Reportf( "masterstatic: %s yielded %d server(s)\n", url, count );

#if !XASH_DEDICATED
	CL_NotifyServerListResponse();
#endif
}

static void NET_MasterStaticQuery( void )
{
	const char *gamedir = GI ? GI->gamefolder : "valve";

	for( masterstatic_t *ms = ml.static_head; ms; ms = ms->next )
	{
		char url[1024];

		if( ms->in_flight )
			continue;

		Q_snprintf( url, sizeof( url ), "%s/v1/servers/%s", ms->base, gamedir );

		if( HTTP_GetToMemory( url, NET_MasterStaticResponse, ms ))
			ms->in_flight = true;
	}
}

/*
=================
NET_MasterQuery

=================
*/
qboolean NET_MasterQuery( uint32_t key, qboolean nat, const char *filter )
{
	char buf[512];
	size_t len = NET_BuildMasterServerScanRequest( buf, sizeof( buf ), key, nat, filter, PROTO_CURRENT );
	qboolean wait = NET_SendToMasters( NS_CLIENT, len, buf, PROTO_CURRENT );

	// goldsrc don't have nat traversal extensions
	if( !nat )
	{
		len = NET_BuildMasterServerScanRequest( buf, sizeof( buf ), 0, false, filter, PROTO_GOLDSRC );
		wait |= NET_SendToMasters( NS_CLIENT, len, buf, PROTO_GOLDSRC );
	}

	NET_MasterStaticQuery();

	if( !wait )
		NET_ClearSendState();

	return wait;
}

/*
========================
NET_MasterHeartbeat

========================
*/
void NET_MasterHeartbeat( void )
{
	if(( !public_server.value && !sv_nat.value ) || svs.maxclients == 1 )
		return; // only public servers send heartbeats

	if( Host_IsDedicated() && public_server.value )
	{
		static qboolean shown_serverlist_notice = false;

		if( !shown_serverlist_notice )
		{
			Con_Printf( "\n" );
			Con_Printf( "********************************************************************************\n" );
			Con_Printf( "*                                                                              *\n" );
			Con_Printf( "*  You set `public 1` on a dedicated server.                                   *\n" );
			Con_Printf( "*                                                                              *\n" );
			Con_Printf( "*  Legacy UDP master servers are deprecated. To make your server visible in    *\n" );
			Con_Printf( "*  the new HTTPS-based public server list, open a Pull Request to:             *\n" );
			Con_Printf( "*                                                                              *\n" );
			Con_Printf( "*      https://github.com/FWGS/server-list                                     *\n" );
			Con_Printf( "*                                                                              *\n" );
			Con_Printf( "********************************************************************************\n" );
			Con_Printf( "\n" );
			shown_serverlist_notice = true;
		}
	}

	for( master_t *m = ml.head; m; m = m->next )
	{
		if( host.realtime - m->last_heartbeat < HEARTBEAT_SECONDS )
			continue;

		if( m->gs )
			continue;

		switch( NET_GetMasterHostByName( m ))
		{
		case NET_EAI_AGAIN:
			m->last_heartbeat = MAX_HEARTBEAT; // retry on next frame
			if( sv_verbose_heartbeats.value )
				Con_Printf( S_NOTE "delay heartbeat to next frame until %s resolves\n", m->address );

			break;
		case NET_EAI_NONAME:
			m->last_heartbeat = host.realtime; // try to resolve again on next heartbeat
			break;
		case NET_EAI_OK:
			m->last_heartbeat = host.realtime;
			NET_AnnounceToMaster( m );
			break;
		}
	}
}

/*
=================
NET_MasterShutdown

Informs all masters that this server is going down
(ignored by master servers in current implementation)
=================
*/
void NET_MasterShutdown( void )
{
	NET_Config( true, false ); // allow remote
	while( NET_SendToMasters( NS_SERVER, 2, S2M_SHUTDOWN, PROTO_CURRENT ));
	NET_ClearSendState();
}


/*
========================
NET_GetMasterFromAdr

========================
*/
static master_t *NET_GetMasterFromAdr( netadr_t adr )
{
	for( master_t *master = ml.head; master; master = master->next )
	{
		if( NET_CompareAdr( adr, master->adr ))
			return master;
	}

	return NULL;
}


/*
========================
NET_GetMaster

========================
*/
qboolean NET_GetMaster( netadr_t from, uint *challenge, double *last_heartbeat )
{
	master_t *m = NET_GetMasterFromAdr( from );

	if( m )
	{
		*challenge = m->heartbeat_challenge;
		*last_heartbeat = m->last_heartbeat;
	}

	return m != NULL;
}

/*
========================
NET_IsMasterAdr

========================
*/
qboolean NET_IsMasterAdr( netadr_t adr, connprotocol_t *proto )
{
	master_t *master = NET_GetMasterFromAdr( adr );

	if( !master )
		return false;

	if( proto )
		*proto = master->gs ? PROTO_GOLDSRC : PROTO_CURRENT;

	return true;
}

/*
========================
NET_AddMaster

Add master to the list
========================
*/
static master_t *NET_AddMaster( const char *addr )
{
	for( master_t *master = ml.head; master; master = master->next )
	{
		if( !Q_stricmp( master->address, addr )) // already exists
			return master;
	}

	master_t *master = Mem_Calloc( host.mempool, sizeof( *master ));
	Q_strncpy( master->address, addr, sizeof( master->address ));

	if( ml.tail )
	{
		ml.tail->next = master;
		ml.tail = master;
	}
	else
	{
		ml.head = ml.tail = master;
	}

	return master;
}

static void NET_AddMaster_f( void )
{
	if( Cmd_Argc() != 2 && Cmd_Argc() != 3 )
	{
		Msg( S_USAGE "addmaster <address> [gs]\n");
		return;
	}

	master_t *master = NET_AddMaster( Cmd_Argv( 1 ));
	master->save = true;

	if( !Q_stricmp( Cmd_Argv( 2 ), "gs" ))
		master->gs = true;

	ml.modified = true; // save config
}

static masterstatic_t *NET_AddMasterStatic( const char *base )
{
	size_t base_len = Q_strlen( base );

	while( base_len > 0 && base[base_len - 1] == '/' )
		base_len--;

	if( base_len == 0 )
		return NULL;

	for( masterstatic_t *ms = ml.static_head; ms; ms = ms->next )
	{
		if( Q_strlen( ms->base ) == base_len && !Q_strnicmp( ms->base, base, base_len ))
			return ms;
	}

	masterstatic_t *ms = Mem_Calloc( host.mempool, sizeof( *ms ) + base_len + 1 );
	memcpy( ms->base, base, base_len );

	if( ml.static_tail )
	{
		ml.static_tail->next = ms;
		ml.static_tail = ms;
	}
	else
	{
		ml.static_head = ml.static_tail = ms;
	}

	return ms;
}

static void NET_AddMasterStatic_f( void )
{
	if( Cmd_Argc() != 2 )
	{
		Msg( S_USAGE "addmasterstatic <base-url>\n" );
		return;
	}

	masterstatic_t *ms = NET_AddMasterStatic( Cmd_Argv( 1 ));
	if( !ms )
		return;

	ms->save = true;
	ml.modified = true;
}

/*
========================
NET_ClearMasters

Clear master list
========================
*/
static void NET_ClearMasters_f( void )
{
	while( ml.head )
	{
		master_t *head = ml.head;
		ml.head = ml.head->next;
		Mem_Free( head );
	}

	ml.tail = NULL;

	while( ml.static_head )
	{
		masterstatic_t *head = ml.static_head;
		ml.static_head = ml.static_head->next;
		Mem_Free( head );
	}

	ml.static_tail = NULL;
}

/*
========================
NET_ListMasters_f

Display current master linked list
========================
*/
static void NET_ListMasters_f( void )
{
	Con_Printf( "Master servers:\n" );

	int i = 1;
	for( master_t *master = ml.head; master; i++, master = master->next )
	{
		Con_Printf( "%d\t%s", i, master->address );
		if( master->adr.type != 0 )
			Con_Printf( "\t%s", NET_AdrToString( master->adr ));

		if( master->gs )
			Con_Printf( " GoldSrc" );

		if( master->v6only )
			Con_Printf( " IPv6-only");

		Con_Printf( "\n" );
	}

	if( ml.static_head )
		Con_Printf( "Static master base URLs:\n" );

	i = 1;
	for( masterstatic_t *ms = ml.static_head; ms; i++, ms = ms->next )
		Con_Printf( "%d\t%s%s\n", i, ms->base, ms->in_flight ? " (in flight)" : "" );
}

/*
========================
NET_LoadMasters

Load master server list from xashcomm.lst
========================
*/
static void NET_LoadMasters( void )
{
	char token[MAX_TOKEN];
	byte *afile = FS_LoadFile( "xashcomm.lst", NULL, false );

	if( !afile ) // file doesn't exist yet
	{
		Con_Reportf( "Cannot load xashcomm.lst\n" );
		return;
	}

	char *pfile = (char*)afile;

	// format: master <addr>\n
	while(( pfile = COM_ParseFile( pfile, token, sizeof( token ))))
	{
		master_t *master = NULL;

		//if( !Q_strcmp( token, "clear" ))
		//	NET_ClearMasters_f();

		if( !Q_strcmp( token, "master" )) // load addr
		{
			pfile = COM_ParseFile( pfile, token, sizeof( token ));
			master = NET_AddMaster( token );
		}
		else if( !Q_strcmp( token, "master6" ))
		{
			pfile = COM_ParseFile( pfile, token, sizeof( token ));
			master = NET_AddMaster( token );
			master->v6only = true;
		}
		else if( !Q_strcmp( token, "mastergs" ))
		{
			pfile = COM_ParseFile( pfile, token, sizeof( token ));
			master = NET_AddMaster( token );
			master->gs = true;
		}
		else if( !Q_strcmp( token, "masterstatic" ))
		{
			pfile = COM_ParseFile( pfile, token, sizeof( token ));
			if( pfile )
			{
				masterstatic_t *ms = NET_AddMasterStatic( token );
				if( ms )
					ms->save = true;
			}
		}

		if( master )
			master->save = true;
	}

	Mem_Free( afile );

	ml.modified = false;
}

/*
========================
NET_SaveMasters

Save master server list to xashcomm.lst, except for default
========================
*/
void NET_SaveMasters( void )
{
	if( !ml.modified )
		return;

	file_t *f = FS_Open( "xashcomm.lst", "w", true );

	if( !f )
	{
		Con_Reportf( S_ERROR "Couldn't write xashcomm.lst\n" );
		return;
	}

	for( master_t *m = ml.head; m; m = m->next )
	{
		const char *key;

		if( !m->save )
			continue;

		if( m->v6only )
			key = "master6";
		else if( m->gs )
			key = "mastergs";
		else
			key = "master";

		FS_Printf( f, "%s %s\n", key, m->address );
	}

	for( masterstatic_t *ms = ml.static_head; ms; ms = ms->next )
	{
		if( !ms->save )
			continue;

		FS_Printf( f, "masterstatic \"%s\"\n", ms->base );
	}

	FS_Close( f );
}

/*
========================
NET_InitMasters

Initialize master server list
========================
*/
void NET_InitMasters( void )
{
	Cmd_AddRestrictedCommand( "addmaster", NET_AddMaster_f, "add address to masterserver list" );
	Cmd_AddRestrictedCommand( "addmasterstatic", NET_AddMasterStatic_f, "add static HTTP masterserver base URL" );
	Cmd_AddRestrictedCommand( "clearmasters", NET_ClearMasters_f, "clear masterserver list" );
	Cmd_AddCommand( "listmasters", NET_ListMasters_f, "list masterservers" );

	Cvar_RegisterVariable( &sv_verbose_heartbeats );

#if 0
	NET_AddMasterStatic( "http://meltdown.lan/test" );
#endif
	// NOTE: do not use fwgs.github.io for GitHub pages
	// because org-wide URL is xash.su (for legacy reasons)
	NET_AddMasterStatic( "http://xash.su/server-list" );
	// FIXME: https raw.githubcontent source
	// FIXME: cloudflare'd sources both HTTP and HTTPS

	NET_LoadMasters();
}