user.go 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473
  1. package user
  2. import (
  3. "context"
  4. "database/sql"
  5. "fmt"
  6. "sort"
  7. "strings"
  8. "time"
  9. "github.com/owncast/owncast/config"
  10. "github.com/owncast/owncast/core/data"
  11. "github.com/owncast/owncast/db"
  12. "github.com/owncast/owncast/utils"
  13. "github.com/pkg/errors"
  14. "github.com/teris-io/shortid"
  15. log "github.com/sirupsen/logrus"
  16. )
  17. var _datastore *data.Datastore
  18. const (
  19. moderatorScopeKey = "MODERATOR"
  20. minSuggestedUsernamePoolLength = 10
  21. )
  22. // User represents a single chat user.
  23. type User struct {
  24. CreatedAt time.Time `json:"createdAt"`
  25. DisabledAt *time.Time `json:"disabledAt,omitempty"`
  26. NameChangedAt *time.Time `json:"nameChangedAt,omitempty"`
  27. AuthenticatedAt *time.Time `json:"-"`
  28. ID string `json:"id"`
  29. DisplayName string `json:"displayName"`
  30. PreviousNames []string `json:"previousNames"`
  31. Scopes []string `json:"scopes,omitempty"`
  32. DisplayColor int `json:"displayColor"`
  33. IsBot bool `json:"isBot"`
  34. Authenticated bool `json:"authenticated"`
  35. }
  36. // IsEnabled will return if this single user is enabled.
  37. func (u *User) IsEnabled() bool {
  38. return u.DisabledAt == nil
  39. }
  40. // IsModerator will return if the user has moderation privileges.
  41. func (u *User) IsModerator() bool {
  42. _, hasModerationScope := utils.FindInSlice(u.Scopes, moderatorScopeKey)
  43. return hasModerationScope
  44. }
  45. // SetupUsers will perform the initial initialization of the user package.
  46. func SetupUsers() {
  47. _datastore = data.GetDatastore()
  48. }
  49. func generateDisplayName() string {
  50. suggestedUsernamesList := data.GetSuggestedUsernamesList()
  51. if len(suggestedUsernamesList) >= minSuggestedUsernamePoolLength {
  52. index := utils.RandomIndex(len(suggestedUsernamesList))
  53. return suggestedUsernamesList[index]
  54. } else {
  55. return utils.GeneratePhrase()
  56. }
  57. }
  58. // CreateAnonymousUser will create a new anonymous user with the provided display name.
  59. func CreateAnonymousUser(displayName string) (*User, string, error) {
  60. // Try to assign a name that was requested.
  61. if displayName != "" {
  62. // If name isn't available then generate a random one.
  63. if available, _ := IsDisplayNameAvailable(displayName); !available {
  64. displayName = generateDisplayName()
  65. }
  66. } else {
  67. displayName = generateDisplayName()
  68. }
  69. displayColor := utils.GenerateRandomDisplayColor(config.MaxUserColor)
  70. id := shortid.MustGenerate()
  71. user := &User{
  72. ID: id,
  73. DisplayName: displayName,
  74. DisplayColor: displayColor,
  75. CreatedAt: time.Now(),
  76. }
  77. // Create new user.
  78. if err := create(user); err != nil {
  79. return nil, "", err
  80. }
  81. // Assign it an access token.
  82. accessToken, err := utils.GenerateAccessToken()
  83. if err != nil {
  84. log.Errorln("Unable to create access token for new user")
  85. return nil, "", err
  86. }
  87. if err := addAccessTokenForUser(accessToken, id); err != nil {
  88. return nil, "", errors.Wrap(err, "unable to save access token for new user")
  89. }
  90. return user, accessToken, nil
  91. }
  92. // IsDisplayNameAvailable will check if the proposed name is available for use.
  93. func IsDisplayNameAvailable(displayName string) (bool, error) {
  94. if available, err := _datastore.GetQueries().IsDisplayNameAvailable(context.Background(), displayName); err != nil {
  95. return false, errors.Wrap(err, "unable to check if display name is available")
  96. } else if available != 0 {
  97. return false, nil
  98. }
  99. return true, nil
  100. }
  101. // ChangeUsername will change the user associated to userID from one display name to another.
  102. func ChangeUsername(userID string, username string) error {
  103. _datastore.DbLock.Lock()
  104. defer _datastore.DbLock.Unlock()
  105. if err := _datastore.GetQueries().ChangeDisplayName(context.Background(), db.ChangeDisplayNameParams{
  106. DisplayName: username,
  107. ID: userID,
  108. PreviousNames: sql.NullString{String: fmt.Sprintf(",%s", username), Valid: true},
  109. NamechangedAt: sql.NullTime{Time: time.Now(), Valid: true},
  110. }); err != nil {
  111. return errors.Wrap(err, "unable to change display name")
  112. }
  113. return nil
  114. }
  115. // ChangeUserColor will change the user associated to userID from one display name to another.
  116. func ChangeUserColor(userID string, color int) error {
  117. _datastore.DbLock.Lock()
  118. defer _datastore.DbLock.Unlock()
  119. if err := _datastore.GetQueries().ChangeDisplayColor(context.Background(), db.ChangeDisplayColorParams{
  120. DisplayColor: int32(color),
  121. ID: userID,
  122. }); err != nil {
  123. return errors.Wrap(err, "unable to change display color")
  124. }
  125. return nil
  126. }
  127. func addAccessTokenForUser(accessToken, userID string) error {
  128. return _datastore.GetQueries().AddAccessTokenForUser(context.Background(), db.AddAccessTokenForUserParams{
  129. Token: accessToken,
  130. UserID: userID,
  131. })
  132. }
  133. func create(user *User) error {
  134. _datastore.DbLock.Lock()
  135. defer _datastore.DbLock.Unlock()
  136. tx, err := _datastore.DB.Begin()
  137. if err != nil {
  138. log.Debugln(err)
  139. }
  140. defer func() {
  141. _ = tx.Rollback()
  142. }()
  143. stmt, err := tx.Prepare("INSERT INTO users(id, display_name, display_color, previous_names, created_at) values(?, ?, ?, ?, ?)")
  144. if err != nil {
  145. log.Debugln(err)
  146. }
  147. defer stmt.Close()
  148. _, err = stmt.Exec(user.ID, user.DisplayName, user.DisplayColor, user.DisplayName, user.CreatedAt)
  149. if err != nil {
  150. log.Errorln("error creating new user", err)
  151. return err
  152. }
  153. return tx.Commit()
  154. }
  155. // SetEnabled will set the enabled status of a single user by ID.
  156. func SetEnabled(userID string, enabled bool) error {
  157. _datastore.DbLock.Lock()
  158. defer _datastore.DbLock.Unlock()
  159. tx, err := _datastore.DB.Begin()
  160. if err != nil {
  161. return err
  162. }
  163. defer tx.Rollback() //nolint
  164. var stmt *sql.Stmt
  165. if !enabled {
  166. stmt, err = tx.Prepare("UPDATE users SET disabled_at=DATETIME('now', 'localtime') WHERE id IS ?")
  167. } else {
  168. stmt, err = tx.Prepare("UPDATE users SET disabled_at=null WHERE id IS ?")
  169. }
  170. if err != nil {
  171. return err
  172. }
  173. defer stmt.Close()
  174. if _, err := stmt.Exec(userID); err != nil {
  175. return err
  176. }
  177. return tx.Commit()
  178. }
  179. // GetUserByToken will return a user by an access token.
  180. func GetUserByToken(token string) *User {
  181. u, err := _datastore.GetQueries().GetUserByAccessToken(context.Background(), token)
  182. if err != nil {
  183. return nil
  184. }
  185. var scopes []string
  186. if u.Scopes.Valid {
  187. scopes = strings.Split(u.Scopes.String, ",")
  188. }
  189. var disabledAt *time.Time
  190. if u.DisabledAt.Valid {
  191. disabledAt = &u.DisabledAt.Time
  192. }
  193. var authenticatedAt *time.Time
  194. if u.AuthenticatedAt.Valid {
  195. authenticatedAt = &u.AuthenticatedAt.Time
  196. }
  197. return &User{
  198. ID: u.ID,
  199. DisplayName: u.DisplayName,
  200. DisplayColor: int(u.DisplayColor),
  201. CreatedAt: u.CreatedAt.Time,
  202. DisabledAt: disabledAt,
  203. PreviousNames: strings.Split(u.PreviousNames.String, ","),
  204. NameChangedAt: &u.NamechangedAt.Time,
  205. AuthenticatedAt: authenticatedAt,
  206. Authenticated: authenticatedAt != nil,
  207. Scopes: scopes,
  208. }
  209. }
  210. // SetAccessTokenToOwner will reassign an access token to be owned by a
  211. // different user. Used for logging in with external auth.
  212. func SetAccessTokenToOwner(token, userID string) error {
  213. return _datastore.GetQueries().SetAccessTokenToOwner(context.Background(), db.SetAccessTokenToOwnerParams{
  214. UserID: userID,
  215. Token: token,
  216. })
  217. }
  218. // SetUserAsAuthenticated will mark that a user has been authenticated
  219. // in some way.
  220. func SetUserAsAuthenticated(userID string) error {
  221. return errors.Wrap(_datastore.GetQueries().SetUserAsAuthenticated(context.Background(), userID), "unable to set user as authenticated")
  222. }
  223. // SetModerator will add or remove moderator status for a single user by ID.
  224. func SetModerator(userID string, isModerator bool) error {
  225. if isModerator {
  226. return addScopeToUser(userID, moderatorScopeKey)
  227. }
  228. return removeScopeFromUser(userID, moderatorScopeKey)
  229. }
  230. func addScopeToUser(userID string, scope string) error {
  231. u := GetUserByID(userID)
  232. if u == nil {
  233. return errors.New("user not found when modifying scope")
  234. }
  235. scopesString := u.Scopes
  236. scopes := utils.StringSliceToMap(scopesString)
  237. scopes[scope] = true
  238. scopesSlice := utils.StringMapKeys(scopes)
  239. return setScopesOnUser(userID, scopesSlice)
  240. }
  241. func removeScopeFromUser(userID string, scope string) error {
  242. u := GetUserByID(userID)
  243. scopesString := u.Scopes
  244. scopes := utils.StringSliceToMap(scopesString)
  245. delete(scopes, scope)
  246. scopesSlice := utils.StringMapKeys(scopes)
  247. return setScopesOnUser(userID, scopesSlice)
  248. }
  249. func setScopesOnUser(userID string, scopes []string) error {
  250. _datastore.DbLock.Lock()
  251. defer _datastore.DbLock.Unlock()
  252. tx, err := _datastore.DB.Begin()
  253. if err != nil {
  254. return err
  255. }
  256. defer tx.Rollback() //nolint
  257. scopesSliceString := strings.TrimSpace(strings.Join(scopes, ","))
  258. stmt, err := tx.Prepare("UPDATE users SET scopes=? WHERE id IS ?")
  259. if err != nil {
  260. return err
  261. }
  262. defer stmt.Close()
  263. var val *string
  264. if scopesSliceString == "" {
  265. val = nil
  266. } else {
  267. val = &scopesSliceString
  268. }
  269. if _, err := stmt.Exec(val, userID); err != nil {
  270. return err
  271. }
  272. return tx.Commit()
  273. }
  274. // GetUserByID will return a user by a user ID.
  275. func GetUserByID(id string) *User {
  276. _datastore.DbLock.Lock()
  277. defer _datastore.DbLock.Unlock()
  278. query := "SELECT id, display_name, display_color, created_at, disabled_at, previous_names, namechanged_at, scopes FROM users WHERE id = ?"
  279. row := _datastore.DB.QueryRow(query, id)
  280. if row == nil {
  281. log.Errorln(row)
  282. return nil
  283. }
  284. return getUserFromRow(row)
  285. }
  286. // GetDisabledUsers will return back all the currently disabled users that are not API users.
  287. func GetDisabledUsers() []*User {
  288. query := "SELECT id, display_name, scopes, display_color, created_at, disabled_at, previous_names, namechanged_at FROM users WHERE disabled_at IS NOT NULL AND type IS NOT 'API'"
  289. rows, err := _datastore.DB.Query(query)
  290. if err != nil {
  291. log.Errorln(err)
  292. return nil
  293. }
  294. defer rows.Close()
  295. users := getUsersFromRows(rows)
  296. sort.Slice(users, func(i, j int) bool {
  297. return users[i].DisabledAt.Before(*users[j].DisabledAt)
  298. })
  299. return users
  300. }
  301. // GetModeratorUsers will return a list of users with moderator access.
  302. func GetModeratorUsers() []*User {
  303. query := `SELECT id, display_name, scopes, display_color, created_at, disabled_at, previous_names, namechanged_at FROM (
  304. WITH RECURSIVE split(id, display_name, scopes, display_color, created_at, disabled_at, previous_names, namechanged_at, scope, rest) AS (
  305. SELECT id, display_name, scopes, display_color, created_at, disabled_at, previous_names, namechanged_at, '', scopes || ',' FROM users
  306. UNION ALL
  307. SELECT id, display_name, scopes, display_color, created_at, disabled_at, previous_names, namechanged_at,
  308. substr(rest, 0, instr(rest, ',')),
  309. substr(rest, instr(rest, ',')+1)
  310. FROM split
  311. WHERE rest <> '')
  312. SELECT id, display_name, scopes, display_color, created_at, disabled_at, previous_names, namechanged_at, scope
  313. FROM split
  314. WHERE scope <> ''
  315. ORDER BY created_at
  316. ) AS token WHERE token.scope = ?`
  317. rows, err := _datastore.DB.Query(query, moderatorScopeKey)
  318. if err != nil {
  319. log.Errorln(err)
  320. return nil
  321. }
  322. defer rows.Close()
  323. users := getUsersFromRows(rows)
  324. return users
  325. }
  326. func getUsersFromRows(rows *sql.Rows) []*User {
  327. users := make([]*User, 0)
  328. for rows.Next() {
  329. var id string
  330. var displayName string
  331. var displayColor int
  332. var createdAt time.Time
  333. var disabledAt *time.Time
  334. var previousUsernames string
  335. var userNameChangedAt *time.Time
  336. var scopesString *string
  337. if err := rows.Scan(&id, &displayName, &scopesString, &displayColor, &createdAt, &disabledAt, &previousUsernames, &userNameChangedAt); err != nil {
  338. log.Errorln("error creating collection of users from results", err)
  339. return nil
  340. }
  341. var scopes []string
  342. if scopesString != nil {
  343. scopes = strings.Split(*scopesString, ",")
  344. }
  345. user := &User{
  346. ID: id,
  347. DisplayName: displayName,
  348. DisplayColor: displayColor,
  349. CreatedAt: createdAt,
  350. DisabledAt: disabledAt,
  351. PreviousNames: strings.Split(previousUsernames, ","),
  352. NameChangedAt: userNameChangedAt,
  353. Scopes: scopes,
  354. }
  355. users = append(users, user)
  356. }
  357. sort.Slice(users, func(i, j int) bool {
  358. return users[i].CreatedAt.Before(users[j].CreatedAt)
  359. })
  360. return users
  361. }
  362. func getUserFromRow(row *sql.Row) *User {
  363. var id string
  364. var displayName string
  365. var displayColor int
  366. var createdAt time.Time
  367. var disabledAt *time.Time
  368. var previousUsernames string
  369. var userNameChangedAt *time.Time
  370. var scopesString *string
  371. if err := row.Scan(&id, &displayName, &displayColor, &createdAt, &disabledAt, &previousUsernames, &userNameChangedAt, &scopesString); err != nil {
  372. return nil
  373. }
  374. var scopes []string
  375. if scopesString != nil {
  376. scopes = strings.Split(*scopesString, ",")
  377. }
  378. return &User{
  379. ID: id,
  380. DisplayName: displayName,
  381. DisplayColor: displayColor,
  382. CreatedAt: createdAt,
  383. DisabledAt: disabledAt,
  384. PreviousNames: strings.Split(previousUsernames, ","),
  385. NameChangedAt: userNameChangedAt,
  386. Scopes: scopes,
  387. }
  388. }