This commit is contained in:
2026-05-28 11:39:47 +03:30
parent db8b50d02d
commit ecd94c7b03
3 changed files with 1140 additions and 0 deletions
@@ -0,0 +1,805 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;
using Microsoft.EntityFrameworkCore.Query;
using Microsoft.Extensions.Logging;
using xCommons.Configurations;
using xCommons.Extensions;
using xCommons.Providers;
using xExceptions.Constants;
using xIdentityService.Controllers;
using xIdentityService.Interfaces;
using xModels.Base;
using xModels.Dtos;
using xPushService.Base;
using xPushService.Interfaces;
using xTagService.Interfaces;
namespace xTagService.Controllers
{
[AllowAnonymous]
public abstract class XBaseProvidedHasTagControllerBase<TEntity, TDto, TKey, THub> : XBaseIdentityApiV1Controller, IXBaseProvidedHasTagController<TEntity, TDto, TKey, THub>
where TEntity : XBaseEntity<TKey>
where TDto : XBaseEntityDto<TKey>
where THub : XBaseDtoHub<TEntity, TDto, TKey>
{
private readonly IXBaseProvided<TEntity, TDto, TKey, THub> provider;
private readonly IXTagProvided<TEntity, TDto, TKey, THub> tagProvided;
private readonly Func<IQueryable<TEntity>, IOrderedQueryable<TEntity>> defaultOrderBuilder;
private readonly Func<IQueryable<TEntity>, IIncludableQueryable<TEntity, object>> defaultIncludeBuilder;
protected XBaseProvidedHasTagControllerBase(
ILogger<XBaseProvidedHasTagControllerBase<TEntity, TDto, TKey, THub>> logger,
XAppConfiguration appConfiguration,
IXIdentityProvider identityProvider,
XValidationProvider validationProvider,
IXBaseProvided<TEntity, TDto, TKey, THub> provider,
IXTagProvided<TEntity, TDto, TKey, THub> tagProvided,
Func<IQueryable<TEntity>, IOrderedQueryable<TEntity>> defaultOrderBuilder = null,
Func<IQueryable<TEntity>, IIncludableQueryable<TEntity, object>> defaultIncludeBuilder = null
) : base(
logger,
appConfiguration,
identityProvider,
validationProvider
)
{
this.provider = provider;
this.tagProvided = tagProvided;
this.defaultOrderBuilder = defaultOrderBuilder;
this.defaultIncludeBuilder = defaultIncludeBuilder;
}
//
#region Provided ...
//
#region Retrieve ...
/// <summary>
/// Get Specified Item by ID ...
/// </summary>
/// <param name="id"></param>
/// <param name="useDefaultIncludes"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[HttpGet("{id}")]
public virtual async Task<ActionResult<TDto>> Get(
[FromRoute] TKey id,
[FromQuery] bool useDefaultIncludes = false,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate ...
if (!ModelState.IsValid)
{
XException.InvalidArgs.Throw();
}
ValidationProvider.NotNull(id);
//
var result = await provider.Get(
id: id,
includeBuilder: !useDefaultIncludes
? null
: defaultIncludeBuilder,
cancellationToken: cancellationToken
);
//
return Ok(result.ToDynamicObject());
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
/// <summary>
/// Get All Exists Items ...
/// </summary>
/// <param name="useDefaultOrders"></param>
/// <param name="useDefaultIncludes"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[HttpGet("")]
public virtual async Task<ActionResult<IEnumerable<TDto>>> GetAll(
[FromQuery] bool useDefaultOrders = false,
[FromQuery] bool useDefaultIncludes = false,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate ...
if (!ModelState.IsValid)
{
XException.InvalidArgs.Throw();
}
//
var result = await provider.GetAll(
orderBuilder: !useDefaultOrders
? null
: defaultOrderBuilder,
includeBuilder: !useDefaultIncludes
? null
: defaultIncludeBuilder,
cancellationToken: cancellationToken
);
//
return Ok(result.ToDynamicObject());
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
/// <summary>
/// Find an item by providing a Conditional Expression ...
/// </summary>
/// <param name="query"></param>
/// <param name="useDefaultIncludes"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[HttpGet("Find/One")]
public virtual async Task<ActionResult<TDto>> FindOne(
[FromRoute] string query,
[FromQuery] bool useDefaultIncludes = false,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate ...
if (!ModelState.IsValid)
{
XException.InvalidArgs.Throw();
}
await ValidationProvider
.GroupValidationBuilder()
.AddNotEmpty(query)
.ValidateGroupAsync();
//
var result = await provider.FindOne(
includeBuilder: !useDefaultIncludes
? null
: defaultIncludeBuilder,
cancellationToken: cancellationToken,
predicate: x => x.PropValuesContains(query)
);
//
return Ok(result.ToDynamicObject());
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
/// <summary>
/// Find a collection of Items by proving a Query Search ...
/// </summary>
/// <param name="query"></param>
/// <param name="useDefaultOrders"></param>
/// <param name="useDefaultIncludes"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[HttpGet("Find/Many")]
public virtual async Task<ActionResult<IEnumerable<TDto>>> FindMany(
[FromRoute] string query,
[FromQuery] bool useDefaultOrders = false,
[FromQuery] bool useDefaultIncludes = false,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate ...
if (!ModelState.IsValid)
{
XException.InvalidArgs.Throw();
}
await ValidationProvider
.GroupValidationBuilder()
.AddNotEmpty(query)
.ValidateGroupAsync();
//
var result = await provider.FindMany(
orderBuilder: !useDefaultOrders
? null
: defaultOrderBuilder,
includeBuilder: !useDefaultIncludes
? null
: defaultIncludeBuilder,
cancellationToken: cancellationToken,
predicate: x => x.PropValuesContains(query)
);
//
return Ok(result.ToDynamicObject());
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
/// <summary>
/// Retrieve Items based on XQuery Pagination structure ...
/// </summary>
/// <param name="query"></param>
/// <param name="useDefaultOrders"></param>
/// <param name="useDefaultIncludes"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[HttpGet("Query")]
public virtual async Task<ActionResult<XQueryResult<TDto>>> Query(
[FromQuery] XQuery query,
[FromQuery] bool useDefaultOrders = false,
[FromQuery] bool useDefaultIncludes = false,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate ...
if (!ModelState.IsValid)
{
XException.InvalidArgs.Throw();
}
await ValidationProvider
.GroupValidationBuilder()
.AddNotNull(query)
.ValidateGroupAsync();
//
var result = await provider.Query(
query: query,
predicate: null,
orderBuilder: !useDefaultOrders
? null
: defaultOrderBuilder,
includeBuilder: !useDefaultIncludes
? null
: defaultIncludeBuilder,
cancellationToken: cancellationToken
);
//
return Ok(result.ToDynamicObject());
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
/// <summary>
/// Retrieve Owned Items based on XQuery Pagination structure ...
/// </summary>
/// <param name="query"></param>
/// <param name="useDefaultOrders"></param>
/// <param name="useDefaultIncludes"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[HttpGet("Query/Owned")]
public virtual async Task<ActionResult<XQueryResult<TDto>>> QueryOwned(
[FromQuery] XQuery query,
[FromQuery] bool useDefaultOrders = false,
[FromQuery] bool useDefaultIncludes = false,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate ...
if (!ModelState.IsValid)
{
XException.InvalidArgs.Throw();
}
await ValidationProvider
.GroupValidationBuilder()
.AddNotNull(query)
.ValidateGroupAsync();
//
var userInfo = await GetUserInfo();
//
var result = await provider.QueryOwned(
query: query,
predicate: null,
userInfo: userInfo,
orderBuilder: !useDefaultOrders
? null
: defaultOrderBuilder,
includeBuilder: !useDefaultIncludes
? null
: defaultIncludeBuilder,
cancellationToken: cancellationToken
);
//
return Ok(result.ToDynamicObject());
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
#endregion
//
#region Add/Update/Remove ...
/// <summary>
/// Add an item ...
/// </summary>
/// <param name="item"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[HttpPost("")]
public virtual async Task<ActionResult<TDto>> Add(
[FromBody] TDto item,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate ...
if (!ModelState.IsValid)
{
XException.InvalidArgs.Throw();
}
await ValidationProvider
.GroupValidationBuilder()
.AddNotNull(item)
.ValidateGroupAsync();
//
var userInfo = await GetUserInfo();
var connectionId = GetConnectionId();
//
var result = await provider.Add(
item: item,
userInfo: userInfo,
connectionId: connectionId,
cancellationToken: cancellationToken
);
//
return Ok(result.ToDynamicObject());
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
/// <summary>
/// Update an item values ...
/// </summary>
/// <param name="id"></param>
/// <param name="item"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[HttpPut("{id}")]
public virtual async Task<ActionResult<TDto>> Update(
[FromRoute] TKey id,
[FromBody] TDto item,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate ...
if (!ModelState.IsValid)
{
XException.InvalidArgs.Throw();
}
await ValidationProvider
.GroupValidationBuilder()
.AddNotNull(id)
.AddNotNull(item)
.ValidateGroupAsync();
//
var userInfo = await GetUserInfo();
var connectionId = GetConnectionId();
//
var result = await provider.Update(
id: id,
item: item,
userInfo: userInfo,
connectionId: connectionId,
cancellationToken: cancellationToken
);
//
return Ok(result.ToDynamicObject());
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
/// <summary>
/// Remove an Item ...
/// </summary>
/// <param name="id"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[HttpDelete("{id}")]
public virtual async Task<ActionResult<TDto>> Remove(
[FromRoute] TKey id,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate ...
if (!ModelState.IsValid)
{
XException.InvalidArgs.Throw();
}
await ValidationProvider
.GroupValidationBuilder()
.AddNotNull(id)
.ValidateGroupAsync();
//
var userInfo = await GetUserInfo();
var connectionId = GetConnectionId();
//
var result = await provider.Remove(
id: id,
userInfo: userInfo,
connectionId: connectionId,
cancellationToken: cancellationToken
);
//
return Ok(result.ToDynamicObject());
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
#endregion
#endregion
//
#region Tag ...
/// <summary>
/// Attach Tag to Specified Item ...
/// </summary>
/// <param name="id"></param>
/// <param name="tag"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[HttpPost("{id}/tags/attach")]
public virtual async Task<ActionResult> AttachTag(
[FromRoute] TKey id,
[FromBody] XBaseValueContainer<string> tag,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate Args ...
if (!ModelState.IsValid)
{
XException.InvalidArgs.Throw();
}
await ValidationProvider
.GroupValidationBuilder()
.AddNotNull(id)
.AddNotNull(tag)
.AddNotEmpty(tag.Value)
.ValidateGroupAsync();
//
var userInfo = await GetUserInfo();
var connectionId = GetConnectionId();
//
// Get Result ...
await tagProvided
.AttachTag(
id: id,
tag: tag.Value,
userInfo: userInfo,
connectionId: connectionId,
cancellationToken: cancellationToken
);
//
return Ok();
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
/// <summary>
/// Detach Tag of Specified Item ...
/// </summary>
/// <param name="id"></param>
/// <param name="tag"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[HttpPost("{id}/tags/detach")]
public virtual async Task<ActionResult> DetachTag(
[FromRoute] TKey id,
[FromBody] XBaseValueContainer<string> tag,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate Args ...
if (!ModelState.IsValid)
{
XException.InvalidArgs.Throw();
}
await ValidationProvider
.GroupValidationBuilder()
.AddNotNull(id)
.AddNotNull(tag)
.AddNotEmpty(tag.Value)
.ValidateGroupAsync();
//
var userInfo = await GetUserInfo();
var connectionId = GetConnectionId();
//
// Get Result ...
await tagProvided
.DetachTag(
id: id,
tag: tag.Value,
userInfo: userInfo,
connectionId: connectionId,
cancellationToken: cancellationToken
);
//
return Ok();
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
/// <summary>
/// Attach Tags to Specified Item ...
/// </summary>
/// <param name="id"></param>
/// <param name="tags"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[HttpPost("{id}/tags/attachs")]
public virtual async Task<ActionResult> AttachTags(
[FromRoute] TKey id,
[FromBody] XBaseRangeRequest<string> tags,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate Args ...
if (!ModelState.IsValid)
{
XException.InvalidArgs.Throw();
}
await ValidationProvider
.GroupValidationBuilder()
.AddNotNull(id)
.AddNotNull(tags)
.AddNotZeroChilds(tags.Items)
.ValidateGroupAsync();
//
var userInfo = await GetUserInfo();
var connectionId = GetConnectionId();
//
// Get Result ...
await tagProvided
.AttachTags(
id: id,
tags: tags.Items,
userInfo: userInfo,
connectionId: connectionId,
cancellationToken: cancellationToken
);
//
return Ok();
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
/// <summary>
/// Detach Tags of Specified Item ...
/// </summary>
/// <param name="id"></param>
/// <param name="tags"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[HttpPost("{id}/tags/detachs")]
public virtual async Task<ActionResult> DetachTags(
[FromRoute] TKey id,
[FromBody] XBaseRangeRequest<string> tags = null,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate Args ...
if (!ModelState.IsValid)
{
XException.InvalidArgs.Throw();
}
await ValidationProvider
.GroupValidationBuilder()
.AddNotNull(id)
.ValidateGroupAsync();
//
var userInfo = await GetUserInfo();
var connectionId = GetConnectionId();
//
// Get Result ...
if (!tags.IsNull())
{
//
await tagProvided
.DetachTags(
id: id,
tags: tags.Items,
userInfo: userInfo,
connectionId: connectionId,
cancellationToken: cancellationToken
);
}
else
{
//
await tagProvided
.DetachTags(
id: id,
userInfo: userInfo,
connectionId: connectionId,
cancellationToken: cancellationToken
);
}
//
return Ok();
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
/// <summary>
/// Get Specified Item Tags ...
/// </summary>
/// <param name="id"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[HttpGet("{id}/tags")]
public virtual async Task<ActionResult<IEnumerable<string>>> GetTags(
[FromRoute] TKey id,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate Args ...
if (!ModelState.IsValid)
{
XException.InvalidArgs.Throw();
}
await ValidationProvider
.GroupValidationBuilder()
.AddNotNull(id)
.ValidateGroupAsync();
//
// Get Result ...
var result = await tagProvided.GetTags(
id: id,
cancellationToken: cancellationToken
);
//
return Ok(result.ToDynamicObject());
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
#endregion
}
}
+323
View File
@@ -0,0 +1,323 @@
using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using xCommons.Configurations;
using xCommons.Extensions;
using xCommons.Providers;
using xExceptions.Constants;
using xIdentityService.Controllers;
using xIdentityService.Interfaces;
using xModels.Base;
using xPushService.Base;
using xTagService.Interfaces;
namespace xTagService.Controllers
{
public abstract class XTagProvidedControllerBase<TEntity, TDto, TKey, THub> : XBaseIdentityApiV1Controller, IXTagProvidedController<TEntity, TDto, TKey, THub>
where TEntity : XBaseEntity<TKey>
where TDto : XBaseEntityDto<TKey>
where THub : XBaseDtoHub<TEntity, TDto, TKey>
{
private readonly IXTagProvided<TEntity, TDto, TKey, THub> tagProvided;
protected XTagProvidedControllerBase(
ILogger<XTagProvidedControllerBase<TEntity, TDto, TKey, THub>> logger,
XAppConfiguration appConfiguration,
XValidationProvider validationProvider,
IXIdentityProvider identityProvider,
IXTagProvided<TEntity, TDto, TKey, THub> tagProvided
) : base(
logger,
appConfiguration,
identityProvider,
validationProvider
)
{
this.tagProvided = tagProvided;
}
/// <summary>
/// Attach Tag to Specified Item ...
/// </summary>
/// <param name="id"></param>
/// <param name="tag"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[HttpPost("{id}/tags/attach")]
public virtual async Task<ActionResult> AttachTag(
[FromRoute] TKey id,
[FromBody] XBaseValueContainer<string> tag,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate Args ...
if (!ModelState.IsValid)
{
XException.InvalidArgs.Throw();
}
await ValidationProvider
.GroupValidationBuilder()
.AddNotNull(id)
.AddNotNull(tag)
.AddNotEmpty(tag.Value)
.ValidateGroupAsync();
//
var userInfo = await GetUserInfo();
var connectionId = GetConnectionId();
//
// Get Result ...
await tagProvided
.AttachTag(
id: id,
tag: tag.Value,
userInfo: userInfo,
connectionId: connectionId,
cancellationToken: cancellationToken
);
//
return Ok();
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
/// <summary>
/// Detach Tag of Specified Item ...
/// </summary>
/// <param name="id"></param>
/// <param name="tag"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[HttpPost("{id}/tags/detach")]
public virtual async Task<ActionResult> DetachTag(
[FromRoute] TKey id,
[FromBody] XBaseValueContainer<string> tag,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate Args ...
if (!ModelState.IsValid)
{
XException.InvalidArgs.Throw();
}
await ValidationProvider
.GroupValidationBuilder()
.AddNotNull(id)
.AddNotNull(tag)
.AddNotEmpty(tag.Value)
.ValidateGroupAsync();
//
var userInfo = await GetUserInfo();
var connectionId = GetConnectionId();
//
// Get Result ...
await tagProvided
.DetachTag(
id: id,
tag: tag.Value,
userInfo: userInfo,
connectionId: connectionId,
cancellationToken: cancellationToken
);
//
return Ok();
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
/// <summary>
/// Attach Tags to Specified Item ...
/// </summary>
/// <param name="id"></param>
/// <param name="tags"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[HttpPost("{id}/tags/attachs")]
public virtual async Task<ActionResult> AttachTags(
[FromRoute] TKey id,
[FromBody] XBaseRangeRequest<string> tags,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate Args ...
if (!ModelState.IsValid)
{
XException.InvalidArgs.Throw();
}
await ValidationProvider
.GroupValidationBuilder()
.AddNotNull(id)
.AddNotNull(tags)
.AddNotZeroChilds(tags.Items)
.ValidateGroupAsync();
//
var userInfo = await GetUserInfo();
var connectionId = GetConnectionId();
//
// Get Result ...
await tagProvided
.AttachTags(
id: id,
tags: tags.Items,
userInfo: userInfo,
connectionId: connectionId,
cancellationToken: cancellationToken
);
//
return Ok();
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
/// <summary>
/// Detach Tags of Specified Item ...
/// </summary>
/// <param name="id"></param>
/// <param name="tags"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[HttpPost("{id}/tags/detachs")]
public virtual async Task<ActionResult> DetachTags(
[FromRoute] TKey id,
[FromBody] XBaseRangeRequest<string> tags = null,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate Args ...
if (!ModelState.IsValid)
{
XException.InvalidArgs.Throw();
}
await ValidationProvider
.GroupValidationBuilder()
.AddNotNull(id)
.ValidateGroupAsync();
//
var userInfo = await GetUserInfo();
var connectionId = GetConnectionId();
//
// Get Result ...
if (!tags.IsNull())
{
//
await tagProvided
.DetachTags(
id: id,
tags: tags.Items,
userInfo: userInfo,
connectionId: connectionId,
cancellationToken: cancellationToken
);
}
else
{
//
await tagProvided
.DetachTags(
id: id,
userInfo: userInfo,
connectionId: connectionId,
cancellationToken: cancellationToken
);
}
//
return Ok();
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
/// <summary>
/// Get Specified Item Tags ...
/// </summary>
/// <param name="id"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[HttpGet("{id}/tags")]
public virtual async Task<ActionResult<IEnumerable<string>>> GetTags(
[FromRoute] TKey id,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate Args ...
if (!ModelState.IsValid)
{
XException.InvalidArgs.Throw();
}
await ValidationProvider
.GroupValidationBuilder()
.AddNotNull(id)
.ValidateGroupAsync();
//
// Get Result ...
var result = await tagProvided.GetTags(
id: id,
cancellationToken: cancellationToken
);
//
return Ok(result.ToDynamicObject());
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
}
}