// Copyright (C) Stichting Deltares 2019. All rights reserved.
//
// This file is part of the Dam Engine.
//
// The Dam Engine is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
// All names, logos, and references to "Deltares" are registered trademarks of
// Stichting Deltares and remain full property of Stichting Deltares at all times.
// All rights reserved.

using System;
using System.Collections.Generic;
using Deltares.DamEngine.Calculators.DikesDesign;
using Deltares.DamEngine.Calculators.DikesOperational;
using Deltares.DamEngine.Data.General;
using Deltares.DamEngine.Data.Standard.Calculation;
using Deltares.DamEngine.Data.Standard.Logging;
using Deltares.DamEngine.Interface.Properties;
using Deltares.DamEngine.Io;
using Deltares.DamEngine.Io.XmlInput;
using Deltares.DamEngine.Io.XmlOutput;

namespace Deltares.DamEngine.Interface
{
    /// <summary>
    /// The main interface class for accessing the Dam Engine
    /// </summary>
    public class EngineInterface
    {
        private ProgressDelegate progressDelegate;
        private SendMessageDelegate sendMessageDelegate;
        private UserAbortDelegate userAbortDelegate;
        
        /// <summary>
        /// Initializes a new instance of the <see cref="EngineInterface"/> class.
        /// </summary>
        /// <param name="modelInput">Xml string containing the model input.</param>
        public EngineInterface(string modelInput)
        {
            if (String.IsNullOrEmpty(modelInput))
            {
                throw new EngineInterfaceException(Resources.Error_EmptyInputString);
            }

            Input input = DamXmlSerialization.LoadInputFromXmlString(modelInput);
            DamProjectData = FillDamFromXmlInput.CreateDamProjectData(input);
            SendMessage(new LogMessage() { MessageType = LogMessageType.Info, Message = Resources.ModelAccepted });
        }

        /// <summary>
        /// Gets or sets the progress delegate.
        /// </summary>
        /// <value>
        /// The progress delegate.
        /// </value>
        public ProgressDelegate ProgressDelegate
        {
            get
            {
                return progressDelegate;
            }
            set
            {
                progressDelegate = value;
            }
        }

        /// <summary>
        /// Gets or sets the send message delegate.
        /// </summary>
        /// <value>
        /// The send message delegate.
        /// </value>
        public SendMessageDelegate SendMessageDelegate
        {
            get
            {
                return sendMessageDelegate;
            }
            set
            {
                sendMessageDelegate = value;
            }
        }

        /// <summary>
        /// Gets or sets the user abort delegate.
        /// </summary>
        /// <value>
        /// The user abort delegate.
        /// </value>
        public UserAbortDelegate UserAbortDelegate
        {
            get
            {
                return userAbortDelegate;
            }
            set
            {
                userAbortDelegate = value;
            }
        }

        /// <summary>
        /// Gets or sets the dam project data.
        /// </summary>
        /// <value>
        /// The dam project data.
        /// </value>
        public DamProjectData DamProjectData { get; set; }

        private void SendMessage(LogMessage logMessage)
        {
            SendMessageDelegate?.Invoke(logMessage);
        }

        private void Progress(double progress)
        {
            ProgressDelegate?.Invoke(progress);
        }

        private bool UserAbort()
        {
            if (UserAbortDelegate != null)
            {
                return UserAbortDelegate();
            }
            else
            {
                return false;
            }
        }

        /// <summary>
        /// Validates the model.
        /// </summary>
        /// <returns>Validation messages in an XML string</returns>
        public string Validate()
        {
            SendMessage(new LogMessage() { MessageType = LogMessageType.Info, Message = Resources.StartValidation });
            List<LogMessage> validationMessages = null;

            try
            {
                DamProjectData.Dike.Validate(DamProjectData.DamProjectType == DamProjectType.Operational);
            }
            catch (Exception e)
            {
                var validationMessage = new LogMessage(LogMessageType.Error,null, e.Message);
                validationMessages = new List<LogMessage> {validationMessage};
                DamProjectData.CalculationMessages = new List<LogMessage>();
            }
              

            // Local validation can give messages and these have to be added to the results but note that there
            // already can be messages added by instantiation of the interface too. So add the local to the global
            if (validationMessages != null && validationMessages.Count > 0)
            {
                if (DamProjectData != null && DamProjectData.CalculationMessages != null)
                {
                    DamProjectData.CalculationMessages.AddRange(validationMessages);
                }
            }

            // Now check if there are any messages at all, if so return them.
            if (DamProjectData != null && DamProjectData.CalculationMessages != null && DamProjectData.CalculationMessages.Count > 0)
            {
                Output output = FillXmlOutputFromDam.CreateOutput(DamProjectData);
                string outputXml = DamXmlSerialization.SaveOutputAsXmlString(output);
                SendMessage(new LogMessage() { MessageType = LogMessageType.Info, Message = Resources.EndValidation });
                return outputXml;
            }
            SendMessage(new LogMessage() { MessageType = LogMessageType.Info, Message = Resources.EndValidation });
            return null;
        }

        /// <summary>
        /// Runs this instance.
        /// </summary>
        /// <returns>Returns the output in an XML string</returns>
        public string Run()
        {
            string outputXml;
            SendMessage(new LogMessage() { MessageType = LogMessageType.Info, Message = Resources.StartCalculation });

            switch (DamProjectData.DamProjectType)
            {
                case DamProjectType.Operational:
                    var operationalCalculator = new OperationalCalculator();
                    operationalCalculator.Execute(DamProjectData);
                    break;
                case DamProjectType.Design:
                    DesignCalculator designCalculator = new DesignCalculator();
                    designCalculator.RegisterProgress(progressDelegate);
                    designCalculator.Execute(DamProjectData);
                    break;
            }
            Output output = FillXmlOutputFromDam.CreateOutput(DamProjectData);
            outputXml = DamXmlSerialization.SaveOutputAsXmlString(output);
            SendMessage(new LogMessage() { MessageType = LogMessageType.Info, Message = Resources.EndCalculation });
            return outputXml;
        }
    }
}