Files
cloudpods/pkg/keystone/models/projects.go
Qiu Jian e1f35f67e7 fix: deprecate old user/group joint project API, create new action apis
for add user/group to projects with roles
2019-08-17 18:44:33 +08:00

515 lines
16 KiB
Go

// Copyright 2019 Yunion
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package models
import (
"context"
"database/sql"
"fmt"
"strings"
"time"
"yunion.io/x/jsonutils"
"yunion.io/x/log"
"yunion.io/x/pkg/errors"
"yunion.io/x/pkg/tristate"
"yunion.io/x/sqlchemy"
api "yunion.io/x/onecloud/pkg/apis/identity"
"yunion.io/x/onecloud/pkg/cloudcommon/db"
"yunion.io/x/onecloud/pkg/httperrors"
"yunion.io/x/onecloud/pkg/keystone/options"
"yunion.io/x/onecloud/pkg/mcclient"
"yunion.io/x/onecloud/pkg/util/pinyinutils"
)
type SProjectManager struct {
SIdentityBaseResourceManager
}
var ProjectManager *SProjectManager
func init() {
ProjectManager = &SProjectManager{
SIdentityBaseResourceManager: NewIdentityBaseResourceManager(
SProject{},
"project",
"project",
"projects",
),
}
ProjectManager.SetVirtualObject(ProjectManager)
}
/*
+-------------+-------------+------+-----+---------+-------+
| Field | Type | Null | Key | Default | Extra |
+-------------+-------------+------+-----+---------+-------+
| id | varchar(64) | NO | PRI | NULL | |
| name | varchar(64) | NO | | NULL | |
| extra | text | YES | | NULL | |
| description | text | YES | | NULL | |
| enabled | tinyint(1) | YES | | NULL | |
| domain_id | varchar(64) | NO | MUL | NULL | |
| parent_id | varchar(64) | YES | MUL | NULL | |
| is_domain | tinyint(1) | NO | | 0 | |
| created_at | datetime | YES | | NULL | |
+-------------+-------------+------+-----+---------+-------+
*/
type SProject struct {
SIdentityBaseResource
ParentId string `width:"64" charset:"ascii" list:"domain" create:"domain_optional"`
IsDomain tristate.TriState `default:"false" nullable:"false" create:"domain_optional"`
}
func (manager *SProjectManager) GetContextManagers() [][]db.IModelManager {
return [][]db.IModelManager{
{UserManager},
{GroupManager},
}
}
func (manager *SProjectManager) InitializeData() error {
return manager.initSysProject()
}
func (manager *SProjectManager) initSysProject() error {
q := manager.Query().Equals("name", api.SystemAdminProject)
q = q.Equals("domain_id", api.DEFAULT_DOMAIN_ID)
cnt, err := q.CountWithError()
if err != nil {
return errors.Wrap(err, "query")
}
if cnt == 1 {
return nil
}
if cnt > 2 {
// ???
log.Fatalf("duplicate system project???")
}
// insert
project := SProject{}
project.Name = api.SystemAdminProject
project.DomainId = api.DEFAULT_DOMAIN_ID
// project.Enabled = tristate.True
project.Description = "Boostrap system default admin project"
project.IsDomain = tristate.False
project.ParentId = api.DEFAULT_DOMAIN_ID
project.SetModelManager(manager, &project)
err = manager.TableSpec().Insert(&project)
if err != nil {
return errors.Wrap(err, "insert")
}
return nil
}
func (manager *SProjectManager) Query(fields ...string) *sqlchemy.SQuery {
return manager.SIdentityBaseResourceManager.Query(fields...).IsFalse("is_domain")
}
func (manager *SProjectManager) FetchProjectByName(projectName string, domainId, domainName string) (*SProject, error) {
obj, err := db.NewModelObject(manager)
if err != nil {
return nil, errors.Wrap(err, "db.NewModelObject")
}
if len(domainId) == 0 && len(domainName) == 0 {
q := manager.Query().Equals("name", projectName)
cnt, err := q.CountWithError()
if err != nil {
return nil, errors.Wrap(err, "CountWithError")
}
if cnt == 0 {
return nil, sql.ErrNoRows
}
if cnt > 1 {
return nil, sqlchemy.ErrDuplicateEntry
}
err = q.First(obj)
if err != nil {
return nil, errors.Wrap(err, "q.First")
}
} else {
domain, err := DomainManager.FetchDomain(domainId, domainName)
if err != nil {
return nil, errors.Wrap(err, "DomainManager.FetchDomain")
}
q := manager.Query().Equals("name", projectName).Equals("domain_id", domain.Id)
err = q.First(obj)
if err != nil {
return nil, errors.Wrap(err, "q.First")
}
}
return obj.(*SProject), nil
}
func (manager *SProjectManager) FetchProjectById(projectId string) (*SProject, error) {
obj, err := db.NewModelObject(manager)
if err != nil {
return nil, err
}
q := manager.Query().Equals("id", projectId)
err = q.First(obj)
if err != nil {
return nil, err
}
return obj.(*SProject), err
}
func (manager *SProjectManager) FetchProject(projectId, projectName string, domainId, domainName string) (*SProject, error) {
if len(projectId) > 0 {
return manager.FetchProjectById(projectId)
}
if len(projectName) > 0 {
return manager.FetchProjectByName(projectName, domainId, domainName)
}
return nil, fmt.Errorf("no project Id or name provided")
}
type SProjectExtended struct {
SProject
DomainName string
}
func (proj *SProject) getDomain() (*SDomain, error) {
return DomainManager.FetchDomainById(proj.DomainId)
}
func (proj *SProject) FetchExtend() (*SProjectExtended, error) {
domain, err := proj.getDomain()
if err != nil {
return nil, err
}
ext := SProjectExtended{
SProject: *proj,
DomainName: domain.Name,
}
return &ext, nil
}
func (manager *SProjectManager) ListItemFilter(ctx context.Context, q *sqlchemy.SQuery, userCred mcclient.TokenCredential, query jsonutils.JSONObject) (*sqlchemy.SQuery, error) {
q, err := manager.SIdentityBaseResourceManager.ListItemFilter(ctx, q, userCred, query)
if err != nil {
return nil, err
}
userStr := jsonutils.GetAnyString(query, []string{"user_id"})
if len(userStr) > 0 {
userObj, err := UserManager.FetchById(userStr)
if err != nil {
if err == sql.ErrNoRows {
return nil, httperrors.NewResourceNotFoundError2(UserManager.Keyword(), userStr)
} else {
return nil, httperrors.NewGeneralError(err)
}
}
subq := AssignmentManager.fetchUserProjectIdsQuery(userObj.GetId())
q = q.In("id", subq.SubQuery())
}
groupStr := jsonutils.GetAnyString(query, []string{"group_id"})
if len(groupStr) > 0 {
groupObj, err := GroupManager.FetchById(groupStr)
if err != nil {
if err == sql.ErrNoRows {
return nil, httperrors.NewResourceNotFoundError2(GroupManager.Keyword(), groupStr)
} else {
return nil, httperrors.NewGeneralError(err)
}
}
subq := AssignmentManager.fetchGroupProjectIdsQuery(groupObj.GetId())
q = q.In("id", subq.SubQuery())
}
return q, nil
}
func (model *SProject) CustomizeCreate(ctx context.Context, userCred mcclient.TokenCredential, ownerId mcclient.IIdentityProvider, query jsonutils.JSONObject, data jsonutils.JSONObject) error {
model.ParentId = ownerId.GetProjectDomainId()
model.IsDomain = tristate.False
return model.SIdentityBaseResource.CustomizeCreate(ctx, userCred, ownerId, query, data)
}
func (proj *SProject) GetUserCount() (int, error) {
q := AssignmentManager.fetchProjectUserIdsQuery(proj.Id)
return q.CountWithError()
}
func (proj *SProject) GetGroupCount() (int, error) {
q := AssignmentManager.fetchProjectGroupIdsQuery(proj.Id)
return q.CountWithError()
}
func (proj *SProject) ValidateDeleteCondition(ctx context.Context) error {
if proj.IsAdminProject() {
return httperrors.NewForbiddenError("cannot delete system project")
}
external, _, _ := proj.getExternalResources()
if len(external) > 0 {
return httperrors.NewNotEmptyError("project contains external resources")
}
usrCnt, _ := proj.GetUserCount()
if usrCnt > 0 {
return httperrors.NewNotEmptyError("project contains user")
}
grpCnt, _ := proj.GetGroupCount()
if grpCnt > 0 {
return httperrors.NewNotEmptyError("project contains group")
}
return proj.SIdentityBaseResource.ValidateDeleteCondition(ctx)
}
func (proj *SProject) IsAdminProject() bool {
return proj.Name == api.SystemAdminProject && proj.DomainId == api.DEFAULT_DOMAIN_ID
}
func (proj *SProject) ValidateUpdateData(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data *jsonutils.JSONDict) (*jsonutils.JSONDict, error) {
if data.Contains("name") {
if proj.IsAdminProject() {
return nil, httperrors.NewForbiddenError("cannot alter system project name")
}
}
return proj.SIdentityBaseResource.ValidateUpdateData(ctx, userCred, query, data)
}
func (proj *SProject) GetCustomizeColumns(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject) *jsonutils.JSONDict {
extra := proj.SIdentityBaseResource.GetCustomizeColumns(ctx, userCred, query)
return projectExtra(proj, extra)
}
func (proj *SProject) GetExtraDetails(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject) (*jsonutils.JSONDict, error) {
extra, err := proj.SIdentityBaseResource.GetExtraDetails(ctx, userCred, query)
if err != nil {
return nil, err
}
return projectExtra(proj, extra), nil
}
func projectExtra(proj *SProject, extra *jsonutils.JSONDict) *jsonutils.JSONDict {
grpCnt, _ := proj.GetGroupCount()
extra.Add(jsonutils.NewInt(int64(grpCnt)), "group_count")
usrCnt, _ := proj.GetUserCount()
extra.Add(jsonutils.NewInt(int64(usrCnt)), "user_count")
external, update, _ := proj.getExternalResources()
if len(external) > 0 {
extra.Add(jsonutils.Marshal(external), "ext_resources")
extra.Add(jsonutils.NewTimeString(update), "ext_resources_last_update")
if update.IsZero() {
update = time.Now()
}
nextUpdate := update.Add(time.Duration(options.Options.FetchProjectResourceCountIntervalSeconds) * time.Second)
extra.Add(jsonutils.NewTimeString(nextUpdate), "ext_resources_next_update")
}
return extra
}
func (proj *SProject) getExternalResources() (map[string]int, time.Time, error) {
return ProjectResourceManager.getProjectResource(proj.Id)
}
func NormalizeProjectName(name string) string {
name = pinyinutils.Text2Pinyin(name)
for _, illChar := range []string{
"/", ".", " ",
} {
name = strings.Replace(name, illChar, "", -1)
}
return name
}
func (manager *SProjectManager) FetchUserProjects(userId string) ([]SProjectExtended, error) {
projects := manager.Query().SubQuery()
domains := DomainManager.Query().SubQuery()
q := projects.Query(
projects.Field("id"),
projects.Field("name"),
projects.Field("domain_id"),
domains.Field("name").Label("domain_name"),
)
q = q.Join(domains, sqlchemy.Equals(projects.Field("domain_id"), domains.Field("id")))
subq := AssignmentManager.fetchUserProjectIdsQuery(userId)
q = q.Filter(sqlchemy.In(projects.Field("id"), subq))
ret := make([]SProjectExtended, 0)
err := q.All(&ret)
if err != nil && err != sql.ErrNoRows {
return nil, errors.Wrap(err, "query.All")
}
return ret, nil
}
func (manager *SProjectManager) ValidateCreateData(ctx context.Context, userCred mcclient.TokenCredential, ownerId mcclient.IIdentityProvider, query jsonutils.JSONObject, data *jsonutils.JSONDict) (*jsonutils.JSONDict, error) {
err := db.ValidateCreateDomainId(ownerId.GetProjectDomainId())
if err != nil {
return nil, err
}
return manager.SIdentityBaseResourceManager.ValidateCreateData(ctx, userCred, ownerId, query, data)
}
func (project *SProject) AllowPerformJoin(ctx context.Context,
userCred mcclient.TokenCredential,
query jsonutils.JSONObject,
data jsonutils.JSONObject,
) bool {
return db.IsAdminAllowPerform(userCred, project, "join")
}
func (project *SProject) PerformJoin(
ctx context.Context,
userCred mcclient.TokenCredential,
query jsonutils.JSONObject,
data jsonutils.JSONObject,
) (jsonutils.JSONObject, error) {
input := api.SProjectAddUserGroupInput{}
err := data.Unmarshal(&input)
if err != nil {
return nil, httperrors.NewInputParameterError("unmarshal project add user group input error %s", err)
}
err = input.Validate()
if err != nil {
return nil, httperrors.NewInputParameterError(err.Error())
}
roles := make([]*SRole, 0)
for i := range input.Roles {
obj, err := RoleManager.FetchByIdOrName(userCred, input.Roles[i])
if err != nil {
if err == sql.ErrNoRows {
return nil, httperrors.NewResourceNotFoundError2(RoleManager.Keyword(), input.Roles[i])
} else {
return nil, httperrors.NewGeneralError(err)
}
}
roles = append(roles, obj.(*SRole))
}
users := make([]*SUser, 0)
for i := range input.Users {
obj, err := UserManager.FetchByIdOrName(userCred, input.Users[i])
if err != nil {
if err == sql.ErrNoRows {
return nil, httperrors.NewResourceNotFoundError2(UserManager.Keyword(), input.Users[i])
} else {
return nil, httperrors.NewGeneralError(err)
}
}
users = append(users, obj.(*SUser))
}
groups := make([]*SGroup, 0)
for i := range input.Groups {
obj, err := GroupManager.FetchByIdOrName(userCred, input.Groups[i])
if err != nil {
if err == sql.ErrNoRows {
return nil, httperrors.NewResourceNotFoundError2(GroupManager.Keyword(), input.Groups[i])
} else {
return nil, httperrors.NewGeneralError(err)
}
}
groups = append(groups, obj.(*SGroup))
}
for i := range users {
for j := range roles {
err = AssignmentManager.projectAddUser(ctx, userCred, project, users[i], roles[j])
if err != nil {
return nil, httperrors.NewGeneralError(err)
}
}
}
for i := range groups {
for j := range roles {
err = AssignmentManager.projectAddGroup(ctx, userCred, project, groups[i], roles[j])
if err != nil {
return nil, httperrors.NewGeneralError(err)
}
}
}
return nil, nil
}
func (project *SProject) AllowPerformLeave(ctx context.Context,
userCred mcclient.TokenCredential,
query jsonutils.JSONObject,
data jsonutils.JSONObject,
) bool {
return db.IsAdminAllowPerform(userCred, project, "leave")
}
func (project *SProject) PerformLeave(
ctx context.Context,
userCred mcclient.TokenCredential,
query jsonutils.JSONObject,
data jsonutils.JSONObject,
) (jsonutils.JSONObject, error) {
input := api.SProjectRemoveUserGroupInput{}
err := data.Unmarshal(&input)
if err != nil {
return nil, httperrors.NewInputParameterError("unmarshal project remove usergroup input error %s", err)
}
err = input.Validate()
if err != nil {
return nil, httperrors.NewInputParameterError(err.Error())
}
for i := range input.UserRoles {
userObj, err := UserManager.FetchByIdOrName(userCred, input.UserRoles[i].User)
if err != nil {
if err == sql.ErrNoRows {
return nil, httperrors.NewResourceNotFoundError2(UserManager.Keyword(), input.UserRoles[i].User)
} else {
return nil, httperrors.NewGeneralError(err)
}
}
roleObj, err := RoleManager.FetchByIdOrName(userCred, input.UserRoles[i].Role)
if err != nil {
if err == sql.ErrNoRows {
return nil, httperrors.NewResourceNotFoundError2(RoleManager.Keyword(), input.UserRoles[i].Role)
} else {
return nil, httperrors.NewGeneralError(err)
}
}
err = AssignmentManager.projectRemoveUser(ctx, userCred, project, userObj.(*SUser), roleObj.(*SRole))
if err != nil {
return nil, httperrors.NewGeneralError(err)
}
}
for i := range input.GroupRoles {
groupObj, err := GroupManager.FetchByIdOrName(userCred, input.GroupRoles[i].Group)
if err != nil {
if err == sql.ErrNoRows {
return nil, httperrors.NewResourceNotFoundError2(GroupManager.Keyword(), input.GroupRoles[i].Group)
} else {
return nil, httperrors.NewGeneralError(err)
}
}
roleObj, err := RoleManager.FetchByIdOrName(userCred, input.GroupRoles[i].Role)
if err != nil {
if err == sql.ErrNoRows {
return nil, httperrors.NewResourceNotFoundError2(RoleManager.Keyword(), input.GroupRoles[i].Role)
} else {
return nil, httperrors.NewGeneralError(err)
}
}
err = AssignmentManager.projectRemoveGroup(ctx, userCred, project, groupObj.(*SGroup), roleObj.(*SRole))
if err != nil {
return nil, httperrors.NewGeneralError(err)
}
}
return nil, nil
}