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.

Let store owners configure payment plugins per store (#840)

Krzysztof Pajak29f3a81f7186
diff --git a/src/Plugins/Payments.BrainTree/Areas/Admin/Controllers/PaymentBrainTreeController.cs b/src/Plugins/Payments.BrainTree/Areas/Admin/Controllers/PaymentBrainTreeController.cs
index 5fa806997..1dbb67f8c 100644
--- a/src/Plugins/Payments.BrainTree/Areas/Admin/Controllers/PaymentBrainTreeController.cs
+++ b/src/Plugins/Payments.BrainTree/Areas/Admin/Controllers/PaymentBrainTreeController.cs
@@ -3,6 +3,7 @@ using Grand.Business.Core.Interfaces.Common.Localization;
using Grand.Domain.Permissions;
using Grand.Web.Common.Controllers;
using Grand.Web.Common.Filters;
+using Grand.Web.Common.Helpers;
using Grand.Web.Common.Security.Authorization;
using Microsoft.AspNetCore.Mvc;
using Payments.BrainTree.Models;
@@ -18,11 +19,11 @@ public class PaymentBrainTreeController : BasePaymentController
public PaymentBrainTreeController(ISettingService settingService,
ITranslationService translationService,
- BrainTreePaymentSettings brainTreePaymentSettings)
+ IAdminStoreService adminStoreService)
{
_settingService = settingService;
_translationService = translationService;
- _brainTreePaymentSettings = brainTreePaymentSettings;
+ _adminStoreService = adminStoreService;
}
#endregion
@@ -31,23 +32,28 @@ public class PaymentBrainTreeController : BasePaymentController
private readonly ISettingService _settingService;
private readonly ITranslationService _translationService;
- private readonly BrainTreePaymentSettings _brainTreePaymentSettings;
+ private readonly IAdminStoreService _adminStoreService;
#endregion
#region Methods
- public IActionResult Configure()
+ public async Task<IActionResult> Configure()
{
+ //load settings for a chosen store scope - the injected settings instance would always be the
+ //one of the store hosting the admin panel, which ignores the scope the admin selected
+ var storeScope = await _adminStoreService.GetActiveStore();
+ var brainTreePaymentSettings = await _settingService.LoadSetting<BrainTreePaymentSettings>(storeScope);
+
var model = new ConfigurationModel {
- Use3DS = _brainTreePaymentSettings.Use3DS,
- UseSandBox = _brainTreePaymentSettings.UseSandBox,
- PublicKey = _brainTreePaymentSettings.PublicKey,
- PrivateKey = _brainTreePaymentSettings.PrivateKey,
- MerchantId = _brainTreePaymentSettings.MerchantId,
- AdditionalFee = _brainTreePaymentSettings.AdditionalFee,
- AdditionalFeePercentage = _brainTreePaymentSettings.AdditionalFeePercentage,
- DisplayOrder = _brainTreePaymentSettings.DisplayOrder
+ Use3DS = brainTreePaymentSettings.Use3DS,
+ UseSandBox = brainTreePaymentSettings.UseSandBox,
+ PublicKey = brainTreePaymentSettings.PublicKey,
+ PrivateKey = brainTreePaymentSettings.PrivateKey,
+ MerchantId = brainTreePaymentSettings.MerchantId,
+ AdditionalFee = brainTreePaymentSettings.AdditionalFee,
+ AdditionalFeePercentage = brainTreePaymentSettings.AdditionalFeePercentage,
+ DisplayOrder = brainTreePaymentSettings.DisplayOrder
};
return View(model);
@@ -58,23 +64,30 @@ public class PaymentBrainTreeController : BasePaymentController
public async Task<IActionResult> Configure(ConfigurationModel model)
{
if (!ModelState.IsValid)
- return Configure();
+ return await Configure();
+
+ //load settings for a chosen store scope
+ var storeScope = await _adminStoreService.GetActiveStore();
+ var brainTreePaymentSettings = await _settingService.LoadSetting<BrainTreePaymentSettings>(storeScope);
//save settings
- _brainTreePaymentSettings.Use3DS = model.Use3DS;
- _brainTreePaymentSettings.UseSandBox = model.UseSandBox;
- _brainTreePaymentSettings.PublicKey = model.PublicKey;
- _brainTreePaymentSettings.PrivateKey = model.PrivateKey;
- _brainTreePaymentSettings.MerchantId = model.MerchantId;
- _brainTreePaymentSettings.AdditionalFee = model.AdditionalFee;
- _brainTreePaymentSettings.AdditionalFeePercentage = model.AdditionalFeePercentage;
- _brainTreePaymentSettings.DisplayOrder = model.DisplayOrder;
+ brainTreePaymentSettings.Use3DS = model.Use3DS;
+ brainTreePaymentSettings.UseSandBox = model.UseSandBox;
+ brainTreePaymentSettings.PublicKey = model.PublicKey;
+ brainTreePaymentSettings.PrivateKey = model.PrivateKey;
+ brainTreePaymentSettings.MerchantId = model.MerchantId;
+ brainTreePaymentSettings.AdditionalFee = model.AdditionalFee;
+ brainTreePaymentSettings.AdditionalFeePercentage = model.AdditionalFeePercentage;
+ brainTreePaymentSettings.DisplayOrder = model.DisplayOrder;
+
+ await _settingService.SaveSetting(brainTreePaymentSettings, storeScope);
- await _settingService.SaveSetting(_brainTreePaymentSettings);
+ //now clear settings cache
+ await _settingService.ClearCache();
Success(_translationService.GetResource("Admin.Plugins.Saved"));
- return Configure();
+ return await Configure();
}
#endregion
diff --git a/src/Plugins/Payments.BrainTree/Areas/Admin/Views/PaymentBrainTree/Configure.cshtml b/src/Plugins/Payments.BrainTree/Areas/Admin/Views/PaymentBrainTree/Configure.cshtml
index e760990fc..0f10ac2ec 100644
--- a/src/Plugins/Payments.BrainTree/Areas/Admin/Views/PaymentBrainTree/Configure.cshtml
+++ b/src/Plugins/Payments.BrainTree/Areas/Admin/Views/PaymentBrainTree/Configure.cshtml
@@ -2,6 +2,7 @@
Layout = "_ConfigurePlugin";
}
@model Payments.BrainTree.Models.ConfigurationModel
+@await Component.InvokeAsync("StoreScope")
<input id="active-menu-item" type="hidden" value="/Admin/Payment/Methods"/>
<form asp-controller="PaymentBrainTree" asp-action="Configure" method="post">
diff --git a/src/Plugins/Payments.BrainTree/Areas/Store/Controllers/PaymentBrainTreeController.cs b/src/Plugins/Payments.BrainTree/Areas/Store/Controllers/PaymentBrainTreeController.cs
new file mode 100644
index 000000000..e9d818e9c
--- /dev/null
+++ b/src/Plugins/Payments.BrainTree/Areas/Store/Controllers/PaymentBrainTreeController.cs
@@ -0,0 +1,107 @@
+using Grand.Business.Core.Interfaces.Common.Configuration;
+using Grand.Business.Core.Interfaces.Common.Localization;
+using Grand.Domain.Permissions;
+using Grand.Infrastructure;
+using Grand.Web.Common.Controllers;
+using Grand.Web.Common.Filters;
+using Grand.Web.Common.Security.Authorization;
+using Microsoft.AspNetCore.Mvc;
+using Payments.BrainTree.Models;
+
+namespace Payments.BrainTree.Areas.Store.Controllers;
+
+/// <summary>
+/// Store-manager configuration of the BrainTree payment method.
+/// <para>
+/// The settings - the gateway credentials included - are read and written for the store the
+/// manager is bound to (<see cref="CurrentStoreId" />), so each store transacts on its own
+/// BrainTree account. The provider builds a <c>BraintreeGateway</c> per call from the settings
+/// instance the container resolved for the current store, so no further change is needed for
+/// the payment itself to use them. Note that the first save creates a store row covering the
+/// whole settings class, after which this store stops inheriting later global changes to it.
+/// </para>
+/// </summary>
+[Area("Store")]
+[AuthorizeStore]
+[AuthorizeMenu]
+[PermissionAuthorize(PermissionSystemName.PaymentMethods)]
+public class PaymentBrainTreeController : BasePaymentController
+{
+ #region Ctor
+
+ public PaymentBrainTreeController(ISettingService settingService,
+ ITranslationService translationService,
+ IContextAccessor contextAccessor)
+ {
+ _settingService = settingService;
+ _translationService = translationService;
+ _contextAccessor = contextAccessor;
+ }
+
+ #endregion
+
+ #region Fields
+
+ private readonly ISettingService _settingService;
+ private readonly ITranslationService _translationService;
+ private readonly IContextAccessor _contextAccessor;
+
+ /// <summary>
+ /// The store the current store manager is bound to. AuthorizeStore already rejects a
+ /// customer without one, so this is never empty here.
+ /// </summary>
+ private string CurrentStoreId => _contextAccessor.WorkContext.CurrentCustomer.StaffStoreId;
+
+ #endregion
+
+ #region Methods
+
+ public async Task<IActionResult> Configure()
+ {
+ var brainTreePaymentSettings = await _settingService.LoadSetting<BrainTreePaymentSettings>(CurrentStoreId);
+
+ var model = new ConfigurationModel {
+ Use3DS = brainTreePaymentSettings.Use3DS,
+ UseSandBox = brainTreePaymentSettings.UseSandBox,
+ PublicKey = brainTreePaymentSettings.PublicKey,
+ PrivateKey = brainTreePaymentSettings.PrivateKey,
+ MerchantId = brainTreePaymentSettings.MerchantId,
+ AdditionalFee = brainTreePaymentSettings.AdditionalFee,
+ AdditionalFeePercentage = brainTreePaymentSettings.AdditionalFeePercentage,
+ DisplayOrder = brainTreePaymentSettings.DisplayOrder
+ };
+
+ return View(model);
+ }
+
+ [HttpPost]
+ [AutoValidateAntiforgeryToken]
+ public async Task<IActionResult> Configure(ConfigurationModel model)
+ {
+ if (!ModelState.IsValid)
+ return await Configure();
+
+ var brainTreePaymentSettings = await _settingService.LoadSetting<BrainTreePaymentSettings>(CurrentStoreId);
+
+ //save settings
+ brainTreePaymentSettings.Use3DS = model.Use3DS;
+ brainTreePaymentSettings.UseSandBox = model.UseSandBox;
+ brainTreePaymentSettings.PublicKey = model.PublicKey;
+ brainTreePaymentSettings.PrivateKey = model.PrivateKey;
+ brainTreePaymentSettings.MerchantId = model.MerchantId;
+ brainTreePaymentSettings.AdditionalFee = model.AdditionalFee;
+ brainTreePaymentSettings.AdditionalFeePercentage = model.AdditionalFeePercentage;
+ brainTreePaymentSettings.DisplayOrder = model.DisplayOrder;
+
+ await _settingService.SaveSetting(brainTreePaymentSettings, CurrentStoreId);
+
+ //now clear settings cache
+ await _settingService.ClearCache();
+
+ Success(_translationService.GetResource("Admin.Plugins.Saved"));
+
+ return await Configure();
+ }
+
+ #endregion
+}
diff --git a/src/Plugins/Payments.BrainTree/Areas/Store/Views/PaymentBrainTree/Configure.cshtml b/src/Plugins/Payments.BrainTree/Areas/Store/Views/PaymentBrainTree/Configure.cshtml
new file mode 100644
index 000000000..de225fd1a
--- /dev/null
+++ b/src/Plugins/Payments.BrainTree/Areas/Store/Views/PaymentBrainTree/Configure.cshtml
@@ -0,0 +1,106 @@
+@model Payments.BrainTree.Models.ConfigurationModel
+@{
+ Layout = "~/Areas/Store/Views/Shared/_StoreLayout.cshtml";
+ ViewBag.Title = Loc["Admin.Configuration.Payment.Methods"];
+}
+<input id="active-menu-item" type="hidden" value="/Store/Payment/Index"/>
+
+<div class="row">
+ <div class="col-md-12">
+ <div class="x_panel light form-fit">
+ <div class="x_title">
+ <div class="caption level-caption">
+ <i class="fa fa-money"></i>
+ @Loc["Payments.BrainTree.FriendlyName"]
+ </div>
+ </div>
+ <div class="x_content form">
+ <form asp-controller="PaymentBrainTree" asp-action="Configure" asp-area="Store" method="post">
+ <div class="form-horizontal">
+ <div class="form-body">
+ <div class="form-group">
+ <div class="col-md-3 col-sm-3 text-right">
+ <admin-label asp-for="Use3DS" class="control-label"/>
+ </div>
+ <div class="col-md-9 col-sm-9">
+ <admin-input asp-for="Use3DS"/>
+ <span asp-validation-for="Use3DS"></span>
+ </div>
+ </div>
+ <div class="form-group">
+ <div class="col-md-3 col-sm-3 text-right">
+ <admin-label asp-for="UseSandBox" class="control-label"/>
+ </div>
+ <div class="col-md-9 col-sm-9">
+ <admin-input asp-for="UseSandBox"/>
+ <span asp-validation-for="UseSandBox"></span>
+ </div>
+ </div>
+ <div class="form-group">
+ <div class="col-md-3 col-sm-3 text-right">
+ <admin-label asp-for="MerchantId" class="control-label"/>
+ </div>
+ <div class="col-md-9 col-sm-9">
+ <admin-input asp-for="MerchantId"/>
+ <span asp-validation-for="MerchantId"></span>
+ </div>
+ </div>
+ <div class="form-group">
+ <div class="col-md-3 col-sm-3 text-right">
+ <admin-label asp-for="PrivateKey" class="control-label"/>
+ </div>
+ <div class="col-md-9 col-sm-9">
+ <admin-input asp-for="PrivateKey"/>
+ <span asp-validation-for="PrivateKey"></span>
+ </div>
+ </div>
+ <div class="form-group">
+ <div class="col-md-3 col-sm-3 text-right">
+ <admin-label asp-for="PublicKey" class="control-label"/>
+ </div>
+ <div class="col-md-9 col-sm-9">
+ <admin-input asp-for="PublicKey"/>
+ <span asp-validation-for="PublicKey"></span>
+ </div>
+ </div>
+ <div class="form-group">
+ <div class="col-md-3 col-sm-3 text-right">
+ <admin-label asp-for="AdditionalFee" class="control-label"/>
+ </div>
+ <div class="col-md-9 col-sm-9">
+ <admin-input asp-for="AdditionalFee"/>
+ <span asp-validation-for="AdditionalFee"></span>
+ </div>
+ </div>
+ <div class="form-group">
+ <div class="col-md-3 col-sm-3 text-right">
+ <admin-label asp-for="AdditionalFeePercentage" class="control-label"/>
+ </div>
+ <div class="col-md-9 col-sm-9">
+ <admin-input asp-for="AdditionalFeePercentage"/>
+ <span asp-validation-for="AdditionalFeePercentage"></span>
+ </div>
+ </div>
+ <div class="form-group">
+ <div class="col-md-3 col-sm-3 text-right">
+ <admin-label asp-for="DisplayOrder" class="control-label"/>
+ </div>
+ <div class="col-md-9 col-sm-9">
+ <admin-input asp-for="DisplayOrder"/>
+ <span asp-validation-for="DisplayOrder"></span>
+ </div>
+ </div>
+ </div>
+ <div class="form-actions">
+ <div class="row">
+ <div class="offset-md-3 offset-sm-3 col-md-9 col-sm-9">
+ <input type="submit" name="save" class="btn green" value="@Loc["Admin.Common.Save"]"/>
+ </div>
+ </div>
+ </div>
+ </div>
+ </form>
+ </div>
+ </div>
+ </div>
+</div>
diff --git a/src/Plugins/Payments.BrainTree/Areas/Store/Views/_ViewImports.cshtml b/src/Plugins/Payments.BrainTree/Areas/Store/Views/_ViewImports.cshtml
new file mode 100644
index 000000000..0d1778c76
--- /dev/null
+++ b/src/Plugins/Payments.BrainTree/Areas/Store/Views/_ViewImports.cshtml
@@ -0,0 +1,8 @@
+@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
+@addTagHelper *, Grand.Web.Common
+
+@using Microsoft.AspNetCore.Mvc.ViewFeatures
+@using Grand.Infrastructure.Extensions
+@using Grand.Web.Common.Localization
+
+@inject LocService Loc
diff --git a/src/Plugins/Payments.CashOnDelivery/Areas/Store/Controllers/PaymentCashOnDeliveryController.cs b/src/Plugins/Payments.CashOnDelivery/Areas/Store/Controllers/PaymentCashOnDeliveryController.cs
new file mode 100644
index 000000000..2f637361b
--- /dev/null
+++ b/src/Plugins/Payments.CashOnDelivery/Areas/Store/Controllers/PaymentCashOnDeliveryController.cs
@@ -0,0 +1,94 @@
+using Grand.Business.Core.Interfaces.Common.Configuration;
+using Grand.Business.Core.Interfaces.Common.Localization;
+using Grand.Domain.Permissions;
+using Grand.Infrastructure;
+using Grand.Web.Common.Controllers;
+using Grand.Web.Common.Filters;
+using Grand.Web.Common.Security.Authorization;
+using Microsoft.AspNetCore.Mvc;
+using Payments.CashOnDelivery.Models;
+
+namespace Payments.CashOnDelivery.Areas.Store.Controllers;
+
+/// <summary>
+/// Store-manager configuration of the cash on delivery payment method.
+/// <para>
+/// The settings are read and written for the store the manager is bound to
+/// (<see cref="CurrentStoreId" />), never globally - the storefront already resolves every
+/// <c>ISettings</c> class for the current store, so a per-store row takes effect on checkout
+/// of that store only. Note that the very first save creates a store row covering the whole
+/// settings class, after which this store stops inheriting later global changes to it.
+/// </para>
+/// </summary>
+[Area("Store")]
+[AuthorizeStore]
+[AuthorizeMenu]
+[PermissionAuthorize(PermissionSystemName.PaymentMethods)]
+public class PaymentCashOnDeliveryController : BasePaymentController
+{
+ private readonly IContextAccessor _contextAccessor;
+ private readonly ISettingService _settingService;
+ private readonly ITranslationService _translationService;
+
+ public PaymentCashOnDeliveryController(
+ ISettingService settingService,
+ ITranslationService translationService,
+ IContextAccessor contextAccessor)
+ {
+ _settingService = settingService;
+ _translationService = translationService;
+ _contextAccessor = contextAccessor;
+ }
+
+ /// <summary>
+ /// The store the current store manager is bound to. AuthorizeStore already rejects a
+ /// customer without one, so this is never empty here.
+ /// </summary>
+ private string CurrentStoreId => _contextAccessor.WorkContext.CurrentCustomer.StaffStoreId;
+
+ public async Task<IActionResult> Configure()
+ {
+ var cashOnDeliveryPaymentSettings =
+ await _settingService.LoadSetting<CashOnDeliveryPaymentSettings>(CurrentStoreId);
+
+ var model = new ConfigurationModel {
+ DescriptionText = cashOnDeliveryPaymentSettings.DescriptionText,
+ AdditionalFee = cashOnDeliveryPaymentSettings.AdditionalFee,
+ AdditionalFeePercentage = cashOnDeliveryPaymentSettings.AdditionalFeePercentage,
+ ShippableProductRequired = cashOnDeliveryPaymentSettings.ShippableProductRequired,
+ DisplayOrder = cashOnDeliveryPaymentSettings.DisplayOrder,
+ SkipPaymentInfo = cashOnDeliveryPaymentSettings.SkipPaymentInfo,
+ //the store manager can only configure his own store, so no store selector is offered
+ ActiveStore = CurrentStoreId
+ };
+
+ return View(model);
+ }
+
+ [HttpPost]
+ [AutoValidateAntiforgeryToken]
+ public async Task<IActionResult> Configure(ConfigurationModel model)
+ {
+ if (!ModelState.IsValid)
+ return await Configure();
+
+ var cashOnDeliveryPaymentSettings =
+ await _settingService.LoadSetting<CashOnDeliveryPaymentSettings>(CurrentStoreId);
+
+ cashOnDeliveryPaymentSettings.DescriptionText = model.DescriptionText;
+ cashOnDeliveryPaymentSettings.AdditionalFee = model.AdditionalFee;
+ cashOnDeliveryPaymentSettings.AdditionalFeePercentage = model.AdditionalFeePercentage;
+ cashOnDeliveryPaymentSettings.ShippableProductRequired = model.ShippableProductRequired;
+ cashOnDeliveryPaymentSettings.DisplayOrder = model.DisplayOrder;
+ cashOnDeliveryPaymentSettings.SkipPaymentInfo = model.SkipPaymentInfo;
+
+ await _settingService.SaveSetting(cashOnDeliveryPaymentSettings, CurrentStoreId);
+
+ //now clear settings cache
+ await _settingService.ClearCache();
+
+ Success(_translationService.GetResource("Admin.Plugins.Saved"));
+
+ return await Configure();
+ }
+}
diff --git a/src/Plugins/Payments.CashOnDelivery/Areas/Store/Views/PaymentCashOnDelivery/Configure.cshtml b/src/Plugins/Payments.CashOnDelivery/Areas/Store/Views/PaymentCashOnDelivery/Configure.cshtml
new file mode 100644
index 000000000..bf85e3e7a
--- /dev/null
+++ b/src/Plugins/Payments.CashOnDelivery/Areas/Store/Views/PaymentCashOnDelivery/Configure.cshtml
@@ -0,0 +1,97 @@
+@model Payments.CashOnDelivery.Models.ConfigurationModel
+@{
+ Layout = "~/Areas/Store/Views/Shared/_StoreLayout.cshtml";
+ ViewBag.Title = Loc["Admin.Configuration.Payment.Methods"];
+}
+<input id="active-menu-item" type="hidden" value="/Store/Payment/Index"/>
+
+<div class="row">
+ <div class="col-md-12">
+ <div class="x_panel light form-fit">
+ <div class="x_title">
+ <div class="caption level-caption">
+ <i class="fa fa-money"></i>
+ @Loc["Payments.CashOnDelivery.FriendlyName"]
+ </div>
+ </div>
+ <div class="x_content form">
+ <form asp-controller="PaymentCashOnDelivery" asp-action="Configure" asp-area="Store" method="post">
+ <div class="form-horizontal">
+ <div class="form-body">
+ <div class="form-group">
+ <div class="col-md-3 col-sm-3 text-right">
+ <admin-label asp-for="DescriptionText" class="control-label"/>
+ </div>
+ <div class="col-md-9 col-sm-9">
+ <admin-textarea asp-for="DescriptionText"></admin-textarea>
+ <span asp-validation-for="DescriptionText"></span>
+ </div>
+ </div>
+ <div class="form-group">
+ <div class="col-md-3 col-sm-3 text-right">
+ <admin-label asp-for="AdditionalFee" class="control-label"/>
+ </div>
+ <div class="col-md-9 col-sm-9">
+ <admin-input asp-for="AdditionalFee"/>
+ <span asp-validation-for="AdditionalFee"></span>
+ </div>
+ </div>
+ <div class="form-group">
+ <div class="col-md-3 col-sm-3 text-right">
+ <admin-label asp-for="AdditionalFeePercentage" class="control-label"/>
+ </div>
+ <div class="col-md-9 col-sm-9">
+ <label class="mt-checkbox mt-checkbox-outline control control-checkbox">
+ <admin-input asp-for="AdditionalFeePercentage"/>
+ <div class="control__indicator"></div>
+ </label>
+ <span asp-validation-for="AdditionalFeePercentage"></span>
+ </div>
+ </div>
+ <div class="form-group">
+ <div class="col-md-3 col-sm-3 text-right">
+ <admin-label asp-for="ShippableProductRequired" class="control-label"/>
+ </div>
+ <div class="col-md-9 col-sm-9">
+ <label class="mt-checkbox mt-checkbox-outline control control-checkbox">
+ <admin-input asp-for="ShippableProductRequired"/>
+ <div class="control__indicator"></div>
+ </label>
+ <span asp-validation-for="ShippableProductRequired"></span>
+ </div>
+ </div>
+ <div class="form-group">
+ <div class="col-md-3 col-sm-3 text-right">
+ <admin-label asp-for="SkipPaymentInfo" class="control-label"/>
+ </div>
+ <div class="col-md-9 col-sm-9">
+ <label class="mt-checkbox mt-checkbox-outline control control-checkbox">
+ <admin-input asp-for="SkipPaymentInfo"/>
+ <div class="control__indicator"></div>
+ </label>
+ <span asp-validation-for="SkipPaymentInfo"></span>
+ </div>
+ </div>
+ <div class="form-group">
+ <div class="col-md-3 col-sm-3 text-right">
+ <admin-label asp-for="DisplayOrder" class="control-label"/>
+ </div>
+ <div class="col-md-9 col-sm-9">
+ <admin-input asp-for="DisplayOrder"/>
+ <span asp-validation-for="DisplayOrder"></span>
+ </div>
+ </div>
+ </div>
+ <div class="form-actions">
+ <div class="row">
+ <div class="offset-md-3 offset-sm-3 col-md-9 col-sm-9">
+ <input type="submit" name="save" class="btn green" value="@Loc["Admin.Common.Save"]"/>
+ </div>
+ </div>
+ </div>
+ </div>
+ </form>
+ </div>
+ </div>
+ </div>
+</div>
diff --git a/src/Plugins/Payments.CashOnDelivery/Areas/Store/Views/_ViewImports.cshtml b/src/Plugins/Payments.CashOnDelivery/Areas/Store/Views/_ViewImports.cshtml
new file mode 100644
index 000000000..0d1778c76
--- /dev/null
+++ b/src/Plugins/Payments.CashOnDelivery/Areas/Store/Views/_ViewImports.cshtml
@@ -0,0 +1,8 @@
+@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
+@addTagHelper *, Grand.Web.Common
+
+@using Microsoft.AspNetCore.Mvc.ViewFeatures
+@using Grand.Infrastructure.Extensions
+@using Grand.Web.Common.Localization
+
+@inject LocService Loc
diff --git a/src/Plugins/Payments.StripeCheckout/Areas/Store/Controllers/StripeCheckoutController.cs b/src/Plugins/Payments.StripeCheckout/Areas/Store/Controllers/StripeCheckoutController.cs
new file mode 100644
index 000000000..5844e9f12
--- /dev/null
+++ b/src/Plugins/Payments.StripeCheckout/Areas/Store/Controllers/StripeCheckoutController.cs
@@ -0,0 +1,102 @@
+using Grand.Business.Core.Interfaces.Common.Configuration;
+using Grand.Business.Core.Interfaces.Common.Localization;
+using Grand.Business.Core.Interfaces.Common.Stores;
+using Grand.Domain.Permissions;
+using Grand.Infrastructure;
+using Grand.Web.Common.Controllers;
+using Grand.Web.Common.Filters;
+using Grand.Web.Common.Security.Authorization;
+using Microsoft.AspNetCore.Mvc;
+using Payments.StripeCheckout.Models;
+
+namespace Payments.StripeCheckout.Areas.Store.Controllers;
+
+/// <summary>
+/// Store-manager configuration of the Stripe Checkout payment method.
+/// <para>
+/// The settings - the API key and the webhook secret included - are read and written for the
+/// store the manager is bound to (<see cref="CurrentStoreId" />), so each store transacts on
+/// its own Stripe account. Every Stripe call is made through a client built from the settings
+/// instance the container resolved for the current store. Note that the first save creates a
+/// store row covering the whole settings class, after which this store stops inheriting later
+/// global changes to it.
+/// </para>
+/// </summary>
+[Area("Store")]
+[AuthorizeStore]
+[AuthorizeMenu]
+[PermissionAuthorize(PermissionSystemName.PaymentMethods)]
+public class StripeCheckoutController : BasePaymentController
+{
+ private readonly IContextAccessor _contextAccessor;
+ private readonly ISettingService _settingService;
+ private readonly IStoreService _storeService;
+ private readonly ITranslationService _translationService;
+
+ public StripeCheckoutController(
+ ISettingService settingService,
+ ITranslationService translationService,
+ IStoreService storeService,
+ IContextAccessor contextAccessor)
+ {
+ _settingService = settingService;
+ _translationService = translationService;
+ _storeService = storeService;
+ _contextAccessor = contextAccessor;
+ }
+
+ /// <summary>
+ /// The store the current store manager is bound to. AuthorizeStore already rejects a
+ /// customer without one, so this is never empty here.
+ /// </summary>
+ private string CurrentStoreId => _contextAccessor.WorkContext.CurrentCustomer.StaffStoreId;
+
+ public async Task<IActionResult> Configure()
+ {
+ var stripeCheckoutPaymentSettings =
+ await _settingService.LoadSetting<StripeCheckoutPaymentSettings>(CurrentStoreId);
+
+ var model = new ConfigurationModel {
+ ApiKey = stripeCheckoutPaymentSettings.ApiKey,
+ WebhookEndpointSecret = stripeCheckoutPaymentSettings.WebhookEndpointSecret,
+ Description = stripeCheckoutPaymentSettings.Description,
+ Line = stripeCheckoutPaymentSettings.Line,
+ DisplayOrder = stripeCheckoutPaymentSettings.DisplayOrder,
+ //the store manager can only configure his own store, so no store selector is offered
+ StoreScope = CurrentStoreId
+ };
+
+ //the webhook has to be registered with Stripe against the manager's own storefront, not
+ //against whichever host happens to serve this panel
+ var store = await _storeService.GetStoreById(CurrentStoreId);
+ ViewBag.WebhookUrl = $"{store?.Url?.TrimEnd('/')}{Url.RouteUrl(StripeCheckoutDefaults.WebHook)}";
+
+ return View(model);
+ }
+
+ [HttpPost]
+ [AutoValidateAntiforgeryToken]
+ public async Task<IActionResult> Configure(ConfigurationModel model)
+ {
+ if (!ModelState.IsValid)
+ return await Configure();
+
+ var stripeCheckoutPaymentSettings =
+ await _settingService.LoadSetting<StripeCheckoutPaymentSettings>(CurrentStoreId);
+
+ stripeCheckoutPaymentSettings.ApiKey = model.ApiKey;
+ stripeCheckoutPaymentSettings.WebhookEndpointSecret = model.WebhookEndpointSecret;
+ stripeCheckoutPaymentSettings.Description = model.Description;
+ stripeCheckoutPaymentSettings.Line = model.Line;
+ stripeCheckoutPaymentSettings.DisplayOrder = model.DisplayOrder;
+
+ await _settingService.SaveSetting(stripeCheckoutPaymentSettings, CurrentStoreId);
+
+ //now clear settings cache
+ await _settingService.ClearCache();
+
+ Success(_translationService.GetResource("Admin.Plugins.Saved"));
+
+ return await Configure();
+ }
+}
diff --git a/src/Plugins/Payments.StripeCheckout/Areas/Store/Views/StripeCheckout/Configure.cshtml b/src/Plugins/Payments.StripeCheckout/Areas/Store/Views/StripeCheckout/Configure.cshtml
new file mode 100644
index 000000000..090c967af
--- /dev/null
+++ b/src/Plugins/Payments.StripeCheckout/Areas/Store/Views/StripeCheckout/Configure.cshtml
@@ -0,0 +1,90 @@
+@model Payments.StripeCheckout.Models.ConfigurationModel
+@{
+ Layout = "~/Areas/Store/Views/Shared/_StoreLayout.cshtml";
+ ViewBag.Title = Loc["Admin.Configuration.Payment.Methods"];
+}
+<input id="active-menu-item" type="hidden" value="/Store/Payment/Index"/>
+
+<div class="row">
+ <div class="col-md-12">
+ <div class="x_panel light form-fit">
+ <div class="x_title">
+ <div class="caption level-caption">
+ <i class="fa fa-money"></i>
+ @Loc["Plugins.Payments.StripeCheckout.FriendlyName"]
+ </div>
+ </div>
+ <div class="x_content form">
+ <form asp-area="Store" asp-controller="StripeCheckout" asp-action="Configure" method="post">
+ <p>
+ For plugin configuration please check:<br/>
+ <br/>
+ 1. Generate API keys from the Stripe Dashboard: <a href="https://stripe.com/docs/api/authentication" target="_blank">Click here.</a><br/>
+ 2. Register webhook endpoints with Stripe <a href="https://stripe.com/docs/development/dashboard/register-webhook" target="_blank">Click here.</a><br/>
+ 3. Your Webhook URL: @ViewBag.WebhookUrl <br/>
+ 4. Fill in your credentials below.<br/>
+ 5. Save the configuration.<br/>
+ <br/>
+ <em>Note: Ensure that you have configured your primary store currency that is supported by selected payment service provider.</em><br/>
+ </p>
+ <div class="form-horizontal">
+ <div class="form-body">
+ <div class="form-group">
+ <div class="col-md-3 col-sm-3 text-right">
+ <admin-label asp-for="ApiKey" class="control-label"/>
+ </div>
+ <div class="col-md-9 col-sm-9">
+ <admin-input asp-for="ApiKey"/>
+ <span asp-validation-for="ApiKey"></span>
+ </div>
+ </div>
+ <div class="form-group">
+ <div class="col-md-3 col-sm-3 text-right">
+ <admin-label asp-for="WebhookEndpointSecret" class="control-label"/>
+ </div>
+ <div class="col-md-9 col-sm-9">
+ <admin-input asp-for="WebhookEndpointSecret"/>
+ <span asp-validation-for="WebhookEndpointSecret"></span>
+ </div>
+ </div>
+ <div class="form-group">
+ <div class="col-md-3 col-sm-3 text-right">
+ <admin-label asp-for="Line" class="control-label"/>
+ </div>
+ <div class="col-md-9 col-sm-9">
+ <admin-input asp-for="Line"/>
+ <span asp-validation-for="Line"></span>
+ </div>
+ </div>
+ <div class="form-group">
+ <div class="col-md-3 col-sm-3 text-right">
+ <admin-label asp-for="Description" class="control-label"/>
+ </div>
+ <div class="col-md-9 col-sm-9">
+ <admin-textarea asp-for="Description"/>
+ <span asp-validation-for="Description"></span>
+ </div>
+ </div>
+ <div class="form-group">
+ <div class="col-md-3 col-sm-3 text-right">
+ <admin-label asp-for="DisplayOrder" class="control-label"/>
+ </div>
+ <div class="col-md-9 col-sm-9">
+ <admin-input asp-for="DisplayOrder"/>
+ <span asp-validation-for="DisplayOrder"></span>
+ </div>
+ </div>
+ </div>
+ <div class="form-actions">
+ <div class="row">
+ <div class="offset-md-3 offset-sm-3 col-md-9 col-sm-9">
+ <input type="submit" name="save" class="btn green" value="@Loc["Admin.Common.Save"]"/>
+ </div>
+ </div>
+ </div>
+ </div>
+ </form>
+ </div>
+ </div>
+ </div>
+</div>
diff --git a/src/Plugins/Payments.StripeCheckout/Areas/Store/Views/_ViewImports.cshtml b/src/Plugins/Payments.StripeCheckout/Areas/Store/Views/_ViewImports.cshtml
new file mode 100644
index 000000000..0d1778c76
--- /dev/null
+++ b/src/Plugins/Payments.StripeCheckout/Areas/Store/Views/_ViewImports.cshtml
@@ -0,0 +1,8 @@
+@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
+@addTagHelper *, Grand.Web.Common
+
+@using Microsoft.AspNetCore.Mvc.ViewFeatures
+@using Grand.Infrastructure.Extensions
+@using Grand.Web.Common.Localization
+
+@inject LocService Loc
diff --git a/src/Plugins/Payments.StripeCheckout/Services/StripeCheckoutService.cs b/src/Plugins/Payments.StripeCheckout/Services/StripeCheckoutService.cs
index 0f1b8c1bb..dd91fded0 100644
--- a/src/Plugins/Payments.StripeCheckout/Services/StripeCheckoutService.cs
+++ b/src/Plugins/Payments.StripeCheckout/Services/StripeCheckoutService.cs
@@ -93,8 +93,6 @@ public class StripeCheckoutService : IStripeCheckoutService
private async Task<Session> CreateUrlSession(Order order)
{
- StripeConfiguration.ApiKey = _stripeCheckoutPaymentSettings.ApiKey;
-
var storeLocation = _contextAccessor.StoreContext.CurrentHost.Url.TrimEnd('/');
var options = new SessionCreateOptions {
@@ -119,7 +117,10 @@ public class StripeCheckoutService : IStripeCheckoutService
SuccessUrl = $"{storeLocation}/orderdetails/{order.Id}",
CancelUrl = $"{storeLocation}/Plugins/PaymentStripeCheckout/CancelOrder/{order.Id}"
};
- var service = new SessionService();
+ //the api key is store-specific, so it travels with the client - the static
+ //StripeConfiguration.ApiKey is process-wide and two stores checking out at the same time
+ //would overwrite each other's credentials
+ var service = new SessionService(new StripeClient(_stripeCheckoutPaymentSettings.ApiKey));
var session = await service.CreateAsync(options);
return session;
diff --git a/src/Tests/Grand.Web.Store.Tests/Controllers/PaymentControllerTests.cs b/src/Tests/Grand.Web.Store.Tests/Controllers/PaymentControllerTests.cs
index 57215f31e..981523139 100644
--- a/src/Tests/Grand.Web.Store.Tests/Controllers/PaymentControllerTests.cs
+++ b/src/Tests/Grand.Web.Store.Tests/Controllers/PaymentControllerTests.cs
@@ -101,6 +101,8 @@ public class PaymentControllerTests
var model = ((IEnumerable<PaymentMethodModel>)data.Data).First();
Assert.AreEqual("Payments.TestMethod", model.SystemName);
Assert.IsTrue(model.IsActive);
+ //the provider ships no Store-area screen, so no configuration link is offered
+ Assert.IsNull(model.ConfigurationUrl);
_paymentServiceMock.Verify(p => p.LoadAllPaymentMethods(null, StoreId, ""), Times.Once);
_settingServiceMock.Verify(s => s.LoadSetting<PaymentSettings>(StoreId), Times.Once);
}
diff --git a/src/Tests/Grand.Web.Store.Tests/Extensions/StoreAreaConfigurationTests.cs b/src/Tests/Grand.Web.Store.Tests/Extensions/StoreAreaConfigurationTests.cs
new file mode 100644
index 000000000..45dbe407a
--- /dev/null
+++ b/src/Tests/Grand.Web.Store.Tests/Extensions/StoreAreaConfigurationTests.cs
@@ -0,0 +1,77 @@
+using Grand.Web.Common.Controllers;
+using Grand.Web.Store.Extensions;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using Moq;
+
+namespace Grand.Web.Store.Tests.Extensions;
+
+[TestClass]
+public class StoreAreaConfigurationTests
+{
+ /// <summary>
+ /// A provider coming from this test assembly - which ships <see cref="FakeStoreController" />
+ /// below - stands in for a plugin that has a Store-area configuration screen.
+ /// </summary>
+ private class ProviderWithStoreArea;
+
+ [TestMethod]
+ public void Exists_ProviderFromAssemblyWithStoreAreaController_ReturnTrue()
+ {
+ Assert.IsTrue(StoreAreaConfiguration.Exists(new ProviderWithStoreArea()));
+ }
+
+ [TestMethod]
+ public void Exists_ProviderWithoutStoreAreaController_ReturnFalse()
+ {
+ //a mocked interface lives in the dynamic proxy assembly, which ships no controllers at all
+ Assert.IsFalse(StoreAreaConfiguration.Exists(Mock.Of<IDisposable>()));
+ }
+
+ [TestMethod]
+ public void Exists_NullProvider_ReturnFalse()
+ {
+ Assert.IsFalse(StoreAreaConfiguration.Exists(null));
+ }
+
+ [TestMethod]
+ public void GetConfigurationUrl_ProviderFromAssemblyWithStoreAreaController_ReturnStoreAreaUrl()
+ {
+ Assert.AreEqual("/Store/FakeStore/Configure",
+ StoreAreaConfiguration.GetConfigurationUrl(new ProviderWithStoreArea()));
+ }
+
+ [TestMethod]
+ public void GetConfigurationUrl_ProviderWithoutStoreAreaController_ReturnNull()
+ {
+ Assert.IsNull(StoreAreaConfiguration.GetConfigurationUrl(Mock.Of<IDisposable>()));
+ }
+
+ [TestMethod]
+ public void GetConfigurationUrl_NullProvider_ReturnNull()
+ {
+ Assert.IsNull(StoreAreaConfiguration.GetConfigurationUrl(null));
+ }
+}
+
+/// <summary>
+/// Stands in for the configuration screen a multi-store capable plugin ships. It is the only
+/// Store-area controller in this test assembly, so the url built from it is deterministic.
+/// The two Configure overloads mirror a real screen: a shipped controller always has both a GET
+/// and a POST, and looking the action up by name alone would throw on that ambiguity.
+/// </summary>
+[Area("Store")]
+public class FakeStoreController : BaseController
+{
+ public IActionResult Configure()
+ {
+ return new EmptyResult();
+ }
+
+ [HttpPost]
+ [AutoValidateAntiforgeryToken]
+ public IActionResult Configure(string model)
+ {
+ return new EmptyResult();
+ }
+}
diff --git a/src/Web/Grand.Web.Store/Areas/Store/Views/Payment/Index.cshtml b/src/Web/Grand.Web.Store/Areas/Store/Views/Payment/Index.cshtml
index c7e50fb35..bb0d7288c 100644
--- a/src/Web/Grand.Web.Store/Areas/Store/Views/Payment/Index.cshtml
+++ b/src/Web/Grand.Web.Store/Areas/Store/Views/Payment/Index.cshtml
@@ -51,6 +51,7 @@
fields: {
FriendlyName: { editable: false, type: "string" },
SystemName: { editable: false, type: "string" },
+ ConfigurationUrl: { editable: false, type: "string" },
SupportCapture: { editable: false, type: "boolean" },
SupportRefund: { editable: false, type: "boolean" },
SupportPartiallyRefund: { editable: false, type: "boolean" },
@@ -86,10 +87,12 @@
scrollable: false,
columns: [{
field: "FriendlyName",
- title: "@Loc["Admin.Configuration.Payment.Methods.Fields.FriendlyName"]"
+ title: "@Loc["Admin.Configuration.Payment.Methods.Fields.FriendlyName"]",
+ template: '# if (ConfigurationUrl) { # <a class="k-link" href="#=ConfigurationUrl#">#:FriendlyName#</a> # } else { # #:FriendlyName# # } #'
}, {
field: "SystemName",
- title: "@Loc["Admin.Configuration.Payment.Methods.Fields.SystemName"]"
+ title: "@Loc["Admin.Configuration.Payment.Methods.Fields.SystemName"]",
+ template: '# if (ConfigurationUrl) { # <a class="k-link" href="#=ConfigurationUrl#">#:SystemName#</a> # } else { # #:SystemName# # } #'
}, {
field: "SupportCapture",
title: "@Loc["Admin.Configuration.Payment.Methods.Fields.SupportCapture"]",
diff --git a/src/Web/Grand.Web.Store/Controllers/PaymentController.cs b/src/Web/Grand.Web.Store/Controllers/PaymentController.cs
index 770596359..d4a36132f 100644
--- a/src/Web/Grand.Web.Store/Controllers/PaymentController.cs
+++ b/src/Web/Grand.Web.Store/Controllers/PaymentController.cs
@@ -13,6 +13,7 @@ using Grand.Web.AdminShared.Models.Payments;
using Grand.Web.AdminShared.Models.Shipping;
using Grand.Web.Common.DataSource;
using Grand.Web.Common.Security.Authorization;
+using Grand.Web.Store.Extensions;
using Microsoft.AspNetCore.Mvc;
namespace Grand.Web.Store.Controllers;
@@ -47,6 +48,10 @@ public class PaymentController(
{
var tmp = await paymentMethod.ToModel();
tmp.IsActive = paymentMethod.IsPaymentMethodActive(paymentSettings);
+ //the provider's own url points at the Admin area, so it is replaced by the Store-area
+ //screen the plugin ships - null when it ships none, and then no link is rendered at all
+ tmp.ConfigurationUrl = StoreAreaConfiguration.GetConfigurationUrl(paymentMethod);
+
paymentMethodsModel.Add(tmp);
}
diff --git a/src/Web/Grand.Web.Store/Extensions/StoreAreaConfiguration.cs b/src/Web/Grand.Web.Store/Extensions/StoreAreaConfiguration.cs
index 01e564e93..59dc51ae4 100644
--- a/src/Web/Grand.Web.Store/Extensions/StoreAreaConfiguration.cs
+++ b/src/Web/Grand.Web.Store/Extensions/StoreAreaConfiguration.cs
@@ -18,6 +18,7 @@ public static class StoreAreaConfiguration
{
//plugin assemblies never change within a process lifetime, so the reflection cost is paid once
private static readonly ConcurrentDictionary<Assembly, bool> Cache = new();
+ private static readonly ConcurrentDictionary<Assembly, string> UrlCache = new();
/// <summary>
/// Whether the provider's plugin exposes at least one controller in the Store area.
@@ -27,12 +28,46 @@ public static class StoreAreaConfiguration
return provider != null && Cache.GetOrAdd(provider.GetType().Assembly, HasStoreAreaController);
}
+ /// <summary>
+ /// The url of the provider's configuration screen within the Store area, or null when its
+ /// plugin ships none.
+ /// <para>
+ /// A provider's own <c>ConfigurationUrl</c> cannot be reused here: some plugins declare it
+ /// relative ("../ShippingByWeight/Configure", which resolves per area) but others declare it
+ /// absolute ("/Admin/PaymentBrainTree/Configure"), which would send a store manager into the
+ /// Admin area. The url is therefore built from the Store-area controller the plugin actually
+ /// ships, which by convention exposes a Configure action.
+ /// </para>
+ /// </summary>
+ public static string GetConfigurationUrl(object provider)
+ {
+ if (provider == null) return null;
+ var controller = UrlCache.GetOrAdd(provider.GetType().Assembly, FindStoreAreaConfigurationController);
+ return controller == null ? null : $"/{Constants.AreaStore}/{controller}/Configure";
+ }
+
private static bool HasStoreAreaController(Assembly assembly)
{
- return GetLoadableTypes(assembly).Any(type =>
- typeof(ControllerBase).IsAssignableFrom(type) &&
- string.Equals(type.GetCustomAttribute<AreaAttribute>()?.RouteValue, Constants.AreaStore,
- StringComparison.OrdinalIgnoreCase));
+ return GetLoadableTypes(assembly).Any(IsStoreAreaController);
+ }
+
+ private static string FindStoreAreaConfigurationController(Assembly assembly)
+ {
+ //a configuration screen has a GET and a POST Configure, so the overloads are enumerated
+ //rather than asked for by name - GetMethod would throw on the ambiguity
+ var controller = GetLoadableTypes(assembly).FirstOrDefault(type =>
+ IsStoreAreaController(type) &&
+ type.GetMethods(BindingFlags.Public | BindingFlags.Instance)
+ .Any(method => method.Name == "Configure"));
+
+ return controller == null ? null : controller.Name.Replace("Controller", string.Empty);
+ }
+
+ private static bool IsStoreAreaController(Type type)
+ {
+ return typeof(ControllerBase).IsAssignableFrom(type) &&
+ string.Equals(type.GetCustomAttribute<AreaAttribute>()?.RouteValue, Constants.AreaStore,
+ StringComparison.OrdinalIgnoreCase);
}
/// <summary>