1 import * as express from 'express'
3 import { extname, join } from 'path'
4 import * as uuidv4 from 'uuid/v4'
5 import { UserCreate, UserRight, UserRole, UserUpdate, UserUpdateMe, UserVideoRate as FormattedUserVideoRate } from '../../../shared'
6 import { retryTransactionWrapper } from '../../helpers/database-utils'
7 import { processImage } from '../../helpers/image-utils'
8 import { logger } from '../../helpers/logger'
9 import { createReqFiles, getFormattedObjects } from '../../helpers/utils'
10 import { AVATARS_SIZE, CONFIG, IMAGE_MIMETYPE_EXT, sequelizeTypescript } from '../../initializers'
11 import { updateActorAvatarInstance } from '../../lib/activitypub'
12 import { sendUpdateActor } from '../../lib/activitypub/send'
13 import { Emailer } from '../../lib/emailer'
14 import { Redis } from '../../lib/redis'
15 import { createUserAccountAndChannel } from '../../lib/user'
20 ensureUserRegistrationAllowed,
27 usersRegisterValidator,
30 usersUpdateMeValidator,
32 usersVideoRatingValidator
33 } from '../../middlewares'
35 usersAskResetPasswordValidator,
36 usersResetPasswordValidator,
37 usersUpdateMyAvatarValidator,
39 } from '../../middlewares/validators'
40 import { AccountVideoRateModel } from '../../models/account/account-video-rate'
41 import { UserModel } from '../../models/account/user'
42 import { OAuthTokenModel } from '../../models/oauth/oauth-token'
43 import { VideoModel } from '../../models/video/video'
45 const reqAvatarFile = createReqFiles([ 'avatarfile' ], IMAGE_MIMETYPE_EXT, { avatarfile: CONFIG.STORAGE.AVATARS_DIR })
47 const usersRouter = express.Router()
49 usersRouter.get('/me',
51 asyncMiddleware(getUserInformation)
54 usersRouter.get('/me/video-quota-used',
56 asyncMiddleware(getUserVideoQuotaUsed)
59 usersRouter.get('/me/videos',
65 asyncMiddleware(getUserVideos)
68 usersRouter.get('/me/videos/:videoId/rating',
70 asyncMiddleware(usersVideoRatingValidator),
71 asyncMiddleware(getUserVideoRating)
76 ensureUserHasRight(UserRight.MANAGE_USERS),
81 asyncMiddleware(listUsers)
84 usersRouter.get('/:id',
85 asyncMiddleware(usersGetValidator),
91 ensureUserHasRight(UserRight.MANAGE_USERS),
92 asyncMiddleware(usersAddValidator),
93 asyncMiddleware(createUserRetryWrapper)
96 usersRouter.post('/register',
97 asyncMiddleware(ensureUserRegistrationAllowed),
98 asyncMiddleware(usersRegisterValidator),
99 asyncMiddleware(registerUserRetryWrapper)
102 usersRouter.put('/me',
104 usersUpdateMeValidator,
105 asyncMiddleware(updateMe)
108 usersRouter.post('/me/avatar/pick',
111 usersUpdateMyAvatarValidator,
112 asyncMiddleware(updateMyAvatar)
115 usersRouter.put('/:id',
117 ensureUserHasRight(UserRight.MANAGE_USERS),
118 asyncMiddleware(usersUpdateValidator),
119 asyncMiddleware(updateUser)
122 usersRouter.delete('/:id',
124 ensureUserHasRight(UserRight.MANAGE_USERS),
125 asyncMiddleware(usersRemoveValidator),
126 asyncMiddleware(removeUser)
129 usersRouter.post('/ask-reset-password',
130 asyncMiddleware(usersAskResetPasswordValidator),
131 asyncMiddleware(askResetUserPassword)
134 usersRouter.post('/:id/reset-password',
135 asyncMiddleware(usersResetPasswordValidator),
136 asyncMiddleware(resetUserPassword)
139 usersRouter.post('/token', token, success)
140 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
142 // ---------------------------------------------------------------------------
148 // ---------------------------------------------------------------------------
150 async function getUserVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
151 const user = res.locals.oauth.token.User as UserModel
152 const resultList = await VideoModel.listUserVideosForApi(user.id ,req.query.start, req.query.count, req.query.sort)
154 return res.json(getFormattedObjects(resultList.data, resultList.total))
157 async function createUserRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
160 errorMessage: 'Cannot insert the user with many retries.'
163 const { user, account } = await retryTransactionWrapper(createUser, options)
173 async function createUser (req: express.Request) {
174 const body: UserCreate = req.body
175 const userToCreate = new UserModel({
176 username: body.username,
177 password: body.password,
182 videoQuota: body.videoQuota
185 const { user, account } = await createUserAccountAndChannel(userToCreate)
187 logger.info('User %s with its channel and account created.', body.username)
189 return { user, account }
192 async function registerUserRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
195 errorMessage: 'Cannot insert the user with many retries.'
198 await retryTransactionWrapper(registerUser, options)
200 return res.type('json').status(204).end()
203 async function registerUser (req: express.Request) {
204 const body: UserCreate = req.body
206 const user = new UserModel({
207 username: body.username,
208 password: body.password,
213 videoQuota: CONFIG.USER.VIDEO_QUOTA
216 await createUserAccountAndChannel(user)
218 logger.info('User %s with its channel and account registered.', body.username)
221 async function getUserInformation (req: express.Request, res: express.Response, next: express.NextFunction) {
222 // We did not load channels in res.locals.user
223 const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
225 return res.json(user.toFormattedJSON())
228 async function getUserVideoQuotaUsed (req: express.Request, res: express.Response, next: express.NextFunction) {
229 // We did not load channels in res.locals.user
230 const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
231 const videoQuotaUsed = await UserModel.getOriginalVideoFileTotalFromUser(user)
238 function getUser (req: express.Request, res: express.Response, next: express.NextFunction) {
239 return res.json((res.locals.user as UserModel).toFormattedJSON())
242 async function getUserVideoRating (req: express.Request, res: express.Response, next: express.NextFunction) {
243 const videoId = +req.params.videoId
244 const accountId = +res.locals.oauth.token.User.Account.id
246 const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
247 const rating = ratingObj ? ratingObj.type : 'none'
249 const json: FormattedUserVideoRate = {
256 async function listUsers (req: express.Request, res: express.Response, next: express.NextFunction) {
257 const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort)
259 return res.json(getFormattedObjects(resultList.data, resultList.total))
262 async function removeUser (req: express.Request, res: express.Response, next: express.NextFunction) {
263 const user = await UserModel.loadById(req.params.id)
267 return res.sendStatus(204)
270 async function updateMe (req: express.Request, res: express.Response, next: express.NextFunction) {
271 const body: UserUpdateMe = req.body
273 const user: UserModel = res.locals.oauth.token.user
275 if (body.password !== undefined) user.password = body.password
276 if (body.email !== undefined) user.email = body.email
277 if (body.displayNSFW !== undefined) user.displayNSFW = body.displayNSFW
278 if (body.autoPlayVideo !== undefined) user.autoPlayVideo = body.autoPlayVideo
280 await sequelizeTypescript.transaction(async t => {
281 await user.save({ transaction: t })
283 if (body.description !== undefined) user.Account.description = body.description
284 await user.Account.save({ transaction: t })
286 await sendUpdateActor(user.Account, t)
289 return res.sendStatus(204)
292 async function updateMyAvatar (req: express.Request, res: express.Response, next: express.NextFunction) {
293 const avatarPhysicalFile = req.files['avatarfile'][0]
294 const user = res.locals.oauth.token.user
295 const actor = user.Account.Actor
297 const extension = extname(avatarPhysicalFile.filename)
298 const avatarName = uuidv4() + extension
299 const destination = join(CONFIG.STORAGE.AVATARS_DIR, avatarName)
300 await processImage(avatarPhysicalFile, destination, AVATARS_SIZE)
302 const avatar = await sequelizeTypescript.transaction(async t => {
303 const updatedActor = await updateActorAvatarInstance(actor, avatarName, t)
304 await updatedActor.save({ transaction: t })
306 await sendUpdateActor(user.Account, t)
308 return updatedActor.Avatar
313 avatar: avatar.toFormattedJSON()
318 async function updateUser (req: express.Request, res: express.Response, next: express.NextFunction) {
319 const body: UserUpdate = req.body
320 const user = res.locals.user as UserModel
321 const roleChanged = body.role !== undefined && body.role !== user.role
323 if (body.email !== undefined) user.email = body.email
324 if (body.videoQuota !== undefined) user.videoQuota = body.videoQuota
325 if (body.role !== undefined) user.role = body.role
329 // Destroy user token to refresh rights
331 await OAuthTokenModel.deleteUserToken(user.id)
334 // Don't need to send this update to followers, these attributes are not propagated
336 return res.sendStatus(204)
339 async function askResetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
340 const user = res.locals.user as UserModel
342 const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
343 const url = CONFIG.WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
344 await Emailer.Instance.addForgetPasswordEmailJob(user.email, url)
346 return res.status(204).end()
349 async function resetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
350 const user = res.locals.user as UserModel
351 user.password = req.body.password
355 return res.status(204).end()
358 function success (req: express.Request, res: express.Response, next: express.NextFunction) {