Provide ability to upload save states (#371)

This change provides the ability to upload save states.

When a state is downloaded, the state (savestate.state), screenshot
(screenshot.jpg), and a json file (rominfo.json) describing the save
state are zipped and downloaded.

The json file description is defined as follows:
```json
{
  "Name": "Super Mario Bros. (1985-09-13)(Nintendo)(JP-US).zip",
  "StateDateTime": "2024-06-24T05:34:38",
  "StateName": "",
  "MD5": "7d158dcd242e77ba249ac8342474aa77",
  "SHA1": "3d4b04dc78f9d998f17d9fe9ad982a83b5ed72df",
  "Type": "ROM"
}
```

| Attribute | Value |
| -------- | ------|
| Name | The name of the ROM that the state belongs to. This is merely a
convenience attribute. |
| StateDateTime | The date and time (in UTC) when the state was
initially saved. |
| StateName | The name of the state |
| MD5 | The MD5 hash of the ROM that the state belongs to. |
| SHA1 | The SHA1 hash of the ROM that the state belongs to. |
| Type | Whether the state belongs to a ROM or ROM Group |

If the zip is re-uploaded, the above json file will be used to
automatically match the saved state to the ROM that created it.

If a zip is uploaded without the above three files, the upload will
fail.

If a file is uploaded that is not a zip, it will be stored against the
currently running ROM and a warning will be displayed that Gaseous was
unable to verify that the state belongs to the ROM, and may not function
as expected.

Closes #336

gaseous-server/Classes/Roms.cs

@@ -12,7 +12,13 @@ namespace gaseous_server.Classes
 		public class InvalidRomId : Exception
 		{
 			public InvalidRomId(long Id) : base("Unable to find ROM by id " + Id)
-            {}
+			{ }
+		}
+
+		public class InvalidRomHash : Exception
+		{
+			public InvalidRomHash(String Hash) : base("Unable to find ROM by hash " + Hash)
+			{ }
 		}
 
 		public static GameRomObject GetRoms(long GameId, long PlatformId = -1, string NameSearch = "", int pageNumber = 0, int pageSize = 0, string userid = "")
@@ -37,13 +43,16 @@ namespace gaseous_server.Classes
 			// platform query
 			sqlPlatform = "SELECT DISTINCT Games_Roms.PlatformId, Platform.`Name` FROM Games_Roms LEFT JOIN Platform ON Games_Roms.PlatformId = Platform.Id WHERE GameId = @id ORDER BY Platform.`Name`;";
 
-			if (PlatformId == -1) {
+			if (PlatformId == -1)
+			{
 				// data query
 				sql = "SELECT DISTINCT Games_Roms.*, Platform.`Name` AS platformname, GameState.RomId AS SavedStateRomId FROM Games_Roms LEFT JOIN Platform ON Games_Roms.PlatformId = Platform.Id LEFT JOIN GameState ON (Games_Roms.Id = GameState.RomId AND GameState.UserId = @userid AND GameState.IsMediaGroup = 0) WHERE Games_Roms.GameId = @id" + NameSearchWhere + " ORDER BY Platform.`Name`, Games_Roms.`Name` LIMIT 1000;";
 
 				// count query
 				sqlCount = "SELECT COUNT(Games_Roms.Id) AS RomCount FROM Games_Roms WHERE Games_Roms.GameId = @id" + NameSearchWhere + ";";
-			} else {
+			}
+			else
+			{
 				// data query
 				sql = "SELECT DISTINCT Games_Roms.*, Platform.`Name` AS platformname, GameState.RomId AS SavedStateRomId FROM Games_Roms LEFT JOIN Platform ON Games_Roms.PlatformId = Platform.Id LEFT JOIN GameState ON (Games_Roms.Id = GameState.RomId AND GameState.UserId = @userid AND GameState.IsMediaGroup = 0) WHERE Games_Roms.GameId = @id AND Games_Roms.PlatformId = @platformid" + NameSearchWhere + " ORDER BY Platform.`Name`, Games_Roms.`Name` LIMIT 1000;";
 
@@ -100,6 +109,26 @@ namespace gaseous_server.Classes
 			}
 		}
 
+		public static GameRomItem GetRom(string MD5)
+		{
+			Database db = new Database(Database.databaseType.MySql, Config.DatabaseConfiguration.ConnectionString);
+			string sql = "SELECT Games_Roms.*, Platform.`Name` AS platformname FROM Games_Roms LEFT JOIN Platform ON Games_Roms.PlatformId = Platform.Id WHERE Games_Roms.MD5 = @id";
+			Dictionary<string, object> dbDict = new Dictionary<string, object>();
+			dbDict.Add("id", MD5);
+			DataTable romDT = db.ExecuteCMD(sql, dbDict);
+
+			if (romDT.Rows.Count > 0)
+			{
+				DataRow romDR = romDT.Rows[0];
+				GameRomItem romItem = BuildRom(romDR);
+				return romItem;
+			}
+			else
+			{
+				throw new InvalidRomHash(MD5);
+			}
+		}
+
 		public static GameRomItem UpdateRom(long RomId, long PlatformId, long GameId)
 		{
 			// ensure metadata for platformid is present
@@ -201,7 +230,7 @@ namespace gaseous_server.Classes
 			public Models.PlatformMapping.PlatformMapItem.WebEmulatorItem? Emulator { get; set; }
 			public long GameId { get; set; }
 			public string? Path { get; set; }
-			public string? SignatureSourceGameTitle { get; set;}
+			public string? SignatureSourceGameTitle { get; set; }
 			public bool HasSaveStates { get; set; } = false;
 			public GameLibrary.LibraryItem Library { get; set; }
 		}

gaseous-server/Controllers/V1.1/StateManagerController.cs

@@ -6,6 +6,7 @@ using Authentication;
 using Microsoft.AspNetCore.Identity;
 using System.Data;
 using Asp.Versioning;
+using System.IO.Compression;
 
 namespace gaseous_server.Controllers.v1_1
 {
@@ -13,7 +14,7 @@ namespace gaseous_server.Controllers.v1_1
     [ApiVersion("1.0")]
     [ApiVersion("1.1")]
     [ApiController]
-    public class StateManagerController: ControllerBase
+    public class StateManagerController : ControllerBase
     {
         private readonly UserManager<ApplicationUser> _userManager;
         private readonly SignInManager<ApplicationUser> _signInManager;
@@ -233,11 +234,11 @@ namespace gaseous_server.Controllers.v1_1
         [ProducesResponseType(StatusCodes.Status404NotFound)]
         [Route("{RomId}/{StateId}/State/")]
         [Route("{RomId}/{StateId}/State/savestate.state")]
-        public async Task<ActionResult> GetStateDataAsync(long RomId, long StateId, bool IsMediaGroup = false)
+        public async Task<ActionResult> GetStateDataAsync(long RomId, long StateId, bool IsMediaGroup = false, bool StateOnly = false)
         {
             var user = await _userManager.GetUserAsync(User);
             Database db = new Database(Database.databaseType.MySql, Config.DatabaseConfiguration.ConnectionString);
-            string sql = "SELECT Zipped, State FROM GameState WHERE Id = @id AND RomId = @romid AND IsMediaGroup = @ismediagroup AND UserId = @userid;";
+            string sql = "SELECT * FROM GameState WHERE Id = @id AND RomId = @romid AND IsMediaGroup = @ismediagroup AND UserId = @userid;";
             Dictionary<string, object> dbDict = new Dictionary<string, object>
             {
                 { "id", StateId },
@@ -254,7 +255,9 @@ namespace gaseous_server.Controllers.v1_1
             }
             else
             {
-                string filename = "savestate.state";
+                // get rom data
+                Roms.GameRomItem romItem = Roms.GetRom(RomId);
+
                 byte[] bytes;
                 if ((bool)data.Rows[0]["Zipped"] == false)
                 {
@@ -264,7 +267,86 @@ namespace gaseous_server.Controllers.v1_1
                 {
                     bytes = Common.Decompress((byte[])data.Rows[0]["State"]);
                 }
-                string contentType = "application/octet-stream";
+
+                string contentType = "";
+                string filename = ((DateTime)data.Rows[0]["StateDateTime"]).ToString("yyyy-MM-ddTHH-mm-ss") + "-" + Path.GetFileNameWithoutExtension(romItem.Name);
+
+
+                if (StateOnly == true)
+                {
+                    contentType = "application/octet-stream";
+                    filename = filename + ".state";
+                }
+                else
+                {
+                    contentType = "application/zip";
+                    filename = filename + ".zip";
+
+                    Dictionary<string, object> RomInfo = new Dictionary<string, object>
+                    {
+                        { "Name", romItem.Name },
+                        { "StateDateTime", data.Rows[0]["StateDateTime"] },
+                        { "StateName", data.Rows[0]["Name"] }
+                    };
+                    if ((int)data.Rows[0]["IsMediaGroup"] == 0)
+                    {
+                        RomInfo.Add("MD5", romItem.Md5);
+                        RomInfo.Add("SHA1", romItem.Sha1);
+                        RomInfo.Add("Type", "ROM");
+                    }
+                    else
+                    {
+                        RomInfo.Add("Type", "Media Group");
+                        RomInfo.Add("MediaGroupId", (long)data.Rows[0]["RomId"]);
+                    }
+                    string RomInfoString = Newtonsoft.Json.JsonConvert.SerializeObject(RomInfo, Newtonsoft.Json.Formatting.Indented, new Newtonsoft.Json.JsonSerializerSettings { NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore });
+
+                    // compile zip file
+                    using (var compressedFileStream = new MemoryStream())
+                    {
+                        List<Dictionary<string, object>> Attachments = new List<Dictionary<string, object>>();
+                        Attachments.Add(new Dictionary<string, object>
+                        {
+                            { "Name", "savestate.state" },
+                            { "Body", bytes }
+                        });
+                        // check if value is dbnull
+                        if (data.Rows[0]["Screenshot"] != DBNull.Value)
+                        {
+                            Attachments.Add(new Dictionary<string, object>
+                            {
+                                { "Name", "screenshot.jpg" },
+                                { "Body", (byte[])data.Rows[0]["Screenshot"] }
+                            });
+                        }
+                        Attachments.Add(new Dictionary<string, object>
+                        {
+                            { "Name", "rominfo.json" },
+                            { "Body", System.Text.Encoding.UTF8.GetBytes(RomInfoString) }
+                        });
+
+                        //Create an archive and store the stream in memory.
+                        using (var zipArchive = new ZipArchive(compressedFileStream, ZipArchiveMode.Create, false))
+                        {
+                            foreach (var Attachment in Attachments)
+                            {
+                                //Create a zip entry for each attachment
+                                var zipEntry = zipArchive.CreateEntry(Attachment["Name"].ToString());
+
+                                //Get the stream of the attachment
+                                using (var originalFileStream = new MemoryStream((byte[])Attachment["Body"]))
+                                using (var zipEntryStream = zipEntry.Open())
+                                {
+                                    //Copy the attachment stream to the zip entry stream
+                                    originalFileStream.CopyTo(zipEntryStream);
+                                }
+                            }
+                        }
+
+                        //return new FileContentResult(compressedFileStream.ToArray(), "application/zip") { FileDownloadName = filename };
+                        bytes = compressedFileStream.ToArray();
+                    }
+                }
 
                 var cd = new System.Net.Mime.ContentDisposition
                 {
@@ -279,6 +361,156 @@ namespace gaseous_server.Controllers.v1_1
             }
         }
 
+        [MapToApiVersion("1.0")]
+        [MapToApiVersion("1.1")]
+        [HttpPost]
+        [Authorize]
+        [ProducesResponseType(StatusCodes.Status200OK)]
+        [ProducesResponseType(StatusCodes.Status404NotFound)]
+        [RequestSizeLimit(long.MaxValue)]
+        [Consumes("multipart/form-data")]
+        [DisableRequestSizeLimit, RequestFormLimits(MultipartBodyLengthLimit = long.MaxValue, ValueLengthLimit = int.MaxValue)]
+        [Route("Upload")]
+        public async Task<ActionResult> UploadStateDataAsync(IFormFile file, long RomId = 0, bool IsMediaGroup = false)
+        {
+            // get user
+            var user = await _userManager.GetUserAsync(User);
+
+            if (file.Length > 0)
+            {
+                MemoryStream fileContent = new MemoryStream();
+                file.CopyTo(fileContent);
+
+                // test if file is a zip file
+                try
+                {
+                    using (var zipArchive = new ZipArchive(fileContent, ZipArchiveMode.Read, false))
+                    {
+                        foreach (var entry in zipArchive.Entries)
+                        {
+                            if (entry.FullName == "rominfo.json")
+                            {
+                                using (var stream = entry.Open())
+                                using (var reader = new StreamReader(stream))
+                                {
+                                    string RomInfoString = reader.ReadToEnd();
+                                    Dictionary<string, object> RomInfo = Newtonsoft.Json.JsonConvert.DeserializeObject<Dictionary<string, object>>(RomInfoString);
+
+                                    // get rom data
+                                    Roms.GameRomItem romItem;
+
+                                    try
+                                    {
+                                        romItem = Roms.GetRom((string)RomInfo["MD5"]);
+                                    }
+                                    catch (Roms.InvalidRomHash)
+                                    {
+                                        return NotFound();
+                                    }
+
+                                    // get state data
+                                    byte[] StateData = null;
+                                    byte[] ScreenshotData = null;
+                                    string StateName = RomInfo["StateName"].ToString();
+                                    DateTime StateDateTime = DateTime.Parse(RomInfo["StateDateTime"].ToString());
+                                    IsMediaGroup = RomInfo["Type"].ToString() == "Media Group" ? true : false;
+
+                                    if (zipArchive.GetEntry("savestate.state") != null)
+                                    {
+                                        using (var stateStream = zipArchive.GetEntry("savestate.state").Open())
+                                        using (var stateReader = new MemoryStream())
+                                        {
+                                            stateStream.CopyTo(stateReader);
+                                            StateData = stateReader.ToArray();
+                                        }
+                                    }
+                                    if (zipArchive.GetEntry("screenshot.jpg") != null)
+                                    {
+                                        using (var screenshotStream = zipArchive.GetEntry("screenshot.jpg").Open())
+                                        using (var screenshotReader = new MemoryStream())
+                                        {
+                                            screenshotStream.CopyTo(screenshotReader);
+                                            ScreenshotData = screenshotReader.ToArray();
+                                        }
+                                    }
+
+                                    // save state
+                                    Database db = new Database(Database.databaseType.MySql, Config.DatabaseConfiguration.ConnectionString);
+                                    string sql = "INSERT INTO GameState (UserId, RomId, IsMediaGroup, StateDateTime, Name, Screenshot, State, Zipped) VALUES (@userid, @romid, @ismediagroup, @statedatetime, @name, @screenshot, @state, @zipped); SELECT LAST_INSERT_ID();";
+                                    Dictionary<string, object> dbDict = new Dictionary<string, object>
+                                    {
+                                        { "userid", user.Id },
+                                        { "romid", romItem.Id },
+                                        { "ismediagroup", IsMediaGroup },
+                                        { "statedatetime", StateDateTime },
+                                        { "name", StateName },
+                                        { "screenshot", ScreenshotData },
+                                        { "state", Common.Compress(StateData) },
+                                        { "zipped", true }
+                                    };
+                                    DataTable data = db.ExecuteCMD(sql, dbDict);
+
+                                    RomInfo.Add("RomId", romItem.Id);
+                                    RomInfo.Add("Management", "Managed");
+                                    return Ok(RomInfo);
+                                }
+                            }
+                        }
+                    }
+
+                    return BadRequest("File is not a valid Gaseous state file.");
+                }
+                catch
+                {
+                    // not a zip file
+                    if (RomId != 0)
+                    {
+                        // get rom data
+                        Roms.GameRomItem romItem;
+
+                        try
+                        {
+                            romItem = Roms.GetRom(RomId);
+                        }
+                        catch (Roms.InvalidRomHash)
+                        {
+                            return NotFound();
+                        }
+
+                        // save state
+                        Database db = new Database(Database.databaseType.MySql, Config.DatabaseConfiguration.ConnectionString);
+                        string sql = "INSERT INTO GameState (UserId, RomId, IsMediaGroup, StateDateTime, Name, Screenshot, State, Zipped) VALUES (@userid, @romid, @ismediagroup, @statedatetime, @name, @screenshot, @state, @zipped); SELECT LAST_INSERT_ID();";
+                        Dictionary<string, object> dbDict = new Dictionary<string, object>
+                        {
+                            { "userid", user.Id },
+                            { "romid", RomId },
+                            { "ismediagroup", IsMediaGroup },
+                            { "statedatetime", DateTime.UtcNow },
+                            { "name", "" },
+                            { "screenshot", null },
+                            { "state", Common.Compress(fileContent.ToArray()) },
+                            { "zipped", true }
+                        };
+                        DataTable data = db.ExecuteCMD(sql, dbDict);
+
+                        return Ok(new Dictionary<string, object>
+                        {
+                            { "RomId", RomId },
+                            { "Management", "Unmanaged" }
+                        });
+                    }
+                    else
+                    {
+                        return BadRequest("No rom id provided.");
+                    }
+                }
+            }
+            else
+            {
+                return BadRequest("File is empty.");
+            }
+        }
+
         private Models.GameStateItem BuildGameStateItem(DataRow dr)
         {
             bool HasScreenshot = true;

gaseous-server/wwwroot/pages/dialogs/emulatorloadstate.html

@@ -1,6 +1,9 @@
 <div id="saved_states">
 
 </div>
+<div>
+    <span>Upload state file: </span><input type="file" id="stateFile" />
+</div>
 
 <script text="text/javascript">
     document.getElementById('modal-heading').innerHTML = "Load saved state";
@@ -13,9 +16,10 @@
         ajaxCall(
             statesUrl,
             'GET',
-            function(result) {
+            function (result) {
                 var statesBox = document.getElementById('saved_states');
                 statesBox.innerHTML = '';
+                document.getElementById('stateFile').value = '';
 
                 for (var i = 0; i < result.length; i++) {
                     var stateBox = document.createElement('div');
@@ -62,7 +66,7 @@
                     stateControls.id = 'stateControls_' + result[i].id;
                     stateControls.className = 'saved_state_controls';
 
-                    var stateControlsLaunch= document.createElement('span');
+                    var stateControlsLaunch = document.createElement('span');
                     stateControlsLaunch.id = 'stateControlsLaunch_' + result[i].id;
                     stateControlsLaunch.className = 'romstart';
                     var emulatorTarget = '/index.html?page=emulator&engine=@engine&core=@core&platformid=@platformid&gameid=@gameid&romid=@romid&mediagroup=@mediagroup&rompath=@rompath&stateid=' + result[i].id;
@@ -128,7 +132,7 @@
         ajaxCall(
             '/api/v1.1/StateManager/' + modalVariables.romId + '/' + StateId + '?IsMediaGroup=' + IsMediaGroup,
             'DELETE',
-            function(success) {
+            function (success) {
                 LoadStates();
             },
             function (error) {
@@ -147,7 +151,7 @@
         ajaxCall(
             '/api/v1.1/StateManager/' + modalVariables.romId + '/' + StateId + '?IsMediaGroup=' + IsMediaGroup,
             'PUT',
-            function(success) {
+            function (success) {
                 LoadStates();
             },
             function (error) {
@@ -156,4 +160,36 @@
             JSON.stringify(model)
         );
     }
+
+    document.getElementById('stateFile').addEventListener('change', function () {
+        let file = document.getElementById('stateFile').files[0];
+        let formData = new FormData();
+        formData.append('file', file);
+
+        console.log("Uploading state file");
+
+        fetch('/api/v1.1/StateManager/Upload?RomId=' + modalVariables.romId + '&IsMediaGroup=' + modalVariables.IsMediaGroup, {
+            method: 'POST',
+            body: formData
+        })
+            .then(response => response.json())
+            .then(data => {
+                console.log('Success:', data);
+                UploadAlert(data);
+                LoadStates();
+            })
+            .catch(error => {
+                console.error("Error:", error);
+                UploadAlert(error);
+                LoadStates();
+            });
+    });
+
+    function UploadAlert(data) {
+        if (data.Management == "Managed") {
+            alert("State uploaded successfully.");
+        } else {
+            alert("State uploaded successfully, but it might not function correctly for this platform and ROM.");
+        }
+    }
 </script>

gaseous-server/wwwroot/pages/emulator.html

@@ -13,7 +13,7 @@
     if (IsMediaGroupInt == 1) { IsMediaGroup = true; }
     var StateUrl = undefined;
     if (getQueryString('stateid', 'int')) {
-        StateUrl = '/api/v1.1/StateManager/' + romId + '/' + getQueryString('stateid', 'int') + '/State/savestate.state?IsMediaGroup=' + IsMediaGroup;
+        StateUrl = '/api/v1.1/StateManager/' + romId + '/' + getQueryString('stateid', 'int') + '/State/savestate.state?StateOnly=true&IsMediaGroup=' + IsMediaGroup;
     }
     var gameData;
     var artworks = null;