1 import * as express from 'express'
3 import { database as db, CONFIG } from '../../initializers'
4 import { logger, getFormattedObjects, retryTransactionWrapper } from '../../helpers'
8 ensureUserRegistrationAllowed,
10 usersRegisterValidator,
12 usersUpdateMeValidator,
14 usersVideoRatingValidator,
22 } from '../../middlewares'
24 UserVideoRate as FormattedUserVideoRate,
30 } from '../../../shared'
31 import { createUserAuthorAndChannel } from '../../lib'
32 import { UserInstance } from '../../models'
34 const usersRouter = express.Router()
36 usersRouter.get('/me',
38 asyncMiddleware(getUserInformation)
41 usersRouter.get('/me/videos/:videoId/rating',
43 usersVideoRatingValidator,
44 asyncMiddleware(getUserVideoRating)
52 asyncMiddleware(listUsers)
55 usersRouter.get('/:id',
62 ensureUserHasRight(UserRight.MANAGE_USERS),
64 createUserRetryWrapper
67 usersRouter.post('/register',
68 ensureUserRegistrationAllowed,
69 usersRegisterValidator,
70 asyncMiddleware(registerUser)
73 usersRouter.put('/me',
75 usersUpdateMeValidator,
76 asyncMiddleware(updateMe)
79 usersRouter.put('/:id',
81 ensureUserHasRight(UserRight.MANAGE_USERS),
83 asyncMiddleware(updateUser)
86 usersRouter.delete('/:id',
88 ensureUserHasRight(UserRight.MANAGE_USERS),
90 asyncMiddleware(removeUser)
93 usersRouter.post('/token', token, success)
94 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
96 // ---------------------------------------------------------------------------
102 // ---------------------------------------------------------------------------
104 async function createUserRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
106 arguments: [ req, res ],
107 errorMessage: 'Cannot insert the user with many retries.'
110 await retryTransactionWrapper(createUser, options)
112 // TODO : include Location of the new user -> 201
113 return res.type('json').status(204).end()
116 async function createUser (req: express.Request, res: express.Response, next: express.NextFunction) {
117 const body: UserCreate = req.body
118 const user = db.User.build({
119 username: body.username,
120 password: body.password,
124 videoQuota: body.videoQuota
127 await createUserAuthorAndChannel(user)
129 logger.info('User %s with its channel and author created.', body.username)
132 async function registerUser (req: express.Request, res: express.Response, next: express.NextFunction) {
133 const body: UserCreate = req.body
135 const user = db.User.build({
136 username: body.username,
137 password: body.password,
141 videoQuota: CONFIG.USER.VIDEO_QUOTA
144 await createUserAuthorAndChannel(user)
145 return res.type('json').status(204).end()
148 async function getUserInformation (req: express.Request, res: express.Response, next: express.NextFunction) {
149 const user = await db.User.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
151 return res.json(user.toFormattedJSON())
154 function getUser (req: express.Request, res: express.Response, next: express.NextFunction) {
155 return res.json(res.locals.user.toFormattedJSON())
158 async function getUserVideoRating (req: express.Request, res: express.Response, next: express.NextFunction) {
159 const videoId = +req.params.videoId
160 const userId = +res.locals.oauth.token.User.id
162 const ratingObj = await db.UserVideoRate.load(userId, videoId, null)
163 const rating = ratingObj ? ratingObj.type : 'none'
165 const json: FormattedUserVideoRate = {
172 async function listUsers (req: express.Request, res: express.Response, next: express.NextFunction) {
173 const resultList = await db.User.listForApi(req.query.start, req.query.count, req.query.sort)
175 return res.json(getFormattedObjects(resultList.data, resultList.total))
178 async function removeUser (req: express.Request, res: express.Response, next: express.NextFunction) {
179 const user = await db.User.loadById(req.params.id)
183 return res.sendStatus(204)
186 async function updateMe (req: express.Request, res: express.Response, next: express.NextFunction) {
187 const body: UserUpdateMe = req.body
189 // FIXME: user is not already a Sequelize instance?
190 const user = res.locals.oauth.token.user
192 if (body.password !== undefined) user.password = body.password
193 if (body.email !== undefined) user.email = body.email
194 if (body.displayNSFW !== undefined) user.displayNSFW = body.displayNSFW
198 return res.sendStatus(204)
201 async function updateUser (req: express.Request, res: express.Response, next: express.NextFunction) {
202 const body: UserUpdate = req.body
203 const user: UserInstance = res.locals.user
205 if (body.email !== undefined) user.email = body.email
206 if (body.videoQuota !== undefined) user.videoQuota = body.videoQuota
207 if (body.role !== undefined) user.role = body.role
211 return res.sendStatus(204)
214 function success (req: express.Request, res: express.Response, next: express.NextFunction) {