server/controllers/api/users/me.ts

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