]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/controllers/api/users.ts
Add auth documentation
[github/Chocobozzz/PeerTube.git] / server / controllers / api / users.ts
index 981a4706a171c5ef18cb9e5269bdadb7738f4b65..abe6b3ff70282894f3861cf592ed199c6497db27 100644 (file)
-import express = require('express')
-import { waterfall } from 'async'
-
-const db = require('../../initializers/database')
-import { CONFIG, USER_ROLES } from '../../initializers'
-import { logger, getFormatedObjects } from '../../helpers'
+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 { retryTransactionWrapper } from '../../helpers/database-utils'
+import { processImage } from '../../helpers/image-utils'
+import { logger } from '../../helpers/logger'
+import { createReqFiles, 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,
-  ensureIsAdmin,
+  ensureUserHasRight,
+  ensureUserRegistrationAllowed,
+  paginationValidator,
+  setDefaultPagination,
+  setDefaultSort,
+  token,
   usersAddValidator,
-  usersUpdateValidator,
+  usersGetValidator,
+  usersRegisterValidator,
   usersRemoveValidator,
-  usersVideoRatingValidator,
-  paginationValidator,
-  setPagination,
   usersSortValidator,
-  setUsersSort,
-  token
+  usersUpdateMeValidator,
+  usersUpdateValidator,
+  usersVideoRatingValidator
 } from '../../middlewares'
