using System; using System.Collections; using System.Collections.Generic; using System.Linq; using System.Xml.XPath; using Examine; using Examine.Search; using Umbraco.Core; using Umbraco.Core.Models.PublishedContent; using Umbraco.Core.Xml; using Umbraco.Examine; using Umbraco.Web.PublishedCache; namespace Umbraco.Web { /// /// A class used to query for published content, media items /// public class PublishedContentQuery : IPublishedContentQuery { private readonly IPublishedSnapshot _publishedSnapshot; private readonly IVariationContextAccessor _variationContextAccessor; private readonly IExamineManager _examineManager; [Obsolete("Use the constructor with all parameters instead")] public PublishedContentQuery(IPublishedSnapshot publishedSnapshot, IVariationContextAccessor variationContextAccessor) : this (publishedSnapshot, variationContextAccessor, ExamineManager.Instance) { } /// /// Initializes a new instance of the class. /// public PublishedContentQuery(IPublishedSnapshot publishedSnapshot, IVariationContextAccessor variationContextAccessor, IExamineManager examineManager) { _publishedSnapshot = publishedSnapshot ?? throw new ArgumentNullException(nameof(publishedSnapshot)); _variationContextAccessor = variationContextAccessor ?? throw new ArgumentNullException(nameof(variationContextAccessor)); _examineManager = examineManager ?? throw new ArgumentNullException(nameof(examineManager)); } #region Content public IPublishedContent Content(int id) { return ItemById(id, _publishedSnapshot.Content); } public IPublishedContent Content(Guid id) { return ItemById(id, _publishedSnapshot.Content); } public IPublishedContent Content(Udi id) { if (!(id is GuidUdi udi)) return null; return ItemById(udi.Guid, _publishedSnapshot.Content); } public IPublishedContent ContentSingleAtXPath(string xpath, params XPathVariable[] vars) { return ItemByXPath(xpath, vars, _publishedSnapshot.Content); } public IEnumerable Content(IEnumerable ids) { return ItemsByIds(_publishedSnapshot.Content, ids); } public IEnumerable Content(IEnumerable ids) { return ItemsByIds(_publishedSnapshot.Content, ids); } public IEnumerable ContentAtXPath(string xpath, params XPathVariable[] vars) { return ItemsByXPath(xpath, vars, _publishedSnapshot.Content); } public IEnumerable ContentAtXPath(XPathExpression xpath, params XPathVariable[] vars) { return ItemsByXPath(xpath, vars, _publishedSnapshot.Content); } public IEnumerable ContentAtRoot() { return ItemsAtRoot(_publishedSnapshot.Content); } #endregion #region Media public IPublishedContent Media(int id) { return ItemById(id, _publishedSnapshot.Media); } public IPublishedContent Media(Guid id) { return ItemById(id, _publishedSnapshot.Media); } public IPublishedContent Media(Udi id) { if (!(id is GuidUdi udi)) return null; return ItemById(udi.Guid, _publishedSnapshot.Media); } public IEnumerable Media(IEnumerable ids) { return ItemsByIds(_publishedSnapshot.Media, ids); } public IEnumerable Media(IEnumerable ids) { return ItemsByIds(_publishedSnapshot.Media, ids); } public IEnumerable MediaAtRoot() { return ItemsAtRoot(_publishedSnapshot.Media); } #endregion #region Used by Content/Media private static IPublishedContent ItemById(int id, IPublishedCache cache) { var doc = cache.GetById(id); return doc; } private static IPublishedContent ItemById(Guid id, IPublishedCache cache) { var doc = cache.GetById(id); return doc; } 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; //} private static IEnumerable ItemsByIds(IPublishedCache cache, IEnumerable ids) { return ids.Select(eachId => ItemById(eachId, cache)).WhereNotNull(); } private IEnumerable ItemsByIds(IPublishedCache cache, IEnumerable ids) { return ids.Select(eachId => ItemById(eachId, cache)).WhereNotNull(); } private static IEnumerable ItemsByXPath(string xpath, XPathVariable[] vars, IPublishedCache cache) { var doc = cache.GetByXPath(xpath, vars); return doc; } private static IEnumerable ItemsByXPath(XPathExpression xpath, XPathVariable[] vars, IPublishedCache cache) { var doc = cache.GetByXPath(xpath, vars); return doc; } private static IEnumerable ItemsAtRoot(IPublishedCache cache) { return cache.GetAtRoot(); } #endregion #region Search /// public IEnumerable Search(string term, string culture = "*", string indexName = null) { return Search(term, 0, 0, out _, culture, indexName); } /// public IEnumerable Search(string term, int skip, int take, out long totalRecords, string culture = "*", string indexName = null) { if (string.IsNullOrEmpty(indexName)) { indexName = Constants.UmbracoIndexes.ExternalIndexName; } if (!_examineManager.TryGetIndex(indexName, out var index) || !(index is IUmbracoIndex umbIndex)) { throw new InvalidOperationException($"No index found by name {indexName} or is not of type {typeof(IUmbracoIndex)}"); } var searcher = umbIndex.GetSearcher(); ISearchResults results; if (culture == "*") { // Search everything results = skip == 0 && take == 0 ? searcher.Search(term) : searcher.Search(term, skip + take); } else { IBooleanOperation query; if (string.IsNullOrWhiteSpace(culture)) { // Only search invariant query = searcher.CreateQuery() .Field(UmbracoContentIndex.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 query = searcher.CreateQuery() .ManagedQuery(term, fields); } results = skip == 0 && take == 0 ? query.Execute() : query.Execute(skip + take); } totalRecords = results.TotalItemCount; return new CultureContextualSearchResults(results.Skip(skip).ToPublishedSearchResults(_publishedSnapshot.Content), _variationContextAccessor, culture); } /// public IEnumerable Search(IQueryExecutor query) { return Search(query, 0, 0, out _); } /// public IEnumerable Search(IQueryExecutor query, int skip, int take, out long totalRecords) { var results = skip == 0 && take == 0 ? query.Execute() : query.Execute(skip + take); totalRecords = results.TotalItemCount; return results.Skip(skip).ToPublishedSearchResults(_publishedSnapshot.Content); } /// /// This is used to contextualize the values in the search results when enumerating over them so that the correct culture values are used /// private class CultureContextualSearchResults : IEnumerable { private readonly IEnumerable _wrapped; private readonly IVariationContextAccessor _variationContextAccessor; private readonly string _culture; public CultureContextualSearchResults(IEnumerable wrapped, IVariationContextAccessor variationContextAccessor, string culture) { _wrapped = wrapped; _variationContextAccessor = variationContextAccessor; _culture = culture; } public IEnumerator GetEnumerator() { //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); } IEnumerator IEnumerable.GetEnumerator() { return GetEnumerator(); } /// /// Resets the variation context when this is disposed /// private class CultureContextualSearchResultsEnumerator : IEnumerator { private readonly IEnumerator _wrapped; private readonly IVariationContextAccessor _variationContextAccessor; private readonly VariationContext _originalContext; public CultureContextualSearchResultsEnumerator(IEnumerator wrapped, IVariationContextAccessor variationContextAccessor, VariationContext originalContext) { _wrapped = wrapped; _variationContextAccessor = variationContextAccessor; _originalContext = originalContext; } public void Dispose() { _wrapped.Dispose(); //reset _variationContextAccessor.VariationContext = _originalContext; } public bool MoveNext() { return _wrapped.MoveNext(); } public void Reset() { _wrapped.Reset(); } public PublishedSearchResult Current => _wrapped.Current; object IEnumerator.Current => Current; } } #endregion } }