yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #10618 from umbraco/v9/feature/migration_surface_action_extension_methods

Browse Source 
V9: Migrated surfaceaction extension methods
This commit is contained in:
Warren Buckley
2021-07-07 15:44:51 +01:00
committed by GitHub
parent 530151f749 414b003747
commit dd7b70c448
3 changed files with 183 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
src/Umbraco.Web.Common/Extensions/FriendlyUrlHelperExtensions.cs Normal file
View File

@@ -0,0 +1,50 @@
using Microsoft.AspNetCore.DataProtection;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.DependencyInjection;
using Umbraco.Cms.Core.Web;
using Umbraco.Cms.Web.Common.DependencyInjection;
namespace Umbraco.Extensions
{
public static class FriendlyUrlHelperExtensions
{
private static IUmbracoContext UmbracoContext { get; } =
StaticServiceProvider.Instance.GetRequiredService<IUmbracoContextAccessor>().GetRequiredUmbracoContext();
private static IDataProtectionProvider DataProtectionProvider { get; } =
StaticServiceProvider.Instance.GetRequiredService<IDataProtectionProvider>();
/// <summary>
/// Generates a URL based on the current Umbraco URL with a custom query string that will route to the specified SurfaceController
/// </summary>
/// <param name="url"></param>
/// <param name="action"></param>
/// <param name="controllerName"></param>
/// <returns></returns>
public static string SurfaceAction(this IUrlHelper url, string action, string controllerName)
=> UrlHelperExtensions.SurfaceAction(url, UmbracoContext, DataProtectionProvider, action, controllerName);
/// <summary>
/// Generates a URL based on the current Umbraco URL with a custom query string that will route to the specified SurfaceController
/// </summary>
/// <param name="url"></param>
/// <param name="action"></param>
/// <param name="controllerName"></param>
/// <param name="additionalRouteVals"></param>
/// <returns></returns>
public static string SurfaceAction(this IUrlHelper url, string action, string controllerName, object additionalRouteVals)
=> UrlHelperExtensions.SurfaceAction(url, UmbracoContext, DataProtectionProvider, action, controllerName, additionalRouteVals);
/// <summary>
/// Generates a URL based on the current Umbraco URL with a custom query string that will route to the specified SurfaceController
/// </summary>
/// <param name="url"></param>
/// <param name="action"></param>
/// <param name="controllerName"></param>
/// <param name="area"></param>
/// <param name="additionalRouteVals"></param>
/// <returns></returns>
public static string SurfaceAction(this IUrlHelper url, string action, string controllerName, string area, object additionalRouteVals)
=> UrlHelperExtensions.SurfaceAction(url, UmbracoContext, DataProtectionProvider, action, controllerName, area, additionalRouteVals);
}
}

50
src/Umbraco.Web.Common/Extensions/UrlHelperExtensions.cs
View File

@@ -1,8 +1,10 @@
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Linq.Expressions;
using System.Web;
using Microsoft.AspNetCore.DataProtection;
using Microsoft.AspNetCore.Html;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Routing;
@@ -12,8 +14,10 @@ using Umbraco.Cms.Core.Hosting;
using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Models.PublishedContent;
using Umbraco.Cms.Core.PropertyEditors.ValueConverters;
using Umbraco.Cms.Core.Web;
using Umbraco.Cms.Core.WebAssets;
using Umbraco.Cms.Web.Common.Controllers;
using Umbraco.Cms.Web.Common.Security;
namespace Umbraco.Extensions
{
@@ -280,5 +284,51 @@ namespace Umbraco.Extensions
return htmlEncode ? new HtmlString(HttpUtility.HtmlEncode(url)) : new HtmlString(url);
}
/// <summary>
/// Generates a URL based on the current Umbraco URL with a custom query string that will route to the specified SurfaceController
/// </summary>
/// <param name="url"></param>
/// <param name="action"></param>
/// <param name="controllerName"></param>
/// <returns></returns>
public static string SurfaceAction(this IUrlHelper url, IUmbracoContext umbracoContext, IDataProtectionProvider dataProtectionProvider,string action, string controllerName)
{
return url.SurfaceAction(umbracoContext, dataProtectionProvider, action, controllerName, null);
}
/// <summary>
/// Generates a URL based on the current Umbraco URL with a custom query string that will route to the specified SurfaceController
/// </summary>
/// <param name="url"></param>
/// <param name="action"></param>
/// <param name="controllerName"></param>
/// <param name="additionalRouteVals"></param>
/// <returns></returns>
public static string SurfaceAction(this IUrlHelper url, IUmbracoContext umbracoContext, IDataProtectionProvider dataProtectionProvider,string action, string controllerName, object additionalRouteVals)
{
return url.SurfaceAction(umbracoContext, dataProtectionProvider, action, controllerName, "", additionalRouteVals);
}
/// <summary>
/// Generates a URL based on the current Umbraco URL with a custom query string that will route to the specified SurfaceController
/// </summary>
/// <param name="url"></param>
/// <param name="action"></param>
/// <param name="controllerName"></param>
/// <param name="area"></param>
/// <param name="additionalRouteVals"></param>
/// <returns></returns>
public static string SurfaceAction(this IUrlHelper url, IUmbracoContext umbracoContext, IDataProtectionProvider dataProtectionProvider, string action, string controllerName, string area, object additionalRouteVals)
{
if (action == null) throw new ArgumentNullException(nameof(action));
if (string.IsNullOrEmpty(action)) throw new ArgumentException("Value can't be empty.", nameof(action));
if (controllerName == null) throw new ArgumentNullException(nameof(controllerName));
if (string.IsNullOrEmpty(controllerName)) throw new ArgumentException("Value can't be empty.", nameof(controllerName));
var encryptedRoute = EncryptionHelper.CreateEncryptedRouteString(dataProtectionProvider, controllerName, action, area, additionalRouteVals);
var result = umbracoContext.OriginalRequestUrl.AbsolutePath.EnsureEndsWith('?') + "ufprt=" + encryptedRoute;
return result;
}
}
}

