server/controllers/api/users/me.ts

   1 import 'multer'
   2 import express from 'express'
   3 import { auditLoggerFactory, getAuditIdFromRes, UserAuditView } from '@server/helpers/audit-logger'
   4 import { Hooks } from '@server/lib/plugins/hooks'
   5 import { ActorImageType, HttpStatusCode, UserUpdateMe, UserVideoQuota, UserVideoRate as FormattedUserVideoRate } from '@shared/models'
   6 import { AttributesOnly } from '@shared/typescript-utils'
   7 import { createReqFiles } from '../../../helpers/express-utils'
   8 import { getFormattedObjects } from '../../../helpers/utils'
   9 import { CONFIG } from '../../../initializers/config'
  10 import { MIMETYPES } from '../../../initializers/constants'
  11 import { sequelizeTypescript } from '../../../initializers/database'
  12 import { sendUpdateActor } from '../../../lib/activitypub/send'
  13 import { deleteLocalActorImageFile, updateLocalActorImageFile } from '../../../lib/local-actor'
  14 import { getOriginalVideoFileTotalDailyFromUser, getOriginalVideoFileTotalFromUser, sendVerifyUserEmail } from '../../../lib/user'
  15 import {
  16   asyncMiddleware,
  17   asyncRetryTransactionMiddleware,
  18   authenticate,
  19   paginationValidator,
  20   setDefaultPagination,
  21   setDefaultSort,
  22   setDefaultVideosSort,
  23   usersUpdateMeValidator,
  24   usersVideoRatingValidator
  25 } from '../../../middlewares'
  26 import { deleteMeValidator, usersVideosValidator, videoImportsSortValidator, videosSortValidator } from '../../../middlewares/validators'
  27 import { updateAvatarValidator } from '../../../middlewares/validators/actor-image'
  28 import { AccountModel } from '../../../models/account/account'
  29 import { AccountVideoRateModel } from '../../../models/account/account-video-rate'
  30 import { UserModel } from '../../../models/user/user'
  31 import { VideoModel } from '../../../models/video/video'
  32 import { VideoImportModel } from '../../../models/video/video-import'
  33
  34 const auditLogger = auditLoggerFactory('users')
  35
  36 const reqAvatarFile = createReqFiles([ 'avatarfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT, { avatarfile: CONFIG.STORAGE.TMP_DIR })
  37
  38 const meRouter = express.Router()
  39
  40 meRouter.get('/me',
  41   authenticate,
  42   asyncMiddleware(getUserInformation)
  43 )
  44 meRouter.delete('/me',
  45   authenticate,
  46   deleteMeValidator,
  47   asyncMiddleware(deleteMe)
  48 )
  49
  50 meRouter.get('/me/video-quota-used',
  51   authenticate,
  52   asyncMiddleware(getUserVideoQuotaUsed)
  53 )
  54
  55 meRouter.get('/me/videos/imports',
  56   authenticate,
  57   paginationValidator,
  58   videoImportsSortValidator,
  59   setDefaultSort,
  60   setDefaultPagination,
  61   asyncMiddleware(getUserVideoImports)
  62 )
  63
  64 meRouter.get('/me/videos',
  65   authenticate,
  66   paginationValidator,
  67   videosSortValidator,
  68   setDefaultVideosSort,
  69   setDefaultPagination,
  70   asyncMiddleware(usersVideosValidator),
  71   asyncMiddleware(getUserVideos)
  72 )
  73
  74 meRouter.get('/me/videos/:videoId/rating',
  75   authenticate,
  76   asyncMiddleware(usersVideoRatingValidator),
  77   asyncMiddleware(getUserVideoRating)
  78 )
  79
  80 meRouter.put('/me',
  81   authenticate,
  82   asyncMiddleware(usersUpdateMeValidator),
  83   asyncRetryTransactionMiddleware(updateMe)
  84 )
  85
  86 meRouter.post('/me/avatar/pick',
  87   authenticate,
  88   reqAvatarFile,
  89   updateAvatarValidator,
  90   asyncRetryTransactionMiddleware(updateMyAvatar)
  91 )
  92
  93 meRouter.delete('/me/avatar',
  94   authenticate,
  95   asyncRetryTransactionMiddleware(deleteMyAvatar)
  96 )
  97
  98 // ---------------------------------------------------------------------------
  99
 100 export {
 101   meRouter
 102 }
 103
 104 // ---------------------------------------------------------------------------
 105
 106 async function getUserVideos (req: express.Request, res: express.Response) {
 107   const user = res.locals.oauth.token.User
 108
 109   const apiOptions = await Hooks.wrapObject({
 110     accountId: user.Account.id,
 111     start: req.query.start,
 112     count: req.query.count,
 113     sort: req.query.sort,
 114     search: req.query.search,
 115     channelId: res.locals.videoChannel?.id,
 116     isLive: req.query.isLive
 117   }, 'filter:api.user.me.videos.list.params')
 118
 119   const resultList = await Hooks.wrapPromiseFun(
 120     VideoModel.listUserVideosForApi,
 121     apiOptions,
 122     'filter:api.user.me.videos.list.result'
 123   )
 124
 125   const additionalAttributes = {
 126     waitTranscoding: true,
 127     state: true,
 128     scheduledUpdate: true,
 129     blacklistInfo: true
 130   }
 131   return res.json(getFormattedObjects(resultList.data, resultList.total, { additionalAttributes }))
 132 }
 133
 134 async function getUserVideoImports (req: express.Request, res: express.Response) {
 135   const user = res.locals.oauth.token.User
 136   const resultList = await VideoImportModel.listUserVideoImportsForApi(
 137     user.id,
 138     req.query.start as number,
 139     req.query.count as number,
 140     req.query.sort
 141   )
 142
 143   return res.json(getFormattedObjects(resultList.data, resultList.total))
 144 }
 145
 146 async function getUserInformation (req: express.Request, res: express.Response) {
 147   // We did not load channels in res.locals.user
 148   const user = await UserModel.loadForMeAPI(res.locals.oauth.token.user.id)
 149
 150   return res.json(user.toMeFormattedJSON())
 151 }
 152
 153 async function getUserVideoQuotaUsed (req: express.Request, res: express.Response) {
 154   const user = res.locals.oauth.token.user
 155   const videoQuotaUsed = await getOriginalVideoFileTotalFromUser(user)
 156   const videoQuotaUsedDaily = await getOriginalVideoFileTotalDailyFromUser(user)
 157
 158   const data: UserVideoQuota = {
 159     videoQuotaUsed,
 160     videoQuotaUsedDaily
 161   }
 162   return res.json(data)
 163 }
 164
 165 async function getUserVideoRating (req: express.Request, res: express.Response) {
 166   const videoId = res.locals.videoId.id
 167   const accountId = +res.locals.oauth.token.User.Account.id
 168
 169   const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
 170   const rating = ratingObj ? ratingObj.type : 'none'
 171
 172   const json: FormattedUserVideoRate = {
 173     videoId,
 174     rating
 175   }
 176   return res.json(json)
 177 }
 178
 179 async function deleteMe (req: express.Request, res: express.Response) {
 180   const user = await UserModel.loadByIdWithChannels(res.locals.oauth.token.User.id)
 181
 182   auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
 183
 184   await user.destroy()
 185
 186   return res.status(HttpStatusCode.NO_CONTENT_204).end()
 187 }
 188
 189 async function updateMe (req: express.Request, res: express.Response) {
 190   const body: UserUpdateMe = req.body
 191   let sendVerificationEmail = false
 192
 193   const user = res.locals.oauth.token.user
 194
 195   const keysToUpdate: (keyof UserUpdateMe & keyof AttributesOnly<UserModel>)[] = [
 196     'password',
 197     'nsfwPolicy',
 198     'p2pEnabled',
 199     'autoPlayVideo',
 200     'autoPlayNextVideo',
 201     'autoPlayNextVideoPlaylist',
 202     'videosHistoryEnabled',
 203     'videoLanguages',
 204     'theme',
 205     'noInstanceConfigWarningModal',
 206     'noAccountSetupWarningModal',
 207     'noWelcomeModal'
 208   ]
 209
 210   for (const key of keysToUpdate) {
 211     if (body[key] !== undefined) user.set(key, body[key])
 212   }
 213
 214   if (body.p2pEnabled !== undefined) {
 215     user.set('p2pEnabled', body.p2pEnabled)
 216   } else if (body.webTorrentEnabled !== undefined) { // FIXME: deprecated in 4.1
 217     user.set('p2pEnabled', body.webTorrentEnabled)
 218   }
 219
 220   if (body.email !== undefined) {
 221     if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
 222       user.pendingEmail = body.email
 223       sendVerificationEmail = true
 224     } else {
 225       user.email = body.email
 226     }
 227   }
 228
 229   await sequelizeTypescript.transaction(async t => {
 230     await user.save({ transaction: t })
 231
 232     if (body.displayName === undefined && body.description === undefined) return
 233
 234     const userAccount = await AccountModel.load(user.Account.id, t)
 235
 236     if (body.displayName !== undefined) userAccount.name = body.displayName
 237     if (body.description !== undefined) userAccount.description = body.description
 238     await userAccount.save({ transaction: t })
 239
 240     await sendUpdateActor(userAccount, t)
 241   })
 242
 243   if (sendVerificationEmail === true) {
 244     await sendVerifyUserEmail(user, true)
 245   }
 246
 247   return res.status(HttpStatusCode.NO_CONTENT_204).end()
 248 }
 249
 250 async function updateMyAvatar (req: express.Request, res: express.Response) {
 251   const avatarPhysicalFile = req.files['avatarfile'][0]
 252   const user = res.locals.oauth.token.user
 253
 254   const userAccount = await AccountModel.load(user.Account.id)
 255
 256   const avatar = await updateLocalActorImageFile(userAccount, avatarPhysicalFile, ActorImageType.AVATAR)
 257
 258   return res.json({ avatar: avatar.toFormattedJSON() })
 259 }
 260
 261 async function deleteMyAvatar (req: express.Request, res: express.Response) {
 262   const user = res.locals.oauth.token.user
 263
 264   const userAccount = await AccountModel.load(user.Account.id)
 265   await deleteLocalActorImageFile(userAccount, ActorImageType.AVATAR)
 266
 267   return res.status(HttpStatusCode.NO_CONTENT_204).end()
 268 }