Introduce HttpRequest & HttpContext Fluid values

src/OrchardCore/OrchardCore.DisplayManagement.Liquid/LiquidHttpContextAccessor.cs

@@ -3,6 +3,7 @@ namespace OrchardCore.Liquid;
 /// <summary>
 /// This is a placeholder class that allows modules to extend the `HttpContext` property in the current Liquid scope.
 /// </summary>
+[Obsolete("This class is obsolete and will be removed in a future version.", error: true)]
 public class LiquidHttpContextAccessor
 {
 }

src/OrchardCore/OrchardCore.DisplayManagement.Liquid/LiquidRequestAccessor.cs

@@ -3,6 +3,7 @@ namespace OrchardCore.Liquid;
 /// <summary>
 /// This is a placeholder class that allows modules to extend the `HttpRequest` property in the current Liquid scope.
 /// </summary>
+[Obsolete("This class is obsolete and will be removed in a future version.", error: true)]
 public class LiquidRequestAccessor
 {
 }

src/OrchardCore/OrchardCore.DisplayManagement.Liquid/TemplateOptionsConfigurations.cs

@@ -44,45 +44,10 @@
 
         options.Scope.SetValue("Environment", new HostingEnvironmentValue(_hostEnvironment));
 
-        options.Scope.SetValue("Request", new ObjectValue(new LiquidRequestAccessor()));
-        options.MemberAccessStrategy.Register<LiquidRequestAccessor, FluidValue>((obj, name, ctx) =>
-        {
-            var request = ((LiquidTemplateContext)ctx).Services.GetRequiredService<IHttpContextAccessor>().HttpContext?.Request;
-            if (request != null)
-            {
-                return name switch
-                {
-                    nameof(HttpRequest.QueryString) => new StringValue(request.QueryString.Value),
-                    nameof(HttpRequest.ContentType) => new StringValue(request.ContentType),
-                    nameof(HttpRequest.ContentLength) => NumberValue.Create(request.ContentLength ?? 0),
-                    nameof(HttpRequest.Cookies) => new ObjectValue(new CookieCollectionWrapper(request.Cookies)),
-                    nameof(HttpRequest.Headers) => new ObjectValue(new HeaderDictionaryWrapper(request.Headers)),
-                    nameof(HttpRequest.Query) => new ObjectValue(new QueryCollection(request.Query.ToDictionary(kv => kv.Key, kv => kv.Value))),
-                    nameof(HttpRequest.Form) => request.HasFormContentType ? (FluidValue)new ObjectValue(request.Form) : NilValue.Instance,
-                    nameof(HttpRequest.Protocol) => new StringValue(request.Protocol),
-                    nameof(HttpRequest.Path) => new StringValue(request.Path.Value),
-                    nameof(HttpRequest.PathBase) => new StringValue(request.PathBase.Value),
-                    nameof(HttpRequest.Host) => new StringValue(request.Host.Value),
-                    nameof(HttpRequest.IsHttps) => BooleanValue.Create(request.IsHttps),
-                    nameof(HttpRequest.Scheme) => new StringValue(request.Scheme),
-                    nameof(HttpRequest.Method) => new StringValue(request.Method),
-                    nameof(HttpRequest.RouteValues) => new ObjectValue(new RouteValueDictionaryWrapper(request.RouteValues)),
-
-                    // Provides correct escaping to reconstruct a request or redirect URI.
-                    "UriHost" => new StringValue(request.Host.ToUriComponent(), encode: false),
-                    "UriPath" => new StringValue(request.Path.ToUriComponent(), encode: false),
-                    "UriPathBase" => new StringValue(request.PathBase.ToUriComponent(), encode: false),
-                    "UriQueryString" => new StringValue(request.QueryString.ToUriComponent(), encode: false),
-
-                    _ => NilValue.Instance
-                };
-            }
-
-            return NilValue.Instance;
-        });
+        options.Scope.SetValue("Request", new HttpRequestValue());
 
         options.Scope.SetValue("HttpContext", new ObjectValue(new LiquidHttpContextAccessor()));
         options.MemberAccessStrategy.Register<LiquidHttpContextAccessor, FluidValue>((obj, name, ctx) =>
         {
             var httpContext = ((LiquidTemplateContext)ctx).Services.GetRequiredService<IHttpContextAccessor>().HttpContext;
             if (httpContext != null)
@@ -113,44 +78,4 @@
         options.MemberAccessStrategy.Register<HeaderDictionaryWrapper, string[]>((headers, name) => headers.HeaderDictionary[name].ToArray());
         options.MemberAccessStrategy.Register<RouteValueDictionaryWrapper, object>((headers, name) => headers.RouteValueDictionary[name]);
     }
-
-    private sealed class CookieCollectionWrapper
-    {
-        public readonly IRequestCookieCollection RequestCookieCollection;
-
-        public CookieCollectionWrapper(IRequestCookieCollection requestCookieCollection)
-        {
-            RequestCookieCollection = requestCookieCollection;
-        }
-    }
-
-    private sealed class HeaderDictionaryWrapper
-    {
-        public readonly IHeaderDictionary HeaderDictionary;
-
-        public HeaderDictionaryWrapper(IHeaderDictionary headerDictionary)
-        {
-            HeaderDictionary = headerDictionary;
-        }
-    }
-
-    private sealed class HttpContextItemsWrapper
-    {
-        public readonly IDictionary<object, object> Items;
-
-        public HttpContextItemsWrapper(IDictionary<object, object> items)
-        {
-            Items = items;
-        }
-    }
-
-    private sealed class RouteValueDictionaryWrapper
-    {
-        public readonly IReadOnlyDictionary<string, object> RouteValueDictionary;
-
-        public RouteValueDictionaryWrapper(IReadOnlyDictionary<string, object> routeValueDictionary)
-        {
-            RouteValueDictionary = routeValueDictionary;
-        }
-    }
 }

