// Copyright (C) Stichting Deltares 2017. All rights reserved.
//
// This file is part of Ringtoets.
//
// Ringtoets is free software: you can redistribute it and/or modify
// it under the terms of the GNU 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 General Public License for more details.
//
// You should have received a copy of the GNU 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 System.Linq;
using log4net;
using Ringtoets.Common.IO.Exceptions;
using Ringtoets.Common.IO.SoilProfile;
using Ringtoets.Common.IO.SoilProfile.Schema;
using Ringtoets.Piping.Data.SoilProfile;
using Ringtoets.Piping.Primitives;
using RingtoetsCommonIOResources = Ringtoets.Common.IO.Properties.Resources;

namespace Ringtoets.Piping.IO.SoilProfiles
{
    /// <summary>
    /// Transforms generic <see cref="StochasticSoilModel"/> into <see cref="PipingStochasticSoilModel"/>.
    /// </summary>
    public class PipingStochasticSoilModelTransformer : IStochasticSoilModelTransformer<PipingStochasticSoilModel>
    {
        private static readonly ILog log = LogManager.GetLogger(typeof(PipingStochasticSoilModel));
        private readonly Dictionary<ISoilProfile, PipingSoilProfile> soilProfiles = new Dictionary<ISoilProfile, PipingSoilProfile>();

        public PipingStochasticSoilModel Transform(StochasticSoilModel stochasticSoilModel)
        {
            if (stochasticSoilModel == null)
            {
                throw new ArgumentNullException(nameof(stochasticSoilModel));
            }
            if (stochasticSoilModel.FailureMechanismType != FailureMechanismType.Piping)
            {
                string message = string.Format(RingtoetsCommonIOResources.IStochasticSoilModelTransformer_Cannot_transform_FailureMechanismType_0_Only_FailureMechanismType_1_supported,
                                               stochasticSoilModel.FailureMechanismType,
                                               FailureMechanismType.Piping);
                throw new ImportedDataTransformException(message);
            }

            try
            {
                var pipingModel = new PipingStochasticSoilModel(stochasticSoilModel.Name, stochasticSoilModel.Geometry);
                pipingModel.StochasticSoilProfiles.AddRange(
                    TransformStochasticSoilProfiles(stochasticSoilModel.StochasticSoilProfiles, stochasticSoilModel.Name).ToArray());

                return pipingModel;
            }
            catch (ArgumentException e)
            {
                throw new ImportedDataTransformException(e.Message, e);
            }
        }

        /// <summary>
        /// Transforms all generic <see cref="StochasticSoilProfile"/> into <see cref="PipingStochasticSoilProfile"/>.
        /// </summary>
        /// <param name="stochasticSoilProfiles">The stochastic soil profiles to use in the transformation.</param>
        /// <param name="soilModelName">The name of the soil model.</param>
        /// <returns>The transformed piping stochastic soil profiles.</returns>
        /// <exception cref="ImportedDataTransformException">Thrown when transformation would 
        /// not result in a valid transformed instance.</exception>
        private IEnumerable<PipingStochasticSoilProfile> TransformStochasticSoilProfiles(IEnumerable<StochasticSoilProfile> stochasticSoilProfiles,
                                                                                         string soilModelName)
        {
            PipingStochasticSoilProfile[] transformedProfiles = stochasticSoilProfiles.Select(ssp => PipingStochasticSoilProfileTransformer.Transform(
                                                                                                  ssp,
                                                                                                  GetTransformedPipingSoilProfile(ssp.SoilProfile))).ToArray();
            return GetUniqueStochasticSoilProfiles(transformedProfiles, soilModelName);
        }

        /// <summary>
        /// Transforms all generic <see cref="ISoilProfile"/> into <see cref="PipingSoilProfile"/>.
        /// </summary>
        /// <param name="soilProfile">The soil profile to use in the transformation.</param>
        /// <returns>The transformed piping soil profile.</returns>
        /// <exception cref="ImportedDataTransformException">Thrown when transformation would 
        /// not result in a valid transformed instance.</exception>
        private PipingSoilProfile GetTransformedPipingSoilProfile(ISoilProfile soilProfile)
        {
            PipingSoilProfile pipingSoilProfile;
            if (soilProfiles.ContainsKey(soilProfile))
            {
                pipingSoilProfile = soilProfiles[soilProfile];
            }
            else
            {
                pipingSoilProfile = PipingSoilProfileTransformer.Transform(soilProfile);
                soilProfiles.Add(soilProfile, pipingSoilProfile);
            }
            return pipingSoilProfile;
        }

        /// <summary>
        /// Filters a collection of <see cref="PipingStochasticSoilProfile"/> to determine which items
        /// are unique.
        /// </summary>
        /// <param name="stochasticSoilProfiles">The collection of <see cref="PipingStochasticSoilProfile"/>
        /// to filter.</param>
        /// <param name="soilModelName">The name of the soil model.</param>
        /// <returns>A collection of unique <see cref="PipingStochasticSoilProfile"/>.</returns>
        /// <exception cref="ImportedDataTransformException">Thrown when a <see cref="StochasticSoilProfile"/>
        /// is invalid.</exception>
        private static IEnumerable<PipingStochasticSoilProfile> GetUniqueStochasticSoilProfiles(
            IEnumerable<PipingStochasticSoilProfile> stochasticSoilProfiles,
            string soilModelName)
        {
            List<PipingStochasticSoilProfile> uniqueStochasticSoilProfiles = stochasticSoilProfiles.ToList();
            PipingStochasticSoilProfile[] allStochasticSoilProfiles = uniqueStochasticSoilProfiles.ToArray();

            try
            {
                for (var i = 1; i < allStochasticSoilProfiles.Length; i++)
                {
                    PipingStochasticSoilProfile previousProfile = allStochasticSoilProfiles[i - 1];
                    PipingStochasticSoilProfile currentProfile = allStochasticSoilProfiles[i];
                    if (ReferenceEquals(currentProfile.SoilProfile, previousProfile.SoilProfile))
                    {
                        log.Warn(string.Format(RingtoetsCommonIOResources.SoilModelTransformer_GetUniqueStochasticSoilProfiles_StochasticSoilProfile_0_has_multiple_occurences_in_SoilModel_1_Probability_Summed,
                                               previousProfile.SoilProfile.Name,
                                               soilModelName));

                        previousProfile.AddProbability(currentProfile.Probability);
                        uniqueStochasticSoilProfiles.Remove(currentProfile);
                    }
                }
            }
            catch (ArgumentOutOfRangeException e)
            {
                throw new ImportedDataTransformException(e.Message, e);
            }

            return uniqueStochasticSoilProfiles;
        }
    }
}