1 import * as express from 'express'
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'
21 ensureUserRegistrationAllowed,
28 usersRegisterValidator,
31 usersUpdateMeValidator,
33 usersVideoRatingValidator
34 } from '../../middlewares'
36 usersAskResetPasswordValidator,
37 usersResetPasswordValidator,
38 usersUpdateMyAvatarValidator,
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'
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,
53 const usersRouter = express.Router()
55 usersRouter.get('/me',
57 asyncMiddleware(getUserInformation)
60 usersRouter.get('/me/video-quota-used',
62 asyncMiddleware(getUserVideoQuotaUsed)
65 usersRouter.get('/me/videos',
71 asyncMiddleware(getUserVideos)
74 usersRouter.get('/me/videos/:videoId/rating',
76 asyncMiddleware(usersVideoRatingValidator),
77 asyncMiddleware(getUserVideoRating)
82 ensureUserHasRight(UserRight.MANAGE_USERS),
87 asyncMiddleware(listUsers)
90 usersRouter.get('/:id',
92 ensureUserHasRight(UserRight.MANAGE_USERS),
93 asyncMiddleware(usersGetValidator),
99 ensureUserHasRight(UserRight.MANAGE_USERS),
100 asyncMiddleware(usersAddValidator),
101 asyncMiddleware(createUserRetryWrapper)
104 usersRouter.post('/register',
105 asyncMiddleware(ensureUserRegistrationAllowed),
106 asyncMiddleware(usersRegisterValidator),
107 asyncMiddleware(registerUserRetryWrapper)
110 usersRouter.put('/me',
112 usersUpdateMeValidator,
113 asyncMiddleware(updateMe)
116 usersRouter.post('/me/avatar/pick',
119 usersUpdateMyAvatarValidator,
120 asyncMiddleware(updateMyAvatar)
123 usersRouter.put('/:id',
125 ensureUserHasRight(UserRight.MANAGE_USERS),
126 asyncMiddleware(usersUpdateValidator),
127 asyncMiddleware(updateUser)
130 usersRouter.delete('/:id',
132 ensureUserHasRight(UserRight.MANAGE_USERS),
133 asyncMiddleware(usersRemoveValidator),
134 asyncMiddleware(removeUser)
137 usersRouter.post('/ask-reset-password',
138 asyncMiddleware(usersAskResetPasswordValidator),
139 asyncMiddleware(askResetUserPassword)
142 usersRouter.post('/:id/reset-password',
143 asyncMiddleware(usersResetPasswordValidator),
144 asyncMiddleware(resetUserPassword)
147 usersRouter.post('/token',
152 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
154 // ---------------------------------------------------------------------------
160 // ---------------------------------------------------------------------------
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)
166 return res.json(getFormattedObjects(resultList.data, resultList.total))
169 async function createUserRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
172 errorMessage: 'Cannot insert the user with many retries.'
175 const { user, account } = await retryTransactionWrapper(createUser, options)
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,
194 videoQuota: body.videoQuota
197 const { user, account } = await createUserAccountAndChannel(userToCreate)
199 logger.info('User %s with its channel and account created.', body.username)
201 return { user, account }
204 async function registerUserRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
207 errorMessage: 'Cannot insert the user with many retries.'
210 await retryTransactionWrapper(registerUser, options)
212 return res.type('json').status(204).end()
215 async function registerUser (req: express.Request) {
216 const body: UserCreate = req.body
218 const user = new UserModel({
219 username: body.username,
220 password: body.password,
225 videoQuota: CONFIG.USER.VIDEO_QUOTA
228 await createUserAccountAndChannel(user)
230 logger.info('User %s with its channel and account registered.', body.username)
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)
237 return res.json(user.toFormattedJSON())
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)
250 function getUser (req: express.Request, res: express.Response, next: express.NextFunction) {
251 return res.json((res.locals.user as UserModel).toFormattedJSON())
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
258 const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
259 const rating = ratingObj ? ratingObj.type : 'none'
261 const json: FormattedUserVideoRate = {
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)
271 return res.json(getFormattedObjects(resultList.data, resultList.total))
274 async function removeUser (req: express.Request, res: express.Response, next: express.NextFunction) {
275 const user = await UserModel.loadById(req.params.id)
279 return res.sendStatus(204)
282 async function updateMe (req: express.Request, res: express.Response, next: express.NextFunction) {
283 const body: UserUpdateMe = req.body
285 const user: UserModel = res.locals.oauth.token.user
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
292 await sequelizeTypescript.transaction(async t => {
293 await user.save({ transaction: t })
295 if (body.description !== undefined) user.Account.description = body.description
296 await user.Account.save({ transaction: t })
298 await sendUpdateActor(user.Account, t)
301 return res.sendStatus(204)
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
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)
314 const avatar = await sequelizeTypescript.transaction(async t => {
315 const updatedActor = await updateActorAvatarInstance(actor, avatarName, t)
316 await updatedActor.save({ transaction: t })
318 await sendUpdateActor(user.Account, t)
320 return updatedActor.Avatar
325 avatar: avatar.toFormattedJSON()
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
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
341 // Destroy user token to refresh rights
343 await OAuthTokenModel.deleteUserToken(user.id)
346 // Don't need to send this update to followers, these attributes are not propagated
348 return res.sendStatus(204)
351 async function askResetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
352 const user = res.locals.user as UserModel
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)
358 return res.status(204).end()
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
367 return res.status(204).end()
370 function success (req: express.Request, res: express.Response, next: express.NextFunction) {