Support segments from querystring in preview (#17819)

Author: kjac

src/Umbraco.Core/Routing/ContentFinderByIdPath.cs

@@ -92,6 +92,7 @@ public Task<bool> TryFindContent(IPublishedRequestBuilder frequest)
         }
 
         ResolveAndSetCultureOnRequest(frequest);
+        ResolveAndSetSegmentOnRequest(frequest);
 
         frequest.SetPublishedContent(node);
         if (_logger.IsEnabled(LogLevel.Debug))

src/Umbraco.Core/Routing/ContentFinderByIdentifierPathBase.cs

@@ -32,6 +32,18 @@ protected void ResolveAndSetCultureOnRequest(IPublishedRequestBuilder frequest)
         }
     }
 
+    protected void ResolveAndSetSegmentOnRequest(IPublishedRequestBuilder frequest)
+    {
+        var segmentFromQuerystring = _requestAccessor.GetQueryStringValue("segment");
+
+        // Check if we have a segment in the query string
+        if (!string.IsNullOrEmpty(segmentFromQuerystring))
+        {
+            // We're assuming it will match a segment
+            frequest.SetSegment(segmentFromQuerystring);
+        }
+    }
+
     protected Task<bool> LogAndReturnFailure()
     {
         if (_logger.IsEnabled(LogLevel.Debug))

src/Umbraco.Core/Routing/ContentFinderByKeyPath.cs

@@ -90,6 +90,7 @@ public Task<bool> TryFindContent(IPublishedRequestBuilder frequest)
         }
 
         ResolveAndSetCultureOnRequest(frequest);
+        ResolveAndSetSegmentOnRequest(frequest);
 
         frequest.SetPublishedContent(node);
         if (_logger.IsEnabled(LogLevel.Debug))

src/Umbraco.Core/Routing/IPublishedRequest.cs

@@ -61,6 +61,11 @@ public interface IPublishedRequest
     /// </remarks>
     string? Culture { get; }
 
+    /// <summary>
+    ///     Gets the content request's segment (if any).
+    /// </summary>
+    string? Segment => null;
+
     /// <summary>
     ///     Gets the url to redirect to, when the content request triggers a redirect.
     /// </summary>

src/Umbraco.Core/Routing/IPublishedRequestBuilder.cs

@@ -32,6 +32,11 @@ public interface IPublishedRequestBuilder
     /// </summary>
     string? Culture { get; }
 
+    /// <summary>
+    ///     Gets the segment assigned (if any)
+    /// </summary>
+    string? Segment => null;
+
     /// <summary>
     ///     Gets a value indicating whether the current published content has been obtained
     ///     from the initial published content following internal redirections exclusively.
@@ -72,6 +77,11 @@ public interface IPublishedRequestBuilder
     /// </summary>
     IPublishedRequestBuilder SetCulture(string? culture);
 
+    /// <summary>
+    ///     Sets the segment for the request
+    /// </summary>
+    IPublishedRequestBuilder SetSegment(string? segment) => this;
+
     /// <summary>
     ///     Sets the found <see cref="IPublishedContent" /> for the request
     /// </summary>

src/Umbraco.Core/Routing/PublishedRequest.cs

