1 import * as express from 'express'
3 import { UserUpdateMe, UserVideoRate as FormattedUserVideoRate } from '../../../../shared'
4 import { getFormattedObjects } from '../../../helpers/utils'
5 import { CONFIG, IMAGE_MIMETYPE_EXT, sequelizeTypescript } from '../../../initializers'
6 import { sendUpdateActor } from '../../../lib/activitypub/send'
10 commonVideosFiltersValidator,
14 userSubscriptionAddValidator,
15 userSubscriptionRemoveValidator,
16 usersUpdateMeValidator,
17 usersVideoRatingValidator
18 } from '../../../middlewares'
21 userSubscriptionsSortValidator,
22 videoImportsSortValidator,
24 } from '../../../middlewares/validators'
25 import { AccountVideoRateModel } from '../../../models/account/account-video-rate'
26 import { UserModel } from '../../../models/account/user'
27 import { VideoModel } from '../../../models/video/video'
28 import { VideoSortField } from '../../../../client/src/app/shared/video/sort-field.type'
29 import { buildNSFWFilter, createReqFiles } from '../../../helpers/express-utils'
30 import { UserVideoQuota } from '../../../../shared/models/users/user-video-quota.model'
31 import { updateAvatarValidator } from '../../../middlewares/validators/avatar'
32 import { updateActorAvatarFile } from '../../../lib/avatar'
33 import { auditLoggerFactory, UserAuditView } from '../../../helpers/audit-logger'
34 import { VideoImportModel } from '../../../models/video/video-import'
35 import { VideoFilter } from '../../../../shared/models/videos/video-query.type'
36 import { ActorFollowModel } from '../../../models/activitypub/actor-follow'
37 import { JobQueue } from '../../../lib/job-queue'
38 import { logger } from '../../../helpers/logger'
40 const auditLogger = auditLoggerFactory('users-me')
42 const reqAvatarFile = createReqFiles([ 'avatarfile' ], IMAGE_MIMETYPE_EXT, { avatarfile: CONFIG.STORAGE.AVATARS_DIR })
44 const meRouter = express.Router()
48 asyncMiddleware(getUserInformation)
50 meRouter.delete('/me',
52 asyncMiddleware(deleteMeValidator),
53 asyncMiddleware(deleteMe)
56 meRouter.get('/me/video-quota-used',
58 asyncMiddleware(getUserVideoQuotaUsed)
61 meRouter.get('/me/videos/imports',
64 videoImportsSortValidator,
67 asyncMiddleware(getUserVideoImports)
70 meRouter.get('/me/videos',
76 asyncMiddleware(getUserVideos)
79 meRouter.get('/me/videos/:videoId/rating',
81 asyncMiddleware(usersVideoRatingValidator),
82 asyncMiddleware(getUserVideoRating)
87 usersUpdateMeValidator,
88 asyncMiddleware(updateMe)
91 meRouter.post('/me/avatar/pick',
94 updateAvatarValidator,
95 asyncMiddleware(updateMyAvatar)
98 // ##### Subscriptions part #####
100 meRouter.get('/me/subscriptions',
103 userSubscriptionsSortValidator,
105 setDefaultPagination,
106 asyncMiddleware(getUserSubscriptions)
109 meRouter.post('/me/subscriptions',
111 userSubscriptionAddValidator,
112 asyncMiddleware(addUserSubscription)
115 meRouter.delete('/me/subscriptions/:uri',
117 userSubscriptionRemoveValidator,
118 asyncMiddleware(deleteUserSubscription)
121 meRouter.get('/me/subscriptions/videos',
127 setDefaultPagination,
128 commonVideosFiltersValidator,
129 asyncMiddleware(getUserSubscriptionVideos)
132 // ---------------------------------------------------------------------------
138 // ---------------------------------------------------------------------------
140 async function addUserSubscription (req: express.Request, res: express.Response) {
141 const user = res.locals.oauth.token.User as UserModel
142 const [ name, host ] = req.body.uri.split('@')
147 followerActorId: user.Account.Actor.id
150 JobQueue.Instance.createJob({ type: 'activitypub-follow', payload })
151 .catch(err => logger.error('Cannot create follow job for subscription %s.', req.body.uri, err))
153 return res.status(204).end()
156 async function deleteUserSubscription (req: express.Request, res: express.Response) {
157 const subscription: ActorFollowModel = res.locals.subscription
159 await sequelizeTypescript.transaction(async t => {
160 return subscription.destroy({ transaction: t })
163 return res.type('json').status(204).end()
166 async function getUserSubscriptions (req: express.Request, res: express.Response) {
167 const user = res.locals.oauth.token.User as UserModel
168 const actorId = user.Account.Actor.id
170 const resultList = await ActorFollowModel.listSubscriptionsForApi(actorId, req.query.start, req.query.count, req.query.sort)
172 return res.json(getFormattedObjects(resultList.data, resultList.total))
175 async function getUserSubscriptionVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
176 const user = res.locals.oauth.token.User as UserModel
177 const resultList = await VideoModel.listForApi({
178 start: req.query.start,
179 count: req.query.count,
180 sort: req.query.sort,
181 includeLocalVideos: false,
182 categoryOneOf: req.query.categoryOneOf,
183 licenceOneOf: req.query.licenceOneOf,
184 languageOneOf: req.query.languageOneOf,
185 tagsOneOf: req.query.tagsOneOf,
186 tagsAllOf: req.query.tagsAllOf,
187 nsfw: buildNSFWFilter(res, req.query.nsfw),
188 filter: req.query.filter as VideoFilter,
190 actorId: user.Account.Actor.id
193 return res.json(getFormattedObjects(resultList.data, resultList.total))
196 async function getUserVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
197 const user = res.locals.oauth.token.User as UserModel
198 const resultList = await VideoModel.listUserVideosForApi(
200 req.query.start as number,
201 req.query.count as number,
202 req.query.sort as VideoSortField
205 const additionalAttributes = {
206 waitTranscoding: true,
208 scheduledUpdate: true,
211 return res.json(getFormattedObjects(resultList.data, resultList.total, { additionalAttributes }))
214 async function getUserVideoImports (req: express.Request, res: express.Response, next: express.NextFunction) {
215 const user = res.locals.oauth.token.User as UserModel
216 const resultList = await VideoImportModel.listUserVideoImportsForApi(
218 req.query.start as number,
219 req.query.count as number,
223 return res.json(getFormattedObjects(resultList.data, resultList.total))
226 async function getUserInformation (req: express.Request, res: express.Response, next: express.NextFunction) {
227 // We did not load channels in res.locals.user
228 const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
230 return res.json(user.toFormattedJSON())
233 async function getUserVideoQuotaUsed (req: express.Request, res: express.Response, next: express.NextFunction) {
234 // We did not load channels in res.locals.user
235 const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
236 const videoQuotaUsed = await UserModel.getOriginalVideoFileTotalFromUser(user)
238 const data: UserVideoQuota = {
241 return res.json(data)
244 async function getUserVideoRating (req: express.Request, res: express.Response, next: express.NextFunction) {
245 const videoId = +req.params.videoId
246 const accountId = +res.locals.oauth.token.User.Account.id
248 const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
249 const rating = ratingObj ? ratingObj.type : 'none'
251 const json: FormattedUserVideoRate = {
255 return res.json(json)
258 async function deleteMe (req: express.Request, res: express.Response) {
259 const user: UserModel = res.locals.oauth.token.User
263 auditLogger.delete(res.locals.oauth.token.User.Account.Actor.getIdentifier(), new UserAuditView(user.toFormattedJSON()))
265 return res.sendStatus(204)
268 async function updateMe (req: express.Request, res: express.Response, next: express.NextFunction) {
269 const body: UserUpdateMe = req.body
271 const user: UserModel = res.locals.oauth.token.user
272 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
274 if (body.password !== undefined) user.password = body.password
275 if (body.email !== undefined) user.email = body.email
276 if (body.nsfwPolicy !== undefined) user.nsfwPolicy = body.nsfwPolicy
277 if (body.autoPlayVideo !== undefined) user.autoPlayVideo = body.autoPlayVideo
279 await sequelizeTypescript.transaction(async t => {
280 await user.save({ transaction: t })
282 if (body.displayName !== undefined) user.Account.name = body.displayName
283 if (body.description !== undefined) user.Account.description = body.description
284 await user.Account.save({ transaction: t })
286 await sendUpdateActor(user.Account, t)
289 res.locals.oauth.token.User.Account.Actor.getIdentifier(),
290 new UserAuditView(user.toFormattedJSON()),
295 return res.sendStatus(204)
298 async function updateMyAvatar (req: express.Request, res: express.Response, next: express.NextFunction) {
299 const avatarPhysicalFile = req.files[ 'avatarfile' ][ 0 ]
300 const user: UserModel = res.locals.oauth.token.user
301 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
302 const account = user.Account
304 const avatar = await updateActorAvatarFile(avatarPhysicalFile, account.Actor, account)
307 res.locals.oauth.token.User.Account.Actor.getIdentifier(),
308 new UserAuditView(user.toFormattedJSON()),
312 return res.json({ avatar: avatar.toFormattedJSON() })