Webiant Logo Webiant Logo
☌

  1. No results found.

    Try your search with a different keyword or use * as a wildcard.

RecentlyViewedProductsService.cs

using Microsoft.AspNetCore.Http;
using Nop.Core;
using Nop.Core.Domain.Catalog;
using Nop.Core.Http;
using Nop.Core.Security;

namespace Nop.Services.Catalog;

/// 
/// Recently viewed products service
/// 
public partial class RecentlyViewedProductsService : IRecentlyViewedProductsService
{
    #region Fields

    protected readonly CatalogSettings _catalogSettings;
    protected readonly CookieSettings _cookieSettings;
    protected readonly IHttpContextAccessor _httpContextAccessor;
    protected readonly IProductService _productService;
    protected readonly IWebHelper _webHelper;
    private static readonly char[] _separator = [','];

    #endregion

    #region Ctor

    public RecentlyViewedProductsService(CatalogSettings catalogSettings,
        CookieSettings cookieSettings,
        IHttpContextAccessor httpContextAccessor,
        IProductService productService,
        IWebHelper webHelper)
    {
        _catalogSettings = catalogSettings;
        _cookieSettings = cookieSettings;
        _httpContextAccessor = httpContextAccessor;
        _productService = productService;
        _webHelper = webHelper;
    }

    #endregion

    #region Utilities

    /// 
    /// Gets a list of identifier of recently viewed products
    /// 
    /// List of identifier
    protected List GetRecentlyViewedProductsIds()
    {
        return GetRecentlyViewedProductsIds(int.MaxValue);
    }

    /// 
    /// Gets a list of identifier of recently viewed products
    /// 
    /// Number of products to load
    /// List of identifier
    protected List GetRecentlyViewedProductsIds(int number)
    {
        var httpContext = _httpContextAccessor.HttpContext;
        if (httpContext?.Request == null)
            return new List();

        //try to get cookie
        var cookieName = $"{NopCookieDefaults.Prefix}{NopCookieDefaults.RecentlyViewedProductsCookie}";
        if (!httpContext.Request.Cookies.TryGetValue(cookieName, out var productIdsCookie) || string.IsNullOrEmpty(productIdsCookie))
            return new List();

        //get array of string product identifiers from cookie
        var productIds = productIdsCookie.Split(_separator, StringSplitOptions.RemoveEmptyEntries);

        //return list of int product identifiers
        return productIds.Select(int.Parse).Distinct().Take(number).ToList();
    }

    /// 
    /// Add cookie value for the recently viewed products
    /// 
    /// Collection of the recently viewed products identifiers
    /// A task that represents the asynchronous operation
    protected virtual Task AddRecentlyViewedProductsCookieAsync(IEnumerable recentlyViewedProductIds)
    {
        //delete current cookie if exists
        var cookieName = $"{NopCookieDefaults.Prefix}{NopCookieDefaults.RecentlyViewedProductsCookie}";
        _httpContextAccessor.HttpContext.Response.Cookies.Delete(cookieName);

        //create cookie value
        var productIdsCookie = string.Join(",", recentlyViewedProductIds);

        //create cookie options 
        var cookieExpires = _cookieSettings.RecentlyViewedProductsCookieExpires;
        var cookieOptions = new CookieOptions
        {
            Expires = DateTime.Now.AddHours(cookieExpires),
            HttpOnly = true,
            Secure = _webHelper.IsCurrentConnectionSecured()
        };

        //add cookie
        _httpContextAccessor.HttpContext.Response.Cookies.Append(cookieName, productIdsCookie, cookieOptions);

        return Task.CompletedTask;
    }

    #endregion

    #region Methods

    /// 
    /// Gets a "recently viewed products" list
    /// 
    /// Number of products to load
    /// 
    /// A task that represents the asynchronous operation
    /// The task result contains the "recently viewed products" list
    /// 
    public virtual async Task> GetRecentlyViewedProductsAsync(int number)
    {
        //get list of recently viewed product identifiers
        var productIds = GetRecentlyViewedProductsIds(number);

        //return list of product
        return (await _productService.GetProductsByIdsAsync(productIds.ToArray()))
            .Where(product => product.Published && !product.Deleted).ToList();
    }

    /// 
    /// Adds a product to a recently viewed products list
    /// 
    /// Product identifier
    /// A task that represents the asynchronous operation
    public virtual async Task AddProductToRecentlyViewedListAsync(int productId)
    {
        if (_httpContextAccessor.HttpContext?.Response == null)
            return;

        //whether recently viewed products is enabled
        if (!_catalogSettings.RecentlyViewedProductsEnabled)
            return;

        //get list of recently viewed product identifiers
        var productIds = GetRecentlyViewedProductsIds();

        //whether product identifier to add already exist
        if (!productIds.Contains(productId))
            productIds.Insert(0, productId);

        //limit list based on the allowed number of the recently viewed products
        productIds = productIds.Take(_catalogSettings.RecentlyViewedProductsNumber).ToList();

        //set cookie
        await AddRecentlyViewedProductsCookieAsync(productIds);
    }

    #endregion
}