// AntennaRange
//
// ModuleLimitedDataTransmitter.cs
//
// Copyright © 2014, toadicus
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation and/or other
//    materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be used
//    to endorse or promote products derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
using KSP;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using ToadicusTools;
using UnityEngine;
 
namespace AntennaRange
{
        /*
         * ModuleLimitedDataTransmitter is designed as a drop-in replacement for ModuleDataTransmitter, and handles range-
         * finding, power scaling, and data scaling for antennas during science transmission.  Its functionality varies with
         * three tunables: nominalRange, maxPowerFactor, and maxDataFactor, set in .cfg files.
         * 
         * In general, the scaling functions assume the following relation:
         * 
         *     D² α P/R,
         * 
         * where D is the total transmission distance, P is the transmission power, and R is the data rate.
         * 
         * */
 
        /*
         * Fields
         * */
        public class ModuleLimitedDataTransmitter : ModuleDataTransmitter, IScienceDataTransmitter, IAntennaRelay
        {
                // If true, use a fixed power cost at the configured value and degrade data rates instead of increasing power
                // requirements.
                public static bool fixedPowerCost;
 
                // Stores the packetResourceCost as defined in the .cfg file.
                protected float _basepacketResourceCost;
 
                // Stores the packetSize as defined in the .cfg file.
                protected float _basepacketSize;
 
                // Every antenna is a relay.
                protected AntennaRelay relay;
 
                // Keep track of vessels with transmitters for relay purposes.
                protected List<Vessel> _relayVessels;
 
                // Sometimes we will need to communicate errors; this is how we do it.
                protected ScreenMessage ErrorMsg;
 
                // The distance from Kerbin at which the antenna will perform exactly as prescribed by packetResourceCost
                // and packetSize.
                [KSPField(isPersistant = false)]
                public float nominalRange;
 
                [KSPField(isPersistant = false, guiActive = true, guiName = "Relay")]
                public string UIrelayStatus;
 
                [KSPField(isPersistant = false, guiActive = true, guiName = "Transmission Distance")]
                public string UItransmitDistance;
 
                [KSPField(isPersistant = false, guiActive = true, guiName = "Maximum Distance")]
                public string UImaxTransmitDistance;
 
                [KSPField(isPersistant = false, guiActive = true, guiName = "Packet Size")]
                public string UIpacketSize;
 
                [KSPField(isPersistant = false, guiActive = true, guiName = "Packet Cost")]
                public string UIpacketCost;
 
                // The multiplier on packetResourceCost that defines the maximum power output of the antenna.  When the power
                // cost exceeds packetResourceCost * maxPowerFactor, transmission will fail.
                [KSPField(isPersistant = false)]
                public float maxPowerFactor;
 
                // The multipler on packetSize that defines the maximum data bandwidth of the antenna.
                [KSPField(isPersistant = false)]
                public float maxDataFactor;
 
                [KSPField(
                        isPersistant = true,
                        guiName = "Packet Throttle",
                        guiUnits = "%",
                        guiActive = true,
                        guiActiveEditor = false
                )]
                [UI_FloatRange(maxValue = 100f, minValue = 2.5f, stepIncrement = 2.5f)]
                public float packetThrottle;
 
                protected bool actionUIUpdate;
 
                /*
                 * Properties
                 * */
                // Returns the parent vessel housing this antenna.
                public new Vessel vessel
                {
                        get
                        {
                                return base.vessel;
                        }
                }
 
                // Returns the distance to the nearest relay or Kerbin, whichever is closer.
                public double transmitDistance
                {
                        get
                        {
                                return this.relay.transmitDistance;
                        }
                }
 
                // Returns the maximum distance this module can transmit
                public float maxTransmitDistance
                {
                        get
                        {
                                return Mathf.Sqrt (this.maxPowerFactor) * this.nominalRange;
                        }
                }
 
