diff --git a/Services/Codecs/EasySave3Codec.cs b/Services/Codecs/EasySave3Codec.cs index 2af9ef0..7205c22 100644 --- a/Services/Codecs/EasySave3Codec.cs +++ b/Services/Codecs/EasySave3Codec.cs @@ -1,4 +1,4 @@ -using System; +using System; using System.Collections.Generic; using System.IO; using System.IO.Compression; @@ -7,8 +7,8 @@ using System.Text; using System.Text.Encodings.Web; using System.Text.Json; using System.Text.Json.Nodes; -using GameLauncher.Models; using GameLauncher.Engines.Unity; +using GameLauncher.Models; namespace GameLauncher.Services.Codecs { @@ -17,10 +17,19 @@ namespace GameLauncher.Services.Codecs /// public class EasySave3Codec : ISaveDataCodec { + /// + /// コーデックの表示名を取得します。 + /// public string CodecName => "Easy Save 3 (ES3) コーデック"; + /// + /// パスワード入力が必要かどうかを取得します。 + /// public bool RequiresPassword => false; + /// + /// パスワード入力ダイアログに表示する案内メッセージを取得します。 + /// public string? PasswordPromptMessage => "暗号化パスワードが設定されている場合は入力してください(未設定・既定の場合は空欄):"; // キャッシュ用の最新平文JSONノード @@ -28,6 +37,12 @@ namespace GameLauncher.Services.Codecs private bool _wasEncrypted; private string? _usedPassword; + /// + /// 指定されたセーブファイルが本コーデックで処理可能かを判定します。 + /// + /// 対象のUnityゲーム情報 + /// 対象のセーブファイル情報 + /// 処理可能な場合は true、それ以外は false public bool CanHandle(UnityGameItem game, SaveFileEntry file) { var ext = Path.GetExtension(file.FilePath).ToLowerInvariant(); @@ -43,6 +58,12 @@ namespace GameLauncher.Services.Codecs return false; } + /// + /// セーブファイルからプロパティ一覧を読み込みます。 + /// + /// セーブファイルの絶対パス + /// 任意の暗号化パスワード + /// 展開されたセーブデータプロパティのリスト public List LoadProperties(string filePath, string? optionalPassword = null) { var list = new List(); @@ -52,8 +73,8 @@ namespace GameLauncher.Services.Codecs if (fileBytes.Length == 0) return list; string? jsonText = null; - _wasEncrypted = false; - _usedPassword = null; + this._wasEncrypted = false; + this._usedPassword = null; // 1. まず平文 JSON または Gzip 解凍を試みる try @@ -91,12 +112,12 @@ namespace GameLauncher.Services.Codecs foreach (var pwd in candidatePasswords) { - var decrypted = TryDecryptAes(fileBytes, pwd); + var decrypted = this.TryDecryptAes(fileBytes, pwd); if (!string.IsNullOrEmpty(decrypted)) { jsonText = decrypted; - _wasEncrypted = true; - _usedPassword = pwd; + this._wasEncrypted = true; + this._usedPassword = pwd; break; } } @@ -105,30 +126,36 @@ namespace GameLauncher.Services.Codecs if (string.IsNullOrEmpty(jsonText)) { // JSON展開ができなかった場合、バイナリキー・バリュー形式として先頭・重要オフセットを抽出 - return ExtractBinaryPropertiesFallback(fileBytes); + return this.ExtractBinaryPropertiesFallback(fileBytes); } // JSON からプロパティを再帰的に展開 try { - _cachedRootNode = JsonNode.Parse(jsonText); - if (_cachedRootNode is JsonObject rootObj) + this._cachedRootNode = JsonNode.Parse(jsonText); + if (this._cachedRootNode is JsonObject rootObj) { - FlattenJsonObject(rootObj, "", list); + this.FlattenJsonObject(rootObj, "", list); } - else if (_cachedRootNode is JsonArray rootArr) + else if (this._cachedRootNode is JsonArray rootArr) { - FlattenJsonArray(rootArr, "Array", list); + this.FlattenJsonArray(rootArr, "Array", list); } } catch { - return ExtractBinaryPropertiesFallback(fileBytes); + return this.ExtractBinaryPropertiesFallback(fileBytes); } return list; } + /// + /// JSONオブジェクトを再帰的に走査し、プロパティ一覧に追加します。 + /// + /// 対象のJSONオブジェクト + /// 現在のキー階層プレフィックス + /// 追加先のプロパティリスト private void FlattenJsonObject(JsonObject obj, string prefix, List list) { foreach (var kvp in obj) @@ -181,14 +208,14 @@ namespace GameLauncher.Services.Codecs } else { - FlattenJsonObject(childObj, key, list); + this.FlattenJsonObject(childObj, key, list); } } else if (node is JsonArray childArr) { if (childArr.Count <= 20) { - FlattenJsonArray(childArr, key, list); + this.FlattenJsonArray(childArr, key, list); } else { @@ -206,6 +233,12 @@ namespace GameLauncher.Services.Codecs } } + /// + /// JSON配列を再帰的に走査し、プロパティ一覧に追加します。 + /// + /// 対象のJSON配列 + /// 現在のキー階層プレフィックス + /// 追加先のプロパティリスト private void FlattenJsonArray(JsonArray arr, string prefix, List list) { for (int i = 0; i < arr.Count; i++) @@ -225,11 +258,16 @@ namespace GameLauncher.Services.Codecs } else if (node is JsonObject childObj) { - FlattenJsonObject(childObj, key, list); + this.FlattenJsonObject(childObj, key, list); } } } + /// + /// JSON展開に失敗した場合のフォールバックとしてバイナリ値を抽出します。 + /// + /// ファイル全体のバイナリデータ + /// バイナリ情報プロパティのリスト private List ExtractBinaryPropertiesFallback(byte[] bytes) { var list = new List(); @@ -261,18 +299,25 @@ namespace GameLauncher.Services.Codecs return list; } + /// + /// 編集後のプロパティ一覧をセーブファイルへ書き戻して保存します。 + /// + /// 保存先セーブファイルの絶対パス + /// 編集されたプロパティ一覧 + /// 任意の暗号化パスワード + /// 保存に成功した場合は true、それ以外は false public bool SaveProperties(string filePath, List properties, string? optionalPassword = null) { try { - if (_cachedRootNode != null) + if (this._cachedRootNode != null) { // JSON の値を更新 foreach (var prop in properties) { if (prop.RawData is string keyPath) { - UpdateJsonNodeByPath(_cachedRootNode, keyPath, prop.EditValue, prop.Type); + this.UpdateJsonNodeByPath(this._cachedRootNode, keyPath, prop.EditValue, prop.Type); } } @@ -281,15 +326,15 @@ namespace GameLauncher.Services.Codecs WriteIndented = true, Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping }; - string updatedJson = _cachedRootNode.ToJsonString(options); + string updatedJson = this._cachedRootNode.ToJsonString(options); byte[] outputBytes = Encoding.UTF8.GetBytes(updatedJson); // もともと暗号化されていた場合は再暗号化 - if (_wasEncrypted) + if (this._wasEncrypted) { - string pwd = !string.IsNullOrEmpty(optionalPassword) ? optionalPassword : (_usedPassword ?? "Moodkie"); - outputBytes = EncryptAes(outputBytes, pwd); + string pwd = !string.IsNullOrEmpty(optionalPassword) ? optionalPassword : (this._usedPassword ?? "Moodkie"); + outputBytes = this.EncryptAes(outputBytes, pwd); } // バックアップ作成 @@ -331,6 +376,13 @@ namespace GameLauncher.Services.Codecs } } + /// + /// キーパスに基づいてJSONノードの値を更新します。 + /// + /// ルートのJSONノード + /// ドット区切りのキーパス + /// 更新後の値文字列 + /// 値の型名 private void UpdateJsonNodeByPath(JsonNode root, string path, string newValue, string type) { try @@ -358,16 +410,22 @@ namespace GameLauncher.Services.Codecs string lastKey = parts[^1]; if (current is JsonObject finalObj) { - finalObj[lastKey] = ParseJsonValue(newValue, type); + finalObj[lastKey] = this.ParseJsonValue(newValue, type); } else if (current is JsonArray finalArr && int.TryParse(lastKey, out int finalIdx) && finalIdx < finalArr.Count) { - finalArr[finalIdx] = ParseJsonValue(newValue, type); + finalArr[finalIdx] = this.ParseJsonValue(newValue, type); } } catch { } } + /// + /// 文字列値と型名から対応するJSONノードを生成します。 + /// + /// 値文字列 + /// 型名 + /// 生成されたJSONノード private JsonNode? ParseJsonValue(string value, string type) { if (type == "Int" && int.TryParse(value, out int i)) return JsonValue.Create(i); @@ -389,6 +447,12 @@ namespace GameLauncher.Services.Codecs return JsonValue.Create(value); } + /// + /// AESアルゴリズムによるセーブデータの復号を試みます。 + /// + /// 暗号化バイナリデータ + /// 復号パスワード + /// 復号された平文文字列。失敗時は null private string? TryDecryptAes(byte[] data, string password) { try @@ -424,6 +488,12 @@ namespace GameLauncher.Services.Codecs return null; } + /// + /// 平文バイト配列をAESアルゴリズムで暗号化します。 + /// + /// 平文バイナリデータ + /// 暗号化パスワード + /// 暗号化されたバイナリデータ private byte[] EncryptAes(byte[] plainBytes, string password) { byte[] rawUtf8 = Encoding.UTF8.GetBytes(password); diff --git a/Services/Codecs/ISaveDataCodec.cs b/Services/Codecs/ISaveDataCodec.cs index 38234f5..0810a1b 100644 --- a/Services/Codecs/ISaveDataCodec.cs +++ b/Services/Codecs/ISaveDataCodec.cs @@ -1,6 +1,6 @@ -using System.Collections.Generic; -using GameLauncher.Models; +using System.Collections.Generic; using GameLauncher.Engines.Unity; +using GameLauncher.Models; namespace GameLauncher.Services.Codecs { @@ -9,22 +9,44 @@ namespace GameLauncher.Services.Codecs /// public interface ISaveDataCodec { - /// コーデックの識別名称(例: "Easy Save 3 (ES3)", "YU-RIS セーブデータ") + /// + /// コーデックの識別名称(例: "Easy Save 3 (ES3)", "YU-RIS セーブデータ")を取得します。 + /// string CodecName { get; } - /// このコーデックで指定ファイルを処理可能か判定 + /// + /// このコーデックで指定ファイルを処理可能か判定します。 + /// + /// 対象のUnityゲーム情報 + /// 対象のセーブファイル情報 + /// 処理可能な場合は true、それ以外は false bool CanHandle(UnityGameItem game, SaveFileEntry file); - /// セーブファイルからGUI編集用プロパティ一覧をロード・解析 + /// + /// セーブファイルからGUI編集用プロパティ一覧をロード・解析します。 + /// + /// セーブファイルの絶対パス + /// 任意の暗号化パスワード + /// 展開されたセーブデータプロパティのリスト List LoadProperties(string filePath, string? optionalPassword = null); - /// GUI編集されたプロパティ一覧をファイルへ再エンコード・保存 + /// + /// GUI編集されたプロパティ一覧をファイルへ再エンコード・保存します。 + /// + /// 保存先セーブファイルの絶対パス + /// 編集されたプロパティ一覧 + /// 任意の暗号化パスワード + /// 保存に成功した場合は true、それ以外は false bool SaveProperties(string filePath, List properties, string? optionalPassword = null); - /// 復号にパスワードやキーが必要かどうか + /// + /// 復号にパスワードやキーが必要かどうかを取得します。 + /// bool RequiresPassword { get; } - /// パスワード入力時の案内メッセージ + /// + /// パスワード入力時の案内メッセージを取得します。 + /// string? PasswordPromptMessage { get; } } } diff --git a/Services/Codecs/YurisSaveCodec.cs b/Services/Codecs/YurisSaveCodec.cs index 7bb89f9..010c434 100644 --- a/Services/Codecs/YurisSaveCodec.cs +++ b/Services/Codecs/YurisSaveCodec.cs @@ -1,9 +1,9 @@ -using System; +using System; using System.Collections.Generic; using System.IO; using System.Text; -using GameLauncher.Models; using GameLauncher.Engines.Unity; +using GameLauncher.Models; namespace GameLauncher.Services.Codecs { @@ -12,12 +12,27 @@ namespace GameLauncher.Services.Codecs /// public class YurisSaveCodec : ISaveDataCodec { + /// + /// コーデックの表示名を取得します。 + /// public string CodecName => "YU-RIS セーブデータ (YSSD) コーデック"; + /// + /// パスワード入力が必要かどうかを取得します。 + /// public bool RequiresPassword => false; + /// + /// パスワード入力ダイアログに表示する案内メッセージを取得します。 + /// public string? PasswordPromptMessage => null; + /// + /// 指定されたセーブファイルが本コーデックで処理可能かを判定します。 + /// + /// 対象のUnityゲーム情報 + /// 対象のセーブファイル情報 + /// 処理可能な場合は true、それ以外は false public bool CanHandle(UnityGameItem game, SaveFileEntry file) { if (!File.Exists(file.FilePath)) return false; @@ -39,6 +54,12 @@ namespace GameLauncher.Services.Codecs } } + /// + /// セーブファイルからプロパティ一覧を読み込みます。 + /// + /// セーブファイルの絶対パス + /// 任意の暗号化パスワード + /// 展開されたセーブデータプロパティのリスト public List LoadProperties(string filePath, string? optionalPassword = null) { var list = new List(); @@ -101,6 +122,13 @@ namespace GameLauncher.Services.Codecs return list; } + /// + /// 編集後のプロパティ一覧をセーブファイルへ書き戻して保存します。 + /// + /// 保存先セーブファイルの絶対パス + /// 編集されたプロパティ一覧 + /// 任意の暗号化パスワード + /// 保存に成功した場合は true、それ以外は false public bool SaveProperties(string filePath, List properties, string? optionalPassword = null) { try diff --git a/Services/SaveDataCodecManager.cs b/Services/SaveDataCodecManager.cs index 0e9703d..73df55c 100644 --- a/Services/SaveDataCodecManager.cs +++ b/Services/SaveDataCodecManager.cs @@ -1,12 +1,11 @@ -using System; +using System; using System.Collections.Generic; using System.IO; using System.Text; using System.Text.RegularExpressions; +using GameLauncher.Engines.Unity; using GameLauncher.Models; using GameLauncher.Services.Codecs; -using GameLauncher.Engines.Unity; -using GameLauncher.Engines.Wolf; namespace GameLauncher.Services { @@ -15,23 +14,32 @@ namespace GameLauncher.Services /// public class SaveDataCodecManager { + /// + /// シングルトンインスタンスを取得します。 + /// public static readonly SaveDataCodecManager Instance = new(); private readonly List _codecs = []; + /// + /// クラスの新しいインスタンスを初期化します。 + /// public SaveDataCodecManager() { // コーデックの登録 - _codecs.Add(new EasySave3Codec()); - _codecs.Add(new YurisSaveCodec()); + this._codecs.Add(new EasySave3Codec()); + this._codecs.Add(new YurisSaveCodec()); } /// /// 指定されたゲームおよびセーブファイルに対応するコーデックを検索します。 /// + /// 対象のUnityゲーム情報 + /// 対象のセーブファイル情報 + /// 対応するコーデック。見つからない場合は null public ISaveDataCodec? FindCodec(UnityGameItem game, SaveFileEntry file) { - foreach (var codec in _codecs) + foreach (var codec in this._codecs) { if (codec.CanHandle(game, file)) { @@ -44,6 +52,9 @@ namespace GameLauncher.Services /// /// 未対応セーブデータについて、Antigravity IDE に依頼できる安全なプロンプトを自動生成します。 /// + /// 対象のUnityゲーム情報 + /// 対象のセーブファイル情報 + /// 生成された依頼プロンプト文字列 public string GenerateAntigravityPrompt(UnityGameItem game, SaveFileEntry file) { // ポリシー配慮: 会社名・タイトル名からセンシティブ表現を除去/安全な別名に変換 @@ -98,8 +109,10 @@ namespace GameLauncher.Services } /// - /// AIプロンプト向けに文字列を安全・中立的な表現にサニタイズ + /// AIプロンプト向けに文字列を安全・中立的な表現にサニタイズします。 /// + /// 元の文字列 + /// サニタイズされた安全な文字列 private static string SanitizeForPrompt(string input) { if (string.IsNullOrWhiteSpace(input)) return "Game";