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