From d60df4b12757b59aa6ea4516508d974b8cb95715 Mon Sep 17 00:00:00 2001
From: historic_bruno <ben@wildfiregames.com>
Date: Sun, 4 Mar 2012 05:27:17 +0000
Subject: [PATCH] Adds saved game deletion. Refs #1090 Documents a few things
 related to saved games.

This was SVN commit r11233.
---
 .../data/mods/public/gui/savedgames/load.js   | 26 +++++++++-
 .../data/mods/public/gui/savedgames/load.xml  | 14 ++++--
 source/gui/scripting/ScriptFunctions.cpp      |  6 +++
 source/ps/SavedGame.cpp                       | 27 +++++++++-
 source/ps/SavedGame.h                         | 50 ++++++++++++++++++-
 5 files changed, 115 insertions(+), 8 deletions(-)

diff --git a/binaries/data/mods/public/gui/savedgames/load.js b/binaries/data/mods/public/gui/savedgames/load.js
index d1504faf23..7fc94dcb14 100644
--- a/binaries/data/mods/public/gui/savedgames/load.js
+++ b/binaries/data/mods/public/gui/savedgames/load.js
@@ -27,6 +27,7 @@ function init()
 	{
 		gameSelection.list = [ "No saved games found" ];
 		getGUIObjectByName("loadGameButton").enabled = false;
+		getGUIObjectByName("deleteGameButton").enabled = false;
 		return;
 	}
 
@@ -52,4 +53,27 @@ function loadGame()
 		"isNetworked" : false,
 		"playerAssignments": metadata.gui.playerAssignments
 	});
-}
\ No newline at end of file
+}
+
+function deleteGame()
+{
+	var gameSelection = getGUIObjectByName("gameSelection");
+	var gameLabel = gameSelection.list[gameSelection.selected];
+	var gameID = gameSelection.list_data[gameSelection.selected];
+
+	// Ask for confirmation
+	var btCaptions = ["Yes", "No"];
+	var btCode = [function(){ reallyDeleteGame(gameID); }, null];
+	messageBox(500, 200, "\""+gameLabel+"\"\nSaved game will be permanently deleted, are you sure?", "DELETE", 0, btCaptions, btCode);
+}
+
+function reallyDeleteGame(gameID)
+{
+	if (!Engine.DeleteSavedGame(gameID))
+	{
+		warn("Could not delete saved game '"+gameID+"'");
+	}
+
+	// Run init again to refresh saved game list
+	init();
+}
diff --git a/binaries/data/mods/public/gui/savedgames/load.xml b/binaries/data/mods/public/gui/savedgames/load.xml
index 03199dfe4e..e3ed2e8418 100644
--- a/binaries/data/mods/public/gui/savedgames/load.xml
+++ b/binaries/data/mods/public/gui/savedgames/load.xml
@@ -3,6 +3,7 @@
 <objects>
 
 	<script file="gui/savedgames/load.js"/>
+	<script file="gui/common/functions_global_object.js" />
 
 	<!-- Add a translucent black background to fade out the menu page -->
 	<object type="image" z="0" sprite="BackgroundTranslucent"/>
@@ -18,13 +19,18 @@
 			type="list"
 			size="24 24 100%-24 100%-100">
 		</object>
-		
-		<object name="loadGameButton" type="button" size="50%-144 100%-60 50%-16 100%-32" style="StoneButton">
-			Load Game
+
+		<object name="loadGameButton" type="button" size="0%+25 100%-60 33%+10 100%-32" style="StoneButton">
+			Load
 			<action on="Press">loadGame();</action>
 		</object>
 
-		<object type="button" style="StoneButton" size="50%+16 100%-60 50%+144 100%-32">
+		<object name="deleteGameButton" type="button" size="33%+20 100%-60 66%-15 100%-32" style="StoneButton">
+			Delete
+			<action on="Press">deleteGame();</action>
+		</object>
+
+		<object type="button" style="StoneButton" size="66%-5 100%-60 100%-25 100%-32">
 			Cancel
 			<action on="Press">Engine.PopGuiPage();</action>
 		</object>
diff --git a/source/gui/scripting/ScriptFunctions.cpp b/source/gui/scripting/ScriptFunctions.cpp
index 88f96c052c..d8a54cc373 100644
--- a/source/gui/scripting/ScriptFunctions.cpp
+++ b/source/gui/scripting/ScriptFunctions.cpp
@@ -351,6 +351,11 @@ std::vector<CScriptValRooted> GetSavedGames(void* cbdata)
 	return SavedGames::GetSavedGames(guiManager->GetScriptInterface());
 }
 
