Skip to content

Open-source eCommerce platform for C# and ASP.NET Core 10 with MongoDB. Build multi-store shops and multi-vendor marketplaces with B2B/B2C, REST API, plugins, Vue 3 and Docker.

7.3 KB
Raw Blame
using Grand.Business.Core.Interfaces.Checkout.CheckoutAttributes;
using Grand.Domain.Common;
using Grand.Domain.Orders;

namespace Grand.Business.Checkout.Services.CheckoutAttributes;

/// <summary>
///     Checkout attribute parser
/// </summary>
public class CheckoutAttributeParser : ICheckoutAttributeParser
{
    private readonly ICheckoutAttributeService _checkoutAttributeService;

    public CheckoutAttributeParser(ICheckoutAttributeService checkoutAttributeService)
    {
        _checkoutAttributeService = checkoutAttributeService;
    }

    /// <summary>
    ///     Gets selected checkout attributes
    /// </summary>
    /// <param name="customAttributes">Attributes</param>
    /// <returns>Selected checkout attributes</returns>
    public virtual async Task<IList<CheckoutAttribute>> ParseCheckoutAttributes(IList<CustomAttribute> customAttributes)
    {
        var result = new List<CheckoutAttribute>();
        if (customAttributes == null || !customAttributes.Any())
            return result;

        foreach (var customAttribute in customAttributes.GroupBy(x => x.Key))
        {
            var attribute = await _checkoutAttributeService.GetCheckoutAttributeById(customAttribute.Key);
            if (attribute != null) result.Add(attribute);
        }

        return result;
    }

    /// <summary>
    ///     Get checkout attribute values
    /// </summary>
    /// <param name="customAttributes">Attributes</param>
    /// <returns>Checkout attribute values</returns>
    public virtual async Task<IList<CheckoutAttributeValue>> ParseCheckoutAttributeValues(
        IList<CustomAttribute> customAttributes)
    {
        var values = new List<CheckoutAttributeValue>();
        if (customAttributes == null || !customAttributes.Any())
            return values;

        var attributes = await ParseCheckoutAttributes(customAttributes);
        foreach (var attribute in attributes)
        {
            if (!attribute.ShouldHaveValues())
                continue;

            var valuesStr = customAttributes.Where(x => x.Key == attribute.Id).Select(x => x.Value);
            values.AddRange(from valueStr in valuesStr
                where !string.IsNullOrEmpty(valueStr)
                select attribute.CheckoutAttributeValues.FirstOrDefault(x => x.Id == valueStr)
                into value
                where value != null
                select value);
        }

        return values;
    }

    /// <summary>
    ///     Get checkout attribute values with checkout attribute
    /// </summary>
    /// <param name="customAttributes">Attributes</param>
    /// <returns>Checkout attribute values with checkout attribute </returns>
    public virtual async Task<IList<(CheckoutAttribute ca, CheckoutAttributeValue cav)>> ParseCheckoutAttributeValue(
        IList<CustomAttribute> customAttributes)
    {
        var values = new List<(CheckoutAttribute ca, CheckoutAttributeValue cav)>();
        if (customAttributes == null || !customAttributes.Any())
            return values;

        var attributes = await ParseCheckoutAttributes(customAttributes);
        foreach (var attribute in attributes)
        {
            if (!attribute.ShouldHaveValues())
                continue;

            var valuesStr = customAttributes.Where(x => x.Key == attribute.Id).Select(x => x.Value);
            values.AddRange(from valueStr in valuesStr
                where !string.IsNullOrEmpty(valueStr)
                select attribute.CheckoutAttributeValues.FirstOrDefault(x => x.Id == valueStr)
                into value
                where value != null
                select (attribute, value));
        }

        return values;
    }

    /// <summary>
    ///     Adds an attribute
    /// </summary>
    /// <param name="customAttributes">Attributes</param>
    /// <param name="ca">Checkout attribute</param>
    /// <param name="value">Value</param>
    /// <returns>Attributes</returns>
    public virtual IList<CustomAttribute> AddCheckoutAttribute(IList<CustomAttribute> customAttributes,
        CheckoutAttribute ca, string value)
    {
        customAttributes ??= new List<CustomAttribute>();

        customAttributes.Add(new CustomAttribute { Key = ca.Id, Value = value });
        return customAttributes;
    }

    /// <summary>
    ///     Removes checkout attributes which cannot be applied to the current cart and returns an update attributes
    /// </summary>
    /// <param name="customAttributes">Attributes</param>
    /// <param name="cart">Shopping cart items</param>
    /// <returns>Updated attributes</returns>
    public virtual async Task<IList<CustomAttribute>> EnsureOnlyActiveAttributes(
        IList<CustomAttribute> customAttributes, IList<ShoppingCartItem> cart)
    {
        customAttributes ??= new List<CustomAttribute>();

        if (cart.RequiresShipping()) return customAttributes;
        var attributes = await ParseCheckoutAttributes(customAttributes);
        var checkoutAttributeIdsToRemove =
            (from ca in attributes where ca.ShippableProductRequired select ca.Id).ToList();

        foreach (var attr in checkoutAttributeIdsToRemove
                     .Select(id => customAttributes.FirstOrDefault(x => x.Key == id))
                     .Where(attr => attr != null)) customAttributes.Remove(attr);

        return customAttributes;
    }

    /// <summary>
    ///     Check whether condition of some attribute is met.
    /// </summary>
    /// <param name="attribute">Checkout attribute</param>
    /// <param name="customAttributes">Selected attributes</param>
    /// <returns>Result</returns>
    public virtual async Task<bool?> IsConditionMet(CheckoutAttribute attribute,
        IList<CustomAttribute> customAttributes)
    {
        ArgumentNullException.ThrowIfNull(attribute);

        customAttributes ??= new List<CustomAttribute>();

        var conditionAttribute = attribute.ConditionAttribute;
        if (!conditionAttribute.Any())
            //no condition
            return null;

        //load an attribute this one depends on
        var dependOnAttribute = (await ParseCheckoutAttributes(conditionAttribute)).FirstOrDefault();
        if (dependOnAttribute == null)
            return true;

        var valuesThatShouldBeSelected = conditionAttribute.Where(x => x.Key == dependOnAttribute.Id)
            .Select(x => x.Value)
            .Where(x => !string.IsNullOrEmpty(x))
            .ToList();

        var selectedValues = customAttributes.Where(x => x.Key == dependOnAttribute.Id).Select(x => x.Value).ToList();
        if (valuesThatShouldBeSelected.Count != selectedValues.Count)
            return false;

        //compare values
        var allFound = true;
        foreach (var t1 in valuesThatShouldBeSelected)
        {
            var found = false;
            foreach (var t2 in selectedValues.Where(t2 => t1 == t2))
                found = true;
            if (!found)
                allFound = false;
        }

        return allFound;
    }

    /// <summary>
    ///     Remove an attribute
    /// </summary>
    /// <param name="customAttributes">Attributes</param>
    /// <param name="attribute">Checkout attribute</param>
    /// <returns>Updated</returns>
    public virtual IList<CustomAttribute> RemoveCheckoutAttribute(IList<CustomAttribute> customAttributes,
        CheckoutAttribute attribute)
    {
        return customAttributes.Where(x => x.Key != attribute.Id).ToList();
    }
}