add users documents

Doc/README.md

@@ -0,0 +1,3 @@
+# Flower Story
+
+花事记录，贴心的帮您记录花园中的点点滴滴。

Server/Controller/BaseController.cs

@@ -0,0 +1,135 @@
+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;
+
+namespace Blahblah.FlowerStory.Server.Controller;
+
+/// <summary>
+/// 基础服务抽象类
+/// </summary>
+public abstract class BaseController : ControllerBase
+{
+    private const string Salt = "Blah blah, o! Flower story, intimately help you record every bit of the garden.";
+
+    /// <summary>
+    /// 自定义认证头的关键字
+    /// </summary>
+    protected const string AuthHeader = "X-Auth";
+    /// <summary>
+    /// 禁用用户
+    /// </summary>
+    protected const int UserDisabled = -1;
+    /// <summary>
+    /// 普通用户
+    /// </summary>
+    protected const int UserCommon = 0;
+    /// <summary>
+    /// 管理员用户
+    /// </summary>
+    protected const int UserAdmin = 99;
+
+    /// <summary>
+    /// 数据库对象
+    /// </summary>
+    protected readonly FlowerDatabase database;
+    /// <summary>
+    /// 日志对象
+    /// </summary>
+    protected readonly ILogger<BaseController>? logger;
+
+    /// <summary>
+    /// 构造基础服务类
+    /// </summary>
+    /// <param name="database">数据库对象</param>
+    /// <param name="logger">日志对象</param>
+    protected BaseController(FlowerDatabase database, ILogger<BaseController>? logger = null)
+    {
+        this.database = database;
+        this.logger = logger;
+    }
+
+    /// <summary>
+    /// 计算密码的 hash
+    /// </summary>
+    /// <param name="password">密码原文</param>
+    /// <param name="id">用户 id</param>
+    /// <returns>密码 hash，值为 SHA256(password+id+salt)</returns>
+    /// <exception cref="ArgumentNullException"></exception>
+    protected string HashPassword(string password, string id)
+    {
+        if (string.IsNullOrEmpty(password))
+        {
+            throw new ArgumentNullException(nameof(password));
+        }
+        if (string.IsNullOrEmpty(id))
+        {
+            throw new ArgumentNullException(nameof(id));
+        }
+        var data = Encoding.UTF8.GetBytes($"{password}{id}{Salt}");
+        var hash = SHA256.HashData(data);
+        return Convert.ToHexString(hash);
+    }
+
+    /// <summary>
+    /// 检查当前会话权限
+    /// </summary>
+    /// <param name="level">需要大于等于该权限，默认为 0 - UserCommon</param>
+    /// <returns>若检查失败，第一个参数返回异常 ActionResult。第二个参数返回会话对应的用户对象</returns>
+    protected (ActionResult? Result, UserItem? User) CheckPermission(int? level = 0)
+    {
+        if (!Request.Headers.TryGetValue(AuthHeader, out var h))
+        {
+            logger?.LogWarning("request with no {auth} header", AuthHeader);
+            return (BadRequest(), null);
+        }
+        string hash = h.ToString();
+        var token = database.Tokens.Find(hash);
+        if (token == null)
+        {
+            logger?.LogWarning("token \"{hash}\" not found", hash);
+            return (Unauthorized(), null);
+        }
+        if (token.ExpireDate < DateTimeOffset.UtcNow)
+        {
+            logger?.LogWarning("token \"{hash}\" has expired after {date}", hash, 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)
+        {
+            logger?.LogWarning("user \"{id}\" level ({level}) lower than required ({required})", user.UserId, user.Level, level);
+            return (Forbid(), user);
+        }
+
+        token.ActiveDateUnixTime = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds();
+        database.Tokens.Update(token);
+
+        return (null, user);
+    }
+
+    /// <summary>
+    /// 保存数据库变动并输出日志
+    /// </summary>
+    /// <returns></returns>
+    protected int SaveDatabase()
+    {
+        var count = database.SaveChanges();
+        if (count > 0)
+        {
+            logger?.LogInformation("{number} of entries written to database.", count);
+        }
+        else
+        {
+            logger?.LogWarning("no data written to database.");
+        }
+        return count;
+    }
+}

Server/Controller/UserController.cs

@@ -4,57 +4,224 @@ using Microsoft.AspNetCore.Mvc;
 
 namespace Blahblah.FlowerStory.Server.Controller
 {
+    /// <summary>
+    /// 用户会话相关服务
+    /// </summary>
     [ApiController]
+    [Produces("application/json")]
     [Route("users")]
-    public class UserController : ControllerBase
+    public partial class UserController : BaseController
     {
-        private readonly FlowerDatabase database;
-        private readonly ILogger<UserController> logger;
-
-        public UserController(FlowerDatabase db, ILogger<UserController> logger)
+        /// <summary>
+        /// 构造用户会话服务
+        /// </summary>
+        /// <param name="db">数据库对象</param>
+        /// <param name="logger">日志对象</param>
+        public UserController(FlowerDatabase db, ILogger<UserController> logger) : base(db, logger)
         {
-            database = db;
-            this.logger = logger;
         }
 
+        /// <summary>
+        /// 用户登录
+        /// </summary>
+        /// <remarks>
+        /// 提交示例：
+        /// 
+        ///     POST /users/auth
+        ///     {
+        ///         "id": "blahblah",
+        ///         "password": "pwd123"
+        ///     }
+        /// 
+        /// </remarks>
+        /// <param name="login">登录参数</param>
+        /// <returns>成功登录则返回自定义认证头</returns>
+        /// <response code="200">返回自定义认证头</response>
+        /// <response code="401">认证失败</response>
+        /// <response code="404">未找到用户</response>
+        [Route("auth")]
+        [Consumes("application/json")]
+        [ProducesResponseType(StatusCodes.Status200OK)]
+        [ProducesResponseType(StatusCodes.Status401Unauthorized)]
+        [ProducesResponseType(StatusCodes.Status404NotFound)]
+        [HttpPost]
+        public ActionResult Authenticate([FromBody] LoginParamter login)
+        {
+#if DEBUG
+            logger?.LogInformation("user \"{user}\" try to login with password \"{password}\"", login.Id, login.Password);
+#endif
+            var user = database.Users.FirstOrDefault(u => u.UserId == login.Id);
+            if (user == null)
+            {
+                logger?.LogWarning("user \"{user}\" not found", login.Id);
+                return NotFound();
+            }
+
+            // comput password hash with salt
+            string hash = HashPassword(login.Password, login.Id);
+            if (hash != user.Password)
+            {
+                logger?.LogWarning("hash result {hash}, unauthorized with hash {password}", hash, user.Password);
+                return Unauthorized();
+            }
+
+            // record the session
+            // TODO: singleton token
+            var now = DateTimeOffset.UtcNow;
+            var expires = 1200; // 20 minutes
+            var token = new TokenItem
+            {
+                Id = Guid.NewGuid().ToString("N"),
+                UserId = user.Id,
+                LogonDateUnixTime = now.ToUnixTimeMilliseconds(),
+                ActiveDateUnixTime = now.ToUnixTimeMilliseconds(),
+                ExpireDateUnixTime = now.AddSeconds(expires).ToUnixTimeMilliseconds(),
+                ExpireSeconds = expires,
+                ClientApp = "browser",  // TODO: support app later
+                ClientAgent = Request.Headers.UserAgent
+            };
+            database.Tokens.Add(token);
+
+            user.ActiveDateUnixTime = token.ActiveDateUnixTime;
+            database.Users.Update(user);
+            SaveDatabase();
+
+            Response.Headers.Add(AuthHeader, token.Id);
+            return Ok();
+        }
+
+        /// <summary>
+        /// 注册用户
+        /// </summary>
+        /// <remarks>
+        /// 提交示例：
+        /// 
+        ///     POST /users/register
+        ///     {
+        ///         "id": "blahblah",
+        ///         "password": "pwd123",
+        ///         "userName": "Blah blah",
+        ///         "email": "blah@example.com",
+        ///         "mobile": "18012345678"
+        ///     }
+        /// 
+        /// </remarks>
+        /// <param name="user">注册参数</param>
+        /// <returns>成功注册则返回已注册的用户对象</returns>
+        /// <response code="200">返回已注册的用户对象</response>
+        /// <response code="500">用户重复或其他服务器错误</response>
+        [Route("register")]
+        [Consumes("application/json")]
+        [ProducesResponseType(StatusCodes.Status200OK)]
+        [ProducesResponseType(StatusCodes.Status500InternalServerError)]
+        [HttpPost]
+        public ActionResult<UserItem> Register([FromBody] UserParameter user)
+        {
+#if DEBUG
+            logger?.LogInformation("user register, {user}", user);
+#endif
+            var u = database.Users.FirstOrDefault(u => u.UserId == user.Id);
+            if (u != null)
+            {
+                logger?.LogWarning("duplicate user \"{id}\"", user.Id);
+                return Problem("duplicateUser", "users/register", 500);
+            }
+
+            var now = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds();
+            var item = new UserItem
+            {
+                UserId = user.Id,
+                Password = HashPassword(user.Password, user.Id),
+                Level = UserCommon,
+                RegisterDateUnixTime = now,
+                ActiveDateUnixTime = now,
+                Name = user.UserName,
+                Email = user.Email,
+                Mobile = user.Mobile
+            };
+            database.Users.Add(item);
+            SaveDatabase();
+
+            return Ok(item);
+        }
+
+        /// <summary>
+        /// 修改用户
+        /// </summary>
+        /// <remarks>
+        /// 提交示例：
+        /// 
+        ///     POST /users/update
+        ///     {
+        ///         "userName": "Blah blah",
+        ///         "email": "blah@example.com",
+        ///         "mobile": "18012345678"
+        ///     }
+        /// 
+        /// </remarks>
+        /// <param name="update">修改参数</param>
+        /// <returns>修改成功则返回已修改的用户对象</returns>
+        /// <response code="200">返回已修改的用户对象</response>
+        /// <response code="400">认证头未找到</response>
+        /// <response code="401">服务器未找到登录会话</response>
+        /// <response code="403">用户权限不足</response>
+        /// <response code="404">未找到关联用户</response>
+        [Route("update")]
+        [Consumes("application/json")]
+        [ProducesResponseType(StatusCodes.Status200OK)]
+        [ProducesResponseType(StatusCodes.Status400BadRequest)]
+        [ProducesResponseType(StatusCodes.Status401Unauthorized)]
+        [ProducesResponseType(StatusCodes.Status403Forbidden)]
+        [ProducesResponseType(StatusCodes.Status404NotFound)]
+        [HttpPost]
+        public ActionResult<UserItem> Update([FromBody] UpdateParameter update)
+        {
+#if DEBUG
+            logger?.LogInformation("user update, {user}", update);
+#endif
+            var (result, user) = CheckPermission();
+            if (result != null)
+            {
+                return result;
+            }
+            if (user == null)
+            {
+                return NotFound();
+            }
+
+            var now = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds();
+            user.ActiveDateUnixTime = now;
+            user.Name = update.UserName;
+            user.Email = update.Email;
+            user.Mobile = update.Mobile;
+            database.Users.Update(user);
+            SaveDatabase();
+
+            return Ok(user);
+        }
+
+//#if DEBUG
+        /// <summary>
+        /// 获取所有用户
+        /// </summary>
+        /// <returns></returns>
         [Route("query")]
         [HttpGet]
         public ActionResult<UserItem[]> GetUsers()
         {
-            //var forecast = Enumerable.Range(1, 5).Select(index =>
-            //    new WeatherForecast
-            //    {
-            //        Date = DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
-            //        TemperatureC = Random.Shared.Next(-20, 55),
-            //        Summary = summaries[Random.Shared.Next(summaries.Length)]
-            //    })
-            //    .ToArray();
-            //return Ok(forecast);
             return Ok(database.Users.ToArray());
         }
 
-        [Route("update")]
-        [HttpPost]
-        public ActionResult<int> UpdateUser([FromBody] UserItem item)
+        /// <summary>
+        /// 获取所有 token
+        /// </summary>
+        /// <returns></returns>
+        [Route("tokens")]
+        [HttpGet]
+        public ActionResult<TokenItem[]> GetTokens()
         {
-            if (item.Id > 0)
-            {
-                database.Update(item);
-            }
-            else
-            {
-                database.Add(item);
-            }
-            var count = database.SaveChanges();
-            if (count > 0)
-            {
-                logger.LogInformation("{number} of entries written to database.", count);
-            }
-            else
-            {
-                logger.LogWarning("no data written to database.");
-            }
-            return Ok(item.Id);
+            return Ok(database.Tokens.ToArray());
         }
+//#endif
     }
 }

Server/Controller/UserController.structs.cs

@@ -0,0 +1,30 @@
+namespace Blahblah.FlowerStory.Server.Controller;
+
+partial class UserController
+{
+}
+
+/// <summary>
+/// 登录参数
+/// </summary>
+/// <param name="Id">用户 id</param>
+/// <param name="Password">密码</param>
+public record LoginParamter(string Id, string Password);
+
+/// <summary>
+/// 用户注册参数
+/// </summary>
+/// <param name="Id">用户 id</param>
+/// <param name="Password">密码</param>
+/// <param name="UserName">用户名</param>
+/// <param name="Email">邮箱</param>
+/// <param name="Mobile">联系电话</param>
+public record UserParameter(string Id, string Password, string UserName, string? Email, string? Mobile) : UpdateParameter(UserName, Email, Mobile);
+
+/// <summary>
+/// 用户修改参数
+/// </summary>
+/// <param name="UserName">用户名</param>
+/// <param name="Email">邮箱</param>
+/// <param name="Mobile">联系电话</param>
+public record UpdateParameter(string UserName, string? Email, string? Mobile);

Server/Data/FlowerDatabase.cs

@@ -3,13 +3,37 @@ using Microsoft.EntityFrameworkCore;
 
 namespace Blahblah.FlowerStory.Server.Data;
 
+/// <summary>
+/// 数据库管理类
+/// </summary>
 public class FlowerDatabase : DbContext
 {
-    public FlowerDatabase(DbContextOptions<FlowerDatabase> options) : base(options) { }
+    /// <summary>
+    /// 构造数据库对象
+    /// </summary>
+    /// <param name="options">选项参数</param>
+    public FlowerDatabase(DbContextOptions<FlowerDatabase> options) : base(options)
+    {
+        //Database.Migrate();
+    }
 
+    /// <summary>
+    /// 用户集
+    /// </summary>
     public DbSet<UserItem> Users { get; set; }
 
+    /// <summary>
+    /// 花草集
+    /// </summary>
     public DbSet<FlowerItem> Flowers { get; set; }
 
+    /// <summary>
+    /// 记录集
+    /// </summary>
     public DbSet<RecordItem> Records { get; set; }
+
+    /// <summary>
+    /// 会话令牌集
+    /// </summary>
+    public DbSet<TokenItem> Tokens { get; set; }
 }

Server/Data/Model/FlowerItem.cs

@@ -1,32 +1,67 @@
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
+using System.Text.Json.Serialization;
 
 namespace Blahblah.FlowerStory.Server.Data.Model;
 
+/// <summary>
+/// 花草对象
+/// </summary>
 [Table("flowers")]
 public class FlowerItem
 {
-    [Column("fid"), Key, Required]
+    /// <summary>
+    /// 自增 id，主键
+    /// </summary>
+    [Column("fid")]
+    [Key]
+    [Required]
     public int Id { get; set; }
 
-    [Column("categoryid"), Required]
+    /// <summary>
+    /// 类别 id
+    /// </summary>
+    [Column("categoryid")]
+    [Required]
     public int CategoryId { get; set; }
 
-    [Column("name"), Required]
+    /// <summary>
+    /// 花草名称
+    /// </summary>
+    [Column("name")]
+    [Required]
     public required string Name { get; set; }
 
-    [Column("datebuy"), Required]
+    /// <summary>
+    /// 购买时间
+    /// </summary>
+    [Column("datebuy")]
+    [Required]
+    [JsonPropertyName("dateBuy")]
     public long DateBuyUnixTime { get; set; }
 
+    /// <summary>
+    /// 购买花费
+    /// </summary>
     [Column("cost", TypeName = "real")]
     public decimal? Cost { get; set; }
 
+    /// <summary>
+    /// 购买渠道
+    /// </summary>
     [Column("purchase")]
     public string? Purchase { get; set; }
 
+    /// <summary>
+    /// 购买照片
+    /// </summary>
     [Column("photo")]
     public byte[]? Photo { get; set; }
 
+    /// <summary>
+    /// 购买时间
+    /// </summary>
     [NotMapped]
+    [JsonIgnore]
     public DateTimeOffset DateBuy => DateTimeOffset.FromUnixTimeMilliseconds(DateBuyUnixTime);
 }

Server/Data/Model/RecordItem.cs

@@ -1,29 +1,60 @@
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
+using System.Text.Json.Serialization;
 
 namespace Blahblah.FlowerStory.Server.Data.Model;
 
+/// <summary>
+/// 记录对象
+/// </summary>
 [Table("records")]
 public class RecordItem
 {
-    [Column("rid"), Key, Required]
+    /// <summary>
+    /// 自增 id，主键
+    /// </summary>
+    [Column("rid")]
+    [Key]
+    [Required]
     public int Id { get; set; }
 
-    [Column("eid"), Required]
+    /// <summary>
+    /// 事件类型
+    /// </summary>
+    [Column("eid")]
+    [Required]
     public int EventId { get; set; }
 
-    [Column("date"), Required]
+    /// <summary>
+    /// 操作时间
+    /// </summary>
+    [Column("date")]
+    [Required]
+    [JsonPropertyName("date")]
     public long DateUnixTime { get; set; }
 
+    /// <summary>
+    /// 操作人 uid
+    /// </summary>
     [Column("byuid")]
     public int? ByUserId { get; set; }
 
+    /// <summary>
+    /// 操作人名称
+    /// </summary>
     [Column("byname")]
     public string? ByUserName { get; set; }
 
+    /// <summary>
+    /// 事件关联照片
+    /// </summary>
     [Column("photo")]
     public byte[]? Photo { get; set; }
 
+    /// <summary>
+    /// 操作时间
+    /// </summary>
     [NotMapped]
+    [JsonIgnore]
     public DateTimeOffset Date => DateTimeOffset.FromUnixTimeMilliseconds(DateUnixTime);
 }

Server/Data/Model/TokenItem.cs

@@ -0,0 +1,103 @@
+using System.ComponentModel.DataAnnotations;
+using System.ComponentModel.DataAnnotations.Schema;
+using System.Text.Json.Serialization;
+
+namespace Blahblah.FlowerStory.Server.Data.Model;
+
+/// <summary>
+/// 会话令牌对象
+/// </summary>
+[Table("tokens")]
+public class TokenItem
+{
+    /// <summary>
+    /// token 唯一 id
+    /// </summary>
+    [Column("tid")]
+    [Key]
+    [Required]
+    public required string Id { get; set; }
+
+    /// <summary>
+    /// 关联用户 uid
+    /// </summary>
+    [Column("uid")]
+    [Required]
+    public int UserId { get; set; }
+
+    /// <summary>
+    /// 登录时间
+    /// </summary>
+    [Column("logondate")]
+    [Required]
+    [JsonPropertyName("logonDate")]
+    public long LogonDateUnixTime { get; set; }
+
+    /// <summary>
+    /// 活动时间
+    /// </summary>
+    [Column("activedate")]
+    [Required]
+    [JsonPropertyName("activeDate")]
+    public long ActiveDateUnixTime { get; set; }
+
+    /// <summary>
+    /// 过期时间
+    /// </summary>
+    [Column("expiredate")]
+    [Required]
+    [JsonPropertyName("expireDate")]
+    public long ExpireDateUnixTime { get; set; }
+
+    /// <summary>
+    /// 过期秒数
+    /// </summary>
+    [Column("expiresecs")]
+    [Required]
+    public int ExpireSeconds { get; set; }
+
+    /// <summary>
+    /// 验证码
+    /// </summary>
+    [Column("verifycode")]
+    public string? VerifyCode { get; set; }
+
+    /// <summary>
+    /// 客户端类型
+    /// </summary>
+    [Column("clientapp")]
+    public string? ClientApp { get; set; }
+
+    /// <summary>
+    /// 客户端设备 id
+    /// </summary>
+    [Column("deviceid")]
+    public string? DeviceId { get; set; }
+
+    /// <summary>
+    /// 客户端代理标识
+    /// </summary>
+    [Column("clientagent")]
+    public string? ClientAgent { get; set; }
+
+    /// <summary>
+    /// 登录时间
+    /// </summary>
+    [NotMapped]
+    [JsonIgnore]
+    public DateTimeOffset LogonDate => DateTimeOffset.FromUnixTimeMilliseconds(LogonDateUnixTime);
+
+    /// <summary>
+    /// 活动时间
+    /// </summary>
+    [NotMapped]
+    [JsonIgnore]
+    public DateTimeOffset ActiveDate => DateTimeOffset.FromUnixTimeMilliseconds(ActiveDateUnixTime);
+
+    /// <summary>
+    /// 过期时间
+    /// </summary>
+    [NotMapped]
+    [JsonIgnore]
+    public DateTimeOffset ExpireDate => DateTimeOffset.FromUnixTimeMilliseconds(ExpireDateUnixTime);
+}

Server/Data/Model/UserItem.cs

@@ -1,32 +1,93 @@
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
+using System.Text.Json.Serialization;
 
 namespace Blahblah.FlowerStory.Server.Data.Model;
 
+/// <summary>
+/// 用户对象
+/// </summary>
 [Table("users")]
 public class UserItem
 {
-    [Column("uid"), Key, Required]
+    /// <summary>
+    /// 自增 id，主键
+    /// </summary>
+    [Column("uid")]
+    [Key]
+    [Required]
     public int Id { get; set; }
-    [Column("id"), Required]
+
+    /// <summary>
+    /// 用户 id
+    /// </summary>
+    [Column("id")]
+    [Required]
     public required string UserId { get; set; }
-    [Column("password"), Required]
-    public required string Password { get; set; }
-    [Column("level"), Required]
+
+    /// <summary>
+    /// 密码，值为 SHA256(password+id+salt)
+    /// </summary>
+    [Column("password")]
+    [Required]
+    [JsonIgnore]
+    public string? Password { get; set; }
+
+    /// <summary>
+    /// 用户级别
+    ///   -1: Disabled
+    ///    0: Common
+    ///   99: Admin
+    /// </summary>
+    [Column("level")]
+    [Required]
     public int Level { get; set; }
-    [Column("regdate"), Required]
+
+    /// <summary>
+    /// 注册时间
+    /// </summary>
+    [Column("regdate")]
+    [Required]
+    [JsonPropertyName("registerDate")]
     public long RegisterDateUnixTime { get; set; }
+
+    /// <summary>
+    /// 最后变动时间
+    /// </summary>
     [Column("activedate")]
+    [JsonIgnore]
     public long? ActiveDateUnixTime { get; set; }
-    [Column("name"), Required]
+
+    /// <summary>
+    /// 用户名
+    /// </summary>
+    [Column("name")]
+    [Required]
     public required string Name { get; set; }
+
+    /// <summary>
+    /// 邮箱
+    /// </summary>
     [Column("email")]
     public string? Email { get; set; }
+
+    /// <summary>
+    /// 联系电话
+    /// </summary>
     [Column("mobile")]
     public string? Mobile { get; set; }
 
+    /// <summary>
+    /// 注册时间
+    /// </summary>
     [NotMapped]
+    [JsonIgnore]
     public DateTimeOffset RegisterDate => DateTimeOffset.FromUnixTimeMilliseconds(RegisterDateUnixTime);
+
+    /// <summary>
+    /// 最后变动时间
+    /// </summary>
     [NotMapped]
+    [JsonIgnore]
     public DateTimeOffset? ActiveDate => ActiveDateUnixTime == null ? null : DateTimeOffset.FromUnixTimeMilliseconds(ActiveDateUnixTime.Value);
 }

Server/Dockerfile

@@ -0,0 +1,8 @@
+#See https://aka.ms/containerfastmode to understand how Visual Studio uses this Dockerfile to build your images for faster debugging.
+
+FROM mcr.microsoft.com/dotnet/aspnet:7.0
+COPY . /app
+WORKDIR /app
+EXPOSE 80
+
+ENTRYPOINT ["dotnet", "Server.dll"]

Server/Migrations/20230523031232_AddTokens.Designer.cs

@@ -0,0 +1,191 @@
+// <auto-generated />
+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("20230523031232_AddTokens")]
+    partial class AddTokens
+    {
+        /// <inheritdoc />
+        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<int>("Id")
+                        .ValueGeneratedOnAdd()
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("fid");
+
+                    b.Property<int>("CategoryId")
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("categoryid");
+
+                    b.Property<decimal?>("Cost")
+                        .HasColumnType("real")
+                        .HasColumnName("cost");
+
+                    b.Property<long>("DateBuyUnixTime")
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("datebuy")
+                        .HasAnnotation("Relational:JsonPropertyName", "dateBuy");
+
+                    b.Property<string>("Name")
+                        .IsRequired()
+                        .HasColumnType("TEXT")
+                        .HasColumnName("name");
+
+                    b.Property<byte[]>("Photo")
+                        .HasColumnType("BLOB")
+                        .HasColumnName("photo");
+
+                    b.Property<string>("Purchase")
+                        .HasColumnType("TEXT")
+                        .HasColumnName("purchase");
+
+                    b.HasKey("Id");
+
+                    b.ToTable("flowers");
+                });
+
+            modelBuilder.Entity("Blahblah.FlowerStory.Server.Data.Model.RecordItem", b =>
+                {
+                    b.Property<int>("Id")
+                        .ValueGeneratedOnAdd()
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("rid");
+
+                    b.Property<int?>("ByUserId")
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("byuid");
+
+                    b.Property<string>("ByUserName")
+                        .HasColumnType("TEXT")
+                        .HasColumnName("byname");
+
+                    b.Property<long>("DateUnixTime")
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("date")
+                        .HasAnnotation("Relational:JsonPropertyName", "date");
+
+                    b.Property<int>("EventId")
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("eid");
+
+                    b.Property<byte[]>("Photo")
+                        .HasColumnType("BLOB")
+                        .HasColumnName("photo");
+
+                    b.HasKey("Id");
+
+                    b.ToTable("records");
+                });
+
+            modelBuilder.Entity("Blahblah.FlowerStory.Server.Data.Model.TokenItem", b =>
+                {
+                    b.Property<string>("Id")
+                        .HasColumnType("TEXT")
+                        .HasColumnName("tid");
+
+                    b.Property<long>("ActiveDateUnixTime")
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("activedate");
+
+                    b.Property<string>("ClientAgent")
+                        .HasColumnType("TEXT")
+                        .HasColumnName("clientagent");
+
+                    b.Property<string>("ClientApp")
+                        .HasColumnType("TEXT")
+                        .HasColumnName("clientapp");
+
+                    b.Property<string>("DeviceId")
+                        .HasColumnType("TEXT")
+                        .HasColumnName("deviceid");
+
+                    b.Property<long>("ExpireDateUnixTime")
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("expiredate");
+
+                    b.Property<int>("ExpireSeconds")
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("expiresecs");
+
+                    b.Property<long>("LogonDateUnixTime")
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("logondate");
+
+                    b.Property<int>("UserId")
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("uid");
+
+                    b.Property<string>("VerifyCode")
+                        .HasColumnType("TEXT")
+                        .HasColumnName("verifycode");
+
+                    b.HasKey("Id");
+
+                    b.ToTable("tokens");
+                });
+
+            modelBuilder.Entity("Blahblah.FlowerStory.Server.Data.Model.UserItem", b =>
+                {
+                    b.Property<int>("Id")
+                        .ValueGeneratedOnAdd()
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("uid");
+
+                    b.Property<long?>("ActiveDateUnixTime")
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("activedate");
+
+                    b.Property<string>("Email")
+                        .HasColumnType("TEXT")
+                        .HasColumnName("email");
+
+                    b.Property<int>("Level")
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("level");
+
+                    b.Property<string>("Mobile")
+                        .HasColumnType("TEXT")
+                        .HasColumnName("mobile");
+
+                    b.Property<string>("Name")
+                        .IsRequired()
+                        .HasColumnType("TEXT")
+                        .HasColumnName("name");
+
+                    b.Property<string>("Password")
+                        .IsRequired()
+                        .HasColumnType("TEXT")
+                        .HasColumnName("password");
+
+                    b.Property<long>("RegisterDateUnixTime")
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("regdate")
+                        .HasAnnotation("Relational:JsonPropertyName", "registerDate");
+
+                    b.Property<string>("UserId")
+                        .IsRequired()
+                        .HasColumnType("TEXT")
+                        .HasColumnName("id");
+
+                    b.HasKey("Id");
+
+                    b.ToTable("users");
+                });
+#pragma warning restore 612, 618
+        }
+    }
+}

