user.go 14 KB

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