Skip to content

Commit

Permalink
Remove singleton and use static class instead
Browse files Browse the repository at this point in the history
  • Loading branch information
@cengelha
cengelha committed Apr 5, 2022
1 parent 5b7d292 commit 35d6a02
Show file tree
Hide file tree
Showing 10 changed files with 119 additions and 120 deletions.
4 changes: 4 additions & 0 deletions .github/changelogs/0.6.0.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Changed the whole library from singleton to static class including necessary structural changes.

### Changed
* Removed singleton and now use static class instead
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ All notable changes to this project will be documented in this file. It uses the
### Fixed
### Security

## 0.6.0 (2022-04-05)

### Changed
* Removed singleton and now use static class instead

## 0.5.0 (2022-04-03)

### Changed
Expand Down
10 changes: 5 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,23 +32,23 @@ The obfuscation and deobfuscation is done in-place. Deobfuscation will return a
set of unknown keys.
```csharp
// Deobfuscate
HashSet<string> unknownKeys = Mapping.Instance.Deobfuscate(jsonObject);
HashSet<string> unknownKeys = Mapping.Deobfuscate(jsonObject);

// Obfuscate
Mapping.Instance.Obfuscate(jsonObject);
Mapping.Obfuscate(jsonObject);
```

Create and update settings.
```csharp
// Settings
Mapping.Instance.Settings = new() { PathDownload = "download" };
Mapping.Settings = new() { PathDownload = "download" };
```

Update and download the mapping.json if a newer version is available.
```csharp
// Update
Mapping.Instance.Update();
Mapping.Instance.UpdateAsync();
Mapping.Update();
Mapping.UpdateAsync();
```

