Slight cleanup of CL_GetServerCommand

* Check the accesses to the args more
* Comments to explain what it actually does
* Make a recursive function instead of an unnecessary goto

Author: Kangz

src/engine/client/cl_cgame.cpp

@@ -329,159 +329,157 @@ void CL_ConfigstringModified( Cmd::Args& csCmd )
 
 /*
 ===================
+CL_HandleServerCommand
 CL_GetServerCommand
-
-Set up argc/argv for the given command
 ===================
 */
-qboolean CL_GetServerCommand( int serverCommandNumber )
-{
-	const char  *s;
-	const char  *cmd;
+bool CL_HandleServerCommand(Str::StringRef text) {
 	static char bigConfigString[ BIG_INFO_STRING ];
-	int         argc;
-
-	// if we have irretrievably lost a reliable command, drop the connection
-	if ( serverCommandNumber <= clc.serverCommandSequence - MAX_RELIABLE_COMMANDS )
-	{
-		// when a demo record was started after the client got a whole bunch of
-		// reliable commands then the client never got those first reliable commands
-		if ( clc.demoplaying )
-		{
-			return qfalse;
-		}
-
-		Com_Error( ERR_DROP, "CL_GetServerCommand: a reliable command was cycled out" );
-	}
-
-	if ( serverCommandNumber > clc.serverCommandSequence )
-	{
-		Com_Error( ERR_DROP, "CL_GetServerCommand: requested a command not received" );
-	}
-
-	s = clc.serverCommands[ serverCommandNumber & ( MAX_RELIABLE_COMMANDS - 1 ) ];
-	clc.lastExecutedServerCommand = serverCommandNumber;
-
-	if ( cl_showServerCommands->integer )
-	{
-		// NERVE - SMF
-		Com_Printf( "serverCommand: %i : %s\n", serverCommandNumber, s );
-	}
-
-rescan:
-	Cmd_TokenizeString( s );
-	Cmd::Args args(s);
+	Cmd::Args args(text);
 
 	if (args.Argc() == 0) {
 		return qfalse;
 	}
 
-	cmd = args[0].c_str();
-	argc = args.size();
+	auto cmd = args.Argv(0);
+	int argc = args.Argc();
 
-	if ( !strcmp( cmd, "disconnect" ) )
-	{
+	if (cmd == "disconnect") {
 		// NERVE - SMF - allow server to indicate why they were disconnected
-		if ( argc >= 2 )
-		{
-			Com_Error( ERR_SERVERDISCONNECT, "Server disconnected: %s", args[1].c_str() );
-		}
-		else
-		{
-			Com_Error( ERR_SERVERDISCONNECT, "Server disconnected" );
+		if (argc >= 2) {
+			Com_Error(ERR_SERVERDISCONNECT, "Server disconnected: %s", args.Argv(1).c_str());
+		} else {
+			Com_Error(ERR_SERVERDISCONNECT, "Server disconnected");
 		}
 	}
 
-	if ( !strcmp( cmd, "bcs0" ) )
-	{
-		Com_sprintf( bigConfigString, BIG_INFO_STRING, "cs %s %s", args[1].c_str(), Cmd_QuoteString( args[2].c_str() ) );
+	// bcs0 to bcs2 are used by the server to send info strings that are bigger than the size of a packet.
+	// See also SV_UpdateConfigStrings
+	// bcs0 starts a new big config string
+	// bcs1 continues it
+	// bcs2 finishes it and feeds it back as a new command sent by the server (bcs0 makes it a cs command)
+	if (cmd == "bcs0") {
+		if (argc >= 3) {
+			Com_sprintf(bigConfigString, BIG_INFO_STRING, "cs %s %s", args.Argv(1).c_str(), args.EscapedArgs(2).c_str());
+		}
 		return qfalse;
 	}
 
-	if ( !strcmp( cmd, "bcs1" ) )
-	{
-		s = Cmd_QuoteString( args[2].c_str() );
+	if (cmd == "bcs1") {
+		if (argc >= 3) {
+			const char* s = Cmd_QuoteString( args[2].c_str() );
 
-		if ( strlen( bigConfigString ) + strlen( s ) >= BIG_INFO_STRING )
-		{
-			Com_Error( ERR_DROP, "bcs exceeded BIG_INFO_STRING" );
-		}
+			if (strlen(bigConfigString) + strlen(s) >= BIG_INFO_STRING) {
+				Com_Error(ERR_DROP, "bcs exceeded BIG_INFO_STRING");
+			}
 
-		Q_strcat( bigConfigString, sizeof( bigConfigString ), s );
+			Q_strcat(bigConfigString, sizeof(bigConfigString), s);
+		}
 		return qfalse;
 	}
 
-	if ( !strcmp( cmd, "bcs2" ) )
-	{
-		s = Cmd_QuoteString( args[2].c_str() );
+	if (cmd == "bcs2") {
+		if (argc >= 3) {
+			const char* s = Cmd_QuoteString( args[2].c_str() );
 
-		if ( strlen( bigConfigString ) + strlen( s ) + 1 >= BIG_INFO_STRING )
-		{
-			Com_Error( ERR_DROP, "bcs exceeded BIG_INFO_STRING" );
-		}
+			if (strlen(bigConfigString) + strlen(s) + 1 >= BIG_INFO_STRING) {
+				Com_Error(ERR_DROP, "bcs exceeded BIG_INFO_STRING");
+			}
 
-		Q_strcat( bigConfigString, sizeof( bigConfigString ), s );
-		Q_strcat( bigConfigString, sizeof( bigConfigString ), "\"" );
-		s = bigConfigString;
-		goto rescan;
+			Q_strcat(bigConfigString, sizeof(bigConfigString), s);
+			Q_strcat(bigConfigString, sizeof(bigConfigString), "\"");
+			return CL_HandleServerCommand(bigConfigString);
+		}
+		return qfalse;
 	}
 
-	if ( !strcmp( cmd, "cs" ) )
-	{
+	if (cmd == "cs") {
 		CL_ConfigstringModified(args);
-		Cmd_TokenizeString( s );
+		Cmd_TokenizeString(text.c_str());
 		return qtrue;
 	}
 
-	if ( !strcmp( cmd, "map_restart" ) )
-	{
+	if (cmd == "map_restart") {
 		// clear outgoing commands before passing
 		// the restart to the cgame
-		memset( cl.cmds, 0, sizeof( cl.cmds ) );
+		memset(cl.cmds, 0, sizeof(cl.cmds));
+		Cmd_TokenizeString(text.c_str());
 		return qtrue;
 	}
 
-	if ( !strcmp( cmd, "popup" ) )
-	{
+	if (cmd == "popup") {
 		// direct server to client popup request, bypassing cgame
-		if ( cls.state == CA_ACTIVE && !clc.demoplaying )
-		{
-			Rocket_DocumentAction( Cmd_Argv(1), "open" );
+		if (cls.state == CA_ACTIVE && !clc.demoplaying && argc >=1) {
+			Rocket_DocumentAction(args.Argv(1).c_str(), "open");
 		}
 		return qfalse;
 	}
 
-	if ( !strcmp( cmd, "pubkey_decrypt" ) )
-	{
+	if (cmd == "pubkey_decrypt") {
 		char         buffer[ MAX_STRING_CHARS ] = "pubkey_identify ";
 		unsigned int msg_len = MAX_STRING_CHARS - 16;
 		mpz_t        message;
 
-		if ( argc == 1 )
-		{
-			Com_Printf("%s", _( "^3Server sent a pubkey_decrypt command, but sent nothing to decrypt!\n" ));
+		if (argc == 1) {
+			Com_Printf("%s", _("^3Server sent a pubkey_decrypt command, but sent nothing to decrypt!\n"));
 			return qfalse;
 		}
 
-		mpz_init_set_str( message, Cmd_Argv( 1 ), 16 );
+		mpz_init_set_str(message, args.Argv(1).c_str(), 16);
 
-		if ( rsa_decrypt( &private_key, &msg_len, ( unsigned char * ) buffer + 16, message ) )
-		{
-			nettle_mpz_set_str_256_u( message, msg_len, ( unsigned char * ) buffer + 16 );
-			mpz_get_str( buffer + 16, 16, message );
-			CL_AddReliableCommand( buffer );
+		if (rsa_decrypt(&private_key, &msg_len, (unsigned char *) buffer + 16, message)) {
+			nettle_mpz_set_str_256_u(message, msg_len, (unsigned char *) buffer + 16);
+			mpz_get_str(buffer + 16, 16, message);
+			CL_AddReliableCommand(buffer);
 		}
 
-		mpz_clear( message );
+		mpz_clear(message);
 		return qfalse;
 	}
 
-	// we may want to put a "connect to other server" command here
-
-	// cgame can now act on the command
+	Cmd_TokenizeString(text.c_str());
 	return qtrue;
 }
 
+// Get the server command, does client-specific handling
+// that may block the propagation of the command to cgame.
+// If the propagation is not blocked then it tokenizes the
+// command.
+// Returns false if the command was blacked.
+qboolean CL_GetServerCommand( int serverCommandNumber )
+{
+	const char  *s;
+
+	// if we have irretrievably lost a reliable command, drop the connection
+	if ( serverCommandNumber <= clc.serverCommandSequence - MAX_RELIABLE_COMMANDS )
+	{
+		// when a demo record was started after the client got a whole bunch of
+		// reliable commands then the client never got those first reliable commands
+		if ( clc.demoplaying )
+		{
+			return qfalse;
+		}
+
+		Com_Error( ERR_DROP, "CL_GetServerCommand: a reliable command was cycled out" );
+	}
+
+	if ( serverCommandNumber > clc.serverCommandSequence )
+	{
+		Com_Error( ERR_DROP, "CL_GetServerCommand: requested a command not received" );
+	}
+
+	s = clc.serverCommands[ serverCommandNumber & ( MAX_RELIABLE_COMMANDS - 1 ) ];
+	clc.lastExecutedServerCommand = serverCommandNumber;
+
+	if ( cl_showServerCommands->integer )
+	{
+		// NERVE - SMF
+		Com_Printf( "serverCommand: %i : %s\n", serverCommandNumber, s );
+	}
+
+	return CL_HandleServerCommand(s);
+}
+
 // DHM - Nerve :: Copied from server to here
 
 /*