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 { 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'
46 import { createReqFiles } from '../../helpers/express-utils'
48 const reqAvatarFile = createReqFiles([ 'avatarfile' ], IMAGE_MIMETYPE_EXT, { avatarfile: CONFIG.STORAGE.AVATARS_DIR })
49 const loginRateLimiter = new RateLimit({
50 windowMs: RATES_LIMIT.LOGIN.WINDOW_MS,
51 max: RATES_LIMIT.LOGIN.MAX,
55 const usersRouter = express.Router()
57 usersRouter.get('/me',
59 asyncMiddleware(getUserInformation)
62 usersRouter.get('/me/video-quota-used',
64 asyncMiddleware(getUserVideoQuotaUsed)
67 usersRouter.get('/me/videos',
73 asyncMiddleware(getUserVideos)
76 usersRouter.get('/me/videos/:videoId/rating',
78 asyncMiddleware(usersVideoRatingValidator),
79 asyncMiddleware(getUserVideoRating)
84 ensureUserHasRight(UserRight.MANAGE_USERS),
89 asyncMiddleware(listUsers)
92 usersRouter.get('/:id',
94 ensureUserHasRight(UserRight.MANAGE_USERS),
95 asyncMiddleware(usersGetValidator),
101 ensureUserHasRight(UserRight.MANAGE_USERS),
102 asyncMiddleware(usersAddValidator),
103 asyncMiddleware(createUserRetryWrapper)
106 usersRouter.post('/register',
107 asyncMiddleware(ensureUserRegistrationAllowed),
108 asyncMiddleware(usersRegisterValidator),
109 asyncMiddleware(registerUserRetryWrapper)
112 usersRouter.put('/me',
114 usersUpdateMeValidator,
115 asyncMiddleware(updateMe)
118 usersRouter.post('/me/avatar/pick',
121 usersUpdateMyAvatarValidator,
122 asyncMiddleware(updateMyAvatar)
125 usersRouter.put('/:id',
127 ensureUserHasRight(UserRight.MANAGE_USERS),
128 asyncMiddleware(usersUpdateValidator),
129 asyncMiddleware(updateUser)
132 usersRouter.delete('/:id',
134 ensureUserHasRight(UserRight.MANAGE_USERS),
135 asyncMiddleware(usersRemoveValidator),
136 asyncMiddleware(removeUser)
139 usersRouter.post('/ask-reset-password',
140 asyncMiddleware(usersAskResetPasswordValidator),
141 asyncMiddleware(askResetUserPassword)
144 usersRouter.post('/:id/reset-password',
145 asyncMiddleware(usersResetPasswordValidator),
146 asyncMiddleware(resetUserPassword)
149 usersRouter.post('/token',
154 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
156 // ---------------------------------------------------------------------------
162 // ---------------------------------------------------------------------------
164 async function getUserVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
165 const user = res.locals.oauth.token.User as UserModel
166 const resultList = await VideoModel.listAccountVideosForApi(
168 req.query.start as number,
169 req.query.count as number,
170 req.query.sort as VideoSortField,
171 false // Display my NSFW videos
174 return res.json(getFormattedObjects(resultList.data, resultList.total))
177 async function createUserRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
180 errorMessage: 'Cannot insert the user with many retries.'
183 const { user, account } = await retryTransactionWrapper(createUser, options)
193 async function createUser (req: express.Request) {
194 const body: UserCreate = req.body
195 const userToCreate = new UserModel({
196 username: body.username,
197 password: body.password,
199 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
202 videoQuota: body.videoQuota
205 const { user, account } = await createUserAccountAndChannel(userToCreate)
207 logger.info('User %s with its channel and account created.', body.username)
209 return { user, account }
212 async function registerUserRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
215 errorMessage: 'Cannot insert the user with many retries.'
218 await retryTransactionWrapper(registerUser, options)
220 return res.type('json').status(204).end()
223 async function registerUser (req: express.Request) {
224 const body: UserCreate = req.body
226 const user = new UserModel({
227 username: body.username,
228 password: body.password,
230 nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
233 videoQuota: CONFIG.USER.VIDEO_QUOTA
236 await createUserAccountAndChannel(user)
238 logger.info('User %s with its channel and account registered.', body.username)
241 async function getUserInformation (req: express.Request, res: express.Response, next: express.NextFunction) {
242 // We did not load channels in res.locals.user
243 const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
245 return res.json(user.toFormattedJSON())
248 async function getUserVideoQuotaUsed (req: express.Request, res: express.Response, next: express.NextFunction) {
249 // We did not load channels in res.locals.user
250 const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
251 const videoQuotaUsed = await UserModel.getOriginalVideoFileTotalFromUser(user)
258 function getUser (req: express.Request, res: express.Response, next: express.NextFunction) {
259 return res.json((res.locals.user as UserModel).toFormattedJSON())
262 async function getUserVideoRating (req: express.Request, res: express.Response, next: express.NextFunction) {
263 const videoId = +req.params.videoId
264 const accountId = +res.locals.oauth.token.User.Account.id
266 const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
267 const rating = ratingObj ? ratingObj.type : 'none'
269 const json: FormattedUserVideoRate = {
276 async function listUsers (req: express.Request, res: express.Response, next: express.NextFunction) {
277 const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort)
279 return res.json(getFormattedObjects(resultList.data, resultList.total))
282 async function removeUser (req: express.Request, res: express.Response, next: express.NextFunction) {
283 const user = await UserModel.loadById(req.params.id)
287 return res.sendStatus(204)
290 async function updateMe (req: express.Request, res: express.Response, next: express.NextFunction) {
291 const body: UserUpdateMe = req.body
293 const user: UserModel = res.locals.oauth.token.user
295 if (body.password !== undefined) user.password = body.password
296 if (body.email !== undefined) user.email = body.email
297 if (body.nsfwPolicy !== undefined) user.nsfwPolicy = body.nsfwPolicy
298 if (body.autoPlayVideo !== undefined) user.autoPlayVideo = body.autoPlayVideo
300 await sequelizeTypescript.transaction(async t => {
301 await user.save({ transaction: t })
303 if (body.description !== undefined) user.Account.description = body.description
304 await user.Account.save({ transaction: t })
306 await sendUpdateActor(user.Account, t)
309 return res.sendStatus(204)
312 async function updateMyAvatar (req: express.Request, res: express.Response, next: express.NextFunction) {
313 const avatarPhysicalFile = req.files['avatarfile'][0]
314 const user = res.locals.oauth.token.user
315 const actor = user.Account.Actor
317 const extension = extname(avatarPhysicalFile.filename)
318 const avatarName = uuidv4() + extension
319 const destination = join(CONFIG.STORAGE.AVATARS_DIR, avatarName)
320 await processImage(avatarPhysicalFile, destination, AVATARS_SIZE)
322 const avatar = await sequelizeTypescript.transaction(async t => {
323 const updatedActor = await updateActorAvatarInstance(actor, avatarName, t)
324 await updatedActor.save({ transaction: t })
326 await sendUpdateActor(user.Account, t)
328 return updatedActor.Avatar
333 avatar: avatar.toFormattedJSON()
338 async function updateUser (req: express.Request, res: express.Response, next: express.NextFunction) {
339 const body: UserUpdate = req.body
340 const user = res.locals.user as UserModel
341 const roleChanged = body.role !== undefined && body.role !== user.role
343 if (body.email !== undefined) user.email = body.email
344 if (body.videoQuota !== undefined) user.videoQuota = body.videoQuota
345 if (body.role !== undefined) user.role = body.role
349 // Destroy user token to refresh rights
351 await OAuthTokenModel.deleteUserToken(user.id)
354 // Don't need to send this update to followers, these attributes are not propagated
356 return res.sendStatus(204)
359 async function askResetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
360 const user = res.locals.user as UserModel
362 const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
363 const url = CONFIG.WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
364 await Emailer.Instance.addForgetPasswordEmailJob(user.email, url)
366 return res.status(204).end()
369 async function resetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
370 const user = res.locals.user as UserModel
371 user.password = req.body.password
375 return res.status(204).end()
378 function success (req: express.Request, res: express.Response, next: express.NextFunction) {