src/OrchardCore/OrchardCore.DisplayManagement.Liquid/Values/CookieCollectionWrapper.cs

@@ -0,0 +1,13 @@
+using Microsoft.AspNetCore.Http;
+
+namespace OrchardCore.DisplayManagement.Liquid.Values;
+
+internal sealed class CookieCollectionWrapper
+{
+    public readonly IRequestCookieCollection RequestCookieCollection;
+
+    public CookieCollectionWrapper(IRequestCookieCollection requestCookieCollection)
+    {
+        RequestCookieCollection = requestCookieCollection;
+    }
+}

src/OrchardCore/OrchardCore.DisplayManagement.Liquid/Values/HeaderDictionaryWrapper.cs

@@ -0,0 +1,13 @@
+using Microsoft.AspNetCore.Http;
+
+namespace OrchardCore.DisplayManagement.Liquid.Values;
+
+internal sealed class HeaderDictionaryWrapper
+{
+    public readonly IHeaderDictionary HeaderDictionary;
+
+    public HeaderDictionaryWrapper(IHeaderDictionary headerDictionary)
+    {
+        HeaderDictionary = headerDictionary;
+    }
+}

src/OrchardCore/OrchardCore.DisplayManagement.Liquid/Values/HttpContextItemsWrapper.cs

@@ -0,0 +1,11 @@
+namespace OrchardCore.DisplayManagement.Liquid.Values;
+
+internal sealed class HttpContextItemsWrapper
+{
+    public readonly IDictionary<object, object> Items;
+
+    public HttpContextItemsWrapper(IDictionary<object, object> items)
+    {
+        Items = items;
+    }
+}

src/OrchardCore/OrchardCore.DisplayManagement.Liquid/Values/HttpContextValue.cs

@@ -0,0 +1,73 @@
+using System.Globalization;
+using System.Text.Encodings.Web;
+using Fluid;
+using Fluid.Values;
+using Microsoft.AspNetCore.Http;
+using Microsoft.Extensions.DependencyInjection;
+using OrchardCore.Liquid;
+
+namespace OrchardCore.DisplayManagement.Liquid.Values;
+
+internal sealed partial class HttpContextValue : FluidValue
+{
+    private readonly HttpContext _context;
+
+    public override FluidValues Type => FluidValues.Object;
+
+    /// <summary>
+    /// Creates a new instance of a <see cref="HttpContextValue"/> for the specified HTTP context.
+    /// </summary>
+    public HttpContextValue(HttpContext context = null)
+    {
+        ArgumentNullException.ThrowIfNull(context);
+
+        _context = context;
+    }
+
+    public override bool Equals(FluidValue other)
+    {
+        if (other is null)
+        {
+            return false;
+        }
+
+        return ToObjectValue() == other.ToObjectValue();
+    }
+
+    public override bool ToBooleanValue() => true;
+
+    public override decimal ToNumberValue() => 0;
+
+    public override object ToObjectValue() => _context;
+
+    public override string ToStringValue() => _context?.ToString();
+
+#pragma warning disable CS0672 // Member overrides obsolete member
+    public override void WriteTo(TextWriter writer, TextEncoder encoder, CultureInfo cultureInfo)
+#pragma warning restore CS0672 // Member overrides obsolete member
+        => writer.Write(_context?.ToString());
+
+    public async override ValueTask WriteToAsync(TextWriter writer, TextEncoder encoder, CultureInfo cultureInfo)
+        => await writer.WriteAsync(_context?.ToString());
+
+    public override ValueTask<FluidValue> GetValueAsync(string name, TemplateContext context)
+    {
+        var httpContext = _context ?? GetHttpContext(context).ToObjectValue() as HttpContext;
+
+        return name switch
+        {
+            nameof(HttpContext.Items) => new ObjectValue(new HttpContextItemsWrapper(httpContext.Items)),
+            _ => NilValue.Instance
+        };
+    }
+
+    private static ObjectValue GetHttpContext(TemplateContext context)
+    {
+        var ctx = context as LiquidTemplateContext
+            ?? throw new InvalidOperationException($"An implementation of '{nameof(LiquidTemplateContext)}' is required");
+
+        var httpContextAccessor = ctx.Services.GetRequiredService<IHttpContextAccessor>();
+
+        return new ObjectValue(httpContextAccessor.HttpContext);
+    }
+}

src/OrchardCore/OrchardCore.DisplayManagement.Liquid/Values/HttpRequestValue.cs

