From 1400fcdeb41e9c1222af11f132268d8b6074447b Mon Sep 17 00:00:00 2001 From: Tsanie Lily Date: Wed, 24 May 2023 22:01:37 +0800 Subject: [PATCH] add flower controller --- Server/Controller/BaseController.cs | 51 ++- Server/Controller/EventController.cs | 96 ++++++ Server/Controller/FlowerController.cs | 314 ++++++++++++++++++ Server/Controller/FlowerController.structs.cs | 49 +++ Server/Controller/SwaggerController.cs | 139 ++++++++ Server/Controller/UserController.cs | 134 ++++++-- Server/Controller/UserController.structs.cs | 63 +++- Server/Data/Model/FlowerItem.cs | 7 + Server/Data/Model/RecordItem.cs | 7 + .../20230524062207_AddOwner.Designer.cs | 202 +++++++++++ Server/Migrations/20230524062207_AddOwner.cs | 40 +++ .../Migrations/FlowerDatabaseModelSnapshot.cs | 17 +- Server/Program.cs | 45 ++- Server/Server.csproj | 4 + 14 files changed, 1099 insertions(+), 69 deletions(-) create mode 100644 Server/Controller/EventController.cs create mode 100644 Server/Controller/FlowerController.cs create mode 100644 Server/Controller/FlowerController.structs.cs create mode 100644 Server/Controller/SwaggerController.cs create mode 100644 Server/Migrations/20230524062207_AddOwner.Designer.cs create mode 100644 Server/Migrations/20230524062207_AddOwner.cs diff --git a/Server/Controller/BaseController.cs b/Server/Controller/BaseController.cs index abebc0b..3825fe6 100644 --- a/Server/Controller/BaseController.cs +++ b/Server/Controller/BaseController.cs @@ -1,7 +1,6 @@ using Blahblah.FlowerStory.Server.Data; using Blahblah.FlowerStory.Server.Data.Model; using Microsoft.AspNetCore.Mvc; -using Microsoft.EntityFrameworkCore; using System.Security.Cryptography; using System.Text; @@ -17,7 +16,7 @@ public abstract class BaseController : ControllerBase /// /// 自定义认证头的关键字 /// - protected const string AuthHeader = "X-Auth"; + protected const string AuthHeader = "Authorization"; /// /// 禁用用户 /// @@ -74,16 +73,15 @@ public abstract class BaseController : ControllerBase } /// - /// 检查当前会话权限 + /// 检出当前会话 /// - /// 需要大于等于该权限，默认为 0 - UserCommon - /// 若检查失败，第一个参数返回异常 ActionResult。第二个参数返回会话对应的用户对象 - protected (ActionResult? Result, UserItem? User) CheckPermission(int? level = 0) + /// 若检查失败，第一个参数返回异常 ActionResult。第二个参数返回会话令牌对象 + protected (ActionResult? Result, TokenItem? Token) CheckToken() { if (!Request.Headers.TryGetValue(AuthHeader, out var h)) { logger?.LogWarning("request with no {auth} header", AuthHeader); - return (BadRequest(), null); + return (Unauthorized(), null); } string hash = h.ToString(); var token = database.Tokens.Find(hash); @@ -92,25 +90,54 @@ public abstract class BaseController : ControllerBase logger?.LogWarning("token \"{hash}\" not found", hash); return (Unauthorized(), null); } + return (null, token); + } + + /// + /// 检查当前会话权限 + /// + /// 需要大于等于该权限，默认为 0 - UserCommon + /// 若检查失败，第一个参数返回异常 ActionResult。第二个参数返回会话对应的用户对象 + protected (ActionResult? Result, UserItem? User) CheckPermission(int? level = 0) + { + var (result, token) = CheckToken(); + if (result != null) + { + return (result, null); + } + if (token == null) + { + return (Unauthorized(), null); + } if (token.ExpireDate < DateTimeOffset.UtcNow) { - logger?.LogWarning("token \"{hash}\" has expired after {date}", hash, token.ExpireDate); + logger?.LogWarning("token \"{hash}\" has expired after {date}", token.Id, token.ExpireDate); return (Unauthorized(), null); } var user = database.Users.Find(token.UserId); if (user == null) { logger?.LogWarning("user not found with id {id}", token.UserId); - return (NotFound(), null); } - if (user.Level < level) + else if (user.Level < level) { logger?.LogWarning("user \"{id}\" level ({level}) lower than required ({required})", user.UserId, user.Level, level); return (Forbid(), user); } + else + { + var now = DateTimeOffset.UtcNow; + token.ActiveDateUnixTime = now.ToUnixTimeMilliseconds(); + var expires = now.AddSeconds(token.ExpireSeconds).ToUnixTimeMilliseconds(); + if (expires > token.ExpireDateUnixTime) + { + token.ExpireDateUnixTime = expires; + } + database.Tokens.Update(token); - token.ActiveDateUnixTime = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds(); - database.Tokens.Update(token); + user.ActiveDateUnixTime = now.ToUnixTimeMilliseconds(); + database.Users.Update(user); + } return (null, user); } diff --git a/Server/Controller/EventController.cs b/Server/Controller/EventController.cs new file mode 100644 index 0000000..e80ddb5 --- /dev/null +++ b/Server/Controller/EventController.cs @@ -0,0 +1,96 @@ +using Blahblah.FlowerStory.Server.Data; +using Blahblah.FlowerStory.Server.Data.Model; +using Microsoft.AspNetCore.Mvc; + +namespace Blahblah.FlowerStory.Server.Controller; + +/// +/// 事件相关服务 +/// +[ApiController] +[Consumes("application/json")] +[Produces("application/json")] +[Route("api/event")] +public class EventController : BaseController +{ + /// + public EventController(FlowerDatabase database, ILogger? logger = null) : base(database, logger) + { + } + + /// + /// 获取用户相关所有符合条件的事件 + /// + /// + /// 请求示例： + /// + /// GET /api/event/query + /// Authorization: authorization id + /// + /// 参数： + /// + /// cid: int? + /// key: string? + /// from: long? + /// to: long? + /// cfrom: decimal? + /// cto: decimal? + /// + /// + /// 事件类型 id + /// 查询关键字 + /// 起始日期 + /// 结束日期 + /// 会话有效则返回符合条件的花草集 + /// 返回符合条件的花草集 + /// 未找到登录会话或已过期 + /// 用户已禁用 + /// 未找到关联用户 + [Route("query")] + [ProducesResponseType(StatusCodes.Status200OK)] + [ProducesResponseType(StatusCodes.Status401Unauthorized)] + [ProducesResponseType(StatusCodes.Status403Forbidden)] + [ProducesResponseType(StatusCodes.Status404NotFound)] + [HttpGet] + public ActionResult GetRecords( + [FromQuery(Name = "eid")] int? eventId, + [FromQuery] string? key, + [FromQuery] long? from, + [FromQuery] long? to) + { + var (result, user) = CheckPermission(); + if (result != null) + { + return result; + } + if (user == null) + { + return NotFound(); + } + + SaveDatabase(); + + var records = database.Records.Where(r => r.OwnerId == user.Id); + if (eventId != null) + { + records = records.Where(r => r.EventId == eventId); + } + if (key != null) + { + records = records.Where(r => + r.ByUserName != null && r.ByUserName.ToLower().Contains(key.ToLower()) + // TODO: notes + ); + } + if (from != null) + { + records = records.Where(r => r.DateUnixTime >= from); + } + if (to != null) + { + records = records.Where(r => r.DateUnixTime <= to); + } + + return Ok(records.ToArray()); + } +} diff --git a/Server/Controller/FlowerController.cs b/Server/Controller/FlowerController.cs new file mode 100644 index 0000000..9484808 --- /dev/null +++ b/Server/Controller/FlowerController.cs @@ -0,0 +1,314 @@ +using Blahblah.FlowerStory.Server.Data; +using Blahblah.FlowerStory.Server.Data.Model; +using Microsoft.AspNetCore.Mvc; +using Microsoft.EntityFrameworkCore; +using System.ComponentModel.DataAnnotations; + +namespace Blahblah.FlowerStory.Server.Controller; + +/// +/// 花草相关服务 +/// +[ApiController] +[Consumes("application/json")] +[Produces("application/json")] +[Route("api/flower")] +public class FlowerController : BaseController +{ + /// + public FlowerController(FlowerDatabase database, ILogger? logger = null) : base(database, logger) + { + } + + /// + /// 获取用户名下所有符合条件的花草 + /// + /// + /// 请求示例： + /// + /// GET /api/flower/query + /// Authorization: authorization id + /// + /// 参数： + /// + /// cid: int? + /// key: string? + /// from: long? + /// to: long? + /// cfrom: decimal? + /// cto: decimal? + /// + /// + /// 类别 id + /// 查询关键字 + /// 起始购买日期 + /// 结束购买日期 + /// 开销最小值 + /// 开销最大值 + /// 会话有效则返回符合条件的花草集 + /// 返回符合条件的花草集 + /// 未找到登录会话或已过期 + /// 用户已禁用 + /// 未找到关联用户 + [Route("query")] + [ProducesResponseType(StatusCodes.Status200OK)] + [ProducesResponseType(StatusCodes.Status401Unauthorized)] + [ProducesResponseType(StatusCodes.Status403Forbidden)] + [ProducesResponseType(StatusCodes.Status404NotFound)] + [HttpGet] + public ActionResult GetFlowers( + [FromQuery(Name = "cid")] int? categoryId, + [FromQuery] string? key, + [FromQuery(Name = "from")] long? buyFrom, + [FromQuery(Name = "to")] long? buyTo, + [FromQuery(Name = "cfrom")] decimal? costFrom, + [FromQuery(Name = "cto")] decimal? costTo) + { + var (result, user) = CheckPermission(); + if (result != null) + { + return result; + } + if (user == null) + { + return NotFound(); + } + + SaveDatabase(); + + var flowers = database.Flowers.Where(f => f.OwnerId == user.Id); + if (categoryId != null) + { + flowers = flowers.Where(f => f.CategoryId == categoryId); + } + if (key != null) + { + flowers = flowers.Where(f => + f.Name.ToLower().Contains(key.ToLower()) || + f.Purchase != null && + f.Purchase.ToLower().Contains(key.ToLower())); + } + if (buyFrom != null) + { + flowers = flowers.Where(f => f.DateBuyUnixTime >= buyFrom); + } + if (buyTo != null) + { + flowers = flowers.Where(f => f.DateBuyUnixTime <= buyTo); + } + if (costFrom != null) + { + flowers = flowers.Where(f => f.Cost != null && f.Cost >= costFrom); + } + if (costTo != null) + { + flowers = flowers.Where(f => f.Cost != null && f.Cost <= costTo); + } + + return Ok(flowers.ToArray()); + } + + /// + /// 移除用户的花草 + /// + /// + /// 请求示例： + /// + /// DELETE /api/flower/remove + /// Authorization: authorization id + /// + /// 参数： + /// + /// id: int + /// + /// + /// 花草唯一 id + /// 会话有效则返回操作影响的数据库行数 + /// 返回操作影响的数据库行数 + /// 未找到登录会话或已过期 + /// 用户已禁用 + /// 未找到关联用户 + [Route("remove")] + [ProducesResponseType(StatusCodes.Status200OK)] + [ProducesResponseType(StatusCodes.Status401Unauthorized)] + [ProducesResponseType(StatusCodes.Status403Forbidden)] + [ProducesResponseType(StatusCodes.Status404NotFound)] + [HttpDelete] + public ActionResult RemoveFlower([FromQuery][Required] int id) + { + var (result, user) = CheckPermission(); + if (result != null) + { + return result; + } + if (user == null) + { + return NotFound(); + } + + var count = database.Database.ExecuteSql($"DELETE FROM [flowers] WHERE \"uid\" = {user.Id} AND \"fid\" = {id}"); + + SaveDatabase(); + + return Ok(count); + } + + /// + /// 批量移除用户的花草 + /// + /// + /// 请求示例： + /// + /// POST /api/flower/remove + /// Authorization: authorization id + /// [ + /// 2, 4, 5, 11 + /// ] + /// + /// + /// 要移除的花草唯一 id 的数组 + /// 会话有效则返回操作影响的数据库行数 + /// 返回操作影响的数据库行数 + /// 未找到登录会话或已过期 + /// 用户已禁用 + /// 未找到关联用户 + [Route("removeany")] + [ProducesResponseType(StatusCodes.Status200OK)] + [ProducesResponseType(StatusCodes.Status401Unauthorized)] + [ProducesResponseType(StatusCodes.Status403Forbidden)] + [ProducesResponseType(StatusCodes.Status404NotFound)] + [HttpPost] + public ActionResult RemoveFlower([FromBody] int[] ids) + { + var (result, user) = CheckPermission(); + if (result != null) + { + return result; + } + if (user == null) + { + return NotFound(); + } + + var idfilter = string.Join(", ", ids); + var count = database.Database.ExecuteSql($"DELETE FROM [flowers] WHERE \"uid\" = {user.Id} AND \"fid\" IN ({idfilter})"); + + SaveDatabase(); + + return Ok(count); + } + + /// + /// 用户添加花草 + /// + /// + /// 请求示例： + /// + /// POST /api/flower/add + /// Authorization: authorization id + /// { + /// "categoryId": 0, + /// "name": "玛格丽特", + /// "dateBuy": 1684919954743, + /// "cost": 5.00, + /// "purchase": "花鸟市场" + /// } + /// + /// + /// 花草参数 + /// 添加成功则返回已添加的花草对象 + /// 返回已添加的花草对象 + /// 未找到登录会话或已过期 + /// 用户已禁用 + /// 未找到关联用户 + [Route("add")] + [ProducesResponseType(StatusCodes.Status200OK)] + [ProducesResponseType(StatusCodes.Status401Unauthorized)] + [ProducesResponseType(StatusCodes.Status403Forbidden)] + [ProducesResponseType(StatusCodes.Status404NotFound)] + [HttpPost] + public ActionResult AddFlower([FromBody] FlowerParameter flower) + { + var (result, user) = CheckPermission(); + if (result != null) + { + return result; + } + if (user == null) + { + return NotFound(); + } + + var item = new FlowerItem + { + OwnerId = user.Id, + CategoryId = flower.CategoryId, + Name = flower.Name, + DateBuyUnixTime = flower.DateBuy, + Cost = flower.Cost, + Purchase = flower.Purchase + }; + database.Flowers.Add(item); + SaveDatabase(); + + return Ok(item); + } + + /// + /// 修改花草 + /// + /// + /// 请求示例： + /// + /// PUT /api/flower/update + /// Authorization: authorization id + /// { + /// "id": 0, + /// "categoryId": 1, + /// "name": "姬小菊", + /// "dateBuy": 1684935276117, + /// "cost": 15.00, + /// "purchase": null + /// } + /// + /// + /// 修改参数 + /// 修改成功则返回已修改的花草对象 + /// 返回已修改的花草对象 + /// 未找到登录会话或已过期 + /// 用户已禁用 + /// 未找到关联用户或者未找到将修改的花草对象 + [Route("update")] + [ProducesResponseType(StatusCodes.Status200OK)] + [ProducesResponseType(StatusCodes.Status401Unauthorized)] + [ProducesResponseType(StatusCodes.Status403Forbidden)] + [ProducesResponseType(StatusCodes.Status404NotFound)] + [HttpPut] + public ActionResult Update([FromBody] FlowerUpdateParameter update) + { + var (result, user) = CheckPermission(); + if (result != null) + { + return result; + } + if (user == null) + { + return NotFound(); + } + + var flower = database.Flowers.FirstOrDefault(f => f.Id == update.Id && f.OwnerId == user.Id); + if (flower == null) + { + return NotFound(update.Id); + } + flower.CategoryId = update.CategoryId; + flower.Name = update.Name; + flower.DateBuyUnixTime = update.DateBuy; + flower.Cost = update.Cost; + flower.Purchase = update.Purchase; + database.Flowers.Update(flower); + SaveDatabase(); + + return Ok(user); + } +} diff --git a/Server/Controller/FlowerController.structs.cs b/Server/Controller/FlowerController.structs.cs new file mode 100644 index 0000000..bf29a21 --- /dev/null +++ b/Server/Controller/FlowerController.structs.cs @@ -0,0 +1,49 @@ +using System.ComponentModel.DataAnnotations; + +namespace Blahblah.FlowerStory.Server.Controller; + +/// +/// 花草参数 +/// +public record FlowerParameter +{ + /// + /// 类别 id + /// + [Required] + public int CategoryId { get; init; } + + /// + /// 花草名称 + /// + [Required] + public required string Name { get; init; } + + /// + /// 购买时间 + /// + [Required] + public long DateBuy { get; init; } + + /// + /// 购买花费 + /// + public decimal? Cost { get; init; } + + /// + /// 购买渠道 + /// + public string? Purchase { get; init; } +} + +/// +/// 花草修改参数 +/// +public record FlowerUpdateParameter : FlowerParameter +{ + /// + /// 花草 id + /// + [Required] + public int Id { get; set; } +} \ No newline at end of file diff --git a/Server/Controller/SwaggerController.cs b/Server/Controller/SwaggerController.cs new file mode 100644 index 0000000..d2289c0 --- /dev/null +++ b/Server/Controller/SwaggerController.cs @@ -0,0 +1,139 @@ +using Microsoft.AspNetCore.Mvc; +using Swashbuckle.AspNetCore.SwaggerGen; +using System.Text; + +namespace Blahblah.FlowerStory.Server.Controller; + +/// +[Route("apidoc")] +public class SwaggerController : ControllerBase +{ + private readonly SwaggerGenerator generator; + + /// + public SwaggerController(SwaggerGenerator generator) + { + this.generator = generator; + } + + /// + [Route("get/{version}")] + [HttpGet] + public ActionResult GetApi(string version) + { + var model = generator.GetSwagger(version); + var builder = new StringBuilder(); + builder.Append($@" + + + + Flower Story - API 接口文档 + + + +
+

