Merge pull request #36 from umbraco/feature/portal-integration

acoumb · web-flow · commit 575db9da2bb9 · 2025-10-14T13:56:20.000+03:00
Portal integration updates
diff --git a/src/Umbraco.Commerce.Checkout/Extensions/CustomerExtensions.cs b/src/Umbraco.Commerce.Checkout/Extensions/CustomerExtensions.cs
@@ -0,0 +1,78 @@
+using System;
+using System.Collections.Generic;
+using Umbraco.Commerce.Checkout.Models;
+using Umbraco.Commerce.Core.Models;
+
+namespace Umbraco.Commerce.Checkout.Extensions;
+
+public static class CustomerExtensions
+{
+    public static Customer GetCustomer(this OrderReadOnly order, OrderPropertyConfig orderPropertyConfig) =>
+        new Customer(
+            order.CustomerInfo.FirstName,
+            order.CustomerInfo.LastName,
+            order.CustomerInfo.Email,
+            order.Properties[orderPropertyConfig.Customer.Telephone.Alias]);
+
+    public static CustomerAddress GetBillingAddress(this OrderReadOnly order, OrderPropertyConfig orderPropertyConfig)
+    {
+        // This extension method should not be used in a context where order is null.
+        ArgumentNullException.ThrowIfNull(order);
+
+        return new CustomerAddress(
+            order.Properties[orderPropertyConfig.Billing.AddressLine1.Alias],
+            order.Properties[orderPropertyConfig.Billing.AddressLine2.Alias],
+            order.Properties[orderPropertyConfig.Billing.City.Alias],
+            order.Properties[orderPropertyConfig.Billing.ZipCode.Alias]);
+    }
+
+    public static CustomerAddress GetShippingAddress(this OrderReadOnly order, OrderPropertyConfig orderPropertyConfig)
+    {
+        // This extension method should not be used in a context where order is null.
+        ArgumentNullException.ThrowIfNull(order);
+
+        return order.Properties["shippingSameAsBilling"] == "1"
+            ? order.GetBillingAddress(orderPropertyConfig)
+            : new CustomerAddress(
+                order.Properties[orderPropertyConfig.Shipping.AddressLine1.Alias],
+                order.Properties[orderPropertyConfig.Shipping.AddressLine2.Alias],
+                order.Properties[orderPropertyConfig.Shipping.City.Alias],
+                order.Properties[orderPropertyConfig.Shipping.ZipCode.Alias]);
+    }
+
+    /// <summary>
+    /// Returns the current string value if not null or whitespace, otherwise returns the fallback value or an empty string.
+    /// </summary>
+    /// <param name="value">The original string value.</param>
+    /// <param name="fallbackValue">The string value for fallback.</param>
+    /// <returns></returns>
+    public static string ValueOrFallback(this string value, string fallbackValue) =>
+        string.IsNullOrWhiteSpace(value)
+            ? string.IsNullOrWhiteSpace(fallbackValue)
+                ? string.Empty
+                : fallbackValue
+            : value;
+
+    /// <summary>
+    /// Returns the property value if exists, otherwise returns the fallback value or an empty string. 
+    /// </summary>
+    /// <param name="properties">The properties dictionary.</param>
+    /// <param name="key">The looked up record key.</param>
+    /// <param name="fallbackValue">The string value for fallback</param>
+    /// <returns></returns>
+    public static string ValueOrFallback(this IReadOnlyDictionary<string, PropertyValue> properties, string key, string fallbackValue)
+    {
+        if (properties is null || !properties.ContainsKey(key))
+        {
+            return string.IsNullOrWhiteSpace(fallbackValue) ? string.Empty : fallbackValue;
+        }
+
+        var propertyRecord = properties[key];
+        if (propertyRecord is null)
+        {
+            return string.IsNullOrWhiteSpace(fallbackValue) ? string.Empty : fallbackValue;
+        }
+
+        return propertyRecord.Value.ValueOrFallback(fallbackValue);
+    }
+}
diff --git a/src/Umbraco.Commerce.Checkout/Models/Customer.cs b/src/Umbraco.Commerce.Checkout/Models/Customer.cs
@@ -0,0 +1,5 @@
+namespace Umbraco.Commerce.Checkout.Models;
+
+public record Customer(string FirstName, string LastName, string Email, string Telephone);
+
+public record CustomerAddress(string AddressLine1, string AddressLine2, string City, string ZipCode);
diff --git a/src/Umbraco.Commerce.Checkout/Pipeline/Tasks/CreateUmbracoCommerceCheckoutDocumentTypesTask.cs b/src/Umbraco.Commerce.Checkout/Pipeline/Tasks/CreateUmbracoCommerceCheckoutDocumentTypesTask.cs
@@ -194,6 +194,20 @@ public override async Task<PipelineResult<InstallPipelineContext>> ExecuteAsync(
                     x.Name = "Hide from Navigation";
                     x.Description = "Hide the checkout page from the sites main navigation.";
                     x.SortOrder = 90;
+                }),
+                CreatePropertyType(await booleanDataType.Value, x =>
+                {
+                    x.Alias = "uccRequireLogin";
+                    x.Name = "Require Login";
+                    x.Description = "Customer is required to login before proceeding with the checkout.";
+                    x.SortOrder = 100;
+                }),
+                CreatePropertyType(await contentPickerDataType.Value, x =>
+                {
+                    x.Alias = "uccLoginPage";
+                    x.Name = "Login Page";
+                    x.Description = "The page on the site containing the customer portal login.";
+                    x.SortOrder = 110;
                 })
             ];
 
