server/project/src/helpers/ProfileHelper.ts

import { ItemHelper } from "@spt/helpers/ItemHelper";
import { IPmcData } from "@spt/models/eft/common/IPmcData";
import { BanType, Common, ICounterKeyValue, IStats } from "@spt/models/eft/common/tables/IBotBase";
import { ICustomisationStorage } from "@spt/models/eft/common/tables/ICustomisationStorage";
import { IItem } from "@spt/models/eft/common/tables/IItem";
import { IQuestReward } from "@spt/models/eft/common/tables/IQuest";
import { ISearchFriendResponse } from "@spt/models/eft/profile/ISearchFriendResponse";
import { ISpt, ISptProfile } from "@spt/models/eft/profile/ISptProfile";
import { IValidateNicknameRequestData } from "@spt/models/eft/profile/IValidateNicknameRequestData";
import { AccountTypes } from "@spt/models/enums/AccountTypes";
import { BonusType } from "@spt/models/enums/BonusType";
import { ConfigTypes } from "@spt/models/enums/ConfigTypes";
import { GameEditions } from "@spt/models/enums/GameEditions";
import { SkillTypes } from "@spt/models/enums/SkillTypes";
import { IInventoryConfig } from "@spt/models/spt/config/IInventoryConfig";
import type { ILogger } from "@spt/models/spt/utils/ILogger";
import { ConfigServer } from "@spt/servers/ConfigServer";
import { SaveServer } from "@spt/servers/SaveServer";
import { DatabaseService } from "@spt/services/DatabaseService";
import { LocalisationService } from "@spt/services/LocalisationService";
import { HashUtil } from "@spt/utils/HashUtil";
import { TimeUtil } from "@spt/utils/TimeUtil";
import { Watermark } from "@spt/utils/Watermark";
import type { ICloner } from "@spt/utils/cloners/ICloner";
import { inject, injectable } from "tsyringe";

@injectable()
export class ProfileHelper {
    protected inventoryConfig: IInventoryConfig;

    constructor(
        @inject("PrimaryLogger") protected logger: ILogger,
        @inject("HashUtil") protected hashUtil: HashUtil,
        @inject("Watermark") protected watermark: Watermark,
        @inject("TimeUtil") protected timeUtil: TimeUtil,
        @inject("SaveServer") protected saveServer: SaveServer,
        @inject("DatabaseService") protected databaseService: DatabaseService,
        @inject("ItemHelper") protected itemHelper: ItemHelper,
        @inject("LocalisationService") protected localisationService: LocalisationService,
        @inject("ConfigServer") protected configServer: ConfigServer,
        @inject("PrimaryCloner") protected cloner: ICloner,
    ) {
        this.inventoryConfig = this.configServer.getConfig(ConfigTypes.INVENTORY);
    }

    /**
     * Remove/reset a completed quest condtion from players profile quest data
     * @param sessionID Session id
     * @param questConditionId Quest with condition to remove
     */
    public removeQuestConditionFromProfile(pmcData: IPmcData, questConditionId: Record<string, string>): void {
        for (const questId in questConditionId) {
            const conditionId = questConditionId[questId];
            const profileQuest = pmcData.Quests.find((x) => x.qid === questId);

            // Find index of condition in array
            const index = profileQuest.completedConditions.indexOf(conditionId);
            if (index > -1) {
                // Remove condition
                profileQuest.completedConditions.splice(index, 1);
            }
        }
    }

    /**
     * Get all profiles from server
     * @returns Dictionary of profiles
     */
    public getProfiles(): Record<string, ISptProfile> {
        return this.saveServer.getProfiles();
    }

    /**
     * Get the pmc and scav profiles as an array by profile id
     * @param sessionId
     * @returns Array of IPmcData objects
     */
    public getCompleteProfile(sessionId: string): IPmcData[] {
        const output: IPmcData[] = [];

        if (this.isWiped(sessionId)) {
            return output;
        }

        const fullProfileClone = this.cloner.clone(this.getFullProfile(sessionId));

        // Sanitize any data the client can not receive
        this.sanitizeProfileForClient(fullProfileClone);

        // PMC must be at array index 0, scav at 1
        output.push(fullProfileClone.characters.pmc);
        output.push(fullProfileClone.characters.scav);

        return output;
    }

