/// <summary>
/// Applies the query to the given entity using the given <see cref="ODataQuerySettings"/>.
/// </summary>
/// <param name="entity">The original entity.</param>
/// <param name="querySettings">The <see cref="ODataQuerySettings"/> that contains all the query application related settings.</param>
/// <returns>The new entity after the $select and $expand query has been applied to.</returns>
/// <remarks>Only $select and $expand query options can be applied on single entities. This method throws if the query contains any other
/// query options.</remarks>
public virtual object ApplyTo(object entity, ODataQuerySettings querySettings)
{
if (entity == null)
{
throw Error.ArgumentNull("entity");
}
if (querySettings == null)
{
throw Error.ArgumentNull("querySettings");
}
if (Filter != null || OrderBy != null || Top != null || Skip != null || Count != null)
{
throw Error.InvalidOperation(SRResources.NonSelectExpandOnSingleEntity);
}
if (SelectExpand != null)
{
SelectExpandClause processedClause = SelectExpand.ProcessLevels();
SelectExpandQueryOption newSelectExpand = new SelectExpandQueryOption(
SelectExpand.RawSelect,
SelectExpand.RawExpand,
SelectExpand.Context,
processedClause);
Request.ODataProperties().SelectExpandClause = processedClause;
return(newSelectExpand.ApplyTo(entity, querySettings));
}
return(entity);
}
public void Initialize(HttpContext httpContext, ModelStateDictionary modelState)
{
HttpContext = httpContext;
ModelState = modelState;
var logger = httpContext.RequestServices.GetRequiredService <ILogger <OpenApiQueryOptions> >();
SelectExpand.Initialize(httpContext, logger, ModelState);
Filter.Initialize(httpContext, logger, ModelState);
OrderBy.Initialize(httpContext, logger, ModelState);
Skip.Initialize(httpContext, ModelState);
Top.Initialize(httpContext, ModelState);
Count.Initialize(httpContext, ModelState);
}
/// <summary>
/// Apply the individual query to the given IQueryable in the right order.
/// </summary>
/// <param name="query">The original <see cref="IQueryable"/>.</param>
/// <param name="querySettings">The settings to use in query composition.</param>
/// <returns>The new <see cref="IQueryable"/> after the query has been applied to.</returns>
public virtual IQueryable ApplyTo(IQueryable query, ODataQuerySettings querySettings)
{
if (query == null)
{
throw Error.ArgumentNull("query");
}
// Construct the actual query and apply them in the following order: filter
if (Filter != null)
{
query = Filter.ApplyTo(query, querySettings, _assemblyProvider);
}
if (OrderBy != null)
{
query = OrderBy.ApplyTo(query, querySettings);
}
if (Skip.HasValue)
{
query = ExpressionHelpers.Skip(query, Skip.Value, Context.ElementClrType, false);
}
int?take = null;
if (querySettings.PageSize.HasValue)
{
take = Math.Min(querySettings.PageSize.Value, int.MaxValue);
}
if (Top.HasValue)
{
take = Math.Min(Top.Value, take ?? int.MaxValue);
}
if (take.HasValue)
{
query = ExpressionHelpers.Take(query, take.Value, Context.ElementClrType, false);
}
if (SelectExpand != null)
{
query = SelectExpand.ApplyTo(query, querySettings, _assemblyProvider);
}
return(query);
}
private T ApplySelectExpand <T>(T entity, ODataQuerySettings querySettings)
{
var result = default(T);
bool selectAvailable = IsAvailableODataQueryOption(SelectExpand.RawSelect, AllowedQueryOptions.Select);
bool expandAvailable = IsAvailableODataQueryOption(SelectExpand.RawExpand, AllowedQueryOptions.Expand);
if (selectAvailable || expandAvailable)
{
if ((!selectAvailable && SelectExpand.RawSelect != null) ||
(!expandAvailable && SelectExpand.RawExpand != null))
{
SelectExpand = new SelectExpandQueryOption(
selectAvailable ? RawValues.Select : null,
expandAvailable ? RawValues.Expand : null,
SelectExpand.Context);
}
SelectExpandClause processedClause = SelectExpand.ProcessLevels();
SelectExpandQueryOption newSelectExpand = new SelectExpandQueryOption(
SelectExpand.RawSelect,
SelectExpand.RawExpand,
SelectExpand.Context,
processedClause);
InternalRequest.Context.SelectExpandClause = processedClause;
var type = typeof(T);
if (type == typeof(IQueryable))
{
result = (T)newSelectExpand.ApplyTo((IQueryable)entity, querySettings);
}
else if (type == typeof(object))
{
result = (T)newSelectExpand.ApplyTo(entity, querySettings);
}
}
return(result);
}
/// <summary>
/// Applies the query to the given entity using the given <see cref="ODataQuerySettings"/>.
/// </summary>
/// <param name="entity">The original entity.</param>
/// <param name="querySettings">The <see cref="ODataQuerySettings"/> that contains all the query application related settings.</param>
/// <returns>The new entity after the $select and $expand query has been applied to.</returns>
/// <remarks>Only $select and $expand query options can be applied on single entities. This method throws if the query contains any other
/// query options.</remarks>
public virtual object ApplyTo(object entity, ODataQuerySettings querySettings)
{
if (entity == null)
{
throw Error.ArgumentNull("entity");
}
if (querySettings == null)
{
throw Error.ArgumentNull("querySettings");
}
if (Filter != null || OrderBy != null || Top != null || Skip != null || Count != null)
{
throw Error.InvalidOperation(SRResources.NonSelectExpandOnSingleEntity);
}
if (SelectExpand != null)
{
Request.ODataProperties().SelectExpandClause = SelectExpand.SelectExpandClause;
return(SelectExpand.ApplyTo(entity, querySettings));
}
return(entity);
}
/// <summary>
/// Apply the individual query to the given IQueryable in the right order.
/// </summary>
/// <param name="query">The original <see cref="IQueryable"/>.</param>
/// <param name="querySettings">The settings to use in query composition.</param>
/// <returns>The new <see cref="IQueryable"/> after the query has been applied to.</returns>
public virtual IQueryable ApplyTo(IQueryable query, ODataQuerySettings querySettings)
{
if (query == null)
{
throw Error.ArgumentNull("query");
}
if (querySettings == null)
{
throw Error.ArgumentNull("querySettings");
}
IQueryable result = query;
// Construct the actual query and apply them in the following order: filter, orderby, skip, top
if (Filter != null)
{
result = Filter.ApplyTo(result, querySettings, _assembliesResolver);
}
if (Count != null && Request.ODataProperties().TotalCount == null)
{
long?count = Count.GetEntityCount(result);
if (count.HasValue)
{
Request.ODataProperties().TotalCount = count.Value;
}
}
OrderByQueryOption orderBy = OrderBy;
// $skip or $top require a stable sort for predictable results.
// Result limits require a stable sort to be able to generate a next page link.
// If either is present in the query and we have permission,
// generate an $orderby that will produce a stable sort.
if (querySettings.EnsureStableOrdering &&
(Skip != null || Top != null || querySettings.PageSize.HasValue))
{
// If there is no OrderBy present, we manufacture a default.
// If an OrderBy is already present, we add any missing
// properties necessary to make a stable sort.
// Instead of failing early here if we cannot generate the OrderBy,
// let the IQueryable backend fail (if it has to).
orderBy = orderBy == null
? GenerateDefaultOrderBy(Context)
: EnsureStableSortOrderBy(orderBy, Context);
}
if (orderBy != null)
{
result = orderBy.ApplyTo(result, querySettings);
}
if (Skip != null)
{
result = Skip.ApplyTo(result, querySettings);
}
if (Top != null)
{
result = Top.ApplyTo(result, querySettings);
}
if (SelectExpand != null)
{
Request.ODataProperties().SelectExpandClause = SelectExpand.SelectExpandClause;
result = SelectExpand.ApplyTo(result, querySettings);
}
if (querySettings.PageSize.HasValue)
{
bool resultsLimited;
result = LimitResults(result, querySettings.PageSize.Value, out resultsLimited);
if (resultsLimited && Request.RequestUri != null && Request.RequestUri.IsAbsoluteUri && Request.ODataProperties().NextLink == null)
{
Uri nextPageLink = GetNextPageLink(Request, querySettings.PageSize.Value);
Request.ODataProperties().NextLink = nextPageLink;
}
}
return(result);
}
/// <summary>
/// Apply the individual query to the given IQueryable in the right order.
/// </summary>
/// <param name="query">The original <see cref="IQueryable"/>.</param>
/// <param name="querySettings">The settings to use in query composition.</param>
/// <param name="pageSize">The page size for this query</param>
/// <param name="queryOptions"></param>
/// <returns>The new <see cref="IQueryable"/> after the query has been applied to.</returns>
public virtual IQueryable ApplyTo(IQueryable query, ODataQuerySettings querySettings, int?pageSize,
ODataQueryOptions queryOptions)
{
if (query == null)
{
throw Error.ArgumentNull("query");
}
// Construct the actual query and apply them in the following order: filter
if (Filter != null)
{
query = Filter.ApplyTo(query, querySettings, _assemblyProvider);
}
var orderBy = OrderBy;
// $skip or $top require a stable sort for predictable results.
// Result limits require a stable sort to be able to generate a next page link.
// If either is present in the query and we have permission,
// generate an $orderby that will produce a stable sort.
if (querySettings.EnsureStableOrdering &&
((Skip != null && queryOptions.IgnoreSkip == false) ||
(Top != null && queryOptions.IgnoreTop == false) ||
pageSize.HasValue))
{
// If there is no OrderBy present, we manufacture a default.
// If an OrderBy is already present, we add any missing
// properties necessary to make a stable sort.
// Instead of failing early here if we cannot generate the OrderBy,
// let the IQueryable backend fail (if it has to).
orderBy = orderBy == null
? OrderByHelper.GenerateDefaultOrderBy(Context, _serviceProvider)
: OrderByHelper.EnsureStableSortOrderBy(orderBy, Context, _serviceProvider);
}
// First apply $apply
// Section 3.15 of the spec http://docs.oasis-open.org/odata/odata-data-aggregation-ext/v4.0/cs01/odata-data-aggregation-ext-v4.0-cs01.html#_Toc378326311
if (Apply != null)
{
query = Apply.ApplyTo(query, querySettings, _assemblyProvider);
Request.ODataFeature().ApplyClause = Apply.ApplyClause;
Context.ElementClrType = Apply.ResultClrType;
}
if (orderBy != null && Apply == null)
{
query = orderBy.ApplyTo(query, querySettings);
}
if (Skip.HasValue && queryOptions.IgnoreSkip == false)
{
query = ExpressionHelpers.Skip(query, Skip.Value, Context.ElementClrType, false);
}
int?take = null;
if (querySettings.PageSize.HasValue)
{
take = Math.Min(querySettings.PageSize.Value, int.MaxValue);
}
if (Top.HasValue && queryOptions.IgnoreTop == false)
{
take = Math.Min(Top.Value, take ?? int.MaxValue);
}
if (take.HasValue)
{
query = ExpressionHelpers.Take(query, take.Value, Context.ElementClrType, false);
}
if (SelectExpand != null)
{
query = SelectExpand.ApplyTo(query, querySettings, _assemblyProvider);
}
if (CountQueryOption != null)
{
if (Request.ODataFeature().TotalCountFunc == null)
{
Func <long> countFunc = CountQueryOption.GetEntityCountFunc(query);
if (countFunc != null)
{
Request.ODataFeature().TotalCountFunc = countFunc;
}
}
if (ODataCountMediaTypeMapping.IsCountRequest(Request.HttpContext))
{
return(query);
}
}
if (pageSize.HasValue && Apply == null)
{
bool resultsLimited;
query = LimitResults(query, pageSize.Value, out resultsLimited);
if (resultsLimited && Request.GetDisplayUrl() != null && new Uri(Request.GetDisplayUrl()).IsAbsoluteUri&& Request.ODataFeature().NextLink == null)
{
Uri nextPageLink = Request.GetNextPageLink(pageSize.Value);
Request.ODataFeature().NextLink = nextPageLink;
}
}
return(query);
}
