using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using System.Xml.XPath;
using Examine;
using Examine.LuceneEngine.Providers;
using Examine.LuceneEngine.SearchCriteria;
using Examine.SearchCriteria;
using Umbraco.Core;
using Umbraco.Core.Models.PublishedContent;
using Umbraco.Core.Services;
using Umbraco.Core.Xml;
using Umbraco.Web.PublishedCache;
namespace Umbraco.Web
{
using Examine = global::Examine;
///
/// A class used to query for published content, media items
///
public class PublishedContentQuery : IPublishedContentQuery
{
private readonly IPublishedContentQuery _query;
private readonly IPublishedContentCache _contentCache;
private readonly IPublishedMediaCache _mediaCache;
///
/// Constructor used to return results from the caches
///
///
///
public PublishedContentQuery(IPublishedContentCache contentCache, IPublishedMediaCache mediaCache)
{
_contentCache = contentCache ?? throw new ArgumentNullException(nameof(contentCache));
_mediaCache = mediaCache ?? throw new ArgumentNullException(nameof(mediaCache));
}
///
/// Constructor used to wrap the ITypedPublishedContentQuery object passed in
///
///
public PublishedContentQuery(IPublishedContentQuery query)
{
_query = query ?? throw new ArgumentNullException(nameof(query));
}
#region Content
public IPublishedContent Content(int id)
{
return _query == null
? ItemById(id, _contentCache)
: _query.Content(id);
}
public IPublishedContent Content(Guid id)
{
return _query == null
? ItemById(id, _contentCache)
: _query.Content(id);
}
public IPublishedContent Content(Udi id)
{
if (!(id is GuidUdi udi)) return null;
return _query == null
? ItemById(udi.Guid, _contentCache)
: _query.Content(udi.Guid);
}
public IPublishedContent ContentSingleAtXPath(string xpath, params XPathVariable[] vars)
{
return _query == null
? ItemByXPath(xpath, vars, _contentCache)
: _query.ContentSingleAtXPath(xpath, vars);
}
public IEnumerable Content(IEnumerable ids)
{
return _query == null
? ItemsByIds(_contentCache, ids)
: _query.Content(ids);
}
public IEnumerable Content(IEnumerable ids)
{
return _query == null
? ItemsByIds(_contentCache, ids)
: _query.Content(ids);
}
public IEnumerable ContentAtXPath(string xpath, params XPathVariable[] vars)
{
return _query == null
? ItemsByXPath(xpath, vars, _contentCache)
: _query.ContentAtXPath(xpath, vars);
}
public IEnumerable ContentAtXPath(XPathExpression xpath, params XPathVariable[] vars)
{
return _query == null
? ItemsByXPath(xpath, vars, _contentCache)
: _query.ContentAtXPath(xpath, vars);
}
public IEnumerable ContentAtRoot()
{
return _query == null
? ItemsAtRoot(_contentCache)
: _query.ContentAtRoot();
}
#endregion
#region Media
public IPublishedContent Media(int id)
{
return _query == null
? ItemById(id, _mediaCache)
: _query.Media(id);
}
public IPublishedContent Media(Guid id)
{
return _query == null
? ItemById(id, _mediaCache)
: _query.Media(id);
}
public IPublishedContent Media(Udi id)
{
if (!(id is GuidUdi udi)) return null;
return _query == null
? ItemById(udi.Guid, _mediaCache)
: _query.Media(udi.Guid);
}
public IEnumerable Media(IEnumerable ids)
{
return _query == null
? ItemsByIds(_mediaCache, ids)
: _query.Media(ids);
}
public IEnumerable Media(IEnumerable ids)
{
return _query == null
? ItemsByIds(_mediaCache, ids)
: _query.Media(ids);
}
public IEnumerable MediaAtRoot()
{
return _query == null
? ItemsAtRoot(_mediaCache)
: _query.MediaAtRoot();
}
#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, bool useWildCards = true, string indexName = null)
{
return Search(0, 0, out _, term, useWildCards, indexName);
}
///
public IEnumerable Search(int skip, int take, out int totalRecords, string term, bool useWildCards = true, string indexName = null)
{
//fixme: inject IExamineManager
if (_query != null) return _query.Search(skip, take, out totalRecords, term, useWildCards, indexName);
indexName = string.IsNullOrEmpty(indexName)
? Constants.Examine.ExternalIndexer
: indexName;
if (!ExamineManager.Instance.TryGetIndex(indexName, out var index))
throw new InvalidOperationException($"No index found by name {indexName}");
var searcher = index.GetSearcher();
if (skip == 0 && take == 0)
{
var results = searcher.Search(term, useWildCards);
totalRecords = results.TotalItemCount;
return results.ToPublishedSearchResults(_contentCache);
}
var criteria = SearchAllFields(term, useWildCards, searcher, index);
return Search(skip, take, out totalRecords, criteria, searcher);
}
///
public IEnumerable Search(ISearchCriteria criteria, ISearcher searchProvider = null)
{
return Search(0, 0, out _, criteria, searchProvider);
}
///
public IEnumerable Search(int skip, int take, out int totalRecords, ISearchCriteria criteria, ISearcher searcher = null)
{
if (_query != null) return _query.Search(skip, take, out totalRecords, criteria, searcher);
//fixme: inject IExamineManager
if (searcher == null)
{
if (!ExamineManager.Instance.TryGetIndex(Constants.Examine.ExternalIndexer, out var index))
throw new InvalidOperationException($"No index found by name {Constants.Examine.ExternalIndexer}");
searcher = index.GetSearcher();
}
var results = skip == 0 && take == 0
? searcher.Search(criteria)
: searcher.Search(criteria, maxResults: skip + take);
totalRecords = results.TotalItemCount;
return results.ToPublishedSearchResults(_contentCache);
}
///
/// Creates an ISearchCriteria for searching all fields in a .
///
private ISearchCriteria SearchAllFields(string searchText, bool useWildcards, ISearcher searcher, IIndex indexer)
{
var sc = searcher.CreateCriteria();
//if we're dealing with a lucene searcher, we can get all of it's indexed fields,
//else we can get the defined fields for the index.
var searchFields = (searcher is BaseLuceneSearcher luceneSearcher)
? luceneSearcher.GetAllIndexedFields()
: indexer.FieldDefinitionCollection.Keys;
//this is what Examine does internally to create ISearchCriteria for searching all fields
var strArray = searchText.Split(new[] { ' ' }, StringSplitOptions.RemoveEmptyEntries);
sc = useWildcards == false
? sc.GroupedOr(searchFields, strArray).Compile()
: sc.GroupedOr(searchFields, strArray.Select(x => (IExamineValue)new ExamineValue(Examineness.ComplexWildcard, x.MultipleCharacterWildcard().Value)).ToArray()).Compile();
return sc;
}
#endregion
}
}