@@ -0,0 +1,93 @@
+using System.Globalization;
+using System.Text.Encodings.Web;
+using Fluid;
+using Fluid.Values;
+using Microsoft.AspNetCore.Http;
+using Microsoft.Extensions.DependencyInjection;
+using OrchardCore.Liquid;
+
+namespace OrchardCore.DisplayManagement.Liquid.Values;
+
+internal sealed partial class HttpRequestValue : FluidValue
+{
+    private readonly HttpRequest _request;
+
+    public override FluidValues Type => FluidValues.Object;
+
+    /// <summary>
+    /// Creates a new instance of a <see cref="HttpRequestValue"/> for the specified HTTP request.
+    /// </summary>
+    public HttpRequestValue(HttpRequest request = null)
+    {
+        ArgumentNullException.ThrowIfNull(request);
+
+        _request = request;
+    }
+
+    public override bool Equals(FluidValue other)
+    {
+        if (other is null)
+        {
+            return false;
+        }
+
+        return ToStringValue() == other.ToStringValue();
+    }
+
+    public override bool ToBooleanValue() => true;
+
+    public override decimal ToNumberValue() => 0;
+
+    public override object ToObjectValue() => _request;
+
+    public override string ToStringValue() => _request?.Path;
+
+#pragma warning disable CS0672 // Member overrides obsolete member
+    public override void WriteTo(TextWriter writer, TextEncoder encoder, CultureInfo cultureInfo)
+#pragma warning restore CS0672 // Member overrides obsolete member
+        => writer.Write(_request?.Path);
+
+    public async override ValueTask WriteToAsync(TextWriter writer, TextEncoder encoder, CultureInfo cultureInfo)
+        => await writer.WriteAsync(_request?.Path);
+
+    public override ValueTask<FluidValue> GetValueAsync(string name, TemplateContext context)
+    {
+        var request = _request ?? GetHttpRequest(context).ToObjectValue() as HttpRequest;
+
+        return name switch
+        {
+            nameof(HttpRequest.QueryString) => new StringValue(request.QueryString.Value),
+            nameof(HttpRequest.ContentType) => new StringValue(request.ContentType),
+            nameof(HttpRequest.ContentLength) => NumberValue.Create(request.ContentLength ?? 0),
+            nameof(HttpRequest.Cookies) => new ObjectValue(new CookieCollectionWrapper(request.Cookies)),
+            nameof(HttpRequest.Headers) => new ObjectValue(new HeaderDictionaryWrapper(request.Headers)),
+            nameof(HttpRequest.Query) => new ObjectValue(new QueryCollection(request.Query.ToDictionary(kv => kv.Key, kv => kv.Value))),
+            nameof(HttpRequest.Form) => request.HasFormContentType ? (FluidValue)new ObjectValue(request.Form) : NilValue.Instance,
+            nameof(HttpRequest.Protocol) => new StringValue(request.Protocol),
+            nameof(HttpRequest.Path) => new StringValue(request.Path.Value),
+            nameof(HttpRequest.PathBase) => new StringValue(request.PathBase.Value),
+            nameof(HttpRequest.Host) => new StringValue(request.Host.Value),
+            nameof(HttpRequest.IsHttps) => BooleanValue.Create(request.IsHttps),
+            nameof(HttpRequest.Scheme) => new StringValue(request.Scheme),
+            nameof(HttpRequest.Method) => new StringValue(request.Method),
+            nameof(HttpRequest.RouteValues) => new ObjectValue(new RouteValueDictionaryWrapper(request.RouteValues)),
+
+            // Provides correct escaping to reconstruct a request or redirect URI.
+            "UriHost" => new StringValue(request.Host.ToUriComponent(), encode: false),
+            "UriPath" => new StringValue(request.Path.ToUriComponent(), encode: false),
+            "UriPathBase" => new StringValue(request.PathBase.ToUriComponent(), encode: false),
+            "UriQueryString" => new StringValue(request.QueryString.ToUriComponent(), encode: false),
+            _ => ValueTask.FromResult<FluidValue>(NilValue.Instance)
+        };
+    }
+
+    private static ObjectValue GetHttpRequest(TemplateContext context)
+    {
+        var ctx = context as LiquidTemplateContext
+            ?? throw new InvalidOperationException($"An implementation of '{nameof(LiquidTemplateContext)}' is required");
+
+        var httpContext = ctx.Services.GetRequiredService<IHttpContextAccessor>().HttpContext;
+
+        return new ObjectValue(httpContext.Request);
+    }
+}

src/OrchardCore/OrchardCore.DisplayManagement.Liquid/Values/RouteValueDictionaryWrapper.cs

@@ -0,0 +1,11 @@
+namespace OrchardCore.DisplayManagement.Liquid.Values;
+
+internal sealed class RouteValueDictionaryWrapper
+{
+    public readonly IReadOnlyDictionary<string, object> RouteValueDictionary;
+
+    public RouteValueDictionaryWrapper(IReadOnlyDictionary<string, object> routeValueDictionary)
+    {
+        RouteValueDictionary = routeValueDictionary;
+    }
+}