+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'
+
+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()
 
 usersRouter.get('/me',
   authenticate,
-  getUserInformation
+  asyncMiddleware(getUserInformation)
+)
+
+usersRouter.get('/me/video-quota-used',
+  authenticate,
+  asyncMiddleware(getUserVideoQuotaUsed)
+)
+
+usersRouter.get('/me/videos',
+  authenticate,
+  paginationValidator,
+  videosSortValidator,
+  setDefaultSort,
+  setDefaultPagination,
+  asyncMiddleware(getUserVideos)
 )
 
 usersRouter.get('/me/videos/:videoId/rating',
   authenticate,
-  usersVideoRatingValidator,
-  getUserVideoRating
+  asyncMiddleware(usersVideoRatingValidator),
+  asyncMiddleware(getUserVideoRating)
 )
 
 usersRouter.get('/',
+  authenticate,
+  ensureUserHasRight(UserRight.MANAGE_USERS),
   paginationValidator,
   usersSortValidator,
-  setUsersSort,
-  setPagination,
-  listUsers
+  setDefaultSort,
+  setDefaultPagination,
+  asyncMiddleware(listUsers)
+)
+
+usersRouter.get('/:id',
+  authenticate,
+  ensureUserHasRight(UserRight.MANAGE_USERS),
+  asyncMiddleware(usersGetValidator),
+  getUser
 )
 
 usersRouter.post('/',
   authenticate,
-  ensureIsAdmin,
-  usersAddValidator,
-  createUser
+  ensureUserHasRight(UserRight.MANAGE_USERS),
+  asyncMiddleware(usersAddValidator),
+  asyncMiddleware(createUserRetryWrapper)
 )
 
 usersRouter.post('/register',
-  ensureRegistrationEnabled,
-  usersAddValidator,
-  createUser
+  asyncMiddleware(ensureUserRegistrationAllowed),
+  asyncMiddleware(usersRegisterValidator),
+  asyncMiddleware(registerUserRetryWrapper)
+)
+
+usersRouter.put('/me',
+  authenticate,
+  usersUpdateMeValidator,
+  asyncMiddleware(updateMe)
+)
+
+usersRouter.post('/me/avatar/pick',
+  authenticate,
+  reqAvatarFile,
+  usersUpdateMyAvatarValidator,
+  asyncMiddleware(updateMyAvatar)
 )
 
 usersRouter.put('/:id',
   authenticate,
-  usersUpdateValidator,
-  updateUser
+  ensureUserHasRight(UserRight.MANAGE_USERS),
+  asyncMiddleware(usersUpdateValidator),
+  asyncMiddleware(updateUser)
 )
 
 usersRouter.delete('/:id',
   authenticate,
-  ensureIsAdmin,
-  usersRemoveValidator,
-  removeUser
+  ensureUserHasRight(UserRight.MANAGE_USERS),
+  asyncMiddleware(usersRemoveValidator),
+  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
 
 // ---------------------------------------------------------------------------
@@ -76,98 +159,214 @@ export {
 
 // ---------------------------------------------------------------------------
 
-function ensureRegistrationEnabled (req, res, next) {
-  const registrationEnabled = CONFIG.SIGNUP.ENABLED
+async function getUserVideos (req: express.Request, res: express.Response, next: express.NextFunction) {
+  const user = res.locals.oauth.token.User as UserModel
+  const resultList = await VideoModel.listUserVideosForApi(user.id ,req.query.start, req.query.count, req.query.sort)
 
-  if (registrationEnabled === true) {
-    return next()
+  return res.json(getFormattedObjects(resultList.data, resultList.total))
+}
+
+async function createUserRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
+  const options = {
+    arguments: [ req ],
+    errorMessage: 'Cannot insert the user with many retries.'
   }
 
-  return res.status(400).send('User registration is not enabled.')
+  const { user, account } = await retryTransactionWrapper(createUser, options)
+
+  return res.json({
+    user: {
+      id: user.id,
+      uuid: account.uuid
+    }
+  }).end()
 }
 
-function createUser (req, res, next) {
-  const user = db.User.build({
-    username: req.body.username,
-    password: req.body.password,
-    email: req.body.email,
+async function createUser (req: express.Request) {
+  const body: UserCreate = req.body
+  const userToCreate = new UserModel({
+    username: body.username,
+    password: body.password,
+    email: body.email,
     displayNSFW: false,
-    role: USER_ROLES.USER
+    autoPlayVideo: true,
+    role: body.role,
+    videoQuota: body.videoQuota
   })
 
-  user.save().asCallback(function (err, createdUser) {
-    if (err) return next(err)
+  const { user, account } = await createUserAccountAndChannel(userToCreate)
 
-    return res.type('json').status(204).end()
-  })
+  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) {
+  const options = {
+    arguments: [ req ],
+    errorMessage: 'Cannot insert the user with many retries.'
+  }
+
+  await retryTransactionWrapper(registerUser, options)
+
+  return res.type('json').status(204).end()
 }
 
-function getUserInformation (req, res, next) {
-  db.User.loadByUsername(res.locals.oauth.token.user.username, function (err, user) {
-    if (err) return next(err)
+async function registerUser (req: express.Request) {
+  const body: UserCreate = req.body
 
-    return res.json(user.toFormatedJSON())
+  const user = new UserModel({
+    username: body.username,
+    password: body.password,
+    email: body.email,
+    displayNSFW: false,
+    autoPlayVideo: true,
+    role: UserRole.USER,
+    videoQuota: CONFIG.USER.VIDEO_QUOTA
   })
+
+  await createUserAccountAndChannel(user)
+
+  logger.info('User %s with its channel and account registered.', body.username)
 }
 
-function getUserVideoRating (req, res, next) {
-  const videoId = req.params.videoId
-  const userId = res.locals.oauth.token.User.id
+async function getUserInformation (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)
 
-  db.UserVideoRate.load(userId, videoId, function (err, ratingObj) {
-    if (err) return next(err)
+  return res.json(user.toFormattedJSON())
+}
 
-    const rating = ratingObj ? ratingObj.type : 'none'
+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)
 
-    res.json({
-      videoId,
-      rating
-    })
+  return res.json({
+    videoQuotaUsed
   })
 }
 
-function listUsers (req, res, next) {
-  db.User.listForApi(req.query.start, req.query.count, req.query.sort, function (err, usersList, usersTotal) {
-    if (err) return next(err)
+function getUser (req: express.Request, res: express.Response, next: express.NextFunction) {
+  return res.json((res.locals.user as UserModel).toFormattedJSON())
+}
 
-    res.json(getFormatedObjects(usersList, usersTotal))
-  })
+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 AccountVideoRateModel.load(accountId, videoId, null)
+  const rating = ratingObj ? ratingObj.type : 'none'
+
+  const json: FormattedUserVideoRate = {
+    videoId,
+    rating
+  }
+  res.json(json)
 }
 
-function removeUser (req, res, next) {
-  waterfall([
-    function loadUser (callback) {
-      db.User.loadById(req.params.id, callback)
-    },
+async function listUsers (req: express.Request, res: express.Response, next: express.NextFunction) {
+  const resultList = await UserModel.listForApi(req.query.start, req.query.count, req.query.sort)
 
-    function deleteUser (user, callback) {
-      user.destroy().asCallback(callback)
-    }
-  ], function andFinally (err) {
-    if (err) {
-      logger.error('Errors when removed the user.', { error: err })
-      return next(err)
-    }
+  return res.json(getFormattedObjects(resultList.data, resultList.total))
+}
+
+async function removeUser (req: express.Request, res: express.Response, next: express.NextFunction) {
+  const user = await UserModel.loadById(req.params.id)
+
+  await user.destroy()
+
+  return res.sendStatus(204)
+}
+
+async function updateMe (req: express.Request, res: express.Response, next: express.NextFunction) {
+  const body: UserUpdateMe = req.body
+
+  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.autoPlayVideo !== undefined) user.autoPlayVideo = body.autoPlayVideo
+
+  await sequelizeTypescript.transaction(async t => {
+    await user.save({ transaction: t })
+
+    if (body.description !== undefined) user.Account.description = body.description
+    await user.Account.save({ transaction: t })
 
-    return res.sendStatus(204)
+    await sendUpdateActor(user.Account, t)
   })
+
+  return res.sendStatus(204)
 }
 
-function updateUser (req, res, next) {
-  db.User.loadByUsername(res.locals.oauth.token.user.username, function (err, user) {
-    if (err) return next(err)
+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
 
-    if (req.body.password) user.password = req.body.password
-    if (req.body.displayNSFW !== undefined) user.displayNSFW = req.body.displayNSFW
+  const extension = extname(avatarPhysicalFile.filename)
+  const avatarName = uuidv4() + extension
+  const destination = join(CONFIG.STORAGE.AVATARS_DIR, avatarName)
+  await processImage(avatarPhysicalFile, destination, AVATARS_SIZE)
 
-    user.save().asCallback(function (err) {
-      if (err) return next(err)
+  const avatar = await sequelizeTypescript.transaction(async t => {
+    const updatedActor = await updateActorAvatarInstance(actor, avatarName, t)
+    await updatedActor.save({ transaction: t })
 
-      return res.sendStatus(204)
-    })
+    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 = 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
+  if (body.role !== undefined) user.role = body.role
+
+  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, res, next) {
+function success (req: express.Request, res: express.Response, next: express.NextFunction) {
   res.end()
 }