Move db related basic functions to models/db (#17075)

* Move db related basic functions to models/db

* Fix lint

* Fix lint

* Fix test

* Fix lint

* Fix lint

* revert unnecessary change

* Fix test

* Fix wrong replace string

* Use *Context

* Correct committer spelling and fix wrong replaced words

Co-authored-by: zeripath <art27@cantab.net>

1 files changed, 51 insertions, 46 deletions

diff --git a/models/org.go b/models/org.go
index a3229470a4..3b1d9f50ec 100644
--- a/models/org.go
+++ b/models/org.go
@@ -9,6 +9,7 @@ import (
 	"fmt"
 	"strings"
 
+	"code.gitea.io/gitea/models/db"
 	"code.gitea.io/gitea/modules/log"
 	"code.gitea.io/gitea/modules/setting"
 	"code.gitea.io/gitea/modules/storage"
@@ -34,25 +35,25 @@ func (org *User) CanCreateOrgRepo(uid int64) (bool, error) {
 	return CanCreateOrgRepo(org.ID, uid)
 }
 
-func (org *User) getTeam(e Engine, name string) (*Team, error) {
+func (org *User) getTeam(e db.Engine, name string) (*Team, error) {
 	return getTeam(e, org.ID, name)
 }
 
 // GetTeam returns named team of organization.
 func (org *User) GetTeam(name string) (*Team, error) {
-	return org.getTeam(x, name)
+	return org.getTeam(db.DefaultContext().Engine(), name)
 }
 
-func (org *User) getOwnerTeam(e Engine) (*Team, error) {
+func (org *User) getOwnerTeam(e db.Engine) (*Team, error) {
 	return org.getTeam(e, ownerTeamName)
 }
 
 // GetOwnerTeam returns owner team of organization.
 func (org *User) GetOwnerTeam() (*Team, error) {
-	return org.getOwnerTeam(x)
+	return org.getOwnerTeam(db.DefaultContext().Engine())
 }
 
-func (org *User) loadTeams(e Engine) error {
+func (org *User) loadTeams(e db.Engine) error {
 	if org.Teams != nil {
 		return nil
 	}
@@ -64,7 +65,7 @@ func (org *User) loadTeams(e Engine) error {
 
 // LoadTeams load teams if not loaded.
 func (org *User) LoadTeams() error {
-	return org.loadTeams(x)
+	return org.loadTeams(db.DefaultContext().Engine())
 }
 
 // GetMembers returns all members of organization.
@@ -84,7 +85,7 @@ type FindOrgMembersOpts struct {
 
 // CountOrgMembers counts the organization's members
 func CountOrgMembers(opts *FindOrgMembersOpts) (int64, error) {
-	sess := x.Where("org_id=?", opts.OrgID)
+	sess := db.DefaultContext().Engine().Where("org_id=?", opts.OrgID)
 	if opts.PublicOnly {
 		sess.And("is_public = ?", true)
 	}
@@ -122,13 +123,13 @@ func (org *User) RemoveMember(uid int64) error {
 	return RemoveOrgUser(org.ID, uid)
 }
 
-func (org *User) removeOrgRepo(e Engine, repoID int64) error {
+func (org *User) removeOrgRepo(e db.Engine, repoID int64) error {
 	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)
+	return org.removeOrgRepo(db.DefaultContext().Engine(), repoID)
 }
 
 // CreateOrganization creates record of a new organization.
@@ -161,7 +162,7 @@ func CreateOrganization(org, owner *User) (err error) {
 	org.NumMembers = 1
 	org.Type = UserTypeOrganization
 
-	sess := x.NewSession()
+	sess := db.DefaultContext().NewSession()
 	defer sess.Close()
 	if err = sess.Begin(); err != nil {
 		return err
@@ -237,7 +238,7 @@ func GetOrgByName(name string) (*User, error) {
 		LowerName: strings.ToLower(name),
 		Type:      UserTypeOrganization,
 	}
-	has, err := x.Get(u)
+	has, err := db.DefaultContext().Engine().Get(u)
 	if err != nil {
 		return nil, err
 	} else if !has {
@@ -248,7 +249,7 @@ func GetOrgByName(name string) (*User, error) {
 
 // CountOrganizations returns number of organizations.
 func CountOrganizations() int64 {
-	count, _ := x.
+	count, _ := db.DefaultContext().Engine().
 		Where("type=1").
 		Count(new(User))
 	return count
@@ -260,7 +261,7 @@ func DeleteOrganization(org *User) (err error) {
 		return fmt.Errorf("%s is a user not an organization", org.Name)
 	}
 
-	sess := x.NewSession()
+	sess := db.DefaultContext().NewSession()
 	defer sess.Close()
 
 	if err = sess.Begin(); err != nil {
@@ -334,7 +335,11 @@ type OrgUser struct {
 	IsPublic bool  `xorm:"INDEX"`
 }
 
-func isOrganizationOwner(e Engine, orgID, uid int64) (bool, error) {
+func init() {
+	db.RegisterModel(new(OrgUser))
+}
+
+func isOrganizationOwner(e db.Engine, orgID, uid int64) (bool, error) {
 	ownerTeam, err := getOwnerTeam(e, orgID)
 	if err != nil {
 		if IsErrTeamNotExist(err) {
@@ -348,15 +353,15 @@ func isOrganizationOwner(e Engine, orgID, uid int64) (bool, error) {
 
 // IsOrganizationOwner returns true if given user is in the owner team.
 func IsOrganizationOwner(orgID, uid int64) (bool, error) {
-	return isOrganizationOwner(x, orgID, uid)
+	return isOrganizationOwner(db.DefaultContext().Engine(), orgID, uid)
 }
 
 // IsOrganizationMember returns true if given user is member of organization.
 func IsOrganizationMember(orgID, uid int64) (bool, error) {
-	return isOrganizationMember(x, orgID, uid)
+	return isOrganizationMember(db.DefaultContext().Engine(), orgID, uid)
 }
 
-func isOrganizationMember(e Engine, orgID, uid int64) (bool, error) {
+func isOrganizationMember(e db.Engine, orgID, uid int64) (bool, error) {
 	return e.
 		Where("uid=?", uid).
 		And("org_id=?", orgID).
@@ -366,7 +371,7 @@ func isOrganizationMember(e Engine, orgID, uid int64) (bool, error) {
 
 // IsPublicMembership returns true if given user public his/her membership.
 func IsPublicMembership(orgID, uid int64) (bool, error) {
-	return x.
+	return db.DefaultContext().Engine().
 		Where("uid=?", uid).
 		And("org_id=?", orgID).
 		And("is_public=?", true).
@@ -379,7 +384,7 @@ func CanCreateOrgRepo(orgID, uid int64) (bool, error) {
 	if owner, err := IsOrganizationOwner(orgID, uid); owner || err != nil {
 		return owner, err
 	}
-	return x.
+	return db.DefaultContext().Engine().
 		Where(builder.Eq{"team.can_create_org_repo": true}).
 		Join("INNER", "team_user", "team_user.team_id = team.id").
 		And("team_user.uid = ?", uid).
@@ -389,12 +394,12 @@ func CanCreateOrgRepo(orgID, uid int64) (bool, error) {
 
 // GetUsersWhoCanCreateOrgRepo returns users which are able to create repo in organization
 func GetUsersWhoCanCreateOrgRepo(orgID int64) ([]*User, error) {
-	return getUsersWhoCanCreateOrgRepo(x, orgID)
+	return getUsersWhoCanCreateOrgRepo(db.DefaultContext().Engine(), orgID)
 }
 
-func getUsersWhoCanCreateOrgRepo(e Engine, orgID int64) ([]*User, error) {
+func getUsersWhoCanCreateOrgRepo(e db.Engine, orgID int64) ([]*User, error) {
 	users := make([]*User, 0, 10)
-	return users, x.
+	return users, db.DefaultContext().Engine().
 		Join("INNER", "`team_user`", "`team_user`.uid=`user`.id").
 		Join("INNER", "`team`", "`team`.id=`team_user`.team_id").
 		Where(builder.Eq{"team.can_create_org_repo": true}.Or(builder.Eq{"team.authorize": AccessModeOwner})).
@@ -416,7 +421,7 @@ func getOrgsByUserID(sess *xorm.Session, userID int64, showAll bool) ([]*User, e
 // GetOrgsByUserID returns a list of organizations that the given user ID
 // has joined.
 func GetOrgsByUserID(userID int64, showAll bool) ([]*User, error) {
-	sess := x.NewSession()
+	sess := db.DefaultContext().NewSession()
 	defer sess.Close()
 	return getOrgsByUserID(sess, userID, showAll)
 }
@@ -426,10 +431,10 @@ type MinimalOrg = User
 
 // GetUserOrgsList returns one user's all orgs list
 func GetUserOrgsList(user *User) ([]*MinimalOrg, error) {
-	sess := x.NewSession()
+	sess := db.DefaultContext().NewSession()
 	defer sess.Close()
 
-	schema, err := x.TableInfo(new(User))
+	schema, err := db.TableInfo(new(User))
 	if err != nil {
 		return nil, err
 	}
@@ -497,10 +502,10 @@ func getOwnedOrgsByUserID(sess *xorm.Session, userID int64) ([]*User, error) {
 
 // HasOrgOrUserVisible tells if the given user can see the given org or user
 func HasOrgOrUserVisible(org, user *User) bool {
-	return hasOrgOrUserVisible(x, org, user)
+	return hasOrgOrUserVisible(db.DefaultContext().Engine(), org, user)
 }
 
-func hasOrgOrUserVisible(e Engine, orgOrUser, user *User) bool {
+func hasOrgOrUserVisible(e db.Engine, orgOrUser, user *User) bool {
 	// Not SignedUser
 	if user == nil {
 		return orgOrUser.Visibility == structs.VisibleTypePublic
@@ -532,7 +537,7 @@ func HasOrgsVisible(orgs []*User, user *User) bool {
 
 // GetOwnedOrgsByUserID returns a list of organizations are owned by given user ID.
 func GetOwnedOrgsByUserID(userID int64) ([]*User, error) {
-	sess := x.NewSession()
+	sess := db.DefaultContext().NewSession()
 	defer sess.Close()
 	return getOwnedOrgsByUserID(sess, userID)
 }
@@ -540,7 +545,7 @@ func GetOwnedOrgsByUserID(userID int64) ([]*User, error) {
 // 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) {
-	return getOwnedOrgsByUserID(x.Desc(desc), userID)
+	return getOwnedOrgsByUserID(db.DefaultContext().Engine().Desc(desc), userID)
 }
 
 // GetOrgsCanCreateRepoByUserID returns a list of organizations where given user ID
@@ -548,7 +553,7 @@ func GetOwnedOrgsByUserIDDesc(userID int64, desc string) ([]*User, error) {
 func GetOrgsCanCreateRepoByUserID(userID int64) ([]*User, error) {
 	orgs := make([]*User, 0, 10)
 
-	return orgs, x.Where(builder.In("id", builder.Select("`user`.id").From("`user`").
+	return orgs, db.DefaultContext().Engine().Where(builder.In("id", builder.Select("`user`.id").From("`user`").
 		Join("INNER", "`team_user`", "`team_user`.org_id = `user`.id").
 		Join("INNER", "`team`", "`team`.id = `team_user`.team_id").
 		Where(builder.Eq{"`team_user`.uid": userID}).
@@ -560,7 +565,7 @@ func GetOrgsCanCreateRepoByUserID(userID int64) ([]*User, error) {
 // GetOrgUsersByUserID returns all organization-user relations by user ID.
 func GetOrgUsersByUserID(uid int64, opts *SearchOrganizationsOptions) ([]*OrgUser, error) {
 	ous := make([]*OrgUser, 0, 10)
-	sess := x.
+	sess := db.DefaultContext().Engine().
 		Join("LEFT", "`user`", "`org_user`.org_id=`user`.id").
 		Where("`org_user`.uid=?", uid)
 	if !opts.All {
@@ -580,10 +585,10 @@ func GetOrgUsersByUserID(uid int64, opts *SearchOrganizationsOptions) ([]*OrgUse
 
 // GetOrgUsersByOrgID returns all organization-user relations by organization ID.
 func GetOrgUsersByOrgID(opts *FindOrgMembersOpts) ([]*OrgUser, error) {
-	return getOrgUsersByOrgID(x, opts)
+	return getOrgUsersByOrgID(db.DefaultContext().Engine(), opts)
 }
 
-func getOrgUsersByOrgID(e Engine, opts *FindOrgMembersOpts) ([]*OrgUser, error) {
+func getOrgUsersByOrgID(e db.Engine, opts *FindOrgMembersOpts) ([]*OrgUser, error) {
 	sess := e.Where("org_id=?", opts.OrgID)
 	if opts.PublicOnly {
 		sess.And("is_public = ?", true)
@@ -602,7 +607,7 @@ func getOrgUsersByOrgID(e Engine, opts *FindOrgMembersOpts) ([]*OrgUser, error)
 // ChangeOrgUserStatus changes public or private membership status.
 func ChangeOrgUserStatus(orgID, uid int64, public bool) error {
 	ou := new(OrgUser)
-	has, err := x.
+	has, err := db.DefaultContext().Engine().
 		Where("uid=?", uid).
 		And("org_id=?", orgID).
 		Get(ou)
@@ -613,7 +618,7 @@ func ChangeOrgUserStatus(orgID, uid int64, public bool) error {
 	}
 
 	ou.IsPublic = public
-	_, err = x.ID(ou.ID).Cols("is_public").Update(ou)
+	_, err = db.DefaultContext().Engine().ID(ou.ID).Cols("is_public").Update(ou)
 	return err
 }
 
@@ -624,7 +629,7 @@ func AddOrgUser(orgID, uid int64) error {
 		return err
 	}
 
-	sess := x.NewSession()
+	sess := db.DefaultContext().NewSession()
 	defer sess.Close()
 	if err := sess.Begin(); err != nil {
 		return err
@@ -733,7 +738,7 @@ func removeOrgUser(sess *xorm.Session, orgID, userID int64) error {
 
 // RemoveOrgUser removes user from given organization.
 func RemoveOrgUser(orgID, userID int64) error {
-	sess := x.NewSession()
+	sess := db.DefaultContext().NewSession()
 	defer sess.Close()
 	if err := sess.Begin(); err != nil {
 		return err
@@ -744,7 +749,7 @@ func RemoveOrgUser(orgID, userID int64) error {
 	return sess.Commit()
 }
 
-func removeOrgRepo(e Engine, orgID, repoID int64) error {
+func removeOrgRepo(e db.Engine, orgID, repoID int64) error {
 	teamRepos := make([]*TeamRepo, 0, 10)
 	if err := e.Find(&teamRepos, &TeamRepo{OrgID: orgID, RepoID: repoID}); err != nil {
 		return err
@@ -770,7 +775,7 @@ func removeOrgRepo(e Engine, orgID, repoID int64) error {
 	return err
 }
 
-func (org *User) getUserTeams(e Engine, userID int64, cols ...string) ([]*Team, error) {
+func (org *User) getUserTeams(e db.Engine, userID int64, cols ...string) ([]*Team, error) {
 	teams := make([]*Team, 0, org.NumTeams)
 	return teams, e.
 		Where("`team_user`.org_id = ?", org.ID).
@@ -782,7 +787,7 @@ func (org *User) getUserTeams(e Engine, userID int64, cols ...string) ([]*Team,
 		Find(&teams)
 }
 
-func (org *User) getUserTeamIDs(e Engine, userID int64) ([]int64, error) {
+func (org *User) getUserTeamIDs(e db.Engine, userID int64) ([]int64, error) {
 	teamIDs := make([]int64, 0, org.NumTeams)
 	return teamIDs, e.
 		Table("team").
@@ -800,13 +805,13 @@ func (org *User) TeamsWithAccessToRepo(repoID int64, mode AccessMode) ([]*Team,
 
 // GetUserTeamIDs returns of all team IDs of the organization that user is member of.
 func (org *User) GetUserTeamIDs(userID int64) ([]int64, error) {
-	return org.getUserTeamIDs(x, userID)
+	return org.getUserTeamIDs(db.DefaultContext().Engine(), userID)
 }
 
 // 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)
+	return org.getUserTeams(db.DefaultContext().Engine(), userID)
 }
 
 // AccessibleReposEnvironment operations involving the repositories that are
@@ -825,7 +830,7 @@ type accessibleReposEnv struct {
 	user    *User
 	team    *Team
 	teamIDs []int64
-	e       Engine
+	e       db.Engine
 	keyword string
 	orderBy SearchOrderBy
 }
@@ -833,10 +838,10 @@ type accessibleReposEnv struct {
 // AccessibleReposEnv builds an AccessibleReposEnvironment for the repositories in `org`
 // that are accessible to the specified user.
 func (org *User) AccessibleReposEnv(userID int64) (AccessibleReposEnvironment, error) {
-	return org.accessibleReposEnv(x, userID)
+	return org.accessibleReposEnv(db.DefaultContext().Engine(), userID)
 }
 
-func (org *User) accessibleReposEnv(e Engine, userID int64) (AccessibleReposEnvironment, error) {
+func (org *User) accessibleReposEnv(e db.Engine, userID int64) (AccessibleReposEnvironment, error) {
 	var user *User
 
 	if userID > 0 {
@@ -866,7 +871,7 @@ func (org *User) AccessibleTeamReposEnv(team *Team) AccessibleReposEnvironment {
 	return &accessibleReposEnv{
 		org:     org,
 		team:    team,
-		e:       x,
+		e:       db.DefaultContext().Engine(),
 		orderBy: SearchOrderByRecentUpdated,
 	}
 }