diff --git a/src/Umbraco.Commerce.Checkout/Views/UmbracoCommerceCheckout/UmbracoCommerceCheckoutInformationPage.cshtml b/src/Umbraco.Commerce.Checkout/Views/UmbracoCommerceCheckout/UmbracoCommerceCheckoutInformationPage.cshtml
@@ -1,11 +1,16 @@
 @using System.Text.Json
+@using Umbraco.Commerce.Checkout.Extensions
 @inherits UmbracoViewPage
 @{
     Layout = "UmbracoCommerceCheckoutLayout.cshtml";
 
     var store = Model.GetStore();
 
     var currentOrder = await UmbracoCommerceApi.Instance.GetCurrentOrderAsync(store.Id);
+    var orderPropertyConfig = await UmbracoCommerceApi.Instance.GetOrderPropertyConfigAsync(store.Alias);
+
+    var customer = currentOrder.GetCustomer(orderPropertyConfig);
+    var billingAddress = currentOrder.GetBillingAddress(orderPropertyConfig);
 
     var countries = await UmbracoCommerceApi.Instance.GetCountriesAsync(store.Id);
 
@@ -43,7 +48,7 @@
 
     <h3 class="text-xl font-medium mb-4">@Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.ContactInformation", "Contact Information")</h3>
     <input name="email" type="email" placeholder="@Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.Email", "Email")" class="block placeholder-gray-700 border border-gray-300 rounded py-2 px-4 mb-2 w-full"
-           value="@(currentOrder.CustomerInfo.Email)" required />
+           value="@(currentOrder.CustomerInfo.Email.ValueOrFallback(customer.Email))" required />
     <label class="flex items-center mb-2  cursor-pointer">
         <input name="marketingOptIn" type="checkbox" value="true" class="mr-2" @Html.Raw(currentOrder.Properties["marketingOptIn"] == "1" ? "checked=\"checked\"" : "") /> @Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.MarketingOptIn", "Keep me up to date on news and exclusive offers")
     </label>
@@ -52,17 +57,17 @@
 
     <div class="flex -mx-1">
         <input name="billingAddress.Firstname" type="text" placeholder="@Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.FirstName", "First Name")" class="block placeholder-gray-700 border border-gray-300 rounded py-2 px-4 mb-2 mx-1 w-full"
-               value="@(currentOrder.CustomerInfo.FirstName)" required />
+               value="@(currentOrder.CustomerInfo.FirstName.ValueOrFallback(customer.FirstName))" required />
         <input name="billingAddress.Lastname" type="text" placeholder="@Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.LastName", "Last Name")" class="block placeholder-gray-700 border border-gray-300 rounded py-2 px-4 mb-2 mx-1 w-full"
-               value="@(currentOrder.CustomerInfo.LastName)" required />
+			   value="@(currentOrder.CustomerInfo.LastName.ValueOrFallback(customer.LastName))" required />
     </div>
 
     <input name="billingAddress.Line1" type="text" placeholder="@Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.Address1", "Address (Line 1)")" class="block placeholder-gray-700 border border-gray-300 rounded py-2 px-4 mb-2 w-full"
