CypherCore/Source/Game/Phasing/PhaseShift.cs

// Copyright (c) CypherCore <http://github.com/CypherCore> All rights reserved.
// Licensed under the GNU GENERAL PUBLIC LICENSE. See LICENSE file in the project root for full license information.

using System;
using System.Collections.Generic;
using Game.Conditions;
using Game.Entities;
using System.Linq;

namespace Game
{
    public class PhaseShift
    {
        public PhaseShift()
        {
            Flags = PhaseShiftFlags.Unphased;
        }
        public PhaseShift(PhaseShift copy)
        {
            Flags = copy.Flags;
            PersonalGuid = copy.PersonalGuid;
            Phases = new Dictionary<uint, PhaseRef>(copy.Phases);
            VisibleMapIds = new Dictionary<uint, VisibleMapIdRef>(copy.VisibleMapIds);
            UiMapPhaseIds = new Dictionary<uint, UiMapPhaseIdRef>(copy.UiMapPhaseIds);

            NonCosmeticReferences = copy.NonCosmeticReferences;
            CosmeticReferences = copy.CosmeticReferences;
            DefaultReferences = copy.DefaultReferences;
            IsDbPhaseShift = copy.IsDbPhaseShift;
        }

        public bool AddPhase(uint phaseId, PhaseFlags flags, List<Condition> areaConditions, int references = 1)
        {
            bool newPhase = false;

            if (!Phases.ContainsKey(phaseId))
            {
                newPhase = true;
                Phases.Add(phaseId, new PhaseRef(flags, null));
            }

            var phase = Phases.LookupByKey(phaseId);
            ModifyPhasesReferences(phaseId, phase, references);
            if (areaConditions != null)
                phase.AreaConditions = areaConditions;

            return newPhase;
        }

        public bool RemovePhase(uint phaseId)
        {
            var phaseRef = Phases.LookupByKey(phaseId);
            if (phaseRef != null)
            {
                ModifyPhasesReferences(phaseId, phaseRef, -1);
                if (phaseRef.References == 0)
                {
                    Phases.Remove(phaseId);
                    return true;
                }
            }

            return false;
        }

        public bool AddVisibleMapId(uint visibleMapId, TerrainSwapInfo visibleMapInfo, int references = 1)
        {
            if (VisibleMapIds.ContainsKey(visibleMapId))
                return false;

            VisibleMapIds.Add(visibleMapId, new VisibleMapIdRef(references, visibleMapInfo));
            return true;
        }

        public bool RemoveVisibleMapId(uint visibleMapId)
        {
            if (VisibleMapIds.ContainsKey(visibleMapId))
            {
                var mapIdRef = VisibleMapIds[visibleMapId];
                if ((--mapIdRef.References) == 0)
                {
                    VisibleMapIds.Remove(visibleMapId);
                    return true;
                }
            }

            return false;
        }

        public bool AddUiMapPhaseId(uint uiMapPhaseId, int references = 1)
        {
            if (UiMapPhaseIds.ContainsKey(uiMapPhaseId))
                return false;

            UiMapPhaseIds.Add(uiMapPhaseId, new UiMapPhaseIdRef(references));
            return true;
        }

        public bool RemoveUiMapPhaseId(uint uiWorldMapAreaId)
        {
            if (UiMapPhaseIds.ContainsKey(uiWorldMapAreaId))
            {
                var value = UiMapPhaseIds[uiWorldMapAreaId];
                if ((--value.References) == 0)
                {
                    UiMapPhaseIds.Remove(uiWorldMapAreaId);
                    return true;
                }
            }

            return false;
        }

        public void Clear()
        {
            ClearPhases();
            VisibleMapIds.Clear();
            UiMapPhaseIds.Clear();
        }

        public void ClearPhases()
        {
            Flags &= PhaseShiftFlags.AlwaysVisible | PhaseShiftFlags.Inverse;
            PersonalGuid.Clear();
            Phases.Clear();
            NonCosmeticReferences = 0;
            CosmeticReferences = 0;
            PersonalReferences = 0;
            DefaultReferences = 0;
            UpdateUnphasedFlag();
        }

        public bool CanSee(PhaseShift other)
        {
            if (Flags.HasFlag(PhaseShiftFlags.Unphased) && other.Flags.HasFlag(PhaseShiftFlags.Unphased))
                return true;
            if (Flags.HasFlag(PhaseShiftFlags.AlwaysVisible) || other.Flags.HasFlag(PhaseShiftFlags.AlwaysVisible))
                return true;
            if (Flags.HasFlag(PhaseShiftFlags.Inverse) && other.Flags.HasFlag(PhaseShiftFlags.Inverse))
                return true;

            PhaseFlags excludePhasesWithFlag = PhaseFlags.None;
            if (Flags.HasFlag(PhaseShiftFlags.NoCosmetic) && other.Flags.HasFlag(PhaseShiftFlags.NoCosmetic))
                excludePhasesWithFlag = PhaseFlags.Cosmetic;

            if (!Flags.HasFlag(PhaseShiftFlags.Inverse) && !other.Flags.HasFlag(PhaseShiftFlags.Inverse))
            {
                ObjectGuid ownerGuid = PersonalGuid;
                ObjectGuid otherPersonalGuid = other.PersonalGuid;
                return Phases.Intersect(other.Phases, (myPhase, otherPhase) =>
                {
                    if (myPhase.Key != otherPhase.Key)
                        return false;

                    return !myPhase.Value.Flags.HasAnyFlag(excludePhasesWithFlag) && (!myPhase.Value.Flags.HasFlag(PhaseFlags.Personal) || ownerGuid == otherPersonalGuid);
                }).Any();
            }

            var checkInversePhaseShift = new Func<PhaseShift, PhaseShift, bool>((phaseShift, excludedPhaseShift) =>
            {
                if (phaseShift.Flags.HasFlag(PhaseShiftFlags.Unphased) && excludedPhaseShift.Flags.HasFlag(PhaseShiftFlags.InverseUnphased))
                    return false;

                foreach (var pair in phaseShift.Phases)
                {
                    if (pair.Value.Flags.HasAnyFlag(excludePhasesWithFlag))
                        continue;

                    var ExcludedPhaseRef = excludedPhaseShift.Phases.LookupByKey(pair.Key);
                    if (ExcludedPhaseRef != null || !ExcludedPhaseRef.Flags.HasAnyFlag(excludePhasesWithFlag))
                        return false;
                }

                return true;
            });

            if (other.Flags.HasFlag(PhaseShiftFlags.Inverse))
                return checkInversePhaseShift(this, other);

            return checkInversePhaseShift(other, this);
        }

