1 import { uniq } from 'lodash'
2 import { FindAndCountOptions, FindOptions, Op, Order, QueryTypes, ScopeOptions, Sequelize, Transaction, WhereOptions } from 'sequelize'
16 } from 'sequelize-typescript'
17 import { getServerActor } from '@server/models/application/application'
18 import { MAccount, MAccountId, MUserAccountId } from '@server/types/models'
19 import { AttributesOnly } from '@shared/core-utils'
20 import { VideoPrivacy } from '@shared/models'
21 import { ActivityTagObject, ActivityTombstoneObject } from '../../../shared/models/activitypub/objects/common-objects'
22 import { VideoCommentObject } from '../../../shared/models/activitypub/objects/video-comment-object'
23 import { VideoComment, VideoCommentAdmin } from '../../../shared/models/videos/comment/video-comment.model'
24 import { actorNameAlphabet } from '../../helpers/custom-validators/activitypub/actor'
25 import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
26 import { regexpCapture } from '../../helpers/regexp'
27 import { CONSTRAINTS_FIELDS, WEBSERVER } from '../../initializers/constants'
30 MCommentAdminFormattable,
35 MCommentOwnerReplyVideoLight,
37 MCommentOwnerVideoFeed,
38 MCommentOwnerVideoReply,
40 } from '../../types/models/video'
41 import { VideoCommentAbuseModel } from '../abuse/video-comment-abuse'
42 import { AccountModel } from '../account/account'
43 import { ActorModel, unusedActorAttributesForAPI } from '../actor/actor'
45 buildBlockedAccountSQL,
46 buildBlockedAccountSQLOptimized,
47 buildLocalAccountIdsIn,
52 import { VideoModel } from './video'
53 import { VideoChannelModel } from './video-channel'
55 export enum ScopeNames {
56 WITH_ACCOUNT = 'WITH_ACCOUNT',
57 WITH_ACCOUNT_FOR_API = 'WITH_ACCOUNT_FOR_API',
58 WITH_IN_REPLY_TO = 'WITH_IN_REPLY_TO',
59 WITH_VIDEO = 'WITH_VIDEO',
60 ATTRIBUTES_FOR_API = 'ATTRIBUTES_FOR_API'
64 [ScopeNames.ATTRIBUTES_FOR_API]: (blockerAccountIds: number[]) => {
71 'WITH "blocklist" AS (' + buildBlockedAccountSQL(blockerAccountIds) + ')' +
72 'SELECT COUNT("replies"."id") - (' +
73 'SELECT COUNT("replies"."id") ' +
74 'FROM "videoComment" AS "replies" ' +
75 'WHERE "replies"."originCommentId" = "VideoCommentModel"."id" ' +
76 'AND "accountId" IN (SELECT "id" FROM "blocklist")' +
78 'FROM "videoComment" AS "replies" ' +
79 'WHERE "replies"."originCommentId" = "VideoCommentModel"."id" ' +
80 'AND "accountId" NOT IN (SELECT "id" FROM "blocklist")' +
88 'SELECT COUNT("replies"."id") ' +
89 'FROM "videoComment" AS "replies" ' +
90 'INNER JOIN "video" ON "video"."id" = "replies"."videoId" ' +
91 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
92 'WHERE "replies"."originCommentId" = "VideoCommentModel"."id" ' +
93 'AND "replies"."accountId" = "videoChannel"."accountId"' +
96 'totalRepliesFromVideoAuthor'
102 [ScopeNames.WITH_ACCOUNT]: {
109 [ScopeNames.WITH_ACCOUNT_FOR_API]: {
112 model: AccountModel.unscoped(),
116 exclude: unusedActorAttributesForAPI
118 model: ActorModel, // Default scope includes avatar and server
125 [ScopeNames.WITH_IN_REPLY_TO]: {
128 model: VideoCommentModel,
129 as: 'InReplyToVideoComment'
133 [ScopeNames.WITH_VIDEO]: {
140 model: VideoChannelModel,
155 tableName: 'videoComment',
158 fields: [ 'videoId' ]
161 fields: [ 'videoId', 'originCommentId' ]
168 fields: [ 'accountId' ]
172 { name: 'createdAt', order: 'DESC' }
177 export class VideoCommentModel extends Model<Partial<AttributesOnly<VideoCommentModel>>> {
185 @Column(DataType.DATE)
189 @Is('VideoCommentUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
190 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.URL.max))
194 @Column(DataType.TEXT)
197 @ForeignKey(() => VideoCommentModel)
199 originCommentId: number
201 @BelongsTo(() => VideoCommentModel, {
203 name: 'originCommentId',
206 as: 'OriginVideoComment',
209 OriginVideoComment: VideoCommentModel
211 @ForeignKey(() => VideoCommentModel)
213 inReplyToCommentId: number
215 @BelongsTo(() => VideoCommentModel, {
217 name: 'inReplyToCommentId',
220 as: 'InReplyToVideoComment',
223 InReplyToVideoComment: VideoCommentModel | null
225 @ForeignKey(() => VideoModel)
229 @BelongsTo(() => VideoModel, {
237 @ForeignKey(() => AccountModel)
241 @BelongsTo(() => AccountModel, {
247 Account: AccountModel
249 @HasMany(() => VideoCommentAbuseModel, {
251 name: 'videoCommentId',
256 CommentAbuses: VideoCommentAbuseModel[]
258 static loadById (id: number, t?: Transaction): Promise<MComment> {
259 const query: FindOptions = {
265 if (t !== undefined) query.transaction = t
267 return VideoCommentModel.findOne(query)
270 static loadByIdAndPopulateVideoAndAccountAndReply (id: number, t?: Transaction): Promise<MCommentOwnerVideoReply> {
271 const query: FindOptions = {
277 if (t !== undefined) query.transaction = t
279 return VideoCommentModel
280 .scope([ ScopeNames.WITH_VIDEO, ScopeNames.WITH_ACCOUNT, ScopeNames.WITH_IN_REPLY_TO ])
284 static loadByUrlAndPopulateAccountAndVideo (url: string, t?: Transaction): Promise<MCommentOwnerVideo> {
285 const query: FindOptions = {
291 if (t !== undefined) query.transaction = t
293 return VideoCommentModel.scope([ ScopeNames.WITH_ACCOUNT, ScopeNames.WITH_VIDEO ]).findOne(query)
296 static loadByUrlAndPopulateReplyAndVideoUrlAndAccount (url: string, t?: Transaction): Promise<MCommentOwnerReplyVideoLight> {
297 const query: FindOptions = {
303 attributes: [ 'id', 'url' ],
304 model: VideoModel.unscoped()
309 if (t !== undefined) query.transaction = t
311 return VideoCommentModel.scope([ ScopeNames.WITH_IN_REPLY_TO, ScopeNames.WITH_ACCOUNT ]).findOne(query)
314 static listCommentsForApi (parameters: {
321 searchAccount?: string
324 const { start, count, sort, isLocal, search, searchAccount, searchVideo } = parameters
326 const where: WhereOptions = {
330 const whereAccount: WhereOptions = {}
331 const whereActor: WhereOptions = {}
332 const whereVideo: WhereOptions = {}
334 if (isLocal === true) {
335 Object.assign(whereActor, {
338 } else if (isLocal === false) {
339 Object.assign(whereActor, {
347 Object.assign(where, {
349 searchAttribute(search, 'text'),
350 searchAttribute(search, '$Account.Actor.preferredUsername$'),
351 searchAttribute(search, '$Account.name$'),
352 searchAttribute(search, '$Video.name$')
358 Object.assign(whereActor, {
360 searchAttribute(searchAccount, '$Account.Actor.preferredUsername$'),
361 searchAttribute(searchAccount, '$Account.name$')
367 Object.assign(whereVideo, searchAttribute(searchVideo, 'name'))
370 const query: FindAndCountOptions = {
373 order: getCommentSort(sort),
377 model: AccountModel.unscoped(),
383 exclude: unusedActorAttributesForAPI
385 model: ActorModel, // Default scope includes avatar and server
392 model: VideoModel.unscoped(),
399 return VideoCommentModel
400 .findAndCountAll(query)
401 .then(({ rows, count }) => {
402 return { total: count, data: rows }
406 static async listThreadsForApi (parameters: {
408 isVideoOwned: boolean
412 user?: MUserAccountId
414 const { videoId, isVideoOwned, start, count, sort, user } = parameters
416 const blockerAccountIds = await VideoCommentModel.buildBlockerAccountIds({ videoId, user, isVideoOwned })
418 const accountBlockedWhere = {
420 [Op.notIn]: Sequelize.literal(
421 '(' + buildBlockedAccountSQL(blockerAccountIds) + ')'
429 order: getCommentSort(sort),
436 inReplyToCommentId: null
450 const scopesList: (string | ScopeOptions)[] = [
451 ScopeNames.WITH_ACCOUNT_FOR_API,
453 method: [ ScopeNames.ATTRIBUTES_FOR_API, blockerAccountIds ]
461 ...accountBlockedWhere
466 VideoCommentModel.scope(scopesList).findAndCountAll(queryList),
467 VideoCommentModel.count(queryCount)
468 ]).then(([ { rows, count }, totalNotDeletedComments ]) => {
469 return { total: count, data: rows, totalNotDeletedComments }
473 static async listThreadCommentsForApi (parameters: {
475 isVideoOwned: boolean
477 user?: MUserAccountId
479 const { videoId, threadId, user, isVideoOwned } = parameters
481 const blockerAccountIds = await VideoCommentModel.buildBlockerAccountIds({ videoId, user, isVideoOwned })
484 order: [ [ 'createdAt', 'ASC' ], [ 'updatedAt', 'ASC' ] ] as Order,
491 { originCommentId: threadId }
498 [Op.notIn]: Sequelize.literal(
499 '(' + buildBlockedAccountSQL(blockerAccountIds) + ')'
512 const scopes: any[] = [
513 ScopeNames.WITH_ACCOUNT_FOR_API,
515 method: [ ScopeNames.ATTRIBUTES_FOR_API, blockerAccountIds ]
519 return VideoCommentModel.scope(scopes)
520 .findAndCountAll(query)
521 .then(({ rows, count }) => {
522 return { total: count, data: rows }
526 static listThreadParentComments (comment: MCommentId, t: Transaction, order: 'ASC' | 'DESC' = 'ASC'): Promise<MCommentOwner[]> {
528 order: [ [ 'createdAt', order ] ] as Order,
531 [Op.in]: Sequelize.literal('(' +
532 'WITH RECURSIVE children (id, "inReplyToCommentId") AS ( ' +
533 `SELECT id, "inReplyToCommentId" FROM "videoComment" WHERE id = ${comment.id} ` +
535 'SELECT "parent"."id", "parent"."inReplyToCommentId" FROM "videoComment" "parent" ' +
536 'INNER JOIN "children" ON "children"."inReplyToCommentId" = "parent"."id"' +
538 'SELECT id FROM children' +
546 return VideoCommentModel
547 .scope([ ScopeNames.WITH_ACCOUNT ])
551 static async listAndCountByVideoForAP (video: MVideoImmutable, start: number, count: number, t?: Transaction) {
552 const blockerAccountIds = await VideoCommentModel.buildBlockerAccountIds({
554 isVideoOwned: video.isOwned()
558 order: [ [ 'createdAt', 'ASC' ] ] as Order,
564 [Op.notIn]: Sequelize.literal(
565 '(' + buildBlockedAccountSQL(blockerAccountIds) + ')'
572 return VideoCommentModel.findAndCountAll<MComment>(query)
575 static async listForFeed (parameters: {
580 videoChannelId?: number
581 }): Promise<MCommentOwnerVideoFeed[]> {
582 const serverActor = await getServerActor()
583 const { start, count, videoId, accountId, videoChannelId } = parameters
585 const whereAnd: WhereOptions[] = buildBlockedAccountSQLOptimized(
586 '"VideoCommentModel"."accountId"',
587 [ serverActor.Account.id, '"Video->VideoChannel"."accountId"' ]
596 const accountWhere = {
600 const videoChannelWhere = videoChannelId ? { id: videoChannelId } : undefined
603 order: [ [ 'createdAt', 'DESC' ] ] as Order,
608 accountId: accountWhere
612 attributes: [ 'name', 'uuid' ],
613 model: VideoModel.unscoped(),
616 privacy: VideoPrivacy.PUBLIC
620 attributes: [ 'accountId' ],
621 model: VideoChannelModel.unscoped(),
623 where: videoChannelWhere
630 if (videoId) query.where['videoId'] = videoId
632 return VideoCommentModel
633 .scope([ ScopeNames.WITH_ACCOUNT ])
637 static listForBulkDelete (ofAccount: MAccount, filter: { onVideosOfAccount?: MAccountId } = {}) {
638 const accountWhere = filter.onVideosOfAccount
639 ? { id: filter.onVideosOfAccount.id }
646 accountId: ofAccount.id
654 model: VideoChannelModel,
669 return VideoCommentModel
670 .scope([ ScopeNames.WITH_ACCOUNT ])
674 static async getStats () {
675 const totalLocalVideoComments = await VideoCommentModel.count({
692 const totalVideoComments = await VideoCommentModel.count()
695 totalLocalVideoComments,
700 static listRemoteCommentUrlsOfLocalVideos () {
701 const query = `SELECT "videoComment".url FROM "videoComment" ` +
702 `INNER JOIN account ON account.id = "videoComment"."accountId" ` +
703 `INNER JOIN actor ON actor.id = "account"."actorId" AND actor."serverId" IS NOT NULL ` +
704 `INNER JOIN video ON video.id = "videoComment"."videoId" AND video.remote IS FALSE`
706 return VideoCommentModel.sequelize.query<{ url: string }>(query, {
707 type: QueryTypes.SELECT,
709 }).then(rows => rows.map(r => r.url))
712 static cleanOldCommentsOf (videoId: number, beforeUpdatedAt: Date) {
716 [Op.lt]: beforeUpdatedAt
720 [Op.notIn]: buildLocalAccountIdsIn()
722 // Do not delete Tombstones
727 return VideoCommentModel.destroy(query)
730 getCommentStaticPath () {
731 return this.Video.getWatchStaticPath() + ';threadId=' + this.getThreadId()
734 getThreadId (): number {
735 return this.originCommentId || this.id
743 return this.Account.isOwned()
747 return this.deletedAt !== null
751 let result: string[] = []
753 const localMention = `@(${actorNameAlphabet}+)`
754 const remoteMention = `${localMention}@${WEBSERVER.HOST}`
756 const mentionRegex = this.isOwned()
757 ? '(?:(?:' + remoteMention + ')|(?:' + localMention + '))' // Include local mentions?
758 : '(?:' + remoteMention + ')'
760 const firstMentionRegex = new RegExp(`^${mentionRegex} `, 'g')
761 const endMentionRegex = new RegExp(` ${mentionRegex}$`, 'g')
762 const remoteMentionsRegex = new RegExp(' ' + remoteMention + ' ', 'g')
764 result = result.concat(
765 regexpCapture(this.text, firstMentionRegex)
766 .map(([ , username1, username2 ]) => username1 || username2),
768 regexpCapture(this.text, endMentionRegex)
769 .map(([ , username1, username2 ]) => username1 || username2),
771 regexpCapture(this.text, remoteMentionsRegex)
772 .map(([ , username ]) => username)
775 // Include local mentions
776 if (this.isOwned()) {
777 const localMentionsRegex = new RegExp(' ' + localMention + ' ', 'g')
779 result = result.concat(
780 regexpCapture(this.text, localMentionsRegex)
781 .map(([ , username ]) => username)
788 toFormattedJSON (this: MCommentFormattable) {
794 threadId: this.getThreadId(),
795 inReplyToCommentId: this.inReplyToCommentId || null,
796 videoId: this.videoId,
798 createdAt: this.createdAt,
799 updatedAt: this.updatedAt,
800 deletedAt: this.deletedAt,
802 isDeleted: this.isDeleted(),
804 totalRepliesFromVideoAuthor: this.get('totalRepliesFromVideoAuthor') || 0,
805 totalReplies: this.get('totalReplies') || 0,
807 account: this.Account
808 ? this.Account.toFormattedJSON()
813 toFormattedAdminJSON (this: MCommentAdminFormattable) {
819 threadId: this.getThreadId(),
820 inReplyToCommentId: this.inReplyToCommentId || null,
821 videoId: this.videoId,
823 createdAt: this.createdAt,
824 updatedAt: this.updatedAt,
828 uuid: this.Video.uuid,
829 name: this.Video.name
832 account: this.Account
833 ? this.Account.toFormattedJSON()
835 } as VideoCommentAdmin
838 toActivityPubObject (this: MCommentAP, threadParentComments: MCommentOwner[]): VideoCommentObject | ActivityTombstoneObject {
839 let inReplyTo: string
840 // New thread, so in AS we reply to the video
841 if (this.inReplyToCommentId === null) {
842 inReplyTo = this.Video.url
844 inReplyTo = this.InReplyToVideoComment.url
847 if (this.isDeleted()) {
853 published: this.createdAt.toISOString(),
854 updated: this.updatedAt.toISOString(),
855 deleted: this.deletedAt.toISOString()
859 const tag: ActivityTagObject[] = []
860 for (const parentComment of threadParentComments) {
861 if (!parentComment.Account) continue
863 const actor = parentComment.Account.Actor
868 name: `@${actor.preferredUsername}@${actor.getHost()}`
873 type: 'Note' as 'Note',
877 updated: this.updatedAt.toISOString(),
878 published: this.createdAt.toISOString(),
880 attributedTo: this.Account.Actor.url,
885 private static async buildBlockerAccountIds (options: {
887 isVideoOwned: boolean
888 user?: MUserAccountId
890 const { videoId, user, isVideoOwned } = options
892 const serverActor = await getServerActor()
893 const blockerAccountIds = [ serverActor.Account.id ]
895 if (user) blockerAccountIds.push(user.Account.id)
898 const videoOwnerAccount = await AccountModel.loadAccountIdFromVideo(videoId)
899 blockerAccountIds.push(videoOwnerAccount.id)
902 return blockerAccountIds