    /**
     * Sanitize any information from the profile that the client does not expect to receive
     * @param clonedProfile A clone of the full player profile
     */
    protected sanitizeProfileForClient(clonedProfile: ISptProfile) {
        // Remove `loyaltyLevel` from `TradersInfo`, as otherwise it causes the client to not
        // properly calculate the player's `loyaltyLevel`
        for (const traderInfo of Object.values(clonedProfile.characters.pmc.TradersInfo)) {
            traderInfo.loyaltyLevel = undefined;
        }
    }

    /**
     * Check if a nickname is used by another profile loaded by the server
     * @param nicknameRequest nickname request object
     * @param sessionID Session id
     * @returns True if already in use
     */
    public isNicknameTaken(nicknameRequest: IValidateNicknameRequestData, sessionID: string): boolean {
        const allProfiles = Object.values(this.saveServer.getProfiles());

        // Find a profile that doesn't have same session id but has same name
        return allProfiles.some(
            (profile) =>
                this.profileHasInfoProperty(profile) &&
                !this.stringsMatch(profile.info.id, sessionID) && // SessionIds dont match
                this.stringsMatch(
                    // Nicknames do
                    profile.characters.pmc.Info.LowerNickname.toLowerCase(),
                    nicknameRequest.nickname.toLowerCase(),
                ),
        );
    }

    protected profileHasInfoProperty(profile: ISptProfile): boolean {
        return !!profile?.characters?.pmc?.Info;
    }

    protected stringsMatch(stringA: string, stringB: string): boolean {
        return stringA === stringB;
    }

    /**
     * Add experience to a PMC inside the players profile
     * @param sessionID Session id
     * @param experienceToAdd Experience to add to PMC character
     */
    public addExperienceToPmc(sessionID: string, experienceToAdd: number): void {
        const pmcData = this.getPmcProfile(sessionID);
        pmcData.Info.Experience += experienceToAdd;
    }

    /**
     * Iterate all profiles and find matching pmc profile by provided id
     * @param pmcId Profile id to find
     * @returns IPmcData
     */
    public getProfileByPmcId(pmcId: string): IPmcData | undefined {
        return Object.values(this.saveServer.getProfiles()).find((profile) => profile.characters.pmc?._id === pmcId)
            ?.characters.pmc;
    }

    /**
     * Get experience value for given level
     * @param level Level to get xp for
     * @returns Number of xp points for level
     */
    public getExperience(level: number): number {
        let playerLevel = level;
        const expTable = this.databaseService.getGlobals().config.exp.level.exp_table;
        let exp = 0;

        if (playerLevel >= expTable.length) {
            // make sure to not go out of bounds
            playerLevel = expTable.length - 1;
        }

        for (let i = 0; i < playerLevel; i++) {
            exp += expTable[i].exp;
        }

        return exp;
    }

    /**
     * Get the max level a player can be
     * @returns Max level
     */
    public getMaxLevel(): number {
        return this.databaseService.getGlobals().config.exp.level.exp_table.length - 1;
    }

    public getDefaultSptDataObject(): ISpt {
        return {
            version: this.watermark.getVersionTag(true),
            freeRepeatableRefreshUsedCount: {},
            migrations: {},
            cultistRewards: new Map(),
            mods: [],
            receivedGifts: [],
        };
    }

    /**
     * Get full representation of a players profile json
     * @param sessionID Profile id to get
     * @returns ISptProfile object
     */
    public getFullProfile(sessionID: string): ISptProfile | undefined {
        return this.saveServer.profileExists(sessionID) ? this.saveServer.getProfile(sessionID) : undefined;
    }

    /**
     * Get full representation of a players profile JSON by the account ID, or undefined if not found
     * @param accountId Account ID to find
     * @returns
     */
    public getFullProfileByAccountId(accountID: string): ISptProfile | undefined {
        const aid = Number.parseInt(accountID);
        return Object.values(this.saveServer.getProfiles()).find((profile) => profile?.info?.aid === aid);
    }

