user.go 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619
  1. package sqlstore
  2. import (
  3. "context"
  4. "fmt"
  5. "strconv"
  6. "strings"
  7. "time"
  8. "github.com/grafana/grafana/pkg/bus"
  9. "github.com/grafana/grafana/pkg/events"
  10. "github.com/grafana/grafana/pkg/models"
  11. "github.com/grafana/grafana/pkg/setting"
  12. "github.com/grafana/grafana/pkg/util"
  13. )
  14. func (ss *SqlStore) addUserQueryAndCommandHandlers() {
  15. ss.Bus.AddHandler(ss.GetSignedInUserWithCache)
  16. bus.AddHandler("sql", GetUserById)
  17. bus.AddHandler("sql", UpdateUser)
  18. bus.AddHandler("sql", ChangeUserPassword)
  19. bus.AddHandler("sql", GetUserByLogin)
  20. bus.AddHandler("sql", GetUserByEmail)
  21. bus.AddHandler("sql", SetUsingOrg)
  22. bus.AddHandler("sql", UpdateUserLastSeenAt)
  23. bus.AddHandler("sql", GetUserProfile)
  24. bus.AddHandler("sql", SearchUsers)
  25. bus.AddHandler("sql", GetUserOrgList)
  26. bus.AddHandler("sql", DisableUser)
  27. bus.AddHandler("sql", BatchDisableUsers)
  28. bus.AddHandler("sql", DeleteUser)
  29. bus.AddHandler("sql", UpdateUserPermissions)
  30. bus.AddHandler("sql", SetUserHelpFlag)
  31. bus.AddHandlerCtx("sql", CreateUser)
  32. }
  33. func getOrgIdForNewUser(cmd *models.CreateUserCommand, sess *DBSession) (int64, error) {
  34. if cmd.SkipOrgSetup {
  35. return -1, nil
  36. }
  37. var org models.Org
  38. if setting.AutoAssignOrg {
  39. has, err := sess.Where("id=?", setting.AutoAssignOrgId).Get(&org)
  40. if err != nil {
  41. return 0, err
  42. }
  43. if has {
  44. return org.Id, nil
  45. }
  46. if setting.AutoAssignOrgId == 1 {
  47. org.Name = "Main Org."
  48. org.Id = int64(setting.AutoAssignOrgId)
  49. } else {
  50. sqlog.Info("Could not create user: organization id %v does not exist",
  51. setting.AutoAssignOrgId)
  52. return 0, fmt.Errorf("Could not create user: organization id %v does not exist",
  53. setting.AutoAssignOrgId)
  54. }
  55. } else {
  56. org.Name = cmd.OrgName
  57. if len(org.Name) == 0 {
  58. org.Name = util.StringsFallback2(cmd.Email, cmd.Login)
  59. }
  60. }
  61. org.Created = time.Now()
  62. org.Updated = time.Now()
  63. if org.Id != 0 {
  64. if _, err := sess.InsertId(&org); err != nil {
  65. return 0, err
  66. }
  67. } else {
  68. if _, err := sess.InsertOne(&org); err != nil {
  69. return 0, err
  70. }
  71. }
  72. sess.publishAfterCommit(&events.OrgCreated{
  73. Timestamp: org.Created,
  74. Id: org.Id,
  75. Name: org.Name,
  76. })
  77. return org.Id, nil
  78. }
  79. func CreateUser(ctx context.Context, cmd *models.CreateUserCommand) error {
  80. return inTransactionCtx(ctx, func(sess *DBSession) error {
  81. orgId, err := getOrgIdForNewUser(cmd, sess)
  82. if err != nil {
  83. return err
  84. }
  85. if cmd.Email == "" {
  86. cmd.Email = cmd.Login
  87. }
  88. // create user
  89. user := models.User{
  90. Email: cmd.Email,
  91. Name: cmd.Name,
  92. Login: cmd.Login,
  93. Company: cmd.Company,
  94. IsAdmin: cmd.IsAdmin,
  95. IsDisabled: cmd.IsDisabled,
  96. OrgId: orgId,
  97. EmailVerified: cmd.EmailVerified,
  98. Created: time.Now(),
  99. Updated: time.Now(),
  100. LastSeenAt: time.Now().AddDate(-10, 0, 0),
  101. }
  102. user.Salt = util.GetRandomString(10)
  103. user.Rands = util.GetRandomString(10)
  104. if len(cmd.Password) > 0 {
  105. user.Password = util.EncodePassword(cmd.Password, user.Salt)
  106. }
  107. sess.UseBool("is_admin")
  108. if _, err := sess.Insert(&user); err != nil {
  109. return err
  110. }
  111. sess.publishAfterCommit(&events.UserCreated{
  112. Timestamp: user.Created,
  113. Id: user.Id,
  114. Name: user.Name,
  115. Login: user.Login,
  116. Email: user.Email,
  117. })
  118. cmd.Result = user
  119. // create org user link
  120. if !cmd.SkipOrgSetup {
  121. orgUser := models.OrgUser{
  122. OrgId: orgId,
  123. UserId: user.Id,
  124. Role: models.ROLE_ADMIN,
  125. Created: time.Now(),
  126. Updated: time.Now(),
  127. }
  128. if setting.AutoAssignOrg && !user.IsAdmin {
  129. if len(cmd.DefaultOrgRole) > 0 {
  130. orgUser.Role = models.RoleType(cmd.DefaultOrgRole)
  131. } else {
  132. orgUser.Role = models.RoleType(setting.AutoAssignOrgRole)
  133. }
  134. }
  135. if _, err = sess.Insert(&orgUser); err != nil {
  136. return err
  137. }
  138. }
  139. return nil
  140. })
  141. }
  142. func GetUserById(query *models.GetUserByIdQuery) error {
  143. user := new(models.User)
  144. has, err := x.Id(query.Id).Get(user)
  145. if err != nil {
  146. return err
  147. } else if !has {
  148. return models.ErrUserNotFound
  149. }
  150. query.Result = user
  151. return nil
  152. }
  153. func GetUserByLogin(query *models.GetUserByLoginQuery) error {
  154. if query.LoginOrEmail == "" {
  155. return models.ErrUserNotFound
  156. }
  157. // Try and find the user by login first.
  158. // It's not sufficient to assume that a LoginOrEmail with an "@" is an email.
  159. user := &models.User{Login: query.LoginOrEmail}
  160. has, err := x.Get(user)
  161. if err != nil {
  162. return err
  163. }
  164. if !has && strings.Contains(query.LoginOrEmail, "@") {
  165. // If the user wasn't found, and it contains an "@" fallback to finding the
  166. // user by email.
  167. user = &models.User{Email: query.LoginOrEmail}
  168. has, err = x.Get(user)
  169. }
  170. if err != nil {
  171. return err
  172. } else if !has {
  173. return models.ErrUserNotFound
  174. }
  175. query.Result = user
  176. return nil
  177. }
  178. func GetUserByEmail(query *models.GetUserByEmailQuery) error {
  179. if query.Email == "" {
  180. return models.ErrUserNotFound
  181. }
  182. user := &models.User{Email: query.Email}
  183. has, err := x.Get(user)
  184. if err != nil {
  185. return err
  186. } else if !has {
  187. return models.ErrUserNotFound
  188. }
  189. query.Result = user
  190. return nil
  191. }
  192. func UpdateUser(cmd *models.UpdateUserCommand) error {
  193. return inTransaction(func(sess *DBSession) error {
  194. user := models.User{
  195. Name: cmd.Name,
  196. Email: cmd.Email,
  197. Login: cmd.Login,
  198. Theme: cmd.Theme,
  199. Updated: time.Now(),
  200. }
  201. if _, err := sess.ID(cmd.UserId).Update(&user); err != nil {
  202. return err
  203. }
  204. sess.publishAfterCommit(&events.UserUpdated{
  205. Timestamp: user.Created,
  206. Id: user.Id,
  207. Name: user.Name,
  208. Login: user.Login,
  209. Email: user.Email,
  210. })
  211. return nil
  212. })
  213. }
  214. func ChangeUserPassword(cmd *models.ChangeUserPasswordCommand) error {
  215. return inTransaction(func(sess *DBSession) error {
  216. user := models.User{
  217. Password: cmd.NewPassword,
  218. Updated: time.Now(),
  219. }
  220. _, err := sess.ID(cmd.UserId).Update(&user)
  221. return err
  222. })
  223. }
  224. func UpdateUserLastSeenAt(cmd *models.UpdateUserLastSeenAtCommand) error {
  225. return inTransaction(func(sess *DBSession) error {
  226. user := models.User{
  227. Id: cmd.UserId,
  228. LastSeenAt: time.Now(),
  229. }
  230. _, err := sess.ID(cmd.UserId).Update(&user)
  231. return err
  232. })
  233. }
  234. func SetUsingOrg(cmd *models.SetUsingOrgCommand) error {
  235. getOrgsForUserCmd := &models.GetUserOrgListQuery{UserId: cmd.UserId}
  236. GetUserOrgList(getOrgsForUserCmd)
  237. valid := false
  238. for _, other := range getOrgsForUserCmd.Result {
  239. if other.OrgId == cmd.OrgId {
  240. valid = true
  241. }
  242. }
  243. if !valid {
  244. return fmt.Errorf("user does not belong to org")
  245. }
  246. return inTransaction(func(sess *DBSession) error {
  247. return setUsingOrgInTransaction(sess, cmd.UserId, cmd.OrgId)
  248. })
  249. }
  250. func setUsingOrgInTransaction(sess *DBSession, userID int64, orgID int64) error {
  251. user := models.User{
  252. Id: userID,
  253. OrgId: orgID,
  254. }
  255. _, err := sess.ID(userID).Update(&user)
  256. return err
  257. }
  258. func GetUserProfile(query *models.GetUserProfileQuery) error {
  259. var user models.User
  260. has, err := x.Id(query.UserId).Get(&user)
  261. if err != nil {
  262. return err
  263. } else if !has {
  264. return models.ErrUserNotFound
  265. }
  266. query.Result = models.UserProfileDTO{
  267. Id: user.Id,
  268. Name: user.Name,
  269. Email: user.Email,
  270. Login: user.Login,
  271. Theme: user.Theme,
  272. IsGrafanaAdmin: user.IsAdmin,
  273. IsDisabled: user.IsDisabled,
  274. OrgId: user.OrgId,
  275. }
  276. return err
  277. }
  278. func GetUserOrgList(query *models.GetUserOrgListQuery) error {
  279. query.Result = make([]*models.UserOrgDTO, 0)
  280. sess := x.Table("org_user")
  281. sess.Join("INNER", "org", "org_user.org_id=org.id")
  282. sess.Where("org_user.user_id=?", query.UserId)
  283. sess.Cols("org.name", "org_user.role", "org_user.org_id")
  284. sess.OrderBy("org.name")
  285. err := sess.Find(&query.Result)
  286. return err
  287. }
  288. func newSignedInUserCacheKey(orgID, userID int64) string {
  289. return fmt.Sprintf("signed-in-user-%d-%d", userID, orgID)
  290. }
  291. func (ss *SqlStore) GetSignedInUserWithCache(query *models.GetSignedInUserQuery) error {
  292. cacheKey := newSignedInUserCacheKey(query.OrgId, query.UserId)
  293. if cached, found := ss.CacheService.Get(cacheKey); found {
  294. query.Result = cached.(*models.SignedInUser)
  295. return nil
  296. }
  297. err := GetSignedInUser(query)
  298. if err != nil {
  299. return err
  300. }
  301. cacheKey = newSignedInUserCacheKey(query.Result.OrgId, query.UserId)
  302. ss.CacheService.Set(cacheKey, query.Result, time.Second*5)
  303. return nil
  304. }
  305. func GetSignedInUser(query *models.GetSignedInUserQuery) error {
  306. orgId := "u.org_id"
  307. if query.OrgId > 0 {
  308. orgId = strconv.FormatInt(query.OrgId, 10)
  309. }
  310. var rawSql = `SELECT
  311. u.id as user_id,
  312. u.is_admin as is_grafana_admin,
  313. u.email as email,
  314. u.login as login,
  315. u.name as name,
  316. u.help_flags1 as help_flags1,
  317. u.last_seen_at as last_seen_at,
  318. (SELECT COUNT(*) FROM org_user where org_user.user_id = u.id) as org_count,
  319. org.name as org_name,
  320. org_user.role as org_role,
  321. org.id as org_id
  322. FROM ` + dialect.Quote("user") + ` as u
  323. LEFT OUTER JOIN org_user on org_user.org_id = ` + orgId + ` and org_user.user_id = u.id
  324. LEFT OUTER JOIN org on org.id = org_user.org_id `
  325. sess := x.Table("user")
  326. if query.UserId > 0 {
  327. sess.SQL(rawSql+"WHERE u.id=?", query.UserId)
  328. } else if query.Login != "" {
  329. sess.SQL(rawSql+"WHERE u.login=?", query.Login)
  330. } else if query.Email != "" {
  331. sess.SQL(rawSql+"WHERE u.email=?", query.Email)
  332. }
  333. var user models.SignedInUser
  334. has, err := sess.Get(&user)
  335. if err != nil {
  336. return err
  337. } else if !has {
  338. return models.ErrUserNotFound
  339. }
  340. if user.OrgRole == "" {
  341. user.OrgId = -1
  342. user.OrgName = "Org missing"
  343. }
  344. getTeamsByUserQuery := &models.GetTeamsByUserQuery{OrgId: user.OrgId, UserId: user.UserId}
  345. err = GetTeamsByUser(getTeamsByUserQuery)
  346. if err != nil {
  347. return err
  348. }
  349. user.Teams = make([]int64, len(getTeamsByUserQuery.Result))
  350. for i, t := range getTeamsByUserQuery.Result {
  351. user.Teams[i] = t.Id
  352. }
  353. query.Result = &user
  354. return err
  355. }
  356. func SearchUsers(query *models.SearchUsersQuery) error {
  357. query.Result = models.SearchUserQueryResult{
  358. Users: make([]*models.UserSearchHitDTO, 0),
  359. }
  360. queryWithWildcards := "%" + query.Query + "%"
  361. whereConditions := make([]string, 0)
  362. whereParams := make([]interface{}, 0)
  363. sess := x.Table("user").Alias("u")
  364. // Join with only most recent auth module
  365. joinCondition := `(
  366. SELECT id from user_auth
  367. WHERE user_auth.user_id = u.id
  368. ORDER BY user_auth.created DESC `
  369. joinCondition = "user_auth.id=" + joinCondition + dialect.Limit(1) + ")"
  370. sess.Join("LEFT", "user_auth", joinCondition)
  371. if query.OrgId > 0 {
  372. whereConditions = append(whereConditions, "org_id = ?")
  373. whereParams = append(whereParams, query.OrgId)
  374. }
  375. if query.Query != "" {
  376. whereConditions = append(whereConditions, "(email "+dialect.LikeStr()+" ? OR name "+dialect.LikeStr()+" ? OR login "+dialect.LikeStr()+" ?)")
  377. whereParams = append(whereParams, queryWithWildcards, queryWithWildcards, queryWithWildcards)
  378. }
  379. if query.IsDisabled != nil {
  380. whereConditions = append(whereConditions, "is_disabled = ?")
  381. whereParams = append(whereParams, query.IsDisabled)
  382. }
  383. if query.AuthModule != "" {
  384. whereConditions = append(
  385. whereConditions,
  386. `u.id IN (SELECT user_id
  387. FROM user_auth
  388. WHERE auth_module=?)`,
  389. )
  390. whereParams = append(whereParams, query.AuthModule)
  391. }
  392. if len(whereConditions) > 0 {
  393. sess.Where(strings.Join(whereConditions, " AND "), whereParams...)
  394. }
  395. offset := query.Limit * (query.Page - 1)
  396. sess.Limit(query.Limit, offset)
  397. sess.Cols("u.id", "u.email", "u.name", "u.login", "u.is_admin", "u.is_disabled", "u.last_seen_at", "user_auth.auth_module")
  398. sess.OrderBy("u.id")
  399. if err := sess.Find(&query.Result.Users); err != nil {
  400. return err
  401. }
  402. // get total
  403. user := models.User{}
  404. countSess := x.Table("user").Alias("u")
  405. if len(whereConditions) > 0 {
  406. countSess.Where(strings.Join(whereConditions, " AND "), whereParams...)
  407. }
  408. count, err := countSess.Count(&user)
  409. query.Result.TotalCount = count
  410. for _, user := range query.Result.Users {
  411. user.LastSeenAtAge = util.GetAgeString(user.LastSeenAt)
  412. }
  413. return err
  414. }
  415. func DisableUser(cmd *models.DisableUserCommand) error {
  416. user := models.User{}
  417. sess := x.Table("user")
  418. sess.ID(cmd.UserId).Get(&user)
  419. user.IsDisabled = cmd.IsDisabled
  420. sess.UseBool("is_disabled")
  421. _, err := sess.ID(cmd.UserId).Update(&user)
  422. return err
  423. }
  424. func BatchDisableUsers(cmd *models.BatchDisableUsersCommand) error {
  425. return inTransaction(func(sess *DBSession) error {
  426. userIds := cmd.UserIds
  427. if len(userIds) == 0 {
  428. return nil
  429. }
  430. user_id_params := strings.Repeat(",?", len(userIds)-1)
  431. disableSQL := "UPDATE " + dialect.Quote("user") + " SET is_disabled=? WHERE Id IN (?" + user_id_params + ")"
  432. disableParams := []interface{}{disableSQL, cmd.IsDisabled}
  433. for _, v := range userIds {
  434. disableParams = append(disableParams, v)
  435. }
  436. _, err := sess.Exec(disableParams...)
  437. if err != nil {
  438. return err
  439. }
  440. return nil
  441. })
  442. }
  443. func DeleteUser(cmd *models.DeleteUserCommand) error {
  444. return inTransaction(func(sess *DBSession) error {
  445. return deleteUserInTransaction(sess, cmd)
  446. })
  447. }
  448. func deleteUserInTransaction(sess *DBSession, cmd *models.DeleteUserCommand) error {
  449. deletes := []string{
  450. "DELETE FROM star WHERE user_id = ?",
  451. "DELETE FROM " + dialect.Quote("user") + " WHERE id = ?",
  452. "DELETE FROM org_user WHERE user_id = ?",
  453. "DELETE FROM dashboard_acl WHERE user_id = ?",
  454. "DELETE FROM preferences WHERE user_id = ?",
  455. "DELETE FROM team_member WHERE user_id = ?",
  456. "DELETE FROM user_auth WHERE user_id = ?",
  457. "DELETE FROM user_auth_token WHERE user_id = ?",
  458. "DELETE FROM quota WHERE user_id = ?",
  459. }
  460. for _, sql := range deletes {
  461. _, err := sess.Exec(sql, cmd.UserId)
  462. if err != nil {
  463. return err
  464. }
  465. }
  466. return nil
  467. }
  468. func UpdateUserPermissions(cmd *models.UpdateUserPermissionsCommand) error {
  469. return inTransaction(func(sess *DBSession) error {
  470. user := models.User{}
  471. sess.ID(cmd.UserId).Get(&user)
  472. user.IsAdmin = cmd.IsGrafanaAdmin
  473. sess.UseBool("is_admin")
  474. _, err := sess.ID(user.Id).Update(&user)
  475. if err != nil {
  476. return err
  477. }
  478. // validate that after update there is at least one server admin
  479. if err := validateOneAdminLeft(sess); err != nil {
  480. return err
  481. }
  482. return nil
  483. })
  484. }
  485. func SetUserHelpFlag(cmd *models.SetUserHelpFlagCommand) error {
  486. return inTransaction(func(sess *DBSession) error {
  487. user := models.User{
  488. Id: cmd.UserId,
  489. HelpFlags1: cmd.HelpFlags1,
  490. Updated: time.Now(),
  491. }
  492. _, err := sess.ID(cmd.UserId).Cols("help_flags1").Update(&user)
  493. return err
  494. })
  495. }
  496. func validateOneAdminLeft(sess *DBSession) error {
  497. // validate that there is an admin user left
  498. count, err := sess.Where("is_admin=?", true).Count(&models.User{})
  499. if err != nil {
  500. return err
  501. }
  502. if count == 0 {
  503. return models.ErrLastGrafanaAdmin
  504. }
  505. return nil
  506. }