// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved. See License.txt in the project root for license information.

namespace System.Data.Entity.Core.Mapping.Update.Internal
{
    using System.Collections.Generic;
    using System.Data.Entity.Core.Common.CommandTrees;
    using System.Data.Entity.Core.Common.Utils;
    using System.Data.Entity.Core.Metadata.Edm;
    using System.Data.Entity.Resources;
    using System.Data.Entity.Utilities;
    using System.Diagnostics;
    using System.Globalization;

    internal partial class Propagator
    {
        // <summary>
        // Helper class supporting the evaluation of highly constrained expressions of the following
        // form:
        // P := P AND P | P OR P | NOT P | V is of type | V eq V | V
        // V := P
        // V := Property(V) | Constant | CASE WHEN P THEN V ... ELSE V | Row | new Instance | Null
        // The evaluator supports SQL style ternary logic for unknown results (bool? is used, where
        // null --> unknown, true --> TRUE and false --> FALSE
        // </summary>
        // <remarks>
        // Assumptions:
        // - The node and the row passed in must be type compatible.
        // Any var refs in the node must have the same type as the input row. This is a natural
        // requirement given the usage of this method in the propagator, since each propagator handler
        // produces rows of the correct type for its parent. Keep in mind that every var ref in a CQT is
        // bound specifically to the direct child.
        // - Equality comparisons are CLR culture invariant. Practically, this introduces the following
        // differences from SQL comparisons:
        // - String comparisons are not collation sensitive
        // - The constants we compare come from a fixed repertoire of scalar types implementing IComparable
        // For the purposes of update mapping view evaluation, these assumptions are safe because we
        // only support mapping of non-null constants to fields (these constants are non-null discriminators)
        // and key comparisons (where the key values are replicated across a reference).
        // </remarks>
        private class Evaluator : UpdateExpressionVisitor<PropagatorResult>
        {
            // <summary>
            // Constructs an evaluator for evaluating expressions for the given row.
            // </summary>
            // <param name="row"> Row to match </param>
            private Evaluator(PropagatorResult row)
            {
                DebugCheck.NotNull(row);

                m_row = row;
            }

            private readonly PropagatorResult m_row;
            private static readonly string _visitorName = typeof(Evaluator).FullName;

            protected override string VisitorName
            {
                get { return _visitorName; }
            }

            // <summary>
            // Utility method filtering out a set of rows given a predicate.
            // </summary>
            // <param name="predicate"> Match criteria. </param>
            // <param name="rows"> Input rows. </param>
            // <returns> Input rows matching criteria. </returns>
            internal static IEnumerable<PropagatorResult> Filter(
                DbExpression predicate, IEnumerable<PropagatorResult> rows)
            {
                foreach (var row in rows)
                {
                    if (EvaluatePredicate(predicate, row))
                    {
                        yield return row;
                    }
                }
            }

            // <summary>
            // Utility method determining whether a row matches a predicate.
            // </summary>
            // <remarks>
            // See Walker class for an explanation of this coding pattern.
            // </remarks>
            // <param name="predicate"> Match criteria. </param>
            // <param name="row"> Input row. </param>
            // <returns>
            // <c>true</c> if the row matches the criteria; <c>false</c> otherwise
            // </returns>
            internal static bool EvaluatePredicate(DbExpression predicate, PropagatorResult row)
            {
                var evaluator = new Evaluator(row);
                var expressionResult = predicate.Accept(evaluator);

                var result = ConvertResultToBool(expressionResult);

                // unknown --> false at base of predicate
                return result ?? false;
            }

            // <summary>
            // Evaluates scalar node.
            // </summary>
            // <param name="node"> Sub-query returning a scalar value. </param>
            // <param name="row"> Row to evaluate. </param>
            // <returns> Scalar result. </returns>
            internal static PropagatorResult Evaluate(DbExpression node, PropagatorResult row)
            {
                DbExpressionVisitor<PropagatorResult> evaluator = new Evaluator(row);
                return node.Accept(evaluator);
            }

