/// <param name="selectedAttributes">Attributes explicitly selected by user or by query string.</param>
public ProductDetailsModel PrepareProductDetailModel(
ProductDetailsModel model,
Product product,
bool isAssociatedProduct = false,
ProductBundleItemData productBundleItem = null,
IList<ProductBundleItemData> productBundleItems = null,
NameValueCollection selectedAttributes = null,
int selectedQuantity = 1)
{
if (product == null)
throw new ArgumentNullException("product");
if (model == null)
throw new ArgumentNullException("model");
if (selectedAttributes == null)
selectedAttributes = new NameValueCollection();
var store = _services.StoreContext.CurrentStore;
var customer = _services.WorkContext.CurrentCustomer;
var currency = _services.WorkContext.WorkingCurrency;
decimal preSelectedPriceAdjustmentBase = decimal.Zero;
decimal preSelectedWeightAdjustment = decimal.Zero;
bool displayPrices = _services.Permissions.Authorize(StandardPermissionProvider.DisplayPrices);
bool isBundle = (product.ProductType == ProductType.BundledProduct);
bool isBundleItemPricing = (productBundleItem != null && productBundleItem.Item.BundleProduct.BundlePerItemPricing);
bool isBundlePricing = (productBundleItem != null && !productBundleItem.Item.BundleProduct.BundlePerItemPricing);
int bundleItemId = (productBundleItem == null ? 0 : productBundleItem.Item.Id);
bool hasSelectedAttributesValues = false;
bool hasSelectedAttributes = (selectedAttributes.Count > 0);
List<ProductVariantAttributeValue> selectedAttributeValues = null;
var variantAttributes = (isBundle ? new List<ProductVariantAttribute>() : _productAttributeService.GetProductVariantAttributesByProductId(product.Id));
model.ProductPrice.DynamicPriceUpdate = _catalogSettings.EnableDynamicPriceUpdate;
model.ProductPrice.BundleItemShowBasePrice = _catalogSettings.BundleItemShowBasePrice;
if (!model.ProductPrice.DynamicPriceUpdate)
selectedQuantity = 1;
#region Product attributes
if (!isBundle) // bundles doesn't have attributes
{
foreach (var attribute in variantAttributes)
{
var pvaModel = new ProductDetailsModel.ProductVariantAttributeModel
{
Id = attribute.Id,
ProductId = attribute.ProductId,
BundleItemId = bundleItemId,
ProductAttributeId = attribute.ProductAttributeId,
Alias = attribute.ProductAttribute.Alias,
Name = attribute.ProductAttribute.GetLocalized(x => x.Name),
Description = attribute.ProductAttribute.GetLocalized(x => x.Description),
TextPrompt = attribute.TextPrompt,
IsRequired = attribute.IsRequired,
AttributeControlType = attribute.AttributeControlType,
AllowedFileExtensions = _catalogSettings.FileUploadAllowedExtensions
};
if (attribute.AttributeControlType == AttributeControlType.Datepicker)
{
if (pvaModel.Alias.HasValue() && RegularExpressions.IsYearRange.IsMatch(pvaModel.Alias))
{
var match = RegularExpressions.IsYearRange.Match(pvaModel.Alias);
pvaModel.BeginYear = match.Groups[1].Value.ToInt();
pvaModel.EndYear = match.Groups[2].Value.ToInt();
}
if (hasSelectedAttributes)
{
var attributeKey = "product_attribute_{0}_{1}_{2}_{3}".FormatInvariant(product.Id, bundleItemId, attribute.ProductAttributeId, attribute.Id);
var day = selectedAttributes[attributeKey + "_day"].ToInt();
var month = selectedAttributes[attributeKey + "_month"].ToInt();
var year = selectedAttributes[attributeKey + "_year"].ToInt();
if (day > 0 && month > 0 && year > 0)
{
pvaModel.SelectedDay = day;
pvaModel.SelectedMonth = month;
pvaModel.SelectedYear = year;
}
}
}
else if (attribute.AttributeControlType == AttributeControlType.TextBox || attribute.AttributeControlType == AttributeControlType.MultilineTextbox)
{
if (hasSelectedAttributes)
{
var attributeKey = "product_attribute_{0}_{1}_{2}_{3}".FormatInvariant(product.Id, bundleItemId, attribute.ProductAttributeId, attribute.Id);
pvaModel.TextValue = selectedAttributes[attributeKey];
}
}
var preSelectedValueId = 0;
var pvaValues = (attribute.ShouldHaveValues() ? _productAttributeService.GetProductVariantAttributeValues(attribute.Id) : new List<ProductVariantAttributeValue>());
foreach (var pvaValue in pvaValues)
{
ProductBundleItemAttributeFilter attributeFilter = null;
if (productBundleItem.FilterOut(pvaValue, out attributeFilter))
continue;
if (preSelectedValueId == 0 && attributeFilter != null && attributeFilter.IsPreSelected)
preSelectedValueId = attributeFilter.AttributeValueId;
var linkedProduct = _productService.GetProductById(pvaValue.LinkedProductId);
var pvaValueModel = new ProductDetailsModel.ProductVariantAttributeValueModel();
pvaValueModel.Id = pvaValue.Id;
pvaValueModel.Name = pvaValue.GetLocalized(x => x.Name);
pvaValueModel.Alias = pvaValue.Alias;
pvaValueModel.ColorSquaresRgb = pvaValue.ColorSquaresRgb; //used with "Color squares" attribute type
pvaValueModel.IsPreSelected = pvaValue.IsPreSelected;
if (linkedProduct != null && linkedProduct.VisibleIndividually)
pvaValueModel.SeName = linkedProduct.GetSeName();
if (hasSelectedAttributes)
pvaValueModel.IsPreSelected = false; // explicitly selected always discards pre-selected by merchant
// display price if allowed
if (displayPrices && !isBundlePricing)
{
decimal taxRate = decimal.Zero;
decimal attributeValuePriceAdjustment = _priceCalculationService.GetProductVariantAttributeValuePriceAdjustment(pvaValue);
decimal priceAdjustmentBase = _taxService.GetProductPrice(product, attributeValuePriceAdjustment, out taxRate);
decimal priceAdjustment = _currencyService.ConvertFromPrimaryStoreCurrency(priceAdjustmentBase, currency);
if (priceAdjustmentBase > decimal.Zero)
pvaValueModel.PriceAdjustment = "+" + _priceFormatter.FormatPrice(priceAdjustment, true, false);
else if (priceAdjustmentBase < decimal.Zero)
pvaValueModel.PriceAdjustment = "-" + _priceFormatter.FormatPrice(-priceAdjustment, true, false);
if (pvaValueModel.IsPreSelected)
{
preSelectedPriceAdjustmentBase = decimal.Add(preSelectedPriceAdjustmentBase, priceAdjustmentBase);
preSelectedWeightAdjustment = decimal.Add(preSelectedWeightAdjustment, pvaValue.WeightAdjustment);
}
if (_catalogSettings.ShowLinkedAttributeValueQuantity && pvaValue.ValueType == ProductVariantAttributeValueType.ProductLinkage)
{
pvaValueModel.QuantityInfo = pvaValue.Quantity;
}
pvaValueModel.PriceAdjustmentValue = priceAdjustment;
}
if (!_catalogSettings.ShowVariantCombinationPriceAdjustment)
{
pvaValueModel.PriceAdjustment = "";
}
if (_catalogSettings.ShowLinkedAttributeValueImage && pvaValue.ValueType == ProductVariantAttributeValueType.ProductLinkage)
{
var linkagePicture = _pictureService.GetPicturesByProductId(pvaValue.LinkedProductId, 1).FirstOrDefault();
if (linkagePicture != null)
pvaValueModel.ImageUrl = _pictureService.GetPictureUrl(linkagePicture, _mediaSettings.VariantValueThumbPictureSize, false);
}
pvaModel.Values.Add(pvaValueModel);
}
// we need selected attributes to get initially displayed combination images
if (!hasSelectedAttributes)
{
ProductDetailsModel.ProductVariantAttributeValueModel defaultValue = null;
if (preSelectedValueId != 0) // value pre-selected by a bundle item filter discards the default pre-selection
{
pvaModel.Values.Each(x => x.IsPreSelected = false);
if ((defaultValue = pvaModel.Values.FirstOrDefault(v => v.Id == preSelectedValueId)) != null)
{
defaultValue.IsPreSelected = true;
selectedAttributes.AddProductAttribute(attribute.ProductAttributeId, attribute.Id, defaultValue.Id, product.Id, bundleItemId);
}
}
if (defaultValue == null)
{
foreach (var value in pvaModel.Values.Where(x => x.IsPreSelected))
{
selectedAttributes.AddProductAttribute(attribute.ProductAttributeId, attribute.Id, value.Id, product.Id, bundleItemId);
}
}
//if (defaultValue == null)
// defaultValue = pvaModel.Values.FirstOrDefault(v => v.IsPreSelected);
//if (defaultValue != null)
// selectedAttributes.AddProductAttribute(attribute.ProductAttributeId, attribute.Id, defaultValue.Id, product.Id, bundleItemId);
}
model.ProductVariantAttributes.Add(pvaModel);
}
}
#endregion
#region Attribute combinations
if (!isBundle)
{
if (selectedAttributes.Count > 0)
{
// merge with combination data if there's a match
var warnings = new List<string>();
string attributeXml = selectedAttributes.CreateSelectedAttributesXml(product.Id, variantAttributes, _productAttributeParser, _localizationService,
_downloadService, _catalogSettings, _httpRequest, warnings, true, bundleItemId);
selectedAttributeValues = _productAttributeParser.ParseProductVariantAttributeValues(attributeXml).ToList();
hasSelectedAttributesValues = (selectedAttributeValues.Count > 0);
if (isBundlePricing)
{
model.AttributeInfo = _productAttributeFormatter.FormatAttributes(product, attributeXml, customer,
renderPrices: false, renderGiftCardAttributes: false, allowHyperlinks: false);
}
model.SelectedCombination = _productAttributeParser.FindProductVariantAttributeCombination(product.Id, attributeXml);
if (model.SelectedCombination != null && model.SelectedCombination.IsActive == false)
{
model.IsAvailable = false;
model.StockAvailability = T("Products.Availability.IsNotActive");
}
product.MergeWithCombination(model.SelectedCombination);
// mark explicitly selected as pre-selected
foreach (var attribute in model.ProductVariantAttributes)
{
foreach (var value in attribute.Values)
{
if (selectedAttributeValues.FirstOrDefault(v => v.Id == value.Id) != null)
value.IsPreSelected = true;
if (!_catalogSettings.ShowVariantCombinationPriceAdjustment)
value.PriceAdjustment = "";
}
}
}
}
#endregion
#region Properties
if ((productBundleItem != null && !productBundleItem.Item.BundleProduct.BundlePerItemShoppingCart) ||
(product.ManageInventoryMethod == ManageInventoryMethod.ManageStockByAttributes && !hasSelectedAttributesValues))
{
// cases where stock inventory is not functional. determined by what ShoppingCartService.GetStandardWarnings and ProductService.AdjustInventory is not handling.
model.IsAvailable = true;
var hasAttributeCombinations = _services.DbContext.QueryForCollection(product, (Product p) => p.ProductVariantAttributeCombinations).Any();
model.StockAvailability = !hasAttributeCombinations ? product.FormatStockMessage(_localizationService) : "";
}
else if (model.IsAvailable)
{
model.IsAvailable = product.IsAvailableByStock();
model.StockAvailability = product.FormatStockMessage(_localizationService);
}
model.Id = product.Id;
model.Name = product.GetLocalized(x => x.Name);
model.ShowSku = _catalogSettings.ShowProductSku;
model.Sku = product.Sku;
model.ShortDescription = product.GetLocalized(x => x.ShortDescription);
model.FullDescription = product.GetLocalized(x => x.FullDescription);
model.MetaKeywords = product.GetLocalized(x => x.MetaKeywords);
model.MetaDescription = product.GetLocalized(x => x.MetaDescription);
model.MetaTitle = product.GetLocalized(x => x.MetaTitle);
model.SeName = product.GetSeName();
model.ShowManufacturerPartNumber = _catalogSettings.ShowManufacturerPartNumber;
model.ManufacturerPartNumber = product.ManufacturerPartNumber;
model.ShowDimensions = _catalogSettings.ShowDimensions;
model.ShowWeight = _catalogSettings.ShowWeight;
model.ShowGtin = _catalogSettings.ShowGtin;
model.Gtin = product.Gtin;
model.HasSampleDownload = product.IsDownload && product.HasSampleDownload;
model.IsCurrentCustomerRegistered = customer.IsRegistered();
model.IsBasePriceEnabled = product.BasePriceEnabled;
model.BasePriceInfo = product.GetBasePriceInfo(_localizationService, _priceFormatter, _currencyService, _taxService, _priceCalculationService, currency);
model.ShowLegalInfo = _taxSettings.ShowLegalHintsInProductDetails;
model.BundleTitleText = product.GetLocalized(x => x.BundleTitleText);
model.BundlePerItemPricing = product.BundlePerItemPricing;
model.BundlePerItemShipping = product.BundlePerItemShipping;
model.BundlePerItemShoppingCart = product.BundlePerItemShoppingCart;
//_taxSettings.TaxDisplayType == TaxDisplayType.ExcludingTax;
var taxDisplayType = _services.WorkContext.GetTaxDisplayTypeFor(customer, store.Id);
string taxInfo = T(taxDisplayType == TaxDisplayType.IncludingTax ? "Tax.InclVAT" : "Tax.ExclVAT");
var defaultTaxRate = "";
var taxrate = Convert.ToString(_taxService.GetTaxRate(product, customer));
if (_taxSettings.DisplayTaxRates && !taxrate.Equals("0", StringComparison.InvariantCultureIgnoreCase))
{
defaultTaxRate = "({0}%)".FormatWith(taxrate);
}
var additionalShippingCosts = String.Empty;
var addShippingPrice = _currencyService.ConvertFromPrimaryStoreCurrency(product.AdditionalShippingCharge, currency);
if (addShippingPrice > 0)
{
additionalShippingCosts = T("Common.AdditionalShippingSurcharge").Text.FormatInvariant(_priceFormatter.FormatPrice(addShippingPrice, true, false)) + ", ";
}
if (!product.IsShipEnabled || (addShippingPrice == 0 && product.IsFreeShipping))
{
model.LegalInfo += "{0} {1}, {2}".FormatInvariant(
product.IsTaxExempt ? "" : taxInfo,
product.IsTaxExempt ? "" : defaultTaxRate,
T("Common.FreeShipping"));
}
else
{
var topic = _topicService.Value.GetTopicBySystemName("ShippingInfo", store.Id);
if (topic == null)
{
model.LegalInfo = T("Tax.LegalInfoProductDetail2",
product.IsTaxExempt ? "" : taxInfo,
product.IsTaxExempt ? "" : defaultTaxRate,
additionalShippingCosts);
}
else
{
model.LegalInfo = T("Tax.LegalInfoProductDetail",
product.IsTaxExempt ? "" : taxInfo,
product.IsTaxExempt ? "" : defaultTaxRate,
additionalShippingCosts,
_urlHelper.RouteUrl("Topic", new { SystemName = "shippinginfo" }));
}
}
var dimension = _measureService.GetMeasureDimensionById(_measureSettings.BaseDimensionId).Name;
model.WeightValue = product.Weight;
if (!isBundle)
{
if (selectedAttributeValues != null)
{
foreach (var attributeValue in selectedAttributeValues)
model.WeightValue = decimal.Add(model.WeightValue, attributeValue.WeightAdjustment);
}
else
{
model.WeightValue = decimal.Add(model.WeightValue, preSelectedWeightAdjustment);
}
}
model.Weight = (model.WeightValue > 0) ? "{0} {1}".FormatCurrent(model.WeightValue.ToString("F2"), _measureService.GetMeasureWeightById(_measureSettings.BaseWeightId).Name) : "";
model.Height = (product.Height > 0) ? "{0} {1}".FormatCurrent(product.Height.ToString("F2"), dimension) : "";
model.Length = (product.Length > 0) ? "{0} {1}".FormatCurrent(product.Length.ToString("F2"), dimension) : "";
model.Width = (product.Width > 0) ? "{0} {1}".FormatCurrent(product.Width.ToString("F2"), dimension) : "";
if (productBundleItem != null)
model.ThumbDimensions = _mediaSettings.BundledProductPictureSize;
else if (isAssociatedProduct)
model.ThumbDimensions = _mediaSettings.AssociatedProductPictureSize;
if (model.IsAvailable)
{
var deliveryTime = _deliveryTimeService.GetDeliveryTime(product);
if (deliveryTime != null)
{
model.DeliveryTimeName = deliveryTime.GetLocalized(x => x.Name);
model.DeliveryTimeHexValue = deliveryTime.ColorHexValue;
}
}
model.DisplayDeliveryTime = _catalogSettings.ShowDeliveryTimesInProductDetail;
model.IsShipEnabled = product.IsShipEnabled;
model.DisplayDeliveryTimeAccordingToStock = product.DisplayDeliveryTimeAccordingToStock(_catalogSettings);
if (model.DeliveryTimeName.IsEmpty() && model.DisplayDeliveryTime)
{
model.DeliveryTimeName = T("ShoppingCart.NotAvailable");
}
var quantityUnit = _quantityUnitService.GetQuantityUnit(product);
if (quantityUnit != null)
{
model.QuantityUnitName = quantityUnit.GetLocalized(x => x.Name);
}
//back in stock subscriptions)
if (product.ManageInventoryMethod == ManageInventoryMethod.ManageStock &&
product.BackorderMode == BackorderMode.NoBackorders &&
product.AllowBackInStockSubscriptions &&
product.StockQuantity <= 0)
{
//out of stock
model.DisplayBackInStockSubscription = true;
model.BackInStockAlreadySubscribed = _backInStockSubscriptionService.FindSubscription(customer.Id, product.Id, store.Id) != null;
}
#endregion
#region Product price
model.ProductPrice.ProductId = product.Id;
if (displayPrices)
{
model.ProductPrice.HidePrices = false;
if (product.CustomerEntersPrice && !isBundleItemPricing)
{
model.ProductPrice.CustomerEntersPrice = true;
}
else
{
if (product.CallForPrice && !isBundleItemPricing)
{
model.ProductPrice.CallForPrice = true;
}
else
{
decimal taxRate = decimal.Zero;
decimal oldPrice = decimal.Zero;
decimal finalPriceWithoutDiscountBase = decimal.Zero;
decimal finalPriceWithDiscountBase = decimal.Zero;
decimal attributesTotalPriceBase = decimal.Zero;
decimal finalPriceWithoutDiscount = decimal.Zero;
decimal finalPriceWithDiscount = decimal.Zero;
decimal oldPriceBase = _taxService.GetProductPrice(product, product.OldPrice, out taxRate);
if (model.ProductPrice.DynamicPriceUpdate && !isBundlePricing)
{
if (selectedAttributeValues != null)
{
selectedAttributeValues.Each(x => attributesTotalPriceBase += _priceCalculationService.GetProductVariantAttributeValuePriceAdjustment(x));
}
else
{
attributesTotalPriceBase = preSelectedPriceAdjustmentBase;
}
}
if (productBundleItem != null)
{
productBundleItem.AdditionalCharge = attributesTotalPriceBase;
}
finalPriceWithoutDiscountBase = _priceCalculationService.GetFinalPrice(product, productBundleItems,
customer, attributesTotalPriceBase, false, selectedQuantity, productBundleItem);
finalPriceWithDiscountBase = _priceCalculationService.GetFinalPrice(product, productBundleItems,
customer, attributesTotalPriceBase, true, selectedQuantity, productBundleItem);
finalPriceWithoutDiscountBase = _taxService.GetProductPrice(product, finalPriceWithoutDiscountBase, out taxRate);
finalPriceWithDiscountBase = _taxService.GetProductPrice(product, finalPriceWithDiscountBase, out taxRate);
oldPrice = _currencyService.ConvertFromPrimaryStoreCurrency(oldPriceBase, _services.WorkContext.WorkingCurrency);
finalPriceWithoutDiscount = _currencyService.ConvertFromPrimaryStoreCurrency(finalPriceWithoutDiscountBase, currency);
finalPriceWithDiscount = _currencyService.ConvertFromPrimaryStoreCurrency(finalPriceWithDiscountBase, currency);
if (productBundleItem == null || isBundleItemPricing)
{
if (finalPriceWithoutDiscountBase != oldPriceBase && oldPriceBase > decimal.Zero)
model.ProductPrice.OldPrice = _priceFormatter.FormatPrice(oldPrice);
model.ProductPrice.Price = _priceFormatter.FormatPrice(finalPriceWithoutDiscount);
if (finalPriceWithoutDiscountBase != finalPriceWithDiscountBase)
model.ProductPrice.PriceWithDiscount = _priceFormatter.FormatPrice(finalPriceWithDiscount);
}
model.ProductPrice.PriceValue = finalPriceWithoutDiscount;
model.ProductPrice.PriceWithDiscountValue = finalPriceWithDiscount;
model.BasePriceInfo = product.GetBasePriceInfo(
_localizationService,
_priceFormatter,
_currencyService,
_taxService,
_priceCalculationService,
currency,
attributesTotalPriceBase);
if (!string.IsNullOrWhiteSpace(model.ProductPrice.OldPrice) || !string.IsNullOrWhiteSpace(model.ProductPrice.PriceWithDiscount))
{
model.ProductPrice.NoteWithoutDiscount = T(isBundle && product.BundlePerItemPricing ? "Products.Bundle.PriceWithoutDiscount.Note" : "Products.Price");
}
if ((isBundle && product.BundlePerItemPricing && !string.IsNullOrWhiteSpace(model.ProductPrice.PriceWithDiscount)) || product.HasTierPrices)
{
if (!product.HasTierPrices)
{
model.ProductPrice.NoteWithDiscount = T("Products.Bundle.PriceWithDiscount.Note");
}
model.BasePriceInfo = product.GetBasePriceInfo(
_localizationService,
_priceFormatter,
_currencyService,
_taxService,
_priceCalculationService,
currency,
(product.Price - finalPriceWithDiscount) * (-1));
}
}
}
}
else
{
model.ProductPrice.HidePrices = true;
model.ProductPrice.OldPrice = null;
model.ProductPrice.Price = null;
}
#endregion
#region 'Add to cart' model
model.AddToCart.ProductId = product.Id;
//quantity
model.AddToCart.EnteredQuantity = product.OrderMinimumQuantity;
//'add to cart', 'add to wishlist' buttons
model.AddToCart.DisableBuyButton = product.DisableBuyButton || !_services.Permissions.Authorize(StandardPermissionProvider.EnableShoppingCart);
model.AddToCart.DisableWishlistButton = product.DisableWishlistButton || !_services.Permissions.Authorize(StandardPermissionProvider.EnableWishlist);
if (!displayPrices)
{
model.AddToCart.DisableBuyButton = true;
model.AddToCart.DisableWishlistButton = true;
}
//pre-order
model.AddToCart.AvailableForPreOrder = product.AvailableForPreOrder;
//customer entered price
model.AddToCart.CustomerEntersPrice = product.CustomerEntersPrice;
if (model.AddToCart.CustomerEntersPrice)
{
var minimumCustomerEnteredPrice = _currencyService.ConvertFromPrimaryStoreCurrency(product.MinimumCustomerEnteredPrice, currency);
var maximumCustomerEnteredPrice = _currencyService.ConvertFromPrimaryStoreCurrency(product.MaximumCustomerEnteredPrice, currency);
model.AddToCart.CustomerEnteredPrice = minimumCustomerEnteredPrice;
model.AddToCart.CustomerEnteredPriceRange = string.Format(T("Products.EnterProductPrice.Range"),
_priceFormatter.FormatPrice(minimumCustomerEnteredPrice, true, false),
_priceFormatter.FormatPrice(maximumCustomerEnteredPrice, true, false));
}
//allowed quantities
var allowedQuantities = product.ParseAllowedQuatities();
foreach (var qty in allowedQuantities)
{
model.AddToCart.AllowedQuantities.Add(new SelectListItem
{
Text = qty.ToString(),
Value = qty.ToString()
});
}
#endregion
#region Gift card
model.GiftCard.IsGiftCard = product.IsGiftCard;
if (model.GiftCard.IsGiftCard)
{
model.GiftCard.GiftCardType = product.GiftCardType;
model.GiftCard.SenderName = customer.GetFullName();
model.GiftCard.SenderEmail = customer.Email;
}
#endregion
return model;
}