12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748 |
- // Copyright 2014 The Gogs Authors. All rights reserved.
- // Copyright 2019 The Gitea 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
-
- import (
- "context"
- "crypto/sha256"
- "crypto/subtle"
- "encoding/hex"
- "errors"
- "fmt"
- _ "image/jpeg" // Needed for jpeg support
- "os"
- "path/filepath"
- "regexp"
- "strings"
- "time"
- "unicode/utf8"
-
- "code.gitea.io/gitea/modules/base"
- "code.gitea.io/gitea/modules/git"
- "code.gitea.io/gitea/modules/log"
- "code.gitea.io/gitea/modules/setting"
- "code.gitea.io/gitea/modules/storage"
- "code.gitea.io/gitea/modules/structs"
- "code.gitea.io/gitea/modules/timeutil"
- "code.gitea.io/gitea/modules/util"
-
- "golang.org/x/crypto/argon2"
- "golang.org/x/crypto/bcrypt"
- "golang.org/x/crypto/pbkdf2"
- "golang.org/x/crypto/scrypt"
- "xorm.io/builder"
- )
-
- // UserType defines the user type
- type UserType int
-
- const (
- // UserTypeIndividual defines an individual user
- UserTypeIndividual UserType = iota // Historic reason to make it starts at 0.
-
- // UserTypeOrganization defines an organization
- UserTypeOrganization
- )
-
- const (
- algoBcrypt = "bcrypt"
- algoScrypt = "scrypt"
- algoArgon2 = "argon2"
- algoPbkdf2 = "pbkdf2"
- )
-
- // AvailableHashAlgorithms represents the available password hashing algorithms
- var AvailableHashAlgorithms = []string{
- algoPbkdf2,
- algoArgon2,
- algoScrypt,
- algoBcrypt,
- }
-
- const (
- // EmailNotificationsEnabled indicates that the user would like to receive all email notifications
- EmailNotificationsEnabled = "enabled"
- // EmailNotificationsOnMention indicates that the user would like to be notified via email when mentioned.
- EmailNotificationsOnMention = "onmention"
- // EmailNotificationsDisabled indicates that the user would not like to be notified via email.
- EmailNotificationsDisabled = "disabled"
- )
-
- var (
- // ErrEmailNotActivated e-mail address has not been activated error
- ErrEmailNotActivated = errors.New("E-mail address has not been activated")
-
- // ErrUserNameIllegal user name contains illegal characters error
- ErrUserNameIllegal = errors.New("User name contains illegal characters")
-
- // ErrLoginSourceNotActived login source is not actived error
- ErrLoginSourceNotActived = errors.New("Login source is not actived")
-
- // ErrUnsupportedLoginType login source is unknown error
- ErrUnsupportedLoginType = errors.New("Login source is unknown")
-
- // Characters prohibited in a user name (anything except A-Za-z0-9_.-)
- alphaDashDotPattern = regexp.MustCompile(`[^\w-\.]`)
- )
-
- // User represents the object of individual and member of organization.
- type User struct {
- ID int64 `xorm:"pk autoincr"`
- LowerName string `xorm:"UNIQUE NOT NULL"`
- Name string `xorm:"UNIQUE NOT NULL"`
- FullName string
- // Email is the primary email address (to be used for communication)
- Email string `xorm:"NOT NULL"`
- KeepEmailPrivate bool
- EmailNotificationsPreference string `xorm:"VARCHAR(20) NOT NULL DEFAULT 'enabled'"`
- Passwd string `xorm:"NOT NULL"`
- PasswdHashAlgo string `xorm:"NOT NULL DEFAULT 'argon2'"`
-
- // MustChangePassword is an attribute that determines if a user
- // is to change his/her password after registration.
- MustChangePassword bool `xorm:"NOT NULL DEFAULT false"`
-
- LoginType LoginType
- LoginSource int64 `xorm:"NOT NULL DEFAULT 0"`
- LoginName string
- Type UserType
- OwnedOrgs []*User `xorm:"-"`
- Repos []*Repository `xorm:"-"`
- Location string
- Website string
- Rands string `xorm:"VARCHAR(10)"`
- Salt string `xorm:"VARCHAR(10)"`
- Language string `xorm:"VARCHAR(5)"`
- Description string
-
- CreatedUnix timeutil.TimeStamp `xorm:"INDEX created"`
- UpdatedUnix timeutil.TimeStamp `xorm:"INDEX updated"`
- LastLoginUnix timeutil.TimeStamp `xorm:"INDEX"`
-
- // Remember visibility choice for convenience, true for private
- LastRepoVisibility bool
- // Maximum repository creation limit, -1 means use global default
- MaxRepoCreation int `xorm:"NOT NULL DEFAULT -1"`
-
- // Permissions
- IsActive bool `xorm:"INDEX"` // Activate primary email
- IsAdmin bool
- IsRestricted bool `xorm:"NOT NULL DEFAULT false"`
- AllowGitHook bool
- AllowImportLocal bool // Allow migrate repository by local path
- AllowCreateOrganization bool `xorm:"DEFAULT true"`
- ProhibitLogin bool `xorm:"NOT NULL DEFAULT false"`
-
- // Avatar
- Avatar string `xorm:"VARCHAR(2048) NOT NULL"`
- AvatarEmail string `xorm:"NOT NULL"`
- UseCustomAvatar bool
-
- // Counters
- NumFollowers int
- NumFollowing int `xorm:"NOT NULL DEFAULT 0"`
- NumStars int
- NumRepos int
-
- // For organization
- NumTeams int
- NumMembers int
- Teams []*Team `xorm:"-"`
- Members UserList `xorm:"-"`
- MembersIsPublic map[int64]bool `xorm:"-"`
- Visibility structs.VisibleType `xorm:"NOT NULL DEFAULT 0"`
- RepoAdminChangeTeamAccess bool `xorm:"NOT NULL DEFAULT false"`
-
- // Preferences
- DiffViewStyle string `xorm:"NOT NULL DEFAULT ''"`
- Theme string `xorm:"NOT NULL DEFAULT ''"`
- KeepActivityPrivate bool `xorm:"NOT NULL DEFAULT false"`
- }
-
- // SearchOrganizationsOptions options to filter organizations
- type SearchOrganizationsOptions struct {
- ListOptions
- All bool
- }
-
- // ColorFormat writes a colored string to identify this struct
- func (u *User) ColorFormat(s fmt.State) {
- log.ColorFprintf(s, "%d:%s",
- log.NewColoredIDValue(u.ID),
- log.NewColoredValue(u.Name))
- }
-
- // BeforeUpdate is invoked from XORM before updating this object.
- func (u *User) BeforeUpdate() {
- if u.MaxRepoCreation < -1 {
- u.MaxRepoCreation = -1
- }
-
- // Organization does not need email
- u.Email = strings.ToLower(u.Email)
- if !u.IsOrganization() {
- if len(u.AvatarEmail) == 0 {
- u.AvatarEmail = u.Email
- }
- }
-
- u.LowerName = strings.ToLower(u.Name)
- u.Location = base.TruncateString(u.Location, 255)
- u.Website = base.TruncateString(u.Website, 255)
- u.Description = base.TruncateString(u.Description, 255)
- }
-
- // AfterLoad is invoked from XORM after filling all the fields of this object.
- func (u *User) AfterLoad() {
- if u.Theme == "" {
- u.Theme = setting.UI.DefaultTheme
- }
- }
-
- // SetLastLogin set time to last login
- func (u *User) SetLastLogin() {
- u.LastLoginUnix = timeutil.TimeStampNow()
- }
-
- // UpdateDiffViewStyle updates the users diff view style
- func (u *User) UpdateDiffViewStyle(style string) error {
- u.DiffViewStyle = style
- return UpdateUserCols(u, "diff_view_style")
- }
-
- // UpdateTheme updates a users' theme irrespective of the site wide theme
- func (u *User) UpdateTheme(themeName string) error {
- u.Theme = themeName
- return UpdateUserCols(u, "theme")
- }
-
- // GetEmail returns an noreply email, if the user has set to keep his
- // email address private, otherwise the primary email address.
- func (u *User) GetEmail() string {
- if u.KeepEmailPrivate {
- return fmt.Sprintf("%s@%s", u.LowerName, setting.Service.NoReplyAddress)
- }
- return u.Email
- }
-
- // GetAllUsers returns a slice of all individual users found in DB.
- func GetAllUsers() ([]*User, error) {
- users := make([]*User, 0)
- return users, x.OrderBy("id").Where("type = ?", UserTypeIndividual).Find(&users)
- }
-
- // IsLocal returns true if user login type is LoginPlain.
- func (u *User) IsLocal() bool {
- return u.LoginType <= LoginPlain
- }
-
- // IsOAuth2 returns true if user login type is LoginOAuth2.
- func (u *User) IsOAuth2() bool {
- return u.LoginType == LoginOAuth2
- }
-
- // HasForkedRepo checks if user has already forked a repository with given ID.
- func (u *User) HasForkedRepo(repoID int64) bool {
- _, has := HasForkedRepo(u.ID, repoID)
- return has
- }
-
- // MaxCreationLimit returns the number of repositories a user is allowed to create
- func (u *User) MaxCreationLimit() int {
- if u.MaxRepoCreation <= -1 {
- return setting.Repository.MaxCreationLimit
- }
- return u.MaxRepoCreation
- }
-
- // CanCreateRepo returns if user login can create a repository
- // NOTE: functions calling this assume a failure due to repository count limit; if new checks are added, those functions should be revised
- func (u *User) CanCreateRepo() bool {
- if u.IsAdmin {
- return true
- }
- if u.MaxRepoCreation <= -1 {
- if setting.Repository.MaxCreationLimit <= -1 {
- return true
- }
- return u.NumRepos < setting.Repository.MaxCreationLimit
- }
- return u.NumRepos < u.MaxRepoCreation
- }
-
- // CanCreateOrganization returns true if user can create organisation.
- func (u *User) CanCreateOrganization() bool {
- return u.IsAdmin || (u.AllowCreateOrganization && !setting.Admin.DisableRegularOrgCreation)
- }
-
- // CanEditGitHook returns true if user can edit Git hooks.
- func (u *User) CanEditGitHook() bool {
- return !setting.DisableGitHooks && (u.IsAdmin || u.AllowGitHook)
- }
-
- // CanImportLocal returns true if user can migrate repository by local path.
- func (u *User) CanImportLocal() bool {
- if !setting.ImportLocalPaths || u == nil {
- return false
- }
- return u.IsAdmin || u.AllowImportLocal
- }
-
- // DashboardLink returns the user dashboard page link.
- func (u *User) DashboardLink() string {
- if u.IsOrganization() {
- return u.OrganisationLink() + "/dashboard/"
- }
- return setting.AppSubURL + "/"
- }
-
- // HomeLink returns the user or organization home page link.
- func (u *User) HomeLink() string {
- return setting.AppSubURL + "/" + u.Name
- }
-
- // HTMLURL returns the user or organization's full link.
- func (u *User) HTMLURL() string {
- return setting.AppURL + u.Name
- }
-
- // OrganisationLink returns the organization sub page link.
- func (u *User) OrganisationLink() string {
- return setting.AppSubURL + "/org/" + u.Name
- }
-
- // GenerateEmailActivateCode generates an activate code based on user information and given e-mail.
- func (u *User) GenerateEmailActivateCode(email string) string {
- code := base.CreateTimeLimitCode(
- fmt.Sprintf("%d%s%s%s%s", u.ID, email, u.LowerName, u.Passwd, u.Rands),
- setting.Service.ActiveCodeLives, nil)
-
- // Add tail hex username
- code += hex.EncodeToString([]byte(u.LowerName))
- return code
- }
-
- // GetFollowers returns range of user's followers.
- func (u *User) GetFollowers(listOptions ListOptions) ([]*User, error) {
- sess := x.
- Where("follow.follow_id=?", u.ID).
- Join("LEFT", "follow", "`user`.id=follow.user_id")
-
- if listOptions.Page != 0 {
- sess = listOptions.setSessionPagination(sess)
-
- users := make([]*User, 0, listOptions.PageSize)
- return users, sess.Find(&users)
- }
-
- users := make([]*User, 0, 8)
- return users, sess.Find(&users)
- }
-
- // IsFollowing returns true if user is following followID.
- func (u *User) IsFollowing(followID int64) bool {
- return IsFollowing(u.ID, followID)
- }
-
- // GetFollowing returns range of user's following.
- func (u *User) GetFollowing(listOptions ListOptions) ([]*User, error) {
- sess := x.
- Where("follow.user_id=?", u.ID).
- Join("LEFT", "follow", "`user`.id=follow.follow_id")
-
- if listOptions.Page != 0 {
- sess = listOptions.setSessionPagination(sess)
-
- users := make([]*User, 0, listOptions.PageSize)
- return users, sess.Find(&users)
- }
-
- users := make([]*User, 0, 8)
- return users, sess.Find(&users)
- }
-
- // NewGitSig generates and returns the signature of given user.
- func (u *User) NewGitSig() *git.Signature {
- return &git.Signature{
- Name: u.GitName(),
- Email: u.GetEmail(),
- When: time.Now(),
- }
- }
-
- func hashPassword(passwd, salt, algo string) string {
- var tempPasswd []byte
-
- switch algo {
- case algoBcrypt:
- tempPasswd, _ = bcrypt.GenerateFromPassword([]byte(passwd), bcrypt.DefaultCost)
- return string(tempPasswd)
- case algoScrypt:
- tempPasswd, _ = scrypt.Key([]byte(passwd), []byte(salt), 65536, 16, 2, 50)
- case algoArgon2:
- tempPasswd = argon2.IDKey([]byte(passwd), []byte(salt), 2, 65536, 8, 50)
- case algoPbkdf2:
- fallthrough
- default:
- tempPasswd = pbkdf2.Key([]byte(passwd), []byte(salt), 10000, 50, sha256.New)
- }
-
- return fmt.Sprintf("%x", tempPasswd)
- }
-
- // SetPassword hashes a password using the algorithm defined in the config value of PASSWORD_HASH_ALGO
- // change passwd, salt and passwd_hash_algo fields
- func (u *User) SetPassword(passwd string) (err error) {
- if len(passwd) == 0 {
- u.Passwd = ""
- u.Salt = ""
- u.PasswdHashAlgo = ""
- return nil
- }
-
- if u.Salt, err = GetUserSalt(); err != nil {
- return err
- }
- u.PasswdHashAlgo = setting.PasswordHashAlgo
- u.Passwd = hashPassword(passwd, u.Salt, setting.PasswordHashAlgo)
-
- return nil
- }
-
- // ValidatePassword checks if given password matches the one belongs to the user.
- func (u *User) ValidatePassword(passwd string) bool {
- tempHash := hashPassword(passwd, u.Salt, u.PasswdHashAlgo)
-
- if u.PasswdHashAlgo != algoBcrypt && subtle.ConstantTimeCompare([]byte(u.Passwd), []byte(tempHash)) == 1 {
- return true
- }
- if u.PasswdHashAlgo == algoBcrypt && bcrypt.CompareHashAndPassword([]byte(u.Passwd), []byte(passwd)) == nil {
- return true
- }
- return false
- }
-
- // IsPasswordSet checks if the password is set or left empty
- func (u *User) IsPasswordSet() bool {
- return len(u.Passwd) != 0
- }
-
- // IsVisibleToUser check if viewer is able to see user profile
- func (u *User) IsVisibleToUser(viewer *User) bool {
- return u.isVisibleToUser(x, viewer)
- }
-
- func (u *User) isVisibleToUser(e Engine, viewer *User) bool {
- if viewer != nil && viewer.IsAdmin {
- return true
- }
-
- switch u.Visibility {
- case structs.VisibleTypePublic:
- return true
- case structs.VisibleTypeLimited:
- if viewer == nil || viewer.IsRestricted {
- return false
- }
- return true
- case structs.VisibleTypePrivate:
- if viewer == nil || viewer.IsRestricted {
- return false
- }
-
- // If they follow - they see each over
- follower := IsFollowing(u.ID, viewer.ID)
- if follower {
- return true
- }
-
- // Now we need to check if they in some organization together
- count, err := x.Table("team_user").
- Where(
- builder.And(
- builder.Eq{"uid": viewer.ID},
- builder.Or(
- builder.Eq{"org_id": u.ID},
- builder.In("org_id",
- builder.Select("org_id").
- From("team_user", "t2").
- Where(builder.Eq{"uid": u.ID}))))).
- Count(new(TeamUser))
- if err != nil {
- return false
- }
-
- if count < 0 {
- // No common organization
- return false
- }
-
- // they are in an organization together
- return true
- }
- return false
- }
-
- // IsOrganization returns true if user is actually a organization.
- func (u *User) IsOrganization() bool {
- return u.Type == UserTypeOrganization
- }
-
- // IsUserOrgOwner returns true if user is in the owner team of given organization.
- func (u *User) IsUserOrgOwner(orgID int64) bool {
- isOwner, err := IsOrganizationOwner(orgID, u.ID)
- if err != nil {
- log.Error("IsOrganizationOwner: %v", err)
- return false
- }
- return isOwner
- }
-
- // HasMemberWithUserID returns true if user with userID is part of the u organisation.
- func (u *User) HasMemberWithUserID(userID int64) bool {
- return u.hasMemberWithUserID(x, userID)
- }
-
- func (u *User) hasMemberWithUserID(e Engine, userID int64) bool {
- isMember, err := isOrganizationMember(e, u.ID, userID)
- if err != nil {
- log.Error("IsOrganizationMember: %v", err)
- return false
- }
- return isMember
- }
-
- // IsPublicMember returns true if user public his/her membership in given organization.
- func (u *User) IsPublicMember(orgID int64) bool {
- isMember, err := IsPublicMembership(orgID, u.ID)
- if err != nil {
- log.Error("IsPublicMembership: %v", err)
- return false
- }
- return isMember
- }
-
- func (u *User) getOrganizationCount(e Engine) (int64, error) {
- return e.
- Where("uid=?", u.ID).
- Count(new(OrgUser))
- }
-
- // GetOrganizationCount returns count of membership of organization of user.
- func (u *User) GetOrganizationCount() (int64, error) {
- return u.getOrganizationCount(x)
- }
-
- // GetRepositories returns repositories that user owns, including private repositories.
- func (u *User) GetRepositories(listOpts ListOptions, names ...string) (err error) {
- u.Repos, _, err = GetUserRepositories(&SearchRepoOptions{Actor: u, Private: true, ListOptions: listOpts, LowerNames: names})
- return err
- }
-
- // GetRepositoryIDs returns repositories IDs where user owned and has unittypes
- // Caller shall check that units is not globally disabled
- func (u *User) GetRepositoryIDs(units ...UnitType) ([]int64, error) {
- var ids []int64
-
- sess := x.Table("repository").Cols("repository.id")
-
- if len(units) > 0 {
- sess = sess.Join("INNER", "repo_unit", "repository.id = repo_unit.repo_id")
- sess = sess.In("repo_unit.type", units)
- }
-
- return ids, sess.Where("owner_id = ?", u.ID).Find(&ids)
- }
-
- // GetActiveRepositoryIDs returns non-archived repositories IDs where user owned and has unittypes
- // Caller shall check that units is not globally disabled
- func (u *User) GetActiveRepositoryIDs(units ...UnitType) ([]int64, error) {
- var ids []int64
-
- sess := x.Table("repository").Cols("repository.id")
-
- if len(units) > 0 {
- sess = sess.Join("INNER", "repo_unit", "repository.id = repo_unit.repo_id")
- sess = sess.In("repo_unit.type", units)
- }
-
- sess.Where(builder.Eq{"is_archived": false})
-
- return ids, sess.Where("owner_id = ?", u.ID).GroupBy("repository.id").Find(&ids)
- }
-
- // GetOrgRepositoryIDs returns repositories IDs where user's team owned and has unittypes
- // Caller shall check that units is not globally disabled
- func (u *User) GetOrgRepositoryIDs(units ...UnitType) ([]int64, error) {
- var ids []int64
-
- if err := x.Table("repository").
- Cols("repository.id").
- Join("INNER", "team_user", "repository.owner_id = team_user.org_id").
- Join("INNER", "team_repo", "(? != ? and repository.is_private != ?) OR (team_user.team_id = team_repo.team_id AND repository.id = team_repo.repo_id)", true, u.IsRestricted, true).
- Where("team_user.uid = ?", u.ID).
- GroupBy("repository.id").Find(&ids); err != nil {
- return nil, err
- }
-
- if len(units) > 0 {
- return FilterOutRepoIdsWithoutUnitAccess(u, ids, units...)
- }
-
- return ids, nil
- }
-
- // GetActiveOrgRepositoryIDs returns non-archived repositories IDs where user's team owned and has unittypes
- // Caller shall check that units is not globally disabled
- func (u *User) GetActiveOrgRepositoryIDs(units ...UnitType) ([]int64, error) {
- var ids []int64
-
- if err := x.Table("repository").
- Cols("repository.id").
- Join("INNER", "team_user", "repository.owner_id = team_user.org_id").
- Join("INNER", "team_repo", "(? != ? and repository.is_private != ?) OR (team_user.team_id = team_repo.team_id AND repository.id = team_repo.repo_id)", true, u.IsRestricted, true).
- Where("team_user.uid = ?", u.ID).
- Where(builder.Eq{"is_archived": false}).
- GroupBy("repository.id").Find(&ids); err != nil {
- return nil, err
- }
-
- if len(units) > 0 {
- return FilterOutRepoIdsWithoutUnitAccess(u, ids, units...)
- }
-
- return ids, nil
- }
-
- // GetAccessRepoIDs returns all repositories IDs where user's or user is a team member organizations
- // Caller shall check that units is not globally disabled
- func (u *User) GetAccessRepoIDs(units ...UnitType) ([]int64, error) {
- ids, err := u.GetRepositoryIDs(units...)
- if err != nil {
- return nil, err
- }
- ids2, err := u.GetOrgRepositoryIDs(units...)
- if err != nil {
- return nil, err
- }
- return append(ids, ids2...), nil
- }
-
- // GetActiveAccessRepoIDs returns all non-archived repositories IDs where user's or user is a team member organizations
- // Caller shall check that units is not globally disabled
- func (u *User) GetActiveAccessRepoIDs(units ...UnitType) ([]int64, error) {
- ids, err := u.GetActiveRepositoryIDs(units...)
- if err != nil {
- return nil, err
- }
- ids2, err := u.GetActiveOrgRepositoryIDs(units...)
- if err != nil {
- return nil, err
- }
- return append(ids, ids2...), nil
- }
-
- // GetMirrorRepositories returns mirror repositories that user owns, including private repositories.
- func (u *User) GetMirrorRepositories() ([]*Repository, error) {
- return GetUserMirrorRepositories(u.ID)
- }
-
- // GetOwnedOrganizations returns all organizations that user owns.
- func (u *User) GetOwnedOrganizations() (err error) {
- u.OwnedOrgs, err = GetOwnedOrgsByUserID(u.ID)
- return err
- }
-
- // DisplayName returns full name if it's not empty,
- // returns username otherwise.
- func (u *User) DisplayName() string {
- trimmed := strings.TrimSpace(u.FullName)
- if len(trimmed) > 0 {
- return trimmed
- }
- return u.Name
- }
-
- // GetDisplayName returns full name if it's not empty and DEFAULT_SHOW_FULL_NAME is set,
- // returns username otherwise.
- func (u *User) GetDisplayName() string {
- if setting.UI.DefaultShowFullName {
- trimmed := strings.TrimSpace(u.FullName)
- if len(trimmed) > 0 {
- return trimmed
- }
- }
- return u.Name
- }
-
- func gitSafeName(name string) string {
- return strings.TrimSpace(strings.NewReplacer("\n", "", "<", "", ">", "").Replace(name))
- }
-
- // GitName returns a git safe name
- func (u *User) GitName() string {
- gitName := gitSafeName(u.FullName)
- if len(gitName) > 0 {
- return gitName
- }
- // Although u.Name should be safe if created in our system
- // LDAP users may have bad names
- gitName = gitSafeName(u.Name)
- if len(gitName) > 0 {
- return gitName
- }
- // Totally pathological name so it's got to be:
- return fmt.Sprintf("user-%d", u.ID)
- }
-
- // ShortName ellipses username to length
- func (u *User) ShortName(length int) string {
- return base.EllipsisString(u.Name, length)
- }
-
- // IsMailable checks if a user is eligible
- // to receive emails.
- func (u *User) IsMailable() bool {
- return u.IsActive
- }
-
- // EmailNotifications returns the User's email notification preference
- func (u *User) EmailNotifications() string {
- return u.EmailNotificationsPreference
- }
-
- // SetEmailNotifications sets the user's email notification preference
- func (u *User) SetEmailNotifications(set string) error {
- u.EmailNotificationsPreference = set
- if err := UpdateUserCols(u, "email_notifications_preference"); err != nil {
- log.Error("SetEmailNotifications: %v", err)
- return err
- }
- return nil
- }
-
- func isUserExist(e Engine, uid int64, name string) (bool, error) {
- if len(name) == 0 {
- return false, nil
- }
- return e.
- Where("id!=?", uid).
- Get(&User{LowerName: strings.ToLower(name)})
- }
-
- // IsUserExist checks if given user name exist,
- // the user name should be noncased unique.
- // If uid is presented, then check will rule out that one,
- // it is used when update a user name in settings page.
- func IsUserExist(uid int64, name string) (bool, error) {
- return isUserExist(x, uid, name)
- }
-
- // GetUserSalt returns a random user salt token.
- func GetUserSalt() (string, error) {
- return util.RandomString(10)
- }
-
- // NewGhostUser creates and returns a fake user for someone has deleted his/her account.
- func NewGhostUser() *User {
- return &User{
- ID: -1,
- Name: "Ghost",
- LowerName: "ghost",
- }
- }
-
- // NewReplaceUser creates and returns a fake user for external user
- func NewReplaceUser(name string) *User {
- return &User{
- ID: -1,
- Name: name,
- LowerName: strings.ToLower(name),
- }
- }
-
- // IsGhost check if user is fake user for a deleted account
- func (u *User) IsGhost() bool {
- if u == nil {
- return false
- }
- return u.ID == -1 && u.Name == "Ghost"
- }
-
- var (
- reservedUsernames = []string{
- ".",
- "..",
- ".well-known",
- "admin",
- "api",
- "assets",
- "attachments",
- "avatars",
- "captcha",
- "commits",
- "debug",
- "error",
- "explore",
- "favicon.ico",
- "ghost",
- "help",
- "install",
- "issues",
- "less",
- "login",
- "manifest.json",
- "metrics",
- "milestones",
- "new",
- "notifications",
- "org",
- "plugins",
- "pulls",
- "raw",
- "repo",
- "robots.txt",
- "search",
- "serviceworker.js",
- "stars",
- "template",
- "user",
- }
-
- reservedUserPatterns = []string{"*.keys", "*.gpg", "*.rss", "*.atom"}
- )
-
- // isUsableName checks if name is reserved or pattern of name is not allowed
- // based on given reserved names and patterns.
- // Names are exact match, patterns can be prefix or suffix match with placeholder '*'.
- func isUsableName(names, patterns []string, name string) error {
- name = strings.TrimSpace(strings.ToLower(name))
- if utf8.RuneCountInString(name) == 0 {
- return ErrNameEmpty
- }
-
- for i := range names {
- if name == names[i] {
- return ErrNameReserved{name}
- }
- }
-
- for _, pat := range patterns {
- if pat[0] == '*' && strings.HasSuffix(name, pat[1:]) ||
- (pat[len(pat)-1] == '*' && strings.HasPrefix(name, pat[:len(pat)-1])) {
- return ErrNamePatternNotAllowed{pat}
- }
- }
-
- return nil
- }
-
- // IsUsableUsername returns an error when a username is reserved
- func IsUsableUsername(name string) error {
- // Validate username make sure it satisfies requirement.
- if alphaDashDotPattern.MatchString(name) {
- // Note: usually this error is normally caught up earlier in the UI
- return ErrNameCharsNotAllowed{Name: name}
- }
- return isUsableName(reservedUsernames, reservedUserPatterns, name)
- }
-
- // CreateUserOverwriteOptions are an optional options who overwrite system defaults on user creation
- type CreateUserOverwriteOptions struct {
- Visibility structs.VisibleType
- }
-
- // CreateUser creates record of a new user.
- func CreateUser(u *User, overwriteDefault ...*CreateUserOverwriteOptions) (err error) {
- if err = IsUsableUsername(u.Name); err != nil {
- return err
- }
-
- // set system defaults
- u.KeepEmailPrivate = setting.Service.DefaultKeepEmailPrivate
- u.Visibility = setting.Service.DefaultUserVisibilityMode
- u.AllowCreateOrganization = setting.Service.DefaultAllowCreateOrganization && !setting.Admin.DisableRegularOrgCreation
- u.EmailNotificationsPreference = setting.Admin.DefaultEmailNotification
- u.MaxRepoCreation = -1
- u.Theme = setting.UI.DefaultTheme
-
- // overwrite defaults if set
- if len(overwriteDefault) != 0 && overwriteDefault[0] != nil {
- u.Visibility = overwriteDefault[0].Visibility
- }
-
- sess := x.NewSession()
- defer sess.Close()
- if err = sess.Begin(); err != nil {
- return err
- }
-
- // validate data
-
- if err := validateUser(u); err != nil {
- return err
- }
-
- isExist, err := isUserExist(sess, 0, u.Name)
- if err != nil {
- return err
- } else if isExist {
- return ErrUserAlreadyExist{u.Name}
- }
-
- isExist, err = isEmailUsed(sess, u.Email)
- if err != nil {
- return err
- } else if isExist {
- return ErrEmailAlreadyUsed{u.Email}
- }
-
- // prepare for database
-
- u.LowerName = strings.ToLower(u.Name)
- u.AvatarEmail = u.Email
- if u.Rands, err = GetUserSalt(); err != nil {
- return err
- }
- if err = u.SetPassword(u.Passwd); err != nil {
- return err
- }
-
- // save changes to database
-
- if err = deleteUserRedirect(sess, u.Name); err != nil {
- return err
- }
-
- if _, err = sess.Insert(u); err != nil {
- return err
- }
-
- // insert email address
- if _, err := sess.Insert(&EmailAddress{
- UID: u.ID,
- Email: u.Email,
- LowerEmail: strings.ToLower(u.Email),
- IsActivated: u.IsActive,
- IsPrimary: true,
- }); err != nil {
- return err
- }
-
- return sess.Commit()
- }
-
- func countUsers(e Engine) int64 {
- count, _ := e.
- Where("type=0").
- Count(new(User))
- return count
- }
-
- // CountUsers returns number of users.
- func CountUsers() int64 {
- return countUsers(x)
- }
-
- // get user by verify code
- func getVerifyUser(code string) (user *User) {
- if len(code) <= base.TimeLimitCodeLength {
- return nil
- }
-
- // use tail hex username query user
- hexStr := code[base.TimeLimitCodeLength:]
- if b, err := hex.DecodeString(hexStr); err == nil {
- if user, err = GetUserByName(string(b)); user != nil {
- return user
- }
- log.Error("user.getVerifyUser: %v", err)
- }
-
- return nil
- }
-
- // VerifyUserActiveCode verifies active code when active account
- func VerifyUserActiveCode(code string) (user *User) {
- minutes := setting.Service.ActiveCodeLives
-
- if user = getVerifyUser(code); user != nil {
- // time limit code
- prefix := code[:base.TimeLimitCodeLength]
- data := fmt.Sprintf("%d%s%s%s%s", user.ID, user.Email, user.LowerName, user.Passwd, user.Rands)
-
- if base.VerifyTimeLimitCode(data, minutes, prefix) {
- return user
- }
- }
- return nil
- }
-
- // VerifyActiveEmailCode verifies active email code when active account
- func VerifyActiveEmailCode(code, email string) *EmailAddress {
- minutes := setting.Service.ActiveCodeLives
-
- if user := getVerifyUser(code); user != nil {
- // time limit code
- prefix := code[:base.TimeLimitCodeLength]
- data := fmt.Sprintf("%d%s%s%s%s", user.ID, email, user.LowerName, user.Passwd, user.Rands)
-
- if base.VerifyTimeLimitCode(data, minutes, prefix) {
- emailAddress := &EmailAddress{UID: user.ID, Email: email}
- if has, _ := x.Get(emailAddress); has {
- return emailAddress
- }
- }
- }
- return nil
- }
-
- // ChangeUserName changes all corresponding setting from old user name to new one.
- func ChangeUserName(u *User, newUserName string) (err error) {
- oldUserName := u.Name
- if err = IsUsableUsername(newUserName); err != nil {
- return err
- }
-
- sess := x.NewSession()
- defer sess.Close()
- if err = sess.Begin(); err != nil {
- return err
- }
-
- isExist, err := isUserExist(sess, 0, newUserName)
- if err != nil {
- return err
- } else if isExist {
- return ErrUserAlreadyExist{newUserName}
- }
-
- if _, err = sess.Exec("UPDATE `repository` SET owner_name=? WHERE owner_name=?", newUserName, oldUserName); err != nil {
- return fmt.Errorf("Change repo owner name: %v", err)
- }
-
- // Do not fail if directory does not exist
- if err = util.Rename(UserPath(oldUserName), UserPath(newUserName)); err != nil && !os.IsNotExist(err) {
- return fmt.Errorf("Rename user directory: %v", err)
- }
-
- if err = newUserRedirect(sess, u.ID, oldUserName, newUserName); err != nil {
- return err
- }
-
- if err = sess.Commit(); err != nil {
- if err2 := util.Rename(UserPath(newUserName), UserPath(oldUserName)); err2 != nil && !os.IsNotExist(err2) {
- log.Critical("Unable to rollback directory change during failed username change from: %s to: %s. DB Error: %v. Filesystem Error: %v", oldUserName, newUserName, err, err2)
- return fmt.Errorf("failed to rollback directory change during failed username change from: %s to: %s. DB Error: %w. Filesystem Error: %v", oldUserName, newUserName, err, err2)
- }
- return err
- }
-
- return nil
- }
-
- // checkDupEmail checks whether there are the same email with the user
- func checkDupEmail(e Engine, u *User) error {
- u.Email = strings.ToLower(u.Email)
- has, err := e.
- Where("id!=?", u.ID).
- And("type=?", u.Type).
- And("email=?", u.Email).
- Get(new(User))
- if err != nil {
- return err
- } else if has {
- return ErrEmailAlreadyUsed{u.Email}
- }
- return nil
- }
-
- // validateUser check if user is valide to insert / update into database
- func validateUser(u *User) error {
- if !setting.Service.AllowedUserVisibilityModesSlice.IsAllowedVisibility(u.Visibility) {
- return fmt.Errorf("visibility Mode not allowed: %s", u.Visibility.String())
- }
-
- u.Email = strings.ToLower(u.Email)
- return ValidateEmail(u.Email)
- }
-
- func updateUser(e Engine, u *User) error {
- if err := validateUser(u); err != nil {
- return err
- }
-
- _, err := e.ID(u.ID).AllCols().Update(u)
- return err
- }
-
- // UpdateUser updates user's information.
- func UpdateUser(u *User) error {
- return updateUser(x, u)
- }
-
- // UpdateUserCols update user according special columns
- func UpdateUserCols(u *User, cols ...string) error {
- return updateUserCols(x, u, cols...)
- }
-
- func updateUserCols(e Engine, u *User, cols ...string) error {
- if err := validateUser(u); err != nil {
- return err
- }
-
- _, err := e.ID(u.ID).Cols(cols...).Update(u)
- return err
- }
-
- // UpdateUserSetting updates user's settings.
- func UpdateUserSetting(u *User) (err error) {
- sess := x.NewSession()
- defer sess.Close()
- if err = sess.Begin(); err != nil {
- return err
- }
- if !u.IsOrganization() {
- if err = checkDupEmail(sess, u); err != nil {
- return err
- }
- }
- if err = updateUser(sess, u); err != nil {
- return err
- }
- return sess.Commit()
- }
-
- // deleteBeans deletes all given beans, beans should contain delete conditions.
- func deleteBeans(e Engine, beans ...interface{}) (err error) {
- for i := range beans {
- if _, err = e.Delete(beans[i]); err != nil {
- return err
- }
- }
- return nil
- }
-
- func deleteUser(e Engine, u *User) error {
- // Note: A user owns any repository or belongs to any organization
- // cannot perform delete operation.
-
- // Check ownership of repository.
- count, err := getRepositoryCount(e, u)
- if err != nil {
- return fmt.Errorf("GetRepositoryCount: %v", err)
- } else if count > 0 {
- return ErrUserOwnRepos{UID: u.ID}
- }
-
- // Check membership of organization.
- count, err = u.getOrganizationCount(e)
- if err != nil {
- return fmt.Errorf("GetOrganizationCount: %v", err)
- } else if count > 0 {
- return ErrUserHasOrgs{UID: u.ID}
- }
-
- // ***** START: Watch *****
- watchedRepoIDs := make([]int64, 0, 10)
- if err = e.Table("watch").Cols("watch.repo_id").
- Where("watch.user_id = ?", u.ID).And("watch.mode <>?", RepoWatchModeDont).Find(&watchedRepoIDs); err != nil {
- return fmt.Errorf("get all watches: %v", err)
- }
- if _, err = e.Decr("num_watches").In("id", watchedRepoIDs).NoAutoTime().Update(new(Repository)); err != nil {
- return fmt.Errorf("decrease repository num_watches: %v", err)
- }
- // ***** END: Watch *****
-
- // ***** START: Star *****
- starredRepoIDs := make([]int64, 0, 10)
- if err = e.Table("star").Cols("star.repo_id").
- Where("star.uid = ?", u.ID).Find(&starredRepoIDs); err != nil {
- return fmt.Errorf("get all stars: %v", err)
- } else if _, err = e.Decr("num_stars").In("id", starredRepoIDs).NoAutoTime().Update(new(Repository)); err != nil {
- return fmt.Errorf("decrease repository num_stars: %v", err)
- }
- // ***** END: Star *****
-
- // ***** START: Follow *****
- followeeIDs := make([]int64, 0, 10)
- if err = e.Table("follow").Cols("follow.follow_id").
- Where("follow.user_id = ?", u.ID).Find(&followeeIDs); err != nil {
- return fmt.Errorf("get all followees: %v", err)
- } else if _, err = e.Decr("num_followers").In("id", followeeIDs).Update(new(User)); err != nil {
- return fmt.Errorf("decrease user num_followers: %v", err)
- }
-
- followerIDs := make([]int64, 0, 10)
- if err = e.Table("follow").Cols("follow.user_id").
- Where("follow.follow_id = ?", u.ID).Find(&followerIDs); err != nil {
- return fmt.Errorf("get all followers: %v", err)
- } else if _, err = e.Decr("num_following").In("id", followerIDs).Update(new(User)); err != nil {
- return fmt.Errorf("decrease user num_following: %v", err)
- }
- // ***** END: Follow *****
-
- if err = deleteBeans(e,
- &AccessToken{UID: u.ID},
- &Collaboration{UserID: u.ID},
- &Access{UserID: u.ID},
- &Watch{UserID: u.ID},
- &Star{UID: u.ID},
- &Follow{UserID: u.ID},
- &Follow{FollowID: u.ID},
- &Action{UserID: u.ID},
- &IssueUser{UID: u.ID},
- &EmailAddress{UID: u.ID},
- &UserOpenID{UID: u.ID},
- &Reaction{UserID: u.ID},
- &TeamUser{UID: u.ID},
- &Collaboration{UserID: u.ID},
- &Stopwatch{UserID: u.ID},
- ); err != nil {
- return fmt.Errorf("deleteBeans: %v", err)
- }
-
- if setting.Service.UserDeleteWithCommentsMaxTime != 0 &&
- u.CreatedUnix.AsTime().Add(setting.Service.UserDeleteWithCommentsMaxTime).After(time.Now()) {
-
- // Delete Comments
- const batchSize = 50
- for start := 0; ; start += batchSize {
- comments := make([]*Comment, 0, batchSize)
- if err = e.Where("type=? AND poster_id=?", CommentTypeComment, u.ID).Limit(batchSize, start).Find(&comments); err != nil {
- return err
- }
- if len(comments) == 0 {
- break
- }
-
- for _, comment := range comments {
- if err = deleteComment(e, comment); err != nil {
- return err
- }
- }
- }
-
- // Delete Reactions
- if err = deleteReaction(e, &ReactionOptions{Doer: u}); err != nil {
- return err
- }
- }
-
- // ***** START: PublicKey *****
- if _, err = e.Delete(&PublicKey{OwnerID: u.ID}); err != nil {
- return fmt.Errorf("deletePublicKeys: %v", err)
- }
- err = rewriteAllPublicKeys(e)
- if err != nil {
- return err
- }
- err = rewriteAllPrincipalKeys(e)
- if err != nil {
- return err
- }
- // ***** END: PublicKey *****
-
- // ***** START: GPGPublicKey *****
- keys, err := listGPGKeys(e, u.ID, ListOptions{})
- if err != nil {
- return fmt.Errorf("ListGPGKeys: %v", err)
- }
- // Delete GPGKeyImport(s).
- for _, key := range keys {
- if _, err = e.Delete(&GPGKeyImport{KeyID: key.KeyID}); err != nil {
- return fmt.Errorf("deleteGPGKeyImports: %v", err)
- }
- }
- if _, err = e.Delete(&GPGKey{OwnerID: u.ID}); err != nil {
- return fmt.Errorf("deleteGPGKeys: %v", err)
- }
- // ***** END: GPGPublicKey *****
-
- // Clear assignee.
- if err = clearAssigneeByUserID(e, u.ID); err != nil {
- return fmt.Errorf("clear assignee: %v", err)
- }
-
- // ***** START: ExternalLoginUser *****
- if err = removeAllAccountLinks(e, u); err != nil {
- return fmt.Errorf("ExternalLoginUser: %v", err)
- }
- // ***** END: ExternalLoginUser *****
-
- if _, err = e.ID(u.ID).Delete(new(User)); err != nil {
- return fmt.Errorf("Delete: %v", err)
- }
-
- // Note: There are something just cannot be roll back,
- // so just keep error logs of those operations.
- path := UserPath(u.Name)
- if err = util.RemoveAll(path); err != nil {
- err = fmt.Errorf("Failed to RemoveAll %s: %v", path, err)
- _ = createNotice(e, NoticeTask, fmt.Sprintf("delete user '%s': %v", u.Name, err))
- return err
- }
-
- if len(u.Avatar) > 0 {
- avatarPath := u.CustomAvatarRelativePath()
- if err = storage.Avatars.Delete(avatarPath); err != nil {
- err = fmt.Errorf("Failed to remove %s: %v", avatarPath, err)
- _ = createNotice(e, NoticeTask, fmt.Sprintf("delete user '%s': %v", u.Name, err))
- return err
- }
- }
-
- return nil
- }
-
- // DeleteUser completely and permanently deletes everything of a user,
- // but issues/comments/pulls will be kept and shown as someone has been deleted,
- // unless the user is younger than USER_DELETE_WITH_COMMENTS_MAX_DAYS.
- func DeleteUser(u *User) (err error) {
- if u.IsOrganization() {
- return fmt.Errorf("%s is an organization not a user", u.Name)
- }
-
- sess := x.NewSession()
- defer sess.Close()
- if err = sess.Begin(); err != nil {
- return err
- }
-
- if err = deleteUser(sess, u); err != nil {
- // Note: don't wrapper error here.
- return err
- }
-
- return sess.Commit()
- }
-
- // DeleteInactiveUsers deletes all inactive users and email addresses.
- func DeleteInactiveUsers(ctx context.Context, olderThan time.Duration) (err error) {
- users := make([]*User, 0, 10)
- if olderThan > 0 {
- if err = x.
- Where("is_active = ? and created_unix < ?", false, time.Now().Add(-olderThan).Unix()).
- Find(&users); err != nil {
- return fmt.Errorf("get all inactive users: %v", err)
- }
- } else {
- if err = x.
- Where("is_active = ?", false).
- Find(&users); err != nil {
- return fmt.Errorf("get all inactive users: %v", err)
- }
- }
- // FIXME: should only update authorized_keys file once after all deletions.
- for _, u := range users {
- select {
- case <-ctx.Done():
- return ErrCancelledf("Before delete inactive user %s", u.Name)
- default:
- }
- if err = DeleteUser(u); err != nil {
- // Ignore users that were set inactive by admin.
- if IsErrUserOwnRepos(err) || IsErrUserHasOrgs(err) {
- continue
- }
- return err
- }
- }
-
- _, err = x.
- Where("is_activated = ?", false).
- Delete(new(EmailAddress))
- return err
- }
-
- // UserPath returns the path absolute path of user repositories.
- func UserPath(userName string) string {
- return filepath.Join(setting.RepoRootPath, strings.ToLower(userName))
- }
-
- func getUserByID(e Engine, id int64) (*User, error) {
- u := new(User)
- has, err := e.ID(id).Get(u)
- if err != nil {
- return nil, err
- } else if !has {
- return nil, ErrUserNotExist{id, "", 0}
- }
- return u, nil
- }
-
- // GetUserByID returns the user object by given ID if exists.
- func GetUserByID(id int64) (*User, error) {
- return getUserByID(x, id)
- }
-
- // GetUserByName returns user by given name.
- func GetUserByName(name string) (*User, error) {
- return getUserByName(x, name)
- }
-
- func getUserByName(e Engine, name string) (*User, error) {
- if len(name) == 0 {
- return nil, ErrUserNotExist{0, name, 0}
- }
- u := &User{LowerName: strings.ToLower(name)}
- has, err := e.Get(u)
- if err != nil {
- return nil, err
- } else if !has {
- return nil, ErrUserNotExist{0, name, 0}
- }
- return u, nil
- }
-
- // GetUserEmailsByNames returns a list of e-mails corresponds to names of users
- // that have their email notifications set to enabled or onmention.
- func GetUserEmailsByNames(names []string) []string {
- return getUserEmailsByNames(x, names)
- }
-
- func getUserEmailsByNames(e Engine, names []string) []string {
- mails := make([]string, 0, len(names))
- for _, name := range names {
- u, err := getUserByName(e, name)
- if err != nil {
- continue
- }
- if u.IsMailable() && u.EmailNotifications() != EmailNotificationsDisabled {
- mails = append(mails, u.Email)
- }
- }
- return mails
- }
-
- // GetMaileableUsersByIDs gets users from ids, but only if they can receive mails
- func GetMaileableUsersByIDs(ids []int64, isMention bool) ([]*User, error) {
- if len(ids) == 0 {
- return nil, nil
- }
- ous := make([]*User, 0, len(ids))
-
- if isMention {
- return ous, x.In("id", ids).
- Where("`type` = ?", UserTypeIndividual).
- And("`prohibit_login` = ?", false).
- And("`is_active` = ?", true).
- And("`email_notifications_preference` IN ( ?, ?)", EmailNotificationsEnabled, EmailNotificationsOnMention).
- Find(&ous)
- }
-
- return ous, x.In("id", ids).
- Where("`type` = ?", UserTypeIndividual).
- And("`prohibit_login` = ?", false).
- And("`is_active` = ?", true).
- And("`email_notifications_preference` = ?", EmailNotificationsEnabled).
- Find(&ous)
- }
-
- // GetUserNamesByIDs returns usernames for all resolved users from a list of Ids.
- func GetUserNamesByIDs(ids []int64) ([]string, error) {
- unames := make([]string, 0, len(ids))
- err := x.In("id", ids).
- Table("user").
- Asc("name").
- Cols("name").
- Find(&unames)
- return unames, err
- }
-
- // GetUsersByIDs returns all resolved users from a list of Ids.
- func GetUsersByIDs(ids []int64) (UserList, error) {
- ous := make([]*User, 0, len(ids))
- if len(ids) == 0 {
- return ous, nil
- }
- err := x.In("id", ids).
- Asc("name").
- Find(&ous)
- return ous, err
- }
-
- // GetUserIDsByNames returns a slice of ids corresponds to names.
- func GetUserIDsByNames(names []string, ignoreNonExistent bool) ([]int64, error) {
- ids := make([]int64, 0, len(names))
- for _, name := range names {
- u, err := GetUserByName(name)
- if err != nil {
- if ignoreNonExistent {
- continue
- } else {
- return nil, err
- }
- }
- ids = append(ids, u.ID)
- }
- return ids, nil
- }
-
- // GetUsersBySource returns a list of Users for a login source
- func GetUsersBySource(s *LoginSource) ([]*User, error) {
- var users []*User
- err := x.Where("login_type = ? AND login_source = ?", s.Type, s.ID).Find(&users)
- return users, err
- }
-
- // UserCommit represents a commit with validation of user.
- type UserCommit struct {
- User *User
- *git.Commit
- }
-
- // ValidateCommitWithEmail check if author's e-mail of commit is corresponding to a user.
- func ValidateCommitWithEmail(c *git.Commit) *User {
- if c.Author == nil {
- return nil
- }
- u, err := GetUserByEmail(c.Author.Email)
- if err != nil {
- return nil
- }
- return u
- }
-
- // ValidateCommitsWithEmails checks if authors' e-mails of commits are corresponding to users.
- func ValidateCommitsWithEmails(oldCommits []*git.Commit) []*UserCommit {
- var (
- emails = make(map[string]*User)
- newCommits = make([]*UserCommit, 0, len(oldCommits))
- )
- for _, c := range oldCommits {
- var u *User
- if c.Author != nil {
- if v, ok := emails[c.Author.Email]; !ok {
- u, _ = GetUserByEmail(c.Author.Email)
- emails[c.Author.Email] = u
- } else {
- u = v
- }
- }
-
- newCommits = append(newCommits, &UserCommit{
- User: u,
- Commit: c,
- })
- }
- return newCommits
- }
-
- // GetUserByEmail returns the user object by given e-mail if exists.
- func GetUserByEmail(email string) (*User, error) {
- return GetUserByEmailContext(DefaultDBContext(), email)
- }
-
- // GetUserByEmailContext returns the user object by given e-mail if exists with db context
- func GetUserByEmailContext(ctx DBContext, email string) (*User, error) {
- if len(email) == 0 {
- return nil, ErrUserNotExist{0, email, 0}
- }
-
- email = strings.ToLower(email)
- // First try to find the user by primary email
- user := &User{Email: email}
- has, err := ctx.e.Get(user)
- if err != nil {
- return nil, err
- }
- if has {
- return user, nil
- }
-
- // Otherwise, check in alternative list for activated email addresses
- emailAddress := &EmailAddress{Email: email, IsActivated: true}
- has, err = ctx.e.Get(emailAddress)
- if err != nil {
- return nil, err
- }
- if has {
- return getUserByID(ctx.e, emailAddress.UID)
- }
-
- // Finally, if email address is the protected email address:
- if strings.HasSuffix(email, fmt.Sprintf("@%s", setting.Service.NoReplyAddress)) {
- username := strings.TrimSuffix(email, fmt.Sprintf("@%s", setting.Service.NoReplyAddress))
- user := &User{}
- has, err := ctx.e.Where("lower_name=?", username).Get(user)
- if err != nil {
- return nil, err
- }
- if has {
- return user, nil
- }
- }
-
- return nil, ErrUserNotExist{0, email, 0}
- }
-
- // GetUser checks if a user already exists
- func GetUser(user *User) (bool, error) {
- return x.Get(user)
- }
-
- // SearchUserOptions contains the options for searching
- type SearchUserOptions struct {
- ListOptions
- Keyword string
- Type UserType
- UID int64
- OrderBy SearchOrderBy
- Visible []structs.VisibleType
- Actor *User // The user doing the search
- IsActive util.OptionalBool
- SearchByEmail bool // Search by email as well as username/full name
- }
-
- func (opts *SearchUserOptions) toConds() builder.Cond {
- var cond builder.Cond = builder.Eq{"type": opts.Type}
- if len(opts.Keyword) > 0 {
- lowerKeyword := strings.ToLower(opts.Keyword)
- keywordCond := builder.Or(
- builder.Like{"lower_name", lowerKeyword},
- builder.Like{"LOWER(full_name)", lowerKeyword},
- )
- if opts.SearchByEmail {
- keywordCond = keywordCond.Or(builder.Like{"LOWER(email)", lowerKeyword})
- }
-
- cond = cond.And(keywordCond)
- }
-
- // If visibility filtered
- if len(opts.Visible) > 0 {
- cond = cond.And(builder.In("visibility", opts.Visible))
- }
-
- if opts.Actor != nil {
- var exprCond builder.Cond
- if setting.Database.UseMySQL {
- exprCond = builder.Expr("org_user.org_id = user.id")
- } else if setting.Database.UseMSSQL {
- exprCond = builder.Expr("org_user.org_id = [user].id")
- } else {
- exprCond = builder.Expr("org_user.org_id = \"user\".id")
- }
-
- // If Admin - they see all users!
- if !opts.Actor.IsAdmin {
- // Force visibility for privacy
- var accessCond builder.Cond
- if !opts.Actor.IsRestricted {
- accessCond = builder.Or(
- builder.In("id", builder.Select("org_id").From("org_user").LeftJoin("`user`", exprCond).Where(builder.And(builder.Eq{"uid": opts.Actor.ID}, builder.Eq{"visibility": structs.VisibleTypePrivate}))),
- builder.In("visibility", structs.VisibleTypePublic, structs.VisibleTypeLimited))
- } else {
- // restricted users only see orgs they are a member of
- accessCond = builder.In("id", builder.Select("org_id").From("org_user").LeftJoin("`user`", exprCond).Where(builder.And(builder.Eq{"uid": opts.Actor.ID})))
- }
- // Don't forget about self
- accessCond = accessCond.Or(builder.Eq{"id": opts.Actor.ID})
- cond = cond.And(accessCond)
- }
-
- } else {
- // Force visibility for privacy
- // Not logged in - only public users
- cond = cond.And(builder.In("visibility", structs.VisibleTypePublic))
- }
-
- if opts.UID > 0 {
- cond = cond.And(builder.Eq{"id": opts.UID})
- }
-
- if !opts.IsActive.IsNone() {
- cond = cond.And(builder.Eq{"is_active": opts.IsActive.IsTrue()})
- }
-
- return cond
- }
-
- // SearchUsers takes options i.e. keyword and part of user name to search,
- // it returns results in given range and number of total results.
- func SearchUsers(opts *SearchUserOptions) (users []*User, _ int64, _ error) {
- cond := opts.toConds()
- count, err := x.Where(cond).Count(new(User))
- if err != nil {
- return nil, 0, fmt.Errorf("Count: %v", err)
- }
-
- if len(opts.OrderBy) == 0 {
- opts.OrderBy = SearchOrderByAlphabetically
- }
-
- sess := x.Where(cond).OrderBy(opts.OrderBy.String())
- if opts.Page != 0 {
- sess = opts.setSessionPagination(sess)
- }
-
- users = make([]*User, 0, opts.PageSize)
- return users, count, sess.Find(&users)
- }
-
- // GetStarredRepos returns the repos starred by a particular user
- func GetStarredRepos(userID int64, private bool, listOptions ListOptions) ([]*Repository, error) {
- sess := x.Where("star.uid=?", userID).
- Join("LEFT", "star", "`repository`.id=`star`.repo_id")
- if !private {
- sess = sess.And("is_private=?", false)
- }
-
- if listOptions.Page != 0 {
- sess = listOptions.setSessionPagination(sess)
-
- repos := make([]*Repository, 0, listOptions.PageSize)
- return repos, sess.Find(&repos)
- }
-
- repos := make([]*Repository, 0, 10)
- return repos, sess.Find(&repos)
- }
-
- // GetWatchedRepos returns the repos watched by a particular user
- func GetWatchedRepos(userID int64, private bool, listOptions ListOptions) ([]*Repository, int64, error) {
- sess := x.Where("watch.user_id=?", userID).
- And("`watch`.mode<>?", RepoWatchModeDont).
- Join("LEFT", "watch", "`repository`.id=`watch`.repo_id")
- if !private {
- sess = sess.And("is_private=?", false)
- }
-
- if listOptions.Page != 0 {
- sess = listOptions.setSessionPagination(sess)
-
- repos := make([]*Repository, 0, listOptions.PageSize)
- total, err := sess.FindAndCount(&repos)
- return repos, total, err
- }
-
- repos := make([]*Repository, 0, 10)
- total, err := sess.FindAndCount(&repos)
- return repos, total, err
- }
-
- // IterateUser iterate users
- func IterateUser(f func(user *User) error) error {
- var start int
- batchSize := setting.Database.IterateBufferSize
- for {
- users := make([]*User, 0, batchSize)
- if err := x.Limit(batchSize, start).Find(&users); err != nil {
- return err
- }
- if len(users) == 0 {
- return nil
- }
- start += len(users)
-
- for _, user := range users {
- if err := f(user); err != nil {
- return err
- }
- }
- }
- }
|