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

Merge v10/dev into infrastructure

Browse Source
This commit is contained in:
Nikolaj Geisle
2022-03-16 14:39:28 +01:00
parent 3a2c53412c 4ebd20bb66
commit 214bcceffc
481 changed files with 13916 additions and 6767 deletions
Download Patch File Download Diff File Expand all files Collapse all files

244
src/Umbraco.Infrastructure/PublishedContentQuery.cs
View File

@@ -17,23 +17,25 @@ using Constants = Umbraco.Cms.Core.Constants;
namespace Umbraco.Cms.Infrastructure
{
/// <summary>
/// A class used to query for published content, media items
/// A class used to query for published content, media items
/// </summary>
/// <seealso cref="Umbraco.Cms.Core.IPublishedContentQuery" />
public class PublishedContentQuery : IPublishedContentQuery
{
private readonly IExamineManager _examineManager;
private readonly IPublishedSnapshot _publishedSnapshot;
private readonly IVariationContextAccessor _variationContextAccessor;
private static readonly HashSet<string> s_itemIdFieldNameHashSet =
new HashSet<string>() { ExamineFieldNames.ItemIdFieldName };
/// <summary>
/// Initializes a new instance of the <see cref="PublishedContentQuery" /> class.
/// Initializes a new instance of the <see cref="PublishedContentQuery" /> class.
/// </summary>
public PublishedContentQuery(IPublishedSnapshot publishedSnapshot,
IVariationContextAccessor variationContextAccessor, IExamineManager examineManager)
public PublishedContentQuery(IPublishedSnapshot publishedSnapshot, IVariationContextAccessor variationContextAccessor, IExamineManager examineManager)
{
_publishedSnapshot = publishedSnapshot ?? throw new ArgumentNullException(nameof(publishedSnapshot));
_variationContextAccessor = variationContextAccessor ??
throw new ArgumentNullException(nameof(variationContextAccessor));
_variationContextAccessor = variationContextAccessor ?? throw new ArgumentNullException(nameof(variationContextAccessor));
_examineManager = examineManager ?? throw new ArgumentNullException(nameof(examineManager));
}
@@ -72,6 +74,7 @@ namespace Umbraco.Cms.Infrastructure
return false;
}
}
private static bool ConvertIdObjectToUdi(object id, out Udi? guidId)
{
switch (id)
@@ -93,160 +96,162 @@ namespace Umbraco.Cms.Infrastructure
#region Content
public IPublishedContent? Content(int id) => ItemById(id, _publishedSnapshot.Content);
public IPublishedContent? Content(int id)
=> ItemById(id, _publishedSnapshot.Content);
public IPublishedContent Content(Guid id) => ItemById(id, _publishedSnapshot.Content);
public IPublishedContent Content(Guid id)
=> ItemById(id, _publishedSnapshot.Content);
public IPublishedContent? Content(Udi? id)
{
if (!(id is GuidUdi udi)) return null;
if (!(id is GuidUdi udi))
{
return null;
}
return ItemById(udi.Guid, _publishedSnapshot.Content);
}
public IPublishedContent? Content(object id)
{
if (ConvertIdObjectToInt(id, out var intId))
{
return Content(intId);
}
if (ConvertIdObjectToGuid(id, out var guidId))
{
return Content(guidId);
}
if (ConvertIdObjectToUdi(id, out var udiId))
{
return Content(udiId);
}
return null;
}
public IPublishedContent ContentSingleAtXPath(string xpath, params XPathVariable[] vars) =>
ItemByXPath(xpath, vars, _publishedSnapshot.Content);
public IPublishedContent ContentSingleAtXPath(string xpath, params XPathVariable[] vars)
=> ItemByXPath(xpath, vars, _publishedSnapshot.Content);
public IEnumerable<IPublishedContent> Content(IEnumerable<int> ids) =>
ItemsByIds(_publishedSnapshot.Content, ids);
public IEnumerable<IPublishedContent> Content(IEnumerable<int> ids)
=> ItemsByIds(_publishedSnapshot.Content, ids);
public IEnumerable<IPublishedContent> Content(IEnumerable<Guid> ids) =>
ItemsByIds(_publishedSnapshot.Content, ids);
public IEnumerable<IPublishedContent> Content(IEnumerable<Guid> ids)
=> ItemsByIds(_publishedSnapshot.Content, ids);
public IEnumerable<IPublishedContent> Content(IEnumerable<object> ids)
{
return ids.Select(Content).WhereNotNull();
}
public IEnumerable<IPublishedContent> ContentAtXPath(string xpath, params XPathVariable[] vars) =>
ItemsByXPath(xpath, vars, _publishedSnapshot.Content);
=> ids.Select(Content).WhereNotNull();
public IEnumerable<IPublishedContent> ContentAtXPath(XPathExpression xpath, params XPathVariable[] vars) =>
ItemsByXPath(xpath, vars, _publishedSnapshot.Content);
public IEnumerable<IPublishedContent> ContentAtXPath(string xpath, params XPathVariable[] vars)
=> ItemsByXPath(xpath, vars, _publishedSnapshot.Content);
public IEnumerable<IPublishedContent> ContentAtRoot() => ItemsAtRoot(_publishedSnapshot.Content);
public IEnumerable<IPublishedContent> ContentAtXPath(XPathExpression xpath, params XPathVariable[] vars)
=> ItemsByXPath(xpath, vars, _publishedSnapshot.Content);
public IEnumerable<IPublishedContent> ContentAtRoot()
=> ItemsAtRoot(_publishedSnapshot.Content);
#endregion
#region Media
public IPublishedContent? Media(int id) => ItemById(id, _publishedSnapshot.Media);
public IPublishedContent? Media(int id)
=> ItemById(id, _publishedSnapshot.Media);
public IPublishedContent Media(Guid id) => ItemById(id, _publishedSnapshot.Media);
public IPublishedContent Media(Guid id)
=> ItemById(id, _publishedSnapshot.Media);
public IPublishedContent? Media(Udi? id)
{
if (!(id is GuidUdi udi)) return null;
if (!(id is GuidUdi udi))
{
return null;
}
return ItemById(udi.Guid, _publishedSnapshot.Media);
}
public IPublishedContent? Media(object id)
{
if (ConvertIdObjectToInt(id, out var intId))
{
return Media(intId);
}
if (ConvertIdObjectToGuid(id, out var guidId))
{
return Media(guidId);
}
if (ConvertIdObjectToUdi(id, out var udiId))
{
return Media(udiId);
}
return null;
}
public IEnumerable<IPublishedContent> Media(IEnumerable<int> ids) => ItemsByIds(_publishedSnapshot.Media, ids);
public IEnumerable<IPublishedContent> Media(IEnumerable<int> ids)
=> ItemsByIds(_publishedSnapshot.Media, ids);
public IEnumerable<IPublishedContent> Media(IEnumerable<object> ids)
{
return ids.Select(Media).WhereNotNull();
}
=> ids.Select(Media).WhereNotNull();
public IEnumerable<IPublishedContent> Media(IEnumerable<Guid> ids) => ItemsByIds(_publishedSnapshot.Media, ids);
public IEnumerable<IPublishedContent> Media(IEnumerable<Guid> ids)
=> ItemsByIds(_publishedSnapshot.Media, ids);
public IEnumerable<IPublishedContent> MediaAtRoot() => ItemsAtRoot(_publishedSnapshot.Media);
public IEnumerable<IPublishedContent> MediaAtRoot()
=> ItemsAtRoot(_publishedSnapshot.Media);
#endregion
#region Used by Content/Media
private static IPublishedContent? ItemById(int id, IPublishedCache cache)
{
var doc = cache.GetById(id);
return doc;
}
=> cache.GetById(id);
private static IPublishedContent ItemById(Guid id, IPublishedCache cache)
{
var doc = cache.GetById(id);
return doc;
}
=> cache.GetById(id);
private static IPublishedContent ItemByXPath(string xpath, XPathVariable[] vars, IPublishedCache cache)
{
var doc = cache.GetSingleByXPath(xpath, vars);
return doc;
}
//NOTE: Not used?
//private IPublishedContent ItemByXPath(XPathExpression xpath, XPathVariable[] vars, IPublishedCache cache)
//{
// var doc = cache.GetSingleByXPath(xpath, vars);
// return doc;
//}
=> cache.GetSingleByXPath(xpath, vars);
private static IEnumerable<IPublishedContent> ItemsByIds(IPublishedCache cache, IEnumerable<int> ids)
{
return ids.Select(eachId => ItemById(eachId, cache)).WhereNotNull();
}
=> ids.Select(eachId => ItemById(eachId, cache)).WhereNotNull();
private IEnumerable<IPublishedContent> ItemsByIds(IPublishedCache cache, IEnumerable<Guid> ids)
{
return ids.Select(eachId => ItemById(eachId, cache)).WhereNotNull();
}
=> ids.Select(eachId => ItemById(eachId, cache)).WhereNotNull();
private static IEnumerable<IPublishedContent> ItemsByXPath(string xpath, XPathVariable[] vars,
IPublishedCache cache)
{
var doc = cache.GetByXPath(xpath, vars);
return doc;
}
private static IEnumerable<IPublishedContent> ItemsByXPath(string xpath, XPathVariable[] vars, IPublishedCache cache)
=> cache.GetByXPath(xpath, vars);
private static IEnumerable<IPublishedContent> ItemsByXPath(XPathExpression xpath, XPathVariable[] vars,
IPublishedCache cache)
{
var doc = cache.GetByXPath(xpath, vars);
return doc;
}
private static IEnumerable<IPublishedContent> ItemsByXPath(XPathExpression xpath, XPathVariable[] vars, IPublishedCache cache)
=> cache.GetByXPath(xpath, vars);
private static IEnumerable<IPublishedContent> ItemsAtRoot(IPublishedCache cache) => cache.GetAtRoot();
private static IEnumerable<IPublishedContent> ItemsAtRoot(IPublishedCache cache)
=> cache.GetAtRoot();
#endregion
#region Search
/// <inheritdoc />
public IEnumerable<PublishedSearchResult> Search(string term, string culture = "*",
string indexName = Constants.UmbracoIndexes.ExternalIndexName) =>
Search(term, 0, 0, out _, culture, indexName);
public IEnumerable<PublishedSearchResult> Search(string term, string culture = "*", string indexName = Constants.UmbracoIndexes.ExternalIndexName)
=> Search(term, 0, 0, out _, culture, indexName);
/// <inheritdoc />
public IEnumerable<PublishedSearchResult> Search(string term, int skip, int take, out long totalRecords, string culture = "*", string indexName = Constants.UmbracoIndexes.ExternalIndexName, ISet<string>? loadedFields = null)
{
if (skip < 0)
{
throw new ArgumentOutOfRangeException(nameof(skip), skip,
"The value must be greater than or equal to zero.");
throw new ArgumentOutOfRangeException(nameof(skip), skip, "The value must be greater than or equal to zero.");
}
if (take < 0)
{
throw new ArgumentOutOfRangeException(nameof(take), take,
"The value must be greater than or equal to zero.");
throw new ArgumentOutOfRangeException(nameof(take), take, "The value must be greater than or equal to zero.");
}
if (string.IsNullOrEmpty(indexName))
@@ -254,68 +259,67 @@ namespace Umbraco.Cms.Infrastructure
indexName = Constants.UmbracoIndexes.ExternalIndexName;
}
if (!_examineManager.TryGetIndex(indexName, out var index) || !(index is IUmbracoIndex umbIndex))
if (!_examineManager.TryGetIndex(indexName, out var index) || index is not IUmbracoIndex umbIndex)
{
throw new InvalidOperationException(
$"No index found by name {indexName} or is not of type {typeof(IUmbracoIndex)}");
throw new InvalidOperationException($"No index found by name {indexName} or is not of type {typeof(IUmbracoIndex)}");
}
var query = umbIndex.Searcher.CreateQuery(IndexTypes.Content);
IQueryExecutor queryExecutor;
IOrdering ordering;
if (culture == "*")
{
// Search everything
queryExecutor = query.ManagedQuery(term);
ordering = query.ManagedQuery(term);
}
else if (string.IsNullOrWhiteSpace(culture))
{
// Only search invariant
queryExecutor = query
ordering = query
.Field(UmbracoExamineFieldNames.VariesByCultureFieldName, "n") // Must not vary by culture
.And().ManagedQuery(term);
}
else
{
// Only search the specified culture
var fields =
umbIndex.GetCultureAndInvariantFields(culture)
.ToArray(); // Get all index fields suffixed with the culture name supplied
queryExecutor = query.ManagedQuery(term, fields);
}
if (loadedFields != null && queryExecutor is IBooleanOperation booleanOperation)
{
queryExecutor = booleanOperation.SelectFields(loadedFields);
var fields = umbIndex.GetCultureAndInvariantFields(culture).ToArray(); // Get all index fields suffixed with the culture name supplied
ordering = query.ManagedQuery(term, fields);
}
// Only select item ID field, because results are loaded from the published snapshot based on this single value
var queryExecutor = ordering.SelectFields(s_itemIdFieldNameHashSet);
var results = skip == 0 && take == 0
? queryExecutor.Execute()
: queryExecutor.Execute(QueryOptions.SkipTake(skip, take));
totalRecords = results.TotalItemCount;
return new CultureContextualSearchResults(
results.ToPublishedSearchResults(_publishedSnapshot.Content), _variationContextAccessor,
culture);
return new CultureContextualSearchResults(results.ToPublishedSearchResults(_publishedSnapshot.Content), _variationContextAccessor, culture);
}
/// <inheritdoc />
public IEnumerable<PublishedSearchResult> Search(IQueryExecutor query) => Search(query, 0, 0, out _);
public IEnumerable<PublishedSearchResult> Search(IQueryExecutor query)
=> Search(query, 0, 0, out _);
/// <inheritdoc />
public IEnumerable<PublishedSearchResult> Search(IQueryExecutor query, int skip, int take,
out long totalRecords)
public IEnumerable<PublishedSearchResult> Search(IQueryExecutor query, int skip, int take, out long totalRecords)
{
if (skip < 0)
{
throw new ArgumentOutOfRangeException(nameof(skip), skip,
"The value must be greater than or equal to zero.");
throw new ArgumentOutOfRangeException(nameof(skip), skip, "The value must be greater than or equal to zero.");
}
if (take < 0)
{
throw new ArgumentOutOfRangeException(nameof(take), take,
"The value must be greater than or equal to zero.");
throw new ArgumentOutOfRangeException(nameof(take), take, "The value must be greater than or equal to zero.");
}
if (query is IOrdering ordering)
{
// Only select item ID field, because results are loaded from the published snapshot based on this single value
query = ordering.SelectFields(s_itemIdFieldNameHashSet);
}
var results = skip == 0 && take == 0
@@ -328,8 +332,7 @@ namespace Umbraco.Cms.Infrastructure
}
/// <summary>
/// This is used to contextualize the values in the search results when enumerating over them so that the correct
/// culture values are used
/// This is used to contextualize the values in the search results when enumerating over them, so that the correct culture values are used.
/// </summary>
private class CultureContextualSearchResults : IEnumerable<PublishedSearchResult>
{
@@ -337,8 +340,7 @@ namespace Umbraco.Cms.Infrastructure
private readonly IVariationContextAccessor _variationContextAccessor;
private readonly IEnumerable<PublishedSearchResult> _wrapped;
public CultureContextualSearchResults(IEnumerable<PublishedSearchResult> wrapped,
IVariationContextAccessor variationContextAccessor, string culture)
public CultureContextualSearchResults(IEnumerable<PublishedSearchResult> wrapped, IVariationContextAccessor variationContextAccessor, string culture)
{
_wrapped = wrapped;
_variationContextAccessor = variationContextAccessor;
@@ -347,20 +349,21 @@ namespace Umbraco.Cms.Infrastructure
public IEnumerator<PublishedSearchResult> GetEnumerator()
{
//We need to change the current culture to what is requested and then change it back
// We need to change the current culture to what is requested and then change it back
var originalContext = _variationContextAccessor.VariationContext;
if (!_culture.IsNullOrWhiteSpace() && !_culture.InvariantEquals(originalContext?.Culture))
{
_variationContextAccessor.VariationContext = new VariationContext(_culture);
}
//now the IPublishedContent returned will be contextualized to the culture specified and will be reset when the enumerator is disposed
return new CultureContextualSearchResultsEnumerator(_wrapped.GetEnumerator(), _variationContextAccessor,
originalContext);
// Now the IPublishedContent returned will be contextualized to the culture specified and will be reset when the enumerator is disposed
return new CultureContextualSearchResultsEnumerator(_wrapped.GetEnumerator(), _variationContextAccessor, originalContext);
}
IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
/// <summary>
/// Resets the variation context when this is disposed
/// Resets the variation context when this is disposed.
/// </summary>
private class CultureContextualSearchResultsEnumerator : IEnumerator<PublishedSearchResult>
{
@@ -368,30 +371,31 @@ namespace Umbraco.Cms.Infrastructure
private readonly IVariationContextAccessor _variationContextAccessor;
private readonly IEnumerator<PublishedSearchResult> _wrapped;
public CultureContextualSearchResultsEnumerator(IEnumerator<PublishedSearchResult> wrapped,
IVariationContextAccessor variationContextAccessor, VariationContext? originalContext)
public CultureContextualSearchResultsEnumerator(
IEnumerator<PublishedSearchResult> wrapped,
IVariationContextAccessor variationContextAccessor,
VariationContext? originalContext)
{
_wrapped = wrapped;
_variationContextAccessor = variationContextAccessor;
_originalContext = originalContext;
}
public PublishedSearchResult Current => _wrapped.Current;
object IEnumerator.Current => Current;
public void Dispose()
{
_wrapped.Dispose();
//reset
// Reset to original variation context
_variationContextAccessor.VariationContext = _originalContext;
}
public bool MoveNext() => _wrapped.MoveNext();
public void Reset()
{
_wrapped.Reset();
}
public PublishedSearchResult Current => _wrapped.Current;
object IEnumerator.Current => Current;
public void Reset() => _wrapped.Reset();
}
}