mirror of
https://github.com/sp-tarkov/modules.git
synced 2025-02-13 01:50:45 -05:00
Modernize HTTP v2 (!104)
This PR won't affect modders who have already updated their mods to 3.8.0. They just need to re-compile. This is a resubmission of my previous PR (SPT-AKI/Modules#99) with additional code cleanup and fixes. Instead of outright removing the functionality, this time I deprecate it instead (marked for removal in next release). Requires SPT-AKI/Server#274 to function. ## Overview - HTTP modernization - Adds `Aki.Common.Http.Client`, a replacement for `Aki.Common.Http.Request` and builds on top of `System.Net.Http.HttpClient` - Implements failsafe retries when requesting during busy connections - Improved debugging - Improved performance - Deprecades old request code - Bundle system - Fixes remote downloaded bundles using external IP - Implements functional bundle caching from remote sources - Implements multi-threaded bundle downloads - Implements Unity-compatible bundle format support - Extensive cleanup - Deprecated unneccecary models ## Why? In it's current state, the bundle system is ducktaped together in 2021, fundumentally broken and in desperate need of a cleanup and fixes. The HTTP code hasn't been updated since 2021, and `HttpWebRequest` has been deprecated by Microsoft for a while now. There was also a lot of opportunity left for simple performance gains that even reduces the complexity of the code. As for why not two separate PRs (HTTP modernization, bundle rework): both were deeply interconnected. A change in one requires modification in the other. Hence the current approach. ## Testing The code has been validated and tested by @TheSparta and me. A large section of the code has been implemented and tested extensively by modders. ### Local 1. Start the game from 127.0.0.1 2. The game starts loading bundles from the mods path ### Remote, full re-aquire 1. Start the server from LAN IP (http.json, set host to `cmd > ipconfig` address, example: `192.168.178.32`) 2. Start the game from LAN IP 3. A folder named `user/cache/bundles` is created ### Remote, partial-aquire (deleted) 1. Ensure all bundles are cached 2. Delete one of the aquired bundles from cache 3. Start the server from LAN IP (http.json, set host to `cmd > ipconfig` address, example: `192.168.178.32`) 4. Start the game from LAN IP 5. The bundle is redownloaded ### Remote, partial-aquire (invalid crc) 1. Ensure all bundles are cached 2. Update a bundle mod with a new bundle on the same path 3. Start the server from LAN IP (http.json, set host to `cmd > ipconfig` address, example: `192.168.178.32`) 4. Start the game from LAN IP 5. The bundle is redownloaded ### Remote, use cache 1. Ensure all bundles are cached 2. Start the server from LAN IP (http.json, set host to `cmd > ipconfig` address, example: `192.168.178.32`) 3. Start the game from LAN IP 4. The game starts loading bundles from the cache path ## Risk assessment In order to reduce friction between releases, this PR introduces a deprecation system. Obsolete classes and methods have been marked deprecated. These will remain available for the current release and continue to function as normal for this release. A warning will be displayed during build when a modder relies on the deprecated functionality. The marked classes and methods are to be removed in the next release. The server-side changes have no impact on modders. ## Deprecation The following classes are affected: - `Aki.Common.Http.Request`: Replaced by `Aki.Common.Http.Request` - `Aki.Common.Http.WebConstants`: Replaced by functionality from `System.Net.Http` - `Aki.Custom.Models.BundleInfo`: Replaced by `Aki.Custom.Models.BundleItem` The following methods are affected: - `Aki.Common.Http.RequestHandler.GetData(path, hasHost)`: `hasHost` enables connection outside intended host. - `Aki.Common.Http.RequestHandler.GetJson(path, hasHost)`: `hasHost` enables connection outside intended host. - `Aki.Common.Http.RequestHandler.PostJson(path, json, hasHost)`: `hasHost` enables connection outside intended host. - `Aki.Common.Http.RequestHandler.PutJson(path, json, hasHost)`: `hasHost` enables connection outside intended host. The deprecated methods and `Aki.Custom.Models.BundleInfo` are self-contained and can be removed independently. The deprecated classes require removal of all deprecated code at once. Reviewed-on: SPT-AKI/Modules#104 Reviewed-by: TheSparta <thesparta@noreply.dev.sp-tarkov.com> Co-authored-by: Merijn Hendriks <merijn.d.hendriks@gmail.com> Co-committed-by: Merijn Hendriks <merijn.d.hendriks@gmail.com>
This commit is contained in:
parent
f0c18a5135
commit
9c89c31c68
@ -12,6 +12,7 @@
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<Reference Include="System.Net.http" />
|
||||
<Reference Include="bsg.componentace.compression.libs.zlib" HintPath="..\Shared\Managed\bsg.componentace.compression.libs.zlib.dll" Private="False" />
|
||||
</ItemGroup>
|
||||
|
||||
|
161
project/Aki.Common/Http/Client.cs
Normal file
161
project/Aki.Common/Http/Client.cs
Normal file
@ -0,0 +1,161 @@
|
||||
using System;
|
||||
using System.IO;
|
||||
using System.Net.Http;
|
||||
using Aki.Common.Http;
|
||||
using Aki.Common.Utils;
|
||||
|
||||
namespace Aki.Common.Http
|
||||
{
|
||||
// NOTE: you do not want to dispose this, keep a reference for the lifetime
|
||||
// of the application.
|
||||
// NOTE: cannot be made async due to Unity's limitations.
|
||||
public class Client : IDisposable
|
||||
{
|
||||
protected readonly HttpClient _httpv;
|
||||
protected readonly string _address;
|
||||
protected readonly string _accountId;
|
||||
protected readonly int _retries;
|
||||
|
||||
public Client(string address, string accountId, int retries = 3)
|
||||
{
|
||||
_address = address;
|
||||
_accountId = accountId;
|
||||
_retries = retries;
|
||||
|
||||
var handler = new HttpClientHandler()
|
||||
{
|
||||
// force setting cookies in header instead of CookieContainer
|
||||
UseCookies = false
|
||||
};
|
||||
|
||||
_httpv = new HttpClient(handler);
|
||||
}
|
||||
|
||||
private HttpRequestMessage GetNewRequest(HttpMethod method, string path)
|
||||
{
|
||||
return new HttpRequestMessage()
|
||||
{
|
||||
Method = method,
|
||||
RequestUri = new Uri(_address + path),
|
||||
Headers = {
|
||||
{ "Cookie", $"PHPSESSID={_accountId}" }
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
protected byte[] Send(HttpMethod method, string path, byte[] data, bool compress = true)
|
||||
{
|
||||
HttpResponseMessage response = null;
|
||||
|
||||
using (var request = GetNewRequest(method, path))
|
||||
{
|
||||
if (data != null)
|
||||
{
|
||||
// if there is data, convert to payload
|
||||
byte[] payload = (compress)
|
||||
? Zlib.Compress(data, ZlibCompression.Maximum)
|
||||
: data;
|
||||
|
||||
// add payload to request
|
||||
request.Content = new ByteArrayContent(payload);
|
||||
}
|
||||
|
||||
// send request
|
||||
response = _httpv.SendAsync(request).Result;
|
||||
}
|
||||
|
||||
if (!response.IsSuccessStatusCode)
|
||||
{
|
||||
// response error
|
||||
throw new Exception($"Code {response.StatusCode}");
|
||||
}
|
||||
|
||||
using (var ms = new MemoryStream())
|
||||
{
|
||||
using (var stream = response.Content.ReadAsStreamAsync().Result)
|
||||
{
|
||||
// grap response payload
|
||||
stream.CopyTo(ms);
|
||||
var bytes = ms.ToArray();
|
||||
|
||||
if (bytes != null)
|
||||
{
|
||||
// payload contains data
|
||||
return Zlib.IsCompressed(bytes)
|
||||
? Zlib.Decompress(bytes)
|
||||
: bytes;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// response returned no data
|
||||
return null;
|
||||
}
|
||||
|
||||
public byte[] Get(string path)
|
||||
{
|
||||
var error = new Exception("Internal error");
|
||||
|
||||
// NOTE: <= is intentional, 0 is send, 1,2,3 is retry
|
||||
for (var i = 0; i <= _retries; ++i)
|
||||
{
|
||||
try
|
||||
{
|
||||
return Send(HttpMethod.Get, path, null, false);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
error = ex;
|
||||
}
|
||||
}
|
||||
|
||||
throw error;
|
||||
}
|
||||
|
||||
public byte[] Post(string path, byte[] data, bool compressed = true)
|
||||
{
|
||||
var error = new Exception("Internal error");
|
||||
|
||||
// NOTE: <= is intentional, 0 is send, 1,2,3 is retry
|
||||
for (var i = 0; i <= _retries; ++i)
|
||||
{
|
||||
try
|
||||
{
|
||||
return Send(HttpMethod.Post, path, data, compressed);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
error = ex;
|
||||
}
|
||||
}
|
||||
|
||||
throw error;
|
||||
}
|
||||
|
||||
public void Put(string path, byte[] data, bool compressed = true)
|
||||
{
|
||||
var error = new Exception("Internal error");
|
||||
|
||||
// NOTE: <= is intentional, 0 is send, 1,2,3 is retry
|
||||
for (var i = 0; i <= _retries; ++i)
|
||||
{
|
||||
try
|
||||
{
|
||||
Send(HttpMethod.Put, path, data, compressed);
|
||||
return;
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
error = ex;
|
||||
}
|
||||
}
|
||||
|
||||
throw error;
|
||||
}
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
_httpv.Dispose();
|
||||
}
|
||||
}
|
||||
}
|
@ -1,3 +1,5 @@
|
||||
#region DEPRECATED, REMOVE IN 3.8.1
|
||||
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
@ -6,12 +8,10 @@ using Aki.Common.Utils;
|
||||
|
||||
namespace Aki.Common.Http
|
||||
{
|
||||
[Obsolete("Request is deprecated, please use Aki.Common.Http.Client instead.")]
|
||||
public class Request
|
||||
{
|
||||
/// <summary>
|
||||
/// Send a request to remote endpoint and optionally receive a response body.
|
||||
/// Deflate is the accepted compression format.
|
||||
/// </summary>
|
||||
[Obsolete("Request.Send() is deprecated, please use Aki.Common.Http.Client instead.")]
|
||||
public byte[] Send(string url, string method, byte[] data = null, bool compress = true, string mime = null, Dictionary<string, string> headers = null)
|
||||
{
|
||||
if (!WebConstants.IsValidMethod(method))
|
||||
@ -81,3 +81,5 @@ namespace Aki.Common.Http
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#endregion
|
@ -1,50 +1,46 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Text;
|
||||
using Aki.Common.Utils;
|
||||
using System.Threading.Tasks;
|
||||
using BepInEx.Logging;
|
||||
using Aki.Common.Utils;
|
||||
|
||||
namespace Aki.Common.Http
|
||||
{
|
||||
public static class RequestHandler
|
||||
{
|
||||
private static string _host;
|
||||
private static Request _request;
|
||||
private static Dictionary<string, string> _headers;
|
||||
private static ManualLogSource _logger;
|
||||
|
||||
public static string SessionId { get; private set; }
|
||||
public static readonly Client HttpClient;
|
||||
public static readonly string Host;
|
||||
public static readonly string SessionId;
|
||||
public static readonly bool IsLocal;
|
||||
|
||||
static RequestHandler()
|
||||
{
|
||||
_logger = Logger.CreateLogSource(nameof(RequestHandler));
|
||||
Initialize();
|
||||
}
|
||||
|
||||
// grab required info from command args
|
||||
var args = Environment.GetCommandLineArgs();
|
||||
|
||||
private static void Initialize()
|
||||
{
|
||||
_request = new Request();
|
||||
|
||||
string[] args = Environment.GetCommandLineArgs();
|
||||
|
||||
foreach (string arg in args)
|
||||
foreach (var arg in args)
|
||||
{
|
||||
if (arg.Contains("BackendUrl"))
|
||||
{
|
||||
string json = arg.Replace("-config=", string.Empty);
|
||||
_host = Json.Deserialize<ServerConfig>(json).BackendUrl;
|
||||
var json = arg.Replace("-config=", string.Empty);
|
||||
Host = Json.Deserialize<ServerConfig>(json).BackendUrl;
|
||||
}
|
||||
|
||||
if (arg.Contains("-token="))
|
||||
{
|
||||
SessionId = arg.Replace("-token=", string.Empty);
|
||||
_headers = new Dictionary<string, string>()
|
||||
{
|
||||
{ "Cookie", $"PHPSESSID={SessionId}" },
|
||||
{ "SessionId", SessionId }
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
IsLocal = Host.Contains("127.0.0.1")
|
||||
|| Host.Contains("localhost");
|
||||
|
||||
// initialize http client
|
||||
HttpClient = new Client(Host, SessionId);
|
||||
}
|
||||
|
||||
private static void ValidateData(byte[] data)
|
||||
@ -67,46 +63,129 @@ namespace Aki.Common.Http
|
||||
_logger.LogInfo($"Request was successful");
|
||||
}
|
||||
|
||||
public static byte[] GetData(string path, bool hasHost = false)
|
||||
public static byte[] GetData(string path)
|
||||
{
|
||||
string url = (hasHost) ? path : _host + path;
|
||||
_logger.LogInfo($"Request GET data: {SessionId}:{path}");
|
||||
|
||||
var data = HttpClient.Get(path);
|
||||
|
||||
ValidateData(data);
|
||||
return data;
|
||||
}
|
||||
|
||||
public static string GetJson(string path)
|
||||
{
|
||||
_logger.LogInfo($"Request GET json: {SessionId}:{path}");
|
||||
|
||||
var payload = HttpClient.Get(path);
|
||||
var body = Encoding.UTF8.GetString(payload);
|
||||
|
||||
ValidateJson(body);
|
||||
return body;
|
||||
}
|
||||
|
||||
public static string PostJson(string path, string json)
|
||||
{
|
||||
_logger.LogInfo($"Request POST json: {SessionId}:{path}");
|
||||
|
||||
var payload = Encoding.UTF8.GetBytes(json);
|
||||
var data = HttpClient.Post(path, payload);
|
||||
var body = Encoding.UTF8.GetString(data);
|
||||
|
||||
ValidateJson(body);
|
||||
return body;
|
||||
}
|
||||
|
||||
public static void PutJson(string path, string json)
|
||||
{
|
||||
_logger.LogInfo($"Request PUT json: {SessionId}:{path}");
|
||||
|
||||
var payload = Encoding.UTF8.GetBytes(json);
|
||||
HttpClient.Put(path, payload);
|
||||
}
|
||||
|
||||
#region DEPRECATED, REMOVE IN 3.8.1
|
||||
[Obsolete("GetData(path, isHost) is deprecated, please use GetData(path) instead.")]
|
||||
public static byte[] GetData(string path, bool hasHost)
|
||||
{
|
||||
var url = (hasHost) ? path : Host + path;
|
||||
_logger.LogInfo($"Request GET data: {SessionId}:{url}");
|
||||
byte[] result = _request.Send(url, "GET", null, headers: _headers);
|
||||
|
||||
ValidateData(result);
|
||||
return result;
|
||||
var headers = new Dictionary<string, string>()
|
||||
{
|
||||
{ "Cookie", $"PHPSESSID={SessionId}" },
|
||||
{ "SessionId", SessionId }
|
||||
};
|
||||
|
||||
var request = new Request();
|
||||
var data = request.Send(url, "GET", null, headers: headers);
|
||||
|
||||
ValidateData(data);
|
||||
return data;
|
||||
|
||||
}
|
||||
|
||||
public static string GetJson(string path, bool hasHost = false)
|
||||
[Obsolete("GetJson(path, isHost) is deprecated, please use GetJson(path) instead.")]
|
||||
public static string GetJson(string path, bool hasHost)
|
||||
{
|
||||
string url = (hasHost) ? path : _host + path;
|
||||
|
||||
var url = (hasHost) ? path : Host + path;
|
||||
_logger.LogInfo($"Request GET json: {SessionId}:{url}");
|
||||
byte[] data = _request.Send(url, "GET", headers: _headers);
|
||||
string result = Encoding.UTF8.GetString(data);
|
||||
|
||||
ValidateJson(result);
|
||||
return result;
|
||||
var headers = new Dictionary<string, string>()
|
||||
{
|
||||
{ "Cookie", $"PHPSESSID={SessionId}" },
|
||||
{ "SessionId", SessionId }
|
||||
};
|
||||
|
||||
var request = new Request();
|
||||
var data = request.Send(url, "GET", headers: headers);
|
||||
var body = Encoding.UTF8.GetString(data);
|
||||
|
||||
ValidateJson(body);
|
||||
return body;
|
||||
|
||||
}
|
||||
|
||||
public static string PostJson(string path, string json, bool hasHost = false)
|
||||
[Obsolete("PostJson(path, json, isHost) is deprecated, please use PostJson(path, json) instead.")]
|
||||
public static string PostJson(string path, string json, bool hasHost)
|
||||
{
|
||||
string url = (hasHost) ? path : _host + path;
|
||||
|
||||
var url = (hasHost) ? path : Host + path;
|
||||
_logger.LogInfo($"Request POST json: {SessionId}:{url}");
|
||||
byte[] data = _request.Send(url, "POST", Encoding.UTF8.GetBytes(json), true, "application/json", _headers);
|
||||
string result = Encoding.UTF8.GetString(data);
|
||||
|
||||
ValidateJson(result);
|
||||
return result;
|
||||
var payload = Encoding.UTF8.GetBytes(json);
|
||||
var mime = WebConstants.Mime[".json"];
|
||||
var headers = new Dictionary<string, string>()
|
||||
{
|
||||
{ "Cookie", $"PHPSESSID={SessionId}" },
|
||||
{ "SessionId", SessionId }
|
||||
};
|
||||
|
||||
var request = new Request();
|
||||
var data = request.Send(url, "POST", payload, true, mime, headers);
|
||||
var body = Encoding.UTF8.GetString(data);
|
||||
|
||||
ValidateJson(body);
|
||||
return body;
|
||||
|
||||
}
|
||||
|
||||
public static void PutJson(string path, string json, bool hasHost = false)
|
||||
[Obsolete("PutJson(path, json, isHost) is deprecated, please use PutJson(path, json) instead.")]
|
||||
public static void PutJson(string path, string json, bool hasHost)
|
||||
{
|
||||
string url = (hasHost) ? path : _host + path;
|
||||
var url = (hasHost) ? path : Host + path;
|
||||
_logger.LogInfo($"Request PUT json: {SessionId}:{url}");
|
||||
_request.Send(url, "PUT", Encoding.UTF8.GetBytes(json), true, "application/json", _headers);
|
||||
|
||||
var payload = Encoding.UTF8.GetBytes(json);
|
||||
var mime = WebConstants.Mime[".json"];
|
||||
var headers = new Dictionary<string, string>()
|
||||
{
|
||||
{ "Cookie", $"PHPSESSID={SessionId}" },
|
||||
{ "SessionId", SessionId }
|
||||
};
|
||||
|
||||
var request = new Request();
|
||||
request.Send(url, "PUT", payload, true, mime, headers);
|
||||
}
|
||||
#endregion
|
||||
}
|
||||
}
|
||||
|
@ -1,53 +1,39 @@
|
||||
using System.Collections.Generic;
|
||||
#region DEPRECATED, REMOVE IN 3.8.1
|
||||
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
|
||||
namespace Aki.Common.Http
|
||||
{
|
||||
[Obsolete("WebConstants is deprecated, please use System.Net.Http functionality instead.")]
|
||||
public static class WebConstants
|
||||
{
|
||||
/// <summary>
|
||||
/// HTML GET method.
|
||||
/// </summary>
|
||||
[Obsolete("Get is deprecated, please use HttpMethod.Get instead.")]
|
||||
public const string Get = "GET";
|
||||
|
||||
/// <summary>
|
||||
/// HTML HEAD method.
|
||||
/// </summary>
|
||||
[Obsolete("Head is deprecated, please use HttpMethod.Head instead.")]
|
||||
public const string Head = "HEAD";
|
||||
|
||||
/// <summary>
|
||||
/// HTML POST method.
|
||||
/// </summary>
|
||||
[Obsolete("Post is deprecated, please use HttpMethod.Post instead.")]
|
||||
public const string Post = "POST";
|
||||
|
||||
/// <summary>
|
||||
/// HTML PUT method.
|
||||
/// </summary>
|
||||
[Obsolete("Put is deprecated, please use HttpMethod.Put instead.")]
|
||||
public const string Put = "PUT";
|
||||
|
||||
/// <summary>
|
||||
/// HTML DELETE method.
|
||||
/// </summary>
|
||||
[Obsolete("Delete is deprecated, please use HttpMethod.Delete instead.")]
|
||||
public const string Delete = "DELETE";
|
||||
|
||||
/// <summary>
|
||||
/// HTML CONNECT method.
|
||||
/// </summary>
|
||||
[Obsolete("Connect is deprecated, please use HttpMethod.Connect instead.")]
|
||||
public const string Connect = "CONNECT";
|
||||
|
||||
/// <summary>
|
||||
/// HTML OPTIONS method.
|
||||
/// </summary>
|
||||
[Obsolete("Options is deprecated, please use HttpMethod.Options instead.")]
|
||||
public const string Options = "OPTIONS";
|
||||
|
||||
/// <summary>
|
||||
/// HTML TRACE method.
|
||||
/// </summary>
|
||||
[Obsolete("Trace is deprecated, please use HttpMethod.Trace instead.")]
|
||||
public const string Trace = "TRACE";
|
||||
|
||||
/// <summary>
|
||||
/// HTML MIME types.
|
||||
/// </summary>
|
||||
[Obsolete("Mime is deprecated, there is sadly no replacement.")]
|
||||
public static Dictionary<string, string> Mime { get; private set; }
|
||||
|
||||
static WebConstants()
|
||||
@ -68,9 +54,7 @@ namespace Aki.Common.Http
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Is HTML method valid?
|
||||
/// </summary>
|
||||
[Obsolete("IsValidMethod is deprecated, please check against HttpMethod entries instead.")]
|
||||
public static bool IsValidMethod(string method)
|
||||
{
|
||||
return method == Get
|
||||
@ -83,12 +67,12 @@ namespace Aki.Common.Http
|
||||
|| method == Trace;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Is MIME type valid?
|
||||
/// </summary>
|
||||
[Obsolete("isValidMime is deprecated, there is sadly no replacement available.")]
|
||||
public static bool IsValidMime(string mime)
|
||||
{
|
||||
return Mime.Any(x => x.Value == mime);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#endregion
|
@ -1,5 +1,10 @@
|
||||
namespace Aki.Custom.Models
|
||||
#region DEPRECATED, REMOVE IN 3.8.1
|
||||
|
||||
using System;
|
||||
|
||||
namespace Aki.Custom.Models
|
||||
{
|
||||
[Obsolete("BundleInfo is deprecated, please use BundleItem instead.")]
|
||||
public class BundleInfo
|
||||
{
|
||||
public string Key { get; }
|
||||
@ -14,3 +19,5 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#endregion
|
@ -1,9 +1,29 @@
|
||||
namespace Aki.Custom.Models
|
||||
using System.Runtime.Serialization;
|
||||
|
||||
namespace Aki.Custom.Models
|
||||
{
|
||||
[DataContract]
|
||||
public struct BundleItem
|
||||
{
|
||||
[DataMember(Name = "filename")]
|
||||
public string FileName;
|
||||
|
||||
[DataMember(Name = "crc")]
|
||||
public uint Crc;
|
||||
|
||||
[DataMember(Name = "dependencies")]
|
||||
public string[] Dependencies;
|
||||
|
||||
// exclusive to aki, ignored in EscapeFromTarkov_Data/StreamingAssets/Windows/Windows.json
|
||||
[DataMember(Name = "modpath")]
|
||||
public string ModPath;
|
||||
|
||||
public BundleItem(string filename, uint crc, string[] dependencies, string modpath = "")
|
||||
{
|
||||
FileName = filename;
|
||||
Crc = crc;
|
||||
Dependencies = dependencies;
|
||||
ModPath = modpath;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -72,7 +72,6 @@ namespace Aki.Custom.Patches
|
||||
var bundleNames = manifest.GetAllAssetBundles()
|
||||
.Union(BundleManager.Bundles.Keys)
|
||||
.ToArray();
|
||||
var bundles = (IEasyBundle[])Array.CreateInstance(EasyBundleHelper.Type, bundleNames.Length);
|
||||
|
||||
// create bundle lock
|
||||
if (bundleLock == null)
|
||||
@ -81,6 +80,8 @@ namespace Aki.Custom.Patches
|
||||
}
|
||||
|
||||
// create bundle of obfuscated type
|
||||
var bundles = (IEasyBundle[])Array.CreateInstance(EasyBundleHelper.Type, bundleNames.Length);
|
||||
|
||||
for (var i = 0; i < bundleNames.Length; i++)
|
||||
{
|
||||
bundles[i] = (IEasyBundle)Activator.CreateInstance(EasyBundleHelper.Type, new object[]
|
||||
|
@ -27,26 +27,26 @@ namespace Aki.Custom.Patches
|
||||
[PatchPostfix]
|
||||
private static void PatchPostfix(object __instance, string key, string rootPath, CompatibilityAssetBundleManifest manifest, IBundleLock bundleLock)
|
||||
{
|
||||
var path = rootPath + key;
|
||||
var dependencyKeys = manifest.GetDirectDependencies(key) ?? Array.Empty<string>();
|
||||
var filepath = rootPath + key;
|
||||
var dependencies = manifest.GetDirectDependencies(key) ?? Array.Empty<string>();
|
||||
|
||||
if (BundleManager.Bundles.TryGetValue(key, out BundleInfo bundle))
|
||||
if (BundleManager.Bundles.TryGetValue(key, out BundleItem bundle))
|
||||
{
|
||||
// server bundle
|
||||
dependencyKeys = (dependencyKeys.Length > 0)
|
||||
? dependencyKeys.Union(bundle.DependencyKeys).ToArray()
|
||||
: bundle.DependencyKeys;
|
||||
dependencies = (dependencies.Length > 0)
|
||||
? dependencies.Union(bundle.Dependencies).ToArray()
|
||||
: bundle.Dependencies;
|
||||
|
||||
// set path to either cachedpath (HTTP) or modpath (local)
|
||||
path = bundle.Path;
|
||||
// set path to either cache (HTTP) or mod (local)
|
||||
filepath = BundleManager.GetBundlePath(bundle);
|
||||
}
|
||||
|
||||
_ = new EasyBundleHelper(__instance)
|
||||
{
|
||||
Key = key,
|
||||
Path = path,
|
||||
Path = filepath,
|
||||
KeyWithoutExtension = Path.GetFileNameWithoutExtension(key),
|
||||
DependencyKeys = dependencyKeys,
|
||||
DependencyKeys = dependencies,
|
||||
LoadState = new BindableState<ELoadState>(ELoadState.Unloaded, null),
|
||||
BundleLock = bundleLock
|
||||
};
|
||||
|
@ -1,50 +1,109 @@
|
||||
using System.Collections.Generic;
|
||||
using System.Text.RegularExpressions;
|
||||
using System.Collections.Concurrent;
|
||||
using System.Threading.Tasks;
|
||||
using BepInEx.Logging;
|
||||
using Newtonsoft.Json;
|
||||
using Aki.Common.Http;
|
||||
using Aki.Common.Utils;
|
||||
using Aki.Custom.Models;
|
||||
using Newtonsoft.Json.Linq;
|
||||
|
||||
namespace Aki.Custom.Utils
|
||||
{
|
||||
public static class BundleManager
|
||||
{
|
||||
public const string CachePath = "user/cache/bundles/";
|
||||
public static Dictionary<string, BundleInfo> Bundles { get; private set; }
|
||||
private static ManualLogSource _logger;
|
||||
public static readonly ConcurrentDictionary<string, BundleItem> Bundles;
|
||||
public static string CachePath;
|
||||
|
||||
static BundleManager()
|
||||
{
|
||||
Bundles = new Dictionary<string, BundleInfo>();
|
||||
_logger = Logger.CreateLogSource(nameof(BundleManager));
|
||||
Bundles = new ConcurrentDictionary<string, BundleItem>();
|
||||
CachePath = "user/cache/bundles/";
|
||||
}
|
||||
|
||||
if (VFS.Exists(CachePath))
|
||||
{
|
||||
VFS.DeleteDirectory(CachePath);
|
||||
}
|
||||
public static string GetBundlePath(BundleItem bundle)
|
||||
{
|
||||
return RequestHandler.IsLocal
|
||||
? $"{bundle.ModPath}/bundles/{bundle.FileName}"
|
||||
: CachePath + bundle.FileName;
|
||||
}
|
||||
|
||||
public static void GetBundles()
|
||||
{
|
||||
// get bundles
|
||||
var json = RequestHandler.GetJson("/singleplayer/bundles");
|
||||
var jArray = JArray.Parse(json);
|
||||
var bundles = JsonConvert.DeserializeObject<BundleItem[]>(json);
|
||||
|
||||
foreach (var jObj in jArray)
|
||||
// register bundles
|
||||
var toDownload = new ConcurrentBag<BundleItem>();
|
||||
|
||||
Parallel.ForEach(bundles, (bundle) =>
|
||||
{
|
||||
var key = jObj["key"].ToString();
|
||||
var path = jObj["path"].ToString();
|
||||
var bundle = new BundleInfo(key, path, jObj["dependencyKeys"].ToObject<string[]>());
|
||||
Bundles.TryAdd(bundle.FileName, bundle);
|
||||
|
||||
if (path.Contains("http"))
|
||||
if (ShouldReaquire(bundle))
|
||||
{
|
||||
var filepath = CachePath + Regex.Split(path, "bundle/", RegexOptions.IgnoreCase)[1];
|
||||
var data = RequestHandler.GetData(path, true);
|
||||
VFS.WriteFile(filepath, data);
|
||||
bundle.Path = filepath;
|
||||
// mark for download
|
||||
toDownload.Add(bundle);
|
||||
}
|
||||
});
|
||||
|
||||
Bundles.Add(key, bundle);
|
||||
if (RequestHandler.IsLocal)
|
||||
{
|
||||
// loading from local mods
|
||||
_logger.LogInfo("CACHE: Loading all bundles from mods on disk.");
|
||||
return;
|
||||
}
|
||||
else
|
||||
{
|
||||
// download bundles
|
||||
// NOTE: assumes bundle keys to be unique
|
||||
Parallel.ForEach(toDownload, (bundle) =>
|
||||
{
|
||||
// download bundle
|
||||
var filepath = GetBundlePath(bundle);
|
||||
var data = RequestHandler.GetData($"/files/bundle/{bundle.FileName}");
|
||||
VFS.WriteFile(filepath, data);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
private static bool ShouldReaquire(BundleItem bundle)
|
||||
{
|
||||
if (RequestHandler.IsLocal)
|
||||
{
|
||||
// only handle remote bundles
|
||||
return false;
|
||||
}
|
||||
|
||||
VFS.WriteTextFile(CachePath + "bundles.json", Json.Serialize<Dictionary<string, BundleInfo>>(Bundles));
|
||||
// read cache
|
||||
var filepath = CachePath + bundle.FileName;
|
||||
|
||||
if (VFS.Exists(filepath))
|
||||
{
|
||||
// calculate hash
|
||||
var data = VFS.ReadFile(filepath);
|
||||
var crc = Crc32.Compute(data);
|
||||
|
||||
if (crc == bundle.Crc)
|
||||
{
|
||||
// file is up-to-date
|
||||
_logger.LogInfo($"CACHE: Loading locally {bundle.FileName}");
|
||||
return false;
|
||||
}
|
||||
else
|
||||
{
|
||||
// crc doesn't match, reaquire the file
|
||||
_logger.LogInfo($"CACHE: Bundle is invalid, (re-)acquiring {bundle.FileName}");
|
||||
return true;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
// file doesn't exist in cache
|
||||
_logger.LogInfo($"CACHE: Bundle is missing, (re-)acquiring {bundle.FileName}");
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
80
project/Aki.Custom/Utils/Crc32.cs
Normal file
80
project/Aki.Custom/Utils/Crc32.cs
Normal file
@ -0,0 +1,80 @@
|
||||
/*
|
||||
By Senko-san (Merijn Hendriks)
|
||||
Taken from https://github.com/spt-haru/haru
|
||||
*/
|
||||
|
||||
using System;
|
||||
|
||||
namespace Aki.Custom.Utils
|
||||
{
|
||||
public class Crc32
|
||||
{
|
||||
private static readonly uint[] _lookupTable = new uint[]
|
||||
{
|
||||
0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA, 0x076DC419,
|
||||
0x706AF48F, 0xE963A535, 0x9E6495A3, 0x0EDB8832, 0x79DCB8A4,
|
||||
0xE0D5E91E, 0x97D2D988, 0x09B64C2B, 0x7EB17CBD, 0xE7B82D07,
|
||||
0x90BF1D91, 0x1DB71064, 0x6AB020F2, 0xF3B97148, 0x84BE41DE,
|
||||
0x1ADAD47D, 0x6DDDE4EB, 0xF4D4B551, 0x83D385C7, 0x136C9856,
|
||||
0x646BA8C0, 0xFD62F97A, 0x8A65C9EC, 0x14015C4F, 0x63066CD9,
|
||||
0xFA0F3D63, 0x8D080DF5, 0x3B6E20C8, 0x4C69105E, 0xD56041E4,
|
||||
0xA2677172, 0x3C03E4D1, 0x4B04D447, 0xD20D85FD, 0xA50AB56B,
|
||||
0x35B5A8FA, 0x42B2986C, 0xDBBBC9D6, 0xACBCF940, 0x32D86CE3,
|
||||
0x45DF5C75, 0xDCD60DCF, 0xABD13D59, 0x26D930AC, 0x51DE003A,
|
||||
0xC8D75180, 0xBFD06116, 0x21B4F4B5, 0x56B3C423, 0xCFBA9599,
|
||||
0xB8BDA50F, 0x2802B89E, 0x5F058808, 0xC60CD9B2, 0xB10BE924,
|
||||
0x2F6F7C87, 0x58684C11, 0xC1611DAB, 0xB6662D3D, 0x76DC4190,
|
||||
0x01DB7106, 0x98D220BC, 0xEFD5102A, 0x71B18589, 0x06B6B51F,
|
||||
0x9FBFE4A5, 0xE8B8D433, 0x7807C9A2, 0x0F00F934, 0x9609A88E,
|
||||
0xE10E9818, 0x7F6A0DBB, 0x086D3D2D, 0x91646C97, 0xE6635C01,
|
||||
0x6B6B51F4, 0x1C6C6162, 0x856530D8, 0xF262004E, 0x6C0695ED,
|
||||
0x1B01A57B, 0x8208F4C1, 0xF50FC457, 0x65B0D9C6, 0x12B7E950,
|
||||
0x8BBEB8EA, 0xFCB9887C, 0x62DD1DDF, 0x15DA2D49, 0x8CD37CF3,
|
||||
0xFBD44C65, 0x4DB26158, 0x3AB551CE, 0xA3BC0074, 0xD4BB30E2,
|
||||
0x4ADFA541, 0x3DD895D7, 0xA4D1C46D, 0xD3D6F4FB, 0x4369E96A,
|
||||
0x346ED9FC, 0xAD678846, 0xDA60B8D0, 0x44042D73, 0x33031DE5,
|
||||
0xAA0A4C5F, 0xDD0D7CC9, 0x5005713C, 0x270241AA, 0xBE0B1010,
|
||||
0xC90C2086, 0x5768B525, 0x206F85B3, 0xB966D409, 0xCE61E49F,
|
||||
0x5EDEF90E, 0x29D9C998, 0xB0D09822, 0xC7D7A8B4, 0x59B33D17,
|
||||
0x2EB40D81, 0xB7BD5C3B, 0xC0BA6CAD, 0xEDB88320, 0x9ABFB3B6,
|
||||
0x03B6E20C, 0x74B1D29A, 0xEAD54739, 0x9DD277AF, 0x04DB2615,
|
||||
0x73DC1683, 0xE3630B12, 0x94643B84, 0x0D6D6A3E, 0x7A6A5AA8,
|
||||
0xE40ECF0B, 0x9309FF9D, 0x0A00AE27, 0x7D079EB1, 0xF00F9344,
|
||||
0x8708A3D2, 0x1E01F268, 0x6906C2FE, 0xF762575D, 0x806567CB,
|
||||
0x196C3671, 0x6E6B06E7, 0xFED41B76, 0x89D32BE0, 0x10DA7A5A,
|
||||
0x67DD4ACC, 0xF9B9DF6F, 0x8EBEEFF9, 0x17B7BE43, 0x60B08ED5,
|
||||
0xD6D6A3E8, 0xA1D1937E, 0x38D8C2C4, 0x4FDFF252, 0xD1BB67F1,
|
||||
0xA6BC5767, 0x3FB506DD, 0x48B2364B, 0xD80D2BDA, 0xAF0A1B4C,
|
||||
0x36034AF6, 0x41047A60, 0xDF60EFC3, 0xA867DF55, 0x316E8EEF,
|
||||
0x4669BE79, 0xCB61B38C, 0xBC66831A, 0x256FD2A0, 0x5268E236,
|
||||
0xCC0C7795, 0xBB0B4703, 0x220216B9, 0x5505262F, 0xC5BA3BBE,
|
||||
0xB2BD0B28, 0x2BB45A92, 0x5CB36A04, 0xC2D7FFA7, 0xB5D0CF31,
|
||||
0x2CD99E8B, 0x5BDEAE1D, 0x9B64C2B0, 0xEC63F226, 0x756AA39C,
|
||||
0x026D930A, 0x9C0906A9, 0xEB0E363F, 0x72076785, 0x05005713,
|
||||
0x95BF4A82, 0xE2B87A14, 0x7BB12BAE, 0x0CB61B38, 0x92D28E9B,
|
||||
0xE5D5BE0D, 0x7CDCEFB7, 0x0BDBDF21, 0x86D3D2D4, 0xF1D4E242,
|
||||
0x68DDB3F8, 0x1FDA836E, 0x81BE16CD, 0xF6B9265B, 0x6FB077E1,
|
||||
0x18B74777, 0x88085AE6, 0xFF0F6A70, 0x66063BCA, 0x11010B5C,
|
||||
0x8F659EFF, 0xF862AE69, 0x616BFFD3, 0x166CCF45, 0xA00AE278,
|
||||
0xD70DD2EE, 0x4E048354, 0x3903B3C2, 0xA7672661, 0xD06016F7,
|
||||
0x4969474D, 0x3E6E77DB, 0xAED16A4A, 0xD9D65ADC, 0x40DF0B66,
|
||||
0x37D83BF0, 0xA9BCAE53, 0xDEBB9EC5, 0x47B2CF7F, 0x30B5FFE9,
|
||||
0xBDBDF21C, 0xCABAC28A, 0x53B39330, 0x24B4A3A6, 0xBAD03605,
|
||||
0xCDD70693, 0x54DE5729, 0x23D967BF, 0xB3667A2E, 0xC4614AB8,
|
||||
0x5D681B02, 0x2A6F2B94, 0xB40BBE37, 0xC30C8EA1, 0x5A05DF1B,
|
||||
0x2D02EF8D
|
||||
};
|
||||
|
||||
public static uint Compute(byte[] bytes)
|
||||
{
|
||||
var crc = uint.MaxValue;
|
||||
|
||||
foreach (var octet in bytes)
|
||||
{
|
||||
crc = _lookupTable[(crc ^ octet) & byte.MaxValue] ^ crc >> 8;
|
||||
}
|
||||
|
||||
return ~crc;
|
||||
}
|
||||
}
|
||||
}
|
Loading…
x
Reference in New Issue
Block a user