// Copyright (C) Stichting Deltares 2016. 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.Data.SQLite;
using Core.Common.IO.Readers;
using Core.Common.Utils.Builders;
using Ringtoets.Piping.IO.Builders;
using Ringtoets.Piping.IO.Exceptions;
using Ringtoets.Piping.IO.Properties;
using Ringtoets.Piping.Primitives;

namespace Ringtoets.Piping.IO.SoilProfile
{
    /// <summary>
    /// This class is responsible for reading 2d profile definitions from the Soil database using a constructed reader
    /// and transform the definitions to a <see cref="PipingSoilProfile"/>.
    /// </summary>
    internal static class SoilProfile2DReader
    {
        /// <summary>
        /// Reads information for a profile from the database and creates a <see cref="PipingSoilProfile"/> based on the information.
        /// </summary>
        /// <param name="reader">A <see cref="IRowBasedDatabaseReader"/> which is used to read row values from.</param>
        /// <returns>A new <see cref="PipingSoilProfile"/>, which is based on the information from the database.</returns>
        /// <exception cref="Core.Common.IO.Exceptions.CriticalFileReadException">Thrown when reading the profile encountered an unrecoverable error.</exception>
        /// <exception cref="PipingSoilProfileReadException">Thrown when
        /// <list type="bullet">
        /// <item>a layer's geometry could not be parsed as XML;</item>
        /// <item>the parsed geometry did not contain loops;</item>
        /// <item>after reading the layers, no layers were added to be build;</item>
        /// <item>unexpected values were encountered for layer properties</item>
        /// </list> 
        /// </exception>
        internal static PipingSoilProfile ReadFrom(IRowBasedDatabaseReader reader)
        {
            var criticalProperties = new CriticalProfileProperties(reader);
            var requiredProperties = new RequiredProfileProperties(reader, criticalProperties.ProfileName);

            try
            {
                var soilProfileBuilder = new SoilProfileBuilder2D(criticalProperties.ProfileName, requiredProperties.IntersectionX, criticalProperties.ProfileId);

                for (int i = 1; i <= criticalProperties.LayerCount; i++)
                {
                    var pipingSoilLayer2D = ReadPiping2DSoilLayer(reader, criticalProperties.ProfileName);
                    soilProfileBuilder.Add(pipingSoilLayer2D);
                    reader.MoveNext();
                }

                return soilProfileBuilder.Build();
            }
            catch (SoilProfileBuilderException e)
            {
                throw CreatePipingSoilProfileReadException(reader.Path, criticalProperties.ProfileName, e);
            }
            catch (ArgumentException e)
            {
                throw CreatePipingSoilProfileReadException(reader.Path, criticalProperties.ProfileName, e);
            }
        }

        /// <summary>
        /// Reads a soil layer from a 2d profile in the database.
        /// </summary>
        /// <param name="reader">The <see cref="SQLiteDataReader"/> to read the layer property values from.</param>
        /// <param name="profileName">The profile name used in generating exceptions messages if casting failed.</param>
        /// <returns>A new <see cref="SoilLayer2D"/> instance, based on the information read from the database.</returns>
        /// <exception cref="PipingSoilProfileReadException">Thrown when:
        /// <list type="bullet">
        /// <item>A column for a layer property did not contain a value of the expected type.</item>
        /// <item>The database contains an invalid XML definition for geometry.</item>
        /// <item>The read geometry does not contain segments that form form a loop for either the inner or outer loop.</item>
        /// </list></exception>
        private static SoilLayer2D ReadPiping2DSoilLayer(IRowBasedDatabaseReader reader, string profileName)
        {
            var properties = new LayerProperties(reader, profileName);

            SoilLayer2D pipingSoilLayer;
            try
            {
                var geometryValue = ReadGeometryFrom(reader, profileName);
                pipingSoilLayer = new SoilLayer2DReader().Read(geometryValue);
            }
            catch (SoilLayerConversionException e)
            {
                throw CreatePipingSoilProfileReadException(reader.Path, profileName, e);
            }

            if (pipingSoilLayer != null)
            {
                pipingSoilLayer.IsAquifer = properties.IsAquifer;
                pipingSoilLayer.MaterialName = properties.MaterialName;
                pipingSoilLayer.Color = properties.Color;

                pipingSoilLayer.BelowPhreaticLevelDistribution = properties.BelowPhreaticLevelDistribution;
                pipingSoilLayer.BelowPhreaticLevelShift = properties.BelowPhreaticLevelShift;
                pipingSoilLayer.BelowPhreaticLevelMean = properties.BelowPhreaticLevelMean;
                pipingSoilLayer.BelowPhreaticLevelDeviation = properties.BelowPhreaticLevelDeviation;

                pipingSoilLayer.DiameterD70Distribution = properties.DiameterD70Distribution;
                pipingSoilLayer.DiameterD70Shift = properties.DiameterD70Shift;
                pipingSoilLayer.DiameterD70Mean = properties.DiameterD70Mean;
                pipingSoilLayer.DiameterD70Deviation = properties.DiameterD70Deviation;

                pipingSoilLayer.PermeabilityDistribution = properties.PermeabilityDistribution;
                pipingSoilLayer.PermeabilityShift = properties.PermeabilityShift;
                pipingSoilLayer.PermeabilityMean = properties.PermeabilityMean;
                pipingSoilLayer.PermeabilityDeviation = properties.PermeabilityDeviation;

            }
            return pipingSoilLayer;
        }

