14 } from 'sequelize-typescript'
15 import { ActivityTagObject } from '../../../shared/models/activitypub/objects/common-objects'
16 import { VideoCommentObject } from '../../../shared/models/activitypub/objects/video-comment-object'
17 import { VideoComment } from '../../../shared/models/videos/video-comment.model'
18 import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
19 import { CONSTRAINTS_FIELDS, WEBSERVER } from '../../initializers/constants'
20 import { sendDeleteVideoComment } from '../../lib/activitypub/send'
21 import { AccountModel } from '../account/account'
22 import { ActorModel } from '../activitypub/actor'
23 import { AvatarModel } from '../avatar/avatar'
24 import { ServerModel } from '../server/server'
25 import { buildBlockedAccountSQL, getSort, throwIfNotValid } from '../utils'
26 import { VideoModel } from './video'
27 import { VideoChannelModel } from './video-channel'
28 import { getServerActor } from '../../helpers/utils'
29 import { UserModel } from '../account/user'
30 import { actorNameAlphabet } from '../../helpers/custom-validators/activitypub/actor'
31 import { regexpCapture } from '../../helpers/regexp'
32 import { uniq } from 'lodash'
33 import { FindOptions, Op, Order, ScopeOptions, Sequelize, Transaction } from 'sequelize'
36 WITH_ACCOUNT = 'WITH_ACCOUNT',
37 WITH_IN_REPLY_TO = 'WITH_IN_REPLY_TO',
38 WITH_VIDEO = 'WITH_VIDEO',
39 ATTRIBUTES_FOR_API = 'ATTRIBUTES_FOR_API'
43 [ScopeNames.ATTRIBUTES_FOR_API]: (serverAccountId: number, userAccountId?: number) => {
50 'WITH "blocklist" AS (' + buildBlockedAccountSQL(serverAccountId, userAccountId) + ')' +
51 'SELECT COUNT("replies"."id") - (' +
52 'SELECT COUNT("replies"."id") ' +
53 'FROM "videoComment" AS "replies" ' +
54 'WHERE "replies"."originCommentId" = "VideoCommentModel"."id" ' +
55 'AND "accountId" IN (SELECT "id" FROM "blocklist")' +
57 'FROM "videoComment" AS "replies" ' +
58 'WHERE "replies"."originCommentId" = "VideoCommentModel"."id" ' +
59 'AND "accountId" NOT IN (SELECT "id" FROM "blocklist")' +
68 [ScopeNames.WITH_ACCOUNT]: {
90 [ScopeNames.WITH_IN_REPLY_TO]: {
93 model: VideoCommentModel,
94 as: 'InReplyToVideoComment'
98 [ScopeNames.WITH_VIDEO]: {
105 model: VideoChannelModel.unscoped(),
126 tableName: 'videoComment',
129 fields: [ 'videoId' ]
132 fields: [ 'videoId', 'originCommentId' ]
139 fields: [ 'accountId' ]
143 export class VideoCommentModel extends Model<VideoCommentModel> {
151 @Is('VideoCommentUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
152 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.URL.max))
156 @Column(DataType.TEXT)
159 @ForeignKey(() => VideoCommentModel)
161 originCommentId: number
163 @BelongsTo(() => VideoCommentModel, {
165 name: 'originCommentId',
168 as: 'OriginVideoComment',
171 OriginVideoComment: VideoCommentModel
173 @ForeignKey(() => VideoCommentModel)
175 inReplyToCommentId: number
177 @BelongsTo(() => VideoCommentModel, {
179 name: 'inReplyToCommentId',
182 as: 'InReplyToVideoComment',
185 InReplyToVideoComment: VideoCommentModel | null
187 @ForeignKey(() => VideoModel)
191 @BelongsTo(() => VideoModel, {
199 @ForeignKey(() => AccountModel)
203 @BelongsTo(() => AccountModel, {
209 Account: AccountModel
212 static async sendDeleteIfOwned (instance: VideoCommentModel, options) {
213 if (!instance.Account || !instance.Account.Actor) {
214 instance.Account = await instance.$get('Account', {
215 include: [ ActorModel ],
216 transaction: options.transaction
220 if (!instance.Video) {
221 instance.Video = await instance.$get('Video', {
224 model: VideoChannelModel,
237 transaction: options.transaction
241 if (instance.isOwned()) {
242 await sendDeleteVideoComment(instance, options.transaction)
246 static loadById (id: number, t?: Transaction) {
247 const query: FindOptions = {
253 if (t !== undefined) query.transaction = t
255 return VideoCommentModel.findOne(query)
258 static loadByIdAndPopulateVideoAndAccountAndReply (id: number, t?: Transaction) {
259 const query: FindOptions = {
265 if (t !== undefined) query.transaction = t
267 return VideoCommentModel
268 .scope([ ScopeNames.WITH_VIDEO, ScopeNames.WITH_ACCOUNT, ScopeNames.WITH_IN_REPLY_TO ])
272 static loadByUrlAndPopulateAccount (url: string, t?: Transaction) {
273 const query: FindOptions = {
279 if (t !== undefined) query.transaction = t
281 return VideoCommentModel.scope([ ScopeNames.WITH_ACCOUNT ]).findOne(query)
284 static loadByUrlAndPopulateReplyAndVideo (url: string, t?: Transaction) {
285 const query: FindOptions = {
291 if (t !== undefined) query.transaction = t
293 return VideoCommentModel.scope([ ScopeNames.WITH_IN_REPLY_TO, ScopeNames.WITH_VIDEO ]).findOne(query)
296 static async listThreadsForApi (videoId: number, start: number, count: number, sort: string, user?: UserModel) {
297 const serverActor = await getServerActor()
298 const serverAccountId = serverActor.Account.id
299 const userAccountId = user ? user.Account.id : undefined
304 order: getSort(sort),
307 inReplyToCommentId: null,
309 [Op.notIn]: Sequelize.literal(
310 '(' + buildBlockedAccountSQL(serverAccountId, userAccountId) + ')'
316 const scopes: (string | ScopeOptions)[] = [
317 ScopeNames.WITH_ACCOUNT,
319 method: [ ScopeNames.ATTRIBUTES_FOR_API, serverAccountId, userAccountId ]
323 return VideoCommentModel
325 .findAndCountAll(query)
326 .then(({ rows, count }) => {
327 return { total: count, data: rows }
331 static async listThreadCommentsForApi (videoId: number, threadId: number, user?: UserModel) {
332 const serverActor = await getServerActor()
333 const serverAccountId = serverActor.Account.id
334 const userAccountId = user ? user.Account.id : undefined
337 order: [ [ 'createdAt', 'ASC' ], [ 'updatedAt', 'ASC' ] ] as Order,
342 { originCommentId: threadId }
345 [Op.notIn]: Sequelize.literal(
346 '(' + buildBlockedAccountSQL(serverAccountId, userAccountId) + ')'
352 const scopes: any[] = [
353 ScopeNames.WITH_ACCOUNT,
355 method: [ ScopeNames.ATTRIBUTES_FOR_API, serverAccountId, userAccountId ]
359 return VideoCommentModel
361 .findAndCountAll(query)
362 .then(({ rows, count }) => {
363 return { total: count, data: rows }
367 static listThreadParentComments (comment: VideoCommentModel, t: Transaction, order: 'ASC' | 'DESC' = 'ASC') {
369 order: [ [ 'createdAt', order ] ] as Order,
372 [ Op.in ]: Sequelize.literal('(' +
373 'WITH RECURSIVE children (id, "inReplyToCommentId") AS ( ' +
374 `SELECT id, "inReplyToCommentId" FROM "videoComment" WHERE id = ${comment.id} ` +
376 'SELECT "parent"."id", "parent"."inReplyToCommentId" FROM "videoComment" "parent" ' +
377 'INNER JOIN "children" ON "children"."inReplyToCommentId" = "parent"."id"' +
379 'SELECT id FROM children' +
381 [ Op.ne ]: comment.id
387 return VideoCommentModel
388 .scope([ ScopeNames.WITH_ACCOUNT ])
392 static listAndCountByVideoId (videoId: number, start: number, count: number, t?: Transaction, order: 'ASC' | 'DESC' = 'ASC') {
394 order: [ [ 'createdAt', order ] ] as Order,
403 return VideoCommentModel.findAndCountAll(query)
406 static listForFeed (start: number, count: number, videoId?: number) {
408 order: [ [ 'createdAt', 'DESC' ] ] as Order,
414 attributes: [ 'name', 'uuid' ],
415 model: VideoModel.unscoped(),
421 if (videoId) query.where['videoId'] = videoId
423 return VideoCommentModel
424 .scope([ ScopeNames.WITH_ACCOUNT ])
428 static async getStats () {
429 const totalLocalVideoComments = await VideoCommentModel.count({
446 const totalVideoComments = await VideoCommentModel.count()
449 totalLocalVideoComments,
454 static cleanOldCommentsOf (videoId: number, beforeUpdatedAt: Date) {
458 [Op.lt]: beforeUpdatedAt
464 return VideoCommentModel.destroy(query)
467 getCommentStaticPath () {
468 return this.Video.getWatchStaticPath() + ';threadId=' + this.getThreadId()
471 getThreadId (): number {
472 return this.originCommentId || this.id
476 return this.Account.isOwned()
480 let result: string[] = []
482 const localMention = `@(${actorNameAlphabet}+)`
483 const remoteMention = `${localMention}@${WEBSERVER.HOST}`
485 const mentionRegex = this.isOwned()
486 ? '(?:(?:' + remoteMention + ')|(?:' + localMention + '))' // Include local mentions?
487 : '(?:' + remoteMention + ')'
489 const firstMentionRegex = new RegExp(`^${mentionRegex} `, 'g')
490 const endMentionRegex = new RegExp(` ${mentionRegex}$`, 'g')
491 const remoteMentionsRegex = new RegExp(' ' + remoteMention + ' ', 'g')
493 result = result.concat(
494 regexpCapture(this.text, firstMentionRegex)
495 .map(([ , username1, username2 ]) => username1 || username2),
497 regexpCapture(this.text, endMentionRegex)
498 .map(([ , username1, username2 ]) => username1 || username2),
500 regexpCapture(this.text, remoteMentionsRegex)
501 .map(([ , username ]) => username)
504 // Include local mentions
505 if (this.isOwned()) {
506 const localMentionsRegex = new RegExp(' ' + localMention + ' ', 'g')
508 result = result.concat(
509 regexpCapture(this.text, localMentionsRegex)
510 .map(([ , username ]) => username)
522 threadId: this.originCommentId || this.id,
523 inReplyToCommentId: this.inReplyToCommentId || null,
524 videoId: this.videoId,
525 createdAt: this.createdAt,
526 updatedAt: this.updatedAt,
527 totalReplies: this.get('totalReplies') || 0,
528 account: this.Account.toFormattedJSON()
532 toActivityPubObject (threadParentComments: VideoCommentModel[]): VideoCommentObject {
533 let inReplyTo: string
534 // New thread, so in AS we reply to the video
535 if (this.inReplyToCommentId === null) {
536 inReplyTo = this.Video.url
538 inReplyTo = this.InReplyToVideoComment.url
541 const tag: ActivityTagObject[] = []
542 for (const parentComment of threadParentComments) {
543 const actor = parentComment.Account.Actor
548 name: `@${actor.preferredUsername}@${actor.getHost()}`
553 type: 'Note' as 'Note',
557 updated: this.updatedAt.toISOString(),
558 published: this.createdAt.toISOString(),
560 attributedTo: this.Account.Actor.url,