]> icculus.org git repositories - divverent/darkplaces.git/blob - csprogs.c
prevent information leakage from trace_ globals to prvm_global client to prevent...
[divverent/darkplaces.git] / csprogs.c
1 #include "quakedef.h"
2 #include "progsvm.h"
3 #include "clprogdefs.h"
4 #include "csprogs.h"
5 #include "cl_collision.h"
6 #include "snd_main.h"
7 #include "clvm_cmds.h"
8
9 //============================================================================
10 // Client prog handling
11 //[515]: omg !!! optimize it ! a lot of hacks here and there also :P
12
13 #define CSQC_RETURNVAL  prog->globals.generic[OFS_RETURN]
14 #define CSQC_BEGIN              csqc_tmpprog=prog;prog=0;PRVM_SetProg(PRVM_CLIENTPROG);
15 #define CSQC_END                prog=csqc_tmpprog;
16
17 static prvm_prog_t *csqc_tmpprog;
18
19 void CL_VM_PreventInformationLeaks(void)
20 {
21         prvm_eval_t *val;
22         if(!cl.csqc_loaded)
23                 return;
24         CSQC_BEGIN
25                 VM_ClearTraceGlobals();
26                 if ((val = PRVM_GLOBALFIELDVALUE(prog->globaloffsets.trace_networkentity)))
27                         val->_float = 0;
28         CSQC_END
29 }
30
31 //[515]: these are required funcs
32 static char *cl_required_func[] =
33 {
34         "CSQC_Init",
35         "CSQC_InputEvent",
36         "CSQC_UpdateView",
37         "CSQC_ConsoleCommand",
38 };
39
40 static int cl_numrequiredfunc = sizeof(cl_required_func) / sizeof(char*);
41
42 void CL_VM_Error (const char *format, ...) DP_FUNC_PRINTF(1);
43 void CL_VM_Error (const char *format, ...)      //[515]: hope it will be never executed =)
44 {
45         char errorstring[4096];
46         va_list argptr;
47
48         va_start (argptr, format);
49         dpvsnprintf (errorstring, sizeof(errorstring), format, argptr);
50         va_end (argptr);
51 //      Con_Printf( "CL_VM_Error: %s\n", errorstring );
52
53         PRVM_Crash();
54         cl.csqc_loaded = false;
55
56         Cvar_SetValueQuick(&csqc_progcrc, -1);
57         Cvar_SetValueQuick(&csqc_progsize, -1);
58
59 //      Host_AbortCurrentFrame();       //[515]: hmmm... if server says it needs csqc then client MUST disconnect
60         Host_Error("CL_VM_Error: %s", errorstring);
61 }
62 void CL_VM_UpdateDmgGlobals (int dmg_take, int dmg_save, vec3_t dmg_origin)
63 {
64         prvm_eval_t *val;
65         if(cl.csqc_loaded)
66         {
67                 CSQC_BEGIN
68                 val = PRVM_GLOBALFIELDVALUE(prog->globaloffsets.dmg_take);
69                 if(val)
70                         val->_float = dmg_take;
71                 val = PRVM_GLOBALFIELDVALUE(prog->globaloffsets.dmg_save);
72                 if(val)
73                         val->_float = dmg_save;
74                 val = PRVM_GLOBALFIELDVALUE(prog->globaloffsets.dmg_origin);
75                 if(val)
76                 {
77                         val->vector[0] = dmg_origin[0];
78                         val->vector[1] = dmg_origin[1];
79                         val->vector[2] = dmg_origin[2];
80                 }
81                 CSQC_END
82         }
83 }
84
85 void CSQC_UpdateNetworkTimes(double newtime, double oldtime)
86 {
87         prvm_eval_t *val;
88         if(!cl.csqc_loaded)
89                 return;
90         CSQC_BEGIN
91         if ((val = PRVM_GLOBALFIELDVALUE(prog->globaloffsets.servertime)))
92                 val->_float = newtime;
93         if ((val = PRVM_GLOBALFIELDVALUE(prog->globaloffsets.serverprevtime)))
94                 val->_float = oldtime;
95         if ((val = PRVM_GLOBALFIELDVALUE(prog->globaloffsets.serverdeltatime)))
96                 val->_float = newtime - oldtime;
97         CSQC_END
98 }
99
100 //[515]: set globals before calling R_UpdateView, WEIRD CRAP
101 static void CSQC_SetGlobals (void)
102 {
103         prvm_eval_t *val;
104         CSQC_BEGIN
105                 prog->globals.client->time = cl.time;
106                 prog->globals.client->frametime = max(0, cl.time - cl.oldtime);
107                 prog->globals.client->servercommandframe = cls.servermovesequence;
108                 prog->globals.client->clientcommandframe = cl.movecmd[0].sequence;
109                 VectorCopy(cl.viewangles, prog->globals.client->input_angles);
110                 VectorCopy(cl.viewangles, cl.csqc_angles);
111                 // // FIXME: this actually belongs into getinputstate().. [12/17/2007 Black]
112                 prog->globals.client->input_buttons = cl.movecmd[0].buttons;
113                 VectorSet(prog->globals.client->input_movevalues, cl.movecmd[0].forwardmove, cl.movecmd[0].sidemove, cl.movecmd[0].upmove);
114                 //VectorCopy(cl.movement_origin, cl.csqc_origin);
115                 Matrix4x4_OriginFromMatrix(&cl.entities[cl.viewentity].render.matrix, cl.csqc_origin);
116
117                 // LordHavoc: Spike says not to do this, but without pmove_org the
118                 // CSQC is useless as it can't alter the view origin without
119                 // completely replacing it
120                 VectorCopy(cl.csqc_origin, prog->globals.client->pmove_org);
121                 VectorCopy(cl.movement_velocity, prog->globals.client->pmove_vel);
122
123                 if ((val = PRVM_GLOBALFIELDVALUE(prog->globaloffsets.view_angles)))
124                         VectorCopy(cl.viewangles, val->vector);
125                 prog->globals.client->maxclients = cl.maxclients;
126         CSQC_END
127 }
128
129 void CSQC_Predraw (prvm_edict_t *ed)
130 {
131         int b;
132         if(!ed->fields.client->predraw)
133                 return;
134         b = prog->globals.client->self;
135         prog->globals.client->self = PRVM_EDICT_TO_PROG(ed);
136         PRVM_ExecuteProgram(ed->fields.client->predraw, "CSQC_Predraw: NULL function\n");
137         prog->globals.client->self = b;
138 }
139
140 void CSQC_Think (prvm_edict_t *ed)
141 {
142         int b;
143         if(ed->fields.client->think)
144         if(ed->fields.client->nextthink && ed->fields.client->nextthink <= prog->globals.client->time)
145         {
146                 ed->fields.client->nextthink = 0;
147                 b = prog->globals.client->self;
148                 prog->globals.client->self = PRVM_EDICT_TO_PROG(ed);
149                 PRVM_ExecuteProgram(ed->fields.client->think, "CSQC_Think: NULL function\n");
150                 prog->globals.client->self = b;
151         }
152 }
153
154 extern cvar_t cl_noplayershadow;
155 qboolean CSQC_AddRenderEdict(prvm_edict_t *ed)
156 {
157         int renderflags;
158         int c;
159         float scale;
160         prvm_eval_t *val;
161         entity_render_t *entrender;
162         dp_model_t *model;
163         matrix4x4_t tagmatrix, matrix2;
164
165         model = CL_GetModelFromEdict(ed);
166         if (!model)
167                 return false;
168
169         entrender = CL_NewTempEntity(0);
170         if (!entrender)
171                 return false;
172
173         entrender->model = model;
174         entrender->skinnum = (int)ed->fields.client->skin;
175         entrender->effects |= entrender->model->effects;
176         scale = 1;
177         renderflags = 0;
178         if((val = PRVM_EDICTFIELDVALUE(ed, prog->fieldoffsets.renderflags)) && val->_float)     renderflags = (int)val->_float;
179         if((val = PRVM_EDICTFIELDVALUE(ed, prog->fieldoffsets.alpha)) && val->_float)           entrender->alpha = val->_float;
180         if((val = PRVM_EDICTFIELDVALUE(ed, prog->fieldoffsets.scale)) && val->_float)           entrender->scale = scale = val->_float;
181         if((val = PRVM_EDICTFIELDVALUE(ed, prog->fieldoffsets.colormod)) && VectorLength2(val->vector)) VectorCopy(val->vector, entrender->colormod);
182         if((val = PRVM_EDICTFIELDVALUE(ed, prog->fieldoffsets.effects)) && val->_float) entrender->effects |= (int)val->_float;
183         if((val = PRVM_EDICTFIELDVALUE(ed, prog->fieldoffsets.tag_entity)) && val->edict)
184         {
185                 int tagentity;
186                 int tagindex = 0;
187                 tagentity = val->edict;
188                 if((val = PRVM_EDICTFIELDVALUE(ed, prog->fieldoffsets.tag_index)) && val->_float)
189                         tagindex = (int)val->_float;
190                 CL_GetTagMatrix (&tagmatrix, PRVM_PROG_TO_EDICT(tagentity), tagindex);
191         }
192         else
193                 Matrix4x4_CreateIdentity(&tagmatrix);
194
195         if (renderflags & RF_USEAXIS)
196         {
197                 vec3_t left;
198                 VectorNegate(prog->globals.client->v_right, left);
199                 Matrix4x4_FromVectors(&matrix2, prog->globals.client->v_forward, left, prog->globals.client->v_up, ed->fields.client->origin);
200                 Matrix4x4_Scale(&matrix2, scale, 1);
201         }
202         else
203         {
204                 vec3_t angles;
205                 VectorCopy(ed->fields.client->angles, angles);
206                 // if model is alias, reverse pitch direction
207                 if (entrender->model->type == mod_alias)
208                         angles[0] = -angles[0];
209
210                 // set up the render matrix
211                 Matrix4x4_CreateFromQuakeEntity(&matrix2, ed->fields.client->origin[0], ed->fields.client->origin[1], ed->fields.client->origin[2], angles[0], angles[1], angles[2], scale);
212         }
213
214         // set up the animation data
215         // self.frame is the interpolation target (new frame)
216         // self.frame1time is the animation base time for the interpolation target
217         // self.frame2 is the interpolation start (previous frame)
218         // self.frame2time is the animation base time for the interpolation start
219         // self.lerpfrac is the interpolation strength for self.frame
220         // 3+ are for additional blends (the main use for this feature is lerping
221         // pitch angle on a player model where the animator set up 5 sets of
222         // animations and the csqc simply lerps between sets)
223         entrender->framegroupblend[0].frame = entrender->framegroupblend[1].frame = (int) ed->fields.client->frame;
224         if ((val = PRVM_EDICTFIELDVALUE(ed, prog->fieldoffsets.frame2))) entrender->framegroupblend[1].frame = (int) val->_float;
225         if ((val = PRVM_EDICTFIELDVALUE(ed, prog->fieldoffsets.frame3))) entrender->framegroupblend[2].frame = (int) val->_float;
226         if ((val = PRVM_EDICTFIELDVALUE(ed, prog->fieldoffsets.frame4))) entrender->framegroupblend[3].frame = (int) val->_float;
227         if ((val = PRVM_EDICTFIELDVALUE(ed, prog->fieldoffsets.frame1time))) entrender->framegroupblend[0].start = val->_float;
228         if ((val = PRVM_EDICTFIELDVALUE(ed, prog->fieldoffsets.frame2time))) entrender->framegroupblend[1].start = val->_float;
229         if ((val = PRVM_EDICTFIELDVALUE(ed, prog->fieldoffsets.frame3time))) entrender->framegroupblend[2].start = val->_float;
230         if ((val = PRVM_EDICTFIELDVALUE(ed, prog->fieldoffsets.frame4time))) entrender->framegroupblend[3].start = val->_float;
231         if ((val = PRVM_EDICTFIELDVALUE(ed, prog->fieldoffsets.lerpfrac))) entrender->framegroupblend[0].lerp = val->_float;
232         if ((val = PRVM_EDICTFIELDVALUE(ed, prog->fieldoffsets.lerpfrac3))) entrender->framegroupblend[2].lerp = val->_float;
233         if ((val = PRVM_EDICTFIELDVALUE(ed, prog->fieldoffsets.lerpfrac4))) entrender->framegroupblend[3].lerp = val->_float;
234         if ((val = PRVM_EDICTFIELDVALUE(ed, prog->fieldoffsets.shadertime))) entrender->shadertime = val->_float;
235         // assume that the (missing) lerpfrac2 is whatever remains after lerpfrac+lerpfrac3+lerpfrac4 are summed
236         entrender->framegroupblend[1].lerp = 1 - entrender->framegroupblend[0].lerp - entrender->framegroupblend[2].lerp - entrender->framegroupblend[3].lerp;
237
238         // concat the matrices to make the entity relative to its tag
239         Matrix4x4_Concat(&entrender->matrix, &tagmatrix, &matrix2);
240
241         if(renderflags)
242         {
243                 if(renderflags & RF_VIEWMODEL)  entrender->flags |= RENDER_VIEWMODEL;
244                 if(renderflags & RF_EXTERNALMODEL)entrender->flags |= RENDER_EXTERIORMODEL;
245                 if(renderflags & RF_DEPTHHACK)  entrender->effects |= EF_NODEPTHTEST;
246                 if(renderflags & RF_ADDITIVE)           entrender->effects |= EF_ADDITIVE;
247         }
248
249         c = (int)ed->fields.client->colormap;
250         if (c <= 0)
251                 CL_SetEntityColormapColors(entrender, -1);
252         else if (c <= cl.maxclients && cl.scores != NULL)
253                 CL_SetEntityColormapColors(entrender, cl.scores[c-1].colors);
254         else
255                 CL_SetEntityColormapColors(entrender, c);
256
257         entrender->flags &= ~(RENDER_SHADOW | RENDER_LIGHT | RENDER_NOSELFSHADOW);
258         // either fullbright or lit
259         if (!(entrender->effects & EF_FULLBRIGHT) && !r_fullbright.integer)
260                 entrender->flags |= RENDER_LIGHT;
261         // hide player shadow during intermission or nehahra movie
262         if (!(entrender->effects & (EF_NOSHADOW | EF_ADDITIVE | EF_NODEPTHTEST))
263          &&  (entrender->alpha >= 1)
264          && !(entrender->flags & RENDER_VIEWMODEL)
265          && (!(entrender->flags & RENDER_EXTERIORMODEL) || (!cl.intermission && cls.protocol != PROTOCOL_NEHAHRAMOVIE && !cl_noplayershadow.integer)))
266                 entrender->flags |= RENDER_SHADOW;
267         if (entrender->flags & RENDER_VIEWMODEL)
268                 entrender->flags |= RENDER_NOSELFSHADOW;
269         if (entrender->effects & EF_NOSELFSHADOW)
270                 entrender->flags |= RENDER_NOSELFSHADOW;
271
272         // make the other useful stuff
273         CL_UpdateRenderEntity(entrender);
274
275         return true;
276 }
277
278 qboolean CL_VM_InputEvent (qboolean down, int key, int ascii)
279 {
280         qboolean r;
281
282         if(!cl.csqc_loaded)
283                 return false;
284
285         CSQC_BEGIN
286                 if (!prog->funcoffsets.CSQC_InputEvent)
287                         r = false;
288                 else
289                 {
290                         prog->globals.client->time = cl.time;
291                         prog->globals.client->self = cl.csqc_server2csqcentitynumber[cl.playerentity];
292                         PRVM_G_FLOAT(OFS_PARM0) = !down; // 0 is down, 1 is up
293                         PRVM_G_FLOAT(OFS_PARM1) = key;
294                         PRVM_G_FLOAT(OFS_PARM2) = ascii;
295                         PRVM_ExecuteProgram(prog->funcoffsets.CSQC_InputEvent, "QC function CSQC_InputEvent is missing");
296                         r = CSQC_RETURNVAL != 0;
297                 }
298         CSQC_END
299         return r;
300 }
301
302 qboolean CL_VM_UpdateView (void)
303 {
304         vec3_t emptyvector;
305         emptyvector[0] = 0;
306         emptyvector[1] = 0;
307         emptyvector[2] = 0;
308 //      vec3_t oldangles;
309         if(!cl.csqc_loaded)
310                 return false;
311         CSQC_BEGIN
312                 //VectorCopy(cl.viewangles, oldangles);
313                 prog->globals.client->time = cl.time;
314                 prog->globals.client->self = cl.csqc_server2csqcentitynumber[cl.playerentity];
315                 CSQC_SetGlobals();
316                 // clear renderable entity and light lists to prevent crashes if the
317                 // CSQC_UpdateView function does not call R_ClearScene as it should
318                 r_refdef.scene.numentities = 0;
319                 r_refdef.scene.numlights = 0;
320                 // pass in width and height as parameters (EXT_CSQC_1)
321                 PRVM_G_FLOAT(OFS_PARM0) = vid.width;
322                 PRVM_G_FLOAT(OFS_PARM1) = vid.height;
323                 PRVM_ExecuteProgram(prog->funcoffsets.CSQC_UpdateView, "QC function CSQC_UpdateView is missing");
324                 //VectorCopy(oldangles, cl.viewangles);
325                 // Dresk : Reset Dmg Globals Here
326                 CL_VM_UpdateDmgGlobals(0, 0, emptyvector);
327         CSQC_END
328         return true;
329 }
330
331 extern sizebuf_t vm_tempstringsbuf;
332 qboolean CL_VM_ConsoleCommand (const char *cmd)
333 {
334         int restorevm_tempstringsbuf_cursize;
335         qboolean r = false;
336         if(!cl.csqc_loaded)
337                 return false;
338         CSQC_BEGIN
339         if (prog->funcoffsets.CSQC_ConsoleCommand)
340         {
341                 prog->globals.client->time = cl.time;
342                 prog->globals.client->self = cl.csqc_server2csqcentitynumber[cl.playerentity];
343                 restorevm_tempstringsbuf_cursize = vm_tempstringsbuf.cursize;
344                 PRVM_G_INT(OFS_PARM0) = PRVM_SetTempString(cmd);
345                 PRVM_ExecuteProgram(prog->funcoffsets.CSQC_ConsoleCommand, "QC function CSQC_ConsoleCommand is missing");
346                 vm_tempstringsbuf.cursize = restorevm_tempstringsbuf_cursize;
347                 r = CSQC_RETURNVAL != 0;
348         }
349         CSQC_END
350         return r;
351 }
352
353 qboolean CL_VM_Parse_TempEntity (void)
354 {
355         int                     t;
356         qboolean        r = false;
357         if(!cl.csqc_loaded)
358                 return false;
359         CSQC_BEGIN
360         if(prog->funcoffsets.CSQC_Parse_TempEntity)
361         {
362                 t = msg_readcount;
363                 prog->globals.client->time = cl.time;
364                 prog->globals.client->self = cl.csqc_server2csqcentitynumber[cl.playerentity];
365                 PRVM_ExecuteProgram(prog->funcoffsets.CSQC_Parse_TempEntity, "QC function CSQC_Parse_TempEntity is missing");
366                 r = CSQC_RETURNVAL != 0;
367                 if(!r)
368                 {
369                         msg_readcount = t;
370                         msg_badread = false;
371                 }
372         }
373         CSQC_END
374         return r;
375 }
376
377 void CL_VM_Parse_StuffCmd (const char *msg)
378 {
379         int restorevm_tempstringsbuf_cursize;
380         if(msg[0] == 'c')
381         if(msg[1] == 's')
382         if(msg[2] == 'q')
383         if(msg[3] == 'c')
384         {
385                 // if this is setting a csqc variable, deprotect csqc_progcrc
386                 // temporarily so that it can be set by the cvar command,
387                 // and then reprotect it afterwards
388                 int crcflags = csqc_progcrc.flags;
389                 int sizeflags = csqc_progcrc.flags;
390                 csqc_progcrc.flags &= ~CVAR_READONLY;
391                 csqc_progsize.flags &= ~CVAR_READONLY;
392                 Cmd_ExecuteString (msg, src_command);
393                 csqc_progcrc.flags = crcflags;
394                 csqc_progsize.flags = sizeflags;
395                 return;
396         }
397
398         if(cls.demoplayback)
399         if(!strncmp(msg, "curl --clear_autodownload\ncurl --pak --forthismap --as ", 55))
400         {
401                 // special handling for map download commands
402                 // run these commands IMMEDIATELY, instead of waiting for a client frame
403                 // that way, there is no black screen when playing back demos
404                 // I know this is a really ugly hack, but I can't think of any better way
405                 // FIXME find the actual CAUSE of this, and make demo playback WAIT
406                 // until all maps are loaded, then remove this hack
407
408                 char buf[MAX_INPUTLINE];
409                 const char *p, *q;
410                 size_t l;
411
412                 p = msg;
413
414                 for(;;)
415                 {
416                         q = strchr(p, '\n');
417                         if(q)
418                                 l = q - p;
419                         else
420                                 l = strlen(p);
421                         if(l > sizeof(buf) - 1)
422                                 l = sizeof(buf) - 1;
423                         strlcpy(buf, p, l + 1); // strlcpy needs a + 1 as it includes the newline!
424
425                         Cmd_ExecuteString(buf, src_command);
426
427                         p += l;
428                         if(*p == '\n')
429                                 ++p; // skip the newline and continue
430                         else
431                                 break; // end of string or overflow
432                 }
433                 Cmd_ExecuteString("curl --clear_autodownload", src_command); // don't inhibit CSQC loading
434                 return;
435         }
436
437         if(!cl.csqc_loaded)
438         {
439                 Cbuf_AddText(msg);
440                 return;
441         }
442         CSQC_BEGIN
443         if(prog->funcoffsets.CSQC_Parse_StuffCmd)
444         {
445                 prog->globals.client->time = cl.time;
446                 prog->globals.client->self = cl.csqc_server2csqcentitynumber[cl.playerentity];
447                 restorevm_tempstringsbuf_cursize = vm_tempstringsbuf.cursize;
448                 PRVM_G_INT(OFS_PARM0) = PRVM_SetTempString(msg);
449                 PRVM_ExecuteProgram(prog->funcoffsets.CSQC_Parse_StuffCmd, "QC function CSQC_Parse_StuffCmd is missing");
450                 vm_tempstringsbuf.cursize = restorevm_tempstringsbuf_cursize;
451         }
452         else
453                 Cbuf_AddText(msg);
454         CSQC_END
455 }
456
457 static void CL_VM_Parse_Print (const char *msg)
458 {
459         int restorevm_tempstringsbuf_cursize;
460         prog->globals.client->time = cl.time;
461         prog->globals.client->self = cl.csqc_server2csqcentitynumber[cl.playerentity];
462         restorevm_tempstringsbuf_cursize = vm_tempstringsbuf.cursize;
463         PRVM_G_INT(OFS_PARM0) = PRVM_SetTempString(msg);
464         PRVM_ExecuteProgram(prog->funcoffsets.CSQC_Parse_Print, "QC function CSQC_Parse_Print is missing");
465         vm_tempstringsbuf.cursize = restorevm_tempstringsbuf_cursize;
466 }
467
468 void CSQC_AddPrintText (const char *msg)
469 {
470         size_t i;
471         if(!cl.csqc_loaded)
472         {
473                 Con_Print(msg);
474                 return;
475         }
476         CSQC_BEGIN
477         if(prog->funcoffsets.CSQC_Parse_Print)
478         {
479                 // FIXME: is this bugged?
480                 i = strlen(msg)-1;
481                 if(msg[i] != '\n' && msg[i] != '\r')
482                 {
483                         if(strlen(cl.csqc_printtextbuf)+i >= MAX_INPUTLINE)
484                         {
485                                 CL_VM_Parse_Print(cl.csqc_printtextbuf);
486                                 cl.csqc_printtextbuf[0] = 0;
487                         }
488                         else
489                                 strlcat(cl.csqc_printtextbuf, msg, MAX_INPUTLINE);
490                         return;
491                 }
492                 strlcat(cl.csqc_printtextbuf, msg, MAX_INPUTLINE);
493                 CL_VM_Parse_Print(cl.csqc_printtextbuf);
494                 cl.csqc_printtextbuf[0] = 0;
495         }
496         else
497                 Con_Print(msg);
498         CSQC_END
499 }
500
501 void CL_VM_Parse_CenterPrint (const char *msg)
502 {
503         int restorevm_tempstringsbuf_cursize;
504         if(!cl.csqc_loaded)
505         {
506                 SCR_CenterPrint(msg);
507                 return;
508         }
509         CSQC_BEGIN
510         if(prog->funcoffsets.CSQC_Parse_CenterPrint)
511         {
512                 prog->globals.client->time = cl.time;
513                 prog->globals.client->self = cl.csqc_server2csqcentitynumber[cl.playerentity];
514                 restorevm_tempstringsbuf_cursize = vm_tempstringsbuf.cursize;
515                 PRVM_G_INT(OFS_PARM0) = PRVM_SetTempString(msg);
516                 PRVM_ExecuteProgram(prog->funcoffsets.CSQC_Parse_CenterPrint, "QC function CSQC_Parse_CenterPrint is missing");
517                 vm_tempstringsbuf.cursize = restorevm_tempstringsbuf_cursize;
518         }
519         else
520                 SCR_CenterPrint(msg);
521         CSQC_END
522 }
523
524 void CL_VM_UpdateIntermissionState (int intermission)
525 {
526         prvm_eval_t *val;
527         if(cl.csqc_loaded)
528         {
529                 CSQC_BEGIN
530                 val = PRVM_GLOBALFIELDVALUE(prog->globaloffsets.intermission);
531                 if(val)
532                         val->_float = intermission;
533                 CSQC_END
534         }
535 }
536 void CL_VM_UpdateShowingScoresState (int showingscores)
537 {
538         prvm_eval_t *val;
539         if(cl.csqc_loaded)
540         {
541                 CSQC_BEGIN
542                 val = PRVM_GLOBALFIELDVALUE(prog->globaloffsets.sb_showscores);
543                 if(val)
544                         val->_float = showingscores;
545                 CSQC_END
546         }
547 }
548 qboolean CL_VM_Event_Sound(int sound_num, float volume, int channel, float attenuation, int ent, vec3_t pos)
549 {
550         qboolean r = false;
551         if(cl.csqc_loaded)
552         {
553                 CSQC_BEGIN
554                 if(prog->funcoffsets.CSQC_Event_Sound)
555                 {
556                         prog->globals.client->time = cl.time;
557                         prog->globals.client->self = cl.csqc_server2csqcentitynumber[cl.playerentity];
558                         PRVM_G_FLOAT(OFS_PARM0) = ent;
559                         PRVM_G_FLOAT(OFS_PARM1) = channel;
560                         PRVM_G_INT(OFS_PARM2) = PRVM_SetTempString(cl.sound_name[sound_num] );
561                         PRVM_G_FLOAT(OFS_PARM3) = volume;
562                         PRVM_G_FLOAT(OFS_PARM4) = attenuation;
563                         VectorCopy(pos, PRVM_G_VECTOR(OFS_PARM5) );
564                         PRVM_ExecuteProgram(prog->funcoffsets.CSQC_Event_Sound, "QC function CSQC_Event_Sound is missing");
565                         r = CSQC_RETURNVAL != 0;
566                 }
567                 CSQC_END
568         }
569
570         return r;
571 }
572 void CL_VM_UpdateCoopDeathmatchGlobals (int gametype)
573 {
574         // Avoid global names for clean(er) coding
575         int localcoop;
576         int localdeathmatch;
577
578         prvm_eval_t *val;
579         if(cl.csqc_loaded)
580         {
581                 if(gametype == GAME_COOP)
582                 {
583                         localcoop = 1;
584                         localdeathmatch = 0;
585                 }
586                 else
587                 if(gametype == GAME_DEATHMATCH)
588                 {
589                         localcoop = 0;
590                         localdeathmatch = 1;
591                 }
592                 else
593                 {
594                         // How did the ServerInfo send an unknown gametype?
595                         // Better just assign the globals as 0...
596                         localcoop = 0;
597                         localdeathmatch = 0;
598                 }
599                 CSQC_BEGIN
600                 val = PRVM_GLOBALFIELDVALUE(prog->globaloffsets.coop);
601                 if(val)
602                         val->_float = localcoop;
603                 val = PRVM_GLOBALFIELDVALUE(prog->globaloffsets.deathmatch);
604                 if(val)
605                         val->_float = localdeathmatch;
606                 CSQC_END
607         }
608 }
609 float CL_VM_Event (float event)         //[515]: needed ? I'd say "YES", but don't know for what :D
610 {
611         float r = 0;
612         if(!cl.csqc_loaded)
613                 return 0;
614         CSQC_BEGIN
615         if(prog->funcoffsets.CSQC_Event)
616         {
617                 prog->globals.client->time = cl.time;
618                 prog->globals.client->self = cl.csqc_server2csqcentitynumber[cl.playerentity];
619                 PRVM_G_FLOAT(OFS_PARM0) = event;
620                 PRVM_ExecuteProgram(prog->funcoffsets.CSQC_Event, "QC function CSQC_Event is missing");
621                 r = CSQC_RETURNVAL;
622         }
623         CSQC_END
624         return r;
625 }
626
627 void CSQC_ReadEntities (void)
628 {
629         unsigned short entnum, oldself, realentnum;
630         if(!cl.csqc_loaded)
631         {
632                 Host_Error ("CSQC_ReadEntities: CSQC is not loaded");
633                 return;
634         }
635
636         CSQC_BEGIN
637                 prog->globals.client->time = cl.time;
638                 oldself = prog->globals.client->self;
639                 while(1)
640                 {
641                         entnum = MSG_ReadShort();
642                         if(!entnum || msg_badread)
643                                 return;
644                         realentnum = entnum & 0x7FFF;
645                         prog->globals.client->self = cl.csqc_server2csqcentitynumber[realentnum];
646                         if(entnum & 0x8000)
647                         {
648                                 if(prog->globals.client->self)
649                                 {
650                                         PRVM_ExecuteProgram(prog->funcoffsets.CSQC_Ent_Remove, "QC function CSQC_Ent_Remove is missing");
651                                         cl.csqc_server2csqcentitynumber[realentnum] = 0;
652                                 }
653                                 else
654                                 {
655                                         // LordHavoc: removing an entity that is already gone on
656                                         // the csqc side is possible for legitimate reasons (such
657                                         // as a repeat of the remove message), so no warning is
658                                         // needed
659                                         //Con_Printf("Bad csqc_server2csqcentitynumber map\n"); //[515]: never happens ?
660                                 }
661                         }
662                         else
663                         {
664                                 if(!prog->globals.client->self)
665                                 {
666                                         if(!prog->funcoffsets.CSQC_Ent_Spawn)
667                                         {
668                                                 prvm_edict_t    *ed;
669                                                 ed = PRVM_ED_Alloc();
670                                                 ed->fields.client->entnum = realentnum;
671                                                 prog->globals.client->self = cl.csqc_server2csqcentitynumber[realentnum] = PRVM_EDICT_TO_PROG(ed);
672                                         }
673                                         else
674                                         {
675                                                 // entity( float entnum ) CSQC_Ent_Spawn;
676                                                 // the qc function should set entnum, too (this way it also can return world [2/1/2008 Andreas]
677                                                 PRVM_G_FLOAT(OFS_PARM0) = (float) realentnum;
678                                                 // make sure no one gets wrong ideas
679                                                 prog->globals.client->self = 0;
680                                                 PRVM_ExecuteProgram(prog->funcoffsets.CSQC_Ent_Spawn, "QC function CSQC_Ent_Spawn is missing");
681                                                 prog->globals.client->self = cl.csqc_server2csqcentitynumber[realentnum] = PRVM_EDICT( PRVM_G_INT( OFS_RETURN ) );
682                                         }
683                                         PRVM_G_FLOAT(OFS_PARM0) = 1;
684                                         PRVM_ExecuteProgram(prog->funcoffsets.CSQC_Ent_Update, "QC function CSQC_Ent_Update is missing");
685                                 }
686                                 else {
687                                         PRVM_G_FLOAT(OFS_PARM0) = 0;
688                                         PRVM_ExecuteProgram(prog->funcoffsets.CSQC_Ent_Update, "QC function CSQC_Ent_Update is missing");
689                                 }
690                         }
691                 }
692                 prog->globals.client->self = oldself;
693         CSQC_END
694 }
695
696 void CL_VM_CB_BeginIncreaseEdicts(void)
697 {
698         // links don't survive the transition, so unlink everything
699         World_UnlinkAll(&cl.world);
700 }
701
702 void CL_VM_CB_EndIncreaseEdicts(void)
703 {
704         int i;
705         prvm_edict_t *ent;
706
707         // link every entity except world
708         for (i = 1, ent = prog->edicts;i < prog->max_edicts;i++, ent++)
709                 if (!ent->priv.server->free)
710                         CL_LinkEdict(ent);
711 }
712
713 void CL_VM_CB_InitEdict(prvm_edict_t *e)
714 {
715         e->priv.server->move = false; // don't move on first frame
716 }
717
718 void CL_VM_CB_FreeEdict(prvm_edict_t *ed)
719 {
720         World_UnlinkEdict(ed);
721         memset(ed->fields.client, 0, sizeof(*ed->fields.client));
722 }
723
724 void CL_VM_CB_CountEdicts(void)
725 {
726         int             i;
727         prvm_edict_t    *ent;
728         int             active = 0, models = 0, solid = 0;
729
730         for (i=0 ; i<prog->num_edicts ; i++)
731         {
732                 ent = PRVM_EDICT_NUM(i);
733                 if (ent->priv.server->free)
734                         continue;
735                 active++;
736                 if (ent->fields.client->solid)
737                         solid++;
738                 if (ent->fields.client->model)
739                         models++;
740         }
741
742         Con_Printf("num_edicts:%3i\n", prog->num_edicts);
743         Con_Printf("active    :%3i\n", active);
744         Con_Printf("view      :%3i\n", models);
745         Con_Printf("touch     :%3i\n", solid);
746 }
747
748 qboolean CL_VM_CB_LoadEdict(prvm_edict_t *ent)
749 {
750         return true;
751 }
752
753 void Cmd_ClearCsqcFuncs (void);
754
755 // returns true if the packet is valid, false if end of file is reached
756 // used for dumping the CSQC download into demo files
757 qboolean MakeDownloadPacket(const char *filename, unsigned char *data, unsigned long len, int crc, int cnt, sizebuf_t *buf, int protocol)
758 {
759         int packetsize = buf->maxsize - 7; // byte short long
760         int npackets = (len + packetsize - 1) / (packetsize);
761
762         if(protocol == PROTOCOL_QUAKEWORLD)
763                 return false; // CSQC can't run in QW anyway
764
765         SZ_Clear(buf);
766         if(cnt == 0)
767         {
768                 MSG_WriteByte(buf, svc_stufftext);
769                 MSG_WriteString(buf, va("\ncl_downloadbegin %lu %s\n", len, filename));
770                 return true;
771         }
772         else if(cnt >= 1 && cnt <= npackets)
773         {
774                 unsigned long thispacketoffset = (cnt - 1) * packetsize;
775                 int thispacketsize = len - thispacketoffset;
776                 if(thispacketsize > packetsize)
777                         thispacketsize = packetsize;
778
779                 MSG_WriteByte(buf, svc_downloaddata);
780                 MSG_WriteLong(buf, thispacketoffset);
781                 MSG_WriteShort(buf, thispacketsize);
782                 SZ_Write(buf, data + thispacketoffset, thispacketsize);
783
784                 return true;
785         }
786         else if(cnt == npackets + 1)
787         {
788                 MSG_WriteByte(buf, svc_stufftext);
789                 MSG_WriteString(buf, va("\ncl_downloadfinished %lu %d\n", len, crc));
790                 return true;
791         }
792         return false;
793 }
794
795 void CL_VM_Init (void)
796 {
797         const char* csprogsfn;
798         unsigned char *csprogsdata;
799         fs_offset_t csprogsdatasize;
800         int csprogsdatacrc, requiredcrc;
801         int requiredsize;
802         prvm_eval_t *val;
803
804         // reset csqc_progcrc after reading it, so that changing servers doesn't
805         // expect csqc on the next server
806         requiredcrc = csqc_progcrc.integer;
807         requiredsize = csqc_progsize.integer;
808         Cvar_SetValueQuick(&csqc_progcrc, -1);
809         Cvar_SetValueQuick(&csqc_progsize, -1);
810
811         // if the server is not requesting a csprogs, then we're done here
812         if (requiredcrc < 0)
813                 return;
814
815         // see if the requested csprogs.dat file matches the requested crc
816         csprogsdatacrc = -1;
817         csprogsfn = va("dlcache/%s.%i.%i", csqc_progname.string, requiredsize, requiredcrc);
818         csprogsdata = FS_LoadFile(csprogsfn, tempmempool, true, &csprogsdatasize);
819         if (!csprogsdata)
820         {
821                 csprogsfn = csqc_progname.string;
822                 csprogsdata = FS_LoadFile(csprogsfn, tempmempool, true, &csprogsdatasize);
823         }
824         if (csprogsdata)
825         {
826                 csprogsdatacrc = CRC_Block(csprogsdata, csprogsdatasize);
827                 if (csprogsdatacrc != requiredcrc || csprogsdatasize != requiredsize)
828                 {
829                         if (cls.demoplayback)
830                         {
831                                 Con_Printf("^1Warning: Your %s is not the same version as the demo was recorded with (CRC/size are %i/%i but should be %i/%i)\n", csqc_progname.string, csprogsdatacrc, (int)csprogsdatasize, requiredcrc, requiredsize);
832                                 // Mem_Free(csprogsdata);
833                                 // return;
834                                 // We WANT to continue here, and play the demo with different csprogs!
835                                 // After all, this is just a warning. Sure things may go wrong from here.
836                         }
837                         else
838                         {
839                                 Mem_Free(csprogsdata);
840                                 Con_Printf("^1Your %s is not the same version as the server (CRC is %i/%i but should be %i/%i)\n", csqc_progname.string, csprogsdatacrc, (int)csprogsdatasize, requiredcrc, requiredsize);
841                                 CL_Disconnect();
842                                 return;
843                         }
844                 }
845         }
846         else
847         {
848                 if (requiredcrc >= 0)
849                 {
850                         if (cls.demoplayback)
851                                 Con_Printf("CL_VM_Init: demo requires CSQC, but \"%s\" wasn't found\n", csqc_progname.string);
852                         else
853                                 Con_Printf("CL_VM_Init: server requires CSQC, but \"%s\" wasn't found\n", csqc_progname.string);
854                         CL_Disconnect();
855                 }
856                 return;
857         }
858
859         PRVM_Begin;
860         PRVM_InitProg(PRVM_CLIENTPROG);
861
862         // allocate the mempools
863         prog->progs_mempool = Mem_AllocPool(csqc_progname.string, 0, NULL);
864         prog->headercrc = CL_PROGHEADER_CRC;
865         prog->edictprivate_size = 0; // no private struct used
866         prog->name = CL_NAME;
867         prog->num_edicts = 1;
868         prog->max_edicts = 512;
869         prog->limit_edicts = CL_MAX_EDICTS;
870         prog->reserved_edicts = 0;
871         prog->edictprivate_size = sizeof(edict_engineprivate_t);
872         // TODO: add a shared extension string #define and add real support for csqc extension strings [12/5/2007 Black]
873         prog->extensionstring = vm_sv_extensions;
874         prog->builtins = vm_cl_builtins;
875         prog->numbuiltins = vm_cl_numbuiltins;
876         prog->begin_increase_edicts = CL_VM_CB_BeginIncreaseEdicts;
877         prog->end_increase_edicts = CL_VM_CB_EndIncreaseEdicts;
878         prog->init_edict = CL_VM_CB_InitEdict;
879         prog->free_edict = CL_VM_CB_FreeEdict;
880         prog->count_edicts = CL_VM_CB_CountEdicts;
881         prog->load_edict = CL_VM_CB_LoadEdict;
882         prog->init_cmd = VM_CL_Cmd_Init;
883         prog->reset_cmd = VM_CL_Cmd_Reset;
884         prog->error_cmd = CL_VM_Error;
885
886         PRVM_LoadProgs(csprogsfn, cl_numrequiredfunc, cl_required_func, 0, NULL, 0, NULL);
887
888         if (!prog->loaded)
889         {
890                 CL_VM_Error("CSQC %s ^2failed to load\n", csprogsfn);
891                 if(!sv.active)
892                         CL_Disconnect();
893                 Mem_Free(csprogsdata);
894                 return;
895         }
896
897         Con_Printf("CSQC %s ^5loaded (crc=%i, size=%i)\n", csprogsfn, csprogsdatacrc, (int)csprogsdatasize);
898
899         if(cls.demorecording)
900         {
901                 if(cls.demo_lastcsprogssize != csprogsdatasize || cls.demo_lastcsprogscrc != csprogsdatacrc)
902                 {
903                         int i;
904                         char buf[NET_MAXMESSAGE];
905                         sizebuf_t sb;
906                         unsigned char *demobuf; fs_offset_t demofilesize;
907
908                         sb.data = (unsigned char *) buf;
909                         sb.maxsize = sizeof(buf);
910                         i = 0;
911
912                         CL_CutDemo(&demobuf, &demofilesize);
913                         while(MakeDownloadPacket(csqc_progname.string, csprogsdata, csprogsdatasize, csprogsdatacrc, i++, &sb, cls.protocol))
914                                 CL_WriteDemoMessage(&sb);
915                         CL_PasteDemo(&demobuf, &demofilesize);
916
917                         cls.demo_lastcsprogssize = csprogsdatasize;
918                         cls.demo_lastcsprogscrc = csprogsdatacrc;
919                 }
920         }
921         Mem_Free(csprogsdata);
922
923         // check if OP_STATE animation is possible in this dat file
924         if (prog->fieldoffsets.nextthink >= 0 && prog->fieldoffsets.frame >= 0 && prog->fieldoffsets.think >= 0 && prog->globaloffsets.self >= 0)
925                 prog->flag |= PRVM_OP_STATE;
926
927         // set time
928         prog->globals.client->time = cl.time;
929         prog->globals.client->self = 0;
930
931         prog->globals.client->mapname = cl.worldmodel ? PRVM_SetEngineString(cl.worldmodel->name) : PRVM_SetEngineString("");
932         prog->globals.client->player_localentnum = cl.playerentity;
933
934         // set map description (use world entity 0)
935         val = PRVM_EDICTFIELDVALUE(prog->edicts, prog->fieldoffsets.message);
936         if(val)
937                 val->string = PRVM_SetEngineString(cl.levelname);
938         VectorCopy(cl.world.mins, prog->edicts->fields.client->mins);
939         VectorCopy(cl.world.maxs, prog->edicts->fields.client->maxs);
940
941         // call the prog init
942         PRVM_ExecuteProgram(prog->funcoffsets.CSQC_Init, "QC function CSQC_Init is missing");
943
944         PRVM_End;
945         cl.csqc_loaded = true;
946
947         cl.csqc_vidvars.drawcrosshair = false;
948         cl.csqc_vidvars.drawenginesbar = false;
949
950         // Update Coop and Deathmatch Globals (at this point the client knows them from ServerInfo)
951         CL_VM_UpdateCoopDeathmatchGlobals(cl.gametype);
952 }
953
954 void CL_VM_ShutDown (void)
955 {
956         Cmd_ClearCsqcFuncs();
957         //Cvar_SetValueQuick(&csqc_progcrc, -1);
958         //Cvar_SetValueQuick(&csqc_progsize, -1);
959         if(!cl.csqc_loaded)
960                 return;
961         CSQC_BEGIN
962                 prog->globals.client->time = cl.time;
963                 prog->globals.client->self = 0;
964                 if (prog->funcoffsets.CSQC_Shutdown)
965                         PRVM_ExecuteProgram(prog->funcoffsets.CSQC_Shutdown, "QC function CSQC_Shutdown is missing");
966                 PRVM_ResetProg();
967         CSQC_END
968         Con_Print("CSQC ^1unloaded\n");
969         cl.csqc_loaded = false;
970 }
971
972 qboolean CL_VM_GetEntitySoundOrigin(int entnum, vec3_t out)
973 {
974         prvm_edict_t *ed;
975         dp_model_t *mod;
976         matrix4x4_t matrix;
977         qboolean r = 0;
978
979         CSQC_BEGIN;
980
981         // FIXME consider attachments here!
982
983         ed = PRVM_EDICT_NUM(entnum - 32768);
984
985         if(!ed->priv.required->free)
986         {
987                 mod = CL_GetModelFromEdict(ed);
988                 VectorCopy(ed->fields.client->origin, out);
989                 if(CL_GetTagMatrix (&matrix, ed, 0) == 0)
990                         Matrix4x4_OriginFromMatrix(&matrix, out);
991                 if (mod && mod->soundfromcenter)
992                         VectorMAMAM(1.0f, out, 0.5f, mod->normalmins, 0.5f, mod->normalmaxs, out);
993                 r = 1;
994         }
995
996         CSQC_END;
997
998         return r;
999 }