        /// <summary>
        /// Reads the geometry for a layer from the current <paramref name="reader"/>
        /// </summary>
        /// <param name="reader">The <see cref="SQLiteDataReader"/> to read the geometry value from.</param>
        /// <param name="profileName">The profile name used in generating exceptions messages if casting failed.</param>
        /// <returns></returns>
        private static byte[] ReadGeometryFrom(IRowBasedDatabaseReader reader, string profileName)
        {
            try
            {
                return reader.Read<byte[]>(SoilProfileDatabaseColumns.LayerGeometry);
            }
            catch (InvalidCastException e)
            {
                throw CreatePipingSoilProfileReadException(reader.Path, profileName, e);
            }
        }

        private static PipingSoilProfileReadException CreatePipingSoilProfileReadException(string filePath, string profileName, string errorMessage, Exception innerException)
        {
            var message = new FileReaderErrorMessageBuilder(filePath)
                .WithSubject(string.Format(Resources.PipingSoilProfileReader_SoilProfileName_0_, profileName))
                .Build(errorMessage);
            return new PipingSoilProfileReadException(profileName, message, innerException);
        }

        private static PipingSoilProfileReadException CreatePipingSoilProfileReadException(string filePath, string profileName, Exception innerException)
        {
            var message = new FileReaderErrorMessageBuilder(filePath)
                .WithSubject(string.Format(Resources.PipingSoilProfileReader_SoilProfileName_0_, profileName))
                .Build(innerException.Message);
            return new PipingSoilProfileReadException(profileName, message, innerException);
        }

        private class RequiredProfileProperties
        {
            internal readonly double IntersectionX;

            /// <summary>
            /// Creates a new instance of <see cref="RequiredProfileProperties"/>, which contains properties
            /// that are required to create a complete <see cref="PipingSoilProfile"/>. If these properties
            /// cannot be read, then the reader can proceed to the next profile.
            /// </summary>
            /// <param name="reader">The <see cref="SQLiteDataReader"/> to read the required profile property values from.</param>
            /// <param name="profileName">The profile name used in generating exceptions messages if casting failed.</param>
            /// <exception cref="PipingSoilProfileReadException">Thrown when the values in the database could not be 
            /// casted to the expected column types.</exception>
            internal RequiredProfileProperties(IRowBasedDatabaseReader reader, string profileName)
            {
                string readColumn = SoilProfileDatabaseColumns.IntersectionX;
                try
                {
                    IntersectionX = reader.Read<double>(readColumn);
                }
                catch (InvalidCastException e)
                {
                    var message = string.Format(Resources.PipingSoilProfileReader_Profile_has_invalid_value_on_Column_0_, readColumn);
                    throw CreatePipingSoilProfileReadException(reader.Path, profileName, message, e);
                }
            }
        }
    }
}