PeerTube/server/controllers/api/users/me.ts

285 lines
8.5 KiB
TypeScript
Raw Normal View History

2018-08-16 11:26:22 +02:00
import 'multer'
2021-08-27 14:32:44 +02:00
import express from 'express'
import { auditLoggerFactory, getAuditIdFromRes, UserAuditView } from '@server/helpers/audit-logger'
import { getBiggestActorImage } from '@server/lib/actor-image'
2021-01-20 15:28:34 +01:00
import { Hooks } from '@server/lib/plugins/hooks'
import { pick } from '@shared/core-utils'
2021-12-24 10:14:47 +01:00
import { ActorImageType, HttpStatusCode, UserUpdateMe, UserVideoQuota, UserVideoRate as FormattedUserVideoRate } from '@shared/models'
import { AttributesOnly } from '@shared/typescript-utils'
2020-06-23 14:10:17 +02:00
import { createReqFiles } from '../../../helpers/express-utils'
2018-08-16 11:26:22 +02:00
import { getFormattedObjects } from '../../../helpers/utils'
2020-06-23 14:10:17 +02:00
import { CONFIG } from '../../../initializers/config'
import { MIMETYPES } from '../../../initializers/constants'
2020-06-23 14:10:17 +02:00
import { sequelizeTypescript } from '../../../initializers/database'
2018-08-16 11:26:22 +02:00
import { sendUpdateActor } from '../../../lib/activitypub/send'
import { deleteLocalActorImageFile, updateLocalActorImageFiles } from '../../../lib/local-actor'
2020-09-25 16:19:35 +02:00
import { getOriginalVideoFileTotalDailyFromUser, getOriginalVideoFileTotalFromUser, sendVerifyUserEmail } from '../../../lib/user'
2018-08-16 11:26:22 +02:00
import {
2018-09-19 17:02:16 +02:00
asyncMiddleware,
asyncRetryTransactionMiddleware,
2018-08-16 11:26:22 +02:00
authenticate,
paginationValidator,
setDefaultPagination,
setDefaultSort,
setDefaultVideosSort,
2018-08-16 11:26:22 +02:00
usersUpdateMeValidator,
usersVideoRatingValidator
} from '../../../middlewares'
import {
deleteMeValidator,
getMyVideoImportsValidator,
usersVideosValidator,
videoImportsSortValidator,
videosSortValidator
} from '../../../middlewares/validators'
2021-04-07 10:36:13 +02:00
import { updateAvatarValidator } from '../../../middlewares/validators/actor-image'
2020-06-23 14:10:17 +02:00
import { AccountModel } from '../../../models/account/account'
2018-08-16 11:26:22 +02:00
import { AccountVideoRateModel } from '../../../models/account/account-video-rate'
2021-05-11 11:15:29 +02:00
import { UserModel } from '../../../models/user/user'
2018-08-16 11:26:22 +02:00
import { VideoModel } from '../../../models/video/video'
import { VideoImportModel } from '../../../models/video/video-import'
const auditLogger = auditLoggerFactory('users')
2018-08-16 11:26:22 +02:00
const reqAvatarFile = createReqFiles([ 'avatarfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT)
2018-08-16 11:26:22 +02:00
const meRouter = express.Router()
meRouter.get('/me',
authenticate,
asyncMiddleware(getUserInformation)
)
meRouter.delete('/me',
authenticate,
2020-01-31 16:56:52 +01:00
deleteMeValidator,
2018-08-16 11:26:22 +02:00
asyncMiddleware(deleteMe)
)
meRouter.get('/me/video-quota-used',
authenticate,
asyncMiddleware(getUserVideoQuotaUsed)
)
meRouter.get('/me/videos/imports',
authenticate,
paginationValidator,
videoImportsSortValidator,
setDefaultSort,
setDefaultPagination,
getMyVideoImportsValidator,
2018-08-16 11:26:22 +02:00
asyncMiddleware(getUserVideoImports)
)
meRouter.get('/me/videos',
authenticate,
paginationValidator,
videosSortValidator,
setDefaultVideosSort,
2018-08-16 11:26:22 +02:00
setDefaultPagination,
asyncMiddleware(usersVideosValidator),
2018-08-16 11:26:22 +02:00
asyncMiddleware(getUserVideos)
)
meRouter.get('/me/videos/:videoId/rating',
authenticate,
asyncMiddleware(usersVideoRatingValidator),
asyncMiddleware(getUserVideoRating)
)
meRouter.put('/me',
authenticate,
2018-09-26 16:28:15 +02:00
asyncMiddleware(usersUpdateMeValidator),
asyncRetryTransactionMiddleware(updateMe)
2018-08-16 11:26:22 +02:00
)
meRouter.post('/me/avatar/pick',
authenticate,
reqAvatarFile,
updateAvatarValidator,
asyncRetryTransactionMiddleware(updateMyAvatar)
2018-08-16 11:26:22 +02:00
)
meRouter.delete('/me/avatar',
authenticate,
asyncRetryTransactionMiddleware(deleteMyAvatar)
)
2018-08-16 11:26:22 +02:00
// ---------------------------------------------------------------------------
export {
meRouter
}
// ---------------------------------------------------------------------------
2019-03-19 10:35:15 +01:00
async function getUserVideos (req: express.Request, res: express.Response) {
const user = res.locals.oauth.token.User
2021-01-20 15:28:34 +01:00
const apiOptions = await Hooks.wrapObject({
accountId: user.Account.id,
start: req.query.start,
count: req.query.count,
sort: req.query.sort,
search: req.query.search,
channelId: res.locals.videoChannel?.id,
isLive: req.query.isLive
2021-01-20 15:28:34 +01:00
}, 'filter:api.user.me.videos.list.params')
const resultList = await Hooks.wrapPromiseFun(
VideoModel.listUserVideosForApi,
apiOptions,
'filter:api.user.me.videos.list.result'
2018-08-16 11:26:22 +02:00
)
const additionalAttributes = {
waitTranscoding: true,
state: true,
scheduledUpdate: true,
blacklistInfo: true
}
return res.json(getFormattedObjects(resultList.data, resultList.total, { additionalAttributes }))
}
2019-03-19 10:35:15 +01:00
async function getUserVideoImports (req: express.Request, res: express.Response) {
const user = res.locals.oauth.token.User
const resultList = await VideoImportModel.listUserVideoImportsForApi({
userId: user.id,
...pick(req.query, [ 'targetUrl', 'start', 'count', 'sort', 'search', 'videoChannelSyncId' ])
})
2018-08-16 11:26:22 +02:00
return res.json(getFormattedObjects(resultList.data, resultList.total))
}
2019-03-19 10:35:15 +01:00
async function getUserInformation (req: express.Request, res: express.Response) {
2018-08-16 11:26:22 +02:00
// We did not load channels in res.locals.user
const user = await UserModel.loadForMeAPI(res.locals.oauth.token.user.id)
2018-08-16 11:26:22 +02:00
return res.json(user.toMeFormattedJSON())
2018-08-16 11:26:22 +02:00
}
2019-03-19 10:35:15 +01:00
async function getUserVideoQuotaUsed (req: express.Request, res: express.Response) {
const user = res.locals.oauth.token.user
2020-09-25 16:19:35 +02:00
const videoQuotaUsed = await getOriginalVideoFileTotalFromUser(user)
const videoQuotaUsedDaily = await getOriginalVideoFileTotalDailyFromUser(user)
2018-08-16 11:26:22 +02:00
const data: UserVideoQuota = {
videoQuotaUsed,
videoQuotaUsedDaily
2018-08-16 11:26:22 +02:00
}
return res.json(data)
}
2019-03-19 10:35:15 +01:00
async function getUserVideoRating (req: express.Request, res: express.Response) {
2019-08-15 11:53:26 +02:00
const videoId = res.locals.videoId.id
2018-08-16 11:26:22 +02:00
const accountId = +res.locals.oauth.token.User.Account.id
const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
const rating = ratingObj ? ratingObj.type : 'none'
const json: FormattedUserVideoRate = {
videoId,
rating
}
return res.json(json)
2018-08-16 11:26:22 +02:00
}
async function deleteMe (req: express.Request, res: express.Response) {
const user = await UserModel.loadByIdWithChannels(res.locals.oauth.token.User.id)
auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
2018-08-16 11:26:22 +02:00
await user.destroy()
return res.status(HttpStatusCode.NO_CONTENT_204).end()
2018-08-16 11:26:22 +02:00
}
async function updateMe (req: express.Request, res: express.Response) {
2018-08-16 11:26:22 +02:00
const body: UserUpdateMe = req.body
2019-06-11 11:54:33 +02:00
let sendVerificationEmail = false
2018-08-16 11:26:22 +02:00
2019-03-19 10:35:15 +01:00
const user = res.locals.oauth.token.user
2018-08-16 11:26:22 +02:00
2021-05-12 14:51:17 +02:00
const keysToUpdate: (keyof UserUpdateMe & keyof AttributesOnly<UserModel>)[] = [
'password',
'nsfwPolicy',
'p2pEnabled',
2021-05-12 14:51:17 +02:00
'autoPlayVideo',
'autoPlayNextVideo',
'autoPlayNextVideoPlaylist',
'videosHistoryEnabled',
'videoLanguages',
'theme',
'noInstanceConfigWarningModal',
'noAccountSetupWarningModal',
2021-05-12 14:51:17 +02:00
'noWelcomeModal'
]
for (const key of keysToUpdate) {
if (body[key] !== undefined) user.set(key, body[key])
}
2018-08-16 11:26:22 +02:00
if (body.p2pEnabled !== undefined) {
user.set('p2pEnabled', body.p2pEnabled)
} else if (body.webTorrentEnabled !== undefined) { // FIXME: deprecated in 4.1
user.set('p2pEnabled', body.webTorrentEnabled)
}
2019-06-11 11:54:33 +02:00
if (body.email !== undefined) {
if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
user.pendingEmail = body.email
sendVerificationEmail = true
} else {
user.email = body.email
}
}
2019-08-28 15:46:56 +02:00
await sequelizeTypescript.transaction(async t => {
await user.save({ transaction: t })
2021-05-12 14:51:17 +02:00
if (body.displayName === undefined && body.description === undefined) return
2018-08-16 11:26:22 +02:00
2021-05-12 14:51:17 +02:00
const userAccount = await AccountModel.load(user.Account.id, t)
2018-08-16 11:26:22 +02:00
2021-05-12 14:51:17 +02:00
if (body.displayName !== undefined) userAccount.name = body.displayName
if (body.description !== undefined) userAccount.description = body.description
await userAccount.save({ transaction: t })
await sendUpdateActor(userAccount, t)
2019-08-28 15:46:56 +02:00
})
2018-08-16 11:26:22 +02:00
2019-06-11 11:54:33 +02:00
if (sendVerificationEmail === true) {
await sendVerifyUserEmail(user, true)
}
return res.status(HttpStatusCode.NO_CONTENT_204).end()
2018-08-16 11:26:22 +02:00
}
2018-12-04 16:02:49 +01:00
async function updateMyAvatar (req: express.Request, res: express.Response) {
2020-01-31 16:56:52 +01:00
const avatarPhysicalFile = req.files['avatarfile'][0]
2019-03-19 10:35:15 +01:00
const user = res.locals.oauth.token.user
2018-08-16 11:26:22 +02:00
const userAccount = await AccountModel.load(user.Account.id)
2018-08-16 11:26:22 +02:00
const avatars = await updateLocalActorImageFiles(
userAccount,
avatarPhysicalFile,
ActorImageType.AVATAR
)
return res.json({
// TODO: remove, deprecated in 4.2
avatar: getBiggestActorImage(avatars).toFormattedJSON(),
avatars: avatars.map(avatar => avatar.toFormattedJSON())
})
2018-08-16 11:26:22 +02:00
}
async function deleteMyAvatar (req: express.Request, res: express.Response) {
const user = res.locals.oauth.token.user
const userAccount = await AccountModel.load(user.Account.id)
2021-04-06 17:01:35 +02:00
await deleteLocalActorImageFile(userAccount, ActorImageType.AVATAR)
return res.json({ avatars: [] })
}