Expose properties of ITrackingConsentFeature and cookie policy in Liq…

…uid (#17148)

---------

Co-authored-by: Mike Alhayek <[email protected]>

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

@@ -46,6 +46,8 @@ public void Configure(TemplateOptions options)
 
         options.Scope.SetValue("HttpContext", new HttpContextValue());
 
+        options.Scope.SetValue("TrackingConsent", new TrackingConsentValue());
+
         options.MemberAccessStrategy.Register<FormCollection, FluidValue>((forms, name) =>
         {
             if (name == "Keys")

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

@@ -12,9 +12,6 @@ internal sealed class HttpRequestValue : FluidValue
 {
     public override FluidValues Type => FluidValues.Object;
 
-    /// <summary>
-    /// Creates a new instance of a <see cref="HttpRequestValue"/> for the specified HTTP request.
-    /// </summary>
     public override bool Equals(FluidValue other)
     {
         if (other is null)

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

@@ -0,0 +1,77 @@
+using Fluid;
+using Fluid.Values;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Http.Features;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
+using OrchardCore.Liquid;
+
+#nullable enable
+
+namespace OrchardCore.DisplayManagement.Liquid.Values;
+
+/// <summary>
+/// Exposes <see href="ITrackingConsentFeature" />properties to Liquid.
+/// </summary>
+/// <remarks>
+/// Exposes the following properties:
+/// - CanTrack
+/// - HasConsent
+/// - IsConsentNeeded
+/// - CookieName
+/// - CookieValue
+/// </remarks>
+internal sealed class TrackingConsentValue : FluidValue
+{
+    public override FluidValues Type => FluidValues.Object;
+
+    public override bool Equals(FluidValue other) 
+        => other is TrackingConsentValue;
+
+    public override bool ToBooleanValue() => true;
+
+    public override decimal ToNumberValue() => 0;
+
+    public override object ToObjectValue() => null!;
+
+    public override string ToStringValue() => "TrackingConsent";
+
+    protected override FluidValue GetValue(string name, TemplateContext context)
+    {
+        var feature = GetTrackingFeature(context);
+
+        if (feature is null)
+        {
+            return NilValue.Instance;
+        }
+
+        return name switch
+        {
+            nameof(ITrackingConsentFeature.CanTrack) => BooleanValue.Create(feature.CanTrack),
+            nameof(ITrackingConsentFeature.HasConsent) => BooleanValue.Create(feature.HasConsent),
+            nameof(ITrackingConsentFeature.IsConsentNeeded) => BooleanValue.Create(feature.IsConsentNeeded),
+            "CookieName" => new StringValue(GetCookiePolicyOptions(context)?.ConsentCookie?.Name ?? string.Empty),
+            "CookieValue" => new StringValue(GetCookiePolicyOptions(context)?.ConsentCookieValue ?? string.Empty),
+            _ => NilValue.Instance
+        };
+    }
+
+    private static ITrackingConsentFeature? GetTrackingFeature(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 httpContext?.Features.Get<ITrackingConsentFeature>();
+    }
+
+    private static CookiePolicyOptions? GetCookiePolicyOptions(TemplateContext context)
+    {
+        var ctx = context as LiquidTemplateContext
+            ?? throw new InvalidOperationException($"An implementation of '{nameof(LiquidTemplateContext)}' is required");
+
+        return ctx.Services.GetService<IOptions<CookiePolicyOptions>>()?.Value;
+    }
+}

src/docs/reference/modules/Liquid/README.md

@@ -559,6 +559,36 @@ Removes key from HttpContext.Items collection
 
 `{% httpcontext_remove_items "Item1" %}`
 
+### TrackingConsent
+
+Represents the tracking consent feature of the current request.
+
+The following properties are available on the `TrackingConsent` object.
+
+| Property | Example | Description |
+| --------- | ---- |------------ |
+| `CanTrack` | `true` | Indicates if tracking is allowed. |
+| `HasConsent` | `true` | Indicates if the user has given consent for tracking. |
+| `IsConsentNeeded` | `false` | Indicates if consent is needed for tracking. |
+| `CookieName` | `ConsentCookie` | The name of the consent cookie. |
+| `CookieValue` | `true` | The value of the consent cookie. |
+
+#### Usage
+
+Here is an example of how to use the `TrackingConsent` object in a Liquid template:
+
+```liquid
+{% if TrackingConsent.CanTrack %}
+    {% if TrackingConsent.HasConsent %}
+        <p>Tracking is allowed and the user has given consent.</p>
+    {% else %}
+        <p>Tracking is allowed but the user has not given consent.</p>
+    {% endif %}
+{% else %}
+    <p>Tracking is not allowed.</p>
+{% endif %}
+```
+
 ## Shape Filters
 
 These filters let you create and filter shapes.