123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113 |
- // 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
- import (
- "bytes"
- "container/list"
- "crypto/sha256"
- "encoding/hex"
- "errors"
- "fmt"
- "image"
- _ "image/jpeg"
- "image/png"
- "os"
- "path/filepath"
- "strings"
- "time"
- "unicode/utf8"
- "github.com/Unknwon/com"
- "github.com/go-xorm/xorm"
- "github.com/nfnt/resize"
- "github.com/gogits/git-module"
- "github.com/gogits/gogs/modules/avatar"
- "github.com/gogits/gogs/modules/base"
- "github.com/gogits/gogs/modules/log"
- "github.com/gogits/gogs/modules/markdown"
- "github.com/gogits/gogs/modules/setting"
- )
- type UserType int
- const (
- USER_TYPE_INDIVIDUAL UserType = iota // Historic reason to make it starts at 0.
- USER_TYPE_ORGANIZATION
- )
- var (
- ErrUserNotKeyOwner = errors.New("User does not the owner of public key")
- ErrEmailNotExist = errors.New("E-mail does not exist")
- ErrEmailNotActivated = errors.New("E-mail address has not been activated")
- ErrUserNameIllegal = errors.New("User name contains illegal characters")
- ErrLoginSourceNotExist = errors.New("Login source does not exist")
- ErrLoginSourceNotActived = errors.New("Login source is not actived")
- ErrUnsupportedLoginType = errors.New("Login source is unknown")
- )
- // 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"`
- ShowEmail bool
- Passwd string `xorm:"NOT NULL"`
- LoginType LoginType
- LoginSource int64 `xorm:"NOT NULL DEFAULT 0"`
- LoginName string
- Type UserType
- OwnedOrgs []*User `xorm:"-"`
- Orgs []*User `xorm:"-"`
- Repos []*Repository `xorm:"-"`
- Location string
- Website string
- Rands string `xorm:"VARCHAR(10)"`
- Salt string `xorm:"VARCHAR(10)"`
- Created time.Time `xorm:"-"`
- CreatedUnix int64
- Updated time.Time `xorm:"-"`
- UpdatedUnix int64
- // Remember visibility choice for convenience, true for private
- LastRepoVisibility bool
- // Maximum repository creation limit, -1 means use gloabl default
- MaxRepoCreation int `xorm:"NOT NULL DEFAULT -1"`
- // Permissions
- IsActive bool // Activate primary email
- IsAdmin bool
- AllowGitHook bool
- AllowImportLocal bool // Allow migrate repository by local path
- ProhibitLogin bool
- // 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
- Description string
- NumTeams int
- NumMembers int
- Teams []*Team `xorm:"-"`
- Members []*User `xorm:"-"`
- }
- func (u *User) BeforeInsert() {
- u.CreatedUnix = time.Now().Unix()
- u.UpdatedUnix = u.CreatedUnix
- }
- func (u *User) BeforeUpdate() {
- if u.MaxRepoCreation < -1 {
- u.MaxRepoCreation = -1
- }
- u.UpdatedUnix = time.Now().Unix()
- }
- func (u *User) AfterSet(colName string, _ xorm.Cell) {
- switch colName {
- case "full_name":
- u.FullName = markdown.Sanitizer.Sanitize(u.FullName)
- case "created_unix":
- u.Created = time.Unix(u.CreatedUnix, 0).Local()
- case "updated_unix":
- u.Updated = time.Unix(u.UpdatedUnix, 0).Local()
- }
- }
- // returns true if user login type is LOGIN_PLAIN.
- func (u *User) IsLocal() bool {
- return u.LoginType <= LOGIN_PLAIN
- }
- // 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
- }
- func (u *User) RepoCreationNum() int {
- if u.MaxRepoCreation <= -1 {
- return setting.Repository.MaxCreationLimit
- }
- return u.MaxRepoCreation
- }
- func (u *User) CanCreateRepo() bool {
- if u.MaxRepoCreation <= -1 {
- if setting.Repository.MaxCreationLimit <= -1 {
- return true
- }
- return u.NumRepos < setting.Repository.MaxCreationLimit
- }
- return u.NumRepos < u.MaxRepoCreation
- }
- // CanEditGitHook returns true if user can edit Git hooks.
- func (u *User) CanEditGitHook() bool {
- return u.IsAdmin || u.AllowGitHook
- }
- // CanImportLocal returns true if user can migrate repository by local path.
- func (u *User) CanImportLocal() bool {
- return u.IsAdmin || u.AllowImportLocal
- }
- // DashboardLink returns the user dashboard page link.
- func (u *User) DashboardLink() string {
- if u.IsOrganization() {
- return setting.AppSubUrl + "/org/" + u.Name + "/dashboard/"
- }
- return setting.AppSubUrl + "/"
- }
- // HomeLink returns the user or organization home page link.
- func (u *User) HomeLink() string {
- return setting.AppSubUrl + "/" + 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(
- com.ToStr(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
- }
- // GenerateActivateCode generates an activate code based on user information.
- func (u *User) GenerateActivateCode() string {
- return u.GenerateEmailActivateCode(u.Email)
- }
- // CustomAvatarPath returns user custom avatar file path.
- func (u *User) CustomAvatarPath() string {
- return filepath.Join(setting.AvatarUploadPath, com.ToStr(u.ID))
- }
- // GenerateRandomAvatar generates a random avatar for user.
- func (u *User) GenerateRandomAvatar() error {
- seed := u.Email
- if len(seed) == 0 {
- seed = u.Name
- }
- img, err := avatar.RandomImage([]byte(seed))
- if err != nil {
- return fmt.Errorf("RandomImage: %v", err)
- }
- if err = os.MkdirAll(filepath.Dir(u.CustomAvatarPath()), os.ModePerm); err != nil {
- return fmt.Errorf("MkdirAll: %v", err)
- }
- fw, err := os.Create(u.CustomAvatarPath())
- if err != nil {
- return fmt.Errorf("Create: %v", err)
- }
- defer fw.Close()
- if err = png.Encode(fw, img); err != nil {
- return fmt.Errorf("Encode: %v", err)
- }
- log.Info("New random avatar created: %d", u.ID)
- return nil
- }
- func (u *User) RelAvatarLink() string {
- defaultImgUrl := "/img/avatar_default.png"
- if u.ID == -1 {
- return defaultImgUrl
- }
- switch {
- case u.UseCustomAvatar:
- if !com.IsExist(u.CustomAvatarPath()) {
- return defaultImgUrl
- }
- return "/avatars/" + com.ToStr(u.ID)
- case setting.DisableGravatar, setting.OfflineMode:
- if !com.IsExist(u.CustomAvatarPath()) {
- if err := u.GenerateRandomAvatar(); err != nil {
- log.Error(3, "GenerateRandomAvatar: %v", err)
- }
- }
- return "/avatars/" + com.ToStr(u.ID)
- }
- return setting.GravatarSource + u.Avatar
- }
- // AvatarLink returns user avatar link.
- func (u *User) AvatarLink() string {
- link := u.RelAvatarLink()
- if link[0] == '/' && link[1] != '/' {
- return strings.TrimSuffix(setting.AppUrl, "/") + link
- }
- return link
- }
- // User.GetFollwoers returns range of user's followers.
- func (u *User) GetFollowers(page int) ([]*User, error) {
- users := make([]*User, 0, ItemsPerPage)
- sess := x.Limit(ItemsPerPage, (page-1)*ItemsPerPage).Where("follow.follow_id=?", u.ID)
- if setting.UsePostgreSQL {
- sess = sess.Join("LEFT", "follow", `"user".id=follow.user_id`)
- } else {
- sess = sess.Join("LEFT", "follow", "user.id=follow.user_id")
- }
- return users, sess.Find(&users)
- }
- func (u *User) IsFollowing(followID int64) bool {
- return IsFollowing(u.ID, followID)
- }
- // GetFollowing returns range of user's following.
- func (u *User) GetFollowing(page int) ([]*User, error) {
- users := make([]*User, 0, ItemsPerPage)
- sess := x.Limit(ItemsPerPage, (page-1)*ItemsPerPage).Where("follow.user_id=?", u.ID)
- if setting.UsePostgreSQL {
- sess = sess.Join("LEFT", "follow", `"user".id=follow.follow_id`)
- } else {
- sess = sess.Join("LEFT", "follow", "user.id=follow.follow_id")
- }
- 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.Name,
- Email: u.Email,
- When: time.Now(),
- }
- }
- // EncodePasswd encodes password to safe format.
- func (u *User) EncodePasswd() {
- newPasswd := base.PBKDF2([]byte(u.Passwd), []byte(u.Salt), 10000, 50, sha256.New)
- u.Passwd = fmt.Sprintf("%x", newPasswd)
- }
- // ValidatePassword checks if given password matches the one belongs to the user.
- func (u *User) ValidatePassword(passwd string) bool {
- newUser := &User{Passwd: passwd, Salt: u.Salt}
- newUser.EncodePasswd()
- return u.Passwd == newUser.Passwd
- }
- // UploadAvatar saves custom avatar for user.
- // FIXME: split uploads to different subdirs in case we have massive users.
- func (u *User) UploadAvatar(data []byte) error {
- img, _, err := image.Decode(bytes.NewReader(data))
- if err != nil {
- return fmt.Errorf("Decode: %v", err)
- }
- m := resize.Resize(avatar.AVATAR_SIZE, avatar.AVATAR_SIZE, img, resize.NearestNeighbor)
- sess := x.NewSession()
- defer sessionRelease(sess)
- if err = sess.Begin(); err != nil {
- return err
- }
- u.UseCustomAvatar = true
- if err = updateUser(sess, u); err != nil {
- return fmt.Errorf("updateUser: %v", err)
- }
- os.MkdirAll(setting.AvatarUploadPath, os.ModePerm)
- fw, err := os.Create(u.CustomAvatarPath())
- if err != nil {
- return fmt.Errorf("Create: %v", err)
- }
- defer fw.Close()
- if err = png.Encode(fw, m); err != nil {
- return fmt.Errorf("Encode: %v", err)
- }
- return sess.Commit()
- }
- // DeleteAvatar deletes the user's custom avatar.
- func (u *User) DeleteAvatar() error {
- log.Trace("DeleteAvatar[%d]: %s", u.ID, u.CustomAvatarPath())
- os.Remove(u.CustomAvatarPath())
- u.UseCustomAvatar = false
- if err := UpdateUser(u); err != nil {
- return fmt.Errorf("UpdateUser: %v", err)
- }
- return nil
- }
- // IsAdminOfRepo returns true if user has admin or higher access of repository.
- func (u *User) IsAdminOfRepo(repo *Repository) bool {
- has, err := HasAccess(u, repo, ACCESS_MODE_ADMIN)
- if err != nil {
- log.Error(3, "HasAccess: %v", err)
- }
- return has
- }
- // IsWriterOfRepo returns true if user has write access to given repository.
- func (u *User) IsWriterOfRepo(repo *Repository) bool {
- has, err := HasAccess(u, repo, ACCESS_MODE_WRITE)
- if err != nil {
- log.Error(3, "HasAccess: %v", err)
- }
- return has
- }
- // IsOrganization returns true if user is actually a organization.
- func (u *User) IsOrganization() bool {
- return u.Type == USER_TYPE_ORGANIZATION
- }
- // IsUserOrgOwner returns true if user is in the owner team of given organization.
- func (u *User) IsUserOrgOwner(orgId int64) bool {
- return IsOrganizationOwner(orgId, u.ID)
- }
- // IsPublicMember returns true if user public his/her membership in give organization.
- func (u *User) IsPublicMember(orgId int64) bool {
- return IsPublicMembership(orgId, u.ID)
- }
- 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(page, pageSize int) (err error) {
- u.Repos, err = GetUserRepositories(u.ID, true, page, pageSize)
- return err
- }
- // GetRepositories 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
- }
- // GetOrganizations returns all organizations that user belongs to.
- func (u *User) GetOrganizations(all bool) error {
- ous, err := GetOrgUsersByUserID(u.ID, all)
- if err != nil {
- return err
- }
- u.Orgs = make([]*User, len(ous))
- for i, ou := range ous {
- u.Orgs[i], err = GetUserByID(ou.OrgID)
- if err != nil {
- return err
- }
- }
- return nil
- }
- // DisplayName returns full name if it's not empty,
- // returns username otherwise.
- func (u *User) DisplayName() string {
- if len(u.FullName) > 0 {
- return u.FullName
- }
- return u.Name
- }
- func (u *User) ShortName(length int) string {
- return base.EllipsisString(u.Name, length)
- }
- // 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) {
- if len(name) == 0 {
- return false, nil
- }
- return x.Where("id!=?", uid).Get(&User{LowerName: strings.ToLower(name)})
- }
- // GetUserSalt returns a ramdom user salt token.
- func GetUserSalt() string {
- return base.GetRandomString(10)
- }
- // NewFakeUser creates and returns a fake user for someone has deleted his/her account.
- func NewFakeUser() *User {
- return &User{
- ID: -1,
- Name: "Someone",
- LowerName: "someone",
- }
- }
- var (
- reversedUsernames = []string{"debug", "raw", "install", "api", "avatar", "user", "org", "help", "stars", "issues", "pulls", "commits", "repo", "template", "admin", "new", ".", "..", "*.about", "*.outages", "*.tos"}
- reversedUserPatterns = []string{"*.keys"}
- )
- // isUsableName checks if name is reserved or pattern of name is not allowed
- // based on given reversed 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
- }
- func IsUsableUsername(name string) error {
- return isUsableName(reversedUsernames, reversedUserPatterns, name)
- }
- // CreateUser creates record of a new user.
- func CreateUser(u *User) (err error) {
- if err = IsUsableUsername(u.Name); err != nil {
- return err
- }
- isExist, err := IsUserExist(0, u.Name)
- if err != nil {
- return err
- } else if isExist {
- return ErrUserAlreadyExist{u.Name}
- }
- u.Email = strings.ToLower(u.Email)
- u.ShowEmail = false
- isExist, err = IsEmailUsed(u.Email)
- if err != nil {
- return err
- } else if isExist {
- return ErrEmailAlreadyUsed{u.Email}
- }
- u.LowerName = strings.ToLower(u.Name)
- u.AvatarEmail = u.Email
- u.Avatar = base.HashEmail(u.AvatarEmail)
- u.Rands = GetUserSalt()
- u.Salt = GetUserSalt()
- u.EncodePasswd()
- u.MaxRepoCreation = -1
- sess := x.NewSession()
- defer sessionRelease(sess)
- if err = sess.Begin(); err != nil {
- return err
- }
- if _, err = sess.Insert(u); err != nil {
- return err
- } else if err = os.MkdirAll(UserPath(u.Name), os.ModePerm); 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)
- }
- // Users returns number of users in given page.
- func Users(page, pageSize int) ([]*User, error) {
- users := make([]*User, 0, pageSize)
- return users, x.Limit(pageSize, (page-1)*pageSize).Where("type=0").Asc("id").Find(&users)
- }
- // get user by erify 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(4, "user.getVerifyUser: %v", err)
- }
- return nil
- }
- // verify 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 := com.ToStr(user.ID) + user.Email + user.LowerName + user.Passwd + user.Rands
- if base.VerifyTimeLimitCode(data, minutes, prefix) {
- return user
- }
- }
- return nil
- }
- // verify active 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 := com.ToStr(user.ID) + email + user.LowerName + user.Passwd + user.Rands
- if base.VerifyTimeLimitCode(data, minutes, prefix) {
- emailAddress := &EmailAddress{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) {
- if err = IsUsableUsername(newUserName); err != nil {
- return err
- }
- isExist, err := IsUserExist(0, newUserName)
- if err != nil {
- return err
- } else if isExist {
- return ErrUserAlreadyExist{newUserName}
- }
- if err = ChangeUsernameInPullRequests(u.Name, newUserName); err != nil {
- return fmt.Errorf("ChangeUsernameInPullRequests: %v", err)
- }
- // Delete all local copies of repository wiki that user owns.
- if err = x.Where("owner_id=?", u.ID).Iterate(new(Repository), func(idx int, bean interface{}) error {
- repo := bean.(*Repository)
- RemoveAllWithNotice("Delete repository wiki local copy", repo.LocalWikiPath())
- return nil
- }); err != nil {
- return fmt.Errorf("Delete repository wiki local copy: %v", err)
- }
- return os.Rename(UserPath(u.Name), UserPath(newUserName))
- }
- func updateUser(e Engine, u *User) error {
- // Organization does not need email
- if !u.IsOrganization() {
- 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}
- }
- if len(u.AvatarEmail) == 0 {
- u.AvatarEmail = u.Email
- }
- u.Avatar = base.HashEmail(u.AvatarEmail)
- }
- 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)
- u.FullName = markdown.Sanitizer.Sanitize(u.FullName)
- _, err := e.Id(u.ID).AllCols().Update(u)
- return err
- }
- // UpdateUser updates user's information.
- func UpdateUser(u *User) error {
- return updateUser(x, u)
- }
- // 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
- }
- // FIXME: need some kind of mechanism to record failure. HINT: system notice
- func deleteUser(e *xorm.Session, 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 *****
- watches := make([]*Watch, 0, 10)
- if err = e.Find(&watches, &Watch{UserID: u.ID}); err != nil {
- return fmt.Errorf("get all watches: %v", err)
- }
- for i := range watches {
- if _, err = e.Exec("UPDATE `repository` SET num_watches=num_watches-1 WHERE id=?", watches[i].RepoID); err != nil {
- return fmt.Errorf("decrease repository watch number[%d]: %v", watches[i].RepoID, err)
- }
- }
- // ***** END: Watch *****
- // ***** START: Star *****
- stars := make([]*Star, 0, 10)
- if err = e.Find(&stars, &Star{UID: u.ID}); err != nil {
- return fmt.Errorf("get all stars: %v", err)
- }
- for i := range stars {
- if _, err = e.Exec("UPDATE `repository` SET num_stars=num_stars-1 WHERE id=?", stars[i].RepoID); err != nil {
- return fmt.Errorf("decrease repository star number[%d]: %v", stars[i].RepoID, err)
- }
- }
- // ***** END: Star *****
- // ***** START: Follow *****
- followers := make([]*Follow, 0, 10)
- if err = e.Find(&followers, &Follow{UserID: u.ID}); err != nil {
- return fmt.Errorf("get all followers: %v", err)
- }
- for i := range followers {
- if _, err = e.Exec("UPDATE `user` SET num_followers=num_followers-1 WHERE id=?", followers[i].UserID); err != nil {
- return fmt.Errorf("decrease user follower number[%d]: %v", followers[i].UserID, 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{FollowID: u.ID},
- &Action{UserID: u.ID},
- &IssueUser{UID: u.ID},
- &EmailAddress{UID: u.ID},
- ); err != nil {
- return fmt.Errorf("deleteBeans: %v", err)
- }
- // ***** START: PublicKey *****
- keys := make([]*PublicKey, 0, 10)
- if err = e.Find(&keys, &PublicKey{OwnerID: u.ID}); err != nil {
- return fmt.Errorf("get all public keys: %v", err)
- }
- keyIDs := make([]int64, len(keys))
- for i := range keys {
- keyIDs[i] = keys[i].ID
- }
- if err = deletePublicKeys(e, keyIDs...); err != nil {
- return fmt.Errorf("deletePublicKeys: %v", err)
- }
- // ***** END: PublicKey *****
- // Clear assignee.
- if _, err = e.Exec("UPDATE `issue` SET assignee_id=0 WHERE assignee_id=?", u.ID); err != nil {
- return fmt.Errorf("clear assignee: %v", err)
- }
- if _, err = e.Id(u.ID).Delete(new(User)); err != nil {
- return fmt.Errorf("Delete: %v", err)
- }
- // FIXME: system notice
- // Note: There are something just cannot be roll back,
- // so just keep error logs of those operations.
- os.RemoveAll(UserPath(u.Name))
- os.Remove(u.CustomAvatarPath())
- 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.
- func DeleteUser(u *User) (err error) {
- sess := x.NewSession()
- defer sessionRelease(sess)
- if err = sess.Begin(); err != nil {
- return err
- }
- if err = deleteUser(sess, u); err != nil {
- // Note: don't wrapper error here.
- return err
- }
- if err = sess.Commit(); err != nil {
- return err
- }
- return RewriteAllPublicKeys()
- }
- // DeleteInactivateUsers deletes all inactivate users and email addresses.
- func DeleteInactivateUsers() (err error) {
- users := make([]*User, 0, 10)
- 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 {
- 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 GetUserByKeyID(keyID int64) (*User, error) {
- user := new(User)
- has, err := x.Sql("SELECT a.* FROM `user` AS a, public_key AS b WHERE a.id = b.owner_id AND b.id=?", keyID).Get(user)
- if err != nil {
- return nil, err
- } else if !has {
- return nil, ErrUserNotKeyOwner
- }
- return user, nil
- }
- 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, ""}
- }
- return u, nil
- }
- // GetUserByID returns the user object by given ID if exists.
- func GetUserByID(id int64) (*User, error) {
- return getUserByID(x, id)
- }
- // GetAssigneeByID returns the user with write access of repository by given ID.
- func GetAssigneeByID(repo *Repository, userID int64) (*User, error) {
- has, err := HasAccess(&User{ID: userID}, repo, ACCESS_MODE_WRITE)
- if err != nil {
- return nil, err
- } else if !has {
- return nil, ErrUserNotExist{userID, ""}
- }
- return GetUserByID(userID)
- }
- // GetUserByName returns user by given name.
- func GetUserByName(name string) (*User, error) {
- if len(name) == 0 {
- return nil, ErrUserNotExist{0, name}
- }
- u := &User{LowerName: strings.ToLower(name)}
- has, err := x.Get(u)
- if err != nil {
- return nil, err
- } else if !has {
- return nil, ErrUserNotExist{0, name}
- }
- return u, nil
- }
- // GetUserEmailsByNames returns a list of e-mails corresponds to names.
- func GetUserEmailsByNames(names []string) []string {
- mails := make([]string, 0, len(names))
- for _, name := range names {
- u, err := GetUserByName(name)
- if err != nil {
- continue
- }
- mails = append(mails, u.Email)
- }
- return mails
- }
- // GetUserIDsByNames returns a slice of ids corresponds to names.
- func GetUserIDsByNames(names []string) []int64 {
- ids := make([]int64, 0, len(names))
- for _, name := range names {
- u, err := GetUserByName(name)
- if err != nil {
- continue
- }
- ids = append(ids, u.ID)
- }
- return ids
- }
- // UserCommit represents a commit with validation of user.
- type UserCommit struct {
- User *User
- *git.Commit
- }
- // ValidateCommitWithEmail chceck if author's e-mail of commit is corresponsind to a user.
- func ValidateCommitWithEmail(c *git.Commit) *User {
- 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 *list.List) *list.List {
- var (
- u *User
- emails = map[string]*User{}
- newCommits = list.New()
- e = oldCommits.Front()
- )
- for e != nil {
- c := e.Value.(*git.Commit)
- if v, ok := emails[c.Author.Email]; !ok {
- u, _ = GetUserByEmail(c.Author.Email)
- emails[c.Author.Email] = u
- } else {
- u = v
- }
- newCommits.PushBack(UserCommit{
- User: u,
- Commit: c,
- })
- e = e.Next()
- }
- return newCommits
- }
- // GetUserByEmail returns the user object by given e-mail if exists.
- func GetUserByEmail(email string) (*User, error) {
- if len(email) == 0 {
- return nil, ErrUserNotExist{0, "email"}
- }
- email = strings.ToLower(email)
- // First try to find the user by primary email
- user := &User{Email: email}
- has, err := x.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 = x.Get(emailAddress)
- if err != nil {
- return nil, err
- }
- if has {
- return GetUserByID(emailAddress.UID)
- }
- return nil, ErrUserNotExist{0, email}
- }
- type SearchUserOptions struct {
- Keyword string
- Type UserType
- OrderBy string
- Page int
- PageSize int // Can be smaller than or equal to setting.UI.ExplorePagingNum
- }
- // SearchUserByName takes keyword and part of user name to search,
- // it returns results in given range and number of total results.
- func SearchUserByName(opts *SearchUserOptions) (users []*User, _ int64, _ error) {
- if len(opts.Keyword) == 0 {
- return users, 0, nil
- }
- opts.Keyword = strings.ToLower(opts.Keyword)
- if opts.PageSize <= 0 || opts.PageSize > setting.UI.ExplorePagingNum {
- opts.PageSize = setting.UI.ExplorePagingNum
- }
- if opts.Page <= 0 {
- opts.Page = 1
- }
- searchQuery := "%" + opts.Keyword + "%"
- users = make([]*User, 0, opts.PageSize)
- // Append conditions
- sess := x.Where("LOWER(lower_name) LIKE ?", searchQuery).
- Or("LOWER(full_name) LIKE ?", searchQuery).
- And("type = ?", opts.Type)
- var countSess xorm.Session
- countSess = *sess
- count, err := countSess.Count(new(User))
- if err != nil {
- return nil, 0, fmt.Errorf("Count: %v", err)
- }
- if len(opts.OrderBy) > 0 {
- sess.OrderBy(opts.OrderBy)
- }
- return users, count, sess.Limit(opts.PageSize, (opts.Page-1)*opts.PageSize).Find(&users)
- }
- // ___________ .__ .__
- // \_ _____/___ | | | | ______ _ __
- // | __)/ _ \| | | | / _ \ \/ \/ /
- // | \( <_> ) |_| |_( <_> ) /
- // \___ / \____/|____/____/\____/ \/\_/
- // \/
- // Follow represents relations of user and his/her followers.
- type Follow struct {
- ID int64 `xorm:"pk autoincr"`
- UserID int64 `xorm:"UNIQUE(follow)"`
- FollowID int64 `xorm:"UNIQUE(follow)"`
- }
- func IsFollowing(userID, followID int64) bool {
- has, _ := x.Get(&Follow{UserID: userID, FollowID: followID})
- return has
- }
- // FollowUser marks someone be another's follower.
- func FollowUser(userID, followID int64) (err error) {
- if userID == followID || IsFollowing(userID, followID) {
- return nil
- }
- sess := x.NewSession()
- defer sessionRelease(sess)
- if err = sess.Begin(); err != nil {
- return err
- }
- if _, err = sess.Insert(&Follow{UserID: userID, FollowID: followID}); err != nil {
- return err
- }
- if _, err = sess.Exec("UPDATE `user` SET num_followers = num_followers + 1 WHERE id = ?", followID); err != nil {
- return err
- }
- if _, err = sess.Exec("UPDATE `user` SET num_following = num_following + 1 WHERE id = ?", userID); err != nil {
- return err
- }
- return sess.Commit()
- }
- // UnfollowUser unmarks someone be another's follower.
- func UnfollowUser(userID, followID int64) (err error) {
- if userID == followID || !IsFollowing(userID, followID) {
- return nil
- }
- sess := x.NewSession()
- defer sessionRelease(sess)
- if err = sess.Begin(); err != nil {
- return err
- }
- if _, err = sess.Delete(&Follow{UserID: userID, FollowID: followID}); err != nil {
- return err
- }
- if _, err = sess.Exec("UPDATE `user` SET num_followers = num_followers - 1 WHERE id = ?", followID); err != nil {
- return err
- }
- if _, err = sess.Exec("UPDATE `user` SET num_following = num_following - 1 WHERE id = ?", userID); err != nil {
- return err
- }
- return sess.Commit()
- }
|