feat(liquid filter): add returnurlfilter

Author: M-A-Boucher

src/Modules/StatCan.OrchardCore.DisplayHelpers/Filters/ReturnUrlFilter.cs

@@ -0,0 +1,43 @@
+using Fluid;
+using Fluid.Values;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using OrchardCore.Liquid;
+using System;
+using System.Threading.Tasks;
+
+namespace StatCan.OrchardCore.DisplayHelpers.Filters
+{
+    public class ReturnUrlFilter : ILiquidFilter
+    {
+        private readonly HttpContext _httpContext;
+
+        public ReturnUrlFilter(IHttpContextAccessor httpContextAccessor)
+        {
+            _httpContext = httpContextAccessor.HttpContext;
+        }
+
+        public ValueTask<FluidValue> ProcessAsync(FluidValue input, FilterArguments arguments, TemplateContext context)
+        {
+            if (!context.AmbientValues.TryGetValue("UrlHelper", out var urlHelper))
+            {
+                throw new ArgumentException("UrlHelper missing while invoking 'return_url'");
+            }
+
+            var returnPath = (_httpContext.Request.PathBase + _httpContext.Request.Path).ToString();
+            if (arguments["type"].Or(arguments.At(0)).ToStringValue() != "")
+            {
+                returnPath = arguments["type"].Or(arguments.At(0)).ToStringValue();
+            }
+            returnPath = returnPath.TrimEnd('/').Trim();
+
+            if (input.ToStringValue() == "")
+            {
+                return new ValueTask<FluidValue>(new StringValue(((IUrlHelper)urlHelper).Content(returnPath)));
+            }
+
+            var targetPath = input.ToStringValue().TrimEnd('/').Trim();
+            return new ValueTask<FluidValue>(new StringValue(((IUrlHelper)urlHelper).Content(string.Concat(targetPath, "?returnUrl=", returnPath))));
+        }
+    }
+}

src/Modules/StatCan.OrchardCore.DisplayHelpers/Startup.cs

@@ -28,6 +28,7 @@ public override void ConfigureServices(IServiceCollection services)
             services.AddLiquidFilter<UserEmailFilter>("user_email");
             services.AddLiquidFilter<IsCurrentUrlFilter>("is_current_url");
             services.AddLiquidFilter<GetClaimLiquidFilter>("get_claim");
+            services.AddLiquidFilter<ReturnUrlFilter>("return_url");
             services.AddTagHelpers<SetHttpContextItemsTagHelper>();
             services.AddScoped<ILiquidTemplateEventHandler, HttpContextItemsEventHandler>();
         }

src/Themes/PortalTheme/Views/Content-Page.liquid

@@ -1,4 +1,3 @@
-{% assign page_url = Model.ContentItem | display_url %}
 {% for item in Model.ContentItem.Content.FlowPart.Widgets %}
     {{ item | shape_build_display | shape_render }}
 {% endfor %}

src/Themes/PortalTheme/Views/MenuItemLink-LoginMenuItem.liquid

@@ -1,9 +1,7 @@
-{% comment %}page_url must be set on the Page content{% endcomment %}
-{% assign return_url = '~/login?returnUrl=' | append: page_url | href %}
 {% if User.Identity.IsAuthenticated %}
     <a href="#" class="dropdown-item d-lg-none d-flex" data-toggle="modal" data-target="#profile-modal" >{{ "Account" | t }}</a>
     <a href="#" class="btn btn-primary is-circle d-lg-flex d-none" data-toggle="modal" data-target="#profile-modal" aria-label="{{ 'Account' | t }}"><i class="fas fa-user"></i></a>
 {% else %}
-    <a href="{{ return_url }}" class="dropdown-item d-lg-none d-flex">{{ "Log in" | t }}</a>
-    <a href="{{ return_url }}" class="btn btn-primary is-circle d-lg-flex d-none" aria-label="{{ 'Log in' | t }}"><i class="fas fa-sign-in-alt"></i></a>
+    <a href="{{ '~/login' | return_url }}" class="dropdown-item d-lg-none d-flex">{{ "Log in" | t }}</a>
+    <a href="{{ '~/login' | return_url }}" class="btn btn-primary is-circle d-lg-flex d-none" aria-label="{{ 'Log in' | t }}"><i class="fas fa-sign-in-alt"></i></a>
 {% endif %}

src/Themes/PortalTheme/Views/ModalBonusAction.liquid

@@ -32,6 +32,7 @@
       <div class="modal-footer di-modal">
         <input name="User" type="hidden" value="{{ User.Identity.Name }}" />
         <input name="Email" type="hidden" value="{{ User | get_claim: 'email' }}" />
+        <input name="ReturnUrl" type="hidden" value="{{ '' | return_url }}" />
         {% antiforgerytoken %}
         <button type="submit" class="btn btn-lg btn-primary is-rounded">{{ "Send request" | t }}</button>
       </div>

src/Themes/PortalTheme/Views/ModalFeedback.liquid

@@ -88,6 +88,7 @@
       <div class="modal-footer di-modal">
         <input name="User" type="hidden" value="{{ User.Identity.Name }}" />
         <input name="Email" type="hidden" value="{{ User | get_claim: 'email' }}" />
+        <input name="ReturnUrl" type="hidden" value="{{ '' | return_url }}" />
         {% antiforgerytoken %}
         <button type="submit" class="btn btn-lg btn-primary is-rounded">{{ "Send feedback" | t }}</button>
       </div>

src/Themes/PortalTheme/Views/ModalProfile.liquid

@@ -1,6 +1,5 @@
 {% zone "Modal" %}
-{% comment %}page_url must be set on the Page content{% endcomment %}
-{% assign return_url = '~/login?returnUrl=' | append: page_url | href %}
+{% assign return_url = '' | return_url %}
 <div id="profile-modal" class="modal fade" tabindex="-1" role="dialog" aria-hidden="true">
     <div class="modal-dialog modal-dialog-centered di-modal" role="document">
         <div class="modal-content section-panel di-modal">
@@ -29,7 +28,7 @@
               </div>
           </div>
           <div class="modal-footer di-modal">
-              {% form asp_route_area:"OrchardCore.Users", asp_controller:"Account", asp_action:"LogOff", asp_returnUrl:return_url, method: "post" %}
+              {% form asp_route_area:"OrchardCore.Users", asp_controller:"Account", asp_action:"LogOff", method: "post" %}
                   <button type="submit" class="btn btn-lg btn-primary is-rounded">{{ "Log out" | t }}</button>
               {% endform %}
           </div>

src/Themes/PortalTheme/Views/Widget-Hero.liquid

@@ -1,5 +1,3 @@
-{% comment %}page_url must be set on the Page content{% endcomment %}
-{% assign return_url = '~/login?returnUrl=' | append: page_url | href %}
 <section class="hero is-fullheight portal-hud">
   <div class="container">
   	<header class="hero-header">
@@ -15,7 +13,7 @@
         {% else %}
           {% unless User.Identity.IsAuthenticated %}
             <ul class="navbar-nav">
-              <a href="{{ return_url }}" class="btn btn-lg btn-primary is-rounded nav-link mt-5">{{ "Log in" | t }}</a>
+              <a href="{{ '~/login' | return_url }}" class="btn btn-lg btn-primary is-rounded nav-link mt-5">{{ "Log in" | t }}</a>
             </ul>
           {% endunless %}
         {% endif %}