@@ -5,6 +5,39 @@ namespace Umbraco.Cms.Core.Routing;
 
 public class PublishedRequest : IPublishedRequest
 {
+    [Obsolete("Please use the constructor that accepts a segment. Will be removed in V16.")]
+    public PublishedRequest(
+        Uri uri,
+        string absolutePathDecoded,
+        IPublishedContent? publishedContent,
+        bool isInternalRedirect,
+        ITemplate? template,
+        DomainAndUri? domain,
+        string? culture,
+        string? redirectUrl,
+        int? responseStatusCode,
+        IReadOnlyList<string>? cacheExtensions,
+        IReadOnlyDictionary<string, string>? headers,
+        bool setNoCacheHeader,
+        bool ignorePublishedContentCollisions)
+        : this(
+            uri,
+            absolutePathDecoded,
+            publishedContent,
+            isInternalRedirect,
+            template,
+            domain,
+            culture,
+            segment: null,
+            redirectUrl,
+            responseStatusCode,
+            cacheExtensions,
+            headers,
+            setNoCacheHeader,
+            ignorePublishedContentCollisions)
+    {
+    }
+
     /// <summary>
     ///     Initializes a new instance of the <see cref="PublishedRequest" /> class.
     /// </summary>
@@ -16,6 +49,7 @@ public PublishedRequest(
         ITemplate? template,
         DomainAndUri? domain,
         string? culture,
+        string? segment,
         string? redirectUrl,
         int? responseStatusCode,
         IReadOnlyList<string>? cacheExtensions,
@@ -30,6 +64,7 @@ public PublishedRequest(
         Template = template;
         Domain = domain;
         Culture = culture;
+        Segment = segment;
         RedirectUrl = redirectUrl;
         ResponseStatusCode = responseStatusCode;
         CacheExtensions = cacheExtensions;
@@ -62,6 +97,9 @@ public PublishedRequest(
     /// <inheritdoc />
     public string? Culture { get; }
 
+    /// <inheritdoc />
+    public string? Segment { get; }
+
     /// <inheritdoc />
     public string? RedirectUrl { get; }
 

src/Umbraco.Core/Routing/PublishedRequestBuilder.cs

@@ -39,6 +39,9 @@ public PublishedRequestBuilder(Uri uri, IFileService fileService)
     /// <inheritdoc />
     public string? Culture { get; private set; }
 
+    /// <inheritdoc />
+    public string? Segment { get; private set; }
+
     /// <inheritdoc />
     public ITemplate? Template { get; private set; }
 
@@ -69,6 +72,7 @@ private set
         Template,
         Domain,
         Culture,
+        Segment,
         _redirectUrl,
         _responseStatus.HasValue ? (int?)_responseStatus : null,
         _cacheExtensions,
@@ -97,6 +101,13 @@ public IPublishedRequestBuilder SetCulture(string? culture)
         return this;
     }
 
+    /// <inheritdoc />
+    public IPublishedRequestBuilder SetSegment(string? segment)
+    {
+        Segment = segment;
+        return this;
+    }
+
     /// <inheritdoc />
     public IPublishedRequestBuilder SetDomain(DomainAndUri domain)
     {

src/Umbraco.Core/Routing/PublishedRouter.cs

@@ -136,6 +136,7 @@ public async Task<IPublishedRequest> UpdateRequestAsync(
             builder.SetDomain(request.Domain);
         }
         builder.SetCulture(request.Culture);
+        builder.SetSegment(request.Segment);
 
         // set to the new content (or null if specified)
         builder.SetPublishedContent(publishedContent);
@@ -181,7 +182,7 @@ internal IPublishedRequest BuildRequest(IPublishedRequestBuilder builder)
         }
 
         // set the culture -- again, 'cos it might have changed in the event handler
-        SetVariationContext(result.Culture);
+        SetVariationContext(result.Culture, result.Segment);
 
         return result;
     }
@@ -205,15 +206,15 @@ private async Task<IPublishedRequest> TryRouteRequest(IPublishedRequestBuilder r
         return request.Build();
     }
 
-    private void SetVariationContext(string? culture)
+    private void SetVariationContext(string? culture, string? segment)
     {
         VariationContext? variationContext = _variationContextAccessor.VariationContext;
-        if (variationContext != null && variationContext.Culture == culture)
+        if (variationContext != null && variationContext.Culture == culture && variationContext.Segment == segment)
         {
             return;
         }
 
-        _variationContextAccessor.VariationContext = new VariationContext(culture);
+        _variationContextAccessor.VariationContext = new VariationContext(culture, segment);
     }
 
     private async Task RouteRequestInternalAsync(IPublishedRequestBuilder builder, bool skipContentFinders = false)
@@ -226,7 +227,7 @@ private async Task RouteRequestInternalAsync(IPublishedRequestBuilder builder, b
         }
 
         // set the culture
-        SetVariationContext(builder.Culture);
+        SetVariationContext(builder.Culture, builder.Segment);
 
         var foundContentByFinders = false;
 
@@ -261,7 +262,7 @@ private async Task RouteRequestInternalAsync(IPublishedRequestBuilder builder, b
             HandleWildcardDomains(builder);
 
             // set the culture  -- again, 'cos it might have changed due to a finder or wildcard domain
-            SetVariationContext(builder.Culture);
+            SetVariationContext(builder.Culture, builder.Segment);
         }
 
         // trigger the routing request (used to be called Prepared) event - at that point it is still possible to change about anything
@@ -278,15 +279,15 @@ public bool RouteDomain(IPublishedRequestBuilder request)
     {
         var found = FindAndSetDomain(request);
         HandleWildcardDomains(request);
-        SetVariationContext(request.Culture);
+        SetVariationContext(request.Culture, request.Segment);
         return found;
     }
 
     /// <inheritdoc />
     public bool UpdateVariationContext(Uri uri)
     {
         DomainAndUri? domain = FindDomain(uri, out _);
-        SetVariationContext(domain?.Culture);
+        SetVariationContext(domain?.Culture, null);
         return domain?.Culture is not null;
     }
 

src/Umbraco.Web.Common/Controllers/RenderController.cs

@@ -58,10 +58,11 @@ public override async Task OnActionExecutionAsync(ActionExecutingContext context
         if (_logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Debug))
         {
             _logger.LogDebug(
-            "Response status: Content={Content}, StatusCode={ResponseStatusCode}, Culture={Culture}",
+            "Response status: Content={Content}, StatusCode={ResponseStatusCode}, Culture={Culture}, Segment={Segment}",
             pcr.PublishedContent?.Id ?? -1,
             pcr.ResponseStatusCode,
-            pcr.Culture);
+            pcr.Culture,
+            pcr.Segment);
         }
 
         UmbracoRouteResult routeStatus = pcr.GetRouteResult();

src/Umbraco.Web.Common/Templates/TemplateRenderer.cs

@@ -101,6 +101,7 @@ public async Task RenderAsync(int pageId, int? altTemplateId, StringWriter write
         else
         {
             requestBuilder.SetCulture(umbracoContext.PublishedRequest.Culture);
+            requestBuilder.SetSegment(umbracoContext.PublishedRequest.Segment);
         }
 
         // set the doc that was found by id