Try your search with a different keyword or use * as a wildcard.
using Microsoft.AspNetCore.Http;
using Nop.Core;
using Nop.Core.Domain.Gdpr;
using Nop.Core.Domain.Shipping;
using Nop.Core.Http.Extensions;
using Nop.Services.Common;
using Nop.Services.Events;
using Nop.Services.Localization;
using Nop.Services.Plugins;
using Nop.Services.Security;
using Nop.Services.Shipping;
using Nop.Web.Areas.Admin.Models.Common;
using Nop.Web.Areas.Admin.Models.Orders;
using Nop.Web.Areas.Admin.Models.Payments;
using Nop.Web.Framework.Events;
using Nop.Web.Framework.Menu;
using Nop.Web.Framework.Models;
using Nop.Web.Models.Customer;
namespace Nop.Plugin.Payments.PayPalCommerce.Services;
///
/// Represents the plugin event consumer
///
public class EventConsumer :
BaseAdminMenuCreatedEventConsumer,
IConsumer,
IConsumer>,
IConsumer>,
IConsumer,
IConsumer,
IConsumer
{
#region Fields
private readonly IAdminMenu _adminMenu;
private readonly IGenericAttributeService _genericAttributeService;
private readonly IHttpContextAccessor _httpContextAccessor;
private readonly ILocalizationService _localizationService;
private readonly IShipmentService _shipmentService;
private readonly PayPalCommerceServiceManager _serviceManager;
private readonly PayPalCommerceSettings _settings;
private readonly IPermissionService _permissionService;
private readonly IWorkContext _workContext;
#endregion
#region Ctor
public EventConsumer(IAdminMenu adminMenu,
IGenericAttributeService genericAttributeService,
IHttpContextAccessor httpContextAccessor,
ILocalizationService localizationService,
IShipmentService shipmentService,
PayPalCommerceServiceManager serviceManager,
PayPalCommerceSettings settings,
IPermissionService permissionService,
IPluginManager pluginManager,
IWorkContext workContext) : base(pluginManager)
{
_adminMenu = adminMenu;
_genericAttributeService = genericAttributeService;
_httpContextAccessor = httpContextAccessor;
_localizationService = localizationService;
_shipmentService = shipmentService;
_serviceManager = serviceManager;
_settings = settings;
_permissionService = permissionService;
_workContext = workContext;
}
#endregion
#region Utilities
///
/// Checks is the current customer has rights to access this menu item
///
///
/// A task that represents the asynchronous operation
/// The task result contains the true if access is granted, otherwise false
///
protected override async Task CheckAccessAsync()
{
return await _permissionService.AuthorizeAsync(StandardPermission.Configuration.MANAGE_PAYMENT_METHODS);
}
///
/// Gets the menu item
///
/// The instance of
/// A task that represents the asynchronous operation
/// The task result contains the instance of
protected override async Task GetAdminMenuItemAsync(IPlugin plugin)
{
var descriptor = plugin.PluginDescriptor;
return new AdminMenuItem
{
Visible = true,
SystemName = descriptor.SystemName,
Title = await _localizationService.GetLocalizedFriendlyNameAsync(plugin, (await _workContext.GetWorkingLanguageAsync()).Id),
IconClass = "far fa-dot-circle",
ChildNodes = new List
{
new()
{
Visible = true,
SystemName = $"{PayPalCommerceDefaults.SystemName} Configuration",
Title = await _localizationService.GetResourceAsync("Plugins.Payments.PayPalCommerce.Configuration"),
Url = plugin.GetConfigurationPageUrl(),
IconClass = "far fa-circle"
},
new()
{
Visible = _settings.UseSandbox || _settings.ConfiguratorSupported,
SystemName = $"{PayPalCommerceDefaults.SystemName} Pay Later",
Title = await _localizationService.GetResourceAsync("Plugins.Payments.PayPalCommerce.PayLater"),
Url = _adminMenu.GetMenuItemUrl("PayPalCommerce", "PayLater"),
IconClass = "far fa-circle"
}
}
};
}
#endregion
#region Methods
///
/// Handle customer permanently deleted event
///
/// Event message
/// A task that represents the asynchronous operation
public async Task HandleEventAsync(CustomerPermanentlyDeleted eventMessage)
{
//delete customer's payment tokens
await _serviceManager.DeletePaymentTokensAsync(_settings, eventMessage.CustomerId);
}
///
/// Handle model prepared event
///
/// Event message
/// A task that represents the asynchronous operation
public async Task HandleEventAsync(ModelPreparedEvent eventMessage)
{
//exclude the plugin from payment providers list, we'll display it another way
if (eventMessage.Model is PaymentMethodListModel paymentMethodsModel)
paymentMethodsModel.Data = paymentMethodsModel.Data.Where(method => !string.Equals(method.SystemName, PayPalCommerceDefaults.SystemName));
if (eventMessage.Model is not CustomerNavigationModel navigationModel)
return;
var (active, _) = await _serviceManager.IsActiveAsync(_settings);
if (!active)
return;
var (tokens, _) = await _serviceManager.GetPaymentTokensAsync(_settings);
if (!_settings.UseVault && !tokens.Any())
return;
//add a new menu item in the customer navigation
var orderItem = navigationModel.CustomerNavigationItems.FirstOrDefault(item => item.Tab == (int)CustomerNavigationEnum.Orders);
var position = navigationModel.CustomerNavigationItems.IndexOf(orderItem) + 1;
navigationModel.CustomerNavigationItems.Insert(position, new()
{
RouteName = PayPalCommerceDefaults.Route.PaymentTokens,
ItemClass = "paypal-payment-tokens",
Tab = PayPalCommerceDefaults.PaymentTokensMenuTab,
Title = await _localizationService.GetResourceAsync("Plugins.Payments.PayPalCommerce.PaymentTokens")
});
}
///
/// Handle model received event
///
/// Event message
/// A task that represents the asynchronous operation
public async Task HandleEventAsync(ModelReceivedEvent eventMessage)
{
if (eventMessage.Model is not ShipmentModel shipmentModel)
return;
if (!PayPalCommerceServiceManager.IsConnected(_settings))
return;
if (!_settings.UseShipmentTracking)
return;
//save specified shipment carrier
var (exists, carrier) = await _httpContextAccessor.HttpContext.Request.TryGetFormValueAsync(PayPalCommerceDefaults.ShipmentCarrierAttribute);
if (exists)
{
var shipment = await _shipmentService.GetShipmentByIdAsync(shipmentModel.Id);
if (shipment is not null)
await _genericAttributeService.SaveAttributeAsync(shipment, PayPalCommerceDefaults.ShipmentCarrierAttribute, carrier);
else if (!string.IsNullOrEmpty(carrier))
{
//when we add a new shipping, it's not in the db yet and we cannot save a generic attribute to it,
//so we temporarily store the data in the context, we'll move it to the attribute later during the same request
_httpContextAccessor.HttpContext.Items.TryAdd(PayPalCommerceDefaults.ShipmentCarrierAttribute, carrier);
}
}
}
///
/// Handle shipment created event
///
/// Event message
/// A task that represents the asynchronous operation
public async Task HandleEventAsync(ShipmentCreatedEvent eventMessage)
{
if (!PayPalCommerceServiceManager.IsConnected(_settings))
return;
if (!_settings.UseShipmentTracking || eventMessage.Shipment is null)
return;
//move the saved data from context to the generic attribute
if (_httpContextAccessor.HttpContext.Items.TryGetValue(PayPalCommerceDefaults.ShipmentCarrierAttribute, out var carrier))
{
await _genericAttributeService
.SaveAttributeAsync(eventMessage.Shipment, PayPalCommerceDefaults.ShipmentCarrierAttribute, carrier.ToString());
}
}
///
/// Handle shipment tracking number set event
///
/// Event message
/// A task that represents the asynchronous operation
public async Task HandleEventAsync(ShipmentTrackingNumberSetEvent eventMessage)
{
if (!PayPalCommerceServiceManager.IsConnected(_settings))
return;
if (!_settings.UseShipmentTracking)
return;
await _serviceManager.SetTrackingAsync(_settings, eventMessage.Shipment);
}
///
/// Handle system warning created event
///
/// Event message
/// A task that represents the asynchronous operation
public Task HandleEventAsync(SystemWarningCreatedEvent eventMessage)
{
if (!PayPalCommerceServiceManager.IsConnected(_settings))
return Task.CompletedTask;
if (!_settings.MerchantIdRequired)
return Task.CompletedTask;
//the plugin was updated, but no merchant ID was specified
var warning = _settings.SetCredentialsManually
? "PayPal Commerce plugin. Merchant ID is required for payments, please specify it on the plugin configuration page"
: "PayPal Commerce plugin. PayPal account ID of the merchant was not set correctly when updating the plugin. " +
"You should either complete onboarding process again on the plugin configuration page or " +
"set the ID yourself on the All Settings page (you can find this ID in your PayPal account)";
eventMessage.SystemWarnings.Add(new() { Level = SystemWarningLevel.Warning, DontEncode = false, Text = warning });
return Task.CompletedTask;
}
#endregion
#region Properties
///
/// Gets the plugin system name
///
protected override string PluginSystemName => PayPalCommerceDefaults.SystemName;
///
/// Menu item insertion type
///
protected override MenuItemInsertType InsertType => MenuItemInsertType.TryAfterThanBefore;
///
/// The system name of the menu item after with need to insert the current one
///
protected override string AfterMenuSystemName => "Misc.Zettle";
///
/// The system name of the menu item before with need to insert the current one
///
protected override string BeforeMenuSystemName => "Local plugins";
#endregion
}