server/controllers/api/users.ts

   1 import * as express from 'express'
   2 import { extname, join } from 'path'
   3 import * as uuidv4 from 'uuid/v4'
   4 import { UserCreate, UserRight, UserRole, UserUpdate, UserUpdateMe, UserVideoRate as FormattedUserVideoRate } from '../../../shared'
   5 import { renamePromise } from '../../helpers/core-utils'
   6 import { retryTransactionWrapper } from '../../helpers/database-utils'
   7 import { logger } from '../../helpers/logger'
   8 import { createReqFiles, getFormattedObjects } from '../../helpers/utils'
   9 import { AVATAR_MIMETYPE_EXT, CONFIG, sequelizeTypescript } from '../../initializers'
  10 import { createUserAccountAndChannel } from '../../lib/user'
  11 import {
  12   asyncMiddleware, authenticate, ensureUserHasRight, ensureUserRegistrationAllowed, paginationValidator, setPagination, setUsersSort,
  13   setVideosSort, token, usersAddValidator, usersGetValidator, usersRegisterValidator, usersRemoveValidator, usersSortValidator,
  14   usersUpdateMeValidator, usersUpdateValidator, usersVideoRatingValidator
  15 } from '../../middlewares'
  16 import { usersUpdateMyAvatarValidator, videosSortValidator } from '../../middlewares/validators'
  17 import { AccountVideoRateModel } from '../../models/account/account-video-rate'
  18 import { UserModel } from '../../models/account/user'
  19 import { AvatarModel } from '../../models/avatar/avatar'
  20 import { VideoModel } from '../../models/video/video'
  21
  22 const reqAvatarFile = createReqFiles('avatarfile', CONFIG.STORAGE.AVATARS_DIR, AVATAR_MIMETYPE_EXT)
  23
  24 const usersRouter = express.Router()
  25
  26 usersRouter.get('/me',
  27   authenticate,
  28   asyncMiddleware(getUserInformation)
  29 )
  30
  31 usersRouter.get('/me/videos',
  32   authenticate,
  33   paginationValidator,
  34   videosSortValidator,
  35   setVideosSort,
  36   setPagination,
  37   asyncMiddleware(getUserVideos)
  38 )
  39
  40 usersRouter.get('/me/videos/:videoId/rating',
  41   authenticate,
  42   asyncMiddleware(usersVideoRatingValidator),
  43   asyncMiddleware(getUserVideoRating)
  44 )
  45
  46 usersRouter.get('/',
  47   authenticate,
  48   ensureUserHasRight(UserRight.MANAGE_USERS),
  49   paginationValidator,
  50   usersSortValidator,
  51   setUsersSort,
  52   setPagination,
  53   asyncMiddleware(listUsers)
  54 )
  55
  56 usersRouter.get('/:id',
  57   asyncMiddleware(usersGetValidator),
  58   getUser
  59 )
  60
  61 usersRouter.post('/',
  62   authenticate,
  63   ensureUserHasRight(UserRight.MANAGE_USERS),
  64   asyncMiddleware(usersAddValidator),
  65   asyncMiddleware(createUserRetryWrapper)
  66 )
  67
  68 usersRouter.post('/register',
  69   asyncMiddleware(ensureUserRegistrationAllowed),
  70   asyncMiddleware(usersRegisterValidator),
  71   asyncMiddleware(registerUserRetryWrapper)
  72 )
  73
  74 usersRouter.put('/me',
  75   authenticate,
  76   usersUpdateMeValidator,
  77   asyncMiddleware(updateMe)
  78 )
  79
  80 usersRouter.post('/me/avatar/pick',
  81   authenticate,
  82   reqAvatarFile,
  83   usersUpdateMyAvatarValidator,
  84   asyncMiddleware(updateMyAvatar)
  85 )
  86
  87 usersRouter.put('/:id',
  88   authenticate,
  89   ensureUserHasRight(UserRight.MANAGE_USERS),
  90   asyncMiddleware(usersUpdateValidator),
  91   asyncMiddleware(updateUser)
  92 )
  93
  94 usersRouter.delete('/:id',
  95   authenticate,
  96   ensureUserHasRight(UserRight.MANAGE_USERS),
  97   asyncMiddleware(usersRemoveValidator),
  98   asyncMiddleware(removeUser)
  99 )
 100
 101 usersRouter.post('/token', token, success)
 102 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
 103
 104 // ---------------------------------------------------------------------------
 105
 106 export {
 107   usersRouter
 108 }
 109
 110 // ---------------------------------------------------------------------------
 111
 112 async function getUserVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
 113   const user = res.locals.oauth.token.User as UserModel
 114   const resultList = await VideoModel.listUserVideosForApi(user.id ,req.query.start, req.query.count, req.query.sort)
 115
 116   return res.json(getFormattedObjects(resultList.data, resultList.total))
 117 }
 118
 119 async function createUserRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
 120   const options = {
 121     arguments: [ req ],
 122     errorMessage: 'Cannot insert the user with many retries.'
 123   }
 124
 125   await retryTransactionWrapper(createUser, options)
 126
 127   // TODO : include Location of the new user -> 201
 128   return res.type('json').status(204).end()
 129 }
 130
 131 async function createUser (req: express.Request) {
 132   const body: UserCreate = req.body
 133   const user = new UserModel({
 134     username: body.username,
 135     password: body.password,
 136     email: body.email,
 137     displayNSFW: false,
 138     autoPlayVideo: true,
 139     role: body.role,
 140     videoQuota: body.videoQuota
 141   })
 142
 143   await createUserAccountAndChannel(user)
 144
 145   logger.info('User %s with its channel and account created.', body.username)
 146 }
 147
 148 async function registerUserRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
 149   const options = {
 150     arguments: [ req ],
 151     errorMessage: 'Cannot insert the user with many retries.'
 152   }
 153
 154   await retryTransactionWrapper(registerUser, options)
 155
 156   return res.type('json').status(204).end()
 157 }
 158
 159 async function registerUser (req: express.Request) {
 160   const body: UserCreate = req.body
 161
 162   const user = new UserModel({
 163     username: body.username,
 164     password: body.password,
 165     email: body.email,
 166     displayNSFW: false,
 167     autoPlayVideo: true,
 168     role: UserRole.USER,
 169     videoQuota: CONFIG.USER.VIDEO_QUOTA
 170   })
 171
 172   await createUserAccountAndChannel(user)
 173
 174   logger.info('User %s with its channel and account registered.', body.username)
 175 }
 176
 177 async function getUserInformation (req: express.Request, res: express.Response, next: express.NextFunction) {
 178   // We did not load channels in res.locals.user
 179   const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
 180
 181   return res.json(user.toFormattedJSON())
 182 }
 183
 184 function getUser (req: express.Request, res: express.Response, next: express.NextFunction) {
 185   return res.json(res.locals.user.toFormattedJSON())
 186 }
 187
 188 async function getUserVideoRating (req: express.Request, res: express.Response, next: express.NextFunction) {
 189   const videoId = +req.params.videoId
 190   const accountId = +res.locals.oauth.token.User.Account.id
 191
 192   const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
 193   const rating = ratingObj ? ratingObj.type : 'none'
 194
 195   const json: FormattedUserVideoRate = {
 196     videoId,
 197     rating
 198   }
 199   res.json(json)
 200 }
 201
 202 async function listUsers (req: express.Request, res: express.Response, next: express.NextFunction) {
 203   const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort)
 204
 205   return res.json(getFormattedObjects(resultList.data, resultList.total))
 206 }
 207
 208 async function removeUser (req: express.Request, res: express.Response, next: express.NextFunction) {
 209   const user = await UserModel.loadById(req.params.id)
 210
 211   await user.destroy()
 212
 213   return res.sendStatus(204)
 214 }
 215
 216 async function updateMe (req: express.Request, res: express.Response, next: express.NextFunction) {
 217   const body: UserUpdateMe = req.body
 218
 219   // FIXME: user is not already a Sequelize instance?
 220   const user = res.locals.oauth.token.user
 221
 222   if (body.password !== undefined) user.password = body.password
 223   if (body.email !== undefined) user.email = body.email
 224   if (body.displayNSFW !== undefined) user.displayNSFW = body.displayNSFW
 225   if (body.autoPlayVideo !== undefined) user.autoPlayVideo = body.autoPlayVideo
 226
 227   await user.save()
 228
 229   return res.sendStatus(204)
 230 }
 231
 232 async function updateMyAvatar (req: express.Request, res: express.Response, next: express.NextFunction) {
 233   const avatarPhysicalFile = req.files['avatarfile'][0]
 234   const actor = res.locals.oauth.token.user.Account.Actor
 235
 236   const avatarDir = CONFIG.STORAGE.AVATARS_DIR
 237   const source = join(avatarDir, avatarPhysicalFile.filename)
 238   const extension = extname(avatarPhysicalFile.filename)
 239   const avatarName = uuidv4() + extension
 240   const destination = join(avatarDir, avatarName)
 241
 242   await renamePromise(source, destination)
 243
 244   const { avatar } = await sequelizeTypescript.transaction(async t => {
 245     const avatar = await AvatarModel.create({
 246       filename: avatarName
 247     }, { transaction: t })
 248
 249     if (actor.Avatar) {
 250       await actor.Avatar.destroy({ transaction: t })
 251     }
 252
 253     actor.set('avatarId', avatar.id)
 254     await actor.save({ transaction: t })
 255
 256     return { actor, avatar }
 257   })
 258
 259   return res
 260     .json({
 261       avatar: avatar.toFormattedJSON()
 262     })
 263     .end()
 264 }
 265
 266 async function updateUser (req: express.Request, res: express.Response, next: express.NextFunction) {
 267   const body: UserUpdate = req.body
 268   const user = res.locals.user as UserModel
 269
 270   if (body.email !== undefined) user.email = body.email
 271   if (body.videoQuota !== undefined) user.videoQuota = body.videoQuota
 272   if (body.role !== undefined) user.role = body.role
 273
 274   await user.save()
 275
 276   return res.sendStatus(204)
 277 }
 278
 279 function success (req: express.Request, res: express.Response, next: express.NextFunction) {
 280   res.end()
 281 }