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 { AttributesOnly } from '@shared/core-utils'
6 import { ActorImageType, UserUpdateMe, UserVideoRate as FormattedUserVideoRate } from '../../../../shared'
7 import { HttpStatusCode } from '../../../../shared/models/http/http-error-codes'
8 import { UserVideoQuota } from '../../../../shared/models/users/user-video-quota.model'
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, updateLocalActorImageFile } from '../../../lib/local-actor'
16 import { getOriginalVideoFileTotalDailyFromUser, getOriginalVideoFileTotalFromUser, sendVerifyUserEmail } from '../../../lib/user'
19 asyncRetryTransactionMiddleware,
25 usersUpdateMeValidator,
26 usersVideoRatingValidator
27 } from '../../../middlewares'
28 import { deleteMeValidator, usersVideosValidator, videoImportsSortValidator, videosSortValidator } from '../../../middlewares/validators'
29 import { updateAvatarValidator } from '../../../middlewares/validators/actor-image'
30 import { AccountModel } from '../../../models/account/account'
31 import { AccountVideoRateModel } from '../../../models/account/account-video-rate'
32 import { UserModel } from '../../../models/user/user'
33 import { VideoModel } from '../../../models/video/video'
34 import { VideoImportModel } from '../../../models/video/video-import'
36 const auditLogger = auditLoggerFactory('users')
38 const reqAvatarFile = createReqFiles([ 'avatarfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT, { avatarfile: CONFIG.STORAGE.TMP_DIR })
40 const meRouter = express.Router()
44 asyncMiddleware(getUserInformation)
46 meRouter.delete('/me',
49 asyncMiddleware(deleteMe)
52 meRouter.get('/me/video-quota-used',
54 asyncMiddleware(getUserVideoQuotaUsed)
57 meRouter.get('/me/videos/imports',
60 videoImportsSortValidator,
63 asyncMiddleware(getUserVideoImports)
66 meRouter.get('/me/videos',
72 asyncMiddleware(usersVideosValidator),
73 asyncMiddleware(getUserVideos)
76 meRouter.get('/me/videos/:videoId/rating',
78 asyncMiddleware(usersVideoRatingValidator),
79 asyncMiddleware(getUserVideoRating)
84 asyncMiddleware(usersUpdateMeValidator),
85 asyncRetryTransactionMiddleware(updateMe)
88 meRouter.post('/me/avatar/pick',
91 updateAvatarValidator,
92 asyncRetryTransactionMiddleware(updateMyAvatar)
95 meRouter.delete('/me/avatar',
97 asyncRetryTransactionMiddleware(deleteMyAvatar)
100 // ---------------------------------------------------------------------------
106 // ---------------------------------------------------------------------------
108 async function getUserVideos (req: express.Request, res: express.Response) {
109 const user = res.locals.oauth.token.User
111 const apiOptions = await Hooks.wrapObject({
112 accountId: user.Account.id,
113 start: req.query.start,
114 count: req.query.count,
115 sort: req.query.sort,
116 search: req.query.search,
117 channelId: res.locals.videoChannel?.id,
118 isLive: req.query.isLive
119 }, 'filter:api.user.me.videos.list.params')
121 const resultList = await Hooks.wrapPromiseFun(
122 VideoModel.listUserVideosForApi,
124 'filter:api.user.me.videos.list.result'
127 const additionalAttributes = {
128 waitTranscoding: true,
130 scheduledUpdate: true,
133 return res.json(getFormattedObjects(resultList.data, resultList.total, { additionalAttributes }))
136 async function getUserVideoImports (req: express.Request, res: express.Response) {
137 const user = res.locals.oauth.token.User
138 const resultList = await VideoImportModel.listUserVideoImportsForApi(
140 req.query.start as number,
141 req.query.count as number,
145 return res.json(getFormattedObjects(resultList.data, resultList.total))
148 async function getUserInformation (req: express.Request, res: express.Response) {
149 // We did not load channels in res.locals.user
150 const user = await UserModel.loadForMeAPI(res.locals.oauth.token.user.id)
152 return res.json(user.toMeFormattedJSON())
155 async function getUserVideoQuotaUsed (req: express.Request, res: express.Response) {
156 const user = res.locals.oauth.token.user
157 const videoQuotaUsed = await getOriginalVideoFileTotalFromUser(user)
158 const videoQuotaUsedDaily = await getOriginalVideoFileTotalDailyFromUser(user)
160 const data: UserVideoQuota = {
164 return res.json(data)
167 async function getUserVideoRating (req: express.Request, res: express.Response) {
168 const videoId = res.locals.videoId.id
169 const accountId = +res.locals.oauth.token.User.Account.id
171 const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
172 const rating = ratingObj ? ratingObj.type : 'none'
174 const json: FormattedUserVideoRate = {
178 return res.json(json)
181 async function deleteMe (req: express.Request, res: express.Response) {
182 const user = await UserModel.loadByIdWithChannels(res.locals.oauth.token.User.id)
184 auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
188 return res.status(HttpStatusCode.NO_CONTENT_204).end()
191 async function updateMe (req: express.Request, res: express.Response) {
192 const body: UserUpdateMe = req.body
193 let sendVerificationEmail = false
195 const user = res.locals.oauth.token.user
197 const keysToUpdate: (keyof UserUpdateMe & keyof AttributesOnly<UserModel>)[] = [
203 'autoPlayNextVideoPlaylist',
204 'videosHistoryEnabled',
207 'noInstanceConfigWarningModal',
208 'noAccountSetupWarningModal',
212 for (const key of keysToUpdate) {
213 if (body[key] !== undefined) user.set(key, body[key])
216 if (body.email !== undefined) {
217 if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
218 user.pendingEmail = body.email
219 sendVerificationEmail = true
221 user.email = body.email
225 await sequelizeTypescript.transaction(async t => {
226 await user.save({ transaction: t })
228 if (body.displayName === undefined && body.description === undefined) return
230 const userAccount = await AccountModel.load(user.Account.id, t)
232 if (body.displayName !== undefined) userAccount.name = body.displayName
233 if (body.description !== undefined) userAccount.description = body.description
234 await userAccount.save({ transaction: t })
236 await sendUpdateActor(userAccount, t)
239 if (sendVerificationEmail === true) {
240 await sendVerifyUserEmail(user, true)
243 return res.status(HttpStatusCode.NO_CONTENT_204).end()
246 async function updateMyAvatar (req: express.Request, res: express.Response) {
247 const avatarPhysicalFile = req.files['avatarfile'][0]
248 const user = res.locals.oauth.token.user
250 const userAccount = await AccountModel.load(user.Account.id)
252 const avatar = await updateLocalActorImageFile(userAccount, avatarPhysicalFile, ActorImageType.AVATAR)
254 return res.json({ avatar: avatar.toFormattedJSON() })
257 async function deleteMyAvatar (req: express.Request, res: express.Response) {
258 const user = res.locals.oauth.token.user
260 const userAccount = await AccountModel.load(user.Account.id)
261 await deleteLocalActorImageFile(userAccount, ActorImageType.AVATAR)
263 return res.status(HttpStatusCode.NO_CONTENT_204).end()