            // <summary>
            // Given an expression, converts to a (nullable) bool. Only boolean constant and null are
            // supported.
            // </summary>
            // <param name="result"> Result to convert </param>
            // <returns> true if true constant; false if false constant; null is null constant </returns>
            private static bool? ConvertResultToBool(PropagatorResult result)
            {
                DebugCheck.NotNull(result);
                Debug.Assert(result.IsSimple, "Must be a simple Boolean result");

                if (result.IsNull)
                {
                    return null;
                }
                else
                {
                    // rely on cast exception to identify invalid cases (CQT validation should already take care of this)
                    return (bool)result.GetSimpleValue();
                }
            }

            // <summary>
            // Converts a (nullable) bool to an expression.
            // </summary>
            // <param name="booleanValue"> Result </param>
            // <param name="inputs"> Inputs contributing to the result </param>
            // <returns> DbExpression </returns>
            private static PropagatorResult ConvertBoolToResult(bool? booleanValue, params PropagatorResult[] inputs)
            {
                object result;
                if (booleanValue.HasValue)
                {
                    result = booleanValue.Value;
                    ;
                }
                else
                {
                    result = null;
                }
                var flags = PropagateUnknownAndPreserveFlags(null, inputs);
                return PropagatorResult.CreateSimpleValue(flags, result);
            }

            // <summary>
            // Determines whether the argument being evaluated has a given type (declared in the IsOfOnly predicate).
            // </summary>
            // <param name="predicate"> IsOfOnly predicate. </param>
            // <returns> True if the row being evaluated is of the requested type; false otherwise. </returns>
            public override PropagatorResult Visit(DbIsOfExpression predicate)
            {
                Check.NotNull(predicate, "predicate");

                if (DbExpressionKind.IsOfOnly
                    != predicate.ExpressionKind)
                {
                    throw ConstructNotSupportedException(predicate);
                }

                var childResult = Visit(predicate.Argument);
                bool result;
                if (childResult.IsNull)
                {
                    // Null value expressions are typed, but the semantics of null are slightly different.
                    result = false;
                }
                else
                {
                    result = childResult.StructuralType.EdmEquals(predicate.OfType.EdmType);
                }

                return ConvertBoolToResult(result, childResult);
            }

            // <summary>
            // Determines whether the row being evaluated has the given type (declared in the IsOf predicate).
            // </summary>
            // <param name="predicate"> Equals predicate. </param>
            // <returns> True if the values being compared are equivalent; false otherwise. </returns>
            public override PropagatorResult Visit(DbComparisonExpression predicate)
            {
                Check.NotNull(predicate, "predicate");

                if (DbExpressionKind.Equals
                    == predicate.ExpressionKind)
                {
                    // Retrieve the left and right hand sides of the equality predicate.
                    var leftResult = Visit(predicate.Left);
                    var rightResult = Visit(predicate.Right);

                    bool? result;

                    if (leftResult.IsNull
                        || rightResult.IsNull)
                    {
                        result = null; // unknown
                    }
                    else
                    {
                        var left = leftResult.GetSimpleValue();
                        var right = rightResult.GetSimpleValue();

                        // Perform a comparison between the sides of the equality predicate using invariant culture.
                        // See assumptions outlined in the documentation for this class for additional information.
                        result = ByValueEqualityComparer.Default.Equals(left, right);
                    }

                    return ConvertBoolToResult(result, leftResult, rightResult);
                }
                else
                {
                    throw ConstructNotSupportedException(predicate);
                }
            }