                /*
                 * The next two functions overwrite the behavior of the stock functions and do not perform equivalently, except
                 * in that they both return floats.  Here's some quick justification:
                 * 
                 * The stock implementation of GetTransmitterScore (which I cannot override) is:
                 *              Score = (1 + DataResourceCost) / DataRate
                 * 
                 * The stock DataRate and DataResourceCost are:
                 *              DataRate = packetSize / packetInterval
                 *              DataResourceCost = packetResourceCost / packetSize
                 * 
                 * So, the resulting score is essentially in terms of joules per byte per baud.  Rearranging that a bit, it
                 * could also look like joule-seconds per byte per byte, or newton-meter-seconds per byte per byte.  Either way,
                 * that metric is not a very reasonable one.
                 * 
                 * Two metrics that might make more sense are joules per byte or joules per byte per second.  The latter case
                 * would look like:
                 *              DataRate = packetSize / packetInterval
                 *              DataResourceCost = packetResourceCost
                 * 
                 * The former case, which I've chosen to implement below, is:
                 *              DataRate = packetSize
                 *              DataResourceCost = packetResourceCost
                 * 
                 * So... hopefully that doesn't screw with anything else.
                 * */
                // Override ModuleDataTransmitter.DataRate to just return packetSize, because we want antennas to be scored in
                // terms of joules/byte
                public new float DataRate
                {
                        get
                        {
                                this.PreTransmit_SetPacketSize();
 
                                if (this.CanTransmit())
                                {
                                        return this.packetSize;
                                }
                                else
                                {
                                        return float.Epsilon;
                                }
                        }
                }
 
                // Override ModuleDataTransmitter.DataResourceCost to just return packetResourceCost, because we want antennas
                // to be scored in terms of joules/byte
                public new float DataResourceCost
                {
                        get
                        {
                                this.PreTransmit_SetPacketResourceCost();
 
                                if (this.CanTransmit())
                                {
                                        return this.packetResourceCost;
                                }
                                else
                                {
                                        return float.PositiveInfinity;
                                }
                        }
                }
 
                // Reports whether this antenna has been checked as a viable relay already in the current FindNearestRelay.
                public bool relayChecked
                {
                        get
                        {
                                return this.relay.relayChecked;
                        }
                }
 
                /*
                 * Methods
                 * */
                // Build ALL the objects.
                public ModuleLimitedDataTransmitter () : base()
                {
                        this.ErrorMsg = new ScreenMessage("", 4f, false, ScreenMessageStyle.UPPER_LEFT);
                        this.packetThrottle = 100f;
                }
 
                // At least once, when the module starts with a state on the launch pad or later, go find Kerbin.
                public override void OnStart (StartState state)
                {
                        base.OnStart (state);
 
                        if (state >= StartState.PreLaunch)
                        {
                                this.relay = new AntennaRelay(this);
                                this.relay.maxTransmitDistance = this.maxTransmitDistance;
 
                                this.UImaxTransmitDistance = Tools.MuMech_ToSI(this.maxTransmitDistance) + "m";
 
                                GameEvents.onPartActionUICreate.Add(this.onPartActionUICreate);
                                GameEvents.onPartActionUIDismiss.Add(this.onPartActionUIDismiss);
                        }
                }
 
                // When the module loads, fetch the Squad KSPFields from the base.  This is necessary in part because
                // overloading packetSize and packetResourceCostinto a property in ModuleLimitedDataTransmitter didn't
                // work.
                public override void OnLoad(ConfigNode node)
                {
                        this.Fields.Load(node);
                        base.Fields.Load(node);
 
                        base.OnLoad (node);
 
                        this._basepacketSize = base.packetSize;
                        this._basepacketResourceCost = base.packetResourceCost;
 
                        Tools.PostDebugMessage(string.Format(
                                "{0} loaded:\n" +
                                "packetSize: {1}\n" +
                                "packetResourceCost: {2}\n" +
                                "nominalRange: {3}\n" +
                                "maxPowerFactor: {4}\n" +
                                "maxDataFactor: {5}\n",
                                this.name,
                                base.packetSize,
                                this._basepacketResourceCost,
                                this.nominalRange,
                                this.maxPowerFactor,
                                this.maxDataFactor
                        ));
                }
 
                // Post an error in the communication messages describing the reason transmission has failed.  Currently there
                // is only one reason for this.
                protected void PostCannotTransmitError()
                {
                        string ErrorText = string.Intern("Unable to transmit: no visible receivers in range!");
 
                        this.ErrorMsg.message = string.Format(
                                "<color='#{0}{1}{2}{3}'><b>{4}</b></color>",
                                ((int)(XKCDColors.OrangeRed.r * 255f)).ToString("x2"),
                                ((int)(XKCDColors.OrangeRed.g * 255f)).ToString("x2"),
                                ((int)(XKCDColors.OrangeRed.b * 255f)).ToString("x2"),
                                ((int)(XKCDColors.OrangeRed.a * 255f)).ToString("x2"),
                                ErrorText
                        );
 
                        Tools.PostDebugMessage(this.GetType().Name + ": " + this.ErrorMsg.message);
 
                        ScreenMessages.PostScreenMessage(this.ErrorMsg, false);
                }
 
