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