chillcog/SPT-Server-Build
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #107 from tetrisdev/ServersComments

Browse Source 
Change Servers comments
This commit is contained in:
Chomp
2025-03-05 21:35:01 +00:00
committed by GitHub
parent bf00a3e1c3 cafe9ff543
commit 70cd8b709d
4 changed files with 91 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Libraries/Core/Servers/Http/SptHttpListener.cs
+18 -18
View File
@@ -130,14 +130,14 @@ public class SptHttpListener : IHttpListener
}
}
/**
* Send HTTP response back to sender
* @param sessionID Player id making request
* @param req Incoming request
* @param resp Outgoing response
* @param body Buffer
* @param output Server generated response data
*/
/// <summary>
/// Send HTTP response back to sender
/// </summary>
/// <param name="sessionID"> Player id making request </param>
/// <param name="req"> Incoming request </param>
/// <param name="resp"> Outgoing response </param>
/// <param name="body"> Buffer </param>
/// <param name="output"> Server generated response data</param>
public void SendResponse(
string sessionID,
HttpRequest req,
@@ -181,21 +181,21 @@ public class SptHttpListener : IHttpListener
LogRequest(req, output);
}
/**
* Is request flagged as debug enabled
* @param req Incoming request
* @returns True if request is flagged as debug
*/
/// <summary>
/// Is request flagged as debug enabled
/// </summary>
/// <param name="req"> Incoming request </param>
/// <returns> True if request is flagged as debug </returns>
protected bool IsDebugRequest(HttpRequest req)
{
return req.Headers.TryGetValue("responsecompressed", out var value) && value == "0";
}
/**
* Log request if enabled
* @param req Incoming message request
* @param output Output string
*/
/// <summary>
/// Log request if enabled
/// </summary>
/// <param name="req"> Log request if enabled </param>
/// <param name="output"> Output string </param>
protected void LogRequest(HttpRequest req, string output)
{
if (ProgramStatics.ENTRY_TYPE() != EntryType.RELEASE)
Libraries/Core/Servers/HttpServer.cs
+10
View File
@@ -26,6 +26,11 @@ public class HttpServer(
private readonly HttpConfig _httpConfig = _configServer.GetConfig<HttpConfig>();
private bool _started;
/// <summary>
/// Handle server loading event
/// </summary>
/// <param name="builder"> Server builder </param>
/// <exception cref="Exception"> Throws Exception when WebApplicationBuiler or WebApplication are null </exception>
public void Load(WebApplicationBuilder? builder)
{
if (builder is null)
@@ -132,6 +137,11 @@ public class HttpServer(
// This http request would be passed through the SPT Router and handled by an ICallback
}
/// <summary>
/// Check against hardcoded values that determine it's from a local address
/// </summary>
/// <param name="remoteAddress"> Address to check </param>
/// <returns> True if its local </returns>
private bool? IsLocalRequest(string? remoteAddress)
{
if (remoteAddress == null)
Libraries/Core/Servers/RagfairServer.cs
+8 -8
View File
@@ -66,10 +66,10 @@ public class RagfairServer(
_ragfairRequiredItemsService.BuildRequiredItemTable();
}
/**
* Get traders who need to be periodically refreshed
* @returns string array of traders
*/
/// <summary>
/// Get traders who need to be periodically refreshed
/// </summary>
/// <returns> List of traders </returns>
public List<string> GetUpdateableTraders()
{
return _ragfairConfig.Traders.Keys.ToList();
@@ -84,10 +84,10 @@ public class RagfairServer(
return _ragfairCategoriesService.GetCategoriesFromOffers(offers, searchRequestData, fleaUnlocked);
}
/**
* Disable/Hide an offer from flea
* @param offerId
*/
/// <summary>
/// Disable/Hide an offer from flea
/// </summary>
/// <param name="offerId"> OfferID to hide </param>
public void HideOffer(string offerId)
{
var offers = _ragfairOfferService.GetOffers();
Libraries/Core/Servers/SaveServer.cs
+55 -53
View File
@@ -32,20 +32,20 @@ public class SaveServer(
protected ConcurrentDictionary<string, SptProfile> profiles = new();
protected ConcurrentDictionary<string, string> saveMd5 = new();
/**
* Add callback to occur prior to saving profile changes
* @param id Id for save callback
* @param callback Callback to execute prior to running SaveServer.saveProfile()
*/
/// <summary>
/// Add callback to occur prior to saving profile changes
/// </summary>
/// <param name="id"> ID for the save callback </param>
/// <param name="callback"> Callback to execute prior to running SaveServer.saveProfile() </param>
public void AddBeforeSaveCallback(string id, Func<SptProfile, SptProfile> callback)
{
onBeforeSaveCallbacks[id] = callback;
}
/**
* Remove a callback from being executed prior to saving profile in SaveServer.saveProfile()
* @param id Id of callback to remove
*/
/// <summary>
/// Remove a callback from being executed prior to saving profile in SaveServer.saveProfile()
/// </summary>
/// <param name="id"> ID of Callback to remove </param>
public void RemoveBeforeSaveCallback(string id)
{
if (onBeforeSaveCallbacks.ContainsKey(id))
@@ -54,9 +54,9 @@ public class SaveServer(
}
}
/**
* Load all profiles in /user/profiles folder into memory (this.profiles)
*/
/// <summary>
/// Load all profiles in /user/profiles folder into memory (this.profiles)
/// </summary>
public void Load()
{
// get files to load
@@ -81,9 +81,9 @@ public class SaveServer(
}
}
/**
* Save changes for each profile from memory into user/profiles json
*/
/// <summary>
/// Save changes for each profile from memory into user/profiles json
/// </summary>
public void Save()
{
// Save every profile
@@ -99,11 +99,12 @@ public class SaveServer(
}
}
/**
* Get a player profile from memory
* @param sessionId Session id
* @returns ISptProfile
*/
/// <summary>
/// Get a player profile from memory
/// </summary>
/// <param name="sessionId"> Session ID </param>
/// <returns> SptProfile of the player </returns>
/// <exception cref="Exception"> Thrown when sessionId is null / empty or no profiles with that ID are found </exception>
public SptProfile GetProfile(string sessionId)
{
if (string.IsNullOrEmpty(sessionId))
@@ -129,20 +130,20 @@ public class SaveServer(
return profiles.ContainsKey(id);
}
/**
* Get all profiles from memory
* @returns Dictionary of ISptProfile
*/
/// <summary>
/// Gets all profiles from memory
/// </summary>
/// <returns> Dictionary of Profiles with their ID as Keys. </returns>
public Dictionary<string, SptProfile> GetProfiles()
{
return profiles.ToDictionary();
}
/**
* Delete a profile by id
* @param sessionID Id of profile to remove
* @returns true when deleted, false when profile not found
*/
/// <summary>
/// Delete a profile by id (Does not remove the profile file!)
/// </summary>
/// <param name="sessionID"> ID of profile to remove </param>
/// <returns> True when deleted, false when profile not found </returns>
public bool DeleteProfileById(string sessionID)
{
if (profiles.ContainsKey(sessionID))
@@ -156,10 +157,11 @@ public class SaveServer(
return false;
}
/**
* Create a new profile in memory with empty pmc/scav objects
* @param profileInfo Basic profile data
*/
/// <summary>
/// Create a new profile in memory with empty pmc/scav objects
/// </summary>
/// <param name="profileInfo"> Basic profile data </param>
/// <exception cref="Exception"> Thrown when profile already exists </exception>
public void CreateProfile(Info profileInfo)
{
if (profiles.ContainsKey(profileInfo.ProfileId))
@@ -181,20 +183,20 @@ public class SaveServer(
);
}
/**
* Add full profile in memory by key (info.id)
* @param profileDetails Profile to save
*/
/// <summary>
/// Add full profile in memory by key (info.id)
/// </summary>
/// <param name="profileDetails"> Profile to save </param>
public void AddProfile(SptProfile profileDetails)
{
profiles.TryAdd(profileDetails.ProfileInfo.ProfileId, profileDetails);
}
/**
* Look up profile json in user/profiles by id and store in memory
* Execute saveLoadRouters callbacks after being loaded into memory
* @param sessionID Id of profile to store in memory
*/
/// <summary>
/// Look up profile json in user/profiles by id and store in memory. <br/>
/// Execute saveLoadRouters callbacks after being loaded into memory.
/// </summary>
/// <param name="sessionID"> ID of profile to store in memory </param>
public void LoadProfile(string sessionID)
{
var filename = $"{sessionID}.json";
@@ -213,12 +215,12 @@ public class SaveServer(
}
}
/**
* Save changes from in-memory profile to user/profiles json
* Execute onBeforeSaveCallbacks callbacks prior to being saved to json
* @param sessionID profile id (user/profiles/id.json)
* @returns time taken to save in MS
*/
/// <summary>
/// Save changes from in-memory profile to user/profiles json
/// Execute onBeforeSaveCallbacks callbacks prior to being saved to json
/// </summary>
/// <param name="sessionID"> Profile id (user/profiles/id.json) </param>
/// <returns> Time taken to save the profile in seconds </returns>
public long SaveProfile(string sessionID)
{
var filePath = $"{profileFilepath}{sessionID}.json";
@@ -261,11 +263,11 @@ public class SaveServer(
return start.ElapsedMilliseconds;
}
/**
* Remove a physical profile json from user/profiles
* @param sessionID Profile id to remove
* @returns true if file no longer exists
*/
/// <summary>
/// Remove a physical profile json from user/profiles
/// </summary>
/// <param name="sessionID"> Profile ID to remove </param>
/// <returns> True if successful </returns>
public bool RemoveProfile(string sessionID)
{
var file = $"{profileFilepath}{sessionID}.json";