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 areSubscriptionsExistValidator
25 } from '../../../middlewares/validators'
26 import { AccountVideoRateModel } from '../../../models/account/account-video-rate'
27 import { UserModel } from '../../../models/account/user'
28 import { VideoModel } from '../../../models/video/video'
29 import { VideoSortField } from '../../../../client/src/app/shared/video/sort-field.type'
30 import { buildNSFWFilter, createReqFiles } from '../../../helpers/express-utils'
31 import { UserVideoQuota } from '../../../../shared/models/users/user-video-quota.model'
32 import { updateAvatarValidator } from '../../../middlewares/validators/avatar'
33 import { updateActorAvatarFile } from '../../../lib/avatar'
34 import { auditLoggerFactory, UserAuditView } from '../../../helpers/audit-logger'
35 import { VideoImportModel } from '../../../models/video/video-import'
36 import { VideoFilter } from '../../../../shared/models/videos/video-query.type'
37 import { ActorFollowModel } from '../../../models/activitypub/actor-follow'
38 import { JobQueue } from '../../../lib/job-queue'
39 import { logger } from '../../../helpers/logger'
41 const auditLogger = auditLoggerFactory('users-me')
43 const reqAvatarFile = createReqFiles([ 'avatarfile' ], IMAGE_MIMETYPE_EXT, { avatarfile: CONFIG.STORAGE.AVATARS_DIR })
45 const meRouter = express.Router()
49 asyncMiddleware(getUserInformation)
51 meRouter.delete('/me',
53 asyncMiddleware(deleteMeValidator),
54 asyncMiddleware(deleteMe)
57 meRouter.get('/me/video-quota-used',
59 asyncMiddleware(getUserVideoQuotaUsed)
62 meRouter.get('/me/videos/imports',
65 videoImportsSortValidator,
68 asyncMiddleware(getUserVideoImports)
71 meRouter.get('/me/videos',
77 asyncMiddleware(getUserVideos)
80 meRouter.get('/me/videos/:videoId/rating',
82 asyncMiddleware(usersVideoRatingValidator),
83 asyncMiddleware(getUserVideoRating)
88 usersUpdateMeValidator,
89 asyncMiddleware(updateMe)
92 meRouter.post('/me/avatar/pick',
95 updateAvatarValidator,
96 asyncMiddleware(updateMyAvatar)
99 // ##### Subscriptions part #####
101 meRouter.get('/me/subscriptions/videos',
106 setDefaultPagination,
107 commonVideosFiltersValidator,
108 asyncMiddleware(getUserSubscriptionVideos)
111 meRouter.get('/me/subscriptions/exist',
113 areSubscriptionsExistValidator,
114 asyncMiddleware(areSubscriptionsExist)
117 meRouter.get('/me/subscriptions',
120 userSubscriptionsSortValidator,
122 setDefaultPagination,
123 asyncMiddleware(getUserSubscriptions)
126 meRouter.post('/me/subscriptions',
128 userSubscriptionAddValidator,
129 asyncMiddleware(addUserSubscription)
132 meRouter.get('/me/subscriptions/:uri',
134 userSubscriptionGetValidator,
138 meRouter.delete('/me/subscriptions/:uri',
140 userSubscriptionGetValidator,
141 asyncMiddleware(deleteUserSubscription)
144 // ---------------------------------------------------------------------------
150 // ---------------------------------------------------------------------------
152 async function areSubscriptionsExist (req: express.Request, res: express.Response) {
153 const uris = req.query.uris as string[]
154 const user = res.locals.oauth.token.User as UserModel
156 const handles = uris.map(u => {
157 let [ name, host ] = u.split('@')
158 if (host === CONFIG.WEBSERVER.HOST) host = null
160 return { name, host, uri: u }
163 const results = await ActorFollowModel.listSubscribedIn(user.Account.Actor.id, handles)
165 const existObject: { [id: string ]: boolean } = {}
166 for (const handle of handles) {
167 const obj = results.find(r => {
168 const server = r.ActorFollowing.Server
170 return r.ActorFollowing.preferredUsername === handle.name &&
172 (!server && !handle.host) ||
173 (server.host === handle.host)
177 existObject[handle.uri] = obj !== undefined
180 return res.json(existObject)
183 async function addUserSubscription (req: express.Request, res: express.Response) {
184 const user = res.locals.oauth.token.User as UserModel
185 const [ name, host ] = req.body.uri.split('@')
190 followerActorId: user.Account.Actor.id
193 JobQueue.Instance.createJob({ type: 'activitypub-follow', payload })
194 .catch(err => logger.error('Cannot create follow job for subscription %s.', req.body.uri, err))
196 return res.status(204).end()
199 function getUserSubscription (req: express.Request, res: express.Response) {
200 const subscription: ActorFollowModel = res.locals.subscription
202 return res.json(subscription.ActorFollowing.VideoChannel.toFormattedJSON())
205 async function deleteUserSubscription (req: express.Request, res: express.Response) {
206 const subscription: ActorFollowModel = res.locals.subscription
208 await sequelizeTypescript.transaction(async t => {
209 return subscription.destroy({ transaction: t })
212 return res.type('json').status(204).end()
215 async function getUserSubscriptions (req: express.Request, res: express.Response) {
216 const user = res.locals.oauth.token.User as UserModel
217 const actorId = user.Account.Actor.id
219 const resultList = await ActorFollowModel.listSubscriptionsForApi(actorId, req.query.start, req.query.count, req.query.sort)
221 return res.json(getFormattedObjects(resultList.data, resultList.total))
224 async function getUserSubscriptionVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
225 const user = res.locals.oauth.token.User as UserModel
226 const resultList = await VideoModel.listForApi({
227 start: req.query.start,
228 count: req.query.count,
229 sort: req.query.sort,
230 includeLocalVideos: false,
231 categoryOneOf: req.query.categoryOneOf,
232 licenceOneOf: req.query.licenceOneOf,
233 languageOneOf: req.query.languageOneOf,
234 tagsOneOf: req.query.tagsOneOf,
235 tagsAllOf: req.query.tagsAllOf,
236 nsfw: buildNSFWFilter(res, req.query.nsfw),
237 filter: req.query.filter as VideoFilter,
239 actorId: user.Account.Actor.id
242 return res.json(getFormattedObjects(resultList.data, resultList.total))
245 async function getUserVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
246 const user = res.locals.oauth.token.User as UserModel
247 const resultList = await VideoModel.listUserVideosForApi(
249 req.query.start as number,
250 req.query.count as number,
251 req.query.sort as VideoSortField
254 const additionalAttributes = {
255 waitTranscoding: true,
257 scheduledUpdate: true,
260 return res.json(getFormattedObjects(resultList.data, resultList.total, { additionalAttributes }))
263 async function getUserVideoImports (req: express.Request, res: express.Response, next: express.NextFunction) {
264 const user = res.locals.oauth.token.User as UserModel
265 const resultList = await VideoImportModel.listUserVideoImportsForApi(
267 req.query.start as number,
268 req.query.count as number,
272 return res.json(getFormattedObjects(resultList.data, resultList.total))
275 async function getUserInformation (req: express.Request, res: express.Response, next: express.NextFunction) {
276 // We did not load channels in res.locals.user
277 const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
279 return res.json(user.toFormattedJSON())
282 async function getUserVideoQuotaUsed (req: express.Request, res: express.Response, next: express.NextFunction) {
283 // We did not load channels in res.locals.user
284 const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
285 const videoQuotaUsed = await UserModel.getOriginalVideoFileTotalFromUser(user)
286 const videoQuotaUsedDaily = await UserModel.getOriginalVideoFileTotalDailyFromUser(user)
288 const data: UserVideoQuota = {
292 return res.json(data)
295 async function getUserVideoRating (req: express.Request, res: express.Response, next: express.NextFunction) {
296 const videoId = +req.params.videoId
297 const accountId = +res.locals.oauth.token.User.Account.id
299 const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
300 const rating = ratingObj ? ratingObj.type : 'none'
302 const json: FormattedUserVideoRate = {
306 return res.json(json)
309 async function deleteMe (req: express.Request, res: express.Response) {
310 const user: UserModel = res.locals.oauth.token.User
314 auditLogger.delete(res.locals.oauth.token.User.Account.Actor.getIdentifier(), new UserAuditView(user.toFormattedJSON()))
316 return res.sendStatus(204)
319 async function updateMe (req: express.Request, res: express.Response, next: express.NextFunction) {
320 const body: UserUpdateMe = req.body
322 const user: UserModel = res.locals.oauth.token.user
323 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
325 if (body.password !== undefined) user.password = body.password
326 if (body.email !== undefined) user.email = body.email
327 if (body.nsfwPolicy !== undefined) user.nsfwPolicy = body.nsfwPolicy
328 if (body.autoPlayVideo !== undefined) user.autoPlayVideo = body.autoPlayVideo
330 await sequelizeTypescript.transaction(async t => {
331 await user.save({ transaction: t })
333 if (body.displayName !== undefined) user.Account.name = body.displayName
334 if (body.description !== undefined) user.Account.description = body.description
335 await user.Account.save({ transaction: t })
337 await sendUpdateActor(user.Account, t)
340 res.locals.oauth.token.User.Account.Actor.getIdentifier(),
341 new UserAuditView(user.toFormattedJSON()),
346 return res.sendStatus(204)
349 async function updateMyAvatar (req: express.Request, res: express.Response, next: express.NextFunction) {
350 const avatarPhysicalFile = req.files[ 'avatarfile' ][ 0 ]
351 const user: UserModel = res.locals.oauth.token.user
352 const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
353 const account = user.Account
355 const avatar = await updateActorAvatarFile(avatarPhysicalFile, account.Actor, account)
358 res.locals.oauth.token.User.Account.Actor.getIdentifier(),
359 new UserAuditView(user.toFormattedJSON()),
363 return res.json({ avatar: avatar.toFormattedJSON() })