## License
Expand Down
187 changes: 89 additions & 98 deletions libNOM.map/Mapping.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,37 +8,41 @@ namespace libNOM.map;
/// <summary>
/// Holds all necessary mapping data and provides obfuscation and deobfuscation.
/// </summary>
public class Mapping
public static class Mapping
{
#region Field

private readonly HttpClient _httpClient = new();
private static readonly HttpClient _httpClient = new();

private readonly MappingJson _jsonCompiler; // latest MBINCompiler mapping.json when this version was created
private static readonly MappingJson _jsonCompiler = MappingJson.Deserialize(Properties.Resources.MBINCompiler)!; // latest MBINCompiler mapping.json when this version was created

private MappingJson? _jsonDownload; // dynamic content from the latest MBINCompiler release on GitHub
private static MappingJson? _jsonDownload; // dynamic content from the latest MBINCompiler release on GitHub

private readonly MappingJson _jsonLegacy; // older keys that are not present in the latest version
private static readonly MappingJson _jsonLegacy = MappingJson.Deserialize(Properties.Resources.Legacy)!; // older keys that are not present in the latest version

private readonly MappingJson _jsonWizard; // adjust differing mapping of SaveWizard
private static readonly MappingJson _jsonWizard = MappingJson.Deserialize(Properties.Resources.SaveWizard)!; // adjust differing mapping of SaveWizard

private readonly Dictionary<string, string> _mapForDeobfuscation = new();
private static readonly Dictionary<string, string> _mapForDeobfuscation = new();

private readonly Dictionary<string, string> _mapForObfuscation = new();
private static readonly Dictionary<string, string> _mapForObfuscation = new();

private string _path;
private static MappingSettings _settings = new();

private MappingSettings _settings = new();
private static Task? _updateTask;

private Task? _updateTask;
#region Dependency

private static string _path = GetCombinedPath();

#endregion

#endregion

#region Property

private bool IsRunning => !_updateTask?.IsCompleted ?? false; // { get; }
private static bool IsRunning => !_updateTask?.IsCompleted ?? false; // { private get; }

public MappingSettings? Settings // { get; set; }
public static MappingSettings Settings // { get; set; }
{
get => _settings;
set
Expand All @@ -50,41 +54,14 @@ public class Mapping

#endregion

#region Singleton

private static readonly Lazy<Mapping> _lazy = new(() => new());

public static Mapping Instance => _lazy.Value; // { get; }

#endregion

#region Contructor

private Mapping()
{
_jsonCompiler = MappingJson.Deserialize(Properties.Resources.MBINCompiler)!;
_jsonLegacy = MappingJson.Deserialize(Properties.Resources.Legacy)!;
_jsonWizard = MappingJson.Deserialize(Properties.Resources.SaveWizard)!;
_path = GetCombinedPath();

if (File.Exists(_path))
{
_jsonDownload = MappingJson.Deserialize(File.ReadAllText(_path));
}

CreateMap();
}

#endregion

// //

#region Create

/// <summary>
/// Creates maps with the mapping data of all files for obfuscation and deobfuscation.
/// </summary>
private void CreateMap()
private static void CreateMap()
{
_mapForDeobfuscation.Clear();
_mapForObfuscation.Clear();
Expand All @@ -93,6 +70,10 @@ private void CreateMap()
AddToMap(_jsonLegacy, true, true);
AddToMap(_jsonWizard, true, false);

if (_jsonDownload is null && File.Exists(_path))
{
_jsonDownload = MappingJson.Deserialize(File.ReadAllText(_path));
}
// Apply additional mapping but keep those that might have become outdated by adding JsonCompiler nonetheless.
if (_jsonDownload?.Version > _jsonCompiler.Version)
{
Expand All @@ -106,7 +87,7 @@ private void CreateMap()
/// <param name="mappingJson">Object of a deserialized file.</param>
/// <param name="deobfuscate">Whether to add a pair to the deobfuscation map.</param>
/// <param name="obfuscate">Whether to add a pair to the obfuscation map.</param>
private void AddToMap(MappingJson mappingJson, bool deobfuscate, bool obfuscate)
private static void AddToMap(MappingJson mappingJson, bool deobfuscate, bool obfuscate)
{
foreach (var pair in mappingJson.Data)
{
Expand All @@ -124,34 +105,15 @@ private void AddToMap(MappingJson mappingJson, bool deobfuscate, bool obfuscate)

#endregion

#region Deobfuscate
#region Getter

/// <summary>
/// Deobfuscates a file to make it human-readable.
/// Combines the download path from the settings with the filename.
/// </summary>
/// <param name="root">Entire file as JSON object.</param>
/// <returns>List of unknown keys.</returns>
public HashSet<string> Deobfuscate(JObject root)
/// <returns></returns>
private static string GetCombinedPath()
{
// Wait in case of currently running update.
_updateTask?.Wait();

var jProperties = new List<JProperty>();
var keys = new HashSet<string>();

// Collect all jProperties that need to be renamed.
foreach (var child in root.Children().Where(c => c.HasValues))
{
CollectForDeobfuscation(child, jProperties, keys);
}

// Actually rename each jProperty.
foreach (var jProperty in jProperties)
{
jProperty.Rename(_mapForDeobfuscation[jProperty.Name]);
}

return keys;
return Path.Combine(Path.GetFullPath(_settings.PathDownload), Properties.Resources.RELEASE_ASSET);
}

/// <summary>
Expand All @@ -160,7 +122,7 @@ public HashSet<string> Deobfuscate(JObject root)
/// <param name="token">Current property that should be deobfuscated.</param>
/// <param name="jProperties">List of properties that need to be deobfuscated.</param>
/// <param name="keys">List of keys that cannot be deobfuscated.</param>
private void CollectForDeobfuscation(JToken token, List<JProperty> jProperties, HashSet<string> keys)
private static void GetPropertiesToDeobfuscate(JToken token, List<JProperty> jProperties, HashSet<string> keys)
{
if (token.Type == JTokenType.Property)
{
Expand All @@ -177,69 +139,97 @@ private void CollectForDeobfuscation(JToken token, List<JProperty> jProperties,
}
foreach (var child in token.Children().Where(c => c.HasValues))
{
CollectForDeobfuscation(child, jProperties, keys);
GetPropertiesToDeobfuscate(child, jProperties, keys);
}
}

#endregion

#region Getter

/// <summary>
/// Combines the download path from the settings with the filename.
/// Iterates over all JSON properties to collect a list for obfuscation.
/// </summary>
/// <returns></returns>
private string GetCombinedPath()
/// <param name="token">Current property that should be obfuscated.</param>
/// <param name="jProperties">List of properties that need to be obfuscated.</param>
private static void GetPropertiesToObfuscate(JToken token, List<JProperty> jProperties)
{
return Path.Combine(Path.GetFullPath(_settings.PathDownload), Properties.Resources.RELEASE_ASSET);
if (token.Type == JTokenType.Property)
{
var property = token as JProperty;
if (_mapForObfuscation.ContainsKey(property!.Name))
{
jProperties.Add(property);
}
}
foreach (var child in token.Children().Where(c => c.HasValues))
{
GetPropertiesToObfuscate(child, jProperties);
}
}

#endregion

#region Obfuscate
#region Mapping

/// <summary>
/// Obfuscates a file to make it readable by the game.
/// Deobfuscates a file to make it human-readable.
/// </summary>
/// <param name="root">Entire file as JSON object.</param>
public void Obfuscate(JObject root)
/// <returns>List of unknown keys.</returns>
public static HashSet<string> Deobfuscate(JObject root)
{
// Wait in case of currently running update.
_updateTask?.Wait();
EnsurePreconditions();

var jProperties = new List<JProperty>();
var keys = new HashSet<string>();

// Collect all jProperties that need to be renamed.
foreach (var child in root.Children().Where(c => c.HasValues))
{
CollectForObfuscation(child, jProperties);
GetPropertiesToDeobfuscate(child, jProperties, keys);
}

// Actually rename each jProperty.
foreach (var jProperty in jProperties)
{
jProperty.Rename(_mapForObfuscation[jProperty.Name]);
jProperty.Rename(_mapForDeobfuscation[jProperty.Name]);
}

return keys;
}

/// <summary>
/// Iterates over all JSON properties to collect a list for obfuscation.
/// Ensures that the update task is complete and both maps are created.
/// </summary>
/// <param name="token">Current property that should be obfuscated.</param>
/// <param name="jProperties">List of properties that need to be obfuscated.</param>
private void CollectForObfuscation(JToken token, List<JProperty> jProperties)
private static void EnsurePreconditions()
{
if (token.Type == JTokenType.Property)
// Wait in case of currently running update.
_updateTask?.Wait();

// Create map if not done yet.
if (!_mapForDeobfuscation.Any() || !_mapForObfuscation.Any())
{
var property = token as JProperty;
if (_mapForObfuscation.ContainsKey(property!.Name))
{
jProperties.Add(property);
}
CreateMap();
}
foreach (var child in token.Children().Where(c => c.HasValues))
}

/// <summary>
/// Obfuscates a file to make it readable by the game.
/// </summary>
/// <param name="root">Entire file as JSON object.</param>
public static void Obfuscate(JObject root)
{
EnsurePreconditions();

var jProperties = new List<JProperty>();

// Collect all jProperties that need to be renamed.
foreach (var child in root.Children().Where(c => c.HasValues))
{
CollectForObfuscation(child, jProperties);
GetPropertiesToObfuscate(child, jProperties);
}

// Actually rename each jProperty.
foreach (var jProperty in jProperties)
{
jProperty.Rename(_mapForObfuscation[jProperty.Name]);
}
}

Expand All @@ -251,7 +241,7 @@ private void CollectForObfuscation(JToken token, List<JProperty> jProperties)
/// Downloads the lastet mapping file and updates the maps.
/// </summary>
/// <returns>Whether a newer version of the mapping file was successfully downloaded.</returns>
public bool Update()
public static bool Update()
{
var result = false;
if (!IsRunning)
Expand All @@ -273,7 +263,7 @@ public bool Update()
/// Downloads the lastet mapping file and updates the maps.
/// This method does not block the calling thread.
/// </summary>
public void UpdateAsync()
public static void UpdateAsync()
{
// No need to run if currently running.
if (IsRunning)
Expand All @@ -294,13 +284,14 @@ public void UpdateAsync()
/// This method does not block the calling thread.
/// </summary>
/// <returns>Whether a newer version of the mapping file was successfully downloaded.</returns>
private async Task<bool> DownloadAsync()
private static async Task<bool> DownloadAsync()
{
var content = await _httpClient.DownloadTextFileContentFromGitHubReleaseAsync(Properties.Resources.REPO_OWNER, Properties.Resources.REPO_NAME, Properties.Resources.RELEASE_ASSET);
if (string.IsNullOrEmpty(content))
return false;

Directory.CreateDirectory(new FileInfo(_path).DirectoryName!);
// File does not matter until next startup and therefore no need to wait.
_ = File.WriteAllTextAsync(_path, content);

_jsonDownload = MappingJson.Deserialize(content);
Expand Down
2 changes: 1 addition & 1 deletion libNOM.map/MappingSettings.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ public record MappingSettings
/// <summary>
/// Where to download the mapping.json.
/// </summary>
public string PathDownload { get; set; } = "download";
public string PathDownload { get; init; } = "download";
}
Loading

0 comments on commit 35d6a02

Please sign in to comment.