            // <summary>
            // Evaluates an 'and' expression given results of evalating its children.
            // </summary>
            // <param name="predicate"> And predicate </param>
            // <returns> True if both child predicates are satisfied; false otherwise. </returns>
            public override PropagatorResult Visit(DbAndExpression predicate)
            {
                Check.NotNull(predicate, "predicate");

                var left = Visit(predicate.Left);
                var right = Visit(predicate.Right);
                var leftResult = ConvertResultToBool(left);
                var rightResult = ConvertResultToBool(right);
                bool? result;

                // Optimization: if either argument is false, preserved and known, return a
                // result that is false, preserved and known.
                if ((leftResult.HasValue && !leftResult.Value && PreservedAndKnown(left))
                    ||
                    (rightResult.HasValue && !rightResult.Value && PreservedAndKnown(right)))
                {
                    return CreatePerservedAndKnownResult(false);
                }

                result = leftResult.And(rightResult);

                return ConvertBoolToResult(result, left, right);
            }

            // <summary>
            // Evaluates an 'or' expression given results of evaluating its children.
            // </summary>
            // <param name="predicate"> 'Or' predicate </param>
            // <returns> True if either child predicate is satisfied; false otherwise. </returns>
            public override PropagatorResult Visit(DbOrExpression predicate)
            {
                Check.NotNull(predicate, "predicate");

                var left = Visit(predicate.Left);
                var right = Visit(predicate.Right);
                var leftResult = ConvertResultToBool(left);
                var rightResult = ConvertResultToBool(right);
                bool? result;

                // Optimization: if either argument is true, preserved and known, return a
                // result that is true, preserved and known.
                if ((leftResult.HasValue && leftResult.Value && PreservedAndKnown(left))
                    ||
                    (rightResult.HasValue && rightResult.Value && PreservedAndKnown(right)))
                {
                    return CreatePerservedAndKnownResult(true);
                }

                result = leftResult.Or(rightResult);

                return ConvertBoolToResult(result, left, right);
            }

            private static PropagatorResult CreatePerservedAndKnownResult(object value)
            {
                // Known is the default (no explicit flag required)
                return PropagatorResult.CreateSimpleValue(PropagatorFlags.Preserve, value);
            }

            private static bool PreservedAndKnown(PropagatorResult result)
            {
                // Check that the preserve flag is set, and the unknown flag is not set
                return PropagatorFlags.Preserve == (result.PropagatorFlags & (PropagatorFlags.Preserve | PropagatorFlags.Unknown));
            }

            // <summary>
            // Evalutes a 'not' expression given results
            // </summary>
            // <param name="predicate"> 'Not' predicate </param>
            // <returns> True of the argument to the 'not' predicate evaluator to false; false otherwise </returns>
            public override PropagatorResult Visit(DbNotExpression predicate)
            {
                Check.NotNull(predicate, "predicate");

                var child = Visit(predicate.Argument);
                var childResult = ConvertResultToBool(child);

                var result = childResult.Not();

                return ConvertBoolToResult(result, child);
            }

            // <summary>
            // Returns the result of evaluating a case expression.
            // </summary>
            // <param name="node"> Case expression node. </param>
            // <returns> Result of evaluating case expression over the input row for this visitor. </returns>
            public override PropagatorResult Visit(DbCaseExpression node)
            {
                Check.NotNull(node, "node");

                var match = -1;
                var statementOrdinal = 0;

                var inputs = new List<PropagatorResult>();

                foreach (var when in node.When)
                {
                    var whenResult = Visit(when);
                    inputs.Add(whenResult);

                    var matches = ConvertResultToBool(whenResult) ?? false; // ternary logic resolution

                    if (matches)
                    {
                        match = statementOrdinal;
                        break;
                    }

                    statementOrdinal++;
                }

                PropagatorResult matchResult;
                if (-1 == match)
                {
                    matchResult = Visit(node.Else);
                }
                else
                {
                    matchResult = Visit(node.Then[match]);
                }
                inputs.Add(matchResult);

                // Clone the result to avoid modifying expressions that may be used elsewhere
                // (design invariant: only set markup for expressions you create)
                var resultFlags = PropagateUnknownAndPreserveFlags(matchResult, inputs);
                var result = matchResult.ReplicateResultWithNewFlags(resultFlags);

                return result;
            }

