server/controllers/api/users.ts

   1 import * as express from 'express'
   2
   3 import { database as db } from '../../initializers/database'
   4 import { USER_ROLES, CONFIG } from '../../initializers'
   5 import { logger, getFormattedObjects } from '../../helpers'
   6 import {
   7   authenticate,
   8   ensureIsAdmin,
   9   ensureUserRegistrationAllowed,
  10   usersAddValidator,
  11   usersUpdateValidator,
  12   usersUpdateMeValidator,
  13   usersRemoveValidator,
  14   usersVideoRatingValidator,
  15   usersGetValidator,
  16   paginationValidator,
  17   setPagination,
  18   usersSortValidator,
  19   setUsersSort,
  20   token
  21 } from '../../middlewares'
  22 import {
  23   UserVideoRate as FormattedUserVideoRate,
  24   UserCreate,
  25   UserUpdate,
  26   UserUpdateMe
  27 } from '../../../shared'
  28
  29 const usersRouter = express.Router()
  30
  31 usersRouter.get('/me',
  32   authenticate,
  33   getUserInformation
  34 )
  35
  36 usersRouter.get('/me/videos/:videoId/rating',
  37   authenticate,
  38   usersVideoRatingValidator,
  39   getUserVideoRating
  40 )
  41
  42 usersRouter.get('/',
  43   paginationValidator,
  44   usersSortValidator,
  45   setUsersSort,
  46   setPagination,
  47   listUsers
  48 )
  49
  50 usersRouter.get('/:id',
  51   usersGetValidator,
  52   getUser
  53 )
  54
  55 usersRouter.post('/',
  56   authenticate,
  57   ensureIsAdmin,
  58   usersAddValidator,
  59   createUser
  60 )
  61
  62 usersRouter.post('/register',
  63   ensureUserRegistrationAllowed,
  64   usersAddValidator,
  65   createUser
  66 )
  67
  68 usersRouter.put('/me',
  69   authenticate,
  70   usersUpdateMeValidator,
  71   updateMe
  72 )
  73
  74 usersRouter.put('/:id',
  75   authenticate,
  76   ensureIsAdmin,
  77   usersUpdateValidator,
  78   updateUser
  79 )
  80
  81 usersRouter.delete('/:id',
  82   authenticate,
  83   ensureIsAdmin,
  84   usersRemoveValidator,
  85   removeUser
  86 )
  87
  88 usersRouter.post('/token', token, success)
  89 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
  90
  91 // ---------------------------------------------------------------------------
  92
  93 export {
  94   usersRouter
  95 }
  96
  97 // ---------------------------------------------------------------------------
  98
  99 function createUser (req: express.Request, res: express.Response, next: express.NextFunction) {
 100   const body: UserCreate = req.body
 101
 102   // On registration, we set the user video quota
 103   if (body.videoQuota === undefined) {
 104     body.videoQuota = CONFIG.USER.VIDEO_QUOTA
 105   }
 106
 107   const user = db.User.build({
 108     username: body.username,
 109     password: body.password,
 110     email: body.email,
 111     displayNSFW: false,
 112     role: USER_ROLES.USER,
 113     videoQuota: body.videoQuota
 114   })
 115
 116   user.save()
 117     .then(() => res.type('json').status(204).end())
 118     .catch(err => next(err))
 119 }
 120
 121 function getUserInformation (req: express.Request, res: express.Response, next: express.NextFunction) {
 122   db.User.loadByUsername(res.locals.oauth.token.user.username)
 123     .then(user => res.json(user.toFormattedJSON()))
 124     .catch(err => next(err))
 125 }
 126
 127 function getUser (req: express.Request, res: express.Response, next: express.NextFunction) {
 128   return res.json(res.locals.user.toFormattedJSON())
 129 }
 130
 131 function getUserVideoRating (req: express.Request, res: express.Response, next: express.NextFunction) {
 132   const videoId = +req.params.videoId
 133   const userId = +res.locals.oauth.token.User.id
 134
 135   db.UserVideoRate.load(userId, videoId, null)
 136     .then(ratingObj => {
 137       const rating = ratingObj ? ratingObj.type : 'none'
 138       const json: FormattedUserVideoRate = {
 139         videoId,
 140         rating
 141       }
 142       res.json(json)
 143     })
 144     .catch(err => next(err))
 145 }
 146
 147 function listUsers (req: express.Request, res: express.Response, next: express.NextFunction) {
 148   db.User.listForApi(req.query.start, req.query.count, req.query.sort)
 149     .then(resultList => {
 150       res.json(getFormattedObjects(resultList.data, resultList.total))
 151     })
 152     .catch(err => next(err))
 153 }
 154
 155 function removeUser (req: express.Request, res: express.Response, next: express.NextFunction) {
 156   db.User.loadById(req.params.id)
 157     .then(user => user.destroy())
 158     .then(() => res.sendStatus(204))
 159     .catch(err => {
 160       logger.error('Errors when removed the user.', err)
 161       return next(err)
 162     })
 163 }
 164
 165 function updateMe (req: express.Request, res: express.Response, next: express.NextFunction) {
 166   const body: UserUpdateMe = req.body
 167
 168   // FIXME: user is not already a Sequelize instance?
 169   db.User.loadByUsername(res.locals.oauth.token.user.username)
 170     .then(user => {
 171       if (body.password !== undefined) user.password = body.password
 172       if (body.email !== undefined) user.email = body.email
 173       if (body.displayNSFW !== undefined) user.displayNSFW = body.displayNSFW
 174
 175       return user.save()
 176     })
 177     .then(() => res.sendStatus(204))
 178     .catch(err => next(err))
 179 }
 180
 181 function updateUser (req: express.Request, res: express.Response, next: express.NextFunction) {
 182   const body: UserUpdate = req.body
 183   const user = res.locals.user
 184
 185   if (body.email !== undefined) user.email = body.email
 186   if (body.videoQuota !== undefined) user.videoQuota = body.videoQuota
 187
 188   return user.save()
 189     .then(() => res.sendStatus(204))
 190     .catch(err => next(err))
 191 }
 192
 193 function success (req: express.Request, res: express.Response, next: express.NextFunction) {
 194   res.end()
 195 }