server/controllers/api/users.ts

   1 import * as express from 'express'
   2 import 'multer'
   3 import { extname, join } from 'path'
   4 import * as uuidv4 from 'uuid/v4'
   5 import * as RateLimit from 'express-rate-limit'
   6 import { UserCreate, UserRight, UserRole, UserUpdate, UserUpdateMe, UserVideoRate as FormattedUserVideoRate } from '../../../shared'
   7 import { retryTransactionWrapper } from '../../helpers/database-utils'
   8 import { processImage } from '../../helpers/image-utils'
   9 import { logger } from '../../helpers/logger'
  10 import { createReqFiles, getFormattedObjects } from '../../helpers/utils'
  11 import { AVATARS_SIZE, CONFIG, IMAGE_MIMETYPE_EXT, RATES_LIMIT, sequelizeTypescript } from '../../initializers'
  12 import { updateActorAvatarInstance } from '../../lib/activitypub'
  13 import { sendUpdateActor } from '../../lib/activitypub/send'
  14 import { Emailer } from '../../lib/emailer'
  15 import { Redis } from '../../lib/redis'
  16 import { createUserAccountAndChannel } from '../../lib/user'
  17 import {
  18   asyncMiddleware,
  19   authenticate,
  20   ensureUserHasRight,
  21   ensureUserRegistrationAllowed,
  22   paginationValidator,
  23   setDefaultPagination,
  24   setDefaultSort,
  25   token,
  26   usersAddValidator,
  27   usersGetValidator,
  28   usersRegisterValidator,
  29   usersRemoveValidator,
  30   usersSortValidator,
  31   usersUpdateMeValidator,
  32   usersUpdateValidator,
  33   usersVideoRatingValidator
  34 } from '../../middlewares'
  35 import {
  36   usersAskResetPasswordValidator,
  37   usersResetPasswordValidator,
  38   usersUpdateMyAvatarValidator,
  39   videosSortValidator
  40 } from '../../middlewares/validators'
  41 import { AccountVideoRateModel } from '../../models/account/account-video-rate'
  42 import { UserModel } from '../../models/account/user'
  43 import { OAuthTokenModel } from '../../models/oauth/oauth-token'
  44 import { VideoModel } from '../../models/video/video'
  45
  46 const reqAvatarFile = createReqFiles([ 'avatarfile' ], IMAGE_MIMETYPE_EXT, { avatarfile: CONFIG.STORAGE.AVATARS_DIR })
  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 usersRouter = express.Router()
  54
  55 usersRouter.get('/me',
  56   authenticate,
  57   asyncMiddleware(getUserInformation)
  58 )
  59
  60 usersRouter.get('/me/video-quota-used',
  61   authenticate,
  62   asyncMiddleware(getUserVideoQuotaUsed)
  63 )
  64
  65 usersRouter.get('/me/videos',
  66   authenticate,
  67   paginationValidator,
  68   videosSortValidator,
  69   setDefaultSort,
  70   setDefaultPagination,
  71   asyncMiddleware(getUserVideos)
  72 )
  73
  74 usersRouter.get('/me/videos/:videoId/rating',
  75   authenticate,
  76   asyncMiddleware(usersVideoRatingValidator),
  77   asyncMiddleware(getUserVideoRating)
  78 )
  79
  80 usersRouter.get('/',
  81   authenticate,
  82   ensureUserHasRight(UserRight.MANAGE_USERS),
  83   paginationValidator,
  84   usersSortValidator,
  85   setDefaultSort,
  86   setDefaultPagination,
  87   asyncMiddleware(listUsers)
  88 )
  89
  90 usersRouter.get('/:id',
  91   authenticate,
  92   ensureUserHasRight(UserRight.MANAGE_USERS),
  93   asyncMiddleware(usersGetValidator),
  94   getUser
  95 )
  96
  97 usersRouter.post('/',
  98   authenticate,
  99   ensureUserHasRight(UserRight.MANAGE_USERS),
 100   asyncMiddleware(usersAddValidator),
 101   asyncMiddleware(createUserRetryWrapper)
 102 )
 103
 104 usersRouter.post('/register',
 105   asyncMiddleware(ensureUserRegistrationAllowed),
 106   asyncMiddleware(usersRegisterValidator),
 107   asyncMiddleware(registerUserRetryWrapper)
 108 )
 109
 110 usersRouter.put('/me',
 111   authenticate,
 112   usersUpdateMeValidator,
 113   asyncMiddleware(updateMe)
 114 )
 115
 116 usersRouter.post('/me/avatar/pick',
 117   authenticate,
 118   reqAvatarFile,
 119   usersUpdateMyAvatarValidator,
 120   asyncMiddleware(updateMyAvatar)
 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('/token',
 148   loginRateLimiter,
 149   token,
 150   success
 151 )
 152 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
 153
 154 // ---------------------------------------------------------------------------
 155
 156 export {
 157   usersRouter
 158 }
 159
 160 // ---------------------------------------------------------------------------
 161
 162 async function getUserVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
 163   const user = res.locals.oauth.token.User as UserModel
 164   const resultList = await VideoModel.listUserVideosForApi(user.id ,req.query.start, req.query.count, req.query.sort)
 165
 166   return res.json(getFormattedObjects(resultList.data, resultList.total))
 167 }
 168
 169 async function createUserRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
 170   const options = {
 171     arguments: [ req ],
 172     errorMessage: 'Cannot insert the user with many retries.'
 173   }
 174
 175   const { user, account } = await retryTransactionWrapper(createUser, options)
 176
 177   return res.json({
 178     user: {
 179       id: user.id,
 180       uuid: account.uuid
 181     }
 182   }).end()
 183 }
 184
 185 async function createUser (req: express.Request) {
 186   const body: UserCreate = req.body
 187   const userToCreate = new UserModel({
 188     username: body.username,
 189     password: body.password,
 190     email: body.email,
 191     displayNSFW: false,
 192     autoPlayVideo: true,
 193     role: body.role,
 194     videoQuota: body.videoQuota
 195   })
 196
 197   const { user, account } = await createUserAccountAndChannel(userToCreate)
 198
 199   logger.info('User %s with its channel and account created.', body.username)
 200
 201   return { user, account }
 202 }
 203
 204 async function registerUserRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
 205   const options = {
 206     arguments: [ req ],
 207     errorMessage: 'Cannot insert the user with many retries.'
 208   }
 209
 210   await retryTransactionWrapper(registerUser, options)
 211
 212   return res.type('json').status(204).end()
 213 }
 214
 215 async function registerUser (req: express.Request) {
 216   const body: UserCreate = req.body
 217
 218   const user = new UserModel({
 219     username: body.username,
 220     password: body.password,
 221     email: body.email,
 222     displayNSFW: false,
 223     autoPlayVideo: true,
 224     role: UserRole.USER,
 225     videoQuota: CONFIG.USER.VIDEO_QUOTA
 226   })
 227
 228   await createUserAccountAndChannel(user)
 229
 230   logger.info('User %s with its channel and account registered.', body.username)
 231 }
 232
 233 async function getUserInformation (req: express.Request, res: express.Response, next: express.NextFunction) {
 234   // We did not load channels in res.locals.user
 235   const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
 236
 237   return res.json(user.toFormattedJSON())
 238 }
 239
 240 async function getUserVideoQuotaUsed (req: express.Request, res: express.Response, next: express.NextFunction) {
 241   // We did not load channels in res.locals.user
 242   const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
 243   const videoQuotaUsed = await UserModel.getOriginalVideoFileTotalFromUser(user)
 244
 245   return res.json({
 246     videoQuotaUsed
 247   })
 248 }
 249
 250 function getUser (req: express.Request, res: express.Response, next: express.NextFunction) {
 251   return res.json((res.locals.user as UserModel).toFormattedJSON())
 252 }
 253
 254 async function getUserVideoRating (req: express.Request, res: express.Response, next: express.NextFunction) {
 255   const videoId = +req.params.videoId
 256   const accountId = +res.locals.oauth.token.User.Account.id
 257
 258   const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
 259   const rating = ratingObj ? ratingObj.type : 'none'
 260
 261   const json: FormattedUserVideoRate = {
 262     videoId,
 263     rating
 264   }
 265   res.json(json)
 266 }
 267
 268 async function listUsers (req: express.Request, res: express.Response, next: express.NextFunction) {
 269   const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort)
 270
 271   return res.json(getFormattedObjects(resultList.data, resultList.total))
 272 }
 273
 274 async function removeUser (req: express.Request, res: express.Response, next: express.NextFunction) {
 275   const user = await UserModel.loadById(req.params.id)
 276
 277   await user.destroy()
 278
 279   return res.sendStatus(204)
 280 }
 281
 282 async function updateMe (req: express.Request, res: express.Response, next: express.NextFunction) {
 283   const body: UserUpdateMe = req.body
 284
 285   const user: UserModel = res.locals.oauth.token.user
 286
 287   if (body.password !== undefined) user.password = body.password
 288   if (body.email !== undefined) user.email = body.email
 289   if (body.displayNSFW !== undefined) user.displayNSFW = body.displayNSFW
 290   if (body.autoPlayVideo !== undefined) user.autoPlayVideo = body.autoPlayVideo
 291
 292   await sequelizeTypescript.transaction(async t => {
 293     await user.save({ transaction: t })
 294
 295     if (body.description !== undefined) user.Account.description = body.description
 296     await user.Account.save({ transaction: t })
 297
 298     await sendUpdateActor(user.Account, t)
 299   })
 300
 301   return res.sendStatus(204)
 302 }
 303
 304 async function updateMyAvatar (req: express.Request, res: express.Response, next: express.NextFunction) {
 305   const avatarPhysicalFile = req.files['avatarfile'][0]
 306   const user = res.locals.oauth.token.user
 307   const actor = user.Account.Actor
 308
 309   const extension = extname(avatarPhysicalFile.filename)
 310   const avatarName = uuidv4() + extension
 311   const destination = join(CONFIG.STORAGE.AVATARS_DIR, avatarName)
 312   await processImage(avatarPhysicalFile, destination, AVATARS_SIZE)
 313
 314   const avatar = await sequelizeTypescript.transaction(async t => {
 315     const updatedActor = await updateActorAvatarInstance(actor, avatarName, t)
 316     await updatedActor.save({ transaction: t })
 317
 318     await sendUpdateActor(user.Account, t)
 319
 320     return updatedActor.Avatar
 321   })
 322
 323   return res
 324     .json({
 325       avatar: avatar.toFormattedJSON()
 326     })
 327     .end()
 328 }
 329
 330 async function updateUser (req: express.Request, res: express.Response, next: express.NextFunction) {
 331   const body: UserUpdate = req.body
 332   const user = res.locals.user as UserModel
 333   const roleChanged = body.role !== undefined && body.role !== user.role
 334
 335   if (body.email !== undefined) user.email = body.email
 336   if (body.videoQuota !== undefined) user.videoQuota = body.videoQuota
 337   if (body.role !== undefined) user.role = body.role
 338
 339   await user.save()
 340
 341   // Destroy user token to refresh rights
 342   if (roleChanged) {
 343     await OAuthTokenModel.deleteUserToken(user.id)
 344   }
 345
 346   // Don't need to send this update to followers, these attributes are not propagated
 347
 348   return res.sendStatus(204)
 349 }
 350
 351 async function askResetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
 352   const user = res.locals.user as UserModel
 353
 354   const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
 355   const url = CONFIG.WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
 356   await Emailer.Instance.addForgetPasswordEmailJob(user.email, url)
 357
 358   return res.status(204).end()
 359 }
 360
 361 async function resetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
 362   const user = res.locals.user as UserModel
 363   user.password = req.body.password
 364
 365   await user.save()
 366
 367   return res.status(204).end()
 368 }
 369
 370 function success (req: express.Request, res: express.Response, next: express.NextFunction) {
 371   res.end()
 372 }