fix: Fix issue where website group can still be deleted even if it contains other websites (#8049)

Author: zhengkunwang223

agent/app/api/v2/entry.go

@@ -67,4 +67,5 @@ var (
 
 	websiteCAService = service.NewIWebsiteCAService()
 	taskService      = service.NewITaskService()
+	groupService     = service.NewIGroupService()
 )

agent/app/api/v2/group.go

@@ -0,0 +1,96 @@
+package v2
+
+import (
+	"github.com/1Panel-dev/1Panel/agent/app/api/v2/helper"
+	"github.com/1Panel-dev/1Panel/agent/app/dto"
+	"github.com/gin-gonic/gin"
+)
+
+// @Tags System Group
+// @Summary Create group
+// @Accept json
+// @Param request body dto.GroupCreate true "request"
+// @Success 200
+// @Security ApiKeyAuth
+// @Security Timestamp
+// @Router /agent/groups [post]
+// @x-panel-log {"bodyKeys":["name","type"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建组 [name][type]","formatEN":"create group [name][type]"}
+func (b *BaseApi) CreateGroup(c *gin.Context) {
+	var req dto.GroupCreate
+	if err := helper.CheckBindAndValidate(&req, c); err != nil {
+		return
+	}
+
+	if err := groupService.Create(req); err != nil {
+		helper.InternalServer(c, err)
+		return
+	}
+	helper.SuccessWithOutData(c)
+}
+
+// @Tags System Group
+// @Summary Delete group
+// @Accept json
+// @Param request body dto.OperateByID true "request"
+// @Success 200
+// @Security ApiKeyAuth
+// @Security Timestamp
+// @Router /agent/groups/del [post]
+// @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"groups","output_column":"name","output_value":"name"},{"input_column":"id","input_value":"id","isList":false,"db":"groups","output_column":"type","output_value":"type"}],"formatZH":"删除组 [type][name]","formatEN":"delete group [type][name]"}
+func (b *BaseApi) DeleteGroup(c *gin.Context) {
+	var req dto.OperateByID
+	if err := helper.CheckBindAndValidate(&req, c); err != nil {
+		return
+	}
+
+	if err := groupService.Delete(req.ID); err != nil {
+		helper.InternalServer(c, err)
+		return
+	}
+	helper.SuccessWithOutData(c)
+}
+
+// @Tags System Group
+// @Summary Update group
+// @Accept json
+// @Param request body dto.GroupUpdate true "request"
+// @Success 200
+// @Security ApiKeyAuth
+// @Security Timestamp
+// @Router /agent/groups/update [post]
+// @x-panel-log {"bodyKeys":["name","type"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新组 [name][type]","formatEN":"update group [name][type]"}
+func (b *BaseApi) UpdateGroup(c *gin.Context) {
+	var req dto.GroupUpdate
+	if err := helper.CheckBindAndValidate(&req, c); err != nil {
+		return
+	}
+
+	if err := groupService.Update(req); err != nil {
+		helper.InternalServer(c, err)
+		return
+	}
+	helper.SuccessWithOutData(c)
+}
+
+// @Tags System Group
+// @Summary List groups
+// @Accept json
+// @Param request body dto.GroupSearch true "request"
+// @Success 200 {array} dto.OperateByType
+// @Security ApiKeyAuth
+// @Security Timestamp
+// @Router /agent/groups/search [post]
+func (b *BaseApi) ListGroup(c *gin.Context) {
+	var req dto.OperateByType
+	if err := helper.CheckBindAndValidate(&req, c); err != nil {
+		return
+	}
+
+	list, err := groupService.List(req)
+	if err != nil {
+		helper.InternalServer(c, err)
+		return
+	}
+
+	helper.SuccessWithData(c, list)
+}

agent/app/dto/group.go

@@ -0,0 +1,29 @@
+package dto
+
+type GroupCreate struct {
+	ID   uint   `json:"id"`
+	Name string `json:"name" validate:"required"`
+	Type string `json:"type" validate:"required"`
+}
+
+type GroupSearch struct {
+	Type string `json:"type" validate:"required"`
+}
+
+type GroupUpdate struct {
+	ID        uint   `json:"id"`
+	Name      string `json:"name"`
+	Type      string `json:"type" validate:"required"`
+	IsDefault bool   `json:"isDefault"`
+}
+
+type GroupInfo struct {
+	ID        uint   `json:"id"`
+	Name      string `json:"name"`
+	Type      string `json:"type"`
+	IsDefault bool   `json:"isDefault"`
+}
+
+type OperateByType struct {
+	Type string `json:"type"`
+}

agent/app/model/group.go

@@ -0,0 +1,8 @@
+package model
+
+type Group struct {
+	BaseModel
+	IsDefault bool   `json:"isDefault"`
+	Name      string `json:"name"`
+	Type      string `json:"type"`
+}

agent/app/repo/group.go

@@ -0,0 +1,56 @@
+package repo
+
+import (
+	"github.com/1Panel-dev/1Panel/agent/app/model"
+	"github.com/1Panel-dev/1Panel/agent/global"
+)
+
+type GroupRepo struct{}
+
+type IGroupRepo interface {
+	Get(opts ...DBOption) (model.Group, error)
+	GetList(opts ...DBOption) ([]model.Group, error)
+	Create(group *model.Group) error
+	Update(id uint, vars map[string]interface{}) error
+	Delete(opts ...DBOption) error
+}
+
+func NewIGroupRepo() IGroupRepo {
+	return &GroupRepo{}
+}
+
+func (g *GroupRepo) Get(opts ...DBOption) (model.Group, error) {
+	var group model.Group
+	db := global.DB
+	for _, opt := range opts {
+		db = opt(db)
+	}
+	err := db.First(&group).Error
+	return group, err
+}
+
+func (g *GroupRepo) GetList(opts ...DBOption) ([]model.Group, error) {
+	var groups []model.Group
+	db := global.DB.Model(&model.Group{})
+	for _, opt := range opts {
+		db = opt(db)
+	}
+	err := db.Find(&groups).Error
+	return groups, err
+}
+
+func (g *GroupRepo) Create(group *model.Group) error {
+	return global.DB.Create(group).Error
+}
+
+func (g *GroupRepo) Update(id uint, vars map[string]interface{}) error {
+	return global.DB.Model(&model.Group{}).Where("id = ?", id).Updates(vars).Error
+}
+
+func (g *GroupRepo) Delete(opts ...DBOption) error {
+	db := global.DB
+	for _, opt := range opts {
+		db = opt(db)
+	}
+	return db.Delete(&model.Group{}).Error
+}

agent/app/service/entry.go

@@ -45,4 +45,6 @@ var (
 	favoriteRepo = repo.NewIFavoriteRepo()
 
 	taskRepo = repo.NewITaskRepo()
+
+	groupRepo = repo.NewIGroupRepo()
 )

agent/app/service/group.go

@@ -0,0 +1,87 @@
+package service
+
+import (
+	"github.com/1Panel-dev/1Panel/agent/app/dto"
+	"github.com/1Panel-dev/1Panel/agent/app/model"
+	"github.com/1Panel-dev/1Panel/agent/app/repo"
+	"github.com/1Panel-dev/1Panel/agent/buserr"
+	"github.com/jinzhu/copier"
+)
+
+type GroupService struct{}
+
+type IGroupService interface {
+	List(req dto.OperateByType) ([]dto.GroupInfo, error)
+	Create(req dto.GroupCreate) error
+	Update(req dto.GroupUpdate) error
+	Delete(id uint) error
+}
+
+func NewIGroupService() IGroupService {
+	return &GroupService{}
+}
+
+func (u *GroupService) List(req dto.OperateByType) ([]dto.GroupInfo, error) {
+	options := []repo.DBOption{
+		repo.WithOrderBy("is_default desc"),
+		repo.WithOrderBy("created_at desc"),
+	}
+	if len(req.Type) != 0 {
+		options = append(options, repo.WithByType(req.Type))
+	}
+	var (
+		groups []model.Group
+		err    error
+	)
+	groups, err = groupRepo.GetList(options...)
+	if err != nil {
+		return nil, buserr.New("ErrRecordNotFound")
+	}
+	var dtoUsers []dto.GroupInfo
+	for _, group := range groups {
+		var item dto.GroupInfo
+		if err := copier.Copy(&item, &group); err != nil {
+			return nil, buserr.WithDetail("ErrStructTransform", err.Error(), nil)
+		}
+		dtoUsers = append(dtoUsers, item)
+	}
+	return dtoUsers, err
+}
+
+func (u *GroupService) Create(req dto.GroupCreate) error {
+	group, _ := groupRepo.Get(repo.WithByName(req.Name), repo.WithByType(req.Type))
+	if group.ID != 0 {
+		return buserr.New("ErrRecordExist")
+	}
+	if err := copier.Copy(&group, &req); err != nil {
+		return buserr.WithDetail("ErrStructTransform", err.Error(), nil)
+	}
+	if err := groupRepo.Create(&group); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (u *GroupService) Delete(id uint) error {
+	group, _ := groupRepo.Get(repo.WithByID(id))
+	if group.ID == 0 {
+		return buserr.New("ErrRecordNotFound")
+	}
+	if group.IsDefault {
+		return buserr.New("ErrGroupIsDefault")
+	}
+	if group.Type == "website" {
+		websites, _ := websiteRepo.List(websiteRepo.WithGroupID(group.ID))
+		if len(websites) > 0 {
+			return buserr.New("ErrGroupIsInWebsiteUse")
+		}
+	}
+	return groupRepo.Delete(repo.WithByID(id))
+}
+
+func (u *GroupService) Update(req dto.GroupUpdate) error {
+	upMap := make(map[string]interface{})
+	upMap["name"] = req.Name
+	upMap["is_default"] = req.IsDefault
+	return groupRepo.Update(req.ID, upMap)
+}

agent/i18n/lang/en.yaml

@@ -19,6 +19,8 @@ ErrTypePort: "Port {{ .name }} format error"
 Success: "Success"
 Failed: "Failed"
 SystemRestart: "System restart causes task interruption"
+ErrGroupIsDefault: "Default group, cannot be deleted"
+ErrGroupIsInWebsiteUse: "Group is being used by other websites, cannot be deleted"
 
 #backup
 ErrBackupLocalDelete: "Deleting local server backup accounts is not currently supported."

agent/i18n/lang/ja.yaml

@@ -28,6 +28,8 @@ ErrTypePortRange: 'ポートレンジは1-65535の間である必要がありま
 Success: "成功"
 Failed: "失敗した"
 SystemRestart: "システムの再起動により、タスクが中断されます"
+ErrGroupIsDefault: "デフォルトグループ、削除できません"
+ErrGroupIsInWebsiteUse: "グループは他のウェブサイトで使用されています、削除できません"
 
 #app
 ErrPortInUsed: "{{.Detail}}ポートはすでに使用されています"

agent/i18n/lang/ko.yaml

@@ -29,6 +29,8 @@ ErrTypePortRange: '포트 범위는 1-65535 사이여야 합니다'
 Success: "성공"
 Failed: "실패"
 SystemRestart: "시스템 재시작으로 인해 작업이 중단되었습니다"
+ErrGroupIsDefault: "기본 그룹, 삭제할 수 없습니다"
+ErrGroupIsInWebsiteUse: "그룹이 다른 웹사이트에서 사용 중입니다, 삭제할 수 없습니다"
 
 # 애플리케이션
 ErrPortInUsed: "{{ .detail }} 포트가 이미 사용 중입니다"