server/controllers/api/users/me.ts

   1 import 'multer'
   2 import * as express from 'express'
   3 import { auditLoggerFactory, getAuditIdFromRes, UserAuditView } from '@server/helpers/audit-logger'
   4 import { Hooks } from '@server/lib/plugins/hooks'
   5 import { ActorImageType, UserUpdateMe, UserVideoRate as FormattedUserVideoRate } from '../../../../shared'
   6 import { HttpStatusCode } from '../../../../shared/core-utils/miscs/http-error-codes'
   7 import { UserVideoQuota } from '../../../../shared/models/users/user-video-quota.model'
   8 import { createReqFiles } from '../../../helpers/express-utils'
   9 import { getFormattedObjects } from '../../../helpers/utils'
  10 import { CONFIG } from '../../../initializers/config'
  11 import { MIMETYPES } from '../../../initializers/constants'
  12 import { sequelizeTypescript } from '../../../initializers/database'
  13 import { sendUpdateActor } from '../../../lib/activitypub/send'
  14 import { deleteLocalActorImageFile, updateLocalActorImageFile } from '../../../lib/actor-image'
  15 import { getOriginalVideoFileTotalDailyFromUser, getOriginalVideoFileTotalFromUser, sendVerifyUserEmail } from '../../../lib/user'
  16 import {
  17   asyncMiddleware,
  18   asyncRetryTransactionMiddleware,
  19   authenticate,
  20   paginationValidator,
  21   setDefaultPagination,
  22   setDefaultSort,
  23   setDefaultVideosSort,
  24   usersUpdateMeValidator,
  25   usersVideoRatingValidator
  26 } from '../../../middlewares'
  27 import { deleteMeValidator, videoImportsSortValidator, videosSortValidator } from '../../../middlewares/validators'
  28 import { updateAvatarValidator } from '../../../middlewares/validators/actor-image'
  29 import { AccountModel } from '../../../models/account/account'
  30 import { AccountVideoRateModel } from '../../../models/account/account-video-rate'
  31 import { UserModel } from '../../../models/user/user'
  32 import { VideoModel } from '../../../models/video/video'
  33 import { VideoImportModel } from '../../../models/video/video-import'
  34 import { AttributesOnly } from '@shared/core-utils'
  35
  36 const auditLogger = auditLoggerFactory('users')
  37
  38 const reqAvatarFile = createReqFiles([ 'avatarfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT, { avatarfile: CONFIG.STORAGE.TMP_DIR })
  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(getUserVideos)
  73 )
  74
  75 meRouter.get('/me/videos/:videoId/rating',
  76   authenticate,
  77   asyncMiddleware(usersVideoRatingValidator),
  78   asyncMiddleware(getUserVideoRating)
  79 )
  80
  81 meRouter.put('/me',
  82   authenticate,
  83   asyncMiddleware(usersUpdateMeValidator),
  84   asyncRetryTransactionMiddleware(updateMe)
  85 )
  86
  87 meRouter.post('/me/avatar/pick',
  88   authenticate,
  89   reqAvatarFile,
  90   updateAvatarValidator,
  91   asyncRetryTransactionMiddleware(updateMyAvatar)
  92 )
  93
  94 meRouter.delete('/me/avatar',
  95   authenticate,
  96   asyncRetryTransactionMiddleware(deleteMyAvatar)
  97 )
  98
  99 // ---------------------------------------------------------------------------
 100
 101 export {
 102   meRouter
 103 }
 104
 105 // ---------------------------------------------------------------------------
 106
 107 async function getUserVideos (req: express.Request, res: express.Response) {
 108   const user = res.locals.oauth.token.User
 109
 110   const apiOptions = await Hooks.wrapObject({
 111     accountId: user.Account.id,
 112     start: req.query.start,
 113     count: req.query.count,
 114     sort: req.query.sort,
 115     search: req.query.search,
 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     'webTorrentEnabled',
 199     'autoPlayVideo',
 200     'autoPlayNextVideo',
 201     'autoPlayNextVideoPlaylist',
 202     'videosHistoryEnabled',
 203     'videoLanguages',
 204     'theme',
 205     'noInstanceConfigWarningModal',
 206     'noWelcomeModal'
 207   ]
 208
 209   for (const key of keysToUpdate) {
 210     if (body[key] !== undefined) user.set(key, body[key])
 211   }
 212
 213   if (body.email !== undefined) {
 214     if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
 215       user.pendingEmail = body.email
 216       sendVerificationEmail = true
 217     } else {
 218       user.email = body.email
 219     }
 220   }
 221
 222   await sequelizeTypescript.transaction(async t => {
 223     await user.save({ transaction: t })
 224
 225     if (body.displayName === undefined && body.description === undefined) return
 226
 227     const userAccount = await AccountModel.load(user.Account.id, t)
 228
 229     if (body.displayName !== undefined) userAccount.name = body.displayName
 230     if (body.description !== undefined) userAccount.description = body.description
 231     await userAccount.save({ transaction: t })
 232
 233     await sendUpdateActor(userAccount, t)
 234   })
 235
 236   if (sendVerificationEmail === true) {
 237     await sendVerifyUserEmail(user, true)
 238   }
 239
 240   return res.status(HttpStatusCode.NO_CONTENT_204).end()
 241 }
 242
 243 async function updateMyAvatar (req: express.Request, res: express.Response) {
 244   const avatarPhysicalFile = req.files['avatarfile'][0]
 245   const user = res.locals.oauth.token.user
 246
 247   const userAccount = await AccountModel.load(user.Account.id)
 248
 249   const avatar = await updateLocalActorImageFile(userAccount, avatarPhysicalFile, ActorImageType.AVATAR)
 250
 251   return res.json({ avatar: avatar.toFormattedJSON() })
 252 }
 253
 254 async function deleteMyAvatar (req: express.Request, res: express.Response) {
 255   const user = res.locals.oauth.token.user
 256
 257   const userAccount = await AccountModel.load(user.Account.id)
 258   await deleteLocalActorImageFile(userAccount, ActorImageType.AVATAR)
 259
 260   return res.status(HttpStatusCode.NO_CONTENT_204).end()
 261 }