user.go 21 KB

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