/// <summary>
/// Applies extra data to an expando object.
/// Export feature flags set by the export provider controls whether and what to be exported here.
/// </summary>
private async Task ApplyExportFeatures(
dynamic dynObject,
Product product,
CalculatedPrice price,
IEnumerable <ProductMediaFile> mediaFiles,
DataExporterContext ctx,
DynamicProductContext productContext)
{
if (ctx.Supports(ExportFeatures.CanProjectDescription))
{
await ApplyProductDescription(dynObject, product, ctx);
}
if (ctx.Supports(ExportFeatures.OffersBrandFallback))
{
string brand = null;
var productManus = await ctx.ProductBatchContext.ProductManufacturers.GetOrLoadAsync(product.Id);
if (productManus?.Any() ?? false)
{
var manufacturer = productManus.First().Manufacturer;
brand = ctx.GetTranslation(manufacturer, nameof(manufacturer.Name), manufacturer.Name);
}
if (brand.IsEmpty())
{
brand = ctx.Projection.Brand;
}
dynObject._Brand = brand;
}
if (ctx.Supports(ExportFeatures.CanIncludeMainPicture))
{
var imageQuery = ctx.Projection.PictureSize > 0 ? new ProcessImageQuery {
MaxWidth = ctx.Projection.PictureSize
} : null;
if (mediaFiles?.Any() ?? false)
{
var file = _mediaService.ConvertMediaFile(mediaFiles.Select(x => x.MediaFile).First());
dynObject._MainPictureUrl = _mediaService.GetUrl(file, imageQuery, ctx.Store.GetHost());
dynObject._MainPictureRelativeUrl = _mediaService.GetUrl(file, imageQuery);
}
else if (!_catalogSettings.HideProductDefaultPictures)
{
// Get fallback image URL.
dynObject._MainPictureUrl = _mediaService.GetUrl(null, imageQuery, ctx.Store.GetHost());
dynObject._MainPictureRelativeUrl = _mediaService.GetUrl(null, imageQuery);
}
else
{
dynObject._MainPictureUrl = null;
dynObject._MainPictureRelativeUrl = null;
}
}
if (ctx.Supports(ExportFeatures.UsesSkuAsMpnFallback) && product.ManufacturerPartNumber.IsEmpty())
{
dynObject.ManufacturerPartNumber = product.Sku;
}
if (ctx.Supports(ExportFeatures.OffersShippingTimeFallback))
{
dynamic deliveryTime = dynObject.DeliveryTime;
dynObject._ShippingTime = deliveryTime == null ? ctx.Projection.ShippingTime : deliveryTime.Name;
}
if (ctx.Supports(ExportFeatures.OffersShippingCostsFallback))
{
dynObject._FreeShippingThreshold = ctx.Projection.FreeShippingThreshold;
dynObject._ShippingCosts = product.IsFreeShipping || (ctx.Projection.FreeShippingThreshold.HasValue && (decimal)dynObject.Price >= ctx.Projection.FreeShippingThreshold.Value)
? decimal.Zero
: ctx.Projection.ShippingCosts;
}
if (ctx.Supports(ExportFeatures.UsesOldPrice))
{
if (product.OldPrice != decimal.Zero && product.OldPrice != (decimal)dynObject.Price && !(product.ProductType == ProductType.BundledProduct && product.BundlePerItemPricing))
{
if (ctx.Projection.ConvertNetToGrossPrices)
{
var tax = await _taxCalculator.CalculateProductTaxAsync(product, product.OldPrice, true, ctx.ContextCustomer, ctx.ContextCurrency);
dynObject._OldPrice = tax.Price;
}
else
{
dynObject._OldPrice = product.OldPrice;
}
}
else
{
dynObject._OldPrice = null;
}
}
if (ctx.Supports(ExportFeatures.UsesSpecialPrice))
{
dynObject._SpecialPrice = null; // Special price which is valid now.
dynObject._FutureSpecialPrice = null; // Special price which is valid now and in future.
dynObject._RegularPrice = null; // Price as if a special price would not exist.
if (!(product.ProductType == ProductType.BundledProduct && product.BundlePerItemPricing))
{
if (price.OfferPrice.HasValue && product.SpecialPriceEndDateTimeUtc.HasValue)
{
var endDate = DateTime.SpecifyKind(product.SpecialPriceEndDateTimeUtc.Value, DateTimeKind.Utc);
if (endDate > DateTime.UtcNow)
{
dynObject._FutureSpecialPrice = price.OfferPrice.Value.Amount;
}
}
dynObject._SpecialPrice = price.OfferPrice?.Amount ?? null;
if (price.OfferPrice.HasValue || dynObject._FutureSpecialPrice != null)
{
var clonedOptions = ctx.PriceCalculationOptions.Clone();
clonedOptions.IgnoreOfferPrice = true;
var calculationContext = new PriceCalculationContext(product, clonedOptions);
calculationContext.AddSelectedAttributes(productContext?.Combination?.AttributeSelection, product.Id);
var priceWithoutOfferPrice = await _priceCalculationService.CalculatePriceAsync(calculationContext);
dynObject._RegularPrice = priceWithoutOfferPrice.FinalPrice.Amount;
}
}
}
}
/// <summary>
/// Creates an expando object with all product properties.
/// This method is used when exporting products and when exporting variant combinations as products.
/// </summary>
private async Task <dynamic> ToDynamic(Product product, bool isParent, DataExporterContext ctx, DynamicProductContext productContext)
{
var combination = productContext.Combination;
product.MergeWithCombination(combination);
var productManufacturers = await ctx.ProductBatchContext.ProductManufacturers.GetOrLoadAsync(product.Id);
var productCategories = await ctx.ProductBatchContext.ProductCategories.GetOrLoadAsync(product.Id);
var productAttributes = await ctx.ProductBatchContext.Attributes.GetOrLoadAsync(product.Id);
var productTags = await ctx.ProductBatchContext.ProductTags.GetOrLoadAsync(product.Id);
var specificationAttributes = await ctx.ProductBatchContext.SpecificationAttributes.GetOrLoadAsync(product.Id);
var selectedAttributes = combination?.AttributeSelection;
var variantAttributeValues = combination?.AttributeSelection?.MaterializeProductVariantAttributeValues(productAttributes);
// Price calculation.
var calculationContext = new PriceCalculationContext(product, ctx.PriceCalculationOptions);
calculationContext.AddSelectedAttributes(combination?.AttributeSelection, product.Id);
var price = await _priceCalculationService.CalculatePriceAsync(calculationContext);
dynamic dynObject = ToDynamic(product, ctx, productContext.SeName, price.FinalPrice);
dynObject._IsParent = isParent;
dynObject._CategoryName = null;
dynObject._CategoryPath = null;
dynObject._AttributeCombinationValues = null;
dynObject._AttributeCombinationId = 0;
dynObject.Price = price.FinalPrice.Amount;
if (combination != null)
{
dynObject._AttributeCombinationId = combination.Id;
dynObject._UniqueId = product.Id + "-" + combination.Id;
if (ctx.Supports(ExportFeatures.UsesAttributeCombination))
{
dynObject._AttributeCombinationValues = variantAttributeValues;
}
if (ctx.Projection.AttributeCombinationValueMerging == ExportAttributeValueMerging.AppendAllValuesToName)
{
var valueNames = variantAttributeValues
.Select(x => ctx.GetTranslation(x, nameof(x.Name), x.Name))
.ToList();
dynObject.Name = ((string)dynObject.Name).Grow(string.Join(", ", valueNames), " ");
}
}
else
{
dynObject._UniqueId = product.Id.ToString();
}
if (selectedAttributes?.AttributesMap?.Any() ?? false)
{
var query = new ProductVariantQuery();
await _productUrlHelper.AddAttributesToQueryAsync(query, selectedAttributes, product.Id, 0, productAttributes);
dynObject._DetailUrl = productContext.AbsoluteProductUrl + _productUrlHelper.ToQueryString(query);
}
else
{
dynObject._DetailUrl = productContext.AbsoluteProductUrl;
}
// Category path.
{
var categoryPath = string.Empty;
var pc = productCategories.OrderBy(x => x.DisplayOrder).FirstOrDefault();
if (pc != null)
{
var node = await _categoryService.GetCategoryTreeAsync(pc.CategoryId, true, ctx.Store.Id);
if (node != null)
{
categoryPath = _categoryService.GetCategoryPath(node, ctx.Projection.LanguageId, null, " > ");
}
}
dynObject._CategoryPath = categoryPath;
}
dynObject.CountryOfOrigin = ctx.Countries.TryGetValue(product.CountryOfOriginId ?? 0, out var countryOfOrigin)
? ToDynamic(countryOfOrigin, ctx)
: null;
dynObject.ProductManufacturers = productManufacturers
.OrderBy(x => x.DisplayOrder)
.Select(x =>
{
dynamic dyn = new DynamicEntity(x);
dyn.Manufacturer = ToDynamic(x.Manufacturer, ctx);
dyn.Manufacturer.Picture = x.Manufacturer != null && x.Manufacturer.MediaFileId.HasValue
? ToDynamic(x.Manufacturer.MediaFile, _mediaSettings.ManufacturerThumbPictureSize, _mediaSettings.ManufacturerThumbPictureSize, ctx)
: null;
return(dyn);
})
.ToList();
dynObject.ProductCategories = productCategories
.OrderBy(x => x.DisplayOrder)
.Select(x =>
{
dynamic dyn = new DynamicEntity(x);
dyn.Category = ToDynamic(x.Category, ctx);
dyn.Category.Picture = x.Category != null && x.Category.MediaFileId.HasValue
? ToDynamic(x.Category.MediaFile, _mediaSettings.CategoryThumbPictureSize, _mediaSettings.CategoryThumbPictureSize, ctx)
: null;
if (dynObject._CategoryName == null)
{
dynObject._CategoryName = (string)dyn.Category.Name;
}
return(dyn);
})
.ToList();
dynObject.ProductAttributes = productAttributes
.OrderBy(x => x.DisplayOrder)
.Select(x => ToDynamic(x, ctx))
.ToList();
// Do not export combinations if a combination is exported as a product.
if (productContext.Combinations != null && productContext.Combination == null)
{
var pictureSize = ctx.Projection.PictureSize > 0 ? ctx.Projection.PictureSize : _mediaSettings.ProductDetailsPictureSize;
var productMediaFiles = (await ctx.ProductBatchContext.ProductMediaFiles.GetOrLoadAsync(product.Id))
.ToDictionarySafe(x => x.MediaFileId, x => x);
dynObject.ProductAttributeCombinations = productContext.Combinations
.Select(x =>
{
dynamic dyn = DataExporter.ToDynamic(x, ctx);
var assignedFiles = new List <dynamic>();
foreach (var fileId in x.GetAssignedMediaIds().Take(ctx.Projection.NumberOfMediaFiles ?? int.MaxValue))
{
if (productMediaFiles.TryGetValue(fileId, out var assignedFile) && assignedFile.MediaFile != null)
{
assignedFiles.Add(ToDynamic(assignedFile.MediaFile, _mediaSettings.ProductThumbPictureSize, pictureSize, ctx));
}
}
dyn.Pictures = assignedFiles;
return(dyn);
})
.ToList();
}
else
{
dynObject.ProductAttributeCombinations = Enumerable.Empty <ProductVariantAttributeCombination>();
}
if (product.HasTierPrices)
{
var tierPrices = await ctx.ProductBatchContext.TierPrices.GetOrLoadAsync(product.Id);
dynObject.TierPrices = tierPrices
.RemoveDuplicatedQuantities()
.Select(x =>
{
dynamic dyn = new DynamicEntity(x);
return(dyn);
})
.ToList();
}
if (product.HasDiscountsApplied)
{
var appliedDiscounts = await ctx.ProductBatchContext.AppliedDiscounts.GetOrLoadAsync(product.Id);
dynObject.AppliedDiscounts = appliedDiscounts
.Select(x => CreateDynamic(x))
.ToList();
}
if (product.IsDownload)
{
var downloads = await ctx.ProductBatchContext.Downloads.GetOrLoadAsync(product.Id);
dynObject.Downloads = downloads
.Select(x => CreateDynamic(x))
.ToList();
}
dynObject.ProductTags = productTags
.Select(x =>
{
var localizedName = ctx.GetTranslation(x, nameof(x.Name), x.Name);
dynamic dyn = new DynamicEntity(x);
dyn.Name = localizedName;
dyn.SeName = SeoHelper.BuildSlug(localizedName, _seoSettings);
dyn._Localized = GetLocalized(ctx, x, y => y.Name);
return(dyn);
})
.ToList();
dynObject.ProductSpecificationAttributes = specificationAttributes
.Select(x => ToDynamic(x, ctx))
.ToList();
if (product.ProductType == ProductType.BundledProduct)
{
var bundleItems = await ctx.ProductBatchContext.ProductBundleItems.GetOrLoadAsync(product.Id);
dynObject.ProductBundleItems = bundleItems
.Select(x =>
{
dynamic dyn = new DynamicEntity(x);
dyn.Name = ctx.GetTranslation(x, nameof(x.Name), x.Name);
dyn.ShortDescription = ctx.GetTranslation(x, nameof(x.ShortDescription), x.ShortDescription);
dyn._Localized = GetLocalized(ctx, x, y => y.Name, y => y.ShortDescription);
return(dyn);
})
.ToList();
}
var mediaFiles = await ApplyMediaFiles(dynObject, product, ctx, productContext);
await ApplyExportFeatures(dynObject, product, price, mediaFiles, ctx, productContext);
return(dynObject);
}
