server/controllers/api/users/index.ts

   1 import * as express from 'express'
   2 import * as RateLimit from 'express-rate-limit'
   3 import { UserCreate, UserRight, UserRole, UserUpdate } from '../../../../shared'
   4 import { logger } from '../../../helpers/logger'
   5 import { generateRandomString, getFormattedObjects } from '../../../helpers/utils'
   6 import { WEBSERVER } from '../../../initializers/constants'
   7 import { Emailer } from '../../../lib/emailer'
   8 import { Redis } from '../../../lib/redis'
   9 import { createUserAccountAndChannelAndPlaylist, sendVerifyUserEmail } from '../../../lib/user'
  10 import {
  11   asyncMiddleware,
  12   asyncRetryTransactionMiddleware,
  13   authenticate,
  14   ensureUserHasRight,
  15   ensureUserRegistrationAllowed,
  16   ensureUserRegistrationAllowedForIP,
  17   paginationValidator,
  18   setDefaultPagination,
  19   setDefaultSort,
  20   token,
  21   userAutocompleteValidator,
  22   usersAddValidator,
  23   usersGetValidator,
  24   usersRegisterValidator,
  25   usersRemoveValidator,
  26   usersSortValidator,
  27   usersUpdateValidator
  28 } from '../../../middlewares'
  29 import {
  30   usersAskResetPasswordValidator,
  31   usersAskSendVerifyEmailValidator,
  32   usersBlockingValidator,
  33   usersResetPasswordValidator,
  34   usersVerifyEmailValidator,
  35   ensureCanManageUser
  36 } from '../../../middlewares/validators'
  37 import { UserModel } from '../../../models/account/user'
  38 import { auditLoggerFactory, getAuditIdFromRes, UserAuditView } from '../../../helpers/audit-logger'
  39 import { meRouter } from './me'
  40 import { deleteUserToken } from '../../../lib/oauth-model'
  41 import { myBlocklistRouter } from './my-blocklist'
  42 import { myVideoPlaylistsRouter } from './my-video-playlists'
  43 import { myVideosHistoryRouter } from './my-history'
  44 import { myNotificationsRouter } from './my-notifications'
  45 import { Notifier } from '../../../lib/notifier'
  46 import { mySubscriptionsRouter } from './my-subscriptions'
  47 import { CONFIG } from '../../../initializers/config'
  48 import { sequelizeTypescript } from '../../../initializers/database'
  49 import { UserAdminFlag } from '../../../../shared/models/users/user-flag.model'
  50 import { UserRegister } from '../../../../shared/models/users/user-register.model'
  51 import { MUser, MUserAccountDefault } from '@server/typings/models'
  52 import { Hooks } from '@server/lib/plugins/hooks'
  53
  54 const auditLogger = auditLoggerFactory('users')
  55
  56 const loginRateLimiter = RateLimit({
  57   windowMs: CONFIG.RATES_LIMIT.LOGIN.WINDOW_MS,
  58   max: CONFIG.RATES_LIMIT.LOGIN.MAX
  59 })
  60
  61 // @ts-ignore
  62 const signupRateLimiter = RateLimit({
  63   windowMs: CONFIG.RATES_LIMIT.SIGNUP.WINDOW_MS,
  64   max: CONFIG.RATES_LIMIT.SIGNUP.MAX,
  65   skipFailedRequests: true
  66 })
  67
  68 // @ts-ignore
  69 const askSendEmailLimiter = new RateLimit({
  70   windowMs: CONFIG.RATES_LIMIT.ASK_SEND_EMAIL.WINDOW_MS,
  71   max: CONFIG.RATES_LIMIT.ASK_SEND_EMAIL.MAX
  72 })
  73
  74 const usersRouter = express.Router()
  75 usersRouter.use('/', myNotificationsRouter)
  76 usersRouter.use('/', mySubscriptionsRouter)
  77 usersRouter.use('/', myBlocklistRouter)
  78 usersRouter.use('/', myVideosHistoryRouter)
  79 usersRouter.use('/', myVideoPlaylistsRouter)
  80 usersRouter.use('/', meRouter)
  81
  82 usersRouter.get('/autocomplete',
  83   userAutocompleteValidator,
  84   asyncMiddleware(autocompleteUsers)
  85 )
  86
  87 usersRouter.get('/',
  88   authenticate,
  89   ensureUserHasRight(UserRight.MANAGE_USERS),
  90   paginationValidator,
  91   usersSortValidator,
  92   setDefaultSort,
  93   setDefaultPagination,
  94   asyncMiddleware(listUsers)
  95 )
  96
  97 usersRouter.post('/:id/block',
  98   authenticate,
  99   ensureUserHasRight(UserRight.MANAGE_USERS),
 100   asyncMiddleware(usersBlockingValidator),
 101   ensureCanManageUser,
 102   asyncMiddleware(blockUser)
 103 )
 104 usersRouter.post('/:id/unblock',
 105   authenticate,
 106   ensureUserHasRight(UserRight.MANAGE_USERS),
 107   asyncMiddleware(usersBlockingValidator),
 108   ensureCanManageUser,
 109   asyncMiddleware(unblockUser)
 110 )
 111
 112 usersRouter.get('/:id',
 113   authenticate,
 114   ensureUserHasRight(UserRight.MANAGE_USERS),
 115   asyncMiddleware(usersGetValidator),
 116   getUser
 117 )
 118
 119 usersRouter.post('/',
 120   authenticate,
 121   ensureUserHasRight(UserRight.MANAGE_USERS),
 122   asyncMiddleware(usersAddValidator),
 123   asyncRetryTransactionMiddleware(createUser)
 124 )
 125
 126 usersRouter.post('/register',
 127   signupRateLimiter,
 128   asyncMiddleware(ensureUserRegistrationAllowed),
 129   ensureUserRegistrationAllowedForIP,
 130   asyncMiddleware(usersRegisterValidator),
 131   asyncRetryTransactionMiddleware(registerUser)
 132 )
 133
 134 usersRouter.put('/:id',
 135   authenticate,
 136   ensureUserHasRight(UserRight.MANAGE_USERS),
 137   asyncMiddleware(usersUpdateValidator),
 138   ensureCanManageUser,
 139   asyncMiddleware(updateUser)
 140 )
 141
 142 usersRouter.delete('/:id',
 143   authenticate,
 144   ensureUserHasRight(UserRight.MANAGE_USERS),
 145   asyncMiddleware(usersRemoveValidator),
 146   ensureCanManageUser,
 147   asyncMiddleware(removeUser)
 148 )
 149
 150 usersRouter.post('/ask-reset-password',
 151   asyncMiddleware(usersAskResetPasswordValidator),
 152   asyncMiddleware(askResetUserPassword)
 153 )
 154
 155 usersRouter.post('/:id/reset-password',
 156   asyncMiddleware(usersResetPasswordValidator),
 157   asyncMiddleware(resetUserPassword)
 158 )
 159
 160 usersRouter.post('/ask-send-verify-email',
 161   askSendEmailLimiter,
 162   asyncMiddleware(usersAskSendVerifyEmailValidator),
 163   asyncMiddleware(reSendVerifyUserEmail)
 164 )
 165
 166 usersRouter.post('/:id/verify-email',
 167   asyncMiddleware(usersVerifyEmailValidator),
 168   asyncMiddleware(verifyUserEmail)
 169 )
 170
 171 usersRouter.post('/token',
 172   loginRateLimiter,
 173   token,
 174   tokenSuccess
 175 )
 176 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
 177
 178 // ---------------------------------------------------------------------------
 179
 180 export {
 181   usersRouter
 182 }
 183
 184 // ---------------------------------------------------------------------------
 185
 186 async function createUser (req: express.Request, res: express.Response) {
 187   const body: UserCreate = req.body
 188   const userToCreate = new UserModel({
 189     username: body.username,
 190     password: body.password,
 191     email: body.email,
 192     nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
 193     autoPlayVideo: true,
 194     role: body.role,
 195     videoQuota: body.videoQuota,
 196     videoQuotaDaily: body.videoQuotaDaily,
 197     adminFlags: body.adminFlags || UserAdminFlag.NONE
 198   }) as MUser
 199
 200   // NB: due to the validator usersAddValidator, password==='' can only be true if we can send the mail.
 201   const createPassword = userToCreate.password === ''
 202   if (createPassword) {
 203     userToCreate.password = await generateRandomString(20)
 204   }
 205
 206   const { user, account, videoChannel } = await createUserAccountAndChannelAndPlaylist({ userToCreate: userToCreate })
 207
 208   auditLogger.create(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
 209   logger.info('User %s with its channel and account created.', body.username)
 210
 211   if (createPassword) {
 212     // this will send an email for newly created users, so then can set their first password.
 213     logger.info('Sending to user %s a create password email', body.username)
 214     const verificationString = await Redis.Instance.setCreatePasswordVerificationString(user.id)
 215     const url = WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
 216     await Emailer.Instance.addPasswordCreateEmailJob(userToCreate.username, user.email, url)
 217   }
 218
 219   Hooks.runAction('action:api.user.created', { body, user, account, videoChannel })
 220
 221   return res.json({
 222     user: {
 223       id: user.id,
 224       account: {
 225         id: account.id
 226       }
 227     }
 228   }).end()
 229 }
 230
 231 async function registerUser (req: express.Request, res: express.Response) {
 232   const body: UserRegister = req.body
 233
 234   const userToCreate = new UserModel({
 235     username: body.username,
 236     password: body.password,
 237     email: body.email,
 238     nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
 239     autoPlayVideo: true,
 240     role: UserRole.USER,
 241     videoQuota: CONFIG.USER.VIDEO_QUOTA,
 242     videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY,
 243     emailVerified: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION ? false : null
 244   })
 245
 246   const { user, account, videoChannel } = await createUserAccountAndChannelAndPlaylist({
 247     userToCreate: userToCreate,
 248     userDisplayName: body.displayName || undefined,
 249     channelNames: body.channel
 250   })
 251
 252   auditLogger.create(body.username, new UserAuditView(user.toFormattedJSON()))
 253   logger.info('User %s with its channel and account registered.', body.username)
 254
 255   if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
 256     await sendVerifyUserEmail(user)
 257   }
 258
 259   Notifier.Instance.notifyOnNewUserRegistration(user)
 260
 261   Hooks.runAction('action:api.user.registered', { body, user, account, videoChannel })
 262
 263   return res.type('json').status(204).end()
 264 }
 265
 266 async function unblockUser (req: express.Request, res: express.Response) {
 267   const user = res.locals.user
 268
 269   await changeUserBlock(res, user, false)
 270
 271   Hooks.runAction('action:api.user.unblocked', { user })
 272
 273   return res.status(204).end()
 274 }
 275
 276 async function blockUser (req: express.Request, res: express.Response) {
 277   const user = res.locals.user
 278   const reason = req.body.reason
 279
 280   await changeUserBlock(res, user, true, reason)
 281
 282   Hooks.runAction('action:api.user.blocked', { user })
 283
 284   return res.status(204).end()
 285 }
 286
 287 function getUser (req: express.Request, res: express.Response) {
 288   return res.json(res.locals.user.toFormattedJSON({ withAdminFlags: true }))
 289 }
 290
 291 async function autocompleteUsers (req: express.Request, res: express.Response) {
 292   const resultList = await UserModel.autoComplete(req.query.search as string)
 293
 294   return res.json(resultList)
 295 }
 296
 297 async function listUsers (req: express.Request, res: express.Response) {
 298   const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort, req.query.search)
 299
 300   return res.json(getFormattedObjects(resultList.data, resultList.total, { withAdminFlags: true }))
 301 }
 302
 303 async function removeUser (req: express.Request, res: express.Response) {
 304   const user = res.locals.user
 305
 306   await user.destroy()
 307
 308   auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
 309
 310   Hooks.runAction('action:api.user.deleted', { user })
 311
 312   return res.sendStatus(204)
 313 }
 314
 315 async function updateUser (req: express.Request, res: express.Response) {
 316   const body: UserUpdate = req.body
 317   const userToUpdate = res.locals.user
 318   const oldUserAuditView = new UserAuditView(userToUpdate.toFormattedJSON())
 319   const roleChanged = body.role !== undefined && body.role !== userToUpdate.role
 320
 321   if (body.password !== undefined) userToUpdate.password = body.password
 322   if (body.email !== undefined) userToUpdate.email = body.email
 323   if (body.emailVerified !== undefined) userToUpdate.emailVerified = body.emailVerified
 324   if (body.videoQuota !== undefined) userToUpdate.videoQuota = body.videoQuota
 325   if (body.videoQuotaDaily !== undefined) userToUpdate.videoQuotaDaily = body.videoQuotaDaily
 326   if (body.role !== undefined) userToUpdate.role = body.role
 327   if (body.adminFlags !== undefined) userToUpdate.adminFlags = body.adminFlags
 328
 329   const user = await userToUpdate.save()
 330
 331   // Destroy user token to refresh rights
 332   if (roleChanged || body.password !== undefined) await deleteUserToken(userToUpdate.id)
 333
 334   auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)
 335
 336   Hooks.runAction('action:api.user.updated', { user })
 337
 338   // Don't need to send this update to followers, these attributes are not federated
 339
 340   return res.sendStatus(204)
 341 }
 342
 343 async function askResetUserPassword (req: express.Request, res: express.Response) {
 344   const user = res.locals.user
 345
 346   const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
 347   const url = WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
 348   await Emailer.Instance.addPasswordResetEmailJob(user.email, url)
 349
 350   return res.status(204).end()
 351 }
 352
 353 async function resetUserPassword (req: express.Request, res: express.Response) {
 354   const user = res.locals.user
 355   user.password = req.body.password
 356
 357   await user.save()
 358
 359   return res.status(204).end()
 360 }
 361
 362 async function reSendVerifyUserEmail (req: express.Request, res: express.Response) {
 363   const user = res.locals.user
 364
 365   await sendVerifyUserEmail(user)
 366
 367   return res.status(204).end()
 368 }
 369
 370 async function verifyUserEmail (req: express.Request, res: express.Response) {
 371   const user = res.locals.user
 372   user.emailVerified = true
 373
 374   if (req.body.isPendingEmail === true) {
 375     user.email = user.pendingEmail
 376     user.pendingEmail = null
 377   }
 378
 379   await user.save()
 380
 381   return res.status(204).end()
 382 }
 383
 384 function tokenSuccess (req: express.Request) {
 385   const username = req.body.username
 386
 387   Hooks.runAction('action:api.user.oauth2-got-token', { username, ip: req.ip })
 388 }
 389
 390 async function changeUserBlock (res: express.Response, user: MUserAccountDefault, block: boolean, reason?: string) {
 391   const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
 392
 393   user.blocked = block
 394   user.blockedReason = reason || null
 395
 396   await sequelizeTypescript.transaction(async t => {
 397     await deleteUserToken(user.id, t)
 398
 399     await user.save({ transaction: t })
 400   })
 401
 402   await Emailer.Instance.addUserBlockJob(user, block, reason)
 403
 404   auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)
 405 }