{model.Info.Title}

+

接口文档 {model.Info.Version}

+

{model.Info.Description}

"); + foreach (var item in model.Paths) + { + if (item.Value.Operations != null) + { + foreach (var operation in item.Value.Operations) + { + if (string.IsNullOrEmpty(operation.Value.Summary)) + { + continue; + } + builder.Append($@" +

{operation.Value.Summary}

+ + + + + + + + + + "); + if (operation.Value.Parameters?.Count > 0) + { + builder.Append(@" + + + + + + "); + foreach (var param in operation.Value.Parameters) + { + builder.Append($@" + + + + + + "); + } + } + if (operation.Value.Responses?.Count > 0) + { + builder.Append(@" + + + + "); + foreach (var response in operation.Value.Responses) + { + builder.Append($@" + + + + "); + } + } + builder.Append(@" +
URL{item.Key}
请求方式{operation.Key}
参数参数类型是否必须说明
{param.Name}{param.In}{param.Required}{param.Description}
状态码说明
{response.Key}{response.Value.Description}
"); + } + } + } + builder.Append(@" +
+ +"); + return Content(builder.ToString(), "text/html"); + } +} diff --git a/Server/Controller/UserController.cs b/Server/Controller/UserController.cs index 2b8451a..e5ed4e7 100644 --- a/Server/Controller/UserController.cs +++ b/Server/Controller/UserController.cs @@ -1,6 +1,7 @@ using Blahblah.FlowerStory.Server.Data; using Blahblah.FlowerStory.Server.Data.Model; using Microsoft.AspNetCore.Mvc; +using System.Security.Cryptography; namespace Blahblah.FlowerStory.Server.Controller { @@ -8,15 +9,12 @@ namespace Blahblah.FlowerStory.Server.Controller /// 用户会话相关服务 /// [ApiController] + [Consumes("application/json")] [Produces("application/json")] - [Route("users")] + [Route("api/user")] public partial class UserController : BaseController { - /// - /// 构造用户会话服务 - /// - /// 数据库对象 - /// 日志对象 + /// public UserController(FlowerDatabase db, ILogger logger) : base(db, logger) { } @@ -25,9 +23,9 @@ namespace Blahblah.FlowerStory.Server.Controller /// 用户登录 /// /// - /// 提交示例： + /// 请求示例： /// - /// POST /users/auth + /// POST /api/user/auth /// { /// "id": "blahblah", /// "password": "pwd123" @@ -36,12 +34,11 @@ namespace Blahblah.FlowerStory.Server.Controller /// /// 登录参数 /// 成功登录则返回自定义认证头 - /// 返回自定义认证头 + /// 返回自定义认证头 /// 认证失败 /// 未找到用户 [Route("auth")] - [Consumes("application/json")] - [ProducesResponseType(StatusCodes.Status200OK)] + [ProducesResponseType(StatusCodes.Status204NoContent)] [ProducesResponseType(StatusCodes.Status401Unauthorized)] [ProducesResponseType(StatusCodes.Status404NotFound)] [HttpPost] @@ -66,12 +63,12 @@ namespace Blahblah.FlowerStory.Server.Controller } // record the session - // TODO: singleton token + // TODO: singleton token, mobile + var expires = 1200; var now = DateTimeOffset.UtcNow; - var expires = 1200; // 20 minutes var token = new TokenItem { - Id = Guid.NewGuid().ToString("N"), + Id = Convert.ToBase64String(SHA256.HashData(Guid.NewGuid().ToByteArray())), UserId = user.Id, LogonDateUnixTime = now.ToUnixTimeMilliseconds(), ActiveDateUnixTime = now.ToUnixTimeMilliseconds(), @@ -87,16 +84,51 @@ namespace Blahblah.FlowerStory.Server.Controller SaveDatabase(); Response.Headers.Add(AuthHeader, token.Id); - return Ok(); + return NoContent(); + } + + /// + /// 注销当前登录会话 + /// + /// + /// 请求示例： + /// + /// POST /api/user/logout + /// Authorization: authorization id + /// + /// + /// 注销失败则返回错误内容 + /// 注销成功 + /// 认证失败 + [Route("logout")] + [ProducesResponseType(StatusCodes.Status204NoContent)] + [ProducesResponseType(StatusCodes.Status401Unauthorized)] + [HttpPost] + public ActionResult Logout() + { + var (result, token) = CheckToken(); + if (result != null) + { + return result; + } + if (token == null) + { + return Unauthorized(); + } + + database.Tokens.Remove(token); + SaveDatabase(); + + return NoContent(); } /// /// 注册用户 /// /// - /// 提交示例： + /// 请求示例： /// - /// POST /users/register + /// POST /api/user/register /// { /// "id": "blahblah", /// "password": "pwd123", @@ -111,7 +143,6 @@ namespace Blahblah.FlowerStory.Server.Controller /// 返回已注册的用户对象 /// 用户重复或其他服务器错误 [Route("register")] - [Consumes("application/json")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status500InternalServerError)] [HttpPost] @@ -124,7 +155,7 @@ namespace Blahblah.FlowerStory.Server.Controller if (u != null) { logger?.LogWarning("duplicate user \"{id}\"", user.Id); - return Problem("duplicateUser", "users/register", 500); + return Problem("duplicateUser", "user/register", 500); } var now = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds(); @@ -145,13 +176,53 @@ namespace Blahblah.FlowerStory.Server.Controller return Ok(item); } + /// + /// 查询当前会话关联的用户 + /// + /// + /// 请求示例： + /// + /// GET /api/user/profile + /// Authorization: authorization id + /// + /// + /// 会话有效则返回关联的用户对象 + /// 返回关联的用户对象 + /// 未找到登录会话或已过期 + /// 用户已禁用 + /// 未找到关联用户 + [Route("profile")] + [ProducesResponseType(StatusCodes.Status200OK)] + [ProducesResponseType(StatusCodes.Status401Unauthorized)] + [ProducesResponseType(StatusCodes.Status403Forbidden)] + [ProducesResponseType(StatusCodes.Status404NotFound)] + [HttpGet] + public ActionResult Profile() + { + var (result, user) = CheckPermission(); + if (result != null) + { + return result; + } + if (user == null) + { + return NotFound(); + } + + // update last active time + SaveDatabase(); + + return Ok(user); + } + /// /// 修改用户 /// /// - /// 提交示例： + /// 请求示例： /// - /// POST /users/update + /// PUT /api/user/update + /// Authorization: authorization id /// { /// "userName": "Blah blah", /// "email": "blah@example.com", @@ -162,18 +233,15 @@ namespace Blahblah.FlowerStory.Server.Controller /// 修改参数 /// 修改成功则返回已修改的用户对象 /// 返回已修改的用户对象 - /// 认证头未找到 - /// 服务器未找到登录会话 - /// 用户权限不足 + /// 未找到登录会话或已过期 + /// 用户已禁用 /// 未找到关联用户 [Route("update")] - [Consumes("application/json")] [ProducesResponseType(StatusCodes.Status200OK)] - [ProducesResponseType(StatusCodes.Status400BadRequest)] [ProducesResponseType(StatusCodes.Status401Unauthorized)] [ProducesResponseType(StatusCodes.Status403Forbidden)] [ProducesResponseType(StatusCodes.Status404NotFound)] - [HttpPost] + [HttpPut] public ActionResult Update([FromBody] UpdateParameter update) { #if DEBUG @@ -189,8 +257,8 @@ namespace Blahblah.FlowerStory.Server.Controller return NotFound(); } - var now = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds(); - user.ActiveDateUnixTime = now; + //var now = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds(); + //user.ActiveDateUnixTime = now; user.Name = update.UserName; user.Email = update.Email; user.Mobile = update.Mobile; @@ -202,10 +270,10 @@ namespace Blahblah.FlowerStory.Server.Controller //#if DEBUG /// - /// 获取所有用户 + /// #DEBUG 获取所有用户 /// /// - [Route("query")] + [Route("debug_list")] [HttpGet] public ActionResult GetUsers() { @@ -213,10 +281,10 @@ namespace Blahblah.FlowerStory.Server.Controller } /// - /// 获取所有 token + /// #DEBUG 获取所有 token /// /// - [Route("tokens")] + [Route("debug_tokens")] [HttpGet] public ActionResult GetTokens() { diff --git a/Server/Controller/UserController.structs.cs b/Server/Controller/UserController.structs.cs index 9dc5751..3d30fb0 100644 --- a/Server/Controller/UserController.structs.cs +++ b/Server/Controller/UserController.structs.cs @@ -1,4 +1,6 @@ -namespace Blahblah.FlowerStory.Server.Controller; +using System.ComponentModel.DataAnnotations; + +namespace Blahblah.FlowerStory.Server.Controller; partial class UserController { @@ -7,24 +9,57 @@ partial class UserController /// /// 登录参数 /// -/// 用户 id -/// 密码 -public record LoginParamter(string Id, string Password); +public record LoginParamter +{ + /// + /// 用户 id + /// + [Required] + public required string Id { get; init; } + + /// + /// 密码 + /// + [Required] + public required string Password { get; init; } +} /// /// 用户注册参数 /// -/// 用户 id -/// 密码 -/// 用户名 -/// 邮箱 -/// 联系电话 -public record UserParameter(string Id, string Password, string UserName, string? Email, string? Mobile) : UpdateParameter(UserName, Email, Mobile); +public record UserParameter : UpdateParameter +{ + /// + /// 用户 id + /// + [Required] + public required string Id { get; init; } + + /// + /// 密码 + /// + [Required] + public required string Password { get; init; } +} /// /// 用户修改参数 /// -/// 用户名 -/// 邮箱 -/// 联系电话 -public record UpdateParameter(string UserName, string? Email, string? Mobile); +public record UpdateParameter +{ + /// + /// 用户名 + /// + [Required] + public required string UserName { get; init; } + + /// + /// 邮箱 + /// + public string? Email { get; init; } + + /// + /// 联系电话 + /// + public string? Mobile { get; init; } +} diff --git a/Server/Data/Model/FlowerItem.cs b/Server/Data/Model/FlowerItem.cs index 0232d7d..2290e09 100644 --- a/Server/Data/Model/FlowerItem.cs +++ b/Server/Data/Model/FlowerItem.cs @@ -18,6 +18,13 @@ public class FlowerItem [Required] public int Id { get; set; } + /// + /// 所有人 uid + /// + [Column("uid")] + [Required] + public int OwnerId { get; set; } + /// /// 类别 id /// diff --git a/Server/Data/Model/RecordItem.cs b/Server/Data/Model/RecordItem.cs index de8ddbb..65e556b 100644 --- a/Server/Data/Model/RecordItem.cs +++ b/Server/Data/Model/RecordItem.cs @@ -18,6 +18,13 @@ public class RecordItem [Required] public int Id { get; set; } + /// + /// 关联人 uid + /// + [Column("uid")] + [Required] + public int OwnerId { get; set; } + /// /// 事件类型 /// diff --git a/Server/Migrations/20230524062207_AddOwner.Designer.cs b/Server/Migrations/20230524062207_AddOwner.Designer.cs new file mode 100644 index 0000000..71c671c --- /dev/null +++ b/Server/Migrations/20230524062207_AddOwner.Designer.cs @@ -0,0 +1,202 @@ +// +using System; +using Blahblah.FlowerStory.Server.Data; +using Microsoft.EntityFrameworkCore; +using Microsoft.EntityFrameworkCore.Infrastructure; +using Microsoft.EntityFrameworkCore.Migrations; +using Microsoft.EntityFrameworkCore.Storage.ValueConversion; + +#nullable disable + +namespace Blahblah.FlowerStory.Server.Migrations +{ + [DbContext(typeof(FlowerDatabase))] + [Migration("20230524062207_AddOwner")] + partial class AddOwner + { + /// + protected override void BuildTargetModel(ModelBuilder modelBuilder) + { +#pragma warning disable 612, 618 + modelBuilder.HasAnnotation("ProductVersion", "7.0.5"); + + modelBuilder.Entity("Blahblah.FlowerStory.Server.Data.Model.FlowerItem", b => + { + b.Property("Id") + .ValueGeneratedOnAdd() + .HasColumnType("INTEGER") + .HasColumnName("fid"); + + b.Property("CategoryId") + .HasColumnType("INTEGER") + .HasColumnName("categoryid"); + + b.Property("Cost") + .HasColumnType("real") + .HasColumnName("cost"); + + b.Property("DateBuyUnixTime") + .HasColumnType("INTEGER") + .HasColumnName("datebuy") + .HasAnnotation("Relational:JsonPropertyName", "dateBuy"); + + b.Property("Name") + .IsRequired() + .HasColumnType("TEXT") + .HasColumnName("name"); + + b.Property("OwnerId") + .HasColumnType("INTEGER") + .HasColumnName("uid"); + + b.Property("Photo") + .HasColumnType("BLOB") + .HasColumnName("photo"); + + b.Property("Purchase") + .HasColumnType("TEXT") + .HasColumnName("purchase"); + + b.HasKey("Id"); + + b.ToTable("flowers"); + }); + + modelBuilder.Entity("Blahblah.FlowerStory.Server.Data.Model.RecordItem", b => + { + b.Property("Id") + .ValueGeneratedOnAdd() + .HasColumnType("INTEGER") + .HasColumnName("rid"); + + b.Property("ByUserId") + .HasColumnType("INTEGER") + .HasColumnName("byuid"); + + b.Property("ByUserName") + .HasColumnType("TEXT") + .HasColumnName("byname"); + + b.Property("DateUnixTime") + .HasColumnType("INTEGER") + .HasColumnName("date") + .HasAnnotation("Relational:JsonPropertyName", "date"); + + b.Property("EventId") + .HasColumnType("INTEGER") + .HasColumnName("eid"); + + b.Property("OwnerId") + .HasColumnType("INTEGER") + .HasColumnName("uid"); + + b.Property("Photo") + .HasColumnType("BLOB") + .HasColumnName("photo"); + + b.HasKey("Id"); + + b.ToTable("records"); + }); + + modelBuilder.Entity("Blahblah.FlowerStory.Server.Data.Model.TokenItem", b => + { + b.Property("Id") + .HasColumnType("TEXT") + .HasColumnName("tid"); + + b.Property("ActiveDateUnixTime") + .HasColumnType("INTEGER") + .HasColumnName("activedate") + .HasAnnotation("Relational:JsonPropertyName", "activeDate"); + + b.Property("ClientAgent") + .HasColumnType("TEXT") + .HasColumnName("clientagent"); + + b.Property("ClientApp") + .HasColumnType("TEXT") + .HasColumnName("clientapp"); + + b.Property("DeviceId") + .HasColumnType("TEXT") + .HasColumnName("deviceid"); + + b.Property("ExpireDateUnixTime") + .HasColumnType("INTEGER") + .HasColumnName("expiredate") + .HasAnnotation("Relational:JsonPropertyName", "expireDate"); + + b.Property("ExpireSeconds") + .HasColumnType("INTEGER") + .HasColumnName("expiresecs"); + + b.Property("LogonDateUnixTime") + .HasColumnType("INTEGER") + .HasColumnName("logondate") + .HasAnnotation("Relational:JsonPropertyName", "logonDate"); + + b.Property("UserId") + .HasColumnType("INTEGER") + .HasColumnName("uid"); + + b.Property("VerifyCode") + .HasColumnType("TEXT") + .HasColumnName("verifycode"); + + b.HasKey("Id"); + + b.ToTable("tokens"); + }); + + modelBuilder.Entity("Blahblah.FlowerStory.Server.Data.Model.UserItem", b => + { + b.Property("Id") + .ValueGeneratedOnAdd() + .HasColumnType("INTEGER") + .HasColumnName("uid"); + + b.Property("ActiveDateUnixTime") + .HasColumnType("INTEGER") + .HasColumnName("activedate"); + + b.Property("Email") + .HasColumnType("TEXT") + .HasColumnName("email"); + + b.Property("Level") + .HasColumnType("INTEGER") + .HasColumnName("level"); + + b.Property("Mobile") + .HasColumnType("TEXT") + .HasColumnName("mobile"); + + b.Property("Name") + .IsRequired() + .HasColumnType("TEXT") + .HasColumnName("name"); + + b.Property("Password") + .IsRequired() + .HasColumnType("TEXT") + .HasColumnName("password"); + + b.Property("RegisterDateUnixTime") + .HasColumnType("INTEGER") + .HasColumnName("regdate") + .HasAnnotation("Relational:JsonPropertyName", "registerDate"); + + b.Property("UserId") + .IsRequired() + .HasColumnType("TEXT") + .HasColumnName("id"); + + b.HasKey("Id"); + + b.ToTable("users"); + }); +#pragma warning restore 612, 618 + } + } +} diff --git a/Server/Migrations/20230524062207_AddOwner.cs b/Server/Migrations/20230524062207_AddOwner.cs new file mode 100644 index 0000000..79fcc1f --- /dev/null +++ b/Server/Migrations/20230524062207_AddOwner.cs @@ -0,0 +1,40 @@ +using Microsoft.EntityFrameworkCore.Migrations; + +#nullable disable + +namespace Blahblah.FlowerStory.Server.Migrations +{ + /// + public partial class AddOwner : Migration + { + /// + protected override void Up(MigrationBuilder migrationBuilder) + { + migrationBuilder.AddColumn( + name: "uid", + table: "records", + type: "INTEGER", + nullable: false, + defaultValue: 0); + + migrationBuilder.AddColumn( + name: "uid", + table: "flowers", + type: "INTEGER", + nullable: false, + defaultValue: 0); + } + + /// + protected override void Down(MigrationBuilder migrationBuilder) + { + migrationBuilder.DropColumn( + name: "uid", + table: "records"); + + migrationBuilder.DropColumn( + name: "uid", + table: "flowers"); + } + } +} diff --git a/Server/Migrations/FlowerDatabaseModelSnapshot.cs b/Server/Migrations/FlowerDatabaseModelSnapshot.cs index cea8de6..beaed6f 100644 --- a/Server/Migrations/FlowerDatabaseModelSnapshot.cs +++ b/Server/Migrations/FlowerDatabaseModelSnapshot.cs @@ -42,6 +42,10 @@ namespace Blahblah.FlowerStory.Server.Migrations .HasColumnType("TEXT") .HasColumnName("name"); + b.Property("OwnerId") + .HasColumnType("INTEGER") + .HasColumnName("uid"); + b.Property("Photo") .HasColumnType("BLOB") .HasColumnName("photo"); @@ -79,6 +83,10 @@ namespace Blahblah.FlowerStory.Server.Migrations .HasColumnType("INTEGER") .HasColumnName("eid"); + b.Property("OwnerId") + .HasColumnType("INTEGER") + .HasColumnName("uid"); + b.Property("Photo") .HasColumnType("BLOB") .HasColumnName("photo"); @@ -96,7 +104,8 @@ namespace Blahblah.FlowerStory.Server.Migrations b.Property("ActiveDateUnixTime") .HasColumnType("INTEGER") - .HasColumnName("activedate"); + .HasColumnName("activedate") + .HasAnnotation("Relational:JsonPropertyName", "activeDate"); b.Property("ClientAgent") .HasColumnType("TEXT") @@ -112,7 +121,8 @@ namespace Blahblah.FlowerStory.Server.Migrations b.Property("ExpireDateUnixTime") .HasColumnType("INTEGER") - .HasColumnName("expiredate"); + .HasColumnName("expiredate") + .HasAnnotation("Relational:JsonPropertyName", "expireDate"); b.Property("ExpireSeconds") .HasColumnType("INTEGER") @@ -120,7 +130,8 @@ namespace Blahblah.FlowerStory.Server.Migrations b.Property("LogonDateUnixTime") .HasColumnType("INTEGER") - .HasColumnName("logondate"); + .HasColumnName("logondate") + .HasAnnotation("Relational:JsonPropertyName", "logonDate"); b.Property("UserId") .HasColumnType("INTEGER") diff --git a/Server/Program.cs b/Server/Program.cs index 3cbb0c4..371f02c 100644 --- a/Server/Program.cs +++ b/Server/Program.cs @@ -25,7 +25,26 @@ public class Program builder.Services.AddEndpointsApiExplorer(); builder.Services.AddSwaggerGen(options => { - options.OperationFilter(); + //options.OperationFilter(); + + var scheme = new OpenApiSecurityScheme + { + Description = "Ȩͷ ʾ \"RG//HkvcTZdBospBOT6OuoWfsc1GS+P/js9zFdflBr0=\"", + Reference = new OpenApiReference + { + Type = ReferenceType.SecurityScheme, + Id = "Authorization" + }, + Scheme = "oauth2", + Name = "Authorization", + In = ParameterLocation.Header, + Type = SecuritySchemeType.ApiKey + }; + options.AddSecurityDefinition("Authorization", scheme); + options.AddSecurityRequirement(new OpenApiSecurityRequirement + { + [scheme] = Array.Empty() + }); options.SwaggerDoc(Version, new OpenApiInfo { @@ -38,6 +57,7 @@ public class Program }); builder.Services.AddDbContext(options => options.UseSqlite("DataSource=flower.db;Cache=Shared")); + builder.Services.AddScoped(); var app = builder.Build(); @@ -64,12 +84,23 @@ public class SwaggerHttpHeaderOperation : IOperationFilter /// public void Apply(OpenApiOperation operation, OperationFilterContext context) { - operation.Parameters.Add(new OpenApiParameter + var required = context.ApiDescription.RelativePath switch { - Name = "X-Auth", - In = ParameterLocation.Header, - Required = false, - Schema = new OpenApiSchema { Type = "string" } - }); + "user/update" or + "user/profile" or + "user/logout" => true, + _ => false + }; + if (required) + { + operation.Parameters.Add(new OpenApiParameter + { + Name = "Authorization", + Description = "Ȩ Token", + In = ParameterLocation.Header, + Required = true, + Schema = new OpenApiSchema { Type = "string" } + }); + } } } \ No newline at end of file diff --git a/Server/Server.csproj b/Server/Server.csproj index 6a39827..ffec1af 100644 --- a/Server/Server.csproj +++ b/Server/Server.csproj @@ -10,6 +10,10 @@ README.md + + + +