/
noire-dev
/
SourceTech
Обзор
Документация
Войти
/
noire-dev
/
SourceTech
Код
Запросы
0
Задачи
Вики
Пакеты
0
Релизы
0
CI/CD
Аналитика
Безопасность
sourcetech
code/client/cl_parse.c
772 строки
21 KB
noire-dev
upload files
02 янв 2026, 04:28
02 янв 2026, 04:28
de34b83
Код
Авторство
О чём код?
/* =========================================================================== Copyright (C) 1999-2005 Id Software, Inc. This file is part of Quake III Arena source code. Quake III Arena source code 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. Quake III Arena source code 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 Quake III Arena source code; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA =========================================================================== */ // cl_parse.c -- parse a message received from the server #include "client.h" static const char *svc_strings[256] = { "svc_bad", "svc_nop", "svc_gamestate", "svc_configstring", "svc_baseline", "svc_serverCommand", "svc_download", "svc_snapshot", "svc_EOF", }; static void SHOWNET( msg_t *msg, const char *s ) { if ( cl_shownet->integer >= 2) { Com_Printf ("%3i:%s\n", msg->readcount-1, s); } } /* ========================================================================= MESSAGE PARSING ========================================================================= */ /* ================== CL_DeltaEntity Parses deltas from the given base and adds the resulting entity to the current frame ================== */ static void CL_DeltaEntity( msg_t *msg, clSnapshot_t *frame, int newnum, const entityState_t *old, qboolean unchanged) { entityState_t *state; // save the parsed entity state into the big circular buffer so // it can be used as the source for a later delta state = &cl.parseEntities[cl.parseEntitiesNum & (MAX_PARSE_ENTITIES-1)]; if ( unchanged ) { *state = *old; } else { MSG_ReadDeltaEntity( msg, old, state, newnum ); } if ( state->number == (MAX_GENTITIES-1) ) { return; // entity was delta removed } cl.parseEntitiesNum++; frame->numEntities++; } /* ================== CL_ParsePacketEntities ================== */ static void CL_ParsePacketEntities( msg_t *msg, const clSnapshot_t *oldframe, clSnapshot_t *newframe ) { const entityState_t *oldstate; int newnum; int oldindex, oldnum; newframe->parseEntitiesNum = cl.parseEntitiesNum; newframe->numEntities = 0; // delta from the entities present in oldframe oldindex = 0; oldstate = NULL; if ( !oldframe ) { oldnum = MAX_GENTITIES+1; } else { if ( oldindex >= oldframe->numEntities ) { oldnum = MAX_GENTITIES+1; } else { oldstate = &cl.parseEntities[ (oldframe->parseEntitiesNum + oldindex) & (MAX_PARSE_ENTITIES-1)]; oldnum = oldstate->number; } } while ( 1 ) { // read the entity index number newnum = MSG_ReadEntitynum( msg ); if ( newnum < 0 ) { Com_Error( ERR_DROP, "CL_ParsePacketEntities: end of message" ); } if ( newnum == (MAX_GENTITIES-1) ) { break; } while ( oldnum < newnum ) { // one or more entities from the old packet are unchanged if ( cl_shownet->integer == 3 ) { Com_Printf ("%3i: unchanged: %i\n", msg->readcount, oldnum); } CL_DeltaEntity( msg, newframe, oldnum, oldstate, qtrue ); oldindex++; if ( oldindex >= oldframe->numEntities ) { oldnum = MAX_GENTITIES+1; } else { oldstate = &cl.parseEntities[ (oldframe->parseEntitiesNum + oldindex) & (MAX_PARSE_ENTITIES-1)]; oldnum = oldstate->number; } } if (oldnum == newnum) { // delta from previous state if ( cl_shownet->integer == 3 ) { Com_Printf ("%3i: delta: %i\n", msg->readcount, newnum); } CL_DeltaEntity( msg, newframe, newnum, oldstate, qfalse ); oldindex++; if ( oldindex >= oldframe->numEntities ) { oldnum = MAX_GENTITIES+1; } else { oldstate = &cl.parseEntities[ (oldframe->parseEntitiesNum + oldindex) & (MAX_PARSE_ENTITIES-1)]; oldnum = oldstate->number; } continue; } if ( oldnum > newnum ) { // delta from baseline if ( cl_shownet->integer == 3 ) { Com_Printf ("%3i: baseline: %i\n", msg->readcount, newnum); } CL_DeltaEntity( msg, newframe, newnum, &cl.entityBaselines[newnum], qfalse ); continue; } } // any remaining entities in the old frame are copied over while ( oldnum != MAX_GENTITIES+1 ) { // one or more entities from the old packet are unchanged if ( cl_shownet->integer == 3 ) { Com_Printf ("%3i: unchanged: %i\n", msg->readcount, oldnum); } CL_DeltaEntity( msg, newframe, oldnum, oldstate, qtrue ); oldindex++; if ( oldindex >= oldframe->numEntities ) { oldnum = MAX_GENTITIES+1; } else { oldstate = &cl.parseEntities[ (oldframe->parseEntitiesNum + oldindex) & (MAX_PARSE_ENTITIES-1)]; oldnum = oldstate->number; } } } /* ================ CL_ParseSnapshot If the snapshot is parsed properly, it will be copied to cl.snap and saved in cl.snapshots[]. If the snapshot is invalid for any reason, no changes to the state will be made at all. ================ */ static void CL_ParseSnapshot( msg_t *msg ) { const clSnapshot_t *old; clSnapshot_t newSnap; int deltaNum; int oldMessageNum; int i, n, packetNum; // get the reliable sequence acknowledge number // NOTE: now sent with all server to client messages //clc.reliableAcknowledge = MSG_ReadLong( msg ); // read in the new snapshot to a temporary buffer // we will only copy to cl.snap if it is valid Com_Memset (&newSnap, 0, sizeof(newSnap)); // we will have read any new server commands in this // message before we got to svc_snapshot newSnap.serverCommandNum = clc.serverCommandSequence; newSnap.serverTime = MSG_ReadLong( msg ); newSnap.messageNum = clc.serverMessageSequence; deltaNum = MSG_ReadByte( msg ); if ( !deltaNum ) { newSnap.deltaNum = -1; } else { newSnap.deltaNum = newSnap.messageNum - deltaNum; } newSnap.snapFlags = MSG_ReadByte( msg ); // If the frame is delta compressed from data that we // no longer have available, we must suck up the rest of // the frame, but not use it, then ask for a non-compressed // message if ( newSnap.deltaNum <= 0 ) { newSnap.valid = qtrue; // uncompressed frame old = NULL; clc.demowaiting = qfalse; // we can start recording now } else { old = &cl.snapshots[newSnap.deltaNum & PACKET_MASK]; if ( !old->valid ) { // should never happen Com_Printf ("Delta from invalid frame (not supposed to happen!).\n"); } else if ( old->messageNum != newSnap.deltaNum ) { // The frame that the server did the delta from // is too old, so we can't reconstruct it properly. Com_Printf ("Delta frame too old.\n"); } else if ( cl.parseEntitiesNum - old->parseEntitiesNum > MAX_PARSE_ENTITIES - MAX_SNAPSHOT_ENTITIES ) { Com_Printf ("Delta parseEntitiesNum too old.\n"); } else { newSnap.valid = qtrue; // valid delta parse } } // read areamask newSnap.areabytes = MSG_ReadByte( msg ); if ( newSnap.areabytes > sizeof(newSnap.areamask) ) { Com_Error( ERR_DROP,"CL_ParseSnapshot: Invalid size %d for areamask", newSnap.areabytes ); return; } MSG_ReadData( msg, &newSnap.areamask, newSnap.areabytes ); // read playerinfo SHOWNET( msg, "playerstate" ); if ( old ) { MSG_ReadDeltaPlayerstate( msg, &old->ps, &newSnap.ps ); } else { MSG_ReadDeltaPlayerstate( msg, NULL, &newSnap.ps ); } // read packet entities SHOWNET( msg, "packet entities" ); CL_ParsePacketEntities( msg, old, &newSnap ); // if not valid, dump the entire thing now that it has // been properly read if ( !newSnap.valid ) { return; } // clear the valid flags of any snapshots between the last // received and this one, so if there was a dropped packet // it won't look like something valid to delta from next // time we wrap around in the buffer oldMessageNum = cl.snap.messageNum + 1; if ( newSnap.messageNum - oldMessageNum >= PACKET_BACKUP ) { oldMessageNum = newSnap.messageNum - ( PACKET_BACKUP - 1 ); } for ( i = 0, n = newSnap.messageNum - oldMessageNum; i < n; i++ ) { cl.snapshots[ ( oldMessageNum + i ) & PACKET_MASK ].valid = qfalse; } // copy to the current good spot cl.snap = newSnap; cl.snap.ping = 999; // calculate ping time for ( i = 0 ; i < PACKET_BACKUP ; i++ ) { packetNum = ( clc.netchan.outgoingSequence - 1 - i ) & PACKET_MASK; if ( cl.snap.ps.commandTime - cl.outPackets[packetNum].p_serverTime >= 0 ) { cl.snap.ping = cls.realtime - cl.outPackets[ packetNum ].p_realtime; break; } } // save the frame off in the backup array for later delta comparisons cl.snapshots[cl.snap.messageNum & PACKET_MASK] = cl.snap; if (cl_shownet->integer == 3) { Com_Printf( " snapshot:%i delta:%i ping:%i\n", cl.snap.messageNum, cl.snap.deltaNum, cl.snap.ping ); } cl.newSnapshots = qtrue; clc.eventMask |= EM_SNAPSHOT; } //===================================================================== int cl_connectedToCheatServer; /* ================== CL_SystemInfoChanged The systeminfo configstring has been changed, so parse new information out of it. This will happen at every gamestate, and possibly during gameplay. ================== */ void CL_SystemInfoChanged( qboolean onlyGame ) { const char *systemInfo; const char *s; char key[BIG_INFO_KEY]; char value[BIG_INFO_VALUE]; systemInfo = cl.gameState.stringData + cl.gameState.stringOffsets[ CS_SYSTEMINFO ]; // NOTE TTimo: // when the serverId changes, any further messages we send to the server will use this new serverId // https://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=475 // in some cases, outdated cp commands might get sent with this news serverId cl.serverId = atoi( Info_ValueForKey( systemInfo, "sv_serverid" ) ); // don't set any vars when playing a demo if ( clc.demoplaying ) { return; } s = Info_ValueForKey( systemInfo, "sv_cheats" ); cl_connectedToCheatServer = atoi( s ); if ( !cl_connectedToCheatServer ) Cvar_SetCheatState(); // scan through all the variables in the systeminfo and locally set cvars to match s = systemInfo; do { s = Info_NextPair( s, key, value ); if ( key[0] == '\0' ) break; // we don't really need any of these server cvars to be set on client-side if ( !Q_stricmp( key, "sv_serverid" ) || !Q_stricmp( key, "sv_fps" ) || !Q_stricmp( key, "sv_referencedPakNames" ) ) continue; Cvar_Set( key, value ); } while ( *s != '\0' ); } /* ================== CL_ParseServerInfo ================== */ static void CL_ParseServerInfo( void ) { const char *serverInfo; size_t len; serverInfo = cl.gameState.stringData + cl.gameState.stringOffsets[ CS_SERVERINFO ]; clc.sv_allowDownload = atoi(Info_ValueForKey(serverInfo, "sv_allowDownload")); Q_strncpyz(clc.sv_dlURL, Info_ValueForKey(serverInfo, "sv_dlURL"), sizeof(clc.sv_dlURL)); /* remove ending slash in URLs */ len = strlen( clc.sv_dlURL ); if ( len > 0 && clc.sv_dlURL[len-1] == '/' ) clc.sv_dlURL[len-1] = '\0'; } /* ================== CL_ParseGamestate ================== */ static void CL_ParseGamestate( msg_t *msg ) { int i; entityState_t *es; int newnum; entityState_t nullstate; int cmd; const char *s; const char *info, *mapname; //for client switching clc.connectPacketCount = 0; Com_Memset( &nullstate, 0, sizeof( nullstate ) ); // clear old error message Cvar_Set( "com_errorMessage", "" ); // wipe local client state CL_ClearState(); // all configstring updates received before new gamestate must be discarded for ( i = 0; i < MAX_RELIABLE_COMMANDS; i++ ) { s = clc.serverCommands[ i ]; if ( !strncmp( s, "cs ", 3 ) || !strncmp( s, "bcs0 ", 5 ) || !strncmp( s, "bcs1 ", 5 ) || !strncmp( s, "bcs2 ", 5 ) ) { clc.serverCommandsIgnore[ i ] = qtrue; } } // a gamestate always marks a server command sequence clc.serverCommandSequence = MSG_ReadLong( msg ); // parse all the configstrings and baselines cl.gameState.dataCount = 1; // leave a 0 at the beginning for uninitialized configstrings while ( 1 ) { cmd = MSG_ReadByte( msg ); if ( cmd == svc_EOF ) { break; } if ( cmd == svc_configstring ) { int len; i = MSG_ReadShort( msg ); if ( i < 0 || i >= MAX_CONFIGSTRINGS ) { Com_Error( ERR_DROP, "%s: configstring > MAX_CONFIGSTRINGS", __func__ ); } s = MSG_ReadBigString( msg ); len = strlen( s ); if ( len + 1 + cl.gameState.dataCount > MAX_GAMESTATE_CHARS ) { Com_Error( ERR_DROP, "%s: MAX_GAMESTATE_CHARS exceeded: %i", __func__, len + 1 + cl.gameState.dataCount ); } // append it to the gameState string buffer cl.gameState.stringOffsets[ i ] = cl.gameState.dataCount; Com_Memcpy( cl.gameState.stringData + cl.gameState.dataCount, s, len + 1 ); cl.gameState.dataCount += len + 1; } else if ( cmd == svc_baseline ) { newnum = MSG_ReadEntitynum( msg ); if ( newnum < 0 ) { Com_Error( ERR_DROP, "%s: end of message", __func__ ); } if ( newnum >= MAX_GENTITIES ) { Com_Error( ERR_DROP, "%s: baseline number out of range: %i", __func__, newnum ); } es = &cl.entityBaselines[ newnum ]; MSG_ReadDeltaEntity( msg, &nullstate, es, newnum ); cl.baselineUsed[ newnum ] = 1; } else { Com_Error( ERR_DROP, "%s: bad command byte", __func__ ); } } clc.eventMask |= EM_GAMESTATE; clc.clientNum = MSG_ReadLong(msg); // read the checksum feed clc.checksumFeed = MSG_ReadLong( msg ); // parse useful values out of CS_SERVERINFO CL_ParseServerInfo(); // parse serverId and other cvars CL_SystemInfoChanged( qtrue ); info = cl.gameState.stringData + cl.gameState.stringOffsets[ CS_SERVERINFO ]; mapname = Info_ValueForKey( info, "mapname" ); Cbuf_AddText( "exec maps/default.cfg \n" ); //load default map script on client Cbuf_AddText( va("exec maps/%s.cfg \n", mapname) ); //load map script on client Cvar_Set("cl_changeqvm", mapname); //load map fs on client // This used to call CL_StartHunkUsers, but now we enter the download state before loading the cgame CL_InitDownloads(); } /* ===================== CL_ValidPakSignature checks for valid ZIP signature returns qtrue for normal and empty archives ===================== */ qboolean CL_ValidPakSignature( const byte *data, int len ) { // maybe it is not 100% correct to check for file size here // because we may receive more data in future packets // but situation when server sends fragmented/shortened // zip header in first packet - looks pretty suspicious if ( len < 22 ) return qfalse; // minimal ZIP file length is 22 bytes if ( data[0] != 'P' || data[1] != 'K' ) return qfalse; if ( data[2] == 0x3 && data[3] == 0x4 ) return qtrue; // local file header if ( data[2] == 0x5 && data[3] == 0x6 ) return qtrue; // EOCD return qfalse; } //===================================================================== /* ===================== CL_ParseDownload A download message has been received from the server ===================== */ static void CL_ParseDownload( msg_t *msg ) { int size; unsigned char data[ MAX_MSGLEN ]; uint16_t block; if (!*clc.downloadTempName) { Com_Printf("Server sending download, but no download was requested\n"); CL_AddReliableCommand( "stopdl", qfalse ); return; } if ( clc.recordfile != FS_INVALID_HANDLE ) { CL_StopRecord_f(); } // read the data block = MSG_ReadShort ( msg ); if(!block && !clc.downloadBlock) { // block zero is special, contains file size clc.downloadSize = MSG_ReadLong ( msg ); Cvar_Set("cl_downloadSize", va("%i", clc.downloadSize)); if (clc.downloadSize < 0) { Com_Error( ERR_DROP, "%s", MSG_ReadString( msg ) ); return; } } size = MSG_ReadShort ( msg ); if (size < 0 || size > sizeof(data)) { Com_Error(ERR_DROP, "CL_ParseDownload: Invalid size %d for download chunk", size); return; } MSG_ReadData(msg, data, size); if((clc.downloadBlock & 0xFFFF) != block) { Com_DPrintf( "CL_ParseDownload: Expected block %d, got %d\n", (clc.downloadBlock & 0xFFFF), block); return; } // open the file if not opened yet if ( clc.download == FS_INVALID_HANDLE ) { if ( !CL_ValidPakSignature( data, size ) ) { Com_Printf( S_COLOR_YELLOW "Invalid pak signature for %s\n", clc.downloadName ); CL_AddReliableCommand( "stopdl", qfalse ); CL_NextDownload(); return; } clc.download = FS_SV_FOpenFileWrite( clc.downloadTempName ); if ( clc.download == FS_INVALID_HANDLE ) { Com_Printf( "Could not create %s\n", clc.downloadTempName ); CL_AddReliableCommand( "stopdl", qfalse ); CL_NextDownload(); return; } } if (size) FS_Write( data, size, clc.download ); CL_AddReliableCommand( va("nextdl %d", clc.downloadBlock), qfalse ); clc.downloadBlock++; clc.downloadCount += size; // So UI gets access to it Cvar_Set("cl_downloadCount", va("%i", clc.downloadCount)); if ( size == 0 ) { // A zero length block means EOF if ( clc.download != FS_INVALID_HANDLE ) { FS_FCloseFile( clc.download ); clc.download = FS_INVALID_HANDLE; // rename the file FS_SV_Rename( clc.downloadTempName, clc.downloadName ); } // send intentions now // We need this because without it, we would hold the last nextdl and then start // loading right away. If we take a while to load, the server is happily trying // to send us that last block over and over. // Write it twice to help make sure we acknowledge the download CL_WritePacket( 1 ); // get another file if needed CL_NextDownload(); } } /* ===================== CL_ParseCommandString Command strings are just saved off until cgame asks for them when it transitions a snapshot ===================== */ static void CL_ParseCommandString( msg_t *msg ) { const char *s; int seq; int index; seq = MSG_ReadLong( msg ); s = MSG_ReadString( msg ); if ( cl_shownet->integer >= 3 ) Com_Printf( " %3i(%3i) %s\n", seq, clc.serverCommandSequence, s ); // see if we have already executed stored it off if ( clc.serverCommandSequence - seq >= 0 ) { return; } clc.serverCommandSequence = seq; index = seq & (MAX_RELIABLE_COMMANDS-1); Q_strncpyz( clc.serverCommands[ index ], s, sizeof( clc.serverCommands[ index ] ) ); clc.serverCommandsIgnore[ index ] = qfalse; // -EC- : we may stuck on downloading because of non-working cgvm // or in "awaiting snapshot..." state so handle "disconnect" here if ( ( !cgvm && cls.state == CA_CONNECTED && clc.download != FS_INVALID_HANDLE ) || ( cgvm && cls.state == CA_PRIMED ) ) { const char *text; Cmd_TokenizeString( s ); if ( !Q_stricmp( Cmd_Argv(0), "disconnect" ) ) { text = ( Cmd_Argc() > 1 ) ? va( "Server disconnected: %s", Cmd_Argv( 1 ) ) : "Server disconnected."; Cvar_Set( "com_errorMessage", text ); Com_Printf( "%s\n", text ); if ( !CL_Disconnect( qtrue ) ) { // restart client if not done already CL_FlushMemory(); } return; } } clc.eventMask |= EM_COMMAND; } /* ===================== CL_ParseServerMessage ===================== */ void CL_ParseServerMessage( msg_t *msg ) { int cmd; if ( cl_shownet->integer == 1 ) { Com_Printf( "%i ",msg->cursize ); } else if ( cl_shownet->integer >= 2 ) { Com_Printf( "------------------\n" ); } clc.eventMask = 0; MSG_Bitstream( msg ); // get the reliable sequence acknowledge number clc.reliableAcknowledge = MSG_ReadLong( msg ); if ( clc.reliableSequence - clc.reliableAcknowledge > MAX_RELIABLE_COMMANDS ) { if ( !clc.demoplaying ) { Com_Printf( S_COLOR_YELLOW "WARNING: dropping %i commands from server\n", clc.reliableSequence - clc.reliableAcknowledge ); } clc.reliableAcknowledge = clc.reliableSequence; } else if ( clc.reliableSequence - clc.reliableAcknowledge < 0 ) { if ( clc.demoplaying ) { clc.reliableSequence = clc.reliableAcknowledge; } else { Com_Error( ERR_DROP, "%s: incorrect reliable sequence acknowledge number", __func__ ); } } // parse the message while ( 1 ) { if ( msg->readcount > msg->cursize ) { Com_Error( ERR_DROP,"CL_ParseServerMessage: read past end of server message" ); break; } cmd = MSG_ReadByte( msg ); if ( cmd == svc_EOF) { SHOWNET( msg, "END OF MESSAGE" ); break; } if ( cl_shownet->integer >= 2 ) { if ( (cmd < 0) || (!svc_strings[cmd]) ) { Com_Printf( "%3i:BAD CMD %i\n", msg->readcount-1, cmd ); } else { SHOWNET( msg, svc_strings[cmd] ); } } // other commands switch ( cmd ) { default: Com_Error( ERR_DROP,"CL_ParseServerMessage: Illegible server message" ); break; case svc_nop: break; case svc_serverCommand: CL_ParseCommandString( msg ); break; case svc_gamestate: CL_ParseGamestate( msg ); break; case svc_snapshot: CL_ParseSnapshot( msg ); break; case svc_download: if ( clc.demofile != FS_INVALID_HANDLE ) return; CL_ParseDownload( msg ); break; } } }