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 userSubscriptionGetValidator,
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/videos',
106 setDefaultPagination,
107 commonVideosFiltersValidator,
108 asyncMiddleware(getUserSubscriptionVideos)
111 meRouter.get('/me/subscriptions',
114 userSubscriptionsSortValidator,
116 setDefaultPagination,
117 asyncMiddleware(getUserSubscriptions)
120 meRouter.post('/me/subscriptions',
122 userSubscriptionAddValidator,
123 asyncMiddleware(addUserSubscription)
126 meRouter.get('/me/subscriptions/:uri',
128 userSubscriptionGetValidator,
132 meRouter.delete('/me/subscriptions/:uri',
134 userSubscriptionGetValidator,
135 asyncMiddleware(deleteUserSubscription)
138 // ---------------------------------------------------------------------------
144 // ---------------------------------------------------------------------------
146 async function addUserSubscription (req: express.Request, res: express.Response) {
147 const user = res.locals.oauth.token.User as UserModel
148 const [ name, host ] = req.body.uri.split('@')
153 followerActorId: user.Account.Actor.id
156 JobQueue.Instance.createJob({ type: 'activitypub-follow', payload })
157 .catch(err => logger.error('Cannot create follow job for subscription %s.', req.body.uri, err))
159 return res.status(204).end()
162 function getUserSubscription (req: express.Request, res: express.Response) {
163 const subscription: ActorFollowModel = res.locals.subscription
165 return res.json(subscription.ActorFollowing.VideoChannel.toFormattedJSON())
168 async function deleteUserSubscription (req: express.Request, res: express.Response) {
169 const subscription: ActorFollowModel = res.locals.subscription
171 await sequelizeTypescript.transaction(async t => {
172 return subscription.destroy({ transaction: t })
175 return res.type('json').status(204).end()
178 async function getUserSubscriptions (req: express.Request, res: express.Response) {
179 const user = res.locals.oauth.token.User as UserModel
180 const actorId = user.Account.Actor.id
182 const resultList = await ActorFollowModel.listSubscriptionsForApi(actorId, req.query.start, req.query.count, req.query.sort)
184 return res.json(getFormattedObjects(resultList.data, resultList.total))
187 async function getUserSubscriptionVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
188 const user = res.locals.oauth.token.User as UserModel
189 const resultList = await VideoModel.listForApi({
190 start: req.query.start,
191 count: req.query.count,
192 sort: req.query.sort,
193 includeLocalVideos: false,
194 categoryOneOf: req.query.categoryOneOf,
195 licenceOneOf: req.query.licenceOneOf,
196 languageOneOf: req.query.languageOneOf,
197 tagsOneOf: req.query.tagsOneOf,
198 tagsAllOf: req.query.tagsAllOf,
199 nsfw: buildNSFWFilter(res, req.query.nsfw),
200 filter: req.query.filter as VideoFilter,
202 actorId: user.Account.Actor.id
205 return res.json(getFormattedObjects(resultList.data, resultList.total))
208 async function getUserVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
209 const user = res.locals.oauth.token.User as UserModel
210 const resultList = await VideoModel.listUserVideosForApi(
212 req.query.start as number,
213 req.query.count as number,
214 req.query.sort as VideoSortField
217 const additionalAttributes = {
218 waitTranscoding: true,
220 scheduledUpdate: true,
223 return res.json(getFormattedObjects(resultList.data, resultList.total, { additionalAttributes }))
226 async function getUserVideoImports (req: express.Request, res: express.Response, next: express.NextFunction) {
227 const user = res.locals.oauth.token.User as UserModel
228 const resultList = await VideoImportModel.listUserVideoImportsForApi(
230 req.query.start as number,
231 req.query.count as number,
235 return res.json(getFormattedObjects(resultList.data, resultList.total))
238 async function getUserInformation (req: express.Request, res: express.Response, next: express.NextFunction) {
239 // We did not load channels in res.locals.user
240 const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
242 return res.json(user.toFormattedJSON())
245 async function getUserVideoQuotaUsed (req: express.Request, res: express.Response, next: express.NextFunction) {
246 // We did not load channels in res.locals.user
247 const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
248 const videoQuotaUsed = await UserModel.getOriginalVideoFileTotalFromUser(user)
250 const data: UserVideoQuota = {
253 return res.json(data)
256 async function getUserVideoRating (req: express.Request, res: express.Response, next: express.NextFunction) {
257 const videoId = +req.params.videoId
258 const accountId = +res.locals.oauth.token.User.Account.id
260 const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
261 const rating = ratingObj ? ratingObj.type : 'none'
263 const json: FormattedUserVideoRate = {
267 return res.json(json)
270 async function deleteMe (req: express.Request, res: express.Response) {
271 const user: UserModel = res.locals.oauth.token.User
275 auditLogger.delete(res.locals.oauth.token.User.Account.Actor.getIdentifier(), new UserAuditView(user.toFormattedJSON()))
277 return res.sendStatus(204)
280 async function updateMe (req: express.Request, res: express.Response, next: express.NextFunction) {
281 const body: UserUpdateMe = req.body
283 const user: UserModel = res.locals.oauth.token.user
284 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
286 if (body.password !== undefined) user.password = body.password
287 if (body.email !== undefined) user.email = body.email
288 if (body.nsfwPolicy !== undefined) user.nsfwPolicy = body.nsfwPolicy
289 if (body.autoPlayVideo !== undefined) user.autoPlayVideo = body.autoPlayVideo
291 await sequelizeTypescript.transaction(async t => {
292 await user.save({ transaction: t })
294 if (body.displayName !== undefined) user.Account.name = body.displayName
295 if (body.description !== undefined) user.Account.description = body.description
296 await user.Account.save({ transaction: t })
298 await sendUpdateActor(user.Account, t)
301 res.locals.oauth.token.User.Account.Actor.getIdentifier(),
302 new UserAuditView(user.toFormattedJSON()),
307 return res.sendStatus(204)
310 async function updateMyAvatar (req: express.Request, res: express.Response, next: express.NextFunction) {
311 const avatarPhysicalFile = req.files[ 'avatarfile' ][ 0 ]
312 const user: UserModel = res.locals.oauth.token.user
313 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
314 const account = user.Account
316 const avatar = await updateActorAvatarFile(avatarPhysicalFile, account.Actor, account)
319 res.locals.oauth.token.User.Account.Actor.getIdentifier(),
320 new UserAuditView(user.toFormattedJSON()),
324 return res.json({ avatar: avatar.toFormattedJSON() })