            // <summary>
            // Evaluates a var ref. In practice, this corresponds to the input row for the visitor (the row is
            // a member of the referenced input for a projection or filter).
            // We assert that types are consistent here.
            // </summary>
            // <param name="node"> Var ref expression node </param>
            // <returns> Input row for the visitor. </returns>
            public override PropagatorResult Visit(DbVariableReferenceExpression node)
            {
                Check.NotNull(node, "node");

                return m_row;
            }

            // <summary>
            // Evaluates a property expression given the result of evaluating the property's instance.
            // </summary>
            // <param name="node"> Property expression node. </param>
            // <returns> DbExpression resulting from the evaluation of property. </returns>
            public override PropagatorResult Visit(DbPropertyExpression node)
            {
                Check.NotNull(node, "node");

                // Retrieve the result of evaluating the instance for the property.
                var instance = Visit(node.Instance);
                PropagatorResult result;

                if (instance.IsNull)
                {
                    result = PropagatorResult.CreateSimpleValue(instance.PropagatorFlags, null);
                }
                else
                {
                    // find member
                    result = instance.GetMemberValue(node.Property);
                }

                // We do not markup the result since the property value already contains the necessary context
                // (determined at record extraction time)
                return result;
            }

            // <summary>
            // Evaluates a constant expression (trivial: the result is the constant expression)
            // </summary>
            // <param name="node"> Constant expression node. </param>
            // <returns> Constant expression </returns>
            public override PropagatorResult Visit(DbConstantExpression node)
            {
                Check.NotNull(node, "node");

                // Flag the expression as 'preserve', since constants (by definition) cannot vary
                var result = PropagatorResult.CreateSimpleValue(PropagatorFlags.Preserve, node.Value);

                return result;
            }

            // <summary>
            // Evaluates a ref key expression based on the result of evaluating the argument to the ref.
            // </summary>
            // <param name="node"> Ref key expression node. </param>
            // <returns> The structural key of the ref as a new instance (record). </returns>
            public override PropagatorResult Visit(DbRefKeyExpression node)
            {
                Check.NotNull(node, "node");

                // Retrieve the result of evaluating the child argument.
                var argument = Visit(node.Argument);

                // Return the argument directly (propagator results treat refs as standard structures)
                return argument;
            }

            // <summary>
            // Evaluates a null expression (trivial: the result is the null expression)
            // </summary>
            // <param name="node"> Null expression node. </param>
            // <returns> Null expression </returns>
            public override PropagatorResult Visit(DbNullExpression node)
            {
                Check.NotNull(node, "node");

                // Flag the expression as 'preserve', since nulls (by definition) cannot vary
                var result = PropagatorResult.CreateSimpleValue(PropagatorFlags.Preserve, null);

                return result;
            }

            // <summary>
            // Evaluates treat expression given a result for the argument to the treat.
            // </summary>
            // <param name="node"> Treat expression </param>
            // <returns> Null if the argument is of the given type, the argument otherwise </returns>
            public override PropagatorResult Visit(DbTreatExpression node)
            {
                Check.NotNull(node, "node");

                var childResult = Visit(node.Argument);
                var nodeType = node.ResultType;

                if (MetadataHelper.IsSuperTypeOf(nodeType.EdmType, childResult.StructuralType))
                {
                    // Doing an up cast is not required because all property/ordinal
                    // accesses are unaffected for more derived types (derived members
                    // are appended)
                    return childResult;
                }

                // "Treat" where the result does not implement the given type results in a null
                // result
                var result = PropagatorResult.CreateSimpleValue(childResult.PropagatorFlags, null);
                return result;
            }

