user.go 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833
  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. "context"
  7. "encoding/hex"
  8. "fmt"
  9. _ "image/jpeg"
  10. "os"
  11. "path/filepath"
  12. "strings"
  13. "time"
  14. "unicode/utf8"
  15. "github.com/unknwon/com"
  16. log "unknwon.dev/clog/v2"
  17. "xorm.io/xorm"
  18. "github.com/gogs/git-module"
  19. "gogs.io/gogs/internal/conf"
  20. "gogs.io/gogs/internal/db/errors"
  21. "gogs.io/gogs/internal/errutil"
  22. "gogs.io/gogs/internal/strutil"
  23. "gogs.io/gogs/internal/tool"
  24. "gogs.io/gogs/internal/userutil"
  25. )
  26. // TODO(unknwon): Delete me once refactoring is done.
  27. func (u *User) BeforeInsert() {
  28. u.CreatedUnix = time.Now().Unix()
  29. u.UpdatedUnix = u.CreatedUnix
  30. }
  31. // TODO(unknwon): Refactoring together with methods that do updates.
  32. func (u *User) BeforeUpdate() {
  33. if u.MaxRepoCreation < -1 {
  34. u.MaxRepoCreation = -1
  35. }
  36. u.UpdatedUnix = time.Now().Unix()
  37. }
  38. // TODO(unknwon): Delete me once refactoring is done.
  39. func (u *User) AfterSet(colName string, _ xorm.Cell) {
  40. switch colName {
  41. case "created_unix":
  42. u.Created = time.Unix(u.CreatedUnix, 0).Local()
  43. case "updated_unix":
  44. u.Updated = time.Unix(u.UpdatedUnix, 0).Local()
  45. }
  46. }
  47. // IsAdminOfRepo returns true if user has admin or higher access of repository.
  48. func (u *User) IsAdminOfRepo(repo *Repository) bool {
  49. return Perms.Authorize(context.TODO(), u.ID, repo.ID, AccessModeAdmin,
  50. AccessModeOptions{
  51. OwnerID: repo.OwnerID,
  52. Private: repo.IsPrivate,
  53. },
  54. )
  55. }
  56. // IsWriterOfRepo returns true if user has write access to given repository.
  57. func (u *User) IsWriterOfRepo(repo *Repository) bool {
  58. return Perms.Authorize(context.TODO(), u.ID, repo.ID, AccessModeWrite,
  59. AccessModeOptions{
  60. OwnerID: repo.OwnerID,
  61. Private: repo.IsPrivate,
  62. },
  63. )
  64. }
  65. // IsOrganization returns true if user is actually a organization.
  66. func (u *User) IsOrganization() bool {
  67. return u.Type == UserTypeOrganization
  68. }
  69. // IsUserOrgOwner returns true if user is in the owner team of given organization.
  70. func (u *User) IsUserOrgOwner(orgId int64) bool {
  71. return IsOrganizationOwner(orgId, u.ID)
  72. }
  73. // IsPublicMember returns true if user public his/her membership in give organization.
  74. func (u *User) IsPublicMember(orgId int64) bool {
  75. return IsPublicMembership(orgId, u.ID)
  76. }
  77. // IsEnabledTwoFactor returns true if user has enabled two-factor authentication.
  78. func (u *User) IsEnabledTwoFactor() bool {
  79. return TwoFactors.IsUserEnabled(context.TODO(), u.ID)
  80. }
  81. func (u *User) getOrganizationCount(e Engine) (int64, error) {
  82. return e.Where("uid=?", u.ID).Count(new(OrgUser))
  83. }
  84. // GetOrganizationCount returns count of membership of organization of user.
  85. func (u *User) GetOrganizationCount() (int64, error) {
  86. return u.getOrganizationCount(x)
  87. }
  88. // GetRepositories returns repositories that user owns, including private repositories.
  89. func (u *User) GetRepositories(page, pageSize int) (err error) {
  90. u.Repos, err = GetUserRepositories(&UserRepoOptions{
  91. UserID: u.ID,
  92. Private: true,
  93. Page: page,
  94. PageSize: pageSize,
  95. })
  96. return err
  97. }
  98. // GetRepositories returns mirror repositories that user owns, including private repositories.
  99. func (u *User) GetMirrorRepositories() ([]*Repository, error) {
  100. return GetUserMirrorRepositories(u.ID)
  101. }
  102. // GetOwnedOrganizations returns all organizations that user owns.
  103. func (u *User) GetOwnedOrganizations() (err error) {
  104. u.OwnedOrgs, err = GetOwnedOrgsByUserID(u.ID)
  105. return err
  106. }
  107. // GetOrganizations returns all organizations that user belongs to.
  108. func (u *User) GetOrganizations(showPrivate bool) error {
  109. orgIDs, err := GetOrgIDsByUserID(u.ID, showPrivate)
  110. if err != nil {
  111. return fmt.Errorf("GetOrgIDsByUserID: %v", err)
  112. }
  113. if len(orgIDs) == 0 {
  114. return nil
  115. }
  116. u.Orgs = make([]*User, 0, len(orgIDs))
  117. if err = x.Where("type = ?", UserTypeOrganization).In("id", orgIDs).Find(&u.Orgs); err != nil {
  118. return err
  119. }
  120. return nil
  121. }
  122. // DisplayName returns full name if it's not empty,
  123. // returns username otherwise.
  124. func (u *User) DisplayName() string {
  125. if len(u.FullName) > 0 {
  126. return u.FullName
  127. }
  128. return u.Name
  129. }
  130. func (u *User) ShortName(length int) string {
  131. return strutil.Ellipsis(u.Name, length)
  132. }
  133. // IsMailable checks if a user is eligible
  134. // to receive emails.
  135. func (u *User) IsMailable() bool {
  136. return u.IsActive
  137. }
  138. // IsUserExist checks if given user name exist,
  139. // the user name should be noncased unique.
  140. // If uid is presented, then check will rule out that one,
  141. // it is used when update a user name in settings page.
  142. func IsUserExist(uid int64, name string) (bool, error) {
  143. if name == "" {
  144. return false, nil
  145. }
  146. return x.Where("id != ?", uid).Get(&User{LowerName: strings.ToLower(name)})
  147. }
  148. // GetUserSalt returns a random user salt token.
  149. func GetUserSalt() (string, error) {
  150. return strutil.RandomChars(10)
  151. }
  152. // NewGhostUser creates and returns a fake user for someone who has deleted his/her account.
  153. func NewGhostUser() *User {
  154. return &User{
  155. ID: -1,
  156. Name: "Ghost",
  157. LowerName: "ghost",
  158. }
  159. }
  160. var (
  161. 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", ".", ".."}
  162. reservedUserPatterns = []string{"*.keys"}
  163. )
  164. type ErrNameNotAllowed struct {
  165. args errutil.Args
  166. }
  167. func IsErrNameNotAllowed(err error) bool {
  168. _, ok := err.(ErrNameNotAllowed)
  169. return ok
  170. }
  171. func (err ErrNameNotAllowed) Value() string {
  172. val, ok := err.args["name"].(string)
  173. if ok {
  174. return val
  175. }
  176. val, ok = err.args["pattern"].(string)
  177. if ok {
  178. return val
  179. }
  180. return "<value not found>"
  181. }
  182. func (err ErrNameNotAllowed) Error() string {
  183. return fmt.Sprintf("name is not allowed: %v", err.args)
  184. }
  185. // isNameAllowed checks if name is reserved or pattern of name is not allowed
  186. // based on given reserved names and patterns.
  187. // Names are exact match, patterns can be prefix or suffix match with placeholder '*'.
  188. func isNameAllowed(names, patterns []string, name string) error {
  189. name = strings.TrimSpace(strings.ToLower(name))
  190. if utf8.RuneCountInString(name) == 0 {
  191. return ErrNameNotAllowed{args: errutil.Args{"reason": "empty name"}}
  192. }
  193. for i := range names {
  194. if name == names[i] {
  195. return ErrNameNotAllowed{args: errutil.Args{"reason": "reserved", "name": name}}
  196. }
  197. }
  198. for _, pat := range patterns {
  199. if pat[0] == '*' && strings.HasSuffix(name, pat[1:]) ||
  200. (pat[len(pat)-1] == '*' && strings.HasPrefix(name, pat[:len(pat)-1])) {
  201. return ErrNameNotAllowed{args: errutil.Args{"reason": "reserved", "pattern": pat}}
  202. }
  203. }
  204. return nil
  205. }
  206. // isUsernameAllowed return an error if given name is a reserved name or pattern for users.
  207. func isUsernameAllowed(name string) error {
  208. return isNameAllowed(reservedUsernames, reservedUserPatterns, name)
  209. }
  210. // CreateUser creates record of a new user.
  211. // Deprecated: Use Users.Create instead.
  212. func CreateUser(u *User) (err error) {
  213. if err = isUsernameAllowed(u.Name); err != nil {
  214. return err
  215. }
  216. isExist, err := IsUserExist(0, u.Name)
  217. if err != nil {
  218. return err
  219. } else if isExist {
  220. return ErrUserAlreadyExist{args: errutil.Args{"name": u.Name}}
  221. }
  222. u.Email = strings.ToLower(u.Email)
  223. isExist, err = IsEmailUsed(u.Email)
  224. if err != nil {
  225. return err
  226. } else if isExist {
  227. return ErrEmailAlreadyUsed{args: errutil.Args{"email": u.Email}}
  228. }
  229. u.LowerName = strings.ToLower(u.Name)
  230. u.AvatarEmail = u.Email
  231. u.Avatar = tool.HashEmail(u.AvatarEmail)
  232. if u.Rands, err = GetUserSalt(); err != nil {
  233. return err
  234. }
  235. if u.Salt, err = GetUserSalt(); err != nil {
  236. return err
  237. }
  238. u.Password = userutil.EncodePassword(u.Password, u.Salt)
  239. u.MaxRepoCreation = -1
  240. sess := x.NewSession()
  241. defer sess.Close()
  242. if err = sess.Begin(); err != nil {
  243. return err
  244. }
  245. if _, err = sess.Insert(u); err != nil {
  246. return err
  247. } else if err = os.MkdirAll(UserPath(u.Name), os.ModePerm); err != nil {
  248. return err
  249. }
  250. return sess.Commit()
  251. }
  252. func countUsers(e Engine) int64 {
  253. count, _ := e.Where("type=0").Count(new(User))
  254. return count
  255. }
  256. // CountUsers returns number of users.
  257. func CountUsers() int64 {
  258. return countUsers(x)
  259. }
  260. // Users returns number of users in given page.
  261. func ListUsers(page, pageSize int) ([]*User, error) {
  262. users := make([]*User, 0, pageSize)
  263. return users, x.Limit(pageSize, (page-1)*pageSize).Where("type=0").Asc("id").Find(&users)
  264. }
  265. // parseUserFromCode returns user by username encoded in code.
  266. // It returns nil if code or username is invalid.
  267. func parseUserFromCode(code string) (user *User) {
  268. if len(code) <= tool.TIME_LIMIT_CODE_LENGTH {
  269. return nil
  270. }
  271. // Use tail hex username to query user
  272. hexStr := code[tool.TIME_LIMIT_CODE_LENGTH:]
  273. if b, err := hex.DecodeString(hexStr); err == nil {
  274. if user, err = GetUserByName(string(b)); user != nil {
  275. return user
  276. } else if !IsErrUserNotExist(err) {
  277. log.Error("Failed to get user by name %q: %v", string(b), err)
  278. }
  279. }
  280. return nil
  281. }
  282. // verify active code when active account
  283. func VerifyUserActiveCode(code string) (user *User) {
  284. minutes := conf.Auth.ActivateCodeLives
  285. if user = parseUserFromCode(code); user != nil {
  286. // time limit code
  287. prefix := code[:tool.TIME_LIMIT_CODE_LENGTH]
  288. data := com.ToStr(user.ID) + user.Email + user.LowerName + user.Password + user.Rands
  289. if tool.VerifyTimeLimitCode(data, minutes, prefix) {
  290. return user
  291. }
  292. }
  293. return nil
  294. }
  295. // verify active code when active account
  296. func VerifyActiveEmailCode(code, email string) *EmailAddress {
  297. minutes := conf.Auth.ActivateCodeLives
  298. if user := parseUserFromCode(code); user != nil {
  299. // time limit code
  300. prefix := code[:tool.TIME_LIMIT_CODE_LENGTH]
  301. data := com.ToStr(user.ID) + email + user.LowerName + user.Password + user.Rands
  302. if tool.VerifyTimeLimitCode(data, minutes, prefix) {
  303. emailAddress := &EmailAddress{Email: email}
  304. if has, _ := x.Get(emailAddress); has {
  305. return emailAddress
  306. }
  307. }
  308. }
  309. return nil
  310. }
  311. // ChangeUserName changes all corresponding setting from old user name to new one.
  312. func ChangeUserName(u *User, newUserName string) (err error) {
  313. if err = isUsernameAllowed(newUserName); err != nil {
  314. return err
  315. }
  316. isExist, err := IsUserExist(0, newUserName)
  317. if err != nil {
  318. return err
  319. } else if isExist {
  320. return ErrUserAlreadyExist{args: errutil.Args{"name": newUserName}}
  321. }
  322. if err = ChangeUsernameInPullRequests(u.Name, newUserName); err != nil {
  323. return fmt.Errorf("ChangeUsernameInPullRequests: %v", err)
  324. }
  325. // Delete all local copies of repositories and wikis the user owns.
  326. if err = x.Where("owner_id=?", u.ID).Iterate(new(Repository), func(idx int, bean interface{}) error {
  327. repo := bean.(*Repository)
  328. deleteRepoLocalCopy(repo)
  329. // TODO: By the same reasoning, shouldn't we also sync access to the local wiki path?
  330. RemoveAllWithNotice("Delete repository wiki local copy", repo.LocalWikiPath())
  331. return nil
  332. }); err != nil {
  333. return fmt.Errorf("delete repository and wiki local copy: %v", err)
  334. }
  335. // Rename or create user base directory
  336. baseDir := UserPath(u.Name)
  337. newBaseDir := UserPath(newUserName)
  338. if com.IsExist(baseDir) {
  339. return os.Rename(baseDir, newBaseDir)
  340. }
  341. return os.MkdirAll(newBaseDir, os.ModePerm)
  342. }
  343. func updateUser(e Engine, u *User) error {
  344. // Organization does not need email
  345. if !u.IsOrganization() {
  346. u.Email = strings.ToLower(u.Email)
  347. has, err := e.Where("id!=?", u.ID).And("type=?", u.Type).And("email=?", u.Email).Get(new(User))
  348. if err != nil {
  349. return err
  350. } else if has {
  351. return ErrEmailAlreadyUsed{args: errutil.Args{"email": u.Email}}
  352. }
  353. if u.AvatarEmail == "" {
  354. u.AvatarEmail = u.Email
  355. }
  356. u.Avatar = tool.HashEmail(u.AvatarEmail)
  357. }
  358. u.LowerName = strings.ToLower(u.Name)
  359. u.Location = tool.TruncateString(u.Location, 255)
  360. u.Website = tool.TruncateString(u.Website, 255)
  361. u.Description = tool.TruncateString(u.Description, 255)
  362. _, err := e.ID(u.ID).AllCols().Update(u)
  363. return err
  364. }
  365. // UpdateUser updates user's information.
  366. func UpdateUser(u *User) error {
  367. return updateUser(x, u)
  368. }
  369. // deleteBeans deletes all given beans, beans should contain delete conditions.
  370. func deleteBeans(e Engine, beans ...interface{}) (err error) {
  371. for i := range beans {
  372. if _, err = e.Delete(beans[i]); err != nil {
  373. return err
  374. }
  375. }
  376. return nil
  377. }
  378. // FIXME: need some kind of mechanism to record failure. HINT: system notice
  379. func deleteUser(e *xorm.Session, u *User) error {
  380. // Note: A user owns any repository or belongs to any organization
  381. // cannot perform delete operation.
  382. // Check ownership of repository.
  383. count, err := getRepositoryCount(e, u)
  384. if err != nil {
  385. return fmt.Errorf("GetRepositoryCount: %v", err)
  386. } else if count > 0 {
  387. return ErrUserOwnRepos{UID: u.ID}
  388. }
  389. // Check membership of organization.
  390. count, err = u.getOrganizationCount(e)
  391. if err != nil {
  392. return fmt.Errorf("GetOrganizationCount: %v", err)
  393. } else if count > 0 {
  394. return ErrUserHasOrgs{UID: u.ID}
  395. }
  396. // ***** START: Watch *****
  397. watches := make([]*Watch, 0, 10)
  398. if err = e.Find(&watches, &Watch{UserID: u.ID}); err != nil {
  399. return fmt.Errorf("get all watches: %v", err)
  400. }
  401. for i := range watches {
  402. if _, err = e.Exec("UPDATE `repository` SET num_watches=num_watches-1 WHERE id=?", watches[i].RepoID); err != nil {
  403. return fmt.Errorf("decrease repository watch number[%d]: %v", watches[i].RepoID, err)
  404. }
  405. }
  406. // ***** END: Watch *****
  407. // ***** START: Star *****
  408. stars := make([]*Star, 0, 10)
  409. if err = e.Find(&stars, &Star{UID: u.ID}); err != nil {
  410. return fmt.Errorf("get all stars: %v", err)
  411. }
  412. for i := range stars {
  413. if _, err = e.Exec("UPDATE `repository` SET num_stars=num_stars-1 WHERE id=?", stars[i].RepoID); err != nil {
  414. return fmt.Errorf("decrease repository star number[%d]: %v", stars[i].RepoID, err)
  415. }
  416. }
  417. // ***** END: Star *****
  418. // ***** START: Follow *****
  419. followers := make([]*Follow, 0, 10)
  420. if err = e.Find(&followers, &Follow{UserID: u.ID}); err != nil {
  421. return fmt.Errorf("get all followers: %v", err)
  422. }
  423. for i := range followers {
  424. if _, err = e.Exec("UPDATE `user` SET num_followers=num_followers-1 WHERE id=?", followers[i].UserID); err != nil {
  425. return fmt.Errorf("decrease user follower number[%d]: %v", followers[i].UserID, err)
  426. }
  427. }
  428. // ***** END: Follow *****
  429. if err = deleteBeans(e,
  430. &AccessToken{UserID: u.ID},
  431. &Collaboration{UserID: u.ID},
  432. &Access{UserID: u.ID},
  433. &Watch{UserID: u.ID},
  434. &Star{UID: u.ID},
  435. &Follow{FollowID: u.ID},
  436. &Action{UserID: u.ID},
  437. &IssueUser{UID: u.ID},
  438. &EmailAddress{UID: u.ID},
  439. ); err != nil {
  440. return fmt.Errorf("deleteBeans: %v", err)
  441. }
  442. // ***** START: PublicKey *****
  443. keys := make([]*PublicKey, 0, 10)
  444. if err = e.Find(&keys, &PublicKey{OwnerID: u.ID}); err != nil {
  445. return fmt.Errorf("get all public keys: %v", err)
  446. }
  447. keyIDs := make([]int64, len(keys))
  448. for i := range keys {
  449. keyIDs[i] = keys[i].ID
  450. }
  451. if err = deletePublicKeys(e, keyIDs...); err != nil {
  452. return fmt.Errorf("deletePublicKeys: %v", err)
  453. }
  454. // ***** END: PublicKey *****
  455. // Clear assignee.
  456. if _, err = e.Exec("UPDATE `issue` SET assignee_id=0 WHERE assignee_id=?", u.ID); err != nil {
  457. return fmt.Errorf("clear assignee: %v", err)
  458. }
  459. if _, err = e.ID(u.ID).Delete(new(User)); err != nil {
  460. return fmt.Errorf("Delete: %v", err)
  461. }
  462. // FIXME: system notice
  463. // Note: There are something just cannot be roll back,
  464. // so just keep error logs of those operations.
  465. _ = os.RemoveAll(UserPath(u.Name))
  466. _ = os.Remove(userutil.CustomAvatarPath(u.ID))
  467. return nil
  468. }
  469. // DeleteUser completely and permanently deletes everything of a user,
  470. // but issues/comments/pulls will be kept and shown as someone has been deleted.
  471. func DeleteUser(u *User) (err error) {
  472. sess := x.NewSession()
  473. defer sess.Close()
  474. if err = sess.Begin(); err != nil {
  475. return err
  476. }
  477. if err = deleteUser(sess, u); err != nil {
  478. // Note: don't wrapper error here.
  479. return err
  480. }
  481. if err = sess.Commit(); err != nil {
  482. return err
  483. }
  484. return RewriteAuthorizedKeys()
  485. }
  486. // DeleteInactivateUsers deletes all inactivate users and email addresses.
  487. func DeleteInactivateUsers() (err error) {
  488. users := make([]*User, 0, 10)
  489. if err = x.Where("is_active = ?", false).Find(&users); err != nil {
  490. return fmt.Errorf("get all inactive users: %v", err)
  491. }
  492. // FIXME: should only update authorized_keys file once after all deletions.
  493. for _, u := range users {
  494. if err = DeleteUser(u); err != nil {
  495. // Ignore users that were set inactive by admin.
  496. if IsErrUserOwnRepos(err) || IsErrUserHasOrgs(err) {
  497. continue
  498. }
  499. return err
  500. }
  501. }
  502. _, err = x.Where("is_activated = ?", false).Delete(new(EmailAddress))
  503. return err
  504. }
  505. // UserPath returns the path absolute path of user repositories.
  506. //
  507. // Deprecated: Use repoutil.UserPath instead.
  508. func UserPath(username string) string {
  509. return filepath.Join(conf.Repository.Root, strings.ToLower(username))
  510. }
  511. func GetUserByKeyID(keyID int64) (*User, error) {
  512. user := new(User)
  513. 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)
  514. if err != nil {
  515. return nil, err
  516. } else if !has {
  517. return nil, errors.UserNotKeyOwner{KeyID: keyID}
  518. }
  519. return user, nil
  520. }
  521. func getUserByID(e Engine, id int64) (*User, error) {
  522. u := new(User)
  523. has, err := e.ID(id).Get(u)
  524. if err != nil {
  525. return nil, err
  526. } else if !has {
  527. return nil, ErrUserNotExist{args: map[string]interface{}{"userID": id}}
  528. }
  529. return u, nil
  530. }
  531. // GetUserByID returns the user object by given ID if exists.
  532. // Deprecated: Use Users.GetByID instead.
  533. func GetUserByID(id int64) (*User, error) {
  534. return getUserByID(x, id)
  535. }
  536. // GetAssigneeByID returns the user with read access of repository by given ID.
  537. func GetAssigneeByID(repo *Repository, userID int64) (*User, error) {
  538. ctx := context.TODO()
  539. if !Perms.Authorize(ctx, userID, repo.ID, AccessModeRead,
  540. AccessModeOptions{
  541. OwnerID: repo.OwnerID,
  542. Private: repo.IsPrivate,
  543. },
  544. ) {
  545. return nil, ErrUserNotExist{args: map[string]interface{}{"userID": userID}}
  546. }
  547. return Users.GetByID(ctx, userID)
  548. }
  549. // GetUserByName returns a user by given name.
  550. // Deprecated: Use Users.GetByUsername instead.
  551. func GetUserByName(name string) (*User, error) {
  552. if name == "" {
  553. return nil, ErrUserNotExist{args: map[string]interface{}{"name": name}}
  554. }
  555. u := &User{LowerName: strings.ToLower(name)}
  556. has, err := x.Get(u)
  557. if err != nil {
  558. return nil, err
  559. } else if !has {
  560. return nil, ErrUserNotExist{args: map[string]interface{}{"name": name}}
  561. }
  562. return u, nil
  563. }
  564. // GetUserEmailsByNames returns a list of e-mails corresponds to names.
  565. func GetUserEmailsByNames(names []string) []string {
  566. mails := make([]string, 0, len(names))
  567. for _, name := range names {
  568. u, err := GetUserByName(name)
  569. if err != nil {
  570. continue
  571. }
  572. if u.IsMailable() {
  573. mails = append(mails, u.Email)
  574. }
  575. }
  576. return mails
  577. }
  578. // GetUserIDsByNames returns a slice of ids corresponds to names.
  579. func GetUserIDsByNames(names []string) []int64 {
  580. ids := make([]int64, 0, len(names))
  581. for _, name := range names {
  582. u, err := GetUserByName(name)
  583. if err != nil {
  584. continue
  585. }
  586. ids = append(ids, u.ID)
  587. }
  588. return ids
  589. }
  590. // UserCommit represents a commit with validation of user.
  591. type UserCommit struct {
  592. User *User
  593. *git.Commit
  594. }
  595. // ValidateCommitWithEmail checks if author's e-mail of commit is corresponding to a user.
  596. func ValidateCommitWithEmail(c *git.Commit) *User {
  597. u, err := GetUserByEmail(c.Author.Email)
  598. if err != nil {
  599. return nil
  600. }
  601. return u
  602. }
  603. // ValidateCommitsWithEmails checks if authors' e-mails of commits are corresponding to users.
  604. func ValidateCommitsWithEmails(oldCommits []*git.Commit) []*UserCommit {
  605. emails := make(map[string]*User)
  606. newCommits := make([]*UserCommit, len(oldCommits))
  607. for i := range oldCommits {
  608. var u *User
  609. if v, ok := emails[oldCommits[i].Author.Email]; !ok {
  610. u, _ = GetUserByEmail(oldCommits[i].Author.Email)
  611. emails[oldCommits[i].Author.Email] = u
  612. } else {
  613. u = v
  614. }
  615. newCommits[i] = &UserCommit{
  616. User: u,
  617. Commit: oldCommits[i],
  618. }
  619. }
  620. return newCommits
  621. }
  622. // GetUserByEmail returns the user object by given e-mail if exists.
  623. // Deprecated: Use Users.GetByEmail instead.
  624. func GetUserByEmail(email string) (*User, error) {
  625. if email == "" {
  626. return nil, ErrUserNotExist{args: map[string]interface{}{"email": email}}
  627. }
  628. email = strings.ToLower(email)
  629. // First try to find the user by primary email
  630. user := &User{Email: email}
  631. has, err := x.Get(user)
  632. if err != nil {
  633. return nil, err
  634. }
  635. if has {
  636. return user, nil
  637. }
  638. // Otherwise, check in alternative list for activated email addresses
  639. emailAddress := &EmailAddress{Email: email, IsActivated: true}
  640. has, err = x.Get(emailAddress)
  641. if err != nil {
  642. return nil, err
  643. }
  644. if has {
  645. return GetUserByID(emailAddress.UID)
  646. }
  647. return nil, ErrUserNotExist{args: map[string]interface{}{"email": email}}
  648. }
  649. type SearchUserOptions struct {
  650. Keyword string
  651. Type UserType
  652. OrderBy string
  653. Page int
  654. PageSize int // Can be smaller than or equal to setting.UI.ExplorePagingNum
  655. }
  656. // SearchUserByName takes keyword and part of user name to search,
  657. // it returns results in given range and number of total results.
  658. func SearchUserByName(opts *SearchUserOptions) (users []*User, _ int64, _ error) {
  659. if opts.Keyword == "" {
  660. return users, 0, nil
  661. }
  662. opts.Keyword = strings.ToLower(opts.Keyword)
  663. if opts.PageSize <= 0 || opts.PageSize > conf.UI.ExplorePagingNum {
  664. opts.PageSize = conf.UI.ExplorePagingNum
  665. }
  666. if opts.Page <= 0 {
  667. opts.Page = 1
  668. }
  669. searchQuery := "%" + opts.Keyword + "%"
  670. users = make([]*User, 0, opts.PageSize)
  671. // Append conditions
  672. sess := x.Where("LOWER(lower_name) LIKE ?", searchQuery).
  673. Or("LOWER(full_name) LIKE ?", searchQuery).
  674. And("type = ?", opts.Type)
  675. countSess := *sess
  676. count, err := countSess.Count(new(User))
  677. if err != nil {
  678. return nil, 0, fmt.Errorf("Count: %v", err)
  679. }
  680. if len(opts.OrderBy) > 0 {
  681. sess.OrderBy(opts.OrderBy)
  682. }
  683. return users, count, sess.Limit(opts.PageSize, (opts.Page-1)*opts.PageSize).Find(&users)
  684. }
  685. // GetRepositoryAccesses finds all repositories with their access mode where a user has access but does not own.
  686. func (u *User) GetRepositoryAccesses() (map[*Repository]AccessMode, error) {
  687. accesses := make([]*Access, 0, 10)
  688. if err := x.Find(&accesses, &Access{UserID: u.ID}); err != nil {
  689. return nil, err
  690. }
  691. repos := make(map[*Repository]AccessMode, len(accesses))
  692. for _, access := range accesses {
  693. repo, err := GetRepositoryByID(access.RepoID)
  694. if err != nil {
  695. if IsErrRepoNotExist(err) {
  696. log.Error("Failed to get repository by ID: %v", err)
  697. continue
  698. }
  699. return nil, err
  700. }
  701. if repo.OwnerID == u.ID {
  702. continue
  703. }
  704. repos[repo] = access.Mode
  705. }
  706. return repos, nil
  707. }
  708. // GetAccessibleRepositories finds repositories which the user has access but does not own.
  709. // If limit is smaller than 1 means returns all found results.
  710. func (user *User) GetAccessibleRepositories(limit int) (repos []*Repository, _ error) {
  711. sess := x.Where("owner_id !=? ", user.ID).Desc("updated_unix")
  712. if limit > 0 {
  713. sess.Limit(limit)
  714. repos = make([]*Repository, 0, limit)
  715. } else {
  716. repos = make([]*Repository, 0, 10)
  717. }
  718. return repos, sess.Join("INNER", "access", "access.user_id = ? AND access.repo_id = repository.id", user.ID).Find(&repos)
  719. }