Webiant Logo Webiant Logo
  1. No results found.

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

Events.cs

using Microsoft.AspNetCore.Http;
using Nop.Core;
using Nop.Core.Domain.Directory;
using Nop.Core.Domain.Logging;
using Nop.Core.Domain.Orders;
using Nop.Core.Domain.Payments;
using Nop.Core.Domain.Stores;
using Nop.Plugin.Widgets.GoogleAnalytics.Api;
using Nop.Plugin.Widgets.GoogleAnalytics.Api.Models;
using Nop.Services.Catalog;
using Nop.Services.Cms;
using Nop.Services.Common;
using Nop.Services.Configuration;
using Nop.Services.Directory;
using Nop.Services.Events;
using Nop.Services.Logging;
using Nop.Services.Orders;
using Nop.Services.Stores;

namespace Nop.Plugin.Widgets.GoogleAnalytics;

public class EventConsumer :
    IConsumer,
    IConsumer,
    IConsumer
{
    protected readonly CurrencySettings _currencySettings;
    protected readonly GoogleAnalyticsHttpClient _googleAnalyticsHttpClient;
    protected readonly ICategoryService _categoryService;
    protected readonly ICurrencyService _currencyService;
    protected readonly IGenericAttributeService _genericAttributeService;
    protected readonly IHttpContextAccessor _httpContextAccessor;
    protected readonly ILogger _logger;
    protected readonly IOrderService _orderService;
    protected readonly IProductService _productService;
    protected readonly ISettingService _settingService;
    protected readonly IStoreContext _storeContext;
    protected readonly IStoreService _storeService;
    protected readonly IWidgetPluginManager _widgetPluginManager;

    public EventConsumer(
        CurrencySettings currencySettings,
        GoogleAnalyticsHttpClient googleAnalyticsHttpClient,
        ICategoryService categoryService,
        ICurrencyService currencyService,
        IGenericAttributeService genericAttributeService,
        IHttpContextAccessor httpContextAccessor,
        ILogger logger,
        IOrderService orderService,
        IProductService productService,
        ISettingService settingService,
        IStoreContext storeContext,
        IStoreService storeService,
        IWidgetPluginManager widgetPluginManager)
    {
        _currencySettings = currencySettings;
        _googleAnalyticsHttpClient = googleAnalyticsHttpClient;
        _categoryService = categoryService;
        _currencyService = currencyService;
        _genericAttributeService = genericAttributeService;
        _httpContextAccessor = httpContextAccessor;
        _logger = logger;
        _orderService = orderService;
        _productService = productService;
        _settingService = settingService;
        _storeContext = storeContext;
        _storeService = storeService;
        _widgetPluginManager = widgetPluginManager;
    }

    /// A task that represents the asynchronous operation
    protected async Task IsPluginEnabledAsync()
    {
        return await _widgetPluginManager.IsPluginActiveAsync(GoogleAnalyticsDefaults.SystemName);
    }

    protected async Task SaveCookiesAsync(Order order, GoogleAnalyticsSettings googleAnalyticsSettings, Store store)
    {
        //try to get cookie
        var httpContext = _httpContextAccessor.HttpContext;

        //client_id
        httpContext.Request.Cookies.TryGetValue(GoogleAnalyticsDefaults.ClientIdCookiesName, out var clientId);
        await _genericAttributeService.SaveAttributeAsync(order, GoogleAnalyticsDefaults.ClientIdAttribute, clientId, store.Id);

        //session_id
        var measurementId = googleAnalyticsSettings.GoogleId.Split('-')[1];
        var sessionCookieKey = $"{GoogleAnalyticsDefaults.SessionIdCookiesName}{measurementId}";
        httpContext.Request.Cookies.TryGetValue(sessionCookieKey, out var sessionId);
        await _genericAttributeService.SaveAttributeAsync(order, GoogleAnalyticsDefaults.SessionIdAttribute, sessionId, store.Id);
    }

    /// A task that represents the asynchronous operation
    protected async Task ProcessOrderEventAsync(Order order, GoogleAnalyticsSettings googleAnalyticsSettings, string eventName)
    {
        try
        {
            var store = await _storeService.GetStoreByIdAsync(order.StoreId) ?? await _storeContext.GetCurrentStoreAsync();
            var currency = (await _currencyService.GetCurrencyByIdAsync(_currencySettings.PrimaryStoreCurrencyId)).CurrencyCode;
            var orderId = order.CustomOrderNumber;
            var orderShipping = googleAnalyticsSettings.IncludingTax ? order.OrderShippingInclTax : order.OrderShippingExclTax;
            var orderTax = order.OrderTax;
            var orderTotal = order.OrderTotal;

            var gaRequest = new EventRequest
            {
                ClientId = await _genericAttributeService.GetAttributeAsync(order, GoogleAnalyticsDefaults.ClientIdAttribute, store.Id),
                UserId = order.CustomerId.ToString(),
                TimestampMicros = (DateTimeOffset.UtcNow - new DateTimeOffset(1970, 1, 1, 0, 0, 0, TimeSpan.Zero)).Ticks / 10
            };


            var events = new List();
            var gaEvent = new Event
            {
                Name = eventName
            };
            events.Add(gaEvent);

            var gaParams = new Parameters
            {
                Currency = currency,
                TransactionId = orderId,
                EngagementTime = 100,
                SessionId = await _genericAttributeService.GetAttributeAsync(order, GoogleAnalyticsDefaults.SessionIdAttribute, store.Id),
                Value = orderTotal,
                Tax = orderTax,
                Shipping = orderShipping
            };

            var items = new List();
            foreach (var item in await _orderService.GetOrderItemsAsync(order.Id))
            {
                var product = await _productService.GetProductByIdAsync(item.ProductId);
                var sku = await _productService.FormatSkuAsync(product, item.AttributesXml);
                if (string.IsNullOrEmpty(sku))
                    sku = product.Id.ToString();
                //get category
                var category = (await _categoryService.GetCategoryByIdAsync((await _categoryService.GetProductCategoriesByProductIdAsync(product.Id)).FirstOrDefault()?.CategoryId ?? 0))?.Name;
                if (string.IsNullOrEmpty(category))
                    category = "No category";
                var unitPrice = googleAnalyticsSettings.IncludingTax ? item.UnitPriceInclTax : item.UnitPriceExclTax;

                var gaItem = new Item
                {
                    ItemId = sku,
                    ItemName = product.Name,
                    Affiliation = store.Name,
                    ItemCategory = category,
                    Price = unitPrice,
                    Quantity = item.Quantity
                };

                items.Add(gaItem);
            }
            gaParams.Items = items;
            gaEvent.Params = gaParams;
            gaRequest.Events = events;

            await _googleAnalyticsHttpClient.RequestAsync(gaRequest, googleAnalyticsSettings);
        }
        catch (Exception ex)
        {
            await _logger.InsertLogAsync(LogLevel.Error, "Google Analytics. Error canceling transaction from server side", ex.ToString());
        }
    }

    /// 
    /// Handles the event
    /// 
    /// The event message
    /// A task that represents the asynchronous operation
    public async Task HandleEventAsync(OrderRefundedEvent eventMessage)
    {
        //ensure the plugin is installed and active
        if (!await IsPluginEnabledAsync())
            return;

        var order = eventMessage.Order;

        //settings per store
        var store = await _storeService.GetStoreByIdAsync(order.StoreId) ?? await _storeContext.GetCurrentStoreAsync();
        var googleAnalyticsSettings = await _settingService.LoadSettingAsync(store.Id);

        //ecommerce is disabled
        if (!googleAnalyticsSettings.EnableEcommerce)
            return;

        //if we use HTTP requests to notify GA about new orders (only when they are paid), then we should notify GA about deleted AND paid orders
        var sendRequest = order.PaymentStatus == PaymentStatus.Paid;

        if (sendRequest)
            await ProcessOrderEventAsync(order, googleAnalyticsSettings, GoogleAnalyticsDefaults.OrderRefundedEventName);
    }

    /// 
    /// Handles the event
    /// 
    /// The event message
    /// A task that represents the asynchronous operation
    public async Task HandleEventAsync(OrderPaidEvent eventMessage)
    {
        //ensure the plugin is installed and active
        if (!await IsPluginEnabledAsync())
            return;

        var order = eventMessage.Order;

        //settings per store
        var store = await _storeService.GetStoreByIdAsync(order.StoreId) ?? await _storeContext.GetCurrentStoreAsync();
        var googleAnalyticsSettings = await _settingService.LoadSettingAsync(store.Id);

        //ecommerce is disabled
        if (!googleAnalyticsSettings.EnableEcommerce)
            return;

        //we use HTTP requests to notify GA about new orders (only when they are paid)
        await ProcessOrderEventAsync(order, googleAnalyticsSettings, GoogleAnalyticsDefaults.OrderPaidEventName);
    }

    /// 
    /// Handles the event
    /// 
    /// The event message
    /// A task that represents the asynchronous operation
    public async Task HandleEventAsync(OrderPlacedEvent eventMessage)
    {
        //ensure the plugin is installed and active
        if (!await IsPluginEnabledAsync())
            return;

        var order = eventMessage.Order;

        //settings per store
        var store = await _storeService.GetStoreByIdAsync(order.StoreId) ?? await _storeContext.GetCurrentStoreAsync();
        var googleAnalyticsSettings = await _settingService.LoadSettingAsync(store.Id);

        //ecommerce is disabled
        if (!googleAnalyticsSettings.EnableEcommerce)
            return;

        await SaveCookiesAsync(order, googleAnalyticsSettings, store);
    }
}