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