gitea/models/user.go

1691 lines
46 KiB
Go
Raw Normal View History

2014-04-10 20:20:58 +02:00
// Copyright 2014 The Gogs Authors. All rights reserved.
// Copyright 2019 The Gitea Authors. All rights reserved.
2014-04-10 20:20:58 +02:00
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
package models
import (
2014-11-21 16:58:08 +01:00
"bytes"
2014-09-23 21:30:04 +02:00
"container/list"
"crypto/md5"
2014-04-10 20:20:58 +02:00
"crypto/sha256"
"crypto/subtle"
2014-04-10 20:20:58 +02:00
"encoding/hex"
"errors"
"fmt"
2014-11-21 16:58:08 +01:00
"image"
2018-10-19 18:49:36 +02:00
2016-11-28 17:47:46 +01:00
// Needed for jpeg support
_ "image/jpeg"
2015-11-13 22:43:43 +01:00
"image/png"
2014-04-10 20:20:58 +02:00
"os"
"path/filepath"
"strings"
"time"
"unicode/utf8"
2014-04-10 20:20:58 +02:00
2014-07-26 06:24:27 +02:00
"github.com/Unknwon/com"
"github.com/go-xorm/builder"
2015-09-01 18:19:52 +02:00
"github.com/go-xorm/xorm"
2014-11-21 16:58:08 +01:00
"github.com/nfnt/resize"
"golang.org/x/crypto/pbkdf2"
"golang.org/x/crypto/ssh"
2014-04-10 20:20:58 +02:00
"code.gitea.io/git"
api "code.gitea.io/sdk/gitea"
"code.gitea.io/gitea/modules/avatar"
"code.gitea.io/gitea/modules/base"
"code.gitea.io/gitea/modules/generate"
"code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/setting"
"code.gitea.io/gitea/modules/util"
2014-04-10 20:20:58 +02:00
)
2016-11-28 17:47:46 +01:00
// UserType defines the user type
2014-06-25 06:44:48 +02:00
type UserType int
2014-04-10 20:20:58 +02:00
const (
2016-11-28 17:47:46 +01:00
// UserTypeIndividual defines an individual user
2016-11-07 17:53:22 +01:00
UserTypeIndividual UserType = iota // Historic reason to make it starts at 0.
2016-11-28 17:47:46 +01:00
// UserTypeOrganization defines an organization
2016-11-07 17:53:22 +01:00
UserTypeOrganization
2014-04-10 20:20:58 +02:00
)
2017-05-10 15:10:18 +02:00
const syncExternalUsers = "sync_external_users"
2014-04-10 20:20:58 +02:00
var (
2016-11-28 17:47:46 +01:00
// ErrUserNotKeyOwner user does not own this key error
ErrUserNotKeyOwner = errors.New("User does not own this public key")
// ErrEmailNotExist e-mail does not exist error
ErrEmailNotExist = errors.New("E-mail does not exist")
// 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
2014-05-11 08:12:45 +02:00
ErrLoginSourceNotActived = errors.New("Login source is not actived")
2016-11-28 17:47:46 +01:00
// ErrUnsupportedLoginType login source is unknown error
ErrUnsupportedLoginType = errors.New("Login source is unknown")
2014-04-10 20:20:58 +02:00
)
// User represents the object of individual and member of organization.
type User struct {
2016-07-23 19:08:22 +02:00
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
Passwd string `xorm:"NOT NULL"`
// 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:"-"`
Orgs []*User `xorm:"-"`
Repos []*Repository `xorm:"-"`
Location string
Website string
Rands string `xorm:"VARCHAR(10)"`
Salt string `xorm:"VARCHAR(10)"`
Language string `xorm:"VARCHAR(5)"`
CreatedUnix util.TimeStamp `xorm:"INDEX created"`
UpdatedUnix util.TimeStamp `xorm:"INDEX updated"`
LastLoginUnix util.TimeStamp `xorm:"INDEX"`
2014-11-21 16:58:08 +01:00
2015-10-25 09:26:26 +01:00
// Remember visibility choice for convenience, true for private
LastRepoVisibility bool
2016-11-27 12:59:12 +01:00
// Maximum repository creation limit, -1 means use global default
2015-12-10 18:48:45 +01:00
MaxRepoCreation int `xorm:"NOT NULL DEFAULT -1"`
// Permissions
2017-01-06 16:14:33 +01:00
IsActive bool `xorm:"INDEX"` // Activate primary email
IsAdmin bool
AllowGitHook bool
AllowImportLocal bool // Allow migrate repository by local path
AllowCreateOrganization bool `xorm:"DEFAULT true"`
ProhibitLogin bool `xorm:"NOT NULL DEFAULT false"`
2014-11-21 16:58:08 +01:00
// Avatar
2014-11-21 16:58:08 +01:00
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
2014-06-25 06:44:48 +02:00
// For organization
2014-06-27 09:37:01 +02:00
Description string
NumTeams int
NumMembers int
2014-06-28 21:43:25 +02:00
Teams []*Team `xorm:"-"`
Members []*User `xorm:"-"`
2016-11-13 03:54:04 +01:00
// Preferences
DiffViewStyle string `xorm:"NOT NULL DEFAULT ''"`
Theme string `xorm:"NOT NULL DEFAULT ''"`
2014-04-10 20:20:58 +02:00
}
2016-11-28 17:47:46 +01:00
// BeforeUpdate is invoked from XORM before updating this object.
2015-12-10 18:37:53 +01:00
func (u *User) BeforeUpdate() {
2015-12-10 18:46:05 +01:00
if u.MaxRepoCreation < -1 {
u.MaxRepoCreation = -1
2015-12-10 18:37:53 +01:00
}
// Organization does not need email
u.Email = strings.ToLower(u.Email)
if !u.IsOrganization() {
if len(u.AvatarEmail) == 0 {
u.AvatarEmail = u.Email
}
if len(u.AvatarEmail) > 0 && u.Avatar == "" {
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)
2015-12-10 18:37:53 +01:00
}
// 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
}
}
2016-11-28 17:47:46 +01:00
// SetLastLogin set time to last login
2016-11-09 11:53:45 +01:00
func (u *User) SetLastLogin() {
u.LastLoginUnix = util.TimeStampNow()
2016-11-09 11:53:45 +01:00
}
2016-11-28 17:47:46 +01:00
// UpdateDiffViewStyle updates the users diff view style
2016-11-13 03:54:04 +01:00
func (u *User) UpdateDiffViewStyle(style string) error {
u.DiffViewStyle = style
return UpdateUserCols(u, "diff_view_style")
2016-11-13 03:54:04 +01:00
}
// 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
}
2016-11-28 17:47:46 +01:00
// APIFormat converts a User to api.User
func (u *User) APIFormat() *api.User {
return &api.User{
ID: u.ID,
UserName: u.Name,
FullName: u.FullName,
Email: u.getEmail(),
2016-11-29 09:25:47 +01:00
AvatarURL: u.AvatarLink(),
Language: u.Language,
}
}
2016-11-28 17:47:46 +01:00
// IsLocal returns true if user login type is LoginPlain.
func (u *User) IsLocal() bool {
2016-11-07 17:30:04 +01:00
return u.LoginType <= LoginPlain
}
Oauth2 consumer (#679) * initial stuff for oauth2 login, fails on: * login button on the signIn page to start the OAuth2 flow and a callback for each provider Only GitHub is implemented for now * show login button only when the OAuth2 consumer is configured (and activated) * create macaron group for oauth2 urls * prevent net/http in modules (other then oauth2) * use a new data sessions oauth2 folder for storing the oauth2 session data * add missing 2FA when this is enabled on the user * add password option for OAuth2 user , for use with git over http and login to the GUI * add tip for registering a GitHub OAuth application * at startup of Gitea register all configured providers and also on adding/deleting of new providers * custom handling of errors in oauth2 request init + show better tip * add ExternalLoginUser model and migration script to add it to database * link a external account to an existing account (still need to handle wrong login and signup) and remove if user is removed * remove the linked external account from the user his settings * if user is unknown we allow him to register a new account or link it to some existing account * sign up with button on signin page (als change OAuth2Provider structure so we can store basic stuff about providers) * from gorilla/sessions docs: "Important Note: If you aren't using gorilla/mux, you need to wrap your handlers with context.ClearHandler as or else you will leak memory!" (we're using gorilla/sessions for storing oauth2 sessions) * use updated goth lib that now supports getting the OAuth2 user if the AccessToken is still valid instead of re-authenticating (prevent flooding the OAuth2 provider)
2017-02-22 08:14:37 +01:00
// IsOAuth2 returns true if user login type is LoginOAuth2.
func (u *User) IsOAuth2() bool {
return u.LoginType == LoginOAuth2
}
2015-11-16 16:14:12 +01:00
// HasForkedRepo checks if user has already forked a repository with given ID.
func (u *User) HasForkedRepo(repoID int64) bool {
2016-07-23 19:08:22 +02:00
_, has := HasForkedRepo(u.ID, repoID)
2015-11-16 16:14:12 +01:00
return has
}
// MaxCreationLimit returns the number of repositories a user is allowed to create
func (u *User) MaxCreationLimit() int {
2015-12-10 18:46:05 +01:00
if u.MaxRepoCreation <= -1 {
2015-12-10 18:37:53 +01:00
return setting.Repository.MaxCreationLimit
}
return u.MaxRepoCreation
}
2016-11-28 17:47:46 +01:00
// CanCreateRepo returns if user login can create a repository
2015-12-10 18:37:53 +01:00
func (u *User) CanCreateRepo() bool {
if u.IsAdmin {
return true
}
2015-12-10 18:46:05 +01:00
if u.MaxRepoCreation <= -1 {
if setting.Repository.MaxCreationLimit <= -1 {
return true
}
2015-12-10 18:37:53 +01:00
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 {
return false
}
return u.IsAdmin || u.AllowImportLocal
}
2014-07-26 06:24:27 +02:00
// DashboardLink returns the user dashboard page link.
func (u *User) DashboardLink() string {
if u.IsOrganization() {
return setting.AppSubURL + "/org/" + u.Name + "/dashboard/"
2014-07-26 06:24:27 +02:00
}
return setting.AppSubURL + "/"
2014-07-26 06:24:27 +02:00
}
2015-08-26 15:45:51 +02:00
// HomeLink returns the user or organization home page link.
2014-06-25 06:44:48 +02:00
func (u *User) HomeLink() string {
return setting.AppSubURL + "/" + u.Name
2014-04-10 20:20:58 +02:00
}
// HTMLURL returns the user or organization's full link.
func (u *User) HTMLURL() string {
return setting.AppURL + 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(
2016-07-23 19:08:22 +02:00
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)
}
2014-04-10 20:20:58 +02:00
// CustomAvatarPath returns user custom avatar file path.
func (u *User) CustomAvatarPath() string {
return filepath.Join(setting.AvatarUploadPath, u.Avatar)
}
// GenerateRandomAvatar generates a random avatar for user.
func (u *User) GenerateRandomAvatar() error {
2017-03-08 16:05:15 +01:00
return u.generateRandomAvatar(x)
}
func (u *User) generateRandomAvatar(e Engine) 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)
}
// NOTICE for random avatar, it still uses id as avatar name, but custom avatar use md5
// since random image is not a user's photo, there is no security for enumable
if u.Avatar == "" {
u.Avatar = fmt.Sprintf("%d", u.ID)
}
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 := e.ID(u.ID).Cols("avatar").Update(u); err != nil {
2017-03-08 16:05:15 +01:00
return err
}
if err = png.Encode(fw, img); err != nil {
return fmt.Errorf("Encode: %v", err)
}
2016-07-23 19:08:22 +02:00
log.Info("New random avatar created: %d", u.ID)
return nil
}
// SizedRelAvatarLink returns a relative link to the user's avatar. When
// applicable, the link is for an avatar of the indicated size (in pixels).
func (u *User) SizedRelAvatarLink(size int) string {
2016-07-23 19:08:22 +02:00
if u.ID == -1 {
2017-06-29 18:10:33 +02:00
return base.DefaultAvatarLink()
}
2014-11-21 16:58:08 +01:00
switch {
case u.UseCustomAvatar:
if !com.IsFile(u.CustomAvatarPath()) {
2017-06-29 18:10:33 +02:00
return base.DefaultAvatarLink()
}
return setting.AppSubURL + "/avatars/" + u.Avatar
case setting.DisableGravatar, setting.OfflineMode:
if !com.IsFile(u.CustomAvatarPath()) {
if err := u.GenerateRandomAvatar(); err != nil {
log.Error(3, "GenerateRandomAvatar: %v", err)
}
}
return setting.AppSubURL + "/avatars/" + u.Avatar
2014-04-10 20:20:58 +02:00
}
return base.SizedAvatarLink(u.AvatarEmail, size)
}
// RelAvatarLink returns a relative link to the user's avatar. The link
// may either be a sub-URL to this site, or a full URL to an external avatar
// service.
func (u *User) RelAvatarLink() string {
return u.SizedRelAvatarLink(base.DefaultAvatarSize)
2014-04-10 20:20:58 +02:00
}
// AvatarLink returns user avatar absolute link.
2015-08-28 17:36:13 +02:00
func (u *User) AvatarLink() string {
link := u.RelAvatarLink()
2015-09-02 11:16:30 +02:00
if link[0] == '/' && link[1] != '/' {
return setting.AppURL + strings.TrimPrefix(link, setting.AppSubURL)[1:]
2015-08-28 17:36:13 +02:00
}
return link
}
2016-11-28 17:47:46 +01:00
// GetFollowers returns range of user's followers.
func (u *User) GetFollowers(page int) ([]*User, error) {
users := make([]*User, 0, ItemsPerPage)
2016-11-10 16:16:32 +01:00
sess := x.
Limit(ItemsPerPage, (page-1)*ItemsPerPage).
2018-10-19 18:49:36 +02:00
Where("follow.follow_id=?", u.ID).
Join("LEFT", "follow", "`user`.id=follow.user_id")
return users, sess.Find(&users)
}
2016-11-28 17:47:46 +01:00
// IsFollowing returns true if user is following followID.
func (u *User) IsFollowing(followID int64) bool {
2016-07-23 19:08:22 +02:00
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)
2016-11-10 16:16:32 +01:00
sess := x.
Limit(ItemsPerPage, (page-1)*ItemsPerPage).
2018-10-19 18:49:36 +02:00
Where("follow.user_id=?", u.ID).
Join("LEFT", "follow", "`user`.id=follow.follow_id")
return users, sess.Find(&users)
}
2014-04-10 20:20:58 +02:00
// NewGitSig generates and returns the signature of given user.
2014-06-25 06:44:48 +02:00
func (u *User) NewGitSig() *git.Signature {
2014-04-10 20:20:58 +02:00
return &git.Signature{
Name: u.GitName(),
Email: u.getEmail(),
2014-04-10 20:20:58 +02:00
When: time.Now(),
}
}
func hashPassword(passwd, salt string) string {
tempPasswd := pbkdf2.Key([]byte(passwd), []byte(salt), 10000, 50, sha256.New)
return fmt.Sprintf("%x", tempPasswd)
}
// HashPassword hashes a password using PBKDF.
func (u *User) HashPassword(passwd string) {
u.Passwd = hashPassword(passwd, u.Salt)
2014-06-25 06:44:48 +02:00
}
2015-04-16 20:40:39 +02:00
// ValidatePassword checks if given password matches the one belongs to the user.
2015-04-16 20:36:32 +02:00
func (u *User) ValidatePassword(passwd string) bool {
tempHash := hashPassword(passwd, u.Salt)
return subtle.ConstantTimeCompare([]byte(u.Passwd), []byte(tempHash)) == 1
2014-08-02 19:47:33 +02:00
}
Oauth2 consumer (#679) * initial stuff for oauth2 login, fails on: * login button on the signIn page to start the OAuth2 flow and a callback for each provider Only GitHub is implemented for now * show login button only when the OAuth2 consumer is configured (and activated) * create macaron group for oauth2 urls * prevent net/http in modules (other then oauth2) * use a new data sessions oauth2 folder for storing the oauth2 session data * add missing 2FA when this is enabled on the user * add password option for OAuth2 user , for use with git over http and login to the GUI * add tip for registering a GitHub OAuth application * at startup of Gitea register all configured providers and also on adding/deleting of new providers * custom handling of errors in oauth2 request init + show better tip * add ExternalLoginUser model and migration script to add it to database * link a external account to an existing account (still need to handle wrong login and signup) and remove if user is removed * remove the linked external account from the user his settings * if user is unknown we allow him to register a new account or link it to some existing account * sign up with button on signin page (als change OAuth2Provider structure so we can store basic stuff about providers) * from gorilla/sessions docs: "Important Note: If you aren't using gorilla/mux, you need to wrap your handlers with context.ClearHandler as or else you will leak memory!" (we're using gorilla/sessions for storing oauth2 sessions) * use updated goth lib that now supports getting the OAuth2 user if the AccessToken is still valid instead of re-authenticating (prevent flooding the OAuth2 provider)
2017-02-22 08:14:37 +01:00
// IsPasswordSet checks if the password is set or left empty
func (u *User) IsPasswordSet() bool {
return !u.ValidatePassword("")
}
2014-11-21 16:58:08 +01:00
// UploadAvatar saves custom avatar for user.
2014-12-07 02:22:48 +01:00
// FIXME: split uploads to different subdirs in case we have massive users.
2014-11-21 16:58:08 +01:00
func (u *User) UploadAvatar(data []byte) error {
imgCfg, _, err := image.DecodeConfig(bytes.NewReader(data))
if err != nil {
return fmt.Errorf("DecodeConfig: %v", err)
}
if imgCfg.Width > setting.AvatarMaxWidth {
return fmt.Errorf("Image width is to large: %d > %d", imgCfg.Width, setting.AvatarMaxWidth)
}
if imgCfg.Height > setting.AvatarMaxHeight {
return fmt.Errorf("Image height is to large: %d > %d", imgCfg.Height, setting.AvatarMaxHeight)
}
2014-11-21 16:58:08 +01:00
img, _, err := image.Decode(bytes.NewReader(data))
if err != nil {
2015-11-13 22:43:43 +01:00
return fmt.Errorf("Decode: %v", err)
2014-11-21 16:58:08 +01:00
}
2016-11-25 09:37:04 +01:00
m := resize.Resize(avatar.AvatarSize, avatar.AvatarSize, img, resize.NearestNeighbor)
2014-11-21 16:58:08 +01:00
sess := x.NewSession()
defer sess.Close()
2014-11-21 16:58:08 +01:00
if err = sess.Begin(); err != nil {
return err
}
2015-11-13 22:43:43 +01:00
u.UseCustomAvatar = true
u.Avatar = fmt.Sprintf("%x", md5.Sum(data))
2015-11-13 22:43:43 +01:00
if err = updateUser(sess, u); err != nil {
return fmt.Errorf("updateUser: %v", err)
2014-11-21 16:58:08 +01:00
}
2016-12-01 00:56:15 +01:00
if err := os.MkdirAll(setting.AvatarUploadPath, os.ModePerm); err != nil {
return fmt.Errorf("Failed to create dir %s: %v", setting.AvatarUploadPath, err)
2016-12-01 00:56:15 +01:00
}
2014-11-22 16:22:53 +01:00
fw, err := os.Create(u.CustomAvatarPath())
2014-11-21 16:58:08 +01:00
if err != nil {
2015-11-13 22:43:43 +01:00
return fmt.Errorf("Create: %v", err)
2014-11-21 16:58:08 +01:00
}
defer fw.Close()
2015-11-13 22:43:43 +01:00
if err = png.Encode(fw, m); err != nil {
return fmt.Errorf("Encode: %v", err)
2014-11-21 16:58:08 +01:00
}
return sess.Commit()
}
2016-03-06 17:36:30 +01:00
// DeleteAvatar deletes the user's custom avatar.
func (u *User) DeleteAvatar() error {
2016-07-23 19:08:22 +02:00
log.Trace("DeleteAvatar[%d]: %s", u.ID, u.CustomAvatarPath())
if len(u.Avatar) > 0 {
if err := os.Remove(u.CustomAvatarPath()); err != nil {
return fmt.Errorf("Failed to remove %s: %v", u.CustomAvatarPath(), err)
}
2016-12-01 00:56:15 +01:00
}
2016-03-06 17:36:30 +01:00
u.UseCustomAvatar = false
u.Avatar = ""
if _, err := x.ID(u.ID).Cols("avatar, use_custom_avatar").Update(u); err != nil {
2016-03-06 19:24:42 +01:00
return fmt.Errorf("UpdateUser: %v", err)
2016-03-06 17:36:30 +01:00
}
return nil
}
2014-06-28 06:40:07 +02:00
// IsOrganization returns true if user is actually a organization.
2014-06-25 06:44:48 +02:00
func (u *User) IsOrganization() bool {
2016-11-07 17:53:22 +01:00
return u.Type == UserTypeOrganization
2014-06-25 06:44:48 +02:00
}
// IsUserOrgOwner returns true if user is in the owner team of given organization.
2016-11-28 17:47:46 +01:00
func (u *User) IsUserOrgOwner(orgID int64) bool {
isOwner, err := IsOrganizationOwner(orgID, u.ID)
if err != nil {
log.Error(4, "IsOrganizationOwner: %v", err)
return false
}
return isOwner
}
2017-01-20 06:16:10 +01:00
// IsPublicMember returns true if user public his/her membership in given organization.
2016-11-28 17:47:46 +01:00
func (u *User) IsPublicMember(orgID int64) bool {
isMember, err := IsPublicMembership(orgID, u.ID)
if err != nil {
log.Error(4, "IsPublicMembership: %v", err)
return false
}
return isMember
}
2015-09-06 14:54:08 +02:00
func (u *User) getOrganizationCount(e Engine) (int64, error) {
2016-11-10 16:16:32 +01:00
return e.
Where("uid=?", u.ID).
Count(new(OrgUser))
2015-09-06 14:54:08 +02:00
}
2014-06-28 21:43:25 +02:00
// GetOrganizationCount returns count of membership of organization of user.
func (u *User) GetOrganizationCount() (int64, error) {
2015-09-06 14:54:08 +02:00
return u.getOrganizationCount(x)
2014-06-28 21:43:25 +02:00
}
2016-07-24 08:32:46 +02:00
// 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
}
// GetRepositoryIDs returns repositories IDs where user owned and has unittypes
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)
}
// GetOrgRepositoryIDs returns repositories IDs where user's team owned and has unittypes
func (u *User) GetOrgRepositoryIDs(units ...UnitType) ([]int64, error) {
var ids []int64
sess := x.Table("repository").
Cols("repository.id").
Join("INNER", "team_user", "repository.owner_id = team_user.org_id").
Join("INNER", "team_repo", "repository.is_private != ? OR (team_user.team_id = team_repo.team_id AND repository.id = team_repo.repo_id)", true)
if len(units) > 0 {
sess = sess.Join("INNER", "team_unit", "team_unit.team_id = team_user.team_id")
sess = sess.In("team_unit.type", units)
}
return ids, sess.
Where("team_user.uid = ?", u.ID).
GroupBy("repository.id").Find(&ids)
}
// GetAccessRepoIDs returns all repositories IDs where user's or user is a team member organizations
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
}
2016-11-28 17:47:46 +01:00
// GetMirrorRepositories returns mirror repositories that user owns, including private repositories.
2016-07-24 08:32:46 +02:00
func (u *User) GetMirrorRepositories() ([]*Repository, error) {
return GetUserMirrorRepositories(u.ID)
}
// GetOwnedOrganizations returns all organizations that user owns.
func (u *User) GetOwnedOrganizations() (err error) {
2016-07-23 19:08:22 +02:00
u.OwnedOrgs, err = GetOwnedOrgsByUserID(u.ID)
return err
}
2014-06-28 06:40:07 +02:00
// GetOrganizations returns all organizations that user belongs to.
2015-12-17 08:28:47 +01:00
func (u *User) GetOrganizations(all bool) error {
2016-07-23 19:08:22 +02:00
ous, err := GetOrgUsersByUserID(u.ID, all)
2014-06-25 06:44:48 +02:00
if err != nil {
return err
}
u.Orgs = make([]*User, len(ous))
for i, ou := range ous {
2015-08-08 16:43:14 +02:00
u.Orgs[i], err = GetUserByID(ou.OrgID)
2014-06-25 06:44:48 +02:00
if err != nil {
return err
}
}
return nil
2014-04-10 20:20:58 +02:00
}
2015-08-27 07:26:38 +02:00
// 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
}
2015-08-27 07:26:38 +02:00
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)
}
2016-11-28 17:47:46 +01:00
// 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
}
2017-10-03 08:29:26 +02:00
func isUserExist(e Engine, uid int64, name string) (bool, error) {
2014-04-10 20:20:58 +02:00
if len(name) == 0 {
return false, nil
}
2017-10-03 08:29:26 +02:00
return e.
2016-11-10 16:16:32 +01:00
Where("id!=?", uid).
Get(&User{LowerName: strings.ToLower(name)})
2014-04-10 20:20:58 +02:00
}
2017-10-03 08:29:26 +02:00
// 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 generate.GetRandomString(10)
2014-04-10 20:20:58 +02:00
}
// NewGhostUser creates and returns a fake user for someone has deleted his/her account.
func NewGhostUser() *User {
return &User{
2016-07-23 19:08:22 +02:00
ID: -1,
Name: "Ghost",
LowerName: "ghost",
}
}
var (
reservedUsernames = []string{
"admin",
"api",
"assets",
"avatars",
"commits",
"css",
"debug",
"error",
"explore",
"help",
"img",
"install",
"issues",
"js",
"less",
"metrics",
"new",
"org",
"plugins",
"pulls",
"raw",
"repo",
"stars",
"template",
"user",
"vendor",
".",
"..",
}
reservedUserPatterns = []string{"*.keys"}
)
// 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
}
2016-11-28 17:47:46 +01:00
// IsUsableUsername returns an error when a username is reserved
func IsUsableUsername(name string) error {
return isUsableName(reservedUsernames, reservedUserPatterns, name)
}
2014-06-25 06:44:48 +02:00
// CreateUser creates record of a new user.
func CreateUser(u *User) (err error) {
if err = IsUsableUsername(u.Name); err != nil {
return err
2014-06-25 06:44:48 +02:00
}
2017-10-03 08:29:26 +02:00
sess := x.NewSession()
defer sess.Close()
if err = sess.Begin(); err != nil {
return err
}
isExist, err := isUserExist(sess, 0, u.Name)
2014-06-25 06:44:48 +02:00
if err != nil {
2014-07-26 06:24:27 +02:00
return err
2014-06-25 06:44:48 +02:00
} else if isExist {
return ErrUserAlreadyExist{u.Name}
2014-06-25 06:44:48 +02:00
}
2015-11-24 02:43:04 +01:00
u.Email = strings.ToLower(u.Email)
2017-10-03 08:29:26 +02:00
isExist, err = sess.
Where("email=?", u.Email).
Get(new(User))
if err != nil {
return err
2017-10-03 08:29:26 +02:00
} else if isExist {
return ErrEmailAlreadyUsed{u.Email}
}
2017-10-03 08:29:26 +02:00
isExist, err = isEmailUsed(sess, u.Email)
2014-06-25 06:44:48 +02:00
if err != nil {
2014-07-26 06:24:27 +02:00
return err
2014-06-25 06:44:48 +02:00
} else if isExist {
return ErrEmailAlreadyUsed{u.Email}
2014-06-25 06:44:48 +02:00
}
u.KeepEmailPrivate = setting.Service.DefaultKeepEmailPrivate
2014-06-25 06:44:48 +02:00
u.LowerName = strings.ToLower(u.Name)
u.AvatarEmail = u.Email
u.Avatar = base.HashEmail(u.AvatarEmail)
if u.Rands, err = GetUserSalt(); err != nil {
return err
}
if u.Salt, err = GetUserSalt(); err != nil {
return err
}
u.HashPassword(u.Passwd)
u.AllowCreateOrganization = setting.Service.DefaultAllowCreateOrganization
u.MaxRepoCreation = -1
u.Theme = setting.UI.DefaultTheme
u.AllowCreateOrganization = !setting.Admin.DisableRegularOrgCreation
2014-06-25 06:44:48 +02:00
if _, err = sess.Insert(u); err != nil {
2014-07-26 06:24:27 +02:00
return err
2014-06-25 06:44:48 +02:00
}
return sess.Commit()
2014-06-25 06:44:48 +02:00
}
func countUsers(e Engine) int64 {
2016-11-10 16:16:32 +01:00
count, _ := e.
Where("type=0").
Count(new(User))
return count
}
// CountUsers returns number of users.
func CountUsers() int64 {
return countUsers(x)
}
2017-01-05 01:50:34 +01:00
// get user by verify code
2014-04-10 20:20:58 +02:00
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
}
2014-07-26 06:24:27 +02:00
log.Error(4, "user.getVerifyUser: %v", err)
2014-04-10 20:20:58 +02:00
}
return nil
}
2016-11-28 17:47:46 +01:00
// VerifyUserActiveCode verifies active code when active account
2014-04-10 20:20:58 +02:00
func VerifyUserActiveCode(code string) (user *User) {
2014-05-26 02:11:25 +02:00
minutes := setting.Service.ActiveCodeLives
2014-04-10 20:20:58 +02:00
if user = getVerifyUser(code); user != nil {
// time limit code
prefix := code[:base.TimeLimitCodeLength]
2016-07-23 19:08:22 +02:00
data := com.ToStr(user.ID) + user.Email + user.LowerName + user.Passwd + user.Rands
2014-04-10 20:20:58 +02:00
if base.VerifyTimeLimitCode(data, minutes, prefix) {
return user
}
}
return nil
}
2016-11-28 17:47:46 +01:00
// 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]
2016-07-23 19:08:22 +02:00
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
}
2014-04-10 20:20:58 +02:00
// ChangeUserName changes all corresponding setting from old user name to new one.
2014-07-26 06:24:27 +02:00
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}
2014-07-26 06:24:27 +02:00
}
if err = ChangeUsernameInPullRequests(u.Name, newUserName); err != nil {
return fmt.Errorf("ChangeUsernameInPullRequests: %v", err)
2016-01-27 22:45:03 +01:00
}
// Delete all local copies of repository wiki that user owns.
if err = x.BufferSize(setting.IterateBufferSize).
2016-11-10 16:16:32 +01:00
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)
}
// Do not fail if directory does not exist
if err = os.Rename(UserPath(u.Name), UserPath(newUserName)); err != nil && !os.IsNotExist(err) {
return fmt.Errorf("Rename user directory: %v", err)
}
return nil
2014-04-10 20:20:58 +02:00
}
2017-02-25 15:53:57 +01:00
// 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
}
func updateUser(e Engine, u *User) error {
_, err := e.ID(u.ID).AllCols().Update(u)
2014-04-10 20:20:58 +02:00
return err
}
// UpdateUser updates user's information.
func UpdateUser(u *User) error {
return updateUser(x, u)
2017-02-25 15:53:57 +01:00
}
// 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 {
_, err := e.ID(u.ID).Cols(cols...).Update(u)
return err
}
2017-02-25 15:53:57 +01:00
// UpdateUserSetting updates user's settings.
func UpdateUserSetting(u *User) error {
if !u.IsOrganization() {
if err := checkDupEmail(x, u); err != nil {
return err
}
}
return updateUser(x, u)
}
2015-09-06 14:54:08 +02:00
// 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
}
2014-11-13 11:27:01 +01:00
// FIXME: need some kind of mechanism to record failure. HINT: system notice
2015-09-06 14:54:08 +02:00
func deleteUser(e *xorm.Session, u *User) error {
2015-08-17 11:05:37 +02:00
// Note: A user owns any repository or belongs to any organization
// cannot perform delete operation.
2014-04-10 20:20:58 +02:00
// Check ownership of repository.
2015-09-06 14:54:08 +02:00
count, err := getRepositoryCount(e, u)
2014-04-10 20:20:58 +02:00
if err != nil {
return fmt.Errorf("GetRepositoryCount: %v", err)
2014-04-10 20:20:58 +02:00
} else if count > 0 {
2016-07-23 19:08:22 +02:00
return ErrUserOwnRepos{UID: u.ID}
2014-04-10 20:20:58 +02:00
}
2014-06-27 09:37:01 +02:00
// Check membership of organization.
2015-09-06 14:54:08 +02:00
count, err = u.getOrganizationCount(e)
2014-06-27 09:37:01 +02:00
if err != nil {
return fmt.Errorf("GetOrganizationCount: %v", err)
2014-06-27 09:37:01 +02:00
} else if count > 0 {
2016-07-23 19:08:22 +02:00
return ErrUserHasOrgs{UID: u.ID}
2014-06-27 09:37:01 +02:00
}
2015-08-17 11:05:37 +02:00
// ***** START: Watch *****
watchedRepoIDs := make([]int64, 0, 10)
if err = e.Table("watch").Cols("watch.repo_id").
Where("watch.user_id = ?", u.ID).Find(&watchedRepoIDs); err != nil {
return fmt.Errorf("get all watches: %v", err)
2014-04-10 20:20:58 +02:00
}
if _, err = e.Decr("num_watches").In("id", watchedRepoIDs).NoAutoTime().Update(new(Repository)); err != nil {
return fmt.Errorf("decrease repository num_watches: %v", err)
2014-04-12 03:47:39 +02:00
}
2015-08-17 11:05:37 +02:00
// ***** END: Watch *****
2015-08-17 11:05:37 +02:00
// ***** 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 {
2015-08-17 11:05:37 +02:00
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)
2015-08-17 11:05:37 +02:00
}
// ***** END: Star *****
2015-08-17 11:05:37 +02:00
// ***** 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)
2015-08-17 11:05:37 +02:00
}
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)
2014-04-10 20:20:58 +02:00
}
2015-08-17 11:05:37 +02:00
// ***** END: Follow *****
2015-09-06 14:54:08 +02:00
if err = deleteBeans(e,
2016-07-23 19:08:22 +02:00
&AccessToken{UID: u.ID},
&Collaboration{UserID: u.ID},
&Access{UserID: u.ID},
&Watch{UserID: u.ID},
&Star{UID: u.ID},
&Follow{UserID: u.ID},
2016-07-23 19:08:22 +02:00
&Follow{FollowID: u.ID},
&Action{UserID: u.ID},
&IssueUser{UID: u.ID},
&EmailAddress{UID: u.ID},
2017-03-17 15:16:08 +01:00
&UserOpenID{UID: u.ID},
&Reaction{UserID: u.ID},
&TeamUser{UID: u.ID},
&Collaboration{UserID: u.ID},
&Stopwatch{UserID: u.ID},
); err != nil {
2015-12-01 02:45:55 +01:00
return fmt.Errorf("deleteBeans: %v", err)
2014-04-10 20:20:58 +02:00
}
2015-08-17 11:05:37 +02:00
// ***** START: PublicKey *****
if _, err = e.Delete(&PublicKey{OwnerID: u.ID}); err != nil {
return fmt.Errorf("deletePublicKeys: %v", err)
2014-04-10 20:20:58 +02:00
}
rewriteAllPublicKeys(e)
2015-08-17 11:05:37 +02:00
// ***** END: PublicKey *****
2014-04-10 20:20:58 +02:00
// ***** START: GPGPublicKey *****
if _, err = e.Delete(&GPGKey{OwnerID: u.ID}); err != nil {
return fmt.Errorf("deleteGPGKeys: %v", err)
}
// ***** END: GPGPublicKey *****
// Clear assignee.
2018-05-09 18:29:04 +02:00
if err = clearAssigneeByUserID(e, u.ID); err != nil {
2015-08-17 11:05:37 +02:00
return fmt.Errorf("clear assignee: %v", err)
}
Oauth2 consumer (#679) * initial stuff for oauth2 login, fails on: * login button on the signIn page to start the OAuth2 flow and a callback for each provider Only GitHub is implemented for now * show login button only when the OAuth2 consumer is configured (and activated) * create macaron group for oauth2 urls * prevent net/http in modules (other then oauth2) * use a new data sessions oauth2 folder for storing the oauth2 session data * add missing 2FA when this is enabled on the user * add password option for OAuth2 user , for use with git over http and login to the GUI * add tip for registering a GitHub OAuth application * at startup of Gitea register all configured providers and also on adding/deleting of new providers * custom handling of errors in oauth2 request init + show better tip * add ExternalLoginUser model and migration script to add it to database * link a external account to an existing account (still need to handle wrong login and signup) and remove if user is removed * remove the linked external account from the user his settings * if user is unknown we allow him to register a new account or link it to some existing account * sign up with button on signin page (als change OAuth2Provider structure so we can store basic stuff about providers) * from gorilla/sessions docs: "Important Note: If you aren't using gorilla/mux, you need to wrap your handlers with context.ClearHandler as or else you will leak memory!" (we're using gorilla/sessions for storing oauth2 sessions) * use updated goth lib that now supports getting the OAuth2 user if the AccessToken is still valid instead of re-authenticating (prevent flooding the OAuth2 provider)
2017-02-22 08:14:37 +01:00
// ***** START: ExternalLoginUser *****
if err = removeAllAccountLinks(e, u); err != nil {
Oauth2 consumer (#679) * initial stuff for oauth2 login, fails on: * login button on the signIn page to start the OAuth2 flow and a callback for each provider Only GitHub is implemented for now * show login button only when the OAuth2 consumer is configured (and activated) * create macaron group for oauth2 urls * prevent net/http in modules (other then oauth2) * use a new data sessions oauth2 folder for storing the oauth2 session data * add missing 2FA when this is enabled on the user * add password option for OAuth2 user , for use with git over http and login to the GUI * add tip for registering a GitHub OAuth application * at startup of Gitea register all configured providers and also on adding/deleting of new providers * custom handling of errors in oauth2 request init + show better tip * add ExternalLoginUser model and migration script to add it to database * link a external account to an existing account (still need to handle wrong login and signup) and remove if user is removed * remove the linked external account from the user his settings * if user is unknown we allow him to register a new account or link it to some existing account * sign up with button on signin page (als change OAuth2Provider structure so we can store basic stuff about providers) * from gorilla/sessions docs: "Important Note: If you aren't using gorilla/mux, you need to wrap your handlers with context.ClearHandler as or else you will leak memory!" (we're using gorilla/sessions for storing oauth2 sessions) * use updated goth lib that now supports getting the OAuth2 user if the AccessToken is still valid instead of re-authenticating (prevent flooding the OAuth2 provider)
2017-02-22 08:14:37 +01:00
return fmt.Errorf("ExternalLoginUser: %v", err)
}
// ***** END: ExternalLoginUser *****
if _, err = e.ID(u.ID).Delete(new(User)); err != nil {
2015-08-17 11:05:37 +02:00
return fmt.Errorf("Delete: %v", err)
}
2015-08-17 11:05:37 +02:00
// FIXME: system notice
// Note: There are something just cannot be roll back,
// so just keep error logs of those operations.
2016-12-01 00:56:15 +01:00
path := UserPath(u.Name)
2015-08-17 11:05:37 +02:00
2016-12-01 00:56:15 +01:00
if err := os.RemoveAll(path); err != nil {
return fmt.Errorf("Failed to RemoveAll %s: %v", path, err)
2016-12-01 00:56:15 +01:00
}
if len(u.Avatar) > 0 {
avatarPath := u.CustomAvatarPath()
if com.IsExist(avatarPath) {
if err := os.Remove(avatarPath); err != nil {
return fmt.Errorf("Failed to remove %s: %v", avatarPath, err)
}
}
2016-12-01 00:56:15 +01:00
}
2014-04-10 20:20:58 +02:00
2015-08-17 11:05:37 +02:00
return nil
2014-06-21 06:51:41 +02:00
}
2015-09-06 14:54:08 +02:00
// 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 sess.Close()
2015-09-06 14:54:08 +02:00
if err = sess.Begin(); err != nil {
return err
}
if err = deleteUser(sess, u); err != nil {
2015-09-13 19:26:20 +02:00
// Note: don't wrapper error here.
return err
2015-09-06 14:54:08 +02:00
}
return sess.Commit()
2015-09-06 14:54:08 +02:00
}
// DeleteInactivateUsers deletes all inactivate users and email addresses.
2015-08-17 11:05:37 +02:00
func DeleteInactivateUsers() (err error) {
users := make([]*User, 0, 10)
2016-11-10 16:16:32 +01:00
if err = x.
Where("is_active = ?", false).
Find(&users); err != nil {
2015-08-17 11:05:37 +02:00
return fmt.Errorf("get all inactive users: %v", err)
}
// FIXME: should only update authorized_keys file once after all deletions.
2015-08-17 11:05:37 +02:00
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
}
}
2015-08-17 11:05:37 +02:00
2016-11-10 16:16:32 +01:00
_, err = x.
Where("is_activated = ?", false).
Delete(new(EmailAddress))
2014-04-10 20:20:58 +02:00
return err
}
// UserPath returns the path absolute path of user repositories.
func UserPath(userName string) string {
2014-05-26 02:11:25 +02:00
return filepath.Join(setting.RepoRootPath, strings.ToLower(userName))
2014-04-10 20:20:58 +02:00
}
// GetUserByKeyID get user information by user's public key id
2015-11-05 03:57:10 +01:00
func GetUserByKeyID(keyID int64) (*User, error) {
var user User
has, err := x.Join("INNER", "public_key", "`public_key`.owner_id = `user`.id").
2016-11-10 16:16:32 +01:00
Where("`public_key`.id=?", keyID).
2016-11-12 09:30:46 +01:00
Get(&user)
if err != nil {
return nil, err
}
if !has {
return nil, ErrUserNotExist{0, "", keyID}
}
return &user, nil
2014-04-10 20:20:58 +02:00
}
2015-08-08 16:43:14 +02:00
func getUserByID(e Engine, id int64) (*User, error) {
2014-06-06 04:07:35 +02:00
u := new(User)
has, err := e.ID(id).Get(u)
2014-04-10 20:20:58 +02:00
if err != nil {
return nil, err
2014-06-06 04:07:35 +02:00
} else if !has {
return nil, ErrUserNotExist{id, "", 0}
2014-04-10 20:20:58 +02:00
}
2014-06-06 04:07:35 +02:00
return u, nil
2014-04-10 20:20:58 +02:00
}
2015-08-08 16:43:14 +02:00
// GetUserByID returns the user object by given ID if exists.
func GetUserByID(id int64) (*User, error) {
return getUserByID(x, id)
2015-02-13 06:58:46 +01:00
}
2014-10-25 00:43:17 +02:00
// GetUserByName returns user by given name.
2014-04-10 20:20:58 +02:00
func GetUserByName(name string) (*User, error) {
return getUserByName(x, name)
}
func getUserByName(e Engine, name string) (*User, error) {
2014-04-10 20:20:58 +02:00
if len(name) == 0 {
return nil, ErrUserNotExist{0, name, 0}
2014-04-10 20:20:58 +02:00
}
2014-10-25 00:43:17 +02:00
u := &User{LowerName: strings.ToLower(name)}
has, err := e.Get(u)
2014-04-10 20:20:58 +02:00
if err != nil {
return nil, err
} else if !has {
return nil, ErrUserNotExist{0, name, 0}
2014-04-10 20:20:58 +02:00
}
2014-10-25 00:43:17 +02:00
return u, nil
2014-04-10 20:20:58 +02:00
}
// GetUserEmailsByNames returns a list of e-mails corresponds to names.
2014-04-10 20:20:58 +02:00
func GetUserEmailsByNames(names []string) []string {
return getUserEmailsByNames(x, names)
}
func getUserEmailsByNames(e Engine, names []string) []string {
2014-04-10 20:20:58 +02:00
mails := make([]string, 0, len(names))
for _, name := range names {
u, err := getUserByName(e, name)
2014-04-10 20:20:58 +02:00
if err != nil {
continue
}
if u.IsMailable() {
mails = append(mails, u.Email)
}
2014-04-10 20:20:58 +02:00
}
return mails
}
// GetUsersByIDs returns all resolved users from a list of Ids.
func GetUsersByIDs(ids []int64) ([]*User, error) {
ous := make([]*User, 0, len(ids))
if len(ids) == 0 {
return ous, nil
}
err := x.In("id", ids).
2016-11-10 16:16:32 +01:00
Asc("name").
Find(&ous)
return ous, err
}
// 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
}
2016-07-23 19:08:22 +02:00
ids = append(ids, u.ID)
}
return ids
}
2014-12-07 02:22:48 +01:00
// UserCommit represents a commit with validation of user.
2014-09-23 21:30:04 +02:00
type UserCommit struct {
2014-11-21 16:58:08 +01:00
User *User
*git.Commit
2014-09-23 21:30:04 +02:00
}
2017-01-05 01:50:34 +01:00
// 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
}
2014-09-26 14:55:13 +02:00
u, err := GetUserByEmail(c.Author.Email)
2014-11-21 16:58:08 +01:00
if err != nil {
return nil
2014-09-26 14:55:13 +02:00
}
2014-11-21 16:58:08 +01:00
return u
2014-09-26 14:55:13 +02:00
}
// ValidateCommitsWithEmails checks if authors' e-mails of commits are corresponding to users.
func ValidateCommitsWithEmails(oldCommits *list.List) *list.List {
2015-08-05 11:36:22 +02:00
var (
u *User
emails = map[string]*User{}
newCommits = list.New()
e = oldCommits.Front()
)
2014-09-23 21:30:04 +02:00
for e != nil {
c := e.Value.(*git.Commit)
2014-09-23 21:30:04 +02:00
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
}
2014-09-24 05:18:14 +02:00
} else {
u = nil
2014-09-23 21:30:04 +02:00
}
newCommits.PushBack(UserCommit{
2014-11-21 16:58:08 +01:00
User: u,
Commit: c,
2014-09-23 21:30:04 +02:00
})
e = e.Next()
}
return newCommits
}
2014-04-10 20:20:58 +02: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{0, email, 0}
2014-04-10 20:20:58 +02:00
}
2015-08-05 11:36:22 +02:00
email = strings.ToLower(email)
// First try to find the user by primary email
2015-08-05 11:36:22 +02:00
user := &User{Email: email}
2014-06-21 06:51:41 +02:00
has, err := x.Get(user)
2014-04-10 20:20:58 +02:00
if err != nil {
return nil, err
}
if has {
return user, nil
}
// Otherwise, check in alternative list for activated email addresses
2015-08-05 11:36:22 +02:00
emailAddress := &EmailAddress{Email: email, IsActivated: true}
has, err = x.Get(emailAddress)
if err != nil {
return nil, err
}
if has {
2015-09-10 17:40:34 +02:00
return GetUserByID(emailAddress.UID)
}
return nil, ErrUserNotExist{0, email, 0}
2014-04-10 20:20:58 +02:00
}
Oauth2 consumer (#679) * initial stuff for oauth2 login, fails on: * login button on the signIn page to start the OAuth2 flow and a callback for each provider Only GitHub is implemented for now * show login button only when the OAuth2 consumer is configured (and activated) * create macaron group for oauth2 urls * prevent net/http in modules (other then oauth2) * use a new data sessions oauth2 folder for storing the oauth2 session data * add missing 2FA when this is enabled on the user * add password option for OAuth2 user , for use with git over http and login to the GUI * add tip for registering a GitHub OAuth application * at startup of Gitea register all configured providers and also on adding/deleting of new providers * custom handling of errors in oauth2 request init + show better tip * add ExternalLoginUser model and migration script to add it to database * link a external account to an existing account (still need to handle wrong login and signup) and remove if user is removed * remove the linked external account from the user his settings * if user is unknown we allow him to register a new account or link it to some existing account * sign up with button on signin page (als change OAuth2Provider structure so we can store basic stuff about providers) * from gorilla/sessions docs: "Important Note: If you aren't using gorilla/mux, you need to wrap your handlers with context.ClearHandler as or else you will leak memory!" (we're using gorilla/sessions for storing oauth2 sessions) * use updated goth lib that now supports getting the OAuth2 user if the AccessToken is still valid instead of re-authenticating (prevent flooding the OAuth2 provider)
2017-02-22 08:14:37 +01:00
// GetUser checks if a user already exists
func GetUser(user *User) (bool, error) {
return x.Get(user)
}
2016-11-28 17:47:46 +01:00
// SearchUserOptions contains the options for searching
type SearchUserOptions struct {
Keyword string
Type UserType
UID int64
OrderBy SearchOrderBy
Page int
PageSize int // Can be smaller than or equal to setting.UI.ExplorePagingNum
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 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)
2014-05-01 05:48:01 +02:00
}
if opts.PageSize == 0 || opts.PageSize > setting.UI.ExplorePagingNum {
opts.PageSize = setting.UI.ExplorePagingNum
}
if opts.Page <= 0 {
opts.Page = 1
2016-03-11 22:11:33 +01:00
}
if len(opts.OrderBy) == 0 {
opts.OrderBy = SearchOrderByAlphabetically
}
sess := x.Where(cond)
if opts.PageSize > 0 {
sess = sess.Limit(opts.PageSize, (opts.Page-1)*opts.PageSize)
}
users = make([]*User, 0, opts.PageSize)
return users, count, sess.OrderBy(opts.OrderBy.String()).Find(&users)
2014-05-01 05:48:01 +02:00
}
2016-11-14 23:33:58 +01:00
// GetStarredRepos returns the repos starred by a particular user
func GetStarredRepos(userID int64, private bool) ([]*Repository, error) {
sess := x.Where("star.uid=?", userID).
Join("LEFT", "star", "`repository`.id=`star`.repo_id")
if !private {
sess = sess.And("is_private=?", false)
}
repos := make([]*Repository, 0, 10)
err := sess.Find(&repos)
if err != nil {
return nil, err
}
return repos, nil
}
2016-12-24 02:53:11 +01:00
// GetWatchedRepos returns the repos watched by a particular user
func GetWatchedRepos(userID int64, private bool) ([]*Repository, error) {
sess := x.Where("watch.user_id=?", userID).
Join("LEFT", "watch", "`repository`.id=`watch`.repo_id")
if !private {
sess = sess.And("is_private=?", false)
}
repos := make([]*Repository, 0, 10)
err := sess.Find(&repos)
if err != nil {
return nil, err
}
return repos, nil
}
2017-05-10 15:10:18 +02:00
// deleteKeysMarkedForDeletion returns true if ssh keys needs update
func deleteKeysMarkedForDeletion(keys []string) (bool, error) {
// Start session
sess := x.NewSession()
defer sess.Close()
if err := sess.Begin(); err != nil {
return false, err
}
// Delete keys marked for deletion
var sshKeysNeedUpdate bool
for _, KeyToDelete := range keys {
key, err := searchPublicKeyByContentWithEngine(sess, KeyToDelete)
if err != nil {
log.Error(4, "SearchPublicKeyByContent: %v", err)
continue
}
if err = deletePublicKeys(sess, key.ID); err != nil {
log.Error(4, "deletePublicKeys: %v", err)
continue
}
sshKeysNeedUpdate = true
}
if err := sess.Commit(); err != nil {
return false, err
}
return sshKeysNeedUpdate, nil
}
// addLdapSSHPublicKeys add a users public keys. Returns true if there are changes.
func addLdapSSHPublicKeys(usr *User, s *LoginSource, SSHPublicKeys []string) bool {
var sshKeysNeedUpdate bool
for _, sshKey := range SSHPublicKeys {
_, _, _, _, err := ssh.ParseAuthorizedKey([]byte(sshKey))
if err == nil {
sshKeyName := fmt.Sprintf("%s-%s", s.Name, sshKey[0:40])
if _, err := AddPublicKey(usr.ID, sshKeyName, sshKey, s.ID); err != nil {
log.Error(4, "addLdapSSHPublicKeys[%s]: Error adding LDAP Public SSH Key for user %s: %v", s.Name, usr.Name, err)
} else {
log.Trace("addLdapSSHPublicKeys[%s]: Added LDAP Public SSH Key for user %s", s.Name, usr.Name)
sshKeysNeedUpdate = true
}
} else {
log.Warn("addLdapSSHPublicKeys[%s]: Skipping invalid LDAP Public SSH Key for user %s: %v", s.Name, usr.Name, sshKey)
}
}
return sshKeysNeedUpdate
}
// synchronizeLdapSSHPublicKeys updates a users public keys. Returns true if there are changes.
func synchronizeLdapSSHPublicKeys(usr *User, s *LoginSource, SSHPublicKeys []string) bool {
var sshKeysNeedUpdate bool
log.Trace("synchronizeLdapSSHPublicKeys[%s]: Handling LDAP Public SSH Key synchronization for user %s", s.Name, usr.Name)
// Get Public Keys from DB with current LDAP source
var giteaKeys []string
keys, err := ListPublicLdapSSHKeys(usr.ID, s.ID)
if err != nil {
log.Error(4, "synchronizeLdapSSHPublicKeys[%s]: Error listing LDAP Public SSH Keys for user %s: %v", s.Name, usr.Name, err)
}
for _, v := range keys {
giteaKeys = append(giteaKeys, v.OmitEmail())
}
// Get Public Keys from LDAP and skip duplicate keys
var ldapKeys []string
for _, v := range SSHPublicKeys {
ldapKey := strings.Join(strings.Split(v, " ")[:2], " ")
if !util.ExistsInSlice(ldapKey, ldapKeys) {
ldapKeys = append(ldapKeys, ldapKey)
}
}
// Check if Public Key sync is needed
if util.IsEqualSlice(giteaKeys, ldapKeys) {
log.Trace("synchronizeLdapSSHPublicKeys[%s]: LDAP Public Keys are already in sync for %s (LDAP:%v/DB:%v)", s.Name, usr.Name, len(ldapKeys), len(giteaKeys))
return false
}
log.Trace("synchronizeLdapSSHPublicKeys[%s]: LDAP Public Key needs update for user %s (LDAP:%v/DB:%v)", s.Name, usr.Name, len(ldapKeys), len(giteaKeys))
// Add LDAP Public SSH Keys that doesn't already exist in DB
var newLdapSSHKeys []string
for _, LDAPPublicSSHKey := range ldapKeys {
if !util.ExistsInSlice(LDAPPublicSSHKey, giteaKeys) {
newLdapSSHKeys = append(newLdapSSHKeys, LDAPPublicSSHKey)
}
}
if addLdapSSHPublicKeys(usr, s, newLdapSSHKeys) {
sshKeysNeedUpdate = true
}
// Mark LDAP keys from DB that doesn't exist in LDAP for deletion
var giteaKeysToDelete []string
for _, giteaKey := range giteaKeys {
if !util.ExistsInSlice(giteaKey, ldapKeys) {
log.Trace("synchronizeLdapSSHPublicKeys[%s]: Marking LDAP Public SSH Key for deletion for user %s: %v", s.Name, usr.Name, giteaKey)
giteaKeysToDelete = append(giteaKeysToDelete, giteaKey)
}
}
// Delete LDAP keys from DB that doesn't exist in LDAP
needUpd, err := deleteKeysMarkedForDeletion(giteaKeysToDelete)
if err != nil {
log.Error(4, "synchronizeLdapSSHPublicKeys[%s]: Error deleting LDAP Public SSH Keys marked for deletion for user %s: %v", s.Name, usr.Name, err)
}
if needUpd {
sshKeysNeedUpdate = true
}
return sshKeysNeedUpdate
}
2017-05-10 15:10:18 +02:00
// SyncExternalUsers is used to synchronize users with external authorization source
func SyncExternalUsers() {
if !taskStatusTable.StartIfNotRunning(syncExternalUsers) {
2017-05-10 15:10:18 +02:00
return
}
defer taskStatusTable.Stop(syncExternalUsers)
log.Trace("Doing: SyncExternalUsers")
ls, err := LoginSources()
if err != nil {
log.Error(4, "SyncExternalUsers: %v", err)
return
}
updateExisting := setting.Cron.SyncExternalUsers.UpdateExisting
for _, s := range ls {
if !s.IsActived || !s.IsSyncEnabled {
continue
}
2017-05-10 15:10:18 +02:00
if s.IsLDAP() {
log.Trace("Doing: SyncExternalUsers[%s]", s.Name)
var existingUsers []int64
var isAttributeSSHPublicKeySet = len(strings.TrimSpace(s.LDAP().AttributeSSHPublicKey)) > 0
var sshKeysNeedUpdate bool
2017-05-10 15:10:18 +02:00
// Find all users with this login type
var users []User
x.Where("login_type = ?", LoginLDAP).
And("login_source = ?", s.ID).
Find(&users)
sr := s.LDAP().SearchEntries()
for _, su := range sr {
if len(su.Username) == 0 {
continue
}
if len(su.Mail) == 0 {
su.Mail = fmt.Sprintf("%s@localhost", su.Username)
}
var usr *User
// Search for existing user
for _, du := range users {
if du.LowerName == strings.ToLower(su.Username) {
usr = &du
break
}
}
fullName := composeFullName(su.Name, su.Surname, su.Username)
// If no existing user found, create one
if usr == nil {
log.Trace("SyncExternalUsers[%s]: Creating user %s", s.Name, su.Username)
usr = &User{
LowerName: strings.ToLower(su.Username),
Name: su.Username,
FullName: fullName,
LoginType: s.Type,
LoginSource: s.ID,
LoginName: su.Username,
Email: su.Mail,
IsAdmin: su.IsAdmin,
IsActive: true,
}
err = CreateUser(usr)
2017-05-10 15:10:18 +02:00
if err != nil {
log.Error(4, "SyncExternalUsers[%s]: Error creating user %s: %v", s.Name, su.Username, err)
} else if isAttributeSSHPublicKeySet {
log.Trace("SyncExternalUsers[%s]: Adding LDAP Public SSH Keys for user %s", s.Name, usr.Name)
if addLdapSSHPublicKeys(usr, s, su.SSHPublicKey) {
sshKeysNeedUpdate = true
}
2017-05-10 15:10:18 +02:00
}
} else if updateExisting {
existingUsers = append(existingUsers, usr.ID)
// Synchronize SSH Public Key if that attribute is set
if isAttributeSSHPublicKeySet && synchronizeLdapSSHPublicKeys(usr, s, su.SSHPublicKey) {
sshKeysNeedUpdate = true
}
2017-05-10 15:10:18 +02:00
// Check if user data has changed
if (len(s.LDAP().AdminFilter) > 0 && usr.IsAdmin != su.IsAdmin) ||
strings.ToLower(usr.Email) != strings.ToLower(su.Mail) ||
usr.FullName != fullName ||
!usr.IsActive {
log.Trace("SyncExternalUsers[%s]: Updating user %s", s.Name, usr.Name)
usr.FullName = fullName
usr.Email = su.Mail
// Change existing admin flag only if AdminFilter option is set
if len(s.LDAP().AdminFilter) > 0 {
usr.IsAdmin = su.IsAdmin
}
usr.IsActive = true
err = UpdateUserCols(usr, "full_name", "email", "is_admin", "is_active")
2017-05-10 15:10:18 +02:00
if err != nil {
log.Error(4, "SyncExternalUsers[%s]: Error updating user %s: %v", s.Name, usr.Name, err)
}
}
}
}
// Rewrite authorized_keys file if LDAP Public SSH Key attribute is set and any key was added or removed
if sshKeysNeedUpdate {
RewriteAllPublicKeys()
}
2017-05-10 15:10:18 +02:00
// Deactivate users not present in LDAP
if updateExisting {
for _, usr := range users {
found := false
for _, uid := range existingUsers {
if usr.ID == uid {
found = true
break
}
}
if !found {
log.Trace("SyncExternalUsers[%s]: Deactivating user %s", s.Name, usr.Name)
usr.IsActive = false
err = UpdateUserCols(&usr, "is_active")
2017-05-10 15:10:18 +02:00
if err != nil {
log.Error(4, "SyncExternalUsers[%s]: Error deactivating user %s: %v", s.Name, usr.Name, err)
}
}
}
}
}
}
}