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