user.go 31 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162
  1. // Copyright 2014 The Gogs Authors. All rights reserved.
  2. // Use of this source code is governed by a MIT-style
  3. // license that can be found in the LICENSE file.
  4. package db
  5. import (
  6. "bytes"
  7. "crypto/sha256"
  8. "crypto/subtle"
  9. "encoding/hex"
  10. "fmt"
  11. "image"
  12. _ "image/jpeg"
  13. "image/png"
  14. "os"
  15. "path/filepath"
  16. "strings"
  17. "time"
  18. "unicode/utf8"
  19. "github.com/nfnt/resize"
  20. "github.com/unknwon/com"
  21. "golang.org/x/crypto/pbkdf2"
  22. log "unknwon.dev/clog/v2"
  23. "xorm.io/xorm"
  24. "github.com/gogs/git-module"
  25. api "github.com/gogs/go-gogs-client"
  26. "gogs.io/gogs/internal/avatar"
  27. "gogs.io/gogs/internal/conf"
  28. "gogs.io/gogs/internal/db/errors"
  29. "gogs.io/gogs/internal/errutil"
  30. "gogs.io/gogs/internal/tool"
  31. )
  32. // USER_AVATAR_URL_PREFIX is used to identify a URL is to access user avatar.
  33. const USER_AVATAR_URL_PREFIX = "avatars"
  34. type UserType int
  35. const (
  36. USER_TYPE_INDIVIDUAL UserType = iota // Historic reason to make it starts at 0.
  37. USER_TYPE_ORGANIZATION
  38. )
  39. // User represents the object of individual and member of organization.
  40. type User struct {
  41. ID int64
  42. LowerName string `xorm:"UNIQUE NOT NULL"`
  43. Name string `xorm:"UNIQUE NOT NULL"`
  44. FullName string
  45. // Email is the primary email address (to be used for communication)
  46. Email string `xorm:"NOT NULL"`
  47. Passwd string `xorm:"NOT NULL"`
  48. LoginType LoginType
  49. LoginSource int64 `xorm:"NOT NULL DEFAULT 0"`
  50. LoginName string
  51. Type UserType
  52. OwnedOrgs []*User `xorm:"-" json:"-"`
  53. Orgs []*User `xorm:"-" json:"-"`
  54. Repos []*Repository `xorm:"-" json:"-"`
  55. Location string
  56. Website string
  57. Rands string `xorm:"VARCHAR(10)"`
  58. Salt string `xorm:"VARCHAR(10)"`
  59. Created time.Time `xorm:"-" json:"-"`
  60. CreatedUnix int64
  61. Updated time.Time `xorm:"-" json:"-"`
  62. UpdatedUnix int64
  63. // Remember visibility choice for convenience, true for private
  64. LastRepoVisibility bool
  65. // Maximum repository creation limit, -1 means use gloabl default
  66. MaxRepoCreation int `xorm:"NOT NULL DEFAULT -1"`
  67. // Permissions
  68. IsActive bool // Activate primary email
  69. IsAdmin bool
  70. AllowGitHook bool
  71. AllowImportLocal bool // Allow migrate repository by local path
  72. ProhibitLogin bool
  73. // Avatar
  74. Avatar string `xorm:"VARCHAR(2048) NOT NULL"`
  75. AvatarEmail string `xorm:"NOT NULL"`
  76. UseCustomAvatar bool
  77. // Counters
  78. NumFollowers int
  79. NumFollowing int `xorm:"NOT NULL DEFAULT 0"`
  80. NumStars int
  81. NumRepos int
  82. // For organization
  83. Description string
  84. NumTeams int
  85. NumMembers int
  86. Teams []*Team `xorm:"-" json:"-"`
  87. Members []*User `xorm:"-" json:"-"`
  88. }
  89. func (u *User) BeforeInsert() {
  90. u.CreatedUnix = time.Now().Unix()
  91. u.UpdatedUnix = u.CreatedUnix
  92. }
  93. func (u *User) BeforeUpdate() {
  94. if u.MaxRepoCreation < -1 {
  95. u.MaxRepoCreation = -1
  96. }
  97. u.UpdatedUnix = time.Now().Unix()
  98. }
  99. func (u *User) AfterSet(colName string, _ xorm.Cell) {
  100. switch colName {
  101. case "created_unix":
  102. u.Created = time.Unix(u.CreatedUnix, 0).Local()
  103. case "updated_unix":
  104. u.Updated = time.Unix(u.UpdatedUnix, 0).Local()
  105. }
  106. }
  107. // IDStr returns string representation of user's ID.
  108. func (u *User) IDStr() string {
  109. return com.ToStr(u.ID)
  110. }
  111. func (u *User) APIFormat() *api.User {
  112. return &api.User{
  113. ID: u.ID,
  114. UserName: u.Name,
  115. Login: u.Name,
  116. FullName: u.FullName,
  117. Email: u.Email,
  118. AvatarUrl: u.AvatarLink(),
  119. }
  120. }
  121. // returns true if user login type is LoginPlain.
  122. func (u *User) IsLocal() bool {
  123. return u.LoginType <= LoginPlain
  124. }
  125. // HasForkedRepo checks if user has already forked a repository with given ID.
  126. func (u *User) HasForkedRepo(repoID int64) bool {
  127. _, has, _ := HasForkedRepo(u.ID, repoID)
  128. return has
  129. }
  130. func (u *User) RepoCreationNum() int {
  131. if u.MaxRepoCreation <= -1 {
  132. return conf.Repository.MaxCreationLimit
  133. }
  134. return u.MaxRepoCreation
  135. }
  136. func (u *User) CanCreateRepo() bool {
  137. if u.MaxRepoCreation <= -1 {
  138. if conf.Repository.MaxCreationLimit <= -1 {
  139. return true
  140. }
  141. return u.NumRepos < conf.Repository.MaxCreationLimit
  142. }
  143. return u.NumRepos < u.MaxRepoCreation
  144. }
  145. func (u *User) CanCreateOrganization() bool {
  146. return !conf.Admin.DisableRegularOrgCreation || u.IsAdmin
  147. }
  148. // CanEditGitHook returns true if user can edit Git hooks.
  149. func (u *User) CanEditGitHook() bool {
  150. return u.IsAdmin || u.AllowGitHook
  151. }
  152. // CanImportLocal returns true if user can migrate repository by local path.
  153. func (u *User) CanImportLocal() bool {
  154. return conf.Repository.EnableLocalPathMigration && (u.IsAdmin || u.AllowImportLocal)
  155. }
  156. // DashboardLink returns the user dashboard page link.
  157. func (u *User) DashboardLink() string {
  158. if u.IsOrganization() {
  159. return conf.Server.Subpath + "/org/" + u.Name + "/dashboard/"
  160. }
  161. return conf.Server.Subpath + "/"
  162. }
  163. // HomeLink returns the user or organization home page link.
  164. func (u *User) HomeLink() string {
  165. return conf.Server.Subpath + "/" + u.Name
  166. }
  167. func (u *User) HTMLURL() string {
  168. return conf.Server.ExternalURL + u.Name
  169. }
  170. // GenerateEmailActivateCode generates an activate code based on user information and given e-mail.
  171. func (u *User) GenerateEmailActivateCode(email string) string {
  172. code := tool.CreateTimeLimitCode(
  173. com.ToStr(u.ID)+email+u.LowerName+u.Passwd+u.Rands,
  174. conf.Auth.ActivateCodeLives, nil)
  175. // Add tail hex username
  176. code += hex.EncodeToString([]byte(u.LowerName))
  177. return code
  178. }
  179. // GenerateActivateCode generates an activate code based on user information.
  180. func (u *User) GenerateActivateCode() string {
  181. return u.GenerateEmailActivateCode(u.Email)
  182. }
  183. // CustomAvatarPath returns user custom avatar file path.
  184. func (u *User) CustomAvatarPath() string {
  185. return filepath.Join(conf.Picture.AvatarUploadPath, com.ToStr(u.ID))
  186. }
  187. // GenerateRandomAvatar generates a random avatar for user.
  188. func (u *User) GenerateRandomAvatar() error {
  189. seed := u.Email
  190. if len(seed) == 0 {
  191. seed = u.Name
  192. }
  193. img, err := avatar.RandomImage([]byte(seed))
  194. if err != nil {
  195. return fmt.Errorf("RandomImage: %v", err)
  196. }
  197. if err = os.MkdirAll(filepath.Dir(u.CustomAvatarPath()), os.ModePerm); err != nil {
  198. return fmt.Errorf("MkdirAll: %v", err)
  199. }
  200. fw, err := os.Create(u.CustomAvatarPath())
  201. if err != nil {
  202. return fmt.Errorf("Create: %v", err)
  203. }
  204. defer fw.Close()
  205. if err = png.Encode(fw, img); err != nil {
  206. return fmt.Errorf("Encode: %v", err)
  207. }
  208. log.Info("New random avatar created: %d", u.ID)
  209. return nil
  210. }
  211. // RelAvatarLink returns relative avatar link to the site domain,
  212. // which includes app sub-url as prefix. However, it is possible
  213. // to return full URL if user enables Gravatar-like service.
  214. func (u *User) RelAvatarLink() string {
  215. defaultImgUrl := conf.Server.Subpath + "/img/avatar_default.png"
  216. if u.ID == -1 {
  217. return defaultImgUrl
  218. }
  219. switch {
  220. case u.UseCustomAvatar:
  221. if !com.IsExist(u.CustomAvatarPath()) {
  222. return defaultImgUrl
  223. }
  224. return fmt.Sprintf("%s/%s/%d", conf.Server.Subpath, USER_AVATAR_URL_PREFIX, u.ID)
  225. case conf.Picture.DisableGravatar:
  226. if !com.IsExist(u.CustomAvatarPath()) {
  227. if err := u.GenerateRandomAvatar(); err != nil {
  228. log.Error("GenerateRandomAvatar: %v", err)
  229. }
  230. }
  231. return fmt.Sprintf("%s/%s/%d", conf.Server.Subpath, USER_AVATAR_URL_PREFIX, u.ID)
  232. }
  233. return tool.AvatarLink(u.AvatarEmail)
  234. }
  235. // AvatarLink returns user avatar absolute link.
  236. func (u *User) AvatarLink() string {
  237. link := u.RelAvatarLink()
  238. if link[0] == '/' && link[1] != '/' {
  239. return conf.Server.ExternalURL + strings.TrimPrefix(link, conf.Server.Subpath)[1:]
  240. }
  241. return link
  242. }
  243. // User.GetFollwoers returns range of user's followers.
  244. func (u *User) GetFollowers(page int) ([]*User, error) {
  245. users := make([]*User, 0, ItemsPerPage)
  246. sess := x.Limit(ItemsPerPage, (page-1)*ItemsPerPage).Where("follow.follow_id=?", u.ID)
  247. if conf.UsePostgreSQL {
  248. sess = sess.Join("LEFT", "follow", `"user".id=follow.user_id`)
  249. } else {
  250. sess = sess.Join("LEFT", "follow", "user.id=follow.user_id")
  251. }
  252. return users, sess.Find(&users)
  253. }
  254. func (u *User) IsFollowing(followID int64) bool {
  255. return IsFollowing(u.ID, followID)
  256. }
  257. // GetFollowing returns range of user's following.
  258. func (u *User) GetFollowing(page int) ([]*User, error) {
  259. users := make([]*User, 0, ItemsPerPage)
  260. sess := x.Limit(ItemsPerPage, (page-1)*ItemsPerPage).Where("follow.user_id=?", u.ID)
  261. if conf.UsePostgreSQL {
  262. sess = sess.Join("LEFT", "follow", `"user".id=follow.follow_id`)
  263. } else {
  264. sess = sess.Join("LEFT", "follow", "user.id=follow.follow_id")
  265. }
  266. return users, sess.Find(&users)
  267. }
  268. // NewGitSig generates and returns the signature of given user.
  269. func (u *User) NewGitSig() *git.Signature {
  270. return &git.Signature{
  271. Name: u.DisplayName(),
  272. Email: u.Email,
  273. When: time.Now(),
  274. }
  275. }
  276. // EncodePasswd encodes password to safe format.
  277. func (u *User) EncodePasswd() {
  278. newPasswd := pbkdf2.Key([]byte(u.Passwd), []byte(u.Salt), 10000, 50, sha256.New)
  279. u.Passwd = fmt.Sprintf("%x", newPasswd)
  280. }
  281. // ValidatePassword checks if given password matches the one belongs to the user.
  282. func (u *User) ValidatePassword(passwd string) bool {
  283. newUser := &User{Passwd: passwd, Salt: u.Salt}
  284. newUser.EncodePasswd()
  285. return subtle.ConstantTimeCompare([]byte(u.Passwd), []byte(newUser.Passwd)) == 1
  286. }
  287. // UploadAvatar saves custom avatar for user.
  288. // FIXME: split uploads to different subdirs in case we have massive number of users.
  289. func (u *User) UploadAvatar(data []byte) error {
  290. img, _, err := image.Decode(bytes.NewReader(data))
  291. if err != nil {
  292. return fmt.Errorf("decode image: %v", err)
  293. }
  294. _ = os.MkdirAll(conf.Picture.AvatarUploadPath, os.ModePerm)
  295. fw, err := os.Create(u.CustomAvatarPath())
  296. if err != nil {
  297. return fmt.Errorf("create custom avatar directory: %v", err)
  298. }
  299. defer fw.Close()
  300. m := resize.Resize(avatar.AVATAR_SIZE, avatar.AVATAR_SIZE, img, resize.NearestNeighbor)
  301. if err = png.Encode(fw, m); err != nil {
  302. return fmt.Errorf("encode image: %v", err)
  303. }
  304. return nil
  305. }
  306. // DeleteAvatar deletes the user's custom avatar.
  307. func (u *User) DeleteAvatar() error {
  308. log.Trace("DeleteAvatar [%d]: %s", u.ID, u.CustomAvatarPath())
  309. if err := os.Remove(u.CustomAvatarPath()); err != nil {
  310. return err
  311. }
  312. u.UseCustomAvatar = false
  313. return UpdateUser(u)
  314. }
  315. // IsAdminOfRepo returns true if user has admin or higher access of repository.
  316. func (u *User) IsAdminOfRepo(repo *Repository) bool {
  317. has, err := HasAccess(u.ID, repo, AccessModeAdmin)
  318. if err != nil {
  319. log.Error("HasAccess: %v", err)
  320. }
  321. return has
  322. }
  323. // IsWriterOfRepo returns true if user has write access to given repository.
  324. func (u *User) IsWriterOfRepo(repo *Repository) bool {
  325. has, err := HasAccess(u.ID, repo, AccessModeWrite)
  326. if err != nil {
  327. log.Error("HasAccess: %v", err)
  328. }
  329. return has
  330. }
  331. // IsOrganization returns true if user is actually a organization.
  332. func (u *User) IsOrganization() bool {
  333. return u.Type == USER_TYPE_ORGANIZATION
  334. }
  335. // IsUserOrgOwner returns true if user is in the owner team of given organization.
  336. func (u *User) IsUserOrgOwner(orgId int64) bool {
  337. return IsOrganizationOwner(orgId, u.ID)
  338. }
  339. // IsPublicMember returns true if user public his/her membership in give organization.
  340. func (u *User) IsPublicMember(orgId int64) bool {
  341. return IsPublicMembership(orgId, u.ID)
  342. }
  343. // IsEnabledTwoFactor returns true if user has enabled two-factor authentication.
  344. func (u *User) IsEnabledTwoFactor() bool {
  345. return TwoFactors.IsUserEnabled(u.ID)
  346. }
  347. func (u *User) getOrganizationCount(e Engine) (int64, error) {
  348. return e.Where("uid=?", u.ID).Count(new(OrgUser))
  349. }
  350. // GetOrganizationCount returns count of membership of organization of user.
  351. func (u *User) GetOrganizationCount() (int64, error) {
  352. return u.getOrganizationCount(x)
  353. }
  354. // GetRepositories returns repositories that user owns, including private repositories.
  355. func (u *User) GetRepositories(page, pageSize int) (err error) {
  356. u.Repos, err = GetUserRepositories(&UserRepoOptions{
  357. UserID: u.ID,
  358. Private: true,
  359. Page: page,
  360. PageSize: pageSize,
  361. })
  362. return err
  363. }
  364. // GetRepositories returns mirror repositories that user owns, including private repositories.
  365. func (u *User) GetMirrorRepositories() ([]*Repository, error) {
  366. return GetUserMirrorRepositories(u.ID)
  367. }
  368. // GetOwnedOrganizations returns all organizations that user owns.
  369. func (u *User) GetOwnedOrganizations() (err error) {
  370. u.OwnedOrgs, err = GetOwnedOrgsByUserID(u.ID)
  371. return err
  372. }
  373. // GetOrganizations returns all organizations that user belongs to.
  374. func (u *User) GetOrganizations(showPrivate bool) error {
  375. orgIDs, err := GetOrgIDsByUserID(u.ID, showPrivate)
  376. if err != nil {
  377. return fmt.Errorf("GetOrgIDsByUserID: %v", err)
  378. }
  379. if len(orgIDs) == 0 {
  380. return nil
  381. }
  382. u.Orgs = make([]*User, 0, len(orgIDs))
  383. if err = x.Where("type = ?", USER_TYPE_ORGANIZATION).In("id", orgIDs).Find(&u.Orgs); err != nil {
  384. return err
  385. }
  386. return nil
  387. }
  388. // DisplayName returns full name if it's not empty,
  389. // returns username otherwise.
  390. func (u *User) DisplayName() string {
  391. if len(u.FullName) > 0 {
  392. return u.FullName
  393. }
  394. return u.Name
  395. }
  396. func (u *User) ShortName(length int) string {
  397. return tool.EllipsisString(u.Name, length)
  398. }
  399. // IsMailable checks if a user is elegible
  400. // to receive emails.
  401. func (u *User) IsMailable() bool {
  402. return u.IsActive
  403. }
  404. // IsUserExist checks if given user name exist,
  405. // the user name should be noncased unique.
  406. // If uid is presented, then check will rule out that one,
  407. // it is used when update a user name in settings page.
  408. func IsUserExist(uid int64, name string) (bool, error) {
  409. if len(name) == 0 {
  410. return false, nil
  411. }
  412. return x.Where("id != ?", uid).Get(&User{LowerName: strings.ToLower(name)})
  413. }
  414. // GetUserSalt returns a ramdom user salt token.
  415. func GetUserSalt() (string, error) {
  416. return tool.RandomString(10)
  417. }
  418. // NewGhostUser creates and returns a fake user for someone who has deleted his/her account.
  419. func NewGhostUser() *User {
  420. return &User{
  421. ID: -1,
  422. Name: "Ghost",
  423. LowerName: "ghost",
  424. }
  425. }
  426. var (
  427. reservedUsernames = []string{"-", "explore", "create", "assets", "css", "img", "js", "less", "plugins", "debug", "raw", "install", "api", "avatar", "user", "org", "help", "stars", "issues", "pulls", "commits", "repo", "template", "admin", "new", ".", ".."}
  428. reservedUserPatterns = []string{"*.keys"}
  429. )
  430. // isUsableName checks if name is reserved or pattern of name is not allowed
  431. // based on given reserved names and patterns.
  432. // Names are exact match, patterns can be prefix or suffix match with placeholder '*'.
  433. func isUsableName(names, patterns []string, name string) error {
  434. name = strings.TrimSpace(strings.ToLower(name))
  435. if utf8.RuneCountInString(name) == 0 {
  436. return errors.EmptyName{}
  437. }
  438. for i := range names {
  439. if name == names[i] {
  440. return ErrNameReserved{name}
  441. }
  442. }
  443. for _, pat := range patterns {
  444. if pat[0] == '*' && strings.HasSuffix(name, pat[1:]) ||
  445. (pat[len(pat)-1] == '*' && strings.HasPrefix(name, pat[:len(pat)-1])) {
  446. return ErrNamePatternNotAllowed{pat}
  447. }
  448. }
  449. return nil
  450. }
  451. func IsUsableUsername(name string) error {
  452. return isUsableName(reservedUsernames, reservedUserPatterns, name)
  453. }
  454. // CreateUser creates record of a new user.
  455. func CreateUser(u *User) (err error) {
  456. if err = IsUsableUsername(u.Name); err != nil {
  457. return err
  458. }
  459. isExist, err := IsUserExist(0, u.Name)
  460. if err != nil {
  461. return err
  462. } else if isExist {
  463. return ErrUserAlreadyExist{u.Name}
  464. }
  465. u.Email = strings.ToLower(u.Email)
  466. isExist, err = IsEmailUsed(u.Email)
  467. if err != nil {
  468. return err
  469. } else if isExist {
  470. return ErrEmailAlreadyUsed{u.Email}
  471. }
  472. u.LowerName = strings.ToLower(u.Name)
  473. u.AvatarEmail = u.Email
  474. u.Avatar = tool.HashEmail(u.AvatarEmail)
  475. if u.Rands, err = GetUserSalt(); err != nil {
  476. return err
  477. }
  478. if u.Salt, err = GetUserSalt(); err != nil {
  479. return err
  480. }
  481. u.EncodePasswd()
  482. u.MaxRepoCreation = -1
  483. sess := x.NewSession()
  484. defer sess.Close()
  485. if err = sess.Begin(); err != nil {
  486. return err
  487. }
  488. if _, err = sess.Insert(u); err != nil {
  489. return err
  490. } else if err = os.MkdirAll(UserPath(u.Name), os.ModePerm); err != nil {
  491. return err
  492. }
  493. return sess.Commit()
  494. }
  495. func countUsers(e Engine) int64 {
  496. count, _ := e.Where("type=0").Count(new(User))
  497. return count
  498. }
  499. // CountUsers returns number of users.
  500. func CountUsers() int64 {
  501. return countUsers(x)
  502. }
  503. // Users returns number of users in given page.
  504. func ListUsers(page, pageSize int) ([]*User, error) {
  505. users := make([]*User, 0, pageSize)
  506. return users, x.Limit(pageSize, (page-1)*pageSize).Where("type=0").Asc("id").Find(&users)
  507. }
  508. // parseUserFromCode returns user by username encoded in code.
  509. // It returns nil if code or username is invalid.
  510. func parseUserFromCode(code string) (user *User) {
  511. if len(code) <= tool.TIME_LIMIT_CODE_LENGTH {
  512. return nil
  513. }
  514. // Use tail hex username to query user
  515. hexStr := code[tool.TIME_LIMIT_CODE_LENGTH:]
  516. if b, err := hex.DecodeString(hexStr); err == nil {
  517. if user, err = GetUserByName(string(b)); user != nil {
  518. return user
  519. } else if !IsErrUserNotExist(err) {
  520. log.Error("Failed to get user by name %q: %v", string(b), err)
  521. }
  522. }
  523. return nil
  524. }
  525. // verify active code when active account
  526. func VerifyUserActiveCode(code string) (user *User) {
  527. minutes := conf.Auth.ActivateCodeLives
  528. if user = parseUserFromCode(code); user != nil {
  529. // time limit code
  530. prefix := code[:tool.TIME_LIMIT_CODE_LENGTH]
  531. data := com.ToStr(user.ID) + user.Email + user.LowerName + user.Passwd + user.Rands
  532. if tool.VerifyTimeLimitCode(data, minutes, prefix) {
  533. return user
  534. }
  535. }
  536. return nil
  537. }
  538. // verify active code when active account
  539. func VerifyActiveEmailCode(code, email string) *EmailAddress {
  540. minutes := conf.Auth.ActivateCodeLives
  541. if user := parseUserFromCode(code); user != nil {
  542. // time limit code
  543. prefix := code[:tool.TIME_LIMIT_CODE_LENGTH]
  544. data := com.ToStr(user.ID) + email + user.LowerName + user.Passwd + user.Rands
  545. if tool.VerifyTimeLimitCode(data, minutes, prefix) {
  546. emailAddress := &EmailAddress{Email: email}
  547. if has, _ := x.Get(emailAddress); has {
  548. return emailAddress
  549. }
  550. }
  551. }
  552. return nil
  553. }
  554. // ChangeUserName changes all corresponding setting from old user name to new one.
  555. func ChangeUserName(u *User, newUserName string) (err error) {
  556. if err = IsUsableUsername(newUserName); err != nil {
  557. return err
  558. }
  559. isExist, err := IsUserExist(0, newUserName)
  560. if err != nil {
  561. return err
  562. } else if isExist {
  563. return ErrUserAlreadyExist{newUserName}
  564. }
  565. if err = ChangeUsernameInPullRequests(u.Name, newUserName); err != nil {
  566. return fmt.Errorf("ChangeUsernameInPullRequests: %v", err)
  567. }
  568. // Delete all local copies of repositories and wikis the user owns.
  569. if err = x.Where("owner_id=?", u.ID).Iterate(new(Repository), func(idx int, bean interface{}) error {
  570. repo := bean.(*Repository)
  571. deleteRepoLocalCopy(repo)
  572. // TODO: By the same reasoning, shouldn't we also sync access to the local wiki path?
  573. RemoveAllWithNotice("Delete repository wiki local copy", repo.LocalWikiPath())
  574. return nil
  575. }); err != nil {
  576. return fmt.Errorf("delete repository and wiki local copy: %v", err)
  577. }
  578. // Rename or create user base directory
  579. baseDir := UserPath(u.Name)
  580. newBaseDir := UserPath(newUserName)
  581. if com.IsExist(baseDir) {
  582. return os.Rename(baseDir, newBaseDir)
  583. }
  584. return os.MkdirAll(newBaseDir, os.ModePerm)
  585. }
  586. func updateUser(e Engine, u *User) error {
  587. // Organization does not need email
  588. if !u.IsOrganization() {
  589. u.Email = strings.ToLower(u.Email)
  590. has, err := e.Where("id!=?", u.ID).And("type=?", u.Type).And("email=?", u.Email).Get(new(User))
  591. if err != nil {
  592. return err
  593. } else if has {
  594. return ErrEmailAlreadyUsed{u.Email}
  595. }
  596. if len(u.AvatarEmail) == 0 {
  597. u.AvatarEmail = u.Email
  598. }
  599. u.Avatar = tool.HashEmail(u.AvatarEmail)
  600. }
  601. u.LowerName = strings.ToLower(u.Name)
  602. u.Location = tool.TruncateString(u.Location, 255)
  603. u.Website = tool.TruncateString(u.Website, 255)
  604. u.Description = tool.TruncateString(u.Description, 255)
  605. _, err := e.ID(u.ID).AllCols().Update(u)
  606. return err
  607. }
  608. // UpdateUser updates user's information.
  609. func UpdateUser(u *User) error {
  610. return updateUser(x, u)
  611. }
  612. // deleteBeans deletes all given beans, beans should contain delete conditions.
  613. func deleteBeans(e Engine, beans ...interface{}) (err error) {
  614. for i := range beans {
  615. if _, err = e.Delete(beans[i]); err != nil {
  616. return err
  617. }
  618. }
  619. return nil
  620. }
  621. // FIXME: need some kind of mechanism to record failure. HINT: system notice
  622. func deleteUser(e *xorm.Session, u *User) error {
  623. // Note: A user owns any repository or belongs to any organization
  624. // cannot perform delete operation.
  625. // Check ownership of repository.
  626. count, err := getRepositoryCount(e, u)
  627. if err != nil {
  628. return fmt.Errorf("GetRepositoryCount: %v", err)
  629. } else if count > 0 {
  630. return ErrUserOwnRepos{UID: u.ID}
  631. }
  632. // Check membership of organization.
  633. count, err = u.getOrganizationCount(e)
  634. if err != nil {
  635. return fmt.Errorf("GetOrganizationCount: %v", err)
  636. } else if count > 0 {
  637. return ErrUserHasOrgs{UID: u.ID}
  638. }
  639. // ***** START: Watch *****
  640. watches := make([]*Watch, 0, 10)
  641. if err = e.Find(&watches, &Watch{UserID: u.ID}); err != nil {
  642. return fmt.Errorf("get all watches: %v", err)
  643. }
  644. for i := range watches {
  645. if _, err = e.Exec("UPDATE `repository` SET num_watches=num_watches-1 WHERE id=?", watches[i].RepoID); err != nil {
  646. return fmt.Errorf("decrease repository watch number[%d]: %v", watches[i].RepoID, err)
  647. }
  648. }
  649. // ***** END: Watch *****
  650. // ***** START: Star *****
  651. stars := make([]*Star, 0, 10)
  652. if err = e.Find(&stars, &Star{UID: u.ID}); err != nil {
  653. return fmt.Errorf("get all stars: %v", err)
  654. }
  655. for i := range stars {
  656. if _, err = e.Exec("UPDATE `repository` SET num_stars=num_stars-1 WHERE id=?", stars[i].RepoID); err != nil {
  657. return fmt.Errorf("decrease repository star number[%d]: %v", stars[i].RepoID, err)
  658. }
  659. }
  660. // ***** END: Star *****
  661. // ***** START: Follow *****
  662. followers := make([]*Follow, 0, 10)
  663. if err = e.Find(&followers, &Follow{UserID: u.ID}); err != nil {
  664. return fmt.Errorf("get all followers: %v", err)
  665. }
  666. for i := range followers {
  667. if _, err = e.Exec("UPDATE `user` SET num_followers=num_followers-1 WHERE id=?", followers[i].UserID); err != nil {
  668. return fmt.Errorf("decrease user follower number[%d]: %v", followers[i].UserID, err)
  669. }
  670. }
  671. // ***** END: Follow *****
  672. if err = deleteBeans(e,
  673. &AccessToken{UserID: u.ID},
  674. &Collaboration{UserID: u.ID},
  675. &Access{UserID: u.ID},
  676. &Watch{UserID: u.ID},
  677. &Star{UID: u.ID},
  678. &Follow{FollowID: u.ID},
  679. &Action{UserID: u.ID},
  680. &IssueUser{UID: u.ID},
  681. &EmailAddress{UID: u.ID},
  682. ); err != nil {
  683. return fmt.Errorf("deleteBeans: %v", err)
  684. }
  685. // ***** START: PublicKey *****
  686. keys := make([]*PublicKey, 0, 10)
  687. if err = e.Find(&keys, &PublicKey{OwnerID: u.ID}); err != nil {
  688. return fmt.Errorf("get all public keys: %v", err)
  689. }
  690. keyIDs := make([]int64, len(keys))
  691. for i := range keys {
  692. keyIDs[i] = keys[i].ID
  693. }
  694. if err = deletePublicKeys(e, keyIDs...); err != nil {
  695. return fmt.Errorf("deletePublicKeys: %v", err)
  696. }
  697. // ***** END: PublicKey *****
  698. // Clear assignee.
  699. if _, err = e.Exec("UPDATE `issue` SET assignee_id=0 WHERE assignee_id=?", u.ID); err != nil {
  700. return fmt.Errorf("clear assignee: %v", err)
  701. }
  702. if _, err = e.ID(u.ID).Delete(new(User)); err != nil {
  703. return fmt.Errorf("Delete: %v", err)
  704. }
  705. // FIXME: system notice
  706. // Note: There are something just cannot be roll back,
  707. // so just keep error logs of those operations.
  708. _ = os.RemoveAll(UserPath(u.Name))
  709. _ = os.Remove(u.CustomAvatarPath())
  710. return nil
  711. }
  712. // DeleteUser completely and permanently deletes everything of a user,
  713. // but issues/comments/pulls will be kept and shown as someone has been deleted.
  714. func DeleteUser(u *User) (err error) {
  715. sess := x.NewSession()
  716. defer sess.Close()
  717. if err = sess.Begin(); err != nil {
  718. return err
  719. }
  720. if err = deleteUser(sess, u); err != nil {
  721. // Note: don't wrapper error here.
  722. return err
  723. }
  724. if err = sess.Commit(); err != nil {
  725. return err
  726. }
  727. return RewriteAuthorizedKeys()
  728. }
  729. // DeleteInactivateUsers deletes all inactivate users and email addresses.
  730. func DeleteInactivateUsers() (err error) {
  731. users := make([]*User, 0, 10)
  732. if err = x.Where("is_active = ?", false).Find(&users); err != nil {
  733. return fmt.Errorf("get all inactive users: %v", err)
  734. }
  735. // FIXME: should only update authorized_keys file once after all deletions.
  736. for _, u := range users {
  737. if err = DeleteUser(u); err != nil {
  738. // Ignore users that were set inactive by admin.
  739. if IsErrUserOwnRepos(err) || IsErrUserHasOrgs(err) {
  740. continue
  741. }
  742. return err
  743. }
  744. }
  745. _, err = x.Where("is_activated = ?", false).Delete(new(EmailAddress))
  746. return err
  747. }
  748. // UserPath returns the path absolute path of user repositories.
  749. func UserPath(userName string) string {
  750. return filepath.Join(conf.Repository.Root, strings.ToLower(userName))
  751. }
  752. func GetUserByKeyID(keyID int64) (*User, error) {
  753. user := new(User)
  754. 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)
  755. if err != nil {
  756. return nil, err
  757. } else if !has {
  758. return nil, errors.UserNotKeyOwner{KeyID: keyID}
  759. }
  760. return user, nil
  761. }
  762. var _ errutil.NotFound = (*ErrUserNotExist)(nil)
  763. type ErrUserNotExist struct {
  764. args map[string]interface{}
  765. }
  766. func IsErrUserNotExist(err error) bool {
  767. _, ok := err.(ErrUserNotExist)
  768. return ok
  769. }
  770. func (err ErrUserNotExist) Error() string {
  771. return fmt.Sprintf("user does not exist: %v", err.args)
  772. }
  773. func (ErrUserNotExist) NotFound() bool {
  774. return true
  775. }
  776. func getUserByID(e Engine, id int64) (*User, error) {
  777. u := new(User)
  778. has, err := e.ID(id).Get(u)
  779. if err != nil {
  780. return nil, err
  781. } else if !has {
  782. return nil, ErrUserNotExist{args: map[string]interface{}{"userID": id}}
  783. }
  784. return u, nil
  785. }
  786. // GetUserByID returns the user object by given ID if exists.
  787. // Deprecated: Use Users.GetByID instead.
  788. func GetUserByID(id int64) (*User, error) {
  789. return getUserByID(x, id)
  790. }
  791. // GetAssigneeByID returns the user with write access of repository by given ID.
  792. func GetAssigneeByID(repo *Repository, userID int64) (*User, error) {
  793. has, err := HasAccess(userID, repo, AccessModeRead)
  794. if err != nil {
  795. return nil, err
  796. } else if !has {
  797. return nil, ErrUserNotExist{args: map[string]interface{}{"userID": userID}}
  798. }
  799. return GetUserByID(userID)
  800. }
  801. // GetUserByName returns a user by given name.
  802. // Deprecated: Use Users.GetByUsername instead.
  803. func GetUserByName(name string) (*User, error) {
  804. if len(name) == 0 {
  805. return nil, ErrUserNotExist{args: map[string]interface{}{"name": name}}
  806. }
  807. u := &User{LowerName: strings.ToLower(name)}
  808. has, err := x.Get(u)
  809. if err != nil {
  810. return nil, err
  811. } else if !has {
  812. return nil, ErrUserNotExist{args: map[string]interface{}{"name": name}}
  813. }
  814. return u, nil
  815. }
  816. // GetUserEmailsByNames returns a list of e-mails corresponds to names.
  817. func GetUserEmailsByNames(names []string) []string {
  818. mails := make([]string, 0, len(names))
  819. for _, name := range names {
  820. u, err := GetUserByName(name)
  821. if err != nil {
  822. continue
  823. }
  824. if u.IsMailable() {
  825. mails = append(mails, u.Email)
  826. }
  827. }
  828. return mails
  829. }
  830. // GetUserIDsByNames returns a slice of ids corresponds to names.
  831. func GetUserIDsByNames(names []string) []int64 {
  832. ids := make([]int64, 0, len(names))
  833. for _, name := range names {
  834. u, err := GetUserByName(name)
  835. if err != nil {
  836. continue
  837. }
  838. ids = append(ids, u.ID)
  839. }
  840. return ids
  841. }
  842. // UserCommit represents a commit with validation of user.
  843. type UserCommit struct {
  844. User *User
  845. *git.Commit
  846. }
  847. // ValidateCommitWithEmail chceck if author's e-mail of commit is corresponsind to a user.
  848. func ValidateCommitWithEmail(c *git.Commit) *User {
  849. u, err := GetUserByEmail(c.Author.Email)
  850. if err != nil {
  851. return nil
  852. }
  853. return u
  854. }
  855. // ValidateCommitsWithEmails checks if authors' e-mails of commits are corresponding to users.
  856. func ValidateCommitsWithEmails(oldCommits []*git.Commit) []*UserCommit {
  857. emails := make(map[string]*User)
  858. newCommits := make([]*UserCommit, len(oldCommits))
  859. for i := range oldCommits {
  860. var u *User
  861. if v, ok := emails[oldCommits[i].Author.Email]; !ok {
  862. u, _ = GetUserByEmail(oldCommits[i].Author.Email)
  863. emails[oldCommits[i].Author.Email] = u
  864. } else {
  865. u = v
  866. }
  867. newCommits[i] = &UserCommit{
  868. User: u,
  869. Commit: oldCommits[i],
  870. }
  871. }
  872. return newCommits
  873. }
  874. // GetUserByEmail returns the user object by given e-mail if exists.
  875. func GetUserByEmail(email string) (*User, error) {
  876. if len(email) == 0 {
  877. return nil, ErrUserNotExist{args: map[string]interface{}{"email": email}}
  878. }
  879. email = strings.ToLower(email)
  880. // First try to find the user by primary email
  881. user := &User{Email: email}
  882. has, err := x.Get(user)
  883. if err != nil {
  884. return nil, err
  885. }
  886. if has {
  887. return user, nil
  888. }
  889. // Otherwise, check in alternative list for activated email addresses
  890. emailAddress := &EmailAddress{Email: email, IsActivated: true}
  891. has, err = x.Get(emailAddress)
  892. if err != nil {
  893. return nil, err
  894. }
  895. if has {
  896. return GetUserByID(emailAddress.UID)
  897. }
  898. return nil, ErrUserNotExist{args: map[string]interface{}{"email": email}}
  899. }
  900. type SearchUserOptions struct {
  901. Keyword string
  902. Type UserType
  903. OrderBy string
  904. Page int
  905. PageSize int // Can be smaller than or equal to setting.UI.ExplorePagingNum
  906. }
  907. // SearchUserByName takes keyword and part of user name to search,
  908. // it returns results in given range and number of total results.
  909. func SearchUserByName(opts *SearchUserOptions) (users []*User, _ int64, _ error) {
  910. if len(opts.Keyword) == 0 {
  911. return users, 0, nil
  912. }
  913. opts.Keyword = strings.ToLower(opts.Keyword)
  914. if opts.PageSize <= 0 || opts.PageSize > conf.UI.ExplorePagingNum {
  915. opts.PageSize = conf.UI.ExplorePagingNum
  916. }
  917. if opts.Page <= 0 {
  918. opts.Page = 1
  919. }
  920. searchQuery := "%" + opts.Keyword + "%"
  921. users = make([]*User, 0, opts.PageSize)
  922. // Append conditions
  923. sess := x.Where("LOWER(lower_name) LIKE ?", searchQuery).
  924. Or("LOWER(full_name) LIKE ?", searchQuery).
  925. And("type = ?", opts.Type)
  926. countSess := *sess
  927. count, err := countSess.Count(new(User))
  928. if err != nil {
  929. return nil, 0, fmt.Errorf("Count: %v", err)
  930. }
  931. if len(opts.OrderBy) > 0 {
  932. sess.OrderBy(opts.OrderBy)
  933. }
  934. return users, count, sess.Limit(opts.PageSize, (opts.Page-1)*opts.PageSize).Find(&users)
  935. }
  936. // ___________ .__ .__
  937. // \_ _____/___ | | | | ______ _ __
  938. // | __)/ _ \| | | | / _ \ \/ \/ /
  939. // | \( <_> ) |_| |_( <_> ) /
  940. // \___ / \____/|____/____/\____/ \/\_/
  941. // \/
  942. // Follow represents relations of user and his/her followers.
  943. type Follow struct {
  944. ID int64
  945. UserID int64 `xorm:"UNIQUE(follow)"`
  946. FollowID int64 `xorm:"UNIQUE(follow)"`
  947. }
  948. func IsFollowing(userID, followID int64) bool {
  949. has, _ := x.Get(&Follow{UserID: userID, FollowID: followID})
  950. return has
  951. }
  952. // FollowUser marks someone be another's follower.
  953. func FollowUser(userID, followID int64) (err error) {
  954. if userID == followID || IsFollowing(userID, followID) {
  955. return nil
  956. }
  957. sess := x.NewSession()
  958. defer sess.Close()
  959. if err = sess.Begin(); err != nil {
  960. return err
  961. }
  962. if _, err = sess.Insert(&Follow{UserID: userID, FollowID: followID}); err != nil {
  963. return err
  964. }
  965. if _, err = sess.Exec("UPDATE `user` SET num_followers = num_followers + 1 WHERE id = ?", followID); err != nil {
  966. return err
  967. }
  968. if _, err = sess.Exec("UPDATE `user` SET num_following = num_following + 1 WHERE id = ?", userID); err != nil {
  969. return err
  970. }
  971. return sess.Commit()
  972. }
  973. // UnfollowUser unmarks someone be another's follower.
  974. func UnfollowUser(userID, followID int64) (err error) {
  975. if userID == followID || !IsFollowing(userID, followID) {
  976. return nil
  977. }
  978. sess := x.NewSession()
  979. defer sess.Close()
  980. if err = sess.Begin(); err != nil {
  981. return err
  982. }
  983. if _, err = sess.Delete(&Follow{UserID: userID, FollowID: followID}); err != nil {
  984. return err
  985. }
  986. if _, err = sess.Exec("UPDATE `user` SET num_followers = num_followers - 1 WHERE id = ?", followID); err != nil {
  987. return err
  988. }
  989. if _, err = sess.Exec("UPDATE `user` SET num_following = num_following - 1 WHERE id = ?", userID); err != nil {
  990. return err
  991. }
  992. return sess.Commit()
  993. }