    /**
     * Retrieve a ChatRoomMember formatted profile for the given session ID
     * @param sessionID The session ID to return the profile for
     * @returns
     */
    public getChatRoomMemberFromSessionId(sessionID: string): ISearchFriendResponse | undefined {
        const pmcProfile = this.getFullProfile(sessionID)?.characters?.pmc;
        if (!pmcProfile) {
            return undefined;
        }

        return this.getChatRoomMemberFromPmcProfile(pmcProfile);
    }

    /**
     * Retrieve a ChatRoomMember formatted profile for the given PMC profile data
     * @param pmcProfile The PMC profile data to format into a ChatRoomMember structure
     * @returns
     */
    public getChatRoomMemberFromPmcProfile(pmcProfile: IPmcData): ISearchFriendResponse {
        return {
            _id: pmcProfile._id,
            aid: pmcProfile.aid,
            Info: {
                Nickname: pmcProfile.Info.Nickname,
                Side: pmcProfile.Info.Side,
                Level: pmcProfile.Info.Level,
                MemberCategory: pmcProfile.Info.MemberCategory,
                SelectedMemberCategory: pmcProfile.Info.SelectedMemberCategory,
            },
        };
    }

    /**
     * Get a PMC profile by its session id
     * @param sessionID Profile id to return
     * @returns IPmcData object
     */
    public getPmcProfile(sessionID: string): IPmcData | undefined {
        const fullProfile = this.getFullProfile(sessionID);
        if (!fullProfile?.characters?.pmc) {
            return undefined;
        }

        return this.saveServer.getProfile(sessionID).characters.pmc;
    }

    /**
     * Is given user id a player
     * @param userId Id to validate
     * @returns True is a player
     */
    public isPlayer(userId: string): boolean {
        return this.saveServer.profileExists(userId);
    }

    /**
     * Get a full profiles scav-specific sub-profile
     * @param sessionID Profiles id
     * @returns IPmcData object
     */
    public getScavProfile(sessionID: string): IPmcData {
        return this.saveServer.getProfile(sessionID).characters.scav;
    }

    /**
     * Get baseline counter values for a fresh profile
     * @returns Default profile Stats object
     */
    public getDefaultCounters(): IStats {
        return {
            Eft: {
                CarriedQuestItems: [],
                DamageHistory: { LethalDamagePart: "Head", LethalDamage: undefined, BodyParts: <any>[] },
                DroppedItems: [],
                ExperienceBonusMult: 0,
                FoundInRaidItems: [],
                LastPlayerState: undefined,
                LastSessionDate: 0,
                OverallCounters: { Items: [] },
                SessionCounters: { Items: [] },
                SessionExperienceMult: 0,
                SurvivorClass: "Unknown",
                TotalInGameTime: 0,
                TotalSessionExperience: 0,
                Victims: [],
            },
        };
    }

    /**
     * is this profile flagged for data removal
     * @param sessionID Profile id
     * @returns True if profile is to be wiped of data/progress
     */
    protected isWiped(sessionID: string): boolean {
        return this.saveServer.getProfile(sessionID).info.wipe;
    }

    /**
     * Iterate over player profile inventory items and find the secure container and remove it
     * @param profile Profile to remove secure container from
     * @returns profile without secure container
     */
    public removeSecureContainer(profile: IPmcData): IPmcData {
        const items = profile.Inventory.items;
        const secureContainer = items.find((x) => x.slotId === "SecuredContainer");
        if (secureContainer) {
            // Find and remove container + children
            const childItemsInSecureContainer = this.itemHelper.findAndReturnChildrenByItems(
                items,
                secureContainer._id,
            );

            // Remove child items + secure container
            profile.Inventory.items = items.filter((x) => !childItemsInSecureContainer.includes(x._id));
        }

        return profile;
    }

