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