+bool DeleteSavedGame(void* UNUSED(cbdata), std::wstring name)
+{
+	return SavedGames::DeleteSavedGame(name);
+}
+
 void OpenURL(void* UNUSED(cbdata), std::string url)
 {
 	sys_open_url(url);
@@ -588,6 +593,7 @@ void GuiScriptingInit(ScriptInterface& scriptInterface)
 	// Saved games
 	scriptInterface.RegisterFunction<CScriptVal, std::wstring, &StartSavedGame>("StartSavedGame");
 	scriptInterface.RegisterFunction<std::vector<CScriptValRooted>, &GetSavedGames>("GetSavedGames");
+	scriptInterface.RegisterFunction<bool, std::wstring, &DeleteSavedGame>("DeleteSavedGame");
 	scriptInterface.RegisterFunction<void, &SaveGame>("SaveGame");
 	scriptInterface.RegisterFunction<void, &QuickSave>("QuickSave");
 	scriptInterface.RegisterFunction<void, &QuickLoad>("QuickLoad");
diff --git a/source/ps/SavedGame.cpp b/source/ps/SavedGame.cpp
index 643bb5fa96..b860617fe1 100644
--- a/source/ps/SavedGame.cpp
+++ b/source/ps/SavedGame.cpp
@@ -1,4 +1,4 @@
-/* Copyright (C) 2011 Wildfire Games.
+/* Copyright (C) 2012 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
@@ -100,6 +100,9 @@ Status SavedGames::Save(const std::wstring& prefix, CSimulation2& simulation, CG
 	return INFO::OK;
 }
 
+/**
+ * Helper class for retrieving data from saved game archives
+ */
 class CGameLoader
 {
 	NONCOPYABLE(CGameLoader);
@@ -202,3 +205,25 @@ std::vector<CScriptValRooted> SavedGames::GetSavedGames(ScriptInterface& scriptI
 
 	return games;
 }
+
+bool SavedGames::DeleteSavedGame(const std::wstring& name)
+{
+	const VfsPath basename(L"saves/" + name);
+	const VfsPath filename = basename.ChangeExtension(L".0adsave");
+	OsPath realpath;
+
+	// Make sure it exists in VFS and find its real path
+	if (!VfsFileExists(filename) || g_VFS->GetRealPath(filename, realpath) != INFO::OK)
+		return false; // Error
+
+	// Remove from VFS
+	if (g_VFS->RemoveFile(filename) != INFO::OK)
+		return false; // Error
+
+	// Delete actual file
+	if (wunlink(realpath) != 0)
+		return false; // Error
+
+	// Successfully deleted file
+	return true;
+}
diff --git a/source/ps/SavedGame.h b/source/ps/SavedGame.h
index 43ad873d36..019f31ba5d 100644
--- a/source/ps/SavedGame.h
+++ b/source/ps/SavedGame.h
@@ -1,4 +1,4 @@
-/* Copyright (C) 2011 Wildfire Games.
+/* Copyright (C) 2012 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
@@ -23,15 +23,61 @@ class ScriptInterface;
 class CScriptValRooted;
 class CGUIManager;
 
+/**
+ * @file
+ * Contains functions for managing saved game archives.
+ *
+ * A saved game is simply a zip archive with the extension '0adsave'
+ * and containing two files:
+ * <ul>
+ *  <li>metadata.json - JSON data file containing the game metadata</li>
+ *	<li>simulation.dat - the serialized simulation state data</li>
+ * </ul>
+ */
+
 namespace SavedGames
 {
 
-Status Save(const std::wstring& prefix, CSimulation2& simulation, CGUIManager* gui, int playerIDo);
+/**
+ * Create new saved game archive with given prefix and simulation data
+ *
+ * @param prefix Create new numbered file starting with this prefix
+ * @param simulation
+ * @param gui if not NULL, store some UI-related data with the saved game
+ * @param playerID ID of the player who saved this file
+ * @return INFO::OK if successfully saved, else an error Status
+ */
+Status Save(const std::wstring& prefix, CSimulation2& simulation, CGUIManager* gui, int playerID);
 
+/**
+ * Load saved game archive with the given name
+ *
+ * @param name filename of saved game (without path or extension)
+ * @param scriptInterface
+ * @param[out] metadata object containing metadata associated with saved game,
+ *	parsed from metadata.json inside the archive.
+ * @param[out] savedState serialized simulation state stored as string of bytes,
+ *	loaded from simulation.dat inside the archive.
+ * @return INFO::OK if successfully loaded, else an error Status
+ */
 Status Load(const std::wstring& name, ScriptInterface& scriptInterface, CScriptValRooted& metadata, std::string& savedState);
 
+/**
+ * Get list of saved games for GUI script usage
+ *
+ * @param scriptInterface the ScriptInterface in which to create the return data.
+ * @return list of objects containing saved game data
+ */
 std::vector<CScriptValRooted> GetSavedGames(ScriptInterface& scriptInterface);
 
+/**
+ * Permanently deletes the saved game archive with the given name
+ *
+ * @param name filename of saved game (without path or extension)
+ * @return true if deletion was successful, or false on error
+ */
+bool DeleteSavedGame(const std::wstring& name);
+
 }
 
 #endif // INCLUDED_SAVEDGAME