ace/Source/ACE.Server/WorldObjects/Managers/ConfirmationManager.cs

using System.Collections.Concurrent;

using ACE.Entity.Enum;
using ACE.Server.Entity;
using ACE.Server.Entity.Actions;
using ACE.Server.Network.GameEvent.Events;
using ACE.Server.Network.Sequence;
using log4net;

namespace ACE.Server.WorldObjects.Managers
{
    public class ConfirmationManager
    {
        private Player Player;

        private ConcurrentDictionary<ConfirmationType, Confirmation> confirmations = new ConcurrentDictionary<ConfirmationType, Confirmation>();

        private static readonly ILog log = LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);

        private const double confirmationTimeout = 30;

        private UIntSequence contextSequence = new UIntSequence();

        public ConfirmationManager(Player player)
        {
            Player = player;
        }

        /// <summary>
        /// Builds a new confirmation request on the server,
        /// and sends the request to the client
        /// </summary>
        public bool EnqueueSend(Confirmation confirmation, string text)
        {
            confirmation.ContextId = contextSequence.NextValue;
            if (confirmations.TryAdd(confirmation.ConfirmationType, confirmation))
            {
                Player.Session.Network.EnqueueSend(new GameEventConfirmationRequest(Player.Session, confirmation.ConfirmationType, confirmation.ContextId, text));
                var timeoutConfirmation = new ActionChain();
                timeoutConfirmation.AddDelaySeconds(confirmationTimeout);
                timeoutConfirmation.AddAction(Player, () => EnqueueAbort(confirmation.ConfirmationType, confirmation.ContextId));
                timeoutConfirmation.EnqueueChain();
            }
            else
            {
                //log.Error($"{Player.Name}.ConfirmationManager.EnqueueSend({confirmation.ConfirmationType}, {confirmation.ContextId}) - duplicate confirmation type");
                return false;
            }

            return true;
        }

        /// <summary>
        /// This only needs to be sent in the rare event the server needs to force close
        /// a confirmation dialog that is still active on the client
        /// </summary>
        public void EnqueueAbort(ConfirmationType confirmationType, uint contextId)
        {
            if (confirmations.TryGetValue(confirmationType, out var confirm) && confirm.ContextId == contextId)
            {
                Player.Session.Network.EnqueueSend(new GameEventConfirmationDone(Player.Session, confirmationType, contextId));

                switch (confirm.ConfirmationType)
                {
                    case ConfirmationType.SwearAllegiance:
                        // This event automatically triggers a response from client, however due to the way ACE works, we want it to process as a timeout to match pcap output as best we can and inform players of results.
                        HandleResponse(confirm.ConfirmationType, confirm.ContextId, false, true);
                        break;
                    case ConfirmationType.AlterSkill:
                    case ConfirmationType.AlterAttribute:
                    case ConfirmationType.CraftInteraction:
                    case ConfirmationType.Augmentation:
                    case ConfirmationType.Yes_No:
                        Player.SendMessage("You waited too long to answer the question!");
                        // These events automatically trigger a response from client, others do not.
                        // do nothing further
                        break;

                    default:
                        HandleResponse(confirm.ConfirmationType, confirm.ContextId, false, true);
                        break;
                }
            }
        }

        /// <summary>
        /// The client has responded to a confirmation box
        /// </summary>
        public bool HandleResponse(ConfirmationType confirmType, uint contextId, bool response, bool timeout = false)
        {
            if (!confirmations.TryRemove(confirmType, out var confirm))
            {
                switch (confirmType)
                {
                    case ConfirmationType.SwearAllegiance:
                        // do nothing.
                        break;
                    case ConfirmationType.Fellowship:
                        // dialog box does not dismiss on ConfirmationDone, unlike on all other types, so we must let the player know when they click either yes or no, nothing occured because the offer has already expired.
                        Player.SendMessage("That offer of fellowship has expired."); // still looking for pcap accurate response
                        break;

                    default:
                        log.Error($"{Player.Name}.ConfirmationManager.HandleResponse({confirmType}, {contextId}, {response}, {timeout}) - confirmType not found");
                        break;
                }

                return false;
            }

            if (confirm.ContextId != contextId)
            {
                if (confirm.ConfirmationType == ConfirmationType.Fellowship)
                {
                    // dialog box does not dismiss on ConfirmationDone, unlike on all other types, so we must let the player know when they click either yes or no, nothing occured because the offer has already expired.
                    if (!confirmations.TryAdd(confirm.ConfirmationType, confirm))
                        log.Error($"{Player.Name}.ConfirmationManager.HandleResponse({confirm.ConfirmationType}, {confirm.ContextId}) - Unable to re-add confirmation, duplicate confirmation type");

                    Player.SendMessage("That offer of fellowship has expired."); // still looking for pcap accurate response

                    return false;
                }    

                log.Error($"{Player.Name}.ConfirmationManager.HandleResponse({confirmType}, {contextId}, {response}, {timeout}) - contextId != confirm.ContextId");

                if (!confirmations.TryAdd(confirm.ConfirmationType, confirm))
                    log.Error($"{Player.Name}.ConfirmationManager.HandleResponse({confirm.ConfirmationType}, {confirm.ContextId}) - Unable to re-add confirmation, duplicate confirmation type");

                return false;
            }

            confirm.ProcessConfirmation(response, timeout);

            return true;
        }
    }
}