                // Before transmission, set packetResourceCost.  Per above, packet cost increases with the square of
                // distance.  packetResourceCost maxes out at _basepacketResourceCost * maxPowerFactor, at which point
                // transmission fails (see CanTransmit).
                protected void PreTransmit_SetPacketResourceCost()
                {
                        if (fixedPowerCost || this.transmitDistance <= this.nominalRange)
                        {
                                base.packetResourceCost = this._basepacketResourceCost;
                        }
                        else
                        {
                                base.packetResourceCost = this._basepacketResourceCost
                                        * (float)Math.Pow (this.transmitDistance / this.nominalRange, 2);
                        }
 
                        base.packetResourceCost *= this.packetThrottle / 100f;
                }
 
                // Before transmission, set packetSize.  Per above, packet size increases with the inverse square of
                // distance.  packetSize maxes out at _basepacketSize * maxDataFactor.
                protected void PreTransmit_SetPacketSize()
                {
                        if (!fixedPowerCost && this.transmitDistance >= this.nominalRange)
                        {
                                base.packetSize = this._basepacketSize;
                        }
                        else
                        {
                                base.packetSize = Math.Min(
                                        this._basepacketSize * (float)Math.Pow (this.nominalRange / this.transmitDistance, 2),
                                        this._basepacketSize * this.maxDataFactor);
                        }
 
                        base.packetSize *= this.packetThrottle / 100f;
                }
 
                // Override ModuleDataTransmitter.GetInfo to add nominal and maximum range to the VAB description.
                public override string GetInfo()
                {
                        string text = base.GetInfo();
                        text += "Nominal Range: " + Tools.MuMech_ToSI((double)this.nominalRange, 2) + "m\n";
                        text += "Maximum Range: " + Tools.MuMech_ToSI((double)this.maxTransmitDistance, 2) + "m\n";
                        return text;
                }
 
                // Override ModuleDataTransmitter.CanTransmit to return false when transmission is not possible.
                public new bool CanTransmit()
                {
                        if (this.part == null || this.relay == null)
                        {
                                return false;
                        }
 
                        PartStates partState = this.part.State;
                        if (partState == PartStates.DEAD || partState == PartStates.DEACTIVATED)
                        {
                                Tools.PostDebugMessage(string.Format(
                                        "{0}: {1} on {2} cannot transmit: {3}",
                                        this.GetType().Name,
                                        this.part.partInfo.title,
                                        this.vessel.vesselName,
                                        Enum.GetName(typeof(PartStates), partState)
                                ));
                                return false;
                        }
                        return this.relay.CanTransmit();
                }
 
                // Override ModuleDataTransmitter.TransmitData to check against CanTransmit and fail out when CanTransmit
                // returns false.
                public new void TransmitData(List<ScienceData> dataQueue)
                {
                        this.PreTransmit_SetPacketSize();
                        this.PreTransmit_SetPacketResourceCost();
 
                        if (this.CanTransmit())
                        {
                                StringBuilder message = new StringBuilder();
 
                                message.Append("[");
                                message.Append(base.part.partInfo.title);
                                message.Append("]: ");
 
                                message.Append("Beginning transmission ");
 
                                if (this.relay.nearestRelay == null)
                                {
                                        message.Append("directly to Kerbin.");
                                }
                                else
                                {
                                        message.Append("via ");
                                        message.Append(this.relay.nearestRelay);
                                }
 
                                ScreenMessages.PostScreenMessage(message.ToString(), 4f, ScreenMessageStyle.UPPER_LEFT);
 
                                base.TransmitData(dataQueue);
                        }
                        else
                        {
                                this.PostCannotTransmitError ();
                        }
 
                        Tools.PostDebugMessage (
                                "distance: " + this.transmitDistance
                                + " packetSize: " + this.packetSize
                                + " packetResourceCost: " + this.packetResourceCost
                        );
                }
 
                // Override ModuleDataTransmitter.StartTransmission to check against CanTransmit and fail out when CanTransmit
                // returns false.
                public new void StartTransmission()
                {
                        PreTransmit_SetPacketSize ();
                        PreTransmit_SetPacketResourceCost ();
 
                        Tools.PostDebugMessage (
                                "distance: " + this.transmitDistance
                                + " packetSize: " + this.packetSize
                                + " packetResourceCost: " + this.packetResourceCost
                                );
 
                        if (this.CanTransmit())
                        {
                                StringBuilder message = new StringBuilder();
 
                                message.Append("[");
                                message.Append(base.part.partInfo.title);
                                message.Append("]: ");
 
                                message.Append("Beginning transmission ");
 
                                if (this.relay.nearestRelay == null)
                                {
                                        message.Append("directly to Kerbin.");
                                }
                                else
                                {
                                        message.Append("via ");
                                        message.Append(this.relay.nearestRelay);
                                }
 
                                ScreenMessages.PostScreenMessage(message.ToString(), 4f, ScreenMessageStyle.UPPER_LEFT);
 
                                base.StartTransmission();
                        }
                        else
                        {
                                this.PostCannotTransmitError ();
                        }
                }
 