    /**
     *  Flag a profile as having received a gift
     * Store giftid in profile spt object
     * @param playerId Player to add gift flag to
     * @param giftId Gift player received
     * @param maxCount Limit of how many of this gift a player can have
     */
    public flagGiftReceivedInProfile(playerId: string, giftId: string, maxCount: number): void {
        const profileToUpdate = this.getFullProfile(playerId);

        // nullguard receivedGifts
        profileToUpdate.spt.receivedGifts ||= [];

        const giftData = profileToUpdate.spt.receivedGifts.find((gift) => gift.giftId === giftId);
        if (giftData) {
            // Increment counter
            giftData.current++;

            return;
        }

        // Player has never received gift, make a new object
        profileToUpdate.spt.receivedGifts.push({
            giftId: giftId,
            timestampLastAccepted: this.timeUtil.getTimestamp(),
            current: 1,
        });
    }

    /**
     * Check if profile has recieved a gift by id
     * @param playerId Player profile to check for gift
     * @param giftId Gift to check for
     * @param maxGiftCount Max times gift can be given to player
     * @returns True if player has recieved gift previously
     */
    public playerHasRecievedMaxNumberOfGift(playerId: string, giftId: string, maxGiftCount: number): boolean {
        const profile = this.getFullProfile(playerId);
        if (!profile) {
            this.logger.debug(`Unable to gift ${giftId}, profile: ${playerId} does not exist`);
            return false;
        }

        if (!profile.spt?.receivedGifts) {
            return false;
        }

        const giftDataFromProfile = profile.spt?.receivedGifts?.find((gift) => gift.giftId === giftId);
        if (!giftDataFromProfile) {
            return false;
        }

        return giftDataFromProfile.current >= maxGiftCount;
    }

    /**
     * Find Stat in profile counters and increment by one
     * @param counters Counters to search for key
     * @param keyToIncrement Key
     */
    public incrementStatCounter(counters: ICounterKeyValue[], keyToIncrement: string): void {
        const stat = counters.find((x) => x.Key.includes(keyToIncrement));
        if (stat) {
            stat.Value++;
        }
    }

    /**
     * Check if player has a skill at elite level
     * @param skillType Skill to check
     * @param pmcProfile Profile to find skill in
     * @returns True if player has skill at elite level
     */
    public hasEliteSkillLevel(skillType: SkillTypes, pmcProfile: IPmcData): boolean {
        const profileSkills = pmcProfile?.Skills?.Common;
        if (!profileSkills) {
            return false;
        }

        const profileSkill = profileSkills.find((x) => x.Id === skillType);
        if (!profileSkill) {
            this.logger.warning(`Unable to check for elite skill ${skillType}, not found in profile`);

            return false;
        }
        return profileSkill.Progress >= 5100; // level 51
    }

    /**
     * Add points to a specific skill in player profile
     * @param skill Skill to add points to
     * @param pointsToAdd Points to add
     * @param pmcProfile Player profile with skill
     * @param useSkillProgressRateMultipler Skills are multiplied by a value in globals, default is off to maintain compatibility with legacy code
     * @returns
     */
    public addSkillPointsToPlayer(
        pmcProfile: IPmcData,
        skill: SkillTypes,
        pointsToAdd: number,
        useSkillProgressRateMultipler = false,
    ): void {
        let pointsToAddToSkill = pointsToAdd;

        if (!pointsToAddToSkill || pointsToAddToSkill < 0) {
            this.logger.warning(
                this.localisationService.getText("player-attempt_to_increment_skill_with_negative_value", skill),
            );
            return;
        }

        const profileSkills = pmcProfile?.Skills?.Common;
        if (!profileSkills) {
            this.logger.warning(`Unable to add ${pointsToAddToSkill} points to ${skill}, profile has no skills`);
            return;
        }

        const profileSkill = profileSkills.find((profileSkill) => profileSkill.Id === skill);
        if (!profileSkill) {
            this.logger.error(this.localisationService.getText("quest-no_skill_found", skill));
            return;
        }

        if (useSkillProgressRateMultipler) {
            const skillProgressRate = this.databaseService.getGlobals().config.SkillsSettings.SkillProgressRate;
            pointsToAddToSkill *= skillProgressRate;
        }

        // Apply custom multipler to skill amount gained, if exists
        if (this.inventoryConfig.skillGainMultiplers[skill]) {
            pointsToAddToSkill *= this.inventoryConfig.skillGainMultiplers[skill];
        }

        profileSkill.Progress += pointsToAddToSkill;
        profileSkill.Progress = Math.min(profileSkill.Progress, 5100); // Prevent skill from ever going above level 51 (5100)
        profileSkill.LastAccess = this.timeUtil.getTimestamp();
    }