166
src/Umbraco.Web/UrlHelperRenderExtensions.cs
View File

@@ -261,52 +261,52 @@ namespace Umbraco.Web
//
// #endregion
/// <summary>
/// Generates a URL based on the current Umbraco URL with a custom query string that will route to the specified SurfaceController
/// </summary>
/// <param name="url"></param>
/// <param name="action"></param>
/// <param name="controllerName"></param>
/// <returns></returns>
public static string SurfaceAction(this UrlHelper url, string action, string controllerName)
{
return url.SurfaceAction(action, controllerName, null);
}
/// <summary>
/// Generates a URL based on the current Umbraco URL with a custom query string that will route to the specified SurfaceController
/// </summary>
/// <param name="url"></param>
/// <param name="action"></param>
/// <param name="controllerName"></param>
/// <param name="additionalRouteVals"></param>
/// <returns></returns>
public static string SurfaceAction(this UrlHelper url, string action, string controllerName, object additionalRouteVals)
{
return url.SurfaceAction(action, controllerName, "", additionalRouteVals);
}
/// <summary>
/// Generates a URL based on the current Umbraco URL with a custom query string that will route to the specified SurfaceController
/// </summary>
/// <param name="url"></param>
/// <param name="action"></param>
/// <param name="controllerName"></param>
/// <param name="area"></param>
/// <param name="additionalRouteVals"></param>
/// <returns></returns>
public static string SurfaceAction(this UrlHelper url, string action, string controllerName, string area, object additionalRouteVals)
{
if (action == null) throw new ArgumentNullException(nameof(action));
if (string.IsNullOrEmpty(action)) throw new ArgumentException("Value can't be empty.", nameof(action));
if (controllerName == null) throw new ArgumentNullException(nameof(controllerName));
if (string.IsNullOrEmpty(controllerName)) throw new ArgumentException("Value can't be empty.", nameof(controllerName));
var encryptedRoute = CreateEncryptedRouteString(controllerName, action, area, additionalRouteVals);
var result = Current.UmbracoContext.OriginalRequestUrl.AbsolutePath.EnsureEndsWith('?') + "ufprt=" + encryptedRoute;
return result;
}
// /// <summary>
// /// Generates a URL based on the current Umbraco URL with a custom query string that will route to the specified SurfaceController
// /// </summary>
// /// <param name="url"></param>
// /// <param name="action"></param>
// /// <param name="controllerName"></param>
// /// <returns></returns>
// public static string SurfaceAction(this UrlHelper url, string action, string controllerName)
// {
// return url.SurfaceAction(action, controllerName, null);
// }
//
// /// <summary>
// /// Generates a URL based on the current Umbraco URL with a custom query string that will route to the specified SurfaceController
// /// </summary>
// /// <param name="url"></param>
// /// <param name="action"></param>
// /// <param name="controllerName"></param>
// /// <param name="additionalRouteVals"></param>
// /// <returns></returns>
// public static string SurfaceAction(this UrlHelper url, string action, string controllerName, object additionalRouteVals)
// {
// return url.SurfaceAction(action, controllerName, "", additionalRouteVals);
// }
//
// /// <summary>
// /// Generates a URL based on the current Umbraco URL with a custom query string that will route to the specified SurfaceController
// /// </summary>
// /// <param name="url"></param>
// /// <param name="action"></param>
// /// <param name="controllerName"></param>
// /// <param name="area"></param>
// /// <param name="additionalRouteVals"></param>
// /// <returns></returns>
// public static string SurfaceAction(this UrlHelper url, string action, string controllerName, string area, object additionalRouteVals)
// {
// if (action == null) throw new ArgumentNullException(nameof(action));
// if (string.IsNullOrEmpty(action)) throw new ArgumentException("Value can't be empty.", nameof(action));
// if (controllerName == null) throw new ArgumentNullException(nameof(controllerName));
// if (string.IsNullOrEmpty(controllerName)) throw new ArgumentException("Value can't be empty.", nameof(controllerName));
//
// var encryptedRoute = CreateEncryptedRouteString(controllerName, action, area, additionalRouteVals);
//
// var result = Current.UmbracoContext.OriginalRequestUrl.AbsolutePath.EnsureEndsWith('?') + "ufprt=" + encryptedRoute;
// return result;
// }
//TODO Move to LinkGenerator
// /// <summary>
@@ -384,42 +384,42 @@ namespace Umbraco.Web
// return url.SurfaceAction(action, typeof (T), additionalRouteVals);
// }
/// <summary>
/// This is used in methods like BeginUmbracoForm and SurfaceAction to generate an encrypted string which gets submitted in a request for which
/// Umbraco can decrypt during the routing process in order to delegate the request to a specific MVC Controller.
/// </summary>
/// <param name="controllerName"></param>
/// <param name="controllerAction"></param>
/// <param name="area"></param>
/// <param name="additionalRouteVals"></param>
/// <returns></returns>
internal static string CreateEncryptedRouteString(string controllerName, string controllerAction, string area, object additionalRouteVals = null)
{
if (controllerName == null) throw new ArgumentNullException(nameof(controllerName));
if (string.IsNullOrEmpty(controllerName)) throw new ArgumentException("Value can't be empty.", nameof(controllerName));
if (controllerAction == null) throw new ArgumentNullException(nameof(controllerAction));
if (string.IsNullOrEmpty(controllerAction)) throw new ArgumentException("Value can't be empty.", nameof(controllerAction));
if (area == null) throw new ArgumentNullException(nameof(area));
//need to create a params string as Base64 to put into our hidden field to use during the routes
var surfaceRouteParams = $"c={HttpUtility.UrlEncode(controllerName)}&a={HttpUtility.UrlEncode(controllerAction)}&ar={area}";
//checking if the additional route values is already a dictionary and convert to querystring
string additionalRouteValsAsQuery;
if (additionalRouteVals != null)
{
if (additionalRouteVals is Dictionary<string, object> additionalRouteValsAsDictionary)
additionalRouteValsAsQuery = additionalRouteValsAsDictionary.ToQueryString();
else
additionalRouteValsAsQuery = additionalRouteVals.ToDictionary<object>().ToQueryString();
}
else
additionalRouteValsAsQuery = null;
if (additionalRouteValsAsQuery.IsNullOrWhiteSpace() == false)
surfaceRouteParams += "&" + additionalRouteValsAsQuery;
return surfaceRouteParams.EncryptWithMachineKey();
}
// /// <summary>
// /// This is used in methods like BeginUmbracoForm and SurfaceAction to generate an encrypted string which gets submitted in a request for which
// /// Umbraco can decrypt during the routing process in order to delegate the request to a specific MVC Controller.
// /// </summary>
// /// <param name="controllerName"></param>
// /// <param name="controllerAction"></param>
// /// <param name="area"></param>
// /// <param name="additionalRouteVals"></param>
// /// <returns></returns>
// internal static string CreateEncryptedRouteString(string controllerName, string controllerAction, string area, object additionalRouteVals = null)
// {
// if (controllerName == null) throw new ArgumentNullException(nameof(controllerName));
// if (string.IsNullOrEmpty(controllerName)) throw new ArgumentException("Value can't be empty.", nameof(controllerName));
// if (controllerAction == null) throw new ArgumentNullException(nameof(controllerAction));
// if (string.IsNullOrEmpty(controllerAction)) throw new ArgumentException("Value can't be empty.", nameof(controllerAction));
// if (area == null) throw new ArgumentNullException(nameof(area));
//
// //need to create a params string as Base64 to put into our hidden field to use during the routes
// var surfaceRouteParams = $"c={HttpUtility.UrlEncode(controllerName)}&a={HttpUtility.UrlEncode(controllerAction)}&ar={area}";
//
// //checking if the additional route values is already a dictionary and convert to querystring
// string additionalRouteValsAsQuery;
// if (additionalRouteVals != null)
// {
// if (additionalRouteVals is Dictionary<string, object> additionalRouteValsAsDictionary)
// additionalRouteValsAsQuery = additionalRouteValsAsDictionary.ToQueryString();
// else
// additionalRouteValsAsQuery = additionalRouteVals.ToDictionary<object>().ToQueryString();
// }
// else
// additionalRouteValsAsQuery = null;
//
// if (additionalRouteValsAsQuery.IsNullOrWhiteSpace() == false)
// surfaceRouteParams += "&" + additionalRouteValsAsQuery;
//
// return surfaceRouteParams.EncryptWithMachineKey();
// }
}
}