PeerTube/server/controllers/api/videos/comment.ts

233 lines
7.2 KiB
TypeScript
Raw Normal View History

2021-08-27 14:32:44 +02:00
import express from 'express'
2021-07-09 14:15:11 +02:00
import { ResultList, ThreadsResultList, UserRight, VideoCommentCreate } from '../../../../shared/models'
2021-07-16 14:27:30 +02:00
import { HttpStatusCode } from '../../../../shared/models/http/http-error-codes'
2021-07-09 14:15:11 +02:00
import { VideoCommentThreads } from '../../../../shared/models/videos/comment/video-comment.model'
2020-05-14 16:56:15 +02:00
import { auditLoggerFactory, CommentAuditView, getAuditIdFromRes } from '../../../helpers/audit-logger'
2017-12-28 11:16:08 +01:00
import { getFormattedObjects } from '../../../helpers/utils'
2020-05-07 14:58:24 +02:00
import { sequelizeTypescript } from '../../../initializers/database'
2020-05-14 16:56:15 +02:00
import { Notifier } from '../../../lib/notifier'
import { Hooks } from '../../../lib/plugins/hooks'
import { buildFormattedCommentTree, createVideoComment, removeComment } from '../../../lib/video-comment'
2018-06-13 14:27:40 +02:00
import {
asyncMiddleware,
asyncRetryTransactionMiddleware,
2019-03-19 10:35:15 +01:00
authenticate,
2020-11-13 16:38:23 +01:00
ensureUserHasRight,
2019-03-19 10:35:15 +01:00
optionalAuthenticate,
2018-06-13 14:27:40 +02:00
paginationValidator,
setDefaultPagination,
setDefaultSort
} from '../../../middlewares'
2017-12-22 10:50:07 +01:00
import {
2018-06-13 14:27:40 +02:00
addVideoCommentReplyValidator,
addVideoCommentThreadValidator,
2020-11-13 16:38:23 +01:00
listVideoCommentsValidator,
2018-06-13 14:27:40 +02:00
listVideoCommentThreadsValidator,
listVideoThreadCommentsValidator,
2018-10-05 11:15:06 +02:00
removeVideoCommentValidator,
2020-11-13 16:38:23 +01:00
videoCommentsValidator,
2018-10-05 11:15:06 +02:00
videoCommentThreadsSortValidator
} from '../../../middlewares/validators'
import { AccountModel } from '../../../models/account/account'
2020-05-14 16:56:15 +02:00
import { VideoCommentModel } from '../../../models/video/video-comment'
2017-12-22 10:50:07 +01:00
const auditLogger = auditLoggerFactory('comments')
2017-12-22 10:50:07 +01:00
const videoCommentRouter = express.Router()
videoCommentRouter.get('/:videoId/comment-threads',
paginationValidator,
videoCommentThreadsSortValidator,
2018-01-17 10:50:33 +01:00
setDefaultSort,
setDefaultPagination,
2017-12-22 10:50:07 +01:00
asyncMiddleware(listVideoCommentThreadsValidator),
optionalAuthenticate,
2017-12-22 10:50:07 +01:00
asyncMiddleware(listVideoThreads)
)
videoCommentRouter.get('/:videoId/comment-threads/:threadId',
asyncMiddleware(listVideoThreadCommentsValidator),
optionalAuthenticate,
2017-12-22 10:50:07 +01:00
asyncMiddleware(listVideoThreadComments)
)
videoCommentRouter.post('/:videoId/comment-threads',
authenticate,
asyncMiddleware(addVideoCommentThreadValidator),
2018-06-13 14:27:40 +02:00
asyncRetryTransactionMiddleware(addVideoCommentThread)
2017-12-22 10:50:07 +01:00
)
videoCommentRouter.post('/:videoId/comments/:commentId',
authenticate,
asyncMiddleware(addVideoCommentReplyValidator),
2018-06-13 14:27:40 +02:00
asyncRetryTransactionMiddleware(addVideoCommentReply)
2017-12-22 10:50:07 +01:00
)
2018-01-04 11:19:16 +01:00
videoCommentRouter.delete('/:videoId/comments/:commentId',
authenticate,
asyncMiddleware(removeVideoCommentValidator),
2018-06-13 14:27:40 +02:00
asyncRetryTransactionMiddleware(removeVideoComment)
2018-01-04 11:19:16 +01:00
)
2017-12-22 10:50:07 +01:00
2020-11-13 16:38:23 +01:00
videoCommentRouter.get('/comments',
authenticate,
ensureUserHasRight(UserRight.SEE_ALL_COMMENTS),
paginationValidator,
videoCommentsValidator,
setDefaultSort,
setDefaultPagination,
listVideoCommentsValidator,
asyncMiddleware(listComments)
)
2017-12-22 10:50:07 +01:00
// ---------------------------------------------------------------------------
export {
videoCommentRouter
}
// ---------------------------------------------------------------------------
2020-11-13 16:38:23 +01:00
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({
total: resultList.total,
data: resultList.data.map(c => c.toFormattedAdminJSON())
})
}
2019-03-19 10:35:15 +01:00
async function listVideoThreads (req: express.Request, res: express.Response) {
2019-08-15 11:53:26 +02:00
const video = res.locals.onlyVideo
2019-03-19 10:35:15 +01:00
const user = res.locals.oauth ? res.locals.oauth.token.User : undefined
let resultList: ThreadsResultList<VideoCommentModel>
2018-01-03 10:12:36 +01:00
if (video.commentsEnabled === true) {
2019-07-18 14:28:37 +02:00
const apiOptions = await Hooks.wrapObject({
videoId: video.id,
isVideoOwned: video.isOwned(),
2019-07-18 14:28:37 +02:00
start: req.query.start,
count: req.query.count,
sort: req.query.sort,
2019-08-15 11:53:26 +02:00
user
2019-07-18 14:28:37 +02:00
}, 'filter:api.video-threads.list.params')
2019-07-19 17:30:41 +02:00
resultList = await Hooks.wrapPromiseFun(
VideoCommentModel.listThreadsForApi,
apiOptions,
2019-07-18 14:28:37 +02:00
'filter:api.video-threads.list.result'
)
2018-01-03 10:12:36 +01:00
} else {
resultList = {
total: 0,
totalNotDeletedComments: 0,
2018-01-03 10:12:36 +01:00
data: []
}
}
2017-12-22 10:50:07 +01:00
return res.json({
...getFormattedObjects(resultList.data, resultList.total),
totalNotDeletedComments: resultList.totalNotDeletedComments
2021-07-09 14:15:11 +02:00
} as VideoCommentThreads)
2017-12-22 10:50:07 +01:00
}
2019-03-19 10:35:15 +01:00
async function listVideoThreadComments (req: express.Request, res: express.Response) {
2019-08-15 11:53:26 +02:00
const video = res.locals.onlyVideo
2019-03-19 10:35:15 +01:00
const user = res.locals.oauth ? res.locals.oauth.token.User : undefined
2018-01-03 10:12:36 +01:00
let resultList: ResultList<VideoCommentModel>
if (video.commentsEnabled === true) {
2019-07-18 14:28:37 +02:00
const apiOptions = await Hooks.wrapObject({
videoId: video.id,
isVideoOwned: video.isOwned(),
2019-07-18 14:28:37 +02:00
threadId: res.locals.videoCommentThread.id,
2019-07-22 11:14:58 +02:00
user
2019-07-18 14:28:37 +02:00
}, 'filter:api.video-thread-comments.list.params')
2019-07-19 17:30:41 +02:00
resultList = await Hooks.wrapPromiseFun(
VideoCommentModel.listThreadCommentsForApi,
apiOptions,
2019-07-18 14:28:37 +02:00
'filter:api.video-thread-comments.list.result'
)
2018-01-03 10:12:36 +01:00
} else {
resultList = {
total: 0,
data: []
}
}
2017-12-22 10:50:07 +01:00
2020-11-27 11:48:20 +01:00
if (resultList.data.length === 0) {
return res.fail({
status: HttpStatusCode.NOT_FOUND_404,
message: 'No comments were found'
})
2020-11-27 11:48:20 +01:00
}
2017-12-22 10:50:07 +01:00
return res.json(buildFormattedCommentTree(resultList))
}
2018-06-13 14:27:40 +02:00
async function addVideoCommentThread (req: express.Request, res: express.Response) {
2017-12-22 10:50:07 +01:00
const videoCommentInfo: VideoCommentCreate = req.body
2018-06-13 14:27:40 +02:00
const comment = await sequelizeTypescript.transaction(async t => {
2019-03-19 10:35:15 +01:00
const account = await AccountModel.load(res.locals.oauth.token.User.Account.id, t)
2017-12-22 10:50:07 +01:00
return createVideoComment({
text: videoCommentInfo.text,
inReplyToComment: null,
2019-08-15 11:53:26 +02:00
video: res.locals.videoAll,
account
2017-12-22 10:50:07 +01:00
}, t)
})
2018-12-26 10:36:24 +01:00
Notifier.Instance.notifyOnNewComment(comment)
2018-09-19 17:02:16 +02:00
auditLogger.create(getAuditIdFromRes(res), new CommentAuditView(comment.toFormattedJSON()))
Hooks.runAction('action:api.video-thread.created', { comment, req, res })
2019-07-18 14:28:37 +02:00
2020-05-14 16:56:15 +02:00
return res.json({ comment: comment.toFormattedJSON() })
2017-12-22 10:50:07 +01:00
}
2018-06-13 14:27:40 +02:00
async function addVideoCommentReply (req: express.Request, res: express.Response) {
2017-12-22 10:50:07 +01:00
const videoCommentInfo: VideoCommentCreate = req.body
2018-06-13 14:27:40 +02:00
const comment = await sequelizeTypescript.transaction(async t => {
2019-03-19 10:35:15 +01:00
const account = await AccountModel.load(res.locals.oauth.token.User.Account.id, t)
2017-12-22 10:50:07 +01:00
return createVideoComment({
text: videoCommentInfo.text,
2019-08-15 11:53:26 +02:00
inReplyToComment: res.locals.videoCommentFull,
video: res.locals.videoAll,
account
2017-12-22 10:50:07 +01:00
}, t)
})
2018-01-04 11:19:16 +01:00
2018-12-26 10:36:24 +01:00
Notifier.Instance.notifyOnNewComment(comment)
2018-09-19 17:02:16 +02:00
auditLogger.create(getAuditIdFromRes(res), new CommentAuditView(comment.toFormattedJSON()))
Hooks.runAction('action:api.video-comment-reply.created', { comment, req, res })
2019-07-18 14:28:37 +02:00
2020-05-14 16:56:15 +02:00
return res.json({ comment: comment.toFormattedJSON() })
2018-01-04 11:19:16 +01:00
}
async function removeVideoComment (req: express.Request, res: express.Response) {
2019-08-15 11:53:26 +02:00
const videoCommentInstance = res.locals.videoCommentFull
await removeComment(videoCommentInstance, req, res)
2018-01-04 11:19:16 +01:00
2019-07-18 14:28:37 +02:00
auditLogger.delete(getAuditIdFromRes(res), new CommentAuditView(videoCommentInstance.toFormattedJSON()))
return res.type('json')
.status(HttpStatusCode.NO_CONTENT_204)
.end()
2018-01-04 11:19:16 +01:00
}