Server/Migrations/20230523031232_AddTokens.cs

@@ -0,0 +1,41 @@
+using Microsoft.EntityFrameworkCore.Migrations;
+
+#nullable disable
+
+namespace Blahblah.FlowerStory.Server.Migrations
+{
+    /// <inheritdoc />
+    public partial class AddTokens : Migration
+    {
+        /// <inheritdoc />
+        protected override void Up(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.CreateTable(
+                name: "tokens",
+                columns: table => new
+                {
+                    tid = table.Column<string>(type: "TEXT", nullable: false),
+                    uid = table.Column<int>(type: "INTEGER", nullable: false),
+                    logondate = table.Column<long>(type: "INTEGER", nullable: false),
+                    activedate = table.Column<long>(type: "INTEGER", nullable: false),
+                    expiredate = table.Column<long>(type: "INTEGER", nullable: false),
+                    expiresecs = table.Column<int>(type: "INTEGER", nullable: false),
+                    verifycode = table.Column<string>(type: "TEXT", nullable: true),
+                    clientapp = table.Column<string>(type: "TEXT", nullable: true),
+                    deviceid = table.Column<string>(type: "TEXT", nullable: true),
+                    clientagent = table.Column<string>(type: "TEXT", nullable: true)
+                },
+                constraints: table =>
+                {
+                    table.PrimaryKey("PK_tokens", x => x.tid);
+                });
+        }
+
+        /// <inheritdoc />
+        protected override void Down(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.DropTable(
+                name: "tokens");
+        }
+    }
+}

