2 import express from 'express'
3 import { auditLoggerFactory, getAuditIdFromRes, UserAuditView } from '@server/helpers/audit-logger'
4 import { getBiggestActorImage } from '@server/lib/actor-image'
5 import { Hooks } from '@server/lib/plugins/hooks'
6 import { pick } from '@shared/core-utils'
7 import { ActorImageType, HttpStatusCode, UserUpdateMe, UserVideoQuota, UserVideoRate as FormattedUserVideoRate } from '@shared/models'
8 import { AttributesOnly } from '@shared/typescript-utils'
9 import { createReqFiles } from '../../../helpers/express-utils'
10 import { getFormattedObjects } from '../../../helpers/utils'
11 import { CONFIG } from '../../../initializers/config'
12 import { MIMETYPES } from '../../../initializers/constants'
13 import { sequelizeTypescript } from '../../../initializers/database'
14 import { sendUpdateActor } from '../../../lib/activitypub/send'
15 import { deleteLocalActorImageFile, updateLocalActorImageFiles } from '../../../lib/local-actor'
16 import { getOriginalVideoFileTotalDailyFromUser, getOriginalVideoFileTotalFromUser, sendVerifyUserEmail } from '../../../lib/user'
19 asyncRetryTransactionMiddleware,
25 usersUpdateMeValidator,
26 usersVideoRatingValidator
27 } from '../../../middlewares'
30 getMyVideoImportsValidator,
32 videoImportsSortValidator,
34 } from '../../../middlewares/validators'
35 import { updateAvatarValidator } from '../../../middlewares/validators/actor-image'
36 import { AccountModel } from '../../../models/account/account'
37 import { AccountVideoRateModel } from '../../../models/account/account-video-rate'
38 import { UserModel } from '../../../models/user/user'
39 import { VideoModel } from '../../../models/video/video'
40 import { VideoImportModel } from '../../../models/video/video-import'
42 const auditLogger = auditLoggerFactory('users')
44 const reqAvatarFile = createReqFiles([ 'avatarfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT)
46 const meRouter = express.Router()
50 asyncMiddleware(getUserInformation)
52 meRouter.delete('/me',
55 asyncMiddleware(deleteMe)
58 meRouter.get('/me/video-quota-used',
60 asyncMiddleware(getUserVideoQuotaUsed)
63 meRouter.get('/me/videos/imports',
66 videoImportsSortValidator,
69 getMyVideoImportsValidator,
70 asyncMiddleware(getUserVideoImports)
73 meRouter.get('/me/videos',
79 asyncMiddleware(usersVideosValidator),
80 asyncMiddleware(getUserVideos)
83 meRouter.get('/me/videos/:videoId/rating',
85 asyncMiddleware(usersVideoRatingValidator),
86 asyncMiddleware(getUserVideoRating)
91 asyncMiddleware(usersUpdateMeValidator),
92 asyncRetryTransactionMiddleware(updateMe)
95 meRouter.post('/me/avatar/pick',
98 updateAvatarValidator,
99 asyncRetryTransactionMiddleware(updateMyAvatar)
102 meRouter.delete('/me/avatar',
104 asyncRetryTransactionMiddleware(deleteMyAvatar)
107 // ---------------------------------------------------------------------------
113 // ---------------------------------------------------------------------------
115 async function getUserVideos (req: express.Request, res: express.Response) {
116 const user = res.locals.oauth.token.User
118 const apiOptions = await Hooks.wrapObject({
119 accountId: user.Account.id,
120 start: req.query.start,
121 count: req.query.count,
122 sort: req.query.sort,
123 search: req.query.search,
124 channelId: res.locals.videoChannel?.id,
125 isLive: req.query.isLive
126 }, 'filter:api.user.me.videos.list.params')
128 const resultList = await Hooks.wrapPromiseFun(
129 VideoModel.listUserVideosForApi,
131 'filter:api.user.me.videos.list.result'
134 const additionalAttributes = {
135 waitTranscoding: true,
137 scheduledUpdate: true,
140 return res.json(getFormattedObjects(resultList.data, resultList.total, { additionalAttributes }))
143 async function getUserVideoImports (req: express.Request, res: express.Response) {
144 const user = res.locals.oauth.token.User
145 const resultList = await VideoImportModel.listUserVideoImportsForApi({
148 ...pick(req.query, [ 'targetUrl', 'start', 'count', 'sort', 'search', 'videoChannelSyncId' ])
151 return res.json(getFormattedObjects(resultList.data, resultList.total))
154 async function getUserInformation (req: express.Request, res: express.Response) {
155 // We did not load channels in res.locals.user
156 const user = await UserModel.loadForMeAPI(res.locals.oauth.token.user.id)
158 return res.json(user.toMeFormattedJSON())
161 async function getUserVideoQuotaUsed (req: express.Request, res: express.Response) {
162 const user = res.locals.oauth.token.user
163 const videoQuotaUsed = await getOriginalVideoFileTotalFromUser(user)
164 const videoQuotaUsedDaily = await getOriginalVideoFileTotalDailyFromUser(user)
166 const data: UserVideoQuota = {
170 return res.json(data)
173 async function getUserVideoRating (req: express.Request, res: express.Response) {
174 const videoId = res.locals.videoId.id
175 const accountId = +res.locals.oauth.token.User.Account.id
177 const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
178 const rating = ratingObj ? ratingObj.type : 'none'
180 const json: FormattedUserVideoRate = {
184 return res.json(json)
187 async function deleteMe (req: express.Request, res: express.Response) {
188 const user = await UserModel.loadByIdWithChannels(res.locals.oauth.token.User.id)
190 auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
194 return res.status(HttpStatusCode.NO_CONTENT_204).end()
197 async function updateMe (req: express.Request, res: express.Response) {
198 const body: UserUpdateMe = req.body
199 let sendVerificationEmail = false
201 const user = res.locals.oauth.token.user
203 const keysToUpdate: (keyof UserUpdateMe & keyof AttributesOnly<UserModel>)[] = [
209 'autoPlayNextVideoPlaylist',
210 'videosHistoryEnabled',
213 'noInstanceConfigWarningModal',
214 'noAccountSetupWarningModal',
218 for (const key of keysToUpdate) {
219 if (body[key] !== undefined) user.set(key, body[key])
222 if (body.p2pEnabled !== undefined) {
223 user.set('p2pEnabled', body.p2pEnabled)
224 } else if (body.webTorrentEnabled !== undefined) { // FIXME: deprecated in 4.1
225 user.set('p2pEnabled', body.webTorrentEnabled)
228 if (body.email !== undefined) {
229 if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
230 user.pendingEmail = body.email
231 sendVerificationEmail = true
233 user.email = body.email
237 await sequelizeTypescript.transaction(async t => {
238 await user.save({ transaction: t })
240 if (body.displayName === undefined && body.description === undefined) return
242 const userAccount = await AccountModel.load(user.Account.id, t)
244 if (body.displayName !== undefined) userAccount.name = body.displayName
245 if (body.description !== undefined) userAccount.description = body.description
246 await userAccount.save({ transaction: t })
248 await sendUpdateActor(userAccount, t)
251 if (sendVerificationEmail === true) {
252 await sendVerifyUserEmail(user, true)
255 return res.status(HttpStatusCode.NO_CONTENT_204).end()
258 async function updateMyAvatar (req: express.Request, res: express.Response) {
259 const avatarPhysicalFile = req.files['avatarfile'][0]
260 const user = res.locals.oauth.token.user
262 const userAccount = await AccountModel.load(user.Account.id)
264 const avatars = await updateLocalActorImageFiles(
267 ActorImageType.AVATAR
271 // TODO: remove, deprecated in 4.2
272 avatar: getBiggestActorImage(avatars).toFormattedJSON(),
273 avatars: avatars.map(avatar => avatar.toFormattedJSON())
277 async function deleteMyAvatar (req: express.Request, res: express.Response) {
278 const user = res.locals.oauth.token.user
280 const userAccount = await AccountModel.load(user.Account.id)
281 await deleteLocalActorImageFile(userAccount, ActorImageType.AVATAR)
283 return res.json({ avatars: [] })