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.

MerchandiseReturnController - move validator logic from Controller to Validator

support9d13f211ab9b
diff --git a/src/Web/Grand.Web/Commands/Handler/Orders/MerchandiseReturnSubmitCommandHandler.cs b/src/Web/Grand.Web/Commands/Handler/Orders/MerchandiseReturnSubmitCommandHandler.cs
index 4b50c429a..3d527fe10 100644
--- a/src/Web/Grand.Web/Commands/Handler/Orders/MerchandiseReturnSubmitCommandHandler.cs
+++ b/src/Web/Grand.Web/Commands/Handler/Orders/MerchandiseReturnSubmitCommandHandler.cs
@@ -13,14 +13,12 @@ using MediatR;
namespace Grand.Web.Commands.Handler.Orders
{
- public class MerchandiseReturnSubmitCommandHandler : IRequestHandler<MerchandiseReturnSubmitCommand, (
- MerchandiseReturnModel model, MerchandiseReturn rr)>
+ public class MerchandiseReturnSubmitCommandHandler : IRequestHandler<MerchandiseReturnSubmitCommand, MerchandiseReturn>
{
private readonly IWorkContext _workContext;
private readonly IProductService _productService;
private readonly IMerchandiseReturnService _merchandiseReturnService;
private readonly IMessageProviderService _messageProviderService;
- private readonly ITranslationService _translationService;
private readonly IGroupService _groupService;
private readonly LanguageSettings _languageSettings;
@@ -29,7 +27,6 @@ namespace Grand.Web.Commands.Handler.Orders
IProductService productService,
IMerchandiseReturnService merchandiseReturnService,
IMessageProviderService messageProviderService,
- ITranslationService translationService,
IGroupService groupService,
LanguageSettings languageSettings)
{
@@ -37,12 +34,11 @@ namespace Grand.Web.Commands.Handler.Orders
_productService = productService;
_merchandiseReturnService = merchandiseReturnService;
_messageProviderService = messageProviderService;
- _translationService = translationService;
_groupService = groupService;
_languageSettings = languageSettings;
}
- public async Task<(MerchandiseReturnModel model, MerchandiseReturn rr)> Handle(
+ public async Task<MerchandiseReturn> Handle(
MerchandiseReturnSubmitCommand request, CancellationToken cancellationToken)
{
var rr = new MerchandiseReturn {
@@ -63,7 +59,7 @@ namespace Grand.Web.Commands.Handler.Orders
if (request.Model.PickupDate.HasValue)
rr.PickupDate = request.Model.PickupDate.Value;
- var vendors = new List<string>();
+
foreach (var orderItem in request.Order.OrderItems)
{
var product = await _productService.GetProductById(orderItem.ProductId);
@@ -88,32 +84,18 @@ namespace Grand.Web.Commands.Handler.Orders
OrderItemId = orderItem.Id
});
rr.VendorId = orderItem.VendorId;
- vendors.Add(orderItem.VendorId);
- }
-
- if (vendors.Distinct().Count() > 1)
- {
- request.Model.Error = _translationService.GetResource("MerchandiseReturns.MultiVendorsItems");
- return (request.Model, rr);
}
- if (rr.MerchandiseReturnItems.Any())
- {
- await _merchandiseReturnService.InsertMerchandiseReturn(rr);
+ await _merchandiseReturnService.InsertMerchandiseReturn(rr);
- //notify store owner here (email)
- await _messageProviderService.SendNewMerchandiseReturnStoreOwnerMessage(rr, request.Order,
- _languageSettings.DefaultAdminLanguageId);
- //notify customer
- await _messageProviderService.SendNewMerchandiseReturnCustomerMessage(rr, request.Order,
- request.Order.CustomerLanguageId);
- }
- else
- {
- request.Model.Error = _translationService.GetResource("MerchandiseReturns.NoItemsSubmitted");
- }
+ //notify store owner here (email)
+ await _messageProviderService.SendNewMerchandiseReturnStoreOwnerMessage(rr, request.Order,
+ _languageSettings.DefaultAdminLanguageId);
+ //notify customer
+ await _messageProviderService.SendNewMerchandiseReturnCustomerMessage(rr, request.Order,
+ request.Order.CustomerLanguageId);
- return (request.Model, rr);
+ return rr;
}
}
}
\ No newline at end of file
diff --git a/src/Web/Grand.Web/Commands/Models/Orders/MerchandiseReturnSubmitCommand.cs b/src/Web/Grand.Web/Commands/Models/Orders/MerchandiseReturnSubmitCommand.cs
index 7f1785b00..bea8e12bb 100644
--- a/src/Web/Grand.Web/Commands/Models/Orders/MerchandiseReturnSubmitCommand.cs
+++ b/src/Web/Grand.Web/Commands/Models/Orders/MerchandiseReturnSubmitCommand.cs
@@ -5,7 +5,7 @@ using MediatR;
namespace Grand.Web.Commands.Models.Orders
{
- public class MerchandiseReturnSubmitCommand : IRequest<(MerchandiseReturnModel model, MerchandiseReturn rr)>
+ public class MerchandiseReturnSubmitCommand : IRequest<MerchandiseReturn>
{
public MerchandiseReturnModel Model { get; set; }
public Order Order { get; set; }
diff --git a/src/Web/Grand.Web/Controllers/MerchandiseReturnController.cs b/src/Web/Grand.Web/Controllers/MerchandiseReturnController.cs
index 563ff97f6..30e7df37e 100644
--- a/src/Web/Grand.Web/Controllers/MerchandiseReturnController.cs
+++ b/src/Web/Grand.Web/Controllers/MerchandiseReturnController.cs
@@ -1,5 +1,4 @@
using Grand.Business.Core.Interfaces.Checkout.Orders;
-using Grand.Business.Core.Interfaces.Common.Addresses;
using Grand.Business.Core.Interfaces.Common.Directory;
using Grand.Business.Core.Interfaces.Common.Localization;
using Grand.Business.Core.Queries.Checkout.Orders;
@@ -32,6 +31,7 @@ namespace Grand.Web.Controllers
private readonly IMediator _mediator;
private readonly AddressSettings _addressSettings;
private readonly OrderSettings _orderSettings;
+
#endregion
#region Constructors
@@ -63,7 +63,8 @@ namespace Grand.Web.Controllers
private async Task PrepareModelAddress(AddressModel addressModel, Address address)
{
var countryService = HttpContext.RequestServices.GetRequiredService<ICountryService>();
- var countries = await countryService.GetAllCountries(_workContext.WorkingLanguage.Id, _workContext.CurrentStore.Id);
+ var countries =
+ await countryService.GetAllCountries(_workContext.WorkingLanguage.Id, _workContext.CurrentStore.Id);
addressModel = await _mediator.Send(new GetAddressModel {
Language = _workContext.WorkingLanguage,
Store = _workContext.CurrentStore,
@@ -80,28 +81,24 @@ namespace Grand.Web.Controllers
{
var address = new Address();
if (!_orderSettings.MerchandiseReturns_AllowToSpecifyPickupAddress) return address;
+
if (!string.IsNullOrEmpty(model.PickupAddressId))
{
address = _workContext.CurrentCustomer.Addresses.FirstOrDefault(a => a.Id == model.PickupAddressId);
}
else
{
- var customAttributes = await _mediator.Send(new GetParseCustomAddressAttributes { SelectedAttributes = model.MerchandiseReturnNewAddress.SelectedAttributes });
- var addressAttributeParser = HttpContext.RequestServices.GetRequiredService<IAddressAttributeParser>();
- var customAttributeWarnings = await addressAttributeParser.GetAttributeWarnings(customAttributes);
- foreach (var error in customAttributeWarnings)
- {
- ModelState.AddModelError("", error);
- }
+ var customAttributes = await _mediator.Send(new GetParseCustomAddressAttributes
+ { SelectedAttributes = model.MerchandiseReturnNewAddress.SelectedAttributes });
address = model.MerchandiseReturnNewAddress.ToEntity(_workContext.CurrentCustomer, _addressSettings);
model.NewAddressPreselected = true;
address.Attributes = customAttributes;
address.CreatedOnUtc = DateTime.UtcNow;
}
+
return address;
}
-
#endregion
#region Methods
@@ -120,7 +117,7 @@ namespace Grand.Web.Controllers
return View(model);
}
- public virtual async Task<IActionResult> MerchandiseReturn(string orderId, string errors = "")
+ public virtual async Task<IActionResult> MerchandiseReturn(string orderId)
{
var order = await _orderService.GetOrderById(orderId);
if (!await order.Access(_workContext.CurrentCustomer, _groupService))
@@ -134,73 +131,52 @@ namespace Grand.Web.Controllers
Language = _workContext.WorkingLanguage,
Store = _workContext.CurrentStore
});
- model.Error = errors;
return View(model);
}
- [HttpPost, ActionName("MerchandiseReturn")]
+ [HttpPost]
[AutoValidateAntiforgeryToken]
- public virtual async Task<IActionResult> MerchandiseReturnSubmit(string orderId, MerchandiseReturnModel model)
+ public virtual async Task<IActionResult> MerchandiseReturn(MerchandiseReturnModel model)
{
- var order = await _orderService.GetOrderById(orderId);
+ var order = await _orderService.GetOrderById(model.OrderId);
if (!await order.Access(_workContext.CurrentCustomer, _groupService))
return Challenge();
if (!await _mediator.Send(new IsMerchandiseReturnAllowedQuery { Order = order }))
return RedirectToRoute("HomePage");
- if (_orderSettings.MerchandiseReturns_AllowToSpecifyPickupDate && _orderSettings.MerchandiseReturns_PickupDateRequired && model.PickupDate == null)
- {
- ModelState.AddModelError("", _translationService.GetResource("MerchandiseReturns.PickupDateRequired"));
- }
-
var address = await PrepareAddress(model);
- if (ModelState is { IsValid: false })
+ if (ModelState.IsValid)
{
- var returnModel = await _mediator.Send(new GetMerchandiseReturn {
- Order = order,
- Language = _workContext.WorkingLanguage,
- Store = _workContext.CurrentStore
- });
- returnModel.Error = string.Join(", ", ModelState.Keys.SelectMany(k => ModelState[k]!.Errors).Select(m => m.ErrorMessage).ToArray());
- returnModel.Comments = model.Comments;
- returnModel.PickupDate = model.PickupDate;
- returnModel.NewAddressPreselected = model.NewAddressPreselected;
- returnModel.MerchandiseReturnNewAddress = model.MerchandiseReturnNewAddress;
- if (returnModel.NewAddressPreselected || _orderSettings.MerchandiseReturns_AllowToSpecifyPickupAddress)
- {
- await PrepareModelAddress(model.MerchandiseReturnNewAddress, address);
- }
- return View(returnModel);
+ var result = await _mediator.Send(new MerchandiseReturnSubmitCommand
+ { Address = address, Model = model, Order = order });
+
+ model.Result = string.Format(_translationService.GetResource("MerchandiseReturns.Submitted"),
+ result.ReturnNumber,
+ Url.Link("MerchandiseReturnDetails", new { merchandiseReturnId = result.Id }));
+ model.OrderNumber = order.OrderNumber;
+ model.OrderCode = order.Code;
+ return View(model);
}
- else
+
+ var returnModel = await _mediator.Send(new GetMerchandiseReturn {
+ Order = order,
+ Language = _workContext.WorkingLanguage,
+ Store = _workContext.CurrentStore
+ });
+ returnModel.Error = string.Join(", ",
+ ModelState.Keys.SelectMany(k => ModelState[k]!.Errors).Select(m => m.ErrorMessage).ToArray());
+ returnModel.Comments = model.Comments;
+ returnModel.PickupDate = model.PickupDate;
+ returnModel.NewAddressPreselected = model.NewAddressPreselected;
+ returnModel.MerchandiseReturnNewAddress = model.MerchandiseReturnNewAddress;
+ if (returnModel.NewAddressPreselected || _orderSettings.MerchandiseReturns_AllowToSpecifyPickupAddress)
{
- var result = await _mediator.Send(new MerchandiseReturnSubmitCommand { Address = address, Model = model, Order = order });
- if (result.rr.ReturnNumber > 0)
- {
- model.Result = string.Format(_translationService.GetResource("MerchandiseReturns.Submitted"), result.rr.ReturnNumber, Url.Link("MerchandiseReturnDetails", new { merchandiseReturnId = result.rr.Id }));
- model.OrderNumber = order.OrderNumber;
- model.OrderCode = order.Code;
- return View(result.model);
- }
-
- var returnModel = await _mediator.Send(new GetMerchandiseReturn {
- Order = order,
- Language = _workContext.WorkingLanguage,
- Store = _workContext.CurrentStore
- });
- returnModel.Error = result.model.Error;
- returnModel.Comments = model.Comments;
- returnModel.PickupDate = model.PickupDate;
- returnModel.NewAddressPreselected = model.NewAddressPreselected;
- returnModel.MerchandiseReturnNewAddress = model.MerchandiseReturnNewAddress;
- if (returnModel.NewAddressPreselected || _orderSettings.MerchandiseReturns_AllowToSpecifyPickupAddress)
- {
- await PrepareModelAddress(model.MerchandiseReturnNewAddress, address);
- }
- return View(returnModel);
+ await PrepareModelAddress(model.MerchandiseReturnNewAddress, address);
}
+
+ return View(returnModel);
}
public virtual async Task<IActionResult> MerchandiseReturnDetails(string merchandiseReturnId)
@@ -224,4 +200,4 @@ namespace Grand.Web.Controllers
#endregion
}
-}
+}
\ No newline at end of file
diff --git a/src/Web/Grand.Web/Validators/Orders/MerchandiseReturnValidator.cs b/src/Web/Grand.Web/Validators/Orders/MerchandiseReturnValidator.cs
new file mode 100644
index 000000000..e05eb10fa
--- /dev/null
+++ b/src/Web/Grand.Web/Validators/Orders/MerchandiseReturnValidator.cs
@@ -0,0 +1,59 @@
+using FluentValidation;
+using Grand.Business.Core.Interfaces.Catalog.Products;
+using Grand.Business.Core.Interfaces.Checkout.Orders;
+using Grand.Business.Core.Interfaces.Common.Addresses;
+using Grand.Business.Core.Interfaces.Common.Localization;
+using Grand.Domain.Orders;
+using Grand.Infrastructure.Validators;
+using Grand.Web.Features.Models.Common;
+using Grand.Web.Models.Orders;
+using MediatR;
+
+namespace Grand.Web.Validators.Orders;
+
+public class MerchandiseReturnValidator : BaseGrandValidator<MerchandiseReturnModel>
+{
+ public MerchandiseReturnValidator(
+ IEnumerable<IValidatorConsumer<MerchandiseReturnModel>> validators,
+ OrderSettings orderSettings, IOrderService orderService, IProductService productService,
+ IMediator mediator, IAddressAttributeParser addressAttributeParser,
+ ITranslationService translationService)
+ : base(validators)
+ {
+ RuleFor(x => x).CustomAsync(async (x, context, _) =>
+ {
+ if (orderSettings.MerchandiseReturns_AllowToSpecifyPickupDate && orderSettings.MerchandiseReturns_PickupDateRequired && x.PickupDate == null)
+ {
+ context.AddFailure(translationService.GetResource("MerchandiseReturns.PickupDateRequired"));
+ }
+ var customAttributes = await mediator.Send(new GetParseCustomAddressAttributes { SelectedAttributes = x.MerchandiseReturnNewAddress.SelectedAttributes }, _);
+ var customAttributeWarnings = await addressAttributeParser.GetAttributeWarnings(customAttributes);
+ foreach (var error in customAttributeWarnings)
+ {
+ context.AddFailure(error);
+ }
+
+ if (!x.Items.Any(x => x.Quantity > 0))
+ {
+ context.AddFailure(translationService.GetResource("MerchandiseReturns.NoItemsSubmitted"));
+ }
+ var vendors = new List<string>();
+ var order = await orderService.GetOrderById(x.OrderId);
+ foreach (var orderItem in order.OrderItems)
+ {
+ var product = await productService.GetProductById(orderItem.ProductId);
+ if (product.NotReturnable) continue;
+
+ var quantity = x.Items.FirstOrDefault(x => x.Id == orderItem.Id)?.Quantity;
+
+ if (quantity is not > 0) continue;
+
+ vendors.Add(orderItem.VendorId);
+ }
+ if (vendors.Distinct().Count() > 1)
+ {
+ context.AddFailure(translationService.GetResource("MerchandiseReturns.MultiVendorsItems"));
+ }
+ });
+ }
+}
\ No newline at end of file