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