259 lines
9.0 KiB
C#
259 lines
9.0 KiB
C#
|
/*
|
||
|
|
*
|
||
|
|
* (c) Copyright Ascensio System Limited 2010-2018
|
||
|
|
*
|
||
|
|
* This program is freeware. You can redistribute it and/or modify it under the terms of the GNU
|
||
|
|
* General Public License (GPL) version 3 as published by the Free Software Foundation (https://www.gnu.org/copyleft/gpl.html).
|
||
|
|
* In accordance with Section 7(a) of the GNU GPL its Section 15 shall be amended to the effect that
|
||
|
|
* Ascensio System SIA expressly excludes the warranty of non-infringement of any third-party rights.
|
||
|
|
*
|
||
|
|
* THIS PROGRAM IS DISTRIBUTED WITHOUT ANY WARRANTY; WITHOUT EVEN THE IMPLIED WARRANTY OF MERCHANTABILITY OR
|
||
|
|
* FITNESS FOR A PARTICULAR PURPOSE. For more details, see GNU GPL at https://www.gnu.org/copyleft/gpl.html
|
||
|
|
*
|
||
|
|
* You can contact Ascensio System SIA by email at sales@onlyoffice.com
|
||
|
|
*
|
||
|
|
* The interactive user interfaces in modified source and object code versions of ONLYOFFICE must display
|
||
|
|
* Appropriate Legal Notices, as required under Section 5 of the GNU GPL version 3.
|
||
|
|
*
|
||
|
|
* Pursuant to Section 7 § 3(b) of the GNU GPL you must retain the original ONLYOFFICE logo which contains
|
||
|
|
* relevant author attributions when distributing the software. If the display of the logo in its graphic
|
||
|
|
* form is not reasonably feasible for technical reasons, you must include the words "Powered by ONLYOFFICE"
|
||
|
|
* in every copy of the program you distribute.
|
||
|
|
* Pursuant to Section 7 § 3(e) we decline to grant you any rights under trademark law for use of our trademarks.
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
|
||
|
|
using System;
|
||
|
|
using System.Collections.Generic;
|
||
|
|
using System.Linq;
|
||
|
|
using Microsoft.AspNetCore.Http;
|
||
|
|
|
||
|
|
namespace ASC.Api.Core
|
||
|
|
{
|
||
|
|
public class ApiContext : ICloneable
|
||
|
|
{
|
||
|
|
public HttpContext HttpContext { get; set; }
|
||
|
|
|
||
|
|
public ApiContext(HttpContext httpContext)
|
||
|
|
{
|
||
|
|
if (httpContext == null) return;
|
||
|
|
HttpContext = httpContext;
|
||
|
|
|
||
|
|
//TODO
|
||
|
|
uint ItemsPerPage = 25;
|
||
|
|
Count = 0;
|
||
|
|
//Try parse values
|
||
|
|
string count = GetRequestValue("count");
|
||
|
|
ulong countParsed;
|
||
|
|
if (!string.IsNullOrEmpty(count) && ulong.TryParse(count,out countParsed))
|
||
|
|
{
|
||
|
|
//Count specified and valid
|
||
|
|
SpecifiedCount = (long)Math.Max(0, Math.Min(ItemsPerPage, countParsed));
|
||
|
|
}
|
||
|
|
else
|
||
|
|
{
|
||
|
|
SpecifiedCount = Math.Max(0,ItemsPerPage);
|
||
|
|
}
|
||
|
|
Count = SpecifiedCount + 1;//NOTE: +1 added to see if it's last page
|
||
|
|
|
||
|
|
|
||
|
|
var startIndex = GetRequestValue("startIndex");
|
||
|
|
if (startIndex != null && long.TryParse(startIndex, out var startIndexParsed))
|
||
|
|
{
|
||
|
|
StartIndex = Math.Max(0, startIndexParsed);
|
||
|
|
SpecifiedStartIndex = StartIndex;
|
||
|
|
}
|
||
|
|
|
||
|
|
var sortOrder = GetRequestValue("sortOrder");
|
||
|
|
if ("descending".Equals(sortOrder))
|
||
|
|
{
|
||
|
|
SortDescending = true;
|
||
|
|
}
|
||
|
|
|
||
|
|
FilterToType = GetRequestValue("type");
|
||
|
|
SortBy = GetRequestValue("sortBy");
|
||
|
|
FilterBy = GetRequestValue("filterBy");
|
||
|
|
FilterOp = GetRequestValue("filterOp");
|
||
|
|
FilterValue = GetRequestValue("filterValue");
|
||
|
|
FilterValues = GetRequestArray("filterValue");
|
||
|
|
Fields = GetRequestArray("fields");
|
||
|
|
|
||
|
|
var updatedSince = GetRequestValue("updatedSince");
|
||
|
|
if (updatedSince != null)
|
||
|
|
{
|
||
|
|
UpdatedSince = Convert.ToDateTime(updatedSince);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
public string[] Fields { get; set; }
|
||
|
|
|
||
|
|
private string[] GetRequestArray(string key)
|
||
|
|
{
|
||
|
|
if (HttpContext.Request.QueryString != null)
|
||
|
|
{
|
||
|
|
var values = HttpContext.Request.Query[key + "[]"];
|
||
|
|
if (values.Any())
|
||
|
|
return values;
|
||
|
|
|
||
|
|
values = HttpContext.Request.Query[key];
|
||
|
|
if (values.Any())
|
||
|
|
{
|
||
|
|
if (values.Count == 1) //If it's only one element
|
||
|
|
{
|
||
|
|
//Try split
|
||
|
|
if (!string.IsNullOrEmpty(values[0]))
|
||
|
|
return values[0].Split(',');
|
||
|
|
}
|
||
|
|
return values;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
public string GetRequestValue(string key)
|
||
|
|
{
|
||
|
|
var reqArray = GetRequestArray(key);
|
||
|
|
return reqArray?.FirstOrDefault();
|
||
|
|
}
|
||
|
|
|
||
|
|
public string[] FilterValues { get; set; }
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Filters responce to specific type from request parameter "type"
|
||
|
|
/// </summary>
|
||
|
|
/// <remarks>
|
||
|
|
/// The type name is retrieved from [DataContractAttribute] name
|
||
|
|
/// </remarks>
|
||
|
|
public string FilterToType { get; set; }
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Gets count to get item from collection. Request parameter "count"
|
||
|
|
/// </summary>
|
||
|
|
/// <remarks>
|
||
|
|
/// Don't forget to call _context.SetDataPaginated() to prevent SmartList from filtering response if you fetch data from DB with TOP & COUNT
|
||
|
|
/// </remarks>
|
||
|
|
public long Count { get; set; }
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Gets start index to get item from collection. Request parameter "startIndex"
|
||
|
|
/// </summary>
|
||
|
|
/// <remarks>
|
||
|
|
/// Don't forget to call _context.SetDataPaginated() to prevent SmartList from filtering response if you fetch data from DB with TOP & COUNT
|
||
|
|
/// </remarks>
|
||
|
|
public long StartIndex { get; set; }
|
||
|
|
|
||
|
|
internal long SpecifiedStartIndex { get; set; }
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Gets field to sort by from request parameter "sortBy"
|
||
|
|
/// </summary>
|
||
|
|
public string SortBy { get; set; }
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Gets field to filter from request parameter "filterBy"
|
||
|
|
/// </summary>
|
||
|
|
public string FilterBy { get; set; }
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Gets filter operation from request parameter "filterOp"
|
||
|
|
/// can be one of the following:"contains","equals","startsWith","present"
|
||
|
|
/// </summary>
|
||
|
|
public string FilterOp { get; set; }
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Gets value to filter from request parameter "filterValue"
|
||
|
|
/// </summary>
|
||
|
|
public string FilterValue { get; set; }
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Sort direction. From request parameter "sortOrder" can be "descending" or "ascending"
|
||
|
|
/// Like ...&sortOrder=descending&...
|
||
|
|
/// </summary>
|
||
|
|
public bool SortDescending { get; set; }
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Gets value to filter from request parameter "updatedSince"
|
||
|
|
/// </summary>
|
||
|
|
public DateTime UpdatedSince { get; set; }
|
||
|
|
|
||
|
|
public bool FromCache { get; set; }
|
||
|
|
|
||
|
|
private readonly List<Type> _knowntype = new List<Type>();
|
||
|
|
|
||
|
|
internal long SpecifiedCount { get; private set; }
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Set mark that data is already paginated and additional filtering is not needed
|
||
|
|
/// </summary>
|
||
|
|
public ApiContext SetDataPaginated()
|
||
|
|
{
|
||
|
|
//Count = 0;//We always ask for +1 count so smart list should cut it
|
||
|
|
StartIndex = 0;
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
|
||
|
|
public ApiContext SetDataSorted()
|
||
|
|
{
|
||
|
|
SortBy = string.Empty;
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
|
||
|
|
public ApiContext SetDataFiltered()
|
||
|
|
{
|
||
|
|
FilterBy = string.Empty;
|
||
|
|
FilterOp = string.Empty;
|
||
|
|
FilterValue = string.Empty;
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
|
||
|
|
public ApiContext SetTotalCount(long totalCollectionCount)
|
||
|
|
{
|
||
|
|
TotalCount = totalCollectionCount;
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
|
||
|
|
public long? TotalCount { get; set; }
|
||
|
|
|
||
|
|
|
||
|
|
public void RegisterType(Type type)
|
||
|
|
{
|
||
|
|
if (!_knowntype.Contains(type))
|
||
|
|
{
|
||
|
|
_knowntype.Add(type);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
public void RegisterTypes(IEnumerable<Type> types)
|
||
|
|
{
|
||
|
|
_knowntype.AddRange(types);
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
internal IEnumerable<Type> GetKnownTypes()
|
||
|
|
{
|
||
|
|
return _knowntype.Distinct();
|
||
|
|
}
|
||
|
|
|
||
|
|
public object Clone()
|
||
|
|
{
|
||
|
|
return MemberwiseClone();
|
||
|
|
}
|
||
|
|
|
||
|
|
public override string ToString()
|
||
|
|
{
|
||
|
|
return string.Format("C:{0},S:{1},So:{2},Sd:{3},Fb;{4},Fo:{5},Fv:{6},Us:{7},Ftt:{8}", Count, StartIndex,
|
||
|
|
SortBy, SortDescending, FilterBy, FilterOp, FilterValue, UpdatedSince.Ticks, FilterToType);
|
||
|
|
}
|
||
|
|
|
||
|
|
public bool Check(string field)
|
||
|
|
{
|
||
|
|
return Fields == null || (Fields != null && Fields.Contains(field));
|
||
|
|
}
|
||
|
|
|
||
|
|
public static implicit operator ApiContext(HttpContext httpContext)
|
||
|
|
{
|
||
|
|
return new ApiContext(httpContext);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|