2 import express from 'express'
3 import { auditLoggerFactory, getAuditIdFromRes, UserAuditView } from '@server/helpers/audit-logger'
4 import { Hooks } from '@server/lib/plugins/hooks'
5 import { ActorImageType, HttpStatusCode, UserUpdateMe, UserVideoQuota, UserVideoRate as FormattedUserVideoRate } from '@shared/models'
6 import { AttributesOnly } from '@shared/typescript-utils'
7 import { createReqFiles } from '../../../helpers/express-utils'
8 import { getFormattedObjects } from '../../../helpers/utils'
9 import { CONFIG } from '../../../initializers/config'
10 import { MIMETYPES } from '../../../initializers/constants'
11 import { sequelizeTypescript } from '../../../initializers/database'
12 import { sendUpdateActor } from '../../../lib/activitypub/send'
13 import { deleteLocalActorImageFile, updateLocalActorImageFile } from '../../../lib/local-actor'
14 import { getOriginalVideoFileTotalDailyFromUser, getOriginalVideoFileTotalFromUser, sendVerifyUserEmail } from '../../../lib/user'
17 asyncRetryTransactionMiddleware,
23 usersUpdateMeValidator,
24 usersVideoRatingValidator
25 } from '../../../middlewares'
26 import { deleteMeValidator, usersVideosValidator, videoImportsSortValidator, videosSortValidator } from '../../../middlewares/validators'
27 import { updateAvatarValidator } from '../../../middlewares/validators/actor-image'
28 import { AccountModel } from '../../../models/account/account'
29 import { AccountVideoRateModel } from '../../../models/account/account-video-rate'
30 import { UserModel } from '../../../models/user/user'
31 import { VideoModel } from '../../../models/video/video'
32 import { VideoImportModel } from '../../../models/video/video-import'
33 import { pick } from '@shared/core-utils'
35 const auditLogger = auditLoggerFactory('users')
37 const reqAvatarFile = createReqFiles([ 'avatarfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT, { avatarfile: CONFIG.STORAGE.TMP_DIR })
39 const meRouter = express.Router()
43 asyncMiddleware(getUserInformation)
45 meRouter.delete('/me',
48 asyncMiddleware(deleteMe)
51 meRouter.get('/me/video-quota-used',
53 asyncMiddleware(getUserVideoQuotaUsed)
56 meRouter.get('/me/videos/imports',
59 videoImportsSortValidator,
62 asyncMiddleware(getUserVideoImports)
65 meRouter.get('/me/videos',
71 asyncMiddleware(usersVideosValidator),
72 asyncMiddleware(getUserVideos)
75 meRouter.get('/me/videos/:videoId/rating',
77 asyncMiddleware(usersVideoRatingValidator),
78 asyncMiddleware(getUserVideoRating)
83 asyncMiddleware(usersUpdateMeValidator),
84 asyncRetryTransactionMiddleware(updateMe)
87 meRouter.post('/me/avatar/pick',
90 updateAvatarValidator,
91 asyncRetryTransactionMiddleware(updateMyAvatar)
94 meRouter.delete('/me/avatar',
96 asyncRetryTransactionMiddleware(deleteMyAvatar)
99 // ---------------------------------------------------------------------------
105 // ---------------------------------------------------------------------------
107 async function getUserVideos (req: express.Request, res: express.Response) {
108 const user = res.locals.oauth.token.User
110 const apiOptions = await Hooks.wrapObject({
111 accountId: user.Account.id,
112 start: req.query.start,
113 count: req.query.count,
114 sort: req.query.sort,
115 search: req.query.search,
116 channelId: res.locals.videoChannel?.id,
117 isLive: req.query.isLive
118 }, 'filter:api.user.me.videos.list.params')
120 const resultList = await Hooks.wrapPromiseFun(
121 VideoModel.listUserVideosForApi,
123 'filter:api.user.me.videos.list.result'
126 const additionalAttributes = {
127 waitTranscoding: true,
129 scheduledUpdate: true,
132 return res.json(getFormattedObjects(resultList.data, resultList.total, { additionalAttributes }))
135 async function getUserVideoImports (req: express.Request, res: express.Response) {
136 const user = res.locals.oauth.token.User
137 const resultList = await VideoImportModel.listUserVideoImportsForApi({
140 ...pick(req.query, [ 'targetUrl', 'start', 'count', 'sort' ])
143 return res.json(getFormattedObjects(resultList.data, resultList.total))
146 async function getUserInformation (req: express.Request, res: express.Response) {
147 // We did not load channels in res.locals.user
148 const user = await UserModel.loadForMeAPI(res.locals.oauth.token.user.id)
150 return res.json(user.toMeFormattedJSON())
153 async function getUserVideoQuotaUsed (req: express.Request, res: express.Response) {
154 const user = res.locals.oauth.token.user
155 const videoQuotaUsed = await getOriginalVideoFileTotalFromUser(user)
156 const videoQuotaUsedDaily = await getOriginalVideoFileTotalDailyFromUser(user)
158 const data: UserVideoQuota = {
162 return res.json(data)
165 async function getUserVideoRating (req: express.Request, res: express.Response) {
166 const videoId = res.locals.videoId.id
167 const accountId = +res.locals.oauth.token.User.Account.id
169 const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
170 const rating = ratingObj ? ratingObj.type : 'none'
172 const json: FormattedUserVideoRate = {
176 return res.json(json)
179 async function deleteMe (req: express.Request, res: express.Response) {
180 const user = await UserModel.loadByIdWithChannels(res.locals.oauth.token.User.id)
182 auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
186 return res.status(HttpStatusCode.NO_CONTENT_204).end()
189 async function updateMe (req: express.Request, res: express.Response) {
190 const body: UserUpdateMe = req.body
191 let sendVerificationEmail = false
193 const user = res.locals.oauth.token.user
195 const keysToUpdate: (keyof UserUpdateMe & keyof AttributesOnly<UserModel>)[] = [
201 'autoPlayNextVideoPlaylist',
202 'videosHistoryEnabled',
205 'noInstanceConfigWarningModal',
206 'noAccountSetupWarningModal',
210 for (const key of keysToUpdate) {
211 if (body[key] !== undefined) user.set(key, body[key])
214 if (body.p2pEnabled !== undefined) {
215 user.set('p2pEnabled', body.p2pEnabled)
216 } else if (body.webTorrentEnabled !== undefined) { // FIXME: deprecated in 4.1
217 user.set('p2pEnabled', body.webTorrentEnabled)
220 if (body.email !== undefined) {
221 if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
222 user.pendingEmail = body.email
223 sendVerificationEmail = true
225 user.email = body.email
229 await sequelizeTypescript.transaction(async t => {
230 await user.save({ transaction: t })
232 if (body.displayName === undefined && body.description === undefined) return
234 const userAccount = await AccountModel.load(user.Account.id, t)
236 if (body.displayName !== undefined) userAccount.name = body.displayName
237 if (body.description !== undefined) userAccount.description = body.description
238 await userAccount.save({ transaction: t })
240 await sendUpdateActor(userAccount, t)
243 if (sendVerificationEmail === true) {
244 await sendVerifyUserEmail(user, true)
247 return res.status(HttpStatusCode.NO_CONTENT_204).end()
250 async function updateMyAvatar (req: express.Request, res: express.Response) {
251 const avatarPhysicalFile = req.files['avatarfile'][0]
252 const user = res.locals.oauth.token.user
254 const userAccount = await AccountModel.load(user.Account.id)
256 const avatar = await updateLocalActorImageFile(userAccount, avatarPhysicalFile, ActorImageType.AVATAR)
258 return res.json({ avatar: avatar.toFormattedJSON() })
261 async function deleteMyAvatar (req: express.Request, res: express.Response) {
262 const user = res.locals.oauth.token.user
264 const userAccount = await AccountModel.load(user.Account.id)
265 await deleteLocalActorImageFile(userAccount, ActorImageType.AVATAR)
267 return res.status(HttpStatusCode.NO_CONTENT_204).end()