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