1 import * as express from 'express'
2 import { extname, join } from 'path'
3 import * as sharp from 'sharp'
4 import * as uuidv4 from 'uuid/v4'
5 import { UserCreate, UserRight, UserRole, UserUpdate, UserUpdateMe, UserVideoRate as FormattedUserVideoRate } from '../../../shared'
6 import { unlinkPromise } from '../../helpers/core-utils'
7 import { retryTransactionWrapper } from '../../helpers/database-utils'
8 import { logger } from '../../helpers/logger'
9 import { createReqFiles, getFormattedObjects } from '../../helpers/utils'
10 import { AVATAR_MIMETYPE_EXT, AVATARS_SIZE, CONFIG, sequelizeTypescript } from '../../initializers'
11 import { updateActorAvatarInstance } from '../../lib/activitypub'
12 import { sendUpdateUser } from '../../lib/activitypub/send'
13 import { createUserAccountAndChannel } from '../../lib/user'
15 asyncMiddleware, authenticate, ensureUserHasRight, ensureUserRegistrationAllowed, paginationValidator, setPagination, setUsersSort,
16 setVideosSort, token, usersAddValidator, usersGetValidator, usersRegisterValidator, usersRemoveValidator, usersSortValidator,
17 usersUpdateMeValidator, usersUpdateValidator, usersVideoRatingValidator
18 } from '../../middlewares'
19 import { usersUpdateMyAvatarValidator, videosSortValidator } from '../../middlewares/validators'
20 import { AccountVideoRateModel } from '../../models/account/account-video-rate'
21 import { UserModel } from '../../models/account/user'
22 import { VideoModel } from '../../models/video/video'
24 const reqAvatarFile = createReqFiles('avatarfile', CONFIG.STORAGE.AVATARS_DIR, AVATAR_MIMETYPE_EXT)
26 const usersRouter = express.Router()
28 usersRouter.get('/me',
30 asyncMiddleware(getUserInformation)
33 usersRouter.get('/me/videos',
39 asyncMiddleware(getUserVideos)
42 usersRouter.get('/me/videos/:videoId/rating',
44 asyncMiddleware(usersVideoRatingValidator),
45 asyncMiddleware(getUserVideoRating)
50 ensureUserHasRight(UserRight.MANAGE_USERS),
55 asyncMiddleware(listUsers)
58 usersRouter.get('/:id',
59 asyncMiddleware(usersGetValidator),
65 ensureUserHasRight(UserRight.MANAGE_USERS),
66 asyncMiddleware(usersAddValidator),
67 asyncMiddleware(createUserRetryWrapper)
70 usersRouter.post('/register',
71 asyncMiddleware(ensureUserRegistrationAllowed),
72 asyncMiddleware(usersRegisterValidator),
73 asyncMiddleware(registerUserRetryWrapper)
76 usersRouter.put('/me',
78 usersUpdateMeValidator,
79 asyncMiddleware(updateMe)
82 usersRouter.post('/me/avatar/pick',
85 usersUpdateMyAvatarValidator,
86 asyncMiddleware(updateMyAvatar)
89 usersRouter.put('/:id',
91 ensureUserHasRight(UserRight.MANAGE_USERS),
92 asyncMiddleware(usersUpdateValidator),
93 asyncMiddleware(updateUser)
96 usersRouter.delete('/:id',
98 ensureUserHasRight(UserRight.MANAGE_USERS),
99 asyncMiddleware(usersRemoveValidator),
100 asyncMiddleware(removeUser)
103 usersRouter.post('/token', token, success)
104 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
106 // ---------------------------------------------------------------------------
112 // ---------------------------------------------------------------------------
114 async function getUserVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
115 const user = res.locals.oauth.token.User as UserModel
116 const resultList = await VideoModel.listUserVideosForApi(user.id ,req.query.start, req.query.count, req.query.sort)
118 return res.json(getFormattedObjects(resultList.data, resultList.total))
121 async function createUserRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
124 errorMessage: 'Cannot insert the user with many retries.'
127 await retryTransactionWrapper(createUser, options)
129 // TODO : include Location of the new user -> 201
130 return res.type('json').status(204).end()
133 async function createUser (req: express.Request) {
134 const body: UserCreate = req.body
135 const user = new UserModel({
136 username: body.username,
137 password: body.password,
142 videoQuota: body.videoQuota
145 await createUserAccountAndChannel(user)
147 logger.info('User %s with its channel and account created.', body.username)
150 async function registerUserRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
153 errorMessage: 'Cannot insert the user with many retries.'
156 await retryTransactionWrapper(registerUser, options)
158 return res.type('json').status(204).end()
161 async function registerUser (req: express.Request) {
162 const body: UserCreate = req.body
164 const user = new UserModel({
165 username: body.username,
166 password: body.password,
171 videoQuota: CONFIG.USER.VIDEO_QUOTA
174 await createUserAccountAndChannel(user)
176 logger.info('User %s with its channel and account registered.', body.username)
179 async function getUserInformation (req: express.Request, res: express.Response, next: express.NextFunction) {
180 // We did not load channels in res.locals.user
181 const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
183 return res.json(user.toFormattedJSON())
186 function getUser (req: express.Request, res: express.Response, next: express.NextFunction) {
187 return res.json(res.locals.user.toFormattedJSON())
190 async function getUserVideoRating (req: express.Request, res: express.Response, next: express.NextFunction) {
191 const videoId = +req.params.videoId
192 const accountId = +res.locals.oauth.token.User.Account.id
194 const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
195 const rating = ratingObj ? ratingObj.type : 'none'
197 const json: FormattedUserVideoRate = {
204 async function listUsers (req: express.Request, res: express.Response, next: express.NextFunction) {
205 const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort)
207 return res.json(getFormattedObjects(resultList.data, resultList.total))
210 async function removeUser (req: express.Request, res: express.Response, next: express.NextFunction) {
211 const user = await UserModel.loadById(req.params.id)
215 return res.sendStatus(204)
218 async function updateMe (req: express.Request, res: express.Response, next: express.NextFunction) {
219 const body: UserUpdateMe = req.body
221 const user = res.locals.oauth.token.user
223 if (body.password !== undefined) user.password = body.password
224 if (body.email !== undefined) user.email = body.email
225 if (body.displayNSFW !== undefined) user.displayNSFW = body.displayNSFW
226 if (body.autoPlayVideo !== undefined) user.autoPlayVideo = body.autoPlayVideo
229 await sendUpdateUser(user, undefined)
231 return res.sendStatus(204)
234 async function updateMyAvatar (req: express.Request, res: express.Response, next: express.NextFunction) {
235 const avatarPhysicalFile = req.files['avatarfile'][0]
236 const user = res.locals.oauth.token.user
237 const actor = user.Account.Actor
239 const avatarDir = CONFIG.STORAGE.AVATARS_DIR
240 const source = join(avatarDir, avatarPhysicalFile.filename)
241 const extension = extname(avatarPhysicalFile.filename)
242 const avatarName = uuidv4() + extension
243 const destination = join(avatarDir, avatarName)
246 .resize(AVATARS_SIZE.width, AVATARS_SIZE.height)
249 await unlinkPromise(source)
251 const avatar = await sequelizeTypescript.transaction(async t => {
252 const updatedActor = await updateActorAvatarInstance(actor, avatarName, t)
253 await updatedActor.save({ transaction: t })
255 await sendUpdateUser(user, t)
257 return updatedActor.Avatar
262 avatar: avatar.toFormattedJSON()
267 async function updateUser (req: express.Request, res: express.Response, next: express.NextFunction) {
268 const body: UserUpdate = req.body
269 const user = res.locals.user as UserModel
271 if (body.email !== undefined) user.email = body.email
272 if (body.videoQuota !== undefined) user.videoQuota = body.videoQuota
273 if (body.role !== undefined) user.role = body.role
277 // Don't need to send this update to followers, these attributes are not propagated
279 return res.sendStatus(204)
282 function success (req: express.Request, res: express.Response, next: express.NextFunction) {