    /**
     * Get a speciic common skill from supplied profile
     * @param pmcData Player profile
     * @param skill Skill to look up and return value from
     * @returns Common skill object from desired profile
     */
    public getSkillFromProfile(pmcData: IPmcData, skill: SkillTypes): Common {
        const skillToReturn = pmcData.Skills.Common.find((commonSkill) => commonSkill.Id === skill);
        if (!skillToReturn) {
            this.logger.warning(`Profile ${pmcData.sessionId} does not have a skill named: ${skill}`);
            return undefined;
        }

        return skillToReturn;
    }

    /**
     * Is the provided session id for a developer account
     * @param sessionID Profile id ot check
     * @returns True if account is developer
     */
    public isDeveloperAccount(sessionID: string): boolean {
        return this.getFullProfile(sessionID).info.edition.toLowerCase().startsWith(AccountTypes.SPT_DEVELOPER);
    }

    /**
     * Add stash row bonus to profile or increments rows given count if it already exists
     * @param sessionId Profile id to give rows to
     * @param rowsToAdd How many rows to give profile
     */
    public addStashRowsBonusToProfile(sessionId: string, rowsToAdd: number): void {
        const profile = this.getPmcProfile(sessionId);
        const existingBonus = profile.Bonuses.find((bonus) => bonus.type === BonusType.STASH_ROWS);
        if (!existingBonus) {
            profile.Bonuses.push({
                id: this.hashUtil.generate(),
                value: rowsToAdd,
                type: BonusType.STASH_ROWS,
                passive: true,
                visible: true,
                production: false,
            });
        } else {
            existingBonus.value += rowsToAdd;
        }
    }

    /**
     * Iterate over all bonuses and sum up all bonuses of desired type in provided profile
     * @param pmcProfile Player profile
     * @param desiredBonus Bonus to sum up
     * @returns Summed bonus value or 0 if no bonus found
     */
    public getBonusValueFromProfile(pmcProfile: IPmcData, desiredBonus: BonusType): number {
        const bonuses = pmcProfile.Bonuses.filter((bonus) => bonus.type === desiredBonus);
        if (bonuses.length === 0) {
            return 0;
        }

        // Sum all bonuses found above
        return bonuses.reduce((sum, curr) => sum + (curr.value ?? 0), 0);
    }

    public playerIsFleaBanned(pmcProfile: IPmcData): boolean {
        const currentTimestamp = this.timeUtil.getTimestamp();
        return pmcProfile.Info.Bans.some((ban) => ban.banType === BanType.RAGFAIR && currentTimestamp < ban.dateTime);
    }

    /**
     * Add an achievement to player profile + check for and add any hideout customisation unlocks to profile
     * @param fullProfile Profile to add achievement to
     * @param achievementId Id of achievement to add
     */
    public addAchievementToProfile(fullProfile: ISptProfile, achievementId: string): void {
        // Add achievement id to profile with timestamp it was unlocked
        fullProfile.characters.pmc.Achievements[achievementId] = this.timeUtil.getTimestamp();

        // Check for any customisation unlocks
        const achievementDataDb = this.databaseService
            .getTemplates()
            .achievements.find((achievement) => achievement.id === achievementId);
        if (!achievementDataDb) {
            return;
        }

        // Get customisation reward object from achievement db
        const customizationDirectReward = achievementDataDb.rewards.find(
            (reward) => reward.type === "CustomizationDirect",
        );
        if (!customizationDirectReward) {
            return;
        }

        const customisationDataDb = this.databaseService
            .getHideout()
            .customisation.globals.find((customisation) => customisation.itemId === customizationDirectReward.target);
        if (!customisationDataDb) {
            this.logger.error(
                `Unable to find customisation data for ${customizationDirectReward.target} in profile ${fullProfile.info.id}`,
            );

            return;
        }

        // Reward found, add to profile
        fullProfile.customisationUnlocks.push({
            id: customizationDirectReward.target,
            source: "achievement",
            type: customisationDataDb.type,
        });
    }