                public void Update()
                {
                        if (this.actionUIUpdate)
                        {
                                if (this.CanTransmit())
                                {
                                        this.UIrelayStatus = string.Intern("Connected");
                                        this.UItransmitDistance = Tools.MuMech_ToSI(this.transmitDistance) + "m";
                                        this.UIpacketSize = Tools.MuMech_ToSI(this.DataRate) + "MiT";
                                        this.UIpacketCost = Tools.MuMech_ToSI(this.DataResourceCost) + "E";
                                }
                                else
                                {
                                        if (this.relay.firstOccludingBody == null)
                                        {
                                                this.UIrelayStatus = string.Intern("Out of range");
                                        }
                                        else
                                        {
                                                this.UIrelayStatus = string.Format("Blocked by {0}", this.relay.firstOccludingBody.bodyName);
                                        }
                                        this.UImaxTransmitDistance = "N/A";
                                        this.UIpacketSize = "N/A";
                                        this.UIpacketCost = "N/A";
                                }
                        }
                }
 
                public void onPartActionUICreate(Part eventPart)
                {
                        if (eventPart == base.part)
                        {
                                this.actionUIUpdate = true;
                        }
                }
 
                public void onPartActionUIDismiss(Part eventPart)
                {
                        if (eventPart == base.part)
                        {
                                this.actionUIUpdate = false;
                        }
                }
 
                public override string ToString()
                {
                        StringBuilder msg = new StringBuilder();
 
                        msg.Append(this.part.partInfo.title);
 
                        if (vessel != null)
                        {
                                msg.Append(" on ");
                                msg.Append(vessel.vesselName);
                        }
 
                        return msg.ToString();
                }
 
                // When debugging, it's nice to have a button that just tells you everything.
                #if DEBUG
                [KSPEvent (guiName = "Show Debug Info", active = true, guiActive = true)]
                public void DebugInfo()
                {
                        PreTransmit_SetPacketSize ();
                        PreTransmit_SetPacketResourceCost ();
 
                        string msg = string.Format(
                                "'{0}'\n" + 
                                "_basepacketSize: {1}\n" +
                                "packetSize: {2}\n" +
                                "_basepacketResourceCost: {3}\n" +
                                "packetResourceCost: {4}\n" +
                                "maxTransmitDistance: {5}\n" +
                                "transmitDistance: {6}\n" +
                                "nominalRange: {7}\n" +
                                "CanTransmit: {8}\n" +
                                "DataRate: {9}\n" +
                                "DataResourceCost: {10}\n" +
                                "TransmitterScore: {11}\n" +
                                "NearestRelay: {12}\n" +
                                "Vessel ID: {13}",
                                this.name,
                                this._basepacketSize,
                                base.packetSize,
                                this._basepacketResourceCost,
                                base.packetResourceCost,
                                this.maxTransmitDistance,
                                this.transmitDistance,
                                this.nominalRange,
                                this.CanTransmit(),
                                this.DataRate,
                                this.DataResourceCost,
                                ScienceUtil.GetTransmitterScore(this),
                                this.relay.FindNearestRelay(),
                                this.vessel.id
                                );
                        Tools.PostDebugMessage(msg);
                }
 
                [KSPEvent (guiName = "Dump Vessels", active = true, guiActive = true)]
                public void PrintAllVessels()
                {
                        StringBuilder sb = new StringBuilder();
 
                        sb.Append("Dumping FlightGlobals.Vessels:");
 
                        foreach (Vessel vessel in FlightGlobals.Vessels)
                        {
                                sb.AppendFormat("\n'{0} ({1})'", vessel.vesselName, vessel.id);
                        }
 
                        Tools.PostDebugMessage(sb.ToString());
                }
 
                [KSPEvent (guiName = "Dump RelayDB", active = true, guiActive = true)]
                public void DumpRelayDB()
                {
                        RelayDatabase.Instance.Dump();
                }
                #endif
        }
}