mirror of
https://github.com/ZDoom/raze-gles.git
synced 2024-11-10 23:02:03 +00:00
353 lines
9.7 KiB
C++
353 lines
9.7 KiB
C++
/*
|
|
** savegame.cpp
|
|
**
|
|
** common savegame utilities for all front ends.
|
|
**
|
|
**---------------------------------------------------------------------------
|
|
** Copyright 2019 Christoph Oelckers
|
|
** All rights reserved.
|
|
**
|
|
** Redistribution and use in source and binary forms, with or without
|
|
** modification, are permitted provided that the following conditions
|
|
** are met:
|
|
**
|
|
** 1. Redistributions of source code must retain the above copyright
|
|
** notice, this list of conditions and the following disclaimer.
|
|
** 2. Redistributions in binary form must reproduce the above copyright
|
|
** notice, this list of conditions and the following disclaimer in the
|
|
** documentation and/or other materials provided with the distribution.
|
|
** 3. The name of the author may not be used to endorse or promote products
|
|
** derived from this software without specific prior written permission.
|
|
**
|
|
** THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|
** IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
** OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
** IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
** INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
** NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OFf
|
|
** THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
**---------------------------------------------------------------------------
|
|
**
|
|
*/
|
|
|
|
#include "compositesaveame.h"
|
|
#include "savegamehelp.h"
|
|
#include "sjson.h"
|
|
#include "baselayer.h"
|
|
#include "gstrings.h"
|
|
#include "i_specialpaths.h"
|
|
#include "cmdlib.h"
|
|
#include "filesystem/filesystem.h"
|
|
#include "statistics.h"
|
|
#include "secrets.h"
|
|
#include "s_music.h"
|
|
#include "quotemgr.h"
|
|
#include "mapinfo.h"
|
|
#include "v_video.h"
|
|
|
|
static CompositeSavegameWriter savewriter;
|
|
static FResourceFile *savereader;
|
|
|
|
//=============================================================================
|
|
//
|
|
// This is for keeping my sanity while working with the horrible mess
|
|
// that is the savegame code in Duke Nukem.
|
|
// Without handling this in global variables it is a losing proposition
|
|
// to save custom data along with the regular snapshot. :(
|
|
// With this the savegame code can mostly pretend to load from and write
|
|
// to files while really using a composite archive.
|
|
//
|
|
// All global non-game dependent state is also saved right here for convenience.
|
|
//
|
|
//=============================================================================
|
|
|
|
|
|
bool OpenSaveGameForRead(const char *name)
|
|
{
|
|
if (savereader) delete savereader;
|
|
savereader = FResourceFile::OpenResourceFile(name, true, true);
|
|
|
|
if (savereader != nullptr)
|
|
{
|
|
// Load system-side data from savegames.
|
|
ReadStatistics();
|
|
SECRET_Load();
|
|
MUS_Restore();
|
|
quoteMgr.ReadFromSavegame();
|
|
|
|
auto file = ReadSavegameChunk("info.json");
|
|
if (!file.isOpen())
|
|
{
|
|
FinishSavegameRead();
|
|
delete savereader;
|
|
return false;
|
|
}
|
|
if (G_ValidateSavegame(file, nullptr, false) <= 0)
|
|
{
|
|
FinishSavegameRead();
|
|
delete savereader;
|
|
return false;
|
|
}
|
|
}
|
|
return savereader != nullptr;
|
|
}
|
|
|
|
FileWriter *WriteSavegameChunk(const char *name)
|
|
{
|
|
return &savewriter.NewElement(name);
|
|
}
|
|
|
|
FileReader ReadSavegameChunk(const char *name)
|
|
{
|
|
if (!savereader) return FileReader();
|
|
auto lump = savereader->FindLump(name);
|
|
if (!lump) return FileReader();
|
|
return lump->NewReader();
|
|
}
|
|
|
|
bool FinishSavegameWrite()
|
|
{
|
|
return savewriter.WriteToFile();
|
|
}
|
|
|
|
void FinishSavegameRead()
|
|
{
|
|
delete savereader;
|
|
savereader = nullptr;
|
|
}
|
|
|
|
//=============================================================================
|
|
//
|
|
// Creates the savegame and writes all cross-game content.
|
|
//
|
|
//=============================================================================
|
|
|
|
bool OpenSaveGameForWrite(const char* filename, const char *name)
|
|
{
|
|
savewriter.Clear();
|
|
savewriter.SetFileName(filename);
|
|
|
|
sjson_context* ctx = sjson_create_context(0, 0, NULL);
|
|
if (!ctx)
|
|
{
|
|
savewriter.Clear();
|
|
return false;
|
|
}
|
|
sjson_node* root = sjson_mkobject(ctx);
|
|
auto savesig = gi->GetSaveSig();
|
|
sjson_put_int(ctx, root, "Save Version", savesig.currentsavever);
|
|
sjson_put_string(ctx, root, "Engine", savesig.savesig);
|
|
sjson_put_string(ctx, root, "Game Resource", fileSystem.GetResourceFileName(1));
|
|
sjson_put_string(ctx, root, "Map Name", currentLevel->DisplayName());
|
|
sjson_put_string(ctx, root, "Creation Time", myasctime());
|
|
sjson_put_string(ctx, root, "Title", name);
|
|
sjson_put_string(ctx, root, "Map File", currentLevel->fileName);
|
|
sjson_put_string(ctx, root, "Map Label", currentLevel->labelName);
|
|
auto gs = gi->getStats();
|
|
FStringf timeStr("%02d:%02d", gs.timesecnd / 60, gs.timesecnd % 60);
|
|
sjson_put_string(ctx, root, "Map Time", timeStr);
|
|
const char *fn = currentLevel->fileName;
|
|
if (*fn == '/') fn++;
|
|
if (strncmp(fn, "file://", 7) != 0) // this only has meaning for non-usermaps
|
|
{
|
|
auto fileno = fileSystem.FindFile(fn);
|
|
auto mapfile = fileSystem.GetFileContainer(fileno);
|
|
auto mapcname = fileSystem.GetResourceFileName(mapfile);
|
|
if (mapcname) sjson_put_string(ctx, root, "Map Resource", mapcname);
|
|
else
|
|
{
|
|
savewriter.Clear();
|
|
return false; // this should never happen. Saving on a map that isn't present is impossible.
|
|
}
|
|
}
|
|
|
|
char* encoded = sjson_stringify(ctx, root, " ");
|
|
|
|
FileWriter* fil = WriteSavegameChunk("info.json");
|
|
if (!fil)
|
|
{
|
|
sjson_destroy_context(ctx);
|
|
savewriter.Clear();
|
|
return false;
|
|
}
|
|
|
|
fil->Write(encoded, strlen(encoded));
|
|
|
|
sjson_free_string(ctx, encoded);
|
|
sjson_destroy_context(ctx);
|
|
|
|
// Handle system-side modules that need to persist data in savegames here, in a central place.
|
|
SaveStatistics();
|
|
SECRET_Save();
|
|
MUS_Save();
|
|
quoteMgr.WriteToSavegame();
|
|
auto picfile = WriteSavegameChunk("savepic.png");
|
|
screen->WriteSavePic(picfile, 240, 180);
|
|
return true;
|
|
}
|
|
|
|
//=============================================================================
|
|
//
|
|
//
|
|
//
|
|
//=============================================================================
|
|
|
|
static bool CheckSingleFile (const char *name, bool &printRequires, bool printwarn)
|
|
{
|
|
if (name == NULL)
|
|
{
|
|
return true;
|
|
}
|
|
if (strncmp(name, "file://", 7) == 0)
|
|
{
|
|
return FileExists(name + 7); // User maps must be present to be validated.
|
|
}
|
|
if (fileSystem.CheckIfResourceFileLoaded(name) < 0)
|
|
{
|
|
if (printwarn)
|
|
{
|
|
if (!printRequires)
|
|
{
|
|
Printf ("%s:\n%s", GStrings("TXT_SAVEGAMENEEDS"), name);
|
|
}
|
|
else
|
|
{
|
|
Printf (", %s", name);
|
|
}
|
|
}
|
|
printRequires = true;
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
//=============================================================================
|
|
//
|
|
// Return false if not all the needed wads have been loaded.
|
|
//
|
|
//=============================================================================
|
|
|
|
static bool G_CheckSaveGameWads (const char *gamegrp, const char *mapgrp, bool printwarn)
|
|
{
|
|
bool printRequires = false;
|
|
CheckSingleFile (gamegrp, printRequires, printwarn);
|
|
CheckSingleFile (mapgrp, printRequires, printwarn);
|
|
|
|
if (printRequires)
|
|
{
|
|
if (printwarn)
|
|
{
|
|
Printf ("\n");
|
|
}
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
//=============================================================================
|
|
//
|
|
// Checks if the savegame is valid. Gets a reader to the included info.json
|
|
// Returns 1 if valid, 0 if invalid and -1 if old and -2 if content missing
|
|
//
|
|
//=============================================================================
|
|
|
|
int G_ValidateSavegame(FileReader &fr, FString *savetitle, bool formenu)
|
|
{
|
|
auto data = fr.ReadPadded(1);
|
|
|
|
sjson_context* ctx = sjson_create_context(0, 0, NULL);
|
|
if (ctx)
|
|
{
|
|
sjson_node* root = sjson_decode(ctx, (const char*)data.Data());
|
|
|
|
|
|
int savever = sjson_get_int(root, "Save Version", -1);
|
|
FString engine = sjson_get_string(root, "Engine", "");
|
|
FString gamegrp = sjson_get_string(root, "Game Resource", "");
|
|
FString mapgrp = sjson_get_string(root, "Map Resource", "");
|
|
FString title = sjson_get_string(root, "Title", "");
|
|
FString filename = sjson_get_string(root, "Map File", "");
|
|
auto savesig = gi->GetSaveSig();
|
|
|
|
sjson_destroy_context(ctx);
|
|
|
|
if (savetitle) *savetitle = title;
|
|
if (engine.Compare(savesig.savesig) != 0 || savever > savesig.currentsavever)
|
|
{
|
|
// different engine or newer version:
|
|
// not our business. Leave it alone.
|
|
return 0;
|
|
}
|
|
|
|
MapRecord *curLevel = nullptr;
|
|
|
|
if (strncmp(filename, "file://", 7) != 0)
|
|
{
|
|
for (auto& mr : mapList)
|
|
{
|
|
if (mr.fileName.Compare(filename) == 0)
|
|
{
|
|
curLevel = &mr;
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
curLevel = &userMapRecord;
|
|
if (!formenu)
|
|
{
|
|
userMapRecord.name = "";
|
|
userMapRecord.SetFileName(filename);
|
|
}
|
|
}
|
|
if (!curLevel) return 0;
|
|
if (!formenu) currentLevel = curLevel;
|
|
|
|
|
|
if (savever < savesig.minsavever)
|
|
{
|
|
// old, incompatible savegame. List as not usable.
|
|
return -1;
|
|
}
|
|
else
|
|
{
|
|
auto ggfn = ExtractFileBase(fileSystem.GetResourceFileName(1), true);
|
|
if (gamegrp.CompareNoCase(ggfn) == 0)
|
|
{
|
|
return G_CheckSaveGameWads(gamegrp, mapgrp, false) ? 1 : -2;
|
|
}
|
|
else
|
|
{
|
|
// different game. Skip this.
|
|
return 0;
|
|
}
|
|
}
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
//=============================================================================
|
|
//
|
|
//
|
|
//
|
|
//=============================================================================
|
|
|
|
FString G_BuildSaveName (const char *prefix)
|
|
{
|
|
FString name = M_GetSavegamesPath();
|
|
size_t len = name.Len();
|
|
if (name[0] != '\0' && name[len-1] != '\\' && name[len-1] != '/')
|
|
{
|
|
name << "/";
|
|
}
|
|
name << prefix;
|
|
if (!strchr(prefix, '.')) name << SAVEGAME_EXT; // only add an extension if the prefix doesn't have one already.
|
|
name = NicePath(name);
|
|
name.Substitute("\\", "/");
|
|
return name;
|
|
}
|
|
|