server/controllers/api/users/me.ts

   1 import * as express from 'express'
   2 import 'multer'
   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'
   7 import {
   8   asyncMiddleware,
   9   asyncRetryTransactionMiddleware,
  10   authenticate,
  11   commonVideosFiltersValidator,
  12   paginationValidator,
  13   setDefaultPagination,
  14   setDefaultSort,
  15   userSubscriptionAddValidator,
  16   userSubscriptionGetValidator,
  17   usersUpdateMeValidator,
  18   usersVideoRatingValidator
  19 } from '../../../middlewares'
  20 import {
  21   areSubscriptionsExistValidator,
  22   deleteMeValidator,
  23   userSubscriptionsSortValidator,
  24   videoImportsSortValidator,
  25   videosSortValidator
  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'
  41
  42 const auditLogger = auditLoggerFactory('users-me')
  43
  44 const reqAvatarFile = createReqFiles([ 'avatarfile' ], IMAGE_MIMETYPE_EXT, { avatarfile: CONFIG.STORAGE.AVATARS_DIR })
  45
  46 const meRouter = express.Router()
  47
  48 meRouter.get('/me',
  49   authenticate,
  50   asyncMiddleware(getUserInformation)
  51 )
  52 meRouter.delete('/me',
  53   authenticate,
  54   asyncMiddleware(deleteMeValidator),
  55   asyncMiddleware(deleteMe)
  56 )
  57
  58 meRouter.get('/me/video-quota-used',
  59   authenticate,
  60   asyncMiddleware(getUserVideoQuotaUsed)
  61 )
  62
  63 meRouter.get('/me/videos/imports',
  64   authenticate,
  65   paginationValidator,
  66   videoImportsSortValidator,
  67   setDefaultSort,
  68   setDefaultPagination,
  69   asyncMiddleware(getUserVideoImports)
  70 )
  71
  72 meRouter.get('/me/videos',
  73   authenticate,
  74   paginationValidator,
  75   videosSortValidator,
  76   setDefaultSort,
  77   setDefaultPagination,
  78   asyncMiddleware(getUserVideos)
  79 )
  80
  81 meRouter.get('/me/videos/:videoId/rating',
  82   authenticate,
  83   asyncMiddleware(usersVideoRatingValidator),
  84   asyncMiddleware(getUserVideoRating)
  85 )
  86
  87 meRouter.put('/me',
  88   authenticate,
  89   usersUpdateMeValidator,
  90   asyncRetryTransactionMiddleware(updateMe)
  91 )
  92
  93 meRouter.post('/me/avatar/pick',
  94   authenticate,
  95   reqAvatarFile,
  96   updateAvatarValidator,
  97   asyncRetryTransactionMiddleware(updateMyAvatar)
  98 )
  99
 100 // ##### Subscriptions part #####
 101
 102 meRouter.get('/me/subscriptions/videos',
 103   authenticate,
 104   paginationValidator,
 105   videosSortValidator,
 106   setDefaultSort,
 107   setDefaultPagination,
 108   commonVideosFiltersValidator,
 109   asyncMiddleware(getUserSubscriptionVideos)
 110 )
 111
 112 meRouter.get('/me/subscriptions/exist',
 113   authenticate,
 114   areSubscriptionsExistValidator,
 115   asyncMiddleware(areSubscriptionsExist)
 116 )
 117
 118 meRouter.get('/me/subscriptions',
 119   authenticate,
 120   paginationValidator,
 121   userSubscriptionsSortValidator,
 122   setDefaultSort,
 123   setDefaultPagination,
 124   asyncMiddleware(getUserSubscriptions)
 125 )
 126
 127 meRouter.post('/me/subscriptions',
 128   authenticate,
 129   userSubscriptionAddValidator,
 130   asyncMiddleware(addUserSubscription)
 131 )
 132
 133 meRouter.get('/me/subscriptions/:uri',
 134   authenticate,
 135   userSubscriptionGetValidator,
 136   getUserSubscription
 137 )
 138
 139 meRouter.delete('/me/subscriptions/:uri',
 140   authenticate,
 141   userSubscriptionGetValidator,
 142   asyncRetryTransactionMiddleware(deleteUserSubscription)
 143 )
 144
 145 // ---------------------------------------------------------------------------
 146
 147 export {
 148   meRouter
 149 }
 150
 151 // ---------------------------------------------------------------------------
 152
 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
 156
 157   const handles = uris.map(u => {
 158     let [ name, host ] = u.split('@')
 159     if (host === CONFIG.WEBSERVER.HOST) host = null
 160
 161     return { name, host, uri: u }
 162   })
 163
 164   const results = await ActorFollowModel.listSubscribedIn(user.Account.Actor.id, handles)
 165
 166   const existObject: { [id: string ]: boolean } = {}
 167   for (const handle of handles) {
 168     const obj = results.find(r => {
 169       const server = r.ActorFollowing.Server
 170
 171       return r.ActorFollowing.preferredUsername === handle.name &&
 172         (
 173           (!server && !handle.host) ||
 174           (server.host === handle.host)
 175         )
 176     })
 177
 178     existObject[handle.uri] = obj !== undefined
 179   }
 180
 181   return res.json(existObject)
 182 }
 183
 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('@')
 187
 188   const payload = {
 189     name,
 190     host,
 191     followerActorId: user.Account.Actor.id
 192   }
 193
 194   JobQueue.Instance.createJob({ type: 'activitypub-follow', payload })
 195           .catch(err => logger.error('Cannot create follow job for subscription %s.', req.body.uri, err))
 196
 197   return res.status(204).end()
 198 }
 199
 200 function getUserSubscription (req: express.Request, res: express.Response) {
 201   const subscription: ActorFollowModel = res.locals.subscription
 202
 203   return res.json(subscription.ActorFollowing.VideoChannel.toFormattedJSON())
 204 }
 205
 206 async function deleteUserSubscription (req: express.Request, res: express.Response) {
 207   const subscription: ActorFollowModel = res.locals.subscription
 208
 209   await sequelizeTypescript.transaction(async t => {
 210     return subscription.destroy({ transaction: t })
 211   })
 212
 213   return res.type('json').status(204).end()
 214 }
 215
 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
 219
 220   const resultList = await ActorFollowModel.listSubscriptionsForApi(actorId, req.query.start, req.query.count, req.query.sort)
 221
 222   return res.json(getFormattedObjects(resultList.data, resultList.total))
 223 }
 224
 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,
 239     withFiles: false,
 240     actorId: user.Account.Actor.id
 241   })
 242
 243   return res.json(getFormattedObjects(resultList.data, resultList.total))
 244 }
 245
 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(
 249     user.Account.id,
 250     req.query.start as number,
 251     req.query.count as number,
 252     req.query.sort as VideoSortField
 253   )
 254
 255   const additionalAttributes = {
 256     waitTranscoding: true,
 257     state: true,
 258     scheduledUpdate: true,
 259     blacklistInfo: true
 260   }
 261   return res.json(getFormattedObjects(resultList.data, resultList.total, { additionalAttributes }))
 262 }
 263
 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(
 267     user.id,
 268     req.query.start as number,
 269     req.query.count as number,
 270     req.query.sort
 271   )
 272
 273   return res.json(getFormattedObjects(resultList.data, resultList.total))
 274 }
 275
 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)
 279
 280   return res.json(user.toFormattedJSON())
 281 }
 282
 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)
 288
 289   const data: UserVideoQuota = {
 290     videoQuotaUsed,
 291     videoQuotaUsedDaily
 292   }
 293   return res.json(data)
 294 }
 295
 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
 299
 300   const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
 301   const rating = ratingObj ? ratingObj.type : 'none'
 302
 303   const json: FormattedUserVideoRate = {
 304     videoId,
 305     rating
 306   }
 307   return res.json(json)
 308 }
 309
 310 async function deleteMe (req: express.Request, res: express.Response) {
 311   const user: UserModel = res.locals.oauth.token.User
 312
 313   await user.destroy()
 314
 315   auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
 316
 317   return res.sendStatus(204)
 318 }
 319
 320 async function updateMe (req: express.Request, res: express.Response, next: express.NextFunction) {
 321   const body: UserUpdateMe = req.body
 322
 323   const user: UserModel = res.locals.oauth.token.user
 324   const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
 325
 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
 330
 331   await sequelizeTypescript.transaction(async t => {
 332     await user.save({ transaction: t })
 333
 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 })
 337
 338     await sendUpdateActor(user.Account, t)
 339
 340     auditLogger.update(
 341       getAuditIdFromRes(res),
 342       new UserAuditView(user.toFormattedJSON()),
 343       oldUserAuditView
 344     )
 345   })
 346
 347   return res.sendStatus(204)
 348 }
 349
 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
 355
 356   const avatar = await updateActorAvatarFile(avatarPhysicalFile, account.Actor, account)
 357
 358   auditLogger.update(
 359     getAuditIdFromRes(res),
 360     new UserAuditView(user.toFormattedJSON()),
 361     oldUserAuditView
 362   )
 363
 364   return res.json({ avatar: avatar.toFormattedJSON() })
 365 }