Archangel
292 lines
12 KiB
C#
292 lines
12 KiB
C#
using SPTarkov.DI.Annotations;
|
|
using SPTarkov.Server.Core.Exceptions.Items;
|
|
using SPTarkov.Server.Core.Extensions;
|
|
using SPTarkov.Server.Core.Models.Common;
|
|
using SPTarkov.Server.Core.Models.Eft.Common.Tables;
|
|
using SPTarkov.Server.Core.Models.Eft.Profile;
|
|
using SPTarkov.Server.Core.Models.Enums;
|
|
using SPTarkov.Server.Core.Models.Spt.Config;
|
|
using SPTarkov.Server.Core.Models.Utils;
|
|
using SPTarkov.Server.Core.Servers;
|
|
using SPTarkov.Server.Core.Services;
|
|
|
|
namespace SPTarkov.Server.Core.Helpers;
|
|
|
|
[Injectable]
|
|
public class ProfileValidatorHelper(
|
|
ConfigServer configServer,
|
|
DatabaseService databaseService,
|
|
ISptLogger<ProfileValidatorHelper> logger,
|
|
ServerLocalisationService serverLocalisationService,
|
|
TraderStore traderStore
|
|
)
|
|
{
|
|
protected readonly CoreConfig _coreConfig = configServer.GetConfig<CoreConfig>();
|
|
|
|
/// <summary>
|
|
/// Checks profile inventory for items that do not exist inside the items DB
|
|
/// </summary>
|
|
/// <param name="sessionId"> Session ID </param>
|
|
/// <param name="fullProfile"> Profile to check inventory of </param>
|
|
/// <exception cref="InvalidModdedItemException">Thrown if <see cref="GameFixes.RemoveModItemsFromProfile">RemoveModItemsFromProfile</see> is false.</exception>
|
|
/// <exception cref="InvalidModdedClothingException">Thrown if <see cref="GameFixes.RemoveModItemsFromProfile">RemoveModItemsFromProfile</see> is false.</exception>
|
|
/// <exception cref="InvalidModdedTraderException">Thrown if <see cref="GameFixes.RemoveModItemsFromProfile">RemoveModItemsFromProfile</see> is false.</exception>
|
|
public void CheckForOrphanedModdedItems(MongoId sessionId, SptProfile fullProfile)
|
|
{
|
|
var itemsDb = databaseService.GetItems();
|
|
var pmcProfile = fullProfile.CharacterData.PmcData;
|
|
|
|
var invalidItemIds = pmcProfile.Inventory.Items.Where(item => !itemsDb.ContainsKey(item.Template)).Select(item => item.Id).ToList();
|
|
foreach (var invalidItemId in invalidItemIds)
|
|
{
|
|
if (_coreConfig.Fixes.RemoveModItemsFromProfile)
|
|
{
|
|
logger.Warning($"Deleting item id: {invalidItemId} from inventory and insurance");
|
|
|
|
// Add here so we can remove below
|
|
pmcProfile.RemoveItem(invalidItemId, sessionId);
|
|
}
|
|
else
|
|
{
|
|
throw new InvalidModdedItemException(serverLocalisationService.GetText("fixer-mod_item_found", invalidItemId.ToString()));
|
|
}
|
|
}
|
|
|
|
if (fullProfile.UserBuildData is not null)
|
|
{
|
|
// Remove invalid builds from weapon, equipment and magazine build lists
|
|
var weaponBuilds = fullProfile.UserBuildData?.WeaponBuilds ?? [];
|
|
fullProfile.UserBuildData.WeaponBuilds = weaponBuilds
|
|
.Where(build => !ShouldRemoveWeaponEquipmentBuild("weapon", build, itemsDb))
|
|
.ToList();
|
|
|
|
var equipmentBuilds = fullProfile.UserBuildData.EquipmentBuilds ?? [];
|
|
fullProfile.UserBuildData.EquipmentBuilds = equipmentBuilds
|
|
.Where(build => !ShouldRemoveWeaponEquipmentBuild("equipment", build, itemsDb))
|
|
.ToList();
|
|
|
|
var magazineBuild = fullProfile.UserBuildData.MagazineBuilds ?? [];
|
|
fullProfile.UserBuildData.MagazineBuilds = magazineBuild.Where(build => !ShouldRemoveMagazineBuild(build, itemsDb)).ToList();
|
|
}
|
|
|
|
// Iterate over dialogs, looking for messages with items not found in item db, remove message if item found
|
|
foreach (var dialog in fullProfile.DialogueRecords)
|
|
{
|
|
if (dialog.Value.Messages is null)
|
|
{
|
|
continue; // Skip dialog with no messages
|
|
}
|
|
|
|
foreach (var message in dialog.Value.Messages)
|
|
{
|
|
if (message.Items?.Data is null)
|
|
{
|
|
continue; // skip messages with no items
|
|
}
|
|
|
|
// Fix message with no items but have the flags to indicate items to collect
|
|
if (message.Items.Data.Count == 0 && message.HasRewards.GetValueOrDefault(false))
|
|
{
|
|
message.HasRewards = false;
|
|
message.RewardCollected = true;
|
|
continue;
|
|
}
|
|
|
|
// Find invalid items and remove from message
|
|
var itemsToRemove = message.Items.Data.Where(item => !itemsDb.ContainsKey(item.Template)).ToList();
|
|
foreach (var itemToRemove in itemsToRemove)
|
|
{
|
|
if (_coreConfig.Fixes.RemoveModItemsFromProfile)
|
|
{
|
|
message.Items.Data.Remove(itemToRemove);
|
|
logger.Warning(
|
|
$"Item: {itemToRemove.Template} has resulted in the deletion of message: {message.Id} from dialog: {dialog.Key}"
|
|
);
|
|
}
|
|
else
|
|
{
|
|
throw new InvalidModdedItemException(
|
|
serverLocalisationService.GetText("fixer-mod_item_found", itemToRemove.Template.ToString())
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
var clothingDb = databaseService.GetTemplates().Customization;
|
|
foreach (
|
|
var clothingItem in fullProfile
|
|
.CustomisationUnlocks.Where(customisation => customisation.Type == CustomisationType.SUITE)
|
|
.ToList() // We're removing element, ToList to allow that to occur
|
|
)
|
|
{
|
|
if (!clothingDb.ContainsKey(clothingItem.Id))
|
|
{
|
|
if (_coreConfig.Fixes.RemoveModItemsFromProfile)
|
|
{
|
|
fullProfile.CustomisationUnlocks.Remove(clothingItem);
|
|
logger.Warning($"Non-default clothing purchase: {clothingItem} removed from profile");
|
|
}
|
|
else
|
|
{
|
|
throw new InvalidModdedClothingException(
|
|
serverLocalisationService.GetText("fixer-clothing_item_found", clothingItem.ToString())
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
foreach (var repeatable in fullProfile.CharacterData.PmcData.RepeatableQuests ?? [])
|
|
{
|
|
if (repeatable.ActiveQuests is null)
|
|
{
|
|
continue;
|
|
}
|
|
|
|
// ToList to prevent `Collection was modified` exception
|
|
foreach (var activeQuest in repeatable.ActiveQuests.ToList())
|
|
{
|
|
if (!DoesTraderExist(activeQuest.TraderId))
|
|
{
|
|
if (_coreConfig.Fixes.RemoveModItemsFromProfile)
|
|
{
|
|
logger.Warning(
|
|
$"Non-default quest: {activeQuest.Id} from trader: {activeQuest.TraderId} removed from RepeatableQuests list in profile"
|
|
);
|
|
repeatable.ActiveQuests.Remove(activeQuest);
|
|
}
|
|
else
|
|
{
|
|
throw new InvalidModdedTraderException(
|
|
serverLocalisationService.GetText("fixer-trader_found", activeQuest.TraderId.ToString())
|
|
);
|
|
}
|
|
|
|
continue;
|
|
}
|
|
|
|
if (activeQuest.Rewards?["Success"] is null)
|
|
{
|
|
continue;
|
|
}
|
|
|
|
// Get Item rewards only
|
|
foreach (var successReward in activeQuest.Rewards["Success"].Where(reward => reward.Type == RewardType.Item))
|
|
{
|
|
if (successReward.Items.Any(item => !itemsDb.ContainsKey(item.Template)))
|
|
{
|
|
logger.Warning(
|
|
$"Non-default repeatable quest: {activeQuest.Id} from trader: {activeQuest.TraderId} removed from RepeatableQuests list in profile"
|
|
);
|
|
repeatable.ActiveQuests.Remove(activeQuest);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
foreach (var (traderId, _) in fullProfile.TraderPurchases.Where(traderPurchase => !DoesTraderExist(traderPurchase.Key)))
|
|
{
|
|
if (_coreConfig.Fixes.RemoveModItemsFromProfile)
|
|
{
|
|
logger.Warning($"Non-default trader: {traderId} purchase removed from traderPurchases list in profile");
|
|
fullProfile.TraderPurchases.Remove(traderId);
|
|
}
|
|
else
|
|
{
|
|
throw new InvalidModdedTraderException(serverLocalisationService.GetText("fixer-trader_found", traderId.ToString()));
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Check whether a weapon build should be removed from the equipment list.
|
|
/// </summary>
|
|
/// <param name="buildType"> The type of build, used for logging only </param>
|
|
/// <param name="build"> The build to check for invalid items </param>
|
|
/// <param name="itemsDb"> The items database to use for item lookup </param>
|
|
/// <returns> True if the build should be removed from the build list, false otherwise </returns>
|
|
protected bool ShouldRemoveWeaponEquipmentBuild(string buildType, UserBuild build, Dictionary<MongoId, TemplateItem> itemsDb)
|
|
{
|
|
if (buildType == "weapon")
|
|
// Get items not found in items db
|
|
{
|
|
foreach (var item in (build as WeaponBuild).Items.Where(item => !itemsDb.ContainsKey(item.Template)))
|
|
{
|
|
logger.Error(serverLocalisationService.GetText("fixer-mod_item_found", item.Template.ToString()));
|
|
|
|
if (_coreConfig.Fixes.RemoveModItemsFromProfile)
|
|
{
|
|
logger.Warning($"Item: {item.Template} has resulted in the deletion of {buildType} build: {build.Name}");
|
|
|
|
return true;
|
|
}
|
|
|
|
break;
|
|
}
|
|
}
|
|
|
|
// TODO: refactor to be generic
|
|
|
|
if (buildType == "equipment")
|
|
// Get items not found in items db
|
|
{
|
|
foreach (var item in (build as EquipmentBuild).Items.Where(item => !itemsDb.ContainsKey(item.Template)))
|
|
{
|
|
logger.Error(serverLocalisationService.GetText("fixer-mod_item_found", item.Template.ToString()));
|
|
|
|
if (_coreConfig.Fixes.RemoveModItemsFromProfile)
|
|
{
|
|
logger.Warning($"Item: {item.Template} has resulted in the deletion of {buildType} build: {build.Name}");
|
|
|
|
return true;
|
|
}
|
|
|
|
// Found a broken item
|
|
break;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Checks whether magazine build shou8ld be removed form the build list.
|
|
/// </summary>
|
|
/// <param name="magazineBuild"> The magazine build to check for validity </param>
|
|
/// <param name="itemsDb"> The items database to use for item lookup </param>
|
|
/// <returns> True if the build should be removed from the build list, false otherwise </returns>
|
|
protected bool ShouldRemoveMagazineBuild(MagazineBuild magazineBuild, Dictionary<MongoId, TemplateItem> itemsDb)
|
|
{
|
|
foreach (var item in magazineBuild.Items)
|
|
{
|
|
// Magazine builds can have undefined items in them, skip those
|
|
if (item is null)
|
|
{
|
|
continue;
|
|
}
|
|
|
|
// Check item exists in itemsDb
|
|
if (!itemsDb.ContainsKey(item.TemplateId))
|
|
{
|
|
logger.Error(serverLocalisationService.GetText("fixer-mod_item_found", item.TemplateId.ToString()));
|
|
|
|
if (_coreConfig.Fixes.RemoveModItemsFromProfile)
|
|
{
|
|
logger.Warning($"Item: {item.TemplateId} has resulted in the deletion of magazine build: {magazineBuild.Name}");
|
|
|
|
return true;
|
|
}
|
|
|
|
break;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
protected bool DoesTraderExist(MongoId traderId)
|
|
{
|
|
return traderStore.GetTraderById(traderId) != null;
|
|
}
|
|
}
|