2 import * as 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, 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(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 isLive: req.query.isLive
117 }, 'filter:api.user.me.videos.list.params')
119 const resultList = await Hooks.wrapPromiseFun(
120 VideoModel.listUserVideosForApi,
122 'filter:api.user.me.videos.list.result'
125 const additionalAttributes = {
126 waitTranscoding: true,
128 scheduledUpdate: true,
131 return res.json(getFormattedObjects(resultList.data, resultList.total, { additionalAttributes }))
134 async function getUserVideoImports (req: express.Request, res: express.Response) {
135 const user = res.locals.oauth.token.User
136 const resultList = await VideoImportModel.listUserVideoImportsForApi(
138 req.query.start as number,
139 req.query.count as number,
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.email !== undefined) {
215 if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
216 user.pendingEmail = body.email
217 sendVerificationEmail = true
219 user.email = body.email
223 await sequelizeTypescript.transaction(async t => {
224 await user.save({ transaction: t })
226 if (body.displayName === undefined && body.description === undefined) return
228 const userAccount = await AccountModel.load(user.Account.id, t)
230 if (body.displayName !== undefined) userAccount.name = body.displayName
231 if (body.description !== undefined) userAccount.description = body.description
232 await userAccount.save({ transaction: t })
234 await sendUpdateActor(userAccount, t)
237 if (sendVerificationEmail === true) {
238 await sendVerifyUserEmail(user, true)
241 return res.status(HttpStatusCode.NO_CONTENT_204).end()
244 async function updateMyAvatar (req: express.Request, res: express.Response) {
245 const avatarPhysicalFile = req.files['avatarfile'][0]
246 const user = res.locals.oauth.token.user
248 const userAccount = await AccountModel.load(user.Account.id)
250 const avatar = await updateLocalActorImageFile(userAccount, avatarPhysicalFile, ActorImageType.AVATAR)
252 return res.json({ avatar: avatar.toFormattedJSON() })
255 async function deleteMyAvatar (req: express.Request, res: express.Response) {
256 const user = res.locals.oauth.token.user
258 const userAccount = await AccountModel.load(user.Account.id)
259 await deleteLocalActorImageFile(userAccount, ActorImageType.AVATAR)
261 return res.status(HttpStatusCode.NO_CONTENT_204).end()