PeerTube/server/controllers/api/users.ts

300 lines
9.3 KiB
TypeScript
Raw Normal View History

2017-06-05 21:53:49 +02:00
import * as express from 'express'
2017-12-29 19:10:13 +01:00
import { extname, join } from 'path'
2018-01-03 11:36:03 +01:00
import * as sharp from 'sharp'
2017-12-29 19:10:13 +01:00
import * as uuidv4 from 'uuid/v4'
2017-11-10 17:27:49 +01:00
import { UserCreate, UserRight, UserRole, UserUpdate, UserUpdateMe, UserVideoRate as FormattedUserVideoRate } from '../../../shared'
2018-01-03 11:54:42 +01:00
import { unlinkPromise } from '../../helpers/core-utils'
2017-12-28 11:16:08 +01:00
import { retryTransactionWrapper } from '../../helpers/database-utils'
import { logger } from '../../helpers/logger'
2017-12-29 19:10:13 +01:00
import { createReqFiles, getFormattedObjects } from '../../helpers/utils'
2018-01-03 11:36:03 +01:00
import { AVATAR_MIMETYPE_EXT, AVATARS_SIZE, CONFIG, sequelizeTypescript } from '../../initializers'
2018-01-04 14:04:02 +01:00
import { updateActorAvatarInstance } from '../../lib/activitypub'
2018-01-03 16:38:50 +01:00
import { sendUpdateUser } from '../../lib/activitypub/send'
2017-12-14 17:38:41 +01:00
import { createUserAccountAndChannel } from '../../lib/user'
2017-05-15 22:22:03 +02:00
import {
2017-12-28 11:16:08 +01:00
asyncMiddleware, authenticate, ensureUserHasRight, ensureUserRegistrationAllowed, paginationValidator, setPagination, setUsersSort,
setVideosSort, token, usersAddValidator, usersGetValidator, usersRegisterValidator, usersRemoveValidator, usersSortValidator,
usersUpdateMeValidator, usersUpdateValidator, usersVideoRatingValidator
2017-05-15 22:22:03 +02:00
} from '../../middlewares'
2017-12-29 19:10:13 +01:00
import { usersUpdateMyAvatarValidator, videosSortValidator } from '../../middlewares/validators'
2017-12-12 17:53:50 +01:00
import { AccountVideoRateModel } from '../../models/account/account-video-rate'
import { UserModel } from '../../models/account/user'
import { VideoModel } from '../../models/video/video'
2017-05-15 22:22:03 +02:00
2017-12-29 19:10:13 +01:00
const reqAvatarFile = createReqFiles('avatarfile', CONFIG.STORAGE.AVATARS_DIR, AVATAR_MIMETYPE_EXT)
2017-05-15 22:22:03 +02:00
const usersRouter = express.Router()
usersRouter.get('/me',
authenticate,
2017-10-25 11:55:06 +02:00
asyncMiddleware(getUserInformation)
2017-03-08 21:35:43 +01:00
)
2018-01-08 12:53:09 +01:00
usersRouter.get('/me/video-quota-used',
authenticate,
asyncMiddleware(getUserVideoQuotaUsed)
)
2017-10-31 11:52:52 +01:00
usersRouter.get('/me/videos',
authenticate,
paginationValidator,
videosSortValidator,
setVideosSort,
setPagination,
asyncMiddleware(getUserVideos)
)
2017-05-15 22:22:03 +02:00
usersRouter.get('/me/videos/:videoId/rating',
authenticate,
2017-11-27 17:30:46 +01:00
asyncMiddleware(usersVideoRatingValidator),
2017-10-25 11:55:06 +02:00
asyncMiddleware(getUserVideoRating)
2017-03-08 21:35:43 +01:00
)
2017-05-15 22:22:03 +02:00
usersRouter.get('/',
authenticate,
ensureUserHasRight(UserRight.MANAGE_USERS),
2017-05-15 22:22:03 +02:00
paginationValidator,
usersSortValidator,
setUsersSort,
setPagination,
2017-10-25 11:55:06 +02:00
asyncMiddleware(listUsers)
2016-08-16 22:31:45 +02:00
)
2017-09-05 21:29:39 +02:00
usersRouter.get('/:id',
2017-11-27 17:30:46 +01:00
asyncMiddleware(usersGetValidator),
2017-09-05 21:29:39 +02:00
getUser
)
2017-05-15 22:22:03 +02:00
usersRouter.post('/',
authenticate,
ensureUserHasRight(UserRight.MANAGE_USERS),
2017-11-27 17:30:46 +01:00
asyncMiddleware(usersAddValidator),
asyncMiddleware(createUserRetryWrapper)
)
2017-05-15 22:22:03 +02:00
usersRouter.post('/register',
2017-11-27 17:30:46 +01:00
asyncMiddleware(ensureUserRegistrationAllowed),
asyncMiddleware(usersRegisterValidator),
2017-11-16 18:40:50 +01:00
asyncMiddleware(registerUserRetryWrapper)
)
2017-09-05 21:29:39 +02:00
usersRouter.put('/me',
authenticate,
usersUpdateMeValidator,
2017-10-25 11:55:06 +02:00
asyncMiddleware(updateMe)
2017-09-05 21:29:39 +02:00
)
2017-12-29 19:10:13 +01:00
usersRouter.post('/me/avatar/pick',
authenticate,
reqAvatarFile,
usersUpdateMyAvatarValidator,
asyncMiddleware(updateMyAvatar)
)
2017-05-15 22:22:03 +02:00
usersRouter.put('/:id',
authenticate,
ensureUserHasRight(UserRight.MANAGE_USERS),
2017-11-27 17:30:46 +01:00
asyncMiddleware(usersUpdateValidator),
2017-10-25 11:55:06 +02:00
asyncMiddleware(updateUser)
)
2017-05-15 22:22:03 +02:00
usersRouter.delete('/:id',
authenticate,
ensureUserHasRight(UserRight.MANAGE_USERS),
2017-11-27 17:30:46 +01:00
asyncMiddleware(usersRemoveValidator),
2017-10-25 11:55:06 +02:00
asyncMiddleware(removeUser)
)
2016-08-05 16:09:39 +02:00
2017-05-15 22:22:03 +02:00
usersRouter.post('/token', token, success)
// TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
2016-03-21 11:56:33 +01:00
// ---------------------------------------------------------------------------
2017-05-15 22:22:03 +02:00
export {
usersRouter
}
2016-03-21 11:56:33 +01:00
// ---------------------------------------------------------------------------
2017-10-31 11:52:52 +01:00
async function getUserVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
2017-12-12 17:53:50 +01:00
const user = res.locals.oauth.token.User as UserModel
const resultList = await VideoModel.listUserVideosForApi(user.id ,req.query.start, req.query.count, req.query.sort)
2017-10-31 11:52:52 +01:00
return res.json(getFormattedObjects(resultList.data, resultList.total))
}
2017-10-25 11:55:06 +02:00
async function createUserRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
2017-10-24 19:41:09 +02:00
const options = {
2017-11-16 18:40:50 +01:00
arguments: [ req ],
2017-10-24 19:41:09 +02:00
errorMessage: 'Cannot insert the user with many retries.'
}
2017-10-25 11:55:06 +02:00
await retryTransactionWrapper(createUser, options)
// TODO : include Location of the new user -> 201
return res.type('json').status(204).end()
2017-10-24 19:41:09 +02:00
}
2017-11-16 18:40:50 +01:00
async function createUser (req: express.Request) {
const body: UserCreate = req.body
2017-12-12 17:53:50 +01:00
const user = new UserModel({
username: body.username,
password: body.password,
email: body.email,
2017-04-03 21:24:36 +02:00
displayNSFW: false,
autoPlayVideo: true,
role: body.role,
2017-09-04 20:07:54 +02:00
videoQuota: body.videoQuota
})
2017-11-10 14:48:08 +01:00
await createUserAccountAndChannel(user)
2017-10-25 11:55:06 +02:00
2017-11-10 14:48:08 +01:00
logger.info('User %s with its channel and account created.', body.username)
}
2017-11-16 18:40:50 +01:00
async function registerUserRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
const options = {
arguments: [ req ],
errorMessage: 'Cannot insert the user with many retries.'
}
await retryTransactionWrapper(registerUser, options)
return res.type('json').status(204).end()
}
async function registerUser (req: express.Request) {
2017-09-06 16:35:40 +02:00
const body: UserCreate = req.body
2017-12-12 17:53:50 +01:00
const user = new UserModel({
2017-09-06 16:35:40 +02:00
username: body.username,
password: body.password,
email: body.email,
displayNSFW: false,
autoPlayVideo: true,
role: UserRole.USER,
2017-09-06 16:35:40 +02:00
videoQuota: CONFIG.USER.VIDEO_QUOTA
})
2017-11-10 14:48:08 +01:00
await createUserAccountAndChannel(user)
2017-11-16 18:40:50 +01:00
logger.info('User %s with its channel and account registered.', body.username)
2017-09-06 16:35:40 +02:00
}
2017-10-25 11:55:06 +02:00
async function getUserInformation (req: express.Request, res: express.Response, next: express.NextFunction) {
2017-10-31 11:52:52 +01:00
// We did not load channels in res.locals.user
2017-12-12 17:53:50 +01:00
const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
2017-10-25 11:55:06 +02:00
return res.json(user.toFormattedJSON())
}
2018-01-08 12:53:09 +01:00
async function getUserVideoQuotaUsed (req: express.Request, res: express.Response, next: express.NextFunction) {
// We did not load channels in res.locals.user
const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
const videoQuotaUsed = await UserModel.getOriginalVideoFileTotalFromUser(user)
return res.json({
videoQuotaUsed
})
}
2017-09-05 21:29:39 +02:00
function getUser (req: express.Request, res: express.Response, next: express.NextFunction) {
2018-01-08 12:53:09 +01:00
return res.json((res.locals.user as UserModel).toFormattedJSON())
2017-09-05 21:29:39 +02:00
}
2017-10-25 11:55:06 +02:00
async function getUserVideoRating (req: express.Request, res: express.Response, next: express.NextFunction) {
const videoId = +req.params.videoId
2017-11-10 17:27:49 +01:00
const accountId = +res.locals.oauth.token.User.Account.id
2017-03-08 21:35:43 +01:00
2017-12-12 17:53:50 +01:00
const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
2017-10-26 08:51:11 +02:00
const rating = ratingObj ? ratingObj.type : 'none'
const json: FormattedUserVideoRate = {
videoId,
rating
}
res.json(json)
2017-03-08 21:35:43 +01:00
}
2017-10-25 11:55:06 +02:00
async function listUsers (req: express.Request, res: express.Response, next: express.NextFunction) {
2017-12-12 17:53:50 +01:00
const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort)
2017-10-25 11:55:06 +02:00
return res.json(getFormattedObjects(resultList.data, resultList.total))
}
2017-10-25 11:55:06 +02:00
async function removeUser (req: express.Request, res: express.Response, next: express.NextFunction) {
2017-12-12 17:53:50 +01:00
const user = await UserModel.loadById(req.params.id)
2017-10-25 11:55:06 +02:00
await user.destroy()
return res.sendStatus(204)
}
2017-10-25 11:55:06 +02:00
async function updateMe (req: express.Request, res: express.Response, next: express.NextFunction) {
2017-09-05 21:29:39 +02:00
const body: UserUpdateMe = req.body
2017-10-25 11:55:06 +02:00
const user = res.locals.oauth.token.user
2017-04-03 21:24:36 +02:00
2017-10-25 11:55:06 +02:00
if (body.password !== undefined) user.password = body.password
if (body.email !== undefined) user.email = body.email
if (body.displayNSFW !== undefined) user.displayNSFW = body.displayNSFW
if (body.autoPlayVideo !== undefined) user.autoPlayVideo = body.autoPlayVideo
2017-10-25 11:55:06 +02:00
await user.save()
2018-01-03 16:38:50 +01:00
await sendUpdateUser(user, undefined)
2017-10-25 11:55:06 +02:00
2017-10-25 16:52:01 +02:00
return res.sendStatus(204)
}
2017-12-29 19:10:13 +01:00
async function updateMyAvatar (req: express.Request, res: express.Response, next: express.NextFunction) {
const avatarPhysicalFile = req.files['avatarfile'][0]
2018-01-03 16:38:50 +01:00
const user = res.locals.oauth.token.user
const actor = user.Account.Actor
2017-12-29 19:10:13 +01:00
const avatarDir = CONFIG.STORAGE.AVATARS_DIR
const source = join(avatarDir, avatarPhysicalFile.filename)
const extension = extname(avatarPhysicalFile.filename)
const avatarName = uuidv4() + extension
const destination = join(avatarDir, avatarName)
2018-01-03 11:36:03 +01:00
await sharp(source)
.resize(AVATARS_SIZE.width, AVATARS_SIZE.height)
.toFile(destination)
await unlinkPromise(source)
2017-12-29 19:10:13 +01:00
2018-01-04 14:04:02 +01:00
const avatar = await sequelizeTypescript.transaction(async t => {
2018-01-04 14:53:25 +01:00
const updatedActor = await updateActorAvatarInstance(actor, avatarName, t)
await updatedActor.save({ transaction: t })
2017-12-29 19:10:13 +01:00
2018-01-04 14:04:02 +01:00
await sendUpdateUser(user, t)
2017-12-29 19:10:13 +01:00
2018-01-04 14:53:25 +01:00
return updatedActor.Avatar
2017-12-29 19:10:13 +01:00
})
return res
.json({
avatar: avatar.toFormattedJSON()
})
.end()
}
2017-10-25 11:55:06 +02:00
async function updateUser (req: express.Request, res: express.Response, next: express.NextFunction) {
2017-09-05 21:29:39 +02:00
const body: UserUpdate = req.body
2017-12-12 17:53:50 +01:00
const user = res.locals.user as UserModel
2017-09-05 21:29:39 +02:00
if (body.email !== undefined) user.email = body.email
if (body.videoQuota !== undefined) user.videoQuota = body.videoQuota
if (body.role !== undefined) user.role = body.role
2017-09-05 21:29:39 +02:00
2017-10-25 11:55:06 +02:00
await user.save()
2018-01-03 16:38:50 +01:00
// Don't need to send this update to followers, these attributes are not propagated
2017-10-25 11:55:06 +02:00
return res.sendStatus(204)
2017-09-05 21:29:39 +02:00
}
2017-06-10 22:15:25 +02:00
function success (req: express.Request, res: express.Response, next: express.NextFunction) {
2016-03-21 11:56:33 +01:00
res.end()
}