-           value="@(currentOrder.Properties["billingAddressLine1"])" required />
+		   value="@(currentOrder.Properties.ValueOrFallback("billingAddressLine1", billingAddress.AddressLine1))" required />
     <input name="billingAddress.Line2" type="text" placeholder="@Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.Address2", "Address (Line 2)")" class="block placeholder-gray-700 border border-gray-300 rounded py-2 px-4 mb-2 w-full"
-           value="@(currentOrder.Properties["billingAddressLine2"])" />
+		   value="@(currentOrder.Properties.ValueOrFallback("billingAddressLine2", billingAddress.AddressLine2))" />
     <input name="billingAddress.City" type="text" placeholder="@Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.City", "City")" class="block placeholder-gray-700 border border-gray-300 rounded py-2 px-4 mb-2 w-full"
-           value="@(currentOrder.Properties["billingCity"])" required />
+		   value="@(currentOrder.Properties.ValueOrFallback("billingCity", billingAddress.City))" required />
 
     <div class="flex -mx-1">
         <select name="billingAddress.Country" class="block placeholder-gray-700 border border-gray-300 rounded py-2 px-4 mb-2 mx-1 w-full" required>
@@ -82,15 +87,17 @@
         <select name="billingAddress.Region" class="block placeholder-gray-700 border border-gray-300 rounded py-2 px-4 mb-2 mx-1 w-full disabled:hidden"
                 data-value="@currentOrder.PaymentInfo.RegionId" data-placeholder="@Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.SelectRegion", "-- Select a Region --")" required disabled></select>
         <input name="billingAddress.ZipCode" type="text" placeholder="@Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.ZipCode", "Postcode")" class="block placeholder-gray-700 border border-gray-300 rounded py-2 px-4 mb-2 mx-1 w-full"
-               value="@(currentOrder.Properties["billingZipCode"])" required />
+			   value="@(currentOrder.Properties.ValueOrFallback("billingZipCode", billingAddress.ZipCode))" required />
     </div>
     <input name="billingAddress.Telephone" type="text" placeholder="@Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.Telephone", "Phone")" class="block placeholder-gray-700 border border-gray-300 rounded py-2 px-4 mb-2 w-full"
-           value="@(currentOrder.Properties["billingTelephone"])" />
-
-    if (checkoutPage.Value<bool>("uccCollectShippingInfo"))
-    {
-        <label class="flex items-center mb-2 cursor-pointer">
-            <input name="shippingSameAsBilling" type="checkbox" class="mr-2" value="true" @Html.Raw(currentOrder.Properties["shippingSameAsBilling"] == "1" || !currentOrder.Properties.ContainsKey("shippingSameAsBilling") ? "checked=\"checked\"" : "") /> @Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.ShippingSameAsBilling", "Shipping address is same as billing address")
+		   value="@(currentOrder.Properties.ValueOrFallback("billingTelephone", customer.Telephone))" />
+
+	if (checkoutPage.Value<bool>("uccCollectShippingInfo"))
+	{
+		var shippingAddress = currentOrder.GetShippingAddress(orderPropertyConfig);
+		
+		<label class="flex items-center mb-2 cursor-pointer">
+			<input name="shippingSameAsBilling" type="checkbox" class="mr-2" value="true" @Html.Raw(currentOrder.Properties["shippingSameAsBilling"] == "1" || !currentOrder.Properties.ContainsKey("shippingSameAsBilling") ? "checked=\"checked\"" : "") /> @Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.ShippingSameAsBilling", "Shipping address is same as billing address")
         </label>
 
         <div id="shipping-info" class="hidden">
@@ -99,17 +106,17 @@
 
             <div class="flex -mx-1">
                 <input name="shippingAddress.Firstname" type="text" placeholder="@Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.FirstName", "First Name")" class="block placeholder-gray-700 border border-gray-300 rounded py-2 px-4 mb-2 mx-1 w-full"
-                       value="@(currentOrder.Properties["shippingFirstName"])" required />
+					   value="@(currentOrder.Properties.ValueOrFallback("shippingFirstName", customer.FirstName))" required />
                 <input name="shippingAddress.Lastname" type="text" placeholder="@Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.LastName", "Last Name")" class="block placeholder-gray-700 border border-gray-300 rounded py-2 px-4 mb-2 mx-1 w-full"
-                       value="@(currentOrder.Properties["shippingLastName"])" required />
+					   value="@(currentOrder.Properties.ValueOrFallback("shippingLastName", customer.LastName))" required />
             </div>
 
             <input name="shippingAddress.Line1" type="text" placeholder="@Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.Address1", "Address (Line 1)")" class="block placeholder-gray-700 border border-gray-300 rounded py-2 px-4 mb-2 w-full"
