]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/controllers/api/videos/comment.ts
refactor API errors to standard error format
[github/Chocobozzz/PeerTube.git] / server / controllers / api / videos / comment.ts
index b11da2ef736dabfcf0c7a6030acc2caceb79ceba..e6f28c1cb058a4bf1e755d8ed0867fbf949dded6 100644 (file)
@@ -1,41 +1,79 @@
 import * as express from 'express'
-import { VideoCommentCreate } from '../../../../shared/models/videos/video-comment.model'
-import { retryTransactionWrapper } from '../../../helpers/database-utils'
+import { HttpStatusCode } from '../../../../shared/core-utils/miscs/http-error-codes'
+import { ResultList, ThreadsResultList, UserRight } from '../../../../shared/models'
+import { VideoCommentCreate } from '../../../../shared/models/videos/comment/video-comment.model'
+import { auditLoggerFactory, CommentAuditView, getAuditIdFromRes } from '../../../helpers/audit-logger'
 import { getFormattedObjects } from '../../../helpers/utils'
-import { sequelizeTypescript } from '../../../initializers'
-import { buildFormattedCommentTree, createVideoComment } from '../../../lib/video-comment'
-import { asyncMiddleware, authenticate, paginationValidator, setPagination, setVideoCommentThreadsSort } from '../../../middlewares'
-import { videoCommentThreadsSortValidator } from '../../../middlewares/validators'
+import { sequelizeTypescript } from '../../../initializers/database'
+import { Notifier } from '../../../lib/notifier'
+import { Hooks } from '../../../lib/plugins/hooks'
+import { buildFormattedCommentTree, createVideoComment, removeComment } from '../../../lib/video-comment'
 import {
-  addVideoCommentReplyValidator, addVideoCommentThreadValidator, listVideoCommentThreadsValidator,
-  listVideoThreadCommentsValidator
-} from '../../../middlewares/validators/video-comments'
+  asyncMiddleware,
+  asyncRetryTransactionMiddleware,
+  authenticate,
+  ensureUserHasRight,
+  optionalAuthenticate,
+  paginationValidator,
+  setDefaultPagination,
+  setDefaultSort
+} from '../../../middlewares'
+import {
+  addVideoCommentReplyValidator,
+  addVideoCommentThreadValidator,
+  listVideoCommentsValidator,
+  listVideoCommentThreadsValidator,
+  listVideoThreadCommentsValidator,
+  removeVideoCommentValidator,
+  videoCommentsValidator,
+  videoCommentThreadsSortValidator
+} from '../../../middlewares/validators'
+import { AccountModel } from '../../../models/account/account'
 import { VideoCommentModel } from '../../../models/video/video-comment'
 
+const auditLogger = auditLoggerFactory('comments')
 const videoCommentRouter = express.Router()
 
 videoCommentRouter.get('/:videoId/comment-threads',
   paginationValidator,
   videoCommentThreadsSortValidator,
-  setVideoCommentThreadsSort,
-  setPagination,
+  setDefaultSort,
+  setDefaultPagination,
   asyncMiddleware(listVideoCommentThreadsValidator),
+  optionalAuthenticate,
   asyncMiddleware(listVideoThreads)
 )
 videoCommentRouter.get('/:videoId/comment-threads/:threadId',
   asyncMiddleware(listVideoThreadCommentsValidator),
+  optionalAuthenticate,
   asyncMiddleware(listVideoThreadComments)
 )
 
 videoCommentRouter.post('/:videoId/comment-threads',
   authenticate,
   asyncMiddleware(addVideoCommentThreadValidator),
-  asyncMiddleware(addVideoCommentThreadRetryWrapper)
+  asyncRetryTransactionMiddleware(addVideoCommentThread)
 )
 videoCommentRouter.post('/:videoId/comments/:commentId',
   authenticate,
   asyncMiddleware(addVideoCommentReplyValidator),
-  asyncMiddleware(addVideoCommentReplyRetryWrapper)
+  asyncRetryTransactionMiddleware(addVideoCommentReply)
+)
+videoCommentRouter.delete('/:videoId/comments/:commentId',
+  authenticate,
+  asyncMiddleware(removeVideoCommentValidator),
+  asyncRetryTransactionMiddleware(removeVideoComment)
+)
+
+videoCommentRouter.get('/comments',
+  authenticate,
+  ensureUserHasRight(UserRight.SEE_ALL_COMMENTS),
+  paginationValidator,
+  videoCommentsValidator,
+  setDefaultSort,
+  setDefaultPagination,
+  listVideoCommentsValidator,
+  asyncMiddleware(listComments)
 )
 
 // ---------------------------------------------------------------------------
