forgejo/models/org.go

605 lines
15 KiB
Go
Raw Normal View History

2014-06-25 04:44:48 +00:00
// Copyright 2014 The Gogs Authors. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
package models
2014-06-27 07:37:01 +00:00
import (
2014-07-02 20:42:16 +00:00
"errors"
"fmt"
2014-07-05 02:43:39 +00:00
"os"
2014-06-27 07:37:01 +00:00
"strings"
2016-11-11 17:31:37 +00:00
"github.com/go-xorm/builder"
"github.com/go-xorm/xorm"
2014-06-27 07:37:01 +00:00
)
2014-07-02 20:42:16 +00:00
var (
2016-11-26 00:20:18 +00:00
// ErrOrgNotExist organization does not exist
ErrOrgNotExist = errors.New("Organization does not exist")
// ErrTeamNotExist team does not exist
ErrTeamNotExist = errors.New("Team does not exist")
2014-07-02 20:42:16 +00:00
)
// IsOwnedBy returns true if given user is in the owner team.
func (org *User) IsOwnedBy(uid int64) bool {
2016-07-23 17:08:22 +00:00
return IsOrganizationOwner(org.ID, uid)
2014-06-29 20:30:41 +00:00
}
// IsOrgMember returns true if given user is member of organization.
func (org *User) IsOrgMember(uid int64) bool {
2016-07-23 17:08:22 +00:00
return org.IsOrganization() && IsOrganizationMember(org.ID, uid)
2014-06-29 20:30:41 +00:00
}
2015-02-13 05:58:46 +00:00
func (org *User) getTeam(e Engine, name string) (*Team, error) {
2016-07-23 17:08:22 +00:00
return getTeam(e, org.ID, name)
2015-02-13 05:58:46 +00:00
}
// GetTeam returns named team of organization.
func (org *User) GetTeam(name string) (*Team, error) {
2015-02-13 05:58:46 +00:00
return org.getTeam(x, name)
}
func (org *User) getOwnerTeam(e Engine) (*Team, error) {
2016-11-28 01:30:08 +00:00
return org.getTeam(e, ownerTeamName)
}
2014-06-28 04:40:07 +00:00
// GetOwnerTeam returns owner team of organization.
func (org *User) GetOwnerTeam() (*Team, error) {
2015-02-13 05:58:46 +00:00
return org.getOwnerTeam(x)
}
func (org *User) getTeams(e Engine) error {
2016-11-10 15:16:32 +00:00
return e.
Where("org_id=?", org.ID).
2016-11-28 01:30:08 +00:00
OrderBy("CASE WHEN name LIKE '" + ownerTeamName + "' THEN '' ELSE name END").
2016-11-10 15:16:32 +00:00
Find(&org.Teams)
2014-06-28 04:40:07 +00:00
}
2014-06-28 19:43:25 +00:00
// GetTeams returns all teams that belong to organization.
func (org *User) GetTeams() error {
2015-02-13 05:58:46 +00:00
return org.getTeams(x)
2014-06-28 19:43:25 +00:00
}
// GetMembers returns all members of organization.
func (org *User) GetMembers() error {
2016-07-23 17:08:22 +00:00
ous, err := GetOrgUsersByOrgID(org.ID)
2014-06-28 19:43:25 +00:00
if err != nil {
return err
}
var ids = make([]int64, len(ous))
2014-06-28 19:43:25 +00:00
for i, ou := range ous {
2016-11-26 00:20:18 +00:00
ids[i] = ou.UID
2014-06-28 19:43:25 +00:00
}
org.Members, err = GetUsersByIDs(ids)
return err
2014-06-28 19:43:25 +00:00
}
// AddMember adds new member to organization.
func (org *User) AddMember(uid int64) error {
2016-07-23 17:08:22 +00:00
return AddOrgUser(org.ID, uid)
}
// RemoveMember removes member from organization.
func (org *User) RemoveMember(uid int64) error {
2016-07-23 17:08:22 +00:00
return RemoveOrgUser(org.ID, uid)
}
func (org *User) removeOrgRepo(e Engine, repoID int64) error {
2016-07-23 17:08:22 +00:00
return removeOrgRepo(e, org.ID, repoID)
}
// RemoveOrgRepo removes all team-repository relations of organization.
func (org *User) RemoveOrgRepo(repoID int64) error {
return org.removeOrgRepo(x, repoID)
}
2014-06-27 07:37:01 +00:00
// CreateOrganization creates record of a new organization.
func CreateOrganization(org, owner *User) (err error) {
if !owner.CanCreateOrganization() {
return ErrUserNotAllowedCreateOrg{}
}
if err = IsUsableUsername(org.Name); err != nil {
return err
2014-06-27 07:37:01 +00:00
}
isExist, err := IsUserExist(0, org.Name)
2014-06-27 07:37:01 +00:00
if err != nil {
return err
2014-06-27 07:37:01 +00:00
} else if isExist {
return ErrUserAlreadyExist{org.Name}
2014-06-27 07:37:01 +00:00
}
org.LowerName = strings.ToLower(org.Name)
if org.Rands, err = GetUserSalt(); err != nil {
return err
}
if org.Salt, err = GetUserSalt(); err != nil {
return err
}
org.UseCustomAvatar = true
org.MaxRepoCreation = -1
2014-06-27 07:37:01 +00:00
org.NumTeams = 1
org.NumMembers = 1
sess := x.NewSession()
defer sessionRelease(sess)
2014-06-27 07:37:01 +00:00
if err = sess.Begin(); err != nil {
return err
2014-06-27 07:37:01 +00:00
}
if _, err = sess.Insert(org); err != nil {
return fmt.Errorf("insert organization: %v", err)
2014-07-05 02:43:39 +00:00
}
org.GenerateRandomAvatar()
// Add initial creator to organization and owner team.
if _, err = sess.Insert(&OrgUser{
2016-11-26 00:20:18 +00:00
UID: owner.ID,
2016-07-23 17:08:22 +00:00
OrgID: org.ID,
IsOwner: true,
NumTeams: 1,
}); err != nil {
return fmt.Errorf("insert org-user relation: %v", err)
}
2014-07-05 02:43:39 +00:00
2014-06-27 07:37:01 +00:00
// Create default owner team.
t := &Team{
2016-07-23 17:08:22 +00:00
OrgID: org.ID,
2016-11-28 01:30:08 +00:00
LowerName: strings.ToLower(ownerTeamName),
Name: ownerTeamName,
2016-11-07 16:20:37 +00:00
Authorize: AccessModeOwner,
2014-06-27 07:37:01 +00:00
NumMembers: 1,
}
if _, err = sess.Insert(t); err != nil {
return fmt.Errorf("insert owner team: %v", err)
2014-06-27 07:37:01 +00:00
}
if _, err = sess.Insert(&TeamUser{
2016-11-28 01:30:08 +00:00
UID: owner.ID,
2016-07-23 17:08:22 +00:00
OrgID: org.ID,
TeamID: t.ID,
}); err != nil {
return fmt.Errorf("insert team-user relation: %v", err)
}
if err = os.MkdirAll(UserPath(org.Name), os.ModePerm); err != nil {
return fmt.Errorf("create directory: %v", err)
2014-06-27 07:37:01 +00:00
}
return sess.Commit()
2014-06-27 07:37:01 +00:00
}
// GetOrgByName returns organization by given name.
func GetOrgByName(name string) (*User, error) {
if len(name) == 0 {
return nil, ErrOrgNotExist
}
u := &User{
LowerName: strings.ToLower(name),
2016-11-07 16:53:22 +00:00
Type: UserTypeOrganization,
}
has, err := x.Get(u)
if err != nil {
return nil, err
} else if !has {
return nil, ErrOrgNotExist
}
return u, nil
}
2014-08-28 14:29:00 +00:00
// CountOrganizations returns number of organizations.
func CountOrganizations() int64 {
2016-11-10 15:16:32 +00:00
count, _ := x.
Where("type=1").
Count(new(User))
2014-08-28 14:29:00 +00:00
return count
}
2015-09-25 17:54:52 +00:00
// Organizations returns number of organizations in given page.
func Organizations(opts *SearchUserOptions) ([]*User, error) {
orgs := make([]*User, 0, opts.PageSize)
if len(opts.OrderBy) == 0 {
opts.OrderBy = "name ASC"
}
sess := x.
Limit(opts.PageSize, (opts.Page-1)*opts.PageSize).
Where("type=1")
return orgs, sess.
OrderBy(opts.OrderBy).
2016-11-10 15:16:32 +00:00
Find(&orgs)
2014-08-29 12:50:43 +00:00
}
2014-06-28 04:40:07 +00:00
// DeleteOrganization completely and permanently deletes everything of organization.
func DeleteOrganization(org *User) (err error) {
sess := x.NewSession()
defer sess.Close()
2014-06-28 04:40:07 +00:00
if err = sess.Begin(); err != nil {
return err
}
2015-09-06 12:54:08 +00:00
if err = deleteBeans(sess,
2016-07-23 17:08:22 +00:00
&Team{OrgID: org.ID},
&OrgUser{OrgID: org.ID},
&TeamUser{OrgID: org.ID},
2015-09-06 12:54:08 +00:00
); err != nil {
return fmt.Errorf("deleteBeans: %v", err)
2014-06-28 04:40:07 +00:00
}
2015-09-06 12:54:08 +00:00
if err = deleteUser(sess, org); err != nil {
return fmt.Errorf("deleteUser: %v", err)
2014-06-28 04:40:07 +00:00
}
2015-09-06 12:54:08 +00:00
if err = sess.Commit(); err != nil {
return err
}
return RewriteAllPublicKeys()
2014-06-28 04:40:07 +00:00
}
2014-06-25 04:44:48 +00:00
// ________ ____ ___
// \_____ \_______ ____ | | \______ ___________
// / | \_ __ \/ ___\| | / ___// __ \_ __ \
// / | \ | \/ /_/ > | /\___ \\ ___/| | \/
// \_______ /__| \___ /|______//____ >\___ >__|
// \/ /_____/ \/ \/
// OrgUser represents an organization-user relation.
type OrgUser struct {
ID int64 `xorm:"pk autoincr"`
2016-11-26 00:20:18 +00:00
UID int64 `xorm:"INDEX UNIQUE(s)"`
OrgID int64 `xorm:"INDEX UNIQUE(s)"`
2017-01-06 15:14:33 +00:00
IsPublic bool `xorm:"INDEX"`
2014-06-25 04:44:48 +00:00
IsOwner bool
NumTeams int
2014-06-25 04:44:48 +00:00
}
2014-06-29 20:30:41 +00:00
// IsOrganizationOwner returns true if given user is in the owner team.
2016-11-26 00:20:18 +00:00
func IsOrganizationOwner(orgID, uid int64) bool {
2016-11-10 15:16:32 +00:00
has, _ := x.
Where("is_owner=?", true).
And("uid=?", uid).
2016-11-26 00:20:18 +00:00
And("org_id=?", orgID).
2016-11-10 15:16:32 +00:00
Get(new(OrgUser))
2014-06-29 20:30:41 +00:00
return has
}
// IsOrganizationMember returns true if given user is member of organization.
2016-11-26 00:20:18 +00:00
func IsOrganizationMember(orgID, uid int64) bool {
2016-11-10 15:16:32 +00:00
has, _ := x.
Where("uid=?", uid).
2016-11-26 00:20:18 +00:00
And("org_id=?", orgID).
2016-11-10 15:16:32 +00:00
Get(new(OrgUser))
2014-06-29 20:30:41 +00:00
return has
}
2014-12-07 01:22:48 +00:00
// IsPublicMembership returns true if given user public his/her membership.
2016-11-26 00:20:18 +00:00
func IsPublicMembership(orgID, uid int64) bool {
2016-11-10 15:16:32 +00:00
has, _ := x.
Where("uid=?", uid).
2016-11-26 00:20:18 +00:00
And("org_id=?", orgID).
2016-11-10 15:16:32 +00:00
And("is_public=?", true).
Get(new(OrgUser))
return has
}
func getOrgsByUserID(sess *xorm.Session, userID int64, showAll bool) ([]*User, error) {
orgs := make([]*User, 0, 10)
if !showAll {
sess.And("`org_user`.is_public=?", true)
}
return orgs, sess.
And("`org_user`.uid=?", userID).
Join("INNER", "`org_user`", "`org_user`.org_id=`user`.id").
Asc("`user`.name").
Find(&orgs)
}
2016-02-15 01:36:03 +00:00
// GetOrgsByUserID returns a list of organizations that the given user ID
// has joined.
func GetOrgsByUserID(userID int64, showAll bool) ([]*User, error) {
return getOrgsByUserID(x.NewSession(), userID, showAll)
}
2016-02-15 01:36:03 +00:00
// GetOrgsByUserIDDesc returns a list of organizations that the given user ID
// has joined, ordered descending by the given condition.
func GetOrgsByUserIDDesc(userID int64, desc string, showAll bool) ([]*User, error) {
return getOrgsByUserID(x.NewSession().Desc(desc), userID, showAll)
}
func getOwnedOrgsByUserID(sess *xorm.Session, userID int64) ([]*User, error) {
orgs := make([]*User, 0, 10)
return orgs, sess.
Where("`org_user`.uid=?", userID).
And("`org_user`.is_owner=?", true).
Join("INNER", "`org_user`", "`org_user`.org_id=`user`.id").
Asc("`user`.name").
Find(&orgs)
}
// GetOwnedOrgsByUserID returns a list of organizations are owned by given user ID.
func GetOwnedOrgsByUserID(userID int64) ([]*User, error) {
sess := x.NewSession()
return getOwnedOrgsByUserID(sess, userID)
}
2016-11-26 00:20:18 +00:00
// GetOwnedOrgsByUserIDDesc returns a list of organizations are owned by
// given user ID, ordered descending by the given condition.
func GetOwnedOrgsByUserIDDesc(userID int64, desc string) ([]*User, error) {
sess := x.NewSession()
return getOwnedOrgsByUserID(sess.Desc(desc), userID)
}
2015-12-17 07:28:47 +00:00
// GetOrgUsersByUserID returns all organization-user relations by user ID.
func GetOrgUsersByUserID(uid int64, all bool) ([]*OrgUser, error) {
2014-06-25 04:44:48 +00:00
ous := make([]*OrgUser, 0, 10)
sess := x.
Join("LEFT", "user", "`org_user`.org_id=`user`.id").
Where("`org_user`.uid=?", uid)
2015-12-17 07:28:47 +00:00
if !all {
// Only show public organizations
sess.And("is_public=?", true)
}
err := sess.
Asc("`user`.name").
Find(&ous)
2014-06-25 04:44:48 +00:00
return ous, err
}
// GetOrgUsersByOrgID returns all organization-user relations by organization ID.
func GetOrgUsersByOrgID(orgID int64) ([]*OrgUser, error) {
ous := make([]*OrgUser, 0, 10)
2016-11-10 15:16:32 +00:00
err := x.
Where("org_id=?", orgID).
Find(&ous)
return ous, err
}
// ChangeOrgUserStatus changes public or private membership status.
2016-07-24 06:32:46 +00:00
func ChangeOrgUserStatus(orgID, uid int64, public bool) error {
ou := new(OrgUser)
2016-11-10 15:16:32 +00:00
has, err := x.
Where("uid=?", uid).
And("org_id=?", orgID).
Get(ou)
if err != nil {
return err
} else if !has {
return nil
}
ou.IsPublic = public
_, err = x.Id(ou.ID).AllCols().Update(ou)
return err
}
// AddOrgUser adds new user to given organization.
2016-07-24 06:32:46 +00:00
func AddOrgUser(orgID, uid int64) error {
if IsOrganizationMember(orgID, uid) {
return nil
}
sess := x.NewSession()
defer sess.Close()
if err := sess.Begin(); err != nil {
return err
}
ou := &OrgUser{
2016-11-26 00:20:18 +00:00
UID: uid,
2016-07-24 06:32:46 +00:00
OrgID: orgID,
}
if _, err := sess.Insert(ou); err != nil {
sess.Rollback()
return err
2016-07-24 06:32:46 +00:00
} else if _, err = sess.Exec("UPDATE `user` SET num_members = num_members + 1 WHERE id = ?", orgID); err != nil {
sess.Rollback()
return err
}
return sess.Commit()
}
// RemoveOrgUser removes user from given organization.
2016-07-24 06:32:46 +00:00
func RemoveOrgUser(orgID, userID int64) error {
ou := new(OrgUser)
2016-11-10 15:16:32 +00:00
has, err := x.
Where("uid=?", userID).
And("org_id=?", orgID).
Get(ou)
if err != nil {
return fmt.Errorf("get org-user: %v", err)
} else if !has {
return nil
}
2016-07-24 06:32:46 +00:00
user, err := GetUserByID(userID)
if err != nil {
return fmt.Errorf("GetUserByID [%d]: %v", userID, err)
}
org, err := GetUserByID(orgID)
if err != nil {
2016-07-24 06:32:46 +00:00
return fmt.Errorf("GetUserByID [%d]: %v", orgID, err)
}
2016-07-24 06:32:46 +00:00
// FIXME: only need to get IDs here, not all fields of repository.
repos, _, err := org.GetUserRepositories(user.ID, 1, org.NumRepos)
if err != nil {
2016-07-24 06:32:46 +00:00
return fmt.Errorf("GetUserRepositories [%d]: %v", user.ID, err)
}
// Check if the user to delete is the last member in owner team.
2016-07-24 06:32:46 +00:00
if IsOrganizationOwner(orgID, userID) {
t, err := org.GetOwnerTeam()
if err != nil {
return err
}
if t.NumMembers == 1 {
2016-07-24 06:32:46 +00:00
return ErrLastOrgOwner{UID: userID}
}
}
sess := x.NewSession()
defer sessionRelease(sess)
if err := sess.Begin(); err != nil {
return err
}
if _, err := sess.Id(ou.ID).Delete(ou); err != nil {
return err
2016-07-24 06:32:46 +00:00
} else if _, err = sess.Exec("UPDATE `user` SET num_members=num_members-1 WHERE id=?", orgID); err != nil {
return err
}
2016-07-24 06:32:46 +00:00
// Delete all repository accesses and unwatch them.
repoIDs := make([]int64, len(repos))
for i := range repos {
repoIDs = append(repoIDs, repos[i].ID)
if err = watchRepo(sess, user.ID, repos[i].ID, false); err != nil {
2014-08-27 08:39:36 +00:00
return err
}
}
if len(repoIDs) > 0 {
2016-11-10 15:16:32 +00:00
if _, err = sess.
Where("user_id = ?", user.ID).
In("repo_id", repoIDs).
Delete(new(Access)); err != nil {
return err
}
2016-07-24 06:32:46 +00:00
}
// Delete member in his/her teams.
2016-07-24 06:32:46 +00:00
teams, err := getUserTeams(sess, org.ID, user.ID)
if err != nil {
return err
}
for _, t := range teams {
2016-07-24 06:32:46 +00:00
if err = removeTeamMember(sess, org.ID, t.ID, user.ID); err != nil {
return err
}
}
return sess.Commit()
}
func removeOrgRepo(e Engine, orgID, repoID int64) error {
_, err := e.Delete(&TeamRepo{
OrgID: orgID,
RepoID: repoID,
})
return err
}
// RemoveOrgRepo removes all team-repository relations of given organization.
func RemoveOrgRepo(orgID, repoID int64) error {
return removeOrgRepo(x, orgID, repoID)
}
func (org *User) getUserTeams(e Engine, userID int64, cols ...string) ([]*Team, error) {
teams := make([]*Team, 0, org.NumTeams)
return teams, e.
Where("`team_user`.org_id = ?", org.ID).
Join("INNER", "team_user", "`team_user`.team_id = team.id").
Join("INNER", "user", "`user`.id=team_user.uid").
And("`team_user`.uid = ?", userID).
Asc("`user`.name").
Cols(cols...).
2016-11-10 15:16:32 +00:00
Find(&teams)
}
2016-11-27 11:59:12 +00:00
// GetUserTeamIDs returns of all team IDs of the organization that user is member of.
2016-07-24 06:32:46 +00:00
func (org *User) GetUserTeamIDs(userID int64) ([]int64, error) {
teams, err := org.getUserTeams(x, userID, "team.id")
if err != nil {
return nil, fmt.Errorf("getUserTeams [%d]: %v", userID, err)
}
2016-07-24 06:32:46 +00:00
teamIDs := make([]int64, len(teams))
2016-02-04 18:03:34 +00:00
for i := range teams {
2016-07-24 06:32:46 +00:00
teamIDs[i] = teams[i].ID
}
2016-07-24 06:32:46 +00:00
return teamIDs, nil
}
2016-11-26 00:20:18 +00:00
// GetUserTeams returns all teams that belong to user,
// and that the user has joined.
func (org *User) GetUserTeams(userID int64) ([]*Team, error) {
return org.getUserTeams(x, userID)
}
// GetUserRepositories returns a range of repositories in organization
// that the user with the given userID has access to,
// and total number of records based on given condition.
2016-07-24 06:32:46 +00:00
func (org *User) GetUserRepositories(userID int64, page, pageSize int) ([]*Repository, int64, error) {
var cond builder.Cond = builder.Eq{
"`repository`.owner_id": org.ID,
"`repository`.is_private": false,
}
2016-07-24 06:32:46 +00:00
teamIDs, err := org.GetUserTeamIDs(userID)
if err != nil {
return nil, 0, fmt.Errorf("GetUserTeamIDs: %v", err)
2016-01-31 18:13:39 +00:00
}
if len(teamIDs) > 0 {
cond = cond.Or(builder.In("team_repo.team_id", teamIDs))
}
2016-01-31 18:13:39 +00:00
2016-07-24 06:32:46 +00:00
if page <= 0 {
page = 1
}
repos := make([]*Repository, 0, pageSize)
2017-01-03 08:27:11 +00:00
if err := x.Select("`repository`.*").
2016-11-10 15:16:32 +00:00
Join("INNER", "team_repo", "`team_repo`.repo_id=`repository`.id").
Where(cond).
2016-11-10 15:16:32 +00:00
GroupBy("`repository`.id").
OrderBy("updated_unix DESC").
Limit(pageSize, (page-1)*pageSize).
Find(&repos); err != nil {
2016-07-24 06:32:46 +00:00
return nil, 0, fmt.Errorf("get repositories: %v", err)
}
2016-11-10 15:16:32 +00:00
repoCount, err := x.
Join("INNER", "team_repo", "`team_repo`.repo_id=`repository`.id").
Where(cond).
2016-11-10 15:16:32 +00:00
GroupBy("`repository`.id").
Count(&Repository{})
2016-07-24 06:32:46 +00:00
if err != nil {
2016-11-10 15:16:32 +00:00
return nil, 0, fmt.Errorf("count user repositories in organization: %v", err)
}
2016-11-10 15:16:32 +00:00
return repos, repoCount, nil
2016-07-24 06:32:46 +00:00
}
2016-11-26 00:20:18 +00:00
// GetUserMirrorRepositories returns mirror repositories of the user
2016-07-24 06:32:46 +00:00
// that the user with the given userID has access to.
func (org *User) GetUserMirrorRepositories(userID int64) ([]*Repository, error) {
teamIDs, err := org.GetUserTeamIDs(userID)
if err != nil {
return nil, fmt.Errorf("GetUserTeamIDs: %v", err)
}
if len(teamIDs) == 0 {
teamIDs = []int64{-1}
}
2016-07-24 06:32:46 +00:00
repos := make([]*Repository, 0, 10)
2016-11-10 15:16:32 +00:00
return repos, x.
Select("`repository`.*").
Join("INNER", "team_repo", "`team_repo`.repo_id=`repository`.id AND `repository`.is_mirror=?", true).
Where("(`repository`.owner_id=? AND `repository`.is_private=?)", org.ID, false).
2016-11-11 17:31:37 +00:00
Or(builder.In("team_repo.team_id", teamIDs)).
2016-11-10 15:16:32 +00:00
GroupBy("`repository`.id").
OrderBy("updated_unix DESC").
Find(&repos)
}