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 { getFormattedObjects } from '../../../helpers/utils'
   6 import { CONFIG, RATES_LIMIT, sequelizeTypescript } from '../../../initializers'
   7 import { Emailer } from '../../../lib/emailer'
   8 import { Redis } from '../../../lib/redis'
   9 import { createUserAccountAndChannel } 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 } from '../../../middlewares/validators'
  36 import { UserModel } from '../../../models/account/user'
  37 import { auditLoggerFactory, getAuditIdFromRes, UserAuditView } from '../../../helpers/audit-logger'
  38 import { meRouter } from './me'
  39 import { deleteUserToken } from '../../../lib/oauth-model'
  40 import { myBlocklistRouter } from './my-blocklist'
  41 import { myVideosHistoryRouter } from './my-history'
  42 import { myNotificationsRouter } from './my-notifications'
  43
  44 const auditLogger = auditLoggerFactory('users')
  45
  46 const loginRateLimiter = new RateLimit({
  47   windowMs: RATES_LIMIT.LOGIN.WINDOW_MS,
  48   max: RATES_LIMIT.LOGIN.MAX,
  49   delayMs: 0
  50 })
  51
  52 const askSendEmailLimiter = new RateLimit({
  53   windowMs: RATES_LIMIT.ASK_SEND_EMAIL.WINDOW_MS,
  54   max: RATES_LIMIT.ASK_SEND_EMAIL.MAX,
  55   delayMs: 0
  56 })
  57
  58 const usersRouter = express.Router()
  59 usersRouter.use('/', myNotificationsRouter)
  60 usersRouter.use('/', myBlocklistRouter)
  61 usersRouter.use('/', myVideosHistoryRouter)
  62 usersRouter.use('/', meRouter)
  63
  64 usersRouter.get('/autocomplete',
  65   userAutocompleteValidator,
  66   asyncMiddleware(autocompleteUsers)
  67 )
  68
  69 usersRouter.get('/',
  70   authenticate,
  71   ensureUserHasRight(UserRight.MANAGE_USERS),
  72   paginationValidator,
  73   usersSortValidator,
  74   setDefaultSort,
  75   setDefaultPagination,
  76   asyncMiddleware(listUsers)
  77 )
  78
  79 usersRouter.post('/:id/block',
  80   authenticate,
  81   ensureUserHasRight(UserRight.MANAGE_USERS),
  82   asyncMiddleware(usersBlockingValidator),
  83   asyncMiddleware(blockUser)
  84 )
  85 usersRouter.post('/:id/unblock',
  86   authenticate,
  87   ensureUserHasRight(UserRight.MANAGE_USERS),
  88   asyncMiddleware(usersBlockingValidator),
  89   asyncMiddleware(unblockUser)
  90 )
  91
  92 usersRouter.get('/:id',
  93   authenticate,
  94   ensureUserHasRight(UserRight.MANAGE_USERS),
  95   asyncMiddleware(usersGetValidator),
  96   getUser
  97 )
  98
  99 usersRouter.post('/',
 100   authenticate,
 101   ensureUserHasRight(UserRight.MANAGE_USERS),
 102   asyncMiddleware(usersAddValidator),
 103   asyncRetryTransactionMiddleware(createUser)
 104 )
 105
 106 usersRouter.post('/register',
 107   asyncMiddleware(ensureUserRegistrationAllowed),
 108   ensureUserRegistrationAllowedForIP,
 109   asyncMiddleware(usersRegisterValidator),
 110   asyncRetryTransactionMiddleware(registerUser)
 111 )
 112
 113 usersRouter.put('/:id',
 114   authenticate,
 115   ensureUserHasRight(UserRight.MANAGE_USERS),
 116   asyncMiddleware(usersUpdateValidator),
 117   asyncMiddleware(updateUser)
 118 )
 119
 120 usersRouter.delete('/:id',
 121   authenticate,
 122   ensureUserHasRight(UserRight.MANAGE_USERS),
 123   asyncMiddleware(usersRemoveValidator),
 124   asyncMiddleware(removeUser)
 125 )
 126
 127 usersRouter.post('/ask-reset-password',
 128   asyncMiddleware(usersAskResetPasswordValidator),
 129   asyncMiddleware(askResetUserPassword)
 130 )
 131
 132 usersRouter.post('/:id/reset-password',
 133   asyncMiddleware(usersResetPasswordValidator),
 134   asyncMiddleware(resetUserPassword)
 135 )
 136
 137 usersRouter.post('/ask-send-verify-email',
 138   askSendEmailLimiter,
 139   asyncMiddleware(usersAskSendVerifyEmailValidator),
 140   asyncMiddleware(askSendVerifyUserEmail)
 141 )
 142
 143 usersRouter.post('/:id/verify-email',
 144   asyncMiddleware(usersVerifyEmailValidator),
 145   asyncMiddleware(verifyUserEmail)
 146 )
 147
 148 usersRouter.post('/token',
 149   loginRateLimiter,
 150   token,
 151   success
 152 )
 153 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
 154
 155 // ---------------------------------------------------------------------------
 156
 157 export {
 158   usersRouter
 159 }
 160
 161 // ---------------------------------------------------------------------------
 162
 163 async function createUser (req: express.Request, res: express.Response) {
 164   const body: UserCreate = req.body
 165   const userToCreate = new UserModel({
 166     username: body.username,
 167     password: body.password,
 168     email: body.email,
 169     nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
 170     autoPlayVideo: true,
 171     role: body.role,
 172     videoQuota: body.videoQuota,
 173     videoQuotaDaily: body.videoQuotaDaily
 174   })
 175
 176   const { user, account } = await createUserAccountAndChannel(userToCreate)
 177
 178   auditLogger.create(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
 179   logger.info('User %s with its channel and account created.', body.username)
 180
 181   return res.json({
 182     user: {
 183       id: user.id,
 184       account: {
 185         id: account.id,
 186         uuid: account.Actor.uuid
 187       }
 188     }
 189   }).end()
 190 }
 191
 192 async function registerUser (req: express.Request, res: express.Response) {
 193   const body: UserCreate = req.body
 194
 195   const userToCreate = new UserModel({
 196     username: body.username,
 197     password: body.password,
 198     email: body.email,
 199     nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
 200     autoPlayVideo: true,
 201     role: UserRole.USER,
 202     videoQuota: CONFIG.USER.VIDEO_QUOTA,
 203     videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY,
 204     emailVerified: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION ? false : null
 205   })
 206
 207   const { user } = await createUserAccountAndChannel(userToCreate)
 208
 209   auditLogger.create(body.username, new UserAuditView(user.toFormattedJSON()))
 210   logger.info('User %s with its channel and account registered.', body.username)
 211
 212   if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
 213     await sendVerifyUserEmail(user)
 214   }
 215
 216   return res.type('json').status(204).end()
 217 }
 218
 219 async function unblockUser (req: express.Request, res: express.Response, next: express.NextFunction) {
 220   const user: UserModel = res.locals.user
 221
 222   await changeUserBlock(res, user, false)
 223
 224   return res.status(204).end()
 225 }
 226
 227 async function blockUser (req: express.Request, res: express.Response, next: express.NextFunction) {
 228   const user: UserModel = res.locals.user
 229   const reason = req.body.reason
 230
 231   await changeUserBlock(res, user, true, reason)
 232
 233   return res.status(204).end()
 234 }
 235
 236 function getUser (req: express.Request, res: express.Response, next: express.NextFunction) {
 237   return res.json((res.locals.user as UserModel).toFormattedJSON())
 238 }
 239
 240 async function autocompleteUsers (req: express.Request, res: express.Response, next: express.NextFunction) {
 241   const resultList = await UserModel.autoComplete(req.query.search as string)
 242
 243   return res.json(resultList)
 244 }
 245
 246 async function listUsers (req: express.Request, res: express.Response, next: express.NextFunction) {
 247   const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort, req.query.search)
 248
 249   return res.json(getFormattedObjects(resultList.data, resultList.total))
 250 }
 251
 252 async function removeUser (req: express.Request, res: express.Response, next: express.NextFunction) {
 253   const user: UserModel = res.locals.user
 254
 255   await user.destroy()
 256
 257   auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
 258
 259   return res.sendStatus(204)
 260 }
 261
 262 async function updateUser (req: express.Request, res: express.Response, next: express.NextFunction) {
 263   const body: UserUpdate = req.body
 264   const userToUpdate = res.locals.user as UserModel
 265   const oldUserAuditView = new UserAuditView(userToUpdate.toFormattedJSON())
 266   const roleChanged = body.role !== undefined && body.role !== userToUpdate.role
 267
 268   if (body.email !== undefined) userToUpdate.email = body.email
 269   if (body.emailVerified !== undefined) userToUpdate.emailVerified = body.emailVerified
 270   if (body.videoQuota !== undefined) userToUpdate.videoQuota = body.videoQuota
 271   if (body.videoQuotaDaily !== undefined) userToUpdate.videoQuotaDaily = body.videoQuotaDaily
 272   if (body.role !== undefined) userToUpdate.role = body.role
 273
 274   const user = await userToUpdate.save()
 275
 276   // Destroy user token to refresh rights
 277   if (roleChanged) await deleteUserToken(userToUpdate.id)
 278
 279   auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)
 280
 281   // Don't need to send this update to followers, these attributes are not propagated
 282
 283   return res.sendStatus(204)
 284 }
 285
 286 async function askResetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
 287   const user = res.locals.user as UserModel
 288
 289   const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
 290   const url = CONFIG.WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
 291   await Emailer.Instance.addForgetPasswordEmailJob(user.email, url)
 292
 293   return res.status(204).end()
 294 }
 295
 296 async function resetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
 297   const user = res.locals.user as UserModel
 298   user.password = req.body.password
 299
 300   await user.save()
 301
 302   return res.status(204).end()
 303 }
 304
 305 async function sendVerifyUserEmail (user: UserModel) {
 306   const verificationString = await Redis.Instance.setVerifyEmailVerificationString(user.id)
 307   const url = CONFIG.WEBSERVER.URL + '/verify-account/email?userId=' + user.id + '&verificationString=' + verificationString
 308   await Emailer.Instance.addVerifyEmailJob(user.email, url)
 309   return
 310 }
 311
 312 async function askSendVerifyUserEmail (req: express.Request, res: express.Response, next: express.NextFunction) {
 313   const user = res.locals.user as UserModel
 314
 315   await sendVerifyUserEmail(user)
 316
 317   return res.status(204).end()
 318 }
 319
 320 async function verifyUserEmail (req: express.Request, res: express.Response, next: express.NextFunction) {
 321   const user = res.locals.user as UserModel
 322   user.emailVerified = true
 323
 324   await user.save()
 325
 326   return res.status(204).end()
 327 }
 328
 329 function success (req: express.Request, res: express.Response, next: express.NextFunction) {
 330   res.end()
 331 }
 332
 333 async function changeUserBlock (res: express.Response, user: UserModel, block: boolean, reason?: string) {
 334   const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
 335
 336   user.blocked = block
 337   user.blockedReason = reason || null
 338
 339   await sequelizeTypescript.transaction(async t => {
 340     await deleteUserToken(user.id, t)
 341
 342     await user.save({ transaction: t })
 343   })
 344
 345   await Emailer.Instance.addUserBlockJob(user, block, reason)
 346
 347   auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)
 348 }