-                   value="@(currentOrder.Properties["shippingAddressLine1"])" required />
+				   value="@(currentOrder.Properties.ValueOrFallback("shippingAddressLine1", shippingAddress.AddressLine1))" required />
             <input name="shippingAddress.Line2" type="text" placeholder="@Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.Address2", "Address (Line 2)")" class="block placeholder-gray-700 border border-gray-300 rounded py-2 px-4 mb-2 w-full"
-                   value="@(currentOrder.Properties["shippingAddressLine2"])" />
+				   value="@(currentOrder.Properties.ValueOrFallback("shippingAddressLine2", shippingAddress.AddressLine2))" />
             <input name="shippingAddress.City" type="text" placeholder="@Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.City", "City")" class="block placeholder-gray-700 border border-gray-300 rounded py-2 px-4 mb-2 w-full"
-                   value="@(currentOrder.Properties["shippingCity"])" required />
+				   value="@(currentOrder.Properties.ValueOrFallback("shippingAddressLine2", shippingAddress.City))" required />
 
             <div class="flex -mx-1">
                 <select name="shippingAddress.Country" class="block placeholder-gray-700 border border-gray-300 rounded py-2 px-4 mb-2 mx-1 w-full" required>
@@ -129,10 +136,10 @@
                 <select name="shippingAddress.Region" class="block placeholder-gray-700 border border-gray-300 rounded py-2 px-4 mb-2 mx-1 w-full disabled:hidden"
                         data-value="@currentOrder.ShippingInfo.RegionId" data-placeholder="@Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.SelectRegion", "-- Select a Region --")" required disabled></select>
                 <input name="shippingAddress.ZipCode" type="text" placeholder="@Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.ZipCode", "Postcode")" class="block placeholder-gray-700 border border-gray-300 rounded py-2 px-4 mb-2 mx-1 w-full"
-                       value="@(currentOrder.Properties["shippingZipCode"])" required />
+					   value="@(currentOrder.Properties.ValueOrFallback("shippingZipCode", shippingAddress.ZipCode))" required />
             </div>
             <input name="shippingAddress.Telephone" type="text" placeholder="@Umbraco.GetDictionaryValueOrDefault("UmbracoCommerceCheckout.Information.Telephone", "Phone")" class="block placeholder-gray-700 border border-gray-300 rounded py-2 px-4 mb-2 w-full"
-                   value="@(currentOrder.Properties["shippingTelephone"])" />
+				   value="@(currentOrder.Properties.ValueOrFallback("shippingTelephone", customer.Telephone))" />
 
         </div>
     }
diff --git a/src/Umbraco.Commerce.Checkout/Web/Controllers/UmbracoCommerceCheckoutBaseController.cs b/src/Umbraco.Commerce.Checkout/Web/Controllers/UmbracoCommerceCheckoutBaseController.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.ViewEngines;
@@ -40,8 +41,6 @@ public virtual Task<IActionResult> Index()
 
         protected async Task<bool> IsValidCartAsync()
         {
-            ArgumentNullException.ThrowIfNull(CurrentPage);
-
             StoreReadOnly store = CurrentPage.GetStore();
             OrderReadOnly order = !IsConfirmationPageType(CurrentPage)
                 ? await UmbracoCommerceApi.Instance.GetCurrentOrderAsync(store.Id)
@@ -55,6 +54,14 @@ protected async Task<bool> IsValidCartAsync()
             return true;
         }
 