@@ -46,66 +84,149 @@ export {
 
 // ---------------------------------------------------------------------------
 
-async function listVideoThreads (req: express.Request, res: express.Response, next: express.NextFunction) {
-  const resultList = await VideoCommentModel.listThreadsForApi(res.locals.video.id, req.query.start, req.query.count, req.query.sort)
+async function listComments (req: express.Request, res: express.Response) {
+  const options = {
+    start: req.query.start,
+    count: req.query.count,
+    sort: req.query.sort,
+
+    isLocal: req.query.isLocal,
+    search: req.query.search,
+    searchAccount: req.query.searchAccount,
+    searchVideo: req.query.searchVideo
+  }
+
+  const resultList = await VideoCommentModel.listCommentsForApi(options)
 
-  return res.json(getFormattedObjects(resultList.data, resultList.total))
+  return res.json({
+    total: resultList.total,
+    data: resultList.data.map(c => c.toFormattedAdminJSON())
+  })
 }
 
-async function listVideoThreadComments (req: express.Request, res: express.Response, next: express.NextFunction) {
-  const resultList = await VideoCommentModel.listThreadCommentsForApi(res.locals.video.id, res.locals.videoCommentThread.id)
+async function listVideoThreads (req: express.Request, res: express.Response) {
+  const video = res.locals.onlyVideo
+  const user = res.locals.oauth ? res.locals.oauth.token.User : undefined
+
+  let resultList: ThreadsResultList<VideoCommentModel>
+
+  if (video.commentsEnabled === true) {
+    const apiOptions = await Hooks.wrapObject({
+      videoId: video.id,
+      isVideoOwned: video.isOwned(),
+      start: req.query.start,
+      count: req.query.count,
+      sort: req.query.sort,
+      user
+    }, 'filter:api.video-threads.list.params')
+
+    resultList = await Hooks.wrapPromiseFun(
+      VideoCommentModel.listThreadsForApi,
+      apiOptions,
+      'filter:api.video-threads.list.result'
+    )
+  } else {
+    resultList = {
+      total: 0,
+      totalNotDeletedComments: 0,
+      data: []
+    }
+  }
 
-  return res.json(buildFormattedCommentTree(resultList))
+  return res.json({
+    ...getFormattedObjects(resultList.data, resultList.total),
+    totalNotDeletedComments: resultList.totalNotDeletedComments
+  })
 }
 
-async function addVideoCommentThreadRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
-  const options = {
-    arguments: [ req, res ],
-    errorMessage: 'Cannot insert the video comment thread with many retries.'
+async function listVideoThreadComments (req: express.Request, res: express.Response) {
+  const video = res.locals.onlyVideo
+  const user = res.locals.oauth ? res.locals.oauth.token.User : undefined
+
+  let resultList: ResultList<VideoCommentModel>
+
+  if (video.commentsEnabled === true) {
+    const apiOptions = await Hooks.wrapObject({
+      videoId: video.id,
+      isVideoOwned: video.isOwned(),
+      threadId: res.locals.videoCommentThread.id,
+      user
+    }, 'filter:api.video-thread-comments.list.params')
+
+    resultList = await Hooks.wrapPromiseFun(
+      VideoCommentModel.listThreadCommentsForApi,
+      apiOptions,
+      'filter:api.video-thread-comments.list.result'
+    )
+  } else {
+    resultList = {
+      total: 0,
+      data: []
+    }
   }
 
-  const comment = await retryTransactionWrapper(addVideoCommentThread, options)
+  if (resultList.data.length === 0) {
+    return res.fail({
+      status: HttpStatusCode.NOT_FOUND_404,
+      message: 'No comments were found'
+    })
+  }
 
-  res.json({
-    comment: comment.toFormattedJSON()
-  }).end()
+  return res.json(buildFormattedCommentTree(resultList))
 }
 
-function addVideoCommentThread (req: express.Request, res: express.Response) {
+async function addVideoCommentThread (req: express.Request, res: express.Response) {
   const videoCommentInfo: VideoCommentCreate = req.body
 
-  return sequelizeTypescript.transaction(async t => {
+  const comment = await sequelizeTypescript.transaction(async t => {
+    const account = await AccountModel.load(res.locals.oauth.token.User.Account.id, t)
+
     return createVideoComment({
       text: videoCommentInfo.text,
       inReplyToComment: null,
-      video: res.locals.video,
-      account: res.locals.oauth.token.User.Account
+      video: res.locals.videoAll,
+      account
     }, t)
   })
-}
 
-async function addVideoCommentReplyRetryWrapper (req: express.Request, res: express.Response, next: express.NextFunction) {
-  const options = {
-    arguments: [ req, res ],
-    errorMessage: 'Cannot insert the video comment reply with many retries.'
-  }
+  Notifier.Instance.notifyOnNewComment(comment)
+  auditLogger.create(getAuditIdFromRes(res), new CommentAuditView(comment.toFormattedJSON()))
 
-  const comment = await retryTransactionWrapper(addVideoCommentReply, options)
+  Hooks.runAction('action:api.video-thread.created', { comment })
 
-  res.json({
-    comment: comment.toFormattedJSON()
-  }).end()
+  return res.json({ comment: comment.toFormattedJSON() })
 }
 
-function addVideoCommentReply (req: express.Request, res: express.Response, next: express.NextFunction) {
+async function addVideoCommentReply (req: express.Request, res: express.Response) {
   const videoCommentInfo: VideoCommentCreate = req.body
 
-  return sequelizeTypescript.transaction(async t => {
+  const comment = await sequelizeTypescript.transaction(async t => {
+    const account = await AccountModel.load(res.locals.oauth.token.User.Account.id, t)
+
     return createVideoComment({
       text: videoCommentInfo.text,
-      inReplyToComment: res.locals.videoComment,
-      video: res.locals.video,
-      account: res.locals.oauth.token.User.Account
+      inReplyToComment: res.locals.videoCommentFull,
+      video: res.locals.videoAll,
+      account
     }, t)
   })
+
+  Notifier.Instance.notifyOnNewComment(comment)
+  auditLogger.create(getAuditIdFromRes(res), new CommentAuditView(comment.toFormattedJSON()))
+
+  Hooks.runAction('action:api.video-comment-reply.created', { comment })
+
+  return res.json({ comment: comment.toFormattedJSON() })
+}
+
+async function removeVideoComment (req: express.Request, res: express.Response) {
+  const videoCommentInstance = res.locals.videoCommentFull
+
+  await removeComment(videoCommentInstance)
+
+  auditLogger.delete(getAuditIdFromRes(res), new CommentAuditView(videoCommentInstance.toFormattedJSON()))
+
+  return res.type('json')
+            .status(HttpStatusCode.NO_CONTENT_204)
+            .end()
 }