    public hasAccessToRepeatableFreeRefreshSystem(pmcProfile: IPmcData): boolean {
        return [GameEditions.EDGE_OF_DARKNESS, GameEditions.UNHEARD].includes(<any>pmcProfile.Info?.GameVersion);
    }

    /**
     * Find a profiles "Pockets" item and replace its tpl with passed in value
     * @param pmcProfile Player profile
     * @param newPocketTpl New tpl to set profiles Pockets to
     */
    public replaceProfilePocketTpl(pmcProfile: IPmcData, newPocketTpl: string): void {
        // Find all pockets in profile, may be multiple as they could have equipment stand
        // (1 pocket for each upgrade level of equipment stand)
        const pockets = pmcProfile.Inventory.items.filter((item) => item.slotId === "Pockets");
        if (pockets.length === 0) {
            this.logger.error(
                `Unable to replace profile: ${pmcProfile._id} pocket tpl with: ${newPocketTpl} as Pocket item could not be found.`,
            );

            return;
        }

        for (const pocket of pockets) {
            pocket._tpl = newPocketTpl;
        }
    }

    /**
     * Return all quest items current in the supplied profile
     * @param profile Profile to get quest items from
     * @returns Array of item objects
     */
    public getQuestItemsInProfile(profile: IPmcData): IItem[] {
        return profile.Inventory.items.filter((item) => item.parentId === profile.Inventory.questRaidItems);
    }

    /**
     * Return a favorites array in the format expected by the getOtherProfile call
     * @param profile
     * @returns An array of IItem objects representing the favorited data
     */
    public getOtherProfileFavorites(profile: IPmcData): IItem[] {
        let fullFavorites = [];

        for (const itemId of profile.Inventory.favoriteItems ?? []) {
            // When viewing another users profile, the client expects a full item with children, so get that
            const itemAndChildren = this.itemHelper.findAndReturnChildrenAsItems(profile.Inventory.items, itemId);
            if (itemAndChildren && itemAndChildren.length > 0) {
                // To get the client to actually see the items, we set the main item's parent to null, so it's treated as a root item
                const clonedItems = this.cloner.clone(itemAndChildren);
                clonedItems[0].parentId = null;

                fullFavorites = fullFavorites.concat(clonedItems);
            }
        }

        return fullFavorites;
    }

    /**
     * Store a hideout customisation unlock inside a profile
     * @param fullProfile Profile to add unlock to
     * @param reward reward given to player with customisation data
     * @param source Source of reward, e.g. "unlockedInGame" for quests and "achievement" for achievements
     */
    public addHideoutCustomisationUnlock(fullProfile: ISptProfile, reward: IQuestReward, source: string): void {
        // Get matching db data for reward
        const hideoutCustomisationDb = this.databaseService
            .getHideout()
            .customisation.globals.find((customisation) => customisation.itemId === reward.target);
        if (!hideoutCustomisationDb) {
            this.logger.warning(
                `Unable to add hideout customisaiton reward: ${reward.target} to profile: ${fullProfile.info.id} as matching object cannot be found in hideout/customisation.json`,
            );

            return;
        }

        fullProfile.customisationUnlocks ||= [];
        if (fullProfile.customisationUnlocks?.some((unlock) => unlock.id === hideoutCustomisationDb.id)) {
            this.logger.warning(
                `Profile: ${fullProfile.info.id} already has hideout customisaiton reward: ${reward.target}, skipping`,
            );
            return;
        }

        const rewardToStore: ICustomisationStorage = {
            id: hideoutCustomisationDb.id,
            source: source,
            type: hideoutCustomisationDb.type,
        };

        fullProfile.customisationUnlocks.push(rewardToStore);
    }
}