Determine urls at save and publish time (#17033)
* Started work on service * temp work * temp commit * Temp commit * Added more routing logic * Fixed tests * Refactor and prepare for isdraft * Work on drafts * Fixed tests * Move to enlistment to ensure caches is only updated on scope complete * Clean up and handle null cultures * Added functionality to the INavigationQueryService to get root keys * Added migration * Fixed issue with navigation * Added migration * Temp commit, move to cache refreshers. * Fixed issues * List urls * fix build * Fixed integration tests * Refactor to create new content finder instead of changing the old * rollback wrong commited line * Clean up, and use docuemnt url service for index * Fixed List endpoin * Do not use Navigation service in methods intended by management api * Fixed examine tests * Make methods virtual * Use domain from published request * Use hybrid cache from new content finder * Eliminate nucache usage * Fixed issue with delivery api and url generation * Fixed linux tests * Added hybrid cache to all integration tests
This commit is contained in:
Bjarke Berg
284
src/Umbraco.Core/Routing/NewDefaultUrlProvider.cs
Normal file
284
src/Umbraco.Core/Routing/NewDefaultUrlProvider.cs
Normal file
@@ -0,0 +1,284 @@
|
||||
using System.Globalization;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Microsoft.Extensions.Options;
|
||||
using Umbraco.Cms.Core.Configuration.Models;
|
||||
using Umbraco.Cms.Core.Models;
|
||||
using Umbraco.Cms.Core.Models.PublishedContent;
|
||||
using Umbraco.Cms.Core.PublishedCache;
|
||||
using Umbraco.Cms.Core.Services;
|
||||
using Umbraco.Cms.Core.Web;
|
||||
using Umbraco.Extensions;
|
||||
|
||||
namespace Umbraco.Cms.Core.Routing;
|
||||
|
||||
/// <summary>
|
||||
/// Provides urls.
|
||||
/// </summary>
|
||||
public class NewDefaultUrlProvider : IUrlProvider
|
||||
{
|
||||
private readonly ILocalizationService _localizationService;
|
||||
private readonly IPublishedContentCache _publishedContentCache;
|
||||
private readonly IDomainCache _domainCache;
|
||||
private readonly IIdKeyMap _idKeyMap;
|
||||
private readonly IDocumentUrlService _documentUrlService;
|
||||
private readonly ILocalizedTextService? _localizedTextService;
|
||||
private readonly ILogger<DefaultUrlProvider> _logger;
|
||||
private readonly ISiteDomainMapper _siteDomainMapper;
|
||||
private readonly IUmbracoContextAccessor _umbracoContextAccessor;
|
||||
private readonly UriUtility _uriUtility;
|
||||
private RequestHandlerSettings _requestSettings;
|
||||
|
||||
public NewDefaultUrlProvider(
|
||||
IOptionsMonitor<RequestHandlerSettings> requestSettings,
|
||||
ILogger<DefaultUrlProvider> logger,
|
||||
ISiteDomainMapper siteDomainMapper,
|
||||
IUmbracoContextAccessor umbracoContextAccessor,
|
||||
UriUtility uriUtility,
|
||||
ILocalizationService localizationService,
|
||||
IPublishedContentCache publishedContentCache,
|
||||
IDomainCache domainCache,
|
||||
IIdKeyMap idKeyMap,
|
||||
IDocumentUrlService documentUrlService)
|
||||
{
|
||||
_requestSettings = requestSettings.CurrentValue;
|
||||
_logger = logger;
|
||||
_siteDomainMapper = siteDomainMapper;
|
||||
_umbracoContextAccessor = umbracoContextAccessor;
|
||||
_uriUtility = uriUtility;
|
||||
_localizationService = localizationService;
|
||||
_publishedContentCache = publishedContentCache;
|
||||
_domainCache = domainCache;
|
||||
_idKeyMap = idKeyMap;
|
||||
_documentUrlService = documentUrlService;
|
||||
|
||||
requestSettings.OnChange(x => _requestSettings = x);
|
||||
}
|
||||
|
||||
#region GetOtherUrls
|
||||
|
||||
/// <summary>
|
||||
/// Gets the other URLs of a published content.
|
||||
/// </summary>
|
||||
/// <param name="id">The published content id.</param>
|
||||
/// <param name="current">The current absolute URL.</param>
|
||||
/// <returns>The other URLs for the published content.</returns>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Other URLs are those that <c>GetUrl</c> would not return in the current context, but would be valid
|
||||
/// URLs for the node in other contexts (different domain for current request, umbracoUrlAlias...).
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public virtual IEnumerable<UrlInfo> GetOtherUrls(int id, Uri current)
|
||||
{
|
||||
var keyAttempt = _idKeyMap.GetKeyForId(id, UmbracoObjectTypes.Document);
|
||||
|
||||
if (keyAttempt.Success is false)
|
||||
{
|
||||
yield break;
|
||||
}
|
||||
|
||||
var key = keyAttempt.Result;
|
||||
|
||||
IPublishedContent? node = _publishedContentCache.GetById(key);
|
||||
if (node == null)
|
||||
{
|
||||
yield break;
|
||||
}
|
||||
|
||||
|
||||
|
||||
// look for domains, walking up the tree
|
||||
IPublishedContent? n = node;
|
||||
IEnumerable<DomainAndUri>? domainUris =
|
||||
DomainUtilities.DomainsForNode(_domainCache, _siteDomainMapper, n.Id, current, false);
|
||||
|
||||
// n is null at root
|
||||
while (domainUris == null && n != null)
|
||||
{
|
||||
n = n.Parent; // move to parent node
|
||||
domainUris = n == null
|
||||
? null
|
||||
: DomainUtilities.DomainsForNode(_domainCache, _siteDomainMapper, n.Id, current);
|
||||
}
|
||||
|
||||
// no domains = exit
|
||||
if (domainUris == null)
|
||||
{
|
||||
yield break;
|
||||
}
|
||||
|
||||
foreach (DomainAndUri d in domainUris)
|
||||
{
|
||||
var culture = d.Culture;
|
||||
|
||||
// although we are passing in culture here, if any node in this path is invariant, it ignores the culture anyways so this is ok
|
||||
var route = GetLegacyRouteFormatById(key, culture);
|
||||
if (route == null)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
// need to strip off the leading ID for the route if it exists (occurs if the route is for a node with a domain assigned)
|
||||
var pos = route.IndexOf('/');
|
||||
var path = pos == 0 ? route : route.Substring(pos);
|
||||
|
||||
var uri = new Uri(CombinePaths(d.Uri.GetLeftPart(UriPartial.Path), path));
|
||||
uri = _uriUtility.UriFromUmbraco(uri, _requestSettings);
|
||||
yield return UrlInfo.Url(uri.ToString(), culture);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the legacy route format by id
|
||||
/// </summary>
|
||||
/// <param name="key"></param>
|
||||
/// <param name="culture"></param>
|
||||
/// <returns></returns>
|
||||
/// <remarks>
|
||||
/// When no domain is set the route can be something like /child/grandchild
|
||||
/// When a domain is set, the route can be something like 1234/grandchild
|
||||
/// </remarks>
|
||||
|
||||
private string GetLegacyRouteFormatById(Guid key, string? culture)
|
||||
{
|
||||
|
||||
return _documentUrlService.GetLegacyRouteFormat(key, culture, _umbracoContextAccessor.GetRequiredUmbracoContext().InPreviewMode);
|
||||
|
||||
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region GetUrl
|
||||
|
||||
/// <inheritdoc />
|
||||
public virtual UrlInfo? GetUrl(IPublishedContent content, UrlMode mode, string? culture, Uri current)
|
||||
{
|
||||
if (!current.IsAbsoluteUri)
|
||||
{
|
||||
throw new ArgumentException("Current URL must be absolute.", nameof(current));
|
||||
}
|
||||
|
||||
|
||||
// will not use cache if previewing
|
||||
var route = GetLegacyRouteFormatById(content.Key, culture);
|
||||
|
||||
return GetUrlFromRoute(route, content.Id, current, mode, culture);
|
||||
}
|
||||
|
||||
internal UrlInfo? GetUrlFromRoute(
|
||||
string? route,
|
||||
int id,
|
||||
Uri current,
|
||||
UrlMode mode,
|
||||
string? culture)
|
||||
{
|
||||
if (string.IsNullOrWhiteSpace(route))
|
||||
{
|
||||
if (_logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Debug))
|
||||
{
|
||||
_logger.LogDebug(
|
||||
"Couldn't find any page with nodeId={NodeId}. This is most likely caused by the page not being published.",
|
||||
id);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
// extract domainUri and path
|
||||
// route is /<path> or <domainRootId>/<path>
|
||||
var pos = route.IndexOf('/');
|
||||
var path = pos == 0 ? route : route[pos..];
|
||||
DomainAndUri? domainUri = pos == 0
|
||||
? null
|
||||
: DomainUtilities.DomainForNode(
|
||||
_domainCache,
|
||||
_siteDomainMapper,
|
||||
int.Parse(route[..pos], CultureInfo.InvariantCulture),
|
||||
current,
|
||||
culture);
|
||||
|
||||
var defaultCulture = _localizationService.GetDefaultLanguageIsoCode();
|
||||
if (domainUri is not null || string.IsNullOrEmpty(culture) ||
|
||||
culture.Equals(defaultCulture, StringComparison.InvariantCultureIgnoreCase))
|
||||
{
|
||||
var url = AssembleUrl(domainUri, path, current, mode).ToString();
|
||||
return UrlInfo.Url(url, culture);
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region Utilities
|
||||
|
||||
private Uri AssembleUrl(DomainAndUri? domainUri, string path, Uri current, UrlMode mode)
|
||||
{
|
||||
Uri uri;
|
||||
|
||||
// ignore vdir at that point, UriFromUmbraco will do it
|
||||
// no domain was found
|
||||
if (domainUri == null)
|
||||
{
|
||||
if (current == null)
|
||||
{
|
||||
mode = UrlMode.Relative; // best we can do
|
||||
}
|
||||
|
||||
switch (mode)
|
||||
{
|
||||
case UrlMode.Absolute:
|
||||
uri = new Uri(current!.GetLeftPart(UriPartial.Authority) + path);
|
||||
break;
|
||||
case UrlMode.Relative:
|
||||
case UrlMode.Auto:
|
||||
uri = new Uri(path, UriKind.Relative);
|
||||
break;
|
||||
default:
|
||||
throw new ArgumentOutOfRangeException(nameof(mode));
|
||||
}
|
||||
}
|
||||
|
||||
// a domain was found
|
||||
else
|
||||
{
|
||||
if (mode == UrlMode.Auto)
|
||||
{
|
||||
// this check is a little tricky, we can't just compare domains
|
||||
if (current != null && domainUri.Uri.GetLeftPart(UriPartial.Authority) ==
|
||||
current.GetLeftPart(UriPartial.Authority))
|
||||
{
|
||||
mode = UrlMode.Relative;
|
||||
}
|
||||
else
|
||||
{
|
||||
mode = UrlMode.Absolute;
|
||||
}
|
||||
}
|
||||
|
||||
switch (mode)
|
||||
{
|
||||
case UrlMode.Absolute:
|
||||
uri = new Uri(CombinePaths(domainUri.Uri.GetLeftPart(UriPartial.Path), path));
|
||||
break;
|
||||
case UrlMode.Relative:
|
||||
uri = new Uri(CombinePaths(domainUri.Uri.AbsolutePath, path), UriKind.Relative);
|
||||
break;
|
||||
default:
|
||||
throw new ArgumentOutOfRangeException(nameof(mode));
|
||||
}
|
||||
}
|
||||
|
||||
// UriFromUmbraco will handle vdir
|
||||
// meaning it will add vdir into domain URLs too!
|
||||
return _uriUtility.UriFromUmbraco(uri, _requestSettings);
|
||||
}
|
||||
|
||||
private string CombinePaths(string path1, string path2)
|
||||
{
|
||||
var path = path1.TrimEnd(Constants.CharArrays.ForwardSlash) + path2;
|
||||
return path == "/" ? path : path.TrimEnd(Constants.CharArrays.ForwardSlash);
|
||||
}
|
||||
|
||||
#endregion
|
||||
}
|
||||
Reference in New Issue
Block a user