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