Server/Migrations/FlowerDatabaseModelSnapshot.cs

@@ -34,7 +34,8 @@ namespace Blahblah.FlowerStory.Server.Migrations
 
                     b.Property<long>("DateBuyUnixTime")
                         .HasColumnType("INTEGER")
-                        .HasColumnName("datebuy");
+                        .HasColumnName("datebuy")
+                        .HasAnnotation("Relational:JsonPropertyName", "dateBuy");
 
                     b.Property<string>("Name")
                         .IsRequired()
@@ -71,7 +72,8 @@ namespace Blahblah.FlowerStory.Server.Migrations
 
                     b.Property<long>("DateUnixTime")
                         .HasColumnType("INTEGER")
-                        .HasColumnName("date");
+                        .HasColumnName("date")
+                        .HasAnnotation("Relational:JsonPropertyName", "date");
 
                     b.Property<int>("EventId")
                         .HasColumnType("INTEGER")
@@ -86,6 +88,53 @@ namespace Blahblah.FlowerStory.Server.Migrations
                     b.ToTable("records");
                 });
 
+            modelBuilder.Entity("Blahblah.FlowerStory.Server.Data.Model.TokenItem", b =>
+                {
+                    b.Property<string>("Id")
+                        .HasColumnType("TEXT")
+                        .HasColumnName("tid");
+
+                    b.Property<long>("ActiveDateUnixTime")
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("activedate");
+
+                    b.Property<string>("ClientAgent")
+                        .HasColumnType("TEXT")
+                        .HasColumnName("clientagent");
+
+                    b.Property<string>("ClientApp")
+                        .HasColumnType("TEXT")
+                        .HasColumnName("clientapp");
+
+                    b.Property<string>("DeviceId")
+                        .HasColumnType("TEXT")
+                        .HasColumnName("deviceid");
+
+                    b.Property<long>("ExpireDateUnixTime")
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("expiredate");
+
+                    b.Property<int>("ExpireSeconds")
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("expiresecs");
+
+                    b.Property<long>("LogonDateUnixTime")
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("logondate");
+
+                    b.Property<int>("UserId")
+                        .HasColumnType("INTEGER")
+                        .HasColumnName("uid");
+
+                    b.Property<string>("VerifyCode")
+                        .HasColumnType("TEXT")
+                        .HasColumnName("verifycode");
+
+                    b.HasKey("Id");
+
+                    b.ToTable("tokens");
+                });
+
             modelBuilder.Entity("Blahblah.FlowerStory.Server.Data.Model.UserItem", b =>
                 {
                     b.Property<int>("Id")
@@ -121,7 +170,8 @@ namespace Blahblah.FlowerStory.Server.Migrations
 
                     b.Property<long>("RegisterDateUnixTime")
                         .HasColumnType("INTEGER")
-                        .HasColumnName("regdate");
+                        .HasColumnName("regdate")
+                        .HasAnnotation("Relational:JsonPropertyName", "registerDate");
 
                     b.Property<string>("UserId")
                         .IsRequired()

Server/Program.cs

@@ -1,11 +1,19 @@
-using Blahblah.FlowerStory.Server.Controller;
 using Blahblah.FlowerStory.Server.Data;
 using Microsoft.EntityFrameworkCore;
+using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
 
 namespace Blahblah.FlowerStory.Server;
 
+/// <inheritdoc/>
 public class Program
 {
+    /// <inheritdoc/>
+    public const string ProjectName = "Flower Story";
+    /// <inheritdoc/>
+    public const string Version = "0.23.523";
+
+    /// <inheritdoc/>
     public static void Main(string[] args)
     {
         var builder = WebApplication.CreateBuilder(args);
@@ -15,17 +23,32 @@ public class Program
 
         // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
         builder.Services.AddEndpointsApiExplorer();
-        builder.Services.AddSwaggerGen();
+        builder.Services.AddSwaggerGen(options =>
+        {
+            options.OperationFilter<SwaggerHttpHeaderOperation>();
+
+            options.SwaggerDoc(Version, new OpenApiInfo
+            {
+                Title = ProjectName,
+                Version = Version,
+                Description = "<p>花事记录，贴心的帮您记录花园中的点点滴滴。</p><p><b>API 文档</b></p>"
+            });
+
+            options.IncludeXmlComments(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Server.xml"));
+        });
 
         builder.Services.AddDbContext<FlowerDatabase>(options => options.UseSqlite("DataSource=flower.db;Cache=Shared"));
 
         var app = builder.Build();
 
         // Configure the HTTP request pipeline.
-        if (app.Environment.IsDevelopment())
+        //if (app.Environment.IsDevelopment())
         {
             app.UseSwagger();
-            app.UseSwaggerUI();
+            app.UseSwaggerUI(options =>
+            {
+                options.SwaggerEndpoint($"/swagger/{Version}/swagger.json", ProjectName);
+            });
         }
 
         app.UseAuthorization();
@@ -33,4 +56,20 @@ public class Program
 
         app.Run();
     }
+}
+
+/// <inheritdoc/>
+public class SwaggerHttpHeaderOperation : IOperationFilter
+{
+    /// <inheritdoc/>
+    public void Apply(OpenApiOperation operation, OperationFilterContext context)
+    {
+        operation.Parameters.Add(new OpenApiParameter
+        {
+            Name = "X-Auth",
+            In = ParameterLocation.Header,
+            Required = false,
+            Schema = new OpenApiSchema { Type = "string" }
+        });
+    }
 }

Server/Server.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk.Web">
+<Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
     <TargetFramework>net7.0</TargetFramework>
@@ -6,6 +6,8 @@
     <ImplicitUsings>enable</ImplicitUsings>
     <RootNamespace>Blahblah.FlowerStory.Server</RootNamespace>
     <UseAppHost>false</UseAppHost>
+    <GenerateDocumentationFile>True</GenerateDocumentationFile>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
@@ -19,9 +21,16 @@
   </ItemGroup>
 
   <ItemGroup>
+    <None Update="Dockerfile">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Update="flower.db">
       <CopyToOutputDirectory>Never</CopyToOutputDirectory>
     </None>
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="..\Doc\README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
 </Project>

Server/WeatherForecast.cs

@@ -1,12 +0,0 @@
-namespace Blahblah.FlowerStory.Server;
-
-public class WeatherForecast
-{
-    public DateOnly Date { get; set; }
-
-    public int TemperatureC { get; set; }
-
-    public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
-
-    public string? Summary { get; set; }
-}