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 { MIMETYPES, sequelizeTypescript } from '../../../initializers'
   6 import { sendUpdateActor } from '../../../lib/activitypub/send'
   7 import {
   8   asyncMiddleware,
   9   asyncRetryTransactionMiddleware,
  10   authenticate,
  11   paginationValidator,
  12   setDefaultPagination,
  13   setDefaultSort,
  14   usersUpdateMeValidator,
  15   usersVideoRatingValidator
  16 } from '../../../middlewares'
  17 import { deleteMeValidator, videoImportsSortValidator, videosSortValidator } from '../../../middlewares/validators'
  18 import { AccountVideoRateModel } from '../../../models/account/account-video-rate'
  19 import { UserModel } from '../../../models/account/user'
  20 import { VideoModel } from '../../../models/video/video'
  21 import { VideoSortField } from '../../../../client/src/app/shared/video/sort-field.type'
  22 import { createReqFiles } from '../../../helpers/express-utils'
  23 import { UserVideoQuota } from '../../../../shared/models/users/user-video-quota.model'
  24 import { updateAvatarValidator } from '../../../middlewares/validators/avatar'
  25 import { updateActorAvatarFile } from '../../../lib/avatar'
  26 import { auditLoggerFactory, getAuditIdFromRes, UserAuditView } from '../../../helpers/audit-logger'
  27 import { VideoImportModel } from '../../../models/video/video-import'
  28 import { AccountModel } from '../../../models/account/account'
  29 import { CONFIG } from '../../../initializers/config'
  30
  31 const auditLogger = auditLoggerFactory('users-me')
  32
  33 const reqAvatarFile = createReqFiles([ 'avatarfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT, { avatarfile: CONFIG.STORAGE.TMP_DIR })
  34
  35 const meRouter = express.Router()
  36
  37 meRouter.get('/me',
  38   authenticate,
  39   asyncMiddleware(getUserInformation)
  40 )
  41 meRouter.delete('/me',
  42   authenticate,
  43   asyncMiddleware(deleteMeValidator),
  44   asyncMiddleware(deleteMe)
  45 )
  46
  47 meRouter.get('/me/video-quota-used',
  48   authenticate,
  49   asyncMiddleware(getUserVideoQuotaUsed)
  50 )
  51
  52 meRouter.get('/me/videos/imports',
  53   authenticate,
  54   paginationValidator,
  55   videoImportsSortValidator,
  56   setDefaultSort,
  57   setDefaultPagination,
  58   asyncMiddleware(getUserVideoImports)
  59 )
  60
  61 meRouter.get('/me/videos',
  62   authenticate,
  63   paginationValidator,
  64   videosSortValidator,
  65   setDefaultSort,
  66   setDefaultPagination,
  67   asyncMiddleware(getUserVideos)
  68 )
  69
  70 meRouter.get('/me/videos/:videoId/rating',
  71   authenticate,
  72   asyncMiddleware(usersVideoRatingValidator),
  73   asyncMiddleware(getUserVideoRating)
  74 )
  75
  76 meRouter.put('/me',
  77   authenticate,
  78   asyncMiddleware(usersUpdateMeValidator),
  79   asyncRetryTransactionMiddleware(updateMe)
  80 )
  81
  82 meRouter.post('/me/avatar/pick',
  83   authenticate,
  84   reqAvatarFile,
  85   updateAvatarValidator,
  86   asyncRetryTransactionMiddleware(updateMyAvatar)
  87 )
  88
  89 // ---------------------------------------------------------------------------
  90
  91 export {
  92   meRouter
  93 }
  94
  95 // ---------------------------------------------------------------------------
  96
  97 async function getUserVideos (req: express.Request, res: express.Response) {
  98   const user = res.locals.oauth.token.User
  99   const resultList = await VideoModel.listUserVideosForApi(
 100     user.Account.id,
 101     req.query.start as number,
 102     req.query.count as number,
 103     req.query.sort as VideoSortField
 104   )
 105
 106   const additionalAttributes = {
 107     waitTranscoding: true,
 108     state: true,
 109     scheduledUpdate: true,
 110     blacklistInfo: true
 111   }
 112   return res.json(getFormattedObjects(resultList.data, resultList.total, { additionalAttributes }))
 113 }
 114
 115 async function getUserVideoImports (req: express.Request, res: express.Response) {
 116   const user = res.locals.oauth.token.User
 117   const resultList = await VideoImportModel.listUserVideoImportsForApi(
 118     user.id,
 119     req.query.start as number,
 120     req.query.count as number,
 121     req.query.sort
 122   )
 123
 124   return res.json(getFormattedObjects(resultList.data, resultList.total))
 125 }
 126
 127 async function getUserInformation (req: express.Request, res: express.Response) {
 128   // We did not load channels in res.locals.user
 129   const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
 130
 131   return res.json(user.toFormattedJSON())
 132 }
 133
 134 async function getUserVideoQuotaUsed (req: express.Request, res: express.Response) {
 135   // We did not load channels in res.locals.user
 136   const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
 137   const videoQuotaUsed = await UserModel.getOriginalVideoFileTotalFromUser(user)
 138   const videoQuotaUsedDaily = await UserModel.getOriginalVideoFileTotalDailyFromUser(user)
 139
 140   const data: UserVideoQuota = {
 141     videoQuotaUsed,
 142     videoQuotaUsedDaily
 143   }
 144   return res.json(data)
 145 }
 146
 147 async function getUserVideoRating (req: express.Request, res: express.Response) {
 148   const videoId = res.locals.video.id
 149   const accountId = +res.locals.oauth.token.User.Account.id
 150
 151   const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
 152   const rating = ratingObj ? ratingObj.type : 'none'
 153
 154   const json: FormattedUserVideoRate = {
 155     videoId,
 156     rating
 157   }
 158   return res.json(json)
 159 }
 160
 161 async function deleteMe (req: express.Request, res: express.Response) {
 162   const user = res.locals.oauth.token.User
 163
 164   await user.destroy()
 165
 166   auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
 167
 168   return res.sendStatus(204)
 169 }
 170
 171 async function updateMe (req: express.Request, res: express.Response) {
 172   const body: UserUpdateMe = req.body
 173
 174   const user = res.locals.oauth.token.user
 175   const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
 176
 177   if (body.password !== undefined) user.password = body.password
 178   if (body.email !== undefined) user.email = body.email
 179   if (body.nsfwPolicy !== undefined) user.nsfwPolicy = body.nsfwPolicy
 180   if (body.webTorrentEnabled !== undefined) user.webTorrentEnabled = body.webTorrentEnabled
 181   if (body.autoPlayVideo !== undefined) user.autoPlayVideo = body.autoPlayVideo
 182   if (body.videosHistoryEnabled !== undefined) user.videosHistoryEnabled = body.videosHistoryEnabled
 183
 184   await sequelizeTypescript.transaction(async t => {
 185     const userAccount = await AccountModel.load(user.Account.id)
 186
 187     await user.save({ transaction: t })
 188
 189     if (body.displayName !== undefined) userAccount.name = body.displayName
 190     if (body.description !== undefined) userAccount.description = body.description
 191     await userAccount.save({ transaction: t })
 192
 193     await sendUpdateActor(userAccount, t)
 194
 195     auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)
 196   })
 197
 198   return res.sendStatus(204)
 199 }
 200
 201 async function updateMyAvatar (req: express.Request, res: express.Response) {
 202   const avatarPhysicalFile = req.files[ 'avatarfile' ][ 0 ]
 203   const user = res.locals.oauth.token.user
 204   const oldUserAuditView = new UserAuditView(user.toFormattedJSON())
 205
 206   const userAccount = await AccountModel.load(user.Account.id)
 207
 208   const avatar = await updateActorAvatarFile(avatarPhysicalFile, userAccount)
 209
 210   auditLogger.update(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()), oldUserAuditView)
 211
 212   return res.json({ avatar: avatar.toFormattedJSON() })
 213 }