sv_save.c

   1 /*
   2 Copyright (C) 1996-1997 Id Software, Inc.
   3
   4 This program is free software; you can redistribute it and/or
   5 modify it under the terms of the GNU General Public License
   6 as published by the Free Software Foundation; either version 2
   7 of the License, or (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  12
  13 See the GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18
  19 */
  20
  21 #include "quakedef.h"
  22 #include "prvm_cmds.h"
  23
  24 /*
  25 ===============================================================================
  26
  27 LOAD / SAVE GAME
  28
  29 ===============================================================================
  30 */
  31
  32 #define SAVEGAME_VERSION        5
  33
  34 void SV_Savegame_to(prvm_prog_t *prog, const char *name)
  35 {
  36         qfile_t *f;
  37         int             i, k, l, numbuffers, lightstyles = 64;
  38         char    comment[SAVEGAME_COMMENT_LENGTH+1];
  39         char    line[MAX_INPUTLINE];
  40         qbool isserver;
  41         char    *s;
  42
  43         // first we have to figure out if this can be saved in 64 lightstyles
  44         // (for Quake compatibility)
  45         for (i=64 ; i<MAX_LIGHTSTYLES ; i++)
  46                 if (sv.lightstyles[i][0])
  47                         lightstyles = i+1;
  48
  49         isserver = prog == SVVM_prog;
  50
  51         Con_Printf("Saving game to %s...\n", name);
  52         f = FS_OpenRealFile(name, "wb", false);
  53         if (!f)
  54         {
  55                 Con_Print("ERROR: couldn't open.\n");
  56                 return;
  57         }
  58
  59         FS_Printf(f, "%i\n", SAVEGAME_VERSION);
  60
  61         memset(comment, 0, sizeof(comment));
  62         if(isserver)
  63                 dpsnprintf(comment, sizeof(comment), "%-21.21s kills:%3i/%3i", PRVM_GetString(prog, PRVM_serveredictstring(prog->edicts, message)), (int)PRVM_serverglobalfloat(killed_monsters), (int)PRVM_serverglobalfloat(total_monsters));
  64         else
  65                 dpsnprintf(comment, sizeof(comment), "(crash dump of %s progs)", prog->name);
  66         // convert space to _ to make stdio happy
  67         // LadyHavoc: convert control characters to _ as well
  68         for (i=0 ; i<SAVEGAME_COMMENT_LENGTH ; i++)
  69                 if (ISWHITESPACEORCONTROL(comment[i]))
  70                         comment[i] = '_';
  71         comment[SAVEGAME_COMMENT_LENGTH] = '\0';
  72
  73         FS_Printf(f, "%s\n", comment);
  74         if(isserver)
  75         {
  76                 for (i=0 ; i<NUM_SPAWN_PARMS ; i++)
  77                         FS_Printf(f, "%f\n", svs.clients[0].spawn_parms[i]);
  78                 FS_Printf(f, "%d\n", current_skill);
  79                 FS_Printf(f, "%s\n", sv.name);
  80                 FS_Printf(f, "%f\n",sv.time);
  81         }
  82         else
  83         {
  84                 for (i=0 ; i<NUM_SPAWN_PARMS ; i++)
  85                         FS_Printf(f, "(dummy)\n");
  86                 FS_Printf(f, "%d\n", 0);
  87                 FS_Printf(f, "%s\n", "(dummy)");
  88                 FS_Printf(f, "%f\n", host.realtime);
  89         }
  90
  91         // write the light styles
  92         for (i=0 ; i<lightstyles ; i++)
  93         {
  94                 if (isserver && sv.lightstyles[i][0])
  95                         FS_Printf(f, "%s\n", sv.lightstyles[i]);
  96                 else
  97                         FS_Print(f,"m\n");
  98         }
  99
 100         PRVM_ED_WriteGlobals (prog, f);
 101         for (i=0 ; i<prog->num_edicts ; i++)
 102         {
 103                 FS_Printf(f,"// edict %d\n", i);
 104                 //Con_Printf("edict %d...\n", i);
 105                 PRVM_ED_Write (prog, f, PRVM_EDICT_NUM(i));
 106         }
 107
 108 #if 1
 109         FS_Printf(f,"/*\n");
 110         FS_Printf(f,"// DarkPlaces extended savegame\n");
 111         // darkplaces extension - extra lightstyles, support for color lightstyles
 112         for (i=0 ; i<MAX_LIGHTSTYLES ; i++)
 113                 if (isserver && sv.lightstyles[i][0])
 114                         FS_Printf(f, "sv.lightstyles %i %s\n", i, sv.lightstyles[i]);
 115
 116         // darkplaces extension - model precaches
 117         for (i=1 ; i<MAX_MODELS ; i++)
 118                 if (sv.model_precache[i][0])
 119                         FS_Printf(f,"sv.model_precache %i %s\n", i, sv.model_precache[i]);
 120
 121         // darkplaces extension - sound precaches
 122         for (i=1 ; i<MAX_SOUNDS ; i++)
 123                 if (sv.sound_precache[i][0])
 124                         FS_Printf(f,"sv.sound_precache %i %s\n", i, sv.sound_precache[i]);
 125
 126         // darkplaces extension - save buffers
 127         numbuffers = (int)Mem_ExpandableArray_IndexRange(&prog->stringbuffersarray);
 128         for (i = 0; i < numbuffers; i++)
 129         {
 130                 prvm_stringbuffer_t *stringbuffer = (prvm_stringbuffer_t*) Mem_ExpandableArray_RecordAtIndex(&prog->stringbuffersarray, i);
 131                 if(stringbuffer && (stringbuffer->flags & STRINGBUFFER_SAVED))
 132                 {
 133                         FS_Printf(f,"sv.buffer %i %i \"string\"\n", i, stringbuffer->flags & STRINGBUFFER_QCFLAGS);
 134                         for(k = 0; k < stringbuffer->num_strings; k++)
 135                         {
 136                                 if (!stringbuffer->strings[k])
 137                                         continue;
 138                                 // Parse the string a bit to turn special characters
 139                                 // (like newline, specifically) into escape codes
 140                                 s = stringbuffer->strings[k];
 141                                 for (l = 0;l < (int)sizeof(line) - 2 && *s;)
 142                                 {
 143                                         if (*s == '\n')
 144                                         {
 145                                                 line[l++] = '\\';
 146                                                 line[l++] = 'n';
 147                                         }
 148                                         else if (*s == '\r')
 149                                         {
 150                                                 line[l++] = '\\';
 151                                                 line[l++] = 'r';
 152                                         }
 153                                         else if (*s == '\\')
 154                                         {
 155                                                 line[l++] = '\\';
 156                                                 line[l++] = '\\';
 157                                         }
 158                                         else if (*s == '"')
 159                                         {
 160                                                 line[l++] = '\\';
 161                                                 line[l++] = '"';
 162                                         }
 163                                         else
 164                                                 line[l++] = *s;
 165                                         s++;
 166                                 }
 167                                 line[l] = '\0';
 168                                 FS_Printf(f,"sv.bufstr %i %i \"%s\"\n", i, k, line);
 169                         }
 170                 }
 171         }
 172         FS_Printf(f,"*/\n");
 173 #endif
 174
 175         FS_Close (f);
 176         Con_Print("done.\n");
 177 }
 178
 179 /*
 180 ===============
 181 SV_Savegame_f
 182 ===============
 183 */
 184 void SV_Savegame_f(cmd_state_t *cmd)
 185 {
 186         prvm_prog_t *prog = SVVM_prog;
 187         char    name[MAX_QPATH];
 188
 189         if (!sv.active)
 190         {
 191                 Con_Print("Can't save - no server running.\n");
 192                 return;
 193         }
 194
 195         if(host.hook.SV_CanSave)
 196         {
 197                 if(!host.hook.SV_CanSave())
 198                         return;
 199         }
 200
 201         if (Cmd_Argc(cmd) != 2)
 202         {
 203                 Con_Print("save <savename> : save a game\n");
 204                 return;
 205         }
 206
 207         if (strstr(Cmd_Argv(cmd, 1), ".."))
 208         {
 209                 Con_Print("Relative pathnames are not allowed.\n");
 210                 return;
 211         }
 212
 213         strlcpy (name, Cmd_Argv(cmd, 1), sizeof (name));
 214         FS_DefaultExtension (name, ".sav", sizeof (name));
 215
 216         SV_Savegame_to(prog, name);
 217 }
 218
 219 /*
 220 ===============
 221 SV_Loadgame_f
 222 ===============
 223 */
 224 void SV_Loadgame_f(cmd_state_t *cmd)
 225 {
 226         prvm_prog_t *prog = SVVM_prog;
 227         char filename[MAX_QPATH];
 228         char mapname[MAX_QPATH];
 229         float time;
 230         const char *start;
 231         const char *end;
 232         const char *t;
 233         char *text;
 234         prvm_edict_t *ent;
 235         int i, k, numbuffers;
 236         int entnum;
 237         int version;
 238         float spawn_parms[NUM_SPAWN_PARMS];
 239         prvm_stringbuffer_t *stringbuffer;
 240
 241         if (Cmd_Argc(cmd) != 2)
 242         {
 243                 Con_Print("load <savename> : load a game\n");
 244                 return;
 245         }
 246
 247         strlcpy (filename, Cmd_Argv(cmd, 1), sizeof(filename));
 248         FS_DefaultExtension (filename, ".sav", sizeof (filename));
 249
 250         Con_Printf("Loading game from %s...\n", filename);
 251
 252         // stop playing demos
 253         if (cls.demoplayback)
 254                 CL_Disconnect ();
 255
 256 #ifdef CONFIG_MENU
 257         // remove menu
 258         if (key_dest == key_menu || key_dest == key_menu_grabbed)
 259                 MR_ToggleMenu(0);
 260 #endif
 261         key_dest = key_game;
 262
 263         cls.demonum = -1;               // stop demo loop in case this fails
 264
 265         t = text = (char *)FS_LoadFile (filename, tempmempool, false, NULL);
 266         if (!text)
 267         {
 268                 Con_Print("ERROR: couldn't open.\n");
 269                 return;
 270         }
 271
 272         if(developer_entityparsing.integer)
 273                 Con_Printf("SV_Loadgame_f: loading version\n");
 274
 275         // version
 276         COM_ParseToken_Simple(&t, false, false, true);
 277         version = atoi(com_token);
 278         if (version != SAVEGAME_VERSION)
 279         {
 280                 Mem_Free(text);
 281                 Con_Printf("Savegame is version %i, not %i\n", version, SAVEGAME_VERSION);
 282                 return;
 283         }
 284
 285         if(developer_entityparsing.integer)
 286                 Con_Printf("SV_Loadgame_f: loading description\n");
 287
 288         // description
 289         COM_ParseToken_Simple(&t, false, false, true);
 290
 291         for (i = 0;i < NUM_SPAWN_PARMS;i++)
 292         {
 293                 COM_ParseToken_Simple(&t, false, false, true);
 294                 spawn_parms[i] = atof(com_token);
 295         }
 296         // skill
 297         COM_ParseToken_Simple(&t, false, false, true);
 298 // this silliness is so we can load 1.06 save files, which have float skill values
 299         current_skill = (int)(atof(com_token) + 0.5);
 300         Cvar_SetValue (&cvars_all, "skill", (float)current_skill);
 301
 302         if(developer_entityparsing.integer)
 303                 Con_Printf("SV_Loadgame_f: loading mapname\n");
 304
 305         // mapname
 306         COM_ParseToken_Simple(&t, false, false, true);
 307         strlcpy (mapname, com_token, sizeof(mapname));
 308
 309         if(developer_entityparsing.integer)
 310                 Con_Printf("SV_Loadgame_f: loading time\n");
 311
 312         // time
 313         COM_ParseToken_Simple(&t, false, false, true);
 314         time = atof(com_token);
 315
 316         if(developer_entityparsing.integer)
 317                 Con_Printf("SV_Loadgame_f: spawning server\n");
 318
 319         SV_SpawnServer (mapname);
 320         if (!sv.active)
 321         {
 322                 Mem_Free(text);
 323                 Con_Print("Couldn't load map\n");
 324                 return;
 325         }
 326         sv.paused = true;               // pause until all clients connect
 327         sv.loadgame = true;
 328
 329         if(developer_entityparsing.integer)
 330                 Con_Printf("SV_Loadgame_f: loading light styles\n");
 331
 332 // load the light styles
 333
 334         // -1 is the globals
 335         entnum = -1;
 336
 337         for (i = 0;i < MAX_LIGHTSTYLES;i++)
 338         {
 339                 // light style
 340                 start = t;
 341                 COM_ParseToken_Simple(&t, false, false, true);
 342                 // if this is a 64 lightstyle savegame produced by Quake, stop now
 343                 // we have to check this because darkplaces may save more than 64
 344                 if (com_token[0] == '{')
 345                 {
 346                         t = start;
 347                         break;
 348                 }
 349                 strlcpy(sv.lightstyles[i], com_token, sizeof(sv.lightstyles[i]));
 350         }
 351
 352         if(developer_entityparsing.integer)
 353                 Con_Printf("SV_Loadgame_f: skipping until globals\n");
 354
 355         // now skip everything before the first opening brace
 356         // (this is for forward compatibility, so that older versions (at
 357         // least ones with this fix) can load savegames with extra data before the
 358         // first brace, as might be produced by a later engine version)
 359         for (;;)
 360         {
 361                 start = t;
 362                 if (!COM_ParseToken_Simple(&t, false, false, true))
 363                         break;
 364                 if (com_token[0] == '{')
 365                 {
 366                         t = start;
 367                         break;
 368                 }
 369         }
 370
 371         // unlink all entities
 372         World_UnlinkAll(&sv.world);
 373
 374 // load the edicts out of the savegame file
 375         end = t;
 376         for (;;)
 377         {
 378                 start = t;
 379                 while (COM_ParseToken_Simple(&t, false, false, true))
 380                         if (!strcmp(com_token, "}"))
 381                                 break;
 382                 if (!COM_ParseToken_Simple(&start, false, false, true))
 383                 {
 384                         // end of file
 385                         break;
 386                 }
 387                 if (strcmp(com_token,"{"))
 388                 {
 389                         Mem_Free(text);
 390                         Host_Error ("First token isn't a brace");
 391                 }
 392
 393                 if (entnum == -1)
 394                 {
 395                         if(developer_entityparsing.integer)
 396                                 Con_Printf("SV_Loadgame_f: loading globals\n");
 397
 398                         // parse the global vars
 399                         PRVM_ED_ParseGlobals (prog, start);
 400
 401                         // restore the autocvar globals
 402                         Cvar_UpdateAllAutoCvars(prog->console_cmd->cvars);
 403                 }
 404                 else
 405                 {
 406                         // parse an edict
 407                         if (entnum >= MAX_EDICTS)
 408                         {
 409                                 Mem_Free(text);
 410                                 Host_Error("Host_PerformLoadGame: too many edicts in save file (reached MAX_EDICTS %i)", MAX_EDICTS);
 411                         }
 412                         while (entnum >= prog->max_edicts)
 413                                 PRVM_MEM_IncreaseEdicts(prog);
 414                         ent = PRVM_EDICT_NUM(entnum);
 415                         memset(ent->fields.fp, 0, prog->entityfields * sizeof(prvm_vec_t));
 416                         ent->priv.server->free = false;
 417
 418                         if(developer_entityparsing.integer)
 419                                 Con_Printf("SV_Loadgame_f: loading edict %d\n", entnum);
 420
 421                         PRVM_ED_ParseEdict (prog, start, ent);
 422
 423                         // link it into the bsp tree
 424                         if (!ent->priv.server->free && !VectorCompare(PRVM_serveredictvector(ent, absmin), PRVM_serveredictvector(ent, absmax)))
 425                                 SV_LinkEdict(ent);
 426                 }
 427
 428                 end = t;
 429                 entnum++;
 430         }
 431
 432         prog->num_edicts = entnum;
 433         sv.time = time;
 434
 435         for (i = 0;i < NUM_SPAWN_PARMS;i++)
 436                 svs.clients[0].spawn_parms[i] = spawn_parms[i];
 437
 438         if(developer_entityparsing.integer)
 439                 Con_Printf("SV_Loadgame_f: skipping until extended data\n");
 440
 441         // read extended data if present
 442         // the extended data is stored inside a /* */ comment block, which the
 443         // parser intentionally skips, so we have to check for it manually here
 444         if(end)
 445         {
 446                 while (*end == '\r' || *end == '\n')
 447                         end++;
 448                 if (end[0] == '/' && end[1] == '*' && (end[2] == '\r' || end[2] == '\n'))
 449                 {
 450                         if(developer_entityparsing.integer)
 451                                 Con_Printf("SV_Loadgame_f: loading extended data\n");
 452
 453                         Con_Printf("Loading extended DarkPlaces savegame\n");
 454                         t = end + 2;
 455                         memset(sv.lightstyles[0], 0, sizeof(sv.lightstyles));
 456                         memset(sv.model_precache[0], 0, sizeof(sv.model_precache));
 457                         memset(sv.sound_precache[0], 0, sizeof(sv.sound_precache));
 458                         BufStr_Flush(prog);
 459
 460                         while (COM_ParseToken_Simple(&t, false, false, true))
 461                         {
 462                                 if (!strcmp(com_token, "sv.lightstyles"))
 463                                 {
 464                                         COM_ParseToken_Simple(&t, false, false, true);
 465                                         i = atoi(com_token);
 466                                         COM_ParseToken_Simple(&t, false, false, true);
 467                                         if (i >= 0 && i < MAX_LIGHTSTYLES)
 468                                                 strlcpy(sv.lightstyles[i], com_token, sizeof(sv.lightstyles[i]));
 469                                         else
 470                                                 Con_Printf("unsupported lightstyle %i \"%s\"\n", i, com_token);
 471                                 }
 472                                 else if (!strcmp(com_token, "sv.model_precache"))
 473                                 {
 474                                         COM_ParseToken_Simple(&t, false, false, true);
 475                                         i = atoi(com_token);
 476                                         COM_ParseToken_Simple(&t, false, false, true);
 477                                         if (i >= 0 && i < MAX_MODELS)
 478                                         {
 479                                                 strlcpy(sv.model_precache[i], com_token, sizeof(sv.model_precache[i]));
 480                                                 sv.models[i] = Mod_ForName (sv.model_precache[i], true, false, sv.model_precache[i][0] == '*' ? sv.worldname : NULL);
 481                                         }
 482                                         else
 483                                                 Con_Printf("unsupported model %i \"%s\"\n", i, com_token);
 484                                 }
 485                                 else if (!strcmp(com_token, "sv.sound_precache"))
 486                                 {
 487                                         COM_ParseToken_Simple(&t, false, false, true);
 488                                         i = atoi(com_token);
 489                                         COM_ParseToken_Simple(&t, false, false, true);
 490                                         if (i >= 0 && i < MAX_SOUNDS)
 491                                                 strlcpy(sv.sound_precache[i], com_token, sizeof(sv.sound_precache[i]));
 492                                         else
 493                                                 Con_Printf("unsupported sound %i \"%s\"\n", i, com_token);
 494                                 }
 495                                 else if (!strcmp(com_token, "sv.buffer"))
 496                                 {
 497                                         if (COM_ParseToken_Simple(&t, false, false, true))
 498                                         {
 499                                                 i = atoi(com_token);
 500                                                 if (i >= 0)
 501                                                 {
 502                                                         k = STRINGBUFFER_SAVED;
 503                                                         if (COM_ParseToken_Simple(&t, false, false, true))
 504                                                                 k |= atoi(com_token);
 505                                                         if (!BufStr_FindCreateReplace(prog, i, k, "string"))
 506                                                                 Con_Printf(CON_ERROR "failed to create stringbuffer %i\n", i);
 507                                                 }
 508                                                 else
 509                                                         Con_Printf("unsupported stringbuffer index %i \"%s\"\n", i, com_token);
 510                                         }
 511                                         else
 512                                                 Con_Printf("unexpected end of line when parsing sv.buffer (expected buffer index)\n");
 513                                 }
 514                                 else if (!strcmp(com_token, "sv.bufstr"))
 515                                 {
 516                                         if (!COM_ParseToken_Simple(&t, false, false, true))
 517                                                 Con_Printf("unexpected end of line when parsing sv.bufstr\n");
 518                                         else
 519                                         {
 520                                                 i = atoi(com_token);
 521                                                 stringbuffer = BufStr_FindCreateReplace(prog, i, STRINGBUFFER_SAVED, "string");
 522                                                 if (stringbuffer)
 523                                                 {
 524                                                         if (COM_ParseToken_Simple(&t, false, false, true))
 525                                                         {
 526                                                                 k = atoi(com_token);
 527                                                                 if (COM_ParseToken_Simple(&t, false, false, true))
 528                                                                         BufStr_Set(prog, stringbuffer, k, com_token);
 529                                                                 else
 530                                                                         Con_Printf("unexpected end of line when parsing sv.bufstr (expected string)\n");
 531                                                         }
 532                                                         else
 533                                                                 Con_Printf("unexpected end of line when parsing sv.bufstr (expected strindex)\n");
 534                                                 }
 535                                                 else
 536                                                         Con_Printf(CON_ERROR "failed to create stringbuffer %i \"%s\"\n", i, com_token);
 537                                         }
 538                                 }
 539                                 // skip any trailing text or unrecognized commands
 540                                 while (COM_ParseToken_Simple(&t, true, false, true) && strcmp(com_token, "\n"))
 541                                         ;
 542                         }
 543                 }
 544         }
 545         Mem_Free(text);
 546
 547         // remove all temporary flagged string buffers (ones created with BufStr_FindCreateReplace)
 548         numbuffers = (int)Mem_ExpandableArray_IndexRange(&prog->stringbuffersarray);
 549         for (i = 0; i < numbuffers; i++)
 550         {
 551                 if ( (stringbuffer = (prvm_stringbuffer_t *)Mem_ExpandableArray_RecordAtIndex(&prog->stringbuffersarray, i)) )
 552                         if (stringbuffer->flags & STRINGBUFFER_TEMP)
 553                                 BufStr_Del(prog, stringbuffer);
 554         }
 555
 556         if(developer_entityparsing.integer)
 557                 Con_Printf("SV_Loadgame_f: finished\n");
 558
 559         // make sure we're connected to loopback
 560         if(sv.active && host.hook.ConnectLocal)
 561                 host.hook.ConnectLocal();
 562 }