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'
9 asyncRetryTransactionMiddleware,
11 commonVideosFiltersValidator,
15 userSubscriptionAddValidator,
16 userSubscriptionGetValidator,
17 usersUpdateMeValidator,
18 usersVideoRatingValidator
19 } from '../../../middlewares'
21 areSubscriptionsExistValidator,
23 userSubscriptionsSortValidator,
24 videoImportsSortValidator,
26 } from '../../../middlewares/validators'
27 import { AccountVideoRateModel } from '../../../models/account/account-video-rate'
28 import { UserModel } from '../../../models/account/user'
29 import { VideoModel } from '../../../models/video/video'
30 import { VideoSortField } from '../../../../client/src/app/shared/video/sort-field.type'
31 import { buildNSFWFilter, createReqFiles } from '../../../helpers/express-utils'
32 import { UserVideoQuota } from '../../../../shared/models/users/user-video-quota.model'
33 import { updateAvatarValidator } from '../../../middlewares/validators/avatar'
34 import { updateActorAvatarFile } from '../../../lib/avatar'
35 import { auditLoggerFactory, getAuditIdFromRes, UserAuditView } from '../../../helpers/audit-logger'
36 import { VideoImportModel } from '../../../models/video/video-import'
37 import { VideoFilter } from '../../../../shared/models/videos/video-query.type'
38 import { ActorFollowModel } from '../../../models/activitypub/actor-follow'
39 import { JobQueue } from '../../../lib/job-queue'
40 import { logger } from '../../../helpers/logger'
42 const auditLogger = auditLoggerFactory('users-me')
44 const reqAvatarFile = createReqFiles([ 'avatarfile' ], IMAGE_MIMETYPE_EXT, { avatarfile: CONFIG.STORAGE.AVATARS_DIR })
46 const meRouter = express.Router()
50 asyncMiddleware(getUserInformation)
52 meRouter.delete('/me',
54 asyncMiddleware(deleteMeValidator),
55 asyncMiddleware(deleteMe)
58 meRouter.get('/me/video-quota-used',
60 asyncMiddleware(getUserVideoQuotaUsed)
63 meRouter.get('/me/videos/imports',
66 videoImportsSortValidator,
69 asyncMiddleware(getUserVideoImports)
72 meRouter.get('/me/videos',
78 asyncMiddleware(getUserVideos)
81 meRouter.get('/me/videos/:videoId/rating',
83 asyncMiddleware(usersVideoRatingValidator),
84 asyncMiddleware(getUserVideoRating)
89 usersUpdateMeValidator,
90 asyncRetryTransactionMiddleware(updateMe)
93 meRouter.post('/me/avatar/pick',
96 updateAvatarValidator,
97 asyncRetryTransactionMiddleware(updateMyAvatar)
100 // ##### Subscriptions part #####
102 meRouter.get('/me/subscriptions/videos',
107 setDefaultPagination,
108 commonVideosFiltersValidator,
109 asyncMiddleware(getUserSubscriptionVideos)
112 meRouter.get('/me/subscriptions/exist',
114 areSubscriptionsExistValidator,
115 asyncMiddleware(areSubscriptionsExist)
118 meRouter.get('/me/subscriptions',
121 userSubscriptionsSortValidator,
123 setDefaultPagination,
124 asyncMiddleware(getUserSubscriptions)
127 meRouter.post('/me/subscriptions',
129 userSubscriptionAddValidator,
130 asyncMiddleware(addUserSubscription)
133 meRouter.get('/me/subscriptions/:uri',
135 userSubscriptionGetValidator,
139 meRouter.delete('/me/subscriptions/:uri',
141 userSubscriptionGetValidator,
142 asyncRetryTransactionMiddleware(deleteUserSubscription)
145 // ---------------------------------------------------------------------------
151 // ---------------------------------------------------------------------------
153 async function areSubscriptionsExist (req: express.Request, res: express.Response) {
154 const uris = req.query.uris as string[]
155 const user = res.locals.oauth.token.User as UserModel
157 const handles = uris.map(u => {
158 let [ name, host ] = u.split('@')
159 if (host === CONFIG.WEBSERVER.HOST) host = null
161 return { name, host, uri: u }
164 const results = await ActorFollowModel.listSubscribedIn(user.Account.Actor.id, handles)
166 const existObject: { [id: string ]: boolean } = {}
167 for (const handle of handles) {
168 const obj = results.find(r => {
169 const server = r.ActorFollowing.Server
171 return r.ActorFollowing.preferredUsername === handle.name &&
173 (!server && !handle.host) ||
174 (server.host === handle.host)
178 existObject[handle.uri] = obj !== undefined
181 return res.json(existObject)
184 async function addUserSubscription (req: express.Request, res: express.Response) {
185 const user = res.locals.oauth.token.User as UserModel
186 const [ name, host ] = req.body.uri.split('@')
191 followerActorId: user.Account.Actor.id
194 JobQueue.Instance.createJob({ type: 'activitypub-follow', payload })
195 .catch(err => logger.error('Cannot create follow job for subscription %s.', req.body.uri, err))
197 return res.status(204).end()
200 function getUserSubscription (req: express.Request, res: express.Response) {
201 const subscription: ActorFollowModel = res.locals.subscription
203 return res.json(subscription.ActorFollowing.VideoChannel.toFormattedJSON())
206 async function deleteUserSubscription (req: express.Request, res: express.Response) {
207 const subscription: ActorFollowModel = res.locals.subscription
209 await sequelizeTypescript.transaction(async t => {
210 return subscription.destroy({ transaction: t })
213 return res.type('json').status(204).end()
216 async function getUserSubscriptions (req: express.Request, res: express.Response) {
217 const user = res.locals.oauth.token.User as UserModel
218 const actorId = user.Account.Actor.id
220 const resultList = await ActorFollowModel.listSubscriptionsForApi(actorId, req.query.start, req.query.count, req.query.sort)
222 return res.json(getFormattedObjects(resultList.data, resultList.total))
225 async function getUserSubscriptionVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
226 const user = res.locals.oauth.token.User as UserModel
227 const resultList = await VideoModel.listForApi({
228 start: req.query.start,
229 count: req.query.count,
230 sort: req.query.sort,
231 includeLocalVideos: false,
232 categoryOneOf: req.query.categoryOneOf,
233 licenceOneOf: req.query.licenceOneOf,
234 languageOneOf: req.query.languageOneOf,
235 tagsOneOf: req.query.tagsOneOf,
236 tagsAllOf: req.query.tagsAllOf,
237 nsfw: buildNSFWFilter(res, req.query.nsfw),
238 filter: req.query.filter as VideoFilter,
240 actorId: user.Account.Actor.id
243 return res.json(getFormattedObjects(resultList.data, resultList.total))
246 async function getUserVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
247 const user = res.locals.oauth.token.User as UserModel
248 const resultList = await VideoModel.listUserVideosForApi(
250 req.query.start as number,
251 req.query.count as number,
252 req.query.sort as VideoSortField
255 const additionalAttributes = {
256 waitTranscoding: true,
258 scheduledUpdate: true,
261 return res.json(getFormattedObjects(resultList.data, resultList.total, { additionalAttributes }))
264 async function getUserVideoImports (req: express.Request, res: express.Response, next: express.NextFunction) {
265 const user = res.locals.oauth.token.User as UserModel
266 const resultList = await VideoImportModel.listUserVideoImportsForApi(
268 req.query.start as number,
269 req.query.count as number,
273 return res.json(getFormattedObjects(resultList.data, resultList.total))
276 async function getUserInformation (req: express.Request, res: express.Response, next: express.NextFunction) {
277 // We did not load channels in res.locals.user
278 const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
280 return res.json(user.toFormattedJSON())
283 async function getUserVideoQuotaUsed (req: express.Request, res: express.Response, next: express.NextFunction) {
284 // We did not load channels in res.locals.user
285 const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
286 const videoQuotaUsed = await UserModel.getOriginalVideoFileTotalFromUser(user)
287 const videoQuotaUsedDaily = await UserModel.getOriginalVideoFileTotalDailyFromUser(user)
289 const data: UserVideoQuota = {
293 return res.json(data)
296 async function getUserVideoRating (req: express.Request, res: express.Response, next: express.NextFunction) {
297 const videoId = res.locals.video.id
298 const accountId = +res.locals.oauth.token.User.Account.id
300 const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
301 const rating = ratingObj ? ratingObj.type : 'none'
303 const json: FormattedUserVideoRate = {
307 return res.json(json)
310 async function deleteMe (req: express.Request, res: express.Response) {
311 const user: UserModel = res.locals.oauth.token.User
315 auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
317 return res.sendStatus(204)
320 async function updateMe (req: express.Request, res: express.Response, next: express.NextFunction) {
321 const body: UserUpdateMe = req.body
323 const user: UserModel = res.locals.oauth.token.user
324 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
326 if (body.password !== undefined) user.password = body.password
327 if (body.email !== undefined) user.email = body.email
328 if (body.nsfwPolicy !== undefined) user.nsfwPolicy = body.nsfwPolicy
329 if (body.autoPlayVideo !== undefined) user.autoPlayVideo = body.autoPlayVideo
331 await sequelizeTypescript.transaction(async t => {
332 await user.save({ transaction: t })
334 if (body.displayName !== undefined) user.Account.name = body.displayName
335 if (body.description !== undefined) user.Account.description = body.description
336 await user.Account.save({ transaction: t })
338 await sendUpdateActor(user.Account, t)
341 getAuditIdFromRes(res),
342 new UserAuditView(user.toFormattedJSON()),
347 return res.sendStatus(204)
350 async function updateMyAvatar (req: express.Request, res: express.Response, next: express.NextFunction) {
351 const avatarPhysicalFile = req.files[ 'avatarfile' ][ 0 ]
352 const user: UserModel = res.locals.oauth.token.user
353 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
354 const account = user.Account
356 const avatar = await updateActorAvatarFile(avatarPhysicalFile, account.Actor, account)
359 getAuditIdFromRes(res),
360 new UserAuditView(user.toFormattedJSON()),
364 return res.json({ avatar: avatar.toFormattedJSON() })