mirror of
https://github.com/go-admin-team/go-admin.git
synced 2026-10-13 08:56:52 +00:00
zhangwenjian
c0ca07c95b
The package, table and business names a table's configuration carries become directories and file names, and nothing on the server checked them; the config page's patterns were the only check. Each is now checked against what it becomes: a package name is lowercase letters and digits, a table name letters, digits and underscores, a business name an identifier starting with a lowercase letter. None allows a dot or a separator, and none is stricter than the config page. The check runs on import, where a list holding one bad name is refused whole, on save, and again before generating, so a configuration saved before this check existed is refused rather than trusted.
438 lines
13 KiB
Go
438 lines
13 KiB
Go
package tools
|
|
|
|
import (
|
|
"errors"
|
|
"strings"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
_ "github.com/go-admin-team/go-admin-core/v2/response"
|
|
"github.com/go-admin-team/go-admin-core/v2/sdk/api"
|
|
"github.com/go-admin-team/go-admin-core/v2/sdk/pkg"
|
|
"gorm.io/gorm"
|
|
|
|
"go-admin/app/other/models/tools"
|
|
)
|
|
|
|
type SysTable struct {
|
|
api.Api
|
|
}
|
|
|
|
// GetPage 分页列表数据
|
|
// @Summary 分页列表数据
|
|
// @Description 生成表分页列表
|
|
// @Tags 工具 / 生成工具
|
|
// @Param tableName query string false "tableName / 数据表名称"
|
|
// @Param pageSize query int false "pageSize / 页条数"
|
|
// @Param pageIndex query int false "pageIndex / 页码"
|
|
// @Success 200 {object} response.Response "{"code": 200, "data": [...]}"
|
|
// @Router /api/v1/sys/tables/page [get]
|
|
func (e SysTable) GetPage(c *gin.Context) {
|
|
e.Context = c
|
|
log := e.GetLogger()
|
|
var data tools.SysTables
|
|
var err error
|
|
var pageSize = 10
|
|
var pageIndex = 1
|
|
|
|
if size := c.Request.FormValue("pageSize"); size != "" {
|
|
pageSize, err = pkg.StringToInt(size)
|
|
}
|
|
|
|
if index := c.Request.FormValue("pageIndex"); index != "" {
|
|
pageIndex, err = pkg.StringToInt(index)
|
|
}
|
|
|
|
db, err := e.GetOrm()
|
|
if err != nil {
|
|
log.Errorf("get db connection error, %s", err.Error())
|
|
e.Error(500, err, "数据库连接获取失败")
|
|
return
|
|
}
|
|
|
|
data.TBName = c.Request.FormValue("tableName")
|
|
data.TableComment = c.Request.FormValue("tableComment")
|
|
result, count, err := data.GetPage(db, pageSize, pageIndex)
|
|
if err != nil {
|
|
log.Errorf("GetPage error, %s", err.Error())
|
|
e.Error(500, err, "")
|
|
return
|
|
}
|
|
e.PageOK(result, count, pageIndex, pageSize, "查询成功")
|
|
}
|
|
|
|
// Get
|
|
// @Summary 获取配置
|
|
// @Description 获取JSON
|
|
// @Tags 工具 / 生成工具
|
|
// @Param configKey path int true "configKey"
|
|
// @Success 200 {object} response.Response "{"code": 200, "data": [...]}"
|
|
// @Router /api/v1/sys/tables/info/{tableId} [get]
|
|
// @Security Bearer
|
|
func (e SysTable) Get(c *gin.Context) {
|
|
e.Context = c
|
|
log := e.GetLogger()
|
|
db, err := e.GetOrm()
|
|
if err != nil {
|
|
log.Errorf("get db connection error, %s", err.Error())
|
|
e.Error(500, err, "数据库连接获取失败")
|
|
return
|
|
}
|
|
|
|
var data tools.SysTables
|
|
data.TableId, _ = pkg.StringToInt(c.Param("tableId"))
|
|
result, err := data.Get(db, true)
|
|
if err != nil {
|
|
log.Errorf("Get error, %s", err.Error())
|
|
e.Error(500, err, "")
|
|
return
|
|
}
|
|
|
|
mp := make(map[string]interface{})
|
|
mp["list"] = result.Columns
|
|
mp["info"] = result
|
|
e.OK(mp, "")
|
|
}
|
|
|
|
func (e SysTable) GetSysTablesInfo(c *gin.Context) {
|
|
e.Context = c
|
|
log := e.GetLogger()
|
|
db, err := e.GetOrm()
|
|
if err != nil {
|
|
log.Errorf("get db connection error, %s", err.Error())
|
|
e.Error(500, err, "数据库连接获取失败")
|
|
return
|
|
}
|
|
|
|
var data tools.SysTables
|
|
if c.Request.FormValue("tableName") != "" {
|
|
data.TBName = c.Request.FormValue("tableName")
|
|
}
|
|
result, err := data.Get(db, true)
|
|
if err != nil {
|
|
log.Errorf("Get error, %s", err.Error())
|
|
e.Error(500, err, "抱歉未找到相关信息")
|
|
return
|
|
}
|
|
|
|
mp := make(map[string]interface{})
|
|
mp["list"] = result.Columns
|
|
mp["info"] = result
|
|
e.OK(mp, "")
|
|
//res.Data = mp
|
|
//c.JSON(http.StatusOK, res.ReturnOK())
|
|
}
|
|
|
|
func (e SysTable) GetSysTablesTree(c *gin.Context) {
|
|
e.Context = c
|
|
log := e.GetLogger()
|
|
db, err := e.GetOrm()
|
|
if err != nil {
|
|
log.Errorf("get db connection error, %s", err.Error())
|
|
e.Error(500, err, "数据库连接获取失败")
|
|
return
|
|
}
|
|
|
|
var data tools.SysTables
|
|
result, err := data.GetTree(db)
|
|
if err != nil {
|
|
log.Errorf("GetTree error, %s", err.Error())
|
|
e.Error(500, err, "抱歉未找到相关信息")
|
|
return
|
|
}
|
|
|
|
e.OK(result, "")
|
|
}
|
|
|
|
// Insert
|
|
// @Summary 添加表结构
|
|
// @Description 添加表结构
|
|
// @Tags 工具 / 生成工具
|
|
// @Accept application/json
|
|
// @Product application/json
|
|
// @Param tables query string false "tableName / 数据表名称，逗号分隔"
|
|
// @Param data body object false "tables / 同上，query 未带时从 JSON body 读"
|
|
// @Success 200 {string} string "{"code": 200, "message": "添加成功"}"
|
|
// @Success 200 {string} string "{"code": -1, "message": "添加失败"}"
|
|
// @Router /api/v1/sys/tables/info [post]
|
|
// @Security Bearer
|
|
func (e SysTable) Insert(c *gin.Context) {
|
|
e.Context = c
|
|
log := e.GetLogger()
|
|
db, err := e.GetOrm()
|
|
if err != nil {
|
|
log.Errorf("get db connection error, %s", err.Error())
|
|
e.Error(500, err, "数据库连接获取失败")
|
|
return
|
|
}
|
|
|
|
tablesList, err := tablesToImport(c)
|
|
if err != nil {
|
|
log.Errorf("read the table list, %s", err.Error())
|
|
e.Error(500, err, "")
|
|
return
|
|
}
|
|
|
|
// Every table is read and checked before any is saved, so a list with
|
|
// one table whose name cannot become a file name is refused whole
|
|
// instead of importing the tables ahead of it.
|
|
tables := make([]tools.SysTables, 0, len(tablesList))
|
|
for i := 0; i < len(tablesList); i++ {
|
|
data, err := genTableInit(db, tablesList, i, c)
|
|
if err != nil {
|
|
log.Errorf("genTableInit error, %s", err.Error())
|
|
e.Error(500, err, "")
|
|
return
|
|
}
|
|
if err = validateGenPathFields(data); err != nil {
|
|
log.Errorf("validate table error, %s", err.Error())
|
|
e.Error(500, err, err.Error())
|
|
return
|
|
}
|
|
tables = append(tables, data)
|
|
}
|
|
for i := range tables {
|
|
if _, err = tables[i].Create(db); err != nil {
|
|
log.Errorf("Create error, %s", err.Error())
|
|
e.Error(500, err, "")
|
|
return
|
|
}
|
|
}
|
|
e.OK(nil, "添加成功")
|
|
|
|
}
|
|
|
|
// tablesToImport reads the comma-separated table list carried by an import
|
|
// request, from the query string or from a JSON body.
|
|
//
|
|
// The list has only ever travelled in the query string, which is the single
|
|
// place FormValue looks once the request declares itself as JSON. A front end
|
|
// that puts it in the body instead therefore left this empty, and the import
|
|
// went on to ask information_schema for a table named "" -- go-admin-ui v3.2.0
|
|
// shipped exactly that, and every import failed with the message below.
|
|
// Reading the body when the query has nothing keeps either front end working.
|
|
func tablesToImport(c *gin.Context) ([]string, error) {
|
|
raw := c.Request.FormValue("tables")
|
|
if raw == "" {
|
|
var body struct {
|
|
Tables string `json:"tables"`
|
|
}
|
|
// A body that is absent, or shaped some other way, is not itself worth
|
|
// reporting: the list is missing either way, and the message below says
|
|
// so in the terms the caller asked in.
|
|
if err := c.ShouldBindJSON(&body); err == nil {
|
|
raw = body.Tables
|
|
}
|
|
}
|
|
|
|
parts := strings.Split(raw, ",")
|
|
names := make([]string, 0, len(parts))
|
|
for _, name := range parts {
|
|
// Splitting "" yields one empty name rather than nothing at all, so
|
|
// without this an empty list reads as a request to import one table
|
|
// whose name happens to be blank.
|
|
if name = strings.TrimSpace(name); name != "" {
|
|
names = append(names, name)
|
|
}
|
|
}
|
|
if len(names) == 0 {
|
|
return nil, errors.New(emptyTableNameMsg)
|
|
}
|
|
return names, nil
|
|
}
|
|
|
|
func genTableInit(tx *gorm.DB, tablesList []string, i int, c *gin.Context) (tools.SysTables, error) {
|
|
var data tools.SysTables
|
|
var dbTable tools.DBTables
|
|
var dbColumn tools.DBColumns
|
|
data.TBName = tablesList[i]
|
|
data.CreateBy = 0
|
|
|
|
dbTable.TableName = data.TBName
|
|
dbtable, err := dbTable.Get(tx)
|
|
if err != nil {
|
|
return data, err
|
|
}
|
|
|
|
dbColumn.TableName = data.TBName
|
|
tablenamelist := strings.Split(dbColumn.TableName, "_")
|
|
for i := 0; i < len(tablenamelist); i++ {
|
|
strStart := string([]byte(tablenamelist[i])[:1])
|
|
strend := string([]byte(tablenamelist[i])[1:])
|
|
// 大驼峰表名 结构体使用
|
|
data.ClassName += strings.ToUpper(strStart) + strend
|
|
// 小驼峰表名 js函数名和权限标识使用
|
|
if i == 0 {
|
|
data.BusinessName += strings.ToLower(strStart) + strend
|
|
} else {
|
|
data.BusinessName += strings.ToUpper(strStart) + strend
|
|
}
|
|
//data.PackageName += strings.ToLower(strStart) + strings.ToLower(strend)
|
|
//data.ModuleName += strings.ToLower(strStart) + strings.ToLower(strend)
|
|
}
|
|
//data.ModuleFrontName = strings.ReplaceAll(data.ModuleName, "_", "-")
|
|
data.PackageName = "admin"
|
|
data.TplCategory = "crud"
|
|
data.Crud = true
|
|
// 中横线表名称，接口路径、前端文件夹名称和js名称使用
|
|
data.ModuleName = strings.Replace(data.TBName, "_", "-", -1)
|
|
dbcolumn, err := dbColumn.GetList(tx)
|
|
data.CreateBy = 0
|
|
data.TableComment = dbtable.TableComment
|
|
if dbtable.TableComment == "" {
|
|
data.TableComment = data.ClassName
|
|
}
|
|
|
|
data.FunctionName = data.TableComment
|
|
//data.BusinessName = data.ModuleName
|
|
data.IsLogicalDelete = "1"
|
|
data.LogicalDelete = true
|
|
data.LogicalDeleteColumn = "is_del"
|
|
data.IsActions = 2
|
|
data.IsDataScope = 1
|
|
data.IsAuth = 1
|
|
|
|
data.FunctionAuthor = "wenjianzhang"
|
|
for i := 0; i < len(dbcolumn); i++ {
|
|
var column tools.SysColumns
|
|
column.ColumnComment = dbcolumn[i].ColumnComment
|
|
column.ColumnName = dbcolumn[i].ColumnName
|
|
column.ColumnType = dbcolumn[i].ColumnType
|
|
column.Sort = i + 1
|
|
column.Insert = true
|
|
column.IsInsert = "1"
|
|
column.QueryType = "EQ"
|
|
column.IsPk = "0"
|
|
|
|
namelist := strings.Split(dbcolumn[i].ColumnName, "_")
|
|
for i := 0; i < len(namelist); i++ {
|
|
strStart := string([]byte(namelist[i])[:1])
|
|
strend := string([]byte(namelist[i])[1:])
|
|
column.GoField += strings.ToUpper(strStart) + strend
|
|
if i == 0 {
|
|
column.JsonField = strings.ToLower(strStart) + strend
|
|
} else {
|
|
column.JsonField += strings.ToUpper(strStart) + strend
|
|
}
|
|
}
|
|
if strings.Contains(dbcolumn[i].ColumnKey, "PR") {
|
|
column.IsPk = "1"
|
|
column.Pk = true
|
|
data.PkColumn = dbcolumn[i].ColumnName
|
|
//column.GoField = strings.ToUpper(column.GoField)
|
|
//column.JsonField = strings.ToUpper(column.JsonField)
|
|
data.PkGoField = column.GoField
|
|
data.PkJsonField = column.JsonField
|
|
}
|
|
column.IsRequired = "0"
|
|
if strings.Contains(dbcolumn[i].IsNullable, "NO") {
|
|
column.IsRequired = "1"
|
|
column.Required = true
|
|
}
|
|
|
|
if strings.Contains(dbcolumn[i].ColumnType, "int") {
|
|
if strings.Contains(dbcolumn[i].ColumnKey, "PR") {
|
|
column.GoType = "int"
|
|
} else {
|
|
column.GoType = "string"
|
|
}
|
|
column.HtmlType = "input"
|
|
} else if strings.Contains(dbcolumn[i].ColumnType, "timestamp") {
|
|
column.GoType = "time.Time"
|
|
column.HtmlType = "datetime"
|
|
} else if strings.Contains(dbcolumn[i].ColumnType, "datetime") {
|
|
column.GoType = "time.Time"
|
|
column.HtmlType = "datetime"
|
|
} else {
|
|
column.GoType = "string"
|
|
column.HtmlType = "input"
|
|
}
|
|
|
|
data.Columns = append(data.Columns, column)
|
|
}
|
|
return data, err
|
|
}
|
|
|
|
// Update
|
|
// @Summary 修改表结构
|
|
// @Description 修改表结构
|
|
// @Tags 工具 / 生成工具
|
|
// @Accept application/json
|
|
// @Product application/json
|
|
// @Param data body tools.SysTables true "body"
|
|
// @Success 200 {string} string "{"code": 200, "message": "添加成功"}"
|
|
// @Success 200 {string} string "{"code": -1, "message": "添加失败"}"
|
|
// @Router /api/v1/sys/tables/info [put]
|
|
// @Security Bearer
|
|
func (e SysTable) Update(c *gin.Context) {
|
|
var data tools.SysTables
|
|
err := c.Bind(&data)
|
|
pkg.HasError(err, "数据解析失败", 500)
|
|
|
|
e.Context = c
|
|
log := e.GetLogger()
|
|
db, err := e.GetOrm()
|
|
if err != nil {
|
|
log.Errorf("get db connection error, %s", err.Error())
|
|
e.Error(500, err, "数据库连接获取失败")
|
|
return
|
|
}
|
|
|
|
// PRD 010 F10: this bind-and-save path has no field-level validation of
|
|
// its own (API契约.md §1.2/§2.1, D6) - see sys_tables_validate.go for
|
|
// what each check guards and why colWidth is sanitized in place rather
|
|
// than rejected.
|
|
if err = validateAndSanitizeColumns(data.Columns); err != nil {
|
|
log.Errorf("validate columns error, %s", err.Error())
|
|
e.Error(500, err, err.Error())
|
|
return
|
|
}
|
|
if err = validateGenPathFields(data); err != nil {
|
|
log.Errorf("validate table error, %s", err.Error())
|
|
e.Error(500, err, err.Error())
|
|
return
|
|
}
|
|
if err = validateBusinessNameUnique(db, data.PackageName, data.BusinessName, data.TableId); err != nil {
|
|
log.Errorf("validate businessName error, %s", err.Error())
|
|
e.Error(500, err, err.Error())
|
|
return
|
|
}
|
|
|
|
data.UpdateBy = 0
|
|
result, err := data.Update(db)
|
|
if err != nil {
|
|
log.Errorf("Update error, %s", err.Error())
|
|
e.Error(500, err, "")
|
|
return
|
|
}
|
|
e.OK(result, "修改成功")
|
|
}
|
|
|
|
// Delete
|
|
// @Summary 删除表结构
|
|
// @Description 删除表结构
|
|
// @Tags 工具 / 生成工具
|
|
// @Param tableId path int true "tableId"
|
|
// @Success 200 {string} string "{"code": 200, "message": "删除成功"}"
|
|
// @Success 200 {string} string "{"code": -1, "message": "删除失败"}"
|
|
// @Router /api/v1/sys/tables/info/{tableId} [delete]
|
|
func (e SysTable) Delete(c *gin.Context) {
|
|
e.Context = c
|
|
log := e.GetLogger()
|
|
db, err := e.GetOrm()
|
|
if err != nil {
|
|
log.Errorf("get db connection error, %s", err.Error())
|
|
e.Error(500, err, "数据库连接获取失败")
|
|
return
|
|
}
|
|
|
|
var data tools.SysTables
|
|
IDS := pkg.IdsStrToIdsIntGroup("tableId", c)
|
|
_, err = data.BatchDelete(db, IDS)
|
|
if err != nil {
|
|
log.Errorf("BatchDelete error, %s", err.Error())
|
|
e.Error(500, err, "删除失败")
|
|
return
|
|
}
|
|
e.OK(nil, "删除成功")
|
|
}
|