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.

Refactor MessageTokenProvider

dkuciaecb9fcc9b79a
diff --git a/src/Business/Grand.Business.Marketing/Services/Campaigns/CampaignService.cs b/src/Business/Grand.Business.Marketing/Services/Campaigns/CampaignService.cs
index 0704fda8c..48f8ef46c 100644
--- a/src/Business/Grand.Business.Marketing/Services/Campaigns/CampaignService.cs
+++ b/src/Business/Grand.Business.Marketing/Services/Campaigns/CampaignService.cs
@@ -322,19 +322,20 @@ namespace Grand.Business.Marketing.Services.Campaigns
if (customer != null && (!customer.Active || customer.Deleted))
continue;
- var liquidObject = new LiquidObject();
+ var builder = new LiquidObjectBuilder(_mediator);
var store = await _storeService.GetStoreById(campaign.StoreId);
if (store == null)
store = (await _storeService.GetAllStores()).FirstOrDefault();
- await _messageTokenProvider.AddStoreTokens(liquidObject, store, language, emailAccount);
- await _messageTokenProvider.AddNewsLetterSubscriptionTokens(liquidObject, subscription, store);
+ builder.AddStoreTokens(store, language, emailAccount)
+ .AddNewsLetterSubscriptionTokens(subscription, store);
if (customer != null)
{
- await _messageTokenProvider.AddCustomerTokens(liquidObject, customer, store, language);
- await _messageTokenProvider.AddShoppingCartTokens(liquidObject, customer, store, language);
+ builder.AddCustomerTokens(customer, store, language)
+ .AddShoppingCartTokens(customer, store, language);
}
+ var liquidObject = await builder.BuildAsync();
var body = LiquidExtensions.Render(liquidObject, campaign.Body);
var subject = LiquidExtensions.Render(liquidObject, campaign.Subject);
@@ -385,15 +386,16 @@ namespace Grand.Business.Marketing.Services.Campaigns
if (store == null)
store = (await _storeService.GetAllStores()).FirstOrDefault();
- var liquidObject = new LiquidObject();
- await _messageTokenProvider.AddStoreTokens(liquidObject, store, language, emailAccount);
+ var builder = new LiquidObjectBuilder(_mediator);
+ builder.AddStoreTokens(store, language, emailAccount);
var customer = await _customerService.GetCustomerByEmail(email);
if (customer != null)
{
- await _messageTokenProvider.AddCustomerTokens(liquidObject, customer, store, language);
- await _messageTokenProvider.AddShoppingCartTokens(liquidObject, customer, store, language);
+ builder.AddCustomerTokens(customer, store, language)
+ .AddShoppingCartTokens(customer, store, language);
}
+ var liquidObject = await builder.BuildAsync();
var body = LiquidExtensions.Render(liquidObject, campaign.Body);
var subject = LiquidExtensions.Render(liquidObject, campaign.Subject);
diff --git a/src/Business/Grand.Business.Marketing/Services/Customers/CustomerReminderService.cs b/src/Business/Grand.Business.Marketing/Services/Customers/CustomerReminderService.cs
index 513eddde2..3834c2c79 100644
--- a/src/Business/Grand.Business.Marketing/Services/Customers/CustomerReminderService.cs
+++ b/src/Business/Grand.Business.Marketing/Services/Customers/CustomerReminderService.cs
@@ -102,11 +102,12 @@ namespace Grand.Business.Marketing.Services.Customers
if (language == null)
language = languages.FirstOrDefault();
- LiquidObject liquidObject = new LiquidObject();
- await _messageTokenProvider.AddStoreTokens(liquidObject, store, language, emailAccount);
- await _messageTokenProvider.AddCustomerTokens(liquidObject, customer, store, language);
- await _messageTokenProvider.AddShoppingCartTokens(liquidObject, customer, store, language);
+ var builder = new LiquidObjectBuilder(_mediator);
+ builder.AddStoreTokens(store, language, emailAccount)
+ .AddCustomerTokens(customer, store, language)
+ .AddShoppingCartTokens(customer, store, language);
+ LiquidObject liquidObject = await builder.BuildAsync();
var body = LiquidExtensions.Render(liquidObject, reminderLevel.Body);
var subject = LiquidExtensions.Render(liquidObject, reminderLevel.Subject);
@@ -171,12 +172,13 @@ namespace Grand.Business.Marketing.Services.Customers
language = (await _languageService.GetAllLanguages()).FirstOrDefault();
}
- var liquidObject = new LiquidObject();
- await _messageTokenProvider.AddStoreTokens(liquidObject, store, language, emailAccount);
- await _messageTokenProvider.AddCustomerTokens(liquidObject, customer, store, language);
- await _messageTokenProvider.AddShoppingCartTokens(liquidObject, customer, store, language);
- await _messageTokenProvider.AddOrderTokens(liquidObject, order, customer, await _storeService.GetStoreById(order.StoreId));
+ var builder = new LiquidObjectBuilder(_mediator);
+ builder.AddStoreTokens(store, language, emailAccount)
+ .AddCustomerTokens(customer, store, language)
+ .AddShoppingCartTokens(customer, store, language)
+ .AddOrderTokens(order, customer, await _storeService.GetStoreById(order.StoreId));
+ var liquidObject = await builder.BuildAsync();
var body = LiquidExtensions.Render(liquidObject, reminderLevel.Body);
var subject = LiquidExtensions.Render(liquidObject, reminderLevel.Subject);
diff --git a/src/Business/Grand.Business.Messages/Interfaces/IMessageTokenProvider.cs b/src/Business/Grand.Business.Messages/Interfaces/IMessageTokenProvider.cs
index c3f32e644..d12f1ea49 100644
--- a/src/Business/Grand.Business.Messages/Interfaces/IMessageTokenProvider.cs
+++ b/src/Business/Grand.Business.Messages/Interfaces/IMessageTokenProvider.cs
@@ -15,24 +15,6 @@ namespace Grand.Business.Messages.Interfaces
{
public partial interface IMessageTokenProvider
{
- Task AddStoreTokens(LiquidObject liquidObject, Store store, Language language, EmailAccount emailAccount);
- Task AddOrderTokens(LiquidObject liquidObject, Order order, Customer customer, Store store, OrderNote orderNote = null, Vendor vendor = null, decimal refundedAmount = 0);
- Task AddShipmentTokens(LiquidObject liquidObject, Shipment shipment, Order order, Store store, Language language);
- Task AddMerchandiseReturnTokens(LiquidObject liquidObject, MerchandiseReturn merchandiseReturn, Store store, Order orderItem, Language language, MerchandiseReturnNote merchandiseReturnNote = null);
- Task AddGiftVoucherTokens(LiquidObject liquidObject, GiftVoucher giftVoucher, Language language);
- Task AddCustomerTokens(LiquidObject liquidObject, Customer customer, Store store, Language language, CustomerNote customerNote = null);
- Task AddShoppingCartTokens(LiquidObject liquidObject, Customer customer, Store store, Language language, string personalMessage = "", string customerEmail = "");
- Task AddVendorTokens(LiquidObject liquidObject, Vendor vendor, Language language);
- Task AddNewsLetterSubscriptionTokens(LiquidObject liquidObject, NewsLetterSubscription subscription, Store store);
- Task AddProductReviewTokens(LiquidObject liquidObject, Product product, ProductReview productReview);
- Task AddVendorReviewTokens(LiquidObject liquidObject, Vendor vendor, VendorReview VendorReview);
- Task AddBlogCommentTokens(LiquidObject liquidObject, BlogPost blogPost, BlogComment blogComment, Store store, Language language);
- Task AddArticleCommentTokens(LiquidObject liquidObject, KnowledgebaseArticle article, KnowledgebaseArticleComment articleComment, Store store, Language language);
- Task AddNewsCommentTokens(LiquidObject liquidObject, NewsItem newsItem, NewsComment newsComment, Store store, Language language);
- Task AddProductTokens(LiquidObject liquidObject, Product product, Language language, Store store);
- Task AddAttributeCombinationTokens(LiquidObject liquidObject, Product product, ProductAttributeCombination combination);
- Task AddOutOfStockTokens(LiquidObject liquidObject, Product product, OutOfStockSubscription subscription, Store store, Language language);
- Task AddAuctionTokens(LiquidObject liquidObject, Product product, Bid bid);
string[] GetListOfCampaignAllowedTokens();
string[] GetListOfAllowedTokens();
string[] GetListOfCustomerReminderAllowedTokens(CustomerReminderRuleEnum rule);
diff --git a/src/Business/Grand.Business.Messages/Services/MessageProviderService.cs b/src/Business/Grand.Business.Messages/Services/MessageProviderService.cs
index bfe2578f6..f959af9c3 100644
--- a/src/Business/Grand.Business.Messages/Services/MessageProviderService.cs
+++ b/src/Business/Grand.Business.Messages/Services/MessageProviderService.cs
@@ -160,10 +160,11 @@ namespace Grand.Business.Messages.Services
//email account
var emailAccount = await GetEmailAccountOfMessageTemplate(messageTemplate, language.Id);
- LiquidObject liquidObject = new LiquidObject();
- await _messageTokenProvider.AddStoreTokens(liquidObject, store, language, emailAccount);
- await _messageTokenProvider.AddCustomerTokens(liquidObject, customer, store, language, customerNote);
+ var builder = new LiquidObjectBuilder(_mediator);
+ builder.AddStoreTokens(store, language, emailAccount)
+ .AddCustomerTokens(customer, store, language, customerNote);
+ LiquidObject liquidObject = await builder.BuildAsync();
//event notification
await _mediator.MessageTokensAdded(messageTemplate, liquidObject);
diff --git a/src/Business/Grand.Business.Messages/Services/MessageTokenProvider.cs b/src/Business/Grand.Business.Messages/Services/MessageTokenProvider.cs
index 394c7cd2d..148be7845 100644
--- a/src/Business/Grand.Business.Messages/Services/MessageTokenProvider.cs
+++ b/src/Business/Grand.Business.Messages/Services/MessageTokenProvider.cs
@@ -20,21 +20,7 @@ namespace Grand.Business.Messages.Services
{
public partial class MessageTokenProvider : IMessageTokenProvider
{
- #region Fields
-
- private readonly IMediator _mediator;
-
- #endregion
-
- #region Ctor
-
- public MessageTokenProvider(IMediator mediator)
- {
- _mediator = mediator;
- }
-
- #endregion
-
+
#region Methods
/// <summary>
@@ -101,154 +87,6 @@ namespace Grand.Business.Messages.Services
return allowedTokens.ToArray();
}
- public async Task AddStoreTokens(LiquidObject liquidObject, Store store, Language language, EmailAccount emailAccount)
- {
- var liquidStore = await _mediator.Send(new GetStoreTokensCommand() { Store = store, Language = language, EmailAccount = emailAccount });
- liquidObject.Store = liquidStore;
-
- await _mediator.EntityTokensAdded(store, liquidStore, liquidObject);
- }
-
- public async Task AddOrderTokens(LiquidObject liquidObject, Order order, Customer customer, Store store, OrderNote orderNote = null, Vendor vendor = null, decimal refundedAmount = 0)
- {
- var liquidOrder = await _mediator.Send(new GetOrderTokensCommand()
- {
- Order = order,
- Customer = customer,
- Vendor = vendor,
- Store = store,
- OrderNote = orderNote,
- RefundedAmount = refundedAmount
- });
- liquidObject.Order = liquidOrder;
- await _mediator.EntityTokensAdded(order, liquidOrder, liquidObject);
- }
-
- public async Task AddShipmentTokens(LiquidObject liquidObject, Shipment shipment, Order order, Store store, Language language)
- {
- var liquidShipment = await _mediator.Send(new GetShipmentTokensCommand() { Shipment = shipment, Order = order, Store = store, Language = language });
- liquidObject.Shipment = liquidShipment;
- await _mediator.EntityTokensAdded(shipment, liquidShipment, liquidObject);
- }
-
- public async Task AddMerchandiseReturnTokens(LiquidObject liquidObject, MerchandiseReturn merchandiseReturn, Store store, Order order, Language language, MerchandiseReturnNote merchandiseReturnNote = null)
- {
- var liquidMerchandiseReturn = await _mediator.Send(new GetMerchandiseReturnTokensCommand() { Order = order, Language = language, MerchandiseReturn = merchandiseReturn, MerchandiseReturnNote = merchandiseReturnNote, Store = store });
- liquidObject.MerchandiseReturn = liquidMerchandiseReturn;
-
- await _mediator.EntityTokensAdded(merchandiseReturn, liquidMerchandiseReturn, liquidObject);
- }
-
- public async Task AddGiftVoucherTokens(LiquidObject liquidObject, GiftVoucher giftVoucher, Language language)
- {
- var liquidGiftCart = await _mediator.Send(new GetGiftVoucherTokensCommand() { GiftVoucher = giftVoucher, Language = language });
- liquidObject.GiftVoucher = liquidGiftCart;
- await _mediator.EntityTokensAdded(giftVoucher, liquidGiftCart, liquidObject);
- }
-
- public async Task AddCustomerTokens(LiquidObject liquidObject, Customer customer, Store store, Language language, CustomerNote customerNote = null)
- {
- var liquidCustomer = new LiquidCustomer(customer, store, customerNote);
- liquidObject.Customer = liquidCustomer;
-
- await _mediator.EntityTokensAdded(customer, liquidCustomer, liquidObject);
- if (customerNote != null)
- await _mediator.EntityTokensAdded(customerNote, liquidCustomer, liquidObject);
- }
-
- public async Task AddShoppingCartTokens(LiquidObject liquidObject, Customer customer, Store store, Language language,
- string personalMessage = "", string customerEmail = "")
- {
- var liquidShoppingCart = await _mediator.Send(new GetShoppingCartTokensCommand()
- {
- Customer = customer,
- CustomerEmail = customerEmail,
- Language = language,
- PersonalMessage = personalMessage,
- Store = store
- });
- liquidObject.ShoppingCart = liquidShoppingCart;
-
- await _mediator.EntityTokensAdded(customer, liquidShoppingCart, liquidObject);
- }
-
- public async Task AddVendorTokens(LiquidObject liquidObject, Vendor vendor, Language language)
- {
- var liquidVendor = await _mediator.Send(new GetVendorTokensCommand() { Vendor = vendor, Language = language });
- liquidObject.Vendor = liquidVendor;
- await _mediator.EntityTokensAdded(vendor, liquidVendor, liquidObject);
- }
-
- public async Task AddNewsLetterSubscriptionTokens(LiquidObject liquidObject, NewsLetterSubscription subscription, Store store)
- {
- var liquidNewsletterSubscription = new LiquidNewsLetterSubscription(subscription, store);
- liquidObject.NewsLetterSubscription = liquidNewsletterSubscription;
- await _mediator.EntityTokensAdded(subscription, liquidNewsletterSubscription, liquidObject);
- }
-
- public async Task AddProductReviewTokens(LiquidObject liquidObject, Product product, ProductReview productReview)
- {
- var liquidProductReview = new LiquidProductReview(product, productReview);
- liquidObject.ProductReview = liquidProductReview;
- await _mediator.EntityTokensAdded(productReview, liquidProductReview, liquidObject);
- }
-
- public async Task AddVendorReviewTokens(LiquidObject liquidObject, Vendor vendor, VendorReview vendorReview)
- {
- var liquidVendorReview = new LiquidVendorReview(vendor, vendorReview);
- liquidObject.VendorReview = liquidVendorReview;
- await _mediator.EntityTokensAdded(vendorReview, liquidVendorReview, liquidObject);
- }
-
- public async Task AddBlogCommentTokens(LiquidObject liquidObject, BlogPost blogPost, BlogComment blogComment, Store store, Language language)
- {
- var liquidBlogComment = new LiquidBlogComment(blogComment, blogPost, store, language);
- liquidObject.BlogComment = liquidBlogComment;
- await _mediator.EntityTokensAdded(blogComment, liquidBlogComment, liquidObject);
- }
-
- public async Task AddArticleCommentTokens(LiquidObject liquidObject, KnowledgebaseArticle article, KnowledgebaseArticleComment articleComment, Store store, Language language)
- {
- var liquidKnowledgebase = new LiquidKnowledgebase(article, articleComment, store, language);
- liquidObject.Knowledgebase = liquidKnowledgebase;
- await _mediator.EntityTokensAdded(articleComment, liquidKnowledgebase, liquidObject);
- }
-
- public async Task AddNewsCommentTokens(LiquidObject liquidObject, NewsItem newsItem, NewsComment newsComment, Store store, Language language)
- {
- var liquidNewsComment = new LiquidNewsComment(newsItem, newsComment, store, language);
- liquidObject.NewsComment = liquidNewsComment;
- await _mediator.EntityTokensAdded(newsComment, liquidNewsComment, liquidObject);
- }
-
- public async Task AddProductTokens(LiquidObject liquidObject, Product product, Language language, Store store)
- {
- var liquidProduct = new LiquidProduct(product, language, store);
- liquidObject.Product = liquidProduct;
- await _mediator.EntityTokensAdded(product, liquidProduct, liquidObject);
- }
-
- public async Task AddAttributeCombinationTokens(LiquidObject liquidObject, Product product, ProductAttributeCombination combination)
- {
- var liquidAttributeCombination = await _mediator.Send(new GetAttributeCombinationTokensCommand() { Product = product, Combination = combination });
- liquidObject.AttributeCombination = liquidAttributeCombination;
- await _mediator.EntityTokensAdded(combination, liquidAttributeCombination, liquidObject);
- }
-
- public async Task AddOutOfStockTokens(LiquidObject liquidObject, Product product, OutOfStockSubscription subscription, Store store, Language language)
- {
- var liquidOutOfStockSubscription = new LiquidOutOfStockSubscription(product, subscription, store, language);
- liquidObject.OutOfStockSubscription = liquidOutOfStockSubscription;
- await _mediator.EntityTokensAdded(subscription, liquidOutOfStockSubscription, liquidObject);
- }
-
- public async Task AddAuctionTokens(LiquidObject liquidObject, Product product, Bid bid)
- {
- var liquidAuctions = await _mediator.Send(new GetAuctionTokensCommand() { Product = product, Bid = bid });
- liquidObject.Auctions = liquidAuctions;
- await _mediator.EntityTokensAdded(bid, liquidAuctions, liquidObject);
- }
-
#endregion
}
}
\ No newline at end of file