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