]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/controllers/api/users.ts
Add ability to update the user display name/description
[github/Chocobozzz/PeerTube.git] / server / controllers / api / users.ts
index f9b871724176dd74827764d659a4c2ff24576ab7..2342c23dd683b809ba9db028907033cb382ed04d 100644 (file)
@@ -1,16 +1,27 @@
 import * as express from 'express'
+import 'multer'
+import { extname, join } from 'path'
+import * as uuidv4 from 'uuid/v4'
+import * as RateLimit from 'express-rate-limit'
 import { UserCreate, UserRight, UserRole, UserUpdate, UserUpdateMe, UserVideoRate as FormattedUserVideoRate } from '../../../shared'
-import { getFormattedObjects, logger, retryTransactionWrapper } from '../../helpers'
-import { CONFIG, database as db } from '../../initializers'
-import { createUserAccountAndChannel } from '../../lib'
+import { retryTransactionWrapper } from '../../helpers/database-utils'
+import { processImage } from '../../helpers/image-utils'
+import { logger } from '../../helpers/logger'
+import { getFormattedObjects } from '../../helpers/utils'
+import { AVATARS_SIZE, CONFIG, IMAGE_MIMETYPE_EXT, RATES_LIMIT, sequelizeTypescript } from '../../initializers'
+import { updateActorAvatarInstance } from '../../lib/activitypub'
+import { sendUpdateActor } from '../../lib/activitypub/send'
+import { Emailer } from '../../lib/emailer'
+import { Redis } from '../../lib/redis'
+import { createUserAccountAndChannel } from '../../lib/user'
 import {
   asyncMiddleware,
   authenticate,
   ensureUserHasRight,
   ensureUserRegistrationAllowed,
   paginationValidator,
-  setPagination,
-  setUsersSort,
+  setDefaultPagination,
+  setDefaultSort,
   token,
   usersAddValidator,
   usersGetValidator,
@@ -21,9 +32,25 @@ import {
   usersUpdateValidator,
   usersVideoRatingValidator
 } from '../../middlewares'
-import { setVideosSort } from '../../middlewares/sort'
-import { videosSortValidator } from '../../middlewares/validators/sort'
-import { UserInstance } from '../../models'
+import {
+  usersAskResetPasswordValidator,
+  usersResetPasswordValidator,
+  usersUpdateMyAvatarValidator,
+  videosSortValidator
+} from '../../middlewares/validators'
+import { AccountVideoRateModel } from '../../models/account/account-video-rate'
+import { UserModel } from '../../models/account/user'
+import { OAuthTokenModel } from '../../models/oauth/oauth-token'
+import { VideoModel } from '../../models/video/video'
+import { VideoSortField } from '../../../client/src/app/shared/video/sort-field.type'
+import { createReqFiles } from '../../helpers/express-utils'
+
+const reqAvatarFile = createReqFiles([ 'avatarfile' ], IMAGE_MIMETYPE_EXT, { avatarfile: CONFIG.STORAGE.AVATARS_DIR })
+const loginRateLimiter = new RateLimit({
+  windowMs: RATES_LIMIT.LOGIN.WINDOW_MS,
+  max: RATES_LIMIT.LOGIN.MAX,
+  delayMs: 0
+})
 
 const usersRouter = express.Router()
 
@@ -32,12 +59,17 @@ usersRouter.get('/me',
   asyncMiddleware(getUserInformation)
 )
 
+usersRouter.get('/me/video-quota-used',
+  authenticate,
+  asyncMiddleware(getUserVideoQuotaUsed)
+)
+
 usersRouter.get('/me/videos',
   authenticate,
   paginationValidator,
   videosSortValidator,
-  setVideosSort,
-  setPagination,
+  setDefaultSort,
+  setDefaultPagination,
   asyncMiddleware(getUserVideos)
 )
 
@@ -52,12 +84,14 @@ usersRouter.get('/',
   ensureUserHasRight(UserRight.MANAGE_USERS),
   paginationValidator,
   usersSortValidator,
-  setUsersSort,
-  setPagination,
+  setDefaultSort,
+  setDefaultPagination,
   asyncMiddleware(listUsers)
 )
 
 usersRouter.get('/:id',
+  authenticate,
+  ensureUserHasRight(UserRight.MANAGE_USERS),
   asyncMiddleware(usersGetValidator),
   getUser
 )
@@ -81,6 +115,13 @@ usersRouter.put('/me',
   asyncMiddleware(updateMe)
 )
 
+usersRouter.post('/me/avatar/pick',
+  authenticate,
+  reqAvatarFile,
+  usersUpdateMyAvatarValidator,
+  asyncMiddleware(updateMyAvatar)
+)
+
 usersRouter.put('/:id',
   authenticate,
   ensureUserHasRight(UserRight.MANAGE_USERS),
@@ -95,7 +136,21 @@ usersRouter.delete('/:id',
   asyncMiddleware(removeUser)
 )
 
-usersRouter.post('/token', token, success)
+usersRouter.post('/ask-reset-password',
+  asyncMiddleware(usersAskResetPasswordValidator),
+  asyncMiddleware(askResetUserPassword)
+)
+
+usersRouter.post('/:id/reset-password',
+  asyncMiddleware(usersResetPasswordValidator),
+  asyncMiddleware(resetUserPassword)
+)
+
+usersRouter.post('/token',
+  loginRateLimiter,
+  token,
+  success
+)
 // TODO: Once https://github.com/oauthjs/node-oauth2-server/pull/289 is merged, implement revoke token route
 
 // ---------------------------------------------------------------------------
@@ -107,8 +162,14 @@ export {
 // ---------------------------------------------------------------------------
 
 async function getUserVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
-  const user = res.locals.oauth.token.User
-  const resultList = await db.Video.listUserVideosForApi(user.id ,req.query.start, req.query.count, req.query.sort)
+  const user = res.locals.oauth.token.User as UserModel
+  const resultList = await VideoModel.listAccountVideosForApi(
+    user.Account.id,
+    req.query.start as number,
+    req.query.count as number,
+    req.query.sort as VideoSortField,
+    false // Display my NSFW videos
+  )
 
   return res.json(getFormattedObjects(resultList.data, resultList.total))
 }
@@ -119,26 +180,36 @@ async function createUserRetryWrapper (req: express.Request, res: express.Respon
     errorMessage: 'Cannot insert the user with many retries.'
   }
 
-  await retryTransactionWrapper(createUser, options)
-
-  // TODO : include Location of the new user -> 201
-  return res.type('json').status(204).end()
+  const { user, account } = await retryTransactionWrapper(createUser, options)
+
+  return res.json({
+    user: {
+      id: user.id,
+      account: {
+        id: account.id,
+        uuid: account.Actor.uuid
+      }
+    }
+  }).end()
 }
 
 async function createUser (req: express.Request) {
   const body: UserCreate = req.body
-  const user = db.User.build({
+  const userToCreate = new UserModel({
     username: body.username,
     password: body.password,
     email: body.email,
-    displayNSFW: false,
+    nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
+    autoPlayVideo: true,
     role: body.role,
     videoQuota: body.videoQuota
   })
 
-  await createUserAccountAndChannel(user)
+  const { user, account } = await createUserAccountAndChannel(userToCreate)
 
   logger.info('User %s with its channel and account created.', body.username)
+
+  return { user, account }
 }
 
 async function registerUserRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
@@ -155,11 +226,12 @@ async function registerUserRetryWrapper (req: express.Request, res: express.Resp
 async function registerUser (req: express.Request) {
   const body: UserCreate = req.body
 
-  const user = db.User.build({
+  const user = new UserModel({
     username: body.username,
     password: body.password,
     email: body.email,
-    displayNSFW: false,
+    nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
+    autoPlayVideo: true,
     role: UserRole.USER,
     videoQuota: CONFIG.USER.VIDEO_QUOTA
   })
@@ -171,20 +243,30 @@ async function registerUser (req: express.Request) {
 
 async function getUserInformation (req: express.Request, res: express.Response, next: express.NextFunction) {
   // We did not load channels in res.locals.user
-  const user = await db.User.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
+  const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
 
   return res.json(user.toFormattedJSON())
 }
 
+async function getUserVideoQuotaUsed (req: express.Request, res: express.Response, next: express.NextFunction) {
+  // We did not load channels in res.locals.user
+  const user = await UserModel.loadByUsernameAndPopulateChannels(res.locals.oauth.token.user.username)
+  const videoQuotaUsed = await UserModel.getOriginalVideoFileTotalFromUser(user)
+
+  return res.json({
+    videoQuotaUsed
+  })
+}
+
 function getUser (req: express.Request, res: express.Response, next: express.NextFunction) {
-  return res.json(res.locals.user.toFormattedJSON())
+  return res.json((res.locals.user as UserModel).toFormattedJSON())
 }
 
 async function getUserVideoRating (req: express.Request, res: express.Response, next: express.NextFunction) {
   const videoId = +req.params.videoId
   const accountId = +res.locals.oauth.token.User.Account.id
 
-  const ratingObj = await db.AccountVideoRate.load(accountId, videoId, null)
+  const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
   const rating = ratingObj ? ratingObj.type : 'none'
 
   const json: FormattedUserVideoRate = {
@@ -195,13 +277,13 @@ async function getUserVideoRating (req: express.Request, res: express.Response,
 }
 
 async function listUsers (req: express.Request, res: express.Response, next: express.NextFunction) {
-  const resultList = await db.User.listForApi(req.query.start, req.query.count, req.query.sort)
+  const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort)
 
   return res.json(getFormattedObjects(resultList.data, resultList.total))
 }
 
 async function removeUser (req: express.Request, res: express.Response, next: express.NextFunction) {
-  const user = await db.User.loadById(req.params.id)
+  const user = await UserModel.loadById(req.params.id)
 
   await user.destroy()
 
@@ -211,21 +293,56 @@ async function removeUser (req: express.Request, res: express.Response, next: ex
 async function updateMe (req: express.Request, res: express.Response, next: express.NextFunction) {
   const body: UserUpdateMe = req.body
 
-  // FIXME: user is not already a Sequelize instance?
-  const user = res.locals.oauth.token.user
+  const user: UserModel = res.locals.oauth.token.user
 
   if (body.password !== undefined) user.password = body.password
   if (body.email !== undefined) user.email = body.email
-  if (body.displayNSFW !== undefined) user.displayNSFW = body.displayNSFW
+  if (body.nsfwPolicy !== undefined) user.nsfwPolicy = body.nsfwPolicy
+  if (body.autoPlayVideo !== undefined) user.autoPlayVideo = body.autoPlayVideo
 
-  await user.save()
+  await sequelizeTypescript.transaction(async t => {
+    await user.save({ transaction: t })
+
+    if (body.displayName !== undefined) user.Account.name = body.displayName
+    if (body.description !== undefined) user.Account.description = body.description
+    await user.Account.save({ transaction: t })
+
+    await sendUpdateActor(user.Account, t)
+  })
 
   return res.sendStatus(204)
 }
 
+async function updateMyAvatar (req: express.Request, res: express.Response, next: express.NextFunction) {
+  const avatarPhysicalFile = req.files['avatarfile'][0]
+  const user = res.locals.oauth.token.user
+  const actor = user.Account.Actor
+
+  const extension = extname(avatarPhysicalFile.filename)
+  const avatarName = uuidv4() + extension
+  const destination = join(CONFIG.STORAGE.AVATARS_DIR, avatarName)
+  await processImage(avatarPhysicalFile, destination, AVATARS_SIZE)
+
+  const avatar = await sequelizeTypescript.transaction(async t => {
+    const updatedActor = await updateActorAvatarInstance(actor, avatarName, t)
+    await updatedActor.save({ transaction: t })
+
+    await sendUpdateActor(user.Account, t)
+
+    return updatedActor.Avatar
+  })
+
+  return res
+    .json({
+      avatar: avatar.toFormattedJSON()
+    })
+    .end()
+}
+
 async function updateUser (req: express.Request, res: express.Response, next: express.NextFunction) {
   const body: UserUpdate = req.body
-  const user: UserInstance = res.locals.user
+  const user = res.locals.user as UserModel
+  const roleChanged = body.role !== undefined && body.role !== user.role
 
   if (body.email !== undefined) user.email = body.email
   if (body.videoQuota !== undefined) user.videoQuota = body.videoQuota
@@ -233,9 +350,35 @@ async function updateUser (req: express.Request, res: express.Response, next: ex
 
   await user.save()
 
+  // Destroy user token to refresh rights
+  if (roleChanged) {
+    await OAuthTokenModel.deleteUserToken(user.id)
+  }
+
+  // Don't need to send this update to followers, these attributes are not propagated
+
   return res.sendStatus(204)
 }
 
+async function askResetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
+  const user = res.locals.user as UserModel
+
+  const verificationString = await Redis.Instance.setResetPasswordVerificationString(user.id)
+  const url = CONFIG.WEBSERVER.URL + '/reset-password?userId=' + user.id + '&verificationString=' + verificationString
+  await Emailer.Instance.addForgetPasswordEmailJob(user.email, url)
+
+  return res.status(204).end()
+}
+
+async function resetUserPassword (req: express.Request, res: express.Response, next: express.NextFunction) {
+  const user = res.locals.user as UserModel
+  user.password = req.body.password
+
+  await user.save()
+
+  return res.status(204).end()
+}
+
 function success (req: express.Request, res: express.Response, next: express.NextFunction) {
   res.end()
 }