        public void ModifyPhasesReferences(uint phaseId, PhaseRef phaseRef, int references)
        {
            phaseRef.References += references;

            if (!IsDbPhaseShift)
            {
                if (phaseRef.Flags.HasAnyFlag(PhaseFlags.Cosmetic))
                    CosmeticReferences += references;
                else if (phaseId != 169)
                    NonCosmeticReferences += references;
                else
                    DefaultReferences += references;

                if (phaseRef.Flags.HasFlag(PhaseFlags.Personal))
                    PersonalReferences += references;

                if (CosmeticReferences != 0)
                    Flags |= PhaseShiftFlags.NoCosmetic;
                else
                    Flags &= ~PhaseShiftFlags.NoCosmetic;

                UpdateUnphasedFlag();
                UpdatePersonalGuid();
            }
        }

        public void UpdateUnphasedFlag()
        {
            PhaseShiftFlags unphasedFlag = !Flags.HasAnyFlag(PhaseShiftFlags.Inverse) ? PhaseShiftFlags.Unphased : PhaseShiftFlags.InverseUnphased;
            Flags &= ~(!Flags.HasFlag(PhaseShiftFlags.Inverse) ? PhaseShiftFlags.InverseUnphased : PhaseShiftFlags.Unphased);
            if (NonCosmeticReferences != 0 && DefaultReferences == 0)
                Flags &= ~unphasedFlag;
            else
                Flags |= unphasedFlag;
        }

        void UpdatePersonalGuid()
        {
            if (PersonalReferences == 0)
                PersonalGuid.Clear();
        }

        public bool HasPersonalPhase()
        {
            foreach (PhaseRef phaseRef in GetPhases().Values)
                if (phaseRef.IsPersonal())
                    return true;

            return false;
        }
        
        public bool HasPhase(uint phaseId) { return Phases.ContainsKey(phaseId); }
        public Dictionary<uint, PhaseRef> GetPhases() { return Phases; }

        public bool HasVisibleMapId(uint visibleMapId) { return VisibleMapIds.ContainsKey(visibleMapId); }
        public Dictionary<uint, VisibleMapIdRef> GetVisibleMapIds() { return VisibleMapIds; }

        public bool HasUiWorldMapAreaIdSwap(uint uiWorldMapAreaId) { return UiMapPhaseIds.ContainsKey(uiWorldMapAreaId); }
        public Dictionary<uint, UiMapPhaseIdRef> GetUiMapPhaseIds() { return UiMapPhaseIds; }

        public ObjectGuid GetPersonalGuid() { return PersonalGuid; }
        
        public PhaseShiftFlags Flags = PhaseShiftFlags.Unphased;
        public ObjectGuid PersonalGuid;
        public Dictionary<uint, PhaseRef> Phases = new();
        public Dictionary<uint, VisibleMapIdRef> VisibleMapIds = new();
        public Dictionary<uint, UiMapPhaseIdRef> UiMapPhaseIds = new();

        int NonCosmeticReferences;
        int CosmeticReferences;
        public int PersonalReferences;
        int DefaultReferences;
        public bool IsDbPhaseShift;
    }

    public class PhaseRef
    {
        public PhaseRef(PhaseFlags flags, List<Condition> conditions)
        {
            Flags = flags;
            References = 0;
            AreaConditions = conditions;
        }

        public bool IsPersonal() { return Flags.HasFlag(PhaseFlags.Personal); }

        public PhaseFlags Flags;
        public int References;
        public List<Condition> AreaConditions;
    }

    public struct VisibleMapIdRef
    {
        public VisibleMapIdRef(int references, TerrainSwapInfo visibleMapInfo)
        {
            References = references;
            VisibleMapInfo = visibleMapInfo;
        }

        public int References;
        public TerrainSwapInfo VisibleMapInfo;
    }

    public struct UiMapPhaseIdRef
    {
        public UiMapPhaseIdRef(int references)
        {
            References = references;
        }

        public int References;
    }

    [Flags]
    public enum PhaseShiftFlags
    {
        None = 0x00,
        AlwaysVisible = 0x01, // Ignores all phasing, can see everything and be seen by everything
        Inverse = 0x02, // By default having at least one shared phase for two objects means they can see each other
                        // this flag makes objects see each other if they have at least one non-shared phase
        InverseUnphased = 0x04,
        Unphased = 0x08,
        NoCosmetic = 0x10  // This flag ignores shared cosmetic phases (two players that both have shared cosmetic phase but no other phase cannot see each other)
    }

    [Flags]
    public enum PhaseFlags : ushort
    {
        None = 0x0,
        Cosmetic = 0x1,
        Personal = 0x2
    }
}