+        protected bool IsLoginRequired(out string loginPageUrl)
+        {
+            IPublishedContent checkoutPage = CurrentPage.GetCheckoutPage();
+            IPublishedContent loginPage = CurrentPage.GetLoginPage();
+            loginPageUrl = loginPage?.Url(Thread.CurrentThread.CurrentCulture.Name) ?? string.Empty;
+            return checkoutPage?.Value<bool>("uccRequireLogin") ?? false;
+        }
+
         private static bool IsConfirmationPageType(IPublishedContent node)
         {
             if (!node.HasProperty("uccStepType"))
diff --git a/src/Umbraco.Commerce.Checkout/Web/Controllers/UmbracoCommerceCheckoutCheckoutPageController.cs b/src/Umbraco.Commerce.Checkout/Web/Controllers/UmbracoCommerceCheckoutCheckoutPageController.cs
@@ -1,9 +1,11 @@
 using System;
 using System.Linq;
+using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.ViewEngines;
 using Microsoft.Extensions.Logging;
+using Umbraco.Cms.Web.Common.Filters;
 using Umbraco.Extensions;
 
 namespace Umbraco.Commerce.Checkout.Web.Controllers
@@ -23,13 +25,22 @@ public UmbracoCommerceCheckoutCheckoutPageController(ILogger<UmbracoCommerceChec
 
         public override async Task<IActionResult> Index()
         {
+            ArgumentNullException.ThrowIfNull(CurrentPage);
+
+            // Check if login is required
+            if (IsLoginRequired(out string loginPageUrl) && (!User.Identity?.IsAuthenticated ?? false))
+            {
+                return string.IsNullOrEmpty(loginPageUrl)
+                    ? Unauthorized()
+                    : Redirect(loginPageUrl);
+            }
+
             // Check the cart is valid before continuing
             if (!await IsValidCartAsync())
             {
                 return Redirect(InvalidCartRedirectUrl);
             }
 
-            ArgumentNullException.ThrowIfNull(CurrentPage);
             // If the page has a template, use it
             if (CurrentPage.TemplateId.HasValue && CurrentPage.TemplateId.Value > 0)
             {
diff --git a/src/Umbraco.Commerce.Checkout/Web/Controllers/UmbracoCommerceCheckoutCheckoutStepPageController.cs b/src/Umbraco.Commerce.Checkout/Web/Controllers/UmbracoCommerceCheckoutCheckoutStepPageController.cs
@@ -2,6 +2,9 @@
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.ViewEngines;
 using Microsoft.Extensions.Logging;
+using Umbraco.Cms.Core.Services;
+using Umbraco.Commerce.Core.Api;
+using Umbraco.Commerce.Extensions;
 using Umbraco.Extensions;
 
 namespace Umbraco.Commerce.Checkout.Web.Controllers
@@ -21,6 +24,14 @@ public UmbracoCommerceCheckoutCheckoutStepPageController(ILogger<UmbracoCommerce
 
         public override async Task<IActionResult> Index()
         {
+            // Check if login is required
+            if (IsLoginRequired(out string loginPageUrl) && (!User.Identity?.IsAuthenticated ?? false))
+            {
+                return string.IsNullOrEmpty(loginPageUrl)
+                    ? Unauthorized()
+                    : Redirect(loginPageUrl);
+            }
+
             // Check the cart is valid before continuing
             if (!await IsValidCartAsync())
             {
diff --git a/src/Umbraco.Commerce.Checkout/Web/PublishedContentExtensions.cs b/src/Umbraco.Commerce.Checkout/Web/PublishedContentExtensions.cs
@@ -30,6 +30,11 @@ public static IPublishedContent GetCheckoutBackPage(this IPublishedContent conte
             return GetCheckoutPage(content).Value<IPublishedContent>("uccBackPage")!;
         }
 
+        public static IPublishedContent GetLoginPage(this IPublishedContent content)
+        {
+            return GetCheckoutPage(content).Value<IPublishedContent>("uccLoginPage")!;
+        }
+
         public static string GetThemeColor(this IPublishedContent content)
         {
             // Check if the checkout page has a custom theme color set
diff --git a/version.json b/version.json
@@ -1,6 +1,6 @@
 {
   "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
-  "version": "16.1.0",
+  "version": "16.2.0",
   "assemblyVersion": {
     "precision": "build"
   },

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,11 @@ public static IPublishedContent GetCheckoutBackPage(this IPublishedContent conte`
`30`	`30`	`return GetCheckoutPage(content).Value<IPublishedContent>("uccBackPage")!;`
`31`	`31`	`}`
`32`	`32`
	`33`	`+ public static IPublishedContent GetLoginPage(this IPublishedContent content)`
	`34`	`+ {`
	`35`	`+ return GetCheckoutPage(content).Value<IPublishedContent>("uccLoginPage")!;`
	`36`	`+ }`
	`37`	`+`
`33`	`38`	`public static string GetThemeColor(this IPublishedContent content)`
`34`	`39`	`{`
`35`	`40`	`// Check if the checkout page has a custom theme color set`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",`
`3`		`- "version": "16.1.0",`
	`3`	`+ "version": "16.2.0",`
`4`	`4`	`"assemblyVersion": {`
`5`	`5`	`"precision": "build"`
`6`	`6`	`},`