forgejo/models/user.go

563 lines
14 KiB
Go
Raw Normal View History

2014-04-10 22:20:58 +04:00
// Copyright 2014 The Gogs Authors. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
package models
import (
"crypto/sha256"
"encoding/hex"
"errors"
"fmt"
"os"
"path/filepath"
"strings"
"time"
"github.com/gogits/git"
"github.com/gogits/gogs/modules/base"
"github.com/gogits/gogs/modules/log"
2014-05-26 04:11:25 +04:00
"github.com/gogits/gogs/modules/setting"
2014-04-10 22:20:58 +04:00
)
2014-06-25 08:44:48 +04:00
type UserType int
2014-04-10 22:20:58 +04:00
const (
2014-06-25 08:44:48 +04:00
INDIVIDUAL UserType = iota // Historic reason to make it starts at 0.
ORGANIZATION
2014-04-10 22:20:58 +04:00
)
var (
2014-05-11 10:12:45 +04:00
ErrUserOwnRepos = errors.New("User still have ownership of repositories")
2014-06-27 11:37:01 +04:00
ErrUserHasOrgs = errors.New("User still have membership of organization")
2014-05-11 10:12:45 +04:00
ErrUserAlreadyExist = errors.New("User already exist")
ErrUserNotExist = errors.New("User does not exist")
2014-05-22 05:37:13 +04:00
ErrUserNotKeyOwner = errors.New("User does not the owner of public key")
2014-05-11 10:12:45 +04:00
ErrEmailAlreadyUsed = errors.New("E-mail already used")
ErrUserNameIllegal = errors.New("User name contains illegal characters")
ErrLoginSourceNotExist = errors.New("Login source does not exist")
ErrLoginSourceNotActived = errors.New("Login source is not actived")
2014-05-15 22:46:04 +04:00
ErrUnsupportedLoginType = errors.New("Login source is unknown")
2014-04-10 22:20:58 +04:00
)
// User represents the object of individual and member of organization.
type User struct {
Id int64
LowerName string `xorm:"unique not null"`
Name string `xorm:"unique not null"`
2014-05-01 16:26:41 +04:00
FullName string
2014-04-10 22:20:58 +04:00
Email string `xorm:"unique not null"`
Passwd string `xorm:"not null"`
LoginType LoginType
2014-05-05 12:40:25 +04:00
LoginSource int64 `xorm:"not null default 0"`
2014-05-11 07:56:04 +04:00
LoginName string
2014-06-25 08:44:48 +04:00
Type UserType
Orgs []*User `xorm:"-"`
2014-04-10 22:20:58 +04:00
NumFollowers int
NumFollowings int
NumStars int
NumRepos int
Avatar string `xorm:"varchar(2048) not null"`
AvatarEmail string `xorm:"not null"`
Location string
Website string
IsActive bool
IsAdmin bool
Rands string `xorm:"VARCHAR(10)"`
Salt string `xorm:"VARCHAR(10)"`
Created time.Time `xorm:"created"`
Updated time.Time `xorm:"updated"`
2014-06-25 08:44:48 +04:00
// For organization.
2014-06-27 11:37:01 +04:00
Description string
NumTeams int
NumMembers int
2014-06-28 23:43:25 +04:00
Teams []*Team `xorm:"-"`
Members []*User `xorm:"-"`
2014-04-10 22:20:58 +04:00
}
// HomeLink returns the user home page link.
2014-06-25 08:44:48 +04:00
func (u *User) HomeLink() string {
return "/user/" + u.Name
2014-04-10 22:20:58 +04:00
}
2014-06-06 06:07:35 +04:00
// AvatarLink returns user gravatar link.
2014-06-25 08:44:48 +04:00
func (u *User) AvatarLink() string {
2014-05-26 04:11:25 +04:00
if setting.DisableGravatar {
2014-05-02 05:30:04 +04:00
return "/img/avatar_default.jpg"
2014-05-26 04:11:25 +04:00
} else if setting.Service.EnableCacheAvatar {
2014-06-25 08:44:48 +04:00
return "/avatar/" + u.Avatar
2014-04-10 22:20:58 +04:00
}
2014-06-25 08:44:48 +04:00
return "//1.gravatar.com/avatar/" + u.Avatar
2014-04-10 22:20:58 +04:00
}
// NewGitSig generates and returns the signature of given user.
2014-06-25 08:44:48 +04:00
func (u *User) NewGitSig() *git.Signature {
2014-04-10 22:20:58 +04:00
return &git.Signature{
2014-06-25 08:44:48 +04:00
Name: u.Name,
Email: u.Email,
2014-04-10 22:20:58 +04:00
When: time.Now(),
}
}
// EncodePasswd encodes password to safe format.
2014-06-25 08:44:48 +04:00
func (u *User) EncodePasswd() {
newPasswd := base.PBKDF2([]byte(u.Passwd), []byte(u.Salt), 10000, 50, sha256.New)
u.Passwd = fmt.Sprintf("%x", newPasswd)
}
2014-06-28 08:40:07 +04:00
// IsOrganization returns true if user is actually a organization.
2014-06-25 08:44:48 +04:00
func (u *User) IsOrganization() bool {
return u.Type == ORGANIZATION
}
2014-06-28 23:43:25 +04:00
// GetOrganizationCount returns count of membership of organization of user.
func (u *User) GetOrganizationCount() (int64, error) {
return x.Where("uid=?", u.Id).Count(new(OrgUser))
}
2014-06-28 08:40:07 +04:00
// GetOrganizations returns all organizations that user belongs to.
2014-06-25 08:44:48 +04:00
func (u *User) GetOrganizations() error {
ous, err := GetOrgUsersByUserId(u.Id)
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
2014-04-10 22:20:58 +04:00
}
// IsUserExist checks if given user name exist,
// the user name should be noncased unique.
func IsUserExist(name string) (bool, error) {
if len(name) == 0 {
return false, nil
}
2014-06-21 08:51:41 +04:00
return x.Get(&User{LowerName: strings.ToLower(name)})
2014-04-10 22:20:58 +04:00
}
// IsEmailUsed returns true if the e-mail has been used.
func IsEmailUsed(email string) (bool, error) {
if len(email) == 0 {
return false, nil
}
2014-06-21 08:51:41 +04:00
return x.Get(&User{Email: email})
2014-04-10 22:20:58 +04:00
}
2014-06-02 05:47:48 +04:00
// GetUserSalt returns a user salt token
2014-04-10 22:20:58 +04:00
func GetUserSalt() string {
return base.GetRandomString(10)
}
2014-06-25 08:44:48 +04:00
// CreateUser creates record of a new user.
func CreateUser(u *User) (*User, error) {
if !IsLegalName(u.Name) {
return nil, ErrUserNameIllegal
}
isExist, err := IsUserExist(u.Name)
if err != nil {
return nil, err
} else if isExist {
return nil, ErrUserAlreadyExist
}
isExist, err = IsEmailUsed(u.Email)
if err != nil {
return nil, err
} else if isExist {
return nil, ErrEmailAlreadyUsed
}
u.LowerName = strings.ToLower(u.Name)
u.Avatar = base.EncodeMd5(u.Email)
u.AvatarEmail = u.Email
u.Rands = GetUserSalt()
u.Salt = GetUserSalt()
u.EncodePasswd()
sess := x.NewSession()
defer sess.Close()
if err = sess.Begin(); err != nil {
return nil, err
}
if _, err = sess.Insert(u); err != nil {
sess.Rollback()
return nil, err
}
if err = os.MkdirAll(UserPath(u.Name), os.ModePerm); err != nil {
sess.Rollback()
return nil, err
}
if err = sess.Commit(); err != nil {
return nil, err
}
2014-06-25 08:44:48 +04:00
// Auto-set admin for user whose ID is 1.
if u.Id == 1 {
u.IsAdmin = true
u.IsActive = true
_, err = x.Id(u.Id).UseBool().Update(u)
}
return u, err
}
// CountUsers returns number of users.
func CountUsers() int64 {
count, _ := x.Where("type=0").Count(new(User))
return count
}
2014-04-10 22:20:58 +04:00
// GetUsers returns given number of user objects with offset.
func GetUsers(num, offset int) ([]User, error) {
users := make([]User, 0, num)
2014-07-05 00:48:36 +04:00
err := x.Limit(num, offset).Where("type=0").Asc("id").Find(&users)
2014-04-10 22:20:58 +04:00
return users, err
}
// 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("user.getVerifyUser: %v", err)
}
return nil
}
// verify active code when active account
func VerifyUserActiveCode(code string) (user *User) {
2014-05-26 04:11:25 +04:00
minutes := setting.Service.ActiveCodeLives
2014-04-10 22:20:58 +04:00
if user = getVerifyUser(code); user != nil {
// time limit code
prefix := code[:base.TimeLimitCodeLength]
data := base.ToStr(user.Id) + user.Email + user.LowerName + user.Passwd + user.Rands
if base.VerifyTimeLimitCode(data, minutes, prefix) {
return user
}
}
return nil
}
// ChangeUserName changes all corresponding setting from old user name to new one.
func ChangeUserName(user *User, newUserName string) (err error) {
newUserName = strings.ToLower(newUserName)
// Update accesses of user.
accesses := make([]Access, 0, 10)
2014-06-21 08:51:41 +04:00
if err = x.Find(&accesses, &Access{UserName: user.LowerName}); err != nil {
2014-04-10 22:20:58 +04:00
return err
}
2014-06-21 08:51:41 +04:00
sess := x.NewSession()
2014-04-10 22:20:58 +04:00
defer sess.Close()
if err = sess.Begin(); err != nil {
return err
}
for i := range accesses {
accesses[i].UserName = newUserName
if strings.HasPrefix(accesses[i].RepoName, user.LowerName+"/") {
accesses[i].RepoName = strings.Replace(accesses[i].RepoName, user.LowerName, newUserName, 1)
2014-05-01 17:09:37 +04:00
}
if err = UpdateAccessWithSession(sess, &accesses[i]); err != nil {
return err
2014-04-10 22:20:58 +04:00
}
}
2014-05-24 23:28:31 +04:00
repos, err := GetRepositories(user.Id, true)
2014-04-10 22:20:58 +04:00
if err != nil {
return err
}
for i := range repos {
accesses = make([]Access, 0, 10)
// Update accesses of user repository.
2014-06-21 08:51:41 +04:00
if err = x.Find(&accesses, &Access{RepoName: user.LowerName + "/" + repos[i].LowerName}); err != nil {
2014-04-10 22:20:58 +04:00
return err
}
for j := range accesses {
2014-05-01 17:00:30 +04:00
accesses[j].UserName = newUserName
2014-04-10 22:20:58 +04:00
accesses[j].RepoName = newUserName + "/" + repos[i].LowerName
if err = UpdateAccessWithSession(sess, &accesses[j]); err != nil {
return err
}
}
}
// Change user directory name.
if err = os.Rename(UserPath(user.LowerName), UserPath(newUserName)); err != nil {
sess.Rollback()
return err
}
return sess.Commit()
}
// UpdateUser updates user's information.
2014-06-06 06:07:35 +04:00
func UpdateUser(u *User) (err error) {
u.LowerName = strings.ToLower(u.Name)
2014-04-10 22:20:58 +04:00
2014-06-06 06:07:35 +04:00
if len(u.Location) > 255 {
u.Location = u.Location[:255]
2014-04-10 22:20:58 +04:00
}
2014-06-06 06:07:35 +04:00
if len(u.Website) > 255 {
u.Website = u.Website[:255]
2014-04-10 22:20:58 +04:00
}
2014-06-27 11:37:01 +04:00
if len(u.Description) > 255 {
u.Description = u.Description[:255]
}
2014-04-10 22:20:58 +04:00
2014-06-21 08:51:41 +04:00
_, err = x.Id(u.Id).AllCols().Update(u)
2014-04-10 22:20:58 +04:00
return err
}
2014-06-28 08:40:07 +04:00
// TODO: need some kind of mechanism to record failure.
// DeleteUser completely and permanently deletes everything of user.
2014-06-27 11:37:01 +04:00
func DeleteUser(u *User) error {
2014-04-10 22:20:58 +04:00
// Check ownership of repository.
2014-06-27 11:37:01 +04:00
count, err := GetRepositoryCount(u)
2014-04-10 22:20:58 +04:00
if err != nil {
2014-06-27 11:37:01 +04:00
return errors.New("modesl.GetRepositories(GetRepositoryCount): " + err.Error())
2014-04-10 22:20:58 +04:00
} else if count > 0 {
return ErrUserOwnRepos
}
2014-06-27 11:37:01 +04:00
// Check membership of organization.
2014-06-28 23:43:25 +04:00
count, err = u.GetOrganizationCount()
2014-06-27 11:37:01 +04:00
if err != nil {
return errors.New("modesl.GetRepositories(GetOrganizationCount): " + err.Error())
} else if count > 0 {
return ErrUserHasOrgs
}
2014-04-10 22:20:58 +04:00
// TODO: check issues, other repos' commits
2014-06-28 08:40:07 +04:00
// TODO: roll backable in some point.
2014-04-10 22:20:58 +04:00
// Delete all followers.
2014-06-27 11:37:01 +04:00
if _, err = x.Delete(&Follow{FollowId: u.Id}); err != nil {
2014-04-10 22:20:58 +04:00
return err
}
2014-04-11 21:24:19 +04:00
// Delete oauth2.
2014-06-27 11:37:01 +04:00
if _, err = x.Delete(&Oauth2{Uid: u.Id}); err != nil {
2014-04-12 05:47:39 +04:00
return err
}
2014-04-10 22:20:58 +04:00
// Delete all feeds.
2014-06-27 11:37:01 +04:00
if _, err = x.Delete(&Action{UserId: u.Id}); err != nil {
2014-04-10 22:20:58 +04:00
return err
}
// Delete all watches.
2014-06-27 11:37:01 +04:00
if _, err = x.Delete(&Watch{UserId: u.Id}); err != nil {
2014-04-10 22:20:58 +04:00
return err
}
// Delete all accesses.
2014-06-27 11:37:01 +04:00
if _, err = x.Delete(&Access{UserName: u.LowerName}); err != nil {
2014-04-10 22:20:58 +04:00
return err
}
// Delete all SSH keys.
2014-05-07 00:28:52 +04:00
keys := make([]*PublicKey, 0, 10)
2014-06-27 11:37:01 +04:00
if err = x.Find(&keys, &PublicKey{OwnerId: u.Id}); err != nil {
2014-04-10 22:20:58 +04:00
return err
}
for _, key := range keys {
2014-05-07 00:28:52 +04:00
if err = DeletePublicKey(key); err != nil {
2014-04-10 22:20:58 +04:00
return err
}
}
// Delete user directory.
2014-06-27 11:37:01 +04:00
if err = os.RemoveAll(UserPath(u.Name)); err != nil {
2014-04-10 22:20:58 +04:00
return err
}
2014-06-27 11:37:01 +04:00
_, err = x.Delete(u)
2014-06-21 08:51:41 +04:00
return err
}
// DeleteInactivateUsers deletes all inactivate users.
func DeleteInactivateUsers() error {
_, err := x.Where("is_active=?", false).Delete(new(User))
2014-04-10 22:20:58 +04:00
return err
}
// UserPath returns the path absolute path of user repositories.
func UserPath(userName string) string {
2014-05-26 04:11:25 +04:00
return filepath.Join(setting.RepoRootPath, strings.ToLower(userName))
2014-04-10 22:20:58 +04:00
}
func GetUserByKeyId(keyId int64) (*User, error) {
user := new(User)
rawSql := "SELECT a.* FROM `user` AS a, public_key AS b WHERE a.id = b.owner_id AND b.id=?"
2014-06-21 08:51:41 +04:00
has, err := x.Sql(rawSql, keyId).Get(user)
2014-04-10 22:20:58 +04:00
if err != nil {
return nil, err
} else if !has {
2014-05-22 05:37:13 +04:00
return nil, ErrUserNotKeyOwner
2014-04-10 22:20:58 +04:00
}
return user, nil
}
2014-06-06 06:07:35 +04:00
// GetUserById returns the user object by given ID if exists.
2014-04-10 22:20:58 +04:00
func GetUserById(id int64) (*User, error) {
2014-06-06 06:07:35 +04:00
u := new(User)
2014-06-21 08:51:41 +04:00
has, err := x.Id(id).Get(u)
2014-04-10 22:20:58 +04:00
if err != nil {
return nil, err
2014-06-06 06:07:35 +04:00
} else if !has {
2014-04-10 22:20:58 +04:00
return nil, ErrUserNotExist
}
2014-06-06 06:07:35 +04:00
return u, nil
2014-04-10 22:20:58 +04:00
}
// GetUserByName returns the user object by given name if exists.
func GetUserByName(name string) (*User, error) {
if len(name) == 0 {
return nil, ErrUserNotExist
}
user := &User{LowerName: strings.ToLower(name)}
2014-06-21 08:51:41 +04:00
has, err := x.Get(user)
2014-04-10 22:20:58 +04:00
if err != nil {
return nil, err
} else if !has {
return nil, ErrUserNotExist
}
return user, nil
}
// GetUserEmailsByNames returns a slice 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
}
2014-04-10 22:20:58 +04:00
// GetUserByEmail returns the user object by given e-mail if exists.
func GetUserByEmail(email string) (*User, error) {
if len(email) == 0 {
return nil, ErrUserNotExist
}
user := &User{Email: strings.ToLower(email)}
2014-06-21 08:51:41 +04:00
has, err := x.Get(user)
2014-04-10 22:20:58 +04:00
if err != nil {
return nil, err
} else if !has {
return nil, ErrUserNotExist
}
return user, nil
}
2014-05-01 07:48:01 +04:00
// SearchUserByName returns given number of users whose name contains keyword.
func SearchUserByName(key string, limit int) (us []*User, err error) {
// Prevent SQL inject.
key = strings.TrimSpace(key)
if len(key) == 0 {
return us, nil
}
key = strings.Split(key, " ")[0]
if len(key) == 0 {
return us, nil
}
key = strings.ToLower(key)
us = make([]*User, 0, limit)
2014-06-21 08:51:41 +04:00
err = x.Limit(limit).Where("lower_name like '%" + key + "%'").Find(&us)
2014-05-01 07:48:01 +04:00
return us, err
}
2014-04-10 22:20:58 +04:00
// Follow is connection request for receiving user notifycation.
type Follow struct {
Id int64
UserId int64 `xorm:"unique(follow)"`
FollowId int64 `xorm:"unique(follow)"`
}
// FollowUser marks someone be another's follower.
func FollowUser(userId int64, followId int64) (err error) {
2014-06-21 08:51:41 +04:00
session := x.NewSession()
2014-04-10 22:20:58 +04:00
defer session.Close()
session.Begin()
if _, err = session.Insert(&Follow{UserId: userId, FollowId: followId}); err != nil {
session.Rollback()
return err
}
rawSql := "UPDATE `user` SET num_followers = num_followers + 1 WHERE id = ?"
if _, err = session.Exec(rawSql, followId); err != nil {
session.Rollback()
return err
}
rawSql = "UPDATE `user` SET num_followings = num_followings + 1 WHERE id = ?"
if _, err = session.Exec(rawSql, userId); err != nil {
session.Rollback()
return err
}
return session.Commit()
}
// UnFollowUser unmarks someone be another's follower.
func UnFollowUser(userId int64, unFollowId int64) (err error) {
2014-06-21 08:51:41 +04:00
session := x.NewSession()
2014-04-10 22:20:58 +04:00
defer session.Close()
session.Begin()
if _, err = session.Delete(&Follow{UserId: userId, FollowId: unFollowId}); err != nil {
session.Rollback()
return err
}
rawSql := "UPDATE `user` SET num_followers = num_followers - 1 WHERE id = ?"
if _, err = session.Exec(rawSql, unFollowId); err != nil {
session.Rollback()
return err
}
rawSql = "UPDATE `user` SET num_followings = num_followings - 1 WHERE id = ?"
if _, err = session.Exec(rawSql, userId); err != nil {
session.Rollback()
return err
}
return session.Commit()
}