user.go 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532
  1. package service
  2. import (
  3. "errors"
  4. "math/rand"
  5. "strconv"
  6. "strings"
  7. "time"
  8. "github.com/gin-gonic/gin"
  9. "github.com/lejianwen/rustdesk-api/v2/model"
  10. "github.com/lejianwen/rustdesk-api/v2/utils"
  11. "gorm.io/gorm"
  12. )
  13. type UserService struct {
  14. }
  15. // InfoById 根据用户id取用户信息
  16. func (us *UserService) InfoById(id uint) *model.User {
  17. u := &model.User{}
  18. DB.Where("id = ?", id).First(u)
  19. return u
  20. }
  21. // InfoByUsername 根据用户名取用户信息
  22. func (us *UserService) InfoByUsername(un string) *model.User {
  23. u := &model.User{}
  24. DB.Where("username = ?", un).First(u)
  25. return u
  26. }
  27. // InfoByEmail 根据邮箱取用户信息
  28. func (us *UserService) InfoByEmail(email string) *model.User {
  29. u := &model.User{}
  30. DB.Where("email = ?", email).First(u)
  31. return u
  32. }
  33. // InfoByOpenid 根据openid取用户信息
  34. func (us *UserService) InfoByOpenid(openid string) *model.User {
  35. u := &model.User{}
  36. DB.Where("openid = ?", openid).First(u)
  37. return u
  38. }
  39. // InfoByUsernamePassword 根据用户名密码取用户信息
  40. func (us *UserService) InfoByUsernamePassword(username, password string) *model.User {
  41. if Config.Ldap.Enable {
  42. u, err := AllService.LdapService.Authenticate(username, password)
  43. if err == nil {
  44. return u
  45. }
  46. Logger.Errorf("LDAP authentication failed, %v", err)
  47. Logger.Warn("Fallback to local database")
  48. }
  49. u := &model.User{}
  50. DB.Where("username = ?", username).First(u)
  51. if u.Id == 0 {
  52. return u
  53. }
  54. ok, newHash, err := utils.VerifyPassword(u.Password, password)
  55. if err != nil || !ok {
  56. return &model.User{}
  57. }
  58. if newHash != "" {
  59. DB.Model(u).Update("password", newHash)
  60. u.Password = newHash
  61. }
  62. return u
  63. }
  64. // InfoByAccesstoken 根据accesstoken取用户信息
  65. func (us *UserService) InfoByAccessToken(token string) (*model.User, *model.UserToken) {
  66. u := &model.User{}
  67. ut := &model.UserToken{}
  68. DB.Where("token = ?", token).First(ut)
  69. if ut.Id == 0 {
  70. return u, ut
  71. }
  72. if ut.ExpiredAt < time.Now().Unix() {
  73. return u, ut
  74. }
  75. DB.Where("id = ?", ut.UserId).First(u)
  76. return u, ut
  77. }
  78. // GenerateToken 生成token
  79. func (us *UserService) GenerateToken(u *model.User) string {
  80. if len(Jwt.Key) > 0 {
  81. return Jwt.GenerateToken(u.Id)
  82. }
  83. return utils.Md5(u.Username + time.Now().String())
  84. }
  85. // Login 登录
  86. func (us *UserService) Login(u *model.User, llog *model.LoginLog) *model.UserToken {
  87. token := us.GenerateToken(u)
  88. ut := &model.UserToken{
  89. UserId: u.Id,
  90. Token: token,
  91. DeviceUuid: llog.Uuid,
  92. DeviceId: llog.DeviceId,
  93. ExpiredAt: us.UserTokenExpireTimestamp(),
  94. }
  95. DB.Create(ut)
  96. llog.UserTokenId = ut.UserId
  97. DB.Create(llog)
  98. if llog.Uuid != "" {
  99. AllService.PeerService.UuidBindUserId(llog.DeviceId, llog.Uuid, u.Id)
  100. }
  101. return ut
  102. }
  103. // CurUser 获取当前用户
  104. func (us *UserService) CurUser(c *gin.Context) *model.User {
  105. user, _ := c.Get("curUser")
  106. u, ok := user.(*model.User)
  107. if !ok {
  108. return nil
  109. }
  110. return u
  111. }
  112. func (us *UserService) List(page, pageSize uint, where func(tx *gorm.DB)) (res *model.UserList) {
  113. res = &model.UserList{}
  114. res.Page = int64(page)
  115. res.PageSize = int64(pageSize)
  116. tx := DB.Model(&model.User{})
  117. if where != nil {
  118. where(tx)
  119. }
  120. tx.Count(&res.Total)
  121. tx.Scopes(Paginate(page, pageSize))
  122. tx.Find(&res.Users)
  123. return
  124. }
  125. func (us *UserService) ListByIds(ids []uint) (res []*model.User) {
  126. DB.Where("id in ?", ids).Find(&res)
  127. return res
  128. }
  129. // ListByGroupId 根据组id取用户列表
  130. func (us *UserService) ListByGroupId(groupId, page, pageSize uint) (res *model.UserList) {
  131. res = us.List(page, pageSize, func(tx *gorm.DB) {
  132. tx.Where("group_id = ?", groupId)
  133. })
  134. return
  135. }
  136. // ListIdsByGroupId 根据组id取用户id列表
  137. func (us *UserService) ListIdsByGroupId(groupId uint) (ids []uint) {
  138. DB.Model(&model.User{}).Where("group_id = ?", groupId).Pluck("id", &ids)
  139. return ids
  140. }
  141. // ListIdAndNameByGroupId 根据组id取用户id和用户名列表
  142. func (us *UserService) ListIdAndNameByGroupId(groupId uint) (res []*model.User) {
  143. DB.Model(&model.User{}).Where("group_id = ?", groupId).Select("id, username").Find(&res)
  144. return res
  145. }
  146. // CheckUserEnable 判断用户是否禁用
  147. func (us *UserService) CheckUserEnable(u *model.User) bool {
  148. return u.Status == model.COMMON_STATUS_ENABLE
  149. }
  150. // Create 创建
  151. func (us *UserService) Create(u *model.User) error {
  152. // The initial username should be formatted, and the username should be unique
  153. if us.IsUsernameExists(u.Username) {
  154. return errors.New("UsernameExists")
  155. }
  156. u.Username = us.formatUsername(u.Username)
  157. var err error
  158. u.Password, err = utils.EncryptPassword(u.Password)
  159. if err != nil {
  160. return err
  161. }
  162. res := DB.Create(u).Error
  163. return res
  164. }
  165. // GetUuidByToken 根据token和user取uuid
  166. func (us *UserService) GetUuidByToken(u *model.User, token string) string {
  167. ut := &model.UserToken{}
  168. err := DB.Where("user_id = ? and token = ?", u.Id, token).First(ut).Error
  169. if err != nil {
  170. return ""
  171. }
  172. return ut.DeviceUuid
  173. }
  174. // Logout 退出登录 -> 删除token, 解绑uuid
  175. func (us *UserService) Logout(u *model.User, token string) error {
  176. uuid := us.GetUuidByToken(u, token)
  177. err := DB.Where("user_id = ? and token = ?", u.Id, token).Delete(&model.UserToken{}).Error
  178. if err != nil {
  179. return err
  180. }
  181. if uuid != "" {
  182. AllService.PeerService.UuidUnbindUserId(uuid, u.Id)
  183. }
  184. return nil
  185. }
  186. // Delete 删除用户和oauth信息
  187. func (us *UserService) Delete(u *model.User) error {
  188. userCount := us.getAdminUserCount()
  189. if userCount <= 1 && us.IsAdmin(u) {
  190. return errors.New("The last admin user cannot be deleted")
  191. }
  192. tx := DB.Begin()
  193. // 删除用户
  194. if err := tx.Delete(u).Error; err != nil {
  195. tx.Rollback()
  196. return err
  197. }
  198. // 删除关联的 OAuth 信息
  199. if err := tx.Where("user_id = ?", u.Id).Delete(&model.UserThird{}).Error; err != nil {
  200. tx.Rollback()
  201. return err
  202. }
  203. // 删除关联的ab
  204. if err := tx.Where("user_id = ?", u.Id).Delete(&model.AddressBook{}).Error; err != nil {
  205. tx.Rollback()
  206. return err
  207. }
  208. // 删除关联的abc
  209. if err := tx.Where("user_id = ?", u.Id).Delete(&model.AddressBookCollection{}).Error; err != nil {
  210. tx.Rollback()
  211. return err
  212. }
  213. // 删除关联的abcr
  214. if err := tx.Where("user_id = ?", u.Id).Delete(&model.AddressBookCollectionRule{}).Error; err != nil {
  215. tx.Rollback()
  216. return err
  217. }
  218. tx.Commit()
  219. // 删除关联的peer
  220. if err := AllService.PeerService.EraseUserId(u.Id); err != nil {
  221. Logger.Warn("User deleted successfully, but failed to unlink peer.")
  222. return nil
  223. }
  224. return nil
  225. }
  226. // Update 更新
  227. func (us *UserService) Update(u *model.User) error {
  228. currentUser := us.InfoById(u.Id)
  229. // 如果当前用户是管理员并且 IsAdmin 不为空,进行检查
  230. if us.IsAdmin(currentUser) {
  231. adminCount := us.getAdminUserCount()
  232. // 如果这是唯一的管理员,确保不能禁用或取消管理员权限
  233. if adminCount <= 1 && (!us.IsAdmin(u) || u.Status == model.COMMON_STATUS_DISABLED) {
  234. return errors.New("The last admin user cannot be disabled or demoted")
  235. }
  236. }
  237. return DB.Model(u).Updates(u).Error
  238. }
  239. // FlushToken 清空token
  240. func (us *UserService) FlushToken(u *model.User) error {
  241. return DB.Where("user_id = ?", u.Id).Delete(&model.UserToken{}).Error
  242. }
  243. // FlushTokenByUuid 清空token
  244. func (us *UserService) FlushTokenByUuid(uuid string) error {
  245. return DB.Where("device_uuid = ?", uuid).Delete(&model.UserToken{}).Error
  246. }
  247. // FlushTokenByUuids 清空token
  248. func (us *UserService) FlushTokenByUuids(uuids []string) error {
  249. return DB.Where("device_uuid in (?)", uuids).Delete(&model.UserToken{}).Error
  250. }
  251. // UpdatePassword 更新密码
  252. func (us *UserService) UpdatePassword(u *model.User, password string) error {
  253. var err error
  254. u.Password, err = utils.EncryptPassword(password)
  255. if err != nil {
  256. return err
  257. }
  258. err = DB.Model(u).Update("password", u.Password).Error
  259. if err != nil {
  260. return err
  261. }
  262. err = us.FlushToken(u)
  263. return err
  264. }
  265. // IsAdmin 是否管理员
  266. func (us *UserService) IsAdmin(u *model.User) bool {
  267. return u != nil && *u.IsAdmin
  268. }
  269. // RouteNames
  270. func (us *UserService) RouteNames(u *model.User) []string {
  271. if us.IsAdmin(u) {
  272. return model.AdminRouteNames
  273. }
  274. return model.UserRouteNames
  275. }
  276. // InfoByOauthId 根据oauth的name和openId取用户信息
  277. func (us *UserService) InfoByOauthId(op string, openId string) *model.User {
  278. ut := AllService.OauthService.UserThirdInfo(op, openId)
  279. if ut.Id == 0 {
  280. return nil
  281. }
  282. u := us.InfoById(ut.UserId)
  283. if u.Id == 0 {
  284. return nil
  285. }
  286. return u
  287. }
  288. // RegisterByOauth 注册
  289. func (us *UserService) RegisterByOauth(oauthUser *model.OauthUser, op string) (error, *model.User) {
  290. Lock.Lock("registerByOauth")
  291. defer Lock.UnLock("registerByOauth")
  292. ut := AllService.OauthService.UserThirdInfo(op, oauthUser.OpenId)
  293. if ut.Id != 0 {
  294. return nil, us.InfoById(ut.UserId)
  295. }
  296. err, oauthType := AllService.OauthService.GetTypeByOp(op)
  297. if err != nil {
  298. return err, nil
  299. }
  300. //check if this email has been registered
  301. email := oauthUser.Email
  302. // only email is not empty
  303. if email != "" {
  304. email = strings.ToLower(email)
  305. // update email to oauthUser, in case it contain upper case
  306. oauthUser.Email = email
  307. // call this, if find user by email, it will update the email to local database
  308. user, ldapErr := AllService.LdapService.GetUserInfoByEmailLocal(email)
  309. // If we enable ldap, and the error is not ErrLdapUserNotFound, return the error because we could not sure if the user is not found in ldap
  310. if !(errors.Is(ldapErr, ErrLdapNotEnabled) || errors.Is(ldapErr, ErrLdapUserNotFound) || ldapErr == nil) {
  311. return ldapErr, user
  312. }
  313. if user.Id == 0 {
  314. // this means the user is not found in ldap, maybe ldao is not enabled
  315. user = us.InfoByEmail(email)
  316. }
  317. if user.Id != 0 {
  318. ut.FromOauthUser(user.Id, oauthUser, oauthType, op)
  319. DB.Create(ut)
  320. return nil, user
  321. }
  322. }
  323. tx := DB.Begin()
  324. ut = &model.UserThird{}
  325. ut.FromOauthUser(0, oauthUser, oauthType, op)
  326. // The initial username should be formatted
  327. username := us.formatUsername(oauthUser.Username)
  328. usernameUnique := us.GenerateUsernameByOauth(username)
  329. user := &model.User{
  330. Username: usernameUnique,
  331. GroupId: 1,
  332. }
  333. oauthUser.ToUser(user, false)
  334. tx.Create(user)
  335. if user.Id == 0 {
  336. tx.Rollback()
  337. return errors.New("OauthRegisterFailed"), user
  338. }
  339. ut.UserId = user.Id
  340. tx.Create(ut)
  341. tx.Commit()
  342. return nil, user
  343. }
  344. // GenerateUsernameByOauth 生成用户名
  345. func (us *UserService) GenerateUsernameByOauth(name string) string {
  346. for us.IsUsernameExists(name) {
  347. name += strconv.Itoa(rand.Intn(10)) // Append a random digit (0-9)
  348. }
  349. return name
  350. }
  351. // UserThirdsByUserId
  352. func (us *UserService) UserThirdsByUserId(userId uint) (res []*model.UserThird) {
  353. DB.Where("user_id = ?", userId).Find(&res)
  354. return res
  355. }
  356. func (us *UserService) UserThirdInfo(userId uint, op string) *model.UserThird {
  357. ut := &model.UserThird{}
  358. DB.Where("user_id = ? and op = ?", userId, op).First(ut)
  359. return ut
  360. }
  361. // FindLatestUserIdFromLoginLogByUuid 根据uuid和设备id查找最后登录的用户id
  362. func (us *UserService) FindLatestUserIdFromLoginLogByUuid(uuid string, deviceId string) uint {
  363. llog := &model.LoginLog{}
  364. DB.Where("uuid = ? and device_id = ?", uuid, deviceId).Order("id desc").First(llog)
  365. return llog.UserId
  366. }
  367. // IsPasswordEmptyById 根据用户id判断密码是否为空,主要用于第三方登录的自动注册
  368. func (us *UserService) IsPasswordEmptyById(id uint) bool {
  369. u := &model.User{}
  370. if DB.Where("id = ?", id).First(u).Error != nil {
  371. return false
  372. }
  373. return u.Password == ""
  374. }
  375. // IsPasswordEmptyByUsername 根据用户id判断密码是否为空,主要用于第三方登录的自动注册
  376. func (us *UserService) IsPasswordEmptyByUsername(username string) bool {
  377. u := &model.User{}
  378. if DB.Where("username = ?", username).First(u).Error != nil {
  379. return false
  380. }
  381. return u.Password == ""
  382. }
  383. // IsPasswordEmptyByUser 判断密码是否为空,主要用于第三方登录的自动注册
  384. func (us *UserService) IsPasswordEmptyByUser(u *model.User) bool {
  385. return us.IsPasswordEmptyById(u.Id)
  386. }
  387. // Register 注册, 如果用户名已存在则返回nil
  388. func (us *UserService) Register(username string, email string, password string, status model.StatusCode) *model.User {
  389. u := &model.User{
  390. Username: username,
  391. Email: email,
  392. Password: password,
  393. GroupId: 1,
  394. Status: status,
  395. }
  396. err := us.Create(u)
  397. if err != nil {
  398. return nil
  399. }
  400. return u
  401. }
  402. func (us *UserService) TokenList(page uint, size uint, f func(tx *gorm.DB)) *model.UserTokenList {
  403. res := &model.UserTokenList{}
  404. res.Page = int64(page)
  405. res.PageSize = int64(size)
  406. tx := DB.Model(&model.UserToken{})
  407. if f != nil {
  408. f(tx)
  409. }
  410. tx.Count(&res.Total)
  411. tx.Scopes(Paginate(page, size))
  412. tx.Find(&res.UserTokens)
  413. return res
  414. }
  415. func (us *UserService) TokenInfoById(id uint) *model.UserToken {
  416. ut := &model.UserToken{}
  417. DB.Where("id = ?", id).First(ut)
  418. return ut
  419. }
  420. func (us *UserService) DeleteToken(l *model.UserToken) error {
  421. return DB.Delete(l).Error
  422. }
  423. // Helper functions, used for formatting username
  424. func (us *UserService) formatUsername(username string) string {
  425. username = strings.ReplaceAll(username, " ", "")
  426. username = strings.ToLower(username)
  427. return username
  428. }
  429. // Helper functions, getUserCount
  430. func (us *UserService) getUserCount() int64 {
  431. var count int64
  432. DB.Model(&model.User{}).Count(&count)
  433. return count
  434. }
  435. // helper functions, getAdminUserCount
  436. func (us *UserService) getAdminUserCount() int64 {
  437. var count int64
  438. DB.Model(&model.User{}).Where("is_admin = ?", true).Count(&count)
  439. return count
  440. }
  441. // UserTokenExpireTimestamp 生成用户token过期时间
  442. func (us *UserService) UserTokenExpireTimestamp() int64 {
  443. exp := Config.App.TokenExpire
  444. if exp == 0 {
  445. //默认七天
  446. exp = 604800
  447. }
  448. return time.Now().Add(exp).Unix()
  449. }
  450. func (us *UserService) RefreshAccessToken(ut *model.UserToken) {
  451. ut.ExpiredAt = us.UserTokenExpireTimestamp()
  452. DB.Model(ut).Update("expired_at", ut.ExpiredAt)
  453. }
  454. func (us *UserService) AutoRefreshAccessToken(ut *model.UserToken) {
  455. if ut.ExpiredAt-time.Now().Unix() < Config.App.TokenExpire.Milliseconds()/3000 {
  456. us.RefreshAccessToken(ut)
  457. }
  458. }
  459. func (us *UserService) BatchDeleteUserToken(ids []uint) error {
  460. return DB.Where("id in ?", ids).Delete(&model.UserToken{}).Error
  461. }
  462. func (us *UserService) VerifyJWT(token string) (uint, error) {
  463. return Jwt.ParseToken(token)
  464. }
  465. // IsUsernameExists 判断用户名是否存在, it will check the internal database and LDAP(if enabled)
  466. func (us *UserService) IsUsernameExists(username string) bool {
  467. return us.IsUsernameExistsLocal(username) || AllService.LdapService.IsUsernameExists(username)
  468. }
  469. func (us *UserService) IsUsernameExistsLocal(username string) bool {
  470. u := &model.User{}
  471. DB.Where("username = ?", username).First(u)
  472. return u.Id != 0
  473. }
  474. func (us *UserService) IsEmailExistsLdap(email string) bool {
  475. return AllService.LdapService.IsEmailExists(email)
  476. }