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