            // <summary>
            // Casts argument to expression.
            // </summary>
            // <param name="node"> Cast expression node </param>
            // <returns> Result of casting argument </returns>
            public override PropagatorResult Visit(DbCastExpression node)
            {
                Check.NotNull(node, "node");

                var childResult = Visit(node.Argument);
                var nodeType = node.ResultType;

                if (!childResult.IsSimple
                    || BuiltInTypeKind.PrimitiveType != nodeType.EdmType.BuiltInTypeKind)
                {
                    throw new NotSupportedException(Strings.Update_UnsupportedCastArgument(nodeType.EdmType.Name));
                }

                object resultValue;

                if (childResult.IsNull)
                {
                    resultValue = null;
                }
                else
                {
                    try
                    {
                        resultValue = Cast(childResult.GetSimpleValue(), ((PrimitiveType)nodeType.EdmType).ClrEquivalentType);
                    }
                    catch
                    {
                        Debug.Fail("view generator failed to validate cast in update mapping view");
                        throw;
                    }
                }

                var result = childResult.ReplicateResultWithNewValue(resultValue);
                return result;
            }

            // <summary>
            // Casts an object instance to the specified model type.
            // </summary>
            // <param name="value"> Value to cast </param>
            // <param name="clrPrimitiveType"> clr type to which the value is casted to </param>
            // <returns> Cast value </returns>
            private static object Cast(object value, Type clrPrimitiveType)
            {
                IFormatProvider formatProvider = CultureInfo.InvariantCulture;

                if (null == value
                    || value == DBNull.Value
                    || value.GetType() == clrPrimitiveType)
                {
                    return value;
                }
                else
                {
                    //Convert is not handling DateTime to DateTimeOffset conversion
                    if ((value is DateTime)
                        && (clrPrimitiveType == typeof(DateTimeOffset)))
                    {
                        return new DateTimeOffset(((DateTime)value).Ticks, TimeSpan.Zero);
                    }
                    else
                    {
                        return Convert.ChangeType(value, clrPrimitiveType, formatProvider);
                    }
                }
            }

            // <summary>
            // Evaluate a null expression.
            // </summary>
            // <param name="node"> Is null expression </param>
            // <returns> A boolean expression describing the result of evaluating the Is Null predicate </returns>
            public override PropagatorResult Visit(DbIsNullExpression node)
            {
                Check.NotNull(node, "node");

                var argumentResult = Visit(node.Argument);
                var result = argumentResult.IsNull;

                return ConvertBoolToResult(result, argumentResult);
            }

            // <summary>
            // Supports propagation of preserve and unknown values when evaluating expressions. If any input
            // to an expression is marked as unknown, the same is true of the result of evaluating
            // that expression. If all inputs to an expression are marked 'preserve', then the result is also
            // marked preserve.
            // </summary>
            // <param name="result"> Result to markup </param>
            // <param name="inputs"> Expressions contributing to the result </param>
            // <returns> Marked up result. </returns>
            private static PropagatorFlags PropagateUnknownAndPreserveFlags(PropagatorResult result, IEnumerable<PropagatorResult> inputs)
            {
                var unknown = false;
                var preserve = true;
                var noInputs = true;

                // aggregate all flags on the inputs
                foreach (var input in inputs)
                {
                    noInputs = false;
                    var inputFlags = input.PropagatorFlags;
                    if (PropagatorFlags.NoFlags
                        != (PropagatorFlags.Unknown & inputFlags))
                    {
                        unknown = true;
                    }
                    if (PropagatorFlags.NoFlags
                        == (PropagatorFlags.Preserve & inputFlags))
                    {
                        preserve = false;
                    }
                }
                if (noInputs)
                {
                    preserve = false;
                }

                if (null != result)
                {
                    // Merge with existing flags
                    var flags = result.PropagatorFlags;
                    if (unknown)
                    {
                        flags |= PropagatorFlags.Unknown;
                    }
                    if (!preserve)
                    {
                        flags &= ~PropagatorFlags.Preserve;
                    }

                    return flags;
                }
                else
                {
                    // if there is no input result, create new markup from scratch
                    var flags = PropagatorFlags.NoFlags;
                    if (unknown)
                    {
                        flags |= PropagatorFlags.Unknown;
                    }
                    if (preserve)
                    {
                        flags |= PropagatorFlags.Preserve;
                    }
                    return flags;
                }
            }
        }
    }
}
