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'
45 import { VideoSortField } from '../../../client/src/app/shared/video/sort-field.type'
47 const reqAvatarFile = createReqFiles([ 'avatarfile' ], IMAGE_MIMETYPE_EXT, { avatarfile: CONFIG.STORAGE.AVATARS_DIR })
48 const loginRateLimiter = new RateLimit({
49 windowMs: RATES_LIMIT.LOGIN.WINDOW_MS,
50 max: RATES_LIMIT.LOGIN.MAX,
54 const usersRouter = express.Router()
56 usersRouter.get('/me',
58 asyncMiddleware(getUserInformation)
61 usersRouter.get('/me/video-quota-used',
63 asyncMiddleware(getUserVideoQuotaUsed)
66 usersRouter.get('/me/videos',
72 asyncMiddleware(getUserVideos)
75 usersRouter.get('/me/videos/:videoId/rating',
77 asyncMiddleware(usersVideoRatingValidator),
78 asyncMiddleware(getUserVideoRating)
83 ensureUserHasRight(UserRight.MANAGE_USERS),
88 asyncMiddleware(listUsers)
91 usersRouter.get('/:id',
93 ensureUserHasRight(UserRight.MANAGE_USERS),
94 asyncMiddleware(usersGetValidator),
100 ensureUserHasRight(UserRight.MANAGE_USERS),
101 asyncMiddleware(usersAddValidator),
102 asyncMiddleware(createUserRetryWrapper)
105 usersRouter.post('/register',
106 asyncMiddleware(ensureUserRegistrationAllowed),
107 asyncMiddleware(usersRegisterValidator),
108 asyncMiddleware(registerUserRetryWrapper)
111 usersRouter.put('/me',
113 usersUpdateMeValidator,
114 asyncMiddleware(updateMe)
117 usersRouter.post('/me/avatar/pick',
120 usersUpdateMyAvatarValidator,
121 asyncMiddleware(updateMyAvatar)
124 usersRouter.put('/:id',
126 ensureUserHasRight(UserRight.MANAGE_USERS),
127 asyncMiddleware(usersUpdateValidator),
128 asyncMiddleware(updateUser)
131 usersRouter.delete('/:id',
133 ensureUserHasRight(UserRight.MANAGE_USERS),
134 asyncMiddleware(usersRemoveValidator),
135 asyncMiddleware(removeUser)
138 usersRouter.post('/ask-reset-password',
139 asyncMiddleware(usersAskResetPasswordValidator),
140 asyncMiddleware(askResetUserPassword)
143 usersRouter.post('/:id/reset-password',
144 asyncMiddleware(usersResetPasswordValidator),
145 asyncMiddleware(resetUserPassword)
148 usersRouter.post('/token',
153 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
155 // ---------------------------------------------------------------------------
161 // ---------------------------------------------------------------------------
163 async function getUserVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
164 const user = res.locals.oauth.token.User as UserModel
165 const resultList = await VideoModel.listAccountVideosForApi(
167 req.query.start as number,
168 req.query.count as number,
169 req.query.sort as VideoSortField,
170 false // Display my NSFW videos
173 return res.json(getFormattedObjects(resultList.data, resultList.total))
176 async function createUserRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
179 errorMessage: 'Cannot insert the user with many retries.'
182 const { user, account } = await retryTransactionWrapper(createUser, options)
192 async function createUser (req: express.Request) {
193 const body: UserCreate = req.body
194 const userToCreate = new UserModel({
195 username: body.username,
196 password: body.password,
198 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
201 videoQuota: body.videoQuota
204 const { user, account } = await createUserAccountAndChannel(userToCreate)
206 logger.info('User %s with its channel and account created.', body.username)
208 return { user, account }
211 async function registerUserRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
214 errorMessage: 'Cannot insert the user with many retries.'
217 await retryTransactionWrapper(registerUser, options)
219 return res.type('json').status(204).end()
222 async function registerUser (req: express.Request) {
223 const body: UserCreate = req.body
225 const user = new UserModel({
226 username: body.username,
227 password: body.password,
229 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
232 videoQuota: CONFIG.USER.VIDEO_QUOTA
235 await createUserAccountAndChannel(user)
237 logger.info('User %s with its channel and account registered.', body.username)
240 async function getUserInformation (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)
244 return res.json(user.toFormattedJSON())
247 async function getUserVideoQuotaUsed (req: express.Request, res: express.Response, next: express.NextFunction) {
248 // We did not load channels in res.locals.user
249 const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
250 const videoQuotaUsed = await UserModel.getOriginalVideoFileTotalFromUser(user)
257 function getUser (req: express.Request, res: express.Response, next: express.NextFunction) {
258 return res.json((res.locals.user as UserModel).toFormattedJSON())
261 async function getUserVideoRating (req: express.Request, res: express.Response, next: express.NextFunction) {
262 const videoId = +req.params.videoId
263 const accountId = +res.locals.oauth.token.User.Account.id
265 const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
266 const rating = ratingObj ? ratingObj.type : 'none'
268 const json: FormattedUserVideoRate = {
275 async function listUsers (req: express.Request, res: express.Response, next: express.NextFunction) {
276 const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort)
278 return res.json(getFormattedObjects(resultList.data, resultList.total))
281 async function removeUser (req: express.Request, res: express.Response, next: express.NextFunction) {
282 const user = await UserModel.loadById(req.params.id)
286 return res.sendStatus(204)
289 async function updateMe (req: express.Request, res: express.Response, next: express.NextFunction) {
290 const body: UserUpdateMe = req.body
292 const user: UserModel = res.locals.oauth.token.user
294 if (body.password !== undefined) user.password = body.password
295 if (body.email !== undefined) user.email = body.email
296 if (body.nsfwPolicy !== undefined) user.nsfwPolicy = body.nsfwPolicy
297 if (body.autoPlayVideo !== undefined) user.autoPlayVideo = body.autoPlayVideo
299 await sequelizeTypescript.transaction(async t => {
300 await user.save({ transaction: t })
302 if (body.description !== undefined) user.Account.description = body.description
303 await user.Account.save({ transaction: t })
305 await sendUpdateActor(user.Account, t)
308 return res.sendStatus(204)
311 async function updateMyAvatar (req: express.Request, res: express.Response, next: express.NextFunction) {
312 const avatarPhysicalFile = req.files['avatarfile'][0]
313 const user = res.locals.oauth.token.user
314 const actor = user.Account.Actor
316 const extension = extname(avatarPhysicalFile.filename)
317 const avatarName = uuidv4() + extension
318 const destination = join(CONFIG.STORAGE.AVATARS_DIR, avatarName)
319 await processImage(avatarPhysicalFile, destination, AVATARS_SIZE)
321 const avatar = await sequelizeTypescript.transaction(async t => {
322 const updatedActor = await updateActorAvatarInstance(actor, avatarName, t)
323 await updatedActor.save({ transaction: t })
325 await sendUpdateActor(user.Account, t)
327 return updatedActor.Avatar
332 avatar: avatar.toFormattedJSON()
337 async function updateUser (req: express.Request, res: express.Response, next: express.NextFunction) {
338 const body: UserUpdate = req.body
339 const user = res.locals.user as UserModel
340 const roleChanged = body.role !== undefined && body.role !== user.role
342 if (body.email !== undefined) user.email = body.email
343 if (body.videoQuota !== undefined) user.videoQuota = body.videoQuota
344 if (body.role !== undefined) user.role = body.role
348 // Destroy user token to refresh rights
350 await OAuthTokenModel.deleteUserToken(user.id)
353 // Don't need to send this update to followers, these attributes are not propagated
355 return res.sendStatus(204)
358 async function askResetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
359 const user = res.locals.user as UserModel
361 const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
362 const url = CONFIG.WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
363 await Emailer.Instance.addForgetPasswordEmailJob(user.email, url)
365 return res.status(204).end()
368 async function resetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
369 const user = res.locals.user as UserModel
370 user.password = req.body.password
374 return res.status(204).end()
377 function success (req: express.Request, res: express.Response, next: express.NextFunction) {